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 a piece of video (with sound), including naming,
  22  *  the source content file, and how it should be presented in a DCP.
  23  */
  24
  25 #ifndef DVDOMATIC_FILM_H
  26 #define DVDOMATIC_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 extern "C" {
  36 #include <libavcodec/avcodec.h>
  37 }
  38 #include "dcp_content_type.h"
  39 #include "util.h"
  40 #include "stream.h"
  41
  42 class Format;
  43 class Job;
  44 class Filter;
  45 class Log;
  46 class ExamineContentJob;
  47 class ExternalAudioStream;
  48
  49 /** @class Film
  50  *  @brief A representation of a video, maybe with sound.
  51  *
  52  *  A representation of a piece of video (maybe with sound), including naming,
  53  *  the source content file, and how it should be presented in a DCP.
  54  */
  55 class Film : public boost::enable_shared_from_this<Film>
  56 {
  57 public:
  58         Film (std::string d, bool must_exist = true);
  59         Film (Film const &);
  60         ~Film ();
  61
  62         std::string j2k_dir () const;
  63
  64         void examine_content ();
  65         void send_dcp_to_tms ();
  66
  67         void make_dcp (bool);
  68
  69         /** @return Logger.
  70          *  It is safe to call this from any thread.
  71          */
  72         Log* log () const {
  73                 return _log;
  74         }
  75
  76         int encoded_frames () const;
  77
  78         std::string file (std::string f) const;
  79         std::string dir (std::string d) const;
  80
  81         std::string frame_out_path (int f, bool t) const;
  82         std::string hash_out_path (int f, bool t) const;
  83         std::string multichannel_audio_out_path (int c, bool t) const;
  84
  85         std::string content_path () const;
  86         ContentType content_type () const;
  87
  88         int target_audio_sample_rate () const;
  89
  90         void write_metadata () const;
  91         void read_metadata ();
  92
  93         libdcp::Size cropped_size (libdcp::Size) const;
  94         std::string dci_name () const;
  95         std::string dcp_name () const;
  96
  97         boost::optional<int> dcp_intrinsic_duration () const {
  98                 return _dcp_intrinsic_duration;
  99         }
 100
 101         /** @return true if our state has changed since we last saved it */
 102         bool dirty () const {
 103                 return _dirty;
 104         }
 105
 106         int audio_channels () const;
 107
 108         void set_dci_date_today ();
 109
 110         /** Identifiers for the parts of our state;
 111             used for signalling changes.
 112         */
 113         enum Property {
 114                 NONE,
 115                 NAME,
 116                 USE_DCI_NAME,
 117                 CONTENT,
 118                 TRUST_CONTENT_HEADER,
 119                 DCP_CONTENT_TYPE,
 120                 FORMAT,
 121                 CROP,
 122                 FILTERS,
 123                 SCALER,
 124                 TRIM_START,
 125                 TRIM_END,
 126                 DCP_AB,
 127                 CONTENT_AUDIO_STREAM,
 128                 EXTERNAL_AUDIO,
 129                 USE_CONTENT_AUDIO,
 130                 AUDIO_GAIN,
 131                 AUDIO_DELAY,
 132                 STILL_DURATION,
 133                 SUBTITLE_STREAM,
 134                 WITH_SUBTITLES,
 135                 SUBTITLE_OFFSET,
 136                 SUBTITLE_SCALE,
 137                 COLOUR_LUT,
 138                 J2K_BANDWIDTH,
 139                 DCI_METADATA,
 140                 SIZE,
 141                 LENGTH,
 142                 DCP_INTRINSIC_DURATION,
 143                 CONTENT_AUDIO_STREAMS,
 144                 SUBTITLE_STREAMS,
 145                 FRAMES_PER_SECOND,
 146         };
 147
 148
 149         /* GET */
 150
 151         std::string directory () const {
 152                 boost::mutex::scoped_lock lm (_directory_mutex);
 153                 return _directory;
 154         }
 155
 156         std::string name () const {
 157                 boost::mutex::scoped_lock lm (_state_mutex);
 158                 return _name;
 159         }
 160
 161         bool use_dci_name () const {
 162                 boost::mutex::scoped_lock lm (_state_mutex);
 163                 return _use_dci_name;
 164         }
 165
 166         std::string content () const {
 167                 boost::mutex::scoped_lock lm (_state_mutex);
 168                 return _content;
 169         }
 170
 171         bool trust_content_header () const {
 172                 boost::mutex::scoped_lock lm (_state_mutex);
 173                 return _trust_content_header;
 174         }
 175
 176         DCPContentType const * dcp_content_type () const {
 177                 boost::mutex::scoped_lock lm (_state_mutex);
 178                 return _dcp_content_type;
 179         }
 180
 181         Format const * format () const {
 182                 boost::mutex::scoped_lock lm (_state_mutex);
 183                 return _format;
 184         }
 185
 186         Crop crop () const {
 187                 boost::mutex::scoped_lock lm (_state_mutex);
 188                 return _crop;
 189         }
 190
 191         std::vector<Filter const *> filters () const {
 192                 boost::mutex::scoped_lock lm (_state_mutex);
 193                 return _filters;
 194         }
 195
 196         Scaler const * scaler () const {
 197                 boost::mutex::scoped_lock lm (_state_mutex);
 198                 return _scaler;
 199         }
 200
 201         int trim_start () const {
 202                 boost::mutex::scoped_lock lm (_state_mutex);
 203                 return _trim_start;
 204         }
 205
 206         int trim_end () const {
 207                 boost::mutex::scoped_lock lm (_state_mutex);
 208                 return _trim_end;
 209         }
 210
 211         bool dcp_ab () const {
 212                 boost::mutex::scoped_lock lm (_state_mutex);
 213                 return _dcp_ab;
 214         }
 215
 216         boost::shared_ptr<AudioStream> content_audio_stream () const {
 217                 boost::mutex::scoped_lock lm (_state_mutex);
 218                 return _content_audio_stream;
 219         }
 220
 221         std::vector<std::string> external_audio () const {
 222                 boost::mutex::scoped_lock lm (_state_mutex);
 223                 return _external_audio;
 224         }
 225
 226         bool use_content_audio () const {
 227                 boost::mutex::scoped_lock lm (_state_mutex);
 228                 return _use_content_audio;
 229         }
 230
 231         float audio_gain () const {
 232                 boost::mutex::scoped_lock lm (_state_mutex);
 233                 return _audio_gain;
 234         }
 235
 236         int audio_delay () const {
 237                 boost::mutex::scoped_lock lm (_state_mutex);
 238                 return _audio_delay;
 239         }
 240
 241         int still_duration () const {
 242                 boost::mutex::scoped_lock lm (_state_mutex);
 243                 return _still_duration;
 244         }
 245
 246         int still_duration_in_frames () const;
 247
 248         boost::shared_ptr<SubtitleStream> subtitle_stream () const {
 249                 boost::mutex::scoped_lock lm (_state_mutex);
 250                 return _subtitle_stream;
 251         }
 252
 253         bool with_subtitles () const {
 254                 boost::mutex::scoped_lock lm (_state_mutex);
 255                 return _with_subtitles;
 256         }
 257
 258         int subtitle_offset () const {
 259                 boost::mutex::scoped_lock lm (_state_mutex);
 260                 return _subtitle_offset;
 261         }
 262
 263         float subtitle_scale () const {
 264                 boost::mutex::scoped_lock lm (_state_mutex);
 265                 return _subtitle_scale;
 266         }
 267
 268         int colour_lut () const {
 269                 boost::mutex::scoped_lock lm (_state_mutex);
 270                 return _colour_lut;
 271         }
 272
 273         int j2k_bandwidth () const {
 274                 boost::mutex::scoped_lock lm (_state_mutex);
 275                 return _j2k_bandwidth;
 276         }
 277
 278         std::string audio_language () const {
 279                 boost::mutex::scoped_lock lm (_state_mutex);
 280                 return _audio_language;
 281         }
 282
 283         std::string subtitle_language () const {
 284                 boost::mutex::scoped_lock lm (_state_mutex);
 285                 return _subtitle_language;
 286         }
 287
 288         std::string territory () const {
 289                 boost::mutex::scoped_lock lm (_state_mutex);
 290                 return _territory;
 291         }
 292
 293         std::string rating () const {
 294                 boost::mutex::scoped_lock lm (_state_mutex);
 295                 return _rating;
 296         }
 297
 298         std::string studio () const {
 299                 boost::mutex::scoped_lock lm (_state_mutex);
 300                 return _studio;
 301         }
 302
 303         std::string facility () const {
 304                 boost::mutex::scoped_lock lm (_state_mutex);
 305                 return _facility;
 306         }
 307
 308         std::string package_type () const {
 309                 boost::mutex::scoped_lock lm (_state_mutex);
 310                 return _package_type;
 311         }
 312
 313         libdcp::Size size () const {
 314                 boost::mutex::scoped_lock lm (_state_mutex);
 315                 return _size;
 316         }
 317
 318         boost::optional<SourceFrame> length () const {
 319                 boost::mutex::scoped_lock lm (_state_mutex);
 320                 return _length;
 321         }
 322
 323         std::string content_digest () const {
 324                 boost::mutex::scoped_lock lm (_state_mutex);
 325                 return _content_digest;
 326         }
 327
 328         std::vector<boost::shared_ptr<AudioStream> > content_audio_streams () const {
 329                 boost::mutex::scoped_lock lm (_state_mutex);
 330                 return _content_audio_streams;
 331         }
 332
 333         std::vector<boost::shared_ptr<SubtitleStream> > subtitle_streams () const {
 334                 boost::mutex::scoped_lock lm (_state_mutex);
 335                 return _subtitle_streams;
 336         }
 337
 338         float frames_per_second () const {
 339                 boost::mutex::scoped_lock lm (_state_mutex);
 340                 if (content_type() == STILL) {
 341                         return 24;
 342                 }
 343
 344                 return _frames_per_second;
 345         }
 346
 347         boost::shared_ptr<AudioStream> audio_stream () const;
 348
 349
 350         /* SET */
 351
 352         void set_directory (std::string);
 353         void set_name (std::string);
 354         void set_use_dci_name (bool);
 355         void set_content (std::string);
 356         void set_trust_content_header (bool);
 357         void set_dcp_content_type (DCPContentType const *);
 358         void set_format (Format const *);
 359         void set_crop (Crop);
 360         void set_left_crop (int);
 361         void set_right_crop (int);
 362         void set_top_crop (int);
 363         void set_bottom_crop (int);
 364         void set_filters (std::vector<Filter const *>);
 365         void set_scaler (Scaler const *);
 366         void set_trim_start (int);
 367         void set_trim_end (int);
 368         void set_dcp_ab (bool);
 369         void set_content_audio_stream (boost::shared_ptr<AudioStream>);
 370         void set_external_audio (std::vector<std::string>);
 371         void set_use_content_audio (bool);
 372         void set_audio_gain (float);
 373         void set_audio_delay (int);
 374         void set_still_duration (int);
 375         void set_subtitle_stream (boost::shared_ptr<SubtitleStream>);
 376         void set_with_subtitles (bool);
 377         void set_subtitle_offset (int);
 378         void set_subtitle_scale (float);
 379         void set_colour_lut (int);
 380         void set_j2k_bandwidth (int);
 381         void set_audio_language (std::string);
 382         void set_subtitle_language (std::string);
 383         void set_territory (std::string);
 384         void set_rating (std::string);
 385         void set_studio (std::string);
 386         void set_facility (std::string);
 387         void set_package_type (std::string);
 388         void set_size (libdcp::Size);
 389         void set_length (SourceFrame);
 390         void unset_length ();
 391         void set_dcp_intrinsic_duration (int);
 392         void set_content_digest (std::string);
 393         void set_content_audio_streams (std::vector<boost::shared_ptr<AudioStream> >);
 394         void set_subtitle_streams (std::vector<boost::shared_ptr<SubtitleStream> >);
 395         void set_frames_per_second (float);
 396
 397         /** Emitted when some property has changed */
 398         mutable boost::signals2::signal<void (Property)> Changed;
 399
 400         /** Current version number of the state file */
 401         static int const state_version;
 402
 403 private:
 404
 405         /** Log to write to */
 406         Log* _log;
 407
 408         /** Any running ExamineContentJob, or 0 */
 409         boost::shared_ptr<ExamineContentJob> _examine_content_job;
 410
 411         /** The date that we should use in a DCI name */
 412         boost::gregorian::date _dci_date;
 413
 414         void signal_changed (Property);
 415         void examine_content_finished ();
 416
 417         /** Complete path to directory containing the film metadata;
 418          *  must not be relative.
 419          */
 420         std::string _directory;
 421         /** Mutex for _directory */
 422         mutable boost::mutex _directory_mutex;
 423
 424         /** Name for DVD-o-matic */
 425         std::string _name;
 426         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 427         bool _use_dci_name;
 428         /** File or directory containing content; may be relative to our directory
 429          *  or an absolute path.
 430          */
 431         std::string _content;
 432         /** If this is true, we will believe the length specified by the content
 433          *  file's header; if false, we will run through the whole content file
 434          *  the first time we see it in order to obtain the length.
 435          */
 436         bool _trust_content_header;
 437         /** The type of content that this Film represents (feature, trailer etc.) */
 438         DCPContentType const * _dcp_content_type;
 439         /** The format to present this Film in (flat, scope, etc.) */
 440         Format const * _format;
 441         /** The crop to apply to the source */
 442         Crop _crop;
 443         /** Video filters that should be used when generating DCPs */
 444         std::vector<Filter const *> _filters;
 445         /** Scaler algorithm to use */
 446         Scaler const * _scaler;
 447         /** Frames to trim off the start of the DCP */
 448         int _trim_start;
 449         /** Frames to trim off the end of the DCP */
 450         int _trim_end;
 451         /** true to create an A/B comparison DCP, where the left half of the image
 452             is the video without any filters or post-processing, and the right half
 453             has the specified filters and post-processing.
 454         */
 455         bool _dcp_ab;
 456         /** The audio stream to use from our content */
 457         boost::shared_ptr<AudioStream> _content_audio_stream;
 458         /** List of filenames of external audio files, in channel order
 459             (L, R, C, Lfe, Ls, Rs)
 460         */
 461         std::vector<std::string> _external_audio;
 462         /** true to use audio from our content file; false to use external audio */
 463         bool _use_content_audio;
 464         /** Gain to apply to audio in dB */
 465         float _audio_gain;
 466         /** Delay to apply to audio (positive moves audio later) in milliseconds */
 467         int _audio_delay;
 468         /** Duration to make still-sourced films (in seconds) */
 469         int _still_duration;
 470         boost::shared_ptr<SubtitleStream> _subtitle_stream;
 471         /** True if subtitles should be shown for this film */
 472         bool _with_subtitles;
 473         /** y offset for placing subtitles, in source pixels; +ve is further down
 474             the frame, -ve is further up.
 475         */
 476         int _subtitle_offset;
 477         /** scale factor to apply to subtitles */
 478         float _subtitle_scale;
 479         /** index of colour LUT to use when converting RGB to XYZ.
 480          *  0: sRGB
 481          *  1: Rec 709
 482          */
 483         int _colour_lut;
 484         /** bandwidth for J2K files in bits per second */
 485         int _j2k_bandwidth;
 486
 487         /* DCI naming stuff */
 488         std::string _audio_language;
 489         std::string _subtitle_language;
 490         std::string _territory;
 491         std::string _rating;
 492         std::string _studio;
 493         std::string _facility;
 494         std::string _package_type;
 495
 496         /* Data which are cached to speed things up */
 497
 498         /** Size, in pixels, of the source (ignoring cropping) */
 499         libdcp::Size _size;
 500         /** The length of the source, in video frames (as far as we know) */
 501         boost::optional<SourceFrame> _length;
 502         boost::optional<int> _dcp_intrinsic_duration;
 503         /** MD5 digest of our content file */
 504         std::string _content_digest;
 505         /** The audio streams in our content */
 506         std::vector<boost::shared_ptr<AudioStream> > _content_audio_streams;
 507         /** A stream to represent possible external audio (will always exist) */
 508         boost::shared_ptr<AudioStream> _external_audio_stream;
 509         /** the subtitle streams that we can use */
 510         std::vector<boost::shared_ptr<SubtitleStream> > _subtitle_streams;
 511         /** Frames per second of the source */
 512         float _frames_per_second;
 513
 514         /** true if our state has changed since we last saved it */
 515         mutable bool _dirty;
 516
 517         /** Mutex for all state except _directory */
 518         mutable boost::mutex _state_mutex;
 519
 520         friend class paths_test;
 521 };
 522
 523 #endif