summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorNils Wallménius <nils@rockbox.org>2007-06-01 08:42:40 +0000
committerNils Wallménius <nils@rockbox.org>2007-06-01 08:42:40 +0000
commit68505ba43097c79610fa6543e91b17dcce055689 (patch)
tree58324888e17e048d15e8370718dcecc1a6d3e8c1 /manual
parent13067f6c71b6bdd6fd63a2699a3ee2eae100b2b8 (diff)
downloadrockbox-68505ba43097c79610fa6543e91b17dcce055689.tar.gz
rockbox-68505ba43097c79610fa6543e91b17dcce055689.zip
First attempt at an MPEG player section in the manual, mostly copied from the wiki. Add HAVE_LCD_COLOR option to the gigabeatf platform file to enable color specific options
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13532 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/platform/gigabeatf.tex1
-rw-r--r--manual/plugins/main.tex2
-rw-r--r--manual/plugins/mpegplayer.tex43
3 files changed, 46 insertions, 0 deletions
diff --git a/manual/platform/gigabeatf.tex b/manual/platform/gigabeatf.tex
index ba03fbc844..73dad55c7a 100644
--- a/manual/platform/gigabeatf.tex
+++ b/manual/platform/gigabeatf.tex
@@ -5,6 +5,7 @@
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,CONFIG_RTC}
\edef\UseOption{\UseOption,GIGABEAT_PAD}
+\edef\UseOption{\UseOption,HAVE_LCD_COLOR}
\edef\UseOption{\UseOption,gigabeat}
\newcommand{\playerman}{Toshiba}
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 9d2714436e..14da5e7e0c 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -105,6 +105,8 @@ the associated file. Viewers are stored in the
\opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}}
+\opt{HAVE_LCD_COLOR}{\input{plugins/mpegplayer.tex}}
+
\opt{recorder,recorderv2fm,ondio}{\input{plugins/rockbox_flash.tex}}
\opt{recorder,recorderv2fm,h1xx,m5,HAVE_LCD_COLOR}{\input{plugins/rockboy.tex}}
diff --git a/manual/plugins/mpegplayer.tex b/manual/plugins/mpegplayer.tex
new file mode 100644
index 0000000000..83e20ec0bf
--- /dev/null
+++ b/manual/plugins/mpegplayer.tex
@@ -0,0 +1,43 @@
+% $Id$ %
+\subsection{MPEG Player}
+The Mpeg Player is a video player plugin capable of playing back MPEG-1 and
+MPEG-2 video streams with MPEG audio multiplexed into \fname{.mpg} files.
+
+To play a video file, you just select it in the Rockbox \setting{File Browser}.
+If your file does not have the \fname{.mpg} extension but is encoded in the
+supported format, you will need to use the \setting{Open With...} context menu
+option and choose \setting{mpegplayer}.
+
+\begin{table}
+\begin{btnmap}{}{}
+ \ActionWpsPlay & Pause/Resume\\
+ \ActionWpsStop & Stop\\
+ \ActionWpsVolUp{} / \ActionWpsVolDown & Adjust volume up / down\\
+ \opt{IRIVER_H300_PAD}{\ButtonMode}
+ \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD}{\ButtonMenu}
+ \opt{IAUDIO_X5_PAD}{\ButtonRec}
+ \opt{IRIVER_H10_PAD}{\ButtonRew}
+ \opt{SANSA_E200_PAD}{\ButtonSelect}
+ & Open the MPEG Player menu\\
+\end{btnmap}
+\end{table}
+
+The menu has the following entries.
+
+\begin{description}
+\item[Show FPS] This option displays (once a second - if your video is
+ full-screen this means it will get overwritten by the video and appear to
+ flash once per second) the average number of frames decoded per second,
+ the total number of frames skipped (see the Skip Frames option), the
+ current time (in 100Hz ticks) and the time the current frame is due to be
+ displayed.
+\item[Limit FPS] With this option disabled, mpegplayer will display the video
+ as fast as it can. Useful for benchmarking.
+\item[Skip frames] This option causes mpegplayer to attempt to maintain
+ realtime playback by skipping the display of frames - but these frames are
+ still decoded. Disabling this option can cause loss of A/V sync.
+\end{description}
+
+See this page in the Rockbox wiki for information on how to encode your videos
+to the supported format. \wikilink{PluginMpegplayer}
+