path: root/src/lib/film.h

/*
    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

/** @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.
 */

#ifndef DVDOMATIC_FILM_H
#define DVDOMATIC_FILM_H

#include <string>
#include <vector>
#include <inttypes.h>
#include <boost/thread/mutex.hpp>
#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 "trim_action.h"

class Format;
class Job;
class Filter;
class Log;
class ExamineContentJob;

/** @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.
 */
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::vector<std::string> audio_files () const;
	std::pair<Position, std::string> thumb_subtitle (int) const;

	void examine_content ();
	void send_dcp_to_tms ();
	void copy_from_dvd ();

	void make_dcp (bool);

	/** @return Logger.
	 *  It is safe to call this from any thread.
	 */
	Log* log () const {
		return _log;
	}

	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;
	
	bool content_is_dvd () const;

	std::string thumb_file (int) const;
	std::string thumb_base (int) const;
	int thumb_frame (int) 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;

	bool dirty () const {
		return _dirty;
	}

	int audio_channels () const;

	void set_dci_date_today ();

	enum Property {
		NONE,
		NAME,
		USE_DCI_NAME,
		CONTENT,
		DCP_CONTENT_TYPE,
		FORMAT,
		CROP,
		FILTERS,
		SCALER,
		DCP_FRAMES,
		DCP_TRIM_ACTION,
		DCP_AB,
		AUDIO_STREAM,
		AUDIO_GAIN,
		AUDIO_DELAY,
		STILL_DURATION,
		SUBTITLE_STREAM,
		WITH_SUBTITLES,
		SUBTITLE_OFFSET,
		SUBTITLE_SCALE,
		DCI_METADATA,
		THUMBS,
		SIZE,
		LENGTH,
		AUDIO_SAMPLE_RATE,
		HAS_SUBTITLES,
		AUDIO_STREAMS,
		SUBTITLE_STREAMS,
		FRAMES_PER_SECOND,
	};


	/* 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;
	}

	std::string content () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _content;
	}

	DCPContentType const * dcp_content_type () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _dcp_content_type;
	}

	Format const * format () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _format;
	}

	Crop crop () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _crop;
	}

	std::vector<Filter const *> filters () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _filters;
	}

	Scaler const * scaler () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _scaler;
	}

	boost::optional<int> dcp_frames () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _dcp_frames;
	}

	TrimAction dcp_trim_action () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _dcp_trim_action;
	}

	bool dcp_ab () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _dcp_ab;
	}

	int audio_stream_index () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _audio_stream;
	}

	AudioStream audio_stream () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		assert (_audio_stream < int (_audio_streams.size()));
		return _audio_streams[_audio_stream];
	}
	
	float audio_gain () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _audio_gain;
	}

	int audio_delay () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _audio_delay;
	}

	int still_duration () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _still_duration;
	}

	int subtitle_stream_index () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _subtitle_stream;
	}

	SubtitleStream subtitle_stream () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		assert (_subtitle_stream < int (_subtitle_streams.size()));
		return _subtitle_streams[_subtitle_stream];
	}

	bool with_subtitles () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _with_subtitles;
	}

	int subtitle_offset () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _subtitle_offset;
	}

	float subtitle_scale () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _subtitle_scale;
	}

	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 {
		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;
	}

	std::vector<int> thumbs () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _thumbs;
	}
	
	Size size () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _size;
	}

	boost::optional<int> length () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _length;
	}
	
	int audio_sample_rate () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _audio_sample_rate;
	}
	
	std::string content_digest () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _content_digest;
	}
	
	bool has_subtitles () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _has_subtitles;
	}

	std::vector<AudioStream> audio_streams () const {
		boost::mutex::scoped_lock lm (_state_mutex);
		return _audio_streams;
	}

	std::vector<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);
		return _frames_per_second;
	}


	/* SET */

	void set_directory (std::string);
	void set_name (std::string);
	void set_use_dci_name (bool);
	virtual void set_content (std::string);
	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_dcp_frames (int);
	void unset_dcp_frames ();
	void set_dcp_trim_action (TrimAction);
	void set_dcp_ab (bool);
	void set_audio_stream (int);
	void set_audio_gain (float);
	void set_audio_delay (int);
	void set_still_duration (int);
	void set_subtitle_stream (int);
	void set_with_subtitles (bool);
	void set_subtitle_offset (int);
	void set_subtitle_scale (float);
	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_thumbs (std::vector<int>);
	void set_size (Size);
	void set_length (int);
	void unset_length ();
	void set_audio_sample_rate (int);
	void set_content_digest (std::string);
	void set_has_subtitles (bool);
	void set_audio_streams (std::vector<AudioStream>);
	void set_subtitle_streams (std::vector<SubtitleStream>);
	void set_frames_per_second (float);

	/** Emitted when some property has changed */
	mutable boost::signals2::signal<void (Property)> Changed;
	
private:
	
	/** Log to write to */
	Log* _log;

	/** Any running ExamineContentJob, or 0 */
	boost::shared_ptr<ExamineContentJob> _examine_content_job;

	boost::gregorian::date _dci_date;

	std::string thumb_file_for_frame (int) const;
	std::string thumb_base_for_frame (int) const;
	void signal_changed (Property);
	void examine_content_finished ();
	
	/** 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 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;
	/** 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;
	/** Maximum number of frames to put in the DCP, if applicable */
	boost::optional<int> _dcp_frames;
	/** What to do with audio when trimming DCPs */
	TrimAction _dcp_trim_action;
	/** 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;
	/** An index into our _audio_streams vector for the stream to use for audio, or -1 if there is none */
	int _audio_stream;
	/** 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;
	/** An index into our _subtitle_streams vector for the stream to use for subtitles, or -1 if there is none */
	int _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;

	/* 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 */

	/** Vector of frame indices for each of our `thumbnails' */
	std::vector<int> _thumbs;
	/** Size, in pixels, of the source (ignoring cropping) */
	Size _size;
	/** Actual length of the source (in video frames) from examining it */
	boost::optional<int> _length;
	/** Sample rate of the source audio, in Hz */
	int _audio_sample_rate;
	/** MD5 digest of our content file */
	std::string _content_digest;
	/** true if the source has subtitles */
	bool _has_subtitles;
	/** the audio streams that the source has */
	std::vector<AudioStream> _audio_streams;
	/** the subtitle streams that the source has */
	std::vector<SubtitleStream> _subtitle_streams;
	/** Frames per second of the source */
	float _frames_per_second;

	mutable bool _dirty;

	/** Mutex for all state except _directory */
	mutable boost::mutex _state_mutex;

	friend class paths_test;
};

#endif