libaec.h 5.22 KB
Newer Older
1 2 3 4 5 6 7 8 9
/**
 * @file libaec.h
 *
 * @author Mathis Rosenhauer, Deutsches Klimarechenzentrum
 * @author Moritz Hanke, Deutsches Klimarechenzentrum
 * @author Joerg Behrens, Deutsches Klimarechenzentrum
 * @author Luis Kornblueh, Max-Planck-Institut fuer Meteorologie
 *
 * @section LICENSE
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
10
 * Copyright 2012 - 2014
11 12 13 14 15 16 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 50 51 52
 *
 * Mathis Rosenhauer,                 Luis Kornblueh
 * Moritz Hanke,
 * Joerg Behrens
 *
 * Deutsches Klimarechenzentrum GmbH  Max-Planck-Institut fuer Meteorologie
 * Bundesstr. 45a                     Bundesstr. 53
 * 20146 Hamburg                      20146 Hamburg
 * Germany                            Germany
 *
 * 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
 *
 */

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
53
#ifndef LIBAEC_H
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
54
#define LIBAEC_H 1
55

56
#include <stddef.h>
57

58 59
#if _WIN32
#  ifdef AECDLL_EXPORTS
60
#    define AEC_SCOPE __declspec(dllexport)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
61
#  else
62
#    define AEC_SCOPE extern __declspec(dllimport)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
63
#  endif
64 65
#else
#  define AEC_SCOPE extern
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
66 67
#endif

68 69
struct internal_state;

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

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

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

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

    /* 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;
98

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

102
/*********************************/
103
/* Sample data description flags */
104
/*********************************/
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
/* Return codes of library functions */
128 129 130
/*************************************/
#define AEC_OK 0
#define AEC_CONF_ERROR (-1)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
131
#define AEC_STREAM_ERROR (-2)
132 133
#define AEC_DATA_ERROR (-3)
#define AEC_MEM_ERROR (-4)
134

135
/************************/
136
/* Options for flushing */
137 138 139 140 141 142 143 144 145 146 147 148 149
/************************/

/* 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
150

151
/*********************************************/
152
/* Streaming encoding and decoding functions */
153
/*********************************************/
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
154 155 156
AEC_SCOPE int aec_encode_init(struct aec_stream *strm);
AEC_SCOPE int aec_encode(struct aec_stream *strm, int flush);
AEC_SCOPE int aec_encode_end(struct aec_stream *strm);
157

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
158 159 160
AEC_SCOPE int aec_decode_init(struct aec_stream *strm);
AEC_SCOPE int aec_decode(struct aec_stream *strm, int flush);
AEC_SCOPE int aec_decode_end(struct aec_stream *strm);
161

162
/***************************************************************/
163
/* Utility functions for encoding or decoding a memory buffer. */
164
/***************************************************************/
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
165 166
AEC_SCOPE int aec_buffer_encode(struct aec_stream *strm);
AEC_SCOPE int aec_buffer_decode(struct aec_stream *strm);
167

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
168
#endif /* LIBAEC_H */