FrameCapture.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2019-2025 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_FRAMECAPTURE_H_
#define DW_FRAMECAPTURE_H_
 
#include <dw/sensors/common/SensorSerializer.h>
 
#include "Image.h"
 
#include <nvscisync.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct dwFrameCaptureObject* dwFrameCaptureHandle_t;
 
typedef enum dwFrameCaptureMode {
    DW_FRAMECAPTURE_MODE_SCREENCAP = 1 << 0,
    DW_FRAMECAPTURE_MODE_SERIALIZE = 1 << 1,
} dwFrameCaptureMode;
 
typedef struct
{
    uint32_t width;
 
    uint32_t height;
 
    bool captureCustom;
 
    uint32_t mode;
 
    bool serializeGL;
 
    dwSerializerParams params;
 
    bool setupForDirectCameraOutput;
} dwFrameCaptureParams;
 
DW_VIZ_API_PUBLIC
dwStatus dwFrameCapture_initialize(dwFrameCaptureHandle_t* obj,
                                   const dwFrameCaptureParams* params,
                                   dwSALHandle_t sal,
                                   dwContextHandle_t ctx);
 
DW_VIZ_API_PUBLIC
dwStatus dwFrameCapture_release(dwFrameCaptureHandle_t framecapture);
 
DW_VIZ_API_PUBLIC
dwStatus dwFrameCapture_screenCapture(const dwImageGL** imageGL, const dwRect roi,
                                      dwFrameCaptureHandle_t framecapture);
 
DW_VIZ_API_PUBLIC
dwStatus dwFrameCapture_screenCaptureCustom(dwImageGL* imageGL, const dwRect roi,
                                            dwFrameCaptureHandle_t framecapture);
 
DW_VIZ_API_PUBLIC
dwStatus dwFrameCapture_appendFrame(const dwImageHandle_t img, dwFrameCaptureHandle_t framecapture);
 
DW_VIZ_API_PUBLIC
DW_DEPRECATED("dwFrameCapture_appendFrameCUDA: this function is deprecated, replace with the dwFrameCapture_appendFrame")
dwStatus dwFrameCapture_appendFrameCUDA(const dwImageCUDA* img, dwFrameCaptureHandle_t framecapture);
 
#ifndef VIBRANTE
 
DW_VIZ_API_PUBLIC
dwStatus dwFrameCapture_appendFrameCPU(const dwImageCPU* img, dwFrameCaptureHandle_t framecapture);
#else
 
DW_VIZ_API_PUBLIC
dwStatus dwFrameCapture_appendFrameNvMedia(const dwImageNvMedia* img, dwFrameCaptureHandle_t framecapture);
DW_VIZ_API_PUBLIC
dwStatus dwFrameCapture_fillSyncAttributes(NvSciSyncAttrList syncAttrList, dwFrameCaptureHandle_t framecapture);
 
DW_VIZ_API_PUBLIC
dwStatus dwFrameCapture_setSyncObject(NvSciSyncObj syncObj, dwFrameCaptureHandle_t framecapture);
 
DW_API_PUBLIC
dwStatus dwFrameCapture_insertFence(NvSciSyncFence* syncFence, dwFrameCaptureHandle_t framecapture);
 
#endif
 
DW_VIZ_API_PUBLIC
dwStatus dwFrameCapture_appendFrameGL(const dwImageGL* img, dwFrameCaptureHandle_t framecapture);
 
DW_API_PUBLIC
dwStatus dwFrameCapture_appendAllocationAttributes(dwImageProperties* imgProps,
                                                   dwFrameCaptureHandle_t framecapture);
#ifdef __cplusplus
}
#endif
 
#endif // DW_FRAMECAPTURE_H_