VideoWrapperTypes.h

Go to the documentation of this file.

//  ==========================================================================================
//  ==========================================================================================

#ifndef _VIDEOWRAPPERTYPES_H
#define _VIDEOWRAPPERTYPES_H


#if defined(_WIN32) || defined(WIN32) || defined(__WIN32__)
   #include <windows.h>
#else
    #ifndef UNIX
        #define UNIX
    #endif
#endif

// ------------------------------------------------------------------------------------------
// misc. type definitions
// ------------------------------------------------------------------------------------------

typedef int VWBool;

#ifndef TRUE
    #define TRUE    1
    #define FALSE   0
#endif


// ------------------------------------------------------------------------------------------
// video library and camera handles
// ------------------------------------------------------------------------------------------

typedef unsigned short VWHVideo;

typedef unsigned char VWHCamera;

//
// Makes a video handle from two bytes representing the video lib id and 
// the camera id within that lib
//
#define MAKE_VIDEO_HANDLE(lib, cam)     ((unsigned short)(((unsigned char)((unsigned long)(cam) & 0xff)) | ((unsigned short)((unsigned char)((unsigned long)(lib) & 0xff))) << 8))

//
// Extracts the camera id (low byte) from a video handle.
//
#define VIDEO_HANDLE_CAMBYTE(w) ((unsigned char)((unsigned long)(w) & 0xff))

//
// Extracts the video library id (hight byte) from a video handle.
//
#define VIDEO_HANDLE_LIBBYTE(w) ((unsigned char)((unsigned long)(w) >> 8))

// ------------------------------------------------------------------------------------------
// result codes
// ------------------------------------------------------------------------------------------







typedef int VWResult;

// REMEMBER to update the VW_RESULT_DESCRIPTIONS macro when adding or modifying 
// the result code symbols.

#define VW_SUCCESS                                      0               
#define VW_E_ERROR                                      1               
#define VW_E_NOT_IMPLEMENTED            100             
#define VW_E_INVALID_HANDLE                     101             
#define VW_E_INVALID_CONFIG_STRING      102             
#define VW_E_LIB_NOT_LOADED                     103             
#define VW_E_LIB_ALREADY_LOADED         104             
#define VW_E_LIB_LOAD_FAILED            105             
#define VW_E_INVALID_CAMERA_ID          106             
#define VW_E_MEMORY_ALLOCATION          107             
#define VW_E_CAM_NOT_INITIALIZED        108             
#define VW_E_STRING_OVERFLOW            109             
#define VW_E_NOT_STARTED                        110             
#define VW_E_PLAYING                            300             
#define VW_E_NOT_PLAYING                        301             
#define VW_E_CAPTURING                          302             
#define VW_E_NOT_CAPTURING                      303             
#define VW_E_NO_CAPTURE_DATA            304             
#define VW_E_CANT_CAPTURE_REPLAY        305             
#define VW_E_WRITE_FAILED                       400             
#define VW_E_READ_FAILED                        401             
#define VW_E_NOT_REPLAY_CAM                     402             
#define VW_E_UNSUPPORTED_PROPERTY       500             
#define VW_E_AUTO_UNSUPPORTED           501             
#define VW_E_OUT_OF_RANGE                       502             
#define VW_E_INTERNAL_ERROR                     900             
// This macro is used by VIDEO_getErrDescription in VideoWrapper to generate descriptions of result codes.
// There shouldn't be any need for this macro elsewhere.
#define VW_RESULT_DESCRIPTIONS  \
        VW_RESULT_DESC( VW_SUCCESS,                                     "The function succeeded.")\
        VW_RESULT_DESC( VW_E_ERROR,                                     "Unspecified error.")\
        VW_RESULT_DESC( VW_E_NOT_IMPLEMENTED,           "The function is not implemented.")\
        VW_RESULT_DESC( VW_E_INVALID_HANDLE,            "The handle is unknown.")\
        VW_RESULT_DESC( VW_E_INVALID_CONFIG_STRING,     "The configuration string is invalid.")\
        VW_RESULT_DESC( VW_E_LIB_NOT_LOADED,            "The requested library is not loaded.")\
        VW_RESULT_DESC( VW_E_LIB_ALREADY_LOADED,        "The requested library is already loaded.")\
        VW_RESULT_DESC( VW_E_LIB_LOAD_FAILED,           "The library failed to load.")\
        VW_RESULT_DESC( VW_E_INVALID_CAMERA_ID,         "The camera id specified in the initialization string is not valid.")\
        VW_RESULT_DESC( VW_E_MEMORY_ALLOCATION,         "Memory allocation failed.")\
        VW_RESULT_DESC( VW_E_CAM_NOT_INITIALIZED,       "The camera has not been initialized.")\
        VW_RESULT_DESC( VW_E_STRING_OVERFLOW,           "The string has exceeded its alocated buffer.")\
        VW_RESULT_DESC( VW_E_NOT_STARTED,                       "The camera has not been started.")\
        VW_RESULT_DESC( VW_E_PLAYING,                           "Operation can not complete because playback is in progress.")\
        VW_RESULT_DESC( VW_E_NOT_PLAYING,                       "Operation can not complete because playback is not in progress.")\
        VW_RESULT_DESC( VW_E_CAPTURING,                         "Operation can not complete because capture is in progress.")\
        VW_RESULT_DESC( VW_E_NOT_CAPTURING,                     "Operation can not complete because capture is not in progress.")\
        VW_RESULT_DESC( VW_E_NO_CAPTURE_DATA,           "No captured data exists.")\
        VW_RESULT_DESC( VW_E_CANT_CAPTURE_REPLAY,       "Can not capture a replay camera.")\
        VW_RESULT_DESC( VW_E_WRITE_FAILED,                      "Failed to write to file.")\
        VW_RESULT_DESC( VW_E_READ_FAILED,                       "Failed to read from file.")\
        VW_RESULT_DESC( VW_E_NOT_REPLAY_CAM,            "The camera is not a replay camera.")\
        VW_RESULT_DESC( VW_E_UNSUPPORTED_PROPERTY,      "The camera property is unsupported.")\
        VW_RESULT_DESC( VW_E_AUTO_UNSUPPORTED,          "The camera property doesn't support automatic control.")\
        VW_RESULT_DESC( VW_E_OUT_OF_RANGE,                      "The camera property value is out of range.")\
        VW_RESULT_DESC( VW_E_INTERNAL_ERROR,            "An unexpected, internal error has occurred within the API.")


#define VW_SUCCEEDED(code)      (code == VW_SUCCESS)


// ------------------------------------------------------------------------------------------
// pixel format
// ------------------------------------------------------------------------------------------












typedef int VWPixelFormat;

// TODO: determine if all of these are needed.
// TODO: doc pixel formats
#define VW_PF_COLOR_INDEX                       0x1900  
#define VW_PF_STENCIL_INDEX                     0x1901  
#define VW_PF_DEPTH_COMPONENT           0x1902  
#define VW_PF_RED                                       0x1903  
#define VW_PF_GREEN                                     0x1904  
#define VW_PF_BLUE                                      0x1905  
#define VW_PF_ALPHA                                     0x1906  
#define VW_PF_RGB                                       0x1907  
#define VW_PF_RGBA                                      0x1908  
#define VW_PF_LUMINANCE                         0x1909  
#define VW_PF_LUMINANCE_ALPHA           0x190A  
#define VW_PF_BGR_EXT               0x80E0      
#define VW_PF_BGRA_EXT              0x80E1      

// ------------------------------------------------------------------------------------------
// camera image properties
// ------------------------------------------------------------------------------------------












typedef int VWCamProp;

// built-in properties
#define VWCAMPROP_BRIGHTNESS                            100     
#define VWCAMPROP_CONTRAST                                      101     
#define VWCAMPROP_HUE                                           102     
#define VWCAMPROP_SATURATION                            103     
#define VWCAMPROP_SHARPNESS                                     104     
#define VWCAMPROP_GAMMA                                         105     
#define VWCAMPROP_COLORENABLE                           106     
#define VWCAMPROP_WHITEBALANCE                          107     
#define VWCAMPROP_BACKLIGHTCOMPENSATION         108     
#define VWCAMPROP_GAIN                                          109     
#define VWCAMPROP_EXPOSURE                                      110     
#define VWCAMPROP_IRIS                                          111     
#define VWCAMPROP_FOCUS                                         112     
#define VWCAMPROP_ZOOM                                          113     
#define VWCAMPROP_PAN                                           114     
#define VWCAMPROP_TILT                                          115     
#define VWCAMPROP_SHUTTER                                       116     
#define VWCAMPROP_TRIGGER_DELAY                         117     










#define VWCAMPROP_CUSTOM                                        1000


// ------------------------------------------------------------------------------------------
// misc. symbols
// ------------------------------------------------------------------------------------------

#define VW_UNLIMITED_BUFFER             -1


#endif // ifndef _VIDEOWRAPPERTYPES_H

---