X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=a790d10cf13f36c633ad51ab97e85891c1aa86ac;hb=caf1d26c4df515e1fd0f9b2758cd3a589079ff4b;hp=1a71bb6d1680050a852ace7811f48c9306d4680a;hpb=35636d18928f801c1de3c8d1969e349a11d5463d;p=dcpomatic.git diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 1a71bb6d1..a790d10cf 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. + + @@ -125,7 +145,7 @@ depend on it. Debian unstable (‘sid’) Ubuntu 12.04 (‘Precise Pangolin’) Ubuntu 14.04 (‘Trusty Tahr’) - Ubuntu 15.10 (‘Wily Werewolf’) + Ubuntu 16.04 (‘Xenial Xerus’) @@ -152,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/
@@ -516,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. + + @@ -595,7 +628,7 @@ DCP-o-matic will decode and then re-encode the JPEG2000 data. -
+
Making overlay files @@ -702,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, .ssa or .xml +.srt, .ssa, .ass or .xml files. DCP — an existing DCP. @@ -800,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 @@ -1023,7 +1069,6 @@ The Audio tab controls properties of the image, as shown in -
The audio map @@ -1128,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 @@ -1289,6 +1347,11 @@ 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. @@ -1357,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. @@ -1776,7 +1845,7 @@ you must specify a reel length in Gb. Then no file in the DCP will be larger th -
+
Show audio @@ -1827,6 +1896,43 @@ auditorium, but it can be useful to get levels in the right rough area. + + + +Templates + + +If you frequently make DCPs with similar settings you may find it +useful to use templates. + + + +Say, for example, you often make 4K feature DCPs from video files in +’scope at 25fps. You can speed up this process by following +these steps: + + + + Create a film with any content and set it up how you like; + in our example, set the content to scale to DCP, the DCP resolution + to 4K, and so on. + Choose Save as template... from the File menu. + Enter a name for your template. + + + +Then in the future you can create a new film, tick the +Template box and choose your previously-saved +template. The basic film's settings will come from your template, and +when you add some content it will take on the settings of the +first similarly-typed piece of content in your template. + + + + + + + Encryption @@ -1976,7 +2082,7 @@ linkend="fig-kdm"/>. KDM dialog - + @@ -2047,13 +2153,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.
@@ -2093,7 +2214,7 @@ 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’ +can start from the same place that you start the ‘normal’ DCP-o-matic. Its window is shown in . @@ -2101,7 +2222,7 @@ DCP-o-matic. Its window is shown in . The KDM creator - + @@ -2158,15 +2279,10 @@ DCP-o-matic provides a few preferences which can be used to modify its behaviour. This chapter explains those options. - - -
-The preferences dialogue - -The preferences dialogue is opened by choosing +Preferences can be edited by choosing Preferences... from the Edit -menu. The dialogue is split into seven tabs. +menu. This opens a dialogue which is split into seven tabs. @@ -2388,13 +2504,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. + +
@@ -2537,6 +2659,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 @@ -2553,7 +2683,6 @@ that are generated, so in normal use it is best to leave this unticked. -
@@ -2838,7 +2967,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. @@ -2879,4 +3009,111 @@ hashes. + +Common tasks + + +This chapter describes how to carry out some commonly-required tasks +with DCP-o-matic. The full details are elsewhere in the manual: here +we just discuss different approaches to these tasks and how to carry +them out. + + +
+Adding subtitles to an existing DCP + + +You have three options: + + + +Make a “Version File” (VF) DCP. +Make a complete DCP with projector-added subtitles. +Make a complete DCP with burnt-in subtitles. + + + +Making a VF DCP is usually the best option. This will be a very small +DCP which contains only the subtitles: it refers to your existing DCP +for the picture and sound. The projectionist will ingest both the +existing and VF DCPs and play back the VF. The advantages of this +approach are that the VF is very quick to generate, and small in size, +making it easy to distribute. This is especially useful if you have +to make VF DCPs in many different languages. + + + +Making a complete DCP with projector-added subtitles gives you a new, +single DCP which the projectionist can ingest and play. It will be +the same size as your existing DCP, and fairly quick to create. This +approach relies on the projector (or server) to create the subtitles +and overlay them on the image, which mostly works well but is not +100% reliable. + + + +Making a complete DCP with burnt-in subtitles gives you a new, single DCP +but with the subtitles rendered by DCP-o-matic and copied into your +image. This is slower to create than a DCP with projector-added +subtitles as every video frame with a subtitle must be re-encoded. +The advantage of this approach is that it is less likely to go wrong, +especially if you are using unusual subtitle positioning or character +sets. + + +
+ +
+Making a VF DCP + + +Start a new DCP-o-matic film. +Click Add folder... and specify your existing DCP's folder. +Go to the DCP tab and choose Split by video content for Reel type. +Go to the Video and +Audio tabs in turn and tick the Refer to existing DCP checkboxes. +Add your subtitles to the film in whatever format you have. +Check the subtitle appearance in the preview; it will be +slow to respond as it is having to decompress images from the existing +DCP. +Choose Make DCP from the menu. + + +
+ +
+Making a complete DCP with projector-added subtitles + + +Start a new DCP-o-matic film. +Click Add folder... and specify your existing DCP's folder. +Add your subtitles to the film in whatever format you have. +Check the subtitle appearance in the preview; it will be +slow to respond as it is having to decompress images from the existing +DCP. Adjust the appearance using controls in the +Subtitle tab if required. +Choose Make DCP from the menu. + + +
+ +
+Making a complete DCP with burnt-in subtitles + + +Start a new DCP-o-matic film. +Click Add folder... and specify your existing DCP's folder. +Add your subtitles to the film in whatever format you have. +Go to the Subtitle tab and tick the Burn subtitles into image checkbox. +Check the subtitle appearance in the preview; it will be +slow to respond as it is having to decompress images from the existing +DCP. Adjust the appearance using controls in the +Subtitle tab if required. +Choose Make DCP from the menu. + + +
+ + +