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