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