Video4Linux.h

/**
 * @class   wosh::interfaces::entertainment::Video4Linux
 * @brief   Standard interface of generic audio player (device).
 *
 *
 * @see     wosh::entertainment::PlayerPlayerMPDBundle
 * @ingroup Interfaces
 ****************************************************************************
 * @version 0.8.384 $Id: Video4Linux.h 3775 2011-01-01 16:38:17Z alex $
 * @author  Alessandro Polo
 ****************************************************************************/
/* Copyright (c) 2007-2011, WOSH - Wide Open Smart Home 
 * by Alessandro Polo - OpenSmartHome.com
 * 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 OpenSmartHome.com WOSH 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 Alessandro Polo ''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 Alessandro Polo 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.
 ****************************************************************************/

#ifndef __WOSH_Interfaces_Entertainment_Video4Linux_H__
 #define __WOSH_Interfaces_Entertainment_Video4Linux_H__

 #include <interfaces/Interface.h>


namespace wosh {
 namespace interfaces {
  namespace entertainment {

 #define _Video4Linux_KEY_StreamBusType         "StreamBusType"
 #define _Video4Linux_DEFAULT_StreamBusType     "wosh::BusMT"

 #define _Video4Linux_KEY_VideoDevice           "VideoDevice"

 #define _Video4Linux_DEFAULT_VideoDevice       "/dev/video0"


class Video4Linux : public virtual Interface
 {
    WOSH_INTERFACE(wosh::interfaces::entertainment::Video4Linux)

/** @name Video4Linux Interface
 * @{
 ******************************************************************************/
    public:
        /**
         * @brief  Connect to device.
         * @return VIPRET_PARAMS_ERR if inputfile is NULL, VIP_ILLEGAL_USE
         *         if a device is already connected, VIPRET_INTERNAL_ERR
         *         if any error occured, VIPRET_OK else.
         */
        virtual WRESULT connectDevice( const std::string& inputFile = _Video4Linux_DEFAULT_VideoDevice, unsigned long timeout = LIMIT_ULONG_MAX ) = 0;

        /**
         * @brief  Disconnect from current device.
         * @return WRET_ERR if no device is connected, VIPRET_OK else.
         */
        virtual WRESULT disconnectDevice( unsigned long timeout = LIMIT_ULONG_MAX ) = 0;

        virtual WRESULT extractFrame( unsigned char* buffer, long size ) = 0;

        virtual const std::string& getVideoDevice() const = 0;

//@}
    public:
        virtual ~Video4Linux() { }

}; // class def



class Video4LinuxListener
 {
/** @name Video4LinuxListener interface
 * @{
 ******************************************************************************/
    public:
    
//@}
    public:
        virtual ~Video4LinuxListener() { }

}; // class def


  }; // namespace entertainment
 }; // namespace interfaces
}; // namespace wosh

#endif //__WOSH_Interfaces_Entertainment_Video4Linux_H__