opngcore.h

Go to the documentation of this file.

#ifndef OPNGLIB_OPNGCORE_H
#define OPNGLIB_OPNGCORE_H

#include <limits.h>
#include <stddef.h>
#include "optk/bits.h"


#ifdef __cplusplus
extern "C" {
#endif


/*** Types ***/

typedef struct opng_optimizer /*opaque*/ opng_optimizer_t;

typedef struct opng_image /*opaque*/ opng_image_t;

struct opng_options
{
    /* general options */
    int backup;
    int out;
    int fix;
    int force;
    int no_clobber;
    int no_create;
    int preserve;
    int snip;
    int use_stdin;
    int use_stdout;
    int verbose;

    /* optimization options */
    int interlace;
    int nb, nc, nm, np, nz;
    int optim_level;
    int paranoid;
    optk_bits_t filter_set;
    optk_bits_t zcompr_level_set;
    optk_bits_t zmem_level_set;
    optk_bits_t zstrategy_set;
    int zwindow_bits;
};


/*** Optimizer ***/

opng_optimizer_t *
opng_create_optimizer(void);

int
opng_set_options(opng_optimizer_t *optimizer,
                 const struct opng_options *user_options);

int
opng_optimize_file(opng_optimizer_t *optimizer,
                   const char *in_fname,
                   const char *out_fname,
                   const char *out_dirname);

#if 0  /* not implemented */

int
opng_optimize_image(opng_optimizer_t *optimizer,
                    const opng_image_t image,
                    const char *out_fname);
#endif

void
opng_destroy_optimizer(opng_optimizer_t *optimizer);


/*** Logging ***/

enum
{
    OPNG_MSG_ALL      = 0,
    OPNG_MSG_DEBUG    = 10,
    OPNG_MSG_INFO     = 20,
    OPNG_MSG_WARNING  = 30,
    OPNG_MSG_ERROR    = 40,
    OPNG_MSG_CRITICAL = 50,
    OPNG_MSG_OFF      = (unsigned int)(-1),
    OPNG_MSG_DEFAULT  = OPNG_MSG_OFF
};

enum
{
    OPNG_MSGFMT_RAW     = 0, /* do not format messages, just print them raw */
    OPNG_MSGFMT_UNIX    = 1, /* format messages in Unix-ish style */
    OPNG_MSGFMT_FANCY   = 2, /* format messages in a more eye-catching style */
    OPNG_MSGFMT_DEFAULT = OPNG_MSGFMT_UNIX
};

void
opng_set_logging_name(const char *program_name);

void
opng_set_logging_level(unsigned int level);

void
opng_set_logging_format(int format);

int
opng_flush_logging(unsigned int level);

int
opng_print_message(unsigned int level, const char *fname, const char *message);

int
opng_debugf(const char *format, ...);

int
opng_printf(const char *format, ...);

int
opng_warning(const char *fname, const char *message);

int
opng_error(const char *fname, const char *message, const char *submessage);


/*** PNG encoding ***/

enum
{
    OPNG_OPTIM_LEVEL_MIN       = -2,
    OPNG_OPTIM_LEVEL_MAX       =  6,
    OPNG_OPTIM_LEVEL_FASTEST   = -2,
    OPNG_OPTIM_LEVEL_FAST      = -1,
    OPNG_OPTIM_LEVEL_DEFAULT   =  2,

    OPNG_FILTER_MIN            = 0,
    OPNG_FILTER_MAX            = 5,
    OPNG_FILTER_SET_MASK       = (1 << (5+1)) - (1 << 0)  /* 0x003f */,

    OPNG_ZCOMPR_LEVEL_MIN      = 1,
    OPNG_ZCOMPR_LEVEL_MAX      = 9,
    OPNG_ZCOMPR_LEVEL_SET_MASK = (1 << (9+1)) - (1 << 1)  /* 0x03fe */,

    OPNG_ZMEM_LEVEL_MIN        = 1,
    OPNG_ZMEM_LEVEL_MAX        = 9,
    OPNG_ZMEM_LEVEL_SET_MASK   = (1 << (9+1)) - (1 << 1)  /* 0x03fe */,

    OPNG_ZSTRATEGY_MIN         = 0,
    OPNG_ZSTRATEGY_MAX         = 3,
    OPNG_ZSTRATEGY_SET_MASK    = (1 << (3+1)) - (1 << 0)  /* 0x000f */,

    /* Note:
     * There are no -zw iterations. They appear to offer no advantage over -zc.
     */
    OPNG_ZWINDOW_BITS_MIN      = 8,
    OPNG_ZWINDOW_BITS_MAX      = 15,
    OPNG_ZWINDOW_BITS_SET_MASK = (1 << (15+1)) - (1 << 8) /* 0xff00 */
};


/*** Miscellanea ***/

struct opng_version_info
{
    const char *library_name;
    const char *library_version;
};

const struct opng_version_info *
opng_get_version_info(void);


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


#endif  /* OPNGLIB_OPNGCORE_H */