avformat/dashenc: Added comments
[ffmpeg.git] / libavformat / riffdec.c
1 /*
2  * RIFF demuxing functions and data
3  * Copyright (c) 2000 Fabrice Bellard
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 "libavutil/dict.h"
23 #include "libavutil/error.h"
24 #include "libavutil/log.h"
25 #include "libavutil/mathematics.h"
26 #include "libavcodec/avcodec.h"
27 #include "libavcodec/bytestream.h"
28 #include "avformat.h"
29 #include "avio_internal.h"
30 #include "riff.h"
31
32 int ff_get_guid(AVIOContext *s, ff_asf_guid *g)
33 {
34     int ret;
35     av_assert0(sizeof(*g) == 16); //compiler will optimize this out
36     ret = avio_read(s, *g, sizeof(*g));
37     if (ret < (int)sizeof(*g)) {
38         memset(*g, 0, sizeof(*g));
39         return ret < 0 ? ret : AVERROR_INVALIDDATA;
40     }
41     return 0;
42 }
43
44 enum AVCodecID ff_codec_guid_get_id(const AVCodecGuid *guids, ff_asf_guid guid)
45 {
46     int i;
47     for (i = 0; guids[i].id != AV_CODEC_ID_NONE; i++)
48         if (!ff_guidcmp(guids[i].guid, guid))
49             return guids[i].id;
50     return AV_CODEC_ID_NONE;
51 }
52
53 /* We could be given one of the three possible structures here:
54  * WAVEFORMAT, PCMWAVEFORMAT or WAVEFORMATEX. Each structure
55  * is an expansion of the previous one with the fields added
56  * at the bottom. PCMWAVEFORMAT adds 'WORD wBitsPerSample' and
57  * WAVEFORMATEX adds 'WORD  cbSize' and basically makes itself
58  * an openended structure.
59  */
60
61 static void parse_waveformatex(AVIOContext *pb, AVCodecParameters *par)
62 {
63     ff_asf_guid subformat;
64     int bps;
65
66     bps = avio_rl16(pb);
67     if (bps)
68         par->bits_per_coded_sample = bps;
69     par->channel_layout        = avio_rl32(pb); /* dwChannelMask */
70
71     ff_get_guid(pb, &subformat);
72     if (!memcmp(subformat + 4,
73                 (const uint8_t[]){ FF_AMBISONIC_BASE_GUID }, 12) ||
74         !memcmp(subformat + 4,
75                 (const uint8_t[]){ FF_BROKEN_BASE_GUID }, 12) ||
76         !memcmp(subformat + 4,
77                 (const uint8_t[]){ FF_MEDIASUBTYPE_BASE_GUID }, 12)) {
78         par->codec_tag = AV_RL32(subformat);
79         par->codec_id  = ff_wav_codec_get_id(par->codec_tag,
80                                              par->bits_per_coded_sample);
81     } else {
82         par->codec_id = ff_codec_guid_get_id(ff_codec_wav_guids, subformat);
83         if (!par->codec_id)
84             av_log(pb, AV_LOG_WARNING,
85                    "unknown subformat:"FF_PRI_GUID"\n",
86                    FF_ARG_GUID(subformat));
87     }
88 }
89
90 /* "big_endian" values are needed for RIFX file format */
91 int ff_get_wav_header(AVFormatContext *s, AVIOContext *pb,
92                       AVCodecParameters *par, int size, int big_endian)
93 {
94     int id;
95     uint64_t bitrate = 0;
96
97     if (size < 14) {
98         avpriv_request_sample(s, "wav header size < 14");
99         return AVERROR_INVALIDDATA;
100     }
101
102     par->codec_type  = AVMEDIA_TYPE_AUDIO;
103     if (!big_endian) {
104         id                 = avio_rl16(pb);
105         if (id != 0x0165) {
106             par->channels    = avio_rl16(pb);
107             par->sample_rate = avio_rl32(pb);
108             bitrate            = avio_rl32(pb) * 8LL;
109             par->block_align = avio_rl16(pb);
110         }
111     } else {
112         id                 = avio_rb16(pb);
113         par->channels    = avio_rb16(pb);
114         par->sample_rate = avio_rb32(pb);
115         bitrate            = avio_rb32(pb) * 8LL;
116         par->block_align = avio_rb16(pb);
117     }
118     if (size == 14) {  /* We're dealing with plain vanilla WAVEFORMAT */
119         par->bits_per_coded_sample = 8;
120     } else {
121         if (!big_endian) {
122             par->bits_per_coded_sample = avio_rl16(pb);
123         } else {
124             par->bits_per_coded_sample = avio_rb16(pb);
125         }
126     }
127     if (id == 0xFFFE) {
128         par->codec_tag = 0;
129     } else {
130         par->codec_tag = id;
131         par->codec_id  = ff_wav_codec_get_id(id,
132                                              par->bits_per_coded_sample);
133     }
134     if (size >= 18 && id != 0x0165) {  /* We're obviously dealing with WAVEFORMATEX */
135         int cbSize = avio_rl16(pb); /* cbSize */
136         if (big_endian) {
137             avpriv_report_missing_feature(s, "WAVEFORMATEX support for RIFX files");
138             return AVERROR_PATCHWELCOME;
139         }
140         size  -= 18;
141         cbSize = FFMIN(size, cbSize);
142         if (cbSize >= 22 && id == 0xfffe) { /* WAVEFORMATEXTENSIBLE */
143             parse_waveformatex(pb, par);
144             cbSize -= 22;
145             size   -= 22;
146         }
147         if (cbSize > 0) {
148             av_freep(&par->extradata);
149             if (ff_get_extradata(s, par, pb, cbSize) < 0)
150                 return AVERROR(ENOMEM);
151             size -= cbSize;
152         }
153
154         /* It is possible for the chunk to contain garbage at the end */
155         if (size > 0)
156             avio_skip(pb, size);
157     } else if (id == 0x0165 && size >= 32) {
158         int nb_streams, i;
159
160         size -= 4;
161         av_freep(&par->extradata);
162         if (ff_get_extradata(s, par, pb, size) < 0)
163             return AVERROR(ENOMEM);
164         nb_streams         = AV_RL16(par->extradata + 4);
165         par->sample_rate   = AV_RL32(par->extradata + 12);
166         par->channels      = 0;
167         bitrate            = 0;
168         if (size < 8 + nb_streams * 20)
169             return AVERROR_INVALIDDATA;
170         for (i = 0; i < nb_streams; i++)
171             par->channels += par->extradata[8 + i * 20 + 17];
172     }
173
174     par->bit_rate = bitrate;
175
176     if (par->sample_rate <= 0) {
177         av_log(s, AV_LOG_ERROR,
178                "Invalid sample rate: %d\n", par->sample_rate);
179         return AVERROR_INVALIDDATA;
180     }
181     if (par->codec_id == AV_CODEC_ID_AAC_LATM) {
182         /* Channels and sample_rate values are those prior to applying SBR
183          * and/or PS. */
184         par->channels    = 0;
185         par->sample_rate = 0;
186     }
187     /* override bits_per_coded_sample for G.726 */
188     if (par->codec_id == AV_CODEC_ID_ADPCM_G726 && par->sample_rate)
189         par->bits_per_coded_sample = par->bit_rate / par->sample_rate;
190
191     return 0;
192 }
193
194 enum AVCodecID ff_wav_codec_get_id(unsigned int tag, int bps)
195 {
196     enum AVCodecID id;
197     id = ff_codec_get_id(ff_codec_wav_tags, tag);
198     if (id <= 0)
199         return id;
200
201     if (id == AV_CODEC_ID_PCM_S16LE)
202         id = ff_get_pcm_codec_id(bps, 0, 0, ~1);
203     else if (id == AV_CODEC_ID_PCM_F32LE)
204         id = ff_get_pcm_codec_id(bps, 1, 0,  0);
205
206     if (id == AV_CODEC_ID_ADPCM_IMA_WAV && bps == 8)
207         id = AV_CODEC_ID_PCM_ZORK;
208     return id;
209 }
210
211 int ff_get_bmp_header(AVIOContext *pb, AVStream *st, uint32_t *size)
212 {
213     int tag1;
214     uint32_t size_ = avio_rl32(pb);
215     if (size)
216         *size = size_;
217     st->codecpar->width  = avio_rl32(pb);
218     st->codecpar->height = (int32_t)avio_rl32(pb);
219     avio_rl16(pb); /* planes */
220     st->codecpar->bits_per_coded_sample = avio_rl16(pb); /* depth */
221     tag1                                = avio_rl32(pb);
222     avio_rl32(pb); /* ImageSize */
223     avio_rl32(pb); /* XPelsPerMeter */
224     avio_rl32(pb); /* YPelsPerMeter */
225     avio_rl32(pb); /* ClrUsed */
226     avio_rl32(pb); /* ClrImportant */
227     return tag1;
228 }
229
230 int ff_read_riff_info(AVFormatContext *s, int64_t size)
231 {
232     int64_t start, end, cur;
233     AVIOContext *pb = s->pb;
234
235     start = avio_tell(pb);
236     end   = start + size;
237
238     while ((cur = avio_tell(pb)) >= 0 &&
239            cur <= end - 8 /* = tag + size */) {
240         uint32_t chunk_code;
241         int64_t chunk_size;
242         char key[5] = { 0 };
243         char *value;
244
245         chunk_code = avio_rl32(pb);
246         chunk_size = avio_rl32(pb);
247         if (avio_feof(pb)) {
248             if (chunk_code || chunk_size) {
249                 av_log(s, AV_LOG_WARNING, "INFO subchunk truncated\n");
250                 return AVERROR_INVALIDDATA;
251             }
252             return AVERROR_EOF;
253         }
254         if (chunk_size > end ||
255             end - chunk_size < cur ||
256             chunk_size == UINT_MAX) {
257             avio_seek(pb, -9, SEEK_CUR);
258             chunk_code = avio_rl32(pb);
259             chunk_size = avio_rl32(pb);
260             if (chunk_size > end || end - chunk_size < cur || chunk_size == UINT_MAX) {
261                 av_log(s, AV_LOG_WARNING, "too big INFO subchunk\n");
262                 return AVERROR_INVALIDDATA;
263             }
264         }
265
266         chunk_size += (chunk_size & 1);
267
268         if (!chunk_code) {
269             if (chunk_size)
270                 avio_skip(pb, chunk_size);
271             else if (pb->eof_reached) {
272                 av_log(s, AV_LOG_WARNING, "truncated file\n");
273                 return AVERROR_EOF;
274             }
275             continue;
276         }
277
278         value = av_mallocz(chunk_size + 1);
279         if (!value) {
280             av_log(s, AV_LOG_ERROR,
281                    "out of memory, unable to read INFO tag\n");
282             return AVERROR(ENOMEM);
283         }
284
285         AV_WL32(key, chunk_code);
286         // Work around VC++ 2015 Update 1 code-gen bug:
287         // https://connect.microsoft.com/VisualStudio/feedback/details/2291638
288         key[4] = 0;
289
290         if (avio_read(pb, value, chunk_size) != chunk_size) {
291             av_log(s, AV_LOG_WARNING,
292                    "premature end of file while reading INFO tag\n");
293         }
294
295         av_dict_set(&s->metadata, key, value, AV_DICT_DONT_STRDUP_VAL);
296     }
297
298     return 0;
299 }