Improvements to the viewers section of the manual (FS#10531 by David Kaufmann)
[kugel-rb.git] / manual / plugins / jpegviewer.tex
blob7cbdc4b99b136f89fa6f9b57cf097f46e709d793
1 % $Id$ %
2 \subsection{JPEG viewer}
3 This plugin opens \fname{.jpeg} files from the \setting{File Browser} to display them\nopt{lcd_color}{ using Rockbox's greyscale library}.
4 \opt{swcodec}{
5 \par
6 \note{
7 When an audio file is playing the size of the image is limited as
8 the decoding process needs to share memory with audio tracks. To be able to
9 view a bigger file you may need to stop playback.}
11 \nopt{large_plugin_buffer}{%
12 \note{This plugin will cause playback to stop.}%
15 \begin{table}
16 \begin{btnmap}{}{}
17 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
18 ,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}
19 {\ButtonUp\ / \ButtonDown}%
20 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu\ / \ButtonPlay}%
21 \opt{IRIVER_H10_PAD}{\ButtonScrollUp\ / \ButtonScrollDown} %
22 / \ButtonLeft\ / \ButtonRight
23 \opt{HAVEREMOTEKEYMAP}{& }
24 & Move around in zoomed in image\\
25 \opt{RECORDER_PAD}{\ButtonPlay}
26 \opt{ONDIO_PAD}{\ButtonMenu}
27 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD%
28 ,SANSA_C200_PAD,MROBE100_PAD}{\ButtonSelect}
29 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd}
30 \opt{IRIVER_H10_PAD}{\ButtonPlay}
31 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolUp}
32 \opt{HAVEREMOTEKEYMAP}{& }
33 & Zoom in\\
34 \opt{RECORDER_PAD}{\ButtonOn}
35 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown}
36 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
37 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack}
38 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{Long \ButtonSelect}
39 \opt{IRIVER_H10_PAD}{Long \ButtonPlay}
40 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
41 \opt{MROBE100_PAD}{\ButtonPlay}
42 \opt{HAVEREMOTEKEYMAP}{& }
43 & Zoom out\\
44 \opt{RECORDER_PAD}{\ButtonFThree}
45 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonRight}
46 \opt{IRIVER_H100_PAD}{\ButtonOn}
47 \opt{IRIVER_H300_PAD}{\ButtonRec}
48 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonRight}
49 \opt{IAUDIO_X5_PAD}{\ButtonPlay}
50 \opt{IRIVER_H10_PAD}{\ButtonFF}
51 \opt{SANSA_E200_PAD}{\ButtonScrollFwd}
52 \opt{SANSA_C200_PAD}{\ButtonVolUp}
53 \opt{GIGABEAT_PAD}{\ButtonA+\ButtonRight}
54 \opt{GIGABEAT_S_PAD}{\ButtonNext}
55 \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonRight}
56 \opt{HAVEREMOTEKEYMAP}{& }
57 & Next jpeg in directory\\
58 \opt{RECORDER_PAD}{\ButtonFTwo}
59 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft}
60 \opt{IRIVER_H100_PAD,IAUDIO_X5_PAD}{\ButtonRec}
61 \opt{IRIVER_H300_PAD}{\ButtonOn}
62 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonLeft}
63 \opt{IRIVER_H10_PAD}{\ButtonRew}
64 \opt{SANSA_E200_PAD}{\ButtonScrollBack}
65 \opt{SANSA_C200_PAD}{\ButtonVolDown}
66 \opt{GIGABEAT_PAD}{\ButtonA+\ButtonLeft}
67 \opt{GIGABEAT_S_PAD}{\ButtonPrev}
68 \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonLeft}
69 \opt{HAVEREMOTEKEYMAP}{& }
70 & Previous jpeg in directory\\
71 \opt{SANSA_E200_PAD,SANSA_C200_PAD}{%currently only defined for the sansa pads
72 \ButtonRec
73 \opt{HAVEREMOTEKEYMAP}{& }
74 & Toggle slide show mode\\
76 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
77 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonMenu}
78 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonPower}
79 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonMenu}
80 \opt{HAVEREMOTEKEYMAP}{&
81 \opt{IRIVER_RC_H100_PAD}{\ButtonRCStop}
83 & Show menu\\
84 \end{btnmap}
85 \end{table}
87 The menu has the following entries.
88 \begin{description}
89 \item[Quit.] Quits the viewer and returns to the \setting{File Browser}.
90 \item[Toggle Slideshow Mode.] Enables or disables the slideshow mode.
91 \item[Change Slideshow Timeout.] You can set the timeout for the slideshow
92 between 1 second and 20 seconds.
93 \opt{large_plugin_buffer}{
94 \item[Show Playback Menu.] From the playback menu you can control the
95 playback of the currently loaded playlist and change the volume of your \dap.
97 \opt{lcd_color}{
98 \item[Display Options.] From this menu you can force the viewer to render the
99 image in greyscale using the \setting{Greyscale} option or set the method of
100 dithering used in the \setting{Dithering} submenu.
102 \item[Return.] Returns you to the image
103 \end{description}
105 \note{
106 Progressive scan and other unusual JPEG files are not supported, and will
107 result in various ``unsupported xx'' messages. Processing could also fail if the
108 image is too big to decode which will be explained by a respective message.