/*############################################################################
  # Copyright (C) Intel Corporation
  #
  # SPDX-License-Identifier: MIT
  ############################################################################*/

#ifndef LIBVPL_SRC_WINDOWS_MFX_DISPATCHER_H_
#define LIBVPL_SRC_WINDOWS_MFX_DISPATCHER_H_

#include <stddef.h>

#include <algorithm>

#include "vpl/mfxdispatcher.h"
#include "vpl/mfxvideo.h"

#include "src/windows/mfx_dispatcher_defs.h"

// internal implementation of mfxConfigInterface
#include "src/mfx_config_interface/mfx_config_interface.h"

#define INTEL_VENDOR_ID 0x8086

mfxStatus MFXQueryVersion(mfxSession session, mfxVersion *version);

enum {
    // to avoid code changing versions are just inherited
    // from the API header file.
    DEFAULT_API_VERSION_MAJOR = MFX_VERSION_MAJOR,
    DEFAULT_API_VERSION_MINOR = MFX_VERSION_MINOR
};

enum { VPL_MINIMUM_VERSION_MAJOR = 2, VPL_MINIMUM_VERSION_MINOR = 0 };

//
// declare functions' integer identifiers.
//

#undef FUNCTION
#define FUNCTION(return_value, func_name, formal_param_list, actual_param_list) e##func_name,

enum eFunc {
    eMFXInit,
    eMFXClose,
    eMFXQueryIMPL,
    eMFXQueryVersion,
    eMFXVideoCORE_GetHandle,
    eMFXJoinSession,
    eMFXDisjoinSession,
    eMFXCloneSession,
    eMFXSetPriority,
    eMFXGetPriority,
    eMFXInitEx,
#include "src/windows/mfx_exposed_functions_list.h"
    eVideoFuncTotal
};

enum ePluginFunc {
    eMFXVideoUSER_Load,
    eMFXVideoUSER_LoadByPath,
    eMFXVideoUSER_UnLoad,
    eMFXAudioUSER_Load,
    eMFXAudioUSER_UnLoad,
    ePluginFuncTotal
};

enum eVideoFunc2 {
    // 2.0
    eMFXQueryImplsDescription,
    eMFXReleaseImplDescription,
    eMFXMemory_GetSurfaceForVPP,
    eMFXMemory_GetSurfaceForEncode,
    eMFXMemory_GetSurfaceForDecode,
    eMFXInitialize,

    // 2.1
    eMFXMemory_GetSurfaceForVPPOut,
    eMFXVideoDECODE_VPP_Init,
    eMFXVideoDECODE_VPP_DecodeFrameAsync,
    eMFXVideoDECODE_VPP_Reset,
    eMFXVideoDECODE_VPP_GetChannelParam,
    eMFXVideoDECODE_VPP_Close,
    eMFXVideoVPP_ProcessFrameAsync,

    eVideoFunc2Total
};

// declare max buffer length for regsitry key name
enum { MFX_MAX_REGISTRY_KEY_NAME = 256 };

// declare the maximum DLL path
enum { MFX_MAX_DLL_PATH = 1024 };

// declare library's implementation types
enum eMfxImplType {
    MFX_LIB_HARDWARE = 0,
    MFX_LIB_SOFTWARE = 1,
    MFX_LIB_PSEUDO   = 2,

    MFX_LIB_IMPL_TYPES
};

// declare dispatcher's version
enum { MFX_DISPATCHER_VERSION_MAJOR = 1, MFX_DISPATCHER_VERSION_MINOR = 3 };

struct _mfxSession {
    // A real handle from MFX engine passed to a called function
    mfxSession session;

    mfxFunctionPointer callTable[eVideoFuncTotal]; // NOLINT(runtime/arrays)
    mfxFunctionPointer callPlugInsTable[ePluginFuncTotal]; // NOLINT(runtime/arrays)
    mfxFunctionPointer callVideoTable2[eVideoFunc2Total]; // NOLINT(runtime/arrays)

    // Current library's implementation (exact implementation)
    mfxIMPL impl;
};

// declare a dispatcher's handle
struct MFX_DISP_HANDLE : public _mfxSession {
    // Default constructor
    explicit MFX_DISP_HANDLE(const mfxVersion requiredVersion);
    // Destructor
    ~MFX_DISP_HANDLE(void);

    // Load the library's module
    mfxStatus LoadSelectedDLL(const wchar_t *pPath,
                              eMfxImplType implType,
                              mfxIMPL impl,
                              mfxIMPL implInterface,
                              mfxInitParam &par,
                              mfxInitializationParam &vplParam,
                              bool bCloneSession = false);
    // Unload the library's module
    mfxStatus UnLoadSelectedDLL(void);

    // Close the handle
    mfxStatus Close(void);

    // NOTE: changing order of struct's members can make different version of
    // dispatchers incompatible. Think of different modules (e.g. MFT filters)
    // within a single application.
    //
    // FOR THIS IMPLEMENTATION: order should not matter. Dispatcher is now built
    // as a DLL and installed in %WINDIR%\system32. Thus all applications on the
    // system should use same dispatcher.  Even if an app loads a different
    // dispatcher version, initializing an mfxSession with one library then
    // using it in a different library is not a supported use case.

    // Library's implementation type (hardware or software)
    eMfxImplType implType;
    // Current library's VIA interface
    mfxIMPL implInterface;
    // Dispatcher's version. If version is 1.1 or lower, then old dispatcher's
    // architecture is used. Otherwise it means current dispatcher's version.
    mfxVersion dispVersion;
    // Required API version of session initialized
    const mfxVersion apiVersion;
    // Actual library API version
    mfxVersion actualApiVersion;
    // Status of loaded dll
    mfxStatus loadStatus;
    // Resgistry subkey name for windows version
    wchar_t subkeyName[MFX_MAX_REGISTRY_KEY_NAME];
    // Storage ID for windows version
    int storageID;

    // Library's module handle
    mfxModuleHandle hModule;

private:
    // Declare assignment operator and copy constructor to prevent occasional assignment
    MFX_DISP_HANDLE(const MFX_DISP_HANDLE &);
    MFX_DISP_HANDLE &operator=(const MFX_DISP_HANDLE &);
};

// This struct extends MFX_DISP_HANDLE, we cannot extend MFX_DISP_HANDLE itself due to possible compatibility issues
// This struct was added in dispatcher version 1.3
// Check dispatcher handle's version when you cast session struct which came from outside of MSDK API function to this
struct MFX_DISP_HANDLE_EX : public MFX_DISP_HANDLE {
    explicit MFX_DISP_HANDLE_EX(const mfxVersion requiredVersion);

    mfxU16 mediaAdapterType;
    mfxU16 reserved[10];
};

// declare comparison operator
inline bool operator==(const mfxVersion &one, const mfxVersion &two) {
    return (one.Version == two.Version);
}

inline bool operator<(const mfxVersion &one, const mfxVersion &two) {
    return (one.Major < two.Major) || ((one.Major == two.Major) && (one.Minor < two.Minor));
}

inline bool operator<=(const mfxVersion &one, const mfxVersion &two) {
    return (one == two) || (one < two);
}

inline bool operator==(mfxGUID const &l, mfxGUID const &r) {
    return std::equal(l.Data, l.Data + 16, r.Data);
}

//
// declare a table with functions descriptions
//

typedef struct FUNCTION_DESCRIPTION {
    // Literal function's name
    const char *pName;
    // API version when function appeared first time
    mfxVersion apiVersion;
} FUNCTION_DESCRIPTION;

extern const FUNCTION_DESCRIPTION APIFunc[eVideoFuncTotal];

extern const FUNCTION_DESCRIPTION APIVideoFunc2[eVideoFunc2Total];

#endif // LIBVPL_SRC_WINDOWS_MFX_DISPATCHER_H_
