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