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