Add defaults for facility, studio, chain, distributor (#2075).
[dcpomatic.git] / src / lib / film.cc
1 /*
2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     DCP-o-matic is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 /** @file  src/film.cc
22  *  @brief A representation of some audio, video and subtitle content, and details of
23  *  how they should be presented in a DCP.
24  */
25
26 #include "atmos_content.h"
27 #include "film.h"
28 #include "job.h"
29 #include "util.h"
30 #include "job_manager.h"
31 #include "dcp_encoder.h"
32 #include "transcode_job.h"
33 #include "upload_job.h"
34 #include "null_log.h"
35 #include "file_log.h"
36 #include "dcpomatic_log.h"
37 #include "exceptions.h"
38 #include "examine_content_job.h"
39 #include "config.h"
40 #include "playlist.h"
41 #include "dcp_content_type.h"
42 #include "ratio.h"
43 #include "cross.h"
44 #include "environment_info.h"
45 #include "audio_processor.h"
46 #include "digester.h"
47 #include "compose.hpp"
48 #include "screen.h"
49 #include "audio_content.h"
50 #include "video_content.h"
51 #include "text_content.h"
52 #include "ffmpeg_content.h"
53 #include "dcp_content.h"
54 #include "kdm_with_metadata.h"
55 #include "cinema.h"
56 #include "change_signaller.h"
57 #include "check_content_change_job.h"
58 #include "ffmpeg_subtitle_stream.h"
59 #include "font.h"
60 #include <libcxml/cxml.h>
61 #include <dcp/cpl.h>
62 #include <dcp/certificate_chain.h>
63 #include <dcp/util.h>
64 #include <dcp/local_time.h>
65 #include <dcp/decrypted_kdm.h>
66 #include <dcp/raw_convert.h>
67 #include <dcp/reel_file_asset.h>
68 #include <dcp/reel_asset.h>
69 #include <libxml++/libxml++.h>
70 #include <boost/filesystem.hpp>
71 #include <boost/algorithm/string.hpp>
72 #include <boost/regex.hpp>
73 #include <unistd.h>
74 #include <stdexcept>
75 #include <iostream>
76 #include <algorithm>
77 #include <cstdlib>
78 #include <iomanip>
79 #include <set>
80
81 #include "i18n.h"
82
83 using std::string;
84 using std::pair;
85 using std::vector;
86 using std::setfill;
87 using std::min;
88 using std::max;
89 using std::make_pair;
90 using std::cout;
91 using std::list;
92 using std::set;
93 using std::runtime_error;
94 using std::copy;
95 using std::back_inserter;
96 using std::map;
97 using std::exception;
98 using std::find;
99 using std::shared_ptr;
100 using std::weak_ptr;
101 using std::make_shared;
102 using std::dynamic_pointer_cast;
103 using boost::optional;
104 using boost::is_any_of;
105 #if BOOST_VERSION >= 106100
106 using namespace boost::placeholders;
107 #endif
108 using dcp::raw_convert;
109 using namespace dcpomatic;
110
111 string const Film::metadata_file = "metadata.xml";
112
113 /* 5 -> 6
114  * AudioMapping XML changed.
115  * 6 -> 7
116  * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
117  * 7 -> 8
118  * Use <Scale> tag in <VideoContent> rather than <Ratio>.
119  * 8 -> 9
120  * DCI -> ISDCF
121  * 9 -> 10
122  * Subtitle X and Y scale.
123  *
124  * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
125  * than frames now.
126  *
127  * 32 -> 33
128  * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
129  * 33 -> 34
130  * Content only contains audio/subtitle-related tags if those things
131  * are present.
132  * 34 -> 35
133  * VideoFrameType in VideoContent is a string rather than an integer.
134  * 35 -> 36
135  * EffectColour rather than OutlineColour in Subtitle.
136  * 36 -> 37
137  * TextContent can be in a Caption tag, and some of the tag names
138  * have had Subtitle prefixes or suffixes removed.
139  * 37 -> 38
140  * VideoContent scale expressed just as "guess" or "custom"
141  */
142 int const Film::current_state_version = 38;
143
144 /** Construct a Film object in a given directory.
145  *
146  *  @param dir Film directory.
147  */
148
149 Film::Film (optional<boost::filesystem::path> dir)
150         : _playlist (new Playlist)
151         , _use_isdcf_name (true)
152         , _dcp_content_type (Config::instance()->default_dcp_content_type ())
153         , _container (Config::instance()->default_container ())
154         , _resolution (Resolution::TWO_K)
155         , _encrypted (false)
156         , _context_id (dcp::make_uuid ())
157         , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
158         , _video_frame_rate (24)
159         , _audio_channels (Config::instance()->default_dcp_audio_channels ())
160         , _three_d (false)
161         , _sequence (true)
162         , _interop (Config::instance()->default_interop ())
163         , _audio_processor (0)
164         , _reel_type (ReelType::SINGLE)
165         , _reel_length (2000000000)
166         , _reencode_j2k (false)
167         , _user_explicit_video_frame_rate (false)
168         , _user_explicit_container (false)
169         , _user_explicit_resolution (false)
170         , _name_language (dcp::LanguageTag("en-US"))
171         , _version_number (1)
172         , _status (dcp::Status::FINAL)
173         , _state_version (current_state_version)
174         , _dirty (false)
175         , _tolerant (false)
176 {
177         set_isdcf_date_today ();
178
179         auto metadata = Config::instance()->default_metadata();
180         if (metadata.find("chain") != metadata.end()) {
181                 _chain = metadata["chain"];
182         }
183         if (metadata.find("distributor") != metadata.end()) {
184                 _distributor = metadata["distributor"];
185         }
186         if (metadata.find("facility") != metadata.end()) {
187                 _facility = metadata["facility"];
188         }
189         if (metadata.find("studio") != metadata.end()) {
190                 _studio = metadata["studio"];
191         }
192
193         _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
194         _playlist_order_changed_connection = _playlist->OrderChange.connect (bind (&Film::playlist_order_changed, this));
195         _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
196         _playlist_length_change_connection = _playlist->LengthChange.connect (bind(&Film::playlist_length_change, this));
197
198         if (dir) {
199                 /* Make state.directory a complete path without ..s (where possible)
200                    (Code swiped from Adam Bowen on stackoverflow)
201                    XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
202                 */
203
204                 boost::filesystem::path p (boost::filesystem::system_complete (dir.get()));
205                 boost::filesystem::path result;
206                 for (auto i: p) {
207                         if (i == "..") {
208                                 boost::system::error_code ec;
209                                 if (boost::filesystem::is_symlink(result, ec) || result.filename() == "..") {
210                                         result /= i;
211                                 } else {
212                                         result = result.parent_path ();
213                                 }
214                         } else if (i != ".") {
215                                 result /= i;
216                         }
217                 }
218
219                 set_directory (result.make_preferred ());
220         }
221
222         if (_directory) {
223                 _log = make_shared<FileLog>(file("log"));
224         } else {
225                 _log = make_shared<NullLog>();
226         }
227
228         _playlist->set_sequence (_sequence);
229 }
230
231 Film::~Film ()
232 {
233         for (auto& i: _job_connections) {
234                 i.disconnect ();
235         }
236
237         for (auto& i: _audio_analysis_connections) {
238                 i.disconnect ();
239         }
240 }
241
242 string
243 Film::video_identifier () const
244 {
245         DCPOMATIC_ASSERT (container ());
246
247         string s = container()->id()
248                 + "_" + resolution_to_string (_resolution)
249                 + "_" + _playlist->video_identifier()
250                 + "_" + raw_convert<string>(_video_frame_rate)
251                 + "_" + raw_convert<string>(j2k_bandwidth());
252
253         if (encrypted ()) {
254                 /* This is insecure but hey, the key is in plaintext in metadata.xml */
255                 s += "_E" + _key.hex();
256         } else {
257                 s += "_P";
258         }
259
260         if (_interop) {
261                 s += "_I";
262         } else {
263                 s += "_S";
264         }
265
266         if (_three_d) {
267                 s += "_3D";
268         }
269
270         return s;
271 }
272
273 /** @return The file to write video frame info to */
274 boost::filesystem::path
275 Film::info_file (DCPTimePeriod period) const
276 {
277         boost::filesystem::path p;
278         p /= "info";
279         p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
280         return file (p);
281 }
282
283 boost::filesystem::path
284 Film::internal_video_asset_dir () const
285 {
286         return dir ("video");
287 }
288
289 boost::filesystem::path
290 Film::internal_video_asset_filename (DCPTimePeriod p) const
291 {
292         return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
293 }
294
295 boost::filesystem::path
296 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
297 {
298         auto p = dir ("analysis");
299
300         Digester digester;
301         for (auto i: playlist->content()) {
302                 if (!i->audio) {
303                         continue;
304                 }
305
306                 digester.add (i->digest());
307                 digester.add (i->audio->mapping().digest());
308                 if (playlist->content().size() != 1) {
309                         /* Analyses should be considered equal regardless of gain
310                            if they were made from just one piece of content.  This
311                            is because we can fake any gain change in a single-content
312                            analysis at the plotting stage rather than having to
313                            recompute it.
314                         */
315                         digester.add (i->audio->gain());
316
317                         /* Likewise we only care about position if we're looking at a
318                          * whole-project view.
319                          */
320                         digester.add (i->position().get());
321                         digester.add (i->trim_start().get());
322                         digester.add (i->trim_end().get());
323                 }
324         }
325
326         if (audio_processor ()) {
327                 digester.add (audio_processor()->id ());
328         }
329
330         digester.add (audio_channels());
331
332         p /= digester.get ();
333         return p;
334 }
335
336
337 boost::filesystem::path
338 Film::subtitle_analysis_path (shared_ptr<const Content> content) const
339 {
340         auto p = dir ("analysis");
341
342         Digester digester;
343         digester.add (content->digest());
344
345         if (!content->text.empty()) {
346                 auto tc = content->text.front();
347                 digester.add (tc->x_scale());
348                 digester.add (tc->y_scale());
349                 for (auto i: tc->fonts()) {
350                         digester.add (i->id());
351                 }
352                 if (tc->effect()) {
353                         digester.add (tc->effect().get());
354                 }
355                 digester.add (tc->line_spacing());
356                 digester.add (tc->outline_width());
357         }
358
359         auto fc = dynamic_pointer_cast<const FFmpegContent>(content);
360         if (fc) {
361                 digester.add (fc->subtitle_stream()->identifier());
362         }
363
364         p /= digester.get ();
365         return p;
366 }
367
368
369 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
370  *  @param gui true if this is being called from a GUI tool.
371  *  @param check true to check the content in the project for changes before making the DCP.
372  */
373 void
374 Film::make_dcp (bool gui, bool check)
375 {
376         if (dcp_name().find ("/") != string::npos) {
377                 throw BadSettingError (_("name"), _("Cannot contain slashes"));
378         }
379
380         if (container() == nullptr) {
381                 throw MissingSettingError (_("container"));
382         }
383
384         if (content().empty()) {
385                 throw runtime_error (_("You must add some content to the DCP before creating it"));
386         }
387
388         if (length() == DCPTime()) {
389                 throw runtime_error (_("The DCP is empty, perhaps because all the content has zero length."));
390         }
391
392         if (dcp_content_type() == nullptr) {
393                 throw MissingSettingError (_("content type"));
394         }
395
396         if (name().empty()) {
397                 set_name ("DCP");
398         }
399
400         for (auto i: content ()) {
401                 if (!i->paths_valid()) {
402                         throw runtime_error (_("some of your content is missing"));
403                 }
404                 auto dcp = dynamic_pointer_cast<const DCPContent>(i);
405                 if (dcp && dcp->needs_kdm()) {
406                         throw runtime_error (_("Some of your content needs a KDM"));
407                 }
408                 if (dcp && dcp->needs_assets()) {
409                         throw runtime_error (_("Some of your content needs an OV"));
410                 }
411         }
412
413         set_isdcf_date_today ();
414
415         for (auto i: environment_info ()) {
416                 LOG_GENERAL_NC (i);
417         }
418
419         for (auto i: content ()) {
420                 LOG_GENERAL ("Content: %1", i->technical_summary());
421         }
422         LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
423         if (Config::instance()->only_servers_encode ()) {
424                 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
425         } else {
426                 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
427         }
428         LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
429
430         auto tj = make_shared<TranscodeJob>(shared_from_this());
431         tj->set_encoder (make_shared<DCPEncoder>(shared_from_this(), tj));
432         if (check) {
433                 auto cc = make_shared<CheckContentChangeJob>(shared_from_this(), tj, gui);
434                 JobManager::instance()->add (cc);
435         } else {
436                 JobManager::instance()->add (tj);
437         }
438 }
439
440 /** Start a job to send our DCP to the configured TMS */
441 void
442 Film::send_dcp_to_tms ()
443 {
444         JobManager::instance()->add(make_shared<UploadJob>(shared_from_this()));
445 }
446
447 shared_ptr<xmlpp::Document>
448 Film::metadata (bool with_content_paths) const
449 {
450         auto doc = make_shared<xmlpp::Document>();
451         auto root = doc->create_root_node ("Metadata");
452
453         root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
454         root->add_child("Name")->add_child_text (_name);
455         root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
456
457         if (_dcp_content_type) {
458                 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
459         }
460
461         if (_container) {
462                 root->add_child("Container")->add_child_text (_container->id ());
463         }
464
465         root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
466         root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
467         root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
468         root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
469         root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
470         root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
471         root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
472         root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
473         root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
474         root->add_child("Key")->add_child_text (_key.hex ());
475         root->add_child("ContextID")->add_child_text (_context_id);
476         if (_audio_processor) {
477                 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
478         }
479         root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
480         root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
481         root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
482         root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
483         for (map<dcp::Marker, DCPTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
484                 auto m = root->add_child("Marker");
485                 m->set_attribute("Type", dcp::marker_to_string(i->first));
486                 m->add_child_text(raw_convert<string>(i->second.get()));
487         }
488         for (auto i: _ratings) {
489                 i.as_xml (root->add_child("Rating"));
490         }
491         for (auto i: _content_versions) {
492                 root->add_child("ContentVersion")->add_child_text(i);
493         }
494         root->add_child("NameLanguage")->add_child_text(_name_language.to_string());
495         if (_release_territory) {
496                 root->add_child("ReleaseTerritory")->add_child_text(_release_territory->subtag());
497         }
498         if (_sign_language_video_language) {
499                 root->add_child("SignLanguageVideoLanguage")->add_child_text(_sign_language_video_language->to_string());
500         }
501         root->add_child("VersionNumber")->add_child_text(raw_convert<string>(_version_number));
502         root->add_child("Status")->add_child_text(dcp::status_to_string(_status));
503         if (_chain) {
504                 root->add_child("Chain")->add_child_text(*_chain);
505         }
506         if (_distributor) {
507                 root->add_child("Distributor")->add_child_text(*_distributor);
508         }
509         if (_facility) {
510                 root->add_child("Facility")->add_child_text(*_facility);
511         }
512         if (_studio) {
513                 root->add_child("Studio")->add_child_text(*_studio);
514         }
515         root->add_child("TempVersion")->add_child_text(_temp_version ? "1" : "0");
516         root->add_child("PreRelease")->add_child_text(_pre_release ? "1" : "0");
517         root->add_child("RedBand")->add_child_text(_red_band ? "1" : "0");
518         root->add_child("TwoDVersionOfThreeD")->add_child_text(_two_d_version_of_three_d ? "1" : "0");
519         if (_luminance) {
520                 root->add_child("LuminanceValue")->add_child_text(raw_convert<string>(_luminance->value()));
521                 root->add_child("LuminanceUnit")->add_child_text(dcp::Luminance::unit_to_string(_luminance->unit()));
522         }
523         root->add_child("UserExplicitContainer")->add_child_text(_user_explicit_container ? "1" : "0");
524         root->add_child("UserExplicitResolution")->add_child_text(_user_explicit_resolution ? "1" : "0");
525         if (_audio_language) {
526                 root->add_child("AudioLanguage")->add_child_text(_audio_language->to_string());
527         }
528         _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
529
530         return doc;
531 }
532
533 void
534 Film::write_metadata (boost::filesystem::path path) const
535 {
536         metadata()->write_to_file_formatted(path.string());
537 }
538
539 /** Write state to our `metadata' file */
540 void
541 Film::write_metadata () const
542 {
543         DCPOMATIC_ASSERT (directory());
544         boost::filesystem::create_directories (directory().get());
545         metadata()->write_to_file_formatted(file(metadata_file).string());
546         _dirty = false;
547 }
548
549 /** Write a template from this film */
550 void
551 Film::write_template (boost::filesystem::path path) const
552 {
553         boost::filesystem::create_directories (path.parent_path());
554         shared_ptr<xmlpp::Document> doc = metadata (false);
555         metadata(false)->write_to_file_formatted(path.string());
556 }
557
558 /** Read state from our metadata file.
559  *  @return Notes about things that the user should know about, or empty.
560  */
561 list<string>
562 Film::read_metadata (optional<boost::filesystem::path> path)
563 {
564         if (!path) {
565                 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
566                         throw runtime_error (_("This film was created with an older version of DCP-o-matic, and unfortunately it cannot be loaded into this version.  You will need to create a new Film, re-add your content and set it up again.  Sorry!"));
567                 }
568
569                 path = file (metadata_file);
570         }
571
572         if (!boost::filesystem::exists(*path)) {
573                 throw FileNotFoundError(*path);
574         }
575
576         cxml::Document f ("Metadata");
577         f.read_file (path.get ());
578
579         _state_version = f.number_child<int> ("Version");
580         if (_state_version > current_state_version) {
581                 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version.  Sorry!"));
582         } else if (_state_version < current_state_version) {
583                 /* This is an older version; save a copy (if we haven't already) */
584                 auto const older = path->parent_path() / String::compose("metadata.%1.xml", _state_version);
585                 if (!boost::filesystem::is_regular_file(older)) {
586                         try {
587                                 boost::filesystem::copy_file(*path, older);
588                         } catch (...) {
589                                 /* Never mind; at least we tried */
590                         }
591                 }
592         }
593
594         _name = f.string_child ("Name");
595         if (_state_version >= 9) {
596                 _use_isdcf_name = f.bool_child ("UseISDCFName");
597                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
598         } else {
599                 _use_isdcf_name = f.bool_child ("UseDCIName");
600                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
601         }
602
603
604         {
605                 auto c = f.optional_string_child("DCPContentType");
606                 if (c) {
607                         _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
608                 }
609         }
610
611         {
612                 auto c = f.optional_string_child("Container");
613                 if (c) {
614                         _container = Ratio::from_id (c.get ());
615                 }
616         }
617
618         _resolution = string_to_resolution (f.string_child ("Resolution"));
619         _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
620         _video_frame_rate = f.number_child<int> ("VideoFrameRate");
621         _encrypted = f.bool_child ("Encrypted");
622         _audio_channels = f.number_child<int> ("AudioChannels");
623         /* We used to allow odd numbers (and zero) channels, but it's just not worth
624            the pain.
625         */
626         if (_audio_channels == 0) {
627                 _audio_channels = 2;
628         } else if ((_audio_channels % 2) == 1) {
629                 _audio_channels++;
630         }
631
632         if (f.optional_bool_child("SequenceVideo")) {
633                 _sequence = f.bool_child("SequenceVideo");
634         } else {
635                 _sequence = f.bool_child("Sequence");
636         }
637
638         _three_d = f.bool_child ("ThreeD");
639         _interop = f.bool_child ("Interop");
640         _key = dcp::Key (f.string_child ("Key"));
641         _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
642
643         if (f.optional_string_child ("AudioProcessor")) {
644                 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
645         } else {
646                 _audio_processor = 0;
647         }
648
649         if (_audio_processor && !Config::instance()->show_experimental_audio_processors()) {
650                 auto ap = AudioProcessor::visible();
651                 if (find(ap.begin(), ap.end(), _audio_processor) == ap.end()) {
652                         Config::instance()->set_show_experimental_audio_processors(true);
653                 }
654         }
655
656         _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(ReelType::SINGLE)));
657         _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
658         _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
659         _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
660
661         for (auto i: f.node_children("Marker")) {
662                 _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
663         }
664
665         for (auto i: f.node_children("Rating")) {
666                 _ratings.push_back (dcp::Rating(i));
667         }
668
669         for (auto i: f.node_children("ContentVersion")) {
670                 _content_versions.push_back (i->content());
671         }
672
673         auto name_language = f.optional_string_child("NameLanguage");
674         if (name_language) {
675                 _name_language = dcp::LanguageTag (*name_language);
676         }
677         auto release_territory = f.optional_string_child("ReleaseTerritory");
678         if (release_territory) {
679                 _release_territory = dcp::LanguageTag::RegionSubtag (*release_territory);
680         }
681
682         auto sign_language_video_language = f.optional_string_child("SignLanguageVideoLanguage");
683         if (sign_language_video_language) {
684                 _sign_language_video_language = dcp::LanguageTag(*sign_language_video_language);
685         }
686
687         _version_number = f.optional_number_child<int>("VersionNumber").get_value_or(0);
688
689         auto status = f.optional_string_child("Status");
690         if (status) {
691                 _status = dcp::string_to_status (*status);
692         }
693
694         _chain = f.optional_string_child("Chain");
695         _distributor = f.optional_string_child("Distributor");
696         _facility = f.optional_string_child("Facility");
697         _studio = f.optional_string_child("Studio");
698         _temp_version = f.optional_bool_child("TempVersion").get_value_or(false);
699         _pre_release = f.optional_bool_child("PreRelease").get_value_or(false);
700         _red_band = f.optional_bool_child("RedBand").get_value_or(false);
701         _two_d_version_of_three_d = f.optional_bool_child("TwoDVersionOfThreeD").get_value_or(false);
702
703         auto value = f.optional_number_child<float>("LuminanceValue");
704         auto unit = f.optional_string_child("LuminanceUnit");
705         if (value && unit) {
706                 _luminance = dcp::Luminance (*value, dcp::Luminance::string_to_unit(*unit));
707         }
708
709         /* Disable guessing for files made in previous DCP-o-matic versions */
710         _user_explicit_container = f.optional_bool_child("UserExplicitContainer").get_value_or(true);
711         _user_explicit_resolution = f.optional_bool_child("UserExplicitResolution").get_value_or(true);
712
713         auto audio_language = f.optional_string_child("AudioLanguage");
714         if (audio_language) {
715                 _audio_language = dcp::LanguageTag(*audio_language);
716         }
717
718         list<string> notes;
719         _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
720
721         /* Write backtraces to this film's directory, until another film is loaded */
722         if (_directory) {
723                 set_backtrace_file (file ("backtrace.txt"));
724         }
725
726         _dirty = false;
727         return notes;
728 }
729
730 /** Given a directory name, return its full path within the Film's directory.
731  *  @param d directory name within the Film's directory.
732  *  @param create true to create the directory (and its parents) if they do not exist.
733  */
734 boost::filesystem::path
735 Film::dir (boost::filesystem::path d, bool create) const
736 {
737         DCPOMATIC_ASSERT (_directory);
738
739         boost::filesystem::path p;
740         p /= _directory.get();
741         p /= d;
742
743         if (create) {
744                 boost::filesystem::create_directories (p);
745         }
746
747         return p;
748 }
749
750 /** Given a file or directory name, return its full path within the Film's directory.
751  *  Any required parent directories will be created.
752  */
753 boost::filesystem::path
754 Film::file (boost::filesystem::path f) const
755 {
756         DCPOMATIC_ASSERT (_directory);
757
758         boost::filesystem::path p;
759         p /= _directory.get();
760         p /= f;
761
762         boost::filesystem::create_directories (p.parent_path ());
763
764         return p;
765 }
766
767 list<int>
768 Film::mapped_audio_channels () const
769 {
770         list<int> mapped;
771
772         if (audio_processor ()) {
773                 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
774                 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
775                         mapped.push_back (i);
776                 }
777         } else {
778                 for (auto i: content()) {
779                         if (i->audio) {
780                                 auto c = i->audio->mapping().mapped_output_channels();
781                                 copy (c.begin(), c.end(), back_inserter(mapped));
782                         }
783                 }
784
785                 mapped.sort ();
786                 mapped.unique ();
787         }
788
789         return mapped;
790 }
791
792
793 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>>
794 Film::subtitle_languages () const
795 {
796         pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>> result;
797         for (auto i: content()) {
798                 for (auto j: i->text) {
799                         if (j->use() && j->type() == TextType::OPEN_SUBTITLE && j->language()) {
800                                 if (j->language_is_additional()) {
801                                         result.second.push_back (j->language().get());
802                                 } else {
803                                         result.first = j->language().get();
804                                 }
805                         }
806                 }
807                 if (i->video && i->video->burnt_subtitle_language()) {
808                         result.first = i->video->burnt_subtitle_language();
809                 }
810         }
811
812         std::sort (result.second.begin(), result.second.end());
813         auto last = std::unique (result.second.begin(), result.second.end());
814         result.second.erase (last, result.second.end());
815         return result;
816 }
817
818
819 /** @return a ISDCF-compliant name for a DCP of this film */
820 string
821 Film::isdcf_name (bool if_created_now) const
822 {
823         string d;
824
825         auto raw_name = name ();
826
827         /* Split the raw name up into words */
828         vector<string> words;
829         split (words, raw_name, is_any_of (" _-"));
830
831         string fixed_name;
832
833         /* Add each word to fixed_name */
834         for (auto i: words) {
835                 string w = i;
836
837                 /* First letter is always capitalised */
838                 w[0] = toupper (w[0]);
839
840                 /* Count caps in w */
841                 size_t caps = 0;
842                 for (size_t j = 0; j < w.size(); ++j) {
843                         if (isupper (w[j])) {
844                                 ++caps;
845                         }
846                 }
847
848                 /* If w is all caps make the rest of it lower case, otherwise
849                    leave it alone.
850                 */
851                 if (caps == w.size ()) {
852                         for (size_t j = 1; j < w.size(); ++j) {
853                                 w[j] = tolower (w[j]);
854                         }
855                 }
856
857                 for (size_t j = 0; j < w.size(); ++j) {
858                         fixed_name += w[j];
859                 }
860         }
861
862         if (fixed_name.length() > 14) {
863                 fixed_name = fixed_name.substr (0, 14);
864         }
865
866         d += fixed_name;
867
868         if (dcp_content_type()) {
869                 d += "_" + dcp_content_type()->isdcf_name();
870                 string version = "1";
871                 if (_interop) {
872                         if (!_content_versions.empty()) {
873                                 auto cv = _content_versions[0];
874                                 if (!cv.empty() && std::all_of(cv.begin(), cv.end(), isdigit)) {
875                                         version = cv;
876                                 }
877                         }
878                 } else {
879                         version = dcp::raw_convert<string>(_version_number);
880                 }
881                 d += "-" + version;
882         }
883
884         if (_temp_version) {
885                 d += "-Temp";
886         }
887
888         if (_pre_release) {
889                 d += "-Pre";
890         }
891
892         if (_red_band) {
893                 d += "-RedBand";
894         }
895
896         if (_chain && !_chain->empty()) {
897                 d += "-" + *_chain;
898         }
899
900         if (three_d ()) {
901                 d += "-3D";
902         }
903
904         if (_two_d_version_of_three_d) {
905                 d += "-2D";
906         }
907
908         if (_luminance) {
909                 auto fl = _luminance->value_in_foot_lamberts();
910                 char buffer[64];
911                 snprintf (buffer, sizeof(buffer), "%.1f", fl);
912                 d += String::compose("-%1fl", buffer);
913         }
914
915         if (video_frame_rate() != 24) {
916                 d += "-" + raw_convert<string>(video_frame_rate());
917         }
918
919         if (container()) {
920                 d += "_" + container()->isdcf_name();
921         }
922
923         /* XXX: this uses the first bit of content only */
924
925         /* Interior aspect ratio.  The standard says we don't do this for trailers, for some strange reason */
926         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::ContentKind::TRAILER) {
927                 auto cl = content();
928                 auto first_video = std::find_if(cl.begin(), cl.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->video); });
929                 if (first_video != cl.end()) {
930                         auto first_ratio = lrintf((*first_video)->video->scaled_size(frame_size()).ratio() * 100);
931                         auto container_ratio = lrintf(container()->ratio() * 100);
932                         if (first_ratio != container_ratio) {
933                                 d += "-" + dcp::raw_convert<string>(first_ratio);
934                         }
935                 }
936         }
937
938         auto audio_language = (_audio_language && _audio_language->language()) ? _audio_language->language()->subtag() : "XX";
939
940         d += "_" + to_upper (audio_language);
941
942         /* I'm not clear on the precise details of the convention for CCAP labelling;
943            for now I'm just appending -CCAP if we have any closed captions.
944         */
945
946         auto burnt_in = true;
947         auto ccap = false;
948         for (auto i: content()) {
949                 for (auto j: i->text) {
950                         if (j->type() == TextType::OPEN_SUBTITLE && j->use() && !j->burn()) {
951                                 burnt_in = false;
952                         } else if (j->type() == TextType::CLOSED_CAPTION && j->use()) {
953                                 ccap = true;
954                         }
955                 }
956         }
957
958         auto sub_langs = subtitle_languages();
959         if (sub_langs.first && sub_langs.first->language()) {
960                 auto lang = sub_langs.first->language()->subtag();
961                 if (burnt_in) {
962                         transform (lang.begin(), lang.end(), lang.begin(), ::tolower);
963                 } else {
964                         lang = to_upper (lang);
965                 }
966
967                 d += "-" + lang;
968                 if (ccap) {
969                         d += "-CCAP";
970                 }
971         } else {
972                 /* No subtitles */
973                 d += "-XX";
974         }
975
976         if (_release_territory) {
977                 auto territory = _release_territory->subtag();
978                 d += "_" + to_upper (territory);
979                 if (_ratings.empty ()) {
980                         d += "-NR";
981                 } else {
982                         d += "-" + _ratings[0].label;
983                 }
984         }
985
986         /* Count mapped audio channels */
987
988         auto mapped = mapped_audio_channels ();
989
990         auto ch = audio_channel_types (mapped, audio_channels());
991         if (!ch.first && !ch.second) {
992                 d += "_MOS";
993         } else if (ch.first) {
994                 d += String::compose("_%1%2", ch.first, ch.second);
995         }
996
997         if (audio_channels() > static_cast<int>(dcp::Channel::HI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::HI)) != mapped.end()) {
998                 d += "-HI";
999         }
1000         if (audio_channels() > static_cast<int>(dcp::Channel::VI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::VI)) != mapped.end()) {
1001                 d += "-VI";
1002         }
1003
1004         d += "_" + resolution_to_string (_resolution);
1005
1006         if (_studio && _studio->length() >= 2) {
1007                 d += "_" + to_upper (_studio->substr(0, 4));
1008         }
1009
1010         if (if_created_now) {
1011                 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
1012         } else {
1013                 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
1014         }
1015
1016         if (_facility && _facility->length() >= 3) {
1017                 d += "_" + to_upper(_facility->substr(0, 3));
1018         }
1019
1020         if (_interop) {
1021                 d += "_IOP";
1022         } else {
1023                 d += "_SMPTE";
1024         }
1025
1026         if (three_d ()) {
1027                 d += "-3D";
1028         }
1029
1030         auto vf = false;
1031         for (auto i: content()) {
1032                 auto dc = dynamic_pointer_cast<const DCPContent>(i);
1033                 if (!dc) {
1034                         continue;
1035                 }
1036
1037                 bool any_text = false;
1038                 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1039                         if (dc->reference_text(static_cast<TextType>(i))) {
1040                                 any_text = true;
1041                         }
1042                 }
1043                 if (dc->reference_video() || dc->reference_audio() || any_text) {
1044                         vf = true;
1045                 }
1046         }
1047
1048         if (vf) {
1049                 d += "_VF";
1050         } else {
1051                 d += "_OV";
1052         }
1053
1054         return d;
1055 }
1056
1057 /** @return name to give the DCP */
1058 string
1059 Film::dcp_name (bool if_created_now) const
1060 {
1061         string unfiltered;
1062         if (use_isdcf_name()) {
1063                 return careful_string_filter (isdcf_name (if_created_now));
1064         }
1065
1066         return careful_string_filter (name ());
1067 }
1068
1069 void
1070 Film::set_directory (boost::filesystem::path d)
1071 {
1072         _directory = d;
1073         _dirty = true;
1074 }
1075
1076 void
1077 Film::set_name (string n)
1078 {
1079         FilmChangeSignaller ch (this, Property::NAME);
1080         _name = n;
1081 }
1082
1083 void
1084 Film::set_use_isdcf_name (bool u)
1085 {
1086         FilmChangeSignaller ch (this, Property::USE_ISDCF_NAME);
1087         _use_isdcf_name = u;
1088 }
1089
1090 void
1091 Film::set_dcp_content_type (DCPContentType const * t)
1092 {
1093         FilmChangeSignaller ch (this, Property::DCP_CONTENT_TYPE);
1094         _dcp_content_type = t;
1095 }
1096
1097
1098 /** @param explicit_user true if this is being set because of
1099  *  a direct user request, false if it is being done because
1100  *  DCP-o-matic is guessing the best container to use.
1101  */
1102 void
1103 Film::set_container (Ratio const * c, bool explicit_user)
1104 {
1105         FilmChangeSignaller ch (this, Property::CONTAINER);
1106         _container = c;
1107
1108         if (explicit_user) {
1109                 _user_explicit_container = true;
1110         }
1111 }
1112
1113
1114 /** @param explicit_user true if this is being set because of
1115  *  a direct user request, false if it is being done because
1116  *  DCP-o-matic is guessing the best resolution to use.
1117  */
1118 void
1119 Film::set_resolution (Resolution r, bool explicit_user)
1120 {
1121         FilmChangeSignaller ch (this, Property::RESOLUTION);
1122         _resolution = r;
1123
1124         if (explicit_user) {
1125                 _user_explicit_resolution = true;
1126         }
1127 }
1128
1129
1130 void
1131 Film::set_j2k_bandwidth (int b)
1132 {
1133         FilmChangeSignaller ch (this, Property::J2K_BANDWIDTH);
1134         _j2k_bandwidth = b;
1135 }
1136
1137 /** @param f New frame rate.
1138  *  @param user_explicit true if this comes from a direct user instruction, false if it is from
1139  *  DCP-o-matic being helpful.
1140  */
1141 void
1142 Film::set_video_frame_rate (int f, bool user_explicit)
1143 {
1144         FilmChangeSignaller ch (this, Property::VIDEO_FRAME_RATE);
1145         _video_frame_rate = f;
1146         if (user_explicit) {
1147                 _user_explicit_video_frame_rate = true;
1148         }
1149 }
1150
1151 void
1152 Film::set_audio_channels (int c)
1153 {
1154         FilmChangeSignaller ch (this, Property::AUDIO_CHANNELS);
1155         _audio_channels = c;
1156 }
1157
1158 void
1159 Film::set_three_d (bool t)
1160 {
1161         FilmChangeSignaller ch (this, Property::THREE_D);
1162         _three_d = t;
1163
1164         if (_three_d && _two_d_version_of_three_d) {
1165                 set_two_d_version_of_three_d (false);
1166         }
1167 }
1168
1169 void
1170 Film::set_interop (bool i)
1171 {
1172         FilmChangeSignaller ch (this, Property::INTEROP);
1173         _interop = i;
1174 }
1175
1176 void
1177 Film::set_audio_processor (AudioProcessor const * processor)
1178 {
1179         FilmChangeSignaller ch1 (this, Property::AUDIO_PROCESSOR);
1180         FilmChangeSignaller ch2 (this, Property::AUDIO_CHANNELS);
1181         _audio_processor = processor;
1182 }
1183
1184 void
1185 Film::set_reel_type (ReelType t)
1186 {
1187         FilmChangeSignaller ch (this, Property::REEL_TYPE);
1188         _reel_type = t;
1189 }
1190
1191 /** @param r Desired reel length in bytes */
1192 void
1193 Film::set_reel_length (int64_t r)
1194 {
1195         FilmChangeSignaller ch (this, Property::REEL_LENGTH);
1196         _reel_length = r;
1197 }
1198
1199 void
1200 Film::set_reencode_j2k (bool r)
1201 {
1202         FilmChangeSignaller ch (this, Property::REENCODE_J2K);
1203         _reencode_j2k = r;
1204 }
1205
1206 void
1207 Film::signal_change (ChangeType type, int p)
1208 {
1209         signal_change (type, static_cast<Property>(p));
1210 }
1211
1212 void
1213 Film::signal_change (ChangeType type, Property p)
1214 {
1215         if (type == ChangeType::DONE) {
1216                 _dirty = true;
1217
1218                 if (p == Property::CONTENT) {
1219                         if (!_user_explicit_video_frame_rate) {
1220                                 set_video_frame_rate (best_video_frame_rate());
1221                         }
1222                 }
1223
1224                 emit (boost::bind (boost::ref (Change), type, p));
1225
1226                 if (p == Property::VIDEO_FRAME_RATE || p == Property::SEQUENCE) {
1227                         /* We want to call Playlist::maybe_sequence but this must happen after the
1228                            main signal emission (since the butler will see that emission and un-suspend itself).
1229                         */
1230                         emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1231                 }
1232         } else {
1233                 Change (type, p);
1234         }
1235 }
1236
1237 void
1238 Film::set_isdcf_date_today ()
1239 {
1240         _isdcf_date = boost::gregorian::day_clock::local_day ();
1241 }
1242
1243 boost::filesystem::path
1244 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1245 {
1246         boost::filesystem::path p;
1247         p /= "j2c";
1248         p /= video_identifier ();
1249
1250         char buffer[256];
1251         snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1252         string s (buffer);
1253
1254         if (eyes == Eyes::LEFT) {
1255                 s += ".L";
1256         } else if (eyes == Eyes::RIGHT) {
1257                 s += ".R";
1258         }
1259
1260         s += ".j2c";
1261
1262         if (tmp) {
1263                 s += ".tmp";
1264         }
1265
1266         p /= s;
1267         return file (p);
1268 }
1269
1270 static
1271 bool
1272 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1273 {
1274         return a.last_write_time > b.last_write_time;
1275 }
1276
1277 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1278  *  The list will be returned in reverse order of timestamp (i.e. most recent first).
1279  */
1280 vector<CPLSummary>
1281 Film::cpls () const
1282 {
1283         if (!directory ()) {
1284                 return vector<CPLSummary> ();
1285         }
1286
1287         vector<CPLSummary> out;
1288
1289         auto const dir = directory().get();
1290         for (auto i: boost::filesystem::directory_iterator(dir)) {
1291                 if (
1292                         boost::filesystem::is_directory (i) &&
1293                         i.path().leaf() != "j2c" && i.path().leaf() != "video" && i.path().leaf() != "info" && i.path().leaf() != "analysis"
1294                         ) {
1295
1296                         try {
1297                                 out.push_back (CPLSummary(i));
1298                         } catch (...) {
1299
1300                         }
1301                 }
1302         }
1303
1304         sort (out.begin(), out.end(), cpl_summary_compare);
1305
1306         return out;
1307 }
1308
1309 void
1310 Film::set_encrypted (bool e)
1311 {
1312         FilmChangeSignaller ch (this, Property::ENCRYPTED);
1313         _encrypted = e;
1314 }
1315
1316 ContentList
1317 Film::content () const
1318 {
1319         return _playlist->content ();
1320 }
1321
1322 /** @param content Content to add.
1323  *  @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1324  */
1325 void
1326 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1327 {
1328         if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1329                 run_ffprobe (content->path(0), file("ffprobe.log"));
1330         }
1331
1332         auto j = make_shared<ExamineContentJob>(shared_from_this(), content);
1333
1334         _job_connections.push_back (
1335                 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1336                 );
1337
1338         JobManager::instance()->add (j);
1339 }
1340
1341 void
1342 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1343 {
1344         auto job = j.lock ();
1345         if (!job || !job->finished_ok ()) {
1346                 return;
1347         }
1348
1349         auto content = c.lock ();
1350         if (!content) {
1351                 return;
1352         }
1353
1354         add_content (content);
1355
1356         if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1357                 auto playlist = make_shared<Playlist>();
1358                 playlist->add (shared_from_this(), content);
1359                 boost::signals2::connection c;
1360                 JobManager::instance()->analyse_audio (
1361                         shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1362                         );
1363                 _audio_analysis_connections.push_back (c);
1364         }
1365 }
1366
1367 void
1368 Film::add_content (shared_ptr<Content> c)
1369 {
1370         /* Add {video,subtitle} content after any existing {video,subtitle} content */
1371         if (c->video) {
1372                 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1373         } else if (!c->text.empty()) {
1374                 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1375         }
1376
1377         if (_template_film) {
1378                 /* Take settings from the first piece of content of c's type in _template */
1379                 for (auto i: _template_film->content()) {
1380                         c->take_settings_from (i);
1381                 }
1382         }
1383
1384         _playlist->add (shared_from_this(), c);
1385
1386         maybe_set_container_and_resolution ();
1387         if (c->atmos) {
1388                 set_audio_channels (14);
1389                 set_interop (false);
1390         }
1391 }
1392
1393
1394 void
1395 Film::maybe_set_container_and_resolution ()
1396 {
1397         /* Get the only piece of video content, if there is only one */
1398         shared_ptr<VideoContent> video;
1399         for (auto i: _playlist->content()) {
1400                 if (i->video) {
1401                         if (!video) {
1402                                 video = i->video;
1403                         } else {
1404                                 video.reset ();
1405                         }
1406                 }
1407         }
1408
1409         if (video) {
1410                 /* This is the only piece of video content in this Film.  Use it to make a guess for
1411                  * DCP container size and resolution, unless the user has already explicitly set these
1412                  * things.
1413                  */
1414                 if (!_user_explicit_container) {
1415                         if (video->size().ratio() > 2.3) {
1416                                 set_container (Ratio::from_id("239"), false);
1417                         } else {
1418                                 set_container (Ratio::from_id("185"), false);
1419                         }
1420                 }
1421
1422                 if (!_user_explicit_resolution) {
1423                         if (video->size_after_crop().width > 2048 || video->size_after_crop().height > 1080) {
1424                                 set_resolution (Resolution::FOUR_K, false);
1425                         } else {
1426                                 set_resolution (Resolution::TWO_K, false);
1427                         }
1428                 }
1429         }
1430 }
1431
1432 void
1433 Film::remove_content (shared_ptr<Content> c)
1434 {
1435         _playlist->remove (c);
1436         maybe_set_container_and_resolution ();
1437 }
1438
1439 void
1440 Film::move_content_earlier (shared_ptr<Content> c)
1441 {
1442         _playlist->move_earlier (shared_from_this(), c);
1443 }
1444
1445 void
1446 Film::move_content_later (shared_ptr<Content> c)
1447 {
1448         _playlist->move_later (shared_from_this(), c);
1449 }
1450
1451 /** @return length of the film from time 0 to the last thing on the playlist,
1452  *  with a minimum length of 1 second.
1453  */
1454 DCPTime
1455 Film::length () const
1456 {
1457         return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
1458 }
1459
1460 int
1461 Film::best_video_frame_rate () const
1462 {
1463         /* Don't default to anything above 30fps (make the user select that explicitly) */
1464         auto best = _playlist->best_video_frame_rate ();
1465         if (best > 30) {
1466                 best /= 2;
1467         }
1468         return best;
1469 }
1470
1471 FrameRateChange
1472 Film::active_frame_rate_change (DCPTime t) const
1473 {
1474         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1475 }
1476
1477 void
1478 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1479 {
1480         if (p == ContentProperty::VIDEO_FRAME_RATE) {
1481                 signal_change (type, Property::CONTENT);
1482         } else if (p == AudioContentProperty::STREAMS) {
1483                 signal_change (type, Property::NAME);
1484         }
1485
1486         if (type == ChangeType::DONE) {
1487                 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1488                 if (!frequent) {
1489                         check_settings_consistency ();
1490                 }
1491         } else {
1492                 ContentChange (type, c, p, frequent);
1493         }
1494
1495         _dirty = true;
1496 }
1497
1498 void
1499 Film::playlist_length_change ()
1500 {
1501         LengthChange ();
1502 }
1503
1504 void
1505 Film::playlist_change (ChangeType type)
1506 {
1507         signal_change (type, Property::CONTENT);
1508         signal_change (type, Property::NAME);
1509
1510         if (type == ChangeType::DONE) {
1511                 check_settings_consistency ();
1512         }
1513
1514         _dirty = true;
1515 }
1516
1517 /** Check for (and if necessary fix) impossible settings combinations, like
1518  *  video set to being referenced when it can't be.
1519  */
1520 void
1521 Film::check_settings_consistency ()
1522 {
1523         optional<int> atmos_rate;
1524         for (auto i: content()) {
1525
1526                 if (i->atmos) {
1527                         int rate = lrintf (i->atmos->edit_rate().as_float());
1528                         if (atmos_rate && *atmos_rate != rate) {
1529                                 Message (_("You have more than one piece of Atmos content, and they do not have the same frame rate.  You must remove some Atmos content."));
1530                         } else if (!atmos_rate && rate != video_frame_rate()) {
1531                                 atmos_rate = rate;
1532                                 set_video_frame_rate (rate, false);
1533                                 Message (_("DCP-o-matic had to change your settings so that the film's frame rate is the same as that of your Atmos content."));
1534                         }
1535                 }
1536         }
1537
1538         bool change_made = false;
1539         for (auto i: content()) {
1540                 auto d = dynamic_pointer_cast<DCPContent>(i);
1541                 if (!d) {
1542                         continue;
1543                 }
1544
1545                 string why_not;
1546                 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1547                         d->set_reference_video(false);
1548                         change_made = true;
1549                 }
1550                 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1551                         d->set_reference_audio(false);
1552                         change_made = true;
1553                 }
1554                 if (d->reference_text(TextType::OPEN_SUBTITLE) && !d->can_reference_text(shared_from_this(), TextType::OPEN_SUBTITLE, why_not)) {
1555                         d->set_reference_text(TextType::OPEN_SUBTITLE, false);
1556                         change_made = true;
1557                 }
1558                 if (d->reference_text(TextType::CLOSED_CAPTION) && !d->can_reference_text(shared_from_this(), TextType::CLOSED_CAPTION, why_not)) {
1559                         d->set_reference_text(TextType::CLOSED_CAPTION, false);
1560                         change_made = true;
1561                 }
1562         }
1563
1564         if (change_made) {
1565                 Message (_("DCP-o-matic had to change your settings for referring to DCPs as OV.  Please review those settings to make sure they are what you want."));
1566         }
1567 }
1568
1569 void
1570 Film::playlist_order_changed ()
1571 {
1572         /* XXX: missing PENDING */
1573         signal_change (ChangeType::DONE, Property::CONTENT_ORDER);
1574 }
1575
1576 int
1577 Film::audio_frame_rate () const
1578 {
1579         /* It seems that nobody makes 96kHz DCPs at the moment, so let's avoid them.
1580            See #1436.
1581         */
1582         return 48000;
1583 }
1584
1585 void
1586 Film::set_sequence (bool s)
1587 {
1588         if (s == _sequence) {
1589                 return;
1590         }
1591
1592         FilmChangeSignaller cc (this, Property::SEQUENCE);
1593         _sequence = s;
1594         _playlist->set_sequence (s);
1595 }
1596
1597 /** @return Size of the largest possible image in whatever resolution we are using */
1598 dcp::Size
1599 Film::full_frame () const
1600 {
1601         switch (_resolution) {
1602         case Resolution::TWO_K:
1603                 return dcp::Size (2048, 1080);
1604         case Resolution::FOUR_K:
1605                 return dcp::Size (4096, 2160);
1606         }
1607
1608         DCPOMATIC_ASSERT (false);
1609         return dcp::Size ();
1610 }
1611
1612 /** @return Size of the frame */
1613 dcp::Size
1614 Film::frame_size () const
1615 {
1616         return fit_ratio_within (container()->ratio(), full_frame ());
1617 }
1618
1619
1620 /** @return Area of Film::frame_size() that contains picture rather than pillar/letterboxing */
1621 dcp::Size
1622 Film::active_area () const
1623 {
1624         auto const frame = frame_size ();
1625         dcp::Size active;
1626
1627         for (auto i: content()) {
1628                 if (i->video) {
1629                         dcp::Size s = i->video->scaled_size (frame);
1630                         active.width = max(active.width, s.width);
1631                         active.height = max(active.height, s.height);
1632                 }
1633         }
1634
1635         return active;
1636 }
1637
1638
1639 /** @param recipient KDM recipient certificate.
1640  *  @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1641  *  @param cpl_file CPL filename.
1642  *  @param from KDM from time expressed as a local time with an offset from UTC.
1643  *  @param until KDM to time expressed as a local time with an offset from UTC.
1644  *  @param formulation KDM formulation to use.
1645  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1646  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1647  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1648  */
1649 dcp::EncryptedKDM
1650 Film::make_kdm (
1651         dcp::Certificate recipient,
1652         vector<string> trusted_devices,
1653         boost::filesystem::path cpl_file,
1654         dcp::LocalTime from,
1655         dcp::LocalTime until,
1656         dcp::Formulation formulation,
1657         bool disable_forensic_marking_picture,
1658         optional<int> disable_forensic_marking_audio
1659         ) const
1660 {
1661         if (!_encrypted) {
1662                 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1663         }
1664
1665         auto cpl = make_shared<dcp::CPL>(cpl_file);
1666         auto signer = Config::instance()->signer_chain();
1667         if (!signer->valid ()) {
1668                 throw InvalidSignerError ();
1669         }
1670
1671         /* Find keys that have been added to imported, encrypted DCP content */
1672         list<dcp::DecryptedKDMKey> imported_keys;
1673         for (auto i: content()) {
1674                 auto d = dynamic_pointer_cast<DCPContent> (i);
1675                 if (d && d->kdm()) {
1676                         dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1677                         auto keys = kdm.keys ();
1678                         copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1679                 }
1680         }
1681
1682         map<shared_ptr<const dcp::ReelFileAsset>, dcp::Key> keys;
1683
1684         for (auto i: cpl->reel_file_assets()) {
1685                 if (!i->encrypted()) {
1686                         continue;
1687                 }
1688
1689                 /* Get any imported key for this ID */
1690                 bool done = false;
1691                 for (auto j: imported_keys) {
1692                         if (j.id() == i->key_id().get()) {
1693                                 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1694                                 keys[i] = j.key();
1695                                 done = true;
1696                         }
1697                 }
1698
1699                 if (!done) {
1700                         /* No imported key; it must be an asset that we encrypted */
1701                         LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1702                         keys[i] = key();
1703                 }
1704         }
1705
1706         return dcp::DecryptedKDM (
1707                 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1708                 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1709 }
1710
1711
1712 /** @return The approximate disk space required to encode a DCP of this film with the
1713  *  current settings, in bytes.
1714  */
1715 uint64_t
1716 Film::required_disk_space () const
1717 {
1718         return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1719 }
1720
1721 /** This method checks the disk that the Film is on and tries to decide whether or not
1722  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1723  *  false is returned and required and available are filled in with the amount of disk space
1724  *  required and available respectively (in GB).
1725  *
1726  *  Note: the decision made by this method isn't, of course, 100% reliable.
1727  */
1728 bool
1729 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1730 {
1731         /* Create a test file and see if we can hard-link it */
1732         boost::filesystem::path test = internal_video_asset_dir() / "test";
1733         boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1734         can_hard_link = true;
1735         auto f = fopen_boost (test, "w");
1736         if (f) {
1737                 fclose (f);
1738                 boost::system::error_code ec;
1739                 boost::filesystem::create_hard_link (test, test2, ec);
1740                 if (ec) {
1741                         can_hard_link = false;
1742                 }
1743                 boost::filesystem::remove (test);
1744                 boost::filesystem::remove (test2);
1745         }
1746
1747         auto s = boost::filesystem::space (internal_video_asset_dir ());
1748         required = double (required_disk_space ()) / 1073741824.0f;
1749         if (!can_hard_link) {
1750                 required *= 2;
1751         }
1752         available = double (s.available) / 1073741824.0f;
1753         return (available - required) > 1;
1754 }
1755
1756 /** @return The names of the channels that audio contents' outputs are passed into;
1757  *  this is either the DCP or a AudioProcessor.
1758  */
1759 vector<NamedChannel>
1760 Film::audio_output_names () const
1761 {
1762         if (audio_processor ()) {
1763                 return audio_processor()->input_names ();
1764         }
1765
1766         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1767
1768         vector<NamedChannel> n;
1769
1770         for (int i = 0; i < audio_channels(); ++i) {
1771                 if (i != 8 && i != 9 && i != 15) {
1772                         n.push_back (NamedChannel(short_audio_channel_name(i), i));
1773                 }
1774         }
1775
1776         return n;
1777 }
1778
1779 void
1780 Film::repeat_content (ContentList c, int n)
1781 {
1782         _playlist->repeat (shared_from_this(), c, n);
1783 }
1784
1785 void
1786 Film::remove_content (ContentList c)
1787 {
1788         _playlist->remove (c);
1789 }
1790
1791 void
1792 Film::audio_analysis_finished ()
1793 {
1794         /* XXX */
1795 }
1796
1797 list<DCPTimePeriod>
1798 Film::reels () const
1799 {
1800         list<DCPTimePeriod> p;
1801         auto const len = length();
1802
1803         switch (reel_type ()) {
1804         case ReelType::SINGLE:
1805                 p.push_back (DCPTimePeriod (DCPTime (), len));
1806                 break;
1807         case ReelType::BY_VIDEO_CONTENT:
1808         {
1809                 /* Collect all reel boundaries */
1810                 list<DCPTime> split_points;
1811                 split_points.push_back (DCPTime());
1812                 split_points.push_back (len);
1813                 for (auto c: content()) {
1814                         if (c->video) {
1815                                 for (auto t: c->reel_split_points(shared_from_this())) {
1816                                         split_points.push_back (t);
1817                                 }
1818                                 split_points.push_back (c->end(shared_from_this()));
1819                         }
1820                 }
1821
1822                 split_points.sort ();
1823                 split_points.unique ();
1824
1825                 /* Make them into periods, coalescing any that are less than 1 second long */
1826                 optional<DCPTime> last;
1827                 for (auto t: split_points) {
1828                         if (last && (t - *last) >= DCPTime::from_seconds(1)) {
1829                                 /* Period from *last to t is long enough; use it and start a new one */
1830                                 p.push_back (DCPTimePeriod(*last, t));
1831                                 last = t;
1832                         } else if (!last) {
1833                                 /* That was the first time, so start a new period */
1834                                 last = t;
1835                         }
1836                 }
1837
1838                 if (!p.empty()) {
1839                         p.back().to = split_points.back();
1840                 }
1841                 break;
1842         }
1843         case ReelType::BY_LENGTH:
1844         {
1845                 DCPTime current;
1846                 /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
1847                  * making sure we don't go less than 1s long.
1848                  */
1849                 Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
1850                 while (current < len) {
1851                         DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1852                         p.push_back (DCPTimePeriod (current, end));
1853                         current = end;
1854                 }
1855                 break;
1856         }
1857         }
1858
1859         return p;
1860 }
1861
1862 /** @param period A period within the DCP
1863  *  @return Name of the content which most contributes to the given period.
1864  */
1865 string
1866 Film::content_summary (DCPTimePeriod period) const
1867 {
1868         return _playlist->content_summary (shared_from_this(), period);
1869 }
1870
1871 void
1872 Film::use_template (string name)
1873 {
1874         _template_film.reset (new Film (optional<boost::filesystem::path>()));
1875         _template_film->read_metadata (Config::instance()->template_path (name));
1876         _use_isdcf_name = _template_film->_use_isdcf_name;
1877         _dcp_content_type = _template_film->_dcp_content_type;
1878         _container = _template_film->_container;
1879         _resolution = _template_film->_resolution;
1880         _j2k_bandwidth = _template_film->_j2k_bandwidth;
1881         _video_frame_rate = _template_film->_video_frame_rate;
1882         _encrypted = _template_film->_encrypted;
1883         _audio_channels = _template_film->_audio_channels;
1884         _sequence = _template_film->_sequence;
1885         _three_d = _template_film->_three_d;
1886         _interop = _template_film->_interop;
1887         _audio_processor = _template_film->_audio_processor;
1888         _reel_type = _template_film->_reel_type;
1889         _reel_length = _template_film->_reel_length;
1890 }
1891
1892 pair<double, double>
1893 Film::speed_up_range (int dcp_frame_rate) const
1894 {
1895         return _playlist->speed_up_range (dcp_frame_rate);
1896 }
1897
1898 void
1899 Film::copy_from (shared_ptr<const Film> film)
1900 {
1901         read_metadata (film->file (metadata_file));
1902 }
1903
1904 bool
1905 Film::references_dcp_video () const
1906 {
1907         for (auto i: _playlist->content()) {
1908                 auto d = dynamic_pointer_cast<DCPContent>(i);
1909                 if (d && d->reference_video()) {
1910                         return true;
1911                 }
1912         }
1913
1914         return false;
1915 }
1916
1917 bool
1918 Film::references_dcp_audio () const
1919 {
1920         for (auto i: _playlist->content()) {
1921                 auto d = dynamic_pointer_cast<DCPContent>(i);
1922                 if (d && d->reference_audio()) {
1923                         return true;
1924                 }
1925         }
1926
1927         return false;
1928 }
1929
1930
1931 bool
1932 Film::contains_atmos_content () const
1933 {
1934         for (auto i: _playlist->content()) {
1935                 if (i->atmos) {
1936                         return true;
1937                 }
1938         }
1939
1940         return false;
1941 }
1942
1943
1944 list<DCPTextTrack>
1945 Film::closed_caption_tracks () const
1946 {
1947         list<DCPTextTrack> tt;
1948         for (auto i: content()) {
1949                 for (auto j: i->text) {
1950                         /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1951                         auto dtt = j->dcp_track().get_value_or(DCPTextTrack());
1952                         if (j->type() == TextType::CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1953                                 tt.push_back (dtt);
1954                         }
1955                 }
1956         }
1957
1958         return tt;
1959 }
1960
1961 void
1962 Film::set_marker (dcp::Marker type, DCPTime time)
1963 {
1964         FilmChangeSignaller ch (this, Property::MARKERS);
1965         _markers[type] = time;
1966 }
1967
1968
1969 void
1970 Film::unset_marker (dcp::Marker type)
1971 {
1972         FilmChangeSignaller ch (this, Property::MARKERS);
1973         _markers.erase (type);
1974 }
1975
1976
1977 void
1978 Film::clear_markers ()
1979 {
1980         FilmChangeSignaller ch (this, Property::MARKERS);
1981         _markers.clear ();
1982 }
1983
1984
1985 void
1986 Film::set_ratings (vector<dcp::Rating> r)
1987 {
1988         FilmChangeSignaller ch (this, Property::RATINGS);
1989         _ratings = r;
1990 }
1991
1992 void
1993 Film::set_content_versions (vector<string> v)
1994 {
1995         FilmChangeSignaller ch (this, Property::CONTENT_VERSIONS);
1996         _content_versions = v;
1997 }
1998
1999
2000 void
2001 Film::set_name_language (dcp::LanguageTag lang)
2002 {
2003         FilmChangeSignaller ch (this, Property::NAME_LANGUAGE);
2004         _name_language = lang;
2005 }
2006
2007
2008 void
2009 Film::set_release_territory (optional<dcp::LanguageTag::RegionSubtag> region)
2010 {
2011         FilmChangeSignaller ch (this, Property::RELEASE_TERRITORY);
2012         _release_territory = region;
2013 }
2014
2015
2016 void
2017 Film::set_status (dcp::Status s)
2018 {
2019         FilmChangeSignaller ch (this, Property::STATUS);
2020         _status = s;
2021 }
2022
2023
2024 void
2025 Film::set_version_number (int v)
2026 {
2027         FilmChangeSignaller ch (this, Property::VERSION_NUMBER);
2028         _version_number = v;
2029 }
2030
2031
2032 void
2033 Film::set_chain (optional<string> c)
2034 {
2035         FilmChangeSignaller ch (this, Property::CHAIN);
2036         _chain = c;
2037 }
2038
2039
2040 void
2041 Film::set_distributor (optional<string> d)
2042 {
2043         FilmChangeSignaller ch (this, Property::DISTRIBUTOR);
2044         _distributor = d;
2045 }
2046
2047
2048 void
2049 Film::set_luminance (optional<dcp::Luminance> l)
2050 {
2051         FilmChangeSignaller ch (this, Property::LUMINANCE);
2052         _luminance = l;
2053 }
2054
2055
2056 void
2057 Film::set_facility (optional<string> f)
2058 {
2059         FilmChangeSignaller ch (this, Property::FACILITY);
2060         _facility = f;
2061 }
2062
2063
2064 void
2065 Film::set_studio (optional<string> s)
2066 {
2067         FilmChangeSignaller ch (this, Property::STUDIO);
2068         _studio = s;
2069 }
2070
2071
2072 optional<DCPTime>
2073 Film::marker (dcp::Marker type) const
2074 {
2075         auto i = _markers.find (type);
2076         if (i == _markers.end()) {
2077                 return {};
2078         }
2079         return i->second;
2080 }
2081
2082 shared_ptr<InfoFileHandle>
2083 Film::info_file_handle (DCPTimePeriod period, bool read) const
2084 {
2085         return std::make_shared<InfoFileHandle>(_info_file_mutex, info_file(period), read);
2086 }
2087
2088 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read)
2089         : _lock (mutex)
2090         , _file (file)
2091 {
2092         if (read) {
2093                 _handle = fopen_boost (file, "rb");
2094                 if (!_handle) {
2095                         throw OpenFileError (file, errno, OpenFileError::READ);
2096                 }
2097         } else {
2098                 auto const exists = boost::filesystem::exists (file);
2099                 if (exists) {
2100                         _handle = fopen_boost (file, "r+b");
2101                 } else {
2102                         _handle = fopen_boost (file, "wb");
2103                 }
2104
2105                 if (!_handle) {
2106                         throw OpenFileError (file, errno, exists ? OpenFileError::READ_WRITE : OpenFileError::WRITE);
2107                 }
2108         }
2109 }
2110
2111 InfoFileHandle::~InfoFileHandle ()
2112 {
2113         fclose (_handle);
2114 }
2115
2116
2117 /** Add FFOC and LFOC markers to a list if they are not already there */
2118 void
2119 Film::add_ffoc_lfoc (Markers& markers) const
2120 {
2121         if (markers.find(dcp::Marker::FFOC) == markers.end()) {
2122                 markers[dcp::Marker::FFOC] = dcpomatic::DCPTime::from_frames(1, video_frame_rate());
2123         }
2124
2125         if (markers.find(dcp::Marker::LFOC) == markers.end()) {
2126                 markers[dcp::Marker::LFOC] = length() - DCPTime::from_frames(1, video_frame_rate());
2127         }
2128 }
2129
2130
2131 void
2132 Film::set_temp_version (bool t)
2133 {
2134         FilmChangeSignaller ch (this, Property::TEMP_VERSION);
2135         _temp_version = t;
2136 }
2137
2138
2139 void
2140 Film::set_pre_release (bool p)
2141 {
2142         FilmChangeSignaller ch (this, Property::PRE_RELEASE);
2143         _pre_release = p;
2144 }
2145
2146
2147 void
2148 Film::set_red_band (bool r)
2149 {
2150         FilmChangeSignaller ch (this, Property::RED_BAND);
2151         _red_band = r;
2152 }
2153
2154
2155 void
2156 Film::set_two_d_version_of_three_d (bool t)
2157 {
2158         FilmChangeSignaller ch (this, Property::TWO_D_VERSION_OF_THREE_D);
2159         _two_d_version_of_three_d = t;
2160 }
2161
2162
2163 void
2164 Film::set_audio_language (optional<dcp::LanguageTag> language)
2165 {
2166         FilmChangeSignaller ch (this, Property::AUDIO_LANGUAGE);
2167         _audio_language = language;
2168 }
2169
2170
2171 bool
2172 Film::has_sign_language_video_channel () const
2173 {
2174         return _audio_channels >= static_cast<int>(dcp::Channel::SIGN_LANGUAGE);
2175 }
2176
2177
2178 void
2179 Film::set_sign_language_video_language (optional<dcp::LanguageTag> lang)
2180 {
2181         FilmChangeSignaller ch (this, Property::SIGN_LANGUAGE_VIDEO_LANGUAGE);
2182         _sign_language_video_language = lang;
2183 }
2184