src/lib/film.h

   1 /*
   2     Copyright (C) 2012-2016 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/key.h>
  35 #include <dcp/encrypted_kdm.h>
  36 #include <boost/signals2.hpp>
  37 #include <boost/enable_shared_from_this.hpp>
  38 #include <boost/filesystem.hpp>
  39 #include <string>
  40 #include <vector>
  41 #include <inttypes.h>
  42
  43 namespace xmlpp {
  44         class Document;
  45 }
  46
  47 class DCPContentType;
  48 class Log;
  49 class Content;
  50 class Playlist;
  51 class AudioContent;
  52 class Screen;
  53 class AudioProcessor;
  54 class AudioMapping;
  55 class Ratio;
  56 class Job;
  57 class ScreenKDM;
  58 struct isdcf_name_test;
  59
  60 /** @class Film
  61  *
  62  *  @brief A representation of some audio and video content, and details of
  63  *  how they should be presented in a DCP.
  64  *
  65  *  The content of a Film is held in a Playlist (created and managed by the Film).
  66  */
  67 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
  68 {
  69 public:
  70         Film (boost::optional<boost::filesystem::path> dir);
  71         ~Film ();
  72
  73         boost::filesystem::path info_file (DCPTimePeriod p) const;
  74         boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
  75         boost::filesystem::path internal_video_asset_dir () const;
  76         boost::filesystem::path internal_video_asset_filename (DCPTimePeriod p) const;
  77
  78         boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
  79
  80         void send_dcp_to_tms ();
  81         void make_dcp ();
  82
  83         /** @return Logger.
  84          *  It is safe to call this from any thread.
  85          */
  86         boost::shared_ptr<Log> log () const {
  87                 return _log;
  88         }
  89
  90         boost::filesystem::path file (boost::filesystem::path f) const;
  91         boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
  92
  93         void use_template (std::string name);
  94         std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
  95         void write_metadata () const;
  96         void write_template (boost::filesystem::path path) const;
  97         boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
  98
  99         std::string isdcf_name (bool if_created_now) const;
 100         std::string dcp_name (bool if_created_now = false) const;
 101
 102         /** @return true if our state has changed since we last saved it */
 103         bool dirty () const {
 104                 return _dirty;
 105         }
 106
 107         dcp::Size full_frame () const;
 108         dcp::Size frame_size () const;
 109
 110         std::vector<CPLSummary> cpls () const;
 111
 112         int audio_frame_rate () const;
 113
 114         uint64_t required_disk_space () const;
 115         bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
 116
 117         /* Proxies for some Playlist methods */
 118
 119         ContentList content () const;
 120         DCPTime length () const;
 121         int best_video_frame_rate () const;
 122         FrameRateChange active_frame_rate_change (DCPTime) const;
 123
 124         dcp::EncryptedKDM make_kdm (
 125                 dcp::Certificate recipient,
 126                 std::vector<dcp::Certificate> trusted_devices,
 127                 boost::filesystem::path cpl_file,
 128                 dcp::LocalTime from,
 129                 dcp::LocalTime until,
 130                 dcp::Formulation formulation
 131                 ) const;
 132
 133         std::list<ScreenKDM> make_kdms (
 134                 std::list<boost::shared_ptr<Screen> >,
 135                 boost::filesystem::path cpl_file,
 136                 boost::posix_time::ptime from,
 137                 boost::posix_time::ptime until,
 138                 dcp::Formulation formulation
 139                 ) const;
 140
 141         int state_version () const {
 142                 return _state_version;
 143         }
 144
 145         std::string subtitle_language () const;
 146
 147         void make_audio_mapping_default (
 148                 AudioMapping & mapping,
 149                 boost::optional<boost::filesystem::path> filename = boost::optional<boost::filesystem::path> ()
 150                 ) const;
 151
 152         std::vector<std::string> audio_output_names () const;
 153
 154         void repeat_content (ContentList, int);
 155
 156         boost::shared_ptr<const Playlist> playlist () const {
 157                 return _playlist;
 158         }
 159
 160         std::list<DCPTimePeriod> reels () const;
 161         std::list<int> mapped_audio_channels () const;
 162
 163         /** @param A period within the DCP
 164          *  @return Name of the content which most contributes to the given period.
 165          */
 166         std::string content_summary (DCPTimePeriod period) const;
 167
 168         std::list<std::string> fix_conflicting_settings ();
 169
 170         /** Identifiers for the parts of our state;
 171             used for signalling changes.
 172         */
 173         enum Property {
 174                 NONE,
 175                 NAME,
 176                 USE_ISDCF_NAME,
 177                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 178                 CONTENT,
 179                 /** The order of content in the playlist has changed */
 180                 CONTENT_ORDER,
 181                 DCP_CONTENT_TYPE,
 182                 CONTAINER,
 183                 RESOLUTION,
 184                 SIGNED,
 185                 ENCRYPTED,
 186                 KEY,
 187                 J2K_BANDWIDTH,
 188                 ISDCF_METADATA,
 189                 VIDEO_FRAME_RATE,
 190                 AUDIO_CHANNELS,
 191                 /** The setting of _three_d has changed */
 192                 THREE_D,
 193                 SEQUENCE,
 194                 INTEROP,
 195                 AUDIO_PROCESSOR,
 196                 REEL_TYPE,
 197                 REEL_LENGTH,
 198                 UPLOAD_AFTER_MAKE_DCP
 199         };
 200
 201
 202         /* GET */
 203
 204         boost::optional<boost::filesystem::path> directory () const {
 205                 return _directory;
 206         }
 207
 208         std::string name () const {
 209                 return _name;
 210         }
 211
 212         bool use_isdcf_name () const {
 213                 return _use_isdcf_name;
 214         }
 215
 216         DCPContentType const * dcp_content_type () const {
 217                 return _dcp_content_type;
 218         }
 219
 220         Ratio const * container () const {
 221                 return _container;
 222         }
 223
 224         Resolution resolution () const {
 225                 return _resolution;
 226         }
 227
 228         /* signed is a reserved word */
 229         bool is_signed () const {
 230                 return _signed;
 231         }
 232
 233         bool encrypted () const {
 234                 return _encrypted;
 235         }
 236
 237         dcp::Key key () const {
 238                 return _key;
 239         }
 240
 241         int j2k_bandwidth () const {
 242                 return _j2k_bandwidth;
 243         }
 244
 245         ISDCFMetadata isdcf_metadata () const {
 246                 return _isdcf_metadata;
 247         }
 248
 249         /** @return The frame rate of the DCP */
 250         int video_frame_rate () const {
 251                 return _video_frame_rate;
 252         }
 253
 254         int audio_channels () const {
 255                 return _audio_channels;
 256         }
 257
 258         bool three_d () const {
 259                 return _three_d;
 260         }
 261
 262         bool sequence () const {
 263                 return _sequence;
 264         }
 265
 266         bool interop () const {
 267                 return _interop;
 268         }
 269
 270         AudioProcessor const * audio_processor () const {
 271                 return _audio_processor;
 272         }
 273
 274         ReelType reel_type () const {
 275                 return _reel_type;
 276         }
 277
 278         int64_t reel_length () const {
 279                 return _reel_length;
 280         }
 281
 282         bool upload_after_make_dcp () const {
 283                 return _upload_after_make_dcp;
 284         }
 285
 286         std::string context_id () const {
 287                 return _context_id;
 288         }
 289
 290
 291         /* SET */
 292
 293         void set_directory (boost::filesystem::path);
 294         void set_name (std::string);
 295         void set_use_isdcf_name (bool);
 296         void examine_and_add_content (boost::shared_ptr<Content>);
 297         void add_content (boost::shared_ptr<Content>);
 298         void remove_content (boost::shared_ptr<Content>);
 299         void remove_content (ContentList);
 300         void move_content_earlier (boost::shared_ptr<Content>);
 301         void move_content_later (boost::shared_ptr<Content>);
 302         void set_dcp_content_type (DCPContentType const *);
 303         void set_container (Ratio const *);
 304         void set_resolution (Resolution);
 305         void set_signed (bool);
 306         void set_encrypted (bool);
 307         void set_key (dcp::Key key);
 308         void set_j2k_bandwidth (int);
 309         void set_isdcf_metadata (ISDCFMetadata);
 310         void set_video_frame_rate (int);
 311         void set_audio_channels (int);
 312         void set_three_d (bool);
 313         void set_isdcf_date_today ();
 314         void set_sequence (bool);
 315         void set_interop (bool);
 316         void set_audio_processor (AudioProcessor const * processor);
 317         void set_reel_type (ReelType);
 318         void set_reel_length (int64_t);
 319         void set_upload_after_make_dcp (bool);
 320
 321         /** Emitted when some property has of the Film has changed */
 322         mutable boost::signals2::signal<void (Property)> Changed;
 323
 324         /** Emitted when some property of our content has changed */
 325         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
 326
 327         /** Current version number of the state file */
 328         static int const current_state_version;
 329
 330 private:
 331
 332         friend struct ::isdcf_name_test;
 333
 334         void signal_changed (Property);
 335         std::string video_identifier () const;
 336         void playlist_changed ();
 337         void playlist_order_changed ();
 338         void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
 339         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
 340         void audio_analysis_finished ();
 341
 342         /** Log to write to */
 343         boost::shared_ptr<Log> _log;
 344         boost::shared_ptr<Playlist> _playlist;
 345
 346         /** Complete path to directory containing the film metadata;
 347          *  must not be relative.
 348          */
 349         boost::optional<boost::filesystem::path> _directory;
 350
 351         /** Name for DCP-o-matic */
 352         std::string _name;
 353         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 354         bool _use_isdcf_name;
 355         /** The type of content that this Film represents (feature, trailer etc.) */
 356         DCPContentType const * _dcp_content_type;
 357         /** The container to put this Film in (flat, scope, etc.) */
 358         Ratio const * _container;
 359         /** DCP resolution (2K or 4K) */
 360         Resolution _resolution;
 361         bool _signed;
 362         bool _encrypted;
 363         dcp::Key _key;
 364         /** context ID used when encrypting picture assets; we keep it so that we can
 365          *  re-start picture MXF encodes.
 366          */
 367         std::string _context_id;
 368         /** bandwidth for J2K files in bits per second */
 369         int _j2k_bandwidth;
 370         /** ISDCF naming stuff */
 371         ISDCFMetadata _isdcf_metadata;
 372         /** Frames per second to run our DCP at */
 373         int _video_frame_rate;
 374         /** The date that we should use in a ISDCF name */
 375         boost::gregorian::date _isdcf_date;
 376         /** Number of audio channels requested for the DCP */
 377         int _audio_channels;
 378         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 379             This will be regardless of what content is on the playlist.
 380         */
 381         bool _three_d;
 382         bool _sequence;
 383         bool _interop;
 384         AudioProcessor const * _audio_processor;
 385         ReelType _reel_type;
 386         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 387         int64_t _reel_length;
 388         bool _upload_after_make_dcp;
 389
 390         int _state_version;
 391
 392         /** true if our state has changed since we last saved it */
 393         mutable bool _dirty;
 394         /** film being used as a template, or 0 */
 395         boost::shared_ptr<Film> _template_film;
 396
 397         boost::signals2::scoped_connection _playlist_changed_connection;
 398         boost::signals2::scoped_connection _playlist_order_changed_connection;
 399         boost::signals2::scoped_connection _playlist_content_changed_connection;
 400         std::list<boost::signals2::connection> _job_connections;
 401         std::list<boost::signals2::connection> _audio_analysis_connections;
 402
 403         friend struct paths_test;
 404         friend struct film_metadata_test;
 405 };
 406
 407 #endif