FFmpeg  2.1.1
oggdec.h
Go to the documentation of this file.
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;
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  */
54  /**
55  * Number of expected headers
56  */
57  int nb_header;
58  void (*cleanup)(AVFormatContext *s, int idx);
59 };
60 
61 struct ogg_stream {
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;
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
84  int got_start;
85  int got_data; ///< 1 if the stream got some data (non-initial packets), 0 otherwise
86  int nb_header; ///< set to the number of parsed headers
87  int end_trimming; ///< set the number of packets to drop from the end
88  void *private;
89 };
90 
91 struct ogg_state {
92  uint64_t pos;
93  int curidx;
94  struct ogg_state *next;
95  int nstreams;
96  struct ogg_stream streams[1];
97 };
98 
99 struct ogg {
101  int nstreams;
102  int headers;
103  int curidx;
104  int64_t page_pos; ///< file offset of the current page
105  struct ogg_state *state;
106 };
107 
108 #define OGG_FLAG_CONT 1
109 #define OGG_FLAG_BOS 2
110 #define OGG_FLAG_EOS 4
111 
112 #define OGG_NOGRANULE_VALUE (-1ull)
113 
114 extern const struct ogg_codec ff_celt_codec;
115 extern const struct ogg_codec ff_dirac_codec;
116 extern const struct ogg_codec ff_flac_codec;
117 extern const struct ogg_codec ff_ogm_audio_codec;
118 extern const struct ogg_codec ff_ogm_old_codec;
119 extern const struct ogg_codec ff_ogm_text_codec;
120 extern const struct ogg_codec ff_ogm_video_codec;
121 extern const struct ogg_codec ff_old_dirac_codec;
122 extern const struct ogg_codec ff_old_flac_codec;
123 extern const struct ogg_codec ff_opus_codec;
124 extern const struct ogg_codec ff_skeleton_codec;
125 extern const struct ogg_codec ff_speex_codec;
126 extern const struct ogg_codec ff_theora_codec;
127 extern const struct ogg_codec ff_vorbis_codec;
128 
130 
131 static inline int
132 ogg_find_stream (struct ogg * ogg, int serial)
133 {
134  int i;
135 
136  for (i = 0; i < ogg->nstreams; i++)
137  if (ogg->streams[i].serial == serial)
138  return i;
139 
140  return -1;
141 }
142 
143 static inline uint64_t
144 ogg_gptopts (AVFormatContext * s, int i, uint64_t gp, int64_t *dts)
145 {
146  struct ogg *ogg = s->priv_data;
147  struct ogg_stream *os = ogg->streams + i;
148  uint64_t pts = AV_NOPTS_VALUE;
149 
150  if(os->codec && os->codec->gptopts){
151  pts = os->codec->gptopts(s, i, gp, dts);
152  } else {
153  pts = gp;
154  if (dts)
155  *dts = pts;
156  }
157 
158  return pts;
159 }
160 
161 #endif /* AVFORMAT_OGGDEC_H */
int headers
Definition: oggdec.h:102
int header
Definition: oggdec.h:78
int granule_is_start
1 if granule is the start time of the associated packet.
Definition: oggdec.h:53
struct ogg_codec ff_theora_codec
const char * s
Definition: avisynth_c.h:668
int size
int nstreams
Definition: oggdec.h:101
struct ogg_codec ff_ogm_audio_codec
Definition: oggparseogm.c:178
Copyright (C) 2005 Michael Ahlberg, Måns Rullgård.
Definition: oggdec.h:31
unsigned int bufsize
Definition: oggdec.h:63
unsigned int pflags
Definition: oggdec.h:67
int nb_header
set to the number of parsed headers
Definition: oggdec.h:86
struct ogg_codec ff_opus_codec
Definition: oggparseopus.c:133
void(* cleanup)(AVFormatContext *s, int idx)
Definition: oggdec.h:58
int flags
Definition: oggdec.h:76
int64_t lastpts
Definition: oggdec.h:72
Format I/O context.
Definition: avformat.h:968
unsigned int psize
Definition: oggdec.h:66
int64_t sync_pos
file offset of the first page needed to reconstruct the current packet
Definition: oggdec.h:74
uint64_t pos
Definition: oggdec.h:92
internal metadata API header see avformat.h or the public API!
uint8_t
struct ogg_codec ff_ogm_video_codec
Definition: oggparseogm.c:169
int64_t page_pos
file offset of the current page
Definition: oggdec.h:75
struct ogg_state * state
Definition: oggdec.h:105
int nstreams
Definition: oggdec.h:95
int end_trimming
set the number of packets to drop from the end
Definition: oggdec.h:87
int ff_vorbis_comment(AVFormatContext *ms, AVDictionary **m, const uint8_t *buf, int size)
struct ogg_codec * codec
Definition: oggdec.h:77
void * priv_data
Format private data.
Definition: avformat.h:988
unsigned m
Definition: audioconvert.c:186
uint8_t segments[255]
Definition: oggdec.h:80
int incomplete
whether we&#39;re expecting a continuation in the next page
Definition: oggdec.h:81
struct ogg_codec ff_skeleton_codec
struct ogg_codec ff_old_flac_codec
Definition: oggparseflac.c:115
uint32_t serial
Definition: oggdec.h:69
struct ogg_codec ff_ogm_text_codec
Definition: oggparseogm.c:187
uint64_t granule
Definition: oggdec.h:70
unsigned int pstart
Definition: oggdec.h:65
uint64_t start_granule
Definition: oggdec.h:71
int(* packet)(AVFormatContext *, int)
Definition: oggdec.h:42
struct ogg_stream * streams
Definition: oggdec.h:100
int segp
Definition: oggdec.h:79
int page_end
current packet is the last one completed in the page
Definition: oggdec.h:82
struct ogg_codec ff_speex_codec
struct ogg_codec ff_vorbis_codec
static int ogg_find_stream(struct ogg *ogg, int serial)
Definition: oggdec.h:132
unsigned int pduration
Definition: oggdec.h:68
int got_start
Definition: oggdec.h:84
int nsegs
Definition: oggdec.h:79
typedef void(RENAME(mix_any_func_type))
struct ogg_codec ff_celt_codec
Definition: oggparsecelt.c:85
const int8_t * name
Definition: oggdec.h:34
void * buf
Definition: avisynth_c.h:594
struct ogg_state * next
Definition: oggdec.h:94
int nb_header
Number of expected headers.
Definition: oggdec.h:57
int64_t lastdts
Definition: oggdec.h:73
int curidx
Definition: oggdec.h:93
const int8_t * magic
Definition: oggdec.h:32
uint8_t * buf
Definition: oggdec.h:62
struct ogg_codec ff_ogm_old_codec
Definition: oggparseogm.c:196
uint64_t(* gptopts)(AVFormatContext *, int, uint64_t, int64_t *dts)
Translate a granule into a timestamp.
Definition: oggdec.h:48
Main libavformat public API header.
struct ogg_codec ff_old_dirac_codec
int got_data
1 if the stream got some data (non-initial packets), 0 otherwise
Definition: oggdec.h:85
int keyframe_seek
Definition: oggdec.h:83
struct ogg_codec ff_flac_codec
Definition: oggparseflac.c:108
Definition: oggdec.h:99
int64_t page_pos
file offset of the current page
Definition: oggdec.h:104
uint8_t magicsize
Definition: oggdec.h:33
#define gp
Definition: regdef.h:62
int curidx
Definition: oggdec.h:103
struct ogg_codec ff_dirac_codec
struct ogg_stream streams[1]
Definition: oggdec.h:96
int(* header)(AVFormatContext *, int)
Attempt to process a packet as a header.
Definition: oggdec.h:41
unsigned int bufpos
Definition: oggdec.h:64
static uint64_t ogg_gptopts(AVFormatContext *s, int i, uint64_t gp, int64_t *dts)
Definition: oggdec.h:144
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avcodec.h:2278