/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#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/key.h>
+#include <dcp/encrypted_kdm.h>
+#include <boost/signals2.hpp>
+#include <boost/enable_shared_from_this.hpp>
+#include <boost/filesystem.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 "types.h"
-#include "playlist.h"
-#include "dci_metadata.h"
+
+namespace xmlpp {
+ class Document;
+}
class DCPContentType;
class Log;
class Content;
class Player;
+class Playlist;
+class AudioContent;
+class Screen;
+class AudioProcessor;
+class AudioMapping;
+class Ratio;
+class Job;
+struct isdcf_name_test;
/** @class Film
*
*
* 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 boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
{
public:
- Film (std::string d);
+ Film (boost::filesystem::path, bool log = true);
+ ~Film ();
- std::string info_dir () const;
- std::string j2c_path (int f, bool t) const;
- std::string info_path (int f) const;
- std::string internal_video_mxf_dir () const;
- std::string internal_video_mxf_filename () const;
- boost::filesystem::path audio_analysis_path (boost::shared_ptr<const AudioContent>) const;
+ boost::filesystem::path info_file () const;
+ boost::filesystem::path j2c_path (int, Eyes, bool) const;
+ boost::filesystem::path internal_video_asset_dir () const;
+ boost::filesystem::path internal_video_asset_filename () const;
- std::string dcp_video_mxf_filename () const;
- std::string dcp_audio_mxf_filename () const;
+ boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
void send_dcp_to_tms ();
void make_dcp ();
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) const;
- void read_metadata ();
+ std::list<std::string> read_metadata ();
void write_metadata () const;
+ boost::shared_ptr<xmlpp::Document> metadata () 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;
}
- libdcp::Size full_frame () const;
-
- bool have_dcp () const;
+ dcp::Size full_frame () const;
+ dcp::Size frame_size () const;
- boost::shared_ptr<Player> make_player () const;
- boost::shared_ptr<Playlist> playlist () const;
+ std::vector<CPLSummary> cpls () const;
- OutputAudioFrame dcp_audio_frame_rate () const;
+ int audio_frame_rate () const;
- OutputAudioFrame time_to_audio_frames (Time) const;
- OutputVideoFrame time_to_video_frames (Time) const;
- Time video_frames_to_time (OutputVideoFrame) const;
- Time audio_frames_to_time (OutputAudioFrame) 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 */
- Playlist::ContentList content_without_loop () const;
+ ContentList content () const;
+ DCPTime length () const;
+ int best_video_frame_rate () const;
+ FrameRateChange active_frame_rate_change (DCPTime) 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> >,
+ boost::filesystem::path cpl_file,
+ dcp::LocalTime from,
+ dcp::LocalTime until,
+ dcp::Formulation formulation
+ ) const;
+
+ int state_version () const {
+ return _state_version;
+ }
- Time length_with_loop () const;
- Time length_without_loop () const;
- bool has_subtitles () const;
- OutputVideoFrame best_dcp_video_frame_rate () const;
+ std::string subtitle_language () const;
- void set_loop (int);
- int loop () const;
+ void make_audio_mapping_default (AudioMapping & mapping) const;
+ std::vector<std::string> audio_output_names () const;
- void set_sequence_video (bool);
+ void repeat_content (ContentList, int);
+
+ boost::shared_ptr<const Playlist> playlist () const {
+ return _playlist;
+ }
/** Identifiers for the parts of our state;
used for signalling changes.
enum Property {
NONE,
NAME,
- USE_DCI_NAME,
- /** The playlist's 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,
- LOOP,
DCP_CONTENT_TYPE,
CONTAINER,
RESOLUTION,
- SCALER,
- WITH_SUBTITLES,
+ SIGNED,
+ ENCRYPTED,
+ KEY,
J2K_BANDWIDTH,
- DCI_METADATA,
- DCP_VIDEO_FRAME_RATE,
- DCP_AUDIO_CHANNELS
+ ISDCF_METADATA,
+ VIDEO_FRAME_RATE,
+ AUDIO_CHANNELS,
+ /** The setting of _three_d has changed */
+ THREE_D,
+ SEQUENCE_VIDEO,
+ INTEROP,
+ AUDIO_PROCESSOR,
};
/* GET */
- std::string directory () const {
- boost::mutex::scoped_lock lm (_directory_mutex);
+ 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;
}
DCPContentType const * dcp_content_type () const {
- boost::mutex::scoped_lock lm (_state_mutex);
return _dcp_content_type;
}
Ratio const * container () const {
- boost::mutex::scoped_lock lm (_state_mutex);
return _container;
}
Resolution resolution () const {
- boost::mutex::scoped_lock lm (_state_mutex);
return _resolution;
}
- Scaler const * scaler () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _scaler;
+ /* signed is a reserved word */
+ bool is_signed () const {
+ return _signed;
+ }
+
+ bool encrypted () const {
+ return _encrypted;
}
- bool with_subtitles () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _with_subtitles;
+ dcp::Key key () const {
+ return _key;
}
int j2k_bandwidth () const {
- boost::mutex::scoped_lock lm (_state_mutex);
return _j2k_bandwidth;
}
- DCIMetadata dci_metadata () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _dci_metadata;
+ ISDCFMetadata isdcf_metadata () const {
+ return _isdcf_metadata;
+ }
+
+ /** @return The frame rate of the DCP */
+ int video_frame_rate () const {
+ return _video_frame_rate;
+ }
+
+ int audio_channels () const {
+ return _audio_channels;
+ }
+
+ bool three_d () const {
+ return _three_d;
}
- /* XXX: -> "video_frame_rate" */
- int dcp_video_frame_rate () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _dcp_video_frame_rate;
+ bool sequence_video () const {
+ return _sequence_video;
}
- int dcp_audio_channels () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _dcp_audio_channels;
+ bool interop () const {
+ return _interop;
}
+ AudioProcessor const * audio_processor () const {
+ return _audio_processor;
+ }
+
+
/* 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_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 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_container (Ratio const *);
void set_resolution (Resolution);
- void set_scaler (Scaler const *);
- void set_with_subtitles (bool);
+ 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_video_frame_rate (int);
- void set_dcp_audio_channels (int);
- void set_dci_date_today ();
+ void set_isdcf_metadata (ISDCFMetadata);
+ void set_video_frame_rate (int);
+ void set_audio_channels (int);
+ void set_three_d (bool);
+ void set_isdcf_date_today ();
+ void set_sequence_video (bool);
+ void set_interop (bool);
+ void set_audio_processor (AudioProcessor const * processor);
/** Emitted when some property has of the Film has changed */
mutable boost::signals2::signal<void (Property)> Changed;
/** 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 (boost::weak_ptr<Content>, int, bool)> ContentChanged;
/** Current version number of the state file */
- static int const state_version;
+ static int const current_state_version;
private:
+ friend struct ::isdcf_name_test;
+
void signal_changed (Property);
std::string video_identifier () const;
void playlist_changed ();
- void playlist_content_changed (boost::weak_ptr<Content>, int);
- std::string filename_safe_name () const;
- void add_content_weak (boost::weak_ptr<Content>);
+ void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
+ void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
/** Log to write to */
boost::shared_ptr<Log> _log;
/** Complete path to directory containing the film metadata;
* must not be relative.
*/
- std::string _directory;
- /** Mutex for _directory */
- mutable boost::mutex _directory_mutex;
-
+ 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;
+ /** 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 container to put this Film in (flat, scope, etc.) */
Ratio const * _container;
/** DCP resolution (2K or 4K) */
Resolution _resolution;
- /** Scaler algorithm to use */
- Scaler const * _scaler;
- /** True if subtitles should be shown for this film */
- bool _with_subtitles;
+ bool _signed;
+ bool _encrypted;
+ dcp::Key _key;
/** 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_video_frame_rate;
- /** The date that we should use in a DCI name */
- boost::gregorian::date _dci_date;
- int _dcp_audio_channels;
+ 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_video;
+ bool _interop;
+ AudioProcessor const * _audio_processor;
+
+ int _state_version;
/** true if our state has changed since we last saved it */
mutable bool _dirty;
- /** Mutex for all state except _directory */
- mutable boost::mutex _state_mutex;
+ boost::signals2::scoped_connection _playlist_changed_connection;
+ boost::signals2::scoped_connection _playlist_content_changed_connection;
+ std::list<boost::signals2::connection> _job_connections;
- friend class paths_test;
- friend class film_metadata_test;
+ friend struct paths_test;
+ friend struct film_metadata_test;
};
#endif