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