X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=cc19d9ebf9a6e1b3230c2542954006875bf1d757;hb=4117c113eeffe817fddc1c63f5d10eb4e6ada4f9;hp=1519562fdc4aedc20dae6ae65085e3f6185c2169;hpb=f300b07097dc04c26557f62b4c7306bd21da23c3;p=dcpomatic.git
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 1519562fd..cc19d9ebf 100644
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -32,7 +32,7 @@ Hello, and welcome to DCP-o-matic!
Creation of Digital
Cinema Packages (DCPs) from video, audio and/or
- subtitle files.
+ subtitle and closed caption files.
Playback and verification of DCPs on a PC/Mac.Creation of KDMs for DCPs.
@@ -107,7 +107,8 @@ version.
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.
@@ -119,7 +120,7 @@ Windows version.
DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and
-higher. DCP-o-matic is split into four separate applications, each of
+higher. DCP-o-matic is split into five separate applications, each of
which can be installed by downloading the .dmg,
double-clicking to open and then dragging the icon to your
Applications folder.
@@ -142,7 +143,7 @@ with the first (main) part.
Debian 7 (‘wheezy’), 8 (‘jessie’), 9 (‘squeeze’) and unstable (‘sid’)
- Ubuntu 14.04 (‘Trusty Tahr’), 16.04 (‘Xenial Xerus’) and 18.04 (‘Bionic Beaver’)
+ Ubuntu 14.04 (‘Trusty Tahr’), 16.04 (‘Xenial Xerus’), 18.04 (‘Bionic Beaver’) and 18.10 (‘Cosmic Cuttlefish’)Mint 17, 18 and 19
@@ -224,7 +225,7 @@ directory:
-./waf configure
+./waf configure --disable-tests
./waf build
sudo ./waf install
@@ -240,11 +241,40 @@ dcpomatic2
in a shell.
+
+
+
+
+‘Simple’ and ‘Full’ modes
+
+When you start DCP-o-matic for the first time it will ask you if
+you want to use ‘simple’ or ‘full’ mode.
+
+
+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.
+
+
+Even if you choose ‘Simple’ mode you can always go
+back to ‘Full’ mode by changing the Interface
+complexity setting in the General tab
+of Preferences.
+
+
+
+All the screenshots in this manual are from a copy of DCP-o-matic in ‘Full’ mode.
+
+
+
+
Creating a DCP from a video
@@ -281,7 +311,7 @@ shown in .
Creating a new film
-
+
@@ -397,7 +427,7 @@ linkend="fig-making-dcp"/>.
Making the DCP
-
+
@@ -500,21 +530,21 @@ to encode a single frame which it can then repeat.
Manipulating existing DCPs
-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.
Importing a DCP into DCP-o-matic
-If you want to do something to an existing DCP the first step is to
-import it. Click Add DCP... 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
+Add DCP... 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.
@@ -602,8 +632,8 @@ the following content settings:
-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.
@@ -989,7 +1019,7 @@ linkend="tab-colour-conversion"/>.
-sRGBStill images in RGB, e.g. photographs.
+sRGBStill images in RGB, e.g. photographs.Rec. 601Standard-definition content (fewer than about 1000 pixels across) including DVD rips.
@@ -1276,29 +1306,37 @@ with respect to the video, and a negative delay will move it earlier.
-Subtitles
+Timed text (subtitles and closed captions)
-The subtitles tab contains settings related to subtitles in your
-content, as shown in .
+The timed text tab contains settings related to subtitles and closed captions in your
+content, as shown in .
-
@@ -2177,7 +2223,7 @@ linkend="fig-kdm"/>.
KDM dialog
-
+
@@ -2317,7 +2363,7 @@ DCP-o-matic. Its window is shown in .
The KDM creator
-
+
@@ -2767,12 +2813,39 @@ Note that for this to work on Doremi servers you will need to set the
+
+
+Email
+
+
+The Email tab is shown in .
+
+
+
+ Email preferences
+
+
+
+
+
+
+
+
+These settings are used when DCP-o-matic sends emails.
+
+
+
+ Outgoing mail server should be the host name of a mail (SMTP) server that DCP-o-matic can use. You can also specify the port that DCP-o-matic should use. User name and Password are the credentials that are required to send email through the server you have specified.
+
+
+
+
KDM email
-The KDM email is shown in .
+The KDM email tab is shown in .
@@ -2821,6 +2894,68 @@ The Reset to default text will replace the current KDM emai
+
+
+Accounts
+
+
+The Accounts tab is shown in .
+
+
+
+ Accounts preferences
+
+
+
+
+
+
+
+
+DCP-o-matic can download projector certificates from the Barco and
+Christie websites if you have the appropriate credentials. Enter your
+usernames and passwords.
+
+
+
+
+
+
+
+Notifications
+
+
+The Notifications tab is shown in .
+
+
+
+ Notifications preferences
+
+
+
+
+
+
+
+
+DCP-o-matic can notify the user when jobs have completed. These
+notifications can be either or both of a message box on-screen (if
+Message box is ticked) and email (if
+Email is ticked). If you enable email
+notifications you can fill in the details of the emails you want to
+send.
+
+
+
+The bottom box in the tab is the contents of the email that should
+be sent. DCP-o-matic will replace the ‘magic’ strings
+$JOB_NAME and $JOB_STATUS in the with the
+details of the job that has completed.
+
+
+
+
+
Cover sheet
@@ -3048,8 +3183,8 @@ The Frame Rate control in the
DCP tab sets the video frame rate that the DCP
will use. Clicking Use best 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.
@@ -3273,7 +3408,7 @@ to the cinema which is showing your DCP.
- dcpomatic2_create [OPTION] [CONTENT] [<CONTENT> ...]
+ dcpomatic2_create [OPTION] <CONTENT> [[OPTION] <CONTENT> ...]
@@ -3291,20 +3426,7 @@ to the cinema which is showing your DCP.
The options are:
-
- -v, --version — show DCP-o-matic version
- -h, --help — show this help
- -n, --name — <name> film name
- -t, --template <name> — template name
- -c, --dcp-content-type <type> — FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV
- --container-ratio <ratio> — 119, 133, 137, 138, 166, 178, 185 or 239
- --content-ratio <ratio> — 119, 133, 137, 138, 166, 178, 185 or 239
- -s, --still-length <n> — number of seconds that still content should last
- --standard <standard> — SMPTE or interop (default SMPTE)
- --no-use-isdcf-name> — do not use an ISDCF name; use the specified name unmodified
- --no-sign— do not sign the DCP
- -o, --output <dir> — output directory
-
+
For example, to setup a film using a MP4 file you might do:
@@ -3334,21 +3456,7 @@ to the cinema which is showing your DCP.
dcpomatic2_cli [OPTION] [FILM]
-
-
- -v, --version — show DCP-o-matic version
- -h, --help — show this help
- -f, --flags — show flags passed to C++ compiler on build
- -n, --no-progress — do not print progress to stdout
- -r, --no-remote — do not use any remote servers
- -t, --threads — specify number of local encoding threads (overriding configuration)
- -j, --json <port> — run a JSON server on the specified port
- -k, --keep-going — keep running even when the job is complete
- -s, --servers — just display a list of encoding servers that DCP-o-matic is configured to use; don't encode
- -d, --dcp-path — echo DCP's path to stdout on successful completion (implies -n)
- --dump — just dump a summary of the film's settings; don't encode
-
-
+
For example, to encode a film called my_film you might do:
@@ -3370,21 +3478,7 @@ to the cinema which is showing your DCP.
dcpomatic2_kdm_cli [OPTION] <FILM|CPL-ID>
-
-
- -o, --output — output file or directory
- -f, --valid-from — valid from time (in local time zone of the cinema) (e.g. "2013-09-28 01:41:51") or "now"
- -t, --valid-to — valid to time (in local time zone of the cinema) (e.g. "2014-09-28 01:41:51")
- -d, --valid-duration — valid duration (e.g. "1 day", "4 hours", "2 weeks")
- --formulation — modified-transitional-1, dci-any or dci-specific [default modified-transitional-1]
- -z, --zip — ZIP each cinema's KDMs into its own file
- -v, --verbose — be verbose
- -c, --cinema — specify a cinema, either by name or email address
- --certificate — file containing projector certificate
- --cinemas — list known cinemas from the DCP-o-matic settings
- --dkdm-cpls — list CPLs for which DCP-o-matic has DKDMs
-
-
+