SoftISP.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) 2015-2021 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_SOFTISP_H_
#define DW_SOFTISP_H_

#include <dw/core/Config.h>
#include <dw/core/context/Context.h>
#include <dw/core/base/Exports.h>
#include <dw/core/base/Types.h>
#include <dw/image/Image.h>
#include <dw/sensors/camera/Camera.h>
#include <dw/isp/Tonemap.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/************************************************************************
  NOTE THAT THIS API HAS DEPRECATED AND IS NOT PUBLIC ANYMORE, DO NOT USE
************************************************************************/

typedef struct dwSoftISPObject* dwSoftISPHandle_t;

typedef enum dwSoftISPDemosaicMethod {
    DW_SOFTISP_DEMOSAIC_METHOD_INTERPOLATION,
    DW_SOFTISP_DEMOSAIC_METHOD_DOWNSAMPLE
} dwSoftISPDemosaicMethod;

typedef enum dwSoftISPDenoiseMethod {
    DW_SOFTISP_DENOISE_METHOD_NONE,
    DW_SOFTISP_DENOISE_METHOD_BILATERAL
} dwSoftISPDenoiseMethod;

typedef enum dwSoftISPProcessType {
    DW_SOFTISP_PROCESS_TYPE_BAYER = 1 << 0,
    DW_SOFTISP_PROCESS_TYPE_DEMOSAIC = 1 << 1,
    DW_SOFTISP_PROCESS_TYPE_TONEMAP = 1 << 2,
} dwSoftISPProcessType;

typedef enum dwSoftISPWhiteBalanceMode {
    DW_SOFTISP_WHITEBALANCE_MODE_FIXED,
    DW_SOFTISP_WHITEBALANCE_MODE_AUTO
} dwSoftISPWhiteBalanceMode;

typedef struct dwSoftISPParams
{
    uint32_t width;

    uint32_t height;

    dwCameraType cameraType;

    // Camera RAW format
    dwCameraRawFormat cameraRawFormat;

    // Camera Revision number
    uint32_t cameraRevision;

    dwTonemapMethod method;

    const char* cameraModuleName;
} dwSoftISPParams;

DW_API_PUBLIC
dwStatus dwSoftISP_initParamsFromCamera(dwSoftISPParams* params,
                                        const dwCameraProperties* cameraProps);

DW_API_PUBLIC
dwStatus dwSoftISP_initialize(dwSoftISPHandle_t* obj,
                              const dwSoftISPParams* params,
                              const dwContextHandle_t ctx);

DW_API_PUBLIC
dwStatus dwSoftISP_reset(dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_release(dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_getBayerImageProperties(dwImageProperties* imageProperties,
                                           dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_getDemosaicImageProperties(dwImageProperties* imageProperties,
                                              dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_bindOutputBayer(dwImageCUDA* bayerImage,
                                   dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_bindOutputDemosaic(dwImageCUDA* demosaicImage,
                                      dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_bindOutputTonemap(dwImageCUDA* tonemappedImage,
                                     dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_bindInputRaw(const dwImageCUDA* rawImage, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_processDeviceAsync(dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_setCUDAStream(cudaStream_t stream, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_getCUDAStream(cudaStream_t* stream, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_setDemosaicMethod(dwSoftISPDemosaicMethod method, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_getDemosaicMethod(dwSoftISPDemosaicMethod* method, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_setDemosaicROI(dwRect cropRegion, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_getDemosaicROI(dwRect* cropRegion, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_setDenoiseMethod(dwSoftISPDenoiseMethod method, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_getDenoiseMethod(dwSoftISPDenoiseMethod* method, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_getTonemapType(dwTonemapMethod* type, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_setTonemapType(dwTonemapMethod type, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_getWhiteBalanceMode(dwSoftISPWhiteBalanceMode* mode, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_setWhiteBalanceMode(dwSoftISPWhiteBalanceMode mode, dwSoftISPHandle_t obj);

DW_API_PUBLIC
dwStatus dwSoftISP_setProcessType(const int32_t processType, dwSoftISPHandle_t obj);

// DEPRECATED APIS

// /**
// * Runs the Software ISP to convert the bound raw image into whatever output was bound beforehand.
// * The command will process as explained in the table at the beginning of the page (DW_SOFTISP_ is omitted).
// *
// * @param[in] type A bitwise mask of the process output chosen (must match or be a subset of the bound images).
// * @param[in] obj A pointer to the Software ISP handle.
// *
// * @return DW_SUCCESS, DW_INVALID_HANDLE
// * \ingroup soft_ISP
// *
// */
//DW_API_PUBLIC
//dwStatus dwSoftISP_processDeviceAsync(const uint32_t processType, dwSoftISPHandle_t obj);

#ifdef __cplusplus
}
#endif

#endif // DW_soft_ISP_H_