API.h

/*
  COPYRIGHT (c) 2012-2024 Esri R&D Center Zurich
  TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
  Unpublished material - all rights reserved under the
  Copyright Laws of the United States and applicable international
  laws, treaties, and conventions.

  For additional information, contact:
  Environmental Systems Research Institute, Inc.
  Attn: Contracts and Legal Services Department
  380 New York Street
  Redlands, California, 92373
  USA

  email: contracts@esri.com
*/

#ifndef PRT_API_H_
#define PRT_API_H_

#include "prt/prt.h"
#include "prt/Status.h"
#include "prt/InitialShape.h"
#include "prt/RuleFileInfo.h"
#include "prt/EncoderInfo.h"
#include "prt/DecoderInfo.h"
#include "prt/LogLevel.h"
#include "prt/LogHandler.h"
#include "prt/Callbacks.h"
#include "prt/Version.h"
#include "prt/OcclusionSet.h"


namespace prt {


// --- MAIN PRT API CALLS


PRT_EXPORTS_API const Object* init(
        const wchar_t* const* prtPlugins,
        size_t                prtPluginsCount,
        LogLevel              logLevel,
        Status*               stat = nullptr
);

PRT_EXPORTS_API Status generate(
        const InitialShape* const*  initialShapes,
        size_t                      initialShapeCount,
        const OcclusionSet::Handle* occlusionHandles,
        const wchar_t* const*       encoders,
        size_t                      encodersCount,
        const AttributeMap* const*  encoderOptions,
        Callbacks*                  callbacks,
        Cache*                      cache,
        const OcclusionSet*         occlSet,
        const AttributeMap*         generateOptions = nullptr
);

PRT_EXPORTS_API Status generate(
        const InitialShape* const*  initialShapes,
        size_t                      initialShapeCount,
        const OcclusionSet::Handle* occlusionHandles,
        const wchar_t* const*       encoders,
        size_t                      encodersCount,
        const AttributeMap* const*  encoderOptions,
        Callbacks*                  callbacks,
        Cache*                      cache,
        const OcclusionSet* const*  occlSets,
        const size_t*               occlSetCounts,
        const AttributeMap*         generateOptions = nullptr
);

PRT_EXPORTS_API Status generateOccluders(
        const InitialShape* const* initialShapes,
        size_t                     initialShapeCount,
        OcclusionSet::Handle*      occlusionHandles,
        const wchar_t* const*      encoders,
        size_t                     encodersCount,
        const AttributeMap* const* encoderOptions,
        Callbacks*                 callbacks,
        Cache*                     cache,
        OcclusionSet*              occlSet,
        const AttributeMap*        generateOptions = nullptr
);

PRT_EXPORTS_API RuleFileInfo const* createRuleFileInfo(
        const wchar_t* ruleFileURI,
        Cache*         cache = nullptr,
        Status*        stat = nullptr
);

PRT_EXPORTS_API ResolveMap const* createResolveMap(
        const wchar_t* rpkOrResURI,
        const wchar_t* unpackFileSystemPath = nullptr,
        Status*        stat = nullptr
);


// --- EXTENSIONS

PRT_EXPORTS_API wchar_t* listEncoderIds(wchar_t* result, size_t* resultSize, Status* stat = nullptr);

PRT_EXPORTS_API wchar_t* listDecoderIds(wchar_t* result, size_t* resultSize, Status* stat = nullptr);

PRT_EXPORTS_API EncoderInfo const* createEncoderInfo(const wchar_t* encoderId, Status* stat = nullptr);

PRT_EXPORTS_API DecoderInfo const* createDecoderInfo(const wchar_t* decoderId, Status* stat = nullptr);


// --- TEXTURE HANDLING

PRT_EXPORTS_API const AttributeMap* createTextureMetadata(
        const wchar_t* uri,
        Cache*         cache = nullptr,
        Status*        stat = nullptr
);

PRT_EXPORTS_API Status getTexturePixeldata(
        const wchar_t* uri,
        uint8_t*       buffer,
        size_t         bufferSize,
        Cache*         cache = nullptr
);

PRT_EXPORTS_API Status encodeTexture(
        const AttributeMap*    metadata,
        const uint8_t*         pixeldata,
        const wchar_t*         encoderId,
        const AttributeMap*    encoderOptions,
        SimpleOutputCallbacks* soc
);


// --- UTILS

PRT_EXPORTS_API const char* getStatusDescription(Status stat);

PRT_EXPORTS_API Version const* getVersion();


// --- LOGGING

PRT_EXPORTS_API Status  addLogHandler(LogHandler* logHandler);

PRT_EXPORTS_API Status  removeLogHandler(LogHandler* logHandler);

PRT_EXPORTS_API Status  log(const wchar_t* msg, LogLevel level);

PRT_EXPORTS_API Status  setLogLevel(LogLevel level);

PRT_EXPORTS_API LogLevel getLogLevel(Status* status = nullptr);

} /* namespace prt */


#endif /* PRT_API_H_ */