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