*/
/** @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 <boost/thread.hpp>
#include <boost/signals2.hpp>
#include <boost/enable_shared_from_this.hpp>
-extern "C" {
-#include <libavcodec/avcodec.h>
-}
-#include "dcp_content_type.h"
#include "util.h"
-#include "stream.h"
+#include "dci_metadata.h"
+#include "types.h"
+#include "ffmpeg_content.h"
+#include "audio_mapping.h"
+class DCPContentType;
class Format;
class Job;
class Filter;
class Log;
class ExamineContentJob;
+class AnalyseAudioJob;
class ExternalAudioStream;
+class Content;
+class Player;
+class Playlist;
/** @class Film
- * @brief A representation of a video, maybe with sound.
- *
- * A representation of a piece of video (maybe 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.
*/
class Film : public boost::enable_shared_from_this<Film>
{
public:
Film (std::string d, bool must_exist = true);
Film (Film const &);
- ~Film ();
- std::string j2k_dir () const;
+ 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;
+ std::string audio_analysis_path () const;
- void examine_content ();
- void send_dcp_to_tms ();
+ void examine_content (boost::shared_ptr<Content>);
+ std::string dcp_video_mxf_filename () const;
+ std::string dcp_audio_mxf_filename () const;
- void make_dcp (bool);
+ void analyse_audio ();
+ void send_dcp_to_tms ();
+ 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;
}
std::string file (std::string f) const;
std::string dir (std::string d) const;
- std::string frame_out_path (SourceFrame f, bool t) const;
- std::string hash_out_path (SourceFrame f, bool t) const;
- std::string multichannel_audio_out_path (int c, bool t) const;
-
- std::string content_path () const;
- ContentType content_type () const;
-
int target_audio_sample_rate () const;
void write_metadata () const;
- void read_metadata ();
- Size cropped_size (Size) const;
- boost::optional<int> dcp_length () const;
- std::string dci_name () const;
- std::string dcp_name () const;
+ libdcp::Size cropped_size (libdcp::Size) 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;
}
+ bool have_dcp () const;
+
+ boost::shared_ptr<Player> player () 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;
- void set_dci_date_today ();
+ 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;
+
+ void set_ffmpeg_subtitle_stream (FFmpegSubtitleStream);
+ void set_ffmpeg_audio_stream (FFmpegAudioStream);
+
+ enum TrimType {
+ CPL,
+ ENCODE
+ };
/** Identifiers for the parts of our state;
used for signalling changes.
NONE,
NAME,
USE_DCI_NAME,
+ TRUST_CONTENT_HEADERS,
+ /** The content list has changed (i.e. content has been added, moved around or removed) */
CONTENT,
- TRUST_CONTENT_HEADER,
DCP_CONTENT_TYPE,
FORMAT,
CROP,
SCALER,
TRIM_START,
TRIM_END,
- REEL_SIZE,
- DCP_AB,
- CONTENT_AUDIO_STREAM,
- EXTERNAL_AUDIO,
- USE_CONTENT_AUDIO,
+ AB,
+ TRIM_TYPE,
AUDIO_GAIN,
AUDIO_DELAY,
- STILL_DURATION,
- SUBTITLE_STREAM,
WITH_SUBTITLES,
SUBTITLE_OFFSET,
SUBTITLE_SCALE,
COLOUR_LUT,
J2K_BANDWIDTH,
DCI_METADATA,
- SIZE,
- LENGTH,
- CONTENT_AUDIO_STREAMS,
- SUBTITLE_STREAMS,
- FRAMES_PER_SECOND,
+ DCP_FRAME_RATE,
+ AUDIO_MAPPING
};
return _use_dci_name;
}
- std::string content () const {
+ bool trust_content_headers () const {
boost::mutex::scoped_lock lm (_state_mutex);
- return _content;
+ return _trust_content_headers;
}
- bool trust_content_header () const {
+ ContentList content () const {
boost::mutex::scoped_lock lm (_state_mutex);
- return _trust_content_header;
+ return _content;
}
DCPContentType const * dcp_content_type () const {
return _scaler;
}
- SourceFrame trim_start () const {
+ int trim_start () const {
boost::mutex::scoped_lock lm (_state_mutex);
return _trim_start;
}
- SourceFrame trim_end () const {
+ int trim_end () const {
boost::mutex::scoped_lock lm (_state_mutex);
return _trim_end;
}
- boost::optional<uint64_t> reel_size () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _reel_size;
- }
-
- bool dcp_ab () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _dcp_ab;
- }
-
- boost::shared_ptr<AudioStream> content_audio_stream () const {
+ TrimType trim_type () const {
boost::mutex::scoped_lock lm (_state_mutex);
- return _content_audio_stream;
+ return _trim_type;
}
- std::vector<std::string> external_audio () const {
+ bool ab () const {
boost::mutex::scoped_lock lm (_state_mutex);
- return _external_audio;
+ return _ab;
}
- bool use_content_audio () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _use_content_audio;
- }
-
float audio_gain () const {
boost::mutex::scoped_lock lm (_state_mutex);
return _audio_gain;
return _audio_delay;
}
- int still_duration () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _still_duration;
- }
-
- boost::shared_ptr<SubtitleStream> subtitle_stream () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _subtitle_stream;
- }
-
bool with_subtitles () const {
boost::mutex::scoped_lock lm (_state_mutex);
return _with_subtitles;
return _j2k_bandwidth;
}
- std::string audio_language () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _audio_language;
- }
-
- std::string subtitle_language () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _subtitle_language;
- }
-
- std::string territory () const {
+ DCIMetadata dci_metadata () const {
boost::mutex::scoped_lock lm (_state_mutex);
- return _territory;
- }
-
- std::string rating () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _rating;
- }
-
- std::string studio () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _studio;
- }
-
- std::string facility () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _facility;
- }
-
- std::string package_type () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _package_type;
- }
-
- Size size () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _size;
+ return _dci_metadata;
}
- boost::optional<SourceFrame> length () const {
+ int dcp_frame_rate () const {
boost::mutex::scoped_lock lm (_state_mutex);
- return _length;
- }
-
- std::string content_digest () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _content_digest;
- }
-
- std::vector<boost::shared_ptr<AudioStream> > content_audio_streams () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- return _content_audio_streams;
+ return _dcp_frame_rate;
}
- std::vector<boost::shared_ptr<SubtitleStream> > subtitle_streams () const {
+ AudioMapping audio_mapping () const {
boost::mutex::scoped_lock lm (_state_mutex);
- return _subtitle_streams;
+ return _audio_mapping;
}
-
- float frames_per_second () const {
- boost::mutex::scoped_lock lm (_state_mutex);
- if (content_type() == STILL) {
- return 24;
- }
-
- return _frames_per_second;
- }
-
- boost::shared_ptr<AudioStream> audio_stream () const;
-
/* SET */
void set_directory (std::string);
void set_name (std::string);
void set_use_dci_name (bool);
- void set_content (std::string);
- void set_trust_content_header (bool);
+ void set_trust_content_headers (bool);
+ 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 set_dcp_content_type (DCPContentType const *);
void set_format (Format const *);
void set_crop (Crop);
void set_scaler (Scaler const *);
void set_trim_start (int);
void set_trim_end (int);
- void set_reel_size (uint64_t);
- void unset_reel_size ();
- void set_dcp_ab (bool);
- void set_content_audio_stream (boost::shared_ptr<AudioStream>);
- void set_external_audio (std::vector<std::string>);
- void set_use_content_audio (bool);
+ void set_ab (bool);
+ void set_trim_type (TrimType);
void set_audio_gain (float);
void set_audio_delay (int);
- void set_still_duration (int);
- void set_subtitle_stream (boost::shared_ptr<SubtitleStream>);
void set_with_subtitles (bool);
void set_subtitle_offset (int);
void set_subtitle_scale (float);
void set_colour_lut (int);
void set_j2k_bandwidth (int);
- void set_audio_language (std::string);
- void set_subtitle_language (std::string);
- void set_territory (std::string);
- void set_rating (std::string);
- void set_studio (std::string);
- void set_facility (std::string);
- void set_package_type (std::string);
- void set_size (Size);
- void set_length (SourceFrame);
- void unset_length ();
- void set_content_digest (std::string);
- void set_content_audio_streams (std::vector<boost::shared_ptr<AudioStream> >);
- void set_subtitle_streams (std::vector<boost::shared_ptr<SubtitleStream> >);
- void set_frames_per_second (float);
-
- /** Emitted when some property has changed */
+ 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;
+ /** Emitted when some property of our content has changed */
+ mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
+
+ boost::signals2::signal<void ()> AudioAnalysisSucceeded;
+
/** Current version number of the state file */
static int const state_version;
private:
- /** Log to write to */
- Log* _log;
-
- /** Any running ExamineContentJob, or 0 */
- boost::shared_ptr<ExamineContentJob> _examine_content_job;
-
- /** The date that we should use in a DCI name */
- boost::gregorian::date _dci_date;
-
void signal_changed (Property);
- void examine_content_finished ();
+ 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 ();
+ std::string filename_safe_name () const;
+
+ /** 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.
/** Mutex for _directory */
mutable boost::mutex _directory_mutex;
- /** Name for DVD-o-matic */
+ /** 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;
- /** File or directory containing content; may be relative to our directory
- * or an absolute path.
- */
- std::string _content;
- /** If this is true, we will believe the length specified by the content
- * file's header; if false, we will run through the whole content file
- * the first time we see it in order to obtain the length.
- */
- bool _trust_content_header;
+ bool _trust_content_headers;
+ ContentList _content;
/** 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.) */
int _trim_start;
/** Frames to trim off the end of the DCP */
int _trim_end;
- /** Approximate target reel size in bytes; if not set, use a single reel */
- boost::optional<uint64_t> _reel_size;
+ TrimType _trim_type;
/** 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 _dcp_ab;
- /** The audio stream to use from our content */
- boost::shared_ptr<AudioStream> _content_audio_stream;
- /** List of filenames of external audio files, in channel order
- (L, R, C, Lfe, Ls, Rs)
- */
- std::vector<std::string> _external_audio;
- /** true to use audio from our content file; false to use external audio */
- bool _use_content_audio;
+ 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;
- /** Duration to make still-sourced films (in seconds) */
- int _still_duration;
- boost::shared_ptr<SubtitleStream> _subtitle_stream;
/** True if subtitles should be shown for this film */
bool _with_subtitles;
/** y offset for placing subtitles, in source pixels; +ve is further down
int _colour_lut;
/** bandwidth for J2K files in bits per second */
int _j2k_bandwidth;
-
- /* DCI naming stuff */
- std::string _audio_language;
- std::string _subtitle_language;
- std::string _territory;
- std::string _rating;
- std::string _studio;
- std::string _facility;
- std::string _package_type;
-
- /* Data which are cached to speed things up */
-
- /** Size, in pixels, of the source (ignoring cropping) */
- Size _size;
- /** The length of the source, in video frames (as far as we know) */
- boost::optional<SourceFrame> _length;
- /** MD5 digest of our content file */
- std::string _content_digest;
- /** The audio streams in our content */
- std::vector<boost::shared_ptr<AudioStream> > _content_audio_streams;
- /** A stream to represent possible external audio (will always exist) */
- boost::shared_ptr<AudioStream> _external_audio_stream;
- /** the subtitle streams that we can use */
- std::vector<boost::shared_ptr<SubtitleStream> > _subtitle_streams;
- /** Frames per second of the source */
- float _frames_per_second;
+ /** DCI naming stuff */
+ DCIMetadata _dci_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;
/** true if our state has changed since we last saved it */
mutable bool _dirty;
mutable boost::mutex _state_mutex;
friend class paths_test;
+ friend class film_metadata_test;
};
#endif