manual/plugins/mpegplayer.tex

   1 % $Id$ %
   2 \subsection{MPEG Player}
   3 The Mpeg Player is a video player plugin capable of playing back MPEG-1 and
   4 MPEG-2 video streams with MPEG audio multiplexed into \fname{.mpg} files.
   5
   6 To play a video file, you just select it in the Rockbox \setting{File Browser}.
   7 If your file does not have the \fname{.mpg} extension but is encoded in the
   8 supported format, you will need to use the \setting{Open With...} context menu
   9 option and choose \setting{mpegplayer}.
  10
  11 \begin{table}
  12 \begin{btnmap}{}{}
  13     \opt{GIGABEAT_S_PAD}{\ButtonSelect{} or \ButtonPlay}
  14     \opt{GIGABEAT_PAD}{\ButtonSelect{} or \ButtonA}
  15     \nopt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ActionWpsPlay}
  16        \opt{HAVEREMOTEKEYMAP}{& }
  17     & Pause / Resume\\
  18     \ActionWpsStop
  19        \opt{HAVEREMOTEKEYMAP}{& }
  20     & Stop\\
  21     \nopt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ActionWpsVolUp{} / \ActionWpsVolDown}
  22     \opt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ButtonLeft{} or  \ButtonVolDown{} /
  23         \ButtonRight{} or \ButtonVolUp}
  24        \opt{HAVEREMOTEKEYMAP}{& }
  25     & Adjust volume up / down\\
  26     \nopt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ActionWpsSkipPrev{} / \ActionWpsSkipNext}
  27     \opt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ButtonUp{} / \ButtonDown}
  28        \opt{HAVEREMOTEKEYMAP}{& }
  29     & Rewind / Fast Forward\\
  30     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
  31     \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,PBELL_VIBE500_PAD}
  32         {\ButtonMenu}
  33     \opt{IAUDIO_X5_PAD}{\ButtonRec}
  34     \opt{IRIVER_H10_PAD}{\ButtonRew}
  35     \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD}{\ButtonSelect}
  36        \opt{HAVEREMOTEKEYMAP}{& }
  37     & Open the MPEG Player menu\\
  38 \end{btnmap}
  39 \end{table}
  40
  41 When a video file is selected, the start Menu will be displayed, unless it is
  42 disabled via the option ``start menu'' (see below). In the latter case the video
  43 will start playing immediately - unless a resume point is found, in which case
  44 the resume menu is presented.
  45
  46 Start Menu
  47
  48 \begin{description}
  49 \item[Play from beginning] Resume information is discarded and the video plays
  50     from the start.
  51 \item[Resume time (min): x.x] Resume video playback at stored resume time x.x
  52     (start of the video if no resume time is found).
  53 \item[Set start time (min)] A preview screen is presented consisting of a
  54     thumbnail preview and a progress bar where the user can select a start time
  55     by 'seeking' through the video. The video playback is started by pressing
  56     the select button.
  57 \item[Quit mpegplayer] Exit the plugin.
  58 \end{description}
  59
  60 Resume Menu
  61
  62 \begin{description}
  63 \item[Yes (min): x.x] Resume video playback at stored resume time x.x.
  64 \item[No] Play video from the beginning.
  65 \end{description}
  66
  67 Main Menu
  68
  69 \begin{description}
  70 \item[Display Options] Opens ``Display Options'' submenu -- see below.
  71 \item[Start Menu] (default: on) Enable/disable the start menu.
  72 \item[Clear all resumes: x] Discard all x resume points.
  73 \item[Quit mpegplayer] Exit the plugin.
  74 \end{description}
  75
  76 Display Options Menu
  77
  78 \begin{description}
  79 \item[Dithering] (default: off) Prevent banding effects in gradients by blending
  80     of colours. (only available on Sansa e200, Sansa c200 and Gigabeat F/X)
  81 \item[Show FPS] (default: off) This option displays (once a second - if your
  82     video is full-screen this means it will get overwritten by the video and
  83     appear to flash once per second) the average number of frames decoded per
  84     second, the total number of frames skipped (see the Skip Frames option),
  85     the current time (in 100~Hz ticks) and the time the current frame is due to
  86     be displayed.
  87 \item[Limit FPS] (default: on) With this option disabled, mpegplayer will
  88     display the video as fast as it can. Useful for benchmarking.
  89 \item[Skip frames] (default: on) This option causes mpegplayer to attempt to
  90     maintain realtime playback by skipping the display of frames - but these
  91     frames are still decoded. Disabling this option can cause loss of A/V sync.
  92 \end{description}
  93
  94 See this page in the Rockbox wiki for information on how to encode your videos
  95 to the supported format. \wikilink{PluginMpegplayer}