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