From: Good Guy Date: Fri, 24 Jan 2020 03:25:52 +0000 (-0700) Subject: a few more corrections from MatN and Phyllis X-Git-Tag: 2021-05~138 X-Git-Url: https://cinelerra-gg.org/git/?a=commitdiff_plain;h=3b0e6cb1ede7a880754c131d9de907bf4318b910;p=goodguy%2Fcin-manual-latex.git a few more corrections from MatN and Phyllis --- diff --git a/parts/AuxilaryPrograms.tex b/parts/AuxilaryPrograms.tex index fdecaa8..a2f7e4f 100644 --- a/parts/AuxilaryPrograms.tex +++ b/parts/AuxilaryPrograms.tex @@ -75,7 +75,7 @@ Example usage of this script follows: There are some common VP9 rendering options files that support creation of video for YouTube, Dailymotion, and other online video services. \ Webm / VP9 \ is a media file format which is free to use under the BSD license and is open-source; thus there are no licensing issues to be concerned about. \ The Webm container is based on Matroska for video and Opus for audio. \medskip -Youtube easy startup steps are documented in the previous section, A.2. \ These same steps have been verified to work for creating Dailymotion videos -- however, the created files must be renamed before uploading to change the youtube extension to webm instead for Dailymotion. +Youtube easy startup steps are documented in the Appendix (\ref{sec:youtube_with_cinelerra}). \ These same steps have been verified to work for creating Dailymotion videos -- however, the created files must be renamed before uploading to change the youtube extension to webm instead for Dailymotion. {}- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \medskip @@ -174,9 +174,9 @@ The following extensions of files in Cinelerra's .bcast5 directory are explained \item [.toc] toc is ``table of contents'' file for MPEG video files (a type of index) \item [Cinelerra\_plugins] a list of the currently loaded plugins available in your Cinelerra session \item [Cinelerra\_rc] the user's preferences and settings are saved in this file to be used on startup - \item [ladspa\_plugins{\dots}] ist of currently loaded ladspa plugins for each version of Cinelerra being used + \item [ladspa\_plugins{\dots}] list of currently loaded ladspa plugins for each version of Cinelerra being used \item [layout\#...\_rc] user-defined window layout setup with the layout name as part of the file name - \item [.xml] generally contain the current settings of plugins that you have used + \item [.xml] used for various backups or for the current settings of plugins that you have used \item [.png] thumbnails of files in Resources so they do not have to be created over and over \end{labeling} diff --git a/parts/Editing.tex b/parts/Editing.tex index 79f3fed..e28decb 100644 --- a/parts/Editing.tex +++ b/parts/Editing.tex @@ -801,7 +801,7 @@ looking timelines because of the automatic rendering capability of nesting. \subsection{Copy/Paste clips/medias across Multiple Instances}% \label{sub:copy_paste_multiple_instances} -It is easy to copy/paste clips/media within a single instance of cinelerra or across multiple instances. The reason this works is because there are hidden X cut buffers and these are used to transmit EDL from 1 instance to another. +It is easy to copy/paste clips/media within a single instance of Cinelerra or across multiple instances. The reason this works is because there are hidden X cut buffers and these are used to transmit EDL from 1 instance to another. \noindent Steps to copy from a source timeline and paste to a target timeline: @@ -854,7 +854,7 @@ ATTRS{name}=="Contour Design ShuttleXpress" MODE="0644" SUBSYSTEMS=="usb", ATTRS{idVendor}=="0b33", ATTRS{idProduct}=="0020", MODE="0666" SUBSYSTEMS=="usb", ATTRS{idVendor}=="0b33", ATTRS{idProduct}=="0030", MODE="0666" \end{lstlisting} -If you swap your shuttle, for example upgrade from an Xpress to a PROv2, just stop Cin, unplug the original shuttle, plug in the replacement shuttle, and restart Cin. If you start the cinelerra program and the shuttle does not function as before, stop cinelerra and then simply unplug it and plug it in again. There are a couple of reasons why it may stop functioning. One is because cinelerra was not stopped with the usual Quit command and the shuttle was improperly shut down when there was a crash. The other possibility is that a static discharge occurred in the area. +If you swap your shuttle, for example upgrade from an Xpress to a PROv2, just stop Cin, unplug the original shuttle, plug in the replacement shuttle, and restart Cin. If you start the Cinelerra program and the shuttle does not function as before, stop Cinelerra and then simply unplug it and plug it in again. There are a couple of reasons why it may stop functioning. One is because Cinelerra was not stopped with the usual Quit command and the shuttle was improperly shut down when there was a crash. The other possibility is that a static discharge occurred in the area. A default shuttlerc file is automatically used when a shuttle device is plugged in when Cin is started. This file sets up the key bindings for Cinelerra to use. You can override any default settings by having a local file in your \texttt{\$HOME} directory, named \texttt{.shuttlerc} to reflect your personal preferences. @@ -922,7 +922,7 @@ K2 "v" K4 "b" # Overwrite \end{lstlisting} -\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 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,numbers=none] @@ -932,7 +932,7 @@ K13 Ctrl-XK_Right # Go to next label \noindent For sequences of one or more \textit{printable} characters, you can just enclose them in double quotes. For example in the \texttt{[Composer]} section, to go into or out of fullscreen mode, automatically start playing and put a label there, you could define a key like this: K7 “f~l” - that is printable character f, a space, and printable character l. -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: +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,numbers=none] dupl key name: [Cinelerra]K1 @@ -1062,7 +1062,7 @@ event: (0, 0, 0x0) \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: (4, 4, 0x9000f) #The last number f is 15 in hexadecimal and is the expected Key. event: (1, 270, 0x1) event: (0, 0, 0x0) event: (4, 4, 0x9000f) diff --git a/parts/FFmpeg.tex b/parts/FFmpeg.tex index 5d2e57e..abf35b2 100644 --- a/parts/FFmpeg.tex +++ b/parts/FFmpeg.tex @@ -95,7 +95,7 @@ In \texttt{typ.ext} encoder parameter files, the first line is defined as: where the | represents piping the codec data through the bitstream filter. The rest of the lines in the file should look as follows: -\begin{lstlisting}[language=bash,numbers=none]] +\begin{lstlisting}[language=bash,numbers=none] # in column one is a comment id1 value1 (or) id2 = value2 @@ -103,7 +103,7 @@ where the | represents piping the codec data through the bitstream filter. The r Only one equals sign is allowed and it is just for readability. There may be any number of id/value pair lines in a media definition, including zero. A typical line might be: -\begin{lstlisting}[language=bash,numbers=none]] +\begin{lstlisting}[language=bash,numbers=none] bitrate 4000000 (or) bitrate = 5000000 \end{lstlisting} @@ -135,7 +135,7 @@ threads=auto The encoder options you see in the Cinelerra menus depend on the files in these directories, \textsc{NOT THE CODE}. If you add files, you will get to use more variety. -In the \textit{cinelerra} directory, which contains the ffmpeg configuration folder, there are the choices the program uses. When you open an ffmpeg format popup dialog, the listbox contains all of the codec types which are identified by the \texttt{file.ext} extensions. Decoding has only a few options, since the ffmpeg file probes determine most of the options by looking at the media being opened, but encoding media requires a lot of setup. Below are some of the folders and files used to determine the configurations used by ffmpeg to decode and encode files. +In the \textit{Cinelerra} directory, which contains the ffmpeg configuration folder, there are the choices the program uses. When you open an ffmpeg format popup dialog, the listbox contains all of the codec types which are identified by the \texttt{file.ext} extensions. Decoding has only a few options, since the ffmpeg file probes determine most of the options by looking at the media being opened, but encoding media requires a lot of setup. Below are some of the folders and files used to determine the configurations used by ffmpeg to decode and encode files. These extensions create audio / video media classes: @@ -221,7 +221,7 @@ If you send any new options files to \href{mailto:cin@lists.cinelerra-gg.org}{ci To get a listing of the current ffmpeg supported formats and codecs that can be made to work with Cinelerra, provided there are option files added, run the following commands. This should be done from the \texttt{} directory substituting the location of \texttt{} where you have installed Cinelerra on your system and the ffmpeg may be a different version than $4.2$ as used below. Then look at the output created in \texttt{/tmp/ff-formats.txt} and \texttt{codecs.txt}. -\begin{lstlisting}[language=bash,numbers=none]] +\begin{lstlisting}[language=bash,numbers=none] //cinelerra-5.1/thirdparty/ffmpeg-4.2/ffmpeg -formats > /tmp/ff-formats.txt //cinelerra-5.1/thirdparty/ffmpeg-4.2/ffmpeg -codecs > /tmp/ff-codecs.txt \end{lstlisting} @@ -233,7 +233,7 @@ For illustrative purposes, here is an example of the options files that need to Add the file named \texttt{./ffmpeg/audio/acc256k.pro} which contains the following lines: -\begin{lstlisting}[language=bash,numbers=none]] +\begin{lstlisting}[language=bash,numbers=none] mov aac strict -2 b 256000 @@ -243,13 +243,13 @@ b 256000 Add the file named \texttt{./ffmpeg/audio/pro.dfl} which contains the following lines: -\begin{lstlisting}[language=bash,numbers=none]] +\begin{lstlisting}[language=bash,numbers=none] acc256k.pro \end{lstlisting} Add the file named \texttt{./ffmpeg/video/prores.pro} which contains the following lines: -\begin{lstlisting}[language=bash,numbers=none]] +\begin{lstlisting}[language=bash,numbers=none] mov prores profile=2 # lines of comments @@ -257,7 +257,7 @@ profile=2 Add the file named \texttt{./ffmpeg/video/pro.dfl} which contains the following lines: -\begin{lstlisting}[language=bash,numbers=none]] +\begin{lstlisting}[language=bash,numbers=none] prores.pro \end{lstlisting} @@ -304,7 +304,7 @@ Figure~\ref{fig:audio-preset02} shows \textit{ffmpeg} video for the Kind. Note t Another feature gained from using ffmpeg in Cinelerra takes advantage of what is being referred to as the \textit{\%d trick}. This trick uses the ffmpeg muxer image2 and a filename template to create a series of image files of a given type. A specific example is described below. -To encode a series of $48$\,bit tiff output image files, add a file to the cinelerra data ffmpeg/video subdirectory as in: +To encode a series of $48$\,bit tiff output image files, add a file to the Cinelerra data ffmpeg/video subdirectory as in: \begin{lstlisting}[language=bash,numbers=none] # \dots/ffmpeg/video/tiff.dfl diff --git a/parts/Loadandsave.tex b/parts/Loadandsave.tex index 6e8d52f..72589b6 100644 --- a/parts/Loadandsave.tex +++ b/parts/Loadandsave.tex @@ -58,7 +58,7 @@ In order to be reasonably fast to use, you will most likely want to prepare them \subsubsection{Filelist format}% \label{ssub:filelist_format} -An image sequence is a series of ordered still pictures; for example a bunch of camera shots, frames of an animated scene, or series of frame shots. These can be loaded as multiple files. For timelapse sequences, as the size of camera images increases to 70 megabytes and beyond, and more images can be stored on a memory stick, more cache, memory, and system resources (such as file descriptors) are used by cinelerra to load the images when you use the \textit{concatenate tracks} or \textit{paste at insertion point} strategies. It is very time consuming and resource consuming when each of the image files is loaded and concatenated as edits, and it also plays super poorly. Here is an alternative to the usual \textit{load}. This technique may also be useful for just a bunch of pictures. +An image sequence is a series of ordered still pictures; for example a bunch of camera shots, frames of an animated scene, or series of frame shots. These can be loaded as multiple files. For timelapse sequences, as the size of camera images increases to 70 megabytes and beyond, and more images can be stored on a memory stick, more cache, memory, and system resources (such as file descriptors) are used by Cinelerra to load the images when you use the \textit{concatenate tracks} or \textit{paste at insertion point} strategies. It is very time consuming and resource consuming when each of the image files is loaded and concatenated as edits, and it also plays super poorly. Here is an alternative to the usual \textit{load}. This technique may also be useful for just a bunch of pictures. File lists formats can be utilized in some way for the following list of types of \textit{Sequence files} The first line of the sequence list file identifies the list codec. @@ -79,7 +79,7 @@ Using the example of jpeg’s, the jpeg list sequence file type is the easiest a $ jpeglist.sh //file.jpg //DSC*.jpg \end{lstlisting} -\vspace*{1ex} \noindent If <\texttt{path}> is the same on both outfile and infiles, then file.jpg is created in the same directory as infiles, the directory contains the entire asset, and the file list uses relative paths; otherwise the file list contains absolute paths. Since this creates outfile list as a single asset, the memory demand and access time is much lower. When you load the outfile in cinelerra, you will need to set \textit{Try ffmpeg last} since ffmpeg does not work with jpeglist sequence files. +\vspace*{1ex} \noindent If <\texttt{path}> is the same on both outfile and infiles, then file.jpg is created in the same directory as infiles, the directory contains the entire asset, and the file list uses relative paths; otherwise the file list contains absolute paths. Since this creates outfile list as a single asset, the memory demand and access time is much lower. When you load the outfile in Cinelerra, you will need to set \textit{Try ffmpeg last} since ffmpeg does not work with jpeglist sequence files. An example output file from running this script residing in the directory where \texttt{DSC*.jpg} files exist is shown below. @@ -136,7 +136,7 @@ This will access the media using ffmpeg which is slower so be patient. \hspace{4em} {\small \url{https://www.cybercom.net/~dcoffin/dcraw/}} -For example, included is the Canon Powershot SX60 (newly available in August, 2014). Because ffmpeg tries to load \textit{any and every} file if \textit{Try Ffmpeg first} is enabled. it will make an attempt to load Raw Camera files first before any other file driver gets the chance. In addition, there is the possibility that dcraw could conflict with the standard TIFF format, since it might be seen as format type \textit{tiff-pipe}. Therefore it is necessary to specifically enable CR2 and either move it to the top or disable \textit{FFMPEG\_Early} and enable \textit{FFMPEG\_late} in the \textit{Probe Order} as described in another sections (\ref{sub:probe_order_loading_media} and \ref{sec:ffmpeg_early_probe_explanation}). These changed settings will be retained across cinelerra sessions in .\texttt{bcast5}. Raw Camera mode is most likely going to be used by expert camera users. +For example, included is the Canon Powershot SX60 (newly available in August, 2014). Because ffmpeg tries to load \textit{any and every} file if \textit{Try Ffmpeg first} is enabled. it will make an attempt to load Raw Camera files first before any other file driver gets the chance. In addition, there is the possibility that dcraw could conflict with the standard TIFF format, since it might be seen as format type \textit{tiff-pipe}. Therefore it is necessary to specifically enable CR2 and either move it to the top or disable \textit{FFMPEG\_Early} and enable \textit{FFMPEG\_late} in the \textit{Probe Order} as described in another section (\ref{sub:probe_order_loading_media} and \ref{sec:ffmpeg_early_probe_explanation}). These changed settings will be retained across Cinelerra sessions in .\texttt{bcast5}. Raw Camera mode is most likely going to be used by expert camera users. The first screenshot in figure~\ref{fig:raw} as in \texttt{Settings $\rightarrow$ ~Preferences $\rightarrow$ ~Playback A} Tab, shows the default checked settings of \textit{Interpolate CR2 images} and \textit{White balance CR2 images} which display the raw images in a way that you expect. However, you may want to uncheck them to ensure that no program manipulation has modified your images so that you can add plugins or make your own modifications. Unchecked indicates that the images are as closest as possible to unadulterated raw. @@ -352,18 +352,18 @@ Originally, the easiest way to maintain a project for moving to another computer \subsection{Information about Backups and Perpetual Session}% \label{sub:information_backups_perpetual_session} -In an effort to minimize loss of work due to user, hardware, or software issues, cinelerra has some automatic backup capabilities. +In an effort to minimize loss of work due to user, hardware, or software issues, Cinelerra has some automatic backup capabilities. -Cinelerra automatically saves every \textit{editing operation} to the current project on disk continuously to a file named \texttt{\$HOME/.bcast5/backup.xml}. In the unlikely event of a crash, when you restart cinelerra, you should select \texttt{File $\rightarrow$ Load backup} in order to continue with the operations that were recorded before the crash. If you have more than 1 instance of Cinelerra running, only the last editing operation made in whichever instance it was last made, will overwrite the backup. +Cinelerra automatically saves every \textit{editing operation} to the current project on disk continuously to a file named \texttt{\$HOME/.bcast5/backup.xml}. In the unlikely event of a crash, when you restart Cinelerra, you should select \texttt{File $\rightarrow$ Load backup} in order to continue with the operations that were recorded before the crash. If you have more than 1 instance of Cinelerra running, only the last editing operation made in whichever instance it was last made, will overwrite the backup. -There is still 1 more backup that may save you. If for some reason you forgot to use \textit{Load backup} immediately when restarting, 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. This same file is also used by multiple instances of cinelerra. +There is still 1 more backup that may save you. If for some reason you forgot to use \textit{Load backup} immediately when restarting, 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. This same file is also used by multiple instances of Cinelerra. \textbf{Perpetual session} is very useful for working on a project over many days so you can just quit before shutting down and the next time you start up Cinelerra you will be right back where you left off. You will retain all of your undo’s and redo’s. The binary file name is \texttt{\$HOME/.bcast5/perpetual.dat} and as long as \texttt{Settings $\rightarrow$ Preferences}, the Appearance tab has the Flag \textit{Perpetual session} set this capability takes effect. It is very important to understand that this is not the same as the continuously editing- operation-updated \texttt{backup.xml} file. -The perpetual.dat file is \textit{only} updated when you Quit cinelerra in the normal manner. -Which means if you interrupt the program, or kill it, or there is a segv or system crash, the \texttt{perpetual.dat} file will only reflect the state of your project from when you last started cinelerra and none of the editing/undo’s/redo’s you executed during the current session which was not ended normally. +The perpetual.dat file is \textit{only} updated when you Quit Cinelerra in the normal manner. +Which means if you interrupt the program, or kill it, or there is a segv or system crash, the \texttt{perpetual.dat} file will only reflect the state of your project from when you last started Cinelerra, and none of the editing/undo’s/redo’s you executed during the current session which was not ended normally. \vspace{1ex} Some notes to keep in mind about Perpetual session are: @@ -373,9 +373,10 @@ Some notes to keep in mind about Perpetual session are: \item takes disk space in \texttt{.bcast5} area and this could get really big \item after you complete a project, it is advisable to turn off the Perpetual session flag before quitting so that when you start a new project, you can start with a fresh perpetual.dat by turning the flag on or - after stopping cinelerra, delete the current \texttt{\$HOME/.bcast5/perpetual.dat} file + after stopping Cinelerra, delete the current \texttt{\$HOME/.bcast5/perpetual.dat} file \item only session data is backed up (not program feature setup) \item the files backup.xml and backup.prev will operate the same as before so that if there is a crash, you will want to use \texttt{File $\rightarrow$ Load backup} in order to continue where you were interrupted. + \item to start Cinelerra without using your Perpetual session data even if enabled, use your\_cinelerra\_path\texttt{/cin/bin -S} \end{itemize} diff --git a/parts/Translations.tex b/parts/Translations.tex index 6fcebb5..d2f5705 100644 --- a/parts/Translations.tex +++ b/parts/Translations.tex @@ -3,10 +3,11 @@ There are several \textit{po} files for various languages to make Cinelerra more usable for non-English countries. A program, \texttt{xlat.C}, assists in providing several variations of text files that can be used in order to allow anyone to help make meaningful translations. All of the \textit{po} files are located in Cinelerra’s \texttt{/po} subdirectory. There are 3 different ways to proceed described below. -Because Cinelerra frequently is changing, it is a good idea to start by building a new \texttt{cin.po} file which contains the latest messages/words in English to be translated, along with a comment line of the routine name and line number. To create this, run the following line from a window: +Because Cinelerra frequently is changing, it is a good idea to start by building a new \texttt{cin.po} file which contains the latest messages/words in English to be translated, along with a comment line of the routine name and line number. To create this, run the following lines from a window: \begin{lstlisting}[language=bash,numbers=none] -/{your cinelerra directory}/po/xlat.sh > /tmp/cin.po +cd /{your top level cinelerra directory} +./po/xlat.sh > /tmp/cin.po \end{lstlisting} \begin{description} @@ -17,7 +18,8 @@ Because Cinelerra frequently is changing, it is a good idea to start by building To use the msgmerge command after creating a new cin.po as suggested previously: \begin{lstlisting}[language=bash,numbers=none] -/{your cinelerra directory}/po/xlat.sh > /tmp/cin.po # use /tmp as a temporary place +cd /{your top level cinelerra directory} +./po/xlat.sh > /tmp/cin.po # use /tmp as a temporary place cp /{your cinelerra directory}/po/xx.po /tmp/xx.po # substitute your language for x msgmerge -U /tmp/xx.po /tmp/cin.po # xx.po will be overwritten to include updates \end{lstlisting}