src/lib/film.h

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