comparison DOCS/documentation.html @ 6811:76595595dcb0

Reviewed Filter section, added limit parameter to cropdetect, not only SDL supports expand.

6810:a4ed4e0464ba

<P><A NAME=2.6><B>2.6.  Video filters</B></A></P>


<P><A NAME=2.6.1><B>2.6.1.  Overview</B></A></P>

<P>Both <B>MPlayer</B> and <B>MEncoder</B> supports using a universal
  video filter layer, which comprises of numerous plugins - listed and
  explained below. These plugins can perform various actions on the image,
  such as rescale, crop black borders (useful not only for encoding but for
  playing too, since black borders increase bus usage, and cropping these
  can boost playing speed on slow boards), expand image (for SVCDs).</P>

<P>With this filter layer it's possible to perform fast image format conversion
  between the various RGB and YUV when necessary. This enables for example
  playing RGB data on <CODE>xv</CODE> and <CODE>xmga</CODE> outputs, amongst
  others. (see the <A HREF="#2.6.11">Scale</A> filter)</P>

<P>The layer also does <B>Direct Rendering</B> between the plugins, to
  maximize the speed.

<P>Note that the postprocessing code is now also a part of the layer. It
  will be explained below.</P>

<P><CODE>&nbsp;&nbsp;mplayer/mencoder -vop filter1,filter2,filter3,...</CODE>
  </P>

<P>This sets up a filter pipeline (you can use any number of filters). Their
  parameters are optional and if omitted, some of them are set to default
  values, like <CODE>x</CODE> and <CODE>y</CODE> are both set to the center of
  the screen, and <CODE>width</CODE> and <CODE>height</CODE>> will be set to
  the movie's width and height.</P>

<P>Filters are queued starting from libvo, so <CODE>filter1</CODE> will be the
  last called filter (after that libvo comes, or when using <B>MEncoder</B>,
  encoding).</P>

<P>You can get the list of available video filters with the<BR>
  "<CODE>mplayer -vop help</CODE>" command line.</P>


<P><A NAME=2.6.3><B>2.6.3.  Crop</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>Crops the given part of the image, and discards the rest. Useful for
  removing black bands of widescreen movies.</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop crop[=width:height:x:y]</CODE></P>


<P><A NAME=2.6.4><B>2.6.4.  Expand</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>Expands (NOT scales) movie resolution to the given value, and places the
  unscaled original to <CODE>x</CODE> <CODE>y</CODE>. For movies not containing
  black bands, this can be used to add them.  This is good when creating SVCDs,
  or using with the
  <A HREF="video.html#2.3.1.4">SDL video output</A> which can place
  subtitles in these bands.</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop expand[=width:height:x:y]</CODE></P>

<P><A NAME=2.6.6><B>2.6.6.  Flip</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>Simply flips image. Useful for some old codecs which can output only
  flipped image (these are autodetected).</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop flip</CODE></P>


<P><A NAME=2.6.7><B>2.6.7.  Format</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>This filter is NOT image format converter. It just forces the next filter
  (or libvo) which image format to use. Useful for cards with slow YV12, like
  tdfx and Savage4. For real conversion, use the <CODE>Scale</CODE> filter.</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop format[=format]</CODE> (where
  <CODE>format</CODE> can be for example: rgb32, yuy2, etc...)</P>

<P><B><U>Description</U></B>:</P>

<P>Performs RGB 24/32 <-> BGR 24/32 colorspace conversion (default behavior)
  or RGB 24/32 <-> RGB 24/32 conversion with R<->B swapping (with the 'swap'
  option)</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop rgb2bgr[=swap]</CODE></P>


<P><A NAME=2.6.10><B>2.6.10.  Rotate</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>Rotates (flips) image. Parameter 'x' (values: 0-3) controls horizontal and
  vertical mirroring.</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop rotate[=x]</CODE></P>

<P>Scales the image with the software scaler (slow). You can adjust the
  quality of the scaler with the <CODE>-sws</CODE> option, see the man page.
  Nice quality implies speed loss.</P>

<P><B>NOTE</B>: calling this filter with no options means <B>colorspace
  conversion</B>! This is useful for codecs which can't output in the needed
  format for the specified video output device. These are hopefully
  autodetected and scale filter is called to convert. In other cases, you
  can use it manually.</P>

<P><A NAME=2.6.15><B>2.6.15.  Cropdetect</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>Calculates needed cropping parameters. It will print the recommended -vop
  option to stdout.</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop cropdetect</CODE></P>


<P><B><A NAME=3>3. Usage</A></B></P>

<P><B><A NAME=3.1>3.1. Command line</A></B></P>

6811:76595595dcb0

<P><A NAME=2.6><B>2.6.  Video filters</B></A></P>


<P><A NAME=2.6.1><B>2.6.1.  Overview</B></A></P>

<P>Both <B>MPlayer</B> and <B>MEncoder</B> support using a universal
  video filter layer, which comprises numerous plugins that are listed and
  explained below. These plugins can perform various actions on the image,
  such as rescaling, cropping black borders (useful not only for encoding but
  for playback, too, since black borders increase bus usage and cropping these
  can boost playback speed on slow boards) and expanding the image (for SVCDs).</P>

<P>With this filter layer it's possible to perform fast image format conversion
  between the various RGB and YUV formats when necessary. This enables for
  example playing RGB data on <CODE>xv</CODE> and <CODE>xmga</CODE> video output
  drivers among other things (see the <A HREF="#2.6.11">Scale</A> filter).</P>

<P>The filter layer also does <B>Direct Rendering</B> between the plugins, to
  maximize the speed.

<P>Note that the postprocessing code is now also a part of the layer. It
  will be explained below.</P>

<P><CODE>&nbsp;&nbsp;mplayer/mencoder -vop filter1,filter2,filter3,...</CODE>
  </P>

<P>This sets up a filter pipeline (you can use any number of filters). Their
  parameters are optional and if omitted, some of them are set to default
  values, e.g. <CODE>x</CODE> and <CODE>y</CODE> are both set to the center of
  the screen and <CODE>width</CODE> and <CODE>height</CODE>> will be set to
  the width and height of the movie.</P>

<P>Filters are queued starting from libvo, so <CODE>filter1</CODE> will be the
  last filter called (after that comes libvo, or when using <B>MEncoder</B>,
  encoding).</P>

<P>You can get the list of available video filters with the command</P>

<P>&nbsp;&nbsp;<CODE>mplayer -vop help</CODE></P>


<P><A NAME=2.6.3><B>2.6.3.  Crop</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>Crops the given part of the image and discards the rest. Useful for removing
  black bands from widescreen movies.</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop crop[=width:height:x:y]</CODE></P>


<P><A NAME=2.6.4><B>2.6.4.  Expand</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>Expands (<B>not</B> scales) movie resolution to the given value and places
  the unscaled original at coordinates <CODE>x</CODE> <CODE>y</CODE>. For movies
  not containing black bands, this can be used to add them.  This is good when
  creating SVCDs or for placing subtitles or the OSD in these bands.</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop expand[=width:height:x:y]</CODE></P>

<P><A NAME=2.6.6><B>2.6.6.  Flip</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>Simply flips the image upside down. Useful for some old codecs which can only
  output a flipped image (these are autodetected).</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop flip</CODE></P>


<P><A NAME=2.6.7><B>2.6.7.  Format</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>This filter is <B>not</B> an image format converter. It just forces the next
  filter (or libvo) to use the given format. Useful for cards with slow YV12,
  like tdfx and Savage4. For real conversion, use the scale filter.</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop format[=format]</CODE> (where
  <CODE>format</CODE> can be for example: rgb32, yuy2, etc...)</P>

<P><B><U>Description</U></B>:</P>

<P>Performs RGB 24/32 <-> BGR 24/32 colorspace conversion (default behavior)
  or RGB 24/32 <-> RGB 24/32 conversion with R<->B swapping (with the 'swap'
  option).</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop rgb2bgr[=swap]</CODE></P>


<P><A NAME=2.6.10><B>2.6.10.  Rotate</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>Rotates (flips) the image. The parameter <CODE>x</CODE> (values: 0-3)
  controls horizontal and vertical mirroring.</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop rotate[=x]</CODE></P>

<P>Scales the image with the software scaler (slow). You can adjust the
  quality of the scaler with the <CODE>-sws</CODE> option, see the man page.
  Nice quality implies speed loss.</P>

<P><B>Note:</B> Calling this filter with no options means <B>colorspace
  conversion</B>! This is useful for codecs which can't output in the needed
  format for the specified video output device. These are hopefully
  autodetected and scale filter is called to convert. In other cases, you
  can use it manually.</P>

<P><A NAME=2.6.15><B>2.6.15.  Cropdetect</B></A></P>

<P><B><U>Description</U></B>:</P>

<P>Calculates necessary cropping parameters. It will print the recommended
  <CODE>-vop crop</CODE> parameters to stdout. You can adjust the threshold of
  what is detected as border and what as picture with the <CODE>limit</CODE>
  parameter. <CODE>limit</CODE> is a number from 0 to 255 that defaults to 24.
  At 0 it detects everything as picture, at 255 everything as border.</P>

<P><B><U>Usage</U></B>:</P>

<P><CODE>&nbsp;&nbsp;-vop cropdetect[=limit]</CODE></P>


<P><B><A NAME=3>3. Usage</A></B></P>

<P><B><A NAME=3.1>3.1. Command line</A></B></P>