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