X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=797a49fe5812acc820f54ee31c26f753c9e4c9c9;hb=3ddec1cb6b495763991f18ed6ffccc8724882199;hp=cc19d9ebf9a6e1b3230c2542954006875bf1d757;hpb=4117c113eeffe817fddc1c63f5d10eb4e6ada4f9;p=dcpomatic.git
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index cc19d9ebf..797a49fe5 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 programs 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.
+ Create KDMs for DCPs.
+ Write cinema-format drives containing DCPs.
@@ -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,7 +90,7 @@ 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.
@@ -98,36 +98,29 @@ 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
+suggest you use 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.
-
-
-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 will run on macOS version 10.10 (Yosemite) and
+higher. DCP-o-matic is split into seven 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.
@@ -135,23 +128,10 @@ with the first (main) part.
-Debian, Ubuntu or Mint Linux
-
-
- You can install DCP-o-matic on:
-
-
-
- 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
-
+Debian, Ubuntu and Mint Linux
-
-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,17 @@ thanks to Stefan Karner.
-
-
-Other Linux distributions
-
-
-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
-
-
-
-
-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:
+
+ Building from source
+
+
+ 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/
+
-
-
-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.
-
-
-
@@ -301,8 +199,12 @@ the low-resolution version to save everyone's bandwidth bills.
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 +213,7 @@ shown in .
‘Magic’ KDM strings
@@ -2893,33 +2992,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
@@ -2980,7 +3052,7 @@ DCP that has been made:
-‘Magic’ Cover sheet strings
+‘Magic’ cover sheet strings
@@ -3101,8 +3173,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) will refuse to play.
@@ -3111,10 +3182,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.
@@ -3271,7 +3342,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 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.
@@ -3596,7 +3667,7 @@ 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
@@ -3612,7 +3683,7 @@ 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
@@ -3670,7 +3741,7 @@ The full details of OV and VF files are discussed in
- Playing DCPs
+ Playing and verifying DCPsDCP-o-matic includes a DCP player, and although it requires a
very high-speed CPU to play DCPs in full resolution, it can also
@@ -3696,8 +3767,22 @@ The full details of OV and VF files are discussed in
+
+ The player also offers a simple DCP validator. To check a DCP,
+ open it and then select Verify DCP from the
+ Tools menu. This will run some basic checks to see if the DCP meets the required standards.
+
+
+
+
+
+Keyboard shortcuts
+
+
+
+
Configuration files
@@ -3717,3 +3802,24 @@ The full details of OV and VF files are discussed in
+
+
+
+
+
+
+
+
+
+
+