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 "playlist.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
  52 /** @class Film
  53  *  @brief A representation of some audio and video content, and details of
  54  *  how they should be presented in a DCP.
  55  */
  56 class Film : public boost::enable_shared_from_this<Film>
  57 {
  58 public:
  59         Film (std::string d, bool must_exist = true);
  60         Film (Film const &);
  61
  62         std::string info_dir () const;
  63         std::string j2c_path (int f, bool t) const;
  64         std::string info_path (int f) const;
  65         std::string internal_video_mxf_dir () const;
  66         std::string internal_video_mxf_filename () const;
  67         std::string audio_analysis_path () const;
  68
  69         void examine_content (boost::shared_ptr<Content>);
  70         std::string dcp_video_mxf_filename () const;
  71         std::string dcp_audio_mxf_filename () const;
  72
  73         void analyse_audio ();
  74         void send_dcp_to_tms ();
  75         void make_dcp ();
  76
  77         /** @return Logger.
  78          *  It is safe to call this from any thread.
  79          */
  80         boost::shared_ptr<Log> log () const {
  81                 return _log;
  82         }
  83
  84         int encoded_frames () const;
  85
  86         std::string file (std::string f) const;
  87         std::string dir (std::string d) 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         boost::shared_ptr<Playlist> playlist () const;
 104
 105         OutputAudioFrame dcp_audio_frame_rate () const;
 106
 107         OutputAudioFrame time_to_audio_frames (Time) const;
 108         OutputVideoFrame time_to_video_frames (Time) const;
 109         Time video_frames_to_time (OutputVideoFrame) const;
 110         Time audio_frames_to_time (OutputAudioFrame) const;
 111
 112         /* Proxies for some Playlist methods */
 113
 114         Playlist::RegionList regions () const;
 115
 116         Time length () const;
 117         bool has_subtitles () const;
 118         OutputVideoFrame best_dcp_video_frame_rate () const;
 119
 120         void set_loop (int);
 121         int loop () const;
 122
 123         enum TrimType {
 124                 CPL,
 125                 ENCODE
 126         };
 127
 128         /** Identifiers for the parts of our state;
 129             used for signalling changes.
 130         */
 131         enum Property {
 132                 NONE,
 133                 NAME,
 134                 USE_DCI_NAME,
 135                 TRUST_CONTENT_HEADERS,
 136                 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
 137                 CONTENT,
 138                 LOOP,
 139                 DCP_CONTENT_TYPE,
 140                 FORMAT,
 141                 CROP,
 142                 FILTERS,
 143                 SCALER,
 144                 TRIM_START,
 145                 TRIM_END,
 146                 AB,
 147                 TRIM_TYPE,
 148                 AUDIO_GAIN,
 149                 AUDIO_DELAY,
 150                 WITH_SUBTITLES,
 151                 SUBTITLE_OFFSET,
 152                 SUBTITLE_SCALE,
 153                 COLOUR_LUT,
 154                 J2K_BANDWIDTH,
 155                 DCI_METADATA,
 156                 DCP_VIDEO_FRAME_RATE,
 157         };
 158
 159
 160         /* GET */
 161
 162         std::string directory () const {
 163                 boost::mutex::scoped_lock lm (_directory_mutex);
 164                 return _directory;
 165         }
 166
 167         std::string name () const {
 168                 boost::mutex::scoped_lock lm (_state_mutex);
 169                 return _name;
 170         }
 171
 172         bool use_dci_name () const {
 173                 boost::mutex::scoped_lock lm (_state_mutex);
 174                 return _use_dci_name;
 175         }
 176
 177         bool trust_content_headers () const {
 178                 boost::mutex::scoped_lock lm (_state_mutex);
 179                 return _trust_content_headers;
 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         TrimType trim_type () const {
 218                 boost::mutex::scoped_lock lm (_state_mutex);
 219                 return _trim_type;
 220         }
 221
 222         bool ab () const {
 223                 boost::mutex::scoped_lock lm (_state_mutex);
 224                 return _ab;
 225         }
 226
 227         float audio_gain () const {
 228                 boost::mutex::scoped_lock lm (_state_mutex);
 229                 return _audio_gain;
 230         }
 231
 232         int audio_delay () const {
 233                 boost::mutex::scoped_lock lm (_state_mutex);
 234                 return _audio_delay;
 235         }
 236
 237         bool with_subtitles () const {
 238                 boost::mutex::scoped_lock lm (_state_mutex);
 239                 return _with_subtitles;
 240         }
 241
 242         int subtitle_offset () const {
 243                 boost::mutex::scoped_lock lm (_state_mutex);
 244                 return _subtitle_offset;
 245         }
 246
 247         float subtitle_scale () const {
 248                 boost::mutex::scoped_lock lm (_state_mutex);
 249                 return _subtitle_scale;
 250         }
 251
 252         int colour_lut () const {
 253                 boost::mutex::scoped_lock lm (_state_mutex);
 254                 return _colour_lut;
 255         }
 256
 257         int j2k_bandwidth () const {
 258                 boost::mutex::scoped_lock lm (_state_mutex);
 259                 return _j2k_bandwidth;
 260         }
 261
 262         DCIMetadata dci_metadata () const {
 263                 boost::mutex::scoped_lock lm (_state_mutex);
 264                 return _dci_metadata;
 265         }
 266
 267         /* XXX: -> "video_frame_rate" */
 268         int dcp_video_frame_rate () const {
 269                 boost::mutex::scoped_lock lm (_state_mutex);
 270                 return _dcp_video_frame_rate;
 271         }
 272
 273         /* SET */
 274
 275         void set_directory (std::string);
 276         void set_name (std::string);
 277         void set_use_dci_name (bool);
 278         void set_trust_content_headers (bool);
 279         void add_content (boost::shared_ptr<Content>);
 280         void remove_content (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_trim_type (TrimType);
 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_video_frame_rate (int);
 303         void set_dci_date_today ();
 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 playlist_changed ();
 323         void playlist_content_changed (boost::weak_ptr<Content>, int);
 324         std::string filename_safe_name () const;
 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         /** The type of content that this Film represents (feature, trailer etc.) */
 345         DCPContentType const * _dcp_content_type;
 346         /** The format to present this Film in (flat, scope, etc.) */
 347         Format const * _format;
 348         /** The crop to apply to the source */
 349         Crop _crop;
 350         /** Video filters that should be used when generating DCPs */
 351         std::vector<Filter const *> _filters;
 352         /** Scaler algorithm to use */
 353         Scaler const * _scaler;
 354         /** Frames to trim off the start of the DCP */
 355         int _trim_start;
 356         /** Frames to trim off the end of the DCP */
 357         int _trim_end;
 358         TrimType _trim_type;
 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_video_frame_rate;
 387         /** The date that we should use in a DCI name */
 388         boost::gregorian::date _dci_date;
 389
 390         /** true if our state has changed since we last saved it */
 391         mutable bool _dirty;
 392
 393         /** Mutex for all state except _directory */
 394         mutable boost::mutex _state_mutex;
 395
 396         friend class paths_test;
 397         friend class film_metadata_test;
 398 };
 399
 400 #endif