a few improved Recording images in Cakewalk theme
[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 \index{quickstart guide}
7
8 \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.
9
10 \subsection{Install the Software}%
11 \label{sub:install_software}
12
13 On the internet, click on the Download page at:
14 \begin{center}
15         {\small \url{https://cinelerra-gg.org/downloads/}}
16 \end{center}
17 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.
18
19 \begin{figure}[htpb]
20         \centering
21         \includegraphics[width=1.0\linewidth]{packages.png}             
22 \end{figure}
23
24 However, if you want to get going as quickly as possible, just do this so that everything is in 1 place:
25
26 \begin{itemize}[noitemsep]
27         \item Download your Operating System’s tar file from {\small \url{https://cinelerra-gg.org/download/tars/}} to \texttt{/tmp}.
28         \item Key in:  cd /name-of-directory-where-you-want-the-software (for example, \texttt{cd /software})
29         \item Key in:  \texttt{mkdir cin}
30         \item Key in:  \texttt{cd cin}
31         \item Key in:  \texttt{tar -xJf /tmp/cinelerra-5.1-*.txz}   (if you put the tar in \texttt{/tmp} AND replace * with full name)
32 \end{itemize}
33
34 \subsection{Start \CGG{}}%
35 \label{sub:start_cinelerra_gg}
36
37 Depending on how you installed the software, you can log in as root or as a user if you used a package.
38
39 \begin{itemize}[noitemsep]
40         \item Key in:  \texttt{/your-software-directory-path/bin/cin}
41         \item Or if you installed using the pkg method, click on the \textit{Cin icon}.
42 \end{itemize}
43
44 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.
45
46 \begin{figure}[htpb]
47         \centering
48         \includegraphics[width=1.0\linewidth]{4windows.png}
49         \caption{Clockwise: Viewer; Compositor; Resources and Main/Program/Timeline}    
50 \end{figure}
51
52 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.
53
54 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.
55
56 \subsection{Load Media}%
57 \label{sub:load_media}
58
59 On the main timeline program window are many pulldowns, the first of which is \textit{File}.
60
61 \begin{figure}[htpb]
62         \centering
63         \includegraphics[width=1.0\linewidth]{load_files.png}
64         \caption{Load media window -- note the icons top right for more options}        
65 \end{figure}
66
67 \begin{enumerate}
68         \item Click on \textit{File} for a list of available options and note that in the right hand column are shortcuts for
69         many of the options that will come in handy if you use \CGG{} often.
70         \item Next click on the second one down -- \textit{Load files$\dots$} -- which brings up the Load menu.
71         \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
72         side of the textbox, there is a down arrow which you use to navigate your file system.  Highlight the
73         desired file system and you will see that directory name appear in the textbox and the files below.
74         \item Scroll to the media file you would like to work on and highlight that file.  When you do, you will
75         see that filename also appear in the textbox below the listing of files.  You could have directly
76         keyed in that file in that textbox instead.
77         \item On the bottom of the Load menu, is a box called \textit{Insertion strategy}.  For getting started the
78         default of \textit{Replace current project} is sufficient.  But you can click on the down arrow to see what
79         is available for future use.
80         \item Now click on the green colored checkmark on the bottom left hand side to actually load the file
81         and see it appear on the timeline in \CGG{}’s main window and a single frame in the Compositor.
82         The first track will most likely be video thumbnails and the next tracks may be audio waveforms.
83         \item Press the space bar in the main Program window and your video will start playing and press the
84         space bar again to stop the play.  While playing, you should see the video in the Compositor
85         window in the upper right hand side of your screen and if you have your audio hooked up, you
86         will hear the sound.  To get back to the beginning of the video, hit the home key on your keyboard.
87 \end{enumerate}
88
89 \subsection{Choose Output Format}%
90 \label{sub:choose_output_format}
91         
92 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.
93
94 \begin{enumerate}
95         \item On the main timeline, use the \textit{Settings} pulldown (about the $7^{th}$ pulldown from the left side top) and
96         click on \textit{Format} which is the first option in that list.
97         \item A \textit{Set Format} menu will appear that shows what the current format is for your loaded media in an
98         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.
99         \item The \textit{Canvas size} is probably the only thing you will want to change here in order to get to the
100         most commonly viewable settings.  On the right hand side of the Width parameter is a down arrow. 
101         Left click the down arrow to see your options.
102         \item Highlight $1280\times720$ HD for a good common option.
103         \item Click OK to have this option take effect.  When you do, the Compositor window may change to fit
104         this option and may look wrong sized.
105 \end{enumerate}
106
107 \begin{figure}[htpb]
108         \centering
109         \includegraphics[width=0.7\linewidth]{format_setting.png}
110         \caption{Format menu to change settings}        
111 \end{figure}
112
113 \begin{enumerate}[resume]       
114         \item If the video now looks too small or too large in the Compositor, you will want to \textit{autoscale} it to
115         look correct when the new media is created.  To do this, mouse over to the Resources window in the
116         lower right hand corner and under the word Visibility, highlight \textit{Video Effects} to see some
117         plugins.
118         \item Mouse over the \textit{Auto Scale} icon, left click to highlight the words underneath the icon, and mouse
119         drag the icon to the timeline video track.  When you see a white colored outline show on that track,
120         drop the Auto Scale icon there and you will see that the video may now automatically scale to a
121         new value.  Click on the magnifying glass icon on the brown colored line beneath the main timeline
122         video which opens a new window.  In that window, again use the down arrow to choose $1280\times720$
123         HD, then dismiss this window.
124         \item If not needed, to remove the Auto Scale plugin, right mouse on the brown line and choose \textit{Detach}.
125 \end{enumerate}
126
127 \begin{figure}[htpb]
128         \centering
129         \includegraphics[width=0.5\linewidth]{magnifier.png}
130         \caption{Effect brown bar with magnifier}       
131 \end{figure}
132
133 \subsection{View and Listen}%
134 \label{sub:view_listen}
135
136 \begin{figure}[htpb]
137         \centering
138         \includegraphics[width=1.0\linewidth]{pulldown_button.png}
139         \caption{Menu pulldowns at the top with Transport buttons below.  Note the yellow tooltips too.}        
140 \end{figure}
141
142 \begin{enumerate}
143         \item On the second line, below the pulldowns, are transport buttons to move back and forth on the
144         timeline and play forward or reverse, fast or slow, or a single frame.  When you mouse over one of
145         these buttons, a yellow colored tooltip appears to tell you its function along with a key shortcut
146         inside of parenthesis.  When you left click the mouse on the transport button it starts the play and 
147         click again to stop it.  As you use these buttons, watch the Compositor to watch your video.
148         \item On the timeline, you only see thumbnails and not every single picture.  You may want to
149         use your keyboard’s \textit{down arrow} to expand the thumbnails and the \textit{up arrow} to unexpand them -- on
150         United States keyboard, the arrow keys are generally together on the lower right hand side of the
151         keyboard, a little to the right of the space bar.  This is a more cpu intensive operation and for very
152         large video can be time-consuming.
153 \end{enumerate}
154
155 \subsection{Edit/Compose}%
156 \label{sub:edit_compose}
157
158 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.
159
160 \begin{figure}[htpb]
161         \centering
162         \includegraphics[width=1.0\linewidth]{some_editing.png}
163         \caption{From left to right:\textit{ Audio 1} is disarmed --  BandSlide transition in \textit{Video 1} -- A highlighted section.}       
164 \end{figure}
165
166 \begin{enumerate}
167         \item You should look at the \textit{Edit} pulldown - $2^{nd}$ from the upper left on the main timeline to see the
168         most common options to use.  The first option in the list is \texttt{Undo} followed by a terse comment of  
169         the last operation that you performed that can be undone.
170         \item To delete a section of video/audio is described next.  Various ways to do that are available but the
171         easiest is to move your mouse and left click at the beginning of the section you want to delete on the
172         timeline and while holding down the left mouse button, drag to the end of the section to be deleted. 
173         When you do this, a white colored highlighted section becomes visible.  Use the \textit{Edit} pulldown and
174         choose the \textit{split/cut} option to cut out the highlighted area (note the shortcut of "x").  Remember if you
175         cut the wrong thing out you can always use the Edit pulldown to Undo that.
176         \item To add a transition where there is deleted section which may make your video look disjointed, do
177         the following.   Go back to the Resources window in the bottom right hand corner.  Change to
178         \textit{Video Transitions} by highlighting that underneath the word \textit{Visibility}.  Highlight a transition like
179         \textit{BandSlide} with the left button mouse click, hold down and drag to the video track and when you see
180         a white colored box around the area that you deleted above, drop the icon.  Right mouse click the
181         icon on the track to vary some parameters like length.
182         \item  To insert another clip from a different video, first you have to load the other video on another track.
183         Go to \textit{File} pulldown again and choose the \textit{Load files} option.  Type in a directory at the top again and
184         erase any specific file that you may have chosen previously in the bottom 2 textboxes.  It is very
185         important to now change the Insertion strategy to \textit{Append in new tracks} or you will write over
186         your current work.  But if you make this mistake, you can use the Edit pulldown and Undo that!
187         \begin{enumerate}
188                 \item Once the new video is on the track below your current work, you want to work with only this new 
189                 track, so disarm your other tracks by looking to the left of each track’s timeline and click the $2^{nd}$ 
190                 button beneath the track name, for example Video 1 or Audio 1.  The track name textbox will turn
191                 red to remind you that the track has been disarmed.  The boxed area is called the patchbay.
192                 \item Move to the area you want to make a clip of on your newly loaded track, hold down the left mouse
193                 button and drag the area to be made into a clip which will turn the color white.  Remember, you
194                 disarmed the other tracks so only this track is relevant at this time.  On the second line of the main
195                 window to the right of the transport buttons, are action buttons and as you mouse over them a
196                 yellow colored tooltip explains its purpose.  Find the one that says \textit{To clip} which is on the right
197                 hand side of the right bracket symbol.
198                 \item Click on \textit{To clip} and a small window comes up which you can comment in, but you do not have
199                 to, so just click on the green checkmark and now you will have a clip.
200                 \item Disarm that new track and re-arm your original tracks so you can go back to working on them
201                 \item Move your cursor to the spot in your original video where you want to insert the clip.   Make a
202                 \textit{Split} with the \textit{Split | Cut} option.
203                 \item Go to the Resources window and under the word Visibility, highlight \textit{Clips} so you can see your
204                 recently created clip in the box to the right.  Highlight that clip and drag it to where you did the
205                 blade cut and drop it in.
206         \end{enumerate}
207 \end{enumerate}
208
209 \begin{figure}[htpb]
210         \centering
211         \includegraphics[width=1.0\linewidth]{title_color.png}
212         \caption{Compositor + Title menu for setting parameters + the Color Picker.}    
213 \end{figure}
214
215 \begin{enumerate}[resume]
216         \item To add a Title or any wording you will use the \textit{Title} plugin.  In the Resources window, under the
217         word \textit{Visibility}, highlight \textit{Video Effects}.  In the box to the right, many plugin icons appear.   Scroll
218         to the right using the scroll bar at the bottom of the Resources window to locate Title.  Highlight the
219         \textit{Title} icon and drag/drop to your video track.  By now your video track may be in sections as you
220         deleted, added blade cuts, and inserts so where you drop the Title icon will be surrounded with a
221         white colored box.  It will take effect in that entire area so you may want to highlight a section as
222         usual with left mouse click on the timeline and drag to the end of the desired area.
223         \begin{enumerate}
224                 \item Right click on the brown colored bar that appeared below your video track to get to options and
225                 then left click on \textit{Show} to get the Title window to appear.
226                 \item Now for the fun part.  First type in some words in the bottom large text box just to see what it
227                 does.  There are so many variable parameters here and they are a lot of fun to play around with.
228                 \item You can dismiss the Title window when finished BUT be sure to leave the brown colored Title bar
229                 on the track.  And if you enabled the \textit{drag} feature, you should disable it so you do not forget.
230                 \item Right mouse click on the bottom Text box to see many more interesting parameters.
231         \end{enumerate}
232 \end{enumerate}
233
234 \subsection{Back up your work}%
235 \label{sub:backup_your_work}
236
237 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.
238
239 \subsection{Create your new media}%
240 \label{sub:create_new_media}
241
242 \begin{enumerate}
243         \item Once again in the main Program window, click on the \textit{File} pulldown and highlight/click the \texttt{Render}
244         option which is about the $9^{th}$ option down from the top of the list.  A \CGG{} Render menu will
245         appear.
246         \item First key in the first textbox the file to render to under \textit{Select a file to render to}.
247         \item For the \textit{File Format}, click on the down arrow and select FFMPEG (because this is the most
248         commonly used format; later you may want to experiment with others).  To the right of that box,
249         click on the down arrow and highlight \texttt{mp4} -- again because this is common.  When you click on 
250         mp4, notice that if there is an extension to your filename in the \textit{file to render to} above, it may
251         change it to mp4 and if there is none, it will add \texttt{.mp4} because that is what is expected.
252         \item Make sure there is a red colored checkmark next to the words Audio and Video right below if you
253         have/want both audio and video.  To the left of that checkmark box, is a symbol that looks like a
254         wrench.  Click on this for Audio just to see the default Preset options which are just fine so dismiss
255         the menu.  Then click on the wrench for Video and check Pixels by using the down arrow to the
256         right to be yuv420p -- this is most commonly usable option.  And click on the green checkmark.
257         \item Check the Insertion Strategy in the Render Menu window.  You might want to change that to
258         a different strategy than the default of \textit{Append in new tracks}.  If not, then when the Render is done,
259         your new video will automatically be loaded in another set of tracks below your work tracks.  Click
260         on the green checkmark in the lower left corner to start the render.
261         \item As the render is running, you will see the video play by in the Compositor.  Rendering is usually
262         slow, especially with plugins added.
263 \end{enumerate}
264
265 \subsection{Play your new media}%
266 \label{sub:play_your_new_media}
267
268 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.