nvmedia_2d.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-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_2D_H
#define _NVMEDIA_2D_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_core.h"
#include "nvmedia_common.h"
#include "nvmedia_image.h"
#define NVMEDIA_2D_VERSION_MAJOR   2

#define NVMEDIA_2D_VERSION_MINOR   2


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_2D_BLIT_FLAG_RETURN_CRC             = (1u << 0)
} NvMedia2DBlitFlags;

/*---------------------------------------------------------*/
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
{
    uint32_t crc;
} NvMedia2DBlitParametersOut;

NvMediaStatus
NvMedia2DGetVersion(
    NvMediaVersion *version
);

typedef void NvMedia2D;

NvMedia2D *
NvMedia2DCreate(
    NvMediaDevice *device
);

void
NvMedia2DDestroy(
    NvMedia2D *i2d
);

NvMediaStatus
NvMedia2DBlitEx(
    NvMedia2D                       *i2d,
    NvMediaImage                    *dstSurface,
    const NvMediaRect               *dstRect,
    NvMediaImage                    *srcSurface,
    const NvMediaRect               *srcRect,
    const NvMedia2DBlitParameters   *params,
    NvMedia2DBlitParametersOut      *paramsOut
);

NvMediaStatus
NvMedia2DCopyPlane(
    NvMediaImage    *dstSurface,
    uint32_t        dstPlane,
    NvMediaImage    *srcSurface,
    uint32_t        srcPlane
)__NVM_DEPRECATED_MSG__("Use NvMedia2DCopyPlaneNew API");

NvMediaStatus
NvMedia2DCopyPlaneNew(
    NvMedia2D       *i2d,
    NvMediaImage    *dstSurface,
    uint32_t        dstPlane,
    NvMediaImage    *srcSurface,
    uint32_t        srcPlane
);

NvMediaStatus
NvMedia2DWeave(
    NvMediaDevice    *device,
    NvMediaImage     *imageOdd,
    NvMediaImage     *imageEven,
    NvMediaImage     *outImage
)__NVM_DEPRECATED_MSG__("Use NvMedia2DWeaveNew() API");

NvMediaStatus
NvMedia2DWeaveNew(
    NvMedia2D        *i2d,
    NvMediaImage     *imageOdd,
    NvMediaImage     *imageEven,
    NvMediaImage     *outImage
);

/*
 * \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 \refNvMedia2DCopyPlane,
     NvMedia2DWeave
 * - Added APIs \ref NvMedia2DCopyPlaneNew, \ref NvMedia2DWeaveNew
 */
#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif /* _NVMEDIA_2D_H */