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/signals2.hpp>
  32 #include <boost/enable_shared_from_this.hpp>
  33 #include <boost/filesystem.hpp>
  34 #include "util.h"
  35 #include "types.h"
  36 #include "dci_metadata.h"
  37
  38 class DCPContentType;
  39 class Log;
  40 class Content;
  41 class Player;
  42 class Playlist;
  43 class AudioContent;
  44 class Scaler;
  45
  46 /** @class Film
  47  *
  48  *  @brief A representation of some audio and video content, and details of
  49  *  how they should be presented in a DCP.
  50  *
  51  *  The content of a Film is held in a Playlist (created and managed by the Film).
  52  */
  53 class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
  54 {
  55 public:
  56         Film (boost::filesystem::path);
  57
  58         std::string info_dir () const;
  59         std::string j2c_path (int, Eyes, bool) const;
  60         std::string info_path (int, Eyes) const;
  61         std::string internal_video_mxf_dir () const;
  62         std::string internal_video_mxf_filename () const;
  63         boost::filesystem::path audio_analysis_path (boost::shared_ptr<const AudioContent>) const;
  64
  65         std::string video_mxf_filename () const;
  66         std::string audio_mxf_filename () const;
  67
  68         void send_dcp_to_tms ();
  69         void make_dcp ();
  70
  71         /** @return Logger.
  72          *  It is safe to call this from any thread.
  73          */
  74         boost::shared_ptr<Log> log () const {
  75                 return _log;
  76         }
  77
  78         int encoded_frames () const;
  79
  80         std::string file (std::string f) const;
  81         std::string dir (std::string d) const;
  82
  83         void read_metadata ();
  84         void write_metadata () const;
  85
  86         std::string dci_name (bool if_created_now) const;
  87         std::string dcp_name (bool if_created_now = false) const;
  88
  89         /** @return true if our state has changed since we last saved it */
  90         bool dirty () const {
  91                 return _dirty;
  92         }
  93
  94         libdcp::Size full_frame () const;
  95
  96         bool have_dcp () const;
  97
  98         boost::shared_ptr<Player> make_player () const;
  99         boost::shared_ptr<Playlist> playlist () const;
 100
 101         OutputAudioFrame audio_frame_rate () const;
 102
 103         OutputAudioFrame time_to_audio_frames (Time) const;
 104         OutputVideoFrame time_to_video_frames (Time) const;
 105         Time video_frames_to_time (OutputVideoFrame) const;
 106         Time audio_frames_to_time (OutputAudioFrame) const;
 107
 108         /* Proxies for some Playlist methods */
 109
 110         ContentList content () const;
 111
 112         Time length () const;
 113         bool has_subtitles () const;
 114         OutputVideoFrame best_video_frame_rate () const;
 115
 116         /** Identifiers for the parts of our state;
 117             used for signalling changes.
 118         */
 119         enum Property {
 120                 NONE,
 121                 NAME,
 122                 USE_DCI_NAME,
 123                 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
 124                 CONTENT,
 125                 DCP_CONTENT_TYPE,
 126                 CONTAINER,
 127                 RESOLUTION,
 128                 SCALER,
 129                 WITH_SUBTITLES,
 130                 J2K_BANDWIDTH,
 131                 DCI_METADATA,
 132                 VIDEO_FRAME_RATE,
 133                 AUDIO_CHANNELS,
 134                 /** The setting of _three_d has been changed */
 135                 THREE_D,
 136                 SEQUENCE_VIDEO,
 137         };
 138
 139
 140         /* GET */
 141
 142         std::string directory () const {
 143                 return _directory;
 144         }
 145
 146         std::string name () const {
 147                 return _name;
 148         }
 149
 150         bool use_dci_name () const {
 151                 return _use_dci_name;
 152         }
 153
 154         DCPContentType const * dcp_content_type () const {
 155                 return _dcp_content_type;
 156         }
 157
 158         Ratio const * container () const {
 159                 return _container;
 160         }
 161
 162         Resolution resolution () const {
 163                 return _resolution;
 164         }
 165
 166         Scaler const * scaler () const {
 167                 return _scaler;
 168         }
 169
 170         bool with_subtitles () const {
 171                 return _with_subtitles;
 172         }
 173
 174         int j2k_bandwidth () const {
 175                 return _j2k_bandwidth;
 176         }
 177
 178         DCIMetadata dci_metadata () const {
 179                 return _dci_metadata;
 180         }
 181
 182         /** @return The frame rate of the DCP */
 183         int video_frame_rate () const {
 184                 return _video_frame_rate;
 185         }
 186
 187         int audio_channels () const {
 188                 return _audio_channels;
 189         }
 190
 191         bool three_d () const {
 192                 return _three_d;
 193         }
 194
 195         bool sequence_video () const {
 196                 return _sequence_video;
 197         }
 198
 199
 200         /* SET */
 201
 202         void set_directory (std::string);
 203         void set_name (std::string);
 204         void set_use_dci_name (bool);
 205         void examine_and_add_content (boost::shared_ptr<Content>);
 206         void add_content (boost::shared_ptr<Content>);
 207         void remove_content (boost::shared_ptr<Content>);
 208         void set_dcp_content_type (DCPContentType const *);
 209         void set_container (Ratio const *);
 210         void set_resolution (Resolution);
 211         void set_scaler (Scaler const *);
 212         void set_with_subtitles (bool);
 213         void set_j2k_bandwidth (int);
 214         void set_dci_metadata (DCIMetadata);
 215         void set_video_frame_rate (int);
 216         void set_audio_channels (int);
 217         void set_three_d (bool);
 218         void set_dci_date_today ();
 219         void set_sequence_video (bool);
 220
 221         /** Emitted when some property has of the Film has changed */
 222         mutable boost::signals2::signal<void (Property)> Changed;
 223
 224         /** Emitted when some property of our content has changed */
 225         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 226
 227         /** Current version number of the state file */
 228         static int const state_version;
 229
 230 private:
 231
 232         void signal_changed (Property);
 233         std::string video_identifier () const;
 234         void playlist_changed ();
 235         void playlist_content_changed (boost::weak_ptr<Content>, int);
 236         std::string filename_safe_name () const;
 237         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
 238
 239         /** Log to write to */
 240         boost::shared_ptr<Log> _log;
 241         boost::shared_ptr<Playlist> _playlist;
 242
 243         /** Complete path to directory containing the film metadata;
 244          *  must not be relative.
 245          */
 246         std::string _directory;
 247
 248         /** Name for DCP-o-matic */
 249         std::string _name;
 250         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 251         bool _use_dci_name;
 252         /** The type of content that this Film represents (feature, trailer etc.) */
 253         DCPContentType const * _dcp_content_type;
 254         /** The container to put this Film in (flat, scope, etc.) */
 255         Ratio const * _container;
 256         /** DCP resolution (2K or 4K) */
 257         Resolution _resolution;
 258         /** Scaler algorithm to use */
 259         Scaler const * _scaler;
 260         /** True if subtitles should be shown for this film */
 261         bool _with_subtitles;
 262         /** bandwidth for J2K files in bits per second */
 263         int _j2k_bandwidth;
 264         /** DCI naming stuff */
 265         DCIMetadata _dci_metadata;
 266         /** Frames per second to run our DCP at */
 267         int _video_frame_rate;
 268         /** The date that we should use in a DCI name */
 269         boost::gregorian::date _dci_date;
 270         /** Number of audio channels to put in the DCP */
 271         int _audio_channels;
 272         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 273             This will be regardless of what content is on the playlist.
 274         */
 275         bool _three_d;
 276         bool _sequence_video;
 277
 278         /** true if our state has changed since we last saved it */
 279         mutable bool _dirty;
 280
 281         friend class paths_test;
 282         friend class film_metadata_test;
 283 };
 284
 285 #endif