libavcodec/opus_rc.h

   1 /*
   2  * Copyright (c) 2012 Andrew D'Addesio
   3  * Copyright (c) 2013-2014 Mozilla Corporation
   4  * Copyright (c) 2017 Rostislav Pehlivanov <atomnuker@gmail.com>
   5  *
   6  * This file is part of FFmpeg.
   7  *
   8  * FFmpeg is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * FFmpeg is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with FFmpeg; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 #ifndef AVCODEC_OPUS_RC_H
  24 #define AVCODEC_OPUS_RC_H
  25
  26 #include <stdint.h>
  27 #include "get_bits.h"
  28 #include "opus.h"
  29
  30 #define opus_ilog(i) (av_log2(i) + !!(i))
  31
  32 typedef struct RawBitsContext {
  33     const uint8_t *position;
  34     uint32_t bytes;
  35     uint32_t cachelen;
  36     uint32_t cacheval;
  37 } RawBitsContext;
  38
  39 typedef struct OpusRangeCoder {
  40     GetBitContext gb;
  41     RawBitsContext rb;
  42     uint32_t range;
  43     uint32_t value;
  44     uint32_t total_bits;
  45
  46     /* Encoder */
  47     uint8_t buf[OPUS_MAX_FRAME_SIZE + 12]; /* memcpy vs (memmove + overreading) */
  48     uint8_t *rng_cur;                      /* Current range coded byte */
  49     int ext;                               /* Awaiting propagation */
  50     int rem;                               /* Carryout flag */
  51
  52     /* Encoding stats */
  53     int waste;
  54 } OpusRangeCoder;
  55
  56 /**
  57  * CELT: estimate bits of entropy that have thus far been consumed for the
  58  *       current CELT frame, to integer and fractional (1/8th bit) precision
  59  */
  60 static av_always_inline uint32_t opus_rc_tell(const OpusRangeCoder *rc)
  61 {
  62     return rc->total_bits - av_log2(rc->range) - 1;
  63 }
  64
  65 static av_always_inline uint32_t opus_rc_tell_frac(const OpusRangeCoder *rc)
  66 {
  67     uint32_t i, total_bits, rcbuffer, range;
  68
  69     total_bits = rc->total_bits << 3;
  70     rcbuffer   = av_log2(rc->range) + 1;
  71     range      = rc->range >> (rcbuffer-16);
  72
  73     for (i = 0; i < 3; i++) {
  74         int bit;
  75         range = range * range >> 15;
  76         bit = range >> 16;
  77         rcbuffer = rcbuffer << 1 | bit;
  78         range >>= bit;
  79     }
  80
  81     return total_bits - rcbuffer;
  82 }
  83
  84 uint32_t ff_opus_rc_dec_cdf(OpusRangeCoder *rc, const uint16_t *cdf);
  85 void     ff_opus_rc_enc_cdf(OpusRangeCoder *rc, int val, const uint16_t *cdf);
  86
  87 uint32_t ff_opus_rc_dec_log(OpusRangeCoder *rc, uint32_t bits);
  88 void     ff_opus_rc_enc_log(OpusRangeCoder *rc, int val, uint32_t bits);
  89
  90 uint32_t ff_opus_rc_dec_uint_step(OpusRangeCoder *rc, int k0);
  91 void     ff_opus_rc_enc_uint_step(OpusRangeCoder *rc, uint32_t val, int k0);
  92
  93 uint32_t ff_opus_rc_dec_uint_tri(OpusRangeCoder *rc, int qn);
  94 void     ff_opus_rc_enc_uint_tri(OpusRangeCoder *rc, uint32_t k, int qn);
  95
  96 uint32_t ff_opus_rc_dec_uint(OpusRangeCoder *rc, uint32_t size);
  97 void     ff_opus_rc_enc_uint(OpusRangeCoder *rc, uint32_t val, uint32_t size);
  98
  99 uint32_t ff_opus_rc_get_raw(OpusRangeCoder *rc, uint32_t count);
 100 void     ff_opus_rc_put_raw(OpusRangeCoder *rc, uint32_t val, uint32_t count);
 101
 102 int      ff_opus_rc_dec_laplace(OpusRangeCoder *rc, uint32_t symbol, int decay);
 103 void     ff_opus_rc_enc_laplace(OpusRangeCoder *rc, int *value, uint32_t symbol, int decay);
 104
 105 int      ff_opus_rc_dec_init(OpusRangeCoder *rc, const uint8_t *data, int size);
 106 void     ff_opus_rc_dec_raw_init(OpusRangeCoder *rc, const uint8_t *rightend, uint32_t bytes);
 107
 108 void     ff_opus_rc_enc_end(OpusRangeCoder *rc, uint8_t *dst, int size);
 109 void     ff_opus_rc_enc_init(OpusRangeCoder *rc);
 110
 111 #define OPUS_RC_CHECKPOINT_UPDATE(rc) \
 112     rc_rollback_bits = opus_rc_tell_frac(rc); \
 113     rc_rollback_ctx  = *rc
 114
 115 #define OPUS_RC_CHECKPOINT_SPAWN(rc) \
 116     uint32_t rc_rollback_bits = opus_rc_tell_frac(rc); \
 117     OpusRangeCoder rc_rollback_ctx = *rc \
 118
 119 #define OPUS_RC_CHECKPOINT_BITS(rc) \
 120     (opus_rc_tell_frac(rc) - rc_rollback_bits)
 121
 122 #define OPUS_RC_CHECKPOINT_ROLLBACK(rc) \
 123     memcpy(rc, &rc_rollback_ctx, sizeof(OpusRangeCoder)); \
 124
 125 #endif /* AVCODEC_OPUS_RC_H */