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