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_without_loop () const;
 110
 111         Time length_with_loop () const;
 112         Time length_without_loop () 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                 RESOLUTION,
 134                 SCALER,
 135                 WITH_SUBTITLES,
 136                 J2K_BANDWIDTH,
 137                 DCI_METADATA,
 138                 DCP_VIDEO_FRAME_RATE,
 139                 DCP_AUDIO_CHANNELS
 140         };
 141
 142
 143         /* GET */
 144
 145         std::string directory () const {
 146                 boost::mutex::scoped_lock lm (_directory_mutex);
 147                 return _directory;
 148         }
 149
 150         std::string name () const {
 151                 boost::mutex::scoped_lock lm (_state_mutex);
 152                 return _name;
 153         }
 154
 155         bool use_dci_name () const {
 156                 boost::mutex::scoped_lock lm (_state_mutex);
 157                 return _use_dci_name;
 158         }
 159
 160         DCPContentType const * dcp_content_type () const {
 161                 boost::mutex::scoped_lock lm (_state_mutex);
 162                 return _dcp_content_type;
 163         }
 164
 165         Ratio const * container () const {
 166                 boost::mutex::scoped_lock lm (_state_mutex);
 167                 return _container;
 168         }
 169
 170         Resolution resolution () const {
 171                 boost::mutex::scoped_lock lm (_state_mutex);
 172                 return _resolution;
 173         }
 174
 175         Scaler const * scaler () const {
 176                 boost::mutex::scoped_lock lm (_state_mutex);
 177                 return _scaler;
 178         }
 179
 180         bool with_subtitles () const {
 181                 boost::mutex::scoped_lock lm (_state_mutex);
 182                 return _with_subtitles;
 183         }
 184
 185         int j2k_bandwidth () const {
 186                 boost::mutex::scoped_lock lm (_state_mutex);
 187                 return _j2k_bandwidth;
 188         }
 189
 190         DCIMetadata dci_metadata () const {
 191                 boost::mutex::scoped_lock lm (_state_mutex);
 192                 return _dci_metadata;
 193         }
 194
 195         /* XXX: -> "video_frame_rate" */
 196         int dcp_video_frame_rate () const {
 197                 boost::mutex::scoped_lock lm (_state_mutex);
 198                 return _dcp_video_frame_rate;
 199         }
 200
 201         int dcp_audio_channels () const {
 202                 boost::mutex::scoped_lock lm (_state_mutex);
 203                 return _dcp_audio_channels;
 204         }
 205
 206         /* SET */
 207
 208         void set_directory (std::string);
 209         void set_name (std::string);
 210         void set_use_dci_name (bool);
 211         void examine_and_add_content (boost::shared_ptr<Content>);
 212         void add_content (boost::shared_ptr<Content>);
 213         void remove_content (boost::shared_ptr<Content>);
 214         void set_dcp_content_type (DCPContentType const *);
 215         void set_container (Ratio const *);
 216         void set_resolution (Resolution);
 217         void set_scaler (Scaler const *);
 218         void set_with_subtitles (bool);
 219         void set_j2k_bandwidth (int);
 220         void set_dci_metadata (DCIMetadata);
 221         void set_dcp_video_frame_rate (int);
 222         void set_dcp_audio_channels (int);
 223         void set_dci_date_today ();
 224
 225         /** Emitted when some property has of the Film has changed */
 226         mutable boost::signals2::signal<void (Property)> Changed;
 227
 228         /** Emitted when some property of our content has changed */
 229         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 230
 231         /** Current version number of the state file */
 232         static int const state_version;
 233
 234 private:
 235
 236         void signal_changed (Property);
 237         std::string video_identifier () const;
 238         void playlist_changed ();
 239         void playlist_content_changed (boost::weak_ptr<Content>, int);
 240         std::string filename_safe_name () const;
 241         void add_content_weak (boost::weak_ptr<Content>);
 242
 243         /** Log to write to */
 244         boost::shared_ptr<Log> _log;
 245         boost::shared_ptr<Playlist> _playlist;
 246
 247         /** Complete path to directory containing the film metadata;
 248          *  must not be relative.
 249          */
 250         std::string _directory;
 251         /** Mutex for _directory */
 252         mutable boost::mutex _directory_mutex;
 253
 254         /** Name for DCP-o-matic */
 255         std::string _name;
 256         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 257         bool _use_dci_name;
 258         /** The type of content that this Film represents (feature, trailer etc.) */
 259         DCPContentType const * _dcp_content_type;
 260         /** The container to put this Film in (flat, scope, etc.) */
 261         Ratio const * _container;
 262         /** DCP resolution (2K or 4K) */
 263         Resolution _resolution;
 264         /** Scaler algorithm to use */
 265         Scaler const * _scaler;
 266         /** True if subtitles should be shown for this film */
 267         bool _with_subtitles;
 268         /** bandwidth for J2K files in bits per second */
 269         int _j2k_bandwidth;
 270         /** DCI naming stuff */
 271         DCIMetadata _dci_metadata;
 272         /** Frames per second to run our DCP at */
 273         int _dcp_video_frame_rate;
 274         /** The date that we should use in a DCI name */
 275         boost::gregorian::date _dci_date;
 276         int _dcp_audio_channels;
 277
 278         /** true if our state has changed since we last saved it */
 279         mutable bool _dirty;
 280
 281         /** Mutex for all state except _directory */
 282         mutable boost::mutex _state_mutex;
 283
 284         friend class paths_test;
 285         friend class film_metadata_test;
 286 };
 287
 288 #endif