comparison DOCS/documentation.html @ 7129:8f410b92f1a7

Plugin descriptions were moved to the man page.

7128:dc48f2130a76

          <LI><A HREF="#tv_options">2.5.2 Available options</A></LI>
          <LI><A HREF="#tv_keyboard">2.5.3 Keyboard control</A></LI>
          <LI><A HREF="#tv_examples">2.5.4 Examples</A></LI>
        </UL>
      </LI>
      <LI><A HREF="#filters">2.6 Video filters</A>
        <UL>
          <LI><A HREF="#filters_usage">2.6.1 Usage</A></LI>
          <LI><A HREF="#filters_crop">2.6.2 Crop</A></LI>
          <LI><A HREF="#filters_expand">2.6.3 Expand</A></LI>
          <LI><A HREF="#filters_fame">2.6.4 Fame/Lavc</A></LI>
          <LI><A HREF="#filters_flip">2.6.5 Flip</A></LI>
          <LI><A HREF="#filters_format">2.6.6 Format</A></LI>
          <LI><A HREF="#filters_postprocess">2.6.7 Postprocess</A></LI>
          <LI><A HREF="#filters_rgb2bgr">2.6.8 RGB2BGR</A></LI>
          <LI><A HREF="#filters_rotate">2.6.9 Rotate</A></LI>
          <LI><A HREF="#filters_scale">2.6.10 Scale</A></LI>
          <LI><A HREF="#filters_yuy2">2.6.11 YUY2</A></LI>
          <LI><A HREF="#filters_mirror">2.6.12 Mirror</A></LI>
          <LI><A HREF="#filters_dvbscale">2.6.13 DVBscale</A></LI>
          <LI><A HREF="#filters_cropdetect">2.6.14 Cropdetect</A></LI>
          <LI><A HREF="#filters_rectangle">2.6.15 Rectangle</A></LI>
        </UL>
      </LI>
    </UL>
  </LI>
  <LI><A HREF="#usage">3. Usage</A>
    <UL>
      <LI><A HREF="#command_line">3.1 Command line</A></LI>

</UL>

<H4>Non-YUV cards</H4>

<P>Fullscreen playing can be achieved by either enabling <B>software scaling</B>
  (use the <CODE>-zoom</CODE> or <A HREF="#filters_scale"><CODE>-vop scale</CODE></A>
  option, but I warn you: this is slow), or switching to a small resolution
  video mode, for example 352x288. If you don't have YUV acceleration, the
  latter method is recommended. Video mode switching can be enabled by
  using the <CODE>-vm</CODE> option and it works with the following drivers:</P>

<P><B>Note:</B><BR>
  If you have a TV card with an external audio device and get only a black
  screen, although input works with xawtv or similar, then try to use the
  <CODE>-noaudio</CODE> option. For the example above this would be:<BR> 
  <CODE>&nbsp;&nbsp;&nbsp;&nbsp;mplayer -tv on:noaudio:driver=v4l:width=640:height=480:outfmt=i420 -vc rawi420 -vo xv</CODE></P>


<H2><A NAME="filters">2.6 Video filters</A></H2>

<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="#filters_scale">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>


<H3><A NAME="filters_usage">2.6.1  Usage</A></H3>

<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>


<H3><A NAME="filters_crop">2.6.2  Crop</A></H3>

<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>


<H3><A NAME="filters_expand">2.6.3  Expand</A></H3>

<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>


<H3><A NAME="filters_fame">2.6.4  Fame/Lavc</A></H3>

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

<P>Realtime MPEG1 encoder (using libfame or libavcodec) (for use with
  DVB/DXR3).</P>

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

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

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


<H3><A NAME="filters_flip">2.6.5  Flip</A></H3>

<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>


<H3><A NAME="filters_format">2.6.6  Format</A></H3>

<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>


<H3><A NAME="filters_postprocess">2.6.7  Postprocess</A></H3>

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

<P>This is our good old postprocess, just converted to the filter layer.
  Performs image quality enhancement, deinterlacing, etc, see
  <CODE>-npp help</CODE> for available options.</P>

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

<P><CODE>&nbsp;&nbsp;-vop pp[=postprocess options/keywords]</CODE></P>


<H3><A NAME="filters_rgb2bgr">2.6.8  RGB2BGR</A></H3>

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

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

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

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


<H3><A NAME="filters_rotate">2.6.9  Rotate</A></H3>

<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>


<H3><A NAME="filters_scale">2.6.10  Scale</A></H3>

<P><B><U>Description</U></B>:</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><B><U>Usage</U></B>:</P>

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


<H3><A NAME="filters_yuy2">2.6.11  YUY2</A></H3>

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

<P>Forced software YV12/I420 to YUY2 conversion.</P>

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

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


<H3><A NAME="filters_mirror">2.6.12  Mirror</A></H3>

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

<P>Flips the image on Y axis.</P>

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

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


<H3><A NAME="filters_dvbscale">2.6.13  DVBscale</A></H3>

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

<P>Calculates Y scaling for DVB card.</P>

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

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


<H3><A NAME="filters_cropdetect">2.6.14  Cropdetect</A></H3>

<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>


<H3><A NAME="filters_rectangle">2.6.15  Rectangle</A></H3>

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

<P>Draws a rectangle of the requested width and height at the designated
  coordinates over the image.  Useful to get visual feedback for the parameters
  of <CODE>-vop crop</CODE> before applying them.</P>

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

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



<H1><A NAME="usage">3. Usage</A></H1>

7129:8f410b92f1a7

          <LI><A HREF="#tv_options">2.5.2 Available options</A></LI>
          <LI><A HREF="#tv_keyboard">2.5.3 Keyboard control</A></LI>
          <LI><A HREF="#tv_examples">2.5.4 Examples</A></LI>
        </UL>
      </LI>
    </UL>
  </LI>
  <LI><A HREF="#usage">3. Usage</A>
    <UL>
      <LI><A HREF="#command_line">3.1 Command line</A></LI>

</UL>

<H4>Non-YUV cards</H4>

<P>Fullscreen playing can be achieved by either enabling <B>software scaling</B>
  (use the <CODE>-zoom</CODE> or <CODE>-vop scale</CODE>
  option, but I warn you: this is slow), or switching to a small resolution
  video mode, for example 352x288. If you don't have YUV acceleration, the
  latter method is recommended. Video mode switching can be enabled by
  using the <CODE>-vm</CODE> option and it works with the following drivers:</P>

<P><B>Note:</B><BR>
  If you have a TV card with an external audio device and get only a black
  screen, although input works with xawtv or similar, then try to use the
  <CODE>-noaudio</CODE> option. For the example above this would be:<BR> 
  <CODE>&nbsp;&nbsp;&nbsp;&nbsp;mplayer -tv on:noaudio:driver=v4l:width=640:height=480:outfmt=i420 -vc rawi420 -vo xv</CODE></P>



<H1><A NAME="usage">3. Usage</A></H1>