2 Copyright (C) 2012-2015 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"
32 #include "signaller.h"
35 #include <dcp/encrypted_kdm.h>
36 #include <boost/signals2.hpp>
37 #include <boost/enable_shared_from_this.hpp>
38 #include <boost/filesystem.hpp>
50 struct isdcf_name_test;
54 * @brief A representation of some audio and video content, and details of
55 * how they should be presented in a DCP.
57 * The content of a Film is held in a Playlist (created and managed by the Film).
59 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
62 Film (boost::filesystem::path, bool log = true);
65 boost::filesystem::path info_file () const;
66 boost::filesystem::path j2c_path (int, Eyes, bool) const;
67 boost::filesystem::path internal_video_mxf_dir () const;
68 boost::filesystem::path internal_video_mxf_filename () const;
69 boost::filesystem::path audio_analysis_dir () const;
71 void send_dcp_to_tms ();
75 * It is safe to call this from any thread.
77 boost::shared_ptr<Log> log () const {
81 boost::filesystem::path file (boost::filesystem::path f) const;
82 boost::filesystem::path dir (boost::filesystem::path d) const;
84 std::list<std::string> read_metadata ();
85 void write_metadata () const;
86 boost::shared_ptr<xmlpp::Document> metadata () const;
88 std::string isdcf_name (bool if_created_now) const;
89 std::string dcp_name (bool if_created_now = false) const;
91 /** @return true if our state has changed since we last saved it */
96 dcp::Size full_frame () const;
97 dcp::Size frame_size () const;
99 std::vector<CPLSummary> cpls () const;
101 boost::shared_ptr<Player> make_player () const;
102 boost::shared_ptr<Playlist> playlist () const;
104 int audio_frame_rate () const;
106 uint64_t required_disk_space () const;
107 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
109 /* Proxies for some Playlist methods */
111 ContentList content () const;
112 DCPTime length () const;
113 int best_video_frame_rate () const;
114 FrameRateChange active_frame_rate_change (DCPTime) const;
118 dcp::Certificate target,
119 boost::filesystem::path cpl_file,
121 dcp::LocalTime until,
122 dcp::Formulation formulation
125 std::list<dcp::EncryptedKDM> make_kdms (
126 std::list<boost::shared_ptr<Screen> >,
127 boost::filesystem::path cpl_file,
129 dcp::LocalTime until,
130 dcp::Formulation formulation
133 int state_version () const {
134 return _state_version;
137 std::string subtitle_language () const;
139 /** Identifiers for the parts of our state;
140 used for signalling changes.
146 /** The playlist's content list has changed (i.e. content has been added or removed) */
158 /** The setting of _three_d has changed */
162 /** The setting of _burn_subtitles has changed */
169 boost::filesystem::path directory () const {
173 std::string name () const {
177 bool use_isdcf_name () const {
178 return _use_isdcf_name;
181 DCPContentType const * dcp_content_type () const {
182 return _dcp_content_type;
185 Ratio const * container () const {
189 Resolution resolution () const {
193 /* signed is a reserved word */
194 bool is_signed () const {
198 bool encrypted () const {
202 dcp::Key key () const {
206 int j2k_bandwidth () const {
207 return _j2k_bandwidth;
210 ISDCFMetadata isdcf_metadata () const {
211 return _isdcf_metadata;
214 /** @return The frame rate of the DCP */
215 int video_frame_rate () const {
216 return _video_frame_rate;
219 int audio_channels () const {
220 return _audio_channels;
223 bool three_d () const {
227 bool sequence_video () const {
228 return _sequence_video;
231 bool interop () const {
235 bool burn_subtitles () const {
236 return _burn_subtitles;
242 void set_directory (boost::filesystem::path);
243 void set_name (std::string);
244 void set_use_isdcf_name (bool);
245 void examine_content (boost::shared_ptr<Content>);
246 void examine_and_add_content (boost::shared_ptr<Content>);
247 void add_content (boost::shared_ptr<Content>);
248 void remove_content (boost::shared_ptr<Content>);
249 void move_content_earlier (boost::shared_ptr<Content>);
250 void move_content_later (boost::shared_ptr<Content>);
251 void set_dcp_content_type (DCPContentType const *);
252 void set_container (Ratio const *);
253 void set_resolution (Resolution);
254 void set_signed (bool);
255 void set_encrypted (bool);
256 void set_key (dcp::Key key);
257 void set_j2k_bandwidth (int);
258 void set_isdcf_metadata (ISDCFMetadata);
259 void set_video_frame_rate (int);
260 void set_audio_channels (int);
261 void set_three_d (bool);
262 void set_isdcf_date_today ();
263 void set_sequence_video (bool);
264 void set_interop (bool);
265 void set_burn_subtitles (bool);
267 /** Emitted when some property has of the Film has changed */
268 mutable boost::signals2::signal<void (Property)> Changed;
270 /** Emitted when some property of our content has changed */
271 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
273 /** Current version number of the state file */
274 static int const current_state_version;
278 friend struct ::isdcf_name_test;
280 void signal_changed (Property);
281 std::string video_identifier () const;
282 void playlist_changed ();
283 void playlist_content_changed (boost::weak_ptr<Content>, int);
284 std::string filename_safe_name () const;
285 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
287 /** Log to write to */
288 boost::shared_ptr<Log> _log;
289 boost::shared_ptr<Playlist> _playlist;
291 /** Complete path to directory containing the film metadata;
292 * must not be relative.
294 boost::filesystem::path _directory;
296 /** Name for DCP-o-matic */
298 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
299 bool _use_isdcf_name;
300 /** The type of content that this Film represents (feature, trailer etc.) */
301 DCPContentType const * _dcp_content_type;
302 /** The container to put this Film in (flat, scope, etc.) */
303 Ratio const * _container;
304 /** DCP resolution (2K or 4K) */
305 Resolution _resolution;
308 /** bandwidth for J2K files in bits per second */
310 /** ISDCF naming stuff */
311 ISDCFMetadata _isdcf_metadata;
312 /** Frames per second to run our DCP at */
313 int _video_frame_rate;
314 /** The date that we should use in a ISDCF name */
315 boost::gregorian::date _isdcf_date;
316 /** Number of audio channels to put in the DCP */
318 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
319 This will be regardless of what content is on the playlist.
322 bool _sequence_video;
324 bool _burn_subtitles;
329 /** true if our state has changed since we last saved it */
332 boost::signals2::scoped_connection _playlist_changed_connection;
333 boost::signals2::scoped_connection _playlist_content_changed_connection;
334 std::list<boost::signals2::connection> _job_connections;
336 friend struct paths_test;
337 friend struct film_metadata_test;