summaryrefslogtreecommitdiffstats log msg author committer range
path: root/manual/plugins/pictureflow.tex
blob: 5b4e80e107704bbf02ce7f4a1a3fff217ee44773 (plain)
 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235  \subsection{PictureFlow} \screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow} PictureFlow is a visual browser for your albums. After you've selected something to play, PictureFlow will continue running by default, or can optionally show the WPS. Using the context menu, albums or songs can be added to the dynamic playlist directly from PictureFlow (see \reference{ref:playingnext_submenu}). \subsubsection{Sort Options} Albums can be sorted by: \begin{itemize} \item Name \item Year \item Album Artist + Name \item Album Artist + Year \end{itemize} \subsubsection{Requirements} PictureFlow uses both the album art (see \reference{ref:album_art}) and database (see \reference{ref:database}) features of Rockbox. These need to be working correctly before PictureFlow can be used. \textbf{PictureFlow does not support embedded album art.} \opt{tc_ramcache}{\note{It is strongly recommended you enable the database's "Load to RAM" feature (and restart your player afterwards)! See \reference{ref:databasemenu}. This will \textbf{vastly} speed up building the album index as well as loading of track titles when browsing albums.}} \opt{dircache}{\note{Enabling the disk's directory cache – see \reference{ref:dircache} – noticeably reduces the time it takes for cover art to be displayed.}} \begin{itemize} \item PictureFlow needs to build an album index the first time it's launched (Cancel/Quit by pressing any button) and then writes an album art cache to disk. During the latter, press any button to skip past the progress bar screen and to start browsing immediately. Processing of album art will continue in the background. An indicator in the screen corner shows you the completed percentage. When the cache is being built, the UI may be slow to react to your input. For optimal performance, wait for processing to complete. \item Each time you update your player's database, you should also update the cache in PictureFlow. \item PictureFlow will accept album art larger than the dimensions of the screen, but the larger the dimensions, the longer they will take to scale. \end{itemize} \subsubsection{Keys} \begin{btnmap} \opt{scrollwheel,IRIVER_H10_PAD,PBELL_VIBE500_PAD,MPIO_HD300_PAD}{% \ActionStdPrev{} / \ActionStdNext & \opt{HAVEREMOTEKEYMAP}{ &} Scroll through albums / track list \\ } % only scroll wheel and strip' targets use the same action in album and track list \nopt{scrollwheel,IRIVER_H10_PAD,PBELL_VIBE500_PAD,MPIO_HD300_PAD}{% % currently the M3 does not use buttons of the main unit which has no display \nopt{IAUDIO_M3_PAD,MPIO_HD200_PAD,touchscreen}{\ButtonLeft{} / \ButtonRight{}} \opt{MPIO_HD200_PAD}{FIXME} \opt{touchscreen}{\TouchMidLeft{} / \TouchMidRight} & \opt{HAVEREMOTEKEYMAP}{ \opt{IAUDIO_M3_PAD,GIGABEAT_RC_PAD}{\ActionRCStdPrev{} / \ActionRCStdNext} &} Scroll through albums \\ \nopt{IAUDIO_M3_PAD}{\ActionStdPrev{} / \ActionStdNext} & \opt{HAVEREMOTEKEYMAP}{ % even though the M3 uses an Iaudio remote, mapping differs when used with M/X5 \opt{IAUDIO_M3_PAD}{\ButtonRCLeft{} / \ButtonRCRight} \opt{GIGABEAT_RC_PAD}{\ButtonRCVolUp{} / \ButtonRCVolDown} &} Scroll through track list \\ } \opt{FIIO_M3K_PAD}{ \ButtonLeft{} / \ButtonRight{} & \opt{HAVEREMOTEKEYMAP}{&} Quickly jump to another album (alphabetically or by year) / browse through albums from track list \\ } \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{ \ButtonLeft{} / \ButtonRight{} & \opt{HAVEREMOTEKEYMAP}{&} Quickly jump to another album (alphabetically or by year) \\ } \opt{FIIO_M3K_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{ \opt{FIIO_M3K_PAD}{\ButtonVolUp{} / \ButtonVolDown} \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{ \ButtonSelect{} + \ButtonMenu{} / \ButtonSelect{} + \ButtonPlay } & \opt{HAVEREMOTEKEYMAP}{&} Adjust current album sorting \\ } \nopt{IAUDIO_M3_PAD}{% \nopt{IRIVER_H10_PAD,touchscreen,PBELL_VIBE500_PAD% ,SANSA_FUZE_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD,SAMSUNG_YH92X_PAD% ,SAMSUNG_YH820_PAD,XDUOO_X3_PAD} {\ButtonSelect} \opt{IRIVER_H10_PAD,PBELL_VIBE500_PAD}{\ButtonRight} \opt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{\ButtonFF} \opt{touchscreen}{\TouchCenter} \opt{SANSA_FUZE_PAD}{\ButtonRight} \opt{MPIO_HD200_PAD}{\ButtonFunc} \opt{MPIO_HD300_PAD}{\ButtonEnter} \opt{XDUOO_X3_PAD}{\ButtonPlay} } & \opt{HAVEREMOTEKEYMAP}{ \opt{IAUDIO_M3_PAD}{\ButtonRCPlay} \opt{GIGABEAT_RC_PAD}{\ButtonRCFF} &} Enter track list \nopt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{% / Play album from selected track} \\ % Ondio & Samsung YH use a different button in album list and track list \opt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{% \opt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{\ButtonPlay} & Play album from selected track in track list \\ } \nopt{IAUDIO_M3_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD,touchscreen,SANSA_FUZEPLUS_PAD,% FIIO_M3K_PAD}{\ButtonLeft} \opt{MPIO_HD200_PAD}{\ButtonRec} \opt{MPIO_HD300_PAD}{\ButtonMenu} \opt{SANSA_FUZEPLUS_PAD}{\ButtonLeft{} or \ButtonBack} \opt{FIIO_M3K_PAD}{\ButtonBack} \opt{touchscreen}{ \opt{COWON_D2_PAD}{\ButtonPower{} or} \TouchBottomRight} & \opt{HAVEREMOTEKEYMAP}{ \opt{IAUDIO_M3_PAD,GIGABEAT_RC_PAD}{\ActionRCStdCancel} &} Exit track list \\ \ActionStdContext & \opt{HAVEREMOTEKEYMAP}{&} Enter context menu \\ \nopt{IAUDIO_M3_PAD,SANSA_FUZEPLUS_PAD,FIIO_M3K_PAD% ,IPOD_4G_PAD,IPOD_3G_PAD}{\ActionStdMenu} \opt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{or \ButtonRew} \opt{IPOD_4G_PAD,IPOD_3G_PAD}{Long \ButtonMenu} \opt{SANSA_FUZEPLUS_PAD}{Long \ButtonSelect} \opt{FIIO_M3K_PAD}{\ButtonPower} & \opt{HAVEREMOTEKEYMAP}{ \opt{IAUDIO_M3_PAD,GIGABEAT_RC_PAD}{\ActionRCStdMenu} &} Enter menu \\ \nopt{IAUDIO_M3_PAD}{% \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff} \opt{IAUDIO_X5_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_CLIP_PAD% ,MROBE100_PAD,SANSA_FUZEPLUS_PAD}{\ButtonPower} \opt{SANSA_C200_PAD,IRIVER_H10_PAD}{Long \ButtonPower} \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ActionStdMenu} \opt{SANSA_FUZE_PAD}{Long \ButtonHome} \opt{PBELL_VIBE500_PAD}{\ButtonRec} \opt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{long \ButtonRew} \opt{MPIO_HD200_PAD}{FIXME} \opt{MPIO_HD300_PAD}{Long \ButtonMenu} \opt{FIIO_M3K_PAD}{\ButtonBack} \opt{touchscreen}{ \opt{COWON_D2_PAD}{Long \ButtonPower{} or} \TouchBottomRight{} (in album view)} } & \opt{HAVEREMOTEKEYMAP}{ \opt{IAUDIO_M3_PAD}{\ButtonRCRec} \opt{GIGABEAT_RC_PAD}{\ButtonRCRew} &} Exit PictureFlow \\ \end{btnmap} \subsubsection{Main Menu} \begin{description} \item[Go to WPS.] Leave PictureFlow and enter the While Playing Screen. \item[Clear playlist] Removes all entries from the current playlist. \item[Playback Control.] Control music playback from within the plugin. \item[Settings.] Enter the settings menu. \item[Return.] Exit menu. \item[Quit.] Exit PictureFlow plugin. \end{description} \subsubsection{Settings Menu} \begin{description} \item[Show album title.] Allows setting the album title / artist to be shown above or below the cover art, or not at all. \item[Show year in album title.] Set whether a year will be displayed next to each album title (determined by the release year of the latest track on an album). \item[Sort albums by.] Change the sorting of albums in PictureFlow. \item[Year sort order.] Determines whether albums are sorted in ascending or descending order, when sorting by year. \item[Display FPS.] Displays frames per second on screen. \item[Spacing.] The distance between the front edges of the side slides, i.e. changes the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom. \item[Centre margin.] The distance, in screen pixels, with zoom at 100, between the centre and side slides. Scales with zoom. \item[Number of slides.] Sets the number of slides at each side, including the centre slide. Therefore if set to 4, there will be 3 slides on the left, the centre slide, and then 3 slides on the right. \item[Zoom.] Changes the distance at which slides are rendered from the camera''. \item[Resize Covers.] Set whether to automatically resize the covers or to leave them at their original size. \item[Rebuild cache.] Creates a fresh album index and builds the artwork cache from scratch. \item[Update cache.] Creates a fresh album index and updates the existing artwork cache to include newly added albums. \item[WPS integration.] Integrate PictureFlow with the While Playing Screen. \item[Backlight.] Force backlight on while running pictureflow. \end{description} `