X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=5dcffaa402f700abae758f7540bf6c55d1c319dd;hb=67e0f33b573a07821695b6e8f883818415f93bb8;hp=72bbedb56c89ea7aa812fb0fa505eec1448202c7;hpb=154be392632ffb5a95cce71a824ede728f32dd09;p=dcpomatic.git
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 72bbedb56..5dcffaa40 100644
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -26,15 +26,15 @@ Hello, and welcome to DCP-o-matic!
What is DCP-o-matic?
-DCP-o-matic is a set of programs to perform the following tasks:
+DCP-o-matic is a set of tools to allow you to:
- Creation of Digital
- Cinema Packages (DCPs) from video, audio and/or
- subtitle and closed caption files.
- Playback and verification of DCPs on a PC/Mac.
- Creation of KDMs for DCPs.
+ Create Digital
+ Cinema Packages (DCPs) from video, audio, subtitle and closed-caption files.
+ Play and verify DCPs (see and ).
+ Create KDMs for DCPs (see ).
+ Write cinema-format drives containing DCPs (see ).
@@ -46,7 +46,7 @@ Hello, and welcome to DCP-o-matic!
DCP-o-matic is free and open-source and is licensed under the GNU
+url="https://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU
GPL.
@@ -72,7 +72,7 @@ This manual presents bits of DCP-o-matic's user interface (such as menu items or
-Notes of an advanced nature are presented like this. Ignore them unless you want to know the gory details.
+Notes of an advanced nature are presented like this. Ignore them unless you want to know the details.
@@ -90,25 +90,14 @@ Notes of an advanced nature are presented like this. Ignore them unless you wan
To install DCP-o-matic on Windows, download the installer from
-http://dcpomatic.com/
+https://dcpomatic.com/
and double-click it. Click through the installer wizard, and
DCP-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 DCP-o-matic to
-use more memory. You may find that DCP-o-matic crashes if you run
-many parallel encoding threads (more than 4) on the 32-bit
-version.
-
-
-
-If you are still using Windows XP, download the specific XP version as
-it should be more stable on your machine than the ‘normal’
-Windows version. Be aware, though, that support for Windows XP will
-not last forever and you should plan to upgrade if at all possible.
+Use the 64-bit installer unless you are using a 32-bit version of Windows.
+You may find that DCP-o-matic crashes if run the 32-bit version on a CPU with more than 4 cores.
@@ -116,42 +105,33 @@ not last forever and you should plan to upgrade if at all possible.
-Mac OS X
+macOS
-DCP-o-matic will run on Mac OS X version 10.6 (Snow Leopard) and
-higher. DCP-o-matic is split into five separate applications, each of
+DCP-o-matic versions 2.16.0 and higher will run on macOS version 10.8 (Mountain Lion) and
+higher. DCP-o-matic is split into eight separate applications, each of
which can be installed by downloading the .dmg,
double-clicking to open and then dragging the icon to your
Applications folder.
-If you are not sure which parts of DCP-o-matic to install, start
+If you don't know which parts of DCP-o-matic to install, start
with the first (main) part.
+
+If you are using macOS 10.7 (Lion) or older you will need to install the latest 2.14.x version of DCP-o-matic.
+
+
-Debian, Ubuntu or Mint Linux
-
-
- You can install DCP-o-matic on:
-
+Debian, Ubuntu and Mint Linux
-
- Debian 7 (‘wheezy’), 8 (‘jessie’), 9 (‘squeeze’) and unstable (‘sid’)
- Ubuntu 14.04 (‘Trusty Tahr’), 16.04 (‘Xenial Xerus’), 18.04 (‘Bionic Beaver’) and 18.10 (‘Cosmic Cuttlefish’)
- Mint 17, 18 and 19
-
-
-
-using .deb packages: download the appropriate package
-from http://dcpomatic.com/
-and double-click it. Debian, Ubuntu or Mint will install the necessary bits and
-pieces and set DCP-o-matic up for you.
+There are .deb packages for Debian, Ubuntu and Mint on
+ https://dcpomatic.com/
@@ -161,8 +141,8 @@ pieces and set DCP-o-matic up for you.
Fedora, Centos and Mageia Linux
- There are .rpm packages for Fedora 27, 28 and 29, Centos 6 and 7 and Mageia 6 on
- http://dcpomatic.com/
+ There are .rpm packages for Fedora, Centos and Mageia on
+ https://dcpomatic.com/
@@ -177,99 +157,14 @@ thanks to Stefan Karner.
-
-
-Other Linux distributions
-
+Building from source
-Installation on other Linux systems (for which no packages are
-available) is quite hard as it must be compiled from source. If you
-can't download packages for your distribution, do let me know by
-email and I will look
-into providing packages on the website.
-
-
-
-The following dependencies are required:
-
-FFmpeg
-libsndfile
-libsamplerate
-OpenSSL
-libopenjpeg
-Boost
-libssh
-GTK (on Linux)
-wxWidgets
-libxml++
-xmlsec
-curl
-libzip
-asdcplib with some patches
-libdcp
-libsub
-libcxml
-locked_sstream
-rtaudio
-libicu
-
+Since DCP-o-matic is open-source you can also build it yourself,
+though this can be quite a difficult process (especially on Windows and macOS).
+There are instructions for how to do it on https://dcpomatic.com/building
-
-
-Once you have installed the development packages for the dependencies,
-download the source code from http://dcpomatic.com/,
-unpack it and run the following commands from inside the source
-directory:
-
-
-
-./waf configure --disable-tests
-./waf build
-sudo ./waf install
-
-
-
-With any luck, this will build and install DCP-o-matic on your system. To run it, enter:
-
-
-
-dcpomatic2
-
-
-
-in a shell.
-
-
-
-
-
-‘Simple’ and ‘Full’ modes
-
-When you start DCP-o-matic for the first time it will ask you if
-you want to use ‘simple’ or ‘full’ mode.
-
-
-The difference between these two is that some of DCP-o-matic's
-more complex or less-used controls are hidden from view in
-‘Simple’ mode. This makes the interface simpler to
-navigate. You may wish to choose this mode if you do not have much
-experience with video processing.
-
-
-Even if you choose ‘Simple’ mode you can always go
-back to ‘Full’ mode by changing the Interface
-complexity setting in the General tab
-of Preferences.
-
-
-
-All the screenshots in this manual are from a copy of DCP-o-matic in ‘Full’ mode.
-
-
-
@@ -294,15 +189,19 @@ movie Sintel from their
website. Generally one would want to use the
highest-resolution material available, but for this test we will use
-the low-resolution version to save everyone's bandwidth bills.
+the low-resolution version to save on download time.
Now, start DCP-o-matic and its window will open. First, we will
create a new ‘film’. A ‘film’ is how DCP-o-matic refers to
some pieces of content, along with some settings, which we will make into
-a DCP. DCP-o-matic stores its data in a folder on your disk while it
-creates the DCP. You can create a new film by selecting
+a DCP. DCP-o-matic stores its ‘film’ data in a folder on your disk while it
+creates the DCP.
+
+
+
+You can create a new film by selecting
New from the File menu, as
shown in .
@@ -311,7 +210,7 @@ shown in .
‘Magic’ KDM strings
@@ -2856,9 +2939,15 @@ KDM that is being sent:
$CPL_NAMEDCP title
+$CPL_FILENAMEFilename of the CPL
+
+$CINEMA_NAMECinema name
+$CINEMA_SHORT_NAMEFirst 14 characters of the cinema name
+
+$SCREENSName of screen or screens that KDMs are being generated for
@@ -2877,33 +2966,6 @@ The Reset to default text will replace the current KDM emai
-
-
-
-Accounts
-
-
-The Accounts tab is shown in .
-
-
-
- Accounts preferences
-
-
-
-
-
-
-
-
-DCP-o-matic can download projector certificates from the Barco and
-Christie websites if you have the appropriate credentials. Enter your
-usernames and passwords.
-
-
-
-
-
Notifications
@@ -2931,7 +2993,7 @@ send.
-The bottom box in the tab is the contents of the email that should
+The bottom box in the tab is the content of the email that should
be sent. DCP-o-matic will replace the ‘magic’ strings
$JOB_NAME and $JOB_STATUS in the with the
details of the job that has completed.
@@ -2964,7 +3026,7 @@ DCP that has been made:
-‘Magic’ Cover sheet strings
+‘Magic’ cover sheet strings
@@ -3049,7 +3111,7 @@ that you might see with your current settings.
-The four checkboxes labelled Log control what
+The 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
@@ -3085,8 +3147,7 @@ however, always possible.
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 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.
+play fine, but another (of a different type, or even just with a different software version) will refuse to play.
@@ -3095,10 +3156,10 @@ even refuse to ingest.
Guaranteed rates
-The only rates that are (pretty much) guaranteed to work on all DCI
-projectors are 24 frames per second (fps) for video and 48kHz for
-audio. If you are sending DCPs to unknown places it is wise to
-consider using these rates if at all possible.
+The only rates that are guaranteed to work on all DCI projectors are
+24 frames per second (fps) for video and 48kHz for audio. If you are
+sending DCPs to unknown places it is wise to consider using these
+rates if at all possible.
@@ -3129,7 +3190,7 @@ with minimal loss in quality.
-Video rate conversion is harder. DCP-o-matic's basic strategy to deal
+Video rate conversion is harder. DCP-o-matic's strategy to deal
with a non-supported content rate is to run it at the wrong speed, and
to adjust the audio to keep it in sync.
@@ -3178,8 +3239,8 @@ 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
+You can experiment with other non-standard frame rates
+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
@@ -3205,7 +3266,7 @@ a small program called dcpomatic_server.
-The master and server machines do not need to be the same type, so you
+The master and server machines do not need to be running the same operating system, so you
can mix Windows PCs, Macs and Linux machines as you wish.
@@ -3215,11 +3276,11 @@ can mix Windows PCs, Macs and Linux machines as you wish.
Running the servers
-There are two options for the encoding server;
+There are two options for the encoding server:
dcpomatic_server_cli, which runs on the command line, and
dcpomatic_server, 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
+the GUI version works best on Windows and macOS where it will put an icon in the
system tray.
@@ -3255,7 +3316,7 @@ server or open a window to show its status.
If you would rather not bother installing DCP-o-matic on your
server computers, the other option is to use the live-CD
image that you can download from the DCP-o-matic web site.
+url="https://dcpomatic.com/">DCP-o-matic web site.
Either burn the image to CD, or write it to a USB stick (using
something like DCP-TEST_EN-XX_UK-U_51_2K_CSY_20130218_CSY_OV. This
contains some small XML files, which describe the DCP, and two large
MXF files, which contain the DCP's audio and video data. It may also
-contain subtitles in either XML or MXF format. This folder
+contain subtitles or closed captions in either XML or MXF format. This folder
(DCP-TEST_EN-XX_...) is what you should ingest, or pass
to the cinema which is showing your DCP.
@@ -3562,10 +3623,10 @@ sets.
Start a new DCP-o-matic film.
-Click Add folder... and specify your existing DCP's folder.
+Click Add DCP... and specify your existing DCP's folder.Go to the DCP tab and choose Split by video content for Reel type.
-Go to the Video and
-Audio tabs in turn and tick the Use this DCP's audio as OV and make VF checkboxes.
+Go to the Video tab and tick the Use this DCP's video as OV and make VF checkbox.
+Go to the Audio tab and tick the Use this DCP's audio as OV and make VF checkbox.Add your subtitles to the film in whatever format you have.Check the subtitle appearance in the preview; it will be
slow to respond as it is having to decompress images from the existing
@@ -3580,12 +3641,12 @@ DCP.Start a new DCP-o-matic film.
-Click Add folder... and specify your existing DCP's folder.
+Click Add DCP... and specify your existing DCP's folder.Add your subtitles to the film in whatever format you have.Check the subtitle appearance in the preview; it will be
slow to respond as it is having to decompress images from the existing
DCP. Adjust the appearance using controls in the
-Subtitle tab if required.
+Timed Text or Closed Captions tabs if required.
Choose Make DCP from the menu.
@@ -3596,13 +3657,13 @@ DCP. Adjust the appearance using controls in the
Start a new DCP-o-matic film.
-Click Add folder... and specify your existing DCP's folder.
+Click Add DCP... and specify your existing DCP's folder.Add your subtitles to the film in whatever format you have.Go to the Subtitle tab and tick the Burn subtitles into image checkbox.Check the subtitle appearance in the preview; it will be
slow to respond as it is having to decompress images from the existing
DCP. Adjust the appearance using controls in the
-Subtitle tab if required.
+Timed Text or Closed Captions tabs if required.
Choose Make DCP from the menu.
@@ -3680,8 +3741,196 @@ The full details of OV and VF files are discussed in
+ Another way to improve performance is to set the Video display mode
+ in Preferences to OpenGL (faster). This should provide
+ a significant speed-up on most systems, although this mode has not been so widely tested so may
+ have problems.
+
+
+
+
+ Verifying DCPs
+
+
+ The DCP-o-matic Player (see ) also offers a DCP verifier. To check a DCP,
+ open it and then select Verify DCP from the
+ Tools menu.
+
+
+
+ The verifier will report three kinds of problems:
+
+
+
+ Errors — serious problems with the DCP that are likely to cause problems on playback.
+ Bv2.1 errors — errors described by the SMPTE Bv2.1 standard.
+ Warnings — small problems that may not matter.
+
+
+
+ The following sections list what the verifier checks for in each category.
+
+
+
+ Errors
+
+
+
+
+ Bv2.1 errors
+
+
+
+
+ Warnings
+
+
+
+
+
+
+
+
+Writing DCPs to disks
+
+
+Once you have your DCP, you need to get it to the cinema or theater who
+will play it. Sometimes this is possible via the internet, using a
+service such as Filemail. If that's an option: go for it! Network
+transfers avoid a lot of the difficulties that other methods have.
+
+
+
+However, your DCP may be too large to make that practical. In that case,
+the usual approach is to copy the DCP onto a USB hard drive or stick and
+physically take it or send it to the cinema.
+
+
+
+Hard drive formatting
+
+
+In theory, this should be as simple as dragging and dropping the DCP's
+files onto a USB-connected drive. Sadly, though, things are not always
+that simple. This is because not all hard drives are formatted in the
+same way. The most common formats for hard drives are:
+
+
+
+APFS — used by macOS 10.13 and later for solid state drives (SSDs).
+HFS+ (Mac OS Extended) — used by macOS on 10.12 and earlier, and on all macOS systems for spinning disks.
+NTFS — modern format used by Windows.
+ExFAT — another modern, but less common (and buggier) format used by Windows.
+FAT32 — old format used by Windows.
+ext2, ext3, ext4 — often used by Linux.
+
+
+
+You can format a drive however you want, but a drive set up on macOS will usually use APFS, just as one set up on Windows will probably use NTFS or ExFAT.
+
+
+
+The problem you have as a DCP maker is: the only format that is
+guaranteed to work in all cinemas is ext2. This format is not easy to
+use directly from Windows or macOS: both operating systems need extra
+software to write ext2 drives.
+
+
+
+The “DCP-o-matic Disk Writer” provides a possible
+solution to this problem. It allows you to format and copy DCPs onto ext2-formatted disks from Windows, macOS or Linux.
+
+
+
+
+
+
+Caution
+
+
+DCP-o-matic is made by one developer in his spare time. As a project,
+we do not have any quality assurance department, testing team or
+anything like that. Though we try our best to ensure quality using
+automated testing, and by the great efforts of our users to find and report problems,
+bugs do get into the code and things do go wrong.
+
+
+
+Though very undesirable, bugs in most parts of DCP-o-matic are usually
+not disastrous; they most often result in an error message, or some
+problem with a DCP. The Disk Writer tool, however, is a bit different. It obtains
+permission from your operating system to write directly to disks connected to the
+computer. Though we have done as much as we can to prevent problems, there is a chance
+that a bug in the Disk Writer could cause irretrievable data loss (for example, if
+the writer wrote to the wrong drive by mistake).
+
+
+
+No such problems have been reported, nor found by us during testing, but I would
+like to warn you that they are possible. As always, make sure that you have backups
+(somewhere that is not directly connected to your computer) of anything that you do not want
+to lose.
+
+
+
+
+
+
+Writing a DCP to a disk
+
+
+Starting up the Disk Writer will give open a confirmation window to make sure that you understand the risks involved, as shown in .
+
+
+
+ Starting the Disk Writer
+
+
+
+
+
+
+
+
+If you are sure you want to continue, type I am sure into the text box and click OK. This will open the window shown in .
+
+
+
+ The Disk Writer
+
+
+
+
+
+
+
+Next, click Open... and choose the DCP that you want to write.
+
+
+Now we need to choose the drive that the DCP will be written to from the drop-down menu.
+Whichever drive you choose will be irretrievably wiped!
+If the drive you want is not listed, click Refresh to search the system for drives.
+
+
+
+Finally, click Copy DCP. After a confirmation window, the drive will be formatted,
+and the DCP copied and then read back to check that it was written correctly.
+
+
+
+
+
+
+
+
+
+Keyboard shortcuts
+
+
+
+
Configuration files
@@ -3701,3 +3950,24 @@ The full details of OV and VF files are discussed in
+
+
+
+
+
+
+
+
+
+
+