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