X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=1b9418c7845eb10f6e26ad39583d8e49b11abf19;hb=4353fa3c514c4cebd4cb1509c8273eed764aab4e;hp=0c697e2b2f2ae1fb4d2b8a536f1aa3a540bdca2e;hpb=ce12e6c391ac87f5468b88844c36a61183d2d099;p=dcpomatic.git diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 0c697e2b2..1b9418c78 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -26,13 +26,16 @@ Hello, and welcome to DCP-o-matic!
What is DCP-o-matic? - -DCP-o-matic is a set of programs to make Digital -Cinema Packages (DCPs) from almost any video, audio and/or -subtitle files. The resulting DCPs will play on modern digital -cinema projectors. - +DCP-o-matic is a set of programs to perform the following tasks: + + + 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. +
@@ -116,7 +119,7 @@ Windows version. DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and -higher. DCP-o-matic is split into four separate applications, each of +higher. DCP-o-matic is split into five 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. @@ -138,20 +141,15 @@ with the first (main) part. - Debian 7 (‘wheezy’) - Debian 8 (‘jessie’) - Debian unstable (‘sid’) - Ubuntu 14.04 (‘Trusty Tahr’) - Ubuntu 16.04 (‘Xenial Xerus’) - Ubuntu 17.10 (‘Artful Aardvark’) - Mint 17 - Mint 18 + 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 or Ubuntu will install the necessary bits and +and double-click it. Debian, Ubuntu or Mint will install the necessary bits and pieces and set DCP-o-matic up for you. @@ -162,7 +160,7 @@ pieces and set DCP-o-matic up for you.
Fedora, Centos and Mageia Linux - There are .rpm packages for Fedora 25, 26 and 27, Centos 6 and 7 and Mageia 6 on + There are .rpm packages for Fedora 27, 28 and 29, Centos 6 and 7 and Mageia 6 on http://dcpomatic.com/
@@ -199,7 +197,6 @@ The following dependencies are required: libsamplerate OpenSSL libopenjpeg -ImageMagick Boost libssh GTK (on Linux) @@ -208,9 +205,12 @@ The following dependencies are required: xmlsec curl libzip -libdcp -libsub -libcxml +asdcplib with some patches +libdcp +libsub +libcxml +locked_sstream +rtaudio libicu @@ -281,7 +281,7 @@ shown in . Creating a new film - + @@ -397,7 +397,7 @@ linkend="fig-making-dcp"/>. Making the DCP - + @@ -518,8 +518,8 @@ 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: +If your DCP is a Version File (VF) (i.e. it refers to +another DCP's assets) you should import it as follows: @@ -533,7 +533,7 @@ OV”. -
+
Decrypting encrypted DCPs @@ -727,6 +727,55 @@ To add one or more movie, sound, still-image or subtitle files, select Add file(s)... and choose them from the selector. + +DCP-o-matic will automatically map a set of audio files to the correct channels if you include appropriate ‘tags’ in your filenames, as shown in . + + + + Audio file naming + + + + Tag + Examples + Channel + + + + + L surrounded by . _ or - + film-L.wav my_movie_L_final.wav + Left + + + R surrounded by . _ or - + film-R.wav my_movie_R_final.wav + Right + + + C surrounded by . _ or - + film-C.wav my_movie_C_final.wav + Centre + + + Lfe surrounded by . _ or - + film-Lfe.wav my_movie_Lfe_final.wav + LFE (sub) + + + Ls surrounded by . _ or - + film-Ls.wav my_movie_Ls_final.wav + Left surround + + + Rs surrounded by . _ or - + film-Rs.wav my_movie_Rs_final.wav + Right surround + + + +
+ To add a directory (folder) of images, choose Add folder... and choose the directory from the selector. @@ -988,11 +1037,11 @@ url="http://dcpomatic.com/manual/colour.pdf">colour.pdf. Other settings -The crop settings can be used to crop your content, -which can be used to remove black borders from round the edges of DVD -images, for example. The specified number of pixels will be trimmed -from each edge, and the content image in the right of the window will -be updated to show the effect of the crop. +The crop settings can be used to crop your +content, which is often used to remove black borders from the edges of +the image. The specified number of pixels will be trimmed from each +edge, and the content image in the right of the window will be updated +to show the effect of the crop. @@ -1722,7 +1771,7 @@ The JPEG2000 bandwidth; setting changes how big the final image files used within the DCP will be. Larger numbers will give better quality, but correspondingly larger DCPs. The bandwidth can be between 50 and 250 megabits per second (Mbit/s). -Most commercial DCPs use bit rates between 75 and 125 MBit/s. +Most commercial DCPs use bit rates between 75 and 125 Mbit/s. @@ -1999,7 +2048,7 @@ delivery message (KDM) can play the DCP.
-How it works (in a nutshell) +How it works This section attempts to summarise how DCP encryption works. You can @@ -2049,9 +2098,16 @@ key from the public key. Public-key encryption allows us to distribute the DCP's key to Alice securely. The manufacturer of Alice's projector generates a public -and private key. They hide the private key deep inside the bowels of -the projector (inside an integrated circuit) where no-one can read it. -They then make the public key available to anyone who is interested. +and private key. They hide the private key inside the projector where +no-one can read it. They then make the public key available to anyone +who is interested. + + + +DCP-o-matic has a similar arrangement except that it stores its +private keys in the user's configuration file. See for details of how to share DCP-o-matic's +certificate so that others can make encrypted DCPs for DCP-o-matic. @@ -2228,7 +2284,7 @@ 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 +content) it is targeted at a particular user'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. @@ -2338,8 +2394,8 @@ system; possible locations are listed in Preferences -DCP-o-matic provides a few preferences which can be used to modify its -behaviour. This chapter explains those options. +DCP-o-matic provides preferences which can be used to modify its +behaviour. They are described in this chapter. @@ -2387,7 +2443,7 @@ read about how to contribute a translation.
-Threads +Number of threads DCP-o-matic should use When DCP-o-matic is encoding DCPs it can use multiple parallel threads @@ -2399,6 +2455,31 @@ to set this up correctly when you run it for the first time.
+ + +
+Number of threads DCP-o-matic encode server should use + + +This is the number of threads that the encode server should use when +it is running and helping another copy of DCP-o-matic to speed up its +encode. + + +
+ + + +
+Configuration file + + +This is the location of DCP-o-matic's configuration file on disk. You +can use this to share configuration between several copies of +DCP-o-matic, across a network share, for instance. + +
+
Cinema and screen database file @@ -2407,9 +2488,22 @@ to set this up correctly when you run it for the first time. 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. +
+ + +
+Play sound via + + +The checkbox to the left of Play sound enables or +disables DCP-o-matic use of sound. On some machines there will be +multiple options in the drop-down menu to decide how the sound should +be played. +
+
Integrated loudness @@ -2423,6 +2517,15 @@ faster.
+ +
+Automatically analyse content audio + + +If this checkbox is ticked an audio analysis will be run whenever content is added that contains sound. + +
+
Updates @@ -2517,7 +2620,7 @@ name or IP address of the server to use. Keys -The Keys tab (shown in ) holds options +The Keys tab (shown in ) has controls related to the keys and certificates used in some parts of DCP creation. @@ -2532,9 +2635,43 @@ creation. -At the top of the tab is the chain of certificates that will be used -to sign DCPs and KDMs. DCP-o-matic creates a random chain when you -first run it and if you are happy to use this chain you can ignore the +Export KDM decryption certificate... allows you +to save the certificate that DCP-o-matic uses when decrypting KDMs +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 +KDMs supplied by other people. Use this button and Import +all KDM decryption settings... to transfer settings between +different copies of DCP-o-matic so that they can both use the same +KDMs. + + + +The two Advanced... buttons open advanced +dialogue boxes for detailed manipulation of DCP-o-matic's certificate +chains. + + +
+ +
+Advanced keys settings + + +At the top of the Advanced dialogue for signing +DCPs and KDMs is the chain of certificates that will be used to sign +DCPs and KDMs. DCP-o-matic creates a random chain when you first run +it and if you are happy to use this chain you can ignore the preferences. Otherwise, you can add or remove certificates from the chain using the Add... and Remove buttons. @@ -2556,13 +2693,13 @@ corresponds to the public key held in the leaf certificate. -Underneath the details of the certificate chain and private key for -signing of DCPs and KDMs is a second chain and key which is used by +At the top of the Advanced dialogue for decrypting DCPs is the chain and key which is used by DCP-o-matic when you import an encrypted DCP as a piece of content. 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 @@ -2684,6 +2821,68 @@ The Reset to default text will replace the current KDM emai
+ +
+Cover sheet + + +The DCP cover sheet configuration is shown in . + + +
+ DCP cover sheet preferences + + + + + +
+ + +This is a template for the cover sheet that is written next to every DCP that DCP-o-matic creates. You can change it to say whatever you like. A few +‘magic’ strings will be replaced by information from the +DCP that has been made: + + + +‘Magic’ Cover sheet strings + + + +$CPL_NAMEDCP title + + +$TYPEDCP content type (e.g. feature, trailer...) + + +$CONTAINERThe container ratio (e.g. flat, scope...) + + +$AUDIODetails of the audio channels + + +$AUDIO_LANGUAGEAudio language + + +$SUBTITLE_LANGUAGESubtitle language + + +$LENGTHDCP length in hours, minutes and seconds + + +$SIZEDCP size in gigabytes + + + +
+ + +The Reset to default text will replace the current cover sheet with DCP-o-matic's default. + + +
+ +
Advanced @@ -2719,7 +2918,7 @@ this unticked for normal use. Only servers encode makes DCP-o-matic encode 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. +suggest you leave this unticked unless you have a good reason to do otherwise. @@ -2740,7 +2939,7 @@ as this makes the log files useful for tracking down bugs. The Timing checkbox will enable extra log entries -to allow developers to investigate and optimize the speed of +to allow developers to investigate and optimise the speed of DCP-o-matic. It will significantly increase the size of the log files that are generated, so in normal use it is best to leave this unticked. @@ -2778,8 +2977,8 @@ even refuse to ingest. The only rates that are (pretty much) guaranteed to work on all DCI -projectors are 24 frames per second (fps) for video and 48kHz or 96kHz -for audio. If you are sending your DCPs to unknown places it wise to +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. @@ -2791,7 +2990,7 @@ consider using these rates if at all possible. Other often-supported rates Many projectors now in the wild support additional video frame rates: -25, 30 and 48 fps. +25, 30, 48, 50 and 60 fps.
@@ -3376,6 +3575,35 @@ The full details of OV and VF files are discussed in + + 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 + play DCPs at reduced resolutions with slower CPUs. + + To use the player, start DCP-o-matic + Player, and load a DCP using the + Open option on the File + menu. + + If you load a VF and/or encrypted DCP you can add your OV + and/or KDM using the appropriate options on the + File menu. + + During playback the Performance area at + the bottom right of the window will give details of how many frames + are being dropped; these are frames that were not decoded from the + DCP quickly enough. If this number is high you can increase + performance at the cost of rendering quality by choosing an option + from the View menu. If you set the player to + decode at less than full resolution the DCP's data will be decoded + at this lower resolution, which is quicker than decoding at full + resolution. + + + + Configuration files