electronicarts: Let functions always returning the same value return void
[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      * Number of expected headers
56      */
57     int nb_header;
58     void (*cleanup)(AVFormatContext *s, int idx);
59 };
60
61 struct ogg_stream {
62     uint8_t *buf;
63     unsigned int bufsize;
64     unsigned int bufpos;
65     unsigned int pstart;
66     unsigned int psize;
67     unsigned int pflags;
68     unsigned int pduration;
69     uint32_t serial;
70     uint64_t granule;
71     uint64_t start_granule;
72     int64_t lastpts;
73     int64_t lastdts;
74     int64_t sync_pos;   ///< file offset of the first page needed to reconstruct the current packet
75     int64_t page_pos;   ///< file offset of the current page
76     int flags;
77     const struct ogg_codec *codec;
78     int header;
79     int nsegs, segp;
80     uint8_t segments[255];
81     int incomplete; ///< whether we're expecting a continuation in the next page
82     int page_end;   ///< current packet is the last one completed in the page
83     int keyframe_seek;
84     int nb_header; ///< set to the number of parsed headers
85     void *private;
86 };
87
88 struct ogg_state {
89     uint64_t pos;
90     int curidx;
91     struct ogg_state *next;
92     int nstreams;
93     struct ogg_stream streams[1];
94 };
95
96 struct ogg {
97     struct ogg_stream *streams;
98     int nstreams;
99     int headers;
100     int curidx;
101     struct ogg_state *state;
102 };
103
104 #define OGG_FLAG_CONT 1
105 #define OGG_FLAG_BOS  2
106 #define OGG_FLAG_EOS  4
107
108 #define OGG_NOGRANULE_VALUE -1ull
109
110 extern const struct ogg_codec ff_celt_codec;
111 extern const struct ogg_codec ff_dirac_codec;
112 extern const struct ogg_codec ff_flac_codec;
113 extern const struct ogg_codec ff_ogm_audio_codec;
114 extern const struct ogg_codec ff_ogm_old_codec;
115 extern const struct ogg_codec ff_ogm_text_codec;
116 extern const struct ogg_codec ff_ogm_video_codec;
117 extern const struct ogg_codec ff_old_dirac_codec;
118 extern const struct ogg_codec ff_old_flac_codec;
119 extern const struct ogg_codec ff_skeleton_codec;
120 extern const struct ogg_codec ff_speex_codec;
121 extern const struct ogg_codec ff_theora_codec;
122 extern const struct ogg_codec ff_vorbis_codec;
123
124 int ff_vorbis_comment(AVFormatContext *ms, AVDictionary **m, const uint8_t *buf, int size);
125
126 static inline int
127 ogg_find_stream (struct ogg * ogg, int serial)
128 {
129     int i;
130
131     for (i = 0; i < ogg->nstreams; i++)
132         if (ogg->streams[i].serial == serial)
133             return i;
134
135     return -1;
136 }
137
138 static inline uint64_t
139 ogg_gptopts (AVFormatContext * s, int i, uint64_t gp, int64_t *dts)
140 {
141     struct ogg *ogg = s->priv_data;
142     struct ogg_stream *os = ogg->streams + i;
143     uint64_t pts = AV_NOPTS_VALUE;
144
145     if(os->codec && os->codec->gptopts){
146         pts = os->codec->gptopts(s, i, gp, dts);
147     } else {
148         pts = gp;
149         if (dts)
150             *dts = pts;
151     }
152
153     return pts;
154 }
155
156 #endif /* AVFORMAT_OGGDEC_H */