X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=f56c005d68bcd492acf2445ecedddd543bacdb53;hb=25043fac5a810cc7d906f1b3d88d0ae90f2a2299;hp=18b2eafa3776d9f388baa6b183ce5b6d270c8c02;hpb=03dba08f2f8be761b644e7837f64764faef1e5ab;p=dcpomatic.git
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 18b2eafa3..f56c005d6 100644
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -32,8 +32,8 @@ Hello, and welcome to DCP-o-matic!
Creation of Digital
Cinema Packages (DCPs) from video, audio and/or
- subtitle files.
- Playback of DCPs on a PC.
+ 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.
@@ -141,20 +142,15 @@ with the first (main) part.
- Debian 7 (‘wheezy’)
- Debian 8 (‘jessie’)
- Debian unstable (‘sid’)
- Ubuntu 14.04 (‘Trusty Tahr’)
- Ubuntu 16.04 (‘Xenial Xerus’)
- Ubuntu 17.10 (‘Artful Aardvark’)
- Mint 17
- Mint 18
+ Debian 7 (‘wheezy’), 8 (‘jessie’), 9 (‘squeeze’) and unstable (‘sid’)
+ Ubuntu 14.04 (‘Trusty Tahr’), 16.04 (‘Xenial Xerus’), 18.04 (‘Bionic Beaver’) and 18.10 (‘Cosmic Cuttlefish’)
+ Mint 17, 18 and 19
using .deb packages: download the appropriate package
from http://dcpomatic.com/
-and double-click it. Debian or Ubuntu will install the necessary bits and
+and double-click it. Debian, Ubuntu or Mint will install the necessary bits and
pieces and set DCP-o-matic up for you.
@@ -165,7 +161,7 @@ pieces and set DCP-o-matic up for you.
Fedora, Centos and Mageia Linux
- There are .rpm packages for Fedora 25, 26 and 27, Centos 6 and 7 and Mageia 6 on
+ There are .rpm packages for Fedora 27, 28 and 29, Centos 6 and 7 and Mageia 6 on
http://dcpomatic.com/
@@ -202,7 +198,6 @@ The following dependencies are required:
libsamplerateOpenSSLlibopenjpeg
-ImageMagickBoostlibsshGTK (on Linux)
@@ -211,9 +206,12 @@ The following dependencies are required:
xmlseccurllibzip
-libdcp
-libsub
-libcxml
+asdcplib with some patches
+libdcp
+libsub
+libcxml
+locked_sstream
+rtaudiolibicu
@@ -227,7 +225,7 @@ directory:
-./waf configure
+./waf configure --disable-tests
./waf build
sudo ./waf install
@@ -243,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
@@ -284,7 +311,7 @@ shown in .
Creating a new film
-
+
@@ -400,7 +427,7 @@ linkend="fig-making-dcp"/>.
Making the DCP
-
+
@@ -499,29 +526,29 @@ 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.
-If your DCP is a Version File (VF) (i.e.\ it refers to
+If your DCP is a Version File (VF) (i.e. it refers to
another DCP's assets) you should import it as follows:
@@ -536,7 +563,7 @@ OV”.
-
+Decrypting encrypted DCPs
@@ -605,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.
@@ -730,6 +757,55 @@ To add one or more movie, sound, still-image or subtitle files, select
Add file(s)... and choose them from the selector.
+
+DCP-o-matic will automatically map a set of audio files to the correct channels if you include appropriate ‘tags’ in your filenames, as shown in .
+
+
+
+ Audio file naming
+
+
+
+ Tag
+ Examples
+ Channel
+
+
+
+
+ L surrounded by ._ or -
+ film-L.wav my_movie_L_final.wav
+ Left
+
+
+ R surrounded by ._ or -
+ film-R.wav my_movie_R_final.wav
+ Right
+
+
+ C surrounded by ._ or -
+ film-C.wav my_movie_C_final.wav
+ Centre
+
+
+ Lfe surrounded by ._ or -
+ film-Lfe.wav my_movie_Lfe_final.wav
+ LFE (sub)
+
+
+ Ls surrounded by ._ or -
+ film-Ls.wav my_movie_Ls_final.wav
+ Left surround
+
+
+ Rs surrounded by ._ or -
+ film-Rs.wav my_movie_Rs_final.wav
+ Right surround
+
+
+
+
+
To add a directory (folder) of images, choose Add
folder... and choose the directory from the selector.
@@ -943,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.
@@ -991,11 +1067,11 @@ url="http://dcpomatic.com/manual/colour.pdf">colour.pdf.
Other settings
-The crop settings can be used to crop your content,
-which can be used to remove black borders from round the edges of DVD
-images, for example. The specified number of pixels will be trimmed
-from each edge, and the content image in the right of the window will
-be updated to show the effect of the crop.
+The crop settings can be used to crop your
+content, which is often used to remove black borders from the edges of
+the image. The specified number of pixels will be trimmed from each
+edge, and the content image in the right of the window will be updated
+to show the effect of the crop.
@@ -1230,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 .
-
@@ -1444,6 +1536,54 @@ any changes to the corresponding timecode.
+
+
+ Timeline
+
+
+ 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 Timeline... button
+ next to the content list. This will open a window like the one in .
+
+
+
+ Timeline
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+ 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.
+
+
+
+ The toolbar at the top of the window offers the following tools:
+
+
+
+ Select — to select and move content.
+ Zoom in — to drag out an area that you want to see more closely.
+ Zoom out — to zoom out so that the window shows the whole film.
+ Snap — when enabled, content will snap to other content when you drag it close.
+ Sequence — when enabled, content will be kept in sequence, without gaps, even if some content is removed.
+
+
+
Video processing pipeline
@@ -1725,7 +1865,7 @@ The JPEG2000 bandwidth; setting changes how big
the final image files used within the DCP will be. Larger numbers
will give better quality, but correspondingly larger DCPs. The
bandwidth can be between 50 and 250 megabits per second (Mbit/s).
-Most commercial DCPs use bit rates between 75 and 125 MBit/s.
+Most commercial DCPs use bit rates between 75 and 125 Mbit/s.
@@ -1973,6 +2113,43 @@ from the timeline is also preserved.
+
+
+ Export
+
+
+ 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.
+
+
+
+ To convert a DCP to ProRes or MP4, the first step is start a new
+ project and import the DCP (see ). Then, choose
+ Export... from the Jobs
+ menu to open the export dialogue, as shown in .
+
+
+
+ Export dialogue
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+ You can also choose whether to mix down multichannel sources to stereo and whether you want to write separate reels to separate files.
+
+
@@ -2002,7 +2179,7 @@ delivery message (KDM) can play the DCP.
-How it works (in a nutshell)
+How it works
This section attempts to summarise how DCP encryption works. You can
@@ -2052,9 +2229,16 @@ key from the public key.
Public-key encryption allows us to distribute the DCP's key to Alice
securely. The manufacturer of Alice's projector generates a public
-and private key. They hide the private key deep inside the bowels of
-the projector (inside an integrated circuit) where no-one can read it.
-They then make the public key available to anyone who is interested.
+and private key. They hide the private key inside the projector where
+no-one can read it. They then make the public key available to anyone
+who is interested.
+
+
+
+DCP-o-matic has a similar arrangement except that it stores its
+private keys in the user's configuration file. See for details of how to share DCP-o-matic's
+certificate so that others can make encrypted DCPs for DCP-o-matic.
@@ -2124,7 +2308,7 @@ linkend="fig-kdm"/>.
KDM dialog
-
+
@@ -2231,7 +2415,7 @@ create KDMs for its film. Perhaps you want to archive the project to
save space, or create KDMs on a different machine. In such situations
it is easier to use a DKDM. This is a normal KDM, but instead of
being targeted at a projection system (to allow it to decrypt the
-content) it is targeted at a particular users's certificate. This
+content) it is targeted at a particular user's certificate. This
means that the certificate owner can create new KDMs for other users.
The DKDM holds everything that is required to create further KDMs.
@@ -2264,7 +2448,7 @@ DCP-o-matic. Its window is shown in .
The KDM creator
-
+
@@ -2341,8 +2525,8 @@ system; possible locations are listed in Preferences
-DCP-o-matic provides a few preferences which can be used to modify its
-behaviour. This chapter explains those options.
+DCP-o-matic provides preferences which can be used to modify its
+behaviour. They are described in this chapter.
@@ -2390,7 +2574,7 @@ read about how to contribute a translation.
-Threads
+Number of threads DCP-o-matic should use
When DCP-o-matic is encoding DCPs it can use multiple parallel threads
@@ -2402,6 +2586,31 @@ to set this up correctly when you run it for the first time.
+
+
+
+Number of threads DCP-o-matic encode server should use
+
+
+This is the number of threads that the encode server should use when
+it is running and helping another copy of DCP-o-matic to speed up its
+encode.
+
+
+
+
+
+
+
+Configuration file
+
+
+This is the location of DCP-o-matic's configuration file on disk. You
+can use this to share configuration between several copies of
+DCP-o-matic, across a network share, for instance.
+
+
+
Cinema and screen database file
@@ -2410,9 +2619,22 @@ to set this up correctly when you run it for the first time.
This option allows you to change the file that DCP-o-matic uses to
store details of the cinemas and screens used to make KDMs.
+
+
+
+
+Play sound via
+
+
+The checkbox to the left of Play sound enables or
+disables DCP-o-matic use of sound. On some machines there will be
+multiple options in the drop-down menu to decide how the sound should
+be played.
+
+
Integrated loudness
@@ -2426,6 +2648,15 @@ faster.
+
+
+Automatically analyse content audio
+
+
+If this checkbox is ticked an audio analysis will be run whenever content is added that contains sound.
+
+
+
Updates
@@ -2520,7 +2751,7 @@ name or IP address of the server to use.
Keys
-The Keys tab (shown in ) holds options
+The Keys tab (shown in ) has controls
related to the keys and certificates used in some parts of DCP
creation.
@@ -2535,9 +2766,43 @@ creation.
-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 and if you are happy to use this chain you can ignore the
+Export KDM decryption certificate... allows you
+to save the certificate that DCP-o-matic uses when decrypting KDMs
+that you give it. Use this option if somebody wants to make a KDM for
+you and asks for your certificate.
+
+
+
+Export KDM decryption chain... exports the whole
+KDM decryption chain rather than just its certificate. This may also
+be requested by KDM creators.
+
+
+
+Export all KDM decryption settings... exports a
+file which contains all the DCP-o-matic settings related to the use of
+KDMs supplied by other people. Use this button and Import
+all KDM decryption settings... to transfer settings between
+different copies of DCP-o-matic so that they can both use the same
+KDMs.
+
+
+
+The two Advanced... buttons open advanced
+dialogue boxes for detailed manipulation of DCP-o-matic's certificate
+chains.
+
+
+
+
+
+Advanced keys settings
+
+
+At the top of the Advanced dialogue for signing
+DCPs and KDMs 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 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 Add... and
Remove buttons.
@@ -2559,13 +2824,13 @@ corresponds to the public key held in the leaf certificate.
-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
+At the top of the Advanced dialogue for decrypting DCPs is the 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.
+
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
@@ -2633,12 +2898,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 .
@@ -2687,6 +2979,130 @@ 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
+
+
+The DCP cover sheet configuration is shown in .
+
+
+
+ DCP cover sheet preferences
+
+
+
+
+
+
+
+
+This is a template for the cover sheet that is written next to every DCP that DCP-o-matic creates. You can change it to say whatever you like. A few
+‘magic’ strings will be replaced by information from the
+DCP that has been made:
+
+
+
+‘Magic’ Cover sheet strings
+
+
+
+$CPL_NAMEDCP title
+
+
+$TYPEDCP content type (e.g. feature, trailer...)
+
+
+$CONTAINERThe container ratio (e.g. flat, scope...)
+
+
+$AUDIODetails of the audio channels
+
+
+$AUDIO_LANGUAGEAudio language
+
+
+$SUBTITLE_LANGUAGESubtitle language
+
+
+$LENGTHDCP length in hours, minutes and seconds
+
+
+$SIZEDCP size in gigabytes
+
+
+
+
+
+
+The Reset to default text will replace the current cover sheet with DCP-o-matic's default.
+
+
+
+
+
Advanced
@@ -2722,7 +3138,7 @@ this unticked for normal use.
Only servers encode 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.
+suggest you leave this unticked unless you have a good reason to do otherwise.
@@ -2743,7 +3159,7 @@ as this makes the log files useful for tracking down bugs.
The Timing checkbox will enable extra log entries
-to allow developers to investigate and optimize the speed of
+to allow developers to investigate and optimise the speed of
DCP-o-matic. It will significantly increase the size of the log files
that are generated, so in normal use it is best to leave this
unticked.
@@ -2781,8 +3197,8 @@ even refuse to ingest.
The only rates that are (pretty much) guaranteed to work on all DCI
-projectors are 24 frames per second (fps) for video and 48kHz or 96kHz
-for audio. If you are sending your DCPs to unknown places it wise to
+projectors are 24 frames per second (fps) for video and 48kHz for
+audio. If you are sending DCPs to unknown places it is wise to
consider using these rates if at all possible.
@@ -2794,7 +3210,7 @@ consider using these rates if at all possible.
Other often-supported rates
Many projectors now in the wild support additional video frame rates:
-25, 30 and 48 fps.
+25, 30, 48, 50 and 60 fps.
@@ -2852,8 +3268,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.
@@ -3077,7 +3493,7 @@ to the cinema which is showing your DCP.
- dcpomatic2_create [OPTION] [CONTENT] [<CONTENT> ...]
+ dcpomatic2_create [OPTION] <CONTENT> [[OPTION] <CONTENT> ...]
@@ -3095,20 +3511,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:
@@ -3138,21 +3541,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:
@@ -3174,21 +3563,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
-
-
+