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