nvmedia_vcp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2019, NVIDIA CORPORATION.  All rights reserved.  All
 * information contained herein is proprietary and confidential to NVIDIA
 * Corporation.  Any use, reproduction, or disclosure without the written
 * permission of NVIDIA Corporation is prohibited.
 */

#ifndef _NVMEDIA_VCP_H
#define _NVMEDIA_VCP_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_core.h"
#include "nvmedia_surface.h"
#include "nvmedia_video.h"

#define NVMEDIA_VCP_VERSION_MAJOR   1

#define NVMEDIA_VCP_VERSION_MINOR   5

#define NVMEDIA_VIDEO_CAPTURE_TIMEOUT_INFINITE  0xFFFFFFFF

#define NVMEDIA_MAX_VCP_FRAME_BUFFERS   32u

typedef enum {
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_A,
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_B,
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_AB,
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_C,
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_D,
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_CD,
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_E,
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_F,
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_EF,
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_G,
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_H,
    NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_GH,
} NvMediaVideoCaptureInterfaceType;

typedef enum {
    NVMEDIA_VIDEO_CAPTURE_INPUT_FORMAT_TYPE_YUV422,
    NVMEDIA_VIDEO_CAPTURE_INPUT_FORMAT_TYPE_YUV444,
    NVMEDIA_VIDEO_CAPTURE_INPUT_FORMAT_TYPE_RGB888
} NvMediaVideoCaptureInputFormatType;

typedef struct {
    NvMediaVideoCaptureInterfaceType interfaceType;
    NvMediaVideoCaptureInputFormatType inputFormatType;
    NvMediaSurfaceType surfaceType;
    uint16_t width;
    uint16_t height;
    uint16_t startX;
    uint16_t startY;
    uint16_t extraLines;
    NvMediaBool interlace;
    uint16_t interlacedExtraLinesDelta;
    uint32_t interfaceLanes;
    uint8_t tpgEnable;
    uint32_t pixelFrequency;
    uint16_t thsSettle;
} NvMediaVideoCaptureSettings;

typedef struct {
    NvMediaSurfaceType surfaceType;
    uint16_t width;
    uint16_t height;
    unsigned char numBuffers;
} NvMediaVideoCapture;

NvMediaStatus
NvMediaVideoCaptureGetVersion(
    NvMediaVersion *version
);

NvMediaVideoCapture *
NvMediaVideoCaptureCreate(
   NvMediaVideoCaptureSettings *settings
);

void
NvMediaVideoCaptureDestroy(
    NvMediaVideoCapture *capture
);

void
NvMediaVideoCaptureStop(
    NvMediaVideoCapture *capture
);

NvMediaStatus
NvMediaVideoCaptureGetFrameEx(
    NvMediaVideoCapture *capture,
    uint32_t millisecondTimeout,
    NvMediaVideoSurface **surface
);

NvMediaStatus
NvMediaVideoCaptureFeedFrame(
    NvMediaVideoCapture *capture,
    NvMediaVideoSurface *surface,
    uint32_t millisecondTimeout
);

NvMediaStatus
NvMediaVideoCaptureReleaseFrame(
    NvMediaVideoCapture *capture,
    NvMediaVideoSurface **surface
);

NvMediaStatus
NvMediaVideoCaptureGetExtraLines(
    NvMediaVideoCapture *capture,
    NvMediaVideoSurface *surface,
    void *extraBuf,
    NvMediaRect *srcRect
);

/*
 * \defgroup history_nvmedia_vcp History
 * Provides change history for the NvMedia Video Capture API.
 *
 * \section history_nvmedia_vcp Version History
 *
 * <b> Version 1.0 </b> March 21, 2017
 * - Initial release
 *
 * <b> Version 1.1 </b> April 25, 2017
 * The following APIs are deprecated -
     NvMediaVideoCaptureListVideoSurfaces()
     NvMediaVideoCaptureGetFrame(). Use NvMediaVideoCaptureGetFrameEx() instead.
     NvMediaVideoCaptureStart()
     NvMediaVideoCaptureDebugGetStatus()
     NvMediaVideoCaptureReturnFrame()
     NvMediaVideoCaptureCheckAvailableFrame(). Use NvMediaVideoCaptureReleaseFrame() instead.
 * NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_C, NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_D,
   NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_CSI_F are newly added to NvMediaVideoCaptureInterfaceType
 * NvMediaVideoCaptureGetVersion() is added to get the version of NvMedia VCP library
 * NvMediaVideoCaptureInterfaceFormat is now deprecated. Only CSI format is supported.
 * interfaceFormat member is removed from \ref NvMediaVideoCapture
 * interfaceFormat & numBuffers inputs are removed from NvMediaVideoCaptureCreate() API.
 * Internal ring buffer based capture is no more supported.
 * externalBuffer member is removed from \ref NvMediaVideoCaptureSettings.
 *
 * <b> Version 1.2 </b> May 19, 2017
 * Removed NvMediaVideoCaptureSurfaceFormatType
 * NvMediaVideoCaptureSettings now takes NvMediaSurfaceType to indicate capture surface format
 * Removed NVMEDIA_VIDEO_CAPTURE_INPUT_FORMAT_TYPE_YUV420
 *   from \ref NvMediaVideoCaptureInputFormatType
 * Removed NVMEDIA_VIDEO_CAPTURE_CSI_INTERFACE_TYPE_TPG_EF
 *
 * <b> Version 1.3 </b> November 18, 2017
 * Added CSI interfaces G & H
 *
 * <b> Version 1.4 </b> October 04, 2018
 * Updated the comments in the header to use new NvMediaSurfaceType values
 *
 * <b> Version 1.5 </b> February 06, 2019
 * Added required header includes nvmedia_core.h and nvmedia_surface.h
 *
 */

#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif /* _NVMEDIA_VCP_H */