src/lib/film.h

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