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