/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLIO/src/ICLIO/OpenCVCamGrabber.h                     **
** Module : ICLIO                                                  **
** Authors: Christian Groszewski, Christof Elbrechter, Viktor      **
**          Richter                                                **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** 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 <ICLUtils/CompatMacros.h>
#include <ICLCore/OpenCV.h>
#include <ICLIO/Grabber.h>
#include <ICLUtils/Exception.h>
#include <ICLUtils/Mutex.h>

#ifdef ICL_HAVE_OPENCV
#ifdef ICL_HAVE_OPENCV_OLD_STYLE
#include <opencv/highgui.h>
#include <opencv/cxcore.h>
#else
#include <opencv2/highgui/highgui_c.h>
#include <opencv/cxcore.h>
#endif
#endif
namespace icl{
  namespace io{

    /// Grabber class that uses OpenCV's grabbing function to grab camera images
    class ICLIO_API OpenCVCamGrabber : public Grabber{
      private:
        /// Wrapped Device struct
        CvCapture *cvc;
        ///number of device
        int device;
        ///
        utils::Mutex m_mutex;
        ///Buffer for imagescaling
        core::ImgBase *m_buffer;
      public:

        /// grab function grabs an image (destination image is adapted on demand)
        /** @copydoc icl::io::Grabber::grab(core::ImgBase**) **/
        virtual const core::ImgBase *acquireImage();

        /// callback for changed configurable properties
        void processPropertyChange(const utils::Configurable::Property &prop);

        /// Creates new OpenCV based grabber
        /** @param dev specifies the device index
             (0 chooses any available device automatically)
          you can also use
          opencv's so called 'domain offsets': current values are:
          - 100 MIL-drivers (proprietary)
          - 200 V4L,V4L2 and VFW,
          - 300 Firewire,
          - 400 TXYZ (proprietary)
          - 500 QuickTime
          - 600 Unicap
          - 700 Direct Show Video Input
          (e.g. device ID 301 selects the 2nd firewire device)
       */
        OpenCVCamGrabber(int dev=0) throw (utils::ICLException);

        /// Destructor
        ~OpenCVCamGrabber();

                // returns a list of all valid device IDs
        /** Internally, for each device index i=0,1,2,...,
          a grabber-instance is created. If any of these creation trys returns an error,
          no further devices are tested.
          @param rescan if this params is a positive or zero integer, it defines the
          last device ID that is tried internally */

        /// simpler version of getDeviceListN detecting a maxinum of 100 devices
        static const std::vector<GrabberDeviceDescription> &getDeviceList(std::string hint, bool rescan);
    };

  } // namespace io
}