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