nvmedia_2d.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2020, 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_2D_H
#define NVMEDIA_2D_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "nvmedia_core.h"
#include "nvmedia_image.h"
#define NVMEDIA_2D_VERSION_MAJOR   3
 
#define NVMEDIA_2D_VERSION_MINOR   9
 
 
typedef enum
{
    NVMEDIA_2D_STRETCH_FILTER_OFF = 0x1,
    NVMEDIA_2D_STRETCH_FILTER_LOW,
    NVMEDIA_2D_STRETCH_FILTER_MEDIUM,
    NVMEDIA_2D_STRETCH_FILTER_HIGH
} NvMedia2DStretchFilter;
 
typedef enum
{
    NVMEDIA_TRANSFORM_NONE = 0x0,
    NVMEDIA_TRANSFORM_ROTATE_90,
    NVMEDIA_TRANSFORM_ROTATE_180,
    NVMEDIA_TRANSFORM_ROTATE_270,
    NVMEDIA_TRANSFORM_FLIP_HORIZONTAL,
    NVMEDIA_TRANSFORM_INV_TRANSPOSE,
    NVMEDIA_TRANSFORM_FLIP_VERTICAL,
    NVMEDIA_TRANSFORM_TRANSPOSE
} NvMediaTransform;
 
/*---------------------------------------------------------*/
typedef enum
{
    NVMEDIA_2D_BLIT_PARAMS_FILTER               = (1u << 0),
    NVMEDIA_2D_BLIT_PARAMS_FLAGS                = (1u << 1),
    NVMEDIA_2D_BLIT_PARAMS_DST_TRANSFORM        = (1u << 2),
    NVMEDIA_2D_BLIT_PARAMS_COLOR_STD            = (1u << 3)
} NvMedia2DBlitParamField;
 
typedef struct
{
    uint32_t                        validFields;
    NvMedia2DStretchFilter          filter;
    uint32_t                        flags;
    NvMediaTransform                dstTransform;
    NvMediaColorStandard            colorStandard;
} NvMedia2DBlitParameters;
 
typedef struct
{
    /* Reserved for future use. */
    uint32_t reserved[8];
} NvMedia2DBlitParametersOut;
 
NvMediaStatus
NvMedia2DGetVersion(
    NvMediaVersion *version
);
 
typedef struct NvMedia2D NvMedia2D;
 
NvMedia2D *
NvMedia2DCreate(
    NvMediaDevice *device
);
 
void
NvMedia2DDestroy(
    NvMedia2D *i2d
);
 
NvMediaStatus
NvMedia2DDestroyEx(
    NvMedia2D *i2d
);
 
NvMediaStatus
NvMedia2DBlitEx(
    const NvMedia2D                 *i2d,
    const NvMediaImage              *dstSurface,
    const NvMediaRect               *dstRect,
    const NvMediaImage              *srcSurface,
    const NvMediaRect               *srcRect,
    const NvMedia2DBlitParameters   *params,
    NvMedia2DBlitParametersOut      *paramsOut
);
 
#if !NV_IS_SAFETY
 
NvMediaStatus
NvMedia2DCopyPlaneNew(
    const NvMedia2D     *i2d,
    NvMediaImage        *dstSurface,
    uint32_t            dstPlane,
    NvMediaImage        *srcSurface,
    uint32_t            srcPlane
);
 
NvMediaStatus
NvMedia2DWeaveNew(
    const NvMedia2D  *i2d,
    NvMediaImage     *imageOdd,
    NvMediaImage     *imageEven,
    NvMediaImage     *outImage
);
#endif
 
NvMediaStatus
NvMedia2DImageRegister(
    const NvMedia2D        *i2d,
    const NvMediaImage     *image,
    NvMediaAccessMode      accessMode
);
 
NvMediaStatus
NvMedia2DImageUnRegister(
    const NvMedia2D        *i2d,
    const NvMediaImage     *image
);
 
/*
 * \defgroup history_nvmedia_2d History
 * Provides change history for the NvMedia 2D API.
 *
 * \section history_nvmedia_2d Version History
 *
 * <b> Version 1.1 </b> February 1, 2016
 * - Initial release
 *
 * <b> Version 1.2 </b> May 11, 2016
 * - Added \ref NvMedia2DCheckVersion API
 *
 * <b> Version 1.3 </b> May 5, 2017
 * - Removed compositing, blending and alpha related defines and structures
 *
 * <b> Version 2.0 </b> May 11, 2017
 * - Deprecated NvMedia2DBlit API
 * - Deprecated NvMedia2DCheckVersion API
 * - Deprecated NvMedia2DColorStandard, NvMedia2DColorRange and
 *   NvMedia2DColorMatrix types
 * - Added \ref NvMedia2DGetVersion API
 *
 * <b> Version 2.1 </b> May 17, 2017
 * - Moved transformation to nvmedia_common.h
 * - Renamed NvMedia2DTransform to \ref NvMediaTransform
 *
 * <b> Version 2.2 </b> September 4, 2018
 * - Added deprecated warning message for \ref NvMedia2DCopyPlane,
 *   NvMedia2DWeave
 * - Added APIs \ref NvMedia2DCopyPlaneNew, \ref NvMedia2DWeaveNew
 *
 * <b> Version 3.0 </b> October 30, 2018
 * - Deprecated \ref NvMedia2DCopyPlane API
 * - Deprecated \ref NvMedia2DWeave API
 *
 * <b> Version 3.1 </b> December 11, 2018
 * - Fixed MISRA-C Rule 21.1 and 21.2 Violations
 *
 * <b> Version 3.2 </b> January 21, 2019
 * - Moved \ref NvMediaTransform from nvmedia_common.h to this header
 *
 * <b> Version 3.3 </b> Feb 21, 2019
 * - Changed \ref NvMedia2D type from void to struct
 *
 * <b> Version 3.4 </b> March 5, 2019
 * - Fixed MISRA-C Rule 8.13 Violations
 *
 * <b> Version 3.5 </b> March 14, 2019
 * - Removing NvMedia2DBlitFlags enum definition
 * - updated \ref NvMedia2DBlitParametersOut structure definition
 *
 * <b> Version 3.6 </b> March 18, 2019
 * - Added APIs \ref NvMedia2DImageRegister, \ref NvMedia2DImageUnRegister
 *
 * <b> Version 3.7 </b> March 22, 2019
 * - Unnecessary header include nvmedia_common.h has been removed
 *
 * <b> Version 3.8 </b> May 18, 2020
 * - Changes related to MISRA-C Rule 8.13 Violations fixes.
 *
 * <b> Version 3.9 </b> Nov 12, 2020
 * - Improved comments and documentation
 * - Introduce NvMedia2DDestroyEx, which returns an error unlike NvMedia2DDestroy
 * - NvMedia2DDestroy is marked as deprecated
 * - NVMEDIA_STATUS_UNDEFINED_STATE is returned
 *   instead of NVMEDIA_STATUS_BAD_PARAMETER if error happens
 *   after submit is started
 *
 */
#ifdef __cplusplus
};     /* extern "C" */
#endif
 
#endif /* NVMEDIA_2D_H */