Add a VorbisComment metadata conversion table and use it in the FLAC and
[ffmpeg.git] / libavformat / oggdec.h
1 /**
2     Copyright (C) 2005  Michael Ahlberg, Måns Rullgård
3
4     Permission is hereby granted, free of charge, to any person
5     obtaining a copy of this software and associated documentation
6     files (the "Software"), to deal in the Software without
7     restriction, including without limitation the rights to use, copy,
8     modify, merge, publish, distribute, sublicense, and/or sell copies
9     of the Software, and to permit persons to whom the Software is
10     furnished to do so, subject to the following conditions:
11
12     The above copyright notice and this permission notice shall be
13     included in all copies or substantial portions of the Software.
14
15     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19     HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20     WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22     DEALINGS IN THE SOFTWARE.
23 **/
24
25 #ifndef AVFORMAT_OGGDEC_H
26 #define AVFORMAT_OGGDEC_H
27
28 #include "avformat.h"
29 #include "metadata.h"
30
31 struct ogg_codec {
32     const int8_t *magic;
33     uint8_t magicsize;
34     const int8_t *name;
35     /**
36      * Attempt to process a packet as a header
37      * @return 1 if the packet was a valid header,
38      *         0 if the packet was not a header (was a data packet)
39      *         -1 if an error occurred or for unsupported stream
40      */
41     int (*header)(AVFormatContext *, int);
42     int (*packet)(AVFormatContext *, int);
43     uint64_t (*gptopts)(AVFormatContext *, int, uint64_t);
44 };
45
46 struct ogg_stream {
47     uint8_t *buf;
48     unsigned int bufsize;
49     unsigned int bufpos;
50     unsigned int pstart;
51     unsigned int psize;
52     unsigned int pflags;
53     uint32_t serial;
54     uint32_t seq;
55     uint64_t granule, lastgp;
56     int flags;
57     const struct ogg_codec *codec;
58     int header;
59     int nsegs, segp;
60     uint8_t segments[255];
61     void *private;
62 };
63
64 struct ogg_state {
65     uint64_t pos;
66     int curidx;
67     struct ogg_state *next;
68     int nstreams;
69     struct ogg_stream streams[1];
70 };
71
72 struct ogg {
73     struct ogg_stream *streams;
74     int nstreams;
75     int headers;
76     int curidx;
77     uint64_t size;
78     struct ogg_state *state;
79 };
80
81 #define OGG_FLAG_CONT 1
82 #define OGG_FLAG_BOS  2
83 #define OGG_FLAG_EOS  4
84
85 extern const struct ogg_codec ff_flac_codec;
86 extern const struct ogg_codec ff_ogm_audio_codec;
87 extern const struct ogg_codec ff_ogm_old_codec;
88 extern const struct ogg_codec ff_ogm_text_codec;
89 extern const struct ogg_codec ff_ogm_video_codec;
90 extern const struct ogg_codec ff_old_flac_codec;
91 extern const struct ogg_codec ff_speex_codec;
92 extern const struct ogg_codec ff_theora_codec;
93 extern const struct ogg_codec ff_vorbis_codec;
94
95 extern const AVMetadataConv ff_vorbiscomment_metadata_conv[];
96
97 int vorbis_comment(AVFormatContext *ms, uint8_t *buf, int size);
98
99 #endif /* AVFORMAT_OGGDEC_H */