Aegisub/aegisub/src/video_provider_ffmpegsource.h

// Copyright (c) 2008-2009, Karl Blomster
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   * Redistributions of source code must retain the above copyright notice,
//     this list of conditions and the following disclaimer.
//   * Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation
//     and/or other materials provided with the distribution.
//   * Neither the name of the Aegisub Group nor the names of its contributors
//     may be used to endorse or promote products derived from this software
//     without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$

/// @file video_provider_ffmpegsource.h
/// @see video_provider_ffmpegsource.cpp
/// @ingroup video_input ffms
///

///////////
// Headers
#ifdef WITH_FFMPEGSOURCE
#ifndef AGI_PRE
#include <vector>
#endif

#include "ffmpegsource_common.h"
#include "include/aegisub/video_provider.h"
#include "vfr.h"


/// @class FFmpegSourceVideoProvider
/// @brief Implements video loading through the FFMS library.
class FFmpegSourceVideoProvider : public VideoProvider, FFmpegSourceProvider {
private:
	FFMS_VideoSource *VideoSource;			/// video source object
	const FFMS_VideoProperties *VideoInfo;	/// video properties

	int Width;					/// width in pixels
	int Height;					/// height in pixels
	int FrameNumber;			/// current framenumber
	wxArrayInt KeyFramesList;	/// list of keyframes
	bool KeyFramesLoaded;		/// keyframe loading state
	std::vector<int> TimecodesVector;	/// list of timestamps
	FrameRate Timecodes;		/// vfr object
	bool COMInited;				/// COM initialization state
	
	AegiVideoFrame CurFrame;	/// current video frame
	
	char FFMSErrMsg[1024];		/// FFMS error message
	FFMS_ErrorInfo ErrInfo;		/// FFMS error codes/messages
	wxString ErrorMsg;			/// wx-ified error message

	void LoadVideo(wxString filename);
	void Close();

public:
	FFmpegSourceVideoProvider(wxString filename);
	~FFmpegSourceVideoProvider();

	const AegiVideoFrame GetFrame(int n);
	int GetPosition();
	int GetFrameCount();

	int GetWidth();
	int GetHeight();
	double GetFPS();

	/// @brief Reports keyframe status
	/// @return	Returns true if keyframes are loaded, false otherwise.
	bool AreKeyFramesLoaded() { return KeyFramesLoaded; };
	/// @brief Gets a list of keyframes
	/// @return	Returns a wxArrayInt of keyframes.
	wxArrayInt GetKeyFrames() { return KeyFramesList; };
	/// @brief Checks if source is VFR
	/// @return	Returns true.
	bool IsVFR() { return true; };
	/// @brief Gets a VFR framerate object
	/// @return Returns the framerate object.
	FrameRate GetTrueFrameRate() { return Timecodes; };
	/// @brief Gets the name of the provider
	/// @return Returns "FFmpegSource".
	wxString GetDecoderName() { return L"FFmpegSource"; }
	/// @brief Gets the desired cache behavior.
	/// @return Returns true.
	bool WantsCaching() { return true; }
};



/// @class FFmpegSourceVideoProviderFactory
/// @brief Creates a FFmpegSource video provider.
class FFmpegSourceVideoProviderFactory : public VideoProviderFactory {
public:
	/// @brief Creates a FFmpegSource video provider.
	/// @param video The video filename to open.
	/// @return Returns the video provider.
	VideoProvider *CreateProvider(wxString video) { return new FFmpegSourceVideoProvider(video); }
};


#endif /* WITH_FFMPEGSOURCE */