src/lib/film.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/film.h
  21  *  @brief A representation of some audio and video content, and details of
  22  *  how they should be presented in a DCP.
  23  */
  24
  25 #ifndef DCPOMATIC_FILM_H
  26 #define DCPOMATIC_FILM_H
  27
  28 #include "util.h"
  29 #include "types.h"
  30 #include "isdcf_metadata.h"
  31 #include "frame_rate_change.h"
  32 #include "signaller.h"
  33 #include <dcp/key.h>
  34 #include <dcp/encrypted_kdm.h>
  35 #include <boost/signals2.hpp>
  36 #include <boost/enable_shared_from_this.hpp>
  37 #include <boost/filesystem.hpp>
  38 #include <string>
  39 #include <vector>
  40 #include <inttypes.h>
  41
  42 namespace xmlpp {
  43         class Document;
  44 }
  45
  46 class DCPContentType;
  47 class Log;
  48 class Content;
  49 class Player;
  50 class Playlist;
  51 class AudioContent;
  52 class Screen;
  53 class AudioProcessor;
  54 class AudioMapping;
  55 class Ratio;
  56 struct isdcf_name_test;
  57
  58 /** @class Film
  59  *
  60  *  @brief A representation of some audio and video content, and details of
  61  *  how they should be presented in a DCP.
  62  *
  63  *  The content of a Film is held in a Playlist (created and managed by the Film).
  64  */
  65 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
  66 {
  67 public:
  68         Film (boost::filesystem::path, bool log = true);
  69         ~Film ();
  70
  71         boost::filesystem::path info_file () const;
  72         boost::filesystem::path j2c_path (int, Eyes, bool) const;
  73         boost::filesystem::path internal_video_asset_dir () const;
  74         boost::filesystem::path internal_video_asset_filename () const;
  75
  76         boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
  77
  78         void send_dcp_to_tms ();
  79         void make_dcp ();
  80
  81         /** @return Logger.
  82          *  It is safe to call this from any thread.
  83          */
  84         boost::shared_ptr<Log> log () const {
  85                 return _log;
  86         }
  87
  88         boost::filesystem::path file (boost::filesystem::path f) const;
  89         boost::filesystem::path dir (boost::filesystem::path d) const;
  90
  91         std::list<std::string> read_metadata ();
  92         void write_metadata () const;
  93         boost::shared_ptr<xmlpp::Document> metadata () const;
  94
  95         std::string isdcf_name (bool if_created_now) const;
  96         std::string dcp_name (bool if_created_now = false) const;
  97
  98         /** @return true if our state has changed since we last saved it */
  99         bool dirty () const {
 100                 return _dirty;
 101         }
 102
 103         dcp::Size full_frame () const;
 104         dcp::Size frame_size () const;
 105
 106         std::vector<CPLSummary> cpls () const;
 107
 108         int audio_frame_rate () const;
 109
 110         uint64_t required_disk_space () const;
 111         bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
 112
 113         /* Proxies for some Playlist methods */
 114
 115         ContentList content () const;
 116         DCPTime length () const;
 117         int best_video_frame_rate () const;
 118         FrameRateChange active_frame_rate_change (DCPTime) const;
 119
 120         dcp::EncryptedKDM
 121         make_kdm (
 122                 dcp::Certificate target,
 123                 boost::filesystem::path cpl_file,
 124                 dcp::LocalTime from,
 125                 dcp::LocalTime until,
 126                 dcp::Formulation formulation
 127                 ) const;
 128
 129         std::list<dcp::EncryptedKDM> make_kdms (
 130                 std::list<boost::shared_ptr<Screen> >,
 131                 boost::filesystem::path cpl_file,
 132                 dcp::LocalTime from,
 133                 dcp::LocalTime until,
 134                 dcp::Formulation formulation
 135                 ) const;
 136
 137         int state_version () const {
 138                 return _state_version;
 139         }
 140
 141         std::string subtitle_language () const;
 142
 143         void make_audio_mapping_default (AudioMapping & mapping) const;
 144         std::vector<std::string> audio_output_names () const;
 145
 146         void repeat_content (ContentList, int);
 147
 148         boost::shared_ptr<const Playlist> playlist () const {
 149                 return _playlist;
 150         }
 151
 152         /** Identifiers for the parts of our state;
 153             used for signalling changes.
 154         */
 155         enum Property {
 156                 NONE,
 157                 NAME,
 158                 USE_ISDCF_NAME,
 159                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 160                 CONTENT,
 161                 DCP_CONTENT_TYPE,
 162                 CONTAINER,
 163                 RESOLUTION,
 164                 SIGNED,
 165                 ENCRYPTED,
 166                 KEY,
 167                 J2K_BANDWIDTH,
 168                 ISDCF_METADATA,
 169                 VIDEO_FRAME_RATE,
 170                 AUDIO_CHANNELS,
 171                 /** The setting of _three_d has changed */
 172                 THREE_D,
 173                 SEQUENCE_VIDEO,
 174                 INTEROP,
 175                 AUDIO_PROCESSOR,
 176         };
 177
 178
 179         /* GET */
 180
 181         boost::filesystem::path directory () const {
 182                 return _directory;
 183         }
 184
 185         std::string name () const {
 186                 return _name;
 187         }
 188
 189         bool use_isdcf_name () const {
 190                 return _use_isdcf_name;
 191         }
 192
 193         DCPContentType const * dcp_content_type () const {
 194                 return _dcp_content_type;
 195         }
 196
 197         Ratio const * container () const {
 198                 return _container;
 199         }
 200
 201         Resolution resolution () const {
 202                 return _resolution;
 203         }
 204
 205         /* signed is a reserved word */
 206         bool is_signed () const {
 207                 return _signed;
 208         }
 209
 210         bool encrypted () const {
 211                 return _encrypted;
 212         }
 213
 214         dcp::Key key () const {
 215                 return _key;
 216         }
 217
 218         int j2k_bandwidth () const {
 219                 return _j2k_bandwidth;
 220         }
 221
 222         ISDCFMetadata isdcf_metadata () const {
 223                 return _isdcf_metadata;
 224         }
 225
 226         /** @return The frame rate of the DCP */
 227         int video_frame_rate () const {
 228                 return _video_frame_rate;
 229         }
 230
 231         int audio_channels () const {
 232                 return _audio_channels;
 233         }
 234
 235         bool three_d () const {
 236                 return _three_d;
 237         }
 238
 239         bool sequence_video () const {
 240                 return _sequence_video;
 241         }
 242
 243         bool interop () const {
 244                 return _interop;
 245         }
 246
 247         AudioProcessor const * audio_processor () const {
 248                 return _audio_processor;
 249         }
 250
 251
 252         /* SET */
 253
 254         void set_directory (boost::filesystem::path);
 255         void set_name (std::string);
 256         void set_use_isdcf_name (bool);
 257         void examine_content (boost::shared_ptr<Content>);
 258         void examine_and_add_content (boost::shared_ptr<Content>);
 259         void add_content (boost::shared_ptr<Content>);
 260         void remove_content (boost::shared_ptr<Content>);
 261         void remove_content (ContentList);
 262         void move_content_earlier (boost::shared_ptr<Content>);
 263         void move_content_later (boost::shared_ptr<Content>);
 264         void set_dcp_content_type (DCPContentType const *);
 265         void set_container (Ratio const *);
 266         void set_resolution (Resolution);
 267         void set_signed (bool);
 268         void set_encrypted (bool);
 269         void set_key (dcp::Key key);
 270         void set_j2k_bandwidth (int);
 271         void set_isdcf_metadata (ISDCFMetadata);
 272         void set_video_frame_rate (int);
 273         void set_audio_channels (int);
 274         void set_three_d (bool);
 275         void set_isdcf_date_today ();
 276         void set_sequence_video (bool);
 277         void set_interop (bool);
 278         void set_audio_processor (AudioProcessor const * processor);
 279
 280         /** Emitted when some property has of the Film has changed */
 281         mutable boost::signals2::signal<void (Property)> Changed;
 282
 283         /** Emitted when some property of our content has changed */
 284         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
 285
 286         /** Current version number of the state file */
 287         static int const current_state_version;
 288
 289 private:
 290
 291         friend struct ::isdcf_name_test;
 292
 293         void signal_changed (Property);
 294         std::string video_identifier () const;
 295         void playlist_changed ();
 296         void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
 297         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
 298
 299         /** Log to write to */
 300         boost::shared_ptr<Log> _log;
 301         boost::shared_ptr<Playlist> _playlist;
 302
 303         /** Complete path to directory containing the film metadata;
 304          *  must not be relative.
 305          */
 306         boost::filesystem::path _directory;
 307
 308         /** Name for DCP-o-matic */
 309         std::string _name;
 310         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 311         bool _use_isdcf_name;
 312         /** The type of content that this Film represents (feature, trailer etc.) */
 313         DCPContentType const * _dcp_content_type;
 314         /** The container to put this Film in (flat, scope, etc.) */
 315         Ratio const * _container;
 316         /** DCP resolution (2K or 4K) */
 317         Resolution _resolution;
 318         bool _signed;
 319         bool _encrypted;
 320         dcp::Key _key;
 321         /** bandwidth for J2K files in bits per second */
 322         int _j2k_bandwidth;
 323         /** ISDCF naming stuff */
 324         ISDCFMetadata _isdcf_metadata;
 325         /** Frames per second to run our DCP at */
 326         int _video_frame_rate;
 327         /** The date that we should use in a ISDCF name */
 328         boost::gregorian::date _isdcf_date;
 329         /** Number of audio channels requested for the DCP */
 330         int _audio_channels;
 331         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 332             This will be regardless of what content is on the playlist.
 333         */
 334         bool _three_d;
 335         bool _sequence_video;
 336         bool _interop;
 337         AudioProcessor const * _audio_processor;
 338
 339         int _state_version;
 340
 341         /** true if our state has changed since we last saved it */
 342         mutable bool _dirty;
 343
 344         boost::signals2::scoped_connection _playlist_changed_connection;
 345         boost::signals2::scoped_connection _playlist_content_changed_connection;
 346         std::list<boost::signals2::connection> _job_connections;
 347
 348         friend struct paths_test;
 349         friend struct film_metadata_test;
 350 };
 351
 352 #endif