doc update for 0.8.1

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@812 fefdeb5f-60dc-0310-8127-8f9354f1896f

doc/FAQ.html.in

@@ -224,7 +224,7 @@ load-module module-rtp-recv sink=rtp
 set-default-source rtp_monitor
 </pre>
 
-<p>Now the audio data will be available from the default source <tt>rtp_monitor</tt>.</p>
+<p>Now the audio data will be available from the default source <tt>rtp_monitor</tt>.</p></li>
 
 <li><p><b>When sending multicast RTP traffic it is recieved on the entire LAN but not by the sender machine itself!</b></p>
 
@@ -237,6 +237,52 @@ the <tt>destination</tt>/<tt>sap_address</tt> arguments of the RTP
 modules to select them. Choose your group addresses from the range
 <tt>225.0.0.x</tt> to make sure the audio data never leaves the LAN.</p></li>
 
+
+<li><p><b>Can I use Polypaudio to playback music on two sound cards simultaneously?</b></p>
+
+<p>Yes! Use <a href="modules.html#module-combine"><tt>module-combine</tt></a> for that.</p>
+
+<pre>
+load-module module-oss-mmap device="/dev/dsp" sink_name=output0
+load-module module-oss-mmap device="/dev/dsp1" sink_name=output1
+load-module module-combine sink_name=combined master=output0 slaves=output1
+set-sink-default combined
+</pre>
+
+<p>This will combine the two sinks <tt>output0</tt> and
+<tt>output1</tt> into a new sink <tt>combined</tt>. Every sample
+written to the latter will be forwarded to the former two. Polypaudio
+will make sure to adjust the sample rate of the slave device in case
+it deviates from the master device. You can have more than one slave
+sink attached to the combined sink, and hence combine even three and
+more sound cards.</p> </li>
+
+<li><p><b>Can I use Polypaudio to combine two stereo soundcards into a virtual surround sound card?</b></p>
+
+<p>Yes! You can use use <a href="modules.html#module-combine"><tt>module-combine</tt></a> for that.</p>
+
+<pre>
+load-module module-oss-mmap device="/dev/dsp" sink_name=output0 channel_map=left,right channels=2
+load-module module-oss-mmap device="/dev/dsp1" sink_name=output1 channel_map=rear-left,rear-right channels=2
+load-module module-combine sink_name=combined master=output0 slaves=output1 channel_map=left,right,rear-left,rear-right channels=4
+</pre>
+
+<p>This is mostly identical to the previous example. However, this
+time we manually specify the channel mappings for the sinks to make
+sure everything is routed correctly.</p>
+
+<p>Please keep in mind that Polypaudio will constantly adjust the
+sample rate to compensate for the deviating quartzes of the sound
+devices. This is not perfect, however. Deviations in a range of
+1/44100s (or 1/48000s depending on the sampling frequency) can not be
+compensated. The human ear will decode these deviations as minor
+movements (less than 1cm) of the positions of the sound sources
+you hear. </p>
+
+</li>
+
+
+
 </ol>
 
 <hr/>

doc/README.html.in

@@ -22,6 +22,7 @@
     <li><a href="#installation">Installation</a></li>
     <li><a href="#acks">Acknowledgements</a></li>
     <li><a href="#download">Download</a></li>
+    <li><a href="#community">Community</a></li>
 </ul>
 
 <h2><a name="license">License</a></h2>
@@ -42,6 +43,14 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>
 
 <h2><a name="news">News</a></h2>
 
+<div class="news-date">Wed Apr 26 2006: </div> <p class="news-text"><a
+href="@PACKAGE_URL@polypaudio-0.8.1.tar.gz">Version 0.8.1</a>
+released; changes include: support for specifying the channel map on
+the command lines of <tt>paplay</tt> and <tt>pacat</tt> and as
+arguments to the driver modules; ALSA hardware mixer compatibility;
+fix linking; properly remove <tt>PF_UNIX</tt> sockets when unloading
+protocol modules; fix sample cache; many other fixes</p>
+
 <div class="news-date">Thu Apr 13 2006: </div> <p class="news-text"><a
 href="@PACKAGE_URL@polypaudio-0.8.tar.gz">Version 0.8</a> released;
 changes include: too many to count - consider reading <a href="http://0pointer.de/blog/projects/polypaudio-0.8.html">this blog entry</a> for more information; many, many minor fixes.</p>
@@ -288,6 +297,10 @@ compilation and <tt>make install</tt> (as root) for installation of
 
 <p><a href="http://www.cendio.com">Cendio AB</a> for paying for Pierre's work on Polypaudio</p>
 
+<p>Sebastien ESTIENNE for testing</p>
+
+<p>Igor Zubkov for some portability patches</p>
+
 <h2><a name="download">Download</a></h2>
 
 <p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p>
@@ -298,10 +311,16 @@ compilation and <tt>make install</tt> (as root) for installation of
 
 <pre>svn checkout svn://0pointer.de/polypaudio/trunk polypaudio</pre>
 
+<h2><a name="community">Community</a></h2>
+
 <p>If you want to be notified whenever I release a new version of this software use the subscription feature of <a href="http://freshmeat.net/projects/polypaudio/">Freshmeat</a>.</p>
 
 <p>There is a general discussion <a href="https://tango.0pointer.de/mailman/listinfo/polypaudio-discuss">mailing list for polypaudio</a> available. In addition, you can subscribe to <a href="https://tango.0pointer.de/mailman/listinfo/polypaudio-commits">SVN changes</a> and <a href="https://tango.0pointer.de/mailman/listinfo/polypaudio-tickets">Trac Tickets</a>.</p>
 
+<p>Polypaudio is being tracked at <a href="http://cia.navi.cx/stats/project/polypaudio">CIA</a>.</p>
+
+<p>There's a chance to meet the Polypaudio developers on our <a href="irc://irc.freenode.org/polypaudio">IRC channel #polypaudio on irc.freenode.org</a>.</p>
+
 <p>There is a <a href="http://www.edgewall.com/products/trac/">Trac</a> based <a href="http://0pointer.de/trac/polypaudio/">Wiki for Polypaudio</a> available.</p>
 
 <p><b>Please report bugs to <a href="http://0pointer.de/trac/polypaudio/newticket">our Trac ticket system</a>.</b></p>

doc/modules.html.in

@@ -20,7 +20,19 @@
   <tr><td><tt>rate=</tt></td><td>The sample rate (defaults to 44100)</td></tr>
   <tr><td><tt>channels=</tt></td><td>Audio channels (defaults to 2)</td></tr>
   <tr><td><tt>sink_name=</tt>, <tt>source_name=</tt></td><td>Name for the sink (resp. source)</td></tr>
-</table>
+  <tr><td><tt>channel_map=</tt></td><td>Channel map. A list of
+comma-seperated channel names. The currently defined channel names
+are: <tt>left</tt>, <tt>right</tt>, <tt>mono</tt>, <tt>center</tt>,
+<tt>front-left</tt>, <tt>front-right</tt>, <tt>front-center</tt>,
+<tt>rear-center</tt>, <tt>rear-left</tt>, <tt>rear-right</tt>,
+<tt>lfe</tt>, <tt>subwoofer</tt>, <tt>front-left-of-center</tt>,
+<tt>front-right-of-center</tt>, <tt>side-left</tt>,
+<tt>side-right</tt>, <tt>aux0</tt>, <tt>aux1</tt> to <tt>aux15</tt>,
+<tt>top-center</tt>, <tt>top-front-left</tt>,
+<tt>top-front-right</tt>, <tt>top-front-center</tt>,
+<tt>top-rear-left</tt>, <tt>top-rear-right</tt>,
+<tt>top-rear-center</tt>, (Default depends on the number of channels
+and the driver)</td></tr> </table>
 
 <h3>module-pipe-sink</h3>
 
@@ -118,12 +130,13 @@ compatible as <tt>module-oss</tt>.</p>
 
 <p>This module supports all arguments thet <tt>module-oss</tt> supports except <tt>device=</tt>.</p>
 
+<a name="module-combine"/>
 <h3>module-combine</h3>
 
 <p>This combines two or more sinks into one. A new virtual sink is
 allocated. All data written to it is forwarded to all connected
 sinks. In aequidistant intervals the sample rates of the output sinks
-is recalculated: i.e. even when the sink's crystals deviate (which is
+is recalculated: i.e. even when the sinks' crystals deviate (which is
 normally the case) output appears synchronously to the human ear. The
 resampling required for this may be very CPU intensive.</p>