FFmpeg
libtwolame.c
Go to the documentation of this file.
1 /*
2  * Interface to libtwolame for mp2 encoding
3  * Copyright (c) 2012 Paul B Mahol
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  * Interface to libtwolame for mp2 encoding.
25  */
26 
27 #include <twolame.h>
28 
30 #include "libavutil/common.h"
31 #include "libavutil/opt.h"
32 
33 #include "avcodec.h"
34 #include "codec_internal.h"
35 #include "encode.h"
36 #include "internal.h"
37 #include "mpegaudio.h"
38 
39 typedef struct TWOLAMEContext {
40  AVClass *class;
41  int mode;
42  int psymodel;
43  int energy;
45  int copyright;
46  int original;
47  int verbosity;
48 
49  twolame_options *glopts;
50  int64_t next_pts;
52 
54 {
55  TWOLAMEContext *s = avctx->priv_data;
56  twolame_close(&s->glopts);
57  return 0;
58 }
59 
61 {
62  TWOLAMEContext *s = avctx->priv_data;
63  int ret;
64 
65  avctx->frame_size = TWOLAME_SAMPLES_PER_FRAME;
66  avctx->initial_padding = 512 - 32 + 1;
67 
68  s->glopts = twolame_init();
69  if (!s->glopts)
70  return AVERROR(ENOMEM);
71 
72  twolame_set_verbosity(s->glopts, s->verbosity);
73  twolame_set_mode(s->glopts, s->mode);
74  twolame_set_psymodel(s->glopts, s->psymodel);
75  twolame_set_energy_levels(s->glopts, s->energy);
76  twolame_set_error_protection(s->glopts, s->error_protection);
77  twolame_set_copyright(s->glopts, s->copyright);
78  twolame_set_original(s->glopts, s->original);
79 
80  twolame_set_num_channels(s->glopts, avctx->ch_layout.nb_channels);
81  twolame_set_in_samplerate(s->glopts, avctx->sample_rate);
82  twolame_set_out_samplerate(s->glopts, avctx->sample_rate);
83 
84  if (!avctx->bit_rate) {
85  if ((s->mode == TWOLAME_AUTO_MODE && avctx->ch_layout.nb_channels == 1) || s->mode == TWOLAME_MONO)
86  avctx->bit_rate = avctx->sample_rate < 28000 ? 80000 : 192000;
87  else
88  avctx->bit_rate = avctx->sample_rate < 28000 ? 160000 : 384000;
89  }
90 
91  if (avctx->flags & AV_CODEC_FLAG_QSCALE || !avctx->bit_rate) {
92  twolame_set_VBR(s->glopts, TRUE);
93  twolame_set_VBR_level(s->glopts,
94  avctx->global_quality / (float) FF_QP2LAMBDA);
95  av_log(avctx, AV_LOG_WARNING,
96  "VBR in MP2 is a hack, use another codec that supports it.\n");
97  } else {
98  twolame_set_bitrate(s->glopts, avctx->bit_rate / 1000);
99  }
100 
101  ret = twolame_init_params(s->glopts);
102  if (ret) {
103  twolame_encode_close(avctx);
104  return AVERROR_UNKNOWN;
105  }
106 
107  return 0;
108 }
109 
110 static int twolame_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
111  const AVFrame *frame, int *got_packet_ptr)
112 {
113  TWOLAMEContext *s = avctx->priv_data;
114  int ret;
115 
116  if ((ret = ff_alloc_packet(avctx, avpkt, MPA_MAX_CODED_FRAME_SIZE)) < 0)
117  return ret;
118 
119  if (frame) {
120  switch (avctx->sample_fmt) {
121  case AV_SAMPLE_FMT_FLT:
122  ret = twolame_encode_buffer_float32_interleaved(s->glopts,
123  (const float *)frame->data[0],
124  frame->nb_samples,
125  avpkt->data,
126  avpkt->size);
127  break;
128  case AV_SAMPLE_FMT_FLTP:
129  ret = twolame_encode_buffer_float32(s->glopts,
130  (const float *)frame->data[0],
131  (const float *)frame->data[1],
132  frame->nb_samples,
133  avpkt->data, avpkt->size);
134  break;
135  case AV_SAMPLE_FMT_S16:
136  ret = twolame_encode_buffer_interleaved(s->glopts,
137  (const short int *)frame->data[0],
138  frame->nb_samples,
139  avpkt->data, avpkt->size);
140  break;
141  case AV_SAMPLE_FMT_S16P:
142  ret = twolame_encode_buffer(s->glopts,
143  (const short int *)frame->data[0],
144  (const short int *)frame->data[1],
145  frame->nb_samples,
146  avpkt->data, avpkt->size);
147  break;
148  default:
149  av_log(avctx, AV_LOG_ERROR,
150  "Unsupported sample format %d.\n", avctx->sample_fmt);
151  return AVERROR_BUG;
152  }
153  } else {
154  ret = twolame_encode_flush(s->glopts, avpkt->data, avpkt->size);
155  }
156 
157  if (!ret) // no bytes written
158  return 0;
159  if (ret < 0) // twolame error
160  return AVERROR_UNKNOWN;
161 
162  if (frame) {
163  avpkt->duration = ff_samples_to_time_base(avctx, frame->nb_samples);
164  if (frame->pts != AV_NOPTS_VALUE)
165  avpkt->pts = frame->pts - ff_samples_to_time_base(avctx, avctx->initial_padding);
166  } else {
167  avpkt->pts = s->next_pts;
168  }
169  // this is for setting pts for flushed packet(s).
170  if (avpkt->pts != AV_NOPTS_VALUE)
171  s->next_pts = avpkt->pts + avpkt->duration;
172 
173  av_shrink_packet(avpkt, ret);
174  *got_packet_ptr = 1;
175  return 0;
176 }
177 
178 #define OFFSET(x) offsetof(TWOLAMEContext, x)
179 #define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
180 static const AVOption options[] = {
181  { "mode", "Mpeg Mode", OFFSET(mode), AV_OPT_TYPE_INT, { .i64 = TWOLAME_AUTO_MODE }, TWOLAME_AUTO_MODE, TWOLAME_MONO, AE, "mode"},
182  { "auto", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TWOLAME_AUTO_MODE }, 0, 0, AE, "mode" },
183  { "stereo", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TWOLAME_STEREO }, 0, 0, AE, "mode" },
184  { "joint_stereo", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TWOLAME_JOINT_STEREO }, 0, 0, AE, "mode" },
185  { "dual_channel", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TWOLAME_DUAL_CHANNEL }, 0, 0, AE, "mode" },
186  { "mono", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TWOLAME_MONO }, 0, 0, AE, "mode" },
187  { "psymodel", "Psychoacoustic Model", OFFSET(psymodel), AV_OPT_TYPE_INT, { .i64 = 3 }, -1, 4, AE},
188  { "energy_levels","enable energy levels", OFFSET(energy), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, AE},
189  { "error_protection","enable CRC error protection", OFFSET(error_protection), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, AE},
190  { "copyright", "set MPEG Audio Copyright flag", OFFSET(copyright), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, AE},
191  { "original", "set MPEG Audio Original flag", OFFSET(original), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, AE},
192  { "verbosity", "set library optput level (0-10)", OFFSET(verbosity), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 10, AE},
193  { NULL },
194 };
195 
196 static const AVClass twolame_class = {
197  .class_name = "libtwolame encoder",
198  .item_name = av_default_item_name,
199  .option = options,
200  .version = LIBAVUTIL_VERSION_INT,
201 };
202 
204  { "b", "0" },
205  { NULL },
206 };
207 
208 static const int twolame_samplerates[] = {
209  16000, 22050, 24000, 32000, 44100, 48000, 0
210 };
211 
213  .p.name = "libtwolame",
214  .p.long_name = NULL_IF_CONFIG_SMALL("libtwolame MP2 (MPEG audio layer 2)"),
215  .p.type = AVMEDIA_TYPE_AUDIO,
216  .p.id = AV_CODEC_ID_MP2,
217  .caps_internal = FF_CODEC_CAP_NOT_INIT_THREADSAFE,
218  .priv_data_size = sizeof(TWOLAMEContext),
221  .close = twolame_encode_close,
222  .p.capabilities = AV_CODEC_CAP_DELAY,
223  .defaults = twolame_defaults,
224  .p.priv_class = &twolame_class,
225  .p.sample_fmts = (const enum AVSampleFormat[]) {
231  },
232 #if FF_API_OLD_CHANNEL_LAYOUT
233  .p.channel_layouts = (const uint64_t[]) {
236  0 },
237 #endif
238  .p.ch_layouts = (const AVChannelLayout[]) {
241  { 0 },
242  },
243  .p.supported_samplerates = twolame_samplerates,
244  .p.wrapper_name = "libtwolame",
245 };
AVCodecContext::frame_size
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:1035
AV_SAMPLE_FMT_FLTP
@ AV_SAMPLE_FMT_FLTP
float, planar
Definition: samplefmt.h:66
twolame_encode_close
static av_cold int twolame_encode_close(AVCodecContext *avctx)
Definition: libtwolame.c:53
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
AVCodecContext::sample_rate
int sample_rate
samples per second
Definition: avcodec.h:1007
AV_CH_LAYOUT_MONO
#define AV_CH_LAYOUT_MONO
Definition: channel_layout.h:204
AV_CODEC_FLAG_QSCALE
#define AV_CODEC_FLAG_QSCALE
Use fixed qscale.
Definition: avcodec.h:216
TWOLAMEContext::error_protection
int error_protection
Definition: libtwolame.c:44
ff_libtwolame_encoder
const FFCodec ff_libtwolame_encoder
Definition: libtwolame.c:212
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
internal.h
AVPacket::data
uint8_t * data
Definition: packet.h:374
AVOption
AVOption.
Definition: opt.h:251
encode.h
AV_CHANNEL_LAYOUT_MONO
#define AV_CHANNEL_LAYOUT_MONO
Definition: channel_layout.h:353
FF_CODEC_CAP_NOT_INIT_THREADSAFE
#define FF_CODEC_CAP_NOT_INIT_THREADSAFE
The codec is not known to be init-threadsafe (i.e.
Definition: codec_internal.h:33
FFCodec
Definition: codec_internal.h:118
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:392
AV_CHANNEL_LAYOUT_STEREO
#define AV_CHANNEL_LAYOUT_STEREO
Definition: channel_layout.h:354
AVERROR_UNKNOWN
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:73
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:300
init
static int init
Definition: av_tx.c:47
FFCodecDefault
Definition: codec_internal.h:88
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:122
TWOLAMEContext::psymodel
int psymodel
Definition: libtwolame.c:42
AVCodecContext::ch_layout
AVChannelLayout ch_layout
Audio channel layout.
Definition: avcodec.h:2065
av_shrink_packet
void av_shrink_packet(AVPacket *pkt, int size)
Reduce packet size, correctly zeroing padding.
Definition: avpacket.c:112
AVCodecContext::initial_padding
int initial_padding
Audio only.
Definition: avcodec.h:1732
TWOLAMEContext::copyright
int copyright
Definition: libtwolame.c:45
AVCodecContext::flags
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:478
FF_CODEC_ENCODE_CB
#define FF_CODEC_ENCODE_CB(func)
Definition: codec_internal.h:269
AV_CH_LAYOUT_STEREO
#define AV_CH_LAYOUT_STEREO
Definition: channel_layout.h:205
twolame_encode_init
static av_cold int twolame_encode_init(AVCodecContext *avctx)
Definition: libtwolame.c:60
ff_samples_to_time_base
static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx, int64_t samples)
Rescale from sample rate to AVCodecContext.time_base.
Definition: internal.h:187
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
s
#define s(width, name)
Definition: cbs_vp9.c:256
AVCodecContext::global_quality
int global_quality
Global quality for codecs which cannot change it per frame.
Definition: avcodec.h:464
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
AV_CODEC_ID_MP2
@ AV_CODEC_ID_MP2
Definition: codec_id.h:429
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
AVCodecContext::bit_rate
int64_t bit_rate
the average bitrate
Definition: avcodec.h:448
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:237
twolame_encode_frame
static int twolame_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Definition: libtwolame.c:110
twolame_class
static const AVClass twolame_class
Definition: libtwolame.c:196
TWOLAMEContext::energy
int energy
Definition: libtwolame.c:43
TWOLAMEContext::original
int original
Definition: libtwolame.c:46
AVPacket::size
int size
Definition: packet.h:375
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
AVChannelLayout
An AVChannelLayout holds information about the channel layout of audio data.
Definition: channel_layout.h:290
TWOLAMEContext::mode
int mode
Definition: libtwolame.c:41
codec_internal.h
AVCodecContext::sample_fmt
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:1023
AV_SAMPLE_FMT_NONE
@ AV_SAMPLE_FMT_NONE
Definition: samplefmt.h:56
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
options
static const AVOption options[]
Definition: libtwolame.c:180
AV_SAMPLE_FMT_S16P
@ AV_SAMPLE_FMT_S16P
signed 16 bits, planar
Definition: samplefmt.h:64
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:367
common.h
AVSampleFormat
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:55
AV_SAMPLE_FMT_S16
@ AV_SAMPLE_FMT_S16
signed 16 bits
Definition: samplefmt.h:58
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:211
TWOLAMEContext
Definition: libtwolame.c:39
OFFSET
#define OFFSET(x)
Definition: libtwolame.c:178
twolame_defaults
static const FFCodecDefault twolame_defaults[]
Definition: libtwolame.c:203
mpegaudio.h
avcodec.h
TWOLAMEContext::glopts
twolame_options * glopts
Definition: libtwolame.c:49
TWOLAMEContext::next_pts
int64_t next_pts
Definition: libtwolame.c:50
ret
ret
Definition: filter_design.txt:187
AVClass::class_name
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:71
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
AE
#define AE
Definition: libtwolame.c:179
AVCodecContext
main external API structure.
Definition: avcodec.h:398
twolame_samplerates
static const int twolame_samplerates[]
Definition: libtwolame.c:208
channel_layout.h
mode
mode
Definition: ebur128.h:83
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:225
AV_CODEC_CAP_DELAY
#define AV_CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
Definition: codec.h:82
AVPacket
This structure stores compressed data.
Definition: packet.h:351
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:425
AVERROR_BUG
#define AVERROR_BUG
Internal bug, also see AVERROR_BUG2.
Definition: error.h:52
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
MPA_MAX_CODED_FRAME_SIZE
#define MPA_MAX_CODED_FRAME_SIZE
Definition: mpegaudio.h:40
FF_QP2LAMBDA
#define FF_QP2LAMBDA
factor to convert from H.263 QP to lambda
Definition: avutil.h:227
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:234
ff_alloc_packet
int ff_alloc_packet(AVCodecContext *avctx, AVPacket *avpkt, int64_t size)
Check AVPacket size and allocate data.
Definition: encode.c:35
AV_SAMPLE_FMT_FLT
@ AV_SAMPLE_FMT_FLT
float
Definition: samplefmt.h:60
TWOLAMEContext::verbosity
int verbosity
Definition: libtwolame.c:47