\chapter{Troubleshooting and Help}%
\label{cha:troubleshooting_help}
+\section{Help and Context Help}%
+\label{sec:help_context_help}
+\index{context help}
+
+\CGG{} is a complex and feature-rich program. Using a guide is indispensable. The official manual (in English) can be found in PDF and HTML format:
+
+\url{https://cinelerra-gg.org/download/CinelerraGG_Manual.pdf}
+
+\url{https://cinelerra-gg.org/download/CinelerraGG_Manual/}
+
+From within the program, you can invoke \textit{Context Help}, which references sections of the HTML manual\protect\footnote{credit Georgy(sge) for full implementation}.
+
+Context help can be requested from almost any \CGG{} window or subwindow by pointing with the mouse cursor on the GUI element of interest and pressing \texttt{Alt/h}. That HTML manual page will be shown via the configured web browser, which is assumed as most relevant to the GUI element currently under the mouse pointer.
+
+\subsection{How Context Help works}%
+\label{sub:how_it_works}
+
+The hotkey to request context help is \texttt{Alt/h}. What particular help page is shown, depends on the mouse cursor location while \texttt{Alt/h} is pressed. Usually, when the mouse is located in some window or dialog, the help page related to the functionality of this window or dialog is shown. In this case the mouse can point either on some widget, or on an empty area in the window. In \CGG{} GUI there are several rich loaded windows, \textit{Timeline} and \textit{Compositor} for example. In such a case different help pages can be requested depending on the particular GUI element under the mouse. For example, pressing \texttt{Alt/h} while pointing on the \textit{Autos curve} in a track would show help on \textit{automation keyframes} section, pointing on the \textit{Overlay} mode button in the \textit{patchbay} would show help on \textit{overlays}, pointing on the \textit{camera control} in \textit{Compositor} would show help on \textit{camera and projector}.
+
+If no context dependent help page is found, the manual page of Contents itself is shown.
+
+\subsection{Requesting context help for plugins}%
+\label{sub:context_help_plugins}
+\index{context help!plugins}
+
+There are several possibilities to request the help page for a particular plugin of interest.
+
+\begin{enumerate}
+ \item Pressing \texttt{Alt/h} with the mouse in the dialog window of that plugin's settings menu.
+ \item Pressing \texttt{Alt/h} while pointing with the mouse on the plugin bar in a track, transition bar, or transition icon.
+ \item Pressing \texttt{Alt/h} while pointing on the plugin name (icon) in the Resources window. If plugin tooltips are on, help for the highlighted plugin under the mouse is shown. If plugin tooltips are off, help for the selected plugin is shown.
+ \item Pressing \texttt{Alt/h} while pointing on the plugin name in the \textit{Attach Effect} dialog menu.
+\end{enumerate}
+
+\subsection{Requesting context help on Contour Shuttle}%
+\label{sub:context_help_contour_shuttle}
+\index{context help!contour shuttle}
+
+Contour Shuttle has no \texttt{Alt/h}. Nevertheless, its help page can be requested by simultaneously pressing both \texttt{Alt} keys (left and right) on the keyboard followed by pressing any button on the Contour Shuttle. Here, pressing both Alt keys is necessary due to the way X11 tracks the status of modifiers. To cancel this mode, press any single modifier key (\texttt{Alt, \texttt{Ctrl}} or Shift) once. Note that the manual Shuttle Configuration will be the default one, rather than the one that you may have redefined.
+
+\subsection{Alternative web browser configuration}%
+\label{sub:alt_browser}
+\index{context help}
+
+If you prefer to get \textit{Context Help} pages displayed in the same tab
+in your browser instead of each help request displayed in a different tab,
+choose an alternative method as outlined here that works for you.
+
+\begin{enumerate}
+ \item Use another browser which has such a configurable mode. Here is an example for Seamonkey:
+\begin{lstlisting}[style=sh]
+ export CIN_BROWSER=seamonkey
+\end{lstlisting}
+In the seamonkey browser go to Edit -> Preferences... -> Browser -> Link
+Behavior -> Links from other applications .
+Set the option "Open links passed from other applications in:" to the value
+"The current tab/window".
+
+ \item Hack a default browser if you know how to hack it. Here is an example for Firefox.
+Start Firefox and open the pseudo-URL:
+\begin{lstlisting}[style=sh]
+ about:config
+\end{lstlisting}
+There will be a warning like "I'll be careful, I promise!", acknowledge it.
+Then there is a very long list with lots of undecipherable variable names.
+Scroll down to the variable: browser.link.open\_newwindow.override.external .
+By default it has value of -1, which means "use value of the more general
+variable: browser.link.open\_newwindow .
+Next, place the mouse cursor over: browser.link.open\_newwindow.override.external ,
+press the right mouse button, and select from the popup menu "Modify".
+You can now edit the value. Set it to 1, and you get new links from external
+apps opened in the same tab.
+
+If you set the variable "browser.link.open\_newwindow" instead, you get this
+behavior not only for external, but also for all links which otherwise would
+be opened in new tabs or new windows. The possible values of both variables
+are:
+\newline \hspace*{1cm} Value = 1: open in the current window and tab
+\newline \hspace*{1cm} Value = 2: open in the new window
+\newline \hspace*{1cm} Value = 3: (default): open in the new tab, current window
+\end{enumerate}
+
+\section{Troubleshooting}%
+\label{sec:troubleshooting}
+
You can report potential problems, bugs, and crashes to the \CGG{} website at:
\begin{center}
troubleshooting help is included in other sections of this manual for specific features.
\section{What to Include in Problem Reports}%
-\label{cha:include_in_problem_reports}
+\label{sub: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
\item If possible, also provide the rendered output, again using that representative sample.
\item Save a session file used with that same sample which will contain a lot of setup parameters; the best method to do this is to use the \texttt{File $\rightarrow$ Export Project}$\dots$ with the Copy option. That way all of the files will be in 1 location and easily loaded onto any other computer.
\item To make sure that the same rendering setup is used, it may be necessary to send an additional session file at the definition point just before rendering starts.
- \item Include the Operating System name and version number and version of Cin that you are running. You can find the date and time \textit{built} in the \texttt{Settings $\rightarrow$ Preferences, About} tab, bottom left corner.
+ \item Include the Operating System name and version number and version of \CGG{} that you are running. You can find the date and time \textit{built} in the \texttt{Settings $\rightarrow$ Preferences, About} tab, bottom left corner.
\end{itemize}
It is better to upload any files to a drop site as some of them can be quite large.
\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
\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 ,\CGG{} 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
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
\item If the rate at which frames are captured during Recording is much lower than the framerate of the source, the video will accumulate in the recording buffers over time and the audio and video will become out of sync. Decrease the number of frames to buffer in the device in \texttt{Settings $\rightarrow $ Preferences, Recording} tab so that the excess frames are dropped instead of buffered.
\item If loading files locks up, this might be because \CGG{} is building picons/vicons for the Resources window. If you load a large number of images it needs to decompress every single image to build a picon/vicon. Go into \texttt{Settings $\rightarrow$ Preferences, Appearance} tab and disable \textit{Use thumbnails in resource window} to skip this process. Keep in mind though, that it only has to create these thumbnails the first time a new piece of media is loaded or the values are changed.
\item For an older computer with less CPU power, in \texttt{Settings $\rightarrow$ Preferences, Appearance} tab, be sure that \textit{Autocolor assets }is disabled; set \textit{View thumbnail size} \& \textit{Vicon quality}\& \textit{Vicon color mode} to lower values or switch to \textit{No Play} instead of \textit{Full Play} in the Resources window (this is to the right of the word \textit{Visibility} in the left hand side of that window). You will then have more CPU and more memory available to do actual editing.
+ \item When using AppImage to run with the OpenGL video driver, you must have the OpenGL drivers
+for your Operating System graphics board installed as it is not included in the AppImage library set. The
+error message you might see if this is not installed is: \textit{error while loading shared libraries: libGLU.so.1: cannot open shared object: No such file or directory}.
+ \item If you have updated your Operating System or newly installed some applications, it is
+possible that your LV2 plugin path may have been modified and be in disagreement with what you have set
+for \CGG{}. This could result in a crash upon startup. Look at the messages in the window from where
+you started \CGG{} to see if they look similiar to the following:
+\begin{lstlisting}[numbers=none,xleftmargin=10mm]
+LOAD: http://eq10q.sourceforge.net/matrix\_lr2ms
+LOAD: http://eq10q.sourceforge.net/matrix\_ms2lr
+LOAD: https://community.ardour.org/node/7596
+LOAD: urna-comp
+** segv at 0x7f2cd80813c4 in pid 4540, tid 4540
+\end{lstlisting}
+The last line before the \textit{segv} indicates the name of the LV2 plugin that is causing problems.
+Please refer to the section on LV2 plugins \ref{sec:audio_lv2_calf_plugins} to resolve the issue.
+ \item Sometimes there is a problem creating a new report issue in the website's Mantis Bugtracker
+using chrome and you lose what you just typed in. Generally when logging into the bugtracker, the
+option "only allow with this IP address" needs to be disabled, then the bug tracker will work fine.
+ \item In the website's Forum, use of unacceptable characters or strings can result in the error
+message "A potentially unsafe operation has been detected in your request to this site". You lose what
+you had typed in and you will have to check what you remember typing in for a non-converational set of
+characters. This can be as simple as ../../ (dot dot slash dot dot slash) or some types of C++ code.
\end{enumerate}
\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 .\CGG{} 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}
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:
\item You simply stopped playing in \CGG{} while the audio is in progress.
\item Running on a computer where there is no sound card.
\item Incorrect setup of the audio parameters in the \texttt{Settings $\rightarrow$ Preferences, Playback} tab.
- \item Your sound system is already in use by another program, like when playing \textit{tunes} outside Cin.
+ \item Your sound system is already in use by another program, like when playing \textit{tunes} outside \CGG{}.
\end{itemize}
\bigskip
\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.}
\medskip
\begin{itemize}[nosep]
- \item Cin doesn't come up in Debian with compiz window manager running. Workaround is to use a different window manager or bring up cin first and then compiz. There is also a report that Compiz leads to single frame problems after a certain amount of time in the case where you switch to fullscreen mode and than back to normal node -- cin stops working and so you will have to restart cin.
- \item When a library goes from one version to a later version, sometimes a pre-built Cin binary will fail because it was created at a different version than the one the user has on their computer. This seems to happen more frequently on Arch distros because Arch has continuous releases and is usually kept up to date. An example of the error message you might see in your startup window would be:\\
+ \item \CGG{} doesn't come up in Debian with compiz window manager running. Workaround is to use a different window manager or bring up cin first and then compiz. There is also a report that Compiz leads to single frame problems after a certain amount of time in the case where you switch to fullscreen mode and than back to normal node -- cin stops working and so you will have to restart cin.
+ \item When a library goes from one version to a later version, sometimes a pre-built \CGG{} binary will fail because it was created at a different version than the one the user has on their computer. This seems to happen more frequently on Arch distros because Arch has continuous releases and is usually kept up to date. An example of the error message you might see in your startup window would be:\\
\texttt{cin: error while loading shared libraries: libvpx.so.5: \\
cannot open shared object file: No such file}
\end{itemize}
You can usually install the required library to fix the problem. A temporary fix may be to create a symlink but this must be done with extreme caution as it may create an unstable condition. A better workaround is to use a tarball to install the software instead of the package build until the libraries are in sync between the build and your Operating System install.
\bigskip
-\textit{ Loading a very large number of media files, for example 500 clips, crashes \CGG{} with messages similar to the following that are displayed in the window from where you started Cin:}
+\textit{ Loading a very large number of media files, for example 500 clips, crashes \CGG{} with messages similar to the following that are displayed in the window from where you started \CGG{}:}
\begin{lstlisting}[numbers=none,xleftmargin=10mm]
This usually indicates that you are out of Operating System file descriptors. You can increase the amount easily with the following command line: \texttt{ulimit -n 4096} where 4096 is a size suggestion but can be increased. You can include this command line in your \texttt{.bashrc} or \texttt{.profile} file for the user login which gets run every time you login, or modify the Operating System limit for everyone in the system file, which for Fedora is \texttt{/etc/security/limits.conf}. Alternatively, you can reduce the number of file descriptors needed by going into \texttt{Settings $\rightarrow$ Preferences, Appearance} tab and unchecking the flag \textit{use thumbnails in resource window}.
+\bigskip
+
+\textit{Using a non-supported locale could cause a failure in starting \CGG{} with the following error.}
+
+\begin{lstlisting}[numbers=none,xleftmargin=10mm]
+
+ BC_WindowBase::init_im: Could not open input method.
+ unjoined tids / owner 1
+ 00007f543dffb700 / 00007f54989d5840 12BC_Clipboard
+
+\end{lstlisting}
+
+This is caused by LC\_CTYPE setting you are using, and maybe other Locale settings too.
+For example, using the following will cause the \textit{unjoined tids} error.
+
+\begin{lstlisting}[numbers=none,xleftmargin=10mm]
+ LC_CTYPE="en_IL" /mnt0/build5/cinelerra-5.1/bin/cin # set LC_CTYPE and start cin
+\end{lstlisting}
+
+This is an operating system error which is resolved by using the following startup instead:
+
+\begin{lstlisting}[numbers=none,xleftmargin=10mm]
+
+ LC_CTYPE="en_GB.utf8" /mnt0/build5/cinelerra-5.1/bin/cin # set LC_CTYPE and start cin
+\end{lstlisting}
+
+You can either export the LC\_CTYPE variable before starting \CGG{} or
+add this in your bash startup file or simply run from the command line as shown above.
+
\bigskip
\textit{Masking Feather is not working and produces error messages on the startup window similar to:}
In the mask window, check the box \textit{Disable OpenGL masking} to use software instead of OpenGL.
\section{Menu Bar Shell Commands}%
-\label{menu_bar_shell_commands}
+\label{sec: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:
\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:
projects / goodguy / cin-manual-latex.git / blobdiff