add ganging section by Andrea + minor fixes
authorGood Guy <>
Tue, 30 Jun 2020 21:00:00 +0000 (15:00 -0600)
committerGood Guy <>
Tue, 30 Jun 2020 21:00:00 +0000 (15:00 -0600)
images/gang-track-01.png [new file with mode: 0644]
images/gang-track-02.png [new file with mode: 0644]
images/gang-track-03.png [new file with mode: 0644]

diff --git a/images/gang-track-01.png b/images/gang-track-01.png
new file mode 100644 (file)
index 0000000..3aff731
Binary files /dev/null and b/images/gang-track-01.png differ
diff --git a/images/gang-track-02.png b/images/gang-track-02.png
new file mode 100644 (file)
index 0000000..620456f
Binary files /dev/null and b/images/gang-track-02.png differ
diff --git a/images/gang-track-03.png b/images/gang-track-03.png
new file mode 100644 (file)
index 0000000..f1fee40
Binary files /dev/null and b/images/gang-track-03.png differ
index 9679e5337c542824097e6bab1a06a7fe13beef8a..13397533add109426189fa476dafb28670e84fce 100644 (file)
@@ -80,13 +80,13 @@ patchbay enables features specific to each track as described next.
 Below the textbox name are several toggles referred to as
-\textit{attributes} for different features (currently there are 5 as
+\textit{attributes} for different features (currently there are 7 as
 shown in figure~\ref{fig:patchbay01}).  If the toggle button is
 shadowed by a color, the feature is enabled. If the toggle is the
 background color of most of the window, it is disabled. Click on the
 toggle to enable/disable the feature.
@@ -109,7 +109,7 @@ other tracks. Or you can:
   attribute in the adjacent track.
-The 5 \textit{attributes} are described here next followed by the other available feature icons and their description.
+The 7 \textit{attributes} are described here next followed by the other available feature icons and their description.
 \item[Play Track] determines whether the track is rendered or
@@ -162,6 +162,7 @@ The 5 \textit{attributes} are described here next followed by the other availabl
 of the 5 attributes, is used to individually resize each track.  This makes
 it very easy to temporarily expand or contract the size of that track either
 by clickin with the left mouse button or using the middle wheel up/down.
+\item[Master Track] Mark a track as \textit{master} serves when using \textit{Gang Channels} or \textit{Gang Media} mode. see ...
 \item[Fader slider] fade values are represented on the timeline
   with a pink (default color) curve that is keyframable.  All tracks have a fader, but
   the units of each fader depend on whether it is audio or video.
@@ -305,6 +306,69 @@ video, the new track is put on the top of the timeline. This way,
 video has a natural compositing order. New video tracks are overlaid
 on top of old tracks.
+\subsection{Displaying tracks: Ganged mode}%
+Often users working on media where Audio is the main focus, want all of a media's audio channels, whether stereo or 5:1 channels, to be treated as a single unit. They are more familiar with working with a DAW (Digital Audio Workstation software) and find that it takes extra work and a lot more care to have to individually manage audio tracks rather than have them automatically edited as a ganged group.
+To use this capability, there is a \textit{Gang Tracks} toggle button on the main timeline controls to switch between 3 modes of working with multiple channels so that the tracks are automatically edited as a single unit. Operations affected include edits such as cuts, moving sections, and adding plugins. Group masters are marked by the \textit{Master Track} toggle in the patchbays. A track gang group begins on a master track, and extends to but does not include the next master track. The 3 \textit{Gang Tracks} modes are:
+       \item \textbf{Gang None:} this is the default mode and is the traditional way Cinelerra operates. If you never toggle the "Gang Tracks" button, everything operates normally as it always has. In this mode, the button icon looks like 3 tracks with $\dots$ on the end and all tracks are visible on the timeline. See figure~\ref{fig:gang-track-01}.
+       \centering
+       \includegraphics[width=0.99\linewidth]{gang-track-01.png}
+       \caption{Gang None: only the video track is master. We see all tracks, both master and non-master (default).}
+       \label{fig:gang-track-01}
+       \item \textbf{Gang Channels:} in this mode, only the \textit{Master Tracks} and the first track of video, audio, or subtitles which are not master tracks are shown. Stereo tracks, or 5:1 channels/any number of audio tracks, are drawn as 1 audio track for the purpose of making changes on that single track which are then propagated to all of its other channel tracks automatically. This is the DAW-like mode. The \textit{Gang Tracks} button icon looks like 2 tracks and only the first video and first audio tracks will be shown. See figure~\ref{fig:gang-track-02}.
+       \centering
+       \includegraphics[width=0.99\linewidth]{gang-track-02.png}
+       \caption{Gang Channels: only the video track is master. We see the master tracks and the first of the non-master tracks.}
+       \label{fig:gang-track-02}
+       \item \textbf{Gang Media:} this mode only shows the \textit{Master Tracks} of the media but changes are propagated to the appropriate other related tracks (even if they are not visible). The \textit{Gang Tracks} button icon looks like a single track. See figure~\ref{fig:gang-track-03}.
+       \centering
+       \includegraphics[width=0.99\linewidth]{gang-track-03.png}
+       \caption{Gang Media: only the video track is master. We only see the master tracks.}
+       \label{fig:gang-track-03}
+The current \textit{Gang Tracks} mode is saved across sessions and will be saved in your project. Although most users will work in the \textit{Gang None} mode, those more familiar with DAW software will tend to use the \textit{Gang Channel}s mode.
+To understand why certain aspects work the way they do in the gang modes, here is an explanation.
+Adding in this DAW-like feature to long time existing code called for an exact algorithm because tracks are
+not inherently bound or in a container. Because of this, there is a requirement that the tracks have to be
+lined up at the beginning and this timeline alignment is what creates the binding and allows for ganging.  
+Next, more details about master tracks are explained, which in addition to the alignment help to define the
+scope of a grouped gang. Each patchbay has a \textit{Master Track} button on the extreme right of the patchbay. These mark which tracks of the media are master tracks. The span of tracks between the gang group masters are the gang track group. The master track toggles can be disabled/enabled as the user wishes to create the desired track groups. Normal file loads will mark the first stream of each file loaded as a master if the media is loaded with insertion strategy of\textit{ Replace current project}, \textit{Replace current project and concatenate tracks} or \textit{Append in new tracks}. Frequently, editing is done on video, audio, or audio/video groups to maintain timeline synchronization. By grouping related tracks, this procedure is much more automatic.
+Previously existing projects created before the addition of ganged tracks, will have ALL tracks marked as master tracks and changing the \textit{Gang Tracks} button mode will have no effect. The user will have to properly designate which track is the master track and disabling the others in order to make use of the toggle modes.
+There are no restrictions on how you use this feature and there may be variations for users not concerned about DAW-like workings that are very useful. Several methodologies are possible, but you have to know what you are doing.
+       \item When in \textit{Gang Channels} or \textit{Gang Media} mode, if the first audio track is not disarmed, but         any of its connected channel tracks are, the disarm of those channels are ignored and all channels are treated as being armed. This is to be consistent with the purpose of using this mode; the purpose being that any edits to the first master track are automatically propagated to all other channels.
+       \item It may be better when using the \textit{Gang Channels} or \textit{Gang Media} mode to make any changes
+       to the first audio channel to be automatically duplicated before reverting to the \textit{Gang None} mode to make other changes. Once you start changing individual channels (that is, audio tracks) so that they are no longer coordinated in their edits/plugins, it may be more difficult to switch back to \textit{Gang Channels} mode and get the desired results since the channels may no longer be lined up.
+       \item When in Drag and Drop mode and you create a \textit{Permanent Group} as described in section
+~\ref{sub:grouping_edits} the grouping does not take precedence over ganging; i.e. they are ignored and only
+the timeline alignment is honored.
 \section{Two Screen Editing}%
index 4fee3f1eef6722d9807df6f39d04cee71cf37600..cd600a363e504cee044cb8843af979e67fe8dea9 100644 (file)
@@ -469,16 +469,14 @@ communication, shared filesystem, permissions and usernames synched.
   \item set the Total number of jobs to create;
   \item click OK on the bottom of the Preferences window.
-\item On the client computers ($$), start 5 background
-  \CGG{} tasks via:
+\item Now we must join the nodes created to instances of \CGG{}. On the client computers ($$), on the terminal, start 5 background  \CGG{} tasks via:
 cd {path_to_cinelerra}
 cin -d 401 cin -d 402
 cin -d 405
-\item On the master node (localhost), start the 2 background \CGG{}
-  tasks via:
+\item Similarly, on the terminal, we must join the local nodes created to instances of \CGG{}. On the master node (localhost), start the 2 background \CGG{}  tasks via:
 cd {path_to_cinelerra}
 cin -d 406
@@ -850,10 +848,10 @@ count, setting up a render farm can really take advantage of using
 all of the cpus. This is much faster than the default automatic
 threading capability. Since you don’t need to communicate with other
 computers, you will not have to be concerned about TCP communication
-or shared disks/files. When you are going to be doing other work
+or shared disks/files; only localhost nodes. On the terminal, we will open many instances of \CGG{} by connecting them to the jobs created. The number of such jobs can be the total number of CPU threads or not. When you are going to be doing other work
 simultaneously while rendering a large job, you will want to leave
-some of the cpus available for that.  Be sure to set Project SMP
-cpus” in the Settings $\rightarrow$ Preferences, Performance tab to your CPU
+some of the cpus available for that.  Be sure to set \textit{Project SMP
+cpus} in the \texttt{Settings $\rightarrow$ Preferences, Performance} tab to your CPU
 \subsection{Troubleshooting Tips and Warnings}%
index f3c096fac00bf9f8e49484c78fc99bf5dbab9ffd..21f883f8788f0e23cee511c6bf9ec5656a9afc02 100644 (file)
@@ -273,10 +273,12 @@ The Main window (also called the program window) consists of pulldown menus, but
   & $\uparrow$ (up arrow) & Ctrl & Increase audio sample waveform scale. \\
   & $\uparrow$ (up arrow) & Alt & Increase auto curve limits (zoombar selected curve). \\
   & $\uparrow$ (up arrow) & Ctrl-alt & Increase all auto curve limits. \\
+  & $\uparrow$ (up arrow) & Shift & Move all tracks up by 1. \\
   & $\downarrow$ (down arrow) &  & Decrease timeline duration (zoom in timeline). \\
   & $\downarrow$ (down arrow) & Ctrl & Decrease audio sample waveform scale. \\
   & $\downarrow$ (down arrow) & Alt & Decrease auto curve limits (zoombar selected curve). \\
   & $\downarrow$ (down arrow) & Ctrl-alt & Decrease all auto curve limits. \\
+  & $\downarrow$ (down arrow) & Shift & Move all tracks down by 1. \\
   & PGUP (page up) &  & Scroll current track vertical window pane up. \\
   & Mouse wheel & UP & Scroll current track vertical window pane up. \\
   & PGUP (page up) & Ctrl & Increase track scale geometry (zoom in track data). \\