98ce4175ae3a9e0585f383a7f8e6c0113d43a46e
[dcpomatic.git] / doc / manual / dcpomatic.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book [
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">
7 %dbcent;
8 <!ENTITY % extensions SYSTEM "extensions.ent">
9 %extensions;
10 ]>
11 <book xmlns="http://docbook.org/ns/docbook" xmlns:mml="http://www.w3.org/1998/Math/MathML" version="5.0" xml:lang="en">
12
13 <bookinfo>
14 <title>DCP-o-matic users' manual</title>
15 <author><firstname>Carl</firstname><surname>Hetherington</surname></author>
16 </bookinfo>
17
18 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
19 <title>Introduction</title>
20
21 <para>
22 Hello, and welcome to DCP-o-matic!
23 </para>
24
25 <!-- ============================================================== -->
26 <section>
27 <title>What is DCP-o-matic?</title>
28
29 <para>DCP-o-matic is a set of programs to perform the following tasks:</para>
30
31 <itemizedlist>
32   <listitem>Creation of <ulink
33   url="http://en.wikipedia.org/wiki/Digital_Cinema_Package">Digital
34   Cinema Packages</ulink> (DCPs) from video, audio and/or
35   subtitle files.</listitem>
36   <listitem>Playback of DCPs on a PC.</listitem>
37   <listitem>Creation of KDMs for DCPs.</listitem>
38 </itemizedlist>
39
40 </section>
41
42
43 <!-- ============================================================== -->
44 <section>
45 <title>Licence</title>
46
47 <para>
48 DCP-o-matic is free and open-source and is licensed under the <ulink
49 url="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU
50 GPL</ulink>.
51 </para>
52
53 </section>
54
55
56 <!-- ============================================================== -->
57 <section>
58 <title>Acknowledgements</title>
59
60 <para>
61 This manual uses icons from the <ulink url="http://tango.freedesktop.org/">Tango Desktop Project</ulink>, with thanks.
62 </para>
63
64 </section>
65
66 <!-- ============================================================== -->
67 <section>
68 <title>This manual</title>
69
70 <para>
71 This manual presents bits of DCP-o-matic's user interface (such as menu items or buttons) <guilabel>like this</guilabel>.
72 </para>
73
74 <note>
75 Notes of an advanced nature are presented like this.  Ignore them unless you want to know the gory details.
76 </note>
77
78 </section>
79 </chapter>
80
81
82 <!-- ============================================================== -->
83 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
84 <title>Installation</title>
85
86
87 <!-- ============================================================== -->
88 <section>
89 <title>Windows</title>
90
91 <para>
92 To install DCP-o-matic on Windows, download the installer from
93 <ulink url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>
94 and double-click it.  Click through the installer wizard, and
95 DCP-o-matic will be installed onto your machine.
96 </para>
97
98 <para>
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 used 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
104 version.
105 </para>
106
107 <para>
108 If you are still using Windows XP, download the specific XP version as
109 it should be more stable on your machine than the &lsquo;normal&rsquo;
110 Windows version.
111 </para>
112
113 </section>
114
115
116 <!-- ============================================================== -->
117 <section>
118 <title>Mac OS X</title>
119
120 <para>
121 DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and
122 higher.  DCP-o-matic is split into four separate applications, each of
123 which can be installed by downloading the <code>.dmg</code>,
124 double-clicking to open and then dragging the icon to your
125 <guilabel>Applications</guilabel> folder.
126 </para>
127
128 <para>
129 If you are not sure which parts of DCP-o-matic to install, start
130 with the first (main) part.
131 </para>
132
133 </section>
134
135 <!-- ============================================================== -->
136 <section>
137 <title>Debian, Ubuntu or Mint Linux</title>
138
139 <para>
140   You can install DCP-o-matic on:
141 </para>
142
143 <itemizedlist>
144   <listitem>Debian 7 (&lsquo;wheezy&rsquo;)</listitem>
145   <listitem>Debian 8 (&lsquo;jessie&rsquo;)</listitem>
146   <listitem>Debian unstable (&lsquo;sid&rsquo;)</listitem>
147   <listitem>Ubuntu 14.04 (&lsquo;Trusty Tahr&rsquo;)</listitem>
148   <listitem>Ubuntu 16.04 (&lsquo;Xenial Xerus&rsquo;)</listitem>
149   <listitem>Ubuntu 17.10 (&lsquo;Artful Aardvark&rsquo;)</listitem>
150   <listitem>Mint 17</listitem>
151   <listitem>Mint 18</listitem>
152 </itemizedlist>
153
154 <para>
155 using <code>.deb</code> packages: download the appropriate package
156 from <ulink url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>
157 and double-click it.  Debian or Ubuntu will install the necessary bits and
158 pieces and set DCP-o-matic up for you.
159 </para>
160 </section>
161 <!-- ============================================================== -->
162
163
164 <!-- ============================================================== -->
165 <section>
166   <title>Fedora, Centos and Mageia Linux</title>
167
168   <para>There are <code>.rpm</code> packages for Fedora 25, 26 and 27, Centos 6 and 7 and Mageia 6 on
169   <ulink url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>
170   </para>
171 </section>
172 <!-- ============================================================== -->
173
174 <!-- ============================================================== -->
175 <section>
176 <title>Arch Linux</title>
177 <para>
178 Packages for Arch Linux are available from <ulink
179 url="https://aur.archlinux.org/packages/dcpomatic/">https://aur.archlinux.org/packages/dcpomatic/</ulink>,
180 thanks to Stefan Karner.
181 </para>
182 </section>
183
184
185 <!-- ============================================================== -->
186 <section>
187 <title>Other Linux distributions</title>
188
189 <para>
190 Installation on other Linux systems (for which no packages are
191 available) is quite hard as it must be compiled from source.  If you
192 can't download packages for your distribution, do let me know by
193 <ulink url="mailto:carl@dcpomatic.com">email</ulink> and I will look
194 into providing packages on the website.
195 </para>
196
197 <para>
198 The following dependencies are required:
199 <itemizedlist>
200 <listitem><ulink url="http://ffmpeg.org/">FFmpeg</ulink></listitem>
201 <listitem><ulink url="http://www.mega-nerd.com/libsndfile/">libsndfile</ulink></listitem>
202 <listitem><ulink url="http://www.mega-nerd.com/SRC/">libsamplerate</ulink></listitem>
203 <listitem><ulink url="http://www.openssl.org/">OpenSSL</ulink></listitem>
204 <listitem><ulink url="http://www.openjpeg.org/">libopenjpeg</ulink></listitem>
205 <listitem><ulink url="http://www.imagemagick.org/script/index.php">ImageMagick</ulink></listitem>
206 <listitem><ulink url="http://www.boost.org/">Boost</ulink></listitem>
207 <listitem><ulink url="http://www.libssh.org/">libssh</ulink></listitem>
208 <listitem><ulink url="http://www.gtk.org/">GTK (on Linux)</ulink></listitem>
209 <listitem><ulink url="http://www.wxwidgets.org/">wxWidgets</ulink></listitem>
210 <listitem><ulink url="http://libxmlplusplus.sourceforge.net/">libxml++</ulink></listitem>
211 <listitem><ulink url="http://www.aleksey.com/xmlsec/">xmlsec</ulink></listitem>
212 <listitem><ulink url="http://curl.haxx.se/">curl</ulink></listitem>
213 <listitem><ulink url="http://www.nih.at/libzip/">libzip</ulink></listitem>
214 <listitem><ulink url="http://carlh.net/libdcp/">libdcp</ulink></listitem>
215 <listitem><ulink url="http://carlh.net/libsub/">libsub</ulink></listitem>
216 <listitem><ulink url="http://carlh.net/libcxml/">libcxml</ulink></listitem>
217 <listitem><ulink url="http://site.icu-project.org">libicu</ulink></listitem>
218 </itemizedlist>
219 </para>
220
221 <para>
222 Once you have installed the development packages for the dependencies,
223 download the source code from <ulink
224 url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>,
225 unpack it and run the following commands from inside the source
226 directory:
227 </para>
228
229 <programlisting>
230 ./waf configure
231 ./waf build
232 sudo ./waf install
233 </programlisting>
234
235 <para>
236 With any luck, this will build and install DCP-o-matic on your system.  To run it, enter:
237 </para>
238
239 <programlisting>
240 dcpomatic2
241 </programlisting>
242
243 <para>
244 in a shell.
245 </para>
246
247 </section>
248 </chapter>
249
250
251 <!-- ============================================================== -->
252 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
253 <title>Creating a DCP from a video</title>
254
255 <para>
256 In this chapter we will see how to create a DCP from a video file using
257 DCP-o-matic.  We will gloss over the details and look at the basics.
258 </para>
259
260 <section>
261 <title>Creating a new film</title>
262
263 <para>
264 Let's make a very simple DCP to see how DCP-o-matic works.  First, we
265 need some content.  Download the low-resolution trailer for the open
266 movie <ulink url="http://sintel.org/">Sintel</ulink> from <ulink
267 url="https://download.blender.org/durian/trailer/Sintel_Trailer.480p.DivX_Plus_HD.mkv">their
268 website</ulink>.  Generally one would want to use the
269 highest-resolution material available, but for this test we will use
270 the low-resolution version to save everyone's bandwidth bills.
271 </para>
272
273 <para>
274 Now, start DCP-o-matic and its window will open.  First, we will
275 create a new &lsquo;film&rsquo;.  A &lsquo;film&rsquo; is how DCP-o-matic refers to
276 some pieces of content, along with some settings, which we will make into
277 a DCP.  DCP-o-matic stores its data in a folder on your disk while it
278 creates the DCP.  You can create a new film by selecting
279 <guilabel>New</guilabel> from the <guilabel>File</guilabel> menu, as
280 shown in <xref linkend="fig-file-new"/>.
281 </para>
282
283 <figure id="fig-file-new">
284   <title>Creating a new film</title>
285   <mediaobject>
286     <imageobject>
287       <imagedata fileref="screenshots/file-new&scs;"/>
288     </imageobject>
289   </mediaobject>
290 </figure>
291
292 <para>
293 This will open a dialogue box for the new film, as shown in <xref
294 linkend="fig-video-new-film"/>.
295 </para>
296
297 <figure id="fig-video-new-film">
298   <title>Dialogue box for creating a new film</title>
299   <mediaobject>
300     <imageobject>
301       <imagedata fileref="screenshots/video-new-film&scs;"/>
302     </imageobject>
303   </mediaobject>
304 </figure>
305
306 <para>
307 In this dialogue box you can choose a name for the film.  This will be
308 used to name the folder to store its data in, and also as the initial
309 name for the DCP itself.  You can also choose whereabouts you want to create
310 the film.  In the example from the figure, DCP-o-matic will create a
311 folder called &lsquo;DCP Test&rsquo; inside my home folder (carl) into which it
312 will write its working files.
313 </para>
314
315 </section>
316
317
318 <!-- ============================================================== -->
319 <section>
320 <title>Adding content</title>
321
322 <para>
323 The next step is to add the content that you want to use.  DCP-o-matic
324 can make DCPs from multiple pieces of content, but in this simple
325 example we will just use a single piece.  Click the <guilabel>Add
326 file(s)...</guilabel> button, as shown in <xref
327 linkend="fig-add-file"/>, and a file chooser will open for you to
328 select the content file to use, as shown in <xref
329 linkend="fig-video-select-content-file"/>.
330 </para>
331
332 <figure id="fig-add-file">
333   <title>Adding content files</title>
334   <mediaobject>
335     <imageobject>
336       <imagedata fileref="screenshots/add-file&scs;"/>
337     </imageobject>
338   </mediaobject>
339 </figure>
340
341 <figure id="fig-video-select-content-file">
342   <title>Selecting a video content file</title>
343   <mediaobject>
344     <imageobject>
345       <imagedata fileref="screenshots/video-select-content-file&scs;"/>
346     </imageobject>
347   </mediaobject>
348 </figure>
349
350 <para>
351 Select your content file and click <guilabel>Open</guilabel>.  In this
352 case we are using the Sintel trailer that we downloaded earlier.
353 </para>
354
355 <para>
356 When you do this, DCP-o-matic will take a look at your file.  After a
357 short while (when the progress bar at the bottom right of the window
358 has finished), you can look through your content using the slider to
359 the right of the window, as shown in <xref linkend="fig-examine-content"/>.
360 </para>
361
362 <figure id="fig-examine-content">
363   <title>Examining the content</title>
364   <mediaobject>
365     <imageobject>
366       <imagedata fileref="screenshots/examine-content&scs;"/>
367     </imageobject>
368   </mediaobject>
369 </figure>
370
371 <para>
372 Dragging the slider will move through your video.  You can also click
373 the <guilabel>Play</guilabel> button to play the content back.
374 </para>
375
376 </section>
377
378
379
380
381 <!-- ============================================================== -->
382 <section>
383 <title>Making the DCP</title>
384
385 <para>In most cases, some adjustments would be made to DCP-o-matic's
386 settings once the content has been added.  For our simple test,
387 however, the default values will suffice, so we can go straight onto
388 making the DCP.</para>
389
390 <para>
391 Choose <guilabel>Make DCP</guilabel> from the
392 <guilabel>Jobs</guilabel> menu.  DCP-o-matic will encode your DCP.
393 This may take some time (many hours in some cases).  While the job is
394 in progress, DCP-o-matic will update you on how it is getting on with
395 the progress bar in the bottom of its window, as shown in <xref
396 linkend="fig-making-dcp"/>.
397 </para>
398
399 <figure id="fig-making-dcp">
400   <title>Making the DCP</title>
401   <mediaobject>
402     <imageobject>
403       <imagedata scale="50" fileref="screenshots/making-dcp&scs;"/>
404     </imageobject>
405   </mediaobject>
406 </figure>
407
408 <para>
409 When it has finished, the DCP will end up on your disk inside the
410 film's folder.  You can then copy this to a projector via a USB
411 stick, hard-drive or network connection.  See <xref
412 linkend="ch-files"/> for details about the files that DCP-o-matic creates.
413 </para>
414
415 <para>
416 Alternatively, if you have a projector or Theatre Management System
417 (TMS) that is accessible via SCP or FTP across your network, you can upload
418 the content directly from DCP-o-matic.  See the <xref
419 linkend="sec-prefs-tms" endterm="sec-prefs-tms-short"/> in <xref linkend="sec-prefs-tms"/>.
420 </para>
421
422 </section>
423 </chapter>
424
425
426 <!-- ============================================================== -->
427 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
428 <title>Creating a DCP from a still image</title>
429
430 <para>
431 DCP-o-matic can also be used to create DCPs of one or more still images, perhaps
432 for an advertisement or an on-screen announcement.  This chapter shows you
433 how to do it.
434 </para>
435
436 <para>
437 As with DCPs made from video files, the first step is to create a new
438 &lsquo;Film&rsquo;; select <guilabel>New</guilabel> from the
439 <guilabel>File</guilabel> menu and the new film dialogue will open as
440 shown in <xref linkend="fig-still-new-film"/>.
441 </para>
442
443 <figure id="fig-still-new-film">
444   <title>Dialogue box for creating a new film</title>
445   <mediaobject>
446     <imageobject>
447       <imagedata fileref="screenshots/still-new-film&scs;"/>
448     </imageobject>
449   </mediaobject>
450 </figure>
451
452 <para>
453 Enter a name and click <guilabel>OK</guilabel>.  Now we need to add
454 the content.  As before, click <guilabel>Add file(s)...</guilabel>.
455 For our example, we will add a single image file, as shown in <xref
456 linkend="fig-still-select-content-file"/>.
457 </para>
458
459 <figure id="fig-still-select-content-file">
460   <title>Selecting a still content file</title>
461   <mediaobject>
462     <imageobject>
463       <imagedata fileref="screenshots/still-select-content-file&scs;"/>
464     </imageobject>
465   </mediaobject>
466 </figure>
467
468 <para>
469 Most of the default settings will be fine for a simple test.  The one
470 thing that you might wish to change is the length of the still.
471 Select the <guilabel>Timing</guilabel> tab and you will see a
472 <guilabel>Play length</guilabel> setting, as shown in <xref
473 linkend="fig-timing-tab"/>.
474 </para>
475
476 <figure id="fig-timing-tab">
477   <title>The timing tab</title>
478   <mediaobject>
479     <imageobject>
480       <imagedata fileref="screenshots/timing-tab&scs;"/>
481     </imageobject>
482   </mediaobject>
483 </figure>
484
485 <para>
486 This length is a &lsquo;timecode&rsquo;: it consists of four numbers.
487 The first is hours, the second minutes, the third seconds, and the
488 fourth frames.  Enter the duration that you want and then click <guilabel>Set</guilabel>.
489 </para>
490
491 <para>
492 Finally, as with video, you can choose <guilabel>Make DCP</guilabel>
493 from the <guilabel>Jobs</guilabel> menu to create your DCP.  This will
494 be much quicker than creating a DCP from a video file, as DCP-o-matic only needs
495 to encode a single frame which it can then repeat.
496 </para>
497
498 </chapter>
499
500
501 <!-- ============================================================== -->
502 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
503 <title>Manipulating existing DCPs</title>
504
505 <para>
506 Frequently DCP-o-matic is used to take content in formats such as MP4
507 and convert it to JPEG2000 for a DCP.  It can also be used
508 to take existing DCPs and modify them in various ways.
509 </para>
510
511 <section>
512 <title>Importing a DCP into DCP-o-matic</title>
513
514 <para>
515 If you want to do something to an existing DCP the first step is to
516 import it.  Click <guilabel>Add DCP...</guilabel> and select your
517 DCP's folder.  It will be added to the DCP-o-matic project.  If the
518 DCP is unencrypted you can preview it in the normal way, though
519 playback will be very slow as decoding of DCPs is almost as
520 computationally intensive as encoding them.
521 </para>
522
523 <para>
524 If your DCP is a Version File (VF) (i.e. it refers to
525 another DCP's assets) you should import it as follows:
526 </para>
527
528 <itemizedlist>
529 <listitem>Use <guilabel>Add DCP...</guilabel> to import the VF DCP.
530 The VF DCP will be added to the content list and marked &ldquo;NEEDS
531 OV&rdquo;.</listitem>
532 <listitem>Right-click on the VF DCP in the content list and choose <guilabel>Add OV...</guilabel> from the menu.</listitem>
533 <listitem>Choose the folder that contains the OV DCP.  The VF will now be playable as normal.</listitem>
534 </itemizedlist>
535
536 </section>
537
538
539 <section xml:id="sec-decrypting">
540 <title>Decrypting encrypted DCPs</title>
541
542 <para>
543 DCPs can be encrypted (see <xref linkend="ch-encryption"/> for
544 details).  If you import an encrypted DCP you will need a key, in the
545 form of a Key Delivery Message (KDM), to decrypt it.
546 </para>
547
548 <para>
549 KDMs must be prepared by the organisation which created the DCP.  They
550 contain the keys to decrypt the DCP wrapped up in such a way that only
551 the intended recipient can read them.  You will need to provide the
552 organisation with a certificate which identifies your copy of
553 DCP-o-matic and allows them to create a KDM for you.
554 </para>
555
556 <para>
557 To get DCP-o-matic's decryption certificate, open the Preferences
558 dialogue (see <xref linkend="ch-preferences"/>) and go to the
559 <guilabel>Keys</guilabel> tab.  Click the <guilabel>Export DCP
560 decryption certificate...</guilabel> button at the bottom of this tab
561 and save the certificate.  Send this certificate to the DCP creators
562 and they can create a KDM to allow DCP-o-matic to decrypt their DCP.
563 </para>
564
565 <para>
566 Once you have your KDM, right-click the DCP's name in DCP-o-matic and
567 choose <guilabel>Add KDM...</guilabel>.  Specify your KDM and the DCP
568 will be decrypted and become available for preview.
569 </para>
570
571 </section>
572
573
574 <section>
575 <title>Making a DCP from a DCP</title>
576
577 <para>
578 In many ways, using DCPs as <emphasis>content</emphasis> in
579 DCP-o-matic is the same as using any other content.  There are a few
580 things to note, though.
581 </para>
582
583
584 <section>
585 <title>Re-use of existing data</title>
586
587 <para>
588 Where possible DCP-o-matic will re-use existing JPEG2000-compressed
589 data from DCP content without modification.  This has the advantage
590 that creation of the new DCP will be quick, as the time-consuming
591 JPEG2000 encoding is not necessary.
592 </para>
593
594 <para>
595 DCP-o-matic can do this if you <emphasis>avoid</emphasis> changes to
596 the following content settings:
597 </para>
598
599 <itemizedlist>
600 <listitem>Crop</listitem>
601 <listitem>Scaling</listitem>
602 <listitem>Subtitle burn-in</listitem>
603 <listitem>Fades</listitem>
604 <listitem>Colour conversion</listitem>
605 </itemizedlist>
606
607 <para>
608 If you do change any of these settings on a piece of DCP content
609 DCP-o-matic will decode and then re-encode the JPEG2000 data.
610 </para>
611
612 </section>
613
614
615 <section xml:id="sec-overlay">
616 <title>Making overlay files</title>
617
618 <para>
619 With its default settings, DCP-o-matic will take any data from DCP
620 content and copy it into the DCP that it creates.  See <xref linkend="fig-dcp-copy"/>.
621 </para>
622
623 <figure id="fig-dcp-copy">
624 <title>Creating a new DCP by copying an existing one</title>
625 <mediaobject><imageobject><imagedata scale="100" fileref="diagrams/dcp-copy&dia;"/></imageobject></mediaobject>
626 </figure>
627
628 <para>
629 This can be inefficient in some cases.  Consider, for example, a film
630 which has ten different translations for which the subtitles are
631 different but video and audio are the same.  If the video and audio
632 content takes up, say, 100Gb this means that the set of DCPs for every
633 translation would be about 1Tb with a lot of duplicated data.
634 </para>
635
636 <para>
637 The DCP format has a solution to this problem.  One DCP can refer to
638 the &lsquo;assets&rsquo; (picture, sound or subtitle) of another DCP.
639 For our translation example this means that we could have a
640 &lsquo;base&rsquo; DCP (often called the OV or Original Version)
641 containing video, audio and one set of subtitles and then any number
642 of overlay DCPs (often called VF or Version Files) which refer to the
643 base version and replace the original subtitles with their own.  <xref
644 linkend="fig-dcp-refer"/> shows this principle for one of our
645 translations.  The DCP that we make refers to the original content
646 DCP's video and audio rather than containing a copy.
647 </para>
648
649 <figure id="fig-dcp-refer">
650 <title>Creating a new DCP by referring to an existing one</title>
651 <mediaobject><imageobject><imagedata scale="100" fileref="diagrams/dcp-refer&dia;"/></imageobject></mediaobject>
652 </figure>
653
654 <para>
655 To play back the subtitled DCP the projectionist ingests both the base
656 (OV) DCP and the overlay (VF) DCP, then plays the VF one.
657 </para>
658
659 <para>
660 To make a DCP like this:
661 </para>
662
663 <itemizedlist>
664 <listitem>Import your &lsquo;Content DCP&rsquo; to a DCP-o-matic project.</listitem>
665 <listitem>Add whatever replacement you want in your new DCP (replacement subtitles or audio files, for example).</listitem>
666 <listitem>Select the DCP in the content list</listitem>
667 <listitem>Tick the <guilabel>Use's this DCP's ... as OV and make VF</guilabel> checkbox
668 in the tabs for the parts of the DCP that you want to refer to in your
669 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>
670 <listitem>Do <guilabel>Make DCP</guilabel> as usual and your VF DCP will be created.</listitem>
671 </itemizedlist>
672
673 </section>
674
675 </section>
676
677
678
679 </chapter>
680 <!-- ============================================================== -->
681
682
683 <!-- ============================================================== -->
684 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
685 <title>Content settings</title>
686
687 <para>
688 The previous chapters showed DCP generation using the default
689 settings.  DCP-o-matic offers a range of features to adjust the
690 content that goes into your DCP, and this chapter describes those
691 features in detail.
692 </para>
693
694 <section>
695 <title>Adding and removing content</title>
696
697 <para>
698 At the top of the <guilabel>Content</guilabel> tab is a list of the
699 content that will go into our DCP.  There can be as many pieces of
700 content as you like, and they can be of the following types:
701 </para>
702
703 <itemizedlist>
704 <listitem>Movie &mdash; a file containing some video, probably some
705 audio and possibly some embedded subtitles; for example, a MOV, MP4 or VOB.
706 </listitem>
707
708 <listitem>Sound &mdash; a file containing one or more channels of
709 audio; for example, a WAV or AIFF file.
710 </listitem>
711
712 <listitem>Still image &mdash; a file containing a single still image; for
713 example, a JPEG, PNG or TIFF file.
714 </listitem>
715
716 <listitem>Moving image &mdash; a directory containing many still
717 images which should be treated as the frames of a video.
718 </listitem>
719
720 <listitem>Subtitle &mdash; a file containing subtitle which will be
721 superimposed on the image of the DCP.  These can be
722 <guilabel>.srt</guilabel>, <guilabel>.ssa</guilabel>, <guilabel>.ass</guilabel> or <guilabel>.xml</guilabel>
723 files.</listitem>
724
725 <listitem>DCP &mdash; an existing DCP.</listitem>
726 </itemizedlist>
727
728 <para>
729 To add one or more movie, sound, still-image or subtitle files, select
730 <guilabel>Add file(s)...</guilabel> and choose them from the selector.
731 </para>
732
733 <para>
734 To add a directory (folder) of images, choose <guilabel>Add
735 folder...</guilabel> and choose the directory from the selector.
736 DCP-o-matic will open a small dialogue box where you can enter the
737 frame rate that the image sequence should be run at.
738 </para>
739
740 <para>
741 To add a DCP, choose <guilabel>Add DCP...</guilabel> and choose the
742 DCP's directory from the selector.
743 </para>
744
745 <para>
746 You can remove a piece of content by clicking on its name and then
747 clicking the <guilabel>Remove</guilabel> button.
748 </para>
749
750 </section>
751
752 <!-- ============================================================== -->
753 <section>
754 <title>Adding existing DCPs</title>
755
756 <para>Adding existing DCPs to a DCP-o-matic film is a little different
757 to adding other types of content.  Most content has to be converted to
758 JPEG2000, the compression scheme used by DCPs, which is a very
759 time-consuming process.  Existing DCPs are already in JPEG2000 format
760 so do not require conversion.  This means that, provided no settings
761 such as crop are used on the DCP content, picture and sound data will
762 be passed from existing to new DCP unaltered.
763 </para>
764
765 <para>Encrypted DCPs that are added as content will require a KDM
766 targeted at DCP-o-matic so that DCP-o-matic can decrypt them.  You
767 should ask the creator of the imported DCP to provide a KDM for
768 DCP-o-matic's decryption certificate, which can be obtained by
769 clicking <guilabel>Export DCP decryption certificate...</guilabel>
770 from the <guilabel>Keys</guilabel> tab of the
771 <guilabel>Preferences</guilabel> dialog (see <xref
772 linkend="sec-prefs-keys"/>).
773 </para>
774
775 </section>
776
777 <!-- ============================================================== -->
778 <section>
779 <title>Content Properties</title>
780
781 <para>
782 Below the content list are the controls to set content properties.  To
783 adjust the properties for a piece of content, click its name in the
784 content list.  The content property controls will then become active
785 for that piece of content.
786 </para>
787
788 <para>
789 If you want to change the properties for multiple pieces of content at
790 the same time, select the content in the list by clicking the first
791 piece then clicking the other pieces with <keycap>shift</keycap> key
792 held down.  Note that not all settings can be changed in this way.
793 </para>
794
795 <para>
796 The content properties are split up into four sections:
797 <guilabel>Video</guilabel>, <guilabel>Audio</guilabel>,
798 <guilabel>Subtitles</guilabel> and <guilabel>Timing</guilabel>.  Not
799 all of these sections will be active for all content types.  The controls
800 in each section are described below.
801 </para>
802
803 </section>
804
805
806 <!-- ============================================================== -->
807 <section>
808 <title>Video</title>
809
810 <para>
811 The <guilabel>Video</guilabel> tab controls properties of the image, as shown in <xref linkend="fig-video-tab"/>.
812 </para>
813
814 <figure id="fig-video-tab">
815   <title>Video settings tab</title>
816   <mediaobject>
817     <imageobject>
818        <imagedata fileref="screenshots/video-tab&scs;"/>
819     </imageobject>
820   </mediaobject>
821 </figure>
822
823
824 <!-- ============================================================== -->
825 <section>
826 <title>Use this DCP's video as OV and make VF</title>
827
828 <para>
829 This option is only applicable if the selected content is an existing
830 DCP.  It allows you make a VF DCP, using the video content from the
831 existing DCP by referencing it (rather than copying).  See <xref
832 linkend="sec-overlay"/>.
833 </para>
834
835 </section>
836
837 <!-- ============================================================== -->
838 <section>
839 <title>Image type</title>
840
841 <para>
842 The next option on this tab is the &lsquo;type&rsquo; of the video.
843 This specifies how DCP-o-matic should interpret the video's image.
844 <guilabel>2D</guilabel> is the default; this just takes the video
845 image as a standard 2D frame.  The <guilabel>3D
846 left/right</guilabel> option tells DCP-o-matic to interpret the frame as a
847 left-right pair, as shown in <xref linkend="fig-3d-left-right"/>.
848 </para>
849
850 <figure id="fig-3d-left-right">
851   <title>3D left/right image type</title>
852   <mediaobject>
853     <imageobject>
854        <imagedata scale="100" fileref="diagrams/3d-left-right&dia;"/>
855     </imageobject>
856   </mediaobject>
857 </figure>
858
859 <para>
860 Alternatively the <guilabel>3D top/bottom</guilabel> option tells
861 DCP-o-matic to see the frame as a top-bottom pair, as shown in <xref
862 linkend="fig-3d-top-bottom"/>.
863 </para>
864
865 <figure id="fig-3d-top-bottom">
866   <title>3D top/bottom image type</title>
867   <mediaobject>
868     <imageobject>
869        <imagedata scale="100" fileref="diagrams/3d-top-bottom&dia;"/>
870     </imageobject>
871   </mediaobject>
872 </figure>
873
874 <para>
875 Another option is <guilabel>3D alternate</guilabel> which takes the
876 first frame of the content as for the left eye, the second for the
877 right eye, the third for the left, and so on.  Finally, you can
878 specify <guilabel>3D left only</guilabel> or <guilabel>3D right
879 only</guilabel> if this content contains only the the left or right
880 eye images.  This is useful when you have the left and right eye image
881 sets in different files; you can specify one content as <guilabel>3D
882 left only</guilabel> and another as <guilabel>3D right only</guilabel>
883 and DCP-o-matic will pick up the appropriate frames from each.
884 </para>
885
886 </section>
887
888
889 <!-- ============================================================== -->
890 <section>
891 <title>Filtering</title>
892
893 <para>
894 The &lsquo;filters&rsquo; settings allow you to apply various video
895 filters to the image.  These may be useful to try to improve
896 poor-quality sources like DVDs.  You can set up the filters by clicking the
897 <guilabel>Edit</guilabel> button next to the filters entry in the
898 setup area of the DCP-o-matic window; this opens the filters selector
899 as shown in <xref linkend="fig-filters"/>.
900 </para>
901
902 <figure id="fig-filters">
903   <title>Filters selector</title>
904   <mediaobject>
905     <imageobject>
906       <imagedata fileref="screenshots/filters&scs;"/>
907     </imageobject>
908   </mediaobject>
909 </figure>
910
911 <para>
912 After changing the filters setup, you will need to regenerate the DCP
913 to see the effect on the cinema screen.  The preview in DCP-o-matic
914 will update itself whenever filters are changed, though of course this
915 image is much smaller and of lower resolution than a projected image!
916 </para>
917 </section>
918
919
920
921 <!-- ============================================================== -->
922 <section>
923 <title>Colour conversion</title>
924
925 <para>
926 The <guilabel>Colour conversion</guilabel> setting specifies what
927 colour transforms and gamma correction DCP-o-matic will use when
928 converting the selected content into the XYZ colourspace for the DCP.
929 </para>
930
931 <para>
932 The easiest way to select the required conversion is to choose one of
933 DCP-o-matic's presets.  DCP-o-matic knows how to convert from four
934 common colourspaces: sRGB, Rec. 601, Rec. 709 and P3.  If you do not
935 know which preset you should use, refer to the suggestions in <xref
936 linkend="tab-colour-conversion"/>.
937 </para>
938
939 <table id="tab-colour-conversion">
940 <title>Suggested colour conversion settings</title>
941 <tgroup cols='2' align='left' colsep='1' rowsep='1'>
942 <colspec colwidth='1*'/>
943 <colspec colwidth='5*'/>
944 <tbody>
945 <row>
946 <entry>sRGB</entry><entry>Still images in RGB, e.g. photographs</entry>.
947 </row>
948 <row>
949 <entry>Rec. 601</entry><entry>Standard-definition content (fewer than about 1000 pixels across) including DVD rips.</entry>
950 </row>
951 <row>
952 <entry>Rec. 709</entry><entry>High-definition content including Blu-Ray rips.</entry>
953 </row>
954 <row>
955 <entry>P3</entry><entry>Content explicitly graded to P3.</entry>
956 </row>
957 </tbody>
958 </tgroup>
959 </table>
960
961 <para>
962 For other required colour conversions, and if you know what you are
963 doing, you can choose <guilabel>Custom</guilabel> which will open the full
964 colour conversion editing dialogue box:
965 </para>
966
967 <figure id="fig-colour-conversion">
968   <title>Dialogue box for custom colour conversion</title>
969   <mediaobject>
970     <imageobject>
971       <imagedata fileref="screenshots/colour-conversion&scs;"/>
972     </imageobject>
973   </mediaobject>
974 </figure>
975
976 <para>
977 Alternatively, choose <guilabel>None</guilabel> if your source files
978 are already in the XYZ colour space and require no conversion.
979 </para>
980
981 <para>
982 DCP-o-matic's colour conversion processes are discussed in much more
983 detail in a separate document <ulink
984 url="http://dcpomatic.com/manual/colour.pdf">colour.pdf</ulink>.
985 </para>
986
987 </section>
988
989 <!-- ============================================================== -->
990 <section>
991 <title>Other settings</title>
992
993 <para>
994 The <guilabel>crop</guilabel> settings can be used to crop your content,
995 which can be used to remove black borders from round the edges of DVD
996 images, for example.  The specified number of pixels will be trimmed
997 from each edge, and the content image in the right of the window will
998 be updated to show the effect of the crop.
999 </para>
1000
1001 <para>
1002 The <guilabel>fade in</guilabel> and <guilabel>fade out</guilabel>
1003 settings can be used to apply linear fades into and out of a piece of
1004 content.  Specify the time for each, clicking <guilabel>Set</guilabel>
1005 after making any changes.
1006 </para>
1007
1008 <para>
1009 The <guilabel>Scale to</guilabel> option governs the shape that
1010 DCP-o-matic will scale the content's image into.  Select the aspect
1011 ratio that your content should be presented in.
1012 </para>
1013
1014 </section>
1015
1016 <!-- ============================================================== -->
1017 <section>
1018 <title>Video description</title>
1019
1020 <para>
1021 At the bottom of the video tab is a short description of what will
1022 happen to your video with the current settings.  In the example of
1023 <xref linkend="fig-video-tab"/>, DCP-o-matic is telling you that the
1024 video file is 1920x1080 pixels and it has square pixels (a pixel
1025 aspect ratio of 1.00) hence its display aspect ratio is 1.78:1.  Since
1026 the controls specify &lsquo;16.9&rsquo; for the ratio, DCP-o-matic
1027 does not scale the image but pads it to the DCP's container ratio of
1028 1.85:1.  For a 2K DCP this is 1998x1080 pixels.
1029 </para>
1030
1031 <para>
1032 This description also gives the frame rate of the content and what
1033 will happen to it when it is played at the DCP's frame rate.  See
1034 <xref linkend="ch-frame-rates"/> for details of DCP-o-matic's
1035 frame-rate conversion.
1036 </para>
1037
1038 </section>
1039
1040 </section>
1041
1042
1043 <!-- ============================================================== -->
1044 <section>
1045 <title>Audio</title>
1046
1047 <para>
1048 The <guilabel>Audio</guilabel> tab controls properties of the image, as shown in <xref linkend="fig-audio-tab"/>.
1049 </para>
1050
1051 <figure id="fig-audio-tab">
1052   <title>Audio settings tab</title>
1053   <mediaobject>
1054     <imageobject>
1055        <imagedata fileref="screenshots/audio-tab&scs;"/>
1056     </imageobject>
1057   </mediaobject>
1058 </figure>
1059
1060 <!-- ============================================================== -->
1061 <section>
1062 <title>The audio map</title>
1063
1064 <para>
1065 The section at the bottom of the audio tab is the &lsquo;audio
1066 map&rsquo;.  This governs how sound from the content will be arranged
1067 in the DCP.
1068 </para>
1069
1070 <para>
1071 Down the left-hand side of the map is the list of audio channels in
1072 the currently-selected piece of content.  These are labelled with two
1073 numbers; the first is the stream index within the content and the
1074 second is the channel number within that stream.  Some content will
1075 have different streams for different languages or audio mixes.  Along
1076 the top is each channel in the DCP.  A green box means that the
1077 corresponding content channel will be copied into the corresponding
1078 DCP channel.
1079 </para>
1080
1081 <para>
1082 When content channels are copied into DCP channels they can be done
1083 with variable gain.  If, for example, you want to copy a channel
1084 as-is, you can set a gain of 0dB.  Alternatively, if you want to mix
1085 two channels into one, you may want to use a gain of -6dB on each one
1086 to prevent clipping when the two channels are added.
1087 </para>
1088
1089 <para>
1090 The green boxes of the audio mapping view tell you (very roughly) how
1091 much gain is applied to each channel.  A full-height box means 0dB
1092 (i.e. unity) gain.  Any less height indicates lower gain.
1093 </para>
1094
1095 <para>
1096 To map one channel to another with 0dB gain, click in the empty box
1097 and it will turn green to reflect the mapping.  A second click will
1098 turn the mapping back off.  To set some other gain, right-click on the
1099 box to open the gain menu.  This allows you to set
1100 <guilabel>Off</guilabel> (no mapping or negative infinity gain),
1101 <guilabel>Full</guilabel> (0dB gain), -6dB gain or
1102 <guilabel>Edit</guilabel> which allows you to set the required gain
1103 precisely.
1104 </para>
1105
1106 <para>
1107 Consider, for example, the case in <xref linkend="fig-audio-map-eg1"/>.
1108 </para>
1109
1110 <figure id="fig-audio-map-eg1">
1111   <title>Audio map example 1</title>
1112   <mediaobject>
1113     <imageobject>
1114        <imagedata fileref="screenshots/audio-map-eg1&scs;"/>
1115     </imageobject>
1116   </mediaobject>
1117 </figure>
1118
1119 <para>
1120 Here, we have two channels in the source which are mapped to left and
1121 right, respectively, in the DCP.  The full green boxes show that the
1122 mapping is at unity gain (0dB) in each case.  Imagine that we modify
1123 the settings to those shown in <xref linkend="fig-audio-map-eg2"/>
1124 </para>
1125
1126 <figure id="fig-audio-map-eg2">
1127   <title>Audio map example 2</title>
1128   <mediaobject>
1129     <imageobject>
1130        <imagedata fileref="screenshots/audio-map-eg2&scs;"/>
1131     </imageobject>
1132   </mediaobject>
1133 </figure>
1134
1135 <para>
1136 We now have the content's streams mapped to left and right and also
1137 mixed together and placed in the DCP's centre channel.  The smaller
1138 green boxes on the centre mappings show that those channels are added
1139 with some non-unity gain; you can see by hovering the mouse pointer
1140 over those boxes that the gain for content channels 1 and 2 is -6dB
1141 when being sent to the centre channel and 0dB when being sent to left
1142 and right.
1143 </para>
1144
1145 <figure id="fig-audio-map-eg3">
1146   <title>Audio map example 3</title>
1147   <mediaobject>
1148     <imageobject>
1149        <imagedata fileref="screenshots/audio-map-eg3&scs;"/>
1150     </imageobject>
1151   </mediaobject>
1152 </figure>
1153
1154 <para>
1155 As a final example, the map in <xref linkend="fig-audio-map-eg3"/>
1156 shows the mapping of a 5.1 source into a 5.1 DCP.
1157 </para>
1158
1159 </section>
1160
1161
1162 <!-- ============================================================== -->
1163 <section>
1164   <title>Other controls</title>
1165
1166 <para>
1167 The <guilabel>Use this DCP's audio as OV and make VF</guilabel>
1168 checkbox is only applicable if the selected content is an existing
1169 DCP.  It allows you to make a VF DCP, using the audio content from the
1170 existing DCP by referencing it (rather than copying).  See <xref
1171 linkend="sec-overlay"/>.
1172 </para>
1173
1174 <para>
1175 <guilabel>Show graphs of audio levels</guilabel> will analyse the
1176 audio of the selected content and plot it on a graph.  See <xref
1177 linkend="sec-show-audio"/> for more details.
1178 </para>
1179
1180 <para>
1181 &lsquo;Audio Gain&rsquo; is used to alter the volume of the
1182 soundtrack.  The specified gain (in dB) will be applied to each sound
1183 channel of your content before it is written to the DCP.
1184 </para>
1185
1186 <para>
1187 If you use a sound processor that DCP-o-matic knows about, it can help
1188 you calculate changes in gain that you should apply.  Say, for
1189 example, that you make a test DCP and find that you have to run it at
1190 volume 5 instead of volume 7 to get a good sound level in the screen.
1191 If this is the case, click the <guilabel>Calculate...</guilabel>
1192 button next to the audio gain entry, and the dialogue box in <xref
1193 linkend="fig-calculate-audio-gain"/> will open.
1194 </para>
1195
1196 <figure id="fig-calculate-audio-gain">
1197   <title>Calculating audio gain</title>
1198   <mediaobject>
1199     <imageobject>
1200       <imagedata fileref="screenshots/calculate-audio-gain&scs;"/>
1201     </imageobject>
1202   </mediaobject>
1203 </figure>
1204
1205 <para>
1206 For our example, put 5 in the first box and 7 in the second and click
1207 <guilabel>OK</guilabel>.  DCP-o-matic will calculate the audio gain
1208 that it should apply to make this happen.  Then you can re-make the
1209 DCP (this will be reasonably fast, as the video data will already have
1210 been done) and it should play back at the correct volume with 7 on
1211 your sound-rack fader.
1212 </para>
1213
1214 <para>
1215 Current versions of DCP-o-matic only know about the Dolby CP650 and
1216 CP750.  If you use a different sound processor, and know the gain
1217 curve of its volume control, <ulink url="mailto:carl@dcpomatic.com">get in
1218 touch</ulink>.
1219 </para>
1220
1221 <para>
1222 <guilabel>Audio Delay</guilabel> is used to adjust the synchronisation
1223 between audio and video.  A positive delay will move the audio later
1224 with respect to the video, and a negative delay will move it earlier.
1225 </para>
1226
1227 </section>
1228 </section>
1229
1230
1231 <!-- ============================================================== -->
1232 <section>
1233 <title>Subtitles</title>
1234
1235 <para>
1236 The subtitles tab contains settings related to subtitles in your
1237 content, as shown in <xref linkend="fig-subtitles-tab"/>.
1238 </para>
1239
1240 <figure id="fig-subtitles-tab">
1241   <title>Subtitle settings tab</title>
1242   <mediaobject>
1243     <imageobject>
1244        <imagedata fileref="screenshots/subtitles-tab&scs;"/>
1245     </imageobject>
1246   </mediaobject>
1247 </figure>
1248
1249 <para>
1250 DCP-o-matic can either:
1251 </para>
1252
1253 <itemizedlist>
1254   <listitem>Extract subtitles that are embedded in video files, or</listitem>
1255   <listitem>Use subtitles from SubRip (<code>.srt</code>), SubStation
1256   Alpha (<code>.ssa</code> or <code>.ass</code>) or DCP XML files.  You may find the great
1257   free program <ulink
1258   url="http://www.nikse.dk/subtitleedit/">Subtitle Edit</ulink> useful
1259   for creating such files.</listitem>
1260 </itemizedlist>
1261
1262 <para>
1263 Embedded subtitles are usually represented using a set of bitmaps,
1264 especially on files that have come from DVD or BluRay.  Such subtitles
1265 can (currently) only be &lsquo;burnt&rsquo; into the DCP (that is,
1266 they are included in the image and not overlaid by the projector).
1267 </para>
1268
1269 <para>
1270 With SubRip, SubStation Alpha or DCP subtitles you have the choice to
1271 either burn-in or include the subtitles as separate subtitle
1272 &lsquo;asset&rsquo; within your DCP (in which case the projector
1273 overlays them onto the image on playback).  The difference between
1274 burn-in and overlay is illustrated by <xref linkend="fig-burn-in"/>
1275 and <xref linkend="fig-discrete"/>.
1276 </para>
1277
1278 <figure id="fig-burn-in">
1279   <title>Burnt-in subtitles</title>
1280   <mediaobject>
1281     <imageobject>
1282        <imagedata scale="100" fileref="diagrams/burn-in&dia;"/>
1283     </imageobject>
1284   </mediaobject>
1285 </figure>
1286
1287 <figure id="fig-discrete">
1288   <title>Separate subtitles</title>
1289   <mediaobject>
1290     <imageobject>
1291        <imagedata scale="100" fileref="diagrams/discrete&dia;"/>
1292     </imageobject>
1293   </mediaobject>
1294 </figure>
1295
1296 <para>
1297 The advantage of separate subtitles is that the same video content can
1298 be used for DCPs in many different languages.  This means that only a
1299 small text file needs to be changed for each target language, rather
1300 than a large video file.  It also means that the time-consuming video
1301 encoding need only be done once for the project rather than once for
1302 every language.
1303 </para>
1304
1305 <para>
1306 Select the <guilabel>Use Subtitles</guilabel> check-box to enable
1307 the subtitles in the selected content.
1308 </para>
1309
1310 <para>
1311 Select the <guilabel>Burn subtitles into image</guilabel> check-box to
1312 burn these subtitles into the image; if this is not ticked the
1313 subtitles will be included separately in the DCP to be rendered by the
1314 projector.  This check-box will always be ticked if you are using
1315 embedded &lsquo;image&rsquo; subtitles.
1316 </para>
1317
1318 <para>
1319 The <guilabel>X Offset</guilabel> and <guilabel>Y Offset</guilabel>
1320 controls move the subtitles around within the image.  The offsets are
1321 expressed as a percentage of the video frame size; 100% X offset is
1322 the entire width of the frame, and 100% Y offset is the entire height.
1323 Hence, to move the subtitles down by half the frame height you would
1324 use a Y offset of 50%.
1325 </para>
1326
1327 <para>
1328 The <guilabel>X Scale</guilabel> and <guilabel>Y Scale</guilabel>
1329 controls scale the subtitles.  Scale values of 1 make the subtitles
1330 the same size (relative to the size of the image) as they are on the
1331 original.  Values lower than 1 make them smaller, and values higher
1332 make them larger.  You can stretch the subtitles in either direction
1333 by specifying different values for X and Y scale.  Subtitles from DVD
1334 and Blu Ray sources are frequently larger (relative to the video
1335 frame) than those typically used for DCP, so it is often useful to
1336 scale such subtitles down using these controls.
1337 </para>
1338
1339 <para>
1340 The <guilabel>Line spacing</guilabel> control adjusts the line spacing
1341 of the subtitles.  This only works for non-embedded (text) subtitles.
1342 </para>
1343
1344 <para>
1345 The <guilabel>Stream</guilabel> control changes the subtitle stream
1346 that is used when the content has more than one.
1347 </para>
1348
1349 <para>
1350 If you are using non-embedded (text) subtitles you can see the
1351 subtitle text and timings by clicking the <guilabel>View...</guilabel>
1352 button, or specify the fonts that should be used by clicking <guilabel>Fonts...</guilabel>.
1353 </para>
1354
1355 <para>
1356 With any subtitles you can click <guilabel>Appearance...</guilabel> to
1357 change how the subtitles look.
1358 </para>
1359
1360 </section>
1361
1362
1363 <!-- ============================================================== -->
1364 <section>
1365 <title>Timing</title>
1366
1367 <para>
1368 The timing tab contains settings related to the timing of your
1369 content, as shown in <xref linkend="fig-timing-tab-detail"/>.
1370 </para>
1371
1372 <figure id="fig-timing-tab-detail">
1373   <title>Timing settings tab</title>
1374   <mediaobject>
1375     <imageobject>
1376        <imagedata fileref="screenshots/timing-tab&scs;"/>
1377     </imageobject>
1378   </mediaobject>
1379 </figure>
1380
1381 <para>
1382 Most of the timing tab's entries are <emphasis>time-codes</emphasis>.
1383 These are expressed as four numbers, as shown in <xref
1384 linkend="fig-timecode"/>.
1385 </para>
1386
1387 <figure id="fig-timecode">
1388   <title>Timecode</title>
1389   <mediaobject>
1390     <imageobject>
1391        <imagedata scale="100" fileref="diagrams/timecode&dia;"/>
1392     </imageobject>
1393   </mediaobject>
1394 </figure>
1395
1396 <para>
1397 <guilabel>Position</guilabel> is the time at which this piece of
1398 content should start within the DCP.  In most cases, this will be
1399 <code>0:0:0:0</code> to make the content start at the beginning of the
1400 DCP.
1401 </para>
1402
1403 <para>
1404 <guilabel>Full length</guilabel> is the length of the piece of
1405 content.  This can only be set for still-image content: for video or
1406 sound content, it is fixed by the nature of the content file.  If
1407 still-image content is being used you can set the length for which it
1408 should be displayed using this control.
1409 </para>
1410
1411 <para>
1412 <guilabel>Trim from start</guilabel> specifies the amount that should
1413 be trimmed from the start of the content.  You can set this amount to
1414 trim up to the current preview position by clicking <guilabel>Trim up
1415 to current position</guilabel>.
1416 </para>
1417
1418 <para>
1419 <guilabel>Trim from end</guilabel> specifies the amount that should be
1420 trimmed from the end of the content.  You can set this amount to trim
1421 after the current preview position by clicking <guilabel>Trim after to
1422 current position</guilabel>.
1423 </para>
1424
1425 <para>
1426 <guilabel>Play length</guilabel> indicates how long this piece of
1427 content will be once the trims have been applied.  This will be equal
1428 to the full length minus <guilabel>trim-from-start</guilabel> and minus <guilabel>trim-from-end</guilabel>.
1429 </para>
1430
1431 <para>
1432 <guilabel>Video frame rate</guilabel> specifies the frame rate for
1433 still-image content.  It can also be used to override the detected
1434 frame rate of other content if DCP-o-matic has got it wrong.
1435 </para>
1436
1437 <para>
1438 Each timecode control has a <guilabel>Set</guilabel> which you should
1439 click when you have entered a new value for a timecode.  The
1440 <guilabel>Set</guilabel> button will make DCP-o-matic take account of
1441 any changes to the corresponding timecode.
1442 </para>
1443
1444 </section>
1445
1446
1447 <!-- ============================================================== -->
1448 <section>
1449 <title>Video processing pipeline</title>
1450
1451 <para>
1452 This section gives a little more detail about how DCP-o-matic process
1453 video as it takes it from a source and puts it into a DCP.
1454 </para>
1455
1456 <para>
1457 Consider, as a somewhat over-the-top example, that we have a 720 x 576
1458 image which is letterboxed with 36 black pixels each at the top and
1459 bottom, and the video content within the letterbox should be presented
1460 in the DCP at ratio of 2.39:1 within a 1.85:1 frame (such as might
1461 happen with a trailer).  The source image is shown in <xref
1462 linkend="fig-pipeline1"/>.
1463 </para>
1464
1465 <figure id="fig-pipeline1">
1466   <title>Example image to demonstrate video processing</title>
1467   <mediaobject>
1468     <imageobject>
1469        <imagedata scale="100" fileref="diagrams/pipeline1&dia;"/>
1470     </imageobject>
1471   </mediaobject>
1472 </figure>
1473
1474 <para>
1475 DCP-o-matic runs through the following steps when preparing an image for a DCP:
1476 </para>
1477
1478 <itemizedlist>
1479 <listitem>Crop</listitem>
1480 <listitem>Scale</listitem>
1481 <listitem>Place in container</listitem>
1482 </itemizedlist>
1483
1484 <para>
1485 First, some amount of the image can be cropped.  This is almost always
1486 used to remove black borders (letterboxing and/or pillarboxing) around
1487 images.
1488 </para>
1489
1490 <para>
1491 In our example image, we would use 36 pixels of crop from the top and
1492 bottom.  This would give the new image shown in <xref
1493 linkend="fig-pipeline2"/>.
1494 </para>
1495
1496 <figure id="fig-pipeline2">
1497   <title>Example image after cropping</title>
1498   <mediaobject>
1499     <imageobject>
1500        <imagedata scale="100" fileref="diagrams/pipeline2&dia;"/>
1501     </imageobject>
1502   </mediaobject>
1503 </figure>
1504
1505 <para>
1506 The next step is to scale the image.  Since this content should be
1507 presented in a 2.39:1 aspect ratio inside a 1.85:1 DCP we would select
1508 <guilabel>Scope</guilabel> from the <guilabel>Scale to</guilabel>
1509 option in the <guilabel>Video</guilabel> tab and
1510 <guilabel>Flat</guilabel> from the <guilabel>Container</guilabel>
1511 option in the <guilabel>DCP</guilabel> tab.
1512 </para>
1513
1514 <para>The <guilabel>Scale to</guilabel> option should always be set to
1515 the aspect ratio at which the content should be seen.  The
1516 <guilabel>Container</guilabel> option should be set to the preset that
1517 you want to use on the projector.  Of course, these two settings will
1518 often be the same.
1519 </para>
1520
1521 <para>
1522 Given the scaling and container information, DCP-o-matic will look at
1523 the DCP's container size, and then scale the source image up until one
1524 or both of its dimensions (width, height or both) fits the size of the
1525 container, all the while preserving the desired aspect ratio.
1526 </para>
1527
1528 <para>
1529 In our example here, the DCP's container is specified as 1.85:1 (so
1530 that the DCP will play back correctly using the projector's
1531 &lsquo;Flat&rsquo; preset).  At 2K, 1.85:1 is 1998 pixels by 1080.
1532 Scaling the source up whilst preserving its 1.85:1 aspect ratio will
1533 result in the image hitting the sides of the container first, at a
1534 size of 1998 x 836.  This gives us a new version of the image as shown
1535 in <xref linkend="fig-pipeline3"/>.
1536 </para>
1537
1538 <figure id="fig-pipeline3">
1539   <title>Example image after cropping and scaling</title>
1540   <mediaobject>
1541     <imageobject>
1542        <imagedata scale="100" fileref="diagrams/pipeline3&dia;"/>
1543     </imageobject>
1544   </mediaobject>
1545 </figure>
1546
1547 <para>
1548 The final step is to place the image into the DCP.  In this case,
1549 since we have a 2.39:1 image that should be presented as a 1.85:1 DCP,
1550 we have set the <guilabel>container</guilabel> in the
1551 <guilabel>DCP</guilabel> tab to be Scope.  Since the content has been
1552 scaled to 1998 x 836, and a Flat container is 1998 x 1080, there will
1553 be some black bars at the top and bottom of the image.  DCP-o-matic
1554 shares out this black equally, as shown in <xref
1555 linkend="fig-pipeline3"/>.
1556 </para>
1557
1558 <figure id="fig-pipeline4">
1559   <title>Example image in the DCP</title>
1560   <mediaobject>
1561     <imageobject>
1562        <imagedata scale="100" fileref="diagrams/pipeline4&dia;"/>
1563     </imageobject>
1564   </mediaobject>
1565 </figure>
1566
1567 </section>
1568
1569
1570 <section>
1571   <title>Copy and paste settings</title>
1572
1573 <para>
1574 Once you have set up a piece of content it is possible to copy the
1575 settings you have applied to another piece of content.  To do this,
1576 select the content to copy from and choose <guilabel>Copy</guilabel>
1577 from the <guilabel>Edit</guilabel> menu.  Then select the content to
1578 copy to and choose <guilabel>Paste</guilabel>.  A dialogue box will
1579 open to allow you to choose which settings you want to copy.  Clicking
1580 <guilabel>OK</guilabel> will apply the copied settings.
1581 </para>
1582
1583 </section>
1584
1585
1586 </chapter>
1587
1588
1589 <!-- ============================================================== -->
1590 <chapter xml:id="ch-dcp" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
1591 <title>DCP settings</title>
1592
1593 <para>
1594 This chapter describes the settings that apply to the whole DCP.  The
1595 controls for these settings are in the <guilabel>DCP</guilabel> tab of
1596 the main window, as shown in <xref linkend="fig-dcp-tab"/>.
1597 </para>
1598
1599 <figure id="fig-dcp-tab">
1600   <title>DCP settings tab</title>
1601   <mediaobject>
1602     <imageobject>
1603        <imagedata fileref="screenshots/dcp-tab&scs;"/>
1604     </imageobject>
1605   </mediaobject>
1606 </figure>
1607
1608 <para>
1609 The first thing here is the name.  This is generally set to the title
1610 of the film that is being encoded.  If <guilabel>Use ISDCF
1611 name</guilabel> is not ticked, the name that you specify will be used
1612 as-is for the name of the DCP.  If <guilabel>Use ISDCF name</guilabel>
1613 is ticked, the name that you enter will be used as part of a
1614 ISDCF-compliant name.
1615 </para>
1616
1617 <para>
1618 Underneath the name field is a preview of the name that the DCP will
1619 get.  To use a ISDCF-compliant name, tick the <guilabel>Use ISDCF
1620 name</guilabel> check-box.  The ISDCF name will be composed using details
1621 of your content's soundtrack, the current date and other things that
1622 can be specified in the ISDCF name details dialogue box, which you can
1623 open by clicking on the <guilabel>Details</guilabel> button.
1624 </para>
1625
1626 <para>
1627 If you want to take the ISDCF-compliant name that DCP-o-matic
1628 generates and modify it, click <guilabel>Copy as name</guilabel> and
1629 the ISDCF name will be copied into the <guilabel>Name</guilabel> box.
1630 You can then edit it as you wish.  The DCP name should not matter (in
1631 that it should not affect how the DCP ingests or plays) but
1632 projectionists will appreciate it if you use the standard naming
1633 scheme as it makes it easier to identify details of the content.
1634 </para>
1635
1636 <para>
1637 The <guilabel>Content Type</guilabel> option can be
1638 &lsquo;feature&rsquo;, &lsquo;trailer&rsquo; or whatever; select the
1639 required type from the drop-down list.  On some projection systems
1640 this will affect where your content appears in the projector's server
1641 user interface, so take care to select an appropriate type.
1642 </para>
1643
1644 <para>
1645 The <guilabel>Signed</guilabel> check-box sets whether or not the DCP
1646 is signed.  This is rarely important; if in doubt, tick it.
1647 </para>
1648
1649 <para>
1650 The <guilabel>Encrypted</guilabel> check-box will set whether the DCP
1651 should be encrypted or not.  If this is ticked, the DCP will require a
1652 KDM to play back.  Encryption is discussed in <xref
1653 linkend="ch-encryption"/>.
1654 </para>
1655
1656 <para>
1657 If you use encryption DCP-o-matic will generate a random encryption
1658 key for you.  To specify your own key, click the
1659 <guilabel>Edit..</guilabel> button next to the key.
1660 </para>
1661
1662 <para>
1663 The <guilabel>Reels</guilabel> and <guilabel>Reel length</guilabel>
1664 controls specify how the DCP will be split up into
1665 &lsquo;reels&rsquo;.  See <xref linkend="sec-reels"/> below.
1666 </para>
1667
1668 <para>
1669 The <guilabel>Standard</guilabel> option specifies which of the two
1670 DCP standards DCP-o-matic should use.  If in doubt, use SMPTE (the
1671 more modern of the two).
1672 </para>
1673
1674 <para>
1675 Ticking the <guilabel>Upload DCP to TMS after it is made</guilabel>
1676 will ask DCP-o-matic to copy the finished DCP to your configured TMS (see <xref linkend="sec-prefs-tms"/>).
1677 </para>
1678
1679 <para>
1680 At the bottom of the DCP tab are a further two tabs, one each to
1681 contain the settings for the DCP's video and audio parts.
1682 </para>
1683
1684 <para>
1685 The <guilabel>Container</guilabel> option sets the ratio of the image
1686 in the DCP.  If this ratio is different to the ratio used for any
1687 content, DCP-o-matic will pad the content with black.  In simple cases
1688 this should be set to the same ratio as that for the the primary piece
1689 of video content.  Alternatively, you might want to pillarbox a small
1690 format into a Flat container: in this case, select the small format
1691 for the content's ratio and &lsquo;Flat&rsquo; for the DCP.
1692 </para>
1693
1694 <para>
1695 The <guilabel>Frame Rate</guilabel> control sets the frame rate of
1696 your DCP.  This can be a little tricky to get right.  Ideally, you
1697 want it to be the same as the video content that you are using.  If it
1698 is not the same, DCP-o-matic must resort to some tricks to alter your
1699 content to fit the specified frame rate.  Frame rates are discussed in
1700 more detail in <xref linkend="ch-frame-rates"/>.
1701 </para>
1702
1703 <para>
1704 The <guilabel>Use best</guilabel> button sets the DCP video frame rate
1705 to what DCP-o-matic thinks is the best given the content that you have
1706 added.
1707 </para>
1708
1709 <para>
1710 The <guilabel>3D</guilabel> button will set your DCP to 3D mode if it
1711 is checked.  A 3D DCP will then be created, and any 2D content will be
1712 made 3D compatible by repeating the same frame for both left and right
1713 eyes.  A 3D DCP can be played back on many 3D systems (e.g. Dolby 3D,
1714 Real-D etc.) but not on a 2D system.
1715 </para>
1716
1717 <para>
1718 The <guilabel>Resolution</guilabel> tab allows you to choose the
1719 resolution for your DCP.  Use 2K unless you have content that is of
1720 high enough resolution to be worth presenting in 4K.
1721 </para>
1722
1723 <para>
1724 The <guilabel>JPEG2000 bandwidth</guilabel>; setting changes how big
1725 the final image files used within the DCP will be.  Larger numbers
1726 will give better quality, but correspondingly larger DCPs.  The
1727 bandwidth can be between 50 and 250 megabits per second (Mbit/s).
1728 Most commercial DCPs use bit rates between 75 and 125 Mbit/s.
1729 </para>
1730
1731 <para>
1732 The <guilabel>Audio Channels</guilabel> control sets the number of
1733 audio channels that the DCP will have.  If the DCP has any channels
1734 for which there is no content audio they will be replaced by silence.
1735 You can only set an even number of channels here, since that is
1736 required by the DCI standard.  If you want an odd number of channels,
1737 set the DCP channel count to one greater than you need and the
1738 unused channel will be filled with silence.
1739 </para>
1740
1741 <para>
1742 The <guilabel>Processor</guilabel> control allows you to select a
1743 process to apply to the audio before it goes into the DCP.  Three processes are currently provided:
1744 </para>
1745
1746 <itemizedlist>
1747 <listitem>Mid-side decode &mdash; this will take a L/R
1748 stereo input and extract the common part (corresponding to the
1749 &lsquo;Mid&rsquo; in a mid-side signal) into the DCP's centre channel.
1750 The remaining L/R parts will be kept in the L/R channels of the DCP.
1751 This may be useful to make near-field L/R mixes more compatible with
1752 cinema audio systems.</listitem>
1753 <listitem>Stereo to 5.1 up-mixer A &mdash; this will take a stereo input and up-mix it to &lsquo;fake&rsquo; 5.1.  The input L/R are treated as follows:
1754 <itemizedlist>
1755 <listitem>DCP L is input L bandpass-filtered between 1.9kHz and 4.8kHz.</listitem>
1756 <listitem>DCP R is input R bandpass-filtered between 1.9kHz and 4.8kHz.</listitem>
1757 <listitem>DCP C is input L mixed with input R, taken down by 3dB and then bandpass-filtered between 150Hz and 1.9kHz.</listitem>
1758 <listitem>DCP Lfe is input L mixed with input R, taken down by 3dB and then bandpass-filtered between 20Hz and 150Hz.</listitem>
1759 <listitem>DCP Ls is input L bandpass-filtered between 4.8kHz and 20kHz.</listitem>
1760 <listitem>DCP Rs is input R bandpass-filtered between 4.8kHz and 20kHz.</listitem>
1761 </itemizedlist>
1762 <para>
1763 This upmixing algorithm is due to GĂ©rald Maruccia.
1764 </para>
1765 </listitem>
1766 <listitem>Stereo to 5.1 up-mixer B &mdash; this uses a different approach:
1767 <itemizedlist>
1768   <listitem>DCP L is input L.</listitem>
1769   <listitem>DCP R is input R.</listitem>
1770   <listitem>DCP C is input L + input R taken down by 3dB.</listitem>
1771   <listitem>DCP Lfe is DCP C bandpass filtered between 20Hz and 150Hz.</listitem>
1772   <listitem>DCP Ls and Rs are input L - input R with a 20ms delay.</listitem>
1773 </itemizedlist>
1774 </listitem>
1775 </itemizedlist>
1776
1777 <!-- ============================================================== -->
1778 <section xml:id="sec-reels">
1779 <title>Reels</title>
1780
1781 <para>
1782 A &lsquo;reel&rsquo; in a DCP is a subsection of the DCP, in the same
1783 way as a 35mm reel is a section of a film.  A DCP can be split up into
1784 any number of reels and the joins (the equivalent to 35mm splices)
1785 between the reels are seamless.
1786 </para>
1787
1788 <para>
1789 There is no reason why you can't just use a single reel for the whole
1790 of your DCP, as there is no limit on their length.  Many people choose
1791 to do this.
1792 </para>
1793
1794 <para>
1795 There are, however, some possible advantages of splitting things up
1796 into reels:
1797 </para>
1798
1799 <itemizedlist>
1800 <listitem>
1801 The picture, sound and subtitle data of the DCP will be
1802 split up into more smaller files on disk, rather than fewer larger
1803 files.  This can be useful if the DCP is to be transferred on storage
1804 that have file size limits.  The FAT32 filesystem, for example, can
1805 only hold files smaller than 4Gb.  A 6Gb DCP with a single reel could
1806 not be transferred using a FAT32-formatted disk.  If that DCP were
1807 split up into two 3Gb reels it could be transferred.
1808 </listitem>
1809 <listitem>
1810 It is easier to re-use DCP components if they are in reels.  Consider,
1811 for example, a film company who wants to put a 5 second ident onto the
1812 beginning of DCPs that they distribute.  If they receive a feature
1813 film DCP they can modify it to add their ident as a separate reel.
1814 This is easier than attaching the picture data in the DCP.
1815 </listitem>
1816 </itemizedlist>
1817
1818 <para>
1819 DCP-o-matic offers three options for setting up the reels in your DCP:
1820 single reel, split by video content or custom.
1821 </para>
1822
1823 <para>
1824 <guilabel>Single reel</guilabel>, as its name suggests, keeps the whole DCP as one reel.
1825 This is a perfectly good option if you have no particular reason to
1826 need reels.
1827 </para>
1828
1829 <para>
1830 <guilabel>Split by video content</guilabel> puts each piece of source
1831 video content in its own reel, as shown in <xref linkend="fig-reels-by-video"/>.
1832 </para>
1833
1834 <figure id="fig-reels-by-video">
1835 <title>Making reels using split by video content</title>
1836 <mediaobject><imageobject><imagedata scale="100" fileref="diagrams/reels-by-video&dia;"/></imageobject></mediaobject>
1837 </figure>
1838
1839 <para>
1840 Here we have three video files (<code>ident.mp4</code>,
1841 <code>feature.ts</code> and <code>cred.mov</code>).  With
1842 <guilabel>split by video content</guilabel> DCP-o-matic makes a new
1843 reel to hold each video file.
1844 </para>
1845
1846 <para>
1847 <guilabel>Custom</guilabel> splits reels by the size of the files that
1848 will make up their video content.  With <guilabel>Custom</guilabel>
1849 you must specify a reel length in Gb.  Then no file in the DCP will be larger than this reel length.
1850 </para>
1851
1852 </section>
1853
1854
1855 <!-- ============================================================== -->
1856 <section xml:id="sec-show-audio">
1857 <title>Show audio</title>
1858
1859 <para>
1860 The <guilabel>Show Audio</guilabel> button will instruct DCP-o-matic
1861 to examine the audio in your content and plot a graph of its level
1862 over time.  This can be useful for getting a rough idea of how loud
1863 the sound will be in the cinema auditorium.  A typical plot is shown
1864 in <xref linkend="fig-audio-plot"/>
1865 </para>
1866
1867 <figure id="fig-audio-plot">
1868   <title>Audio plot</title>
1869   <mediaobject>
1870     <imageobject>
1871        <imagedata fileref="screenshots/audio-plot&scs;"/>
1872     </imageobject>
1873   </mediaobject>
1874 </figure>
1875
1876 <para>
1877 The plot gives the audio level (vertical axis, in dB) with time
1878 (horizontal axis).  0dB represents full scale, so if there is anything
1879 near this you are in danger of clipping the projector's audio outputs.
1880 </para>
1881
1882 <para>
1883 There are two plot types: the peak level and the RMS, which can be
1884 shown or hidden using the check-boxes on the right hand side of the
1885 window.
1886 </para>
1887
1888 <para>
1889 The channel check-boxes will show or hide the plot(s) for
1890 the corresponding channels in the DCP.
1891 </para>
1892
1893 <para>
1894 The smoothing slider applies a variable degree of temporal smoothing
1895 to the plots, which can make them easier to read in some cases.
1896 </para>
1897
1898 <para>
1899 Obviously the audio plot is no substitute for listening in an
1900 auditorium, but it can be useful to get levels in the right rough area.
1901 </para>
1902
1903 </section>
1904
1905 </chapter>
1906
1907
1908 <!-- ============================================================== -->
1909 <chapter xml:id="ch-templates" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
1910 <title>Templates</title>
1911
1912 <para>
1913 If you frequently make DCPs with similar settings you may find it
1914 useful to use templates.
1915 </para>
1916
1917 <para>
1918 Say, for example, you often make 4K feature DCPs from video files in
1919 &rsquo;scope at 25fps.  You can speed up this process by following
1920 these steps:
1921 </para>
1922
1923 <itemizedlist>
1924   <listitem>Create a film with any content and set it up how you like;
1925   in our example, set the content to scale to DCP, the DCP resolution
1926   to 4K, and so on.</listitem>
1927   <listitem>Choose <guilabel>Save as template...</guilabel> from the <guilabel>File</guilabel> menu.</listitem>
1928   <listitem>Enter a name for your template.</listitem>
1929 </itemizedlist>
1930
1931 <para>
1932 Then in the future you can create a new film, tick the
1933 <guilabel>Template</guilabel> box and choose your previously-saved
1934 template.  The basic film's settings will come from your template, and
1935 when you add some content it will take on the settings of the
1936 first similarly-typed piece of content in your template.
1937 </para>
1938
1939 <para>
1940 For example if the template has a piece of video content and some
1941 subtitles, any video that you add to the new film will take on the
1942 settings of the video in the template.  Similarly, any subtitles that
1943 you add will take on the settings of the subtitles from the template.
1944 </para>
1945
1946 <para>
1947 The following settings from the <guilabel>DCP</guilabel> tab are saved
1948 in templates:
1949 </para>
1950
1951 <itemizedlist>
1952   <listitem>&ldquo;Use ISDCF name&rdquo; checkbox</listitem>
1953   <listitem>Content type (FTR, TLR etc.)</listitem>
1954   <listitem>Container</listitem>
1955   <listitem>Resolution</listitem>
1956   <listitem>JPEG200 bandwidth</listitem>
1957   <listitem>Video frame rate</listitem>
1958   <listitem>Signed and encrypted checkboxes</listitem>
1959   <listitem>Audio channels</listitem>
1960   <listitem>Standard (Interop / SMPTE)</listitem>
1961   <listitem>Audio processor</listitem>
1962   <listitem>Reel type and length</listitem>
1963   <listitem>Upload after make DCP checkbox</listitem>
1964 </itemizedlist>
1965
1966 <para>
1967 In addition to this, the settings (but not the filenames) of any
1968 content in the template are stored, as discussed above.  The status of
1969 the <guilabel>Keep video and subtitles in sequence</guilabel> checkbox
1970 from the timeline is also preserved.
1971 </para>
1972
1973 </chapter>
1974
1975
1976
1977 <!-- ============================================================== -->
1978 <chapter xml:id="ch-encryption" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
1979 <title>Encryption</title>
1980
1981 <para>
1982 It is not required that DCPs be encrypted, but they can be.  This
1983 chapter discusses the basic principles of DCP encryption, and how
1984 DCP-o-matic can create encrypted DCPs and KDMs for them.
1985 </para>
1986
1987
1988 <!-- ============================================================== -->
1989 <section>
1990 <title>Basics</title>
1991
1992 <para>
1993 DCPs can be encrypted.  This means that the picture and sound data are
1994 encoded in such a way that only cinemas &lsquo;approved&rsquo; by the
1995 DCP's creators can read them.  In particular, this means copies of the
1996 DCP can be distributed by insecure means: if an ne'er-do-well called
1997 Mallory obtains a hard drive containing an encrypted DCP, there is no
1998 way that he can play it.  Only those cinemas who receive a correct key
1999 delivery message (KDM) can play the DCP.
2000 </para>
2001
2002
2003 <!-- ============================================================== -->
2004 <section>
2005 <title>How it works</title>
2006
2007 <para>
2008 This section attempts to summarise how DCP encryption works.  You can
2009 skip it if you like.  You may need some knowledge of encryption
2010 methods to understand it.
2011 </para>
2012
2013 <para>
2014 We suppose that we are trying to send a DCP to
2015 Alice's cinema without a troublemaker called Mallory being able to
2016 watch it himself.
2017 </para>
2018
2019 <para>
2020 There are two main families of encryption techniques.  The first,
2021 symmetric-key encryption, allows us to encode some data using some
2022 numeric key.  After encoding, no-one can decode the data unless they
2023 know the key.
2024 </para>
2025
2026 <para>
2027 The first step in a DCP encryption is to encode its data with some key
2028 using symmetric-key encryption.  The encrypted DCP can then be sent
2029 anywhere, safe in the knowledge that even if Mallory got hold of a
2030 copy, he could not decrypt it.
2031 </para>
2032
2033 <para>
2034 Alice, however, needs to know the key so she can play the DCP in her
2035 cinema.  A simple approach might be for us to send Alice the key.
2036 However, if Mallory can intercept the DCP, he might also be able to
2037 intercept our communication of the key to Alice.  Furthermore, if Alice
2038 happened to know Mallory, she could just send him a copy of the key.
2039 </para>
2040
2041 <para>
2042 The clever bit in the process requires the use of public-key
2043 encryption.  With this technique we can encrypt a block of data using
2044 some &lsquo;public&rsquo; key.  That data can then only be decrypted
2045 using a corresponding private key which is
2046 <emphasis>different</emphasis> to the public key.  The private and
2047 public keys form a pair which are related mathematically, but it is
2048 extremely hard (or rather, virtually impossible) to derive the private
2049 key from the public key.
2050 </para>
2051
2052 <para>
2053 Public-key encryption allows us to distribute the DCP's key to Alice
2054 securely.  The manufacturer of Alice's projector generates a public
2055 and private key.  They hide the private key inside the projector where
2056 no-one can read it.  They then make the public key available to anyone
2057 who is interested.
2058 </para>
2059
2060 <para>
2061 DCP-o-matic has a similar arrangement except that it stores its
2062 private keys in the user's configuration file. See <xref
2063 linkend="sec-decrypting"/> for details of how to share DCP-o-matic's
2064 certificate so that others can make encrypted DCPs for DCP-o-matic.
2065 </para>
2066
2067 <para>
2068 We take our DCP's symmetric key and encrypt it using the public key of
2069 Alice's projector.  We send the result to Alice over email (using a
2070 format called a Key Delivery Message, or KDM).  Her projector then
2071 decrypts our message using its private key, yielding the magic
2072 symmetric key which can decrypt the DCP.
2073 </para>
2074
2075 <para>
2076 If is fine if Mallory intercepts our email to Alice, since the only
2077 key which can decrypt the message is the private key buried inside
2078 Alice's projector.  The projector manufacturer is very careful that
2079 no-one ever finds out what this key is.  Our DCP is secure: only Alice
2080 can play it back, since only her projector knows the key (even Alice
2081 does not).
2082 </para>
2083
2084 </section>
2085 </section>
2086
2087
2088 <!-- ============================================================== -->
2089 <section>
2090 <title>Encryption using DCP-o-matic</title>
2091
2092 <para>
2093 There are two steps to distributing an encrypted DCP.  First, the
2094 DCP's data must be encrypted, and secondly KDMs must be generated for
2095 those cinemas that are allowed to play the DCP.
2096 </para>
2097
2098 <para>
2099 The first part is simple: ticking the <guilabel>Encrypted</guilabel>
2100 box in the <guilabel>DCP</guilabel> tab will instruct DCP-o-matic to
2101 encrypt the DCP that it makes using a random key that DCP-o-matic
2102 generates.  The key will be written to the film's metadata file, which
2103 should be kept secure.
2104 </para>
2105
2106 <para>
2107 A DCP that is generated with the <guilabel>Encrypted</guilabel> box
2108 ticked will not play on any projector as-is (it will be marked as
2109 &lsquo;locked&rsquo;, or whatever the projector manufacturer's term
2110 is).
2111 </para>
2112
2113 <para>
2114 The second part of distributions is to generate KDMs for the cinemas
2115 that you wish to allow to play your DCP.  There are two approaches to
2116 this within DCP-o-matic: using the project, or using a DKDM.  These
2117 approaches are now described in turn.
2118 </para>
2119
2120 <section>
2121 <title>Creating KDMs from a DCP-o-matic project</title>
2122
2123 <para>
2124 You can create KDMs from inside a DCP-o-matic project using the
2125 <guilabel>Make KDMs</guilabel> option on the <guilabel>Jobs</guilabel>
2126 menu.  This will open the KDM dialogue box, as shown in <xref
2127 linkend="fig-kdm"/>.
2128 </para>
2129
2130 <figure id="fig-kdm">
2131   <title>KDM dialog</title>
2132   <mediaobject>
2133     <imageobject>
2134       <imagedata scale="40" fileref="screenshots/kdm&scs;"/>
2135     </imageobject>
2136   </mediaobject>
2137 </figure>
2138
2139 <para>
2140 In order to generate KDMs for a particular projector, you need to know
2141 its <emphasis>certificate</emphasis>.  These are usually made
2142 available by the projector manufacturers as text files with a
2143 <code>.pem</code> extension.
2144 </para>
2145
2146 <para>
2147 DCP-o-matic can store these certificates along with details of their
2148 cinemas and screens within those cinemas.  Each screen has a
2149 certificate for its projector (and optionally certificates for other
2150 trusted devices, such as the sound processor).  DCP-o-matic can
2151 generate KDMs for any screens that it knows about.
2152 </para>
2153
2154 <para>
2155 To add a cinema, click <guilabel>Add Cinema...</guilabel>.  This opens
2156 a dialogue box into which you can enter the cinema's name, and
2157 optionally an email address.  This email address can be used to
2158 get DCP-o-matic to deliver KDMs via email.
2159 </para>
2160
2161 <para>
2162 Once you have added a cinema, select it by clicking on its name, then
2163 click <guilabel>Add Screen...</guilabel>.  The resulting dialogue
2164 allows you to enter a name for the screen and load in its certificate
2165 from a file.  The certificate should be in SHA256 PEM format.
2166 </para>
2167
2168 <para>
2169 Alternatively, certificates for projection systems made by some
2170 manufacturers can be downloaded from databases provided by the
2171 manufacturer.  Currently this is supported for Doremi and Dolby
2172 equipment.  If you are targeting a screen with equipment by one of
2173 these manufacturers you can click <guilabel>Download</guilabel> then
2174 enter the serial number of the server in the screen and click
2175 <guilabel>Download</guilabel> again and, all being well, the certificate
2176 will be fetched.
2177 </para>
2178
2179 <para>
2180 Using the download system you will need to know the serial number of
2181 the media server in use in the screen.  Most cinema projection or
2182 technical departments will know these serial numbers.
2183 </para>
2184
2185 <para>
2186 Note that the reliability of the manufacturers' certificate databases
2187 cannot be guaranteed.  It is vital that KDMs are tested by the
2188 destination cinema will in advance of show time to identify any
2189 problems.
2190 </para>
2191
2192 <para>
2193 Once you have set up all the screens that you need KDMs for, select
2194 the CPL that you want to create the KDM for.  You can use the
2195 drop-down list to select the CPLs in the current film project, or load
2196 a CPL from somewhere else.  Select the cinemas and/or screens that you
2197 want KDMs for and fill in the start and end dates and times.
2198 </para>
2199
2200 <para>
2201 You must also select the type of KDM that you want to generate.  If in
2202 doubt, use <guilabel>Modified Transitional 1</guilabel>.
2203 </para>
2204
2205 <note>
2206 The differences between the three KDM types are fairly subtle.
2207 <guilabel>DCI Specific</guilabel> and <guilabel>DCI Any</guilabel> add
2208 a <code>&lt;ContentAuthenticator&gt;</code> tag to the KDM which
2209 allows the exhibitor to check that the DCP and KDM have come from a
2210 bona-fide source.  In addition, <guilabel>DCI Specific</guilabel> adds
2211 information on trusted devices to the KDM.  This allows the KDM
2212 creator to specify devices (such as sound processors) that are allowed
2213 to use keys delivered by the KDM.  At present it is not clear how
2214 widely the <guilabel>DCI Specific</guilabel> and <guilabel>DCI
2215 Any</guilabel> features are supported (or even tolerated) by servers
2216 so you are advised to use <guilabel>Modified Transitional
2217 1</guilabel>.
2218 </note>
2219
2220 <para>
2221 Finally, choose what you want to do with the KDMs.  They can be
2222 written to disk, to a location that you can specify by clicking
2223 <guilabel>Browse</guilabel>.  Alternatively, if you choose
2224 <guilabel>Send by email</guilabel> the KDMs will be zipped up and
2225 emailed to the appropriate cinema email addresses.  Click
2226 <guilabel>Make KDMs</guilabel> to generate the KDMs.
2227 </para>
2228
2229 </section>
2230
2231 <section>
2232 <title>Creating KDMs using a DKDM</title>
2233 </section>
2234
2235 <para>
2236 It can be inconvenient to need a whole DCP-o-matic project just to
2237 create KDMs for its film.  Perhaps you want to archive the project to
2238 save space, or create KDMs on a different machine.  In such situations
2239 it is easier to use a DKDM.  This is a normal KDM, but instead of
2240 being targeted at a projection system (to allow it to decrypt the
2241 content) it is targeted at a particular user's certificate.  This
2242 means that the certificate owner can create new KDMs for other users.
2243 The DKDM holds everything that is required to create further KDMs.
2244 </para>
2245
2246 <para>
2247 Sometimes it is useful to create DKDMs that can be used by
2248 DCP-o-matic.  If you create such a DKDM you can keep it and then, at
2249 any point in the future, use DCP-o-matic's standalone KDM creator to
2250 make KDMs for the DKDM's film for any cinema.
2251 </para>
2252
2253 <para>
2254 In other cases a DKDM is sent to a 3rd party so that they can create
2255 KDMs for your films.  This can be useful if, for example, you have a
2256 distributor who provides 24-hour KDM support to cinemas and can create
2257 KDMs for anybody that requires them at short notice.
2258 </para>
2259
2260 <para>
2261 To create a DKDM for DCP-o-matic, open your encrypted project and
2262 select <guilabel>Make DKDM for DCP-o-matic...</guilabel> from the
2263 <guilabel>Jobs</guilabel> menu.  Select the CPL that you want to make
2264 the DKDM for and click <guilabel>OK</guilabel>.  This DKDM will then
2265 be available in the KDM creator.  This is a separate program which you
2266 can start from the same place that you start the &lsquo;normal&rsquo;
2267 DCP-o-matic.  Its window is shown in <xref linkend="fig-kdm-creator"/>.
2268 </para>
2269
2270 <figure id="fig-kdm-creator">
2271   <title>The KDM creator</title>
2272   <mediaobject>
2273     <imageobject>
2274       <imagedata scale="35" fileref="screenshots/kdm-creator&scs;"/>
2275     </imageobject>
2276   </mediaobject>
2277 </figure>
2278
2279 <para>
2280 To create KDMs, select the cinema(s) and/or screens that you want KDMs
2281 to be created for, the date range, the DCP that the KDMs are for and
2282 the destination for the KDMs and click <guilabel>Create
2283 KDMs</guilabel>.
2284 </para>
2285
2286 <para>
2287 By default the <guilabel>DKDM</guilabel> list will list any DCPs for
2288 which you have clicked <guilabel>Make DKDM for
2289 DCP-o-matic</guilabel>in the main DCP-o-matic program.  If you have
2290 other DKDMs you can add them by clicking <guilabel>Add...</guilabel> and
2291 specifying the file containing the DKDM.
2292 </para>
2293
2294 <para>
2295 If another organisation wants to send you a DKDM they will ask you for
2296 a target certificate.  You can get DCP-o-matic's target certificate by
2297 opening <guilabel>Preferences</guilabel> and clicking <guilabel>Export
2298 DCP decryption certificate...</guilabel> in the <guilabel>Keys</guilabel>
2299 tab.
2300
2301 </para>
2302
2303 </section>
2304
2305 <section>
2306 <title>Encryption keys</title>
2307
2308 <para>
2309   You must be careful when using encryption not to lose important keys.
2310 </para>
2311
2312 <para>
2313 If you are making KDMs from a DCP-o-matic film you
2314 <emphasis>must</emphasis> ensure that you have a backup of the
2315 <code>metadata.xml</code> file from the project, as well as the DCP
2316 itself.
2317 </para>
2318
2319 <para>
2320 If you are using a DKDM you <emphasis>must</emphasis> ensure that you
2321 have a backup of DCP-o-matic's <code>config.xml</code> file, since it
2322 contains the only key which can decrypt the DKDM.  The
2323 <code>config.xml</code> file location depends on your operating
2324 system; possible locations are listed in <xref linkend="ch-config"/>
2325 </para>
2326
2327 </section>
2328
2329 <section>
2330 <title>Encryption overview</title>
2331
2332 <figure id="fig-encryption-overview">
2333   <title>Overview of encryption</title>
2334   <mediaobject>
2335     <imageobject>
2336       <imagedata fileref="diagrams/crypt&dia;"/>
2337     </imageobject>
2338   </mediaobject>
2339 </figure>
2340
2341 </section>
2342 </chapter>
2343
2344
2345
2346 <!-- ============================================================== -->
2347 <chapter xml:id="ch-preferences" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
2348 <title>Preferences</title>
2349
2350 <para>
2351 DCP-o-matic provides a few preferences which can be used to modify its
2352 behaviour.  This chapter explains those options.
2353 </para>
2354
2355 <para>
2356 Preferences can be edited by choosing
2357 <guilabel>Preferences...</guilabel> from the <guilabel>Edit</guilabel>
2358 menu.  This opens a dialogue which is split into seven tabs.
2359 </para>
2360
2361 <!-- ============================================================== -->
2362 <section>
2363 <title>General</title>
2364
2365 <para>
2366 The general tab is shown in <xref linkend="fig-prefs-general"/>.
2367 </para>
2368
2369 <figure id="fig-prefs-general">
2370   <title>General preferences</title>
2371   <mediaobject>
2372     <imageobject>
2373       <imagedata fileref="screenshots/prefs-general&scs;"/>
2374     </imageobject>
2375   </mediaobject>
2376 </figure>
2377
2378
2379 <!-- ============================================================== -->
2380 <section>
2381 <title>Language</title>
2382
2383 <para>
2384 If you tick the <guilabel>Set Language</guilabel> checkbox and choose
2385 a language from the list, that language will be used for DCP-o-matic.
2386 You will need to restart DCP-o-matic to see the new language.
2387 </para>
2388
2389 <para>
2390 The translations for DCP-o-matic have been contributed by helpful
2391 users.  If your language is not on the last, head to <ulink
2392 url="http://dcpomatic.com/i18n.php">the DCP-o-matic website</ulink> to
2393 read about how to contribute a translation.
2394 </para>
2395 </section>
2396
2397
2398 <!-- ============================================================== -->
2399 <section>
2400 <title>Number of threads DCP-o-matic should use</title>
2401
2402 <para>
2403 When DCP-o-matic is encoding DCPs it can use multiple parallel threads
2404 to speed things up.  Set this value to the number of threads
2405 DCP-o-matic should use.  This should normally be the number of
2406 processors (or processor cores) in your machine.  DCP-o-matic will try
2407 to set this up correctly when you run it for the first time.
2408 </para>
2409
2410 </section>
2411
2412
2413 <!-- ============================================================== -->
2414 <section>
2415 <title>Number of threads DCP-o-matic encode server should use</title>
2416
2417 <para>
2418 This is the number of threads that the encode server should use when
2419 it is running and helping another copy of DCP-o-matic to speed up its
2420 encode.
2421 </para>
2422
2423 </section>
2424
2425
2426 <!-- ============================================================== -->
2427 <section>
2428 <title>Configuration file</title>
2429
2430 <para>
2431 This is the location of DCP-o-matic's configuration file on disk.  You
2432 can use this to share configuration between several copies of
2433 DCP-o-matic, across a network share, for instance.
2434 </para>
2435 </section>
2436
2437 <!-- ============================================================== -->
2438 <section>
2439 <title>Cinema and screen database file</title>
2440
2441 <para>
2442 This option allows you to change the file that DCP-o-matic uses to
2443 store details of the cinemas and screens used to make KDMs.
2444 </para>
2445 </section>
2446
2447
2448 <!-- ============================================================== -->
2449 <section>
2450 <title>Play sound via</title>
2451
2452 <para>
2453 The checkbox to the left of <guilabel>Play sound</guilabel> enables or
2454 disables DCP-o-matic use of sound.  On some machines there will be
2455 multiple options in the drop-down menu to decide how the sound should
2456 be played.
2457 </para>
2458 </section>
2459
2460 <!-- ============================================================== -->
2461 <section>
2462 <title>Integrated loudness</title>
2463
2464 <para>
2465 If <guilabel>Find integrated loudness, true peak and loudness range
2466 when analysing audio</guilabel> is ticked, DCP-o-matic will do extra
2467 work when analysing audio.  Leave this ticked if the extra parameters
2468 are useful to you.  If not, untick it and audio analysis will be
2469 faster.
2470 </para>
2471
2472 </section>
2473
2474 <!-- ============================================================== -->
2475 <section>
2476 <title>Automatically analyse content audio</title>
2477
2478 <para>
2479 If this checkbox is ticked an audio analysis will be run whenever content is added that contains sound.
2480 </para>
2481 </section>
2482
2483 <!-- ============================================================== -->
2484 <section>
2485 <title>Updates</title>
2486
2487 <para>
2488 The <guilabel>Check for updates on startup</guilabel> option, if
2489 enabled, will tell DCP-o-matic to check on <ulink
2490 url="http://dcpomatic.com/">dcpomatic.com</ulink> to see if there any
2491 newer versions of DCP-o-matic then the one you are running.  If so, a
2492 dialogue box will open with a link to download the new version.
2493 available
2494 </para>
2495
2496 <para>
2497 The <guilabel>Check for testing updates as well as stable
2498 ones</guilabel> option will also check for test updates as well as
2499 those that are formally &lsquo;released&rsquo;. This is useful if you
2500 like to live on the bleeding edge!
2501 </para>
2502 </section>
2503
2504 <!-- ============================================================== -->
2505 <section>
2506 <title>Issuer and creator</title>
2507
2508 <para>
2509 With these controls you can set the issuer and creator strings that
2510 will be put into the DCPs which you create.
2511 </para>
2512 </section>
2513
2514 </section>
2515
2516 <!-- ============================================================== -->
2517 <section>
2518 <title>Defaults</title>
2519
2520 <para>
2521 The defaults tab is shown in <xref linkend="fig-prefs-defaults"/>.
2522 </para>
2523
2524 <figure id="fig-prefs-defaults">
2525   <title>Defaults preferences</title>
2526   <mediaobject>
2527     <imageobject>
2528       <imagedata fileref="screenshots/prefs-defaults&scs;"/>
2529     </imageobject>
2530   </mediaobject>
2531 </figure>
2532
2533 <para>
2534 The options in this tab simply allow you to set up default values for
2535 various properties of new films.
2536 </para>
2537
2538 </section>
2539
2540 <!-- ============================================================== -->
2541 <section>
2542 <title>Servers</title>
2543
2544 <para>
2545 The servers tab is shown in <xref linkend="fig-prefs-servers"/>.
2546 </para>
2547
2548 <figure id="fig-prefs-servers">
2549   <title>Servers preferences</title>
2550   <mediaobject>
2551     <imageobject>
2552       <imagedata fileref="screenshots/prefs-servers&scs;"/>
2553     </imageobject>
2554   </mediaobject>
2555 </figure>
2556
2557 <para>
2558 If <guilabel>Use all servers</guilabel> is ticked DCP-o-matic will
2559 locate encoding servers automatically (see <xref
2560 linkend="ch-servers"/>).
2561 </para>
2562
2563 <para>
2564 Instead of this (or in addition) servers can be specified explicitly.
2565 To add a server, click <guilabel>Add...</guilabel> and enter the host
2566 name or IP address of the server to use.
2567 </para>
2568
2569 </section>
2570
2571
2572 <!-- ============================================================== -->
2573 <section xml:id="sec-prefs-keys">
2574 <title>Keys</title>
2575
2576 <para>
2577 The Keys tab (shown in <xref linkend="fig-prefs-keys"/>) has controls
2578 related to the keys and certificates used in some parts of DCP
2579 creation.
2580 </para>
2581
2582 <figure id="fig-prefs-keys">
2583   <title>Keys preferences</title>
2584   <mediaobject>
2585     <imageobject>
2586       <imagedata fileref="screenshots/prefs-keys&scs;"/>
2587     </imageobject>
2588   </mediaobject>
2589 </figure>
2590
2591 <para>
2592 <guilabel>Export KDM decryption certificate...</guilabel> allows you
2593 to save the certificate that DCP-o-matic uses when decrypting KDMs
2594 that you give it.  Use this option if somebody wants to make a KDM for
2595 you and asks for your certificate.
2596 </para>
2597
2598 <para>
2599 <guilabel>Export KDM decryption chain...</guilabel> exports the whole
2600 KDM decryption chain rather than just its certificate.  This may also
2601 be requested by KDM creators.
2602 </para>
2603
2604 <para>
2605 <guilabel>Export all KDM decryption settings...</guilabel> exports a
2606 file which contains all the DCP-o-matic settings related to the use of
2607 KDMs supplied by other people.  Use this button and <guilabel>Import
2608 all KDM decryption settings...</guilabel> to transfer settings between
2609 different copies of DCP-o-matic so that they can both use the same
2610 KDMs.
2611 </para>
2612
2613 <para>
2614 The two <guilabel>Advanced...</guilabel> buttons open advanced
2615 dialogue boxes for detailed manipulation of DCP-o-matic's certificate
2616 chains.
2617 </para>
2618
2619 </section>
2620
2621 <section>
2622 <title>Advanced keys settings</title>
2623
2624 <para>
2625 At the top of the <guilabel>Advanced</guilabel> dialogue for signing
2626 DCPs and KDMs is the chain of certificates that will be used to sign
2627 DCPs and KDMs.  DCP-o-matic creates a random chain when you first run
2628 it and if you are happy to use this chain you can ignore the
2629 preferences.  Otherwise, you can add or remove certificates from the
2630 chain using the <guilabel>Add...</guilabel> and
2631 <guilabel>Remove</guilabel> buttons.
2632 </para>
2633
2634 <para>
2635 If you want DCP-o-matic to re-create the certificate chain (using new,
2636 random certificates) click <guilabel>Re-make
2637 certificates...</guilabel> and specify your organisation and common
2638 names in the dialogue box that opens.
2639 </para>
2640
2641 <para>
2642 Underneath the certificate chain is the private key that corresponds
2643 to the leaf certificate in the chain.  You can specify your own
2644 private key by clicking <guilabel>Load...</guilabel>.  You must do
2645 this if you change the leaf certificate, so that the leaf private key
2646 corresponds to the public key held in the leaf certificate.
2647 </para>
2648
2649 <para>
2650 At the top of the <guilabel>Advanced</guilabel> dialogue for decrypting DCPs is the chain and key which is used by
2651 DCP-o-matic when you import an encrypted DCP as a piece of content.
2652 The leaf certificate of this chain contains the public key that should
2653 be used when targeting a KDM at DCP-o-matic.
2654 </para>
2655
2656
2657 <para>
2658 If you want to import an encrypted DCP you will need to give the
2659 decryption certificate to the distributor of the DCP so that they can
2660 generate a DKDM for you.  You can save this certificate to disk by
2661 clicking <guilabel>Export DCP decryption certificate...</guilabel>.
2662 As with the signing chain, DCP-o-matic will create a certificate chain
2663 and private key for you.  You can also choose to load your own
2664 certificates and key or re-make the chain and key with new, random
2665 values.
2666 </para>
2667
2668 <para>
2669 Clicking <guilabel>Export DCP decryption chain...</guilabel> will
2670 export the whole certificate chain, rather than just the leaf
2671 certificate.
2672 </para>
2673
2674 </section>
2675
2676 <!-- ============================================================== -->
2677 <section xml:id="sec-prefs-tms">
2678 <title>TMS</title>
2679 <titleabbrev xml:id="sec-prefs-tms-short">TMS preferences</titleabbrev>
2680
2681 <para>
2682 The TMS tab (shown in <xref linkend="fig-prefs-tms"/>) gives some
2683 options for specifying details about your theatre management system
2684 (TMS).  If you do this, and your TMS accepts SSH or FTP connections,
2685 you can upload DCPs directly from DCP-o-matic to the TMS using the
2686 <guilabel>Send DCP to TMS</guilabel> option in the
2687 <guilabel>Jobs</guilabel> menu.
2688 </para>
2689
2690 <figure id="fig-prefs-tms">
2691   <title>TMS preferences</title>
2692   <mediaobject>
2693     <imageobject>
2694       <imagedata fileref="screenshots/prefs-tms&scs;"/>
2695     </imageobject>
2696   </mediaobject>
2697 </figure>
2698
2699 <para>
2700 <guilabel>Protocol</guilabel> should be set to SCP or FTP as
2701 appropriate for your TMS.  We know that the Arts Alliance Media (AAM)
2702 and the Doremi ranges uses SCP connections, and that Dolby's TMSs use
2703 FTP.  Do let us know if you use any other type of TMS with the
2704 <guilabel>Send DCP to TMS</guilabel> feature.
2705 </para>
2706
2707 <para>
2708 <guilabel>TMS IP address</guilabel> should be set to the IP address of
2709 your TMS, <guilabel>TMS target path</guilabel> to the place that DCPs
2710 should be uploaded to (which will be relative to the home directory of
2711 the SSH or FTP user).  Finally, the user name and password are the
2712 credentials required to log into the TMS via SSH or FTP.
2713 </para>
2714
2715 <para>
2716 Note that for this to work on Doremi servers you will need to set the
2717 <code>PasswordAuthentication</code> option in your server's
2718 <code>sshd_config</code> to <code>yes</code>.
2719 </para>
2720
2721 </section>
2722
2723
2724 <!-- ============================================================== -->
2725 <section>
2726 <title>KDM email</title>
2727
2728 <para>
2729 The KDM email is shown in <xref linkend="fig-prefs-kdm-email"/>.
2730 </para>
2731
2732 <figure id="fig-prefs-kdm-email">
2733   <title>KDM email preferences</title>
2734   <mediaobject>
2735     <imageobject>
2736       <imagedata fileref="screenshots/prefs-kdm-email&scs;"/>
2737     </imageobject>
2738   </mediaobject>
2739 </figure>
2740
2741 <para>
2742 This is a template for the email that is used to send KDMs out to
2743 cinemas.  You can change it to say whatever you like.  A few
2744 &lsquo;magic&rsquo; strings will be replaced by information from the
2745 KDM that is being sent:
2746 </para>
2747
2748 <table>
2749 <title>&lsquo;Magic&rsquo; KDM strings</title>
2750 <tgroup cols='2' align='left' colsep='1' rowsep='1'>
2751 <tbody>
2752 <row>
2753 <entry><code>$CPL_NAME</code></entry><entry>DCP title</entry>
2754 </row>
2755 <row>
2756 <entry><code>$CINEMA_NAME</code></entry><entry>Cinema name</entry>
2757 </row>
2758 <row>
2759 <entry><code>$SCREENS</code></entry><entry>Name of screen or screens that KDMs are being generated for</entry>
2760 </row>
2761 <row>
2762 <entry><code>$START_TIME</code></entry><entry>The time from which the KDMs are valid</entry>
2763 </row>
2764 <row>
2765 <entry><code>$END_TIME</code></entry><entry>The time until which the KDMs are valid</entry>
2766 </row>
2767 </tbody>
2768 </tgroup>
2769 </table>
2770
2771 <para>
2772 The <guilabel>Reset to default text</guilabel> will replace the current KDM email with DCP-o-matic's default.
2773 </para>
2774
2775 </section>
2776
2777
2778 <!-- ============================================================== -->
2779 <section>
2780 <title>Cover sheet</title>
2781
2782 <para>
2783 The DCP cover sheet configuration is shown in <xref linkend="fig-prefs-cover-sheet"/>.
2784 </para>
2785
2786 <figure id="fig-prefs-cover-sheet">
2787   <title>DCP cover sheet preferences</title>
2788   <mediaobject>
2789     <imageobject>
2790       <imagedata fileref="screenshots/prefs-cover-sheet&scs;"/>
2791     </imageobject>
2792   </mediaobject>
2793 </figure>
2794
2795 <para>
2796 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
2797 &lsquo;magic&rsquo; strings will be replaced by information from the
2798 DCP that has been made:
2799 </para>
2800
2801 <table>
2802 <title>&lsquo;Magic&rsquo; Cover sheet strings</title>
2803 <tgroup cols='2' align='left' colsep='1' rowsep='1'>
2804 <tbody>
2805 <row>
2806 <entry><code>$CPL_NAME</code></entry><entry>DCP title</entry>
2807 </row>
2808 <row>
2809 <entry><code>$TYPE</code></entry><entry>DCP content type (e.g. feature, trailer...)</entry>
2810 </row>
2811 <row>
2812 <entry><code>$CONTAINER</code></entry><entry>The container ratio (e.g. flat, scope...)</entry>
2813 </row>
2814 <row>
2815 <entry><code>$AUDIO</code></entry><entry>Details of the audio channels</entry>
2816 </row>
2817 <row>
2818 <entry><code>$AUDIO_LANGUAGE</code></entry><entry>Audio language</entry>
2819 </row>
2820 <row>
2821 <entry><code>$SUBTITLE_LANGUAGE</code></entry><entry>Subtitle language</entry>
2822 </row>
2823 <row>
2824 <entry><code>$LENGTH</code></entry><entry>DCP length in hours, minutes and seconds</entry>
2825 </row>
2826 <row>
2827 <entry><code>$SIZE</code></entry><entry>DCP size in gigabytes</entry>
2828 </row>
2829 </tbody>
2830 </tgroup>
2831 </table>
2832
2833 <para>
2834 The <guilabel>Reset to default text</guilabel> will replace the current cover sheet with DCP-o-matic's default.
2835 </para>
2836
2837 </section>
2838
2839
2840 <!-- ============================================================== -->
2841 <section xml:id="sec-prefs-advanced">
2842 <title>Advanced</title>
2843 <titleabbrev xml:id="sec-prefs-advanced-short">Advanced preferences</titleabbrev>
2844
2845 <para>
2846 The advanced preferences are shown in <xref linkend="fig-prefs-advanced"/>.
2847 </para>
2848
2849 <figure id="fig-prefs-advanced">
2850   <title>Advanced preferences</title>
2851   <mediaobject>
2852     <imageobject>
2853       <imagedata fileref="screenshots/prefs-advanced&scs;"/>
2854     </imageobject>
2855   </mediaobject>
2856 </figure>
2857
2858 <para>
2859 <guilabel>Maximum JPEG2000 bandwidth</guilabel> specifies the maximum
2860 bit-rate of JPEG2000 that DCP-o-matic will allow you to create.  You
2861 are advised to leave this at 250Mbit/s in normal use for maximum DCP
2862 compatibility.
2863 </para>
2864
2865 <para>
2866 <guilabel>Allow any DCP frame rate</guilabel> removes the limits on
2867 the DCP video frame rates that DCP-o-matic will create.  This may be
2868 useful for experimentation.  Again, you are strongly advised to leave
2869 this unticked for normal use.
2870 </para>
2871
2872 <para>
2873 <guilabel>Only servers encode</guilabel> makes DCP-o-matic encode
2874 JPEG2000 data only on encoding servers and not on the host.  We
2875 suggest you leave this unticked unless you have a good reason to do otherwise.
2876 </para>
2877
2878 <para>
2879 With the filename format fields you can adjust the filenames that are
2880 used for metadata (CPL and PKL files) and assets (MXF and subtitle
2881 files).  Below each field there is a list of the &lsquo;magic&rsquo;
2882 values that you can use in the format and an example of a filename
2883 that you might see with your current settings.
2884 </para>
2885
2886 <para>
2887 The four checkboxes labelled <guilabel>Log</guilabel> control what
2888 sort of messages DCP-o-matic writes to its log file when creating a
2889 DCP.  It is useful to leave <guilabel>General</guilabel>,
2890 <guilabel>Warnings</guilabel> and <guilabel>Errors</guilabel> ticked
2891 as this makes the log files useful for tracking down bugs.
2892 </para>
2893
2894 <para>
2895 The <guilabel>Timing</guilabel> checkbox will enable extra log entries
2896 to allow developers to investigate and optimise the speed of
2897 DCP-o-matic.  It will significantly increase the size of the log files
2898 that are generated, so in normal use it is best to leave this
2899 unticked.
2900 </para>
2901
2902 </section>
2903 </chapter>
2904
2905 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" xml:id="ch-frame-rates">
2906 <title>Frame rates</title>
2907
2908 <para>
2909 In an ideal world, a DCP would be created using content at the same
2910 video frame and audio sampling rates as the DCP.  This is not,
2911 however, always possible.
2912 </para>
2913
2914
2915 <!-- ============================================================== -->
2916 <section>
2917 <title>DCP frame rate limitations</title>
2918
2919 <para>
2920 There are some limitations to video and audio frame rates in DCPs.  This is
2921 complicated by the fact that not all projectors will play DCPs at the
2922 same frame rates.  It is possible to create a DCP which one projector will
2923 play fine, but another (of a different type) will refuse to play, or
2924 even refuse to ingest.
2925 </para>
2926
2927
2928 <!-- ============================================================== -->
2929 <section>
2930 <title>Guaranteed rates</title>
2931
2932 <para>
2933 The only rates that are (pretty much) guaranteed to work on all DCI
2934 projectors are 24 frames per second (fps) for video and 48kHz or 96kHz
2935 for audio.  If you are sending your DCPs to unknown places it wise to
2936 consider using these rates if at all possible.
2937 </para>
2938
2939 </section>
2940
2941
2942 <!-- ============================================================== -->
2943 <section>
2944 <title>Other often-supported rates</title>
2945 <para>
2946 Many projectors now in the wild support additional video frame rates:
2947 25, 30 and 48 fps.
2948 </para>
2949 </section>
2950
2951
2952 <!-- ============================================================== -->
2953 <section>
2954 <title>Adapting content to fit the DCP rate</title>
2955
2956 <para>
2957 DCP-o-matic has a few tricks to allow you to use content that is not
2958 in one of the &lsquo;approved&rsquo; rates.
2959 </para>
2960
2961 <para>
2962 Audio is easy: DCP-o-matic can resample to 48kHz from any source rate
2963 with minimal loss in quality.
2964 </para>
2965
2966 <para>
2967 Video rate conversion is harder.  DCP-o-matic's basic strategy to deal
2968 with a non-supported content rate is to run it at the wrong speed, and
2969 to adjust the audio to keep it in sync.
2970 </para>
2971
2972 <para>Let us consider the example of a 25fps source for which you want
2973 to create a 24fps DCP.  DCP-o-matic will put the frames from the
2974 source directly into the DCP without modification, but will tell the
2975 projector to play them back at 24fps.  This means that the DCP's video
2976 will run slightly slower than the original.
2977 </para>
2978
2979 <para>
2980 If DCP-o-matic did nothing else, the result of this would be that the
2981 audio would be running at the original speed with the video running
2982 slowly.  Hence the audio would drift slowly out of sync.  To avoid
2983 this, DCP-o-matic also resamples the audio such that the projector
2984 will play it too slow by the same amount.  Hence it will sound
2985 slightly different but will remain in sync with the video.
2986 </para>
2987
2988 <para>
2989 For very low or high frame rates, DCP-o-matic can also skip or duplicate frames.
2990 </para>
2991
2992 </section>
2993 </section>
2994
2995
2996 <!-- ============================================================== -->
2997 <section>
2998 <title>Setting up</title>
2999
3000 <para>
3001 The <guilabel>Frame Rate</guilabel> control in the
3002 <guilabel>DCP</guilabel> tab sets the video frame rate that the DCP
3003 will use.  Clicking <guilabel>Use best</guilabel> sets the rate to
3004 what DCP-o-matic thinks is the best for your content.  With this
3005 button, DCP-o-matic assumes that the whole range of frame rates (24,
3006 25, 30 and 48fps) are allowable.
3007 </para>
3008
3009 <para>
3010 After this, the <guilabel>Video</guilabel> tab for each piece of
3011 content will give a summary of what DCP-o-matic is doing with that
3012 content.
3013 </para>
3014
3015 <para>
3016 If you want to experiment with other non-standard frame rates, you can
3017 do so by ticking the <guilabel>Allow any DCP frame rate</guilabel> in
3018 the <guilabel>Advanced</guilabel> tab of the preferences dialogue (see the
3019 <xref linkend="sec-prefs-advanced" endterm="sec-prefs-advanced-short"/>).  You are strongly advised to
3020 use this only on your own equipment, and only for experimentation
3021 purposes.
3022 </para>
3023
3024 </section>
3025
3026 </chapter>
3027
3028
3029 <!-- ============================================================== -->
3030 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" xml:id="ch-servers">
3031 <title>Encoding servers</title>
3032
3033 <para>
3034 One way to increase the speed of DCP encoding is to use more
3035 than one machine at the same time.  An instance of DCP-o-matic can
3036 offload some of the time-consuming JPEG2000 encoding to any number of
3037 other machines on a network.  To do this, one &lsquo;master&rsquo;
3038 machine runs DCP-o-matic, and the &lsquo;server&rsquo; machines run
3039 a small program called <code>dcpomatic_server</code>.
3040 </para>
3041
3042 <para>
3043 The master and server machines do not need to be the same type, so you
3044 can mix Windows PCs, Macs and Linux machines as you wish.
3045 </para>
3046
3047
3048 <!-- ============================================================== -->
3049 <section>
3050 <title>Running the servers</title>
3051
3052 <para>
3053 There are two options for the encoding server;
3054 <code>dcpomatic_server_cli</code>, which runs on the command line, and
3055 <code>dcpomatic_server</code>, which has a simple GUI.  The command line
3056 version is well-suited to headless servers, especially on Linux, and
3057 the GUI version works best on Windows where it will put an icon in the
3058 system tray.
3059 </para>
3060
3061 <para>
3062 To run the command line version, simply enter:
3063 </para>
3064
3065 <programlisting>
3066 dcpomatic2_server_cli
3067 </programlisting>
3068
3069 <para>
3070 at a command prompt.  If you are running the program on a machine with
3071 a multi-core processor, you can run multiple parallel encoding threads
3072 by doing something like:
3073 </para>
3074
3075 <programlisting>
3076 dcpomatic2_server_cli -t 4
3077 </programlisting>
3078
3079 <para>
3080 to run 4 threads in parallel.
3081 </para>
3082
3083 <para>
3084 To run the GUI version on windows, run the &lsquo;DCP-o-matic encode
3085 server&rsquo; from the start menu.  An icon will appear in the system
3086 tray; right-click it to open a menu from whence you can quit the
3087 server or open a window to show its status.
3088 </para>
3089
3090 <para>If you would rather not bother installing DCP-o-matic on your
3091 server computers, the other option is to use the live-CD
3092 image that you can download from the <ulink
3093 url="http://dcpomatic.com/">DCP-o-matic web site.</ulink></para>
3094
3095 <para>Either burn the image to CD, or write it to a USB stick (using
3096 something like <ulink
3097 url="http://unetbootin.sourceforge.net/">unetbootin</ulink>).  Boot a
3098 PC from the CD or USB stick and it becomes a DCP-o-matic server
3099 without touching your standard operating system install.
3100 </para>
3101
3102 </section>
3103
3104 <!-- ============================================================== -->
3105 <section>
3106 <title>Setting up DCP-o-matic</title>
3107
3108 <para>
3109 DCP-o-matic periodically looks on the local network for servers.  Any
3110 that it finds are given work to do during encodes.  Selecting
3111 <guilabel>Encoding Servers</guilabel> from the
3112 <guilabel>Tools</guilabel> menu brings up a window which shows that
3113 servers that DCP-o-matic has found.
3114 </para>
3115
3116 </section>
3117
3118 <!-- ============================================================== -->
3119 <section>
3120 <title>Some notes about encode servers</title>
3121
3122 <para>
3123 DCP-o-matic does not mind if servers come and go; if a server
3124 disappears, DCP-o-matic will stop sending work to it, and will check
3125 it every minute or so in case it has come back online.
3126 </para>
3127
3128 <para>
3129 You will probably find that using a 1Gb/s or faster network will
3130 provide a significant speed-up compared to a 100Mb/s network.
3131 </para>
3132
3133 </section>
3134
3135 </chapter>
3136
3137 <chapter xml:id="ch-files" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
3138 <title>Generated files</title>
3139
3140 <para>
3141 DCP-o-matic generates a number of files as it makes a DCP.  <xref
3142 linkend="fig-file-structure"/> shows the files that might be generated
3143 after you have created a DCP for a film called &lsquo;DCP Test&rsquo;.
3144 </para>
3145
3146 <figure id="fig-file-structure">
3147   <title>Creating a new film</title>
3148   <mediaobject>
3149     <imageobject>
3150       <imagedata scale="100" fileref="diagrams/file-structure&dia;"/>
3151     </imageobject>
3152   </mediaobject>
3153 </figure>
3154
3155 <para>
3156 The <code>DCP Test</code> folder is the one that you specify when you
3157 select the <guilabel>New Film</guilabel> option from DCP-o-matic's
3158 menu.  Everything is stored inside this folder.
3159 </para>
3160
3161 <para>
3162 DCP-o-matic generates some working files as it goes along.  These are as follows:
3163 <itemizedlist>
3164
3165 <listitem><code>log</code> is a list of notes that DCP-o-matic makes as it goes
3166 along.  This can be useful for debugging purposes if something goes
3167 wrong.</listitem>
3168
3169 <listitem><code>metadata</code> stores the settings that you have made
3170 for this film: things like cropping, output format and so on.</listitem>
3171
3172 <listitem><code>video</code> is where DCP-o-matic writes the DCP's
3173 video data as it encodes it.</listitem>
3174
3175 <listitem><code>analysis</code> is used to keep the results of audio analysis runs.</listitem>
3176
3177 <listitem><code>info</code> contains details of each video frame that
3178 DCP-o-matic has written so far.  This is used when an encoding
3179 operation is interrupted and DCP-o-matic must resume it.</listitem>
3180 </itemizedlist>
3181 </para>
3182
3183 <para>
3184 Following this is the DCP itself:
3185 <code>DCP-TEST_EN-XX_UK-U_51_2K_CSY_20130218_CSY_OV</code>.  This
3186 contains some small XML files, which describe the DCP, and two large
3187 MXF files, which contain the DCP's audio and video data.  It may also
3188 contain subtitles in either XML or MXF format.  This folder
3189 (<code>DCP-TEST_EN-XX_...</code>) is what you should ingest, or pass
3190 to the cinema which is showing your DCP.
3191 </para>
3192
3193 </chapter>
3194
3195
3196 <chapter>
3197   <title>Command-line tools</title>
3198
3199   <para>
3200     DCP-o-matic includes some tools which allow DCP creation from the
3201     command line or from scripting languages.  This chapter covers the
3202     use of those tools.
3203   </para>
3204
3205   <para>
3206     There are three command-line tools in DCP-o-matic.
3207     <code>dcpomatic2_create</code> creates film directories, with the
3208     associated metadata, from a list of content files.  Then
3209     <code>dcpomatic2_cli</code> runs the transcode process on these
3210     film directories.  Finally, <code>dcpomatic2_kdm_cli</code> can be
3211     used to create KDMs.
3212   </para>
3213
3214   <para>
3215     Some applications will benefit from setting up the films using the
3216     main DCP-o-matic GUI and then using <code>dcpomatic2_cli</code> to
3217     do the encode.  This allows, for example, setup on a relatively
3218     low-powered machine before running the encode on a higher-powered
3219     headless server.
3220   </para>
3221
3222   <section>
3223     <title><code>dcpomatic2_create</code></title>
3224
3225     <para>
3226       The syntax for <code>dcpomatic2_create</code> is:
3227     </para>
3228
3229     <para>
3230       <code>dcpomatic2_create [OPTION] [CONTENT] [&lt;CONTENT&gt; ...]</code>
3231     </para>
3232
3233     <para>
3234       <code>[CONTENT]</code> are the files or folders that you want to use in the
3235       DCP. They can be:
3236       <itemizedlist>
3237         <listitem>&lsquo;Movie&rsquo; files in almost any common format (e.g. MP4, MOV, MKV, etc.)</listitem>
3238         <listitem>A folder containing and image sequence in almost any common format (e.g. TIFF, DPX etc.)</listitem>
3239         <listitem>Sound files (e.g. WAV, MP3, AIFF)</listitem>
3240         <listitem>Subtitles files (e.g. <code>.srt</code>, DCP XML, <code>.ssa</code> etc.)</listitem>
3241       </itemizedlist>
3242     </para>
3243
3244     <para>
3245       The options are:
3246     </para>
3247
3248     <itemizedlist>
3249       <listitem><code>-v</code>, <code>--version</code> &#8212; show DCP-o-matic version</listitem>
3250       <listitem><code>-h</code>, <code>--help</code> &#8212; show this help</listitem>
3251       <listitem><code>-n</code>, <code>--name</code> &#8212; &lt;name&gt; film name</listitem>
3252       <listitem><code>-t, --template &lt;name&gt;</code> &#8212; template name</listitem>
3253       <listitem><code>-c, --dcp-content-type &lt;type&gt;</code> &#8212; FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV</listitem>
3254       <listitem><code>--container-ratio &lt;ratio&gt;</code> &#8212; 119, 133, 137, 138, 166, 178, 185 or 239</listitem>
3255       <listitem><code>--content-ratio &lt;ratio&gt;</code> &#8212; 119, 133, 137, 138, 166, 178, 185 or 239</listitem>
3256       <listitem><code>-s, --still-length &lt;n&gt;</code> &#8212; number of seconds that still content should last</listitem>
3257       <listitem><code>--standard &lt;standard&gt;</code> &#8212; SMPTE or interop (default SMPTE)</listitem>
3258       <listitem><code>--no-use-isdcf-name&gt;</code> &#8212; do not use an ISDCF name; use the specified name unmodified</listitem>
3259       <listitem><code>--no-sign</code>&#8212; do not sign the DCP</listitem>
3260       <listitem><code>-o</code>, <code>--output &lt;dir&gt;</code> &#8212; output directory</listitem>
3261     </itemizedlist>
3262
3263     <para>
3264       For example, to setup a film using a MP4 file you might do:
3265     </para>
3266
3267     <para>
3268       <code>dcpomatic2_create -o my_film --container-ratio 185 --content-ratio 185 -c FTR -n "My Film" Stuff.mp4</code>
3269     </para>
3270
3271     <para>
3272       This will create a folder called <code>my_film</code> which is ready for a DCP to be made by <code>dcpomatic2_cli</code>.
3273     </para>
3274
3275     <para>
3276       <code>dcpomatic2_create</code> will use any default settings that you have configured in the main DCP-o-matic preferences.
3277     </para>
3278   </section>
3279
3280   <section>
3281     <title><code>dcpomatic2_cli</code></title>
3282
3283     <para>
3284       The syntax for <code>dcpomatic2_cli</code> is:
3285     </para>
3286
3287     <para>
3288       <code>dcpomatic2_cli [OPTION] [FILM]</code>
3289     </para>
3290
3291     <para>
3292       <itemizedlist>
3293         <listitem><code>-v</code>, <code>--version</code> &#8212; show DCP-o-matic version</listitem>
3294         <listitem><code>-h</code>, <code>--help</code> &#8212; show this help</listitem>
3295         <listitem><code>-f</code>, <code>--flags</code> &#8212; show flags passed to C++ compiler on build</listitem>
3296         <listitem><code>-n</code>, <code>--no-progress</code> &#8212; do not print progress to stdout</listitem>
3297         <listitem><code>-r</code>, <code>--no-remote</code> &#8212; do not use any remote servers</listitem>
3298         <listitem><code>-t</code>, <code>--threads</code> &#8212; specify number of local encoding threads (overriding configuration)</listitem>
3299         <listitem><code>-j</code>, <code>--json</code> &lt;port&gt; &#8212; run a JSON server on the specified port</listitem>
3300         <listitem><code>-k</code>, <code>--keep-going</code> &#8212; keep running even when the job is complete</listitem>
3301         <listitem><code>-s</code>, <code>--servers</code> &#8212; just display a list of encoding servers that DCP-o-matic is configured to use; don't encode</listitem>
3302         <listitem><code>-d</code>, <code>--dcp-path</code> &#8212; echo DCP's path to stdout on successful completion (implies -n)</listitem>
3303         <listitem><code>--dump</code> &#8212; just dump a summary of the film's settings; don't encode</listitem>
3304       </itemizedlist>
3305     </para>
3306
3307     <para>
3308       For example, to encode a film called <code>my_film</code> you might do:
3309     </para>
3310
3311     <para>
3312       <code>dcpomatic2_cli my_film</code>
3313     </para>
3314   </section>
3315
3316   <section>
3317     <title><code>dcpomatic2_kdm_cli</code></title>
3318
3319     <para>
3320       The syntax for <code>dcpomatic2_kdm_cli</code> is:
3321     </para>
3322
3323     <para>
3324       <code>dcpomatic2_kdm_cli [OPTION] &lt;FILM|CPL-ID&gt;</code>
3325     </para>
3326
3327     <para>
3328       <itemizedlist>
3329         <listitem><code>-o</code>, <code>--output</code> &#8212; output file or directory</listitem>
3330         <listitem><code>-f</code>, <code>--valid-from</code> &#8212; valid from time (in local time zone of the cinema) (e.g. "2013-09-28 01:41:51") or "now"</listitem>
3331         <listitem><code>-t</code>, <code>--valid-to</code> &#8212; valid to time (in local time zone of the cinema) (e.g. "2014-09-28 01:41:51")</listitem>
3332         <listitem><code>-d</code>, <code>--valid-duration</code> &#8212; valid duration (e.g. "1 day", "4 hours", "2 weeks")</listitem>
3333         <listitem><code>--formulation</code> &#8212; modified-transitional-1, dci-any or dci-specific [default modified-transitional-1]</listitem>
3334         <listitem><code>-z</code>, <code>--zip</code> &#8212; ZIP each cinema's KDMs into its own file</listitem>
3335         <listitem><code>-v</code>, <code>--verbose</code> &#8212; be verbose</listitem>
3336         <listitem><code>-c</code>, <code>--cinema</code> &#8212; specify a cinema, either by name or email address</listitem>
3337         <listitem><code>--certificate</code> &#8212; file containing projector certificate</listitem>
3338         <listitem><code>--cinemas</code> &#8212; list known cinemas from the DCP-o-matic settings</listitem>
3339         <listitem><code>--dkdm-cpls</code> &#8212; list CPLs for which DCP-o-matic has DKDMs</listitem>
3340       </itemizedlist>
3341     </para>
3342
3343   </section>
3344 </chapter>
3345
3346
3347
3348 <!-- ============================================================== -->
3349 <chapter>
3350 <title>Loose ends</title>
3351
3352 <para>
3353 This chapter collects a few notes on bits of DCP-o-matic that do not fit elsewhere in the manual.
3354 </para>
3355
3356
3357 <!-- ============================================================== -->
3358 <section>
3359 <title>Resuming encodes</title>
3360
3361 <para>
3362 If you cancel a DCP encoding run half-way through, or your computer
3363 crashes... fear not.  DCP-o-matic takes care to ensure that, in most
3364 cases, it can resume encoding from where it left off.  When you
3365 re-start a DCP creation, using the same settings are a previous run,
3366 DCP-o-matic will first check that the existing picture frames are
3367 correct, and then resume from where it left off.  The checking of
3368 existing frames does take some time, but it is much faster than
3369 running a full re-encode.
3370 </para>
3371
3372 <para>
3373 This resumption is achieved by writing a digest (hash) to disk for
3374 every image frame that is written.  On resumption, the existing MXF
3375 file for image data is read and its contents checked against the
3376 hashes.
3377 </para>
3378
3379 </section>
3380
3381 </chapter>
3382
3383 <!-- ============================================================== -->
3384 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
3385 <title>Common tasks</title>
3386
3387 <para>
3388 This chapter describes how to carry out some commonly-required tasks
3389 with DCP-o-matic.  The full details are elsewhere in the manual: here
3390 we just discuss different approaches to these tasks and how to carry
3391 them out.
3392 </para>
3393
3394 <section>
3395 <title>Adding subtitles to an existing DCP</title>
3396
3397 <para>
3398 You have three options:
3399 </para>
3400
3401 <itemizedlist>
3402 <listitem>Make a &ldquo;Version File&rdquo; (VF) DCP.</listitem>
3403 <listitem>Make a complete DCP with projector-added subtitles.</listitem>
3404 <listitem>Make a complete DCP with burnt-in subtitles.</listitem>
3405 </itemizedlist>
3406
3407 <para>
3408 Making a VF DCP is usually the best option.  This will be a very small
3409 DCP which contains only the subtitles: it refers to your existing DCP
3410 for the picture and sound.  The projectionist will ingest both the
3411 existing and VF DCPs and play back the VF.  The advantages of this
3412 approach are that the VF is very quick to generate, and small in size,
3413 making it easy to distribute.  This is especially useful if you have
3414 to make VF DCPs in many different languages.
3415 </para>
3416
3417 <para>
3418 Making a complete DCP with projector-added subtitles gives you a new,
3419 single DCP which the projectionist can ingest and play.  It will be
3420 the same size as your existing DCP, and fairly quick to create.  This
3421 approach relies on the projector (or server) to create the subtitles
3422 and overlay them on the image, which mostly works well but is not
3423 100&percnt; reliable.
3424 </para>
3425
3426 <para>
3427 Making a complete DCP with burnt-in subtitles gives you a new, single DCP
3428 but with the subtitles rendered by DCP-o-matic and copied into your
3429 image.  This is slower to create than a DCP with projector-added
3430 subtitles as every video frame with a subtitle must be re-encoded.
3431 The advantage of this approach is that it is less likely to go wrong,
3432 especially if you are using unusual subtitle positioning or character
3433 sets.
3434 </para>
3435
3436 <section>
3437 <title>Making a VF DCP</title>
3438
3439 <itemizedlist>
3440 <listitem>Start a new DCP-o-matic film.</listitem>
3441 <listitem>Click <guilabel>Add folder...</guilabel> and specify your existing DCP's folder.</listitem>
3442 <listitem>Go to the <guilabel>DCP</guilabel> tab and choose <guilabel>Split by video content</guilabel> for <guilabel>Reel type</guilabel>.</listitem>
3443 <listitem>Go to the <guilabel>Video</guilabel> and
3444 <guilabel>Audio</guilabel> tabs in turn and tick the <guilabel>Use this DCP's audio as OV and make VF</guilabel> checkboxes.</listitem>
3445 <listitem>Add your subtitles to the film in whatever format you have.</listitem>
3446 <listitem>Check the subtitle appearance in the preview; it will be
3447 slow to respond as it is having to decompress images from the existing
3448 DCP.</listitem>
3449 <listitem>Choose <guilabel>Make DCP</guilabel> from the menu.</listitem>
3450 </itemizedlist>
3451
3452 </section>
3453
3454 <section>
3455 <title>Making a complete DCP with projector-added subtitles</title>
3456
3457 <itemizedlist>
3458 <listitem>Start a new DCP-o-matic film.</listitem>
3459 <listitem>Click <guilabel>Add folder...</guilabel> and specify your existing DCP's folder.</listitem>
3460 <listitem>Add your subtitles to the film in whatever format you have.</listitem>
3461 <listitem>Check the subtitle appearance in the preview; it will be
3462 slow to respond as it is having to decompress images from the existing
3463 DCP.  Adjust the appearance using controls in the
3464 <guilabel>Subtitle</guilabel> tab if required.</listitem>
3465 <listitem>Choose <guilabel>Make DCP</guilabel> from the menu.</listitem>
3466 </itemizedlist>
3467
3468 </section>
3469
3470 <section>
3471 <title>Making a complete DCP with burnt-in subtitles</title>
3472
3473 <itemizedlist>
3474 <listitem>Start a new DCP-o-matic film.</listitem>
3475 <listitem>Click <guilabel>Add folder...</guilabel> and specify your existing DCP's folder.</listitem>
3476 <listitem>Add your subtitles to the film in whatever format you have.</listitem>
3477 <listitem>Go to the <guilabel>Subtitle</guilabel> tab and tick the <guilabel>Burn subtitles into image</guilabel> checkbox.</listitem>
3478 <listitem>Check the subtitle appearance in the preview; it will be
3479 slow to respond as it is having to decompress images from the existing
3480 DCP.  Adjust the appearance using controls in the
3481 <guilabel>Subtitle</guilabel> tab if required.</listitem>
3482 <listitem>Choose <guilabel>Make DCP</guilabel> from the menu.</listitem>
3483 </itemizedlist>
3484
3485 </section>
3486 </section>
3487
3488 <section>
3489 <title>Adding soundtracks or subtitles in different languages</title>
3490
3491 <para>
3492 If you have a film that is to be dubbed or subtitled in several
3493 languages, the best approach with DCP-o-matic is as follows:
3494 </para>
3495
3496 <itemizedlist>
3497 <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>
3498 <listitem>For each language, make a new Version File (VF) DCP which refers to the OV.</listitem>
3499 </itemizedlist>
3500
3501 <para>
3502 Once you have done this, you send the OV DCP to every cinema and then
3503 the appropriate VF to each cinema depending on what language they want
3504 to play the film in.  The projectionist ingests both DCPs and then plays the VF.
3505 </para>
3506
3507 <para>
3508 The advantage of this approach is that the VF DCPs are much smaller
3509 than the OV since they only have the language-specific parts.  If you
3510 are just changing the subtitles you can often ship the OV by normal
3511 transport means (e.g. a hard drive or high-speed download) and send
3512 the VF by email.
3513 </para>
3514
3515 <para>
3516 The full details of OV and VF files are discussed in <xref linkend="sec-overlay"/>.  The steps can be summarised as follows:
3517 </para>
3518
3519 <itemizedlist>
3520 <listitem>Create a new DCP-o-matic project for the OV, as normal, adding video and perhaps sound.  Make the DCP.</listitem>
3521 <listitem>Create a new DCP-o-matic project for the VF.</listitem>
3522 <listitem>Use <guilabel>Add folder...</guilabel> to add your OV DCP to the project.</listitem>
3523 <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>
3524 <listitem>Do the same in the <guilabel>Audio</guilabel> tab if your OV has audio.</listitem>
3525 <listitem>Add your language-specific audio and/or subtitles and Make DCP.</listitem>
3526 </itemizedlist>
3527
3528 </section>
3529
3530 </chapter>
3531
3532 <chapter xml:id="ch-player" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
3533   <title>Playing DCPs</title>
3534
3535   <para>DCP-o-matic includes a DCP player, and although it requires a
3536   very high-speed CPU to play DCPs in full resolution, it can also
3537   play DCPs at reduced resolutions with slower CPUs.</para>
3538
3539   <para>To use the player, start <guilabel>DCP-o-matic
3540   Player</guilabel>, and load a DCP using the
3541   <guilabel>Open</guilabel> option on the <guilabel>File</guilabel>
3542   menu.</para>
3543
3544   <para>If you load a VF and/or encrypted DCP you can add your OV
3545   and/or KDM using the appropriate options on the
3546   <guilabel>File</guilabel> menu.</para>
3547
3548   <para>During playback the <guilabel>Performance</guilabel> area at
3549   the bottom right of the window will give details of how many frames
3550   are being dropped; these are frames that were not decoded from the
3551   DCP quickly enough.  If this number is high you can increase
3552   performance at the cost of rendering quality by choosing an option
3553   from the <guilabel>View</guilabel> menu.  If you set the player to
3554   decode at less than full resolution the DCP's data will be decoded
3555   at this lower resolution, which is quicker than decoding at full
3556   resolution.
3557   </para>
3558
3559 </chapter>
3560
3561 <!-- ============================================================== -->
3562 <chapter xml:id="ch-config" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
3563 <title>Configuration files</title>
3564
3565 <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>
3566
3567 <itemizedlist>
3568   <listitem>Windows: <code>c:\Users\your_user_name\AppData\Local\dcpomatic</code></listitem>
3569   <listitem>OS X: <code>/Users/your_user_Name/Library/Preferences/com.dcpomatic/2</code></listitem>
3570   <listitem>Linux: <code>~/.config/dcpomatic2</code></listitem>
3571 </itemizedlist>
3572
3573 <para>Possible XML tags are as follows:</para>
3574
3575 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="config.xml"/>
3576
3577 </chapter>
3578
3579 </book>