Tensor.h

Go to the documentation of this file.

 
//
// 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 & AFFILIATES 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 & AFFILIATES. 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 & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2019-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//
 
#ifndef DW_DNN_TENSOR_H_
#define DW_DNN_TENSOR_H_
 
#include <dw/core/context/Context.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct dwDNNTensorObject* dwDNNTensorHandle_t;
typedef struct dwDNNTensorObject const* dwConstDNNTensorHandle_t;
 
#define DW_DNN_TENSOR_MAX_DIMENSIONS 8U
 
typedef enum {
    DW_DNN_TENSOR_TYPE_CPU = 0,
    DW_DNN_TENSOR_TYPE_CUDA = 1,
    DW_DNN_TENSOR_TYPE_NVMEDIA = 2,
} dwDNNTensorType;
 
typedef enum {
    DW_DNN_TENSOR_LAYOUT_NCHW = 0,
    DW_DNN_TENSOR_LAYOUT_NHWC = 1,
    DW_DNN_TENSOR_LAYOUT_NCHWx = 2
} dwDNNTensorLayout;
 
typedef enum {
    DW_DNN_TENSOR_COLORSPACE_UNKNOWN = 0,
    DW_DNN_TENSOR_COLORSPACE_RGB     = 1,
    DW_DNN_TENSOR_COLORSPACE_YUV     = 2,
} dwDNNTensorColorSpace;
 
typedef struct
{
    dwTrivialDataType dataType;
    dwDNNTensorType tensorType;
    dwDNNTensorLayout tensorLayout;
    bool isGPUMapped;
    uint32_t numDimensions;
    uint32_t dimensionSize[DW_DNN_TENSOR_MAX_DIMENSIONS];
    dwDNNTensorColorSpace colorSpace;
    float32_t dynamicRange[2];
} dwDNNTensorProperties;
 
typedef struct
{
    dwDNNTensorProperties prop;
    dwTime_t timestamp_us;
    const void* ptr;
} dwDNNTensor;
 
DW_API_PUBLIC
dwStatus dwDNNTensor_create(dwDNNTensorHandle_t* const tensorHandle,
                            dwDNNTensorProperties const* const properties,
                            dwContextHandle_t const ctx);
 
DW_API_PUBLIC
dwStatus dwDNNTensor_createWithExtMem(dwDNNTensorHandle_t* const tensorHandle,
                                      dwDNNTensorProperties const* const properties,
                                      uint8_t* const extMem,
                                      size_t const stride);
 
DW_API_PUBLIC
dwStatus dwDNNTensor_destroy(dwDNNTensorHandle_t const tensorHandle);
 
DW_API_PUBLIC
dwStatus dwDNNTensor_getLayoutView(size_t* const offset, size_t* const stride, size_t* const numElements,
                                   const uint32_t* const indices, uint32_t const numIndices,
                                   uint32_t const dimension, dwConstDNNTensorHandle_t const tensorHandle);
 
DW_API_PUBLIC
dwStatus dwDNNTensor_getProperties(dwDNNTensorProperties* const properties, dwConstDNNTensorHandle_t const tensorHandle);
 
DW_API_PUBLIC
dwStatus dwDNNTensor_getTensor(dwDNNTensor* const tensor, dwDNNTensorHandle_t const tensorHandle);
 
DW_API_PUBLIC
dwStatus dwDNNTensor_getTimestamp(dwTime_t* const time, dwDNNTensorHandle_t const tensorHandle);
 
DW_API_PUBLIC
dwStatus dwDNNTensor_setTimestamp(dwTime_t time, dwDNNTensorHandle_t const tensorHandle);
 
DW_API_PUBLIC
dwStatus dwDNNTensor_lock(void** const data, dwDNNTensorHandle_t const tensorHandle);
 
DW_API_PUBLIC
dwStatus dwDNNTensor_tryLock(bool* const isLocked, void** const data, dwDNNTensorHandle_t const tensorHandle);
 
DW_API_PUBLIC
dwStatus dwDNNTensor_unlock(dwDNNTensorHandle_t const tensorHandle);
 
#ifdef __cplusplus
}
#endif
#endif // DW_DNN_TENSOR_H_