X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=3df603a85d55e83261011e911b730732eebaa094;hp=ef2ca87ee4c67935af300d94f7f5a04d040f7df2;hb=15a22a16c999a936f945d8620d2c64eb5248a505;hpb=495ba8f21d392ab638f7713efd9d69987515bb9d
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index ef2ca87ee..3df603a85 100644
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -16,7 +16,7 @@
-->
-DCP-o-matic
+DCP-o-matic users' manualCarlHetherington
@@ -27,6 +27,7 @@
Hello, and welcome to DCP-o-matic!
+
What is DCP-o-matic?
@@ -38,23 +39,23 @@ and AVI, or still images. The resulting DCPs will play on modern digital
cinema projectors.
-
-You might find it useful to make DVDs easier to present, to encode
-independently-shot feature films, or to generate local advertising for
-your cinema.
-
-
+
+
Licence
-DCP-o-matic is licensed under the GNU GPL.
+DCP-o-matic is free and open-source and is licensed under the GNU
+GPL.
+
+
Acknowledgements
@@ -65,14 +66,18 @@ This manual uses icons from the Tango
+
+
Installation
+
+
Windows
-To install DCP-o-matic on Windows, simply download the installer from
+To install DCP-o-matic on Windows, download the installer from
http://dcpomatic.com/
and double-click it. Click through the installer wizard, and
DCP-o-matic will be installed onto your machine.
@@ -89,12 +94,14 @@ version.
+
+
Mac OS X
DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and
-higher. To install it, download the DMG from .dmg from http://dcpomatic.com/ and double
click to open it. Then drag the DCP-o-matic icon to your
Applications folder or wherever else you would
@@ -108,8 +115,8 @@ like to install it.
You can install DCP-o-matic on Ubuntu 12.04 (‘Precise
-Pangolin’), 12.10 (‘Quantal Quetzal’) or 13.04
-(‘Raring Ringtail’) using .deb packages:
+Pangolin’), 14.04 (‘Trusty Tahr’) or 15.04
+(‘Vivid Vervet’) using .deb packages:
download the appropriate package from http://dcpomatic.com/ and
double-click it. Ubuntu will install the necessary bits and pieces
@@ -118,15 +125,48 @@ and set DCP-o-matic up for you.
+
+
+
+Debian Linux
+
+Packages are available for Debian 7 (squeeze), 8 (jessie) and unstable (sid) from http://dcpomatic.com/.
+
+
+
+
+
+
+Centos Linux
+
+Packages are available for Centos 6.5 and 7 from http://dcpomatic.com/.
+
+
+
+
+
+
+Arch Linux
+
+Packages for Arch Linux are available from https://aur.archlinux.org/packages/dcpomatic/,
+thanks to Stefan Karner.
+
+
+
+
+
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.
+Installation on other Linux systems (for which no packages are
+available) is quite hard; you will have to compile it from source. If
+you are using distribution for which no packages are available, do let
+me know by email and I
+will look into providing packages on the website.
@@ -139,8 +179,12 @@ The following dependencies are required:
ImageMagickBoostlibssh
-GTK
+GTK (on Linux)wxWidgets
+libxml++
+xmlsec
+curl
+libziplibdcplibcxml
@@ -165,7 +209,7 @@ With any luck, this will build and install DCP-o-matic on your system. To run i
-dcpomatic
+dcpomatic2
@@ -175,6 +219,8 @@ in a shell.
+
+
Creating a video DCP
@@ -207,11 +253,11 @@ shown in .
@@ -221,11 +267,11 @@ linkend="fig-video-new-film"/>.
@@ -240,6 +286,8 @@ will write its working files.
+
+
Adding content
@@ -253,21 +301,21 @@ select the content file to use, as shown in .
-
+
+
Creating a still-image DCP
@@ -367,12 +420,12 @@ As with video DCPs, the first step is to create a new
shown in .
-
- Dialogue box for creating a new film
+
+ Dialogue box for creating a new film
-
+
-
+
@@ -383,12 +436,12 @@ For our example, we will add a single image file, as shown in .
-
- Selecting a still content file
+
+ Selecting a still content file
-
+
-
+
@@ -396,16 +449,16 @@ linkend="fig-still-select-content-file"/>.
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 Play length setting, as shown in .
-
+The timing tab
-
+
-
+
@@ -424,6 +477,8 @@ to encode a single frame which it can then repeat.
+
+
Content settings
@@ -445,7 +500,7 @@ 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.
+audio and possibly some embedded subtitles; for example, a MOV, MP4 or VOB.
Sound — a file containing one or more channels of
@@ -459,13 +514,26 @@ 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.
+
+Subtitle — a file containing subtitle which will be
+superimposed on the image of the DCP. These can be
+.srt or .xml
+files.
+
+DCP — an existing DCP.
-To add one or more movie, sound or still-image files, select
+To add one or more movie, sound, still-image or subtitle files, select
Add file(s)... and choose them from the selector.
-To add a directory of images, choose Add
-directory... and do similar.
+
+
+
+To add a directory (folder) of images or a DCP, choose Add
+folder... and choose the directory from the selector. If
+you select a folder of images DCP-o-matic will open a small dialogue
+box where you can enter the frame rate that the image sequence should
+be run at.
@@ -474,6 +542,33 @@ clicking the Remove button.
+
+
+
+Adding existing DCPs
+
+Adding existing DCPs to a DCP-o-matic film is a little different
+to adding other types of content. Most content has to be converted to
+JPEG2000, the compression scheme used by DCPs, which is a very
+time-consuming process. Existing DCPs are already in JPEG2000 format
+so do not require conversion. This means that, provided no settings
+such as crop are used on the DCP content, picture and sound data will
+be passed from existing to new DCP unaltered.
+
+
+Encrypted DCPs that are added as content will require a KDM
+targeted at DCP-o-matic so that DCP-o-matic can decrypt them. You
+should ask the creator of the imported DCP to provide a KDM for
+DCP-o-matic's decryption certificate, which can be obtained by
+clicking Export DCP decryption certificate...
+from the Keys tab of the
+Preferences dialog (see ).
+
+
+
+
+
Content Properties
@@ -484,6 +579,13 @@ content list. The content property controls will then become active
for that piece of content.
+
+If you want to change the properties for multiple pieces of content at
+the same time, select the content in the list by clicking the first
+piece then clicking the other pieces with shift key
+held down. Note that not all settings can be changed in this way.
+
+
The content properties are split up into four sections:
Video, Audio,
@@ -494,6 +596,8 @@ in each section are described below.
+
+
Video
@@ -501,15 +605,17 @@ in each section are described below.
The Video tab controls properties of the image, as shown in .
-
+Video settings tab
-
+
-
+
+
+
Image type
@@ -517,23 +623,45 @@ The Video tab controls properties of the image, as shown in
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
+image as a standard 2D frame. The 3D
+left/right option tells DCP-o-matic to interpret the frame as a
left-right pair, as shown in .
-
+3D left/right image type
-
+
-
+
+
+
+
+
+Alternatively the 3D top/bottom option tells
+DCP-o-matic to see the frame as a top-bottom pair, as shown in .
+
+
+
+ 3D top/bottom image type
+
+
+
+
-This option can be used to generate a 3D DCP. Other means of creating
-3D will be added in the future.
+Another option is 3D alternate which takes the
+first frame of the content as for the left eye, the second for the
+right eye, the third for the left, and so on. Finally, you can
+specify 3D left only or 3D right
+only if this content contains only the the left or right
+eye images. This is useful when you have the left and right eye image
+sets in different files; you can specify one content as 3D
+left only and another as 3D right only
+and DCP-o-matic will pick up the appropriate frames from each.
@@ -552,12 +680,12 @@ setup area of the DCP-o-matic window; this opens the filters selector
as shown in .
-
- Filters selector
+
+ Filters selector
-
+
-
+
@@ -570,18 +698,94 @@ image is much smaller and of lower resolution than a projected image!
+
+
+
+Colour conversion
+
+
+The Colour conversion setting specifies what
+colour transforms and gamma correction DCP-o-matic will use when
+converting the selected content into the XYZ colourspace for the DCP.
+
+
+
+The easiest way to select the required conversion is to choose one of
+DCP-o-matic's presets. DCP-o-matic knows how to convert from four
+common colourspaces: sRGB, Rec. 601, Rec. 709 and P3. If you do not
+know which preset you should use, refer to the suggestions in .
+
+
+
+Suggested colour conversion settings
+
+
+
+
+
+sRGBStill images in RGB, e.g. photographs.
+
+
+Rec. 601Standard-definition content (fewer than about 1000 pixels across) including DVD rips.
+
+
+Rec. 709High-definition content including Blu-Ray rips.
+
+
+P3Content explicitly graded to P3.
+
+
+
+
- KDM email preferences
+
+ KDM email preferences
-
+
-
+
This is a template for the email that is used to send KDMs out to
-cinemas. You can change it to say whatever you like. The
-‘magic’ string $CPL_NAME will be replaced by
-DCP's title.
+cinemas. You can change it to say whatever you like. A few
+‘magic’ strings will be replaced by information from the
+KDM that is being sent:
+
+
+
+‘Magic’ KDM strings
+
+
+
+$CPL_NAMEDCP title
+
+
+$CINEMA_NAMECinema name
+
+
+$SCREENSName of screen or screens that KDMs are being generated for
+
+
+$START_TIMEThe time from which the KDMs are valid
+
+
+$END_TIMEThe time until which the KDMs are valid
+
+
+
+
+
+
+The Reset to default text will replace the current KDM email with DCP-o-matic's default.
-
+
+
+
+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.
+
+
+
+Only servers encode makes DCP-o-matic encode
+JPEG2000 data only on encoding servers and not on the host. We
+suggest you leave this un-ticked unless you have a good reason to do otherwise.
+
+
+
+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.
+
+
+
+
@@ -1359,29 +2142,35 @@ video frame and audio sampling rates as the DCP. This is not,
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.
+
+
Guaranteed rates
The only rates that are (pretty much) guaranteed to work on all DCI
-projectors is 24 frames per second (fps) for video and 48kHz or 96kHz
+projectors are 24 frames per second (fps) for video and 48kHz or 96kHz
for audio. If you are sending your DCPs to unknown places it wise to
consider using these rates if at all possible.
+
+
Other often-supported rates
@@ -1390,6 +2179,8 @@ Many projectors now in the wild support additional video frame rates:
+
+
Adapting content to fit the DCP rate
@@ -1421,7 +2212,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.
@@ -1432,6 +2223,8 @@ For very low or high frame rates, DCP-o-matic can also skip or duplicate frames.
+
+
Setting up
@@ -1439,7 +2232,7 @@ For very low or high frame rates, DCP-o-matic can also skip or duplicate frames.
The Frame Rate control in the
DCP tab sets the video frame rate that the DCP
will use. Clicking Use best sets the rate to
-what DVD-o-matic thinks is the best for your content. With this
+what DCP-o-matic thinks is the best for your content. With this
button, DCP-o-matic assumes that the whole range of frame rates (24,
25, 30 and 48fps) are allowable.
@@ -1450,6 +2243,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.
+
+
@@ -1472,6 +2274,8 @@ The master and server machines do not need to be the same type, so you
can mix Windows PCs, Macs and Linux machines as you wish.
+
+
Running the servers
@@ -1489,7 +2293,7 @@ To run the command line version, simply enter:
-dcpomatic_server_cli
+dcpomatic2_server_cli
@@ -1499,7 +2303,7 @@ by doing something like:
-dcpomatic_server_cli -t 4
+dcpomatic2_server_cli -t 4
@@ -1526,6 +2330,8 @@ without touching your standard operating system install.
+
+
Setting up DCP-o-matic
@@ -1538,6 +2344,8 @@ servers that DCP-o-matic has found.
+
+
Some notes about encode servers
@@ -1556,27 +2364,6 @@ provide a significant speed-up compared to a 100Mb/s network.
-
-Colour conversions
-
-
-As part of the encoding process, DCP-o-matic has to convert the colour
-space of the source files that you use into XYZ, the colour space used
-by the DCI standard.
-
-
-
-In order to do this, source colour is converted in three steps:
-
-
-
-Input gamma correction.
-Multiplication by a conversion matrix.
-Output gamma correction.
-
-
-
-
Generated files
@@ -1586,12 +2373,12 @@ linkend="fig-file-structure"/> shows the files that might be generated
after you have created a DCP for a film called ‘DCP Test’.
-
- Creating a new film
+
+ Creating a new film
-
+
-
+
@@ -1641,6 +2428,8 @@ to the cinema which is showing your DCP.
This chapter collects a few notes on bits of DCP-o-matic that do not fit elsewhere in the manual.
+
+
Resuming encodes