DenseOpticalFlow.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) 2019 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_IMAGEPROCESSING_MOTION_DENSEOPTICALFLOW_H_
#define DW_IMAGEPROCESSING_MOTION_DENSEOPTICALFLOW_H_

#include <dw/core/context/Context.h>
#include <dw/image/Image.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct dwDenseOpticalFlowObject* dwDenseOpticalFlowHandle_t;

typedef enum {
    DW_DENSE_OPTICAL_FLOW_MODE_HIGH_PERFORMANCE = 0,
    DW_DENSE_OPTICAL_FLOW_MODE_ULTRA_HIGH_PERFORMANCE = 1,
    DW_DENSE_OPTICAL_FLOW_MODE_HIGH_QUALITY = 2
} dwDenseOpticalFlowMode;

typedef struct
{
    dwProcessorType processorNVENC;
    dwProcessorType processorPVA;
    dwDenseOpticalFlowMode estimationMode;
    uint32_t imageWidth;
    uint32_t imageHeight;
} dwDenseOpticalFlowParams;

DW_API_PUBLIC
dwStatus dwDenseOpticalFlow_initDefaultParams(dwDenseOpticalFlowParams* params);

DW_API_PUBLIC
dwStatus dwDenseOpticalFlow_initialize(dwDenseOpticalFlowHandle_t* obj,
                                       const dwDenseOpticalFlowParams* params,
                                       dwContextHandle_t ctx);

DW_API_PUBLIC
dwStatus dwDenseOpticalFlow_reset(dwDenseOpticalFlowHandle_t obj);

DW_API_PUBLIC
dwStatus dwDenseOpticalFlow_release(dwDenseOpticalFlowHandle_t obj);

DW_API_PUBLIC
dwStatus dwDenseOpticalFlow_setCUDAStream(cudaStream_t stream, dwDenseOpticalFlowHandle_t obj);

DW_API_PUBLIC
dwStatus dwDenseOpticalFlow_getCUDAStream(cudaStream_t* stream, dwDenseOpticalFlowHandle_t obj);

DW_API_PUBLIC
dwStatus dwDenseOpticalFlow_getOutputImageProperties(dwImageProperties* outputProperties,
                                                     dwDenseOpticalFlowHandle_t obj);

DW_API_PUBLIC
dwStatus dwDenseOpticalFlow_calculateOpticalFlow(dwImageHandle_t output,
                                                 const dwImageHandle_t input,
                                                 const dwImageHandle_t inputReference,
                                                 dwDenseOpticalFlowHandle_t obj);

#ifdef __cplusplus
}
#endif

#endif // DW_IMAGEPROCESSING_MOTION_DENSEOPTICALFLOW_H_