Imported Upstream version 6.1
[platform/upstream/ffmpeg.git] / libavformat / riff.h
1 /*
2  * RIFF common 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 /**
23  * @file
24  * internal header for RIFF based (de)muxers
25  * do NOT include this in end user applications
26  */
27
28 #ifndef AVFORMAT_RIFF_H
29 #define AVFORMAT_RIFF_H
30
31 #include "avio.h"
32 #include "internal.h"
33 #include "metadata.h"
34
35 extern const AVMetadataConv ff_riff_info_conv[];
36
37 int64_t ff_start_tag(AVIOContext *pb, const char *tag);
38 void ff_end_tag(AVIOContext *pb, int64_t start);
39
40 /**
41  * Read BITMAPINFOHEADER structure and set AVStream codec width, height and
42  * bits_per_encoded_sample fields. Does not read extradata.
43  * Writes the size of the BMP file to *size.
44  * @return codec tag
45  */
46 int ff_get_bmp_header(AVIOContext *pb, AVStream *st, uint32_t *size);
47
48 void ff_put_bmp_header(AVIOContext *pb, AVCodecParameters *par, int for_asf, int ignore_extradata, int rgb_frame_is_flipped);
49
50 /**
51  * Tell ff_put_wav_header() to use WAVEFORMATEX even for PCM codecs.
52  */
53 #define FF_PUT_WAV_HEADER_FORCE_WAVEFORMATEX    0x00000001
54
55 /**
56  * Tell ff_put_wav_header() to write an empty channel mask.
57  */
58 #define FF_PUT_WAV_HEADER_SKIP_CHANNELMASK      0x00000002
59
60 /**
61  * Write WAVEFORMAT header structure.
62  *
63  * @param flags a combination of FF_PUT_WAV_HEADER_* constants
64  *
65  * @return the size or -1 on error
66  */
67 int ff_put_wav_header(AVFormatContext *s, AVIOContext *pb, AVCodecParameters *par, int flags);
68
69 enum AVCodecID ff_wav_codec_get_id(unsigned int tag, int bps);
70 int ff_get_wav_header(void *logctx, AVIOContext *pb, AVCodecParameters *par,
71                       int size, int big_endian);
72
73 extern const AVCodecTag ff_codec_bmp_tags[]; // exposed through avformat_get_riff_video_tags()
74 extern const AVCodecTag ff_codec_wav_tags[];
75 /* The following list contains both ff_codec_bmp_tags and ff_codec_wav_tags. */
76 extern const AVCodecTag *const ff_riff_codec_tags_list[];
77 /* The following list contains only ff_codec_wav_tags. */
78 extern const AVCodecTag *const ff_wav_codec_tags_list[];
79
80 extern const AVCodecTag ff_codec_bmp_tags_unofficial[];
81
82 void ff_parse_specific_params(AVStream *st, int *au_rate, int *au_ssize, int *au_scale);
83
84 int ff_read_riff_info(AVFormatContext *s, int64_t size);
85
86 /**
87  * Write all recognized RIFF tags from s->metadata
88  */
89 void ff_riff_write_info(AVFormatContext *s);
90
91 /**
92  * Write a single RIFF info tag
93  */
94 void ff_riff_write_info_tag(AVIOContext *pb, const char *tag, const char *str);
95
96 typedef uint8_t ff_asf_guid[16];
97
98 typedef struct AVCodecGuid {
99     enum AVCodecID id;
100     ff_asf_guid guid;
101 } AVCodecGuid;
102
103 extern const AVCodecGuid ff_codec_wav_guids[];
104
105 #define FF_PRI_GUID \
106     "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x " \
107     "{%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x}"
108
109 #define FF_ARG_GUID(g) \
110     g[0], g[1], g[2],  g[3],  g[4],  g[5],  g[6],  g[7], \
111     g[8], g[9], g[10], g[11], g[12], g[13], g[14], g[15],\
112     g[3], g[2], g[1],  g[0],  g[5],  g[4],  g[7],  g[6], \
113     g[8], g[9], g[10], g[11], g[12], g[13], g[14], g[15]
114
115 #define FF_MEDIASUBTYPE_BASE_GUID \
116     0x00, 0x00, 0x10, 0x00, 0x80, 0x00, 0x00, 0xAA, 0x00, 0x38, 0x9B, 0x71
117 #define FF_AMBISONIC_BASE_GUID \
118     0x21, 0x07, 0xD3, 0x11, 0x86, 0x44, 0xC8, 0xC1, 0xCA, 0x00, 0x00, 0x00
119 #define FF_BROKEN_BASE_GUID \
120     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x80, 0x00, 0x00, 0xAA
121
122 static av_always_inline int ff_guidcmp(const void *g1, const void *g2)
123 {
124     return memcmp(g1, g2, sizeof(ff_asf_guid));
125 }
126
127 int ff_get_guid(AVIOContext *s, ff_asf_guid *g);
128 void ff_put_guid(AVIOContext *s, const ff_asf_guid *g);
129 const ff_asf_guid *ff_get_codec_guid(enum AVCodecID id, const AVCodecGuid *av_guid);
130
131 enum AVCodecID ff_codec_guid_get_id(const AVCodecGuid *guids, ff_asf_guid guid);
132
133 #endif /* AVFORMAT_RIFF_H */