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

   1 /*
   2  * Copyright (C) 2009 Justin Ruggles
   3  * Copyright (c) 2009 Xuggle Incorporated
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 /**
  23  * @file
  24  * libspeex Speex audio encoder
  25  *
  26  * Usage Guide
  27  * This explains the values that need to be set prior to initialization in
  28  * order to control various encoding parameters.
  29  *
  30  * Channels
  31  *     Speex only supports mono or stereo, so avctx->channels must be set to
  32  *     1 or 2.
  33  *
  34  * Sample Rate / Encoding Mode
  35  *     Speex has 3 modes, each of which uses a specific sample rate.
  36  *         narrowband     :  8 kHz
  37  *         wideband       : 16 kHz
  38  *         ultra-wideband : 32 kHz
  39  *     avctx->sample_rate must be set to one of these 3 values.  This will be
  40  *     used to set the encoding mode.
  41  *
  42  * Rate Control
  43  *     VBR mode is turned on by setting CODEC_FLAG_QSCALE in avctx->flags.
  44  *     avctx->global_quality is used to set the encoding quality.
  45  *     For CBR mode, avctx->bit_rate can be used to set the constant bitrate.
  46  *     Alternatively, the 'cbr_quality' option can be set from 0 to 10 to set
  47  *     a constant bitrate based on quality.
  48  *     For ABR mode, set avctx->bit_rate and set the 'abr' option to 1.
  49  *     Approx. Bitrate Range:
  50  *         narrowband     : 2400 - 25600 bps
  51  *         wideband       : 4000 - 43200 bps
  52  *         ultra-wideband : 4400 - 45200 bps
  53  *
  54  * Complexity
  55  *     Encoding complexity is controlled by setting avctx->compression_level.
  56  *     The valid range is 0 to 10.  A higher setting gives generally better
  57  *     quality at the expense of encoding speed.  This does not affect the
  58  *     bit rate.
  59  *
  60  * Frames-per-Packet
  61  *     The encoder defaults to using 1 frame-per-packet.  However, it is
  62  *     sometimes desirable to use multiple frames-per-packet to reduce the
  63  *     amount of container overhead.  This can be done by setting the
  64  *     'frames_per_packet' option to a value 1 to 8.
  65  */
  66
  67 #include <speex/speex.h>
  68 #include <speex/speex_header.h>
  69 #include <speex/speex_stereo.h>
  70 #include "libavutil/mathematics.h"
  71 #include "libavutil/opt.h"
  72 #include "avcodec.h"
  73 #include "internal.h"
  74
  75 typedef struct {
  76     AVClass *class;             ///< AVClass for private options
  77     SpeexBits bits;             ///< libspeex bitwriter context
  78     SpeexHeader header;         ///< libspeex header struct
  79     void *enc_state;            ///< libspeex encoder state
  80     int frames_per_packet;      ///< number of frames to encode in each packet
  81     float vbr_quality;          ///< VBR quality 0.0 to 10.0
  82     int cbr_quality;            ///< CBR quality 0 to 10
  83     int abr;                    ///< flag to enable ABR
  84     int pkt_frame_count;        ///< frame count for the current packet
  85     int lookahead;              ///< encoder delay
  86     int64_t next_pts;           ///< next pts, in sample_rate time base
  87     int pkt_sample_count;       ///< sample count in the current packet
  88 } LibSpeexEncContext;
  89
  90 static av_cold void print_enc_params(AVCodecContext *avctx,
  91                                      LibSpeexEncContext *s)
  92 {
  93     const char *mode_str = "unknown";
  94
  95     av_log(avctx, AV_LOG_DEBUG, "channels: %d\n", avctx->channels);
  96     switch (s->header.mode) {
  97     case SPEEX_MODEID_NB:  mode_str = "narrowband";     break;
  98     case SPEEX_MODEID_WB:  mode_str = "wideband";       break;
  99     case SPEEX_MODEID_UWB: mode_str = "ultra-wideband"; break;
 100     }
 101     av_log(avctx, AV_LOG_DEBUG, "mode: %s\n", mode_str);
 102     if (s->header.vbr) {
 103         av_log(avctx, AV_LOG_DEBUG, "rate control: VBR\n");
 104         av_log(avctx, AV_LOG_DEBUG, "  quality: %f\n", s->vbr_quality);
 105     } else if (s->abr) {
 106         av_log(avctx, AV_LOG_DEBUG, "rate control: ABR\n");
 107         av_log(avctx, AV_LOG_DEBUG, "  bitrate: %d bps\n", avctx->bit_rate);
 108     } else {
 109         av_log(avctx, AV_LOG_DEBUG, "rate control: CBR\n");
 110         av_log(avctx, AV_LOG_DEBUG, "  bitrate: %d bps\n", avctx->bit_rate);
 111     }
 112     av_log(avctx, AV_LOG_DEBUG, "complexity: %d\n",
 113            avctx->compression_level);
 114     av_log(avctx, AV_LOG_DEBUG, "frame size: %d samples\n",
 115            avctx->frame_size);
 116     av_log(avctx, AV_LOG_DEBUG, "frames per packet: %d\n",
 117            s->frames_per_packet);
 118     av_log(avctx, AV_LOG_DEBUG, "packet size: %d\n",
 119            avctx->frame_size * s->frames_per_packet);
 120 }
 121
 122 static av_cold int encode_init(AVCodecContext *avctx)
 123 {
 124     LibSpeexEncContext *s = avctx->priv_data;
 125     const SpeexMode *mode;
 126     uint8_t *header_data;
 127     int header_size;
 128     int32_t complexity;
 129
 130     /* channels */
 131     if (avctx->channels < 1 || avctx->channels > 2) {
 132         av_log(avctx, AV_LOG_ERROR, "Invalid channels (%d). Only stereo and "
 133                "mono are supported\n", avctx->channels);
 134         return AVERROR(EINVAL);
 135     }
 136
 137     /* sample rate and encoding mode */
 138     switch (avctx->sample_rate) {
 139     case  8000: mode = &speex_nb_mode;  break;
 140     case 16000: mode = &speex_wb_mode;  break;
 141     case 32000: mode = &speex_uwb_mode; break;
 142     default:
 143         av_log(avctx, AV_LOG_ERROR, "Sample rate of %d Hz is not supported. "
 144                "Resample to 8, 16, or 32 kHz.\n", avctx->sample_rate);
 145         return AVERROR(EINVAL);
 146     }
 147
 148     /* initialize libspeex */
 149     s->enc_state = speex_encoder_init(mode);
 150     if (!s->enc_state) {
 151         av_log(avctx, AV_LOG_ERROR, "Error initializing libspeex\n");
 152         return -1;
 153     }
 154     speex_init_header(&s->header, avctx->sample_rate, avctx->channels, mode);
 155
 156     /* rate control method and parameters */
 157     if (avctx->flags & CODEC_FLAG_QSCALE) {
 158         /* VBR */
 159         s->header.vbr = 1;
 160         speex_encoder_ctl(s->enc_state, SPEEX_SET_VBR, &s->header.vbr);
 161         s->vbr_quality = av_clipf(avctx->global_quality / (float)FF_QP2LAMBDA,
 162                                   0.0f, 10.0f);
 163         speex_encoder_ctl(s->enc_state, SPEEX_SET_VBR_QUALITY, &s->vbr_quality);
 164     } else {
 165         s->header.bitrate = avctx->bit_rate;
 166         if (avctx->bit_rate > 0) {
 167             /* CBR or ABR by bitrate */
 168             if (s->abr) {
 169                 speex_encoder_ctl(s->enc_state, SPEEX_SET_ABR,
 170                                   &s->header.bitrate);
 171                 speex_encoder_ctl(s->enc_state, SPEEX_GET_ABR,
 172                                   &s->header.bitrate);
 173             } else {
 174                 speex_encoder_ctl(s->enc_state, SPEEX_SET_BITRATE,
 175                                   &s->header.bitrate);
 176                 speex_encoder_ctl(s->enc_state, SPEEX_GET_BITRATE,
 177                                   &s->header.bitrate);
 178             }
 179         } else {
 180             /* CBR by quality */
 181             speex_encoder_ctl(s->enc_state, SPEEX_SET_QUALITY,
 182                               &s->cbr_quality);
 183             speex_encoder_ctl(s->enc_state, SPEEX_GET_BITRATE,
 184                               &s->header.bitrate);
 185         }
 186         /* stereo side information adds about 800 bps to the base bitrate */
 187         /* TODO: this should be calculated exactly */
 188         avctx->bit_rate = s->header.bitrate + (avctx->channels == 2 ? 800 : 0);
 189     }
 190
 191     /* set encoding complexity */
 192     if (avctx->compression_level > FF_COMPRESSION_DEFAULT) {
 193         complexity = av_clip(avctx->compression_level, 0, 10);
 194         speex_encoder_ctl(s->enc_state, SPEEX_SET_COMPLEXITY, &complexity);
 195     }
 196     speex_encoder_ctl(s->enc_state, SPEEX_GET_COMPLEXITY, &complexity);
 197     avctx->compression_level = complexity;
 198
 199     /* set packet size */
 200     avctx->frame_size = s->header.frame_size;
 201     s->header.frames_per_packet = s->frames_per_packet;
 202
 203     /* set encoding delay */
 204     speex_encoder_ctl(s->enc_state, SPEEX_GET_LOOKAHEAD, &s->lookahead);
 205     s->next_pts = -s->lookahead;
 206
 207     /* create header packet bytes from header struct */
 208     /* note: libspeex allocates the memory for header_data, which is freed
 209              below with speex_header_free() */
 210     header_data = speex_header_to_packet(&s->header, &header_size);
 211
 212     /* allocate extradata and coded_frame */
 213     avctx->extradata   = av_malloc(header_size + FF_INPUT_BUFFER_PADDING_SIZE);
 214     avctx->coded_frame = avcodec_alloc_frame();
 215     if (!avctx->extradata || !avctx->coded_frame) {
 216         speex_header_free(header_data);
 217         speex_encoder_destroy(s->enc_state);
 218         av_log(avctx, AV_LOG_ERROR, "memory allocation error\n");
 219         return AVERROR(ENOMEM);
 220     }
 221
 222     /* copy header packet to extradata */
 223     memcpy(avctx->extradata, header_data, header_size);
 224     avctx->extradata_size = header_size;
 225     speex_header_free(header_data);
 226
 227     /* init libspeex bitwriter */
 228     speex_bits_init(&s->bits);
 229
 230     print_enc_params(avctx, s);
 231     return 0;
 232 }
 233
 234 static int encode_frame(AVCodecContext *avctx, uint8_t *frame, int buf_size,
 235                         void *data)
 236 {
 237     LibSpeexEncContext *s = avctx->priv_data;
 238     int16_t *samples      = data;
 239
 240     if (data) {
 241         /* encode Speex frame */
 242         if (avctx->channels == 2)
 243             speex_encode_stereo_int(samples, s->header.frame_size, &s->bits);
 244         speex_encode_int(s->enc_state, samples, &s->bits);
 245         s->pkt_frame_count++;
 246         s->pkt_sample_count += avctx->frame_size;
 247     } else {
 248         /* handle end-of-stream */
 249         if (!s->pkt_frame_count)
 250             return 0;
 251         /* add extra terminator codes for unused frames in last packet */
 252         while (s->pkt_frame_count < s->frames_per_packet) {
 253             speex_bits_pack(&s->bits, 15, 5);
 254             s->pkt_frame_count++;
 255         }
 256     }
 257
 258     /* write output if all frames for the packet have been encoded */
 259     if (s->pkt_frame_count == s->frames_per_packet) {
 260         s->pkt_frame_count = 0;
 261         avctx->coded_frame->pts =
 262             av_rescale_q(s->next_pts, (AVRational){ 1, avctx->sample_rate },
 263                          avctx->time_base);
 264         s->next_pts += s->pkt_sample_count;
 265         s->pkt_sample_count = 0;
 266         if (buf_size > speex_bits_nbytes(&s->bits)) {
 267             int ret = speex_bits_write(&s->bits, frame, buf_size);
 268             speex_bits_reset(&s->bits);
 269             return ret;
 270         } else {
 271             av_log(avctx, AV_LOG_ERROR, "output buffer too small");
 272             return AVERROR(EINVAL);
 273         }
 274     }
 275     return 0;
 276 }
 277
 278 static av_cold int encode_close(AVCodecContext *avctx)
 279 {
 280     LibSpeexEncContext *s = avctx->priv_data;
 281
 282     speex_bits_destroy(&s->bits);
 283     speex_encoder_destroy(s->enc_state);
 284
 285     av_freep(&avctx->coded_frame);
 286     av_freep(&avctx->extradata);
 287
 288     return 0;
 289 }
 290
 291 #define OFFSET(x) offsetof(LibSpeexEncContext, x)
 292 #define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 293 static const AVOption options[] = {
 294     { "abr",               "Use average bit rate",                      OFFSET(abr),               AV_OPT_TYPE_INT, { 0 }, 0,   1, AE },
 295     { "cbr_quality",       "Set quality value (0 to 10) for CBR",       OFFSET(cbr_quality),       AV_OPT_TYPE_INT, { 8 }, 0,  10, AE },
 296     { "frames_per_packet", "Number of frames to encode in each packet", OFFSET(frames_per_packet), AV_OPT_TYPE_INT, { 1 }, 1,   8, AE },
 297     { NULL },
 298 };
 299
 300 static const AVClass class = {
 301     .class_name = "libspeex",
 302     .item_name  = av_default_item_name,
 303     .option     = options,
 304     .version    = LIBAVUTIL_VERSION_INT,
 305 };
 306
 307 static const AVCodecDefault defaults[] = {
 308     { "b",                 "0" },
 309     { "compression_level", "3" },
 310     { NULL },
 311 };
 312
 313 AVCodec ff_libspeex_encoder = {
 314     .name           = "libspeex",
 315     .type           = AVMEDIA_TYPE_AUDIO,
 316     .id             = CODEC_ID_SPEEX,
 317     .priv_data_size = sizeof(LibSpeexEncContext),
 318     .init           = encode_init,
 319     .encode         = encode_frame,
 320     .close          = encode_close,
 321     .capabilities   = CODEC_CAP_DELAY,
 322     .sample_fmts    = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16, AV_SAMPLE_FMT_NONE },
 323     .long_name      = NULL_IF_CONFIG_SMALL("libspeex Speex"),
 324     .priv_class     = &class,
 325     .defaults       = defaults,
 326 };