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 a piece of video (with sound), including naming,
  22  *  the source content file, and how it should be presented in a DCP.
  23  */
  24
  25 #ifndef DVDOMATIC_FILM_H
  26 #define DVDOMATIC_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 extern "C" {
  36 #include <libavcodec/avcodec.h>
  37 }
  38 #include "dcp_content_type.h"
  39 #include "util.h"
  40 #include "stream.h"
  41 #include "dci_metadata.h"
  42
  43 class Format;
  44 class Job;
  45 class Filter;
  46 class Log;
  47 class ExamineContentJob;
  48 class AnalyseAudioJob;
  49 class ExternalAudioStream;
  50 class Content;
  51
  52 /** @class Film
  53  *  @brief A representation of a video, maybe with sound.
  54  *
  55  *  A representation of a piece of video (maybe with sound), including naming,
  56  *  the source content file, and how it should be presented in a DCP.
  57  */
  58 class Film : public boost::enable_shared_from_this<Film>
  59 {
  60 public:
  61         Film (std::string d, bool must_exist = true);
  62         Film (Film const &);
  63         ~Film ();
  64
  65         std::string info_dir () const;
  66         std::string j2c_path (int f, bool t) const;
  67         std::string info_path (int f) const;
  68         std::string video_mxf_dir () const;
  69         std::string video_mxf_filename () const;
  70         std::string audio_analysis_path () const;
  71
  72         void examine_content ();
  73         void analyse_audio ();
  74         void send_dcp_to_tms ();
  75
  76         void make_dcp ();
  77
  78         /** @return Logger.
  79          *  It is safe to call this from any thread.
  80          */
  81         boost::shared_ptr<Log> log () const {
  82                 return _log;
  83         }
  84
  85         int encoded_frames () const;
  86
  87         std::string file (std::string f) const;
  88         std::string dir (std::string d) const;
  89
  90         std::string content_path () const;
  91         ContentType content_type () const;
  92
  93         int target_audio_sample_rate () const;
  94
  95         void write_metadata () const;
  96         void read_metadata ();
  97
  98         libdcp::Size cropped_size (libdcp::Size) const;
  99         std::string dci_name (bool if_created_now) const;
 100         std::string dcp_name (bool if_created_now = false) const;
 101
 102         /** @return true if our state has changed since we last saved it */
 103         bool dirty () const {
 104                 return _dirty;
 105         }
 106
 107         int audio_channels () const;
 108
 109         void set_dci_date_today ();
 110
 111         bool have_dcp () const;
 112
 113         /** Identifiers for the parts of our state;
 114             used for signalling changes.
 115         */
 116         enum Property {
 117                 NONE,
 118                 NAME,
 119                 USE_DCI_NAME,
 120                 TRUST_CONTENT_HEADER,
 121                 DCP_CONTENT_TYPE,
 122                 FORMAT,
 123                 CROP,
 124                 FILTERS,
 125                 SCALER,
 126                 TRIM_START,
 127                 TRIM_END,
 128                 DCP_AB,
 129                 AUDIO_GAIN,
 130                 AUDIO_DELAY,
 131                 STILL_DURATION,
 132                 SUBTITLE_STREAM,
 133                 WITH_SUBTITLES,
 134                 SUBTITLE_OFFSET,
 135                 SUBTITLE_SCALE,
 136                 COLOUR_LUT,
 137                 J2K_BANDWIDTH,
 138                 DCI_METADATA,
 139                 DCP_FRAME_RATE
 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         bool trust_content_header () const {
 161                 boost::mutex::scoped_lock lm (_state_mutex);
 162                 return _trust_content_header;
 163         }
 164
 165         DCPContentType const * dcp_content_type () const {
 166                 boost::mutex::scoped_lock lm (_state_mutex);
 167                 return _dcp_content_type;
 168         }
 169
 170         Format const * format () const {
 171                 boost::mutex::scoped_lock lm (_state_mutex);
 172                 return _format;
 173         }
 174
 175         Crop crop () const {
 176                 boost::mutex::scoped_lock lm (_state_mutex);
 177                 return _crop;
 178         }
 179
 180         std::vector<Filter const *> filters () const {
 181                 boost::mutex::scoped_lock lm (_state_mutex);
 182                 return _filters;
 183         }
 184
 185         Scaler const * scaler () const {
 186                 boost::mutex::scoped_lock lm (_state_mutex);
 187                 return _scaler;
 188         }
 189
 190         int trim_start () const {
 191                 boost::mutex::scoped_lock lm (_state_mutex);
 192                 return _trim_start;
 193         }
 194
 195         int trim_end () const {
 196                 boost::mutex::scoped_lock lm (_state_mutex);
 197                 return _trim_end;
 198         }
 199
 200         bool dcp_ab () const {
 201                 boost::mutex::scoped_lock lm (_state_mutex);
 202                 return _dcp_ab;
 203         }
 204
 205         float audio_gain () const {
 206                 boost::mutex::scoped_lock lm (_state_mutex);
 207                 return _audio_gain;
 208         }
 209
 210         int audio_delay () const {
 211                 boost::mutex::scoped_lock lm (_state_mutex);
 212                 return _audio_delay;
 213         }
 214
 215         boost::shared_ptr<SubtitleStream> subtitle_stream () const {
 216                 boost::mutex::scoped_lock lm (_state_mutex);
 217                 return _subtitle_stream;
 218         }
 219
 220         bool with_subtitles () const {
 221                 boost::mutex::scoped_lock lm (_state_mutex);
 222                 return _with_subtitles;
 223         }
 224
 225         int subtitle_offset () const {
 226                 boost::mutex::scoped_lock lm (_state_mutex);
 227                 return _subtitle_offset;
 228         }
 229
 230         float subtitle_scale () const {
 231                 boost::mutex::scoped_lock lm (_state_mutex);
 232                 return _subtitle_scale;
 233         }
 234
 235         int colour_lut () const {
 236                 boost::mutex::scoped_lock lm (_state_mutex);
 237                 return _colour_lut;
 238         }
 239
 240         int j2k_bandwidth () const {
 241                 boost::mutex::scoped_lock lm (_state_mutex);
 242                 return _j2k_bandwidth;
 243         }
 244
 245         DCIMetadata dci_metadata () const {
 246                 boost::mutex::scoped_lock lm (_state_mutex);
 247                 return _dci_metadata;
 248         }
 249
 250         int dcp_frame_rate () const {
 251                 boost::mutex::scoped_lock lm (_state_mutex);
 252                 return _dcp_frame_rate;
 253         }
 254
 255         boost::shared_ptr<AudioStream> audio_stream () const;
 256         bool has_audio () const;
 257
 258         /* SET */
 259
 260         void set_directory (std::string);
 261         void set_name (std::string);
 262         void set_use_dci_name (bool);
 263         void set_trust_content_header (bool);
 264         void set_dcp_content_type (DCPContentType const *);
 265         void set_format (Format const *);
 266         void set_crop (Crop);
 267         void set_left_crop (int);
 268         void set_right_crop (int);
 269         void set_top_crop (int);
 270         void set_bottom_crop (int);
 271         void set_filters (std::vector<Filter const *>);
 272         void set_scaler (Scaler const *);
 273         void set_trim_start (int);
 274         void set_trim_end (int);
 275         void set_dcp_ab (bool);
 276         void set_audio_gain (float);
 277         void set_audio_delay (int);
 278         void set_still_duration (int);
 279         void set_with_subtitles (bool);
 280         void set_subtitle_offset (int);
 281         void set_subtitle_scale (float);
 282         void set_colour_lut (int);
 283         void set_j2k_bandwidth (int);
 284         void set_dci_metadata (DCIMetadata);
 285         void set_dcp_frame_rate (int);
 286
 287         /** Emitted when some property has changed */
 288         mutable boost::signals2::signal<void (Property)> Changed;
 289
 290         boost::signals2::signal<void ()> AudioAnalysisSucceeded;
 291
 292         /** Current version number of the state file */
 293         static int const state_version;
 294
 295 private:
 296
 297         /** Log to write to */
 298         boost::shared_ptr<Log> _log;
 299
 300         /** Any running ExamineContentJob, or 0 */
 301         boost::shared_ptr<ExamineContentJob> _examine_content_job;
 302         /** Any running AnalyseAudioJob, or 0 */
 303         boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
 304
 305         void signal_changed (Property);
 306         void examine_content_finished ();
 307         void analyse_audio_finished ();
 308         std::string video_state_identifier () const;
 309
 310         /** Complete path to directory containing the film metadata;
 311          *  must not be relative.
 312          */
 313         std::string _directory;
 314         /** Mutex for _directory */
 315         mutable boost::mutex _directory_mutex;
 316
 317         /** Name for DVD-o-matic */
 318         std::string _name;
 319         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 320         bool _use_dci_name;
 321         std::list<boost::shared_ptr<Content> > _content;
 322         /** If this is true, we will believe the length specified by the content
 323          *  file's header; if false, we will run through the whole content file
 324          *  the first time we see it in order to obtain the length.
 325          */
 326         bool _trust_content_header;
 327         /** The type of content that this Film represents (feature, trailer etc.) */
 328         DCPContentType const * _dcp_content_type;
 329         /** The format to present this Film in (flat, scope, etc.) */
 330         Format const * _format;
 331         /** The crop to apply to the source */
 332         Crop _crop;
 333         /** Video filters that should be used when generating DCPs */
 334         std::vector<Filter const *> _filters;
 335         /** Scaler algorithm to use */
 336         Scaler const * _scaler;
 337         /** Frames to trim off the start of the DCP */
 338         int _trim_start;
 339         /** Frames to trim off the end of the DCP */
 340         int _trim_end;
 341         /** true to create an A/B comparison DCP, where the left half of the image
 342             is the video without any filters or post-processing, and the right half
 343             has the specified filters and post-processing.
 344         */
 345         bool _dcp_ab;
 346         /** Gain to apply to audio in dB */
 347         float _audio_gain;
 348         /** Delay to apply to audio (positive moves audio later) in milliseconds */
 349         int _audio_delay;
 350         /** True if subtitles should be shown for this film */
 351         bool _with_subtitles;
 352         /** y offset for placing subtitles, in source pixels; +ve is further down
 353             the frame, -ve is further up.
 354         */
 355         int _subtitle_offset;
 356         /** scale factor to apply to subtitles */
 357         float _subtitle_scale;
 358         /** index of colour LUT to use when converting RGB to XYZ.
 359          *  0: sRGB
 360          *  1: Rec 709
 361          */
 362         int _colour_lut;
 363         /** bandwidth for J2K files in bits per second */
 364         int _j2k_bandwidth;
 365
 366         /** DCI naming stuff */
 367         DCIMetadata _dci_metadata;
 368         /** The date that we should use in a DCI name */
 369         boost::gregorian::date _dci_date;
 370         /** Frames per second to run our DCP at */
 371         int _dcp_frame_rate;
 372
 373         /** true if our state has changed since we last saved it */
 374         mutable bool _dirty;
 375
 376         /** Mutex for all state except _directory */
 377         mutable boost::mutex _state_mutex;
 378
 379         friend class paths_test;
 380         friend class film_metadata_test;
 381 };
 382
 383 #endif