Hello, and welcome to DCP-o-matic!
</para>
+<!-- ============================================================== -->
<section>
<title>What is DCP-o-matic?</title>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Licence</title>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Acknowledgements</title>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>Installation</title>
+
+<!-- ============================================================== -->
<section>
<title>Windows</title>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Mac OS X</title>
<para>
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
+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
<guilabel>Applications</guilabel> folder or wherever else you would
<para>
You can install DCP-o-matic on Ubuntu 12.04 (‘Precise
-Pangolin’), 12.10 (‘Quantal Quetzal’), 13.10 (‘Saucy
-Salamander’) or 14.04 (‘Trusty Tahr’) using <code>.deb</code> packages: download the
+Pangolin’) or 14.04 (‘Trusty Tahr’) using <code>.deb</code> packages: download the
appropriate package from <ulink
url="http://dcpomatic.com/">http://dcpomatic.com/</ulink> and
double-click it. Ubuntu will install the necessary bits and pieces
</section>
+
+<!-- ============================================================== -->
<section>
<title>Debian Linux</title>
<para>
-Packages are available for Debian 7 (squeeze) from <ulink
+Packages are available for Debian 7 (squeeze)
and unstable (sid) from <ulink
url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>.
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Centos Linux</title>
<para>
-Packages are available for Centos 6.5 from <ulink
+Packages are available for Centos 6.5
and 7 from <ulink
url="http://dcpomatic.com/">http://dcpomatic.com/</ulink>.
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Arch Linux</title>
<para>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Other Linux distributions</title>
Installation on non-Ubuntu Linux is currently a little involved, as
there are no packages available (yet); you will have to compile it
from source. If you are using a non-Ubuntu distribution, do let me
-know via the <ulink url="mailto:carl@dcpomatic.com">mailing
-list</ulink> and I will see about building some packages.
+know by <ulink url="mailto:carl@dcpomatic.com">email</ulink> and I will see about building some packages.
</para>
<para>
</section>
</chapter>
+
+<!-- ============================================================== -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>Creating a video DCP</title>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Adding content</title>
+
+<!-- ============================================================== -->
<section>
<title>Making the DCP</title>
</section>
</chapter>
+
+<!-- ============================================================== -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>Creating a still-image DCP</title>
</chapter>
+
+<!-- ============================================================== -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>Content settings</title>
</para>
</section>
+
+
+<!-- ============================================================== -->
<section>
<title>Content Properties</title>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Video</title>
</mediaobject>
</figure>
+
+<!-- ============================================================== -->
<section>
<title>Image type</title>
</mediaobject>
</figure>
+<para>
+Another option is <guilabel>3D alternate</guilabel> which takes the
+first frame of the content as for the left eye, the second for the
+right eye, the third for the left, and so on. Finally, you can
+specify <guilabel>3D left only</guilabel> or <guilabel>3D right
+only</guilabel> if this content contains only the the left or right
+eye images. This is useful when you have the left and right eye image
+sets in different files; you can specify one content as <guilabel>3D
+left only</guilabel> and another as <guilabel>3D right only</guilabel>
+and DCP-o-matic will pick up the appropriate frames from each.
+</para>
+
</section>
</section>
+
+<!-- ============================================================== -->
+<section>
+<title>Colour conversion</title>
+
+<para>
+The <guilabel>Colour conversion</guilabel> setting specifies what
+colour transforms and gamma correction DCP-o-matic will use when
+converting the selected content into the XYZ colourspace for the DCP.
+</para>
+
+<para>
+Clicking <guilabel>Edit...</guilabel> will open the colour conversion
+dialogue box, as shown in <xref linkend="fig-colour-conversion"/>.
+</para>
+
+<figure id="fig-colour-conversion">
+ <title>Dialogue box for setting colour conversion</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="screenshots/colour-conversion&scs;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+In most cases, it is only necessary to select one of DCP-o-matic's
+presets. DCP-o-matic knows how to convert from two common
+colourspaces: sRGB and Rec. 709, so if your content was graded using
+one of those you can select the appropriate preset.
+</para>
+
+<para>
+For other colour spaces you can edit the values in the lower half of
+the dialogue box as you wish. Alternatively, create a new colour
+conversion preset using the preferences dialog, as described in <xref
+linkend="sec-prefs-colour"/>.
+</para>
+
+<para>
+Colour conversion is discussed in more detail in a separate document
+<ulink url="http://dcpomatic.com/manual/colour.pdf">colour.pdf</ulink>.
+</para>
+
+</section>
+
<!-- ============================================================== -->
<section>
<title>Other settings</title>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Video description</title>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Audio</title>
</mediaobject>
</figure>
+
+<!-- ============================================================== -->
<section>
<title>Show audio</title>
</section>
+
+<!-- ============================================================== -->
<section>
<title>The audio map</title>
<para>
Down the left-hand side of the map is the list of audio channels in
the currently-selected piece of content. Along the top is each
-channel in the DCP. A checked box means that the corresponding
+channel in the DCP. A green box means that the corresponding
content channel will be copied into the corresponding DCP channel.
</para>
+<para>
+When content channels are copied into DCP channels they can be done
+with variable gain. If, for example, you want to copy a channel
+as-is, you can set a gain of 0dB. Alternatively, if you want to mix
+two channels into one, you may want to use a gain of -6dB on each one
+to prevent clipping when the two channels are added.
+</para>
+
+<para>
+The green boxes of the audio mapping view tell you (very roughly) how
+much gain is applied to each channel. A full-height box means 0dB
+(i.e. unity) gain. Any less height indicates lower gain.
+</para>
+
+<para>
+To map one channel to another with 0dB gain, click in the empty box
+and it will turn green to reflect the mapping. A second click will
+turn the mapping back off. To set some other gain, right-click on the
+box to open the gain menu. This allows you to set
+<guilabel>Off</guilabel> (no mapping or negative infinity gain),
+<guilabel>Full</guilabel> (0dB gain), -6dB gain or
+<guilabel>Edit</guilabel> which allows you to set the required gain
+precisely.
+</para>
+
<para>
Consider, for example, the case in <xref linkend="fig-audio-map-eg1"/>.
</para>
<para>
Here, we have two channels in the source which are mapped to left and
-right, respectively, in the DCP. If we modify that as in <xref
-linkend="fig-audio-map-eg2"/>
+right, respectively, in the DCP. The full green boxes show that the
+mapping is at unity gain (0dB) in each case. Imagine that we modify
+the settings to those shown in <xref linkend="fig-audio-map-eg2"/>
</para>
<figure id="fig-audio-map-eg2">
</figure>
<para>
-we now have the content's streams mapped to left and right and also
-mixed together and placed in the DCP's centre channel.
+We now have the content's streams mapped to left and right and also
+mixed together and placed in the DCP's centre channel. The smaller
+green boxes on the centre mappings show that those channels are added
+with some non-unity gain; you can see by hovering the mouse pointer
+over those boxes that the gain for content channels 1 and 2 is -6dB
+when being sent to the centre channel and 0dB when being sent to left
+and right.
</para>
<figure id="fig-audio-map-eg3">
</section>
+
+<!-- ============================================================== -->
<section>
<title>Other controls</title>
</section>
+<!-- ============================================================== -->
<section>
<title>Subtitles</title>
DVD and Blu-Ray subtitles are stored as bitmaps, so it is not possible
(automatically) to use non-burnt-in subtitles with these sources.
Select the <guilabel>With Subtitles</guilabel> check-box to enable
-subtitles. The <guilabel>offset</guilabel> control moves the
-subtitles up and down the image, and the <guilabel>scale</guilabel>
-control changes their size.
+subtitles. The <guilabel>X Offset</guilabel> and <guilabel>Y
+Offset</guilabel> controls move the subtitles around within the image,
+and the <guilabel>scale</guilabel> control changes their size. The
+<guilabel>Stream</guilabel> control changes the subtitle stream that
+is used when the content has more than one.
</para>
<para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Timing</title>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Video processing pipeline</title>
DCP-o-matic can create encrypted DCPs and KDMs for them.
</para>
+
+<!-- ============================================================== -->
<section>
<title>Basics</title>
delivery message (KDM) can play the DCP.
</para>
+
+<!-- ============================================================== -->
<section>
<title>How it works (in a nutshell)</title>
</section>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Encryption using DCP-o-matic</title>
</chapter>
+
+<!-- ============================================================== -->
<chapter xml:id="ch-preferences" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>Preferences</title>
behaviour. This chapter explains those options.
</para>
+
+<!-- ============================================================== -->
<section>
<title>The preferences dialogue</title>
<para>
The preferences dialogue is opened by choosing
<guilabel>Preferences...</guilabel> from the <guilabel>Edit</guilabel>
-menu. The dialogue is split into five tabs.
+menu. The dialogue is split into seven tabs.
</para>
+<!-- ============================================================== -->
<section>
-<title>Miscellaneous</title>
+<title>General</title>
<para>
-The miscellaneous tab is shown in <xref linkend="fig-prefs-misc"/>.
+The general tab is shown in <xref linkend="fig-prefs-general"/>.
</para>
-<figure id="fig-prefs-misc">
- <title>Miscellaneous preferences</title>
+<figure id="fig-prefs-general">
+ <title>General preferences</title>
<mediaobject>
<imageobject>
- <imagedata fileref="screenshots/prefs-misc&scs;"/>
+ <imagedata fileref="screenshots/prefs-general&scs;"/>
</imageobject>
</mediaobject>
</figure>
+
+<!-- ============================================================== -->
<section>
<title>Language</title>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Threads</title>
</section>
+<!-- ============================================================== -->
<section>
-<title>KDM emails</title>
+<title>Updates</title>
+
+<para>
+The <guilabel>Check for updates on startup</guilabel> option, if
+enabled, will tell DCP-o-matic to check on <ulink
+url="http://dcpomatic.com/">dcpomatic.com</ulink> to see if there any
+newer versions of DCP-o-matic then the one you are running. If so, a
+dialogue box will open with a link to download the new version.
+available
+</para>
<para>
-DCP-o-matic can send KDMs (see <xref linkend="ch-encryption"/>) to
-cinemas (or anywhere else) via email. To make this work, enter a
-suitable outgoing mail (SMTP) server and ‘from’ address
-for these emails.
+The <guilabel>Check for testing updates as well as stable
+ones</guilabel> option will also check for test updates as well as
+those that are formally ‘released’ This is useful if you
+like to live on the bleeding edge!
</para>
+</section>
</section>
+<!-- ============================================================== -->
<section>
<title>Defaults</title>
<para>
-The next few options allow you to set up default values for several
-properties of new films that you create.
+The defaults tab is shown in <xref linkend="fig-prefs-defaults"/>.
+</para>
+
+<figure id="fig-prefs-defaults">
+ <title>Defaults preferences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="screenshots/prefs-defaults&scs;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+The options in this tab simply allow you to set up default values for
+various properties of new films.
</para>
-</section>
</section>
-<section>
+<!-- XXX: servers -->
+
+<!-- ============================================================== -->
+<section xml:id="sec-prefs-colour">
<title>Colour conversions</title>
<para>
</section>
-<section>
-<title>Metadata</title>
-
-<para>
-The metadata tab is shown in <xref linkend="fig-prefs-metadata"/>.
-</para>
-
-<figure id="fig-prefs-metadata">
- <title>Metadata preferences</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="screenshots/prefs-metadata&scs;"/>
- </imageobject>
- </mediaobject>
-</figure>
-
-<para>
-This allows you to set up a couple of identifiers that are written
-into the DCP. The default values should cause no problems.
-</para>
-
-</section>
+<!-- ============================================================== -->
<section xml:id="sec-prefs-tms">
<title>TMS</title>
<titleabbrev xml:id="sec-prefs-tms-short">TMS preferences</titleabbrev>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>KDM email</title>
<para>
This is a template for the email that is used to send KDMs out to
-cinemas. You can change it to say whatever you like. The
-‘magic’ string <code>$CPL_NAME</code> will be replaced by
-DCP's title.
+cinemas. You can change it to say whatever you like. A few
+‘magic’ strings will be replaced by information from the
+KDM that is being sent:
+</para>
+
+<table>
+<title>‘Magic’ KDM strings</title>
+<tgroup cols='2' align='left' colsep='1' rowsep='1'>
+<tbody>
+<row>
+<entry><code>$CPL_NAME</code></entry><entry>DCP title</entry>
+</row>
+<row>
+<entry><code>$CINEMA_NAME</code></entry><entry>Cinema name</entry>
+</row>
+<row>
+<entry><code>$SCREENS</code></entry><entry>Name of screen or screens that KDMs are being generated for</entry>
+</row>
+<row>
+<entry><code>$START_TIME</code></entry><entry>The time from which the KDMs are valid</entry>
+</row>
+<row>
+<entry><code>$END_TIME</code></entry><entry>The time until which the KDMs are valid</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+
+<para>
+The <guilabel>Reset to default text</guilabel> will replace the current KDM email with DCP-o-matic's default.
</para>
</section>
+
+<!-- ============================================================== -->
<section xml:id="sec-prefs-advanced">
<title>Advanced</title>
<titleabbrev xml:id="sec-prefs-advanced-short">Advanced preferences</titleabbrev>
however, always possible.
</para>
+
+<!-- ============================================================== -->
<section>
<title>DCP frame rate limitations</title>
even refuse to ingest.
</para>
+
+<!-- ============================================================== -->
<section>
<title>Guaranteed rates</title>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Other often-supported rates</title>
<para>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Adapting content to fit the DCP rate</title>
</section>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Setting up</title>
can mix Windows PCs, Macs and Linux machines as you wish.
</para>
+
+<!-- ============================================================== -->
<section>
<title>Running the servers</title>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Setting up DCP-o-matic</title>
</para>
</section>
+
+<!-- ============================================================== -->
<section>
<title>Some notes about encode servers</title>
This chapter collects a few notes on bits of DCP-o-matic that do not fit elsewhere in the manual.
</para>
+
+<!-- ============================================================== -->
<section>
<title>Resuming encodes</title>
projects / dcpomatic.git / commitdiff
