encode.c 26.3 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 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
 * @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.
 *
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

69
/* Marker for Remainder Of Segment condition in zero block encoding */
70
#define ROS -1
71

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
72 73 74 75
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
76
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
77 78 79 80
    /**
       Emit sequence of bits.
     */

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
88
        while (bits & ~7) {
89
            bits -= 8;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
90
            *state->cds++ = data >> bits;
91
        }
92

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
93 94
        state->bits = 8 - bits;
        *state->cds = data << state->bits;
95
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
96 97
}

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

103 104
       fs zero bits followed by one 1 bit.
     */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
105

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

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
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;
}

#define EMITBLOCK_FS(ref)                                           \
    static inline void emitblock_fs_##ref(struct aec_stream *strm,  \
                                          int k)                    \
    {                                                               \
        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);                             \
        }                                                           \
                                                                    \
        copy64(state->cds, acc);                                    \
        state->cds += used >> 3;                                    \
        state->bits = 7 - (used & 7);                               \
    }

EMITBLOCK_FS(0);
EMITBLOCK_FS(1);

#define EMITBLOCK(ref)                                              \
    static inline void emitblock_##ref(struct aec_stream *strm,     \
                                       int k)                       \
    {                                                               \
        /**                                                         \
           Emit the k LSB of a whole block of input data.           \
        */                                                          \
                                                                    \
        int b;                                                      \
        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;               \
            }                                                       \
                                                                    \
            for (b = 56; b > (p & ~7); b -= 8)                      \
                *o++ = a >> b;                                      \
            a >>= b;                                                \
        }                                                           \
                                                                    \
        *o = a;                                                     \
        state->cds = o;                                             \
        state->bits = p % 8;                                        \
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
198 199 200 201 202
    }

EMITBLOCK(0);
EMITBLOCK(1);

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
203
static void preprocess_unsigned(struct aec_stream *strm)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
204
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
205 206 207 208
    /**
       Preprocess RSI of unsigned samples.
    */

209
    int64_t D;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
210
    struct internal_state *state = strm->state;
211 212
    const uint32_t *x = state->data_raw;
    uint32_t *d = state->data_pp;
213 214
    uint32_t xmax = state->xmax;
    uint32_t rsi = strm->rsi * strm->block_size - 1;
215

216
    *d++ = x[0];
217
    while (rsi--) {
218 219 220 221
        if (x[1] >= x[0]) {
            D = x[1] - x[0];
            if (D <= x[0]) {
                *d = 2 * D;
222
            } else {
223
                *d = x[1];
224
            }
225
        } else {
226 227 228
            D = x[0] - x[1];
            if (D <= xmax - x[0]) {
                *d = 2 * D - 1;
229
            } else {
230
                *d = xmax - x[1];
231
            }
232
        }
233
        d++;
234
        x++;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
235 236 237
    }
}

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
238
static void preprocess_signed(struct aec_stream *strm)
239
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
240 241 242 243
    /**
       Preprocess RSI of signed samples.
    */

244
    int64_t D;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
245
    struct internal_state *state = strm->state;
246 247
    uint32_t *d = state->data_pp;
    int32_t *x = (int32_t *)state->data_raw;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
248
    uint64_t m = 1ULL << (strm->bits_per_sample - 1);
249 250 251
    int64_t xmax = state->xmax;
    int64_t xmin = state->xmin;
    uint32_t rsi = strm->rsi * strm->block_size - 1;
252

253 254 255
    *d++ = (uint32_t)x[0];
    x[0] = (x[0] ^ m) - m;

256
    while (rsi--) {
257 258 259 260 261
        x[1] = (x[1] ^ m) - m;
        if (x[1] < x[0]) {
            D = (int64_t)x[0] - x[1];
            if (D <= xmax - x[0])
                *d = 2 * D - 1;
262
            else
263
                *d = xmax - x[1];
264
        } else {
265 266 267
            D = (int64_t)x[1] - x[0];
            if (D <= x[0] - xmin)
                *d = 2 * D;
268
            else
269
                *d = x[1] - xmin;
270
        }
271 272
        x++;
        d++;
273
    }
274
}
275

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
static uint64_t block_fs(struct aec_stream *strm, int k)
{
    /**
       Sum FS of all samples in block for given splitting position.
    */

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

    fs = (uint64_t)(state->block[1] >> k)
        + (uint64_t)(state->block[2] >> k)
        + (uint64_t)(state->block[3] >> k)
        + (uint64_t)(state->block[4] >> k)
        + (uint64_t)(state->block[5] >> k)
        + (uint64_t)(state->block[6] >> k)
        + (uint64_t)(state->block[7] >> k);

    if (strm->block_size > 8)
        for (j = 8; j < strm->block_size; j += 8)
            fs +=
                (uint64_t)(state->block[j + 0] >> k)
                + (uint64_t)(state->block[j + 1] >> k)
                + (uint64_t)(state->block[j + 2] >> k)
                + (uint64_t)(state->block[j + 3] >> k)
                + (uint64_t)(state->block[j + 4] >> k)
                + (uint64_t)(state->block[j + 5] >> k)
                + (uint64_t)(state->block[j + 6] >> k)
                + (uint64_t)(state->block[j + 7] >> k);

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

    return fs;
}

static int assess_splitting_option(struct aec_stream *strm)
{
    /**
       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
318
       the same position into k LSB and bits_per_sample - k MSB. The
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 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 423 424
       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.
     */

    int k;
    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;
    no_turn = (k == 0) ? 1 : 0;
    dir = 1;

    for (;;) {
        fs_len = block_fs(strm, k);
        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;
}

static int assess_se_option(uint64_t limit, struct aec_stream *strm)
{
    /**
       Length of CDS encoded with Second Extension option.

       If length is above limit just return UINT64_MAX.
    */

    int i;
    uint64_t d;
    uint64_t len;
    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 */
        if (d > limit) {
            len = UINT64_MAX;
            break;
        } else {
            len += d * (d + 1) / 2
                + (uint64_t)state->block[i + 1];
        }
    }
    return len;
}

425 426 427 428 429 430
/*
 *
 * FSM functions
 *
 */

431
static int m_flush_block_resumable(struct aec_stream *strm)
432
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
433
    /**
434
       Slow and restartable flushing
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
435
    */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
436
    struct internal_state *state = strm->state;
437

438 439 440
    while(state->cds_buf + state->i < state->cds) {
        if (strm->avail_out == 0)
            return M_EXIT;
441

442 443 444 445
        *strm->next_out++ = state->cds_buf[state->i];
        strm->avail_out--;
        strm->total_out++;
        state->i++;
446
    }
447
    state->mode = m_get_block;
448
    return M_CONTINUE;
449 450
}

451
static int m_flush_block(struct aec_stream *strm)
452
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
453
    /**
454
       Flush block in direct_out mode by updating counters.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
455

456
       Fall back to slow flushing if in buffered mode.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
457
    */
458
    int n;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
459
    struct internal_state *state = strm->state;
460

461 462 463 464 465
    if (state->direct_out) {
        n = state->cds - strm->next_out;
        strm->next_out += n;
        strm->avail_out -= n;
        strm->total_out += n;
466 467
        state->mode = m_get_block;
        return M_CONTINUE;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
468
    }
469

470 471 472
    state->i = 0;
    state->mode = m_flush_block_resumable;
    return M_CONTINUE;
473
}
474

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
475
static int m_encode_splitting(struct aec_stream *strm)
476
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
477
    struct internal_state *state = strm->state;
478
    int k = state->k;
479

480
    emit(state, k + 1, state->id_len);
481

482
    if (state->ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
483
    {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
484
        emit(state, state->block[0], strm->bits_per_sample);
485
        emitblock_fs_1(strm, k);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
486 487
        if (k)
            emitblock_1(strm, k);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
488 489 490
    }
    else
    {
491
        emitblock_fs_0(strm, k);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
492 493
        if (k)
            emitblock_0(strm, k);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
494
    }
495

496 497
    return m_flush_block(strm);
}
498

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
499
static int m_encode_uncomp(struct aec_stream *strm)
500
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
501
    struct internal_state *state = strm->state;
502

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
503
    emit(state, (1U << state->id_len) - 1, state->id_len);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
504
    emitblock_0(strm, strm->bits_per_sample);
505

506 507
    return m_flush_block(strm);
}
508

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
509
static int m_encode_se(struct aec_stream *strm)
510 511
{
    int i;
512
    uint32_t d;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
513
    struct internal_state *state = strm->state;
514

515 516
    emit(state, 1, state->id_len + 1);
    if (state->ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
517
        emit(state, state->block[0], strm->bits_per_sample);
518

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
519
    for (i = 0; i < strm->block_size; i+= 2) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
520 521
        d = state->block[i] + state->block[i + 1];
        emitfs(state, d * (d + 1) / 2 + state->block[i + 1]);
522
    }
523

524 525
    return m_flush_block(strm);
}
526

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
527
static int m_encode_zero(struct aec_stream *strm)
528
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
529
    struct internal_state *state = strm->state;
530

531
    emit(state, 0, state->id_len + 1);
532

533
    if (state->zero_ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
534
        emit(state, state->zero_ref_sample, strm->bits_per_sample);
535

536 537 538 539 540 541
    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);
542

543 544 545
    state->zero_blocks = 0;
    return m_flush_block(strm);
}
546

547
static int m_select_code_option(struct aec_stream *strm)
548
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
549
    /**
550 551
       Decide which code option to use.
    */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
552

553 554 555 556 557 558
    uint64_t uncomp_len;
    uint64_t split_len;
    uint64_t se_len;
    struct internal_state *state = strm->state;

    uncomp_len = (strm->block_size - state->ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
559
        * strm->bits_per_sample;
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
    split_len = assess_splitting_option(strm);
    se_len = assess_se_option(split_len, strm);

    if (split_len < uncomp_len) {
        if (split_len < se_len)
            return m_encode_splitting(strm);
        else
            return m_encode_se(strm);
    } else {
        if (uncomp_len <= se_len)
            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
583
    */
584

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
585
    struct internal_state *state = strm->state;
586 587
    uint32_t *p = state->block + state->ref;
    uint32_t *end = state->block + strm->block_size;
588

589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
    while(p < end && *p == 0)
        p++;

    if (p < end) {
        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
             * handled later.
             */
            state->block -= strm->block_size;
            state->blocks_avail++;
            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;
        }
618 619 620
        state->mode = m_get_block;
        return M_CONTINUE;
    }
621
}
622

623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
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.
    */

    int j;
    struct internal_state *state = strm->state;

    do {
        if (strm->avail_in > 0) {
            state->data_raw[state->i] = state->get_sample(strm);
        } else {
            if (state->flush == AEC_FLUSH) {
                if (state->i > 0) {
                    for (j = state->i; j < strm->rsi * strm->block_size; j++)
                        state->data_raw[j] = state->data_raw[state->i - 1];
                    state->i = strm->rsi * strm->block_size;
                } else {
                    if (state->zero_blocks) {
                        state->mode = m_encode_zero;
                        return M_CONTINUE;
                    }

                    emit(state, 0, state->bits);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
651 652 653 654 655 656
                    if (strm->avail_out > 0) {
                        if (state->direct_out == 0)
                            *strm->next_out++ = *state->cds;
                        strm->avail_out--;
                        strm->total_out++;
                    }
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
                    return M_EXIT;
                }
            } else {
                return M_EXIT;
            }
        }
    } while (++state->i < strm->rsi * strm->block_size);

    state->blocks_avail = strm->rsi - 1;
    if (strm->flags & AEC_DATA_PREPROCESS) {
        state->preprocess(strm);
        state->ref = 1;
    }

    return m_check_zero_block(strm);
672 673
}

674
static int m_get_block(struct aec_stream *strm)
675
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
676
    /**
677 678 679 680
       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
681
    */
682

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
683
    struct internal_state *state = strm->state;
684

685 686 687 688 689 690 691 692 693 694 695 696 697 698
    if (strm->avail_out > state->cds_len) {
        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;
    }
699

700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
    if (state->blocks_avail == 0) {
        state->block = state->data_pp;

        if (strm->avail_in >= state->block_len * strm->rsi) {
            state->get_rsi(strm);
            state->blocks_avail = strm->rsi - 1;

            if (strm->flags & AEC_DATA_PREPROCESS) {
                state->preprocess(strm);
                state->ref = 1;
            }
            return m_check_zero_block(strm);
        } else {
            state->i = 0;
            state->mode = m_get_rsi_resumable;
        }
    } else {
        state->ref = 0;
        state->block += strm->block_size;
        state->blocks_avail--;
        return m_check_zero_block(strm);
721 722 723 724 725 726 727 728 729
    }
    return M_CONTINUE;
}

/*
 *
 * API functions
 *
 */
730

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
731
int aec_encode_init(struct aec_stream *strm)
732
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
733
    struct internal_state *state;
734

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
735
    if (strm->bits_per_sample > 32 || strm->bits_per_sample == 0)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
736
        return AEC_CONF_ERROR;
737 738 739 740 741

    if (strm->block_size != 8
        && strm->block_size != 16
        && strm->block_size != 32
        && strm->block_size != 64)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
742
        return AEC_CONF_ERROR;
743 744

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
747
    state = (struct internal_state *)malloc(sizeof(struct internal_state));
748
    if (state == NULL)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
749
        return AEC_MEM_ERROR;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
750 751

    memset(state, 0, sizeof(struct internal_state));
752 753
    strm->state = state;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
754
    if (strm->bits_per_sample > 16) {
755
        /* 24/32 input bit settings */
756 757
        state->id_len = 5;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
758
        if (strm->bits_per_sample <= 24
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
759
            && strm->flags & AEC_DATA_3BYTE) {
760
            state->block_len = 3 * strm->block_size;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
761
            if (strm->flags & AEC_DATA_MSB) {
762
                state->get_sample = get_msb_24;
763
                state->get_rsi = get_rsi_msb_24;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
764
            } else {
765
                state->get_sample = get_lsb_24;
766
                state->get_rsi = get_rsi_lsb_24;
767
            }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
768
        } else {
769
            state->block_len = 4 * strm->block_size;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
770
            if (strm->flags & AEC_DATA_MSB) {
771
                state->get_sample = get_msb_32;
772
                state->get_rsi = get_rsi_msb_32;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
773
            } else {
774
                state->get_sample = get_lsb_32;
775
                state->get_rsi = get_rsi_lsb_32;
776 777
            }
        }
778
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
779
    else if (strm->bits_per_sample > 8) {
780 781
        /* 16 bit settings */
        state->id_len = 4;
782
        state->block_len = 2 * strm->block_size;
783

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
784
        if (strm->flags & AEC_DATA_MSB) {
785
            state->get_sample = get_msb_16;
786
            state->get_rsi = get_rsi_msb_16;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
787
        } else {
788
            state->get_sample = get_lsb_16;
789
            state->get_rsi = get_rsi_lsb_16;
790
        }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
791
    } else {
792 793
        /* 8 bit settings */
        state->id_len = 3;
794
        state->block_len = strm->block_size;
795 796

        state->get_sample = get_8;
797
        state->get_rsi = get_rsi_8;
798 799
    }

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
800
    if (strm->flags & AEC_DATA_SIGNED) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
801 802
        state->xmin = -(1ULL << (strm->bits_per_sample - 1));
        state->xmax = (1ULL << (strm->bits_per_sample - 1)) - 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
803
        state->preprocess = preprocess_signed;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
804
    } else {
805
        state->xmin = 0;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
806
        state->xmax = (1ULL << strm->bits_per_sample) - 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
807
        state->preprocess = preprocess_unsigned;
808 809
    }

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

812
    state->data_pp = (uint32_t *)malloc(strm->rsi
813 814
                                         * strm->block_size
                                         * sizeof(uint32_t));
815
    if (state->data_pp == NULL)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
816
        return AEC_MEM_ERROR;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
817

818 819 820 821 822 823 824 825 826 827
    if (strm->flags & AEC_DATA_PREPROCESS) {
        state->data_raw = (uint32_t *)malloc(strm->rsi
                                             * strm->block_size
                                             * sizeof(uint32_t));
        if (state->data_raw == NULL)
            return AEC_MEM_ERROR;
    } else {
        state->data_raw = state->data_pp;
    }

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
828
    state->block = state->data_pp;
829

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
830
    /* Largest possible CDS according to specs */
831 832 833
    state->cds_len = (5 + 64 * 32) / 8 + 3;
    state->cds_buf = (uint8_t *)malloc(state->cds_len);
    if (state->cds_buf == NULL)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
834
        return AEC_MEM_ERROR;
835

836 837 838
    strm->total_in = 0;
    strm->total_out = 0;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
839 840 841
    state->cds = state->cds_buf;
    *state->cds = 0;
    state->bits = 8;
842 843
    state->mode = m_get_block;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
844
    return AEC_OK;
845 846
}

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
847
int aec_encode(struct aec_stream *strm, int flush)
848 849 850 851 852
{
    /**
       Finite-state machine implementation of the adaptive entropy
       encoder.
    */
853
    int n;
854 855
    struct internal_state *state = strm->state;

856 857 858 859
    state->flush = flush;

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
860
    if (state->direct_out) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
861
        n = state->cds - strm->next_out;
862 863 864 865
        strm->next_out += n;
        strm->avail_out -= n;
        strm->total_out += n;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
866 867
        *state->cds_buf = *state->cds;
        state->cds = state->cds_buf;
868
        state->direct_out = 0;
869
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
870
    return AEC_OK;
871 872
}

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
873
int aec_encode_end(struct aec_stream *strm)
874
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
875
    struct internal_state *state = strm->state;
876

877 878 879
    if (strm->flags & AEC_DATA_PREPROCESS)
        free(state->data_raw);
    free(state->data_pp);
880
    free(state->cds_buf);
881
    free(state);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
882
    return AEC_OK;
883
}
884

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
885
int aec_buffer_encode(struct aec_stream *strm)
886 887 888 889 890 891 892 893 894 895 896 897 898
{
    int status;

    status = aec_encode_init(strm);
    if (status != AEC_OK)
        return status;
    status = aec_encode(strm, AEC_FLUSH);
    if (strm->avail_in > 0 || strm->avail_out == 0)
        status = AEC_DATA_ERROR;

    aec_encode_end(strm);
    return status;
}