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