libshine.c
Go to the documentation of this file.
1 /*
2  * Interface to libshine for mp3 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 #include <shine/layer3.h>
23 
24 #include "libavutil/intreadwrite.h"
25 #include "audio_frame_queue.h"
26 #include "avcodec.h"
27 #include "internal.h"
28 #include "mpegaudio.h"
29 #include "mpegaudiodecheader.h"
30 
31 #define BUFFER_SIZE (4096 * 20)
32 
33 typedef struct SHINEContext {
34  shine_config_t config;
35  shine_t shine;
39 } SHINEContext;
40 
42 {
43  SHINEContext *s = avctx->priv_data;
44 
45  if (avctx->channels <= 0 || avctx->channels > 2){
46  av_log(avctx, AV_LOG_ERROR, "only mono or stereo is supported\n");
47  return AVERROR(EINVAL);
48  }
49 
50  shine_set_config_mpeg_defaults(&s->config.mpeg);
51  if (avctx->bit_rate)
52  s->config.mpeg.bitr = avctx->bit_rate / 1000;
53  if (shine_find_bitrate_index(s->config.mpeg.bitr) < 0) {
54  av_log(avctx, AV_LOG_ERROR, "invalid bitrate\n");
55  return AVERROR(EINVAL);
56  }
57  s->config.mpeg.mode = avctx->channels == 2 ? STEREO : MONO;
58  s->config.wave.samplerate = avctx->sample_rate;
59  s->config.wave.channels = avctx->channels == 2 ? PCM_STEREO : PCM_MONO;
60  s->shine = shine_initialise(&s->config);
61  if (!s->shine)
62  return AVERROR(ENOMEM);
63  avctx->frame_size = samp_per_frame;
64  ff_af_queue_init(avctx, &s->afq);
65  return 0;
66 }
67 
68 static int libshine_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
69  const AVFrame *frame, int *got_packet_ptr)
70 {
71  SHINEContext *s = avctx->priv_data;
72  MPADecodeHeader hdr;
73  unsigned char *data;
74  long written;
75  int ret, len;
76 
77  if (frame)
78  data = shine_encode_frame(s->shine, frame->data[0], &written);
79  else
80  data = shine_flush(s->shine, &written);
81  if (written < 0)
82  return -1;
83  if (written > 0) {
84  if (s->buffer_index + written > BUFFER_SIZE) {
85  av_log(avctx, AV_LOG_ERROR, "internal buffer too small\n");
86  return AVERROR_BUG;
87  }
88  memcpy(s->buffer + s->buffer_index, data, written);
89  s->buffer_index += written;
90  }
91  if (frame) {
92  if ((ret = ff_af_queue_add(&s->afq, frame)) < 0)
93  return ret;
94  }
95 
96  if (s->buffer_index < 4 || !s->afq.frame_count)
97  return 0;
99  av_log(avctx, AV_LOG_ERROR, "free format output not supported\n");
100  return -1;
101  }
102 
103  len = hdr.frame_size;
104  if (len <= s->buffer_index) {
105  if ((ret = ff_alloc_packet2(avctx, avpkt, len)))
106  return ret;
107  memcpy(avpkt->data, s->buffer, len);
108  s->buffer_index -= len;
109  memmove(s->buffer, s->buffer + len, s->buffer_index);
110 
111  ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
112  &avpkt->duration);
113 
114  avpkt->size = len;
115  *got_packet_ptr = 1;
116  }
117  return 0;
118 }
119 
121 {
122  SHINEContext *s = avctx->priv_data;
123 
124  ff_af_queue_close(&s->afq);
125  shine_close(s->shine);
126  return 0;
127 }
128 
129 static const int libshine_sample_rates[] = {
130  44100, 48000, 32000, 0
131 };
132 
134  .name = "libshine",
135  .type = AVMEDIA_TYPE_AUDIO,
136  .id = CODEC_ID_MP3,
137  .priv_data_size = sizeof(SHINEContext),
139  .encode2 = libshine_encode_frame,
141  .capabilities = CODEC_CAP_DELAY,
142  .sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16P,
144  .supported_samplerates = libshine_sample_rates,
145  .channel_layouts = (const uint64_t[]) { AV_CH_LAYOUT_MONO,
147  0 },
148  .long_name = NULL_IF_CONFIG_SMALL("libshine MP3 (MPEG audio layer 3)"),
149 };
const char * s
Definition: avisynth_c.h:668
This structure describes decoded (raw) audio or video data.
Definition: frame.h:76
shine_config_t config
Definition: libshine.c:34
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
#define AV_CH_LAYOUT_STEREO
uint8_t
#define av_cold
Definition: attributes.h:78
#define AV_RB32
static av_cold int libshine_encode_close(AVCodecContext *avctx)
Definition: libshine.c:120
uint8_t * data
int avpriv_mpegaudio_decode_header(MPADecodeHeader *s, uint32_t header)
int duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
frame
Definition: stft.m:14
#define CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Spectrum Plot time data
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:246
const char * name
Name of the codec implementation.
int ff_af_queue_add(AudioFrameQueue *afq, const AVFrame *f)
Add a frame to the queue.
external API header
#define STEREO
Definition: atrac3.c:52
uint8_t buffer[BUFFER_SIZE]
Definition: libshine.c:36
int bit_rate
the average bitrate
static av_cold int libshine_encode_init(AVCodecContext *avctx)
Definition: libshine.c:41
ret
Definition: avfilter.c:821
CODEC_ID_MP3
preferred ID for decoding MPEG audio layer 1, 2 or 3
#define BUFFER_SIZE
Definition: libshine.c:31
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int size)
Check AVPacket size and/or allocate data.
int frame_size
Number of samples per channel in an audio frame.
AVCodec ff_libshine_encoder
Definition: libshine.c:133
int sample_rate
samples per second
main external API structure.
static void close(AVCodecParserContext *s)
Definition: h264_parser.c:375
AudioFrameQueue afq
Definition: libshine.c:38
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:148
#define AVERROR_BUG
Internal bug, also see AVERROR_BUG2.
Definition: error.h:50
#define MONO
Definition: cook.c:58
int buffer_index
Definition: libshine.c:37
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFilterBuffer 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.Buffer references ownership and permissions
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:87
MPEG Audio header decoder.
common internal api header.
static const int libshine_sample_rates[]
Definition: libshine.c:129
AVSampleFormat
Audio Sample Formats.
Definition: samplefmt.h:49
mpeg audio declarations for both encoder and decoder.
void ff_af_queue_init(AVCodecContext *avctx, AudioFrameQueue *afq)
Initialize AudioFrameQueue.
int len
void ff_af_queue_remove(AudioFrameQueue *afq, int nb_samples, int64_t *pts, int *duration)
Remove frame(s) from the queue.
int channels
number of audio channels
void ff_af_queue_close(AudioFrameQueue *afq)
Close AudioFrameQueue.
signed 16 bits, planar
Definition: samplefmt.h:58
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:700
static int libshine_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Definition: libshine.c:68
#define AV_CH_LAYOUT_MONO
This structure stores compressed data.
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
shine_t shine
Definition: libshine.c:35
struct SHINEContext SHINEContext