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