nvmedia_iofst.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-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_IOFST_H
#define NVMEDIA_IOFST_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include "nvmedia_image.h"
#include "nvmedia_common_encode_ofst.h"
#include "nvmedia_core.h"
#include "nvmedia_surface.h"
 
#define NVMEDIA_IOFST_VERSION_MAJOR   1
 
#define NVMEDIA_IOFST_VERSION_MINOR   14
 
typedef enum {
    NVMEDIA_IMAGE_OPTICALFLOW_ESTIMATION_HP_MODE,
    NVMEDIA_IMAGE_STEREODISPARITY_ESTIMATION_HP_MODE,
    NVMEDIA_IMAGE_OPTICALFLOW_ESTIMATION_HQ_MODE,
    NVMEDIA_IMAGE_STEREODISPARITY_ESTIMATION_HQ_MODE,
    NVMEDIA_IMAGE_OPTICALFLOW_ESTIMATION_UHP_MODE,
    NVMEDIA_IMAGE_STEREODISPARITY_ESTIMATION_UHP_MODE
} NvMediaIOFSTType;
 
typedef enum {
    NVMEDIA_OFST_CONFIG_ENABLE_PROFILING                = (1 << 0)
} NvMediaOFSTConfigFeatures;
 
typedef struct {
    NvMediaIOFSTType estimationType;
    NvMediaSurfaceType inputFormat;
    NvMediaSurfaceType outputFormat;
    NvMediaEncoderInstanceId instanceId;
    struct NvMediaIOFSTPriv_ *ofstPriv;
} NvMediaIOFST;
 
typedef struct {
    uint16_t width;
    uint16_t height;
    uint32_t features;
} NvMediaOFSTInitializeParams;
 
typedef struct {
    void *meExternalHints;
    NvMediaBool enableSegmentMap;
} NvMediaOFSTExternalHintParams;
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIOFSTGetVersion(
    NvMediaVersion *version
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaIOFST *
NvMediaIOFSTCreate(
    const NvMediaDevice *device,
    NvMediaIOFSTType estimationType,
    NvMediaSurfaceType inputFormat,
    NvMediaSurfaceType outputFormat,
    const NvMediaOFSTInitializeParams *initParams,
    uint8_t maxInputBuffering,
    NvMediaEncoderInstanceId instanceId
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
void NvMediaIOFSTDestroy(const NvMediaIOFST *ofst);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIOFSTProcessFrame(
    const NvMediaIOFST *ofst,
    const NvMediaImage *frame,
    const NvMediaImage *refFrame,
    const NvMediaImage *mvs,
    const NvMediaOFSTExternalHintParams *extHintParams,
    NvMediaEncoderInstanceId instanceId
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIOFSTImageRegister(
    const NvMediaIOFST *ofst,
    const NvMediaImage *image,
    NvMediaAccessMode  accessMode
);
 
// coverity[misra_c_2012_rule_8_7_violation : FALSE]
NvMediaStatus
NvMediaIOFSTImageUnRegister(
    const NvMediaIOFST *ofst,
    const NvMediaImage *image
);
 
/*
 * \defgroup history_nvmedia_iofst History
 * Provides change history for the NvMedia IOFST API.
 *
 * \section history_nvmedia_iofst Version History
 *
 * <b> Version 1.0 </b> April 22, 2017
 * - Initial release
 *
 * <b> Version 1.1 </b> June 08, 2017
 * - Added enableSegmentMap parameter to \ref NvMediaOFSTInitializeParams
 * - Added enableSegmentMap parameter to \ref NvMediaOFSTExternalHintParams
 *
 * <b> Version 1.2 </b/> June 13, 2017
 * - Added instance ID parameter to \ref NvMediaIOFSTCreate()
 * - Added instance ID parameter to \ref NvMediaIOFSTProcessFrame()
 * - Added instanceId to \ref NvMediaIOFST object
 *
 * <b> Version 1.3 </b/> June 19, 2017
 * - Added NVMEDIA_IMAGE_OPTICALFLOW_ESTIMATION_HQ_MODE and
 *   NVMEDIA_IMAGE_OPTICALFLOW_ESTIMATION_UHP_MODE and
 *   NVMEDIA_IMAGE_STEREODISPARITY_ESTIMATION_UHP_MODE
 *   parameters \ref NvMediaIOFSTType enum
 *
 * <b> Version 1.4 </b/> June 19, 2018
 * - Added features parameter to \ref NvMediaOFSTInitializeParams
 *
 * <b> Version 1.5 </b/> Dec 14, 2018
 * - Fix MISRA violations 21.1 and 21.2
 *
 * <b> Version 1.6 </b> January 15, 2019
 * - Fix MISRA violations 8.13
 *
 * <b> Version 1.7 </b> Feb 7, 2019
 * - Added opaque handle for ofst
 *   internal usage into OFST object
 * - Fix MISRA violations 11.3
 * - Fix MISRA violations 8.13
 *
 * <b> Version 1.8 </b> February 28, 2019
 * - Added required header includes nvmedia_core.h and nvmedia_surface.h
 *
 * <b> Version 1.9 </b> March 14, 2019
 * - Removed ExternalHints related parameters from
 *   \ref NvMediaOFSTInitializeParams
 * - Updated meExternalHints pointer type in
 *   \ref NvMediaOFSTExternalHintParams
 *
 * <b> Version 1.10 </b> April 03, 2019
 * - Added \ref NvMediaIOFSTGetVersion API
 *
 * <b> Version 1.11 </b> July 10, 2019
 * - Header include nvmedia_common.h is replaced with nvmedia_common_encode_ofst.h
 *
 * <b> Version 1.12 </b> July 16, 2019
 * - Added \ref NvMediaIOFSTImageRegister API
 * - Added \ref NvMediaIOFSTImageUnRegister API
 *
 * <b> Version 1.13 </b> July 17, 2019
 * - Removed nvmedia_array dependency
 *
 * <b> Version 1.14 </b> October 5, 2019
 * - Fix MISRA violations 8.13
 * - Added Coverity Code annotations to suppress partial 8.7 violations
 */
 
#ifdef __cplusplus
};     /* extern "C" */
#endif
 
#endif /* NVMEDIA_IOFST_H */