OpenNI 1.0.0
|
00001 /***************************************************************************** 00002 * * 00003 * OpenNI 1.0 Alpha * 00004 * Copyright (C) 2010 PrimeSense Ltd. * 00005 * * 00006 * This file is part of OpenNI. * 00007 * * 00008 * OpenNI is free software: you can redistribute it and/or modify * 00009 * it under the terms of the GNU Lesser General Public License as published * 00010 * by the Free Software Foundation, either version 3 of the License, or * 00011 * (at your option) any later version. * 00012 * * 00013 * OpenNI is distributed in the hope that it will be useful, * 00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * 00016 * GNU Lesser General Public License for more details. * 00017 * * 00018 * You should have received a copy of the GNU Lesser General Public License * 00019 * along with OpenNI. If not, see <http://www.gnu.org/licenses/>. * 00020 * * 00021 *****************************************************************************/ 00022 00023 00024 00025 00026 #ifndef _XN_USB_H_ 00027 #define _XN_USB_H_ 00028 00029 //--------------------------------------------------------------------------- 00030 // Includes 00031 //--------------------------------------------------------------------------- 00032 #include "XnOS.h" 00033 00034 //--------------------------------------------------------------------------- 00035 // Structures & Enums 00036 //--------------------------------------------------------------------------- 00037 typedef enum { 00038 XN_USB_DEVICE_LOW_SPEED = 0, 00039 XN_USB_DEVICE_FULL_SPEED, 00040 XN_USB_DEVICE_HIGH_SPEED, 00041 } XnUSBDeviceSpeed; 00042 00043 typedef enum { 00044 XN_USB_EP_BULK = 0, 00045 XN_USB_EP_ISOCHRONOUS, 00046 XN_USB_EP_INTERRUPT, 00047 } XnUSBEndPointType; 00048 00049 typedef enum { 00050 XN_USB_DIRECTION_IN = 0, 00051 XN_USB_DIRECTION_OUT, 00052 } XnUSBDirectionType; 00053 00054 typedef enum { 00055 XN_USB_CONTROL_TYPE_STANDARD = 0, 00056 XN_USB_CONTROL_TYPE_CLASS, 00057 XN_USB_CONTROL_TYPE_VENDOR, 00058 } XnUSBControlType; 00059 00060 typedef enum { 00061 XN_USB_EVENT_DEVICE_CONNECT = 0, 00062 XN_USB_EVENT_DEVICE_DISCONNECT, 00063 } XnUSBEventType; 00064 00065 struct XnUSBDeviceHandle; 00066 struct XnUSBEndPointHandle; 00067 00068 typedef XnChar XnUSBConnectionString[XN_FILE_MAX_PATH]; 00069 00070 typedef XnUSBDeviceHandle* XN_USB_DEV_HANDLE; 00071 typedef XnUSBEndPointHandle* XN_USB_EP_HANDLE; 00072 00073 typedef XnBool (XN_CALLBACK_TYPE* XnUSBReadCallbackFunctionPtr)(XnUChar* pBuffer, XnUInt32 nBufferSize, void* pCallbackData); 00074 typedef XnBool (XN_CALLBACK_TYPE* XnUSBEventCallbackFunctionPtr)(XnUSBEventType USBEventType, XnChar* cpDevPath, void* pCallbackData); 00075 00076 //--------------------------------------------------------------------------- 00077 // Exported Function Declaration 00078 //--------------------------------------------------------------------------- 00079 XN_C_API XnStatus xnUSBInit(); 00080 XN_C_API XnStatus xnUSBShutdown(); 00081 00082 XN_C_API XnStatus XN_API_DEPRECATED("Use xnUSBEnumerateDevices() instead") xnUSBIsDevicePresent(XnUInt16 nVendorID, XnUInt16 nProductID, void* pExtraParam, XnBool* pbDevicePresent); 00083 00084 XN_C_API XnStatus xnUSBEnumerateDevices(XnUInt16 nVendorID, XnUInt16 nProductID, const XnUSBConnectionString** pastrDevicePaths, XnUInt32* pnCount); 00085 XN_C_API void xnUSBFreeDevicesList(const XnUSBConnectionString* astrDevicePaths); 00086 00087 XN_C_API XnStatus XN_API_DEPRECATED("Use xnUSBOpenDeviceByPath() instead") xnUSBOpenDevice(XnUInt16 nVendorID, XnUInt16 nProductID, void* pExtraParam, void* pExtraParam2, XN_USB_DEV_HANDLE* pDevHandlePtr); 00088 XN_C_API XnStatus xnUSBOpenDeviceByPath(const XnUSBConnectionString strDevicePath, XN_USB_DEV_HANDLE* pDevHandlePtr); 00089 XN_C_API XnStatus xnUSBCloseDevice(XN_USB_DEV_HANDLE pDevHandle); 00090 00091 XN_C_API XnStatus xnUSBGetDeviceSpeed(XN_USB_DEV_HANDLE pDevHandle, XnUSBDeviceSpeed* pDevSpeed); 00092 00093 XN_C_API XnStatus xnUSBSetConfig(XN_USB_DEV_HANDLE pDevHandle, XnUInt8 nConfig); 00094 XN_C_API XnStatus xnUSBGetConfig(XN_USB_DEV_HANDLE pDevHandle, XnUInt8* pnConfig); 00095 00096 XN_C_API XnStatus xnUSBSetInterface(XN_USB_DEV_HANDLE pDevHandle, XnUInt8 nInterface, XnUInt8 nAltInterface); 00097 XN_C_API XnStatus xnUSBGetInterface(XN_USB_DEV_HANDLE pDevHandle, XnUInt8* pnInterface, XnUInt8* pnAltInterface); 00098 00099 XN_C_API XnStatus xnUSBOpenEndPoint(XN_USB_DEV_HANDLE pDevHandle, XnUInt16 nEndPointID, XnUSBEndPointType nEPType, XnUSBDirectionType nDirType, XN_USB_EP_HANDLE* pEPHandlePtr); 00100 XN_C_API XnStatus xnUSBCloseEndPoint(XN_USB_EP_HANDLE pEPHandle); 00101 XN_C_API XnStatus xnUSBGetEndPointMaxPacketSize(XN_USB_EP_HANDLE pEPHandle, XnUInt32* pnMaxPacketSize); 00102 00103 XN_C_API XnStatus xnUSBAbortEndPoint(XN_USB_EP_HANDLE pEPHandle); 00104 XN_C_API XnStatus xnUSBFlushEndPoint(XN_USB_EP_HANDLE pEPHandle); 00105 XN_C_API XnStatus xnUSBResetEndPoint(XN_USB_EP_HANDLE pEPHandle); 00106 00107 XN_C_API XnStatus xnUSBSendControl(XN_USB_DEV_HANDLE pDevHandle, XnUSBControlType nType, XnUInt8 nRequest, XnUInt16 nValue, XnUInt16 nIndex, XnUChar* pBuffer, XnUInt32 nBufferSize, XnUInt32 nTimeOut); 00108 XN_C_API XnStatus xnUSBReceiveControl(XN_USB_DEV_HANDLE pDevHandle, XnUSBControlType nType, XnUInt8 nRequest, XnUInt16 nValue, XnUInt16 nIndex, XnUChar* pBuffer, XnUInt32 nBufferSize, XnUInt32* pnBytesReceived, XnUInt32 nTimeOut); 00109 00110 XN_C_API XnStatus xnUSBReadEndPoint(XN_USB_EP_HANDLE pEPHandle, XnUChar* pBuffer, XnUInt32 nBufferSize, XnUInt32* pnBytesReceived, XnUInt32 nTimeOut); 00111 XN_C_API XnStatus xnUSBWriteEndPoint(XN_USB_EP_HANDLE pEPHandle, XnUChar* pBuffer, XnUInt32 nBufferSize, XnUInt32 nTimeOut); 00112 00113 XN_C_API XnStatus xnUSBQueueReadEndPoint(XN_USB_EP_HANDLE pEPHandle, XnUChar* pBuffer, XnUInt32 nBufferSize, XnUInt32 nTimeOut); 00114 XN_C_API XnStatus xnUSBFinishReadEndPoint(XN_USB_EP_HANDLE pEPHandle, XnUInt32* pnBytesReceived, XnUInt32 nTimeOut); 00115 00116 XN_C_API XnStatus xnUSBInitReadThread(XN_USB_EP_HANDLE pEPHandle, XnUInt32 nBufferSize, XnUInt32 nNumBuffers, XnUInt32 nTimeOut, XnUSBReadCallbackFunctionPtr pCallbackFunction, void* pCallbackData); 00117 XN_C_API XnStatus xnUSBShutdownReadThread(XN_USB_EP_HANDLE pEPHandle); 00118 00119 XN_C_API XnStatus xnUSBSetCallbackHandler(XnUInt16 nVendorID, XnUInt16 nProductID, void* pExtraParam, XnUSBEventCallbackFunctionPtr pCallbackFunction, void* pCallbackData); 00120 00121 #endif //_XN_USB_H_