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
30 #include "isdcf_metadata.h"
31 #include "frame_rate_change.h"
33 #include <dcp/encrypted_kdm.h>
34 #include <boost/signals2.hpp>
35 #include <boost/enable_shared_from_this.hpp>
36 #include <boost/filesystem.hpp>
49 struct 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;
72 boost::filesystem::path subtitle_xml_filename () const;
74 void send_dcp_to_tms ();
78 * It is safe to call this from any thread.
80 boost::shared_ptr<Log> log () const {
84 int encoded_frames () const;
86 boost::filesystem::path file (boost::filesystem::path f) const;
87 boost::filesystem::path dir (boost::filesystem::path d) const;
89 std::list<std::string> read_metadata ();
90 void write_metadata () const;
91 boost::shared_ptr<xmlpp::Document> metadata () const;
93 std::string isdcf_name (bool if_created_now) const;
94 std::string dcp_name (bool if_created_now = false) const;
96 /** @return true if our state has changed since we last saved it */
101 dcp::Size full_frame () const;
102 dcp::Size frame_size () const;
104 std::vector<CPLSummary> cpls () const;
106 boost::shared_ptr<Player> make_player () const;
107 boost::shared_ptr<Playlist> playlist () const;
109 int audio_frame_rate () const;
111 uint64_t required_disk_space () const;
112 bool should_be_enough_disk_space (double &, double &) const;
114 /* Proxies for some Playlist methods */
116 ContentList content () const;
117 DCPTime length () const;
118 int best_video_frame_rate () const;
119 FrameRateChange active_frame_rate_change (DCPTime) const;
123 dcp::Certificate target,
124 boost::filesystem::path cpl_file,
126 dcp::LocalTime until,
127 dcp::Formulation formulation
130 std::list<dcp::EncryptedKDM> make_kdms (
131 std::list<boost::shared_ptr<Screen> >,
132 boost::filesystem::path cpl_file,
134 dcp::LocalTime until,
135 dcp::Formulation formulation
138 dcp::Key key () const {
142 int state_version () const {
143 return _state_version;
146 std::string subtitle_language () const;
148 /** Identifiers for the parts of our state;
149 used for signalling changes.
155 /** The playlist's content list has changed (i.e. content has been added or removed) */
167 /** The setting of _three_d has changed */
171 /** The setting of _burn_subtitles has changed */
178 boost::filesystem::path directory () const {
182 std::string name () const {
186 bool use_isdcf_name () const {
187 return _use_isdcf_name;
190 DCPContentType const * dcp_content_type () const {
191 return _dcp_content_type;
194 Ratio const * container () const {
198 Resolution resolution () const {
202 Scaler const * scaler () const {
206 /* signed is a reserved word */
207 bool is_signed () const {
211 bool encrypted () const {
215 int j2k_bandwidth () const {
216 return _j2k_bandwidth;
219 ISDCFMetadata isdcf_metadata () const {
220 return _isdcf_metadata;
223 /** @return The frame rate of the DCP */
224 int video_frame_rate () const {
225 return _video_frame_rate;
228 int audio_channels () const {
229 return _audio_channels;
232 bool three_d () const {
236 bool sequence_video () const {
237 return _sequence_video;
240 bool interop () const {
244 bool burn_subtitles () const {
245 return _burn_subtitles;
251 void set_directory (boost::filesystem::path);
252 void set_name (std::string);
253 void set_use_isdcf_name (bool);
254 void examine_content (boost::shared_ptr<Content>, bool calculate_digest);
255 void examine_and_add_content (boost::shared_ptr<Content>, bool calculate_digest);
256 void add_content (boost::shared_ptr<Content>);
257 void remove_content (boost::shared_ptr<Content>);
258 void move_content_earlier (boost::shared_ptr<Content>);
259 void move_content_later (boost::shared_ptr<Content>);
260 void set_dcp_content_type (DCPContentType const *);
261 void set_container (Ratio const *);
262 void set_resolution (Resolution);
263 void set_scaler (Scaler const *);
264 void set_signed (bool);
265 void set_encrypted (bool);
266 void set_j2k_bandwidth (int);
267 void set_isdcf_metadata (ISDCFMetadata);
268 void set_video_frame_rate (int);
269 void set_audio_channels (int);
270 void set_three_d (bool);
271 void set_isdcf_date_today ();
272 void set_sequence_video (bool);
273 void set_interop (bool);
274 void set_burn_subtitles (bool);
276 /** Emitted when some property has of the Film has changed */
277 mutable boost::signals2::signal<void (Property)> Changed;
279 /** Emitted when some property of our content has changed */
280 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
282 /** Current version number of the state file */
283 static int const current_state_version;
287 friend struct ::isdcf_name_test;
289 void signal_changed (Property);
290 std::string video_identifier () const;
291 void playlist_changed ();
292 void playlist_content_changed (boost::weak_ptr<Content>, int);
293 std::string filename_safe_name () const;
294 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
296 /** Log to write to */
297 boost::shared_ptr<Log> _log;
298 boost::shared_ptr<Playlist> _playlist;
300 /** Complete path to directory containing the film metadata;
301 * must not be relative.
303 boost::filesystem::path _directory;
305 /** Name for DCP-o-matic */
307 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
308 bool _use_isdcf_name;
309 /** The type of content that this Film represents (feature, trailer etc.) */
310 DCPContentType const * _dcp_content_type;
311 /** The container to put this Film in (flat, scope, etc.) */
312 Ratio const * _container;
313 /** DCP resolution (2K or 4K) */
314 Resolution _resolution;
315 /** Scaler algorithm to use */
316 Scaler const * _scaler;
319 /** bandwidth for J2K files in bits per second */
321 /** ISDCF naming stuff */
322 ISDCFMetadata _isdcf_metadata;
323 /** Frames per second to run our DCP at */
324 int _video_frame_rate;
325 /** The date that we should use in a ISDCF name */
326 boost::gregorian::date _isdcf_date;
327 /** Number of audio channels to put in the DCP */
329 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
330 This will be regardless of what content is on the playlist.
333 bool _sequence_video;
335 bool _burn_subtitles;
340 /** true if our state has changed since we last saved it */
343 friend struct paths_test;
344 friend struct film_metadata_test;