OniCAPI.h

Go to the documentation of this file.

/*****************************************************************************
*                                                                            *
*  OpenNI 2.x Alpha                                                          *
*  Copyright (C) 2012 PrimeSense Ltd.                                        *
*                                                                            *
*  This file is part of OpenNI.                                              *
*                                                                            *
*  Licensed under the Apache License, Version 2.0 (the "License");           *
*  you may not use this file except in compliance with the License.          *
*  You may obtain a copy of the License at                                   *
*                                                                            *
*      http://www.apache.org/licenses/LICENSE-2.0                            *
*                                                                            *
*  Unless required by applicable law or agreed to in writing, software       *
*  distributed under the License is distributed on an "AS IS" BASIS,         *
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  *
*  See the License for the specific language governing permissions and       *
*  limitations under the License.                                            *
*                                                                            *
*****************************************************************************/
#ifndef _ONI_C_API_H_
#define _ONI_C_API_H_

#include "OniPlatform.h"
#include "OniCTypes.h"
#include "OniCProperties.h"
#include "OniVersion.h"

/******************************************** General APIs */

ONI_C_API OniStatus oniInitialize(int apiVersion);
ONI_C_API void oniShutdown();

ONI_C_API OniStatus oniGetDeviceList(OniDeviceInfo** pDevices, int* pNumDevices);
ONI_C_API OniStatus oniReleaseDeviceList(OniDeviceInfo* pDevices);

ONI_C_API OniStatus oniRegisterDeviceCallbacks(OniDeviceCallbacks* pCallbacks, void* pCookie, OniCallbackHandle* pHandle);
ONI_C_API void oniUnregisterDeviceCallbacks(OniCallbackHandle handle);

ONI_C_API OniStatus oniWaitForAnyStream(OniStreamHandle* pStreams, int numStreams, int* pStreamIndex, int timeout);

ONI_C_API OniVersion oniGetVersion();

ONI_C_API int oniFormatBytesPerPixel(OniPixelFormat format);

ONI_C_API const char* oniGetExtendedError();

/******************************************** Device APIs */

ONI_C_API OniStatus oniDeviceOpen(const char* uri, OniDeviceHandle* pDevice);
ONI_C_API OniStatus oniDeviceClose(OniDeviceHandle device);

ONI_C_API const OniSensorInfo* oniDeviceGetSensorInfo(OniDeviceHandle device, OniSensorType sensorType);

ONI_C_API OniStatus oniDeviceGetInfo(OniDeviceHandle device, OniDeviceInfo* pInfo);

ONI_C_API OniStatus oniDeviceCreateStream(OniDeviceHandle device, OniSensorType sensorType, OniStreamHandle* pStream);

ONI_C_API OniStatus oniDeviceEnableDepthColorSync(OniDeviceHandle device);
ONI_C_API void oniDeviceDisableDepthColorSync(OniDeviceHandle device);
ONI_C_API OniBool oniDeviceGetDepthColorSyncEnabled(OniDeviceHandle device);

ONI_C_API OniStatus oniDeviceSetProperty(OniDeviceHandle device, int propertyId, const void* data, int dataSize);
ONI_C_API OniStatus oniDeviceGetProperty(OniDeviceHandle device, int propertyId, void* data, int* pDataSize);
ONI_C_API OniBool oniDeviceIsPropertySupported(OniDeviceHandle device, int propertyId);
ONI_C_API OniStatus oniDeviceInvoke(OniDeviceHandle device, int commandId, void* data, int dataSize);
ONI_C_API OniBool oniDeviceIsCommandSupported(OniDeviceHandle device, int commandId);

ONI_C_API OniBool oniDeviceIsImageRegistrationModeSupported(OniDeviceHandle device, OniImageRegistrationMode mode);

ONI_C_API OniStatus oniDeviceOpenEx(const char* uri, const char* mode, OniDeviceHandle* pDevice);

/******************************************** Stream APIs */

ONI_C_API void oniStreamDestroy(OniStreamHandle stream);

ONI_C_API const OniSensorInfo* oniStreamGetSensorInfo(OniStreamHandle stream);

ONI_C_API OniStatus oniStreamStart(OniStreamHandle stream);
ONI_C_API void oniStreamStop(OniStreamHandle stream);

ONI_C_API OniStatus oniStreamReadFrame(OniStreamHandle stream, OniFrame** pFrame);

ONI_C_API OniStatus oniStreamRegisterNewFrameCallback(OniStreamHandle stream, OniNewFrameCallback handler, void* pCookie, OniCallbackHandle* pHandle);
ONI_C_API void oniStreamUnregisterNewFrameCallback(OniStreamHandle stream, OniCallbackHandle handle);

ONI_C_API OniStatus oniStreamSetProperty(OniStreamHandle stream, int propertyId, const void* data, int dataSize);
ONI_C_API OniStatus oniStreamGetProperty(OniStreamHandle stream, int propertyId, void* data, int* pDataSize);
ONI_C_API OniBool oniStreamIsPropertySupported(OniStreamHandle stream, int propertyId);
ONI_C_API OniStatus oniStreamInvoke(OniStreamHandle stream, int commandId, void* data, int dataSize);
ONI_C_API OniBool oniStreamIsCommandSupported(OniStreamHandle stream, int commandId);
ONI_C_API OniStatus oniStreamSetFrameBuffersAllocator(OniStreamHandle stream, OniFrameAllocBufferCallback alloc, OniFrameFreeBufferCallback free, void* pCookie);


ONI_C_API void oniFrameAddRef(OniFrame* pFrame);
ONI_C_API void oniFrameRelease(OniFrame* pFrame);

// ONI_C_API OniStatus oniConvertRealWorldToProjective(OniStreamHandle stream, OniFloatPoint3D* pRealWorldPoint, OniFloatPoint3D* pProjectivePoint);
// ONI_C_API OniStatus oniConvertProjectiveToRealWorld(OniStreamHandle stream, OniFloatPoint3D* pProjectivePoint, OniFloatPoint3D* pRealWorldPoint);

ONI_C_API OniStatus oniCreateRecorder(const char* fileName, OniRecorderHandle* pRecorder);

ONI_C_API OniStatus oniRecorderAttachStream(
        OniRecorderHandle   recorder, 
        OniStreamHandle     stream, 
        OniBool             allowLossyCompression);

ONI_C_API OniStatus oniRecorderStart(OniRecorderHandle recorder);

ONI_C_API void oniRecorderStop(OniRecorderHandle recorder);

ONI_C_API OniStatus oniRecorderDestroy(OniRecorderHandle* pRecorder);

ONI_C_API OniStatus oniCoordinateConverterDepthToWorld(OniStreamHandle depthStream, float depthX, float depthY, float depthZ, float* pWorldX, float* pWorldY, float* pWorldZ);

ONI_C_API OniStatus oniCoordinateConverterWorldToDepth(OniStreamHandle depthStream, float worldX, float worldY, float worldZ, float* pDepthX, float* pDepthY, float* pDepthZ);

ONI_C_API OniStatus oniCoordinateConverterDepthToColor(OniStreamHandle depthStream, OniStreamHandle colorStream, int depthX, int depthY, OniDepthPixel depthZ, int* pColorX, int* pColorY);

/******************************************** Log APIs */

ONI_C_API OniStatus oniSetLogOutputFolder(const char* strOutputFolder);

ONI_C_API OniStatus oniGetLogFileName(char* strFileName, int nBufferSize);

ONI_C_API OniStatus oniSetLogMinSeverity(int nMinSeverity);

ONI_C_API OniStatus oniSetLogConsoleOutput(OniBool bConsoleOutput);

ONI_C_API OniStatus oniSetLogFileOutput(OniBool bFileOutput);

#if ONI_PLATFORM == ONI_PLATFORM_ANDROID_ARM

ONI_C_API OniStatus oniSetLogAndroidOutput(OniBool bAndroidOutput);
#endif
#endif // _ONI_C_API_H_