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