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