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