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 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 some audio and video content, and details of
  56  *  how they 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
  64         std::string info_dir () const;
  65         std::string j2c_path (int f, bool t) const;
  66         std::string info_path (int f) const;
  67         std::string video_mxf_dir () const;
  68         std::string video_mxf_filename () const;
  69         std::string audio_analysis_path () const;
  70
  71         void examine_content (boost::shared_ptr<Content>);
  72         void analyse_audio ();
  73         void send_dcp_to_tms ();
  74         void make_dcp ();
  75
  76         /** @return Logger.
  77          *  It is safe to call this from any thread.
  78          */
  79         boost::shared_ptr<Log> log () const {
  80                 return _log;
  81         }
  82
  83         int encoded_frames () const;
  84
  85         std::string file (std::string f) const;
  86         std::string dir (std::string d) const;
  87
  88         int target_audio_sample_rate () const;
  89
  90         void write_metadata () const;
  91
  92         libdcp::Size cropped_size (libdcp::Size) const;
  93         std::string dci_name (bool if_created_now) const;
  94         std::string dcp_name (bool if_created_now = false) const;
  95
  96         /** @return true if our state has changed since we last saved it */
  97         bool dirty () const {
  98                 return _dirty;
  99         }
 100
 101         bool have_dcp () const;
 102
 103         boost::shared_ptr<Player> player () const;
 104
 105         /* Proxies for some Playlist methods */
 106
 107         ContentAudioFrame audio_length () const;
 108         int audio_channels () const;
 109         int audio_frame_rate () const;
 110         int64_t audio_channel_layout () const;
 111         bool has_audio () const;
 112
 113         float video_frame_rate () const;
 114         libdcp::Size video_size () const;
 115         ContentVideoFrame video_length () const;
 116
 117         /** Identifiers for the parts of our state;
 118             used for signalling changes.
 119         */
 120         enum Property {
 121                 NONE,
 122                 NAME,
 123                 USE_DCI_NAME,
 124                 TRUST_CONTENT_HEADERS,
 125                 /** The content list has changed (i.e. content has been added, moved around or removed) */
 126                 CONTENT,
 127                 DCP_CONTENT_TYPE,
 128                 FORMAT,
 129                 CROP,
 130                 FILTERS,
 131                 SCALER,
 132                 TRIM_START,
 133                 TRIM_END,
 134                 AB,
 135                 AUDIO_GAIN,
 136                 AUDIO_DELAY,
 137                 STILL_DURATION,
 138                 SUBTITLE_STREAM,
 139                 WITH_SUBTITLES,
 140                 SUBTITLE_OFFSET,
 141                 SUBTITLE_SCALE,
 142                 COLOUR_LUT,
 143                 J2K_BANDWIDTH,
 144                 DCI_METADATA,
 145                 DCP_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         bool trust_content_headers () const {
 167                 boost::mutex::scoped_lock lm (_state_mutex);
 168                 return _trust_content_headers;
 169         }
 170
 171         ContentList content () const {
 172                 boost::mutex::scoped_lock lm (_state_mutex);
 173                 return _content;
 174         }
 175
 176         DCPContentType const * dcp_content_type () const {
 177                 boost::mutex::scoped_lock lm (_state_mutex);
 178                 return _dcp_content_type;
 179         }
 180
 181         Format const * format () const {
 182                 boost::mutex::scoped_lock lm (_state_mutex);
 183                 return _format;
 184         }
 185
 186         Crop crop () const {
 187                 boost::mutex::scoped_lock lm (_state_mutex);
 188                 return _crop;
 189         }
 190
 191         std::vector<Filter const *> filters () const {
 192                 boost::mutex::scoped_lock lm (_state_mutex);
 193                 return _filters;
 194         }
 195
 196         Scaler const * scaler () const {
 197                 boost::mutex::scoped_lock lm (_state_mutex);
 198                 return _scaler;
 199         }
 200
 201         int trim_start () const {
 202                 boost::mutex::scoped_lock lm (_state_mutex);
 203                 return _trim_start;
 204         }
 205
 206         int trim_end () const {
 207                 boost::mutex::scoped_lock lm (_state_mutex);
 208                 return _trim_end;
 209         }
 210
 211         bool ab () const {
 212                 boost::mutex::scoped_lock lm (_state_mutex);
 213                 return _ab;
 214         }
 215
 216         float audio_gain () const {
 217                 boost::mutex::scoped_lock lm (_state_mutex);
 218                 return _audio_gain;
 219         }
 220
 221         int audio_delay () const {
 222                 boost::mutex::scoped_lock lm (_state_mutex);
 223                 return _audio_delay;
 224         }
 225
 226         bool with_subtitles () const {
 227                 boost::mutex::scoped_lock lm (_state_mutex);
 228                 return _with_subtitles;
 229         }
 230
 231         int subtitle_offset () const {
 232                 boost::mutex::scoped_lock lm (_state_mutex);
 233                 return _subtitle_offset;
 234         }
 235
 236         float subtitle_scale () const {
 237                 boost::mutex::scoped_lock lm (_state_mutex);
 238                 return _subtitle_scale;
 239         }
 240
 241         int colour_lut () const {
 242                 boost::mutex::scoped_lock lm (_state_mutex);
 243                 return _colour_lut;
 244         }
 245
 246         int j2k_bandwidth () const {
 247                 boost::mutex::scoped_lock lm (_state_mutex);
 248                 return _j2k_bandwidth;
 249         }
 250
 251         DCIMetadata dci_metadata () const {
 252                 boost::mutex::scoped_lock lm (_state_mutex);
 253                 return _dci_metadata;
 254         }
 255
 256         int dcp_frame_rate () const {
 257                 boost::mutex::scoped_lock lm (_state_mutex);
 258                 return _dcp_frame_rate;
 259         }
 260
 261         /* SET */
 262
 263         void set_directory (std::string);
 264         void set_name (std::string);
 265         void set_use_dci_name (bool);
 266         void set_trust_content_headers (bool);
 267         void add_content (boost::shared_ptr<Content>);
 268         void remove_content (boost::shared_ptr<Content>);
 269         void move_content_earlier (boost::shared_ptr<Content>);
 270         void move_content_later (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_with_subtitles (bool);
 286         void set_subtitle_offset (int);
 287         void set_subtitle_scale (float);
 288         void set_colour_lut (int);
 289         void set_j2k_bandwidth (int);
 290         void set_dci_metadata (DCIMetadata);
 291         void set_dcp_frame_rate (int);
 292         void set_dci_date_today ();
 293
 294         /** Emitted when some property has of the Film has changed */
 295         mutable boost::signals2::signal<void (Property)> Changed;
 296
 297         /** Emitted when some property of our content has changed */
 298         mutable boost::signals2::signal<void (int)> ContentChanged;
 299
 300         boost::signals2::signal<void ()> AudioAnalysisSucceeded;
 301
 302         /** Current version number of the state file */
 303         static int const state_version;
 304
 305 private:
 306
 307         void signal_changed (Property);
 308         void analyse_audio_finished ();
 309         std::string video_state_identifier () const;
 310         void read_metadata ();
 311
 312         /** Log to write to */
 313         boost::shared_ptr<Log> _log;
 314         /** Any running AnalyseAudioJob, or 0 */
 315         boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
 316         boost::shared_ptr<Playlist> _playlist;
 317
 318         /** Complete path to directory containing the film metadata;
 319          *  must not be relative.
 320          */
 321         std::string _directory;
 322         /** Mutex for _directory */
 323         mutable boost::mutex _directory_mutex;
 324
 325         /** Name for DVD-o-matic */
 326         std::string _name;
 327         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 328         bool _use_dci_name;
 329         bool _trust_content_headers;
 330         ContentList _content;
 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         /** DCI naming stuff */
 370         DCIMetadata _dci_metadata;
 371         /** Frames per second to run our DCP at */
 372         int _dcp_frame_rate;
 373         /** The date that we should use in a DCI name */
 374         boost::gregorian::date _dci_date;
 375
 376         /** true if our state has changed since we last saved it */
 377         mutable bool _dirty;
 378
 379         /** Mutex for all state except _directory */
 380         mutable boost::mutex _state_mutex;
 381
 382         friend class paths_test;
 383         friend class film_metadata_test;
 384 };
 385
 386 #endif