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