]>
<book xmlns="http://docbook.org/ns/docbook" xmlns:mml="http://www.w3.org/1998/Math/MathML" version="5.0" xml:lang="en">
-<!-- By good luck or good management, the scale parameter to imagedata
- appears only to affect PDF output. HTML scaling is done in the
- Makefile.
--->
-
<bookinfo>
-<title>DCP-o-matic</title>
+<title>DCP-o-matic users' manual</title>
<author><firstname>Carl</firstname><surname>Hetherington</surname></author>
</bookinfo>
Hello, and welcome to DCP-o-matic!
</para>
+<!-- ============================================================== -->
<section>
<title>What is DCP-o-matic?</title>
<para>
DCP-o-matic is a program to generate <ulink
url="http://en.wikipedia.org/wiki/Digital_Cinema_Package">Digital
-Cinema Packages</ulink> (DCPs) from DVDs, Blu-Rays, video files such as MP4
-and AVI, or still images. The resulting DCPs will play on modern digital
+Cinema Packages</ulink> (DCPs) from almost any video, audio and/or
+subtitle source files. The resulting DCPs will play on modern digital
cinema projectors.
</para>
-<para>
-You might find it useful to make DVDs easier to present, to encode
-independently-shot feature films, or to generate local advertising for
-your cinema.
-</para>
-
</section>
+
+<!-- ============================================================== -->
<section>
<title>Licence</title>
<para>
-DCP-o-matic is licensed under the <ulink url="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU GPL</ulink>.
+DCP-o-matic is free and open-source and is licensed under the <ulink
+url="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU
+GPL</ulink>.
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Acknowledgements</title>
</section>
</chapter>
+
+<!-- ============================================================== -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>Installation</title>
+
+<!-- ============================================================== -->
<section>
<title>Windows</title>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Mac OS X</title>
<para>
DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and
-higher. To install it, download the <code>
DMG</code> from <ulink
+higher. To install it, download the <code>
.dmg</code> from <ulink
url="http://dcpomatic.com/">http://dcpomatic.com/</ulink> and double
click to open it. Then drag the DCP-o-matic icon to your
<guilabel>Applications</guilabel> folder or wherever else you would
</section>
+<!-- ============================================================== -->
<section>
-<title>Ubuntu Linux</title>
+<title>Debian or Ubuntu Linux</title>
<para>
-You can install DCP-o-matic on Ubuntu 12.04 (‘Precise
-Pangolin’), 12.10 (‘Quantal Quetzal’), 13.10 (‘Saucy
-Salamander’) or 14.04 (‘Trusty Tahr’) using <code>.deb</code> packages: download the
-appropriate package from <ulink
-url="http://dcpomatic.com/">http://dcpomatic.com/</ulink> and
-double-click it. Ubuntu will install the necessary bits and pieces
-and set DCP-o-matic up for you.
+ You can install DCP-o-matic on:
</para>
-</section>
+<itemizedlist>
+ <listitem>Debian 7 (‘wheezy’)</listitem>
+ <listitem>Debian 8 (‘jessie’)</listitem>
+ <listitem>Debian unstable (‘sid’)</listitem>
+ <listitem>Ubuntu 12.04 (‘Precise Pangolin’)</listitem>
+ <listitem>Ubuntu 14.04 (‘Trusty Tahr’)</listitem>
+ <listitem>Ubuntu 15.04 (‘Vivid Vervet’)</listitem>
+ <listitem>Ubuntu 15.10 (‘Wily Werewolf’)</listitem>
+</itemizedlist>
-<section>
-<title>Debian Linux</title>
<para>
-Packages are available for Debian 7 (squeeze) from <ulink
-url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>.
+using <code>.deb</code> packages: download the appropriate package
+from <ulink url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>
+and double-click it. Debian or Ubuntu will install the necessary bits and
+pieces and set DCP-o-matic up for you.
</para>
</section>
+<!-- ============================================================== -->
+
+<!-- ============================================================== -->
<section>
-<title>Centos Linux</title>
-<para>
-Packages are available for Centos 6.5 from <ulink
-url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>.
-</para>
+ <title>Fedora Linux</title>
+
+ <para>There are <code>.rpm</code> packages for Fedora 22 and 23 on
+ <ulink url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>
+ </para>
+</section>
+<!-- ============================================================== -->
+
+
+<!-- ============================================================== -->
+<section>
+ <title>Centos Linux</title>
+ <para>There are <code>.rpm</code> packages for Centos 6.5 and 7 on
+ <ulink url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>
+ </para>
</section>
+<!-- ============================================================== -->
+
+<!-- ============================================================== -->
<section>
<title>Arch Linux</title>
<para>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Other Linux distributions</title>
<para>
-Installation on non-Ubuntu Linux is currently a little involved, as
-there are no packages available (yet); you will have to compile it
-from source. If you are using a non-Ubuntu distribution, do let me
-know via the <ulink url="mailto:carl@dcpomatic.com">mailing
-list</ulink> and I will see about building some packages.
+Installation on other Linux systems (for which no packages are
+available) is quite hard; you will have to compile it from source. If
+you are using distribution for which no packages are available, do let
+me know by <ulink url="mailto:carl@dcpomatic.com">email</ulink> and I
+will look into providing packages on the website.
</para>
<para>
<itemizedlist>
<listitem><ulink url="http://ffmpeg.org/">FFmpeg</ulink></listitem>
<listitem><ulink url="http://www.mega-nerd.com/libsndfile/">libsndfile</ulink></listitem>
+<listitem><ulink url="http://www.mega-nerd.com/SRC/">libsamplerate</ulink></listitem>
<listitem><ulink url="http://www.openssl.org/">OpenSSL</ulink></listitem>
<listitem><ulink url="http://www.openjpeg.org/">libopenjpeg</ulink></listitem>
<listitem><ulink url="http://www.imagemagick.org/script/index.php">ImageMagick</ulink></listitem>
<listitem><ulink url="http://www.libssh.org/">libssh</ulink></listitem>
<listitem><ulink url="http://www.gtk.org/">GTK (on Linux)</ulink></listitem>
<listitem><ulink url="http://www.wxwidgets.org/">wxWidgets</ulink></listitem>
-<listitem><ulink url="http://freecode.com/projects/libquickmail">libquickmail</ulink></listitem>
<listitem><ulink url="http://libxmlplusplus.sourceforge.net/">libxml++</ulink></listitem>
<listitem><ulink url="http://www.aleksey.com/xmlsec/">xmlsec</ulink></listitem>
<listitem><ulink url="http://curl.haxx.se/">curl</ulink></listitem>
<listitem><ulink url="http://www.nih.at/libzip/">libzip</ulink></listitem>
-<listitem><ulink url="http://carlh.net/software/libdcp/">libdcp</ulink></listitem>
-<listitem><ulink url="http://carlh.net/software/libcxml/">libcxml</ulink></listitem>
+<listitem><ulink url="http://carlh.net/libdcp/">libdcp</ulink></listitem>
+<listitem><ulink url="http://carlh.net/libsub/">libsub</ulink></listitem>
+<listitem><ulink url="http://carlh.net/libcxml/">libcxml</ulink></listitem>
+<listitem><ulink url="http://site.icu-project.org">libicu</ulink></listitem>
</itemizedlist>
</para>
</para>
<programlisting>
-dcpomatic
+dcpomatic2
</programlisting>
<para>
</section>
</chapter>
+
+<!-- ============================================================== -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>Creating a video DCP</title>
</para>
<figure id="fig-file-new">
- <title>Creating a new film</title>
+ <title>Creating a new film</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/file-new&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
</para>
<figure id="fig-video-new-film">
- <title>Dialogue box for creating a new film</title>
+ <title>Dialogue box for creating a new film</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/video-new-film&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Adding content</title>
linkend="fig-video-select-content-file"/>.
</para>
-<figure id="fig-add-file">
- <title>Adding content files</title>
+<figure id="fig-add-file">
+ <title>Adding content files</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/add-file&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
-<figure id="fig-video-select-content-file">
- <title>Selecting a video content file</title>
+<figure id="fig-video-select-content-file">
+ <title>Selecting a video content file</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/video-select-content-file&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
the right of the window, as shown in <xref linkend="fig-examine-content"/>.
</para>
-<figure id="fig-examine-content">
+<figure id="fig-examine-content">
<title>Examining the content</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/examine-content&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
<para>
Dragging the slider will move through your video. You can also click
-the <guilabel>Play</guilabel> button to play the content back. Note
-that there will be no sound, and playback might not be entirely
+the <guilabel>Play</guilabel> button to play the content back. <emphasis>Note
+that there will be no sound</emphasis>, and playback might not be entirely
accurate (it may be slightly slower or faster than it should be, for
example). This player is really only intended for brief inspection of
content; if you need to check it more thoroughly, use another player
+
+<!-- ============================================================== -->
<section>
<title>Making the DCP</title>
<figure id="fig-making-dcp">
<title>Making the DCP</title>
<mediaobject>
- <imageobject>
- <imagedata scale="30" fileref="screenshots/making-dcp&scs;"/>
- </imageobject>
+ <imageobject>
+ <imagedata scale="50" fileref="screenshots/making-dcp&scs;"/>
+ </imageobject>
</mediaobject>
</figure>
</para>
<para>
-Alternatively, if you have a projector or TMS that is accessible via
-SCP across your network, you can upload the content directly from
-DCP-o-matic. See the preferences in <xref linkend="sec-prefs-tms"/>.
+Alternatively, if you have a projector or Theatre Management System
+(TMS) that is accessible via SCP across your network, you can upload
+the content directly from DCP-o-matic. See the <xref
+linkend="sec-prefs-tms" endterm="sec-prefs-tms-short"/> in <xref linkend="sec-prefs-tms"/>.
</para>
</section>
</chapter>
+
+<!-- ============================================================== -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>Creating a still-image DCP</title>
shown in <xref linkend="fig-still-new-film"/>.
</para>
-<figure id="fig-still-new-film">
- <title>Dialogue box for creating a new film</title>
+<figure id="fig-still-new-film">
+ <title>Dialogue box for creating a new film</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/still-new-film&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
linkend="fig-still-select-content-file"/>.
</para>
-<figure id="fig-still-select-content-file">
- <title>Selecting a still content file</title>
+<figure id="fig-still-select-content-file">
+ <title>Selecting a still content file</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/still-select-content-file&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
As with video DCPs, most of the default settings will be fine for a
simple test. The one thing that you might wish to change is the
length of the still. Select the <guilabel>Timing</guilabel> tab and
-you will see a <guilabel>Length</guilabel> setting, as shown in <xref
+you will see a <guilabel>Play length</guilabel> setting, as shown in <xref
linkend="fig-timing-tab"/>.
</para>
-<figure id="fig-timing-tab">
+<figure id="fig-timing-tab">
<title>The timing tab</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/timing-tab&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
</chapter>
+
+<!-- ============================================================== -->
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
+<title>Manipulating existing DCPs</title>
+
+<para>
+Frequently DCP-o-matic is used to take content in formats such as MP4
+and convert it to JPEG2000 for a DCP. Alternatively, it can be used
+to take existing DCPs and modify them in various ways.
+</para>
+
+<section>
+<title>Importing a DCP into DCP-o-matic</title>
+
+<para>
+If you want to do something to an existing DCP the first step is to
+import it. Click <guilabel>Add folder...</guilabel> and select your
+DCP's folder. It will be added to the DCP-o-matic project. If the
+DCP is unencrypted you can preview it in the normal way, though
+playback will be very slow as decoding of DCPs is almost as
+computationally intensive as encoding them.
+</para>
+
+</section>
+
+
+<section>
+<title>Decrypting encrypted DCPs</title>
+
+<para>
+DCPs can be encrypted (see <xref linkend="ch-encryption"/> for
+details). If you import an encrypted DCP you will need a key, in the
+form of a Key Delivery Message (KDM), to decrypt it.
+</para>
+
+<para>
+KDMs must be prepared by the organisation which created the DCP. They
+contain the keys to decrypt the DCP wrapped up in such a way that only
+the intended recipient can read them. You will need to provide the
+organisation with a certificate which identifies your copy of
+DCP-o-matic and allows them to create a KDM for you.
+</para>
+
+<para>
+To get DCP-o-matic's decryption certificate, open the Preferences
+dialogue (see <xref linkend="ch-preferences"/>) and go to the
+<guilabel>Keys</guilabel> tab. Click the <guilabel>Export DCP
+decryption certificate...</guilabel> button at the bottom of this tab
+and save the certificate. Send this certificate to the DCP creators
+and they can create a KDM to allow DCP-o-matic to decrypt their DCP.
+</para>
+
+<para>
+Once you have your KDM, right-click the DCP's name in DCP-o-matic and
+choose <guilabel>Add KDM...</guilabel>. Specify your KDM and (all
+being well) the DCP will be decrypted and become available for preview.
+</para>
+
+</section>
+
+
+<section>
+<title>Making a DCP from a DCP</title>
+
+<para>
+In many ways, using DCPs as <emphasis>content</emphasis> in
+DCP-o-matic is the same as using any other content. There are a few
+things to note, though.
+</para>
+
+
+<section>
+<title>Re-use of existing data</title>
+
+<para>
+Where possible DCP-o-matic will re-use existing JPEG2000-compressed
+data from DCP content without modification. This has the advantage
+that creation of the new DCP will be quick, as the time-consuming
+JPEG2000 encoding is not necessary.
+</para>
+
+<para>
+DCP-o-matic can do this if you avoid changes to the following content
+settings:
+</para>
+
+<itemizedlist>
+<listitem>Crop</listitem>
+<listitem>Scaling</listitem>
+<listitem>Subtitle burn-in</listitem>
+<listitem>Fades</listitem>
+<listitem>Colour conversion</listitem>
+</itemizedlist>
+
+<para>
+If you do change any of these settings on a piece of DCP content
+DCP-o-matic will decode and then re-encode the JPEG2000 data.
+</para>
+
+</section>
+
+
+<section>
+<title>Making overlay files</title>
+
+<para>
+With its default settings, DCP-o-matic will take any data from DCP
+content and copy it into the DCP that it creates. See <xref linkend="fig-dcp-copy"/>.
+</para>
+
+<figure id="fig-dcp-copy">
+<title>Creating a new DCP by copying an existing one</title>
+<mediaobject><imageobject><imagedata scale="100" fileref="diagrams/dcp-copy&dia;"/></imageobject></mediaobject>
+</figure>
+
+<para>
+This can be inefficient in some cases. Consider, for example, a film
+which has ten different translations for which the subtitles are
+different but video and audio are the same. If the video and audio
+content takes up, say, 100Gb this means that the set of DCPs for every
+translation would be about 1Tb with a lot of duplicated data.
+</para>
+
+<para>
+The DCP format has a solution to this problem. One DCP can refer to
+the ‘assets’ (picture, sound or subtitle) of another DCP.
+For our translation example this means that we could have a
+‘base’ DCP (often called the OV or Original Version)
+containing video, audio and one set of subtitles and then any number
+of overlay DCPs (often called VF or Version Files) which refer to the
+base version and replace the original subtitles with their own. <xref
+linkend="fig-dcp-refer"/> shows this principle for one of our
+translations. The DCP that we make refers to the original content
+DCP's video and audio rather than containing a copy.
+</para>
+
+<figure id="fig-dcp-refer">
+<title>Creating a new DCP by referring to an existing one</title>
+<mediaobject><imageobject><imagedata scale="100" fileref="diagrams/dcp-refer&dia;"/></imageobject></mediaobject>
+</figure>
+
+<para>
+To play back the subtitled DCP the projectionist ingests both the base
+(OV) DCP and the overlay (VF) DCP, then plays the VF one.
+</para>
+
+<para>
+To make a DCP like this:
+</para>
+
+<itemizedlist>
+<listitem>Import your ‘Content DCP’ to a DCP-o-matic project.</listitem>
+<listitem>Add whatever replacement you want in your new DCP (replacement subtitles or audio files, for example).</listitem>
+<listitem>Select the DCP in the content list</listitem>
+<listitem>Tick the <guilabel>Refer to existing DCP</guilabel> checkbox
+in the tabs for the parts of the DCP that you want to refer to in your
+new DCP. For example, to refer to the ‘Content DCP’'s video and audio you would select the <guilabel>Video</guilabel> tab, click <guilabel>Refer to existing DCP</guilabel> then select the <guilabel>Audio</guilabel> tab and do the same.</listitem>
+<listitem>Do <guilabel>Make DCP</guilabel> as usual and your VF DCP will be created.</listitem>
+</itemizedlist>
+
+</section>
+
+</section>
+
+
+
+</chapter>
+<!-- ============================================================== -->
+
+
+<!-- ============================================================== -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>Content settings</title>
<para>
The previous chapters showed DCP generation using the default
settings. DCP-o-matic offers a range of features to adjust the
-content that goes into your DCP, and this chapter describes those features in
-detail.
+content that goes into your DCP, and this chapter describes those
+features in detail.
</para>
<section>
<itemizedlist>
<listitem>Movie — a file containing some video, probably some
-audio and possibly some subtitles; for example, a MOV, MP4 or VOB.
+audio and possibly some embedded subtitles; for example, a MOV, MP4 or VOB.
</listitem>
<listitem>Sound — a file containing one or more channels of
<listitem>Moving image — a directory containing many still
images which should be treated as the frames of a video.
</listitem>
+
+<listitem>Subtitle — a file containing subtitle which will be
+superimposed on the image of the DCP. These can be
+<guilabel>.srt</guilabel> or <guilabel>.xml</guilabel>
+files.</listitem>
+
+<listitem>DCP — an existing DCP.</listitem>
</itemizedlist>
<para>
-To add one or more movie, sound or still-image files, select
+To add one or more movie, sound, still-image or subtitle files, select
<guilabel>Add file(s)...</guilabel> and choose them from the selector.
-To add a directory of images, choose <guilabel>Add
-directory...</guilabel> and do similar.
+</para>
+
+<para>
+To add a directory (folder) of images or a DCP, choose <guilabel>Add
+folder...</guilabel> and choose the directory from the selector. If
+you select a folder of images DCP-o-matic will open a small dialogue
+box where you can enter the frame rate that the image sequence should
+be run at.
</para>
<para>
</para>
</section>
+
+<!-- ============================================================== -->
+<section>
+<title>Adding existing DCPs</title>
+
+<para>Adding existing DCPs to a DCP-o-matic film is a little different
+to adding other types of content. Most content has to be converted to
+JPEG2000, the compression scheme used by DCPs, which is a very
+time-consuming process. Existing DCPs are already in JPEG2000 format
+so do not require conversion. This means that, provided no settings
+such as crop are used on the DCP content, picture and sound data will
+be passed from existing to new DCP unaltered.
+</para>
+
+<para>Encrypted DCPs that are added as content will require a KDM
+targeted at DCP-o-matic so that DCP-o-matic can decrypt them. You
+should ask the creator of the imported DCP to provide a KDM for
+DCP-o-matic's decryption certificate, which can be obtained by
+clicking <guilabel>Export DCP decryption certificate...</guilabel>
+from the <guilabel>Keys</guilabel> tab of the
+<guilabel>Preferences</guilabel> dialog (see <xref
+linkend="sec-prefs-keys"/>).
+</para>
+
+</section>
+
+<!-- ============================================================== -->
<section>
<title>Content Properties</title>
for that piece of content.
</para>
+<para>
+If you want to change the properties for multiple pieces of content at
+the same time, select the content in the list by clicking the first
+piece then clicking the other pieces with <keycap>shift</keycap> key
+held down. Note that not all settings can be changed in this way.
+</para>
+
<para>
The content properties are split up into four sections:
<guilabel>Video</guilabel>, <guilabel>Audio</guilabel>,
</section>
+
+<!-- ============================================================== -->
<section>
<title>Video</title>
The <guilabel>Video</guilabel> tab controls properties of the image, as shown in <xref linkend="fig-video-tab"/>.
</para>
-<figure id="fig-video-tab">
+<figure id="fig-video-tab">
<title>Video settings tab</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/video-tab&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
+
+<!-- ============================================================== -->
<section>
<title>Image type</title>
left-right pair, as shown in <xref linkend="fig-3d-left-right"/>.
</para>
-<figure id="fig-3d-left-right">
+<figure id="fig-3d-left-right">
<title>3D left/right image type</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata scale="100" fileref="diagrams/3d-left-right&dia;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
linkend="fig-3d-top-bottom"/>.
</para>
-<figure id="fig-3d-top-bottom">
+<figure id="fig-3d-top-bottom">
<title>3D top/bottom image type</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata scale="100" fileref="diagrams/3d-top-bottom&dia;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
+<para>
+Another option is <guilabel>3D alternate</guilabel> which takes the
+first frame of the content as for the left eye, the second for the
+right eye, the third for the left, and so on. Finally, you can
+specify <guilabel>3D left only</guilabel> or <guilabel>3D right
+only</guilabel> if this content contains only the the left or right
+eye images. This is useful when you have the left and right eye image
+sets in different files; you can specify one content as <guilabel>3D
+left only</guilabel> and another as <guilabel>3D right only</guilabel>
+and DCP-o-matic will pick up the appropriate frames from each.
+</para>
+
</section>
as shown in <xref linkend="fig-filters"/>.
</para>
-<figure id="fig-filters">
- <title>Filters selector</title>
+<figure id="fig-filters">
+ <title>Filters selector</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/filters&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
</section>
+
+<!-- ============================================================== -->
+<section>
+<title>Colour conversion</title>
+
+<para>
+The <guilabel>Colour conversion</guilabel> setting specifies what
+colour transforms and gamma correction DCP-o-matic will use when
+converting the selected content into the XYZ colourspace for the DCP.
+</para>
+
+<para>
+The easiest way to select the required conversion is to choose one of
+DCP-o-matic's presets. DCP-o-matic knows how to convert from four
+common colourspaces: sRGB, Rec. 601, Rec. 709 and P3. If you do not
+know which preset you should use, refer to the suggestions in <xref
+linkend="tab-colour-conversion"/>.
+</para>
+
+<table id="tab-colour-conversion">
+<title>Suggested colour conversion settings</title>
+<tgroup cols='2' align='left' colsep='1' rowsep='1'>
+<colspec colwidth='1*'/>
+<colspec colwidth='5*'/>
+<tbody>
+<row>
+<entry>sRGB</entry><entry>Still images in RGB, e.g. photographs</entry>.
+</row>
+<row>
+<entry>Rec. 601</entry><entry>Standard-definition content (fewer than about 1000 pixels across) including DVD rips.</entry>
+</row>
+<row>
+<entry>Rec. 709</entry><entry>High-definition content including Blu-Ray rips.</entry>
+</row>
+<row>
+<entry>P3</entry><entry>Content explicitly graded to P3.</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+
+<para>
+For other required colour conversions, and if you know what you are
+doing, you can choose <guilabel>Custom</guilabel> which will open the full
+colour conversion editing dialogue box:
+</para>
+
+<figure id="fig-colour-conversion">
+ <title>Dialogue box for custom colour conversion</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="screenshots/colour-conversion&scs;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+Alternatively, choose <guilabel>None</guilabel> if your source files
+are already in the XYZ colour space and require no conversion.
+</para>
+
+<para>
+DCP-o-matic's colour conversion processes are discussed in much more
+detail in a separate document <ulink
+url="http://dcpomatic.com/manual/colour.pdf">colour.pdf</ulink>.
+</para>
+
+</section>
+
<!-- ============================================================== -->
<section>
<title>Other settings</title>
<para>
-The ‘crop’ settings can be used to crop your content,
+The <guilabel>crop</guilabel> settings can be used to crop your content,
which can be used to remove black borders from round the edges of DVD
images, for example. The specified number of pixels will be trimmed
from each edge, and the content image in the right of the window will
be updated to show the effect of the crop.
</para>
+<para>
+The <guilabel>fade in</guilabel> and <guilabel>fade out</guilabel>
+settings can be used to apply linear fades into and out of a piece of
+content. Specify the time for each, clicking <guilabel>Set</guilabel>
+after making any changes.
+</para>
+
<para>
The <guilabel>Scale to</guilabel> option governs the shape that
DCP-o-matic will scale the content's image into. Select the aspect
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Video description</title>
At the bottom of the video tab is a short description of what will
happen to your video with the current settings. In the example of
<xref linkend="fig-video-tab"/>, DCP-o-matic is telling you that the
-video file is 1920x1080 pixels (which is a ratio of 1.78:1). Since
-the controls specify ‘Flat’ for the ratio, DCP-o-matic
-scales the content image to 1998x1080, which is the DCI flat
-resolution at 2K.
+video file is 1920x1080 pixels and it has square pixels (a pixel
+aspect ratio of 1.00) hence its display aspect ratio is 1.78:1. Since
+the controls specify ‘16.9’ for the ratio, DCP-o-matic
+does not scale the image but pads it to the DCP's container ratio of
+1.85:1. For a 2K DCP this is 1998x1080 pixels.
</para>
<para>
This description also gives the frame rate of the content and what
-will happen to it when it is played at the DCP's frame rate.
-<!-- XXX: link to more detailed discussion of this -->
+will happen to it when it is played at the DCP's frame rate. See
+<xref linkend="ch-frame-rates"/> for details of DCP-o-matic's
+frame-rate conversion.
</para>
</section>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Audio</title>
The <guilabel>Audio</guilabel> tab controls properties of the image, as shown in <xref linkend="fig-audio-tab"/>.
</para>
-<figure id="fig-audio-tab">
+<figure id="fig-audio-tab">
<title>Audio settings tab</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/audio-tab&scs;"/>
- </imageobject>
- </mediaobject>
-</figure>
-
-<section>
-<title>Show audio</title>
-
-<para>
-The <guilabel>Show Audio</guilabel> button will instruct DCP-o-matic
-to examine the audio in your content and plot a graph of its level
-over time. This can be useful for getting a rough idea of how loud
-the sound will be in the cinema auditorium. A typical plot is shown
-in <xref linkend="fig-audio-plot"/>
-</para>
-
-<figure id="fig-audio-plot">
- <title>Audio plot</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="screenshots/audio-plot&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
-<para>
-The plot gives the audio level (vertical axis, in dB) with time
-(horizontal axis). 0dB represents full scale, so if there is anything
-near this you are in danger of clipping the projector's audio outputs.
-</para>
-<para>
-There are two plot types: the peak level and the RMS, which can be
-shown or hidden using the check-boxes on the right hand side of the
-window.
-</para>
+<!-- ============================================================== -->
+<section>
+<title>The audio map</title>
<para>
-The channel check-boxes will show or hide the plot(s) for
-the corresponding channels in the DCP.
+The section at the bottom of the audio tab is the ‘audio
+map’. This governs how sound from the content will be arranged
+in the DCP.
</para>
<para>
-The smoothing slider applies a variable degree of temporal smoothing
-to the plots, which can make them easier to read in some cases.
+Down the left-hand side of the map is the list of audio channels in
+the currently-selected piece of content. These are labelled with two
+numbers; the first is the stream index within the content and the
+second is the channel number within that stream. Some content will
+have different streams for different languages or audio mixes. Along
+the top is each channel in the DCP. A green box means that the
+corresponding content channel will be copied into the corresponding
+DCP channel.
</para>
<para>
-Obviously the audio plot is no substitute for listening in an
-auditorium, but it can be useful to get levels in the right rough area.
+When content channels are copied into DCP channels they can be done
+with variable gain. If, for example, you want to copy a channel
+as-is, you can set a gain of 0dB. Alternatively, if you want to mix
+two channels into one, you may want to use a gain of -6dB on each one
+to prevent clipping when the two channels are added.
</para>
-</section>
-
-<section>
-<title>The audio map</title>
-
<para>
-The section at the bottom of the audio tab is the ‘audio
-map’. This governs how sound from the content will be arranged
-in the DCP.
+The green boxes of the audio mapping view tell you (very roughly) how
+much gain is applied to each channel. A full-height box means 0dB
+(i.e. unity) gain. Any less height indicates lower gain.
</para>
<para>
-Down the left-hand side of the map is the list of audio channels in
-the currently-selected piece of content. Along the top is each
-channel in the DCP. A checked box means that the corresponding
-content channel will be copied into the corresponding DCP channel.
+To map one channel to another with 0dB gain, click in the empty box
+and it will turn green to reflect the mapping. A second click will
+turn the mapping back off. To set some other gain, right-click on the
+box to open the gain menu. This allows you to set
+<guilabel>Off</guilabel> (no mapping or negative infinity gain),
+<guilabel>Full</guilabel> (0dB gain), -6dB gain or
+<guilabel>Edit</guilabel> which allows you to set the required gain
+precisely.
</para>
<para>
<figure id="fig-audio-map-eg1">
<title>Audio map example 1</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/audio-map-eg1&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
<para>
Here, we have two channels in the source which are mapped to left and
-right, respectively, in the DCP. If we modify that as in <xref
-linkend="fig-audio-map-eg2"/>
+right, respectively, in the DCP. The full green boxes show that the
+mapping is at unity gain (0dB) in each case. Imagine that we modify
+the settings to those shown in <xref linkend="fig-audio-map-eg2"/>
</para>
<figure id="fig-audio-map-eg2">
<title>Audio map example 2</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/audio-map-eg2&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
<para>
-we now have the content's streams mapped to left and right and also
-mixed together and placed in the DCP's centre channel.
+We now have the content's streams mapped to left and right and also
+mixed together and placed in the DCP's centre channel. The smaller
+green boxes on the centre mappings show that those channels are added
+with some non-unity gain; you can see by hovering the mouse pointer
+over those boxes that the gain for content channels 1 and 2 is -6dB
+when being sent to the centre channel and 0dB when being sent to left
+and right.
</para>
<figure id="fig-audio-map-eg3">
<title>Audio map example 3</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/audio-map-eg3&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Other controls</title>
linkend="fig-calculate-audio-gain"/> will open.
</para>
-<figure id="fig-calculate-audio-gain">
+<figure id="fig-calculate-audio-gain">
<title>Calculating audio gain</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/calculate-audio-gain&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
with respect to the video, and a negative delay will move it earlier.
</para>
-<para>
-The <guilabel>Audio Stream</guilabel> option allows you to select the
-audio stream to use, if the content contains more than one. There
-might be different soundtrack languages, for example.
-</para>
-
</section>
</section>
+<!-- ============================================================== -->
<section>
<title>Subtitles</title>
content, as shown in <xref linkend="fig-subtitles-tab"/>.
</para>
-<figure id="fig-subtitles-tab">
+<figure id="fig-subtitles-tab">
<title>Subtitle settings tab</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/subtitles-tab&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
<para>
-DCP-o-matic will extract subtitles from the content, if present, and
-they can be ‘burnt into’ the DCP (that is, they are
-included in the image and not overlaid by the projector). Note that
-DVD and Blu-Ray subtitles are stored as bitmaps, so it is not possible
-(automatically) to use non-burnt-in subtitles with these sources.
-Select the <guilabel>With Subtitles</guilabel> check-box to enable
-subtitles. The <guilabel>offset</guilabel> control moves the
-subtitles up and down the image, and the <guilabel>scale</guilabel>
-control changes their size.
+DCP-o-matic can either:
</para>
+<itemizedlist>
+ <listitem>Extract ‘image’ subtitles that are embedded in video files, or</listitem>
+ <listitem>Use text subtitles from SubRip (<code>.srt</code>) or DCP XML files.</listitem>
+</itemizedlist>
+
<para>
-All being well, future versions of DCP-o-matic will include the option to
-use text subtitles (as is the norm with most professionally-mastered
-DCPs).
+Image subtitles are represented using a set of bitmaps, as commonly
+used on DVD and BluRay. Such subtitles can (currently) only be
+‘burnt’ into the DCP (that is, they are included in the
+image and not overlaid by the projector).
</para>
-</section>
+<para>
+With text subtitles you have the choice to either burn-in or include
+the subtitles as separate subtitle ‘asset’ within your DCP
+(in which case the projector overlays them onto the image on
+playback). The difference between burn-in and overlay is
+illustrated by <xref linkend="fig-burn-in"/> and <xref
+linkend="fig-discrete"/>.
+</para>
-<section>
+<figure id="fig-burn-in">
+ <title>Burnt-in subtitles</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="100" fileref="diagrams/burn-in&dia;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<figure id="fig-discrete">
+ <title>Separate subtitles</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="100" fileref="diagrams/discrete&dia;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+The advantage of separate subtitles is that the same video content can
+be used for DCPs in many different languages. This means that only a
+small text file needs to be changed for each target language, rather
+than a large video file. It also means that the time-consuming video
+encoding need only be done once for the project rather than once for
+every language.
+</para>
+
+<para>
+Select the <guilabel>Use Subtitles</guilabel> check-box to enable
+the subtitles in the selected content.
+</para>
+
+<para>
+Select the <guilabel>Burn subtitles into image</guilabel> check-box to
+burn these subtitles into the image; if this is not ticked the
+subtitles will be included separately in the DCP to be rendered by the
+projector. This check-box will always be ticked if you are using
+embedded ‘image’ subtitles.
+</para>
+
+<para>
+The <guilabel>X Offset</guilabel> and <guilabel>Y Offset</guilabel>
+controls move the subtitles around within the image. The offsets are
+expressed as a percentage of the video frame size; 100% X offset is
+the entire width of the frame, and 100% Y offset is the entire height.
+Hence, to move the subtitles down by half the frame height you would
+use a Y offset of 50%.
+</para>
+
+<para>
+The <guilabel>X Scale</guilabel> and <guilabel>Y Scale</guilabel>
+controls scale the subtitles. Scale values of 1 make the subtitles
+the same size (relative to the size of the image) as they are on the
+original. Values lower than 1 make them smaller, and values higher
+make them larger. You can stretch the subtitles in either direction
+by specifying different values for X and Y scale. Subtitles from DVD
+and Blu Ray sources are frequently larger (relative to the video
+frame) than those typically used for DCP, so it is often useful to
+scale such subtitles down using these controls.
+</para>
+
+<para>
+The <guilabel>Stream</guilabel> control changes the subtitle stream
+that is used when the content has more than one.
+</para>
+
+</section>
+
+
+<!-- ============================================================== -->
+<section>
<title>Timing</title>
<para>
content, as shown in <xref linkend="fig-timing-tab-detail"/>.
</para>
-<figure id="fig-timing-tab-detail">
+<figure id="fig-timing-tab-detail">
<title>Timing settings tab</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/timing-tab&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
linkend="fig-timecode"/>.
</para>
-<figure id="fig-timecode">
+<figure id="fig-timecode">
<title>Timecode</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="diagrams/timecode&dia;"/>
- </imageobject>
+ <imageobject>
+ <imagedata scale="100" fileref="diagrams/timecode&dia;"/>
+ </imageobject>
</mediaobject>
</figure>
</para>
<para>
-<guilabel>Video frame rate</guilabel> specifies the frame rate for still-image content.
+<guilabel>Video frame rate</guilabel> specifies the frame rate for
+still-image content. It can also be used to override the detected
+frame rate of other content if DCP-o-matic has got it wrong.
</para>
<para>
</section>
+
+<!-- ============================================================== -->
+<section>
+<title>Video processing pipeline</title>
+
+<para>
+This section gives a little more detail about how DCP-o-matic process
+video as it takes it from a source and puts it into a DCP.
+</para>
+
+<para>
+Consider, as a somewhat over-the-top example, that we have a 720 x 576
+image which is letterboxed with 36 black pixels each at the top and
+bottom, and the video content within the letterbox should be presented
+in the DCP at ratio of 2.39:1 within a 1.85:1 frame (such as might
+happen with a trailer). The source image is shown in <xref
+linkend="fig-pipeline1"/>.
+</para>
+
+<figure id="fig-pipeline1">
+ <title>Example image to demonstrate video processing</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="100" fileref="diagrams/pipeline1&dia;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+DCP-o-matic runs through the following steps when preparing an image for a DCP:
+</para>
+
+<itemizedlist>
+<listitem>Crop</listitem>
+<listitem>Scale</listitem>
+<listitem>Place in container</listitem>
+</itemizedlist>
+
+<para>
+First, some amount of the image can be cropped. This is almost always
+used to remove black borders (letterboxing and/or pillarboxing) around
+images.
+</para>
+
+<para>
+In our example image, we would use 36 pixels of crop from the top and
+bottom. This would give the new image shown in <xref
+linkend="fig-pipeline2"/>.
+</para>
+
+<figure id="fig-pipeline2">
+ <title>Example image after cropping</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="100" fileref="diagrams/pipeline2&dia;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+The next step is to scale the image. Since this content should be
+presented in a 2.39:1 aspect ratio inside a 1.85:1 DCP we would select
+<guilabel>Scope</guilabel> from the <guilabel>Scale to</guilabel>
+option in the <guilabel>Video</guilabel> tab and
+<guilabel>Flat</guilabel> from the <guilabel>Container</guilabel>
+option in the <guilabel>DCP</guilabel> tab.
+</para>
+
+<para>The <guilabel>Scale to</guilabel> option should always be set to
+the aspect ratio at which the content should be seen. The
+<guilabel>Container</guilabel> option should be set to the preset that
+you want to use on the projector. Of course, these two settings will
+often be the same.
+</para>
+
+<para>
+Given the scaling and container information, DCP-o-matic will look at
+the DCP's container size, and then scale the source image up until one
+or both of its dimensions (width, height or both) fits the size of the
+container, all the while preserving the desired aspect ratio.
+</para>
+
+<para>
+In our example here, the DCP's container is specified as 1.85:1 (so
+that the DCP will play back correctly using the projector's
+‘Flat’ preset). At 2K, 1.85:1 is 1998 pixels by 1080.
+Scaling the source up whilst preserving its 1.85:1 aspect ratio will
+result in the image hitting the sides of the container first, at a
+size of 1998 x 836. This gives us a new version of the image as shown
+in <xref linkend="fig-pipeline3"/>.
+</para>
+
+<figure id="fig-pipeline3">
+ <title>Example image after cropping and scaling</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="100" fileref="diagrams/pipeline3&dia;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+The final step is to place the image into the DCP. In this case,
+since we have a 2.39:1 image that should be presented as a 1.85:1 DCP,
+we have set the <guilabel>container</guilabel> in the
+<guilabel>DCP</guilabel> tab to be Scope. Since the content has been
+scaled to 1998 x 836, and a Flat container is 1998 x 1080, there will
+be some black bars at the top and bottom of the image. DCP-o-matic
+shares out this black equally, as shown in <xref
+linkend="fig-pipeline3"/>.
+</para>
+
+<figure id="fig-pipeline4">
+ <title>Example image in the DCP</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="100" fileref="diagrams/pipeline4&dia;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+</section>
+
</chapter>
<chapter xml:id="ch-dcp" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
the main window, as shown in <xref linkend="fig-dcp-tab"/>.
</para>
-<figure id="fig-dcp-tab">
+<figure id="fig-dcp-tab">
<title>DCP settings tab</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/dcp-tab&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
name</guilabel> is not ticked, the name that you specify will be used
as-is for the name of the DCP. If <guilabel>Use ISDCF name</guilabel>
is ticked, the name that you enter will be used as part of a
-ISDCF-compliant name.
+ISDCF-compliant name.
</para>
<para>
</para>
<para>
-If the DCP name is long, it may not all be visible. You can see the
-full name by hovering the mouse pointer over the partial name.
+If you want to take the ISDCF-compliant name that DCP-o-matic
+generates and modify it, click <guilabel>Copy as name</guilabel> and
+the ISDCF name will be copied into the <guilabel>Name</guilabel> box.
+You can then edit it as you wish. The DCP name should not matter (in
+that it should not affect how the DCP ingests or plays) but
+projectionists will appreciate it if you use the standard naming
+scheme as it makes it easier to identify details of the content.
+</para>
+
+<para>
+The <guilabel>Content Type</guilabel> option can be
+‘feature’, ‘trailer’ or whatever; select the
+required type from the drop-down list. On some projection systems
+this will affect where your content appears in the projector's server
+user interface, so take care to select an appropriate type.
+</para>
+
+<para>
+The <guilabel>Signed</guilabel> check-box sets whether or not the DCP
+is signed. This is rarely important; if in doubt, tick it.
+</para>
+
+<para>
+The <guilabel>Encrypted</guilabel> check-box will set whether the DCP
+should be encrypted or not. If this is ticked, the DCP will require a
+KDM to play back. Encryption is discussed in <xref
+linkend="ch-encryption"/>.
+</para>
+
+<para>
+If you use encryption DCP-o-matic will generate a random encryption
+key for you. To specify your own key, click the
+<guilabel>Edit..</guilabel> button next to the key.
+</para>
+
+<para>
+The <guilabel>Reels</guilabel> and <guilabel>Reel length</guilabel>
+controls specify how the DCP will be split up into
+‘reels’. See <xref linkend="sec-reels"/> below.
+</para>
+
+<para>
+The <guilabel>Standard</guilabel> option specifies which of the two
+DCP standards DCP-o-matic should use. If in doubt, use SMPTE (the
+more modern of the two).
+</para>
+
+<para>
+At the bottom of the DCP tab are a further two tabs, one each to
+contain the settings for the DCP's video and audio parts.
</para>
<para>
for the content's ratio and ‘Flat’ for the DCP.
</para>
-<para>
-Next up is the content type. This can be
-‘feature’, ‘trailer’ or whatever; select the
-required type from the drop-down list.
-</para>
-
<para>
The <guilabel>Frame Rate</guilabel> control sets the frame rate of
your DCP. This can be a little tricky to get right. Ideally, you
</para>
<para>
-The <guilabel>Signed</guilabel> check-box sets whether or not the DCP
-is signed. This is rarely important; if in doubt, tick it.
+The <guilabel>Use best</guilabel> button sets the DCP video frame rate
+to what DCP-o-matic thinks is the best given the content that you have
+added.
</para>
<para>
-The <guilabel>Encrypted</guilabel> check-box will set whether the DCP
-should be encrypted or not. If this is ticked, the DCP will require a
-KDM to play back. Encryption is discussed in <xref
-linkend="ch-encryption"/>.
+The <guilabel>3D</guilabel> button will set your DCP to 3D mode if it
+is checked. A 3D DCP will then be created, and any 2D content will be
+made 3D compatible by repeating the same frame for both left and right
+eyes. A 3D DCP can be played back on many 3D systems (e.g. Dolby 3D,
+Real-D etc.) but not on a 2D system.
</para>
<para>
-The <guilabel>Use best</guilabel> button sets the DCP video frame rate
-to what DCP-o-matic thinks is the best given the content that you have
-added.
+The <guilabel>Resolution</guilabel> tab allows you to choose the
+resolution for your DCP. Use 2K unless you have content that is of
+high enough resolution to be worth presenting in 4K.
+</para>
+
+<para>
+The <guilabel>JPEG2000 bandwidth</guilabel>; setting changes how big
+the final image files used within the DCP will be. Larger numbers
+will give better quality, but correspondingly larger DCPs. The
+bandwidth can be between 50 and 250 megabits per second (Mbit/s).
+Most commercial DCPs use bit rates between 75 and 125 MBit/s.
</para>
<para>
The <guilabel>Audio Channels</guilabel> control sets the number of
audio channels that the DCP will have. If the DCP has any channels
for which there is no content audio they will be replaced by silence.
+You can only set an even number of channels here, since that is
+required by the DCI standard. If you want an odd number of channels,
+set the DCP channel count to one greater than you need and the
+unused channel will be filled with silence.
</para>
<para>
-The <guilabel>3D</guilabel> button will set your DCP to 3D mode if it
-is checked. A 3D DCP will then be created, and any 2D content will be
-made 3D compatible by repeating the same frame for both left and right
-eyes. A 3D DCP can be played back on many 3D systems (e.g. Dolby 3D,
-Real-D etc.) but not on a 2D system.
+The <guilabel>Processor</guilabel> control allows you to select a
+process to apply to the audio before it goes into the DCP. Three processes are currently provided:
+</para>
+
+<itemizedlist>
+<listitem>Mid-side decode — this will take a L/R
+stereo input and extract the common part (corresponding to the
+‘Mid’ in a mid-side signal) into the DCP's centre channel.
+The remaining L/R parts will be kept in the L/R channels of the DCP.
+This may be useful to make near-field L/R mixes more compatible with
+cinema audio systems.</listitem>
+<listitem>Stereo to 5.1 up-mixer A — this will take a stereo input and up-mix it to ‘fake’ 5.1. The input L/R are treated as follows:
+<itemizedlist>
+<listitem>DCP L is input L bandpass-filtered between 1.9kHz and 4.8kHz.</listitem>
+<listitem>DCP R is input R bandpass-filtered between 1.9kHz and 4.8kHz.</listitem>
+<listitem>DCP C is input L mixed with input R, taken down by 3dB and then bandpass-filtered between 150Hz and 1.9kHz.</listitem>
+<listitem>DCP Lfe is input L mixed with input R, taken down by 3dB and then bandpass-filtered between 20Hz and 150Hz.</listitem>
+<listitem>DCP Ls is input L bandpass-filtered between 4.8kHz and 20kHz.</listitem>
+<listitem>DCP Rs is input R bandpass-filtered between 4.8kHz and 20kHz.</listitem>
+</itemizedlist>
+<para>
+This upmixing algorithm is due to Gérald Maruccia.
</para>
+</listitem>
+<listitem>Stereo to 5.1 up-mixer B — this uses a different approach:
+<itemizedlist>
+ <listitem>DCP L is input L.</listitem>
+ <listitem>DCP R is input R.</listitem>
+ <listitem>DCP C is input L + input R taken down by 3dB.</listitem>
+ <listitem>DCP Lfe is DCP C bandpass filtered between 20Hz and 150Hz.</listitem>
+ <listitem>DCP Ls and Rs are input L - input R with a 20ms delay.</listitem>
+</itemizedlist>
+</listitem>
+</itemizedlist>
+
+<!-- ============================================================== -->
+<section xml:id="sec-reels">
+<title>Reels</title>
<para>
-The <guilabel>Resolution</guilabel> tab allows you to choose the
-resolution for your DCP. Use 2K unless you have content that is of
-high enough resolution to be worth presenting in 4K.
+A ‘reel’ in a DCP is a subsection of the DCP, in the same
+way as a 35mm reel is a section of a film. A DCP can be split up into
+any number of reels and the joins (the equivalent to 35mm splices)
+between the reels are seamless.
</para>
<para>
-The <guilabel>JPEG2000 bandwidth</guilabel>; setting changes how big the final
-image files used within the DCP will be. Larger numbers will give
-better quality, but correspondingly larger DCPs. The bandwidth can be
-between 50 and 250 megabits per second (Mbit/s).
+There is no reason why you can't just use a single reel for the whole
+of your DCP, as there is no limit on their length. Many people choose
+to do this.
</para>
<para>
-The <guilabel>Standard</guilabel> option specifies which of the two
-DCP standards DCP-o-matic should use. If in doubt, use SMPTE (the
-more modern of the two).
+There are, however, some possible advantages of splitting things up
+into reels:
+</para>
+
+<itemizedlist>
+<listitem>
+The picture, sound and subtitle data of the DCP will be
+split up into more smaller files on disk, rather than fewer larger
+files. This can be useful if the DCP is to be transferred on storage
+that have file size limits. The FAT32 filesystem, for example, can
+only hold files smaller than 4Gb. A 6Gb DCP with a single reel could
+not be transferred using a FAT32-formatted disk. If that DCP were
+split up into two 3Gb reels it could be transferred.
+</listitem>
+<listitem>
+It is easier to re-use DCP components if they are in reels. Consider,
+for example, a film company who wants to put a 5 second ident onto the
+beginning of DCPs that they distribute. If they receive a feature
+film DCP they can modify it to add their ident as a separate reel.
+This is easier than attaching the picture data in the DCP.
+</listitem>
+</itemizedlist>
+
+<para>
+DCP-o-matic offers three options for setting up the reels in your DCP:
+single reel, split by video content or custom.
+</para>
+
+<para>
+<guilabel>Single reel</guilabel>, as its name suggests, keeps the whole DCP as one reel.
+This is a perfectly good option if you have no particular reason to
+need reels.
</para>
<para>
-Finally, the <guilabel>scaler</guilabel> is the method that will be used to scale up
-your content to the required size for the DCP, if required. Bicubic is a fine choice in
-most situations.
+<guilabel>Split by video content</guilabel> puts each piece of source
+video content in its own reel, as shown in <xref linkend="fig-reels-by-video"/>.
+</para>
+
+<figure id="fig-reels-by-video">
+<title>Making reels using split by video content</title>
+<mediaobject><imageobject><imagedata scale="100" fileref="diagrams/reels-by-video&dia;"/></imageobject></mediaobject>
+</figure>
+
+<para>
+Here we have three video files (<code>ident.mp4</code>,
+<code>feature.ts</code> and <code>cred.mov</code>). With
+<guilabel>split by video content</guilabel> DCP-o-matic makes a new
+reel to hold each video file.
+</para>
+
+<para>
+<guilabel>Custom</guilabel> splits reels by the size of the files that
+will make up their video content. With <guilabel>Custom</guilabel>
+you must specify a reel length in Gb. Then no file in the DCP will be larger than this reel length.
+</para>
+
+</section>
+
+
+<!-- ============================================================== -->
+<section>
+<title>Show audio</title>
+
+<para>
+The <guilabel>Show Audio</guilabel> button will instruct DCP-o-matic
+to examine the audio in your content and plot a graph of its level
+over time. This can be useful for getting a rough idea of how loud
+the sound will be in the cinema auditorium. A typical plot is shown
+in <xref linkend="fig-audio-plot"/>
</para>
+<figure id="fig-audio-plot">
+ <title>Audio plot</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="screenshots/audio-plot&scs;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+The plot gives the audio level (vertical axis, in dB) with time
+(horizontal axis). 0dB represents full scale, so if there is anything
+near this you are in danger of clipping the projector's audio outputs.
+</para>
+
+<para>
+There are two plot types: the peak level and the RMS, which can be
+shown or hidden using the check-boxes on the right hand side of the
+window.
+</para>
+
+<para>
+The channel check-boxes will show or hide the plot(s) for
+the corresponding channels in the DCP.
+</para>
+
+<para>
+The smoothing slider applies a variable degree of temporal smoothing
+to the plots, which can make them easier to read in some cases.
+</para>
+
+<para>
+Obviously the audio plot is no substitute for listening in an
+auditorium, but it can be useful to get levels in the right rough area.
+</para>
+
+</section>
+
</chapter>
<chapter xml:id="ch-encryption" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
DCP-o-matic can create encrypted DCPs and KDMs for them.
</para>
+
+<!-- ============================================================== -->
<section>
<title>Basics</title>
DCP's creators can read them. In particular, this means copies of the
DCP can be distributed by insecure means: if an ne'er-do-well called
Mallory obtains a hard drive containing an encrypted DCP, there is no
-way that he can play it. Only those cinemas who receive a key
+way that he can play it. Only those cinemas who receive a correct key
delivery message (KDM) can play the DCP.
</para>
+
+<!-- ============================================================== -->
<section>
<title>How it works (in a nutshell)</title>
</para>
<para>
-We suppose that we are trying to distribute a DCP to
-Alice's cinema, without a troublemaker called Mallory being able to
+We suppose that we are trying to send a DCP to
+Alice's cinema without a troublemaker called Mallory being able to
watch it himself.
</para>
</para>
<para>
-The clever bit in DCP encryption requires the use of public-key
+The clever bit in the process requires the use of public-key
encryption. With this technique we can encrypt a block of data using
some ‘public’ key. That data can then only be decrypted
-using a <emphasis>different</emphasis> ‘private’ key. The
-private and public keys are related mathematically, but it is
+using a corresponding private key which is
+<emphasis>different</emphasis> to the public key. The private and
+public keys form a pair which are related mathematically, but it is
extremely hard (or rather, virtually impossible) to derive the private
key from the public key.
</para>
</section>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Encryption using DCP-o-matic</title>
<para>
The first part is simple: ticking the <guilabel>Encrypted</guilabel>
-box in the <guilabel>DCP</guilabel> tab of DCP-o-matic will encrypt
-the DCP using a random key that DCP-o-matic generates. The key will
-be written to the film's metadata file, so that should be kept
-secure.
+box in the <guilabel>DCP</guilabel> tab will instruct DCP-o-matic to
+encrypt the DCP that it makes using a random key that DCP-o-matic
+generates. The key will be written to the film's metadata file, which
+should be kept secure.
</para>
<para>
</para>
<para>
-The second part is to generate KDMs for the cinemas that you wish to
-allow to play your DCP. This is done using the <guilabel>Make
-KDMs</guilabel> option on the <guilabel>Jobs</guilabel> menu. This
-will open the KDM dialogue box, as shown in <xref linkend="fig-kdm"/>.
+The second part of distributions is to generate KDMs for the cinemas
+that you wish to allow to play your DCP. There are two approaches to
+this within DCP-o-matic: using the project, or using a DKDM. These
+approaches are now described in turn.
+</para>
+
+<section>
+<title>Creating KDMs from a DCP-o-matic project</title>
+
+<para>
+You can create KDMs from inside a DCP-o-matic project using the
+<guilabel>Make KDMs</guilabel> option on the <guilabel>Jobs</guilabel>
+menu. This will open the KDM dialogue box, as shown in <xref
+linkend="fig-kdm"/>.
</para>
<figure id="fig-kdm">
- <title>KDM dialog</title>
+ <title>KDM dialog</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/kdm&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
</para>
<para>
-DCP-o-matic can store these certificates to make life easier. It
-stores details of cinemas and screens within those cinemas. Each
-screen has a certificate for its projector. DCP-o-matic can generate
-KDMs for any screens that it knows about.
+DCP-o-matic can store these certificates along with details of their
+cinemas and screens within those cinemas. Each screen has a
+certificate for its projector (and optionally certificates for other
+trusted devices, such as the sound processor). DCP-o-matic can
+generate KDMs for any screens that it knows about.
</para>
<para>
To add a cinema, click <guilabel>Add Cinema...</guilabel>. This opens
a dialogue box into which you can enter the cinema's name, and
optionally an email address. This email address can be used to
-get DCP-o-matic to deliver KDMs via email, but it is optional.
+get DCP-o-matic to deliver KDMs via email.
</para>
<para>
</para>
<para>
-Once you have set up all the screens that you need KDMs for,
-DCP-o-matic can generate KDMs for the last DCP that you generated for
-the currently-loaded film. Select the cinemas and/or screens that you
-want KDMs for and fill in the start and end dates and times.
+Alternatively, certificates for projection systems made by some
+manufacturers can be downloaded from databases provided by the
+manufacturer. Currently this is supported for Doremi and Dolby
+equipment. If you are targeting a screen with equipment by one of
+these manufacturers you can click <guilabel>Download</guilabel> then
+enter the serial number of the server in the screen and click
+<guilabel>Download</guilabel> again and, all being well, the certificate
+will be fetched.
+</para>
+
+<para>
+Using the download system you will need to know the serial number of
+the media server in use in the screen. Most cinema projection or
+technical departments will know these serial numbers.
+</para>
+
+<para>
+Note that the reliability of the manufacturers' certificate databases
+cannot be guaranteed. It is vital that KDMs are tested by the
+destination cinema will in advance of show time to identify any
+problems.
+</para>
+
+<para>
+Once you have set up all the screens that you need KDMs for, select
+the CPL that you want to create the KDM for. You can use the
+drop-down list to select the CPLs in the current film project, or load
+a CPL from somewhere else. Select the cinemas and/or screens that you
+want KDMs for and fill in the start and end dates and times.
+</para>
+
+<para>
+You must also select the type of KDM that you want to generate. If in
+doubt, use <guilabel>Modified Transitional 1</guilabel>.
</para>
<para>
</section>
+<section>
+<title>Creating KDMs using a DKDM</title>
+</section>
+
+<para>
+It can be inconvenient to need a whole DCP-o-matic project just to
+create KDMs for its film. Perhaps you want to archive the project to
+save space, or create KDMs on a different machine. In such situations
+it is easier to use a DKDM. This is a normal KDM, but instead of
+being targeted at a projection system (to allow it to decrypt the
+content) it is targeted at a particular users's certificate. This
+means that the certificate owner can create new KDMs for other users.
+The DKDM holds everything that is required to create further KDMs.
+</para>
+
+<para>
+Sometimes it is useful to create DKDMs that can be used by
+DCP-o-matic. If you create such a DKDM you can keep it and then, at
+any point in the future, use DCP-o-matic's standalone KDM creator to
+make KDMs for the DKDM's film for any cinema.
+</para>
+
+<para>
+In other cases a DKDM is sent to a 3rd party so that they can create
+KDMs for your films. This can be useful if, for example, you have a
+distributor who provides 24-hour KDM support to cinemas and can create
+KDMs for anybody that requires them at short notice.
+</para>
+
+<para>
+To create a DKDM for DCP-o-matic, open your encrypted project and
+select <guilabel>Make DKDM for DCP-o-matic...</guilabel> from the
+<guilabel>Jobs</guilabel> menu. Select the CPL that you want to make
+the DKDM for and click <guilabel>OK</guilabel>. This DKDM will then
+be available in the KDM creator. This is a separate program which you
+can start from the same place that you start the ‘Normal’
+DCP-o-matic. Its window is shown in <xref linkend="fig-kdm-creator"/>.
+</para>
+
+<figure id="fig-kdm-creator">
+ <title>The KDM creator</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="screenshots/kdm-creator&scs;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+To create KDMs, select the cinema(s) and/or screens that you want KDMs
+to be created for, the date range, the DCP that the KDMs are for and
+the destination for the KDMs and click <guilabel>Create
+KDMs</guilabel>.
+</para>
+
+<para>
+By default the <guilabel>DKDM</guilabel> list will list any DCPs for
+which you have clicked <guilabel>Make DKDM for
+DCP-o-matic</guilabel>in the main DCP-o-matic program. If you have
+other DKDMs you can add them by clicking <guilabel>Add...</guilabel> and
+specifying the file containing the DKDM.
+</para>
+
+<para>
+If another organisation wants to send you a DKDM they will ask you for
+a target certificate. You can get DCP-o-matic's target certificate by
+opening <guilabel>Preferences</guilabel> and clicking <guilabel>Export
+DCP decryption certificate...</guilabel> in the <guilabel>Keys</guilabel>
+tab.
+
+</para>
+
+</section>
+
+<section>
+<title>Encryption overview</title>
+
+<figure id="fig-encryption-overview">
+ <title>Overview of encryption</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="diagrams/crypt&dia;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+</section>
</chapter>
+
+<!-- ============================================================== -->
<chapter xml:id="ch-preferences" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>Preferences</title>
behaviour. This chapter explains those options.
</para>
+
+<!-- ============================================================== -->
<section>
<title>The preferences dialogue</title>
<para>
The preferences dialogue is opened by choosing
<guilabel>Preferences...</guilabel> from the <guilabel>Edit</guilabel>
-menu. The dialogue is split into five tabs.
+menu. The dialogue is split into seven tabs.
</para>
+<!-- ============================================================== -->
<section>
-<title>Miscellaneous</title>
+<title>General</title>
<para>
-The miscellaneous tab is shown in <xref linkend="fig-prefs-misc"/>.
+The general tab is shown in <xref linkend="fig-prefs-general"/>.
</para>
-<figure id="fig-prefs-misc">
- <title>Miscellaneous preferences</title>
+<figure id="fig-prefs-general">
+ <title>General preferences</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="screenshots/prefs-misc&scs;"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="screenshots/prefs-general&scs;"/>
+ </imageobject>
</mediaobject>
</figure>
+
+<!-- ============================================================== -->
<section>
<title>Language</title>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Threads</title>
</section>
+<!-- ============================================================== -->
<section>
-<title>KDM emails</title>
+<title>Updates</title>
<para>
-DCP-o-matic can send KDMs (see <xref linkend="ch-encryption"/>) to
-cinemas (or anywhere else) via email. To make this work, enter a
-suitable outgoing mail (SMTP) server and ‘from’ address
-for these emails.
+The <guilabel>Check for updates on startup</guilabel> option, if
+enabled, will tell DCP-o-matic to check on <ulink
+url="http://dcpomatic.com/">dcpomatic.com</ulink> to see if there any
+newer versions of DCP-o-matic then the one you are running. If so, a
+dialogue box will open with a link to download the new version.
+available
</para>
+<para>
+The <guilabel>Check for testing updates as well as stable
+ones</guilabel> option will also check for test updates as well as
+those that are formally ‘released’. This is useful if you
+like to live on the bleeding edge!
+</para>
</section>
+<!-- ============================================================== -->
<section>
-<title>Defaults</title>
+<title>Issuer and creator</title>
<para>
-The next few options allow you to set up default values for several
-properties of new films that you create.
+With these controls you can set the issuer and creator strings that
+will be put into the DCPs which you create.
</para>
-
</section>
+
</section>
+<!-- ============================================================== -->
<section>
-<title>Colour conversions</title>
+<title>Defaults</title>
<para>
-The colour conversions tab is shown in <xref linkend="fig-prefs-colour-conversions"/>.
+The defaults tab is shown in <xref linkend="fig-prefs-defaults"/>.
</para>
-<figure id="fig-prefs-colour-conversions">
- <title>Colour conversions preferences</title>
+<figure id="fig-prefs-defaults">
+ <title>Defaults preferences</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="screenshots/prefs-colour-conversions&scs;"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="screenshots/prefs-defaults&scs;"/>
+ </imageobject>
</mediaobject>
</figure>
<para>
-As part of the encoding process, DCP-o-matic has to convert the colour
-space of the source files that you use into XYZ, the colour space used
-by the DCI standard.
+The options in this tab simply allow you to set up default values for
+various properties of new films.
+</para>
+
+</section>
+
+<!-- ============================================================== -->
+<section>
+<title>Servers</title>
+
+<para>
+The servers tab is shown in <xref linkend="fig-prefs-servers"/>.
</para>
+<figure id="fig-prefs-servers">
+ <title>Servers preferences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="screenshots/prefs-servers&scs;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
<para>
-Colour conversion is discussed in more detail in a separate document
-<ulink url="http://dcpomatic.com/manual/colour.pdf">colour.pdf</ulink>.
+If <guilabel>Use all servers</guilabel> is ticked DCP-o-matic will
+locate encoding servers automatically (see <xref
+linkend="ch-servers"/>).
</para>
<para>
-These preferences control a list of presets which are suitable for
-converting from common input colour spaces to XYZ.
+Instead of this (or in addition) servers can be specified explicitly.
+To add a server, click <guilabel>Add...</guilabel> and enter the host
+name or IP address of the server to use.
</para>
</section>
-<section>
-<title>Metadata</title>
+
+<!-- ============================================================== -->
+<section xml:id="sec-prefs-keys">
+<title>Keys</title>
<para>
-The metadata tab is shown in <xref linkend="fig-prefs-metadata"/>.
+The Keys tab (shown in <xref linkend="fig-prefs-keys"/>) holds options
+related to the keys and certificates used in some parts of DCP
+creation.
</para>
-<figure id="fig-prefs-metadata">
- <title>Metadata preferences</title>
+<figure id="fig-prefs-keys">
+ <title>Keys preferences</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="screenshots/prefs-metadata&scs;"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="screenshots/prefs-keys&scs;"/>
+ </imageobject>
</mediaobject>
</figure>
<para>
-This allows you to set up a couple of identifiers that are written
-into the DCP. The default values should cause no problems.
+At the top of the tab is the chain of certificates that will be used
+to sign DCPs and KDMs. DCP-o-matic creates a random chain when you
+first run it and if you are happy to use this chain you can ignore the
+preferences. Otherwise, you can add or remove certificates from the
+chain using the <guilabel>Add...</guilabel> and
+<guilabel>Remove</guilabel> buttons.
+</para>
+
+<para>
+If you want DCP-o-matic to re-create the certificate chain (using new,
+random certificates) click <guilabel>Re-make
+certificates...</guilabel> and specify your organisation and common
+names in the dialogue box that opens.
+</para>
+
+<para>
+Underneath the certificate chain is the private key that corresponds
+to the leaf certificate in the chain. You can specify your own
+private key by clicking <guilabel>Load...</guilabel>. You must do
+this if you change the leaf certificate, so that the leaf private key
+corresponds to the public key held in the leaf certificate.
+</para>
+
+<para>
+Underneath the details of the certificate chain and private key for
+signing of DCPs and KDMs is a second chain and key which is used by
+DCP-o-matic when you import an encrypted DCP as a piece of content.
+The leaf certificate of this chain contains the public key that should
+be used when targeting a KDM at DCP-o-matic.
+</para>
+
+<para>
+If you want to import an encrypted DCP you will need to give the
+decryption certificate to the distributor of the DCP so that they can
+generate a DKDM for you. You can save this certificate to disk by
+clicking <guilabel>Export DCP decryption certificate...</guilabel>. As
+with the signing chain, DCP-o-matic will create a certificate chain
+and private key for you. You can also choose to load your own
+certificates and key or re-make the chain and key with new, random
+values.
</para>
</section>
+<!-- ============================================================== -->
<section xml:id="sec-prefs-tms">
<title>TMS</title>
+<titleabbrev xml:id="sec-prefs-tms-short">TMS preferences</titleabbrev>
<para>
The TMS tab (shown in <xref linkend="fig-prefs-tms"/>) gives some
options for specifying details about your theatre management system
-(TMS). If you do this, and your TMS accepts SSH connections, you can
-upload DCPs directly from DCP-o-matic to the TMS using the
+(TMS). If you do this, and your TMS accepts SSH or FTP connections,
+you can upload DCPs directly from DCP-o-matic to the TMS using the
<guilabel>Send DCP to TMS</guilabel> option in the
<guilabel>Jobs</guilabel> menu.
</para>
-<figure id="fig-prefs-tms">
- <title>TMS preferences</title>
+<figure id="fig-prefs-tms">
+ <title>TMS preferences</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/prefs-tms&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
+<para>
+<guilabel>Protocol</guilabel> should be set to SCP or FTP as
+appropriate for your TMS. We know that the Arts Alliance Media (AAM)
+and the Doremi ranges uses SCP connections, and that Dolby's TMSs use
+FTP. Do let us know if you use any other type of TMS with the
+<guilabel>Send DCP to TMS</guilabel> feature.
+</para>
+
<para>
<guilabel>TMS IP address</guilabel> should be set to the IP address of
your TMS, <guilabel>TMS target path</guilabel> to the place that DCPs
should be uploaded to (which will be relative to the home directory of
-the SSH user). Finally, the user name and password are the
-credentials required to log into the TMS via SSH.
+the SSH or FTP user). Finally, the user name and password are the
+credentials required to log into the TMS via SSH or FTP.
+</para>
+
+<para>
+Note that for this to work on Doremi servers you will need to set the
+<code>PasswordAuthentication</code> option in your server's
+<code>sshd_config</code> to <code>yes</code>.
</para>
+
</section>
+
+<!-- ============================================================== -->
<section>
<title>KDM email</title>
The KDM email is shown in <xref linkend="fig-prefs-kdm-email"/>.
</para>
-<figure id="fig-prefs-kdm-email">
- <title>KDM email preferences</title>
+<figure id="fig-prefs-kdm-email">
+ <title>KDM email preferences</title>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="screenshots/prefs-kdm-email&scs;"/>
- </imageobject>
+ </imageobject>
</mediaobject>
</figure>
<para>
This is a template for the email that is used to send KDMs out to
-cinemas. You can change it to say whatever you like. The
-‘magic’ string <code>$CPL_NAME</code> will be replaced by
-DCP's title.
+cinemas. You can change it to say whatever you like. A few
+‘magic’ strings will be replaced by information from the
+KDM that is being sent:
+</para>
+
+<table>
+<title>‘Magic’ KDM strings</title>
+<tgroup cols='2' align='left' colsep='1' rowsep='1'>
+<tbody>
+<row>
+<entry><code>$CPL_NAME</code></entry><entry>DCP title</entry>
+</row>
+<row>
+<entry><code>$CINEMA_NAME</code></entry><entry>Cinema name</entry>
+</row>
+<row>
+<entry><code>$SCREENS</code></entry><entry>Name of screen or screens that KDMs are being generated for</entry>
+</row>
+<row>
+<entry><code>$START_TIME</code></entry><entry>The time from which the KDMs are valid</entry>
+</row>
+<row>
+<entry><code>$END_TIME</code></entry><entry>The time until which the KDMs are valid</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+
+<para>
+The <guilabel>Reset to default text</guilabel> will replace the current KDM email with DCP-o-matic's default.
</para>
</section>
-</section>
+
+<!-- ============================================================== -->
+<section xml:id="sec-prefs-advanced">
+<title>Advanced</title>
+<titleabbrev xml:id="sec-prefs-advanced-short">Advanced preferences</titleabbrev>
+
+<para>
+The advanced preferences are shown in <xref linkend="fig-prefs-advanced"/>.
+</para>
+
+<figure id="fig-prefs-advanced">
+ <title>Advanced preferences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="screenshots/prefs-advanced&scs;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+<guilabel>Maximum JPEG2000 bandwidth</guilabel> specifies the maximum
+bit-rate of JPEG2000 that DCP-o-matic will allow you to create. You
+are advised to leave this at 250Mbit/s in normal use for maximum DCP
+compatibility.
+</para>
+
+<para>
+<guilabel>Allow any DCP frame rate</guilabel> removes the limits on
+the DCP video frame rates that DCP-o-matic will create. This may be
+useful for experimentation. Again, you are strongly advised to leave
+this unticked for normal use.
+</para>
+
+<para>
+<guilabel>Only servers encode</guilabel> makes DCP-o-matic encode
+JPEG2000 data only on encoding servers and not on the host. We
+suggest you leave this un-ticked unless you have a good reason to do otherwise.
+</para>
+
+<para>
+The four checkboxes labelled <guilabel>Log</guilabel> control what
+sort of messages DCP-o-matic writes to its log file when creating a
+DCP. It is useful to leave <guilabel>General</guilabel>,
+<guilabel>Warnings</guilabel> and <guilabel>Errors</guilabel> ticked
+as this makes the log files useful for tracking down bugs.
+</para>
+
+<para>
+The <guilabel>Timing</guilabel> checkbox will enable extra log entries
+to allow developers to investigate and optimize the speed of
+DCP-o-matic. It will significantly increase the size of the log files
+that are generated, so in normal use it is best to leave this
+unticked.
+</para>
+
+</section>
+</section>
</chapter>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" xml:id="ch-frame-rates">
however, always possible.
</para>
+
+<!-- ============================================================== -->
<section>
-<title>DCP rate limitations</title>
+<title>DCP frame rate limitations</title>
<para>
-There are some limitations to video and audio rates in DCPs. This is
+There are some limitations to video and audio frame rates in DCPs. This is
complicated by the fact that not all projectors will play DCPs at the
-same rates. It is possible to create a DCP which one projector will
+same frame rates. It is possible to create a DCP which one projector will
play fine, but another (of a different type) will refuse to play, or
even refuse to ingest.
</para>
+
+<!-- ============================================================== -->
<section>
<title>Guaranteed rates</title>
<para>
The only rates that are (pretty much) guaranteed to work on all DCI
-projectors is 24 frames per second (fps) for video and 48kHz or 96kHz
+projectors are 24 frames per second (fps) for video and 48kHz or 96kHz
for audio. If you are sending your DCPs to unknown places it wise to
consider using these rates if at all possible.
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Other often-supported rates</title>
<para>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Adapting content to fit the DCP rate</title>
audio would be running at the original speed with the video running
slowly. Hence the audio would drift slowly out of sync. To avoid
this, DCP-o-matic also resamples the audio such that the projector
-will play it too fast by the same amount. Hence it will sound
+will play it too slow by the same amount. Hence it will sound
slightly different but will remain in sync with the video.
</para>
</section>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Setting up</title>
The <guilabel>Frame Rate</guilabel> control in the
<guilabel>DCP</guilabel> tab sets the video frame rate that the DCP
will use. Clicking <guilabel>Use best</guilabel> sets the rate to
-what DVD-o-matic thinks is the best for your content. With this
+what DCP-o-matic thinks is the best for your content. With this
button, DCP-o-matic assumes that the whole range of frame rates (24,
25, 30 and 48fps) are allowable.
</para>
content.
</para>
+<para>
+If you want to experiment with other non-standard frame rates, you can
+do so by ticking the <guilabel>Allow any DCP frame rate</guilabel> in
+the <guilabel>Advanced</guilabel> tab of the preferences dialogue (see the
+<xref linkend="sec-prefs-advanced" endterm="sec-prefs-advanced-short"/>). You are strongly advised to
+use this only on your own equipment, and only for experimentation
+purposes.
+</para>
+
</section>
</chapter>
can mix Windows PCs, Macs and Linux machines as you wish.
</para>
+
+<!-- ============================================================== -->
<section>
<title>Running the servers</title>
</para>
<programlisting>
-dcpomatic_server_cli
+dcpomatic2_server_cli
</programlisting>
<para>
</para>
<programlisting>
-dcpomatic_server_cli -t 4
+dcpomatic2_server_cli -t 4
</programlisting>
<para>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Setting up DCP-o-matic</title>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Some notes about encode servers</title>
after you have created a DCP for a film called ‘DCP Test’.
</para>
-<figure id="fig-file-structure">
- <title>Creating a new film</title>
+<figure id="fig-file-structure">
+ <title>Creating a new film</title>
<mediaobject>
- <imageobject>
- <imagedata fileref="diagrams/file-structure&dia;"/>
- </imageobject>
+ <imageobject>
+ <imagedata scale="100" fileref="diagrams/file-structure&dia;"/>
+ </imageobject>
</mediaobject>
</figure>
This chapter collects a few notes on bits of DCP-o-matic that do not fit elsewhere in the manual.
</para>
+
+<!-- ============================================================== -->
<section>
<title>Resuming encodes</title>
projects / dcpomatic.git / blobdiff