*/
/** @file src/film.h
- * @brief A representation of a piece of video (with sound), including naming,
- * the source content file, and how it should be presented in a DCP.
+ * @brief A representation of some audio and video content, and details of
+ * 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 <string>
#include <vector>
#include <inttypes.h>
#include <boost/thread/mutex.hpp>
#include <boost/thread.hpp>
-extern "C" {
-#include <libavcodec/avcodec.h>
-}
-#include "dcp_content_type.h"
-#include "film_state.h"
-
-class Format;
-class Job;
-class Filter;
+#include <boost/signals2.hpp>
+#include <boost/enable_shared_from_this.hpp>
+#include "util.h"
+#include "types.h"
+#include "playlist.h"
+#include "dci_metadata.h"
+
+class DCPContentType;
class Log;
-class ExamineContentJob;
+class Content;
+class Player;
/** @class Film
- * @brief A representation of a video with sound.
*
- * A representation of a piece of video (with sound), including naming,
- * the source content file, and how it should be presented in a DCP.
+ * @brief A representation of some audio and video 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 FilmState
+class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
{
public:
- Film (std::string d, bool must_exist = true);
- ~Film ();
+ Film (std::string d);
- std::string j2k_dir () const;
+ std::string info_dir () const;
+ std::string j2c_path (int, Eyes, bool) const;
+ std::string info_path (int, Eyes) 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;
- std::vector<std::string> audio_files () const;
+ std::string dcp_video_mxf_filename () const;
+ std::string dcp_audio_mxf_filename () const;
- void update_thumbs_pre_gui ();
- void update_thumbs_post_gui ();
- std::pair<Position, std::string> thumb_subtitle (int) const;
-
- void copy_from_dvd_post_gui ();
- void examine_content ();
- void examine_content_post_gui ();
void send_dcp_to_tms ();
- void copy_from_dvd ();
-
- void make_dcp (bool, int freq = 0);
+ void make_dcp ();
/** @return Logger.
* It is safe to call this from any thread.
*/
- Log* log () const {
+ boost::shared_ptr<Log> log () const {
return _log;
}
int encoded_frames () const;
+ std::string file (std::string f) const;
+ std::string dir (std::string d) const;
+
+ void read_metadata ();
+ void write_metadata () const;
+
+ std::string dci_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 */
+ bool dirty () const {
+ return _dirty;
+ }
+
+ libdcp::Size full_frame () const;
+
+ bool have_dcp () const;
+
+ boost::shared_ptr<Player> make_player () const;
+ boost::shared_ptr<Playlist> playlist () const;
+
+ OutputAudioFrame dcp_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;
+
+ /* Proxies for some Playlist methods */
+
+ ContentList content () const;
+
+ Time length () const;
+ bool has_subtitles () const;
+ OutputVideoFrame best_dcp_video_frame_rate () const;
+
+ /** 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) */
+ CONTENT,
+ DCP_CONTENT_TYPE,
+ CONTAINER,
+ RESOLUTION,
+ SCALER,
+ WITH_SUBTITLES,
+ J2K_BANDWIDTH,
+ DCI_METADATA,
+ DCP_VIDEO_FRAME_RATE,
+ DCP_AUDIO_CHANNELS,
+ /** The setting of _dcp_3d has been changed */
+ DCP_3D,
+ SEQUENCE_VIDEO,
+ };
+
+
+ /* GET */
+
+ std::string directory () const {
+ boost::mutex::scoped_lock lm (_directory_mutex);
+ 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;
+ }
+
+ 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;
+ }
+
+ bool with_subtitles () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _with_subtitles;
+ }
+
+ 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;
+ }
+
+ /* XXX: -> "video_frame_rate" */
+ int dcp_video_frame_rate () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _dcp_video_frame_rate;
+ }
+
+ int dcp_audio_channels () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _dcp_audio_channels;
+ }
+
+ bool dcp_3d () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _dcp_3d;
+ }
+
+ bool sequence_video () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _sequence_video;
+ }
+
+
+ /* SET */
+
+ void set_directory (std::string);
+ void set_name (std::string);
+ void set_use_dci_name (bool);
+ void examine_and_add_content (boost::shared_ptr<Content>);
+ void add_content (boost::shared_ptr<Content>);
+ void remove_content (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_j2k_bandwidth (int);
+ void set_dci_metadata (DCIMetadata);
+ void set_dcp_video_frame_rate (int);
+ void set_dcp_audio_channels (int);
+ void set_dcp_3d (bool);
+ void set_dci_date_today ();
+ void set_sequence_video (bool);
+
+ /** 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;
+
+ /** Current version number of the state file */
+ static int const state_version;
+
private:
+
+ 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 maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
+
/** Log to write to */
- Log* _log;
+ boost::shared_ptr<Log> _log;
+ 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 DCP-o-matic */
+ std::string _name;
+ /** True if a auto-generated DCI-compliant name should be used for our DCP */
+ bool _use_dci_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;
+ /** bandwidth for J2K files in bits per second */
+ int _j2k_bandwidth;
+ /** DCI naming stuff */
+ DCIMetadata _dci_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;
+ /** 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 _dcp_3d;
+ bool _sequence_video;
+
+ /** 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;
- /** Any running ExamineContentJob, or 0 */
- boost::shared_ptr<ExamineContentJob> _examine_content_job;
+ friend class paths_test;
+ friend class film_metadata_test;
};
#endif
projects / dcpomatic.git / blobdiff