plugin_interface.h

Go to the documentation of this file.

 
#include <plugin/minpf_plugin.h>
#include "grok.h"
#include <cstring>
#include <string>
 
#pragma once
 
namespace grk {
 
// Debug Interface
 
#define DEBUG_CONTEXT_CACHE_SIZE 3
 
// debugging variables
struct grk_plugin_debug_mqc {
        uint32_t debug_state;
        uint8_t context_number;
        uint32_t *contextStream;
        uint32_t contextStreamByteCount;
        uint8_t contextCache[DEBUG_CONTEXT_CACHE_SIZE];
        uint32_t contextCacheCount;
        uint8_t orient;
        uint32_t compno;
        uint32_t level;
};
 
typedef uint32_t (*PLUGIN_GET_DEBUG_STATE)(void);
 
typedef void (*PLUGIN_DEBUG_MQC_NEXT_CXD)(grk_plugin_debug_mqc *mqc, uint32_t d);
 
typedef void (*PLUGIN_DEBUG_MQC_NEXT_PLANE)(grk_plugin_debug_mqc *mqc);
 
// encoder interface
 
struct plugin_encode_user_callback_info {
        const char *input_file_name;
        bool outputFileNameIsRelative;
        const char *output_file_name;
         grk_cparameters  *encoder_parameters;
        grk_image *image;
        grk_plugin_tile *tile;
        int32_t error_code;
};
 
typedef void (*PLUGIN_ENCODE_USER_CALLBACK)(
                plugin_encode_user_callback_info *info);
 
typedef bool (*PLUGIN_INIT)(grk_plugin_init_info initInfo);
 
typedef int32_t (*PLUGIN_ENCODE)( grk_cparameters  *encoding_parameters,
                PLUGIN_ENCODE_USER_CALLBACK callback);
 
typedef int32_t (*PLUGIN_BATCH_ENCODE)(const char *input_dir,
                const char *output_dir,  grk_cparameters  *encoding_parameters,
                PLUGIN_ENCODE_USER_CALLBACK userCallback);
 
typedef void (*PLUGIN_STOP_BATCH_ENCODE)(void);
 
typedef bool (*PLUGIN_IS_BATCH_COMPLETE)(void);
 
// decoder interface
 
struct PluginDecodeCallbackInfo {
        PluginDecodeCallbackInfo() :
                        PluginDecodeCallbackInfo("", "", nullptr, GRK_UNK_FMT, 0) {
        }
        PluginDecodeCallbackInfo(std::string input, std::string output,
                        grk_decompress_parameters *decoderParameters, GRK_SUPPORTED_FILE_FMT format,
                        uint32_t flags) :
                        deviceId(0), init_decoders_func(nullptr), inputFile(input), outputFile(
                                        output), decod_format(format), cod_format(GRK_UNK_FMT), l_stream(
                                        nullptr), l_codec(nullptr), decoder_parameters(
                                        decoderParameters), image(nullptr), plugin_owns_image(
                                        false), tile(nullptr), error_code(0), decode_flags(flags) {
                memset(&header_info, 0, sizeof(header_info));
        }
        size_t deviceId;
        GROK_INIT_DECODERS init_decoders_func;
        std::string inputFile;
        std::string outputFile;
        // input file format 0: J2K, 1: JP2
        GRK_SUPPORTED_FILE_FMT decod_format;
        // output file format 0: PGX, 1: PxM, 2: BMP etc 
        GRK_SUPPORTED_FILE_FMT cod_format;
         grk_stream  *l_stream;
         grk_codec  l_codec;
        grk_decompress_parameters *decoder_parameters;
         grk_header_info  header_info;
        grk_image *image;
        bool plugin_owns_image;
        grk_plugin_tile *tile;
        int32_t error_code;
        uint32_t decode_flags;
};
 
typedef int32_t (*PLUGIN_DECODE_USER_CALLBACK)(PluginDecodeCallbackInfo *info);
 
typedef int32_t (*PLUGIN_DECODE)(grk_decompress_parameters *decoding_parameters,
                PLUGIN_DECODE_USER_CALLBACK userCallback);
 
typedef int32_t (*PLUGIN_INIT_BATCH_DECODE)(const char *input_dir,
                const char *output_dir, grk_decompress_parameters *decoding_parameters,
                PLUGIN_DECODE_USER_CALLBACK userCallback);
 
typedef int32_t (*PLUGIN_BATCH_DECODE)(void);
 
typedef void (*PLUGIN_STOP_BATCH_DECODE)(void);
 
}