/*
 *	osgART/GenericVideo
 *	osgART: AR ToolKit for OpenSceneGraph
 *
 *	Copyright (c) 2005-2007 ARToolworks, Inc. All rights reserved.
 *	
 *	Rev		Date		Who		Changes
 *  1.0   	2006-12-08  ---     Version 1.0 release.
 *
 */
/*
 * This file is part of osgART - AR Toolkit for OpenSceneGraph
 *
 * Copyright (c) 2005-2007 ARToolworks, Inc. All rights reserved.
 *
 * (See the AUTHORS file in the root of this distribution.)
 *
 *
 * OSGART 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.
 *
 * OSGART 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 OSGART; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 *
 */


#ifndef OSGART_GENERICVIDEO
#define OSGART_GENERICVIDEO 1

// OSG include
#include <osg/ref_ptr>
#include <osg/Image>
#include <osg/Referenced>


// Local include
#include "osgART/Export"
#include "osgART/VideoConfig"
#include "osgART/Field"



#include <OpenThreads/ScopedLock>
#include <OpenThreads/Mutex>



namespace osgART {

	/**
	 * GenericVideo encapsulates different capturing devices and sources. 
	 * 
	 */	
	class OSGART_EXPORT GenericVideo : public osg::Referenced, 
		public FieldContainer<GenericVideo>
	{
	public:       

		    
		/** 
		* \brief default constructor.
		* The default constructor.
		*/
		GenericVideo();
	    
		/** 
		* \brief copy constructor.
		*
		*/
		GenericVideo(const GenericVideo &);
	    
	    
		/** 
		* \brief affectation operator.
		*
		*/
		GenericVideo& operator = (const GenericVideo &);
	   
		/**
		* \brief x size of the GenericVideo.
		* @return the width of the GenericVideo stream.
		*/
		inline int getWidth() const {
			return xsize;
		}
		
		/**
		* \brief y size of the GenericVideo.
		* @return the height of the GenericVideo stream.
		*/
		inline int getHeight() const {
			return ysize;
		}

		/**
		* \brief pixel size of the GenericVideo.
		* @return the pixel size of the GenericVideo stream in number of components.
		*/
		inline int pixelSize() const {
			return pixelsize;
		}

		/**
		* \brief return the type of the pixel format
		* @return pixel format of the video image returned: from RGB to YUV format. 
		*/
		inline PixelFormatType pixelFormat() const {
			return pixelformat;
		}
		
		/**
		* \brief return the type of the internal pixel format
		* @return pixel format use internally, grabbed from camera: from RGB to YUV format.
		*/
		inline PixelFormatType pixelInternalFormat() const {
			return internalpixelformat;
		}

		/**
		* \brief return the frame rate
		* @return actual frame rate used by the camera
		*/
		inline FrameRateType frameRate() const {
			return framerate;
		}
		
		/**
		* \brief get GenericVideo id.
		* @return a GenericVideo identifier.
		*/
		virtual int getID() const;

		// services
	    
		/**
		* \brief open the GenericVideo stream.
		* Access the GenericVideo stream (hardware or file) and get an handle on it.
		*/
		virtual void open() = 0;
		
		/**
		* \brief close the  video stream.
		* Terminate the connection with the video stream and clean handle.
		*/
		virtual void close() = 0;
		
		/**
		* \brief start the  video stream grabbing.
		* Start to get image from the  video stream. In function of the implementation on different
		* platform, this function can run a thread, signal or real-time function. 
		*/
		virtual void start() = 0;
		
		/**
		* \brief stop the  video stream grabbing.
		* Stop to get image from the  video stream. In function of the implementation on different
		* platform, this function can stop a thread, signal or real-time function. 
		*/
		virtual void stop() = 0;
		
		/**
		* \brief update the  video stream grabbing.
		* Try to get an image of the  video instance, usable by your application.
		*/
		virtual void update() = 0;
		
		/**
		 * \brief get an image.
		 * Get the last image retrieved since call of update.
		 */
		unsigned char* getImageRaw();
		
		/**
		 * \brief get an image.
		 * Get the last image retrieved since call of update.
		 */
		osg::ref_ptr<osg::Image> getImage() const;
		
		/**
		 * \brief set an image.
		 * \param image set the internal image 
		 * Get the last image retrieved since call of update.
		 */
		void setImage(osg::Image* image);
		
		
		/**
		* \brief force a release of the frame.
		* Use when user explicitly want to release the memory area of the grabbed GenericVideo. Otherwise
		* generally release at the next call of update.
		*/
		virtual void releaseImage() = 0;
		
		
		inline PixelFormatType getPixelFormat(bool internal = true) {
			return (internal) ? internalpixelformat : pixelformat;
		}		
		
		
		inline OpenThreads::Mutex& getMutex() {
			return m_mutex;		
		}
		
		/**
		 * Access a field by its name. You need to cast
		 * the field into its respective type in order
		 * to access it.
		 * \param name Name of the field
		 * \return pointer to the field (0L if not found)
		 */
		Field* get(const std::string& name);
		
		
		virtual VideoConfiguration* getVideoConfiguration();
		
	   
	protected:		
	

		/** 
		 * \brief destructor.
		 *
		 */
		virtual ~GenericVideo();   
 
		osg::ref_ptr<osg::Image> m_image;

		int xsize;
		int ysize;	
		int pixelsize;
		PixelFormatType pixelformat;
		PixelFormatType internalpixelformat;
		FrameRateType framerate;
		
		int m_video_id;
			
		static int videoNum;
		
		// used for locking
		OpenThreads::Mutex m_mutex;
		
	};

	/**
     * The videocontainer encapsulates a video video stream object
	 * Its single purpose of existance is to get arround restrictions
	 * within osgIntrospection and RTTI accross DLL boundaries.
	 */
	class OSGART_EXPORT VideoContainer : public GenericVideo {
	public:
	
		VideoContainer(GenericVideo* video);


		VideoConfiguration* getVideoConfiguration();

	    
		/**
		* \brief open the internal video stream.
		* Access the GenericVideo stream (hardware or file) and get an handle on it.
		*/
		virtual void open();
		
		/**
		* \brief close the video stream.
		* Terminate the connection with the video stream and clean handle.
		*/
		virtual void close();
		
		/**
		* \brief start the  video stream grabbing.
		* Start to get image from the  video stream. In function of the implementation on different
		* platform, this function can run a thread, signal or real-time function. 
		*/
		virtual void start();
		
		/**
		* \brief stop the  video stream grabbing.
		* Stop to get image from the  video stream. In function of the implementation on different
		* platform, this function can stop a thread, signal or real-time function. 
		*/
		virtual void stop();
		
		/**
		* \brief update the  video stream grabbing.
		* Try to get an image of the  video instance, usable by your application.
		*/
		virtual void update();		
		
		
		virtual void releaseImage();
		

	protected:

		VideoContainer();

		virtual ~VideoContainer();

		osg::ref_ptr<GenericVideo> m_encapsulated;

	};
	
	
};

#endif