opus/dnn/dred_decoder.c

/* Copyright (c) 2022 Amazon
   Written by Jan Buethe */
/*
   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

   - Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

   - 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 OWNER
   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.
*/

#include <string.h>

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "os_support.h"
#include "dred_decoder.h"
#include "dred_coding.h"
#include "celt/entdec.h"
#include "celt/laplace.h"
#include "dred_rdovae_stats_data.h"
#include "dred_rdovae_constants.h"

static void dred_decode_latents(ec_dec *dec, float *x, const opus_uint8 *scale, const opus_uint8 *r, const opus_uint8 *p0, int dim) {
    int i;
    for (i=0;i<dim;i++) {
        int q;
        if (r[i] == 0 || p0[i] == 255) q = 0;
        else q = ec_laplace_decode_p0(dec, p0[i]<<7, r[i]<<7);
        x[i] = q*256.f/(scale[i] == 0 ? 1 : scale[i]);
    }
}

int dred_ec_decode(OpusDRED *dec, const opus_uint8 *bytes, int num_bytes, int min_feature_frames, int dred_frame_offset)
{
  ec_dec ec;
  int q_level;
  int i;
  int offset;
  int q0;
  int dQ;
  int qmax;
  int state_qoffset;
  int extra_offset;

  /* since features are decoded in quadruples, it makes no sense to go with an uneven number of redundancy frames */
  celt_assert(DRED_NUM_REDUNDANCY_FRAMES % 2 == 0);

  /* decode initial state and initialize RDOVAE decoder */
  ec_dec_init(&ec, (unsigned char*)bytes, num_bytes);
  q0 = ec_dec_uint(&ec, 16);
  dQ = ec_dec_uint(&ec, 8);
  if (ec_dec_uint(&ec, 2)) extra_offset = 32*ec_dec_uint(&ec, 256);
  else extra_offset = 0;
  /* Compute total offset, including DRED position in a multiframe packet. */
  dec->dred_offset = 16 - ec_dec_uint(&ec, 32) - extra_offset + dred_frame_offset;
  /*printf("%d %d %d\n", dred_offset, q0, dQ);*/
  qmax = 15;
  if (q0 < 14 && dQ > 0) {
    int nvals;
    int ft;
    int s;
    /* The distribution for the dQmax symbol is split evenly between zero
        (which implies qmax == 15) and larger values, with the probability of
        all larger values being uniform.
       This is equivalent to coding 1 bit to decide if the maximum is less than
        15 followed by a uint to decide the actual value if it is less than
        15, but combined into a single symbol. */
    nvals = 15 - (q0 + 1);
    ft = 2*nvals;
    s = ec_decode(&ec, ft);
    if (s >= nvals) {
      qmax = q0 + (s - nvals) + 1;
      ec_dec_update(&ec, s, s + 1, ft);
    }
    else {
      ec_dec_update(&ec, 0, nvals, ft);
    }
  }
  state_qoffset = q0*DRED_STATE_DIM;
  dred_decode_latents(
      &ec,
      dec->state,
      dred_state_quant_scales_q8 + state_qoffset,
      dred_state_r_q8 + state_qoffset,
      dred_state_p0_q8 + state_qoffset,
      DRED_STATE_DIM);

  /* decode newest to oldest and store oldest to newest */
  for (i = 0; i < IMIN(DRED_NUM_REDUNDANCY_FRAMES, (min_feature_frames+1)/2); i += 2)
  {
      /* FIXME: Figure out how to avoid missing a last frame that would take up < 8 bits. */
      if (8*num_bytes - ec_tell(&ec) <= 7)
         break;
      q_level = compute_quantizer(q0, dQ, qmax, i/2);
      offset = q_level*DRED_LATENT_DIM;
      dred_decode_latents(
          &ec,
          &dec->latents[(i/2)*DRED_LATENT_DIM],
          dred_latent_quant_scales_q8 + offset,
          dred_latent_r_q8 + offset,
          dred_latent_p0_q8 + offset,
          DRED_LATENT_DIM
          );

      offset = 2 * i * DRED_NUM_FEATURES;
  }
  dec->process_stage = 1;
  dec->nb_latents = i/2;
  return i/2;
}