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         boost::filesystem::path audio_analysis_path (boost::shared_ptr<const AudioContent>) const;
  67
  68         std::string dcp_video_mxf_filename () const;
  69         std::string dcp_audio_mxf_filename () const;
  70
  71         void send_dcp_to_tms ();
  72         void make_dcp ();
  73
  74         /** @return Logger.
  75          *  It is safe to call this from any thread.
  76          */
  77         boost::shared_ptr<Log> log () const {
  78                 return _log;
  79         }
  80
  81         int encoded_frames () const;
  82
  83         std::string file (std::string f) const;
  84         std::string dir (std::string d) const;
  85
  86         void read_metadata ();
  87         void write_metadata () const;
  88
  89         std::string dci_name (bool if_created_now) const;
  90         std::string dcp_name (bool if_created_now = false) const;
  91
  92         /** @return true if our state has changed since we last saved it */
  93         bool dirty () const {
  94                 return _dirty;
  95         }
  96
  97         libdcp::Size full_frame () const;
  98
  99         bool have_dcp () const;
 100
 101         boost::shared_ptr<Player> player () const;
 102         boost::shared_ptr<Playlist> playlist () const;
 103
 104         OutputAudioFrame dcp_audio_frame_rate () const;
 105
 106         OutputAudioFrame time_to_audio_frames (Time) const;
 107         OutputVideoFrame time_to_video_frames (Time) const;
 108         Time video_frames_to_time (OutputVideoFrame) const;
 109         Time audio_frames_to_time (OutputAudioFrame) const;
 110
 111         /* Proxies for some Playlist methods */
 112
 113         Playlist::ContentList content () const;
 114
 115         Time length () const;
 116         bool has_subtitles () const;
 117         OutputVideoFrame best_dcp_video_frame_rate () const;
 118
 119         void set_loop (int);
 120         int loop () const;
 121
 122         void set_sequence_video (bool);
 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                 SCALER,
 137                 WITH_SUBTITLES,
 138                 COLOUR_LUT,
 139                 J2K_BANDWIDTH,
 140                 DCI_METADATA,
 141                 DCP_VIDEO_FRAME_RATE,
 142                 DCP_AUDIO_CHANNELS
 143         };
 144
 145
 146         /* GET */
 147
 148         std::string directory () const {
 149                 boost::mutex::scoped_lock lm (_directory_mutex);
 150                 return _directory;
 151         }
 152
 153         std::string name () const {
 154                 boost::mutex::scoped_lock lm (_state_mutex);
 155                 return _name;
 156         }
 157
 158         bool use_dci_name () const {
 159                 boost::mutex::scoped_lock lm (_state_mutex);
 160                 return _use_dci_name;
 161         }
 162
 163         DCPContentType const * dcp_content_type () const {
 164                 boost::mutex::scoped_lock lm (_state_mutex);
 165                 return _dcp_content_type;
 166         }
 167
 168         Ratio const * container () const {
 169                 boost::mutex::scoped_lock lm (_state_mutex);
 170                 return _container;
 171         }
 172
 173         Scaler const * scaler () const {
 174                 boost::mutex::scoped_lock lm (_state_mutex);
 175                 return _scaler;
 176         }
 177
 178         bool with_subtitles () const {
 179                 boost::mutex::scoped_lock lm (_state_mutex);
 180                 return _with_subtitles;
 181         }
 182
 183         int colour_lut () const {
 184                 boost::mutex::scoped_lock lm (_state_mutex);
 185                 return _colour_lut;
 186         }
 187
 188         int j2k_bandwidth () const {
 189                 boost::mutex::scoped_lock lm (_state_mutex);
 190                 return _j2k_bandwidth;
 191         }
 192
 193         DCIMetadata dci_metadata () const {
 194                 boost::mutex::scoped_lock lm (_state_mutex);
 195                 return _dci_metadata;
 196         }
 197
 198         /* XXX: -> "video_frame_rate" */
 199         int dcp_video_frame_rate () const {
 200                 boost::mutex::scoped_lock lm (_state_mutex);
 201                 return _dcp_video_frame_rate;
 202         }
 203
 204         int dcp_audio_channels () const {
 205                 boost::mutex::scoped_lock lm (_state_mutex);
 206                 return _dcp_audio_channels;
 207         }
 208
 209         /* SET */
 210
 211         void set_directory (std::string);
 212         void set_name (std::string);
 213         void set_use_dci_name (bool);
 214         void examine_and_add_content (boost::shared_ptr<Content>);
 215         void add_content (boost::shared_ptr<Content>);
 216         void remove_content (boost::shared_ptr<Content>);
 217         void set_dcp_content_type (DCPContentType const *);
 218         void set_container (Ratio const *);
 219         void set_scaler (Scaler const *);
 220         void set_with_subtitles (bool);
 221         void set_colour_lut (int);
 222         void set_j2k_bandwidth (int);
 223         void set_dci_metadata (DCIMetadata);
 224         void set_dcp_video_frame_rate (int);
 225         void set_dcp_audio_channels (int);
 226         void set_dci_date_today ();
 227
 228         /** Emitted when some property has of the Film has changed */
 229         mutable boost::signals2::signal<void (Property)> Changed;
 230
 231         /** Emitted when some property of our content has changed */
 232         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 233
 234         /** Current version number of the state file */
 235         static int const state_version;
 236
 237 private:
 238
 239         void signal_changed (Property);
 240         std::string video_identifier () const;
 241         void playlist_changed ();
 242         void playlist_content_changed (boost::weak_ptr<Content>, int);
 243         std::string filename_safe_name () const;
 244         void add_content_weak (boost::weak_ptr<Content>);
 245
 246         /** Log to write to */
 247         boost::shared_ptr<Log> _log;
 248         boost::shared_ptr<Playlist> _playlist;
 249
 250         /** Complete path to directory containing the film metadata;
 251          *  must not be relative.
 252          */
 253         std::string _directory;
 254         /** Mutex for _directory */
 255         mutable boost::mutex _directory_mutex;
 256
 257         /** Name for DCP-o-matic */
 258         std::string _name;
 259         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 260         bool _use_dci_name;
 261         /** The type of content that this Film represents (feature, trailer etc.) */
 262         DCPContentType const * _dcp_content_type;
 263         /** The container to put this Film in (flat, scope, etc.) */
 264         Ratio const * _container;
 265         /** Scaler algorithm to use */
 266         Scaler const * _scaler;
 267         /** True if subtitles should be shown for this film */
 268         bool _with_subtitles;
 269         /** index of colour LUT to use when converting RGB to XYZ.
 270          *  0: sRGB
 271          *  1: Rec 709
 272          */
 273         int _colour_lut;
 274         /** bandwidth for J2K files in bits per second */
 275         int _j2k_bandwidth;
 276         /** DCI naming stuff */
 277         DCIMetadata _dci_metadata;
 278         /** Frames per second to run our DCP at */
 279         int _dcp_video_frame_rate;
 280         /** The date that we should use in a DCI name */
 281         boost::gregorian::date _dci_date;
 282         int _dcp_audio_channels;
 283
 284         /** true if our state has changed since we last saved it */
 285         mutable bool _dirty;
 286
 287         /** Mutex for all state except _directory */
 288         mutable boost::mutex _state_mutex;
 289
 290         friend class paths_test;
 291         friend class film_metadata_test;
 292 };
 293
 294 #endif