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