libaec.h 5.28 KB
Newer Older
1 2 3 4
/**
 * @file libaec.h
 *
 * @section LICENSE
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
5
 * Copyright 2012 - 2019
6
 *
7 8 9 10
 * Mathis Rosenhauer, Moritz Hanke, Joerg Behrens
 * Deutsches Klimarechenzentrum GmbH
 * Bundesstr. 45a
 * 20146 Hamburg Germany
11
 *
12 13 14 15 16
 * Luis Kornblueh
 * Max-Planck-Institut fuer Meteorologie
 * Bundesstr. 53
 * 20146 Hamburg
 * Germany
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided
 *    with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @section DESCRIPTION
 *
 * Adaptive Entropy Coding library
 *
 */

50
#ifndef LIBAEC_H
51
#define LIBAEC_H 1
52

53
#include <stddef.h>
54

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
55 56 57 58
#ifdef __cplusplus
extern "C"{
#endif

59 60 61 62 63 64
#if BUILDING_LIBAEC && HAVE_VISIBILITY
#  define LIBAEC_DLL_EXPORTED __attribute__((__visibility__("default")))
#elif BUILDING_LIBAEC && defined _MSC_VER
#  define LIBAEC_DLL_EXPORTED __declspec(dllexport)
#elif defined _MSC_VER
#  define LIBAEC_DLL_EXPORTED __declspec(dllimport)
65
#else
66
#  define LIBAEC_DLL_EXPORTED
67 68
#endif

69 70
struct internal_state;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
71
struct aec_stream {
72
    const unsigned char *next_in;
73 74 75 76 77 78 79

    /* number of bytes available at next_in */
    size_t avail_in;

    /* total number of input bytes read so far */
    size_t total_in;

80
    unsigned char *next_out;
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98

    /* remaining free space at next_out */
    size_t avail_out;

    /* total number of bytes output so far */
    size_t total_out;

    /* resolution in bits per sample (n = 1, ..., 32) */
    unsigned int bits_per_sample;

    /* block size in samples */
    unsigned int block_size;

    /* Reference sample interval, the number of Coded Data Sets
     * between consecutive reference samples (up to 4096). */
    unsigned int rsi;

    unsigned int flags;
99

100
    struct internal_state *state;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
101
};
102

103
/*********************************/
104
/* Sample data description flags */
105
/*********************************/
106

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
/* Samples are signed. Telling libaec this results in a slightly
 * better compression ratio. Default is unsigned. */
#define AEC_DATA_SIGNED 1

/* 24 bit samples are coded in 3 bytes */
#define AEC_DATA_3BYTE 2

/* Samples are stored with their most significant bit first. This has
 * nothing to do with the endianness of the host. Default is LSB. */
#define AEC_DATA_MSB 4

/* Set if preprocessor should be used */
#define AEC_DATA_PREPROCESS 8

/* Use restricted set of code options */
#define AEC_RESTRICTED 16

/* Pad RSI to byte boundary. Only for decoding CCSDS sample data. */
#define AEC_PAD_RSI 32

127 128 129
/* Do not enforce standard regarding legal block sizes. */
#define AEC_NOT_ENFORCE 64

130
/*************************************/
131
/* Return codes of library functions */
132 133 134
/*************************************/
#define AEC_OK 0
#define AEC_CONF_ERROR (-1)
135
#define AEC_STREAM_ERROR (-2)
136 137
#define AEC_DATA_ERROR (-3)
#define AEC_MEM_ERROR (-4)
138

139
/************************/
140
/* Options for flushing */
141 142 143 144 145 146 147 148 149 150 151 152 153
/************************/

/* Do not enforce output flushing. More input may be provided with
 * later calls. So far only relevant for encoding. */
#define AEC_NO_FLUSH 0

/* Flush output and end encoding. The last call to aec_encode() must
 * set AEC_FLUSH to drain all output.
 *
 * It is not possible to continue encoding of the same stream after it
 * has been flushed because the last byte may be padded with fill
 * bits. */
#define AEC_FLUSH 1
154

155
/*********************************************/
156
/* Streaming encoding and decoding functions */
157
/*********************************************/
158 159 160
LIBAEC_DLL_EXPORTED int aec_encode_init(struct aec_stream *strm);
LIBAEC_DLL_EXPORTED int aec_encode(struct aec_stream *strm, int flush);
LIBAEC_DLL_EXPORTED int aec_encode_end(struct aec_stream *strm);
161

162 163 164
LIBAEC_DLL_EXPORTED int aec_decode_init(struct aec_stream *strm);
LIBAEC_DLL_EXPORTED int aec_decode(struct aec_stream *strm, int flush);
LIBAEC_DLL_EXPORTED int aec_decode_end(struct aec_stream *strm);
165

166
/***************************************************************/
167
/* Utility functions for encoding or decoding a memory buffer. */
168
/***************************************************************/
169 170
LIBAEC_DLL_EXPORTED int aec_buffer_encode(struct aec_stream *strm);
LIBAEC_DLL_EXPORTED int aec_buffer_decode(struct aec_stream *strm);
171

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
172 173 174 175
#ifdef __cplusplus
}
#endif

176
#endif /* LIBAEC_H */