\item[Fader slider] fade values are represented on the timeline with a pink curve that is keyframable. All tracks have a fader, but the units of each fader depend on whether it is audio or video. Audio fade values are in dB. They represent relative levels, where 0 is the unaltered original sound level, -40 is silence, -80 the minimum value set by default. You can move fader and keyframes down to -80 but the parameter's curve won't go below -40. For your convenience you can set a different fade range with the curve zoom. Audio fader’s main purpose is to \textit{fade out} sound or to lower the sound level smoothly to silence, or \textit{fade in} to make sounds appear gradually instead of suddenly. Video fade values are the percentage of opacity of the image in normal overlay mode, the percentage of the layer that is mixed into the render pipeline in the other overlay modes.
Click and drag the fader to fade the track in and out. If it is ganged to other tracks of the same media type, with the arm option enabled, the other faders should follow. Hold down the Shift key and drag a fader to center it on the original source value (0 for audio, 100 for video).
\item[mixer] in the expanded patchbay for that track designate the multi-camera mixer mode.
- \item[Overlay mode] in the expanded patchbay is used for porter-duff operations and is full explained in Overlay Modes \ref{cha:???}.
+ \item[Overlay mode] in the expanded patchbay is used for porter-duff operations and is full explained in \nameref{cha:overlays} chapter.
\item[Nudge] is in the expanded patchbay. The nudge value is the amount the track is shifted left or right during playback. The track is not displayed shifted on the timeline, but it is shifted when it is played back. This is useful for synchronizing audio with video, creating fake stereo, or compensating for an effect which shifts time, all without altering any edits (figure~\ref{fig:overlay}).
\begin{figure}[htpb]
\section{Two Screen Editing}%
\label{sec:two_screen_editing}
-This is a fast way to construct a program out of movie files. The idea consists of viewing a movie file in one window and viewing the program in another window. Subsections of the movie file are defined in the viewer window and transferred to the end of the program in the program window. Two screen editing can be done simply by using keyboard shortcuts. To get familiar with which keys to use, move the mouse pointer over the transport panel and a tooltip appears, showing what key is bound to that button.
+This is a fast way to construct a program out of movie files (in other programs is called \textit{three points editing}). The idea consists of viewing a movie file in one window and viewing the program in another window. Subsections of the movie file are defined in the viewer window and transferred to the end of the program in the program window. Two screen editing can be done simply by using keyboard shortcuts. To get familiar with which keys to use, move the mouse pointer over the transport panel and a tooltip appears, showing what key is bound to that button.
To begin a two screen editing session, load your media resources by using the main menu \textbf{File pulldown} and choose \textit{Load files}; make sure the insertion mode is set to \textit{Create new resources only}. This insertion strategy is to ensure that the timeline stays unchanged while new resources are brought in. Go to the Resources window and select the Media folder. The newly loaded resources will appear. Double click on a resource or drag it from the media side of the window over to the Viewer window.
\paragraph{Copy} The copy icon, or shortcut letter “c”, copies the selection into the copy buffer.
+\subsection{Use Case – Working with Sequences}
+\label{sub:use_case_working_sequences}
+
+\textit{From the Viewer to the Timeline with the sequences imported
+in a Master Project.}
+
+A convenient methodology for working on a Master project along with 1 or more previously saved Sub projects or \textit{sequences} use case is described here. A sequence is an edited assembly of audio and video clips generally consisting of a series of videos that relate to the same activity. This use case explains how to work this way and some things you need to be aware of.
+
+\begin{enumerate}
+ \item First load your Master project, which you worked on and saved earlier as an \texttt{.xml} file, using an Insertion strategy of \textit{Replace current project}. Generally this Master project consists of media with any of the attributes of clips, autos, possibly keyframes, and effects. You will see your project on the main timeline and the Media files that are part of this Master project will be displayed in the Resources window in the Media folder.
+ \item Previously you may have also saved a Sub project, which will now be referred to as a Sequence, as an \texttt{.xml} file that may contain any of the same such things: media, clips, autos, keyframes, effects. Second you will want to load the Sequence using an Insertion strategy of \textit{Create new resources only}. When you do the load, this Sequence will show as a file in the Resources window in the Clips folder. The actual media will show in the Media folder.
+ \item Now Drag and Drop the Sub project from the Clips folder to the Viewer.
+ \item Set In and Out Pointers in the Viewer to the region of interest in the Sub project and in the Timeline of the Main window of your Master project, move the cursor position to where you would like to insert this In/Out section.
+ \item Click on the \textit{Splice (v)} button in the Viewer to insert this section into the Master project timeline. All of the attributes of the selected Sub project section will now be inserted in the main timeline to include the autos, keyframes, effects, and labels.
+ \item Alternatively, if you click on the \textit{Overwrite (b)} button in the Viewer, you can see the Sub project In/Out section in the timeline, but without its autos, effects, keyframes, etc. If in the timeline there were some autos, effects, and keyframes in that Master project, they will be in effect for the new section.
+\end{enumerate}
+
+You can see the advantages of using Splice versus Overwrite to either insert (splice) with all of the attributes of a specific section of your Sequence or to overwrite without the attributes to allow for the smooth operation on the timeline by retaining the timeline’s attributes at that point.
+
+NOTE: for correct operation of this use case, you should have the same (or more) number of tracks in the Master project as you do in the Sequence. To avoid having to know how many tracks you need, you can use the Nest feature as described in the Nesting section (\ref{sub:nesting}).
+
\section{Cut and Paste Editing}%
\label{sec:cut_paste_editing}
\paragraph{Split --- blade cut and hard edges:} You can cut the tracks into 2 pieces on the timeline by putting the hairline cursor on the place you want to do a cut and then using the character “x” or the scissors tool (figure~\ref{fig:cut}).
\begin{wrapfigure}[16]{O}{0.3\linewidth}
- \vspace{-1ex}
+ \vspace{1ex}
\centering
\includegraphics[width=0.9\linewidth]{images/cut.png}
\caption{Blade cut}
Cinelerra fills out the audio and video tracks below the dragging cursor with data from the file. This affects what tracks you should create initially and which track to drag the media onto. To drag and drop a file on the Program window, you need to create on the timeline the same set of tracks as your media file.
-When you drag your chosen media from the media folder to the timeline, your mouse pointer will drag a thumbnail and, once over the timeline, the outline of a white rectangle, as big as the edit you are going to have appears. Drag the media to the desired position of an empty track of the timeline and drop it. If there are other edits on that track, when you move the white outline over an edit, you will see a bow tie symbol $\rhd\lhd$ appearing at edit boundaries. If you drop the media there, the new edit will start from the edit boundary indicated by the center of the bow tie $\rhd\lhd$.
+When you drag your chosen media from the media folder to the timeline, your mouse pointer will drag a thumbnail and, once over the timeline, the outline of a white rectangle, as big as the edit you are going to have appears. Drag the media to the desired position of an empty track of the timeline and drop it. If there are other edits on that track, when you move the white outline over an edit, you will see a bow tie symbol $\bowtie$ appearing at edit boundaries. If you drop the media there, the new edit will start from the edit boundary indicated by the center of the bow tie $\bowtie$.
Since the mouse pointer is in the middle of the white outline, when this rectangle is bigger than the visible part of the timeline, it is quite cumbersome to precisely insert it for long media. Lengthening the duration visible in the timeline by changing the sample zoom in the zoom panel will reduce the size of the white rectangle, making a precise insertion possible.
\noindent When you drag and drop edits within the timeline:
\begin{itemize}
- \item If you drop an edit when bow ties $\rhd\lhd$ are shown, that edit will be cut and pasted starting at the edit
- boundary indicated by the center of the bow tie $\rhd\lhd$. Following edits on the same track will move.
- \item If you drop an edit when there are no bow ties $\rhd\lhd$ shown, the original edit will be muted and pasted
+ \item If you drop an edit when bow ties $\bowtie$ are shown, that edit will be cut and pasted starting at the edit
+ boundary indicated by the center of the bow tie $\bowtie$. Following edits on the same track will move.
+ \item If you drop an edit when there are no bow ties $\bowtie$ shown, the original edit will be muted and pasted
where you dropped it. No edits will move. A silence will appear in place of the original edit.
\item If you have more armed tracks on the timeline than in the asset you are dragging, only the following
edits of the tracks affected by the drag and drop operation will move to the right. This will cause loss
Attaching transitions to multiple selected edits via the Video or Audio pulldowns is also available. The new transitions are attached at the start of the edits, and will replace any existing attached transitions.
-\subsection{Copy/Paste Behavior}%
-\label{sub:copy_paste_behavior}
+\subsection{Grouping edits}%
+\label{sub:grouping_edits}
Cinelerra recognizes as a group, the edits of different armed tracks that have aligned beginnings, regardless of whether they have the same source or aligned ends. You can drag these edits around on the timeline to construct your movie by rearranging scenes. If more than one track is armed, Cinelerra will drag any edits which start on the same positions the edit the mouse pointer is currently over. \\
Another method of Grouping of edits is performed as follows:
\end{itemize}
This last section on Dragging, outlines the difference between \textit{column selection} and \textit{marking selection}. Column selection is available to make it easy to still be able to do some dragging in I-beam mode whereas Marking selection makes it easy to drag clips together that are not columnated.
+\subsection{Selection Methods}%
+\label{sub:selection_method}
+
+Concerning \textit{Selection} methods, the following information is partially pertinent to all editing, but is most important to keep in mind when using Drag and Drop Editing.
+
+Originally, there was the column oriented timeline drag selection which can be seen
+in 1 of 3 ways:
+
+\begin{enumerate}
+ \item a highlighted vertical column
+ \item the colored line region between the [ in and ] out marker labels
+ \item a single flashing line
+\end{enumerate}
+
+The selection priority works like this. When the highlighted vertical drag column is in use (1), it has the highest precedence and is used
+as the selection. When the column is a single line (2), then the fall back
+selection is the [in/out] marker region, if they are set. When they
+are not set, and the cursor is flashing, then the selection start=end
+and the selection is empty, but it does have a position on the
+timeline which can be used for editing. This is input for the
+vertical style cut/paste drag/drop editing.
+
+More recently, in addition to the column oriented timeline drag selection, there is now \textit{group}
+capabilities which have various \textit{edit} selections. These are
+created in the Drag and Drop editing mode by clicking edits to toggle
+select/deselection. These groups are input to a different (more modern) set
+of cut/paste/overwrite drag/drop editing. You can see this set of
+operations when you click on an edit with the middle mouse
+button, and are also available using the shortcuts shown. They are more like text
+editor commands to include \texttt{ctrl+x=cut}, \texttt{ctrl+c=copy}, \texttt{ctrl+v=paste}, and so on $\dots$
+The keyboard Delete key is not hooked to these operations, and is hooked to the
+original editing methods.
+
+In this "group" mode, if there are In/Out markers set, they enter the selection priority queue
+between the column selection and the cursor only. You can see the In/Out markers selected
+region colored line across the timebar (slightly underneath where the time, samples or frames show
+) on the main timeline
+extending between the [ and ]. This means that when
+the highlighted cursor selection is empty, the In/Out selection will be used.
+
+
\section{Inter-View Mode / Identifying Source Targets Editing}%
\label{sec:inter-view_identifying_source_target_editing}
\item You can see which parts of that particular media are already used so you do not reuse that same
piece again.
\end{itemize}
-Figure~\ref{fig:inter-view01} shows an example of the Inter-View mode mapping preview mini-window..
+Figure~\ref{fig:inter-view01} shows an example of the Inter-View mode mapping preview mini-window.
+
\begin{figure}[htpb]
\centering
\includegraphics[width=0.8\linewidth]{images/inter-view01.png}
is updated with that start position.
\end{itemize}
+\pagebreak
Figure~\ref{fig:inter-view02} displays Inter-View window and its relation to the timeline, viewer, and compositor.
-\begin{figure}[htpb]
+\begin{figure}[ht]
\centering
\includegraphics[width=0.9\linewidth]{images/inter-view02.png}
\caption{Inter-View mode and the timeline}
\label{fig:inter-view02}
\end{figure}
+
The Inter-View mode works for Media, Proxy, and User Bins. When the preview window has only black bars on the top and bottom, it means that this particular media is not loaded in the timeline. So when you are in Proxy, meaning that the Proxy files are loaded on the timeline, there will be only black bars for the corresponding Media file UNLESS there is an audio track associated with the video. Because audio tracks are not proxied, they will show for Media but not for Proxy.
\section{Some Specific Editing Tools}%
This section covers some more detailed editing tools and scenarios for edit management.
+\subsection{Editing EDLs within a Project}%
+\label{sub:edit-edls}
+
+To edit EDL that is included with your project as Clips, Nested Clips, Referenced File, or Xml you can use the option "Open EDL"
+in the Resources window for the highlighted media. Then with a simple button click you can return to your main
+timeline project. For example, if you have a nested clip that originally had several plugins added to it before
+it was nested, you can edit those plugin parameter values. Previously to make any changes to these types of EDL
+you had to remake the whole clip from scratch.
+
+Here is how this works. In the Clip or Media folder or on a timeline EDL edit, the option "Open EDL" for the highlighted clip or nested clip is available so that when you choose this option, that EDL will be brought up on the timeline superseding the current EDL that exists on the timeline. Now, once the clip is open on the timeline, you can edit it however you want. The previous timeline EDL is "pushed onto a stack" so it can be recalled by "popping the stack" with a click of the left mouse button in the upper right hand corner of the timeline to the left of the "shell cmds" icon. Initially this button displays a 0 to indicate your initial timeline/project. Then this button will read 1 if you choose "Open EDL" and then back to 0 and your original timeline with the left mouse click. You can go several levels deep so instead of 1, it could be 2, 3, ... but this requires some thought to avoid potential confusion.
+\\
+
+An example of a typical set of steps to follow is:
+
+\begin{enumerate}
+ \item Load your media using insertion strategy of "Replace current project". There will be \# 0 in the
+ upper right hand corner of the main menu with the tooltip of "Close EDL".
+ \item Highlight a selection on the timeline and press the "To clip" icon and click the green checkmark OK.
+ \item In the Resources window, open the Clip folder and you will see that Clip 1 is present.
+ \item Highlight Clip1 and right mouse the item to bring up available options and select "Open EDL".
+ \item Now you will see the timeline change from the original media to just the clip content and the \# in the
+ upper right hand corner will change from 0 to 1.
+ \item Add a visible effect, like AgingTV to the timeline.
+ \item Click on the \# 1 in the main menu bar to see he timeline restored to the original media.
+ \item Drag the clip from the Resources Clip folder to the timeline and you will see the AgingTV effect.
+\end{enumerate}
+
+You can follow the same steps as above by first using the option "Nest to media" in the Clip folder which nests the clip and moves it out of the Clip folder to the Media folder. Then use "Open EDL" on the Nested EDL in the media folder. When you Open EDL and edit the changes, those changes will take affect on any and all occurrences of that nested clip on the current and/or original timeline. The option to unnest that clip and put that back into the Clip folder is the option "EDL to clip". The nested clip is still in the Media folder. It will now have a name of the next available Clip \# but the comment contains the previous name so you can tell where it came from.
+
+Instead of using the \# number on the main menu to close the current EDL, both the Media and Clip folders have "Close EDL" options with the left mouse button. Clicking on the \# number is quick and easy but for infrequent usage it is not obvious, whereas if you use "Open EDL" you see "Close EDL" right below that and so it is very obvious. In addition in the case of where you have opened a EDL, and you no longer see that clip in the folder, the right mouse button where no media is highlighted will also display the Close EDL option.
+
+\pagebreak
+\begin{figure}[h]
+ \centering
+ \includegraphics[width=0.8\linewidth]{images/editing-img001.png}
+ \caption{Once you have an an Open EDL, there are 2 ways to close it.}
+ \label{fig:open_edl}
+\end{figure}
+\relax
+
+In addition to the "Open EDL" option in the Resources menu, this option is available on the timeline when the cursor is on an EDL-type edit.
+To get to this option, click on the middle mouse button on that edit. If it is not EDL, the option will not be shown. In summary:
+
+\begin{center}
+ \small
+ \begin{tabular}{l l}
+ \toprule
+
+ Media folder of Resources window & Open EDL for Nested or Referenced EDLs \\
+ Clip folder of Resources window & Open EDL for clips \\
+ Track timeline & Open EDL for Nested or Referenced EDLs \\
+ \bottomrule
+ \end{tabular}
+\end{center}
+
+An aside - when nesting and unnesting clips to take advantage of this feature, names of the media can lead to some confusion. For example, if you nest a clip, the new name in the Media folder is the word "Nested" followed by an underscore with the date and timestamp, another underscore, and then the clip name. Then when you unnest this Media folder clip via the "EDL to clip" option, the name will be changed in the Clip folder to the next available Clip \#. However the comment field will reflect the nested clip name from which it was derived. To avoid confusion you can easily change the name for these clips in either the Clip or Media folder because they are not real files at this point. To do so, highlight the clip name in Resources, click on Info and type in a new name.
+
+For additional safety, the "Open EDL" feature includes additional backup capabilities. Automatically Cinelerra saves a backup when certain changes are made or you can always use the shortcut "b" to do one yourself, although keep in mind it will be overwritten whenever Cinelerra wants to do another backup. Now there is a shortcut for the backup shortcut "b" so you can keep your hand on the mouse instead of the keyboard. Just click on the \# in the upper right hand corner of the main window. If \# is at 0, it backs up to backup.xml, if at 1, it backs up to backup1.xml and so on ... up to backup9.xml.
+
+When "Open EDL" is invoked, the current EDL and current undo stack are both "pushed", and the active session EDL is replaced with the target clip/nested edl. A new undo stack is created, and the active backup.xml file name is decorated with the stack level. So, backup.xml is backup1.xml when your edits are at stack level 1, backup2.xml at stack level 2, and so on. This means that if you "load backup" at stack level 1, the session will reload from history at stack level 1, not the main session.
+
+\begin{comment}
+\begin{figure}[htpb]
+ \centering
+ \includegraphics[width=0.6\linewidth]{images/lenght.png}
+ \caption{Edit Length window}
+ \label{fig:lenght}
+\end{figure}
+\end{comment}
+
\subsection{Edit Length}%
\label{sub:edit-lenght}
\end{description}
The next table displays the options and results with the Key Table here first.
-\begin{lstlisting}[language=bash]
+\begin{lstlisting}[language=bash,numbers=none]
s = src media start\\
p = proj position \\
l = length \\
It is somewhat important to note that nested assets and nested clips will have index files automatically created. These index files can start to clutter up your \texttt{\$HOME/.bcast5} directory with files named \texttt{Nested\_\#\#\#.idx} and you may want to periodically delete any index files which are no longer in use.
-\paragraph{Nested Clips} It is also possible to create \textit{clips} and convert them to \textit{nested edl}. This is done by first creating a clip using the standard cut, clipboard, paste, and/or edit panel buttons. Now, using the resources \textit{clip} folder, select a clip to be nested, and use the right mouse button to select a clip. This activates the clip popup menu. Select the \textit{Nest} menu item, and the clip will be converted to a \textit{Nested: Clip}. Conversely, you can select a \textit{Nested: Clip}, use the \textit{UnNest} menu item, and the clip will be reverted to a \textit{Clip}. This works similarly to the group / un-group editing features of many graphic design editing programs, but in this case the groups are rendered compositions. They can not be proxied (figure~\ref{fig:nesting}).
+\paragraph{Nested Clips} It is also possible to create \textit{clips} and convert them to \textit{nested edl}. This is done by first creating a clip using the standard cut, clipboard, paste, and/or edit panel buttons. Now, using the resources \textit{clip} folder, select a clip to be nested, and use the right mouse button to select a clip. This activates the clip popup menu. Select the \textit{Nest to media} menu item, and the clip will be converted to a \textit{Nested: Clip}. Conversely, you can select a \textit{Nested: Clip}, use the \textit{EDL to clip} menu item, and the clip will be reverted to a \textit{Clip}. This works similarly to the group / un-group editing features of many graphic design editing programs, but in this case the groups are rendered compositions (figure~\ref{fig:nesting}).
+
+Nested clips can be proxied and when they are, the resulting files
+are placed in the user's \$HOME/Videos directory by default. This can be modified by changing
+
+Settings $\rightarrow$ Preferences $\rightarrow$ Interface tab, Nested Proxy Path.
\begin{figure}[htpb]
\centering
\includegraphics[width=0.9\linewidth]{images/nesting.png}
\label{fig:nesting}
\end{figure}
+\paragraph{Usage Examples of Nested Clips}
+
+\begin{description}
+ \item[Example 1:] You want to make a flashback/rewind at the end of your video
+that represents a quick summary of the entire video in black and white. On
+he timeline, you have 60 seconds of edits with clips, cuts, zoom in, zoom
+out and any other edits. Now you want to get this 60 seconds "compressed"
+to 10 seconds, play in reverse, and in black and white at the end of your
+ video.
+ You would copy the 60 seconds in a clip, nest the clip in the Clip folder
+of the Resources window and drag it to the timeline. You will see only a
+clean clip without all of the edits that were used to create it because
+nesting display a clip without having to actually use the Render menu.
+ Now you can add a Reverse effect, Color3way plugin for black and white, and
+use the Speed auto to get the 60 seconds down to only 10 seconds.
+ \item[Example 2:] You are working on a complex project with a team in a separate
+location. You create some sub projects, i.e. sequences, that you or the
+team will use in the Master project to merge the sequences in the right
+order and to make the final color correction steps.
+\end{description}
+
+In each of the examples you can see the benefit of nesting to create clean
+looking timelines because of the automatic rendering capability of nesting.
+
\subsection{Copy/Paste clips/medias across Multiple Instances}%
\label{sub:copy_paste_multiple_instances}
\vspace{1ex}
\noindent Only 1 necessary initial setup is required due to permission settings for non-root usage. As root, just copy a file that provides the necessary permissions to use the shuttle, then reboot, Example copy:
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
$sudo cp {cindat_path}/doc/99-ShuttlePRO.rules /etc/udev/rules.d/
\end{lstlisting}
\noindent then the next time after you reboot, the permissions should be correct. This file only needs to contain one of the following lines depending on which shuttle version you have/use, but all will be in the file.
-\begin{lstlisting}[language=Bash,basicstyle=\footnotesize]
+\begin{lstlisting}[language=Bash,,numbers=none,basicstyle=\footnotesize]
# for newer PRO model
ATTRS{name}=="Contour Design ShuttlePro" MODE="0644"
# for older PRO model
\noindent The next brackets represent sections. Default, Resources, Load windows all use the same key values.
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
[Default]
[Resources]
[Load]
\noindent Cinlerra with brackets around it next, is the section with some key definitions for the main window.
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
[Cinelerra]
# Most useful functions have to be on K5-K9 because Xpress only has 5 keys
For the Viewer, you may want keys defined to do a Splice or an Overwrite so define differently. Note that assignments that contain single character letters must be enclosed in quotes.
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
[Viewer]
# Splice - Viewer only; may be defined differently than Composer or Cinelerra
K2 "v"
\noindent To change any key value to an alternative value, just edit the file and make the changes. Besides just keys and alphabetic letters of numbers, you can also use any cinelerra value that contains the combination with Shift, Alt, and Ctrl. For keys that are not printable characters, you can look up the symbol name to use for a specific operation in the file called: \texttt{/usr/include/X11/keysymdef.h} .
\noindent Some examples:
-\begin{lstlisting}[language=bash]
+\begin{lstlisting}[language=bash,numbers=none]
K10 Alt-XK_Left # Go to previous edit \\
K13 Ctrl-XK_Right # Go to next label
\end{lstlisting}
After modifying \texttt{.shuttlerc}, the next time you use the shuttle, your changes will automatically take affect without even having to stop and restart Cin. However, the first thing to try if problems is to stop cinelerra, unplug the shuttle, wait a few seconds, plug it in again, and then restart cin. If for some reason, the shuttle keys still do not work after that, you may have an incorrect setup and you will have to correct that first. For example, if you define S5 twice within the Cinelerra setup, it will fail. It is suggested that if you make changes, you should initially uncomment DEBUG in the \texttt{.shuttlerc} file and start up cinelerra from a terminal window so that you can make sure it is working and has no output errors. An error might look like:
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
dupl key name: [Cinelerra]K1
shuttle config err file: /root/.shuttlerc, line:37
\end{lstlisting}
Any time you are having trouble with your shuttle, you can copy the default \texttt{shuttlerc} file from \texttt{{cindat\_path}/shuttlerc} to your local \texttt{.shuttlerc} file, and edit that to\ switch to DEBUG mode by removing the \# comment from the DEBUG line. But you will have to have started Cin from a terminal window to see the key values. The first time you use the shuttle or after you change the file, the current assignments will show in the terminal window so will look something like:
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
[Cinelerra] # 1
K5[D]: XK_KP_0/U
K5[U]: XK_KP_0/U
\noindent When you are in DEBUG mode and are just working away, what you will see is something like this:
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
key: 0058 1
key: 0055 0
\end{lstlisting}
or:
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
shuttle: 00 00 00 00 00
key: XK_Home 0
\end{lstlisting}
\noindent When you change the focus from one window to another, you will see something like this:
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
new focus: 04c00137
new translation: Viewer
key: 0059 1
\noindent You can also set an environment variable to temporarily use an alternative shuttle configuration file for testing as in:
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
$ export SHUTTLE_CONFIG_FILE=/tmp/shuttlerc_test
\end{lstlisting}
In order to see if you hardware was recognized by the operating system, key in:
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
$ lsusb -v -d 0b33:0030 # for the Shuttle Pro or PROv2 \\
$ lsusb -v -d 0b33:0020 # for the Shuttle Xpress
\end{lstlisting}
\item From a terminal window as an ordinary user key in: lsusb (the first character is a lower case L ---for
list). You will see something like the following depending on which usb device you have the
ShuttlePro plugged into:
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
Bus 003 Device 002: ID 0b33:0030 Contour Design, Inc. ShuttlePro v2
\end{lstlisting}
\item To make sure you have usbmon installed key in:
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
$ sudo modprobe usbmon
\end{lstlisting}
\item Next key in the following:
-\begin{lstlisting}[language=Bash]
+\begin{lstlisting}[language=Bash,numbers=none]
$ sudo od -tx1 /dev/usbmon3
\end{lstlisting}
where the last 3 is the same \# as the Bus in above. If it lists \texttt{Bus 002}, then use \texttt{/dev/usbmon2} instead.
have multiple devices on the same bus, you will get responses from any and all of them. Attempt to
isolate your shuttle by temporarily unplugging unnecessary devices on the same bus or plug the
shuttle into a different usb port that has fewer devices.
- \begin{lstlisting}[language=Bash]
+ \begin{lstlisting}[language=Bash,numbers=none]
0000000 80 70 99 75 53 8c ff ff 43 01 81 02 03 00 2d 00
0000020 4e 61 5c 5c 00 00 00 00 8d 2c 06 00 00 00 00 00
0000040 05 00 00 00 05 00 00 00 00 00 00 00 00 00 00 00
\item Compile that with the command: \texttt{c++ shdmp.C -o shudmp}
\item Make the file executable with the command: \texttt{chmod +x shudmp}
\item Execute:
- \begin{lstlisting}[language=Bash]
+ \begin{lstlisting}[language=Bash,numbers=none]
$ sudo ./shdmp /dev/input/by-id/usb-Contour\_Design\_ShuttlePro-event-if00 # substitute your shuttle
\end{lstlisting}
\end{enumerate}
\noindent Then press your shuttle key that is having problems and check the results. They should look like:
- \begin{lstlisting}[language=Bash, caption={Example for K7}]
+\begin{lstlisting}[language=Bash,numbers=none,caption={Example for K7}]
event: (4, 4, 0x90007) #The last number, 7, is the expected Key number.
event: (1, 262, 0x1)
event: (0, 0, 0x0)
event: (1, 262, 0x0)
event: (0, 0, 0x0)
\end{lstlisting}
- \begin{lstlisting}[language=Bash, caption={Example for K15}]
+
+\begin{lstlisting}[language=Bash,numbers=none,caption={Example for K15}]
Example for K15:
event: (4, 4, 0x9000f) #The last number f is 15 in octal and is the expected Key.
event: (1, 270, 0x1)
\paragraph{Note 4} For developers, if you have a pre-UEFI Secure Boot kernel it is also possible to do the following for further in depth testing:
-\begin{enumerate}
- \item \texttt{ls /sys/kernel/debug/hid \# to locate numerical value of the shuttle, e.g. 0003:0B33.0030.0006}
- \item \texttt{cat “/sys/kernel/debug/hid/0003:0B33.0030.0006/rdesc” \# substitute your own numerical value}
- \item \texttt{cat “/sys/kernel/debug/hid/0003:0B33.0030.0006/events” \# press keys to see the results}
-\end{enumerate}
+\begin{lstlisting}[language=Bash,numbers=none]
+ls /sys/kernel/debug/hid \# to locate numerical value of the shuttle, e.g. 0003:0B33.0030.0006
+cat "/sys/kernel/debug/hid/0003:0B33.0030.0006/rdesc" # substitute your own numerical value
+cat "/sys/kernel/debug/hid/0003:0B33.0030.0006/events" # press keys to see the results
+\end{lstlisting}
+%\begin{enumerate}
+ %\item \texttt{ls /sys/kernel/debug/hid \# to locate numerical value of the shuttle, e.g. 0003:0B33.0030.0006}
+ %\item \texttt{cat “/sys/kernel/debug/hid/0003:0B33.0030.0006/rdesc” \# substitute your own numerical value}
+ %\item \texttt{cat “/sys/kernel/debug/hid/0003:0B33.0030.0006/events” \# press keys to see the results}
+%\end{enumerate}
\subsection{Shuttle key default arrangement for Cinelerra / Composer / Viewer:}%
\label{sub:shuttle_key_default_cinelerra}
The following is the default setting for the ShuttlePROv2 and ShuttleXpress (table~\ref{tab:shuttleprov2} and table~\ref{tab:xpress}):
-\begin{landscape}
- \begin{table}[htpb]
- \centering
- \caption{ShuttlePROv2 key default arrangement for Cinelerra / Composer / Viewer}
- \label{tab:shuttleprov2}
- \begin{tabular}{c c c c c c c}
- \toprule
- K1 & K2 & & K3 & K4 & & \\
- Label & Future use & & Future use & Clip & & \\
- & Splice (viewer) & & Copy & Overwrite (viewer) & & \\
- \midrule
- K5 & K6 & K7 & K8 & K9 & & \\
- Home & Reverse & Stop & Play & End & & \\
- & & Fullscreen & & & & \\
- & & (viewer / compositor) & & & & \\
- \midrule
- Home(Defaults) & MouseBtn1(D) & MouseBtn2(D) & MouseBtn3(D) & End(Defaults) & & \\
- \midrule
- \multicolumn{7}{c}{Shuttle Outer Wheel} \\
- \multicolumn{7}{c}{Play forward (first row) or Play reverse (second row)} \\
- S1=Stop & S2=1/2 & S3=Normal & S4=2x & S5=4x & S6=8x & S7=16x \\
- S-1=Stop & S-2=1/2 & S-3=Normal & S-4=2x & S-5=4x & S-6=8x & S-7=16x \\
- \midrule
- K14 & & Jog Left & (Inner Wheel) & Jog Right & & K15 \\
- Toggle In & & Frame reverse & & Frame forward & & Toggle Out \\
- & & Scroll up(Defaults) & & Scroll down(Defaults) & & \\
- \midrule
- & & K10 & & K11 & & \\
- & & Previous Edit & & Next Edit & & \\
- & & Future Use(Viewer) & & Future Use(Viewer) & & \\
- \midrule
- & & K12 & & K13 & & \\
- & & Previous Edit & & Next Edit & & \\
- & & Previous Label & & Next label & & \\
- \bottomrule
- \end{tabular}
- \end{table}
-\end{landscape}
-
-\begin{landscape}
- \begin{table}[htpb]
- \centering
- \caption{ShuttleXpress key default arrangement for Cinelerra / Composer / Viewer}
- \label{tab:xpress}
- \begin{tabular}{c c c c c c c}
- \toprule
- K5 & K6 & K7 & K8 & K9 & & \\
- Home & Reverse & Stop & Play & End & & \\
- & & Fullscreen & & & & \\
- & & (viewer / compositor) & & & & \\
- \midrule
- Home(Defaults) & MouseBtn1(D) & MouseBtn2(D) & MouseBtn3(D) & End(Defaults) & & \\
- \midrule
- \multicolumn{7}{c}{Shuttle Outer Wheel} \\
- \multicolumn{7}{c}{Play forward (first row) or Play reverse (second row)} \\
- S1=Stop & S2=1/2 & S3=Normal & S4=2x & S5=4x & S6=8x & S7=16x \\
- S-1=Stop & S-2=1/2 & S-3=Normal & S-4=2x & S-5=4x & S-6=8x & S-7=16x \\
- \midrule
- & & Jog Left & (Inner Wheel) & Jog Right & & \\
- & & Frame reverse & & Frame forward & & \\
- & & Scroll up(Defaults) & & Scroll down(Defaults) & & \\
- \bottomrule
- \end{tabular}
- \end{table}
- \centering
-
-
-
-\end{landscape}
+\begin{table}[ht]
+ \caption{ShuttlePROv2 key default arrangement for Cinelerra / Composer / Viewer}
+ \label{tab:shuttleprov2}
+ % Tell table to adjust font to fix on the page using \resize
+ \resizebox{\textwidth}{!}{%
+ \begin{tabular}{c c c c c c c}
+ \toprule
+ K1 & K2 & & K3 & K4 & & \\
+ Label & Future use & & Future use & Clip & & \\
+ & Splice (viewer) & & Copy & Overwrite (viewer) & & \\
+ \midrule
+ K5 & K6 & K7 & K8 & K9 & & \\
+ Home & Reverse & Stop & Play & End & & \\
+ & & Fullscreen & & & & \\
+ & & (viewer / compositor) & & & & \\
+ \midrule
+ Home(Defaults) & MouseBtn1(D) & MouseBtn2(D) & MouseBtn3(D) & End(Defaults) & & \\
+ \midrule
+ \multicolumn{7}{c}{Shuttle Outer Wheel} \\
+ \multicolumn{7}{c}{Play forward (first row) or Play reverse (second row)} \\
+ S1=Stop & S2=1/2 & S3=Normal & S4=2x & S5=4x & S6=8x & S7=16x \\
+ S-1=Stop & S-2=1/2 & S-3=Normal & S-4=2x & S-5=4x & S-6=8x & S-7=16x \\
+ \midrule
+ K14 & & Jog Left & (Inner Wheel) & Jog Right & & K15 \\
+ Toggle In & & Frame reverse & & Frame forward & & Toggle Out \\
+ & & Scroll up(Defaults) & & Scroll down(Defaults) & & \\
+ \midrule
+ & & K10 & & K11 & & \\
+ & & Previous Edit & & Next Edit & & \\
+ & & Future Use(Viewer) & & Future Use(Viewer) & & \\
+ \midrule
+ & & K12 & & K13 & & \\
+ & & Previous Edit & & Next Edit & & \\
+ & & Previous Label & & Next label & & \\
+ \bottomrule
+ \end{tabular}}
+\end{table}
+
+\begin{table}[ht]
+ \caption{ShuttleXpress key default arrangement for Cinelerra / Composer / Viewer}
+ \label{tab:xpress}
+ % Tell table to adjust font to fix on the page using \resize
+ \resizebox{\textwidth}{!}{%
+ \begin{tabular}{c c c c c c c}
+ \toprule
+ K5 & K6 & K7 & K8 & K9 & & \\
+ Home & Reverse & Stop & Play & End & & \\
+ & & Fullscreen & & & & \\
+ & & (viewer / compositor) & & & & \\
+ \midrule
+ Home(Defaults) & MouseBtn1(D) & MouseBtn2(D) & MouseBtn3(D) & End(Defaults) & & \\
+ \midrule
+ \multicolumn{7}{c}{Shuttle Outer Wheel} \\
+ \multicolumn{7}{c}{Play forward (first row) or Play reverse (second row)} \\
+ S1=Stop & S2=1/2 & S3=Normal & S4=2x & S5=4x & S6=8x & S7=16x \\
+ S-1=Stop & S-2=1/2 & S-3=Normal & S-4=2x & S-5=4x & S-6=8x & S-7=16x \\
+ \midrule
+ & & Jog Left & (Inner Wheel) & Jog Right & & \\
+ & & Frame reverse & & Frame forward & & \\
+ & & Scroll up(Defaults) & & Scroll down(Defaults) & & \\
+ \bottomrule
+ \end{tabular}}
+\end{table}
projects / goodguy / cin-manual-latex.git / blobdiff