nvmedia_core.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_CORE_H
#define NVMEDIA_CORE_H

#ifdef __cplusplus
extern "C" {
#endif

#include <math.h>
#include <stdint.h>
#include <time.h>

#if !defined(NVM_DEPRECATED)
    #if defined(__GNUC__) && (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 6)
        /*
         * deprecated as build time warnings to prompt developers to migrate
         * from older API to new one gradually. Should be removed once API
         * transition is done(ie: no warnings).
         */

        #pragma GCC diagnostic warning "-Wdeprecated-declarations"
        #define NVM_DEPRECATED_MSG(fmt) __attribute__((deprecated(fmt)))
    #else
        #define NVM_DEPRECATED
        #define NVM_DEPRECATED_MSG(fmt) NVM_DEPRECATED
    #endif
#else
    #define NVM_DEPRECATED_MSG(fmt) NVM_DEPRECATED
#endif

#define NVMEDIA_RELEASE_VERSION_MAJOR   2

#define NVMEDIA_RELEASE_VERSION_MINOR   0

#define NVMEDIA_CORE_VERSION_MAJOR   1

#define NVMEDIA_CORE_VERSION_MINOR   14

#define NVMEDIA_TRUE  (0 == 0)

#define NVMEDIA_FALSE (0 == 1)

typedef uint32_t NvMediaBool;

typedef struct timespec NvMediaTime;

typedef uint64_t NvMediaGlobalTime;

typedef enum {
    NVMEDIA_TIME_BASE_CLOCK_PTP = 0,
    NVMEDIA_TIME_BASE_CLOCK_MONOTONIC,
    NVMEDIA_TIME_BASE_CLOCK_USER_DEFINED,
} NvMediaTimeBase;

typedef enum {
    NVMEDIA_COLOR_STANDARD_ITUR_BT_601,
    NVMEDIA_COLOR_STANDARD_ITUR_BT_709,
    NVMEDIA_COLOR_STANDARD_SMPTE_240M,
    NVMEDIA_COLOR_STANDARD_ITUR_BT_601_ER,
    NVMEDIA_COLOR_STANDARD_ITUR_BT_709_ER
} NvMediaColorStandard;

typedef struct {
    uint16_t x0;
    uint16_t y0;
    uint16_t x1;
    uint16_t y1;
} NvMediaRect;

typedef struct {
    int32_t x;
    int32_t y;
} NvMediaPoint;

typedef struct {
    float_t x;
    float_t y;
} NvMediaPointFloat;

typedef struct {
    double_t x;
    double_t y;
} NvMediaPointDouble;

typedef enum {
    NVMEDIA_STATUS_OK = 0,
    NVMEDIA_STATUS_BAD_PARAMETER = 1,
    NVMEDIA_STATUS_PENDING = 2,
    NVMEDIA_STATUS_TIMED_OUT = 3,
    NVMEDIA_STATUS_OUT_OF_MEMORY = 4,
    NVMEDIA_STATUS_NOT_INITIALIZED = 5,
    NVMEDIA_STATUS_NOT_SUPPORTED = 6,
    NVMEDIA_STATUS_ERROR = 7,
    NVMEDIA_STATUS_NONE_PENDING = 8,
    NVMEDIA_STATUS_INSUFFICIENT_BUFFERING = 9,
    NVMEDIA_STATUS_INVALID_SIZE = 10,
    NVMEDIA_STATUS_INCOMPATIBLE_VERSION = 11,
    NVMEDIA_STATUS_UNDEFINED_STATE = 13,
    NVMEDIA_STATUS_PFSD_ERROR = 14,
} NvMediaStatus;

typedef struct {
    NvMediaStatus status;
    uint64_t endTimestamp;
} NvMediaTaskStatus;

typedef struct {
    uint8_t major;
    uint8_t minor;
} NvMediaVersion;

/*
 ******* Definitions ******************
 * SOFFence - Start of frame \ref NvSciSyncFence. An NvSciSyncFence
 *            whose expiry indicates that the processing has started.
 * EOFFence - End of frame NvSciSyncFence. An NvSciSyncFence
 *            whose expiry indicates that the processing is done.
 * PREFence - An NvSciSyncFence on which the start of processing is
 *            blocked until the expiry of the fence.
 **************************************
 */

typedef enum {
    NVMEDIA_SIGNALER,
    NVMEDIA_WAITER,
    NVMEDIA_SIGNALER_WAITER
} NvMediaNvSciSyncClientType;

typedef enum {
    NVMEDIA_PRESYNCOBJ,
    NVMEDIA_EOFSYNCOBJ,
    NVMEDIA_SOFSYNCOBJ,
    NVMEDIA_EOF_PRESYNCOBJ,
    NVMEDIA_SOF_PRESYNCOBJ

} NvMediaNvSciSyncObjType;

/*
 * \brief Defines all possible access modes.
 */
typedef enum {
    NVMEDIA_ACCESS_MODE_READ,
    NVMEDIA_ACCESS_MODE_READ_WRITE,
} NvMediaAccessMode;

NvMediaStatus
NvMediaReleaseGetVersion(
    NvMediaVersion *version
);

NvMediaStatus
NvMediaCoreGetVersion(
    NvMediaVersion *version
);

typedef struct NvMediaDevice NvMediaDevice;

NvMediaDevice *
NvMediaDeviceCreate(
    void
);

void
NvMediaDeviceDestroy(
    NvMediaDevice *device
);

/*
 * \defgroup history_nvmedia_core History
 * Provides change history for the NvMedia Common Types.
 *
 * \section history_nvmedia_core Version History
 *
 * <b> Version 1.0 </b> March 21, 2017
 * - Initial release
 *
 * <b> Version 1.1 </b> April 18, 2017
 * - NVMEDIA_VERSION_MAJOR is renamed to NVMEDIA_CORE_VERSION_MAJOR.
 * - NVMEDIA_VERSION_MINOR is renamed to NVMEDIA_CORE_VERSION_MINOR.
 * - NvMediaBool is now changed from "int" to "uint32_t" type.
 * - NvMediaRect is now changed from "unsigned short" to "uint16_t".
 * - All NvMedia data types are moved to standard data types from <stdint.h>
 * - NvMediaVersionInfo is now deprecated. Use module specific GetVersion()
     API to query the module versions.
 * - NvMediaGetVersionInfo is now deprecated. Use NvMediaCoreGetVersion()
     or NvMediaReleaseGetVersion()
 * - NvMediaCheckVersion is now deprecated. Applications are expected
     to check their version using above GetVersion() APIs.
 * - NVMEDIA_SET_VERSION macro is now deprecated.
 *
 * <b> Version 1.2 </b> May 4, 2017
 * - Added \ref NvMediaROI and \ref NvMediaTaskStatus.
 *
 * <b> Version 1.3 </b> May 17, 2017
 * - Added macros to generate build warnings for deprecated APIs
 * - Changed the size of \ref NvMediaPoint members
 *
 * <b> Version 1.4 </b> September 14, 2017
 * - Added \ref NvMediaTimeBase
 *
 * <b> Version 1.5 </b> December 12, 2017
 * - Deprecated the following palette related APIs:
 *   NvMediaPaletteCreate
 *   NvMediaPaletteDestroy
 *   NvMediaPaletteLoad
 *
 * <b> Version 1.6 </b> Sep 12, 2018
 * - Add \ref NvMediaPointDouble
 *
 * <b> Version 1.7 </b> Dec 12, 2018
 * - MISRA Rule 21.1 and 21.2 violations are fixed
 *
 * <b> Version 1.8 </b> Feb 4, 2019
 * - Removed \ref NvMediaROI
 * - Moved \ref NvMediaColor to nvmedia_vmp.h
 * - Changed \ref NvMediaDevice type from void to struct
 *
 * <b> Version 1.9 </b> March 7, 2019
 * - Added \ref NvMediaNvSciSyncClientType and \ref NvMediaNvSciSyncObjType.
 *
 * <b> Version 1.10 </b> March 18, 2019
 * - Added /ref NvMediaAccessMode
 *
 * <b> Version 1.11 </b> March 25, 2019
 * - Removed enum value NVMEDIA_STATUS_CANCELLED from \ref NvMediaStatus
 *
 * <b> Version 1.12 </b> April 2, 2019
 * - Added enum value NVMEDIA_STATUS_PFSD_ERROR to \ref NvMediaStatus
 *
 * <b> Version 1.13 </b> August 1, 2019
 * - Added manual enumeration for backward compatibility to \ref NvMediaStatus
 *
 * <b> Version 1.14 </b> November 06, 2019
 * - Add \ref NvMediaPointFloat
 *
 */

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

#endif /* NVMEDIA_CORE_H */