022dbf9910e4bf25135859412320ea4badad1b02
[goodguy/cin-manual-latex.git] / parts / Advanced.tex
1 \chapter{Advanced Editing}%
2 \label{cha:advanced_editing}
3
4 \section{Proxy}%
5 \label{sec:proxy}
6 \index{proxy}
7
8 Proxies were introduced to allow for a smoother timeline experience. Full HD and everything from 4K size up are usually very large in file size. In addition, some commonly used codecs (for example h264/5) are very compressed and interframe type, so they are more CPU intensive for timeline playback. These files cause performance problems on smaller computers. As a solution, proxies were introduced to reduce the file size. Reduced means to minimize the resolution/dimension, as usually not the full resolution is needed because the compositor generally occupies only a fraction of the computer screen. The proxy provides a scaling factor which indicates how much the original resolution should be reduced. 
9 There is also the \textit{proxy 1:1} \index{proxy!1:1} option that maintains the original resolution but still allows you to modify codec parameters (lowering the bit rate, for example). This is explained in the next section, \ref{sec:transcode}.
10 Always remember when getting ready to render the project, disable Proxy to return to the original settings with the highest quality.  
11
12 To use proxy in a classic way, that is as a scaling, select \texttt{Settings $\rightarrow$ Proxy settings} and change the Scale factor from Original size to your downsized choice.  You can choose ffmpeg as the \textit{File Format} \index{file format} and for the \textit{File Type} a choice of various codecs associated with that.  A good choice for \textit{File Type} is the default of mpeg or mov which can usually be quite fast.  In addition you can modify values for that codec by clicking on the wrench icon. Once you have created a
13 proxy file, it will be reused and does not have to be created again as long as you
14 do not change certain parameters.  This saves a lot of CPU time.
15
16 There are two main ways to use Proxy, with or without \texttt{Rescaled to project size} option checked. The options of the Scale factor may be different if Rescaled to project size is checked versus unchecked. It is a special case when the Scale factor is set to "1" and it does not  matter if Rescaled to project size is checked or unchecked.
17
18 The usual steps to use Proxy are:
19 \begin{enumerate}
20         \item Check that \textit{File Format} is set to \texttt{FFMPEG}.
21         \item Check or uncheck the \texttt{Rescaled to project size} (FFMPEG only). The difference with this option will be explained here \ref{sub:rescaled_project_size_works}. But for old computers checking Rescaled to project size is not recommended; again due to requiring more CPU. You need to know that when Rescaled to project size is unchecked some Effects/Plugins do not work as expected because they use pixel values instead of percentage values as is used in the Project Format. For example \texttt{Title}, \texttt{Blur}, \texttt{Sketcher} plugins do not work right if unchecked, while \texttt{Perspective} and \texttt{Crop\&Position} plugins work correctly for both checked and unchecked.
22         \item Choose the \textit{Scale factor}. The options may be different if Rescaled to project size is checked or unchecked. The smaller the Scale factor is, the smoother playing on the Timeline will be ($\frac{1}{8}$ is smaller than $\frac{1}{4}$), but on the Viewer/Compositor the image will be degraded/pixelated more.
23         \item Set the \textit{File Type} in the \textit{File Format} for FFMPEG, such as mp4, mpeg, or mov. Still images like jpg, tiff, and png will be converted to PNG files with alpha channel if it had an alpha channel.
24         \item Click on the wrench icon to configure video compression; just use the default values if you are unsure and prefer not to experiment.
25         \begin{enumerate}
26                 \item Select the Compressor type (codec).
27                 \item Change Bitrate, or Quality, and Pixels. Because not all codecs use the alpha channel for transparency, check that the letter "a" is in the Pixels name (such as yuva420p or rgba) to retain the alpha channel.
28                 \item Click on the OK button to close the Compressor window.
29         \end{enumerate}
30         \item Now click on the \texttt{OK} button to start the rendering for the proxy.
31         \item Look in the lower right corner of the main window where there is a progress bar and a percentage value showing the progress of the creation of proxies, and in the lower left corner there is the \texttt{Creating proxy files... ETA: hh:mm:ss} text with the "Estimated Time of Arrival (completion)" in hours, minutes, seconds. Depending on how many files your project uses, the file size, which codec is used, the scale factor, and cpu performance, creating proxies may take some time.
32 \end{enumerate}
33
34 You will know that Proxy mode is enabled because:
35 \begin{itemize}
36         \item A white colored \textbf{P} meaning \textit{Proxy}, or a white colored \textbf{S} meaning \textit{Proxy Scaled} icon is shown in the upper right corner of the main window to the left of the FF icon.  If using the Cakewalk or Neophyte theme it will be a \textbf{Ps} icon.
37         \item  The Proxy folder in the Resources window has been populated with the names and/or icons of the proxy media.
38         \item The track title bar in the timeline will have the name of the proxy file instead of the original name. So if the video filename is \texttt{VID\_20221012.mp4}, the Proxy Scale Factor is $\frac{1}{4}$, and the Proxy container is mov, then the proxy name will be \texttt{VID\_20221012.proxy4-mp4.mov}.
39 \end{itemize}
40
41 The Proxy icon is a toggle button so that you just click on the icon to change modes.  Or it can be toggled using the \texttt{Ctrl+R} shortcut. 
42
43 \begin{table}[ht]
44         \centering
45         \begin{tabular}{|p{2.5cm}|p{3.2cm}|p{3.2cm}| p{3.2cm}|}
46                 \hline
47                 \textbf{Proxy State} & \textbf{Rescaled to project size (FFMPEG only)} & \textbf{Proxy icon for themes:
48                 Cakewalk/Neophyte} & \textbf{Proxy icon for themes: the Others}\\
49                 \hline
50                 Off & checked/ unchecked & no icon
51                  & no icon\\
52                 \hline
53                 Active (Enable) & checked & Ps: P(green)  s(white)
54                  & S (white)\\
55                 \hline
56                 Disable & checked & Ps: P(red)  s(white) & S (gray)\\
57                 \hline
58                 Active (Enable) & unchecked & Ps: P(green) s(red) & P (white)\\
59                 \hline
60                 Disable & unchecked & Ps: P(red) s(red) & P (gray)\\
61                 \hline
62         \end{tabular}
63         \caption{Table: list States of the Proxy icon}
64 \end{table}
65
66 When you disable Proxy using the toggle button for Proxy, or its shortcut (\texttt{Ctrl+R}), in the Proxy Settings window you will see the \texttt{Scale Factor = 1}, but if you look at the Active Scale and the State, you can understand what your setting is.
67 Proxy can have three possible States: Off, Active, Disabled. The difference between Off and Disabled is that Disabled means you have set the Proxy and it is temporarily switched off (and you can see the icon in the upper right corner of the main window); you can enable proxy by just clicking on the icon, so the State will then be changed from Disabled to Active.
68
69 \subsection{How Rescaled to project size (FFMPEG only) works}%
70 \label{sub:rescaled_project_size_works}
71
72 \begin{itemize}
73         \item When \texttt{Rescaled to project size (FFMPEG only)} is checked, the size of the video data to be computed will always be the same as the Project Format. The size of your video is scaled down to the Scale factor BUT then it is rescaled up to the Project Format. For example, your Project Format is 1920x1080 and Proxy's Scale factor is $\frac{1}{4}$, then your videos ($1920x1080$) will be scaled down to 480x270 and then up-scaled to $1920x1080$. All the Effects/Plugins work correctly because the original resolution/geometry/size is not changed. For an old computer, this option is not recommended.
74         \item When \texttt{Rescaled to project size (FFMPEG only)} is UNchecked, the size of the video data to be computed will be reduced to the Scale factor. The size of your video is scaled down to the Scale factor. For example, your Project Format is 1920x1080 and Proxy's Scale factor is $\frac{1}{4}$, then your videos ($1920x1080$) will be scaled down to $480x270$. It works as if the Project Format were $480x270$ (and really it works). If you take a look at \texttt{Settings $\rightarrow$ Format...} when Proxy is enabled (Active), you can see that the Width and Height are changed according to the Scale factor; you absolutely must NOT change these values! The good thing is that your computer will be faster. The bad thing is that some Effects/Plugins do not work as expected because they use pixel units. Examples are \texttt{Title} and \texttt{Blur} plugins. A workaround is needed for that, such as using Inkscape to create a title and export it to PNG that you load instead of using the \textit{Title} plugin.
75
76 \end{itemize}
77
78 Note: the dimensions of the frame/image are downscaled to the Scale factor; so if the Scale factor is $\frac{1}{4}$ and the dimension of the image is $4288x2848$ pixels, that image will be downscaled to $1072x712$. It doesn't matter what the Project Format is.
79
80 \subsection{Using proxy}%
81 \label{sub:using_proxy}
82
83 To insert a clip/video from Resources window to the Timeline when Proxy is enabled (Active) you MUST Drag \& Drop that clip/video from the Proxy folder instead of the Media folder, as well as for Nested clips. And also if you want to load the clip in the Viewer or Compositor. You can use clips in the Clips folder in any State of the Proxy - it does not matter if Proxy is enabled or disabled.
84
85 Rendered proxy media is saved in the same directory as the original media. As usual, you can delete proxy files from the project or disk in the Resources window if you no longer want to retain them. You should always save your project with the Proxy disabled.
86
87 If you create proxies for Nested clips they will be saved in \texttt{\$HOME/Videos} unless you modify that in \texttt{Settings $\rightarrow$ Preferences}, \texttt{Interface tab}, \texttt{Nested Proxy Path}. If you change anything in a Nested clip using the Open EDL feature, you must first delete its old proxy file from disk because it is not updated automatically, and then enable Proxy again so that a new one is created. 
88
89 Not all the settings for Proxy are saved in the project: the values of Active Scale and the Rescaled to project size are saved but not the \textit{File Format}, \textit{File Type} and all video compression data. A good idea is to record this information in a README file about your project where you make a note of your Proxy settings for that project. 
90 This is especially important because some Projects may use different Proxy settings and
91 if you load a project where the Proxy is set and disabled, it could use a different
92 setting because you changed the Proxy settings in a project you were working on before.
93 If in that Project its proxy files were not deleted and you want to reuse them to save
94 time, unfortunately they will be created again because the proxy settings have changed.
95
96 If the \textit{Creation of proxy on media loading} option has been checked, then when you load other media later, proxies will be created for them automatically, or else you can change the Proxy's State from disabled to enabled (Active) using the Proxy icon. Previous proxy renders will be reused unless you change one of the following proxy parameters: \textit{Scale factor}, \textit{File Format}, or \textit{File Type}. If proxies have been created and then you decide to change only the Compression type (Codec, Bitrate, Quality, Pixels), without changing the Scale factor or Container, you must delete proxy files from the disk beforehand. That is because \CGG{} does not read the compression type; it does read the filename and if the filename does
97 not change, \CGG{} thinks the proxy was already created.
98
99 \subsection{Scale factor set to 1, a special case}%
100 \label{sub:scale_factor_special_case}
101
102 This special case is used to temporarily change the codec parameters of your video while maintaining the original resolution - for example maybe your videos use long-GOP or the video codec is too hard to handle due to a strong compression. It does not matter if Rescaled to project size is checked or unchecked. For old computers, or underpowered computers, this option is not recommended.
103
104 \subsection{Setting the proxy}%
105 \label{sub:setting_proxy}
106
107 \begin{figure}[htpb]
108         \centering
109         \includegraphics[width=0.8\linewidth]{proxy-02.png}
110         \caption{Proxy settings dialog}
111         \label{fig:proxy-02}
112 \end{figure}
113
114 Screencast in figure~\ref{fig:proxy-02} shows the \textit{Rescaled to project size} checked so you can still use plugins correctly and the original project size is kept.  The Scale factor pull-down gives you available size options.  Note the new media dimensions shown (partially covered).  If the size is an odd number, 1 is added to make the dimensions both even numbers.
115
116 To go back to the original media permanently, simply set the Scale factor to Off or disable the Proxy by clicking on its toggle button. However, if you decide to reuse the proxies, those which have not been deleted from the Hard Disk (but have been removed from the project) will be used without re-rendering - this saves a lot of time. To completely remove the created proxies you will have to delete them manually from the Hard Disk.
117
118 There is also a convenient \textit{Beep on done volume} slider included so that you can work on other tasks until there is an audible notify of completion.  The default volume is set to 0 for no audible notify.
119
120 A good choice for classic proxy settings with a 1080p source video is:
121
122 \begin{lstlisting}[numbers=none]
123 Scale Factor:   1/4
124 File Format:    FFMPEG - mpeg
125 Video Preset:
126 Compression:    mpeg.mpeg
127 Bitrate:        2000000
128 Quality:        -1
129 Pixels:         yuv420p
130 \end{lstlisting}
131
132 If you get errors for some videos, such as those with strange variable bit rate or some types of files made on a smartphone, a usually reliable alternative is to change the following parameters:
133
134 \begin{lstlisting}[numbers=none]
135 File Format:    FFMPEG - mov
136 Video Preset:
137 Compression:    mov.mov
138 \end{lstlisting}
139
140 Or if you want small files with high image quality, a \textit{File Format} of m2ts is optimal.  For example a 1 GB file can be reduced to 50 MB with scale $\frac{1}{2}$. 
141
142 If you get error messages \index{proxy!error} when creating proxies, check the Video wrench settings.  These usually default to values that are expected to work correctly for the \textit{File Format} and codec you selected but they can be changed and may result in errors.  If you get an error message of \textit{check\_frame\_rate failed} followed by \textit{Error making proxy} in the popup Errors window, do just that and check the Frame rate value by going to the Resources window, Media folder, and use the right mouse button for the \textit{Info} option for the specific media in question.  You can change the frame rate in this window to a more codec acceptable value.  Different codecs may have different legal values.
143
144 A faster method of creating the proxy file outiside of \CGG{} for users who have
145 vaapi hardware acceleration capability on their graphics board is via a script.  Speed
146 up could potentially be 10 to 30 times faster depending on the parameter values you choose
147 and the size of your video file.  This script is included in the doc subdirectory as 
148 \texttt{vaapi\_proxy.sh} for users not using an AppImage version and is shown below.  You will
149 have to tune it to your specific needs for the vaapi\_device name (currently set to
150 \texttt{/dev/dri/renderr128}), file type (currently set to h264 and mp4), and proxy size (now is 6). 
151 Once you have created the proxy file, you then start \CGG{}, load the original un-proxied
152 video, use the Settings pulldown and choose the Proxy settings options as you would normally,
153 but because you already have created the existing proxy file with the correct name, it will
154 be automatically loaded and will not have to create it.  The filename of the proxy file
155 must be in the same location as the original video and have the exact required naming
156 conventions and scale factor.
157
158 \begin{lstlisting}[numbers=none]
159 #!/bin/bash
160 filename="$1"
161 fileout="${filename%.*}"
162 proxy="6"
163 # Hardware encode AMD
164 ffmpeg -threads 2 -hwaccel vaapi  -vaapi_device /dev/dri/renderD128 \
165  -i  "$1" -c:v h264_vaapi -vf "format=nv12,hwupload,scale_vaapi=iw/'$proxy':ih/'$proxy'" \
166  -vcodec h264_vaapi  -preset fast -c:a copy \
167  -bf 0 -profile:v 66 "$fileout".proxy"$proxy"-mp4.mp4
168 \end{lstlisting}
169
170 \subsection{Proxies with Alpha channel}%
171 \label{sub:proxies_alpha_channel}
172
173 Next are some examples of tested and working configurations that maintain the alpha channel:
174
175 \begin{lstlisting}[numbers=none]
176 Proxy #1
177         Scale factor: 1/4
178         Rescaled to project size (FFMPEG only) = unchecked
179         File Format: FFMPEG | qt
180         Video Preset-->
181                 Compression: png.qt
182                 Bitrate: 0
183                 Quality: -1
184                 Pixels: rgba (or rgba64be)
185         
186         
187 Proxy #2
188         Scale factor: 1/4
189         Rescaled to project size (FFMPEG only) = unchecked
190         File Format: FFMPEG | qt
191         Video Preset-->
192                 Compression: magicyuv.qt
193                 Bitrate: 0
194                 Quality: -1
195                 Pixels: yuva444p
196         
197         
198 Proxy #3
199         Scale factor: 1/4
200         Rescaled to project size (FFMPEG only) = unchecked
201         File Format: FFMPEG | qt
202         Video Preset-->
203                 Compression: openjpeg.qt
204                 Bitrate: 0
205                 Quality: -1
206                 Pixels: yuva420p
207         
208         
209 Proxy #4
210         Scale factor: 1/4
211         Rescaled to project size (FFMPEG only) = unchecked
212         File Format: FFMPEG | pro
213         Video Preset-->
214                 Compression: prores_4444.pro
215                 prores_4444xq.pro
216                 Bitrate: 0
217                 Quality: -1
218                 Pixels: yuva444p10le
219         
220         
221 Proxy #5
222         Scale factor: 1/4
223         Rescaled to project size (FFMPEG only) = unchecked
224         File Format: FFMPEG | mkv
225         Video Preset-->
226                 Compression: user_ffvhuff.mkv
227                 Bitrate: 0
228                 Quality: -1
229                 Pixels: yuva4--p
230                                    yuva4--p--le
231 \end{lstlisting}
232
233 \section{Transcode}%
234 \label{sec:transcode}
235 \index{transcode}
236
237 Transcode, an option under the \textit{Settings} pulldown right next to the Proxy settings option, is a type of full resolution \textbf{1:1 Proxy} \index{proxy!1:1}.
238 The process of transcoding works directly from the resource; it is independent of the timeline. 
239 All of the loaded asset media will be converted, that is, rendered in the selected format and loaded onto the timeline. 
240 Menu choices besides the usual File Format \index{file format} and File Type include: \textit{Tag suffix} (to add to media filename), \textit{Remove originals from project}, \textit{Into Nested Proxy directory} (an option to have the file saved here instead of the location of the original media), and \textit{Beep on done} volume.
241
242 The settings of the project have an effect on the outcome, for example the dimensions are taken into account. The resulting files are also larger than if they were created directly with ffmpeg.
243 Transcode works for videos with or without audio and even single frame files, like png's.
244 If you have a video file that also contains audio, and you convert only the video, the original audio will stay on the timeline if do not check \textit{Remove originals from project}. Or vice versa if audio converted and not video.
245 Multiple stream media will only transcode the first stream (this would be like the TV channel recordings in the United States).
246 You will get an error message if you already have a transcoded file in the selected format with the same suffix name and try to transcode it again with a different selection made -- you will have to delete that file first. An example would be
247 an already converted file that has both video and audio and now you request video only. 
248
249 The BIGGEST gain from using this is if you have media that is not \textit{seekable} \index{seek}, that is, you can play it from the beginning but can not move to another spot and have the audio or video play correctly. A video file with no keyframes makes seeking next to impossible, but then a Transcode generally adds these keyframes. This is particularly useful for the \texttt{mkv} container, which often has seek problems. For more details on mkv container see \ref{ssub:note_mkv_container}
250
251 Another important function of Transcode is being able to convert the project's media into a high-quality \textit{mezzanine} codec \index{mezzanine codec} (sometimes also called \textit{intermediate} codec \index{digital intermediate}), which makes timeline work lighter and more efficient. In fact such codecs (ffv1, ProRes, DNxHD, OpenEXR, huffyuv, etc) are generally little or not at all compressed; the type of compression is intraframe --more suitable for editing, and the image quality (4:2:2 up; 10-bit color up; floating point; etc) is suitable for \textit{Color Correction}, \textit{Chroma Key} and \textit{Rotoscoping}. The use of mezzanine codecs leads to very large files, so you need to make sure you have enough storage space.
252
253
254 \section{OpenEDL}%
255 \label{sec:openedl}
256 \index{openEDL}
257
258 To edit EDL \index{EDL} that is included with your project as Clips, Nested
259 Clips, Referenced File, or Xml you can use the option \textit{Open
260         EDL} in the Resources window for the highlighted media.  Then
261 with a simple button click you can return to your main timeline project.
262 For example, if you have a nested clip that originally had several
263 plugins added to it before it was nested, you can edit those plugin
264 parameter values. Previously to make any changes to these types of
265 EDL you had to remake the whole clip from scratch.  The program is 
266 actually "opening" the file as it currently exists for that particular
267 media so that it can be edited separately from the project EDL. In other NLEs the term \textit{sub-timeline} is used.
268
269 Here is how this works. In the Clip \index{clip !older} or Media folder \index{media folder} or on a timeline
270 EDL edit, the option \textit{Open EDL} for the highlighted clip or
271 nested clip is available so that when you choose this option, that
272 EDL will be brought up on the timeline superseding the current EDL
273 that exists on the timeline \index{timeline}.  Now, once the clip is open on the
274 timeline, you can edit it however you want. The previous timeline
275 EDL is \textit{pushed onto a stack} so it can be recalled by
276 \textit{popping the stack} with a click of the left mouse button in
277 the upper right hand corner of the timeline to the left of the
278 \textit{shell cmds} icon.  Initially this button displays a 0 to
279 indicate your initial timeline/project.  Then this button will read
280 1 if you choose \textit{Open EDL} and then back to 0 and your
281 original timeline with the left mouse click.  You can go several
282 levels deep so instead of 1, it could be 2, 3, $\dots$ but this
283 requires some thought to avoid potential confusion.
284
285 An example of a typical set of steps to follow is:
286 \begin{enumerate}
287         \item Load your media using insertion strategy of \textit{Replace
288                 current project}.  There will be number 0 in the upper right hand corner
289         of the main menu with the tooltip of \textit{Close EDL}.
290         \item Highlight a selection on the timeline and press the
291         \textit{To clip} icon and click the green checkmark OK.
292         \item In the Resources window, open the Clip folder and you will
293         see that Clip 1 is present.
294         \item Highlight Clip1 and right mouse the item to bring up
295         available options and select \textit{Open EDL}.
296         \item Now you will see the timeline change from the original
297         media to just the clip content and the number in the upper right hand
298         corner will change from 0 to 1.
299         \item Add a visible effect, like AgingTV to the timeline.
300         \item Click on the number 1 in the main menu bar to see the timeline
301         restored to the original media.
302         \item Drag the clip from the Resources Clip folder to the
303         timeline and you will see the AgingTV effect.
304 \end{enumerate}
305
306 You can follow the same steps as above by first using the option
307 \textit{Nest to media} in the Clip folder which nests the clip and
308 moves it out of the Clip folder to the Media folder.  Then use
309 \textit{Open EDL} on the Nested EDL \index{nested EDL} in the media folder.  When you
310 Open EDL and edit the changes, those changes will take affect on any
311 and all occurrences of that nested clip on the current and/or
312 original timeline. The option to unnest that clip and put that back
313 into the Clip folder is the option \textit{EDL to clip}.  The nested
314 clip is still in the Media folder.  It will now have a name of the
315 next available Clip number but the comment contains the previous name so
316 you can tell where it came from.
317
318 Instead of using the number on the main menu to close the current
319 EDL, both the Media and Clip folders have \textit{Close EDL} options
320 with the left mouse button. Clicking on the number button is quick and
321 easy but for infrequent usage it is not obvious, whereas if you use
322 \textit{Open EDL} you see \textit{Close EDL} right below that and so
323 it is very obvious.  In addition in the case of where you have
324 opened a EDL, and you no longer see that clip in the folder, the
325 right mouse button where no media is highlighted will also display
326 the Close EDL option.
327
328 %\pagebreak
329 \begin{figure}[h]
330         \centering
331         \includegraphics[width=1\linewidth]{editing-img001.png}
332         \caption{Once you have an Open EDL, the easiest way to close it.}
333         \label{fig:open_edl}
334 \end{figure}
335 \relax
336
337 In addition to the \textit{Open EDL} option in the Resources menu,
338 this option is available on the timeline when the cursor is on an
339 EDL-type edit. To get to this option, click on the middle mouse
340 button on that edit.  If it is not EDL, the option will not be
341 shown.  In summary:
342
343 \begin{center}
344         \begin{tabular}{ll}
345                 \toprule
346                 Media folder of Resources window & Open EDL for Nested or Referenced EDLs\\
347                 Clip folder of Resources window & Open EDL for clips\\
348                 Track timeline & Open EDL for Nested or Referenced EDLs\\
349                 \bottomrule
350         \end{tabular}
351 \end{center}
352
353 An aside -- when nesting and unnesting clips to take advantage of
354 this feature, names of the media can lead to some confusion.  For
355 example, if you nest a clip, the new name in the Media folder is the
356 word \textit{Nested} followed by an underscore with the date and
357 timestamp, another underscore, and then the clip name.  Then when
358 you unnest this Media folder clip via the \textit{EDL to clip}
359 option, the name will be changed in the Clip folder to the next
360 available Clip number.  However the comment field will reflect the
361 nested clip name from which it was derived.  To avoid confusion you
362 can easily change the name for these clips in either the Clip or
363 Media folder because they are not real files at this point. To do
364 so, highlight the clip name in Resources, click on Info and type in
365 a new name.
366
367 For additional safety, the \textit{Open EDL} feature includes
368 additional backup capabilities. Automatically \CGG{} saves a backup \index{backup}
369 when certain changes are made or you can always use the shortcut `b'
370 to do one yourself, although keep in mind it will be overwritten
371 whenever \CGG{} wants to do another backup.  Now there is a shortcut
372 for the backup shortcut `b' so you can keep your hand on the mouse
373 instead of the keyboard.  Just click on the number button in the upper right
374 hand corner of the main window.  If number is at 0, it backs up to
375 backup.xml, if at 1, it backs up to \texttt{backup1.xml} and so on
376 \dots up to \texttt{backup9.xml}.
377
378 When \textit{Open EDL} is invoked, the current EDL and current undo
379 stack are both \textit{pushed}, and the active session EDL is
380 replaced with the target clip/nested edl.  A new undo stack is
381 created, and the active \texttt{backup.xml} file name is decorated
382 with the stack level.  So, \texttt{backup.xml} is
383 \texttt{backup1.xml} when your edits are at stack level 1,
384 \texttt{back\-up2\-.xml} at stack level 2, and so on.  This means
385 that if you \textit{load backup} at stack level 1, the session will
386 reload from history at stack level 1, not the main session.
387
388 See a real-world workflow at appendix \nameref{sec:workflow_openedl_nested_clips}
389
390 \section{File by Reference}%
391 \label{sec:file_by_reference}
392 \index{file by reference}
393
394 It is sometimes handy to have EDL \index{EDL} assets not as a copy, but as a
395 reference that is automatically updated into your project.  Suppose
396 you have several short videos that at the end have the same credits
397 which include the current year such as 2021.  But now it is 2022 and
398 all of the videos would have to be individually updated with the new
399 date.  By including a \textit{Referenced File} as the EDL file type
400 when you create each of the videos, you can just change the one
401 credits xml file and the next time you load one of the videos and
402 render it, it will now automatically have the updated information.
403
404 The purpose of this feature is to be able to rework a smaller
405 section of a global master project at any time, which can be done by
406 an "assistant" (i.e. external software like GIMP or Inkscape, $\dots$) and then this work is automatically reflected in the
407 global master project.  It is for \textbf{advanced usage only}.
408
409 Up until the addition of this feature, \CGG{} has always used copies
410 and no direct reference in order to ensure original data is never
411 compromised (No Destructive editing).  In the usual case, subprojects as xmls are copied into
412 a master project where subprojects had been inserted, so that if you
413 change something in a subproject or delete a subproject, it would
414 have no affect on the master project.  But now with \textit{File by
415         Reference}, any project that uses a referenced file will
416 automatically include any changes made to the referenced file when
417 loaded.  At the same time, if you use the EDL file NOT as a
418 referenced file in a project since it is then just a copy, it will
419 not be updated.  Because of this difference, the user needs to be
420 very aware of what using this feature could do.
421
422 \textbf{Use with extreme caution}.  However, there are several
423 built-in safety features and a warning that should never be turned
424 off even though it gives you the option to do so.  These include:
425
426 \begin{enumerate}
427         \item When the \texttt{File, Load files} menu is opened, the EDL
428         strategy will always be set to just EDL as default.  Although, if
429         you use Apply and leave the Load Menu open, it will stay changed to
430         what you selected until it is re-opened.
431         \item When an EDL is opened as \textit{Reference}, the color of
432         that file name in the Resources Media folder is different in order
433         to serve as a reminder that it is special.
434         \item A warning message is displayed in a popup window when you
435         load a \textit{File by Reference} that reads \texttt{Other projects can
436         change this project and this can become a broken link}.  Although
437         you can check the warning box to never see this warning again, you
438         would be well advised to not do so.  It is a great reminder of
439         consequences and you will not want to be cavalier about the warning.
440         Instead just use the X to dismiss the warning.
441 \end{enumerate}
442
443 Here is a step by step example of how you can use \textit{File by
444         Reference}:
445 \begin{enumerate}
446         \item Start up \CGG{} and use the Title plugin to create a new
447         credits file.  Save as credits.xml.
448         \item Start a New project and then load an existing master
449         project to the timeline.
450         \item Load the credits file you created in step 1 with a Load
451         Strategy of Create Resources Only and with EDL Strategy as
452         \textit{Reference}.
453         \item Note the color change in the credits.xml filename and the
454         reference comment in the Resources Media folder.
455         \item Drag the credits file to an empty spot on the timeline.
456         Save this new master project and quit.
457         \item Start \CGG{} up again.  Load credits.xml and make a change
458         to the Title and save again.
459         \item Exit \CGG{}; restart \CGG{}; load your master project and
460         now you will automatically see on the timeline the changes you just
461         made in the previous step.
462 \end{enumerate}
463
464 \section{Trimming}%
465 \label{sec:trimming}
466 \index{trim}
467
468 With some edits on the timeline it is possible to do trimming. By
469 trimming you shrink or grow the edit boundaries (\textit{head} or \textit{tail}) by dragging them. In
470 drag and drop mode or cut and paste mode, move the cursor over an
471 edit boundary until it changes shape. The drag handle \index{drag handles} shows as a
472 left or right facing fat arrow when you cursor near the clip start
473 or end.  If the cursor faces left, the dragging operation affects
474 the beginning of the edit. If the cursor faces right, the dragging
475 operation affects the end of the edit.
476
477 The effect of each drag operation not only depends on the behavior
478 button but whether the beginning or end of the edit is being
479 dragged. When you release the mouse button, the trimming operation
480 is performed.
481
482 For all file formats, other than still images, the extent of the
483 trimming operation is limited to the source file length. Attempting
484 to drag the start of the edit beyond the start of the source, limits
485 it to the source start. In all trimming operations, all edits which
486 start on the same position as the cursor when the drag operation
487 begins are affected. You have to disarm tracks in order to prevent
488 edits from being affected.
489
490 You have 6 different choices of which mouse button to use for
491 specific types of editing while using the drag handle.  You change
492 the drag handle mouse effects by using the \texttt{Settings
493         $\rightarrow$ Preferences  $\rightarrow$ Interface} tab and
494 modifying the Editing section as shown in the next
495 figure~\ref{fig:trim}. The drag handle affects not only the clip you
496 are working on but also frequently the entire duration of all clips
497 on the timeline.
498
499 \begin{figure}[htpb]
500         \centering
501         \includegraphics[width=0.5\linewidth]{trim.png}
502         \caption{Default choices for mouse: Ripple for button 1; Roll
503                 for button 2; Slip for button 3}
504         \label{fig:trim}
505 \end{figure}
506
507 A description of the fundamental/common terminology for choices
508 follows.
509
510 \begin{description}
511         \item[All Edits (ripple)] \index{trim!ripple} shorten or lengthen the start or end
512         of a single piece of media while moving all media to the right of
513         that clip up or down on the timeline correspondingly.  Timeline
514         duration is modified.  In a drag \textit{All Edits} operation, the
515         beginning of the edit either cuts data from the edit if you move it
516         forward or pastes new data from before the edit if you move it
517         backward. The end of the edit pastes data into the edit if you move
518         it forward or cuts data from the end of the edit if you move it
519         backward. All the following edits shift. If you drag the end of the
520         edit past the start of the edit, the edit is deleted.
521         \item[One Edit (roll)] \index{trim!roll} move the in and out point of a single
522         clip without changing the timeline duration. In a drag \textit{One
523                 Edit} operation, nothing is cut or pasted. If you move the beginning
524         or end of the edit forward, the source reference in the edit shifts
525         forward. If you move the beginning or end of the edit backward, the
526         source reference shifts backward. The edit remains in the same spot
527         in the timeline but the source shifts.
528         \item[Src Only (slip)] \index{trim!slip} move the in and out point of a single
529         clip without changing the timeline duration. In a drag \textit{Src
530                 Only} operation, nothing is cut or pasted. If you move the beginning
531         or end of the edit forward, the source reference in the edit shifts
532         forward. If you move the beginning or end of the edit backward, the
533         source reference shifts backward. The edit remains in the same spot
534         in the timeline but the source shifts.
535         \item[Slide] \index{trim!slide} a single clip is moved but retains its current in
536         and out point; however the out point of the clip to the left changes
537         and the in point of the clip to the right also changes.  Timeline
538         duration remains the same.
539         \item[Edge Left/Right] \index{trim!edge} moves the edge of the clips.
540         \item[No effect] no changes are made.  You might want to use
541         this choice to prevent accidental movements.
542 \end{description}
543
544 The next table displays the options and results
545 with the Key Table here first.
546
547 \begin{lstlisting}[style=sh]
548 s = src media start
549 p = proj position
550 l = length
551 c = cut distance
552 rest == p+=c: for rest of clips
553 01 = flags edits_moved, rest_moved
554 \end{lstlisting}
555
556 \renewcommand{\arraystretch}{1.15}
557 \begin{center}
558         %\caption{}
559         %\label{tab:}
560         % Tell table to adjust font to fix on the page using \resize    
561                 \begin{longtable}{lllll}
562                         \toprule
563                         &  & \textbf{Drag Left} & \textbf{Drag Right} &\\
564                         \midrule
565                         \multicolumn{2}{l}{\textit{curr s += c, l -= c; + rest}} & $\leftarrow$ & $\rightarrow$ & \textit{rest}\\
566                         abc12345xyz & \textbf{Ripple} left edge 11 $\rightarrow$ & abc012345xyz & abc2345xyz &\\
567                         \midrule
568                         \multicolumn{2}{l}{\textit{curr l += c; + rest}} & $\leftarrow$ & $\rightarrow$ & \textit{rest}\\
569                         abc12345xyz & \textbf{Ripple} right edge 01 $\rightarrow$ & abc1234xyz & abc123456xyz &\\
570                         \midrule
571                         \multicolumn{2}{l}{\textit{prev l += c; curr ps+= c, l -= c}} & $\leftarrow$ & $\rightarrow$ &\\
572                         abc12345xyz & \textbf{Roll} left edge 00 $\rightarrow$ & ab012345xyz & abcd2345xyz &\\
573                         \midrule
574                         \multicolumn{2}{l}{\textit{curr l += c; next ps+= c, l -= c}} & $\leftarrow$ & $\rightarrow$ &\\
575                         abc12345xyz & \textbf{Roll} right edge 00 $\rightarrow$ & abc1234wxyz & abc123456yz &\\
576                         \midrule
577                         \multicolumn{2}{l}{\textit{s -= c}} & $\leftarrow$ & $\rightarrow$ &\\
578                         abc12345xyz & \textbf{Slip} left edge 10 $\rightarrow$ & abc23456xyz & abc01234xyz &\\
579                         \midrule
580                         \multicolumn{2}{l}{\textit{s -= c}} & $\leftarrow$ & $\rightarrow$ &\\
581                         abc12345xyz & \textbf{Slip} right edge 10 $\rightarrow$ & abc23456xyz & abc01234xyz &\\
582                         \midrule
583                         \multicolumn{2}{l}{\textit{prev l += c; curr p+= c; next ps += c, l -= c}} & $\leftarrow$ & $\rightarrow$ &\\
584                         abc12345xyz & \textbf{Slide} left edge 10 $\rightarrow$ & ab012345wxyz & abcd12345yz &\\
585                         \midrule
586                         \multicolumn{2}{l}{\textit{prev l += c; curr p+= c; next ps += c, l -= c}} & $\leftarrow$ & $\rightarrow$ &\\
587                         abc12345xyz & \textbf{Slide} right edge 10 $\rightarrow$ & ab12345wxyz & abcd12345yz &\\
588                         \midrule
589                         \multicolumn{2}{l}{\textit{curr s -+= c, l += c; + rest}} & $\leftarrow$ & $\rightarrow$ & \textit{rest}\\
590                         abc12345xyz & \textbf{Edge} left edge 11 $\rightarrow$ & abc2345xyz & abc0123456xyz &\\
591                         \midrule
592                         \multicolumn{2}{l}{\textit{curr l -+= c; + rest}} & $\leftarrow$ & $\rightarrow$ & \textit{rest}\\
593                         abc12345xyz & \textbf{Edge} right edge 01 $\rightarrow$ & abc1234xyz & abc123456xyz &\\
594                         \bottomrule
595                 \end{longtable}
596 \end{center}
597 \renewcommand{\arraystretch}{1}
598
599 Next, a more immediate and colorful view shows these trimming
600 options (figure~\ref{fig:trim-color}).
601
602 \begin{figure}[htpb]
603         \centering
604         \includegraphics[width=0.8\linewidth]{trim-color.png}
605         \caption{The 5 types of Trim: note the different lengths of the results.}
606         \label{fig:trim-color}
607 \end{figure}
608
609 \paragraph{How to do a J-cut or L-cut} A J-cut \index{J-cut/L-cut} is a split edit film
610 editing technique in which the audio from a following scene overlaps
611 the picture from the preceding scene, so that the audio portion of
612 the later scene starts playing before its picture as a lead-in to
613 the visual cut.  An L-cut is a different split edit film editing
614 technique in which the audio from preceding scene overlaps the
615 picture from the following scene, so that the audio cuts after the
616 picture, and continues playing over the beginning of the next scene
617 (figure~\ref{fig:j-cut}). To do either a J-cut or an L-cut, you
618 first shorten the first or second video a little.  Then you block
619 the audio tracks from changing by disarming the appropriate tracks.
620 Finally use \textit{One Edit (roll)} the cutting edge off the
621 videos.  Moving to the right creates a J-cut and moving to the left
622 creates an L-cut.
623
624 \begin{figure}[htpb]
625         \centering
626         \includegraphics[width=0.8\linewidth]{j-cut.png}
627         \caption{J-cut to left and L-cut to right}
628         \label{fig:j-cut}
629 \end{figure}
630
631
632 \subsection{Split View in Compositor Using the Drag Handle with Trim}%
633 \label{sub:split_view_compositor_using_drag_trim}
634 \index{trim!split view}
635 The Trim Feature using the drag handle provides some good ways to
636 view your video while editing.  The playback position in the
637 compositor is updated live and the view in the compositor can be
638 split so that in the left half of the compositor you can see the
639 last frame of the left clip and in the right half the first frame of
640 the right clip.  Dragging edits can not be extended past the
641 beginning or the end.
642
643 First familiarize yourself with button operation; check your setup
644 by executing the following step.  In the \texttt{Settings
645         $\rightarrow$ Preferences $\rightarrow$ Interface} tab, Editing
646 section, clicking on the edit boundaries can be set for Button 1, 2,
647 3 as one of the following:
648
649 \textit{Ripple}; \textit{Roll}; \textit{Slip}; \textit{Slide};
650 \textit{Edge} or \textit{No effect}
651
652 Now to use this feature, create a track with edits that have trims
653 on the left and/or the right. The edit boundary can be modified
654 using \textit{drag handles} at the boundary between the edits
655 (figure~\ref{fig:trim-display}).
656
657 \begin{figure}[htpb]
658         \centering
659         \includegraphics[width=1\linewidth]{trim-display.png}
660         \caption{Split compositor screen showing the result of the Trim feature}
661         \label{fig:trim-display}
662 \end{figure}
663
664 \begin{description}
665         \item[Left Mouse Button (LMB) usage:] If you grab the edit
666         handle from the right side, you will see a left arrow and dragging
667         the boundary will modify the right edit playback starting time. If
668         you grab the edit handle from the left side, you will see a right
669         arrow and dragging the boundary will modify the left edit playback
670         ending time. In both cases, the composer will show the edit endpoint
671         of the changed edit.
672         \item[Shift LMB usage:] The effect on the edits is the same as
673         described above, but the composer will show a split screen of the
674         left and right edits as they appear at the drag handle
675         boundary. Dragging will only change one of the two images, since
676         only one edit is being changed.
677         \item[Middle Mouse Button (MMB) usage:] Both the left and the
678         right edit ending/starting times are updated.  The image shown in
679         the compositor will be drawn from the side of the drag grab, that is
680         the left if it is grabbed from the left, and the right if it is
681         grabbed from the right.
682         \item[Shift MMB usage:] The effect on the edits is the same as
683         described above, but the composer will show a split screen of the
684         left and right edits as they appear at the drag handle boundary.
685         Dragging will change both of the two images, since both edits are
686         being changed.
687         \item[Right Mouse Button (RMB) usage:] The start/end point of
688         the current edit is moved, but the edit length is unchanged only one
689         image changes since only one edit endpoint is view is updated.
690         \item[Shift RMB usage:] The effect on the edits is the same as
691         described above, but the composer will show a split screen of the
692         left and right edits as they appear at the drag handle boundary.
693         Dragging will only change one of the two images, since only one edit
694         is being changed.
695 \end{description}
696
697
698
699
700 \section{Nesting clips and assets}%
701 \label{sec:nesting_clips_and_assets}
702 \index{nested EDL}
703
704 \subsection{Nested Assets}%
705 \label{sub:nested_assets}
706 \index{nested assets}
707
708 A nested asset is an EDL session that
709 embeds an existing EDL session, all tracks, all plugins, editing,
710 and effects into a media object that appears as one audio/video
711 media object, no plugins, editing, or effects.  It is as if the
712 existing EDL was rendered, and loaded in its place.  This has
713 several interesting side effects.  First, you don’t have to render
714 the entire media file to see any portion.  Second, it requires no
715 rendering compute time or storage.  Third, it changes the precedence
716 of the composer so that you get more control over the projection and
717 automation, so that the results can be sent into another rendering
718 step, not simply part of the current stack.  It groups the plugin
719 stack in much the same way that an arithmetic expression is grouped
720 by parenthesis.
721
722 The EDL session and the rendered output are visually equivalent.
723 Nested assets allow for complex grouping and stacking of effects,
724 and makes media access much more flexible.  This feature can be used
725 recursively, that is, any number of sessions may be stacked and
726 referenced as an asset, as long as all of the rendering resources
727 are available.  Nested assets are added to the timeline by using the
728 pulldown \texttt{File $\rightarrow$ Load files}\dots on the main
729 menu and selecting the \textit{Insertion strategy} of \textit{Nest
730         asset}. The file will be pasted into the timeline over the current
731 selection or at the insertion point.
732
733 It is somewhat important to note that nested assets and nested clips
734 will have index files automatically created.  These index files can
735 start to clutter up your \texttt{\$HOME/.bcast5} directory with
736 files named \texttt{Nested\_\#\#\#.idx} and you may want to
737 periodically delete any index files which are no longer in use.
738
739 \subsection{Nested Clips}%
740 \label{sub:nested_clips}
741 \index{nested clips}
742
743  It is also possible to create
744 \textit{clips} and convert them to \textit{nested edl}.  This is
745 done by first creating a clip using the standard cut, clipboard,
746 paste, and/or edit panel buttons.  Now, using the resources
747 \textit{clip} folder, select a clip to be nested, and use the right
748 mouse button to select a clip.  This activates the clip popup menu.
749 Select the \textit{Nest to media} menu item, and the clip will be
750 converted to a \textit{Nested: Clip} and put in Media
751 folder. Conversely, you can select a \textit{Nested: Clip}, use the
752 \textit{EDL to clip} menu item, and the clip will be reverted to a
753 \textit{Clip}.  This works similarly to the group / un-group editing
754 features of many graphic design editing programs, but in this case
755 the groups are rendered compositions (figure~\ref{fig:nesting}).
756
757 Nested clips can be proxied and when they are, the resulting files
758 are placed in the user's \texttt{\$HOME/Videos} directory by default.  This
759 can be modified by changing
760
761 \texttt{Settings $\rightarrow$ Preferences $\rightarrow$ Interface}
762 tab, Nested Proxy Path.
763
764 \begin{figure}[htpb]
765         \centering
766         \includegraphics[width=1.0\linewidth]{nesting.png}
767         \caption{Nested clips in Timeline and Resources window}
768         \label{fig:nesting}
769 \end{figure}
770
771 \paragraph{Notes:} creating nested clips is a complicated internal process for \CGG{}, especially for managing audio tracks. Therefore you need to make sure you have your project set up as you expect before you start nesting with the \texttt{Nest to Media} command.  Below are several things to remember.
772
773 \begin{itemize}
774         \item The creation of the nested clip is based on the settings in \texttt{Settings $\rightarrow$ Format}. Be sure that the number of audio tracks and channels is the same as we want to have in the nested clip. In addition, it is better to make each audio track independent from the others (which could be linked in more than one channel) using the option: \texttt{Audio $\rightarrow$ Map 1:1}
775         \item You can do any editing on the nested clip once it is loaded to the timeline. For example we can start an OpenEDL \index{openEDL} session to make the changes. Once out of the OpenEDL session it may be that the changes made are not visible in the original nested clip. You can fix this by doing RMB on the nested clip in the \textit{Resources/Media} window and choosing \texttt{Rebuild index}. This process may take some time depending on the size of
776 the media; because of the additional time required to do this, it is not done automatically in order to allow the user to make the decision as to when they are done editing enough and need to see the exact results
777 in order to save time.
778         \item Because of the way the timeline thumbnails are displayed, after editing using OpenEDL of a
779 nested clip, the thumbnails of the video track may be redrawn and may look different and out of sync with the
780 way they did originally with respect to the audio waveforms. This is simply a result of the redrawing of the
781 video track which is independent from the redrawing of the audio tracks. The playback is still synchronized.
782 \end{itemize}
783
784 \paragraph{Usage Examples of Nested Clips}
785
786 \begin{description}
787         \item[Example 1:] You want to make a flashback/rewind at the end
788         of your video that represents a quick summary of the entire video in
789         black and white. On he timeline, you have 60 seconds of edits with
790         clips, cuts, zoom in, zoom out and any other edits. Now you want to
791         get this 60 seconds \textit{compressed} to 10 seconds, play in
792         reverse, and in black and white at the end of your video.  You would
793         copy the 60 seconds in a clip, nest the clip in the Clip folder of
794         the Resources window and drag it to the timeline. You will see only
795         a clean clip without all of the edits that were used to create it
796         because nesting display a clip without having to actually use the
797         Render menu.  Now you can add a Reverse effect, Color3way plugin for
798         black and white, and use the Speed auto to get the 60 seconds down
799         to only 10 seconds.
800         \item[Example 2:] You are working on a complex project with a
801         team in a separate location. You create some sub projects, i.e.\
802         sequences, that you or the team will use in the Master project to
803         merge the sequences in the right order and to make the final color
804         correction steps.
805 \end{description}
806
807 In each of the examples you can see the benefit of nesting to create
808 clean looking timelines because of the automatic rendering
809 capability of nesting.
810
811 \section{Multi-Camera / Mixer}%
812 \label{sec:multicamera_mixer}
813 \index{multi-camera}
814 \index{mixers}
815
816 Use the Mixer Viewer to see multiple media playing simultaneously in re-sizable mini-viewers.  This can be used in various ways and is useful to edit videos shot by multiple cameras from different viewpoints that were simultaneously recorded in order to create a single good video.  Everything will have to be initially synced so you can decide which one of the camera angles is best suited at any time. Mixer mode does not support audio only tracks but there is a workaround described at \nameref{cha:faq_problems_workarounds}.
817
818 The number of cameras/mixers you can have is generally limited to the available resources on your computer.  Currently, the number of File Descriptors available in the OS limits cameras to about 50.  If you have many \textit{mixer viewers} you will probably want to use proxy mode whenever possible.  Also, in the \texttt{Settings $\rightarrow$ Playback A} tab \textit{Video Out} section, uncheck \textit{play every frame} and choosing a Video Driver of \textit{X11} with \textit{use direct X11 render if possible} checked, will provide better performance.
819
820 Figure~\ref{fig:multicam01} shows 9 media sources in the left corner, the composed video in the right corner, the timeline with the top video track with pieces of the 9 overwrites, and the choice in Resources of Mixed.
821
822 \begin{figure}[htpb]
823         \centering
824         \includegraphics[width=1.0\linewidth]{multicam01.png}
825         \caption{Using Mixer capability in Cin for multiple cameras}
826         \label{fig:multicam01}
827 \end{figure}
828
829 \subsubsection*{Easiest Method to Getting Started}%
830 \label{ssub:easiest_method_started}
831
832 \begin{enumerate}
833         \item This method assumes all of your media or cameras are aligned the way you want them already.
834         \item From the \textit{File} pulldown, create a \textit{New project} with the desired format for Audio and Video output (or you can just use the default).
835         \item \texttt{File $\rightarrow$ Load} the media files you want to work with using \textit{Create new resources only}.
836         \item In the Resources window, with  the Media folder, highlight the list of media you want to \textit{Mix}. This is done using a ctrl or shift mouse button press as you would in a standard listbox selection.
837         \item Right click the mouse on the media selection and choose \textit{open mixers} \index{mixers!open mixers}. This opens multiple mixer viewer \index{mixers!viewer} windows, one for each media item that was highlighted.  You can
838         do them 1 at a time instead.  This also adds the source media tracks to the main window.
839         \item Now use the timeline \index{timeline} to play and you will see all viewers/cameras playing.  Stop when you get to the
840         end of the \textit{good} camera playback.
841         \item Simply double click the \textit{good} mixer viewer and from where you first started playing to the playback insertion pointer is the source section, which will be pasted in the destination video/audio tracks at the top of the new project.
842         \item Repeat steps 6-7.  Start playing again, stop when you want, double click the desired mini-viewer!
843 \end{enumerate}
844
845 \subsubsection*{Some Hints and Caveats}%
846 \label{ssub:hints_caveats}
847
848 \begin{itemize}
849         \item You can easily overwrite a section of the new track by \textit{selecting} a section on the timeline, then double click on one of the mini-viewers to overwrite/replace that section.
850         \item If you edit the output tracks, it only edits output tracks, and the input tracks may no longer be lined up.
851         \item You can add a silent section by selecting past a section and start overwriting that section from then on.
852         \item If you use the cursor hairline to create the selection endpoint, it must be past the end of the destination.
853         \item The compositor shows composed media.  This is the media that will be rendered.
854         \item The program always uses overwrite as the paste operation.
855         \item Use the timeline edit handles to move the start and end points of that section.
856         \item Only middle mouse drag handle operations should be used normally.
857         \item Other drags will displace the media source/destination timeline correspondence.
858         \item To re-tile the mixer windows after you have resized and moved them around, you can use the Window
859         pulldown of \textit{Tile mixers} or the shortcut of Alt-t.
860 \end{itemize}
861
862 \subsubsection*{But, I want to use only the first set of audio tracks\dots}%
863 \label{ssub:but_use_only_first_audio}
864
865 There are many cases where you may want to compose using media from several different tracks while using the the same audio tracks as associated from a specific viewer.  Since mixer source tracks can be updated any time by using a mixer toggle \index{mixers!toggle}, this makes it possible to do this.  
866
867 Procedure to update the mixer audio source track list:
868
869 \begin{enumerate}
870         \item Single click to highlight the mixer window you want to re-associate to the audio track.
871         \item In that audio track’s patchbay click the expand toggle, the arrow on the right side.
872         \item In the expanded pane that appears, there is another arrow on the left side.  This icon has the tooltip \textit{Mixer}.  Click this and because in step \#1 you highlighted the mixer window, it will now be toggled on.  Once you click the mixer icon it will then point up.
873         \item Now, disassociate any audio that is unwanted by expanding its patchbay and toggling off the mixer.
874 \end{enumerate}
875
876 \subsubsection*{Expert Usage}%
877 \label{ssub:expert_usage}
878
879 When you double click a mixer viewer window, it operates an \textit{overwrite} paste operation.  This moves \textit{src} (source) track edits to \textit{dst} (destination) track edits over the same selected timeline region.
880
881 \begin{itemize}[noitemsep]
882         \item \textit{Src tracks} should be not playable and not armed in the main window patchbay gui.
883         \item \textit{Dst tracks} should be playable and armed in the main window patchbay gui.
884 \end{itemize}
885
886 Each mixer viewer maintains a list of the tracks which will be used as src. This list is made visible selecting the window with the left mouse button.  When the mixer viewer is selected, a highlight is drawn around the media image.  All track patchbay \textit{mixer} toggles are updated to reflect the src tracks included in the selected viewer src track list. The \textit{play track} patchbay toggles can be used to manage the list.
887
888 \begin{itemize}[noitemsep]
889         \item \textit{Turning on} a toggle (pointing up) includes the track in the src track list.
890         \item \textit{Turning off} a toggle (pointing right) removes the track from the src track list.
891 \end{itemize}
892
893 New Mixer viewers can be created using the main menu \texttt{Window $\rightarrow$ Mixer Viewer}, or with a shortcut of \texttt{Shift-M}.  When a new viewer is created, the currently enabled patchbay \textit{mixer} toggles are used to create the viewer source track list.  The toggles are cleared after the window is created.  This is to improve the work flow.  Use the following list of steps to create individual mixer viewers.
894
895 To create a list of mixer viewers:
896
897 \begin{enumerate}
898         \item Setup the session \texttt{settings $\rightarrow$ format}, width, height, frame rate, color model, aspect ratio.
899         \item Create dst tracks using the a/v track pulldowns (or use shortcuts "t" / "T"),  armed and playable.
900         \item Append src tracks using \texttt{file $\rightarrow$ open $\rightarrow$ append tracks}, or the resource window using pasting.
901         \item Using the track patchbay, disarm editing and disable playback of the audio/video src tracks.
902         \item Using the track patchbay, mark the new tracks as \textit{mixer} source to be added to the viewer.
903         \item Create a mixer viewer using the main menu pulldown, or the shift "M” shortcut.
904         \item Repeat steps $3-6$ for each mixer viewer needed for the session editing.
905 \end{enumerate}
906
907 When you single click a mixer window, it becomes selected and highlighted and all of the patchbay mixer toggles are updated to reflect the state of the viewer’s src tracks.  Tracks that will be src are shown as enabled.  If you change a toggle, the src tracks for the selected window will be modified.  This means you can associate or dis-associate any media track to any mixer window.
908
909 When you double click a mixer window, an overwrite paste is invoked.  The mixer viewer’s src tracks are overwritten to the dst tracks.  The timeline region for both the source and destination are the same for the overwrite paste function.  The selection region is used if it is active.  If the selection is empty, that is it is a hairline, the selection region is from the end of the destination playable edits to the selection cursor hairline.  The hairline must be past the end of the playable edits on the destination tracks.
910
911 The mixer viewer configuration is saved with the session data.  When a saved session is loaded in \textit{replace project} or \textit{replace project and concatenate tracks}, the mixer viewer will be reopened.
912
913 \subsubsection*{Using Proxy with \textit{Open Mixers}}%
914 \label{ssub:using_proxy_open_mixers}
915
916 The best way to use proxy \index{proxy} with your multiple cameras is to follow the steps below:
917
918 \begin{enumerate}
919         \item Load media with insertion strategy of \textit{create resources only}.
920         \item Highlight the media in the Resources window and right click on this to choose \textit{open mixers}.
921         \item Use the \texttt{Settings $\rightarrow$ Proxy settings}\dots to bring up the proxy menu.
922         \item Choose the size and other options you want and click the checkmark OK. If you choose the option \textit{Beep when done} you will hear a short beep if all media is already proxied or a longer beep when all proxies have been created.
923         \item When your editing is complete, use \textit{Settings} pulldown and proxy to \textit{original size}.
924 \end{enumerate}
925 Instead of Open Mixers, you can Insert Mixers \index{mixers!insert mixers} with new tracks at the timeline insertion point.
926
927 \subsubsection*{Options available in the \textit{Mixer Windows}}%
928 \label{ssub:options_available_with_mixers}
929 \index{mixers!viewer RMB options}
930
931 There are several options you will see in each Mixer viewer \index{mixers!viewer} that help with using them. These
932 are shown in figure~\ref{fig:mixer-playable}. To use these, RMB in the desired mixer window,
933 and choose one of the options as described here.
934
935 \begin{figure}[htpb]
936         \centering
937         \includegraphics[width=1.0\linewidth]{mixer-playable.png}
938         \caption{A Mixer window showing available options with the white X designating no playing}
939         \label{fig:mixer-playable}
940 \end{figure}
941
942 \begin{enumerate}
943         \item Fullscreen / Windowed - will bring up a fullscreen display of that window or revert to the original size.
944         \item Resize Window - allows for resizing the window to a choice of different sizes.
945         \item Tile Mixers \index{mixers!tile mixers} - makes it easy to get all of the mixers nicely tiled to a standard size.
946         This is also available in the \textit{Window} pulldown.
947         \item Playable - enabled by default so that you will see a checkmark next to it in the 
948         popup.  The benefit of making a mixer window not playable is to save cpu time. When a specific
949         mixer window is unchecked, so not Playable, a white cross appears in the upper left hand corner
950         of the mixer.  To switch back to playing again, RMB and choose Playable and this will turn
951         playing back on. The program automatically updates the mixer image when the timeline cursor
952         stops or when it is moved to a different spot even when play is disabled. You can see the
953         white cross designating not playable in figure~\ref{fig:mixer-playable}. Statistics that show
954         the savings are as follows on a 16 cpu laptop:
955         \begin{verbatim}
956         5 Mixers all playing -- cpu usage = 1275
957         1 only playing       -- cpu usage =  405
958         2 only playing       -- cpu usage =  800
959         \end{verbatim}
960 \end{enumerate}
961
962 \subsubsection*{Mixers pulldown}%
963 \label{ssub:mixers_pulldown}
964
965 From Program windows menu we can access the \texttt{windows $\rightarrow$ mixers...} there are several entries available (see figure~\ref{fig:mixers-pulldown}):
966
967 \begin{figure}[htpb]
968         \centering
969         \includegraphics[width=0.5\linewidth]{mixers-pulldown.png}
970         \caption{Mixers...  pulldown}
971         \label{fig:mixers-pulldown}
972 \end{figure}
973
974 \begin{description}
975         \item[Mixer Viewer:] \index{mixers!viewer} (Shift-M) opens a new empty \textit{Mixer 1} window, which will then be associated with a track. We can open as many Mixers as we like.
976         \item[Drag Tile mixers:] \index{mixers!drag tile mixers} (Alt-t) the default size of a mixer window is related to the std size of the \textit{Viewer} window. If we want to modify it at our convenience, we can build a window of the desired size with the \textit{Drag Tile mixers} function and then automatically order our mixers within it with the right click of the mouse.
977         \item[Align mixers:] \index{mixers!align mixers} see \nameref{sub:audio_video_sync_waveform}
978         \item[Mix masters:] \index{mixers!mix masters} this feature makes it very easy to get into the multi-camera mixer mode after tracks have already been set up and edited. Before this addition, you could only \textit{Open Mixers} from original media assets in the \textit{Resources} window.
979         \item[Entries:] If the mixers of several sources have been opened, the entries of each assets will appear, useful for recalling a specific mixer window.
980 \end{description}
981
982 \subsection{Recover Mixer Windows}%
983 \label{sub:recover_mixer_windows}
984 \index{mixers!recover mixer window}
985
986 It is a hazard that you might accidentally \textit{undo} (\texttt{z or Ctrl-z}) too far and lose your mixer windows.  Here are the steps to recover.  It is recommended that you make a backup of your project before performing the recovery steps just in case there are other problems.
987
988 In the patchbay box to the left of the main timeline, there is a right pointing arrow on the right side.  This is called the \textit{Expander} (figure~\ref{fig:mixer-patchbay01}).  When you click on each expander, another line appears below that expander arrow and the timeline track height is slightly increased.  If you Shift-click on a single expander, the patchbay will expand for all of the tracks.
989
990 \begin{figure}[htpb]
991         \centering
992         \includegraphics[width=0.35\linewidth]{mixer-patchbay01.png}
993         \caption{Mixer  patchbay}
994         \label{fig:mixer-patchbay01}
995 \end{figure}
996
997 \begin{enumerate}
998         \item Expand all of the patchbay lines, either one by one, or Shift-click on one to do them all. This is so you can see the \textit{mixer} right pointing arrow on the second expanded line.    
999         \item Use the \textit{Window} pulldown and choose \textit{Mixer Viewer} to bring up a new mixer window.  Now you will be making an association between the mixer viewer and the track’s video.
1000         \item Click on the new mixer window to make sure it is highlighted with a white border. This designates it as the \textit{in use} mixer viewer.
1001         \item Set your play to the beginning of the video using the \textit{Home} key or \textit{Home} transport button.
1002         \item In the patchbay for a video track click on the \textit{mixer} arrow on the expanded $2^{nd}$ line which is a right facing arrow.  Now the arrow will point up.  If there are audio tracks with that video, click on each of its audio tracks \textit{mixer} arrow until they point up also.
1003         \item Next move your insertion pointer on the timeline where there is video.  Some of the time this just helps so that the new mixer viewer window gets redrawn and you can see that the images appear; but the image may not appear until the program does a redraw later.  Now the mixer viewer should be
1004         correctly associated.  Note if you have large video, give it some time to update.  You may have to click on the mixer viewer window if the image does not show.  You can always start over with that mixer if you encountered any problems.
1005         \item Click the arrows that are pointing up in that video and its audio so they go back to pointing right. That mixer viewer is complete so you need to do this to make sure the \textit{mixer} arrows are off.
1006 \end{enumerate}
1007
1008 Repeat steps 2 through 7 for each of the mixer viewers you need going down the patchbay starting on step 2 first with Mixer 1, then 2 to 7 steps for Mixer 2, then again run 2 to 7 for Mixer 3 and so on.
1009
1010 Sometimes the association does not stick initially.  If not, highlight the mixer viewer with the problem, change the mixer arrows to point up, and reassociate.
1011
1012 % For html, make sure using below is different from via in subsection
1013 \section{Audio/Video sync using Waveforms/Timecodes}%
1014 \label{sec:audio_video_sync}
1015 \index{audio/video sync}
1016
1017 \subsection{Audio/Video sync via Waveform}%
1018 \label{sub:audio_video_sync_waveform}
1019 \index{audio/video sync via waveform}
1020
1021 Multi-camera \index{multi-camera} footage of a single event can have various shots starting and ending at different times. So when the footage start times are different, you can use the mixer audio to synchronize the clips on the timeline. The program algorithm attempts to find and align automatically the waveforms of the media.
1022
1023 Synchronizing multiple camera videos based on audio tracks can be done with \CGG{} easily enough with the \texttt{Window $\rightarrow$ Mixers$\dots$ $\rightarrow$  Align mixers} option.  Align mixers brings up a window displaying your mixers, the currently selected Master Track, and a list of all of the Audio Tracks (figure~\ref{fig:mixer-align01}).  There is a limit of 32 audio tracks per each mixer (that should be enough!)
1024
1025 \begin{figure}[htpb]
1026         \centering
1027         \includegraphics[width=0.9\linewidth]{mixer-align01.png}
1028         \caption{Align Mixers window}
1029         \label{fig:mixer-align01}
1030 \end{figure}
1031
1032 Two different methods of aligning the audio for mixers are available. They are most easily referred to by the button that is pressed -- \textit{Match} and \textit{Match All}. There are also 2 methods of activating the alignment -- \textit{Apply} and \textit{Move}.  
1033
1034 \textit{Match} consists usually of the next set of steps to take advantage of this feature:
1035
1036 \begin{enumerate}
1037         \item Load your camera media with insertion strategy of \textit{resources only}
1038         \item Highlight in the Resources window, all of the media you want to mix.
1039         \item Right mouse button on one of the media and click on Open Mixers; all mixer windows come up.
1040         \item To arm the created mixer tracks and related audio tracks. They are automatically placed on the timeline disarmed. This is right for multi-cam but not for audio sync.
1041         \item Provide a small target audio pattern on the Master Track for syncing by marking with the In/Out points ([ and ]). NOTE: When choosing between the audio tracks to align the one that will have to work as Master, we must rigorously use the one with the right-most synchronization peak. This is because the Master track will be started at the beginning of the timeline. If during alignment the other tracks should move further to the left than the Master, they will be truncated at 00:00:00:000, finding no more space available, and will be shortened with loss of footage for the next multi-cam
1042         \item Make a selection on the timeline in which to look for the pattern. Left mouse click, then drag select and highlight a search time domain. 
1043         \item Use the \texttt{Window $\rightarrow$ Mixers$\dots$ $\rightarrow$  Align mixers} to bring up its dialog window.
1044         \item Highlight in the first listbox, the Mixer number you want to align. Click on \textit{Match}. This will take a few seconds so watch the rendering time percentage on the lower right hand side zoom panel. The buttons will be ghosted out until finished. Now note the changed values in the Audio Tracks listbox.
1045         \item If you are satisfied with the calculated Nudge values -- that is they are very close to $1.0$ -- in the Audio Tracks listbox and the audio track selected as the Master Track in the Master Track listbox, hit the \textit{Apply} button.
1046         \item If you plan on performing more alignment tasks, click on Checkpoint so you can go back to a previous step in case you make a mistake.
1047         \item Last, click on the OK green checkmark or to cancel click on the red X.  Or just close the gui.
1048         \item To disarm the mixer tracks and related audio tracks for the next multi-cam operations.
1049 \end{enumerate}
1050
1051 \paragraph{Reset} is used to start over with the current session data, not an undo.  This means you can use the match repeatedly to refine alignments.  All of the Audio Tracks listbox values will be reset.
1052
1053 \paragraph{Checkpoint} provides a method to create checkpoints that save the current state.  This is especially helpful while learning or doing more complicated operations where you might make a mistake or do not like the results and need to get back to a previous state.
1054
1055 \paragraph{Undo} is used to put the media back to a previous state on the timeline.  If you choose \textit{start over} the session will reload with the original, before any changes were applied.  You can also go back to any of your previous checkpoints that you created earlier which are listed there, such as \textit{chkpt 1}.
1056
1057 \paragraph{Match All}is used when you have several mixers, instead of only picking 1 to match, it picks the best match for EACH of the mixer tracks based on a single master track. So when you hit Apply, each track might move differently. You do not set In/Out points but you have to make a selection within which to match.
1058
1059 \paragraph{Apply} button will apply the nudges that were generated during the Match or Match All execution (figure~\ref{fig:mixer-align02}).
1060
1061 \begin{figure}[htpb]
1062         \centering
1063         \includegraphics[width=0.9\linewidth]{mixer-align02.png}
1064         \caption{Aligned mixer window after "Match". Note the Nudge amounts above.}
1065         \label{fig:mixer-align02}
1066 \end{figure}
1067
1068 \paragraph{Move} is very handy when you are using mixers, if you have an edit somewhere that you need to fix specifically without moving any of the other track pieces. In this case you have to select a section (like you do a group, but do not make a group), generate a match, and then you can just \textit{Move} that set only -- everything else stays where it is at its current location (figure~\ref{fig:mixer-align03}).
1069
1070 \begin{figure}[htpb]
1071         \centering
1072         \includegraphics[width=1.0\linewidth]{mixer-align03.png}
1073         \caption{Match setup for aligning by audio.  Note that [ ] are set over a sample waveform highlighted selection that includes that.}
1074         \label{fig:mixer-align03}
1075 \end{figure}
1076
1077 More detailed information follows about how this all works and the information in the dialog window.  It is important to know that the result of the calculation is \textit{best match} but you can still override the selections if you decide there is a better one.  The dialog window is split into 3 sections:
1078
1079 \begin{enumerate}
1080         \item \textit{Mixers} lists the mixers that are active by highlighting them all initially. You can decide that you do
1081         not want 1 or more mixers to be used in the correlation calculation by un-highlighting the one(s) that should not be used. In some cases you have to have at least 2 in order to align audio.
1082         \item \textit{Master Track} lists each of the audio tracks currently loaded for all of the mixers. You can decide to highlight a different audio track to be used as the master for correlation, but only 1 can be used. Remember to use the track with the right-most synchronization peak as the Master.
1083         \item \textit{Audio Tracks} lists each of the mixer audio tracks.  Again, you can highlight a different set of which
1084         mixer audio tracks that you want to use for the waveform correlation.  Any audio tracks that are not
1085         highlighted, that is \textit{turned off}, will not be considered in the correlation calculation.
1086 \end{enumerate}
1087
1088 The corresponding input position is determined by track input correlation.
1089
1090 The letter "R" in the Audio Tracks listbox represents the correlation value.  $R=1.0$ designates that if both the pattern and the matching section were in the highlighted area, they are completely correlated -- this is a good self-test to check.
1091 $Nudge=0.0$ means just that.
1092
1093 The header \textit{pos} stands for the timeline position. When the \textit{Apply} button is pressed, only the Mixers listbox is relevant at that time.
1094
1095 The Mixer with the master track generally does not move, everything else will be lined up (figure~\ref{fig:mixer-align04}).
1096
1097 \begin{figure}[htpb]
1098         \centering
1099         \includegraphics[width=1.0\linewidth]{mixer-align04.png}
1100         \caption{An audio Match is complete. Note the waveform is aligned.}
1101         \label{fig:mixer-align04}
1102 \end{figure}
1103
1104 \textit{Match All} option basically consists of the following steps:
1105
1106 \begin{enumerate}
1107         \item Highlight the Mixer to use in the Mixer listbox.
1108         \item Highlight the Master Track you want to use in the Master Track listbox.
1109         \item On the timeline, mark your selection on the Master Track.
1110         \item Click on the \textit{Match All} button.
1111         \item Note the nudge values to see if they make sense, and if so, press \textit{Apply}.
1112 \end{enumerate}
1113
1114 \textit{Match} option basic steps (just for comparison with Match All):
1115
1116 \begin{enumerate}
1117         \item Set the In/Out points [ ] of the target.
1118         \item On the timeline, mark your selection.
1119         \item Click on the \texttt{Match} button.
1120         \item Note the nudge values to see if they make sense, then press \textit{Apply} (or \textit{Move} when doing a group).
1121 \end{enumerate}
1122
1123 \subsection{Align Timecodes}%
1124 \label{sub:align_timecodes}
1125 \index{audio/video sync via timecodes}
1126 \index{align timecodes}
1127
1128 Align Timecodes is especially useful in the case where you create video with multiple cameras capable of recording a timecode in the metadata of each file.  Let’s say we have recorded three videos at the same time at a concert with each camera set up at unique positions and at different angles.   All of the cameras start recording at various times but were synchronized with the same master clock (\textit{Timecode Sync Generator} or \textit{Jam Sync timecode}) so that the recordings are timestamped with that synchronized time.  For example, the 3 cameras have embedded metadata as follows: \quad \textbf{camera 1} = 00:00:00:01 \quad \textbf{camera 2} = 00:00:10:07 \quad \textbf{camera 3} = 00:00:17:22
1129
1130 \begin{figure}[ht]
1131         \centering
1132         \includegraphics[width=1.0\linewidth]{timecode-01.png}
1133         \caption{Before sync}
1134         \label{fig:timecode-01}
1135 \end{figure}
1136
1137 Timecode synchronization is performed by the program when you choose the option \textit{Align Timecodes} and works in 2 steps. The first automatic step is to locate the earliest timecode \index{timecode} and the second step is to align the edits on the armed tracks using that time on the timeline. 
1138
1139 When you load in the three files to different tracks, they'll be placed on a timeline that starts from $00:00:00:00$ as usual. But, by middle mouse clicking (MMB) on any of the video tracks, you can view the timecode embedded at that point in that file.
1140
1141 To make it easy to align the videos onto the timeline manually, set the \textit{origin point}, that is the leftmost time index, of the timebar to the timecode of the earliest video.  For the 3 aforementioned cameras this would be camera 1 with a timeecode of $00:00:00:01$.  By using the \textit{clapboard} button on the main timeline, you can set $00:00:00:01$ as the start timecode. Then positioning the camera 1 video at the start of the timeline will line its frames up with the times on the timebar.
1142
1143 \begin{figure}[ht]
1144         \centering
1145         \includegraphics[width=1.0\linewidth]{timecode-02.png}
1146         \caption{Clapperboard button}
1147         \label{fig:timecode-02}
1148 \end{figure}
1149
1150 Similarly, using the middle mouse button to view the other 2 camera’s timecodes, you can position them  so their timecodes line up and now all three tracks will be in sync.  You can do this manually or simply do it automatically with the option under: \texttt{Tracks  $\rightarrow$  Align Timecodes}. See figure~\ref{fig:timecode-03}
1151
1152 \begin{figure}[ht]
1153         \centering
1154         \includegraphics[width=1.0\linewidth]{timecode-03.png}
1155         \caption{After sync}
1156         \label{fig:timecode-03}
1157 \end{figure}
1158
1159 Timecode synchronization in \CGG{} is based on the inclusion of an actual \textit{timecode} saved in
1160 the media as can be seen using the \texttt{ffprobe} or \texttt{mediainfo} command line. Examples are shown here:
1161
1162 \begin{lstlisting}[style=sh]
1163 # ffprobe tut1.mov
1164 Metadata:
1165 handler_name:   VideoHandler
1166 timecode:               00:00:20:01
1167
1168 # mediainfo mtb.mp4
1169 Time code of first frame:       11:05:49:41
1170 Time code, striped:             Yes
1171 Title:                          GoPro AVC
1172 \end{lstlisting}
1173
1174 Many newer cameras and media in a MOV container have valid timecodes often with SMPTE
1175 compliant start Timecode in Quicktime format, whereas others do not. Most low end cameras do not.
1176 When no timecode is present, various clock time values may be used to synchronize instead.
1177
1178 There are various types of timecodes and they are written in metadata in various ways. Because it is not clear which timecode in the file is the one to use or there is none, the precedence as described next is followed. The contexts, packets, streams, and data refer to the corresponding ffmpeg data or metadata objects:
1179
1180 \begin{enumerate}
1181         \item if the format context has a timecode use: \texttt{fmt\_ctx $\rightarrow$ timecode - 0}
1182         \item if the layer/channel has a timecode use: \texttt{st $\rightarrow$ timecode - (start\_time -nudge)}
1183         \item find the first program stream with video stream, and if the video stream has a timecode use:
1184         \texttt{st $\rightarrow$ timecode - (start\_time-nudge)}
1185         \item find timecode in any stream use: \texttt{st $\rightarrow$ timecode}
1186         \item read 100 packets, save \texttt{ofs=pkt.pts*st $\rightarrow$ time\_base - st $\rightarrow$ nudge}:
1187         \begin{itemize}
1188                 \item decode frame for video stream of the first program
1189                 \item if \texttt{frame $\rightarrow$ timecode} has a timecode use:\texttt{ frame $\rightarrow$ timecode - ofs}
1190                 \item if side\_data has gop (group of pictures) timecode use: \texttt{gop $\rightarrow$ timecode - ofs}
1191                 \item if side\_data has smpte timecode use: \texttt{smpte $\rightarrow$ timecode - ofs}
1192         \end{itemize}
1193         \item if the \texttt{filename/url} scans \texttt{*date\_time.ext} use: \texttt{date\_time} (yr, month, day, hr, min, sec, nanosecond)
1194         \item if stat (display file status) works on the \texttt{filename/url} use: \texttt{mtime} (modification time)
1195         \item finally, if none of the above are usable, then return \texttt{failure}
1196 \end{enumerate}
1197
1198 Operation of Align Timecodes includes the following options to help in your setup and review (figure~\ref{fig:timecode-04}):
1199
1200 \begin{figure}[ht]
1201         \centering
1202         \includegraphics[width=1.0\linewidth]{timecode-04.png}
1203         \caption{Timecode via MMB on track and via Resources windows/Info}
1204         \label{fig:timecode-04}
1205 \end{figure}
1206
1207 \begin{itemize}
1208         \item \textit{Align Timecodes} under the \textit{Tracks} pulldown
1209         \item \textit{Clapperboard} icon on the main timeline to set a timecode.
1210         \item Timecode option added to timebar choices (in timecode $hh:mm:ss:ff$) with use of the session frame
1211         rate as a time standard.
1212         \item Time Code Start in the Resources window on the bottom of \textit{Info} for the media if the timecode for that
1213         asset has been scanned and is known. You can scan the asset’s Timecode by using the middle mouse
1214         button on its track which then displays the timecode for that on the timebar (\texttt{MMB $\rightarrow$ Timecode}). Or you can use the shortcut \texttt{Ctrl+!}, after selecting the edit/track on the timeline.
1215 \end{itemize}
1216
1217 \paragraph*{Notes}
1218
1219 \begin{itemize}
1220         \item \textit{Align Timecodes} is a good first step to quickly sync media up either perfectly or roughly.
1221         \item Currently this is not known to function for syncing audio recorded on a separate audio device,
1222         because no test material was provided to ensure that this works.
1223         \item Disarmed tracks will not be affected by using \textit{Align Timecodes}.
1224         \item No edits or sections will get cut off on the left or elsewhere, unless the moved edits overlap.
1225         \item You can add a timecode to video using an \texttt{ffmpeg} command if you want to align a particular video
1226         which has no timecode to ones that do. For example:
1227 \end{itemize}
1228
1229 \begin{lstlisting}[style=sh]
1230 ffmpeg -i originalfile.mp4 -metadata timecode="14:36:08:29" -c copy newfile.mp4
1231
1232 # where "-i" is followed by the input filename
1233 # where "-metadata timecode" is followed by the timecode key
1234 # where "-c copy" just copies the video/audio to the following output filename
1235 \end{lstlisting}
1236
1237 \section{Subtitles}%
1238 \label{sec:subtitles}
1239 \index{subtitles}
1240
1241 \CGG{} can create subtitles directly in the timeline with the Subtitle tool. Subtitles are added by using the main window pulldown   \texttt{File $\rightarrow$ Subtitle} (Alt-y)  which brings up a window allowing you to type the filename of a previously generated text file containing the desired words/lines, the script.  After entering the filename, click \texttt{Load} to read in your script.  By creating a script file ahead of time, it lets you easily add dialog that was already written out and carefully edited for spelling and proper grammar.
1242
1243 The file must be plain text; a .srt or .sub can also be used, but only the text lines will be used and not the timecodes or comments. The format of the script/text input file has specific requirements as listed below:
1244
1245 \begin{itemize}
1246         \item Lines can be any length but they will be broken up to fit according to some criteria below.
1247         \begin{itemize}
1248                 \item Running text used as script lines will be broken into multiple lines.
1249                 \item The target line length is 60 characters.
1250                 \item Punctuation may be flagged to create an early break.
1251                 \item Single carriage return ends an individual script line.
1252                 \item Double carriage return indicates the end of a entry and helps to keep track of where you are.
1253         \end{itemize}
1254         \item The "\textit{=}" sign in column 1 indicates a comment seen in the script text to assist you in location.
1255         \item An "\textit{*}" at the beginning of the line is a comment and not a script line.
1256         \item \textit{Whitespace} at either the beginning of a script line or the end will be removed.
1257 \end{itemize}
1258
1259 Figure~\ref{fig:subtitle01} shows the Subtitle window you will see.
1260
1261 \begin{figure}[htpb]
1262         \centering
1263         \includegraphics[width=0.8\linewidth]{subtitle01.png}
1264         \caption{Subtitle window}
1265         \label{fig:subtitle01}
1266 \end{figure}
1267
1268 To put the subtitles onto your media, first add a subtitle track via the pulldown  \texttt{Tracks $\rightarrow$ Add subttl} (Shit-Y). In the Subtitle window, note that there are 2 major textboxes.  There is the \textit{Script Text} textbox showing the current entry of text from your input file and there is the \textit{Line Text} textbox showing the currently active text.  In your subtitle track, select a timeline region (in/out or drag select with hairline cursor/highlight or via labels or the \textit{selection start/length/end time} textboxes in the Zoom Panel) to indicate the region where you want the active Line Text to be pasted.  Then click the \texttt{Paste} button in the Subtitle window to paste the line onto the subtitle track.  Silence will be added to the subtitle track in the places in the media where there are gaps.
1269
1270 Editing in the Line Text box can be used to change the active script line. By double clicking the timeline over the subtitle track, you can reselect the active script line.  The subtitle text will be reloaded into the Line Text box and can be edited and re-pasted as the new active subtitle text.  You can also highlight multiple lines in the Script Text box and paste them (using the usual window paste methodology) into the Line Text box.  After pasting to the timeline, the Line Text box will be updated with the next script line.  In addition, if you triple click a line in the \textit{Script Text} box, it will automatically become the current line in the \textit{Line Text} box.
1271
1272 When you are finished, before clicking on \textit{Save}, you can specify the output format using the \textit{Format} drop-down button. You can choose between the classic \texttt{.udvd} (micro DVD) and the more universally supported \texttt{.srt} (subrip) and \texttt{.sub} (subviewer). The next step is to provide a legitimate filname in the \textit{Path} box; your current directory will be used if only a filename but no directory path is supplied.  The filename used will automatically have a "--" after it followed by the \textit{track label} and then \textit{udvd/srt/sub} extension added; any extension in the filename will be removed..  If you click OK before saving, the subtitle script position is saved with the session.  This is convenient for continuing where you left off.
1273
1274 To reposition the script, use the slider or tumbler buttons:
1275
1276 \textit{Slider} bar to move through the text entries quickly. \\
1277 \textit{Prev} or \textit{Next} buttons to go to the previous or next script line.
1278
1279 Figure~\ref{fig:subtitle02} shows what the pasted subtitle script looks like in a portion of the main window.
1280
1281 \begin{figure}[htpb]
1282         \centering
1283         \includegraphics[width=1.0\linewidth]{subtitle02.png}
1284         \caption{Subtitles on timeline}
1285         \label{fig:subtitle02}
1286 \end{figure}
1287
1288
1289