• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 "libavutil/opt.h"
34 #include "avcodec.h"
35 #include "internal.h"
36 #include "profiles.h"
37 #include "put_bits.h"
38 #include "sbc.h"
39 #include "sbcdsp.h"
40 
41 typedef struct SBCEncContext {
42     AVClass *class;
43     int64_t max_delay;
44     int msbc;
45     DECLARE_ALIGNED(SBC_ALIGN, struct sbc_frame, frame);
46     DECLARE_ALIGNED(SBC_ALIGN, SBCDSPContext, dsp);
47 } SBCEncContext;
48 
sbc_analyze_audio(SBCDSPContext * s,struct sbc_frame * frame)49 static int sbc_analyze_audio(SBCDSPContext *s, struct sbc_frame *frame)
50 {
51     int ch, blk;
52     int16_t *x;
53 
54     switch (frame->subbands) {
55     case 4:
56         for (ch = 0; ch < frame->channels; ch++) {
57             x = &s->X[ch][s->position - 4 *
58                     s->increment + frame->blocks * 4];
59             for (blk = 0; blk < frame->blocks;
60                         blk += s->increment) {
61                 s->sbc_analyze_4s(
62                     s, x,
63                     frame->sb_sample_f[blk][ch],
64                     frame->sb_sample_f[blk + 1][ch] -
65                     frame->sb_sample_f[blk][ch]);
66                 x -= 4 * s->increment;
67             }
68         }
69         return frame->blocks * 4;
70 
71     case 8:
72         for (ch = 0; ch < frame->channels; ch++) {
73             x = &s->X[ch][s->position - 8 *
74                     s->increment + frame->blocks * 8];
75             for (blk = 0; blk < frame->blocks;
76                         blk += s->increment) {
77                 s->sbc_analyze_8s(
78                     s, x,
79                     frame->sb_sample_f[blk][ch],
80                     frame->sb_sample_f[blk + 1][ch] -
81                     frame->sb_sample_f[blk][ch]);
82                 x -= 8 * s->increment;
83             }
84         }
85         return frame->blocks * 8;
86 
87     default:
88         return AVERROR(EIO);
89     }
90 }
91 
92 /*
93  * Packs the SBC frame from frame into the memory in avpkt.
94  * Returns the length of the packed frame.
95  */
sbc_pack_frame(AVPacket * avpkt,struct sbc_frame * frame,int joint,int msbc)96 static size_t sbc_pack_frame(AVPacket *avpkt, struct sbc_frame *frame,
97                              int joint, int msbc)
98 {
99     PutBitContext pb;
100 
101     /* Will copy the header parts for CRC-8 calculation here */
102     uint8_t crc_header[11] = { 0 };
103     int crc_pos;
104 
105     uint32_t audio_sample;
106 
107     int ch, sb, blk;        /* channel, subband, block and bit counters */
108     int bits[2][8];         /* bits distribution */
109     uint32_t levels[2][8];  /* levels are derived from that */
110     uint32_t sb_sample_delta[2][8];
111 
112     if (msbc) {
113         avpkt->data[0] = MSBC_SYNCWORD;
114         avpkt->data[1] = 0;
115         avpkt->data[2] = 0;
116     } else {
117         avpkt->data[0] = SBC_SYNCWORD;
118 
119         avpkt->data[1]  = (frame->frequency           & 0x03) << 6;
120         avpkt->data[1] |= (((frame->blocks >> 2) - 1) & 0x03) << 4;
121         avpkt->data[1] |= (frame->mode                & 0x03) << 2;
122         avpkt->data[1] |= (frame->allocation          & 0x01) << 1;
123         avpkt->data[1] |= ((frame->subbands == 8)     & 0x01) << 0;
124 
125         avpkt->data[2] = frame->bitpool;
126 
127         if (frame->bitpool > frame->subbands << (4 + (frame->mode == STEREO
128                                                    || frame->mode == JOINT_STEREO)))
129             return -5;
130     }
131 
132     /* Can't fill in crc yet */
133     crc_header[0] = avpkt->data[1];
134     crc_header[1] = avpkt->data[2];
135     crc_pos = 16;
136 
137     init_put_bits(&pb, avpkt->data + 4, avpkt->size);
138 
139     if (frame->mode == JOINT_STEREO) {
140         put_bits(&pb, frame->subbands, joint);
141         crc_header[crc_pos >> 3] = joint;
142         crc_pos += frame->subbands;
143     }
144 
145     for (ch = 0; ch < frame->channels; ch++) {
146         for (sb = 0; sb < frame->subbands; sb++) {
147             put_bits(&pb, 4, frame->scale_factor[ch][sb] & 0x0F);
148             crc_header[crc_pos >> 3] <<= 4;
149             crc_header[crc_pos >> 3] |= frame->scale_factor[ch][sb] & 0x0F;
150             crc_pos += 4;
151         }
152     }
153 
154     /* align the last crc byte */
155     if (crc_pos % 8)
156         crc_header[crc_pos >> 3] <<= 8 - (crc_pos % 8);
157 
158     avpkt->data[3] = ff_sbc_crc8(frame->crc_ctx, crc_header, crc_pos);
159 
160     ff_sbc_calculate_bits(frame, bits);
161 
162     for (ch = 0; ch < frame->channels; ch++) {
163         for (sb = 0; sb < frame->subbands; sb++) {
164             levels[ch][sb] = ((1 << bits[ch][sb]) - 1) <<
165                 (32 - (frame->scale_factor[ch][sb] +
166                     SCALE_OUT_BITS + 2));
167             sb_sample_delta[ch][sb] = (uint32_t) 1 <<
168                 (frame->scale_factor[ch][sb] +
169                     SCALE_OUT_BITS + 1);
170         }
171     }
172 
173     for (blk = 0; blk < frame->blocks; blk++) {
174         for (ch = 0; ch < frame->channels; ch++) {
175             for (sb = 0; sb < frame->subbands; sb++) {
176 
177                 if (bits[ch][sb] == 0)
178                     continue;
179 
180                 audio_sample = ((uint64_t) levels[ch][sb] *
181                     (sb_sample_delta[ch][sb] +
182                     frame->sb_sample_f[blk][ch][sb])) >> 32;
183 
184                 put_bits(&pb, bits[ch][sb], audio_sample);
185             }
186         }
187     }
188 
189     flush_put_bits(&pb);
190 
191     return (put_bits_count(&pb) + 7) / 8;
192 }
193 
sbc_encode_init(AVCodecContext * avctx)194 static int sbc_encode_init(AVCodecContext *avctx)
195 {
196     SBCEncContext *sbc = avctx->priv_data;
197     struct sbc_frame *frame = &sbc->frame;
198 
199     if (avctx->profile == FF_PROFILE_SBC_MSBC)
200         sbc->msbc = 1;
201 
202     if (sbc->msbc) {
203         if (avctx->channels != 1) {
204             av_log(avctx, AV_LOG_ERROR, "mSBC require mono channel.\n");
205             return AVERROR(EINVAL);
206         }
207 
208         if (avctx->sample_rate != 16000) {
209             av_log(avctx, AV_LOG_ERROR, "mSBC require 16 kHz samplerate.\n");
210             return AVERROR(EINVAL);
211         }
212 
213         frame->mode = SBC_MODE_MONO;
214         frame->subbands = 8;
215         frame->blocks = MSBC_BLOCKS;
216         frame->allocation = SBC_AM_LOUDNESS;
217         frame->bitpool = 26;
218 
219         avctx->frame_size = 8 * MSBC_BLOCKS;
220     } else {
221         int d;
222 
223         if (avctx->global_quality > 255*FF_QP2LAMBDA) {
224             av_log(avctx, AV_LOG_ERROR, "bitpool > 255 is not allowed.\n");
225             return AVERROR(EINVAL);
226         }
227 
228         if (avctx->channels == 1) {
229             frame->mode = SBC_MODE_MONO;
230             if (sbc->max_delay <= 3000 || avctx->bit_rate > 270000)
231                 frame->subbands = 4;
232             else
233                 frame->subbands = 8;
234         } else {
235             if (avctx->bit_rate < 180000 || avctx->bit_rate > 420000)
236                 frame->mode = SBC_MODE_JOINT_STEREO;
237             else
238                 frame->mode = SBC_MODE_STEREO;
239             if (sbc->max_delay <= 4000 || avctx->bit_rate > 420000)
240                 frame->subbands = 4;
241             else
242                 frame->subbands = 8;
243         }
244         /* sbc algorithmic delay is ((blocks + 10) * subbands - 2) / sample_rate */
245         frame->blocks = av_clip(((sbc->max_delay * avctx->sample_rate + 2)
246                                / (1000000 * frame->subbands)) - 10, 4, 16) & ~3;
247 
248         frame->allocation = SBC_AM_LOUDNESS;
249 
250         d = frame->blocks * ((frame->mode == SBC_MODE_DUAL_CHANNEL) + 1);
251         frame->bitpool = (((avctx->bit_rate * frame->subbands * frame->blocks) / avctx->sample_rate)
252                           - 4 * frame->subbands * avctx->channels
253                           - (frame->mode == SBC_MODE_JOINT_STEREO)*frame->subbands - 32 + d/2) / d;
254         if (avctx->global_quality > 0)
255             frame->bitpool = avctx->global_quality / FF_QP2LAMBDA;
256 
257         avctx->frame_size = 4*((frame->subbands >> 3) + 1) * 4*(frame->blocks >> 2);
258     }
259 
260     for (int i = 0; avctx->codec->supported_samplerates[i]; i++)
261         if (avctx->sample_rate == avctx->codec->supported_samplerates[i])
262             frame->frequency = i;
263 
264     frame->channels = avctx->channels;
265     frame->codesize = frame->subbands * frame->blocks * avctx->channels * 2;
266     frame->crc_ctx = av_crc_get_table(AV_CRC_8_EBU);
267 
268     memset(&sbc->dsp.X, 0, sizeof(sbc->dsp.X));
269     sbc->dsp.position = (SBC_X_BUFFER_SIZE - frame->subbands * 9) & ~7;
270     sbc->dsp.increment = sbc->msbc ? 1 : 4;
271     ff_sbcdsp_init(&sbc->dsp);
272 
273     return 0;
274 }
275 
sbc_encode_frame(AVCodecContext * avctx,AVPacket * avpkt,const AVFrame * av_frame,int * got_packet_ptr)276 static int sbc_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
277                             const AVFrame *av_frame, int *got_packet_ptr)
278 {
279     SBCEncContext *sbc = avctx->priv_data;
280     struct sbc_frame *frame = &sbc->frame;
281     uint8_t joint = frame->mode == SBC_MODE_JOINT_STEREO;
282     uint8_t dual  = frame->mode == SBC_MODE_DUAL_CHANNEL;
283     int ret, j = 0;
284 
285     int frame_length = 4 + (4 * frame->subbands * frame->channels) / 8
286                      + ((frame->blocks * frame->bitpool * (1 + dual)
287                      + joint * frame->subbands) + 7) / 8;
288 
289     /* input must be large enough to encode a complete frame */
290     if (av_frame->nb_samples * frame->channels * 2 < frame->codesize)
291         return 0;
292 
293     if ((ret = ff_alloc_packet2(avctx, avpkt, frame_length, 0)) < 0)
294         return ret;
295 
296     /* Select the needed input data processing function and call it */
297     if (frame->subbands == 8)
298         sbc->dsp.position = sbc->dsp.sbc_enc_process_input_8s(
299                 sbc->dsp.position, av_frame->data[0], sbc->dsp.X,
300                 frame->subbands * frame->blocks, frame->channels);
301     else
302         sbc->dsp.position = sbc->dsp.sbc_enc_process_input_4s(
303                 sbc->dsp.position, av_frame->data[0], sbc->dsp.X,
304                 frame->subbands * frame->blocks, frame->channels);
305 
306     sbc_analyze_audio(&sbc->dsp, &sbc->frame);
307 
308     if (frame->mode == JOINT_STEREO)
309         j = sbc->dsp.sbc_calc_scalefactors_j(frame->sb_sample_f,
310                                              frame->scale_factor,
311                                              frame->blocks,
312                                              frame->subbands);
313     else
314         sbc->dsp.sbc_calc_scalefactors(frame->sb_sample_f,
315                                        frame->scale_factor,
316                                        frame->blocks,
317                                        frame->channels,
318                                        frame->subbands);
319     emms_c();
320     sbc_pack_frame(avpkt, frame, j, sbc->msbc);
321 
322     *got_packet_ptr = 1;
323     return 0;
324 }
325 
326 #define OFFSET(x) offsetof(SBCEncContext, x)
327 #define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
328 static const AVOption options[] = {
329     { "sbc_delay", "set maximum algorithmic latency",
330       OFFSET(max_delay), AV_OPT_TYPE_DURATION, {.i64 = 13000}, 1000,13000, AE },
331     { "msbc",      "use mSBC mode (wideband speech mono SBC)",
332       OFFSET(msbc),      AV_OPT_TYPE_BOOL,     {.i64 = 0},        0,    1, AE },
333     FF_AVCTX_PROFILE_OPTION("msbc", NULL, AUDIO, FF_PROFILE_SBC_MSBC)
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 };
362