Add ff_ prefix to vorbis_comment
[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     /**
44      * Translate a granule into a timestamp.
45      * Will set dts if non-null and known.
46      * @return pts
47      */
48     uint64_t (*gptopts)(AVFormatContext *, int, uint64_t, int64_t *dts);
49     /**
50      * 1 if granule is the start time of the associated packet.
51      * 0 if granule is the end time of the associated packet.
52      */
53     int granule_is_start;
54 };
55
56 struct ogg_stream {
57     uint8_t *buf;
58     unsigned int bufsize;
59     unsigned int bufpos;
60     unsigned int pstart;
61     unsigned int psize;
62     unsigned int pflags;
63     unsigned int pduration;
64     uint32_t serial;
65     uint32_t seq;
66     uint64_t granule;
67     int64_t lastpts;
68     int64_t lastdts;
69     int64_t sync_pos;   ///< file offset of the first page needed to reconstruct the current packet
70     int64_t page_pos;   ///< file offset of the current page
71     int flags;
72     const struct ogg_codec *codec;
73     int header;
74     int nsegs, segp;
75     uint8_t segments[255];
76     int incomplete; ///< whether we're expecting a continuation in the next page
77     int page_end;   ///< current packet is the last one completed in the page
78     int keyframe_seek;
79     void *private;
80 };
81
82 struct ogg_state {
83     uint64_t pos;
84     int curidx;
85     struct ogg_state *next;
86     int nstreams;
87     struct ogg_stream streams[1];
88 };
89
90 struct ogg {
91     struct ogg_stream *streams;
92     int nstreams;
93     int headers;
94     int curidx;
95     uint64_t size;
96     struct ogg_state *state;
97 };
98
99 #define OGG_FLAG_CONT 1
100 #define OGG_FLAG_BOS  2
101 #define OGG_FLAG_EOS  4
102
103 extern const struct ogg_codec ff_dirac_codec;
104 extern const struct ogg_codec ff_flac_codec;
105 extern const struct ogg_codec ff_ogm_audio_codec;
106 extern const struct ogg_codec ff_ogm_old_codec;
107 extern const struct ogg_codec ff_ogm_text_codec;
108 extern const struct ogg_codec ff_ogm_video_codec;
109 extern const struct ogg_codec ff_old_dirac_codec;
110 extern const struct ogg_codec ff_old_flac_codec;
111 extern const struct ogg_codec ff_skeleton_codec;
112 extern const struct ogg_codec ff_speex_codec;
113 extern const struct ogg_codec ff_theora_codec;
114 extern const struct ogg_codec ff_vorbis_codec;
115
116 extern const AVMetadataConv ff_vorbiscomment_metadata_conv[];
117
118 int ff_vorbis_comment(AVFormatContext *ms, uint8_t *buf, int size);
119
120 static inline int
121 ogg_find_stream (struct ogg * ogg, int serial)
122 {
123     int i;
124
125     for (i = 0; i < ogg->nstreams; i++)
126         if (ogg->streams[i].serial == serial)
127             return i;
128
129     return -1;
130 }
131
132 static inline uint64_t
133 ogg_gptopts (AVFormatContext * s, int i, uint64_t gp, int64_t *dts)
134 {
135     struct ogg *ogg = s->priv_data;
136     struct ogg_stream *os = ogg->streams + i;
137     uint64_t pts = AV_NOPTS_VALUE;
138
139     if(os->codec && os->codec->gptopts){
140         pts = os->codec->gptopts(s, i, gp, dts);
141     } else {
142         pts = gp;
143         if (dts)
144             *dts = pts;
145     }
146
147     return pts;
148 }
149
150 #endif /* AVFORMAT_OGGDEC_H */