[goodguy/cin-manual-latex.git] / parts / Introduction.tex

\chapter*{Introduction}%
\label{cha:introduction}
\addcontentsline{toc}{chapter}{Introduction}

\CGG{} is a software program NLE, Non-Linear Editor, that provides a
way to edit, record, and play audio or video media.  It can also be
used to transcode media from one format to another or to correct and
retouch photos. \CGG{} currently runs on many Linux operating system
distributions.

This manual covers the \CGG{} \INF{} version.  Information
contained in this manual is a description of the \CGG{} program
usage and was obtained from various sources to include different
communication channels, emails, common knowledge, and write-ups as
new features were added.  The author of the original
\textsc{Cinelerra} program, Adam Williams, as well as many different
people have modified the \textsc{Cinelerra} source code over the
years.  William Morrow merged all of the known changes, whenever
possible, into this \CGG{} version and has been adding numerous
features, updates, and fixes.

{\small \textbf{NOTE1:} This manual is a Work in Progress: monthly parts are added to cover the new features introduced in \CGG{}. The texts are continuously revised to make them clearer and more complete. In order to have a better and better product we rely on the suggestions and criticisms of our readers. Do not hesitate to let us know your opinions. For this continuous variability, we recommend that you download the manual at least once a month, during the release of \CGG{}, so that its content is always up to date.

\textbf{NOTE2}: this manual, in the HTML version present on the website, is the base of the \textit{Context Help} that can be called inside the program. For each window, button and plugins we can open the relative web page of the manual with \texttt{ALT/h} keys. More details in \nameref{sec:help_context_help}.}

The \CGG{} software is under
\href{https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html}{GPLv2+}
license. A notice of this is included in the software and shown here.

\begin{lstlisting}[basicstyle=\footnotesize]
*
* CINELERRA
* Copyright (C) 1997-2012 Adam Williams <broadcast at earthling dot net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston
\end{lstlisting}

\section*{\CGG{} Overview}%
\label{sec:cinelerra_overview}

Presented briefly here is an overview of \CGGI{} and information
provided in this manual. The \GG{} version of \textsc{Cinelerra} has
been improved for \emph{stability}, \emph{modernized} to accommodate
the \emph{current state} of Linux software, enhanced with additional
\emph{basic features}, and enriched with \emph{new features}
imagined by dedicated users and then implemented by professional
programmers.

\begin{description}
    \item[Website] \href{https://www.cinelerra-gg.org}{https://www.cinelerra-gg.org}\\
        The website for the cinelerra-gg software is a good place to start for information, help, and documentation.
        It is professionally maintained and continuously updated with more language
        translations ongoing.
    \item[Stability]~\\
        Software programs that \textit{just work} are a \#1 priority in order to be of use for producing quality videos.
        A large amount of time has been invested in debugging problems and resolving crashes.
        And in a continuous process to do so, a chapter on Troubleshooting is included in order to easily provide sufficient information for users to capture issues and crashes so that they can be analyzed and quickly fixed to avoid repeat problems.
    \item[Modernization]~\\
        Artistic creativity has been applied to modernize the \CGG{} plugin icons for video and audio to even include the ffmpeg plugins.
        The Cinfinity set of plugin icons come in square or roundish versions --- your choice.
        In keeping up with the current expectation of users for a certain \textit{look and feel}, 2 very modern recent theme additions, Cakewalk and Neophyte, provide alternatives to the already existing 9 themes.
        These 11 themes give the user the choice to get the look they like best for their own eyes.
    \item[Current and up-to-date]~\\
        For today’s software, included thirdparty libraries are kept up to date in a timely manner and effort is made to always use a relatively recent version of FFmpeg, if not the latest.
        This is a big deal because there is a whole set of separate programmers working on these libraries continuously and diligently to cover all of the old and newly created formats.
        Thus \CGG{} programmers can be dedicated to working solely on \CGG{} rather than just trying to keep up with many formats.
    \item[FFmpeg usage integration]~\\
        By using FFmpeg with \CGG{}, there is the advantage that users can directly convert videos via pre- and post-processing, without the need for command lines to be executed manually before or afterwards.
    \item[Import and Export formats]~\\
        Listed here are only a few of the supported Import and Export formats:
        \begin{itemize}
            \item  several standard native formats, such as mpeg, ac3, flac, exr and jpeg/png/ppm/tiff sequences
            \item FFmpeg’s over 400 decoders and 150 encoders accessible from within \CGG{} to include:
                mp4, mkv, mpeg, mov, m2ts, mp3, dvd, ogg, theora, prores, tiff, webm, flac, opus, vorbis,
                quicktime (div, dnxhd, jpeg, mjpeg, mp4, rle, v308, v410), h264 \& h265 usage, avc, hevc,
                and recently released AV1 and WebP
            \item raw image format for over 700 supported cameras, courtesy Dave Coffin's DCraw
        \end{itemize}

        \item[Standard Features]~\\
            \begin{itemize}
                \item Program window for video and audio tracks, navigation, popups, playing and seeking functions.
                \item Editing via track manipulation with either drag and drop editing or cut and paste editing.
                \item  Patchbay tools: fader, gang, arm, enable output, expanders, mixers, and blending operations.
                \item Undo and Redo capability for many editing functions.
                \item Drag handle functionality for Ripple, Roll, Slip, Slide, Edge, and No Effect.
                \item Dynamic Keyframe support with curve, toggle, automatic, compositor, and editing capabilities.
                \item Proxy editing support to speed up editing for large formatted files on slower computers.
                \item Compositor window with masking, zooming, cropping, projector and camera capabilities.
                \item Viewing window for quickly viewing/playing audio, video, clips, or proxies.
                \item Resources window with Media, Proxy, Clips, Video and Audio Effects/Transitions.
                \item User defined bins/folders for a project.
                \item Expandable Video/Audio effects for grouping selections such as Color Correction or Motion plugins.
                \item Included are over 400 Plugins – audio and video native, FFmpeg, plus expandable to include others.
                \item LV2 and Ladspa plugins audio support.
                \item Mouse over Media or Proxy folders to get a 5 second real time preview of the media.
                \item Single or multiple files rendering; background rendering, batch rendering, command line rendering, and use of a Render Farm to take advantage of multiple computer CPUs.
                \item Numerous pre-defined output formats automatically available and allowance for user-defined formats.
                \item Capture and Recording capability to include Broadcast TV recording, editing, and viewing.
                \item Hundreds of Shortcuts are defined which are easily viewed using the shell commands pulldown.
                \item Context Help in the program for numerous window, menu, GUI elements, buttons, and other items via the user's configured web browser.
                \item PorterDuff operations are available in the patchbay of the main timeline window for alpha blending.
                \item Color correction + 8-bit and 10-bit color space.
                \item Up to 8K video supported.
                \item ShuttlePro and ShuttleXpress functionality.
                \item International language support.
                \item Multi-screen, Multi-viewers, Multi-session, Multi-pane capability.
                \item Menu bar shell commands with reference to some manuals and user-definable additions.
                \item Video stabilization, Motion tracking, Motion Graphics.
                \item Blade Cut/Hard Edges, Snap/Cut editing and Snap Dragging.
                \item OpenGL support as well as Direct X11 speedup.
                \item Advanced Trim Features and Grouping.
                \item Asset and Title colors selection including Alpha slider adjustment.
                \item Scaling preference for any monitor size and HiDPI to support 4K monitors.
            \end{itemize}
            \item[Innovative New Features]~\\
                \begin{itemize}
                    \item Inter-View mode as invented through a collaborative effort by a user and the developer.
                    \item Proxy settings for large formatted media with the coveted Scalar option and proxy quick switch.  Includes a 1:1 proxy setting used to save CPU time with a reduced bitrate.
                    \item Multiple cameras / Mixer Viewer with the number of cameras only limited by the resources on the user’s computer (on a large system, 50 are known to work).
                    \item Audio/Video sync via waveforms, or timecodes to include syncing with externally recorded audio.
                    \item DVD/bluray creation, editing, and copying for non-commercial media greatly enhanced for usability.
                    \item Title plugin virtually unlimited script size with many changeable attributes such as size, blink, color.
                    \item Motion Graphics using the Sketcher plugin to create elements such as ellipses, rectangles and shapes for simpler motion graphics.
                    \item Open EDL for editing clips, nested clips, and xml files while working on a Project.
                    \item File by Reference; To be able to modify the original source during editing (which, in this case, becomes destructive).
                    \item The Vectorscope option in the Videoscope plugin allows for the use of any number of user-supplied grid patterns as an Overlay.
                    \item Hardware acceleration with vaapi and vdpau for computers with graphics hardware meeting certain criteria.
                    \item Bump Autos is a new type of keyframe automation that allows you to easily create and manage keyframes intervals in Speed, Fade and Camera/Projector-XYZ curves.
                \end{itemize}
\end{description}

\section*{Chapters Overview}%
\label{sec:chapters_overview}

Below is listed a brief overview of each chapter to help you to decide which chapters you should pay the most attention to and read more thoroughly.
And which chapters are important for beginning to learn to use \CGG{}. At the end of the descriptions is a list of the sections to read for beginners.

\begin{description}
    \item[Chapter~\ref{cha:Installation} ] \nameref{cha:Installation}.

        If you just want to get started using the program, you can safely skip this chapter and instead go to:
        {\small \url{https://www.cinelerra-gg.org}}
        and simply download a pre-built linux version for your Operating System. If you would like to do your own builds so that you always have the latest, refer to this chapter to learn how.
        But if you are already familiar with doing your own builds, you can just refer to this chapter when you encounter issues.
    \item[Chapter~\ref{cha:the_4_windows} ] \nameref{cha:the_4_windows}.

        It is important to understand the window setup in \CGG{} and what each of them is used for.
        In addition this chapter covers some basic navigation functions that you will need to know.
        However, if you have used an NLE before and don’t mind experimenting to learn how to execute certain functions, probably there is no need to peruse this chapter.
    \item[Chapter~\ref{cha:project_and_media_attributes}] \nameref{cha:project_and_media_attributes}.

        This chapter is helpful for basic understanding of setting up your session but it can easily be skipped.

    \item[Chapter~\ref{cha:load_save_and_the_EDL}] \nameref{cha:load_save_and_the_EDL}.

                The EDL is the list of changes that \CGG{} would make to the original media in order to produce the desired output
        Since this is important to not losing your work, you should read this chapter for some basic usage concepts and for some lesser used functions that may come in handy.
        Besides how to Load and Save files, there is also information on using raw camera formats.
        Helpful hints on working with image sequences, such as a bunch of pictures from your camera all loaded at once, is a time saver. Understanding that the EDL is the list of changes that would be made to the original media in order to produce the desired output is key to ensuring that that media remains intact.
        
    \item[Chapter~\ref{cha:editing}] \nameref{cha:editing}.

        New and occasional users will find it necessary to read this chapter. However, you can decide which editing mode you prefer and concentrate on reading that section.
        Even seasoned users will want to read this chapter in order to take advantage of features that have been newly implemented or may be less familiar due to infrequent usage.
        Anyone who wants the editing capabilities that comes with use of the Shuttle Jog Wheel, will initially need to read that section to become familiar with its usage.
        
     \item[Chapter~\ref{cha:advanced_editing}] \nameref{cha:advanced_editing}.
     
        Many tools for the advanced editing: Proxy, Nesting; Trimming; Multi-Cam; Audio/Video sync and Transcoding. \CGG{} offers many possibilities and sophisticated alternatives for editing, but they are complex tools. Here we deepen their knowledge and use.

    \item[Chapter~\ref{cha:rendering}] \nameref{cha:rendering}.

        Minimally most users will need to read the section on single file rendering to get started; since after all the whole purpose of using an NLE is to create your own media.
        The end of this chapter includes some helpful specific rendering scenarios which could prove quite useful.
        You might also want to consider using batch rendering and background rendering for performance reasons.
        And, of course, render farm usage to take advantage of multiple computers can be a real boost.

    \item[Chapter~\ref{cha:keyframes}] \nameref{cha:keyframes}.

        This is a more advanced topic but extremely useful to know.
        Keyframes are data values that have been associated to media on the timeline that affect the media presentation.
        You can go for years without knowing all of the nuances but you will most likely have a need to use and understand them sooner or later.

    \item[Chapter~\ref{cha:ffmpeg_interactions}] \nameref{cha:ffmpeg_interactions}.

        Skip this chapter if you are just getting started. Skip this chapter if you just want to use common
        formats that are already set up for you. Experts may want to refer to this chapter in order to set up their
        own option files.

    \item[Chapter~\ref{cha:plugins}]\nameref{cha:plugins}.

        Use this chapter as a reference to add an audio or video plugin in order to correct color or add some fancy effect.
        You will not want to read about each and every plugin, most of which you will never use.
        On the other hand, going over the section on “some specific details concerning plugins” might come in handy.

    \item[Chapter~\ref{cha:transition_plugin}] \nameref{cha:transition_plugin}.

        Everyone who does not know about using transitions should read this chapter because you will want to use transitions between cuts in your video for smoothly changing scenes.
        It is short and easy reading.

    \item[Chapter~\ref{cha:overlays}] \nameref{cha:overlays} Modes, Alpha Blending, and Porter Duff.

        Experts can really use the information in this chapter to spiff up their editing work through some blending type techniques.
        A lot of information and possibilities are described here.

    \item[Chapter~\ref{cha:capturing_recording_media}] \nameref{cha:capturing_recording_media}.

        This chapter is helpful in learning how to capture and record media from various sources.  A section on using \CGG{} with broadcast TV (NTSC) is especially useful.

    \item[Chapter~\ref{cha:dvd_bluray_creation}] \nameref{cha:dvd_bluray_creation}.

        If this is what you want to do, then read this chapter.
        In the case of DVD media creation it includes many examples and lots of tips for checking your methods.

    \item[Chapter~\ref{cha:shortcuts}] \nameref{cha:shortcuts}.

        Everyone will want to use this chapter to speed up their editing sessions.
        Once you find yourself doing the same thing over and over again, you will want to know if there is a shortcut. Then look here!

    \item[Chapter~\ref{cha:configuration_settings_preferences}] \nameref{cha:configuration_settings_preferences}.

        Refer to this chapter when you want to change some setting or preference.
        Otherwise if a new user, you should make sure to read the first page which includes some important basic information.

    \item[Chapter~\ref{cha:how_stuff_works}] \nameref{cha:how_stuff_works}.

        Only read this chapter if you are confused about a specific covered topic and how it works.

    \item[Chapter~\ref{cha:troubleshooting_help}] \nameref{cha:troubleshooting_help}.

        Use this chapter for diagnosing a problem and find out what to report to get the best resolution or help.  Context Help, using Alt/h, is explained here.

    \item[Chapter~\ref{cha:performance_tips}]  \nameref{cha:performance_tips}.

        There are a few performance tips in this chapter that may eventually prove useful.

    \item[Chapter~\ref{cha:translations}] \nameref{cha:translations}.

        If you want to help by providing translations for a specific language, there is a complete description of how to do this and what to do.

    \item[Chapter~\ref{cha:licenses}] \nameref{cha:licenses}.

    \item[Appendix~\ref{cha:Quickstart}] \nameref{cha:Quickstart}.

        Here you go! If you hate to read, just go over the quick start guide or the youtube video creation and simply be on your way.

    \item[Appendix~\ref{cha:developer's_section}] \nameref{cha:developer's_section}.

        Some extra information that developers may or may not find useful.

    \item[Appendix~\ref{cha:auxiliary_programs}] \nameref{cha:auxiliary_programs}.

        This is a catch-all for any useful programs that may need to be included, mostly for analysis.
        
     \item[Appendix~\ref{cha:editing_real_world_usage}] \nameref{cha:editing_real_world_usage}.
    
        Our users illustrate in-depth examples of their workflows by showing their editing in real use cases.

\end{description}

In summary, \textit{must} reads for a new user would be these chapters or sections:

\begin{itemize}
    \item Chapter~\ref{cha:the_4_windows} --- \nameref{cha:the_4_windows}.
    \item Chapter~\ref{cha:load_save_and_the_EDL} --- \nameref{cha:load_save_and_the_EDL}.
    \item Chapter~\ref{cha:editing} --- \nameref{cha:editing}; read all sections except emphasize only either \nameref{sec:cut_paste_editing} or \nameref{sec:drag_drop_editing} to suit your purpose and then skim the editing mode that is not your preference as some operations work in either mode.
        Skip the \nameref{sec:shuttle_jog_wheels_editing} section unless you have this jog wheel in hand.
    \item Chapter~\ref{cha:rendering} --- \nameref{cha:rendering}; minimally read the \nameref{sec:single_file_rendering} section.
    \item Chapter~\ref{cha:plugins} --- \nameref{cha:plugins}; read the section on \nameref{sec:how_use_plugins}.
    \item Chapter~\ref{cha:transition_plugin} --- \nameref{cha:transition_plugin}.
    \item Chapter~\ref{cha:configuration_settings_preferences} --- \nameref{cha:configuration_settings_preferences}; read at least the first couple of paragraphs.
\end{itemize}

%%% Local Variables:
%%% mode: latex
%%% TeX-master: "../CinelerraGG_Manual"
%%% End: