diff options
Diffstat (limited to 'manual/plugins')
-rw-r--r-- | manual/plugins/pictureflow.tex | 114 |
1 files changed, 87 insertions, 27 deletions
diff --git a/manual/plugins/pictureflow.tex b/manual/plugins/pictureflow.tex index afab86ef18..87f07264fd 100644 --- a/manual/plugins/pictureflow.tex +++ b/manual/plugins/pictureflow.tex | |||
@@ -1,23 +1,44 @@ | |||
1 | \subsection{PictureFlow} | 1 | \subsection{PictureFlow} |
2 | \screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow} | 2 | \screenshot{plugins/images/ss-pictureflow}{PictureFlow}{img:pictureflow} |
3 | PictureFlow provides a visualisation of your albums with their associated cover | 3 | PictureFlow is a visual browser for your albums. After you've selected something to play, |
4 | art. It is possible to start playback of the selected album from PictureFlow. | 4 | PictureFlow will continue running by default, or can show the WPS. The optional WPS |
5 | Playback will start from the selected track. The PictureFlow plugin will | 5 | integration enables access to a context menu for adding albums or songs |
6 | continue to run while your tracks are played. | 6 | to the dynamic playlist directly from PictureFlow (see \reference{ref:currentplaylist_submenu}). |
7 | |||
8 | \subsubsection{Sort Options} | ||
9 | Albums can be sorted by: | ||
10 | |||
11 | \begin{itemize} | ||
12 | \item Name | ||
13 | \item Year | ||
14 | \item Album Artist + Name | ||
15 | \item Album Artist + Year | ||
16 | \end{itemize} | ||
7 | 17 | ||
8 | \subsubsection{Requirements} | 18 | \subsubsection{Requirements} |
9 | PictureFlow uses both the album art (see \reference{ref:album_art}) and | 19 | PictureFlow uses both the album art (see \reference{ref:album_art}) and |
10 | database (see \reference{ref:database}) features of Rockbox. | 20 | database (see \reference{ref:database}) features of Rockbox. |
11 | It is therefore important that these are working correctly before attempting | 21 | These need to be working correctly before PictureFlow can be used. |
12 | to use PictureFlow. In addition, there are some other points of which to be | 22 | {\bf PictureFlow does not support embedded album art.} |
13 | aware: | 23 | |
24 | \opt{tc_ramcache}{\note{It is strongly recommended you enable the database's "Load to RAM" feature | ||
25 | (and restart your player afterwards)! See \reference{ref:databasemenu}. This will {\bf vastly} speed up | ||
26 | building the album index as well as loading of track titles when browsing albums.}} | ||
27 | |||
28 | \opt{dircache}{\note{Enabling the disk's directory cache – see \reference{ref:dircache} – noticeably | ||
29 | reduces the time it takes for cover art to be displayed.}} | ||
30 | |||
14 | 31 | ||
15 | \begin{itemize} | 32 | \begin{itemize} |
16 | \item First an album index must be built, If you have a lot of albums/artists | 33 | \item PictureFlow needs to build an album index the first time it's launched |
17 | this could take a while, any button cancels the process and quits pictureflow. | 34 | (Cancel/Quit by pressing any button) and then writes an album art cache to disk. |
18 | \item You don't have to wait for the albumart search to finish, you can press | 35 | During the latter, press any button to skip past the progress bar screen and |
19 | any button and the albumart will be searched in the background. | 36 | to start browsing immediately. Processing of album art will continue in the |
20 | \item Pictureflow checks for updated albumart (in background) on every restart | 37 | background. An indicator in the screen corner shows you the completed percentage. |
38 | When the cache is being built, the UI may be slow to react to your input. | ||
39 | For optimal performance, wait for processing to complete. | ||
40 | \item Each time you update your player's database, you should manually rebuild or | ||
41 | update the cache in PictureFlow. | ||
21 | \item PictureFlow will accept album art larger than the dimensions of the | 42 | \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. | 43 | screen, but the larger the dimensions, the longer they will take to scale. |
23 | \end{itemize} | 44 | \end{itemize} |
@@ -32,7 +53,7 @@ aware: | |||
32 | Scroll through albums / track list | 53 | Scroll through albums / track list |
33 | \\ | 54 | \\ |
34 | } | 55 | } |
35 | 56 | ||
36 | % only scroll wheel and `strip' targets use the same action in album and track list | 57 | % only scroll wheel and `strip' targets use the same action in album and track list |
37 | \nopt{scrollwheel,IRIVER_H10_PAD,PBELL_VIBE500_PAD,MPIO_HD300_PAD}{% | 58 | \nopt{scrollwheel,IRIVER_H10_PAD,PBELL_VIBE500_PAD,MPIO_HD300_PAD}{% |
38 | % currently the M3 does not use buttons of the main unit which has no display | 59 | % currently the M3 does not use buttons of the main unit which has no display |
@@ -57,6 +78,29 @@ aware: | |||
57 | \\ | 78 | \\ |
58 | } | 79 | } |
59 | 80 | ||
81 | \opt{FIIO_M3K_PAD}{ | ||
82 | \ButtonLeft{} / \ButtonRight | ||
83 | & | ||
84 | \opt{HAVEREMOTEKEYMAP}{&} | ||
85 | Quickly jump to another album (alphabetically or by year) / | ||
86 | browse through albums from track list | ||
87 | \\ | ||
88 | } | ||
89 | \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{ | ||
90 | \ButtonLeft{} / \ButtonRight | ||
91 | & | ||
92 | \opt{HAVEREMOTEKEYMAP}{&} | ||
93 | Quickly jump to another album (alphabetically or by year) | ||
94 | \\ | ||
95 | } | ||
96 | \opt{FIIO_M3K_PAD}{ | ||
97 | \ButtonVolUp{} / \ButtonVolDown | ||
98 | & | ||
99 | \opt{HAVEREMOTEKEYMAP}{&} | ||
100 | Adjust current album sorting | ||
101 | \\ | ||
102 | } | ||
103 | |||
60 | \nopt{IAUDIO_M3_PAD}{% | 104 | \nopt{IAUDIO_M3_PAD}{% |
61 | \nopt{IRIVER_H10_PAD,touchscreen,PBELL_VIBE500_PAD% | 105 | \nopt{IRIVER_H10_PAD,touchscreen,PBELL_VIBE500_PAD% |
62 | ,SANSA_FUZE_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD,SAMSUNG_YH92X_PAD% | 106 | ,SANSA_FUZE_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD,SAMSUNG_YH92X_PAD% |
@@ -85,11 +129,13 @@ aware: | |||
85 | Play album from selected track in track list | 129 | Play album from selected track in track list |
86 | \\ | 130 | \\ |
87 | } | 131 | } |
88 | 132 | ||
89 | \nopt{IAUDIO_M3_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD,touchscreen,SANSA_FUZEPLUS_PAD}{\ButtonLeft} | 133 | \nopt{IAUDIO_M3_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD,touchscreen,SANSA_FUZEPLUS_PAD,% |
134 | FIIO_M3K_PAD}{\ButtonLeft} | ||
90 | \opt{MPIO_HD200_PAD}{\ButtonRec} | 135 | \opt{MPIO_HD200_PAD}{\ButtonRec} |
91 | \opt{MPIO_HD300_PAD}{\ButtonMenu} | 136 | \opt{MPIO_HD300_PAD}{\ButtonMenu} |
92 | \opt{SANSA_FUZEPLUS_PAD}{\ButtonLeft{} or \ButtonBack} | 137 | \opt{SANSA_FUZEPLUS_PAD}{\ButtonLeft{} or \ButtonBack} |
138 | \opt{FIIO_M3K_PAD}{\ButtonBack} | ||
93 | \opt{touchscreen}{ | 139 | \opt{touchscreen}{ |
94 | \opt{COWON_D2_PAD}{\ButtonPower{} or} | 140 | \opt{COWON_D2_PAD}{\ButtonPower{} or} |
95 | \TouchBottomRight} | 141 | \TouchBottomRight} |
@@ -100,10 +146,16 @@ aware: | |||
100 | Exit track list | 146 | Exit track list |
101 | \\ | 147 | \\ |
102 | 148 | ||
103 | \nopt{IAUDIO_M3_PAD,SANSA_FUZEPLUS_PAD}{\ActionStdMenu} | 149 | \ActionStdContext |
104 | \nopt{IAUDIO_M3_PAD,SANSA_FUZEPLUS_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{\ActionStdMenu} | 150 | & |
105 | \opt{SANSA_FUZEPLUS_PAD}{long \ButtonSelect} | 151 | \opt{HAVEREMOTEKEYMAP}{&} |
106 | \opt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{or \ButtonRew} | 152 | Enter context menu (if WPS integration is enabled) |
153 | \\ | ||
154 | |||
155 | \nopt{IAUDIO_M3_PAD,SANSA_FUZEPLUS_PAD,FIIO_M3K_PAD}{\ActionStdMenu} | ||
156 | \opt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{or \ButtonRew} | ||
157 | \opt{SANSA_FUZEPLUS_PAD}{Long \ButtonSelect} | ||
158 | \opt{FIIO_M3K_PAD}{\ButtonPower} | ||
107 | & | 159 | & |
108 | \opt{HAVEREMOTEKEYMAP}{ | 160 | \opt{HAVEREMOTEKEYMAP}{ |
109 | \opt{IAUDIO_M3_PAD,GIGABEAT_RC_PAD}{\ActionRCStdMenu} | 161 | \opt{IAUDIO_M3_PAD,GIGABEAT_RC_PAD}{\ActionRCStdMenu} |
@@ -117,11 +169,12 @@ aware: | |||
117 | ,MROBE100_PAD,SANSA_FUZEPLUS_PAD}{\ButtonPower} | 169 | ,MROBE100_PAD,SANSA_FUZEPLUS_PAD}{\ButtonPower} |
118 | \opt{SANSA_C200_PAD,IRIVER_H10_PAD}{Long \ButtonPower} | 170 | \opt{SANSA_C200_PAD,IRIVER_H10_PAD}{Long \ButtonPower} |
119 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{Long \ButtonMenu} | 171 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{Long \ButtonMenu} |
120 | \opt{SANSA_FUZE_PAD}{Long \ButtonHome} | 172 | \opt{SANSA_FUZE_PAD}{Long \ButtonHome} |
121 | \opt{PBELL_VIBE500_PAD}{\ButtonRec} | 173 | \opt{PBELL_VIBE500_PAD}{\ButtonRec} |
122 | \opt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{long \ButtonRew} | 174 | \opt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{long \ButtonRew} |
123 | \opt{MPIO_HD200_PAD}{FIXME} | 175 | \opt{MPIO_HD200_PAD}{FIXME} |
124 | \opt{MPIO_HD300_PAD}{Long \ButtonMenu} | 176 | \opt{MPIO_HD300_PAD}{Long \ButtonMenu} |
177 | \opt{FIIO_M3K_PAD}{\ButtonBack} | ||
125 | \opt{touchscreen}{ | 178 | \opt{touchscreen}{ |
126 | \opt{COWON_D2_PAD}{Long \ButtonPower{} or} | 179 | \opt{COWON_D2_PAD}{Long \ButtonPower{} or} |
127 | \TouchBottomRight{} (in album view)} | 180 | \TouchBottomRight{} (in album view)} |
@@ -133,12 +186,13 @@ aware: | |||
133 | &} | 186 | &} |
134 | Exit PictureFlow | 187 | Exit PictureFlow |
135 | \\ | 188 | \\ |
136 | 189 | ||
137 | \end{btnmap} | 190 | \end{btnmap} |
138 | 191 | ||
139 | \subsubsection{Main Menu} | 192 | \subsubsection{Main Menu} |
140 | \begin{description} | 193 | \begin{description} |
141 | \item[Go to WPS.] Leave PictureFlow and enter the while playing screen. | 194 | \item[Go to WPS.] Leave PictureFlow and enter the While Playing Screen. |
195 | \item[Clear playlist] Removes all entries from the current playlist. | ||
142 | \item[Playback Control.] Control music playback from within the plugin. | 196 | \item[Playback Control.] Control music playback from within the plugin. |
143 | \item[Settings.] Enter the settings menu. | 197 | \item[Settings.] Enter the settings menu. |
144 | \item[Return.] Exit menu. | 198 | \item[Return.] Exit menu. |
@@ -148,7 +202,14 @@ aware: | |||
148 | \subsubsection{Settings Menu} | 202 | \subsubsection{Settings Menu} |
149 | 203 | ||
150 | \begin{description} | 204 | \begin{description} |
151 | \item[Show FPS.] Displays frames per second on screen. | 205 | \item[Show album title.] Allows setting the album title / artist to be |
206 | shown above or below the cover art, or not at all. | ||
207 | \item[Show year in album title.] Set whether a year will be displayed next to each album | ||
208 | title (determined by the release year of the latest track on an album). | ||
209 | \item[Sort albums by.] Change the sorting of albums in PictureFlow. | ||
210 | \item[Year sort order.] Determines whether albums are sorted in ascending or descending | ||
211 | order, when sorting by year. | ||
212 | \item[Display FPS.] Displays frames per second on screen. | ||
152 | \item[Spacing.] The distance between the front edges of the side slides, i.e. changes | 213 | \item[Spacing.] The distance between the front edges of the side slides, i.e. changes |
153 | the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom. | 214 | the degree of overlap of the side slides. A larger number means less overlap. Scales with zoom. |
154 | \item[Centre margin.] The distance, in screen pixels, with zoom at 100, between | 215 | \item[Centre margin.] The distance, in screen pixels, with zoom at 100, between |
@@ -157,14 +218,13 @@ aware: | |||
157 | centre slide. Therefore if set to 4, there will be 3 slides on the left, | 218 | centre slide. Therefore if set to 4, there will be 3 slides on the left, |
158 | the centre slide, and then 3 slides on the right. | 219 | the centre slide, and then 3 slides on the right. |
159 | \item[Zoom.] Changes the distance at which slides are rendered from the ``camera''. | 220 | \item[Zoom.] Changes the distance at which slides are rendered from the ``camera''. |
160 | \item[Show album title.] Allows setting the album title / artist to be | ||
161 | shown above or below the cover art, or not at all. | ||
162 | \item[Resize Covers.] Set whether to automatically resize the covers or to leave | 221 | \item[Resize Covers.] Set whether to automatically resize the covers or to leave |
163 | them at their original size. | 222 | them at their original size. |
164 | \item[Rebuild cache.] Rebuild the PictureFlow cache. This is needed in order | 223 | \item[Rebuild cache.] Rebuild the PictureFlow cache. This is needed in order |
165 | for PictureFlow to pick up new albums, and may occasionally be needed if albums | 224 | for PictureFlow to pick up new albums, and may occasionally be needed if albums |
166 | are removed. | 225 | are removed. |
167 | \item[Update cache.] Update the PictureFlow cache. New albumart will be added. | 226 | \item[Update cache.] Update the PictureFlow cache. New albumart will be added. |
168 | \item[WPS integration.] Integrate pictureflow with the While Playing Screen. | 227 | \item[WPS integration.] Integrate PictureFlow with the While Playing Screen and enable |
228 | the Current Playlist context menu. | ||
169 | \item[Backlight.] Force backlight on while running pictureflow. | 229 | \item[Backlight.] Force backlight on while running pictureflow. |
170 | \end{description} | 230 | \end{description} |