X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=19551d0086442483c35ad36d15bd4f8081190556;hp=557538b69aa73622042447a368f471558864083f;hb=91adae31531b3ac8d1129cc3b2df577a39a892ee;hpb=675f55d01854467f42bc44be08f6a083ea73e534 diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 557538b69..19551d008 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -96,12 +96,8 @@ 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 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. +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. @@ -112,43 +108,30 @@ version. macOS -DCP-o-matic will run on macOS version 10.6 (Snow Leopard) and -higher. DCP-o-matic is split into seven separate applications, each of +DCP-o-matic versions 2.16.0 and higher will run on macOS version 10.10 (Yosemite) 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. -Make sure you choose the correct download, depending on whether you are running macOS 10.9 (Mavericks) (or higher) or something older. +If you don't know which parts of DCP-o-matic to install, start +with the first (main) part. -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.9 (Mavericks) or older you will need to install the latest 2.14.x version of DCP-o-matic.
-Debian, Ubuntu or Mint Linux - - - You can install DCP-o-matic on: - - - - Debian 9 (‘squeeze’), 10 (‘buster’) and unstable (‘sid’) - Ubuntu 16.04 (‘Xenial Xerus’), 18.04 (‘Bionic Beaver’), 19.10 (‘Eoan Ermine’) and 20.04 (‘Focal Fossa’) - Mint 18 and 19 - +Debian, Ubuntu and Mint Linux - -using .deb packages: download the appropriate package -from https://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/
@@ -158,7 +141,7 @@ pieces and set DCP-o-matic up for you.
Fedora, Centos and Mageia Linux - There are .rpm packages for Fedora 30, 31 and 32, Centos 7 and 8 and Mageia 7 on + There are .rpm packages for Fedora, Centos and Mageia on https://dcpomatic.com/
@@ -174,72 +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. - - +Building from source -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 https://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. +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/
- @@ -264,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 . @@ -303,7 +232,7 @@ 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 existing folder DCP into which it will write its working files. @@ -403,17 +332,15 @@ linkend="fig-making-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, 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 the in . +across your network. See . @@ -495,6 +422,21 @@ to encode a single frame which it can then repeat. + + +Writing DCP drives + + +Once a DCP has been created it must often be transferred to a cinema for playback. The most reliable way to do this is to write a specially-formatted drive (in the ext2 format) containing your DCP. + + + +Writing ext2-formatted drives is difficult from macOS and Windows without custom software. DCP-o-matic includes a tool called the ‘DCP-o-matic Disk Writer’ which makes it easy. + + + + + Manipulating existing DCPs @@ -512,7 +454,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. @@ -714,12 +656,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. @@ -822,7 +766,7 @@ linkend="sec-prefs-keys"/>).
-Content Properties +Content properties Below the content list are the controls to set content properties. To @@ -932,38 +876,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 may be smaller and of lower resolution than a projected image! - -
- - -
Colour conversion @@ -1693,6 +1605,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. + +
+ + +
+ @@ -1861,7 +1874,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: @@ -1871,31 +1884,7 @@ 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. - - - -The up-mixers are not particularly advanced and should be used with care. You are strongly advised to check how the DCPs sound in a cinema if you have used one of DCP-o-matic's upmixers.
@@ -2126,7 +2115,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 . @@ -2172,7 +2169,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. @@ -2228,7 +2225,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. @@ -3740,7 +3737,7 @@ The full details of OV and VF files are discussed in - Playing and verifying DCPs + 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 @@ -3766,14 +3763,57 @@ The full details of OV and VF files are discussed in + + + + + Verifying DCPs + - The player also offers a simple DCP validator. To check a DCP, + The player also offers a DCP verifier. 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. + 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 + +
+ + + + +Keyboard shortcuts + + + + Configuration files