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