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 Format;
  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         libdcp::Size cropped_size (libdcp::Size) const;
  92         std::string dci_name (bool if_created_now) const;
  93         std::string dcp_name (bool if_created_now = false) const;
  94
  95         /** @return true if our state has changed since we last saved it */
  96         bool dirty () const {
  97                 return _dirty;
  98         }
  99
 100         bool have_dcp () const;
 101
 102         boost::shared_ptr<Player> player () const;
 103         boost::shared_ptr<Playlist> playlist () const;
 104
 105         OutputAudioFrame dcp_audio_frame_rate () const;
 106
 107         OutputAudioFrame time_to_audio_frames (Time) const;
 108         OutputVideoFrame time_to_video_frames (Time) const;
 109         Time video_frames_to_time (OutputVideoFrame) const;
 110         Time audio_frames_to_time (OutputAudioFrame) const;
 111
 112         /* Proxies for some Playlist methods */
 113
 114         Playlist::ContentList content () const;
 115
 116         Time length () const;
 117         bool has_subtitles () const;
 118         OutputVideoFrame best_dcp_video_frame_rate () const;
 119
 120         void set_loop (int);
 121         int loop () const;
 122
 123         /** Identifiers for the parts of our state;
 124             used for signalling changes.
 125         */
 126         enum Property {
 127                 NONE,
 128                 NAME,
 129                 USE_DCI_NAME,
 130                 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
 131                 CONTENT,
 132                 LOOP,
 133                 DCP_CONTENT_TYPE,
 134                 FORMAT,
 135                 CROP,
 136                 FILTERS,
 137                 SCALER,
 138                 AB,
 139                 AUDIO_GAIN,
 140                 AUDIO_DELAY,
 141                 WITH_SUBTITLES,
 142                 SUBTITLE_OFFSET,
 143                 SUBTITLE_SCALE,
 144                 COLOUR_LUT,
 145                 J2K_BANDWIDTH,
 146                 DCI_METADATA,
 147                 DCP_VIDEO_FRAME_RATE,
 148         };
 149
 150
 151         /* GET */
 152
 153         std::string directory () const {
 154                 boost::mutex::scoped_lock lm (_directory_mutex);
 155                 return _directory;
 156         }
 157
 158         std::string name () const {
 159                 boost::mutex::scoped_lock lm (_state_mutex);
 160                 return _name;
 161         }
 162
 163         bool use_dci_name () const {
 164                 boost::mutex::scoped_lock lm (_state_mutex);
 165                 return _use_dci_name;
 166         }
 167
 168         DCPContentType const * dcp_content_type () const {
 169                 boost::mutex::scoped_lock lm (_state_mutex);
 170                 return _dcp_content_type;
 171         }
 172
 173         Format const * format () const {
 174                 boost::mutex::scoped_lock lm (_state_mutex);
 175                 return _format;
 176         }
 177
 178         Crop crop () const {
 179                 boost::mutex::scoped_lock lm (_state_mutex);
 180                 return _crop;
 181         }
 182
 183         std::vector<Filter const *> filters () const {
 184                 boost::mutex::scoped_lock lm (_state_mutex);
 185                 return _filters;
 186         }
 187
 188         Scaler const * scaler () const {
 189                 boost::mutex::scoped_lock lm (_state_mutex);
 190                 return _scaler;
 191         }
 192
 193         bool ab () const {
 194                 boost::mutex::scoped_lock lm (_state_mutex);
 195                 return _ab;
 196         }
 197
 198         float audio_gain () const {
 199                 boost::mutex::scoped_lock lm (_state_mutex);
 200                 return _audio_gain;
 201         }
 202
 203         int audio_delay () const {
 204                 boost::mutex::scoped_lock lm (_state_mutex);
 205                 return _audio_delay;
 206         }
 207
 208         bool with_subtitles () const {
 209                 boost::mutex::scoped_lock lm (_state_mutex);
 210                 return _with_subtitles;
 211         }
 212
 213         int subtitle_offset () const {
 214                 boost::mutex::scoped_lock lm (_state_mutex);
 215                 return _subtitle_offset;
 216         }
 217
 218         float subtitle_scale () const {
 219                 boost::mutex::scoped_lock lm (_state_mutex);
 220                 return _subtitle_scale;
 221         }
 222
 223         int colour_lut () const {
 224                 boost::mutex::scoped_lock lm (_state_mutex);
 225                 return _colour_lut;
 226         }
 227
 228         int j2k_bandwidth () const {
 229                 boost::mutex::scoped_lock lm (_state_mutex);
 230                 return _j2k_bandwidth;
 231         }
 232
 233         DCIMetadata dci_metadata () const {
 234                 boost::mutex::scoped_lock lm (_state_mutex);
 235                 return _dci_metadata;
 236         }
 237
 238         /* XXX: -> "video_frame_rate" */
 239         int dcp_video_frame_rate () const {
 240                 boost::mutex::scoped_lock lm (_state_mutex);
 241                 return _dcp_video_frame_rate;
 242         }
 243
 244         /* SET */
 245
 246         void set_directory (std::string);
 247         void set_name (std::string);
 248         void set_use_dci_name (bool);
 249         void add_content (boost::shared_ptr<Content>);
 250         void remove_content (boost::shared_ptr<Content>);
 251         void set_dcp_content_type (DCPContentType const *);
 252         void set_format (Format const *);
 253         void set_crop (Crop);
 254         void set_left_crop (int);
 255         void set_right_crop (int);
 256         void set_top_crop (int);
 257         void set_bottom_crop (int);
 258         void set_filters (std::vector<Filter const *>);
 259         void set_scaler (Scaler const *);
 260         void set_ab (bool);
 261         void set_audio_gain (float);
 262         void set_audio_delay (int);
 263         void set_with_subtitles (bool);
 264         void set_subtitle_offset (int);
 265         void set_subtitle_scale (float);
 266         void set_colour_lut (int);
 267         void set_j2k_bandwidth (int);
 268         void set_dci_metadata (DCIMetadata);
 269         void set_dcp_video_frame_rate (int);
 270         void set_dci_date_today ();
 271
 272         /** Emitted when some property has of the Film has changed */
 273         mutable boost::signals2::signal<void (Property)> Changed;
 274
 275         /** Emitted when some property of our content has changed */
 276         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 277
 278         boost::signals2::signal<void ()> AudioAnalysisSucceeded;
 279
 280         /** Current version number of the state file */
 281         static int const state_version;
 282
 283 private:
 284
 285         void signal_changed (Property);
 286         void analyse_audio_finished ();
 287         std::string video_state_identifier () const;
 288         void read_metadata ();
 289         void playlist_changed ();
 290         void playlist_content_changed (boost::weak_ptr<Content>, int);
 291         std::string filename_safe_name () const;
 292
 293         /** Log to write to */
 294         boost::shared_ptr<Log> _log;
 295         /** Any running AnalyseAudioJob, or 0 */
 296         boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
 297         boost::shared_ptr<Playlist> _playlist;
 298
 299         /** Complete path to directory containing the film metadata;
 300          *  must not be relative.
 301          */
 302         std::string _directory;
 303         /** Mutex for _directory */
 304         mutable boost::mutex _directory_mutex;
 305
 306         /** Name for DCP-o-matic */
 307         std::string _name;
 308         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 309         bool _use_dci_name;
 310         /** The type of content that this Film represents (feature, trailer etc.) */
 311         DCPContentType const * _dcp_content_type;
 312         /** The format to present this Film in (flat, scope, etc.) */
 313         Format const * _format;
 314         /** The crop to apply to the source */
 315         Crop _crop;
 316         /** Video filters that should be used when generating DCPs */
 317         std::vector<Filter const *> _filters;
 318         /** Scaler algorithm to use */
 319         Scaler const * _scaler;
 320         /** true to create an A/B comparison DCP, where the left half of the image
 321             is the video without any filters or post-processing, and the right half
 322             has the specified filters and post-processing.
 323         */
 324         bool _ab;
 325         /** Gain to apply to audio in dB */
 326         float _audio_gain;
 327         /** Delay to apply to audio (positive moves audio later) in milliseconds */
 328         int _audio_delay;
 329         /** True if subtitles should be shown for this film */
 330         bool _with_subtitles;
 331         /** y offset for placing subtitles, in source pixels; +ve is further down
 332             the frame, -ve is further up.
 333         */
 334         int _subtitle_offset;
 335         /** scale factor to apply to subtitles */
 336         float _subtitle_scale;
 337         /** index of colour LUT to use when converting RGB to XYZ.
 338          *  0: sRGB
 339          *  1: Rec 709
 340          */
 341         int _colour_lut;
 342         /** bandwidth for J2K files in bits per second */
 343         int _j2k_bandwidth;
 344         /** DCI naming stuff */
 345         DCIMetadata _dci_metadata;
 346         /** Frames per second to run our DCP at */
 347         int _dcp_video_frame_rate;
 348         /** The date that we should use in a DCI name */
 349         boost::gregorian::date _dci_date;
 350
 351         /** true if our state has changed since we last saved it */
 352         mutable bool _dirty;
 353
 354         /** Mutex for all state except _directory */
 355         mutable boost::mutex _state_mutex;
 356
 357         friend class paths_test;
 358         friend class film_metadata_test;
 359 };
 360
 361 #endif