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 "dci_metadata.h"
  37 #include "types.h"
  38 #include "ffmpeg_content.h"
  39 #include "playlist.h"
  40
  41 class DCPContentType;
  42 class Container;
  43 class Job;
  44 class Filter;
  45 class Log;
  46 class ExamineContentJob;
  47 class AnalyseAudioJob;
  48 class ExternalAudioStream;
  49 class Content;
  50 class Player;
  51
  52 /** @class Film
  53  *  @brief A representation of some audio and video content, and details of
  54  *  how they should be presented in a DCP.
  55  */
  56 class Film : public boost::enable_shared_from_this<Film>
  57 {
  58 public:
  59         Film (std::string d, bool must_exist = true);
  60         Film (Film const &);
  61
  62         std::string info_dir () const;
  63         std::string j2c_path (int f, bool t) const;
  64         std::string info_path (int f) const;
  65         std::string internal_video_mxf_dir () const;
  66         std::string internal_video_mxf_filename () const;
  67         std::string audio_analysis_path () const;
  68
  69         void examine_content (boost::shared_ptr<Content>);
  70         std::string dcp_video_mxf_filename () const;
  71         std::string dcp_audio_mxf_filename () const;
  72
  73         void analyse_audio ();
  74         void send_dcp_to_tms ();
  75         void make_dcp ();
  76
  77         /** @return Logger.
  78          *  It is safe to call this from any thread.
  79          */
  80         boost::shared_ptr<Log> log () const {
  81                 return _log;
  82         }
  83
  84         int encoded_frames () const;
  85
  86         std::string file (std::string f) const;
  87         std::string dir (std::string d) const;
  88
  89         void write_metadata () const;
  90
  91         std::string dci_name (bool if_created_now) const;
  92         std::string dcp_name (bool if_created_now = false) const;
  93
  94         /** @return true if our state has changed since we last saved it */
  95         bool dirty () const {
  96                 return _dirty;
  97         }
  98
  99         bool have_dcp () const;
 100
 101         boost::shared_ptr<Player> player () const;
 102         boost::shared_ptr<Playlist> playlist () const;
 103
 104         OutputAudioFrame dcp_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         Playlist::ContentList content () const;
 114
 115         Time length () const;
 116         bool has_subtitles () const;
 117         OutputVideoFrame best_dcp_video_frame_rate () const;
 118
 119         void set_loop (int);
 120         int loop () const;
 121
 122         /** Identifiers for the parts of our state;
 123             used for signalling changes.
 124         */
 125         enum Property {
 126                 NONE,
 127                 NAME,
 128                 USE_DCI_NAME,
 129                 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
 130                 CONTENT,
 131                 LOOP,
 132                 DCP_CONTENT_TYPE,
 133                 CONTAINER,
 134                 FILTERS,
 135                 SCALER,
 136                 AB,
 137                 AUDIO_GAIN,
 138                 AUDIO_DELAY,
 139                 WITH_SUBTITLES,
 140                 SUBTITLE_OFFSET,
 141                 SUBTITLE_SCALE,
 142                 COLOUR_LUT,
 143                 J2K_BANDWIDTH,
 144                 DCI_METADATA,
 145                 DCP_VIDEO_FRAME_RATE,
 146         };
 147
 148
 149         /* GET */
 150
 151         std::string directory () const {
 152                 boost::mutex::scoped_lock lm (_directory_mutex);
 153                 return _directory;
 154         }
 155
 156         std::string name () const {
 157                 boost::mutex::scoped_lock lm (_state_mutex);
 158                 return _name;
 159         }
 160
 161         bool use_dci_name () const {
 162                 boost::mutex::scoped_lock lm (_state_mutex);
 163                 return _use_dci_name;
 164         }
 165
 166         DCPContentType const * dcp_content_type () const {
 167                 boost::mutex::scoped_lock lm (_state_mutex);
 168                 return _dcp_content_type;
 169         }
 170
 171         Container const * container () const {
 172                 boost::mutex::scoped_lock lm (_state_mutex);
 173                 return _container;
 174         }
 175
 176         std::vector<Filter const *> filters () const {
 177                 boost::mutex::scoped_lock lm (_state_mutex);
 178                 return _filters;
 179         }
 180
 181         Scaler const * scaler () const {
 182                 boost::mutex::scoped_lock lm (_state_mutex);
 183                 return _scaler;
 184         }
 185
 186         bool ab () const {
 187                 boost::mutex::scoped_lock lm (_state_mutex);
 188                 return _ab;
 189         }
 190
 191         float audio_gain () const {
 192                 boost::mutex::scoped_lock lm (_state_mutex);
 193                 return _audio_gain;
 194         }
 195
 196         int audio_delay () const {
 197                 boost::mutex::scoped_lock lm (_state_mutex);
 198                 return _audio_delay;
 199         }
 200
 201         bool with_subtitles () const {
 202                 boost::mutex::scoped_lock lm (_state_mutex);
 203                 return _with_subtitles;
 204         }
 205
 206         int subtitle_offset () const {
 207                 boost::mutex::scoped_lock lm (_state_mutex);
 208                 return _subtitle_offset;
 209         }
 210
 211         float subtitle_scale () const {
 212                 boost::mutex::scoped_lock lm (_state_mutex);
 213                 return _subtitle_scale;
 214         }
 215
 216         int colour_lut () const {
 217                 boost::mutex::scoped_lock lm (_state_mutex);
 218                 return _colour_lut;
 219         }
 220
 221         int j2k_bandwidth () const {
 222                 boost::mutex::scoped_lock lm (_state_mutex);
 223                 return _j2k_bandwidth;
 224         }
 225
 226         DCIMetadata dci_metadata () const {
 227                 boost::mutex::scoped_lock lm (_state_mutex);
 228                 return _dci_metadata;
 229         }
 230
 231         /* XXX: -> "video_frame_rate" */
 232         int dcp_video_frame_rate () const {
 233                 boost::mutex::scoped_lock lm (_state_mutex);
 234                 return _dcp_video_frame_rate;
 235         }
 236
 237         /* SET */
 238
 239         void set_directory (std::string);
 240         void set_name (std::string);
 241         void set_use_dci_name (bool);
 242         void add_content (boost::shared_ptr<Content>);
 243         void remove_content (boost::shared_ptr<Content>);
 244         void set_dcp_content_type (DCPContentType const *);
 245         void set_container (Container const *);
 246         void set_filters (std::vector<Filter const *>);
 247         void set_scaler (Scaler const *);
 248         void set_ab (bool);
 249         void set_audio_gain (float);
 250         void set_audio_delay (int);
 251         void set_with_subtitles (bool);
 252         void set_subtitle_offset (int);
 253         void set_subtitle_scale (float);
 254         void set_colour_lut (int);
 255         void set_j2k_bandwidth (int);
 256         void set_dci_metadata (DCIMetadata);
 257         void set_dcp_video_frame_rate (int);
 258         void set_dci_date_today ();
 259
 260         /** Emitted when some property has of the Film has changed */
 261         mutable boost::signals2::signal<void (Property)> Changed;
 262
 263         /** Emitted when some property of our content has changed */
 264         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 265
 266         boost::signals2::signal<void ()> AudioAnalysisSucceeded;
 267
 268         /** Current version number of the state file */
 269         static int const state_version;
 270
 271 private:
 272
 273         void signal_changed (Property);
 274         void analyse_audio_finished ();
 275         std::string video_state_identifier () const;
 276         void read_metadata ();
 277         void playlist_changed ();
 278         void playlist_content_changed (boost::weak_ptr<Content>, int);
 279         std::string filename_safe_name () const;
 280
 281         /** Log to write to */
 282         boost::shared_ptr<Log> _log;
 283         /** Any running AnalyseAudioJob, or 0 */
 284         boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
 285         boost::shared_ptr<Playlist> _playlist;
 286
 287         /** Complete path to directory containing the film metadata;
 288          *  must not be relative.
 289          */
 290         std::string _directory;
 291         /** Mutex for _directory */
 292         mutable boost::mutex _directory_mutex;
 293
 294         /** Name for DCP-o-matic */
 295         std::string _name;
 296         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 297         bool _use_dci_name;
 298         /** The type of content that this Film represents (feature, trailer etc.) */
 299         DCPContentType const * _dcp_content_type;
 300         /** The container to put this Film in (flat, scope, etc.) */
 301         Container const * _container;
 302         /** Video filters that should be used when generating DCPs */
 303         std::vector<Filter const *> _filters;
 304         /** Scaler algorithm to use */
 305         Scaler const * _scaler;
 306         /** true to create an A/B comparison DCP, where the left half of the image
 307             is the video without any filters or post-processing, and the right half
 308             has the specified filters and post-processing.
 309         */
 310         bool _ab;
 311         /** Gain to apply to audio in dB */
 312         float _audio_gain;
 313         /** Delay to apply to audio (positive moves audio later) in milliseconds */
 314         int _audio_delay;
 315         /** True if subtitles should be shown for this film */
 316         bool _with_subtitles;
 317         /** y offset for placing subtitles, in source pixels; +ve is further down
 318             the frame, -ve is further up.
 319         */
 320         int _subtitle_offset;
 321         /** scale factor to apply to subtitles */
 322         float _subtitle_scale;
 323         /** index of colour LUT to use when converting RGB to XYZ.
 324          *  0: sRGB
 325          *  1: Rec 709
 326          */
 327         int _colour_lut;
 328         /** bandwidth for J2K files in bits per second */
 329         int _j2k_bandwidth;
 330         /** DCI naming stuff */
 331         DCIMetadata _dci_metadata;
 332         /** Frames per second to run our DCP at */
 333         int _dcp_video_frame_rate;
 334         /** The date that we should use in a DCI name */
 335         boost::gregorian::date _dci_date;
 336
 337         /** true if our state has changed since we last saved it */
 338         mutable bool _dirty;
 339
 340         /** Mutex for all state except _directory */
 341         mutable boost::mutex _state_mutex;
 342
 343         friend class paths_test;
 344         friend class film_metadata_test;
 345 };
 346
 347 #endif