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