\chapter{QuickStart}% \label{cha:Quickstart} \section{\CGG{} Quick Start Guide}% \label{sec:cin_quick_start_guide} \index{quickstart guide} \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. \subsection{Install the Software}% \label{sub:install_software} On the internet, click on the Download page at: \begin{center} {\small \url{https://cinelerra-gg.org/downloads/}} \end{center} 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. \begin{figure}[htpb] \centering \includegraphics[width=1.0\linewidth]{packages.png} \end{figure} However, if you want to get going as quickly as possible, just do this so that everything is in 1 place: \begin{itemize}[noitemsep] \item Download your Operating System’s tar file from {\small \url{https://cinelerra-gg.org/download/tars/}} to \texttt{/tmp}. \item Key in: cd /name-of-directory-where-you-want-the-software (for example, \texttt{cd /software}) \item Key in: \texttt{mkdir cin} \item Key in: \texttt{cd cin} \item Key in: \texttt{tar -xJf /tmp/cinelerra-5.1-*.txz} (if you put the tar in \texttt{/tmp} AND replace * with full name) \end{itemize} \subsection{Start \CGG{}}% \label{sub:start_cinelerra_gg} Depending on how you installed the software, you can log in as root or as a user if you used a package. \begin{itemize}[noitemsep] \item Key in: \texttt{/your-software-directory-path/bin/cin} \item Or if you installed using the pkg method, click on the \textit{Cin icon}. \end{itemize} \begin{figure}[htpb] \centering \includegraphics[width=1.0\linewidth]{Fenstergrundposition-en.png} \caption{Clockwise: Viewer; Compositor; Resources and Main/Program/Timeline} \end{figure} 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. 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. 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. Before you get startedi here is a note about \textit{Context Help}. If you need more detailed information on a window, menu, button or other particular GUI element than is shown in the tooltip, press Alt/h hotkey and the HTML page in your configured web browser will display the documentation for the item currently under the mouse. \subsection{Load Media}% \label{sub:load_media} On the main timeline program window are many pulldowns, the first of which is \textit{File}. \begin{figure}[htpb] \centering \includegraphics[width=1.0\linewidth]{load.png} \caption{Load media window -- note the icons top right for more options} \end{figure} \begin{enumerate} \item Click on \textit{File} for a list of available options and note that in the right hand column are shortcuts for many of the options that will come in handy if you use \CGG{} often. \item Next click on the second one down -- \textit{Load files$\dots$} -- which brings up the Load menu. \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 side of the textbox, there is a down arrow which you use to navigate your file system. Highlight the desired file system and you will see that directory name appear in the textbox and the files below. \item Scroll to the media file you would like to work on and highlight that file. When you do, you will see that filename also appear in the textbox below the listing of files. You could have directly keyed in that file in that textbox instead. \item On the bottom of the Load menu, is a box called \textit{Insertion strategy}. For getting started the default of \textit{Replace current project} is sufficient. But you can click on the down arrow to see what is available for future use. \item Now click on the green colored checkmark on the bottom left hand side to actually load the file and see it appear on the timeline in \CGG{}’s main window and a single frame in the Compositor. The first track will most likely be video thumbnails and the next tracks may be audio waveforms. \item Press the space bar in the main Program window and your video will start playing and press the space bar again to stop the play. While playing, you should see the video in the Compositor window in the upper right hand side of your screen and if you have your audio hooked up, you will hear the sound. To get back to the beginning of the video, hit the home key on your keyboard. \end{enumerate} \subsection{Choose Output Format}% \label{sub:choose_output_format} 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. \begin{enumerate} \item On the main timeline, use the \textit{Settings} pulldown (about the $7^{th}$ pulldown from the left side top) and click on \textit{Format} which is the first option in that list. \item A \textit{Set Format} menu will appear that shows what the current format is for your loaded media in an 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. \item The \textit{Canvas size} is probably the only thing you will want to change here in order to get to the most commonly viewable settings. On the right hand side of the Width parameter is a down arrow. Left click the down arrow to see your options. \item Highlight $1280\times720$ HD for a good common option. \item Click OK to have this option take effect. When you do, the Compositor window may change to fit this option and may look wrong sized. \end{enumerate} \begin{figure}[htpb] \centering \includegraphics[width=0.7\linewidth]{set-format.png} \caption{Format menu to change settings} \end{figure} \begin{enumerate}[resume] \item If the video now looks too small or too large in the Compositor, you will want to \textit{autoscale} it to look correct when the new media is created. To do this, mouse over to the Resources window in the lower right hand corner and under the word Visibility, highlight \textit{Video Effects} to see some plugins. \item Mouse over the \textit{Auto Scale} icon, left click to highlight the words underneath the icon, and mouse drag the icon to the timeline video track. When you see a white colored outline show on that track, drop the Auto Scale icon there and you will see that the video may now automatically scale to a new value. Click on the magnifying glass icon on the brown colored line beneath the main timeline video which opens a new window. In that window, again use the down arrow to choose $1280\times720$ HD, then dismiss this window. \item If not needed, to remove the Auto Scale plugin, right mouse on the brown line and choose \textit{Detach}. \end{enumerate} \begin{figure}[htpb] \centering \includegraphics[width=0.8\linewidth]{magnifier.png} \caption{Effect blue bar with magnifier} \end{figure} \subsection{View and Listen}% \label{sub:view_listen} \begin{figure}[htpb] \centering \includegraphics[width=1.0\linewidth]{pulldown_button.png} \caption{Menu pulldowns at the top with Transport buttons below. Note the colored tooltips too.} \end{figure} \begin{enumerate} \item On the second line, below the pulldowns, are transport buttons to move back and forth on the timeline and play forward or reverse, fast or slow, or a single frame. When you mouse over one of these buttons, a colored tooltip appears to tell you its function along with a key shortcut inside of parenthesis. When you left click the mouse on the transport button it starts the play and click again to stop it. As you use these buttons, watch the Compositor to watch your video. \item On the timeline, you only see thumbnails and not every single picture. You may want to use your keyboard’s \textit{down arrow} to expand the thumbnails and the \textit{up arrow} to unexpand them -- on United States keyboard, the arrow keys are generally together on the lower right hand side of the keyboard, a little to the right of the space bar. This is a more cpu intensive operation and for very large video can be time-consuming. \end{enumerate} If you need more detailed information on a button or other particular GUI element than is shown in the tooltip, press Alt/h hotkey and the HTML page in your configured web browser will display the documentation for the item currently under the mouse. \subsection{Edit/Compose}% \label{sub:edit_compose} 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. \begin{figure}[htpb] \centering \includegraphics[width=1.0\linewidth]{some_editing.png} \caption{From left to right: Audio 1 is disarmed -- BandSlide transition in Video 1 -- A highlighted section.} \end{figure} \begin{enumerate} \item You should look at the \textit{Edit} pulldown - $2^{nd}$ from the upper left on the main timeline to see the most common options to use. The first option in the list is \texttt{Undo} followed by a terse comment of the last operation that you performed that can be undone. \item To delete a section of video/audio is described next. Various ways to do that are available but the easiest is to move your mouse and left click at the beginning of the section you want to delete on the timeline and while holding down the left mouse button, drag to the end of the section to be deleted. When you do this, a white colored highlighted section becomes visible. Use the \textit{Edit} pulldown and choose the \textit{split/cut} option to cut out the highlighted area (note the shortcut of "x"). Remember if you cut the wrong thing out you can always use the Edit pulldown to Undo that. \item To add a transition where there is deleted section which may make your video look disjointed, do the following. Go back to the Resources window in the bottom right hand corner. Change to \textit{Video Transitions} by highlighting that underneath the word \textit{Visibility}. Highlight a transition like \textit{BandSlide} with the left button mouse click, hold down and drag to the video track and when you see a white colored box around the area that you deleted above, drop the icon. Right mouse click the icon on the track to vary some parameters like length. \item To insert another clip from a different video, first you have to load the other video on another track. Go to \textit{File} pulldown again and choose the \textit{Load files} option. Type in a directory at the top again and erase any specific file that you may have chosen previously in the bottom 2 textboxes. It is very important to now change the Insertion strategy to \textit{Append in new tracks} or you will write over your current work. But if you make this mistake, you can use the Edit pulldown and Undo that! \begin{enumerate} \item Once the new video is on the track below your current work, you want to work with only this new track, so disarm your other tracks by looking to the left of each track’s timeline and click the $2^{nd}$ button beneath the track name, for example Video 1 or Audio 1. The track name textbox will turn red to remind you that the track has been disarmed. The boxed area is called the patchbay. \item Move to the area you want to make a clip of on your newly loaded track, hold down the left mouse button and drag the area to be made into a clip which will turn the color white. Remember, you disarmed the other tracks so only this track is relevant at this time. On the second line of the main window to the right of the transport buttons, are action buttons and as you mouse over them a colored tooltip explains its purpose. Find the one that says \textit{To clip} which is on the right hand side of the right bracket symbol. \item Click on \textit{To clip} and a small window comes up which you can comment in, but you do not have to, so just click on the green checkmark and now you will have a clip. \item Disarm that new track and re-arm your original tracks so you can go back to working on them \item Move your cursor to the spot in your original video where you want to insert the clip. Make a \textit{Split} with the \textit{Split | Cut} option. \item Go to the Resources window and under the word Visibility, highlight \textit{Clips} so you can see your recently created clip in the box to the right. Highlight that clip and drag it to where you did the blade cut and drop it in. \end{enumerate} \end{enumerate} \begin{figure}[htpb] \centering \includegraphics[width=1.0\linewidth]{title_color.png} \caption{Compositor + Title menu for setting parameters + the Color Picker.} \end{figure} \begin{enumerate}[resume] \item To add a Title or any wording you will use the \textit{Title} plugin. In the Resources window, under the word \textit{Visibility}, highlight \textit{Video Effects}. In the box to the right, many plugin icons appear. Scroll to the right using the scroll bar at the bottom of the Resources window to locate Title. Highlight the \textit{Title} icon and drag/drop to your video track. By now your video track may be in sections as you deleted, added blade cuts, and inserts so where you drop the Title icon will be surrounded with a white colored box. It will take effect in that entire area so you may want to highlight a section as usual with left mouse click on the timeline and drag to the end of the desired area. \begin{enumerate} \item Right click on the brown colored bar that appeared below your video track to get to options and then left click on \textit{Show} to get the Title window to appear. \item Now for the fun part. First type in some words in the bottom large text box just to see what it does. There are so many variable parameters here and they are a lot of fun to play around with. \item You can dismiss the Title window when finished BUT be sure to leave the brown colored Title bar on the track. And if you enabled the \textit{drag} feature, you should disable it so you do not forget. \item Right mouse click on the bottom Text box to see many more interesting parameters. \end{enumerate} \end{enumerate} \subsection{Back up your work}% \label{sub:backup_your_work} 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. \subsection{Create your new media}% \label{sub:create_new_media} \begin{enumerate} \item Once again in the main Program window, click on the \textit{File} pulldown and highlight/click the \texttt{Render} option which is about the $9^{th}$ option down from the top of the list. A \CGG{} Render menu will appear. \item First key in the first textbox the file to render to under \textit{Select a file to render to}. \item For the \textit{File Format}, click on the down arrow and select FFMPEG (because this is the most commonly used format; later you may want to experiment with others). To the right of that box, click on the down arrow and highlight \texttt{mp4} -- again because this is common. When you click on mp4, notice that if there is an extension to your filename in the \textit{file to render to} above, it may change it to mp4 and if there is none, it will add \texttt{.mp4} because that is what is expected. \item Make sure there is a red colored checkmark next to the words Audio and Video right below if you have/want both audio and video. To the left of that checkmark box, is a symbol that looks like a wrench. Click on this for Audio just to see the default Preset options which are just fine so dismiss the menu. Then click on the wrench for Video and check Pixels by using the down arrow to the right to be yuv420p -- this is most commonly usable option. And click on the green checkmark. \item Check the Insertion Strategy in the Render Menu window. You might want to change that to a different strategy than the default of \textit{Append in new tracks}. If not, then when the Render is done, your new video will automatically be loaded in another set of tracks below your work tracks. Click on the green checkmark in the lower left corner to start the render. \item As the render is running, you will see the video play by in the Compositor. Rendering is usually slow, especially with plugins added. \end{enumerate} \subsection{Play your new media}% \label{sub:play_your_new_media} 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. \section{Overview on Formats and Codecs}% \label{sec:overview_formats} \index{format} \index{codec} Here is an overview of the formats (also called containers) and codecs that are used in \CGG{}, by ffmpeg and the internal engine. Roughly speaking these are divided into uncompressed codecs (or codecs with \textit{Intraframe} compression, which can be lossy or lossless) and compressed codecs of \textit{Interframe} type (LongGOP, almost always with lossy compression). The All-I (intraframe) codecs are suitable for editing because a cut or other operation on the timeline corresponds to the exact frame on which you are operating. The interframe types use Groups of Pictures (GOP) and a cut or other operation is accurate (and requires no further calculation) only if it coincides with the beginning of the GOP, and not with an internal frame. There is also color compression: Color Space \textit{bit-depth} and \textit{Chroma-Subsampling} for YUV models. In addition, heavy compression requires the system to do more encoding/decoding work on the timeline. High quality codecs have high bit rates and bit depths but this also affects the performance of the system, not to mention the increased disk space usage. Some formats implement both audio and video streams, others audio only or video only. \subsection{Video FFmpeg Formats}% \label{sec:FFmpeg_video} FFmpeg supports hundreds of codecs and formats. Some are proprietary and cannot be implemented in FFmpeg or can be voluntarily compiled as non-free; others are proprietary but their use is free; finally there are the Open formats/codecs, fully supported and well documented. We are only describing here a selection of the most well-known and most frequently used ones. \subsubsection{High Quality} \label{ssub:ffmpeg_video_high_quality} High quality formats are also called Mezzanine codecs, Digital Intermediate, Preservation codecs or Editing codecs. These have no compression or intraframe lossless or near-lossless compression and are suitable for editing, post-processing, mastering and archiving. They are also used for the interchange of files between different programs. They take up a lot of disk space and require a powerful system. \begin{description} \item[MKV] Open, highly configurable and extensively documented. Can have seeking problems. Belongs to the Matroska family. \newline Presets: \textit{ffv1, ffvyuv} \item[MXF] Created by Avid. It is probably the best and most advanced container for editing. \newline Presets: \textit{DNxHR, ffv1, AVC\_Intra\_100} \item[MOV] Created by Apple. It is a suitable format for editing because it organizes the files within the container into hierarchically structured \textit{atoms} described in a header. This brings simplicity and compatibility with various software and does not require continuous encoding/decoding in the timeline. \newline Presets: \textit{DNxHR, ffv1, CineformHD, huffyuv} \item[PRO] Different extension, but it is still mov. Prores is proprietary and there are no official encoders except the original Adobe one. The engine used by ffmpeg is the result of reverse engineering and, according to Adobe, does not guarantee the same quality and performance of the original\protect\footnote{https://support.apple.com/en-us/HT200321}. \newline Presets: \textit{ProRes} \item[QT] Different extension, but it is always mov. \newline Presets: \textit{DNxHD, magicyuv, raw, utvideo} \item[MP4] mostly used for General Purpose. It belongs to the large MPEG family. \newline Presets: \textit{AVC\_Intra\_100} \item[RGB] Raw format. \newline Presets: \textit{raw} \item[YUV] Raw format. \newline Presets: \textit{raw} \item[AVI] Old and limited format (no multi streams, no subtitles, limited metadata) but with high compatibility. \newline Presets: \textit{ffv1} \end{description} \subsubsection{General Purpose} \label{ssub:ffmpeg_video_general_purpose} These are also called Delivery codecs. They are the most used and widespread being suitable for streaming, video sharing, watching TV, smartphones, plus more. Because of lossy compression type Interframe, they produce smaller files with variable quality. They are not suitable for editing, compositing and color correction. Further rendering of these formats worsens the quality exponentially. The most used codecs have hardware support (vaapi, vdpau, nvenc) that make them more efficient. \begin{description} \item[MOV] Created by Apple. It is a suitable format for editing because it organizes the files within the container into hierarchically structured "atoms" described in a header. This brings simplicity and compatibility with various software and does not require continuous encoding/decoding in the timeline. \newline Presets: \textit{Presets: mov} \item[QT] Different exstension, but it is always mov. \newline Presets: \textit{mjpeg, DV, Div, CinePack} \item[MP4] The most popular. Many other formats belong to this family (MPEG); \newline h264 is actually x264, open, highly configurable and documented; h265/HEVC is actually x265, open, highly configurable and documented. x264-5 is for encoding only. \newline Presets: \textit{h265, h265, mjpeg, mpeg2, obs2youtube} \item[WEBM] Open; similar to mp4 but not as widespread (it is used by YouTube). It belongs to the Matroska family. In \CGG{} there are specific Presets with \texttt{.youtube} extension, but they are still webm. \newline Presets: \textit{VP8, VP9, AV1} \item[MKV] Open, highly configurable and widely documented. It might have seeking problems. It belongs to the Matroska family. \newline Presets: \textit{Theora, VP8, VP9} \item[AVI] Old and limited format (no multistreams, no subtitles, limited metadata) but with high compatibility. \newline Presets: \textit{asv, DV, mjpeg, xvid} \item[MPG] Parent of the MPEG family, to which MP4 also belongs. Mpeg is used by \CGG{} as default for proxies and mpeg-2 is the standard for Video DVDs. \newline Presets: \textit{mpeg, mpeg2} \end{description} \subsubsection{Image Sequences} \label{ssub:ffmpeg_image_sequences} The image sequences can be uncompressed, with lossy or lossless compression but always Intraframe. They are suitable for post-processing that is compositing (VFX) and color correction. \begin{description} \item[DPX] Film standard; uncompressed; high quality. \textit{Log} type. \item[PNG] Uncompressed or lossless compression. Supports alpha channel. \item[WEBP, TIFF, GIF, JPEG, ...] Variable compression, size and quality. \end{description} \subsubsection{Old Pro Formats} \label{ssub:ffmpeg_old_pro_formats} Some formats, though used in the past in the pro field, are disappearing with the evolution of technologies. DVD is becoming more and more niche, while Bluray is still widespread (also as a backup); DV/HDV remains only as a support for old Camcorders with magnetic tapes. DV is still a quality format, with intraframe compression; HDV is mpeg-2 compressed. \begin{description} \item[AVI] old and limited format but with high compatibility. \newline Presets: \textit{DV\_pal, DV\_ntsc, mjpeg} \item[QT] belongs to the Apple mov family. \newline Presets: \textit{DV, mjpeg} \item[M2TS] format for Bluray (mpeg4). Bluray player devices need a standard Bluray disc structure (bdwrite) for playback\protect\footnote{\CGG{} offers specific functionality for creating DVDs/Blurays}. \newline Presets: \textit{AVC422, Lossless, Bluray, hevc} \item[MP4] Belongs to the MPEG family. Motionjpeg has jpeg compression, then Intraframe, so it maintains good quality and fluidity in editing. It is now an old and limited codec. \newline Presets: \textit{mjpeg} \end{description} \subsection{Audio FFmpeg Formats}% \label{sub:FFmpeg_audio} Audio formats and codecs take much less resources and space than video ones, so they are often used without compression for maximum quality. However these are compressed formats and codecs widely used in streaming and sharing. \subsubsection{High Quality} \label{ssub:ffmpeg_audio_high_quality} \begin{description} \item[FLAC] Open; used for storing music. It has lossless compression. \newline preset: \textit{flac} \item[PCM] Raw format that encodes the signal with \textit{modified pulse modulation} (pcm). FFmpeg does not support pcm audio if you use mp4 as a container. \newline Presets: \textit{s8, s16, s24, s32} \item[WAV] Raw format created by Microsoft. 32-bit addressing leading to the 4 GB recording limit. It is a widely used standard. \newline Presets: \textit{s24le, s32le} \item[W64] Wave format created by Sony to override the 4GB recording limit. Poorly supported. \newline Presets: \textit{s16le, s24le, s32le} \item[MKA] Open, highly configurable and documented. It belongs to the Matroska family. Uncompressed pcm type. \newline Presets: \textit{s16le, s24le, s32le} \end{description} \subsubsection{General Purpose} \label{ssub:ffmpeg_audio_general_purpose} \begin{description} \item[MP3] Belongs to the MPEG family. The most widely used in streaming and sharing. \newline preset: \textit{mp3} \item[OGG] Open, highly configurable and documented. It belongs to the Matroska family. Flac has lossless compression; opus is compressed but modern and of good quality, superior to mp3. Vorbis is compressed and dated, but lightweight and compatible. \newline Presets: \textit{flac, opus, vorbis} \item[PRO] Created by Apple; compressed audio codec, competing with mp3. \newline Presets: \textit{aac256k} \end{description} \subsection{\CGG{} Internal Engine}% \label{sub:internal_engine} FFmpeg is the default engine, but you can also use its internal engine, which is limited in supported formats but efficient and of high quality. \subsubsection{Video general purpose} \label{ssub:internal_general_purpose} \begin{description} \item[RAW DV] supports the DV standard. \newline Presets: \textit{dv} \item[MPEG Video] highly configurable. Extension \texttt{.m2v}. \newline Presets: \textit{mpeg1, mpeg2} \item[OGG Theora/Vorbis] Open, easily configurable. Theora for video, Vorbis for audio. \newline Presets: \textit{theora, vorbis} \end{description} \subsubsection{Image Sequences} \label{sub:internal_image_sequences} There are quite a few formats available. \begin{description} \item[EXR Sequence] OpenEXR (Open Standard) is a competing film standard to DPX, but \textit{Linear} type. \item[Ppm Sequence] is RGB Raw. \item[Tga Sequence] is RGB(A) compressed or uncompressed. \item[Tiff Sequence] is RGB(A) or RGB(A)-Float with various compression types. \item[Jpg, gif Sequences] lossy compressed and limited formats. \end{description} \subsubsection{Audio general purpose} \label{sub:internal_audio_general_purpose} \begin{description} \item[AC3] widely used multichannel standard (Dolby Digital). Format with lossy compression. \newline Presets: \textit{ac3} \item[Apple/SGI AIFF] Created by Apple; is an uncompressed format (pcm type) or with 32/64-bit floating point compression. \newline Presets: \textit{aif} \item[Sun/Next AU] created by Sun and used in Unix environment, now in disuse. It can be of pcm type or with lossy compression. \newline Presets: \textit{au} \item[Flac] Open, lossless compression, very good quality. \newline preset: \textit{flac} \item[Microsoft WAV] created by Microsoft. It can have 16-24-32-bit linear or float compression. \newline Presets: \textit{wav} \item[MPEG Audio] Very widespread standard. Extension \texttt{.mp3}. \newline Presets: \textit{mp3} \end{description}