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 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
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;
}

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
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);
150 151
    }

152 153 154 155
    copy64(state->cds, acc);
    state->cds += used >> 3;
    state->bits = 7 - (used & 7);
}
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 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 238 239 240
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;
        }

        switch (p & ~ 7) {
        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
241 242
    }

243 244 245 246
    *o = a;
    state->cds = o;
    state->bits = p % 8;
}
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
247

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

       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
255 256
    */

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
257
    uint32_t D;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
258
    struct internal_state *state = strm->state;
259 260
    const uint32_t *x = state->data_raw;
    uint32_t *d = state->data_pp;
261 262
    uint32_t xmax = state->xmax;
    uint32_t rsi = strm->rsi * strm->block_size - 1;
263

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
286
static void preprocess_signed(struct aec_stream *strm)
287
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
288 289 290 291
    /**
       Preprocess RSI of signed samples.
    */

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

301 302 303
    *d++ = (uint32_t)x[0];
    x[0] = (x[0] ^ m) - m;

304
    while (rsi--) {
305 306 307 308 309
        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;
310
            else
311
                *d = xmax - x[1];
312
        } else {
313 314 315
            D = (int64_t)x[1] - x[0];
            if (D <= x[0] - xmin)
                *d = 2 * D;
316
            else
317
                *d = x[1] - xmin;
318
        }
319 320
        x++;
        d++;
321
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
322
    state->ref = 1;
323
    state->uncomp_len = (strm->block_size - 1) * strm->bits_per_sample;
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
static uint64_t block_fs(struct aec_stream *strm, int k)
{
    /**
       Sum FS of all samples in block for given splitting position.
    */

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

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

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

    return fs;
}

353
static uint32_t assess_splitting_option(struct aec_stream *strm)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
354 355 356 357 358
{
    /**
       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
359
       the same position into k LSB and bits_per_sample - k MSB. The
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
       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.
     */

380
    int k;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
381 382 383 384 385 386 387 388 389 390 391 392 393
    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;
394
    no_turn = k == 0;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
395 396 397
    dir = 1;

    for (;;) {
398
        fs_len = block_fs(strm, k);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
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 425 426 427 428 429 430 431 432 433 434 435
        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;
}

436
static uint32_t assess_se_option(struct aec_stream *strm)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
437 438 439 440
{
    /**
       Length of CDS encoded with Second Extension option.

441
       If length is above limit just return UINT32_MAX.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
442 443 444 445
    */

    int i;
    uint64_t d;
446
    uint32_t len;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
447 448 449 450 451 452 453 454
    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 */
455 456
        if (d > state->uncomp_len) {
            len = UINT32_MAX;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
457 458
            break;
        } else {
459
            len += d * (d + 1) / 2 + state->block[i + 1];
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
460 461 462 463 464
        }
    }
    return len;
}

465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
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;

    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;
    }
}

490 491 492 493 494 495
/*
 *
 * FSM functions
 *
 */

496
static int m_flush_block_resumable(struct aec_stream *strm)
497
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
498
    /**
499
       Slow and restartable flushing
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
500
    */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
501
    struct internal_state *state = strm->state;
502

503 504 505 506 507 508 509 510 511 512 513
    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;
514 515 516
    }
}

517
static int m_flush_block(struct aec_stream *strm)
518
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
519
    /**
520
       Flush block in direct_out mode by updating counters.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
521

522
       Fall back to slow flushing if in buffered mode.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
523
    */
524
    int n;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
525
    struct internal_state *state = strm->state;
526

527 528 529 530
    if (state->direct_out) {
        n = state->cds - strm->next_out;
        strm->next_out += n;
        strm->avail_out -= n;
531 532
        state->mode = m_get_block;
        return M_CONTINUE;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
533
    }
534

535 536 537
    state->i = 0;
    state->mode = m_flush_block_resumable;
    return M_CONTINUE;
538
}
539

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
540
static int m_encode_splitting(struct aec_stream *strm)
541
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
542
    struct internal_state *state = strm->state;
543
    int k = state->k;
544

545
    emit(state, k + 1, state->id_len);
546

547
    if (state->ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
548
        emit(state, state->block[0], strm->bits_per_sample);
549 550 551 552

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

554 555
    return m_flush_block(strm);
}
556

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
557
static int m_encode_uncomp(struct aec_stream *strm)
558
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
559
    struct internal_state *state = strm->state;
560

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
561
    emit(state, (1U << state->id_len) - 1, state->id_len);
562
    emitblock(strm, strm->bits_per_sample, 0);
563

564 565
    return m_flush_block(strm);
}
566

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
567
static int m_encode_se(struct aec_stream *strm)
568 569
{
    int i;
570
    uint32_t d;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
571
    struct internal_state *state = strm->state;
572

573 574
    emit(state, 1, state->id_len + 1);
    if (state->ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
575
        emit(state, state->block[0], strm->bits_per_sample);
576

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
577
    for (i = 0; i < strm->block_size; i+= 2) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
578 579
        d = state->block[i] + state->block[i + 1];
        emitfs(state, d * (d + 1) / 2 + state->block[i + 1]);
580
    }
581

582 583
    return m_flush_block(strm);
}
584

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
585
static int m_encode_zero(struct aec_stream *strm)
586
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
587
    struct internal_state *state = strm->state;
588

589
    emit(state, 0, state->id_len + 1);
590

591
    if (state->zero_ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
592
        emit(state, state->zero_ref_sample, strm->bits_per_sample);
593

594 595 596 597 598 599
    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);
600

601 602 603
    state->zero_blocks = 0;
    return m_flush_block(strm);
}
604

605
static int m_select_code_option(struct aec_stream *strm)
606
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
607
    /**
608 609
       Decide which code option to use.
    */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
610

611 612
    uint32_t split_len;
    uint32_t se_len;
613 614 615
    struct internal_state *state = strm->state;

    split_len = assess_splitting_option(strm);
616
    se_len = assess_se_option(strm);
617

618
    if (split_len < state->uncomp_len) {
619 620 621 622 623
        if (split_len < se_len)
            return m_encode_splitting(strm);
        else
            return m_encode_se(strm);
    } else {
624
        if (state->uncomp_len <= se_len)
625 626 627 628 629 630 631 632 633 634 635 636 637
            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
638
    */
639

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
640
    struct internal_state *state = strm->state;
641 642
    uint32_t *p = state->block + state->ref;
    uint32_t *end = state->block + strm->block_size;
643

644 645 646 647 648 649 650
    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
651
             * flagged and handled later.
652
             */
653
            state->block_nonzero = 1;
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
            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;
        }
672 673 674
        state->mode = m_get_block;
        return M_CONTINUE;
    }
675
}
676

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
713
    if (strm->flags & AEC_DATA_PREPROCESS)
714 715 716
        state->preprocess(strm);

    return m_check_zero_block(strm);
717 718
}

719
static int m_get_block(struct aec_stream *strm)
720
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
721
    /**
722 723 724 725
       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
726
    */
727

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
728
    struct internal_state *state = strm->state;
729

730 731 732 733 734 735
    init_output(strm);

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

738
    if (state->blocks_avail == 0) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
739
        state->blocks_avail = strm->rsi - 1;
740 741
        state->block = state->data_pp;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
742
        if (strm->avail_in >= state->rsi_len) {
743
            state->get_rsi(strm);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
744
            if (strm->flags & AEC_DATA_PREPROCESS)
745
                state->preprocess(strm);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
746

747 748 749 750 751 752
            return m_check_zero_block(strm);
        } else {
            state->i = 0;
            state->mode = m_get_rsi_resumable;
        }
    } else {
753 754 755 756
        if (state->ref) {
            state->ref = 0;
            state->uncomp_len = strm->block_size * strm->bits_per_sample;
        }
757 758 759
        state->block += strm->block_size;
        state->blocks_avail--;
        return m_check_zero_block(strm);
760 761 762 763 764 765 766 767 768
    }
    return M_CONTINUE;
}

/*
 *
 * API functions
 *
 */
769

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
770
int aec_encode_init(struct aec_stream *strm)
771
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
772
    struct internal_state *state;
773

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
774
    if (strm->bits_per_sample > 32 || strm->bits_per_sample == 0)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
775
        return AEC_CONF_ERROR;
776 777 778 779 780

    if (strm->block_size != 8
        && strm->block_size != 16
        && strm->block_size != 32
        && strm->block_size != 64)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
781
        return AEC_CONF_ERROR;
782 783

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
786
    state = malloc(sizeof(struct internal_state));
787
    if (state == NULL)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
788
        return AEC_MEM_ERROR;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
789 790

    memset(state, 0, sizeof(struct internal_state));
791 792
    strm->state = state;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
793
    if (strm->bits_per_sample > 16) {
794
        /* 24/32 input bit settings */
795 796
        state->id_len = 5;

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
823
        if (strm->flags & AEC_DATA_MSB) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
824 825
            state->get_sample = aec_get_msb_16;
            state->get_rsi = aec_get_rsi_msb_16;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
826
        } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
827 828
            state->get_sample = aec_get_lsb_16;
            state->get_rsi = aec_get_rsi_lsb_16;
829
        }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
830
    } else {
831 832
        /* 8 bit settings */
        state->id_len = 3;
833
        state->bytes_per_sample = 1;
834

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
835 836
        state->get_sample = aec_get_8;
        state->get_rsi = aec_get_rsi_8;
837
    }
838
    state->rsi_len = strm->rsi * strm->block_size * state->bytes_per_sample;
839

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
840
    if (strm->flags & AEC_DATA_SIGNED) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
841 842
        state->xmin = -(1ULL << (strm->bits_per_sample - 1));
        state->xmax = (1ULL << (strm->bits_per_sample - 1)) - 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
843
        state->preprocess = preprocess_signed;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
844
    } else {
845
        state->xmin = 0;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
846
        state->xmax = (1ULL << strm->bits_per_sample) - 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
847
        state->preprocess = preprocess_unsigned;
848 849
    }

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
852 853 854
    state->data_pp = malloc(strm->rsi
                            * strm->block_size
                            * sizeof(uint32_t));
855
    if (state->data_pp == NULL)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
856
        return AEC_MEM_ERROR;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
857

858
    if (strm->flags & AEC_DATA_PREPROCESS) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
859 860 861
        state->data_raw = malloc(strm->rsi
                                 * strm->block_size
                                 * sizeof(uint32_t));
862 863 864 865 866 867
        if (state->data_raw == NULL)
            return AEC_MEM_ERROR;
    } else {
        state->data_raw = state->data_pp;
    }

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
868
    state->block = state->data_pp;
869

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
870
    /* Largest possible CDS according to specs */
871
    state->cds_len = (5 + 64 * 32) / 8 + 3;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
872
    state->cds_buf = malloc(state->cds_len);
873
    if (state->cds_buf == NULL)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
874
        return AEC_MEM_ERROR;
875

876 877 878
    strm->total_in = 0;
    strm->total_out = 0;

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

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

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

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

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

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

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

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

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

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

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

    aec_encode_end(strm);
    return status;
}