a few improved Recording images in Cakewalk theme
[goodguy/cin-manual-latex.git] / parts / Trouble.tex
index db2c6a6518a96484499f6f3a02071d5b552d9791..2ff131a16786311d6550e5877c95ded36fe2b2af 100644 (file)
@@ -24,6 +24,7 @@ troubleshooting help is included in other sections of this manual for specific f
 
 \section{What to Include in Problem Reports}%
 \label{cha:include_in_problem_reports}
+\index{report problem}
 For the best help, if you have a reproducible problem and can provide the following list of materials for analysis, it
 is usually possible to figure out what the problem is and how to fix it. It may be a simple usage or setup mistake or
 a real bug which a programmer would like to fix rather quickly. Although it is not always necessary to provide this
@@ -56,6 +57,7 @@ It is better to upload any files to a drop site as some of them can be quite lar
 
 \section{Crash Dumps for Analysis}%
 \label{cha:crash_dumps_analysis}
+\index{crash dumps}
 If you get a SEGV crash and can explain what steps you took, a \texttt{/tmp/cinelerra\_<pid> .dmp} file is
 very useful for analysis. You can also use Ctrl-c in the controlling window to force an INTR signal interrupt when
 you think the program is hung up. You can only perform one Ctrl-c as the second Ctrl-c quits out of the program. It
@@ -92,20 +94,23 @@ probability that the dump will prove useful, but if the problem can be recreated
 
 \section{When things go wrong}%
 \label{cha:when_things_go_wrong}
+\index{problem FAQ}
+
 Sometimes things go wrong and there are some ways to continue your work without much trouble. Below is a list of items
 to try before abandoning your session.
 
 \begin{enumerate}
-        \item If your computer or the program crashed, you can use the File pulldown choice
+        \item If your computer or the program crashed, you can use the \textit{File} pulldown choice
 of \textit{Load backup} to get back to the last automatically saved session. It will most
 likely not include the last few operations that were done though.  But if you forgot to 
-Load backup when you restarted Cinelerra, you have a second chance to use File → Load and
-select \$HOME/.bcast5/backup.prev as long as you only loaded a different file and have
+Load backup when you restarted Cinelerra, 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.
          \item If you accidentally destroyed your current project by a Load with 
 \textit{Replace current project} when you should have changed the Insertion strategy, and 
 you had not saved a recent backup, this is another time when it is useful to use
-File → Load and select \$HOME/.bcast5/backup.prev as long as you only loaded a different
+\texttt{File $\rightarrow$ Load} and
+select \texttt{\$HOME/.bcast5/backup.prev} as long as you only loaded a different
 file and had performed no editing operations.
        \item If you suddenly get errors or hangs on media or strange looking tracks, you might want to rebuild indexes. You can do this in the Resources window with a right mouse click on the media to get a pulldown with the \textit{Rebuild index} option. For an easy way to rebuild for all of your media use \texttt{Settings $\rightarrow$ Preferences, Interface} tab, Index Files section, \textit{Delete existing indexes}. Over time, as you
 load media, the indexes will automatically be recreated so each load takes a little longer, but this quite often
@@ -117,7 +122,7 @@ is all that is needed to repair a media problem.
 that a new file with the original name will be created with original defaults.  You will lose your preferences,
 but it is just for testing and you can move back the renamed \CGG{}\_rc over the new one if that is not the
 cause of the problem.  Be sure to stop and restart \CGG{} whenever you rename this file.
-       \item Some media has only a single keyframe at the beginning of the file so that moving anywhere on the timeline results in just a black image in the compositor. \CGG{} needs more keyframes to determine position. You can temporarily use \texttt{Settings $\rightarrow$ Proxy} to $\frac{1}{2}$ size to put in keyframes. How to use Proxy is explained in \href{sec:proxy_settings}{Proxy settings and Transcode}.
+       \item Some media has only a single keyframe at the beginning of the file so that moving anywhere on the timeline results in just a black image in the compositor. \CGG{} needs more keyframes to determine position. You can temporarily use \texttt{Settings $\rightarrow$ Proxy} to $\frac{1}{2}$ size to put in keyframes. How to use Proxy is explained in \ref{sec:proxy_settings} {Proxy Settings and Transcode}.
         \item If you have enabled an \textit{Automation Curve} such as Fade or Speed on your track but it
 does not show, it could simply be because the range minimum and maximum are incorrectly set in the zoom bar.
 Set them to more reasonable values until you see the lines appear. Just as a reminder, the zoom bar is on the
@@ -129,14 +134,14 @@ bottom of the main window (figure~\ref{fig:automation}).
 
 \textbf{Some Helpful User Readable Text Dumps}
 
-On the File pulldown, there is a \textit{Dumps} option with a submenu of dump EDL, Plugins, Assets, and Undo. In all cases, you will have to have started \CGG{} from a window instead of from an application icon and
+On the \textit{File} pulldown, there is a \textit{Dumps} option with a submenu of dump EDL, Plugins, Assets, and Undo. In all cases, you will have to have started \CGG{} from a window instead of from an application icon and
 the text results will be shown in that window.
 
 \begin{itemize}[nosep]
-\item \textit{Dump EDL} will display your current EDL state on the screen in the window from where you started Cin. This can be useful to see information concerning a specific edit or a file path.
-\item \textit{Dump Plugins} will show the names of the currently loaded plugins.
-\item \textit{Dump Assets} displays the media assets that you have loaded and various pertinent details on each, such as samplerate, width, and height.
-\item \textit{Dump Undo }will dump the last 32 edits on the undo stack exactly as kept, which can be useful if you are looking to see how far back in the undo to go to get to a specific spot.
+\item \textit{Dump EDL} \index{EDL dump} will display your current EDL state on the screen in the window from where you started Cin. This can be useful to see information concerning a specific edit or a file path.
+\item \textit{Dump Plugins} \index{plugins!dumps} will show the names of the currently loaded plugins.
+\item \textit{Dump Assets} \index{asset!dump} displays the media assets that you have loaded and various pertinent details on each, such as samplerate, width, and height.
+\item \textit{Dump Undo} \index{undo dump} will dump the last 32 edits on the undo stack exactly as kept, which can be useful if you are looking to see how far back in the undo to go to get to a specific spot.
 \end{itemize}
 
 \textbf{Common Problems}
@@ -144,11 +149,18 @@ the text results will be shown in that window.
 Some messages you may see in the startup window may or may not be errors. Some examples are:
 \bigskip
 
-\textit{FFMPEG::open\_decoder: some stream times estimated:} \quad \texttt{/your directory/filename}
+\textit{FFMPEG::open\_decoder: some stream times estimated:}  \texttt{/your directory/filename}
 
 This is not a problem. Basically, when you open a file if a stream has a known duration, there is no message. If the duration is unknown, it is estimated by using the File Size and Bitrate to estimate the duration. This may just indicate that the stream number \CGG{} uses versus ffmpeg may be counted differently.
 \bigskip
 
+\textit{FFMPEG::scan: codec open failed} followed by
+\newline 
+\textit{FFMPEG::scan:file=} \quad \texttt{your directory/filename}
+
+This is not a problem. \CGG{} is building an index for your file in order to better seek.  In that process, different methods are tried until a successful scan is complete.
+\bigskip
+
 \textit{AudioALSA::write\_buffer err -32(Broken pipe) at sample \#}
 
 This indicates that there is something wrong with the audio. Some reasons for this are:
@@ -162,7 +174,7 @@ This indicates that there is something wrong with the audio. Some reasons for th
 
 \textit{Playback does not keep up so you hear the audio ahead of the video.}
 
-When this occurs, it most likely means that there is not enough CPU power to keep up. You can go into \texttt{Settings $\rightarrow$ Preferences, Playback} tab and uncheck \textit{Play every frame}. Not playing every frame means that as it plays, if it can not keep up with doing all it has to do to change the frame into a vframe and then draw it, the program just notes that it is falling behind so skips frames to catch back up. This does not affect rendering. A different solution is to use Background Rendering as described in \href{sec:background_rendering}{Rendering}.
+When this occurs, it most likely means that there is not enough CPU power to keep up. You can go into \texttt{Settings $\rightarrow$ Preferences, Playback} tab and uncheck \textit{Play every frame}. Not playing every frame means that as it plays, if it can not keep up with doing all it has to do to change the frame into a vframe and then draw it, the program just notes that it is falling behind so skips frames to catch back up. This does not affect rendering. A different solution is to use Background Rendering as described in section \ref{sec:background_rendering}.
 \bigskip
 
 \textit{\CGG{} will not start and produces error message on the startup window.}
@@ -216,15 +228,18 @@ In the mask window, check the box \textit{Disable OpenGL masking} to use softwar
 
 \section{Menu Bar Shell Commands}%
 \label{menu_bar_shell_commands}
+\index{shell commands}
 
-In order to provide some types of help, the Menu Bar Shell Commands are available for customization purposes. In the
-main window on the top line containing the File, Edit, {\dots} Window pulldown menus, all the way to the right hand
-side is the \textit{shell cmds} icon. You might see a small gold-color bordered box with the $>\_.\_$ inside
-and if you mouse over it, the tooltip says \textit{shell cmds}. This is a configurable popup which gives you the ability to
-see a table of Shortcuts in html format, refer to the reference manual or execute a pre-defined script to perform a
-specific task, such as some type of post processing which you plan on performing on a repeat basis. Unless redirected
-elsewhere, the output from executing any script-type commands will be displayed in the window from where you started
-\CGG{}.
+In order to provide some types of help, the Menu Bar Shell Commands are available for customization purposes (figure~\ref{fig:trouble-img001}).
+
+\begin{figure}[h!]
+       \centering
+       \includegraphics[width=1.0\linewidth]{trouble-img001.png} 
+       \caption{Some windows used to manipulate Shell Commands scripts}
+       \label{fig:trouble-img001}
+\end{figure}
+
+In the main window on the top line containing the \textit{File}, \textit{Edit}, {\dots} \textit{Window} pulldown menus, all the way to the right hand side is the \textit{shell cmds} icon. You might see a small white-color bordered box with the "\texttt{i}" inside and if you mouse over it, the tooltip says \textit{shell cmds}. This is a configurable popup which gives you the ability to see a table of Shortcuts in html format, refer to the reference manual or execute a pre-defined script to perform a specific task, such as some type of post processing which you plan on performing on a repeat basis. Unless redirected elsewhere, the output from executing any script-type commands will be displayed in the window from where you started \CGG{}.
 
 The Shell Cmds popup menu items are configured in:
 
@@ -297,15 +312,9 @@ There are some Help features currently included in the Shell Cmds menu. Those av
        \item \textit{RenderMux} shell script to use ffmpeg concatenate to copy files such as \textit{look.mp4001}, \textit{look.mp4002}, \textit{look.mp4005}{\dots} that were rendered using \textit{Create new file at each label} or with the Render Farm.
 \end{enumerate}
 
-\begin{figure}[h!]
-       \centering
-       \includegraphics[width=1.0\linewidth]{trouble-img001.png} 
-       \caption{Some windows used to manipulate Shell Commands scripts}
-       \label{fig:shell_script_manupulation}
-\end{figure}
-
 \section{\CGG{} Command Line -h}%
 \label{cha:cinelerra_command_line_-h}
+\index{command line}
 
 To see the command line parameters available to use with \CGG{}, key in: