include/cinder/Capture.h

Go to the documentation of this file.

/*
 Copyright (c) 2010, The Barbarian Group
 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.

 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 HOLDER 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.
*/

#pragma once

#include "cinder/Cinder.h"
#include "cinder/Surface.h"
#include "cinder/Exception.h"

#if defined( CINDER_MAC )
    #if defined( __OBJC__ )
        @class CaptureImplQtKit;
        @class QTCaptureDevice;
    #else
        class CaptureImplQtKit;
        class QTCaptureDevice;
    #endif
#elif defined( CINDER_COCOA_TOUCH_SIMULATOR )
    #if defined( __OBJC__ )
        @class CaptureImplCocoaDummy;
    #else
        class CaptureImplCocoaDummy;
    #endif
#elif defined( CINDER_COCOA_TOUCH_DEVICE )
    #if defined( __OBJC__ )
        @class CaptureImplAvFoundation;
    #else
        class CaptureImplAvFoundation;
    #endif
#elif defined( CINDER_MSW )
    namespace cinder {
        class CaptureImplDirectShow;
    }
#endif

#include <map>

namespace cinder {

typedef std::shared_ptr<class Capture>  CaptureRef;

class Capture {
  public:
    class Device;
    typedef std::shared_ptr<Device> DeviceRef;

    static CaptureRef   create( int32_t width, int32_t height, const DeviceRef device = DeviceRef() ) { return CaptureRef( new Capture( width, height, device ) ); }

    Capture() {}
    Capture( int32_t width, int32_t height, const DeviceRef device = DeviceRef() );
    ~Capture() {}

    void        start();
    void        stop();
    bool        isCapturing();

    bool        checkNewFrame() const;

    int32_t     getWidth() const;
    int32_t     getHeight() const;
    Vec2i       getSize() const { return Vec2i( getWidth(), getHeight() ); }
    float       getAspectRatio() const { return getWidth() / (float)getHeight(); }
    Area        getBounds() const { return Area( 0, 0, getWidth(), getHeight() ); }
    
    Surface8u   getSurface() const;
    const Capture::DeviceRef getDevice() const;

    static const std::vector<DeviceRef>&    getDevices( bool forceRefresh = false );
    static DeviceRef findDeviceByName( const std::string &name );
    static DeviceRef findDeviceByNameContains( const std::string &nameFragment );

#if defined( CINDER_COCOA )
    typedef std::string DeviceIdentifier;
#else
    typedef int DeviceIdentifier;
#endif

    // This is an abstract base class for implementing platform specific devices
    class Device {
     public:
        virtual ~Device() {}
        const std::string&                  getName() const { return mName; }
        virtual bool                        checkAvailable() const = 0;
        virtual bool                        isConnected() const = 0;
        virtual Capture::DeviceIdentifier   getUniqueId() const = 0;
#if defined( CINDER_COCOA )
        virtual void*       getNative() const = 0;
#endif
#if defined( CINDER_COCOA_TOUCH )

        virtual bool        isFrontFacing() const = 0;
#endif
     protected:
        Device() {}
        std::string     mName;
    };
        
 protected: 
    struct Obj {
        Obj( int32_t width, int32_t height, const Capture::DeviceRef device );
        virtual ~Obj();

#if defined( CINDER_MAC ) 
        CaptureImplQtKit                *mImpl;
#elif defined( CINDER_COCOA_TOUCH_SIMULATOR )
        CaptureImplCocoaDummy           *mImpl;
#elif defined( CINDER_COCOA_TOUCH_DEVICE )
        CaptureImplAvFoundation         *mImpl;
#elif defined( CINDER_MSW )
        CaptureImplDirectShow           *mImpl;
#endif
    };
    
    std::shared_ptr<Obj>                mObj;
    
  public:

    typedef std::shared_ptr<Obj> Capture::*unspecified_bool_type;
    operator unspecified_bool_type() const { return ( mObj.get() == 0 ) ? 0 : &Capture::mObj; }
    void reset() { mObj.reset(); }
};

class CaptureExc : public Exception {
};

class CaptureExcInitFail : public CaptureExc {
};

class CaptureExcInvalidChannelOrder : public CaptureExc {
};

} //namespace cinder