#include <vector>
#include <inttypes.h>
#include <boost/thread/mutex.hpp>
-#include <sigc++/signal.h>
+#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 "film_state.h"
+#include "util.h"
+#include "stream.h"
class Format;
class Job;
class Filter;
class Log;
class ExamineContentJob;
+class ExternalAudioStream;
/** @class Film
- * @brief A representation of a video with sound.
+ * @brief A representation of a video, maybe with sound.
*
- * A representation of a piece of video (with sound), including naming,
+ * 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.
*/
-class Film
+class Film : public boost::enable_shared_from_this<Film>
{
public:
Film (std::string d, bool must_exist = true);
Film (Film const &);
~Film ();
- void write_metadata () const;
+ std::string hash_dir () const;
+ std::string j2c_path (int f, bool t) const;
+ std::string hash_path (int f) const;
+ std::string video_mxf_path () const;
- /** @return complete path to directory containing the film metadata */
- std::string directory () const {
- return _state.directory;
+ void examine_content ();
+ void send_dcp_to_tms ();
+
+ void make_dcp (bool);
+
+ /** @return Logger.
+ * It is safe to call this from any thread.
+ */
+ Log* log () const {
+ return _log;
}
- std::string content () const;
+ int encoded_frames () const;
+
+ std::string file (std::string f) const;
+ std::string dir (std::string d) const;
+
+ std::string content_path () const;
ContentType content_type () const;
+
+ int target_audio_sample_rate () const;
+
+ void write_metadata () const;
+ void read_metadata ();
+
+ libdcp::Size cropped_size (libdcp::Size) const;
+ std::string dci_name () const;
+ std::string dcp_name () const;
+
+ boost::optional<int> dcp_intrinsic_duration () const {
+ return _dcp_intrinsic_duration;
+ }
+
+ /** @return true if our state has changed since we last saved it */
+ bool dirty () const {
+ return _dirty;
+ }
+
+ int audio_channels () const;
+
+ void set_dci_date_today ();
+
+ /** Identifiers for the parts of our state;
+ used for signalling changes.
+ */
+ enum Property {
+ NONE,
+ NAME,
+ USE_DCI_NAME,
+ CONTENT,
+ TRUST_CONTENT_HEADER,
+ DCP_CONTENT_TYPE,
+ FORMAT,
+ CROP,
+ FILTERS,
+ SCALER,
+ TRIM_START,
+ TRIM_END,
+ DCP_AB,
+ CONTENT_AUDIO_STREAM,
+ EXTERNAL_AUDIO,
+ USE_CONTENT_AUDIO,
+ AUDIO_GAIN,
+ AUDIO_DELAY,
+ STILL_DURATION,
+ SUBTITLE_STREAM,
+ WITH_SUBTITLES,
+ SUBTITLE_OFFSET,
+ SUBTITLE_SCALE,
+ COLOUR_LUT,
+ J2K_BANDWIDTH,
+ DCI_METADATA,
+ SIZE,
+ LENGTH,
+ DCP_INTRINSIC_DURATION,
+ CONTENT_AUDIO_STREAMS,
+ SUBTITLE_STREAMS,
+ FRAMES_PER_SECOND,
+ };
+
+
+ /* GET */
+
+ std::string directory () const {
+ boost::mutex::scoped_lock lm (_directory_mutex);
+ return _directory;
+ }
- /** @return name for DVD-o-matic */
std::string name () const {
- return _state.name;
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _name;
}
- /** @return number of pixels to crop from the top of the original picture */
- int top_crop () const {
- return _state.top_crop;
+ bool use_dci_name () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _use_dci_name;
}
- /** @return number of pixels to crop from the bottom of the original picture */
- int bottom_crop () const {
- return _state.bottom_crop;
+ std::string content () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _content;
}
- /** @return number of pixels to crop from the left-hand side of the original picture */
- int left_crop () const {
- return _state.left_crop;
+ bool trust_content_header () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _trust_content_header;
}
- /** @return number of pixels to crop from the right-hand side of the original picture */
- int right_crop () const {
- return _state.right_crop;
+ DCPContentType const * dcp_content_type () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _dcp_content_type;
}
- /** @return the format to present this film in (flat, scope, etc.) */
Format const * format () const {
- return _state.format;
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _format;
+ }
+
+ Crop crop () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _crop;
}
- /** @return video filters that should be used when generating DCPs */
std::vector<Filter const *> filters () const {
- return _state.filters;
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _filters;
}
- /** @return scaler algorithm to use */
Scaler const * scaler () const {
- return _state.scaler;
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _scaler;
}
- /** @return number of frames to put in the DCP, or 0 for all */
- int dcp_frames () const {
- return _state.dcp_frames;
+ int trim_start () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _trim_start;
}
- TrimAction dcp_trim_action () const {
- return _state.dcp_trim_action;
+ int trim_end () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _trim_end;
}
- /** @return 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 () const {
- return _state.dcp_ab;
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _dcp_ab;
}
+ boost::shared_ptr<AudioStream> content_audio_stream () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _content_audio_stream;
+ }
+
+ std::vector<std::string> external_audio () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _external_audio;
+ }
+
+ bool use_content_audio () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _use_content_audio;
+ }
+
float audio_gain () const {
- return _state.audio_gain;
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _audio_gain;
}
int audio_delay () const {
- return _state.audio_delay;
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _audio_delay;
}
int still_duration () const {
- return _state.still_duration;
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _still_duration;
}
-
- void set_filters (std::vector<Filter const *> const &);
- void set_scaler (Scaler const *);
+ int still_duration_in_frames () const;
- /** @return the type of content that this Film represents (feature, trailer etc.) */
- DCPContentType const * dcp_content_type () {
- return _state.dcp_content_type;
+ boost::shared_ptr<SubtitleStream> subtitle_stream () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _subtitle_stream;
}
- void set_dcp_frames (int);
- void set_dcp_trim_action (TrimAction);
- void set_dcp_ab (bool);
-
- void set_name (std::string);
- void set_content (std::string);
- void set_top_crop (int);
- void set_bottom_crop (int);
- void set_left_crop (int);
- void set_right_crop (int);
- void set_frames_per_second (float);
- void set_format (Format const *);
- void set_dcp_content_type (DCPContentType const *);
- void set_audio_gain (float);
- void set_audio_delay (int);
- void set_still_duration (int);
-
- /** @return size, in pixels, of the source (ignoring cropping) */
- Size size () const {
- return _state.size;
+ bool with_subtitles () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _with_subtitles;
}
- /** @return length, in video frames */
- int length () const {
- return _state.length;
+ int subtitle_offset () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _subtitle_offset;
}
- /** @return nnumber of video frames per second */
- float frames_per_second () const {
- return _state.frames_per_second;
+ float subtitle_scale () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _subtitle_scale;
}
- /** @return number of audio channels */
- int audio_channels () const {
- return _state.audio_channels;
+ int colour_lut () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _colour_lut;
}
- /** @return audio sample rate, in Hz */
- int audio_sample_rate () const {
- return _state.audio_sample_rate;
+ int j2k_bandwidth () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _j2k_bandwidth;
}
- /** @return format of the audio samples */
- AVSampleFormat audio_sample_format () const {
- return _state.audio_sample_format;
+ std::string audio_language () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _audio_language;
}
- std::string j2k_dir () const;
-
- std::vector<std::string> audio_files () const;
+ std::string subtitle_language () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _subtitle_language;
+ }
+
+ std::string territory () 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;
+ }
- void update_thumbs_pre_gui ();
- void update_thumbs_post_gui ();
- int num_thumbs () const;
- int thumb_frame (int) const;
- std::string thumb_file (int) const;
+ libdcp::Size size () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _size;
+ }
- void copy_from_dvd_post_gui ();
- void examine_content ();
- void examine_content_post_gui ();
- void send_dcp_to_tms ();
- void copy_from_dvd ();
+ boost::optional<SourceFrame> length () 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 true if our metadata has been modified since it was last saved */
- bool dirty () const {
- return _dirty;
+ std::vector<boost::shared_ptr<SubtitleStream> > subtitle_streams () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _subtitle_streams;
+ }
+
+ float frames_per_second () const {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ if (content_type() == STILL) {
+ return 24;
+ }
+
+ return _frames_per_second;
}
- void make_dcp (bool, int freq = 0);
+ boost::shared_ptr<AudioStream> audio_stream () const;
- enum Property {
- NAME,
- CONTENT,
- DCP_CONTENT_TYPE,
- FORMAT,
- LEFT_CROP,
- RIGHT_CROP,
- TOP_CROP,
- BOTTOM_CROP,
- FILTERS,
- SCALER,
- DCP_FRAMES,
- DCP_TRIM_ACTION,
- DCP_AB,
- AUDIO_GAIN,
- AUDIO_DELAY,
- THUMBS,
- SIZE,
- LENGTH,
- FRAMES_PER_SECOND,
- AUDIO_CHANNELS,
- AUDIO_SAMPLE_RATE,
- STILL_DURATION
- };
+
+ /* SET */
- boost::shared_ptr<FilmState> state_copy () const;
+ 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_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_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_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 (libdcp::Size);
+ void set_length (SourceFrame);
+ void unset_length ();
+ void set_dcp_intrinsic_duration (int);
+ 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);
- /** @return Logger.
- * It is safe to call this from any thread.
- */
- Log* log () const {
- return _log;
- }
+ /** Emitted when some property has changed */
+ mutable boost::signals2::signal<void (Property)> Changed;
+
+ /** Current version number of the state file */
+ static int const state_version;
- /** Emitted when some metadata property has changed */
- mutable sigc::signal1<void, Property> Changed;
-
private:
- void read_metadata ();
- std::string metadata_file () const;
- void update_dimensions ();
+
+ /** 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 ();
+ std::string video_state_identifier () const;
- /** The majority of our state. Kept in a separate object
- * so that it can easily be copied for passing onto long-running
- * jobs (which then have an unchanging set of parameters).
+ /** Complete path to directory containing the film metadata;
+ * must not be relative.
*/
- FilmState _state;
-
- /** true if our metadata has changed since it was last written to disk */
+ std::string _directory;
+ /** Mutex for _directory */
+ mutable boost::mutex _directory_mutex;
+
+ /** Name for DVD-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;
+ /** 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 _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;
+ /** 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
+ 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
+ */
+ 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) */
+ libdcp::Size _size;
+ /** The length of the source, in video frames (as far as we know) */
+ boost::optional<SourceFrame> _length;
+ boost::optional<int> _dcp_intrinsic_duration;
+ /** 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;
+
+ /** true if our state has changed since we last saved it */
mutable bool _dirty;
- /** Log to write to */
- Log* _log;
+ /** 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;
};
#endif
projects / dcpomatic.git / blobdiff