Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 45aa9080

History | View | Annotate | Download (46.2 KB)

1 04d7f601 Diego Biurrun
/*
2
 * copyright (c) 2001 Fabrice Bellard
3
 *
4 b78e7197 Diego Biurrun
 * This file is part of FFmpeg.
5
 *
6
 * FFmpeg is free software; you can redistribute it and/or
7 04d7f601 Diego Biurrun
 * modify it under the terms of the GNU Lesser General Public
8
 * License as published by the Free Software Foundation; either
9 b78e7197 Diego Biurrun
 * version 2.1 of the License, or (at your option) any later version.
10 04d7f601 Diego Biurrun
 *
11 b78e7197 Diego Biurrun
 * FFmpeg is distributed in the hope that it will be useful,
12 04d7f601 Diego Biurrun
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 * Lesser General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU Lesser General Public
17 b78e7197 Diego Biurrun
 * License along with FFmpeg; if not, write to the Free Software
18 04d7f601 Diego Biurrun
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
 */
20
21 98790382 Stefano Sabatini
#ifndef AVFORMAT_AVFORMAT_H
22
#define AVFORMAT_AVFORMAT_H
23 de6d9b64 Fabrice Bellard
24 800c289a Måns Rullgård
#define LIBAVFORMAT_VERSION_MAJOR 52
25 45aa9080 Ronald S. Bultje
#define LIBAVFORMAT_VERSION_MINOR 48
26 7c3c53c8 Ramiro Polla
#define LIBAVFORMAT_VERSION_MICRO  0
27 e97ac1e6 Måns Rullgård
28 800c289a Måns Rullgård
#define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \
29
                                               LIBAVFORMAT_VERSION_MINOR, \
30
                                               LIBAVFORMAT_VERSION_MICRO)
31
#define LIBAVFORMAT_VERSION     AV_VERSION(LIBAVFORMAT_VERSION_MAJOR,   \
32
                                           LIBAVFORMAT_VERSION_MINOR,   \
33
                                           LIBAVFORMAT_VERSION_MICRO)
34 5aa083ee Michael Niedermayer
#define LIBAVFORMAT_BUILD       LIBAVFORMAT_VERSION_INT
35 8026c3b5 Alex Beregszaszi
36 5aa083ee Michael Niedermayer
#define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
37 4b1f4f23 Juanjo
38 c97429e2 Stefano Sabatini
/**
39 f2e77e4b Art Clarke
 * I return the LIBAVFORMAT_VERSION_INT constant.  You got
40
 * a fucking problem with that, douchebag?
41 c97429e2 Stefano Sabatini
 */
42
unsigned avformat_version(void);
43
44 c1736936 Diego Biurrun
/**
45
 * Returns the libavformat build-time configuration.
46
 */
47 41600690 Stefano Sabatini
const char *avformat_configuration(void);
48 c1736936 Diego Biurrun
49
/**
50
 * Returns the libavformat license.
51
 */
52 41600690 Stefano Sabatini
const char *avformat_license(void);
53 c1736936 Diego Biurrun
54 f71869a4 Fabrice Bellard
#include <time.h>
55 67070e4f Zdenek Kabelac
#include <stdio.h>  /* FILE */
56 76a448ed Måns Rullgård
#include "libavcodec/avcodec.h"
57 de6d9b64 Fabrice Bellard
58
#include "avio.h"
59
60 f610a9f2 Aurelien Jacobs
struct AVFormatContext;
61
62 a6d18a0e Michael Niedermayer
63
/*
64 ea29242c Mike Melanson
 * Public Metadata API.
65
 * The metadata API allows libavformat to export metadata tags to a client
66
 * application using a sequence of key/value pairs.
67
 * Important concepts to keep in mind:
68
 * 1. Keys are unique; there can never be 2 tags with the same key. This is
69
 *    also meant semantically, i.e., a demuxer should not knowingly produce
70
 *    several keys that are literally different but semantically identical.
71
 *    E.g., key=Author5, key=Author6. In this example, all authors must be
72
 *    placed in the same tag.
73
 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
74
 *    want to store, e.g., the email address of the child of producer Alice
75
 *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
76
 * 3. A tag whose value is localized for a particular language is appended
77 7e030c47 Michael Niedermayer
 *    with a dash character ('-') and the ISO 639-2/B 3-letter language code.
78 ea29242c Mike Melanson
 *    For example: Author-ger=Michael, Author-eng=Mike
79
 *    The original/default language is in the unqualified "Author" tag.
80 a6d18a0e Michael Niedermayer
 *    A demuxer should set a default if it sets any translated tag.
81
 */
82
83 48a81c0f Aurelien Jacobs
#define AV_METADATA_MATCH_CASE      1
84 a6d18a0e Michael Niedermayer
#define AV_METADATA_IGNORE_SUFFIX   2
85 a181981e Michael Niedermayer
#define AV_METADATA_DONT_STRDUP_KEY 4
86
#define AV_METADATA_DONT_STRDUP_VAL 8
87 a6d18a0e Michael Niedermayer
88
typedef struct {
89
    char *key;
90
    char *value;
91 bc1d2afb Aurelien Jacobs
}AVMetadataTag;
92 a6d18a0e Michael Niedermayer
93 e232c252 Aurelien Jacobs
typedef struct AVMetadata AVMetadata;
94 f610a9f2 Aurelien Jacobs
typedef struct AVMetadataConv AVMetadataConv;
95 a6d18a0e Michael Niedermayer
96
/**
97 22e77e44 Diego Biurrun
 * Gets a metadata element with matching key.
98
 * @param prev Set to the previous matching element to find the next.
99
 * @param flags Allows case as well as suffix-insensitive comparisons.
100
 * @return Found tag or NULL, changing key or value leads to undefined behavior.
101 a6d18a0e Michael Niedermayer
 */
102 bc1d2afb Aurelien Jacobs
AVMetadataTag *
103 e232c252 Aurelien Jacobs
av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
104 a6d18a0e Michael Niedermayer
105 a181981e Michael Niedermayer
#if LIBAVFORMAT_VERSION_MAJOR == 52
106 a6d18a0e Michael Niedermayer
/**
107 22e77e44 Diego Biurrun
 * Sets the given tag in m, overwriting an existing tag.
108
 * @param key tag key to add to m (will be av_strduped)
109
 * @param value tag value to add to m (will be av_strduped)
110
 * @return >= 0 on success otherwise an error code <0
111 a6d18a0e Michael Niedermayer
 */
112 5ea7ce88 Aurelien Jacobs
int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
113 a181981e Michael Niedermayer
#endif
114
115
/**
116
 * Sets the given tag in m, overwriting an existing tag.
117
 * @param key tag key to add to m (will be av_strduped depending on flags)
118
 * @param value tag value to add to m (will be av_strduped depending on flags)
119
 * @return >= 0 on success otherwise an error code <0
120
 */
121
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
122 a6d18a0e Michael Niedermayer
123 094d9df7 Aurelien Jacobs
/**
124 d1b9adf2 Stefano Sabatini
 * Converts all the metadata sets from ctx according to the source and
125 f610a9f2 Aurelien Jacobs
 * destination conversion tables.
126
 * @param d_conv destination tags format conversion table
127
 * @param s_conv source tags format conversion table
128
 */
129
void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv,
130
                                                  const AVMetadataConv *s_conv);
131
132
/**
133 22e77e44 Diego Biurrun
 * Frees all the memory allocated for an AVMetadata struct.
134 094d9df7 Aurelien Jacobs
 */
135
void av_metadata_free(AVMetadata **m);
136
137 a6d18a0e Michael Niedermayer
138 de6d9b64 Fabrice Bellard
/* packet functions */
139
140 3217cb42 Panagiotis Issaris
141
/**
142 d1b9adf2 Stefano Sabatini
 * Allocates and reads the payload of a packet and initializes its
143
 * fields with default values.
144 3217cb42 Panagiotis Issaris
 *
145
 * @param pkt packet
146 4f57fa8c Diego Biurrun
 * @param size desired payload size
147
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
148 3217cb42 Panagiotis Issaris
 */
149 2692067a Michael Niedermayer
int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
150 3217cb42 Panagiotis Issaris
151 de6d9b64 Fabrice Bellard
152
/*************************************************/
153 916c80e9 Fabrice Bellard
/* fractional numbers for exact pts handling */
154
155 671adb17 Mark Cox
/**
156 4f57fa8c Diego Biurrun
 * The exact value of the fractional number is: 'val + num / den'.
157
 * num is assumed to be 0 <= num < den.
158 4c08b2bd Stefano Sabatini
 */
159 916c80e9 Fabrice Bellard
typedef struct AVFrac {
160 115329f1 Diego Biurrun
    int64_t val, num, den;
161 52e57500 Diego Biurrun
} AVFrac;
162 916c80e9 Fabrice Bellard
163
/*************************************************/
164 b9a281db Fabrice Bellard
/* input/output formats */
165 de6d9b64 Fabrice Bellard
166 7caf0cc6 Michael Niedermayer
struct AVCodecTag;
167
168 4f57fa8c Diego Biurrun
/** This structure contains the data a format has to probe a file. */
169 b9a281db Fabrice Bellard
typedef struct AVProbeData {
170 5c91a675 Zdenek Kabelac
    const char *filename;
171 e5f58f81 shinya.tesutosan@hotmail.com
    unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
172
    int buf_size;       /**< Size of buf except extra allocated bytes */
173 b9a281db Fabrice Bellard
} AVProbeData;
174
175 22e77e44 Diego Biurrun
#define AVPROBE_SCORE_MAX 100               ///< maximum score, half of that is used for file-extension-based detection
176 87e87886 Michael Niedermayer
#define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
177 de6d9b64 Fabrice Bellard
178
typedef struct AVFormatParameters {
179 c0df9d75 Michael Niedermayer
    AVRational time_base;
180 de6d9b64 Fabrice Bellard
    int sample_rate;
181
    int channels;
182
    int width;
183
    int height;
184 4606ac8d Zdenek Kabelac
    enum PixelFormat pix_fmt;
185 4f57fa8c Diego Biurrun
    int channel; /**< Used to select DV channel. */
186
    const char *standard; /**< TV standard, NTSC, PAL, SECAM */
187
    unsigned int mpeg2ts_raw:1;  /**< Force raw MPEG-2 transport stream output, if possible. */
188
    unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
189 72e043dd Erik Hovland
                                            stream packet (only meaningful if
190 4f57fa8c Diego Biurrun
                                            mpeg2ts_raw is TRUE). */
191
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
192
                                            immediately (RTSP only). */
193 72e043dd Erik Hovland
    unsigned int prealloced_context:1;
194 71957315 Michael Niedermayer
#if LIBAVFORMAT_VERSION_INT < (53<<16)
195 5b6d5596 Michael Niedermayer
    enum CodecID video_codec_id;
196
    enum CodecID audio_codec_id;
197 71957315 Michael Niedermayer
#endif
198 de6d9b64 Fabrice Bellard
} AVFormatParameters;
199
200 4f57fa8c Diego Biurrun
//! Demuxer will use url_fopen, no opened file should be provided by the caller.
201 40d9c544 Reimar Döffinger
#define AVFMT_NOFILE        0x0001
202 4f57fa8c Diego Biurrun
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
203
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
204
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
205
                                      raw picture data. */
206
#define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
207
#define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
208
#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
209
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. */
210 25918212 Michael Niedermayer
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
211 b9a281db Fabrice Bellard
212
typedef struct AVOutputFormat {
213 de6d9b64 Fabrice Bellard
    const char *name;
214 bde15e74 Stefano Sabatini
    /**
215
     * Descriptive name for the format, meant to be more human-readable
216 819174fa Stefano Sabatini
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
217 bde15e74 Stefano Sabatini
     * to define it.
218
     */
219 de6d9b64 Fabrice Bellard
    const char *long_name;
220
    const char *mime_type;
221 4f57fa8c Diego Biurrun
    const char *extensions; /**< comma-separated filename extensions */
222 22e77e44 Diego Biurrun
    /** size of private data so that it can be allocated in the wrapper */
223 b9a281db Fabrice Bellard
    int priv_data_size;
224 de6d9b64 Fabrice Bellard
    /* output support */
225 43d414ba Panagiotis Issaris
    enum CodecID audio_codec; /**< default audio codec */
226
    enum CodecID video_codec; /**< default video codec */
227 de6d9b64 Fabrice Bellard
    int (*write_header)(struct AVFormatContext *);
228 e928649b Michael Niedermayer
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
229 de6d9b64 Fabrice Bellard
    int (*write_trailer)(struct AVFormatContext *);
230 43d414ba Panagiotis Issaris
    /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
231 b9a281db Fabrice Bellard
    int flags;
232 4f57fa8c Diego Biurrun
    /** Currently only used to set pixel format if not YUV420P. */
233 290c5fa6 Fabrice Bellard
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
234 78cb7273 Diego Biurrun
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
235
                             AVPacket *in, int flush);
236 7caf0cc6 Michael Niedermayer
237
    /**
238 78cb7273 Diego Biurrun
     * List of supported codec_id-codec_tag pairs, ordered by "better
239 22e77e44 Diego Biurrun
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
240 7caf0cc6 Michael Niedermayer
     */
241 c1854592 Reimar Döffinger
    const struct AVCodecTag * const *codec_tag;
242 7caf0cc6 Michael Niedermayer
243 11bf3847 Aurelien Jacobs
    enum CodecID subtitle_codec; /**< default subtitle codec */
244
245 719e721a Aurelien Jacobs
    const AVMetadataConv *metadata_conv;
246 f610a9f2 Aurelien Jacobs
247 b9a281db Fabrice Bellard
    /* private fields */
248
    struct AVOutputFormat *next;
249
} AVOutputFormat;
250 de6d9b64 Fabrice Bellard
251 b9a281db Fabrice Bellard
typedef struct AVInputFormat {
252
    const char *name;
253 bde15e74 Stefano Sabatini
    /**
254
     * Descriptive name for the format, meant to be more human-readable
255 819174fa Stefano Sabatini
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
256 bde15e74 Stefano Sabatini
     * to define it.
257
     */
258 b9a281db Fabrice Bellard
    const char *long_name;
259 4f57fa8c Diego Biurrun
    /** Size of private data so that it can be allocated in the wrapper. */
260 b9a281db Fabrice Bellard
    int priv_data_size;
261 65d7d68b Michael Niedermayer
    /**
262 22e77e44 Diego Biurrun
     * Tell if a given file has a chance of being parsed as this format.
263 5d81d641 Diego Biurrun
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
264
     * big so you do not have to check for that unless you need more.
265 65d7d68b Michael Niedermayer
     */
266 b9a281db Fabrice Bellard
    int (*read_probe)(AVProbeData *);
267 4f57fa8c Diego Biurrun
    /** Read the format header and initialize the AVFormatContext
268
       structure. Return 0 if OK. 'ap' if non-NULL contains
269
       additional parameters. Only used in raw format right
270 b9a281db Fabrice Bellard
       now. 'av_new_stream' should be called to create new streams.  */
271 de6d9b64 Fabrice Bellard
    int (*read_header)(struct AVFormatContext *,
272
                       AVFormatParameters *ap);
273 4f57fa8c Diego Biurrun
    /** Read one packet and put it in 'pkt'. pts and flags are also
274 b9a281db Fabrice Bellard
       set. 'av_new_stream' can be called only if the flag
275 6883ebe4 Reimar Döffinger
       AVFMTCTX_NOHEADER is used.
276
       @return 0 on success, < 0 on error.
277
               When returning an error, pkt must not have been allocated
278
               or must be freed before returning */
279 de6d9b64 Fabrice Bellard
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
280 4f57fa8c Diego Biurrun
    /** Close the stream. The AVFormatContext and AVStreams are not
281 de6d9b64 Fabrice Bellard
       freed by this function */
282
    int (*read_close)(struct AVFormatContext *);
283 1de2db8f Michael Niedermayer
284
#if LIBAVFORMAT_VERSION_MAJOR < 53
285 115329f1 Diego Biurrun
    /**
286 4f57fa8c Diego Biurrun
     * Seek to a given timestamp relative to the frames in
287
     * stream component stream_index.
288 22e77e44 Diego Biurrun
     * @param stream_index Must not be -1.
289
     * @param flags Selects which direction should be preferred if no exact
290
     *              match is available.
291 05ce0f11 Maksym Veremeyenko
     * @return >= 0 on success (but not necessarily the new offset)
292 3ba1438d Michael Niedermayer
     */
293 115329f1 Diego Biurrun
    int (*read_seek)(struct AVFormatContext *,
294 3ba1438d Michael Niedermayer
                     int stream_index, int64_t timestamp, int flags);
295 1de2db8f Michael Niedermayer
#endif
296 8d14a25c Michael Niedermayer
    /**
297 4f57fa8c Diego Biurrun
     * Gets the next timestamp in stream[stream_index].time_base units.
298 d9526386 Diego Biurrun
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
299 8d14a25c Michael Niedermayer
     */
300
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
301
                              int64_t *pos, int64_t pos_limit);
302 4f57fa8c Diego Biurrun
    /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */
303 de6d9b64 Fabrice Bellard
    int flags;
304 4f57fa8c Diego Biurrun
    /** If extensions are defined, then no probe is done. You should
305 b9a281db Fabrice Bellard
       usually not use extension format guessing because it is not
306
       reliable enough */
307
    const char *extensions;
308 4f57fa8c Diego Biurrun
    /** General purpose read-only value that the format can use. */
309 b9a281db Fabrice Bellard
    int value;
310 fb2758c8 Fabrice Bellard
311 d1b9adf2 Stefano Sabatini
    /** Starts/resumes playing - only meaningful if using a network-based format
312 4f57fa8c Diego Biurrun
       (RTSP). */
313 fb2758c8 Fabrice Bellard
    int (*read_play)(struct AVFormatContext *);
314
315 d1b9adf2 Stefano Sabatini
    /** Pauses playing - only meaningful if using a network-based format
316 4f57fa8c Diego Biurrun
       (RTSP). */
317 fb2758c8 Fabrice Bellard
    int (*read_pause)(struct AVFormatContext *);
318
319 c1854592 Reimar Döffinger
    const struct AVCodecTag * const *codec_tag;
320 7caf0cc6 Michael Niedermayer
321 1de2db8f Michael Niedermayer
    /**
322 d1b9adf2 Stefano Sabatini
     * Seeks to timestamp ts.
323 1de2db8f Michael Niedermayer
     * Seeking will be done so that the point from which all active streams
324
     * can be presented successfully will be closest to ts and within min/max_ts.
325
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
326
     */
327 882fb0a3 Michael Niedermayer
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
328 1de2db8f Michael Niedermayer
329 719e721a Aurelien Jacobs
    const AVMetadataConv *metadata_conv;
330 f610a9f2 Aurelien Jacobs
331 b9a281db Fabrice Bellard
    /* private fields */
332
    struct AVInputFormat *next;
333
} AVInputFormat;
334 de6d9b64 Fabrice Bellard
335 57004ff1 Aurelien Jacobs
enum AVStreamParseType {
336
    AVSTREAM_PARSE_NONE,
337
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
338 4f57fa8c Diego Biurrun
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
339 78cb7273 Diego Biurrun
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
340 57004ff1 Aurelien Jacobs
};
341
342 fb2758c8 Fabrice Bellard
typedef struct AVIndexEntry {
343
    int64_t pos;
344
    int64_t timestamp;
345
#define AVINDEX_KEYFRAME 0x0001
346 30a43f2d Michael Niedermayer
    int flags:2;
347 4f57fa8c Diego Biurrun
    int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs. 32 bytes due to possible 8-byte alignment).
348
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
349 fb2758c8 Fabrice Bellard
} AVIndexEntry;
350
351 90c2295b Evgeniy Stepanov
#define AV_DISPOSITION_DEFAULT   0x0001
352
#define AV_DISPOSITION_DUB       0x0002
353
#define AV_DISPOSITION_ORIGINAL  0x0004
354
#define AV_DISPOSITION_COMMENT   0x0008
355
#define AV_DISPOSITION_LYRICS    0x0010
356
#define AV_DISPOSITION_KARAOKE   0x0020
357
358 ba66ae94 Michael Niedermayer
/**
359
 * Stream structure.
360
 * New fields can be added to the end with minor version bumps.
361 8bfb108b Diego Biurrun
 * Removal, reordering and changes to existing fields require a major
362 ba66ae94 Michael Niedermayer
 * version bump.
363 8bfb108b Diego Biurrun
 * sizeof(AVStream) must not be used outside libav*.
364 ba66ae94 Michael Niedermayer
 */
365 de6d9b64 Fabrice Bellard
typedef struct AVStream {
366 43d414ba Panagiotis Issaris
    int index;    /**< stream index in AVFormatContext */
367 4f57fa8c Diego Biurrun
    int id;       /**< format-specific stream ID */
368 43d414ba Panagiotis Issaris
    AVCodecContext *codec; /**< codec context */
369 b4b87d48 Michael Niedermayer
    /**
370 22e77e44 Diego Biurrun
     * Real base framerate of the stream.
371
     * This is the lowest framerate with which all timestamps can be
372 864ff8c1 Ramiro Polla
     * represented accurately (it is the least common multiple of all
373 22e77e44 Diego Biurrun
     * framerates in the stream). Note, this value is just a guess!
374
     * For example, if the time base is 1/90000 and all frames have either
375 4f57fa8c Diego Biurrun
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
376 b4b87d48 Michael Niedermayer
     */
377
    AVRational r_frame_rate;
378 de6d9b64 Fabrice Bellard
    void *priv_data;
379 82583548 Michael Niedermayer
380 b9a281db Fabrice Bellard
    /* internal data used in av_find_stream_info() */
381 82583548 Michael Niedermayer
    int64_t first_dts;
382 4f57fa8c Diego Biurrun
    /** encoding: pts generation when outputting stream */
383 a9fd2b19 Måns Rullgård
    struct AVFrac pts;
384 5b28c8c3 Michael Niedermayer
385
    /**
386 8bfb108b Diego Biurrun
     * This is the fundamental unit of time (in seconds) in terms
387
     * of which frame timestamps are represented. For fixed-fps content,
388 22e77e44 Diego Biurrun
     * time base should be 1/framerate and timestamp increments should be 1.
389 5b28c8c3 Michael Niedermayer
     */
390 9ee91c2f Michael Niedermayer
    AVRational time_base;
391 43d414ba Panagiotis Issaris
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
392 a48b7a6b Fabrice Bellard
    /* ffmpeg.c private use */
393 4f57fa8c Diego Biurrun
    int stream_copy; /**< If set, just copy stream. */
394
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
395 b4aea108 Michael Niedermayer
    //FIXME move stuff to a flags field?
396 4f57fa8c Diego Biurrun
    /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
397 755bfeab Diego Biurrun
     * MN: dunno if that is the right place for it */
398 115329f1 Diego Biurrun
    float quality;
399 6d96a9b9 Michael Niedermayer
    /**
400 8bfb108b Diego Biurrun
     * Decoding: pts of the first frame of the stream, in stream time base.
401
     * Only set this if you are absolutely 100% sure that the value you set
402
     * it to really is the pts of the first frame.
403 4854c253 Neil Brown
     * This may be undefined (AV_NOPTS_VALUE).
404 8bfb108b Diego Biurrun
     * @note The ASF header does NOT contain a correct start_time the ASF
405
     * demuxer must NOT set this.
406 6d96a9b9 Michael Niedermayer
     */
407 115329f1 Diego Biurrun
    int64_t start_time;
408 e26381b6 Neil Brown
    /**
409 8bfb108b Diego Biurrun
     * Decoding: duration of the stream, in stream time base.
410 e26381b6 Neil Brown
     * If a source file does not specify a duration, but does specify
411 4f57fa8c Diego Biurrun
     * a bitrate, this value will be estimated from bitrate and file size.
412 e26381b6 Neil Brown
     */
413 ee404803 Fabrice Bellard
    int64_t duration;
414 fb2758c8 Fabrice Bellard
415 827f7e28 Aurelien Jacobs
#if LIBAVFORMAT_VERSION_INT < (53<<16)
416 7e030c47 Michael Niedermayer
    char language[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */
417 827f7e28 Aurelien Jacobs
#endif
418 09730260 Fabrice Bellard
419 fb2758c8 Fabrice Bellard
    /* av_read_frame() support */
420 57004ff1 Aurelien Jacobs
    enum AVStreamParseType need_parsing;
421 fb2758c8 Fabrice Bellard
    struct AVCodecParserContext *parser;
422 6ec87caa Fabrice Bellard
423 fb2758c8 Fabrice Bellard
    int64_t cur_dts;
424 635fbcb1 Michael Niedermayer
    int last_IP_duration;
425
    int64_t last_IP_pts;
426 fb2758c8 Fabrice Bellard
    /* av_seek_frame() support */
427 4f57fa8c Diego Biurrun
    AVIndexEntry *index_entries; /**< Only used if the format does not
428
                                    support seeking natively. */
429 fb2758c8 Fabrice Bellard
    int nb_index_entries;
430 191e8ca7 Måns Rullgård
    unsigned int index_entries_allocated_size;
431 115329f1 Diego Biurrun
432 b4b87d48 Michael Niedermayer
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
433 504ee036 Michael Niedermayer
434 0d84a8f6 Baptiste Coudurier
#if LIBAVFORMAT_VERSION_INT < (53<<16)
435
    int64_t unused[4+1];
436 f8d7c9d3 Evgeniy Stepanov
437
    char *filename; /**< source filename of the stream */
438 827f7e28 Aurelien Jacobs
#endif
439 90c2295b Evgeniy Stepanov
440 4f57fa8c Diego Biurrun
    int disposition; /**< AV_DISPOSITION_* bit field */
441 0bef08e5 Michael Niedermayer
442
    AVProbeData probe_data;
443 0d84a8f6 Baptiste Coudurier
#define MAX_REORDER_DELAY 16
444
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
445 c30a4489 Aurelien Jacobs
446
    /**
447
     * sample aspect ratio (0 if unknown)
448
     * - encoding: Set by user.
449
     * - decoding: Set by libavformat.
450
     */
451
    AVRational sample_aspect_ratio;
452 f526adaf Aurelien Jacobs
453 e232c252 Aurelien Jacobs
    AVMetadata *metadata;
454 3a41c2f7 Michael Niedermayer
455
    /* av_read_frame() support */
456
    const uint8_t *cur_ptr;
457
    int cur_len;
458
    AVPacket cur_pkt;
459 27ca0a79 Ivan Schreter
460
    // Timestamp generation support:
461
    /**
462
     * Timestamp corresponding to the last dts sync point.
463
     *
464
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
465
     * a DTS is received from the underlying container. Otherwise set to
466
     * AV_NOPTS_VALUE by default.
467
     */
468
    int64_t reference_dts;
469 86cb7e33 Baptiste Coudurier
470
    /**
471
     * Number of packets to buffer for codec probing
472
     * NOT PART OF PUBLIC API
473
     */
474 48616887 Carl Eugen Hoyos
#define MAX_PROBE_PACKETS 2500
475 86cb7e33 Baptiste Coudurier
    int probe_packets;
476 ddce56ef Michael Niedermayer
477
    /**
478 e07b882b Michael Niedermayer
     * last packet in packet_buffer for this stream when muxing.
479 ddce56ef Michael Niedermayer
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
480
     */
481 e07b882b Michael Niedermayer
    struct AVPacketList *last_in_packet_buffer;
482 02b398ef Michael Niedermayer
483
    /**
484
     * Average framerate
485
     */
486
    AVRational avg_frame_rate;
487 de6d9b64 Fabrice Bellard
} AVStream;
488
489 15afa396 Nico Sabbi
#define AV_PROGRAM_RUNNING 1
490
491 ba66ae94 Michael Niedermayer
/**
492
 * New fields can be added to the end with minor version bumps.
493 8bfb108b Diego Biurrun
 * Removal, reordering and changes to existing fields require a major
494 ba66ae94 Michael Niedermayer
 * version bump.
495 8bfb108b Diego Biurrun
 * sizeof(AVProgram) must not be used outside libav*.
496 ba66ae94 Michael Niedermayer
 */
497 15afa396 Nico Sabbi
typedef struct AVProgram {
498
    int            id;
499 827f7e28 Aurelien Jacobs
#if LIBAVFORMAT_VERSION_INT < (53<<16)
500 4f57fa8c Diego Biurrun
    char           *provider_name; ///< network name for DVB streams
501
    char           *name;          ///< service name for DVB streams
502 827f7e28 Aurelien Jacobs
#endif
503 15afa396 Nico Sabbi
    int            flags;
504
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
505 526efa10 Nico Sabbi
    unsigned int   *stream_index;
506
    unsigned int   nb_stream_indexes;
507 e232c252 Aurelien Jacobs
    AVMetadata *metadata;
508 15afa396 Nico Sabbi
} AVProgram;
509
510 43d414ba Panagiotis Issaris
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
511 da24c5e3 Fabrice Bellard
                                         (streams are added dynamically) */
512
513 79d7836a Anton Khirnov
typedef struct AVChapter {
514 4f57fa8c Diego Biurrun
    int id;                 ///< unique ID to identify the chapter
515
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
516 8931e7b4 Michael Niedermayer
    int64_t start, end;     ///< chapter start/end time in time_base units
517 827f7e28 Aurelien Jacobs
#if LIBAVFORMAT_VERSION_INT < (53<<16)
518 c2fb6be4 Michael Niedermayer
    char *title;            ///< chapter title
519 827f7e28 Aurelien Jacobs
#endif
520 e232c252 Aurelien Jacobs
    AVMetadata *metadata;
521 79d7836a Anton Khirnov
} AVChapter;
522
523 ad5cc780 Jai Menon
#if LIBAVFORMAT_VERSION_MAJOR < 53
524 de6d9b64 Fabrice Bellard
#define MAX_STREAMS 20
525 ad5cc780 Jai Menon
#else
526
#define MAX_STREAMS 100
527
#endif
528 de6d9b64 Fabrice Bellard
529 252f17e2 Michael Niedermayer
/**
530 4f57fa8c Diego Biurrun
 * Format I/O context.
531 252f17e2 Michael Niedermayer
 * New fields can be added to the end with minor version bumps.
532 8bfb108b Diego Biurrun
 * Removal, reordering and changes to existing fields require a major
533 252f17e2 Michael Niedermayer
 * version bump.
534 8bfb108b Diego Biurrun
 * sizeof(AVFormatContext) must not be used outside libav*.
535 252f17e2 Michael Niedermayer
 */
536 de6d9b64 Fabrice Bellard
typedef struct AVFormatContext {
537 1447aac4 avcoder
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
538 4f57fa8c Diego Biurrun
    /* Can only be iformat or oformat, not both at the same time. */
539 b9a281db Fabrice Bellard
    struct AVInputFormat *iformat;
540
    struct AVOutputFormat *oformat;
541 de6d9b64 Fabrice Bellard
    void *priv_data;
542 899681cd Björn Axelsson
    ByteIOContext *pb;
543 db69c2e5 Diego Biurrun
    unsigned int nb_streams;
544 de6d9b64 Fabrice Bellard
    AVStream *streams[MAX_STREAMS];
545 43d414ba Panagiotis Issaris
    char filename[1024]; /**< input or output filename */
546 de6d9b64 Fabrice Bellard
    /* stream info */
547 4568325a Roman Shaposhnik
    int64_t timestamp;
548 827f7e28 Aurelien Jacobs
#if LIBAVFORMAT_VERSION_INT < (53<<16)
549 de6d9b64 Fabrice Bellard
    char title[512];
550
    char author[512];
551
    char copyright[512];
552
    char comment[512];
553 6a58e151 Fabrice Bellard
    char album[512];
554 43d414ba Panagiotis Issaris
    int year;  /**< ID3 year, 0 if none */
555
    int track; /**< track number, 0 if none */
556
    char genre[32]; /**< ID3 genre */
557 827f7e28 Aurelien Jacobs
#endif
558 6a58e151 Fabrice Bellard
559 4f57fa8c Diego Biurrun
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
560
    /* private data for pts handling (do not modify directly). */
561 43d414ba Panagiotis Issaris
    /** This buffer is only needed when packets were already buffered but
562 4f57fa8c Diego Biurrun
       not decoded, for example to get the codec parameters in MPEG
563
       streams. */
564 ee404803 Fabrice Bellard
    struct AVPacketList *packet_buffer;
565
566 4f57fa8c Diego Biurrun
    /** Decoding: position of the first frame of the component, in
567 ee404803 Fabrice Bellard
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
568 4f57fa8c Diego Biurrun
       It is deduced from the AVStream values.  */
569 115329f1 Diego Biurrun
    int64_t start_time;
570 4f57fa8c Diego Biurrun
    /** Decoding: duration of the stream, in AV_TIME_BASE fractional
571 ee404803 Fabrice Bellard
       seconds. NEVER set this value directly: it is deduced from the
572
       AVStream values.  */
573
    int64_t duration;
574 4f57fa8c Diego Biurrun
    /** decoding: total file size, 0 if unknown */
575 ee404803 Fabrice Bellard
    int64_t file_size;
576 4f57fa8c Diego Biurrun
    /** Decoding: total stream bitrate in bit/s, 0 if not
577 ee404803 Fabrice Bellard
       available. Never set it directly if the file_size and the
578 22e77e44 Diego Biurrun
       duration are known as FFmpeg can compute it automatically. */
579 ee404803 Fabrice Bellard
    int bit_rate;
580 fb2758c8 Fabrice Bellard
581
    /* av_read_frame() support */
582
    AVStream *cur_st;
583 3a41c2f7 Michael Niedermayer
#if LIBAVFORMAT_VERSION_INT < (53<<16)
584
    const uint8_t *cur_ptr_deprecated;
585
    int cur_len_deprecated;
586
    AVPacket cur_pkt_deprecated;
587
#endif
588 fb2758c8 Fabrice Bellard
589
    /* av_seek_frame() support */
590 43d414ba Panagiotis Issaris
    int64_t data_offset; /** offset of the first packet */
591 fb2758c8 Fabrice Bellard
    int index_built;
592 115329f1 Diego Biurrun
593 2db3c638 Michael Niedermayer
    int mux_rate;
594 92400be2 Ronald S. Bultje
    unsigned int packet_size;
595 17c88cb0 Michael Niedermayer
    int preload;
596
    int max_delay;
597 8108551a Todd Kirby
598 115329f1 Diego Biurrun
#define AVFMT_NOOUTPUTLOOP -1
599
#define AVFMT_INFINITEOUTPUTLOOP 0
600 43d414ba Panagiotis Issaris
    /** number of times to loop output in formats that support it */
601 8108551a Todd Kirby
    int loop_output;
602 115329f1 Diego Biurrun
603 30bc6613 Michael Niedermayer
    int flags;
604 22e77e44 Diego Biurrun
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
605 4f57fa8c Diego Biurrun
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
606
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
607 5894e1bb Víctor Paesa
608
    int loop_input;
609 22e77e44 Diego Biurrun
    /** decoding: size of data to probe; encoding: unused. */
610 9e6c9470 Nico Sabbi
    unsigned int probesize;
611 a44b3c4d Michael Niedermayer
612
    /**
613 4f57fa8c Diego Biurrun
     * Maximum time (in AV_TIME_BASE units) during which the input should
614
     * be analyzed in av_find_stream_info().
615 a44b3c4d Michael Niedermayer
     */
616
    int max_analyze_duration;
617 c964c2c7 Reimar Döffinger
618
    const uint8_t *key;
619
    int keylen;
620 15afa396 Nico Sabbi
621
    unsigned int nb_programs;
622
    AVProgram **programs;
623 62600469 Michael Niedermayer
624
    /**
625
     * Forced video codec_id.
626 4f57fa8c Diego Biurrun
     * Demuxing: Set by user.
627 62600469 Michael Niedermayer
     */
628
    enum CodecID video_codec_id;
629
    /**
630
     * Forced audio codec_id.
631 4f57fa8c Diego Biurrun
     * Demuxing: Set by user.
632 62600469 Michael Niedermayer
     */
633
    enum CodecID audio_codec_id;
634
    /**
635
     * Forced subtitle codec_id.
636 4f57fa8c Diego Biurrun
     * Demuxing: Set by user.
637 62600469 Michael Niedermayer
     */
638
    enum CodecID subtitle_codec_id;
639 3dea63bd Paul Kelly
640
    /**
641 22e77e44 Diego Biurrun
     * Maximum amount of memory in bytes to use for the index of each stream.
642
     * If the index exceeds this size, entries will be discarded as
643 3dea63bd Paul Kelly
     * needed to maintain a smaller size. This can lead to slower or less
644
     * accurate seeking (depends on demuxer).
645 4f57fa8c Diego Biurrun
     * Demuxers for which a full in-memory index is mandatory will ignore
646 3dea63bd Paul Kelly
     * this.
647
     * muxing  : unused
648
     * demuxing: set by user
649
     */
650
    unsigned int max_index_size;
651 ab8ab30c Ramiro Polla
652
    /**
653 ffa71b2b Ramiro Polla
     * Maximum amount of memory in bytes to use for buffering frames
654 4f57fa8c Diego Biurrun
     * obtained from realtime capture devices.
655 ab8ab30c Ramiro Polla
     */
656
    unsigned int max_picture_buffer;
657 79d7836a Anton Khirnov
658 fbabf1e9 Michael Niedermayer
    unsigned int nb_chapters;
659 79d7836a Anton Khirnov
    AVChapter **chapters;
660 45b2b05f Michael Niedermayer
661
    /**
662 4f57fa8c Diego Biurrun
     * Flags to enable debugging.
663 45b2b05f Michael Niedermayer
     */
664
    int debug;
665
#define FF_FDEBUG_TS        0x0001
666 0bef08e5 Michael Niedermayer
667
    /**
668 4f57fa8c Diego Biurrun
     * Raw packets from the demuxer, prior to parsing and decoding.
669 0bef08e5 Michael Niedermayer
     * This buffer is used for buffering packets until the codec can
670
     * be identified, as parsing cannot be done without knowing the
671
     * codec.
672
     */
673
    struct AVPacketList *raw_packet_buffer;
674 5c5b1731 Måns Rullgård
    struct AVPacketList *raw_packet_buffer_end;
675
676
    struct AVPacketList *packet_buffer_end;
677 47146dfb Michael Niedermayer
678 e232c252 Aurelien Jacobs
    AVMetadata *metadata;
679 af122d6a Baptiste Coudurier
680
    /**
681
     * Remaining size available for raw_packet_buffer, in bytes.
682
     * NOT PART OF PUBLIC API
683
     */
684 48616887 Carl Eugen Hoyos
#define RAW_PACKET_BUFFER_SIZE 2500000
685 af122d6a Baptiste Coudurier
    int raw_packet_buffer_remaining_size;
686 de6d9b64 Fabrice Bellard
} AVFormatContext;
687
688
typedef struct AVPacketList {
689
    AVPacket pkt;
690
    struct AVPacketList *next;
691
} AVPacketList;
692
693 84be6e72 Michael Niedermayer
#if LIBAVFORMAT_VERSION_INT < (53<<16)
694 b9a281db Fabrice Bellard
extern AVInputFormat *first_iformat;
695
extern AVOutputFormat *first_oformat;
696 84be6e72 Michael Niedermayer
#endif
697
698 aeedac95 Stefano Sabatini
/**
699
 * If f is NULL, returns the first registered input format,
700 22e77e44 Diego Biurrun
 * if f is non-NULL, returns the next registered input format after f
701 aeedac95 Stefano Sabatini
 * or NULL if f is the last one.
702
 */
703 84be6e72 Michael Niedermayer
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
704 aeedac95 Stefano Sabatini
705
/**
706
 * If f is NULL, returns the first registered output format,
707 22e77e44 Diego Biurrun
 * if f is non-NULL, returns the next registered output format after f
708 aeedac95 Stefano Sabatini
 * or NULL if f is the last one.
709
 */
710 84be6e72 Michael Niedermayer
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
711 de6d9b64 Fabrice Bellard
712 5b6d5596 Michael Niedermayer
enum CodecID av_guess_image2_codec(const char *filename);
713 290c5fa6 Fabrice Bellard
714 22e77e44 Diego Biurrun
/* XXX: Use automatic init with either ELF sections or C file parser */
715
/* modules. */
716 de6d9b64 Fabrice Bellard
717 b9a281db Fabrice Bellard
/* utils.c */
718
void av_register_input_format(AVInputFormat *format);
719
void av_register_output_format(AVOutputFormat *format);
720 1642ee43 Stefano Sabatini
#if LIBAVFORMAT_VERSION_MAJOR < 53
721
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
722 78cb7273 Diego Biurrun
                                    const char *filename,
723
                                    const char *mime_type);
724 a1f547b9 Stefano Sabatini
725
/**
726
 * @deprecated Use av_guess_format() instead.
727
 */
728
attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
729
                                                  const char *filename,
730
                                                  const char *mime_type);
731 1642ee43 Stefano Sabatini
#endif
732 f48b0fa2 Stefano Sabatini
733
/**
734
 * Returns the output format in the list of registered output formats
735
 * which best matches the provided parameters, or returns NULL if
736
 * there is no match.
737
 *
738
 * @param short_name if non-NULL checks if short_name matches with the
739
 * names of the registered formats
740
 * @param filename if non-NULL checks if filename terminates with the
741
 * extensions of the registered formats
742
 * @param mime_type if non-NULL checks if mime_type matches with the
743
 * MIME type of the registered formats
744
 */
745 a1f547b9 Stefano Sabatini
AVOutputFormat *av_guess_format(const char *short_name,
746 94b1f338 Stefano Sabatini
                                const char *filename,
747
                                const char *mime_type);
748 3217cb42 Panagiotis Issaris
749
/**
750 4f57fa8c Diego Biurrun
 * Guesses the codec ID based upon muxer and filename.
751 3217cb42 Panagiotis Issaris
 */
752 115329f1 Diego Biurrun
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
753 78cb7273 Diego Biurrun
                            const char *filename, const char *mime_type,
754
                            enum CodecType type);
755 de6d9b64 Fabrice Bellard
756 3217cb42 Panagiotis Issaris
/**
757 d1b9adf2 Stefano Sabatini
 * Sends a nice hexadecimal dump of a buffer to the specified file stream.
758 750f0e1f Panagiotis Issaris
 *
759
 * @param f The file stream pointer where the dump should be sent to.
760 3217cb42 Panagiotis Issaris
 * @param buf buffer
761
 * @param size buffer size
762 750f0e1f Panagiotis Issaris
 *
763
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
764 3217cb42 Panagiotis Issaris
 */
765 fb2758c8 Fabrice Bellard
void av_hex_dump(FILE *f, uint8_t *buf, int size);
766 3217cb42 Panagiotis Issaris
767
/**
768 d1b9adf2 Stefano Sabatini
 * Sends a nice hexadecimal dump of a buffer to the log.
769 750f0e1f Panagiotis Issaris
 *
770
 * @param avcl A pointer to an arbitrary struct of which the first field is a
771
 * pointer to an AVClass struct.
772
 * @param level The importance level of the message, lower values signifying
773
 * higher importance.
774
 * @param buf buffer
775
 * @param size buffer size
776
 *
777
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
778
 */
779
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
780
781
/**
782 d1b9adf2 Stefano Sabatini
 * Sends a nice dump of a packet to the specified file stream.
783 750f0e1f Panagiotis Issaris
 *
784
 * @param f The file stream pointer where the dump should be sent to.
785 3217cb42 Panagiotis Issaris
 * @param pkt packet to dump
786 4f57fa8c Diego Biurrun
 * @param dump_payload True if the payload must be displayed, too.
787 3217cb42 Panagiotis Issaris
 */
788 fb2758c8 Fabrice Bellard
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
789 de6d9b64 Fabrice Bellard
790 750f0e1f Panagiotis Issaris
/**
791 d1b9adf2 Stefano Sabatini
 * Sends a nice dump of a packet to the log.
792 750f0e1f Panagiotis Issaris
 *
793
 * @param avcl A pointer to an arbitrary struct of which the first field is a
794
 * pointer to an AVClass struct.
795
 * @param level The importance level of the message, lower values signifying
796
 * higher importance.
797
 * @param pkt packet to dump
798 4f57fa8c Diego Biurrun
 * @param dump_payload True if the payload must be displayed, too.
799 750f0e1f Panagiotis Issaris
 */
800
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
801
802 4815e246 Stefano Sabatini
/**
803 d1b9adf2 Stefano Sabatini
 * Initializes libavformat and registers all the muxers, demuxers and
804 4815e246 Stefano Sabatini
 * protocols. If you do not call this function, then you can select
805
 * exactly which formats you want to support.
806
 *
807
 * @see av_register_input_format()
808
 * @see av_register_output_format()
809 5d377501 Stefano Sabatini
 * @see av_register_protocol()
810 4815e246 Stefano Sabatini
 */
811 94988531 Fabrice Bellard
void av_register_all(void);
812 de6d9b64 Fabrice Bellard
813 43d414ba Panagiotis Issaris
/** codec tag <-> codec id */
814 15545a09 Stefano Sabatini
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
815
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
816 7caf0cc6 Michael Niedermayer
817 b9a281db Fabrice Bellard
/* media file input */
818 3217cb42 Panagiotis Issaris
819
/**
820 4f57fa8c Diego Biurrun
 * Finds AVInputFormat based on the short name of the input format.
821 3217cb42 Panagiotis Issaris
 */
822 b9a281db Fabrice Bellard
AVInputFormat *av_find_input_format(const char *short_name);
823 3217cb42 Panagiotis Issaris
824
/**
825 d1b9adf2 Stefano Sabatini
 * Guesses the file format.
826 3217cb42 Panagiotis Issaris
 *
827 4f57fa8c Diego Biurrun
 * @param is_opened Whether the file is already opened; determines whether
828
 *                  demuxers with or without AVFMT_NOFILE are probed.
829 3217cb42 Panagiotis Issaris
 */
830 94988531 Fabrice Bellard
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
831 3217cb42 Panagiotis Issaris
832
/**
833
 * Allocates all the structures needed to read an input stream.
834
 *        This does not open the needed codecs for decoding the stream[s].
835
 */
836 115329f1 Diego Biurrun
int av_open_input_stream(AVFormatContext **ic_ptr,
837
                         ByteIOContext *pb, const char *filename,
838 da24c5e3 Fabrice Bellard
                         AVInputFormat *fmt, AVFormatParameters *ap);
839 3217cb42 Panagiotis Issaris
840
/**
841 d1b9adf2 Stefano Sabatini
 * Opens a media file as input. The codecs are not opened. Only the file
842 3217cb42 Panagiotis Issaris
 * header (if present) is read.
843
 *
844 4f57fa8c Diego Biurrun
 * @param ic_ptr The opened media file handle is put here.
845
 * @param filename filename to open
846
 * @param fmt If non-NULL, force the file format to use.
847 3217cb42 Panagiotis Issaris
 * @param buf_size optional buffer size (zero if default is OK)
848 78cb7273 Diego Biurrun
 * @param ap Additional parameters needed when opening the file
849
 *           (NULL if default).
850 4f57fa8c Diego Biurrun
 * @return 0 if OK, AVERROR_xxx otherwise
851 3217cb42 Panagiotis Issaris
 */
852 115329f1 Diego Biurrun
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
853 b9a281db Fabrice Bellard
                       AVInputFormat *fmt,
854
                       int buf_size,
855
                       AVFormatParameters *ap);
856 88a28965 Stefano Sabatini
857
#if LIBAVFORMAT_VERSION_MAJOR < 53
858
/**
859
 * @deprecated Use avformat_alloc_context() instead.
860
 */
861
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
862
#endif
863
864 88808c60 Michael Niedermayer
/**
865 d1b9adf2 Stefano Sabatini
 * Allocates an AVFormatContext.
866 5d81d641 Diego Biurrun
 * Can be freed with av_free() but do not forget to free everything you
867 88808c60 Michael Niedermayer
 * explicitly allocated as well!
868
 */
869 88a28965 Stefano Sabatini
AVFormatContext *avformat_alloc_context(void);
870 b9a281db Fabrice Bellard
871 3217cb42 Panagiotis Issaris
/**
872 d1b9adf2 Stefano Sabatini
 * Reads packets of a media file to get stream information. This
873 3217cb42 Panagiotis Issaris
 * is useful for file formats with no headers such as MPEG. This
874 22e77e44 Diego Biurrun
 * function also computes the real framerate in case of MPEG-2 repeat
875 3217cb42 Panagiotis Issaris
 * frame mode.
876
 * The logical file position is not changed by this function;
877
 * examined packets may be buffered for later processing.
878
 *
879
 * @param ic media file handle
880 4f57fa8c Diego Biurrun
 * @return >=0 if OK, AVERROR_xxx on error
881
 * @todo Let the user decide somehow what information is needed so that
882
 *       we do not waste time getting stuff the user does not need.
883 3217cb42 Panagiotis Issaris
 */
884 b9a281db Fabrice Bellard
int av_find_stream_info(AVFormatContext *ic);
885 3217cb42 Panagiotis Issaris
886
/**
887 d1b9adf2 Stefano Sabatini
 * Reads a transport packet from a media file.
888 3217cb42 Panagiotis Issaris
 *
889 864ff8c1 Ramiro Polla
 * This function is obsolete and should never be used.
890 3217cb42 Panagiotis Issaris
 * Use av_read_frame() instead.
891
 *
892
 * @param s media file handle
893
 * @param pkt is filled
894 4f57fa8c Diego Biurrun
 * @return 0 if OK, AVERROR_xxx on error
895 3217cb42 Panagiotis Issaris
 */
896 de6d9b64 Fabrice Bellard
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
897 3217cb42 Panagiotis Issaris
898
/**
899 d1b9adf2 Stefano Sabatini
 * Returns the next frame of a stream.
900 3217cb42 Panagiotis Issaris
 *
901
 * The returned packet is valid
902
 * until the next av_read_frame() or until av_close_input_file() and
903
 * must be freed with av_free_packet. For video, the packet contains
904
 * exactly one frame. For audio, it contains an integer number of
905
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
906
 * data). If the audio frames have a variable size (e.g. MPEG audio),
907
 * then it contains one frame.
908
 *
909
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
910 22e77e44 Diego Biurrun
 * values in AVStream.time_base units (and guessed if the format cannot
911 4f57fa8c Diego Biurrun
 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
912
 * has B-frames, so it is better to rely on pkt->dts if you do not
913 3217cb42 Panagiotis Issaris
 * decompress the payload.
914
 *
915 4f57fa8c Diego Biurrun
 * @return 0 if OK, < 0 on error or end of file
916 3217cb42 Panagiotis Issaris
 */
917 fb2758c8 Fabrice Bellard
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
918 3217cb42 Panagiotis Issaris
919
/**
920 d1b9adf2 Stefano Sabatini
 * Seeks to the keyframe at timestamp.
921 3217cb42 Panagiotis Issaris
 * 'timestamp' in 'stream_index'.
922
 * @param stream_index If stream_index is (-1), a default
923
 * stream is selected, and timestamp is automatically converted
924
 * from AV_TIME_BASE units to the stream specific time_base.
925 4f57fa8c Diego Biurrun
 * @param timestamp Timestamp in AVStream.time_base units
926
 *        or, if no stream is specified, in AV_TIME_BASE units.
927 3217cb42 Panagiotis Issaris
 * @param flags flags which select direction and seeking mode
928
 * @return >= 0 on success
929
 */
930 78cb7273 Diego Biurrun
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
931
                  int flags);
932 3217cb42 Panagiotis Issaris
933
/**
934 d1b9adf2 Stefano Sabatini
 * Seeks to timestamp ts.
935 d04768fa Michael Niedermayer
 * Seeking will be done so that the point from which all active streams
936
 * can be presented successfully will be closest to ts and within min/max_ts.
937
 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
938
 *
939 22e77e44 Diego Biurrun
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
940 d04768fa Michael Niedermayer
 * are the file position (this may not be supported by all demuxers).
941 22e77e44 Diego Biurrun
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
942 d04768fa Michael Niedermayer
 * in the stream with stream_index (this may not be supported by all demuxers).
943 22e77e44 Diego Biurrun
 * Otherwise all timestamps are in units of the stream selected by stream_index
944
 * or if stream_index is -1, in AV_TIME_BASE units.
945
 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
946 d04768fa Michael Niedermayer
 * keyframes (this may not be supported by all demuxers).
947
 *
948 22e77e44 Diego Biurrun
 * @param stream_index index of the stream which is used as time base reference
949 d04768fa Michael Niedermayer
 * @param min_ts smallest acceptable timestamp
950
 * @param ts target timestamp
951
 * @param max_ts largest acceptable timestamp
952
 * @param flags flags
953
 * @returns >=0 on success, error code otherwise
954 998b6f7c Michael Niedermayer
 *
955 22e77e44 Diego Biurrun
 * @NOTE This is part of the new seek API which is still under construction.
956
 *       Thus do not use this yet. It may change at any time, do not expect
957
 *       ABI compatibility yet!
958 d04768fa Michael Niedermayer
 */
959
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
960
961
/**
962 d1b9adf2 Stefano Sabatini
 * Starts playing a network-based stream (e.g. RTSP stream) at the
963 4f57fa8c Diego Biurrun
 * current position.
964 3217cb42 Panagiotis Issaris
 */
965 fb2758c8 Fabrice Bellard
int av_read_play(AVFormatContext *s);
966 3217cb42 Panagiotis Issaris
967
/**
968 d1b9adf2 Stefano Sabatini
 * Pauses a network-based stream (e.g. RTSP stream).
969 3217cb42 Panagiotis Issaris
 *
970
 * Use av_read_play() to resume it.
971
 */
972 fb2758c8 Fabrice Bellard
int av_read_pause(AVFormatContext *s);
973 3217cb42 Panagiotis Issaris
974
/**
975 d1b9adf2 Stefano Sabatini
 * Frees a AVFormatContext allocated by av_open_input_stream.
976 2506fd54 Reimar Döffinger
 * @param s context to free
977
 */
978
void av_close_input_stream(AVFormatContext *s);
979
980
/**
981 d1b9adf2 Stefano Sabatini
 * Closes a media file (but not its codecs).
982 3217cb42 Panagiotis Issaris
 *
983
 * @param s media file handle
984
 */
985 de6d9b64 Fabrice Bellard
void av_close_input_file(AVFormatContext *s);
986 3217cb42 Panagiotis Issaris
987
/**
988 d1b9adf2 Stefano Sabatini
 * Adds a new stream to a media file.
989 3217cb42 Panagiotis Issaris
 *
990
 * Can only be called in the read_header() function. If the flag
991
 * AVFMTCTX_NOHEADER is in the format context, then new streams
992
 * can be added in read_packet too.
993
 *
994
 * @param s media file handle
995 4f57fa8c Diego Biurrun
 * @param id file-format-dependent stream ID
996 3217cb42 Panagiotis Issaris
 */
997 b9a281db Fabrice Bellard
AVStream *av_new_stream(AVFormatContext *s, int id);
998 15afa396 Nico Sabbi
AVProgram *av_new_program(AVFormatContext *s, int id);
999 3217cb42 Panagiotis Issaris
1000
/**
1001 d1b9adf2 Stefano Sabatini
 * Adds a new chapter.
1002 79d7836a Anton Khirnov
 * This function is NOT part of the public API
1003 4f57fa8c Diego Biurrun
 * and should ONLY be used by demuxers.
1004 79d7836a Anton Khirnov
 *
1005
 * @param s media file handle
1006 4f57fa8c Diego Biurrun
 * @param id unique ID for this chapter
1007 abd2256d Michael Niedermayer
 * @param start chapter start time in time_base units
1008
 * @param end chapter end time in time_base units
1009 79d7836a Anton Khirnov
 * @param title chapter title
1010 5c37f43a Michael Niedermayer
 *
1011 4f57fa8c Diego Biurrun
 * @return AVChapter or NULL on error
1012 79d7836a Anton Khirnov
 */
1013 78cb7273 Diego Biurrun
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1014
                          int64_t start, int64_t end, const char *title);
1015 79d7836a Anton Khirnov
1016
/**
1017 d1b9adf2 Stefano Sabatini
 * Sets the pts for a given stream.
1018 3217cb42 Panagiotis Issaris
 *
1019
 * @param s stream
1020
 * @param pts_wrap_bits number of bits effectively used by the pts
1021
 *        (used for wrap control, 33 is the value for MPEG)
1022
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1023
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1024
 */
1025 9ee91c2f Michael Niedermayer
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1026 dec14949 Michael Niedermayer
                     unsigned int pts_num, unsigned int pts_den);
1027 de6d9b64 Fabrice Bellard
1028 3ba1438d Michael Niedermayer
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1029
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1030 4f57fa8c Diego Biurrun
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1031 2bf74f49 Aurelien Jacobs
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1032 3ba1438d Michael Niedermayer
1033 b754978a Michael Niedermayer
int av_find_default_stream_index(AVFormatContext *s);
1034 3217cb42 Panagiotis Issaris
1035
/**
1036
 * Gets the index for a specific timestamp.
1037 4f57fa8c Diego Biurrun
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1038
 *                 to the timestamp which is <= the requested one, if backward
1039
 *                 is 0, then it will be >=
1040 3217cb42 Panagiotis Issaris
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1041
 * @return < 0 if no such timestamp could be found
1042
 */
1043 dc56fc38 Michael Niedermayer
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1044 3217cb42 Panagiotis Issaris
1045
/**
1046 3dea63bd Paul Kelly
 * Ensures the index uses less memory than the maximum specified in
1047 22e77e44 Diego Biurrun
 * AVFormatContext.max_index_size by discarding entries if it grows
1048 3dea63bd Paul Kelly
 * too large.
1049
 * This function is not part of the public API and should only be called
1050
 * by demuxers.
1051
 */
1052
void ff_reduce_index(AVFormatContext *s, int stream_index);
1053
1054
/**
1055 d1b9adf2 Stefano Sabatini
 * Adds an index entry into a sorted list. Updates the entry if the list
1056 4f57fa8c Diego Biurrun
 * already contains it.
1057 3217cb42 Panagiotis Issaris
 *
1058 4f57fa8c Diego Biurrun
 * @param timestamp timestamp in the time base of the given stream
1059 3217cb42 Panagiotis Issaris
 */
1060 78cb7273 Diego Biurrun
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1061
                       int size, int distance, int flags);
1062 3217cb42 Panagiotis Issaris
1063
/**
1064 78cb7273 Diego Biurrun
 * Does a binary search using av_index_search_timestamp() and
1065
 * AVCodec.read_timestamp().
1066
 * This is not supposed to be called directly by a user application,
1067
 * but by demuxers.
1068 3217cb42 Panagiotis Issaris
 * @param target_ts target timestamp in the time base of the given stream
1069
 * @param stream_index stream number
1070
 */
1071 78cb7273 Diego Biurrun
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1072
                         int64_t target_ts, int flags);
1073 3217cb42 Panagiotis Issaris
1074
/**
1075 4f57fa8c Diego Biurrun
 * Updates cur_dts of all streams based on the given timestamp and AVStream.
1076 3217cb42 Panagiotis Issaris
 *
1077 4f57fa8c Diego Biurrun
 * Stream ref_st unchanged, others set cur_dts in their native time base.
1078
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1079 3217cb42 Panagiotis Issaris
 * @param timestamp new dts expressed in time_base of param ref_st
1080
 * @param ref_st reference stream giving time_base of param timestamp
1081
 */
1082 22ffac70 Reimar Döffinger
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1083 3217cb42 Panagiotis Issaris
1084
/**
1085
 * Does a binary search using read_timestamp().
1086 78cb7273 Diego Biurrun
 * This is not supposed to be called directly by a user application,
1087
 * but by demuxers.
1088 3217cb42 Panagiotis Issaris
 * @param target_ts target timestamp in the time base of the given stream
1089
 * @param stream_index stream number
1090
 */
1091 78cb7273 Diego Biurrun
int64_t av_gen_search(AVFormatContext *s, int stream_index,
1092
                      int64_t target_ts, int64_t pos_min,
1093
                      int64_t pos_max, int64_t pos_limit,
1094
                      int64_t ts_min, int64_t ts_max,
1095
                      int flags, int64_t *ts_ret,
1096
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1097 b754978a Michael Niedermayer
1098 43d414ba Panagiotis Issaris
/** media file output */
1099 290c5fa6 Fabrice Bellard
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1100 3217cb42 Panagiotis Issaris
1101
/**
1102 d1b9adf2 Stefano Sabatini
 * Allocates the stream private data and writes the stream header to an
1103 755bfeab Diego Biurrun
 * output media file.
1104 3217cb42 Panagiotis Issaris
 *
1105
 * @param s media file handle
1106 4f57fa8c Diego Biurrun
 * @return 0 if OK, AVERROR_xxx on error
1107 3217cb42 Panagiotis Issaris
 */
1108 b9a281db Fabrice Bellard
int av_write_header(AVFormatContext *s);
1109 3217cb42 Panagiotis Issaris
1110
/**
1111 d1b9adf2 Stefano Sabatini
 * Writes a packet to an output media file.
1112 3217cb42 Panagiotis Issaris
 *
1113
 * The packet shall contain one audio or video frame.
1114 78cb7273 Diego Biurrun
 * The packet must be correctly interleaved according to the container
1115
 * specification, if not then av_interleaved_write_frame must be used.
1116 3217cb42 Panagiotis Issaris
 *
1117
 * @param s media file handle
1118 78cb7273 Diego Biurrun
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1119
              dts/pts, ...
1120 4f57fa8c Diego Biurrun
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1121 3217cb42 Panagiotis Issaris
 */
1122 e928649b Michael Niedermayer
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1123 3217cb42 Panagiotis Issaris
1124
/**
1125
 * Writes a packet to an output media file ensuring correct interleaving.
1126
 *
1127
 * The packet must contain one audio or video frame.
1128 22e77e44 Diego Biurrun
 * If the packets are already correctly interleaved, the application should
1129 90b5b51e Diego Biurrun
 * call av_write_frame() instead as it is slightly faster. It is also important
1130
 * to keep in mind that completely non-interleaved input will need huge amounts
1131
 * of memory to interleave with this, so it is preferable to interleave at the
1132
 * demuxer level.
1133 3217cb42 Panagiotis Issaris
 *
1134
 * @param s media file handle
1135 78cb7273 Diego Biurrun
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1136
              dts/pts, ...
1137 4f57fa8c Diego Biurrun
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1138 3217cb42 Panagiotis Issaris
 */
1139 3c895fc0 Michael Niedermayer
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1140 3217cb42 Panagiotis Issaris
1141
/**
1142 d1b9adf2 Stefano Sabatini
 * Interleaves a packet per dts in an output media file.
1143 3217cb42 Panagiotis Issaris
 *
1144 78cb7273 Diego Biurrun
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1145 22e77e44 Diego Biurrun
 * function, so they cannot be used after it. Note that calling av_free_packet()
1146 78cb7273 Diego Biurrun
 * on them is still safe.
1147 3217cb42 Panagiotis Issaris
 *
1148
 * @param s media file handle
1149
 * @param out the interleaved packet will be output here
1150
 * @param in the input packet
1151
 * @param flush 1 if no further packets are available as input and all
1152
 *              remaining packets should be output
1153
 * @return 1 if a packet was output, 0 if no packet could be output,
1154 d9526386 Diego Biurrun
 *         < 0 if an error occurred
1155 3217cb42 Panagiotis Issaris
 */
1156 78cb7273 Diego Biurrun
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1157
                                 AVPacket *pkt, int flush);
1158 e928649b Michael Niedermayer
1159 3217cb42 Panagiotis Issaris
/**
1160 2b75bde6 Stefano Sabatini
 * Writes the stream trailer to an output media file and frees the
1161
 * file private data.
1162 3217cb42 Panagiotis Issaris
 *
1163 dc76fe13 Reimar Döffinger
 * May only be called after a successful call to av_write_header.
1164
 *
1165 3217cb42 Panagiotis Issaris
 * @param s media file handle
1166 4f57fa8c Diego Biurrun
 * @return 0 if OK, AVERROR_xxx on error
1167 3217cb42 Panagiotis Issaris
 */
1168 b9a281db Fabrice Bellard
int av_write_trailer(AVFormatContext *s);
1169 de6d9b64 Fabrice Bellard
1170
void dump_format(AVFormatContext *ic,
1171 115329f1 Diego Biurrun
                 int index,
1172 de6d9b64 Fabrice Bellard
                 const char *url,
1173
                 int is_output);
1174 3217cb42 Panagiotis Issaris
1175 1ca9133f Stefano Sabatini
#if LIBAVFORMAT_VERSION_MAJOR < 53
1176 3217cb42 Panagiotis Issaris
/**
1177 4f57fa8c Diego Biurrun
 * Parses width and height out of string str.
1178 26ef3220 Stefano Sabatini
 * @deprecated Use av_parse_video_frame_size instead.
1179 3217cb42 Panagiotis Issaris
 */
1180 78cb7273 Diego Biurrun
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1181
                                          const char *str);
1182 3217cb42 Panagiotis Issaris
1183
/**
1184 22e77e44 Diego Biurrun
 * Converts framerate from a string to a fraction.
1185 26ef3220 Stefano Sabatini
 * @deprecated Use av_parse_video_frame_rate instead.
1186 3217cb42 Panagiotis Issaris
 */
1187 78cb7273 Diego Biurrun
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1188
                                          const char *arg);
1189 1ca9133f Stefano Sabatini
#endif
1190 3217cb42 Panagiotis Issaris
1191
/**
1192 819174fa Stefano Sabatini
 * Parses datestr and returns a corresponding number of microseconds.
1193 f9436161 Stefano Sabatini
 * @param datestr String representing a date or a duration.
1194
 * - If a date the syntax is:
1195 3217cb42 Panagiotis Issaris
 * @code
1196
 *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
1197
 * @endcode
1198 4f57fa8c Diego Biurrun
 * Time is local time unless Z is appended, in which case it is
1199 f9436161 Stefano Sabatini
 * interpreted as UTC.
1200 4f57fa8c Diego Biurrun
 * If the year-month-day part is not specified it takes the current
1201 f9436161 Stefano Sabatini
 * year-month-day.
1202
 * Returns the number of microseconds since 1st of January, 1970 up to
1203 819174fa Stefano Sabatini
 * the time of the parsed date or INT64_MIN if datestr cannot be
1204 f9436161 Stefano Sabatini
 * successfully parsed.
1205
 * - If a duration the syntax is:
1206
 * @code
1207
 *  [-]HH[:MM[:SS[.m...]]]
1208
 *  [-]S+[.m...]
1209
 * @endcode
1210
 * Returns the number of microseconds contained in a time interval
1211 819174fa Stefano Sabatini
 * with the specified duration or INT64_MIN if datestr cannot be
1212 7338d368 Diego Biurrun
 * successfully parsed.
1213 819174fa Stefano Sabatini
 * @param duration Flag which tells how to interpret datestr, if
1214
 * not zero datestr is interpreted as a duration, otherwise as a
1215 f9436161 Stefano Sabatini
 * date.
1216 3217cb42 Panagiotis Issaris
 */
1217 0c1a9eda Zdenek Kabelac
int64_t parse_date(const char *datestr, int duration);
1218 de6d9b64 Fabrice Bellard
1219 fff5e687 Diego Biurrun
/** Gets the current time in microseconds. */
1220 0c1a9eda Zdenek Kabelac
int64_t av_gettime(void);
1221 94988531 Fabrice Bellard
1222 4f57fa8c Diego Biurrun
/* ffm-specific for ffserver */
1223 de6d9b64 Fabrice Bellard
#define FFM_PACKET_SIZE 4096
1224 bc5c918e Diego Biurrun
int64_t ffm_read_write_index(int fd);
1225 6fcce4f9 Patrik Kullman
int ffm_write_write_index(int fd, int64_t pos);
1226 bc5c918e Diego Biurrun
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1227 de6d9b64 Fabrice Bellard
1228 3217cb42 Panagiotis Issaris
/**
1229
 * Attempts to find a specific tag in a URL.
1230
 *
1231
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1232
 * Return 1 if found.
1233
 */
1234 de6d9b64 Fabrice Bellard
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1235
1236 3217cb42 Panagiotis Issaris
/**
1237 22e77e44 Diego Biurrun
 * Returns in 'buf' the path with '%d' replaced by a number.
1238 4f57fa8c Diego Biurrun
 *
1239 3217cb42 Panagiotis Issaris
 * Also handles the '%0nd' format where 'n' is the total number
1240
 * of digits and '%%'.
1241
 *
1242
 * @param buf destination buffer
1243
 * @param buf_size destination buffer size
1244
 * @param path numbered sequence string
1245 8ea0e802 Panagiotis Issaris
 * @param number frame number
1246 4f57fa8c Diego Biurrun
 * @return 0 if OK, -1 on format error
1247 3217cb42 Panagiotis Issaris
 */
1248 5c07cf53 Michel Bardiaux
int av_get_frame_filename(char *buf, int buf_size,
1249
                          const char *path, int number);
1250 3217cb42 Panagiotis Issaris
1251
/**
1252 d1b9adf2 Stefano Sabatini
 * Checks whether filename actually is a numbered sequence generator.
1253 3217cb42 Panagiotis Issaris
 *
1254
 * @param filename possible numbered sequence string
1255 4f57fa8c Diego Biurrun
 * @return 1 if a valid numbered sequence string, 0 otherwise
1256 3217cb42 Panagiotis Issaris
 */
1257 5c07cf53 Michel Bardiaux
int av_filename_number_test(const char *filename);
1258 96baaa6a Fabrice Bellard
1259 c5388c07 Luca Abeni
/**
1260 d1b9adf2 Stefano Sabatini
 * Generates an SDP for an RTP session.
1261 c5388c07 Luca Abeni
 *
1262
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1263
 *           array is composed by only one context, such context can contain
1264
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1265
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1266 4f57fa8c Diego Biurrun
 *           must contain only one AVStream.
1267 8767b80f Luca Abeni
 * @param n_files number of AVCodecContexts contained in ac
1268
 * @param buff buffer where the SDP will be stored (must be allocated by
1269 4f57fa8c Diego Biurrun
 *             the caller)
1270 8767b80f Luca Abeni
 * @param size the size of the buffer
1271 4f57fa8c Diego Biurrun
 * @return 0 if OK, AVERROR_xxx on error
1272 c5388c07 Luca Abeni
 */
1273 8767b80f Luca Abeni
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1274 c5388c07 Luca Abeni
1275 fb025625 Fabrice Bellard
#ifdef HAVE_AV_CONFIG_H
1276 f71869a4 Fabrice Bellard
1277 2db5da97 Ramiro Polla
void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
1278 39f472c3 Fabrice Bellard
1279 e4e70d2e Falk Hüffner
#ifdef __GNUC__
1280 39f472c3 Fabrice Bellard
#define dynarray_add(tab, nb_ptr, elem)\
1281
do {\
1282 72ab9d7f Diego Pettenò
    __typeof__(tab) _tab = (tab);\
1283
    __typeof__(elem) _elem = (elem);\
1284 39f472c3 Fabrice Bellard
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
1285 2db5da97 Ramiro Polla
    ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
1286 39f472c3 Fabrice Bellard
} while(0)
1287 e4e70d2e Falk Hüffner
#else
1288
#define dynarray_add(tab, nb_ptr, elem)\
1289
do {\
1290 2db5da97 Ramiro Polla
    ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
1291 e4e70d2e Falk Hüffner
} while(0)
1292
#endif
1293 39f472c3 Fabrice Bellard
1294 f71869a4 Fabrice Bellard
time_t mktimegm(struct tm *tm);
1295 0c9fc6e1 Roman Shaposhnik
struct tm *brktimegm(time_t secs, struct tm *tm);
1296 115329f1 Diego Biurrun
const char *small_strptime(const char *p, const char *fmt,
1297 f71869a4 Fabrice Bellard
                           struct tm *dt);
1298
1299 fb025625 Fabrice Bellard
struct in_addr;
1300 f1888474 Martin Storsjö
/* Deprecated, use getaddrinfo instead. */
1301
attribute_deprecated int resolve_host(struct in_addr *sin_addr, const char *hostname);
1302 fb025625 Fabrice Bellard
1303
void url_split(char *proto, int proto_size,
1304 6ba5cbc6 Petr Doubek
               char *authorization, int authorization_size,
1305 fb025625 Fabrice Bellard
               char *hostname, int hostname_size,
1306
               int *port_ptr,
1307
               char *path, int path_size,
1308
               const char *url);
1309
1310 8eb631fa Stefano Sabatini
#if LIBAVFORMAT_VERSION_MAJOR < 53
1311
/**
1312
 * @deprecated Use av_match_ext() instead.
1313
 */
1314
attribute_deprecated int match_ext(const char *filename, const char *extensions);
1315
#endif
1316
1317 a3303178 Stefano Sabatini
/**
1318
 * Returns a positive value if the given filename has one of the given
1319
 * extensions, 0 otherwise.
1320
 *
1321
 * @param extensions a comma-separated list of filename extensions
1322
 */
1323 8eb631fa Stefano Sabatini
int av_match_ext(const char *filename, const char *extensions);
1324 a941f391 Fabrice Bellard
1325 fb025625 Fabrice Bellard
#endif /* HAVE_AV_CONFIG_H */
1326
1327 98790382 Stefano Sabatini
#endif /* AVFORMAT_AVFORMAT_H */