X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdvdomatic.xml;h=58315eca6ccb53cb28c7aa17df87819267599890;hb=6809fdcbf8c65afe3c986b0e2b430d55ce7b124c;hp=997a5695b983ee6ac062b122ce2f125c46a73d34;hpb=1dd701e960a38042b8aea2bfe01fa350e40fcf7f;p=dcpomatic.git
diff --git a/doc/manual/dvdomatic.xml b/doc/manual/dvdomatic.xml
index 997a5695b..58315eca6 100644
--- a/doc/manual/dvdomatic.xml
+++ b/doc/manual/dvdomatic.xml
@@ -40,6 +40,16 @@ your cinema.
+
+
+Licence
+
+
+DVD-o-matic is licensed under the GNU GPL.
+
+
+
+
@@ -52,17 +62,44 @@ your cinema.
To install DVD-o-matic on Windows, simply download the installer from
http://carlh.net
and double-click it. Click through the installer wizard, and
-DVD-o-matic will be installed to your machine.
+DVD-o-matic will be installed onto your machine.
+
+
+
+If you are using a 32-bit version of Windows, you will need the 32-bit
+installer. For 64-bit Windows, either installer will work, but I
+suggest you used the 64-bit version as it will allow DVD-o-matic to
+use more memory. You may find that DVD-o-matic crashes if you run
+many parallel encoding threads (more than 4) on the 32-bit
+version.
-Linux
+Ubuntu Linux
-Installation on Linux is currently a little involved, as there are no
-packages available (yet); you will have to compile it from source.
+You can install DVD-o-matic on Ubuntu 12.04 (‘Precise
+Pangolin’) or 12.10 (‘Quantal Quetzal’) using
+.deb packages: download the appropriate package from
+http://carlh.net and
+double-click it. Ubuntu will install the necessary bits and pieces
+and set DVD-o-matic up for you.
+
+
+
+
+
+Other Linux distributions
+
+
+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.
@@ -111,10 +148,12 @@ in a shell.
-Creating a video DCP with DVD-o-matic
+Creating a video DCP
-In this chapter we will see how to create a video DCP using DVD-o-matic.
+In this chapter we will see how to create a video DCP using
+DVD-o-matic. We will gloss over some of the finer details, which are
+explained in later chapters.
@@ -132,11 +171,10 @@ the low-resolution version to save everyone's bandwidth bills.
Now, start DVD-o-matic and its window will open. First, we will
-create a new film. A ‘film’ is how DVD-o-matic refers to
+create a new ‘film’. A ‘film’ is how DVD-o-matic refers to
a piece of content, along with some settings, which we will make into
a DCP. DVD-o-matic stores its data in a folder on your disk while it
-creates the DCP. will use to store its working files while it creates
-your DCP. You can create a new film by selecting
+creates the DCP. You can create a new film by selecting
New from the File menu, as
shown in .
@@ -152,14 +190,14 @@ shown in .
This will open a dialogue box for the new film, as shown in .
+linkend="fig-video-new-film"/>.
-
+Dialogue box for creating a new film
-
+
@@ -167,12 +205,19 @@ linkend="fig-new-film"/>.
In this dialogue box you can choose a name for the film. This will be
used to name the folder to store its data in, and also as the initial
-name for the DCP itself. You can also set whereabouts you want to create
+name for the DCP itself. You can also choose whereabouts you want to create
the film. In the example from the figure, DVD-o-matic will create a
folder called ‘DCP Test’ inside my home folder (carl) into which it
will write its working files.
+
+If you always create your DCPs in a particular folder, you can use
+DVD-o-matic's Preferences to make life a little
+easier by setting the default folder that DVD-o-matic will offer in this dialogue.
+See .
+
+
@@ -181,9 +226,9 @@ will write its working files.
The next step is to set the content that you want to use. Click the
content selector, as shown in and the a file chooser will
+linkend="fig-click-content-selector"/>, and a file chooser will
open for you to select the content file to use, as shown in .
+linkend="fig-video-select-content-file"/>.
@@ -195,24 +240,24 @@ linkend="fig-select-content-file"/>.
-
- Selecting the content file
+
+ Selecting a video content file
-
+
Select your content file and click Open. In this
-case, we are using the Sintel trailer that we downloaded earlier.
+case we are using the Sintel trailer that we downloaded earlier.
-When you do this, DVD-o-maticw will take a look at your file. After a
-short while (when the progress bars at the bottom right of the window
-have finished), you can look through your content using the slider to
+When you do this, DVD-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 .
@@ -226,7 +271,13 @@ the right of the window, as shown in .
-Dragging the slider will move through your video.
+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
+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
+such as Totem, mplayer or VLC.
@@ -236,43 +287,103 @@ Dragging the slider will move through your video.
Now there are a few things to set up to describe how the DCP should be
-created, as shown in .
+created. The settings are divided into four tabs: film, video, audio and subtitles.
-
- Setting up
+
+Film tab
+
+
+The ‘film’ tab contains settings that pertain to the whole film, as shown in .
+
+
+
+ Film settings tab
-
+
-The first thing is the content type. This can be
+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.
+
+
+
+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.
+
+
+
+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 Trust content's header button starts off
+checked, and this means that DVD-o-matic will use the content's header
+information to determine its length. If, for some reason, this header
+length is wrong, uncheck the Trust content's
+header button and DVD-o-matic will run through the content
+to find its exact length. This may take a while for large pieces of content.
+
+
+
+Next up is the content type. This can be
‘feature’, ‘trailer’ or whatever; select the
required type from the drop-down list.
-Next is the format. This will govern the shape that DVD-o-matic will
-make your image into. Select the aspect ratio that your content
-should be presented in. The ‘4:3 within Flat’ and
-‘16:9 within Flat’ settings will put the image at the
-specified ratio within a Flat (1.85:1) frame, so that you can project
-the DCP using your projector's Flat preset.
+The trim frames settings allow you to trim frames
+from the beginning and end of the content; any trimmed frames will not
+be included in the DCP.
+
+
+
+
+
+Video tab
+
+
+This tab contains settings related to the picture in your DCP, as shown in .
+
+
+
+ Video settings tab
+
+
+
+
+
+
+
+
+The first option on this tab is the format. This will govern the
+shape that DVD-o-matic will make your image into. Select the aspect
+ratio that your content should be presented in. The ‘4:3 within
+Flat’ and ‘16:9 within Flat’ settings will put the
+image at the specified ratio within a Flat (1.85:1) frame, so that you
+can project the DCP using your projector's Flat preset.
The remaining options can often be left alone, but may sometimes be
useful. The ‘crop’ settings can be used to crop your
-content, which can be useful to remove black borders from round the
-edges of DVD images, for example. The L,
-R, T and
-B settings correspond to the left, right, top and
-bottom of the image respectively. The specified number of pixels will
-be trimmed from each edge, and your content image in the right of the
-window will be updated to show the cropping in action.
+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.
@@ -290,24 +401,532 @@ most situations.
+
+The ‘colour look-up table’ specifies the colour space that
+your input content will be expected to be in. If in doubt, leave it
+set to ‘sRGB’.
+
+
+
+Finally, 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).
+
+
+
+
+
+Audio tab
+
+
+This tab contains settings related to the sound in your DCP, as shown in .
+
+
+
+ Audio settings tab
+
+
+
+
+
+
+
+
‘Audio Gain’ is used to alter the volume of the
soundtrack. The specified gain (in dB) will be applied to each sound
channel before it is written to the DCP.
+
+If you use a sound processor that DVD-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. DVD-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 DVD-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.
-
+
+By default the Use content‘s audio button
+will be selected. This means that the DCP will use one of the
+soundtracks from your content file; you can select the soundtrack that
+you wish to use from the drop-down box.
+
-
+
+Note that if your content's audio is mono, DVD-o-matic will place it
+in the centre channel in the DCP.
+
+
+
+Alternatively, you can supply different sound files by clicking the
+Use external audio button and choosing a WAV file
+for any channels that you want to appear in the DCP. These files can
+be any bit depth and sampling rate, and will be re-sampled and
+bit-depth converted if required.
+
+
+Subtitles tab
+
+
+This tab contains settings related to subtitles in your DCP, as shown in .
+
+
+ Subtitle settings tab
+
+
+
+
+
+
+
+
+DVD-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.
+
+
+
+Future versions of DVD-o-matic will hopefully include the option to
+use text subtitles (as is the norm with most professionally-mastered
+DCPs).
+
+
+
+
+
+
+Making the DCP
+
+
+Now that we have set everything up, choose Make
+DCP from the Jobs menu. DVD-o-matic
+will encode your DCP. This may take some time (many hours in some
+cases). While the job is in progress, DVD-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 directory. You can then copy this to a projector via a USB
+stick, hard-drive or network connection.
+
+
+
+Alternatively, if you have a projector or TMS that is accessible via
+SCP across your network, you can upload the content directly from
+DVD-o-matic. See .
+
+
+
+
+
+Creating a still-image DCP
+
+
+DVD-o-matic can also be used to create DCPs of a still image, 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 DVD-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 DVD-o-matic only needs
+to encode a single frame which it can then repeat.
+
+
+
+
+
+
+Preferences
+
+
+DVD-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 DVD-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 DVD-o-matic is encoding DCPs it can use multiple parallel threads
+to speed things up. Set this value to the number of threads
+DVD-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 which DVD-o-matic will suggest initially as a place to put new films.
+
+
+
+
+
+A/B options
+
+
+These options are for DVD-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
+
+
+If you have spare machines sitting around on your network not doing
+much, they can be pressed into service to speed up DCP encodes. This
+is done by running a small server program on the machine, which will
+encode video sent to it by the ‘master’ DVD-o-matic. This
+option is described in more detail in .
+Use these preferences to specify the encoding servers that should be
+used.
+
+
+
+
+
+
+
+
+Advanced topics
+
+This chapter describes some parts of DVD-o-matic that are
+probably not essential, but which you might find useful in some
+circumstances.
+
+
+
+Filtering
+
+
+DVD-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 DVD-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 DVD-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
+
+
+If your source material is not of the DCI-specified size, or if it
+uses non-square pixels, DVD-o-matic will need to scale it. The
+algorithm used to scale is set up by the Scaler
+entry in the film setup area. We think ‘Bicubic’ is the
+best all-round option, but tests are ongoing.
+
+
+
+
+
+TMS upload
+
+
+If you have configured details of a TMS in the preferences dialogue
+() you can upload a completed DCP
+straight to your TMS buy choosing Send DCP to TMS
+from the Jobs menu.
+
+
+
+
+
+
+A/B comparison
+
+
+When evaluating the effects of different filters or scalers on the
+image quality, A/B mode might be useful. In this mode, DVD-o-matic
+will generate a DCP where the left half of the image uses some
+‘reference’ filtering and scaling, and the right half of
+the image uses a different set of filters and a different scaler.
+This DCP can then be played back on a projector and the image quality
+evaluated.
+
+
+
+To enable A/B mode, click the A/B checkbox in the setup area of the
+DVD-o-matic window. When you generate your DCP, the left half of the
+screen will use the filters and scaler specified in the preferences dialogue, and the right
+half will use the filters and scaler specified in the film setup.
+
+
+
+
+
+Encoding servers
+
+
+One way to increase the speed of DCP encoding is to use more
+than one machine at the same time. An instance of DVD-o-matic can
+offload some of the time-consuming JPEG2000 encoding to any number of
+other machines on a network. To do this, one ‘master’
+machine runs DVD-o-matic, and the ‘server’ machines run
+a small program called ‘servomatic’.
+
+
+
+Running the servers
+
+
+There are two options for the encoding server;
+servomatic_cli, which runs on the command line, and
+servomatic_gui, which has a simple GUI. The command line
+version is well-suited to headless servers, especially on Linux, and
+the GUI version works best on Windows where it will put an icon in the
+system tray.
+
+
+
+To run the command line version, simply enter:
+
+
+
+servomatic_cli
+
+
+
+at a command prompt. If you are running the program on a machine with
+a multi-core processor, you can run multiple parallel encoding threads
+by doing something like:
+
+
+
+servomatic_cli -t 4
+
+
+
+to run 4 threads in parallel.
+
+
+
+To run the GUI version on windows, run the ‘DVD-o-matic encode
+server’ from the start menu. An icon will appear in the system
+tray; right-click it to open a menu from whence you can quit the
+server or open a window to show its status.
+
+
+
+
+Setting up DVD-o-matic
+
+
+Once your servers are running, you need to tell your master
+DVD-o-matic instance about them. Start DVD-o-matic and open the
+Preferences dialog from the
+Edit menu. At the bottom of this dialog is a
+section where you can add, edit and remove encoding servers. For each
+encoding server you need only specify its IP address and the number of
+threads that it is running, so that DVD-o-matic knows how many
+parallel encode jobs to send to the server.
+
+
+
+Once this is done, any encodes that you start will split the workload
+up between the master machine and the servers.
+
+
+
+
+Some notes about encode servers
+
+
+DVD-o-matic does not mind if servers come and go; if a server
+disappears, DVD-o-matic will stop sending work to it, and will check
+it every minute or so in case it has come back online.
+
+
+
+You will probably find that using a 1Gb/s or faster network will
+provide a significant speed-up compared to a 100Mb/s network.
+
+
+
+Making changes to the server configuration in the master DVD-o-matic
+will have no effect while an encode is running; the changes will only
+be noticed when a new encode is started.
+
+
+
+
+
+
+
+