FFmpeg
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 
30 struct ogg_codec {
31  const int8_t *magic;
32  uint8_t magicsize;
33  const int8_t *name;
34  /**
35  * Attempt to process a packet as a header
36  * @return 1 if the packet was a valid header,
37  * 0 if the packet was not a header (was a data packet)
38  * -1 if an error occurred or for unsupported stream
39  */
42  /**
43  * Translate a granule into a timestamp.
44  * Will set dts if non-null and known.
45  * @return pts
46  */
47  uint64_t (*gptopts)(AVFormatContext *, int, uint64_t, int64_t *dts);
48  /**
49  * 1 if granule is the start time of the associated packet.
50  * 0 if granule is the end time of the associated packet.
51  */
53  /**
54  * Number of expected headers
55  */
56  int nb_header;
57  void (*cleanup)(AVFormatContext *s, int idx);
58 };
59 
60 struct ogg_stream {
61  uint8_t *buf;
62  unsigned int bufsize;
63  unsigned int bufpos;
64  unsigned int pstart;
65  unsigned int psize;
66  unsigned int pflags;
67  unsigned int pduration;
68  uint32_t serial;
69  uint64_t granule;
70  uint64_t start_granule;
71  int64_t lastpts;
72  int64_t lastdts;
73  int64_t sync_pos; ///< file offset of the first page needed to reconstruct the current packet
74  int64_t page_pos; ///< file offset of the current page
75  int flags;
76  const struct ogg_codec *codec;
77  int header;
78  int nsegs, segp;
79  uint8_t segments[255];
80  int incomplete; ///< whether we're expecting a continuation in the next page
81  int page_end; ///< current packet is the last one completed in the page
83  int got_start;
84  int got_data; ///< 1 if the stream got some data (non-initial packets), 0 otherwise
85  int nb_header; ///< set to the number of parsed headers
86  int start_trimming; ///< set the number of packets to drop from the start
87  int end_trimming; ///< set the number of packets to drop from the end
88  uint8_t *new_metadata;
90  void *private;
91 };
92 
93 struct ogg_state {
94  uint64_t pos;
95  int curidx;
96  struct ogg_state *next;
97  int nstreams;
98  struct ogg_stream streams[1];
99 };
100 
101 struct ogg {
103  int nstreams;
104  int headers;
105  int curidx;
106  int64_t page_pos; ///< file offset of the current page
107  struct ogg_state *state;
108 };
109 
110 #define OGG_FLAG_CONT 1
111 #define OGG_FLAG_BOS 2
112 #define OGG_FLAG_EOS 4
113 
114 #define OGG_NOGRANULE_VALUE (-1ull)
115 
116 extern const struct ogg_codec ff_celt_codec;
117 extern const struct ogg_codec ff_dirac_codec;
118 extern const struct ogg_codec ff_flac_codec;
119 extern const struct ogg_codec ff_ogm_audio_codec;
120 extern const struct ogg_codec ff_ogm_old_codec;
121 extern const struct ogg_codec ff_ogm_text_codec;
122 extern const struct ogg_codec ff_ogm_video_codec;
123 extern const struct ogg_codec ff_old_dirac_codec;
124 extern const struct ogg_codec ff_old_flac_codec;
125 extern const struct ogg_codec ff_opus_codec;
126 extern const struct ogg_codec ff_skeleton_codec;
127 extern const struct ogg_codec ff_speex_codec;
128 extern const struct ogg_codec ff_theora_codec;
129 extern const struct ogg_codec ff_vorbis_codec;
130 extern const struct ogg_codec ff_vp8_codec;
131 
132 /**
133  * Parse Vorbis comments
134  *
135  * @note The buffer will be temporarily modifed by this function,
136  * so it needs to be writable. Furthermore it must be padded
137  * by a single byte (not counted in size).
138  * All changes will have been reverted upon return.
139  */
141  const uint8_t *buf, int size, int parse_picture);
142 
143 /**
144  * Parse Vorbis comments and add metadata to an AVStream
145  *
146  * @note The buffer will be temporarily modifed by this function,
147  * so it needs to be writable. Furthermore it must be padded
148  * by a single byte (not counted in size).
149  * All changes will have been reverted upon return.
150  */
152  const uint8_t *buf, int size);
153 
154 static inline int
155 ogg_find_stream (struct ogg * ogg, int serial)
156 {
157  int i;
158 
159  for (i = 0; i < ogg->nstreams; i++)
160  if (ogg->streams[i].serial == serial)
161  return i;
162 
163  return -1;
164 }
165 
166 static inline uint64_t
167 ogg_gptopts (AVFormatContext * s, int i, uint64_t gp, int64_t *dts)
168 {
169  struct ogg *ogg = s->priv_data;
170  struct ogg_stream *os = ogg->streams + i;
171  uint64_t pts = AV_NOPTS_VALUE;
172 
173  if(os->codec && os->codec->gptopts){
174  pts = os->codec->gptopts(s, i, gp, dts);
175  } else {
176  pts = gp;
177  if (dts)
178  *dts = pts;
179  }
180  if (pts > INT64_MAX && pts != AV_NOPTS_VALUE) {
181  // The return type is unsigned, we thus cannot return negative pts
182  av_log(s, AV_LOG_ERROR, "invalid pts %"PRId64"\n", pts);
184  }
185 
186  return pts;
187 }
188 
189 #endif /* AVFORMAT_OGGDEC_H */
ff_old_flac_codec
const struct ogg_codec ff_old_flac_codec
Definition: oggparseflac.c:136
ff_ogm_text_codec
const struct ogg_codec ff_ogm_text_codec
Definition: oggparseogm.c:213
ogg_stream::segp
int segp
Definition: oggdec.h:78
ogg_stream::lastpts
int64_t lastpts
Definition: oggdec.h:71
ff_ogm_audio_codec
const struct ogg_codec ff_ogm_audio_codec
Definition: oggparseogm.c:204
ogg_codec::magicsize
uint8_t magicsize
Definition: oggdec.h:32
ogg_state::pos
uint64_t pos
Definition: oggdec.h:94
ogg_stream::bufpos
unsigned int bufpos
Definition: oggdec.h:63
ogg_state::streams
struct ogg_stream streams[1]
Definition: oggdec.h:98
ff_vp8_codec
const struct ogg_codec ff_vp8_codec
Definition: oggparsevp8.c:139
ogg_stream::got_start
int got_start
Definition: oggdec.h:83
ff_old_dirac_codec
const struct ogg_codec ff_old_dirac_codec
Definition: oggparsedirac.c:125
ogg_stream::granule
uint64_t granule
Definition: oggdec.h:69
ogg_stream::start_trimming
int start_trimming
set the number of packets to drop from the start
Definition: oggdec.h:86
ogg_codec::gptopts
uint64_t(* gptopts)(AVFormatContext *, int, uint64_t, int64_t *dts)
Translate a granule into a timestamp.
Definition: oggdec.h:47
ogg_stream::nb_header
int nb_header
set to the number of parsed headers
Definition: oggdec.h:85
AVDictionary
Definition: dict.c:32
ogg_stream::buf
uint8_t * buf
Definition: oggdec.h:61
ogg_stream::nsegs
int nsegs
Definition: oggdec.h:78
ogg
Definition: oggdec.h:101
ff_vorbis_codec
const struct ogg_codec ff_vorbis_codec
Definition: oggparsevorbis.c:505
ff_flac_codec
const struct ogg_codec ff_flac_codec
Definition: oggparseflac.c:129
ogg_codec::packet
int(* packet)(AVFormatContext *, int)
Definition: oggdec.h:41
ogg_gptopts
static uint64_t ogg_gptopts(AVFormatContext *s, int i, uint64_t gp, int64_t *dts)
Definition: oggdec.h:167
ogg_stream::serial
uint32_t serial
Definition: oggdec.h:68
ogg_stream::lastdts
int64_t lastdts
Definition: oggdec.h:72
ogg::headers
int headers
Definition: oggdec.h:104
ogg_state::nstreams
int nstreams
Definition: oggdec.h:97
pts
static int64_t pts
Definition: transcode_aac.c:654
ogg_stream::pstart
unsigned int pstart
Definition: oggdec.h:64
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
s
#define s(width, name)
Definition: cbs_vp9.c:256
ogg_stream::got_data
int got_data
1 if the stream got some data (non-initial packets), 0 otherwise
Definition: oggdec.h:84
ogg_stream::page_end
int page_end
current packet is the last one completed in the page
Definition: oggdec.h:81
ogg::curidx
int curidx
Definition: oggdec.h:105
ogg_stream::new_metadata
uint8_t * new_metadata
Definition: oggdec.h:88
ogg_stream::page_pos
int64_t page_pos
file offset of the current page
Definition: oggdec.h:74
AVFormatContext
Format I/O context.
Definition: avformat.h:1216
ogg_codec::header
int(* header)(AVFormatContext *, int)
Attempt to process a packet as a header.
Definition: oggdec.h:40
ff_ogm_old_codec
const struct ogg_codec ff_ogm_old_codec
Definition: oggparseogm.c:222
ogg_stream::flags
int flags
Definition: oggdec.h:75
ogg::page_pos
int64_t page_pos
file offset of the current page
Definition: oggdec.h:106
ogg::streams
struct ogg_stream * streams
Definition: oggdec.h:102
gp
#define gp
Definition: regdef.h:62
ogg_stream::keyframe_seek
int keyframe_seek
Definition: oggdec.h:82
size
int size
Definition: twinvq_data.h:10344
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
ogg_codec::name
const int8_t * name
Definition: oggdec.h:33
ogg::state
struct ogg_state * state
Definition: oggdec.h:107
ogg_state::next
struct ogg_state * next
Definition: oggdec.h:96
ogg_stream::pflags
unsigned int pflags
Definition: oggdec.h:66
ogg::nstreams
int nstreams
Definition: oggdec.h:103
ogg_stream::sync_pos
int64_t sync_pos
file offset of the first page needed to reconstruct the current packet
Definition: oggdec.h:73
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
ogg_stream::incomplete
int incomplete
whether we're expecting a continuation in the next page
Definition: oggdec.h:80
ogg_stream
Definition: oggdec.h:60
ff_ogm_video_codec
const struct ogg_codec ff_ogm_video_codec
Definition: oggparseogm.c:195
ff_skeleton_codec
const struct ogg_codec ff_skeleton_codec
Definition: oggparseskeleton.c:96
ogg_state::curidx
int curidx
Definition: oggdec.h:95
ogg_stream::header
int header
Definition: oggdec.h:77
AVStream
Stream structure.
Definition: avformat.h:948
avformat.h
ogg_find_stream
static int ogg_find_stream(struct ogg *ogg, int serial)
Definition: oggdec.h:155
ogg_codec::cleanup
void(* cleanup)(AVFormatContext *s, int idx)
Definition: oggdec.h:57
ogg_stream::start_granule
uint64_t start_granule
Definition: oggdec.h:70
ff_vorbis_stream_comment
int ff_vorbis_stream_comment(AVFormatContext *as, AVStream *st, const uint8_t *buf, int size)
Parse Vorbis comments and add metadata to an AVStream.
Definition: oggparsevorbis.c:73
ogg_stream::new_metadata_size
size_t new_metadata_size
Definition: oggdec.h:89
ogg_codec::nb_header
int nb_header
Number of expected headers.
Definition: oggdec.h:56
ogg_stream::segments
uint8_t segments[255]
Definition: oggdec.h:79
ogg_state
Definition: oggdec.h:93
ff_celt_codec
const struct ogg_codec ff_celt_codec
Definition: oggparsecelt.c:92
ogg_stream::psize
unsigned int psize
Definition: oggdec.h:65
ogg_codec
Copyright (C) 2005 Michael Ahlberg, Måns Rullgård.
Definition: oggdec.h:30
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
ogg_codec::magic
const int8_t * magic
Definition: oggdec.h:31
ogg_stream::end_trimming
int end_trimming
set the number of packets to drop from the end
Definition: oggdec.h:87
ff_dirac_codec
const struct ogg_codec ff_dirac_codec
Definition: oggparsedirac.c:116
ff_vorbis_comment
int ff_vorbis_comment(AVFormatContext *ms, AVDictionary **m, const uint8_t *buf, int size, int parse_picture)
Parse Vorbis comments.
Definition: oggparsevorbis.c:148
ff_speex_codec
const struct ogg_codec ff_speex_codec
Definition: oggparsespeex.c:143
int
int
Definition: ffmpeg_filter.c:156
ogg_codec::granule_is_start
int granule_is_start
1 if granule is the start time of the associated packet.
Definition: oggdec.h:52
ogg_stream::pduration
unsigned int pduration
Definition: oggdec.h:67
ff_theora_codec
const struct ogg_codec ff_theora_codec
Definition: oggparsetheora.c:211
ogg_stream::codec
const struct ogg_codec * codec
Definition: oggdec.h:76
ff_opus_codec
const struct ogg_codec ff_opus_codec
Definition: oggparseopus.c:181
ogg_stream::bufsize
unsigned int bufsize
Definition: oggdec.h:62