src/lib/film.h

   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.h
  22  *  @brief A representation of some audio and video content, and details of
  23  *  how they should be presented in a DCP.
  24  */
  25
  26 #ifndef DCPOMATIC_FILM_H
  27 #define DCPOMATIC_FILM_H
  28
  29 #include "change_signaller.h"
  30 #include "dcp_text_track.h"
  31 #include "frame_rate_change.h"
  32 #include "signaller.h"
  33 #include "transcode_job.h"
  34 #include "types.h"
  35 #include "util.h"
  36 #include <dcp/encrypted_kdm.h>
  37 #include <dcp/key.h>
  38 #include <dcp/language_tag.h>
  39 #include <dcp/rating.h>
  40 #include <boost/filesystem.hpp>
  41 #include <boost/signals2.hpp>
  42 #include <boost/thread.hpp>
  43 #include <boost/thread/mutex.hpp>
  44 #include <inttypes.h>
  45 #include <string>
  46 #include <vector>
  47
  48 namespace xmlpp {
  49         class Document;
  50 }
  51
  52 namespace dcpomatic {
  53         class Screen;
  54 }
  55
  56 class DCPContentType;
  57 class Log;
  58 class Content;
  59 class Playlist;
  60 class AudioContent;
  61 class AudioProcessor;
  62 class Ratio;
  63 class Job;
  64 class Film;
  65 struct isdcf_name_test;
  66 struct recover_test_2d_encrypted;
  67 struct atmos_encrypted_passthrough_test;
  68
  69 class InfoFileHandle
  70 {
  71 public:
  72         InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
  73         ~InfoFileHandle ();
  74
  75         FILE* get () const {
  76                 return _handle;
  77         }
  78
  79         boost::filesystem::path file () const {
  80                 return _file;
  81         }
  82
  83 private:
  84         friend class Film;
  85
  86         boost::mutex::scoped_lock _lock;
  87         FILE* _handle;
  88         boost::filesystem::path _file;
  89 };
  90
  91 /** @class Film
  92  *
  93  *  @brief A representation of some audio, video, subtitle and closed-caption content,
  94  *  and details of how they should be presented in a DCP.
  95  *
  96  *  The content of a Film is held in a Playlist (created and managed by the Film).
  97  */
  98 class Film : public std::enable_shared_from_this<Film>, public Signaller
  99 {
 100 public:
 101         explicit Film (boost::optional<boost::filesystem::path> dir);
 102         ~Film ();
 103
 104         Film (Film const&) = delete;
 105         Film& operator= (Film const&) = delete;
 106
 107         std::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
 108         boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
 109         boost::filesystem::path internal_video_asset_dir () const;
 110         boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
 111
 112         boost::filesystem::path audio_analysis_path (std::shared_ptr<const Playlist>) const;
 113         boost::filesystem::path subtitle_analysis_path (std::shared_ptr<const Content>) const;
 114
 115         void send_dcp_to_tms ();
 116         void make_dcp (TranscodeJob::ChangedBehaviour behaviour);
 117
 118         /** @return Logger.
 119          *  It is safe to call this from any thread.
 120          */
 121         std::shared_ptr<Log> log () const {
 122                 return _log;
 123         }
 124
 125         boost::filesystem::path file (boost::filesystem::path f) const;
 126         boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
 127
 128         void use_template (std::string name);
 129         std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
 130         void write_metadata () const;
 131         void write_metadata (boost::filesystem::path path) const;
 132         void write_template (boost::filesystem::path path) const;
 133         std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
 134
 135         void copy_from (std::shared_ptr<const Film> film);
 136
 137         std::string isdcf_name (bool if_created_now) const;
 138         std::string dcp_name (bool if_created_now = false) const;
 139
 140         /** @return true if our state has changed since we last saved it */
 141         bool dirty () const {
 142                 return _dirty;
 143         }
 144
 145         dcp::Size full_frame () const;
 146         dcp::Size frame_size () const;
 147         dcp::Size active_area () const;
 148
 149         std::vector<CPLSummary> cpls () const;
 150
 151         int audio_frame_rate () const;
 152
 153         std::list<DCPTextTrack> closed_caption_tracks () const;
 154
 155         uint64_t required_disk_space () const;
 156         bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
 157
 158         bool has_sign_language_video_channel () const;
 159
 160         /* Proxies for some Playlist methods */
 161
 162         ContentList content () const;
 163         dcpomatic::DCPTime length () const;
 164         int best_video_frame_rate () const;
 165         FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
 166         std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
 167
 168         dcp::EncryptedKDM make_kdm (
 169                 dcp::Certificate recipient,
 170                 std::vector<std::string> trusted_devices,
 171                 boost::filesystem::path cpl_file,
 172                 dcp::LocalTime from,
 173                 dcp::LocalTime until,
 174                 dcp::Formulation formulation,
 175                 bool disable_forensic_marking_picture,
 176                 boost::optional<int> disable_forensic_marking_audio
 177                 ) const;
 178
 179         int state_version () const {
 180                 return _state_version;
 181         }
 182
 183         std::vector<NamedChannel> audio_output_names () const;
 184
 185         void repeat_content (ContentList, int);
 186
 187         std::shared_ptr<const Playlist> playlist () const {
 188                 return _playlist;
 189         }
 190
 191         std::list<dcpomatic::DCPTimePeriod> reels () const;
 192         std::list<int> mapped_audio_channels () const;
 193
 194         boost::optional<dcp::LanguageTag> audio_language () const {
 195                 return _audio_language;
 196         }
 197
 198         /** @return pair containing the main subtitle language, and additional languages */
 199         std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages () const;
 200
 201         std::string content_summary (dcpomatic::DCPTimePeriod period) const;
 202
 203         bool references_dcp_video () const;
 204         bool references_dcp_audio () const;
 205         bool contains_atmos_content () const;
 206
 207         void set_tolerant (bool t) {
 208                 _tolerant = t;
 209         }
 210
 211         bool tolerant () const {
 212                 return _tolerant;
 213         }
 214
 215         /** Identifiers for the parts of our state;
 216             used for signalling changes.
 217         */
 218         enum class Property {
 219                 NONE,
 220                 NAME,
 221                 USE_ISDCF_NAME,
 222                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 223                 CONTENT,
 224                 /** The order of content in the playlist has changed */
 225                 CONTENT_ORDER,
 226                 DCP_CONTENT_TYPE,
 227                 CONTAINER,
 228                 RESOLUTION,
 229                 ENCRYPTED,
 230                 J2K_BANDWIDTH,
 231                 VIDEO_FRAME_RATE,
 232                 AUDIO_CHANNELS,
 233                 /** The setting of _three_d has changed */
 234                 THREE_D,
 235                 SEQUENCE,
 236                 INTEROP,
 237                 AUDIO_PROCESSOR,
 238                 REEL_TYPE,
 239                 REEL_LENGTH,
 240                 REENCODE_J2K,
 241                 MARKERS,
 242                 RATINGS,
 243                 CONTENT_VERSIONS,
 244                 NAME_LANGUAGE,
 245                 AUDIO_LANGUAGE,
 246                 RELEASE_TERRITORY,
 247                 SIGN_LANGUAGE_VIDEO_LANGUAGE,
 248                 VERSION_NUMBER,
 249                 STATUS,
 250                 CHAIN,
 251                 DISTRIBUTOR,
 252                 FACILITY,
 253                 STUDIO,
 254                 TEMP_VERSION,
 255                 PRE_RELEASE,
 256                 RED_BAND,
 257                 TWO_D_VERSION_OF_THREE_D,
 258                 LUMINANCE,
 259         };
 260
 261
 262         /* GET */
 263
 264         boost::optional<boost::filesystem::path> directory () const {
 265                 return _directory;
 266         }
 267
 268         std::string name () const {
 269                 return _name;
 270         }
 271
 272         bool use_isdcf_name () const {
 273                 return _use_isdcf_name;
 274         }
 275
 276         DCPContentType const * dcp_content_type () const {
 277                 return _dcp_content_type;
 278         }
 279
 280         Ratio const * container () const {
 281                 return _container;
 282         }
 283
 284         Resolution resolution () const {
 285                 return _resolution;
 286         }
 287
 288         bool encrypted () const {
 289                 return _encrypted;
 290         }
 291
 292         dcp::Key key () const {
 293                 return _key;
 294         }
 295
 296         int j2k_bandwidth () const {
 297                 return _j2k_bandwidth;
 298         }
 299
 300         /** @return The frame rate of the DCP */
 301         int video_frame_rate () const {
 302                 return _video_frame_rate;
 303         }
 304
 305         int audio_channels () const {
 306                 return _audio_channels;
 307         }
 308
 309         bool three_d () const {
 310                 return _three_d;
 311         }
 312
 313         bool sequence () const {
 314                 return _sequence;
 315         }
 316
 317         bool interop () const {
 318                 return _interop;
 319         }
 320
 321         AudioProcessor const * audio_processor () const {
 322                 return _audio_processor;
 323         }
 324
 325         ReelType reel_type () const {
 326                 return _reel_type;
 327         }
 328
 329         int64_t reel_length () const {
 330                 return _reel_length;
 331         }
 332
 333         std::string context_id () const {
 334                 return _context_id;
 335         }
 336
 337         bool reencode_j2k () const {
 338                 return _reencode_j2k;
 339         }
 340
 341         typedef std::map<dcp::Marker, dcpomatic::DCPTime> Markers;
 342
 343         boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
 344         Markers markers () const {
 345                 return _markers;
 346         }
 347
 348         std::vector<dcp::Rating> ratings () const {
 349                 return _ratings;
 350         }
 351
 352         std::vector<std::string> content_versions () const {
 353                 return _content_versions;
 354         }
 355
 356         dcp::LanguageTag name_language () const {
 357                 return _name_language;
 358         }
 359
 360         boost::optional<dcp::LanguageTag::RegionSubtag> release_territory () const {
 361                 return _release_territory;
 362         }
 363
 364         boost::optional<dcp::LanguageTag> sign_language_video_language () const {
 365                 return _sign_language_video_language;
 366         }
 367
 368         int version_number () const {
 369                 return _version_number;
 370         }
 371
 372         dcp::Status status () const {
 373                 return _status;
 374         }
 375
 376         boost::optional<std::string> chain () const {
 377                 return _chain;
 378         }
 379
 380         boost::optional<std::string> distributor () const {
 381                 return _distributor;
 382         }
 383
 384         boost::optional<std::string> facility () const {
 385                 return _facility;
 386         }
 387
 388         boost::optional<std::string> studio () const {
 389                 return _studio;
 390         }
 391
 392         bool temp_version () const {
 393                 return _temp_version;
 394         }
 395
 396         bool pre_release () const {
 397                 return _pre_release;
 398         }
 399
 400         bool red_band () const {
 401                 return _red_band;
 402         }
 403
 404         bool two_d_version_of_three_d () const {
 405                 return _two_d_version_of_three_d;
 406         }
 407
 408         boost::optional<dcp::Luminance> luminance () const {
 409                 return _luminance;
 410         }
 411
 412
 413         /* SET */
 414
 415         void set_directory (boost::filesystem::path);
 416         void set_name (std::string);
 417         void set_use_isdcf_name (bool);
 418         void examine_and_add_content (std::shared_ptr<Content> content, bool disable_audio_analysis = false);
 419         void add_content (std::shared_ptr<Content>);
 420         void remove_content (std::shared_ptr<Content>);
 421         void remove_content (ContentList);
 422         void move_content_earlier (std::shared_ptr<Content>);
 423         void move_content_later (std::shared_ptr<Content>);
 424         void set_dcp_content_type (DCPContentType const *);
 425         void set_container (Ratio const *, bool user_explicit = true);
 426         void set_resolution (Resolution, bool user_explicit = true);
 427         void set_encrypted (bool);
 428         void set_j2k_bandwidth (int);
 429         void set_video_frame_rate (int rate, bool user_explicit = false);
 430         void set_audio_channels (int);
 431         void set_three_d (bool);
 432         void set_isdcf_date_today ();
 433         void set_sequence (bool);
 434         void set_interop (bool);
 435         void set_audio_processor (AudioProcessor const * processor);
 436         void set_reel_type (ReelType);
 437         void set_reel_length (int64_t);
 438         void set_reencode_j2k (bool);
 439         void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
 440         void unset_marker (dcp::Marker type);
 441         void clear_markers ();
 442         void set_ratings (std::vector<dcp::Rating> r);
 443         void set_content_versions (std::vector<std::string> v);
 444         void set_name_language (dcp::LanguageTag lang);
 445         void set_release_territory (boost::optional<dcp::LanguageTag::RegionSubtag> region = boost::none);
 446         void set_sign_language_video_language (boost::optional<dcp::LanguageTag> tag);
 447         void set_version_number (int v);
 448         void set_status (dcp::Status s);
 449         void set_chain (boost::optional<std::string> c = boost::none);
 450         void set_facility (boost::optional<std::string> f = boost::none);
 451         void set_studio (boost::optional<std::string> s = boost::none);
 452         void set_temp_version (bool t);
 453         void set_pre_release (bool p);
 454         void set_red_band (bool r);
 455         void set_two_d_version_of_three_d (bool t);
 456         void set_distributor (boost::optional<std::string> d = boost::none);
 457         void set_luminance (boost::optional<dcp::Luminance> l = boost::none);
 458         void set_audio_language (boost::optional<dcp::LanguageTag> language);
 459
 460         void add_ffoc_lfoc (Markers& markers) const;
 461
 462         /** Emitted when some property has of the Film is about to change or has changed */
 463         mutable boost::signals2::signal<void (ChangeType, Property)> Change;
 464
 465         /** Emitted when some property of our content has changed */
 466         mutable boost::signals2::signal<void (ChangeType, std::weak_ptr<Content>, int, bool)> ContentChange;
 467
 468         /** Emitted when the film's length might have changed; this is not like a normal
 469             property as its value is derived from the playlist, so it has its own signal.
 470         */
 471         mutable boost::signals2::signal<void ()> LengthChange;
 472
 473         /** Emitted when we have something important to tell the user */
 474         boost::signals2::signal<void (std::string)> Message;
 475
 476         /** Current version number of the state file */
 477         static int const current_state_version;
 478
 479 private:
 480
 481         friend struct ::isdcf_name_test;
 482         friend struct ::recover_test_2d_encrypted;
 483         friend struct ::atmos_encrypted_passthrough_test;
 484         template <class, class> friend class ChangeSignaller;
 485
 486         boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
 487
 488         void signal_change (ChangeType, Property);
 489         void signal_change (ChangeType, int);
 490         std::string video_identifier () const;
 491         void playlist_change (ChangeType);
 492         void playlist_order_changed ();
 493         void playlist_content_change (ChangeType type, std::weak_ptr<Content>, int, bool frequent);
 494         void playlist_length_change ();
 495         void maybe_add_content (std::weak_ptr<Job>, std::weak_ptr<Content>, bool disable_audio_analysis);
 496         void audio_analysis_finished ();
 497         void check_settings_consistency ();
 498         void maybe_set_container_and_resolution ();
 499
 500         /** Log to write to */
 501         std::shared_ptr<Log> _log;
 502         std::shared_ptr<Playlist> _playlist;
 503
 504         /** Complete path to directory containing the film metadata;
 505          *  must not be relative.
 506          */
 507         boost::optional<boost::filesystem::path> _directory;
 508
 509         /** Name for DCP-o-matic */
 510         std::string _name;
 511         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 512         bool _use_isdcf_name;
 513         /** The type of content that this Film represents (feature, trailer etc.) */
 514         DCPContentType const * _dcp_content_type;
 515         /** The container to put this Film in (flat, scope, etc.) */
 516         Ratio const * _container;
 517         /** DCP resolution (2K or 4K) */
 518         Resolution _resolution;
 519         bool _encrypted;
 520         dcp::Key _key;
 521         /** context ID used when encrypting picture assets; we keep it so that we can
 522          *  re-start picture MXF encodes.
 523          */
 524         std::string _context_id;
 525         /** bandwidth for J2K files in bits per second */
 526         int _j2k_bandwidth;
 527         /** Frames per second to run our DCP at */
 528         int _video_frame_rate;
 529         /** The date that we should use in a ISDCF name */
 530         boost::gregorian::date _isdcf_date;
 531         /** Number of audio channels requested for the DCP */
 532         int _audio_channels;
 533         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 534             This will be regardless of what content is on the playlist.
 535         */
 536         bool _three_d;
 537         bool _sequence;
 538         bool _interop;
 539         AudioProcessor const * _audio_processor;
 540         ReelType _reel_type;
 541         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 542         int64_t _reel_length;
 543         bool _reencode_j2k;
 544         /** true if the user has ever explicitly set the video frame rate of this film */
 545         bool _user_explicit_video_frame_rate;
 546         bool _user_explicit_container;
 547         bool _user_explicit_resolution;
 548         std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
 549         std::vector<dcp::Rating> _ratings;
 550         std::vector<std::string> _content_versions;
 551         dcp::LanguageTag _name_language;
 552         boost::optional<dcp::LanguageTag::RegionSubtag> _release_territory;
 553         boost::optional<dcp::LanguageTag> _sign_language_video_language;
 554         int _version_number;
 555         dcp::Status _status;
 556         boost::optional<std::string> _chain;
 557         boost::optional<std::string> _distributor;
 558         boost::optional<std::string> _facility;
 559         boost::optional<std::string> _studio;
 560         bool _temp_version = false;
 561         bool _pre_release = false;
 562         bool _red_band = false;
 563         bool _two_d_version_of_three_d = false;
 564         boost::optional<dcp::Luminance> _luminance;
 565         boost::optional<dcp::LanguageTag> _audio_language;
 566
 567         int _state_version;
 568
 569         /** true if our state has changed since we last saved it */
 570         mutable bool _dirty;
 571         /** film being used as a template, or 0 */
 572         std::shared_ptr<Film> _template_film;
 573
 574         /** Be tolerant of errors in content (currently applies to DCP only).
 575             Not saved as state.
 576         */
 577         bool _tolerant;
 578
 579         mutable boost::mutex _info_file_mutex;
 580
 581         boost::signals2::scoped_connection _playlist_change_connection;
 582         boost::signals2::scoped_connection _playlist_order_changed_connection;
 583         boost::signals2::scoped_connection _playlist_content_change_connection;
 584         boost::signals2::scoped_connection _playlist_length_change_connection;
 585         std::list<boost::signals2::connection> _job_connections;
 586         std::list<boost::signals2::connection> _audio_analysis_connections;
 587
 588         friend struct paths_test;
 589         friend struct film_metadata_test;
 590 };
 591
 592
 593 typedef ChangeSignaller<Film, Film::Property> FilmChangeSignaller;
 594
 595
 596 #endif