Correctly compute the array size regardless of the element type
[kugel-rb/myfork.git] / manual / plugins / mpegplayer.tex
blob45bbd545111794b432ae9b7315f24fb6038f8a9a
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.
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}.
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{IRIVER_RC_H100_PAD}{&}
17 & Pause / Resume\\
18 \ActionWpsStop
19 \opt{HAVEREMOTEKEYPAD}{&}
20 & Stop\\
21 \nopt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ActionWpsVolUp{} / \ActionWpsVolDown}
22 \opt{GIGABEAT_S_PAD,GIGABEAT_PAD}{\ButtonLeft{} or \ButtonVolDown{} /
23 \opt{HAVEREMOTEKEYPAD}{&}
24 \ButtonRight{} or \ButtonVolUp}
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{HAVEREMOTEKEYPAD}{&}
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}{\ButtonMenu}
32 \opt{IAUDIO_X5_PAD}{\ButtonRec}
33 \opt{IRIVER_H10_PAD}{\ButtonRew}
34 \opt{SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonSelect}
35 \opt{IRIVER_RC_H100_PAD}{&}
36 & Open the MPEG Player menu\\
37 \end{btnmap}
38 \end{table}
40 When a video file is selected, the start Menu will be displayed, unless it is
41 disabled via the option "start menu" (see below). In the latter case the video
42 will start playing immediately - unless a resume point is found, in which case
43 the resume menu is presented.
45 Start Menu
47 \begin{description}
48 \item[Play from beginning] Resume information is discarded and the video plays
49 from the start.
50 \item[Resume time (min): x.x] Resume video playback at stored resume time x.x
51 (start of the video if no resume time is found).
52 \item[Set start time (min)] A preview screen is presented consisting of a
53 thumbnail preview and a progress bar where the user can select a start time
54 by 'seeking' through the video. The video playback is started by pressing
55 the select button.
56 \item[Quit mpegplayer] Exit the plugin.
57 \end{description}
59 Resume Menu
61 \begin{description}
62 \item[Yes (min): x.x] Resume video playback at stored resume time x.x.
63 \item[No] Play video from the beginning.
64 \end{description}
66 Main Menu
68 \begin{description}
69 \item[Display Options] Opens "Display Options" submenu - see below.
70 \item[Start Menu] (default: on) Enable/disable the start menu.
71 \item[Clear all resumes: x] Discard all x resume points.
72 \item[Quit mpegplayer] Exit the plugin.
73 \end{description}
75 Display Options Menu
77 \begin{description}
78 \item[Dithering] (default: off) Prevent banding effects in gradients by blending
79 of colours. (only available on Sansa e200, Sansa c200 and Gigabeat F/X)
80 \item[Show FPS] (default: off) This option displays (once a second - if your
81 video is full-screen this means it will get overwritten by the video and
82 appear to flash once per second) the average number of frames decoded per
83 second, the total number of frames skipped (see the Skip Frames option),
84 the current time (in 100Hz ticks) and the time the current frame is due to
85 be displayed.
86 \item[Limit FPS] (default: on) With this option disabled, mpegplayer will
87 display the video as fast as it can. Useful for benchmarking.
88 \item[Skip frames] (default: on) This option causes mpegplayer to attempt to
89 maintain realtime playback by skipping the display of frames - but these
90 frames are still decoded. Disabling this option can cause loss of A/V sync.
91 \end{description}
93 See this page in the Rockbox wiki for information on how to encode your videos
94 to the supported format. \wikilink{PluginMpegplayer}