Some manual updates.

[dcpomatic.git] / doc / manual / dcpomatic.xml

diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 2a948d3a77ef63a9c4940f7e9160c698abd9f5d7..e83f573451771248ed2c5344e7923bb5913ab959 100644 (file)
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -98,11 +98,17 @@ version.
 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
 url="http://dcpomatic.com/">http://dcpomatic.com/</ulink> and double
 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
 url="http://dcpomatic.com/">http://dcpomatic.com/</ulink> and double

-click to open it.  Then drag the DCP-o-matic icon to your
+click to open it.  Then drag the DCP-o-matics icon to your

 <guilabel>Applications</guilabel> folder or wherever else you would
 like to install it.
 </para>
 
 <guilabel>Applications</guilabel> folder or wherever else you would
 like to install it.
 </para>
 

+<para>
+You do not have to install all the applications, but you must always
+install <code>DCP-o-matic 2.app</code> as the other applications
+depend on it.
+</para>
+

 </section>
 
 <!-- ============================================================== -->
 </section>
 
 <!-- ============================================================== -->


@@ -119,7 +125,6 @@ like to install it.
   <listitem>Debian unstable (&lsquo;sid&rsquo;)</listitem>
   <listitem>Ubuntu 12.04 (&lsquo;Precise Pangolin&rsquo;)</listitem>
   <listitem>Ubuntu 14.04 (&lsquo;Trusty Tahr&rsquo;)</listitem>
   <listitem>Debian unstable (&lsquo;sid&rsquo;)</listitem>
   <listitem>Ubuntu 12.04 (&lsquo;Precise Pangolin&rsquo;)</listitem>
   <listitem>Ubuntu 14.04 (&lsquo;Trusty Tahr&rsquo;)</listitem>

-  <listitem>Ubuntu 15.04 (&lsquo;Vivid Vervet&rsquo;)</listitem>

   <listitem>Ubuntu 15.10 (&lsquo;Wily Werewolf&rsquo;)</listitem>
 </itemizedlist>
 
   <listitem>Ubuntu 15.10 (&lsquo;Wily Werewolf&rsquo;)</listitem>
 </itemizedlist>
 


@@ -171,10 +176,10 @@ thanks to Stefan Karner.
 
 <para>
 Installation on other Linux systems (for which no packages are
 
 <para>
 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.
+available) is quite hard as it must be compiled from source.  If you
+can't download packages for your distribution, 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>
 </para>
 
 <para>


@@ -233,10 +238,10 @@ in a shell.
 
 <!-- ============================================================== -->
 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
 
 <!-- ============================================================== -->
 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">

-<title>Creating a video DCP</title>
+<title>Creating a DCP from a video</title>

 
 <para>
 
 <para>

-In this chapter we will see how to create a video DCP using
+In this chapter we will see how to create a DCP from a video file using

 DCP-o-matic.  We will gloss over the details and look at the basics.
 </para>
 
 DCP-o-matic.  We will gloss over the details and look at the basics.
 </para>
 


@@ -248,7 +253,7 @@ Let's make a very simple DCP to see how DCP-o-matic works.  First, we
 need some content.  Download the low-resolution trailer for the open
 movie <ulink url="http://sintel.org/">Sintel</ulink> from <ulink
 url="http://ftp.nluug.nl/ftp/graphics/blender/apricot/trailer/Sintel_Trailer1.480p.DivX_Plus_HD.mkv">their
 need some content.  Download the low-resolution trailer for the open
 movie <ulink url="http://sintel.org/">Sintel</ulink> from <ulink
 url="http://ftp.nluug.nl/ftp/graphics/blender/apricot/trailer/Sintel_Trailer1.480p.DivX_Plus_HD.mkv">their

-website</ulink>.  Generally, of course, one would want to use the
+website</ulink>.  Generally one would want to use the

 highest-resolution material available, but for this test we will use
 the low-resolution version to save everyone's bandwidth bills.
 </para>
 highest-resolution material available, but for this test we will use
 the low-resolution version to save everyone's bandwidth bills.
 </para>


@@ -404,8 +409,8 @@ linkend="ch-files"/> for details about the files that DCP-o-matic creates.
 </para>
 
 <para>
 </para>
 
 <para>

-Alternatively, if  you have a  projector or Theatre  Management System
-(TMS) that is accessible via SCP across your network, you can upload
+Alternatively, if you have a projector or Theatre Management System
+(TMS) that is accessible via SCP or FTP 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>
 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>


@@ -416,7 +421,7 @@ linkend="sec-prefs-tms" endterm="sec-prefs-tms-short"/> in <xref linkend="sec-pr
 
 <!-- ============================================================== -->
 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
 
 <!-- ============================================================== -->
 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">

-<title>Creating a still-image DCP</title>
+<title>Creating a DCP from a still image</title>

 
 <para>
 DCP-o-matic can also be used to create DCPs of one or more still images, perhaps
 
 <para>
 DCP-o-matic can also be used to create DCPs of one or more still images, perhaps


@@ -425,7 +430,7 @@ how to do it.
 </para>
 
 <para>
 </para>
 
 <para>

-As with video DCPs, the first step is to create a new
+As with DCPs made from video files, the first step is to create a new

 &lsquo;Film&rsquo;; select <guilabel>New</guilabel> from the
 <guilabel>File</guilabel> menu and the new film dialogue will open as
 shown in <xref linkend="fig-still-new-film"/>.
 &lsquo;Film&rsquo;; select <guilabel>New</guilabel> from the
 <guilabel>File</guilabel> menu and the new film dialogue will open as
 shown in <xref linkend="fig-still-new-film"/>.


@@ -457,10 +462,10 @@ linkend="fig-still-select-content-file"/>.
 </figure>
 
 <para>
 </figure>
 
 <para>

-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>Play length</guilabel> setting, as shown in <xref
+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>Play length</guilabel> setting, as shown in <xref

 linkend="fig-timing-tab"/>.
 </para>
 
 linkend="fig-timing-tab"/>.
 </para>
 


@@ -482,7 +487,7 @@ fourth frames.  Enter the duration that you want and then click <guilabel>Set</g
 <para>
 Finally, as with video, you can choose <guilabel>Make DCP</guilabel>
 from the <guilabel>Jobs</guilabel> menu to create your DCP.  This will
 <para>
 Finally, as with video, you can choose <guilabel>Make DCP</guilabel>
 from the <guilabel>Jobs</guilabel> menu to create your DCP.  This will

-be much quicker than creating a video DCP, as DCP-o-matic only needs
+be much quicker than creating a DCP from a video file, as DCP-o-matic only needs

 to encode a single frame which it can then repeat.
 </para>
 
 to encode a single frame which it can then repeat.
 </para>
 


@@ -495,7 +500,7 @@ to encode a single frame which it can then repeat.
 
 <para>
 Frequently DCP-o-matic is used to take content in formats such as MP4
 
 <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
+and convert it to JPEG2000 for a DCP.  It can also be used

 to take existing DCPs and modify them in various ways.
 </para>
 
 to take existing DCPs and modify them in various ways.
 </para>
 


@@ -570,8 +575,8 @@ JPEG2000 encoding is not necessary.
 </para>
 
 <para>
 </para>
 
 <para>

-DCP-o-matic can do this if you avoid changes to the following content
-settings:
+DCP-o-matic can do this if you <emphasis>avoid</emphasis> changes to
+the following content settings:

 </para>
 
 <itemizedlist>
 </para>
 
 <itemizedlist>


@@ -644,7 +649,7 @@ To make a DCP like this:
 <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
 <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 &lsquo;Content DCP&rsquo;'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>
+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>
 
 <listitem>Do <guilabel>Make DCP</guilabel> as usual and your VF DCP will be created.</listitem>
 </itemizedlist>
 


@@ -697,7 +702,7 @@ images which should be treated as the frames of a video.
 
 <listitem>Subtitle &mdash; a file containing subtitle which will be
 superimposed on the image of the DCP.  These can be
 
 <listitem>Subtitle &mdash; a file containing subtitle which will be
 superimposed on the image of the DCP.  These can be

-<guilabel>.srt</guilabel> or <guilabel>.xml</guilabel>
+<guilabel>.srt</guilabel>, <guilabel>.ssa</guilabel> or <guilabel>.xml</guilabel>

 files.</listitem>
 
 <listitem>DCP &mdash; an existing DCP.</listitem>
 files.</listitem>
 
 <listitem>DCP &mdash; an existing DCP.</listitem>


@@ -1195,13 +1200,28 @@ content, as shown in <xref linkend="fig-subtitles-tab"/>.
 </figure>
 
 <para>
 </figure>
 
 <para>

-DCP-o-matic will extract subtitles from the content, if present, and
-they can be &lsquo;burnt into&rsquo; the DCP (that is, they are
-included in the image and not overlaid by the projector) or included
-as a separate subtitle &lsquo;asset&rsquo; within your DCP (in which
-case the projector overlays them onto the image on playback).  The
-difference between these two arrangements is illustrated by <xref
-linkend="fig-burn-in"/> and <xref linkend="fig-discrete"/>
+DCP-o-matic can either:
+</para>
+
+<itemizedlist>
+  <listitem>Extract subtitles that are embedded in video files, or</listitem>
+  <listitem>Use subtitles from SubRip (<code>.srt</code>), SubStation Alpha (<code>.ssa</code>) or DCP XML files.</listitem>
+</itemizedlist>
+
+<para>
+Embedded subtitles are usually represented using a set of bitmaps,
+especially on files that have come from DVD or BluRay.  Such subtitles
+can (currently) only be &lsquo;burnt&rsquo; into the DCP (that is,
+they are included in the image and not overlaid by the projector).
+</para>
+
+<para>
+With SubRip, SubStation Alpha or DCP subtitles you have the choice to
+either burn-in or include the subtitles as separate subtitle
+&lsquo;asset&rsquo; 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>
 
 <figure id="fig-burn-in">
 </para>
 
 <figure id="fig-burn-in">


@@ -1231,25 +1251,17 @@ encoding need only be done once for the project rather than once for
 every language.
 </para>
 
 every language.
 </para>
 

-<para>
-Note that subtitles come in two types: text and bitmap.  Text
-subtitles are expressed as plain text and can be either burnt into the
-image or included as a separate subtitle asset within the DCP.  Bitmap
-subtitles, on the other hand, are expressed as pre-rendered bitmaps.
-They cannot (yet) be added to the DCP as a separate asset and must be
-burnt into the image.
-</para>
-

 <para>
 Select the <guilabel>Use Subtitles</guilabel> check-box to enable
 <para>
 Select the <guilabel>Use Subtitles</guilabel> check-box to enable

-these subtitles.
+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
 </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.
+projector.  This check-box will always be ticked if you are using
+embedded &lsquo;image&rsquo; subtitles.

 </para>
 
 <para>
 </para>
 
 <para>


@@ -1278,6 +1290,17 @@ The <guilabel>Stream</guilabel> control changes the subtitle stream
 that is used when the content has more than one.
 </para>
 
 that is used when the content has more than one.
 </para>
 

+<para>
+If you are using non-embedded (text) subtitles you can see the
+subtitle text and timings by clicking the <guilabel>View...</guilabel>
+button, or specify the fonts that should be used by clicking <guilabel>Fonts...</guilabel>.
+</para>
+
+<para>
+With any subtitles you can click <guilabel>Appearance...</guilabel> to
+change how the subtitles look.
+</para>
+

 </section>
 
 
 </section>
 
 


@@ -1567,6 +1590,11 @@ DCP standards DCP-o-matic should use.  If in doubt, use SMPTE (the
 more modern of the two).
 </para>
 
 more modern of the two).
 </para>
 

+<para>
+Ticking the <guilabel>Upload DCP to TMS after it is made</guilabel>
+will ask DCP-o-matic to copy the finished DCP to your configured TMS (see <xref linkend="sec-prefs-tms"/>).
+</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>
 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.


@@ -1631,7 +1659,7 @@ unused channel will be filled with silence.
 
 <para>
 The <guilabel>Processor</guilabel> control allows you to select a
 
 <para>
 The <guilabel>Processor</guilabel> control allows you to select a

-process to apply to the audio before it goes into the DCP.  Two processes are currently provided:
+process to apply to the audio before it goes into the DCP.  Three processes are currently provided:

 </para>
 
 <itemizedlist>
 </para>
 
 <itemizedlist>


@@ -1910,10 +1938,10 @@ those cinemas that are allowed to play the DCP.
 
 <para>
 The first part is simple: ticking the <guilabel>Encrypted</guilabel>
 
 <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, which 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>


@@ -1924,10 +1952,10 @@ is).
 </para>
 
 <para>
 </para>
 
 <para>

-The second part 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 are now
-described in turn.
+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>
 </para>
 
 <section>


@@ -1957,11 +1985,11 @@ available by the projector manufacturers as text files with a
 </para>
 
 <para>
 </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 (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.
+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>
 </para>
 
 <para>


@@ -2035,7 +2063,7 @@ 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
 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

-begin targeted at a projection system (to allow it to decrypt the
+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.
 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.


@@ -2059,10 +2087,59 @@ KDMs for anybody that requires them at short notice.
 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
 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 choose where it should be written, then click
-<guilabel>OK</guilabel>.
+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 &lsquo;Normal&rsquo;
+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>
 

+<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>
 
 </section>
 </chapter>
 


@@ -2139,6 +2216,30 @@ to set this up correctly when you run it for the first time.
 
 </section>
 
 
 </section>
 

+<!-- ============================================================== -->
+<section>
+<title>Cinema and screen database file</title>
+
+<para>
+This option allows you to change the file that DCP-o-matic uses to
+store details of the cinemas and screens used to make KDMs.
+</para>
+
+</section>
+
+<section>
+<title>Integrated loudness</title>
+
+<para>
+If <guilabel>Find integrated loudness, true peak and loudness range
+when analysing audio</guilabel> is ticked, DCP-o-matic will do extra
+work when analysing audio.  Leave this ticked if the extra parameters
+are useful to you.  If not, untick it and audio analysis will be
+faster.
+</para>
+
+</section>
+

 <!-- ============================================================== -->
 <section>
 <title>Updates</title>
 <!-- ============================================================== -->
 <section>
 <title>Updates</title>


@@ -2283,7 +2384,7 @@ be used when targeting a KDM at DCP-o-matic.
 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
 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
+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
 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