ImageStreamer.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) 2016 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_IMAGE_IMAGESTREAMER_H__
#define DW_IMAGE_IMAGESTREAMER_H__

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

#include <dw/image/Image.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct dwImageStreamerObject *dwImageStreamerHandle_t;

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


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_initializeCrossProcess(dwImageStreamerHandle_t *streamer,
                                                              const dwImageProperties *from, dwImageType to,
                                                              dwImageStreamerCrossProcessModeParams params,
                                                              dwContextHandle_t ctx);

DW_API_PUBLIC dwStatus dwImageStreamer_release(dwImageStreamerHandle_t *streamer);

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 streamer);

// ---------- push -----------------
DW_API_PUBLIC dwStatus dwImageStreamer_postCPU(dwImageCPU *image, dwImageStreamerHandle_t streamer);

DW_API_PUBLIC dwStatus dwImageStreamer_postGL(dwImageGL *image, dwImageStreamerHandle_t streamer);

DW_API_PUBLIC dwStatus dwImageStreamer_postCUDA(dwImageCUDA *image, dwImageStreamerHandle_t streamer);

// ---------- pop -----------------
DW_API_PUBLIC dwStatus dwImageStreamer_waitPostedCPU(dwImageCPU **image,
                                                     dwTime_t timeout_us,
                                                     dwImageStreamerHandle_t streamer);

DW_API_PUBLIC dwStatus dwImageStreamer_waitPostedGL(dwImageGL **image,
                                                    dwTime_t timeout_us,
                                                    dwImageStreamerHandle_t streamer);

DW_API_PUBLIC dwStatus dwImageStreamer_waitPostedCUDA(dwImageCUDA **image,
                                                      dwTime_t timeout_us,
                                                      dwImageStreamerHandle_t streamer);

// ---------- lease -----------------
DW_API_PUBLIC dwStatus dwImageStreamer_receiveCPU(dwImageCPU **image,
                                                  dwTime_t timeout_us,
                                                  dwImageStreamerHandle_t streamer);

DW_API_PUBLIC dwStatus dwImageStreamer_receiveGL(dwImageGL **image,
                                                 dwTime_t timeout_us,
                                                 dwImageStreamerHandle_t streamer);

DW_API_PUBLIC dwStatus dwImageStreamer_receiveCUDA(dwImageCUDA **image,
                                                   dwTime_t timeout_us,
                                                   dwImageStreamerHandle_t streamer);

// ---------- return -----------------
DW_API_PUBLIC dwStatus dwImageStreamer_returnReceivedCPU(dwImageCPU *image,
                                                         dwImageStreamerHandle_t streamer);

DW_API_PUBLIC dwStatus dwImageStreamer_returnReceivedGL(dwImageGL *image,
                                                        dwImageStreamerHandle_t streamer);

DW_API_PUBLIC dwStatus dwImageStreamer_returnReceivedCUDA(dwImageCUDA *image,
                                                          dwImageStreamerHandle_t streamer);
#ifdef __cplusplus
}
#endif

// OS-specific
#ifdef VIBRANTE
#include "ImageStreamer_vibrante.h"
#endif


#endif // DW_IMAGE_IMAGESSTREAMER_H__