FFmpeg
riff.h
Go to the documentation of this file.
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  */
68 
69 enum AVCodecID ff_wav_codec_get_id(unsigned int tag, int bps);
70 int ff_get_wav_header(AVFormatContext *s, AVIOContext *pb, AVCodecParameters *par, int size, int big_endian);
71 
72 extern const AVCodecTag ff_codec_bmp_tags[]; // exposed through avformat_get_riff_video_tags()
73 extern const AVCodecTag ff_codec_wav_tags[];
74 /* The following list contains both ff_codec_bmp_tags and ff_codec_wav_tags. */
75 extern const AVCodecTag *const ff_riff_codec_tags_list[];
76 /* The following list contains only ff_codec_wav_tags. */
77 extern const AVCodecTag *const ff_wav_codec_tags_list[];
78 
80 
81 void ff_parse_specific_params(AVStream *st, int *au_rate, int *au_ssize, int *au_scale);
82 
84 
85 /**
86  * Write all recognized RIFF tags from s->metadata
87  */
89 
90 /**
91  * Write a single RIFF info tag
92  */
93 void ff_riff_write_info_tag(AVIOContext *pb, const char *tag, const char *str);
94 
95 typedef uint8_t ff_asf_guid[16];
96 
97 typedef struct AVCodecGuid {
98  enum AVCodecID id;
100 } AVCodecGuid;
101 
102 extern const AVCodecGuid ff_codec_wav_guids[];
103 
104 #define FF_PRI_GUID \
105  "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x " \
106  "{%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x}"
107 
108 #define FF_ARG_GUID(g) \
109  g[0], g[1], g[2], g[3], g[4], g[5], g[6], g[7], \
110  g[8], g[9], g[10], g[11], g[12], g[13], g[14], g[15],\
111  g[3], g[2], g[1], g[0], g[5], g[4], g[7], g[6], \
112  g[8], g[9], g[10], g[11], g[12], g[13], g[14], g[15]
113 
114 #define FF_MEDIASUBTYPE_BASE_GUID \
115  0x00, 0x00, 0x10, 0x00, 0x80, 0x00, 0x00, 0xAA, 0x00, 0x38, 0x9B, 0x71
116 #define FF_AMBISONIC_BASE_GUID \
117  0x21, 0x07, 0xD3, 0x11, 0x86, 0x44, 0xC8, 0xC1, 0xCA, 0x00, 0x00, 0x00
118 #define FF_BROKEN_BASE_GUID \
119  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x80, 0x00, 0x00, 0xAA
120 
121 static av_always_inline int ff_guidcmp(const void *g1, const void *g2)
122 {
123  return memcmp(g1, g2, sizeof(ff_asf_guid));
124 }
125 
127 void ff_put_guid(AVIOContext *s, const ff_asf_guid *g);
128 const ff_asf_guid *ff_get_codec_guid(enum AVCodecID id, const AVCodecGuid *av_guid);
129 
130 enum AVCodecID ff_codec_guid_get_id(const AVCodecGuid *guids, ff_asf_guid guid);
131 
132 #endif /* AVFORMAT_RIFF_H */
ff_riff_info_conv
const AVMetadataConv ff_riff_info_conv[]
Definition: riff.c:604
ff_get_guid
int ff_get_guid(AVIOContext *s, ff_asf_guid *g)
Definition: riffdec.c:31
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:52
ff_put_bmp_header
void ff_put_bmp_header(AVIOContext *pb, AVCodecParameters *par, int for_asf, int ignore_extradata, int rgb_frame_is_flipped)
Definition: riffenc.c:216
ff_wav_codec_get_id
enum AVCodecID ff_wav_codec_get_id(unsigned int tag, int bps)
Definition: riffdec.c:191
AVMetadataConv
Definition: metadata.h:34
ff_guidcmp
static av_always_inline int ff_guidcmp(const void *g1, const void *g2)
Definition: riff.h:121
ff_get_bmp_header
int ff_get_bmp_header(AVIOContext *pb, AVStream *st, uint32_t *size)
Read BITMAPINFOHEADER structure and set AVStream codec width, height and bits_per_encoded_sample fiel...
Definition: riffdec.c:208
ff_codec_bmp_tags_unofficial
const AVCodecTag ff_codec_bmp_tags_unofficial[]
Definition: riff.c:503
ff_start_tag
int64_t ff_start_tag(AVIOContext *pb, const char *tag)
Definition: riffenc.c:32
ff_codec_wav_guids
const AVCodecGuid ff_codec_wav_guids[]
Definition: riff.c:631
AVCodecTag
Definition: internal.h:50
s
#define s(width, name)
Definition: cbs_vp9.c:257
g
const char * g
Definition: vf_curves.c:117
ff_read_riff_info
int ff_read_riff_info(AVFormatContext *s, int64_t size)
Definition: riffdec.c:227
AVFormatContext
Format I/O context.
Definition: avformat.h:1107
internal.h
ff_asf_guid
uint8_t ff_asf_guid[16]
Definition: riff.h:95
ff_put_wav_header
int ff_put_wav_header(AVFormatContext *s, AVIOContext *pb, AVCodecParameters *par, int flags)
Write WAVEFORMAT header structure.
Definition: riffenc.c:55
AVCodecID
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:47
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
ff_riff_write_info_tag
void ff_riff_write_info_tag(AVIOContext *pb, const char *tag, const char *str)
Write a single RIFF info tag.
Definition: riffenc.c:303
AVCodecGuid::id
enum AVCodecID id
Definition: riff.h:98
bps
unsigned bps
Definition: movenc.c:1595
size
int size
Definition: twinvq_data.h:10344
AVCodecGuid
Definition: riff.h:97
avio.h
ff_end_tag
void ff_end_tag(AVIOContext *pb, int64_t start)
Definition: riffenc.c:39
ff_codec_guid_get_id
enum AVCodecID ff_codec_guid_get_id(const AVCodecGuid *guids, ff_asf_guid guid)
Definition: riffdec.c:43
av_always_inline
#define av_always_inline
Definition: attributes.h:49
ff_get_wav_header
int ff_get_wav_header(AVFormatContext *s, AVIOContext *pb, AVCodecParameters *par, int size, int big_endian)
Definition: riffdec.c:90
tag
uint32_t tag
Definition: movenc.c:1594
AVStream
Stream structure.
Definition: avformat.h:847
metadata.h
ff_parse_specific_params
void ff_parse_specific_params(AVStream *st, int *au_rate, int *au_ssize, int *au_scale)
Definition: riffenc.c:273
ff_put_guid
void ff_put_guid(AVIOContext *s, const ff_asf_guid *g)
Definition: riffenc.c:357
ff_riff_write_info
void ff_riff_write_info(AVFormatContext *s)
Write all recognized RIFF tags from s->metadata.
Definition: riffenc.c:335
ff_codec_bmp_tags
const AVCodecTag ff_codec_bmp_tags[]
Definition: riff.c:34
ff_get_codec_guid
const ff_asf_guid * ff_get_codec_guid(enum AVCodecID id, const AVCodecGuid *av_guid)
Definition: riffenc.c:363
convert_header.str
string str
Definition: convert_header.py:20
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
ff_codec_wav_tags
const AVCodecTag ff_codec_wav_tags[]
Definition: riff.c:509
AVCodecGuid::guid
ff_asf_guid guid
Definition: riff.h:99
ff_riff_codec_tags_list
const AVCodecTag *const ff_riff_codec_tags_list[]
ff_wav_codec_tags_list
const AVCodecTag *const ff_wav_codec_tags_list[]