Cinder

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 CaptureCocoa;
        @class QTCaptureDevice;
#   else
        class CaptureCocoa;
        class QTCaptureDevice;
#   endif
#elif defined( CINDER_MSW )
#   include "msw/videoInput/videoInput.h"
#endif

#include <map>

namespace cinder {

class Capture {
 public:
    class Device;
    
    Capture() {}
    Capture( int32_t width, int32_t height, const Device &device = Device() );
    ~Capture() {}

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

    bool        checkNewFrame() const;

    int32_t     getWidth() const { return mObj->mWidth; }
    int32_t     getHeight() const { return mObj->mHeight; }
    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;
    Device      getDevice() const { return mObj->mDevice; }

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

    class Device {
      public:
        const std::string&      getName() const { return mName; }
        bool                    checkAvailable() const;
        bool                    isConnected() const;

    #if defined( CINDER_MAC )
        const std::string&      getUniqueId() const { return mUniqueId; }
    #else
        int                     getUniqueId() const { return mUniqueId; }
    #endif

    #if defined( CINDER_MAC )
        Device() {} // this represents a null device
    #else
        Device() : mUniqueId( 0 ) {}
    #endif
     protected:
    #if defined( CINDER_MAC )
        Device( QTCaptureDevice* device );
    #else
        Device( const std::string &name, int uniqueId ) : mName( name ), mUniqueId( uniqueId ) {}
    #endif

        std::string     mName;
    #if defined( CINDER_MAC )
        std::string     mUniqueId;
    #else
        int             mUniqueId;
    #endif
    
        friend class Capture;
    };
        
 protected: 
    struct Obj {
        Obj( int32_t width, int32_t height, const Capture::Device &device );
        virtual ~Obj();

#if defined( CINDER_MAC ) 
        CaptureCocoa        *mImpl;
#elif defined( CINDER_MSW )
        int                             mDeviceID;
        // this maintains a reference to the mgr so that we don't destroy it before
        // the last Capture is destroyed
        shared_ptr<class CaptureMgr>    mMgrPtr;
        bool                            mIsCapturing;
        shared_ptr<class SurfaceCache>  mSurfaceCache;
#endif
        int32_t             mWidth, mHeight;
        mutable Surface8u   mCurrentFrame;
        Capture::Device     mDevice;
    };
    
    shared_ptr<Obj>                     mObj;
    static bool                         sDevicesEnumerated;
    static std::vector<Capture::Device> sDevices;
    
  public:

    typedef shared_ptr<Obj> Capture::*unspecified_bool_type;
    operator unspecified_bool_type() { 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