From 413a60419542895a13fa54640b44e074df8de162 Mon Sep 17 00:00:00 2001 From: nicolas Date: Sun, 23 Mar 2003 23:35:12 +0000 Subject: XML version of MPlayer's doc git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@9676 b3059339-0415-0410-9bf9-f77b7e298cf2 --- DOCS/xml/en/Makefile | 7 + DOCS/xml/en/audio.xml | 1144 + DOCS/xml/en/bugreports.xml | 321 + DOCS/xml/en/bugs.xml | 180 + DOCS/xml/en/cd-dvd.xml | 355 + DOCS/xml/en/codecs.xml | 856 + DOCS/xml/en/documentation.tex | 70603 ++++++++++++++++++++++++++++++++++++++++ DOCS/xml/en/documentation.xml | 226 + DOCS/xml/en/edl.xml | 66 + DOCS/xml/en/faq.xml | 1106 + DOCS/xml/en/features.xml | 17 + DOCS/xml/en/formats.xml | 455 + DOCS/xml/en/history.xml | 88 + DOCS/xml/en/install.xml | 894 + DOCS/xml/en/mail-lists.xml | 109 + DOCS/xml/en/mencoder.xml | 488 + DOCS/xml/en/patches.xml | 7 + DOCS/xml/en/ports.xml | 313 + DOCS/xml/en/skin.xml | 1094 + DOCS/xml/en/tvinput.xml | 203 + DOCS/xml/en/usage.xml | 436 + DOCS/xml/en/users-vs-dev.xml | 244 + DOCS/xml/en/video.xml | 2141 ++ 23 files changed, 81353 insertions(+) create mode 100644 DOCS/xml/en/Makefile create mode 100644 DOCS/xml/en/audio.xml create mode 100644 DOCS/xml/en/bugreports.xml create mode 100644 DOCS/xml/en/bugs.xml create mode 100644 DOCS/xml/en/cd-dvd.xml create mode 100644 DOCS/xml/en/codecs.xml create mode 100644 DOCS/xml/en/documentation.tex create mode 100644 DOCS/xml/en/documentation.xml create mode 100644 DOCS/xml/en/edl.xml create mode 100644 DOCS/xml/en/faq.xml create mode 100644 DOCS/xml/en/features.xml create mode 100644 DOCS/xml/en/formats.xml create mode 100644 DOCS/xml/en/history.xml create mode 100644 DOCS/xml/en/install.xml create mode 100644 DOCS/xml/en/mail-lists.xml create mode 100644 DOCS/xml/en/mencoder.xml create mode 100644 DOCS/xml/en/patches.xml create mode 100644 DOCS/xml/en/ports.xml create mode 100644 DOCS/xml/en/skin.xml create mode 100644 DOCS/xml/en/tvinput.xml create mode 100644 DOCS/xml/en/usage.xml create mode 100644 DOCS/xml/en/users-vs-dev.xml create mode 100644 DOCS/xml/en/video.xml (limited to 'DOCS/xml/en') diff --git a/DOCS/xml/en/Makefile b/DOCS/xml/en/Makefile new file mode 100644 index 0000000000..9526a6b068 --- /dev/null +++ b/DOCS/xml/en/Makefile @@ -0,0 +1,7 @@ +include ../Makefile.inc + +# Set if you are using your own HTML stylesheet... +#HTML_STYLESHEET = mystyle.css + +# Dependency information. +$(HTMLDIR)/index.html: $(wildcard *.xml) diff --git a/DOCS/xml/en/audio.xml b/DOCS/xml/en/audio.xml new file mode 100644 index 0000000000..b1f29ac19d --- /dev/null +++ b/DOCS/xml/en/audio.xml @@ -0,0 +1,1144 @@ + + +Audio output devices + +Audio/Video synchronisation + + +MPlayer's audio interface is called +libao2. It currently contains these drivers: + + + + + + DriverComment + + +oss + OSS (ioctl) driver (supports hardware AC3 passthrough) + +sdl + SDL driver (supports sound daemons like ESD + and ARTS) + +nas + NAS (Network Audio System) driver + +alsa5 + native ALSA 0.5 driver + +alsa9 + native ALSA 0.9 driver (supports hardware AC3 passthrough) + +sun + SUN audio driver (/dev/audio) for BSD and Solaris8 users + +arts + native ARTS driver (mostly for KDE users) + +esd + native ESD driver (mostly for GNOME users) + + + + + + +Linux sound card drivers have compatibility problems. This is because +MPlayer relies on an in-built feature of +properly coded sound drivers that enable them to +maintain correct audio/video sync. Regrettably, some driver authors +don't take the care to code this feature since it is not needed for +playing MP3s or sound effects. + + + +Other media players like aviplay +or xine possibly work +out-of-the-box with these drivers because they use "simple" methods +with internal timing. Measuring showed that their methods are not as +efficient as MPlayer's. + + + +Using MPlayer with a properly written audio +driver will never result in A/V desyncs related to the audio, except +only with very badly created files (check the man page for workarounds). + + + +If you happen to have a bad audio driver, try the +option, it should sort out your problems. See the man page for detailed +information. + + + +Some notes: + + If you have an OSS driver, first try (this is + the default). If you experience glitches, halts or anything out of the + ordinary, try (NOTE: you need to have SDL libraries + and header files installed). The SDL audio driver helps in a lot of cases + and also supports ESD (GNOME) and ARTS (KDE). + + + If you have ALSA version 0.5, then you almost always have to use + , since ALSA 0.5 has buggy OSS emulation code, + and will crash MPlayer + with a message like this: + +DEMUXER: Too many (945 in 8390980 bytes) video packets in the buffer! + + + On Solaris, use the SUN audio driver with the option, + otherwise neither video nor audio will work. + + + If the sound clicks when playing from CD-ROM, turn on IRQ unmasking, e.g. + hdparm -u1 /dev/cdrom (man hdparm). + This is generally beneficial and described in more detail in the + CD-ROM section. + + + + + +Soundcard experiences, recommendations + +On Linux, a 2.4.x kernel is highly recommended. Kernel 2.2 is not tested. + + + +Linux sound drivers are primarily provided by the free version of OSS. +These drivers have been superceded by ALSA +(Advanced Linux Sound Architecture) in the 2.5 development series. If +your distribution does not already use ALSA you may wish to try their +drivers if you experience sound problems. ALSA drivers are generally +superior to OSS in compatibility, performance and features. But some +sound cards are only supported by the commercial OSS drivers from +4Front Technologies. +They also support several non-Linux systems. + + + + + + + + + + + + + + + + + + + + SOUND CARD + DRIVER + Max kHz + Max Channels + Max Opens + + the number of applications that are able to use + the device at the same time. + + + + + + OSS/Free + ALSA + OSS/Pro + other + + + + + + VIA onboard (686/A/B, 8233, 8235) + + via82cxxx_audio + + snd-via82xx + + + 4-48 kHz or 48 kHz only, depending on the chipset + + + + + + Aureal Vortex 2 + none + none + OK + + Linux Aureal Drivers + buffer size increased to 32k + + 48 + 4.1 + 5+ + + + + SB Live! + Analog OK, SP/DIF not working + Both OK + Both OK + + Creative's OSS driver (SP/DIF support) + + 192 + 4.0/5.1 + 32 + + + + SB 128 PCI (es1371) + OK + ? + + + 48 + stereo + 2 + + + + SB AWE 64 + max 44kHz + 48kHz sounds bad + + + 48 + + + + + + GUS PnP + none + OK + OK + + 48 + + + + + + Gravis UltraSound ACE + + + + + + + + + + + Gravis UltraSound MAX + OK + OK (?) + + + 48 + + + + + + ESS 688 + OK + OK (?) + + + 48 + + + + + + C-Media cards (which ones?) + not OK (hissing) (?) + OK + + + ? + + + + + + Yamaha cards (*ymf*) + not OK (?) (maybe ) + OK only with ALSA 0.5 with OSS emulation + AND (!) (?) + + + + + + + + + Cards with envy24 chips (like Terratec EWS88MT) + ? + ? + OK + + ? + + + + + + PC Speaker or DAC + OK + none + + + Linux PC speaker OSS driver + + The driver emulates 44.1, maybe more. + mono + 1 + + + + + + + +Feedback to this document is welcome. Please tell us how +MPlayer and your sound card(s) worked together. + + + + +Audio filters + + The old audio plugins have been superseded by a new audio filter layer. Audio + filters are used for changing the properties of the audio data before the + sound reaches the sound card. The activation and deactivation of the filters + is normally automated but can be overridden. The filters are activated when + the properties of the audio data differ from those required by the sound card + and deactivated if unnecessary. The + option is used to override the automatic activation of filters or to insert + filters that are not automatically inserted. The filters will be executed as + they appear in the comma separated list. + + + +Example: +mplayer -af resample,pan movie.avi +would run the sound through the resampling filter followed by the pan filter. +Observe that the list must not contain any spaces, else it will fail. + + + +The filters often have options that change their behavior. These options +are explained in detail in the sections below. A filter will execute using +default settings if its options are omitted. Here is an example of how to use +filters in combination with filter specific options: +mplayer -af resample=11025,pan=1:0.5:0.5 -channels 1 -srate 11025 media.avi +would set the output frequency of the resample filter to 11025Hz and downmix +the audio to 1 channel using the pan filter. + + + + +The overall execution of the filter layer is controlled using the + option. This option has two suboptions: + + + + is a bit field that controls how the filters +are inserted and what speed/accuracy optimizations they use: + + + + + + +Use automatic insertion of filters and optimize according to CPU speed. + + + + + + +Use automatic insertion of filters and optimize for the highest speed. +Warning: Some features in the audio filters may +silently fail, and the sound quality may drop. + + + + + + +Use automatic insertion of filters and optimize for quality. + + + + + + +Use no automatic insertion of filters and no optimization. +Warning: It may be possible to crash MPlayer +using this setting. + + + + + + +Use automatic insertion of filters according to 0 above, +but use floating point processing when possible. + + + + + + +Use automatic insertion of filters according to 1 above, +but use floating point processing when possible. + + + + + + +Use automatic insertion of filters according to 2 above, +but use floating point processing when possible. + + + + + + +Use no automatic insertion of filters according to 3 above, +and use floating point processing when possible. + + + + + + is an alias for the -af option. + + + +The filter layer is also affected by the following generic options: + + + + + + +Increases the verbosity level and makes most filters print out extra +status messages. + + + + + + +This option sets the number of output channels you would like your +sound card to use. It also affects the number of channels that are +being decoded from the media. If the media contains less channels +than requested the channels filter (see below) will automatically +be inserted. The routing will be the default routing for the channels +filter. + + + + + + +This option selects the sample rate you would like your sound card +to use (of course the cards have limits on this). If the sample frequency +of your sound card is different from that of the current media, the resample +filter (see below) will be inserted into the audio filter layer to compensate +for the difference. + + + + + +This option sets the sample format between the audio filter layer and the +sound card. If the requested sample format of your sound card is different +from that of the current media, a format filter (see below) will be inserted +to rectify the difference. + + + + + +Up/Downsampling + + +MPlayer fully supports sound up/down-sampling through the +resample filter. It can be used if you +have a fixed frequency sound card or if you are stuck with an old sound card +that is only capable of max 44.1kHz. This filter is automatically enabled if +it is necessary, but it can also be explicitly enabled on the command line. It +has three options: + + + + + + + is an integer used for setting the output sample + frequency in Hz. The valid range for this parameter is 8kHz to 192kHz. If + the input and output sample frequency are the same or if this parameter is + omitted the filter is automatically unloaded. A high sample frequency + normally improves the audio quality, especially when used in combination + with other filters. + + + + + + + is an optional binary parameter that allows the output frequency to differ + slightly from the frequency given by . This option + can be used if the startup of the playback is extremely slow. It is enabled + by default. + + + + + + + is an optional integer between 0 and 2 that + selects which resampling method to use. Here 0 represents + linear interpolation as resampling method, 1 represents + resampling using a poly-phase filter-bank and integer processing and + 2 represents resampling using a poly-phase filter-bank and + floating point processing. Linear interpolation is extremely fast, but + suffers from poor sound quality especially when used for up-sampling. The + best quality is given by 2 but this method also suffers from + the highest CPU load. + + + + +Example: +mplayer -af resample=44100:0:0 +would set the output frequency of the resample filter to 44100Hz using exact output +frequency scaling and linear interpolation. + + + + +Changing the number of channels + +The filter can be used for adding and removing +channels, it can also be used for routing or copying channels. It is +automatically enabled when the output from the audio filter layer differs from +the input layer or when it is requested by another filter. This filter unloads +itself if not needed. The number of options is dynamic: + + + + + + + is an integer between 1 and 6 that is used + for setting the number of output channels. This option is required, leaving it + empty results in a runtime error. + + + + + + + is an integer between 1 and 6 that is used + for specifying the number of routes. This parameter is optional. If it is + omitted the default routing is used. + + + + + + + are pairs of numbers between 0 and 5 + that define where each channel should be routed. + + + + + + If only is given the default routing is used, it works + as follows: If the number of output channels is bigger than the number of input + channels empty channels are inserted (except mixing from mono to stereo, then + the mono channel is repeated in both of the output channels). If the number of + output channels is smaller than the number of input channels the exceeding + channels are truncated. + + + +Example 1: +mplayer -af channels=4:4:0:1:1:0:2:2:3:3 media.avi +would change the number of channels to 4 and set up 4 routes that swap +channel 0 and channel 1 and leave channel 2 and 3 intact. Observe that +if media containing two channels was played back, channels 2 and 3 would +contain silence but 0 and 1 would still be swapped. + + + +Exemple 2: +mplayer -af channels=6:4:0:0:0:1:0:2:0:3 media.avi +would change the number of channels to 6 and set up 4 routes that copy +channel 0 to channels 0 to 3. Channel 4 and 5 will contain silence. + + + + +Sample format converter + +The filter converts between different sample formats. It + is automatically enabled when needed by the sound card or another filter. + + + + + + + can be 1, 2 or 4 and + denotes the number of bytes per sample. This option is required, leaving it empty + results in a runtime error. + + + + + + + is a text string describing the sample format. The string is a + concatenated mix of: , or + , or , + or , or + (little or big endian). This option is required, + leaving it empty results in a runtime error. + + + + + +Example: +mplayer -af format=4:float media.avi +would set the output format to 4 bytes per sample floating point data. + + + + +Delay + +The filter delays the sound to the loudspeakers such that +the sound from the different channels arrives at the listening position +simultaneously. +It is only useful if you have more than 2 loudspeakers. This filter has a +variable number of parameters: + + + + + + + are floating point numbers representing the delays in ms that should be + imposed on the different channels. The minimum delay is 0ms and the maximum + is 1000ms. + + + + + +To calculate the required delay for the different channels do as follows: + + + + + Measure the distance to the loudspeakers in meters in relation to your + listening position, giving you the distances s1 to s5 (for a 5.1 system). + There is no point in compensating for the sub-woofer (you will not hear the + difference anyway). + + +Subtract the distances s1 to s5 from the maximum distance i.e. + s[i] = max(s) - s[i]; i = 1...5 + + +alculated the required delays in ms as + d[i] = 1000*s[i]/342; i = 1...5 + s[i] = max(s) - s[i]; i = 1...5 + + + + +Example: +mplayer -af delay=10.5:10.5:0:0:7:0 media.avi +would delay front left and right by 10.5ms, the two rear channels and the sub +by 0ms and the center channel by 7ms. + + + + + +Software volume control +Software volume control is implemented by the +audio filter. Use this filter with caution since it can reduce the signal to +noise ratio of the sound. In most cases it is best to set the level for the +PCM sound to max, leave this filter out and control the output level to your +speakers with the master volume control of the mixer. In case your sound card +has a digital PCM mixer instead of an analog one, and you hear distortion, +use the MASTER mixer instead. If there is an external amplifier connected to +the computer (this is almost always the case), the noise level can be minimized +by adjusting the master level and the volume knob on the amplifier until the +hissing noise in the background is gone. This filter has two options: + + + + + + + is a floating point number between -200 and +60 + which represents the volume level in dB. The default level is 0dB. + + + + + + + is a binary control that turns soft clipping on and off. Soft-clipping can + make the sound more smooth if very high volume levels are used. Enable this + option if the dynamic range of the loudspeakers is very low. Be aware that + this feature creates distortion and should be considered a last resort. + + + + + +Example: +mplayer -af volume=10.1:0 media.avi +would amplify the sound by 10.1dB and hard-clip if the sound level is too high. + + + +This filter has a second feature: It measures the overall maximum sound level +and prints out that level when MPlayer exits. This volume estimate can be used +for setting the sound level in MEncoder such that the maximum dynamic range is +utilized. + + + + +Equalizer + +The filter represents a 10 octave band graphic +equalizer, implemented using 10 IIR band pass filters. This means that +it works regardless of what type of audio is being played back. The center +frequencies for the 10 bands are: + + + + + + + Band No.Center frequency + + + + 031.25 Hz + 162.50 Hz + 2125.0 Hz + 3250.0 Hz + 4500.0 Hz + 51.000 kHz + 62.000 kHz + 74.000 kHz + 88.000 kHz + 916.00 kHz + + + + + +If the sample rate of the sound being played back is lower than the center +frequency for a frequency band, then that band will be disabled. A known +bug with this filter is that the characteristics for the uppermost band +are not completely symmetric if the sample rate is close to the center +frequency of that band. This problem can be worked around by up-sampling +the sound using the resample filter before it reaches this filter. + + + +This filter has 10 parameters: + + + + + + +are floating point numbers between -12 and +12 +representing the gain in dB for each frequency band. + + + + + +Example: +mplayer -af equalizer=11:11:10:5:0:-12:0:5:12:12 media.avi +would amplify the sound in the upper and lower frequency region while +canceling it almost completely around 1kHz. + + + + +Panning filter + +Use the filter to mix channels arbitrarily. It is +basically a combination of the volume control and the channels filter. +There are two major uses for this filter: + + + + +Down-mixing many channels to only a few, stereo to mono for example. + + +Varying the "width" of the center speaker in a surround sound system. + + + + +This filter is hard to use, and will require some tinkering before the +desired result is obtained. The number of options for this filter +depends on the number of output channels: + + + + + + +is an integer between 1 and 6 and is used +for setting the number of output channels. This option is required, leaving it +empty results in a runtime error. + + + + + + +are floating point values between 0 and 1. + determines how much of input channel j is mixed into +output channel i. + + + + + +Example 1: +mplayer -af pan=1:0.5:0.5 -channels 1 media.avi +would down-mix from stereo to mono. + + + +Example 2: +mplayer -af pan=3:1:0:1:0.5:0.5 -channels 3 media.avi +would give 3 channel output leaving channels 0 and 1 intact, and mix +channels 0 and 1 into output channel 2 (which could be sent to a +sub-woofer for example). + + + + +Sub-woofer + +The filter adds a sub woofer channel to the audio +stream. The audio data used for creating the sub-woofer channel is an +average of the sound in channel 0 and channel 1. The resulting sound is +then low-pass filtered by a 4th order Butterworth filter with a default +cutoff frequency of 60Hz and added to a separate channel in the audio +stream. Warning: Disable this filter when you are playing DVDs with Dolby +Digital 5.1 sound, otherwise this filter will disrupt the sound to the +sub-woofer. This filter has two parameters: + + + + + + + is an optional floating point number used for setting the cutoff frequency + for the filter in Hz. The valid range is 20Hz to 300Hz. For the best result + try setting the cutoff frequency as low as possible. This will improve the + stereo or surround sound experience. The default cutoff frequency is 60Hz. + + + + + + + is an optional integer between 0 and 5 + which determines the channel number in which to insert the sub-channel audio. + The default is channel number 5. Observe that the number of + channels will automatically be increased to ch if + necessary. + + + + + +Example: +mplayer -af sub=100:4 -channels 5 media.avi +would add a sub-woofer channel with a cutoff frequency of +100Hz to output channel 4. + + + + +Surround-sound decoder + +Matrix encoded surround sound can be decoded by the +filter. Dolby Surround is an example of a matrix encoded format. Many files +with 2 channel audio actually contain matrixed surround sound. To use this +feature you need a sound card supporting at least 4 channels. This filter has +one parameter: + + + + + + +is an optional floating point number between 0 and +1000 used for setting the delay time in ms for the +rear speakers. This delay should be set as follows: if d1 is the distance +from the listening position to the front speakers and d2 is the distance +from the listening position to the rear speakers, then the delay d should +be set to 15ms if d1 <= d2 and to 15 + 5*(d1-d2) if d1 > d2. The default +value for d is 20ms. + + + + + +Example: +mplayer -af surround=15 -channels 4 media.avi +would add surround sound decoding with 15ms delay for the sound to the +rear speakers. + + + + + +Audio plugins (deprecated) +Audio plugins have been deprecated by audio filters and will +be removed soon. + + +MPlayer has support for audio plugins. Audio +plugins can be used for changing the properties of the audio data before +the sound reaches the sound card. They are enabled using the + switch which takes a + argument. The + argument is required and determines which plugins +should be used and in which order they should be executed. Example: + +mplayer media.avi -aop list=resample,format + +would run the sound through the resampling plugin followed by the format +plugin. + + + +The plugins can also have switches that change their behavior. These +switches are explained in detail in the sections below. A plugin will +execute using default settings if its switches are omitted. Here is an +example of how to use plugins in combination with plugin specific switches: + +mplayer media.avi -aop list=resample,format:fout=44100:format=0x8 + +would set the output frequency of the resample plugin to 44100 Hz and the +output format of the format plugin to AFMT_U8. + + + +Currently audio plugins can not be used in +MEncoder. + + + + +Up/Downsampling + + +MPlayer fully supports up/downsampling of the sound. This plugin can be +used if you have a fixed frequency sound card or if you are stuck with an +old sound card that is only capable of max 44.1 kHz. Limitations in your +hardware are not auto detected, so you have to specify the sample frequency +explicitly. This plugin has one switch: which is used for setting the +desired output sample frequency. It defaults to 48 kHz, and is given in +Hz. + + + +Usage: + + +mplayer media.avi -aop list=resample:fout=freq + +where freq is the frequency +in Hz, like 44100. + + + + +The output frequency should not be scaled up from the default value. +Scaling up will cause the audio and video streams to be played in slow +motion in addition to audio distortion. + + + + + + +Surround Sound decoding + + +MPlayer has an audio plugin that can decode +matrix encoded surround sound. Dolby Surround is an example of a matrix +encoded format. Many files with 2 channel audio actually contain matrixed +surround sound. To use this feature you need a sound card supporting at +least 4 channels. + + + +Usage: +mplayer media.avi -aop list=surround + + + + + +Sample format converter + + +If your sound card driver does not support signed 16-bit int data type, +this plugin can be used to change the format to one which your sound card +can understand. It has one switch, , which can be +set to one of the numbers found in libao2/afmt.h. This +plugin is hardly ever needed and is intended for advanced users. Keep in +mind that this plugin only changes the sample format and not the sample +frequency or the number of channels. + + + +Usage: + + +mplayer media.avi -aop list=format:format=outfmt + +where outfmt is the +required output format. + + + + + +Delay + +This plugin delays the sound and is intended as an example of how to +develop new plugins. It can not be used for anything useful from a users +perspective and is mentioned here for the sake of completeness only. Do not +use this plugin unless you are a developer. + + + + + +Software volume control + + +This plugin is a software replacement for the volume control, and can be +used on machines with a broken mixer device. It can also be used if one +wants to change the output volume of MPlayer +without changing the PCM volume setting in the mixer. It has one switch + that is used for setting the initial sound level. +The initial sound level can be set to values between 0 and 255 and defaults +to 101 which equals 0dB amplification. Use this plugin with caution since +it can reduce the signal to noise ratio of the sound. In most cases it is +best to set the level for the PCM sound to max, leave this plugin out and +control the output level to your speakers with the master volume control of +the mixer. If there is an external amplifier connected to the computer +(this is almost always the case), the noise level can be minimized by +adjusting the master level and the volume knob on the amplifier until the +hissing noise in the background is gone. + + + +Usage: + +mplayer media.avi -aop list=volume:volume=0-255 + + + +This plugin also has compressor or "soft-clipping" capabilities. +Compression can be used if the dynamic range of the sound is very high or +if the dynamic range of the loudspeakers is very low. Be aware that this +feature creates distortion and should be considered a last resort. + + + +Usage: + +mplayer media.avi -aop list=volume:softclip + + + + +Extrastereo + + +This plugin (linearly) increases the difference between left and right +channels (like the XMMS extrastereo plugin) which gives some sort of "live" +effect to playback. + + + +Usage: + +mplayer media.avi -aop list=extrastereo +mplayer media.avi -aop list=extrastereo:mul=3.45 + +The default coefficient () is a float number that +defaults to 2.5. If you set it to 0.0, you will have +mono sound (average of both channels). If you set it to +1.0, sound will be unchanged, if you set it to +-1.0, left and right channels will be swapped. + + + + + +Volume normalizer + + +This plugin maximizes the volume without distorting the sound. + + + +Usage: +mplayer media.avi -aop list=volnorm + + + + diff --git a/DOCS/xml/en/bugreports.xml b/DOCS/xml/en/bugreports.xml new file mode 100644 index 0000000000..36c07d70df --- /dev/null +++ b/DOCS/xml/en/bugreports.xml @@ -0,0 +1,321 @@ + + +How to report bugs + +Good bug reports are a very valuable contribution to the development of any +software project. But just like writing good software, good problem reports +involve some work. Please realize that most developers are extremely busy and +receive obscene amounts of email. So while your feedback is crucial in improving +MPlayer and very much appreciated, please understand that you have to provide +all of the information we request and follow +the instructions in this document closely. + + +How to fix bugs + +If you feel have the necessary skills you are invited to have a go at fixing the +bug yourself. Or maybe you already did that? Please read +this short document to find out how to +get your code included in MPlayer. The people on the +mplayer-dev-eng +mailing list will assist you if you have questions. + + + +How to report bugs + +First of all please try the latest CVS version of MPlayer as your bug might +already be fixed there. Development moves extremely fast, most problems in +official releases are reported within days or even hours, so please use +only CVS to report bugs. This includes +binary packages of MPlayer. CVS instructions can be found at the bottom of +this page or in +the README. If this did not help please refer to the list of +known bugs and the rest of the documentation. If your +problem is not known or not solvable by our instructions, then please report the bug. + + + +Please do not send bug reports privately to individual developers. This is +community work and thus there might be several people interested in it. Sometimes +other users already experienced your troubles and know how to circumvent a problem +even if it is a bug in MPlayer code. + + + +Please describe your problem in as much detail as possible. Do a little detective +work to narrow down the circumstances under which the problem occurs. Does the bug +only show up in certain situations? Is it specific to certain files or file types? +Does it occur with only one codec or is it codec independent? Can you reproduce it +with all output drivers? The more information you provide the better are our +chances at fixing your problem. Please do not forget to also include the valuable +information requested below, we will be unable to properly diagnose your problem +otherwise. + + + +An excellent and well written guide to asking questions in public forums is +How To Ask +Questions The Smart Way by Eric S. Raymond. +There is another called +How to Report +Bugs Effectively by Simon Tatham. +If you follow these guidelines you should be able to get help. But please +understand that we all follow the mailing lists voluntarily in our free time. We +are very busy and cannot guarantee that you will get a solution for your problem +or even an answer. + + + + + +Where to report bugs + +Subscribe to the mplayer-users mailing list: + +and send your bug report to: + + + +The language of this list is English. Please follow the standard +Netiquette Guidelines and +do not send HTML mail to any of our mailing lists. You will only get ignored or +banned. If you do not know what HTML mail is or why it is evil, read this +fine document. It explains all +the details and has instructions for turning HTML off. Also note that we will not +individually CC (carbon-copy) people so it is a good idea to subscribe to actually +receive your answer. + + + + +What to report + +You may need to include log, configuration or sample files in your bug report. +If some of them are quite big then it is better to upload them to our +FTP server in a +compressed format (gzip and bzip2 preferred) and include only the path and file +name in your bug report. Our mailing lists have a message size limit of 80k, if +you have something bigger you have to compress or upload it. + + + +System Information + + + +Your Linux distribution or operating system and version e.g.: + + Red Hat 7.1 + Slackware 7.0 + devel packs from 7.1 ... + + + +kernel version: +uname -a + + +libc version: +ls -l /lib/libc[.-]* + + +gcc and ld versions: + +gcc -v +ld -v + + + +If you have problems with fullscreen mode: + + Window manager type and version + + + +If you have problems with XVIDIX: + + X colour depth: +xdpyinfo | grep "depth of root" + + + + +If only the GUI is buggy: + + GTK version + GLIB version + libpng version + GUI situation in which the bug occurs + + + + + + + +Hardware and drivers + + + +CPU info (this works on Linux only): +cat /proc/cpuinfo + + +Video card manufacturer and model, e.g.: + + ASUS V3800U chip: nVidia TNT2 Ultra pro 32MB SDRAM + Matrox G400 DH 32MB SGRAM + + + +Video driver type & version, e.g.: + + X built-in driver + nVidia 0.9.623 + Utah-GLX CVS 2001-02-17 + DRI from X 4.0.3 + + + +Sound card type & driver, e.g.: + + Creative SBLive! Gold with OSS driver from oss.creative.com + Creative SB16 with kernel OSS drivers + GUS PnP with ALSA OSS emulation + + + +If in doubt include lspci -vv output on Linux systems. + + + + + + +Configure problems + +If you get errors while running ./configure, or autodetection +of something fails, read configure.log. You may find the +answer there, for example multiple versions of the same library mixed on your +system, or you forgot to install the development package (those with the -dev +suffix). If you think there is a bug, include configure.log +in your bug report. + + + + +Compilation problems + +Please include these files: + +config.h +config.mak + +Only if compilation fails below one of these directories, include these files: + +Gui/config.mak +libvo/config.mak +libao2/config.mak + + + + + +Playback problems + +Please include the output of MPlayer at verbosity level +1, but remember to not truncate the output when +you paste it into your mail. The developers need all of the messages to properly +diagnose a problem. You can direct the output into a file like this: +mplayer -v options filename > mplayer.log 2>&1 + + + +If your problem is specific to one or more files, then please upload the offender(s) to: + + + + +Also upload a small text file having the same base name as your file with a .txt +extension. Describe the problem you are having with the particular file there and +include your email address as well as the output of MPlayer at verbosity level 1. +Usually the first 1-5 MB of a file are enough to reproduce the problem, but to be +sure we ask you to: +dd if=yourfile of=smallfile bs=1024k count=5 +It will take the first five megabytes of 'your-file' +and write it to 'small-file'. Then try again on +this small file and if the bug still shows up your sample is sufficient for us. +Please do not ever send such files via mail! +Upload it, and send only the path/filename of the file on the FTP-server. If the +file is accessible on the net, then sending the exact +URL is sufficient. + + + + +Crashes + +You have to run MPlayer inside gdb +and send us the complete output or if you have a core dump of +the crash you can extract useful information from the Core file. Here's how: + + + +How to conserve information about a reproducible crash + +Recompile MPlayer with debugging code enabled: + +./configure --enable-debug=3 +make + +and then run MPlayer within gdb using: +gdb ./mplayer +You are now within gdb. Type: +run -v options-to-mplayer filename +and reproduce your crash. As soon as you did it, gdb will return you to the command +line prompt where you have to enter + +bt +disass $pc-32 $pc+32 +info all-registers + + + + + +How to extract meaningful information from a core dump + +Please create the following command file: + +bt +disass $pc-32 $pc+32 +info all-registers + +Then simply execute the following on your command line: +gdb mplayer --core=core -batch --command=command_file > mplayer.bug + + + + + + +I know what I am doing... + +If you created a proper bug report following the steps above and you are confident +it is a bug in MPlayer, not a compiler problem or broken file, you have already +read the documentation and you could not find a solution, your sound drivers are +OK, then you might want to subscribe to the mplayer-advusers list and send your +bug report there to get a better and faster answer. + + + +Please be advised that if you post newbie questions or questions answered in the +manual there, you will be ignored or flamed instead of getting an appropriate answer. +So do not flame us and subscribe to -advusers only if you really know what you are +doing and feel like being an advanced MPlayer user or developer. If you meet these +criteria it should not be difficult to find out how to subscribe... + + + + + diff --git a/DOCS/xml/en/bugs.xml b/DOCS/xml/en/bugs.xml new file mode 100644 index 0000000000..b2f03bff74 --- /dev/null +++ b/DOCS/xml/en/bugs.xml @@ -0,0 +1,180 @@ + + +Known bugs + +Special system/CPU-specific bugs/problems + + +SIGILL (signal 4) on P3 using 2.2.x kernels: +Problem: kernel 2.2.x doesn't have proper (working) SSE support +Solution: upgrade kernel to 2.4.x +Workaround: ./configure --disable-sse + + +General SIGILL (signal 4): +Problem: you compiled and run mplayer in different machines +(for example compiled on P3 and running on Celeron) +Solution: compile MPlayer on the same machine where you will use it! +Workaround: ./configure --disable-sse etc. options + + +"Internal buffer inconsistency" during MEncoder run: +Problem: known problem when lame < 3.90 was compiled with gcc 2.96 or 3.x. +Solution: use lame >=3.90. +Workaround: compile lame with gcc 2.95.x and remove any already installed +lame packages, they may have been compiled with gcc 2.96. + + +Messed up MP2/MP3 sound on PPC: +Problem: known GCC miscompilation bug on PPC platforms, no fix yet. +Workaround: use FFmpeg's (slow) MP1/MP2/MP3 decoder () + + +sig11 in libmpeg2, when scaling+encoding: +Problem: known GCC 2.95.2 MMX bug, upgrade to 2.95.3. + + + + + +Various A-V sync and other audio problems + + +General audio delay or jerky sound (exists with all or many files) + + +most common: buggy audio driver! - try to use different drivers, try ALSA 0.9 OSS +emulation with , also try , +sometimes it helps. If your file plays fine with -nosound, then you can be sure +it's sound card (driver) problem. + + + + +audio buffer problems (buffer size badly detected) +Workaround: mplayer option + + + + +samplerate problems - maybe your card doesn't support the samplerate used in your +files - try the resampling plugin () + + + + +slow machine (CPU or VGA) +try with , if it plays well, then you have slow +VGA card/driver +Workaround: buy a faster card or read this documentation about how to +speed up +Also try + + + + + +Audio delay/de-sync specific to one or a few files + + +bad file + +Workaround: + + + or option (for + non-interleaved or bad files) + and/or + + + (required for files with badly + interleaved VBR audio) + and/or + + + or +/- + keys at runtime to adjust delay + + +If none of these help, please upload the file, we'll check (and fix). + + + +your sound card doesn't support 48kHz playback +Workaround: buy a better sound card... or try to decrease fps by 10% (use + for a 30fps movie) or use the resampler plugin + + +slow machine(if A-V is not around 0, and the last number in the status +line increasing) +Workaround: + + + + + +No sound at all + + +your file uses an unsupported audio codec +read the documentation and help us adding support for it + + + + + +No picture at all (just plain grey/green window) + + +your file uses an unsupported video codec +Workaround: read the documentation and help us adding support for it + + + +auto-selected codec can't decode the file, try to select another using + or options + + + + +you try to play DivX 3.x file with OpenDivX decoder or XviD +() - install Divx4Linux and recompile player + + + + + + +Video-out problems + +First note: options and are just +recommendations, not (yet) supported by all drivers. So it isn't a bug if it +doesn't work. Only a few driver supports scaling/zooming, don't expect this from +x11 or dga. + + + +OSD/sub flickering + + +x11 driver: sorry, it can't be fixed now +xv driver: use option + + + + + +Green image using mga_vid (<option>-vo mga</option> / <option>-vo xmga</option>) + + +mga_vid misdetected your card's RAM amount, reload it using + option + + + + + + + + + diff --git a/DOCS/xml/en/cd-dvd.xml b/DOCS/xml/en/cd-dvd.xml new file mode 100644 index 0000000000..eb7f6537b1 --- /dev/null +++ b/DOCS/xml/en/cd-dvd.xml @@ -0,0 +1,355 @@ + + +CD/DVD usage + + +CD/DVD drives + +Linux documentation excerpt: + + + +Modern CD-ROM drives can attain very high head speeds, yet some CD-ROM drives +are capable of running at reduced speeds. There are several reasons that might +make you consider changing the speed of a CD-ROM drive: + + + + +There have been reports of read errors at high speeds, especially +with badly pressed CD-ROMs. Reducing the speed can prevent data loss under +these circumstances. + + + +Many CD-ROM drives are annoyingly loud, a lower speed may reduce the noise. + + + + +You can reduce the speed of IDE CD-ROM drives with hdparm or a +program called setcd. It works like this: +hdparm -E [speed] [cdrom device] +setcd -x [speed] [cdrom device] + + + +You can also try +echo current_speed:4 > /proc/ide/[cdrom device]/settings +but you will need root privileges. The following command may also help: +echo file_readahead:2000000 > /proc/ide/[cdrom device]/settings + + + +This sets prefetched file reading to 2MB, which helps with scratched CD-ROMs. +If you set it to too high, the drive will continuously spin up and down, and +will dramatically decrease the performance. +It is recommended that you also tune your CD-ROM drive with hdparm: +hdparm -d1 -a8 -u1 cdrom device + + + +This enables DMA access, read-ahead, and IRQ unmasking (read the hdparm +man page for a detailed explanation). + + + +Please refer to "/proc/ide/[cdrom device]/settings" +for fine-tuning your CD-ROM. + + + +SCSI drives do not have a uniform way of setting these parameters (Do you know one? +Tell us!) There is a tool that works for +Plextor SCSI drives. + + +FreeBSD: +Speed: cdcontrol [-f device] speed [speed] +DMA: sysctl hw.ata.atapi_dma=1 + + + +DVD playback + +For the complete list of available options, please read the man page. +The Syntax for a standard Digital Versatile Disc (DVD) is as follows: +mplayer -dvd <track> [-dvd-device <device>] + + + +Example: +mplayer -dvd 1 -dvd-device /dev/hdc + + + +The default DVD device is /dev/dvd. If your setup +differs, make a symlink or specify the correct device on the command +line with the option. + + + +New-style DVD support (mpdvdkit2) + +MPlayer uses libdvdread and +libdvdcss for DVD decryption and playback. These two +libraries are contained in the libmpdvdkit2/ +subdirectory of the MPlayer source tree, you do not have to install them separately. +We opted for this solution because we had to fix a libdvdread +bug and apply a patch which adds +cracked CSS keys caching support to +libdvdcss This results in a large speed increase because the +keys do not have to be cracked every time before playing. + + + + +MPlayer can also use system-wide libdvdread +and libdvdcss libraries, but this solution is +not recommended, as it can result in bugs, +library incompatibilities and slower speed. + + + +DVD Navigation support (dvdnav) + +Support