4335bd6eca5cd5b39afb41fdd1fea44d080bcb1e
[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 #define OPUS_HEAD_SIZE 19
60
61 static av_cold int libopus_decode_init(AVCodecContext *avc)
62 {
63     struct libopus_context *opus = avc->priv_data;
64     int ret, channel_map = 0, gain_db = 0, nb_streams, nb_coupled;
65     uint8_t mapping_arr[8] = { 0, 1 }, *mapping;
66
67     avc->sample_rate    = 48000;
68     avc->sample_fmt     = avc->request_sample_fmt == AV_SAMPLE_FMT_FLT ?
69                           AV_SAMPLE_FMT_FLT : AV_SAMPLE_FMT_S16;
70     avc->channel_layout = avc->channels > 8 ? 0 :
71                           ff_vorbis_channel_layouts[avc->channels - 1];
72
73     if (avc->extradata_size >= OPUS_HEAD_SIZE) {
74         gain_db     = sign_extend(AV_RL16(avc->extradata + 16), 16);
75         channel_map = AV_RL8 (avc->extradata + 18);
76     }
77     if (avc->extradata_size >= OPUS_HEAD_SIZE + 2 + avc->channels) {
78         nb_streams = avc->extradata[OPUS_HEAD_SIZE + 0];
79         nb_coupled = avc->extradata[OPUS_HEAD_SIZE + 1];
80         if (nb_streams + nb_coupled != avc->channels)
81             av_log(avc, AV_LOG_WARNING, "Inconsistent channel mapping.\n");
82         mapping = avc->extradata + OPUS_HEAD_SIZE + 2;
83     } else {
84         if (avc->channels > 2 || channel_map) {
85             av_log(avc, AV_LOG_ERROR,
86                    "No channel mapping for %d channels.\n", avc->channels);
87             return AVERROR(EINVAL);
88         }
89         nb_streams = 1;
90         nb_coupled = avc->channels > 1;
91         mapping    = mapping_arr;
92     }
93
94     if (avc->channels > 2 && avc->channels <= 8) {
95         const uint8_t *vorbis_offset = ff_vorbis_channel_layout_offsets[avc->channels - 1];
96         int ch;
97
98         /* Remap channels from vorbis order to libav order */
99         for (ch = 0; ch < avc->channels; ch++)
100             mapping_arr[ch] = mapping[vorbis_offset[ch]];
101         mapping = mapping_arr;
102     }
103
104     opus->dec = opus_multistream_decoder_create(avc->sample_rate, avc->channels,
105                                                 nb_streams, nb_coupled,
106                                                 mapping, &ret);
107     if (!opus->dec) {
108         av_log(avc, AV_LOG_ERROR, "Unable to create decoder: %s\n",
109                opus_strerror(ret));
110         return opus_error_to_averror(ret);
111     }
112
113     ret = opus_multistream_decoder_ctl(opus->dec, OPUS_SET_GAIN(gain_db));
114     if (ret != OPUS_OK)
115         av_log(avc, AV_LOG_WARNING, "Failed to set gain: %s\n",
116                opus_strerror(ret));
117
118     avc->delay = 3840;  /* Decoder delay (in samples) at 48kHz */
119     avcodec_get_frame_defaults(&opus->frame);
120     avc->coded_frame = &opus->frame;
121     return 0;
122 }
123
124 static av_cold int libopus_decode_close(AVCodecContext *avc)
125 {
126     struct libopus_context *opus = avc->priv_data;
127
128     opus_multistream_decoder_destroy(opus->dec);
129     return 0;
130 }
131
132 #define MAX_FRAME_SIZE (960 * 6)
133
134 static int libopus_decode(AVCodecContext *avc, void *frame,
135                           int *got_frame_ptr, AVPacket *pkt)
136 {
137     struct libopus_context *opus = avc->priv_data;
138     int ret, nb_samples;
139
140     opus->frame.nb_samples = MAX_FRAME_SIZE;
141     ret = avc->get_buffer(avc, &opus->frame);
142     if (ret < 0) {
143         av_log(avc, AV_LOG_ERROR, "get_buffer() failed\n");
144         return ret;
145     }
146
147     if (avc->sample_fmt == AV_SAMPLE_FMT_S16)
148         nb_samples = opus_multistream_decode(opus->dec, pkt->data, pkt->size,
149                                              (opus_int16 *)opus->frame.data[0],
150                                              opus->frame.nb_samples, 0);
151     else
152         nb_samples = opus_multistream_decode_float(opus->dec, pkt->data, pkt->size,
153                                                    (float *)opus->frame.data[0],
154                                                    opus->frame.nb_samples, 0);
155
156     if (nb_samples < 0) {
157         av_log(avc, AV_LOG_ERROR, "Decoding error: %s\n",
158                opus_strerror(nb_samples));
159         return opus_error_to_averror(nb_samples);
160     }
161
162     opus->frame.nb_samples = nb_samples;
163     *(AVFrame *)frame = opus->frame;
164     *got_frame_ptr = 1;
165     return pkt->size;
166 }
167
168 static void libopus_flush(AVCodecContext *avc)
169 {
170     struct libopus_context *opus = avc->priv_data;
171
172     opus_multistream_decoder_ctl(opus->dec, OPUS_RESET_STATE);
173 }
174
175 AVCodec ff_libopus_decoder = {
176     .name           = "libopus",
177     .type           = AVMEDIA_TYPE_AUDIO,
178     .id             = AV_CODEC_ID_OPUS,
179     .priv_data_size = sizeof(struct libopus_context),
180     .init           = libopus_decode_init,
181     .close          = libopus_decode_close,
182     .decode         = libopus_decode,
183     .flush          = libopus_flush,
184     .capabilities   = CODEC_CAP_DR1,
185     .long_name      = NULL_IF_CONFIG_SMALL("libopus Opus"),
186     .sample_fmts    = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_FLT,
187                                                      AV_SAMPLE_FMT_S16,
188                                                      AV_SAMPLE_FMT_NONE },
189 };