2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * @brief A representation of a piece of video (with sound), including naming,
22 * the source content file, and how it should be presented in a DCP.
25 #ifndef DVDOMATIC_FILM_H
26 #define DVDOMATIC_FILM_H
31 #include <boost/thread/mutex.hpp>
32 #include <boost/thread.hpp>
33 #include <boost/signals2.hpp>
34 #include <boost/enable_shared_from_this.hpp>
36 #include <libavcodec/avcodec.h>
38 #include "dcp_content_type.h"
41 #include "dci_metadata.h"
47 class ExamineContentJob;
48 class AnalyseAudioJob;
49 class ExternalAudioStream;
52 * @brief A representation of a video, maybe with sound.
54 * A representation of a piece of video (maybe with sound), including naming,
55 * the source content file, and how it should be presented in a DCP.
57 class Film : public boost::enable_shared_from_this<Film>
60 Film (std::string d, bool must_exist = true);
64 std::string info_dir () const;
65 std::string j2c_path (int f, bool t) const;
66 std::string info_path (int f) const;
67 std::string internal_video_mxf_dir () const;
68 std::string internal_video_mxf_filename () const;
69 std::string audio_analysis_path () const;
71 std::string dcp_video_mxf_filename () const;
72 std::string dcp_audio_mxf_filename () const;
74 void examine_content ();
75 void analyse_audio ();
76 void send_dcp_to_tms ();
81 * It is safe to call this from any thread.
83 boost::shared_ptr<Log> log () const {
87 int encoded_frames () const;
89 std::string file (std::string f) const;
90 std::string dir (std::string d) const;
92 std::string content_path () const;
93 ContentType content_type () const;
95 int target_audio_sample_rate () const;
97 void write_metadata () const;
98 void read_metadata ();
100 libdcp::Size cropped_size (libdcp::Size) const;
101 std::string dci_name (bool if_created_now) const;
102 std::string dcp_name (bool if_created_now = false) const;
104 /** @return true if our state has changed since we last saved it */
105 bool dirty () const {
109 int audio_channels () const;
111 void set_dci_date_today ();
113 bool have_dcp () const;
120 /** Identifiers for the parts of our state;
121 used for signalling changes.
128 TRUST_CONTENT_HEADER,
138 CONTENT_AUDIO_STREAM,
153 CONTENT_AUDIO_STREAMS,
157 MINIMUM_AUDIO_CHANNELS
163 std::string directory () const {
164 boost::mutex::scoped_lock lm (_directory_mutex);
168 std::string name () const {
169 boost::mutex::scoped_lock lm (_state_mutex);
173 bool use_dci_name () const {
174 boost::mutex::scoped_lock lm (_state_mutex);
175 return _use_dci_name;
178 std::string content () const {
179 boost::mutex::scoped_lock lm (_state_mutex);
183 bool trust_content_header () const {
184 boost::mutex::scoped_lock lm (_state_mutex);
185 return _trust_content_header;
188 DCPContentType const * dcp_content_type () const {
189 boost::mutex::scoped_lock lm (_state_mutex);
190 return _dcp_content_type;
193 Format const * format () const {
194 boost::mutex::scoped_lock lm (_state_mutex);
199 boost::mutex::scoped_lock lm (_state_mutex);
203 std::vector<Filter const *> filters () const {
204 boost::mutex::scoped_lock lm (_state_mutex);
208 Scaler const * scaler () const {
209 boost::mutex::scoped_lock lm (_state_mutex);
213 int trim_start () const {
214 boost::mutex::scoped_lock lm (_state_mutex);
218 int trim_end () const {
219 boost::mutex::scoped_lock lm (_state_mutex);
223 TrimType trim_type () const {
224 boost::mutex::scoped_lock lm (_state_mutex);
228 bool dcp_ab () const {
229 boost::mutex::scoped_lock lm (_state_mutex);
233 boost::shared_ptr<AudioStream> content_audio_stream () const {
234 boost::mutex::scoped_lock lm (_state_mutex);
235 return _content_audio_stream;
238 std::vector<std::string> external_audio () const {
239 boost::mutex::scoped_lock lm (_state_mutex);
240 return _external_audio;
243 bool use_content_audio () const {
244 boost::mutex::scoped_lock lm (_state_mutex);
245 return _use_content_audio;
248 float audio_gain () const {
249 boost::mutex::scoped_lock lm (_state_mutex);
253 int audio_delay () const {
254 boost::mutex::scoped_lock lm (_state_mutex);
258 int still_duration () const {
259 boost::mutex::scoped_lock lm (_state_mutex);
260 return _still_duration;
263 int still_duration_in_frames () const;
265 boost::shared_ptr<SubtitleStream> subtitle_stream () const {
266 boost::mutex::scoped_lock lm (_state_mutex);
267 return _subtitle_stream;
270 bool with_subtitles () const {
271 boost::mutex::scoped_lock lm (_state_mutex);
272 return _with_subtitles;
275 int subtitle_offset () const {
276 boost::mutex::scoped_lock lm (_state_mutex);
277 return _subtitle_offset;
280 float subtitle_scale () const {
281 boost::mutex::scoped_lock lm (_state_mutex);
282 return _subtitle_scale;
285 int colour_lut () const {
286 boost::mutex::scoped_lock lm (_state_mutex);
290 int j2k_bandwidth () const {
291 boost::mutex::scoped_lock lm (_state_mutex);
292 return _j2k_bandwidth;
295 DCIMetadata dci_metadata () const {
296 boost::mutex::scoped_lock lm (_state_mutex);
297 return _dci_metadata;
300 int dcp_frame_rate () const {
301 boost::mutex::scoped_lock lm (_state_mutex);
302 return _dcp_frame_rate;
305 libdcp::Size size () const {
306 boost::mutex::scoped_lock lm (_state_mutex);
310 boost::optional<SourceFrame> length () const {
311 boost::mutex::scoped_lock lm (_state_mutex);
315 std::string content_digest () const {
316 boost::mutex::scoped_lock lm (_state_mutex);
317 return _content_digest;
320 std::vector<boost::shared_ptr<AudioStream> > content_audio_streams () const {
321 boost::mutex::scoped_lock lm (_state_mutex);
322 return _content_audio_streams;
325 std::vector<boost::shared_ptr<SubtitleStream> > subtitle_streams () const {
326 boost::mutex::scoped_lock lm (_state_mutex);
327 return _subtitle_streams;
330 float source_frame_rate () const {
331 boost::mutex::scoped_lock lm (_state_mutex);
332 if (content_type() == STILL) {
336 return _source_frame_rate;
339 int minimum_audio_channels () const {
340 boost::mutex::scoped_lock lm (_state_mutex);
341 return _minimum_audio_channels;
344 boost::shared_ptr<AudioStream> audio_stream () const;
345 bool has_audio () const;
349 void set_directory (std::string);
350 void set_name (std::string);
351 void set_use_dci_name (bool);
352 void set_content (std::string);
353 void set_trust_content_header (bool);
354 void set_dcp_content_type (DCPContentType const *);
355 void set_format (Format const *);
356 void set_crop (Crop);
357 void set_left_crop (int);
358 void set_right_crop (int);
359 void set_top_crop (int);
360 void set_bottom_crop (int);
361 void set_filters (std::vector<Filter const *>);
362 void set_scaler (Scaler const *);
363 void set_trim_start (int);
364 void set_trim_end (int);
365 void set_trim_type (TrimType);
366 void set_dcp_ab (bool);
367 void set_content_audio_stream (boost::shared_ptr<AudioStream>);
368 void set_external_audio (std::vector<std::string>);
369 void set_use_content_audio (bool);
370 void set_audio_gain (float);
371 void set_audio_delay (int);
372 void set_still_duration (int);
373 void set_subtitle_stream (boost::shared_ptr<SubtitleStream>);
374 void set_with_subtitles (bool);
375 void set_subtitle_offset (int);
376 void set_subtitle_scale (float);
377 void set_colour_lut (int);
378 void set_j2k_bandwidth (int);
379 void set_dci_metadata (DCIMetadata);
380 void set_dcp_frame_rate (int);
381 void set_size (libdcp::Size);
382 void set_length (SourceFrame);
383 void unset_length ();
384 void set_content_digest (std::string);
385 void set_content_audio_streams (std::vector<boost::shared_ptr<AudioStream> >);
386 void set_subtitle_streams (std::vector<boost::shared_ptr<SubtitleStream> >);
387 void set_source_frame_rate (float);
388 void set_minimum_audio_channels (int);
390 /** Emitted when some property has changed */
391 mutable boost::signals2::signal<void (Property)> Changed;
393 boost::signals2::signal<void ()> AudioAnalysisSucceeded;
395 /** Current version number of the state file */
396 static int const state_version;
400 /** Log to write to */
401 boost::shared_ptr<Log> _log;
403 /** Any running ExamineContentJob, or 0 */
404 boost::shared_ptr<ExamineContentJob> _examine_content_job;
405 /** Any running AnalyseAudioJob, or 0 */
406 boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
408 void signal_changed (Property);
409 void examine_content_finished ();
410 void analyse_audio_finished ();
411 std::string video_state_identifier () const;
412 std::string filename_safe_name () const;
414 /** Complete path to directory containing the film metadata;
415 * must not be relative.
417 std::string _directory;
418 /** Mutex for _directory */
419 mutable boost::mutex _directory_mutex;
421 /** Name for DVD-o-matic */
423 /** True if a auto-generated DCI-compliant name should be used for our DCP */
425 /** File or directory containing content; may be relative to our directory
426 * or an absolute path.
428 std::string _content;
429 /** If this is true, we will believe the length specified by the content
430 * file's header; if false, we will run through the whole content file
431 * the first time we see it in order to obtain the length.
433 bool _trust_content_header;
434 /** The type of content that this Film represents (feature, trailer etc.) */
435 DCPContentType const * _dcp_content_type;
436 /** The format to present this Film in (flat, scope, etc.) */
437 Format const * _format;
438 /** The crop to apply to the source */
440 /** Video filters that should be used when generating DCPs */
441 std::vector<Filter const *> _filters;
442 /** Scaler algorithm to use */
443 Scaler const * _scaler;
444 /** Frames to trim off the start of the DCP */
446 /** Frames to trim off the end of the DCP */
449 /** true to create an A/B comparison DCP, where the left half of the image
450 is the video without any filters or post-processing, and the right half
451 has the specified filters and post-processing.
454 /** The audio stream to use from our content */
455 boost::shared_ptr<AudioStream> _content_audio_stream;
456 /** List of filenames of external audio files, in channel order
457 (L, R, C, Lfe, Ls, Rs)
459 std::vector<std::string> _external_audio;
460 /** true to use audio from our content file; false to use external audio */
461 bool _use_content_audio;
462 /** Gain to apply to audio in dB */
464 /** Delay to apply to audio (positive moves audio later) in milliseconds */
466 /** Duration to make still-sourced films (in seconds) */
468 boost::shared_ptr<SubtitleStream> _subtitle_stream;
469 /** True if subtitles should be shown for this film */
470 bool _with_subtitles;
471 /** y offset for placing subtitles, in source pixels; +ve is further down
472 the frame, -ve is further up.
474 int _subtitle_offset;
475 /** scale factor to apply to subtitles */
476 float _subtitle_scale;
477 /** index of colour LUT to use when converting RGB to XYZ.
482 /** bandwidth for J2K files in bits per second */
485 /** DCI naming stuff */
486 DCIMetadata _dci_metadata;
487 /** The date that we should use in a DCI name */
488 boost::gregorian::date _dci_date;
489 /** Frames per second to run our DCP at */
491 int _minimum_audio_channels;
493 /* Data which are cached to speed things up */
495 /** Size, in pixels, of the source (ignoring cropping) */
497 /** The length of the source, in video frames (as far as we know) */
498 boost::optional<SourceFrame> _length;
499 /** MD5 digest of our content file */
500 std::string _content_digest;
501 /** The audio streams in our content */
502 std::vector<boost::shared_ptr<AudioStream> > _content_audio_streams;
503 /** A stream to represent possible external audio (will always exist) */
504 boost::shared_ptr<AudioStream> _sndfile_stream;
505 /** the subtitle streams that we can use */
506 std::vector<boost::shared_ptr<SubtitleStream> > _subtitle_streams;
507 /** Frames per second of the source */
508 float _source_frame_rate;
510 /** true if our state has changed since we last saved it */
513 /** Mutex for all state except _directory */
514 mutable boost::mutex _state_mutex;
516 friend class paths_test;
517 friend class film_metadata_test;