2 Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
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.
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.
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.
21 * @brief A representation of some audio and video content, and details of
22 * how they should be presented in a DCP.
25 #ifndef DCPOMATIC_FILM_H
26 #define DCPOMATIC_FILM_H
31 #include <boost/signals2.hpp>
32 #include <boost/enable_shared_from_this.hpp>
33 #include <boost/filesystem.hpp>
34 #include <libdcp/key.h>
35 #include <libdcp/kdm.h>
38 #include "isdcf_metadata.h"
39 #include "frame_rate_change.h"
49 class isdcf_name_test;
53 * @brief A representation of some audio and video content, and details of
54 * how they should be presented in a DCP.
56 * The content of a Film is held in a Playlist (created and managed by the Film).
58 class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
61 Film (boost::filesystem::path, bool log = true);
63 boost::filesystem::path info_dir () const;
64 boost::filesystem::path j2c_path (int, Eyes, bool) const;
65 boost::filesystem::path info_path (int, Eyes) const;
66 boost::filesystem::path internal_video_mxf_dir () const;
67 boost::filesystem::path internal_video_mxf_filename () const;
68 boost::filesystem::path audio_analysis_dir () const;
70 boost::filesystem::path video_mxf_filename () const;
71 boost::filesystem::path audio_mxf_filename () const;
73 void send_dcp_to_tms ();
77 * It is safe to call this from any thread.
79 boost::shared_ptr<Log> log () const {
83 int encoded_frames () const;
85 boost::filesystem::path file (boost::filesystem::path f) const;
86 boost::filesystem::path dir (boost::filesystem::path d) const;
88 std::list<std::string> read_metadata ();
89 void write_metadata () const;
90 boost::shared_ptr<xmlpp::Document> metadata () const;
92 std::string isdcf_name (bool if_created_now) const;
93 std::string dcp_name (bool if_created_now = false) const;
95 /** @return true if our state has changed since we last saved it */
100 libdcp::Size full_frame () const;
101 libdcp::Size frame_size () const;
103 std::vector<CPLSummary> cpls () const;
105 boost::shared_ptr<Player> make_player () const;
106 boost::shared_ptr<Playlist> playlist () const;
108 OutputAudioFrame audio_frame_rate () const;
110 OutputAudioFrame time_to_audio_frames (Time) const;
111 OutputVideoFrame time_to_video_frames (Time) const;
112 Time video_frames_to_time (OutputVideoFrame) const;
113 Time audio_frames_to_time (OutputAudioFrame) const;
115 uint64_t required_disk_space () const;
116 bool should_be_enough_disk_space (double &, double &) const;
118 /* Proxies for some Playlist methods */
120 ContentList content () const;
121 Time length () const;
122 bool has_subtitles () const;
123 OutputVideoFrame best_video_frame_rate () const;
124 FrameRateChange active_frame_rate_change (Time) const;
128 boost::shared_ptr<libdcp::Certificate> target,
129 boost::filesystem::path cpl_file,
130 boost::posix_time::ptime from,
131 boost::posix_time::ptime until,
132 libdcp::KDM::Formulation formulation
135 std::list<libdcp::KDM> make_kdms (
136 std::list<boost::shared_ptr<Screen> >,
137 boost::filesystem::path cpl_file,
138 boost::posix_time::ptime from,
139 boost::posix_time::ptime until,
140 libdcp::KDM::Formulation formulation
143 libdcp::Key key () const {
147 int state_version () const {
148 return _state_version;
151 /** Identifiers for the parts of our state;
152 used for signalling changes.
158 /** The playlist's content list has changed (i.e. content has been added or removed) */
171 /** The setting of _three_d has been changed */
180 boost::filesystem::path directory () const {
184 std::string name () const {
188 bool use_isdcf_name () const {
189 return _use_isdcf_name;
192 DCPContentType const * dcp_content_type () const {
193 return _dcp_content_type;
196 Ratio const * container () const {
200 Resolution resolution () const {
204 Scaler const * scaler () const {
208 bool with_subtitles () const {
209 return _with_subtitles;
212 /* signed is a reserved word */
213 bool is_signed () const {
217 bool encrypted () const {
221 int j2k_bandwidth () const {
222 return _j2k_bandwidth;
225 ISDCFMetadata isdcf_metadata () const {
226 return _isdcf_metadata;
229 /** @return The frame rate of the DCP */
230 int video_frame_rate () const {
231 return _video_frame_rate;
234 int audio_channels () const {
235 return _audio_channels;
238 bool three_d () const {
242 bool sequence_video () const {
243 return _sequence_video;
246 bool interop () const {
253 void set_directory (boost::filesystem::path);
254 void set_name (std::string);
255 void set_use_isdcf_name (bool);
256 void examine_and_add_content (boost::shared_ptr<Content>);
257 void add_content (boost::shared_ptr<Content>);
258 void remove_content (boost::shared_ptr<Content>);
259 void move_content_earlier (boost::shared_ptr<Content>);
260 void move_content_later (boost::shared_ptr<Content>);
261 void set_dcp_content_type (DCPContentType const *);
262 void set_container (Ratio const *);
263 void set_resolution (Resolution);
264 void set_scaler (Scaler const *);
265 void set_with_subtitles (bool);
266 void set_signed (bool);
267 void set_encrypted (bool);
268 void set_j2k_bandwidth (int);
269 void set_isdcf_metadata (ISDCFMetadata);
270 void set_video_frame_rate (int);
271 void set_audio_channels (int);
272 void set_three_d (bool);
273 void set_isdcf_date_today ();
274 void set_sequence_video (bool);
275 void set_interop (bool);
277 /** Emitted when some property has of the Film has changed */
278 mutable boost::signals2::signal<void (Property)> Changed;
280 /** Emitted when some property of our content has changed */
281 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
283 /** Current version number of the state file */
284 static int const current_state_version;
288 friend class ::isdcf_name_test;
290 void signal_changed (Property);
291 std::string video_identifier () const;
292 void playlist_changed ();
293 void playlist_content_changed (boost::weak_ptr<Content>, int);
294 std::string filename_safe_name () const;
295 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
297 /** Log to write to */
298 boost::shared_ptr<Log> _log;
299 boost::shared_ptr<Playlist> _playlist;
301 /** Complete path to directory containing the film metadata;
302 * must not be relative.
304 boost::filesystem::path _directory;
306 /** Name for DCP-o-matic */
308 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
309 bool _use_isdcf_name;
310 /** The type of content that this Film represents (feature, trailer etc.) */
311 DCPContentType const * _dcp_content_type;
312 /** The container to put this Film in (flat, scope, etc.) */
313 Ratio const * _container;
314 /** DCP resolution (2K or 4K) */
315 Resolution _resolution;
316 /** Scaler algorithm to use */
317 Scaler const * _scaler;
318 /** True if subtitles should be shown for this film */
319 bool _with_subtitles;
322 /** bandwidth for J2K files in bits per second */
324 /** ISDCF naming stuff */
325 ISDCFMetadata _isdcf_metadata;
326 /** Frames per second to run our DCP at */
327 int _video_frame_rate;
328 /** The date that we should use in a ISDCF name */
329 boost::gregorian::date _isdcf_date;
330 /** Number of audio channels to put in the DCP */
332 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
333 This will be regardless of what content is on the playlist.
336 bool _sequence_video;
342 /** true if our state has changed since we last saved it */
345 friend class paths_test;
346 friend class film_metadata_test;