Bump libdcp for another build fix.

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

diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 5b30bcf70b9ccda32103e9ef884bb0834a891267..a790d10cf13f36c633ad51ab97e85891c1aa86ac 100644 (file)
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -101,6 +101,12 @@ many parallel encoding threads (more than 4) on the 32-bit
 version.
 </para>
 
 version.
 </para>
 

+<para>
+If you are still using Windows XP, download the specific XP version as
+it should be more stable on your machine than the &lsquo;normal&rsquo;
+Windows version.
+</para>
+

 </section>
 
 
 </section>
 
 


@@ -139,7 +145,6 @@ depend on 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.10 (&lsquo;Wily Werewolf&rsquo;)</listitem>

   <listitem>Ubuntu 16.04 (&lsquo;Xenial Xerus&rsquo;)</listitem>
 </itemizedlist>
 
   <listitem>Ubuntu 16.04 (&lsquo;Xenial Xerus&rsquo;)</listitem>
 </itemizedlist>
 


@@ -531,6 +536,19 @@ playback will be very slow as decoding of DCPs is almost as
 computationally intensive as encoding them.
 </para>
 
 computationally intensive as encoding them.
 </para>
 

+<para>
+If your DCP is a Version File (VF), in other words it refers to
+another DCP's assets, you should import it as follows:
+</para>
+
+<itemizedlist>
+<listitem>Use <guilabel>Add folder...</guilabel> to import the VF DCP.
+The VF DCP will be added to the content list and marked &ldquo;NEEDS
+OV&rdquo;.</listitem>
+<listitem>Right-click on the VF DCP in the content list and choose <guilabel>Add OV...</guilabel> from the menu.</listitem>
+<listitem>Choose the folder that contains the OV DCP.  The VF will now be playable as normal.</listitem>
+</itemizedlist>
+

 </section>
 
 
 </section>
 
 


@@ -610,7 +628,7 @@ DCP-o-matic will decode and then re-encode the JPEG2000 data.
 </section>
 
 
 </section>
 
 

-<section>
+<section xml:id="sec-overlay">

 <title>Making overlay files</title>
 
 <para>
 <title>Making overlay files</title>
 
 <para>


@@ -717,7 +735,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>, <guilabel>.ssa</guilabel> or <guilabel>.xml</guilabel>
+<guilabel>.srt</guilabel>, <guilabel>.ssa</guilabel>, <guilabel>.ass</guilabel> or <guilabel>.xml</guilabel>

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


@@ -815,12 +833,25 @@ The <guilabel>Video</guilabel> tab controls properties of the image, as shown in
 </figure>
 
 
 </figure>
 
 

+<!-- ============================================================== -->
+<section>
+<title>Refer to existing DCP</title>
+
+<para>
+This option is only applicable if the selected content is an existing
+DCP.  It allows you to get the video content from the existing DCP by
+referencing it (rather than copying).  See <xref
+linkend="sec-overlay"/>.
+</para>
+
+</section>
+

 <!-- ============================================================== -->
 <section>
 <title>Image type</title>
 
 <para>
 <!-- ============================================================== -->
 <section>
 <title>Image type</title>
 
 <para>

-The first option on this tab is the &lsquo;type&rsquo; of the video.
+The next option on this tab is the &lsquo;type&rsquo; of the video.

 This specifies how DCP-o-matic should interpret the video's image.
 <guilabel>2D</guilabel> is the default; this just takes the video
 image as a standard 2D frame.  The <guilabel>3D
 This specifies how DCP-o-matic should interpret the video's image.
 <guilabel>2D</guilabel> is the default; this just takes the video
 image as a standard 2D frame.  The <guilabel>3D


@@ -1038,7 +1069,6 @@ The <guilabel>Audio</guilabel> tab controls properties of the image, as shown in
   </mediaobject>
 </figure>
 
   </mediaobject>
 </figure>
 

-

 <!-- ============================================================== -->
 <section>
 <title>The audio map</title>
 <!-- ============================================================== -->
 <section>
 <title>The audio map</title>


@@ -1143,7 +1173,20 @@ shows the mapping of a 5.1 source into a 5.1 DCP.
 
 <!-- ============================================================== -->
 <section>
 
 <!-- ============================================================== -->
 <section>

-<title>Other controls</title>
+  <title>Other controls</title>
+
+<para>
+The <guilabel>Refer to existing DCP</guilabel> checkbox isonly
+applicable if the selected content is an existing DCP.  It allows you
+to get the audio content from the existing DCP by referencing it
+(rather than copying).  See <xref linkend="sec-overlay"/>.
+</para>
+
+<para>
+<guilabel>Show graphs of audio levels</guilabel> will analyse the
+audio of the selected content and plot it on a graph.  See <xref
+linkend="sec-show-audio"/> for more details.
+</para>

 
 <para>
 &lsquo;Audio Gain&rsquo; is used to alter the volume of the
 
 <para>
 &lsquo;Audio Gain&rsquo; is used to alter the volume of the


@@ -1304,6 +1347,11 @@ frame) than those typically used for DCP, so it is often useful to
 scale such subtitles down using these controls.
 </para>
 
 scale such subtitles down using these controls.
 </para>
 

+<para>
+The <guilabel>Line spacing</guilabel> control adjusts the line spacing
+of the subtitles.  This only works for non-embedded (text) subtitles.
+</para>
+

 <para>
 The <guilabel>Stream</guilabel> control changes the subtitle stream
 that is used when the content has more than one.
 <para>
 The <guilabel>Stream</guilabel> control changes the subtitle stream
 that is used when the content has more than one.


@@ -1372,11 +1420,17 @@ should be displayed using this control.
 </para>
 
 <para>
 </para>
 
 <para>

-<guilabel>Trim from start</guilabel> specifies the amount that should be trimmed from the start of the content.
+<guilabel>Trim from start</guilabel> specifies the amount that should
+be trimmed from the start of the content.  You can set this amount to
+trim up to the current preview position by clicking <guilabel>Trim up
+to current position</guilabel>.

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

-<guilabel>Trim from end</guilabel> specifies the amount that should be trimmed from the end of the content.
+<guilabel>Trim from end</guilabel> specifies the amount that should be
+trimmed from the end of the content.  You can set this amount to trim
+after the current preview position by clicking <guilabel>Trim after to
+current position</guilabel>.

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


@@ -1791,7 +1845,7 @@ you must specify a reel length in Gb.  Then no file in the DCP will be larger th
 
 
 <!-- ============================================================== -->
 
 
 <!-- ============================================================== -->

-<section>
+<section xml:id="sec-show-audio">

 <title>Show audio</title>
 
 <para>
 <title>Show audio</title>
 
 <para>


@@ -1842,6 +1896,43 @@ auditorium, but it can be useful to get levels in the right rough area.
 
 </chapter>
 
 
 </chapter>
 

+
+<!-- ============================================================== -->
+<chapter xml:id="ch-templates" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
+<title>Templates</title>
+
+<para>
+If you frequently make DCPs with similar settings you may find it
+useful to use templates.
+</para>
+
+<para>
+Say, for example, you often make 4K feature DCPs from video files in
+&rsquo;scope at 25fps.  You can speed up this process by following
+these steps:
+</para>
+
+<itemizedlist>
+  <listitem>Create a film with any content and set it up how you like;
+  in our example, set the content to scale to DCP, the DCP resolution
+  to 4K, and so on.</listitem>
+  <listitem>Choose <guilabel>Save as template...</guilabel> from the <guilabel>File</guilabel> menu.</listitem>
+  <listitem>Enter a name for your template.</listitem>
+</itemizedlist>
+
+<para>
+Then in the future you can create a new film, tick the
+<guilabel>Template</guilabel> box and choose your previously-saved
+template.  The basic film's settings will come from your template, and
+when you add some content it will take on the settings of the
+first similarly-typed piece of content in your template.
+</para>
+
+</chapter>
+
+
+
+<!-- ============================================================== -->

 <chapter xml:id="ch-encryption" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
 <title>Encryption</title>
 
 <chapter xml:id="ch-encryption" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
 <title>Encryption</title>
 


@@ -1991,7 +2082,7 @@ linkend="fig-kdm"/>.
   <title>KDM dialog</title>
   <mediaobject>
     <imageobject>
   <title>KDM dialog</title>
   <mediaobject>
     <imageobject>

-      <imagedata fileref="screenshots/kdm&scs;"/>
+      <imagedata scale="40" fileref="screenshots/kdm&scs;"/>

     </imageobject>
   </mediaobject>
 </figure>
     </imageobject>
   </mediaobject>
 </figure>


@@ -2131,7 +2222,7 @@ DCP-o-matic.  Its window is shown in <xref linkend="fig-kdm-creator"/>.
   <title>The KDM creator</title>
   <mediaobject>
     <imageobject>
   <title>The KDM creator</title>
   <mediaobject>
     <imageobject>

-      <imagedata fileref="screenshots/kdm-creator&scs;"/>
+      <imagedata scale="35" fileref="screenshots/kdm-creator&scs;"/>

     </imageobject>
   </mediaobject>
 </figure>
     </imageobject>
   </mediaobject>
 </figure>


@@ -2188,15 +2279,10 @@ DCP-o-matic provides a few preferences which can be used to modify its
 behaviour.  This chapter explains those options.
 </para>
 
 behaviour.  This chapter explains those options.
 </para>
 

-
-<!-- ============================================================== -->
-<section>
-<title>The preferences dialogue</title>
-

 <para>
 <para>

-The preferences dialogue is opened by choosing
+Preferences can be edited by choosing

 <guilabel>Preferences...</guilabel> from the <guilabel>Edit</guilabel>
 <guilabel>Preferences...</guilabel> from the <guilabel>Edit</guilabel>

-menu.  The dialogue is split into seven tabs.
+menu.  This opens a dialogue which is split into seven tabs.

 </para>
 
 <!-- ============================================================== -->
 </para>
 
 <!-- ============================================================== -->


@@ -2418,13 +2504,19 @@ 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
-with the signing chain, DCP-o-matic will create a certificate chain
+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>
 
 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>
 

+<para>
+Clicking <guilabel>Export DCP decryption chain...</guilabel> will
+export the whole certificate chain, rather than just the leaf
+certificate.
+</para>
+

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


@@ -2567,6 +2659,14 @@ 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>
 
 suggest you leave this un-ticked unless you have a good reason to do otherwise.
 </para>
 

+<para>
+With the filename format fields you can adjust the filenames that are
+used for metadata (CPL and PKL files) and assets (MXF and subtitle
+files).  Below each field there is a list of the &lsquo;magic&rsquo;
+values that you can use in the format and an example of a filename
+that you might see with your current settings.
+</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
 <para>
 The four checkboxes labelled <guilabel>Log</guilabel> control what
 sort of messages DCP-o-matic writes to its log file when creating a


@@ -2583,7 +2683,6 @@ that are generated, so in normal use it is best to leave this
 unticked.
 </para>
 
 unticked.
 </para>
 

-</section>

 </section>
 </chapter>
 
 </section>
 </chapter>
 


@@ -2910,4 +3009,111 @@ hashes.
 
 </chapter>
 
 
 </chapter>
 

+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
+<title>Common tasks</title>
+
+<para>
+This chapter describes how to carry out some commonly-required tasks
+with DCP-o-matic.  The full details are elsewhere in the manual: here
+we just discuss different approaches to these tasks and how to carry
+them out.
+</para>
+
+<section>
+<title>Adding subtitles to an existing DCP</title>
+
+<para>
+You have three options:
+</para>
+
+<itemizedlist>
+<listitem>Make a &ldquo;Version File&rdquo; (VF) DCP.</listitem>
+<listitem>Make a complete DCP with projector-added subtitles.</listitem>
+<listitem>Make a complete DCP with burnt-in subtitles.</listitem>
+</itemizedlist>
+
+<para>
+Making a VF DCP is usually the best option.  This will be a very small
+DCP which contains only the subtitles: it refers to your existing DCP
+for the picture and sound.  The projectionist will ingest both the
+existing and VF DCPs and play back the VF.  The advantages of this
+approach are that the VF is very quick to generate, and small in size,
+making it easy to distribute.  This is especially useful if you have
+to make VF DCPs in many different languages.
+</para>
+
+<para>
+Making a complete DCP with projector-added subtitles gives you a new,
+single DCP which the projectionist can ingest and play.  It will be
+the same size as your existing DCP, and fairly quick to create.  This
+approach relies on the projector (or server) to create the subtitles
+and overlay them on the image, which mostly works well but is not
+100&percnt; reliable.
+</para>
+
+<para>
+Making a complete DCP with burnt-in subtitles gives you a new, single DCP
+but with the subtitles rendered by DCP-o-matic and copied into your
+image.  This is slower to create than a DCP with projector-added
+subtitles as every video frame with a subtitle must be re-encoded.
+The advantage of this approach is that it is less likely to go wrong,
+especially if you are using unusual subtitle positioning or character
+sets.
+</para>
+
+</section>
+
+<section>
+<title>Making a VF DCP</title>
+
+<itemizedlist>
+<listitem>Start a new DCP-o-matic film.</listitem>
+<listitem>Click <guilabel>Add folder...</guilabel> and specify your existing DCP's folder.</listitem>
+<listitem>Go to the <guilabel>DCP</guilabel> tab and choose <guilabel>Split by video content</guilabel> for <guilabel>Reel type</guilabel>.</listitem>
+<listitem>Go to the <guilabel>Video</guilabel> and
+<guilabel>Audio</guilabel> tabs in turn and tick the <guilabel>Refer to existing DCP</guilabel> checkboxes.</listitem>
+<listitem>Add your subtitles to the film in whatever format you have.</listitem>
+<listitem>Check the subtitle appearance in the preview; it will be
+slow to respond as it is having to decompress images from the existing
+DCP.</listitem>
+<listitem>Choose <guilabel>Make DCP</guilabel> from the menu.</listitem>
+</itemizedlist>
+
+</section>
+
+<section>
+<title>Making a complete DCP with projector-added subtitles</title>
+
+<itemizedlist>
+<listitem>Start a new DCP-o-matic film.</listitem>
+<listitem>Click <guilabel>Add folder...</guilabel> and specify your existing DCP's folder.</listitem>
+<listitem>Add your subtitles to the film in whatever format you have.</listitem>
+<listitem>Check the subtitle appearance in the preview; it will be
+slow to respond as it is having to decompress images from the existing
+DCP.  Adjust the appearance using controls in the
+<guilabel>Subtitle</guilabel> tab if required.</listitem>
+<listitem>Choose <guilabel>Make DCP</guilabel> from the menu.</listitem>
+</itemizedlist>
+
+</section>
+
+<section>
+<title>Making a complete DCP with burnt-in subtitles</title>
+
+<itemizedlist>
+<listitem>Start a new DCP-o-matic film.</listitem>
+<listitem>Click <guilabel>Add folder...</guilabel> and specify your existing DCP's folder.</listitem>
+<listitem>Add your subtitles to the film in whatever format you have.</listitem>
+<listitem>Go to the <guilabel>Subtitle</guilabel> tab and tick the <guilabel>Burn subtitles into image</guilabel> checkbox.</listitem>
+<listitem>Check the subtitle appearance in the preview; it will be
+slow to respond as it is having to decompress images from the existing
+DCP.  Adjust the appearance using controls in the
+<guilabel>Subtitle</guilabel> tab if required.</listitem>
+<listitem>Choose <guilabel>Make DCP</guilabel> from the menu.</listitem>
+</itemizedlist>
+
+</section>
+
+</chapter>
+

 </book>
 </book>