X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=88c4b984b041a11a6ef8a8f3a4dd2a29d2bd77e0;hb=96c7c48da7e7c2b661f28be4ff454b84d0173801;hp=3a74341a193a92cd2be605a08422144025c2bfe8;hpb=9d82858f73679c9752e45ef632648e41d22ae864;p=dcpomatic.git
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 3a74341a1..88c4b984b 100644
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -26,13 +26,16 @@ Hello, and welcome to DCP-o-matic!
What is DCP-o-matic?
-
-DCP-o-matic is a program to generate Digital
-Cinema Packages (DCPs) from almost any video, audio and/or
-subtitle source files. The resulting DCPs will play on modern digital
-cinema projectors.
-
+DCP-o-matic is a set of tools to allow you to:
+
+
+ Create Digital
+ Cinema Packages (DCPs) from video, audio, subtitle and closed-caption files.
+ Play and verify DCPs (see and ).
+ Create KDMs for DCPs (see ).
+ Write cinema-format drives containing DCPs (see ).
+
@@ -43,7 +46,7 @@ cinema projectors.
DCP-o-matic is free and open-source and is licensed under the GNU
+url="https://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU
GPL.
@@ -58,6 +61,20 @@ GPL.
This manual uses icons from the Tango Desktop Project, with thanks.
+
+
+
+
+This manual
+
+
+This manual presents bits of DCP-o-matic's user interface (such as menu items or buttons) like this.
+
+
+
+Notes of an advanced nature are presented like this. Ignore them unless you want to know the details.
+
+
@@ -73,18 +90,14 @@ This manual uses icons from the Tango
To install DCP-o-matic on Windows, download the installer from
-http://dcpomatic.com/
+https://dcpomatic.com/
and double-click it. Click through the installer wizard, and
DCP-o-matic will be installed onto your machine.
-If you are using a 32-bit version of Windows, you will need the 32-bit
-installer. For 64-bit Windows, either installer will work, but I
-suggest you used the 64-bit version as it will allow DCP-o-matic to
-use more memory. You may find that DCP-o-matic crashes if you run
-many parallel encoding threads (more than 4) on the 32-bit
-version.
+Use the 64-bit installer unless you are using a 32-bit version of Windows.
+You may find that DCP-o-matic crashes if run the 32-bit version on a CPU with more than 4 cores.
@@ -92,68 +105,48 @@ version.
-Mac OS X
+macOS
-DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and
-higher. To install it, download the .dmg from http://dcpomatic.com/ and double
-click to open it. Then drag the DCP-o-matic icon to your
-Applications folder or wherever else you would
-like to install it.
+DCP-o-matic versions 2.16.0 and higher will run on macOS version 10.8 (Mountain Lion) and
+higher. DCP-o-matic is split into eight 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.
-
-
-
-
-Debian or Ubuntu Linux
-
- You can install DCP-o-matic on:
+If you don't know which parts of DCP-o-matic to install, start
+with the first (main) part.
-
- Debian 7 (‘wheezy’)
- Debian 8 (‘jessie’)
- Debian unstable (‘sid’)
- Ubuntu 12.04 (‘Precise Pangolin’)
- Ubuntu 14.04 (‘Trusty Tahr’)
- Ubuntu 15.04 (‘Vivid Vervet’)
- Ubuntu 15.10 (‘Wily Werewolf’)
-
-
-using .deb packages: download the appropriate package
-from http://dcpomatic.com/
-and double-click it. Debian or Ubuntu will install the necessary bits and
-pieces and set DCP-o-matic up for you.
+If you are using macOS 10.7 (Lion) or older you will need to install the latest 2.14.x version of DCP-o-matic.
-
-
+
- Fedora Linux
+Debian, Ubuntu and Mint Linux
- There are .rpm packages for Fedora 22 and 23 on
- http://dcpomatic.com/
-
+There are .deb packages for Debian, Ubuntu and Mint on
+ https://dcpomatic.com/
+
- Centos Linux
- There are .rpm packages for Centos 6.5 and 7 on
- http://dcpomatic.com/
+ Fedora, Centos and Mageia Linux
+
+ There are .rpm packages for Fedora, Centos and Mageia on
+ https://dcpomatic.com/
-
Arch Linux
@@ -164,79 +157,25 @@ thanks to Stefan Karner.
-
-
-Other Linux distributions
-
+Building from source
-Installation on other Linux systems (for which no packages are
-available) is quite hard; you will have to compile it from source. If
-you are using distribution for which no packages are available, do let
-me know by email and I
-will look into providing packages on the website.
+Since DCP-o-matic is open-source you can also build it yourself,
+though this can be quite a difficult process (especially on Windows and macOS).
+There are instructions for how to do it on https://dcpomatic.com/building
-
-
-The following dependencies are required:
-
-FFmpeg
-libsndfile
-libsamplerate
-OpenSSL
-libopenjpeg
-ImageMagick
-Boost
-libssh
-GTK (on Linux)
-wxWidgets
-libxml++
-xmlsec
-curl
-libzip
-libdcp
-libsub
-libcxml
-libicu
-
-
-
-
-Once you have installed the development packages for the dependencies,
-download the source code from http://dcpomatic.com/,
-unpack it and run the following commands from inside the source
-directory:
-
-
-
-./waf configure
-./waf build
-sudo ./waf install
-
-
-
-With any luck, this will build and install DCP-o-matic on your system. To run it, enter:
-
-
-
-dcpomatic2
-
-
-
-in a shell.
-
-
+
+
-Creating a video DCP
+Creating a DCP from a video
-In this chapter we will see how to create a video DCP using
+In this chapter we will see how to create a DCP from a video file using
DCP-o-matic. We will gloss over the details and look at the basics.
@@ -247,18 +186,22 @@ DCP-o-matic. We will gloss over the details and look at the basics.
Let's make a very simple DCP to see how DCP-o-matic works. First, we
need some content. Download the low-resolution trailer for the open
movie Sintel from their
-website. Generally, of course, one would want to use the
+url="https://download.blender.org/durian/trailer/Sintel_Trailer.480p.DivX_Plus_HD.mkv">their
+website. Generally one would want to use the
highest-resolution material available, but for this test we will use
-the low-resolution version to save everyone's bandwidth bills.
+the low-resolution version to save on download time.
Now, start DCP-o-matic and its window will open. First, we will
create a new ‘film’. A ‘film’ is how DCP-o-matic refers to
some pieces of content, along with some settings, which we will make into
-a DCP. DCP-o-matic stores its data in a folder on your disk while it
-creates the DCP. You can create a new film by selecting
+a DCP. DCP-o-matic stores its ‘film’ data in a folder on your disk while it
+creates the DCP.
+
+
+
+You can create a new film by selecting
New from the File menu, as
shown in .
@@ -281,7 +224,7 @@ linkend="fig-video-new-film"/>.
Dialogue box for creating a new film
-
+
@@ -289,12 +232,17 @@ linkend="fig-video-new-film"/>.
In this dialogue box you can choose a name for the film. This will be
used to name the folder to store its data in, and also as the initial
-name for the DCP itself. You can also choose whereabouts you want to create
+name for the DCP itself. You can also choose where you want to create
the film. In the example from the figure, DCP-o-matic will create a
-folder called ‘DCP Test’ inside my home folder (carl) into which it
+folder called ‘DCP Test’ inside my existing folder DCP into which it
will write its working files.
+
+DCPs can be very large (more than 100Gb for a feature-length DCP) so
+it's important to choose a folder on a disk with plenty of free space.
+
+
@@ -304,8 +252,8 @@ will write its working files.
The next step is to add the content that you want to use. DCP-o-matic
-can make DCPs from multiple pieces of content, but in this simple
-example we will just use a single piece. Click the Add
+can make DCPs from multiple pieces of content, but in this example we
+will use a single piece. Click the Add
file(s)... button, as shown in , and a file chooser will open for you to
select the content file to use, as shown in .
Dragging the slider will move through your video. You can also click
-the Play button to play the content back. Note
-that there will be no sound, and playback might not be entirely
-accurate (it may be slightly slower or faster than it should be, for
-example). This player is really only intended for brief inspection of
-content; if you need to check it more thoroughly, use another player
-such as Totem, mplayer or
-VLC.
+the Play button to play the content back.
@@ -391,23 +331,21 @@ linkend="fig-making-dcp"/>.
Making the DCP
-
+
-When it has finished, the DCP will end up on your disk inside the
-film's folder. You can then copy this to a projector via a USB
-stick, hard-drive or network connection. See for details about the files that DCP-o-matic creates.
-Alternatively, if you have a projector or Theatre Management System
-(TMS) that is accessible via SCP across your network, you can upload
-the content directly from DCP-o-matic. See the in .
+Alternatively, DCP-o-matic can upload your DCP directly to a projector
+or Theatre Management System (TMS) that is accessible via SCP or FTP
+across your network. See .
@@ -416,7 +354,7 @@ linkend="sec-prefs-tms" endterm="sec-prefs-tms-short"/> in
-Creating a still-image DCP
+Creating a DCP from a still image
DCP-o-matic can also be used to create DCPs of one or more still images, perhaps
@@ -425,7 +363,7 @@ how to do it.
-As with video DCPs, the first step is to create a new
+As with DCPs made from video files, the first step is to create a new
‘Film’; select New from the
File menu and the new film dialogue will open as
shown in .
@@ -435,7 +373,7 @@ shown in .
Dialogue box for creating a new film
-
+
@@ -457,10 +395,10 @@ linkend="fig-still-select-content-file"/>.
-As with video DCPs, most of the default settings will be fine for a
-simple test. The one thing that you might wish to change is the
-length of the still. Select the Timing tab and
-you will see a Play length setting, as shown in Timing tab and you will see a
+Full length setting, as shown in .
@@ -482,7 +420,7 @@ fourth frames. Enter the duration that you want and then click Set
Finally, as with video, you can choose Make DCP
from the Jobs menu to create your DCP. This will
-be much quicker than creating a video DCP, as DCP-o-matic only needs
+be much quicker than creating a DCP from a video file, as DCP-o-matic only needs
to encode a single frame which it can then repeat.
@@ -490,31 +428,44 @@ 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. Alternatively, it can 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 folder... 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 may 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
+another DCP's assets) you should import it as follows:
+
+Use Add DCP... to import the VF DCP.
+The VF DCP will be added to the content list and marked “NEEDS
+OV”.
+Right-click on the VF DCP in the content list and choose Add OV... from the menu.
+Choose the folder that contains the OV DCP. The VF will now be playable as normal.
+
+
-
+Decrypting encrypted DCPs
@@ -524,10 +475,10 @@ form of a Key Delivery Message (KDM), to decrypt it.
-KDMs must be prepared by the organisation which created the DCP. They
+KDMs must be prepared by whoever created the DCP. They
contain the keys to decrypt the DCP wrapped up in such a way that only
the intended recipient can read them. You will need to provide the
-organisation with a certificate which identifies your copy of
+KDM creator with a certificate which identifies your copy of
DCP-o-matic and allows them to create a KDM for you.
@@ -536,14 +487,14 @@ To get DCP-o-matic's decryption certificate, open the Preferences
dialogue (see ) and go to the
Keys tab. Click the Export DCP
decryption certificate... button at the bottom of this tab
-and save the certificate. Send this certificate to the DCP creators
-and they can create a KDM to allow DCP-o-matic to decrypt their DCP.
+and save the certificate. Send this certificate to the KDM creators
+and they can make a KDM to allow DCP-o-matic to decrypt the DCP.
-Once you have your KDM, right-click the DCP's name in DCP-o-matic and
-choose Add KDM.... Specify your KDM and (all
-being well) the DCP will be decrypted and become available for preview.
+Once you have your KDM, right-click the DCP's name in the DCP-o-matic content list and
+choose Add KDM.... Select your KDM and the DCP
+will be decrypted and become available for preview.
@@ -570,8 +521,8 @@ JPEG2000 encoding is not necessary.
-DCP-o-matic can do this if you avoid changes to the following content
-settings:
+DCP-o-matic can do this if you avoid changes to
+the following content settings:
@@ -583,14 +534,14 @@ 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.
-
+Making overlay files
@@ -608,7 +559,7 @@ This can be inefficient in some cases. Consider, for example, a film
which has ten different translations for which the subtitles are
different but video and audio are the same. If the video and audio
content takes up, say, 100Gb this means that the set of DCPs for every
-translation would be about 1Tb with a lot of duplicated data.
+translation would be about 1Tb, with a lot of duplicated data.
@@ -642,9 +593,9 @@ To make a DCP like this:
Import your ‘Content DCP’ to a DCP-o-matic project.Add whatever replacement you want in your new DCP (replacement subtitles or audio files, for example).Select the DCP in the content list
-Tick the Refer to existing DCP checkbox
+Tick the Use's this DCP's ... as OV and make VF checkbox
in the tabs for the parts of the DCP that you want to refer to in your
-new DCP. For example, to refer to the ‘Content DCP’'s video and audio you would select the Video tab, click Refer to existing DCP then select the Audio tab and do the same.
+new DCP. For example, to refer to the Content DCP's video and audio you would select the Video tab, click Use this DCP's video as OV and make VF then select the Audio tab and click Use this DCP's audio as OV and make VF.Do Make DCP as usual and your VF DCP will be created.
@@ -695,12 +646,14 @@ example, a JPEG, PNG or TIFF file.
images which should be treated as the frames of a video.
-Subtitle — a file containing subtitle which will be
+Subtitle — a file containing subtitles which will be
superimposed on the image of the DCP. These can be
-.srt or .xml
-files.
+.srt, .ssa, .ass or .xml
+files. Subtitle files can also be used to make closed captions.DCP — an existing DCP.
+
+ATMOS MXFs — if you have Dolby ATMOS content in MXF format (created using Dolby's tools) you can add it to a DCP just like any other content.
@@ -709,11 +662,64 @@ To add one or more movie, sound, still-image or subtitle files, select
-To add a directory (folder) of images or a DCP, choose Add
-folder... and choose the directory from the selector. If
-you select a folder of images DCP-o-matic will open a small dialogue
-box where you can enter the frame rate that the image sequence should
-be run at.
+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
+
+
+
+
‘Magic’ KDM strings
@@ -2424,6 +2935,9 @@ KDM that is being sent:
$CINEMA_NAMECinema name
+$CINEMA_SHORT_NAMEFirst 14 characters of the cinema name
+
+$SCREENSName of screen or screens that KDMs are being generated for
@@ -2442,6 +2956,103 @@ The Reset to default text will replace the current KDM emai
+
+
+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 content 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.
+
+
+
+
@@ -2478,11 +3089,19 @@ 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.
+
+
+
+With the filename format fields you can adjust the filenames that are
+used for metadata (CPL and PKL files) and assets (MXF and subtitle
+files). Below each field there is a list of the ‘magic’
+values that you can use in the format and an example of a filename
+that you might see with your current settings.
-The four checkboxes labelled Log control what
+The checkboxes labelled Log control what
sort of messages DCP-o-matic writes to its log file when creating a
DCP. It is useful to leave General,
Warnings and Errors ticked
@@ -2491,13 +3110,12 @@ 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.
-
@@ -2519,8 +3137,7 @@ however, always possible.
There are some limitations to video and audio frame rates in DCPs. This is
complicated by the fact that not all projectors will play DCPs at the
same frame rates. It is possible to create a DCP which one projector will
-play fine, but another (of a different type) will refuse to play, or
-even refuse to ingest.
+play fine, but another (of a different type, or even just with a different software version) will refuse to play.
@@ -2529,10 +3146,10 @@ even refuse to ingest.
Guaranteed rates
-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
-consider using these rates if at all possible.
+The only rates that are guaranteed to work on all DCI 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.
@@ -2543,7 +3160,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.
@@ -2563,7 +3180,7 @@ with minimal loss in quality.
-Video rate conversion is harder. DCP-o-matic's basic strategy to deal
+Video rate conversion is harder. DCP-o-matic's strategy to deal
with a non-supported content rate is to run it at the wrong speed, and
to adjust the audio to keep it in sync.
@@ -2601,8 +3218,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.
@@ -2612,8 +3229,8 @@ content.
-If you want to experiment with other non-standard frame rates, you can
-do so by ticking the Allow any DCP frame rate in
+You can experiment with other non-standard frame rates
+by ticking the Allow any DCP frame rate in
the Advanced tab of the preferences dialogue (see the
). You are strongly advised to
use this only on your own equipment, and only for experimentation
@@ -2625,6 +3242,7 @@ purposes.
+
Encoding servers
@@ -2638,7 +3256,7 @@ a small program called dcpomatic_server.
-The master and server machines do not need to be the same type, so you
+The master and server machines do not need to be running the same operating system, so you
can mix Windows PCs, Macs and Linux machines as you wish.
@@ -2648,11 +3266,11 @@ can mix Windows PCs, Macs and Linux machines as you wish.
Running the servers
-There are two options for the encoding server;
+There are two options for the encoding server:
dcpomatic_server_cli, which runs on the command line, and
dcpomatic_server, which has a simple GUI. The command line
version is well-suited to headless servers, especially on Linux, and
-the GUI version works best on Windows where it will put an icon in the
+the GUI version works best on Windows and macOS where it will put an icon in the
system tray.
@@ -2688,7 +3306,7 @@ server or open a window to show its status.
If you would rather not bother installing DCP-o-matic on your
server computers, the other option is to use the live-CD
image that you can download from the DCP-o-matic web site.
+url="https://dcpomatic.com/">DCP-o-matic web site.
Either burn the image to CD, or write it to a USB stick (using
something like
Following this is the DCP itself:
DCP-TEST_EN-XX_UK-U_51_2K_CSY_20130218_CSY_OV. This
contains some small XML files, which describe the DCP, and two large
-MXF files, which contain the DCP's audio and video data. This folder
+MXF files, which contain the DCP's audio and video data. It may also
+contain subtitles or closed captions in either XML or MXF format. This folder
(DCP-TEST_EN-XX_...) is what you should ingest, or pass
to the cinema which is showing your DCP.
+
+
+ Command-line tools
+
+
+ DCP-o-matic includes some tools which allow DCP creation from the
+ command line or from scripting languages. This chapter covers the
+ use of those tools.
+
+
+
+ There are three command-line tools in DCP-o-matic.
+ dcpomatic2_create creates film directories, with the
+ associated metadata, from a list of content files. Then
+ dcpomatic2_cli runs the transcode process on these
+ film directories. Finally, dcpomatic2_kdm_cli can be
+ used to create KDMs.
+
+
+
+ Some applications will benefit from setting up the films using the
+ main DCP-o-matic GUI and then using dcpomatic2_cli to
+ do the encode. This allows, for example, setup on a relatively
+ low-powered machine before running the encode on a higher-powered
+ headless server.
+
+
+
+ dcpomatic2_create
+
+
+ The syntax for dcpomatic2_create is:
+
+
+
+ dcpomatic2_create [OPTION] <CONTENT> [[OPTION] <CONTENT> ...]
+
+
+
+ [CONTENT] are the files or folders that you want to use in the
+ DCP. They can be:
+
+ ‘Movie’ files in almost any common format (e.g. MP4, MOV, MKV, etc.)
+ A folder containing and image sequence in almost any common format (e.g. TIFF, DPX etc.)
+ Sound files (e.g. WAV, MP3, AIFF)
+ Subtitles files (e.g. .srt, DCP XML, .ssa etc.)
+
+
+
+
+ The options are:
+
+
+
+
+
+ For example, to setup a film using a MP4 file you might do:
+
+
+
+ dcpomatic2_create -o my_film --container-ratio 185 --content-ratio 185 -c FTR -n "My Film" Stuff.mp4
+
+
+
+ This will create a folder called my_film which is ready for a DCP to be made by dcpomatic2_cli.
+
+
+
+ dcpomatic2_create will use any default settings that you have configured in the main DCP-o-matic preferences.
+
+
+
+
+ dcpomatic2_cli
+
+
+ The syntax for dcpomatic2_cli is:
+
+
+
+ dcpomatic2_cli [OPTION] [FILM]
+
+
+
+
+
+ For example, to encode a film called my_film you might do:
+
+
+
+ dcpomatic2_cli my_film
+
+
+
+
+ dcpomatic2_kdm_cli
+
+
+ The syntax for dcpomatic2_kdm_cli is:
+
+
+
+ dcpomatic2_kdm_cli [OPTION] <FILM|CPL-ID>
+
+
+
+
+
+
+
+
+
+
Loose ends
@@ -2823,4 +3555,409 @@ hashes.
+
+
+Common tasks
+
+
+This chapter describes how to carry out some commonly-required tasks
+with DCP-o-matic. The full details are elsewhere in the manual: here
+we just discuss different approaches to these tasks and how to carry
+them out.
+
+
+
+Adding subtitles to an existing DCP
+
+
+You have three options:
+
+
+
+Make a “Version File” (VF) DCP.
+Make a complete DCP with projector-added subtitles.
+Make a complete DCP with burnt-in subtitles.
+
+
+
+Making a VF DCP is usually the best option. This will be a very small
+DCP which contains only the subtitles: it refers to your existing DCP
+for the picture and sound. The projectionist will ingest both the
+existing and VF DCPs and play back the VF. The advantages of this
+approach are that the VF is very quick to generate, and small in size,
+making it easy to distribute. This is especially useful if you have
+to make VF DCPs in many different languages.
+
+
+
+Making a complete DCP with projector-added subtitles gives you a new,
+single DCP which the projectionist can ingest and play. It will be
+the same size as your existing DCP, and fairly quick to create. This
+approach relies on the projector (or server) to create the subtitles
+and overlay them on the image, which mostly works well but is not
+100% reliable.
+
+
+
+Making a complete DCP with burnt-in subtitles gives you a new, single DCP
+but with the subtitles rendered by DCP-o-matic and copied into your
+image. This is slower to create than a DCP with projector-added
+subtitles as every video frame with a subtitle must be re-encoded.
+The advantage of this approach is that it is less likely to go wrong,
+especially if you are using unusual subtitle positioning or character
+sets.
+
+
+
+Making a VF DCP
+
+
+Start a new DCP-o-matic film.
+Click Add DCP... and specify your existing DCP's folder.
+Go to the DCP tab and choose Split by video content for Reel type.
+Go to the Video tab and tick the Use this DCP's video as OV and make VF checkbox.
+Go to the Audio tab and tick the Use this DCP's audio as OV and make VF checkbox.
+Add your subtitles to the film in whatever format you have.
+Check the subtitle appearance in the preview; it will be
+slow to respond as it is having to decompress images from the existing
+DCP.
+Choose Make DCP from the menu.
+
+
+
+
+
+Making a complete DCP with projector-added subtitles
+
+
+Start a new DCP-o-matic film.
+Click Add DCP... and specify your existing DCP's folder.
+Add your subtitles to the film in whatever format you have.
+Check the subtitle appearance in the preview; it will be
+slow to respond as it is having to decompress images from the existing
+DCP. Adjust the appearance using controls in the
+Timed Text or Closed Captions tabs if required.
+Choose Make DCP from the menu.
+
+
+
+
+
+Making a complete DCP with burnt-in subtitles
+
+
+Start a new DCP-o-matic film.
+Click Add DCP... and specify your existing DCP's folder.
+Add your subtitles to the film in whatever format you have.
+Go to the Subtitle tab and tick the Burn subtitles into image checkbox.
+Check the subtitle appearance in the preview; it will be
+slow to respond as it is having to decompress images from the existing
+DCP. Adjust the appearance using controls in the
+Timed Text or Closed Captions tabs if required.
+Choose Make DCP from the menu.
+
+
+
+
+
+
+Adding soundtracks or subtitles in different languages
+
+
+If you have a film that is to be dubbed or subtitled in several
+languages, the best approach with DCP-o-matic is as follows:
+
+
+
+Make a DCP with the common elements (perhaps just the video, or maybe the video and sound); this is known as the Original Version (OV).
+For each language, make a new Version File (VF) DCP which refers to the OV.
+
+
+
+Once you have done this, you send the OV DCP to every cinema and then
+the appropriate VF to each cinema depending on what language they want
+to play the film in. The projectionist ingests both DCPs and then plays the VF.
+
+
+
+The advantage of this approach is that the VF DCPs are much smaller
+than the OV since they only have the language-specific parts. If you
+are just changing the subtitles you can often ship the OV by normal
+transport means (e.g. a hard drive or high-speed download) and send
+the VF by email.
+
+
+
+The full details of OV and VF files are discussed in . The steps can be summarised as follows:
+
+
+
+Create a new DCP-o-matic project for the OV, as normal, adding video and perhaps sound. Make the DCP.
+Create a new DCP-o-matic project for the VF.
+Use Add folder... to add your OV DCP to the project.
+Select the video tab and tick Use this DCP's video as OV and make VF (you may need to select By video content for Reel type in the DCP tab).
+Do the same in the Audio tab if your OV has audio.
+Add your language-specific audio and/or subtitles and Make DCP.
+
+
+
+
+
+
+
+ Playing DCPs
+
+ DCP-o-matic includes a DCP player, and although it requires a
+ very high-speed CPU to play DCPs in full resolution, it can also
+ play DCPs at reduced resolutions with slower CPUs.
+
+ To use the player, start DCP-o-matic
+ Player, and load a DCP using the
+ Open option on the File
+ menu.
+
+ If you load a VF and/or encrypted DCP you can add your OV
+ and/or KDM using the appropriate options on the
+ File menu.
+
+ During playback the Performance area at
+ the bottom right of the window will give details of how many frames
+ are being dropped; these are frames that were not decoded from the
+ DCP quickly enough. If this number is high you can increase
+ performance at the cost of rendering quality by choosing an option
+ from the View menu. If you set the player to
+ decode at less than full resolution the DCP's data will be decoded
+ at this lower resolution, which is quicker than decoding at full
+ resolution.
+
+
+ Another way to improve performance is to set the Video display mode
+ in Preferences to OpenGL (faster). This should provide
+ a significant speed-up on most systems, although this mode has not been so widely tested so may
+ have problems.
+
+
+
+
+
+
+ Verifying DCPs
+
+
+ The DCP-o-matic Player (see ) also offers a DCP verifier. To check a DCP,
+ open it and then select Verify DCP from the
+ Tools menu.
+
+
+
+ The verifier will report three kinds of problems:
+
+
+
+ Errors — serious problems with the DCP that are likely to cause problems on playback.
+ Bv2.1 errors — errors described by the SMPTE Bv2.1 standard.
+ Warnings — small problems that may not matter.
+
+
+
+ The following sections list what the verifier checks for in each category.
+
+
+
+ Errors
+
+
+
+
+ Bv2.1 errors
+
+
+
+
+ Warnings
+
+
+
+
+
+
+
+
+Writing DCPs to disks
+
+
+Once you have your DCP, you need to get it to the cinema or theater who
+will play it. Sometimes this is possible via the internet, using a
+service such as Filemail. If that's an option: go for it! Network
+transfers avoid a lot of the difficulties that other methods have.
+
+
+
+However, your DCP may be too large to make that practical. In that case,
+the usual approach is to copy the DCP onto a USB hard drive or stick and
+physically take it or send it to the cinema.
+
+
+
+Hard drive formatting
+
+
+In theory, this should be as simple as dragging and dropping the DCP's
+files onto a USB-connected drive. Sadly, though, things are not always
+that simple. This is because not all hard drives are formatted in the
+same way. The most common formats for hard drives are:
+
+
+
+APFS — used by macOS 10.13 and later for solid state drives (SSDs).
+HFS+ (Mac OS Extended) — used by macOS on 10.12 and earlier, and on all macOS systems for spinning disks.
+NTFS — modern format used by Windows.
+ExFAT — another modern, but less common (and buggier) format used by Windows.
+FAT32 — old format used by Windows.
+ext2, ext3, ext4 — often used by Linux.
+
+
+
+You can format a drive however you want, but a drive set up on macOS will usually use APFS, just as one set up on Windows will probably use NTFS or ExFAT.
+
+
+
+The problem you have as a DCP maker is: the only format that is
+guaranteed to work in all cinemas is ext2. This format is not easy to
+use directly from Windows or macOS: both operating systems need extra
+software to write ext2 drives.
+
+
+
+The “DCP-o-matic Disk Writer” provides a possible
+solution to this problem. It allows you to format and copy DCPs onto ext2-formatted disks from Windows, macOS or Linux.
+
+
+
+
+
+
+Caution
+
+
+DCP-o-matic is made by one developer in his spare time. As a project,
+we do not have any quality assurance department, testing team or
+anything like that. Though we try our best to ensure quality using
+automated testing, and by the great efforts of our users to find and report problems,
+bugs do get into the code and things do go wrong.
+
+
+
+Though very undesirable, bugs in most parts of DCP-o-matic are usually
+not disastrous; they most often result in an error message, or some
+problem with a DCP. The Disk Writer tool, however, is a bit different. It obtains
+permission from your operating system to write directly to disks connected to the
+computer. Though we have done as much as we can to prevent problems, there is a chance
+that a bug in the Disk Writer could cause irretrievable data loss (for example, if
+the writer wrote to the wrong drive by mistake).
+
+
+
+No such problems have been reported, nor found by us during testing, but I would
+like to warn you that they are possible. As always, make sure that you have backups
+(somewhere that is not directly connected to your computer) of anything that you do not want
+to lose.
+
+
+
+
+
+
+Writing a DCP to a disk
+
+
+Starting up the Disk Writer will give open a confirmation window to make sure that you understand the risks involved, as shown in .
+
+
+
+ Starting the Disk Writer
+
+
+
+
+
+
+
+
+If you are sure you want to continue, type I am sure into the text box and click OK. This will open the window shown in .
+
+
+
+ The Disk Writer
+
+
+
+
+
+
+
+Next, click Open... and choose the DCP that you want to write.
+
+
+Now we need to choose the drive that the DCP will be written to from the drop-down menu.
+Whichever drive you choose will be irretrievably wiped!
+If the drive you want is not listed, click Refresh to search the system for drives.
+
+
+
+Finally, click Copy DCP. After a confirmation window, the drive will be formatted,
+and the DCP copied and then read back to check that it was written correctly.
+
+
+
+
+
+
+
+
+
+Keyboard shortcuts
+
+
+
+
+
+
+Configuration files
+
+Most of DCP-o-matic's configuration is stored in an XML file called config.xml. This is stored in different places depending on your operating system:
+
+
+ Windows: c:\Users\your_user_name\AppData\Local\dcpomatic
+ OS X: /Users/your_user_Name/Library/Preferences/com.dcpomatic/2
+ Linux: ~/.config/dcpomatic2
+
+
+Possible XML tags are as follows:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+