2 Copyright (C) 2012-2020 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/thread.hpp>
40 #include <boost/filesystem.hpp>
41 #include <boost/thread/mutex.hpp>
63 struct isdcf_name_test;
64 struct recover_test_2d_encrypted;
75 boost::filesystem::path file () const {
82 InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
84 boost::mutex::scoped_lock _lock;
86 boost::filesystem::path _file;
91 * @brief A representation of some audio, video, subtitle and closed-caption content,
92 * and details of how they should be presented in a DCP.
94 * The content of a Film is held in a Playlist (created and managed by the Film).
96 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
99 explicit Film (boost::optional<boost::filesystem::path> dir);
102 boost::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
103 boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
104 boost::filesystem::path internal_video_asset_dir () const;
105 boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
107 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
108 boost::filesystem::path subtitle_analysis_path (boost::shared_ptr<const Content>) const;
110 void send_dcp_to_tms ();
111 void make_dcp (bool gui = false, bool check = true);
114 * It is safe to call this from any thread.
116 boost::shared_ptr<Log> log () const {
120 boost::filesystem::path file (boost::filesystem::path f) const;
121 boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
123 void use_template (std::string name);
124 std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
125 void write_metadata () const;
126 void write_metadata (boost::filesystem::path path) const;
127 void write_template (boost::filesystem::path path) const;
128 boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
130 void copy_from (boost::shared_ptr<const Film> film);
132 std::string isdcf_name (bool if_created_now) const;
133 std::string dcp_name (bool if_created_now = false) const;
135 /** @return true if our state has changed since we last saved it */
136 bool dirty () const {
140 dcp::Size full_frame () const;
141 dcp::Size frame_size () const;
143 std::vector<CPLSummary> cpls () const;
145 int audio_frame_rate () const;
147 std::list<DCPTextTrack> closed_caption_tracks () const;
149 uint64_t required_disk_space () const;
150 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
152 /* Proxies for some Playlist methods */
154 ContentList content () const;
155 dcpomatic::DCPTime length () const;
156 int best_video_frame_rate () const;
157 FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
158 std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
160 dcp::EncryptedKDM make_kdm (
161 dcp::Certificate recipient,
162 std::vector<std::string> trusted_devices,
163 boost::filesystem::path cpl_file,
165 dcp::LocalTime until,
166 dcp::Formulation formulation,
167 bool disable_forensic_marking_picture,
168 boost::optional<int> disable_forensic_marking_audio
171 int state_version () const {
172 return _state_version;
175 std::string subtitle_language () const;
177 std::vector<std::string> audio_output_names () const;
179 void repeat_content (ContentList, int);
181 boost::shared_ptr<const Playlist> playlist () const {
185 std::list<dcpomatic::DCPTimePeriod> reels () const;
186 std::list<int> mapped_audio_channels () const;
188 std::string content_summary (dcpomatic::DCPTimePeriod period) const;
190 bool references_dcp_video () const;
191 bool references_dcp_audio () const;
193 void set_tolerant (bool t) {
197 bool tolerant () const {
201 /** Identifiers for the parts of our state;
202 used for signalling changes.
208 /** The playlist's content list has changed (i.e. content has been added or removed) */
210 /** The order of content in the playlist has changed */
220 /** The setting of _three_d has changed */
236 boost::optional<boost::filesystem::path> directory () const {
240 std::string name () const {
244 bool use_isdcf_name () const {
245 return _use_isdcf_name;
248 DCPContentType const * dcp_content_type () const {
249 return _dcp_content_type;
252 Ratio const * container () const {
256 Resolution resolution () const {
260 bool encrypted () const {
264 dcp::Key key () const {
268 int j2k_bandwidth () const {
269 return _j2k_bandwidth;
272 ISDCFMetadata isdcf_metadata () const {
273 return _isdcf_metadata;
276 /** @return The frame rate of the DCP */
277 int video_frame_rate () const {
278 return _video_frame_rate;
281 int audio_channels () const {
282 return _audio_channels;
285 bool three_d () const {
289 bool sequence () const {
293 bool interop () const {
297 AudioProcessor const * audio_processor () const {
298 return _audio_processor;
301 ReelType reel_type () const {
305 int64_t reel_length () const {
309 std::string context_id () const {
313 bool reencode_j2k () const {
314 return _reencode_j2k;
317 boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
318 std::map<dcp::Marker, dcpomatic::DCPTime> markers () const {
322 std::vector<dcp::Rating> ratings () const {
326 std::string content_version () const {
327 return _content_version;
332 void set_directory (boost::filesystem::path);
333 void set_name (std::string);
334 void set_use_isdcf_name (bool);
335 void examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
336 void add_content (boost::shared_ptr<Content>);
337 void remove_content (boost::shared_ptr<Content>);
338 void remove_content (ContentList);
339 void move_content_earlier (boost::shared_ptr<Content>);
340 void move_content_later (boost::shared_ptr<Content>);
341 void set_dcp_content_type (DCPContentType const *);
342 void set_container (Ratio const *, bool user_explicit = true);
343 void set_resolution (Resolution, bool user_explicit = true);
344 void set_encrypted (bool);
345 void set_j2k_bandwidth (int);
346 void set_isdcf_metadata (ISDCFMetadata);
347 void set_video_frame_rate (int rate, bool user_explicit = false);
348 void set_audio_channels (int);
349 void set_three_d (bool);
350 void set_isdcf_date_today ();
351 void set_sequence (bool);
352 void set_interop (bool);
353 void set_audio_processor (AudioProcessor const * processor);
354 void set_reel_type (ReelType);
355 void set_reel_length (int64_t);
356 void set_reencode_j2k (bool);
357 void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
358 void unset_marker (dcp::Marker type);
359 void clear_markers ();
360 void set_ratings (std::vector<dcp::Rating> r);
361 void set_content_version (std::string v);
363 /** Emitted when some property has of the Film is about to change or has changed */
364 mutable boost::signals2::signal<void (ChangeType, Property)> Change;
366 /** Emitted when some property of our content has changed */
367 mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
369 /** Emitted when the film's length might have changed; this is not like a normal
370 property as its value is derived from the playlist, so it has its own signal.
372 mutable boost::signals2::signal<void ()> LengthChange;
374 /** Emitted when we have something important to tell the user */
375 boost::signals2::signal<void (std::string)> Message;
377 /** Current version number of the state file */
378 static int const current_state_version;
382 friend struct ::isdcf_name_test;
383 friend struct ::recover_test_2d_encrypted;
384 template <typename> friend class ChangeSignaller;
386 boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
388 void signal_change (ChangeType, Property);
389 void signal_change (ChangeType, int);
390 std::string video_identifier () const;
391 void playlist_change (ChangeType);
392 void playlist_order_changed ();
393 void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
394 void playlist_length_change ();
395 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
396 void audio_analysis_finished ();
397 void check_settings_consistency ();
398 void maybe_set_container_and_resolution ();
400 static std::string const metadata_file;
402 /** Log to write to */
403 boost::shared_ptr<Log> _log;
404 boost::shared_ptr<Playlist> _playlist;
406 /** Complete path to directory containing the film metadata;
407 * must not be relative.
409 boost::optional<boost::filesystem::path> _directory;
411 /** Name for DCP-o-matic */
413 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
414 bool _use_isdcf_name;
415 /** The type of content that this Film represents (feature, trailer etc.) */
416 DCPContentType const * _dcp_content_type;
417 /** The container to put this Film in (flat, scope, etc.) */
418 Ratio const * _container;
419 /** DCP resolution (2K or 4K) */
420 Resolution _resolution;
423 /** context ID used when encrypting picture assets; we keep it so that we can
424 * re-start picture MXF encodes.
426 std::string _context_id;
427 /** bandwidth for J2K files in bits per second */
429 /** ISDCF naming stuff */
430 ISDCFMetadata _isdcf_metadata;
431 /** Frames per second to run our DCP at */
432 int _video_frame_rate;
433 /** The date that we should use in a ISDCF name */
434 boost::gregorian::date _isdcf_date;
435 /** Number of audio channels requested for the DCP */
437 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
438 This will be regardless of what content is on the playlist.
443 AudioProcessor const * _audio_processor;
445 /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
446 int64_t _reel_length;
448 /** true if the user has ever explicitly set the video frame rate of this film */
449 bool _user_explicit_video_frame_rate;
450 bool _user_explicit_container;
451 bool _user_explicit_resolution;
452 std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
453 std::vector<dcp::Rating> _ratings;
454 std::string _content_version;
458 /** true if our state has changed since we last saved it */
460 /** film being used as a template, or 0 */
461 boost::shared_ptr<Film> _template_film;
463 /** Be tolerant of errors in content (currently applies to DCP only).
468 mutable boost::mutex _info_file_mutex;
470 boost::signals2::scoped_connection _playlist_change_connection;
471 boost::signals2::scoped_connection _playlist_order_changed_connection;
472 boost::signals2::scoped_connection _playlist_content_change_connection;
473 boost::signals2::scoped_connection _playlist_length_change_connection;
474 std::list<boost::signals2::connection> _job_connections;
475 std::list<boost::signals2::connection> _audio_analysis_connections;
477 friend struct paths_test;
478 friend struct film_metadata_test;