From: Carl Hetherington Date: Sat, 2 Feb 2019 02:02:41 +0000 (+0000) Subject: Manual tweaks. X-Git-Tag: v2.13.112~3 X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=1473441e9436fb921b34b62d802d4313427c9129 Manual tweaks. --- diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 69eff8138..0c34d30d4 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -31,8 +31,7 @@ Hello, and welcome to DCP-o-matic! Creation of Digital - Cinema Packages (DCPs) from video, audio and/or - subtitle and closed caption files. + Cinema Packages (DCPs) from video, audio, subtitle and closed-caption files. Playback and verification of DCPs on a PC/Mac. Creation of KDMs for DCPs. @@ -255,7 +254,7 @@ you want to use ‘simple’ or ‘full’ mode. 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. +experience with DCP or video processing. Even if you choose ‘Simple’ mode you can always go @@ -335,7 +334,7 @@ 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 whereabouts you want to create the film. In the example from the figure, DCP-o-matic will create a -folder called ‘DCP Test’ inside my home folder (carl) into which it +folder called ‘DCP Test’ inside my existing folder DCP into which it will write its working files. @@ -348,8 +347,8 @@ will write its working files. The next step is to add the content that you want to use. DCP-o-matic -can make DCPs from multiple pieces of content, but in this simple -example we will just use a single piece. Click the Add +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 , and a file chooser will open for you to select the content file to use, as shown in for details about the files that DCP-o-matic creates. -Alternatively, if you have a projector or Theatre Management System -(TMS) that is accessible via SCP or FTP across your network, you can upload -the content directly from DCP-o-matic. See the in . +Alternatively, DCP-o-matic can upload your DCP directly to a projector +or Theatre Management System (TMS) that is accessible via SCP or FTP +across your network. See the in . @@ -496,7 +495,7 @@ linkend="fig-still-select-content-file"/>. 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 -Play length setting, as shown in Full length setting, as shown in . @@ -871,7 +870,7 @@ held down. Note that not all settings can be changed in this way. The content properties are split up into four sections: Video, Audio, -Subtitles and Timing. Not +Timed text and Timing. Not all of these sections will be active for all content types. The controls in each section are described below. @@ -988,7 +987,7 @@ as shown in . After changing the filters setup, you will need to regenerate the DCP to see the effect on the cinema screen. The preview in DCP-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! +image may be smaller and of lower resolution than a projected image! @@ -1097,9 +1096,9 @@ ratio that your content should be presented in. At the bottom of the video tab is a short description of what will happen to your video with the current settings. In the example of , DCP-o-matic is telling you that the -video file is 1920x1080 pixels and it has square pixels (a pixel -aspect ratio of 1.00) hence its display aspect ratio is 1.78:1. Since -the controls specify ‘16.9’ for the ratio, DCP-o-matic +video file is 2048x872 pixels and it has square pixels (a pixel +aspect ratio of 1.00) hence its display aspect ratio is 2.35:1. Since +the controls specify ‘2.35’ for the ratio, DCP-o-matic does not scale the image but pads it to the DCP's container ratio of 1.85:1. For a 2K DCP this is 1998x1080 pixels. @@ -1121,7 +1120,7 @@ frame-rate conversion. Audio -The Audio tab controls properties of the image, as shown in . +The Audio tab controls properties of the sound, as shown in .
@@ -1324,7 +1323,7 @@ content, as shown in . Depending on where timed text comes from it can sometimes be used as -either an open subtitle (to be overlaid onto the cinema screen and so +either an open subtitle (to be overlaid onto the cinema screen and seen by everybody) or as a closed caption (to be displayed to individual viewers using a special system such as the Doremi CaptiView™) @@ -1444,7 +1443,7 @@ button, or specify the fonts that should be used by clicking Fonts...< With any subtitles you can click Appearance... to change how the subtitles look. Some of the controls in the -Apperance only apply to burnt-in subtitles, as +Appearance only apply to burnt-in subtitles, as only limited control is available for subtitles rendered by the projection system. @@ -1557,7 +1556,7 @@ any changes to the corresponding timecode.
- The X axis represents time, and you can see the time codes (in + The horizontal axis represents time, and you can see the time codes (in hours:minutes:seconds) along the bottom of the window. Pieces of content are represented with rectangles in the main part of the window. Content containing different types of data (e.g. a MP4 @@ -1644,7 +1643,7 @@ linkend="fig-pipeline2"/>. The next step is to scale the image. Since this content should be -presented in a 2.39:1 aspect ratio inside a 1.85:1 DCP we would select +presented in a 2.39:1 (scope) aspect ratio inside a 1.85:1 (flat) DCP we would select Scope from the Scale to option in the Video tab and Flat from the Container @@ -1802,7 +1801,7 @@ 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 -‘reels’. See below. +‘reels’. See . @@ -1925,6 +1924,8 @@ This upmixing algorithm is due to Gérald Maruccia. +The up-mixers are not particularly advanced and should be used with care. You are strongly advised to check how the DCPs sound in a cinema if you have used one of DCP-o-matic's upmixers. +
Reels @@ -1932,13 +1933,13 @@ This upmixing algorithm is due to Gérald Maruccia. A ‘reel’ in a DCP is a subsection of the DCP, in the same way as a 35mm reel is a section of a film. A DCP can be split up into -any number of reels and the joins (the equivalent to 35mm splices) +any number of reels and the joins (the equivalent to 35mm splices or changeovers) between the reels are seamless. There is no reason why you can't just use a single reel for the whole -of your DCP, as there is no limit on their length. Many people choose +of your DCP, as there is no limit to their length. Many people choose to do this. @@ -1962,13 +1963,13 @@ It is easier to re-use DCP components if they are in reels. Consider, for example, a film company who wants to put a 5 second ident onto the beginning of DCPs that they distribute. If they receive a feature film DCP they can modify it to add their ident as a separate reel. -This is easier than attaching the picture data in the DCP. +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. +single reel, split by video content or custom. @@ -2088,7 +2089,7 @@ first similarly-typed piece of content in your template. -For example if the template has a piece of video content and some +For example, if the template has a piece of video content and some subtitles, any video that you add to the new film will take on the settings of the video in the template. Similarly, any subtitles that you add will take on the settings of the subtitles from the template. @@ -2356,18 +2357,15 @@ from a file. The certificate should be in SHA256 PEM format. Alternatively, certificates for projection systems made by some manufacturers can be downloaded from databases provided by the -manufacturer. Currently this is supported for Doremi and Dolby -equipment. 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 and, all being well, the certificate -will be fetched. - - - -Using the download system you will need to know the serial number of -the media server in use in the screen. Most cinema projection or -technical departments will know these serial numbers. +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 +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 +and, all being well, the certificate will be fetched. Most cinema +projection or technical departments will know these serial numbers. @@ -2509,11 +2507,50 @@ If you are using a DKDM you must ensure that you have a backup of DCP-o-matic's config.xml file, since it contains the only key which can decrypt the DKDM. The config.xml file location depends on your operating -system; possible locations are listed in +system; possible locations are listed in .
+
+ Should I encrypt? + + + The question of whether encryption is appropriate for a given + project is a tricky one. + + + + On the one hand, if you distribute an unencrypted DCP it is easy for + anybody to take it and do whatever they want with its contents. + They could use DCP-o-matic to convert it to a MP4, show it in + their cinema, or even edit and redistribute it in ways that you + do not like. + + + + Encryption prevents this, but brings its own problems. It will be + impossible for a cinema to screen your DCP unless they have the + correct KDM. This is easy enough if things work as they should, + but problems can occur. For example, cinemas may substitute + broken playout servers with new ones without telling you: then the + KDM that you sent them will be invalid, and a new one required. + If the cinema can't get in touch with you, or somebody else who + can create a new KDM, they can't screen your DCP. Often these + problems are only discovered very close to showtime, with little + time for fixes. + + + + If you are distributing encrypted DCPs widely it is worth thinking + about who will make the KDMs, and who will provide quick-response + technical support. It may be a good idea to engage a company who can + provide such services. + + +
+ +
Encryption overview @@ -2543,7 +2580,7 @@ behaviour. They are described in this chapter. Preferences can be edited by choosing Preferences... from the Edit -menu. This opens a dialogue which is split into seven tabs. +menu. This opens a dialogue which is split into eleven tabs. @@ -2578,11 +2615,23 @@ 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, head to the DCP-o-matic website to -read about how to contribute a translation. +find out how to contribute a translation.
+ +
+ Interface complexity + + + Choose Simple to see a cut-down, simplified + interface or Full to see DCP-o-matic's full + interface. + +
+ +
Number of threads DCP-o-matic should use @@ -2678,7 +2727,6 @@ enabled, will tell DCP-o-matic to check on dcpomatic.com to see if there any newer versions of DCP-o-matic then the one you are running. If so, a dialogue box will open with a link to download the new version. -available @@ -2783,12 +2831,6 @@ that you give it. Use this option if somebody wants to make a KDM for you and asks for your certificate. - -Export KDM decryption chain... exports the whole -KDM decryption chain rather than just its certificate. This may also -be requested by KDM creators. - - Export all KDM decryption settings... exports a file which contains all the DCP-o-matic settings related to the use of @@ -2822,14 +2864,14 @@ chain using the Add... and If you want DCP-o-matic to re-create the certificate chain (using new, random certificates) click Re-make -certificates... and specify your organisation and common +certificates and key... and specify your organisation and common names in the dialogue box that opens. Underneath the certificate chain is the private key that corresponds to the leaf certificate in the chain. You can specify your own -private key by clicking Load.... You must do +private key by clicking Import.... You must do this if you change the leaf certificate, so that the leaf private key corresponds to the public key held in the leaf certificate. @@ -2841,22 +2883,9 @@ The leaf certificate of this chain contains the public key that should be used when targeting a KDM at DCP-o-matic. - - -If you want to import an encrypted DCP you will need to give the -decryption certificate to the distributor of the DCP so that they can -generate a DKDM for you. You can save this certificate to disk by -clicking Export DCP decryption certificate.... -As with the signing chain, DCP-o-matic will create a certificate chain -and private key for you. You can also choose to load your own -certificates and key or re-make the chain and key with new, random -values. - - -Clicking Export DCP decryption chain... will -export the whole certificate chain, rather than just the leaf -certificate. +Clicking Export chain... will +export the whole certificate chain.
@@ -2957,10 +2986,10 @@ The KDM email tab is shown in . 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. A few ‘magic’ strings will be replaced by information from the -KDM that is being sent: +KDM that is being sent; these strings are shown in . - +
‘Magic’ KDM strings @@ -3008,9 +3037,9 @@ The Accounts tab is shown in . -DCP-o-matic can download projector certificates from the Barco and -Christie websites if you have the appropriate credentials. Enter your -usernames and passwords. +DCP-o-matic can download projector certificates from the Barco, +Christie and GDC websites if you have the appropriate credentials. +Enter your usernames and passwords. @@ -3076,7 +3105,7 @@ DCP that has been made:
-‘Magic’ Cover sheet strings +‘Magic’ cover sheet strings @@ -3197,8 +3226,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. @@ -3207,10 +3235,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. @@ -3766,7 +3794,7 @@ The full details of OV and VF files are discussed in - Playing DCPs + Playing and verifying DCPs DCP-o-matic includes a DCP player, and although it requires a very high-speed CPU to play DCPs in full resolution, it can also @@ -3792,6 +3820,12 @@ 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. + + @@ -3813,3 +3847,24 @@ The full details of OV and VF files are discussed in + + + + + + + + + + + diff --git a/doc/manual/screenshots/add-file.png b/doc/manual/screenshots/add-file.png index d61305dcb..456090c80 100644 Binary files a/doc/manual/screenshots/add-file.png and b/doc/manual/screenshots/add-file.png differ diff --git a/doc/manual/screenshots/prefs-accounts.png b/doc/manual/screenshots/prefs-accounts.png index e919e6abf..1730f3b0c 100644 Binary files a/doc/manual/screenshots/prefs-accounts.png and b/doc/manual/screenshots/prefs-accounts.png differ diff --git a/doc/manual/screenshots/prefs-keys.png b/doc/manual/screenshots/prefs-keys.png index 2cb66446d..1d2784f5f 100644 Binary files a/doc/manual/screenshots/prefs-keys.png and b/doc/manual/screenshots/prefs-keys.png differ diff --git a/doc/manual/screenshots/timing-tab.png b/doc/manual/screenshots/timing-tab.png index 2b5b314f3..ba943325a 100644 Binary files a/doc/manual/screenshots/timing-tab.png and b/doc/manual/screenshots/timing-tab.png differ diff --git a/src/wx/full_config_dialog.cc b/src/wx/full_config_dialog.cc index 4a1561b85..80db5b7c0 100644 --- a/src/wx/full_config_dialog.cc +++ b/src/wx/full_config_dialog.cc @@ -981,10 +981,20 @@ public: _christie_password = new wxTextCtrl (_panel, wxID_ANY); table->Add (_christie_password, 1, wxEXPAND | wxALL); + add_label_to_sizer (table, _panel, _("GDC user name"), true); + _gdc_username = new wxTextCtrl (_panel, wxID_ANY); + table->Add (_gdc_username, 1, wxEXPAND | wxALL); + + add_label_to_sizer (table, _panel, _("GDC password"), true); + _gdc_password = new wxTextCtrl (_panel, wxID_ANY); + table->Add (_gdc_password, 1, wxEXPAND | wxALL); + _barco_username->Bind (wxEVT_TEXT, boost::bind(&AccountsPage::barco_username_changed, this)); _barco_password->Bind (wxEVT_TEXT, boost::bind(&AccountsPage::barco_password_changed, this)); _christie_username->Bind (wxEVT_TEXT, boost::bind(&AccountsPage::christie_username_changed, this)); _christie_password->Bind (wxEVT_TEXT, boost::bind(&AccountsPage::christie_password_changed, this)); + _gdc_username->Bind (wxEVT_TEXT, boost::bind(&AccountsPage::gdc_username_changed, this)); + _gdc_password->Bind (wxEVT_TEXT, boost::bind(&AccountsPage::gdc_password_changed, this)); } void config_changed () @@ -995,6 +1005,8 @@ public: checked_set (_barco_password, config->barco_password().get_value_or("")); checked_set (_christie_username, config->christie_username().get_value_or("")); checked_set (_christie_password, config->christie_password().get_value_or("")); + checked_set (_gdc_username, config->gdc_username().get_value_or("")); + checked_set (_gdc_password, config->gdc_password().get_value_or("")); } void barco_username_changed () @@ -1037,11 +1049,33 @@ public: } } + void gdc_username_changed () + { + wxString const s = _gdc_username->GetValue(); + if (!s.IsEmpty()) { + Config::instance()->set_gdc_username (wx_to_std(s)); + } else { + Config::instance()->unset_gdc_username (); + } + } + + void gdc_password_changed () + { + wxString const s = _gdc_password->GetValue(); + if (!s.IsEmpty()) { + Config::instance()->set_gdc_password (wx_to_std(s)); + } else { + Config::instance()->unset_gdc_password (); + } + } + private: wxTextCtrl* _barco_username; wxTextCtrl* _barco_password; wxTextCtrl* _christie_username; wxTextCtrl* _christie_password; + wxTextCtrl* _gdc_username; + wxTextCtrl* _gdc_password; };