summaryrefslogtreecommitdiff
path: root/manual/plugins/imageviewer.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/plugins/imageviewer.tex')
-rw-r--r--manual/plugins/imageviewer.tex142
1 files changed, 142 insertions, 0 deletions
diff --git a/manual/plugins/imageviewer.tex b/manual/plugins/imageviewer.tex
new file mode 100644
index 0000000000..28ef62e3a6
--- /dev/null
+++ b/manual/plugins/imageviewer.tex
@@ -0,0 +1,142 @@
1% $Id$ %
2\subsection{Image Viewer}
3This plugin opens image files from the \setting{File Browser} to display them\nopt{lcd_color}{ using Rockbox's greyscale library}. Supported formats are as follows.
4
5\begin{table}
6 \begin{rbtabular}{.60\textwidth}{llX}%
7 {\textbf{Format}& \textbf{File-extension(s)}}%
8 {}{}
9 BMP & \fname{.bmp} \\
10 JPEG & \fname{.jpg, .jpe, .jpeg} \\
11 PNG & \fname{.png} \\
12 \end{rbtabular}
13\end{table}
14
15\opt{large_plugin_buffer}{
16\par
17\note{
18When an audio file is playing the size of the image is limited as
19the decoding process needs to share memory with audio tracks. To be able to
20view a bigger file you may need to stop playback.}
21}
22\nopt{large_plugin_buffer}{%
23\note{This plugin will cause playback to stop.}%
24}%
25
26\begin{btnmap}
27 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
28 ,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
29 ,MROBE100_PAD,PBELL_VIBE500_PAD}
30 {\ButtonUp\ / \ButtonDown}%
31 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu\ / \ButtonPlay}%
32 \opt{IRIVER_H10_PAD}{\ButtonScrollUp\ / \ButtonScrollDown} %
33 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
34 ,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
35 ,MROBE100_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD,PBELL_VIBE500_PAD}
36 {/ \ButtonLeft\ / \ButtonRight}
37 \opt{touchscreen}{\TouchTopMiddle{} / \TouchBottomMiddle{}/ \TouchMidLeft{} / \TouchMidRight}
38 \opt{HAVEREMOTEKEYMAP}{& }
39 & Move around in zoomed in image\\
40 \opt{RECORDER_PAD}{\ButtonPlay}
41 \opt{ONDIO_PAD}{\ButtonMenu}
42 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD%
43 ,SANSA_FUZE_PAD,SANSA_C200_PAD,MROBE100_PAD}{\ButtonSelect}
44 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd}
45 \opt{IRIVER_H10_PAD}{\ButtonPlay}
46 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolUp}
47 \opt{PBELL_VIBE500_PAD}{\ButtonRec+\ButtonUp}
48 \opt{touchscreen}{\TouchTopRight}
49 \opt{HAVEREMOTEKEYMAP}{& }
50 & Zoom in\\
51 \opt{RECORDER_PAD}{\ButtonOn}
52 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown}
53 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
54 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack}
55 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD}{Long \ButtonSelect}
56 \opt{IRIVER_H10_PAD}{Long \ButtonPlay}
57 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
58 \opt{MROBE100_PAD}{\ButtonPlay}
59 \opt{PBELL_VIBE500_PAD}{\ButtonRec+\ButtonDown}
60 \opt{touchscreen}{\TouchTopLeft}
61 \opt{HAVEREMOTEKEYMAP}{& }
62 & Zoom out\\
63 \opt{RECORDER_PAD}{\ButtonFThree}
64 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonRight}
65 \opt{IRIVER_H100_PAD}{\ButtonOn}
66 \opt{IRIVER_H300_PAD}{\ButtonRec}
67 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonRight}
68 \opt{IAUDIO_X5_PAD}{\ButtonPlay}
69 \opt{IRIVER_H10_PAD}{\ButtonFF}
70 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
71 \opt{SANSA_C200_PAD}{\ButtonVolUp}
72 \opt{GIGABEAT_PAD}{\ButtonA+\ButtonRight}
73 \opt{GIGABEAT_S_PAD}{\ButtonNext}
74 \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonRight}
75 \opt{PBELL_VIBE500_PAD}{\ButtonRec+\ButtonRight}
76 \opt{touchscreen}{\TouchBottomRight}
77 \opt{HAVEREMOTEKEYMAP}{& }
78 & Next image in directory\\
79 \opt{RECORDER_PAD}{\ButtonFTwo}
80 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft}
81 \opt{IRIVER_H100_PAD,IAUDIO_X5_PAD}{\ButtonRec}
82 \opt{IRIVER_H300_PAD}{\ButtonOn}
83 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonLeft}
84 \opt{IRIVER_H10_PAD}{\ButtonRew}
85 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollBack}
86 \opt{SANSA_C200_PAD}{\ButtonVolDown}
87 \opt{GIGABEAT_PAD}{\ButtonA+\ButtonLeft}
88 \opt{GIGABEAT_S_PAD}{\ButtonPrev}
89 \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonLeft}
90 \opt{PBELL_VIBE500_PAD}{\ButtonRec+\ButtonLeft}
91 \opt{touchscreen}{\TouchBottomLeft}
92 \opt{HAVEREMOTEKEYMAP}{& }
93 & Previous image in directory\\
94 \opt{SANSA_E200_PAD,SANSA_C200_PAD}{%currently only defined for the sansa pads
95 \ButtonRec
96 \opt{HAVEREMOTEKEYMAP}{& }
97 & Toggle slide show mode\\
98 }
99 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
100 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonMenu}
101 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonPower}
102 \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
103 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,PBELL_VIBE500_PAD}{\ButtonMenu}
104 \opt{touchscreen}{\TouchCenter}
105 \opt{HAVEREMOTEKEYMAP}{&
106 \opt{IRIVER_RC_H100_PAD}{\ButtonRCStop}
107 }
108 & Show menu / Abort \\
109 \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD,PBELL_VIBE500_PAD}{
110 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonPlay}
111 \opt{GIGABEAT_PAD,MROBE100_PAD}{\ButtonPower}
112 \opt{GIGABEAT_S_PAD}{\ButtonBack}
113 \opt{PBELL_VIBE500_PAD}{\ButtonCancel}
114 \opt{HAVEREMOTEKEYMAP}{& }
115 & Quit the viewer \\
116 }
117\end{btnmap}
118
119The menu has the following entries.
120\begin{description}
121\item[Return.] Returns you to the image
122\item[Toggle Slideshow Mode.] Enables or disables the slideshow mode.
123\item[Change Slideshow Timeout.] You can set the timeout for the slideshow
124 between 1 second and 20 seconds.
125\opt{large_plugin_buffer}{
126\item[Show Playback Menu.] From the playback menu you can control the
127playback of the currently loaded playlist and change the volume of your \dap.
128}
129\opt{lcd_color}{
130\item[Display Options.] From this menu you can force the viewer to render the
131image in greyscale using the \setting{Greyscale} option or set the method of
132dithering used in the \setting{Dithering} submenu. These settings only take affect
133for JPEG images.
134}
135\item[Quit.] Quits the viewer and returns to the \setting{File Browser}.
136\end{description}
137
138\note{
139Progressive scan and other unusual JPEG files are not supported, and will
140result in various ``unsupported xx'' messages. Processing could also fail if the
141image is too big to decode which will be explained by a respective message.
142}