1 <?xml version="1.0" encoding="utf-8"?>
3 <!ENTITY % sgml.features "IGNORE">
4 <!ENTITY % xml.features "INCLUDE">
5 <!ENTITY % dbcent PUBLIC "-//OASIS//ENTITIES DocBook Character Entities V4.5//EN"
6 "/usr/share/xml/docbook/schema/dtd/4.5/dbcentx.mod">
8 <!ENTITY % extensions SYSTEM "extensions.ent">
11 <book xmlns="http://docbook.org/ns/docbook" xmlns:mml="http://www.w3.org/1998/Math/MathML" version="5.0" xml:lang="en">
14 <title>DCP-o-matic users' manual</title>
15 <author><firstname>Carl</firstname><surname>Hetherington</surname></author>
18 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
19 <title>Introduction</title>
22 Hello, and welcome to DCP-o-matic!
25 <!-- ============================================================== -->
27 <title>What is DCP-o-matic?</title>
29 <para>DCP-o-matic is a set of programs to allow you to:</para>
32 <listitem>Create <ulink
33 url="https://en.wikipedia.org/wiki/Digital_Cinema_Package">Digital
34 Cinema Packages</ulink> (DCPs) from video, audio, subtitle and closed-caption files.</listitem>
35 <listitem>Play and verify DCPs.</listitem>
36 <listitem>Create KDMs for DCPs.</listitem>
37 <listitem>Write cinema-format drives containing DCPs.</listitem>
43 <!-- ============================================================== -->
45 <title>Licence</title>
48 DCP-o-matic is free and open-source and is licensed under the <ulink
49 url="https://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU
56 <!-- ============================================================== -->
58 <title>Acknowledgements</title>
61 This manual uses icons from the <ulink url="http://tango.freedesktop.org/">Tango Desktop Project</ulink>, with thanks.
66 <!-- ============================================================== -->
68 <title>This manual</title>
71 This manual presents bits of DCP-o-matic's user interface (such as menu items or buttons) <guilabel>like this</guilabel>.
75 Notes of an advanced nature are presented like this. Ignore them unless you want to know the details.
82 <!-- ============================================================== -->
83 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
84 <title>Installation</title>
87 <!-- ============================================================== -->
89 <title>Windows</title>
92 To install DCP-o-matic on Windows, download the installer from
93 <ulink url="https://dcpomatic.com/">https://dcpomatic.com/</ulink>
94 and double-click it. Click through the installer wizard, and
95 DCP-o-matic will be installed onto your machine.
99 If you are using a 32-bit version of Windows, you will need the 32-bit
100 installer. For 64-bit Windows, either installer will work, but I
101 suggest you use the 64-bit version as it will allow DCP-o-matic to
102 use more memory. You may find that DCP-o-matic crashes if you run
103 many parallel encoding threads (more than 4) on the 32-bit
110 <!-- ============================================================== -->
115 DCP-o-matic will run on macOS version 10.6 (Snow Leopard) and
116 higher. DCP-o-matic is split into seven separate applications, each of
117 which can be installed by downloading the <code>.dmg</code>,
118 double-clicking to open and then dragging the icon to your
119 <guilabel>Applications</guilabel> folder.
123 Make sure you choose the correct download, depending on whether you are running macOS 10.9 (Mavericks) (or higher) or something older.
127 If you don't know which parts of DCP-o-matic to install, start
128 with the first (main) part.
133 <!-- ============================================================== -->
135 <title>Debian, Ubuntu or Mint Linux</title>
138 You can install DCP-o-matic on:
142 <listitem>Debian 9 (‘squeeze’), 10 (‘buster’) and unstable (‘sid’)</listitem>
143 <listitem>Ubuntu 16.04 (‘Xenial Xerus’), 18.04 (‘Bionic Beaver’), 19.10 (‘Eoan Ermine’) and 20.04 (‘Focal Fossa’)</listitem>
144 <listitem>Mint 18 and 19</listitem>
148 using <code>.deb</code> packages: download the appropriate package
149 from <ulink url="https://dcpomatic.com/">https://dcpomatic.com/</ulink>
150 and double-click it. Debian, Ubuntu or Mint will install the necessary bits and
151 pieces and set DCP-o-matic up for you.
154 <!-- ============================================================== -->
157 <!-- ============================================================== -->
159 <title>Fedora, Centos and Mageia Linux</title>
161 <para>There are <code>.rpm</code> packages for Fedora 30, 31 and 32, Centos 7 and 8 and Mageia 7 on
162 <ulink url="https://dcpomatic.com/">https://dcpomatic.com/</ulink>
165 <!-- ============================================================== -->
167 <!-- ============================================================== -->
169 <title>Arch Linux</title>
171 Packages for Arch Linux are available from <ulink
172 url="https://aur.archlinux.org/packages/dcpomatic/">https://aur.archlinux.org/packages/dcpomatic/</ulink>,
173 thanks to Stefan Karner.
178 <!-- ============================================================== -->
180 <title>Other Linux distributions</title>
183 Installation on other Linux systems (for which no packages are
184 available) is quite hard as it must be compiled from source. If you
185 can't download packages for your distribution, do let me know by
186 <ulink url="mailto:carl@dcpomatic.com">email</ulink> and I will look
187 into providing packages on the website.
191 The following dependencies are required:
193 <listitem><ulink url="http://ffmpeg.org/">FFmpeg</ulink></listitem>
194 <listitem><ulink url="http://www.mega-nerd.com/libsndfile/">libsndfile</ulink></listitem>
195 <listitem><ulink url="http://www.mega-nerd.com/SRC/">libsamplerate</ulink></listitem>
196 <listitem><ulink url="http://www.openssl.org/">OpenSSL</ulink></listitem>
197 <listitem><ulink url="http://www.openjpeg.org/">libopenjpeg</ulink></listitem>
198 <listitem><ulink url="http://www.boost.org/">Boost</ulink></listitem>
199 <listitem><ulink url="http://www.libssh.org/">libssh</ulink></listitem>
200 <listitem><ulink url="http://www.gtk.org/">GTK (on Linux)</ulink></listitem>
201 <listitem><ulink url="http://www.wxwidgets.org/">wxWidgets</ulink></listitem>
202 <listitem><ulink url="http://libxmlplusplus.sourceforge.net/">libxml++</ulink></listitem>
203 <listitem><ulink url="http://www.aleksey.com/xmlsec/">xmlsec</ulink></listitem>
204 <listitem><ulink url="http://curl.haxx.se/">curl</ulink></listitem>
205 <listitem><ulink url="http://www.nih.at/libzip/">libzip</ulink></listitem>
206 <listitem><ulink url="http://carlh.net/asdcplib">asdcplib with some patches</ulink></listitem>
207 <listitem><ulink url="http://carlh.net/libdcp">libdcp</ulink></listitem>
208 <listitem><ulink url="http://carlh.net/libsub">libsub</ulink></listitem>
209 <listitem><ulink url="http://carlh.net/libcxml">libcxml</ulink></listitem>
210 <listitem><ulink url="https://carlh.net/locked_sstream">locked_sstream</ulink></listitem>
211 <listitem><ulink url="https://www.music.mcgill.ca/~gary/rtaudio/">rtaudio</ulink></listitem>
212 <listitem><ulink url="http://site.icu-project.org">libicu</ulink></listitem>
217 Once you have installed the development packages for the dependencies,
218 download the source code from <ulink
219 url="https://dcpomatic.com/">https://dcpomatic.com/</ulink>,
220 unpack it and run the following commands from inside the source
225 ./waf configure --disable-tests
231 With any luck, this will build and install DCP-o-matic on your system. To run it, enter:
243 <!-- ============================================================== -->
245 <title>‘Simple’ and ‘Full’ modes</title>
247 <para>When you start DCP-o-matic for the first time it will ask you if
248 you want to use ‘simple’ or ‘full’ mode.
251 <para>The difference between these two is that some of DCP-o-matic's
252 more complex or less-used controls are hidden from view in
253 ‘Simple’ mode. This makes the interface simpler to
254 navigate. You may wish to choose this mode if you do not have much
255 experience with DCP or video processing.
258 <para>Even if you choose ‘Simple’ mode you can always go
259 back to ‘Full’ mode by changing the <guilabel>Interface
260 complexity</guilabel> setting in the <guilabel>General</guilabel> tab
261 of <guilabel>Preferences</guilabel>.
265 All the screenshots in this manual are from a copy of DCP-o-matic in ‘Full’ mode.
275 <!-- ============================================================== -->
276 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
277 <title>Creating a DCP from a video</title>
280 In this chapter we will see how to create a DCP from a video file using
281 DCP-o-matic. We will gloss over the details and look at the basics.
285 <title>Creating a new film</title>
288 Let's make a very simple DCP to see how DCP-o-matic works. First, we
289 need some content. Download the low-resolution trailer for the open
290 movie <ulink url="http://sintel.org/">Sintel</ulink> from <ulink
291 url="https://download.blender.org/durian/trailer/Sintel_Trailer.480p.DivX_Plus_HD.mkv">their
292 website</ulink>. Generally one would want to use the
293 highest-resolution material available, but for this test we will use
294 the low-resolution version to save everyone's bandwidth bills.
298 Now, start DCP-o-matic and its window will open. First, we will
299 create a new ‘film’. A ‘film’ is how DCP-o-matic refers to
300 some pieces of content, along with some settings, which we will make into
301 a DCP. DCP-o-matic stores its data in a folder on your disk while it
302 creates the DCP. You can create a new film by selecting
303 <guilabel>New</guilabel> from the <guilabel>File</guilabel> menu, as
304 shown in <xref linkend="fig-file-new"/>.
307 <figure id="fig-file-new">
308 <title>Creating a new film</title>
311 <imagedata scale="250" fileref="screenshots/file-new&scs;"/>
317 This will open a dialogue box for the new film, as shown in <xref
318 linkend="fig-video-new-film"/>.
321 <figure id="fig-video-new-film">
322 <title>Dialogue box for creating a new film</title>
325 <imagedata fileref="screenshots/video-new-film&scs;"/>
331 In this dialogue box you can choose a name for the film. This will be
332 used to name the folder to store its data in, and also as the initial
333 name for the DCP itself. You can also choose whereabouts you want to create
334 the film. In the example from the figure, DCP-o-matic will create a
335 folder called ‘DCP Test’ inside my existing folder <code>DCP</code> into which it
336 will write its working files.
342 <!-- ============================================================== -->
344 <title>Adding content</title>
347 The next step is to add the content that you want to use. DCP-o-matic
348 can make DCPs from multiple pieces of content, but in this example we
349 will use a single piece. Click the <guilabel>Add
350 file(s)...</guilabel> button, as shown in <xref
351 linkend="fig-add-file"/>, and a file chooser will open for you to
352 select the content file to use, as shown in <xref
353 linkend="fig-video-select-content-file"/>.
356 <figure id="fig-add-file">
357 <title>Adding content files</title>
360 <imagedata fileref="screenshots/add-file&scs;"/>
365 <figure id="fig-video-select-content-file">
366 <title>Selecting a video content file</title>
369 <imagedata fileref="screenshots/video-select-content-file&scs;"/>
375 Select your content file and click <guilabel>Open</guilabel>. In this
376 case we are using the Sintel trailer that we downloaded earlier.
380 When you do this, DCP-o-matic will take a look at your file. After a
381 short while (when the progress bar at the bottom right of the window
382 has finished), you can look through your content using the slider to
383 the right of the window, as shown in <xref linkend="fig-examine-content"/>.
386 <figure id="fig-examine-content">
387 <title>Examining the content</title>
390 <imagedata fileref="screenshots/examine-content&scs;"/>
396 Dragging the slider will move through your video. You can also click
397 the <guilabel>Play</guilabel> button to play the content back.
405 <!-- ============================================================== -->
407 <title>Making the DCP</title>
409 <para>In most cases, some adjustments would be made to DCP-o-matic's
410 settings once the content has been added. For our simple test,
411 however, the default values will suffice, so we can go straight onto
412 making the DCP.</para>
415 Choose <guilabel>Make DCP</guilabel> from the
416 <guilabel>Jobs</guilabel> menu. DCP-o-matic will encode your DCP.
417 This may take some time (many hours in some cases). While the job is
418 in progress, DCP-o-matic will update you on how it is getting on with
419 the progress bar in the bottom of its window, as shown in <xref
420 linkend="fig-making-dcp"/>.
423 <figure id="fig-making-dcp">
424 <title>Making the DCP</title>
427 <imagedata scale="250" fileref="screenshots/making-dcp&scs;"/>
433 When it has finished, the DCP will end up on your disk inside the
434 film's folder. You can then copy this to a projector via a USB
435 stick, hard-drive or network connection. See <xref
436 linkend="ch-files"/> for details about the files that DCP-o-matic creates.
440 Alternatively, DCP-o-matic can upload your DCP directly to a projector
441 or Theatre Management System (TMS) that is accessible via SCP or FTP
442 across your network. See the <xref linkend="sec-prefs-tms"
443 endterm="sec-prefs-tms-short"/> in <xref linkend="sec-prefs-tms"/>.
450 <!-- ============================================================== -->
451 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
452 <title>Creating a DCP from a still image</title>
455 DCP-o-matic can also be used to create DCPs of one or more still images, perhaps
456 for an advertisement or an on-screen announcement. This chapter shows you
461 As with DCPs made from video files, the first step is to create a new
462 ‘Film’; select <guilabel>New</guilabel> from the
463 <guilabel>File</guilabel> menu and the new film dialogue will open as
464 shown in <xref linkend="fig-still-new-film"/>.
467 <figure id="fig-still-new-film">
468 <title>Dialogue box for creating a new film</title>
471 <imagedata fileref="screenshots/still-new-film&scs;"/>
477 Enter a name and click <guilabel>OK</guilabel>. Now we need to add
478 the content. As before, click <guilabel>Add file(s)...</guilabel>.
479 For our example, we will add a single image file, as shown in <xref
480 linkend="fig-still-select-content-file"/>.
483 <figure id="fig-still-select-content-file">
484 <title>Selecting a still content file</title>
487 <imagedata fileref="screenshots/still-select-content-file&scs;"/>
493 Most of the default settings will be fine for a simple test. The one
494 thing that you might wish to change is the length of the still.
495 Select the <guilabel>Timing</guilabel> tab and you will see a
496 <guilabel>Full length</guilabel> setting, as shown in <xref
497 linkend="fig-timing-tab"/>.
500 <figure id="fig-timing-tab">
501 <title>The timing tab</title>
504 <imagedata fileref="screenshots/timing-tab&scs;"/>
510 This length is a ‘timecode’: it consists of four numbers.
511 The first is hours, the second minutes, the third seconds, and the
512 fourth frames. Enter the duration that you want and then click <guilabel>Set</guilabel>.
516 Finally, as with video, you can choose <guilabel>Make DCP</guilabel>
517 from the <guilabel>Jobs</guilabel> menu to create your DCP. This will
518 be much quicker than creating a DCP from a video file, as DCP-o-matic only needs
519 to encode a single frame which it can then repeat.
525 <!-- ============================================================== -->
526 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" id="ch-manipulating-existing-dcps">
527 <title>Manipulating existing DCPs</title>
530 DCP-o-matic is often used to take content in formats such as MP4 and
531 make it into a DCP. It can also be used to take existing DCPs and
532 modify them in various ways.
536 <title>Importing a DCP into DCP-o-matic</title>
539 The first step in manipulating an existing DCP is to import it. Click
540 <guilabel>Add DCP...</guilabel> and select your DCP's folder. It will
541 be added to the DCP-o-matic project. If the DCP is unencrypted you
542 can preview it in the normal way, though playback will be slow as
543 decoding of DCPs is almost as computationally intensive as encoding
548 If your DCP is a Version File (VF) (i.e. it refers to
549 another DCP's assets) you should import it as follows:
553 <listitem>Use <guilabel>Add DCP...</guilabel> to import the VF DCP.
554 The VF DCP will be added to the content list and marked “NEEDS
555 OV”.</listitem>
556 <listitem>Right-click on the VF DCP in the content list and choose <guilabel>Add OV...</guilabel> from the menu.</listitem>
557 <listitem>Choose the folder that contains the OV DCP. The VF will now be playable as normal.</listitem>
563 <section xml:id="sec-decrypting">
564 <title>Decrypting encrypted DCPs</title>
567 DCPs can be encrypted (see <xref linkend="ch-encryption"/> for
568 details). If you import an encrypted DCP you will need a key, in the
569 form of a Key Delivery Message (KDM), to decrypt it.
573 KDMs must be prepared by the organisation which created the DCP. They
574 contain the keys to decrypt the DCP wrapped up in such a way that only
575 the intended recipient can read them. You will need to provide the
576 organisation with a certificate which identifies your copy of
577 DCP-o-matic and allows them to create a KDM for you.
581 To get DCP-o-matic's decryption certificate, open the Preferences
582 dialogue (see <xref linkend="ch-preferences"/>) and go to the
583 <guilabel>Keys</guilabel> tab. Click the <guilabel>Export DCP
584 decryption certificate...</guilabel> button at the bottom of this tab
585 and save the certificate. Send this certificate to the DCP creators
586 and they can create a KDM to allow DCP-o-matic to decrypt their DCP.
590 Once you have your KDM, right-click the DCP's name in DCP-o-matic and
591 choose <guilabel>Add KDM...</guilabel>. Specify your KDM and the DCP
592 will be decrypted and become available for preview.
599 <title>Making a DCP from a DCP</title>
602 In many ways, using DCPs as <emphasis>content</emphasis> in
603 DCP-o-matic is the same as using any other content. There are a few
604 things to note, though.
609 <title>Re-use of existing data</title>
612 Where possible DCP-o-matic will re-use existing JPEG2000-compressed
613 data from DCP content without modification. This has the advantage
614 that creation of the new DCP will be quick, as the time-consuming
615 JPEG2000 encoding is not necessary.
619 DCP-o-matic can do this if you <emphasis>avoid</emphasis> changes to
620 the following content settings:
624 <listitem>Crop</listitem>
625 <listitem>Scaling</listitem>
626 <listitem>Subtitle burn-in</listitem>
627 <listitem>Fades</listitem>
628 <listitem>Colour conversion</listitem>
632 DCP-o-matic will be forced to decode and re-encode your JPEG2000 data
633 if you change any of these settings on a piece of DCP content.
639 <section xml:id="sec-overlay">
640 <title>Making overlay files</title>
643 With its default settings, DCP-o-matic will take any data from DCP
644 content and copy it into the DCP that it creates. See <xref linkend="fig-dcp-copy"/>.
647 <figure id="fig-dcp-copy">
648 <title>Creating a new DCP by copying an existing one</title>
649 <mediaobject><imageobject><imagedata scale="100" fileref="diagrams/dcp-copy&dia;"/></imageobject></mediaobject>
653 This can be inefficient in some cases. Consider, for example, a film
654 which has ten different translations for which the subtitles are
655 different but video and audio are the same. If the video and audio
656 content takes up, say, 100Gb this means that the set of DCPs for every
657 translation would be about 1Tb with a lot of duplicated data.
661 The DCP format has a solution to this problem. One DCP can refer to
662 the ‘assets’ (picture, sound or subtitle) of another DCP.
663 For our translation example this means that we could have a
664 ‘base’ DCP (often called the OV or Original Version)
665 containing video, audio and one set of subtitles and then any number
666 of overlay DCPs (often called VF or Version Files) which refer to the
667 base version and replace the original subtitles with their own. <xref
668 linkend="fig-dcp-refer"/> shows this principle for one of our
669 translations. The DCP that we make refers to the original content
670 DCP's video and audio rather than containing a copy.
673 <figure id="fig-dcp-refer">
674 <title>Creating a new DCP by referring to an existing one</title>
675 <mediaobject><imageobject><imagedata scale="100" fileref="diagrams/dcp-refer&dia;"/></imageobject></mediaobject>
679 To play back the subtitled DCP the projectionist ingests both the base
680 (OV) DCP and the overlay (VF) DCP, then plays the VF one.
684 To make a DCP like this:
688 <listitem>Import your ‘Content DCP’ to a DCP-o-matic project.</listitem>
689 <listitem>Add whatever replacement you want in your new DCP (replacement subtitles or audio files, for example).</listitem>
690 <listitem>Select the DCP in the content list</listitem>
691 <listitem>Tick the <guilabel>Use's this DCP's ... as OV and make VF</guilabel> checkbox
692 in the tabs for the parts of the DCP that you want to refer to in your
693 new DCP. For example, to refer to the Content DCP's video and audio you would select the <guilabel>Video</guilabel> tab, click <guilabel>Use this DCP's video as OV and make VF</guilabel> then select the <guilabel>Audio</guilabel> tab and click <guilabel>Use this DCP's audio as OV and make VF</guilabel>.</listitem>
694 <listitem>Do <guilabel>Make DCP</guilabel> as usual and your VF DCP will be created.</listitem>
704 <!-- ============================================================== -->
707 <!-- ============================================================== -->
708 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
709 <title>Content settings</title>
712 The previous chapters showed DCP generation using the default
713 settings. DCP-o-matic offers a range of features to adjust the
714 content that goes into your DCP, and this chapter describes those
719 <title>Adding and removing content</title>
722 At the top of the <guilabel>Content</guilabel> tab is a list of the
723 content that will go into our DCP. There can be as many pieces of
724 content as you like, and they can be of the following types:
728 <listitem>Movie — a file containing some video, probably some
729 audio and possibly some embedded subtitles; for example, a MOV, MP4 or VOB.
732 <listitem>Sound — a file containing one or more channels of
733 audio; for example, a WAV or AIFF file.
736 <listitem>Still image — a file containing a single still image; for
737 example, a JPEG, PNG or TIFF file.
740 <listitem>Moving image — a directory containing many still
741 images which should be treated as the frames of a video.
744 <listitem>Subtitle — a file containing subtitle which will be
745 superimposed on the image of the DCP. These can be
746 <guilabel>.srt</guilabel>, <guilabel>.ssa</guilabel>, <guilabel>.ass</guilabel> or <guilabel>.xml</guilabel>
749 <listitem>DCP — an existing DCP.</listitem>
753 To add one or more movie, sound, still-image or subtitle files, select
754 <guilabel>Add file(s)...</guilabel> and choose them from the selector.
758 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 <xref linkend="tab-audio-file-naming"/>.
761 <table id="tab-audio-file-naming">
762 <title>Audio file naming</title>
763 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
767 <entry>Examples</entry>
768 <entry>Channel</entry>
773 <entry><code>L</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
774 <entry>film-L.wav my_movie_L_final.wav</entry>
778 <entry><code>R</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
779 <entry>film-R.wav my_movie_R_final.wav</entry>
783 <entry><code>C</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
784 <entry>film-C.wav my_movie_C_final.wav</entry>
785 <entry>Centre</entry>
788 <entry><code>Lfe</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
789 <entry>film-Lfe.wav my_movie_Lfe_final.wav</entry>
790 <entry>LFE (sub)</entry>
793 <entry><code>Ls</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
794 <entry>film-Ls.wav my_movie_Ls_final.wav</entry>
795 <entry>Left surround</entry>
798 <entry><code>Rs</code> surrounded by <code>.</code> <code>_</code> or <code>-</code></entry>
799 <entry>film-Rs.wav my_movie_Rs_final.wav</entry>
800 <entry>Right surround</entry>
807 To add a directory (folder) of images, choose <guilabel>Add
808 folder...</guilabel> and choose the directory from the selector.
809 DCP-o-matic will open a small dialogue box where you can enter the
810 frame rate that the image sequence should be run at.
814 To add a DCP, choose <guilabel>Add DCP...</guilabel> and choose the
815 DCP's directory from the selector.
819 You can remove a piece of content by clicking on its name and then
820 clicking the <guilabel>Remove</guilabel> button.
825 <!-- ============================================================== -->
827 <title>Adding existing DCPs</title>
829 <para>Adding existing DCPs to a DCP-o-matic film is a little different
830 to adding other types of content. Most content has to be converted to
831 JPEG2000, the compression scheme used by DCPs, which is a very
832 time-consuming process. Existing DCPs are already in JPEG2000 format
833 so do not require conversion. This means that, provided no settings
834 such as crop are used on the DCP content, picture and sound data will
835 be passed from existing to new DCP unaltered.
838 <para>Encrypted DCPs that are added as content will require a KDM
839 targeted at DCP-o-matic so that DCP-o-matic can decrypt them. You
840 should ask the creator of the imported DCP to provide a KDM for
841 DCP-o-matic's decryption certificate, which can be obtained by
842 clicking <guilabel>Export DCP decryption certificate...</guilabel>
843 from the <guilabel>Keys</guilabel> tab of the
844 <guilabel>Preferences</guilabel> dialog (see <xref
845 linkend="sec-prefs-keys"/>).
850 <!-- ============================================================== -->
852 <title>Content Properties</title>
855 Below the content list are the controls to set content properties. To
856 adjust the properties for a piece of content, click its name in the
857 content list. The content property controls will then become active
858 for that piece of content.
862 If you want to change the properties for multiple pieces of content at
863 the same time, select the content in the list by clicking the first
864 piece then clicking the other pieces with <keycap>shift</keycap> key
865 held down. Note that not all settings can be changed in this way.
869 The content properties are split up into four sections:
870 <guilabel>Video</guilabel>, <guilabel>Audio</guilabel>,
871 <guilabel>Timed text</guilabel> and <guilabel>Timing</guilabel>. Not
872 all of these sections will be active for all content types. The controls
873 in each section are described below.
879 <!-- ============================================================== -->
884 The <guilabel>Video</guilabel> tab controls properties of the image, as shown in <xref linkend="fig-video-tab"/>.
887 <figure id="fig-video-tab">
888 <title>Video settings tab</title>
891 <imagedata fileref="screenshots/video-tab&scs;"/>
897 <!-- ============================================================== -->
899 <title>Use this DCP's video as OV and make VF</title>
902 This option is only applicable if the selected content is an existing
903 DCP. It allows you make a VF DCP, using the video content from the
904 existing DCP by referencing it (rather than copying). See <xref
905 linkend="sec-overlay"/>.
910 <!-- ============================================================== -->
912 <title>Image type</title>
915 The next option on this tab is the ‘type’ of the video.
916 This specifies how DCP-o-matic should interpret the video's image.
917 <guilabel>2D</guilabel> is the default; this just takes the video
918 image as a standard 2D frame. The <guilabel>3D
919 left/right</guilabel> option tells DCP-o-matic to interpret the frame as a
920 left-right pair, as shown in <xref linkend="fig-3d-left-right"/>.
923 <figure id="fig-3d-left-right">
924 <title>3D left/right image type</title>
927 <imagedata scale="100" fileref="diagrams/3d-left-right&dia;"/>
933 Alternatively the <guilabel>3D top/bottom</guilabel> option tells
934 DCP-o-matic to see the frame as a top-bottom pair, as shown in <xref
935 linkend="fig-3d-top-bottom"/>.
938 <figure id="fig-3d-top-bottom">
939 <title>3D top/bottom image type</title>
942 <imagedata scale="100" fileref="diagrams/3d-top-bottom&dia;"/>
948 Another option is <guilabel>3D alternate</guilabel> which takes the
949 first frame of the content as for the left eye, the second for the
950 right eye, the third for the left, and so on. Finally, you can
951 specify <guilabel>3D left only</guilabel> or <guilabel>3D right
952 only</guilabel> if this content contains only the the left or right
953 eye images. This is useful when you have the left and right eye image
954 sets in different files; you can specify one content as <guilabel>3D
955 left only</guilabel> and another as <guilabel>3D right only</guilabel>
956 and DCP-o-matic will pick up the appropriate frames from each.
962 <!-- ============================================================== -->
964 <title>Filtering</title>
967 The ‘filters’ settings allow you to apply various video
968 filters to the image. These may be useful to try to improve
969 poor-quality sources like DVDs. You can set up the filters by clicking the
970 <guilabel>Edit</guilabel> button next to the filters entry in the
971 setup area of the DCP-o-matic window; this opens the filters selector
972 as shown in <xref linkend="fig-filters"/>.
975 <figure id="fig-filters">
976 <title>Filters selector</title>
979 <imagedata fileref="screenshots/filters&scs;"/>
985 After changing the filters setup, you will need to regenerate the DCP
986 to see the effect on the cinema screen. The preview in DCP-o-matic
987 will update itself whenever filters are changed, though of course this
988 image may be smaller and of lower resolution than a projected image!
994 <!-- ============================================================== -->
996 <title>Colour conversion</title>
999 The <guilabel>Colour conversion</guilabel> setting specifies what
1000 colour transforms and gamma correction DCP-o-matic will use when
1001 converting the selected content into the XYZ colourspace for the DCP.
1005 The easiest way to select the required conversion is to choose one of
1006 DCP-o-matic's presets. DCP-o-matic knows how to convert from four
1007 common colourspaces: sRGB, Rec. 601, Rec. 709 and P3. If you do not
1008 know which preset you should use, refer to the suggestions in <xref
1009 linkend="tab-colour-conversion"/>.
1012 <table id="tab-colour-conversion">
1013 <title>Suggested colour conversion settings</title>
1014 <tgroup cols='2' align='left' colsep='1' rowsep='1'>
1015 <colspec colwidth='1*'/>
1016 <colspec colwidth='5*'/>
1019 <entry>sRGB</entry><entry>Still images in RGB, e.g. photographs.</entry>
1022 <entry>Rec. 601</entry><entry>Standard-definition content (fewer than about 1000 pixels across) including DVD rips.</entry>
1025 <entry>Rec. 709</entry><entry>High-definition content including Blu-Ray rips.</entry>
1028 <entry>P3</entry><entry>Content explicitly graded to P3.</entry>
1035 For other required colour conversions, and if you know what you are
1036 doing, you can choose <guilabel>Custom</guilabel> which will open the full
1037 colour conversion editing dialogue box:
1040 <figure id="fig-colour-conversion">
1041 <title>Dialogue box for custom colour conversion</title>
1044 <imagedata fileref="screenshots/colour-conversion&scs;"/>
1050 Alternatively, choose <guilabel>None</guilabel> if your source files
1051 are already in the XYZ colour space and require no conversion.
1055 DCP-o-matic's colour conversion processes are discussed in much more
1056 detail in a separate document <ulink
1057 url="https://dcpomatic.com/manual/colour.pdf">colour.pdf</ulink>.
1062 <!-- ============================================================== -->
1064 <title>Other settings</title>
1067 The <guilabel>crop</guilabel> settings can be used to crop your
1068 content, which is often used to remove black borders from the edges of
1069 the image. The specified number of pixels will be trimmed from each
1070 edge, and the content image in the right of the window will be updated
1071 to show the effect of the crop.
1075 The <guilabel>fade in</guilabel> and <guilabel>fade out</guilabel>
1076 settings can be used to apply linear fades into and out of a piece of
1077 content. Specify the time for each, clicking <guilabel>Set</guilabel>
1078 after making any changes.
1082 The <guilabel>Scale to</guilabel> option governs the shape that
1083 DCP-o-matic will scale the content's image into. Select the aspect
1084 ratio that your content should be presented in.
1089 <!-- ============================================================== -->
1091 <title>Video description</title>
1094 At the bottom of the video tab is a short description of what will
1095 happen to your video with the current settings. In the example of
1096 <xref linkend="fig-video-tab"/>, DCP-o-matic is telling you that the
1097 video file is 2048x872 pixels and it has square pixels (a pixel
1098 aspect ratio of 1.00) hence its display aspect ratio is 2.35:1. Since
1099 the controls specify ‘2.35’ for the ratio, DCP-o-matic
1100 does not scale the image but pads it to the DCP's container ratio of
1101 1.85:1. For a 2K DCP this is 1998x1080 pixels.
1105 This description also gives the frame rate of the content and what
1106 will happen to it when it is played at the DCP's frame rate. See
1107 <xref linkend="ch-frame-rates"/> for details of DCP-o-matic's
1108 frame-rate conversion.
1116 <!-- ============================================================== -->
1118 <title>Audio</title>
1121 The <guilabel>Audio</guilabel> tab controls properties of the sound, as shown in <xref linkend="fig-audio-tab"/>.
1124 <figure id="fig-audio-tab">
1125 <title>Audio settings tab</title>
1128 <imagedata fileref="screenshots/audio-tab&scs;"/>
1133 <!-- ============================================================== -->
1135 <title>The audio map</title>
1138 The section at the bottom of the audio tab is the ‘audio
1139 map’. This governs how sound from the content will be arranged
1144 Down the left-hand side of the map is the list of audio channels in
1145 the currently-selected piece of content. These are labelled with two
1146 numbers; the first is the stream index within the content and the
1147 second is the channel number within that stream. Some content will
1148 have different streams for different languages or audio mixes. Along
1149 the top is each channel in the DCP. A green box means that the
1150 corresponding content channel will be copied into the corresponding
1155 When content channels are copied into DCP channels they can be done
1156 with variable gain. If, for example, you want to copy a channel
1157 as-is, you can set a gain of 0dB. Alternatively, if you want to mix
1158 two channels into one, you may want to use a gain of -6dB on each one
1159 to prevent clipping when the two channels are added.
1163 The green boxes of the audio mapping view tell you (very roughly) how
1164 much gain is applied to each channel. A full-height box means 0dB
1165 (i.e. unity) gain. Any less height indicates lower gain.
1169 To map one channel to another with 0dB gain, click in the empty box
1170 and it will turn green to reflect the mapping. A second click will
1171 turn the mapping back off. To set some other gain, right-click on the
1172 box to open the gain menu. This allows you to set
1173 <guilabel>Off</guilabel> (no mapping or negative infinity gain),
1174 <guilabel>Full</guilabel> (0dB gain), -6dB gain or
1175 <guilabel>Edit</guilabel> which allows you to set the required gain
1180 Consider, for example, the case in <xref linkend="fig-audio-map-eg1"/>.
1183 <figure id="fig-audio-map-eg1">
1184 <title>Audio map example 1</title>
1187 <imagedata fileref="screenshots/audio-map-eg1&scs;"/>
1193 Here, we have two channels in the source which are mapped to left and
1194 right, respectively, in the DCP. The full green boxes show that the
1195 mapping is at unity gain (0dB) in each case. Imagine that we modify
1196 the settings to those shown in <xref linkend="fig-audio-map-eg2"/>
1199 <figure id="fig-audio-map-eg2">
1200 <title>Audio map example 2</title>
1203 <imagedata fileref="screenshots/audio-map-eg2&scs;"/>
1209 We now have the content's streams mapped to left and right and also
1210 mixed together and placed in the DCP's centre channel. The smaller
1211 green boxes on the centre mappings show that those channels are added
1212 with some non-unity gain; you can see by hovering the mouse pointer
1213 over those boxes that the gain for content channels 1 and 2 is -6dB
1214 when being sent to the centre channel and 0dB when being sent to left
1218 <figure id="fig-audio-map-eg3">
1219 <title>Audio map example 3</title>
1222 <imagedata fileref="screenshots/audio-map-eg3&scs;"/>
1228 As a final example, the map in <xref linkend="fig-audio-map-eg3"/>
1229 shows the mapping of a 5.1 source into a 5.1 DCP.
1235 <!-- ============================================================== -->
1237 <title>Other controls</title>
1240 The <guilabel>Use this DCP's audio as OV and make VF</guilabel>
1241 checkbox is only applicable if the selected content is an existing
1242 DCP. It allows you to make a VF DCP, using the audio content from the
1243 existing DCP by referencing it (rather than copying). See <xref
1244 linkend="sec-overlay"/>.
1248 <guilabel>Show graphs of audio levels</guilabel> will analyse the
1249 audio of the selected content and plot it on a graph. See <xref
1250 linkend="sec-show-audio"/> for more details.
1254 ‘Audio Gain’ is used to alter the volume of the
1255 soundtrack. The specified gain (in dB) will be applied to each sound
1256 channel of your content before it is written to the DCP.
1260 If you use a sound processor that DCP-o-matic knows about, it can help
1261 you calculate changes in gain that you should apply. Say, for
1262 example, that you make a test DCP and find that you have to run it at
1263 volume 5 instead of volume 7 to get a good sound level in the screen.
1264 If this is the case, click the <guilabel>Calculate...</guilabel>
1265 button next to the audio gain entry, and the dialogue box in <xref
1266 linkend="fig-calculate-audio-gain"/> will open.
1269 <figure id="fig-calculate-audio-gain">
1270 <title>Calculating audio gain</title>
1273 <imagedata fileref="screenshots/calculate-audio-gain&scs;"/>
1279 For our example, put 5 in the first box and 7 in the second and click
1280 <guilabel>OK</guilabel>. DCP-o-matic will calculate the audio gain
1281 that it should apply to make this happen. Then you can re-make the
1282 DCP (this will be reasonably fast, as the video data will already have
1283 been done) and it should play back at the correct volume with 7 on
1284 your sound-rack fader.
1288 Current versions of DCP-o-matic only know about the Dolby CP650 and
1289 CP750. If you use a different sound processor, and know the gain
1290 curve of its volume control, <ulink url="mailto:carl@dcpomatic.com">get in
1295 <guilabel>Audio Delay</guilabel> is used to adjust the synchronisation
1296 between audio and video. A positive delay will move the audio later
1297 with respect to the video, and a negative delay will move it earlier.
1304 <!-- ============================================================== -->
1306 <title>Timed text (subtitles and closed captions)</title>
1309 The timed text tab contains settings related to subtitles and closed captions in your
1310 content, as shown in <xref linkend="fig-timed-text-tab"/>.
1313 <figure id="fig-timed-text-tab">
1314 <title>Timed text settings tab</title>
1317 <imagedata fileref="screenshots/timed-text-tab&scs;"/>
1323 Depending on where timed text comes from it can sometimes be used as
1324 either an open subtitle (to be overlaid onto the cinema screen and
1325 seen by everybody) or as a closed caption (to be displayed to
1326 individual viewers using a special system such as the Doremi
1331 DCP-o-matic can either:
1335 <listitem>Extract timed text that is embedded in video files, or</listitem>
1336 <listitem>Use timed text from SubRip (<code>.srt</code>), SubStation
1337 Alpha (<code>.ssa</code> or <code>.ass</code>) or DCP XML files. You may find the great
1339 url="http://www.nikse.dk/subtitleedit/">Subtitle Edit</ulink> useful
1340 for creating such files.</listitem>
1344 Embedded timed text is usually represented using a set of bitmaps,
1345 especially on files that have come from DVD or BluRay. Such text can
1346 be used as a subtitle, but not a closed caption (since the closed
1347 captioning system requires the text to be delivered as
1348 character codes rather than an image).
1351 <para>In contrast, SubRip, SubStation Alpha or DCP text can be used as either a subtitle or a closed caption.</para>
1354 With subtitles you have the further choice of whether to burn the
1355 subtitles into the image or include them as a separate subtitle
1356 ‘asset’ within your DCP (in which case the projector
1357 overlays them onto the image on playback). The difference between
1358 burn-in and overlay is illustrated by <xref linkend="fig-burn-in"/>
1359 and <xref linkend="fig-discrete"/>.
1362 <figure id="fig-burn-in">
1363 <title>Burnt-in subtitles</title>
1366 <imagedata scale="100" fileref="diagrams/burn-in&dia;"/>
1371 <figure id="fig-discrete">
1372 <title>Separate subtitles</title>
1375 <imagedata scale="100" fileref="diagrams/discrete&dia;"/>
1381 The advantage of separate subtitles is that the same video content can
1382 be used for DCPs in many different languages. This means that only a
1383 small text file needs to be changed for each target language, rather
1384 than a large video file. It also means that the time-consuming video
1385 encoding need only be done once for the project rather than once for
1390 Select the <guilabel>Use as</guilabel> check-box to enable the timed
1391 text in the selected content, then choose what you want to use the
1392 text for: open subtitles or closed captions.
1396 Select the <guilabel>Burn subtitles into image</guilabel> check-box to
1397 burn subtitles into the image; if this is not ticked the
1398 subtitles will be included separately in the DCP to be rendered by the
1403 The <guilabel>X Offset</guilabel> and <guilabel>Y Offset</guilabel>
1404 controls move subtitles around within the image. These controls have
1405 no effect for closed captions. The offsets are expressed as a
1406 percentage of the video frame size; 100% X offset is the entire width
1407 of the frame, and 100% Y offset is the entire height. Hence, to move
1408 the subtitles down by half the frame height you would use a Y offset
1413 The <guilabel>X Scale</guilabel> and <guilabel>Y Scale</guilabel>
1414 controls scale subtitles. These controls have no effect for closed
1415 captions. Scale values of 1 make the subtitles the same size
1416 (relative to the size of the image) as they are on the original.
1417 Values lower than 1 make them smaller, and values higher make them
1418 larger. You can stretch the subtitles in either direction by
1419 specifying different values for X and Y scale. Subtitles from DVD and
1420 Blu Ray sources are frequently larger (relative to the video frame)
1421 than those typically used for DCP, so it is often useful to scale such
1422 subtitles down using these controls.
1426 The <guilabel>Line spacing</guilabel> control adjusts the line spacing
1427 of the subtitles. This only works for subtitles that did not come from bitmaps.
1431 The <guilabel>Stream</guilabel> control changes the subtitle stream
1432 that is used when the content has more than one.
1436 If you are using non-image (text) subtitles or closed captions you can see the
1437 subtitle text and timings by clicking the <guilabel>View...</guilabel>
1438 button, or specify the fonts that should be used by clicking <guilabel>Fonts...</guilabel>.
1442 With any subtitles you can click <guilabel>Appearance...</guilabel> to
1443 change how the subtitles look. Some of the controls in the
1444 <guilabel>Appearance</guilabel> only apply to burnt-in subtitles, as
1445 only limited control is available for subtitles rendered by the
1452 <!-- ============================================================== -->
1454 <title>Timing</title>
1457 The timing tab contains settings related to the timing of your
1458 content, as shown in <xref linkend="fig-timing-tab-detail"/>.
1461 <figure id="fig-timing-tab-detail">
1462 <title>Timing settings tab</title>
1465 <imagedata fileref="screenshots/timing-tab&scs;"/>
1471 Most of the timing tab's entries are <emphasis>time-codes</emphasis>.
1472 These are expressed as four numbers, as shown in <xref
1473 linkend="fig-timecode"/>.
1476 <figure id="fig-timecode">
1477 <title>Timecode</title>
1480 <imagedata scale="100" fileref="diagrams/timecode&dia;"/>
1486 <guilabel>Position</guilabel> is the time at which this piece of
1487 content should start within the DCP. In most cases, this will be
1488 <code>0:0:0:0</code> to make the content start at the beginning of the
1493 <guilabel>Full length</guilabel> is the length of the piece of
1494 content. This can only be set for still-image content: for video or
1495 sound content, it is fixed by the nature of the content file. If
1496 still-image content is being used you can set the length for which it
1497 should be displayed using this control.
1501 <guilabel>Trim from start</guilabel> specifies the amount that should
1502 be trimmed from the start of the content. You can set this amount to
1503 trim up to the current preview position by clicking <guilabel>Trim up
1504 to current position</guilabel>.
1508 <guilabel>Trim from end</guilabel> specifies the amount that should be
1509 trimmed from the end of the content. You can set this amount to trim
1510 after the current preview position by clicking <guilabel>Trim after to
1511 current position</guilabel>.
1515 <guilabel>Play length</guilabel> indicates how long this piece of
1516 content will be once the trims have been applied. This will be equal
1517 to the full length minus <guilabel>trim-from-start</guilabel> and minus <guilabel>trim-from-end</guilabel>.
1521 <guilabel>Video frame rate</guilabel> specifies the frame rate for
1522 still-image content. It can also be used to override the detected
1523 frame rate of other content if DCP-o-matic has got it wrong.
1527 Each timecode control has a <guilabel>Set</guilabel> which you should
1528 click when you have entered a new value for a timecode. The
1529 <guilabel>Set</guilabel> button will make DCP-o-matic take account of
1530 any changes to the corresponding timecode.
1536 <!-- ============================================================== -->
1538 <title>Timeline</title>
1541 The timeline window gives an overview of all the pieces of content
1542 in your film, and how they are arranged. You can open the
1543 timeline by clicking the <guilabel>Timeline...</guilabel> button
1544 next to the content list. This will open a window like the one in <xref linkend="fig-timeline1"/>.
1547 <figure id="fig-timeline1">
1548 <title>Timeline</title>
1551 <imagedata fileref="screenshots/timeline1&scs;"/>
1557 The horizontal axis represents time, and you can see the time codes (in
1558 hours:minutes:seconds) along the bottom of the window. Pieces of
1559 content are represented with rectangles in the main part of the
1560 window. Content containing different types of data (e.g. a MP4
1561 file with video, audio and subtitles) have a rectangle for each
1566 Within the timeline you can select content by clicking, and drag
1567 it to change its position. Right-clicking a piece of content will
1568 open the content menu.
1572 The toolbar at the top of the window offers the following tools:
1576 <listitem>Select — to select and move content.</listitem>
1577 <listitem>Zoom in — to drag out an area that you want to see more closely.</listitem>
1578 <listitem>Zoom out — to zoom out so that the window shows the whole film.</listitem>
1579 <listitem>Snap — when enabled, content will snap to other content when you drag it close.</listitem>
1580 <listitem>Sequence — when enabled, content will be kept in sequence, without gaps, even if some content is removed.</listitem>
1584 <!-- ============================================================== -->
1586 <title>Video processing pipeline</title>
1589 This section gives a little more detail about how DCP-o-matic process
1590 video as it takes it from a source and puts it into a DCP.
1594 Consider, as a somewhat over-the-top example, that we have a 720 x 576
1595 image which is letterboxed with 36 black pixels each at the top and
1596 bottom, and the video content within the letterbox should be presented
1597 in the DCP at ratio of 2.39:1 within a 1.85:1 frame (such as might
1598 happen with a trailer). The source image is shown in <xref
1599 linkend="fig-pipeline1"/>.
1602 <figure id="fig-pipeline1">
1603 <title>Example image to demonstrate video processing</title>
1606 <imagedata scale="100" fileref="diagrams/pipeline1&dia;"/>
1612 DCP-o-matic runs through the following steps when preparing an image for a DCP:
1616 <listitem>Crop</listitem>
1617 <listitem>Scale</listitem>
1618 <listitem>Place in container</listitem>
1622 First, some amount of the image can be cropped. This is almost always
1623 used to remove black borders (letterboxing and/or pillarboxing) around
1628 In our example image, we would use 36 pixels of crop from the top and
1629 bottom. This would give the new image shown in <xref
1630 linkend="fig-pipeline2"/>.
1633 <figure id="fig-pipeline2">
1634 <title>Example image after cropping</title>
1637 <imagedata scale="100" fileref="diagrams/pipeline2&dia;"/>
1643 The next step is to scale the image. Since this content should be
1644 presented in a 2.39:1 (scope) aspect ratio inside a 1.85:1 (flat) DCP we would select
1645 <guilabel>Scope</guilabel> from the <guilabel>Scale to</guilabel>
1646 option in the <guilabel>Video</guilabel> tab and
1647 <guilabel>Flat</guilabel> from the <guilabel>Container</guilabel>
1648 option in the <guilabel>DCP</guilabel> tab.
1651 <para>The <guilabel>Scale to</guilabel> option should always be set to
1652 the aspect ratio at which the content should be seen. The
1653 <guilabel>Container</guilabel> option should be set to the preset that
1654 you want to use on the projector. Of course, these two settings will
1659 Given the scaling and container information, DCP-o-matic will look at
1660 the DCP's container size, and then scale the source image up until one
1661 or both of its dimensions (width, height or both) fits the size of the
1662 container, all the while preserving the desired aspect ratio.
1666 In our example here, the DCP's container is specified as 1.85:1 (so
1667 that the DCP will play back correctly using the projector's
1668 ‘Flat’ preset). At 2K, 1.85:1 is 1998 pixels by 1080.
1669 Scaling the source up whilst preserving its 1.85:1 aspect ratio will
1670 result in the image hitting the sides of the container first, at a
1671 size of 1998 x 836. This gives us a new version of the image as shown
1672 in <xref linkend="fig-pipeline3"/>.
1675 <figure id="fig-pipeline3">
1676 <title>Example image after cropping and scaling</title>
1679 <imagedata scale="100" fileref="diagrams/pipeline3&dia;"/>
1685 The final step is to place the image into the DCP. In this case,
1686 since we have a 2.39:1 image that should be presented as a 1.85:1 DCP,
1687 we have set the <guilabel>container</guilabel> in the
1688 <guilabel>DCP</guilabel> tab to be Scope. Since the content has been
1689 scaled to 1998 x 836, and a Flat container is 1998 x 1080, there will
1690 be some black bars at the top and bottom of the image. DCP-o-matic
1691 shares out this black equally, as shown in <xref
1692 linkend="fig-pipeline3"/>.
1695 <figure id="fig-pipeline4">
1696 <title>Example image in the DCP</title>
1699 <imagedata scale="100" fileref="diagrams/pipeline4&dia;"/>
1708 <title>Copy and paste settings</title>
1711 Once you have set up a piece of content it is possible to copy the
1712 settings you have applied to another piece of content. To do this,
1713 select the content to copy from and choose <guilabel>Copy</guilabel>
1714 from the <guilabel>Edit</guilabel> menu. Then select the content to
1715 copy to and choose <guilabel>Paste</guilabel>. A dialogue box will
1716 open to allow you to choose which settings you want to copy. Clicking
1717 <guilabel>OK</guilabel> will apply the copied settings.
1726 <!-- ============================================================== -->
1727 <chapter xml:id="ch-dcp" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
1728 <title>DCP settings</title>
1731 This chapter describes the settings that apply to the whole DCP. The
1732 controls for these settings are in the <guilabel>DCP</guilabel> tab of
1733 the main window, as shown in <xref linkend="fig-dcp-tab"/>.
1736 <figure id="fig-dcp-tab">
1737 <title>DCP settings tab</title>
1740 <imagedata fileref="screenshots/dcp-tab&scs;"/>
1746 The first thing here is the name. This is generally set to the title
1747 of the film that is being encoded. If <guilabel>Use ISDCF
1748 name</guilabel> is not ticked, the name that you specify will be used
1749 as-is for the name of the DCP. If <guilabel>Use ISDCF name</guilabel>
1750 is ticked, the name that you enter will be used as part of a
1751 ISDCF-compliant name.
1755 Underneath the name field is a preview of the name that the DCP will
1756 get. To use a ISDCF-compliant name, tick the <guilabel>Use ISDCF
1757 name</guilabel> check-box. The ISDCF name will be composed using details
1758 of your content's soundtrack, the current date and other things that
1759 can be specified in the ISDCF name details dialogue box, which you can
1760 open by clicking on the <guilabel>Details</guilabel> button.
1764 If you want to take the ISDCF-compliant name that DCP-o-matic
1765 generates and modify it, click <guilabel>Copy as name</guilabel> and
1766 the ISDCF name will be copied into the <guilabel>Name</guilabel> box.
1767 You can then edit it as you wish. The DCP name should not matter (in
1768 that it should not affect how the DCP ingests or plays) but
1769 projectionists will appreciate it if you use the standard naming
1770 scheme as it makes it easier to identify details of the content.
1774 The <guilabel>Content Type</guilabel> option can be
1775 ‘feature’, ‘trailer’ or whatever; select the
1776 required type from the drop-down list. On some projection systems
1777 this will affect where your content appears in the projector's server
1778 user interface, so take care to select an appropriate type.
1782 The <guilabel>Signed</guilabel> check-box sets whether or not the DCP
1783 is signed. This is rarely important; if in doubt, tick it.
1787 The <guilabel>Encrypted</guilabel> check-box will set whether the DCP
1788 should be encrypted or not. If this is ticked, the DCP will require a
1789 KDM to play back. Encryption is discussed in <xref
1790 linkend="ch-encryption"/>.
1794 If you use encryption DCP-o-matic will generate a random encryption
1795 key for you. To specify your own key, click the
1796 <guilabel>Edit..</guilabel> button next to the key.
1800 The <guilabel>Reels</guilabel> and <guilabel>Reel length</guilabel>
1801 controls specify how the DCP will be split up into
1802 ‘reels’. See <xref linkend="sec-reels"/>.
1806 The <guilabel>Standard</guilabel> option specifies which of the two
1807 DCP standards DCP-o-matic should use. If in doubt, use SMPTE (the
1808 more modern of the two).
1812 Ticking the <guilabel>Upload DCP to TMS after it is made</guilabel>
1813 will ask DCP-o-matic to copy the finished DCP to your configured TMS (see <xref linkend="sec-prefs-tms"/>).
1817 At the bottom of the DCP tab are a further two tabs, one each to
1818 contain the settings for the DCP's video and audio parts.
1822 The <guilabel>Container</guilabel> option sets the ratio of the image
1823 in the DCP. If this ratio is different to the ratio used for any
1824 content, DCP-o-matic will pad the content with black. In simple cases
1825 this should be set to the same ratio as that for the the primary piece
1826 of video content. Alternatively, you might want to pillarbox a small
1827 format into a Flat container: in this case, select the small format
1828 for the content's ratio and ‘Flat’ for the DCP.
1832 The <guilabel>Frame Rate</guilabel> control sets the frame rate of
1833 your DCP. This can be a little tricky to get right. Ideally, you
1834 want it to be the same as the video content that you are using. If it
1835 is not the same, DCP-o-matic must resort to some tricks to alter your
1836 content to fit the specified frame rate. Frame rates are discussed in
1837 more detail in <xref linkend="ch-frame-rates"/>.
1841 The <guilabel>Use best</guilabel> button sets the DCP video frame rate
1842 to what DCP-o-matic thinks is the best given the content that you have
1847 The <guilabel>3D</guilabel> button will set your DCP to 3D mode if it
1848 is checked. A 3D DCP will then be created, and any 2D content will be
1849 made 3D compatible by repeating the same frame for both left and right
1850 eyes. A 3D DCP can be played back on many 3D systems (e.g. Dolby 3D,
1851 Real-D etc.) but not on a 2D system.
1855 The <guilabel>Resolution</guilabel> tab allows you to choose the
1856 resolution for your DCP. Use 2K unless you have content that is of
1857 high enough resolution to be worth presenting in 4K.
1861 The <guilabel>JPEG2000 bandwidth</guilabel>; setting changes how big
1862 the final image files used within the DCP will be. Larger numbers
1863 will give better quality, but correspondingly larger DCPs. The
1864 bandwidth can be between 50 and 250 megabits per second (Mbit/s).
1865 Most commercial DCPs use bit rates between 75 and 125 Mbit/s.
1869 <guilabel>Re-encode JPEG2000 data from input</guilabel> governs
1870 whether or not JPEG2000-encoded data from a piece of content (usually
1871 a DCP) will be re-used in the output data as-is or whether it will be
1872 decoded and re-encoded by DCP-o-matic. If the option is enabled
1873 DCP-o-matic will decompress any JPEG2000 data it finds and re-encode
1874 it. This is useful if you want to reduce the bitrate of a DCP.
1875 Usually you will achieve better quality and quicker results by leaving
1876 this option switched off.
1880 The <guilabel>Audio Channels</guilabel> control sets the number of
1881 audio channels that the DCP will have. If the DCP has any channels
1882 for which there is no content audio they will be replaced by silence.
1883 You can only set an even number of channels here, since that is
1884 required by the DCI standard. If you want an odd number of channels,
1885 set the DCP channel count to one greater than you need and the
1886 unused channel will be filled with silence.
1890 The <guilabel>Processor</guilabel> control allows you to select a
1891 process to apply to the audio before it goes into the DCP. Three processes are currently provided:
1895 <listitem>Mid-side decode — this will take a L/R
1896 stereo input and extract the common part (corresponding to the
1897 ‘Mid’ in a mid-side signal) into the DCP's centre channel.
1898 The remaining L/R parts will be kept in the L/R channels of the DCP.
1899 This may be useful to make near-field L/R mixes more compatible with
1900 cinema audio systems.</listitem>
1901 <listitem>Stereo to 5.1 up-mixer A — this will take a stereo input and up-mix it to ‘fake’ 5.1. The input L/R are treated as follows:
1903 <listitem>DCP L is input L bandpass-filtered between 1.9kHz and 4.8kHz.</listitem>
1904 <listitem>DCP R is input R bandpass-filtered between 1.9kHz and 4.8kHz.</listitem>
1905 <listitem>DCP C is input L mixed with input R, taken down by 3dB and then bandpass-filtered between 150Hz and 1.9kHz.</listitem>
1906 <listitem>DCP Lfe is input L mixed with input R, taken down by 3dB and then bandpass-filtered between 20Hz and 150Hz.</listitem>
1907 <listitem>DCP Ls is input L bandpass-filtered between 4.8kHz and 20kHz.</listitem>
1908 <listitem>DCP Rs is input R bandpass-filtered between 4.8kHz and 20kHz.</listitem>
1911 This upmixing algorithm is due to Gérald Maruccia.
1914 <listitem>Stereo to 5.1 up-mixer B — this uses a different approach:
1916 <listitem>DCP L is input L.</listitem>
1917 <listitem>DCP R is input R.</listitem>
1918 <listitem>DCP C is input L + input R taken down by 3dB.</listitem>
1919 <listitem>DCP Lfe is DCP C bandpass filtered between 20Hz and 150Hz.</listitem>
1920 <listitem>DCP Ls and Rs are input L - input R with a 20ms delay.</listitem>
1925 The up-mixers are not particularly advanced and should be used with care. You are strongly advised to check how the DCPs sound in a cinema if you have used one of DCP-o-matic's upmixers.
1927 <!-- ============================================================== -->
1928 <section xml:id="sec-reels">
1929 <title>Reels</title>
1932 A ‘reel’ in a DCP is a subsection of the DCP, in the same
1933 way as a 35mm reel is a section of a film. A DCP can be split up into
1934 any number of reels and the joins (the equivalent to 35mm splices or changeovers)
1935 between the reels are seamless.
1939 There is no reason why you can't just use a single reel for the whole
1940 of your DCP, as there is no limit to their length. Many people choose
1945 There are, however, some possible advantages of splitting things up
1951 The picture, sound and subtitle data of the DCP will be
1952 split up into more smaller files on disk, rather than fewer larger
1953 files. This can be useful if the DCP is to be transferred on storage
1954 that have file size limits. The FAT32 filesystem, for example, can
1955 only hold files smaller than 4Gb. A 6Gb DCP with a single reel could
1956 not be transferred using a FAT32-formatted disk. If that DCP were
1957 split up into two 3Gb reels it could be transferred.
1960 It is easier to re-use DCP components if they are in reels. Consider,
1961 for example, a film company who wants to put a 5 second ident onto the
1962 beginning of DCPs that they distribute. If they receive a feature
1963 film DCP they can modify it to add their ident as a separate reel.
1964 This is easier than attaching the picture data to the feature's existing data.
1969 DCP-o-matic offers three options for setting up the reels in your DCP:
1970 <guilabel>single reel</guilabel>, <guilabel>split by video content</guilabel> or <guilabel>custom</guilabel>.
1974 <guilabel>Single reel</guilabel>, as its name suggests, keeps the whole DCP as one reel.
1975 This is a perfectly good option if you have no particular reason to
1980 <guilabel>Split by video content</guilabel> puts each piece of source
1981 video content in its own reel, as shown in <xref linkend="fig-reels-by-video"/>.
1984 <figure id="fig-reels-by-video">
1985 <title>Making reels using split by video content</title>
1986 <mediaobject><imageobject><imagedata scale="100" fileref="diagrams/reels-by-video&dia;"/></imageobject></mediaobject>
1990 Here we have three video files (<code>ident.mp4</code>,
1991 <code>feature.ts</code> and <code>cred.mov</code>). With
1992 <guilabel>split by video content</guilabel> DCP-o-matic makes a new
1993 reel to hold each video file.
1997 <guilabel>Custom</guilabel> splits reels by the size of the files that
1998 will make up their video content. With <guilabel>Custom</guilabel>
1999 you must specify a reel length in Gb. Then no file in the DCP will be larger than this reel length.
2005 <!-- ============================================================== -->
2006 <section xml:id="sec-show-audio">
2007 <title>Show audio</title>
2010 The <guilabel>Show Audio</guilabel> button will instruct DCP-o-matic
2011 to examine the audio in your content and plot a graph of its level
2012 over time. This can be useful for getting a rough idea of how loud
2013 the sound will be in the cinema auditorium. A typical plot is shown
2014 in <xref linkend="fig-audio-plot"/>
2017 <figure id="fig-audio-plot">
2018 <title>Audio plot</title>
2021 <imagedata fileref="screenshots/audio-plot&scs;"/>
2027 The plot gives the audio level (vertical axis, in dB) with time
2028 (horizontal axis). 0dB represents full scale, so if there is anything
2029 near this you are in danger of clipping the projector's audio outputs.
2033 There are two plot types: the peak level and the RMS, which can be
2034 shown or hidden using the check-boxes on the right hand side of the
2039 The channel check-boxes will show or hide the plot(s) for
2040 the corresponding channels in the DCP.
2044 The smoothing slider applies a variable degree of temporal smoothing
2045 to the plots, which can make them easier to read in some cases.
2049 Obviously the audio plot is no substitute for listening in an
2050 auditorium, but it can be useful to get levels in the right rough area.
2058 <!-- ============================================================== -->
2059 <chapter xml:id="ch-templates" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
2060 <title>Templates</title>
2063 If you frequently make DCPs with similar settings you may find it
2064 useful to use templates.
2068 Say, for example, you often make 4K feature DCPs from video files in
2069 ’scope at 25fps. You can speed up this process by following
2074 <listitem>Create a film with any content and set it up how you like;
2075 in our example, set the content to scale to DCP, the DCP resolution
2076 to 4K, and so on.</listitem>
2077 <listitem>Choose <guilabel>Save as template...</guilabel> from the <guilabel>File</guilabel> menu.</listitem>
2078 <listitem>Enter a name for your template.</listitem>
2082 Then in the future you can create a new film, tick the
2083 <guilabel>Template</guilabel> box and choose your previously-saved
2084 template. The basic film's settings will come from your template, and
2085 when you add some content it will take on the settings of the
2086 first similarly-typed piece of content in your template.
2090 For example, if the template has a piece of video content and some
2091 subtitles, any video that you add to the new film will take on the
2092 settings of the video in the template. Similarly, any subtitles that
2093 you add will take on the settings of the subtitles from the template.
2097 The following settings from the <guilabel>DCP</guilabel> tab are saved
2102 <listitem>“Use ISDCF name” checkbox</listitem>
2103 <listitem>Content type (FTR, TLR etc.)</listitem>
2104 <listitem>Container</listitem>
2105 <listitem>Resolution</listitem>
2106 <listitem>JPEG200 bandwidth</listitem>
2107 <listitem>Video frame rate</listitem>
2108 <listitem>Signed and encrypted checkboxes</listitem>
2109 <listitem>Audio channels</listitem>
2110 <listitem>Standard (Interop / SMPTE)</listitem>
2111 <listitem>Audio processor</listitem>
2112 <listitem>Reel type and length</listitem>
2113 <listitem>Upload after make DCP checkbox</listitem>
2117 In addition to this, the settings (but not the filenames) of any
2118 content in the template are stored, as discussed above. The status of
2119 the <guilabel>Keep video and subtitles in sequence</guilabel> checkbox
2120 from the timeline is also preserved.
2126 <!-- ============================================================== -->
2127 <chapter xml:id="ch-export" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
2128 <title>Export</title>
2131 As well as creating DCPs from the content you specify, DCP-o-matic
2132 can also export projects to ProRes and MP4 files. This is most
2133 often useful to convert DCPs to a file that is smaller and easier to play back.
2137 To convert a DCP to ProRes or MP4, the first step is start a new
2138 project and import the DCP (see <xref
2139 linkend="ch-manipulating-existing-dcps"/>). Then, choose
2140 <guilabel>Export...</guilabel> from the <guilabel>Jobs</guilabel>
2141 menu to open the export dialogue, as shown in <xref linkend="fig-export"/>.
2144 <figure id="fig-export">
2145 <title>Export dialogue</title>
2148 <imagedata fileref="screenshots/export&scs;"/>
2154 From this dialogue you can select the required output format,
2155 output file and, in the case of MP4, the quality of the output
2156 file. Higher quality files will, of course, be larger.
2160 You can also choose whether to mix down multichannel sources to stereo and whether you want to write separate reels to separate files.
2164 <!-- ============================================================== -->
2165 <chapter xml:id="ch-encryption" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
2166 <title>Encryption</title>
2169 DCP's do not have to be encrypted, but they can be. This
2170 chapter discusses the basic principles of DCP encryption, and how
2171 DCP-o-matic can create encrypted DCPs and KDMs for them.
2175 <!-- ============================================================== -->
2177 <title>Basics</title>
2180 DCPs can be encrypted. This means that the picture and sound data are
2181 encoded in such a way that only cinemas ‘approved’ by the
2182 DCP's creators can read them. In particular, this means copies of the
2183 DCP can be distributed by insecure means: if a bad person called
2184 Mallory obtains a hard drive containing an encrypted DCP, there is no
2185 way that he can play it. Only those cinemas who receive a correct key
2186 delivery message (KDM) can play the DCP.
2190 <!-- ============================================================== -->
2192 <title>How it works</title>
2195 This section attempts to summarise how DCP encryption works. You can
2196 skip it if you like. You may need some knowledge of encryption
2197 methods to understand it.
2201 We suppose that we are trying to send a DCP to
2202 Alice's cinema without a troublemaker called Mallory being able to
2207 There are two main families of encryption techniques. The first,
2208 symmetric-key encryption, allows us to encode some data using some
2209 numeric key. After encoding, no-one can decode the data unless they
2214 The first step in a DCP encryption is to encode its data with a random key
2215 using symmetric-key encryption. The encrypted DCP can then be sent
2216 anywhere, safe in the knowledge that even if Mallory got hold of a
2217 copy, he could not decrypt it.
2221 Alice, however, needs to know the key so she can play the DCP in her
2222 cinema. A simple approach might be for us to send Alice the key.
2223 However, if Mallory can intercept the DCP, he might also be able to
2224 intercept our communication of the key to Alice. Furthermore, if Alice
2225 happened to know Mallory, she could just send him a copy of the key.
2229 The clever bit in the process requires the use of public-key
2230 encryption. With this technique we can encrypt a block of data using
2231 some ‘public’ key. That data can then only be decrypted
2232 using a corresponding private key which is
2233 <emphasis>different</emphasis> to the public key. The private and
2234 public keys form a pair which are related mathematically, but it is
2235 extremely hard (or rather, virtually impossible) to derive the private
2236 key from the public key.
2240 Public-key encryption allows us to distribute the DCP's key to Alice
2241 securely. The manufacturer of Alice's projector generates a public
2242 and private key. They hide the private key inside the projector where
2243 no-one can read it. They then make the public key available to anyone
2248 DCP-o-matic has a similar arrangement except that it stores its
2249 private keys in the user's configuration file. See <xref
2250 linkend="sec-decrypting"/> for details of how to share DCP-o-matic's
2251 certificate so that others can make encrypted DCPs for DCP-o-matic.
2255 We take our DCP's symmetric key and encrypt it using the public key of
2256 Alice's projector. We send the result to Alice over email (using a
2257 format called a Key Delivery Message, or KDM). Her projector then
2258 decrypts our message using its private key, yielding the magic
2259 symmetric key which can decrypt the DCP.
2263 If is fine if Mallory intercepts our email to Alice, since the only
2264 key which can decrypt the message is the private key buried inside
2265 Alice's projector. The projector manufacturer is very careful that
2266 no-one ever finds out what this key is. Our DCP is secure: only Alice
2267 can play it back, since only her projector knows the key (even Alice
2275 <!-- ============================================================== -->
2277 <title>Encryption using DCP-o-matic</title>
2280 There are two steps to distributing an encrypted DCP. First, the
2281 DCP's data must be encrypted, and secondly KDMs must be generated for
2282 those cinemas that are allowed to play the DCP.
2286 The first part is simple: ticking the <guilabel>Encrypted</guilabel>
2287 box in the <guilabel>DCP</guilabel> tab will instruct DCP-o-matic to
2288 encrypt the DCP that it makes using a random key that DCP-o-matic
2289 generates. The key will be written to the film's metadata file, which
2290 should be kept secure.
2294 A DCP that is generated with the <guilabel>Encrypted</guilabel> box
2295 ticked will not play on any projector as-is (it will be marked as
2296 ‘locked’, or whatever the projector manufacturer's term
2301 The second part of distributions is to generate KDMs for the cinemas
2302 that you wish to allow to play your DCP. There are two approaches to
2303 this within DCP-o-matic: using the project, or using a DKDM. These
2304 approaches are now described in turn.
2308 <title>Creating KDMs from a DCP-o-matic project</title>
2311 You can create KDMs from inside a DCP-o-matic project using the
2312 <guilabel>Make KDMs</guilabel> option on the <guilabel>Jobs</guilabel>
2313 menu. This will open the KDM dialogue box, as shown in <xref
2314 linkend="fig-kdm"/>.
2317 <figure id="fig-kdm">
2318 <title>KDM dialog</title>
2321 <imagedata scale="35" fileref="screenshots/kdm&scs;"/>
2327 In order to generate KDMs for a particular projector, you need to know
2328 its <emphasis>certificate</emphasis>. These are usually made
2329 available by the projector manufacturers as text files with a
2330 <code>.pem</code> extension.
2334 DCP-o-matic can store these certificates along with details of their
2335 cinemas and screens within those cinemas. Each screen has a
2336 certificate for its projector (and optionally certificates for other
2337 trusted devices, such as the sound processor). DCP-o-matic can
2338 generate KDMs for any screens that it knows about.
2342 To add a cinema, click <guilabel>Add Cinema...</guilabel>. This opens
2343 a dialogue box into which you can enter the cinema's name, and
2344 optionally an email address. This email address can be used to
2345 get DCP-o-matic to deliver KDMs via email.
2349 Once you have added a cinema, select it by clicking on its name, then
2350 click <guilabel>Add Screen...</guilabel>. The resulting dialogue
2351 allows you to enter a name for the screen and load in its certificate
2352 from a file. The certificate should be in SHA256 PEM format.
2356 Alternatively, certificates for projection systems made by some
2357 manufacturers can be downloaded from databases provided by the
2358 manufacturer. Currently this is supported for Doremi, Dolby, Barco,
2359 Christie and GDC equipment (through downloading Barco, Christie or GDC
2360 certificates requires you to have an appropriate account set up in
2361 DCP-o-matic's preferences). If you are targeting a screen with
2362 equipment by one of these manufacturers you can click
2363 <guilabel>Download</guilabel> then enter the serial number of the
2364 server in the screen and click <guilabel>Download</guilabel> again
2365 and, all being well, the certificate will be fetched. Most cinema
2366 projection or technical departments will know these serial numbers.
2370 Note that the reliability of the manufacturers' certificate databases
2371 cannot be guaranteed. It is vital that KDMs are tested by the
2372 destination cinema will in advance of show time to identify any
2377 Once you have set up all the screens that you need KDMs for, select
2378 the CPL that you want to create the KDM for. You can use the
2379 drop-down list to select the CPLs in the current film project, or load
2380 a CPL from somewhere else. Select the cinemas and/or screens that you
2381 want KDMs for and fill in the start and end dates and times.
2385 You must also select the type of KDM that you want to generate. If in
2386 doubt, use <guilabel>Modified Transitional 1</guilabel>.
2390 The differences between the three KDM types are fairly subtle.
2391 <guilabel>DCI Specific</guilabel> and <guilabel>DCI Any</guilabel> add
2392 a <code><ContentAuthenticator></code> tag to the KDM which
2393 allows the exhibitor to check that the DCP and KDM have come from a
2394 bona-fide source. In addition, <guilabel>DCI Specific</guilabel> adds
2395 information on trusted devices to the KDM. This allows the KDM
2396 creator to specify devices (such as sound processors) that are allowed
2397 to use keys delivered by the KDM. At present it is not clear how
2398 widely the <guilabel>DCI Specific</guilabel> and <guilabel>DCI
2399 Any</guilabel> features are supported (or even tolerated) by servers
2400 so you are advised to use <guilabel>Modified Transitional
2405 Finally, choose what you want to do with the KDMs. They can be
2406 written to disk, to a location that you can specify by clicking
2407 <guilabel>Browse</guilabel>. Alternatively, if you choose
2408 <guilabel>Send by email</guilabel> the KDMs will be zipped up and
2409 emailed to the appropriate cinema email addresses. Click
2410 <guilabel>Make KDMs</guilabel> to generate the KDMs.
2416 <title>Creating KDMs using a DKDM</title>
2420 It can be inconvenient to need a whole DCP-o-matic project just to
2421 create KDMs for its film. Perhaps you want to archive the project to
2422 save space, or create KDMs on a different machine. In such situations
2423 it is easier to use a DKDM. This is a normal KDM, but instead of
2424 being targeted at a projection system (to allow it to decrypt the
2425 content) it is targeted at a particular user's certificate. This
2426 means that the certificate owner can create new KDMs for other users.
2427 The DKDM holds everything that is required to create further KDMs.
2431 Sometimes it is useful to create DKDMs that can be used by
2432 DCP-o-matic. If you create such a DKDM you can keep it and then, at
2433 any point in the future, use DCP-o-matic's standalone KDM creator to
2434 make KDMs for the DKDM's film for any cinema.
2438 In other cases a DKDM is sent to a 3rd party so that they can create
2439 KDMs for your films. This can be useful if, for example, you have a
2440 distributor who provides 24-hour KDM support to cinemas and can create
2441 KDMs for anybody that requires them at short notice.
2445 To create a DKDM for DCP-o-matic, open your encrypted project and
2446 select <guilabel>Make DKDM for DCP-o-matic...</guilabel> from the
2447 <guilabel>Jobs</guilabel> menu. Select the CPL that you want to make
2448 the DKDM for and click <guilabel>OK</guilabel>. This DKDM will then
2449 be available in the KDM creator. This is a separate program which you
2450 can start from the same place that you start the ‘normal’
2451 DCP-o-matic. Its window is shown in <xref linkend="fig-kdm-creator"/>.
2454 <figure id="fig-kdm-creator">
2455 <title>The KDM creator</title>
2458 <imagedata scale="30" fileref="screenshots/kdm-creator&scs;"/>
2464 To create KDMs, select the cinema(s) and/or screens that you want KDMs
2465 to be created for, the date range, the DCP that the KDMs are for and
2466 the destination for the KDMs and click <guilabel>Create
2471 By default the <guilabel>DKDM</guilabel> list will list any DCPs for
2472 which you have clicked <guilabel>Make DKDM for
2473 DCP-o-matic</guilabel> in the main DCP-o-matic program. If you have
2474 other DKDMs you can add them by clicking <guilabel>Add...</guilabel> and
2475 specifying the file containing the DKDM.
2479 If another organisation wants to send you a DKDM they will ask you for
2480 a target certificate. You can get DCP-o-matic's target certificate by
2481 opening <guilabel>Preferences</guilabel> and clicking <guilabel>Export
2482 DCP decryption certificate...</guilabel> in the <guilabel>Keys</guilabel>
2490 <title>Encryption keys</title>
2493 You must be careful when using encryption not to lose important keys.
2497 If you are making KDMs from a DCP-o-matic film you
2498 <emphasis>must</emphasis> ensure that you have a backup of the
2499 <code>metadata.xml</code> file from the project, as well as the DCP
2504 If you are using a DKDM you <emphasis>must</emphasis> ensure that you
2505 have a backup of DCP-o-matic's <code>config.xml</code> file, since it
2506 contains the only key which can decrypt the DKDM. The
2507 <code>config.xml</code> file location depends on your operating
2508 system; possible locations are listed in <xref linkend="ch-config"/>.
2514 <title>Should I encrypt?</title>
2517 The question of whether encryption is appropriate for a given
2518 project is a tricky one.
2522 On the one hand, if you distribute an unencrypted DCP it is easy for
2523 anybody to take it and do whatever they want with its contents.
2524 They could use DCP-o-matic to convert it to a MP4, show it in
2525 their cinema, or even edit and redistribute it in ways that you
2530 Encryption prevents this, but brings its own problems. It will be
2531 impossible for a cinema to screen your DCP unless they have the
2532 correct KDM. This is easy enough if things work as they should,
2533 but problems can occur. For example, cinemas may substitute
2534 broken playout servers with new ones without telling you: then the
2535 KDM that you sent them will be invalid, and a new one required.
2536 If the cinema can't get in touch with you, or somebody else who
2537 can create a new KDM, they can't screen your DCP. Often these
2538 problems are only discovered very close to showtime, with little
2543 If you are distributing encrypted DCPs widely it is worth thinking
2544 about who will make the KDMs, and who will provide quick-response
2545 technical support. It may be a good idea to engage a company who can
2546 provide such services.
2553 <title>Encryption overview</title>
2555 <figure id="fig-encryption-overview">
2556 <title>Overview of encryption</title>
2559 <imagedata fileref="diagrams/crypt&dia;"/>
2569 <!-- ============================================================== -->
2570 <chapter xml:id="ch-preferences" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
2571 <title>Preferences</title>
2574 DCP-o-matic provides preferences which can be used to modify its
2575 behaviour. They are described in this chapter.
2579 Preferences can be edited by choosing
2580 <guilabel>Preferences...</guilabel> from the <guilabel>Edit</guilabel>
2581 menu. This opens a dialogue which is split into eleven tabs.
2584 <!-- ============================================================== -->
2586 <title>General</title>
2589 The general tab is shown in <xref linkend="fig-prefs-general"/>.
2592 <figure id="fig-prefs-general">
2593 <title>General preferences</title>
2596 <imagedata fileref="screenshots/prefs-general&scs;"/>
2602 <!-- ============================================================== -->
2604 <title>Language</title>
2607 If you tick the <guilabel>Set Language</guilabel> checkbox and choose
2608 a language from the list, that language will be used for DCP-o-matic.
2609 You will need to restart DCP-o-matic to see the new language.
2613 The translations for DCP-o-matic have been contributed by helpful
2614 users. If your language is not on the last, head to <ulink
2615 url="https://dcpomatic.com/i18n.php">the DCP-o-matic website</ulink> to
2616 find out how to contribute a translation.
2621 <!-- ============================================================== -->
2623 <title>Interface complexity</title>
2626 Choose <guilabel>Simple</guilabel> to see a cut-down, simplified
2627 interface or <guilabel>Full</guilabel> to see DCP-o-matic's full
2633 <!-- ============================================================== -->
2635 <title>Number of threads DCP-o-matic should use</title>
2638 When DCP-o-matic is encoding DCPs it can use multiple parallel threads
2639 to speed things up. Set this value to the number of threads
2640 DCP-o-matic should use. This should normally be the number of
2641 processors (or processor cores) in your machine. DCP-o-matic will try
2642 to set this up correctly when you run it for the first time.
2648 <!-- ============================================================== -->
2650 <title>Number of threads DCP-o-matic encode server should use</title>
2653 This is the number of threads that the encode server should use when
2654 it is running and helping another copy of DCP-o-matic to speed up its
2661 <!-- ============================================================== -->
2663 <title>Configuration file</title>
2666 This is the location of DCP-o-matic's configuration file on disk. You
2667 can use this to share configuration between several copies of
2668 DCP-o-matic, across a network share, for instance.
2672 <!-- ============================================================== -->
2674 <title>Cinema and screen database file</title>
2677 This option allows you to change the file that DCP-o-matic uses to
2678 store details of the cinemas and screens used to make KDMs.
2683 <!-- ============================================================== -->
2685 <title>Play sound via</title>
2688 The checkbox to the left of <guilabel>Play sound</guilabel> enables or
2689 disables DCP-o-matic use of sound. On some machines there will be
2690 multiple options in the drop-down menu to decide how the sound should
2695 <!-- ============================================================== -->
2697 <title>Integrated loudness</title>
2700 If <guilabel>Find integrated loudness, true peak and loudness range
2701 when analysing audio</guilabel> is ticked, DCP-o-matic will do extra
2702 work when analysing audio. Leave this ticked if the extra parameters
2703 are useful to you. If not, untick it and audio analysis will be
2709 <!-- ============================================================== -->
2711 <title>Automatically analyse content audio</title>
2714 If this checkbox is ticked an audio analysis will be run whenever content is added that contains sound.
2718 <!-- ============================================================== -->
2720 <title>Updates</title>
2723 The <guilabel>Check for updates on startup</guilabel> option, if
2724 enabled, will tell DCP-o-matic to check on <ulink
2725 url="https://dcpomatic.com/">dcpomatic.com</ulink> to see if there any
2726 newer versions of DCP-o-matic then the one you are running. If so, a
2727 dialogue box will open with a link to download the new version.
2731 The <guilabel>Check for testing updates as well as stable
2732 ones</guilabel> option will also check for test updates as well as
2733 those that are formally ‘released’. This is useful if you
2734 like to live on the bleeding edge!
2738 <!-- ============================================================== -->
2740 <title>Issuer and creator</title>
2743 With these controls you can set the issuer and creator strings that
2744 will be put into the DCPs which you create.
2750 <!-- ============================================================== -->
2752 <title>Defaults</title>
2755 The defaults tab is shown in <xref linkend="fig-prefs-defaults"/>.
2758 <figure id="fig-prefs-defaults">
2759 <title>Defaults preferences</title>
2762 <imagedata fileref="screenshots/prefs-defaults&scs;"/>
2768 The options in this tab simply allow you to set up default values for
2769 various properties of new films.
2774 <!-- ============================================================== -->
2776 <title>Servers</title>
2779 The servers tab is shown in <xref linkend="fig-prefs-servers"/>.
2782 <figure id="fig-prefs-servers">
2783 <title>Servers preferences</title>
2786 <imagedata fileref="screenshots/prefs-servers&scs;"/>
2792 If <guilabel>Use all servers</guilabel> is ticked DCP-o-matic will
2793 locate encoding servers automatically (see <xref
2794 linkend="ch-servers"/>).
2798 Instead of this (or in addition) servers can be specified explicitly.
2799 To add a server, click <guilabel>Add...</guilabel> and enter the host
2800 name or IP address of the server to use.
2806 <!-- ============================================================== -->
2807 <section xml:id="sec-prefs-keys">
2811 The Keys tab (shown in <xref linkend="fig-prefs-keys"/>) has controls
2812 related to the keys and certificates used in some parts of DCP
2816 <figure id="fig-prefs-keys">
2817 <title>Keys preferences</title>
2820 <imagedata fileref="screenshots/prefs-keys&scs;"/>
2826 <guilabel>Export KDM decryption certificate...</guilabel> allows you
2827 to save the certificate that DCP-o-matic uses when decrypting KDMs
2828 that you give it. Use this option if somebody wants to make a KDM for
2829 you and asks for your certificate.
2833 <guilabel>Export all KDM decryption settings...</guilabel> exports a
2834 file which contains all the DCP-o-matic settings related to the use of
2835 KDMs supplied by other people. Use this button and <guilabel>Import
2836 all KDM decryption settings...</guilabel> to transfer settings between
2837 different copies of DCP-o-matic so that they can both use the same
2842 The two <guilabel>Advanced...</guilabel> buttons open advanced
2843 dialogue boxes for detailed manipulation of DCP-o-matic's certificate
2850 <title>Advanced keys settings</title>
2853 At the top of the <guilabel>Advanced</guilabel> dialogue for signing
2854 DCPs and KDMs is the chain of certificates that will be used to sign
2855 DCPs and KDMs. DCP-o-matic creates a random chain when you first run
2856 it and if you are happy to use this chain you can ignore the
2857 preferences. Otherwise, you can add or remove certificates from the
2858 chain using the <guilabel>Add...</guilabel> and
2859 <guilabel>Remove</guilabel> buttons.
2863 If you want DCP-o-matic to re-create the certificate chain (using new,
2864 random certificates) click <guilabel>Re-make
2865 certificates and key...</guilabel> and specify your organisation and common
2866 names in the dialogue box that opens.
2870 Underneath the certificate chain is the private key that corresponds
2871 to the leaf certificate in the chain. You can specify your own
2872 private key by clicking <guilabel>Import...</guilabel>. You must do
2873 this if you change the leaf certificate, so that the leaf private key
2874 corresponds to the public key held in the leaf certificate.
2878 At the top of the <guilabel>Advanced</guilabel> dialogue for decrypting DCPs is the chain and key which is used by
2879 DCP-o-matic when you import an encrypted DCP as a piece of content.
2880 The leaf certificate of this chain contains the public key that should
2881 be used when targeting a KDM at DCP-o-matic.
2885 Clicking <guilabel>Export chain...</guilabel> will
2886 export the whole certificate chain.
2891 <!-- ============================================================== -->
2892 <section xml:id="sec-prefs-tms">
2894 <titleabbrev xml:id="sec-prefs-tms-short">TMS preferences</titleabbrev>
2897 The TMS tab (shown in <xref linkend="fig-prefs-tms"/>) gives some
2898 options for specifying details about your theatre management system
2899 (TMS). If you do this, and your TMS accepts SSH or FTP connections,
2900 you can upload DCPs directly from DCP-o-matic to the TMS using the
2901 <guilabel>Send DCP to TMS</guilabel> option in the
2902 <guilabel>Jobs</guilabel> menu.
2905 <figure id="fig-prefs-tms">
2906 <title>TMS preferences</title>
2909 <imagedata fileref="screenshots/prefs-tms&scs;"/>
2915 <guilabel>Protocol</guilabel> should be set to SCP or FTP as
2916 appropriate for your TMS. We know that the Arts Alliance Media (AAM)
2917 and the Doremi ranges uses SCP connections, and that Dolby's TMSs use
2918 FTP. Do let us know if you use any other type of TMS with the
2919 <guilabel>Send DCP to TMS</guilabel> feature.
2923 <guilabel>TMS IP address</guilabel> should be set to the IP address of
2924 your TMS, <guilabel>TMS target path</guilabel> to the place that DCPs
2925 should be uploaded to (which will be relative to the home directory of
2926 the SSH or FTP user). Finally, the user name and password are the
2927 credentials required to log into the TMS via SSH or FTP.
2931 Note that for this to work on Doremi servers you will need to set the
2932 <code>PasswordAuthentication</code> option in your server's
2933 <code>sshd_config</code> to <code>yes</code>.
2939 <!-- ============================================================== -->
2941 <title>Email</title>
2944 The Email tab is shown in <xref linkend="fig-prefs-email"/>.
2947 <figure id="fig-prefs-email">
2948 <title>Email preferences</title>
2951 <imagedata fileref="screenshots/prefs-email&scs;"/>
2957 These settings are used when DCP-o-matic sends emails.
2961 <guilabel>Outgoing mail server</guilabel> 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. <guilabel>User name</guilabel> and <guilabel>Password</guilabel> are the credentials that are required to send email through the server you have specified.
2966 <!-- ============================================================== -->
2968 <title>KDM email</title>
2971 The KDM email tab is shown in <xref linkend="fig-prefs-kdm-email"/>.
2974 <figure id="fig-prefs-kdm-email">
2975 <title>KDM email preferences</title>
2978 <imagedata fileref="screenshots/prefs-kdm-email&scs;"/>
2984 This is a template for the email that is used to send KDMs out to
2985 cinemas. You can change it to say whatever you like. A few
2986 ‘magic’ strings will be replaced by information from the
2987 KDM that is being sent; these strings are shown in <xref linkend="tab-kdm-magic"/>.
2990 <table id="tab-kdm-magic">
2991 <title>‘Magic’ KDM strings</title>
2992 <tgroup cols='2' align='left' colsep='1' rowsep='1'>
2995 <entry><code>$CPL_NAME</code></entry><entry>DCP title</entry>
2998 <entry><code>$CINEMA_NAME</code></entry><entry>Cinema name</entry>
3001 <entry><code>$SCREENS</code></entry><entry>Name of screen or screens that KDMs are being generated for</entry>
3004 <entry><code>$START_TIME</code></entry><entry>The time from which the KDMs are valid</entry>
3007 <entry><code>$END_TIME</code></entry><entry>The time until which the KDMs are valid</entry>
3014 The <guilabel>Reset to default text</guilabel> will replace the current KDM email with DCP-o-matic's default.
3019 <!-- ============================================================== -->
3021 <title>Notifications</title>
3024 The Notifications tab is shown in <xref linkend="fig-prefs-notifications"/>.
3027 <figure id="fig-prefs-notifications">
3028 <title>Notifications preferences</title>
3031 <imagedata fileref="screenshots/prefs-notifications&scs;"/>
3037 DCP-o-matic can notify the user when jobs have completed. These
3038 notifications can be either or both of a message box on-screen (if
3039 <guilabel>Message box</guilabel> is ticked) and email (if
3040 <guilabel>Email</guilabel> is ticked). If you enable email
3041 notifications you can fill in the details of the emails you want to
3046 The bottom box in the tab is the contents of the email that should
3047 be sent. DCP-o-matic will replace the ‘magic’ strings
3048 <code>$JOB_NAME</code> and <code>$JOB_STATUS</code> in the with the
3049 details of the job that has completed.
3055 <!-- ============================================================== -->
3057 <title>Cover sheet</title>
3060 The DCP cover sheet configuration is shown in <xref linkend="fig-prefs-cover-sheet"/>.
3063 <figure id="fig-prefs-cover-sheet">
3064 <title>DCP cover sheet preferences</title>
3067 <imagedata fileref="screenshots/prefs-cover-sheet&scs;"/>
3073 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
3074 ‘magic’ strings will be replaced by information from the
3075 DCP that has been made:
3079 <title>‘Magic’ cover sheet strings</title>
3080 <tgroup cols='2' align='left' colsep='1' rowsep='1'>
3083 <entry><code>$CPL_NAME</code></entry><entry>DCP title</entry>
3086 <entry><code>$TYPE</code></entry><entry>DCP content type (e.g. feature, trailer...)</entry>
3089 <entry><code>$CONTAINER</code></entry><entry>The container ratio (e.g. flat, scope...)</entry>
3092 <entry><code>$AUDIO</code></entry><entry>Details of the audio channels</entry>
3095 <entry><code>$AUDIO_LANGUAGE</code></entry><entry>Audio language</entry>
3098 <entry><code>$SUBTITLE_LANGUAGE</code></entry><entry>Subtitle language</entry>
3101 <entry><code>$LENGTH</code></entry><entry>DCP length in hours, minutes and seconds</entry>
3104 <entry><code>$SIZE</code></entry><entry>DCP size in gigabytes</entry>
3111 The <guilabel>Reset to default text</guilabel> will replace the current cover sheet with DCP-o-matic's default.
3117 <!-- ============================================================== -->
3118 <section xml:id="sec-prefs-advanced">
3119 <title>Advanced</title>
3120 <titleabbrev xml:id="sec-prefs-advanced-short">Advanced preferences</titleabbrev>
3123 The advanced preferences are shown in <xref linkend="fig-prefs-advanced"/>.
3126 <figure id="fig-prefs-advanced">
3127 <title>Advanced preferences</title>
3130 <imagedata fileref="screenshots/prefs-advanced&scs;"/>
3136 <guilabel>Maximum JPEG2000 bandwidth</guilabel> specifies the maximum
3137 bit-rate of JPEG2000 that DCP-o-matic will allow you to create. You
3138 are advised to leave this at 250Mbit/s in normal use for maximum DCP
3143 <guilabel>Allow any DCP frame rate</guilabel> removes the limits on
3144 the DCP video frame rates that DCP-o-matic will create. This may be
3145 useful for experimentation. Again, you are strongly advised to leave
3146 this unticked for normal use.
3150 <guilabel>Only servers encode</guilabel> makes DCP-o-matic encode
3151 JPEG2000 data only on encoding servers and not on the host. We
3152 suggest you leave this unticked unless you have a good reason to do otherwise.
3156 With the filename format fields you can adjust the filenames that are
3157 used for metadata (CPL and PKL files) and assets (MXF and subtitle
3158 files). Below each field there is a list of the ‘magic’
3159 values that you can use in the format and an example of a filename
3160 that you might see with your current settings.
3164 The four checkboxes labelled <guilabel>Log</guilabel> control what
3165 sort of messages DCP-o-matic writes to its log file when creating a
3166 DCP. It is useful to leave <guilabel>General</guilabel>,
3167 <guilabel>Warnings</guilabel> and <guilabel>Errors</guilabel> ticked
3168 as this makes the log files useful for tracking down bugs.
3172 The <guilabel>Timing</guilabel> checkbox will enable extra log entries
3173 to allow developers to investigate and optimise the speed of
3174 DCP-o-matic. It will significantly increase the size of the log files
3175 that are generated, so in normal use it is best to leave this
3182 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" xml:id="ch-frame-rates">
3183 <title>Frame rates</title>
3186 In an ideal world, a DCP would be created using content at the same
3187 video frame and audio sampling rates as the DCP. This is not,
3188 however, always possible.
3192 <!-- ============================================================== -->
3194 <title>DCP frame rate limitations</title>
3197 There are some limitations to video and audio frame rates in DCPs. This is
3198 complicated by the fact that not all projectors will play DCPs at the
3199 same frame rates. It is possible to create a DCP which one projector will
3200 play fine, but another (of a different type) will refuse to play.
3204 <!-- ============================================================== -->
3206 <title>Guaranteed rates</title>
3209 The only rates that are guaranteed to work on all DCI projectors are
3210 24 frames per second (fps) for video and 48kHz for audio. If you are
3211 sending DCPs to unknown places it is wise to consider using these
3212 rates if at all possible.
3218 <!-- ============================================================== -->
3220 <title>Other often-supported rates</title>
3222 Many projectors now in the wild support additional video frame rates:
3223 25, 30, 48, 50 and 60 fps.
3228 <!-- ============================================================== -->
3230 <title>Adapting content to fit the DCP rate</title>
3233 DCP-o-matic has a few tricks to allow you to use content that is not
3234 in one of the ‘approved’ rates.
3238 Audio is easy: DCP-o-matic can resample to 48kHz from any source rate
3239 with minimal loss in quality.
3243 Video rate conversion is harder. DCP-o-matic's basic strategy to deal
3244 with a non-supported content rate is to run it at the wrong speed, and
3245 to adjust the audio to keep it in sync.
3248 <para>Let us consider the example of a 25fps source for which you want
3249 to create a 24fps DCP. DCP-o-matic will put the frames from the
3250 source directly into the DCP without modification, but will tell the
3251 projector to play them back at 24fps. This means that the DCP's video
3252 will run slightly slower than the original.
3256 If DCP-o-matic did nothing else, the result of this would be that the
3257 audio would be running at the original speed with the video running
3258 slowly. Hence the audio would drift slowly out of sync. To avoid
3259 this, DCP-o-matic also resamples the audio such that the projector
3260 will play it too slow by the same amount. Hence it will sound
3261 slightly different but will remain in sync with the video.
3265 For very low or high frame rates, DCP-o-matic can also skip or duplicate frames.
3272 <!-- ============================================================== -->
3274 <title>Setting up</title>
3277 The <guilabel>Frame Rate</guilabel> control in the
3278 <guilabel>DCP</guilabel> tab sets the video frame rate that the DCP
3279 will use. Clicking <guilabel>Use best</guilabel> sets the rate to
3280 what DCP-o-matic thinks is the best for your content. With this
3281 button, DCP-o-matic assumes that the most commonly-working frame rates (24,
3282 25 and 30fps) are allowed.
3286 After this, the <guilabel>Video</guilabel> tab for each piece of
3287 content will give a summary of what DCP-o-matic is doing with that
3292 If you want to experiment with other non-standard frame rates, you can
3293 do so by ticking the <guilabel>Allow any DCP frame rate</guilabel> in
3294 the <guilabel>Advanced</guilabel> tab of the preferences dialogue (see the
3295 <xref linkend="sec-prefs-advanced" endterm="sec-prefs-advanced-short"/>). You are strongly advised to
3296 use this only on your own equipment, and only for experimentation
3305 <!-- ============================================================== -->
3306 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" xml:id="ch-servers">
3307 <title>Encoding servers</title>
3310 One way to increase the speed of DCP encoding is to use more
3311 than one machine at the same time. An instance of DCP-o-matic can
3312 offload some of the time-consuming JPEG2000 encoding to any number of
3313 other machines on a network. To do this, one ‘master’
3314 machine runs DCP-o-matic, and the ‘server’ machines run
3315 a small program called <code>dcpomatic_server</code>.
3319 The master and server machines do not need to be the same type, so you
3320 can mix Windows PCs, Macs and Linux machines as you wish.
3324 <!-- ============================================================== -->
3326 <title>Running the servers</title>
3329 There are two options for the encoding server;
3330 <code>dcpomatic_server_cli</code>, which runs on the command line, and
3331 <code>dcpomatic_server</code>, which has a simple GUI. The command line
3332 version is well-suited to headless servers, especially on Linux, and
3333 the GUI version works best on Windows where it will put an icon in the
3338 To run the command line version, simply enter:
3342 dcpomatic2_server_cli
3346 at a command prompt. If you are running the program on a machine with
3347 a multi-core processor, you can run multiple parallel encoding threads
3348 by doing something like:
3352 dcpomatic2_server_cli -t 4
3356 to run 4 threads in parallel.
3360 To run the GUI version on windows, run the ‘DCP-o-matic encode
3361 server’ from the start menu. An icon will appear in the system
3362 tray; right-click it to open a menu from whence you can quit the
3363 server or open a window to show its status.
3366 <para>If you would rather not bother installing DCP-o-matic on your
3367 server computers, the other option is to use the live-CD
3368 image that you can download from the <ulink
3369 url="https://dcpomatic.com/">DCP-o-matic web site.</ulink></para>
3371 <para>Either burn the image to CD, or write it to a USB stick (using
3372 something like <ulink
3373 url="http://unetbootin.sourceforge.net/">unetbootin</ulink>). Boot a
3374 PC from the CD or USB stick and it becomes a DCP-o-matic server
3375 without touching your standard operating system install.
3380 <!-- ============================================================== -->
3382 <title>Setting up DCP-o-matic</title>
3385 DCP-o-matic periodically looks on the local network for servers. Any
3386 that it finds are given work to do during encodes. Selecting
3387 <guilabel>Encoding Servers</guilabel> from the
3388 <guilabel>Tools</guilabel> menu brings up a window which shows that
3389 servers that DCP-o-matic has found.
3394 <!-- ============================================================== -->
3396 <title>Some notes about encode servers</title>
3399 DCP-o-matic does not mind if servers come and go; if a server
3400 disappears, DCP-o-matic will stop sending work to it, and will check
3401 it every minute or so in case it has come back online.
3405 You will probably find that using a 1Gb/s or faster network will
3406 provide a significant speed-up compared to a 100Mb/s network.
3413 <chapter xml:id="ch-files" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
3414 <title>Generated files</title>
3417 DCP-o-matic generates a number of files as it makes a DCP. <xref
3418 linkend="fig-file-structure"/> shows the files that might be generated
3419 after you have created a DCP for a film called ‘DCP Test’.
3422 <figure id="fig-file-structure">
3423 <title>Creating a new film</title>
3426 <imagedata scale="100" fileref="diagrams/file-structure&dia;"/>
3432 The <code>DCP Test</code> folder is the one that you specify when you
3433 select the <guilabel>New Film</guilabel> option from DCP-o-matic's
3434 menu. Everything is stored inside this folder.
3438 DCP-o-matic generates some working files as it goes along. These are as follows:
3441 <listitem><code>log</code> is a list of notes that DCP-o-matic makes as it goes
3442 along. This can be useful for debugging purposes if something goes
3445 <listitem><code>metadata</code> stores the settings that you have made
3446 for this film: things like cropping, output format and so on.</listitem>
3448 <listitem><code>video</code> is where DCP-o-matic writes the DCP's
3449 video data as it encodes it.</listitem>
3451 <listitem><code>analysis</code> is used to keep the results of audio analysis runs.</listitem>
3453 <listitem><code>info</code> contains details of each video frame that
3454 DCP-o-matic has written so far. This is used when an encoding
3455 operation is interrupted and DCP-o-matic must resume it.</listitem>
3460 Following this is the DCP itself:
3461 <code>DCP-TEST_EN-XX_UK-U_51_2K_CSY_20130218_CSY_OV</code>. This
3462 contains some small XML files, which describe the DCP, and two large
3463 MXF files, which contain the DCP's audio and video data. It may also
3464 contain subtitles in either XML or MXF format. This folder
3465 (<code>DCP-TEST_EN-XX_...</code>) is what you should ingest, or pass
3466 to the cinema which is showing your DCP.
3473 <title>Command-line tools</title>
3476 DCP-o-matic includes some tools which allow DCP creation from the
3477 command line or from scripting languages. This chapter covers the
3482 There are three command-line tools in DCP-o-matic.
3483 <code>dcpomatic2_create</code> creates film directories, with the
3484 associated metadata, from a list of content files. Then
3485 <code>dcpomatic2_cli</code> runs the transcode process on these
3486 film directories. Finally, <code>dcpomatic2_kdm_cli</code> can be
3487 used to create KDMs.
3491 Some applications will benefit from setting up the films using the
3492 main DCP-o-matic GUI and then using <code>dcpomatic2_cli</code> to
3493 do the encode. This allows, for example, setup on a relatively
3494 low-powered machine before running the encode on a higher-powered
3499 <title><code>dcpomatic2_create</code></title>
3502 The syntax for <code>dcpomatic2_create</code> is:
3506 <code>dcpomatic2_create [OPTION] <CONTENT> [[OPTION] <CONTENT> ...]</code>
3510 <code>[CONTENT]</code> are the files or folders that you want to use in the
3513 <listitem>‘Movie’ files in almost any common format (e.g. MP4, MOV, MKV, etc.)</listitem>
3514 <listitem>A folder containing and image sequence in almost any common format (e.g. TIFF, DPX etc.)</listitem>
3515 <listitem>Sound files (e.g. WAV, MP3, AIFF)</listitem>
3516 <listitem>Subtitles files (e.g. <code>.srt</code>, DCP XML, <code>.ssa</code> etc.)</listitem>
3524 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dcpomatic_create.xml"/>
3527 For example, to setup a film using a MP4 file you might do:
3531 <code>dcpomatic2_create -o my_film --container-ratio 185 --content-ratio 185 -c FTR -n "My Film" Stuff.mp4</code>
3535 This will create a folder called <code>my_film</code> which is ready for a DCP to be made by <code>dcpomatic2_cli</code>.
3539 <code>dcpomatic2_create</code> will use any default settings that you have configured in the main DCP-o-matic preferences.
3544 <title><code>dcpomatic2_cli</code></title>
3547 The syntax for <code>dcpomatic2_cli</code> is:
3551 <code>dcpomatic2_cli [OPTION] [FILM]</code>
3554 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dcpomatic_cli.xml"/>
3557 For example, to encode a film called <code>my_film</code> you might do:
3561 <code>dcpomatic2_cli my_film</code>
3566 <title><code>dcpomatic2_kdm_cli</code></title>
3569 The syntax for <code>dcpomatic2_kdm_cli</code> is:
3573 <code>dcpomatic2_kdm_cli [OPTION] <FILM|CPL-ID></code>
3576 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dcpomatic_kdm_cli.xml"/>
3583 <!-- ============================================================== -->
3585 <title>Loose ends</title>
3588 This chapter collects a few notes on bits of DCP-o-matic that do not fit elsewhere in the manual.
3592 <!-- ============================================================== -->
3594 <title>Resuming encodes</title>
3597 If you cancel a DCP encoding run half-way through, or your computer
3598 crashes... fear not. DCP-o-matic takes care to ensure that, in most
3599 cases, it can resume encoding from where it left off. When you
3600 re-start a DCP creation, using the same settings are a previous run,
3601 DCP-o-matic will first check that the existing picture frames are
3602 correct, and then resume from where it left off. The checking of
3603 existing frames does take some time, but it is much faster than
3604 running a full re-encode.
3608 This resumption is achieved by writing a digest (hash) to disk for
3609 every image frame that is written. On resumption, the existing MXF
3610 file for image data is read and its contents checked against the
3618 <!-- ============================================================== -->
3619 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
3620 <title>Common tasks</title>
3623 This chapter describes how to carry out some commonly-required tasks
3624 with DCP-o-matic. The full details are elsewhere in the manual: here
3625 we just discuss different approaches to these tasks and how to carry
3630 <title>Adding subtitles to an existing DCP</title>
3633 You have three options:
3637 <listitem>Make a “Version File” (VF) DCP.</listitem>
3638 <listitem>Make a complete DCP with projector-added subtitles.</listitem>
3639 <listitem>Make a complete DCP with burnt-in subtitles.</listitem>
3643 Making a VF DCP is usually the best option. This will be a very small
3644 DCP which contains only the subtitles: it refers to your existing DCP
3645 for the picture and sound. The projectionist will ingest both the
3646 existing and VF DCPs and play back the VF. The advantages of this
3647 approach are that the VF is very quick to generate, and small in size,
3648 making it easy to distribute. This is especially useful if you have
3649 to make VF DCPs in many different languages.
3653 Making a complete DCP with projector-added subtitles gives you a new,
3654 single DCP which the projectionist can ingest and play. It will be
3655 the same size as your existing DCP, and fairly quick to create. This
3656 approach relies on the projector (or server) to create the subtitles
3657 and overlay them on the image, which mostly works well but is not
3658 100% reliable.
3662 Making a complete DCP with burnt-in subtitles gives you a new, single DCP
3663 but with the subtitles rendered by DCP-o-matic and copied into your
3664 image. This is slower to create than a DCP with projector-added
3665 subtitles as every video frame with a subtitle must be re-encoded.
3666 The advantage of this approach is that it is less likely to go wrong,
3667 especially if you are using unusual subtitle positioning or character
3672 <title>Making a VF DCP</title>
3675 <listitem>Start a new DCP-o-matic film.</listitem>
3676 <listitem>Click <guilabel>Add DCP...</guilabel> and specify your existing DCP's folder.</listitem>
3677 <listitem>Go to the <guilabel>DCP</guilabel> tab and choose <guilabel>Split by video content</guilabel> for <guilabel>Reel type</guilabel>.</listitem>
3678 <listitem>Go to the <guilabel>Video</guilabel> and
3679 <guilabel>Audio</guilabel> tabs in turn and tick the <guilabel>Use this DCP's audio as OV and make VF</guilabel> checkboxes.</listitem>
3680 <listitem>Add your subtitles to the film in whatever format you have.</listitem>
3681 <listitem>Check the subtitle appearance in the preview; it will be
3682 slow to respond as it is having to decompress images from the existing
3684 <listitem>Choose <guilabel>Make DCP</guilabel> from the menu.</listitem>
3690 <title>Making a complete DCP with projector-added subtitles</title>
3693 <listitem>Start a new DCP-o-matic film.</listitem>
3694 <listitem>Click <guilabel>Add DCP...</guilabel> and specify your existing DCP's folder.</listitem>
3695 <listitem>Add your subtitles to the film in whatever format you have.</listitem>
3696 <listitem>Check the subtitle appearance in the preview; it will be
3697 slow to respond as it is having to decompress images from the existing
3698 DCP. Adjust the appearance using controls in the
3699 <guilabel>Subtitle</guilabel> tab if required.</listitem>
3700 <listitem>Choose <guilabel>Make DCP</guilabel> from the menu.</listitem>
3706 <title>Making a complete DCP with burnt-in subtitles</title>
3709 <listitem>Start a new DCP-o-matic film.</listitem>
3710 <listitem>Click <guilabel>Add DCP...</guilabel> and specify your existing DCP's folder.</listitem>
3711 <listitem>Add your subtitles to the film in whatever format you have.</listitem>
3712 <listitem>Go to the <guilabel>Subtitle</guilabel> tab and tick the <guilabel>Burn subtitles into image</guilabel> checkbox.</listitem>
3713 <listitem>Check the subtitle appearance in the preview; it will be
3714 slow to respond as it is having to decompress images from the existing
3715 DCP. Adjust the appearance using controls in the
3716 <guilabel>Subtitle</guilabel> tab if required.</listitem>
3717 <listitem>Choose <guilabel>Make DCP</guilabel> from the menu.</listitem>
3724 <title>Adding soundtracks or subtitles in different languages</title>
3727 If you have a film that is to be dubbed or subtitled in several
3728 languages, the best approach with DCP-o-matic is as follows:
3732 <listitem>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).</listitem>
3733 <listitem>For each language, make a new Version File (VF) DCP which refers to the OV.</listitem>
3737 Once you have done this, you send the OV DCP to every cinema and then
3738 the appropriate VF to each cinema depending on what language they want
3739 to play the film in. The projectionist ingests both DCPs and then plays the VF.
3743 The advantage of this approach is that the VF DCPs are much smaller
3744 than the OV since they only have the language-specific parts. If you
3745 are just changing the subtitles you can often ship the OV by normal
3746 transport means (e.g. a hard drive or high-speed download) and send
3751 The full details of OV and VF files are discussed in <xref linkend="sec-overlay"/>. The steps can be summarised as follows:
3755 <listitem>Create a new DCP-o-matic project for the OV, as normal, adding video and perhaps sound. Make the DCP.</listitem>
3756 <listitem>Create a new DCP-o-matic project for the VF.</listitem>
3757 <listitem>Use <guilabel>Add folder...</guilabel> to add your OV DCP to the project.</listitem>
3758 <listitem>Select the video tab and tick <guilabel>Use this DCP's video as OV and make VF</guilabel> (you may need to select <guilabel>By video content</guilabel> for <guilabel>Reel type</guilabel> in the <guilabel>DCP</guilabel> tab).</listitem>
3759 <listitem>Do the same in the <guilabel>Audio</guilabel> tab if your OV has audio.</listitem>
3760 <listitem>Add your language-specific audio and/or subtitles and Make DCP.</listitem>
3767 <chapter xml:id="ch-player" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
3768 <title>Playing and verifying DCPs</title>
3770 <para>DCP-o-matic includes a DCP player, and although it requires a
3771 very high-speed CPU to play DCPs in full resolution, it can also
3772 play DCPs at reduced resolutions with slower CPUs.</para>
3774 <para>To use the player, start <guilabel>DCP-o-matic
3775 Player</guilabel>, and load a DCP using the
3776 <guilabel>Open</guilabel> option on the <guilabel>File</guilabel>
3779 <para>If you load a VF and/or encrypted DCP you can add your OV
3780 and/or KDM using the appropriate options on the
3781 <guilabel>File</guilabel> menu.</para>
3783 <para>During playback the <guilabel>Performance</guilabel> area at
3784 the bottom right of the window will give details of how many frames
3785 are being dropped; these are frames that were not decoded from the
3786 DCP quickly enough. If this number is high you can increase
3787 performance at the cost of rendering quality by choosing an option
3788 from the <guilabel>View</guilabel> menu. If you set the player to
3789 decode at less than full resolution the DCP's data will be decoded
3790 at this lower resolution, which is quicker than decoding at full
3795 The player also offers a simple DCP validator. To check a DCP,
3796 open it and then select <guilabel>Verify DCP</guilabel> from the
3797 <guilabel>Tools</guilabel> menu. This will run some basic checks to see if the DCP meets the required standards.
3802 <!-- ============================================================== -->
3803 <chapter xml:id="ch-config" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
3804 <title>Configuration files</title>
3806 <para>Most of DCP-o-matic's configuration is stored in an XML file called <code>config.xml</code>. This is stored in different places depending on your operating system:</para>
3809 <listitem>Windows: <code>c:\Users\your_user_name\AppData\Local\dcpomatic</code></listitem>
3810 <listitem>OS X: <code>/Users/your_user_Name/Library/Preferences/com.dcpomatic/2</code></listitem>
3811 <listitem>Linux: <code>~/.config/dcpomatic2</code></listitem>
3814 <para>Possible XML tags are as follows:</para>
3816 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="config.xml"/>
3822 <!-- LocalWords: dbcent DCP matic Hetherington DCPs KDMs GPL XP sid
3824 <!-- LocalWords: matic's jessie Tahr Xenial Xerus Centos Mageia GTK
3826 <!-- LocalWords: Karner FFmpeg libsndfile libsamplerate OpenSSL waf
3828 <!-- LocalWords: libopenjpeg libssh wxWidgets libxml xmlsec libzip
3830 <!-- LocalWords: asdcplib libdcp libsub libcxml sstream sudo Sintel
3832 <!-- LocalWords: dcpomatic TMS SCP timecode DCP's unencrypted OV Gb
3834 <!-- LocalWords: Decrypting KDM decrypt decrypted MOV VOB WAV AIFF
3836 <!-- LocalWords: PNG srt ssa xml wav Lfe XYZ colourspace sRGB RGB
3838 <!-- LocalWords: colourspaces pdf fader CP Doremi CaptiView SubRip
3840 <!-- LocalWords: SubStation BluRay
projects / dcpomatic.git / blob