diff options
-rw-r--r-- | manual/configure_rockbox/display_options.tex | 2 | ||||
-rw-r--r-- | manual/plugins/images/icon-splitedit-loop-1.png | bin | 0 -> 131 bytes | |||
-rw-r--r-- | manual/plugins/images/icon-splitedit-loop-2.png | bin | 0 -> 131 bytes | |||
-rw-r--r-- | manual/plugins/images/icon-splitedit-loop-3.png | bin | 0 -> 130 bytes | |||
-rw-r--r-- | manual/plugins/images/icon-splitedit-loop-4.png | bin | 0 -> 131 bytes | |||
-rw-r--r-- | manual/plugins/images/ss-splitedit-main-112x64x1.png | bin | 0 -> 9459 bytes | |||
-rw-r--r-- | manual/plugins/images/ss-splitedit-save-112x64x1.png | bin | 0 -> 923 bytes | |||
-rw-r--r-- | manual/plugins/split_editor.tex | 304 |
8 files changed, 159 insertions, 147 deletions
diff --git a/manual/configure_rockbox/display_options.tex b/manual/configure_rockbox/display_options.tex index 580f99d4de..b197481537 100644 --- a/manual/configure_rockbox/display_options.tex +++ b/manual/configure_rockbox/display_options.tex | |||
@@ -248,7 +248,7 @@ | |||
248 | Show the number of times the clip indicator went active during | 248 | Show the number of times the clip indicator went active during |
249 | recording in front of the peakmeters. | 249 | recording in front of the peakmeters. |
250 | } | 250 | } |
251 | \item[Scale:] | 251 | \item[\label{ref:Peakmetersetting}Scale:] |
252 | Select whether the peak meter displays linear or logarithmic values. | 252 | Select whether the peak meter displays linear or logarithmic values. |
253 | The human ear perceives loudness on a logarithmic scale. If the Scale | 253 | The human ear perceives loudness on a logarithmic scale. If the Scale |
254 | setting is set to \setting{Logarithmic} (dB) scale, the volume values | 254 | setting is set to \setting{Logarithmic} (dB) scale, the volume values |
diff --git a/manual/plugins/images/icon-splitedit-loop-1.png b/manual/plugins/images/icon-splitedit-loop-1.png new file mode 100644 index 0000000000..bd50c82dfb --- /dev/null +++ b/manual/plugins/images/icon-splitedit-loop-1.png | |||
Binary files differ | |||
diff --git a/manual/plugins/images/icon-splitedit-loop-2.png b/manual/plugins/images/icon-splitedit-loop-2.png new file mode 100644 index 0000000000..50577e69c8 --- /dev/null +++ b/manual/plugins/images/icon-splitedit-loop-2.png | |||
Binary files differ | |||
diff --git a/manual/plugins/images/icon-splitedit-loop-3.png b/manual/plugins/images/icon-splitedit-loop-3.png new file mode 100644 index 0000000000..093821ed70 --- /dev/null +++ b/manual/plugins/images/icon-splitedit-loop-3.png | |||
Binary files differ | |||
diff --git a/manual/plugins/images/icon-splitedit-loop-4.png b/manual/plugins/images/icon-splitedit-loop-4.png new file mode 100644 index 0000000000..6b01acda15 --- /dev/null +++ b/manual/plugins/images/icon-splitedit-loop-4.png | |||
Binary files differ | |||
diff --git a/manual/plugins/images/ss-splitedit-main-112x64x1.png b/manual/plugins/images/ss-splitedit-main-112x64x1.png new file mode 100644 index 0000000000..56ddd6f831 --- /dev/null +++ b/manual/plugins/images/ss-splitedit-main-112x64x1.png | |||
Binary files differ | |||
diff --git a/manual/plugins/images/ss-splitedit-save-112x64x1.png b/manual/plugins/images/ss-splitedit-save-112x64x1.png new file mode 100644 index 0000000000..fbb2f31754 --- /dev/null +++ b/manual/plugins/images/ss-splitedit-save-112x64x1.png | |||
Binary files differ | |||
diff --git a/manual/plugins/split_editor.tex b/manual/plugins/split_editor.tex index 34fd40894f..a8ee56d33d 100644 --- a/manual/plugins/split_editor.tex +++ b/manual/plugins/split_editor.tex | |||
@@ -1,142 +1,155 @@ | |||
1 | \subsection{Split Editor} | 1 | \subsection{Split Editor} |
2 | \fixme{This chapter has to be rewritten, to fit in the multi-platform latex | 2 | |
3 | source code that we currently use} | ||
4 | When recording an mp3 file, it is common practice to start the recording | 3 | When recording an mp3 file, it is common practice to start the recording |
5 | a little bit early and stop it a little bit late to ensure all the | 4 | a little bit early and stop it a little bit late to ensure all the |
6 | desired sound is recorded. This results in recordings that contains | 5 | desired sound is recorded. This results in recordings that contain |
7 | extra snippets of sound in the beginning and the end. Unfortunately these | 6 | extra snippets of sound in the beginning and the end. Unfortunately these |
8 | snippets can not be deleted easily because they are stored in the same | 7 | snippets can not be deleted easily because they are stored in the same |
9 | file as the desired recording. The purpose of the split editor is to | 8 | file as the desired recording. The purpose of the split editor is to |
10 | split a mp3 file (the input file) at a point in time (split point). Two | 9 | split an mp3 file (the input file) at a point in time (split point). Two |
11 | new files can be generated from the input file. The first file contains | 10 | new files can be generated from the input file. The first file contains |
12 | the part before the split point and the second file contains the part | 11 | the part before the split point and the second file contains the part |
13 | after the split point. Once this process has been successful the | 12 | after the split point. Once this process has been successful the |
14 | original file can be deleted or kept as a backup. | 13 | original file can be deleted or kept as a backup. % |
15 | 14 | % | |
16 | The whole process of splitting a mp3 file consists of three steps: | 15 | The whole process of splitting an mp3 file consists of three steps: |
17 | 16 | % | |
18 | \begin{enumerate} | ||
19 | \item defining the split point | ||
20 | \item generating the result files. | ||
21 | \item if desired delete the input file (with the browser, not the split | ||
22 | editor) | ||
23 | \end{enumerate} | ||
24 | |||
25 | \subsubsection{How to use the Split Editor} | ||
26 | |||
27 | \begin{itemize} | 17 | \begin{itemize} |
28 | \item \textbf{Pause near the split point} | 18 | \item Defining the split point |
29 | When the device plays the song just hit the PAUSE button, when playback | 19 | \item Generating the result files |
30 | has roughly reached the split point. This need not be very precise as | 20 | \item If desired deleting the input file (with the browser, not the split editor) |
31 | the split point can be fine tuned later. | ||
32 | \item \textbf{Open the split editor} | ||
33 | |||
34 | Open the plugin. A screen similar to the one below will appear. | ||
35 | |||
36 | {\centering\itshape | ||
37 | [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
38 | %\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img67.gif} | ||
39 | \newline | ||
40 | The Split Editor | ||
41 | \par} | ||
42 | |||
43 | {\centering\upshape | ||
44 | Here is an explanation of the areas marked in red on the screenshot. | ||
45 | \par} | ||
46 | |||
47 | \begin{enumerate} | ||
48 | \item The waveform \newline | ||
49 | \newline | ||
50 | The waveform displays the volume of the song over time. It will appear | ||
51 | as the song plays and help to visually identify the point in time where | ||
52 | the split is desired | ||
53 | \item The split point indicator\newline | ||
54 | \newline | ||
55 | The split point indicator is a vertical line with a small triangle at | ||
56 | the top end. It is the most important control element of the split | ||
57 | editor. It can be moved with the LEFT and RIGHT buttons. Later, when | ||
58 | you have fine tuned the split point, the song will be split at this | ||
59 | position. | ||
60 | \item The split time\newline | ||
61 | \newline | ||
62 | At the top of the window a time value is displayed. This is the point in | ||
63 | time within the song at which the split point indicator is positioned. | ||
64 | \item The locator\newline | ||
65 | \newline | ||
66 | Another vertical bar represents the position locator. It moves along as | ||
67 | the song plays. In contrast to the split point indicator it has no | ||
68 | triangles at the ends. | ||
69 | \item The time bar\newline | ||
70 | \newline | ||
71 | The time bar displays the current position within the song relative to | ||
72 | the whole song. The entire length of the time bar represents the song | ||
73 | length. The length of the solid part of the time bar represents the position and length | ||
74 | of the displayed part of the song. | ||
75 | \item The scale mode\newline | ||
76 | \newline | ||
77 | Directly above the F3 button the scale mode is displayed. The waveform | ||
78 | can be scaled either logarithmically or linearly. In logarithmic scale | ||
79 | mode the letters ``dB'' are displayed, in linear mode ``\%''. Use F3 to | ||
80 | switch between these modes. Linear mode usually gives better optical | ||
81 | hints with commercially recorded music. For quiet recordings, | ||
82 | especially of human speech, the logarithmic scale often is preferable. | ||
83 | \item The loop mode \newline | ||
84 | \newline | ||
85 | Directly above the F2 button the loop mode icon is displayed. There are | ||
86 | 4 different loop modes. Pressing F2 changes to the next loop mode. | ||
87 | |||
88 | \begin{itemize} | ||
89 | \item [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
90 | %\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img68.gif} | ||
91 | Playback loops around the split point indicator. This mode is best | ||
92 | used when searching and zooming for the desired point at which to split | ||
93 | the recording. | ||
94 | \item [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
95 | %\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img69.gif} | ||
96 | Playback loops from the split point indicator to the end of the | ||
97 | visible area. This mode is best used when fine tuning the split | ||
98 | indicator position at the beginning of a recording. | ||
99 | \item [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
100 | %\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img70.gif} | ||
101 | Playback loops from the beginning of the | ||
102 | visible area to the split point. This mode is best used when fine | ||
103 | tuning the split indicator position at the end of a recording. | ||
104 | \item [Warning: Image ignored] % Unhandled or unsupported graphics: | ||
105 | %\includegraphics[width=0.688cm,height=0.476cm]{images/rockbox-manual-img71.gif} | ||
106 | Playback doesn't loop, the borders of the visible | ||
107 | area as well as the split point indicator are ignored. This mode is | ||
108 | best used when playing the song outside of the borders of the displayed | ||
109 | region. | ||
110 | \end{itemize} | ||
111 | |||
112 | \item Perform the split \newline | ||
113 | \newline | ||
114 | The icon directly above the F1 button indicates its function to execute | ||
115 | the split. When split positioning is complete open the save dialogue with F1. | ||
116 | \end{enumerate} | ||
117 | |||
118 | {\bfseries | ||
119 | Controls in the split editor } | ||
120 | \end{itemize} | 21 | \end{itemize} |
121 | 22 | ||
122 | \begin{table}[h!] | 23 | \subsubsection{How To Use The Split Editor} |
123 | \begin{tabular}{|c|c|c|} | 24 | When the device plays the song just hit the \ActionWpsPlay{} button |
124 | \hline | 25 | to pause, when playback has roughly reached the split point. This need |
125 | Recorder & Ondio & Function \\\hline | 26 | not be very precise as the split point can be fine tuned later. A screen |
126 | Off & On/Off & Quit plugin \\\hline | 27 | similar to the one below will appear. |
127 | Left/Right & Left/Right & Move the split point indicator \\\hline | 28 | |
128 | Up/Down & Up/Down & Zoom in / out \\\hline | 29 | \begin{figure}[H] |
129 | Play & Mode & Play from the split position \\\hline | 30 | \begin{center} |
130 | F1 & Mode+Left & Enter the save dialogue \\\hline | 31 | \includegraphics[width=8.0cm]{plugins/images/ss-splitedit-main-112x64x1} |
131 | F2 & Mode+Up & Toggle loop modes \\\hline | 32 | \caption{The Split Editor's Main Screen} |
132 | F3 & Mode+Right & Toggle logarithmic / linear scaling \\\hline | 33 | \end{center} |
133 | On+Left & ~ & Play half speed \\\hline | 34 | \end{figure} |
134 | On+Right & ~ & Play 150\% speed \\\hline | 35 | |
135 | On+Play & ~ & Play normal speed \\\hline | 36 | \subsubsection{The Split Editor's Main Screen} |
136 | \end{tabular} | 37 | \begin{description} |
137 | \end{table} | 38 | \item[The waveform] |
138 | 39 | displays the volume of the song over time. It will appear as the song | |
139 | \subsubsection{Save the files} | 40 | plays and help to visually identify the point in time where the split is |
41 | desired | ||
42 | % | ||
43 | \item[The split point indicator] | ||
44 | is a vertical line with a small triangle at the top end. It is the most | ||
45 | important control element of the split editor. It can be moved with the | ||
46 | \ButtonLeft\ and \ButtonRight\ buttons. Later, when you have fine tuned | ||
47 | the split point, the song will be split at this position. | ||
48 | % | ||
49 | \item[The split time] | ||
50 | At the top of the window a time value is displayed. This is the point in | ||
51 | time within the song at which the split point indicator is positioned. | ||
52 | % | ||
53 | \item[The locator] | ||
54 | Another vertical bar represents the position locator. It moves along as | ||
55 | the song plays. In contrast to the split point indicator it has no | ||
56 | triangles at the ends. | ||
57 | % | ||
58 | \item[The time bar] | ||
59 | displays the current position within the song relative to the whole song. | ||
60 | The entire length of the time bar represents the song length. The length | ||
61 | of the solid part of the time bar represents the position and length of | ||
62 | the displayed part of the song. | ||
63 | % | ||
64 | \item[The scale mode] | ||
65 | On the right side of the bottom line the scale mode is displayed. The | ||
66 | waveform can be scaled either logarithmically or linearly. In logarithmic | ||
67 | scale mode the letters ``dB'' are displayed, in linear mode ``\%''. Use | ||
68 | \opt{RECORDER_PAD}{\ButtonFThree} | ||
69 | \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonRight} | ||
70 | to switch between these modes. Linear mode usually gives better optical | ||
71 | hints with commercially recorded music. For quiet recordings, | ||
72 | especially of human speech, the logarithmic scale often is preferable. | ||
73 | More information in the Scale \reference{ref:Scalemode} below. | ||
74 | % | ||
75 | \item[The loop mode] | ||
76 | In the middle of the bottom line the loop mode icon is displayed. | ||
77 | There are 4 different loop modes. Pressing | ||
78 | \opt{RECORDER_PAD}{\ButtonFTwo} | ||
79 | \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonUp} | ||
80 | changes to the next loop mode. | ||
81 | % | ||
82 | \begin{description} | ||
83 | \item | ||
84 | \includegraphics[width=0.53cm]{plugins/images/icon-splitedit-loop-1} | ||
85 | Playback loops around the split point indicator. This mode is best | ||
86 | used when searching and zooming for the desired point at which to split | ||
87 | the recording. | ||
88 | \item | ||
89 | \includegraphics[width=0.53cm]{plugins/images/icon-splitedit-loop-2} | ||
90 | Playback loops from the split point indicator to the end of the | ||
91 | visible area. This mode is best used when fine tuning the split | ||
92 | indicator position at the beginning of a recording. | ||
93 | \item | ||
94 | \includegraphics[width=0.53cm]{plugins/images/icon-splitedit-loop-3} | ||
95 | Playback loops from the beginning of the | ||
96 | visible area to the split point. This mode is best used when fine | ||
97 | tuning the split indicator position at the end of a recording. | ||
98 | \item | ||
99 | \includegraphics[width=0.53cm]{plugins/images/icon-splitedit-loop-4} | ||
100 | Playback doesn't loop, the borders of the visible | ||
101 | area as well as the split point indicator are ignored. This mode is | ||
102 | best used when playing the song outside of the borders of the displayed | ||
103 | region. | ||
104 | \end{description} | ||
105 | \item[Perform the split (8)] | ||
106 | The icon above the | ||
107 | \opt{RECORDER_PAD}{\ButtonFOne} | ||
108 | \opt{ONDIO_PAD}{\ButtonLeft} | ||
109 | button indicates its function to execute the split. When split | ||
110 | positioning is complete open the save dialogue with | ||
111 | \opt{RECORDER_PAD}{\ButtonFOne} | ||
112 | \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonLeft}. | ||
113 | \end{description} | ||
114 | |||
115 | \begin{table} | ||
116 | \begin{btnmap}{Controls in the split editor}{} | ||
117 | \ButtonOff & Quit plugin \\ | ||
118 | % | ||
119 | \ButtonLeft\ / \ButtonRight & Move the split point indicator \\ | ||
120 | % | ||
121 | \ButtonUp\ / \ButtonDown & Zoom in / out \\ | ||
122 | % | ||
123 | \opt{RECORDER_PAD}{\ButtonPlay} | ||
124 | \opt{ONDIO_PAD}{\ButtonMenu} | ||
125 | & Play from the split position \\ | ||
126 | % | ||
127 | \opt{RECORDER_PAD}{\ButtonFOne} | ||
128 | \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonLeft} | ||
129 | & Enter the save dialogue \\ | ||
130 | % | ||
131 | \opt{RECORDER_PAD}{\ButtonFTwo} | ||
132 | \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonUp} | ||
133 | & Toggle loop modes \\ | ||
134 | % | ||
135 | \opt{RECORDER_PAD}{\ButtonFThree} | ||
136 | \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonRight} | ||
137 | & Toggle logarithmic / linear scaling \\ | ||
138 | \opt{RECORDER_PAD}{ | ||
139 | % | ||
140 | \ButtonOn\ + ButtonLeft | ||
141 | & Play half speed \\ | ||
142 | % | ||
143 | \ButtonOn\ + ButtonRight | ||
144 | & Play 150\% speed \\ | ||
145 | % | ||
146 | \ButtonOn\ + \ButtonPlay | ||
147 | & Play normal speed \\ | ||
148 | } | ||
149 | \end{btnmap} | ||
150 | \end{table} | ||
151 | |||
152 | \subsubsection{Save dialogue} | ||
140 | In the save dialogue it is possible to specify which of the files you | 153 | In the save dialogue it is possible to specify which of the files you |
141 | want to save and their names. When finished, select | 154 | want to save and their names. When finished, select |
142 | ``Save'' and the files will be written to | 155 | ``Save'' and the files will be written to |
@@ -146,27 +159,25 @@ file already exists simply try to save it. If another file with this | |||
146 | name exists the dialogue will return and you can choose another | 159 | name exists the dialogue will return and you can choose another |
147 | filename | 160 | filename |
148 | 161 | ||
149 | {\centering\itshape | 162 | \screenshot{plugins/images/ss-splitedit-save}{The Split Editor's |
150 | [Warning: Image ignored] % Unhandled or unsupported graphics: | 163 | Save Dialogue}{} |
151 | %\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img72.gif} | 164 | |
152 | \newline | 165 | \begin{table} |
153 | Save dialogue | 166 | \begin{btnmap}{Controls in the save dialogue}{} |
154 | \par} | 167 | \ButtonUp\ / \ButtonDown & Select item \\ |
155 | 168 | % | |
156 | Controls in the save dialogue | 169 | \opt{RECORDER_PAD}{\ButtonPlay} |
157 | \begin{table}[h!] | 170 | \opt{ONDIO_PAD}{\ButtonRight} |
158 | \begin{tabular}{|c|c|c|} | 171 | & Toggle / edit item \\ |
159 | \hline | 172 | % |
160 | RECORDER & ONDIO & FUNCTION \\\hline | 173 | \ButtonOff & Cancel \\ |
161 | UP/DOWN & UP/DOWN & Select item \\\hline | 174 | \end{btnmap} |
162 | PLAY & RIGHT & Toggle / edit item \\\hline | ||
163 | \end{tabular} | ||
164 | \end{table} | 175 | \end{table} |
165 | 176 | ||
166 | \subsubsection{Scale} | 177 | \subsubsection{\label{ref:Scalemode}Scale} |
167 | The values in the waveform are scaled according to the settings of the | 178 | The values in the waveform are scaled according to the settings of the |
168 | peak meter. These can be altered in the menu | 179 | peak meter. These can be altered in the peak meter settings, |
169 | \textbf{General Settings {}-{\textgreater} Display{}-{\textgreater} Peak Meter}. If extreme minimum / | 180 | see \reference{ref:Peakmetersetting}. If extreme minimum or |
170 | maximum values are set the waveform might be cut off. A minimum | 181 | maximum values are set the waveform might be cut off. A minimum |
171 | setting of {}-60 dB and a maximum setting of 0 dB are recommended. | 182 | setting of {}-60 dB and a maximum setting of 0 dB are recommended. |
172 | These settings should be capable of producing useful waveforms for very | 183 | These settings should be capable of producing useful waveforms for very |
@@ -174,6 +185,7 @@ soft sounds in logarithmic mode (dB). When the editor is used on loud | |||
174 | sounds (such as commercial rock or pop music) switching to the linear | 185 | sounds (such as commercial rock or pop music) switching to the linear |
175 | scale may prove more effective since the logarithmic scale compresses | 186 | scale may prove more effective since the logarithmic scale compresses |
176 | loud noises and makes it more difficult to identify characteristic | 187 | loud noises and makes it more difficult to identify characteristic |
177 | shapes. Note that it is always possible to toggle the scale with F3. | 188 | shapes. Note that it is always possible to toggle between the two scale |
189 | modes. | ||
178 | 190 | ||
179 | 191 | ||