add Olaf Workmark
[goodguy/cin-manual-latex.git] / parts / Loadandsave.tex
index 2685641ecdc250d25052531f74c7f2b1bafa0019..2d9203a8285efb7e6f8db2ec3286fde503b397b2 100644 (file)
@@ -2,18 +2,18 @@
 \label{cha:load_save_and_the_EDL}
 
 There are many supported file formats that can be loaded and rendered to, that is to say, imported and exported. 
-The format of the file affects what Cinelerra does with it.  
+The format of the file affects what \CGG{} does with it.  
 Some file formats are very slow to display on the timeline, especially video which is highly compressed.  
 Drawing video thumbnails, picons, on the timeline can be very slow.  (You can disable picon drawing for these files with the \textit{draw media} toggle in the patchbay to speed up operations).
 
 \section{EDL --- Edit Decision List}%
 \label{sec:edl_edit_decision_list}
 
-When Cinelerra saves a file, it saves the EDL, Edit Decision List, of the current project but does not save any media. 
-Edit decision lists, more commonly referred to as the EDL, are generated by Cinelerra for storing projects.  
+When \CGG{} saves a file, it saves the EDL, Edit Decision List, of the current project but does not save any media. 
+Edit decision lists, more commonly referred to as the EDL, are generated by \CGG{} for storing projects.  
 The EDL contains all the project settings and locations of every edit. 
 Instead of media, the file contains pointers to the original media files on disk.  
-EDL files are specific to Cinelerra.    
+EDL files are specific to \CGG{}.    
 
 The EDL files generally have an extension of .xml.  
 The purpose of the EDL is to separate the media from all of the editing operations so that the original media remains intact. 
@@ -41,7 +41,7 @@ What is an MPEG file?  A very common file format is MPEG because it works with m
 \subsection{Working with Still Images}%
 \label{sub:working_with_still_images}
 
-Still images are played from 1 to any number of times, over and over; they have no duration. You can load still images on video tracks just like you do for any video file. When loaded on the track, use the down arrow on the timeline so you can see the single frame. To extend the length of the image, drag its boundaries just as you would do with regular video media. You can drag the boundaries of a still image as much as you want. Images in Cinelerra have the ability to be dragged to an infinite length. Alternatively, you can define the initial length of the loaded images. The parameter is set in the Images section of the \texttt{Settings $\rightarrow$ ~Preferences $\rightarrow$ ~Recording} window.
+Still images are played from 1 to any number of times, over and over; they have no duration. You can load still images on video tracks just like you do for any video file. When loaded on the track, use the down arrow on the timeline so you can see the single frame. To extend the length of the image, drag its boundaries just as you would do with regular video media. You can drag the boundaries of a still image as much as you want. Images in \CGG{} have the ability to be dragged to an infinite length. Alternatively, you can define the initial length of the loaded images. The parameter is set in the Images section of the \texttt{Settings $\rightarrow$ ~Preferences $\rightarrow$ ~Recording} window.
 
 Unless your original material comes from a digital source using its best resolution (like a digital camera), the first thing you might have to do before you can use it is to somehow capture the assets into a usable digital medium. For old photos, paper maps, drawings or diagrams, you can scan them into a file format like PNG, TIF, TGA or JPG files by using a digital scanner.
 
@@ -58,7 +58,7 @@ In order to be reasonably fast to use, you will most likely want to prepare them
 \subsubsection{Filelist format}%
 \label{ssub:filelist_format}
 
-An image sequence is a series of ordered still pictures; for example a bunch of camera shots, frames of an animated scene, or series of frame shots. These can be loaded as multiple files. For timelapse sequences, as the size of camera images increases to 70 megabytes and beyond, and more images can be stored on a memory stick, more cache, memory, and system resources (such as file descriptors) are used by Cinelerra to load the images when you use the \textit{concatenate tracks} or \textit{paste at insertion point} strategies.  It is very time consuming and resource consuming when each of the image files is loaded and concatenated as edits, and it also plays super poorly.  Here is an alternative to the usual \textit{load}.  This technique may also be useful for just a bunch of pictures.
+An image sequence is a series of ordered still pictures; for example a bunch of camera shots, frames of an animated scene, or series of frame shots. These can be loaded as multiple files. For timelapse sequences, as the size of camera images increases to 70 megabytes and beyond, and more images can be stored on a memory stick, more cache, memory, and system resources (such as file descriptors) are used by \CGG{} to load the images when you use the \textit{concatenate tracks} or \textit{paste at insertion point} strategies.  It is very time consuming and resource consuming when each of the image files is loaded and concatenated as edits, and it also plays super poorly.  Here is an alternative to the usual \textit{load}.  This technique may also be useful for just a bunch of pictures.
 
 File lists formats can be utilized in some way for the following list of types of \textit{Sequence files}  The first line of the sequence list file identifies the list codec.
 
@@ -79,7 +79,7 @@ Using the example of jpeg’s, the jpeg list sequence file type is the easiest a
 $ jpeglist.sh   /<path>/file.jpg   /<path>/DSC*.jpg
 \end{lstlisting}
 
-\vspace*{1ex} \noindent If <\texttt{path}> is the same on both outfile and infiles, then file.jpg is created in the same directory as infiles, the directory contains the entire asset, and the file list uses relative paths; otherwise the file list contains absolute paths.   Since this creates outfile list as a single asset, the memory demand and access time is much lower.  When you load the outfile in Cinelerra, you will need to set \textit{Try ffmpeg last} since ffmpeg does not work with jpeglist sequence files.
+\vspace*{1ex} \noindent If <\texttt{path}> is the same on both outfile and infiles, then file.jpg is created in the same directory as infiles, the directory contains the entire asset, and the file list uses relative paths; otherwise the file list contains absolute paths.   Since this creates outfile list as a single asset, the memory demand and access time is much lower.  When you load the outfile in \CGG{}, you will need to set \textit{Try ffmpeg last} since ffmpeg does not work with jpeglist sequence files.
 
 An example output file from running this script residing in the directory where \texttt{DSC*.jpg} files exist is shown below.
 
@@ -132,11 +132,11 @@ This will access the media using ffmpeg which is slower so be patient.
 \subsection{Raw Image Format of Some Digital Cameras \& Probe Order}%
 \label{sub:raw_image_format_digital_camera_probe_order}
 
-\textit{Warning: Expert Usage only.}  Raw digital camera images are a special kind of image file that Cinelerra can load. Dcraw, as used by Cinelerra, is Dave Coffin’s open-source computer program which reads many raw-image formats typically produced by high-end digital cameras.  Currently almost 700 of the types of cameras it recognizes are listed at:
+\textit{Warning: Expert Usage only.}  Raw digital camera images are a special kind of image file that \CGG{} can load. Dcraw, as used by \CGG{}, is Dave Coffin’s open-source computer program which reads many raw-image formats typically produced by high-end digital cameras.  Currently almost 700 of the types of cameras it recognizes are listed at:
 
 \hspace{4em}   {\small \url{https://www.cybercom.net/~dcoffin/dcraw/}}
 
-For example, included is the Canon Powershot SX60 (newly available in August, 2014).  Because ffmpeg tries to load \textit{any and every} file if \textit{Try Ffmpeg first} is enabled. it will make an attempt to load Raw Camera files first before any other file driver gets the chance.  In addition, there is the possibility that dcraw could conflict with the standard TIFF format, since it might be seen as format type \textit{tiff-pipe}.  Therefore it is necessary to specifically enable CR2 and either move it to the top or disable \textit{FFMPEG\_Early} and enable \textit{FFMPEG\_late} in the \textit{Probe Order} as described in another section (\ref{sub:probe_order_loading_media} and \ref{sec:ffmpeg_early_probe_explanation}).  These changed settings will be retained across Cinelerra sessions in .\texttt{bcast5}.  Raw Camera mode is most likely going to be used by expert camera users.
+For example, included is the Canon Powershot SX60 (newly available in August, 2014).  Because ffmpeg tries to load \textit{any and every} file if \textit{Try Ffmpeg first} is enabled. it will make an attempt to load Raw Camera files first before any other file driver gets the chance.  In addition, there is the possibility that dcraw could conflict with the standard TIFF format, since it might be seen as format type \textit{tiff-pipe}.  Therefore it is necessary to specifically enable CR2 and either move it to the top or disable \textit{FFMPEG\_Early} and enable \textit{FFMPEG\_late} in the \textit{Probe Order} as described in another section (\ref{sub:probe_order_loading_media} and \ref{sec:ffmpeg_early_probe_explanation}).  These changed settings will be retained across \CGG{} sessions in .\texttt{bcast5}.  Raw Camera mode is most likely going to be used by expert camera users.
 
 The first screenshot in figure~\ref{fig:raw} as in \texttt{Settings $\rightarrow$ ~Preferences $\rightarrow$ ~Playback A} Tab, shows the default checked settings of \textit{Interpolate CR2 images} and \textit{White balance CR2 images} which display the raw images in a way that you expect.  However, you may want to uncheck them to ensure that no program manipulation has modified your images so that you can add plugins or make your own modifications.  Unchecked indicates that the images are as closest as possible to unadulterated raw.
 
@@ -154,7 +154,7 @@ The final screenshot showing the Resources Asset Info displaying the File format
 \section{Loading Files}%
 \label{sec:loading_files}
 
-All data that you work with in Cinelerra is acquired either by loading from disk or recording from a device. This section describes loading.  To bring up the Load window go to the File pulldown and choose Load Files  (figure~\ref{fig:load}).  Next \textit{Select files to load}, and click ok (the green checkmark) or \textit{Apply}. When you use the Apply button, the Load window remains active for easily loading more files later.  Depending on the setting of the Insertion Strategy list box, your file will be either loaded directly on the Program window or in the Resources Media window.  If the file is a still image, the project's attributes are not changed and the first frame of the track becomes the image. Cinelerra usually builds an index file if one does not already exist, in order to speed up drawing. You can edit and play the file while the index is being built.
+All data that you work with in \CGG{} is acquired either by loading from disk or recording from a device. This section describes loading.  To bring up the Load window go to the File pulldown and choose Load Files  (figure~\ref{fig:load}).  Next \textit{Select files to load}, and click ok (the green checkmark) or \textit{Apply}. When you use the Apply button, the Load window remains active for easily loading more files later.  Depending on the setting of the Insertion Strategy list box, your file will be either loaded directly on the Program window or in the Resources Media window.  If the file is a still image, the project's attributes are not changed and the first frame of the track becomes the image. \CGG{} usually builds an index file if one does not already exist, in order to speed up drawing. You can edit and play the file while the index is being built.
 
 \begin{figure}[htpb]
     \centering
@@ -183,11 +183,11 @@ All data that you work with in Cinelerra is acquired either by loading from disk
 
 \begin{description}
     \item[Insertion Strategy] 
-    Cinelerra lets you change what happens when you load a file.  In the Load dialog window go to the Insertion strategy box and select one of the options in the drop down menu. Each of these options loads the file a different way.
+    \CGG{} lets you change what happens when you load a file.  In the Load dialog window go to the Insertion strategy box and select one of the options in the drop down menu. Each of these options loads the file a different way.
     
     \begin{description}
-       \item [Replace current project:] all tracks in the current project are deleted and a set of new tracks are created to match the source file.  Project attributes are only changed when loading XML. If multiple files are selected for loading, Cinelerra adds a set of new tracks for each file. New resources are created in the Resources Window, replacing the current ones.
-       \item [Replace current project and concatenate tracks: ] same as replace current project, except that if multiple files are selected, Cinelerra will concatenate the tracks of each file, inserting different source files in the same set of tracks, one after another, in alphanumeric order, starting at 0. New resources are created in the Resources Window, replacing the current ones.  Files go across the timeline.
+       \item [Replace current project:] all tracks in the current project are deleted and a set of new tracks are created to match the source file.  Project attributes are only changed when loading XML. If multiple files are selected for loading, \CGG{} adds a set of new tracks for each file. New resources are created in the Resources Window, replacing the current ones.
+       \item [Replace current project and concatenate tracks: ] same as replace current project, except that if multiple files are selected, \CGG{} will concatenate the tracks of each file, inserting different source files in the same set of tracks, one after another, in alphanumeric order, starting at 0. New resources are created in the Resources Window, replacing the current ones.  Files go across the timeline.
     \end{description}
     For ffmpeg and mpeg files, when the Insertion strategy methodology in the \texttt{File $\rightarrow$ Load files} pulldown is chosen to be either \textit{Replace current project} or \textit{Replace current project and concatenate tracks}, the basic session format parameters are reinitialized to match new media.  This selects the default asset and determines its width, height, and video length, frame rate, calculates the colormodel, and assumes square pixels to make an intelligent guess about aspect ratio for video.  For audio, the sample rate, audio length, and channel count (mono, stereo, or 5.1) are reinitialized.  In addition the \textit{Track Size} will be computed and is reinitialized to match the new loaded media.  When using \textit{replace} type insertion strategy, the new asset list is the only media in use so that this update saves the user from immediately needing to change the session format to match the only possibility.
     \begin{description}
@@ -198,7 +198,7 @@ All data that you work with in Cinelerra is acquired either by loading from disk
         \item[Nest sequence:] nested assets are added to the timeline by using the Nest sequence insertion strategy.
         The file will be pasted into the timeline over the current selection or at the insertion point. A nested sequence is media that had already been saved as an EDL earlier.  See the section on Nesting.description
     \end{description}
-    The insertion strategy is a recurring option in many of Cinelerra's functions. In each place the options do the same thing. If you load files by passing command line arguments to Cinelerra, the files are loaded with \textit{Replace current project} by default.
+    The insertion strategy is a recurring option in many of \CGG{}'s functions. In each place the options do the same thing. If you load files by passing command line arguments to \CGG{}, the files are loaded with \textit{Replace current project} by default.
     \item[Loading Multiple Files] In the Load dialog go to the list of files. Selecting files utilizes the motif style selection method.
     \begin{enumerate} [noitemsep]
         \item Select a single file by highlighting.
@@ -214,11 +214,11 @@ This behavior is available in most listboxes.   It is an especially useful metho
     You can also get a sub-list of potential files to choose from. For example, you know that the file you are looking for begins with the capital letter "C". If you keyin "C" into the selection box immediately below the list of files, and then click the left mouse button, a sub-list of files beginning with the "C" shows up under the selection box. Clicking the right mouse button cancels this sub-list.
     \item[Loading the backup] There is one special XML file on disk at all times. 
 
-        After every editing operation, Cinelerra saves the current project to a backup in  \texttt{\$HOME/.bcast/backup.xml}. 
-        In the event of a crash, the first thing you should do after restarting Cinelerra is select \texttt{File $\rightarrow$ Load backup} in order to load the backup. 
-        This will start Cinelerra at the point in your editing operations directly before the program crashed. 
-        It is important after a crash to restart Cinelerra without performing any editing operations as you will overwrite the backup. 
-        Note that the backup.xml file is always a single file which means that when you are working with two instances of Cinelerra open at the same time, they use the same backup file. 
+        After every editing operation, \CGG{} saves the current project to a backup in  \texttt{\$HOME/.bcast/backup.xml}. 
+        In the event of a crash, the first thing you should do after restarting \CGG{} is select \texttt{File $\rightarrow$ Load backup} in order to load the backup. 
+        This will start \CGG{} at the point in your editing operations directly before the program crashed. 
+        It is important after a crash to restart \CGG{} without performing any editing operations as you will overwrite the backup. 
+        Note that the backup.xml file is always a single file which means that when you are working with two instances of \CGG{} open at the same time, they use the same backup file. 
         In this case, the last operation made in whatever instance will overwrite the backup.
 \end{description}
 
@@ -285,7 +285,7 @@ The order change will not take effect until you click on the checkmark in both t
 Some kinds of media have \textit{program} streams, like captured mpeg broadcast stream data.  For example, you may be able to \textit{tune} to channel 9, but be able to see 9-1, 9-2, and 9-3 on your TV.  If you open a capture of this kind of media, all of the channels are present in the timeline.  To select and view just one program, you can use Alt-1 to select program 1, or Alt-2 to select program 2, etc. up to Alt-8.  This will remove all of the other unrelated tracks and reset the format.  This feature can be used even if there is only one program, by pressing Alt-1, and the effect will be to reset the session format to the parameters from the media probe.  Note that there may be several audio \textit{programs} associated to a video stream;
 for example, there may be dialog in another language or some kind of descriptive dialog.  Since the first associated audio is always selected, this may not produce the intended results.
 
-Below are screenshots illustrating multiple program streams (figure~\ref{fig:stream}).  The left screenshot is a partial main Cinelerra window showing a pre-recorded broadcast TV media/audio stream with 3 programs plus several associated audio tracks.  The second screenshot of \textit{Asset Detail} provides detailed information on each of the streams obtained through executing the Info Details as explained in the section \textit{Info Asset Details}.
+Below are screenshots illustrating multiple program streams (figure~\ref{fig:stream}).  The left screenshot is a partial main \CGG{} window showing a pre-recorded broadcast TV media/audio stream with 3 programs plus several associated audio tracks.  The second screenshot of \textit{Asset Detail} provides detailed information on each of the streams obtained through executing the Info Details as explained in the section \textit{Info Asset Details}.
 
 \begin{figure}[htpb]
     \centering
@@ -297,14 +297,14 @@ Below are screenshots illustrating multiple program streams (figure~\ref{fig:str
 \section{Saving Your Work}%
 \label{sec:saving_your_work}
 
-You can save your work as a project, which is what is loaded in Cinelerra now, or as an export, which is all the media it takes to reproduce your project space.
+You can save your work as a project, which is what is loaded in \CGG{} now, or as an export, which is all the media it takes to reproduce your project space.
 
 \subsection{Saving Project Files}%
 \label{sub:saving_project_files}
 
-Saving  XML files is useful to save the current state of Cinelerra before quitting an editing session. Cinelerra saves projects as XML files. There are a few options you can use to save your work via the File pulldown menu: \textit{Save}, \textit{Save as\dots}, \textit{Export project}, \textit{Save backup}.  You can either overwrite an existing file or enter a new filename. Cinelerra automatically concatenates .xml to the filename if no .xml extension is given.
+Saving  XML files is useful to save the current state of \CGG{} before quitting an editing session. \CGG{} saves projects as XML files. There are a few options you can use to save your work via the File pulldown menu: \textit{Save}, \textit{Save as\dots}, \textit{Export project}, \textit{Save backup}.  You can either overwrite an existing file or enter a new filename. \CGG{} automatically concatenates .xml to the filename if no .xml extension is given.
 
-When Cinelerra saves a file, it saves the EDL of the current project but does not save any media, instead just pointers to the original media files. For each media file, the XML file stores either an absolute path or just the relative path. If the media is in the same directory as the XML file, a relative path is saved. If it is in a different directory, an absolute path is saved.
+When \CGG{} saves a file, it saves the EDL of the current project but does not save any media, instead just pointers to the original media files. For each media file, the XML file stores either an absolute path or just the relative path. If the media is in the same directory as the XML file, a relative path is saved. If it is in a different directory, an absolute path is saved.
 
 You have to be careful when moving files around to avoid breaking the media linkages. You can keep the media and the XML file in the same directory forever and freely move the whole directory, since relative paths are saved. Alternatively you can save the XML file in a different directory than the media but then you can't move the media. In this case you can freely move your XML file around, since absolute paths are saved. If you saved your XML file in the same directory as your media but you would like to move location, you can change the paths from relative to absolute by going
 to \texttt{File $\rightarrow$ Save as}$\dots$ and entering the new location. Similarly if you saved your project outside your media directory but you would like to move your media to another location, you can change the paths from absolute to relative by going to File $\rightarrow$ Save as\dots and saving your XML file in the same directory as the media.
@@ -352,18 +352,18 @@ Originally, the easiest way to maintain a project for moving to another computer
 \subsection{Information about Backups and Perpetual Session}%
 \label{sub:information_backups_perpetual_session}
 
-In an effort to minimize loss of work due to user, hardware, or software issues, Cinelerra has some automatic backup capabilities.
+In an effort to minimize loss of work due to user, hardware, or software issues, \CGG{} has some automatic backup capabilities.
 
-Cinelerra automatically saves every \textit{editing operation} to the current project on disk continuously to a file named \texttt{\$HOME/.bcast5/backup.xml}.  In the unlikely event of a crash, when you restart Cinelerra, you should select \texttt{File $\rightarrow$ Load backup} in order to continue with the operations that were recorded before the crash.  If you have more than 1 instance of Cinelerra running, only the last editing operation made in whichever instance it was last made, will overwrite the backup. 
+\CGG{} automatically saves every \textit{editing operation} to the current project on disk continuously to a file named \texttt{\$HOME/.bcast5/backup.xml}.  In the unlikely event of a crash, when you restart \CGG{}, you should select \texttt{File $\rightarrow$ Load backup} in order to continue with the operations that were recorded before the crash.  If you have more than 1 instance of \CGG{} running, only the last editing operation made in whichever instance it was last made, will overwrite the backup. 
 
-There is still 1 more backup that may save you.  If for some reason you forgot to use \textit{Load backup} immediately when restarting, you have a second chance to use \texttt{File $\rightarrow$ Load} and select \texttt{\$HOME/.bcast5/backup.prev} as long as you only loaded a different file and have performed no editing operations.  This same file is also used by multiple instances of Cinelerra.
+There is still 1 more backup that may save you.  If for some reason you forgot to use \textit{Load backup} immediately when restarting, you have a second chance to use \texttt{File $\rightarrow$ Load} and select \texttt{\$HOME/.bcast5/backup.prev} as long as you only loaded a different file and have performed no editing operations.  This same file is also used by multiple instances of \CGG{}.
 
-\textbf{Perpetual session} is very useful for working on a project over many days so you can just quit before shutting down and the next time you start up Cinelerra you will be right back where you left off.  
+\textbf{Perpetual session} is very useful for working on a project over many days so you can just quit before shutting down and the next time you start up \CGG{} you will be right back where you left off.  
 You will retain all of your undo’s and redo’s.  
 The binary file name is \texttt{\$HOME/.bcast5/perpetual.dat} and as long as \texttt{Settings $\rightarrow$ Preferences}, the Appearance tab has the Flag \textit{Perpetual session} set this capability takes effect.  
 It is very important to understand that this is not the same as the continuously editing- operation-updated \texttt{backup.xml} file.  
-The perpetual.dat file is \textit{only} updated when you Quit Cinelerra in the normal manner.  
-Which means if you interrupt the program, or kill it, or there is a segv or system crash, the \texttt{perpetual.dat} file will only reflect the state of your project from when you last started Cinelerra, and none of the editing/undo’s/redo’s you executed during the current session which was not ended normally.
+The perpetual.dat file is \textit{only} updated when you Quit \CGG{} in the normal manner.  
+Which means if you interrupt the program, or kill it, or there is a segv or system crash, the \texttt{perpetual.dat} file will only reflect the state of your project from when you last started \CGG{}, and none of the editing/undo’s/redo’s you executed during the current session which was not ended normally.
 \vspace{1ex}
 
 Some notes to keep in mind about Perpetual session are:
@@ -373,10 +373,10 @@ Some notes to keep in mind about Perpetual session are:
     \item takes disk space in \texttt{.bcast5} area and this could get really big
     \item after you complete a project, it is advisable to turn off the Perpetual session flag before quitting so
     that when you start a new project, you can start with a fresh perpetual.dat by turning the flag on or
-    after stopping Cinelerra, delete the current \texttt{\$HOME/.bcast5/perpetual.dat} file
+    after stopping \CGG{}, delete the current \texttt{\$HOME/.bcast5/perpetual.dat} file
     \item only session data is backed up (not program feature setup)
     \item the files backup.xml and backup.prev will operate the same as before so that if there is a crash, you
     will want to use \texttt{File $\rightarrow$ Load backup} in order to continue where you were interrupted.
-    \item to start Cinelerra without using your Perpetual session data even if enabled, use your\_cinelerra\_path\texttt{/cin/bin -S}
+    \item to start \CGG{} without using your Perpetual session data even if enabled, use your\_cinelerra\_path\texttt{/cin/bin -S}
 \end{itemize}