X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=aa31b47cdeb0276fb3045601ef2979ea52be2107;hb=47e78514ffa98c991ddd38d077836f4a558fbec0;hp=3df603a85d55e83261011e911b730732eebaa094;hpb=b0297f77b23099a52d37becfa45930ee730bda4b;p=dcpomatic.git diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 3df603a85..aa31b47cd 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -10,11 +10,6 @@ ]> - - DCP-o-matic users' manual CarlHetherington @@ -34,8 +29,8 @@ Hello, and welcome to DCP-o-matic! DCP-o-matic is a program to generate Digital -Cinema Packages (DCPs) from DVDs, Blu-Rays, video files such as MP4 -and AVI, or still images. The resulting DCPs will play on modern digital +Cinema Packages (DCPs) from almost any video, audio and/or +subtitle source files. The resulting DCPs will play on modern digital cinema projectors. @@ -103,47 +98,66 @@ 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-matic icon to your +click to open it. Then drag the DCP-o-matics icon to your Applications folder or wherever else you would like to install it. + +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. + + +
-Ubuntu Linux +Debian or Ubuntu Linux -You can install DCP-o-matic on Ubuntu 12.04 (‘Precise -Pangolin’), 14.04 (‘Trusty Tahr’) or 15.04 -(‘Vivid Vervet’) using .deb packages: -download the appropriate package from http://dcpomatic.com/ and -double-click it. Ubuntu will install the necessary bits and pieces -and set DCP-o-matic up for you. + You can install DCP-o-matic on: + + Debian 7 (‘wheezy’) + Debian 8 (‘jessie’) + Debian unstable (‘sid’) + Ubuntu 12.04 (‘Precise Pangolin’) + Ubuntu 14.04 (‘Trusty Tahr’) + Ubuntu 15.10 (‘Wily Werewolf’) + Ubuntu 16.04 (‘Xenial Xerus’) + + + +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. +
+
-Debian Linux - -Packages are available for Debian 7 (squeeze), 8 (jessie) and unstable (sid) from http://dcpomatic.com/. - + Fedora Linux + + There are .rpm packages for Fedora 22 and 23 on + http://dcpomatic.com/ +
+
-Centos Linux - -Packages are available for Centos 6.5 and 7 from http://dcpomatic.com/. - + Centos Linux + There are .rpm packages for Centos 5, 6.5 and 7 on + http://dcpomatic.com/ +
+ @@ -163,10 +177,10 @@ thanks to Stefan Karner. Installation on other Linux systems (for which no packages are -available) is quite hard; you will have to compile it from source. If -you are using distribution for which no packages are available, do let -me know by email and I -will look into providing packages on the website. +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. @@ -174,6 +188,7 @@ The following dependencies are required: FFmpeg libsndfile +libsamplerate OpenSSL libopenjpeg ImageMagick @@ -185,8 +200,10 @@ The following dependencies are required: xmlsec curl libzip -libdcp -libcxml +libdcp +libsub +libcxml +libicu @@ -222,10 +239,10 @@ in a shell. -Creating a video DCP +Creating a DCP from a video -In this chapter we will see how to create a video DCP using +In this chapter we will see how to create a DCP from a video file using DCP-o-matic. We will gloss over the details and look at the basics. @@ -237,7 +254,7 @@ Let's make a very simple DCP to see how DCP-o-matic works. First, we need some content. Download the low-resolution trailer for the open movie Sintel from their -website. Generally, of course, one would want to use the +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. @@ -393,8 +410,8 @@ linkend="ch-files"/> for details about the files that DCP-o-matic creates. -Alternatively, if you have a projector or Theatre Management System -(TMS) that is accessible via SCP across your network, you can upload +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 . @@ -405,7 +422,7 @@ linkend="sec-prefs-tms" endterm="sec-prefs-tms-short"/> in -Creating a still-image DCP +Creating a DCP from a still image DCP-o-matic can also be used to create DCPs of one or more still images, perhaps @@ -414,7 +431,7 @@ how to do it. -As with video DCPs, the first step is to create a new +As with DCPs made from video files, the first step is to create a new ‘Film’; select New from the File menu and the new film dialogue will open as shown in . @@ -446,10 +463,10 @@ linkend="fig-still-select-content-file"/>. -As with video DCPs, most of the default settings will be fine for a -simple test. The one thing that you might wish to change is the -length of the still. Select the Timing tab and -you will see a Play length setting, as shown in Timing tab and you will see a +Play length setting, as shown in . @@ -471,13 +488,182 @@ fourth frames. Enter the duration that you want and then click Set Finally, as with video, you can choose Make DCP from the Jobs menu to create your DCP. This will -be much quicker than creating a video DCP, as DCP-o-matic only needs +be much quicker than creating a DCP from a video file, as DCP-o-matic only needs to encode a single frame which it can then repeat. + + +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. + + +
+Importing a DCP into DCP-o-matic + + +If you want to do something to an existing DCP the first step is to +import it. Click Add folder... and select your +DCP's folder. It will be added to the DCP-o-matic project. If the +DCP is unencrypted you can preview it in the normal way, though +playback will be very slow as decoding of DCPs is almost as +computationally intensive as encoding them. + + +
+ + +
+Decrypting encrypted DCPs + + +DCPs can be encrypted (see for +details). If you import an encrypted DCP you will need a key, in the +form of a Key Delivery Message (KDM), to decrypt it. + + + +KDMs must be prepared by the organisation which created the DCP. They +contain the keys to decrypt the DCP wrapped up in such a way that only +the intended recipient can read them. You will need to provide the +organisation with a certificate which identifies your copy of +DCP-o-matic and allows them to create a KDM for you. + + + +To get DCP-o-matic's decryption certificate, open the Preferences +dialogue (see ) and go to the +Keys tab. Click the Export DCP +decryption certificate... button at the bottom of this tab +and save the certificate. Send this certificate to the DCP creators +and they can create a KDM to allow DCP-o-matic to decrypt their DCP. + + + +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. + + +
+ + +
+Making a DCP from a DCP + + +In many ways, using DCPs as content in +DCP-o-matic is the same as using any other content. There are a few +things to note, though. + + + +
+Re-use of existing data + + +Where possible DCP-o-matic will re-use existing JPEG2000-compressed +data from DCP content without modification. This has the advantage +that creation of the new DCP will be quick, as the time-consuming +JPEG2000 encoding is not necessary. + + + +DCP-o-matic can do this if you avoid changes to +the following content settings: + + + +Crop +Scaling +Subtitle burn-in +Fades +Colour conversion + + + +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. + + +
+ + +
+Making overlay files + + +With its default settings, DCP-o-matic will take any data from DCP +content and copy it into the DCP that it creates. See . + + +
+Creating a new DCP by copying an existing one + +
+ + +This can be inefficient in some cases. Consider, for example, a film +which has ten different translations for which the subtitles are +different but video and audio are the same. If the video and audio +content takes up, say, 100Gb this means that the set of DCPs for every +translation would be about 1Tb with a lot of duplicated data. + + + +The DCP format has a solution to this problem. One DCP can refer to +the ‘assets’ (picture, sound or subtitle) of another DCP. +For our translation example this means that we could have a +‘base’ DCP (often called the OV or Original Version) +containing video, audio and one set of subtitles and then any number +of overlay DCPs (often called VF or Version Files) which refer to the +base version and replace the original subtitles with their own. shows this principle for one of our +translations. The DCP that we make refers to the original content +DCP's video and audio rather than containing a copy. + + +
+Creating a new DCP by referring to an existing one + +
+ + +To play back the subtitled DCP the projectionist ingests both the base +(OV) DCP and the overlay (VF) DCP, then plays the VF one. + + + +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 +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. +Do Make DCP as usual and your VF DCP will be created. + + +
+ +
+ + + + + + + Content settings @@ -485,8 +671,8 @@ to encode a single frame which it can then repeat. The previous chapters showed DCP generation using the default settings. DCP-o-matic offers a range of features to adjust the -content that goes into your DCP, and this chapter describes those features in -detail. +content that goes into your DCP, and this chapter describes those +features in detail.
@@ -517,7 +703,7 @@ images which should be treated as the frames of a video. Subtitle — a file containing subtitle which will be superimposed on the image of the DCP. These can be -.srt or .xml +.srt, .ssa or .xml files. DCP — an existing DCP. @@ -1015,20 +1201,39 @@ content, as shown in . -DCP-o-matic will extract subtitles from the content, if present, and -they can be ‘burnt into’ the DCP (that is, they are -included in the image and not overlaid by the projector) or included -as a separate subtitle ‘asset’ within your DCP (in which -case the projector overlays them onto the image on playback). The -difference between these two arrangements is illustrated by and +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 + free program Subtitle Edit useful + for creating such files. + + + +Embedded subtitles are usually represented using a set of bitmaps, +especially on files that have come from DVD or BluRay. Such subtitles +can (currently) only be ‘burnt’ into the DCP (that is, +they are included in the image and not overlaid by the projector). + + + +With SubRip, SubStation Alpha or DCP subtitles you have the choice to +either burn-in or include the subtitles as separate subtitle +‘asset’ within your DCP (in which case the projector +overlays them onto the image on playback). The difference between +burn-in and overlay is illustrated by +and .
Burnt-in subtitles - +
@@ -1037,7 +1242,7 @@ linkend="fig-burn-in"/> and Separate subtitles - + @@ -1051,25 +1256,17 @@ encoding need only be done once for the project rather than once for every language. - -Note that subtitles come in two types: text and bitmap. Text -subtitles are expressed as plain text and can be either burnt into the -image or included as a separate subtitle asset within the DCP. Bitmap -subtitles, on the other hand, are expressed as pre-rendered bitmaps. -They cannot (yet) be added to the DCP as a separate asset and must be -burnt into the image. - - Select the Use Subtitles check-box to enable -these subtitles. +the subtitles in the selected content. Select the Burn subtitles into image check-box to burn these subtitles into the image; if this is not ticked the subtitles will be included separately in the DCP to be rendered by the -projector. +projector. This check-box will always be ticked if you are using +embedded ‘image’ subtitles. @@ -1098,6 +1295,17 @@ The Stream control changes the subtitle stream that is used when the content has more than one. + +If you are using non-embedded (text) subtitles you can see the +subtitle text and timings by clicking the View... +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. + +
@@ -1129,7 +1337,7 @@ linkend="fig-timecode"/>. Timecode - + @@ -1375,12 +1583,23 @@ key for you. To specify your own key, click the Edit.. button next to the key. + +The Reels and Reel length +controls specify how the DCP will be split up into +‘reels’. See below. + + The Standard option specifies which of the two DCP standards DCP-o-matic should use. If in doubt, use SMPTE (the more modern of the two). + +Ticking the Upload DCP to TMS after it is made +will ask DCP-o-matic to copy the finished DCP to your configured TMS (see ). + + At the bottom of the DCP tab are a further two tabs, one each to contain the settings for the DCP's video and audio parts. @@ -1445,7 +1664,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. Two processes are currently provided: +process to apply to the audio before it goes into the DCP. Three processes are currently provided: @@ -1464,13 +1683,98 @@ cinema audio systems. 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. + + + + +
+Reels -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) +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 +to do this. + + + +There are, however, some possible advantages of splitting things up +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 +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. + + +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. + + + + +DCP-o-matic offers three options for setting up the reels in your DCP: +single reel, split by video content or custom. + + + +Single reel, as its name suggests, keeps the whole DCP as one reel. +This is a perfectly good option if you have no particular reason to +need reels. + + + +Split by video content puts each piece of source +video content in its own reel, as shown in . + + +
+Making reels using split by video content + +
+ + +Here we have three video files (ident.mp4, +feature.ts and cred.mov). With +split by video content DCP-o-matic makes a new +reel to hold each video file. + + + +Custom splits reels by the size of the files that +will make up their video content. With Custom +you must specify a reel length in Gb. Then no file in the DCP will be larger than this reel length. + + +
+
@@ -1639,10 +1943,10 @@ those cinemas that are allowed to play the DCP. The first part is simple: ticking the Encrypted -box in the DCP tab of DCP-o-matic will encrypt -the DCP using a random key that DCP-o-matic generates. The key will -be written to the film's metadata file, which should be kept -secure. +box in the DCP tab will instruct DCP-o-matic to +encrypt the DCP that it makes using a random key that DCP-o-matic +generates. The key will be written to the film's metadata file, which +should be kept secure. @@ -1653,10 +1957,20 @@ is). -The second part is to generate KDMs for the cinemas that you wish to -allow to play your DCP. This is done using the Make -KDMs option on the Jobs menu. This -will open the KDM dialogue box, as shown in . +The second part of distributions is to generate KDMs for the cinemas +that you wish to allow to play your DCP. There are two approaches to +this within DCP-o-matic: using the project, or using a DKDM. These +approaches are now described in turn. + + +
+Creating KDMs from a DCP-o-matic project + + +You can create KDMs from inside a DCP-o-matic project using the +Make KDMs option on the Jobs +menu. This will open the KDM dialogue box, as shown in .
@@ -1676,17 +1990,18 @@ available by the projector manufacturers as text files with a -DCP-o-matic can store these certificates to make life easier. It -stores details of cinemas and screens within those cinemas. Each -screen has a certificate for its projector. DCP-o-matic can generate -KDMs for any screens that it knows about. +DCP-o-matic can store these certificates along with details of their +cinemas and screens within those cinemas. Each screen has a +certificate for its projector (and optionally certificates for other +trusted devices, such as the sound processor). DCP-o-matic can +generate KDMs for any screens that it knows about. To add a cinema, click Add Cinema.... This opens a dialogue box into which you can enter the cinema's name, and optionally an email address. This email address can be used to -get DCP-o-matic to deliver KDMs via email, but it is optional. +get DCP-o-matic to deliver KDMs via email. @@ -1701,11 +2016,10 @@ 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 select Doremi or Dolby from the -Server manufacturer selection and then click -Download. In the next dialogue box, enter -details of the screen and click Download and, all -being well, the certificate will be fetched. +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. @@ -1745,6 +2059,93 @@ generate the KDMs.
+
+Creating KDMs using a DKDM +
+ + +It can be inconvenient to need a whole DCP-o-matic project just to +create KDMs for its film. Perhaps you want to archive the project to +save space, or create KDMs on a different machine. In such situations +it is easier to use a DKDM. This is a normal KDM, but instead of +being targeted at a projection system (to allow it to decrypt the +content) it is targeted at a particular users's certificate. This +means that the certificate owner can create new KDMs for other users. +The DKDM holds everything that is required to create further KDMs. + + + +Sometimes it is useful to create DKDMs that can be used by +DCP-o-matic. If you create such a DKDM you can keep it and then, at +any point in the future, use DCP-o-matic's standalone KDM creator to +make KDMs for the DKDM's film for any cinema. + + + +In other cases a DKDM is sent to a 3rd party so that they can create +KDMs for your films. This can be useful if, for example, you have a +distributor who provides 24-hour KDM support to cinemas and can create +KDMs for anybody that requires them at short notice. + + + +To create a DKDM for DCP-o-matic, open your encrypted project and +select Make DKDM for DCP-o-matic... from the +Jobs menu. Select the CPL that you want to make +the DKDM for and click OK. This DKDM will then +be available in the KDM creator. This is a separate program which you +can start from the same place that you start the ‘Normal’ +DCP-o-matic. Its window is shown in . + + +
+ The KDM creator + + + + + +
+ + +To create KDMs, select the cinema(s) and/or screens that you want KDMs +to be created for, the date range, the DCP that the KDMs are for and +the destination for the KDMs and click Create +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 +other DKDMs you can add them by clicking Add... and +specifying the file containing the DKDM. + + + +If another organisation wants to send you a DKDM they will ask you for +a target certificate. You can get DCP-o-matic's target certificate by +opening Preferences and clicking Export +DCP decryption certificate... in the Keys +tab. + + + +
+ +
+Encryption overview + +
+ Overview of encryption + + + + + +
+ +
 @@ -1820,6 +2221,30 @@ to set this up correctly when you run it for the first time. + +
+Cinema and screen database file + + +This option allows you to change the file that DCP-o-matic uses to +store details of the cinemas and screens used to make KDMs. + + +
+ +
+Integrated loudness + + +If Find integrated loudness, true peak and loudness range +when analysing audio is ticked, DCP-o-matic will do extra +work when analysing audio. Leave this ticked if the extra parameters +are useful to you. If not, untick it and audio analysis will be +faster. + + +
+
Updates @@ -1964,7 +2389,7 @@ 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 +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 @@ -2377,7 +2802,7 @@ after you have created a DCP for a film called ‘DCP Test’. Creating a new film - + @@ -2414,7 +2839,8 @@ operation is interrupted and DCP-o-matic must resume it. Following this is the DCP itself: DCP-TEST_EN-XX_UK-U_51_2K_CSY_20130218_CSY_OV. This contains some small XML files, which describe the DCP, and two large -MXF files, which contain the DCP's audio and video data. This folder +MXF files, which contain the DCP's audio and video data. It may also +contain subtitles in either XML or MXF format. This folder (DCP-TEST_EN-XX_...) is what you should ingest, or pass to the cinema which is showing your DCP.