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{btnmap}
  12     \opt{GIGABEAT_S_PAD}{\ButtonSelect{} or \ButtonPlay}
  13     \opt{GIGABEAT_PAD}{\ButtonSelect{} or \ButtonA}
  14     \nopt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ActionWpsPlay}
  15        \opt{HAVEREMOTEKEYMAP}{& }
  16     & Pause / Resume\\
  17     \ActionWpsStop
  18        \opt{HAVEREMOTEKEYMAP}{& }
  19     & Stop\\
  20     \nopt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ActionWpsVolUp{} / \ActionWpsVolDown}
  21     \opt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ButtonLeft{} or  \ButtonVolDown{} /
  22         \ButtonRight{} or \ButtonVolUp}
  23        \opt{HAVEREMOTEKEYMAP}{& }
  24     & Adjust volume up / down\\
  25     \nopt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ActionWpsSkipPrev{} / \ActionWpsSkipNext}
  26     \opt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ButtonUp{} / \ButtonDown}
  27        \opt{HAVEREMOTEKEYMAP}{& }
  28     & Rewind / Fast Forward\\
  29     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
  30     \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,PBELL_VIBE500_PAD}
  31         {\ButtonMenu}
  32     \opt{IAUDIO_X5_PAD}{\ButtonRec}
  33     \opt{IRIVER_H10_PAD}{\ButtonRew}
  34     \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD}{\ButtonSelect}
  35        \opt{HAVEREMOTEKEYMAP}{& }
  36     & Open the MPEG Player menu\\
  37 \end{btnmap}
  38
  39 When a video file is selected, the Start Menu will be displayed, unless it is
  40 disabled via the \setting{Resume Options} (see below). In the latter case the video
  41 will start playing immediately.
  42
  43 Start Menu
  44
  45 \begin{description}
  46 \item[Play from beginning] Resume information is discarded and the video plays
  47     from the start.
  48 \item[Resume at: mm:ss] Resume video playback at stored resume time mm:ss
  49     (start of the video if no resume time is found).
  50 \item[Set start time] A preview screen is presented consisting of a
  51     thumbnail preview and a progress bar where the user can select a start time
  52     by `seeking' through the video. The video playback is started by pressing
  53     the select button.
  54 \item[Settings] Open \setting{Settings} submenu -- see below.
  55 \item[Quit mpegplayer] Exit the plugin.
  56 \end{description}
  57
  58 Main Menu
  59
  60 \begin{description}
  61 \item[Settings] Open \setting{Settings} submenu -- see below.
  62 \item[Resume playback] Return to playback screen.
  63 \item[Quit mpegplayer] Exit the plugin.
  64 \end{description}
  65
  66 Settings Menu
  67
  68 \begin{description}
  69 \item[Display Options] Open \setting{Display Options} submenu -- see below.
  70 \item[Audio Options] Open \setting{Audio Options} submenu -- see below.
  71 \item[Resume Options] (default: Start menu) Enable/disable the start menu.
  72 \item[Play Mode] (default: Single) Set to \setting{All} to play multiple
  73     \fname{.mpg} files in the directory continuously.
  74 \item[Clear all resumes: x] Discard all x resume points.
  75 \end{description}
  76
  77 Display Options Menu
  78
  79 \begin{description}
  80 \item[Dithering] (default: off) Prevent banding effects in gradients by blending
  81     of colours. (only available on Sansa e200, Sansa c200 and Gigabeat F/X)
  82 \item[Display FPS] (default: off) This option displays (once a second - if your
  83     video is full-screen this means it will get overwritten by the video and
  84     appear to flash once per second) the average number of frames decoded per
  85     second, the total number of frames skipped (see the Skip Frames option),
  86     the current time (in 100~Hz ticks) and the time the current frame is due to
  87     be displayed.
  88 \item[Limit FPS] (default: on) With this option disabled, mpegplayer will
  89     display the video as fast as it can. Useful for benchmarking.
  90 \item[Skip frames] (default: on) This option causes mpegplayer to attempt to
  91     maintain realtime playback by skipping the display of frames - but these
  92     frames are still decoded. Disabling this option can cause loss of A/V sync.
  93 \opt{backlight_brightness}{
  94   \item[Backlight Brightness] (default: Use setting) Choose brightness to use
  95     during video playback. Set to \setting{Use setting} to use the Brightness
  96     setting.
  97 }
  98 \end{description}
  99
 100 Audio Options Menu
 101
 102 \begin{description}
 103 \item[Tone Controls] (default: force off) Use the bass and treble control
 104     settings or force them off.
 105 \item[Channel Modes] (default: force off) Use the channel configuration setting
 106     or force Stereo mode.
 107 \item[Crossfeed] (default: force off) Use the Crossfeed setting or force
 108     crossfeed off.
 109 \item[Equalizer] (default: force off) Use the Equalizer setting or force the
 110     equalizer off.
 111 \item[Dithering] (default: force off) Use the Dithering setting or force
 112     audio dithering off.
 113 \end{description}
 114
 115 See this page in the Rockbox wiki for information on how to encode your videos
 116 to the supported format. \wikilink{PluginMpegplayer}