libspeexenc: Add an option for enabling DTX
[ffmpeg.git] / 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
71 #include "libavutil/audioconvert.h"
72 #include "libavutil/common.h"
73 #include "libavutil/opt.h"
74 #include "avcodec.h"
75 #include "internal.h"
76 #include "audio_frame_queue.h"
77
78 /* TODO: Think about converting abr, vad, dtx and such flags to a bit field */
79 typedef struct {
80     AVClass *class;             ///< AVClass for private options
81     SpeexBits bits;             ///< libspeex bitwriter context
82     SpeexHeader header;         ///< libspeex header struct
83     void *enc_state;            ///< libspeex encoder state
84     int frames_per_packet;      ///< number of frames to encode in each packet
85     float vbr_quality;          ///< VBR quality 0.0 to 10.0
86     int cbr_quality;            ///< CBR quality 0 to 10
87     int abr;                    ///< flag to enable ABR
88     int vad;                    ///< flag to enable VAD
89     int dtx;                    ///< flag to enable DTX
90     int pkt_frame_count;        ///< frame count for the current packet
91     AudioFrameQueue afq;        ///< frame queue
92 } LibSpeexEncContext;
93
94 static av_cold void print_enc_params(AVCodecContext *avctx,
95                                      LibSpeexEncContext *s)
96 {
97     const char *mode_str = "unknown";
98
99     av_log(avctx, AV_LOG_DEBUG, "channels: %d\n", avctx->channels);
100     switch (s->header.mode) {
101     case SPEEX_MODEID_NB:  mode_str = "narrowband";     break;
102     case SPEEX_MODEID_WB:  mode_str = "wideband";       break;
103     case SPEEX_MODEID_UWB: mode_str = "ultra-wideband"; break;
104     }
105     av_log(avctx, AV_LOG_DEBUG, "mode: %s\n", mode_str);
106     if (s->header.vbr) {
107         av_log(avctx, AV_LOG_DEBUG, "rate control: VBR\n");
108         av_log(avctx, AV_LOG_DEBUG, "  quality: %f\n", s->vbr_quality);
109     } else if (s->abr) {
110         av_log(avctx, AV_LOG_DEBUG, "rate control: ABR\n");
111         av_log(avctx, AV_LOG_DEBUG, "  bitrate: %d bps\n", avctx->bit_rate);
112     } else {
113         av_log(avctx, AV_LOG_DEBUG, "rate control: CBR\n");
114         av_log(avctx, AV_LOG_DEBUG, "  bitrate: %d bps\n", avctx->bit_rate);
115     }
116     av_log(avctx, AV_LOG_DEBUG, "complexity: %d\n",
117            avctx->compression_level);
118     av_log(avctx, AV_LOG_DEBUG, "frame size: %d samples\n",
119            avctx->frame_size);
120     av_log(avctx, AV_LOG_DEBUG, "frames per packet: %d\n",
121            s->frames_per_packet);
122     av_log(avctx, AV_LOG_DEBUG, "packet size: %d\n",
123            avctx->frame_size * s->frames_per_packet);
124     av_log(avctx, AV_LOG_DEBUG, "voice activity detection: %d\n", s->vad);
125     av_log(avctx, AV_LOG_DEBUG, "discontinuous transmission: %d\n", s->dtx);
126 }
127
128 static av_cold int encode_init(AVCodecContext *avctx)
129 {
130     LibSpeexEncContext *s = avctx->priv_data;
131     const SpeexMode *mode;
132     uint8_t *header_data;
133     int header_size;
134     int32_t complexity;
135
136     /* channels */
137     if (avctx->channels < 1 || avctx->channels > 2) {
138         av_log(avctx, AV_LOG_ERROR, "Invalid channels (%d). Only stereo and "
139                "mono are supported\n", avctx->channels);
140         return AVERROR(EINVAL);
141     }
142
143     /* sample rate and encoding mode */
144     switch (avctx->sample_rate) {
145     case  8000: mode = &speex_nb_mode;  break;
146     case 16000: mode = &speex_wb_mode;  break;
147     case 32000: mode = &speex_uwb_mode; break;
148     default:
149         av_log(avctx, AV_LOG_ERROR, "Sample rate of %d Hz is not supported. "
150                "Resample to 8, 16, or 32 kHz.\n", avctx->sample_rate);
151         return AVERROR(EINVAL);
152     }
153
154     /* initialize libspeex */
155     s->enc_state = speex_encoder_init(mode);
156     if (!s->enc_state) {
157         av_log(avctx, AV_LOG_ERROR, "Error initializing libspeex\n");
158         return -1;
159     }
160     speex_init_header(&s->header, avctx->sample_rate, avctx->channels, mode);
161
162     /* rate control method and parameters */
163     if (avctx->flags & CODEC_FLAG_QSCALE) {
164         /* VBR */
165         s->header.vbr = 1;
166         s->vad = 1; /* VAD is always implicitly activated for VBR */
167         speex_encoder_ctl(s->enc_state, SPEEX_SET_VBR, &s->header.vbr);
168         s->vbr_quality = av_clipf(avctx->global_quality / (float)FF_QP2LAMBDA,
169                                   0.0f, 10.0f);
170         speex_encoder_ctl(s->enc_state, SPEEX_SET_VBR_QUALITY, &s->vbr_quality);
171     } else {
172         s->header.bitrate = avctx->bit_rate;
173         if (avctx->bit_rate > 0) {
174             /* CBR or ABR by bitrate */
175             if (s->abr) {
176                 speex_encoder_ctl(s->enc_state, SPEEX_SET_ABR,
177                                   &s->header.bitrate);
178                 speex_encoder_ctl(s->enc_state, SPEEX_GET_ABR,
179                                   &s->header.bitrate);
180             } else {
181                 speex_encoder_ctl(s->enc_state, SPEEX_SET_BITRATE,
182                                   &s->header.bitrate);
183                 speex_encoder_ctl(s->enc_state, SPEEX_GET_BITRATE,
184                                   &s->header.bitrate);
185             }
186         } else {
187             /* CBR by quality */
188             speex_encoder_ctl(s->enc_state, SPEEX_SET_QUALITY,
189                               &s->cbr_quality);
190             speex_encoder_ctl(s->enc_state, SPEEX_GET_BITRATE,
191                               &s->header.bitrate);
192         }
193         /* stereo side information adds about 800 bps to the base bitrate */
194         /* TODO: this should be calculated exactly */
195         avctx->bit_rate = s->header.bitrate + (avctx->channels == 2 ? 800 : 0);
196     }
197
198     /* VAD is activated with VBR or can be turned on by itself */
199     if (s->vad)
200         speex_encoder_ctl(s->enc_state, SPEEX_SET_VAD, &s->vad);
201
202     /* Activiting Discontinuous Transmission */
203     if (s->dtx) {
204         speex_encoder_ctl(s->enc_state, SPEEX_SET_DTX, &s->dtx);
205         if ( !(s->abr || s->vad || s->header.vbr))
206             av_log(avctx, AV_LOG_WARNING, "DTX is not much of use without ABR, VAD or VBR\n");
207     }
208
209     /* set encoding complexity */
210     if (avctx->compression_level > FF_COMPRESSION_DEFAULT) {
211         complexity = av_clip(avctx->compression_level, 0, 10);
212         speex_encoder_ctl(s->enc_state, SPEEX_SET_COMPLEXITY, &complexity);
213     }
214     speex_encoder_ctl(s->enc_state, SPEEX_GET_COMPLEXITY, &complexity);
215     avctx->compression_level = complexity;
216
217     /* set packet size */
218     avctx->frame_size = s->header.frame_size;
219     s->header.frames_per_packet = s->frames_per_packet;
220
221     /* set encoding delay */
222     speex_encoder_ctl(s->enc_state, SPEEX_GET_LOOKAHEAD, &avctx->delay);
223     ff_af_queue_init(avctx, &s->afq);
224
225     /* create header packet bytes from header struct */
226     /* note: libspeex allocates the memory for header_data, which is freed
227              below with speex_header_free() */
228     header_data = speex_header_to_packet(&s->header, &header_size);
229
230     /* allocate extradata and coded_frame */
231     avctx->extradata   = av_malloc(header_size + FF_INPUT_BUFFER_PADDING_SIZE);
232     if (!avctx->extradata) {
233         speex_header_free(header_data);
234         speex_encoder_destroy(s->enc_state);
235         av_log(avctx, AV_LOG_ERROR, "memory allocation error\n");
236         return AVERROR(ENOMEM);
237     }
238 #if FF_API_OLD_ENCODE_AUDIO
239     avctx->coded_frame = avcodec_alloc_frame();
240     if (!avctx->coded_frame) {
241         av_freep(&avctx->extradata);
242         speex_header_free(header_data);
243         speex_encoder_destroy(s->enc_state);
244         av_log(avctx, AV_LOG_ERROR, "memory allocation error\n");
245         return AVERROR(ENOMEM);
246     }
247 #endif
248
249     /* copy header packet to extradata */
250     memcpy(avctx->extradata, header_data, header_size);
251     avctx->extradata_size = header_size;
252     speex_header_free(header_data);
253
254     /* init libspeex bitwriter */
255     speex_bits_init(&s->bits);
256
257     print_enc_params(avctx, s);
258     return 0;
259 }
260
261 static int encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
262                         const AVFrame *frame, int *got_packet_ptr)
263 {
264     LibSpeexEncContext *s = avctx->priv_data;
265     int16_t *samples      = frame ? (int16_t *)frame->data[0] : NULL;
266     int ret;
267
268     if (samples) {
269         /* encode Speex frame */
270         if (avctx->channels == 2)
271             speex_encode_stereo_int(samples, s->header.frame_size, &s->bits);
272         speex_encode_int(s->enc_state, samples, &s->bits);
273         s->pkt_frame_count++;
274         if ((ret = ff_af_queue_add(&s->afq, frame) < 0))
275             return ret;
276     } else {
277         /* handle end-of-stream */
278         if (!s->pkt_frame_count)
279             return 0;
280         /* add extra terminator codes for unused frames in last packet */
281         while (s->pkt_frame_count < s->frames_per_packet) {
282             speex_bits_pack(&s->bits, 15, 5);
283             s->pkt_frame_count++;
284         }
285     }
286
287     /* write output if all frames for the packet have been encoded */
288     if (s->pkt_frame_count == s->frames_per_packet) {
289         s->pkt_frame_count = 0;
290         if ((ret = ff_alloc_packet2(avctx, avpkt, speex_bits_nbytes(&s->bits))))
291             return ret;
292         ret = speex_bits_write(&s->bits, avpkt->data, avpkt->size);
293         speex_bits_reset(&s->bits);
294
295         /* Get the next frame pts/duration */
296         ff_af_queue_remove(&s->afq, s->frames_per_packet * avctx->frame_size,
297                            &avpkt->pts, &avpkt->duration);
298
299         avpkt->size = ret;
300         *got_packet_ptr = 1;
301         return 0;
302     }
303     return 0;
304 }
305
306 static av_cold int encode_close(AVCodecContext *avctx)
307 {
308     LibSpeexEncContext *s = avctx->priv_data;
309
310     speex_bits_destroy(&s->bits);
311     speex_encoder_destroy(s->enc_state);
312
313     ff_af_queue_close(&s->afq);
314 #if FF_API_OLD_ENCODE_AUDIO
315     av_freep(&avctx->coded_frame);
316 #endif
317     av_freep(&avctx->extradata);
318
319     return 0;
320 }
321
322 #define OFFSET(x) offsetof(LibSpeexEncContext, x)
323 #define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
324 static const AVOption options[] = {
325     { "abr",               "Use average bit rate",                      OFFSET(abr),               AV_OPT_TYPE_INT, { .i64 = 0 }, 0,   1, AE },
326     { "cbr_quality",       "Set quality value (0 to 10) for CBR",       OFFSET(cbr_quality),       AV_OPT_TYPE_INT, { .i64 = 8 }, 0,  10, AE },
327     { "frames_per_packet", "Number of frames to encode in each packet", OFFSET(frames_per_packet), AV_OPT_TYPE_INT, { .i64 = 1 }, 1,   8, AE },
328     { "vad",               "Voice Activity Detection",                  OFFSET(vad),               AV_OPT_TYPE_INT, { .i64 = 0 }, 0,   1, AE },
329     { "dtx",               "Discontinuous Transmission",                OFFSET(dtx),               AV_OPT_TYPE_INT, { .i64 = 0 }, 0,   1, AE },
330     { NULL },
331 };
332
333 static const AVClass class = {
334     .class_name = "libspeex",
335     .item_name  = av_default_item_name,
336     .option     = options,
337     .version    = LIBAVUTIL_VERSION_INT,
338 };
339
340 static const AVCodecDefault defaults[] = {
341     { "b",                 "0" },
342     { "compression_level", "3" },
343     { NULL },
344 };
345
346 AVCodec ff_libspeex_encoder = {
347     .name           = "libspeex",
348     .type           = AVMEDIA_TYPE_AUDIO,
349     .id             = AV_CODEC_ID_SPEEX,
350     .priv_data_size = sizeof(LibSpeexEncContext),
351     .init           = encode_init,
352     .encode2        = encode_frame,
353     .close          = encode_close,
354     .capabilities   = CODEC_CAP_DELAY,
355     .sample_fmts    = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
356                                                      AV_SAMPLE_FMT_NONE },
357     .channel_layouts = (const uint64_t[]){ AV_CH_LAYOUT_MONO,
358                                            AV_CH_LAYOUT_STEREO,
359                                            0 },
360     .supported_samplerates = (const int[]){ 8000, 16000, 32000, 0 },
361     .long_name      = NULL_IF_CONFIG_SMALL("libspeex Speex"),
362     .priv_class     = &class,
363     .defaults       = defaults,
364 };