git.sesse.net Git - ffmpeg/blob - libavcodec/sbcenc.c

   1 /*
   2  * Bluetooth low-complexity, subband codec (SBC)
   3  *
   4  * Copyright (C) 2017  Aurelien Jacobs <aurel@gnuage.org>
   5  * Copyright (C) 2012-2013  Intel Corporation
   6  * Copyright (C) 2008-2010  Nokia Corporation
   7  * Copyright (C) 2004-2010  Marcel Holtmann <marcel@holtmann.org>
   8  * Copyright (C) 2004-2005  Henryk Ploetz <henryk@ploetzli.ch>
   9  * Copyright (C) 2005-2008  Brad Midgley <bmidgley@xmission.com>
  10  *
  11  * This file is part of FFmpeg.
  12  *
  13  * FFmpeg is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU Lesser General Public
  15  * License as published by the Free Software Foundation; either
  16  * version 2.1 of the License, or (at your option) any later version.
  17  *
  18  * FFmpeg is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21  * Lesser General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU Lesser General Public
  24  * License along with FFmpeg; if not, write to the Free Software
  25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  26  */
  27
  28 /**
  29  * @file
  30  * SBC encoder implementation
  31  */
  32
  33 #include <stdbool.h>
  34 #include "libavutil/opt.h"
  35 #include "avcodec.h"
  36 #include "internal.h"
  37 #include "profiles.h"
  38 #include "put_bits.h"
  39 #include "sbc.h"
  40 #include "sbcdsp.h"
  41
  42 typedef struct SBCEncContext {
  43     AVClass *class;
  44     int64_t max_delay;
  45     int msbc;
  46     DECLARE_ALIGNED(SBC_ALIGN, struct sbc_frame, frame);
  47     DECLARE_ALIGNED(SBC_ALIGN, SBCDSPContext, dsp);
  48 } SBCEncContext;
  49
  50 static int sbc_analyze_audio(SBCDSPContext *s, struct sbc_frame *frame)
  51 {
  52     int ch, blk;
  53     int16_t *x;
  54
  55     switch (frame->subbands) {
  56     case 4:
  57         for (ch = 0; ch < frame->channels; ch++) {
  58             x = &s->X[ch][s->position - 4 *
  59                     s->increment + frame->blocks * 4];
  60             for (blk = 0; blk < frame->blocks;
  61                         blk += s->increment) {
  62                 s->sbc_analyze_4s(
  63                     s, x,
  64                     frame->sb_sample_f[blk][ch],
  65                     frame->sb_sample_f[blk + 1][ch] -
  66                     frame->sb_sample_f[blk][ch]);
  67                 x -= 4 * s->increment;
  68             }
  69         }
  70         return frame->blocks * 4;
  71
  72     case 8:
  73         for (ch = 0; ch < frame->channels; ch++) {
  74             x = &s->X[ch][s->position - 8 *
  75                     s->increment + frame->blocks * 8];
  76             for (blk = 0; blk < frame->blocks;
  77                         blk += s->increment) {
  78                 s->sbc_analyze_8s(
  79                     s, x,
  80                     frame->sb_sample_f[blk][ch],
  81                     frame->sb_sample_f[blk + 1][ch] -
  82                     frame->sb_sample_f[blk][ch]);
  83                 x -= 8 * s->increment;
  84             }
  85         }
  86         return frame->blocks * 8;
  87
  88     default:
  89         return AVERROR(EIO);
  90     }
  91 }
  92
  93 /*
  94  * Packs the SBC frame from frame into the memory in avpkt.
  95  * Returns the length of the packed frame.
  96  */
  97 static size_t sbc_pack_frame(AVPacket *avpkt, struct sbc_frame *frame,
  98                              int joint, bool msbc)
  99 {
 100     PutBitContext pb;
 101
 102     /* Will copy the header parts for CRC-8 calculation here */
 103     uint8_t crc_header[11] = { 0 };
 104     int crc_pos;
 105
 106     uint32_t audio_sample;
 107
 108     int ch, sb, blk;        /* channel, subband, block and bit counters */
 109     int bits[2][8];         /* bits distribution */
 110     uint32_t levels[2][8];  /* levels are derived from that */
 111     uint32_t sb_sample_delta[2][8];
 112
 113     if (msbc) {
 114         avpkt->data[0] = MSBC_SYNCWORD;
 115         avpkt->data[1] = 0;
 116         avpkt->data[2] = 0;
 117     } else {
 118         avpkt->data[0] = SBC_SYNCWORD;
 119
 120         avpkt->data[1]  = (frame->frequency           & 0x03) << 6;
 121         avpkt->data[1] |= (((frame->blocks >> 2) - 1) & 0x03) << 4;
 122         avpkt->data[1] |= (frame->mode                & 0x03) << 2;
 123         avpkt->data[1] |= (frame->allocation          & 0x01) << 1;
 124         avpkt->data[1] |= ((frame->subbands == 8)     & 0x01) << 0;
 125
 126         avpkt->data[2] = frame->bitpool;
 127
 128         if (frame->bitpool > frame->subbands << (4 + (frame->mode == STEREO
 129                                                    || frame->mode == JOINT_STEREO)))
 130             return -5;
 131     }
 132
 133     /* Can't fill in crc yet */
 134     crc_header[0] = avpkt->data[1];
 135     crc_header[1] = avpkt->data[2];
 136     crc_pos = 16;
 137
 138     init_put_bits(&pb, avpkt->data + 4, avpkt->size);
 139
 140     if (frame->mode == JOINT_STEREO) {
 141         put_bits(&pb, frame->subbands, joint);
 142         crc_header[crc_pos >> 3] = joint;
 143         crc_pos += frame->subbands;
 144     }
 145
 146     for (ch = 0; ch < frame->channels; ch++) {
 147         for (sb = 0; sb < frame->subbands; sb++) {
 148             put_bits(&pb, 4, frame->scale_factor[ch][sb] & 0x0F);
 149             crc_header[crc_pos >> 3] <<= 4;
 150             crc_header[crc_pos >> 3] |= frame->scale_factor[ch][sb] & 0x0F;
 151             crc_pos += 4;
 152         }
 153     }
 154
 155     /* align the last crc byte */
 156     if (crc_pos % 8)
 157         crc_header[crc_pos >> 3] <<= 8 - (crc_pos % 8);
 158
 159     avpkt->data[3] = ff_sbc_crc8(frame->crc_ctx, crc_header, crc_pos);
 160
 161     ff_sbc_calculate_bits(frame, bits);
 162
 163     for (ch = 0; ch < frame->channels; ch++) {
 164         for (sb = 0; sb < frame->subbands; sb++) {
 165             levels[ch][sb] = ((1 << bits[ch][sb]) - 1) <<
 166                 (32 - (frame->scale_factor[ch][sb] +
 167                     SCALE_OUT_BITS + 2));
 168             sb_sample_delta[ch][sb] = (uint32_t) 1 <<
 169                 (frame->scale_factor[ch][sb] +
 170                     SCALE_OUT_BITS + 1);
 171         }
 172     }
 173
 174     for (blk = 0; blk < frame->blocks; blk++) {
 175         for (ch = 0; ch < frame->channels; ch++) {
 176             for (sb = 0; sb < frame->subbands; sb++) {
 177
 178                 if (bits[ch][sb] == 0)
 179                     continue;
 180
 181                 audio_sample = ((uint64_t) levels[ch][sb] *
 182                     (sb_sample_delta[ch][sb] +
 183                     frame->sb_sample_f[blk][ch][sb])) >> 32;
 184
 185                 put_bits(&pb, bits[ch][sb], audio_sample);
 186             }
 187         }
 188     }
 189
 190     flush_put_bits(&pb);
 191
 192     return (put_bits_count(&pb) + 7) / 8;
 193 }
 194
 195 static int sbc_encode_init(AVCodecContext *avctx)
 196 {
 197     SBCEncContext *sbc = avctx->priv_data;
 198     struct sbc_frame *frame = &sbc->frame;
 199
 200     if (avctx->profile == FF_PROFILE_SBC_MSBC)
 201         sbc->msbc = 1;
 202
 203     if (sbc->msbc) {
 204         if (avctx->channels != 1) {
 205             av_log(avctx, AV_LOG_ERROR, "mSBC require mono channel.\n");
 206             return AVERROR(EINVAL);
 207         }
 208
 209         if (avctx->sample_rate != 16000) {
 210             av_log(avctx, AV_LOG_ERROR, "mSBC require 16 kHz samplerate.\n");
 211             return AVERROR(EINVAL);
 212         }
 213
 214         frame->mode = SBC_MODE_MONO;
 215         frame->subbands = 8;
 216         frame->blocks = MSBC_BLOCKS;
 217         frame->allocation = SBC_AM_LOUDNESS;
 218         frame->bitpool = 26;
 219
 220         avctx->frame_size = 8 * MSBC_BLOCKS;
 221     } else {
 222         int d;
 223
 224         if (avctx->global_quality > 255*FF_QP2LAMBDA) {
 225             av_log(avctx, AV_LOG_ERROR, "bitpool > 255 is not allowed.\n");
 226             return AVERROR(EINVAL);
 227         }
 228
 229         if (avctx->channels == 1) {
 230             frame->mode = SBC_MODE_MONO;
 231             if (sbc->max_delay <= 3000 || avctx->bit_rate > 270000)
 232                 frame->subbands = 4;
 233             else
 234                 frame->subbands = 8;
 235         } else {
 236             if (avctx->bit_rate < 180000 || avctx->bit_rate > 420000)
 237                 frame->mode = SBC_MODE_JOINT_STEREO;
 238             else
 239                 frame->mode = SBC_MODE_STEREO;
 240             if (sbc->max_delay <= 4000 || avctx->bit_rate > 420000)
 241                 frame->subbands = 4;
 242             else
 243                 frame->subbands = 8;
 244         }
 245         /* sbc algorithmic delay is ((blocks + 10) * subbands - 2) / sample_rate */
 246         frame->blocks = av_clip(((sbc->max_delay * avctx->sample_rate + 2)
 247                                / (1000000 * frame->subbands)) - 10, 4, 16) & ~3;
 248
 249         frame->allocation = SBC_AM_LOUDNESS;
 250
 251         d = frame->blocks * ((frame->mode == SBC_MODE_DUAL_CHANNEL) + 1);
 252         frame->bitpool = (((avctx->bit_rate * frame->subbands * frame->blocks) / avctx->sample_rate)
 253                           - 4 * frame->subbands * avctx->channels
 254                           - (frame->mode == SBC_MODE_JOINT_STEREO)*frame->subbands - 32 + d/2) / d;
 255         if (avctx->global_quality > 0)
 256             frame->bitpool = avctx->global_quality / FF_QP2LAMBDA;
 257
 258         avctx->frame_size = 4*((frame->subbands >> 3) + 1) * 4*(frame->blocks >> 2);
 259     }
 260
 261     for (int i = 0; avctx->codec->supported_samplerates[i]; i++)
 262         if (avctx->sample_rate == avctx->codec->supported_samplerates[i])
 263             frame->frequency = i;
 264
 265     frame->channels = avctx->channels;
 266     frame->codesize = frame->subbands * frame->blocks * avctx->channels * 2;
 267     frame->crc_ctx = av_crc_get_table(AV_CRC_8_EBU);
 268
 269     memset(&sbc->dsp.X, 0, sizeof(sbc->dsp.X));
 270     sbc->dsp.position = (SBC_X_BUFFER_SIZE - frame->subbands * 9) & ~7;
 271     sbc->dsp.increment = sbc->msbc ? 1 : 4;
 272     ff_sbcdsp_init(&sbc->dsp);
 273
 274     return 0;
 275 }
 276
 277 static int sbc_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
 278                             const AVFrame *av_frame, int *got_packet_ptr)
 279 {
 280     SBCEncContext *sbc = avctx->priv_data;
 281     struct sbc_frame *frame = &sbc->frame;
 282     uint8_t joint = frame->mode == SBC_MODE_JOINT_STEREO;
 283     uint8_t dual  = frame->mode == SBC_MODE_DUAL_CHANNEL;
 284     int ret, j = 0;
 285
 286     int frame_length = 4 + (4 * frame->subbands * frame->channels) / 8
 287                      + ((frame->blocks * frame->bitpool * (1 + dual)
 288                      + joint * frame->subbands) + 7) / 8;
 289
 290     /* input must be large enough to encode a complete frame */
 291     if (av_frame->nb_samples * frame->channels * 2 < frame->codesize)
 292         return 0;
 293
 294     if ((ret = ff_alloc_packet2(avctx, avpkt, frame_length, 0)) < 0)
 295         return ret;
 296
 297     /* Select the needed input data processing function and call it */
 298     if (frame->subbands == 8)
 299         sbc->dsp.position = sbc->dsp.sbc_enc_process_input_8s(
 300                 sbc->dsp.position, av_frame->data[0], sbc->dsp.X,
 301                 frame->subbands * frame->blocks, frame->channels);
 302     else
 303         sbc->dsp.position = sbc->dsp.sbc_enc_process_input_4s(
 304                 sbc->dsp.position, av_frame->data[0], sbc->dsp.X,
 305                 frame->subbands * frame->blocks, frame->channels);
 306
 307     sbc_analyze_audio(&sbc->dsp, &sbc->frame);
 308
 309     if (frame->mode == JOINT_STEREO)
 310         j = sbc->dsp.sbc_calc_scalefactors_j(frame->sb_sample_f,
 311                                              frame->scale_factor,
 312                                              frame->blocks,
 313                                              frame->subbands);
 314     else
 315         sbc->dsp.sbc_calc_scalefactors(frame->sb_sample_f,
 316                                        frame->scale_factor,
 317                                        frame->blocks,
 318                                        frame->channels,
 319                                        frame->subbands);
 320     emms_c();
 321     sbc_pack_frame(avpkt, frame, j, sbc->msbc);
 322
 323     *got_packet_ptr = 1;
 324     return 0;
 325 }
 326
 327 #define OFFSET(x) offsetof(SBCEncContext, x)
 328 #define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 329 static const AVOption options[] = {
 330     { "sbc_delay", "set maximum algorithmic latency",
 331       OFFSET(max_delay), AV_OPT_TYPE_DURATION, {.i64 = 13000}, 1000,13000, AE },
 332     { "msbc",      "use mSBC mode (wideband speech mono SBC)",
 333       OFFSET(msbc),      AV_OPT_TYPE_BOOL,     {.i64 = 0},        0,    1, AE },
 334     { NULL },
 335 };
 336
 337 static const AVClass sbc_class = {
 338     .class_name = "sbc encoder",
 339     .item_name  = av_default_item_name,
 340     .option     = options,
 341     .version    = LIBAVUTIL_VERSION_INT,
 342 };
 343
 344 AVCodec ff_sbc_encoder = {
 345     .name                  = "sbc",
 346     .long_name             = NULL_IF_CONFIG_SMALL("SBC (low-complexity subband codec)"),
 347     .type                  = AVMEDIA_TYPE_AUDIO,
 348     .id                    = AV_CODEC_ID_SBC,
 349     .priv_data_size        = sizeof(SBCEncContext),
 350     .init                  = sbc_encode_init,
 351     .encode2               = sbc_encode_frame,
 352     .capabilities          = AV_CODEC_CAP_SMALL_LAST_FRAME,
 353     .caps_internal         = FF_CODEC_CAP_INIT_THREADSAFE,
 354     .channel_layouts       = (const uint64_t[]) { AV_CH_LAYOUT_MONO,
 355                                                   AV_CH_LAYOUT_STEREO, 0},
 356     .sample_fmts           = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_S16,
 357                                                              AV_SAMPLE_FMT_NONE },
 358     .supported_samplerates = (const int[]) { 16000, 32000, 44100, 48000, 0 },
 359     .priv_class            = &sbc_class,
 360     .profiles              = NULL_IF_CONFIG_SMALL(ff_sbc_profiles),
 361 };