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         boost::shared_ptr<Playlist> playlist () const;
 107
 108         /* Proxies for some Playlist methods */
 109
 110         ContentList content () const;
 111
 112         ContentAudioFrame audio_length () const;
 113         int audio_channels () const;
 114         int audio_frame_rate () const;
 115         bool has_audio () const;
 116
 117         bool has_subtitles () const;
 118
 119         float video_frame_rate () const;
 120         libdcp::Size video_size () const;
 121         ContentVideoFrame video_length () const;
 122
 123         ContentVideoFrame content_length () const;
 124
 125         std::string playlist_description () const;
 126
 127         void set_loop (int);
 128         int loop () const;
 129
 130
 131         enum TrimType {
 132                 CPL,
 133                 ENCODE
 134         };
 135
 136         /** Identifiers for the parts of our state;
 137             used for signalling changes.
 138         */
 139         enum Property {
 140                 NONE,
 141                 NAME,
 142                 USE_DCI_NAME,
 143                 TRUST_CONTENT_HEADERS,
 144                 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
 145                 CONTENT,
 146                 LOOP,
 147                 DCP_CONTENT_TYPE,
 148                 FORMAT,
 149                 CROP,
 150                 FILTERS,
 151                 SCALER,
 152                 TRIM_START,
 153                 TRIM_END,
 154                 AB,
 155                 TRIM_TYPE,
 156                 AUDIO_GAIN,
 157                 AUDIO_DELAY,
 158                 WITH_SUBTITLES,
 159                 SUBTITLE_OFFSET,
 160                 SUBTITLE_SCALE,
 161                 COLOUR_LUT,
 162                 J2K_BANDWIDTH,
 163                 DCI_METADATA,
 164                 DCP_FRAME_RATE,
 165                 AUDIO_MAPPING
 166         };
 167
 168
 169         /* GET */
 170
 171         std::string directory () const {
 172                 boost::mutex::scoped_lock lm (_directory_mutex);
 173                 return _directory;
 174         }
 175
 176         std::string name () const {
 177                 boost::mutex::scoped_lock lm (_state_mutex);
 178                 return _name;
 179         }
 180
 181         bool use_dci_name () const {
 182                 boost::mutex::scoped_lock lm (_state_mutex);
 183                 return _use_dci_name;
 184         }
 185
 186         bool trust_content_headers () const {
 187                 boost::mutex::scoped_lock lm (_state_mutex);
 188                 return _trust_content_headers;
 189         }
 190
 191         DCPContentType const * dcp_content_type () const {
 192                 boost::mutex::scoped_lock lm (_state_mutex);
 193                 return _dcp_content_type;
 194         }
 195
 196         Format const * format () const {
 197                 boost::mutex::scoped_lock lm (_state_mutex);
 198                 return _format;
 199         }
 200
 201         Crop crop () const {
 202                 boost::mutex::scoped_lock lm (_state_mutex);
 203                 return _crop;
 204         }
 205
 206         std::vector<Filter const *> filters () const {
 207                 boost::mutex::scoped_lock lm (_state_mutex);
 208                 return _filters;
 209         }
 210
 211         Scaler const * scaler () const {
 212                 boost::mutex::scoped_lock lm (_state_mutex);
 213                 return _scaler;
 214         }
 215
 216         int trim_start () const {
 217                 boost::mutex::scoped_lock lm (_state_mutex);
 218                 return _trim_start;
 219         }
 220
 221         int trim_end () const {
 222                 boost::mutex::scoped_lock lm (_state_mutex);
 223                 return _trim_end;
 224         }
 225
 226         TrimType trim_type () const {
 227                 boost::mutex::scoped_lock lm (_state_mutex);
 228                 return _trim_type;
 229         }
 230
 231         bool ab () const {
 232                 boost::mutex::scoped_lock lm (_state_mutex);
 233                 return _ab;
 234         }
 235
 236         float audio_gain () const {
 237                 boost::mutex::scoped_lock lm (_state_mutex);
 238                 return _audio_gain;
 239         }
 240
 241         int audio_delay () const {
 242                 boost::mutex::scoped_lock lm (_state_mutex);
 243                 return _audio_delay;
 244         }
 245
 246         bool with_subtitles () const {
 247                 boost::mutex::scoped_lock lm (_state_mutex);
 248                 return _with_subtitles;
 249         }
 250
 251         int subtitle_offset () const {
 252                 boost::mutex::scoped_lock lm (_state_mutex);
 253                 return _subtitle_offset;
 254         }
 255
 256         float subtitle_scale () const {
 257                 boost::mutex::scoped_lock lm (_state_mutex);
 258                 return _subtitle_scale;
 259         }
 260
 261         int colour_lut () const {
 262                 boost::mutex::scoped_lock lm (_state_mutex);
 263                 return _colour_lut;
 264         }
 265
 266         int j2k_bandwidth () const {
 267                 boost::mutex::scoped_lock lm (_state_mutex);
 268                 return _j2k_bandwidth;
 269         }
 270
 271         DCIMetadata dci_metadata () const {
 272                 boost::mutex::scoped_lock lm (_state_mutex);
 273                 return _dci_metadata;
 274         }
 275
 276         int dcp_frame_rate () const {
 277                 boost::mutex::scoped_lock lm (_state_mutex);
 278                 return _dcp_frame_rate;
 279         }
 280
 281         AudioMapping audio_mapping () const {
 282                 boost::mutex::scoped_lock lm (_state_mutex);
 283                 return _audio_mapping;
 284         }
 285
 286         /* SET */
 287
 288         void set_directory (std::string);
 289         void set_name (std::string);
 290         void set_use_dci_name (bool);
 291         void set_trust_content_headers (bool);
 292         void add_content (boost::shared_ptr<Content>);
 293         void remove_content (boost::shared_ptr<Content>);
 294         void move_content_earlier (boost::shared_ptr<Content>);
 295         void move_content_later (boost::shared_ptr<Content>);
 296         void set_dcp_content_type (DCPContentType const *);
 297         void set_format (Format const *);
 298         void set_crop (Crop);
 299         void set_left_crop (int);
 300         void set_right_crop (int);
 301         void set_top_crop (int);
 302         void set_bottom_crop (int);
 303         void set_filters (std::vector<Filter const *>);
 304         void set_scaler (Scaler const *);
 305         void set_trim_start (int);
 306         void set_trim_end (int);
 307         void set_ab (bool);
 308         void set_trim_type (TrimType);
 309         void set_audio_gain (float);
 310         void set_audio_delay (int);
 311         void set_with_subtitles (bool);
 312         void set_subtitle_offset (int);
 313         void set_subtitle_scale (float);
 314         void set_colour_lut (int);
 315         void set_j2k_bandwidth (int);
 316         void set_dci_metadata (DCIMetadata);
 317         void set_dcp_frame_rate (int);
 318         void set_dci_date_today ();
 319         void set_audio_mapping (AudioMapping);
 320
 321         /** Emitted when some property has of the Film has changed */
 322         mutable boost::signals2::signal<void (Property)> Changed;
 323
 324         /** Emitted when some property of our content has changed */
 325         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 326
 327         boost::signals2::signal<void ()> AudioAnalysisSucceeded;
 328
 329         /** Current version number of the state file */
 330         static int const state_version;
 331
 332 private:
 333
 334         void signal_changed (Property);
 335         void analyse_audio_finished ();
 336         std::string video_state_identifier () const;
 337         void read_metadata ();
 338         void playlist_changed ();
 339         void playlist_content_changed (boost::weak_ptr<Content>, int);
 340         void setup_default_audio_mapping ();
 341         std::string filename_safe_name () const;
 342
 343         /** Log to write to */
 344         boost::shared_ptr<Log> _log;
 345         /** Any running AnalyseAudioJob, or 0 */
 346         boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
 347         boost::shared_ptr<Playlist> _playlist;
 348
 349         /** Complete path to directory containing the film metadata;
 350          *  must not be relative.
 351          */
 352         std::string _directory;
 353         /** Mutex for _directory */
 354         mutable boost::mutex _directory_mutex;
 355
 356         /** Name for DCP-o-matic */
 357         std::string _name;
 358         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 359         bool _use_dci_name;
 360         bool _trust_content_headers;
 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