TexConv/Applications/_Plugins/Common/PluginInterface.h

//=====================================================================
// Copyright 2016-2021 (c), Advanced Micro Devices, Inc. All rights reserved.
//
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files(the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions :
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
/// \file PluginInterface.h
/// \version 3.2
/// \brief Declares the interface to the Compressonator & ArchitectMF SDK
//
//=====================================================================

#ifndef _PLUGININTERFACE_H
#define _PLUGININTERFACE_H

#include "common.h"
#include "compressonator.h"

#include "pluginbase.h"
#include "pluginmanager.h"
#include "texture.h"

#define TC_API_VERSION_MAJOR 1
#define TC_API_VERSION_MINOR 4

typedef CMP_DWORD_PTR TC_HANDLE;  ///< Generic Texture API handle
typedef TC_HANDLE HFILETYPE;  ///< Handle to a FileType.
typedef TC_HANDLE HCODEC;     ///< Handle to a Codec.
typedef TC_HANDLE HMIPPER;    ///< Handle to a Mipper.
typedef TC_HANDLE HVIEWTYPE;  ///< \internal Handle to a ViewType.
typedef TC_HANDLE HVIEW;      ///< \internal Handle to a View.

#ifndef _WIN32
typedef CMP_DWORD WNDPROC;
#endif

class PluginInterface_Image : PluginBase {
  public:
    PluginInterface_Image() {}
    virtual ~PluginInterface_Image() {}
    virtual int TC_PluginGetVersion(TC_PluginVersion* pPluginVersion)=0;
    virtual int TC_PluginSetSharedIO(void* Shared)=0;

    virtual int TC_PluginFileLoadTexture(const char* pszFilename, MipSet* pMipSet) = 0;
    virtual int TC_PluginFileSaveTexture(const char* pszFilename, MipSet* pMipSet) = 0;
    virtual int TC_PluginFileLoadTexture(const char* pszFilename, CMP_Texture *srcTexture) = 0;
    virtual int TC_PluginFileSaveTexture(const char* pszFilename, CMP_Texture *srcTexture) = 0;
};

class PluginInterface_Codec : PluginBase {
  public:
    PluginInterface_Codec() {}
    virtual ~PluginInterface_Codec() {}
    virtual int TC_PluginGetVersion(TC_PluginVersion* pPluginVersion)=0;
};

// These type of plugins are used to Analyze images
class PluginInterface_Analysis : PluginBase {
  public:
    PluginInterface_Analysis() {}
    virtual ~PluginInterface_Analysis() {}
    virtual int TC_PluginGetVersion(TC_PluginVersion* pPluginVersion)=0;
    virtual int TC_ImageDiff(const char *in1, const char *in2, const char *out, char *resultsFile, void *usrAnalysisData, void *pluginManager, void **cmipImages, CMP_Feedback_Proc pFeedbackProc = NULL) {
        (void)in1, (void)in2, (void)out, (void)resultsFile;
        (void) usrAnalysisData;
        (void)pluginManager;
        (void*)cmipImages;
        (void)pFeedbackProc;
        return 0;
    };
    virtual int TC_PSNR_MSE(const char *in1, const char *in2, char *resultsFile, void *pluginManager, CMP_Feedback_Proc pFeedbackProc = NULL) {
        (void)in1, (void)in2, (void)resultsFile;
        (void)pluginManager;
        (void)pFeedbackProc;
        return 0;
    };
    virtual int TC_SSIM(const char *in1, const char *in2, char *resultsFile, void *pluginManager, CMP_Feedback_Proc pFeedbackProc = NULL) {
        (void)in1, (void)in2, (void)resultsFile;
        (void)pluginManager;
        (void)pFeedbackProc;
        return 0;
    };
};


// These type of plugins are used transcode compress texture to another compressed format
class PluginInterface_CMPTranscode : PluginBase {
  public:
    PluginInterface_CMPTranscode() {}
    virtual ~PluginInterface_CMPTranscode() {}
    virtual int         TC_PluginGetVersion(TC_PluginVersion* pPluginVersion) = 0;
    virtual int         TC_PluginSetSharedIO(void* Shared) = 0;
    virtual CMP_ERROR   TC_Trancode(MipSet  *srcTexture, MipSet  *destTexture) = 0;
};

// These type of plugins are used to Generate or transform images
class PluginInterface_Filters : PluginBase {
  public:
    PluginInterface_Filters() {}
    virtual ~PluginInterface_Filters() {}
    virtual int TC_PluginSetSharedIO(void* Shared) = 0;
    virtual int TC_PluginGetVersion(TC_PluginVersion* pPluginVersion)=0;
    virtual int TC_CFilter(CMP_MipSet* pMipSet, CMP_MipSet* pMipSetDst, CMP_CFilterParams* FilterParams) = 0;
};


// These type of plugins are used for Compute
class PluginInterface_Encoder : PluginBase {
  public:
    PluginInterface_Encoder() {}
    virtual ~PluginInterface_Encoder() {}
    virtual int     TC_PluginGetVersion(TC_PluginVersion* pPluginVersion) = 0;
    virtual int     TC_PluginSetSharedIO(void* Shared) = 0;
    virtual void*   TC_Create() = 0;
    virtual void    TC_Destroy(void* codec) = 0;
    virtual int     TC_Init(void* kernel_options) = 0;
    virtual char *  TC_ComputeSourceFile(unsigned int     Compute_type) = 0;
    virtual void    TC_Start() = 0;
    virtual void    TC_End() =0;
};

class PluginInterface_Pipeline : PluginBase {
  public:
    PluginInterface_Pipeline() {}
    virtual ~PluginInterface_Pipeline() {}
    virtual int         TC_PluginGetVersion(TC_PluginVersion* pPluginVersion) = 0;
    virtual int         TC_PluginSetSharedIO(void* Shared) = 0;
    virtual int         TC_Init(void  *kernel_options) = 0;
    virtual CMP_ERROR   TC_Compress(void  *kernel_options, MipSet  &SrcTexture, MipSet  &destTexture,CMP_Feedback_Proc pFeedbackProc = NULL) = 0;
    virtual void        TC_SetComputeOptions(void *options) = 0;
    virtual char *      TC_ComputeSourceFile() = 0;
    virtual CMP_ERROR   TC_GetPerformanceStats(void* pPerfStats) = 0;
    virtual CMP_ERROR   TC_GetDeviceInfo(void* pDeviceInfo) = 0;
    virtual int TC_Close() = 0;
};


// These type of plugins are used to Decompress Images using GPU
class PluginInterface_GPUDecode : PluginBase {
  public:
    PluginInterface_GPUDecode() {}
    virtual ~PluginInterface_GPUDecode() {}
    virtual int TC_PluginGetVersion(TC_PluginVersion* pPluginVersion) = 0;
    virtual int TC_Init(CMP_DWORD Width, CMP_DWORD Height, WNDPROC callback) = 0;
    virtual CMP_ERROR TC_Decompress(const CMP_Texture* pSourceTexture, CMP_Texture* pDestTexture) = 0;
    virtual int TC_Close() = 0;
};


class PluginInterface_3DModel : PluginBase {
  public:
    PluginInterface_3DModel() {}
    virtual ~PluginInterface_3DModel() {}
    virtual int  TC_PluginGetVersion(TC_PluginVersion* pPluginVersion) = 0;
    virtual int  TC_PluginSetSharedIO(void* Shared) = 0;
    virtual void *CreateView(void *ModelData, CMP_LONG Width, CMP_LONG Height, void *HWND, void *pluginManager, void *msghandler,CMP_Feedback_Proc pFeedbackProc = NULL) = 0;
    virtual void *ShowView(void *data) = 0;
    virtual void CloseView()    = 0;
    virtual bool OnRenderView()   = 0;
    virtual void OnReSizeView(CMP_LONG w, CMP_LONG h) = 0;
    virtual void processMSG(void *message) = 0;
};


class PluginInterface_3DModel_Loader : PluginBase {
  public:
    PluginInterface_3DModel_Loader() {}
    virtual ~PluginInterface_3DModel_Loader() {}
    virtual int  TC_PluginGetVersion(TC_PluginVersion* pPluginVersion) = 0;
    virtual int  TC_PluginSetSharedIO(void* Shared) = 0;
    virtual int  LoadModelData(const char* pszFilename, const char* pszFilename2, void *pluginManager, void *msghandler, CMP_Feedback_Proc pFeedbackProc) = 0;
    virtual int  SaveModelData(const char* pdstFilename, void* meshData) = 0;
    virtual void *GetModelData() = 0;
};

class PluginInterface_Mesh : PluginBase {
  public:
    PluginInterface_Mesh() {}
    virtual ~PluginInterface_Mesh() {}
    virtual int  TC_PluginGetVersion(TC_PluginVersion* pPluginVersion) = 0;
    virtual int  TC_PluginSetSharedIO(void* Shared) = 0;

    virtual int Init() = 0;
    virtual void* ProcessMesh(void* data = NULL, void* setting = NULL, void* statsOut = NULL, CMP_Feedback_Proc pFeedbackProc = NULL) = 0;
    virtual int CleanUp() = 0;
};

class PluginInterface_WindowViews : PluginBase {
  public:
    PluginInterface_WindowViews() {}
    virtual ~PluginInterface_WindowViews() {}
    virtual int TC_PluginGetVersion(TC_PluginVersion* pPluginVersion) = 0;
    virtual void  ShowWindow(bool Show) = 0;
    virtual void *CreateView(void *window) = 0;
    virtual void  DeleteView()  = 0;
};


//High Performance Compute codec interface
class CMP_Encoder {
  public:
    CMP_Encoder() {
        m_srcWidth  = 0;
        m_srcHeight = 0;
        m_srcStride = 0;
        m_dstStride = 0;
        m_xdim      = 4;
        m_ydim      = 4;
        m_zdim      = 1;
        m_quality   = 0.05f;
    };
    ~CMP_Encoder() {};

    // Block Level Processing
    virtual int CompressBlock(unsigned int xBlock, unsigned int yBlock, void *in, void *out) = 0;
    virtual int CompressBlock(void *in, void *out, void *blockoptions) = 0;
    virtual int DecompressBlock(unsigned int xBlock, unsigned int yBlock, void *in, void *out) = 0;
    virtual int DecompressBlock(void *in, void *out) = 0;

    // Full Texture Processing
    virtual int CompressTexture(void *in, void *out,void *processOptions) = 0;
    virtual int DecompressTexture(void *in, void *out,void *processOptions) = 0;

    // Original image size
    unsigned int     m_srcWidth;
    unsigned int     m_srcHeight;

    // image strides
    unsigned int     m_srcStride;
    unsigned int     m_dstStride;

    // Source block dimensions to compress
    unsigned int     m_xdim;
    unsigned int     m_ydim;
    unsigned int     m_zdim;
    // Compression quality to apply during compression
    float            m_quality;
};


class PluginInterface_Vision : PluginBase
{
public:
    PluginInterface_Vision()
    {
    }
    virtual ~PluginInterface_Vision()
    {
    }
    virtual int   TC_PluginGetVersion(TC_PluginVersion* pPluginVersion) = 0;

    virtual void VisionProcess(char* srcFile, char* testFile, void *options, void *results) = 0;
};

#endif