/*
    Copyright (C) 2012-2015 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/decoder.h
 *  @brief Decoder class.
 */

#ifndef DCPOMATIC_DECODER_H
#define DCPOMATIC_DECODER_H

#include "types.h"
#include "dcpomatic_time.h"
#include <boost/utility.hpp>

class Decoded;

/** @class Decoder.
 *  @brief Parent class for decoders of content.
 */
class Decoder : public boost::noncopyable
{
public:
	virtual ~Decoder () {}

protected:
	friend class AudioDecoderStream;

	/** Seek so that the next pass() will yield the next thing
	 *  (video/sound frame, subtitle etc.) at or after the requested
	 *  time.  Pass accurate = true to try harder to ensure that, at worst,
	 *  the next thing we yield comes before `time'.  This may entail
	 *  seeking some way before `time' to be on the safe side.
	 *  Alternatively, if seeking is 100% accurate for this decoder,
	 *  it may seek to just the right spot.
	 */
	virtual void seek (ContentTime time, bool accurate) = 0;

	enum PassReason {
		PASS_REASON_VIDEO,
		PASS_REASON_AUDIO,
		PASS_REASON_SUBTITLE
	};

	virtual bool pass (PassReason) = 0;
};

#endif