Context.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
// expressly authorized by NVIDIA.  Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2016-2020 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//

#ifndef DW_CORE_CONTEXT_H_
#define DW_CORE_CONTEXT_H_

#include <dw/core/Config.h>
#include <dw/core/Exports.h>
#include <dw/core/Types.h>
#include <dw/core/Version.h>
#include <dw/core/Status.h>
#include <cuda_runtime_api.h>

// typdefs for CUDA structs
typedef struct cudaDeviceProp cudaDeviceProp;
typedef enum cudaDeviceAttr cudaDeviceAttr;
typedef enum cudaTextureAddressMode cudaTextureAddressMode;

// Forward declares from EGL
typedef void* EGLDisplay;

#ifdef __cplusplus
extern "C" {
#endif

typedef struct dwContextObject* dwContextHandle_t;
typedef struct dwContextObject const* dwConstContextHandle_t;

typedef struct dwContextParameters
{

#ifdef DW_USE_EGL
    EGLDisplay eglDisplay;

    bool skipEglInit;
#endif

    const char8_t* dataPath;

    bool skipCudaInit;

    bool enablePVA;

    bool enableCudaTaskGraph;
} dwContextParameters;

typedef void* dwCustomizedFileHandle;

typedef struct dwCustomizedFileFunctions
{
    void (*close)(dwCustomizedFileHandle);
    size_t (*write)(dwCustomizedFileHandle, const void*, size_t);
    size_t (*read)(dwCustomizedFileHandle, void*, size_t);
    bool (*getString)(dwCustomizedFileHandle, char8_t*, size_t);
    size_t (*size)(dwCustomizedFileHandle);
    size_t (*getPosition)(dwCustomizedFileHandle);
    void (*setPosition)(dwCustomizedFileHandle, size_t);
    bool (*eof)(dwCustomizedFileHandle);
    bool (*error)(dwCustomizedFileHandle);
    void (*flush)(dwCustomizedFileHandle);
    dwCustomizedFileHandle (*open)(const char8_t*, const char8_t*);

} dwCustomizedFileFunctions;

DW_API_PUBLIC
dwStatus dwContext_setCustomFileFunctions(dwContextHandle_t context, dwCustomizedFileFunctions* fileFunctionPtr);

DW_API_PUBLIC
dwStatus dwGetLastError(const char8_t** errorMsg);

DW_API_PUBLIC
dwStatus dwInitialize(dwContextHandle_t* context, dwVersion header_version, const dwContextParameters* params);

DW_API_PUBLIC
dwStatus dwRelease(dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_getCurrentTime(dwTime_t* time, dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_isTimePTPSynchronized(bool* flag, dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_selectGPUDevice(int32_t deviceNumber, dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_getGPUDeviceCurrent(int32_t* deviceNumber, dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_getGPUCount(int32_t* count, dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_getGPUProperties(cudaDeviceProp* properties, int32_t deviceNum,
                                    dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_getGPUAttribute(int32_t* value, cudaDeviceAttr attribute, int32_t deviceNum,
                                   dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_getGPUArchitecture(const char8_t** architecture, dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_getCUDAProperties(int32_t* driverVersion, int32_t* apiVersion, dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_getGPUDeviceType(dwGPUDeviceType* deviceType, int32_t deviceNum, dwContextHandle_t context);

#ifdef DW_USE_EGL

DW_API_PUBLIC
dwStatus dwContext_setEGLDisplay(EGLDisplay display, dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_getEGLDisplay(EGLDisplay* display, dwContextHandle_t context);
#endif

DW_API_PUBLIC
dwStatus dwContext_getDLAEngineCount(int32_t* count, dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_getPVAEngineCount(uint32_t* count, dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwContext_getDataPath(const char8_t** dataPath, dwContextHandle_t context);

#ifdef __cplusplus
}
#endif

#endif // DW_CORE_CONTEXT_H_