X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fmanual%2Fdcpomatic.xml;h=76fa4c2d72c174531efc56f03ea13e9d38b5afb4;hb=1f261b862e4f065505970c945531bf94843d5d17;hp=a790d10cf13f36c633ad51ab97e85891c1aa86ac;hpb=caf1d26c4df515e1fd0f9b2758cd3a589079ff4b;p=dcpomatic.git
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index a790d10cf..76fa4c2d7 100644
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -26,13 +26,16 @@ Hello, and welcome to DCP-o-matic!
What is DCP-o-matic?
-
-DCP-o-matic is a program to generate Digital
-Cinema Packages (DCPs) from almost any video, audio and/or
-subtitle source files. The resulting DCPs will play on modern digital
-cinema projectors.
-
+DCP-o-matic is a set of programs to allow you to:
+
+
+ Create Digital
+ Cinema Packages (DCPs) from video, audio, subtitle and closed-caption files.
+ Play and verify DCPs.
+ Create KDMs for DCPs.
+ Write cinema-format drives containing DCPs.
+
@@ -43,7 +46,7 @@ cinema projectors.
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.
@@ -69,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.
@@ -87,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.
@@ -95,63 +98,52 @@ 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.
-
-
-Mac OS X
+macOS
-DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and
-higher. To install it, download the .dmg from http://dcpomatic.com/ and double
-click to open it. Then drag the DCP-o-matics icon to your
-Applications folder or wherever else you would
-like to install it.
+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.
-You do not have to install all the applications, but you must always
-install DCP-o-matic 2.app as the other applications
-depend on it.
+If you don't know which parts of DCP-o-matic to install, start
+with the first (main) part.
-Debian or Ubuntu Linux
+Debian, Ubuntu or Mint Linux
You can install DCP-o-matic on:
- Debian 7 (‘wheezy’)
- Debian 8 (‘jessie’)
- Debian unstable (‘sid’)
- Ubuntu 12.04 (‘Precise Pangolin’)
- Ubuntu 14.04 (‘Trusty Tahr’)
- Ubuntu 16.04 (‘Xenial Xerus’)
+ Debian 9 (‘squeeze’), 10 (‘buster’) and unstable (‘sid’)
+ Ubuntu 16.04, 18.04, 20.04 and 20.10
+ Mint 18 and 19
using .deb packages: download the appropriate package
-from http://dcpomatic.com/
-and double-click it. Debian or Ubuntu will install the necessary bits and
+from https://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.
@@ -160,25 +152,14 @@ pieces and set DCP-o-matic up for you.
- Fedora Linux
+ Fedora, Centos and Mageia Linux
- There are .rpm packages for Fedora 22 and 23 on
- http://dcpomatic.com/
+ There are .rpm packages for Fedora 31, 32 and 33, Centos 7 and 8 and Mageia 7 on
+ https://dcpomatic.com/
-
-
-
- Centos Linux
- There are .rpm packages for Centos 5, 6.5 and 7 on
- http://dcpomatic.com/
-
-
-
-
-
Arch Linux
@@ -210,7 +191,6 @@ The following dependencies are required:
libsamplerateOpenSSLlibopenjpeg
-ImageMagickBoostlibsshGTK (on Linux)
@@ -219,9 +199,12 @@ The following dependencies are required:
xmlseccurllibzip
-libdcp
-libsub
-libcxml
+asdcplib with some patches
+libdcp
+libsub
+libcxml
+locked_sstream
+rtaudiolibicu
@@ -229,13 +212,13 @@ The following dependencies are required:
Once you have installed the development packages for the dependencies,
download the source code from http://dcpomatic.com/,
+url="https://dcpomatic.com/">https://dcpomatic.com/,
unpack it and run the following commands from inside the source
directory:
-./waf configure
+./waf configure --disable-tests
./waf build
sudo ./waf install
@@ -251,11 +234,13 @@ dcpomatic2
in a shell.
-
+
+
+
Creating a DCP from a video
@@ -272,7 +257,7 @@ DCP-o-matic. We will gloss over the details and look at the basics.
Let's make a very simple DCP to see how DCP-o-matic works. First, we
need some content. Download the low-resolution trailer for the open
movie Sintel from their
+url="https://download.blender.org/durian/trailer/Sintel_Trailer.480p.DivX_Plus_HD.mkv">their
website. Generally one would want to use the
highest-resolution material available, but for this test we will use
the low-resolution version to save everyone's bandwidth bills.
@@ -306,7 +291,7 @@ linkend="fig-video-new-film"/>.
Dialogue box for creating a new film
-
+
@@ -316,7 +301,7 @@ 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
the film. In the example from the figure, DCP-o-matic will create a
-folder called ‘DCP Test’ inside my home folder (carl) into which it
+folder called ‘DCP Test’ inside my existing folder DCP into which it
will write its working files.
@@ -329,8 +314,8 @@ will write its working files.
The next step is to add the content that you want to use. DCP-o-matic
-can make DCPs from multiple pieces of content, but in this simple
-example we will just use a single piece. Click the Add
+can make DCPs from multiple pieces of content, but in this example we
+will use a single piece. Click the Add
file(s)... button, as shown in , and a file chooser will open for you to
select the content file to use, as shown in .
Dragging the slider will move through your video. You can also click
-the Play button to play the content back. Note
-that there will be no sound, and playback might not be entirely
-accurate (it may be slightly slower or faster than it should be, for
-example). This player is really only intended for brief inspection of
-content; if you need to check it more thoroughly, use another player
-such as Totem, mplayer or
-VLC.
+the Play button to play the content back.
@@ -416,7 +393,7 @@ linkend="fig-making-dcp"/>.
Making the DCP
-
+
@@ -429,10 +406,9 @@ linkend="ch-files"/> for details about the files that DCP-o-matic creates.
-Alternatively, if you have a projector or Theatre Management System
-(TMS) that is accessible via SCP or FTP across your network, you can upload
-the content directly from DCP-o-matic. See the in .
+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 .
@@ -460,7 +436,7 @@ shown in .
Dialogue box for creating a new film
-
+
@@ -485,7 +461,7 @@ linkend="fig-still-select-content-file"/>.
Most of the default settings will be fine for a simple test. The one
thing that you might wish to change is the length of the still.
Select the Timing tab and you will see a
-Play length setting, as shown in Full length setting, as shown in .
@@ -515,34 +491,34 @@ to encode a single frame which it can then repeat.
-
+Manipulating existing DCPs
-Frequently DCP-o-matic is used to take content in formats such as MP4
-and convert it to JPEG2000 for a DCP. It can also be used
-to take existing DCPs and modify them in various ways.
+DCP-o-matic is often used to take content in formats such as MP4 and
+make it into a DCP. It can also be used to take existing DCPs and
+modify them in various ways.
Importing a DCP into DCP-o-matic
-If you want to do something to an existing DCP the first step is to
-import it. Click Add folder... 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 very slow as decoding of DCPs is almost as
-computationally intensive as encoding them.
+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
+decoding of DCPs is almost as computationally intensive as encoding
+them.
-If your DCP is a Version File (VF), in other words it refers to
-another DCP's assets, you should import it as follows:
+If your DCP is a Version File (VF) (i.e. it refers to
+another DCP's assets) you should import it as follows:
-Use Add folder... to import the VF DCP.
+Use Add DCP... to import the VF DCP.
The VF DCP will be added to the content list and marked “NEEDS
OV”.Right-click on the VF DCP in the content list and choose Add OV... from the menu.
@@ -552,7 +528,7 @@ OV”.
-
+Decrypting encrypted DCPs
@@ -580,8 +556,8 @@ and they can create a KDM to allow DCP-o-matic to decrypt their DCP.
Once you have your KDM, right-click the DCP's name in DCP-o-matic and
-choose Add KDM.... Specify your KDM and (all
-being well) the DCP will be decrypted and become available for preview.
+choose Add KDM.... Specify your KDM and the DCP
+will be decrypted and become available for preview.
@@ -621,8 +597,8 @@ the following content settings:
-If you do change any of these settings on a piece of DCP content
-DCP-o-matic will decode and then re-encode the JPEG2000 data.
+DCP-o-matic will be forced to decode and re-encode your JPEG2000 data
+if you change any of these settings on a piece of DCP content.
@@ -680,9 +656,9 @@ To make a DCP like this:
Import your ‘Content DCP’ to a DCP-o-matic project.Add whatever replacement you want in your new DCP (replacement subtitles or audio files, for example).Select the DCP in the content list
-Tick the Refer to existing DCP checkbox
+Tick the Use's this DCP's ... as OV and make VF checkbox
in the tabs for the parts of the DCP that you want to refer to in your
-new DCP. For example, to refer to the Content DCP's video and audio you would select the Video tab, click Refer to existing DCP then select the Audio tab and do the same.
+new DCP. For example, to refer to the Content DCP's video and audio you would select the Video tab, click Use this DCP's video as OV and make VF then select the Audio tab and click Use this DCP's audio as OV and make VF.Do Make DCP as usual and your VF DCP will be created.
@@ -747,11 +723,64 @@ To add one or more movie, sound, still-image or subtitle files, select
-To add a directory (folder) of images or a DCP, choose Add
-folder... and choose the directory from the selector. If
-you select a folder of images DCP-o-matic will open a small dialogue
-box where you can enter the frame rate that the image sequence should
-be run at.
+DCP-o-matic will automatically map a set of audio files to the correct channels if you include appropriate ‘tags’ in your filenames, as shown in .
+
+
+
+ Audio file naming
+
+
+
+ Tag
+ Examples
+ Channel
+
+
+
+
+ L surrounded by ._ or -
+ film-L.wav my_movie_L_final.wav
+ Left
+
+
+ R surrounded by ._ or -
+ film-R.wav my_movie_R_final.wav
+ Right
+
+
+ C surrounded by ._ or -
+ film-C.wav my_movie_C_final.wav
+ Centre
+
+
+ Lfe surrounded by ._ or -
+ film-Lfe.wav my_movie_Lfe_final.wav
+ LFE (sub)
+
+
+ Ls surrounded by ._ or -
+ film-Ls.wav my_movie_Ls_final.wav
+ Left surround
+
+
+ Rs surrounded by ._ or -
+ film-Rs.wav my_movie_Rs_final.wav
+ Right surround
+
+
+
+
+
+
+To add a directory (folder) of images, choose Add
+folder... and choose the directory from the selector.
+DCP-o-matic will open a small dialogue box where you can enter the
+frame rate that the image sequence should be run at.
+
+
+
+To add a DCP, choose Add DCP... and choose the
+DCP's directory from the selector.
@@ -807,7 +836,7 @@ held down. Note that not all settings can be changed in this way.
The content properties are split up into four sections:
Video, Audio,
-Subtitles and Timing. Not
+Timed text and Timing. Not
all of these sections will be active for all content types. The controls
in each section are described below.
@@ -835,12 +864,12 @@ The Video tab controls properties of the image, as shown in
-Refer to existing DCP
+Use this DCP's video as OV and make VF
This option is only applicable if the selected content is an existing
-DCP. It allows you to get the video content from the existing DCP by
-referencing it (rather than copying). See .
@@ -924,7 +953,7 @@ as shown in .
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 is much smaller and of lower resolution than a projected image!
+image may be smaller and of lower resolution than a projected image!
@@ -955,7 +984,7 @@ linkend="tab-colour-conversion"/>.
-sRGBStill images in RGB, e.g. photographs.
+sRGBStill images in RGB, e.g. photographs.Rec. 601Standard-definition content (fewer than about 1000 pixels across) including DVD rips.
@@ -993,7 +1022,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.
@@ -1003,11 +1032,11 @@ url="http://dcpomatic.com/manual/colour.pdf">colour.pdf.
Other settings
-The crop settings can be used to crop your content,
-which can be used to remove black borders from round the edges of DVD
-images, for example. The specified number of pixels will be trimmed
-from each edge, and the content image in the right of the window will
-be updated to show the effect of the crop.
+The crop settings can be used to crop your
+content, which is often used to remove black borders from the edges of
+the image. The specified number of pixels will be trimmed from each
+edge, and the content image in the right of the window will be updated
+to show the effect of the crop.
@@ -1033,9 +1062,9 @@ ratio that your content should be presented in.
At the bottom of the video tab is a short description of what will
happen to your video with the current settings. In the example of
, DCP-o-matic is telling you that the
-video file is 1920x1080 pixels and it has square pixels (a pixel
-aspect ratio of 1.00) hence its display aspect ratio is 1.78:1. Since
-the controls specify ‘16.9’ for the ratio, DCP-o-matic
+video file is 2048x872 pixels and it has square pixels (a pixel
+aspect ratio of 1.00) hence its display aspect ratio is 2.35:1. Since
+the controls specify ‘2.35’ for the ratio, DCP-o-matic
does not scale the image but pads it to the DCP's container ratio of
1.85:1. For a 2K DCP this is 1998x1080 pixels.
@@ -1057,7 +1086,7 @@ frame-rate conversion.
Audio
-The Audio tab controls properties of the image, as shown in .
+The Audio tab controls properties of the sound, as shown in .
@@ -2119,18 +2323,15 @@ from a file. The certificate should be in SHA256 PEM format.
Alternatively, certificates for projection systems made by some
manufacturers can be downloaded from databases provided by the
-manufacturer. Currently this is supported for Doremi and Dolby
-equipment. If you are targeting a screen with equipment by one of
-these manufacturers you can click Download then
-enter the serial number of the server in the screen and click
-Download again and, all being well, the certificate
-will be fetched.
-
-
-
-Using the download system you will need to know the serial number of
-the media server in use in the screen. Most cinema projection or
-technical departments will know these serial numbers.
+manufacturer. Currently this is supported for Doremi, Dolby, Barco,
+Christie and GDC equipment (through downloading Barco, Christie or GDC
+certificates requires you to have an appropriate account set up in
+DCP-o-matic's preferences). If you are targeting a screen with
+equipment by one of these manufacturers you can click
+Download then enter the serial number of the
+server in the screen and click Download again
+and, all being well, the certificate will be fetched. Most cinema
+projection or technical departments will know these serial numbers.
@@ -2189,7 +2390,7 @@ create KDMs for its film. Perhaps you want to archive the project to
save space, or create KDMs on a different machine. In such situations
it is easier to use a DKDM. This is a normal KDM, but instead of
being targeted at a projection system (to allow it to decrypt the
-content) it is targeted at a particular users's certificate. This
+content) it is targeted at a particular user's certificate. This
means that the certificate owner can create new KDMs for other users.
The DKDM holds everything that is required to create further KDMs.
@@ -2222,7 +2423,7 @@ DCP-o-matic. Its window is shown in .
The KDM creator
-
+
@@ -2237,7 +2438,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.
@@ -2253,6 +2454,69 @@ tab.
+
+Encryption keys
+
+
+ You must be careful when using encryption not to lose important keys.
+
+
+
+If you are making KDMs from a DCP-o-matic film you
+must ensure that you have a backup of the
+metadata.xml file from the project, as well as the DCP
+itself.
+
+
+
+If you are using a DKDM you must ensure that you
+have a backup of DCP-o-matic's config.xml file, since it
+contains the only key which can decrypt the DKDM. The
+config.xml file location depends on your operating
+system; possible locations are listed in .
+
+
+
+
+
+ Should I encrypt?
+
+
+ The question of whether encryption is appropriate for a given
+ project is a tricky one.
+
+
+
+ On the one hand, if you distribute an unencrypted DCP it is easy for
+ anybody to take it and do whatever they want with its contents.
+ They could use DCP-o-matic to convert it to a MP4, show it in
+ their cinema, or even edit and redistribute it in ways that you
+ do not like.
+
+
+
+ Encryption prevents this, but brings its own problems. It will be
+ impossible for a cinema to screen your DCP unless they have the
+ correct KDM. This is easy enough if things work as they should,
+ but problems can occur. For example, cinemas may substitute
+ broken playout servers with new ones without telling you: then the
+ KDM that you sent them will be invalid, and a new one required.
+ If the cinema can't get in touch with you, or somebody else who
+ can create a new KDM, they can't screen your DCP. Often these
+ problems are only discovered very close to showtime, with little
+ time for fixes.
+
+
+
+ If you are distributing encrypted DCPs widely it is worth thinking
+ about who will make the KDMs, and who will provide quick-response
+ technical support. It may be a good idea to engage a company who can
+ provide such services.
+
+
+
+
+
Encryption overview
@@ -2275,14 +2539,14 @@ tab.
Preferences
-DCP-o-matic provides a few preferences which can be used to modify its
-behaviour. This chapter explains those options.
+DCP-o-matic provides preferences which can be used to modify its
+behaviour. They are described in this chapter.
Preferences can be edited by choosing
Preferences... from the Edit
-menu. This opens a dialogue which is split into seven tabs.
+menu. This opens a dialogue which is split into eleven tabs.
@@ -2316,15 +2580,27 @@ 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
-read about how to contribute a translation.
+url="https://dcpomatic.com/i18n.php">the DCP-o-matic website to
+find out how to contribute a translation.
-Threads
+ Interface complexity
+
+
+ Choose Simple to see a cut-down, simplified
+ interface or Full to see DCP-o-matic's full
+ interface.
+
+
+
+
+
+
+Number of threads DCP-o-matic should use
When DCP-o-matic is encoding DCPs it can use multiple parallel threads
@@ -2336,6 +2612,31 @@ to set this up correctly when you run it for the first time.
+
+
+
+Number of threads DCP-o-matic encode server should use
+
+
+This is the number of threads that the encode server should use when
+it is running and helping another copy of DCP-o-matic to speed up its
+encode.
+
+
+
+
+
+
+
+Configuration file
+
+
+This is the location of DCP-o-matic's configuration file on disk. You
+can use this to share configuration between several copies of
+DCP-o-matic, across a network share, for instance.
+
+
+
Cinema and screen database file
@@ -2344,9 +2645,22 @@ to set this up correctly when you run it for the first time.
This option allows you to change the file that DCP-o-matic uses to
store details of the cinemas and screens used to make KDMs.
+
+
+
+
+
+Play sound via
+
+The checkbox to the left of Play sound enables or
+disables DCP-o-matic use of sound. On some machines there will be
+multiple options in the drop-down menu to decide how the sound should
+be played.
+
+
Integrated loudness
@@ -2360,6 +2674,15 @@ faster.
+
+
+Automatically analyse content audio
+
+
+If this checkbox is ticked an audio analysis will be run whenever content is added that contains sound.
+
+
+
Updates
@@ -2367,10 +2690,9 @@ faster.
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.
-available
@@ -2387,7 +2709,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).
@@ -2454,7 +2778,7 @@ name or IP address of the server to use.
Keys
-The Keys tab (shown in ) holds options
+The Keys tab (shown in ) has controls
related to the keys and certificates used in some parts of DCP
creation.
@@ -2469,9 +2793,37 @@ creation.
-At the top of the tab is the chain of certificates that will be used
-to sign DCPs and KDMs. DCP-o-matic creates a random chain when you
-first run it and if you are happy to use this chain you can ignore the
+Export KDM decryption certificate... allows you
+to save the certificate that DCP-o-matic uses when decrypting KDMs
+that you give it. Use this option if somebody wants to make a KDM for
+you and asks for your certificate.
+
+
+
+Export all KDM decryption settings... exports a
+file which contains all the DCP-o-matic settings related to the use of
+KDMs supplied by other people. Use this button and Import
+all KDM decryption settings... to transfer settings between
+different copies of DCP-o-matic so that they can both use the same
+KDMs.
+
+
+
+The two Advanced... buttons open advanced
+dialogue boxes for detailed manipulation of DCP-o-matic's certificate
+chains.
+
+
+
+
+
+Advanced keys settings
+
+
+At the top of the Advanced dialogue for signing
+DCPs and KDMs is the chain of certificates that will be used to sign
+DCPs and KDMs. DCP-o-matic creates a random chain when you first run
+it and if you are happy to use this chain you can ignore the
preferences. Otherwise, you can add or remove certificates from the
chain using the Add... and
Remove buttons.
@@ -2480,41 +2832,28 @@ chain using the Add... and
If you want DCP-o-matic to re-create the certificate chain (using new,
random certificates) click Re-make
-certificates... and specify your organisation and common
+certificates and key... and specify your organisation and common
names in the dialogue box that opens.
Underneath the certificate chain is the private key that corresponds
to the leaf certificate in the chain. You can specify your own
-private key by clicking Load.... You must do
+private key by clicking Import.... You must do
this if you change the leaf certificate, so that the leaf private key
corresponds to the public key held in the leaf certificate.
-Underneath the details of the certificate chain and private key for
-signing of DCPs and KDMs is a second chain and key which is used by
+At the top of the Advanced dialogue for decrypting DCPs is the chain and key which is used by
DCP-o-matic when you import an encrypted DCP as a piece of content.
The leaf certificate of this chain contains the public key that should
be used when targeting a KDM at DCP-o-matic.
-If you want to import an encrypted DCP you will need to give the
-decryption certificate to the distributor of the DCP so that they can
-generate a DKDM for you. You can save this certificate to disk by
-clicking Export DCP decryption certificate....
-As with the signing chain, DCP-o-matic will create a certificate chain
-and private key for you. You can also choose to load your own
-certificates and key or re-make the chain and key with new, random
-values.
-
-
-
-Clicking Export DCP decryption chain... will
-export the whole certificate chain, rather than just the leaf
-certificate.
+Clicking Export chain... will
+export the whole certificate chain.
@@ -2567,12 +2906,39 @@ Note that for this to work on Doremi servers you will need to set the
+
+
+Email
+
+
+The Email tab is shown in .
+
+
+
+ Email preferences
+
+
+
+
+
+
+
+
+These settings are used when DCP-o-matic sends emails.
+
+
+
+ Outgoing mail server should be the host name of a mail (SMTP) server that DCP-o-matic can use. You can also specify the port that DCP-o-matic should use. User name and Password are the credentials that are required to send email through the server you have specified.
+
+
+
+
KDM email
-The KDM email is shown in .
+The KDM email tab is shown in .
@@ -2588,10 +2954,10 @@ The KDM email is shown in .
This is a template for the email that is used to send KDMs out to
cinemas. You can change it to say whatever you like. A few
‘magic’ strings will be replaced by information from the
-KDM that is being sent:
+KDM that is being sent; these strings are shown in .
-
+
‘Magic’ KDM strings
@@ -2620,6 +2986,103 @@ The Reset to default text will replace the current KDM emai
+
+
+Notifications
+
+
+The Notifications tab is shown in .
+
+
+
+ Notifications preferences
+
+
+
+
+
+
+
+
+DCP-o-matic can notify the user when jobs have completed. These
+notifications can be either or both of a message box on-screen (if
+Message box is ticked) and email (if
+Email is ticked). If you enable email
+notifications you can fill in the details of the emails you want to
+send.
+
+
+
+The bottom box in the tab is the contents of the email that should
+be sent. DCP-o-matic will replace the ‘magic’ strings
+$JOB_NAME and $JOB_STATUS in the with the
+details of the job that has completed.
+
+
+
+
+
+
+
+Cover sheet
+
+
+The DCP cover sheet configuration is shown in .
+
+
+
+ DCP cover sheet preferences
+
+
+
+
+
+
+
+
+This is a template for the cover sheet that is written next to every DCP that DCP-o-matic creates. You can change it to say whatever you like. A few
+‘magic’ strings will be replaced by information from the
+DCP that has been made:
+
+
+
+‘Magic’ cover sheet strings
+
+
+
+$CPL_NAMEDCP title
+
+
+$TYPEDCP content type (e.g. feature, trailer...)
+
+
+$CONTAINERThe container ratio (e.g. flat, scope...)
+
+
+$AUDIODetails of the audio channels
+
+
+$AUDIO_LANGUAGEAudio language
+
+
+$SUBTITLE_LANGUAGESubtitle language
+
+
+$LENGTHDCP length in hours, minutes and seconds
+
+
+$SIZEDCP size in gigabytes
+
+
+
+
+
+
+The Reset to default text will replace the current cover sheet with DCP-o-matic's default.
+
+
+
+
@@ -2656,7 +3119,7 @@ this unticked for normal use.
Only servers encode makes DCP-o-matic encode
JPEG2000 data only on encoding servers and not on the host. We
-suggest you leave this un-ticked unless you have a good reason to do otherwise.
+suggest you leave this unticked unless you have a good reason to do otherwise.
@@ -2677,7 +3140,7 @@ as this makes the log files useful for tracking down bugs.
The Timing checkbox will enable extra log entries
-to allow developers to investigate and optimize the speed of
+to allow developers to investigate and optimise the speed of
DCP-o-matic. It will significantly increase the size of the log files
that are generated, so in normal use it is best to leave this
unticked.
@@ -2704,8 +3167,7 @@ however, always possible.
There are some limitations to video and audio frame rates in DCPs. This is
complicated by the fact that not all projectors will play DCPs at the
same frame rates. It is possible to create a DCP which one projector will
-play fine, but another (of a different type) will refuse to play, or
-even refuse to ingest.
+play fine, but another (of a different type) will refuse to play.
@@ -2714,10 +3176,10 @@ even refuse to ingest.
Guaranteed rates
-The only rates that are (pretty much) guaranteed to work on all DCI
-projectors are 24 frames per second (fps) for video and 48kHz or 96kHz
-for audio. If you are sending your DCPs to unknown places it wise to
-consider using these rates if at all possible.
+The only rates that are guaranteed to work on all DCI projectors are
+24 frames per second (fps) for video and 48kHz for audio. If you are
+sending DCPs to unknown places it is wise to consider using these
+rates if at all possible.
@@ -2728,7 +3190,7 @@ consider using these rates if at all possible.
Other often-supported rates
Many projectors now in the wild support additional video frame rates:
-25, 30 and 48 fps.
+25, 30, 48, 50 and 60 fps.
@@ -2786,8 +3248,8 @@ The Frame Rate control in the
DCP tab sets the video frame rate that the DCP
will use. Clicking Use best sets the rate to
what DCP-o-matic thinks is the best for your content. With this
-button, DCP-o-matic assumes that the whole range of frame rates (24,
-25, 30 and 48fps) are allowable.
+button, DCP-o-matic assumes that the most commonly-working frame rates (24,
+25 and 30fps) are allowed.
@@ -2810,6 +3272,7 @@ purposes.
+
Encoding servers
@@ -2873,7 +3336,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
+
+
+ Command-line tools
+
+
+ DCP-o-matic includes some tools which allow DCP creation from the
+ command line or from scripting languages. This chapter covers the
+ use of those tools.
+
+
+
+ There are three command-line tools in DCP-o-matic.
+ dcpomatic2_create creates film directories, with the
+ associated metadata, from a list of content files. Then
+ dcpomatic2_cli runs the transcode process on these
+ film directories. Finally, dcpomatic2_kdm_cli can be
+ used to create KDMs.
+
+
+
+ Some applications will benefit from setting up the films using the
+ main DCP-o-matic GUI and then using dcpomatic2_cli to
+ do the encode. This allows, for example, setup on a relatively
+ low-powered machine before running the encode on a higher-powered
+ headless server.
+
+
+
+ dcpomatic2_create
+
+
+ The syntax for dcpomatic2_create is:
+
+
+
+ dcpomatic2_create [OPTION] <CONTENT> [[OPTION] <CONTENT> ...]
+
+
+
+ [CONTENT] are the files or folders that you want to use in the
+ DCP. They can be:
+
+ ‘Movie’ files in almost any common format (e.g. MP4, MOV, MKV, etc.)
+ A folder containing and image sequence in almost any common format (e.g. TIFF, DPX etc.)
+ Sound files (e.g. WAV, MP3, AIFF)
+ Subtitles files (e.g. .srt, DCP XML, .ssa etc.)
+
+
+
+
+ The options are:
+
+
+
+
+
+ For example, to setup a film using a MP4 file you might do:
+
+
+
+ dcpomatic2_create -o my_film --container-ratio 185 --content-ratio 185 -c FTR -n "My Film" Stuff.mp4
+
+
+
+ This will create a folder called my_film which is ready for a DCP to be made by dcpomatic2_cli.
+
+
+
+ dcpomatic2_create will use any default settings that you have configured in the main DCP-o-matic preferences.
+
+
+
+
+ dcpomatic2_cli
+
+
+ The syntax for dcpomatic2_cli is:
+
+
+
+ dcpomatic2_cli [OPTION] [FILM]
+
+
+
+
+
+ For example, to encode a film called my_film you might do:
+
+
+
+ dcpomatic2_cli my_film
+
+
+
+
+ dcpomatic2_kdm_cli
+
+
+ The syntax for dcpomatic2_kdm_cli is:
+
+
+
+ dcpomatic2_kdm_cli [OPTION] <FILM|CPL-ID>
+
+
+
+
+
+
+
+
+
+
Loose ends
@@ -3009,6 +3585,7 @@ hashes.
+
Common tasks
@@ -3061,17 +3638,15 @@ especially if you are using unusual subtitle positioning or character
sets.
-
-
Making a VF DCPStart a new DCP-o-matic film.
-Click Add folder... and specify your existing DCP's folder.
+Click Add DCP... and specify your existing DCP's folder.Go to the DCP tab and choose Split by video content for Reel type.Go to the Video and
-Audio tabs in turn and tick the Refer to existing DCP checkboxes.
+Audio tabs in turn and tick the Use this DCP's audio as OV and make VF checkboxes.
Add your subtitles to the film in whatever format you have.Check the subtitle appearance in the preview; it will be
slow to respond as it is having to decompress images from the existing
@@ -3086,7 +3661,7 @@ DCP.Start a new DCP-o-matic film.
-Click Add folder... and specify your existing DCP's folder.
+Click Add DCP... and specify your existing DCP's folder.Add your subtitles to the film in whatever format you have.Check the subtitle appearance in the preview; it will be
slow to respond as it is having to decompress images from the existing
@@ -3102,7 +3677,7 @@ DCP. Adjust the appearance using controls in the
Start a new DCP-o-matic film.
-Click Add folder... and specify your existing DCP's folder.
+Click Add DCP... and specify your existing DCP's folder.Add your subtitles to the film in whatever format you have.Go to the Subtitle tab and tick the Burn subtitles into image checkbox.Check the subtitle appearance in the preview; it will be
@@ -3113,7 +3688,124 @@ DCP. Adjust the appearance using controls in the
+
+
+
+Adding soundtracks or subtitles in different languages
+
+
+If you have a film that is to be dubbed or subtitled in several
+languages, the best approach with DCP-o-matic is as follows:
+
+
+
+Make a DCP with the common elements (perhaps just the video, or maybe the video and sound); this is known as the Original Version (OV).
+For each language, make a new Version File (VF) DCP which refers to the OV.
+
+
+
+Once you have done this, you send the OV DCP to every cinema and then
+the appropriate VF to each cinema depending on what language they want
+to play the film in. The projectionist ingests both DCPs and then plays the VF.
+
+
+
+The advantage of this approach is that the VF DCPs are much smaller
+than the OV since they only have the language-specific parts. If you
+are just changing the subtitles you can often ship the OV by normal
+transport means (e.g. a hard drive or high-speed download) and send
+the VF by email.
+
+
+
+The full details of OV and VF files are discussed in . The steps can be summarised as follows:
+
+
+
+Create a new DCP-o-matic project for the OV, as normal, adding video and perhaps sound. Make the DCP.
+Create a new DCP-o-matic project for the VF.
+Use Add folder... to add your OV DCP to the project.
+Select the video tab and tick Use this DCP's video as OV and make VF (you may need to select By video content for Reel type in the DCP tab).
+Do the same in the Audio tab if your OV has audio.
+Add your language-specific audio and/or subtitles and Make DCP.
+
+
+
+
+
+
+
+ Playing and verifying DCPs
+
+ DCP-o-matic includes a DCP player, and although it requires a
+ very high-speed CPU to play DCPs in full resolution, it can also
+ play DCPs at reduced resolutions with slower CPUs.
+
+ To use the player, start DCP-o-matic
+ Player, and load a DCP using the
+ Open option on the File
+ menu.
+
+ If you load a VF and/or encrypted DCP you can add your OV
+ and/or KDM using the appropriate options on the
+ File menu.
+
+ During playback the Performance area at
+ the bottom right of the window will give details of how many frames
+ are being dropped; these are frames that were not decoded from the
+ DCP quickly enough. If this number is high you can increase
+ performance at the cost of rendering quality by choosing an option
+ from the View menu. If you set the player to
+ decode at less than full resolution the DCP's data will be decoded
+ at this lower resolution, which is quicker than decoding at full
+ resolution.
+
+
+
+ The player also offers a simple DCP validator. To check a DCP,
+ open it and then select Verify DCP from the
+ Tools menu. This will run some basic checks to see if the DCP meets the required standards.
+
+
+
+
+
+
+Configuration files
+
+Most of DCP-o-matic's configuration is stored in an XML file called config.xml. This is stored in different places depending on your operating system:
+
+
+ Windows: c:\Users\your_user_name\AppData\Local\dcpomatic
+ OS X: /Users/your_user_Name/Library/Preferences/com.dcpomatic/2
+ Linux: ~/.config/dcpomatic2
+
+
+Possible XML tags are as follows:
+
+
+
+
+
+
+
+
+
+
+
+
+