summaryrefslogtreecommitdiffstats
path: root/DOCS/man/en/ao.rst
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2012-08-02 21:37:33 +0200
committerwm4 <wm4@nowhere>2012-08-02 22:05:27 +0200
commit504e2336b7631fac55413d660adad5c734dac10a (patch)
treef21fddfbf68577b3586605684a01668eb9a98d3b /DOCS/man/en/ao.rst
parented3f0c3e4b91b672b3a16ef884cd5a4ec3f6a12c (diff)
downloadmpv-504e2336b7631fac55413d660adad5c734dac10a.tar.bz2
mpv-504e2336b7631fac55413d660adad5c734dac10a.tar.xz
manpage: merge new manpage
About a year ago, ubitux converted most of the old manpage from the hard to maintain nroff format to reStructuredText. This was not merged back into the master repository immediately. The argument was that the new manpage still required work to be done. However, progress was very slow. Even worse: the old manpage wasn't updated, because it was scheduled for deletion, and updating it would have meant useless work. Now the situation is that the new manpage still isn't finished, and the old manpage is grossly out of sync with the player. This is not helpful for users. Additionally, keeping the new manpage in a separate branch, while the normal development repository for code had the old manpage, was very inconvenient, because you couldn't just update the documentation in the same commit as the code. Even though the new manpage isn't finished yet, merging it now seems to be the best course of action. Squash-merge the manpage development branch [1], revision e89f5dd3f2, which branches from the mplayer2 master branch after revision 159102e0cb. Committers: * Clément Bœsch <ubitux@gmail.com> (Initial conversion to RST.) * Uoti Urpala <uau@mplayer2.org> (Many updates.) * Myself (Minor edits.) Most text of the manpage has been directly taken from the old manpage, because this is a conversion, not a complete rewrite. [1] http://git.mplayer2.org/uau/mplayer2.git/log/?h=man
Diffstat (limited to 'DOCS/man/en/ao.rst')
-rw-r--r--DOCS/man/en/ao.rst152
1 files changed, 152 insertions, 0 deletions
diff --git a/DOCS/man/en/ao.rst b/DOCS/man/en/ao.rst
new file mode 100644
index 0000000000..4f817774ed
--- /dev/null
+++ b/DOCS/man/en/ao.rst
@@ -0,0 +1,152 @@
+.. _audio_outputs:
+
+AUDIO OUTPUT DRIVERS
+====================
+
+Audio output drivers are interfaces to different audio output facilities. The
+syntax is:
+
+--ao=<driver1[:suboption1[=value]:...],driver2,...[,]>
+ Specify a priority list of audio output drivers to be used.
+
+If the list has a trailing ',' MPlayer will fall back on drivers not contained
+in the list. Suboptions are optional and can mostly be omitted.
+
+*NOTE*: See ``--ao=help`` for a list of compiled-in audio output drivers.
+
+*EXAMPLE*:
+
+ - ``--ao=alsa,oss,`` Try the ALSA driver, then the OSS driver, then others.
+ - ``--ao=alsa:noblock:device=hw=0.3`` Sets noblock-mode and the device-name
+ as first card, fourth device.
+
+Available audio output drivers are:
+
+alsa
+ ALSA 0.9/1.x audio output driver
+
+ noblock
+ Sets noblock-mode.
+ device=<device>
+ Sets the device name. Replace any ',' with '.' and any ':' with '=' in
+ the ALSA device name. For hwac3 output via S/PDIF, use an "iec958" or
+ "spdif" device, unless you really know how to set it correctly.
+
+alsa5
+ ALSA 0.5 audio output driver
+
+oss
+ OSS audio output driver
+
+ <dsp-device>
+ Sets the audio output device (default: ``/dev/dsp``).
+ <mixer-device>
+ Sets the audio mixer device (default: ``/dev/mixer``).
+ <mixer-channel>
+ Sets the audio mixer channel (default: pcm).
+
+sdl (SDL only)
+ highly platform independent SDL (Simple Directmedia Layer) library audio
+ output driver
+
+ <driver>
+ Explicitly choose the SDL audio driver to use (default: let SDL
+ choose).
+
+jack
+ audio output through JACK (Jack Audio Connection Kit)
+
+ port=<name>
+ Connects to the ports with the given name (default: physical ports).
+ name=<client
+ Client name that is passed to JACK (default: MPlayer [<PID>]). Useful
+ if you want to have certain connections established automatically.
+ (no-)estimate
+ Estimate the audio delay, supposed to make the video playback smoother
+ (default: enabled).
+ (no-)autostart
+ Automatically start jackd if necessary (default: disabled). Note that
+ this seems unreliable and will spam stdout with server messages.
+
+nas
+ audio output through NAS
+
+coreaudio (Mac OS X only)
+ native Mac OS X audio output driver
+
+ device_id=<id>
+ ID of output device to use (0 = default device)
+ help
+ List all available output devices with their IDs.
+
+openal
+ Experimental OpenAL audio output driver
+
+pulse
+ PulseAudio audio output driver
+
+ [<host>][:<output sink>]
+ Specify the host and optionally output sink to use. An empty <host>
+ string uses a local connection, "localhost" uses network transfer
+ (most likely not what you want).
+
+sun (Sun only)
+ native Sun audio output driver
+
+ <device>
+ Explicitly choose the audio device to use (default: ``/dev/audio``).
+
+win32 (Windows only)
+ native Windows waveout audio output driver
+
+dsound (Windows only)
+ DirectX DirectSound audio output driver
+
+ device=<devicenum>
+ Sets the device number to use. Playing a file with ``-v`` will show a
+ list of available devices.
+
+ivtv (IVTV only)
+ IVTV specific MPEG audio output driver. Works with ``--ac=hwmpa`` only.
+
+v4l2 (requires Linux 2.6.22+ kernel)
+ Audio output driver for V4L2 cards with hardware MPEG decoder.
+
+mpegpes (DVB only)
+ Audio output driver for DVB cards that writes the output to an MPEG-PES
+ file if no DVB card is installed.
+
+ card=<1-4>
+ DVB card to use if more than one card is present. If not specified
+ MPlayer will search the first usable card.
+ file=<filename>
+ output filename
+
+null
+ Produces no audio output but maintains video playback speed. Use
+ ``--nosound`` for benchmarking.
+
+pcm
+ raw PCM/wave file writer audio output
+
+ (no-)waveheader
+ Include or do not include the wave header (default: included). When
+ not included, raw PCM will be generated.
+ file=<filename>
+ Write the sound to <filename> instead of the default
+ ``audiodump.wav``. If nowaveheader is specified, the default is
+ ``audiodump.pcm``.
+
+rsound
+ audio output to an RSound daemon
+
+ host=<name/path>
+ Set the address of the server (default: localhost). Can be either a
+ network hostname for TCP connections or a Unix domain socket path
+ starting with '/'.
+ port=<number>
+ Set the TCP port used for connecting to the server (default: 12345).
+ Not used if connecting to a Unix domain socket.
+
+plugin
+ plugin audio output driver