From 348afe4e19aa4149b2ad3b729bc1b4e8f87a5a3e Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Sun, 28 Jul 2013 16:43:23 +0100 Subject: Updates to manual. --- doc/manual/Makefile | 12 +- doc/manual/dcpomatic-pdf.xsl | 2 +- doc/manual/dcpomatic.xml | 519 ++++++++++++++++++++----------- doc/manual/diagrams/3d-left-right.svg | 219 +++++++++++++ doc/manual/screenshots/audio-map-eg1.png | Bin 0 -> 3876 bytes doc/manual/screenshots/audio-map-eg2.png | Bin 0 -> 3882 bytes doc/manual/screenshots/audio-map-eg3.png | Bin 0 -> 5881 bytes doc/manual/screenshots/audio-plot.png | Bin 0 -> 58207 bytes doc/manual/screenshots/audio-tab.png | Bin 0 -> 25648 bytes doc/manual/screenshots/subtitles-tab.png | Bin 0 -> 11651 bytes doc/manual/screenshots/video-tab.png | Bin 0 -> 29618 bytes 11 files changed, 564 insertions(+), 188 deletions(-) create mode 100644 doc/manual/diagrams/3d-left-right.svg create mode 100644 doc/manual/screenshots/audio-map-eg1.png create mode 100644 doc/manual/screenshots/audio-map-eg2.png create mode 100644 doc/manual/screenshots/audio-map-eg3.png create mode 100644 doc/manual/screenshots/audio-plot.png create mode 100644 doc/manual/screenshots/audio-tab.png create mode 100644 doc/manual/screenshots/subtitles-tab.png create mode 100644 doc/manual/screenshots/video-tab.png diff --git a/doc/manual/Makefile b/doc/manual/Makefile index f0cef4832..bb3c3167e 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -2,11 +2,12 @@ all: html pdf -DIAGRAMS := file-structure.svg +DIAGRAMS := file-structure.svg 3d-left-right.svg -SCREENSHOTS := file-new.png video-new-film.png still-new-film.png click-content-selector.png video-select-content-file.png \ - still-select-content-file.png examine-thumbs.png \ - calculate-audio-gain.png prefs.png making-dcp.png filters.png film-tab.png video-tab.png audio-tab.png subtitles-tab.png +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 prefs.png making-dcp.png filters.png video-tab.png audio-tab.png subtitles-tab.png \ + audio-plot.png audio-map-eg1.png audio-map-eg2.png audio-map-eg3.png XML := dcpomatic.xml @@ -49,6 +50,9 @@ html/screenshots/new-session.png: screenshots/new-session.png html/screenshots/export-dialogue.png: screenshots/export-dialogue.png mkdir -p html/screenshots convert -resize 75% $< $@ +html/screenshots/making-dcp.png: screenshots/making-dcp.png + mkdir -p html/screenshots + convert -resize 75% $< $@ # For HTML: convert graphics from SVG to PNG graphics/%.png: graphics/%.svg diff --git a/doc/manual/dcpomatic-pdf.xsl b/doc/manual/dcpomatic-pdf.xsl index 414fb64b8..c4ced0deb 100644 --- a/doc/manual/dcpomatic-pdf.xsl +++ b/doc/manual/dcpomatic-pdf.xsl @@ -9,7 +9,7 @@ 0 -scale=0.6 +scale=0.5 3 diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index dff11d4a6..c83345af1 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -10,6 +10,11 @@ ]> + + DCP-o-matic CarlHetherington @@ -247,11 +252,11 @@ select the content file to use, as shown in . -
- Adding content +
+ Adding content files - +
@@ -324,7 +329,7 @@ linkend="fig-making-dcp"/>. Making the DCP - +
@@ -424,7 +429,7 @@ to encode a single frame which it can then repeat. The previous chapters showed DCP generation using the default settings. DCP-o-matic offers a range of features to adjust the -content that goes into your DCP, and this describes those features in +content that goes into your DCP, and this chapter describes those features in detail. @@ -467,6 +472,332 @@ You can remove a piece of content by clicking on its name and then clicking the Remove button. + +
+Content Properties + + +Below the content list are the controls to set content properties. To +adjust the properties for a piece of content, click its name in the +content list. The content property controls will then become active +for that piece of content. + + + +The content properties are split up into four sections: +Video, Audio, +Subtitles and Timing. Not +all of these sections will be active for all content types. The controls +in each section are described below. + + +
+ +
+Video + + +The Video tab controls properties of the image, as shown in . + + +
+ Video settings tab + + + + + +
+ +
+Image type + + +The first 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 other option 3D +left/right tells DCP-o-matic to interpret the frame as a +left-right pair, as shown in . + + +
+ 3D left/right image type + + + + + +
+ + +This option can be used to generate a 3D DCP. Other means of creating +3D will be added in the future. + + +
+ + + +
+Filtering + + +The ‘filters’ settings allow you to apply various video +filters to the image. These may be useful to try to improve +poor-quality sources like DVDs. You can set up the filters by clicking the +Edit button next to the filters entry in the +setup area of the DCP-o-matic window; this opens the filters selector +as shown in . + + +
+ Filters selector + + + + + +
+ + +After changing the filters setup, you will need to regenerate the DCP +to see the effect on the cinema screen. The preview in DCP-o-matic +will update itself whenever filters are changed, though of course this +image is much smaller and of lower resolution than a projected image! + +
+ + + +
+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 Scale to option governs the shape that +DCP-o-matic will scale the content's image into. Select the aspect +ratio that your content should be presented in. + + +
+
+Video description + + +At the bottom of the video tab is a short description of what will +happen to your video with the current settings. In the example of +, DCP-o-matic is telling you that the +video file is 1920x1080 pixels (which is a ratio of 1.78:1). Since +the controls specify ‘Flat’ for the ratio, DCP-o-matic +scales the content image to 1998x1080, which is the DCI flat +resolution at 2K. + + + +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. + + + +
+ +
+ +
+Audio + + +The Audio tab controls properties of the image, as shown in . + + +
+ Audio settings tab + + + + + +
+ +
+Show audio + + +The Show Audio button will instruct DCP-o-matic +to examine the audio in your content and plot a graph of its level +over time. This can be useful for getting a rough idea of how loud +the sound will be in the cinema auditorium. A typical plot is shown +in + + +
+ Audio plot + + + + + +
+ + +The plot gives the audio level (vertical axis, in dB) with time +(horizontal axis). 0dB represents full scale, so if there is anything +near this you are in danger of clipping the projector's audio outputs. + + + +There are two plot types: the peak level and the RMS, which can be +shown or hidden using the check-boxes on the right hand side of the +window. + + + +The channel check-boxes will show or hide the plot(s) for +the corresponding channels in the DCP. + + + +The smoothing slider applies a variable degree of temporal smoothing +to the plots, which can make them easier to read in some cases. + + + +Obviously the audio plot is no substitute for listening in an +auditorium, but it can be useful to get levels in the right rough area. + + +
+ +
+The audio map + + +The section at the bottom of the audio tab is the ‘audio +map’. This governs how sound from the content will be arranged +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 +content channel will be copied into the corresponding DCP channel. + + + +Consider, for example, the case in . + + +
+ Audio map example 1 + + + + + +
+ + +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 + + +
+ Audio map example 2 + + + + + +
+ + +we now have the content's streams mapped to left and right and also +mixed together and placed in the DCP's centre channel. + + +
+ Audio map example 3 + + + + + +
+ + +As a final example, the map in +shows the mapping of a 5.1 source into a 5.1 DCP. + + +
+ +
+Other controls + + +‘Audio Gain’ is used to alter the volume of the +soundtrack. The specified gain (in dB) will be applied to each sound +channel of your content before it is written to the DCP. + + + +If you use a sound processor that DCP-o-matic knows about, it can help +you calculate changes in gain that you should apply. Say, for +example, that you make a test DCP and find that you have to run it at +volume 5 instead of volume 7 to get a good sound level in the screen. +If this is the case, click the Calculate... +button next to the audio gain entry, and the dialogue box in will open. + + +
+ Calculating audio gain + + + + + +
+ + +For our example, put 5 in the first box and 7 in the second and click +OK. DCP-o-matic will calculate the audio gain +that it should apply to make this happen. Then you can re-make the +DCP (this will be reasonably fast, as the video data will already have +been done) and it should play back at the correct volume with 7 on +your sound-rack fader. + + + +Current versions of DCP-o-matic only know about the Dolby CP750. If +you use a different sound processor, and know the gain curve of its +volume control, get in +touch. + + + +Audio Delay is used to adjust the synchronisation +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. + + +
@@ -574,35 +905,6 @@ probably not essential, but which you might find useful in some circumstances. -
-Filtering - - -DCP-o-matic offers a variety of filters that can be applied to your -video content. You can set up the filters by clicking the -Edit button next to the filters entry in the -setup area of the DCP-o-matic window; this opens the filters selector -as shown in . - - -
- Filters selector - - - - - -
- - -After changing the filters setup, you will need to regenerate the DCP -to see the effect on the cinema screen. The preview in DCP-o-matic -will update itself whenever filters are changed, though of course this -image is much smaller and of lower resolution than a projected image! - - -
-
Scaling @@ -829,156 +1131,7 @@ easier by setting the default folder that DCP-o-matic will offer in this dialogu See . -
-Setting up the content - - -Now there are a few things to set up to describe how the content you just added should be used. -created. The settings are divided into four tabs: video, audio, subtitles and timing. - - -
-Video content tab - - -This tab contains settings related to the video (i.e. the picture) of your content, as shown in . - - -
- Video settings tab - - - XXX: content video tab - - -
- -The default values in this tab are fine for our example, but the -options are described here anyway. - - -The first 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 other options allow the video to be -interpreted as 3D; this is described later in the manual. - XXX: link - - - -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 Scale to option governs the shape that -DCP-o-matic will scale the content's image into. Select the aspect -ratio that your content should be presented in. - - - -The ‘filters’ settings allow you to apply various video -filters to the image. These may be useful to try to improve -poor-quality sources like DVDs. We will discuss filtering later in the manual. - XXX: link - -
- -
-Audio tab - - -This tab contains settings related to the sound in your content, as shown in . - - -
- Audio settings tab - - - XXX: content audio tab - - -
- - -Once again, these settings can be left at their defaults for our Sintel example. - - - -The Show Audio button will instruct DCP-o-matic -to examine the audio in your content and plot a graph of its level -over time. This can be useful for getting a rough idea of how loud -the sound will be in the cinema auditorium. The audio graphic is -discussed in more detail later in the manual. - XXX: link - - - -‘Audio Gain’ is used to alter the volume of the -soundtrack. The specified gain (in dB) will be applied to each sound -channel of your content before it is written to the DCP. - - -If you use a sound processor that DCP-o-matic knows about, it can help -you calculate changes in gain that you should apply. Say, for -example, that you make a test DCP and find that you have to run it at -volume 5 instead of volume 7 to get a good sound level in the screen. -If this is the case, click the Calculate... -button next to the audio gain entry, and the dialogue box in will open. - - -
- Calculating audio gain - - - - - -
- - -For our example, put 5 in the first box and 7 in the second and click -OK. DCP-o-matic will calculate the audio gain -that it should apply to make this happen. Then you can re-make the -DCP (this will be reasonably fast, as the video data will already have -been done) and it should play back at the correct volume with 7 on -your sound-rack fader. - - - -Current versions of DCP-o-matic only know about the Dolby CP750. If -you use a different sound processor, and know the gain curve of its -volume control, get in -touch. - - - -Audio Delay is used to adjust the synchronisation -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. - - - -The final section in the audio tab is the ‘audio map’. -This governs how sound from the content will be arranged in the DCP. -Our Sintel clip is in 5.1, so DCP-o-matic will default to assigning -each channel from the content to the appropriate DCP channel. This -audio mapping is described in more detail later in the manual. - XXX: link - - -
Subtitles tab diff --git a/doc/manual/diagrams/3d-left-right.svg b/doc/manual/diagrams/3d-left-right.svg new file mode 100644 index 000000000..02df7092f --- /dev/null +++ b/doc/manual/diagrams/3d-left-right.svg @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + Lefteyeimage + Righteyeimage + + + + width + + width / 2 + + diff --git a/doc/manual/screenshots/audio-map-eg1.png b/doc/manual/screenshots/audio-map-eg1.png new file mode 100644 index 000000000..246c2e2d1 Binary files /dev/null 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 new file mode 100644 index 000000000..e2a9e1bb3 Binary files /dev/null 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 new file mode 100644 index 000000000..a1ebe3848 Binary files /dev/null and b/doc/manual/screenshots/audio-map-eg3.png differ diff --git a/doc/manual/screenshots/audio-plot.png b/doc/manual/screenshots/audio-plot.png new file mode 100644 index 000000000..80e2fe0a2 Binary files /dev/null and b/doc/manual/screenshots/audio-plot.png differ diff --git a/doc/manual/screenshots/audio-tab.png b/doc/manual/screenshots/audio-tab.png new file mode 100644 index 000000000..78b216793 Binary files /dev/null and b/doc/manual/screenshots/audio-tab.png differ diff --git a/doc/manual/screenshots/subtitles-tab.png b/doc/manual/screenshots/subtitles-tab.png new file mode 100644 index 000000000..4880d8391 Binary files /dev/null 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 new file mode 100644 index 000000000..31b120a52 Binary files /dev/null and b/doc/manual/screenshots/video-tab.png differ -- cgit v1.2.3