ImageStreamer.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) 2016-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_IMAGE_IMAGESTREAMER_H_
#define DW_IMAGE_IMAGESTREAMER_H_

#include <dw/core/Config.h>
#include <dw/core/base/Exports.h>
#include <dw/core/context/Context.h>

#include <dw/image/Image.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct dwImageStreamerObject* dwImageStreamerHandle_t;


typedef enum dwImageStreamerCrossProcessMode {
    DW_IMAGE_STREAMER_CROSS_PROCESS_PRODUCER,
    DW_IMAGE_STREAMER_CROSS_PROCESS_CONSUMER
} dwImageStreamerCrossProcessMode;

typedef struct dwImageStreamerCrossProcessModeParams
{

    const char* parameters;

    dwImageStreamerCrossProcessMode mode;
} dwImageStreamerCrossProcessModeParams;

DW_API_PUBLIC
dwStatus dwImageStreamer_setCUDAStream(cudaStream_t stream, dwImageStreamerHandle_t streamer);

DW_API_PUBLIC
dwStatus dwImageStreamer_getCUDAStream(cudaStream_t* stream, dwImageStreamerHandle_t streamer);

DW_API_PUBLIC
dwStatus dwImageStreamer_getOutputProperties(dwImageProperties* props, dwImageStreamerHandle_t const streamer);

DW_API_PUBLIC
dwStatus dwImageStreamer_initialize(dwImageStreamerHandle_t* streamer,
                                    const dwImageProperties* from, dwImageType to,
                                    dwContextHandle_t ctx);

DW_API_PUBLIC
DW_DEPRECATED("EGL based and legacy behavior will be deprecated")
dwStatus dwImageStreamer_initializeLegacy(dwImageStreamerHandle_t* streamer,
                                          const dwImageProperties* from, dwImageType to,
                                          dwContextHandle_t ctx);

#ifdef VIBRANTE

DW_API_PUBLIC
DW_DEPRECATED("The cross process streamer is deprecated and will be removed in the next version. The dwChannel can be used instead for cross process image streaming")
dwStatus dwImageStreamer_initializeCrossProcess(dwImageStreamerHandle_t* streamer,
                                                const dwImageProperties* from, dwImageType to,
                                                dwImageStreamerCrossProcessModeParams params,
                                                dwContextHandle_t ctx);

DW_API_PUBLIC
DW_DEPRECATED("The EGL based cross process streamer is deprecated and will be removed in the next version.")
dwStatus dwImageStreamer_initializeCrossProcessEGL(dwImageStreamerHandle_t* streamer,
                                                   const dwImageProperties* from, dwImageType to,
                                                   dwImageStreamerCrossProcessModeParams params,
                                                   dwContextHandle_t ctx);
#endif

DW_API_PUBLIC
dwStatus dwImageStreamer_producerSend(dwImageHandle_t image, dwImageStreamerHandle_t const streamer);

DW_API_PUBLIC
dwStatus dwImageStreamer_producerReturn(dwImageHandle_t* const image, dwTime_t const timeoutUs,
                                        dwImageStreamerHandle_t const streamer);

DW_API_PUBLIC
dwStatus dwImageStreamer_consumerReceive(dwImageHandle_t* image, dwTime_t const timeoutUs,
                                         dwImageStreamerHandle_t const streamer);

DW_API_PUBLIC
dwStatus dwImageStreamer_consumerReturn(dwImageHandle_t* image, dwImageStreamerHandle_t const streamer);

DW_API_PUBLIC
dwStatus dwImageStreamer_release(dwImageStreamerHandle_t streamer);

#ifdef __cplusplus
}
#endif

#endif // DW_IMAGE_IMAGESSTREAMER_H_