manual/plugins/imageviewer.tex

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