add void AssetPicon::create_objects problem workaround when rendering to Common Probl...

[goodguy/cin-manual-latex.git] / parts / Trouble.tex

diff --git a/parts/Trouble.tex b/parts/Trouble.tex
index 8003ded357f36fc2ceef5822b832da5d3e99d45f..b22ab1f79579fd6bba1acc41b93096e147de6a1d 100644 (file)
--- a/parts/Trouble.tex
+++ b/parts/Trouble.tex
@@ -1,6 +1,8 @@
 \chapter{Troubleshooting and Help}%
 \label{cha:troubleshooting_help}
 
 \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}
 \section{Help and Context Help}%
 \label{sec:help_context_help}
 \index{context help}


@@ -16,7 +18,7 @@ From within the program, you can invoke \textit{Context Help}, which references
 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}%
 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}.
 
 
 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}.
 


@@ -93,15 +95,21 @@ You can report potential problems, bugs, and crashes to the \CGG{} website at:
 \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
 \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
 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.
 
 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 
 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 


@@ -243,7 +251,7 @@ option "only allow with this IP address" needs to be disabled, then the bug trac
 
   \begin{enumerate}
        \item If you can not register your username in the website's Forum, it could be 
 
   \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 (({\small \url{https://lists.cinelerra-gg.org/mailman/listinfo/cin}}) so that you can be added to the forum manually as long as
+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 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


@@ -254,7 +262,9 @@ characters.  This can be as simple as ../../ (dot dot slash dot dot slash) or so
 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
 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.
+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.
        \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.


@@ -312,6 +322,11 @@ This indicates that there is something wrong with the audio. Some reasons for th
 \end{itemize}
 \bigskip
 
 \end{itemize}
 \bigskip
 

+\textit{void AssetPicon::create\_objects():}
+
+While rendering, you may see this in the Message log window as well as in your terminal startup window. Your render will be incomplete. This indicates that \CGG{} is unable to update the image of the asset picon either on the Timeline or in the Compositor. Usually not a problem unless rendering large media such as 4K.  Because this is just for displaying approximately where you are in the render process, turn off "Draw media" in the patchbay for the video tracks (3rd icon from the left).  You can still see how far along the render is by checking the progress bar which shows the percent complete in the bottom right corner of the main program window.
+\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 section \ref{sec:background_rendering}.
 \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 section \ref{sec:background_rendering}.


@@ -479,6 +494,7 @@ There are some Help features currently included in the Shell Cmds menu. Those av
        \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{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}%
 \end{enumerate}
 
 \section{\CGG{} Command Line -h}%