From: Carl Hetherington Date: Fri, 12 Jun 2015 22:41:40 +0000 (+0100) Subject: Various alterations to the manual. X-Git-Tag: v2.1.0~9 X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=979ead5948d8831cde9765fdedd322c5deb661d9 Various alterations to the manual. --- diff --git a/doc/manual/Makefile b/doc/manual/Makefile index 5ca5700f9..ef4dacff2 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -3,7 +3,7 @@ all: html pdf DIAGRAMS := file-structure.svg 3d-left-right.svg 3d-top-bottom.svg timecode.svg pipeline1.svg pipeline2.svg \ - pipeline3.svg pipeline4.svg + pipeline3.svg pipeline4.svg burn-in.svg discrete.svg SCREENSHOTS := file-new.png video-new-film.png still-new-film.png video-select-content-file.png \ still-select-content-file.png examine-thumbs.png examine-content.png timing-tab.png \ diff --git a/doc/manual/dcpomatic-pdf.xsl b/doc/manual/dcpomatic-pdf.xsl index c4ced0deb..0a57bf23f 100644 --- a/doc/manual/dcpomatic-pdf.xsl +++ b/doc/manual/dcpomatic-pdf.xsl @@ -1,8 +1,8 @@ - + - -colorlinks,linkcolor=black,urlcolor=black + +colorlinks,linkcolor=blue,urlcolor=blue 0 @@ -14,4 +14,18 @@ 3 + + + + + + \textsf{ + + } + + + + + + diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 0bb5ed1ca..0200cf26e 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -342,8 +342,8 @@ the right of the window, as shown in . Dragging the slider will move through your video. You can also click -the Play button to play the content back. Note -that there will be no sound, and playback might not be entirely +the Play button to play the content back. Note +that there will be no sound, and playback might not be entirely accurate (it may be slightly slower or faster than it should be, for example). This player is really only intended for brief inspection of content; if you need to check it more thoroughly, use another player @@ -380,7 +380,7 @@ linkend="fig-making-dcp"/>. Making the DCP - + @@ -449,7 +449,7 @@ 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 Length setting, as shown in Play length setting, as shown in . @@ -519,6 +519,8 @@ images which should be treated as the frames of a video. superimposed on the image of the DCP. These can be .srt or .xml files. + +DCP — an existing DCP. @@ -527,10 +529,11 @@ To add one or more movie, sound, still-image or subtitle files, select -To add a directory (folder) of images, choose Add -folder... and choose the directory from the selector. -DCP-o-matic will open a small dialogue box where you can enter the -frame rate that your image sequence should be run at. +To add a directory (folder) of images or a DCP, choose Add +folder... and choose the directory from the selector. If +you select a folder of images DCP-o-matic will open a small dialogue +box where you can enter the frame rate that the image sequence should +be run at. @@ -540,6 +543,30 @@ clicking the Remove button. + +
+Adding existing DCPs + +Adding existing DCPs to a DCP-o-matic film is a little different +to adding other types of content. Most content has to be converted to +JPEG2000, the compression scheme used by DCPs, which is a very +time-consuming process. Existing DCPs are already in JPEG2000 format +so do not require conversion. This means that, provided no settings +such as crop are used on the DCP content, picture and sound data will +be passed from existing to new DCP unaltered. + + +Encrypted DCPs that are added as content will require a KDM +targeted at DCP-o-matic so that DCP-o-matic can decrypt them. You +should ask the creator of the imported DCP to provide a KDM for +DCP-o-matic's decryption certificate, which can be obtained by +clicking Export DCP decryption certificate... +from the Keys tab of the +Preferences dialog (see ). + + +
@@ -700,7 +727,7 @@ linkend="tab-colour-conversion"/>. sRGBStill images in RGB, e.g. photographs. -Rec. 601Standard-definition content (lower than about 1000 pixels across) including DVD rips. +Rec. 601Standard-definition content (fewer than about 1000 pixels across) including DVD rips. Rec. 709High-definition content including Blu-Ray rips. @@ -784,8 +811,9 @@ does not scale the image but pads it to the DCP's container ratio of This description also gives the frame rate of the content and what -will happen to it when it is played at the DCP's frame rate. - +will happen to it when it is played at the DCP's frame rate. See + for details of DCP-o-matic's +frame-rate conversion.
@@ -823,9 +851,13 @@ in the DCP. Down the left-hand side of the map is the list of audio channels in -the currently-selected piece of content. Along the top is each -channel in the DCP. A green box means that the corresponding -content channel will be copied into the corresponding DCP channel. +the currently-selected piece of content. These are labelled with two +numbers; the first is the stream index within the content and the +second is the channel number within that stream. Some content will +have different streams for different languages or audio mixes. Along +the top is each channel in the DCP. A green box means that the +corresponding content channel will be copied into the corresponding +DCP channel. @@ -960,12 +992,6 @@ between audio and video. A positive delay will move the audio later with respect to the video, and a negative delay will move it earlier. - -The Audio Stream option allows you to select the -audio stream to use, if the content contains more than one. There -might be different soundtrack languages, for example. - - @@ -991,7 +1017,47 @@ 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). +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 + + +
+ Burnt-in subtitles + + + + + +
+ +
+ Separate subtitles + + + + + +
+ + +The advantage of separate subtitles is that the same video content can +be used for DCPs in many different languages. This means that only a +small text file needs to be changed for each target language, rather +than a large video file. It also means that the time-consuming video +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. @@ -1091,7 +1157,9 @@ to the full length minus trim-from-start and minus -Video frame rate specifies the frame rate for still-image content. +Video frame rate specifies the frame rate for +still-image content. It can also be used to override the detected +frame rate of other content if DCP-o-matic has got it wrong. @@ -1275,8 +1343,40 @@ scheme as it makes it easier to identify details of the content. -If the DCP name is long, it may not all be visible. You can see the -full name by hovering the mouse pointer over the partial name. +The Content Type option can be +‘feature’, ‘trailer’ or whatever; select the +required type from the drop-down list. On some projection systems +this will affect where your content appears in the projector's server +user interface, so take care to select an appropriate type. + + + +The Signed check-box sets whether or not the DCP +is signed. This is rarely important; if in doubt, tick it. + + + +The Encrypted check-box will set whether the DCP +should be encrypted or not. If this is ticked, the DCP will require a +KDM to play back. Encryption is discussed in . + + + +If you use encryption DCP-o-matic will generate a random encryption +key for you. To specify your own key, click the +Edit.. button next to the key. + + + +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). + + + +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. @@ -1289,12 +1389,6 @@ format into a Flat container: in this case, select the small format for the content's ratio and ‘Flat’ for the DCP. - -Next up is the content type. This can be -‘feature’, ‘trailer’ or whatever; select the -required type from the drop-down list. - - The Frame Rate control sets the frame rate of your DCP. This can be a little tricky to get right. Ideally, you @@ -1311,31 +1405,10 @@ added. -The Signed check-box sets whether or not the DCP -is signed. This is rarely important; if in doubt, tick it. - - - -The Encrypted check-box will set whether the DCP -should be encrypted or not. If this is ticked, the DCP will require a -KDM to play back. Encryption is discussed in . - - - -If you use encryption DCP-o-matic will generate a random encryption -key for you. To specify your own key, click the -Edit.. button next to the key. - - - -The Audio Channels control sets the number of -audio channels that the DCP will have. If the DCP has any channels -for which there is no content audio they will be replaced by silence. -You can only set an even number of channels here, since that is -required by the DCI standard. If you want an odd number of channels, -set the DCP channel count to one greater than you need and the -unused channel will be filled with silence. +Burn subtitles into image should be selected if +you want DCP-o-matic to overlay the subtitles onto the video frame +before encoding. Leave this un-ticked to include the subtitles +separately in the DCP. @@ -1361,17 +1434,44 @@ Most commercial DCPs use bit rates between 75 and 125 MBit/s. -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). +The Audio Channels control sets the number of +audio channels that the DCP will have. If the DCP has any channels +for which there is no content audio they will be replaced by silence. +You can only set an even number of channels here, since that is +required by the DCI standard. If you want an odd number of channels, +set the DCP channel count to one greater than you need and the +unused channel will be filled with silence. -Finally, the Scaler is the method that will be used to scale up -your content for the DCP, if required. Bicubic is a fine choice in -most situations. +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: + +Mid-side decode — this will take a L/R +stereo input and extract the common part (corresponding to the +‘Mid’ in a mid-side signal) into the DCP's centre channel. +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. + + +
Show audio @@ -1797,44 +1897,9 @@ name or IP address of the server to use.
- -
-Colour conversions - - -The colour conversions tab is shown in . - - -
- Colour conversions preferences - - - - - -
- - -As part of the encoding process, DCP-o-matic has to convert the colour -space of the source files that you use into XYZ, the colour space used -by the DCI standard. - - - -Colour conversion is discussed in more detail in a separate document -colour.pdf. - - - -These preferences control a list of presets which are suitable for -converting from common input colour spaces to XYZ. - - -
- -
+
Keys diff --git a/doc/manual/diagrams/burn-in.svg b/doc/manual/diagrams/burn-in.svg new file mode 100644 index 000000000..6f1e35aa0 --- /dev/null +++ b/doc/manual/diagrams/burn-in.svg @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + Content + Video frame + + + + Shapes were inventedin 1954. + + Subtitle + + + + + + Shapes were inventedin 1954. + + DCP-o-matic merges("burns in") + DCP + + diff --git a/doc/manual/diagrams/discrete.svg b/doc/manual/diagrams/discrete.svg new file mode 100644 index 000000000..d2c157178 --- /dev/null +++ b/doc/manual/diagrams/discrete.svg @@ -0,0 +1,385 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + Content + Video frame + + + + Shapes were inventedin 1954. + + Subtitle + + + Subtitle is keptseparate from videoframe in DCP + + + + + + + DCP + + + + Shapes were inventedin 1954. + + Subtitle + + Video frame + + + + + + + Projector + Shapes were inventedin 1954. + + Projector merges + +