/*
    Copyright (C) 2013 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.

*/

#ifndef DCPOMATIC_VIDEO_CONTENT_H
#define DCPOMATIC_VIDEO_CONTENT_H

#include "content.h"
#include "colour_conversion.h"

class VideoExaminer;
class Ratio;

class VideoContentProperty
{
public:
	static int const VIDEO_SIZE;
	static int const VIDEO_FRAME_RATE;
	static int const VIDEO_FRAME_TYPE;
	static int const VIDEO_CROP;
	static int const VIDEO_SCALE;
	static int const COLOUR_CONVERSION;
};

class VideoContentScale
{
public:
	VideoContentScale ();
	VideoContentScale (Ratio const *);
	VideoContentScale (bool);
	VideoContentScale (boost::shared_ptr<cxml::Node>);

	libdcp::Size size (boost::shared_ptr<const VideoContent>, libdcp::Size) const;
	std::string id () const;
	std::string name () const;
	void as_xml (xmlpp::Node *) const;

	Ratio const * ratio () const {
		return _ratio;
	}

	bool scale () const {
		return _scale;
	}

	static void setup_scales ();
	static std::vector<VideoContentScale> all () {
		return _scales;
	}

private:
	Ratio const * _ratio;
	bool _scale;

	static std::vector<VideoContentScale> _scales;
};

bool operator== (VideoContentScale const & a, VideoContentScale const & b);
bool operator!= (VideoContentScale const & a, VideoContentScale const & b);

class VideoContent : public virtual Content
{
public:
	typedef int Frame;

	VideoContent (boost::shared_ptr<const Film>);
	VideoContent (boost::shared_ptr<const Film>, Time, VideoContent::Frame);
	VideoContent (boost::shared_ptr<const Film>, boost::filesystem::path);
	VideoContent (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>, int);
	VideoContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);

	void as_xml (xmlpp::Node *) const;
	std::string technical_summary () const;
	virtual std::string information () const;
	virtual std::string identifier () const;

	VideoContent::Frame video_length () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _video_length;
	}

	libdcp::Size video_size () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _video_size;
	}
	
	float video_frame_rate () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _video_frame_rate;
	}

	void set_video_frame_type (VideoFrameType);

	void set_left_crop (int);
	void set_right_crop (int);
	void set_top_crop (int);
	void set_bottom_crop (int);

	void set_scale (VideoContentScale);
	void set_colour_conversion (ColourConversion);
	
	VideoFrameType video_frame_type () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _video_frame_type;
	}

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

	int left_crop () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _crop.left;
	}

	int right_crop () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _crop.right;
	}

	int top_crop () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _crop.top;
	}

	int bottom_crop () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _crop.bottom;
	}

	/** @return Description of how to scale this content (if indeed it should be scaled) */
	VideoContentScale scale () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _scale;
	}

	ColourConversion colour_conversion () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _colour_conversion;
	}

	libdcp::Size video_size_after_3d_split () const;
	libdcp::Size video_size_after_crop () const;

	VideoContent::Frame time_to_content_video_frames (Time) const;

protected:
	void take_from_video_examiner (boost::shared_ptr<VideoExaminer>);

	VideoContent::Frame _video_length;
	float _video_frame_rate;

private:
	friend class ffmpeg_pts_offset_test;
	friend class best_dcp_frame_rate_test_single;
	friend class best_dcp_frame_rate_test_double;
	friend class audio_sampling_rate_test;

	void setup_default_colour_conversion ();
	
	libdcp::Size _video_size;
	VideoFrameType _video_frame_type;
	Crop _crop;
	VideoContentScale _scale;
	ColourConversion _colour_conversion;
};

#endif