From: Good Guy Date: Tue, 19 Jan 2021 03:53:47 +0000 (-0700) Subject: Andrea reworked Batch Render for changes + minor fixes X-Git-Tag: 2021-05~24 X-Git-Url: https://git.cinelerra-gg.org/git/?p=goodguy%2Fcin-manual-latex.git;a=commitdiff_plain;h=5f7eb23c66c85a2566498a073568bbad95004c31;hp=7678fff73ceb5a9aa587db80d79bcd45641d4b60 Andrea reworked Batch Render for changes + minor fixes --- diff --git a/images/batch-advanced.png b/images/batch-advanced.png new file mode 100644 index 0000000..f709ee7 Binary files /dev/null and b/images/batch-advanced.png differ diff --git a/images/batch01.png b/images/batch01.png index 6cbb296..054c201 100644 Binary files a/images/batch01.png and b/images/batch01.png differ diff --git a/images/settings.png b/images/settings.png index e042422..85135b2 100644 Binary files a/images/settings.png and b/images/settings.png differ diff --git a/parts/Loadandsave.tex b/parts/Loadandsave.tex index 62df619..0510fb5 100644 --- a/parts/Loadandsave.tex +++ b/parts/Loadandsave.tex @@ -378,9 +378,10 @@ as long as you only loaded a different file and have performed no editing operat \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 \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. +It is very important to understand that this is not the same as the continuously editing- operation-updated \texttt{backup.xml} file which is still operating as usual. +The perpetual.dat file is updated so that when you Quit \CGG{} in the normal manner, +interrupt the program, kill the program, or there is a segv or system crash, the \texttt{perpetual.dat} file still reflects the state of your project. This means the editing/undo’s/redo’s you executed during the current session should still be available on a restart with the exception of any edit +that may not have had a chance to be written on disk before an abnormal stoppage. \vspace{1ex} Some notes to keep in mind about Perpetual session are: @@ -393,7 +394,7 @@ Some notes to keep in mind about Perpetual session are: 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. + can still use \texttt{File $\rightarrow$ Load backup} in order to continue where you were interrupted. \item to start \CGG{} without using your Perpetual session data even if enabled, keyin: /your\_cinelerra\_path\texttt{/bin/cin -S} \end{itemize} diff --git a/parts/Rendering.tex b/parts/Rendering.tex index 8a9793b..3de25a9 100644 --- a/parts/Rendering.tex +++ b/parts/Rendering.tex @@ -693,7 +693,7 @@ a more efficient method of rendering. To use this feature you need to understand certain concepts. \begin{enumerate} - \item You must define a list of Batches (\textit{Job} \index{job}) before starting the rendering. This is created using the \textit{New} button and displayed in \textit{Batches to Render} dialog. + \item You must define a list of Batches (\textit{Job} \index{job}) before starting the rendering. This is created using the \textit{New} button and displayed in \textit{Batches to Render} dialog. \item Each batch consists of a source project already created in \CGG{}, e.g. \texttt{aaa.xml}, to which we assign the rendering parameters. \begin{itemize} \item to associate \texttt{aaa.xml} to the batch we use the \textit{EDL Path} input field. @@ -732,7 +732,7 @@ called \textit{Batches to render}. Above this are the configuration parameters for a single batch; a batch is simply a pairing of a project file with a choice of output file and render settings. -Set the \textit{Output path}, \textit{File format}, \textit{Audio}, +It may be advisable to start with a \textit{Delete} so you don't have any problems. Set the \textit{Output path}, \textit{File format}, \textit{Audio}, \textit{Video}, and \textit{Create new file at each label} parameters as if you were rendering a single file. These parameters apply to only one batch. In addition to the standard rendering @@ -772,7 +772,25 @@ follows: job. \item[Elapsed:] the amount of time taken to render the batch if finished. If field is empty, it did not run. -\end{description} To start rendering from the first enabled batch, +\end{description} + +The \texttt{File $\rightarrow$ Batch Render} pulldown brings up the +Batch Render window to be used for batch rendering as well as DVD/BD +creation. There are some additional buttons that can save time and +mistakes. These are described next. + +\begin{description} + \item[Save Jobs] when you have set up the batch jobs the way you + want and you think you may have to run them more than once, it is + beneficial to save the jobs for later use so you easily run them + again. + \item[Load Jobs] reload a previous set of saved jobs. This can come + in handy if you did not have the time to render them when you + originally set them up, if you need to rerun, or if you got + interrupted. +\end{description} + +To start rendering from the first enabled batch, hit \textit{Start}. Once rendering, the main window shows the progress of the batch. After each batch finishes, the elapsed column in the batch list is updated and the next batch is rendered until @@ -799,50 +817,28 @@ program, execute: will start up and perform the rendering jobs in that list, without creating its usual windows. -\subsection{Command Line Rendering}% -\label{sub:command_line_rendering} -\index{rendering!command line} - -The command line rendering method consists of a way to load the -current set of batch rendering jobs and process them without a -GUI\@. This is useful if you want to do rendering on the other side -of a low bandwidth network and you have access to a high powered -computer located elsewhere. Setting up all the parameters for this -operation is somewhat difficult. That is why the command line aborts -if any output files already exist. - -To perform rendering from the command line, first run \CGG{} in -graphical mode. Go to \texttt{File $\rightarrow$ Batch - Render}. Create the batches you intend to render in the batch window -and close the window. This saves the batches in a file. Set up the -desired render farm attributes in \texttt{Settings $\rightarrow$ - Preferences} and quit out of \CGG{} if you want to use the Render -Farm capability. These settings are used the next time command line -rendering is used to process the current set of batch jobs without a -GUI\@. - -On the command line run: - -\begin{lstlisting}[style=sh] -cin -r -\end{lstlisting} - -\subsection{More about Save/Use EDL and Save/Load Jobs}% -\label{sub:more_save_use_edl_jobs} +\subsection{Advanced features}% +\label{sub:advanced_features} \index{batch rendering!more options} -The \texttt{File $\rightarrow$ Batch Render} pulldown brings up the -Batch Render window to be used for batch rendering as well as DVD/BD -creation. There are some additional buttons that can save time and -mistakes. These are described next. +\textbf{Warning}: one of these advanced functions overwrites the original EDL, which will then be lost! + +Although the operation of Batch Rendering in \CGG{} is similar to that of other NLEs, there is one big difference that we need to take into account. The render setup is not done on a project-by-project basis, which are then brought into the Batch window to be rendered automatically. The setup must be done in the Batch rendering window, where various projects are loaded and set up. In the case of similar projects, derived from a single EDL with some variation, this mode offers the possibility of altering the projects without having to open each individual project, make the changes, set up the rendering, save and import into the Batch window. The procedure is to select the batch we want to modify in the Batches to render window; operate on the currently open timeline (even if it does not correspond to the one we want to modify) making the desired changes and then press the \textit{Save to EDL path} button. Thus the chosen batch, while retaining its original name, will now contain the modified project. Since this possibility destroys the original EDL overwriting it with the modified one, you must be very careful. This procedure is convenient in case the batches are similar, i.e. they are variations of the same EDL, where we want to experiment with other effects, other output formats or when trying out various cuts of a DVD/BD before the final production. It might also be useful to use an \textit{active region} of the timeline, so as to speed up rendering times but still have an indicative result for comparison. Instead operating on different projects, we can do a \textit{save as...} of the project on the timeline to have a new EDL with a new name and then replace it with the batch selected in the joblist using the \textit{Use Current EDL} button. The new project (with its name) overwrites the original project. The \textit{Save to EDL Path} and \textit{Use Current EDL} buttons can be valuable tools for advanced usage or for developers doing testing. Description of how you can expect them to work will help -to illustrate how to take advantage of their capabilities. +to illustrate how to take advantage of their capabilities (figure~\ref{fig:batch-advanced}): + +\begin{figure}[htpb] \centering + \includegraphics[width=0.7\linewidth]{batch-advanced.png} + \caption{New Buttons with Unsafe GUI in batchrender} + \label{fig:batch-advanced} +\end{figure} + \begin{description} -\item[Save to EDL Path] if you have made a change to the EDL, use +\item[Save to EDL Path] Warning: this function overwrites the contents of the original EDL with new data, keeping the name of the original. If we don't know exactly what we're doing we may lose the original project. If you have made a change to the EDL, use this button to save the changes so that they will be used in the render operation. Although you can get the same results by using \texttt{File $\rightarrow$ Save\dots}, this capability was initially @@ -864,8 +860,8 @@ to illustrate how to take advantage of their capabilities. However, it is important to note that the result will be saved with the name \texttt{original\_name} – that is, the new content from \texttt{new.xml} but with the old name of - \texttt{original\_name.xml}. -\item[Use Current EDL] if you are working on media and still testing + \texttt{original\_name.xml}. To have this functionality we have to enable the checkbox in \texttt{Settings $\rightarrow$ Preferences $\rightarrow$ Appearance} tab; section \textit{Dangerous:} and unchecked (default) \textit{Unsafe GUI in batchrender}. +\item[Use Current EDL] Warning: this function overwrites the contents of the original EDL with new project. If we don't know exactly what we're doing we may lose the original project. if you are working on media and still testing out the results, you can take advantage of this click-box to quickly get results. Basically, you change the media, save that change with another name (in order to preserve the original name in case you @@ -879,15 +875,7 @@ to illustrate how to take advantage of their capabilities. listbox will be automatically updated to the \texttt{new\_name.xml} and the current existing highlighted job will be replaced with the \texttt{new\_name.xml} in the EDL column. -\item[Save Jobs] when you have set up the batch jobs the way you - want and you think you may have to run them more than once, it is - beneficial to save the jobs for later use so you easily run them - again. -\item[Load Jobs] reload a previous set of saved jobs. This can come - in handy if you did not have the time to render them when you - originally set them up, if you need to rerun, or if you got - interrupted. -\item[Warn if Jobs/Session mismatched] After you set up your render +\item[Warn if Jobs/Session mismatched] Warning: It is better to keep this function unchecked because it is only needed in case of changes on the original EDL. By default it is hidden and is shown only if we enable the checkbox in \texttt{Settings $\rightarrow$ Preferences $\rightarrow$ Appearance} tab; section \textit{Dangerous:} and checked \textit{Unsafe GUI in batchrender}. After you set up your render and press Start, the program checks to see if the current EDL session matches your Batch Render job. If the EDL has been changed since the batch job was created, it warns you so that you have the @@ -895,16 +883,46 @@ to illustrate how to take advantage of their capabilities. Otherwise, you can dismiss that warning box, disable the warning message by unchecking the box and use the original values. If you never want to be warned about the mismatches, leave the box - unchecked (figure~\ref{fig:batch02}). + unchecked (figure~\ref{fig:batch02}). It is advisable to keep it unchecked because it can cause problems. \end{description} \begin{figure}[htpb] \centering - \includegraphics[width=1.0\linewidth]{batch02.png} - \caption{Batch render with the 4 ghosted buttons on the right side - + the Warning message below} - \label{fig:batch02} + \includegraphics[width=0.9\linewidth]{batch02.png} + \caption{Batch render with the 4 ghosted buttons on the right side + + the Warning message below} + \label{fig:batch02} \end{figure} +A very clear tutorial on these features can be found \href{https://linuxvideoediting.blogspot.com/2021/01/save-edl-path-use-current-edl-in-cinelerra-gg.html}{here}\protect\footnote{credit Igor Vladimirsky}; in Russian but easily translatable with DeepL or similar. + +\subsection{Command Line Rendering}% +\label{sub:command_line_rendering} +\index{rendering!command line} + +The command line rendering method consists of a way to load the +current set of batch rendering jobs and process them without a +GUI\@. This is useful if you want to do rendering on the other side +of a low bandwidth network and you have access to a high powered +computer located elsewhere. Setting up all the parameters for this +operation is somewhat difficult. That is why the command line aborts +if any output files already exist. + +To perform rendering from the command line, first run \CGG{} in +graphical mode. Go to \texttt{File $\rightarrow$ Batch + Render}. Create the batches you intend to render in the batch window +and close the window. This saves the batches in a file. Set up the +desired render farm attributes in \texttt{Settings $\rightarrow$ + Preferences} and quit out of \CGG{} if you want to use the Render +Farm capability. These settings are used the next time command line +rendering is used to process the current set of batch jobs without a +GUI\@. + +On the command line run: + +\begin{lstlisting}[style=sh] +cin -r +\end{lstlisting} + \section{Background Rendering}% \label{sec:background_rendering} \index{background rendering} diff --git a/parts/Shortcuts.tex b/parts/Shortcuts.tex index 393aea0..617495d 100644 --- a/parts/Shortcuts.tex +++ b/parts/Shortcuts.tex @@ -130,6 +130,7 @@ The Main window (also called the program window) consists of pulldown menus, but & -- Typeless keyfrs & & Toggle typeless keyframes mode. \\ & Save settings now & Ctrl-Shift-S & Save \CGG{}\_rc. \\ & Loop Playback & Shift-L & Set loop playback region to selection/all. \\ + & Guide on timeline & Shift-L & Create a guide on timeline. \\ & Set bkg render & Shift-G & Toggle background rendering. \\ \midrule \textcolor{CinBlueText}{View} & -- Show assets & 0 & Toggle show asset data. \\ diff --git a/parts/Windows.tex b/parts/Windows.tex index d0144ab..8ae755d 100644 --- a/parts/Windows.tex +++ b/parts/Windows.tex @@ -293,6 +293,13 @@ There are numerous methods to cut and paste in \emph{drag and drop mode} by sett a selected region or using the Copy/Paste Behavior as outlined in~\ref{sub:copy_paste_behavior}. In this mode, clicking the LMB in the timeline does not reposition the \textit{Insertion Point}. +\begin{figure}[htpb] + \centering + \includegraphics[width=0.4\linewidth]{i-beam.png} + \caption{I-beam + in/out + labels} + \label{fig:i-beam} +\end{figure} + When the I-beam is highlighted, you are in \emph{cut and paste mode}. In cut and paste mode, clicking the LMB in the timeline does reposition the \textit{Insertion Point}. Double clicking in the timeline selects the entire edit the cursor is over, i.e.\ that column. @@ -300,13 +307,6 @@ Dragging in the timeline with the LMB pressed down, highlights a selected region and paste operations. It is also the playback range used for the subsequent playback operation. Holding down the Shift key while clicking in the timeline extends the highlighted region. -\begin{figure}[htpb] - \centering - \includegraphics[width=0.4\linewidth]{i-beam.png} - \caption{I-beam + in/out + labels} - \label{fig:i-beam} -\end{figure} - \subsection{In/Out Points}% \label{sub:in_out_points} \index{in/out point} @@ -355,6 +355,12 @@ Some of the useful operations concerning the In/Out pointers are listed next. \item[Ctrl-t] clears both In/Out points \end{description} +\subsection{Guide on timeline}% +\label{sub:guide_timeline} +\index{guide lines} + +It can be useful to have visual reference points on the timeline to help you position edits relative to other tracks. For example in manual synchronization of audio and video. You can set two points on the timeline with In/Out points or by selecting a range in Cut and Paste mode. Now we use \texttt{Settings $\rightarrow$ Loop Playback} (Shift - L) to make two vertical green lines appear at the edges of the selection. Originally this function is used to limit the playback within this range, but we can take advantage of the fact that the green lines remain even when we move the insertion point or delete the In/Out points or deselect the range. So they can be used as a visual reference when we want to move the edits precisely. To delete these guides press \textit{Shift-L} again. + \subsection{Labels}% \label{sub:labels} \index{label}