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