src/lib/film.h

   1 /*
   2     Copyright (C) 2012-2020 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 "util.h"
  30 #include "types.h"
  31 #include "isdcf_metadata.h"
  32 #include "frame_rate_change.h"
  33 #include "signaller.h"
  34 #include "dcp_text_track.h"
  35 #include <dcp/key.h>
  36 #include <dcp/encrypted_kdm.h>
  37 #include <boost/signals2.hpp>
  38 #include <boost/enable_shared_from_this.hpp>
  39 #include <boost/thread.hpp>
  40 #include <boost/filesystem.hpp>
  41 #include <boost/thread/mutex.hpp>
  42 #include <string>
  43 #include <vector>
  44 #include <inttypes.h>
  45
  46 namespace xmlpp {
  47         class Document;
  48 }
  49
  50 namespace dcpomatic {
  51         class Screen;
  52 }
  53
  54 class DCPContentType;
  55 class Log;
  56 class Content;
  57 class Playlist;
  58 class AudioContent;
  59 class AudioProcessor;
  60 class Ratio;
  61 class Job;
  62 class Film;
  63 struct isdcf_name_test;
  64 struct recover_test_2d_encrypted;
  65 struct atmos_encrypted_passthrough_test;
  66
  67 class InfoFileHandle
  68 {
  69 public:
  70         ~InfoFileHandle ();
  71
  72         FILE* get () const {
  73                 return _handle;
  74         }
  75
  76         boost::filesystem::path file () const {
  77                 return _file;
  78         }
  79
  80 private:
  81         friend class Film;
  82
  83         InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
  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 boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
  98 {
  99 public:
 100         explicit Film (boost::optional<boost::filesystem::path> dir);
 101         ~Film ();
 102
 103         boost::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
 104         boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
 105         boost::filesystem::path internal_video_asset_dir () const;
 106         boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
 107
 108         boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
 109         boost::filesystem::path subtitle_analysis_path (boost::shared_ptr<const Content>) const;
 110
 111         void send_dcp_to_tms ();
 112         void make_dcp (bool gui = false, bool check = true);
 113
 114         /** @return Logger.
 115          *  It is safe to call this from any thread.
 116          */
 117         boost::shared_ptr<Log> log () const {
 118                 return _log;
 119         }
 120
 121         boost::filesystem::path file (boost::filesystem::path f) const;
 122         boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
 123
 124         void use_template (std::string name);
 125         std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
 126         void write_metadata () const;
 127         void write_metadata (boost::filesystem::path path) const;
 128         void write_template (boost::filesystem::path path) const;
 129         boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
 130
 131         void copy_from (boost::shared_ptr<const Film> film);
 132
 133         std::string isdcf_name (bool if_created_now) const;
 134         std::string dcp_name (bool if_created_now = false) const;
 135
 136         /** @return true if our state has changed since we last saved it */
 137         bool dirty () const {
 138                 return _dirty;
 139         }
 140
 141         dcp::Size full_frame () const;
 142         dcp::Size frame_size () const;
 143
 144         std::vector<CPLSummary> cpls () const;
 145
 146         int audio_frame_rate () const;
 147
 148         std::list<DCPTextTrack> closed_caption_tracks () const;
 149
 150         uint64_t required_disk_space () const;
 151         bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
 152
 153         /* Proxies for some Playlist methods */
 154
 155         ContentList content () const;
 156         dcpomatic::DCPTime length () const;
 157         int best_video_frame_rate () const;
 158         FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
 159         std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
 160
 161         dcp::EncryptedKDM make_kdm (
 162                 dcp::Certificate recipient,
 163                 std::vector<std::string> trusted_devices,
 164                 boost::filesystem::path cpl_file,
 165                 dcp::LocalTime from,
 166                 dcp::LocalTime until,
 167                 dcp::Formulation formulation,
 168                 bool disable_forensic_marking_picture,
 169                 boost::optional<int> disable_forensic_marking_audio
 170                 ) const;
 171
 172         int state_version () const {
 173                 return _state_version;
 174         }
 175
 176         std::string subtitle_language () const;
 177
 178         std::vector<std::string> audio_output_names () const;
 179
 180         void repeat_content (ContentList, int);
 181
 182         boost::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         std::string content_summary (dcpomatic::DCPTimePeriod period) const;
 190
 191         bool references_dcp_video () const;
 192         bool references_dcp_audio () const;
 193         bool contains_atmos_content () const;
 194
 195         void set_tolerant (bool t) {
 196                 _tolerant = t;
 197         }
 198
 199         bool tolerant () const {
 200                 return _tolerant;
 201         }
 202
 203         /** Identifiers for the parts of our state;
 204             used for signalling changes.
 205         */
 206         enum Property {
 207                 NONE,
 208                 NAME,
 209                 USE_ISDCF_NAME,
 210                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 211                 CONTENT,
 212                 /** The order of content in the playlist has changed */
 213                 CONTENT_ORDER,
 214                 DCP_CONTENT_TYPE,
 215                 CONTAINER,
 216                 RESOLUTION,
 217                 ENCRYPTED,
 218                 J2K_BANDWIDTH,
 219                 ISDCF_METADATA,
 220                 VIDEO_FRAME_RATE,
 221                 AUDIO_CHANNELS,
 222                 /** The setting of _three_d has changed */
 223                 THREE_D,
 224                 SEQUENCE,
 225                 INTEROP,
 226                 AUDIO_PROCESSOR,
 227                 REEL_TYPE,
 228                 REEL_LENGTH,
 229                 REENCODE_J2K,
 230                 MARKERS,
 231                 RATINGS,
 232                 CONTENT_VERSION
 233         };
 234
 235
 236         /* GET */
 237
 238         boost::optional<boost::filesystem::path> directory () const {
 239                 return _directory;
 240         }
 241
 242         std::string name () const {
 243                 return _name;
 244         }
 245
 246         bool use_isdcf_name () const {
 247                 return _use_isdcf_name;
 248         }
 249
 250         DCPContentType const * dcp_content_type () const {
 251                 return _dcp_content_type;
 252         }
 253
 254         Ratio const * container () const {
 255                 return _container;
 256         }
 257
 258         Resolution resolution () const {
 259                 return _resolution;
 260         }
 261
 262         bool encrypted () const {
 263                 return _encrypted;
 264         }
 265
 266         dcp::Key key () const {
 267                 return _key;
 268         }
 269
 270         int j2k_bandwidth () const {
 271                 return _j2k_bandwidth;
 272         }
 273
 274         ISDCFMetadata isdcf_metadata () const {
 275                 return _isdcf_metadata;
 276         }
 277
 278         /** @return The frame rate of the DCP */
 279         int video_frame_rate () const {
 280                 return _video_frame_rate;
 281         }
 282
 283         int audio_channels () const {
 284                 return _audio_channels;
 285         }
 286
 287         bool three_d () const {
 288                 return _three_d;
 289         }
 290
 291         bool sequence () const {
 292                 return _sequence;
 293         }
 294
 295         bool interop () const {
 296                 return _interop;
 297         }
 298
 299         AudioProcessor const * audio_processor () const {
 300                 return _audio_processor;
 301         }
 302
 303         ReelType reel_type () const {
 304                 return _reel_type;
 305         }
 306
 307         int64_t reel_length () const {
 308                 return _reel_length;
 309         }
 310
 311         std::string context_id () const {
 312                 return _context_id;
 313         }
 314
 315         bool reencode_j2k () const {
 316                 return _reencode_j2k;
 317         }
 318
 319         boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
 320         std::map<dcp::Marker, dcpomatic::DCPTime> markers () const {
 321                 return _markers;
 322         }
 323
 324         std::vector<dcp::Rating> ratings () const {
 325                 return _ratings;
 326         }
 327
 328         std::string content_version () const {
 329                 return _content_version;
 330         }
 331
 332         /* SET */
 333
 334         void set_directory (boost::filesystem::path);
 335         void set_name (std::string);
 336         void set_use_isdcf_name (bool);
 337         void examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
 338         void add_content (boost::shared_ptr<Content>);
 339         void remove_content (boost::shared_ptr<Content>);
 340         void remove_content (ContentList);
 341         void move_content_earlier (boost::shared_ptr<Content>);
 342         void move_content_later (boost::shared_ptr<Content>);
 343         void set_dcp_content_type (DCPContentType const *);
 344         void set_container (Ratio const *, bool user_explicit = true);
 345         void set_resolution (Resolution, bool user_explicit = true);
 346         void set_encrypted (bool);
 347         void set_j2k_bandwidth (int);
 348         void set_isdcf_metadata (ISDCFMetadata);
 349         void set_video_frame_rate (int rate, bool user_explicit = false);
 350         void set_audio_channels (int);
 351         void set_three_d (bool);
 352         void set_isdcf_date_today ();
 353         void set_sequence (bool);
 354         void set_interop (bool);
 355         void set_audio_processor (AudioProcessor const * processor);
 356         void set_reel_type (ReelType);
 357         void set_reel_length (int64_t);
 358         void set_reencode_j2k (bool);
 359         void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
 360         void unset_marker (dcp::Marker type);
 361         void clear_markers ();
 362         void set_ratings (std::vector<dcp::Rating> r);
 363         void set_content_version (std::string v);
 364
 365         /** Emitted when some property has of the Film is about to change or has changed */
 366         mutable boost::signals2::signal<void (ChangeType, Property)> Change;
 367
 368         /** Emitted when some property of our content has changed */
 369         mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
 370
 371         /** Emitted when the film's length might have changed; this is not like a normal
 372             property as its value is derived from the playlist, so it has its own signal.
 373         */
 374         mutable boost::signals2::signal<void ()> LengthChange;
 375
 376         /** Emitted when we have something important to tell the user */
 377         boost::signals2::signal<void (std::string)> Message;
 378
 379         /** Current version number of the state file */
 380         static int const current_state_version;
 381
 382 private:
 383
 384         friend struct ::isdcf_name_test;
 385         friend struct ::recover_test_2d_encrypted;
 386         friend struct ::atmos_encrypted_passthrough_test;
 387         template <typename> friend class ChangeSignaller;
 388
 389         boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
 390
 391         void signal_change (ChangeType, Property);
 392         void signal_change (ChangeType, int);
 393         std::string video_identifier () const;
 394         void playlist_change (ChangeType);
 395         void playlist_order_changed ();
 396         void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
 397         void playlist_length_change ();
 398         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
 399         void audio_analysis_finished ();
 400         void check_settings_consistency ();
 401         void maybe_set_container_and_resolution ();
 402
 403         static std::string const metadata_file;
 404
 405         /** Log to write to */
 406         boost::shared_ptr<Log> _log;
 407         boost::shared_ptr<Playlist> _playlist;
 408
 409         /** Complete path to directory containing the film metadata;
 410          *  must not be relative.
 411          */
 412         boost::optional<boost::filesystem::path> _directory;
 413
 414         /** Name for DCP-o-matic */
 415         std::string _name;
 416         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 417         bool _use_isdcf_name;
 418         /** The type of content that this Film represents (feature, trailer etc.) */
 419         DCPContentType const * _dcp_content_type;
 420         /** The container to put this Film in (flat, scope, etc.) */
 421         Ratio const * _container;
 422         /** DCP resolution (2K or 4K) */
 423         Resolution _resolution;
 424         bool _encrypted;
 425         dcp::Key _key;
 426         /** context ID used when encrypting picture assets; we keep it so that we can
 427          *  re-start picture MXF encodes.
 428          */
 429         std::string _context_id;
 430         /** bandwidth for J2K files in bits per second */
 431         int _j2k_bandwidth;
 432         /** ISDCF naming stuff */
 433         ISDCFMetadata _isdcf_metadata;
 434         /** Frames per second to run our DCP at */
 435         int _video_frame_rate;
 436         /** The date that we should use in a ISDCF name */
 437         boost::gregorian::date _isdcf_date;
 438         /** Number of audio channels requested for the DCP */
 439         int _audio_channels;
 440         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 441             This will be regardless of what content is on the playlist.
 442         */
 443         bool _three_d;
 444         bool _sequence;
 445         bool _interop;
 446         AudioProcessor const * _audio_processor;
 447         ReelType _reel_type;
 448         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 449         int64_t _reel_length;
 450         bool _reencode_j2k;
 451         /** true if the user has ever explicitly set the video frame rate of this film */
 452         bool _user_explicit_video_frame_rate;
 453         bool _user_explicit_container;
 454         bool _user_explicit_resolution;
 455         std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
 456         std::vector<dcp::Rating> _ratings;
 457         std::string _content_version;
 458
 459         int _state_version;
 460
 461         /** true if our state has changed since we last saved it */
 462         mutable bool _dirty;
 463         /** film being used as a template, or 0 */
 464         boost::shared_ptr<Film> _template_film;
 465
 466         /** Be tolerant of errors in content (currently applies to DCP only).
 467             Not saved as state.
 468         */
 469         bool _tolerant;
 470
 471         mutable boost::mutex _info_file_mutex;
 472
 473         boost::signals2::scoped_connection _playlist_change_connection;
 474         boost::signals2::scoped_connection _playlist_order_changed_connection;
 475         boost::signals2::scoped_connection _playlist_content_change_connection;
 476         boost::signals2::scoped_connection _playlist_length_change_connection;
 477         std::list<boost::signals2::connection> _job_connections;
 478         std::list<boost::signals2::connection> _audio_analysis_connections;
 479
 480         friend struct paths_test;
 481         friend struct film_metadata_test;
 482 };
 483
 484 #endif