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 "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);
  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
  89         std::string dci_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         libdcp::Size full_frame () const;
  98
  99         std::list<boost::filesystem::path> dcps () const;
 100
 101         boost::shared_ptr<Player> make_player () const;
 102         boost::shared_ptr<Playlist> playlist () const;
 103
 104         OutputAudioFrame audio_frame_rate () const;
 105
 106         OutputAudioFrame time_to_audio_frames (DCPTime) const;
 107         OutputVideoFrame time_to_video_frames (DCPTime) const;
 108         DCPTime video_frames_to_time (OutputVideoFrame) const;
 109         DCPTime audio_frames_to_time (OutputAudioFrame) const;
 110
 111         /* Proxies for some Playlist methods */
 112
 113         ContentList content () const;
 114         DCPTime length () const;
 115         bool has_subtitles () const;
 116         OutputVideoFrame best_video_frame_rate () const;
 117         FrameRateChange active_frame_rate_change (DCPTime) const;
 118
 119         libdcp::KDM
 120         make_kdm (
 121                 boost::shared_ptr<libdcp::Certificate> target,
 122                 boost::filesystem::path dcp,
 123                 boost::posix_time::ptime from,
 124                 boost::posix_time::ptime until
 125                 ) const;
 126
 127         std::list<libdcp::KDM> make_kdms (
 128                 std::list<boost::shared_ptr<Screen> >,
 129                 boost::filesystem::path dcp,
 130                 boost::posix_time::ptime from,
 131                 boost::posix_time::ptime until
 132                 ) const;
 133
 134         libdcp::Key key () const {
 135                 return _key;
 136         }
 137
 138         /** Identifiers for the parts of our state;
 139             used for signalling changes.
 140         */
 141         enum Property {
 142                 NONE,
 143                 NAME,
 144                 USE_DCI_NAME,
 145                 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
 146                 CONTENT,
 147                 DCP_CONTENT_TYPE,
 148                 CONTAINER,
 149                 RESOLUTION,
 150                 SCALER,
 151                 WITH_SUBTITLES,
 152                 SIGNED,
 153                 ENCRYPTED,
 154                 J2K_BANDWIDTH,
 155                 DCI_METADATA,
 156                 VIDEO_FRAME_RATE,
 157                 AUDIO_CHANNELS,
 158                 /** The setting of _three_d has been changed */
 159                 THREE_D,
 160                 SEQUENCE_VIDEO,
 161                 INTEROP,
 162         };
 163
 164
 165         /* GET */
 166
 167         boost::filesystem::path directory () const {
 168                 return _directory;
 169         }
 170
 171         std::string name () const {
 172                 return _name;
 173         }
 174
 175         bool use_dci_name () const {
 176                 return _use_dci_name;
 177         }
 178
 179         DCPContentType const * dcp_content_type () const {
 180                 return _dcp_content_type;
 181         }
 182
 183         Ratio const * container () const {
 184                 return _container;
 185         }
 186
 187         Resolution resolution () const {
 188                 return _resolution;
 189         }
 190
 191         Scaler const * scaler () const {
 192                 return _scaler;
 193         }
 194
 195         bool with_subtitles () const {
 196                 return _with_subtitles;
 197         }
 198
 199         /* signed is a reserved word */
 200         bool is_signed () const {
 201                 return _signed;
 202         }
 203
 204         bool encrypted () const {
 205                 return _encrypted;
 206         }
 207
 208         int j2k_bandwidth () const {
 209                 return _j2k_bandwidth;
 210         }
 211
 212         DCIMetadata dci_metadata () const {
 213                 return _dci_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
 238         /* SET */
 239
 240         void set_directory (boost::filesystem::path);
 241         void set_name (std::string);
 242         void set_use_dci_name (bool);
 243         void examine_and_add_content (boost::shared_ptr<Content>);
 244         void add_content (boost::shared_ptr<Content>);
 245         void remove_content (boost::shared_ptr<Content>);
 246         void move_content_earlier (boost::shared_ptr<Content>);
 247         void move_content_later (boost::shared_ptr<Content>);
 248         void set_dcp_content_type (DCPContentType const *);
 249         void set_container (Ratio const *);
 250         void set_resolution (Resolution);
 251         void set_scaler (Scaler const *);
 252         void set_with_subtitles (bool);
 253         void set_signed (bool);
 254         void set_encrypted (bool);
 255         void set_j2k_bandwidth (int);
 256         void set_dci_metadata (DCIMetadata);
 257         void set_video_frame_rate (int);
 258         void set_audio_channels (int);
 259         void set_three_d (bool);
 260         void set_dci_date_today ();
 261         void set_sequence_video (bool);
 262         void set_interop (bool);
 263
 264         /** Emitted when some property has of the Film has changed */
 265         mutable boost::signals2::signal<void (Property)> Changed;
 266
 267         /** Emitted when some property of our content has changed */
 268         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 269
 270         /** Current version number of the state file */
 271         static int const state_version;
 272
 273 private:
 274
 275         void signal_changed (Property);
 276         std::string video_identifier () const;
 277         void playlist_changed ();
 278         void playlist_content_changed (boost::weak_ptr<Content>, int);
 279         std::string filename_safe_name () const;
 280         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
 281
 282         /** Log to write to */
 283         boost::shared_ptr<Log> _log;
 284         boost::shared_ptr<Playlist> _playlist;
 285
 286         /** Complete path to directory containing the film metadata;
 287          *  must not be relative.
 288          */
 289         boost::filesystem::path _directory;
 290
 291         /** Name for DCP-o-matic */
 292         std::string _name;
 293         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 294         bool _use_dci_name;
 295         /** The type of content that this Film represents (feature, trailer etc.) */
 296         DCPContentType const * _dcp_content_type;
 297         /** The container to put this Film in (flat, scope, etc.) */
 298         Ratio const * _container;
 299         /** DCP resolution (2K or 4K) */
 300         Resolution _resolution;
 301         /** Scaler algorithm to use */
 302         Scaler const * _scaler;
 303         /** True if subtitles should be shown for this film */
 304         bool _with_subtitles;
 305         bool _signed;
 306         bool _encrypted;
 307         /** bandwidth for J2K files in bits per second */
 308         int _j2k_bandwidth;
 309         /** DCI naming stuff */
 310         DCIMetadata _dci_metadata;
 311         /** Frames per second to run our DCP at */
 312         int _video_frame_rate;
 313         /** The date that we should use in a DCI name */
 314         boost::gregorian::date _dci_date;
 315         /** Number of audio channels to put in the DCP */
 316         int _audio_channels;
 317         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 318             This will be regardless of what content is on the playlist.
 319         */
 320         bool _three_d;
 321         bool _sequence_video;
 322         bool _interop;
 323         libdcp::Key _key;
 324
 325         /** true if our state has changed since we last saved it */
 326         mutable bool _dirty;
 327
 328         friend class paths_test;
 329         friend class film_metadata_test;
 330 };
 331
 332 #endif