Manual updates.
[dcpomatic.git] / doc / manual / dcpomatic.xml
index dca6e3ef02c8bfe860324a78b62a822418fe973c..5b30bcf70b9ccda32103e9ef884bb0834a891267 100644 (file)
@@ -58,6 +58,20 @@ GPL</ulink>.
 This manual uses icons from the <ulink url="http://tango.freedesktop.org/">Tango Desktop Project</ulink>, with thanks.
 </para>
 
+</section>
+
+<!-- ============================================================== -->
+<section>
+<title>This manual</title>
+
+<para>
+This manual presents bits of DCP-o-matic's user interface (such as menu items or buttons) <guilabel>like this</guilabel>.
+</para>
+
+<note>
+Notes of an advanced nature are presented like this.  Ignore them unless you want to know the gory details.
+</note>
+
 </section>
 </chapter>
 
@@ -98,11 +112,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
-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>
 
+<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>
 
 <!-- ============================================================== -->
@@ -119,8 +139,8 @@ 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>Ubuntu 15.04 (&lsquo;Vivid Vervet&rsquo;)</listitem>
   <listitem>Ubuntu 15.10 (&lsquo;Wily Werewolf&rsquo;)</listitem>
+  <listitem>Ubuntu 16.04 (&lsquo;Xenial Xerus&rsquo;)</listitem>
 </itemizedlist>
 
 <para>
@@ -147,7 +167,7 @@ pieces and set DCP-o-matic up for you.
 <!-- ============================================================== -->
 <section>
   <title>Centos Linux</title>
-  <para>There are <code>.rpm</code> packages for Centos 6.5 and 7 on
+  <para>There are <code>.rpm</code> packages for Centos 5, 6.5 and 7 on
   <ulink url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>
   </para>
 </section>
@@ -171,10 +191,10 @@ thanks to Stefan Karner.
 
 <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>
@@ -233,10 +253,10 @@ in a shell.
 
 <!-- ============================================================== -->
 <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>
-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>
 
@@ -248,7 +268,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
-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>
@@ -404,8 +424,8 @@ linkend="ch-files"/> for details about the files that DCP-o-matic creates.
 </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>
@@ -416,7 +436,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">
-<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
@@ -425,7 +445,7 @@ how to do it.
 </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"/>.
@@ -457,10 +477,10 @@ linkend="fig-still-select-content-file"/>.
 </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>
 
@@ -482,7 +502,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
-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>
 
@@ -495,7 +515,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
-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>
 
@@ -570,8 +590,8 @@ JPEG2000 encoding is not necessary.
 </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>
@@ -644,7 +664,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
-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>
 
@@ -697,7 +717,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
-<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>
@@ -1199,24 +1219,28 @@ DCP-o-matic can either:
 </para>
 
 <itemizedlist>
-  <listitem>Extract &lsquo;image&rsquo; subtitles that are embedded in video files, or</listitem>
-  <listitem>Use text subtitles from SubRip (<code>.srt</code>) or DCP XML files.</listitem>
+  <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.  You may find the great
+  free program <ulink
+  url="http://www.nikse.dk/subtitleedit/">Subtitle Edit</ulink> useful
+  for creating such files.</listitem>
 </itemizedlist>
 
 <para>
-Image subtitles are represented using a set of bitmaps, as commonly
-used on DVD and 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).
+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 text 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"/>.
+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">
@@ -1285,6 +1309,17 @@ The <guilabel>Stream</guilabel> control changes the subtitle stream
 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>
 
 
@@ -1574,6 +1609,11 @@ DCP standards DCP-o-matic should use.  If in doubt, use SMPTE (the
 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.
@@ -2022,13 +2062,28 @@ You must also select the type of KDM that you want to generate.  If in
 doubt, use <guilabel>Modified Transitional 1</guilabel>.
 </para>
 
+<note>
+The differences between the three KDM types are fairly subtle.
+<guilabel>DCI Specific</guilabel> and <guilabel>DCI Any</guilabel> add
+a <code>&lt;ContentAuthenticator&gt;</code> tag to the KDM which
+allows the exhibitor to check that the DCP and KDM have come from a
+bona-fide source.  In addition, <guilabel>DCI Specific</guilabel> adds
+information on trusted devices to the KDM.  This allows the KDM
+creator to specify devices (such as sound processors) that are allowed
+to use keys delivered by the KDM.  At present it is not clear how
+widely the <guilabel>DCI Specific</guilabel> and <guilabel>DCI
+Any</guilabel> features are supported (or even tolerated) by servers
+so you are advised to use <guilabel>Modified Transitional
+1</guilabel>.
+</note>
+
 <para>
 Finally, choose what you want to do with the KDMs.  They can be
 written to disk, to a location that you can specify by clicking
 <guilabel>Browse</guilabel>.  Alternatively, if you choose
 <guilabel>Send by email</guilabel> the KDMs will be zipped up and
-emailed to the appropriate cinema email addresses.  Click OK to
-generate the KDMs.
+emailed to the appropriate cinema email addresses.  Click
+<guilabel>Make KDMs</guilabel> to generate the KDMs.
 </para>
 
 </section>
@@ -2068,7 +2123,7 @@ 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 &lsquo;Normal&rsquo;
+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>
 
@@ -2195,6 +2250,30 @@ to set this up correctly when you run it for the first time.
 
 </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>
@@ -2789,7 +2868,8 @@ operation is interrupted and DCP-o-matic must resume it.</listitem>
 Following this is the DCP itself:
 <code>DCP-TEST_EN-XX_UK-U_51_2K_CSY_20130218_CSY_OV</code>.  This
 contains some small XML files, which describe the DCP, and two large
-MXF files, which contain the DCP's audio and video data.  This folder
+MXF files, which contain the DCP's audio and video data.  It may also
+contain subtitles in either XML or MXF format.  This folder
 (<code>DCP-TEST_EN-XX_...</code>) is what you should ingest, or pass
 to the cinema which is showing your DCP.
 </para>