X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=1bd1516b077fd42458885d497c492d16ef610dac;hb=a26b6e9e392a1ac342a19e0d33d92865819c6ded;hp=2a948d3a77ef63a9c4940f7e9160c698abd9f5d7;hpb=52b9a5f3edb119c19ce49c6885a7f3733d11f2e8;p=dcpomatic.git diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 2a948d3a7..1bd1516b0 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -58,6 +58,20 @@ GPL. This manual uses icons from the Tango Desktop Project, with thanks. + + + +
+This manual + + +This manual presents bits of DCP-o-matic's user interface (such as menu items or buttons) like this. + + + +Notes of an advanced nature are presented like this. Ignore them unless you want to know the gory details. + +
@@ -87,6 +101,12 @@ 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. + + @@ -98,11 +118,17 @@ 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. + + @@ -119,8 +145,7 @@ like to install it. Debian unstable (‘sid’) Ubuntu 12.04 (‘Precise Pangolin’) Ubuntu 14.04 (‘Trusty Tahr’) - Ubuntu 15.04 (‘Vivid Vervet’) - Ubuntu 15.10 (‘Wily Werewolf’) + Ubuntu 16.04 (‘Xenial Xerus’) @@ -147,7 +172,7 @@ pieces and set DCP-o-matic up for you.
Centos Linux - There are .rpm packages for Centos 6.5 and 7 on + There are .rpm packages for Centos 5, 6.5 and 7 on http://dcpomatic.com/
@@ -171,10 +196,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. @@ -233,10 +258,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. @@ -248,7 +273,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. @@ -404,8 +429,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 . @@ -416,7 +441,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 @@ -425,7 +450,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 . @@ -457,10 +482,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 . @@ -482,7 +507,7 @@ 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. @@ -495,7 +520,7 @@ to encode a single frame which it can then repeat. Frequently DCP-o-matic is used to take content in formats such as MP4 -and convert it to JPEG2000 for a DCP. Alternatively, it can be used +and convert it to JPEG2000 for a DCP. It can also be used to take existing DCPs and modify them in various ways. @@ -511,6 +536,19 @@ playback will be very slow as decoding of DCPs is almost as 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: + + + +Use Add folder... 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. +Choose the folder that contains the OV DCP. The VF will now be playable as normal. + + @@ -570,8 +608,8 @@ JPEG2000 encoding is not necessary. -DCP-o-matic can do this if you avoid changes to the following content -settings: +DCP-o-matic can do this if you avoid changes to +the following content settings: @@ -590,7 +628,7 @@ DCP-o-matic will decode and then re-encode the JPEG2000 data. -
+
Making overlay files @@ -644,7 +682,7 @@ To make a DCP like this: 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. +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. @@ -697,7 +735,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, .ass or .xml files. DCP — an existing DCP. @@ -795,12 +833,25 @@ The Video tab controls properties of the image, as shown in + +
+Refer to existing DCP + + +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 . + + +
+
Image type -The first option on this tab is the ‘type’ of the video. +The next option on this tab is the ‘type’ of the video. This specifies how DCP-o-matic should interpret the video's image. 2D is the default; this just takes the video image as a standard 2D frame. The 3D @@ -1018,7 +1069,6 @@ The Audio tab controls properties of the image, as shown in -
The audio map @@ -1123,7 +1173,20 @@ shows the mapping of a 5.1 source into a 5.1 DCP.
-Other controls + 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 . + + + +Show graphs of audio levels will analyse the +audio of the selected content and plot it on a graph. See for more details. + ‘Audio Gain’ is used to alter the volume of the @@ -1195,13 +1258,32 @@ 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 .
@@ -1231,25 +1313,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. @@ -1273,11 +1347,27 @@ frame) than those typically used for DCP, so it is often useful to scale such subtitles down using these controls. + +The Line spacing control adjusts the line spacing +of the subtitles. This only works for non-embedded (text) subtitles. + + 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. + +
@@ -1330,11 +1420,17 @@ should be displayed using this control. -Trim from start specifies the amount that should be trimmed from the start of the content. +Trim from start specifies the amount that should +be trimmed from the start of the content. You can set this amount to +trim up to the current preview position by clicking Trim up +to current position. -Trim from end specifies the amount that should be trimmed from the end of the content. +Trim from end specifies the amount that should be +trimmed from the end of the content. You can set this amount to trim +after the current preview position by clicking Trim after to +current position. @@ -1567,6 +1663,11 @@ 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. @@ -1631,7 +1732,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: @@ -1744,7 +1845,7 @@ you must specify a reel length in Gb. Then no file in the DCP will be larger th -
+
Show audio @@ -1910,10 +2011,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. @@ -1924,10 +2025,10 @@ is). -The second part 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 are now -described in turn. +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.
@@ -1944,7 +2045,7 @@ linkend="fig-kdm"/>. KDM dialog - + @@ -1957,11 +2058,11 @@ 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 (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. +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. @@ -2015,13 +2116,28 @@ You must also select the type of KDM that you want to generate. If in doubt, use Modified Transitional 1. + +The differences between the three KDM types are fairly subtle. +DCI Specific and DCI Any add +a <ContentAuthenticator> tag to the KDM which +allows the exhibitor to check that the DCP and KDM have come from a +bona-fide source. In addition, DCI Specific adds +information on trusted devices to the KDM. This allows the KDM +creator to specify devices (such as sound processors) that are allowed +to use keys delivered by the KDM. At present it is not clear how +widely the DCI Specific and DCI +Any features are supported (or even tolerated) by servers +so you are advised to use Modified Transitional +1. + + Finally, choose what you want to do with the KDMs. They can be written to disk, to a location that you can specify by clicking Browse. Alternatively, if you choose Send by email the KDMs will be zipped up and -emailed to the appropriate cinema email addresses. Click OK to -generate the KDMs. +emailed to the appropriate cinema email addresses. Click +Make KDMs to generate the KDMs.
@@ -2035,7 +2151,7 @@ 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 -begin targeted at a projection system (to allow it to decrypt the +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. @@ -2059,10 +2175,59 @@ 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 choose where it should be written, then click -OK. +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 + + + + + +
+
@@ -2139,6 +2304,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 @@ -2283,13 +2472,19 @@ 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 +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. + +
@@ -2432,6 +2627,14 @@ JPEG2000 data only on encoding servers and not on the host. We suggest you leave this un-ticked unless you have a good reason to do otherwise. + +With the filename format fields you can adjust the filenames that are +used for metadata (CPL and PKL files) and assets (MXF and subtitle +files). Below each field there is a list of the ‘magic’ +values that you can use in the format and an example of a filename +that you might see with your current settings. + + The four checkboxes labelled Log control what sort of messages DCP-o-matic writes to its log file when creating a @@ -2733,7 +2936,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.