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 Container;
  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);
  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         std::string dcp_video_mxf_filename () const;
  70         std::string dcp_audio_mxf_filename () const;
  71
  72         void analyse_audio ();
  73         void send_dcp_to_tms ();
  74         void make_dcp ();
  75
  76         /** @return Logger.
  77          *  It is safe to call this from any thread.
  78          */
  79         boost::shared_ptr<Log> log () const {
  80                 return _log;
  81         }
  82
  83         int encoded_frames () const;
  84
  85         std::string file (std::string f) const;
  86         std::string dir (std::string d) const;
  87
  88         void read_metadata ();
  89         void write_metadata () const;
  90
  91         std::string dci_name (bool if_created_now) const;
  92         std::string dcp_name (bool if_created_now = false) const;
  93
  94         /** @return true if our state has changed since we last saved it */
  95         bool dirty () const {
  96                 return _dirty;
  97         }
  98
  99         libdcp::Size full_frame () const;
 100
 101         bool have_dcp () const;
 102
 103         boost::shared_ptr<Player> player () const;
 104         boost::shared_ptr<Playlist> playlist () const;
 105
 106         OutputAudioFrame dcp_audio_frame_rate () const;
 107
 108         OutputAudioFrame time_to_audio_frames (Time) const;
 109         OutputVideoFrame time_to_video_frames (Time) const;
 110         Time video_frames_to_time (OutputVideoFrame) const;
 111         Time audio_frames_to_time (OutputAudioFrame) const;
 112
 113         /* Proxies for some Playlist methods */
 114
 115         Playlist::ContentList content () const;
 116
 117         Time length () const;
 118         bool has_subtitles () const;
 119         OutputVideoFrame best_dcp_video_frame_rate () const;
 120
 121         void set_loop (int);
 122         int loop () const;
 123
 124         void set_sequence_video (bool);
 125
 126         /** Identifiers for the parts of our state;
 127             used for signalling changes.
 128         */
 129         enum Property {
 130                 NONE,
 131                 NAME,
 132                 USE_DCI_NAME,
 133                 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
 134                 CONTENT,
 135                 LOOP,
 136                 DCP_CONTENT_TYPE,
 137                 CONTAINER,
 138                 SCALER,
 139                 AB,
 140                 WITH_SUBTITLES,
 141                 SUBTITLE_OFFSET,
 142                 SUBTITLE_SCALE,
 143                 COLOUR_LUT,
 144                 J2K_BANDWIDTH,
 145                 DCI_METADATA,
 146                 DCP_VIDEO_FRAME_RATE,
 147         };
 148
 149
 150         /* GET */
 151
 152         std::string directory () const {
 153                 boost::mutex::scoped_lock lm (_directory_mutex);
 154                 return _directory;
 155         }
 156
 157         std::string name () const {
 158                 boost::mutex::scoped_lock lm (_state_mutex);
 159                 return _name;
 160         }
 161
 162         bool use_dci_name () const {
 163                 boost::mutex::scoped_lock lm (_state_mutex);
 164                 return _use_dci_name;
 165         }
 166
 167         DCPContentType const * dcp_content_type () const {
 168                 boost::mutex::scoped_lock lm (_state_mutex);
 169                 return _dcp_content_type;
 170         }
 171
 172         Container const * container () const {
 173                 boost::mutex::scoped_lock lm (_state_mutex);
 174                 return _container;
 175         }
 176
 177         Scaler const * scaler () const {
 178                 boost::mutex::scoped_lock lm (_state_mutex);
 179                 return _scaler;
 180         }
 181
 182         bool ab () const {
 183                 boost::mutex::scoped_lock lm (_state_mutex);
 184                 return _ab;
 185         }
 186
 187         bool with_subtitles () const {
 188                 boost::mutex::scoped_lock lm (_state_mutex);
 189                 return _with_subtitles;
 190         }
 191
 192         int subtitle_offset () const {
 193                 boost::mutex::scoped_lock lm (_state_mutex);
 194                 return _subtitle_offset;
 195         }
 196
 197         float subtitle_scale () const {
 198                 boost::mutex::scoped_lock lm (_state_mutex);
 199                 return _subtitle_scale;
 200         }
 201
 202         int colour_lut () const {
 203                 boost::mutex::scoped_lock lm (_state_mutex);
 204                 return _colour_lut;
 205         }
 206
 207         int j2k_bandwidth () const {
 208                 boost::mutex::scoped_lock lm (_state_mutex);
 209                 return _j2k_bandwidth;
 210         }
 211
 212         DCIMetadata dci_metadata () const {
 213                 boost::mutex::scoped_lock lm (_state_mutex);
 214                 return _dci_metadata;
 215         }
 216
 217         /* XXX: -> "video_frame_rate" */
 218         int dcp_video_frame_rate () const {
 219                 boost::mutex::scoped_lock lm (_state_mutex);
 220                 return _dcp_video_frame_rate;
 221         }
 222
 223         int dcp_audio_channels () const {
 224                 boost::mutex::scoped_lock lm (_state_mutex);
 225                 return _dcp_audio_channels;
 226         }
 227
 228         /* SET */
 229
 230         void set_directory (std::string);
 231         void set_name (std::string);
 232         void set_use_dci_name (bool);
 233         void examine_and_add_content (boost::shared_ptr<Content>);
 234         void add_content (boost::shared_ptr<Content>);
 235         void remove_content (boost::shared_ptr<Content>);
 236         void set_dcp_content_type (DCPContentType const *);
 237         void set_container (Container const *);
 238         void set_scaler (Scaler const *);
 239         void set_ab (bool);
 240         void set_with_subtitles (bool);
 241         void set_subtitle_offset (int);
 242         void set_subtitle_scale (float);
 243         void set_colour_lut (int);
 244         void set_j2k_bandwidth (int);
 245         void set_dci_metadata (DCIMetadata);
 246         void set_dcp_video_frame_rate (int);
 247         void set_dci_date_today ();
 248
 249         /** Emitted when some property has of the Film has changed */
 250         mutable boost::signals2::signal<void (Property)> Changed;
 251
 252         /** Emitted when some property of our content has changed */
 253         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 254
 255         boost::signals2::signal<void ()> AudioAnalysisSucceeded;
 256
 257         /** Current version number of the state file */
 258         static int const state_version;
 259
 260 private:
 261
 262         void signal_changed (Property);
 263         void analyse_audio_finished ();
 264         std::string video_state_identifier () const;
 265         void playlist_changed ();
 266         void playlist_content_changed (boost::weak_ptr<Content>, int);
 267         std::string filename_safe_name () const;
 268
 269         /** Log to write to */
 270         boost::shared_ptr<Log> _log;
 271         /** Any running AnalyseAudioJob, or 0 */
 272         boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
 273         boost::shared_ptr<Playlist> _playlist;
 274
 275         /** Complete path to directory containing the film metadata;
 276          *  must not be relative.
 277          */
 278         std::string _directory;
 279         /** Mutex for _directory */
 280         mutable boost::mutex _directory_mutex;
 281
 282         /** Name for DCP-o-matic */
 283         std::string _name;
 284         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 285         bool _use_dci_name;
 286         /** The type of content that this Film represents (feature, trailer etc.) */
 287         DCPContentType const * _dcp_content_type;
 288         /** The container to put this Film in (flat, scope, etc.) */
 289         Container const * _container;
 290         /** Scaler algorithm to use */
 291         Scaler const * _scaler;
 292         /** true to create an A/B comparison DCP, where the left half of the image
 293             is the video without any filters or post-processing, and the right half
 294             has the specified filters and post-processing.
 295         */
 296         bool _ab;
 297         /** True if subtitles should be shown for this film */
 298         bool _with_subtitles;
 299         /** y offset for placing subtitles, in source pixels; +ve is further down
 300             the frame, -ve is further up.
 301         */
 302         int _subtitle_offset;
 303         /** scale factor to apply to subtitles */
 304         float _subtitle_scale;
 305         /** index of colour LUT to use when converting RGB to XYZ.
 306          *  0: sRGB
 307          *  1: Rec 709
 308          */
 309         int _colour_lut;
 310         /** bandwidth for J2K files in bits per second */
 311         int _j2k_bandwidth;
 312         /** DCI naming stuff */
 313         DCIMetadata _dci_metadata;
 314         /** Frames per second to run our DCP at */
 315         int _dcp_video_frame_rate;
 316         /** The date that we should use in a DCI name */
 317         boost::gregorian::date _dci_date;
 318         int _dcp_audio_channels;
 319
 320         /** true if our state has changed since we last saved it */
 321         mutable bool _dirty;
 322
 323         /** Mutex for all state except _directory */
 324         mutable boost::mutex _state_mutex;
 325
 326         friend class paths_test;
 327         friend class film_metadata_test;
 328 };
 329
 330 #endif