X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=797a49fe5812acc820f54ee31c26f753c9e4c9c9;hb=3ddec1cb6b495763991f18ed6ffccc8724882199;hp=18fe753b59b49cb54cf6b3fe76bdc53050023cbf;hpb=44662dcbb5cb5543ff1810b4a92115e447553c9d;p=dcpomatic.git diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 18fe753b5..797a49fe5 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -26,14 +26,15 @@ Hello, and welcome to DCP-o-matic!
What is DCP-o-matic? -DCP-o-matic is a set of programs to perform the following tasks: +DCP-o-matic is a set of programs to allow you to: - Creation of Digital + Create Digital Cinema Packages (DCPs) from video, audio, subtitle and closed-caption files. - Playback and verification of DCPs on a PC/Mac. - Creation of KDMs for DCPs. + Play and verify DCPs. + Create KDMs for DCPs. + Write cinema-format drives containing DCPs.
@@ -45,7 +46,7 @@ Hello, and welcome to DCP-o-matic! DCP-o-matic is free and open-source and is licensed under the GNU +url="https://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU GPL. @@ -71,7 +72,7 @@ This manual presents bits of DCP-o-matic's user interface (such as menu items or -Notes of an advanced nature are presented like this. Ignore them unless you want to know the gory details. +Notes of an advanced nature are presented like this. Ignore them unless you want to know the details. @@ -89,7 +90,7 @@ Notes of an advanced nature are presented like this. Ignore them unless you wan To install DCP-o-matic on Windows, download the installer from -http://dcpomatic.com/ +https://dcpomatic.com/ and double-click it. Click through the installer wizard, and DCP-o-matic will be installed onto your machine. @@ -97,36 +98,29 @@ DCP-o-matic will be installed onto your machine. If you are using a 32-bit version of Windows, you will need the 32-bit installer. For 64-bit Windows, either installer will work, but I -suggest you used the 64-bit version as it will allow DCP-o-matic to +suggest you use the 64-bit version as it will allow DCP-o-matic to use more memory. You may find that DCP-o-matic crashes if you run many parallel encoding threads (more than 4) on the 32-bit version. - -If you are still using Windows XP, download the specific XP version as -it should be more stable on your machine than the ‘normal’ -Windows version. Be aware, though, that support for Windows XP will -not last forever and you should plan to upgrade if at all possible. - -
-Mac OS X +macOS -DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and -higher. DCP-o-matic is split into five separate applications, each of +DCP-o-matic will run on macOS version 10.10 (Yosemite) and +higher. DCP-o-matic is split into seven separate applications, each of which can be installed by downloading the .dmg, double-clicking to open and then dragging the icon to your Applications folder. -If you are not sure which parts of DCP-o-matic to install, start +If you don't know which parts of DCP-o-matic to install, start with the first (main) part. @@ -134,23 +128,10 @@ with the first (main) part.
-Debian, Ubuntu or Mint Linux +Debian, Ubuntu and Mint Linux - - You can install DCP-o-matic on: - - - - Debian 7 (‘wheezy’), 8 (‘jessie’), 9 (‘squeeze’) and unstable (‘sid’) - Ubuntu 14.04 (‘Trusty Tahr’), 16.04 (‘Xenial Xerus’), 18.04 (‘Bionic Beaver’) and 18.10 (‘Cosmic Cuttlefish’) - Mint 17, 18 and 19 - - - -using .deb packages: download the appropriate package -from http://dcpomatic.com/ -and double-click it. Debian, Ubuntu or Mint will install the necessary bits and -pieces and set DCP-o-matic up for you. +There are .deb packages for Debian, Ubuntu and Mint on + https://dcpomatic.com/
@@ -160,8 +141,8 @@ pieces and set DCP-o-matic up for you.
Fedora, Centos and Mageia Linux - There are .rpm packages for Fedora 27, 28 and 29, Centos 6 and 7 and Mageia 6 on - http://dcpomatic.com/ + There are .rpm packages for Fedora, Centos and Mageia on + https://dcpomatic.com/
@@ -176,99 +157,17 @@ thanks to Stefan Karner.
- -
-Other Linux distributions - - -Installation on other Linux systems (for which no packages are -available) is quite hard as it must be compiled from source. If you -can't download packages for your distribution, do let me know by -email and I will look -into providing packages on the website. - - - -The following dependencies are required: - -FFmpeg -libsndfile -libsamplerate -OpenSSL -libopenjpeg -Boost -libssh -GTK (on Linux) -wxWidgets -libxml++ -xmlsec -curl -libzip -asdcplib with some patches -libdcp -libsub -libcxml -locked_sstream -rtaudio -libicu - - - - -Once you have installed the development packages for the dependencies, -download the source code from http://dcpomatic.com/, -unpack it and run the following commands from inside the source -directory: - - - -./waf configure --disable-tests -./waf build -sudo ./waf install - - - -With any luck, this will build and install DCP-o-matic on your system. To run it, enter: - - - -dcpomatic2 - - - -in a shell. - -
- - -
-‘Simple’ and ‘Full’ modes - -When you start DCP-o-matic for the first time it will ask you if -you want to use ‘simple’ or ‘full’ mode. - - -The difference between these two is that some of DCP-o-matic's -more complex or less-used controls are hidden from view in -‘Simple’ mode. This makes the interface simpler to -navigate. You may wish to choose this mode if you do not have much -experience with DCP or video processing. - - -Even if you choose ‘Simple’ mode you can always go -back to ‘Full’ mode by changing the Interface -complexity setting in the General tab -of Preferences. - - - -All the screenshots in this manual are from a copy of DCP-o-matic in ‘Full’ mode. + + Building from source + + + Since DCP-o-matic is open-source you can also build it yourself, though this can be quite a difficult process (especially on Windows and macOS). There are instructions for how to do it on + + https://dcpomatic.com/ + -
- @@ -300,8 +199,12 @@ the low-resolution version to save everyone's bandwidth bills. Now, start DCP-o-matic and its window will open. First, we will create a new ‘film’. A ‘film’ is how DCP-o-matic refers to some pieces of content, along with some settings, which we will make into -a DCP. DCP-o-matic stores its data in a folder on your disk while it -creates the DCP. You can create a new film by selecting +a DCP. DCP-o-matic stores its ‘film’ data in a folder on your disk while it +creates the DCP. + + + +You can create a new film by selecting New from the File menu, as shown in . @@ -310,7 +213,7 @@ shown in . Creating a new film - + @@ -324,7 +227,7 @@ linkend="fig-video-new-film"/>. Dialogue box for creating a new film - + @@ -332,7 +235,7 @@ linkend="fig-video-new-film"/>. In this dialogue box you can choose a name for the film. This will be used to name the folder to store its data in, and also as the initial -name for the DCP itself. You can also choose whereabouts you want to create +name for the DCP itself. You can also choose where you want to create the film. In the example from the figure, DCP-o-matic will create a folder called ‘DCP Test’ inside my existing folder DCP into which it will write its working files. @@ -426,23 +329,21 @@ linkend="fig-making-dcp"/>. Making the DCP - + -When it has finished, the DCP will end up on your disk inside the -film's folder. You can then copy this to a projector via a USB -stick, hard-drive or network connection. See for details about the files that DCP-o-matic creates. Alternatively, DCP-o-matic can upload your DCP directly to a projector or Theatre Management System (TMS) that is accessible via SCP or FTP -across your network. See the in . +across your network. See . @@ -470,7 +371,7 @@ shown in . Dialogue box for creating a new film - + @@ -541,7 +442,7 @@ modify them in various ways. The first step in manipulating an existing DCP is to import it. Click Add DCP... and select your DCP's folder. It will be added to the DCP-o-matic project. If the DCP is unencrypted you -can preview it in the normal way, though playback will be slow as +can preview it in the normal way, though playback may be slow as decoding of DCPs is almost as computationally intensive as encoding them. @@ -743,12 +644,14 @@ example, a JPEG, PNG or TIFF file. images which should be treated as the frames of a video. -Subtitle — a file containing subtitle which will be +Subtitle — a file containing subtitles which will be superimposed on the image of the DCP. These can be .srt, .ssa, .ass or .xml -files. +files. Subtitle files can also be used to make closed captions. DCP — an existing DCP. + +ATMOS MXFs — if you have Dolby ATMOS content in MXF format (created using Dolby's tools) you can add it to a DCP just like any other content. @@ -961,38 +864,6 @@ and DCP-o-matic will pick up the appropriate frames from each. - -
-Filtering - - -The ‘filters’ settings allow you to apply various video -filters to the image. These may be useful to try to improve -poor-quality sources like DVDs. You can set up the filters by clicking the -Edit button next to the filters entry in the -setup area of the DCP-o-matic window; this opens the filters selector -as shown in . - - -
- Filters selector - - - - - -
- - -After changing the filters setup, you will need to regenerate the DCP -to see the effect on the cinema screen. The preview in DCP-o-matic -will update itself whenever filters are changed, though of course this -image may be smaller and of lower resolution than a projected image! - -
- - -
Colour conversion @@ -1056,7 +927,7 @@ are already in the XYZ colour space and require no conversion. DCP-o-matic's colour conversion processes are discussed in much more detail in a separate document colour.pdf. +url="https://dcpomatic.com/manual/colour.pdf">colour.pdf.
@@ -1722,6 +1593,107 @@ open to allow you to choose which settings you want to copy. Clicking +
+Advanced content settings + + +There are a few more content settings that you can change by right-clicking a piece of content in the list and choosing Advanced settings... +This opens the dialogue box shown in . + + +
+ Advanced content dialogue + + + + + +
+ + + +
+Video filters + + +The Video filters setting allows you to apply various +filters to the image. These may be useful to try to improve +poor-quality sources like DVDs. You can set up the filters by clicking the +Edit button next to the filters entry; this opens the filters selector +as shown in . + + +
+ Filters selector + + + + + +
+ +
+ + +
+Override frame rate + + +The Override detected video frame rate setting has some different effects depending on the type of content +you use it on. + + + +For video content, it sets the frame rate that DCP-o-matic will run the video at. This is useful if DCP-o-matic has mis-detected +the video frame rate. For example, if DCP-o-matic says your content is 24fps when you know for a fact it's 25fps, you can set the +override value to 25 to force DCP-o-matic to do the right thing. + + + +On audio, subtitle and caption content this setting behaves slightly differently. It sets the video frame rate that the content +in question was intended to work with. As an example, consider a project with a 23.976fps video source and some separate audio files. +Perhaps those audio files have been mastered alongside a 24fps version of your video. By default, DCP-o-matic will see the 23.976fps +video file and decide to run it slightly fast at 24fps to fit the DCP standard. It will then also run the audio slightly fast so that +it stays in sync with the video. + + + +In this case, though, that is not what you want, since the audio is already ‘fixed’ to work alongside 24fps video. If you +override the video frame rate of the audio content to 24fps this will stop DCP-o-matic altering it. + + + +A similar situation can occur if you have video at one rate and a subtitle file that was prepared with its timing at a different rate. +In that case, you should override the video frame rate of the subtitle content to the one that it was prepared for. +This will mean that DCP-o-matic can get the relative timing right. + + + +Do not use this setting to change the DCP frame rate. Doing so will result in strange effects and sync problems. + +
+ + +
+Video has burnt-in subtitles + +Details about subtitle language are stored in various places within the DCP metadata. If a piece of video content already has subtitles +burnt into the image you can tell DCP-o-matic the language that they are in by clicking the Edit... button. + +
+ + +
+Ignore this content's video + +Tick this if you have some content which includes video along with other things (such as audio or subtitles) and you do +not want the video to appear in the DCP. + +
+ + +
+ @@ -2201,7 +2173,7 @@ methods to understand it. We suppose that we are trying to send a DCP to -Alice's cinema without a troublemaker called Mallory being able to +Alice's cinema without an attacker called Mallory being able to watch it himself. @@ -2472,7 +2444,7 @@ KDMs. By default the DKDM list will list any DCPs for which you have clicked Make DKDM for -DCP-o-maticin the main DCP-o-matic program. If you have +DCP-o-matic in the main DCP-o-matic program. If you have other DKDMs you can add them by clicking Add... and specifying the file containing the DKDM. @@ -2614,7 +2586,7 @@ You will need to restart DCP-o-matic to see the new language. The translations for DCP-o-matic have been contributed by helpful users. If your language is not on the last, head to the DCP-o-matic website to +url="https://dcpomatic.com/i18n.php">the DCP-o-matic website to find out how to contribute a translation. @@ -2724,7 +2696,7 @@ If this checkbox is ticked an audio analysis will be run whenever content is add The Check for updates on startup option, if enabled, will tell DCP-o-matic to check on dcpomatic.com to see if there any +url="https://dcpomatic.com/">dcpomatic.com to see if there any newer versions of DCP-o-matic then the one you are running. If so, a dialogue box will open with a link to download the new version. @@ -2743,7 +2715,9 @@ like to live on the bleeding edge! With these controls you can set the issuer and creator strings that -will be put into the DCPs which you create. +will be put into the DCPs which you create. The issuer is typically your name +(or your organisation's name) and the creator is typically the name of the tool +used to make the DCP (e.g. DCP-o-matic). @@ -3018,33 +2992,6 @@ The Reset to default text will replace the current KDM emai - - -
-Accounts - - -The Accounts tab is shown in . - - -
- Accounts preferences - - - - - -
- - -DCP-o-matic can download projector certificates from the Barco, -Christie and GDC websites if you have the appropriate credentials. -Enter your usernames and passwords. - - -
- -
Notifications @@ -3395,7 +3342,7 @@ server or open a window to show its status. If you would rather not bother installing DCP-o-matic on your server computers, the other option is to use the live-CD image that you can download from the DCP-o-matic web site. +url="https://dcpomatic.com/">DCP-o-matic web site. Either burn the image to CD, or write it to a USB stick (using something like + + + +Keyboard shortcuts + + + + Configuration files