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