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