2 Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 * @brief A representation of some audio and video content, and details of
23 * how they should be presented in a DCP.
26 #ifndef DCPOMATIC_FILM_H
27 #define DCPOMATIC_FILM_H
31 #include "isdcf_metadata.h"
32 #include "frame_rate_change.h"
33 #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>
58 struct isdcf_name_test;
62 * @brief A representation of some audio and video content, and details of
63 * how they should be presented in a DCP.
65 * The content of a Film is held in a Playlist (created and managed by the Film).
67 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
70 Film (boost::optional<boost::filesystem::path> dir);
73 boost::filesystem::path info_file (DCPTimePeriod p) const;
74 boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
75 boost::filesystem::path internal_video_asset_dir () const;
76 boost::filesystem::path internal_video_asset_filename (DCPTimePeriod p) const;
78 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
80 void send_dcp_to_tms ();
84 * It is safe to call this from any thread.
86 boost::shared_ptr<Log> log () const {
90 boost::filesystem::path file (boost::filesystem::path f) const;
91 boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
93 void use_template (std::string name);
94 std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
95 void write_metadata () const;
96 void write_template (boost::filesystem::path path) const;
97 boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
99 void copy_from (boost::shared_ptr<const Film> film);
101 std::string isdcf_name (bool if_created_now) const;
102 std::string dcp_name (bool if_created_now = false) const;
104 /** @return true if our state has changed since we last saved it */
105 bool dirty () const {
109 dcp::Size full_frame () const;
110 dcp::Size frame_size () const;
112 std::vector<CPLSummary> cpls () const;
114 int audio_frame_rate () const;
116 uint64_t required_disk_space () const;
117 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
119 /* Proxies for some Playlist methods */
121 ContentList content () const;
122 DCPTime length () const;
123 int best_video_frame_rate () const;
124 FrameRateChange active_frame_rate_change (DCPTime) const;
125 std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
127 dcp::EncryptedKDM make_kdm (
128 dcp::Certificate recipient,
129 std::vector<dcp::Certificate> trusted_devices,
130 boost::filesystem::path cpl_file,
132 dcp::LocalTime until,
133 dcp::Formulation formulation
136 std::list<ScreenKDM> make_kdms (
137 std::list<boost::shared_ptr<Screen> > screens,
138 boost::filesystem::path cpl_file,
139 boost::posix_time::ptime from,
140 boost::posix_time::ptime until,
141 dcp::Formulation formulation
144 int state_version () const {
145 return _state_version;
148 std::string subtitle_language () const;
150 void make_audio_mapping_default (
151 AudioMapping & mapping,
152 boost::optional<boost::filesystem::path> filename = boost::optional<boost::filesystem::path> ()
155 std::vector<std::string> audio_output_names () const;
157 void repeat_content (ContentList, int);
159 boost::shared_ptr<const Playlist> playlist () const {
163 std::list<DCPTimePeriod> reels () const;
164 std::list<int> mapped_audio_channels () const;
166 std::string content_summary (DCPTimePeriod period) const;
168 std::list<std::string> fix_conflicting_settings ();
170 bool references_dcp_video () const;
171 bool references_dcp_audio () const;
173 /** Identifiers for the parts of our state;
174 used for signalling changes.
180 /** The playlist's content list has changed (i.e. content has been added or removed) */
182 /** The order of content in the playlist has changed */
194 /** The setting of _three_d has changed */
201 UPLOAD_AFTER_MAKE_DCP
207 boost::optional<boost::filesystem::path> directory () const {
211 std::string name () const {
215 bool use_isdcf_name () const {
216 return _use_isdcf_name;
219 DCPContentType const * dcp_content_type () const {
220 return _dcp_content_type;
223 Ratio const * container () const {
227 Resolution resolution () const {
231 /* signed is a reserved word */
232 bool is_signed () const {
236 bool encrypted () const {
240 dcp::Key key () const {
244 int j2k_bandwidth () const {
245 return _j2k_bandwidth;
248 ISDCFMetadata isdcf_metadata () const {
249 return _isdcf_metadata;
252 /** @return The frame rate of the DCP */
253 int video_frame_rate () const {
254 return _video_frame_rate;
257 int audio_channels () const {
258 return _audio_channels;
261 bool three_d () const {
265 bool sequence () const {
269 bool interop () const {
273 AudioProcessor const * audio_processor () const {
274 return _audio_processor;
277 ReelType reel_type () const {
281 int64_t reel_length () const {
285 bool upload_after_make_dcp () const {
286 return _upload_after_make_dcp;
289 std::string context_id () const {
296 void set_directory (boost::filesystem::path);
297 void set_name (std::string);
298 void set_use_isdcf_name (bool);
299 void examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
300 void add_content (boost::shared_ptr<Content>);
301 void remove_content (boost::shared_ptr<Content>);
302 void remove_content (ContentList);
303 void move_content_earlier (boost::shared_ptr<Content>);
304 void move_content_later (boost::shared_ptr<Content>);
305 void set_dcp_content_type (DCPContentType const *);
306 void set_container (Ratio const *);
307 void set_resolution (Resolution);
308 void set_signed (bool);
309 void set_encrypted (bool);
310 void set_key (dcp::Key key);
311 void set_j2k_bandwidth (int);
312 void set_isdcf_metadata (ISDCFMetadata);
313 void set_video_frame_rate (int);
314 void set_audio_channels (int);
315 void set_three_d (bool);
316 void set_isdcf_date_today ();
317 void set_sequence (bool);
318 void set_interop (bool);
319 void set_audio_processor (AudioProcessor const * processor);
320 void set_reel_type (ReelType);
321 void set_reel_length (int64_t);
322 void set_upload_after_make_dcp (bool);
324 /** Emitted when some property has of the Film has changed */
325 mutable boost::signals2::signal<void (Property)> Changed;
327 /** Emitted when some property of our content has changed */
328 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
330 /** Current version number of the state file */
331 static int const current_state_version;
335 friend struct ::isdcf_name_test;
337 void signal_changed (Property);
338 std::string video_identifier () const;
339 void playlist_changed ();
340 void playlist_order_changed ();
341 void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
342 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
343 void audio_analysis_finished ();
345 static std::string const metadata_file;
347 /** Log to write to */
348 boost::shared_ptr<Log> _log;
349 boost::shared_ptr<Playlist> _playlist;
351 /** Complete path to directory containing the film metadata;
352 * must not be relative.
354 boost::optional<boost::filesystem::path> _directory;
356 /** Name for DCP-o-matic */
358 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
359 bool _use_isdcf_name;
360 /** The type of content that this Film represents (feature, trailer etc.) */
361 DCPContentType const * _dcp_content_type;
362 /** The container to put this Film in (flat, scope, etc.) */
363 Ratio const * _container;
364 /** DCP resolution (2K or 4K) */
365 Resolution _resolution;
369 /** context ID used when encrypting picture assets; we keep it so that we can
370 * re-start picture MXF encodes.
372 std::string _context_id;
373 /** bandwidth for J2K files in bits per second */
375 /** ISDCF naming stuff */
376 ISDCFMetadata _isdcf_metadata;
377 /** Frames per second to run our DCP at */
378 int _video_frame_rate;
379 /** The date that we should use in a ISDCF name */
380 boost::gregorian::date _isdcf_date;
381 /** Number of audio channels requested for the DCP */
383 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
384 This will be regardless of what content is on the playlist.
389 AudioProcessor const * _audio_processor;
391 /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
392 int64_t _reel_length;
393 bool _upload_after_make_dcp;
397 /** true if our state has changed since we last saved it */
399 /** film being used as a template, or 0 */
400 boost::shared_ptr<Film> _template_film;
402 boost::signals2::scoped_connection _playlist_changed_connection;
403 boost::signals2::scoped_connection _playlist_order_changed_connection;
404 boost::signals2::scoped_connection _playlist_content_changed_connection;
405 std::list<boost::signals2::connection> _job_connections;
406 std::list<boost::signals2::connection> _audio_analysis_connections;
408 friend struct paths_test;
409 friend struct film_metadata_test;