encode.h 4.38 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 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 53
/**
 * @file encode.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
 * Copyright 2012
 *
 * 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 Encoder
 * Based on CCSDS documents 121.0-B-2 and 120.0-G-2
 *
 */

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
54 55
#ifndef ENCODE_H
#define ENCODE_H
56

57 58 59 60 61 62
#include <config.h>

#if HAVE_STDINT_H
# include <stdint.h>
#endif

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
63
#include "libaec.h"
64 65 66

#define M_CONTINUE 1
#define M_EXIT 0
67
#define MIN(a, b) (((a) < (b))? (a): (b))
68

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
69 70 71
struct internal_state {
    int (*mode)(struct aec_stream *);
    uint32_t (*get_sample)(struct aec_stream *);
72
    void (*get_rsi)(struct aec_stream *);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
73
    void (*preprocess)(struct aec_stream *);
74 75 76 77

    int id_len;             /* bit length of code option identification key */
    int64_t xmin;           /* minimum integer for preprocessing */
    int64_t xmax;           /* maximum integer for preprocessing */
78
    int i;                  /* counter */
79 80
    uint32_t *data_pp;      /* RSI blocks of preprocessed input */
    uint32_t *data_raw;     /* RSI blocks of input */
81
    int blocks_avail;       /* remaining blocks in buffer */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
82
    uint32_t *block;        /* current (preprocessed) input block */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
83
    int rsi_len;            /* reference sample interval in byte */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
84 85 86
    uint8_t *cds;           /* current Coded Data Set output */
    uint8_t *cds_buf;       /* buffer for one CDS (only used if
                             * strm->next_out cannot hold full CDS) */
87
    int cds_len;            /* max cds length in byte */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
88
    int direct_out;         /* cds points to strm->next_out (1)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
89
                             * or cds_buf (0) */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
90
    int bits;               /* Free bits (LSB) in output buffer or
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
91 92 93 94 95
                             * accumulator */
    int ref;                /* length of reference sample in current
                             * block i.e. 0 or 1 depending on whether
                             * the block has a reference sample or
                             * not */
96
    int zero_ref;           /* current zero block has a reference sample */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
97
    uint32_t zero_ref_sample;/* reference sample of zero block */
98
    int bytes_per_sample;   /* storage size of samples in bytes */
99
    int zero_blocks;        /* number of contiguous zero blocks */
100 101
    int block_nonzero;      /* 1 if this is the first non-zero block
                             * after one or more zero blocks */
102
    int k;                  /* splitting position */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
103
    int kmax;               /* maximum number for k depending on id_len */
104
    int flush;              /* flush option copied from argument */
105
    uint32_t uncomp_len;    /* length of uncompressed CDS */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
106
};
107

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
108
#endif /* ENCODE_H */