X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=18b2eafa3776d9f388baa6b183ce5b6d270c8c02;hb=03dba08f2f8be761b644e7837f64764faef1e5ab;hp=3711654666a4ca14769e008984acd9d3e16cfaa4;hpb=755a163576da6a8aab1bc5c4b96ca2c216f88fab;p=dcpomatic.git
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 371165466..18b2eafa3 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 programs to perform the following tasks:
+
+
+ Creation of Digital
+ Cinema Packages (DCPs) from video, audio and/or
+ subtitle files.
+ Playback of DCPs on a PC.
+ Creation of KDMs for DCPs.
+
@@ -116,24 +119,22 @@ Windows version.
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-matics icon to your
-Applications folder or wherever else you would
-like to install it.
+higher. DCP-o-matic is split into four 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.
-You do not have to install all the applications, but you must always
-install DCP-o-matic 2.app as the other applications
-depend on it.
+If you are not sure which parts of DCP-o-matic to install, start
+with the first (main) part.
-Debian or Ubuntu Linux
+Debian, Ubuntu or Mint Linux
You can install DCP-o-matic on:
@@ -143,9 +144,11 @@ depend on it.
Debian 7 (‘wheezy’)
Debian 8 (‘jessie’)
Debian unstable (‘sid’)
- Ubuntu 12.04 (‘Precise Pangolin’)
Ubuntu 14.04 (‘Trusty Tahr’)
Ubuntu 16.04 (‘Xenial Xerus’)
+ Ubuntu 17.10 (‘Artful Aardvark’)
+ Mint 17
+ Mint 18
@@ -160,25 +163,14 @@ pieces and set DCP-o-matic up for you.
- Fedora Linux
-
- There are .rpm packages for Fedora 22 and 23 on
- http://dcpomatic.com/
-
-
-
-
+ Fedora, Centos and Mageia Linux
-
-
- Centos Linux
- There are .rpm packages for Centos 5, 6.5 and 7 on
+ There are .rpm packages for Fedora 25, 26 and 27, Centos 6 and 7 and Mageia 6 on
http://dcpomatic.com/
-
Arch Linux
@@ -272,7 +264,7 @@ 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
+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.
@@ -378,15 +370,7 @@ the right of the window, 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.
@@ -529,7 +513,7 @@ to take existing DCPs and modify them in various ways.
If you want to do something to an existing DCP the first step is to
-import it. Click Add folder... and select your
+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
@@ -537,12 +521,12 @@ computationally intensive as encoding them.
-If your DCP is a Version File (VF), in other words it refers to
-another DCP's assets, you should import it as follows:
+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 folder... to import the VF DCP.
+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.
@@ -580,8 +564,8 @@ and they can create a KDM to allow DCP-o-matic to decrypt their 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.
+choose Add KDM.... Specify your KDM and the DCP
+will be decrypted and become available for preview.
@@ -680,9 +664,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.
@@ -747,11 +731,15 @@ 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.
+To add a directory (folder) of images, choose Add
+folder... and choose the directory from the selector.
+DCP-o-matic will open a small dialogue box where you can enter the
+frame rate that the image sequence should be run at.
+
+
+
+To add a DCP, choose Add DCP... and choose the
+DCP's directory from the selector.
@@ -835,12 +823,12 @@ The Video tab controls properties of the image, as shown in
-Refer to existing DCP
+Use this DCP's video as OV and make VF
This option is only applicable if the selected content is an existing
-DCP. It allows you to get the video content from the existing DCP by
-referencing it (rather than copying). See .
@@ -1176,10 +1164,11 @@ shows the mapping of a 5.1 source into a 5.1 DCP.
Other controls
-The Refer to existing DCP checkbox isonly
-applicable if the selected content is an existing DCP. It allows you
-to get the audio content from the existing DCP by referencing it
-(rather than copying). See .
+The Use this DCP's audio as OV and make VF
+checkbox is only applicable if the selected content is an existing
+DCP. It allows you to make a VF DCP, using the audio content from the
+existing DCP by referencing it (rather than copying). See .
@@ -1264,7 +1253,7 @@ DCP-o-matic can either:
Extract subtitles that are embedded in video files, or
Use subtitles from SubRip (.srt), SubStation
- Alpha (.ssa) or DCP XML files. You may find the great
+ Alpha (.ssa or .ass) or DCP XML files. You may find the great
free program Subtitle Edit useful
for creating such files.
@@ -1577,8 +1566,27 @@ linkend="fig-pipeline3"/>.
+
+
+ Copy and paste settings
+
+
+Once you have set up a piece of content it is possible to copy the
+settings you have applied to another piece of content. To do this,
+select the content to copy from and choose Copy
+from the Edit menu. Then select the content to
+copy to and choose Paste. A dialogue box will
+open to allow you to choose which settings you want to copy. Clicking
+OK will apply the copied settings.
+
+
+
+
+
+
+
DCP settings
@@ -1896,6 +1904,77 @@ auditorium, but it can be useful to get levels in the right rough area.
+
+
+
+Templates
+
+
+If you frequently make DCPs with similar settings you may find it
+useful to use templates.
+
+
+
+Say, for example, you often make 4K feature DCPs from video files in
+’scope at 25fps. You can speed up this process by following
+these steps:
+
+
+
+ Create a film with any content and set it up how you like;
+ in our example, set the content to scale to DCP, the DCP resolution
+ to 4K, and so on.
+ Choose Save as template... from the File menu.
+ Enter a name for your template.
+
+
+
+Then in the future you can create a new film, tick the
+Template box and choose your previously-saved
+template. The basic film's settings will come from your template, and
+when you add some content it will take on the settings of the
+first similarly-typed piece of content in your template.
+
+
+
+For example if the template has a piece of video content and some
+subtitles, any video that you add to the new film will take on the
+settings of the video in the template. Similarly, any subtitles that
+you add will take on the settings of the subtitles from the template.
+
+
+
+The following settings from the DCP tab are saved
+in templates:
+
+
+
+ “Use ISDCF name” checkbox
+ Content type (FTR, TLR etc.)
+ Container
+ Resolution
+ JPEG200 bandwidth
+ Video frame rate
+ Signed and encrypted checkboxes
+ Audio channels
+ Standard (Interop / SMPTE)
+ Audio processor
+ Reel type and length
+ Upload after make DCP checkbox
+
+
+
+In addition to this, the settings (but not the filenames) of any
+content in the template are stored, as discussed above. The status of
+the Keep video and subtitles in sequence checkbox
+from the timeline is also preserved.
+
+
+
+
+
+
+
Encryption
@@ -2216,6 +2295,30 @@ tab.
+
+Encryption keys
+
+
+ You must be careful when using encryption not to lose important keys.
+
+
+
+If you are making KDMs from a DCP-o-matic film you
+must ensure that you have a backup of the
+metadata.xml file from the project, as well as the DCP
+itself.
+
+
+
+If you are using a DKDM you must ensure that you
+have a backup of DCP-o-matic's config.xml file, since it
+contains the only key which can decrypt the DKDM. The
+config.xml file location depends on your operating
+system; possible locations are listed in
+
+
+
+
Encryption overview
@@ -2773,6 +2876,7 @@ purposes.
+
Encoding servers
@@ -2938,6 +3042,160 @@ 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.
+
+
+
+ <code>dcpomatic2_create</code>
+
+
+ The syntax for dcpomatic2_create is:
+
+
+
+ dcpomatic2_create [OPTION] [CONTENT] [<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:
+
+
+
+ -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:
+
+
+
+ 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.
+
+
+
+
+ <code>dcpomatic2_cli</code>
+
+
+ The syntax for dcpomatic2_cli is:
+
+
+
+ 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:
+
+
+
+ dcpomatic2_cli my_film
+
+
+
+
+ <code>dcpomatic2_kdm_cli</code>
+
+
+ The syntax for dcpomatic2_kdm_cli is:
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
Loose ends
@@ -2972,4 +3230,200 @@ 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 folder... 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.
+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 folder... 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
+Subtitle tab 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 folder... 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
+Subtitle tab 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.
+
+
+
+
+
+
+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:
+
+
+
+
+