encode.c 25.2 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
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
50
 * Based on CCSDS documents 121.0-B-2 and 120.0-G-3
51
52
 *
 */
53
54
55
56
57

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
58
59
60
#include "libaec.h"
#include "encode.h"
#include "encode_accessors.h"
61

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
62
63
64
65
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
66
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
67
68
69
70
    /**
       Emit sequence of bits.
     */

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
71
72
73
    if (bits <= state->bits) {
        state->bits -= bits;
        *state->cds += data << state->bits;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
74
    } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
75
76
        bits -= state->bits;
        *state->cds++ += (uint64_t)data >> bits;
77

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
78
        while (bits > 8) {
79
            bits -= 8;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
80
            *state->cds++ = data >> bits;
81
        }
82

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
83
84
        state->bits = 8 - bits;
        *state->cds = data << state->bits;
85
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
86
87
}

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
88
static inline void emitfs(struct internal_state *state, int fs)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
89
{
90
91
    /**
       Emits a fundamental sequence.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
92

93
94
       fs zero bits followed by one 1 bit.
     */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
95

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
96
    for(;;) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
97
98
99
        if (fs < state->bits) {
            state->bits -= fs + 1;
            *state->cds += 1U << state->bits;
100
            break;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
101
        } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
102
103
104
            fs -= state->bits;
            *++state->cds = 0;
            state->bits = 8;
105
106
        }
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
107
}
108

109
110
111
112
113
114
115
116
117
118
119
120
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;
}

121
122
123
124
125
126
127
128
129
130
131
132
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;
133
        while (used > 63) {
134
135
136
            copy64(state->cds, acc);
            state->cds += 8;
            acc = 0;
137
            used -= 64;
138
139
        }
        acc |= 1ULL << (63 - used);
140
141
    }

142
143
144
145
    copy64(state->cds, acc);
    state->cds += used >> 3;
    state->bits = 7 - (used & 7);
}
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
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
172
        switch (p & ~7) {
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
        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
231
232
    }

233
234
235
236
    *o = a;
    state->cds = o;
    state->bits = p % 8;
}
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
237

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

       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
245
246
    */

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
247
    uint32_t D;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
248
    struct internal_state *state = strm->state;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
249
250
    const uint32_t *restrict x = state->data_raw;
    uint32_t *restrict d = state->data_pp;
251
252
    uint32_t xmax = state->xmax;
    uint32_t rsi = strm->rsi * strm->block_size - 1;
253
    int i;
254

255
256
    d[0] = x[0];
    for (i = 0; i < rsi; i++) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
257
258
        if (x[i + 1] >= x[i]) {
            D = x[i + 1] - x[i];
259
            if (D <= x[i])
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
260
                d[i + 1] = 2 * D;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
261
            else
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
262
                d[i + 1] = x[i + 1];
263
        } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
264
            D = x[i] - x[i + 1];
265
            if (D <= xmax - x[i])
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
266
                d[i + 1] = 2 * D - 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
267
            else
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
268
                d[i + 1] = xmax - x[i + 1];
269
        }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
270
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
271
    state->ref = 1;
272
    state->uncomp_len = (strm->block_size - 1) * strm->bits_per_sample;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
273
274
}

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
275
static void preprocess_signed(struct aec_stream *strm)
276
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
277
278
279
280
    /**
       Preprocess RSI of signed samples.
    */

281
    int64_t D;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
282
    struct internal_state *state = strm->state;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
283
284
    uint32_t *restrict d = state->data_pp;
    int32_t *restrict x = (int32_t *)state->data_raw;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
285
    uint64_t m = 1ULL << (strm->bits_per_sample - 1);
286
287
288
    int64_t xmax = state->xmax;
    int64_t xmin = state->xmin;
    uint32_t rsi = strm->rsi * strm->block_size - 1;
289
    int i;
290

291
    d[0] = (uint32_t)x[0];
292
293
    x[0] = (x[0] ^ m) - m;

294
    for (i = 0; i < rsi; i++) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
295
296
297
        x[i + 1] = (x[i + 1] ^ m) - m;
        if (x[i + 1] < x[i]) {
            D = (int64_t)x[i] - x[i + 1];
298
299
            if (D <= xmax - x[i])
                d[i + 1] = 2 * D - 1;
300
            else
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
301
                d[i + 1] = xmax - x[i + 1];
302
        } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
303
            D = (int64_t)x[i + 1] - x[i];
304
305
            if (D <= x[i] - xmin)
                d[i + 1] = 2 * D;
306
            else
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
307
                d[i + 1] = x[i + 1] - xmin;
308
        }
309
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
310
    state->ref = 1;
311
    state->uncomp_len = (strm->block_size - 1) * strm->bits_per_sample;
312
}
313

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
314
static inline uint64_t block_fs(struct aec_stream *strm, int k)
315
316
317
318
319
320
321
322
323
{
    /**
       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
324
325
    for (i = 0; i < strm->block_size; i++)
        fs += (uint64_t)(state->block[i] >> k);
326
327
328
329
330
331
332

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

    return fs;
}

333
static uint32_t assess_splitting_option(struct aec_stream *strm)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
334
335
336
337
338
{
    /**
       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
339
       the same position into k LSB and bits_per_sample - k MSB. The
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
       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.
     */

360
    int k;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
361
362
363
364
365
366
367
368
369
370
371
372
373
    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;
374
    no_turn = k == 0;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
375
376
377
    dir = 1;

    for (;;) {
378
        fs_len = block_fs(strm, k);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
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
        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;
}

416
static uint32_t assess_se_option(struct aec_stream *strm)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
417
418
419
420
{
    /**
       Length of CDS encoded with Second Extension option.

421
       If length is above limit just return UINT32_MAX.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
422
423
424
425
    */

    int i;
    uint64_t d;
426
    uint32_t len;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
427
428
429
430
431
432
433
434
    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 */
435
436
        if (d > state->uncomp_len) {
            len = UINT32_MAX;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
437
438
            break;
        } else {
439
            len += d * (d + 1) / 2 + state->block[i + 1] + 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
440
441
442
443
444
        }
    }
    return len;
}

445
446
447
448
449
450
451
452
453
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;

454
    if (strm->avail_out > CDSLEN) {
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
        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;
    }
}

470
471
472
473
474
475
/*
 *
 * FSM functions
 *
 */

476
static int m_flush_block_resumable(struct aec_stream *strm)
477
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
478
    /**
479
       Slow and restartable flushing
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
480
    */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
481
    struct internal_state *state = strm->state;
482

483
484
485
486
487
488
489
490
491
492
493
    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;
494
495
496
    }
}

497
static int m_flush_block(struct aec_stream *strm)
498
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
499
    /**
500
       Flush block in direct_out mode by updating counters.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
501

502
       Fall back to slow flushing if in buffered mode.
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
503
    */
504
    int n;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
505
    struct internal_state *state = strm->state;
506

507
#ifdef ENABLE_RSI_PADDING
508
509
510
511
512
    if (state->blocks_avail == 0
        && strm->flags & AEC_PAD_RSI
        && state->block_nonzero == 0
        )
        emit(state, 0, state->bits % 8);
513
#endif
514

515
516
517
518
    if (state->direct_out) {
        n = state->cds - strm->next_out;
        strm->next_out += n;
        strm->avail_out -= n;
519
520
        state->mode = m_get_block;
        return M_CONTINUE;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
521
    }
522

523
524
525
    state->i = 0;
    state->mode = m_flush_block_resumable;
    return M_CONTINUE;
526
}
527

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

533
    emit(state, k + 1, state->id_len);
534

535
    if (state->ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
536
        emit(state, state->block[0], strm->bits_per_sample);
537
538
539
540

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

542
543
    return m_flush_block(strm);
}
544

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
545
static int m_encode_uncomp(struct aec_stream *strm)
546
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
547
    struct internal_state *state = strm->state;
548

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
549
    emit(state, (1U << state->id_len) - 1, state->id_len);
550
    emitblock(strm, strm->bits_per_sample, 0);
551

552
553
    return m_flush_block(strm);
}
554

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
555
static int m_encode_se(struct aec_stream *strm)
556
557
{
    int i;
558
    uint32_t d;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
559
    struct internal_state *state = strm->state;
560

561
562
    emit(state, 1, state->id_len + 1);
    if (state->ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
563
        emit(state, state->block[0], strm->bits_per_sample);
564

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
565
    for (i = 0; i < strm->block_size; i+= 2) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
566
567
        d = state->block[i] + state->block[i + 1];
        emitfs(state, d * (d + 1) / 2 + state->block[i + 1]);
568
    }
569

570
571
    return m_flush_block(strm);
}
572

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
573
static int m_encode_zero(struct aec_stream *strm)
574
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
575
    struct internal_state *state = strm->state;
576

577
    emit(state, 0, state->id_len + 1);
578

579
    if (state->zero_ref)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
580
        emit(state, state->zero_ref_sample, strm->bits_per_sample);
581

582
583
584
585
586
587
    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);
588

589
590
591
    state->zero_blocks = 0;
    return m_flush_block(strm);
}
592

593
static int m_select_code_option(struct aec_stream *strm)
594
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
595
    /**
596
597
       Decide which code option to use.
    */
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
598

599
600
    uint32_t split_len;
    uint32_t se_len;
601
602
    struct internal_state *state = strm->state;

603
604
605
606
    if (state->id_len > 1)
        split_len = assess_splitting_option(strm);
    else
        split_len = UINT32_MAX;
607
    se_len = assess_se_option(strm);
608

609
    if (split_len < state->uncomp_len) {
610
611
612
613
614
        if (split_len < se_len)
            return m_encode_splitting(strm);
        else
            return m_encode_se(strm);
    } else {
615
        if (state->uncomp_len <= se_len)
616
617
618
619
620
621
622
623
624
625
626
627
628
            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
629
    */
630

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

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
639
    if (i < strm->block_size) {
640
641
642
        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
643
             * flagged and handled later.
644
             */
645
            state->block_nonzero = 1;
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
            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;
        }
664
665
666
        state->mode = m_get_block;
        return M_CONTINUE;
    }
667
}
668

669
670
671
672
673
674
675
676
677
678
679
680
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 {
681
        if (strm->avail_in >= state->bytes_per_sample) {
682
683
684
685
            state->data_raw[state->i] = state->get_sample(strm);
        } else {
            if (state->flush == AEC_FLUSH) {
                if (state->i > 0) {
686
687
688
                    state->blocks_avail = state->i / strm->block_size - 1;
                    if (state->i % strm->block_size)
                        state->blocks_avail++;
689
690
691
692
                    do
                        state->data_raw[state->i] =
                            state->data_raw[state->i - 1];
                    while(++state->i < strm->rsi * strm->block_size);
693
                } else {
694
695
                    /* Finish encoding by padding the last byte with
                     * zero bits. */
696
                    emit(state, 0, state->bits);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
697
                    if (strm->avail_out > 0) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
698
                        if (!state->direct_out)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
699
700
                            *strm->next_out++ = *state->cds;
                        strm->avail_out--;
701
                        state->flushed = 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
702
                    }
703
704
705
706
707
708
709
710
                    return M_EXIT;
                }
            } else {
                return M_EXIT;
            }
        }
    } while (++state->i < strm->rsi * strm->block_size);

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

    return m_check_zero_block(strm);
715
716
}

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
726
    struct internal_state *state = strm->state;
727

728
729
730
731
732
733
    init_output(strm);

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

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

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

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

762
763
764
765
766
767
768
769
770
771
772
static void cleanup(struct aec_stream *strm)
{
    struct internal_state *state = strm->state;

    if (strm->flags & AEC_DATA_PREPROCESS && state->data_raw)
        free(state->data_raw);
    if (state->data_pp)
        free(state->data_pp);
    free(state);
}

773
774
775
776
777
/*
 *
 * API functions
 *
 */
778

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
779
int aec_encode_init(struct aec_stream *strm)
780
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
781
    struct internal_state *state;
782

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
783
    if (strm->bits_per_sample > 32 || strm->bits_per_sample == 0)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
784
        return AEC_CONF_ERROR;
785
786
787
788
789

    if (strm->block_size != 8
        && strm->block_size != 16
        && strm->block_size != 32
        && strm->block_size != 64)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
790
        return AEC_CONF_ERROR;
791
792

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
795
    state = malloc(sizeof(struct internal_state));
796
    if (state == NULL)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
797
        return AEC_MEM_ERROR;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
798
799

    memset(state, 0, sizeof(struct internal_state));
800
801
    strm->state = state;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
802
    if (strm->bits_per_sample > 16) {
803
        /* 24/32 input bit settings */
804
805
        state->id_len = 5;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
806
        if (strm->bits_per_sample <= 24
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
807
            && strm->flags & AEC_DATA_3BYTE) {
808
            state->bytes_per_sample = 3;
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_24;
                state->get_rsi = aec_get_rsi_msb_24;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
812
            } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
813
814
                state->get_sample = aec_get_lsb_24;
                state->get_rsi = aec_get_rsi_lsb_24;
815
            }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
816
        } else {
817
            state->bytes_per_sample = 4;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
818
            if (strm->flags & AEC_DATA_MSB) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
819
820
                state->get_sample = aec_get_msb_32;
                state->get_rsi = aec_get_rsi_msb_32;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
821
            } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
822
823
                state->get_sample = aec_get_lsb_32;
                state->get_rsi = aec_get_rsi_lsb_32;
824
825
            }
        }
826
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
827
    else if (strm->bits_per_sample > 8) {
828
829
        /* 16 bit settings */
        state->id_len = 4;
830
        state->bytes_per_sample = 2;
831

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
832
        if (strm->flags & AEC_DATA_MSB) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
833
834
            state->get_sample = aec_get_msb_16;
            state->get_rsi = aec_get_rsi_msb_16;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
835
        } else {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
836
837
            state->get_sample = aec_get_lsb_16;
            state->get_rsi = aec_get_rsi_lsb_16;
838
        }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
839
    } else {
840
        /* 8 bit settings */
841
        if (strm->flags & AEC_RESTRICTED) {
842
843
844
845
846
847
848
849
850
851
852
            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;
        }
853
        state->bytes_per_sample = 1;
854

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
855
856
        state->get_sample = aec_get_8;
        state->get_rsi = aec_get_rsi_8;
857
    }
858
    state->rsi_len = strm->rsi * strm->block_size * state->bytes_per_sample;
859

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
860
    if (strm->flags & AEC_DATA_SIGNED) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
861
862
        state->xmin = -(1ULL << (strm->bits_per_sample - 1));
        state->xmax = (1ULL << (strm->bits_per_sample - 1)) - 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
863
        state->preprocess = preprocess_signed;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
864
    } else {
865
        state->xmin = 0;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
866
        state->xmax = (1ULL << strm->bits_per_sample) - 1;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
867
        state->preprocess = preprocess_unsigned;
868
869
    }

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
872
873
874
    state->data_pp = malloc(strm->rsi
                            * strm->block_size
                            * sizeof(uint32_t));
875
876
    if (state->data_pp == NULL) {
        cleanup(strm);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
877
        return AEC_MEM_ERROR;
878
    }
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
879

880
    if (strm->flags & AEC_DATA_PREPROCESS) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
881
882
883
        state->data_raw = malloc(strm->rsi
                                 * strm->block_size
                                 * sizeof(uint32_t));
884
885
        if (state->data_raw == NULL) {
            cleanup(strm);
886
            return AEC_MEM_ERROR;
887
        }
888
889
890
891
    } else {
        state->data_raw = state->data_pp;
    }

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
892
    state->block = state->data_pp;
893
894
895

    strm->total_in = 0;
    strm->total_out = 0;
896
    state->flushed = 0;
897

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
898
899
900
    state->cds = state->cds_buf;
    *state->cds = 0;
    state->bits = 8;
901
902
    state->mode = m_get_block;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
903
    return AEC_OK;
904
905
}

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
906
int aec_encode(struct aec_stream *strm, int flush)
907
908
909
910
911
{
    /**
       Finite-state machine implementation of the adaptive entropy
       encoder.
    */
912
    int n;
913
914
    struct internal_state *state = strm->state;

915
    state->flush = flush;
916
917
    strm->total_in += strm->avail_in;
    strm->total_out += strm->avail_out;
918
919
920

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

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
921
    if (state->direct_out) {
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
922
        n = state->cds - strm->next_out;
923
924
925
        strm->next_out += n;
        strm->avail_out -= n;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
926
927
        *state->cds_buf = *state->cds;
        state->cds = state->cds_buf;
928
        state->direct_out = 0;
929
    }
930
931
    strm->total_in -= strm->avail_in;
    strm->total_out -= strm->avail_out;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
932
    return AEC_OK;
933
934
}

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
935
int aec_encode_end(struct aec_stream *strm)
936
{
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
937
    struct internal_state *state = strm->state;
938
    int status;
939

940
941
942
943
944
    status = AEC_OK;
    if (state->flush == AEC_FLUSH && state->flushed == 0)
        status = AEC_STREAM_ERROR;
    cleanup(strm);
    return status;
945
}
946

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
947
int aec_buffer_encode(struct aec_stream *strm)
948
949
950
951
952
953
954
{
    int status;

    status = aec_encode_init(strm);
    if (status != AEC_OK)
        return status;
    status = aec_encode(strm, AEC_FLUSH);
955
956
957
958
959
    if (status != AEC_OK) {
        cleanup(strm);
        return status;
    }
    return aec_encode_end(strm);
960
}