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"
34 #include "dcp_text_track.h"
36 #include <dcp/encrypted_kdm.h>
37 #include <boost/signals2.hpp>
38 #include <boost/enable_shared_from_this.hpp>
39 #include <boost/filesystem.hpp>
59 struct isdcf_name_test;
63 * @brief A representation of some audio and video content, and details of
64 * how they should be presented in a DCP.
66 * The content of a Film is held in a Playlist (created and managed by the Film).
68 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
71 explicit Film (boost::optional<boost::filesystem::path> dir);
74 boost::filesystem::path info_file (DCPTimePeriod p) const;
75 boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
76 boost::filesystem::path internal_video_asset_dir () const;
77 boost::filesystem::path internal_video_asset_filename (DCPTimePeriod p) const;
79 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
81 void send_dcp_to_tms ();
85 * It is safe to call this from any thread.
87 boost::shared_ptr<Log> log () const {
91 boost::filesystem::path file (boost::filesystem::path f) const;
92 boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
94 void use_template (std::string name);
95 std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
96 void write_metadata () const;
97 void write_metadata (boost::filesystem::path path) const;
98 void write_template (boost::filesystem::path path) const;
99 boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
101 void copy_from (boost::shared_ptr<const Film> film);
103 std::string isdcf_name (bool if_created_now) const;
104 std::string dcp_name (bool if_created_now = false) const;
106 /** @return true if our state has changed since we last saved it */
107 bool dirty () const {
111 dcp::Size full_frame () const;
112 dcp::Size frame_size () const;
114 std::vector<CPLSummary> cpls () const;
116 int audio_frame_rate () const;
118 std::list<DCPTextTrack> closed_caption_tracks () const;
120 uint64_t required_disk_space () const;
121 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
123 /* Proxies for some Playlist methods */
125 ContentList content () const;
126 DCPTime length () const;
127 int best_video_frame_rate () const;
128 FrameRateChange active_frame_rate_change (DCPTime) const;
129 std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
131 dcp::EncryptedKDM make_kdm (
132 dcp::Certificate recipient,
133 std::vector<std::string> trusted_devices,
134 boost::filesystem::path cpl_file,
136 dcp::LocalTime until,
137 dcp::Formulation formulation,
138 bool disable_forensic_marking_picture,
139 boost::optional<int> disable_forensic_marking_audio
142 std::list<ScreenKDM> make_kdms (
143 std::list<boost::shared_ptr<Screen> > screens,
144 boost::filesystem::path cpl_file,
145 boost::posix_time::ptime from,
146 boost::posix_time::ptime until,
147 dcp::Formulation formulation,
148 bool disable_forensic_marking_picture,
149 boost::optional<int> disable_forensic_marking_audio
152 int state_version () const {
153 return _state_version;
156 std::string subtitle_language () const;
158 std::vector<std::string> audio_output_names () const;
160 void repeat_content (ContentList, int);
162 boost::shared_ptr<const Playlist> playlist () const {
166 std::list<DCPTimePeriod> reels () const;
167 std::list<int> mapped_audio_channels () const;
169 std::string content_summary (DCPTimePeriod period) const;
171 bool references_dcp_video () const;
172 bool references_dcp_audio () const;
174 /** Identifiers for the parts of our state;
175 used for signalling changes.
181 /** The playlist's content list has changed (i.e. content has been added or removed) */
183 /** The order of content in the playlist has changed */
195 /** The setting of _three_d has changed */
202 UPLOAD_AFTER_MAKE_DCP,
209 boost::optional<boost::filesystem::path> directory () const {
213 std::string name () const {
217 bool use_isdcf_name () const {
218 return _use_isdcf_name;
221 DCPContentType const * dcp_content_type () const {
222 return _dcp_content_type;
225 Ratio const * container () const {
229 Resolution resolution () const {
233 /* signed is a reserved word */
234 bool is_signed () const {
238 bool encrypted () const {
242 dcp::Key key () const {
246 int j2k_bandwidth () const {
247 return _j2k_bandwidth;
250 ISDCFMetadata isdcf_metadata () const {
251 return _isdcf_metadata;
254 /** @return The frame rate of the DCP */
255 int video_frame_rate () const {
256 return _video_frame_rate;
259 int audio_channels () const {
260 return _audio_channels;
263 bool three_d () const {
267 bool sequence () const {
271 bool interop () const {
275 AudioProcessor const * audio_processor () const {
276 return _audio_processor;
279 ReelType reel_type () const {
283 int64_t reel_length () const {
287 bool upload_after_make_dcp () const {
288 return _upload_after_make_dcp;
291 std::string context_id () const {
295 bool reencode_j2k () const {
296 return _reencode_j2k;
302 void set_directory (boost::filesystem::path);
303 void set_name (std::string);
304 void set_use_isdcf_name (bool);
305 void examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
306 void add_content (boost::shared_ptr<Content>);
307 void remove_content (boost::shared_ptr<Content>);
308 void remove_content (ContentList);
309 void move_content_earlier (boost::shared_ptr<Content>);
310 void move_content_later (boost::shared_ptr<Content>);
311 void set_dcp_content_type (DCPContentType const *);
312 void set_container (Ratio const *);
313 void set_resolution (Resolution);
314 void set_signed (bool);
315 void set_encrypted (bool);
316 void set_key (dcp::Key key);
317 void set_j2k_bandwidth (int);
318 void set_isdcf_metadata (ISDCFMetadata);
319 void set_video_frame_rate (int rate, bool user_explicit = false);
320 void set_audio_channels (int);
321 void set_three_d (bool);
322 void set_isdcf_date_today ();
323 void set_sequence (bool);
324 void set_interop (bool);
325 void set_audio_processor (AudioProcessor const * processor);
326 void set_reel_type (ReelType);
327 void set_reel_length (int64_t);
328 void set_upload_after_make_dcp (bool);
329 void set_reencode_j2k (bool);
331 /** Emitted when some property has of the Film is about to change or has changed */
332 mutable boost::signals2::signal<void (ChangeType, Property)> Change;
334 /** Emitted when some property of our content has changed */
335 mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
337 /** Emitted when we have something important to tell the user */
338 boost::signals2::signal<void (std::string)> Message;
340 /** Current version number of the state file */
341 static int const current_state_version;
345 friend struct ::isdcf_name_test;
346 template <typename> friend class ChangeSignaller;
348 void signal_change (ChangeType, Property);
349 void signal_change (ChangeType, int);
350 std::string video_identifier () const;
351 void playlist_change (ChangeType);
352 void playlist_order_changed ();
353 void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
354 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
355 void audio_analysis_finished ();
357 static std::string const metadata_file;
359 /** Log to write to */
360 boost::shared_ptr<Log> _log;
361 boost::shared_ptr<Playlist> _playlist;
363 /** Complete path to directory containing the film metadata;
364 * must not be relative.
366 boost::optional<boost::filesystem::path> _directory;
368 /** Name for DCP-o-matic */
370 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
371 bool _use_isdcf_name;
372 /** The type of content that this Film represents (feature, trailer etc.) */
373 DCPContentType const * _dcp_content_type;
374 /** The container to put this Film in (flat, scope, etc.) */
375 Ratio const * _container;
376 /** DCP resolution (2K or 4K) */
377 Resolution _resolution;
381 /** context ID used when encrypting picture assets; we keep it so that we can
382 * re-start picture MXF encodes.
384 std::string _context_id;
385 /** bandwidth for J2K files in bits per second */
387 /** ISDCF naming stuff */
388 ISDCFMetadata _isdcf_metadata;
389 /** Frames per second to run our DCP at */
390 int _video_frame_rate;
391 /** The date that we should use in a ISDCF name */
392 boost::gregorian::date _isdcf_date;
393 /** Number of audio channels requested for the DCP */
395 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
396 This will be regardless of what content is on the playlist.
401 AudioProcessor const * _audio_processor;
403 /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
404 int64_t _reel_length;
405 bool _upload_after_make_dcp;
407 /** true if the user has ever explicitly set the video frame rate of this film */
408 bool _user_explicit_video_frame_rate;
412 /** true if our state has changed since we last saved it */
414 /** film being used as a template, or 0 */
415 boost::shared_ptr<Film> _template_film;
418 boost::signals2::scoped_connection _playlist_change_connection;
419 boost::signals2::scoped_connection _playlist_order_changed_connection;
420 boost::signals2::scoped_connection _playlist_content_change_connection;
421 std::list<boost::signals2::connection> _job_connections;
422 std::list<boost::signals2::connection> _audio_analysis_connections;
424 friend struct paths_test;
425 friend struct film_metadata_test;