nvmedia_2d.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2013-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
 
 
#ifndef NVMEDIA_2D_H
#define NVMEDIA_2D_H
 
#include "nvmedia_core.h"
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#define NVMEDIA_2D_VERSION_MAJOR   8
 
#define NVMEDIA_2D_VERSION_MINOR   0
 
#define NVMEDIA_2D_VERSION_PATCH   0
 
typedef enum
{
    NVMEDIA_2D_FILTER_OFF = 0x1,
 
    NVMEDIA_2D_FILTER_LOW,
 
    NVMEDIA_2D_FILTER_MEDIUM,
 
    NVMEDIA_2D_FILTER_HIGH
 
} NvMedia2DFilter;
 
typedef enum
{
    NVMEDIA_2D_TRANSFORM_NONE = 0x0,
 
    NVMEDIA_2D_TRANSFORM_ROTATE_90,
 
    NVMEDIA_2D_TRANSFORM_ROTATE_180,
 
    NVMEDIA_2D_TRANSFORM_ROTATE_270,
 
    NVMEDIA_2D_TRANSFORM_FLIP_HORIZONTAL,
 
    NVMEDIA_2D_TRANSFORM_INV_TRANSPOSE,
 
    NVMEDIA_2D_TRANSFORM_FLIP_VERTICAL,
 
    NVMEDIA_2D_TRANSFORM_TRANSPOSE
 
} NvMedia2DTransform;
 
typedef enum
{
    NVMEDIA_2D_BLEND_MODE_DISABLED,
 
    NVMEDIA_2D_BLEND_MODE_CONSTANT_ALPHA,
 
    NVMEDIA_2D_BLEND_MODE_STRAIGHT_ALPHA,
 
    NVMEDIA_2D_BLEND_MODE_PREMULTIPLIED_ALPHA
 
} NvMedia2DBlendMode;
 
typedef struct
{
    uint32_t numComposeParameters;
 
    uint32_t maxRegisteredBuffers;
 
    uint32_t maxRegisteredSyncs;
 
    uint32_t maxFilterBuffers;
 
    uint32_t flags;
 
} NvMedia2DAttributes;
 
typedef uint32_t NvMedia2DComposeParameters;
 
typedef uint32_t NvMedia2DFilterBuffer;
 
typedef struct
{
    uint64_t operationId;
 
} NvMedia2DComposeResult;
 
typedef struct
{
    int16_t coeffs[32][5];
} NvMedia2DFilterCoefficients5Tap;
 
typedef struct
{
    int16_t coeffs[32][10];
} NvMedia2DFilterCoefficients10Tap;
 
NvMediaStatus
NvMedia2DGetVersion(NvMediaVersion * const version);
 
typedef struct NvMedia2D NvMedia2D;
 
NvMediaStatus
NvMedia2DCreate(NvMedia2D ** const handle,
                NvMedia2DAttributes const * const attr);
 
//    completed.
NvMediaStatus
NvMedia2DDestroy(NvMedia2D const * const handle);
 
NvMediaStatus
NvMedia2DGetComposeParameters(NvMedia2D const * const handle,
                              NvMedia2DComposeParameters * const params);
 
NvMediaStatus
NvMedia2DCompose(NvMedia2D const * const handle,
                 NvMedia2DComposeParameters const params,
                 NvMedia2DComposeResult * const result);
 
NvMediaStatus
NvMedia2DSetSrcGeometry(NvMedia2D const * const handle,
                        NvMedia2DComposeParameters const params,
                        uint32_t const index,
                        NvMediaRect const * const srcRect,
                        NvMediaRect const * const dstRect,
                        NvMedia2DTransform const transform);
 
NvMediaStatus
NvMedia2DSetSrcFilter(NvMedia2D const * const handle,
                      NvMedia2DComposeParameters const params,
                      uint32_t const index,
                      NvMedia2DFilter const filter);
 
NvMediaStatus
NvMedia2DSetSrcBlendMode(NvMedia2D const * const handle,
                         NvMedia2DComposeParameters const params,
                         uint32_t const index,
                         NvMedia2DBlendMode const blendMode,
                         float const constantAlpha);
 
NvMediaStatus
NvMedia2DCreateFilterBuffer(NvMedia2D const * const handle,
                            NvMedia2DFilterBuffer * const filterBuffer);
 
NvMediaStatus
NvMedia2DDestroyFilterBuffer(NvMedia2D const * const handle,
                             NvMedia2DFilterBuffer const filterBuffer);
 
NvMediaStatus
NvMedia2DSetFilterBuffer(NvMedia2D const * const handle,
                         NvMedia2DComposeParameters const params,
                         NvMedia2DFilterBuffer const filterBuffer);
 
NvMediaStatus
NvMedia2DComputeFilterCoefficients5Tap(NvMedia2D const * const handle,
                                       NvMedia2DFilterBuffer const filterBuffer,
                                       uint32_t const index,
                                       NvMedia2DFilterCoefficients5Tap const * const lumaX,
                                       NvMedia2DFilterCoefficients5Tap const * const lumaY,
                                       NvMedia2DFilterCoefficients5Tap const * const chromaX,
                                       NvMedia2DFilterCoefficients5Tap const * const chromaY);
 
NvMediaStatus
NvMedia2DComputeFilterCoefficients10Tap(NvMedia2D const * const handle,
                                        NvMedia2DFilterBuffer const filterBuffer,
                                        uint32_t const index,
                                        NvMedia2DFilterCoefficients10Tap const * const lumaX,
                                        NvMedia2DFilterCoefficients10Tap const * const lumaY,
                                        NvMedia2DFilterCoefficients10Tap const * const chromaX,
                                        NvMedia2DFilterCoefficients10Tap const * const chromaY);
 
 
//
// Version History
//
// Version 1.1 February 1, 2016
// - Initial release
//
// Version 1.2 May 11, 2016
// - Added #NvMedia2DCheckVersion API
//
// Version 1.3 May 5, 2017
// - Removed compositing, blending and alpha related defines and structures
//
// Version 2.0 May 11, 2017
// - Deprecated NvMedia2DBlit API
// - Deprecated NvMedia2DCheckVersion API
// - Deprecated NvMedia2DColorStandard, NvMedia2DColorRange and
//   NvMedia2DColorMatrix types
// - Added #NvMedia2DGetVersion API
//
// Version 2.1 May 17, 2017
// - Moved transformation to nvmedia_common.h
// - Renamed NvMedia2DTransform to #NvMediaTransform
//
// Version 2.2 September 4, 2018
// - Added deprecated warning message for #NvMedia2DCopyPlane,
//   NvMedia2DWeave
// - Added APIs #NvMedia2DCopyPlaneNew, #NvMedia2DWeaveNew
//
// Version 3.0 October 30, 2018
// - Deprecated #NvMedia2DCopyPlane API
// - Deprecated #NvMedia2DWeave API
//
// Version 3.1 December 11, 2018
// - Fixed MISRA-C Rule 21.1 and 21.2 Violations
//
// Version 3.2 January 21, 2019
// - Moved #NvMediaTransform from nvmedia_common.h to this header
//
// Version 3.3 Feb 21, 2019
// - Changed #NvMedia2D type from void to struct
//
// Version 3.4 March 5, 2019
// - Fixed MISRA-C Rule 8.13 Violations
//
// Version 3.5 March 14, 2019
// - Removing NvMedia2DBlitFlags enum definition
// - updated #NvMedia2DBlitParametersOut structure definition
//
// Version 3.6 March 18, 2019
// - Added APIs #NvMedia2DImageRegister, #NvMedia2DImageUnRegister
//
// Version 3.7 March 22, 2019
// - Unnecessary header include nvmedia_common.h has been removed
//
// Version 3.8 May 18, 2020
// - Changes related to MISRA-C Rule 8.13 Violations fixes.
//
// Version 3.9 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
//
// Version 3.10 January 25, 2021
// - Remove NvMedia2DWeaveNew API.
//
// Version 4.0 September 23, 2021
// - Remove NvMedia2DCopyPlaneNew API.
// - Remove NvMedia2DBlitEx API.
// - Remove NvMedia2DImageRegister API.
// - Remove NvMedia2DImageUnregister API.
// - Remove NvMedia2DDestroyEx API.
// - Remove NvMedia2DNvSciSyncGetVersion API.
// - Remove NVMEDIA_2D_NVSCISYNC_VERSION_MAJOR token.
// - Remove NVMEDIA_2D_NVSCISYNC_VERSION_MINOR token.
// - Change prototype for NvMedia2DCreate API.
// - Change prototype for NvMedia2DDestroy API.
// - Change prototype for NvMedia2DSetNvSciSyncObjforEOF API.
// - Change prototype for NvMedia2DInsertPreNvSciSyncFence API.
// - Change prototype for NvMedia2DGetEOFNvSciSyncFence API.
// - Rename NvMedia2DStretchFilter to NvMedia2DFilter.
// - Rename NvMediaTransform to NvMedia2DTransform.
// - Add NVMEDIA_2D_VERSION_PATCH token.
// - Add NvMedia2DCompose API.
// - Add NvMedia2DFillNvSciBufAttrList API.
// - Add NvMedia2DRegisterNvSciBufObj API.
// - Add NvMedia2DUnregisterNvSciBufObj API.
// - Add NvMedia2DSetSrcNvSciBufObj API.
// - Add NvMedia2DSetDstNvSciBufObj API.
// - Set default filter mode to NVMEDIA_2D_FILTER_OFF.
//
// Version 4.1 November 15, 2021
// - Add NvMedia2DSetSrcBlendMode API.
//
// Version 4.2 November 29, 2021
// - Add refcounting to NvMedia2DRegisterNvSciBufObj/UnregisterNvSciBufObj API.
//
// Version 4.3 March 8, 2022
// - Add NvMedia2DCreateFilterBuffer API.
// - Add NvMedia2DDestroyFilterBuffer API.
// - Add NvMedia2DSetFilterBuffer API.
// - Add NvMedia2DComputeFilterCoefficients5Tap API.
// - Add NvMedia2DComputeFilterCoefficients10Tap API.
//
// Version 5.0.0 March 28, 2022
// - Add support for NvSciSync task statuses
// - Max pre-fence count changed from 32 to 16
//
// Version 6.0.0 June 3, 2022
// - Change default for maxRegisteredBuffers attribute from 256 to 64
// - Forbid registering same buffer multiple times
// - Error codes changed for multiple APIs
//
// Version 7.0.0 July 8, 2022
// - New error NVMEDIA_STATUS_INVALID_STATE added for multiple APIs
//
// Version 7.0.1 August 25, 2022
// - Allow NULL context handle in NvMedia2DFillNvSciBufAttrList
//
// Version 7.0.2 September 2, 2022
// - Always treat compose parameters and filter buffer handle value 0 as invalid
//
// Version 8.0.0 October 17, 2023
// - Update the logic to compute the filter buffer coefficients values
//
 
#ifdef __cplusplus
}
#endif
 
#endif // NVMEDIA_2D_H