Olaf fix in settings so can cut and paste from pdf file
[goodguy/cin-manual-latex.git] / parts / Quickstart.tex
1 \chapter{QuickStart}%
2 \label{cha:Quickstart}
3
4 \section{\CGG{} Quick Start Guide}%
5 \label{sec:cin_quick_start_guide}
6
7 \CGG{} is a software program NLE, Non-Linear Editor, that provides a way to edit, record, and play audio or video media on Linux.   It can also be used to color correction, retouch photos, motion tracking, watch TV, and create DVDs.
8
9 \subsection{Install the Software}%
10 \label{sub:install_software}
11
12 On the internet, click on the Download page at:
13 \begin{center}
14         {\small \url{https://cinelerra-gg.org/downloads/}}
15 \end{center}
16 Here you will see several Operating System distro packages that are already built for you to download.  Click on your preference and read the specific instructions for usage.
17
18 \begin{figure}[htpb]
19         \centering
20         \includegraphics[width=1.0\linewidth]{packages.png}             
21 \end{figure}
22
23 However, if you want to get going as quickly as possible, just do this so that everything is in 1 place:
24
25 \begin{itemize}[noitemsep]
26         \item Download your Operating System’s tar file from {\small \url{https://cinelerra-gg.org/download/tars/}} to \texttt{/tmp}.
27         \item Key in:  cd /name-of-directory-where-you-want-the-software (for example, \texttt{cd /software})
28         \item Key in:  \texttt{mkdir cin}
29         \item Key in:  \texttt{cd cin}
30         \item Key in:  \texttt{tar -xJf /tmp/cinelerra-5.1-*.txz}   (if you put the tar in \texttt{/tmp} AND replace * with full name)
31 \end{itemize}
32
33 \subsection{Start \CGG{}}%
34 \label{sub:start_cinelerra_gg}
35
36 Depending on how you installed the software, you can log in as root or as a user if you used a package.
37
38 \begin{itemize}[noitemsep]
39         \item Key in:  \texttt{/your-software-directory-path/bin/cin}
40         \item Or if you installed using the pkg method, click on the \textit{Cin icon}.
41 \end{itemize}
42
43 You will now see 4 separate windows appear.  The top 2 windows from left to right are the Viewer which is most useful for previewing clips and media and the Compositor which displays the current working frame at the timeline position.  The bottom 2 windows are the \CGG{} Program, also called the timeline, which is where the real work gets done and the Resources window showing a selection of media or effects.
44
45 \begin{figure}[htpb]
46         \centering
47         \includegraphics[width=1.0\linewidth]{4windows.png}
48         \caption{Clockwise: Viewer; Compositor; Resources and Main/Program/Timeline}    
49 \end{figure}
50
51 Any of these windows can be resized to better suit your needs.  Note that if your system’s native language is not English, some of the words you see on the screen will be correctly translated for you, others will be in english, and some will have not very good translations.
52
53 It is important to know that \CGG{} does not directly change your media.  It writes all changes to what is called the EDL, Edit Decision List.  This way you original media remains completely intact.
54
55 \subsection{Load Media}%
56 \label{sub:load_media}
57
58 On the main timeline program window are many pulldowns, the first of which is \textit{File}.
59
60 \begin{figure}[htpb]
61         \centering
62         \includegraphics[width=1.0\linewidth]{load_files.png}
63         \caption{Load media window -- note the icons top right for more options}        
64 \end{figure}
65
66 \begin{enumerate}
67         \item Click on \textit{File} for a list of available options and note that in the right hand column are shortcuts for
68         many of the options that will come in handy if you use \CGG{} often.
69         \item Next click on the second one down -- \textit{Load files$\dots$} -- which brings up the Load menu.
70         \item Below \textit{Select files to load} on the top left side is a textbox and if you look all the way to the right
71         side of the textbox, there is a down arrow which you use to navigate your file system.  Highlight the
72         desired file system and you will see that directory name appear in the textbox and the files below.
73         \item Scroll to the media file you would like to work on and highlight that file.  When you do, you will
74         see that filename also appear in the textbox below the listing of files.  You could have directly
75         keyed in that file in that textbox instead.
76         \item On the bottom of the Load menu, is a box called \textit{Insertion strategy}.  For getting started the
77         default of \textit{Replace current project} is sufficient.  But you can click on the down arrow to see what
78         is available for future use.
79         \item Now click on the green colored checkmark on the bottom left hand side to actually load the file
80         and see it appear on the timeline in \CGG{}’s main window and a single frame in the Compositor.
81         The first track will most likely be video thumbnails and the next tracks may be audio waveforms.
82         \item Press the space bar in the main Program window and your video will start playing and press the
83         space bar again to stop the play.  While playing, you should see the video in the Compositor
84         window in the upper right hand side of your screen and if you have your audio hooked up, you
85         will hear the sound.  To get back to the beginning of the video, hit the home key on your keyboard.
86 \end{enumerate}
87
88 \subsection{Choose Output Format}%
89 \label{sub:choose_output_format}
90         
91 You can skip this step if you want the format of your output to be the same as your input.  However, to create output media that is widely viewable on many platforms, to include phones and television, you should set your format accordingly.
92
93 \begin{enumerate}
94         \item On the main timeline, use the \textit{Settings} pulldown (about the $7^{th}$ pulldown from the left side top) and
95         click on \textit{Format} which is the first option in that list.
96         \item A \textit{Set Format} menu will appear that shows what the current format is for your loaded media in an
97         Audio and a Video tab.  In the United States, the Video Frame rate is usually expected to be 29.970     and usually the Color model is only changed if you have a personal preference.
98         \item The \textit{Canvas size} is probably the only thing you will want to change here in order to get to the
99         most commonly viewable settings.  On the right hand side of the Width parameter is a down arrow. 
100         Left click the down arrow to see your options.
101         \item Highlight $1280\times720$ HD for a good common option.
102         \item Click OK to have this option take effect.  When you do, the Compositor window may change to fit
103         this option and may look wrong sized.
104 \end{enumerate}
105
106 \begin{figure}[htpb]
107         \centering
108         \includegraphics[width=0.7\linewidth]{format_setting.png}
109         \caption{Format menu to change settings}        
110 \end{figure}
111
112 \begin{enumerate}[resume]       
113         \item If the video now looks too small or too large in the Compositor, you will want to \textit{autoscale} it to
114         look correct when the new media is created.  To do this, mouse over to the Resources window in the
115         lower right hand corner and under the word Visibility, highlight \textit{Video Effects} to see some
116         plugins.
117         \item Mouse over the \textit{Auto Scale} icon, left click to highlight the words underneath the icon, and mouse
118         drag the icon to the timeline video track.  When you see a white colored outline show on that track,
119         drop the Auto Scale icon there and you will see that the video may now automatically scale to a
120         new value.  Click on the magnifying glass icon on the brown colored line beneath the main timeline
121         video which opens a new window.  In that window, again use the down arrow to choose $1280\times720$
122         HD, then dismiss this window.
123         \item If not needed, to remove the Auto Scale plugin, right mouse on the brown line and choose \textit{Detach}.
124 \end{enumerate}
125
126 \begin{figure}[htpb]
127         \centering
128         \includegraphics[width=0.5\linewidth]{magnifier.png}
129         \caption{Effect brown bar with magnifier}       
130 \end{figure}
131
132 \subsection{View and Listen}%
133 \label{sub:view_listen}
134
135 \begin{figure}[htpb]
136         \centering
137         \includegraphics[width=1.0\linewidth]{pulldown_button.png}
138         \caption{Menu pulldowns at the top with Transport buttons below.  Note the yellow tooltips too.}        
139 \end{figure}
140
141 \begin{enumerate}
142         \item On the second line, below the pulldowns, are transport buttons to move back and forth on the
143         timeline and play forward or reverse, fast or slow, or a single frame.  When you mouse over one of
144         these buttons, a yellow colored tooltip appears to tell you its function along with a key shortcut
145         inside of parenthesis.  When you left click the mouse on the transport button it starts the play and 
146         click again to stop it.  As you use these buttons, watch the Compositor to watch your video.
147         \item On the timeline, you only see thumbnails and not every single picture.  You may want to
148         use your keyboard’s \textit{down arrow} to expand the thumbnails and the \textit{up arrow} to unexpand them -- on
149         United States keyboard, the arrow keys are generally together on the lower right hand side of the
150         keyboard, a little to the right of the space bar.  This is a more cpu intensive operation and for very
151         large video can be time-consuming.
152 \end{enumerate}
153
154 \subsection{Edit/Compose}%
155 \label{sub:edit_compose}
156
157 There may be sections of your media that you want to delete, or audio that is hard to hear and needs to be enhanced, or there is a need for a descriptive title that you want to add.  Here are a few basics.  But first be sure that you are in \textit{cut and paste} mode (this is the default) by checking to verify that you see a gold color around the “I” i-beam mode icon as in the figure above.  If the arrow to the left is gold, you are in \textit{drag and drop} mode so switch to \textit{cut and paste} by clicking on the “I” instead.
158
159 \begin{figure}[htpb]
160         \centering
161         \includegraphics[width=1.0\linewidth]{some_editing.png}
162         \caption{From left to right:\textit{ Audio 1} is disarmed --  BandSlide transition in \textit{Video 1} -- A highlighted section.}       
163 \end{figure}
164
165 \begin{enumerate}
166         \item You should look at the \textit{Edit} pulldown - $2^{nd}$ from the upper left on the main timeline to see the
167         most common options to use.  The first option in the list is \texttt{Undo} followed by a terse comment of  
168         the last operation that you performed that can be undone.
169         \item To delete a section of video/audio is described next.  Various ways to do that are available but the
170         easiest is to move your mouse and left click at the beginning of the section you want to delete on the
171         timeline and while holding down the left mouse button, drag to the end of the section to be deleted. 
172         When you do this, a white colored highlighted section becomes visible.  Use the edit pulldown and
173         choose the \textit{split/cut} option to cut out the highlighted area (note the shortcut of "x").  Remember if you
174         cut the wrong thing out you can always use the Edit pulldown to Undo that.
175         \item To add a transition where there is deleted section which may make your video look disjointed, do
176         the following.   Go back to the Resources window in the bottom right hand corner.  Change to
177         \textit{Video Transitions} by highlighting that underneath the word \textit{Visibility}.  Highlight a transition like
178         \textit{BandSlide} with the left button mouse click, hold down and drag to the video track and when you see
179         a white colored box around the area that you deleted above, drop the icon.  Right mouse click the
180         icon on the track to vary some parameters like length.
181         \item  To insert another clip from a different video, first you have to load the other video on another track.
182         Go to \textit{File} pulldown again and choose the \textit{Load files} option.  Type in a directory at the top again and
183         erase any specific file that you may have chosen previously in the bottom 2 textboxes.  It is very
184         important to now change the Insertion strategy to \textit{Append in new tracks} or you will write over
185         your current work.  But if you make this mistake, you can use the Edit pulldown and Undo that!
186         \begin{enumerate}
187                 \item Once the new video is on the track below your current work, you want to work with only this new 
188                 track, so disarm your other tracks by looking to the left of each track’s timeline and click the $2^{nd}$ 
189                 button beneath the track name, for example Video 1 or Audio 1.  The track name textbox will turn
190                 red to remind you that the track has been disarmed.  The boxed area is called the patchbay.
191                 \item Move to the area you want to make a clip of on your newly loaded track, hold down the left mouse
192                 button and drag the area to be made into a clip which will turn the color white.  Remember, you
193                 disarmed the other tracks so only this track is relevant at this time.  On the second line of the main
194                 window to the right of the transport buttons, are action buttons and as you mouse over them a
195                 yellow colored tooltip explains its purpose.  Find the one that says \textit{To clip} which is on the right
196                 hand side of the right bracket symbol.
197                 \item Click on \textit{To clip} and a small window comes up which you can comment in, but you do not have
198                 to, so just click on the green checkmark and now you will have a clip.
199                 \item Disarm that new track and re-arm your original tracks so you can go back to working on them
200                 \item Move your cursor to the spot in your original video where you want to insert the clip.   Make a
201                 \textit{Split} with the \textit{Split | Cut} option.
202                 \item Go to the Resources window and under the word Visibility, highlight \textit{Clips} so you can see your
203                 recently created clip in the box to the right.  Highlight that clip and drag it to where you did the
204                 blade cut and drop it in.
205         \end{enumerate}
206 \end{enumerate}
207
208 \begin{figure}[htpb]
209         \centering
210         \includegraphics[width=1.0\linewidth]{title_color.png}
211         \caption{Compositor + Title menu for setting parameters + the Color Picker.}    
212 \end{figure}
213
214 \begin{enumerate}[resume]
215         \item To add a Title or any wording you will use the \textit{Title} plugin.  In the Resources window, under the
216         word \textit{Visibility}, highlight \textit{Video Effects}.  In the box to the right, many plugin icons appear.   Scroll
217         to the right using the scroll bar at the bottom of the Resources window to locate Title.  Highlight the
218         \textit{Title} icon and drag/drop to your video track.  By now your video track may be in sections as you
219         deleted, added blade cuts, and inserts so where you drop the Title icon will be surrounded with a
220         white colored box.  It will take effect in that entire area so you may want to highlight a section as
221         usual with left mouse click on the timeline and drag to the end of the desired area.
222         \begin{enumerate}
223                 \item Right click on the brown colored bar that appeared below your video track to get to options and
224                 then left click on \textit{Show} to get the Title window to appear.
225                 \item Now for the fun part.  First type in some words in the bottom large text box just to see what it
226                 does.  There are so many variable parameters here and they are a lot of fun to play around with.
227                 \item You can dismiss the Title window when finished BUT be sure to leave the brown colored Title bar
228                 on the track.  And if you enabled the \textit{drag} feature, you should disable it so you do not forget.
229                 \item Right mouse click on the bottom Text box to see many more interesting parameters.
230         \end{enumerate}
231 \end{enumerate}
232
233 \subsection{Back up your work}%
234 \label{sub:backup_your_work}
235
236 At this time, or even earlier if you think you might make a mistake or if you are concerned about computer crashes, you should save your work.  Use the \textit{File} pulldown, and you can use \textit{Save as} to designate a directory and filename.  Then click the green checkmark.  You are saving the EDL which is the set of changes that you have made -- this file is separate from your original media.
237
238 \subsection{Create your new media}%
239 \label{sub:create_new_media}
240
241 \begin{enumerate}
242         \item Once again in the main Program window, click on the \textit{File} pulldown and highlight/click the \texttt{Render}
243         option which is about the $9^{th}$ option down from the top of the list.  A \CGG{} Render menu will
244         appear.
245         \item First key in the first textbox the file to render to under \textit{Select a file to render to}.
246         \item For the \textit{File Format}, click on the down arrow and select FFMPEG (because this is the most
247         commonly used format; later you may want to experiment with others).  To the right of that box,
248         click on the down arrow and highlight \texttt{mp4} -- again because this is common.  When you click on 
249         mp4, notice that if there is an extension to your filename in the \textit{file to render to} above, it may
250         change it to mp4 and if there is none, it will add \texttt{.mp4} because that is what is expected.
251         \item Make sure there is a red colored checkmark next to the words Audio and Video right below if you
252         have/want both audio and video.  To the left of that checkmark box, is a symbol that looks like a
253         wrench.  Click on this for Audio just to see the default Preset options which are just fine so dismiss
254         the menu.  Then click on the wrench for Video and check Pixels by using the down arrow to the
255         right to be yuv420p -- this is most commonly usable option.  And click on the green checkmark.
256         \item Check the Insertion Strategy in the Render Menu window.  You might want to change that to
257         a different strategy than the default of \textit{Append in new tracks}.  If not, then when the Render is done,
258         your new video will automatically be loaded in another set of tracks below your work tracks.  Click
259         on the green checkmark in the lower left corner to start the render.
260         \item As the render is running, you will see the video play by in the Compositor.  Rendering is usually
261         slow, especially with plugins added.
262 \end{enumerate}
263
264 \subsection{Play your new media}%
265 \label{sub:play_your_new_media}
266
267 The file you created in the Render step should now be playable.  You can test this in \CGG{} most easily by going to the Resource window in the lower right corner, clicking on the Media folder, and dragging and dropping the last video to the Viewer window.  There is a separate set of transport buttons on the bottom on that screen to use for playing.
268
269 \section{YouTube with \CGG{}}%
270 \label{sec:youtube_with_cinelerra}
271
272 To create a youtube or dailymotion video, you can easily follow the steps below.  You will have to learn a lot more about \CGG{} to take full advantage of its capabilities and make some really special videos, but this is just to get a start and to see the possibilities.
273
274 \begin{enumerate}
275         \item Start \CGG{}; usually you can do this by clicking on \CGG{} icon or key in \texttt{{cin\_path}/bin/cin}.
276         \item In the Program window on the lower left side of your screen, left mouse click the \textit{File} pulldown.
277         \item You will see \textit{Load files} as the second choice so left mouse click this and find your video file to
278         load, highlight it, and check the green checkmark in the lower left hand corner to get it loaded.
279         \item Edit your video in the Program window using the basic commands of:
280         \begin{itemize}
281                 \item play and then stop using the space bar
282                 \item move the mouse and then left click to move the insertion (location) pointer
283                 \item cut a section out by holding down the left mouse and drag, then key in “x” to cut or “c” to copy
284                 \item paste a copy or cut section by moving the insertion pointer, then key in “v”
285         \end{itemize}
286     \item Add a title by highlighting the \textit{Video Effects} in the right hand side Resources window; then
287     highlighting the \textit{Title} icon and dragging it to the Program window video track and dropping.
288     \item Click on the middle icon button (looks like a magnifying glass) on the brown colored Title bar to
289     bring up the Title window bottom text box and key in a title.
290     \item Use the \textit{File} pulldown to select \textit{Render} to create the desired video.  In the \textit{Render} window just next to the empty box to the right of the \textit{ffmpeg} file format, click on the down arrow shown there
291     to see the choices and pick \textit{youtube}.  Then move back up to key in the path and filename to render
292     to.  It will pick all of the defaults automatically for you so then just click on the green checkmark to
293     have it start.  There is a progress bar in the main window, very bottom of the right hand side.
294     \item Key in “q” in the main window to get out of \CGG{} and yes or no to save your edit session.
295 \end{enumerate}
296
297 Youtube will allow the upload of the resulting rendered file as named.  However, Dailymotion requires that the file be named with an acceptable extension so you must rename the output file to have the extension of .webm instead of .youtube
298
299 There are currently 6 specific variations within the ffmpeg (file format) / youtube (file type) for different video options.  You see these when you click on the wrench to the right of the word Video and then the Compression down arrow in the Video Preset window.  The first 3 are based on Webm/Vp9\protect\footnote{credit by Frederic Roenitz} and contain basic comments of usage and where to find more information.
300
301 The first 3 below, plus any of the VP9 files under the file type of \textit{webm} are the recommended options to use because they are freely usable in any circumstance.
302
303 \begin{center}
304         \begin{tabular}{l p{8cm}}
305                 sd.youtube & Standard Definition use with default audio/Opus stereo.youtube \\
306                 hd.youtube & High Definition “ “ \\
307                 uhd.youtube & Ultra High Definition “ “ \\
308         \end{tabular}
309 \end{center}
310
311 Alternatives based on h264 and for non-commercial use are listed below.  For Dailymotion, these must be renamed to have a different extension of .mp4 instead of .youtube before uploading.
312
313 \begin{center}
314         \begin{tabular}{l p{8cm}}
315                 sd\_h264.youtube & Standard Definition – must change to audio stereo\_with\_h264.youtube \\
316                 hd\_h264.youtube & High Definition -          “ “ \\
317                 uhd\_u264.youtube & Ultra High Definition - “ “ \\
318         \end{tabular}
319 \end{center}