summaryrefslogtreecommitdiff
path: root/manual/plugins/main.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/plugins/main.tex')
-rw-r--r--manual/plugins/main.tex1243
1 files changed, 1243 insertions, 0 deletions
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
new file mode 100644
index 0000000000..2a53337a6b
--- /dev/null
+++ b/manual/plugins/main.tex
@@ -0,0 +1,1243 @@
1\chapter{Plugins}
2\newpage
3Plugins are little programs that Rockbox can load and run. Plugins have
4the file extension .rock. Most of them can be started from the main
5menu if you put them in the \textbf{/.rockbox/rocks} directory. Press
6PLAY on them to start them.
7
8Viewer plugins get started automatically by
9``playing'' an associated file (i.e. text
10files, chip8 games), or from the ``Open with'' option on the File menu.
11
12Plugins listed here have the platforms they run under (Player for
13Jukebox players, Recorder for Jukebox recorders including Jukebox FM,
14and Ondio for the Ondio SP and FM). If no platforms are listed then
15the plugin runs on all Rockbox platforms.\\
16
17\textbf{The plugin loader}
18Only one plugin can be loaded at a time. Plugins run in the GUI thread
19and have exclusive control over the user interface. This means you
20cannot switch back and forth between a plugin and Rockbox. A plugin is
21loaded, run and then exited, which returns control to Rockbox. Music
22will carry on playing whilst plugins are being run.
23
24\section{Games}
25See also the Chip{}-8 emulator on page \pageref{ref:Chip8emulator}.
26
27\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/flipit.tex}}
28
29\opt{player}{\input{plugins/jackpot.tex}}
30
31\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/minesweeper.tex}}
32
33\opt{player}{\input{plugins/nim.tex}}
34
35\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/rockblox.tex}}
36
37\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/sliding.tex}}
38
39\opt{recorder,recorderv2fm,ondio}{\input{plugins/snake.tex}}
40
41\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/snake2.tex}}
42
43\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/sokoban.tex}}
44
45\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/solitaire.tex}}
46
47\opt{recorder,recorderv2fm,ondio}{\input{plugins/star.tex}}
48
49\opt{recorder,recorderv2fm}{\input{plugins/wormlet.tex}}
50
51\section{Demos}
52
53\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/bounce.tex}}
54
55\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/cube.tex}}
56
57\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/grayscale.tex}}
58
59{\input{plugins/hello.tex}}
60
61\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/mandelbrot.tex}}
62
63\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/mosaic.tex}}
64
65\opt{recorder,recorderv2fm,ondio}{\input{plugins/oscillograph.tex}}
66
67\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/snow.tex}}
68
69\opt{recorder,recorderv2fm,ondio}{\input{plugins/vumeter.tex}}
70
71\section{\label{ref:Viewersplugins}Viewers}
72
73Viewers are plugins which are associated with specific file extensions.
74They cannot be run directly but are started by ``playing''
75the associated file. Viewers are stored in the
76\textbf{/.rockbox/viewers/ }directory.
77
78\subsection{\label{ref:Chip8emulator}Chip{}-8 Emulator (Recorder, Ondio)}
79The Chip{}-8 Emulator allows you to play many old chip8 games found on
80the Net. It modifies Rockbox, so file extensions .ch8 will be
81recognised as chip8 games. Just press PLAY on a .ch8 file to start a
82game.
83
84There are lots of tiny Chip8 games (usually only about 256 bytes to a
85couple of KB) which were made popular by the HP48
86calculator's emulator for them. The original Chip8 had
8764x32 pixel graphics, and the new superchip emulator supports 128x64
88graphics, which almost fits on the Recorder's display.
89The only problem is they are based on a 4x4 keyboard, but since most
90games do not use all of the buttons, this can easily be worked around.
91
92Some places where can you can find .ch8 files:
93
94\begin{itemize}
95\item The original chip8 patch had several attached:
96\url{http://sourceforge.net/tracker/index.php?func=detail&aid=628509&group_id=44306&atid=439120}
97\item Check out the HP48 chip games section:
98\url{http://www.hpcalc.org/hp48/games/chip/}
99\item Check out the PC emulator by the guy who wrote the HP48 emulator:
100\url{http://www.pdc.kth.se/~lfo/chip8/CHIP8.htm}
101\item Links to other chip8 emulators:
102\url{http://www.zophar.net/chip8.html}
103\end{itemize}
104
105\subsection{JPEG viewer (Recorder, Ondio)}
106Press PLAY on a .jpg file in order to view the contents using Rockbox's greyscale library. Use the arrow keys to move around the image, PLAY to zoom in
107and ON to zoom out. Press OFF to exit the viewer.
108
109Note: JPEGs that use progressive scan encoding are not supported and will produce an error.
110
111\subsection{Movie Player (Recorder, Ondio)}
112Play movies on your Jukebox! In order to do
113this, movies must be in AVI format, and then converted to .RVF,
114Rockbox's own video format. For more details on how to use this plugin, please see \url{http://www.rockbox.org/twiki/bin/view/Main/VideoTutorial}.
115
116\subsection{Rockbox\_flash (Recorder, Ondio)}
117{\centering\itshape
118 [Warning: Image ignored] % Unhandled or unsupported graphics:
119%\includegraphics[width=4.059cm,height=2.32cm]{images/rockbox-manual-img57.png}
120 \newline
121Rockbox flash
122\par}
123
124For ``playing'' .UCL files on flashed Jukeboxes. Reprograms the flash memory of
125the Jukebox unit (see page \pageref{ref:Rockboxinflash} for details).
126
127\subsection{Search}
128This plugin can be used on playlists. It searches through the playlist
129that it is opened on looking for any occurrences of the string entered by the
130user. The results of this search are saved to a new playlist,
131\textbf{search\_results.m3u}, within the same directory as the
132original playlist.
133
134\subsection{Sort}
135This plugin takes a file and sorts it in forward alphabetical order. Case is
136ignored. This is useful for ordering playlists generated by the ``Create Playlist'' menu option (see page \pageref{ref:Playlistsubmenu}).
137
138\subsection{Text Viewer}
139This is a Viewer for text files with word wrap. Just press PLAY on a
140.txt file to display it. Has controls to handle various styles of text
141formatting. Has top{}-of{}-file and bottom{}-of{}-file buttons. You
142can view files without a .txt extension by using \textbf{Open with ..}
143from the Play Screen menu
144
145\subsubsection{Controls}
146
147\begin{itemize}
148\item \textbf{F1 (Recorder) / ON{}-MINUS (Player): }
149toggles Word mode between Wrap and Chop:
150
151\begin{itemize}
152\item Wrap breaks lines at white space or hyphen.
153\item Chop breaks lines at the maximum column limit.
154\end{itemize}
155
156\item \textbf{F2 (Recorder) / ON{}-MENU{}-PLUS (Player): }
157cycles Line mode through Normal, Join and Expand:
158
159\begin{itemize}
160\item Normal breaks lines at newline characters.
161\item Join ignores unpaired newline characters (i.e., joins lines). Useful for
162adopting the orphans that occur with e{}-mail style (i.e.,pre{}-wrapped) text files.
163\item Expand doubles unpaired newlines (i.e., adds a blank line). Useful
164for making the paragraphs clearer in some book style text files.
165\end{itemize}
166
167\item \textbf{F3 (Recorder) / ON{}-PLUS (Player):}
168toggles View mode between Narrow and Wide:
169
170\begin{itemize}
171\item Narrow sets maximum column to the screen width.
172\item Wide sets maximum column to 114. Useful for navigating large
173files. (Currently, Wide and Join cannot be selected together.)
174\end{itemize}
175
176\item \textbf{ON{}-F1 (Recorder):}
177toggles Page mode between Normal and Overlap:
178
179\begin{itemize}
180\item Normal sets page{}-down/page{}-up to one full screen.
181\item Overlap tells page{}-down/page{}-up to retain one line from
182previous screen.
183\end{itemize}
184
185\item \textbf{ON{}-F3 (Recorder):}
186toggles Scrollbar mode, for the current View mode.
187
188\begin{itemize}
189\item Narrow mode has no scrollbar by default, until toggled.
190\item Wide mode has a scrollbar by default, until toggled.
191\item If file fits on one screen, there is no scrollbar and ON{}-F3 has
192no effect.
193\end{itemize}
194\end{itemize}
195
196Settings are not remembered after the viewer has been exited.
197Keys are as follows:
198
199\subsubsection{Recorder}
200
201\begin{tabular}[c]{|p{3.317cm}|p{7.104cm}|}
202\hline
203{\centering\bfseries\itshape
204KEY
205\par}
206&
207{\centering\bfseries\itshape
208ACTION
209\par}
210\\\hline
211{\centering
212UP
213\par}
214&
215Page{}-up (one screen up)
216\\\hline
217{\centering
218DOWN
219\par}
220&
221Page{}-down (one screen down)
222\\\hline
223{\centering
224LEFT
225\par}
226&
227Top of file (Narrow mode)\newline
228One screen left (Wide mode)
229\\\hline
230{\centering
231RIGHT
232\par}
233&
234Bottom of file (Narrow mode)\newline
235One screen right (Wide mode)
236\\\hline
237{\centering
238ON{}-UP
239\par}
240&
241One line up
242\\\hline
243{\centering
244ON{}-DOWN
245\par}
246&
247One line down
248\\\hline
249{\centering
250ON{}-LEFT
251\par}
252&
253One column left
254\\\hline
255{\centering
256ON{}-RIGHT
257\par}
258&
259One column right
260\\\hline
261{\centering
262OFF
263\par}
264&
265Exit text viewer
266\\\hline
267\end{tabular}
268
269\subsubsection{Player}
270
271\begin{tabular}[c]{|p{3.291cm}|p{7.131cm}|}
272\hline
273{\centering\bfseries\itshape
274KEY
275\par}
276&
277{\centering\bfseries\itshape
278ACTION
279\par}
280\\\hline
281{\centering
282MINUS
283\par}
284&
285Page{}-up (one screen up)
286\\\hline
287{\centering
288PLUS
289\par}
290&
291Page{}-down (one screen down)
292\\\hline
293{\centering
294MENU MINUS
295\par}
296&
297Top of file (Narrow mode)\newline
298One screen left (Wide mode)
299\\\hline
300{\centering
301MENU PLUS
302\par}
303&
304Bottom of file (Narrow mode)\newline
305One screen right (Wide mode)
306\\\hline
307{\centering
308STOP
309\par}
310&
311Exit text viewer
312\\\hline
313\end{tabular}
314
315\subsubsection{Compatibility}
316
317\begin{itemize}
318\item Correctly reads plain text files in Unix, Win/DOS, or Macintosh
319format. Latin{}-alphabet Unicode files are a l m o s t r e a d a b l
320e.
321\item Currently prefers fixed{}-width fonts. With proportional fonts,
322pretends all characters are the width of a lower{}-case 'o'.
323\item Currently messages are in English
324\item Does not currently support right{}-to{}-left languages.
325\end{itemize}
326
327\subsection{VBRfix}
328This function scans a VBR (Variable Bitrate)
329MP3 file and updates/creates the Xing VBR header. The Xing header
330contains information about the VBR stream used to calculate average bit
331rate, time information and to more accurately fwd/rew in the stream.
332
333This function is especially useful when the playback of a file skips,
334fwd/rew does not work correctly or the time display is incorrect. Run
335VBRfix on files you record with your Jukebox. The header is not present
336in the recorded files and VBRfix adds this header.
337
338Note: VBRfix can only run when music is
339turned off (since it uses the same memory as the player) and can take a
340while to complete if run on big files.
341
342\section{Applications}
343
344\subsection{Battery\_test}
345{\centering\itshape
346 [Warning: Image ignored] % Unhandled or unsupported graphics:
347%\includegraphics[width=3.704cm,height=2.117cm]{images/rockbox-manual-img58.png}
348 \textmd{ } [Warning: Image ignored]
349% Unhandled or unsupported graphics:
350%\includegraphics[width=4.598cm,height=1.976cm]{images/rockbox-manual-img59.png}
351 \newline
352 Recorder battery test Player battery test
353\par}
354
355This plugin simulates normal power drain by spinning up the disk and
356reading a big file once every 90 seconds (or thereabouts). Each
357spin up also writes the battery level to a
358log file. The test stops when battery level reaches 4\% in order to
359avoid being unable to write to the disk. The power usage data is saved
360to a file in the root directory of the Jukebox. This plugin can
361sometimes be useful for diagnosing problems with battery charging.
362
363\subsection{Calculator (Recorder, Ondio)}
364{\centering\itshape
365 [Warning: Image ignored] % Unhandled or unsupported graphics:
366%\includegraphics[width=3.889cm,height=2.223cm]{images/rockbox-manual-img60.png}
367 \newline
368Calculator
369\par}
370
371This is a simple scientific calculator for
372use on the Jukebox. It works like a standard calculator. Move using
373the arrow keys and press PLAY to press a button. Pressing the ``1st''
374button will toggle between other available maths functions on the right
375hand side.
376
377\subsection{Calendar (Recorder, Ondio)}
378{\centering\itshape
379 [Warning: Image ignored] % Unhandled or unsupported graphics:
380%\includegraphics[width=3.9cm,height=2.23cm]{images/rockbox-manual-img61.png}
381 \newline
382Calendar
383\par}
384
385This is a small and simple calendar application with memo saving function.
386
387Dots indicate dates with memos. To add a new memo press PLAY on the
388date. Includes one off, annual, monthly, and weekly memos:
389
390\begin{tabular}[c]{|p{2.6469998cm}|p{3.95cm}|}
391\hline
392{\centering\bfseries\itshape
393KEY
394\par}
395&
396{\centering\bfseries\itshape
397ACTION
398\par}
399\\\hline
400{\centering
401PLAY
402\par}
403&
404monthly
405\\\hline
406{\centering
407LEFT
408\par}
409&
410weekly
411\\\hline
412{\centering
413RIGHT
414\par}
415&
416annually
417\\\hline
418{\centering
419ON
420\par}
421&
422one off
423\\\hline
424{\centering
425STOP
426\par}
427&
428exit
429\\\hline
430\end{tabular}
431
432\subsection{Chess Clock}
433{\centering\itshape
434 [Warning: Image ignored] % Unhandled or unsupported graphics:
435%\includegraphics[width=4.634cm,height=1.984cm]{images/rockbox-manual-img62.png}
436 \newline
437Chess Clock
438\par}
439
440The chess clock plugin is designed to
441simulate a chess clock, but it can be used
442in any kind of game with up to ten players.
443
444\subsubsection{Setup}
445
446\begin{itemize}
447\item First enter the number of players (1{}-10) (press PLAY to
448continue).
449\item Then set the total game time in mm:ss (press PLAY to continue,
450STOP to go back).
451\item Then the maximum round time is entered. For example, this could
452be used to play Scrabble for a maximum of 15 minutes each, with each
453round taking no longer than one minute. (press PLAY to continue).
454\item Done. Player 1 starts in paused mode. So press PLAY to start.
455\end{itemize}
456
457\subsubsection{While playing}
458The number of the current player is displayed on the top line. The time
459below is the time remaining for that round (and possibly also the total
460time left if different).
461
462Keys are as follows:
463
464\begin{center}\begin{tabular}{|p{1.917cm}|p{2.7649999cm}|p{1.7049999cm}|p{9.433001cm}|}
465\hline
466{\centering\bfseries\itshape
467PLAYER
468\par}
469&
470{\centering\bfseries\itshape
471RECORDER
472\par}
473&
474{\centering\bfseries\itshape
475ONDIO
476\par}
477&
478{\centering\bfseries\itshape
479FUNCTION
480\par}
481\\\hline
482{\centering
483ON
484\par}
485&
486{\centering
487OFF
488\par}
489&
490{\centering
491ONOFF
492\par}
493&
494Exit plugin
495\\\hline
496{\centering
497STOP
498\par}
499&
500{\centering
501LEFT
502\par}
503&
504{\centering
505LEFT
506\par}
507&
508Restart round for the player
509\\\hline
510{\centering
511PLAY
512\par}
513&
514{\centering
515PLAY
516\par}
517&
518{\centering
519RIGHT
520\par}
521&
522Pausing the time (press again to continue)
523\\\hline
524{\centering
525RIGHT
526\par}
527&
528{\centering
529UP
530\par}
531&
532{\centering
533UP
534\par}
535&
536Switch to next player
537\\\hline
538{\centering
539LEFT
540\par}
541&
542{\centering
543DOWN
544\par}
545&
546{\centering
547DOWN
548\par}
549&
550Switch to previous player
551\\\hline
552{\centering
553MENU
554\par}
555&
556{\centering
557F1
558\par}
559&
560{\centering
561MODE
562\par}
563&
564Enter a simple menu
565\\\hline
566\end{tabular}\end{center}
567From the menu it is possible to delete a player, modify the round time
568for the current player or set the total time for the game.
569
570When the round time is up for a player the message ``ROUND UP!'' is shown (press NEXT to continue).
571
572When the total time is up for a player the message ``TIME UP!''is shown. Then player will then be removed from the timer.
573
574\subsection{Clock (Recorder)}
575{\centering\itshape
576 [Warning: Image ignored] % Unhandled or unsupported graphics:
577%\includegraphics[width=3.528cm,height=2.016cm]{images/rockbox-manual-img63.png}
578 \newline
579Clock
580\par}
581
582This is a fully featured analogue and digital clock program.
583
584\subsubsection{Key configuration}
585
586\begin{center}\begin{tabular}{|p{2.411cm}|p{6.012cm}|}
587\hline
588{\centering\bfseries\itshape
589KEY
590\par}
591&
592{\centering\bfseries\itshape
593ACTION
594\par}
595\\\hline
596{\centering
597F1
598\par}
599&
600Help
601\\\hline
602{\centering
603F2
604\par}
605&
606Start / Stop stopwatch
607\\\hline
608{\centering
609F2 (Hold)
610\par}
611&
612Reset stopwatch
613\\\hline
614{\centering
615F3
616\par}
617&
618Options
619\\\hline
620{\centering
621Play
622\par}
623&
624Select clock mode
625\\\hline
626{\centering
627UP
628\par}
629&
630Enable idle power off
631\\\hline
632{\centering
633DOWN
634\par}
635&
636Disable idle power off
637\\\hline
638{\centering
639RIGHT
640\par}
641&
642Enable backlight
643\\\hline
644{\centering
645LEFT
646\par}
647&
648Disable backlight
649\\\hline
650{\centering
651OFF
652\par}
653&
654Save settings to disk and exit
655\\\hline
656\end{tabular}\end{center}
657
658\subsubsection{Backlight configuration}
659If RIGHT or LEFT is not pressed during clock operation (with the
660exception of at the Help/Options/Mode Selector/Credit screens) then the
661backlight timeout will remain your Rockbox default setting (example, 15
662seconds). If RIGHT or LEFT is pressed, Clock will set the backlight to
663ON or OFF, respectively. When Clock is exited, your default Rockbox
664setting for Backlight will be restored.
665
666\subsubsection{Saving Settings}
667Settings are saved to disk when Clock is exited. They are saved to
668\textbf{/.rockbox/rocks/.clock\_settings''}. To reset your settings
669back to the defaults, simply navigate to this file using Rockbox,
670highlight it, and press the ON+PLAY keys to get the Delete option. This way you can feel free to experiment with the settings {}- and you could even load
671separate settings, say, one for your desk at home and one for in the car {}- by keeping two files in your \textbf{/.rockbox/rocks} folder such as
672``h.clock\_settings'' and ``c.clock\_settings''. Simply remove the
673``h'' for your home settings to go into effect, or add the ``h'' back and take off the ``c'' for your car settings.
674
675In the future, loading different settings will probably be made easier
676through a built{}-in settings file loader in Clock.
677
678\subsection{Euro Converter (Player)}
679{\centering\itshape
680 [Warning: Image ignored] % Unhandled or unsupported graphics:
681%\includegraphics[width=4.671cm,height=2cm]{images/rockbox-manual-img64.png}
682 \newline
683Euro converter
684\par}
685
686This plugin converts euros back into pre{}-euro currency. The country for which is does this is selectable by pressing the MENU key. The MINUS and
687PLUS keys move the cursor between the digits and the PLAY and STOP keys
688increase and decrease the current digit. The amount in the old
689currency is displayed on the second line.
690
691\subsection{Favorites}
692{\centering\itshape
693 [Warning: Image ignored] % Unhandled or unsupported graphics:
694%\includegraphics[width=4.667cm,height=1.998cm]{images/rockbox-manual-img65.png}
695 \newline
696Favorites
697\par}
698
699When listening to any song you can open it with this plugin and it will
700add the current song to a special playlist of all songs you selected in
701\textbf{/favorites.m3u}.
702
703\subsection{Firmware\_flash (Recorder, Ondio)}
704{\centering\mdseries\itshape
705 [Warning: Image ignored] % Unhandled or unsupported graphics:
706%\includegraphics[width=3.634cm,height=2.076cm]{images/rockbox-manual-img66.png}
707 \newline
708Firmware\_flash
709\par}
710
711Use when flashing Rockbox (see page \pageref{ref:FlashingRockboxReal}.
712In the ideal case, you'll need this tool only once. For safety reasons you may wish to delete \textbf{firmware\_flash.rock} from \textbf{/.rockbox/rocks} once flashing is complete.
713
714\subsection{Metronome}
715This plugin can be used as a metronome to keep time during music
716practice. Adjust the tempo though the interface or by tapping it out
717on the appropriate button.
718
719\begin{tabular}[c]{|p{2.587cm}|p{2.55cm}|p{2.62cm}|p{4.952cm}|}
720\hline
721{\centering\bfseries\itshape
722PLAYER
723\par}
724&
725{\centering\bfseries\itshape
726RECORDER
727\par}
728&
729{\centering\bfseries\itshape
730ONDIO
731\par}
732&
733{\centering\bfseries\itshape
734FUNCTION
735\par}
736\\\hline
737{\centering
738STOP
739\par}
740&
741{\centering
742OFF
743\par}
744&
745{\centering
746ONOFF
747\par}
748&
749Exit plugin
750\\\hline
751{\centering
752PLAY
753\par}
754&
755{\centering
756PLAY
757\par}
758&
759{\centering
760~
761\par}
762&
763Start / Stop
764\\\hline
765{\centering
766ON
767\par}
768&
769{\centering
770ON
771\par}
772&
773{\centering
774~
775\par}
776&
777Tap tempo
778\\\hline
779{\centering
780~
781\par}
782&
783{\centering
784~
785\par}
786&
787{\centering
788MODE
789\par}
790&
791Start / Tap tempo
792\\\hline
793{\centering
794~
795\par}
796&
797{\centering
798~
799\par}
800&
801{\centering
802HOLD MODE
803\par}
804&
805Stop
806\\\hline
807{\centering
808MINUS/PLUS
809\par}
810&
811{\centering
812LEFT/RIGHT
813\par}
814&
815{\centering
816LEFT/RIGHT
817\par}
818&
819Adjust tempo
820\\\hline
821{\centering
822ON+MINUS/\newline
823ON+PLUS
824\par}
825&
826{\centering
827UP/DOWN
828\par}
829&
830{\centering
831UP/DOWN
832\par}
833&
834Adjust volume
835\\\hline
836\end{tabular}
837
838\subsection{Split Editor (Recorder, Ondio)}
839When recording an mp3 file, it is common practice to start the recording
840a little bit early and stop it a little bit late to ensure all the
841desired sound is recorded. This results in recordings that contain
842extra snippets of sound and the beginning and end. Unfortunately these
843snippets can not be deleted easily because they are stored in the same
844file as the desired recording. The purpose of the split editor is to
845split a mp3 file (the input file) at a point in time (split point). Two
846new files can be generated from the input file. The first file contains
847the part before the split point and the second file contains the part
848after the split point. Once this process has been successful the
849original file can be deleted or kept as a backup.
850
851The whole process of splitting a mp3 file consists of three steps:
852
853\begin{enumerate}
854\item defining the split point
855\item generating the result files.
856\item if desired delete the input file (with the browser, not the split
857editor)
858\end{enumerate}
859
860\subsubsection{How to use the Split Editor}
861
862\begin{itemize}
863\item \textbf{Pause near the split point}
864When the device plays the song just hit the PAUSE button, when playback
865has roughly reached the split point. This need not be very precise as
866the split point can be fine tuned later.
867\item \textbf{Open the split editor}
868
869Open the plugin. A screen similar to the one below will appear.
870
871{\centering\itshape
872 [Warning: Image ignored] % Unhandled or unsupported graphics:
873%\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img67.gif}
874 \newline
875The Split Editor
876\par}
877
878{\centering\upshape
879Here is an explanation of the areas marked in red on the screenshot.
880\par}
881
882\begin{enumerate}
883\item The waveform \newline
884\newline
885The waveform displays the volume of the song over time. It will appear
886as the song plays and help to visually identify the point in time where
887the split is desired
888\item The split point indicator\newline
889\newline
890The split point indicator is a vertical line with a small triangle at
891the top end. It is the most important control element of the split
892editor. It can be moved with the LEFT and RIGHT buttons. Later, when
893you have fine tuned the split point, the song will be split at this
894position.
895\item The split time\newline
896\newline
897At the top of the window a time value is displayed. This is the point in
898time within the song at which the split point indicator is positioned.
899\item The locator\newline
900\newline
901Another vertical bar represents the position locator. It moves along as
902the song plays. In contrast to the split point indicator it has no
903triangles at the ends.
904\item The time bar\newline
905\newline
906The time bar displays the current position within the song relative to
907the whole song. The entire length of the time bar represents the song
908length. The length of the solid part of the time bar represents the position and length
909of the displayed part of the song.
910\item The scale mode\newline
911\newline
912Directly above the F3 button the scale mode is displayed. The waveform
913can be scaled either logarithmically or linearly. In logarithmic scale
914mode the letters ``dB'' are displayed, in linear mode ``\%''. Use F3 to
915switch between these modes. Linear mode usually gives better optical
916hints with commercially recorded music. For quiet recordings,
917especially of human speech, the logarithmic scale often is preferable.
918\item The loop mode \newline
919\newline
920Directly above the F2 button the loop mode icon is displayed. There are
9214 different loop modes. Pressing F2 changes to the next loop mode.
922
923\begin{itemize}
924\item [Warning: Image ignored] % Unhandled or unsupported graphics:
925%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img68.gif}
926 Playback loops around the split point indicator. This mode is best
927used when searching and zooming for the desired point at which to split
928the recording.
929\item [Warning: Image ignored] % Unhandled or unsupported graphics:
930%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img69.gif}
931 Playback loops from the split point indicator to the end of the
932visible area. This mode is best used when fine tuning the split
933indicator position at the beginning of a recording.
934\item [Warning: Image ignored] % Unhandled or unsupported graphics:
935%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img70.gif}
936 Playback loops from the beginning of the
937visible area to the split point. This mode is best used when fine
938tuning the split indicator position at the end of a recording.
939\item [Warning: Image ignored] % Unhandled or unsupported graphics:
940%\includegraphics[width=0.688cm,height=0.476cm]{images/rockbox-manual-img71.gif}
941 Playback doesn't loop, the borders of the visible
942area as well as the split point indicator are ignored. This mode is
943best used when playing the song outside of the borders of the displayed
944region.
945\end{itemize}
946
947\item Perform the split \newline
948\newline
949The icon directly above the F1 button indicates its function to execute
950the split. When split positioning is complete open the save dialogue with F1.
951\end{enumerate}
952
953{\bfseries
954Controls in the split editor }
955\end{itemize}
956
957\begin{tabular}[c]{|p{2.975cm}|p{3.047cm}|p{6.649cm}|}
958\hline
959{\centering\bfseries\itshape
960Recorder
961\par}
962&
963{\centering\bfseries\itshape
964Ondio
965\par}
966&
967{\centering\bfseries\itshape
968Function
969\par}
970\\\hline
971{\centering
972Off
973\par}
974&
975{\centering
976On/Off
977\par}
978&
979Quit plugin
980\\\hline
981{\centering
982Left/Right
983\par}
984&
985{\centering
986Left/Right
987\par}
988&
989Move the split point indicator
990\\\hline
991{\centering
992Up/Down
993\par}
994&
995{\centering
996Up/Down
997\par}
998&
999Zoom in / out
1000\\\hline
1001{\centering
1002Play
1003\par}
1004&
1005{\centering
1006Mode
1007\par}
1008&
1009Play from the split position
1010\\\hline
1011{\centering
1012F1
1013\par}
1014&
1015{\centering
1016Mode+Left
1017\par}
1018&
1019Enter the save dialogue
1020\\\hline
1021{\centering
1022F2
1023\par}
1024&
1025{\centering
1026Mode+Up
1027\par}
1028&
1029Toggle loop modes
1030\\\hline
1031{\centering
1032F3
1033\par}
1034&
1035{\centering
1036Mode+Right
1037\par}
1038&
1039Toggle logarithmic / linear scaling
1040\\\hline
1041{\centering
1042On+Left
1043\par}
1044&
1045{\centering
1046~
1047\par}
1048&
1049Play half speed
1050\\\hline
1051{\centering
1052On+Right
1053\par}
1054&
1055{\centering
1056~
1057\par}
1058&
1059Play 150\% speed
1060\\\hline
1061{\centering
1062On+Play
1063\par}
1064&
1065{\centering
1066~
1067\par}
1068&
1069Play normal speed
1070\\\hline
1071\end{tabular}
1072
1073\subsubsection{Save the files}
1074In the save dialogue it is possible to specify which of the files you
1075want to save and their names. When finished, select
1076``Save'' and the files will be written to
1077disk. Note that files can not be overwritten, so filenames that
1078don't exist yet must be chosen. If unsure whether the
1079file already exists simply try to save it. If another file with this
1080name exists the dialogue will return and you can choose another
1081filename
1082
1083{\centering\itshape
1084 [Warning: Image ignored] % Unhandled or unsupported graphics:
1085%\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img72.gif}
1086 \newline
1087Save dialogue
1088\par}
1089
1090Controls in the save dialogue
1091\begin{tabular}[c]{|p{2.62cm}|p{2.266cm}|p{3.965cm}|}
1092\hline
1093{\centering\bfseries\itshape
1094RECORDER
1095\par}
1096&
1097{\centering\bfseries\itshape
1098ONDIO
1099\par}
1100&
1101{\centering\bfseries\itshape
1102FUNCTION
1103\par}
1104\\\hline
1105{\centering
1106UP/DOWN
1107\par}
1108&
1109{\centering
1110UP/DOWN
1111\par}
1112&
1113Select item
1114\\\hline
1115{\centering
1116PLAY
1117\par}
1118&
1119{\centering
1120RIGHT
1121\par}
1122&
1123Toggle / edit item
1124\\\hline
1125\end{tabular}
1126
1127\subsubsection{Scale}
1128The values in the waveform are scaled according to the settings of the
1129peak meter. These can be altered in the menu
1130\textbf{General Settings {}-{\textgreater} Display{}-{\textgreater} Peak Meter}. If extreme minimum /
1131maximum values are set the waveform might be cut off. A minimum
1132setting of {}-60 dB and a maximum setting of 0 dB are recommended.
1133These settings should be capable of producing useful waveforms for very
1134soft sounds in logarithmic mode (dB). When the editor is used on loud
1135sounds (such as commercial rock or pop music) switching to the linear
1136scale may prove more effective since the logarithmic scale compresses
1137loud noises and makes it more difficult to identify characteristic
1138shapes. Note that it is always possible to toggle the scale with F3.
1139
1140\subsection{Stopwatch}
1141{\centering\itshape
1142 [Warning: Image ignored] % Unhandled or unsupported graphics:
1143%\includegraphics[width=3.704cm,height=2.117cm]{images/rockbox-manual-img73.png}
1144 \textmd{ } [Warning: Image ignored]
1145% Unhandled or unsupported graphics:
1146%\includegraphics[width=4.667cm,height=1.998cm]{images/rockbox-manual-img74.png}
1147 \newline
1148Recorder stopwatch Player stopwatch
1149\par}
1150
1151A simple stopwatch program with support for saving times.
1152
1153\subsubsection{Keys are as follows:}
1154
1155\begin{tabular}[c]{|p{2.9029999cm}|p{2.763cm}|p{2.199cm}|p{5.235cm}|}
1156\hline
1157{\centering\bfseries\itshape
1158PLAYER
1159\par}
1160&
1161{\centering\bfseries\itshape
1162RECORDER
1163\par}
1164&
1165{\centering\bfseries\itshape
1166ONDIO
1167\par}
1168&
1169{\centering\bfseries\itshape
1170FUNCTION
1171\par}
1172\\\hline
1173{\centering
1174MENU
1175\par}
1176&
1177{\centering
1178OFF
1179\par}
1180&
1181{\centering
1182ONOFF
1183\par}
1184&
1185Quit Plugin
1186\\\hline
1187{\centering
1188PLAY
1189\par}
1190&
1191{\centering
1192PLAY
1193\par}
1194&
1195{\centering
1196RIGHT
1197\par}
1198&
1199Start / stop
1200\\\hline
1201{\centering
1202STOP
1203\par}
1204&
1205{\centering
1206LEFT
1207\par}
1208&
1209{\centering
1210LEFT
1211\par}
1212&
1213Reset timer
1214\\\hline
1215{\centering
1216ON
1217\par}
1218&
1219{\centering
1220ON
1221\par}
1222&
1223{\centering
1224MODE
1225\par}
1226&
1227Take lap time
1228\\\hline
1229{\centering
1230MINUS/PLUS
1231\par}
1232&
1233{\centering
1234DOWN/UP
1235\par}
1236&
1237{\centering
1238DOWN/UP
1239\par}
1240&
1241Scroll through lap times
1242\\\hline
1243\end{tabular}