encode.c 24.5 KB
Newer Older
1
/**
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
2
 * @file encode.c
3
 *
4
 * @author Mathis Rosenhauer, Deutsches Klimarechenzentrum
5 6 7 8 9
 * @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
 *
 * 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.
 *
47 48 49
 * @section DESCRIPTION
 *
 * Adaptive Entropy Encoder
50
 * Based on CCSDS documents 121.0-B-2 and 120.0-G-2
51 52
 *
 */
53

54 55 56 57 58 59
#include <config.h>

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

60 61
#include <stdio.h>
#include <stdlib.h>
62
#include <unistd.h>
63 64
#include <string.h>

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
65 66 67
#include "libaec.h"
#include "encode.h"
#include "encode_accessors.h"
68

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
69 70 71 72
static int m_get_block(struct aec_stream *strm);

static inline void emit(struct internal_state *state,
                        uint32_t data, int bits)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
73
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
74 75 76 77
    /**
       Emit sequence of bits.
     */

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
78 79 80
    if (bits <= state->bits) {
        state->bits -= bits;
        *state->cds += data << state->bits;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
81
    } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
82 83
        bits -= state->bits;
        *state->cds++ += (uint64_t)data >> bits;
84

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
85
        while (bits > 8) {
86
            bits -= 8;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
87
            *state->cds++ = data >> bits;
88
        }
89

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
90 91
        state->bits = 8 - bits;
        *state->cds = data << state->bits;
92
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
93 94
}

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
95
static inline void emitfs(struct internal_state *state, int fs)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
96
{
97 98
    /**
       Emits a fundamental sequence.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
99

100 101
       fs zero bits followed by one 1 bit.
     */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
102

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
103
    for(;;) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
104 105 106
        if (fs < state->bits) {
            state->bits -= fs + 1;
            *state->cds += 1U << state->bits;
107
            break;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
108
        } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
109 110 111
            fs -= state->bits;
            *++state->cds = 0;
            state->bits = 8;
112 113
        }
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
114
}
115

116 117 118 119 120 121 122 123 124 125 126 127
static inline void copy64(uint8_t *dst, uint64_t src)
{
    dst[0] = src >> 56;
    dst[1] = src >> 48;
    dst[2] = src >> 40;
    dst[3] = src >> 32;
    dst[4] = src >> 24;
    dst[5] = src >> 16;
    dst[6] = src >> 8;
    dst[7] = src;
}

128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
static inline void emitblock_fs(struct aec_stream *strm, int k, int ref)
{
    int i;
    int used; /* used bits in 64 bit accumulator */
    uint64_t acc; /* accumulator */
    struct internal_state *state = strm->state;

    acc = (uint64_t)*state->cds << 56;
    used = 7 - state->bits;

    for (i = ref; i < strm->block_size; i++) {
        used += (state->block[i] >> k) + 1;
        if (used > 63) {
            copy64(state->cds, acc);
            state->cds += 8;
            acc = 0;
            used &= 0x3f;
        }
        acc |= 1ULL << (63 - used);
147 148
    }

149 150 151 152
    copy64(state->cds, acc);
    state->cds += used >> 3;
    state->bits = 7 - (used & 7);
}
153

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
static inline void emitblock(struct aec_stream *strm, int k, int ref)
{
    /**
       Emit the k LSB of a whole block of input data.
    */

    uint64_t a;
    struct internal_state *state = strm->state;
    uint32_t *in = state->block + ref;
    uint32_t *in_end = state->block + strm->block_size;
    uint64_t mask = (1ULL << k) - 1;
    uint8_t *o = state->cds;
    int p = state->bits;

    a = *o;

    while(in < in_end) {
        a <<= 56;
        p = (p % 8) + 56;

        while (p > k && in < in_end) {
            p -= k;
            a += ((uint64_t)(*in++) & mask) << p;
        }

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
179
        switch (p & ~7) {
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
        case 0:
            o[0] = a >> 56;
            o[1] = a >> 48;
            o[2] = a >> 40;
            o[3] = a >> 32;
            o[4] = a >> 24;
            o[5] = a >> 16;
            o[6] = a >> 8;
            o += 7;
            break;
        case 8:
            o[0] = a >> 56;
            o[1] = a >> 48;
            o[2] = a >> 40;
            o[3] = a >> 32;
            o[4] = a >> 24;
            o[5] = a >> 16;
            a >>= 8;
            o += 6;
            break;
        case 16:
            o[0] = a >> 56;
            o[1] = a >> 48;
            o[2] = a >> 40;
            o[3] = a >> 32;
            o[4] = a >> 24;
            a >>= 16;
            o += 5;
            break;
        case 24:
            o[0] = a >> 56;
            o[1] = a >> 48;
            o[2] = a >> 40;
            o[3] = a >> 32;
            a >>= 24;
            o += 4;
            break;
        case 32:
            o[0] = a >> 56;
            o[1] = a >> 48;
            o[2] = a >> 40;
            a >>= 32;
            o += 3;
            break;
        case 40:
            o[0] = a >> 56;
            o[1] = a >> 48;
            a >>= 40;
            o += 2;
            break;
        case 48:
            *o++ = a >> 56;
            a >>= 48;
            break;
        default:
            a >>= 56;
            break;
        }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
238 239
    }

240 241 242 243
    *o = a;
    state->cds = o;
    state->bits = p % 8;
}
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
244

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
245
static void preprocess_unsigned(struct aec_stream *strm)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
246
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
247 248
    /**
       Preprocess RSI of unsigned samples.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
249 250 251

       Combining preprocessing and converting to uint32_t in one loop
       is slower due to the data dependance on x_i-1.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
252 253
    */

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
254
    uint32_t D;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
255
    struct internal_state *state = strm->state;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
256 257
    const uint32_t *restrict x = state->data_raw;
    uint32_t *restrict d = state->data_pp;
258 259
    uint32_t xmax = state->xmax;
    uint32_t rsi = strm->rsi * strm->block_size - 1;
260
    int i;
261

262 263
    d[0] = x[0];
    for (i = 0; i < rsi; i++) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
264 265
        if (x[i + 1] >= x[i]) {
            D = x[i + 1] - x[i];
266
            if (D <= x[i])
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
267
                d[i + 1] = 2 * D;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
268
            else
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
269
                d[i + 1] = x[i + 1];
270
        } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
271
            D = x[i] - x[i + 1];
272
            if (D <= xmax - x[i])
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
273
                d[i + 1] = 2 * D - 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
274
            else
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
275
                d[i + 1] = xmax - x[i + 1];
276
        }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
277
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
278
    state->ref = 1;
279
    state->uncomp_len = (strm->block_size - 1) * strm->bits_per_sample;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
280 281
}

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
282
static void preprocess_signed(struct aec_stream *strm)
283
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
284 285 286 287
    /**
       Preprocess RSI of signed samples.
    */

288
    int64_t D;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
289
    struct internal_state *state = strm->state;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
290 291
    uint32_t *restrict d = state->data_pp;
    int32_t *restrict x = (int32_t *)state->data_raw;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
292
    uint64_t m = 1ULL << (strm->bits_per_sample - 1);
293 294 295
    int64_t xmax = state->xmax;
    int64_t xmin = state->xmin;
    uint32_t rsi = strm->rsi * strm->block_size - 1;
296
    int i;
297

298
    d[0] = (uint32_t)x[0];
299 300
    x[0] = (x[0] ^ m) - m;

301
    for (i = 0; i < rsi; i++) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
302 303 304
        x[i + 1] = (x[i + 1] ^ m) - m;
        if (x[i + 1] < x[i]) {
            D = (int64_t)x[i] - x[i + 1];
305 306
            if (D <= xmax - x[i])
                d[i + 1] = 2 * D - 1;
307
            else
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
308
                d[i + 1] = xmax - x[i + 1];
309
        } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
310
            D = (int64_t)x[i + 1] - x[i];
311 312
            if (D <= x[i] - xmin)
                d[i + 1] = 2 * D;
313
            else
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
314
                d[i + 1] = x[i + 1] - xmin;
315
        }
316
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
317
    state->ref = 1;
318
    state->uncomp_len = (strm->block_size - 1) * strm->bits_per_sample;
319
}
320

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
321
static inline uint64_t block_fs(struct aec_stream *strm, int k)
322 323 324 325 326 327 328 329 330
{
    /**
       Sum FS of all samples in block for given splitting position.
    */

    int i;
    uint64_t fs = 0;
    struct internal_state *state = strm->state;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
331 332
    for (i = 0; i < strm->block_size; i++)
        fs += (uint64_t)(state->block[i] >> k);
333 334 335 336 337 338 339

    if (state->ref)
        fs -= (uint64_t)(state->block[0] >> k);

    return fs;
}

340
static uint32_t assess_splitting_option(struct aec_stream *strm)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
341 342 343 344 345
{
    /**
       Length of CDS encoded with splitting option and optimal k.

       In Rice coding each sample in a block of samples is split at
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
346
       the same position into k LSB and bits_per_sample - k MSB. The
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
       LSB part is left binary and the MSB part is coded as a
       fundamental sequence a.k.a. unary (see CCSDS 121.0-B-2). The
       function of the length of the Coded Data Set (CDS) depending on
       k has exactly one minimum (see A. Kiely, IPN Progress Report
       42-159).

       To find that minimum with only a few costly evaluations of the
       CDS length, we start with the k of the previous CDS. K is
       increased and the CDS length evaluated. If the CDS length gets
       smaller, then we are moving towards the minimum. If the length
       increases, then the minimum will be found with smaller k.

       For increasing k we know that we will gain block_size bits in
       length through the larger binary part. If the FS lenth is less
       than the block size then a reduced FS part can't compensate the
       larger binary part. So we know that the CDS for k+1 will be
       larger than for k without actually computing the length. An
       analogue check can be done for decreasing k.
     */

367
    int k;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
368 369 370 371 372 373 374 375 376 377 378 379 380
    int k_min;
    int this_bs; /* Block size of current block */
    int no_turn; /* 1 if we shouldn't reverse */
    int dir; /* Direction, 1 means increasing k, 0 decreasing k */
    uint64_t len; /* CDS length for current k */
    uint64_t len_min; /* CDS length minimum so far */
    uint64_t fs_len; /* Length of FS part (not including 1s) */

    struct internal_state *state = strm->state;

    this_bs = strm->block_size - state->ref;
    len_min = UINT64_MAX;
    k = k_min = state->k;
381
    no_turn = k == 0;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
382 383 384
    dir = 1;

    for (;;) {
385
        fs_len = block_fs(strm, k);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
        len = fs_len + this_bs * (k + 1);

        if (len < len_min) {
            if (len_min < UINT64_MAX)
                no_turn = 1;

            len_min = len;
            k_min = k;

            if (dir) {
                if (fs_len < this_bs || k >= state->kmax) {
                    if (no_turn)
                        break;
                    k = state->k - 1;
                    dir = 0;
                    no_turn = 1;
                } else {
                    k++;
                }
            } else {
                if (fs_len >= this_bs || k == 0)
                    break;
                k--;
            }
        } else {
            if (no_turn)
                break;
            k = state->k - 1;
            dir = 0;
            no_turn = 1;
        }
    }
    state->k = k_min;

    return len_min;
}

423
static uint32_t assess_se_option(struct aec_stream *strm)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
424 425 426 427
{
    /**
       Length of CDS encoded with Second Extension option.

428
       If length is above limit just return UINT32_MAX.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
429 430 431 432
    */

    int i;
    uint64_t d;
433
    uint32_t len;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
434 435 436 437 438 439 440 441
    struct internal_state *state = strm->state;

    len = 1;

    for (i = 0; i < strm->block_size; i+= 2) {
        d = (uint64_t)state->block[i]
            + (uint64_t)state->block[i + 1];
        /* we have to worry about overflow here */
442 443
        if (d > state->uncomp_len) {
            len = UINT32_MAX;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
444 445
            break;
        } else {
446
            len += d * (d + 1) / 2 + state->block[i + 1];
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
447 448 449 450 451
        }
    }
    return len;
}

452 453 454 455 456 457 458 459 460
static void init_output(struct aec_stream *strm)
{
    /**
       Direct output to next_out if next_out can hold a Coded Data
       Set, use internal buffer otherwise.
    */

    struct internal_state *state = strm->state;

461
    if (strm->avail_out > CDSLEN) {
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
        if (!state->direct_out) {
            state->direct_out = 1;
            *strm->next_out = *state->cds;
            state->cds = strm->next_out;
        }
    } else {
        if (state->zero_blocks == 0 || state->direct_out) {
            /* copy leftover from last block */
            *state->cds_buf = *state->cds;
            state->cds = state->cds_buf;
        }
        state->direct_out = 0;
    }
}

477 478 479 480 481 482
/*
 *
 * FSM functions
 *
 */

483
static int m_flush_block_resumable(struct aec_stream *strm)
484
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
485
    /**
486
       Slow and restartable flushing
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
487
    */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
488
    struct internal_state *state = strm->state;
489

490 491 492 493 494 495 496 497 498 499 500
    int n = MIN(state->cds - state->cds_buf - state->i, strm->avail_out);
    memcpy(strm->next_out, state->cds_buf + state->i, n);
    strm->next_out += n;
    strm->avail_out -= n;
    state->i += n;

    if (strm->avail_out == 0) {
        return M_EXIT;
    } else {
        state->mode = m_get_block;
        return M_CONTINUE;
501 502 503
    }
}

504
static int m_flush_block(struct aec_stream *strm)
505
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
506
    /**
507
       Flush block in direct_out mode by updating counters.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
508

509
       Fall back to slow flushing if in buffered mode.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
510
    */
511
    int n;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
512
    struct internal_state *state = strm->state;
513

514 515 516 517 518 519
    if (state->blocks_avail == 0
        && strm->flags & AEC_PAD_RSI
        && state->block_nonzero == 0
        )
        emit(state, 0, state->bits % 8);

520 521 522 523
    if (state->direct_out) {
        n = state->cds - strm->next_out;
        strm->next_out += n;
        strm->avail_out -= n;
524 525
        state->mode = m_get_block;
        return M_CONTINUE;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
526
    }
527

528 529 530
    state->i = 0;
    state->mode = m_flush_block_resumable;
    return M_CONTINUE;
531
}
532

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
533
static int m_encode_splitting(struct aec_stream *strm)
534
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
535
    struct internal_state *state = strm->state;
536
    int k = state->k;
537

538
    emit(state, k + 1, state->id_len);
539

540
    if (state->ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
541
        emit(state, state->block[0], strm->bits_per_sample);
542 543 544 545

    emitblock_fs(strm, k, state->ref);
    if (k)
        emitblock(strm, k, state->ref);
546

547 548
    return m_flush_block(strm);
}
549

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
550
static int m_encode_uncomp(struct aec_stream *strm)
551
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
552
    struct internal_state *state = strm->state;
553

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
554
    emit(state, (1U << state->id_len) - 1, state->id_len);
555
    emitblock(strm, strm->bits_per_sample, 0);
556

557 558
    return m_flush_block(strm);
}
559

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
560
static int m_encode_se(struct aec_stream *strm)
561 562
{
    int i;
563
    uint32_t d;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
564
    struct internal_state *state = strm->state;
565

566 567
    emit(state, 1, state->id_len + 1);
    if (state->ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
568
        emit(state, state->block[0], strm->bits_per_sample);
569

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
570
    for (i = 0; i < strm->block_size; i+= 2) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
571 572
        d = state->block[i] + state->block[i + 1];
        emitfs(state, d * (d + 1) / 2 + state->block[i + 1]);
573
    }
574

575 576
    return m_flush_block(strm);
}
577

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
578
static int m_encode_zero(struct aec_stream *strm)
579
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
580
    struct internal_state *state = strm->state;
581

582
    emit(state, 0, state->id_len + 1);
583

584
    if (state->zero_ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
585
        emit(state, state->zero_ref_sample, strm->bits_per_sample);
586

587 588 589 590 591 592
    if (state->zero_blocks == ROS)
        emitfs(state, 4);
    else if (state->zero_blocks >= 5)
        emitfs(state, state->zero_blocks);
    else
        emitfs(state, state->zero_blocks - 1);
593

594 595 596
    state->zero_blocks = 0;
    return m_flush_block(strm);
}
597

598
static int m_select_code_option(struct aec_stream *strm)
599
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
600
    /**
601 602
       Decide which code option to use.
    */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
603

604 605
    uint32_t split_len;
    uint32_t se_len;
606 607 608
    struct internal_state *state = strm->state;

    split_len = assess_splitting_option(strm);
609
    se_len = assess_se_option(strm);
610

611
    if (split_len < state->uncomp_len) {
612 613 614 615 616
        if (split_len < se_len)
            return m_encode_splitting(strm);
        else
            return m_encode_se(strm);
    } else {
617
        if (state->uncomp_len <= se_len)
618 619 620 621 622 623 624 625 626 627 628 629 630
            return m_encode_uncomp(strm);
        else
            return m_encode_se(strm);
    }
}

static int m_check_zero_block(struct aec_stream *strm)
{
    /**
       Check if input block is all zero.

       Aggregate consecutive zero blocks until we find !0 or reach the
       end of a segment or RSI.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
631
    */
632

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
633
    int i;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
634
    struct internal_state *state = strm->state;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
635
    uint32_t *p = state->block;
636

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
637 638 639
    for (i = state->ref; i < strm->block_size; i++)
        if (p[i] != 0)
            break;
640

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
641
    if (i < strm->block_size) {
642 643 644
        if (state->zero_blocks) {
            /* The current block isn't zero but we have to emit a
             * previous zero block first. The current block will be
645
             * flagged and handled later.
646
             */
647
            state->block_nonzero = 1;
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
            state->mode = m_encode_zero;
            return M_CONTINUE;
        }
        state->mode = m_select_code_option;
        return M_CONTINUE;
    } else {
        state->zero_blocks++;
        if (state->zero_blocks == 1) {
            state->zero_ref = state->ref;
            state->zero_ref_sample = state->block[0];
        }
        if (state->blocks_avail == 0
            || (strm->rsi - state->blocks_avail) % 64 == 0) {
            if (state->zero_blocks > 4)
                state->zero_blocks = ROS;
            state->mode = m_encode_zero;
            return M_CONTINUE;
        }
666 667 668
        state->mode = m_get_block;
        return M_CONTINUE;
    }
669
}
670

671 672 673 674 675 676 677 678 679 680 681 682
static int m_get_rsi_resumable(struct aec_stream *strm)
{
    /**
       Get RSI while input buffer is short.

       Let user provide more input. Once we got all input pad buffer
       to full RSI.
    */

    struct internal_state *state = strm->state;

    do {
683
        if (strm->avail_in >= state->bytes_per_sample) {
684 685 686 687
            state->data_raw[state->i] = state->get_sample(strm);
        } else {
            if (state->flush == AEC_FLUSH) {
                if (state->i > 0) {
688 689 690 691
                    do
                        state->data_raw[state->i] =
                            state->data_raw[state->i - 1];
                    while(++state->i < strm->rsi * strm->block_size);
692 693
                } else {
                    emit(state, 0, state->bits);
694
                    if (strm->avail_out > 0) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
695
                        if (!state->direct_out)
696 697 698
                            *strm->next_out++ = *state->cds;
                        strm->avail_out--;
                    }
699 700 701 702 703 704 705 706
                    return M_EXIT;
                }
            } else {
                return M_EXIT;
            }
        }
    } while (++state->i < strm->rsi * strm->block_size);

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
707
    if (strm->flags & AEC_DATA_PREPROCESS)
708 709 710
        state->preprocess(strm);

    return m_check_zero_block(strm);
711 712
}

713
static int m_get_block(struct aec_stream *strm)
714
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
715
    /**
716 717 718 719
       Provide the next block of preprocessed input data.

       Pull in a whole Reference Sample Interval (RSI) of data if
       block buffer is empty.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
720
    */
721

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
722
    struct internal_state *state = strm->state;
723

724 725 726 727 728 729
    init_output(strm);

    if (state->block_nonzero) {
        state->block_nonzero = 0;
        state->mode = m_select_code_option;
        return M_CONTINUE;
730
    }
731

732
    if (state->blocks_avail == 0) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
733
        state->blocks_avail = strm->rsi - 1;
734 735
        state->block = state->data_pp;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
736
        if (strm->avail_in >= state->rsi_len) {
737
            state->get_rsi(strm);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
738
            if (strm->flags & AEC_DATA_PREPROCESS)
739
                state->preprocess(strm);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
740

741 742 743 744 745 746
            return m_check_zero_block(strm);
        } else {
            state->i = 0;
            state->mode = m_get_rsi_resumable;
        }
    } else {
747 748 749 750
        if (state->ref) {
            state->ref = 0;
            state->uncomp_len = strm->block_size * strm->bits_per_sample;
        }
751 752 753
        state->block += strm->block_size;
        state->blocks_avail--;
        return m_check_zero_block(strm);
754 755 756 757 758 759 760 761 762
    }
    return M_CONTINUE;
}

/*
 *
 * API functions
 *
 */
763

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
764
int aec_encode_init(struct aec_stream *strm)
765
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
766
    struct internal_state *state;
767

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
768
    if (strm->bits_per_sample > 32 || strm->bits_per_sample == 0)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
769
        return AEC_CONF_ERROR;
770 771 772 773 774

    if (strm->block_size != 8
        && strm->block_size != 16
        && strm->block_size != 32
        && strm->block_size != 64)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
775
        return AEC_CONF_ERROR;
776 777

    if (strm->rsi > 4096)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
778
        return AEC_CONF_ERROR;
779

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
780
    state = malloc(sizeof(struct internal_state));
781
    if (state == NULL)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
782
        return AEC_MEM_ERROR;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
783 784

    memset(state, 0, sizeof(struct internal_state));
785 786
    strm->state = state;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
787
    if (strm->bits_per_sample > 16) {
788
        /* 24/32 input bit settings */
789 790
        state->id_len = 5;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
791
        if (strm->bits_per_sample <= 24
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
792
            && strm->flags & AEC_DATA_3BYTE) {
793
            state->bytes_per_sample = 3;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
794
            if (strm->flags & AEC_DATA_MSB) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
795 796
                state->get_sample = aec_get_msb_24;
                state->get_rsi = aec_get_rsi_msb_24;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
797
            } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
798 799
                state->get_sample = aec_get_lsb_24;
                state->get_rsi = aec_get_rsi_lsb_24;
800
            }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
801
        } else {
802
            state->bytes_per_sample = 4;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
803
            if (strm->flags & AEC_DATA_MSB) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
804 805
                state->get_sample = aec_get_msb_32;
                state->get_rsi = aec_get_rsi_msb_32;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
806
            } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
807 808
                state->get_sample = aec_get_lsb_32;
                state->get_rsi = aec_get_rsi_lsb_32;
809 810
            }
        }
811
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
812
    else if (strm->bits_per_sample > 8) {
813 814
        /* 16 bit settings */
        state->id_len = 4;
815
        state->bytes_per_sample = 2;
816

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
817
        if (strm->flags & AEC_DATA_MSB) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
818 819
            state->get_sample = aec_get_msb_16;
            state->get_rsi = aec_get_rsi_msb_16;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
820
        } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
821 822
            state->get_sample = aec_get_lsb_16;
            state->get_rsi = aec_get_rsi_lsb_16;
823
        }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
824
    } else {
825
        /* 8 bit settings */
826
        if (strm->flags & AEC_RESTRICTED) {
827 828 829 830 831 832 833 834 835 836 837
            if (strm->bits_per_sample <= 4) {
                if (strm->bits_per_sample <= 2)
                    state->id_len = 1;
                else
                    state->id_len = 2;
            } else {
                return AEC_CONF_ERROR;
            }
        } else {
            state->id_len = 3;
        }
838
        state->bytes_per_sample = 1;
839

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
840 841
        state->get_sample = aec_get_8;
        state->get_rsi = aec_get_rsi_8;
842
    }
843
    state->rsi_len = strm->rsi * strm->block_size * state->bytes_per_sample;
844

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
845
    if (strm->flags & AEC_DATA_SIGNED) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
846 847
        state->xmin = -(1ULL << (strm->bits_per_sample - 1));
        state->xmax = (1ULL << (strm->bits_per_sample - 1)) - 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
848
        state->preprocess = preprocess_signed;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
849
    } else {
850
        state->xmin = 0;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
851
        state->xmax = (1ULL << strm->bits_per_sample) - 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
852
        state->preprocess = preprocess_unsigned;
853 854
    }

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
855 856
    state->kmax = (1U << state->id_len) - 3;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
857 858 859
    state->data_pp = malloc(strm->rsi
                            * strm->block_size
                            * sizeof(uint32_t));
860
    if (state->data_pp == NULL)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
861
        return AEC_MEM_ERROR;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
862

863
    if (strm->flags & AEC_DATA_PREPROCESS) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
864 865 866
        state->data_raw = malloc(strm->rsi
                                 * strm->block_size
                                 * sizeof(uint32_t));
867 868 869 870 871 872
        if (state->data_raw == NULL)
            return AEC_MEM_ERROR;
    } else {
        state->data_raw = state->data_pp;
    }

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
873
    state->block = state->data_pp;
874 875 876 877

    strm->total_in = 0;
    strm->total_out = 0;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
878 879 880
    state->cds = state->cds_buf;
    *state->cds = 0;
    state->bits = 8;
881 882
    state->mode = m_get_block;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
883
    return AEC_OK;
884 885
}

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
886
int aec_encode(struct aec_stream *strm, int flush)
887 888 889 890 891
{
    /**
       Finite-state machine implementation of the adaptive entropy
       encoder.
    */
892
    int n;
893 894
    struct internal_state *state = strm->state;

895
    state->flush = flush;
896 897
    strm->total_in += strm->avail_in;
    strm->total_out += strm->avail_out;
898 899 900

    while (state->mode(strm) == M_CONTINUE);

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
901
    if (state->direct_out) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
902
        n = state->cds - strm->next_out;
903 904 905
        strm->next_out += n;
        strm->avail_out -= n;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
906 907
        *state->cds_buf = *state->cds;
        state->cds = state->cds_buf;
908
        state->direct_out = 0;
909
    }
910 911
    strm->total_in -= strm->avail_in;
    strm->total_out -= strm->avail_out;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
912
    return AEC_OK;
913 914
}

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
915
int aec_encode_end(struct aec_stream *strm)
916
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
917
    struct internal_state *state = strm->state;
918

919 920 921
    if (strm->flags & AEC_DATA_PREPROCESS)
        free(state->data_raw);
    free(state->data_pp);
922
    free(state);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
923
    return AEC_OK;
924
}
925

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
926
int aec_buffer_encode(struct aec_stream *strm)
927 928 929 930 931 932 933
{
    int status;

    status = aec_encode_init(strm);
    if (status != AEC_OK)
        return status;
    status = aec_encode(strm, AEC_FLUSH);
934
    if (strm->avail_in > 0)
935 936 937 938 939
        status = AEC_DATA_ERROR;

    aec_encode_end(strm);
    return status;
}