Opus decoder using libopus
[ffmpeg.git] / libavcodec / libopusdec.c
1 /*
2  * Opus decoder using libopus
3  * Copyright (c) 2012 Nicolas George
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include <opus.h>
23 #include <opus_multistream.h>
24
25 #include "libavutil/common.h"
26 #include "libavutil/avassert.h"
27 #include "libavutil/intreadwrite.h"
28 #include "avcodec.h"
29 #include "vorbis.h"
30 #include "mathops.h"
31
32 struct libopus_context {
33     OpusMSDecoder *dec;
34     AVFrame frame;
35 };
36
37 static int opus_error_to_averror(int err)
38 {
39     switch (err) {
40     case OPUS_BAD_ARG:
41         return AVERROR(EINVAL);
42     case OPUS_BUFFER_TOO_SMALL:
43         return AVERROR_UNKNOWN;
44     case OPUS_INTERNAL_ERROR:
45         return AVERROR(EFAULT);
46     case OPUS_INVALID_PACKET:
47         return AVERROR_INVALIDDATA;
48     case OPUS_UNIMPLEMENTED:
49         return AVERROR(ENOSYS);
50     case OPUS_INVALID_STATE:
51         return AVERROR_UNKNOWN;
52     case OPUS_ALLOC_FAIL:
53         return AVERROR(ENOMEM);
54     default:
55         return AVERROR(EINVAL);
56     }
57 }
58
59 static inline void reorder(uint8_t *data, unsigned channels, unsigned bps,
60                            unsigned samples, const uint8_t *map)
61 {
62     uint8_t tmp[8 * 4];
63     unsigned i;
64
65     av_assert1(channels * bps <= sizeof(tmp));
66     for (; samples > 0; samples--) {
67         for (i = 0; i < channels; i++)
68             memcpy(tmp + bps * i, data + bps * map[i], bps);
69         memcpy(data, tmp, bps * channels);
70         data += bps * channels;
71     }
72 }
73
74 #define OPUS_HEAD_SIZE 19
75
76 static av_cold int libopus_decode_init(AVCodecContext *avc)
77 {
78     struct libopus_context *opus = avc->priv_data;
79     int ret, channel_map = 0, gain_db = 0, nb_streams, nb_coupled;
80     uint8_t mapping_stereo[] = { 0, 1 }, *mapping;
81
82     avc->sample_rate    = 48000;
83     avc->sample_fmt     = avc->request_sample_fmt == AV_SAMPLE_FMT_FLT ?
84                           AV_SAMPLE_FMT_FLT : AV_SAMPLE_FMT_S16;
85     avc->channel_layout = avc->channels > 8 ? 0 :
86                           ff_vorbis_channel_layouts[avc->channels - 1];
87
88     if (avc->extradata_size >= OPUS_HEAD_SIZE) {
89         gain_db     = sign_extend(AV_RL16(avc->extradata + 16), 16);
90         channel_map = AV_RL8 (avc->extradata + 18);
91     }
92     if (avc->extradata_size >= OPUS_HEAD_SIZE + 2 + avc->channels) {
93         nb_streams = avc->extradata[OPUS_HEAD_SIZE + 0];
94         nb_coupled = avc->extradata[OPUS_HEAD_SIZE + 1];
95         if (nb_streams + nb_coupled != avc->channels)
96             av_log(avc, AV_LOG_WARNING, "Inconsistent channel mapping.\n");
97         mapping = avc->extradata + OPUS_HEAD_SIZE + 2;
98     } else {
99         if (avc->channels > 2 || channel_map) {
100             av_log(avc, AV_LOG_ERROR,
101                    "No channel mapping for %d channels.\n", avc->channels);
102             return AVERROR(EINVAL);
103         }
104         nb_streams = 1;
105         nb_coupled = avc->channels > 1;
106         mapping    = mapping_stereo;
107     }
108
109     opus->dec = opus_multistream_decoder_create(avc->sample_rate, avc->channels,
110                                                 nb_streams, nb_coupled,
111                                                 mapping, &ret);
112     if (!opus->dec) {
113         av_log(avc, AV_LOG_ERROR, "Unable to create decoder: %s\n",
114                opus_strerror(ret));
115         return opus_error_to_averror(ret);
116     }
117
118     ret = opus_multistream_decoder_ctl(opus->dec, OPUS_SET_GAIN(gain_db));
119     if (ret != OPUS_OK)
120         av_log(avc, AV_LOG_WARNING, "Failed to set gain: %s\n",
121                opus_strerror(ret));
122
123     avc->delay = 3840;  /* Decoder delay (in samples) at 48kHz */
124     avcodec_get_frame_defaults(&opus->frame);
125     avc->coded_frame = &opus->frame;
126     return 0;
127 }
128
129 static av_cold int libopus_decode_close(AVCodecContext *avc)
130 {
131     struct libopus_context *opus = avc->priv_data;
132
133     opus_multistream_decoder_destroy(opus->dec);
134     return 0;
135 }
136
137 #define MAX_FRAME_SIZE (960 * 6)
138
139 static int libopus_decode(AVCodecContext *avc, void *frame,
140                           int *got_frame_ptr, AVPacket *pkt)
141 {
142     struct libopus_context *opus = avc->priv_data;
143     int ret, nb_samples;
144
145     opus->frame.nb_samples = MAX_FRAME_SIZE;
146     ret = avc->get_buffer(avc, &opus->frame);
147     if (ret < 0) {
148         av_log(avc, AV_LOG_ERROR, "get_buffer() failed\n");
149         return ret;
150     }
151
152     if (avc->sample_fmt == AV_SAMPLE_FMT_S16)
153         nb_samples = opus_multistream_decode(opus->dec, pkt->data, pkt->size,
154                                              (opus_int16 *)opus->frame.data[0],
155                                              opus->frame.nb_samples, 0);
156     else
157         nb_samples = opus_multistream_decode_float(opus->dec, pkt->data, pkt->size,
158                                                    (float *)opus->frame.data[0],
159                                                    opus->frame.nb_samples, 0);
160
161     if (nb_samples < 0) {
162         av_log(avc, AV_LOG_ERROR, "Decoding error: %s\n",
163                opus_strerror(nb_samples));
164         return opus_error_to_averror(nb_samples);
165     }
166
167     if (avc->channels > 3 && avc->channels <= 8) {
168         const uint8_t *m = ff_vorbis_channel_layout_offsets[avc->channels - 1];
169         if (avc->sample_fmt == AV_SAMPLE_FMT_S16)
170             reorder(opus->frame.data[0], avc->channels, 2, nb_samples, m);
171         else
172             reorder(opus->frame.data[0], avc->channels, 4, nb_samples, m);
173     }
174
175     opus->frame.nb_samples = nb_samples;
176     *(AVFrame *)frame = opus->frame;
177     *got_frame_ptr = 1;
178     return pkt->size;
179 }
180
181 static void libopus_flush(AVCodecContext *avc)
182 {
183     struct libopus_context *opus = avc->priv_data;
184
185     opus_multistream_decoder_ctl(opus->dec, OPUS_RESET_STATE);
186 }
187
188 AVCodec ff_libopus_decoder = {
189     .name           = "libopus",
190     .type           = AVMEDIA_TYPE_AUDIO,
191     .id             = AV_CODEC_ID_OPUS,
192     .priv_data_size = sizeof(struct libopus_context),
193     .init           = libopus_decode_init,
194     .close          = libopus_decode_close,
195     .decode         = libopus_decode,
196     .flush          = libopus_flush,
197     .capabilities   = CODEC_CAP_DR1,
198     .long_name      = NULL_IF_CONFIG_SMALL("libopus Opus"),
199     .sample_fmts    = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_FLT,
200                                                      AV_SAMPLE_FMT_S16,
201                                                      AV_SAMPLE_FMT_NONE },
202 };