From 424f70766c4acc8519633dd72f0d31dd93798bfb Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Fri, 26 Jul 2013 15:34:22 +0100 Subject: Manual work. --- doc/manual/dcpomatic.xml | 873 +++++++++++++++++++++++++---------------------- 1 file changed, 465 insertions(+), 408 deletions(-) (limited to 'doc') diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 68c73b84f..e6e253e2b 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -174,8 +174,7 @@ in a shell. In this chapter we will see how to create a video DCP using -DCP-o-matic. We will gloss over some of the finer details, which are -explained in later chapters. +DCP-o-matic. We will gloss over the details and look at the basics.
@@ -201,7 +200,7 @@ creates the DCP. You can create a new film by selecting shown in . -
+
Creating a new film @@ -215,7 +214,7 @@ This will open a dialogue box for the new film, as shown in . -
+
Dialogue box for creating a new film @@ -233,19 +232,6 @@ folder called ‘DCP Test’ inside my home folder (carl) into which it will write its working files. - -The folder that you choose should have plenty of free disc space -available. As a very rough guide, you will need about 25Mb per second -of your DCP. This works out at 1.5Gb per minute, or 90Gb per hour. - - - -If you always create your DCPs in a particular folder, you can use -DCP-o-matic's Preferences to make life a little -easier by setting the default folder that DCP-o-matic will offer in this dialogue. -See . - -
@@ -255,7 +241,7 @@ See . The next step is to add the content that you want to use. DCP-o-matic can make DCPs from multiple pieces of content, but in this simple example we will just use a single piece. Click the Add -file... button, and a file chooser will open for you to +file(s)... button, and a file chooser will open for you to select the content file to use, as shown in . @@ -287,14 +273,14 @@ case we are using the Sintel trailer that we downloaded earlier. When you do this, DCP-o-matic will take a look at your file. After a short while (when the progress bar at the bottom right of the window has finished), you can look through your content using the slider to -the right of the window, as shown in . +the right of the window, as shown in . -
+
Examining the content - +
@@ -311,487 +297,245 @@ such as Totem, <
-
-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 +Making the DCP + +In most cases, some adjustments would be made to DCP-o-matic's +settings once the content has been added. For our simple test, +however, the default values will suffice, so we can go straight onto +making the DCP. -This tab contains settings related to the video (i.e. the picture) of your content, as shown in . +Choose Make DCP from the +Jobs menu. DCP-o-matic will encode your DCP. +This may take some time (many hours in some cases). While the job is +in progress, DCP-o-matic will update you on how it is getting on with +the progress bar in the bottom of its window, as shown in . -
- Video settings tab +
+ Making the DCP - +
-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. - +When it has finished, the DCP will end up on your disk inside the +film's folder. You can then copy this to a projector via a USB +stick, hard-drive or network connection. See for details about the files that DVD-o-matic creates. -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. +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 . +
+ + + +Creating a still-image DCP + -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. +DCP-o-matic can also be used to create DCPs of one or more still images, perhaps +for an advertisement or an on-screen announcement. This chapter shows you +how to do it. -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. - +As with video DCPs, the first step is to create a new +‘Film’; select New from the +File menu and the new film dialogue will open as +shown in . -
-
-Audio tab +
+ Dialogue box for creating a new film + + + + + +
-This tab contains settings related to the sound in your content, as shown in . +Enter a name and click OK. Now we need to add +the content. As before, click Add file(s).... +For our example, we will add a single image file, as shown in . -
- Audio settings tab +
+ Selecting a still content file - +
-Once again, these settings can be left at their defaults for our Sintel example. +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 . - -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. - - + -‘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. +This length is a ‘timecode’: it consists of four numbers. +The first is hours, the second minutes, the third seconds, and the +fourth frames. Enter the duration that you want and then click Set. -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. +Finally, as with video, you can choose Make DCP +from the Jobs menu to create your DCP. This will +be much quicker than creating a video DCP, as DCP-o-matic only needs +to encode a single frame which it can then repeat. -
- 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. - + +Handling content -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. +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 +detail. +
+Adding and removing content + -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. +At the top of the Content tab is a list of the +content that will go into our DCP. There can be as many pieces of +content as you like, and they can be of the following types: + +Movie — a file containing some video, probably some +audio and possibly some subtitles; for example, a MOV, MP4 or VOB. + + +Sound — a file containing one or more channels of +audio; for example, a WAV or AIFF file. + + +Still image — a file containing a single still image; for +example, a JPEG, PNG or TIFF file. + + +Moving image — a directory containing many still +images which should be treated as the frames of a video. + + + -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. +To add one or more movie, sound or still-image files, select +Add file(s)... and choose them from the selector. +To add a directory of images, choose Add +directory... and do similar. -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. - +You can remove a piece of content by clicking on its name and then +clicking the Remove button.
+ + + +Preferences + + +DCP-o-matic provides a few preferences which can be used to modify its +behaviour. This chapter explains those options. + +
-Subtitles tab +The preferences dialogue -This tab contains settings related to subtitles in your content, as shown in . +The preferences dialogue is opened by choosing +Preferences... from the Edit +menu. The dialogue is shown in . -
- Subtitle settings tab +
+ Preferences - +
+
+TMS setup + -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). 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 checkbox to enable -subtitles. The offset control moves the -subtitles up and down the image, and the scale -control changes their size. +The first part of the dialogue gives some options for specifying +details about your TMS. If you do this, and your TMS accepts SSH +connections, you can upload DCPs directly from DCP-o-matic to the TMS. +This is discussed in . -All being well, future versions of DCP-o-matic will include the option to -use text subtitles (as is the norm with most professionally-mastered -DCPs). +TMS IP address should be set to the IP address of +your TMS, TMS target path to the place that DCPs +should be uploaded to (which will be relative to the home directory of +the SSH user). Finally, the user name and password are the +credentials required to log into the TMS via SSH. - -
-Setting up the DCP +Threads -Now that we have set up the content that will go into our DCP, we can -set things up for the DCP itself. This is done from the -DCP tab which can be found at the top of the -DCP-o-matic window (next to the Content tab). -The DCP tab is shown in foo. +When DCP-o-matic is encoding DCPs it can use multiple parallel threads +to speed things up. Set this value to the number of threads +DCP-o-matic should use. This would typically be set to the number of +processors (or processor cores) in your machine. - +
- -The first thing here is the name. This is generally set to the title -of the film that is being encoded. If Use DCI -name is not ticked, the name that you specify will be used -as-is for the name of the DCP. If Use DCI name -is ticked, the name that you enter will be used as part of a -DCI-compliant name. Set the name to something useful, like -‘Sintel’. - +
+Default directory for new films -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 checkbox. The DCI 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 -open by clicking on the Details button. +This is the directory (folder) which DCP-o-matic will suggest initially as a place to put new films. - -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 Container option sets the ratio of the image -in the DCP. If this ratio is different to the ratio used for any -content, DCP-o-matic will pad the content with black. In simple cases -this should be set to the same ratio as that for the the primary piece -of video content. Alternatively, you might want to pillarbox a small -format into a Flat container: in this case, select the small format -for the content's ratio and ‘Flat’ for the DCP. - +
+A/B options -Next up is the content type. This can be -‘feature’, ‘trailer’ or whatever; select the -required type from the drop-down list. +These options are for DCP-o-matic's special mode of making A/B +comparison DCPs for checking the performance of video filters. Their +use is described in . - -The Frame Rate control sets the frame rate of -your DCP. This can be a little tricky to get right. Ideally, you -want it to be the same as the video content that you are using. If it -is not the same, DCP-o-matic must resort to some tricks to alter your -content to fit the specified frame rate. Frame rates are discussed in more detail later. - - - - -The Use best button sets the DCP video frame rate -to what DCP-o-matic thinks is the best given the content that you have -added. - - - -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. - - - -The 3D button will set your DCP to 3D mode if it -is checked. This is discussed later. - - - - -The Resolution tab allows you to choose the -resolution for your DCP. Use 2K unless you have content that is of -high enough resolution to be worth presenting in 4K. - - - -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 (MBps). - - - -Finally, the scaler is the method that will be used to scale up -your content to the required size for the DCP, if required. We will -discuss the options in more detail later; Bicubic is a fine choice in -most situations. - - - -
- - -
-Making the DCP - - -Now that we have set everything up, choose Make -DCP from the Jobs menu. DCP-o-matic -will encode your DCP. This may take some time (many hours in some -cases). While the job is in progress, DCP-o-matic will update you on -how it is getting on with the progress bar in the bottom of its window, as shown in . - - -
- Making the DCP - - - - - -
- - -When it has finished, the DCP will end up on your disk inside the -film's folder. You can then copy this to a projector via a USB -stick, hard-drive or network connection. See for details about the files that DVD-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 . - - -
- - - - -Creating a still-image DCP - - -DCP-o-matic can also be used to create DCPs of one or more still images, perhaps -for an advertisement or an on-screen announcement. This chapter shows you -how to do it. - - - -As with video DCPs, the first step is to create a new -‘Film’; select New from the -File menu and the new film dialogue will open as -shown in . - - -
- Dialogue box for creating a new film - - - - - -
- - - - -Enter a name and click OK. Then we set up the -content; click the content selector as before, and this time we will -choose an image file, as shown in . - - -
- Selecting a still content file - - - - - -
- - -Setting up for a still image DCP is somewhat simpler than for a video; -the tabs are all the same, but many options are removed and a few are added. - - - -As with video, you can select a content type and the format (ratio) -that your image should be presented in. It will be scaled and padded -to fit the selected ratio, but in such a way that the pixel aspect -ratio is preserved. In other words, the image will not be stretched, -merely scaled; if you want to stretch your image, you will need to do -so in a separate program before importing it into DCP-o-matic. You -can also crop your image, if you so choose, and then set a duration -(in seconds) that the image should appear on screen. - - - -Still-image DCPs can include sound; this can be added from the -Audio tab. If your specified duration is shorter -than the audio, the audio will be cut off at the duration; if it is -longer, silence will be added after your audio. - - - -Finally, as with video, you can choose Make DCP -from the Jobs menu to create your DCP. This will -be much quicker than creating a video DCP, as DCP-o-matic only needs -to encode a single frame which it can then repeat. - - - - - - -Preferences - - -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 shown in . - - -
- Preferences - - - - - -
- -
-TMS setup - - -The first part of the dialogue gives some options for specifying -details about your TMS. If you do this, and your TMS accepts SSH -connections, you can upload DCPs directly from DCP-o-matic to the TMS. -This is discussed in . - - - -TMS IP address should be set to the IP address of -your TMS, TMS target path to the place that DCPs -should be uploaded to (which will be relative to the home directory of -the SSH user). Finally, the user name and password are the -credentials required to log into the TMS via SSH. - -
- -
-Threads - - -When DCP-o-matic is encoding DCPs it can use multiple parallel threads -to speed things up. Set this value to the number of threads -DCP-o-matic should use. This would typically be set to the number of -processors (or processor cores) in your machine. - - -
- -
-Default directory for new films - - -This is the directory (folder) which DCP-o-matic will suggest initially as a place to put new films. - - -
- -
-A/B options - - -These options are for DCP-o-matic's special mode of making A/B -comparison DCPs for checking the performance of video filters. Their -use is described in . - - -
+
Encoding servers @@ -1055,3 +799,316 @@ to the cinema which is showing your DCP. + + + \ No newline at end of file -- cgit v1.2.3