changeset 11366:3d38013edd45

Export audio filter documentation by Gustavo Sverzut Barbieri <gsbarbieri at yahoo.com.br>, cleaned up by me.
author diego
date Mon, 03 Nov 2003 01:45:04 +0000
parents 23cb5b69113d
children c404cdbb8472
files DOCS/man/en/mplayer.1 DOCS/xml/en/audio.xml
diffstat 2 files changed, 48 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/DOCS/man/en/mplayer.1	Mon Nov 03 01:20:51 2003 +0000
+++ b/DOCS/man/en/mplayer.1	Mon Nov 03 01:45:04 2003 +0000
@@ -2024,6 +2024,13 @@
 Delays the sound output.
 Specify the delay separately for each channel in milliseconds (floating point
 number between 0 and 1000).
+.IPs export[=mmapped_file[:nsamples]]
+Exports the incoming signal to other processes using memory mapping (mmap()).
+.RSss
+mmapped_file: File to map data to (default: ~/.mplayer/mplayer-af_export).
+.br
+nsamples: number of samples per channel (default: 512)
+.REss
 .RE
 .
 .TP
--- a/DOCS/xml/en/audio.xml	Mon Nov 03 01:20:51 2003 +0000
+++ b/DOCS/xml/en/audio.xml	Mon Nov 03 01:45:04 2003 +0000
@@ -942,6 +942,47 @@
 rear speakers.
 </para>
 </sect4>
+
+<sect4 id="af_export">
+<title>Audio Exporter</title>
+<para>
+This audio filter exports the incoming signal to other processes using memory
+mapping (<literal>mmap()</literal>). Memory mapped areas contain a header:
+
+<programlisting>
+int nch                      /*number of channels*/
+int size		     /*buffer size*/
+unsigned long long counter   /*Used to keep sync, it's updated
+                               every time new data is exported.*/
+</programlisting>
+
+The rest is payload (non-interleaved) 16bit data.
+</para>
+
+<variablelist>
+<varlistentry>
+<term><option>mmapped_file</option></term>
+<listitem><para>
+The file you want this filter to export to. The default is to map to 
+<filename>~/.mplayer/mplayer-af_export</filename>.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>nsamples</option></term>
+<listitem><para>
+Number of samples per channel. The default is <literal>512</literal> samples.
+</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para>
+Example:
+<screen>mplayer -af export=/tmp/mplayer-af_export:1024 media.avi</screen>
+would export 1024 samples per channel to <filename>/tmp/mplayer-af_export</filename>.
+</para>
+</sect4>
+
 </sect3>
 
 <sect3 id="audio-plugins">