From 7f4f37f498d56b734b49d66127f6f53cf1652d8f Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Sat, 21 Jun 2014 00:30:11 +0100 Subject: Manual updates. --- doc/manual/Makefile | 4 +- doc/manual/dcpomatic.css | 10 ++++ doc/manual/dcpomatic.xml | 91 +++++++++++++++++++++++++++++++--- doc/manual/screenshots/dcp-tab.png | Bin 37495 -> 43867 bytes doc/manual/screenshots/timing-tab.png | Bin 10417 -> 24796 bytes 5 files changed, 96 insertions(+), 9 deletions(-) (limited to 'doc') diff --git a/doc/manual/Makefile b/doc/manual/Makefile index baf8bddc8..eb10af245 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -2,13 +2,13 @@ all: html pdf -DIAGRAMS := file-structure.svg 3d-left-right.svg 3d-top-bottom.svg +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 \ - making-dcp.png filters.png video-tab.png audio-tab.png subtitles-tab.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 XML := dcpomatic.xml diff --git a/doc/manual/dcpomatic.css b/doc/manual/dcpomatic.css index 0e4982f20..566f09e63 100644 --- a/doc/manual/dcpomatic.css +++ b/doc/manual/dcpomatic.css @@ -17,3 +17,13 @@ div.sidebar { border-style: solid; background-color: #E2E8EE; } + +span.guilabel { + border-width: 1px; + border-style: solid; + background-color: #BED2E6; + padding-top: 1px; + padding-bottom: 1px; + padding-left: 3px; + padding-right: 3px; +} \ No newline at end of file diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index a346c69c7..ef4b7ff6d 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -879,7 +879,79 @@ DCPs). - +
+Timing + + +The timing tab contains settings related to the timing of your +content, as shown in . + + +
+ Timing settings tab + + + + + +
+ + +Most of the timing tab's entries are time-codes. +These are expressed as four numbers, as shown in . + + +
+ Timecode + + + + + +
+ + +Position is the time at which this piece of +content should start within the DCP. In most cases, this will be +0:0:0:0 to make the content start at the beginning of the +DCP. + + + +Full length is the length of the piece of +content. This can only be set for still-image content: for video or +sound content, it is fixed by the nature of the content file. If +still-image content is being used you can set the length for which it +should be displayed using this control. + + + +Trim from start specifies the amount that should be trimmed from the start of the content. + + + +Trim from end specifies the amount that should be trimmed from the end of the content. + + + +Play length indicates how long this piece of +content will be once the trims have been applied. This will be equal +to the full length minus trim-from-start and minus trim-from-end. + + + +Video frame rate specifies the frame rate for still-image content. + + + +Each timecode control has a Set which you should +click when you have entered a new value for a timecode. The +Set button will make DCP-o-matic take account of +any changes to the corresponding timecode. + + +
@@ -903,19 +975,19 @@ the main window, as shown in . The first thing here is the name. This is generally set to the title -of the film that is being encoded. If Use DCI +of the film that is being encoded. If Use ISDCF name is not ticked, the name that you specify will be used -as-is for the name of the DCP. If Use DCI name +as-is for the name of the DCP. If Use ISDCF name is ticked, the name that you enter will be used as part of a -DCI-compliant name. +ISDCF-compliant name. Underneath the name field is a preview of the name that the DCP will -get. To use a DCI-compliant name, tick the Use DCI -name check-box. The DCI name will be composed using details +get. To use a ISDCF-compliant name, tick the Use ISDCF +name check-box. The ISDCF name will be composed using details of your content's soundtrack, the current date and other things that -can be specified in the DCI name details dialogue box, which you can +can be specified in the ISDCF name details dialogue box, which you can open by clicking on the Details button. @@ -949,6 +1021,11 @@ content to fit the specified frame rate. Frame rates are discussed in more detail in . + +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 diff --git a/doc/manual/screenshots/dcp-tab.png b/doc/manual/screenshots/dcp-tab.png index e938aa63d..17208891a 100644 Binary files a/doc/manual/screenshots/dcp-tab.png and b/doc/manual/screenshots/dcp-tab.png differ diff --git a/doc/manual/screenshots/timing-tab.png b/doc/manual/screenshots/timing-tab.png index 122d01dc9..9b081e32e 100644 Binary files a/doc/manual/screenshots/timing-tab.png and b/doc/manual/screenshots/timing-tab.png differ -- cgit v1.2.3 From 25d977b3d64fb1396822243562a1b16185cec728 Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Sat, 21 Jun 2014 00:40:52 +0100 Subject: Manual tweaks. --- doc/manual/dcpomatic.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index ef4b7ff6d..57ff63d19 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -1098,7 +1098,7 @@ encoded in such a way that only cinemas ‘approved’ by the DCP's creators can read them. In particular, this means copies of the DCP can be distributed by insecure means: if an ne'er-do-well called Mallory obtains a hard drive containing an encrypted DCP, there is no -way that he can play it. Only those cinemas who receive a key +way that he can play it. Only those cinemas who receive a correct key delivery message (KDM) can play the DCP. @@ -1190,7 +1190,7 @@ 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, so that should be kept +be written to the film's metadata file, which should be kept secure. @@ -1538,7 +1538,7 @@ If DCP-o-matic did nothing else, the result of this would be that the audio would be running at the original speed with the video running slowly. Hence the audio would drift slowly out of sync. To avoid this, DCP-o-matic also resamples the audio such that the projector -will play it too fast by the same amount. Hence it will sound +will play it too slow by the same amount. Hence it will sound slightly different but will remain in sync with the video. -- cgit v1.2.3 From 72400007e8a9c8f7e3116197943fe9f232bd90aa Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Sat, 21 Jun 2014 12:06:37 +0100 Subject: Manual tweak. --- doc/manual/dcpomatic.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 57ff63d19..8460c2cbc 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -1073,7 +1073,7 @@ more modern of the two). -Finally, the scaler is the method that will be used to scale up +Finally, the Scaler is the method that will be used to scale up your content to the required size for the DCP, if required. Bicubic is a fine choice in most situations. -- cgit v1.2.3 From 7dd06cc89e018bfec3cbe802495bf7dee137a71f Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Sat, 21 Jun 2014 12:10:13 +0100 Subject: Missing file. --- doc/manual/diagrams/timecode.svg | 249 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 249 insertions(+) create mode 100644 doc/manual/diagrams/timecode.svg (limited to 'doc') diff --git a/doc/manual/diagrams/timecode.svg b/doc/manual/diagrams/timecode.svg new file mode 100644 index 000000000..5523c1b3d --- /dev/null +++ b/doc/manual/diagrams/timecode.svg @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + hours + minutes + seconds + frames + + + + + + -- cgit v1.2.3 From 14b1f672dc92ae8e1385c75e30420a4dcb4e32c9 Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Sun, 22 Jun 2014 16:52:03 +0100 Subject: Document advanced preferences. --- doc/manual/Makefile | 1 + doc/manual/dcpomatic.xml | 68 +++++++++++++++++++++++++++--- doc/manual/screenshots/prefs-advanced.png | Bin 0 -> 32295 bytes 3 files changed, 64 insertions(+), 5 deletions(-) create mode 100644 doc/manual/screenshots/prefs-advanced.png (limited to 'doc') diff --git a/doc/manual/Makefile b/doc/manual/Makefile index eb10af245..2e37c96be 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -8,6 +8,7 @@ SCREENSHOTS := file-new.png video-new-film.png still-new-film.png video-select-c 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 \ 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 8460c2cbc..dd0d3bf0c 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -375,7 +375,7 @@ linkend="ch-files"/> for details about the files that DCP-o-matic creates. Alternatively, if you have a projector or TMS that is accessible via SCP across your network, you can upload the content directly from -DCP-o-matic. See the preferences in . +DCP-o-matic. See the . @@ -1411,6 +1411,7 @@ into the DCP. The default values should cause no problems.
TMS +TMS preferences The TMS tab (shown in ) gives some @@ -1463,8 +1464,56 @@ DCP's title.
- +
+Advanced +Advanced preferences + + +The advanced preferences are shown in . + + +
+ Advanced preferences + + + + + +
+ + +Maximum JPEG2000 bandwidth specifies the maximum +bit-rate of JPEG2000 that DCP-o-matic will allow you to create. You +are advised to leave this at 250Mbit/s in normal use for maximum DCP +compatibility. + + + +Allow any DCP frame rate removes the limits on +the DCP video frame rates that DCP-o-matic will create. This may be +useful for experimentation. Again, you are strongly advised to leave +this unticked for normal use. + + + +The four checkboxes labelled Log control what +sort of messages DCP-o-matic writes to its log file when creating a +DCP. It is useful to leave General, +Warnings and Errors ticked +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 +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. + + +
+ @@ -1477,12 +1526,12 @@ however, always possible.
-DCP rate limitations +DCP frame rate limitations -There are some limitations to video and audio rates in DCPs. This is +There are some limitations to video and audio frame rates in DCPs. This is complicated by the fact that not all projectors will play DCPs at the -same rates. It is possible to create a DCP which one projector will +same frame rates. It is possible to create a DCP which one projector will play fine, but another (of a different type) will refuse to play, or even refuse to ingest. @@ -1567,6 +1616,15 @@ content will give a summary of what DCP-o-matic is doing with that content. + +If you want to experiment with other non-standard frame rates, you can +do so by ticking the Allow any DCP frame rate in +the Advanced tab of the preferences dialogue (see the +). You are strongly advised to +use this only on your own equipment, and only for experimentation +purposes. + +
diff --git a/doc/manual/screenshots/prefs-advanced.png b/doc/manual/screenshots/prefs-advanced.png new file mode 100644 index 000000000..b8db5f494 Binary files /dev/null and b/doc/manual/screenshots/prefs-advanced.png differ -- cgit v1.2.3