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