Mercurial > mplayer.hg
comparison DOCS/man/en/mplayer.1 @ 14787:346ace66cdb4
Move audio filter descriptions to the man page.
author | diego |
---|---|
date | Thu, 24 Feb 2005 11:00:45 +0000 |
parents | 13feacc885a7 |
children | c3245111b6fb |
comparison
equal
deleted
inserted
replaced
14786:e1bf5e07962f | 14787:346ace66cdb4 |
---|---|
3505 To get a full list of available audio filters, see \-af help. | 3505 To get a full list of available audio filters, see \-af help. |
3506 .PP | 3506 .PP |
3507 Available filters are: | 3507 Available filters are: |
3508 . | 3508 . |
3509 .TP | 3509 .TP |
3510 .B resample[=srate[:sloppy][:type]] | 3510 .B resample[=srate[:sloppy[:type]]] |
3511 Changes the sample rate of the audio stream to an integer srate in Hz. | 3511 Changes the sample rate of the audio stream. |
3512 Can be used if you have a fixed frequency sound card or if you are | |
3513 stuck with an old sound card that is only capable of max 44.1kHz. | |
3514 This filter is automatically enabled if necessary. | |
3512 It only supports the 16-bit little-endian format. | 3515 It only supports the 16-bit little-endian format. |
3516 .br | |
3517 .I NOTE: | |
3513 With MEncoder, you need to also use \-srate <srate>. | 3518 With MEncoder, you need to also use \-srate <srate>. |
3519 .PD 0 | |
3520 .RSs | |
3521 .IPs <srate> | |
3522 output sample frequency in Hz. | |
3523 The valid range for this parameter is 8000 to 192000. | |
3524 If the input and output sample frequency are the same or if this | |
3525 parameter is omitted the filter is automatically unloaded. | |
3526 A high sample frequency normally improves the audio quality, | |
3527 especially when used in combination with other filters. | |
3528 .IPs <sloppy> | |
3529 Allow (1) or disallow (0) the output frequency to differ slightly | |
3530 from the frequency given by <srate> (default: 1). | |
3531 Can be used if the startup of the playback is extremely slow. | |
3532 .IPs <type> | |
3533 Selects which resampling method to use. | |
3534 .RSss | |
3535 0: linear interpolation (fast, poor quality especially when upsampling) | |
3536 .br | |
3537 1: polyphase filterbank and integer processing | |
3538 .br | |
3539 2: polyphase filterbank and floating point processing (slow, best quality) | |
3540 .REss | |
3541 .PD 1 | |
3542 .RE | |
3543 .sp 1 | |
3544 .RS | |
3545 .I EXAMPLE: | |
3546 .RE | |
3547 .PD 0 | |
3548 .RSs | |
3549 .IPs "mplayer -af resample=44100:0:0" | |
3550 would set the output frequency of the resample filter to 44100Hz using | |
3551 exact output frequency scaling and linear interpolation. | |
3552 .RE | |
3553 .PD 1 | |
3514 . | 3554 . |
3515 .TP | 3555 .TP |
3516 .B lavcresample[=srate[:length[:linear[:count[:cutoff]]]]] | 3556 .B lavcresample[=srate[:length[:linear[:count[:cutoff]]]]] |
3517 Changes the sample rate of the audio stream to an integer srate in Hz. | 3557 Changes the sample rate of the audio stream to an integer <srate> in Hz. |
3518 It only supports the 16-bit little-endian format. | 3558 It only supports the 16-bit little-endian format. |
3559 .br | |
3560 .I NOTE: | |
3519 With MEncoder, you need to also use \-srate <srate>. | 3561 With MEncoder, you need to also use \-srate <srate>. |
3520 .PD 0 | 3562 .PD 0 |
3521 .RSs | 3563 .RSs |
3522 .IPs <srate> | 3564 .IPs <srate> |
3523 the output sample rate | 3565 the output sample rate |
3542 .B hrtf\ \ \ | 3584 .B hrtf\ \ \ |
3543 Head-related transfer function: Converts multichannel audio to | 3585 Head-related transfer function: Converts multichannel audio to |
3544 2 channel output for headphones, preserving the spatiality of the sound. | 3586 2 channel output for headphones, preserving the spatiality of the sound. |
3545 . | 3587 . |
3546 .TP | 3588 .TP |
3547 .B channels[=nch] | 3589 .B equalizer=[g1:g2:g3:...:g10] |
3548 Change the number of channels to <nch> output channels. | 3590 10 octave band graphic equalizer, implemented using 10 IIR band pass filters. |
3549 If the number of output channels is bigger than the number of input channels | 3591 This means that it works regardless of what type of audio is being played back. |
3550 empty channels are inserted (except when mixing from mono to stereo, then | 3592 The center frequencies for the 10 bands are: |
3551 the mono channel is repeated in both of the output channels). | 3593 .sp 1 |
3552 If the number of output channels is smaller than the number of input channels | 3594 .PD 0 |
3553 the exceeding channels are truncated. | 3595 .RS |
3596 .IPs "No. frequency" | |
3597 .IPs "0 31.25 Hz" | |
3598 .IPs "1 62.50 Hz" | |
3599 .IPs "2 125.00 Hz" | |
3600 .IPs "3 250.00 Hz" | |
3601 .IPs "4 500.00 Hz" | |
3602 .IPs "5 1.00 kHz" | |
3603 .IPs "6 2.00 kHz" | |
3604 .IPs "7 4.00 kHz" | |
3605 .IPs "8 8.00 kHz" | |
3606 .IPs "9 16.00 kHz" | |
3607 .RE | |
3608 .PD 1 | |
3609 .sp 1 | |
3610 .RS | |
3611 If the sample rate of the sound being played is lower than the center | |
3612 frequency for a frequency band, then that band will be disabled. | |
3613 A known bug with this filter is that the characteristics for the | |
3614 uppermost band are not completely symmetric if the sample | |
3615 rate is close to the center frequency of that band. | |
3616 This problem can be worked around by upsampling the sound | |
3617 using the resample filter before it reaches this filter. | |
3618 .RE | |
3619 .PD 0 | |
3620 .RSs | |
3621 .IPs <g1>:<g2>:<g3>:...:<g10> | |
3622 floating point numbers representing the gain in dB | |
3623 for each frequency band (-12\-12) | |
3624 .RE | |
3625 .sp 1 | |
3626 .RS | |
3627 .I EXAMPLE: | |
3628 .RE | |
3629 .RSs | |
3630 .IPs "mplayer \-af equalizer=11:11:10:5:0:-12:0:5:12:12 media.avi" | |
3631 Would amplify the sound in the upper and lower frequency region | |
3632 while canceling it almost completely around 1kHz. | |
3633 .RE | |
3634 .PD 1 | |
3635 . | |
3636 .TP | |
3637 .B channels=nch[:nr:from1:to1:from2:to2:from3:to3:...] | |
3638 Can be used for adding, removing, routing and copying audio channels. | |
3639 If only <nch> is given the default routing is used, it works as | |
3640 follows: If the number of output channels is bigger than the number of | |
3641 input channels empty channels are inserted (except mixing from mono to | |
3642 stereo, then the mono channel is repeated in both of the output | |
3643 channels). | |
3644 If the number of output channels is smaller than the number | |
3645 of input channels the exceeding channels are truncated. | |
3646 .PD 0 | |
3647 .RSs | |
3648 .IPs <nch> | |
3649 number of output channels (1\-6) | |
3650 .IPs <nr>\ | |
3651 number of routes (1\-6) | |
3652 .IPs <from1:to1:from2:to2:from3:to3:...> | |
3653 Pairs of numbers between 0 and 5 that define where to route each channel. | |
3654 .RE | |
3655 .sp 1 | |
3656 .RS | |
3657 .I EXAMPLE: | |
3658 .RE | |
3659 .RSs | |
3660 .IPs "mplayer -af channels=4:4:0:1:1:0:2:2:3:3 media.avi" | |
3661 Would change the number of channels to 4 and set up 4 routes that | |
3662 swap channel 0 and channel 1 and leave channel 2 and 3 intact. | |
3663 Observe that if media containing two channels was played back, channels | |
3664 2 and 3 would contain silence but 0 and 1 would still be swapped. | |
3665 .IPs "mplayer -af channels=6:4:0:0:0:1:0:2:0:3 media.avi" | |
3666 Would change the number of channels to 6 and set up 4 routes | |
3667 that copy channel 0 to channels 0 to 3. | |
3668 Channel 4 and 5 will contain silence. | |
3669 .RE | |
3670 .PD 1 | |
3554 . | 3671 . |
3555 .TP | 3672 .TP |
3556 .B format[=format] | 3673 .B format[=format] |
3557 Change the current sample format. | 3674 Convert between different sample formats. |
3675 Automatically enabled when needed by the sound card or another filter. | |
3558 .PD 0 | 3676 .PD 0 |
3559 .RSs | 3677 .RSs |
3560 .IPs <format> | 3678 .IPs <format> |
3561 Sets the desired format. | 3679 Sets the desired format. |
3562 The general form is 'sbe', where 's' denotes the sign (either 's' for signed | 3680 The general form is 'sbe', where 's' denotes the sign (either 's' for signed |
3563 or 'u' for unsigned), 'b' denotes the number of bits per sample (16, 24 or 32) | 3681 or 'u' for unsigned), 'b' denotes the number of bits per sample (16, 24 or 32) |
3564 and 'e' denotes the endianness ('le' means little-endian, 'be' big-endian | 3682 and 'e' denotes the endianness ('le' means little-endian, 'be' big-endian |
3565 and 'ne' the endianness of the computer MPlayer is running on). | 3683 and 'ne' the endianness of the computer MPlayer is running on). |
3566 Valid values (amongst others) are: 's16le', 'u32be' and 'u24ne'. | 3684 Valid values (amongst others) are: 's16le', 'u32be' and 'u24ne'. |
3567 Exceptions to this rule are: u8, s8, floatle, floatbe, floatne, mulaw, alaw, | 3685 Exceptions to this rule that are also valid format specifiers: u8, s8, |
3568 mpeg2, ac3 and imaadpcm. | 3686 floatle, floatbe, floatne, mulaw, alaw, mpeg2, ac3 and imaadpcm. |
3569 .RE | 3687 .RE |
3570 .PD 1 | 3688 .PD 1 |
3571 . | 3689 . |
3572 .TP | 3690 .TP |
3573 .B volume[=v:sc] | 3691 .B volume[=v[:sc]] |
3574 Select the output volume level. | 3692 Implements software volume control. |
3575 This filter is not reentrant and can therefore only be enabled once for every | 3693 Use this filter with caution since it can reduce the signal |
3576 audio stream. | 3694 to noise ratio of the sound. |
3695 In most cases it is best to set the level for the PCM sound to max, | |
3696 leave this filter out and control the output level to your | |
3697 speakers with the master volume control of the mixer. | |
3698 In case your sound card has a digital PCM mixer instead of an analog | |
3699 one, and you hear distortion, use the MASTER mixer instead. | |
3700 If there is an external amplifier connected to the computer (this | |
3701 is almost always the case), the noise level can be minimized by | |
3702 adjusting the master level and the volume knob on the amplifier | |
3703 until the hissing noise in the background is gone. | |
3704 .br | |
3705 This filter has a second feature: It measures the overall maximum | |
3706 sound level and prints out that level when MPlayer exits. | |
3707 This volume estimate can be used for setting the sound level in | |
3708 MEncoder such that the maximum dynamic range is utilized. | |
3709 .br | |
3710 .I NOTE: | |
3711 This filter is not reentrant and can therefore only be enabled | |
3712 once for every audio stream. | |
3577 .PD 0 | 3713 .PD 0 |
3578 .RSs | 3714 .RSs |
3579 .IPs <v>\ \ | 3715 .IPs <v>\ \ |
3580 Sets the desired gain in dB for all channels in the stream | 3716 Sets the desired gain in dB for all channels in the stream |
3581 from -200dB to +60dB (where -200dB mutes the sound | 3717 from -200dB to +60dB, where -200dB mutes the sound |
3582 completely and +60dB equals a gain of 1000). | 3718 completely and +60dB equals a gain of 1000 (default: 0). |
3583 .IPs <sc>\ | 3719 .IPs <sc>\ |
3584 Enable soft clipping. | 3720 Turns soft clipping on (1) or off (0). |
3585 .RE | 3721 Soft-clipping can make the sound more smooth if very |
3586 .PD 1 | 3722 high volume levels are used. |
3587 . | 3723 Enable this option if the dynamic range of the |
3588 .TP | 3724 loudspeakers is very low. |
3589 .B pan[=n:l01:l02:...l10:l11:l12:...ln0:ln1:ln2:...] | 3725 .br |
3590 Mixes channels arbitrarily, see DOCS/\:HTML/\:en/\:audio.html for details. | 3726 .I WARNING: |
3591 An example how to downmix a six-channel file to two channels with this | 3727 This feature creates distortion and should be considered a last resort. |
3592 filter can be found in the examples section near the end of the man page. | 3728 .RE |
3729 .sp 1 | |
3730 .RS | |
3731 .I EXAMPLE: | |
3732 .RE | |
3733 .RSs | |
3734 .IPs "mplayer -af volume=10.1:0 media.avi" | |
3735 would amplify the sound by 10.1dB and hard-clip if the | |
3736 sound level is too high. | |
3737 .RE | |
3738 .PD 1 | |
3739 . | |
3740 .TP | |
3741 .B pan=n[:l01:l02:...l10:l11:l12:...ln0:ln1:ln2:...] | |
3742 Mixes channels arbitrarily. | |
3743 Basically a combination of the volume and the channels filter | |
3744 that can be used to down-mix many channels to only a few, | |
3745 e.g.\& stereo to mono or vary the "width" of the center | |
3746 speaker in a surround sound system. | |
3747 This filter is hard to use, and will require some tinkering | |
3748 before the desired result is obtained. | |
3749 The number of options for this filter depends on | |
3750 the number of output channels. | |
3751 An example how to downmix a six-channel file to two channels with | |
3752 this filter can be found in the examples section near the end. | |
3593 .PD 0 | 3753 .PD 0 |
3594 .RSs | 3754 .RSs |
3595 .IPs <n>\ \ | 3755 .IPs <n>\ \ |
3596 number of input channels (1\-6) | 3756 number of input channels (1\-6) |
3597 .IPs <lij> | 3757 .IPs <lij> |
3598 How much of input channel j is mixed into output channel i. | 3758 How much of input channel j is mixed into output channel i (0\-1). |
3759 .RE | |
3760 .sp 1 | |
3761 .RS | |
3762 .I EXAMPLE: | |
3763 .RE | |
3764 .RSs | |
3765 .IPs "mplayer -af pan=1:0.5:0.5 -channels 1 media.avi" | |
3766 Would down-mix from stereo to mono. | |
3767 .IPs "mplayer -af pan=3:1:0:1:0.5:0.5 -channels 3 media.avi" | |
3768 Would give 3 channel output leaving channels 0 and 1 intact, | |
3769 and mix channels 0 and 1 into output channel 2 (which could | |
3770 be sent to a subwoofer for example). | |
3599 .RE | 3771 .RE |
3600 .PD 1 | 3772 .PD 1 |
3601 . | 3773 . |
3602 .TP | 3774 .TP |
3603 .B sub[=fc:ch] | 3775 .B sub[=fc:ch] |
3604 Add subwoofer channel. | 3776 Adds a subwoofer channel to the audio stream. |
3777 The audio data used for creating the subwoofer channel is | |
3778 an average of the sound in channel 0 and channel 1. | |
3779 The resulting sound is then low-pass filtered by a 4th order | |
3780 Butterworth filter with a default cutoff frequency of 60Hz | |
3781 and added to a separate channel in the audio stream. | |
3782 .br | |
3783 .I Warning: | |
3784 Disable this filter when you are playing DVDs with Dolby | |
3785 Digital 5.1 sound, otherwise this filter will disrupt | |
3786 the sound to the subwoofer. | |
3605 .PD 0 | 3787 .PD 0 |
3606 .RSs | 3788 .RSs |
3607 .IPs <fc>\ | 3789 .IPs <fc>\ |
3608 cutoff frequency for low-pass filter (20Hz to 300Hz) (default: 60Hz) | 3790 cutoff frequency in Hz for the low-pass filter (20Hz to 300Hz) (default: 60Hz) |
3791 For the best result try setting the cutoff frequency as low as possible. | |
3792 This will improve the stereo or surround sound experience. | |
3609 .IPs <ch>\ | 3793 .IPs <ch>\ |
3610 channel number for the sub-channel | 3794 Determines the channel number in which to insert the sub-channel audio. |
3795 Channel number can be between 0 and 5 (default: 5). | |
3796 Observe that the number of channels will automatically | |
3797 be increased to <ch> if necessary. | |
3798 .RE | |
3799 .sp 1 | |
3800 .RS | |
3801 .I EXAMPLE: | |
3802 .RE | |
3803 .RSs | |
3804 .IPs "mplayer -af sub=100:4 -channels 5 media.avi" | |
3805 would add a sub-woofer channel with a cutoff frequency of | |
3806 100Hz to output channel 4. | |
3611 .RE | 3807 .RE |
3612 .PD 1 | 3808 .PD 1 |
3613 . | 3809 . |
3614 .TP | 3810 .TP |
3615 .B surround[=delay] | 3811 .B surround[=delay] |
3616 Decoder for matrix encoded surround sound, works on many 2 channel files. | 3812 Decoder for matrix encoded surround sound like Dolby Surround. |
3813 Many files with 2 channel audio actually contain matrixed surround sound. | |
3814 Requires a sound card supporting at least 4 channels. | |
3617 .PD 0 | 3815 .PD 0 |
3618 .RSs | 3816 .RSs |
3619 .IPs <delay> | 3817 .IPs <delay> |
3620 delay time in ms for the rear speakers (0 to 1000) (default: 20) | 3818 delay time in ms for the rear speakers (0 to 1000) (default: 20) |
3819 This delay should be set as follows: If d1 is the distance | |
3820 from the listening position to the front speakers and d2 is the distance | |
3821 from the listening position to the rear speakers, then the delay d should | |
3822 be set to 15ms if d1 <= d2 and to 15 + 5*(d1-d2) if d1 > d2. | |
3823 .RE | |
3824 .sp 1 | |
3825 .RS | |
3826 .I EXAMPLE: | |
3827 .RE | |
3828 .RSs | |
3829 .IPs "mplayer \-af surround=15 \-channels 4 media.avi" | |
3830 Would add surround sound decoding with 15ms delay for the sound to the | |
3831 rear speakers. | |
3621 .RE | 3832 .RE |
3622 .PD 1 | 3833 .PD 1 |
3623 . | 3834 . |
3624 .TP | 3835 .TP |
3625 .B delay[=ch1:ch2:...] | 3836 .B delay[=ch1:ch2:...] |
3626 Delays the sound output. | 3837 Delays the sound to the loudspeakers such that the sound from the |
3627 Specify the delay separately for each channel in milliseconds (floating point | 3838 different channels arrives at the listening position simultaneously. |
3628 number between 0 and 1000). | 3839 It is only useful if you have more than 2 loudspeakers. |
3840 .PD 0 | |
3841 .RSs | |
3842 .IPs ch1,ch2,... | |
3843 The delay in ms that should be imposed on each channel | |
3844 (floating point number between 0 and 1000). | |
3845 .RE | |
3846 .PD 1 | |
3847 .sp 1 | |
3848 .RS | |
3849 To calculate the required delay for the different channels do as follows: | |
3850 .IP 1. 3 | |
3851 Measure the distance to the loudspeakers in meters in relation | |
3852 to your listening position, giving you the distances s1 to s5 | |
3853 (for a 5.1 system). There is no point in compensating for the | |
3854 subwoofer (you will not hear the difference anyway). | |
3855 .IP 2. 3 | |
3856 Subtract the distances s1 to s5 from the maximum distance, | |
3857 i.e.\& s[i] = max(s) - s[i]; i = 1...5. | |
3858 .IP 3. | |
3859 Calculate the required delays in ms as d[i] = 1000*s[i]/342; i = 1...5. | |
3860 .RE | |
3861 .PD 0 | |
3862 .sp 1 | |
3863 .RS | |
3864 .I EXAMPLE: | |
3865 .RE | |
3866 .RSs | |
3867 .IPs "mplayer \-af delay=10.5:10.5:0:0:7:0 media.avi" | |
3868 Would delay front left and right by 10.5ms, the two rear channels | |
3869 and the sub by 0ms and the center channel by 7ms. | |
3870 .RE | |
3871 .PD 1 | |
3629 . | 3872 . |
3630 .TP | 3873 .TP |
3631 .B export[=mmapped_file[:nsamples]] | 3874 .B export[=mmapped_file[:nsamples]] |
3632 Exports the incoming signal to other processes using memory mapping (mmap()). | 3875 Exports the incoming signal to other processes using memory mapping (mmap()). |
3876 Memory mapped areas contain a header: | |
3877 .sp 1 | |
3878 .nf | |
3879 int nch /*number of channels*/ | |
3880 int size /*buffer size*/ | |
3881 unsigned long long counter /*Used to keep sync, updated every | |
3882 time new data is exported.*/ | |
3883 .fi | |
3884 .sp 1 | |
3885 The rest is payload (non-interleaved) 16 bit data. | |
3633 .PD 0 | 3886 .PD 0 |
3634 .RSs | 3887 .RSs |
3635 .IPs <mmapped_file> | 3888 .IPs <mmapped_file> |
3636 file to map data to (default: ~/.mplayer/\:mplayer-af_export) | 3889 file to map data to (default: ~/.mplayer/\:mplayer-af_export) |
3637 .IPs <nsamples> | 3890 .IPs <nsamples> |
3638 number of samples per channel (default: 512) | 3891 number of samples per channel (default: 512) |
3639 .RE | 3892 .RE |
3893 .sp 1 | |
3894 .RS | |
3895 .I EXAMPLE: | |
3896 .RE | |
3897 .RSs | |
3898 .IPs "mplayer \-af export=/tmp/mplayer-af_export:1024 media.avi" | |
3899 Would export 1024 samples per channel to '/tmp/mplayer-af_export'. | |
3900 .RE | |
3640 .PD 1 | 3901 .PD 1 |
3641 . | 3902 . |
3642 .TP | 3903 .TP |
3643 .B extrastereo[=mul] | 3904 .B extrastereo[=mul] |
3644 Increases the difference between left and right channels to add some | 3905 (Linearly) increases the difference between left and right channels |
3645 sort of "live" effect to playback. | 3906 which adds some sort of "live" effect to playback. |
3646 .PD 0 | 3907 .PD 0 |
3647 .RSs | 3908 .RSs |
3648 .IPs <mul> | 3909 .IPs <mul> |
3649 difference coefficient (default: 2.5) | 3910 Sets the difference coefficient (default: 2.5). |
3911 0.0 means mono sound (average of both channels), with 1.0 sound will be | |
3912 unchanged, with -1.0 left and right channels will be swapped. | |
3650 .RE | 3913 .RE |
3651 .PD 1 | 3914 .PD 1 |
3652 . | 3915 . |
3653 .TP | 3916 .TP |
3654 .B volnorm | 3917 .B volnorm |
3701 from the upper left corner of the bigger image. | 3964 from the upper left corner of the bigger image. |
3702 .br | 3965 .br |
3703 .I NOTE: | 3966 .I NOTE: |
3704 To get a full list of available video filters, see \-vf help. | 3967 To get a full list of available video filters, see \-vf help. |
3705 .sp 1 | 3968 .sp 1 |
3706 Filters are managed in lists. | 3969 Video filters are managed in lists. |
3707 There are a few commands to manage the filter list. | 3970 There are a few commands to manage the filter list. |
3708 . | 3971 . |
3709 .TP | 3972 .TP |
3710 .B \-vf-add <filter1[,filter2,...]> | 3973 .B \-vf-add <filter1[,filter2,...]> |
3711 Appends the filters given as arguments to the filter list. | 3974 Appends the filters given as arguments to the filter list. |