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