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