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 <libdcp/key.h>
  35 #include <libdcp/kdm.h>
  36 #include "util.h"
  37 #include "types.h"
  38 #include "isdcf_metadata.h"
  39 #include "frame_rate_change.h"
  40
  41 class DCPContentType;
  42 class Log;
  43 class Content;
  44 class Player;
  45 class Playlist;
  46 class AudioContent;
  47 class Scaler;
  48 class Screen;
  49 class isdcf_name_test;
  50
  51 /** @class Film
  52  *
  53  *  @brief A representation of some audio and video content, and details of
  54  *  how they should be presented in a DCP.
  55  *
  56  *  The content of a Film is held in a Playlist (created and managed by the Film).
  57  */
  58 class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
  59 {
  60 public:
  61         Film (boost::filesystem::path, bool log = true);
  62
  63         boost::filesystem::path info_dir () const;
  64         boost::filesystem::path j2c_path (int, Eyes, bool) const;
  65         boost::filesystem::path info_path (int, Eyes) const;
  66         boost::filesystem::path internal_video_mxf_dir () const;
  67         boost::filesystem::path internal_video_mxf_filename () const;
  68         boost::filesystem::path audio_analysis_dir () const;
  69
  70         boost::filesystem::path video_mxf_filename () const;
  71         boost::filesystem::path audio_mxf_filename () const;
  72
  73         void send_dcp_to_tms ();
  74         void make_dcp ();
  75
  76         /** @return Logger.
  77          *  It is safe to call this from any thread.
  78          */
  79         boost::shared_ptr<Log> log () const {
  80                 return _log;
  81         }
  82
  83         int encoded_frames () const;
  84
  85         boost::filesystem::path file (boost::filesystem::path f) const;
  86         boost::filesystem::path dir (boost::filesystem::path d) const;
  87
  88         std::list<std::string> read_metadata ();
  89         void write_metadata () const;
  90         boost::shared_ptr<xmlpp::Document> metadata () const;
  91
  92         std::string isdcf_name (bool if_created_now) const;
  93         std::string dcp_name (bool if_created_now = false) const;
  94
  95         /** @return true if our state has changed since we last saved it */
  96         bool dirty () const {
  97                 return _dirty;
  98         }
  99
 100         libdcp::Size full_frame () const;
 101         libdcp::Size frame_size () const;
 102
 103         std::vector<CPLSummary> cpls () const;
 104
 105         boost::shared_ptr<Player> make_player () const;
 106         boost::shared_ptr<Playlist> playlist () const;
 107
 108         OutputAudioFrame audio_frame_rate () const;
 109
 110         OutputAudioFrame time_to_audio_frames (Time) const;
 111         OutputVideoFrame time_to_video_frames (Time) const;
 112         Time video_frames_to_time (OutputVideoFrame) const;
 113         Time audio_frames_to_time (OutputAudioFrame) const;
 114
 115         uint64_t required_disk_space () const;
 116         bool should_be_enough_disk_space (double &, double &) const;
 117
 118         /* Proxies for some Playlist methods */
 119
 120         ContentList content () const;
 121         Time length () const;
 122         bool has_subtitles () const;
 123         OutputVideoFrame best_video_frame_rate () const;
 124         FrameRateChange active_frame_rate_change (Time) const;
 125
 126         libdcp::KDM
 127         make_kdm (
 128                 boost::shared_ptr<libdcp::Certificate> target,
 129                 boost::filesystem::path cpl_file,
 130                 boost::posix_time::ptime from,
 131                 boost::posix_time::ptime until
 132                 ) const;
 133
 134         std::list<libdcp::KDM> make_kdms (
 135                 std::list<boost::shared_ptr<Screen> >,
 136                 boost::filesystem::path cpl_file,
 137                 boost::posix_time::ptime from,
 138                 boost::posix_time::ptime until
 139                 ) const;
 140
 141         libdcp::Key key () const {
 142                 return _key;
 143         }
 144
 145         int state_version () const {
 146                 return _state_version;
 147         }
 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, moved around or removed) */
 157                 CONTENT,
 158                 DCP_CONTENT_TYPE,
 159                 CONTAINER,
 160                 RESOLUTION,
 161                 SCALER,
 162                 WITH_SUBTITLES,
 163                 SIGNED,
 164                 ENCRYPTED,
 165                 J2K_BANDWIDTH,
 166                 ISDCF_METADATA,
 167                 VIDEO_FRAME_RATE,
 168                 AUDIO_CHANNELS,
 169                 /** The setting of _three_d has been changed */
 170                 THREE_D,
 171                 SEQUENCE_VIDEO,
 172                 INTEROP,
 173         };
 174
 175
 176         /* GET */
 177
 178         boost::filesystem::path directory () const {
 179                 return _directory;
 180         }
 181
 182         std::string name () const {
 183                 return _name;
 184         }
 185
 186         bool use_isdcf_name () const {
 187                 return _use_isdcf_name;
 188         }
 189
 190         DCPContentType const * dcp_content_type () const {
 191                 return _dcp_content_type;
 192         }
 193
 194         Ratio const * container () const {
 195                 return _container;
 196         }
 197
 198         Resolution resolution () const {
 199                 return _resolution;
 200         }
 201
 202         Scaler const * scaler () const {
 203                 return _scaler;
 204         }
 205
 206         bool with_subtitles () const {
 207                 return _with_subtitles;
 208         }
 209
 210         /* signed is a reserved word */
 211         bool is_signed () const {
 212                 return _signed;
 213         }
 214
 215         bool encrypted () const {
 216                 return _encrypted;
 217         }
 218
 219         int j2k_bandwidth () const {
 220                 return _j2k_bandwidth;
 221         }
 222
 223         ISDCFMetadata isdcf_metadata () const {
 224                 return _isdcf_metadata;
 225         }
 226
 227         /** @return The frame rate of the DCP */
 228         int video_frame_rate () const {
 229                 return _video_frame_rate;
 230         }
 231
 232         int audio_channels () const {
 233                 return _audio_channels;
 234         }
 235
 236         bool three_d () const {
 237                 return _three_d;
 238         }
 239
 240         bool sequence_video () const {
 241                 return _sequence_video;
 242         }
 243
 244         bool interop () const {
 245                 return _interop;
 246         }
 247
 248
 249         /* SET */
 250
 251         void set_directory (boost::filesystem::path);
 252         void set_name (std::string);
 253         void set_use_isdcf_name (bool);
 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_with_subtitles (bool);
 264         void set_signed (bool);
 265         void set_encrypted (bool);
 266         void set_j2k_bandwidth (int);
 267         void set_isdcf_metadata (ISDCFMetadata);
 268         void set_video_frame_rate (int);
 269         void set_audio_channels (int);
 270         void set_three_d (bool);
 271         void set_isdcf_date_today ();
 272         void set_sequence_video (bool);
 273         void set_interop (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         /** True if subtitles should be shown for this film */
 317         bool _with_subtitles;
 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         libdcp::Key _key;
 337
 338         int _state_version;
 339
 340         /** true if our state has changed since we last saved it */
 341         mutable bool _dirty;
 342
 343         friend class paths_test;
 344         friend class film_metadata_test;
 345 };
 346
 347 #endif