nvmedia_video.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2018, 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_VIDEO_H
#define _NVMEDIA_VIDEO_H

#ifdef __cplusplus
extern "C" {
#endif

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

#define NVMEDIA_VIDEO_VERSION_MAJOR   1

#define NVMEDIA_VIDEO_VERSION_MINOR   5

typedef struct {
    NvMediaSurfaceType type;
    uint32_t width;
    uint32_t height;
    void *tag;
    uint32_t colorStd;
} NvMediaVideoSurface;

typedef struct {
    uint32_t lumaWidth;
    uint32_t lumaHeight;
    unsigned char *pY;
    uint32_t pitchY;
    unsigned char *pU;
    uint32_t pitchU;
    unsigned char *pV;
    uint32_t pitchV;
    unsigned char *pY2;
    uint32_t pitchY2;
    unsigned char *pU2;
    uint32_t pitchU2;
    unsigned char *pV2;
    uint32_t pitchV2;
    unsigned char *pRGBA;
    uint32_t pitchRGBA;
} NvMediaVideoSurfaceMap;

NvMediaVideoSurface *
NvMediaVideoSurfaceCreateNew(
    NvMediaDevice *device,
    NvMediaSurfaceType type,
    NvMediaSurfAllocAttr *attrs,
    uint32_t numAllocAttrs,
    uint32_t flags
);

void
NvMediaVideoSurfaceDestroy(
    NvMediaVideoSurface *surface
);

NvMediaStatus
NvMediaVideoSurfaceLock(
    NvMediaVideoSurface *surface,
    NvMediaVideoSurfaceMap *surfaceMap
);

void
NvMediaVideoSurfaceUnlock(
    NvMediaVideoSurface *surface
);

NvMediaStatus
NvMediaVideoSurfacePutBits(
    NvMediaVideoSurface *videoSurface,
    NvMediaRect *dstRect,
    void **srcPntrs,
    uint32_t *srcPitches
);

NvMediaStatus
NvMediaVideoSurfaceGetBits(
    NvMediaVideoSurface *videoSurface,
    NvMediaRect *srcRect,
    void **dstPntrs,
    uint32_t *dstPitches
);

/*
 * \defgroup history_nvmedia_video History
 * Provides change history for the NvMedia Video Surface handling
 *
 * \section history_nvmedia_video Version History
 *
 * <b> Version 1.0 </b> March 21, 2017
 * - Initial release
 *
 * <b> Version 1.1 </b> May 15, 2017
 * - Added deprecated warning message for \ref NvMediaVideoSurfaceCreateEx,
 *   \ref NvMediaVideoSurfaceSetAttributes
 *
 * <b> Version 1.2 </b> May 18, 2017
 * - Added deprecated warning message for \ref NvMediaVideoSurfaceCreate
 * - NvMediaVideoSurfaceWaitForCompletion() is deprecated
 * - All NvMedia data types are moved to standard data types
 *
 * <b> Version 1.3 </b> May 18, 2017
 * - Added colorStd member in \ref NvMediaVideoSurface
 *
 * <b> Version 1.4 </b> September 12, 2017
 * - Removed NVMEDIA_SURFACE_CREATE_ATTRIBUTE_CAPTURE, NVMEDIA_SURFACE_CREATE_ATTRIBUTE_DISPLAY,
 *   NVMEDIA_SURFACE_ATTRIBUTE_INTERLACED
 * - Deprecated \ref NvMediaVideoSurfaceCreate, \ref NvMediaVideoSurfaceCreateEx,
 *   \ref NvMediaVideoSurfaceSetAttributes
 *
 * <b> Version 1.5 </b> October 5, 2018
 * - Updated the comments in the header to use new NvMediaSurfaceType values
 *
 */

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

#endif /* _NVMEDIA_VIDEO_H */