libuvcc-defs.h

/* warning: mixed naming conventions! */
#ifndef __LIBUVCC_DEFS_H__
#define __LIBUVCC_DEFS_H__

#include <IOKit/usb/USB.h>

#define USB_BASE_CLASS_DEV      0x00
#define USB_BASE_CLASS_COM      0x02
#define USB_BASE_CLASS_HID      0x03
#define USB_BASE_CLASS_PHYS     0x05
#define USB_BASE_CLASS_IMG      0x06
#define USB_BASE_CLASS_CDC      0x0a
#define USB_BASE_CLASS_VID      0x0e
#define USB_BASE_CLASS_MISC     0xef
#define USB_BASE_CLASS_APP      0xfe
#define USB_BASE_CLASS_VEND     0xff

#define USB_SUB_CLASS_VID_CTRL  0x01

#define USB_RT_TD_SET       0x00        
#define USB_RT_TD_GET       0x80        
#define USB_RT_TY_STD       (0x00 << 5) 
#define USB_RT_TY_CLASS     (0x01 << 5) 
#define USB_RT_TY_VENDOR    (0x02 << 5) 
#define USB_RT_TY_RESERVED  (0x03 << 5) 
#define USB_RT_RE_DEVICE    0x00        
#define USB_RT_RE_IFACE     0x01        
#define USB_RT_RE_ENDPOINT  0x02        
#define USB_RT_RE_OTHER     0x03        
#define USB_REQ_GET_STATUS  0x00
#define USB_REQ_CLEAR_FEAT  0x01
/* 0x02 reserved for future use */
#define USB_REQ_SET_FEAT    0x03
/* 0x04 reserved for future use */
#define USB_REQ_SET_ADDR    0x05
#define USB_REQ_GET_DESC    0x06
#define USB_REQ_SET_DESC    0x07
#define USB_REQ_GET_CONF    0x08
#define USB_REQ_SET_CONF    0x09
#define USB_REQ_GET_IFACE   0x0a
#define USB_REQ_SET_IFACE   0x0b
#define USB_REQ_SYNCH_FRAME 0x0c

#define USB_DESC_DEV                0x01
#define USB_DESC_CONFIG             0x02
#define USB_DESC_STRING             0x03
#define USB_DESC_IFACE              0x04
#define USB_DESC_EP                 0x05
#define USB_DESC_DEV_QUALIFIER      0x06
#define USB_DESC_OTHER_SPEED_CONF   0x07
#define USB_DESC_IFACE_POWER        0x08

#define UVC_DESC_UNDEFINED          0x20
#define UVC_DESC_DEV                0x21
#define UVC_DESC_CONF               0x22
#define UVC_DESC_STRING             0x23
#define UVC_DESC_IFACE              0x24
#define UVC_DESC_EP                 0x25
#define UVC_DESC_IFACE_UNDEFINED        0x00
#define UVC_DESC_IFACE_HEADER           0x01
#define UVC_DESC_IFACE_INPUT_TERMINAL   0x02
#define UVC_DESC_IFACE_OUTPUT_TERMINAL  0x03
#define UVC_DESC_IFACE_SELECTOR_UNIT    0x04
#define UVC_DESC_IFACE_PROCESSING_UNIT  0x05
#define UVC_DESC_IFACE_EXTENSION_UNIT   0x06

#define UVC_ITT_VENDOR_SPEC             0x0200
#define UVC_ITT_CAMERA                  0x0201
#define UVC_ITT_MEDIA_TRANSPORT_INPUT   0x0202

#define UVC_RC_UNDEFINED                    0x00
#define UVC_SET_CUR                         0x01
#define UVC_GET_CUR                         0x81
#define UVC_GET_MIN                         0x82
#define UVC_GET_MAX                         0x83
#define UVC_GET_RES                         0x84
#define UVC_GET_LEN                         0x85
#define UVC_GET_INFO                        0x86
#define UVC_GET_DEF                         0x87

/* this should be enumed! */
#define UVC_VC_CONTROL_UNDEFINED                0x00
#define UVC_VC_VIDEO_POWER_MODE_CONTROL         0x01
#define UVC_VC_REQUEST_ERROR_CODE_CONTROL       0x02
#define UVC_CT_CONTROL_UNDEFINED                0x00
#define UVC_CT_SCANNING_MODE_CONTROL            (0x01 << 8)
#define UVC_CT_AE_MODE_CONTROL                  (0x02 << 8)
#define UVC_CT_AE_PRIORITY_CONTROL              (0x03 << 8)
#define UVC_CT_EXPOSURE_TIME_ABSOLUTE_CONTROL   (0x04 << 8)
#define UVC_CT_EXPOSURE_TIME_RELATIVE_CONTROL   (0x05 << 8)
#define UVC_CT_FOCUS_ABSOLUTE_CONTROL           (0x06 << 8)
#define UVC_CT_FOCUS_RELATIVE_CONTROL           (0x07 << 8)
#define UVC_CT_FOCUS_AUTO_CONTROL               (0x08 << 8)
#define UVC_CT_IRIS_ABSOLUTE_CONTROL            (0x09 << 8)
#define UVC_CT_IRIS_RELATIVE_CONTROL            (0x0a << 8)
#define UVC_CT_ZOOM_ABSOLUTE_CONTROL            (0x0b << 8)
#define UVC_CT_ZOOM_RELATIVE_CONTROL            (0x0c << 8)
#define UVC_CT_PANTILT_ABSOLUTE_CONTROL         (0x0d << 8)
#define UVC_CT_PANTILT_RELATIVE_CONTROL         (0x0e << 8)
#define UVC_CT_ROLL_ABSOLUTE_CONTROL            (0x0f << 8)
#define UVC_CT_ROLL_RELATIVE_CONTROL            (0x10 << 8)
#define UVC_CT_PRIVACY_CONTROL                  (0x11 << 8)
#define UVC_PU_CONTROL_UNDEFINED                        (0x00 << 8)
#define UVC_PU_BACKLIGHT_COMPENSATION_CONTROL           (0x01 << 8)
#define UVC_PU_BRIGHTNESS_CONTROL                       (0x02 << 8)
#define UVC_PU_CONTRAST_CONTROL                         (0x03 << 8)
#define UVC_PU_GAIN_CONTROL                             (0x04 << 8)
#define UVC_PU_POWER_LINE_FREQUENCY_CONTROL             (0x05 << 8)
#define UVC_PU_HUE_CONTROL                              (0x06 << 8)
#define UVC_PU_SATURATION_CONTROL                       (0x07 << 8)
#define UVC_PU_SHARPNESS_CONTROL                        (0x08 << 8)
#define UVC_PU_GAMMA_CONTROL                            (0x09 << 8)
#define UVC_PU_WHITE_BALANCE_TEMPERATURE_CONTROL        (0x0a << 8)
#define UVC_PU_WHITE_BALANCE_TEMPERATURE_AUTO_CONTROL   (0x0b << 8)
#define UVC_PU_WHITE_BALANCE_COMPONENT_CONTROL          (0x0c << 8)
#define UVC_PU_WHITE_BALANCE_COMPONENT_AUTO_CONTROL     (0x0d << 8)
#define UVC_PU_DIGITAL_MULTIPLIER_CONTROL               (0x0e << 8)
#define UVC_PU_DIGITAL_MULTIPLIER_LIMIT_CONTROL         (0x0f << 8)
#define UVC_PU_HUE_AUTO_CONTROL                         (0x10 << 8)
#define UVC_PU_ANALOG_VIDEO_STANDARD_CONTROL            (0x11 << 8)
#define UVC_PU_ANALOG_LOCK_STATUS_CONTROL               (0x12 << 8)

#define UVCC_BMRT_SET   USB_RT_TD_SET | USB_RT_TY_CLASS | USB_RT_RE_IFACE
#define UVCC_BMRT_GET   USB_RT_TD_GET | USB_RT_TY_CLASS | USB_RT_RE_IFACE

#define UVCC_INFO_GET_SUPPORT           (int8_t)0x01
#define UVCC_INFO_SET_SUPPORT           (int8_t)0x02
#define UVCC_INFO_DISABLED_BY_AUTOCTRL  (int8_t)0x04
#define UVCC_INFO_ASYNC_CTRL            (int8_t)0x08

#define UVCC_AUTO_OFF   (uint8_t)0x00
#define UVCC_AUTO_ON    (uint8_t)0x01

#define UVCC_SCANNING_MODE_INTERLACED   (uint8_t)0x00
#define UVCC_SCANNING_MODE_PROGRESSIVE  (uint8_t)0x01

#define UVCC_EXPOSURE_MODE_MANUAL           (int8_t)0x01
#define UVCC_EXPOSURE_MODE_AUTO             (int8_t)0x02
#define UVCC_EXPOSURE_MODE_SHUTTER_PRIO     (int8_t)0x04
#define UVCC_EXPOSURE_MODE_APERTURE_PRIO    (int8_t)0x08

#define UVCC_EXPOSURE_PRIO_CTRL_CONSTANT    (int8_t)0x00
#define UVCC_EXPOSURE_PRIO_CTRL_DYNAMIC     (int8_t)0x01

#define UVCC_POWER_LINE_FREQUENCE_DISABLED  (int8_t)0x00
#define UVCC_POWER_LINE_FREQUENCY_50HZ      (int8_t)0x01
#define UVCC_POWER_LINE_FREQUENCY_60HZ      (int8_t)0x02

typedef IOUSBDeviceInterface320 usbDevIf;
typedef IOUSBInterfaceInterface197 usbIfIf;

enum uvccDevSpeed {
    UVCC_DEV_SPEED_1_5_MBPS     = kUSBDeviceSpeedLow,
    UVCC_DEV_SPEED_12_MBPS      = kUSBDeviceSpeedFull,
    UVCC_DEV_SPEED_480_MBPS     = kUSBDeviceSpeedHigh,
    UVCC_DEV_SPEED_5000_MBPS    = kUSBDeviceSpeedSuper,
    UVCC_DEV_SPEED_USB_1A       = UVCC_DEV_SPEED_1_5_MBPS,
    UVCC_DEV_SPEED_USB_1B       = UVCC_DEV_SPEED_12_MBPS,
    UVCC_DEV_SPEED_USB_2        = UVCC_DEV_SPEED_480_MBPS,
    UVCC_DEV_SPEED_USB_3        = UVCC_DEV_SPEED_5000_MBPS
};
    
enum uvccError
{
    UVCC_ERR_EU_INDEX_OUT_OF_RANGE = -11,
    UVCC_ERR_EU_REQ_INDEX_OUT_OF_RANGE,
    UVCC_ERR_CREATE_MASTER_PORT_FAIL,
    UVCC_ERR_CAM_IS_NULL,
    UVCC_ERR_INTERFACE_IS_NULL,
    UVCC_ERR_CTRL_REQUEST_IS_NULL,
    UVCC_ERR_UNKNOWN_REQUEST,
    UVCC_ERR_UNKNOWN_UVC_REQUEST,
    UVCC_ERR_USB_OPEN_FAILED,
    UVCC_ERR_CTRL_REQUEST_UNSUPPORTED_OR_MALFORMATTED,
    UVCC_ERR_CTRL_REQUEST_FAILED,
    UVCC_ERR_NO_ERROR = 0
};

enum uvccWarning
{
    UVCC_WARN_NO_WARNING,
    UVCC_WARN_LOGGING_TO_STDERR
};

enum uvccRequest
{   /* note that these are just indicies in predef_reqs so don't change the order ! */
    UVCC_REQ_SCANNING_MODE,
    UVCC_REQ_EXPOSURE_AUTOMODE,
    UVCC_REQ_EXPOSURE_AUTOPRIO,
    UVCC_REQ_EXPOSURE_ABS,
    UVCC_REQ_EXPOSURE_REL,
    UVCC_REQ_FOCUS_AUTO,
    UVCC_REQ_FOCUS_ABS,
    UVCC_REQ_FOCUS_REL,
    UVCC_REQ_IRIS_ABS,
    UVCC_REQ_IRIS_REL,
    UVCC_REQ_BACKLIGHT_COMPENSATION_ABS,
    UVCC_REQ_BRIGHTNESS_ABS,
    UVCC_REQ_CONTRAST_ABS,
    UVCC_REQ_GAIN_ABS,
    UVCC_REQ_POWER_LINE_FREQ,
    UVCC_REQ_HUE_AUTO,
    UVCC_REQ_HUE_ABS,
    UVCC_REQ_SATURATION_ABS,
    UVCC_REQ_SHARPNESS_ABS,
    UVCC_REQ_GAMMA_ABS,
    UVCC_REQ_WB_TEMPERATURE_AUTO,
    UVCC_REQ_WB_TEMPERATURE_ABS,
    UVCC_REQ_WB_COMPONENT_AUTO,
    UVCC_REQ_WB_COMPONENT_ABS,
    __UVCC_REQ_OUT_OF_RANGE
};

enum uvccCtSupportFlags
{
    UVCC_CTSM_UNDEFINED         = 0x00000,
    UVCC_CTSM_SCANNING_MODE     = 0x00001,
    UVCC_CTSM_ET_AUTOMODE       = 0x00002,
    UVCC_CTSM_ET_AUTOPRIO       = 0x00004,
    UVCC_CTSM_ET_ABSOLUTE       = 0x00008,
    UVCC_CTSM_ET_RELATIVE       = 0x00010,
    UVCC_CTSM_FOCUS_ABSOLUTE    = 0x00020,
    UVCC_CTSM_FOCUS_RELATIVE    = 0x00040,
    UVCC_CTSM_IRIS_ABSOLUTE     = 0x00080,
    UVCC_CTSM_IRIS_RELATIVE     = 0x00100,
    UVCC_CTSM_ZOOM_ABSOLUTE     = 0x00200,
    UVCC_CTSM_ZOOM_RELATIVE     = 0x00400,
    UVCC_CTSM_PANTILT_ABSOLUTE  = 0x00800,
    UVCC_CTSM_PANTILT_RELATIVE  = 0x01000,
    UVCC_CTSM_ROLL_ABSOLUTE     = 0x02000,
    UVCC_CTSM_ROLL_RELATIVE     = 0x04000,
    UVCC_CTSM_RESERVED_A        = 0x08000,
    UVCC_CTSM_RESERVED_B        = 0x10000,
    UVCC_CTSM_FOCUS_AUTO        = 0x20000,
    UVCC_CTSM_PRIVACY           = 0x40000
};

enum uvccPuSupportFlags
{
    UVCC_PUSM_UNDEFINED                 = 0x00000,
    UVCC_PUSM_BRIGHTNESS                = 0x00001,
    UVCC_PUSM_CONTRAST                  = 0x00002,
    UVCC_PUSM_HUE                       = 0x00004,
    UVCC_PUSM_SATURATION                = 0x00008,
    UVCC_PUSM_SHARPNESS                 = 0x00010,
    UVCC_PUSM_GAMMA                     = 0x00020,
    UVCC_PUSM_WB_TEMPERATURE            = 0x00040,
    UVCC_PUSM_WB_COMPONENT              = 0x00080,
    UVCC_PUSM_BACKLIGHT_COMPENSATION    = 0x00100,
    UVCC_PUSM_GAIN                      = 0x00200,
    UVCC_PUSM_POWER_LINE_FREQUENCY      = 0x00400,
    UVCC_PUSM_HUE_AUTO                  = 0x00800,
    UVCC_PUSM_WB_TEMPERATURE_AUTO       = 0x01000,
    UVCC_PUSM_WB_COMPONENT_AUTO         = 0x02000,
    UVCC_PUSM_DIGITAL_MULTIPLIER        = 0x04000,
    UVCC_PUSM_DIGITAL_MULTIPLIER_LIMIT  = 0x08000,
    UVCC_PUSM_ANALOG_VIDEO_STANDARD     = 0x10000,
    UVCC_PUSM_ANALOG_LOCK_STATUS        = 0x20000
};

/* uvc iface descriptors (the only ones i care about), first three fields are
   always the same.. crazy sizes and casting means packing is needed */
#pragma pack(1)
struct uvcIfaceDesc
{
    uint8_t     bLength;
    uint8_t     bDescriptorType;
    uint8_t     bDescriptorSubType;
    uint16_t    bcdUVC;             
    uint16_t    wTotalLength;
    uint32_t    dwClockFrequency;
    uint8_t     bInCollection;      
    uint8_t     baInterfaceNr[1];   
};
#pragma options align = reset

#pragma pack(1)
struct uvcITDesc
{
    uint8_t     bLength;
    uint8_t     bDescriptorType;
    uint8_t     bDescriptorSubType;
    uint8_t     bTerminalID;
    uint16_t    wTerminalType;
    uint8_t     bAssocTerminal;
    uint8_t     bSourceID;
    uint8_t     iTerminal;
};
#pragma options align = reset

#pragma pack(1)
struct uvcCTDesc
{
    uint8_t     bLength;    
    uint8_t     bDescriptorType;
    uint8_t     bDescriptorSubType;
    uint8_t     bTerminalID;
    uint16_t    wTerminalType;
    uint8_t     bAssocTerminal;
    uint8_t     iTerminal;
    uint16_t    wObjectiveFocalLengthMin;
    uint16_t    wObjectiveFocalLengthMax;
    uint16_t    wOcularFocalLength;
    uint8_t     bControlSize;
    uint8_t     bmControls[1];
};
#pragma options align = reset

#pragma pack(1)
struct uvcPUDesc
{
    uint8_t     bLength;    
    uint8_t     bDescriptorType;
    uint8_t     bDescriptorSubType;
    uint8_t     bUnitID;
    uint8_t     bSourceID;
    uint16_t    wMaxMultiplier;
    uint8_t     bControlSize;
    uint8_t     bmControls[1];
};
#pragma options align = reset

#pragma pack(1)
struct uvcEUDescA
{
    uint8_t bLength;    
    uint8_t bDescriptorType;
    uint8_t bDescriptorSubType;
    uint8_t bUnitID;
    uint8_t guidFormat[16];
    uint8_t bNumControls;
    uint8_t bNrInPins;
    uint8_t baSourceID[1];
};
#pragma options align = reset

#pragma pack(1)
struct uvcEUDescB
{
    uint8_t bControlSize;
    uint8_t bmControls[1];  
};
#pragma options align = reset

#pragma pack(1)
struct uvcEUDescC
{
    uint8_t iExtension;
};
#pragma options align = reset

struct uvccModelID
{
    uint16_t idVendor;
    uint16_t idProduct;
};

struct uvccDevDesc
{   /* "soft" info */
    uint8_t     bDevClass;
    uint8_t     bDevSubClass;
    uint8_t     bDevProtocol;
    uint8_t     bDevSpeed;
    /* "hard" info */
    uint16_t    hwIdVendor;
    uint16_t    hwIdProduct;
    uint16_t    hwRelNo;
    uint8_t     bNumConfs;
    /* string indicies */
    uint8_t     bIManufacturer;
    uint8_t     bIProduct;
    uint8_t     bISerialNumber;
};

struct uvccCam
{
    uint32_t idLocation;
    /* mId is actually just a pointer into the devDesc */
    struct uvccModelID *mID;
//  IOUSBDeviceDescriptor devDesc;
    usbDevIf **devIf;
    struct uvccDevDesc devDesc;
    usbIfIf **ctrlIf;
    uint8_t ifNo, ctIndex, puIndex;
    uint8_t nEUs;           
    uint8_t *euIndicies;    
    uint8_t **euGUIDs;
    uint8_t *nEUReqs;       
    uint16_t **euWValues;   
    CFStringRef regName;
    /* info when fetched.. should be updated by listener. */
    uint32_t portInfo;
    uint32_t ctSupportMap;
    uint32_t puSupportMap;
};
typedef struct uvccCam uvccCam;


#endif