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