Andrea starting index entries + minor changes
[goodguy/cin-manual-latex.git] / parts / Editing.tex
1 \chapter{Editing}%
2 \label{cha:editing}
3
4 Editing comprises both time and track space.  The timeline consists
5 of the time certain media appear on the track going left to right
6 and a set of tracks from the top to the bottom.  There are 2 methods
7 of timeline editing -- drag and drop editing, also called
8 \textit{arrow mode}, and cut and paste editing or \textit{I-beam
9   mode}.  Cut and Paste is the default editing mode.  An additional,
10 but not often considered editing method is called \textit{two-screen
11   editing} where the Viewer is used to view media and then the
12 desired clip from the media is transferred to the timeline.
13
14 The timeline is where all editing decisions are made
15 (figure~\ref{fig:timeline}).  This is a stack of tracks in the
16 center of the main window.  It can be scrolled up, down, left and
17 right with the scrollbars on the right and bottom.  It can also be
18 scrolled up and down with a mouse wheel, or left and right while
19 holding down the Ctrl key and using the mouse wheel.
20
21 \begin{figure}[htpb]
22   \centering
23   \includegraphics[width=1.0\linewidth]{timeline.png}
24   \caption{Timeline editing session}
25   \label{fig:timeline}
26 \end{figure}
27
28 The active region is the range of time which is affected by editing
29 commands on the timeline.  The active region is determined first by
30 the presence of in/out points on the timeline.
31 %
32 If those do not exist the highlighted region is used. To reiterate,
33 \emph{highlighting} is done in \emph{cut and paste mode} by moving
34 the insertion point with the mouse in the timeline to where you want
35 to start. Then hold down the LMB\@, drag the mouse to where you want
36 the end point to be and release the LMB\@. In \emph{drag and drop
37   mode}, the method to create a highlighted selection is to hold
38 down the Ctrl key and double click with the LMB with the mouse over
39 that column.
40
41 If no highlighted region exists, the insertion point is used as the
42 start of the active region.  Some commands treat all the space to
43 the right of the insertion point as active while others treat the
44 active length as 0 (zero) if no end point for the active region is
45 defined.
46
47 Most importantly, editing decisions never affect source material
48 meaning that it is non-destructive editing.  So not only does your
49 original media stay completely untouched, it is much faster than if
50 you had to copy all the media affected by an edit.  Editing only
51 affects pointers to source material, so if you want to have a new
52 modified media file at the end of your editing session which
53 represents the editing decisions, you need to render it.  Saving and
54 loading your edit decisions is explained in the Load, Save and the
55 EDL section and rendering is explained in the section on Rendering.
56
57 In the following editing sections, references to common operations
58 are scattered within any of the modes where they seem pertinent.
59 However, many of the editing operations work in different modes.
60
61
62 \section{The Patchbay}%
63 \label{sec:patchbay}
64
65 On the left of the timeline is a region known as the patchbay.  The
66 patchbay enables features specific to each track as described next.
67
68
69 \begin{description}
70 \item[Textbox] for naming the track.  The default names will usually
71   be Video \#, Audio \#, or Mixer \# if using the multi-camera/mixer
72   operations.  A \# will be designated for subsequent tracks as in 1,
73   2, 3 and so on.
74 \item[Expander] which is a down arrow on the right side, is for
75   viewing more options on the patchbay and for viewing the effects
76   represented on the track.  You can just click on the expander to
77   expand or collapse the patchbay and the track.  If it is pointing
78   sideways, the track is collapsed.  If it is pointing down, the track
79   is expanded.  Existing effects appear below the media for the track.
80 \end{description}
81
82 Below the textbox name are several toggles referred to as
83 \textit{attributes} for different features (currently there are 7 as
84 shown in figure~\ref{fig:patchbay01}).  If the toggle button is
85 shadowed by a color, the feature is enabled. If the toggle is the
86 background color of most of the window, it is disabled. Click on the
87 toggle to enable/disable the feature.
88
89 \begin{wrapfigure}[13]{O}{0.3\linewidth}
90   %\vspace{-2ex}
91   \centering
92   \includegraphics[width=0.79\linewidth]{patchbay01.png}
93   \caption{Patchbay}
94   \label{fig:patchbay01}
95 \end{wrapfigure}
96
97 Several mouse operations speed up the configuration of several
98 tracks at a time. Click on an attribute and drag the cursor across
99 adjacent tracks to copy the same attribute to those tracks.  Hold
100 down Shift while clicking a track's attribute to enable the
101 attribute in the current track and toggle the attribute in all the
102 other tracks. Or you can:
103
104 \begin{enumerate}
105 \item hold down Shift while clicking an attribute,
106 \item click until all the tracks except the selected one are
107   disabled,
108 \item then drag the cursor over the adjacent track to enable the
109   attribute in the adjacent track.
110 \end{enumerate}
111
112 The 7 \textit{attributes} are described here next followed by the other available feature icons and their description.
113
114 \begin{description}
115 \item[Play Track] determines whether the track is rendered or
116   not. If it is off, the track is not rendered.  For example if you
117   turn it off in all the video tracks, the rendered media file will
118   have only audio tracks.  If the track is chained to any other tracks
119   by a shared track effect, the other tracks perform all the effects
120   in this shared track, regardless of play status of the shared track
121   that in this particular case affects the media output but not fade
122   and effects.
123 \item[Arm Track] determines whether the track is armed or not.
124   Only the armed tracks are affected by editing operations. Make sure
125   you have enough armed destination tracks when you paste or splice
126   material or some tracks in the material will get left out.  In
127   addition to restricting editing operations, the armed tracks in
128   combination with the active region determine where material is
129   inserted when loading files.  If the files are loaded with one of
130   the insertion strategies which do not delete the existing project,
131   the armed tracks will be used as destination tracks.
132 \end{description}
133
134 \begin{description}
135 \item[Draw Media] determines if picons or waveforms are drawn on
136   the asset in the track.  You may want to disable this if you know
137   that the media/format takes a long time to draw on the timeline.  By
138   default it is set to on in order to see picons on the timeline.
139 \item[Don’t send to output] -- more commonly called
140   \textit{mute} -- causes the output to be thrown away once the track is
141   completely rendered. This happens whether or not \textit{Play track}
142   is on.  For example if you mute all the video tracks, the rendered
143   media file will have a blank video track.  Mute track is represented
144   on the timeline with a line that has the default color of a
145   pinkish-orange.  Use the pulldown \texttt{View $\rightarrow$ Mute} to
146   have the line displayed.  It is a keyframable attribute, but Mute
147   track keyframing is a toggle and it has only the two values of on or
148   off. If a track is part of a shared track effect, the output of the
149   track with the shared track effect is overlaid on the final output
150   even though it is routed back to another track (the shared track).
151   Mute track is used to keep the track with the shared track effect
152   from overlapping the output of the source track (the shared track)
153   where the shared track effect is not present.
154 \item[Gang Fader] cause the fader to track the movement of
155   whatever other fader you are adjusting by dragging either the fader
156   or the curve on the track.  It doesn't affect the editing made with
157   menu controls.  A fader is only ganged if the arm track is also on.
158   This is often used to adjust audio levels on all the tracks
159   simultaneously.  Gang also causes Nudge parameters to synchronize
160   across all the ganged tracks.
161 \item[Master Track] Mark a track as \textit{master} serves when using \textit{Gang Channels} or \textit{Gang Media} mode. See \nameref{sub:displaying_tracks_ganged}
162 \item[Track Data Height] this up/down toggle symbol to the immediate right
163 of the 5 attributes, is used to individually resize each track.  This makes
164 it very easy to temporarily expand or contract the size of that track either
165 by clickin with the left mouse button or using the middle wheel up/down.
166 \item[Fader slider] fade values are represented on the timeline
167   with a pink (default color) curve that is keyframable.  All tracks have a fader, but
168   the units of each fader depend on whether it is audio or video.
169   Audio fade values are in dB. They represent relative levels, where 0
170   is the unaltered original sound level, -40 is silence, -80 the
171   minimum value set by default.  You can move fader and keyframes down
172   to -80 but the parameter's curve won't go below -40.  For your
173   convenience you can set a different fade range with the curve zoom.
174   Audio fader’s main purpose is to \textit{fade out} sound or to lower
175   the sound level smoothly to silence, or \textit{fade in} to make
176   sounds appear gradually instead of suddenly.  Video fade values are
177   the percentage of opacity of the image in normal overlay mode, the
178   percentage of the layer that is mixed into the render pipeline in
179   the other overlay modes.  Click and drag the fader to fade the track
180   in and out.  If it is ganged to other tracks of the same media type,
181   with the arm option enabled, the other faders should follow.  Hold
182   down the Shift key and drag a fader to center it on the original
183   source value (0 for audio, 100 for video).
184 \item[Mixer] in the expanded patchbay for that track designates
185   the multi-camera mixer mode.
186 \item[Overlay mode] in the expanded patchbay is used for
187   porter-duff operations and is full explained in
188   \nameref{cha:overlays} chapter.
189 \item[Nudge] is in the expanded patchbay.  The nudge value is
190   the amount the track is shifted left or right during playback. The
191   track is not displayed shifted on the timeline, but it is shifted
192   when it is played back. This is useful for synchronizing audio with
193   video, creating fake stereo, or compensating for an effect which
194   shifts time, all without altering any edits
195   (figure~\ref{fig:overlay}).
196
197   \begin{figure}[htpb] \centering
198     \includegraphics[width=0.65\linewidth]{overlay.png}
199     \caption{Video Overlay, audio Pan and Nudge.}
200     \label{fig:overlay}
201   \end{figure}
202
203   Enter the amount of time to shift to instantly shift the
204   track. Negative numbers make the track play later. Positive numbers
205   make the track play sooner. The nudge units are either seconds or
206   the native units for the track (frames or samples). Select the units
207   by right clicking on the nudge textbox and using the context
208   sensitive menu. Nudge settings are ganged with the Gang faders
209   toggle and the Arm track toggle. Use the mouse wheel over the nudge
210   textbox to increment and decrement the value.
211 \item[Pan] is available in the expanded patchbay for audio
212   tracks via a panning box. Position the pointer in the panning box
213   and click/drag to reposition the audio output among the speaker
214   arrangement. The loudness of each speaker is printed on the relative
215   icon during the dragging operation. The panning box uses a special
216   algorithm to try to allow audio to be focused through one speaker or
217   branched between the nearest speakers when more than 2 speakers are
218   used.
219 \end{description}
220
221 Press the Tab key while the cursor is anywhere over a track to
222 toggle the track arming status. Press Shift-Tab while the cursor is
223 over a track to toggle the arming status of every other track.
224
225 \paragraph{Automatic audio mappings} Several convenience functions
226 are provided for automatically setting the panning to several common
227 standards. They are listed in the Audio menu. These functions only
228 affect armed audio tracks. They are:
229
230 \begin{description}
231 \item[Audio~$\rightarrow$~Map 1:1] This maps every track to
232   its own channel and wraps around when all the channels are
233   allocated. It is most useful for making 2 tracks with 2 channels map
234   to stereo and for making 6 tracks with 6 channels map to a 6 channel
235   sound card.
236 \item[Audio~$\rightarrow$~Map 5.1:2] This maps 6 tracks to 2
237   channels. The project should have 2 channels when using this
238   function. Go to \texttt{Settings $\rightarrow$ Format} to set the
239   output channels to 2. This is most useful for down-mixing 5.1 audio
240   to stereo (for more information refer to Configuration, Settings and
241   Preferences section~\ref{sub:audio_out_section}).
242 \end{description}
243
244 \paragraph{Standard audio mappings} Although \CGG{} lets you map any
245 audio track to any speaker, there are standard mappings you should
246 use to ensure the media can be played back elsewhere. Also, most
247 audio encoders require the audio tracks to be mapped to standard
248 speaker numbers or they will not work.
249
250 In the channel position widget, the channels are numbered to
251 correspond to the output tracks they are rendered to. For stereo,
252 the source of channel 1 needs to be the left track and the source of
253 channel 2 needs to be the right track.  For 5.1 surround sound, the
254 sources of the 6 channels need to be in the order of center, front
255 left, front right, back left, back right, low frequency effects. If
256 the right tracks are not mapped to the right speakers, most audio
257 encoders will not encode the right information if they encode
258 anything at all. The low frequency effects track specifically can
259 not store high frequencies in most cases.
260
261
262 \section{Manipulating Tracks}%
263 \label{sec:manipulating_tracks}
264
265 Tracks in \CGG{} either contain audio or video.  There is no special
266 designation for tracks other than the type of media they contain.
267 When you create a new project, it contains three default tracks: one
268 video track and two audio tracks.  You can still add and delete
269 tracks from the menus.  The Tracks menu contains a number of options
270 for dealing with multiple tracks simultaneously.  Each track itself
271 has a popup menu which affects one track.
272
273 Operations in the \textbf{Tracks pulldown} affect only tracks which
274 are armed.
275
276 \begin{description}
277 \item[Move tracks up | Move tracks down] shift all the armed
278   tracks up or down the stack.
279 \item[Delete tracks] deletes the armed tracks.
280 \item[Delete last track] deletes the last track, whether it is
281   armed or not.
282 \item[Concatenate tracks] operation copies all the assets of
283   every disarmed but playable track and concatenates it by pasting
284   those assets at the end of the first set of armed tracks. They are
285   pasted one after the other, keeping the same order they have on the
286   stack. If there are two armed tracks followed by two disarmed
287   tracks, the concatenate operation copies the assets of the two
288   disarmed tracks and pastes them after the assets of the two armed
289   tracks. If there are three disarmed tracks instead, the assets of
290   two tracks are pasted after the assets of the armed tracks and the
291   assets of the third track are pasted at the end of the first armed
292   track. The destination track wraps around until all the disarmed
293   tracks are concatenated. Disarmed tracks that are not playable are
294   not concatenated.
295 \item[Append to project] allows for creating new tracks after
296   any existing tracks.
297 \item[Add subttl] will add a track for subtitles at the top of
298   the other tracks.
299 \end{description}
300
301 The \textbf{Audio} and \textbf{Video pulldowns} each contain an
302 option to add a track of their specific type. In the case of audio,
303 the new track is put on the bottom of the timeline and the output
304 channel of the audio track is incremented by one. In the case of
305 video, the new track is put on the top of the timeline. This way,
306 video has a natural compositing order. New video tracks are overlaid
307 on top of old tracks.
308
309 \subsection{Displaying tracks: Ganged mode}%
310 \label{sub:displaying_tracks_ganged}
311
312 Often users working on media where Audio is the main focus, want all of a media's audio channels, whether stereo or 5:1 channels, to be treated as a single unit. They are more familiar with working with a DAW (Digital Audio Workstation software) and find that it takes extra work and a lot more care to have to individually manage audio tracks rather than have them automatically edited as a ganged group.
313
314 To get this capability, there is a \textit{Gang Tracks} toggle button on the main timeline controls to switch between 3 modes of working with multiple channels so that the tracks are automatically edited as a single unit. Operations affected include edits such as cuts, moving sections, and adding plugins. Group masters are marked by the \textit{Master Track} toggle in the patchbays. A track gang group begins on a master track, and extends to, but not including, the next master track. The 3 \textit{Gang Tracks} modes are:
315
316 \begin{enumerate}
317         \item \textbf{Gang None:} this is the default mode and is the traditional way Cinelerra operates. If you never toggle the "Gang Tracks" button, everything operates normally as it always has. In this mode, the button icon looks like 3 tracks with $\dots$ on the end and all tracks are visible on the timeline. See figure~\ref{fig:gang-track-01}
318 \end{enumerate}
319
320 \begin{figure}[htpb]
321         \centering
322         \includegraphics[width=0.99\linewidth]{gang-track-01.png}
323         \caption{Gang None: only the video track is master. We see all tracks both master and non-master (default)}
324         \label{fig:gang-track-01}
325 \end{figure}
326
327 \begin{enumerate}[start=2]
328         \item \textbf{Gang Channels:} in this mode, all \textit{Master Tracks}
329 are shown. The exception is when there is no
330 Master video, no Master audio or no Master subtitle track, in which case for
331 each the first track of video, audio, and subtitle will be shown.  For users who
332 routinely switch the track order frequently, the patchbay has the \textit{Master Track} icon to set your own preference.
333 Stereo tracks, or 5:1 channels/any number of audio tracks, are drawn as 1 audio track for the purpose of making changes on that single track which are propagated to all of its other channel tracks automatically. This is the DAW-like mode. The \textit{Gang Tracks} button icon looks like 2 tracks and only the first video and first audio tracks will be shown. See figure~\ref{fig:gang-track-02}
334 \end{enumerate}
335
336 \begin{figure}[htpb]
337         \centering
338         \includegraphics[width=0.99\linewidth]{gang-track-02.png}
339         \caption{Gang Channels: only the video track is master. Let's see the master tracks and the first of the non master tracks}
340         \label{fig:gang-track-02}
341 \end{figure}
342
343 \begin{enumerate}[start=3]
344         \item \textbf{Gang Media:} this mode only shows the \textit{Master Tracks} of the media but changes are propagated to the appropriate other related tracks (even if they are not visible). The \textit{Gang Tracks} button icon looks like a single track. See figure~\ref{fig:gang-track-03}
345 \end{enumerate}
346
347 \begin{figure}[htpb]
348         \centering
349         \includegraphics[width=0.99\linewidth]{gang-track-03.png}
350         \caption{Gang Media: only the video track is master. We only see the master tracks}
351         \label{fig:gang-track-03}
352 \end{figure}
353
354 The current \textit{Gang Tracks} mode is saved across sessions and will be saved in your project. Although most likely users will work in the \textit{Gang None} mode, users more familiar with DAW software will tend to use the \textit{Gang Channel}s mode.
355
356 More details ares described next about master tracks. Each patchbay has a \textit{Master Track} button on the extreme right of the patchbay. These mark which tracks of the media are master tracks. The span of tracks between the gang group masters are the gang track group. The master track toggles can be disabled/enabled as the user wishes to create the desired track groups. Normal file loads will mark the first stream of each file loaded as a master, if the media is loaded with insertion strategy of\textit{ Replace current project}, \textit{Replace current project and concatenate tracks} or \textit{Append in new tracks}. Frequently, editing is done on video, audio, or audio/video groups to maintain timeline synchronization. By grouping related tracks, this procedure is much more automatic.
357
358 Previously existing projects created before the addition of ganged tracks, will have ALL tracks marked as master tracks and changing the \textit{Gang Tracks} button mode will have no effect. The user will have to properly designate which track is the master track and disabling the others in order to make use of the toggle modes.
359
360 There are no restrictions on how you use this feature and there may be variations for users not concerned about DAW-like workings that are very useful. Several methodologies are possible, but you have to know what you are doing.
361
362 NOTES:
363 \begin{itemize}
364         \item When in \textit{Gang Channels} or \textit{Gang Media} mode, if the first audio track is not disarmed, but         any of its connected channel tracks are, the disarm of those channels are ignored and all channels are treated as being armed. This is to be consistent with the purpose of using this mode; the purpose being that any edits to the first master track are automatically propagated to all other channels.
365         \item It may be better when using the \textit{Gang Channels} or \textit{Gang Media} mode to make any changes
366         to the first audio channel to be automatically duplicated before reverting to the \textit{Gang None} mode to make other changes. Once you start changing individual channels (that is, audio tracks) so that they are no longer coordinated in their edits/plugins, it may be more difficult to switch back to \textit{Gang Channels} mode and get the desired results since the channels may no longer be lined up.
367         \item Gang modes should not be used with Multi-camera/Mixers because they have very specific
368 operational capabilities which are not compatible with the way that Ganging works.
369 \end{itemize}
370
371 \section{Two Screen Editing}%
372 \label{sec:two_screen_editing}
373
374 This is a fast way to construct a program out of movie files (in
375 other programs is called \textit{three points editing}). The idea
376 consists of viewing a movie file in one window and viewing the
377 program in another window. Subsections of the movie file are defined
378 in the viewer window and transferred to the end of the program in
379 the program window.  Two screen editing can be done simply by using
380 keyboard shortcuts.  To get familiar with which keys to use, move
381 the mouse pointer over the transport panel and a tooltip appears,
382 showing what key is bound to that button.
383
384 To begin a two screen editing session, load your media resources by
385 using the main menu \textbf{File pulldown} and choose \textit{Load
386   files}; make sure the insertion mode is set to \textit{Create new
387   resources only}.  This insertion strategy is to ensure that the
388 timeline stays unchanged while new resources are brought in. Go to
389 the Resources window and select the Media folder. The newly loaded
390 resources will appear. Double click on a resource or drag it from
391 the media side of the window over to the Viewer window.
392
393 Check to make sure there are enough armed tracks on the timeline to
394 put the subsections of source material that you want.  Usually this
395 would be one video track and two audio tracks, but if there are not
396 enough, just create new tracks or arm more tracks.
397
398 Now to start your 2 screen editing, in the viewer window, define a
399 clip from the media file:
400
401 \begin{enumerate}
402 \item Set the starting point with the In pointer button.  You
403   will see a left hand bracket on the timebar.
404 \item Move your cursor to the ending point of the clip you want
405   to use.
406 \item Set the ending point with the Out pointer right hand
407   bracket.
408 \item You will see a colored bar inside the brackets for easier
409   viewing.
410 \item Drag the In/Out point with the mouse to conveniently
411   change their position.
412 \end{enumerate}
413
414 These In/Out points define a clip.  You can now use this in a couple
415 of different ways.
416
417 \paragraph{Splice} The splice icon, or shortcut letter “\texttt{v}”,
418 inserts the selected area in the timeline after the insertion point.
419 After the splice has taken effect, the insertion point moves to the
420 end of the edit ready to be used as the next splice location. This
421 way you can continuously build up the program by splicing.  If an In
422 point or an Out point exists on the timeline the clip is inserted
423 after the In point or after the Out point. If both In and Out points
424 are set on the timeline, the clip is inserted after the In point. If
425 there are edits after your chosen splice location on the timeline,
426 they will be moved to the right.
427
428 \paragraph{Overwrite} The overwrite icon, or shortcut letter
429 “\texttt{b}”, overwrites the region of the timeline after the
430 insertion point with the clip. If an In point or an Out point exists
431 on the timeline the clip is overwritten after the In point or after
432 the Out point. If both In and Out points are set on the timeline,
433 the clip is inserted after the In point. If a region is highlighted
434 or both In and Out points exist they limit the region of the
435 overwriting and the clip may therefore be shortened. Here is a
436 detailed explanation to take advantage of this method.
437
438 To overwrite exactly on a precise region of the timeline:
439
440 \begin{enumerate} [noitemsep]
441 \item Arm only tracks to change.
442 \item Define the destination region on the timeline with [ and
443   ], the In and Out points.
444 \item You can achieve maximum precision by setting the active
445   region in the zoom panel.
446 \item Define the clip you want to use in the viewer with [ and
447   ], the In and Out points.
448 \item Overwrite from Viewer to the timeline.
449 \end{enumerate}
450
451 If the destination region is shorter than the clip defined in the
452 viewer, the portion of the clip longer than the destination region
453 won't be inserted and on the timeline the following edits won't
454 move.  If the destination region is longer than the clip defined in
455 the viewer, the destination region will shrink and on the timeline
456 the following edits will move to the left.
457
458 \paragraph{Clip} The clip icon, or shortcut letter “\texttt{i}”,
459 generates a new clip for the resource window containing the affected
460 region but does not change the timeline.  Every clip has an
461 optional/default title and description.
462
463 \paragraph{Copy} The copy icon, or shortcut letter “\texttt{c}”,
464 copies the selection into the copy buffer.
465
466 \subsection{Use Case – Working with Sequences}
467 \label{sub:use_case_working_sequences}
468
469 \textit{From the Viewer to the Timeline with the sequences imported
470   in a Master Project.}
471
472 A convenient methodology for working on a Master project along with
473 1 or more previously saved Sub projects or \textit{sequences} use
474 case is described here.  A sequence is an edited assembly of audio
475 and video clips generally consisting of a series of videos that
476 relate to the same activity. This use case explains how to work this
477 way and some things you need to be aware of.
478
479 \begin{enumerate}
480 \item First load your Master project, which you worked on and
481   saved earlier as an \texttt{.xml} file, using an Insertion strategy
482   of \textit{Replace current project}.  Generally this Master project
483   consists of media with any of the attributes of clips, autos,
484   possibly keyframes, and effects.  You will see your project on the
485   main timeline and the Media files that are part of this Master
486   project will be displayed in the Resources window in the Media
487   folder.
488 \item Previously you may have also saved a Sub project, which
489   will now be referred to as a Sequence, as an \texttt{.xml} file that
490   may contain any of the same such things: media, clips, autos,
491   keyframes, effects.  Second you will want to load the Sequence using
492   an Insertion strategy of \textit{Create new resources only}.  When
493   you do the load, this Sequence will show as a file in the Resources
494   window in the Clips folder.  The actual media will show in the Media
495   folder.
496 \item Now Drag and Drop the Sub project from the Clips folder to
497   the Viewer.
498 \item Set In and Out Pointers in the Viewer to the region of
499   interest in the Sub project and in the Timeline of the Main window
500   of your Master project, move the cursor position to where you would
501   like to insert this In/Out section.
502 \item Click on the \textit{Splice (v)} button in the Viewer to
503   insert this section into the Master project timeline.  All of the
504   attributes of the selected Sub project section will now be inserted
505   in the main timeline to include the autos, keyframes, effects, and
506   labels.
507 \item Alternatively, if you click on the \textit{Overwrite (b)}
508   button in the Viewer, you can see the Sub project In/Out section in
509   the timeline, but without its autos, effects, keyframes, etc.  If in
510   the timeline there were some autos, effects, and keyframes in that
511   Master project, they will be in effect for the new section.
512 \end{enumerate}
513
514 You can see the advantages of using Splice versus Overwrite to
515 either insert (splice) with all of the attributes of a specific
516 section of your Sequence or to overwrite without the attributes to
517 allow for the smooth operation on the timeline by retaining the
518 timeline’s attributes at that point.
519
520 NOTE: for correct operation of this use case, you should have the
521 same (or more) number of tracks in the Master project as you do in
522 the Sequence.  To avoid having to know how many tracks you need, you
523 can use the Nest feature as described in the Nesting section
524 (\ref{sec:nesting_clips_and_assets}).
525
526
527 \section{Cut and Paste Editing}%
528 \label{sec:cut_paste_editing}
529
530 This is the more traditional method of editing in \CGG{} and
531 therefore is the default.  To enable the cut and paste editing mode
532 on the timeline, select the I-beam toggle on the control bar at the
533 top of the main program window. You can copy edits in the same
534 track, copy from different tracks in the same instance, start a
535 second instance of \CGG{} and copy from one instance to the other or
536 load a media file into the Viewer and copy from there.
537
538 To start editing, load some files onto the timeline.  Select a
539 region of the timeline by click dragging on it and select the cut
540 button to cut it. Move the insertion point to another point in the
541 timeline and select the paste button.  Assuming no In/Out points are
542 defined on the timeline this performs a cut and paste operation.
543
544 Most editing operations are listed in the \textit{Edit} pulldown. Some of
545 them have a button on the program control toolbar as well as a
546 keyboard shortcut.  The keyboard shortcut is in parenthesis here.
547
548 \begin{description}
549 \item [Split | Cut] (x) Delete the selected area and put it in
550   the cut buffer for future pasting.
551 \item[Copy] (c) Copy the selected area and put it in the cut
552   buffer for future pasting.
553 \item[Paste] (v) Paste the material that is in the cut buffer.
554 \item[Clear] (Del) Clear the selected area. If the insertion
555   point is over an edit boundary and the edits on each side of the
556   edit boundary are the same resource, the edits are combined into one
557   edit comprised by the resource. The start of this one edit is the
558   start of the first edit and the end of this one edit is the end of
559   the second edit. This either results in the edit expanding or
560   shrinking.
561 \item[Paste silence] (Shift+Space) Paste blank audio/video for
562   the length of the selected area. Following edits will be pushed to
563   the right.
564 \item[Mute Region] (m) Overwrite blank audio/video on the
565   selected area. Following edits don't move.
566 \item[Trim Selection] Delete everything but the selected region.
567 \item[Select All] (a) Select the whole timeline.
568 \end{description}
569
570 In Cut and Paste editing mode you can \textit{edit labels} as
571 well. By enabling Edit labels in the \textbf{Settings pulldown}, or
572 by disabling the Lock labels from moving button on the Program
573 Control Tool Bar, labels will be cut, copied or pasted along with
574 the selected regions of the armed tracks.
575
576 Using labels and In/Out points are useful in editing audio.  You can
577 set In/Out points for the source region of the source waveform and
578 set labels for the destination region of the destination
579 waveform. Perform a cut, clear the In/Out points, select the region
580 between the labels, and perform a paste.
581
582 \paragraph{In / Out Points} The In and Out bracket placement is
583 explained here to illustrate their usage.  Because of the shape of
584 the markers [ and ] you may assume that they are inclusive -- that
585 everything placed in between would be included in the clip, such as
586 in the case of being transferred to the timeline from the Viewer.
587 In reality, one of the two markers will not include the frame that
588 was visible at the time the marker was affixed. Depending on whether
589 the \textit{Always show next frame} option is used or not, it is the
590 In or Out marker that will not be inclusive.
591
592 To obtain a clip on the timeline exactly as you saw in the Viewer,
593 you must necessarily move the In mark back from the beginning before
594 the first desired frame or move the Out mark forward after the last
595 desired frame, depending on the \textit{Always show next frame}
596 setting.
597
598 Some of the confusion can be attributed to the fact that the Viewer
599 shows frames, while the markers determine spaces, i.e.\ times, that
600 are not visible between frames. You have to think of each frame as
601 being delimited by two spaces -- one preceding and one following.
602 The In mark is always placed before the displayed frame and the Out
603 mark is always placed after the displayed frame, while taking into
604 account in its calculations whether the \textit{Always show next
605   frame }option is used or not. If you just remember that the
606 reference of the markers is in the middle of the icon, you will
607 avoid confusion.
608
609 \paragraph{Overwrite} To perform overwriting within the timeline
610 paste on a selected region (highlighted or between In/Out
611 points). The selected region will be overwritten. If the clip pasted
612 from the clipboard is shorter than the selected region, the selected
613 region will be shrunk. Following edits will move. If the clip pasted
614 from the clipboard is longer than the selected region, the selected
615 region will be overwritten with the first part of the clip and the
616 remaining part of the clip will be written after the
617 overwriting. Following edits will move.
618
619 \paragraph{Tracks $\rightarrow$ Concatenate tracks} This operation
620 copies all the assets of every disarmed but playable track and
621 concatenates it by pasting those assets at the end of the first set
622 of armed tracks. They are pasted one after the other, keeping the
623 same order they have on the stack.
624
625 \paragraph{Split -- blade cut and hard edges:} You can cut the
626 tracks into 2 pieces on the timeline by putting the hairline cursor
627 on the place you want to do a cut and then using the character “x”
628 or the scissors tool (figure~\ref{fig:cut}).
629
630 \begin{wrapfigure}[16]{O}{0.3\linewidth}
631   \vspace{-2ex}
632   \centering
633   \includegraphics[width=0.9\linewidth]{cut.png}
634   \caption{Blade cut}
635   \label{fig:cut}
636 \end{wrapfigure}
637
638 A \textit{cut} uses a non-empty selection region, where the
639 \textit{blade cut} or \textit{split} has no duration in the
640 selection, just a hairline.  As usual the use of cut when a
641 selection is set, deletes/cuts the highlighted area.  In the case
642 where an In point or an Out point exists on the timeline, the clip
643 is split at the location of the In/Out point since it has priority
644 over the cursor location.  A blade cut simply splits the edit into
645 two edits.  In order to have the video and audio aligned, it works
646 best to have \texttt{Settings $\rightarrow$ Align cursor on
647   frames}.  When a blade cut occurs, the edges are created as
648 \textit{hard edges}.  These are edges that cannot be deleted by
649 track optimizations.
650 %
651 \CGG{} has built-in optimization on the timeline.  So that whenever
652 two parts on the timeline are sequential frames, it automatically
653 optimizes by making them into 1 item.  So if you are cutting,
654 dragging, editing, or whatever and somehow frame \# 40 ends up
655 right next to frame \# 41, it optimizes them together.  This
656 optimization affects many areas throughout the program code.  When
657 you do a blade cut/split, all armed tracks will be included in the
658 cut and green-colored triangles will show on the bottom of the
659 track on both the left and the right side of the cut.  This is a
660 \textit{hard edge} marker toggle, as opposed to the soft edge
661 designation for an ordinary edit.  The \textit{hard edge} marker
662 can be toggled off/on if so desired.  In order to not interfere
663 with the usual drag handles, only a few pixels are used for the
664 toggle so you have to be sure you have the cursor right over the
665 hard edge triangle -- when in position, it will be obvious because
666 you can see an arrow pointing to the corner.  Use Shift-left mouse
667 button 1 to toggle off/on the hard edge marker on all tracks
668 simultaneously.
669
670
671 \section{Drag and Drop Editing}%
672 \label{sec:drag_drop_editing}
673
674 To enable the drag and drop editing mode on the timeline, select the
675 arrow toggle on the control bar at the top of the main program
676 window.  Drag and drop editing is a quick and simple way of working
677 in \CGG{}, using mostly only the mouse. The basic idea is to create
678 a bunch of clips, then drag them in order into the timeline, thus
679 building prototype media that you can watch in the compositor. If
680 after watching it, you wish to re-arrange your clips, set effects,
681 add transitions or insert/delete material, just drag and drop them
682 on the timeline.
683
684 To simply get started, perform the following operations which are
685 useful for working in a drag and drop editing session.  First load
686 your media by using the main menu \textit{File} pulldown and choose
687 \textit{Load files}; make sure the insertion mode is set to
688 \textit{Create new resources only}.  This loads the files into the
689 Resources window.
690
691 \begin{enumerate}
692 \item Create some video and audio tracks on the timeline using
693   the \textit{Video} and \textit{Audio} pulldowns.
694 \item Open the Media folder in the Resources window.  Make sure
695   the necessary tracks are armed and drag a media file from the
696   Resources window to the timeline. If the media has video, drag it
697   onto a video track or if just audio, drag it onto an audio
698   track. For a still image, drag it onto a video track.
699 \end{enumerate}
700
701 You can also drag multiple files from the Resources window. When
702 dropped in the timeline they are concatenated. If you have
703 \textit{Display Icons} selected in the Resources window, drawing a
704 box around the files selects contiguous files. If you have
705 \textit{Display Text} selected, Ctrl-clicking on media files selects
706 additional files one at a time; Shift-clicking on media files
707 extends the number of highlighted selections.  In addition to
708 dragging media files, if you create clips and open the clip folder
709 you can drag clips onto the timeline.
710
711 \CGG{} fills out the audio and video tracks below the dragging
712 cursor with data from the file. This affects what tracks you should
713 create initially and which track to drag the media onto. To drag and
714 drop a file on the Program window, you need to create on the
715 timeline the same set of tracks as your media file.
716
717 When you drag your chosen media from the media folder to the
718 timeline, your mouse pointer will drag a thumbnail and, once over
719 the timeline, the outline of a white rectangle, as big as the edit
720 you are going to have appears.  Drag the media to the desired
721 position of an empty track of the timeline and drop it.  If there
722 are other edits on that track, when you move the white outline over
723 an edit, you will see a bow tie symbol $\bowtie$ appearing at edit
724 boundaries. If you drop the media there, the new edit will start
725 from the edit boundary indicated by the center of the bow tie
726 $\bowtie$.
727
728 Since the mouse pointer is in the middle of the white outline, when
729 this rectangle is bigger than the visible part of the timeline, it
730 is quite cumbersome to precisely insert it for long
731 media. Lengthening the duration visible in the timeline by changing
732 the sample zoom in the zoom panel will reduce the size of the white
733 rectangle, making a precise insertion possible.
734
735 When you drag and drop edits within the timeline:
736
737 \begin{itemize}
738 \item If you drop an edit when bow ties $\bowtie$ are shown,
739   that edit will be cut and pasted starting at the edit boundary
740   indicated by the center of the bow tie $\bowtie$.  Following edits
741   on the same track will move.
742 \item If you drop an edit when there are no bow ties $\bowtie$
743   shown, the original edit will be muted and pasted where you dropped
744   it. No edits will move. A silence will appear in place of the
745   original edit.
746 \item If you have more armed tracks on the timeline than in the
747   asset you are dragging, only the following edits of the tracks
748   affected by the drag and drop operation will move to the right. This
749   will cause loss of synchronization. To restore it, disarm the tracks
750   affected by the drag and drop operation, highlight the just dropped
751   edit and paste silence over it using the \textit{Edit} pulldown,
752   \textit{Paste Silence}.
753 \end{itemize}
754
755 Labels sometimes work differently in Drag and Drop editing mode in
756 that you can't drag and drop them. They might be locked to the
757 timebar, even with the Edit labels option enabled.  Although with
758 the Edit labels option enabled, if a selected area of a resource is
759 spliced from the Viewer to the timeline in a position before labels,
760 these labels will be pushed to the right for the length of the
761 selected area.
762
763 In/Out points can be used to perform Cut and Paste operations in
764 Drag and Drop mode as well as in Cut and Paste mode.  Use the \textit{Edit}
765 pulldown to view the list and their keyboard shortcuts.
766
767
768 \subsection{Copy/Paste Behavior}%
769 \label{sub:copy_paste_behavior}
770
771 There are many options for moving, copying, pasting, inserting, and
772 deleting selected \textit{edits}, more commonly referred to by the
773 user as \textit{clips}, when in the Drag and Drop (arrow) editing
774 mode.  This makes it easier to avoid constantly having to disarm/arm
775 tracks.  To create a selection move the cursor over the clip and
776 just click the left mouse button; remove a selection by left mouse
777 button click again.  This will mark your selection with a colored
778 border which contains some red.  The easiest way to initially use
779 the various modes is to click on the middle mouse button when your
780 cursor is over a track and a popup displays the modes and shortcuts.
781 However, for those users who prefer the addition of the Ctrl key to
782 add multiple selections as is commonly done for listbox operations,
783 there is a preference in \texttt{Settings $\rightarrow$ Preferences
784   $\rightarrow$ Appearance} tab, called \textit{Clears before
785   toggle} that changes the behavior.
786
787 When an edit is marked as selected, it can be cut/copied into the
788 paste clip buffer.  The constructed clip buffer will begin with the
789 leftmost edit and end with the rightmost edit.  The edits may
790 contain media, or be silence, or skipped if they are not selected.
791 The clip tracks are copied from the first track with an active edit
792 selection to the last track with an active edit selection.  A clip
793 track can be completely empty if no selection was made on the track.
794 The word \textit{packed} means that the silent edits and empty
795 tracks are not included in the copy to the clip buffer, and all of
796 the elements are packed together, no gaps.  Packing a clip buffer
797 makes it easier to move \textit{blobs} of data around.  Once the
798 edits have moved and have a relative relationship applied, an
799 unpacked clip buffer allows the media to be copied with the relative
800 positions of the edits preserved.
801
802 The \textit{edits} popup is activated on a track and a red and
803 yellow colored reticle appears to temporarily mark the location when
804 you click on the middle mouse button.  An expanded explanation is
805 provided below.
806
807 \renewcommand{\arraystretch}{1.15}
808 \begin{center}
809   \begin{longtable}{p{0.3\textwidth-2\tabcolsep} p{0.7\textwidth-2\tabcolsep}}
810     \toprule
811     \textbf{Key} & \textbf{Operations}\\
812     \midrule
813     Drag & Hold down the Ctrl key while dragging to move a single
814            edit elsewhere.\\
815     Left mouse button & Selects and highlights the edit under the
816                         cursor with a red selection box. Left mouse
817                         button also will toggle that clip selection
818                         off if it is on.\\
819     \bottomrule
820   \end{longtable}
821 \end{center}
822
823 \begin{center}
824   \begin{longtable}{p{0.2\textwidth-2\tabcolsep}
825     p{0.2\textwidth-2\tabcolsep} p{0.6\textwidth-2\tabcolsep}
826     }
827     \toprule
828     \textbf{Popup Label} & \textbf{Key} & \textbf{Operation}\\ \midrule
829     \endhead
830     Clear Select & Ctrl-Shift-A & Deselect all selected edits --
831                                   ones that have the red lines
832                                   around them.\\
833                                   
834     Select Edits & Ctrl-Alt-' & Select all edits within a highlighted area of the timeline \\
835     
836     Deselect Edits & & Deselect all edits within a highlighted area of the timeline \\
837
838     Copy & Ctrl-c & Copy the selected edits into the copy buffer.\\
839
840     Cut & Ctrl-x & Delete the selected edits after copying them into
841                    the buffer. The edits\\
842
843     Mute & Ctrl-m & Delete the selected edits after copying them
844                     into the buffer. The space previously occupied
845                     by the edits will be replaced with silence.\\
846
847     Copy Pack & Ctrl-Shift-C & Copy the selected edits into the
848                                buffer and remove any silent
849                                sections.\\
850
851     Cut Pack & Ctrl-z & Delete the selected edits after copying them
852                         into the buffer. The edits after the
853                         election will move left to occupy the
854                         vacated space.  The edits in the copy buffer
855                         will be packed together within each track.\\
856
857     Mute Pack & Ctrl-Shift-M & Delete the selected edits after
858                                copying them into the buffer.  The
859                                deleted edits will be replaced with
860                                silence.  The edits in the copy
861                                buffer will be packed together within
862                                each track.\\
863
864     Paste  & Ctrl-v & Paste contents of the copy buffer at the
865                       insertion point marked by the red \& yellow
866                       reticle of the popup menu or the position of
867                       the hairline cursor. This is a splice
868                       operation which creates space for the edits.\\
869
870     Overwrite & Ctrl-b & Paste contents of the copy buffer at the
871                          insertion point marked by the red \& yellow
872                          reticle of the popup menu or the position
873                          of the hairline cursor. This destroys the
874                          current edits in that space.\\
875
876     Overwrite & Ctrl-Shift-P & Pastes plugins that are in the Copy
877                                buffer to current location but no
878                                clip. Plugins.\\
879     \bottomrule
880   \end{longtable}
881 \end{center}
882 \renewcommand{\arraystretch}{1}
883
884 The copy/paste behavior respects the armed/disarmed tracks
885 state.  A paste of audio on a video track will fail and vice versa.
886 In addition if you attempt to paste edits consisting of more tracks
887 than what is available at that location it will not allowed.
888
889 Attaching transitions to multiple selected edits via the \textit{Video} or
890 \textit{Audio} pulldowns is also available.  The new transitions are attached
891 at the start of the edits, and will replace any existing attached
892 transitions.  As a side note, when in drag and drop mode the end
893 transition does not drag.
894
895 \subsection{Snapping while Cutting and Dragging}%
896 \label{syb:snapping_cutting_dragging}
897
898 \paragraph{Cutting/Snapping edits} cuts from an edit handle to the
899 insert point.  There are Edit Panel buttons which normally are used
900 to move to the previous or next edit handle/label.
901
902 \begin{wrapfigure}[3]{r}{0.2\linewidth}
903         \vspace{-2ex}
904         \centering
905         \includegraphics[width=0.7\linewidth]{snap.png}
906 \end{wrapfigure}
907
908 They look like tags and the letter E on the menu bar and are
909 oriented forward/backward.  These same buttons can be used to
910 \textit{cut} from the insert pointer to the previous or next
911 edit/label when the ctrl+alt keys are both pressed when the buttons
912 are used.  They \textit{snap} off the media instead of doing the
913 standard re-positioning.  This is useful to minimize the number of
914 operations necessary to cut between edits/labels.
915
916 Instead of using the edit panel buttons, you can more easily use the
917 following keyboard shortcuts to perform the same functions:
918
919 \begin{center}
920         \begin{tabular}{lll}
921                 \toprule
922                 snap\_right\_edit & ctrl+alt+ '.' &\\
923                 snap\_left\_edit & ctrl+alt+ ',' &\\
924                 snap\_right\_label & ctrl+alt +shift '.' & shift+period is the > sign on US keyboards\\
925                 snap\_left\_label &  ctrl+alt +shift',' & shift+comma is the < sign on US keyboards\\
926                 \bottomrule
927         \end{tabular}
928 \end{center}
929
930 \paragraph{Drag Snapping} if you hold down the Ctrl + Alt keys while
931 dragging using the mouse, once the clip gets near to an edit, a
932 label, an in/out pointer or the start/end of the timeline, the
933 dragged clip will snap next to that marker.  The 2 will now be
934 exactly aligned with no gap and no overlap.  As you drag the clip
935 close to one of the markers, when they are within a short distance
936 they start to stick and stay that way until you move further away
937 from that distance.  Also, the line will turn color from green to
938 yellow while in the sticky phase.  In addition, this works for a
939 plugin while dragging so that it will be the same length as the edit.
940
941 \subsection{Copy/Paste clips/medias across Multiple Instances}%
942 \label{sub:copy_paste_multiple_instances}
943
944 It is easy to copy/paste clips/media within a single instance of
945 \CGG{} or across multiple instances.  The reason this works is
946 because there are hidden X cut buffers and these are used to
947 transmit EDL from 1 instance to another.
948
949 Steps to copy from a source timeline and paste to a target timeline:
950
951 \begin{enumerate}
952         \item highlight a selection on the timeline in 1 instance of \CGG{}
953         \item use the Copy icon (shortcut c) on the main menu bar to copy
954         into a buffer
955         \item move the pointer to another instance of \CGG{} and set an
956         insertion point in its timeline
957         \item use the Paste icon (shortcut v) to paste the clip to that
958         other instance selection target
959 \end{enumerate}
960
961 \subsection{Grouping edits}%
962 \label{sub:grouping_edits}
963
964 \CGG{} recognizes as a group, the edits of different armed tracks
965 that have aligned beginnings, regardless of whether they have the
966 same source or aligned ends.  You can drag these edits around on the
967 timeline to construct your movie by rearranging scenes. If more than
968 one track is armed, \CGG{} will drag any edits which start on the
969 same positions the edit the mouse pointer is currently over. Another
970 method of Grouping of edits is performed as follows:
971
972 \begin{enumerate}
973 \item Select each of the clips you would like to be part of a
974   group.
975 \item Use the desired Copy mode as described above to get into
976   the buffer.
977 \item Go to the Resources window Clip folder and right click on
978   an empty spot.
979 \item Choose the Paste Clip option.  Now you have a named clip
980   of the current selection.
981 \end{enumerate} A more traditional Grouping of edits which make a
982 Permanent Group works as described next.  A temporary group is just
983 a set of selected clips and works the same as a single selection.
984 \begin{enumerate}
985 \item Create a group:
986   \begin{itemize}[noitemsep]
987   \item Select multiple clips/edits with left mouse button
988     over the clip;
989   \item Hold down shift and left mouse click over any of the
990     selected clips to create a group;
991   \item A Group Id and color are assigned to this group making
992     it easy to distinguish.
993   \end{itemize}
994 \item Move a group:
995   \begin{itemize}[noitemsep]
996   \item Move your cursor over any of the clips within the
997     group; click to select the clip group.
998   \item Click and Hold down the left mouse button to drag.
999   \end{itemize}
1000 \item Dissolve a permanent group:\\
1001   To ungroup select any of the group edits/clips and shift left
1002   mouse click to ungroup (same as creating).  The edits will be
1003   ungrouped, and the current selection will be replaced with the
1004   ungrouped clips.
1005 \end{enumerate}
1006
1007 The color of the created groups are not muted and are assigned by
1008 Group Id going sequentially through the number of 1 to 64.
1009 Therefore if you dissolve a group and make it again, it will have a
1010 different Group Id and a different color.
1011
1012 \subsection{Dragging Groups}%
1013 \label{sub:dragging_groups}
1014
1015 Dragging while in \textit{Drop and Drag editing mode} (arrow mode)
1016 is really easy.  Just select the clip or clips you want to drag
1017 using the left mouse button, then put your cursor over one of them
1018 and drag while holding down the left mouse button.  Keyframes,
1019 autos, labels, and plugins will also be dragged.  Dragging honors
1020 armed/disarmed tracks.  When you drag there will be some possible
1021 colors as defined; depends on how the edges of edits and groups
1022 interact:
1023
1024 \begin{itemize}
1025 \item Green color means OK to drop in that position as it will
1026   fit.
1027 \item Yellow color means you can drop here and when you do it
1028   will be exactly next to that existing edit.
1029 \item Blue color means it overlaps something and this includes
1030   overlapping itself.
1031 \item Red color means can not drop here because it will not fit
1032   in the space.
1033 \item Orange color means the track types do not match so it can
1034   not be dropped here.
1035 \end{itemize}
1036
1037 Remember: With the \texttt{Shift} key on, it will always
1038 \textit{overwrite}. Without the \texttt{Shift} key enabled, it
1039 always \textit{inserts} only.
1040
1041 The original (older) method of dragging while in Arrow mode, lets
1042 you just left mouse click on a single clip or aligned clips and just
1043 drag.  This older method of dragging does not move any of its
1044 effects with it at this time.  There will only be a white outline
1045 while dragging and it will let you drop only if it fits.  You can
1046 also perform some dragging and grouping while in the \textit{Cut and
1047   Paste editing mode} (ibeam mode) by taking advantage of the Ctrl
1048 button in conjunction with the left mouse button.
1049
1050 \begin{itemize}
1051 \item Double click selects a column so you can move, for
1052   example, the audio and video together by holding down the Ctrl key
1053   and dragging.
1054 \item A single clip can be dragged without any of its aligned
1055   clips, by holding down and Ctrl key and drag.
1056 \end{itemize}
1057
1058 This last section on Dragging, outlines the difference
1059 between \textit{column selection} and \textit{marking selection}.
1060 Column selection is available to make it easy to still be able to do
1061 some dragging in I-beam mode whereas Marking selection makes it easy
1062 to drag clips together that are not columnated.
1063
1064
1065 \subsection{Selection Methods}%
1066 \label{sub:selection_method}
1067
1068 Concerning \textit{Selection} methods, the following information is
1069 partially pertinent to all editing, but is most important to keep in
1070 mind when using Drag and Drop Editing.
1071
1072 Originally, there was the column oriented timeline drag selection
1073 which can be seen in 1 of 3 ways:
1074
1075 \begin{enumerate}
1076 \item a highlighted vertical column
1077 \item the colored line region between the [~in and out~] marker
1078   labels
1079 \item a single flashing line
1080 \end{enumerate}
1081
1082 The selection priority works like this. When the highlighted
1083 vertical drag column is in use (1), it has the highest precedence
1084 and is used as the selection.  When the column is a single line (2),
1085 then the fall back selection is the [~in/out~] marker region, if
1086 they are set.  When they are not set, and the cursor is flashing,
1087 then the selection start=end and the selection is empty, but it does
1088 have a position on the timeline which can be used for editing.  This
1089 is input for the vertical style cut/paste drag/drop editing.
1090
1091 More recently, in addition to the column oriented timeline drag
1092 selection, there is now \textit{group} capabilities which have
1093 various \textit{edit} selections.  These are created in the Drag and
1094 Drop editing mode by clicking edits to toggle
1095 select/deselection.  These groups are input to a different (more
1096 modern) set of cut, paste and overwrite drag/drop editing.  You
1097 can see this set of operations when you click on an edit with the
1098 middle mouse button, and are also available using the shortcuts
1099 shown. They are more like text editor commands to include
1100 \texttt{ctrl+x=cut}, \texttt{ctrl+c=copy}, \texttt{ctrl+v=paste},
1101 and so on \dots The keyboard Delete key is not hooked to these
1102 operations, and is hooked to the original editing methods.
1103
1104 In this \textit{group} mode, if there are In/Out markers set, they
1105 enter the selection priority queue between the column selection and
1106 the cursor only. You can see the In/Out markers selected region
1107 colored line across the timebar (slightly underneath where the time,
1108 samples or frames show ) on the main timeline extending between the
1109 [ and ].  This means that when the highlighted cursor selection is
1110 empty, the In/Out selection will be used.
1111
1112 Summarizing: to select multiple edits/clips on the timeline you can simply use LMB on each edit. Or, if in \texttt{Settings $\rightarrow$ Preferences $\rightarrow$ appearence tab $\rightarrow$ Flags} we have enabled \textit{Clears before toggle}, use CTRL + LMB on each edit.
1113
1114 There is also a faster way:
1115
1116 \begin{enumerate}
1117         \item Arm the tracks you want to be used.
1118         \item Highlight the area as usually you do with \textit{I-beam} mode (or use \textit{In/Out Points}; or position \textit{Insert Point} over the stack of edits). If you miss an edit that you want included, the same method can be used to add it. It is an additive operation. And, it will include the partial edits in the selected area, thus making it easy to disinclude ones you do not want.
1119         It will include silence also but you can remove that or any other edit with CTRL + LMB.
1120         \item Press MMB on a clip inside the highlight area and the PopUp menu is shown with the \textit{Select edits} option on the top.
1121         \item Choose the \textit{Select or Deselect edits} option and the clips inside the highlight area will be selected or deselected.
1122 \end{enumerate}
1123
1124 And there is a Drag mouse way (this requires that the cursor be on the first
1125 clip and from there you start the drag):
1126 \begin{enumerate}
1127         \item To Drag Select edits, hold down Alt+Left Mouse Button (LMB) and drag over the selection area. Releasing the mouse results in selecting. 
1128         \item To Drag Deselect edits. hold down Alt+Ctrl+LMB and drag over the area to be desected.  Releasing the mouse results in deselecting.
1129 \end{enumerate}
1130
1131 If using certain operating systems (for example Ubuntu and Arch) that might field the Alt key before it gets to \CGG{}, you can use the following for both Select and Deselect instead:
1132 \begin{enumerate}
1133         \item Press and hold down Ctrl+Alt+LMB on an edit
1134         \item Drag on the edits you want to select
1135         \item Release the Ctrl key
1136         \item Release the LMB
1137         \item Release the Alt key
1138 \end{enumerate}
1139
1140 \section{Inter-View Mode\;/\;Identifying Source Targets}%
1141 \label{sec:inter-view_identifying_source_target}
1142
1143 Inter-View mode provides a mapping of a particular media file to its
1144 timeline usages. It is somewhat similar to Two Screen Editing in
1145 that you make use of the Viewer. It makes it possible to precisely
1146 trace and indicate in the media the origin of a particular segment
1147 of the timeline and visually indicate the use and distribution that
1148 the timeline makes of a particular media.  A good example usage
1149 would be in the case of a 30 minute interview where you use a few
1150 short pieces to make a shorter 10 minute section, find out that you
1151 have made the timeline 12 minutes instead and need to cut out
1152 another 2 minutes. This feature provides the following capabilities:
1153
1154 \begin{itemize}
1155 \item You can see on the timeline all of the places where a
1156   particular piece of media was used.
1157 \item You can see which parts of that particular media are
1158   already used so you do not reuse that same piece again.
1159 \end{itemize} Figure~\ref{fig:inter-view01} shows an example of the
1160 Inter-View mode mapping preview mini-window.
1161 \begin{figure}[ht]
1162   \includegraphics[width=0.8\linewidth]{inter-view01.png}
1163   \caption{Inter-View mode: white bar$\rightarrow$source; red
1164     bar$\rightarrow$timeline}
1165   \label{fig:inter-view01}
1166 \end{figure}
1167
1168 Explanation of how to use Inter-View mode will be described here
1169 next.
1170
1171 \begin{itemize}
1172 \item Do your editing as usual on the timeline until you are
1173   ready to see what is used or unused.
1174 \item Make sure you are in any of the Preview modes in the
1175   Resources window; you enable the mode using the pulldown to the left
1176   of the word \textit{Search}.  The option looks like this \quad
1177   \includegraphics[height=\baselineskip]{fullplay.png}.
1178 \item Middle mouse click on a thumbnail in the Resources window and
1179   a popup occurs of that media with a white colored bar at the top
1180   and a red colored bar at the bottom with black sections.
1181 \end{itemize}
1182
1183 The red/white bars represent the presence and the black sections
1184 represent the absence of where that media is used on the timeline.
1185 To get to a bigger representation, use the “\texttt{f}” key for a
1186 full screen.  Now you can operate the following buttons to display
1187 what you need to see and to move around.  It is important to note
1188 that \textit{locked tracks} will not be represented.  This makes it
1189 easy to ignore the audio track segments if you want so there is less
1190 confusion in the display.
1191
1192 \begin{itemize}
1193 \item Clicking on the top white or black spaces in the top time
1194   bar loads the Viewer with the source media, and sets the In/Out [
1195   and ] pointers to be the selection of that edit.
1196 \item Click on a location in the bottom red or black bar, and
1197   the main cursor and composer will re-position to the corresponding
1198   location on the session timeline.
1199 \item Dragging on the red/black bar will correspondingly update
1200   the position in the timeline and composer.
1201 \item Ctrl-click on the bottom bar and the timeline and composer
1202   are re-positioned to the beginning of that edit.
1203 \item Shift-click on the bottom bar and a \textit{selection} is
1204   made of that section in the timeline and the composer is updated
1205   with that start position.
1206 \end{itemize}
1207
1208 %\pagebreak
1209 Figure~\ref{fig:inter-view02} displays Inter-View window and its
1210 relation to the timeline, viewer, and compositor.
1211 \begin{figure}[ht]
1212   \centering
1213   \includegraphics[width=1.0\linewidth]{inter-view02.png}
1214   \caption{Inter-View mode and the timeline}
1215   \label{fig:inter-view02}
1216 \end{figure}
1217
1218 The Inter-View mode works for Media, Proxy, and User Bins.  When the
1219 preview window has only black bars on the top and bottom, it means
1220 that this particular media is not loaded in the timeline.  So when
1221 you are in Proxy, meaning that the Proxy files are loaded on the
1222 timeline, there will be only black bars for the corresponding Media
1223 file UNLESS there is an audio track associated with the video.
1224 Because audio tracks are not proxied, they will show for Media but
1225 not for Proxy.
1226
1227 \section{Edit Tools}%
1228 \label{sec:edit-tools}
1229
1230 \subsection{Edit Length}%
1231 \label{sub:edit-lenght}
1232
1233 To set the length of an edit in the timeline, select the region
1234 which contains the edit to be modified. Now select the menu bar
1235 \texttt{Edit $\rightarrow$ Edit Length}\dots menu item to activate
1236 the \textit{edit length} popup (figure~\ref{fig:lenght}).  The
1237 duration of the edit can be reset by entering the desired edit
1238 length in seconds.  Pressing OK will change all of the selected
1239 edits (in armed tracks) to the specified length.
1240
1241 \begin{figure}[htpb]
1242     \centering
1243     \includegraphics[width=0.5\linewidth]{lenght.png}
1244     \caption{Edit Length window}
1245     \label{fig:lenght}
1246 \end{figure}
1247
1248 \subsection{Align Edits}%
1249 \label{sub:align_edits}
1250
1251 When loading media, a common problem is that the various audio/video
1252 tracks do not always have exactly the same lengths. For example, you
1253 might load audio/video recordings from your camera and be dismayed
1254 to see that the audio for each segment is a half second longer than
1255 the video. If you load a large set of media clips by concatenation,
1256 the audio and video will be more skewed as more media is
1257 loaded. Align Edits makes it possible to adjust the edits so the
1258 audio and/or video align by adjusting
1259 the edits so that the track lengths are consistent. To use this
1260 feature, load all of the desired media and select a region which
1261 contains all of the edits to be aligned in the timeline. Now select
1262 the menu bar \texttt{Edit $\rightarrow$ Align Edits} menu item to
1263 operate the change. The topmost armed track is used as a template
1264 reference, and the rest of the tracks are either cut or padded to
1265 align the edit boundaries.  Besides aligning audio with the video,
1266 you can also align video with the audio if the first armed track is
1267 audio. The code performs the following algorithm:
1268
1269 \begin{itemize}
1270 \item Use the first armed track as the master track (it must
1271   contain data).
1272 \item Collect the \textit{edit project start times} on the
1273   selected master track. Only edits that are 100\% inside the selected
1274   area will be used.
1275 \item Set all other tracks to match the \textit{edit times} of
1276   the template track, either by putting in silence or cutting the
1277   region to align the edits on the \textit{edit times} of the master
1278   track.
1279 \end{itemize}
1280
1281 The start time sequence of media and silence edits
1282 along the master track are collected as the target alignment
1283 boundaries. All armed tracks after the master track are modified so
1284 that if the next edit edge is too soon, it adds silence; if it is
1285 too late, edits are shortened or deleted past the point of the next
1286 target alignment boundary time.  Align Edits works best if there are
1287 an equal number of Video and Audio sections.  Also, it is better to
1288 use cuts instead of adding silence -- if there are silence edits
1289 together, the algorithm will combine the silence edits into a single
1290 edit and results may not be as desired.
1291
1292 The first two screenshots in figure~\ref{fig:align} show the Before,
1293 the Highlighted Edits to be manipulated, and the After results for
1294 the Align Edits. The third screenshot \textit{adds silence} in the
1295 second section as noted in red letters.
1296
1297 \begin{figure}[htpb] \centering
1298   \includegraphics[width=1.0\linewidth]{align.png}
1299   \caption{Align edits}
1300   \label{fig:align}
1301 \end{figure}
1302
1303
1304 \subsection{Reverse Edits}%
1305 \label{sub:reverse_edits}
1306
1307 The Reverse Edits can be useful to change the order of 2 edits in
1308 the case where you would like to put a \textit{teaser} section that
1309 occurred in the middle of a movie at the beginning instead, that is,
1310 reversed positions.  To operate, highlight completely the edit areas
1311 you would like reversed and then use the pulldown \texttt{Edit
1312   $\rightarrow$ Reverse Edits}.
1313
1314 Figure~\ref{fig:reverse01} shows the selected / highlighted area to
1315 which Edits will be applied.  Note the first edit is 0002, followed
1316 by 0003, 0004, and 0005 in that order.
1317
1318 \begin{figure}[htpb]
1319   \centering
1320   \includegraphics[width=0.9\linewidth]{reverse01.png}
1321   \caption{Selected area for Reverse Edits}
1322   \label{fig:reverse01}
1323 \end{figure}
1324
1325 Figure~\ref{fig:reverse02} shows the results of executing
1326 \textit{Reverse Edits}.  Now you will see the reversed order of
1327 0005, 0004, 0003, and last 0002.
1328
1329 \begin{figure}[htpb]
1330   \centering
1331   \includegraphics[width=0.9\linewidth]{reverse02.png}
1332   \caption{Results of the Reverse Edits}
1333   \label{fig:reverse02}
1334 \end{figure}
1335
1336
1337 \subsection{Shuffle Edits}%
1338 \label{sub:shuffle_edits}
1339
1340 The file pulldown \texttt{Edit $\rightarrow$ Shuffle Edits} will
1341 randomly exchange the location of the edits.  This feature can be
1342 used to change the order of the music like you would do from your
1343 MP4 player where you have a playlist of your favorite music.  Or
1344 perhaps you are creating an advertisement background, you can
1345 randomly change it, thus the viewer sees a different order of scenes
1346 each time shown.
1347
1348 Figure~\ref{fig:shuffle} illustrating Shuffle Edits of the
1349 highlighted area of the first screenshot on the page.  Note the
1350 permutation of the fragments resulting in 0002 now being first, then
1351 0004, 0003, and 0005 last.
1352
1353 \begin{figure}[htpb]
1354   \centering
1355   \includegraphics[width=0.9\linewidth]{shuffle.png}
1356   \caption{Shuffle edits: the edits are permutated}
1357   \label{fig:shuffle}
1358 \end{figure}
1359
1360 \section{Multi-Session}%
1361 \label{sec:multi_session}
1362
1363 You can run as many sessions of \CGG{} as your computer resources allow.  However, if you are using the same \texttt{\$HOME/.bcast5}, changes you make for one may impact the others. You can always create and rename a new \texttt{.bcast5} from:\\
1364 \texttt{Settings $\rightarrow$ Preferences $\rightarrow$ Interface $\rightarrow$ Index files:} and press \textit{Index files go here}
1365
1366 \section{Multi-Viewer Window Support}%
1367 \label{sec:multi_viewer_window_support}
1368
1369 You can create as many Viewer windows as you want in \CGG{}.  These are handy for users who are adept at working with a lot of different clips simultaneously.  By bringing up multiple Viewer windows, each clip can be edited in its own area, making it easy to see all of the separate pieces.  After you have loaded some media files, to start another Viewer window, right click on one of the pieces of media in the Resources window.  This brings up a menu of several options, one of which is \textit{view in new window}.  Choose this option and that media will come up in a new Viewer window for you to work (figure~\ref{fig:multi-view01}).
1370
1371 \begin{figure}[htpb]
1372         \centering
1373         \includegraphics[width=1.0\linewidth]{multi-view01.png}
1374         \caption{Shown here are 3 Viewer windows and the \textit{View in new window} popup}
1375         \label{fig:multi-view01}
1376 \end{figure}
1377
1378 \section[ShuttlePROv2 and ShuttleXpress Jog Wheels for Editing]{ShuttlePROv2 and ShuttleXpress Jog Wheels for Editing\protect\footnote{programmatic specifications from Eric Messick}}%
1379 \label{sec:shuttle_jog_wheels_editing}
1380
1381 The ShuttlePROv2 and ShuttleXpress are affordable jog wheels which
1382 can be useful for working with Cin, especially if you do a lot of
1383 playing forward/backward, fast/slow/normal, and single frames
1384 (figure~\ref{fig:shuttle}).
1385 %
1386 Directions for using the ShuttlePROv2 and the ShuttleXpress with
1387 \CGG{} are described next. These devices work by sending keystrokes
1388 used in Cin, corresponding to the shuttle action, to the keyboard
1389 buffer. The shuttle has been fully integrated into the \CGG{} code
1390 so that after the one initial setup, no further intervention is
1391 required.  The multi-speed outer wheel works the same and has the
1392 same number of S positions on both shuttles but the shuttle Xpress
1393 has only 5 keys.  Since the majority of user operations will most
1394 likely be with the use of the 2 wheels, the slightly smaller Xpress
1395 could be a better choice with its 5 easy to reach keys.  The Pro is
1396 approximately $4\times7$\,inches whereas the Xpress is about
1397 $4\times4$\,inches.
1398
1399 \begin{figure}[htpb]
1400   \centering
1401   \includegraphics[width=0.9\linewidth]{shuttle.png}
1402   \caption{ShuttlePROv2 and ShuttleXpress}
1403   \label{fig:shuttle}
1404 \end{figure}
1405
1406 The vendor supplied \textit{string} device names for the shuttles
1407 are currently:
1408
1409 \texttt{/dev/input/by-id/usb-Contour\_Design\_ShuttlePRO\_v2-event-if00}\\
1410 \texttt{/dev/input/by-id/usb-Contour\_Design\_ShuttleXpress-event-if00}\\
1411 \texttt{/dev/input/by-id/usb-Contour\_Design\_ShuttlePro-event-if00}
1412
1413 Only 1 necessary initial setup is required due to permission
1414 settings for non-root usage. As root, just copy a file that provides
1415 the necessary permissions to use the shuttle, then reboot, Example
1416 copy:
1417
1418 \begin{lstlisting}[style=sh]
1419 sudo cp {cindat_path}/doc/99-ShuttlePRO.rules /etc/udev/rules.d/
1420 \end{lstlisting}
1421
1422 then the next time after you reboot, the permissions should be
1423 correct. This file only needs to contain one of the following lines
1424 depending on which shuttle version you have/use, but all will be in
1425 the file.
1426
1427 \begin{lstlisting}[style=sh]
1428 # for  newer PRO model
1429 ATTRS{name}=="Contour Design ShuttlePro" MODE="0644"
1430 # for older PRO model
1431 ATTRS{name}=="Contour Design ShuttlePRO v2" MODE="0644"
1432 # for the Xpress model
1433 ATTRS{name}=="Contour Design ShuttleXpress" MODE="0644"
1434 SUBSYSTEMS=="usb", ATTRS{idVendor}=="0b33", ATTRS{idProduct}=="0020", MODE="0666"
1435 SUBSYSTEMS=="usb", ATTRS{idVendor}=="0b33", ATTRS{idProduct}=="0030", MODE="0666"
1436 \end{lstlisting}
1437
1438 If you swap your shuttle, for example upgrade from an Xpress to a
1439 PROv2, just stop Cin, unplug the original shuttle, plug in the
1440 replacement shuttle, and restart Cin.  If you start the \CGG{}
1441 program and the shuttle does not function as before, stop \CGG{} and
1442 then simply unplug it and plug it in again.  There are a couple of
1443 reasons why it may stop functioning.  One is because \CGG{} was not
1444 stopped with the usual Quit command and the shuttle was improperly
1445 shut down when there was a crash.  The other possibility is that a
1446 static discharge occurred in the area.
1447
1448 A default shuttlerc file is automatically used when a shuttle device
1449 is plugged in when Cin is started. This file sets up the key
1450 bindings for \CGG{} to use. You can override any default settings by
1451 having a local file in your \texttt{\$HOME} directory, named
1452 \texttt{.shuttlerc} to reflect your personal preferences.
1453
1454
1455 \subsection{How to Modify the Default Key Settings}%
1456 \label{sub:modify_default_key_settings}
1457
1458 Detailed information on how to modify your local \texttt{.shuttlerc}
1459 file is described next, but if you need help you can request more
1460 information in the forum at {\small
1461   \url{https://cinelerra-gg.org}}. In the \texttt{shuttlerc} file, a
1462 \# always represents a comment and blank lines are ignored.  The
1463 first thing you must do is copy the system supplied
1464 \texttt{shuttlerc} file to your \texttt{\$HOME} directory and rename
1465 it as \texttt{.shuttlerc} (with a period).
1466
1467 The \texttt{shuttlerc} file has sections that in the case of \CGG{},
1468 represent different windows allowing you to set the keys, K1-K15 for
1469 the Pro and K5-K9 for the Xpress, the shuttle wheel positions of
1470 S0/S1/S-1 for stop, S2 through S7 for wheeling to the right, and S-7
1471 through S-2 for wheeling to the left for reverse.  Then there is JR
1472 to jog right (clockwise) and JL to jog left (counter-clockwise) for
1473 the inner smaller wheel for single frame movement.  See the key
1474 arrangement on a later page for location of the keys for each of the
1475 two different shuttles.
1476
1477 The sections are surrounded by brackets for windows such as \CGG{}
1478 (the main window), Viewer, Composer, Resources, Load, and Default.
1479 If you want the keys to be defined the same in every window, you can
1480 bracket each window on lines one right after the other and then just
1481 define one set of keys.  The other lines will have the key
1482 name/shuttle position followed by its assigned value.  The values
1483 you use for the keys are usually shortcuts and have to be
1484 operationally defined within \CGG{}. For example, the shortcut “f”
1485 to go fullscreen is defined so can be used; however the shortcut “h”
1486 is not defined so will not do anything.  You can check the file,
1487 shortcuts.html, for some options to use.
1488
1489 Next are a few actual examples from the default
1490 \texttt{{cindat\_path}/shuttlerc} file.
1491
1492 The next brackets represent sections. Default, Resources, Load
1493 windows all use the same key values.
1494
1495 \begin{lstlisting}[style=sh]
1496 [Default]
1497 [Resources]
1498 [Load]
1499 K5 XK_Home
1500 K6 XK_Button_1 # same as mouse button 1
1501 K7 XK_Button_2 # same operation as mouse button 2
1502 K8 XK_Button_3
1503 K9 XK_End
1504 # for example, in the Load menu, use scroll up to get to the next file name
1505 JL XK_Scroll_Up
1506 JR XK_Scroll_Down
1507 \end{lstlisting}
1508
1509 Cinelerra with brackets around it next, is the section with some key
1510 definitions for the main window.
1511
1512 \begin{lstlisting}[style=sh]
1513 [Cinelerra]
1514
1515 # Most useful functions have to be on K5-K9
1516 # because Xpress only has 5 keys
1517 K5 XK_Home      # Beginning
1518 K6 XK_KP_6      # Reverse, or if playing Stop
1519 K7 XK_KP_0      # Stop
1520 K8 XK_KP_3      # Play, or if playing Stop
1521 K9 XK_End       # End
1522 ...
1523 S-7 REV_16      # Next 6 are reverse keys
1524 S-6 REV_8       #  the number on the end represents speed
1525 S-5 REV_4       #  number can be decimal up to 64
1526 S-4 REV_2       #  2 means 2x or double speed
1527 S-3 REV_1
1528 S-2 REV_0.5     #  0.5 represents 1/2 speed
1529 S-1 XK_KP_0     # Because the Shuttle does not generate S0,
1530                 #   have to use S-1
1531 S0  XK_KP_0     # Hardware does not generate S0
1532 S1  XK_KP_0     # Because the Shuttle does not generate S0,
1533                 #   have to use S1
1534 S2  FWD_0.5
1535 S3  FWD_1
1536 ...
1537 \end{lstlisting}
1538
1539 An explanation for the above REV and FWD key symbol values is
1540 necessary to facilitate user preferences.  Obviously REV stands for
1541 reverse and FWD for forward.  You can set any speed up to and
1542 including 64x (that is, 64 times the normal speed) on any of the S
1543 keys.  First in the line is the key name such as S-3 and then the
1544 key direction of FWD or REV followed by the symbol for underscore
1545 (\_) and then the numerical value to use.  For example, if you want
1546 the $5^{th}$ forward position, S5, to play 10$\frac{1}{2}$ times
1547 faster, you would use the statement \texttt{S5 FWD\_10.5}.  Integer
1548 or decimal numbers are legal.
1549
1550 For the Viewer, you may want keys defined to do a Splice or an
1551 Overwrite so define differently.  Note that assignments that contain
1552 single character letters must be enclosed in quotes.
1553
1554 \begin{lstlisting}[style=sh]
1555 [Viewer]
1556 # Splice - Viewer only; may be defined
1557 # differently than Composer or Cinelerra
1558 K2 "v"
1559 K4 "b"          # Overwrite
1560 \end{lstlisting}
1561
1562 To change any key value to an alternative value, just edit the file
1563 and make the changes.  Besides just keys and alphabetic letters of
1564 numbers, you can also use any \CGG{} value that contains the
1565 combination with Shift, Alt, and Ctrl.  For keys that are not
1566 printable characters, you can look up the symbol name to use for a
1567 specific operation in the file called:
1568 \texttt{/usr/include/X11/keysymdef.h}. Some examples:
1569
1570 \begin{lstlisting}[style=sh]
1571 K10 Alt-XK_Left   # Go to previous edit \\
1572 K13 Ctrl-XK_Right # Go to next label
1573 \end{lstlisting}
1574
1575 For sequences of one or more \textit{printable} characters, you can
1576 just enclose them in double quotes.  For example in the
1577 \texttt{[Composer]} section, to go into or out of fullscreen mode,
1578 automatically start playing and put a label there, you could define
1579 a key like this:  K7 “f~l” - that is printable character f, a space,
1580 and printable character l.
1581
1582 After modifying \texttt{.shuttlerc}, the next time you use the
1583 shuttle, your changes will automatically take affect without even
1584 having to stop and restart Cin.  However, the first thing to try if
1585 problems is to stop \CGG{}, unplug the shuttle, wait a few seconds,
1586 plug it in again, and then restart cin.  If for some reason, the
1587 shuttle keys still do not work after that, you may have an incorrect
1588 setup and you will have to correct that first.  For example, if you
1589 define S5 twice within the \CGG{} setup, it will fail.  It is
1590 suggested that if you make changes, you should initially uncomment
1591 DEBUG in the \texttt{.shuttlerc} file and start up \CGG{} from a
1592 terminal window so that you can make sure it is working and has no
1593 output errors.  An error might look like:
1594
1595 \begin{lstlisting}[style=sh]
1596 dupl key name: [Cinelerra]K1
1597 shuttle config err file: /root/.shuttlerc, line:37
1598 \end{lstlisting}
1599
1600 Keep in mind when changing the values, that the ShuttleXpress has
1601 fewer buttons so if you define K1 it will only work for the
1602 ShuttlePro.
1603
1604 Any time you are having trouble with your shuttle, you can copy the
1605 default \texttt{shuttlerc} file from
1606 \texttt{{cindat\_path}/shuttlerc} to your local \texttt{.shuttlerc}
1607 file, and edit that to\ switch to DEBUG mode by removing the \#
1608 comment from the DEBUG line.  But you will have to have started Cin
1609 from a terminal window to see the key values. The first time you use
1610 the shuttle or after you change the file, the current assignments
1611 will show in the terminal window so will look something like:
1612
1613 \begin{lstlisting}[style=sh]
1614 [Cinelerra] # 1
1615 K5[D]: XK_KP_0/U
1616 K5[U]: XK_KP_0/U
1617 \end{lstlisting}
1618
1619 When you are in DEBUG mode and are just working away, what you will
1620 see is something like this:
1621
1622 \begin{lstlisting}[style=sh]
1623 key: 0058 1
1624 key: 0055 0
1625 \end{lstlisting}
1626
1627 or:
1628
1629 \begin{lstlisting}[style=sh]
1630 shuttle:  00 00 00 00 00
1631 key: XK_Home 0
1632 \end{lstlisting}
1633
1634 When you change the focus from one window to another, you will see
1635 something like this:
1636
1637 \begin{lstlisting}[style=sh]
1638 new focus: 04c00137
1639 new translation: Viewer
1640 key: 0059 1
1641 \end{lstlisting}
1642
1643 You can also set an environment variable to temporarily use an
1644 alternative shuttle configuration file for testing as in:
1645
1646 \begin{lstlisting}[style=sh]
1647 export SHUTTLE_CONFIG_FILE=/tmp/shuttlerc_test
1648 \end{lstlisting}
1649
1650 The shuttle wheel occasionally will not \textit{stop} after you have
1651 wheeled it to play forward.  This is a documented known problem from
1652 the original code so you just have to joggle it a little in the
1653 other direction and then it will stop.  S0 does not always generate
1654 a signal to do a stop and that is why S1 and S-1 have to be used to
1655 relay the stop instead.  Also, if you have a fullscreen Composer or
1656 Viewer up and the regular one also, the fullscreen takes precedence.
1657
1658
1659 \subsection{Troubleshooting auxilliary information}%
1660 \label{sub:troubleshooting_auxilliary_information}
1661
1662 In order to see if you hardware was recognized by the operating
1663 system, key in:
1664
1665 \begin{lstlisting}[style=sh]
1666 lsusb -v -d 0b33:0030  # for the Shuttle Pro or PROv2\\
1667 lsusb -v -d 0b33:0020  # for the Shuttle Xpress
1668 \end{lstlisting}
1669
1670 \paragraph{Note 1} Currently, the keys K14 and K15 do not function
1671 on the \textit{Contour Design ShuttlePro} but do on the
1672 \textit{Contour Design ShuttlePRO v2} due to a Report Descriptor
1673 error.  You can workaround this by uncommenting \texttt{USB\_DIRECT}
1674 in your local \texttt{.shuttlerc} file.  This directly uses libusb
1675 rather than the generic Linux hid driver.  \texttt{USB\_DIRECT}
1676 works for any of the currently tested shuttles.
1677
1678 \paragraph{Note 2} If you are not sure if your shuttle is fully
1679 functional, you can verify that the hardware device has been seen by
1680 your operating system with this procedure.
1681 \begin{enumerate}
1682 \item From a terminal window as an ordinary user key in: lsusb (the
1683   first character is a lower case L for list).  You will see
1684   something like the following depending on which usb device you
1685   have the ShuttlePro plugged into:
1686 \begin{lstlisting}[style=sh]
1687 Bus 003 Device 002: ID 0b33:0030 Contour Design, Inc. ShuttlePro v2
1688 \end{lstlisting}
1689 \item To make sure you have usbmon installed key in:
1690 \begin{lstlisting}[style=sh]
1691 sudo modprobe usbmon
1692 \end{lstlisting}
1693 \item Next key in the following:
1694 \begin{lstlisting}[style=sh]
1695 sudo od -tx1 /dev/usbmon3
1696 \end{lstlisting}
1697   where the last 3 is the same \# as the Bus in above.  If it lists
1698   \texttt{Bus 002}, then use \texttt{/dev/usbmon2} instead.
1699 \item Now with focus in that same terminal window, press any shuttle
1700   key just to see what happens and should see about 12 lines similar
1701   to these below -- a new set every time you press a single key or
1702   the wheel.  The lines are usually not important, just the fact
1703   that you get a response is.  However if you have multiple devices
1704   on the same bus, you will get responses from any and all of them.
1705   Attempt to isolate your shuttle by temporarily unplugging
1706   unnecessary devices on the same bus or plug the shuttle into a
1707   different usb port that has fewer devices.
1708     \begin{lstlisting}[style=sh]
1709 0000000 80 70 99 75 53 8c ff ff 43 01 81 02 03 00 2d 00
1710 0000020 4e 61 5c 5c 00 00 00 00 8d 2c 06 00 00 00 00 00
1711 0000040 05 00 00 00 05 00 00 00 00 00 00 00 00 00 00 00
1712 0000060 01 ff 00 00 00 80 70 99 75 53 8c ff ff 53 01 81
1713 0000100 02 03 00 2d 3c 4e 61 5c 5c 00 00 00 00 b1 2c 06
1714 0000120 00 8d ff ff ff 05 00 00 00 00 00 00 00 00 00 00
1715 0000140 00 00 00 00 00 80 70 99 75 53 8c ff ff 43 01 81
1716 0000160 02 03 00 2d 00 4e 61 5c 5c 00 00 00 00 3d d7 09
1717 0000200 00 00 00 00 00 05 00 00 00 05 00 00 00 00 00 00
1718 0000220 00 00 00 00 00 00 ff 00 00 00 80 70 99 75 53 8c
1719 0000240 ff ff 53 01 81 02 03 00 2d 3c 4e 61 5c 5c 00 00
1720 0000260 00 00 64 d7 09 00 8d ff ff ff 05 00 00 00 00 00
1721 \end{lstlisting}
1722 \item Next press the key that you want to verify is functioning --
1723   if no new lines show up, then the key is non-functional so there
1724   is a hardware problem.  If you get output, then perhaps there is a
1725   problem with your software setup.
1726 \item Use Ctrl-C on the terminal window when done to get back to the
1727   prompt.
1728 \end{enumerate}
1729
1730 \paragraph{Note 3} Another method for testing to make sure your
1731 model of the Shuttle does not have different key definitions than
1732 the one that \CGG{} was coded for is to do the following.
1733
1734 \begin{enumerate}
1735 \item Locate the shudmp.C program in your \CGG{} directory.
1736 \item Compile that with the command:  \texttt{c++ shdmp.C -o shudmp}
1737 \item Make the file executable with the command:  \texttt{chmod +x shudmp}
1738 \item Execute:
1739 \begin{lstlisting}[style=sh]
1740 sudo ./shdmp /dev/input/by-id/usb-Contour\_Design\_ShuttlePro-event-if00 # substitute your shuttle
1741 \end{lstlisting}
1742 \end{enumerate}
1743
1744 Then press your shuttle key that is having problems and check the
1745 results.  They should look like:
1746
1747 \begin{lstlisting}[style=sh,caption={Example for K7}]
1748 event: (4, 4, 0x90007)  #The last number, 7, is the expected Key number.
1749 event: (1, 262, 0x1)
1750 event: (0, 0, 0x0)
1751 event: (4, 4, 0x90007)
1752 event: (1, 262, 0x0)
1753 event: (0, 0, 0x0)
1754 \end{lstlisting}
1755
1756 \begin{lstlisting}[style=sh,caption={Example for K15}]
1757 Example for K15:
1758 event: (4, 4, 0x9000f)  #The last number f is 15 in hexadecimal and is the expected Key.
1759 event: (1, 270, 0x1)
1760 event: (0, 0, 0x0)
1761 event: (4, 4, 0x9000f)
1762 event: (1, 270, 0x0)
1763 event: (0, 0, 0x0)
1764 \end{lstlisting}
1765
1766 When done, you will have to Ctrl-C to get out of the program.
1767
1768 \paragraph{Note 4} For developers, if you have a pre-UEFI Secure
1769 Boot kernel it is also possible to do the following for further in
1770 depth testing:
1771
1772 \begin{lstlisting}[style=sh]
1773 ls /sys/kernel/debug/hid   \# to locate numerical value of the shuttle, e.g. 0003:0B33.0030.0006
1774 cat "/sys/kernel/debug/hid/0003:0B33.0030.0006/rdesc"  # substitute your own numerical value
1775 cat "/sys/kernel/debug/hid/0003:0B33.0030.0006/events"  # press keys to see the results
1776 \end{lstlisting}
1777 %\begin{enumerate}
1778     %\item \texttt{ls /sys/kernel/debug/hid   \# to locate numerical value of the shuttle, e.g. 0003:0B33.0030.0006}
1779     %\item \texttt{cat “/sys/kernel/debug/hid/0003:0B33.0030.0006/rdesc”    \# substitute your own numerical value}
1780     %\item \texttt{cat “/sys/kernel/debug/hid/0003:0B33.0030.0006/events”  \# press keys to see the results}
1781 %\end{enumerate}
1782
1783 \subsection{Shuttle key default arrangement for \CGG{} / Composer / Viewer:}%
1784 \label{sub:shuttle_key_default_cinelerra}
1785
1786 The following is the default setting for the ShuttlePROv2 and
1787 ShuttleXpress (table~\ref{tab:shuttleprov2} and
1788 table~\ref{tab:xpress}):
1789
1790 \renewcommand{\arraystretch}{1.15}
1791 \begin{table}[ht]
1792   \caption{ShuttlePROv2 key default arrangement for \CGG{} /
1793     Composer / Viewer}
1794   \label{tab:shuttleprov2}
1795   % Tell table to adjust font to fix on the page using \resize
1796   \resizebox{\textwidth}{!}{%
1797     \begin{tabular}{c c c c c c c}
1798       \toprule
1799       K1 & K2 & & K3 & K4 & &\\
1800       Label & Future use & & Future use & Clip & &\\
1801          & Splice (viewer) & & Copy  & Overwrite (viewer) & &\\
1802       \midrule
1803       K5 & K6 & K7 & K8 & K9 & &\\
1804       Home & Reverse & Stop & Play & End & &\\
1805          & & Fullscreen & & & &\\
1806          & & (viewer / compositor) & & & &\\
1807       \midrule
1808       Home(Defaults) & MouseBtn1(D) & MouseBtn2(D) & MouseBtn3(D) & End(Defaults) & &\\
1809       \midrule
1810       \multicolumn{7}{c}{Shuttle Outer Wheel}\\
1811       \multicolumn{7}{c}{Play forward (first row) or Play reverse (second row)}\\
1812       S1=Stop  & S2=1/2 & S3=Normal  & S4=2x & S5=4x & S6=8x & S7=16x\\
1813       S-1=Stop &  S-2=1/2 & S-3=Normal & S-4=2x & S-5=4x & S-6=8x & S-7=16x\\
1814       \midrule
1815       K14 & & Jog Left & (Inner Wheel) & Jog Right & & K15\\
1816       Toggle In & & Frame reverse & & Frame forward & & Toggle Out\\
1817          & & Scroll up(Defaults) & & Scroll down(Defaults) & &\\
1818       \midrule
1819          & & K10  & &  K11 & &\\
1820          & & Previous Edit & & Next Edit & &\\
1821          & & Future Use(Viewer) & & Future Use(Viewer) & &\\
1822       \midrule
1823          & & K12  & &  K13 & &\\
1824          & & Previous Edit & & Next Edit & &\\
1825          & & Previous Label & & Next label & &\\
1826       \bottomrule
1827     \end{tabular}}
1828 \end{table}
1829
1830 \begin{table}[ht]
1831   \caption{ShuttleXpress key default arrangement for \CGG{} / Composer / Viewer}
1832   \label{tab:xpress}
1833   % Tell table to adjust font to fix on the page using \resize
1834   \resizebox{\textwidth}{!}{%
1835     \begin{tabular}{c c c c c c c}
1836       \toprule
1837       K5 & K6 & K7 & K8 & K9 & &\\
1838       Home & Reverse & Stop & Play & End & &\\
1839          &         & Fullscreen & & & &\\
1840          &         & (viewer / compositor) & & & &\\
1841       \midrule
1842       Home(Defaults) & MouseBtn1(D) & MouseBtn2(D) & MouseBtn3(D) & End(Defaults) & &\\
1843       \midrule
1844       \multicolumn{7}{c}{Shuttle Outer Wheel}\\
1845       \multicolumn{7}{c}{Play forward (first row) or Play reverse (second row)}\\
1846       S1=Stop &   S2=1/2 &   S3=Normal  &  S4=2x  &  S5=4x  &  S6=8x &   S7=16x\\
1847       S-1=Stop &  S-2=1/2 &  S-3=Normal &  S-4=2x &  S-5=4x &  S-6=8x  & S-7=16x\\
1848       \midrule
1849          & & Jog Left & (Inner Wheel) & Jog Right & &\\
1850          & & Frame reverse & & Frame forward & &\\
1851          & & Scroll up(Defaults) & & Scroll down(Defaults) & &\\
1852       \bottomrule
1853     \end{tabular}}
1854 \end{table}
1855
1856
1857 %%% Local Variables:
1858 %%% mode: latex
1859 %%% TeX-master: "../CinelerraGG_Manual"
1860 %%% End: