src/lib/film.cc

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