\chapter{Troubleshooting and Help}%
\label{cha:troubleshooting_help}
+To help new users, a pdf has been created comparing the editing workflow of \CGG{} with the more usual editing workflow of Adobe Premiere Pro. See \href{https://cinelerra-gg.org/download/Workflow.pdf}{here}.
+
\section{Help and Context Help}%
\label{sec:help_context_help}
\index{context help}
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}
+\label{sub:how_context_help_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}.
\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.
+Contour Shuttle has no \texttt{Alt/h}. Nevertheless, its help page can be requested by simultaneously pressing the \texttt{Alt} key on the keyboard and any button on the Contour Shuttle. Note that the default Shuttle Configuration will be shown, rather than the one that you may have redefined.
\subsection{Alternative web browser configuration}%
\label{sub:alt_browser}
\end{center}
Here you can log the problem into the MantisBT bugtracker, or use the forum Q\&A for help from other users, or email the
-problem using the address:{\small \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}} It is usually more
+problem to the Mailing List using the address:{\small \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}}. It is usually more
helpful if instead of starting \CGG{} from its application icon, start from a window so that if there are error
messages related to the problem, they can be captured from the screen and emailed or logged. The command to run
from a window is: \texttt{<directory\_path of where you installed cinelerra>/bin/cin} -- for example if
-installed in \texttt{/mnt0/build5/cinelerra-5.1}, you would execute the following command to start the program:\\
-\texttt{/mnt0/build5/cinelerra-5.1/bin/cin} \\
+installed in \texttt{/mnt0/build5/cinelerra-5.1}, you would execute the following command to start the program:
+\newline \hspace*{1cm} \texttt{/mnt0/build5/cinelerra-5.1/bin/cin} \\
The problem you are experiencing may be as simple as an error due to the settings in your \texttt{\$HOME/.bcast5} subdirectory so you may want to first rename your current \texttt{.bcast5} in order to start with default settings. By renaming the directory instead of deleting it, you will be able to put it back and not lose all of your preferences.
-However, there are some easy things to do to fix errors that may have resulted from media problems,
+A note about using the Mailing List {\small \href{mailto:cin@lists.cinelerra-gg.org}{cin@lists.cinelerra-gg.org}}
+is that to avoid receiving spam, it will require you to subscribe. But it is also easy to unsubscribe once you have
+the information you need. The Mailing List, although routinely used by developers or contributors to discuss
+changes, can provide more technical answers in some cases and the email goes directly to individuals who are quite
+likely sitting at their computers depending on the timezone.
+
+There are some easy things to do to fix errors that may have resulted from media problems,
computer problems, or operational missteps so you can proceed without having to wait for help. These
are outlined in \ref{cha:when_things_go_wrong} - be sure to read down through
\textit{Common Problems} where some exact error messages are mentioned along with their cause or solution. Other
\item On an older computer, if you are playing media and it can not keep up, you can turn off \textit{Play every frame} in the \textit{Video Out} tab of \texttt{Settings $\rightarrow$ Preferences, Playback} tab. You will then see the video jump as it skips frames in order to stay caught up.
\item The \textit{Cache size} can be lowered to 1048 if playback seems choppy or if you have problems with lv2 plugins, or you can increase the \textit{Cache size} for better flow. This can be changed in \texttt{Settings $\rightarrow$ Preferences, Performance} tab.
\item After saving your session and settings and exiting \CGG{}, you might want to rename your current \texttt{\$HOME/.bcast5} directory and start with the default setup. This will eliminate your settings as the potential cause of a problem; however, all of your preferences will be lost until you go back to your original \texttt{.bcast5}.
- \item You can also temporarily rename just \CGG{}\_rc in your \$HOME/.bcast5 directory, so
+ \item You can also temporarily rename just Cinelerra\_rc in your \$HOME/.bcast5 directory, so
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.
bottom of the main window (figure~\ref{fig:automation}).
\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 After a crash, look on the window where you started running \CGG{} to see if there is a line towards the end of the output that reads something like a bunch of numbers followed by the word "AssetVIconThread". Frequently this indicates that some system resouce has been exhaused in creating/running the Vicon images in the Resources window. You can disable \textit{Use thumbnails in resource window} in Settings/Preferences, Appearace tab to see if this resolves the crashing. In most cases when this is the cause, it will be the second to last line shown in the window.
+In addition, you might want to \textit{Delete clip thumbnails} in the Interface
+tab section of Settings/Preferences.
\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
\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 Mantis Bugtracker
-using chrome and you lose what you just typed in. Generally when logging into the bugtracker, the
+ \item Check your \textit{Overlays} window if you do not see your Assets, Titles, Transitions, Plugin Keyframes, or other lines such as Fade, Cameras, etc. on your timeline.
+These items will still be functional, but you may be confused when you do not actually see their physical presence if you inadvertently unchecked them in the \textit{Overlays} window. Use the \textit{Window} pulldown to enable/disable the \textit{Show Overlays} window.
+ \item BugTracker - sometimes there is a problem creating a new report issue in the website's Mantis Bugtracker
+using the Chrome web browser 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 Forum -
+
+ \begin{enumerate}
+ \item If you can not register your username in the website's Forum, it could be
+because the protection measures against spammers also is in effect with real users, so sometimes the website blocks the registration for the forum. This often affects email addresses of well-known email providers. Send email to the mailing list which requires you to subscribe (({\small \url{https://lists.cinelerra-gg.org/mailman/listinfo/cin}}) so that you can be added to the forum manually as long as
+you confirm that you agree with the terms of use of this website and the forum.
+ \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.
+
+ \item Entries not showing up for several hours could be due to taking a long time
+to propagate around the world on some time basis.
+ \item Not seeing a comment or reply section could be because you are not logged in
+or recognized as logged in. If you seem to be logged in, logout and then login again to
+see if that resolves the problem. Another potential solution is the switch the language
+being used to English, even if you think it is already English. Sometimes it is left in
+a different language and needs to be reset.
+ \item Until you have made a few entries in the Forum, you will have to wait a few
+hours for your entry to be approved. This is because there are people who spam the
+forum so attempts to alleviate this by requiring moderation for new users until validated.
+ \end{enumerate}
+
\end{enumerate}
\textbf{Some Helpful User Readable Text Dumps}
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{int FFMPEG::init\_encoder(const char*);} followed by
+\newline
+\textit{bad file format:} \quad \texttt{your directory/filename}
+
+This error occurs when you are rendering, or possibly capturing media via recording, when the
+file format/type are set to an incompatible option. To fix this in the Render window, check
+the Video and Audio wrenches configure compression settings and choose a compatible Compression
+as shown when clicking on the down arrow in the Preset window.
+\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:
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!]
+\begin{figure}[ht]
\centering
\includegraphics[width=1.0\linewidth]{trouble-img001.png}
\caption{Some windows used to manipulate Shell Commands scripts}
\item \textit{Setting Shell Commands} \textit{how to} which explains how to configure your own commands.
\item \textit{Shortcuts} html file for easily looking up a particular shortcut.
\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.
+ \item \textit{Delete brender files in tmp} shell script to delete the many brenderX files in /tmp when using the default location.
\end{enumerate}
\section{\CGG{} Command Line -h}%
projects / goodguy / cin-manual-latex.git / blobdiff