manual/plugins/pictureflow.tex

   1 \subsection{PictureFlow}
   2 \screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow}
   3 PictureFlow provides a visualisation of your albums with their associated cover
   4 art. \opt{swcodec}{It is possible to start playback of the selected
   5 album from PictureFlow. Playback will start from the selected track. The
   6 PictureFlow plugin will continue to run while your tracks are played.}
   7
   8 \opt{hwcodec}{
   9 \note{PictureFlow is a visualisation only. It cannot be used to select and
  10 play music.  Also, using this plugin will cause playback to stop.}
  11 }
  12
  13 \subsubsection{Requirements}
  14 PictureFlow uses both the album art (see \reference{ref:album_art}) and
  15 database (see \reference{ref:database}) features of Rockbox.
  16 It is therefore important that these are working correctly before attempting
  17 to use PictureFlow. In addition, there are some other points of which to be
  18 aware:
  19
  20   \begin{itemize}
  21     \item PictureFlow will accept album art larger than the dimensions of the
  22     screen, but the larger the dimensions, the longer they will take to scale.
  23   \end{itemize}
  24
  25 \subsubsection{Keys}
  26     \begin{btnmap}
  27         \opt{scrollwheel,IRIVER_H10_PAD,PBELL_VIBE500_PAD}{
  28             \ActionStdPrev{} / \ActionStdNext
  29                 &
  30             \opt{HAVEREMOTEKEYMAP}{
  31                 &}
  32             Scroll through albums / track list
  33                 \\
  34         }
  35
  36         % only scroll wheel and `strip' targets use the same action in album and track list
  37         \nopt{scrollwheel,IRIVER_H10_PAD,PBELL_VIBE500_PAD}{%
  38             % currently the M3 does not use buttons of the main unit which has no display
  39             \nopt{IAUDIO_M3_PAD,MPIO_HD200_PAD,touchscreen}{\ButtonLeft{} / \ButtonRight}
  40             \opt{MPIO_HD200_PAD}{FIXME}
  41             \opt{touchscreen}{\TouchMidLeft{} / \TouchMidRight}
  42                 &
  43             \opt{HAVEREMOTEKEYMAP}{
  44                 \opt{IAUDIO_M3_PAD,GIGABEAT_RC_PAD}{\ActionRCStdPrev{} / \ActionRCStdNext}
  45                 &}
  46             Scroll through albums
  47                 \\
  48
  49             \nopt{IAUDIO_M3_PAD}{\ActionStdPrev{} / \ActionStdNext}
  50                 &
  51             \opt{HAVEREMOTEKEYMAP}{
  52                 % even though the M3 uses an Iaudio remote, mapping differs when used with M/X5
  53                 \opt{IAUDIO_M3_PAD}{\ButtonRCLeft{} / \ButtonRCRight}
  54                 \opt{GIGABEAT_RC_PAD}{\ButtonRCVolUp{} / \ButtonRCVolDown}
  55                 &}
  56             Scroll through track list
  57                 \\
  58         }
  59
  60         \nopt{IAUDIO_M3_PAD}{%
  61             \nopt{ONDIO_PAD,IRIVER_H10_PAD,RECORDER_PAD,touchscreen,PBELL_VIBE500_PAD,SANSA_FUZE_PAD,MPIO_HD200_PAD}
  62                  {\ButtonSelect}
  63             \opt{ONDIO_PAD}{\ButtonUp}
  64             \opt{IRIVER_H10_PAD,PBELL_VIBE500_PAD}{\ButtonRight}
  65             \opt{RECORDER_PAD}{\ButtonOn}
  66             \opt{touchscreen}{\TouchCenter}
  67             \opt{SANSA_FUZE_PAD}{\ButtonRight}
  68             \opt{MPIO_HD200_PAD}{FIXME}
  69         }
  70             &
  71         \opt{HAVEREMOTEKEYMAP}{
  72             \opt{IAUDIO_M3_PAD}{\ButtonRCPlay}
  73             \opt{GIGABEAT_RC_PAD}{\ButtonRCFF}
  74             &}
  75         Enter track list
  76             \nopt{ONDIO_PAD}{/ Play album from selected track}
  77             \\
  78
  79         % Ondio uses a different button in album list and track list
  80         \opt{ONDIO_PAD}{
  81             \ButtonMenu
  82                 &
  83             Play album from selected track in track list
  84                 \\
  85         }
  86
  87         \nopt{IAUDIO_M3_PAD,MPIO_HD200_PAD,touchscreen}{\ButtonLeft}
  88         \opt{MPIO_HD200_PAD}{FIXME}
  89         \opt{touchscreen}{
  90             \opt{COWON_D2_PAD}{\ButtonPower{} or}
  91             \TouchBottomRight}
  92             &
  93         \opt{HAVEREMOTEKEYMAP}{
  94             \opt{IAUDIO_M3_PAD,GIGABEAT_RC_PAD}{\ActionRCStdCancel}
  95             &}
  96         Exit track list
  97             \\
  98
  99         \nopt{IAUDIO_M3_PAD}{\ActionStdMenu}
 100             &
 101         \opt{HAVEREMOTEKEYMAP}{
 102             \opt{IAUDIO_M3_PAD,GIGABEAT_RC_PAD}{\ActionRCStdMenu}
 103             &}
 104         Enter menu
 105             \\
 106
 107         \nopt{IAUDIO_M3_PAD}{%
 108             \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,RECORDER_PAD,ONDIO_PAD}{\ButtonOff}
 109             \opt{IAUDIO_X5_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD%
 110                 ,MROBE100_PAD}{\ButtonPower}
 111             \opt{SANSA_C200_PAD,IRIVER_H10_PAD}{Long \ButtonPower}
 112             \opt{IPOD_4G_PAD,IPOD_3G_PAD}{Long \ButtonMenu}
 113             \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
 114             \opt{PBELL_VIBE500_PAD}{\ButtonRec}
 115             \opt{MPIO_HD200_PAD}{FIXME}
 116             \opt{touchscreen}{
 117                 \opt{COWON_D2_PAD}{Long \ButtonPower{} or}
 118                 \TouchBottomRight{} (in album view)}
 119         }
 120             &
 121         \opt{HAVEREMOTEKEYMAP}{
 122             \opt{IAUDIO_M3_PAD}{\ButtonRCRec}
 123             \opt{GIGABEAT_RC_PAD}{\ButtonRCRew}
 124             &}
 125         Exit PictureFlow
 126             \\
 127
 128     \end{btnmap}
 129
 130 \subsubsection{Main Menu}
 131 \begin{description}
 132   \item[Go to WPS.] Leave PictureFlow and enter the while playing screen.
 133   \opt{swcodec}{\item[Playback Control.] Control music playback from within the plugin.}
 134   \item[Settings.] Enter the settings menu.
 135   \item[Return.] Exit menu.
 136   \item[Quit.] Exit PictureFlow plugin.
 137 \end{description}
 138
 139 \subsubsection{Settings Menu}
 140
 141 \begin{description}
 142   \item[Show FPS.] Displays frames per second on screen.
 143   \item[Spacing.] The distance between the front edges of the side slides, i.e. changes
 144   the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom.
 145   \item[Centre margin.] The distance, in screen pixels, with zoom at 100, between
 146   the centre and side slides. Scales with zoom.
 147   \item[Number of slides.] Sets the number of slides at each side, including the
 148   centre slide. Therefore if set to 4, there will be 3 slides on the left,
 149   the centre slide, and then 3 slides on the right.
 150   \item[Zoom.] Changes the distance at which slides are rendered from the ``camera''.
 151   \item[Show album title.] Allows setting the album title to be shown above or
 152   below the cover art, or not at all.
 153   \item[Resize Covers.] Set whether to automatically resize the covers or to leave
 154   them at their original size.
 155   \item[Rebuild cache.] Rebuild the PictureFlow cache. This is needed in order
 156   for PictureFlow to pick up new albums, and may occasionally be needed if albums
 157   are removed.
 158 \end{description}