summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authordiego <diego@b3059339-0415-0410-9bf9-f77b7e298cf2>2003-11-03 01:45:04 +0000
committerdiego <diego@b3059339-0415-0410-9bf9-f77b7e298cf2>2003-11-03 01:45:04 +0000
commit7caac82cf9dc0775e0e01a1db89900d331912e4d (patch)
tree706a8596c85aa04e8d4eff152355c4ce45b7279a /DOCS
parent04fa0fd56f9fdbc74088ccce4c6a232740c6d695 (diff)
downloadmpv-7caac82cf9dc0775e0e01a1db89900d331912e4d.tar.bz2
mpv-7caac82cf9dc0775e0e01a1db89900d331912e4d.tar.xz
Export audio filter documentation by Gustavo Sverzut Barbieri
<gsbarbieri at yahoo.com.br>, cleaned up by me. git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@11367 b3059339-0415-0410-9bf9-f77b7e298cf2
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/man/en/mplayer.17
-rw-r--r--DOCS/xml/en/audio.xml41
2 files changed, 48 insertions, 0 deletions
diff --git a/DOCS/man/en/mplayer.1 b/DOCS/man/en/mplayer.1
index 5907007cef..566e053921 100644
--- a/DOCS/man/en/mplayer.1
+++ b/DOCS/man/en/mplayer.1
@@ -2024,6 +2024,13 @@ d: delay time in ms for the rear speakers (0ms to 1000ms) default is 15ms.
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
diff --git a/DOCS/xml/en/audio.xml b/DOCS/xml/en/audio.xml
index dd68bdca8e..d178f63452 100644
--- a/DOCS/xml/en/audio.xml
+++ b/DOCS/xml/en/audio.xml
@@ -942,6 +942,47 @@ would add surround sound decoding with 15ms delay for the sound to the
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">