From 3cb195305c4a4ccea546cc4e8c23cad8fcd4e720 Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Wed, 27 Nov 2024 00:25:22 +0100 Subject: Manual updates for v2.18.0. --- doc/manual/Makefile | 29 +- doc/manual/dcpomatic.sty | 5 +- doc/manual/dcpomatic.xml | 654 +++++++++++++++++---- doc/manual/raw-screenshots/add-screen.pdf | Bin 13660 -> 12765 bytes doc/manual/raw-screenshots/audio-tab.pdf | Bin 63379 -> 47553 bytes doc/manual/raw-screenshots/combiner.pdf | Bin 0 -> 6164 bytes doc/manual/raw-screenshots/dcp-tab.pdf | Bin 957045 -> 34326 bytes doc/manual/raw-screenshots/disk-writer-notice.pdf | Bin 22654 -> 0 bytes doc/manual/raw-screenshots/disk-writer.pdf | Bin 8965 -> 6164 bytes doc/manual/raw-screenshots/editor-cpl.pdf | Bin 0 -> 10522 bytes doc/manual/raw-screenshots/editor-reel.pdf | Bin 0 -> 8367 bytes doc/manual/raw-screenshots/editor.pdf | Bin 0 -> 4371 bytes doc/manual/raw-screenshots/markers.pdf | Bin 18721 -> 14687 bytes doc/manual/raw-screenshots/prefs-advanced.pdf | Bin 176398 -> 23700 bytes doc/manual/raw-screenshots/prefs-defaults.pdf | Bin 139109 -> 18780 bytes doc/manual/raw-screenshots/prefs-email.pdf | Bin 53366 -> 12618 bytes doc/manual/raw-screenshots/prefs-general.pdf | Bin 42638 -> 19280 bytes doc/manual/raw-screenshots/prefs-identifiers.pdf | Bin 27735 -> 9668 bytes doc/manual/raw-screenshots/prefs-kdm-email.pdf | Bin 56764 -> 13523 bytes doc/manual/raw-screenshots/prefs-keys.pdf | Bin 92914 -> 14062 bytes doc/manual/raw-screenshots/prefs-non-standard.pdf | Bin 0 -> 14088 bytes doc/manual/raw-screenshots/prefs-notifications.pdf | Bin 76756 -> 15335 bytes doc/manual/raw-screenshots/prefs-sound.pdf | Bin 77970 -> 25088 bytes doc/manual/raw-screenshots/prefs-tms.pdf | Bin 60808 -> 12474 bytes doc/manual/raw-screenshots/reels.pdf | Bin 0 -> 11903 bytes doc/manual/raw-screenshots/timed-text-tab.pdf | Bin 1103752 -> 41675 bytes doc/manual/raw-screenshots/vf-setup.pdf | Bin 0 -> 11661 bytes doc/manual/raw-screenshots/video-tab.pdf | Bin 73577 -> 49048 bytes 28 files changed, 560 insertions(+), 128 deletions(-) create mode 100644 doc/manual/raw-screenshots/combiner.pdf delete mode 100644 doc/manual/raw-screenshots/disk-writer-notice.pdf create mode 100644 doc/manual/raw-screenshots/editor-cpl.pdf create mode 100644 doc/manual/raw-screenshots/editor-reel.pdf create mode 100644 doc/manual/raw-screenshots/editor.pdf create mode 100644 doc/manual/raw-screenshots/prefs-non-standard.pdf create mode 100644 doc/manual/raw-screenshots/reels.pdf create mode 100644 doc/manual/raw-screenshots/vf-setup.pdf diff --git a/doc/manual/Makefile b/doc/manual/Makefile index ab8a7f398..72de24043 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -18,9 +18,11 @@ SCREENSHOTS := file-new.pdf new-film.pdf video-select-content-file.pdf \ prefs-notifications.pdf timeline1.pdf timed-text-tab.pdf \ making-dcp.pdf filters.pdf video-tab.pdf audio-tab.pdf \ audio-plot.pdf audio-map-eg1.pdf audio-map-eg2.pdf audio-map-eg3.pdf kdm.pdf \ - kdm-creator.pdf export.pdf advanced-content.pdf disk-writer-notice.pdf disk-writer.pdf \ + kdm-creator.pdf export.pdf advanced-content.pdf disk-writer.pdf combiner.pdf \ markers.pdf prefs-notifications.pdf prefs-cover-sheet.pdf add-screen.pdf \ - advanced-player.pdf playlist-editor.pdf playlist-editor-prefs.pdf + advanced-player.pdf playlist-editor.pdf playlist-editor-prefs.pdf reels.pdf \ + editor.pdf editor-cpl.pdf editor-reel.pdf vf-setup.pdf prefs-sound.pdf \ + prefs-identifiers.pdf prefs-non-standard.pdf XML := dcpomatic.xml @@ -37,7 +39,7 @@ screenshots/%.pdf: raw-screenshots/%.pdf cp $< $@ screenshots/prefs-general.pdf: raw-screenshots/prefs-general.pdf - python3 pdf_crop_by.py $< $@ 0 400 0 0 + python3 pdf_crop_by.py $< $@ 0 300 0 0 screenshots/prefs-defaults.pdf: raw-screenshots/prefs-defaults.pdf python3 pdf_crop_by.py $< $@ 0 400 0 0 @@ -46,13 +48,22 @@ screenshots/prefs-servers.pdf: raw-screenshots/prefs-servers.pdf python3 pdf_crop_by.py $< $@ 0 700 0 0 screenshots/prefs-keys.pdf: raw-screenshots/prefs-keys.pdf - python3 pdf_crop_by.py $< $@ 0 600 0 0 + python3 pdf_crop_by.py $< $@ 0 400 0 0 screenshots/prefs-tms.pdf: raw-screenshots/prefs-tms.pdf - python3 pdf_crop_by.py $< $@ 0 600 0 0 + python3 pdf_crop_by.py $< $@ 0 450 0 0 screenshots/prefs-email.pdf: raw-screenshots/prefs-email.pdf - python3 pdf_crop_by.py $< $@ 0 700 0 0 + python3 pdf_crop_by.py $< $@ 0 500 0 0 + +screenshots/prefs-identifiers.pdf: raw-screenshots/prefs-identifiers.pdf + python3 pdf_crop_by.py $< $@ 0 450 0 0 + +screenshots/prefs-non-standard.pdf: raw-screenshots/prefs-non-standard.pdf + python3 pdf_crop_by.py $< $@ 0 450 0 0 + +screenshots/prefs-advanced.pdf: raw-screenshots/prefs-advanced.pdf + python3 pdf_crop_by.py $< $@ 0 150 0 0 screenshots/prefs-cover-sheet.pdf: raw-screenshots/prefs-cover-sheet.pdf python3 pdf_crop_by.py $< $@ 0 600 0 0 @@ -67,10 +78,10 @@ screenshots/timing-tab.pdf: raw-screenshots/timing-tab.pdf python3 pdf_crop_by.py $< $@ 0 100 1475 420 screenshots/timed-text-tab.pdf: raw-screenshots/timed-text-tab.pdf - python3 pdf_crop_by.py $< $@ 0 50 1480 420 + python3 pdf_crop_by.py $< $@ 0 0 1450 420 screenshots/video-tab.pdf: raw-screenshots/video-tab.pdf - python3 pdf_crop_by.py $< $@ 0 0 1480 365 + python3 pdf_crop_by.py $< $@ 0 0 1450 390 screenshots/add-file.pdf: raw-screenshots/add-file.pdf python3 pdf_crop_by.py $< $@ 0 600 1210 0 @@ -88,7 +99,7 @@ screenshots/audio-map-eg3.pdf: raw-screenshots/audio-map-eg3.pdf python3 pdf_crop_by.py $< $@ 10 75 1350 630 screenshots/dcp-tab.pdf: raw-screenshots/dcp-tab.pdf - python3 pdf_crop_by.py $< $@ 0 350 1240 30 + python3 pdf_crop_by.py $< $@ 0 350 1415 25 # For HTML: convert diagrams from SVG to PNG diff --git a/doc/manual/dcpomatic.sty b/doc/manual/dcpomatic.sty index 834e581fc..eeb0417fa 100644 --- a/doc/manual/dcpomatic.sty +++ b/doc/manual/dcpomatic.sty @@ -2,7 +2,7 @@ %% This style is derivated from the docbook one %% \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{ardour}[2007/04/04 My DocBook Style] +\ProvidesPackage{dcpomatic}[2007/04/04 My DocBook Style] %% Just use the original package and pass the options \RequirePackageWithOptions{docbook} @@ -22,6 +22,9 @@ \hbox to0pt{\hskip-\hangindent\dbend\hfill}\ignorespaces} \def\endsidebar{\par\end{trivlist}} +\renewcommand{\listoffigures}{} +\renewcommand{\listoftables}{} + % Futz with the title page; basically a copy of % /usr/share/texmf/tex/latex/dblatex/style/dbk_title.sty diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index df4bc75f5..891c4b7e1 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -3,7 +3,7 @@ + "/usr/share/sgml/docbook/xml-dtd-4.5/dbcentx.mod"> %dbcent; %extensions; @@ -13,6 +13,7 @@ DCP-o-matic users' manual CarlHetherington +For version 2.18.x @@ -35,6 +36,7 @@ Hello, and welcome to DCP-o-matic! Play and verify DCPs (see and ). Create KDMs for DCPs (see ). Write cinema-format drives containing DCPs (see ). + Manipulate existing DCPs in various ways (see and ). @@ -109,7 +111,7 @@ You may find that DCP-o-matic crashes if run the 32-bit version on a CPU with mo 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 +higher. DCP-o-matic is split into ten 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. @@ -133,6 +135,10 @@ If you are using macOS 10.7 (Lion) or older you will need to install the latest There are .deb packages for Debian, Ubuntu and Mint on https://dcpomatic.com/ + +For Debian there are both x86 and ARM packages, so choose the correct one +for the CPU type you are using (most people will need x86). + @@ -144,6 +150,11 @@ If you are using macOS 10.7 (Lion) or older you will need to install the latest There are .rpm packages for Fedora, Centos and Mageia on https://dcpomatic.com/ + +For Fedora there are both x86 and ARM packages, so choose the correct one +for the CPU type you are using (most people will need x86). You can install the +ARM packages on Asahi Linux on mac. + @@ -153,7 +164,7 @@ If you are using macOS 10.7 (Lion) or older you will need to install the latest Packages for Arch Linux are available from https://aur.archlinux.org/packages/dcpomatic/, -thanks to Stefan Karner. +thanks to Benjamin Radel and Markus Kalb. @@ -234,12 +245,12 @@ 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 choose where you want to create the film. In the example from the figure, DCP-o-matic will create a -folder called ‘DCP Test’ inside my existing folder DCP into which it +folder called ‘DCP Test’, inside my existing folder DCP, into which it will write its working files. -DCPs can be very large (more than 100Gb for a feature-length DCP) so +DCPs can be very large (more than 100GB for a feature-length DCP) so it's important to choose a folder on a disk with plenty of free space. @@ -251,7 +262,7 @@ it's important to choose a folder on a disk with plenty of free space. Adding content -The next step is to add the content that you want to use. DCP-o-matic +The next step is to add the content. DCP-o-matic can make DCPs from multiple pieces of content, but in this example we will use a single piece. Click the Add file(s)... button, as shown in When you do this, DCP-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 . +has finished), you can look through your content using the slider +underneath the black preview area, as shown in .
@@ -315,16 +326,16 @@ the Play button to play the content back. In most cases, some adjustments would be made to DCP-o-matic's settings once the content has been added. For our simple test, -however, the default values will suffice, so we can go straight onto +however, the default values are fine, so we can go straight onto making the DCP. Choose Make DCP from the Jobs menu. Before encoding your DCP, DCP-o-matic -will run a series of checks on your film to look for various conditions +will run a series of checks on your film to look for things that might cause problems when playing back the DCP. If any potential problems are found, DCP-o-matic will show you a list of hints. -Each hint describes the condition that was found and gives +Each hint describes what was found and gives advice on how to resolve it. If hints are found and reported, you can either Make DCP anyway (without adjusting any settings), or Go back in order to make @@ -335,8 +346,8 @@ adjustments before encoding the DCP. If no hints were found (or you pressed Make DCP after hints were displayed), DCP-o-matic will encode your DCP. This may take some time (many hours in some cases). While the job is -in progress, DCP-o-matic will update you on how it is getting on with -the progress bar in the bottom of its window, as shown in . @@ -352,7 +363,8 @@ linkend="fig-making-dcp"/>. When it has finished, the DCP will be written into its own folder inside the film's folder. You can copy this to a projector via a USB stick, hard-drive or network connection. See for details about the files that DCP-o-matic creates. +linkend="ch-files"/> for details about the files that DCP-o-matic creates, and +for details of a DCP-o-matic tool which can write the DCP to an external hard-drive. @@ -605,13 +617,25 @@ To make a DCP like this: Import your ‘Content DCP’ to a DCP-o-matic project. Add whatever replacement you want in your new DCP (replacement subtitles or audio files, for example). -Select the DCP in the content list -Tick the Use's this DCP's ... as OV and make VF checkbox -in the tabs for the parts of the DCP that you want to refer to in your -new DCP. For example, to refer to the Content DCP's video and audio you would select the Video tab, click Use this DCP's video as OV and make VF then select the Audio tab and click Use this DCP's audio as OV and make VF. +Open the Version File Setup dialogue box using the Version File (VF)... option in the Tools menu. + +Tick the relevant checkboxes for the parts of your existing DCP that you want to re-use (e.g. to refer to, or re-use, the video from the existing DCP, tick +the Video checkbox). Do Make DCP as usual and your VF DCP will be created. +The VF setup dialog is shown below, set up to refer to both picture and sound from an existing DCP: + +
+ Setup for making a Version File (VF) + + + + + +
+ + @@ -814,19 +838,6 @@ The Video tab controls properties of the image, as shown in
- -
-Use this DCP's video as OV and make VF - - -This option is only available if the selected content is an existing -DCP. It allows you make a VF DCP, using the video content from the -existing DCP by referencing it (rather than copying). See . - - -
-
Image type @@ -1129,14 +1140,6 @@ shows the mapping of a 5.1 source into a 5.1 DCP.
Other controls - -The Use this DCP's audio as OV and make VF -checkbox is only applicable if the selected content is an existing -DCP. It allows you to make a VF DCP, using the audio content from the -existing DCP by referencing it (rather than copying). See . - - Show graphs of audio levels will analyse the audio of the selected content and plot it on a graph. See for more details. -Audio Gain is used to alter the volume of the +Gain is used to alter the volume of the soundtrack. The specified gain (in dB) will be applied to each sound channel of your content before it is written to the DCP. @@ -1183,6 +1186,14 @@ 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. + +Fade in and Fade out can be +used to set fades for the audio. If your selected content also contains +video you can tick Use same fades as video if you +want the audio to fade in/out with the picture. When Use same fades... +is ticked the fades used will be the ones set in the Video tab. + +
@@ -1748,13 +1759,6 @@ projectionists will appreciate it if you use the as it makes it easier to identify details of the content. - -If there is spoken language in your project's audio you can tick the -Audio Language checkbox and then specify the language -of that audio. This information will be used for the ISDCF name, written into -the DCP cover sheet, and added as metadata to the audio MXF files in the DCP. - - The Content Type option can be ‘feature’, ‘trailer’ or whatever; select the @@ -1777,8 +1781,8 @@ key for you. To specify your own key, click the -The Reels and Reel length -controls specify how the DCP will be split up into +The Reels... button opens a dialogue box which +can be used to specify how the DCP will be split up into ‘reels’. See . @@ -1896,6 +1900,14 @@ This may be useful to make near-field L/R mixes more compatible with cinema audio systems. + +If there is spoken language in your project's audio you can tick the +Language checkbox and then specify the language +of that audio. This information will be used for the ISDCF name, written into +the DCP cover sheet, and added as metadata to the audio MXF files in the DCP. + + +
Reels @@ -1938,19 +1950,33 @@ This is easier than attaching the picture data to the feature's existing data. -DCP-o-matic offers three options for setting up the reels in your DCP: -single reel, split by video content or custom. +To change how your DCP will be split up into reels, click the Reels... +button in the DCP tab to open the reels dialogue: +
+ Editing reels + + + + + +
+ -Single reel, as its name suggests, keeps the whole DCP as one reel. -This is a perfectly good option if you have no particular reason to -need reels. +The Reel mode control lets you choose different ways that the reel breaks +are decided. As you change the mode, the timeline below is updated to reflect the new setting. -Split by video content puts each piece of source -video content in its own reel, as shown in . +Single reel simply uses one reel for the entire DCP. This is fine in most cases: +select it if you are unsure. + + + +Split by video content puts a reel break at the start and end of each piece of video +content. This is useful if you want to make it easier, for example, to make VF which swaps out some credits +or an introduction ident. If you have a project like the one below, for example:
@@ -1959,16 +1985,23 @@ video content in its own reel, as shown in .
-Here we have three video files (ident.mp4, -feature.ts and cred.mov). With -split by video content DCP-o-matic makes a new -reel to hold each video file. +you can more easily make a VF with a different ident if the ident is in its own reel. -Custom splits reels by the size of the files that -will make up their video content. With Custom -you must specify a reel length in Gb. Then no file in the DCP will be larger than this reel length. +Split by maximum reel size is useful if you want to limit how large the video file for +each reel is. With this option selected you can alter Maximum reel size as required. +The video files for the reels in the DCP are not guaranteed to be exactly your requested size, but they +should be close. + + + +Custom allows you to put your reel breaks wherever you like. In this mode you can right-click +on the timeline and choose Add reel boundary from the menu. Once you have reel boundaries you +can drag them around, or set their timecodes precisely with the controls under the timeline. You can also remove +a reel boundary by right-clicking it and choosing Remove reel boundary. Ticking Snap when dragging +means that the reel markers will snap to the reel markers of existing DCPs in your project, or the start position +of any other content.
@@ -2040,8 +2073,7 @@ useful to use templates. Say, for example, you often make 4K feature DCPs from video files in -’scope at 25fps. You can speed up this process by following -these steps: +scope at 25fps. You can speed up this process by following these steps: @@ -2049,6 +2081,7 @@ these steps: in our example, set the content to scale to DCP, the DCP resolution to 4K, and so on. Choose Save as template... from the File menu. + Click Save as new new with name to make a new template. Enter a name for your template. @@ -2093,6 +2126,17 @@ the Keep video and subtitles in sequence checkbox from the timeline is also preserved. + +There are some other options when saving a template. Save as default +saves the current project as the default template applied to all new films. If there is some +setting you always use, you can add it to the default template to save time. + + + +By choosing Save over existing template you can also update a template +you made previously. + + @@ -2323,7 +2367,9 @@ generate KDMs for any screens that it knows about. To add a cinema, click Add Cinema.... This opens a dialogue box into which you can enter the cinema's name, and optionally an email address. This email address can be used to -get DCP-o-matic to deliver KDMs via email. +get DCP-o-matic to deliver KDMs via email. You can also enter the time +zone of the cinema, which helps to create KDMs with the correct local +time windows. @@ -2338,8 +2384,9 @@ Alternatively, certificates for projection systems made by some manufacturers can be downloaded from databases provided by the manufacturer. Currently this is supported for Doremi, Dolby, Barco, Christie and GDC equipment (through downloading Barco, Christie or GDC -certificates requires you to have an appropriate account set up in -DCP-o-matic's preferences). If you are targeting a screen with +certificates requires you to have an appropriate account, and you need +to enter the user name and password into the appropriate tab in +Download certificate. If you are targeting a screen with equipment by one of these manufacturers you can click Download then enter the serial number of the server in the screen and click Download again @@ -2354,7 +2401,23 @@ destination cinema will in advance of show time to identify any problems. - + +Each KDM is made for a single Composition Play List (CPL). This is the +name for a file (part of every DCP) which lists the things that make +up a single ‘composition’. A CPL might, for example, list +a video file, an audio file, and some subtitles, and give details of +frames rate and other metadata. A CPL is the thing you choose to +play on a cinema projector, and is commonly a single film, a single +advert, or perhaps a trailer. + + + +A CPL is often effectively the same as a DCP, though it is possible +for a single DCP (‘package’) to contain multiple CPLs. +For example, a DCP might contain CPLs that each describe the same +feature film but with audio tracks in different languages. + + Once you have set up all the screens that you need KDMs for, select the CPL that you want to create the KDM for. You can use the @@ -2373,7 +2436,7 @@ The differences between the three KDM types are fairly subtle. DCI Specific and DCI Any add a <ContentAuthenticator> tag to the KDM which allows the exhibitor to check that the DCP and KDM have come from a -bona-fide source. In addition, DCI Specific adds +trusted source. In addition, DCI Specific adds information on trusted devices to the KDM. This allows the KDM creator to specify devices (such as sound processors) that are allowed to use keys delivered by the KDM. At present it is not clear how @@ -2503,7 +2566,7 @@ a new cinema by clicking Add Cinema..., giving it a name Then select this new cinema and click Add Screen... to open -the screen dialog box, as shown in . +the screen dialogue box, as shown in .
@@ -2641,6 +2704,8 @@ The general tab is shown in .
+ +
@@ -2654,7 +2719,8 @@ You will need to restart DCP-o-matic to see the new language. The translations for DCP-o-matic have been contributed by helpful -users. If your language is not on the last, visit the DCP-o-matic website to find out how to contribute a translation. @@ -2706,21 +2772,44 @@ DCP-o-matic: across a network share, for instance. This option allows you to change the file that DCP-o-matic uses to -store details of the cinemas and screens used to make KDMs. +store details of the cinemas and screens used to make KDMs. Since +DCP-o-matic 2.18.0 this is an sqlite3 file rather than +XML
+ +
+Default “add file” location + + +This option sets the ‘starting point’ for the file picker +when adding content to a project. It can either be wherever you last +looked for content, or always in the same place as the DCP-o-matic +project folder. + +
-Play sound via +Write relative content paths -The checkbox to the left of Play sound enables or -disables DCP-o-matic's use of sound. On some machines there will be -multiple options in the drop-down menu to decide how the sound should -be played. +If this checkbox is unticked, the full filenames of content files will +be stored in the DCP-o-matic project. This means that if you move your +project around, the content files will still be found. This is useful +if your content files are stored in their own place, unrelated to where +you make your DCP-o-matic projects. + + + +Ticking this box means that content filenames will be written relative +to the DCP-o-matic project. This means that you can move your project +and content files to a different place and your content will still be +found. This is useful if you keep DCP-o-matic projects alongside the +content they use. +
@@ -2766,6 +2855,43 @@ those that are formally ‘released’.
+ +
+Sound + + +The sound tab is shown in . + + +
+ Sound preferences + + + + + +
+ + +
+Play sound via + + +The checkbox to the left of Play sound enables or +disables DCP-o-matic's use of sound. On some machines there will be +multiple options in the drop-down menu to decide how the sound should +be played. + + + +The mapping matrix below specifies how audio from DCP channels will be +routed to your sound hardware. By default, DCP-o-matic will mix 5.1 +audio down to stereo if your chosen output device only has 2 channels. + +
+ +
+
Defaults @@ -2785,7 +2911,12 @@ The defaults tab is shown in . The options in this tab simply allow you to set up default values for -various properties of new films. +various things in DCP-o-matic. + + + +Another way to set up defaults, especially for project settings, is +to use a default template (see ).
@@ -2857,6 +2988,12 @@ different copies of DCP-o-matic so that they can both use the same KDMs. + +The Re-make certificates and key... button under +Signing DCPs and KDMs can be clicked to recreate +the signing keys used by DCP-o-matic. + + The two Advanced... buttons open advanced dialogue boxes for detailed manipulation of DCP-o-matic's certificate @@ -2938,6 +3075,11 @@ FTP. Do let us know if you use any other type of TMS with the Send DCP to TMS feature. + +Passive mode can be ticked to enable the FTP +PASV mode, if you are using FTP. + + TMS IP address should be set to the IP address of your TMS, TMS target path to the place that DCPs @@ -2977,7 +3119,11 @@ These settings are used when DCP-o-matic sends emails. - Outgoing mail server should be the host name of a mail (SMTP) server that DCP-o-matic can use. You can also specify the port that DCP-o-matic should use. User name and Password are the credentials that are required to send email through the server you have specified. +Outgoing mail server should be the host name of a mail (SMTP) server that DCP-o-matic can use. You can also specify the port. User name and Password are the credentials that are required to send email through the server you have specified. + + + +Clicking Send test email... opens a dialogue box where you can send a test email (using the server you have configured) to make sure that the settings are correct. @@ -3138,25 +3284,58 @@ The Reset to default text will replace the current cover sh + +
+Identifiers + + +The Identifiers tab is shown in . + + +
+ Identifiers preferences + + + + + +
+ + + These are a set of ‘labels’ that are written to DCPs made by + DCP-o-matic and which identify the creator and product used. If they are left + blank, DCP-o-matic will use its own values which show that DCP-o-matic was + used. You can use these labels to ‘brand’ DCPs with your own + company details (though these label values are not usually very prominent on + the user interfaces of projection systems). + + +
+ -
-Advanced -Advanced preferences +
+Non-standard -The advanced preferences are shown in . +The non-standard preferences are shown in . -
- Advanced preferences +
+ Non-standard preferences - +
+ +This tab contains preferences which enable DCP-o-matic to make DCPs with properties +that are non-standard or unusual. Think carefully before changing these preferences, +as DCP-o-matic may then make DCPs which do not play correctly on some projection systems. + + Maximum JPEG2000 bandwidth specifies the maximum bit-rate of JPEG2000 that DCP-o-matic will allow you to create. You @@ -3164,6 +3343,11 @@ are advised to leave this at 250Mbit/s in normal use for maximum DCP compatibility. + +Maximum MPEG2 bit rate is the equivalent for MPEG2 DCPs; I am not aware +of a specified maximum for MPEG2 DCPs. + + Allow any DCP frame rate removes the limits on the DCP video frame rates that DCP-o-matic will create. This may be @@ -3171,12 +3355,74 @@ useful for experimentation. Again, you are strongly advised to leave this unticked for normal use. + +Ticking Allow full-frame and non-standard container ratios allows +containers other than ‘Flat’ (1.85:1) and ‘Scope’ (2.39:1). + + + +Ticking Allow creation of DCPs with 96kHz audio enables 96kHz +as an audio sampling rate option. This is theoretically supported by the DCP standards +but rarely used in practice. + + + +Allow mapping to all audio channels will include in the audio +mappings some channels which are usually silent (8, 9 and 15). + + + +Allow use of SMPTE Bv2.0 adds an option to disable the use of +MCASubDescriptor tags for audio. + + + +ISDCF name part length sets how long the film name can be in +the ISDCF name. 14 is the recommended maximum, but longer names should not (in theory) +case problems. + + +
+ + +
+Advanced +Advanced preferences + + +The advanced preferences are shown in . + + +
+ Advanced preferences + + + + + +
+ + +Show experimental audio processors adds some extra +audio processors whose quality has not been fully checked. If you try them +out it's advisable to listen to the results in a cinema or good 5.1 +listening environment to check that they give you what you want. + + Only servers encode makes DCP-o-matic encode JPEG2000 data only on encoding servers and not on the host. We suggest you leave this unticked unless you have a good reason to do otherwise. + +Maximum number of frames to store per thread sets +how many frames will be queued up in memory when they cannot yet be written +to disk. Changing this value will make DCP-o-matic use more memory, but +may make it more efficient when you have a lot of CPU cores or network +encoding servers. + + With the filename format fields you can adjust the filenames that are used for metadata (CPL and PKL files) and assets (MXF and subtitle @@ -3498,20 +3744,32 @@ to the cinema which is showing your DCP. Command-line tools - DCP-o-matic includes some tools which allow DCP creation from the - command line or from scripting languages. This chapter covers the - use of those tools. + DCP-o-matic includes some tools which allow DCP creation and manipulation + from the command line or from scripting languages. This chapter + covers the use of those tools. - There are three command-line tools in DCP-o-matic. - dcpomatic2_create creates film directories, with the - associated metadata, from a list of content files. Then - dcpomatic2_cli runs the transcode process on these - film directories. Finally, dcpomatic2_kdm_cli can be - used to create KDMs. + There are four command-line tools in DCP-o-matic. + + + dcpomatic2_create creates film directories, with the + associated metadata, from a list of content files. + + + dcpomatic2_cli runs the transcode process on film directories. + + + dcpomatic2_kdm_cli can be used to create KDMs. + + + dcpomatic2_map can collect CPLs and assets from existing DCPs + and make a new DCP. + + + Some applications will benefit from setting up the films using the main DCP-o-matic GUI and then using dcpomatic2_cli to @@ -3601,6 +3859,51 @@ to the cinema which is showing your DCP.
+ +
+ <code>dcpomatic2_map</code> + + + The syntax for dcpomatic2_map is: + + + + dcpomatic2_map [OPTION] <cpl-file|ID> [<cpl-file|ID> ...] + + + + Each <cpl-file|ID> is either a filename or a UUID of a CPL that you want to include + in the output DCP. + + + + dcpomatic2_map will search for CPLs (when given by ID) and other required assets in + directories that you specify with the -d or --assets-dir option. + + + + A new DCP will be created in the directory specified by -o or --output which + contains the CPLs you specify, along with the required assets and other ancillary files (PKL, + AssetMap etc.) + + + + By default, all the required assets will be copied into the new DCP. You can change this behaviour by passing + -l or --hard-link to hard-link the assets (on filesystems and platforms that support + this) or -s or --soft-link to soft-link the assets. + + + + Passing -r or --rename will rename asset files to match DCP-o-matic's configured + naming scheme. + + + + --config <dir> can be used to specify a directory containing the DCP-o-matic configuration + to use for the DCP naming scheme, creator/issuer metadata, signer chain and so on. + +
+ @@ -3700,8 +4003,8 @@ sets. Start a new DCP-o-matic film. 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 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. +Open the Version File (VF) setup dialogue box using the Version File (VF)... option in the Tools menu. +Tick the Video and Audio checkboxes next to your existing DCP's name. 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 @@ -3768,7 +4071,7 @@ to play the film in. The projectionist ingests both DCPs and then plays the VF. The advantage of this approach is that the VF DCPs are much smaller than the OV since they only have the language-specific parts. If you are just changing the subtitles you can often ship the OV by normal -transport means (e.g. a hard drive or high-speed download) and send +transport means (e.g. a hard drive or download) and send the VF by email. @@ -3780,8 +4083,9 @@ The full details of OV and VF files are discussed in Create a new DCP-o-matic project for the OV, as normal, adding video and perhaps sound. Make the DCP. Create a new DCP-o-matic project for the VF. Use Add folder... to add your OV DCP to the project. -Select the video tab and tick Use this DCP's video as OV and make VF (you may need to select By video content for Reel type in the DCP tab). -Do the same in the Audio tab if your OV has audio. +Open the Version File (VF) setup dialogue box using the Version File (VF)... option in the Tools menu. +Tick the Video checkbox next to your existing DCP's name (you may need to select By video content for Reel type in the DCP tab). +Check also the Audio checkbox if your OV has audio. Add your language-specific audio and/or subtitles and Make DCP. @@ -3958,7 +4262,7 @@ are changed.
- Good things + Notes which indicate that something is correct
@@ -3970,7 +4274,7 @@ are changed. Writing DCPs to disks -Once you have your DCP, you need to get it to the cinema or theater who +Once you have your DCP, you need to get it to the cinema or theatre 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. @@ -4055,49 +4359,163 @@ 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 up the Disk Writer will open its main window: -
- Starting the Disk Writer +
+ The Disk Writer - +
+Next, click Add... and choose the DCP that you want to write. You can +write several DCPs to the same drive by clicking Add.. again. + + +Now we need to choose the drive that the DCPs 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. + + -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 . +Finally, click Copy DCPs. After a confirmation window, the drive will be formatted, +and the DCPs copied and then read back to check that they were written correctly. -
- The Disk Writer + + + + + + + +Combining DCPs + + + The main ‘DCP-o-matic’ tool is designed to create a single DCP + containing a single Composition Play List (CPL): in other words, a + single folder containing one film, trailer or advert that can be played. + + + + However, it is also possible to have a single DCP folder containing multiple + CPLs. A projectionist can then ingest (copy) a single thing onto their + playback server but have the choice of several different things to play. + This is often useful to package up different versions of a film (perhaps + with different subtitles or audio tracks) into a single folder. + + + + The difference between a single folder multiple CPLs, or multiple folders + each containing a single CPL, is not great, but sometimes a single folder is + more convenient. + + + + In an ideal world, perhaps it would be possible to create multi-CPL DCPs + from the main ‘DCP-o-matic’ tool. This is not yet possible + (mostly because I find it hard to imagine a user interface that allows it + without complicating the more common ‘single CPL’ case). + Instead, there is a separate tool, the ‘DCP-o-matic Combiner’ + that allows multiple DCPs to be combined into a single one. + + + + Loading the DCP-o-matic Combiner shows a small window: + + +
+ The Combiner - + + + +
+ + + First, click Add... to add the DCPs that you want to join. + Fill in an annotation text (a title) for the combined DCP. Finally, choose an + output folder, click Combine and your combined DCP will be + prepared. + + + + + + + + +Editing DCP metadata + + + The main ‘DCP-o-matic’ tool is designed to ease creation of new DCPs + from existing content. Though it re-uses data where appropriate, it will almost + always create new assets (the large files containing picture, sound or subtitles). + + + + Sometimes it is necessary to make small edits to existing DCPs (especially to + the metadata) or to fix DCPs that have errors. DCP-o-matic has a tool for that: + the ‘DCP-o-matic Editor’. Though it is currently quite limited in + what it can do, you may still find it useful. + + + + Opening the ‘DCP-o-matic Editor’ shows its window: + + +
+ The Editor + + +
-Next, click Open... and choose the DCP that you want to write. + + Load a DCP by using the Open... option from the File + menu. This will display some details about the DCP: + + +
+ The Editor with a DCP loaded + + + + + +
-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. +You can make any changes you wish to the text fields, then re-create the DCP's XML files +by choosing Save from the File menu. +The DCP-o-matic Editor will fix the various checksums, as required, and re-sign the files +using its own certificate. -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. +You can also make changes to the metadata of the individual reels by choosing a reel in the +list and clicking Edit.... Reels are shown in a window like this: - +
+ The Editor editing a reel + + + + + +
 + Keyboard shortcuts diff --git a/doc/manual/raw-screenshots/add-screen.pdf b/doc/manual/raw-screenshots/add-screen.pdf index 6c0754106..414150b7e 100644 Binary files a/doc/manual/raw-screenshots/add-screen.pdf and b/doc/manual/raw-screenshots/add-screen.pdf differ diff --git a/doc/manual/raw-screenshots/audio-tab.pdf b/doc/manual/raw-screenshots/audio-tab.pdf index 7696bb7e3..8893265c6 100644 Binary files a/doc/manual/raw-screenshots/audio-tab.pdf and b/doc/manual/raw-screenshots/audio-tab.pdf differ diff --git a/doc/manual/raw-screenshots/combiner.pdf b/doc/manual/raw-screenshots/combiner.pdf new file mode 100644 index 000000000..27723f3a9 Binary files /dev/null and b/doc/manual/raw-screenshots/combiner.pdf differ diff --git a/doc/manual/raw-screenshots/dcp-tab.pdf b/doc/manual/raw-screenshots/dcp-tab.pdf index 27f333918..9f16dfcaf 100644 Binary files a/doc/manual/raw-screenshots/dcp-tab.pdf and b/doc/manual/raw-screenshots/dcp-tab.pdf differ diff --git a/doc/manual/raw-screenshots/disk-writer-notice.pdf b/doc/manual/raw-screenshots/disk-writer-notice.pdf deleted file mode 100644 index 4060b75a3..000000000 Binary files a/doc/manual/raw-screenshots/disk-writer-notice.pdf and /dev/null differ diff --git a/doc/manual/raw-screenshots/disk-writer.pdf b/doc/manual/raw-screenshots/disk-writer.pdf index 7d713401c..27723f3a9 100644 Binary files a/doc/manual/raw-screenshots/disk-writer.pdf and b/doc/manual/raw-screenshots/disk-writer.pdf differ diff --git a/doc/manual/raw-screenshots/editor-cpl.pdf b/doc/manual/raw-screenshots/editor-cpl.pdf new file mode 100644 index 000000000..373caad34 Binary files /dev/null and b/doc/manual/raw-screenshots/editor-cpl.pdf differ diff --git a/doc/manual/raw-screenshots/editor-reel.pdf b/doc/manual/raw-screenshots/editor-reel.pdf new file mode 100644 index 000000000..aeaf7e6d0 Binary files /dev/null and b/doc/manual/raw-screenshots/editor-reel.pdf differ diff --git a/doc/manual/raw-screenshots/editor.pdf b/doc/manual/raw-screenshots/editor.pdf new file mode 100644 index 000000000..d9e0e6066 Binary files /dev/null and b/doc/manual/raw-screenshots/editor.pdf differ diff --git a/doc/manual/raw-screenshots/markers.pdf b/doc/manual/raw-screenshots/markers.pdf index d0ed8339b..449e33c81 100644 Binary files a/doc/manual/raw-screenshots/markers.pdf and b/doc/manual/raw-screenshots/markers.pdf differ diff --git a/doc/manual/raw-screenshots/prefs-advanced.pdf b/doc/manual/raw-screenshots/prefs-advanced.pdf index 3b1429581..983c6f1cc 100644 Binary files a/doc/manual/raw-screenshots/prefs-advanced.pdf and b/doc/manual/raw-screenshots/prefs-advanced.pdf differ diff --git a/doc/manual/raw-screenshots/prefs-defaults.pdf b/doc/manual/raw-screenshots/prefs-defaults.pdf index f28d28acc..95b43db2a 100644 Binary files a/doc/manual/raw-screenshots/prefs-defaults.pdf and b/doc/manual/raw-screenshots/prefs-defaults.pdf differ diff --git a/doc/manual/raw-screenshots/prefs-email.pdf b/doc/manual/raw-screenshots/prefs-email.pdf index 0f8794ce5..0c7e61e08 100644 Binary files a/doc/manual/raw-screenshots/prefs-email.pdf and b/doc/manual/raw-screenshots/prefs-email.pdf differ diff --git a/doc/manual/raw-screenshots/prefs-general.pdf b/doc/manual/raw-screenshots/prefs-general.pdf index 30bd4635b..9943b32df 100644 Binary files a/doc/manual/raw-screenshots/prefs-general.pdf and b/doc/manual/raw-screenshots/prefs-general.pdf differ diff --git a/doc/manual/raw-screenshots/prefs-identifiers.pdf b/doc/manual/raw-screenshots/prefs-identifiers.pdf index fc38ef2ad..0845338dc 100644 Binary files a/doc/manual/raw-screenshots/prefs-identifiers.pdf and b/doc/manual/raw-screenshots/prefs-identifiers.pdf differ diff --git a/doc/manual/raw-screenshots/prefs-kdm-email.pdf b/doc/manual/raw-screenshots/prefs-kdm-email.pdf index a5db0add7..ecdf5512c 100644 Binary files a/doc/manual/raw-screenshots/prefs-kdm-email.pdf and b/doc/manual/raw-screenshots/prefs-kdm-email.pdf differ diff --git a/doc/manual/raw-screenshots/prefs-keys.pdf b/doc/manual/raw-screenshots/prefs-keys.pdf index ddd557aeb..1afe3818f 100644 Binary files a/doc/manual/raw-screenshots/prefs-keys.pdf and b/doc/manual/raw-screenshots/prefs-keys.pdf differ diff --git a/doc/manual/raw-screenshots/prefs-non-standard.pdf b/doc/manual/raw-screenshots/prefs-non-standard.pdf new file mode 100644 index 000000000..ac4defa79 Binary files /dev/null and b/doc/manual/raw-screenshots/prefs-non-standard.pdf differ diff --git a/doc/manual/raw-screenshots/prefs-notifications.pdf b/doc/manual/raw-screenshots/prefs-notifications.pdf index 088e47f6e..1ca91c18b 100644 Binary files a/doc/manual/raw-screenshots/prefs-notifications.pdf and b/doc/manual/raw-screenshots/prefs-notifications.pdf differ diff --git a/doc/manual/raw-screenshots/prefs-sound.pdf b/doc/manual/raw-screenshots/prefs-sound.pdf index 89743581c..237303efb 100644 Binary files a/doc/manual/raw-screenshots/prefs-sound.pdf and b/doc/manual/raw-screenshots/prefs-sound.pdf differ diff --git a/doc/manual/raw-screenshots/prefs-tms.pdf b/doc/manual/raw-screenshots/prefs-tms.pdf index 98a98fa35..ff8e78cce 100644 Binary files a/doc/manual/raw-screenshots/prefs-tms.pdf and b/doc/manual/raw-screenshots/prefs-tms.pdf differ diff --git a/doc/manual/raw-screenshots/reels.pdf b/doc/manual/raw-screenshots/reels.pdf new file mode 100644 index 000000000..00246967c Binary files /dev/null and b/doc/manual/raw-screenshots/reels.pdf differ diff --git a/doc/manual/raw-screenshots/timed-text-tab.pdf b/doc/manual/raw-screenshots/timed-text-tab.pdf index d4d090ed4..9d3f949f4 100644 Binary files a/doc/manual/raw-screenshots/timed-text-tab.pdf and b/doc/manual/raw-screenshots/timed-text-tab.pdf differ diff --git a/doc/manual/raw-screenshots/vf-setup.pdf b/doc/manual/raw-screenshots/vf-setup.pdf new file mode 100644 index 000000000..8903379d2 Binary files /dev/null and b/doc/manual/raw-screenshots/vf-setup.pdf differ diff --git a/doc/manual/raw-screenshots/video-tab.pdf b/doc/manual/raw-screenshots/video-tab.pdf index 964f0c2f6..70f77da0f 100644 Binary files a/doc/manual/raw-screenshots/video-tab.pdf and b/doc/manual/raw-screenshots/video-tab.pdf differ -- cgit v1.2.3