projects / dcpomatic.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update manual per #2068.
[dcpomatic.git] / doc / manual / dcpomatic.xml
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 10a21237d49e73e23d79e94a944911d7a10a513b..32007d1c2834297cac870fb9d118f46f02503969 100644 (file)
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -96,12 +96,8 @@ DCP-o-matic will be installed onto your machine.
 </para>
 
 <para>
 </para>
 
 <para>
-If you are using a 32-bit version of Windows, you will need the 32-bit
-installer.  For 64-bit Windows, either installer will work, but I
-suggest you use the 64-bit version as it will allow DCP-o-matic to
-use more memory.  You may find that DCP-o-matic crashes if you run
-many parallel encoding threads (more than 4) on the 32-bit
-version.
+Use the 64-bit installer unless you are using a 32-bit version of Windows.
+You may find that DCP-o-matic crashes if run the 32-bit version on a CPU with more than 4 cores.
 </para>
 
 </section>
 </para>
 
 </section>
@@ -112,8 +108,8 @@ version.
 <title>macOS</title>
 
 <para>
 <title>macOS</title>
 
 <para>
-DCP-o-matic will run on macOS version 10.10 (Yosemite) and
-higher.  DCP-o-matic is split into seven separate applications, each of
+DCP-o-matic versions 2.16.0 and higher will run on macOS version 10.10 (Yosemite) and
+higher.  DCP-o-matic is split into eight separate applications, each of
 which can be installed by downloading the <code>.dmg</code>,
 double-clicking to open and then dragging the icon to your
 <guilabel>Applications</guilabel> folder.
 which can be installed by downloading the <code>.dmg</code>,
 double-clicking to open and then dragging the icon to your
 <guilabel>Applications</guilabel> folder.
@@ -124,6 +120,10 @@ If you don't know which parts of DCP-o-matic to install, start
 with the first (main) part.
 </para>
 
 with the first (main) part.
 </para>
 
+<para>
+If you are using macOS 10.9 (Mavericks) or older you will need to install the latest 2.14.x version of DCP-o-matic.
+</para>
+
 </section>
 
 <!-- ============================================================== -->
 </section>
 
 <!-- ============================================================== -->
@@ -158,14 +158,11 @@ thanks to Stefan Karner.
 </section>
 
 <section>
 </section>
 
 <section>
-        <title>
-                Building from source
-        </title>
-        <para>
-                Since DCP-o-matic is open-source you can also build it yourself, though this can be quite a difficult process (especially on Windows and macOS).  There are instructions for how to do it on
-        <ulink url="https://dcpomatic.com/development">
-                https://dcpomatic.com/
-        </ulink>
+<title>Building from source</title>
+<para>
+Since DCP-o-matic is open-source you can also build it yourself,
+though this can be quite a difficult process (especially on Windows and macOS).
+There are instructions for how to do it on <ulink url="https://dcpomatic.com/development">https://dcpomatic.com/</ulink>
 </para>
 </section>
 </chapter>
 </para>
 </section>
 </chapter>
@@ -192,7 +189,7 @@ movie <ulink url="http://sintel.org/">Sintel</ulink> from <ulink
 url="https://download.blender.org/durian/trailer/Sintel_Trailer.480p.DivX_Plus_HD.mkv">their
 website</ulink>.  Generally one would want to use the
 highest-resolution material available, but for this test we will use
 url="https://download.blender.org/durian/trailer/Sintel_Trailer.480p.DivX_Plus_HD.mkv">their
 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.
+the low-resolution version to save on download time.
 </para>
 
 <para>
 </para>
 
 <para>
@@ -425,6 +422,21 @@ to encode a single frame which it can then repeat.
 </chapter>
 
 
 </chapter>
 
 
+<!-- ============================================================== -->
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" id="ch-disk-writer">
+<title>Writing DCP drives</title>
+
+<para>
+Once a DCP has been created it must often be transferred to a cinema for playback.  The most reliable way to do this is to write a specially-formatted drive (in the ext2 format) containing your DCP.
+</para>
+
+<para>
+Writing ext2-formatted drives is difficult from macOS and Windows without custom software.  DCP-o-matic includes a tool called the &lsquo;DCP-o-matic Disk Writer&rsquo; which makes it easy.
+</para>
+
+</chapter>
+
+
 <!-- ============================================================== -->
 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" id="ch-manipulating-existing-dcps">
 <title>Manipulating existing DCPs</title>
 <!-- ============================================================== -->
 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" id="ch-manipulating-existing-dcps">
 <title>Manipulating existing DCPs</title>
@@ -754,7 +766,7 @@ linkend="sec-prefs-keys"/>).
 
 <!-- ============================================================== -->
 <section>
 
 <!-- ============================================================== -->
 <section>
-<title>Content Properties</title>
+<title>Content properties</title>
 
 <para>
 Below the content list are the controls to set content properties.  To
 
 <para>
 Below the content list are the controls to set content properties.  To
@@ -2127,7 +2139,15 @@ from the timeline is also preserved.
   <para>
     From this dialogue you can select the required output format,
     output file and, in the case of MP4, the quality of the output
   <para>
     From this dialogue you can select the required output format,
     output file and, in the case of MP4, the quality of the output
-    file.  Higher quality files will, of course, be larger.
+    file (by setting the <ulink url="https://trac.ffmpeg.org/wiki/Encode/H.264#crf">CRF value</ulink>).
+  </para>
+
+  <para>
+    The useful range of CRF values is from 17 (high quality but large file size) to 28 (smaller file size and still reasonable quality).
+  </para>
+
+  <para>
+    The time needed to export, and the resulting size, depend partly on the DCP resolution set in the project.  To change that, see chapter <xref linkend="ch-dcp"/>.
   </para>
 
   <para>
   </para>
 
   <para>
@@ -2173,7 +2193,7 @@ methods to understand it.
 
 <para>
 We suppose that we are trying to send a DCP to
 
 <para>
 We suppose that we are trying to send a DCP to
-Alice's cinema without an attacker called Mallory being able to
+Alice's cinema without a third party called Mallory being able to
 watch it himself.
 </para>
 
 watch it himself.
 </para>
 
@@ -2229,7 +2249,7 @@ certificate so that others can make encrypted DCPs for DCP-o-matic.
 We take our DCP's symmetric key and encrypt it using the public key of
 Alice's projector.  We send the result to Alice over email (using a
 format called a Key Delivery Message, or KDM).  Her projector then
 We take our DCP's symmetric key and encrypt it using the public key of
 Alice's projector.  We send the result to Alice over email (using a
 format called a Key Delivery Message, or KDM).  Her projector then
-decrypts our message using its private key, yielding the magic
+decrypts our message using its private key, giving the
 symmetric key which can decrypt the DCP.
 </para>
 
 symmetric key which can decrypt the DCP.
 </para>
 
@@ -3741,7 +3761,7 @@ The full details of OV and VF files are discussed in <xref linkend="sec-overlay"
 </chapter>
 
 <chapter xml:id="ch-player" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
 </chapter>
 
 <chapter xml:id="ch-player" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
-  <title>Playing and verifying DCPs</title>
+  <title>Playing DCPs</title>
 
   <para>DCP-o-matic includes a DCP player, and although it requires a
   very high-speed CPU to play DCPs in full resolution, it can also
 
   <para>DCP-o-matic includes a DCP player, and although it requires a
   very high-speed CPU to play DCPs in full resolution, it can also
@@ -3767,14 +3787,57 @@ The full details of OV and VF files are discussed in <xref linkend="sec-overlay"
   resolution.
   </para>
 
   resolution.
   </para>
 
+</chapter>
+
+
+<chapter xml:id="ch-verifier" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
+  <title>Verifying DCPs</title>
+
   <para>
   <para>
-    The player also offers a simple DCP validator.  To check a DCP,
+    The player also offers a DCP verifier.  To check a DCP,
     open it and then select <guilabel>Verify DCP</guilabel> from the
     open it and then select <guilabel>Verify DCP</guilabel> from the
-    <guilabel>Tools</guilabel> menu.  This will run some basic checks to see if the DCP meets the required standards.
+    <guilabel>Tools</guilabel> menu.
   </para>
 
   </para>
 
+  <para>
+    The verifier will report three kinds of problems:
+  </para>
+
+  <itemizedlist>
+  <listitem><emphasis>Errors</emphasis> &mdash; serious problems with the DCP that are likely to cause problems on playback.</listitem>
+  <listitem><emphasis>Bv2.1 errors</emphasis> &mdash; errors described by the <ulink url="https://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=9161348">SMPTE Bv2.1 standard</ulink>.</listitem>
+  <listitem><emphasis>Warnings</emphasis> &mdash; small problems that may not matter.</listitem>
+  </itemizedlist>
+
+  <para>
+    The following sections list what the verifier checks for in each category.
+  </para>
+
+  <section>
+  <title>Errors</title>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="verify_errors.xml"/>
+  </section>
+
+  <section>
+  <title>Bv2.1 errors</title>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="verify_bv21_errors.xml"/>
+  </section>
+
+  <section>
+  <title>Warnings</title>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="verify_warnings.xml"/>
+  </section>
+
 </chapter>
 
 </chapter>
 
+
+<!-- ============================================================== -->
+<chapter>
+<title>Keyboard shortcuts</title>
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="shortcuts.xml"/>
+</chapter>
+
+
 <!-- ============================================================== -->
 <chapter xml:id="ch-config" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
 <title>Configuration files</title>
 <!-- ============================================================== -->
 <chapter xml:id="ch-config" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
 <title>Configuration files</title>
Development branch of dcpomatic