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"
46 class ExamineContentJob;
47 class ExternalAudioStream;
50 * @brief A representation of a video with sound.
52 * A representation of a piece of video (with sound), including naming,
53 * the source content file, and how it should be presented in a DCP.
55 class Film : public boost::enable_shared_from_this<Film>
58 Film (std::string d, bool must_exist = true);
62 std::string j2k_dir () const;
63 std::vector<std::string> audio_files () const;
64 std::pair<Position, std::string> thumb_subtitle (int) const;
66 void examine_content ();
67 void send_dcp_to_tms ();
72 * It is safe to call this from any thread.
78 int encoded_frames () const;
80 std::string file (std::string f) const;
81 std::string dir (std::string d) const;
83 std::string content_path () const;
84 ContentType content_type () const;
86 std::string thumb_file (int) const;
87 std::string thumb_base (int) const;
88 SourceFrame thumb_frame (int) const;
90 int target_audio_sample_rate () const;
92 void write_metadata () const;
93 void read_metadata ();
95 Size cropped_size (Size) const;
96 boost::optional<SourceFrame> dcp_length () const;
97 std::string dci_name () const;
98 std::string dcp_name () const;
100 bool dirty () const {
104 int audio_channels () const;
106 void set_dci_date_today ();
113 TRUST_CONTENT_HEADER,
122 CONTENT_AUDIO_STREAM,
136 CONTENT_AUDIO_STREAMS,
144 std::string directory () const {
145 boost::mutex::scoped_lock lm (_directory_mutex);
149 std::string name () const {
150 boost::mutex::scoped_lock lm (_state_mutex);
154 bool use_dci_name () const {
155 boost::mutex::scoped_lock lm (_state_mutex);
156 return _use_dci_name;
159 std::string content () const {
160 boost::mutex::scoped_lock lm (_state_mutex);
164 bool trust_content_header () const {
165 boost::mutex::scoped_lock lm (_state_mutex);
166 return _trust_content_header;
169 DCPContentType const * dcp_content_type () const {
170 boost::mutex::scoped_lock lm (_state_mutex);
171 return _dcp_content_type;
174 Format const * format () const {
175 boost::mutex::scoped_lock lm (_state_mutex);
180 boost::mutex::scoped_lock lm (_state_mutex);
184 std::vector<Filter const *> filters () const {
185 boost::mutex::scoped_lock lm (_state_mutex);
189 Scaler const * scaler () const {
190 boost::mutex::scoped_lock lm (_state_mutex);
194 SourceFrame dcp_trim_start () const {
195 boost::mutex::scoped_lock lm (_state_mutex);
196 return _dcp_trim_start;
199 SourceFrame dcp_trim_end () const {
200 boost::mutex::scoped_lock lm (_state_mutex);
201 return _dcp_trim_end;
204 bool dcp_ab () const {
205 boost::mutex::scoped_lock lm (_state_mutex);
209 boost::shared_ptr<AudioStream> content_audio_stream () const {
210 boost::mutex::scoped_lock lm (_state_mutex);
211 return _content_audio_stream;
214 std::vector<std::string> external_audio () const {
215 boost::mutex::scoped_lock lm (_state_mutex);
216 return _external_audio;
219 bool use_content_audio () const {
220 boost::mutex::scoped_lock lm (_state_mutex);
221 return _use_content_audio;
224 float audio_gain () const {
225 boost::mutex::scoped_lock lm (_state_mutex);
229 int audio_delay () const {
230 boost::mutex::scoped_lock lm (_state_mutex);
234 int still_duration () const {
235 boost::mutex::scoped_lock lm (_state_mutex);
236 return _still_duration;
239 boost::shared_ptr<SubtitleStream> subtitle_stream () const {
240 boost::mutex::scoped_lock lm (_state_mutex);
241 return _subtitle_stream;
244 bool with_subtitles () const {
245 boost::mutex::scoped_lock lm (_state_mutex);
246 return _with_subtitles;
249 int subtitle_offset () const {
250 boost::mutex::scoped_lock lm (_state_mutex);
251 return _subtitle_offset;
254 float subtitle_scale () const {
255 boost::mutex::scoped_lock lm (_state_mutex);
256 return _subtitle_scale;
259 std::string audio_language () const {
260 boost::mutex::scoped_lock lm (_state_mutex);
261 return _audio_language;
264 std::string subtitle_language () const {
265 boost::mutex::scoped_lock lm (_state_mutex);
266 return _subtitle_language;
269 std::string territory () const {
270 boost::mutex::scoped_lock lm (_state_mutex);
274 std::string rating () const {
275 boost::mutex::scoped_lock lm (_state_mutex);
279 std::string studio () const {
280 boost::mutex::scoped_lock lm (_state_mutex);
284 std::string facility () const {
285 boost::mutex::scoped_lock lm (_state_mutex);
289 std::string package_type () const {
290 boost::mutex::scoped_lock lm (_state_mutex);
291 return _package_type;
294 std::vector<SourceFrame> thumbs () const {
295 boost::mutex::scoped_lock lm (_state_mutex);
300 boost::mutex::scoped_lock lm (_state_mutex);
304 boost::optional<SourceFrame> length () const {
305 boost::mutex::scoped_lock lm (_state_mutex);
309 std::string content_digest () const {
310 boost::mutex::scoped_lock lm (_state_mutex);
311 return _content_digest;
314 std::vector<boost::shared_ptr<AudioStream> > content_audio_streams () const {
315 boost::mutex::scoped_lock lm (_state_mutex);
316 return _content_audio_streams;
319 std::vector<boost::shared_ptr<SubtitleStream> > subtitle_streams () const {
320 boost::mutex::scoped_lock lm (_state_mutex);
321 return _subtitle_streams;
324 float frames_per_second () const {
325 boost::mutex::scoped_lock lm (_state_mutex);
326 return _frames_per_second;
329 boost::shared_ptr<AudioStream> audio_stream () const;
334 void set_directory (std::string);
335 void set_name (std::string);
336 void set_use_dci_name (bool);
337 void set_content (std::string);
338 void set_trust_content_header (bool);
339 void set_dcp_content_type (DCPContentType const *);
340 void set_format (Format const *);
341 void set_crop (Crop);
342 void set_left_crop (int);
343 void set_right_crop (int);
344 void set_top_crop (int);
345 void set_bottom_crop (int);
346 void set_filters (std::vector<Filter const *>);
347 void set_scaler (Scaler const *);
348 void set_dcp_trim_start (int);
349 void set_dcp_trim_end (int);
350 void set_dcp_ab (bool);
351 void set_content_audio_stream (boost::shared_ptr<AudioStream>);
352 void set_external_audio (std::vector<std::string>);
353 void set_use_content_audio (bool);
354 void set_audio_gain (float);
355 void set_audio_delay (int);
356 void set_still_duration (int);
357 void set_subtitle_stream (boost::shared_ptr<SubtitleStream>);
358 void set_with_subtitles (bool);
359 void set_subtitle_offset (int);
360 void set_subtitle_scale (float);
361 void set_audio_language (std::string);
362 void set_subtitle_language (std::string);
363 void set_territory (std::string);
364 void set_rating (std::string);
365 void set_studio (std::string);
366 void set_facility (std::string);
367 void set_package_type (std::string);
368 void set_thumbs (std::vector<SourceFrame>);
369 void set_size (Size);
370 void set_length (SourceFrame);
371 void unset_length ();
372 void set_content_digest (std::string);
373 void set_content_audio_streams (std::vector<boost::shared_ptr<AudioStream> >);
374 void set_subtitle_streams (std::vector<boost::shared_ptr<SubtitleStream> >);
375 void set_frames_per_second (float);
377 /** Emitted when some property has changed */
378 mutable boost::signals2::signal<void (Property)> Changed;
380 /** Current version number of the state file */
381 static int const state_version;
385 /** Log to write to */
388 /** Any running ExamineContentJob, or 0 */
389 boost::shared_ptr<ExamineContentJob> _examine_content_job;
391 /** The date that we should use in a DCI name */
392 boost::gregorian::date _dci_date;
394 std::string thumb_file_for_frame (SourceFrame) const;
395 std::string thumb_base_for_frame (SourceFrame) const;
396 void signal_changed (Property);
397 void examine_content_finished ();
399 /** Complete path to directory containing the film metadata;
400 * must not be relative.
402 std::string _directory;
403 /** Mutex for _directory */
404 mutable boost::mutex _directory_mutex;
406 /** Name for DVD-o-matic */
408 /** True if a auto-generated DCI-compliant name should be used for our DCP */
410 /** File or directory containing content; may be relative to our directory
411 * or an absolute path.
413 std::string _content;
414 bool _trust_content_header;
415 /** The type of content that this Film represents (feature, trailer etc.) */
416 DCPContentType const * _dcp_content_type;
417 /** The format to present this Film in (flat, scope, etc.) */
418 Format const * _format;
419 /** The crop to apply to the source */
421 /** Video filters that should be used when generating DCPs */
422 std::vector<Filter const *> _filters;
423 /** Scaler algorithm to use */
424 Scaler const * _scaler;
425 /** Frames to trim off the start of the source */
426 SourceFrame _dcp_trim_start;
427 /** Frames to trim off the end of the source */
428 SourceFrame _dcp_trim_end;
429 /** true to create an A/B comparison DCP, where the left half of the image
430 is the video without any filters or post-processing, and the right half
431 has the specified filters and post-processing.
434 /** The audio stream to use from our content */
435 boost::shared_ptr<AudioStream> _content_audio_stream;
436 /** List of filenames of external audio files, in channel order
437 (L, R, C, Lfe, Ls, Rs)
439 std::vector<std::string> _external_audio;
440 /** true to use audio from our content file; false to use external audio */
441 bool _use_content_audio;
442 /** Gain to apply to audio in dB */
444 /** Delay to apply to audio (positive moves audio later) in milliseconds */
446 /** Duration to make still-sourced films (in seconds) */
448 boost::shared_ptr<SubtitleStream> _subtitle_stream;
449 /** True if subtitles should be shown for this film */
450 bool _with_subtitles;
451 /** y offset for placing subtitles, in source pixels; +ve is further down
452 the frame, -ve is further up.
454 int _subtitle_offset;
455 /** scale factor to apply to subtitles */
456 float _subtitle_scale;
458 /* DCI naming stuff */
459 std::string _audio_language;
460 std::string _subtitle_language;
461 std::string _territory;
464 std::string _facility;
465 std::string _package_type;
467 /* Data which are cached to speed things up */
469 /** Vector of frame indices for each of our `thumbnails' */
470 std::vector<SourceFrame> _thumbs;
471 /** Size, in pixels, of the source (ignoring cropping) */
473 /** Actual length of the source (in video frames) from examining it */
474 boost::optional<SourceFrame> _length;
475 /** MD5 digest of our content file */
476 std::string _content_digest;
477 /** The audio streams in our content */
478 std::vector<boost::shared_ptr<AudioStream> > _content_audio_streams;
479 /** A stream to represent possible external audio (will always exist) */
480 boost::shared_ptr<AudioStream> _external_audio_stream;
481 /** the subtitle streams that we can use */
482 std::vector<boost::shared_ptr<SubtitleStream> > _subtitle_streams;
483 /** Frames per second of the source */
484 float _frames_per_second;
486 /** true if our state has changed since we last saved it */
489 /** Mutex for all state except _directory */
490 mutable boost::mutex _state_mutex;
492 friend class paths_test;