X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdvdomatic.xml;h=58315eca6ccb53cb28c7aa17df87819267599890;hb=6809fdcbf8c65afe3c986b0e2b430d55ce7b124c;hp=b222c1cd4a3819f4c1bec6affd479246585e9316;hpb=715f6c0d2a7782d2410340745af02b68e0a00d86;p=dcpomatic.git
diff --git a/doc/manual/dvdomatic.xml b/doc/manual/dvdomatic.xml
index b222c1cd4..58315eca6 100644
--- a/doc/manual/dvdomatic.xml
+++ b/doc/manual/dvdomatic.xml
@@ -48,8 +48,8 @@ your cinema.
DVD-o-matic is licensed under the GNU GPL.
-
+
@@ -65,14 +65,41 @@ and double-click it. Click through the installer wizard, and
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.
@@ -117,87 +144,6 @@ dvdomatic
in a shell.
-
-Obtaining dependencies on Ubuntu 12.04
-
-
-Ubuntu 12.04 packages most of DVD-o-matic's dependencies, but some are missing. This section
-describes how to obtain all of the dependencies.
-
-
-
-Packaged dependencies
-
-
-Most of the dependencies can be obtained from Ubuntu's packages using:
-
-
-
-sudo apt-get install libwxgtk2.8-dev libsndfile1-dev libssl-dev libssh-dev
-sudo apt-get install libmagickcore-dev libboost-filesystem-dev libboost-thread-dev
-
-
-
-
-
-Unpackaged dependencies
-
-
-
-FFmpeg
-
-
-Ubuntu does not package FFmpeg, so you will need to build it from source. The
-following commands should work:
-
-
-
-git clone git://source.ffmpeg.org/ffmpeg.git ffmpeg
-cd ffmpeg
-./configure --enable-shared --enable-postproc --enable-gpl
-make
-sudo make install
-
-
-
-
-
-libdcp
-
-
-You can build libdcp using:
-
-
-
-wget http://carlh.net/software/libdcp-0.20.tar.bz2
-tar xjf libdcp-0.20.tar.bz2
-cd libdcp-0.20
-./waf configure
-./waf build
-sudo ./waf install
-
-
-
-
-
-libopenjpeg
-
-
-Ubuntu does package libopenjpeg, but it is a rather old version. To build
-the current release:
-
-
-
-wget http://code.google.com/p/openjpeg/downloads/detail?name=openjpeg-1.5.1.tar.gz
-tar xzf openjpeg-1.5.1.tar.gz
-cd openjepg-1.5.1.tar.gz
-./configure
-make
-sudo make install
-
-
-
-
@@ -259,12 +205,19 @@ linkend="fig-video-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 .
+
+
@@ -273,7 +226,7 @@ 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 .
@@ -298,13 +251,13 @@ linkend="fig-video-select-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-matic 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
+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 .
@@ -318,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.
@@ -328,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 to make a video DCP
+
+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 used 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.
+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.
@@ -382,6 +401,38 @@ 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
@@ -430,10 +481,61 @@ with respect to the video, and a negative delay will move it earlier.
-The Range controls allow you to specify a part of
-your content to encode. We will discuss this later.
+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).
+
+
+
@@ -444,8 +546,7 @@ 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 right hand
-corner of its window, as shown in .
+how it is getting on with the progress bar in the bottom of its window, as shown in .
@@ -463,6 +564,12 @@ 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 .
+
+
@@ -510,24 +617,25 @@ linkend="fig-still-select-content-file"/>.
Setting up for a still image DCP is somewhat simpler than for a video;
-the options are shown in .
+the tabs are all the same, but many options are removed and a few are added.
-
- Setting up to make a still DCP
-
-
-
-
-
-
-
As with video, you can select a content type and the format (ratio)
-that your image should be presented in. It will be scaled to fit the
-selected ratio. You can also crop your image, if you so choose, and
-then set a duration (in seconds) that the image should appear on
-screen.
+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.
@@ -598,11 +706,10 @@ processors (or processor cores) in your machine.
-Colour look-up table
+Default directory for new films
-This specifies the colour space that your input content will be
-expected to be in. If in doubt, leave it set to ‘sRGB’.
+This is the directory which DVD-o-matic will suggest initially as a place to put new films.
@@ -664,20 +771,11 @@ as shown in .
-
-As it stands, these filters are somewhat disorganised! Work is
-ongoing to test them with various content and choose a selection which
-work well for cinema applications.
-
-
-
-If you want to examine them yourself, you may find the A/B option (see
-) useful.
-
-
After changing the filters setup, you will need to regenerate the DCP
-to see the effect on-screen.
+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!
@@ -695,13 +793,13 @@ 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 but choosing Send DCP to TMS
+straight to your TMS buy choosing Send DCP to TMS
from the Jobs menu.
@@ -731,42 +829,103 @@ 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’.
+
-Encode range
+Running the servers
-If you want to encode only a portion of your input content, you can do
-so by clicking the Edit button next to the
-Range entry in the film setup area. This will
-open the dialogue shown in .
+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.
-
- Range selector
-
-
-
-
-
-
+
+To run the command line version, simply enter:
+
+
+
+servomatic_cli
+
-Here you can choose to encode the whole film, or just the first
-so-many frames of it. This can be useful to check the quality of an
-encode before comitting to encoding the whole film — perhaps
-just encode the first ten minutes, look at it on screen, and check
-that it is ok.
+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
+
+
-If you choose to encode only a part of the film, you can set
-DVD-o-matic to black out the rest. This can be useful to chop a small
-part off the end of a piece of content while letting the audio play
-out.
+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.
+
+
+
+
+