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 DCPContentType;
  68 class Log;
  69 class Content;
  70 class Playlist;
  71 class AudioContent;
  72 class AudioProcessor;
  73 class Ratio;
  74 class Job;
  75 class Film;
  76 struct isdcf_name_test;
  77 struct isdcf_name_with_atmos;
  78 struct isdcf_name_with_ccap;
  79 struct recover_test_2d_encrypted;
  80 struct atmos_encrypted_passthrough_test;
  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         /** @return pair containing the main subtitle language, and additional languages */
 196         std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages () const;
 197         /** @return all closed caption languages in the film */
 198         std::vector<dcp::LanguageTag> closed_caption_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         bool last_written_by_earlier_than(int major, int minor, int micro) const;
 215
 216         /* GET */
 217
 218         boost::optional<boost::filesystem::path> directory () const {
 219                 return _directory;
 220         }
 221
 222         std::string name () const {
 223                 return _name;
 224         }
 225
 226         bool use_isdcf_name () const {
 227                 return _use_isdcf_name;
 228         }
 229
 230         DCPContentType const * dcp_content_type () const {
 231                 return _dcp_content_type;
 232         }
 233
 234         Ratio const * container () const {
 235                 return _container;
 236         }
 237
 238         Resolution resolution () const {
 239                 return _resolution;
 240         }
 241
 242         bool encrypted () const {
 243                 return _encrypted;
 244         }
 245
 246         dcp::Key key () const {
 247                 return _key;
 248         }
 249
 250         int j2k_bandwidth () const {
 251                 return _j2k_bandwidth;
 252         }
 253
 254         /** @return The frame rate of the DCP */
 255         int video_frame_rate () const {
 256                 return _video_frame_rate;
 257         }
 258
 259         int audio_channels () const {
 260                 return _audio_channels;
 261         }
 262
 263         bool three_d () const {
 264                 return _three_d;
 265         }
 266
 267         bool sequence () const {
 268                 return _sequence;
 269         }
 270
 271         bool interop () const {
 272                 return _interop;
 273         }
 274
 275         bool limit_to_smpte_bv20() const {
 276                 return _limit_to_smpte_bv20;
 277         }
 278
 279         AudioProcessor const * audio_processor () const {
 280                 return _audio_processor;
 281         }
 282
 283         ReelType reel_type () const {
 284                 return _reel_type;
 285         }
 286
 287         int64_t reel_length () const {
 288                 return _reel_length;
 289         }
 290
 291         std::string context_id () const {
 292                 return _context_id;
 293         }
 294
 295         bool reencode_j2k () const {
 296                 return _reencode_j2k;
 297         }
 298
 299         typedef std::map<dcp::Marker, dcpomatic::DCPTime> Markers;
 300
 301         boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
 302         Markers markers () const {
 303                 return _markers;
 304         }
 305
 306         std::vector<dcp::Rating> ratings () const {
 307                 return _ratings;
 308         }
 309
 310         std::vector<std::string> content_versions () const {
 311                 return _content_versions;
 312         }
 313
 314         dcp::LanguageTag name_language () const {
 315                 return _name_language;
 316         }
 317
 318         TerritoryType territory_type() const {
 319                 return _territory_type;
 320         }
 321
 322         boost::optional<dcp::LanguageTag::RegionSubtag> release_territory () const {
 323                 return _release_territory;
 324         }
 325
 326         boost::optional<dcp::LanguageTag> sign_language_video_language () const {
 327                 return _sign_language_video_language;
 328         }
 329
 330         int version_number () const {
 331                 return _version_number;
 332         }
 333
 334         dcp::Status status () const {
 335                 return _status;
 336         }
 337
 338         boost::optional<std::string> chain () const {
 339                 return _chain;
 340         }
 341
 342         boost::optional<std::string> distributor () const {
 343                 return _distributor;
 344         }
 345
 346         boost::optional<std::string> facility () const {
 347                 return _facility;
 348         }
 349
 350         boost::optional<std::string> studio () const {
 351                 return _studio;
 352         }
 353
 354         bool temp_version () const {
 355                 return _temp_version;
 356         }
 357
 358         bool pre_release () const {
 359                 return _pre_release;
 360         }
 361
 362         bool red_band () const {
 363                 return _red_band;
 364         }
 365
 366         bool two_d_version_of_three_d () const {
 367                 return _two_d_version_of_three_d;
 368         }
 369
 370         boost::optional<dcp::Luminance> luminance () const {
 371                 return _luminance;
 372         }
 373
 374         boost::gregorian::date isdcf_date () const {
 375                 return _isdcf_date;
 376         }
 377
 378         int audio_frame_rate () const {
 379                 return _audio_frame_rate;
 380         }
 381
 382         /* SET */
 383
 384         void set_directory (boost::filesystem::path);
 385         void set_name (std::string);
 386         void set_use_isdcf_name (bool);
 387         void examine_and_add_content (std::shared_ptr<Content> content, bool disable_audio_analysis = false);
 388         void add_content (std::shared_ptr<Content>);
 389         void remove_content (std::shared_ptr<Content>);
 390         void remove_content (ContentList);
 391         void move_content_earlier (std::shared_ptr<Content>);
 392         void move_content_later (std::shared_ptr<Content>);
 393         void set_dcp_content_type (DCPContentType const *);
 394         void set_container (Ratio const *, bool user_explicit = true);
 395         void set_resolution (Resolution, bool user_explicit = true);
 396         void set_encrypted (bool);
 397         void set_j2k_bandwidth (int);
 398         void set_video_frame_rate (int rate, bool user_explicit = false);
 399         void set_audio_channels (int);
 400         void set_three_d (bool);
 401         void set_isdcf_date_today ();
 402         void set_sequence (bool);
 403         void set_interop (bool);
 404         void set_limit_to_smpte_bv20(bool);
 405         void set_audio_processor (AudioProcessor const * processor);
 406         void set_reel_type (ReelType);
 407         void set_reel_length (int64_t);
 408         void set_reencode_j2k (bool);
 409         void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
 410         void unset_marker (dcp::Marker type);
 411         void clear_markers ();
 412         void set_ratings (std::vector<dcp::Rating> r);
 413         void set_content_versions (std::vector<std::string> v);
 414         void set_name_language (dcp::LanguageTag lang);
 415         void set_territory_type(TerritoryType type);
 416         void set_release_territory (boost::optional<dcp::LanguageTag::RegionSubtag> region = boost::none);
 417         void set_sign_language_video_language (boost::optional<dcp::LanguageTag> tag);
 418         void set_version_number (int v);
 419         void set_status (dcp::Status s);
 420         void set_chain (boost::optional<std::string> c = boost::none);
 421         void set_facility (boost::optional<std::string> f = boost::none);
 422         void set_studio (boost::optional<std::string> s = boost::none);
 423         void set_temp_version (bool t);
 424         void set_pre_release (bool p);
 425         void set_red_band (bool r);
 426         void set_two_d_version_of_three_d (bool t);
 427         void set_distributor (boost::optional<std::string> d = boost::none);
 428         void set_luminance (boost::optional<dcp::Luminance> l = boost::none);
 429         void set_audio_language (boost::optional<dcp::LanguageTag> language);
 430         void set_audio_frame_rate (int rate);
 431
 432         void add_ffoc_lfoc (Markers& markers) const;
 433
 434         /** Emitted when some property has of the Film is about to change or has changed */
 435         mutable boost::signals2::signal<void (ChangeType, FilmProperty)> Change;
 436
 437         /** Emitted when some property of our content has changed */
 438         mutable boost::signals2::signal<void (ChangeType, std::weak_ptr<Content>, int, bool)> ContentChange;
 439
 440         /** Emitted when the film's length might have changed; this is not like a normal
 441             property as its value is derived from the playlist, so it has its own signal.
 442         */
 443         mutable boost::signals2::signal<void ()> LengthChange;
 444
 445         boost::signals2::signal<void (bool)> DirtyChange;
 446
 447         /** Emitted when we have something important to tell the user */
 448         boost::signals2::signal<void (std::string)> Message;
 449
 450         /** Current version number of the state file */
 451         static int const current_state_version;
 452
 453 private:
 454
 455         friend struct ::isdcf_name_test;
 456         friend struct ::isdcf_name_with_atmos;
 457         friend struct ::isdcf_name_with_ccap;
 458         friend struct ::recover_test_2d_encrypted;
 459         friend struct ::atmos_encrypted_passthrough_test;
 460         template <class, class> friend class ChangeSignalDespatcher;
 461
 462         boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
 463
 464         void signal_change (ChangeType, FilmProperty);
 465         void signal_change (ChangeType, int);
 466         std::string video_identifier () const;
 467         void playlist_change (ChangeType);
 468         void playlist_order_changed ();
 469         void playlist_content_change (ChangeType type, std::weak_ptr<Content>, int, bool frequent);
 470         void playlist_length_change ();
 471         void maybe_add_content (std::weak_ptr<Job>, std::weak_ptr<Content>, bool disable_audio_analysis);
 472         void audio_analysis_finished ();
 473         void check_settings_consistency ();
 474         void maybe_set_container_and_resolution ();
 475         void set_dirty (bool dirty);
 476
 477         /** Log to write to */
 478         std::shared_ptr<Log> _log;
 479         std::shared_ptr<Playlist> _playlist;
 480
 481         /** Complete path to directory containing the film metadata;
 482          *  must not be relative.
 483          */
 484         boost::optional<boost::filesystem::path> _directory;
 485
 486         boost::optional<std::string> _last_written_by;
 487
 488         /** Name for DCP-o-matic */
 489         std::string _name;
 490         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 491         bool _use_isdcf_name;
 492         /** The type of content that this Film represents (feature, trailer etc.) */
 493         DCPContentType const * _dcp_content_type;
 494         /** The container to put this Film in (flat, scope, etc.) */
 495         Ratio const * _container;
 496         /** DCP resolution (2K or 4K) */
 497         Resolution _resolution;
 498         bool _encrypted;
 499         dcp::Key _key;
 500         /** context ID used when encrypting picture assets; we keep it so that we can
 501          *  re-start picture MXF encodes.
 502          */
 503         std::string _context_id;
 504         /** bandwidth for J2K files in bits per second */
 505         int _j2k_bandwidth;
 506         /** Frames per second to run our DCP at */
 507         int _video_frame_rate;
 508         /** The date that we should use in a ISDCF name */
 509         boost::gregorian::date _isdcf_date;
 510         /** Number of audio channels requested for the DCP */
 511         int _audio_channels;
 512         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 513             This will be regardless of what content is on the playlist.
 514         */
 515         bool _three_d;
 516         bool _sequence;
 517         bool _interop;
 518         bool _limit_to_smpte_bv20;
 519         AudioProcessor const * _audio_processor;
 520         ReelType _reel_type;
 521         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 522         int64_t _reel_length;
 523         bool _reencode_j2k;
 524         /** true if the user has ever explicitly set the video frame rate of this film */
 525         bool _user_explicit_video_frame_rate;
 526         bool _user_explicit_container;
 527         bool _user_explicit_resolution;
 528         std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
 529         std::vector<dcp::Rating> _ratings;
 530         std::vector<std::string> _content_versions;
 531         dcp::LanguageTag _name_language;
 532         TerritoryType _territory_type = TerritoryType::SPECIFIC;
 533         boost::optional<dcp::LanguageTag::RegionSubtag> _release_territory;
 534         boost::optional<dcp::LanguageTag> _sign_language_video_language;
 535         int _version_number;
 536         dcp::Status _status;
 537         boost::optional<std::string> _chain;
 538         boost::optional<std::string> _distributor;
 539         boost::optional<std::string> _facility;
 540         boost::optional<std::string> _studio;
 541         bool _temp_version = false;
 542         bool _pre_release = false;
 543         bool _red_band = false;
 544         bool _two_d_version_of_three_d = false;
 545         boost::optional<dcp::Luminance> _luminance;
 546         boost::optional<dcp::LanguageTag> _audio_language;
 547         int _audio_frame_rate = 48000;
 548
 549         int _state_version;
 550
 551         /** true if our state has changed since we last saved it */
 552         mutable bool _dirty;
 553         /** film being used as a template, or 0 */
 554         std::shared_ptr<Film> _template_film;
 555
 556         /** Be tolerant of errors in content (currently applies to DCP only).
 557             Not saved as state.
 558         */
 559         bool _tolerant;
 560
 561         mutable boost::mutex _info_file_mutex;
 562
 563         boost::signals2::scoped_connection _playlist_change_connection;
 564         boost::signals2::scoped_connection _playlist_order_changed_connection;
 565         boost::signals2::scoped_connection _playlist_content_change_connection;
 566         boost::signals2::scoped_connection _playlist_length_change_connection;
 567         std::list<boost::signals2::connection> _job_connections;
 568         std::list<boost::signals2::connection> _audio_analysis_connections;
 569
 570         friend struct paths_test;
 571         friend struct film_metadata_test;
 572 };
 573
 574
 575 typedef ChangeSignaller<Film, FilmProperty> FilmChangeSignaller;
 576
 577
 578 #endif