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