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