<para>
If you are still using Windows XP, download the specific XP version as
it should be more stable on your machine than the ‘normal’
-Windows version.
+Windows version. Be aware, though, that support for Windows XP will
+not last forever and you should plan to upgrade if at all possible.
</para>
</section>
</para>
<programlisting>
-./waf configure
+./waf configure --disable-tests
./waf build
sudo ./waf install
</programlisting>
<para>
in a shell.
</para>
+</section>
+
+<!-- ============================================================== -->
+<section>
+<title>‘Simple’ and ‘Full’ modes</title>
+
+<para>When you start DCP-o-matic for the first time it will ask you if
+you want to use ‘simple’ or ‘full’ mode.
+</para>
+
+<para>The difference between these two is that some of DCP-o-matic's
+more complex or less-used controls are hidden from view in
+‘Simple’ mode. This makes the interface simpler to
+navigate. You may wish to choose this mode if you do not have much
+experience with video processing.
+</para>
+
+<para>Even if you choose ‘Simple’ mode you can always go
+back to ‘Full’ mode by changing the <guilabel>Interface
+complexity</guilabel> setting in the <guilabel>General</guilabel> tab
+of <guilabel>Preferences</guilabel>.
+</para>
+
+<para>
+All the screenshots in this manual are from a copy of DCP-o-matic in ‘Full’ mode.
+</para>
</section>
+
</chapter>
+
+
<!-- ============================================================== -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>Creating a DCP from a video</title>
<!-- ============================================================== -->
-<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" id="ch-manipulating-existing-dcps">
<title>Manipulating existing DCPs</title>
<para>
-Frequently DCP-o-matic is used to take content in formats such as MP4
-and convert it to JPEG2000 for a DCP. It can also be used
-to take existing DCPs and modify them in various ways.
+DCP-o-matic is often used to take content in formats such as MP4 and
+make it into a DCP. It can also be used to take existing DCPs and
+modify them in various ways.
</para>
<section>
<title>Importing a DCP into DCP-o-matic</title>
<para>
-If you want to do something to an existing DCP the first step is to
-import it. Click <guilabel>Add DCP...</guilabel> and select your
-DCP's folder. It will be added to the DCP-o-matic project. If the
-DCP is unencrypted you can preview it in the normal way, though
-playback will be very slow as decoding of DCPs is almost as
-computationally intensive as encoding them.
+The first step in manipulating an existing DCP is to import it. Click
+<guilabel>Add DCP...</guilabel> and select your DCP's folder. It will
+be added to the DCP-o-matic project. If the DCP is unencrypted you
+can preview it in the normal way, though playback will be slow as
+decoding of DCPs is almost as computationally intensive as encoding
+them.
</para>
<para>
</itemizedlist>
<para>
-If you do change any of these settings on a piece of DCP content
-DCP-o-matic will decode and then re-encode the JPEG2000 data.
+DCP-o-matic will be forced to decode and re-encode your JPEG2000 data
+if you change any of these settings on a piece of DCP content.
</para>
</section>
<colspec colwidth='5*'/>
<tbody>
<row>
-<entry>sRGB</entry><entry>Still images in RGB, e.g. photographs</entry>.
+<entry>sRGB</entry><entry>Still images in RGB, e.g. photographs.</entry>
</row>
<row>
<entry>Rec. 601</entry><entry>Standard-definition content (fewer than about 1000 pixels across) including DVD rips.</entry>
<!-- ============================================================== -->
<section>
-<title>Subtitles</title>
+<title>Timed text (subtitles and closed captions)</title>
<para>
-The subtitles tab contains settings related to subtitles in your
-content, as shown in <xref linkend="fig-subtitles-tab"/>.
+The timed text tab contains settings related to subtitles and closed captions in your
+content, as shown in <xref linkend="fig-timed-text-tab"/>.
</para>
-<figure id="fig-subtitles-tab">
- <title>Subtitle settings tab</title>
+<figure id="fig-timed-text-tab">
+ <title>Timed text settings tab</title>
<mediaobject>
<imageobject>
- <imagedata fileref="screenshots/subtitles-tab&scs;"/>
+ <imagedata fileref="screenshots/timed-text-tab&scs;"/>
</imageobject>
</mediaobject>
</figure>
+<para>
+Depending on where timed text comes from it can sometimes be used as
+either an open subtitle (to be overlaid onto the cinema screen and so
+seen by everybody) or as a closed caption (to be displayed to
+individual viewers using a special system such as the Doremi
+CaptiView™)
+</para>
+
<para>
DCP-o-matic can either:
</para>
<itemizedlist>
- <listitem>Extract subtitles that are embedded in video files, or</listitem>
- <listitem>Use subtitles from SubRip (<code>.srt</code>), SubStation
+ <listitem>Extract timed text that is embedded in video files, or</listitem>
+ <listitem>Use timed text from SubRip (<code>.srt</code>), SubStation
Alpha (<code>.ssa</code> or <code>.ass</code>) or DCP XML files. You may find the great
free program <ulink
url="http://www.nikse.dk/subtitleedit/">Subtitle Edit</ulink> useful
</itemizedlist>
<para>
-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 ‘burnt’ into the DCP (that is,
-they are included in the image and not overlaid by the projector).
+Embedded timed text is usually represented using a set of bitmaps,
+especially on files that have come from DVD or BluRay. Such text can
+be used as a subtitle, but not a closed caption (since the closed
+captioning system requires the text to be delivered as
+character codes rather than an image).
</para>
+<para>In contrast, SubRip, SubStation Alpha or DCP text can be used as either a subtitle or a closed caption.</para>
+
<para>
-With SubRip, SubStation Alpha or DCP subtitles you have the choice to
-either burn-in or include the subtitles as separate subtitle
+With subtitles you have the further choice of whether to burn the
+subtitles into the image or include them as a separate subtitle
‘asset’ 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"/>
</para>
<para>
-Select the <guilabel>Use Subtitles</guilabel> check-box to enable
-the subtitles in the selected content.
+Select the <guilabel>Use as</guilabel> check-box to enable the timed
+text in the selected content, then choose what you want to use the
+text for: open subtitles or closed captions.
</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
+burn subtitles into the image; if this is not ticked the
subtitles will be included separately in the DCP to be rendered by the
-projector. This check-box will always be ticked if you are using
-embedded ‘image’ subtitles.
+projector.
</para>
<para>
The <guilabel>X Offset</guilabel> and <guilabel>Y Offset</guilabel>
-controls move the subtitles around within the image. The offsets are
-expressed as a percentage of the video frame size; 100% X offset is
-the entire width of the frame, and 100% Y offset is the entire height.
-Hence, to move the subtitles down by half the frame height you would
-use a Y offset of 50%.
+controls move subtitles around within the image. These controls have
+no effect for closed captions. The offsets are expressed as a
+percentage of the video frame size; 100% X offset is the entire width
+of the frame, and 100% Y offset is the entire height. Hence, to move
+the subtitles down by half the frame height you would use a Y offset
+of 50%.
</para>
<para>
The <guilabel>X Scale</guilabel> and <guilabel>Y Scale</guilabel>
-controls scale the subtitles. Scale values of 1 make the subtitles
-the same size (relative to the size of the image) as they are on the
-original. Values lower than 1 make them smaller, and values higher
-make them larger. You can stretch the subtitles in either direction
-by specifying different values for X and Y scale. Subtitles from DVD
-and Blu Ray sources are frequently larger (relative to the video
-frame) than those typically used for DCP, so it is often useful to
-scale such subtitles down using these controls.
+controls scale subtitles. These controls have no effect for closed
+captions. Scale values of 1 make the subtitles the same size
+(relative to the size of the image) as they are on the original.
+Values lower than 1 make them smaller, and values higher make them
+larger. You can stretch the subtitles in either direction by
+specifying different values for X and Y scale. Subtitles from DVD and
+Blu Ray sources are frequently larger (relative to the video frame)
+than those typically used for DCP, so it is often useful to 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.
+of the subtitles. This only works for subtitles that did not come from bitmaps.
</para>
<para>
</para>
<para>
-If you are using non-embedded (text) subtitles you can see the
+If you are using non-image (text) subtitles or closed captions 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.
+change how the subtitles look. Some of the controls in the
+<guilabel>Apperance</guilabel> only apply to burnt-in subtitles, as
+only limited control is available for subtitles rendered by the
+projection system.
</para>
</section>
</section>
+<!-- ============================================================== -->
+<section>
+ <title>Timeline</title>
+
+ <para>
+ The timeline window gives an overview of all the pieces of content
+ in your film, and how they are arranged. You can open the
+ timeline by clicking the <guilabel>Timeline...</guilabel> button
+ next to the content list. This will open a window like the one in <xref linkend="fig-timeline1"/>.
+ </para>
+
+ <figure id="fig-timeline1">
+ <title>Timeline</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="screenshots/timeline1&scs;"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ The X axis represents time, and you can see the time codes (in
+ hours:minutes:seconds) along the bottom of the window. Pieces of
+ content are represented with rectangles in the main part of the
+ window. Content containing different types of data (e.g. a MP4
+ file with video, audio and subtitles) have a rectangle for each
+ type.
+ </para>
+
+ <para>
+ Within the timeline you can select content by clicking, and drag
+ it to change its position. Right-clicking a piece of content will
+ open the content menu.
+ </para>
+
+ <para>
+ The toolbar at the top of the window offers the following tools:
+ </para>
+
+ <itemizedlist>
+ <listitem>Select — to select and move content.</listitem>
+ <listitem>Zoom in — to drag out an area that you want to see more closely.</listitem>
+ <listitem>Zoom out — to zoom out so that the window shows the whole film.</listitem>
+ <listitem>Snap — when enabled, content will snap to other content when you drag it close.</listitem>
+ <listitem>Sequence — when enabled, content will be kept in sequence, without gaps, even if some content is removed.</listitem>
+ </itemizedlist>
+</section>
+
<!-- ============================================================== -->
<section>
<title>Video processing pipeline</title>
</chapter>
+<!-- ============================================================== -->
+<chapter xml:id="ch-export" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
+ <title>Export</title>
+
+ <para>
+ As well as creating DCPs from the content you specify, DCP-o-matic
+ can also export projects to ProRes and MP4 files. This is most
+ often useful to convert DCPs to a file that is smaller and easier to play back.
+ </para>
+
+ <para>
+ To convert a DCP to ProRes or MP4, the first step is start a new
+ project and import the DCP (see <xref
+ linkend="ch-manipulating-existing-dcps"/>). Then, choose
+ <guilabel>Export...</guilabel> from the <guilabel>Jobs</guilabel>
+ menu to open the export dialogue, as shown in <xref linkend="fig-export"/>.
+ </para>
+
+ <figure id="fig-export">
+ <title>Export dialogue</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="screenshots/export&scs;"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <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.
+ </para>
+
+ <para>
+ You can also choose whether to mix down multichannel sources to stereo and whether you want to write separate reels to separate files.
+ </para>
+</chapter>
<!-- ============================================================== -->
<chapter xml:id="ch-encryption" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
<title>KDM dialog</title>
<mediaobject>
<imageobject>
- <imagedata scale="40" fileref="screenshots/kdm&scs;"/>
+ <imagedata scale="35" fileref="screenshots/kdm&scs;"/>
</imageobject>
</mediaobject>
</figure>
<title>The KDM creator</title>
<mediaobject>
<imageobject>
- <imagedata scale="35" fileref="screenshots/kdm-creator&scs;"/>
+ <imagedata scale="30" fileref="screenshots/kdm-creator&scs;"/>
</imageobject>
</mediaobject>
</figure>
<guilabel>DCP</guilabel> tab sets the video frame rate that the DCP
will use. Clicking <guilabel>Use best</guilabel> sets the rate to
what DCP-o-matic thinks is the best for your content. With this
-button, DCP-o-matic assumes that the whole range of frame rates (24,
-25, 30 and 48fps) are allowable.
+button, DCP-o-matic assumes that the most commonly-working frame rates (24,
+25 and 30fps) are allowed.
</para>
<para>
</para>
<para>
- <code>dcpomatic2_create [OPTION] [CONTENT] [<CONTENT> ...]</code>
+ <code>dcpomatic2_create [OPTION] <CONTENT> [[OPTION] <CONTENT> ...]</code>
</para>
<para>
The options are:
</para>
- <itemizedlist>
- <listitem><code>-v</code>, <code>--version</code> — show DCP-o-matic version</listitem>
- <listitem><code>-h</code>, <code>--help</code> — show this help</listitem>
- <listitem><code>-n</code>, <code>--name</code> — <name> film name</listitem>
- <listitem><code>-t, --template <name></code> — template name</listitem>
- <listitem><code>-c, --dcp-content-type <type></code> — FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV</listitem>
- <listitem><code>--container-ratio <ratio></code> — 119, 133, 137, 138, 166, 178, 185 or 239</listitem>
- <listitem><code>--content-ratio <ratio></code> — 119, 133, 137, 138, 166, 178, 185 or 239</listitem>
- <listitem><code>-s, --still-length <n></code> — number of seconds that still content should last</listitem>
- <listitem><code>--standard <standard></code> — SMPTE or interop (default SMPTE)</listitem>
- <listitem><code>--no-use-isdcf-name></code> — do not use an ISDCF name; use the specified name unmodified</listitem>
- <listitem><code>--no-sign</code>— do not sign the DCP</listitem>
- <listitem><code>-o</code>, <code>--output <dir></code> — output directory</listitem>
- </itemizedlist>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dcpomatic_create.xml"/>
<para>
For example, to setup a film using a MP4 file you might do:
<code>dcpomatic2_cli [OPTION] [FILM]</code>
</para>
- <para>
- <itemizedlist>
- <listitem><code>-v</code>, <code>--version</code> — show DCP-o-matic version</listitem>
- <listitem><code>-h</code>, <code>--help</code> — show this help</listitem>
- <listitem><code>-f</code>, <code>--flags</code> — show flags passed to C++ compiler on build</listitem>
- <listitem><code>-n</code>, <code>--no-progress</code> — do not print progress to stdout</listitem>
- <listitem><code>-r</code>, <code>--no-remote</code> — do not use any remote servers</listitem>
- <listitem><code>-t</code>, <code>--threads</code> — specify number of local encoding threads (overriding configuration)</listitem>
- <listitem><code>-j</code>, <code>--json</code> <port> — run a JSON server on the specified port</listitem>
- <listitem><code>-k</code>, <code>--keep-going</code> — keep running even when the job is complete</listitem>
- <listitem><code>-s</code>, <code>--servers</code> — just display a list of encoding servers that DCP-o-matic is configured to use; don't encode</listitem>
- <listitem><code>-d</code>, <code>--dcp-path</code> — echo DCP's path to stdout on successful completion (implies -n)</listitem>
- <listitem><code>--dump</code> — just dump a summary of the film's settings; don't encode</listitem>
- </itemizedlist>
- </para>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dcpomatic_cli.xml"/>
<para>
For example, to encode a film called <code>my_film</code> you might do:
<code>dcpomatic2_kdm_cli [OPTION] <FILM|CPL-ID></code>
</para>
- <para>
- <itemizedlist>
- <listitem><code>-o</code>, <code>--output</code> — output file or directory</listitem>
- <listitem><code>-f</code>, <code>--valid-from</code> — valid from time (in local time zone of the cinema) (e.g. "2013-09-28 01:41:51") or "now"</listitem>
- <listitem><code>-t</code>, <code>--valid-to</code> — valid to time (in local time zone of the cinema) (e.g. "2014-09-28 01:41:51")</listitem>
- <listitem><code>-d</code>, <code>--valid-duration</code> — valid duration (e.g. "1 day", "4 hours", "2 weeks")</listitem>
- <listitem><code>--formulation</code> — modified-transitional-1, dci-any or dci-specific [default modified-transitional-1]</listitem>
- <listitem><code>-z</code>, <code>--zip</code> — ZIP each cinema's KDMs into its own file</listitem>
- <listitem><code>-v</code>, <code>--verbose</code> — be verbose</listitem>
- <listitem><code>-c</code>, <code>--cinema</code> — specify a cinema, either by name or email address</listitem>
- <listitem><code>--certificate</code> — file containing projector certificate</listitem>
- <listitem><code>--cinemas</code> — list known cinemas from the DCP-o-matic settings</listitem>
- <listitem><code>--dkdm-cpls</code> — list CPLs for which DCP-o-matic has DKDMs</listitem>
- </itemizedlist>
- </para>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dcpomatic_kdm_cli.xml"/>
</section>
</chapter>