/*
- Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
- This program is free software; you can redistribute it and/or modify
+ This file is part of DCP-o-matic.
+
+ DCP-o-matic is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
- This program is distributed in the hope that it will be useful,
+ DCP-o-matic is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
*/
+
/** @file src/film.h
* @brief A representation of some audio and video content, and details of
* how they should be presented in a DCP.
*/
+
#ifndef DCPOMATIC_FILM_H
#define DCPOMATIC_FILM_H
+
+#include "change_signaller.h"
+#include "dcp_text_track.h"
+#include "frame_rate_change.h"
+#include "signaller.h"
+#include "transcode_job.h"
+#include "types.h"
+#include "util.h"
+#include <dcp/encrypted_kdm.h>
+#include <dcp/file.h>
+#include <dcp/key.h>
+#include <dcp/language_tag.h>
+#include <dcp/rating.h>
+#include <boost/filesystem.hpp>
+#include <boost/signals2.hpp>
+#include <boost/thread.hpp>
+#include <boost/thread/mutex.hpp>
+#include <inttypes.h>
#include <string>
#include <vector>
-#include <inttypes.h>
-#include <boost/signals2.hpp>
-#include <boost/enable_shared_from_this.hpp>
-#include <boost/filesystem.hpp>
-#include <dcp/key.h>
-#include <dcp/decrypted_kdm.h>
-#include <dcp/encrypted_kdm.h>
-#include "util.h"
-#include "types.h"
-#include "isdcf_metadata.h"
-#include "frame_rate_change.h"
+
+
+namespace xmlpp {
+ class Document;
+}
+
+namespace dcpomatic {
+ class Screen;
+}
class DCPContentType;
class Log;
class Content;
-class Player;
class Playlist;
class AudioContent;
-class Scaler;
-class Screen;
+class AudioProcessor;
+class Ratio;
+class Job;
+class Film;
struct isdcf_name_test;
+struct recover_test_2d_encrypted;
+struct atmos_encrypted_passthrough_test;
+
+
+class InfoFileHandle
+{
+public:
+ InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
+
+ dcp::File& get () {
+ return _file;
+ }
+
+private:
+ friend class Film;
+
+ boost::mutex::scoped_lock _lock;
+ dcp::File _file;
+};
+
/** @class Film
*
- * @brief A representation of some audio and video content, and details of
- * how they should be presented in a DCP.
+ * @brief A representation of some audio, video, subtitle and closed-caption content,
+ * and details of how they should be presented in a DCP.
*
* The content of a Film is held in a Playlist (created and managed by the Film).
*/
-class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
+class Film : public std::enable_shared_from_this<Film>, public Signaller
{
public:
- Film (boost::filesystem::path, bool log = true);
+ explicit Film (boost::optional<boost::filesystem::path> dir);
+ ~Film ();
+
+ Film (Film const&) = delete;
+ Film& operator= (Film const&) = delete;
- boost::filesystem::path info_dir () const;
- boost::filesystem::path j2c_path (int, Eyes, bool) const;
- boost::filesystem::path info_path (int, Eyes) const;
- boost::filesystem::path internal_video_mxf_dir () const;
- boost::filesystem::path internal_video_mxf_filename () const;
- boost::filesystem::path audio_analysis_dir () const;
+ std::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
+ boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
+ boost::filesystem::path internal_video_asset_dir () const;
+ boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
- boost::filesystem::path video_mxf_filename () const;
- boost::filesystem::path audio_mxf_filename () const;
- boost::filesystem::path subtitle_xml_filename () const;
+ boost::filesystem::path audio_analysis_path (std::shared_ptr<const Playlist>) const;
+ boost::filesystem::path subtitle_analysis_path (std::shared_ptr<const Content>) const;
void send_dcp_to_tms ();
- void make_dcp ();
/** @return Logger.
* It is safe to call this from any thread.
*/
- boost::shared_ptr<Log> log () const {
+ std::shared_ptr<Log> log () const {
return _log;
}
- int encoded_frames () const;
-
boost::filesystem::path file (boost::filesystem::path f) const;
- boost::filesystem::path dir (boost::filesystem::path d) const;
+ boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
+
+ void use_template (std::string name);
+ std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
+ void write_metadata ();
+ void write_metadata (boost::filesystem::path path) const;
+ void write_template (boost::filesystem::path path) const;
+ std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
- std::list<std::string> read_metadata ();
- void write_metadata () const;
- boost::shared_ptr<xmlpp::Document> metadata () const;
+ void copy_from (std::shared_ptr<const Film> film);
std::string isdcf_name (bool if_created_now) const;
std::string dcp_name (bool if_created_now = false) const;
dcp::Size full_frame () const;
dcp::Size frame_size () const;
+ dcp::Size active_area () const;
std::vector<CPLSummary> cpls () const;
- boost::shared_ptr<Player> make_player () const;
- boost::shared_ptr<Playlist> playlist () const;
-
- int audio_frame_rate () const;
+ std::list<DCPTextTrack> closed_caption_tracks () const;
uint64_t required_disk_space () const;
- bool should_be_enough_disk_space (double &, double &) const;
-
+ bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
+
+ bool has_sign_language_video_channel () const;
+
/* Proxies for some Playlist methods */
ContentList content () const;
- DCPTime length () const;
+ dcpomatic::DCPTime length () const;
int best_video_frame_rate () const;
- FrameRateChange active_frame_rate_change (DCPTime) const;
+ FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
+ std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
- dcp::EncryptedKDM
- make_kdm (
- dcp::Certificate target,
- boost::filesystem::path cpl_file,
- dcp::LocalTime from,
- dcp::LocalTime until,
- dcp::Formulation formulation
- ) const;
-
- std::list<dcp::EncryptedKDM> make_kdms (
- std::list<boost::shared_ptr<Screen> >,
+ dcp::EncryptedKDM make_kdm (
+ dcp::Certificate recipient,
+ std::vector<std::string> trusted_devices,
boost::filesystem::path cpl_file,
dcp::LocalTime from,
dcp::LocalTime until,
- dcp::Formulation formulation
+ dcp::Formulation formulation,
+ bool disable_forensic_marking_picture,
+ boost::optional<int> disable_forensic_marking_audio
) const;
- dcp::Key key () const {
- return _key;
- }
-
int state_version () const {
return _state_version;
}
+ std::vector<NamedChannel> audio_output_names () const;
+
+ void repeat_content (ContentList, int);
+
+ std::shared_ptr<const Playlist> playlist () const {
+ return _playlist;
+ }
+
+ std::list<dcpomatic::DCPTimePeriod> reels () const;
+ std::list<int> mapped_audio_channels () const;
+
+ boost::optional<dcp::LanguageTag> audio_language () const {
+ return _audio_language;
+ }
+
+ /** @return pair containing the main subtitle language, and additional languages */
+ std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages () const;
+
+ std::string content_summary (dcpomatic::DCPTimePeriod period) const;
+
+ bool references_dcp_video () const;
+ bool references_dcp_audio () const;
+ bool contains_atmos_content () const;
+
+ void set_tolerant (bool t) {
+ _tolerant = t;
+ }
+
+ bool tolerant () const {
+ return _tolerant;
+ }
+
+ bool last_written_by_earlier_than(int major, int minor, int micro) const;
+
/** Identifiers for the parts of our state;
used for signalling changes.
*/
- enum Property {
+ enum class Property {
NONE,
NAME,
USE_ISDCF_NAME,
/** The playlist's content list has changed (i.e. content has been added or removed) */
CONTENT,
+ /** The order of content in the playlist has changed */
+ CONTENT_ORDER,
DCP_CONTENT_TYPE,
CONTAINER,
RESOLUTION,
- SCALER,
- SIGNED,
ENCRYPTED,
J2K_BANDWIDTH,
- ISDCF_METADATA,
VIDEO_FRAME_RATE,
+ AUDIO_FRAME_RATE,
AUDIO_CHANNELS,
/** The setting of _three_d has changed */
THREE_D,
- SEQUENCE_VIDEO,
+ SEQUENCE,
INTEROP,
- /** The setting of _burn_subtitles has changed */
- BURN_SUBTITLES,
+ AUDIO_PROCESSOR,
+ REEL_TYPE,
+ REEL_LENGTH,
+ REENCODE_J2K,
+ MARKERS,
+ RATINGS,
+ CONTENT_VERSIONS,
+ NAME_LANGUAGE,
+ AUDIO_LANGUAGE,
+ RELEASE_TERRITORY,
+ SIGN_LANGUAGE_VIDEO_LANGUAGE,
+ VERSION_NUMBER,
+ STATUS,
+ CHAIN,
+ DISTRIBUTOR,
+ FACILITY,
+ STUDIO,
+ TEMP_VERSION,
+ PRE_RELEASE,
+ RED_BAND,
+ TWO_D_VERSION_OF_THREE_D,
+ LUMINANCE,
+ WRITE_CPL_METADATA,
};
/* GET */
- boost::filesystem::path directory () const {
+ boost::optional<boost::filesystem::path> directory () const {
return _directory;
}
return _resolution;
}
- Scaler const * scaler () const {
- return _scaler;
- }
-
- /* signed is a reserved word */
- bool is_signed () const {
- return _signed;
- }
-
bool encrypted () const {
return _encrypted;
}
- int j2k_bandwidth () const {
- return _j2k_bandwidth;
+ dcp::Key key () const {
+ return _key;
}
- ISDCFMetadata isdcf_metadata () const {
- return _isdcf_metadata;
+ int j2k_bandwidth () const {
+ return _j2k_bandwidth;
}
/** @return The frame rate of the DCP */
return _three_d;
}
- bool sequence_video () const {
- return _sequence_video;
+ bool sequence () const {
+ return _sequence;
}
bool interop () const {
return _interop;
}
- bool burn_subtitles () const {
- return _burn_subtitles;
+ AudioProcessor const * audio_processor () const {
+ return _audio_processor;
+ }
+
+ ReelType reel_type () const {
+ return _reel_type;
+ }
+
+ int64_t reel_length () const {
+ return _reel_length;
+ }
+
+ std::string context_id () const {
+ return _context_id;
+ }
+
+ bool reencode_j2k () const {
+ return _reencode_j2k;
+ }
+
+ typedef std::map<dcp::Marker, dcpomatic::DCPTime> Markers;
+
+ boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
+ Markers markers () const {
+ return _markers;
+ }
+
+ std::vector<dcp::Rating> ratings () const {
+ return _ratings;
+ }
+
+ std::vector<std::string> content_versions () const {
+ return _content_versions;
+ }
+
+ dcp::LanguageTag name_language () const {
+ return _name_language;
+ }
+
+ boost::optional<dcp::LanguageTag::RegionSubtag> release_territory () const {
+ return _release_territory;
+ }
+
+ boost::optional<dcp::LanguageTag> sign_language_video_language () const {
+ return _sign_language_video_language;
+ }
+
+ int version_number () const {
+ return _version_number;
+ }
+
+ dcp::Status status () const {
+ return _status;
+ }
+
+ boost::optional<std::string> chain () const {
+ return _chain;
+ }
+
+ boost::optional<std::string> distributor () const {
+ return _distributor;
+ }
+
+ boost::optional<std::string> facility () const {
+ return _facility;
+ }
+
+ boost::optional<std::string> studio () const {
+ return _studio;
+ }
+
+ bool temp_version () const {
+ return _temp_version;
+ }
+
+ bool pre_release () const {
+ return _pre_release;
+ }
+
+ bool red_band () const {
+ return _red_band;
+ }
+
+ bool two_d_version_of_three_d () const {
+ return _two_d_version_of_three_d;
+ }
+
+ boost::optional<dcp::Luminance> luminance () const {
+ return _luminance;
+ }
+
+ boost::gregorian::date isdcf_date () const {
+ return _isdcf_date;
+ }
+
+ int audio_frame_rate () const {
+ return _audio_frame_rate;
+ }
+
+ bool write_cpl_metadata() const {
+ return _write_cpl_metadata;
}
-
/* SET */
void set_directory (boost::filesystem::path);
void set_name (std::string);
void set_use_isdcf_name (bool);
- void examine_content (boost::shared_ptr<Content>);
- void examine_and_add_content (boost::shared_ptr<Content>);
- void add_content (boost::shared_ptr<Content>);
- void remove_content (boost::shared_ptr<Content>);
- void move_content_earlier (boost::shared_ptr<Content>);
- void move_content_later (boost::shared_ptr<Content>);
+ void examine_and_add_content (std::shared_ptr<Content> content, bool disable_audio_analysis = false);
+ void add_content (std::shared_ptr<Content>);
+ void remove_content (std::shared_ptr<Content>);
+ void remove_content (ContentList);
+ void move_content_earlier (std::shared_ptr<Content>);
+ void move_content_later (std::shared_ptr<Content>);
void set_dcp_content_type (DCPContentType const *);
- void set_container (Ratio const *);
- void set_resolution (Resolution);
- void set_scaler (Scaler const *);
- void set_signed (bool);
+ void set_container (Ratio const *, bool user_explicit = true);
+ void set_resolution (Resolution, bool user_explicit = true);
void set_encrypted (bool);
void set_j2k_bandwidth (int);
- void set_isdcf_metadata (ISDCFMetadata);
- void set_video_frame_rate (int);
+ void set_video_frame_rate (int rate, bool user_explicit = false);
void set_audio_channels (int);
void set_three_d (bool);
void set_isdcf_date_today ();
- void set_sequence_video (bool);
+ void set_sequence (bool);
void set_interop (bool);
- void set_burn_subtitles (bool);
-
- /** Emitted when some property has of the Film has changed */
- mutable boost::signals2::signal<void (Property)> Changed;
+ void set_audio_processor (AudioProcessor const * processor);
+ void set_reel_type (ReelType);
+ void set_reel_length (int64_t);
+ void set_reencode_j2k (bool);
+ void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
+ void unset_marker (dcp::Marker type);
+ void clear_markers ();
+ void set_ratings (std::vector<dcp::Rating> r);
+ void set_content_versions (std::vector<std::string> v);
+ void set_name_language (dcp::LanguageTag lang);
+ void set_release_territory (boost::optional<dcp::LanguageTag::RegionSubtag> region = boost::none);
+ void set_sign_language_video_language (boost::optional<dcp::LanguageTag> tag);
+ void set_version_number (int v);
+ void set_status (dcp::Status s);
+ void set_chain (boost::optional<std::string> c = boost::none);
+ void set_facility (boost::optional<std::string> f = boost::none);
+ void set_studio (boost::optional<std::string> s = boost::none);
+ void set_temp_version (bool t);
+ void set_pre_release (bool p);
+ void set_red_band (bool r);
+ void set_two_d_version_of_three_d (bool t);
+ void set_distributor (boost::optional<std::string> d = boost::none);
+ void set_luminance (boost::optional<dcp::Luminance> l = boost::none);
+ void set_audio_language (boost::optional<dcp::LanguageTag> language);
+ void set_audio_frame_rate (int rate);
+ void set_write_cpl_metadata(bool write);
+
+ void add_ffoc_lfoc (Markers& markers) const;
+
+ /** Emitted when some property has of the Film is about to change or has changed */
+ mutable boost::signals2::signal<void (ChangeType, Property)> Change;
/** Emitted when some property of our content has changed */
- mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
+ mutable boost::signals2::signal<void (ChangeType, std::weak_ptr<Content>, int, bool)> ContentChange;
+
+ /** Emitted when the film's length might have changed; this is not like a normal
+ property as its value is derived from the playlist, so it has its own signal.
+ */
+ mutable boost::signals2::signal<void ()> LengthChange;
+
+ boost::signals2::signal<void (bool)> DirtyChange;
+
+ /** Emitted when we have something important to tell the user */
+ boost::signals2::signal<void (std::string)> Message;
/** Current version number of the state file */
static int const current_state_version;
private:
friend struct ::isdcf_name_test;
+ friend struct ::recover_test_2d_encrypted;
+ friend struct ::atmos_encrypted_passthrough_test;
+ template <class, class> friend class ChangeSignaller;
+
+ boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
- void signal_changed (Property);
+ void signal_change (ChangeType, Property);
+ void signal_change (ChangeType, int);
std::string video_identifier () const;
- void playlist_changed ();
- void playlist_content_changed (boost::weak_ptr<Content>, int);
- std::string filename_safe_name () const;
- void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
+ void playlist_change (ChangeType);
+ void playlist_order_changed ();
+ void playlist_content_change (ChangeType type, std::weak_ptr<Content>, int, bool frequent);
+ void playlist_length_change ();
+ void maybe_add_content (std::weak_ptr<Job>, std::weak_ptr<Content>, bool disable_audio_analysis);
+ void audio_analysis_finished ();
+ void check_settings_consistency ();
+ void maybe_set_container_and_resolution ();
+ void set_dirty (bool dirty);
/** Log to write to */
- boost::shared_ptr<Log> _log;
- boost::shared_ptr<Playlist> _playlist;
+ std::shared_ptr<Log> _log;
+ std::shared_ptr<Playlist> _playlist;
/** Complete path to directory containing the film metadata;
* must not be relative.
*/
- boost::filesystem::path _directory;
-
+ boost::optional<boost::filesystem::path> _directory;
+
+ boost::optional<std::string> _last_written_by;
+
/** Name for DCP-o-matic */
std::string _name;
/** True if a auto-generated ISDCF-compliant name should be used for our DCP */
Ratio const * _container;
/** DCP resolution (2K or 4K) */
Resolution _resolution;
- /** Scaler algorithm to use */
- Scaler const * _scaler;
- bool _signed;
bool _encrypted;
+ dcp::Key _key;
+ /** context ID used when encrypting picture assets; we keep it so that we can
+ * re-start picture MXF encodes.
+ */
+ std::string _context_id;
/** bandwidth for J2K files in bits per second */
int _j2k_bandwidth;
- /** ISDCF naming stuff */
- ISDCFMetadata _isdcf_metadata;
/** Frames per second to run our DCP at */
int _video_frame_rate;
/** The date that we should use in a ISDCF name */
boost::gregorian::date _isdcf_date;
- /** Number of audio channels to put in the DCP */
+ /** Number of audio channels requested for the DCP */
int _audio_channels;
/** If true, the DCP will be written in 3D mode; otherwise in 2D.
This will be regardless of what content is on the playlist.
*/
bool _three_d;
- bool _sequence_video;
+ bool _sequence;
bool _interop;
- bool _burn_subtitles;
- dcp::Key _key;
+ AudioProcessor const * _audio_processor;
+ ReelType _reel_type;
+ /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
+ int64_t _reel_length;
+ bool _reencode_j2k;
+ /** true if the user has ever explicitly set the video frame rate of this film */
+ bool _user_explicit_video_frame_rate;
+ bool _user_explicit_container;
+ bool _user_explicit_resolution;
+ std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
+ std::vector<dcp::Rating> _ratings;
+ std::vector<std::string> _content_versions;
+ dcp::LanguageTag _name_language;
+ boost::optional<dcp::LanguageTag::RegionSubtag> _release_territory;
+ boost::optional<dcp::LanguageTag> _sign_language_video_language;
+ int _version_number;
+ dcp::Status _status;
+ boost::optional<std::string> _chain;
+ boost::optional<std::string> _distributor;
+ boost::optional<std::string> _facility;
+ boost::optional<std::string> _studio;
+ bool _temp_version = false;
+ bool _pre_release = false;
+ bool _red_band = false;
+ bool _two_d_version_of_three_d = false;
+ boost::optional<dcp::Luminance> _luminance;
+ boost::optional<dcp::LanguageTag> _audio_language;
+ int _audio_frame_rate = 48000;
+ bool _write_cpl_metadata = true;
int _state_version;
/** true if our state has changed since we last saved it */
mutable bool _dirty;
+ /** film being used as a template, or 0 */
+ std::shared_ptr<Film> _template_film;
+
+ /** Be tolerant of errors in content (currently applies to DCP only).
+ Not saved as state.
+ */
+ bool _tolerant;
+
+ mutable boost::mutex _info_file_mutex;
+
+ boost::signals2::scoped_connection _playlist_change_connection;
+ boost::signals2::scoped_connection _playlist_order_changed_connection;
+ boost::signals2::scoped_connection _playlist_content_change_connection;
+ boost::signals2::scoped_connection _playlist_length_change_connection;
+ std::list<boost::signals2::connection> _job_connections;
+ std::list<boost::signals2::connection> _audio_analysis_connections;
friend struct paths_test;
friend struct film_metadata_test;
};
+
+typedef ChangeSignaller<Film, Film::Property> FilmChangeSignaller;
+
+
#endif