nvmedia_vmp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2019, 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_VMP_H
#define _NVMEDIA_VMP_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_2d.h"
#include "nvmedia_core.h"
#include "nvmedia_common.h"
#include "nvmedia_surface.h"
#include "nvmedia_video.h"
#include "nvmedia_vop.h"

#define NVMEDIA_VMP_VERSION_MAJOR   2

#define NVMEDIA_VMP_VERSION_MINOR   5

#define NVMEDIA_VMP_FEATURE_BACKGROUND_PRESENT              (1<<0)

#define NVMEDIA_VMP_FEATURE_INTERLACED                      (1<<1)

#define NVMEDIA_VMP_FEATURE_DEINTERLACING                   (1<<2)

#define NVMEDIA_VMP_FEATURE_ADVANCED1_DEINTERLACING         (1<<3)

#define NVMEDIA_VMP_FEATURE_ADVANCED2_DEINTERLACING         (1<<4)

#define NVMEDIA_VMP_FEATURE_LIMITED_RGB_INPUT               (1<<5)

#define NVMEDIA_VMP_FEATURE_INVERSE_TELECINE                (1<<6)

#define NVMEDIA_VMP_FEATURE_NOISE_REDUCTION                 (1<<7)

#define NVMEDIA_VMP_FEATURE_SHARPENING                      (1<<8)

#define NVMEDIA_VMP_FEATURE_ALPHA_SURFACE_MODE              (1<<9)

#define NVMEDIA_VMP_FEATURE_PROTECTED                       (1<<10)

#define NVMEDIA_VMP_FEATURE_ENABLE_DFS                      (1<<11)

#define NVMEDIA_VMP_ATTR_BRIGHTNESS                    (1<<0)

#define NVMEDIA_VMP_ATTR_CONTRAST                      (1<<1)

#define NVMEDIA_VMP_ATTR_SATURATION                    (1<<2)

#define NVMEDIA_VMP_ATTR_HUE                           (1<<3)

#define NVMEDIA_VMP_ATTR_COLOR_STANDARD                (1<<4)

#define NVMEDIA_VMP_ATTR_DEINTERLACE_TYPE              (1<<6)

#define NVMEDIA_VMP_ATTR_NOISE_REDUCTION               (1<<7)

#define NVMEDIA_VMP_ATTR_NOISE_REDUCTION_ALGORITHM     (1<<8)

#define NVMEDIA_VMP_ATTR_SHARPENING                    (1<<9)

#define NVMEDIA_VMP_ATTR_INVERSE_TELECINE              (1<<10)

#define NVMEDIA_VMP_ATTR_FILTER_QUALITY                (1<<11)

#define NVMEDIA_VMP_ATTR_DESTINATION_ALPHA             (1<<12)

#define NVMEDIA_VMP_ATTR_DESTINATION_PREMULTIPLY_ALPHA (1<<13)

#define NVMEDIA_VMP_ATTR_TRANSFORM                     (1<<14)

typedef void NvMediaVideoMixer;

typedef enum {
    NVMEDIA_DEINTERLACE_TYPE_BOB = 0,
    NVMEDIA_DEINTERLACE_TYPE_ADVANCED1 = 1,
    NVMEDIA_DEINTERLACE_TYPE_ADVANCED2 = 2
} NvMediaDeinterlaceType;

typedef enum {
    NVMEDIA_PICTURE_STRUCTURE_TOP_FIELD = 0x1,
    NVMEDIA_PICTURE_STRUCTURE_BOTTOM_FIELD = 0x2,
    NVMEDIA_PICTURE_STRUCTURE_FRAME = 0x3
} NvMediaPictureStructure;

typedef struct {
    float_t red;
    float_t green;
    float_t blue;
    float_t alpha;
} NvMediaColor;

NvMediaStatus
NvMediaVideoMixerGetVersion(
    NvMediaVersion *version
);

NvMediaVideoMixer *
NvMediaVideoMixerCreate(
    NvMediaDevice *device,
    NvMediaSurfaceType surfaceType,
    uint16_t mixerWidth,
    uint16_t mixerHeight,
    float_t  sourceAspectRatio,
    uint16_t videoWidth,
    uint16_t videoHeight,
    uint32_t features
);

void
NvMediaVideoMixerDestroy(
    NvMediaVideoMixer *mixer
);

typedef struct {
    float_t brightness;
    float_t contrast;
    float_t saturation;
    float_t hue;
    NvMediaColorStandard colorStandard;
    NvMediaDeinterlaceType deinterlaceType;
    float_t noiseReduction;
    NvMediaNoiseReductionAlgorithm noiseReductionAlgorithm;
    float_t sharpening;
    NvMediaBool inverseTelecine;
    NvMediaFilterQuality filterQuality;
    float_t destinationAlpha;
    NvMediaBool premultiplyAlpha;
    NvMediaTransform dstTransform;
} NvMediaVideoMixerAttributes;

void
NvMediaVideoMixerSetAttributes(
   NvMediaVideoMixer *mixer,
   uint32_t attributeMask,
   NvMediaVideoMixerAttributes *attributes
);

typedef struct {
    NvMediaColor backgroundColor;
} NvMediaBackground;

typedef struct {
    NvMediaPictureStructure pictureStructure;
    NvMediaVideoSurface *next;
    NvMediaVideoSurface *current;
    NvMediaVideoSurface *previous;
    NvMediaVideoSurface *previous2;
    NvMediaRect *srcRect;
    NvMediaRect *dstRect;
} NvMediaVideoDesc;

typedef struct {
    NvMediaVideoSurface *alphaSurface;

    NvMediaRect *srcRect;
} NvMediaAlphaSurface;

NvMediaStatus
NvMediaVideoMixerRenderSurface(
    NvMediaVideoMixer *mixer,
    NvMediaVideoSurface *outputSurface,
    NvMediaBackground *background,
    NvMediaVideoDesc *video
);

NvMediaStatus
NvMediaVideoMixerRenderSurfaceWithAlpha(
    NvMediaVideoMixer *mixer,
    NvMediaVideoSurface *outputSurface,
    NvMediaBackground *background,
    NvMediaVideoDesc *video,
    NvMediaAlphaSurface *alpha
);

/*
 * \defgroup history_nvmedia_vmp History
 * Provides change history for the NvMedia Video Mixer API.
 *
 * \section history_nvmedia_vmp Version History
 *
 * <b> Version 1.0 </b> March 21, 2017
 * - Initial release
 *
 * <b> Version 2.0 </b> May 17, 2017
 * - Removed NvMediaVideoMixerRender and NvMediaVideoMixerRenderWithAlpha functions
 * - Removed multi-layer rendering
 * - Removed secondary video and graphics layer support
 * - Added NvMediaVideoMixerGetVersion function
 * - Added destination surface transformation
 * - Changed NvMediaVideoMixer function definition
 * - All NvMedia data types are moved to standard data types
 *
 * <b> Version 2.1 </b> September 7, 2017
 * - Added feature \ref NVMEDIA_VMP_FEATURE_ENABLE_DFS to enable DFS for mixer
 *   hardware block
 *
 * <b> Version 2.2 </b> March 16, 2018
 * - Move \ref NvMediaNoiseReductionAlgorithm structure definition to nvmedia_common.h header file
 *
 * <b> Version 2.3 </b> January 21, 2019
 * - Added header include nvmedia_2d.h
 *
 * <b> Version 2.4 </b> February 4, 2019
 * - Moved \ref NvMediaColor from nvmedia_core.h to this header
 *
 * <b> Version 2.5 </b> February 6, 2019
 * - Added required header include nvmedia_surface.h
 */


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

#endif /* _NVMEDIA_VMP_H */