nvmedia_image.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2017, 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_IMAGE_H
#define _NVMEDIA_IMAGE_H

#ifdef __cplusplus
extern "C" {
#endif

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

#define NVMEDIA_IMAGE_VERSION_MAJOR   1

#define NVMEDIA_IMAGE_VERSION_MINOR   11

#define NVMEDIA_MAX_AGGREGATE_IMAGES   6

#define NVMEDIA_MAX_IMAGE_GROUP_SIZE   3

#define NVMEDIA_IMAGE_TIMEOUT_INFINITE  0xFFFFFFFF

typedef struct {
    NvMediaSurfaceType type;
    uint32_t width;
    uint32_t height;
    uint32_t imageCount;
    uint32_t embeddedDataTopSize;
    uint32_t embeddedDataBottomSize;
    uint32_t attributes;
    void *tag;
    NvMediaTime captureTimeStamp;
    NvMediaGlobalTime captureGlobalTimeStamp;
    uint32_t colorStd;
} NvMediaImage;

typedef struct {
    NvMediaImage *imageList[NVMEDIA_MAX_IMAGE_GROUP_SIZE];
    uint32_t numImages;
    void *tag;
} NvMediaImageGroup;

typedef enum {
    NVMEDIA_BITS_PER_PIXEL_8 = 0,
    NVMEDIA_BITS_PER_PIXEL_10,
    NVMEDIA_BITS_PER_PIXEL_12,
    NVMEDIA_BITS_PER_PIXEL_14,
    NVMEDIA_BITS_PER_PIXEL_16,
    NVMEDIA_BITS_PER_PIXEL_20
} NvMediaBitsPerPixel;

typedef enum {
    NVMEDIA_RAW_PIXEL_ORDER_RGGB = 0,
    NVMEDIA_RAW_PIXEL_ORDER_BGGR,
    NVMEDIA_RAW_PIXEL_ORDER_GRBG,
    NVMEDIA_RAW_PIXEL_ORDER_GBRG
} NvMediaRawPixelOrder;

NvMediaStatus
NvMediaImageGetVersion(
    NvMediaVersion *version
);

NvMediaImage *
NvMediaImageCreateNew(
    NvMediaDevice *device,
    NvMediaSurfaceType type,
    NvMediaSurfAllocAttr *attrs,
    uint32_t numAttrs,
    uint32_t flags
);

void
NvMediaImageDestroy(
    NvMediaImage *image
);

typedef enum {
    NVMEDIA_IMAGE_ACCESS_READ       = (1 << 0),
    NVMEDIA_IMAGE_ACCESS_WRITE      = (1 << 1),
    NVMEDIA_IMAGE_ACCESS_READ_WRITE = (NVMEDIA_IMAGE_ACCESS_READ | NVMEDIA_IMAGE_ACCESS_WRITE),
} NvMediaImageLockAccess;

typedef struct {
    uint32_t pitch;
    void *mapping;
} NvMediaImageSurface;

typedef struct {
    NvMediaSurfaceType type;
    uint32_t width;
    uint32_t height;
    uint32_t surfaces;
    NvMediaImageSurface surface[6];
    void *metaData;
} NvMediaImageSurfaceMap;

NvMediaStatus
NvMediaImageLock(
    NvMediaImage *image,
    uint32_t lockAccessType,
    NvMediaImageSurfaceMap *surfaceMap
);

void
NvMediaImageUnlock(
    NvMediaImage *image
);

NvMediaStatus
NvMediaImagePutBits(
    NvMediaImage *image,
    NvMediaRect *dstRect,
    void **srcPntrs,
    uint32_t *srcPitches
);

NvMediaStatus
NvMediaImageGetBits(
    NvMediaImage *image,
    NvMediaRect *srcRect,
    void **dstPntrs,
    uint32_t *dstPitches
);

NvMediaStatus
NvMediaImageGetEmbeddedData(
    NvMediaImage *image,
    uint32_t imageIndex,
    void *embeddedBufTop,
    uint32_t *embeddedBufTopSize,
    void *embeddedBufBottom,
    uint32_t *embeddedBufBottomSize
);

NvMediaStatus
NvMediaImageGetTimeStamp(
    NvMediaImage *image,
    NvMediaTime *timeStamp
);

NvMediaStatus
NvMediaImageGetGlobalTimeStamp(
    NvMediaImage *image,
    NvMediaGlobalTime *globalTimeStamp
);

NvMediaStatus
NvMediaImageGetStatus(
    NvMediaImage *image,
    uint32_t millisecondWait,
    NvMediaTaskStatus *status
);

/*
 * \defgroup history_nvmedia_image History
 * Provides change history for the NvMedia Image API.
 *
 * \section history_nvmedia_image Version History
 *
 * <b> Version 1.1 </b> March 3, 2016
 * - Initial release
 *
 * <b> Version 1.2 </b> May 11, 2016
 * - Added \ref NvMediaImageCheckVersion API
 *
 * <b> Version 1.3 </b> Jan 17, 2017
 * - Added atrribute NVMEDIA_IMAGE_ATTRIBUTE_CAPTURE in \ref NvMediaImageAttributes
 *
 * <b> Version 1.4 </b> Feb 9, 2017
 * - Added new APIs
 *       NvMediaImageCreateNew()
 *
 * <b> Version 1.5 </b> March 16, 2017
 * - Added \ref NVMEDIA_BITS_PER_PIXEL_16 in \ref NvMediaBitsPerPixel
 *
 * <b> Version 1.6 </b> May 9, 2017
 * - Deprecated the following APIs
 *     - NvMediaImageAcquire
 *     - NvMediaImageRelease
 *     - NvMediaImageWaitForIdle
 *     - NvMediaImageWaitForCompletion
 *     - NvMediaImageCheckVersion
 * - NvMediaImageGetVersion() is added to get the version of NvMedia Image library
 * - All NvMedia data types are moved to standard data types
 *
 * <b> Version 1.7 </b> May 14, 2017
 * - Added API to get status of operation on an image. \ref NvMediaImageGetStatus
 *
 * <b> Version 1.8 </b> May 15, 2017
 * - Added deprecated warning message for \ref NvMediaImageCreate,
 *   \ref NvMediaImageSiblingCreate, \ref NvMediaImageSiblingDestroy,
 *   \ref NvMediaVideoCreateImageSibling, \ref NvMediaImageCreateVideoSibling
 *
 * <b> Version 1.9 </b> May 18, 2017
 * - Added colorStd member in \ref NvMediaImage
 *
 * <b> Version 1.10 </b> June 12, 2017
 * - Added \ref NvMediaImageGroup to hold a list of NvMediaImages.
 *
 * <b> Version 1.11 </b> September 12, 2017
 * - Deprecated \ref NvMediaImageClass, \ref NvMediaImageAttributes, \ref NvMediaImageAdvancedConfig
 * - Deprecated \ref NvMediaImageCreate, \ref NvMediaImageSiblingCreate,
 *   \ref NvMediaVideoCreateImageSibling, \ref NvMediaImageSiblingDestroy,
 *   \ref NvMediaImageCreateVideoSibling, \ref NvMediaVideoSurfaceSiblingDestroy
 *
 */
#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif /* _NVMEDIA_IMAGE_H */