aed.c 14.6 KB
Newer Older
1 2 3 4 5 6 7 8 9
/* Adaptive Entropy Decoder            */
/* CCSDS 121.0-B-1 and CCSDS 120.0-G-2 */

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

10
#include "libae.h"
11

12 13
#define MIN(a, b) (((a) < (b))? (a): (b))

14
#define SAFE (strm->avail_in >= state->in_blklen        \
15
              && strm->avail_out >= state->out_blklen)
16 17 18 19

#define ROS 5

typedef struct internal_state {
20
    int id;            /* option ID */
21
    int id_len;        /* bit length of code option identification key */
22
    int *id_table;     /* table maps IDs to states */
23
    void (*put_sample)(ae_streamp, int64_t);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
24
    int ref_int;       /* reference sample is every ref_int samples */
25
    int64_t last_out;  /* previous output for post-processing */
26 27 28
    int64_t xmin;      /* minimum integer for post-processing */
    int64_t xmax;      /* maximum integer for post-processing */
    int mode;          /* current mode of FSM */
29
    int in_blklen;     /* length of uncompressed input block
30
                          should be the longest possible block */
31
    int out_blklen;    /* length of output block in bytes */
32 33
    int n, i;          /* counter for samples */
    int64_t *block;    /* block buffer for split-sample options */
34 35
    int se;            /* set if second extension option is selected */
    uint64_t acc;      /* accumulator for currently used bit sequence */
36 37
    int bitp;          /* bit pointer to the next unused bit in accumulator */
    int fs;            /* last fundamental sequence in accumulator */
38
    int ref;           /* 1 if current block has reference sample */
39
    int pp;            /* 1 if postprocessor has to be used */
40
    int byte_per_sample;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
41
    size_t samples_out;
42 43 44
} decode_state;

/* decoding table for the second-extension option */
45
static const int second_extension[36][2] = {
46 47 48 49 50 51 52 53
    {0, 0},
    {1, 1}, {1, 1},
    {2, 3}, {2, 3}, {2, 3},
    {3, 6}, {3, 6}, {3, 6}, {3, 6},
    {4, 10}, {4, 10}, {4, 10}, {4, 10}, {4, 10},
    {5, 15}, {5, 15}, {5, 15}, {5, 15}, {5, 15}, {5, 15},
    {6, 21}, {6, 21}, {6, 21}, {6, 21}, {6, 21}, {6, 21}, {6, 21},
    {7, 28}, {7, 28}, {7, 28}, {7, 28}, {7, 28}, {7, 28}, {7, 28}, {7, 28}
54 55 56 57
};

enum
{
58 59 60 61 62 63 64 65 66 67 68 69
    M_ID = 0,
    M_SPLIT,
    M_SPLIT_FS,
    M_SPLIT_OUTPUT,
    M_LOW_ENTROPY,
    M_LOW_ENTROPY_REF,
    M_ZERO_BLOCK,
    M_ZERO_OUTPUT,
    M_SE,
    M_SE_DECODE,
    M_UNCOMP,
    M_UNCOMP_COPY,
70 71
};

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
static void put_msb_32(ae_streamp strm, int64_t data)
{
    *strm->next_out++ = data >> 24;
    *strm->next_out++ = data >> 16;
    *strm->next_out++ = data >> 8;
    *strm->next_out++ = data;
    strm->avail_out -= 4;
    strm->total_out += 4;
}

static void put_msb_16(ae_streamp strm, int64_t data)
{
    *strm->next_out++ = data >> 8;
    *strm->next_out++ = data;
    strm->avail_out -= 2;
    strm->total_out += 2;
}

static void put_lsb_32(ae_streamp strm, int64_t data)
{
    *strm->next_out++ = data;
    *strm->next_out++ = data >> 8;
    *strm->next_out++ = data >> 16;
    *strm->next_out++ = data >> 24;
    strm->avail_out -= 4;
    strm->total_out += 4;
}

static void put_lsb_16(ae_streamp strm, int64_t data)
{
    *strm->next_out++ = data;
    *strm->next_out++ = data >> 8;
    strm->avail_out -= 2;
    strm->total_out += 2;
}
107

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
108 109 110 111 112 113
static void put_8(ae_streamp strm, int64_t data)
{
    *strm->next_out++ = data;
    strm->avail_out--;
    strm->total_out++;
}
114 115

static inline void u_put(ae_streamp strm, int64_t sample)
116 117 118 119 120
{
    int64_t x, d, th, D;
    decode_state *state;

    state = strm->state;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
121
    if (state->pp && (state->samples_out % state->ref_int != 0))
122 123 124
    {
        d = sample;
        x = state->last_out;
125
        th = MIN(x - state->xmin, state->xmax - x);
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

        if (d <= 2*th)
        {
            if (d & 1)
                D = - (d + 1) / 2;
            else
                D = d / 2;
        } else {
            if (th == x)
                D = d - th;
            else
                D = th - d;
        }
        sample = x + D;
    }
141 142
    state->last_out = sample;
    state->put_sample(strm, sample);
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
143
    state->samples_out++;
144 145
}

146
static inline int64_t u_get(ae_streamp strm, unsigned int n)
147 148 149 150 151 152 153 154 155 156 157 158 159 160
{
    /**
       Unsafe get n bit from input stream

       No checking whatsoever. Read bits are dumped.
     */

    decode_state *state;

    state = strm->state;
    while (state->bitp < n)
    {
        strm->avail_in--;
        strm->total_in++;
161
        state->acc = (state->acc << 8) | *strm->next_in++;
162 163 164 165 166 167
        state->bitp += 8;
    }
    state->bitp -= n;
    return (state->acc >> state->bitp) & ((1ULL << n) - 1);
}

168
static inline int u_get_fs(ae_streamp strm)
169 170 171 172 173 174 175 176
{
    /**
       Interpret a Fundamental Sequence from the input buffer.

       Essentially counts the number of 0 bits until a
       1 is encountered. TODO: faster version.
     */

177
    int fs = 0;
178 179 180 181 182 183 184 185

    while(u_get(strm, 1) == 0)
        fs++;

    return fs;
}

static inline void fast_split(ae_streamp strm)
186
{
187
    int i, k;
188 189 190 191 192
    decode_state *state;

    state = strm->state;
    k = state->id - 1;

193
    if (state->ref)
194
        u_put(strm, u_get(strm, strm->bit_per_sample));
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
195

196
    for (i = state->ref; i < strm->block_size; i++)
197 198
        state->block[i] = u_get_fs(strm) << k;

199
    for (i = state->ref; i < strm->block_size; i++)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
200
    {
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
        state->block[i] += u_get(strm, k);
        u_put(strm, state->block[i]);
    }
}

static inline void fast_zero(ae_streamp strm)
{
    int i = strm->state->i;

    while (i--)
        u_put(strm, 0);
}

static inline void fast_se(ae_streamp strm)
{
    int i;
217
    int64_t gamma, beta, ms, delta1;
218

219
    i = strm->state->ref;
220

221
    while (i < strm->block_size)
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
222
    {
223 224 225 226
        gamma = u_get_fs(strm);
        beta = second_extension[gamma][0];
        ms = second_extension[gamma][1];
        delta1 = gamma - ms;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
227

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
        if ((i & 1) == 0)
        {
            u_put(strm, beta - delta1);
            i++;
        }
        u_put(strm, delta1);
        i++;
    }
}

static inline void fast_uncomp(ae_streamp strm)
{
    int i;

    for (i = 0; i < strm->block_size; i++)
        u_put(strm, u_get(strm, strm->bit_per_sample));
244 245 246 247
}

int ae_decode_init(ae_streamp strm)
{
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
    int i, modi;
    decode_state *state;

    /* Some sanity checks */
    if (strm->bit_per_sample > 32 || strm->bit_per_sample == 0)
    {
        return AE_ERRNO;
    }

    /* Internal state for decoder */
    state = (decode_state *) malloc(sizeof(decode_state));
    if (state == NULL)
    {
        return AE_MEM_ERROR;
    }
    strm->state = state;

265 266
    if (strm->bit_per_sample > 16)
    {
267
        state->byte_per_sample = 4;
268
        state->id_len = 5;
269
        state->out_blklen = strm->block_size * 4;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
270 271
        if (strm->flags & AE_DATA_MSB)
            state->put_sample = put_msb_32;
272
        else
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
273
            state->put_sample = put_lsb_32;
274 275 276
    }
    else if (strm->bit_per_sample > 8)
    {
277
        state->byte_per_sample = 2;
278
        state->id_len = 4;
279
        state->out_blklen = strm->block_size * 2;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
280 281
        if (strm->flags & AE_DATA_MSB)
            state->put_sample = put_msb_16;
282
        else
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
283
            state->put_sample = put_lsb_16;
284
    }
285
    else
286
    {
287
        state->byte_per_sample = 1;
288
        state->id_len = 3;
289
        state->out_blklen = strm->block_size;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
290 291
        state->put_sample = put_8;

292 293 294 295 296 297 298 299 300 301 302 303
    }

    if (strm->flags & AE_DATA_SIGNED)
    {
        state->xmin = -(1ULL << (strm->bit_per_sample - 1));
        state->xmax = (1ULL << (strm->bit_per_sample - 1)) - 1;
    }
    else
    {
        state->xmin = 0;
        state->xmax = (1ULL << strm->bit_per_sample) - 1;
    }
304 305

    state->ref_int = strm->block_size * strm->segment_size;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
306
    state->in_blklen = (strm->block_size * strm->bit_per_sample
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
                        + state->id_len) / 8 + 1;

    modi = 1UL << state->id_len;
    state->id_table = (int *)malloc(modi * sizeof(int));
    if (state->id_table == NULL)
    {
        return AE_MEM_ERROR;
    }
    state->id_table[0] = M_LOW_ENTROPY;
    for (i = 1; i < modi - 1; i++)
    {
        state->id_table[i] = M_SPLIT;
    }
    state->id_table[modi - 1] = M_UNCOMP;

322
    state->block = (int64_t *)malloc(strm->block_size * sizeof(int64_t));
323 324 325 326 327 328 329
    if (state->block == NULL)
    {
        return AE_MEM_ERROR;
    }
    strm->total_in = 0;
    strm->total_out = 0;

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
330
    state->samples_out = 0;
331
    state->bitp = 0;
332
    state->pp = strm->flags & AE_DATA_PREPROCESS;
333 334
    state->mode = M_ID;
    return AE_OK;
335 336
}

337 338 339 340 341 342 343 344 345 346 347
int ae_decode_end(ae_streamp strm)
{
    decode_state *state;

    state = strm->state;
    free(state->block);
    free(state->id_table);
    free(state);
    return AE_OK;
}

348 349 350 351 352 353 354 355
#define ASK(n)                                           \
    do {                                                 \
        while (state->bitp < (unsigned)(n))              \
        {                                                \
            if (strm->avail_in == 0) goto req_buffer;    \
            strm->avail_in--;                            \
            strm->total_in++;                            \
            state->acc <<= 8;                            \
356
            state->acc |= *strm->next_in++;              \
357 358
            state->bitp += 8;                            \
        }                                                \
359
    } while (0)
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 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
#define GET(n)                                                  \
    ((state->acc >> (state->bitp - (n))) & ((1ULL << (n)) - 1))

#define DROP(n) state->bitp -= (unsigned)(n)

#define ASKFS()                          \
    do {                                 \
        ASK(1);                          \
        state->fs = 0;                   \
        while (GET(state->fs + 1) == 0)  \
        {                                \
            state->fs++;                 \
            ASK(state->fs + 1);          \
        }                                \
    } while(0)

#define GETFS() state->fs

#define DROPFS() DROP(state->fs + 1)

#define PUT(sample)                                \
    do {                                           \
        if (strm->avail_out == 0) goto req_buffer; \
        u_put(strm, (sample));                     \
    } while (0)

#define COPYSAMPLE()                    \
    do {                                \
        ASK(strm->bit_per_sample);      \
        PUT(GET(strm->bit_per_sample)); \
        DROP(strm->bit_per_sample);     \
    } while (0)


395 396
int ae_decode(ae_streamp strm, int flush)
{
397 398 399 400 401 402 403 404 405
    /**
       Finite-state machine implementation of the adaptive entropy
       decoder.

       Can work with one byte input und one sample output buffers. If
       enough buffer space is available, then faster implementations
       of the states are called. Inspired by zlib.
    */

Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
406
    int zero_blocks;
407
    int64_t gamma, beta, ms, delta1;
408 409 410 411 412 413 414 415 416 417
    int k;
    decode_state *state;

    state = strm->state;

    for (;;)
    {
        switch(state->mode)
        {
        case M_ID:
418
            if (state->pp
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
419
                && (state->samples_out / strm->block_size) % strm->segment_size == 0)
420 421 422 423 424 425 426
                state->ref = 1;
            else
                state->ref = 0;

            ASK(state->id_len);
            state->id = GET(state->id_len);
            DROP(state->id_len);
427 428 429 430 431 432 433 434 435 436 437
            state->mode = state->id_table[state->id];
            break;

        case M_SPLIT:
            if (SAFE)
            {
                fast_split(strm);
                state->mode = M_ID;
                break;
            }

438
            if (state->ref)
439 440 441 442 443 444 445 446 447
            {
                COPYSAMPLE();
                state->n = strm->block_size - 1;
            }
            else
            {
                state->n = strm->block_size;
            }

448
            state->i = state->n - 1;
449 450 451 452 453 454
            state->mode = M_SPLIT_FS;

        case M_SPLIT_FS:
            do
            {
                ASKFS();
455
                state->block[state->i] = GETFS();
456 457
                DROPFS();
            }
458
            while(state->i--);
459

460
            state->i = state->n - 1;
461
            state->mode = M_SPLIT_OUTPUT;
462

463
        case M_SPLIT_OUTPUT:
464 465 466 467
            k = state->id - 1;
            do
            {
                ASK(k);
468
                PUT((state->block[state->i] << k) + GET(k));
469 470
                DROP(k);
            }
471
            while(state->i--);
472 473 474 475 476 477 478 479 480 481 482

            state->mode = M_ID;
            break;

        case M_LOW_ENTROPY:
            ASK(1);
            state->id = GET(1);
            DROP(1);
            state->mode = M_LOW_ENTROPY_REF;

        case M_LOW_ENTROPY_REF:
483
            if (state->ref)
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
                COPYSAMPLE();

            if(state->id == 1)
            {
                state->mode = M_SE;
                break;
            }

            state->mode = M_ZERO_BLOCK;

        case M_ZERO_BLOCK:
            ASKFS();
            zero_blocks = GETFS() + 1;
            DROPFS();

            if (zero_blocks == ROS)
            {
                zero_blocks =  strm->segment_size - (
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
502
                    (state->samples_out / strm->block_size)
503 504
                    % strm->segment_size);
            }
505 506 507 508
            else if (zero_blocks > ROS)
            {
                zero_blocks--;
            }
509 510


511
            if (state->ref)
512 513 514 515
                state->i = zero_blocks * strm->block_size - 1;
            else
                state->i = zero_blocks * strm->block_size;

516
            if (strm->avail_out >= state->i * state->byte_per_sample)
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
            {
                fast_zero(strm);
                state->mode = M_ID;
                break;
            }

            state->mode = M_ZERO_OUTPUT;

        case M_ZERO_OUTPUT:
            do
                PUT(0);
            while(--state->i);

            state->mode = M_ID;
            break;

        case M_SE:
            if (SAFE)
            {
                fast_se(strm);
                state->mode = M_ID;
                break;
            }

            state->mode = M_SE_DECODE;
542
            state->i = state->ref;
543 544

        case M_SE_DECODE:
545
            while(state->i < strm->block_size)
546 547
            {
                ASKFS();
548 549 550 551 552 553 554 555 556 557 558 559
                gamma = GETFS();
                beta = second_extension[gamma][0];
                ms = second_extension[gamma][1];
                delta1 = gamma - ms;

                if ((state->i & 1) == 0)
                {
                    PUT(beta - delta1);
                    state->i++;
                }

                PUT(delta1);
560
                state->i++;
561
                DROPFS();
562 563
            }

564
            state->mode = M_ID;
565
            break;
Mathis Rosenhauer's avatar
Mathis Rosenhauer committed
566

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
        case M_UNCOMP:
            if (SAFE)
            {
                fast_uncomp(strm);
                state->mode = M_ID;
                break;
            }

            state->i = strm->block_size;
            state->mode = M_UNCOMP_COPY;

        case M_UNCOMP_COPY:
            do
                COPYSAMPLE();
            while(--state->i);

            state->mode = M_ID;
            break;

        default:
            return AE_STREAM_ERROR;
        }
    }
590 591

req_buffer:
592
    return AE_OK;
593
}