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">
13 <!-- By good luck or good management, the scale parameter to imagedata
14 appears only to affect PDF output. HTML scaling is done in the
19 <title>DCP-o-matic users' manual</title>
20 <author><firstname>Carl</firstname><surname>Hetherington</surname></author>
23 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
24 <title>Introduction</title>
27 Hello, and welcome to DCP-o-matic!
30 <!-- ============================================================== -->
32 <title>What is DCP-o-matic?</title>
35 DCP-o-matic is a program to generate <ulink
36 url="http://en.wikipedia.org/wiki/Digital_Cinema_Package">Digital
37 Cinema Packages</ulink> (DCPs) from DVDs, Blu-Rays, video files such as MP4
38 and AVI, or still images. The resulting DCPs will play on modern digital
45 <!-- ============================================================== -->
47 <title>Licence</title>
50 DCP-o-matic is free and open-source and is licensed under the <ulink
51 url="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU
58 <!-- ============================================================== -->
60 <title>Acknowledgements</title>
63 This manual uses icons from the <ulink url="http://tango.freedesktop.org/">Tango Desktop Project</ulink>, with thanks.
70 <!-- ============================================================== -->
71 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
72 <title>Installation</title>
75 <!-- ============================================================== -->
77 <title>Windows</title>
80 To install DCP-o-matic on Windows, download the installer from
81 <ulink url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>
82 and double-click it. Click through the installer wizard, and
83 DCP-o-matic will be installed onto your machine.
87 If you are using a 32-bit version of Windows, you will need the 32-bit
88 installer. For 64-bit Windows, either installer will work, but I
89 suggest you used the 64-bit version as it will allow DCP-o-matic to
90 use more memory. You may find that DCP-o-matic crashes if you run
91 many parallel encoding threads (more than 4) on the 32-bit
98 <!-- ============================================================== -->
100 <title>Mac OS X</title>
103 DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and
104 higher. To install it, download the <code>.dmg</code> from <ulink
105 url="http://dcpomatic.com/">http://dcpomatic.com/</ulink> and double
106 click to open it. Then drag the DCP-o-matic icon to your
107 <guilabel>Applications</guilabel> folder or wherever else you would
114 <title>Ubuntu Linux</title>
117 You can install DCP-o-matic on Ubuntu 12.04 (‘Precise
118 Pangolin’), 14.04 (‘Trusty Tahr’) or 15.04
119 (‘Vivid Vervet’) using <code>.deb</code> packages:
120 download the appropriate package from <ulink
121 url="http://dcpomatic.com/">http://dcpomatic.com/</ulink> and
122 double-click it. Ubuntu will install the necessary bits and pieces
123 and set DCP-o-matic up for you.
129 <!-- ============================================================== -->
131 <title>Debian Linux</title>
133 Packages are available for Debian 7 (squeeze), 8 (jessie) and unstable (sid) from <ulink
134 url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>.
139 <!-- ============================================================== -->
141 <title>Centos Linux</title>
143 Packages are available for Centos 6.5 and 7 from <ulink
144 url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>.
149 <!-- ============================================================== -->
151 <title>Arch Linux</title>
153 Packages for Arch Linux are available from <ulink
154 url="https://aur.archlinux.org/packages/dcpomatic/">https://aur.archlinux.org/packages/dcpomatic/</ulink>,
155 thanks to Stefan Karner.
160 <!-- ============================================================== -->
162 <title>Other Linux distributions</title>
165 Installation on other Linux systems (for which no packages are
166 available) is quite hard; you will have to compile it from source. If
167 you are using distribution for which no packages are available, do let
168 me know by <ulink url="mailto:carl@dcpomatic.com">email</ulink> and I
169 will look into providing packages on the website.
173 The following dependencies are required:
175 <listitem><ulink url="http://ffmpeg.org/">FFmpeg</ulink></listitem>
176 <listitem><ulink url="http://www.mega-nerd.com/libsndfile/">libsndfile</ulink></listitem>
177 <listitem><ulink url="http://www.openssl.org/">OpenSSL</ulink></listitem>
178 <listitem><ulink url="http://www.openjpeg.org/">libopenjpeg</ulink></listitem>
179 <listitem><ulink url="http://www.imagemagick.org/script/index.php">ImageMagick</ulink></listitem>
180 <listitem><ulink url="http://www.boost.org/">Boost</ulink></listitem>
181 <listitem><ulink url="http://www.libssh.org/">libssh</ulink></listitem>
182 <listitem><ulink url="http://www.gtk.org/">GTK (on Linux)</ulink></listitem>
183 <listitem><ulink url="http://www.wxwidgets.org/">wxWidgets</ulink></listitem>
184 <listitem><ulink url="http://libxmlplusplus.sourceforge.net/">libxml++</ulink></listitem>
185 <listitem><ulink url="http://www.aleksey.com/xmlsec/">xmlsec</ulink></listitem>
186 <listitem><ulink url="http://curl.haxx.se/">curl</ulink></listitem>
187 <listitem><ulink url="http://www.nih.at/libzip/">libzip</ulink></listitem>
188 <listitem><ulink url="http://carlh.net/software/libdcp/">libdcp</ulink></listitem>
189 <listitem><ulink url="http://carlh.net/software/libcxml/">libcxml</ulink></listitem>
194 Once you have installed the development packages for the dependencies,
195 download the source code from <ulink
196 url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>,
197 unpack it and run the following commands from inside the source
208 With any luck, this will build and install DCP-o-matic on your system. To run it, enter:
223 <!-- ============================================================== -->
224 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
225 <title>Creating a video DCP</title>
228 In this chapter we will see how to create a video DCP using
229 DCP-o-matic. We will gloss over the details and look at the basics.
233 <title>Creating a new film</title>
236 Let's make a very simple DCP to see how DCP-o-matic works. First, we
237 need some content. Download the low-resolution trailer for the open
238 movie <ulink url="http://sintel.org/">Sintel</ulink> from <ulink
239 url="http://ftp.nluug.nl/ftp/graphics/blender/apricot/trailer/Sintel_Trailer1.480p.DivX_Plus_HD.mkv">their
240 website</ulink>. Generally, of course, one would want to use the
241 highest-resolution material available, but for this test we will use
242 the low-resolution version to save everyone's bandwidth bills.
246 Now, start DCP-o-matic and its window will open. First, we will
247 create a new ‘film’. A ‘film’ is how DCP-o-matic refers to
248 some pieces of content, along with some settings, which we will make into
249 a DCP. DCP-o-matic stores its data in a folder on your disk while it
250 creates the DCP. You can create a new film by selecting
251 <guilabel>New</guilabel> from the <guilabel>File</guilabel> menu, as
252 shown in <xref linkend="fig-file-new"/>.
255 <figure id="fig-file-new">
256 <title>Creating a new film</title>
259 <imagedata fileref="screenshots/file-new&scs;"/>
265 This will open a dialogue box for the new film, as shown in <xref
266 linkend="fig-video-new-film"/>.
269 <figure id="fig-video-new-film">
270 <title>Dialogue box for creating a new film</title>
273 <imagedata fileref="screenshots/video-new-film&scs;"/>
279 In this dialogue box you can choose a name for the film. This will be
280 used to name the folder to store its data in, and also as the initial
281 name for the DCP itself. You can also choose whereabouts you want to create
282 the film. In the example from the figure, DCP-o-matic will create a
283 folder called ‘DCP Test’ inside my home folder (carl) into which it
284 will write its working files.
290 <!-- ============================================================== -->
292 <title>Adding content</title>
295 The next step is to add the content that you want to use. DCP-o-matic
296 can make DCPs from multiple pieces of content, but in this simple
297 example we will just use a single piece. Click the <guilabel>Add
298 file(s)...</guilabel> button, as shown in <xref
299 linkend="fig-add-file"/>, and a file chooser will open for you to
300 select the content file to use, as shown in <xref
301 linkend="fig-video-select-content-file"/>.
304 <figure id="fig-add-file">
305 <title>Adding content files</title>
308 <imagedata fileref="screenshots/add-file&scs;"/>
313 <figure id="fig-video-select-content-file">
314 <title>Selecting a video content file</title>
317 <imagedata fileref="screenshots/video-select-content-file&scs;"/>
323 Select your content file and click <guilabel>Open</guilabel>. In this
324 case we are using the Sintel trailer that we downloaded earlier.
328 When you do this, DCP-o-matic will take a look at your file. After a
329 short while (when the progress bar at the bottom right of the window
330 has finished), you can look through your content using the slider to
331 the right of the window, as shown in <xref linkend="fig-examine-content"/>.
334 <figure id="fig-examine-content">
335 <title>Examining the content</title>
338 <imagedata fileref="screenshots/examine-content&scs;"/>
344 Dragging the slider will move through your video. You can also click
345 the <guilabel>Play</guilabel> button to play the content back. <emphasis>Note
346 that there will be no sound</emphasis>, and playback might not be entirely
347 accurate (it may be slightly slower or faster than it should be, for
348 example). This player is really only intended for brief inspection of
349 content; if you need to check it more thoroughly, use another player
351 url="http://projects.gnome.org/totem/index.html">Totem</ulink>, <ulink
352 url="http://www.mplayerhq.hu/design7/news.html">mplayer</ulink> or
353 <ulink url="http://www.videolan.org/vlc/index.html">VLC</ulink>.
361 <!-- ============================================================== -->
363 <title>Making the DCP</title>
365 <para>In most cases, some adjustments would be made to DCP-o-matic's
366 settings once the content has been added. For our simple test,
367 however, the default values will suffice, so we can go straight onto
368 making the DCP.</para>
371 Choose <guilabel>Make DCP</guilabel> from the
372 <guilabel>Jobs</guilabel> menu. DCP-o-matic will encode your DCP.
373 This may take some time (many hours in some cases). While the job is
374 in progress, DCP-o-matic will update you on how it is getting on with
375 the progress bar in the bottom of its window, as shown in <xref
376 linkend="fig-making-dcp"/>.
379 <figure id="fig-making-dcp">
380 <title>Making the DCP</title>
383 <imagedata scale="50" fileref="screenshots/making-dcp&scs;"/>
389 When it has finished, the DCP will end up on your disk inside the
390 film's folder. You can then copy this to a projector via a USB
391 stick, hard-drive or network connection. See <xref
392 linkend="ch-files"/> for details about the files that DCP-o-matic creates.
396 Alternatively, if you have a projector or Theatre Management System
397 (TMS) that is accessible via SCP across your network, you can upload
398 the content directly from DCP-o-matic. See the <xref
399 linkend="sec-prefs-tms" endterm="sec-prefs-tms-short"/> in <xref linkend="sec-prefs-tms"/>.
406 <!-- ============================================================== -->
407 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
408 <title>Creating a still-image DCP</title>
411 DCP-o-matic can also be used to create DCPs of one or more still images, perhaps
412 for an advertisement or an on-screen announcement. This chapter shows you
417 As with video DCPs, the first step is to create a new
418 ‘Film’; select <guilabel>New</guilabel> from the
419 <guilabel>File</guilabel> menu and the new film dialogue will open as
420 shown in <xref linkend="fig-still-new-film"/>.
423 <figure id="fig-still-new-film">
424 <title>Dialogue box for creating a new film</title>
427 <imagedata fileref="screenshots/still-new-film&scs;"/>
433 Enter a name and click <guilabel>OK</guilabel>. Now we need to add
434 the content. As before, click <guilabel>Add file(s)...</guilabel>.
435 For our example, we will add a single image file, as shown in <xref
436 linkend="fig-still-select-content-file"/>.
439 <figure id="fig-still-select-content-file">
440 <title>Selecting a still content file</title>
443 <imagedata fileref="screenshots/still-select-content-file&scs;"/>
449 As with video DCPs, most of the default settings will be fine for a
450 simple test. The one thing that you might wish to change is the
451 length of the still. Select the <guilabel>Timing</guilabel> tab and
452 you will see a <guilabel>Play length</guilabel> setting, as shown in <xref
453 linkend="fig-timing-tab"/>.
456 <figure id="fig-timing-tab">
457 <title>The timing tab</title>
460 <imagedata fileref="screenshots/timing-tab&scs;"/>
466 This length is a ‘timecode’: it consists of four numbers.
467 The first is hours, the second minutes, the third seconds, and the
468 fourth frames. Enter the duration that you want and then click <guilabel>Set</guilabel>.
472 Finally, as with video, you can choose <guilabel>Make DCP</guilabel>
473 from the <guilabel>Jobs</guilabel> menu to create your DCP. This will
474 be much quicker than creating a video DCP, as DCP-o-matic only needs
475 to encode a single frame which it can then repeat.
481 <!-- ============================================================== -->
482 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
483 <title>Content settings</title>
486 The previous chapters showed DCP generation using the default
487 settings. DCP-o-matic offers a range of features to adjust the
488 content that goes into your DCP, and this chapter describes those features in
493 <title>Adding and removing content</title>
496 At the top of the <guilabel>Content</guilabel> tab is a list of the
497 content that will go into our DCP. There can be as many pieces of
498 content as you like, and they can be of the following types:
502 <listitem>Movie — a file containing some video, probably some
503 audio and possibly some embedded subtitles; for example, a MOV, MP4 or VOB.
506 <listitem>Sound — a file containing one or more channels of
507 audio; for example, a WAV or AIFF file.
510 <listitem>Still image — a file containing a single still image; for
511 example, a JPEG, PNG or TIFF file.
514 <listitem>Moving image — a directory containing many still
515 images which should be treated as the frames of a video.
518 <listitem>Subtitle — a file containing subtitle which will be
519 superimposed on the image of the DCP. These can be
520 <guilabel>.srt</guilabel> or <guilabel>.xml</guilabel>
523 <listitem>DCP — an existing DCP.</listitem>
527 To add one or more movie, sound, still-image or subtitle files, select
528 <guilabel>Add file(s)...</guilabel> and choose them from the selector.
532 To add a directory (folder) of images or a DCP, choose <guilabel>Add
533 folder...</guilabel> and choose the directory from the selector. If
534 you select a folder of images DCP-o-matic will open a small dialogue
535 box where you can enter the frame rate that the image sequence should
540 You can remove a piece of content by clicking on its name and then
541 clicking the <guilabel>Remove</guilabel> button.
546 <!-- ============================================================== -->
548 <title>Adding existing DCPs</title>
550 <para>Adding existing DCPs to a DCP-o-matic film is a little different
551 to adding other types of content. Most content has to be converted to
552 JPEG2000, the compression scheme used by DCPs, which is a very
553 time-consuming process. Existing DCPs are already in JPEG2000 format
554 so do not require conversion. This means that, provided no settings
555 such as crop are used on the DCP content, picture and sound data will
556 be passed from existing to new DCP unaltered.
559 <para>Encrypted DCPs that are added as content will require a KDM
560 targeted at DCP-o-matic so that DCP-o-matic can decrypt them. You
561 should ask the creator of the imported DCP to provide a KDM for
562 DCP-o-matic's decryption certificate, which can be obtained by
563 clicking <guilabel>Export DCP decryption certificate...</guilabel>
564 from the <guilabel>Keys</guilabel> tab of the
565 <guilabel>Preferences</guilabel> dialog (see <xref
566 linkend="sec-prefs-keys"/>).
571 <!-- ============================================================== -->
573 <title>Content Properties</title>
576 Below the content list are the controls to set content properties. To
577 adjust the properties for a piece of content, click its name in the
578 content list. The content property controls will then become active
579 for that piece of content.
583 If you want to change the properties for multiple pieces of content at
584 the same time, select the content in the list by clicking the first
585 piece then clicking the other pieces with <keycap>shift</keycap> key
586 held down. Note that not all settings can be changed in this way.
590 The content properties are split up into four sections:
591 <guilabel>Video</guilabel>, <guilabel>Audio</guilabel>,
592 <guilabel>Subtitles</guilabel> and <guilabel>Timing</guilabel>. Not
593 all of these sections will be active for all content types. The controls
594 in each section are described below.
600 <!-- ============================================================== -->
605 The <guilabel>Video</guilabel> tab controls properties of the image, as shown in <xref linkend="fig-video-tab"/>.
608 <figure id="fig-video-tab">
609 <title>Video settings tab</title>
612 <imagedata fileref="screenshots/video-tab&scs;"/>
618 <!-- ============================================================== -->
620 <title>Image type</title>
623 The first option on this tab is the ‘type’ of the video.
624 This specifies how DCP-o-matic should interpret the video's image.
625 <guilabel>2D</guilabel> is the default; this just takes the video
626 image as a standard 2D frame. The <guilabel>3D
627 left/right</guilabel> option tells DCP-o-matic to interpret the frame as a
628 left-right pair, as shown in <xref linkend="fig-3d-left-right"/>.
631 <figure id="fig-3d-left-right">
632 <title>3D left/right image type</title>
635 <imagedata scale="100" fileref="diagrams/3d-left-right&dia;"/>
641 Alternatively the <guilabel>3D top/bottom</guilabel> option tells
642 DCP-o-matic to see the frame as a top-bottom pair, as shown in <xref
643 linkend="fig-3d-top-bottom"/>.
646 <figure id="fig-3d-top-bottom">
647 <title>3D top/bottom image type</title>
650 <imagedata scale="100" fileref="diagrams/3d-top-bottom&dia;"/>
656 Another option is <guilabel>3D alternate</guilabel> which takes the
657 first frame of the content as for the left eye, the second for the
658 right eye, the third for the left, and so on. Finally, you can
659 specify <guilabel>3D left only</guilabel> or <guilabel>3D right
660 only</guilabel> if this content contains only the the left or right
661 eye images. This is useful when you have the left and right eye image
662 sets in different files; you can specify one content as <guilabel>3D
663 left only</guilabel> and another as <guilabel>3D right only</guilabel>
664 and DCP-o-matic will pick up the appropriate frames from each.
670 <!-- ============================================================== -->
672 <title>Filtering</title>
675 The ‘filters’ settings allow you to apply various video
676 filters to the image. These may be useful to try to improve
677 poor-quality sources like DVDs. You can set up the filters by clicking the
678 <guilabel>Edit</guilabel> button next to the filters entry in the
679 setup area of the DCP-o-matic window; this opens the filters selector
680 as shown in <xref linkend="fig-filters"/>.
683 <figure id="fig-filters">
684 <title>Filters selector</title>
687 <imagedata fileref="screenshots/filters&scs;"/>
693 After changing the filters setup, you will need to regenerate the DCP
694 to see the effect on the cinema screen. The preview in DCP-o-matic
695 will update itself whenever filters are changed, though of course this
696 image is much smaller and of lower resolution than a projected image!
702 <!-- ============================================================== -->
704 <title>Colour conversion</title>
707 The <guilabel>Colour conversion</guilabel> setting specifies what
708 colour transforms and gamma correction DCP-o-matic will use when
709 converting the selected content into the XYZ colourspace for the DCP.
713 The easiest way to select the required conversion is to choose one of
714 DCP-o-matic's presets. DCP-o-matic knows how to convert from four
715 common colourspaces: sRGB, Rec. 601, Rec. 709 and P3. If you do not
716 know which preset you should use, refer to the suggestions in <xref
717 linkend="tab-colour-conversion"/>.
720 <table id="tab-colour-conversion">
721 <title>Suggested colour conversion settings</title>
722 <tgroup cols='2' align='left' colsep='1' rowsep='1'>
723 <colspec colwidth='1*'/>
724 <colspec colwidth='5*'/>
727 <entry>sRGB</entry><entry>Still images in RGB, e.g. photographs</entry>.
730 <entry>Rec. 601</entry><entry>Standard-definition content (fewer than about 1000 pixels across) including DVD rips.</entry>
733 <entry>Rec. 709</entry><entry>High-definition content including Blu-Ray rips.</entry>
736 <entry>P3</entry><entry>Content explicitly graded to P3.</entry>
743 For other required colour conversions, and if you know what you are
744 doing, you can choose <guilabel>Custom</guilabel> which will open the full
745 colour conversion editing dialogue box:
748 <figure id="fig-colour-conversion">
749 <title>Dialogue box for custom colour conversion</title>
752 <imagedata fileref="screenshots/colour-conversion&scs;"/>
758 Alternatively, choose <guilabel>None</guilabel> if your source files
759 are already in the XYZ colour space and require no conversion.
763 DCP-o-matic's colour conversion processes are discussed in much more
764 detail in a separate document <ulink
765 url="http://dcpomatic.com/manual/colour.pdf">colour.pdf</ulink>.
770 <!-- ============================================================== -->
772 <title>Other settings</title>
775 The <guilabel>crop</guilabel> settings can be used to crop your content,
776 which can be used to remove black borders from round the edges of DVD
777 images, for example. The specified number of pixels will be trimmed
778 from each edge, and the content image in the right of the window will
779 be updated to show the effect of the crop.
783 The <guilabel>fade in</guilabel> and <guilabel>fade out</guilabel>
784 settings can be used to apply linear fades into and out of a piece of
785 content. Specify the time for each, clicking <guilabel>Set</guilabel>
786 after making any changes.
790 The <guilabel>Scale to</guilabel> option governs the shape that
791 DCP-o-matic will scale the content's image into. Select the aspect
792 ratio that your content should be presented in.
797 <!-- ============================================================== -->
799 <title>Video description</title>
802 At the bottom of the video tab is a short description of what will
803 happen to your video with the current settings. In the example of
804 <xref linkend="fig-video-tab"/>, DCP-o-matic is telling you that the
805 video file is 1920x1080 pixels and it has square pixels (a pixel
806 aspect ratio of 1.00) hence its display aspect ratio is 1.78:1. Since
807 the controls specify ‘16.9’ for the ratio, DCP-o-matic
808 does not scale the image but pads it to the DCP's container ratio of
809 1.85:1. For a 2K DCP this is 1998x1080 pixels.
813 This description also gives the frame rate of the content and what
814 will happen to it when it is played at the DCP's frame rate. See
815 <xref linkend="ch-frame-rates"/> for details of DCP-o-matic's
816 frame-rate conversion.
824 <!-- ============================================================== -->
829 The <guilabel>Audio</guilabel> tab controls properties of the image, as shown in <xref linkend="fig-audio-tab"/>.
832 <figure id="fig-audio-tab">
833 <title>Audio settings tab</title>
836 <imagedata fileref="screenshots/audio-tab&scs;"/>
842 <!-- ============================================================== -->
844 <title>The audio map</title>
847 The section at the bottom of the audio tab is the ‘audio
848 map’. This governs how sound from the content will be arranged
853 Down the left-hand side of the map is the list of audio channels in
854 the currently-selected piece of content. These are labelled with two
855 numbers; the first is the stream index within the content and the
856 second is the channel number within that stream. Some content will
857 have different streams for different languages or audio mixes. Along
858 the top is each channel in the DCP. A green box means that the
859 corresponding content channel will be copied into the corresponding
864 When content channels are copied into DCP channels they can be done
865 with variable gain. If, for example, you want to copy a channel
866 as-is, you can set a gain of 0dB. Alternatively, if you want to mix
867 two channels into one, you may want to use a gain of -6dB on each one
868 to prevent clipping when the two channels are added.
872 The green boxes of the audio mapping view tell you (very roughly) how
873 much gain is applied to each channel. A full-height box means 0dB
874 (i.e. unity) gain. Any less height indicates lower gain.
878 To map one channel to another with 0dB gain, click in the empty box
879 and it will turn green to reflect the mapping. A second click will
880 turn the mapping back off. To set some other gain, right-click on the
881 box to open the gain menu. This allows you to set
882 <guilabel>Off</guilabel> (no mapping or negative infinity gain),
883 <guilabel>Full</guilabel> (0dB gain), -6dB gain or
884 <guilabel>Edit</guilabel> which allows you to set the required gain
889 Consider, for example, the case in <xref linkend="fig-audio-map-eg1"/>.
892 <figure id="fig-audio-map-eg1">
893 <title>Audio map example 1</title>
896 <imagedata fileref="screenshots/audio-map-eg1&scs;"/>
902 Here, we have two channels in the source which are mapped to left and
903 right, respectively, in the DCP. The full green boxes show that the
904 mapping is at unity gain (0dB) in each case. Imagine that we modify
905 the settings to those shown in <xref linkend="fig-audio-map-eg2"/>
908 <figure id="fig-audio-map-eg2">
909 <title>Audio map example 2</title>
912 <imagedata fileref="screenshots/audio-map-eg2&scs;"/>
918 We now have the content's streams mapped to left and right and also
919 mixed together and placed in the DCP's centre channel. The smaller
920 green boxes on the centre mappings show that those channels are added
921 with some non-unity gain; you can see by hovering the mouse pointer
922 over those boxes that the gain for content channels 1 and 2 is -6dB
923 when being sent to the centre channel and 0dB when being sent to left
927 <figure id="fig-audio-map-eg3">
928 <title>Audio map example 3</title>
931 <imagedata fileref="screenshots/audio-map-eg3&scs;"/>
937 As a final example, the map in <xref linkend="fig-audio-map-eg3"/>
938 shows the mapping of a 5.1 source into a 5.1 DCP.
944 <!-- ============================================================== -->
946 <title>Other controls</title>
949 ‘Audio Gain’ is used to alter the volume of the
950 soundtrack. The specified gain (in dB) will be applied to each sound
951 channel of your content before it is written to the DCP.
955 If you use a sound processor that DCP-o-matic knows about, it can help
956 you calculate changes in gain that you should apply. Say, for
957 example, that you make a test DCP and find that you have to run it at
958 volume 5 instead of volume 7 to get a good sound level in the screen.
959 If this is the case, click the <guilabel>Calculate...</guilabel>
960 button next to the audio gain entry, and the dialogue box in <xref
961 linkend="fig-calculate-audio-gain"/> will open.
964 <figure id="fig-calculate-audio-gain">
965 <title>Calculating audio gain</title>
968 <imagedata fileref="screenshots/calculate-audio-gain&scs;"/>
974 For our example, put 5 in the first box and 7 in the second and click
975 <guilabel>OK</guilabel>. DCP-o-matic will calculate the audio gain
976 that it should apply to make this happen. Then you can re-make the
977 DCP (this will be reasonably fast, as the video data will already have
978 been done) and it should play back at the correct volume with 7 on
979 your sound-rack fader.
983 Current versions of DCP-o-matic only know about the Dolby CP650 and
984 CP750. If you use a different sound processor, and know the gain
985 curve of its volume control, <ulink url="mailto:carl@dcpomatic.com">get in
990 <guilabel>Audio Delay</guilabel> is used to adjust the synchronisation
991 between audio and video. A positive delay will move the audio later
992 with respect to the video, and a negative delay will move it earlier.
999 <!-- ============================================================== -->
1001 <title>Subtitles</title>
1004 The subtitles tab contains settings related to subtitles in your
1005 content, as shown in <xref linkend="fig-subtitles-tab"/>.
1008 <figure id="fig-subtitles-tab">
1009 <title>Subtitle settings tab</title>
1012 <imagedata fileref="screenshots/subtitles-tab&scs;"/>
1018 DCP-o-matic will extract subtitles from the content, if present, and
1019 they can be ‘burnt into’ the DCP (that is, they are
1020 included in the image and not overlaid by the projector) or included
1021 as a separate subtitle ‘asset’ within your DCP (in which
1022 case the projector overlays them onto the image on playback). The
1023 difference between these two arrangements is illustrated by <xref
1024 linkend="fig-burn-in"/> and <xref linkend="fig-discrete"/>
1027 <figure id="fig-burn-in">
1028 <title>Burnt-in subtitles</title>
1031 <imagedata scale="80" fileref="diagrams/burn-in&dia;"/>
1036 <figure id="fig-discrete">
1037 <title>Separate subtitles</title>
1040 <imagedata scale="80" fileref="diagrams/discrete&dia;"/>
1046 The advantage of separate subtitles is that the same video content can
1047 be used for DCPs in many different languages. This means that only a
1048 small text file needs to be changed for each target language, rather
1049 than a large video file. It also means that the time-consuming video
1050 encoding need only be done once for the project rather than once for
1055 Note that subtitles come in two types: text and bitmap. Text
1056 subtitles are expressed as plain text and can be either burnt into the
1057 image or included as a separate subtitle asset within the DCP. Bitmap
1058 subtitles, on the other hand, are expressed as pre-rendered bitmaps.
1059 They cannot (yet) be added to the DCP as a separate asset and must be
1060 burnt into the image.
1064 Select the <guilabel>With Subtitles</guilabel> check-box to enable
1069 The <guilabel>X Offset</guilabel> and <guilabel>Y Offset</guilabel>
1070 controls move the subtitles around within the image. The offsets are
1071 expressed as a percentage of the video frame size; 100% X offset is
1072 the entire width of the frame, and 100% Y offset is the entire height.
1073 Hence, to move the subtitles down by half the frame height you would
1074 use a Y offset of 50%.
1078 The <guilabel>X Scale</guilabel> and <guilabel>Y Scale</guilabel>
1079 controls scale the subtitles. Scale values of 1 make the subtitles
1080 the same size (relative to the size of the image) as they are on the
1081 original. Values lower than 1 make them smaller, and values higher
1082 make them larger. You can stretch the subtitles in either direction
1083 by specifying different values for X and Y scale. Subtitles from DVD
1084 and Blu Ray sources are frequently larger (relative to the video
1085 frame) than those typically used for DCP, so it is often useful to
1086 scale such subtitles down using these controls.
1090 The <guilabel>Stream</guilabel> control changes the subtitle stream
1091 that is used when the content has more than one.
1097 <!-- ============================================================== -->
1099 <title>Timing</title>
1102 The timing tab contains settings related to the timing of your
1103 content, as shown in <xref linkend="fig-timing-tab-detail"/>.
1106 <figure id="fig-timing-tab-detail">
1107 <title>Timing settings tab</title>
1110 <imagedata fileref="screenshots/timing-tab&scs;"/>
1116 Most of the timing tab's entries are <emphasis>time-codes</emphasis>.
1117 These are expressed as four numbers, as shown in <xref
1118 linkend="fig-timecode"/>.
1121 <figure id="fig-timecode">
1122 <title>Timecode</title>
1125 <imagedata fileref="diagrams/timecode&dia;"/>
1131 <guilabel>Position</guilabel> is the time at which this piece of
1132 content should start within the DCP. In most cases, this will be
1133 <code>0:0:0:0</code> to make the content start at the beginning of the
1138 <guilabel>Full length</guilabel> is the length of the piece of
1139 content. This can only be set for still-image content: for video or
1140 sound content, it is fixed by the nature of the content file. If
1141 still-image content is being used you can set the length for which it
1142 should be displayed using this control.
1146 <guilabel>Trim from start</guilabel> specifies the amount that should be trimmed from the start of the content.
1150 <guilabel>Trim from end</guilabel> specifies the amount that should be trimmed from the end of the content.
1154 <guilabel>Play length</guilabel> indicates how long this piece of
1155 content will be once the trims have been applied. This will be equal
1156 to the full length minus <guilabel>trim-from-start</guilabel> and minus <guilabel>trim-from-end</guilabel>.
1160 <guilabel>Video frame rate</guilabel> specifies the frame rate for
1161 still-image content. It can also be used to override the detected
1162 frame rate of other content if DCP-o-matic has got it wrong.
1166 Each timecode control has a <guilabel>Set</guilabel> which you should
1167 click when you have entered a new value for a timecode. The
1168 <guilabel>Set</guilabel> button will make DCP-o-matic take account of
1169 any changes to the corresponding timecode.
1175 <!-- ============================================================== -->
1177 <title>Video processing pipeline</title>
1180 This section gives a little more detail about how DCP-o-matic process
1181 video as it takes it from a source and puts it into a DCP.
1185 Consider, as a somewhat over-the-top example, that we have a 720 x 576
1186 image which is letterboxed with 36 black pixels each at the top and
1187 bottom, and the video content within the letterbox should be presented
1188 in the DCP at ratio of 2.39:1 within a 1.85:1 frame (such as might
1189 happen with a trailer). The source image is shown in <xref
1190 linkend="fig-pipeline1"/>.
1193 <figure id="fig-pipeline1">
1194 <title>Example image to demonstrate video processing</title>
1197 <imagedata scale="100" fileref="diagrams/pipeline1&dia;"/>
1203 DCP-o-matic runs through the following steps when preparing an image for a DCP:
1207 <listitem>Crop</listitem>
1208 <listitem>Scale</listitem>
1209 <listitem>Place in container</listitem>
1213 First, some amount of the image can be cropped. This is almost always
1214 used to remove black borders (letterboxing and/or pillarboxing) around
1219 In our example image, we would use 36 pixels of crop from the top and
1220 bottom. This would give the new image shown in <xref
1221 linkend="fig-pipeline2"/>.
1224 <figure id="fig-pipeline2">
1225 <title>Example image after cropping</title>
1228 <imagedata scale="100" fileref="diagrams/pipeline2&dia;"/>
1234 The next step is to scale the image. Since this content should be
1235 presented in a 2.39:1 aspect ratio inside a 1.85:1 DCP we would select
1236 <guilabel>Scope</guilabel> from the <guilabel>Scale to</guilabel>
1237 option in the <guilabel>Video</guilabel> tab and
1238 <guilabel>Flat</guilabel> from the <guilabel>Container</guilabel>
1239 option in the <guilabel>DCP</guilabel> tab.
1242 <para>The <guilabel>Scale to</guilabel> option should always be set to
1243 the aspect ratio at which the content should be seen. The
1244 <guilabel>Container</guilabel> option should be set to the preset that
1245 you want to use on the projector. Of course, these two settings will
1250 Given the scaling and container information, DCP-o-matic will look at
1251 the DCP's container size, and then scale the source image up until one
1252 or both of its dimensions (width, height or both) fits the size of the
1253 container, all the while preserving the desired aspect ratio.
1257 In our example here, the DCP's container is specified as 1.85:1 (so
1258 that the DCP will play back correctly using the projector's
1259 ‘Flat’ preset). At 2K, 1.85:1 is 1998 pixels by 1080.
1260 Scaling the source up whilst preserving its 1.85:1 aspect ratio will
1261 result in the image hitting the sides of the container first, at a
1262 size of 1998 x 836. This gives us a new version of the image as shown
1263 in <xref linkend="fig-pipeline3"/>.
1266 <figure id="fig-pipeline3">
1267 <title>Example image after cropping and scaling</title>
1270 <imagedata scale="100" fileref="diagrams/pipeline3&dia;"/>
1276 The final step is to place the image into the DCP. In this case,
1277 since we have a 2.39:1 image that should be presented as a 1.85:1 DCP,
1278 we have set the <guilabel>container</guilabel> in the
1279 <guilabel>DCP</guilabel> tab to be Scope. Since the content has been
1280 scaled to 1998 x 836, and a Flat container is 1998 x 1080, there will
1281 be some black bars at the top and bottom of the image. DCP-o-matic
1282 shares out this black equally, as shown in <xref
1283 linkend="fig-pipeline3"/>.
1286 <figure id="fig-pipeline4">
1287 <title>Example image in the DCP</title>
1290 <imagedata scale="100" fileref="diagrams/pipeline4&dia;"/>
1299 <chapter xml:id="ch-dcp" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
1300 <title>DCP settings</title>
1303 This chapter describes the settings that apply to the whole DCP. The
1304 controls for these settings are in the <guilabel>DCP</guilabel> tab of
1305 the main window, as shown in <xref linkend="fig-dcp-tab"/>.
1308 <figure id="fig-dcp-tab">
1309 <title>DCP settings tab</title>
1312 <imagedata fileref="screenshots/dcp-tab&scs;"/>
1318 The first thing here is the name. This is generally set to the title
1319 of the film that is being encoded. If <guilabel>Use ISDCF
1320 name</guilabel> is not ticked, the name that you specify will be used
1321 as-is for the name of the DCP. If <guilabel>Use ISDCF name</guilabel>
1322 is ticked, the name that you enter will be used as part of a
1323 ISDCF-compliant name.
1327 Underneath the name field is a preview of the name that the DCP will
1328 get. To use a ISDCF-compliant name, tick the <guilabel>Use ISDCF
1329 name</guilabel> check-box. The ISDCF name will be composed using details
1330 of your content's soundtrack, the current date and other things that
1331 can be specified in the ISDCF name details dialogue box, which you can
1332 open by clicking on the <guilabel>Details</guilabel> button.
1336 If you want to take the ISDCF-compliant name that DCP-o-matic
1337 generates and modify it, click <guilabel>Copy as name</guilabel> and
1338 the ISDCF name will be copied into the <guilabel>Name</guilabel> box.
1339 You can then edit it as you wish. The DCP name should not matter (in
1340 that it should not affect how the DCP ingests or plays) but
1341 projectionists will appreciate it if you use the standard naming
1342 scheme as it makes it easier to identify details of the content.
1346 The <guilabel>Content Type</guilabel> option can be
1347 ‘feature’, ‘trailer’ or whatever; select the
1348 required type from the drop-down list. On some projection systems
1349 this will affect where your content appears in the projector's server
1350 user interface, so take care to select an appropriate type.
1354 The <guilabel>Signed</guilabel> check-box sets whether or not the DCP
1355 is signed. This is rarely important; if in doubt, tick it.
1359 The <guilabel>Encrypted</guilabel> check-box will set whether the DCP
1360 should be encrypted or not. If this is ticked, the DCP will require a
1361 KDM to play back. Encryption is discussed in <xref
1362 linkend="ch-encryption"/>.
1366 If you use encryption DCP-o-matic will generate a random encryption
1367 key for you. To specify your own key, click the
1368 <guilabel>Edit..</guilabel> button next to the key.
1372 The <guilabel>Standard</guilabel> option specifies which of the two
1373 DCP standards DCP-o-matic should use. If in doubt, use SMPTE (the
1374 more modern of the two).
1378 At the bottom of the DCP tab are a further two tabs, one each to
1379 contain the settings for the DCP's video and audio parts.
1383 The <guilabel>Container</guilabel> option sets the ratio of the image
1384 in the DCP. If this ratio is different to the ratio used for any
1385 content, DCP-o-matic will pad the content with black. In simple cases
1386 this should be set to the same ratio as that for the the primary piece
1387 of video content. Alternatively, you might want to pillarbox a small
1388 format into a Flat container: in this case, select the small format
1389 for the content's ratio and ‘Flat’ for the DCP.
1393 The <guilabel>Frame Rate</guilabel> control sets the frame rate of
1394 your DCP. This can be a little tricky to get right. Ideally, you
1395 want it to be the same as the video content that you are using. If it
1396 is not the same, DCP-o-matic must resort to some tricks to alter your
1397 content to fit the specified frame rate. Frame rates are discussed in
1398 more detail in <xref linkend="ch-frame-rates"/>.
1402 The <guilabel>Use best</guilabel> button sets the DCP video frame rate
1403 to what DCP-o-matic thinks is the best given the content that you have
1408 <guilabel>Burn subtitles into image</guilabel> should be selected if
1409 you want DCP-o-matic to overlay the subtitles onto the video frame
1410 before encoding. Leave this un-ticked to include the subtitles
1411 separately in the DCP.
1415 The <guilabel>3D</guilabel> button will set your DCP to 3D mode if it
1416 is checked. A 3D DCP will then be created, and any 2D content will be
1417 made 3D compatible by repeating the same frame for both left and right
1418 eyes. A 3D DCP can be played back on many 3D systems (e.g. Dolby 3D,
1419 Real-D etc.) but not on a 2D system.
1423 The <guilabel>Resolution</guilabel> tab allows you to choose the
1424 resolution for your DCP. Use 2K unless you have content that is of
1425 high enough resolution to be worth presenting in 4K.
1429 The <guilabel>JPEG2000 bandwidth</guilabel>; setting changes how big
1430 the final image files used within the DCP will be. Larger numbers
1431 will give better quality, but correspondingly larger DCPs. The
1432 bandwidth can be between 50 and 250 megabits per second (Mbit/s).
1433 Most commercial DCPs use bit rates between 75 and 125 MBit/s.
1437 The <guilabel>Audio Channels</guilabel> control sets the number of
1438 audio channels that the DCP will have. If the DCP has any channels
1439 for which there is no content audio they will be replaced by silence.
1440 You can only set an even number of channels here, since that is
1441 required by the DCI standard. If you want an odd number of channels,
1442 set the DCP channel count to one greater than you need and the
1443 unused channel will be filled with silence.
1447 The <guilabel>Processor</guilabel> control allows you to select a
1448 process to apply to the audio before it goes into the DCP. Two processes are currently provided:
1452 <listitem>Mid-side decode — this will take a L/R
1453 stereo input and extract the common part (corresponding to the
1454 ‘Mid’ in a mid-side signal) into the DCP's centre channel.
1455 The remaining L/R parts will be kept in the L/R channels of the DCP.
1456 This may be useful to make near-field L/R mixes more compatible with
1457 cinema audio systems.</listitem>
1458 <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:
1460 <listitem>DCP L is input L bandpass-filtered between 1.9kHz and 4.8kHz.</listitem>
1461 <listitem>DCP R is input R bandpass-filtered between 1.9kHz and 4.8kHz.</listitem>
1462 <listitem>DCP C is input L mixed with input R, taken down by 3dB and then bandpass-filtered between 150Hz and 1.9kHz.</listitem>
1463 <listitem>DCP Lfe is input L mixed with input R, taken down by 3dB and then bandpass-filtered between 20Hz and 150Hz.</listitem>
1464 <listitem>DCP Ls is input L bandpass-filtered between 4.8kHz and 20kHz.</listitem>
1465 <listitem>DCP Rs is input R bandpass-filtered between 4.8kHz and 20kHz.</listitem>
1471 This upmixing algorithm is due to Gérald Maruccia.
1475 <!-- ============================================================== -->
1477 <title>Show audio</title>
1480 The <guilabel>Show Audio</guilabel> button will instruct DCP-o-matic
1481 to examine the audio in your content and plot a graph of its level
1482 over time. This can be useful for getting a rough idea of how loud
1483 the sound will be in the cinema auditorium. A typical plot is shown
1484 in <xref linkend="fig-audio-plot"/>
1487 <figure id="fig-audio-plot">
1488 <title>Audio plot</title>
1491 <imagedata fileref="screenshots/audio-plot&scs;"/>
1497 The plot gives the audio level (vertical axis, in dB) with time
1498 (horizontal axis). 0dB represents full scale, so if there is anything
1499 near this you are in danger of clipping the projector's audio outputs.
1503 There are two plot types: the peak level and the RMS, which can be
1504 shown or hidden using the check-boxes on the right hand side of the
1509 The channel check-boxes will show or hide the plot(s) for
1510 the corresponding channels in the DCP.
1514 The smoothing slider applies a variable degree of temporal smoothing
1515 to the plots, which can make them easier to read in some cases.
1519 Obviously the audio plot is no substitute for listening in an
1520 auditorium, but it can be useful to get levels in the right rough area.
1527 <chapter xml:id="ch-encryption" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
1528 <title>Encryption</title>
1531 It is not required that DCPs be encrypted, but they can be. This
1532 chapter discusses the basic principles of DCP encryption, and how
1533 DCP-o-matic can create encrypted DCPs and KDMs for them.
1537 <!-- ============================================================== -->
1539 <title>Basics</title>
1542 DCPs can be encrypted. This means that the picture and sound data are
1543 encoded in such a way that only cinemas ‘approved’ by the
1544 DCP's creators can read them. In particular, this means copies of the
1545 DCP can be distributed by insecure means: if an ne'er-do-well called
1546 Mallory obtains a hard drive containing an encrypted DCP, there is no
1547 way that he can play it. Only those cinemas who receive a correct key
1548 delivery message (KDM) can play the DCP.
1552 <!-- ============================================================== -->
1554 <title>How it works (in a nutshell)</title>
1557 This section attempts to summarise how DCP encryption works. You can
1558 skip it if you like. You may need some knowledge of encryption
1559 methods to understand it.
1563 We suppose that we are trying to distribute a DCP, to
1564 Alice's cinema, without a troublemaker called Mallory being able to
1569 There are two main families of encryption techniques. The first,
1570 symmetric-key encryption, allows us to encode some data using some
1571 numeric key. After encoding, no-one can decode the data unless they
1576 The first step in a DCP encryption is to encode its data with some key
1577 using symmetric-key encryption. The encrypted DCP can then be sent
1578 anywhere, safe in the knowledge that even if Mallory got hold of a
1579 copy, he could not decrypt it.
1583 Alice, however, needs to know the key so she can play the DCP in her
1584 cinema. A simple approach might be for us to send Alice the key.
1585 However, if Mallory can intercept the DCP, he might also be able to
1586 intercept our communication of the key to Alice. Furthermore, if Alice
1587 happened to know Mallory, she could just send him a copy of the key.
1591 The clever bit in DCP encryption requires the use of public-key
1592 encryption. With this technique we can encrypt a block of data using
1593 some ‘public’ key. That data can then only be decrypted
1594 using a <emphasis>different</emphasis> ‘private’ key. The
1595 private and public keys are related mathematically, but it is
1596 extremely hard (or rather, virtually impossible) to derive the private
1597 key from the public key.
1601 Public-key encryption allows us to distribute the DCP's key to Alice
1602 securely. The manufacturer of Alice's projector generates a public
1603 and private key. They hide the private key deep inside the bowels of
1604 the projector (inside an integrated circuit) where no-one can read it.
1605 They then make the public key available to anyone who is interested.
1609 We take our DCP's symmetric key and encrypt it using the public key of
1610 Alice's projector. We send the result to Alice over email (using a
1611 format called a Key Delivery Message, or KDM). Her projector then
1612 decrypts our message using its private key, yielding the magic
1613 symmetric key which can decrypt the DCP.
1617 If is fine if Mallory intercepts our email to Alice, since the only
1618 key which can decrypt the message is the private key buried inside
1619 Alice's projector. The projector manufacturer is very careful that
1620 no-one ever finds out what this key is. Our DCP is secure: only Alice
1621 can play it back, since only her projector knows the key (even Alice
1629 <!-- ============================================================== -->
1631 <title>Encryption using DCP-o-matic</title>
1634 There are two steps to distributing an encrypted DCP. First, the
1635 DCP's data must be encrypted, and secondly KDMs must be generated for
1636 those cinemas that are allowed to play the DCP.
1640 The first part is simple: ticking the <guilabel>Encrypted</guilabel>
1641 box in the <guilabel>DCP</guilabel> tab of DCP-o-matic will encrypt
1642 the DCP using a random key that DCP-o-matic generates. The key will
1643 be written to the film's metadata file, which should be kept
1648 A DCP that is generated with the <guilabel>Encrypted</guilabel> box
1649 ticked will not play on any projector as-is (it will be marked as
1650 ‘locked’, or whatever the projector manufacturer's term
1655 The second part is to generate KDMs for the cinemas that you wish to
1656 allow to play your DCP. This is done using the <guilabel>Make
1657 KDMs</guilabel> option on the <guilabel>Jobs</guilabel> menu. This
1658 will open the KDM dialogue box, as shown in <xref linkend="fig-kdm"/>.
1661 <figure id="fig-kdm">
1662 <title>KDM dialog</title>
1665 <imagedata fileref="screenshots/kdm&scs;"/>
1671 In order to generate KDMs for a particular projector, you need to know
1672 its <emphasis>certificate</emphasis>. These are usually made
1673 available by the projector manufacturers as text files with a
1674 <code>.pem</code> extension.
1678 DCP-o-matic can store these certificates to make life easier. It
1679 stores details of cinemas and screens within those cinemas. Each
1680 screen has a certificate for its projector. DCP-o-matic can generate
1681 KDMs for any screens that it knows about.
1685 To add a cinema, click <guilabel>Add Cinema...</guilabel>. This opens
1686 a dialogue box into which you can enter the cinema's name, and
1687 optionally an email address. This email address can be used to
1688 get DCP-o-matic to deliver KDMs via email, but it is optional.
1692 Once you have added a cinema, select it by clicking on its name, then
1693 click <guilabel>Add Screen...</guilabel>. The resulting dialogue
1694 allows you to enter a name for the screen and load in its certificate
1695 from a file. The certificate should be in SHA256 PEM format.
1699 Alternatively, certificates for projection systems made by some
1700 manufacturers can be downloaded from databases provided by the
1701 manufacturer. Currently this is supported for Doremi and Dolby
1702 equipment. If you are targeting a screen with equipment by one of
1703 these manufacturers you can select Doremi or Dolby from the
1704 <guilabel>Server manufacturer</guilabel> selection and then click
1705 <guilabel>Download</guilabel>. In the next dialogue box, enter
1706 details of the screen and click <guilabel>Download</guilabel> and, all
1707 being well, the certificate will be fetched.
1711 Using the download system you will need to know the serial number of
1712 the media server in use in the screen. Most cinema projection or
1713 technical departments will know these serial numbers.
1717 Note that the reliability of the manufacturers' certificate databases
1718 cannot be guaranteed. It is vital that KDMs are tested by the
1719 destination cinema will in advance of show time to identify any
1724 Once you have set up all the screens that you need KDMs for, select
1725 the CPL that you want to create the KDM for. You can use the
1726 drop-down list to select the CPLs in the current film project, or load
1727 a CPL from somewhere else. Select the cinemas and/or screens that you
1728 want KDMs for and fill in the start and end dates and times.
1732 You must also select the type of KDM that you want to generate. If in
1733 doubt, use <guilabel>Modified Transitional 1</guilabel>.
1737 Finally, choose what you want to do with the KDMs. They can be
1738 written to disk, to a location that you can specify by clicking
1739 <guilabel>Browse</guilabel>. Alternatively, if you choose
1740 <guilabel>Send by email</guilabel> the KDMs will be zipped up and
1741 emailed to the appropriate cinema email addresses. Click OK to
1751 <!-- ============================================================== -->
1752 <chapter xml:id="ch-preferences" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
1753 <title>Preferences</title>
1756 DCP-o-matic provides a few preferences which can be used to modify its
1757 behaviour. This chapter explains those options.
1761 <!-- ============================================================== -->
1763 <title>The preferences dialogue</title>
1766 The preferences dialogue is opened by choosing
1767 <guilabel>Preferences...</guilabel> from the <guilabel>Edit</guilabel>
1768 menu. The dialogue is split into seven tabs.
1771 <!-- ============================================================== -->
1773 <title>General</title>
1776 The general tab is shown in <xref linkend="fig-prefs-general"/>.
1779 <figure id="fig-prefs-general">
1780 <title>General preferences</title>
1783 <imagedata fileref="screenshots/prefs-general&scs;"/>
1789 <!-- ============================================================== -->
1791 <title>Language</title>
1794 If you tick the <guilabel>Set Language</guilabel> checkbox and choose
1795 a language from the list, that language will be used for DCP-o-matic.
1796 You will need to restart DCP-o-matic to see the new language.
1800 The translations for DCP-o-matic have been contributed by helpful
1801 users. If your language is not on the last, head to <ulink
1802 url="http://dcpomatic.com/i18n.php">the DCP-o-matic website</ulink> to
1803 read about how to contribute a translation.
1808 <!-- ============================================================== -->
1810 <title>Threads</title>
1813 When DCP-o-matic is encoding DCPs it can use multiple parallel threads
1814 to speed things up. Set this value to the number of threads
1815 DCP-o-matic should use. This should normally be the number of
1816 processors (or processor cores) in your machine. DCP-o-matic will try
1817 to set this up correctly when you run it for the first time.
1822 <!-- ============================================================== -->
1824 <title>Updates</title>
1827 The <guilabel>Check for updates on startup</guilabel> option, if
1828 enabled, will tell DCP-o-matic to check on <ulink
1829 url="http://dcpomatic.com/">dcpomatic.com</ulink> to see if there any
1830 newer versions of DCP-o-matic then the one you are running. If so, a
1831 dialogue box will open with a link to download the new version.
1836 The <guilabel>Check for testing updates as well as stable
1837 ones</guilabel> option will also check for test updates as well as
1838 those that are formally ‘released’. This is useful if you
1839 like to live on the bleeding edge!
1845 <!-- ============================================================== -->
1847 <title>Defaults</title>
1850 The defaults tab is shown in <xref linkend="fig-prefs-defaults"/>.
1853 <figure id="fig-prefs-defaults">
1854 <title>Defaults preferences</title>
1857 <imagedata fileref="screenshots/prefs-defaults&scs;"/>
1863 The options in this tab simply allow you to set up default values for
1864 various properties of new films.
1869 <!-- ============================================================== -->
1871 <title>Servers</title>
1874 The servers tab is shown in <xref linkend="fig-prefs-servers"/>.
1877 <figure id="fig-prefs-servers">
1878 <title>Servers preferences</title>
1881 <imagedata fileref="screenshots/prefs-servers&scs;"/>
1887 If <guilabel>Use all servers</guilabel> is ticked DCP-o-matic will
1888 locate encoding servers automatically (see <xref
1889 linkend="ch-servers"/>).
1893 Instead of this (or in addition) servers can be specified explicitly.
1894 To add a server, click <guilabel>Add...</guilabel> and enter the host
1895 name or IP address of the server to use.
1901 <!-- ============================================================== -->
1902 <section xml:id="sec-prefs-keys">
1906 The Keys tab (shown in <xref linkend="fig-prefs-keys"/>) holds options
1907 related to the keys and certificates used in some parts of DCP
1911 <figure id="fig-prefs-keys">
1912 <title>Keys preferences</title>
1915 <imagedata fileref="screenshots/prefs-keys&scs;"/>
1921 At the top of the tab is the chain of certificates that will be used
1922 to sign DCPs and KDMs. DCP-o-matic creates a random chain when you
1923 first run it, so if you are happy to use a randomly-generated chain
1924 you can ignore the preferences. Otherwise, you can add or remove
1925 certificates from the chain using the <guilabel>Add...</guilabel> and
1926 <guilabel>Remove</guilabel> buttons.
1930 If you want DCP-o-matic to re-create the certificate chain (using new,
1931 random certificates) click <guilabel>Re-make
1932 certificates...</guilabel> and specify your organisation and common
1933 names in the dialogue box that opens.
1937 Underneath the certificate chain is the private key that corresponds
1938 to the leaf certificate in the chain. You can specify your own
1939 private key by clicking <guilabel>Load...</guilabel>. You must do
1940 this if you change the leaf certificate, so that the leaf private key
1941 corresponds to the public key held in the leaf certificate.
1945 The bottom of the tab specifies the certificate and private key that
1946 is used to decrypt DCPs if they are imported as sources to
1947 DCP-o-matic. If you want to import an encrypted DCP you will need to
1948 give the decryption certificate to the distributor of the DCP so that
1949 they can generate a DKDM for you. As with the certificate chain,
1950 DCP-o-matic will create a certificate and private key for you. You
1951 can also choose to load your own certificate and key.
1956 <!-- ============================================================== -->
1957 <section xml:id="sec-prefs-tms">
1959 <titleabbrev xml:id="sec-prefs-tms-short">TMS preferences</titleabbrev>
1962 The TMS tab (shown in <xref linkend="fig-prefs-tms"/>) gives some
1963 options for specifying details about your theatre management system
1964 (TMS). If you do this, and your TMS accepts SSH connections, you can
1965 upload DCPs directly from DCP-o-matic to the TMS using the
1966 <guilabel>Send DCP to TMS</guilabel> option in the
1967 <guilabel>Jobs</guilabel> menu.
1970 <figure id="fig-prefs-tms">
1971 <title>TMS preferences</title>
1974 <imagedata fileref="screenshots/prefs-tms&scs;"/>
1980 <guilabel>TMS IP address</guilabel> should be set to the IP address of
1981 your TMS, <guilabel>TMS target path</guilabel> to the place that DCPs
1982 should be uploaded to (which will be relative to the home directory of
1983 the SSH user). Finally, the user name and password are the
1984 credentials required to log into the TMS via SSH.
1988 Note that for this to work on Doremi servers you will need to set the
1989 <code>PasswordAuthentication</code> option in your server's
1990 <code>sshd_config</code> to <code>yes</code>.
1996 <!-- ============================================================== -->
1998 <title>KDM email</title>
2001 The KDM email is shown in <xref linkend="fig-prefs-kdm-email"/>.
2004 <figure id="fig-prefs-kdm-email">
2005 <title>KDM email preferences</title>
2008 <imagedata fileref="screenshots/prefs-kdm-email&scs;"/>
2014 This is a template for the email that is used to send KDMs out to
2015 cinemas. You can change it to say whatever you like. A few
2016 ‘magic’ strings will be replaced by information from the
2017 KDM that is being sent:
2021 <title>‘Magic’ KDM strings</title>
2022 <tgroup cols='2' align='left' colsep='1' rowsep='1'>
2025 <entry><code>$CPL_NAME</code></entry><entry>DCP title</entry>
2028 <entry><code>$CINEMA_NAME</code></entry><entry>Cinema name</entry>
2031 <entry><code>$SCREENS</code></entry><entry>Name of screen or screens that KDMs are being generated for</entry>
2034 <entry><code>$START_TIME</code></entry><entry>The time from which the KDMs are valid</entry>
2037 <entry><code>$END_TIME</code></entry><entry>The time until which the KDMs are valid</entry>
2044 The <guilabel>Reset to default text</guilabel> will replace the current KDM email with DCP-o-matic's default.
2050 <!-- ============================================================== -->
2051 <section xml:id="sec-prefs-advanced">
2052 <title>Advanced</title>
2053 <titleabbrev xml:id="sec-prefs-advanced-short">Advanced preferences</titleabbrev>
2056 The advanced preferences are shown in <xref linkend="fig-prefs-advanced"/>.
2059 <figure id="fig-prefs-advanced">
2060 <title>Advanced preferences</title>
2063 <imagedata fileref="screenshots/prefs-advanced&scs;"/>
2069 <guilabel>Maximum JPEG2000 bandwidth</guilabel> specifies the maximum
2070 bit-rate of JPEG2000 that DCP-o-matic will allow you to create. You
2071 are advised to leave this at 250Mbit/s in normal use for maximum DCP
2076 <guilabel>Allow any DCP frame rate</guilabel> removes the limits on
2077 the DCP video frame rates that DCP-o-matic will create. This may be
2078 useful for experimentation. Again, you are strongly advised to leave
2079 this unticked for normal use.
2083 The four checkboxes labelled <guilabel>Log</guilabel> control what
2084 sort of messages DCP-o-matic writes to its log file when creating a
2085 DCP. It is useful to leave <guilabel>General</guilabel>,
2086 <guilabel>Warnings</guilabel> and <guilabel>Errors</guilabel> ticked
2087 as this makes the log files useful for tracking down bugs.
2091 The <guilabel>Timing</guilabel> checkbox will enable extra log entries
2092 to allow developers to investigate and optimize the speed of
2093 DCP-o-matic. It will significantly increase the size of the log files
2094 that are generated, so in normal use it is best to leave this
2102 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" xml:id="ch-frame-rates">
2103 <title>Frame rates</title>
2106 In an ideal world, a DCP would be created using content at the same
2107 video frame and audio sampling rates as the DCP. This is not,
2108 however, always possible.
2112 <!-- ============================================================== -->
2114 <title>DCP frame rate limitations</title>
2117 There are some limitations to video and audio frame rates in DCPs. This is
2118 complicated by the fact that not all projectors will play DCPs at the
2119 same frame rates. It is possible to create a DCP which one projector will
2120 play fine, but another (of a different type) will refuse to play, or
2121 even refuse to ingest.
2125 <!-- ============================================================== -->
2127 <title>Guaranteed rates</title>
2130 The only rates that are (pretty much) guaranteed to work on all DCI
2131 projectors are 24 frames per second (fps) for video and 48kHz or 96kHz
2132 for audio. If you are sending your DCPs to unknown places it wise to
2133 consider using these rates if at all possible.
2139 <!-- ============================================================== -->
2141 <title>Other often-supported rates</title>
2143 Many projectors now in the wild support additional video frame rates:
2149 <!-- ============================================================== -->
2151 <title>Adapting content to fit the DCP rate</title>
2154 DCP-o-matic has a few tricks to allow you to use content that is not
2155 in one of the ‘approved’ rates.
2159 Audio is easy: DCP-o-matic can resample to 48kHz from any source rate
2160 with minimal loss in quality.
2164 Video rate conversion is harder. DCP-o-matic's basic strategy to deal
2165 with a non-supported content rate is to run it at the wrong speed, and
2166 to adjust the audio to keep it in sync.
2169 <para>Let us consider the example of a 25fps source for which you want
2170 to create a 24fps DCP. DCP-o-matic will put the frames from the
2171 source directly into the DCP without modification, but will tell the
2172 projector to play them back at 24fps. This means that the DCP's video
2173 will run slightly slower than the original.
2177 If DCP-o-matic did nothing else, the result of this would be that the
2178 audio would be running at the original speed with the video running
2179 slowly. Hence the audio would drift slowly out of sync. To avoid
2180 this, DCP-o-matic also resamples the audio such that the projector
2181 will play it too slow by the same amount. Hence it will sound
2182 slightly different but will remain in sync with the video.
2186 For very low or high frame rates, DCP-o-matic can also skip or duplicate frames.
2193 <!-- ============================================================== -->
2195 <title>Setting up</title>
2198 The <guilabel>Frame Rate</guilabel> control in the
2199 <guilabel>DCP</guilabel> tab sets the video frame rate that the DCP
2200 will use. Clicking <guilabel>Use best</guilabel> sets the rate to
2201 what DCP-o-matic thinks is the best for your content. With this
2202 button, DCP-o-matic assumes that the whole range of frame rates (24,
2203 25, 30 and 48fps) are allowable.
2207 After this, the <guilabel>Video</guilabel> tab for each piece of
2208 content will give a summary of what DCP-o-matic is doing with that
2213 If you want to experiment with other non-standard frame rates, you can
2214 do so by ticking the <guilabel>Allow any DCP frame rate</guilabel> in
2215 the <guilabel>Advanced</guilabel> tab of the preferences dialogue (see the
2216 <xref linkend="sec-prefs-advanced" endterm="sec-prefs-advanced-short"/>). You are strongly advised to
2217 use this only on your own equipment, and only for experimentation
2226 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" xml:id="ch-servers">
2227 <title>Encoding servers</title>
2230 One way to increase the speed of DCP encoding is to use more
2231 than one machine at the same time. An instance of DCP-o-matic can
2232 offload some of the time-consuming JPEG2000 encoding to any number of
2233 other machines on a network. To do this, one ‘master’
2234 machine runs DCP-o-matic, and the ‘server’ machines run
2235 a small program called <code>dcpomatic_server</code>.
2239 The master and server machines do not need to be the same type, so you
2240 can mix Windows PCs, Macs and Linux machines as you wish.
2244 <!-- ============================================================== -->
2246 <title>Running the servers</title>
2249 There are two options for the encoding server;
2250 <code>dcpomatic_server_cli</code>, which runs on the command line, and
2251 <code>dcpomatic_server</code>, which has a simple GUI. The command line
2252 version is well-suited to headless servers, especially on Linux, and
2253 the GUI version works best on Windows where it will put an icon in the
2258 To run the command line version, simply enter:
2262 dcpomatic2_server_cli
2266 at a command prompt. If you are running the program on a machine with
2267 a multi-core processor, you can run multiple parallel encoding threads
2268 by doing something like:
2272 dcpomatic2_server_cli -t 4
2276 to run 4 threads in parallel.
2280 To run the GUI version on windows, run the ‘DCP-o-matic encode
2281 server’ from the start menu. An icon will appear in the system
2282 tray; right-click it to open a menu from whence you can quit the
2283 server or open a window to show its status.
2286 <para>If you would rather not bother installing DCP-o-matic on your
2287 server computers, the other option is to use the live-CD
2288 image that you can download from the <ulink
2289 url="http://dcpomatic.com/">DCP-o-matic web site.</ulink></para>
2291 <para>Either burn the image to CD, or write it to a USB stick (using
2292 something like <ulink
2293 url="http://unetbootin.sourceforge.net/">unetbootin</ulink>). Boot a
2294 PC from the CD or USB stick and it becomes a DCP-o-matic server
2295 without touching your standard operating system install.
2300 <!-- ============================================================== -->
2302 <title>Setting up DCP-o-matic</title>
2305 DCP-o-matic periodically looks on the local network for servers. Any
2306 that it finds are given work to do during encodes. Selecting
2307 <guilabel>Encoding Servers</guilabel> from the
2308 <guilabel>Tools</guilabel> menu brings up a window which shows that
2309 servers that DCP-o-matic has found.
2314 <!-- ============================================================== -->
2316 <title>Some notes about encode servers</title>
2319 DCP-o-matic does not mind if servers come and go; if a server
2320 disappears, DCP-o-matic will stop sending work to it, and will check
2321 it every minute or so in case it has come back online.
2325 You will probably find that using a 1Gb/s or faster network will
2326 provide a significant speed-up compared to a 100Mb/s network.
2333 <chapter xml:id="ch-files" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
2334 <title>Generated files</title>
2337 DCP-o-matic generates a number of files as it makes a DCP. <xref
2338 linkend="fig-file-structure"/> shows the files that might be generated
2339 after you have created a DCP for a film called ‘DCP Test’.
2342 <figure id="fig-file-structure">
2343 <title>Creating a new film</title>
2346 <imagedata fileref="diagrams/file-structure&dia;"/>
2352 The <code>DCP Test</code> folder is the one that you specify when you
2353 select the <guilabel>New Film</guilabel> option from DCP-o-matic's
2354 menu. Everything is stored inside this folder.
2358 DCP-o-matic generates some working files as it goes along. These are as follows:
2361 <listitem><code>log</code> is a list of notes that DCP-o-matic makes as it goes
2362 along. This can be useful for debugging purposes if something goes
2365 <listitem><code>metadata</code> stores the settings that you have made
2366 for this film: things like cropping, output format and so on.</listitem>
2368 <listitem><code>video</code> is where DCP-o-matic writes the DCP's
2369 video data as it encodes it.</listitem>
2371 <listitem><code>analysis</code> is used to keep the results of audio analysis runs.</listitem>
2373 <listitem><code>info</code> contains details of each video frame that
2374 DCP-o-matic has written so far. This is used when an encoding
2375 operation is interrupted and DCP-o-matic must resume it.</listitem>
2380 Following this is the DCP itself:
2381 <code>DCP-TEST_EN-XX_UK-U_51_2K_CSY_20130218_CSY_OV</code>. This
2382 contains some small XML files, which describe the DCP, and two large
2383 MXF files, which contain the DCP's audio and video data. This folder
2384 (<code>DCP-TEST_EN-XX_...</code>) is what you should ingest, or pass
2385 to the cinema which is showing your DCP.
2391 <title>Loose ends</title>
2394 This chapter collects a few notes on bits of DCP-o-matic that do not fit elsewhere in the manual.
2398 <!-- ============================================================== -->
2400 <title>Resuming encodes</title>
2403 If you cancel a DCP encoding run half-way through, or your computer
2404 crashes... fear not. DCP-o-matic takes care to ensure that, in most
2405 cases, it can resume encoding from where it left off. When you
2406 re-start a DCP creation, using the same settings are a previous run,
2407 DCP-o-matic will first check that the existing picture frames are
2408 correct, and then resume from where it left off. The checking of
2409 existing frames does take some time, but it is much faster than
2410 running a full re-encode.
2414 This resumption is achieved by writing a digest (hash) to disk for
2415 every image frame that is written. On resumption, the existing MXF
2416 file for image data is read and its contents checked against the
projects / dcpomatic.git / blob