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