src/lib/film.h

   1 /*
   2     Copyright (C) 2012-2019 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 AudioMapping;
  61 class Ratio;
  62 class Job;
  63 class ScreenKDM;
  64 class Film;
  65 struct isdcf_name_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         std::list<boost::shared_ptr<ScreenKDM> > make_kdms (
 173                 std::list<boost::shared_ptr<dcpomatic::Screen> > screens,
 174                 boost::filesystem::path cpl_file,
 175                 boost::posix_time::ptime from,
 176                 boost::posix_time::ptime until,
 177                 dcp::Formulation formulation,
 178                 bool disable_forensic_marking_picture,
 179                 boost::optional<int> disable_forensic_marking_audio
 180                 ) const;
 181
 182         int state_version () const {
 183                 return _state_version;
 184         }
 185
 186         std::string subtitle_language () const;
 187
 188         std::vector<std::string> audio_output_names () const;
 189
 190         void repeat_content (ContentList, int);
 191
 192         boost::shared_ptr<const Playlist> playlist () const {
 193                 return _playlist;
 194         }
 195
 196         std::list<dcpomatic::DCPTimePeriod> reels () const;
 197         std::list<int> mapped_audio_channels () const;
 198
 199         std::string content_summary (dcpomatic::DCPTimePeriod period) const;
 200
 201         bool references_dcp_video () const;
 202         bool references_dcp_audio () const;
 203
 204         void set_tolerant (bool t) {
 205                 _tolerant = t;
 206         }
 207
 208         bool tolerant () const {
 209                 return _tolerant;
 210         }
 211
 212         /** Identifiers for the parts of our state;
 213             used for signalling changes.
 214         */
 215         enum Property {
 216                 NONE,
 217                 NAME,
 218                 USE_ISDCF_NAME,
 219                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 220                 CONTENT,
 221                 /** The order of content in the playlist has changed */
 222                 CONTENT_ORDER,
 223                 DCP_CONTENT_TYPE,
 224                 CONTAINER,
 225                 RESOLUTION,
 226                 SIGNED,
 227                 ENCRYPTED,
 228                 KEY,
 229                 J2K_BANDWIDTH,
 230                 ISDCF_METADATA,
 231                 VIDEO_FRAME_RATE,
 232                 AUDIO_CHANNELS,
 233                 /** The setting of _three_d has changed */
 234                 THREE_D,
 235                 SEQUENCE,
 236                 INTEROP,
 237                 AUDIO_PROCESSOR,
 238                 REEL_TYPE,
 239                 REEL_LENGTH,
 240                 UPLOAD_AFTER_MAKE_DCP,
 241                 REENCODE_J2K,
 242                 MARKERS,
 243                 RATINGS,
 244                 CONTENT_VERSION
 245         };
 246
 247
 248         /* GET */
 249
 250         boost::optional<boost::filesystem::path> directory () const {
 251                 return _directory;
 252         }
 253
 254         std::string name () const {
 255                 return _name;
 256         }
 257
 258         bool use_isdcf_name () const {
 259                 return _use_isdcf_name;
 260         }
 261
 262         DCPContentType const * dcp_content_type () const {
 263                 return _dcp_content_type;
 264         }
 265
 266         Ratio const * container () const {
 267                 return _container;
 268         }
 269
 270         Resolution resolution () const {
 271                 return _resolution;
 272         }
 273
 274         /* signed is a reserved word */
 275         bool is_signed () const {
 276                 return _signed;
 277         }
 278
 279         bool encrypted () const {
 280                 return _encrypted;
 281         }
 282
 283         dcp::Key key () const {
 284                 return _key;
 285         }
 286
 287         int j2k_bandwidth () const {
 288                 return _j2k_bandwidth;
 289         }
 290
 291         ISDCFMetadata isdcf_metadata () const {
 292                 return _isdcf_metadata;
 293         }
 294
 295         /** @return The frame rate of the DCP */
 296         int video_frame_rate () const {
 297                 return _video_frame_rate;
 298         }
 299
 300         int audio_channels () const {
 301                 return _audio_channels;
 302         }
 303
 304         bool three_d () const {
 305                 return _three_d;
 306         }
 307
 308         bool sequence () const {
 309                 return _sequence;
 310         }
 311
 312         bool interop () const {
 313                 return _interop;
 314         }
 315
 316         AudioProcessor const * audio_processor () const {
 317                 return _audio_processor;
 318         }
 319
 320         ReelType reel_type () const {
 321                 return _reel_type;
 322         }
 323
 324         int64_t reel_length () const {
 325                 return _reel_length;
 326         }
 327
 328         bool upload_after_make_dcp () const {
 329                 return _upload_after_make_dcp;
 330         }
 331
 332         std::string context_id () const {
 333                 return _context_id;
 334         }
 335
 336         bool reencode_j2k () const {
 337                 return _reencode_j2k;
 338         }
 339
 340         boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
 341         std::map<dcp::Marker, dcpomatic::DCPTime> markers () const {
 342                 return _markers;
 343         }
 344
 345         std::vector<dcp::Rating> ratings () const {
 346                 return _ratings;
 347         }
 348
 349         std::string content_version () const {
 350                 return _content_version;
 351         }
 352
 353         /* SET */
 354
 355         void set_directory (boost::filesystem::path);
 356         void set_name (std::string);
 357         void set_use_isdcf_name (bool);
 358         void examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
 359         void add_content (boost::shared_ptr<Content>);
 360         void remove_content (boost::shared_ptr<Content>);
 361         void remove_content (ContentList);
 362         void move_content_earlier (boost::shared_ptr<Content>);
 363         void move_content_later (boost::shared_ptr<Content>);
 364         void set_dcp_content_type (DCPContentType const *);
 365         void set_container (Ratio const *);
 366         void set_resolution (Resolution);
 367         void set_signed (bool);
 368         void set_encrypted (bool);
 369         void set_key (dcp::Key key);
 370         void set_j2k_bandwidth (int);
 371         void set_isdcf_metadata (ISDCFMetadata);
 372         void set_video_frame_rate (int rate, bool user_explicit = false);
 373         void set_audio_channels (int);
 374         void set_three_d (bool);
 375         void set_isdcf_date_today ();
 376         void set_sequence (bool);
 377         void set_interop (bool);
 378         void set_audio_processor (AudioProcessor const * processor);
 379         void set_reel_type (ReelType);
 380         void set_reel_length (int64_t);
 381         void set_upload_after_make_dcp (bool);
 382         void set_reencode_j2k (bool);
 383         void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
 384         void unset_marker (dcp::Marker type);
 385         void clear_markers ();
 386         void set_ratings (std::vector<dcp::Rating> r);
 387         void set_content_version (std::string v);
 388
 389         /** Emitted when some property has of the Film is about to change or has changed */
 390         mutable boost::signals2::signal<void (ChangeType, Property)> Change;
 391
 392         /** Emitted when some property of our content has changed */
 393         mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
 394
 395         /** Emitted when the film's length might have changed; this is not like a normal
 396             property as its value is derived from the playlist, so it has its own signal.
 397         */
 398         mutable boost::signals2::signal<void ()> LengthChange;
 399
 400         /** Emitted when we have something important to tell the user */
 401         boost::signals2::signal<void (std::string)> Message;
 402
 403         /** Current version number of the state file */
 404         static int const current_state_version;
 405
 406 private:
 407
 408         friend struct ::isdcf_name_test;
 409         template <typename> friend class ChangeSignaller;
 410
 411         boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
 412
 413         void signal_change (ChangeType, Property);
 414         void signal_change (ChangeType, int);
 415         std::string video_identifier () const;
 416         void playlist_change (ChangeType);
 417         void playlist_order_changed ();
 418         void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
 419         void playlist_length_change ();
 420         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
 421         void audio_analysis_finished ();
 422         void check_settings_consistency ();
 423
 424         static std::string const metadata_file;
 425
 426         /** Log to write to */
 427         boost::shared_ptr<Log> _log;
 428         boost::shared_ptr<Playlist> _playlist;
 429
 430         /** Complete path to directory containing the film metadata;
 431          *  must not be relative.
 432          */
 433         boost::optional<boost::filesystem::path> _directory;
 434
 435         /** Name for DCP-o-matic */
 436         std::string _name;
 437         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 438         bool _use_isdcf_name;
 439         /** The type of content that this Film represents (feature, trailer etc.) */
 440         DCPContentType const * _dcp_content_type;
 441         /** The container to put this Film in (flat, scope, etc.) */
 442         Ratio const * _container;
 443         /** DCP resolution (2K or 4K) */
 444         Resolution _resolution;
 445         bool _signed;
 446         bool _encrypted;
 447         dcp::Key _key;
 448         /** context ID used when encrypting picture assets; we keep it so that we can
 449          *  re-start picture MXF encodes.
 450          */
 451         std::string _context_id;
 452         /** bandwidth for J2K files in bits per second */
 453         int _j2k_bandwidth;
 454         /** ISDCF naming stuff */
 455         ISDCFMetadata _isdcf_metadata;
 456         /** Frames per second to run our DCP at */
 457         int _video_frame_rate;
 458         /** The date that we should use in a ISDCF name */
 459         boost::gregorian::date _isdcf_date;
 460         /** Number of audio channels requested for the DCP */
 461         int _audio_channels;
 462         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 463             This will be regardless of what content is on the playlist.
 464         */
 465         bool _three_d;
 466         bool _sequence;
 467         bool _interop;
 468         AudioProcessor const * _audio_processor;
 469         ReelType _reel_type;
 470         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 471         int64_t _reel_length;
 472         bool _upload_after_make_dcp;
 473         bool _reencode_j2k;
 474         /** true if the user has ever explicitly set the video frame rate of this film */
 475         bool _user_explicit_video_frame_rate;
 476         std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
 477         std::vector<dcp::Rating> _ratings;
 478         std::string _content_version;
 479
 480         int _state_version;
 481
 482         /** true if our state has changed since we last saved it */
 483         mutable bool _dirty;
 484         /** film being used as a template, or 0 */
 485         boost::shared_ptr<Film> _template_film;
 486
 487         /** Be tolerant of errors in content (currently applies to DCP only).
 488             Not saved as state.
 489         */
 490         bool _tolerant;
 491
 492         mutable boost::mutex _info_file_mutex;
 493
 494         boost::signals2::scoped_connection _playlist_change_connection;
 495         boost::signals2::scoped_connection _playlist_order_changed_connection;
 496         boost::signals2::scoped_connection _playlist_content_change_connection;
 497         boost::signals2::scoped_connection _playlist_length_change_connection;
 498         std::list<boost::signals2::connection> _job_connections;
 499         std::list<boost::signals2::connection> _audio_analysis_connections;
 500
 501         friend struct paths_test;
 502         friend struct film_metadata_test;
 503 };
 504
 505 #endif