decode.h 3.56 KB
Newer Older
1
/**
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
2
 * @file decode.h
3 4
 *
 * @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
 *
 * 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 Decoder
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
47
 * Based on CCSDS documents 121.0-B-2 and 120.0-G-3
48 49 50
 *
 */

51
#ifndef DECODE_H
52
#define DECODE_H 1
53

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
54
#include "config.h"
55
#include <stdint.h>
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
56
#include <stddef.h>
57 58 59

#define M_CONTINUE 1
#define M_EXIT 0
60
#define M_ERROR (-1)
61 62 63

#define MIN(a, b) (((a) < (b))? (a): (b))

64 65
#define SE_TABLE_SIZE 90

66 67
struct aec_stream;

68 69
struct internal_state {
    int (*mode)(struct aec_stream *);
70 71 72 73 74 75 76 77 78 79

    /* option ID */
    int id;

    /* bit length of code option identification key */
    int id_len;

    /* table maps IDs to states */
    int (**id_table)(struct aec_stream *);

80
    void (*flush_output)(struct aec_stream *);
81 82

    /* previous output for post-processing */
Moritz Hanke's avatar
Moritz Hanke committed
83
    int32_t last_out;
84 85

    /* minimum integer for post-processing */
86
    uint32_t xmin;
87 88

    /* maximum integer for post-processing */
89
    uint32_t xmax;
90 91

     /* length of uncompressed input block should be the longest
92
        legal block */
93 94 95 96 97
    uint32_t in_blklen;

    /* length of output block in bytes */
    uint32_t out_blklen;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
98
    uint32_t sample_counter;
99 100 101 102 103 104 105 106

    /* accumulator for currently used bit sequence */
    uint64_t acc;

    /* bit pointer to the next unused bit in accumulator */
    int bitp;

    /* last fundamental sequence in accumulator */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
107
    uint32_t fs;
108 109 110 111

    /* 1 if current block has reference sample */
    int ref;

112 113 114
    /* block_size minus reference sample if present */
    uint32_t encoded_block_size;

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
    /* 1 if postprocessor has to be used */
    int pp;

    /* storage size of samples in bytes */
    uint32_t bytes_per_sample;

    /* output buffer holding one reference sample interval */
    uint32_t *rsi_buffer;

    /* current position of output in rsi_buffer */
    uint32_t *rsip;

    /* rsi in bytes */
    size_t rsi_size;

    /* first not yet flushed byte in rsi_buffer */
    uint32_t *flush_start;

    /* table for decoding second extension option */
134
    int se_table[2 * (SE_TABLE_SIZE + 1)];
135 136 137
} decode_state;

#endif /* DECODE_H */