X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=797a49fe5812acc820f54ee31c26f753c9e4c9c9;hb=3ddec1cb6b495763991f18ed6ffccc8724882199;hp=18b2eafa3776d9f388baa6b183ce5b6d270c8c02;hpb=03dba08f2f8be761b644e7837f64764faef1e5ab;p=dcpomatic.git
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 18b2eafa3..797a49fe5 100644
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -26,15 +26,15 @@ Hello, and welcome to DCP-o-matic!
What is DCP-o-matic?
-DCP-o-matic is a set of programs to perform the following tasks:
+DCP-o-matic is a set of programs to allow you to:
- Creation of Digital
- Cinema Packages (DCPs) from video, audio and/or
- subtitle files.
- Playback of DCPs on a PC.
- Creation of KDMs for DCPs.
+ Create Digital
+ Cinema Packages (DCPs) from video, audio, subtitle and closed-caption files.
+ Play and verify DCPs.
+ Create KDMs for DCPs.
+ Write cinema-format drives containing DCPs.
@@ -46,7 +46,7 @@ Hello, and welcome to DCP-o-matic!
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.
@@ -72,7 +72,7 @@ This manual presents bits of DCP-o-matic's user interface (such as menu items or
-Notes of an advanced nature are presented like this. Ignore them unless you want to know the gory details.
+Notes of an advanced nature are presented like this. Ignore them unless you want to know the details.
@@ -90,7 +90,7 @@ Notes of an advanced nature are presented like this. Ignore them unless you wan
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.
@@ -98,35 +98,29 @@ 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
+suggest you use 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.
-
-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.
-
-
-Mac OS X
+macOS
-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
+DCP-o-matic will run on macOS version 10.10 (Yosemite) and
+higher. DCP-o-matic is split into seven 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.
-If you are not sure which parts of DCP-o-matic to install, start
+If you don't know which parts of DCP-o-matic to install, start
with the first (main) part.
@@ -134,28 +128,10 @@ with the first (main) part.
-Debian, Ubuntu or Mint Linux
-
-
- You can install DCP-o-matic on:
-
+Debian, Ubuntu and Mint Linux
-
- 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
-
-
-
-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.
+There are .deb packages for Debian, Ubuntu and Mint on
+ https://dcpomatic.com/
@@ -165,8 +141,8 @@ 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
- http://dcpomatic.com/
+ There are .rpm packages for Fedora, Centos and Mageia on
+ https://dcpomatic.com/
@@ -181,73 +157,22 @@ thanks to Stefan Karner.
-
-
-Other Linux distributions
-
-
-Installation on other Linux systems (for which no packages are
-available) is quite hard as it must be compiled from source. If you
-can't download packages for your distribution, do let me know by
-email and I will look
-into providing packages on the website.
-
-
-
-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.
+
+ Building from source
+
+
+ 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/
+
-
+
+
Creating a DCP from a video
@@ -274,8 +199,12 @@ the low-resolution version to save everyone's bandwidth bills.
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 .
@@ -298,7 +227,7 @@ linkend="fig-video-new-film"/>.
Dialogue box for creating a new film
-
+
@@ -306,9 +235,9 @@ 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.
@@ -321,8 +250,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 .
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 or FTP 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 .
@@ -444,7 +371,7 @@ shown in .
Dialogue box for creating a new film
-
+
@@ -469,7 +396,7 @@ linkend="fig-still-select-content-file"/>.
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 Full length setting, as shown in .
@@ -499,29 +426,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 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
+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 +463,7 @@ OV”.
-
+Decrypting encrypted DCPs
@@ -605,8 +532,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.
@@ -717,12 +644,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, .ssa, .ass or .xml
-files.
+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.
@@ -730,6 +659,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
+
+
+
+
@@ -2654,10 +2960,10 @@ The KDM email is shown in .
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. A few
‘magic’ strings will be replaced by information from the
-KDM that is being sent:
+KDM that is being sent; these strings are shown in .
-
+
‘Magic’ KDM strings
@@ -2686,6 +2992,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 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.
+
+
+
+
@@ -2722,7 +3125,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 +3146,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.
@@ -2770,8 +3173,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) will refuse to play.
@@ -2780,10 +3182,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.
@@ -2794,7 +3196,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 +3254,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.
@@ -2940,7 +3342,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
- dcpomatic2_create [OPTION] [CONTENT] [<CONTENT> ...]
+ dcpomatic2_create [OPTION] <CONTENT> [[OPTION] <CONTENT> ...]
@@ -3095,20 +3497,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 +3527,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 +3549,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
-
-
+
@@ -3288,7 +3649,7 @@ sets.
Start a new DCP-o-matic film.
-Click Add folder... and specify your existing DCP's folder.
+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 and
Audio tabs in turn and tick the Use this DCP's audio as OV and make VF checkboxes.
@@ -3306,7 +3667,7 @@ DCP.
Start a new DCP-o-matic film.
-Click Add folder... and specify your existing DCP's folder.
+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
@@ -3322,7 +3683,7 @@ DCP. Adjust the appearance using controls in the
Start a new DCP-o-matic film.
-Click Add folder... and specify your existing DCP's folder.
+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
@@ -3380,7 +3741,7 @@ The full details of OV and VF files are discussed in
- Playing DCPs
+ Playing and verifying DCPsDCP-o-matic includes a DCP player, and although it requires a
very high-speed CPU to play DCPs in full resolution, it can also
@@ -3406,8 +3767,22 @@ The full details of OV and VF files are discussed in
+
+ The player also offers a simple DCP validator. To check a DCP,
+ open it and then select Verify DCP from the
+ Tools menu. This will run some basic checks to see if the DCP meets the required standards.
+
+
+
+
+
+Keyboard shortcuts
+
+
+
+
Configuration files
@@ -3427,3 +3802,24 @@ The full details of OV and VF files are discussed in
+
+
+
+
+
+
+
+
+
+
+