X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=b46e43039e025435ce7a777625396f9752f7d1bd;hp=f56c005d68bcd492acf2445ecedddd543bacdb53;hb=15c633d60c26e7e3280e3977d96ed83efd9fd971;hpb=25043fac5a810cc7d906f1b3d88d0ae90f2a2299 diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index f56c005d6..b46e43039 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 tools to allow you to: - Creation of Digital - Cinema Packages (DCPs) from video, audio and/or - subtitle and closed caption files. - Playback and verification of DCPs on a PC/Mac. - Creation of KDMs for DCPs. + 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 ).
@@ -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,25 +90,14 @@ 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. -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. - - - -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. Be aware, though, that support for Windows XP will -not last forever and you should plan to upgrade if at all possible. +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. @@ -116,42 +105,33 @@ not last forever and you should plan to upgrade if at all possible.
-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 five separate applications, each of +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. -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. + +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. + +
-Debian, Ubuntu or Mint Linux +Debian, Ubuntu and Mint Linux - - You can install DCP-o-matic on: - - - - 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, Ubuntu or Mint 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/
@@ -161,8 +141,8 @@ pieces and set DCP-o-matic up for you.
Fedora, Centos and Mageia Linux - There are .rpm packages for Fedora 27, 28 and 29, Centos 6 and 7 and Mageia 6 on - http://dcpomatic.com/ + There are .rpm packages for Fedora, Centos and Mageia on + https://dcpomatic.com/
@@ -177,99 +157,14 @@ 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 -Boost -libssh -GTK (on Linux) -wxWidgets -libxml++ -xmlsec -curl -libzip -asdcplib with some patches -libdcp -libsub -libcxml -locked_sstream -rtaudio -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 --disable-tests -./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. - -
- -
-‘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. - - +Building from source -All the screenshots in this manual are from a copy of DCP-o-matic in ‘Full’ mode. +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/ -
- @@ -294,15 +189,19 @@ movie Sintel from 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 . @@ -311,7 +210,7 @@ shown in . Creating a new film - + @@ -325,7 +224,7 @@ linkend="fig-video-new-film"/>. Dialogue box for creating a new film - + @@ -333,9 +232,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. @@ -348,8 +247,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 . @@ -471,7 +368,7 @@ shown in . Dialogue box for creating a new film - + @@ -496,7 +393,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 . @@ -542,7 +439,7 @@ modify them in various ways. 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 +can preview it in the normal way, though playback may be slow as decoding of DCPs is almost as computationally intensive as encoding them. @@ -744,12 +641,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. @@ -852,7 +751,7 @@ linkend="sec-prefs-keys"/>).
-Content Properties +Content properties Below the content list are the controls to set content properties. To @@ -871,7 +770,7 @@ held down. Note that not all settings can be changed in this way. The content properties are split up into four sections: Video, Audio, -Subtitles and Timing. Not +Timed text and Timing. Not all of these sections will be active for all content types. The controls in each section are described below. @@ -962,38 +861,6 @@ and DCP-o-matic will pick up the appropriate frames from each.
- -
-Filtering - - -The ‘filters’ settings allow you to apply various video -filters to the image. These may be useful to try to improve -poor-quality sources like DVDs. You can set up the filters by clicking the -Edit button next to the filters entry in the -setup area of the DCP-o-matic window; this opens the filters selector -as shown in . - - -
- Filters selector - - - - - -
- - -After changing the filters setup, you will need to regenerate the DCP -to see the effect on the cinema screen. The preview in DCP-o-matic -will update itself whenever filters are changed, though of course this -image is much smaller and of lower resolution than a projected image! - -
- - -
Colour conversion @@ -1057,7 +924,7 @@ are already in the XYZ colour space and require no conversion. DCP-o-matic's colour conversion processes are discussed in much more detail in a separate document colour.pdf. +url="https://dcpomatic.com/manual/colour.pdf">colour.pdf.
@@ -1097,9 +964,9 @@ ratio that your content should be presented in. At the bottom of the video tab is a short description of what will happen to your video with the current settings. In the example of , DCP-o-matic is telling you that the -video file is 1920x1080 pixels and it has square pixels (a pixel -aspect ratio of 1.00) hence its display aspect ratio is 1.78:1. Since -the controls specify ‘16.9’ for the ratio, DCP-o-matic +video file is 2048x872 pixels and it has square pixels (a pixel +aspect ratio of 1.00) hence its display aspect ratio is 2.35:1. Since +the controls specify ‘2.35’ for the ratio, DCP-o-matic does not scale the image but pads it to the DCP's container ratio of 1.85:1. For a 2K DCP this is 1998x1080 pixels.
@@ -1121,7 +988,7 @@ frame-rate conversion. Audio -The Audio tab controls properties of the image, as shown in . +The Audio tab controls properties of the sound, as shown in .
@@ -1324,7 +1191,7 @@ content, as shown in . Depending on where timed text comes from it can sometimes be used as -either an open subtitle (to be overlaid onto the cinema screen and so +either an open subtitle (to be overlaid onto the cinema screen and seen by everybody) or as a closed caption (to be displayed to individual viewers using a special system such as the Doremi CaptiView™) @@ -1444,7 +1311,7 @@ button, or specify the fonts that should be used by clicking Fonts...< With any subtitles you can click Appearance... to change how the subtitles look. Some of the controls in the -Apperance only apply to burnt-in subtitles, as +Appearance only apply to burnt-in subtitles, as only limited control is available for subtitles rendered by the projection system. @@ -1557,7 +1424,7 @@ any changes to the corresponding timecode.
- The X axis represents time, and you can see the time codes (in + The horizontal 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 @@ -1644,7 +1511,7 @@ linkend="fig-pipeline2"/>. The next step is to scale the image. Since this content should be -presented in a 2.39:1 aspect ratio inside a 1.85:1 DCP we would select +presented in a 2.39:1 (scope) aspect ratio inside a 1.85:1 (flat) DCP we would select Scope from the Scale to option in the Video tab and Flat from the Container @@ -1723,6 +1590,107 @@ open to allow you to choose which settings you want to copy. Clicking +
+Advanced content settings + + +There are a few more content settings that you can change by right-clicking a piece of content in the list and choosing Advanced settings... +This opens the dialogue box shown in . + + +
+ Advanced content dialogue + + + + + +
+ + + +
+Video filters + + +The Video filters setting allows you to apply various +filters to the image. These may be useful to try to improve +poor-quality sources like DVDs. You can set up the filters by clicking the +Edit button next to the filters entry; this opens the filters selector +as shown in . + + +
+ Filters selector + + + + + +
+ +
+ + +
+Override frame rate + + +The Override detected video frame rate setting has some different effects depending on the type of content +you use it on. + + + +For video content, it sets the frame rate that DCP-o-matic will run the video at. This is useful if DCP-o-matic has mis-detected +the video frame rate. For example, if DCP-o-matic says your content is 24fps when you know for a fact it's 25fps, you can set the +override value to 25 to force DCP-o-matic to do the right thing. + + + +On audio, subtitle and caption content this setting behaves slightly differently. It sets the video frame rate that the content +in question was intended to work with. As an example, consider a project with a 23.976fps video source and some separate audio files. +Perhaps those audio files have been mastered alongside a 24fps version of your video. By default, DCP-o-matic will see the 23.976fps +video file and decide to run it slightly fast at 24fps to fit the DCP standard. It will then also run the audio slightly fast so that +it stays in sync with the video. + + + +In this case, though, that is not what you want, since the audio is already ‘fixed’ to work alongside 24fps video. If you +override the video frame rate of the audio content to 24fps this will stop DCP-o-matic altering it. + + + +A similar situation can occur if you have video at one rate and a subtitle file that was prepared with its timing at a different rate. +In that case, you should override the video frame rate of the subtitle content to the one that it was prepared for. +This will mean that DCP-o-matic can get the relative timing right. + + + +Do not use this setting to change the DCP frame rate. Doing so will result in strange effects and sync problems. + +
+ + +
+Video has burnt-in subtitles + +Details about subtitle language are stored in various places within the DCP metadata. If a piece of video content already has subtitles +burnt into the image you can tell DCP-o-matic the language that they are in by clicking the Edit... button. + +
+ + +
+Ignore this content's video + +Tick this if you have some content which includes video along with other things (such as audio or subtitles) and you do +not want the video to appear in the DCP. + +
+ + +
+ @@ -1802,7 +1770,7 @@ key for you. To specify your own key, click the The Reels and Reel length controls specify how the DCP will be split up into -‘reels’. See below. +‘reels’. See . @@ -1868,6 +1836,17 @@ bandwidth can be between 50 and 250 megabits per second (Mbit/s). Most commercial DCPs use bit rates between 75 and 125 Mbit/s. + +Re-encode JPEG2000 data from input governs +whether or not JPEG2000-encoded data from a piece of content (usually +a DCP) will be re-used in the output data as-is or whether it will be +decoded and re-encoded by DCP-o-matic. If the option is enabled +DCP-o-matic will decompress any JPEG2000 data it finds and re-encode +it. This is useful if you want to reduce the bitrate of a DCP. +Usually you will achieve better quality and quicker results by leaving +this option switched off. + + The Audio Channels control sets the number of audio channels that the DCP will have. If the DCP has any channels @@ -1880,7 +1859,7 @@ unused channel will be filled with silence. The Processor control allows you to select a -process to apply to the audio before it goes into the DCP. Three processes are currently provided: +process to apply to the audio before it goes into the DCP. One process is currently provided: @@ -1890,28 +1869,6 @@ stereo input and extract the common part (corresponding to the The remaining L/R parts will be kept in the L/R channels of the DCP. This may be useful to make near-field L/R mixes more compatible with cinema audio systems. -Stereo to 5.1 up-mixer A — this will take a stereo input and up-mix it to ‘fake’ 5.1. The input L/R are treated as follows: - -DCP L is input L bandpass-filtered between 1.9kHz and 4.8kHz. -DCP R is input R bandpass-filtered between 1.9kHz and 4.8kHz. -DCP C is input L mixed with input R, taken down by 3dB and then bandpass-filtered between 150Hz and 1.9kHz. -DCP Lfe is input L mixed with input R, taken down by 3dB and then bandpass-filtered between 20Hz and 150Hz. -DCP Ls is input L bandpass-filtered between 4.8kHz and 20kHz. -DCP Rs is input R bandpass-filtered between 4.8kHz and 20kHz. - - -This upmixing algorithm is due to Gérald Maruccia. - - -Stereo to 5.1 up-mixer B — this uses a different approach: - - DCP L is input L. - DCP R is input R. - DCP C is input L + input R taken down by 3dB. - DCP Lfe is DCP C bandpass filtered between 20Hz and 150Hz. - DCP Ls and Rs are input L - input R with a 20ms delay. - - @@ -1921,13 +1878,13 @@ This upmixing algorithm is due to Gérald Maruccia. A ‘reel’ in a DCP is a subsection of the DCP, in the same way as a 35mm reel is a section of a film. A DCP can be split up into -any number of reels and the joins (the equivalent to 35mm splices) +any number of reels and the joins (the equivalent to 35mm splices or changeovers) between the reels are seamless. There is no reason why you can't just use a single reel for the whole -of your DCP, as there is no limit on their length. Many people choose +of your DCP, as there is no limit to their length. Many people choose to do this. @@ -1941,7 +1898,7 @@ into reels: The picture, sound and subtitle data of the DCP will be split up into more smaller files on disk, rather than fewer larger files. This can be useful if the DCP is to be transferred on storage -that have file size limits. The FAT32 filesystem, for example, can +that has a file size limit. The FAT32 filesystem, for example, can only hold files smaller than 4Gb. A 6Gb DCP with a single reel could not be transferred using a FAT32-formatted disk. If that DCP were split up into two 3Gb reels it could be transferred. @@ -1951,13 +1908,13 @@ It is easier to re-use DCP components if they are in reels. Consider, for example, a film company who wants to put a 5 second ident onto the beginning of DCPs that they distribute. If they receive a feature film DCP they can modify it to add their ident as a separate reel. -This is easier than attaching the picture data in the DCP. +This is easier than attaching the picture data to the feature's existing data. DCP-o-matic offers three options for setting up the reels in your DCP: -single reel, split by video content or custom. +single reel, split by video content or custom. @@ -2077,7 +2034,7 @@ first similarly-typed piece of content in your template. -For example if the template has a piece of video content and some +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. @@ -2143,7 +2100,15 @@ from the timeline is also preserved. 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. + file (by setting the CRF value). + + + + The useful range of CRF values is from 17 (high quality but large file size) to 28 (smaller file size and still reasonable quality). + + + + The time needed to export, and the resulting size, depend partly on the DCP resolution set in the project. To change that, see chapter . @@ -2156,7 +2121,7 @@ from the timeline is also preserved. Encryption -It is not required that DCPs be encrypted, but they can be. This +DCP's do not have to be encrypted, but they can be. This chapter discusses the basic principles of DCP encryption, and how DCP-o-matic can create encrypted DCPs and KDMs for them. @@ -2170,7 +2135,7 @@ DCP-o-matic can create encrypted DCPs and KDMs for them. DCPs can be encrypted. This means that the picture and sound data are encoded in such a way that only cinemas ‘approved’ by the DCP's creators can read them. In particular, this means copies of the -DCP can be distributed by insecure means: if an ne'er-do-well called +DCP can be distributed by insecure means: if a bad person called Mallory obtains a hard drive containing an encrypted DCP, there is no way that he can play it. Only those cinemas who receive a correct key delivery message (KDM) can play the DCP. @@ -2189,7 +2154,7 @@ methods to understand it. We suppose that we are trying to send a DCP to -Alice's cinema without a troublemaker called Mallory being able to +Alice's cinema without a third party called Mallory being able to watch it himself. @@ -2201,7 +2166,7 @@ know the key. -The first step in a DCP encryption is to encode its data with some key +The first step in a DCP encryption is to encode its data with a random key using symmetric-key encryption. The encrypted DCP can then be sent anywhere, safe in the knowledge that even if Mallory got hold of a copy, he could not decrypt it. @@ -2245,7 +2210,7 @@ certificate so that others can make encrypted DCPs for DCP-o-matic. We take our DCP's symmetric key and encrypt it using the public key of Alice's projector. We send the result to Alice over email (using a format called a Key Delivery Message, or KDM). Her projector then -decrypts our message using its private key, yielding the magic +decrypts our message using its private key, giving the symmetric key which can decrypt the DCP. @@ -2345,18 +2310,15 @@ from a file. The certificate should be in SHA256 PEM format. Alternatively, certificates for projection systems made by some manufacturers can be downloaded from databases provided by the -manufacturer. Currently this is supported for Doremi and Dolby -equipment. If you are targeting a screen with equipment by one of -these manufacturers you can click Download then -enter the serial number of the server in the screen and click -Download again and, all being well, the certificate -will be fetched. - - - -Using the download system you will need to know the serial number of -the media server in use in the screen. Most cinema projection or -technical departments will know these serial numbers. +manufacturer. Currently this is supported for Doremi, Dolby, Barco, +Christie and GDC equipment (through downloading Barco, Christie or GDC +certificates requires you to have an appropriate account set up in +DCP-o-matic's preferences). If you are targeting a screen with +equipment by one of these manufacturers you can click +Download then enter the serial number of the +server in the screen and click Download again +and, all being well, the certificate will be fetched. Most cinema +projection or technical departments will know these serial numbers. @@ -2463,7 +2425,7 @@ KDMs. By default the DKDM list will list any DCPs for which you have clicked Make DKDM for -DCP-o-maticin the main DCP-o-matic program. If you have +DCP-o-matic in the main DCP-o-matic program. If you have other DKDMs you can add them by clicking Add... and specifying the file containing the DKDM. @@ -2498,11 +2460,50 @@ 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 +system; possible locations are listed in . +
+ Should I encrypt? + + + The question of whether encryption is appropriate for a given + project is a tricky one. + + + + On the one hand, if you distribute an unencrypted DCP it is easy for + anybody to take it and do whatever they want with its contents. + They could use DCP-o-matic to convert it to a MP4, show it in + their cinema, or even edit and redistribute it in ways that you + do not like. + + + + Encryption prevents this, but brings its own problems. It will be + impossible for a cinema to screen your DCP unless they have the + correct KDM. This is easy enough if things work as they should, + but problems can occur. For example, cinemas may substitute + broken playout servers with new ones without telling you: then the + KDM that you sent them will be invalid, and a new one required. + If the cinema can't get in touch with you, or somebody else who + can create a new KDM, they can't screen your DCP. Often these + problems are only discovered very close to showtime, with little + time for fixes. + + + + If you are distributing encrypted DCPs widely it is worth thinking + about who will make the KDMs, and who will provide quick-response + technical support. It may be a good idea to engage a company who can + provide such services. + + +
+ +
Encryption overview @@ -2532,7 +2533,7 @@ behaviour. They are described in this chapter. Preferences can be edited by choosing Preferences... from the Edit -menu. This opens a dialogue which is split into seven tabs. +menu. This opens a dialogue which is split into eleven tabs. @@ -2566,12 +2567,24 @@ You will need to restart DCP-o-matic to see the new language. The translations for DCP-o-matic have been contributed by helpful users. If your language is not on the last, head to the DCP-o-matic website to -read about how to contribute a translation. +url="https://dcpomatic.com/i18n.php">the DCP-o-matic website to +find out how to contribute a translation.
+ +
+ Interface complexity + + + Choose Simple to see a cut-down, simplified + interface or Full to see DCP-o-matic's full + interface. + +
+ +
Number of threads DCP-o-matic should use @@ -2664,10 +2677,9 @@ If this checkbox is ticked an audio analysis will be run whenever content is add The Check for updates on startup option, if enabled, will tell DCP-o-matic to check on dcpomatic.com to see if there any +url="https://dcpomatic.com/">dcpomatic.com to see if there any newer versions of DCP-o-matic then the one you are running. If so, a dialogue box will open with a link to download the new version. -available @@ -2684,7 +2696,9 @@ like to live on the bleeding edge! With these controls you can set the issuer and creator strings that -will be put into the DCPs which you create. +will be put into the DCPs which you create. The issuer is typically your name +(or your organisation's name) and the creator is typically the name of the tool +used to make the DCP (e.g. DCP-o-matic).
@@ -2772,12 +2786,6 @@ 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 @@ -2811,14 +2819,14 @@ chain using the Add... and If you want DCP-o-matic to re-create the certificate chain (using new, random certificates) click Re-make -certificates... and specify your organisation and common +certificates and key... and specify your organisation and common names in the dialogue box that opens. Underneath the certificate chain is the private key that corresponds to the leaf certificate in the chain. You can specify your own -private key by clicking Load.... You must do +private key by clicking Import.... You must do this if you change the leaf certificate, so that the leaf private key corresponds to the public key held in the leaf certificate. @@ -2830,22 +2838,9 @@ 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 -generate a DKDM for you. You can save this certificate to disk by -clicking Export DCP decryption certificate.... -As with the signing chain, DCP-o-matic will create a certificate chain -and private key for you. You can also choose to load your own -certificates and key or re-make the chain and key with new, random -values. - - -Clicking Export DCP decryption chain... will -export the whole certificate chain, rather than just the leaf -certificate. +Clicking Export chain... will +export the whole certificate chain. @@ -2946,10 +2941,10 @@ The KDM email tab 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 @@ -2978,33 +2973,6 @@ 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 @@ -3065,7 +3033,7 @@ DCP that has been made:
-‘Magic’ Cover sheet strings +‘Magic’ cover sheet strings @@ -3186,8 +3154,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. @@ -3196,10 +3163,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 for -audio. If you are sending DCPs to unknown places it is 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. @@ -3320,7 +3287,7 @@ 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. @@ -3356,7 +3323,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 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. @@ -3681,7 +3648,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 @@ -3697,7 +3664,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 @@ -3783,6 +3750,188 @@ The full details of OV and VF files are discussed in + + + 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 @@ -3802,3 +3951,24 @@ The full details of OV and VF files are discussed in + + + + + + + + + + +