/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2012 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : include/ICLIO/V4L2Grabber.h                            **
** Module : ICLIO                                                  **
** Authors: Christof Elbrechter, Viktor Richter                    **
**                                                                 **
** Commercial License                                              **
** ICL can be used commercially, please refer to our website       **
** www.iclcv.org for more details.                                 **
**                                                                 **
** GNU General Public License Usage                                **
** Alternatively, this file may be used under the terms of the     **
** GNU General Public License version 3.0 as published by the      **
** Free Software Foundation and appearing in the file LICENSE.GPL  **
** included in the packaging of this file.  Please review the      **
** following information to ensure the GNU General Public License  **
** version 3.0 requirements will be met:                           **
** http://www.gnu.org/copyleft/gpl.html.                           **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
*********************************************************************/

#pragma once

#include <ICLIO/GrabberHandle.h>
#include <ICLUtils/Mutex.h>

namespace icl{
  namespace io{
    
    /// The Video for Linux 2 Grabber uses the v4l2-api to access video capturing devices \ingroup GRABBER_G \ingroup V4L_G
    /** This grabber backend is usually used for USB-Webcams as well as for Grabber cards */
    class V4L2GrabberImpl : public Grabber{
        class Impl; //!< internal implementation
        Impl *impl; //!< internal data structure
        utils::Mutex implMutex; //!< protects the impl which is reallocated when the core::format is changed
      public:

        /// create a new grabbers instance, with given device name (
        V4L2GrabberImpl(const std::string &device="/dev/video0");

        /// Destruktoer
        ~V4L2GrabberImpl();

        /// obtains the next image
        virtual const core::ImgBase *acquireImage();
        
        /// returns a list of all supported video devices
        static const std::vector<GrabberDeviceDescription> &getDeviceList(bool rescan);

      private:
        /// adds properties to Configurable
        void addProperties();
        /// callback for changed configurable properties
        void processPropertyChange(const utils::Configurable::Property &prop);
    };


    /// Video4Linux2 based grabber \ingroup GRABBER_G
    /** for more details: @see V4L2GrabberImpl */
    class V4L2Grabber : public GrabberHandle<V4L2GrabberImpl>{
      public:
        /// returns a list of available pwc devices
        /** @see V4L2GrabberImpl for more details*/
        static inline const std::vector<GrabberDeviceDescription> &getDeviceList(bool rescan){
          return V4L2GrabberImpl::getDeviceList(rescan);
        }

        /// creates a new V4L2Grabber instance
        /** @see V4L2GrabberImpl for more details */
        inline V4L2Grabber(const std::string &device="/dev/video0"){
          if(isNew(device)){
            initialize(new V4L2GrabberImpl(device), device);
          }else{
            initialize(device);
          }
        }
        /// empty constructor (initialize late using init())
        /** @see V4L2GrabberImpl for more details */
        inline V4L2Grabber(){}
    };

  } // namespace io
}