From: Carl Hetherington Date: Fri, 29 Aug 2014 22:51:13 +0000 (+0100) Subject: Manual updates. X-Git-Tag: v2.0.48~561^2~64 X-Git-Url: https://git.carlh.net/gitweb/?a=commitdiff_plain;h=8db9e4f88fd3710dd972f0233e6f1b60b691a569;hp=06435a3dd129d35a28f9b948ada3153d93c33b07;p=dcpomatic.git Manual updates. --- diff --git a/ChangeLog b/ChangeLog index bbc8299cb..a966e7532 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2014-08-29 Carl Hetherington + + * Some improvements to the manual. + 2014-08-26 Carl Hetherington * Version 1.73.0 released. diff --git a/doc/manual/Makefile b/doc/manual/Makefile index 408f874f6..55d888b2e 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -7,9 +7,9 @@ DIAGRAMS := file-structure.svg 3d-left-right.svg 3d-top-bottom.svg timecode.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 \ - calculate-audio-gain.png add-file.png dcp-tab.png \ - prefs-kdm-email.png prefs-colour-conversions.png prefs-metadata.png prefs-misc.png prefs-tms.png \ - prefs-advanced.png \ + calculate-audio-gain.png add-file.png dcp-tab.png colour-conversion.png \ + prefs-kdm-email.png prefs-colour-conversions.png prefs-metadata.png prefs-general.png prefs-tms.png \ + prefs-advanced.png prefs-defaults.png prefs-servers.png \ making-dcp.png filters.png video-tab.png audio-tab.png subtitles-tab.png timing-tab.png \ audio-plot.png audio-map-eg1.png audio-map-eg2.png audio-map-eg3.png kdm.png diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 851a7793d..cd27bef72 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -27,6 +27,7 @@ Hello, and welcome to DCP-o-matic! +
What is DCP-o-matic? @@ -46,6 +47,8 @@ your cinema.
+ +
Licence @@ -55,6 +58,8 @@ DCP-o-matic is licensed under the Tango Installation + +
Windows @@ -89,12 +96,14 @@ version.
+ +
Mac OS X DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and -higher. To install it, download the DMG from .dmg from http://dcpomatic.com/ and double click to open it. Then drag the DCP-o-matic icon to your Applications folder or wherever else you would @@ -108,8 +117,7 @@ like to install it. You can install DCP-o-matic on Ubuntu 12.04 (‘Precise -Pangolin’), 12.10 (‘Quantal Quetzal’), 13.10 (‘Saucy -Salamander’) or 14.04 (‘Trusty Tahr’) using .deb packages: download the +Pangolin’) or 14.04 (‘Trusty Tahr’) using .deb packages: download the appropriate package from http://dcpomatic.com/ and double-click it. Ubuntu will install the necessary bits and pieces @@ -118,22 +126,28 @@ and set DCP-o-matic up for you.
+ +
Debian Linux -Packages are available for Debian 7 (squeeze) from http://dcpomatic.com/.
+ +
Centos Linux -Packages are available for Centos 6.5 from http://dcpomatic.com/.
+ +
Arch Linux @@ -143,6 +157,8 @@ thanks to Stefan Karner.
+ +
Other Linux distributions @@ -150,8 +166,7 @@ thanks to Stefan Karner. Installation on non-Ubuntu Linux is currently a little involved, as there are no packages available (yet); you will have to compile it from source. If you are using a non-Ubuntu distribution, do let me -know via the mailing -list and I will see about building some packages. +know by email and I will see about building some packages. @@ -205,6 +220,8 @@ in a shell.
+ + Creating a video DCP @@ -270,6 +287,8 @@ will write its working files.
+ +
Adding content @@ -339,6 +358,8 @@ url="http://www.mplayerhq.hu/design7/news.html">mplayer or + +
Making the DCP @@ -381,6 +402,8 @@ DCP-o-matic. See the Creating a still-image DCP @@ -454,6 +477,8 @@ to encode a single frame which it can then repeat. + + Content settings @@ -504,6 +529,9 @@ clicking the Remove button.
+ + +
Content Properties @@ -524,6 +552,8 @@ in each section are described below.
+ +
Video @@ -540,6 +570,8 @@ The Video tab controls properties of the image, as shown in + +
Image type @@ -576,6 +608,18 @@ linkend="fig-3d-top-bottom"/>. + +Another option is 3D alternate which takes the +first frame of the content as for the left eye, the second for the +right eye, the third for the left, and so on. Finally, you can +specify 3D left only or 3D right +only if this content contains only the the left or right +eye images. This is useful when you have the left and right eye image +sets in different files; you can specify one content as 3D +left only and another as 3D right only +and DCP-o-matic will pick up the appropriate frames from each. + +
@@ -610,6 +654,52 @@ image is much smaller and of lower resolution than a projected image!
+ + +
+Colour conversion + + +The Colour conversion setting specifies what +colour transforms and gamma correction DCP-o-matic will use when +converting the selected content into the XYZ colourspace for the DCP. + + + +Clicking Edit... will open the colour conversion +dialogue box, as shown in . + + +
+ Dialogue box for setting colour conversion + + + + + +
+ + +In most cases, it is only necessary to select one of DCP-o-matic's +presets. DCP-o-matic knows how to convert from two common +colourspaces: sRGB and Rec. 709, so if your content was graded using +one of those you can select the appropriate preset. + + + +For other colour spaces you can edit the values in the lower half of +the dialogue box as you wish. Alternatively, create a new colour +conversion preset using the preferences dialog, as described in . + + + +Colour conversion is discussed in more detail in a separate document +colour.pdf. + + +
+
Other settings @@ -629,6 +719,8 @@ ratio that your content should be presented in.
+ +
Video description @@ -652,6 +744,8 @@ will happen to it when it is played at the DCP's frame rate.
+ +
Audio @@ -668,6 +762,8 @@ The Audio tab controls properties of the image, as shown in + +
Show audio @@ -717,6 +813,8 @@ auditorium, but it can be useful to get levels in the right rough area.
+ +
The audio map @@ -729,10 +827,35 @@ 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 checked box means that the corresponding +channel in the DCP. A green box means that the corresponding content channel will be copied into the corresponding DCP channel. + +When content channels are copied into DCP channels they can be done +with variable gain. If, for example, you want to copy a channel +as-is, you can set a gain of 0dB. Alternatively, if you want to mix +two channels into one, you may want to use a gain of -6dB on each one +to prevent clipping when the two channels are added. + + + +The green boxes of the audio mapping view tell you (very roughly) how +much gain is applied to each channel. A full-height box means 0dB +(i.e. unity) gain. Any less height indicates lower gain. + + + +To map one channel to another with 0dB gain, click in the empty box +and it will turn green to reflect the mapping. A second click will +turn the mapping back off. To set some other gain, right-click on the +box to open the gain menu. This allows you to set +Off (no mapping or negative infinity gain), +Full (0dB gain), -6dB gain or +Edit which allows you to set the required gain +precisely. + + Consider, for example, the case in . @@ -748,8 +871,9 @@ Consider, for example, the case in . Here, we have two channels in the source which are mapped to left and -right, respectively, in the DCP. If we modify that as in +right, respectively, in the DCP. The full green boxes show that the +mapping is at unity gain (0dB) in each case. Imagine that we modify +the settings to those shown in
@@ -762,8 +886,13 @@ linkend="fig-audio-map-eg2"/>
-we now have the content's streams mapped to left and right and also -mixed together and placed in the DCP's centre channel. +We now have the content's streams mapped to left and right and also +mixed together and placed in the DCP's centre channel. The smaller +green boxes on the centre mappings show that those channels are added +with some non-unity gain; you can see by hovering the mouse pointer +over those boxes that the gain for content channels 1 and 2 is -6dB +when being sent to the centre channel and 0dB when being sent to left +and right.
@@ -782,6 +911,8 @@ shows the mapping of a 5.1 source into a 5.1 DCP.
+ +
Other controls @@ -842,6 +973,7 @@ might be different soundtrack languages, for example.
+
Subtitles @@ -866,9 +998,11 @@ included in the image and not overlaid by the projector). Note that DVD and Blu-Ray subtitles are stored as bitmaps, so it is not possible (automatically) to use non-burnt-in subtitles with these sources. Select the With Subtitles check-box to enable -subtitles. The offset control moves the -subtitles up and down the image, and the scale -control changes their size. +subtitles. The X Offset and Y +Offset controls move the subtitles around within the image, +and the scale control changes their size. The +Stream control changes the subtitle stream that +is used when the content has more than one. @@ -879,6 +1013,8 @@ DCPs).
+ +
Timing @@ -953,6 +1089,8 @@ any changes to the corresponding timecode.
+ +
Video processing pipeline @@ -1210,6 +1348,8 @@ chapter discusses the basic principles of DCP encryption, and how DCP-o-matic can create encrypted DCPs and KDMs for them. + +
Basics @@ -1223,6 +1363,8 @@ way that he can play it. Only those cinemas who receive a correct key delivery message (KDM) can play the DCP. + +
How it works (in a nutshell) @@ -1298,6 +1440,8 @@ does not).
+ +
Encryption using DCP-o-matic @@ -1387,6 +1531,8 @@ generate the KDMs. + + Preferences @@ -1395,31 +1541,36 @@ 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... from the Edit -menu. The dialogue is split into five tabs. +menu. The dialogue is split into seven tabs. +
-Miscellaneous +General -The miscellaneous tab is shown in . +The general tab is shown in . -
- Miscellaneous preferences +
+ General preferences - +
+ +
Language @@ -1437,6 +1588,8 @@ read about how to contribute a translation.
+ +
Threads @@ -1450,30 +1603,57 @@ to set this up correctly when you run it for the first time.
+
-KDM emails +Updates + + +The Check for updates on startup option, if +enabled, will tell DCP-o-matic to check on dcpomatic.com to see if there any +newer versions of DCP-o-matic then the one you are running. If so, a +dialogue box will open with a link to download the new version. +available + -DCP-o-matic can send KDMs (see ) to -cinemas (or anywhere else) via email. To make this work, enter a -suitable outgoing mail (SMTP) server and ‘from’ address -for these emails. +The Check for testing updates as well as stable +ones option will also check for test updates as well as +those that are formally ‘released’ This is useful if you +like to live on the bleeding edge! +
+
Defaults -The next few options allow you to set up default values for several -properties of new films that you create. +The defaults tab is shown in . + + +
+ Defaults preferences + + + + + +
+ + +The options in this tab simply allow you to set up default values for +various properties of new films. -
-
+ + + +
Colour conversions @@ -1507,29 +1687,8 @@ converting from common input colour spaces to XYZ.
-
-Metadata - - -The metadata tab is shown in . - - -
- Metadata preferences - - - - - -
- - -This allows you to set up a couple of identifiers that are written -into the DCP. The default values should cause no problems. - - -
+
TMS TMS preferences @@ -1561,6 +1720,8 @@ credentials required to log into the TMS via SSH.
+ +
KDM email @@ -1579,13 +1740,42 @@ The KDM email is shown in . This is a template for the email that is used to send KDMs out to -cinemas. You can change it to say whatever you like. The -‘magic’ string $CPL_NAME will be replaced by -DCP's title. +cinemas. You can change it to say whatever you like. A few +‘magic’ strings will be replaced by information from the +KDM that is being sent: + + + +‘Magic’ KDM strings + + + +$CPL_NAMEDCP title + + +$CINEMA_NAMECinema name + + +$SCREENSName of screen or screens that KDMs are being generated for + + +$START_TIMEThe time from which the KDMs are valid + + +$END_TIMEThe time until which the KDMs are valid + + + +
+ + +The Reset to default text will replace the current KDM email with DCP-o-matic's default.
+ +
Advanced Advanced preferences @@ -1646,6 +1836,8 @@ video frame and audio sampling rates as the DCP. This is not, however, always possible. + +
DCP frame rate limitations @@ -1657,6 +1849,8 @@ play fine, but another (of a different type) will refuse to play, or even refuse to ingest. + +
Guaranteed rates @@ -1669,6 +1863,8 @@ consider using these rates if at all possible.
+ +
Other often-supported rates @@ -1677,6 +1873,8 @@ Many projectors now in the wild support additional video frame rates:
+ +
Adapting content to fit the DCP rate @@ -1719,6 +1917,8 @@ For very low or high frame rates, DCP-o-matic can also skip or duplicate frames.
+ +
Setting up @@ -1768,6 +1968,8 @@ The master and server machines do not need to be the same type, so you can mix Windows PCs, Macs and Linux machines as you wish. + +
Running the servers @@ -1822,6 +2024,8 @@ without touching your standard operating system install.
+ +
Setting up DCP-o-matic @@ -1834,6 +2038,8 @@ servers that DCP-o-matic has found.
+ +
Some notes about encode servers @@ -1916,6 +2122,8 @@ to the cinema which is showing your DCP. This chapter collects a few notes on bits of DCP-o-matic that do not fit elsewhere in the manual. + +
Resuming encodes diff --git a/doc/manual/screenshots/add-file.png b/doc/manual/screenshots/add-file.png index 86901de1b..22234dc6f 100644 Binary files a/doc/manual/screenshots/add-file.png and b/doc/manual/screenshots/add-file.png differ diff --git a/doc/manual/screenshots/audio-map-eg1.png b/doc/manual/screenshots/audio-map-eg1.png index 246c2e2d1..edef76e2d 100644 Binary files a/doc/manual/screenshots/audio-map-eg1.png and b/doc/manual/screenshots/audio-map-eg1.png differ diff --git a/doc/manual/screenshots/audio-map-eg2.png b/doc/manual/screenshots/audio-map-eg2.png index e2a9e1bb3..0e047cf38 100644 Binary files a/doc/manual/screenshots/audio-map-eg2.png and b/doc/manual/screenshots/audio-map-eg2.png differ diff --git a/doc/manual/screenshots/audio-map-eg3.png b/doc/manual/screenshots/audio-map-eg3.png index a1ebe3848..b43fb2968 100644 Binary files a/doc/manual/screenshots/audio-map-eg3.png and b/doc/manual/screenshots/audio-map-eg3.png differ diff --git a/doc/manual/screenshots/audio-tab.png b/doc/manual/screenshots/audio-tab.png index 78b216793..e12f23797 100644 Binary files a/doc/manual/screenshots/audio-tab.png and b/doc/manual/screenshots/audio-tab.png differ diff --git a/doc/manual/screenshots/colour-conversion.png b/doc/manual/screenshots/colour-conversion.png new file mode 100644 index 000000000..c5013ea6a Binary files /dev/null and b/doc/manual/screenshots/colour-conversion.png differ diff --git a/doc/manual/screenshots/filters.png b/doc/manual/screenshots/filters.png index 3f3c1e6c0..1a21c9d24 100644 Binary files a/doc/manual/screenshots/filters.png and b/doc/manual/screenshots/filters.png differ diff --git a/doc/manual/screenshots/prefs-colour-conversions.png b/doc/manual/screenshots/prefs-colour-conversions.png index 4ac4dc1d1..93b0dcf76 100644 Binary files a/doc/manual/screenshots/prefs-colour-conversions.png and b/doc/manual/screenshots/prefs-colour-conversions.png differ diff --git a/doc/manual/screenshots/prefs-defaults.png b/doc/manual/screenshots/prefs-defaults.png new file mode 100644 index 000000000..b116c31ac Binary files /dev/null and b/doc/manual/screenshots/prefs-defaults.png differ diff --git a/doc/manual/screenshots/prefs-general.png b/doc/manual/screenshots/prefs-general.png new file mode 100644 index 000000000..2a360e022 Binary files /dev/null and b/doc/manual/screenshots/prefs-general.png differ diff --git a/doc/manual/screenshots/prefs-kdm-email.png b/doc/manual/screenshots/prefs-kdm-email.png index 26ab5c044..5f30a1331 100644 Binary files a/doc/manual/screenshots/prefs-kdm-email.png and b/doc/manual/screenshots/prefs-kdm-email.png differ diff --git a/doc/manual/screenshots/prefs-misc.png b/doc/manual/screenshots/prefs-misc.png deleted file mode 100644 index 7e3a45a39..000000000 Binary files a/doc/manual/screenshots/prefs-misc.png and /dev/null differ diff --git a/doc/manual/screenshots/prefs-servers.png b/doc/manual/screenshots/prefs-servers.png new file mode 100644 index 000000000..11a0c2720 Binary files /dev/null and b/doc/manual/screenshots/prefs-servers.png differ diff --git a/doc/manual/screenshots/prefs-tms.png b/doc/manual/screenshots/prefs-tms.png index effc3ad71..62b0cadac 100644 Binary files a/doc/manual/screenshots/prefs-tms.png and b/doc/manual/screenshots/prefs-tms.png differ diff --git a/doc/manual/screenshots/subtitles-tab.png b/doc/manual/screenshots/subtitles-tab.png index 4880d8391..c2a01126e 100644 Binary files a/doc/manual/screenshots/subtitles-tab.png and b/doc/manual/screenshots/subtitles-tab.png differ diff --git a/doc/manual/screenshots/video-tab.png b/doc/manual/screenshots/video-tab.png index 31b120a52..80ae513f4 100644 Binary files a/doc/manual/screenshots/video-tab.png and b/doc/manual/screenshots/video-tab.png differ