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