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