Brief docs for Upmixer B in the manual.
[dcpomatic.git] / doc / manual / dcpomatic.xml
index a8065a75423387db639fb6c3653f2107d2b84a23..69bb45d5401fa281527f796dfbb4d56e65b836d3 100644 (file)
@@ -1061,8 +1061,15 @@ burnt into the image.
 </para>
 
 <para>
-Select the <guilabel>With Subtitles</guilabel> check-box to enable
-subtitles.
+Select the <guilabel>Use Subtitles</guilabel> check-box to enable
+these subtitles.
+</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.
 </para>
 
 <para>
@@ -1404,13 +1411,6 @@ to what DCP-o-matic thinks is the best given the content that you have
 added.
 </para>
 
-<para>
-<guilabel>Burn subtitles into image</guilabel> should be selected if
-you want DCP-o-matic to overlay the subtitles onto the video frame
-before encoding.  Leave this un-ticked to include the subtitles
-separately in the DCP.
-</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
@@ -1464,13 +1464,20 @@ cinema audio systems.</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>
-</listitem>
-</itemizedlist>
-
 <para>
 This upmixing algorithm is due to GĂ©rald Maruccia.
 </para>
-
+</listitem>
+<listitem>Stereo to 5.1 up-mixer B &mdash; 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>
@@ -1560,8 +1567,8 @@ methods to understand it.
 </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>
 
@@ -1588,11 +1595,12 @@ happened to know Mallory, she could just send him a copy of the key.
 </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 &lsquo;public&rsquo; key.  That data can then only be decrypted
-using a <emphasis>different</emphasis> &lsquo;private&rsquo; 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>
@@ -1840,6 +1848,16 @@ like to live on the bleeding edge!
 </para>
 </section>
 
+<!-- ============================================================== -->
+<section>
+<title>Issuer and creator</title>
+
+<para>
+With these controls you can set the issuer and creator strings that
+will be put into the DCPs which you create.
+</para>
+</section>
+
 </section>
 
 <!-- ============================================================== -->
@@ -1920,9 +1938,9 @@ creation.
 <para>
 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, so if you are happy to use a randomly-generated chain
-you can ignore the preferences.  Otherwise, you can add or remove
-certificates from the chain using the <guilabel>Add...</guilabel> and
+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>
 
@@ -1942,13 +1960,22 @@ corresponds to the public key held in the leaf certificate.
 </para>
 
 <para>
-The bottom of the tab specifies the certificate and private key that
-is used to decrypt DCPs if they are imported as sources to
-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.  As with the certificate chain,
-DCP-o-matic will create a certificate and private key for you.  You
-can also choose to load your own certificate and key.
+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>
@@ -1961,8 +1988,8 @@ can also choose to load your own certificate and key.
 <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>
@@ -1976,12 +2003,20 @@ upload DCPs directly from DCP-o-matic to the TMS using the
   </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>
@@ -2079,6 +2114,12 @@ 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