/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2020 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/>.
*/
* how they should be presented in a DCP.
*/
-#ifndef DVDOMATIC_FILM_H
-#define DVDOMATIC_FILM_H
+#ifndef DCPOMATIC_FILM_H
+#define DCPOMATIC_FILM_H
+#include "util.h"
+#include "types.h"
+#include "isdcf_metadata.h"
+#include "frame_rate_change.h"
+#include "signaller.h"
+#include "dcp_text_track.h"
+#include <dcp/key.h>
+#include <dcp/encrypted_kdm.h>
+#include <boost/signals2.hpp>
+#include <boost/enable_shared_from_this.hpp>
+#include <boost/thread.hpp>
+#include <boost/filesystem.hpp>
+#include <boost/thread/mutex.hpp>
#include <string>
#include <vector>
#include <inttypes.h>
-#include <boost/thread/mutex.hpp>
-#include <boost/thread.hpp>
-#include <boost/signals2.hpp>
-#include <boost/enable_shared_from_this.hpp>
-#include "util.h"
-#include "dci_metadata.h"
-#include "types.h"
-#include "ffmpeg_content.h"
-#include "audio_mapping.h"
+
+namespace xmlpp {
+ class Document;
+}
+
+namespace dcpomatic {
+ class Screen;
+}
class DCPContentType;
-class Format;
-class Job;
-class Filter;
class Log;
-class ExamineContentJob;
-class AnalyseAudioJob;
-class ExternalAudioStream;
class Content;
-class Player;
class Playlist;
+class AudioContent;
+class AudioProcessor;
+class AudioMapping;
+class Ratio;
+class Job;
+class Film;
+struct isdcf_name_test;
+
+class InfoFileHandle
+{
+public:
+ ~InfoFileHandle ();
+
+ FILE* get () const {
+ return _handle;
+ }
+
+ boost::filesystem::path file () const {
+ return _file;
+ }
+
+private:
+ friend class Film;
+
+ InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
+
+ boost::mutex::scoped_lock _lock;
+ FILE* _handle;
+ boost::filesystem::path _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>
+class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
{
public:
- Film (std::string d, bool must_exist = true);
- Film (Film const &);
-
- std::string info_dir () const;
- std::string j2c_path (int f, bool t) const;
- std::string info_path (int f) const;
- std::string video_mxf_dir () const;
- std::string video_mxf_filename () const;
- std::string audio_analysis_path () const;
-
- void examine_content (boost::shared_ptr<Content>);
- void analyse_audio ();
+ explicit Film (boost::optional<boost::filesystem::path> dir);
+ ~Film ();
+
+ boost::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 audio_analysis_path (boost::shared_ptr<const Playlist>) const;
+ boost::filesystem::path subtitle_analysis_path (boost::shared_ptr<const Content>) const;
+
void send_dcp_to_tms ();
- void make_dcp ();
+ void make_dcp (bool gui = false, bool check = true);
/** @return Logger.
* It is safe to call this from any thread.
return _log;
}
- int encoded_frames () const;
-
- std::string file (std::string f) const;
- std::string dir (std::string d) const;
+ boost::filesystem::path file (boost::filesystem::path f) const;
+ boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
- int target_audio_sample_rate () 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 () const;
+ void write_metadata (boost::filesystem::path path) const;
+ void write_template (boost::filesystem::path path) const;
+ boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
+
+ void copy_from (boost::shared_ptr<const Film> film);
- libdcp::Size cropped_size (libdcp::Size) const;
- std::string dci_name (bool if_created_now) const;
+ std::string isdcf_name (bool if_created_now) const;
std::string dcp_name (bool if_created_now = false) const;
/** @return true if our state has changed since we last saved it */
return _dirty;
}
- bool have_dcp () const;
+ dcp::Size full_frame () const;
+ dcp::Size frame_size () const;
+
+ std::vector<CPLSummary> cpls () const;
+
+ int audio_frame_rate () const;
+
+ std::list<DCPTextTrack> closed_caption_tracks () const;
- boost::shared_ptr<Player> player () const;
+ uint64_t required_disk_space () const;
+ bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
/* Proxies for some Playlist methods */
- ContentAudioFrame audio_length () const;
- int audio_channels () const;
- int audio_frame_rate () const;
- bool has_audio () const;
-
- float video_frame_rate () const;
- libdcp::Size video_size () const;
- ContentVideoFrame video_length () const;
+ ContentList content () const;
+ dcpomatic::DCPTime length () const;
+ int best_video_frame_rate () 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 recipient,
+ std::vector<std::string> trusted_devices,
+ boost::filesystem::path cpl_file,
+ dcp::LocalTime from,
+ dcp::LocalTime until,
+ dcp::Formulation formulation,
+ bool disable_forensic_marking_picture,
+ boost::optional<int> disable_forensic_marking_audio
+ ) const;
+
+ int state_version () const {
+ return _state_version;
+ }
+
+ std::string subtitle_language () const;
+
+ std::vector<std::string> audio_output_names () const;
+
+ void repeat_content (ContentList, int);
- std::vector<FFmpegSubtitleStream> ffmpeg_subtitle_streams () const;
- boost::optional<FFmpegSubtitleStream> ffmpeg_subtitle_stream () const;
- std::vector<FFmpegAudioStream> ffmpeg_audio_streams () const;
- boost::optional<FFmpegAudioStream> ffmpeg_audio_stream () const;
+ boost::shared_ptr<const Playlist> playlist () const {
+ return _playlist;
+ }
+
+ std::list<dcpomatic::DCPTimePeriod> reels () const;
+ std::list<int> mapped_audio_channels () const;
+
+ std::string content_summary (dcpomatic::DCPTimePeriod period) const;
- void set_ffmpeg_subtitle_stream (FFmpegSubtitleStream);
- void set_ffmpeg_audio_stream (FFmpegAudioStream);
+ bool references_dcp_video () const;
+ bool references_dcp_audio () const;
+
+ void set_tolerant (bool t) {
+ _tolerant = t;
+ }
+
+ bool tolerant () const {
+ return _tolerant;
+ }
/** Identifiers for the parts of our state;
used for signalling changes.
enum Property {
NONE,
NAME,
- USE_DCI_NAME,
- TRUST_CONTENT_HEADERS,
- /** The content list has changed (i.e. content has been added, moved around or removed) */
+ 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,
- FORMAT,
- CROP,
- FILTERS,
- SCALER,
- TRIM_START,
- TRIM_END,
- AB,
- AUDIO_GAIN,
- AUDIO_DELAY,
- WITH_SUBTITLES,
- SUBTITLE_OFFSET,
- SUBTITLE_SCALE,
- COLOUR_LUT,
+ CONTAINER,
+ RESOLUTION,
+ SIGNED,
+ ENCRYPTED,
+ KEY,
J2K_BANDWIDTH,
- DCI_METADATA,
- DCP_FRAME_RATE,
- AUDIO_MAPPING
+ ISDCF_METADATA,
+ VIDEO_FRAME_RATE,
+ AUDIO_CHANNELS,
+ /** The setting of _three_d has changed */
+ THREE_D,
+ SEQUENCE,
+ INTEROP,
+ AUDIO_PROCESSOR,
+ REEL_TYPE,
+ REEL_LENGTH,
+ UPLOAD_AFTER_MAKE_DCP,
+ REENCODE_J2K,
+ MARKERS,
+ RATINGS,
+ CONTENT_VERSION
};
/* GET */
- std::string directory () const {
- boost::mutex::scoped_lock lm (_directory_mutex);
+ boost::optional<boost::filesystem::path> directory () const {
return _directory;
}
std::string name () const {
- boost::mutex::scoped_lock lm (_state_mutex);
return _name;
}
- bool use_dci_name () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _use_dci_name;
+ bool use_isdcf_name () const {
+ return _use_isdcf_name;
}
- bool trust_content_headers () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _trust_content_headers;
+ DCPContentType const * dcp_content_type () const {
+ return _dcp_content_type;
}
- ContentList content () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _content;
+ Ratio const * container () const {
+ return _container;
}
- DCPContentType const * dcp_content_type () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _dcp_content_type;
+ Resolution resolution () const {
+ return _resolution;
}
- Format const * format () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _format;
+ /* signed is a reserved word */
+ bool is_signed () const {
+ return _signed;
}
- Crop crop () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _crop;
+ bool encrypted () const {
+ return _encrypted;
}
- std::vector<Filter const *> filters () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _filters;
+ dcp::Key key () const {
+ return _key;
}
- Scaler const * scaler () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _scaler;
+ int j2k_bandwidth () const {
+ return _j2k_bandwidth;
}
- int trim_start () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _trim_start;
+ ISDCFMetadata isdcf_metadata () const {
+ return _isdcf_metadata;
}
- int trim_end () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _trim_end;
+ /** @return The frame rate of the DCP */
+ int video_frame_rate () const {
+ return _video_frame_rate;
}
- bool ab () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _ab;
+ int audio_channels () const {
+ return _audio_channels;
}
- float audio_gain () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _audio_gain;
+ bool three_d () const {
+ return _three_d;
}
- int audio_delay () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _audio_delay;
+ bool sequence () const {
+ return _sequence;
}
- bool with_subtitles () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _with_subtitles;
+ bool interop () const {
+ return _interop;
}
- int subtitle_offset () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _subtitle_offset;
+ AudioProcessor const * audio_processor () const {
+ return _audio_processor;
}
- float subtitle_scale () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _subtitle_scale;
+ ReelType reel_type () const {
+ return _reel_type;
}
- int colour_lut () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _colour_lut;
+ int64_t reel_length () const {
+ return _reel_length;
}
- int j2k_bandwidth () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _j2k_bandwidth;
+ bool upload_after_make_dcp () const {
+ return _upload_after_make_dcp;
+ }
+
+ std::string context_id () const {
+ return _context_id;
+ }
+
+ bool reencode_j2k () const {
+ return _reencode_j2k;
}
- DCIMetadata dci_metadata () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _dci_metadata;
+ boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
+ std::map<dcp::Marker, dcpomatic::DCPTime> markers () const {
+ return _markers;
}
- int dcp_frame_rate () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _dcp_frame_rate;
+ std::vector<dcp::Rating> ratings () const {
+ return _ratings;
}
- AudioMapping audio_mapping () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _audio_mapping;
+ std::string content_version () const {
+ return _content_version;
}
/* SET */
- void set_directory (std::string);
+ void set_directory (boost::filesystem::path);
void set_name (std::string);
- void set_use_dci_name (bool);
- void set_trust_content_headers (bool);
+ void set_use_isdcf_name (bool);
+ void examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
void add_content (boost::shared_ptr<Content>);
void remove_content (boost::shared_ptr<Content>);
+ void remove_content (ContentList);
void move_content_earlier (boost::shared_ptr<Content>);
void move_content_later (boost::shared_ptr<Content>);
void set_dcp_content_type (DCPContentType const *);
- void set_format (Format const *);
- void set_crop (Crop);
- void set_left_crop (int);
- void set_right_crop (int);
- void set_top_crop (int);
- void set_bottom_crop (int);
- void set_filters (std::vector<Filter const *>);
- void set_scaler (Scaler const *);
- void set_trim_start (int);
- void set_trim_end (int);
- void set_ab (bool);
- void set_audio_gain (float);
- void set_audio_delay (int);
- void set_with_subtitles (bool);
- void set_subtitle_offset (int);
- void set_subtitle_scale (float);
- void set_colour_lut (int);
+ void set_container (Ratio const *);
+ void set_resolution (Resolution);
+ void set_signed (bool);
+ void set_encrypted (bool);
+ void set_key (dcp::Key key);
void set_j2k_bandwidth (int);
- void set_dci_metadata (DCIMetadata);
- void set_dcp_frame_rate (int);
- void set_dci_date_today ();
- void set_audio_mapping (AudioMapping);
-
- /** Emitted when some property has of the Film has changed */
- mutable boost::signals2::signal<void (Property)> Changed;
+ void set_isdcf_metadata (ISDCFMetadata);
+ 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 (bool);
+ void set_interop (bool);
+ void set_audio_processor (AudioProcessor const * processor);
+ void set_reel_type (ReelType);
+ void set_reel_length (int64_t);
+ void set_upload_after_make_dcp (bool);
+ 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_version (std::string v);
+
+ /** 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, boost::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 ()> AudioAnalysisSucceeded;
+ /** 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 state_version;
+ static int const current_state_version;
private:
-
- void signal_changed (Property);
- void analyse_audio_finished ();
- std::string video_state_identifier () const;
- void read_metadata ();
- void content_changed (boost::weak_ptr<Content>, int);
- boost::shared_ptr<FFmpegContent> ffmpeg () const;
- void setup_default_audio_mapping ();
+
+ friend struct ::isdcf_name_test;
+ template <typename> friend class ChangeSignaller;
+
+ boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
+
+ void signal_change (ChangeType, Property);
+ void signal_change (ChangeType, int);
+ std::string video_identifier () const;
+ void playlist_change (ChangeType);
+ void playlist_order_changed ();
+ void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
+ void playlist_length_change ();
+ void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
+ void audio_analysis_finished ();
+ void check_settings_consistency ();
+
+ static std::string const metadata_file;
/** Log to write to */
boost::shared_ptr<Log> _log;
- /** Any running AnalyseAudioJob, or 0 */
- boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
boost::shared_ptr<Playlist> _playlist;
/** Complete path to directory containing the film metadata;
* must not be relative.
*/
- std::string _directory;
- /** Mutex for _directory */
- mutable boost::mutex _directory_mutex;
-
- /** Name for DVD-o-matic */
+ boost::optional<boost::filesystem::path> _directory;
+
+ /** Name for DCP-o-matic */
std::string _name;
- /** True if a auto-generated DCI-compliant name should be used for our DCP */
- bool _use_dci_name;
- bool _trust_content_headers;
- ContentList _content;
+ /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
+ bool _use_isdcf_name;
/** The type of content that this Film represents (feature, trailer etc.) */
DCPContentType const * _dcp_content_type;
- /** The format to present this Film in (flat, scope, etc.) */
- Format const * _format;
- /** The crop to apply to the source */
- Crop _crop;
- /** Video filters that should be used when generating DCPs */
- std::vector<Filter const *> _filters;
- /** Scaler algorithm to use */
- Scaler const * _scaler;
- /** Frames to trim off the start of the DCP */
- int _trim_start;
- /** Frames to trim off the end of the DCP */
- int _trim_end;
- /** true to create an A/B comparison DCP, where the left half of the image
- is the video without any filters or post-processing, and the right half
- has the specified filters and post-processing.
- */
- bool _ab;
- /** Gain to apply to audio in dB */
- float _audio_gain;
- /** Delay to apply to audio (positive moves audio later) in milliseconds */
- int _audio_delay;
- /** True if subtitles should be shown for this film */
- bool _with_subtitles;
- /** y offset for placing subtitles, in source pixels; +ve is further down
- the frame, -ve is further up.
- */
- int _subtitle_offset;
- /** scale factor to apply to subtitles */
- float _subtitle_scale;
- /** index of colour LUT to use when converting RGB to XYZ.
- * 0: sRGB
- * 1: Rec 709
+ /** The container to put this Film in (flat, scope, etc.) */
+ Ratio const * _container;
+ /** DCP resolution (2K or 4K) */
+ Resolution _resolution;
+ 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.
*/
- int _colour_lut;
+ std::string _context_id;
/** bandwidth for J2K files in bits per second */
int _j2k_bandwidth;
- /** DCI naming stuff */
- DCIMetadata _dci_metadata;
+ /** ISDCF naming stuff */
+ ISDCFMetadata _isdcf_metadata;
/** Frames per second to run our DCP at */
- int _dcp_frame_rate;
- /** The date that we should use in a DCI name */
- boost::gregorian::date _dci_date;
- AudioMapping _audio_mapping;
+ int _video_frame_rate;
+ /** The date that we should use in a ISDCF name */
+ boost::gregorian::date _isdcf_date;
+ /** 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;
+ bool _interop;
+ AudioProcessor const * _audio_processor;
+ ReelType _reel_type;
+ /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
+ int64_t _reel_length;
+ bool _upload_after_make_dcp;
+ bool _reencode_j2k;
+ /** true if the user has ever explicitly set the video frame rate of this film */
+ bool _user_explicit_video_frame_rate;
+ std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
+ std::vector<dcp::Rating> _ratings;
+ std::string _content_version;
+
+ 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 */
+ boost::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;
- /** Mutex for all state except _directory */
- mutable boost::mutex _state_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 class paths_test;
- friend class film_metadata_test;
+ friend struct paths_test;
+ friend struct film_metadata_test;
};
#endif