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 "util.h"
  29 #include "types.h"
  30 #include "isdcf_metadata.h"
  31 #include "frame_rate_change.h"
  32 #include "ratio.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 class DCPContentType;
  43 class Log;
  44 class Content;
  45 class Player;
  46 class Playlist;
  47 class AudioContent;
  48 class Scaler;
  49 class Screen;
  50 struct 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                 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         std::string subtitle_language () const;
 148
 149         /** Identifiers for the parts of our state;
 150             used for signalling changes.
 151         */
 152         enum Property {
 153                 NONE,
 154                 NAME,
 155                 USE_ISDCF_NAME,
 156                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 157                 CONTENT,
 158                 DCP_CONTENT_TYPE,
 159                 CONTAINER,
 160                 RESOLUTION,
 161                 SCALER,
 162                 SIGNED,
 163                 ENCRYPTED,
 164                 J2K_BANDWIDTH,
 165                 ISDCF_METADATA,
 166                 VIDEO_FRAME_RATE,
 167                 AUDIO_CHANNELS,
 168                 /** The setting of _three_d has changed */
 169                 THREE_D,
 170                 SEQUENCE_VIDEO,
 171                 INTEROP,
 172                 /** The setting of _burn_subtitles has changed */
 173                 BURN_SUBTITLES,
 174         };
 175
 176
 177         /* GET */
 178
 179         boost::filesystem::path directory () const {
 180                 return _directory;
 181         }
 182
 183         std::string name () const {
 184                 return _name;
 185         }
 186
 187         bool use_isdcf_name () const {
 188                 return _use_isdcf_name;
 189         }
 190
 191         DCPContentType const * dcp_content_type () const {
 192                 return _dcp_content_type;
 193         }
 194
 195         Ratio const * container () const {
 196                 return _container;
 197         }
 198
 199         Resolution resolution () const {
 200                 return _resolution;
 201         }
 202
 203         Scaler const * scaler () const {
 204                 return _scaler;
 205         }
 206
 207         /* signed is a reserved word */
 208         bool is_signed () const {
 209                 return _signed;
 210         }
 211
 212         bool encrypted () const {
 213                 return _encrypted;
 214         }
 215
 216         int j2k_bandwidth () const {
 217                 return _j2k_bandwidth;
 218         }
 219
 220         ISDCFMetadata isdcf_metadata () const {
 221                 return _isdcf_metadata;
 222         }
 223
 224         /** @return The frame rate of the DCP */
 225         int video_frame_rate () const {
 226                 return _video_frame_rate;
 227         }
 228
 229         int audio_channels () const {
 230                 return _audio_channels;
 231         }
 232
 233         bool three_d () const {
 234                 return _three_d;
 235         }
 236
 237         bool sequence_video () const {
 238                 return _sequence_video;
 239         }
 240
 241         bool interop () const {
 242                 return _interop;
 243         }
 244
 245         bool burn_subtitles () const {
 246                 return _burn_subtitles;
 247         }
 248
 249
 250         /* SET */
 251
 252         void set_directory (boost::filesystem::path);
 253         void set_name (std::string);
 254         void set_use_isdcf_name (bool);
 255         void examine_content (boost::shared_ptr<Content>, bool calculate_digest);
 256         void examine_and_add_content (boost::shared_ptr<Content>, bool calculate_digest);
 257         void add_content (boost::shared_ptr<Content>);
 258         void remove_content (boost::shared_ptr<Content>);
 259         void move_content_earlier (boost::shared_ptr<Content>);
 260         void move_content_later (boost::shared_ptr<Content>);
 261         void set_dcp_content_type (DCPContentType const *);
 262         void set_container (Ratio const *);
 263         void set_resolution (Resolution);
 264         void set_scaler (Scaler const *);
 265         void set_signed (bool);
 266         void set_encrypted (bool);
 267         void set_j2k_bandwidth (int);
 268         void set_isdcf_metadata (ISDCFMetadata);
 269         void set_video_frame_rate (int);
 270         void set_audio_channels (int);
 271         void set_three_d (bool);
 272         void set_isdcf_date_today ();
 273         void set_sequence_video (bool);
 274         void set_interop (bool);
 275         void set_burn_subtitles (bool);
 276
 277         /** Emitted when some property has of the Film has changed */
 278         mutable boost::signals2::signal<void (Property)> Changed;
 279
 280         /** Emitted when some property of our content has changed */
 281         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 282
 283         /** Current version number of the state file */
 284         static int const current_state_version;
 285
 286 private:
 287
 288         friend struct ::isdcf_name_test;
 289
 290         void signal_changed (Property);
 291         std::string video_identifier () const;
 292         void playlist_changed ();
 293         void playlist_content_changed (boost::weak_ptr<Content>, int);
 294         std::string filename_safe_name () const;
 295         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
 296
 297         /** Log to write to */
 298         boost::shared_ptr<Log> _log;
 299         boost::shared_ptr<Playlist> _playlist;
 300
 301         /** Complete path to directory containing the film metadata;
 302          *  must not be relative.
 303          */
 304         boost::filesystem::path _directory;
 305
 306         /** Name for DCP-o-matic */
 307         std::string _name;
 308         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 309         bool _use_isdcf_name;
 310         /** The type of content that this Film represents (feature, trailer etc.) */
 311         DCPContentType const * _dcp_content_type;
 312         /** The container to put this Film in (flat, scope, etc.) */
 313         Ratio const * _container;
 314         /** DCP resolution (2K or 4K) */
 315         Resolution _resolution;
 316         /** Scaler algorithm to use */
 317         Scaler const * _scaler;
 318         bool _signed;
 319         bool _encrypted;
 320         /** bandwidth for J2K files in bits per second */
 321         int _j2k_bandwidth;
 322         /** ISDCF naming stuff */
 323         ISDCFMetadata _isdcf_metadata;
 324         /** Frames per second to run our DCP at */
 325         int _video_frame_rate;
 326         /** The date that we should use in a ISDCF name */
 327         boost::gregorian::date _isdcf_date;
 328         /** Number of audio channels to put in the DCP */
 329         int _audio_channels;
 330         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 331             This will be regardless of what content is on the playlist.
 332         */
 333         bool _three_d;
 334         bool _sequence_video;
 335         bool _interop;
 336         bool _burn_subtitles;
 337         dcp::Key _key;
 338
 339         int _state_version;
 340
 341         /** true if our state has changed since we last saved it */
 342         mutable bool _dirty;
 343
 344         friend struct paths_test;
 345         friend struct film_metadata_test;
 346 };
 347
 348 #endif