esound.sgml

linux下的终端管理工具源码

    <sect1 id="esdsample-esdloop">
      <title>esdsample, esdloop</title>

      <para>
	esdsample is test scaffolding for sample cache, play back, and free.
	esdloop is test scaffolding for sample cache, loop, and free.  These
	utilities have no practical purpose beyond testing sample
	functionality.
      </para>

      <para>
	<command>esdsample</command> <option>[options] file</option>
      </para>
      <para>
	<command>esdloop</command>   <option>[options] file</option>
      </para>

      <informaltable frame="all">
	<tgroup cols="2">
	  <thead>
	    <row><entry>option</entry><entry>purpose</entry></row></thead>
	  <tbody>
	    <row>
	      <entry>-s SERVER</entry>
	      <entry>communicate with esound running at SERVER</entry>
	    </row>
	    <row>
	      <entry>-b</entry>
	      <entry>read/write 8 bit sample data</entry>
	    </row>
	    <row>
	      <entry>-m</entry>
	      <entry>read/write mono data</entry>
	    </row>
	    <row>
	      <entry>-r RATE</entry>
	      <entry>use a sampling rate of RATE</entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>

      <para>
	options:
	-s server = communicate with esound running at server

	-b = 8 bit unsigned char

	-m = mono

	-r rate = sample rate of rate Hz.
      </para>

      <para>
	options for esdsample and esdloop default to 16 bit signed short,
	stereo, 44.1kHz
      </para>

    </sect1>

    <sect1 id="environment-variables">
      <title>Environment Variables</title>

      <para>
	All client programs (except esdctl) can connect to remote hosts via
	the <envar>ESPEAKER</envar> environment variable: 

	<literallayout>
	  <prompt>bash $ </prompt><userinput>export ESPEAKER=inet.addr.of.host:port</userinput>

	  <prompt>tcsh &gt; </prompt><userinput>setenv ESPEAKER inet.addr.of.host:port</userinput>
	</literallayout>

	The client will connect to EsounD running on the specified host on the
	specified port.
      </para>

    </sect1>

  </chapter>

  <!-- ========================================== -->

  <chapter id="miscellaneous">
    <title>Miscellaneous Information</title>

    <sect1 id="new-features">
      <title>New Features</title>

      <para>
	Version 0.2.4

	more bug fixes, mostly works on irix now.

	incompatible changes to client side API.  streams and samples
	now have names, and you can specify a host in esd_open_sound().
      </para>

      <para>
	Version 0.2.3

	bug fixes

      </para>

      <para>
	Version 0.2.2

	added reference counting to samples, so freeing samples works

	added first cut at drivers for other platforms.  no idea if they work

      </para>

      <para>
	Version 0.2.1

	the configure style installation now works if you don't already have a
	previous version installed.  Evil gnu automake &gt;=P

	better handling of "dead" time: should use 0&percnt; cpu if it's not actually
	doing anything
      </para>

      <para>
	Version 0.2

	a configure style installation is now available.

	added network support

	optional /dev/dsp fallback for stream play and record

	other forgotten features and bug fixes

      </para>

    </sect1>

    <sect1 id="deficiencies">
      <title>Known Problems, Deficiencies, and Possible Workarounds</title>

      <para>
	"unsupported sound format: 33" - This happens on cards that don't
	support playback of 16bit, stereo, 44.1kHz sound.  Try running in 8
	bit mode (esd -b), or at a lower playback rate (esd -r 22050), or both 
	(esd -b -r 22050)
      </para>

      <para>
	"unable to connect to server at port 35091" - This means the client
	cannot contact the server.  Make sure you have SysV IPC enabled in
	your kernel 
      </para>

      <para>
	Documentation of the API is in sad shape, but for now it's still in
	development (i.e. subject to change).  See the source of the sample
	command line driver utilities (esd?*) for usage.
      </para>

      <para>
	Any other pressing issues, problems, or patches may be directed to
	[e-mail].  Please mention EsounD and the version number
	(date for cvs checkouts) in the subject line.
      </para>

    </sect1>

    <sect1 id="planned-development">
      <title>Planned Development and Top Suggestions So Far...</title>

      <para>
	Porting of more sound playing applications.  For sound programs that
	send their output to /dev/dsp, this is usually a trivial process.
	Anyone willing to lend a hand in this effort will be duly appreciated.
      </para>

    </sect1>

    <sect1 id="feature-additions">
      <title>Planned Feature Additions</title>

      <para>
	See the TODO file for unorganized thoughts about where to go from
	here.
      </para>

    </sect1>

  </chapter>

  <!-- ========================================== -->

  <chapter id="supported-programs">
    <title>Enlightened Sound Daemon Aware Audio Programs</title>

    <sect1 id="emusic">
      <title>eMusic</title>

      <para>
	<ulink url="http://www.icom.net/~smelecat/emp3/index.htm"> eMusic</ulink>
	is an Enlightenend music player, which is capableof playing MP3, MOD,
	WAV, AU, and CD files.  All graphic elements of the program are fully
	customizable.
      </para>

    </sect1>

    <sect1 id="xmp">
      <title>The Extended Module Player</title>

      <para>
	<ulink url="http://xmp.home.ml.org"> Extended Mudule Player</ulink>
	is a MOD tracker, which also has an Xwindows interface.
      </para>

    </sect1>

    <sect1 id="mpg123">
      <title>mpg123</title>

      <para>
	<ulink url="http://www.netcom.com/~ericmit/mpg123_esd.tgz">
	  mpg123</ulink> is a command line program which plays mpeg layer 3
	audio files.
      </para>

    </sect1>

  </chapter>

  <!-- ========================================== -->

  <chapter id="esound-api">
    <title>The EsounD API</title>

    <sect1 id="put-something-useful-here">
      <title>Need to put something useful in here.</title>

      <para>
	Better yet, extract it from the source files.
      </para>

    </sect1>

  </chapter>

  <!-- ========================================== -->

  <chapter id="design-docs">
    <title>Rough Design Docs</title>

    <sect1 id="covered-formats">
      <title>Covered Formats</title>

      <para>
	Digital Waveforms
      </para>

      <para>
	No MIDI, No MOD
      </para>

    </sect1>

    <sect1 id="organization">
      <title>Client/Server Organization</title>

      <para>
	Server does the dirty work for byte swapping, scaling, etc.
      </para>

    </sect1>

    <sect1 id="signal-path">
      <title>The Audio Signal Path</title>

      <para>
	The audio signal travels the following path from source to speaker.
	Samples and streams are read via players
      </para>

    </sect1>

    <sect1 id="authentication">
      <title>Authentication Model</title>

      <para>
	Your .esd_auth file
      </para>

    </sect1>

    <sect1 id="player-type">
      <title>The Player Type</title>

      <para>
	read_player()
      </para>

    </sect1>

    <sect1 id="anything-else">
      <title>Anything Else?</title>

      <para>
	Anything Else?
      </para>

    </sect1>

  </chapter>

  <!-- ========================================== -->

  <reference>

    <title>EsounD Command Reference</title>

    <refentry id="refentry-esd">

      <refmeta>
	<refentrytitle>esd</refentrytitle>
	<manvolnum>1</manvolnum>
      </refmeta>

      <refnamediv>
	<refname>esd</refname>
	<refpurpose>The Enlightened Sound Daemon</refpurpose>
	<indexterm id="index-esd"><primary>esd</primary></indexterm>
      </refnamediv>

      <refsynopsisdiv>
	<refsynopsisdivinfo>
	  <date>August 26, 1999</date>
	</refsynopsisdivinfo>

	<synopsis>
	  esd [options]
	</synopsis>

	<refsect2 id="rs2-options">
	  <refsect2info>
	    <date>6 march 1996</date>
	  </refsect2info>
	  <title>options</title>
	  <variablelist>
	    <varlistentry>
	      <term><replaceable class="parameter">-nobeeps</replaceable></term>
	      <listitem>
		<para>
		  Specifies an array of child widgets.  Each child must be
		  of class RectObj or any subclass thereof.
		</para>
	      </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term><replaceable class="parameter">-as [SECS]</replaceable></term>
	      <listitem>
		<para>
		  Specifies the number of elements in <replaceable
 	    class="parameter">children</replaceable>.
		</para>
	      </listitem>
	    </varlistentry>
	  </variablelist>
	</refsect2>
      </refsynopsisdiv>

      <refsect1 id="r1-1007-unmanagechildren-2">
	<title>usage</title>
	<para>
	  unmanaging widgets is the usual method for temporarily making
	  them invisible.  they can be re-managed with
	  <function>xtmanagechildren()</function>.
	</para>
      </refsect1>
    </refentry>

  </reference>

  <!-- --------------------------------------------------------------------- -->

  <appendix id="Remaining-details">
    <title>Remaining details</title>

    <para>
      Although this booklet is quite complete, here I will mention some
      details I never got to.
    </para>

    <sect1 id="Use-of-the-word-dude">
      <title>Use of the word dude</title>

      <para>
	Here's an example of how to say <emphasis>dude</emphasis>: DUDE.

      </para> 

    </sect1>

  </appendix>

  <!-- --------------------------------------------------------------------- -->

</book>