Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ a1c4b65b

History | View | Annotate | Download (55.3 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 072e3efd Aurelien Jacobs
25 c97429e2 Stefano Sabatini
/**
26 f2e77e4b Art Clarke
 * I return the LIBAVFORMAT_VERSION_INT constant.  You got
27
 * a fucking problem with that, douchebag?
28 c97429e2 Stefano Sabatini
 */
29
unsigned avformat_version(void);
30
31 c1736936 Diego Biurrun
/**
32 49bd8e4b Måns Rullgård
 * Return the libavformat build-time configuration.
33 c1736936 Diego Biurrun
 */
34 41600690 Stefano Sabatini
const char *avformat_configuration(void);
35 c1736936 Diego Biurrun
36
/**
37 49bd8e4b Måns Rullgård
 * Return the libavformat license.
38 c1736936 Diego Biurrun
 */
39 41600690 Stefano Sabatini
const char *avformat_license(void);
40 c1736936 Diego Biurrun
41 f71869a4 Fabrice Bellard
#include <time.h>
42 67070e4f Zdenek Kabelac
#include <stdio.h>  /* FILE */
43 76a448ed Måns Rullgård
#include "libavcodec/avcodec.h"
44 de6d9b64 Fabrice Bellard
45
#include "avio.h"
46 d3058be6 Anton Khirnov
#include "libavformat/version.h"
47 de6d9b64 Fabrice Bellard
48 f610a9f2 Aurelien Jacobs
struct AVFormatContext;
49
50 a6d18a0e Michael Niedermayer
51
/*
52 ea29242c Mike Melanson
 * Public Metadata API.
53
 * The metadata API allows libavformat to export metadata tags to a client
54 61648423 Anton Khirnov
 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
55
 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
56
 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
57 ea29242c Mike Melanson
 * Important concepts to keep in mind:
58
 * 1. Keys are unique; there can never be 2 tags with the same key. This is
59
 *    also meant semantically, i.e., a demuxer should not knowingly produce
60
 *    several keys that are literally different but semantically identical.
61
 *    E.g., key=Author5, key=Author6. In this example, all authors must be
62
 *    placed in the same tag.
63
 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
64
 *    want to store, e.g., the email address of the child of producer Alice
65
 *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
66 ca76a119 Anton Khirnov
 * 3. Several modifiers can be applied to the tag name. This is done by
67
 *    appending a dash character ('-') and the modifier name in the order
68
 *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
69
 *    a) language -- a tag whose value is localized for a particular language
70
 *       is appended with the ISO 639-2/B 3-letter language code.
71
 *       For example: Author-ger=Michael, Author-eng=Mike
72
 *       The original/default language is in the unqualified "Author" tag.
73
 *       A demuxer should set a default if it sets any translated tag.
74
 *    b) sorting  -- a modified version of a tag that should be used for
75
 *       sorting will have '-sort' appended. E.g. artist="The Beatles",
76
 *       artist-sort="Beatles, The".
77
 *
78 03700d39 Anton Khirnov
 * 4. Demuxers attempt to export metadata in a generic format, however tags
79
 *    with no generic equivalents are left as they are stored in the container.
80
 *    Follows a list of generic tag names:
81 ca76a119 Anton Khirnov
 *
82
 * album        -- name of the set this work belongs to
83
 * album_artist -- main creator of the set/album, if different from artist.
84
 *                 e.g. "Various Artists" for compilation albums.
85
 * artist       -- main creator of the work
86
 * comment      -- any additional description of the file.
87
 * composer     -- who composed the work, if different from artist.
88
 * copyright    -- name of copyright holder.
89 29c5c590 Anton Khirnov
 * creation_time-- date when the file was created, preferably in ISO 8601.
90 ca76a119 Anton Khirnov
 * date         -- date when the work was created, preferably in ISO 8601.
91
 * disc         -- number of a subset, e.g. disc in a multi-disc collection.
92
 * encoder      -- name/settings of the software/hardware that produced the file.
93
 * encoded_by   -- person/group who created the file.
94
 * filename     -- original name of the file.
95
 * genre        -- <self-evident>.
96
 * language     -- main language in which the work is performed, preferably
97
 *                 in ISO 639-2 format.
98
 * performer    -- artist who performed the work, if different from artist.
99
 *                 E.g for "Also sprach Zarathustra", artist would be "Richard
100
 *                 Strauss" and performer "London Philharmonic Orchestra".
101
 * publisher    -- name of the label/publisher.
102 7916202b Georgi Chorbadzhiyski
 * service_name     -- name of the service in broadcasting (channel name).
103
 * service_provider -- name of the service provider in broadcasting.
104 ca76a119 Anton Khirnov
 * title        -- name of the work.
105
 * track        -- number of this work in the set, can be in form current/total.
106 a6d18a0e Michael Niedermayer
 */
107
108 48a81c0f Aurelien Jacobs
#define AV_METADATA_MATCH_CASE      1
109 a6d18a0e Michael Niedermayer
#define AV_METADATA_IGNORE_SUFFIX   2
110 a181981e Michael Niedermayer
#define AV_METADATA_DONT_STRDUP_KEY 4
111
#define AV_METADATA_DONT_STRDUP_VAL 8
112 56a8242f Ronald S. Bultje
#define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
113 a6d18a0e Michael Niedermayer
114
typedef struct {
115
    char *key;
116
    char *value;
117 bc1d2afb Aurelien Jacobs
}AVMetadataTag;
118 a6d18a0e Michael Niedermayer
119 e232c252 Aurelien Jacobs
typedef struct AVMetadata AVMetadata;
120 1f5e9ede Anton Khirnov
#if FF_API_OLD_METADATA2
121 f610a9f2 Aurelien Jacobs
typedef struct AVMetadataConv AVMetadataConv;
122 03700d39 Anton Khirnov
#endif
123 a6d18a0e Michael Niedermayer
124
/**
125 49bd8e4b Måns Rullgård
 * Get a metadata element with matching key.
126 26cc5310 Stefano Sabatini
 *
127 22e77e44 Diego Biurrun
 * @param prev Set to the previous matching element to find the next.
128 66b6c745 Stefano Sabatini
 *             If set to NULL the first matching element is returned.
129 22e77e44 Diego Biurrun
 * @param flags Allows case as well as suffix-insensitive comparisons.
130
 * @return Found tag or NULL, changing key or value leads to undefined behavior.
131 a6d18a0e Michael Niedermayer
 */
132 bc1d2afb Aurelien Jacobs
AVMetadataTag *
133 e232c252 Aurelien Jacobs
av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
134 a6d18a0e Michael Niedermayer
135 54036be1 Aurelien Jacobs
#if FF_API_OLD_METADATA
136 a6d18a0e Michael Niedermayer
/**
137 32e6f246 Stefano Sabatini
 * Set the given tag in *pm, overwriting an existing tag.
138 26cc5310 Stefano Sabatini
 *
139 983ec304 Stefano Sabatini
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
140
 * a metadata struct is allocated and put in *pm.
141 32e6f246 Stefano Sabatini
 * @param key tag key to add to *pm (will be av_strduped)
142
 * @param value tag value to add to *pm (will be av_strduped)
143 22e77e44 Diego Biurrun
 * @return >= 0 on success otherwise an error code <0
144 2ef6c124 Stefano Sabatini
 * @deprecated Use av_metadata_set2() instead.
145 a6d18a0e Michael Niedermayer
 */
146 2ef6c124 Stefano Sabatini
attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
147 a181981e Michael Niedermayer
#endif
148
149
/**
150 32e6f246 Stefano Sabatini
 * Set the given tag in *pm, overwriting an existing tag.
151 26cc5310 Stefano Sabatini
 *
152 983ec304 Stefano Sabatini
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
153
 * a metadata struct is allocated and put in *pm.
154 32e6f246 Stefano Sabatini
 * @param key tag key to add to *pm (will be av_strduped depending on flags)
155
 * @param value tag value to add to *pm (will be av_strduped depending on flags).
156 160c896c Anton Khirnov
 *        Passing a NULL value will cause an existing tag to be deleted.
157 a181981e Michael Niedermayer
 * @return >= 0 on success otherwise an error code <0
158
 */
159
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
160 a6d18a0e Michael Niedermayer
161 1f5e9ede Anton Khirnov
#if FF_API_OLD_METADATA2
162 094d9df7 Aurelien Jacobs
/**
163 03700d39 Anton Khirnov
 * This function is provided for compatibility reason and currently does nothing.
164 f610a9f2 Aurelien Jacobs
 */
165 03700d39 Anton Khirnov
attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
166
                                                                        const AVMetadataConv *s_conv);
167
#endif
168 f610a9f2 Aurelien Jacobs
169
/**
170 7f88a5bf Ronald S. Bultje
 * Copy metadata from one AVMetadata struct into another.
171
 * @param dst pointer to a pointer to a AVMetadata struct. If *dst is NULL,
172
 *            this function will allocate a struct for you and put it in *dst
173
 * @param src pointer to source AVMetadata struct
174
 * @param flags flags to use when setting metadata in *dst
175
 * @note metadata is read using the AV_METADATA_IGNORE_SUFFIX flag
176
 */
177
void av_metadata_copy(AVMetadata **dst, AVMetadata *src, int flags);
178
179
/**
180 49bd8e4b Måns Rullgård
 * Free all the memory allocated for an AVMetadata struct.
181 094d9df7 Aurelien Jacobs
 */
182
void av_metadata_free(AVMetadata **m);
183
184 a6d18a0e Michael Niedermayer
185 de6d9b64 Fabrice Bellard
/* packet functions */
186
187 3217cb42 Panagiotis Issaris
188
/**
189 49bd8e4b Måns Rullgård
 * Allocate and read the payload of a packet and initialize its
190 d1b9adf2 Stefano Sabatini
 * fields with default values.
191 3217cb42 Panagiotis Issaris
 *
192
 * @param pkt packet
193 4f57fa8c Diego Biurrun
 * @param size desired payload size
194
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
195 3217cb42 Panagiotis Issaris
 */
196 471fe57e Anton Khirnov
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
197 3217cb42 Panagiotis Issaris
198 de6d9b64 Fabrice Bellard
199 6bfc2683 Reimar Döffinger
/**
200 fa8cc126 Reimar Döffinger
 * Read data and append it to the current content of the AVPacket.
201
 * If pkt->size is 0 this is identical to av_get_packet.
202 6bfc2683 Reimar Döffinger
 * Note that this uses av_grow_packet and thus involves a realloc
203
 * which is inefficient. Thus this function should only be used
204
 * when there is no reasonable way to know (an upper bound of)
205
 * the final size.
206
 *
207
 * @param pkt packet
208
 * @param size amount of data to read
209
 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
210
 *         will not be lost even if an error occurs.
211
 */
212 471fe57e Anton Khirnov
int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
213 6bfc2683 Reimar Döffinger
214 de6d9b64 Fabrice Bellard
/*************************************************/
215 916c80e9 Fabrice Bellard
/* fractional numbers for exact pts handling */
216
217 671adb17 Mark Cox
/**
218 4f57fa8c Diego Biurrun
 * The exact value of the fractional number is: 'val + num / den'.
219
 * num is assumed to be 0 <= num < den.
220 4c08b2bd Stefano Sabatini
 */
221 916c80e9 Fabrice Bellard
typedef struct AVFrac {
222 115329f1 Diego Biurrun
    int64_t val, num, den;
223 52e57500 Diego Biurrun
} AVFrac;
224 916c80e9 Fabrice Bellard
225
/*************************************************/
226 b9a281db Fabrice Bellard
/* input/output formats */
227 de6d9b64 Fabrice Bellard
228 7caf0cc6 Michael Niedermayer
struct AVCodecTag;
229
230 76c56376 Michael Niedermayer
/**
231
 * This structure contains the data a format has to probe a file.
232
 */
233 b9a281db Fabrice Bellard
typedef struct AVProbeData {
234 5c91a675 Zdenek Kabelac
    const char *filename;
235 e5f58f81 shinya.tesutosan@hotmail.com
    unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
236
    int buf_size;       /**< Size of buf except extra allocated bytes */
237 b9a281db Fabrice Bellard
} AVProbeData;
238
239 22e77e44 Diego Biurrun
#define AVPROBE_SCORE_MAX 100               ///< maximum score, half of that is used for file-extension-based detection
240 87e87886 Michael Niedermayer
#define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
241 de6d9b64 Fabrice Bellard
242
typedef struct AVFormatParameters {
243 c0df9d75 Michael Niedermayer
    AVRational time_base;
244 de6d9b64 Fabrice Bellard
    int sample_rate;
245
    int channels;
246
    int width;
247
    int height;
248 4606ac8d Zdenek Kabelac
    enum PixelFormat pix_fmt;
249 4f57fa8c Diego Biurrun
    int channel; /**< Used to select DV channel. */
250
    const char *standard; /**< TV standard, NTSC, PAL, SECAM */
251
    unsigned int mpeg2ts_raw:1;  /**< Force raw MPEG-2 transport stream output, if possible. */
252
    unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
253 72e043dd Erik Hovland
                                            stream packet (only meaningful if
254 4f57fa8c Diego Biurrun
                                            mpeg2ts_raw is TRUE). */
255
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
256
                                            immediately (RTSP only). */
257 72e043dd Erik Hovland
    unsigned int prealloced_context:1;
258 0139fdea Aurelien Jacobs
#if FF_API_PARAMETERS_CODEC_ID
259 a15c7fd6 Anton Khirnov
    attribute_deprecated enum CodecID video_codec_id;
260
    attribute_deprecated enum CodecID audio_codec_id;
261 71957315 Michael Niedermayer
#endif
262 de6d9b64 Fabrice Bellard
} AVFormatParameters;
263
264 ebb92e07 Anton Khirnov
//! Demuxer will use avio_open, no opened file should be provided by the caller.
265 40d9c544 Reimar Döffinger
#define AVFMT_NOFILE        0x0001
266 4f57fa8c Diego Biurrun
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
267
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
268
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
269
                                      raw picture data. */
270
#define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
271
#define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
272
#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
273 58ec7e00 Michael Niedermayer
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
274 25918212 Michael Niedermayer
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
275 ab5a0175 Michael Niedermayer
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
276 bb62d5c1 Anton Khirnov
#define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
277 b9a281db Fabrice Bellard
278
typedef struct AVOutputFormat {
279 de6d9b64 Fabrice Bellard
    const char *name;
280 bde15e74 Stefano Sabatini
    /**
281
     * Descriptive name for the format, meant to be more human-readable
282 819174fa Stefano Sabatini
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
283 bde15e74 Stefano Sabatini
     * to define it.
284
     */
285 de6d9b64 Fabrice Bellard
    const char *long_name;
286
    const char *mime_type;
287 4f57fa8c Diego Biurrun
    const char *extensions; /**< comma-separated filename extensions */
288 76c56376 Michael Niedermayer
    /**
289
     * size of private data so that it can be allocated in the wrapper
290
     */
291 b9a281db Fabrice Bellard
    int priv_data_size;
292 de6d9b64 Fabrice Bellard
    /* output support */
293 43d414ba Panagiotis Issaris
    enum CodecID audio_codec; /**< default audio codec */
294
    enum CodecID video_codec; /**< default video codec */
295 de6d9b64 Fabrice Bellard
    int (*write_header)(struct AVFormatContext *);
296 e928649b Michael Niedermayer
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
297 de6d9b64 Fabrice Bellard
    int (*write_trailer)(struct AVFormatContext *);
298 76c56376 Michael Niedermayer
    /**
299 a1c4b65b Anssi Hannula
     * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
300
     * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
301
     * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
302 76c56376 Michael Niedermayer
     */
303 b9a281db Fabrice Bellard
    int flags;
304 76c56376 Michael Niedermayer
    /**
305
     * Currently only used to set pixel format if not YUV420P.
306
     */
307 290c5fa6 Fabrice Bellard
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
308 78cb7273 Diego Biurrun
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
309
                             AVPacket *in, int flush);
310 7caf0cc6 Michael Niedermayer
311
    /**
312 78cb7273 Diego Biurrun
     * List of supported codec_id-codec_tag pairs, ordered by "better
313 22e77e44 Diego Biurrun
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
314 7caf0cc6 Michael Niedermayer
     */
315 c1854592 Reimar Döffinger
    const struct AVCodecTag * const *codec_tag;
316 7caf0cc6 Michael Niedermayer
317 11bf3847 Aurelien Jacobs
    enum CodecID subtitle_codec; /**< default subtitle codec */
318
319 03700d39 Anton Khirnov
#if FF_API_OLD_METADATA
320 719e721a Aurelien Jacobs
    const AVMetadataConv *metadata_conv;
321 03700d39 Anton Khirnov
#endif
322 f610a9f2 Aurelien Jacobs
323 cf99e4aa Anssi Hannula
    const AVClass *priv_class; ///< AVClass for the private context
324
325 b9a281db Fabrice Bellard
    /* private fields */
326
    struct AVOutputFormat *next;
327
} AVOutputFormat;
328 de6d9b64 Fabrice Bellard
329 b9a281db Fabrice Bellard
typedef struct AVInputFormat {
330 76c56376 Michael Niedermayer
    /**
331
     * A comma separated list of short names for the format. New names
332 ac3ccbc0 Alex Converse
     * may be appended with a minor bump.
333
     */
334 b9a281db Fabrice Bellard
    const char *name;
335 76c56376 Michael Niedermayer
336 bde15e74 Stefano Sabatini
    /**
337
     * Descriptive name for the format, meant to be more human-readable
338 819174fa Stefano Sabatini
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
339 bde15e74 Stefano Sabatini
     * to define it.
340
     */
341 b9a281db Fabrice Bellard
    const char *long_name;
342 76c56376 Michael Niedermayer
343
    /**
344
     * Size of private data so that it can be allocated in the wrapper.
345
     */
346 b9a281db Fabrice Bellard
    int priv_data_size;
347 76c56376 Michael Niedermayer
348 65d7d68b Michael Niedermayer
    /**
349 22e77e44 Diego Biurrun
     * Tell if a given file has a chance of being parsed as this format.
350 5d81d641 Diego Biurrun
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
351
     * big so you do not have to check for that unless you need more.
352 65d7d68b Michael Niedermayer
     */
353 b9a281db Fabrice Bellard
    int (*read_probe)(AVProbeData *);
354 76c56376 Michael Niedermayer
355
    /**
356
     * Read the format header and initialize the AVFormatContext
357
     * structure. Return 0 if OK. 'ap' if non-NULL contains
358
     * additional parameters. Only used in raw format right
359
     * now. 'av_new_stream' should be called to create new streams.
360
     */
361 de6d9b64 Fabrice Bellard
    int (*read_header)(struct AVFormatContext *,
362
                       AVFormatParameters *ap);
363 76c56376 Michael Niedermayer
364
    /**
365
     * Read one packet and put it in 'pkt'. pts and flags are also
366
     * set. 'av_new_stream' can be called only if the flag
367 2899a28c Aurelien Jacobs
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
368
     * background thread).
369 76c56376 Michael Niedermayer
     * @return 0 on success, < 0 on error.
370
     *         When returning an error, pkt must not have been allocated
371
     *         or must be freed before returning
372
     */
373 de6d9b64 Fabrice Bellard
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
374 76c56376 Michael Niedermayer
375
    /**
376
     * Close the stream. The AVFormatContext and AVStreams are not
377
     * freed by this function
378
     */
379 de6d9b64 Fabrice Bellard
    int (*read_close)(struct AVFormatContext *);
380 1de2db8f Michael Niedermayer
381 634e0304 Aurelien Jacobs
#if FF_API_READ_SEEK
382 115329f1 Diego Biurrun
    /**
383 4f57fa8c Diego Biurrun
     * Seek to a given timestamp relative to the frames in
384
     * stream component stream_index.
385 22e77e44 Diego Biurrun
     * @param stream_index Must not be -1.
386
     * @param flags Selects which direction should be preferred if no exact
387
     *              match is available.
388 05ce0f11 Maksym Veremeyenko
     * @return >= 0 on success (but not necessarily the new offset)
389 3ba1438d Michael Niedermayer
     */
390 a15c7fd6 Anton Khirnov
    attribute_deprecated int (*read_seek)(struct AVFormatContext *,
391
                                          int stream_index, int64_t timestamp, int flags);
392 1de2db8f Michael Niedermayer
#endif
393 8d14a25c Michael Niedermayer
    /**
394 4f57fa8c Diego Biurrun
     * Gets the next timestamp in stream[stream_index].time_base units.
395 d9526386 Diego Biurrun
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
396 8d14a25c Michael Niedermayer
     */
397
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
398
                              int64_t *pos, int64_t pos_limit);
399 76c56376 Michael Niedermayer
400
    /**
401
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
402
     */
403 de6d9b64 Fabrice Bellard
    int flags;
404 76c56376 Michael Niedermayer
405
    /**
406
     * If extensions are defined, then no probe is done. You should
407
     * usually not use extension format guessing because it is not
408
     * reliable enough
409
     */
410 b9a281db Fabrice Bellard
    const char *extensions;
411 76c56376 Michael Niedermayer
412
    /**
413
     * General purpose read-only value that the format can use.
414
     */
415 b9a281db Fabrice Bellard
    int value;
416 fb2758c8 Fabrice Bellard
417 76c56376 Michael Niedermayer
    /**
418
     * Start/resume playing - only meaningful if using a network-based format
419
     * (RTSP).
420
     */
421 fb2758c8 Fabrice Bellard
    int (*read_play)(struct AVFormatContext *);
422
423 76c56376 Michael Niedermayer
    /**
424
     * Pause playing - only meaningful if using a network-based format
425
     * (RTSP).
426
     */
427 fb2758c8 Fabrice Bellard
    int (*read_pause)(struct AVFormatContext *);
428
429 c1854592 Reimar Döffinger
    const struct AVCodecTag * const *codec_tag;
430 7caf0cc6 Michael Niedermayer
431 1de2db8f Michael Niedermayer
    /**
432 49bd8e4b Måns Rullgård
     * Seek to timestamp ts.
433 1de2db8f Michael Niedermayer
     * Seeking will be done so that the point from which all active streams
434
     * can be presented successfully will be closest to ts and within min/max_ts.
435
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
436
     */
437 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);
438 1de2db8f Michael Niedermayer
439 03700d39 Anton Khirnov
#if FF_API_OLD_METADATA
440 719e721a Aurelien Jacobs
    const AVMetadataConv *metadata_conv;
441 03700d39 Anton Khirnov
#endif
442 f610a9f2 Aurelien Jacobs
443 b9a281db Fabrice Bellard
    /* private fields */
444
    struct AVInputFormat *next;
445
} AVInputFormat;
446 de6d9b64 Fabrice Bellard
447 57004ff1 Aurelien Jacobs
enum AVStreamParseType {
448
    AVSTREAM_PARSE_NONE,
449
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
450 4f57fa8c Diego Biurrun
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
451 78cb7273 Diego Biurrun
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
452 74a6df59 Alex Converse
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
453 57004ff1 Aurelien Jacobs
};
454
455 fb2758c8 Fabrice Bellard
typedef struct AVIndexEntry {
456
    int64_t pos;
457
    int64_t timestamp;
458
#define AVINDEX_KEYFRAME 0x0001
459 30a43f2d Michael Niedermayer
    int flags:2;
460 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).
461
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
462 fb2758c8 Fabrice Bellard
} AVIndexEntry;
463
464 90c2295b Evgeniy Stepanov
#define AV_DISPOSITION_DEFAULT   0x0001
465
#define AV_DISPOSITION_DUB       0x0002
466
#define AV_DISPOSITION_ORIGINAL  0x0004
467
#define AV_DISPOSITION_COMMENT   0x0008
468
#define AV_DISPOSITION_LYRICS    0x0010
469
#define AV_DISPOSITION_KARAOKE   0x0020
470 76c56376 Michael Niedermayer
471
/**
472
 * Track should be used during playback by default.
473
 * Useful for subtitle track that should be displayed
474
 * even when user did not explicitly ask for subtitles.
475
 */
476 7a617a86 Aurelien Jacobs
#define AV_DISPOSITION_FORCED    0x0040
477 8270db38 Peter Ross
#define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
478
#define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
479 2ea7e1f0 Anssi Hannula
#define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
480 90c2295b Evgeniy Stepanov
481 ba66ae94 Michael Niedermayer
/**
482
 * Stream structure.
483
 * New fields can be added to the end with minor version bumps.
484 8bfb108b Diego Biurrun
 * Removal, reordering and changes to existing fields require a major
485 ba66ae94 Michael Niedermayer
 * version bump.
486 8bfb108b Diego Biurrun
 * sizeof(AVStream) must not be used outside libav*.
487 ba66ae94 Michael Niedermayer
 */
488 de6d9b64 Fabrice Bellard
typedef struct AVStream {
489 43d414ba Panagiotis Issaris
    int index;    /**< stream index in AVFormatContext */
490 4f57fa8c Diego Biurrun
    int id;       /**< format-specific stream ID */
491 43d414ba Panagiotis Issaris
    AVCodecContext *codec; /**< codec context */
492 b4b87d48 Michael Niedermayer
    /**
493 22e77e44 Diego Biurrun
     * Real base framerate of the stream.
494
     * This is the lowest framerate with which all timestamps can be
495 864ff8c1 Ramiro Polla
     * represented accurately (it is the least common multiple of all
496 22e77e44 Diego Biurrun
     * framerates in the stream). Note, this value is just a guess!
497
     * For example, if the time base is 1/90000 and all frames have either
498 4f57fa8c Diego Biurrun
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
499 b4b87d48 Michael Niedermayer
     */
500
    AVRational r_frame_rate;
501 de6d9b64 Fabrice Bellard
    void *priv_data;
502 82583548 Michael Niedermayer
503 b9a281db Fabrice Bellard
    /* internal data used in av_find_stream_info() */
504 82583548 Michael Niedermayer
    int64_t first_dts;
505 76c56376 Michael Niedermayer
506
    /**
507
     * encoding: pts generation when outputting stream
508
     */
509 a9fd2b19 Måns Rullgård
    struct AVFrac pts;
510 5b28c8c3 Michael Niedermayer
511
    /**
512 8bfb108b Diego Biurrun
     * This is the fundamental unit of time (in seconds) in terms
513
     * of which frame timestamps are represented. For fixed-fps content,
514 22e77e44 Diego Biurrun
     * time base should be 1/framerate and timestamp increments should be 1.
515 12763671 Reimar Döffinger
     * decoding: set by libavformat
516
     * encoding: set by libavformat in av_write_header
517 5b28c8c3 Michael Niedermayer
     */
518 9ee91c2f Michael Niedermayer
    AVRational time_base;
519 43d414ba Panagiotis Issaris
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
520 a48b7a6b Fabrice Bellard
    /* ffmpeg.c private use */
521 4f57fa8c Diego Biurrun
    int stream_copy; /**< If set, just copy stream. */
522
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
523 76c56376 Michael Niedermayer
524 b4aea108 Michael Niedermayer
    //FIXME move stuff to a flags field?
525 76c56376 Michael Niedermayer
    /**
526
     * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
527
     * MN: dunno if that is the right place for it
528
     */
529 115329f1 Diego Biurrun
    float quality;
530 76c56376 Michael Niedermayer
531 6d96a9b9 Michael Niedermayer
    /**
532 8bfb108b Diego Biurrun
     * Decoding: pts of the first frame of the stream, in stream time base.
533
     * Only set this if you are absolutely 100% sure that the value you set
534
     * it to really is the pts of the first frame.
535 4854c253 Neil Brown
     * This may be undefined (AV_NOPTS_VALUE).
536 8bfb108b Diego Biurrun
     * @note The ASF header does NOT contain a correct start_time the ASF
537
     * demuxer must NOT set this.
538 6d96a9b9 Michael Niedermayer
     */
539 115329f1 Diego Biurrun
    int64_t start_time;
540 76c56376 Michael Niedermayer
541 e26381b6 Neil Brown
    /**
542 8bfb108b Diego Biurrun
     * Decoding: duration of the stream, in stream time base.
543 e26381b6 Neil Brown
     * If a source file does not specify a duration, but does specify
544 4f57fa8c Diego Biurrun
     * a bitrate, this value will be estimated from bitrate and file size.
545 e26381b6 Neil Brown
     */
546 ee404803 Fabrice Bellard
    int64_t duration;
547 fb2758c8 Fabrice Bellard
548 54036be1 Aurelien Jacobs
#if FF_API_OLD_METADATA
549 a15c7fd6 Anton Khirnov
    attribute_deprecated char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
550 827f7e28 Aurelien Jacobs
#endif
551 09730260 Fabrice Bellard
552 fb2758c8 Fabrice Bellard
    /* av_read_frame() support */
553 57004ff1 Aurelien Jacobs
    enum AVStreamParseType need_parsing;
554 fb2758c8 Fabrice Bellard
    struct AVCodecParserContext *parser;
555 6ec87caa Fabrice Bellard
556 fb2758c8 Fabrice Bellard
    int64_t cur_dts;
557 635fbcb1 Michael Niedermayer
    int last_IP_duration;
558
    int64_t last_IP_pts;
559 fb2758c8 Fabrice Bellard
    /* av_seek_frame() support */
560 4f57fa8c Diego Biurrun
    AVIndexEntry *index_entries; /**< Only used if the format does not
561
                                    support seeking natively. */
562 fb2758c8 Fabrice Bellard
    int nb_index_entries;
563 191e8ca7 Måns Rullgård
    unsigned int index_entries_allocated_size;
564 115329f1 Diego Biurrun
565 b4b87d48 Michael Niedermayer
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
566 504ee036 Michael Niedermayer
567 d1742ff7 Aurelien Jacobs
#if FF_API_LAVF_UNUSED
568 a15c7fd6 Anton Khirnov
    attribute_deprecated int64_t unused[4+1];
569 dd872bf4 Aurelien Jacobs
#endif
570 f8d7c9d3 Evgeniy Stepanov
571 54036be1 Aurelien Jacobs
#if FF_API_OLD_METADATA
572 a15c7fd6 Anton Khirnov
    attribute_deprecated char *filename; /**< source filename of the stream */
573 827f7e28 Aurelien Jacobs
#endif
574 90c2295b Evgeniy Stepanov
575 4f57fa8c Diego Biurrun
    int disposition; /**< AV_DISPOSITION_* bit field */
576 0bef08e5 Michael Niedermayer
577
    AVProbeData probe_data;
578 0d84a8f6 Baptiste Coudurier
#define MAX_REORDER_DELAY 16
579
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
580 c30a4489 Aurelien Jacobs
581
    /**
582
     * sample aspect ratio (0 if unknown)
583
     * - encoding: Set by user.
584
     * - decoding: Set by libavformat.
585
     */
586
    AVRational sample_aspect_ratio;
587 f526adaf Aurelien Jacobs
588 e232c252 Aurelien Jacobs
    AVMetadata *metadata;
589 3a41c2f7 Michael Niedermayer
590 31769dad Víctor Paesa
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
591
    /* external applications; try to use something else if at all possible.    */
592 3a41c2f7 Michael Niedermayer
    const uint8_t *cur_ptr;
593
    int cur_len;
594
    AVPacket cur_pkt;
595 27ca0a79 Ivan Schreter
596
    // Timestamp generation support:
597
    /**
598
     * Timestamp corresponding to the last dts sync point.
599
     *
600
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
601
     * a DTS is received from the underlying container. Otherwise set to
602
     * AV_NOPTS_VALUE by default.
603
     */
604
    int64_t reference_dts;
605 86cb7e33 Baptiste Coudurier
606
    /**
607
     * Number of packets to buffer for codec probing
608
     * NOT PART OF PUBLIC API
609
     */
610 48616887 Carl Eugen Hoyos
#define MAX_PROBE_PACKETS 2500
611 86cb7e33 Baptiste Coudurier
    int probe_packets;
612 ddce56ef Michael Niedermayer
613
    /**
614 e07b882b Michael Niedermayer
     * last packet in packet_buffer for this stream when muxing.
615 ddce56ef Michael Niedermayer
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
616
     */
617 e07b882b Michael Niedermayer
    struct AVPacketList *last_in_packet_buffer;
618 02b398ef Michael Niedermayer
619
    /**
620
     * Average framerate
621
     */
622
    AVRational avg_frame_rate;
623 6c6e6ef5 Michael Niedermayer
624
    /**
625
     * Number of frames that have been demuxed during av_find_stream_info()
626
     */
627
    int codec_info_nb_frames;
628 fd0368e7 Aurelien Jacobs
629
    /**
630
     * Stream informations used internally by av_find_stream_info()
631
     */
632
#define MAX_STD_TIMEBASES (60*12+5)
633
    struct {
634
        int64_t last_dts;
635
        int64_t duration_gcd;
636
        int duration_count;
637
        double duration_error[MAX_STD_TIMEBASES];
638
        int64_t codec_info_duration;
639
    } *info;
640 de6d9b64 Fabrice Bellard
} AVStream;
641
642 15afa396 Nico Sabbi
#define AV_PROGRAM_RUNNING 1
643
644 ba66ae94 Michael Niedermayer
/**
645
 * New fields can be added to the end with minor version bumps.
646 8bfb108b Diego Biurrun
 * Removal, reordering and changes to existing fields require a major
647 ba66ae94 Michael Niedermayer
 * version bump.
648 8bfb108b Diego Biurrun
 * sizeof(AVProgram) must not be used outside libav*.
649 ba66ae94 Michael Niedermayer
 */
650 15afa396 Nico Sabbi
typedef struct AVProgram {
651
    int            id;
652 54036be1 Aurelien Jacobs
#if FF_API_OLD_METADATA
653 a15c7fd6 Anton Khirnov
    attribute_deprecated char           *provider_name; ///< network name for DVB streams
654
    attribute_deprecated char           *name;          ///< service name for DVB streams
655 827f7e28 Aurelien Jacobs
#endif
656 15afa396 Nico Sabbi
    int            flags;
657
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
658 526efa10 Nico Sabbi
    unsigned int   *stream_index;
659
    unsigned int   nb_stream_indexes;
660 e232c252 Aurelien Jacobs
    AVMetadata *metadata;
661 15afa396 Nico Sabbi
} AVProgram;
662
663 43d414ba Panagiotis Issaris
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
664 da24c5e3 Fabrice Bellard
                                         (streams are added dynamically) */
665
666 79d7836a Anton Khirnov
typedef struct AVChapter {
667 4f57fa8c Diego Biurrun
    int id;                 ///< unique ID to identify the chapter
668
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
669 8931e7b4 Michael Niedermayer
    int64_t start, end;     ///< chapter start/end time in time_base units
670 54036be1 Aurelien Jacobs
#if FF_API_OLD_METADATA
671 a15c7fd6 Anton Khirnov
    attribute_deprecated char *title;            ///< chapter title
672 827f7e28 Aurelien Jacobs
#endif
673 e232c252 Aurelien Jacobs
    AVMetadata *metadata;
674 79d7836a Anton Khirnov
} AVChapter;
675
676 54036be1 Aurelien Jacobs
#if FF_API_MAX_STREAMS
677 de6d9b64 Fabrice Bellard
#define MAX_STREAMS 20
678 ad5cc780 Jai Menon
#endif
679 de6d9b64 Fabrice Bellard
680 252f17e2 Michael Niedermayer
/**
681 4f57fa8c Diego Biurrun
 * Format I/O context.
682 252f17e2 Michael Niedermayer
 * New fields can be added to the end with minor version bumps.
683 8bfb108b Diego Biurrun
 * Removal, reordering and changes to existing fields require a major
684 252f17e2 Michael Niedermayer
 * version bump.
685 8bfb108b Diego Biurrun
 * sizeof(AVFormatContext) must not be used outside libav*.
686 252f17e2 Michael Niedermayer
 */
687 de6d9b64 Fabrice Bellard
typedef struct AVFormatContext {
688 1447aac4 avcoder
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
689 4f57fa8c Diego Biurrun
    /* Can only be iformat or oformat, not both at the same time. */
690 b9a281db Fabrice Bellard
    struct AVInputFormat *iformat;
691
    struct AVOutputFormat *oformat;
692 de6d9b64 Fabrice Bellard
    void *priv_data;
693 471fe57e Anton Khirnov
    AVIOContext *pb;
694 db69c2e5 Diego Biurrun
    unsigned int nb_streams;
695 61138c43 Aurelien Jacobs
#if FF_API_MAX_STREAMS
696 de6d9b64 Fabrice Bellard
    AVStream *streams[MAX_STREAMS];
697 38aab35f Aurelien Jacobs
#else
698
    AVStream **streams;
699
#endif
700 43d414ba Panagiotis Issaris
    char filename[1024]; /**< input or output filename */
701 de6d9b64 Fabrice Bellard
    /* stream info */
702 4568325a Roman Shaposhnik
    int64_t timestamp;
703 54036be1 Aurelien Jacobs
#if FF_API_OLD_METADATA
704 a15c7fd6 Anton Khirnov
    attribute_deprecated char title[512];
705
    attribute_deprecated char author[512];
706
    attribute_deprecated char copyright[512];
707
    attribute_deprecated char comment[512];
708
    attribute_deprecated char album[512];
709
    attribute_deprecated int year;  /**< ID3 year, 0 if none */
710
    attribute_deprecated int track; /**< track number, 0 if none */
711
    attribute_deprecated char genre[32]; /**< ID3 genre */
712 827f7e28 Aurelien Jacobs
#endif
713 6a58e151 Fabrice Bellard
714 4f57fa8c Diego Biurrun
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
715
    /* private data for pts handling (do not modify directly). */
716 76c56376 Michael Niedermayer
    /**
717
     * This buffer is only needed when packets were already buffered but
718
     * not decoded, for example to get the codec parameters in MPEG
719
     * streams.
720
     */
721 ee404803 Fabrice Bellard
    struct AVPacketList *packet_buffer;
722
723 76c56376 Michael Niedermayer
    /**
724
     * Decoding: position of the first frame of the component, in
725
     * AV_TIME_BASE fractional seconds. NEVER set this value directly:
726
     * It is deduced from the AVStream values.
727
     */
728 115329f1 Diego Biurrun
    int64_t start_time;
729 76c56376 Michael Niedermayer
730
    /**
731
     * Decoding: duration of the stream, in AV_TIME_BASE fractional
732
     * seconds. Only set this value if you know none of the individual stream
733
     * durations and also dont set any of them. This is deduced from the
734
     * AVStream values if not set.
735
     */
736 ee404803 Fabrice Bellard
    int64_t duration;
737 76c56376 Michael Niedermayer
738
    /**
739
     * decoding: total file size, 0 if unknown
740
     */
741 ee404803 Fabrice Bellard
    int64_t file_size;
742 76c56376 Michael Niedermayer
743
    /**
744
     * Decoding: total stream bitrate in bit/s, 0 if not
745
     * available. Never set it directly if the file_size and the
746
     * duration are known as FFmpeg can compute it automatically.
747
     */
748 ee404803 Fabrice Bellard
    int bit_rate;
749 fb2758c8 Fabrice Bellard
750
    /* av_read_frame() support */
751
    AVStream *cur_st;
752 d1742ff7 Aurelien Jacobs
#if FF_API_LAVF_UNUSED
753 3a41c2f7 Michael Niedermayer
    const uint8_t *cur_ptr_deprecated;
754
    int cur_len_deprecated;
755
    AVPacket cur_pkt_deprecated;
756
#endif
757 fb2758c8 Fabrice Bellard
758
    /* av_seek_frame() support */
759 ec906fcd Michael Niedermayer
    int64_t data_offset; /**< offset of the first packet */
760 b845252d Anton Khirnov
#if FF_API_INDEX_BUILT
761
    attribute_deprecated int index_built;
762
#endif
763 115329f1 Diego Biurrun
764 2db3c638 Michael Niedermayer
    int mux_rate;
765 92400be2 Ronald S. Bultje
    unsigned int packet_size;
766 17c88cb0 Michael Niedermayer
    int preload;
767
    int max_delay;
768 8108551a Todd Kirby
769 115329f1 Diego Biurrun
#define AVFMT_NOOUTPUTLOOP -1
770
#define AVFMT_INFINITEOUTPUTLOOP 0
771 76c56376 Michael Niedermayer
    /**
772
     * number of times to loop output in formats that support it
773
     */
774 8108551a Todd Kirby
    int loop_output;
775 115329f1 Diego Biurrun
776 30bc6613 Michael Niedermayer
    int flags;
777 22e77e44 Diego Biurrun
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
778 4f57fa8c Diego Biurrun
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
779
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
780 c55806e3 Michael Niedermayer
#define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
781 fe8344a2 Michael Niedermayer
#define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
782
#define AVFMT_FLAG_NOPARSE      0x0020 ///< Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the fillin code works on frames and no parsing -> no frames. Also seeking to frames can not work if parsing to find frame boundaries has been disabled
783 796ac233 Martin Storsjö
#define AVFMT_FLAG_RTP_HINT     0x0040 ///< Add RTP hinting to the output file
784 5894e1bb Víctor Paesa
785
    int loop_input;
786 76c56376 Michael Niedermayer
787
    /**
788
     * decoding: size of data to probe; encoding: unused.
789
     */
790 9e6c9470 Nico Sabbi
    unsigned int probesize;
791 a44b3c4d Michael Niedermayer
792
    /**
793 4f57fa8c Diego Biurrun
     * Maximum time (in AV_TIME_BASE units) during which the input should
794
     * be analyzed in av_find_stream_info().
795 a44b3c4d Michael Niedermayer
     */
796
    int max_analyze_duration;
797 c964c2c7 Reimar Döffinger
798
    const uint8_t *key;
799
    int keylen;
800 15afa396 Nico Sabbi
801
    unsigned int nb_programs;
802
    AVProgram **programs;
803 62600469 Michael Niedermayer
804
    /**
805
     * Forced video codec_id.
806 4f57fa8c Diego Biurrun
     * Demuxing: Set by user.
807 62600469 Michael Niedermayer
     */
808
    enum CodecID video_codec_id;
809 76c56376 Michael Niedermayer
810 62600469 Michael Niedermayer
    /**
811
     * Forced audio codec_id.
812 4f57fa8c Diego Biurrun
     * Demuxing: Set by user.
813 62600469 Michael Niedermayer
     */
814
    enum CodecID audio_codec_id;
815 76c56376 Michael Niedermayer
816 62600469 Michael Niedermayer
    /**
817
     * Forced subtitle codec_id.
818 4f57fa8c Diego Biurrun
     * Demuxing: Set by user.
819 62600469 Michael Niedermayer
     */
820
    enum CodecID subtitle_codec_id;
821 3dea63bd Paul Kelly
822
    /**
823 22e77e44 Diego Biurrun
     * Maximum amount of memory in bytes to use for the index of each stream.
824
     * If the index exceeds this size, entries will be discarded as
825 3dea63bd Paul Kelly
     * needed to maintain a smaller size. This can lead to slower or less
826
     * accurate seeking (depends on demuxer).
827 4f57fa8c Diego Biurrun
     * Demuxers for which a full in-memory index is mandatory will ignore
828 3dea63bd Paul Kelly
     * this.
829
     * muxing  : unused
830
     * demuxing: set by user
831
     */
832
    unsigned int max_index_size;
833 ab8ab30c Ramiro Polla
834
    /**
835 ffa71b2b Ramiro Polla
     * Maximum amount of memory in bytes to use for buffering frames
836 4f57fa8c Diego Biurrun
     * obtained from realtime capture devices.
837 ab8ab30c Ramiro Polla
     */
838
    unsigned int max_picture_buffer;
839 79d7836a Anton Khirnov
840 fbabf1e9 Michael Niedermayer
    unsigned int nb_chapters;
841 79d7836a Anton Khirnov
    AVChapter **chapters;
842 45b2b05f Michael Niedermayer
843
    /**
844 4f57fa8c Diego Biurrun
     * Flags to enable debugging.
845 45b2b05f Michael Niedermayer
     */
846
    int debug;
847
#define FF_FDEBUG_TS        0x0001
848 0bef08e5 Michael Niedermayer
849
    /**
850 4f57fa8c Diego Biurrun
     * Raw packets from the demuxer, prior to parsing and decoding.
851 0bef08e5 Michael Niedermayer
     * This buffer is used for buffering packets until the codec can
852
     * be identified, as parsing cannot be done without knowing the
853
     * codec.
854
     */
855
    struct AVPacketList *raw_packet_buffer;
856 5c5b1731 Måns Rullgård
    struct AVPacketList *raw_packet_buffer_end;
857
858
    struct AVPacketList *packet_buffer_end;
859 47146dfb Michael Niedermayer
860 e232c252 Aurelien Jacobs
    AVMetadata *metadata;
861 af122d6a Baptiste Coudurier
862
    /**
863
     * Remaining size available for raw_packet_buffer, in bytes.
864
     * NOT PART OF PUBLIC API
865
     */
866 48616887 Carl Eugen Hoyos
#define RAW_PACKET_BUFFER_SIZE 2500000
867 af122d6a Baptiste Coudurier
    int raw_packet_buffer_remaining_size;
868 b8819c85 Martin Storsjö
869
    /**
870
     * Start time of the stream in real world time, in microseconds
871
     * since the unix epoch (00:00 1st January 1970). That is, pts=0
872
     * in the stream was captured at this real world time.
873
     * - encoding: Set by user.
874
     * - decoding: Unused.
875
     */
876
    int64_t start_time_realtime;
877 de6d9b64 Fabrice Bellard
} AVFormatContext;
878
879
typedef struct AVPacketList {
880
    AVPacket pkt;
881
    struct AVPacketList *next;
882
} AVPacketList;
883
884 114c9a59 Aurelien Jacobs
#if FF_API_FIRST_FORMAT
885 a15c7fd6 Anton Khirnov
attribute_deprecated extern AVInputFormat *first_iformat;
886
attribute_deprecated extern AVOutputFormat *first_oformat;
887 84be6e72 Michael Niedermayer
#endif
888
889 aeedac95 Stefano Sabatini
/**
890
 * If f is NULL, returns the first registered input format,
891 22e77e44 Diego Biurrun
 * if f is non-NULL, returns the next registered input format after f
892 aeedac95 Stefano Sabatini
 * or NULL if f is the last one.
893
 */
894 84be6e72 Michael Niedermayer
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
895 aeedac95 Stefano Sabatini
896
/**
897
 * If f is NULL, returns the first registered output format,
898 22e77e44 Diego Biurrun
 * if f is non-NULL, returns the next registered output format after f
899 aeedac95 Stefano Sabatini
 * or NULL if f is the last one.
900
 */
901 84be6e72 Michael Niedermayer
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
902 de6d9b64 Fabrice Bellard
903 5b6d5596 Michael Niedermayer
enum CodecID av_guess_image2_codec(const char *filename);
904 290c5fa6 Fabrice Bellard
905 22e77e44 Diego Biurrun
/* XXX: Use automatic init with either ELF sections or C file parser */
906
/* modules. */
907 de6d9b64 Fabrice Bellard
908 b9a281db Fabrice Bellard
/* utils.c */
909
void av_register_input_format(AVInputFormat *format);
910
void av_register_output_format(AVOutputFormat *format);
911 198ac67f Aurelien Jacobs
#if FF_API_GUESS_FORMAT
912 1642ee43 Stefano Sabatini
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
913 78cb7273 Diego Biurrun
                                    const char *filename,
914
                                    const char *mime_type);
915 a1f547b9 Stefano Sabatini
916
/**
917
 * @deprecated Use av_guess_format() instead.
918
 */
919
attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
920
                                                  const char *filename,
921
                                                  const char *mime_type);
922 1642ee43 Stefano Sabatini
#endif
923 f48b0fa2 Stefano Sabatini
924
/**
925 49bd8e4b Måns Rullgård
 * Return the output format in the list of registered output formats
926
 * which best matches the provided parameters, or return NULL if
927 f48b0fa2 Stefano Sabatini
 * there is no match.
928
 *
929
 * @param short_name if non-NULL checks if short_name matches with the
930
 * names of the registered formats
931
 * @param filename if non-NULL checks if filename terminates with the
932
 * extensions of the registered formats
933
 * @param mime_type if non-NULL checks if mime_type matches with the
934
 * MIME type of the registered formats
935
 */
936 a1f547b9 Stefano Sabatini
AVOutputFormat *av_guess_format(const char *short_name,
937 94b1f338 Stefano Sabatini
                                const char *filename,
938
                                const char *mime_type);
939 3217cb42 Panagiotis Issaris
940
/**
941 49bd8e4b Måns Rullgård
 * Guess the codec ID based upon muxer and filename.
942 3217cb42 Panagiotis Issaris
 */
943 115329f1 Diego Biurrun
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
944 78cb7273 Diego Biurrun
                            const char *filename, const char *mime_type,
945 72415b2a Stefano Sabatini
                            enum AVMediaType type);
946 de6d9b64 Fabrice Bellard
947 3217cb42 Panagiotis Issaris
/**
948 49bd8e4b Måns Rullgård
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
949 750f0e1f Panagiotis Issaris
 *
950
 * @param f The file stream pointer where the dump should be sent to.
951 3217cb42 Panagiotis Issaris
 * @param buf buffer
952
 * @param size buffer size
953 750f0e1f Panagiotis Issaris
 *
954
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
955 3217cb42 Panagiotis Issaris
 */
956 fb2758c8 Fabrice Bellard
void av_hex_dump(FILE *f, uint8_t *buf, int size);
957 3217cb42 Panagiotis Issaris
958
/**
959 49bd8e4b Måns Rullgård
 * Send a nice hexadecimal dump of a buffer to the log.
960 750f0e1f Panagiotis Issaris
 *
961
 * @param avcl A pointer to an arbitrary struct of which the first field is a
962
 * pointer to an AVClass struct.
963
 * @param level The importance level of the message, lower values signifying
964
 * higher importance.
965
 * @param buf buffer
966
 * @param size buffer size
967
 *
968
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
969
 */
970
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
971
972
/**
973 49bd8e4b Måns Rullgård
 * Send a nice dump of a packet to the specified file stream.
974 750f0e1f Panagiotis Issaris
 *
975
 * @param f The file stream pointer where the dump should be sent to.
976 3217cb42 Panagiotis Issaris
 * @param pkt packet to dump
977 4f57fa8c Diego Biurrun
 * @param dump_payload True if the payload must be displayed, too.
978 3217cb42 Panagiotis Issaris
 */
979 fb2758c8 Fabrice Bellard
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
980 de6d9b64 Fabrice Bellard
981 750f0e1f Panagiotis Issaris
/**
982 49bd8e4b Måns Rullgård
 * Send a nice dump of a packet to the log.
983 750f0e1f Panagiotis Issaris
 *
984
 * @param avcl A pointer to an arbitrary struct of which the first field is a
985
 * pointer to an AVClass struct.
986
 * @param level The importance level of the message, lower values signifying
987
 * higher importance.
988
 * @param pkt packet to dump
989 4f57fa8c Diego Biurrun
 * @param dump_payload True if the payload must be displayed, too.
990 750f0e1f Panagiotis Issaris
 */
991
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
992
993 4815e246 Stefano Sabatini
/**
994 49bd8e4b Måns Rullgård
 * Initialize libavformat and register all the muxers, demuxers and
995 4815e246 Stefano Sabatini
 * protocols. If you do not call this function, then you can select
996
 * exactly which formats you want to support.
997
 *
998
 * @see av_register_input_format()
999
 * @see av_register_output_format()
1000 5d377501 Stefano Sabatini
 * @see av_register_protocol()
1001 4815e246 Stefano Sabatini
 */
1002 94988531 Fabrice Bellard
void av_register_all(void);
1003 de6d9b64 Fabrice Bellard
1004 7693b93e Stefano Sabatini
/**
1005 49bd8e4b Måns Rullgård
 * Get the CodecID for the given codec tag tag.
1006 7693b93e Stefano Sabatini
 * If no codec id is found returns CODEC_ID_NONE.
1007
 *
1008
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1009
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1010
 */
1011 15545a09 Stefano Sabatini
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1012 7693b93e Stefano Sabatini
1013
/**
1014 49bd8e4b Måns Rullgård
 * Get the codec tag for the given codec id id.
1015 7693b93e Stefano Sabatini
 * If no codec tag is found returns 0.
1016
 *
1017
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1018
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1019
 */
1020 15545a09 Stefano Sabatini
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1021 7caf0cc6 Michael Niedermayer
1022 b9a281db Fabrice Bellard
/* media file input */
1023 3217cb42 Panagiotis Issaris
1024
/**
1025 49bd8e4b Måns Rullgård
 * Find AVInputFormat based on the short name of the input format.
1026 3217cb42 Panagiotis Issaris
 */
1027 b9a281db Fabrice Bellard
AVInputFormat *av_find_input_format(const char *short_name);
1028 3217cb42 Panagiotis Issaris
1029
/**
1030 49bd8e4b Måns Rullgård
 * Guess the file format.
1031 3217cb42 Panagiotis Issaris
 *
1032 4f57fa8c Diego Biurrun
 * @param is_opened Whether the file is already opened; determines whether
1033
 *                  demuxers with or without AVFMT_NOFILE are probed.
1034 3217cb42 Panagiotis Issaris
 */
1035 94988531 Fabrice Bellard
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1036 3217cb42 Panagiotis Issaris
1037
/**
1038 49bd8e4b Måns Rullgård
 * Guess the file format.
1039 8e2ee182 Reimar Döffinger
 *
1040
 * @param is_opened Whether the file is already opened; determines whether
1041
 *                  demuxers with or without AVFMT_NOFILE are probed.
1042 c99d506b Reimar Döffinger
 * @param score_max A probe score larger that this is required to accept a
1043
 *                  detection, the variable is set to the actual detection
1044
 *                  score afterwards.
1045
 *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1046 8e2ee182 Reimar Döffinger
 *                  to retry with a larger probe buffer.
1047
 */
1048
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1049
1050
/**
1051 070e5ba5 Anssi Hannula
 * Probe a bytestream to determine the input format. Each time a probe returns
1052
 * with a score that is too low, the probe buffer size is increased and another
1053
 * attempt is made. When the maximum probe size is reached, the input format
1054
 * with the highest score is returned.
1055
 *
1056
 * @param pb the bytestream to probe
1057
 * @param fmt the input format is put here
1058
 * @param filename the filename of the stream
1059
 * @param logctx the log context
1060
 * @param offset the offset within the bytestream to probe from
1061
 * @param max_probe_size the maximum probe buffer size (zero for default)
1062
 * @return 0 in case of success, a negative value corresponding to an
1063
 * AVERROR code otherwise
1064
 */
1065 471fe57e Anton Khirnov
int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1066 070e5ba5 Anssi Hannula
                          const char *filename, void *logctx,
1067
                          unsigned int offset, unsigned int max_probe_size);
1068
1069
/**
1070 49bd8e4b Måns Rullgård
 * Allocate all the structures needed to read an input stream.
1071 3217cb42 Panagiotis Issaris
 *        This does not open the needed codecs for decoding the stream[s].
1072
 */
1073 115329f1 Diego Biurrun
int av_open_input_stream(AVFormatContext **ic_ptr,
1074 471fe57e Anton Khirnov
                         AVIOContext *pb, const char *filename,
1075 da24c5e3 Fabrice Bellard
                         AVInputFormat *fmt, AVFormatParameters *ap);
1076 3217cb42 Panagiotis Issaris
1077
/**
1078 49bd8e4b Måns Rullgård
 * Open a media file as input. The codecs are not opened. Only the file
1079 3217cb42 Panagiotis Issaris
 * header (if present) is read.
1080
 *
1081 4f57fa8c Diego Biurrun
 * @param ic_ptr The opened media file handle is put here.
1082
 * @param filename filename to open
1083
 * @param fmt If non-NULL, force the file format to use.
1084 3217cb42 Panagiotis Issaris
 * @param buf_size optional buffer size (zero if default is OK)
1085 78cb7273 Diego Biurrun
 * @param ap Additional parameters needed when opening the file
1086
 *           (NULL if default).
1087 4f57fa8c Diego Biurrun
 * @return 0 if OK, AVERROR_xxx otherwise
1088 3217cb42 Panagiotis Issaris
 */
1089 115329f1 Diego Biurrun
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1090 b9a281db Fabrice Bellard
                       AVInputFormat *fmt,
1091
                       int buf_size,
1092
                       AVFormatParameters *ap);
1093 88a28965 Stefano Sabatini
1094 ca51d86c Aurelien Jacobs
#if FF_API_ALLOC_FORMAT_CONTEXT
1095 88a28965 Stefano Sabatini
/**
1096
 * @deprecated Use avformat_alloc_context() instead.
1097
 */
1098
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1099
#endif
1100
1101 88808c60 Michael Niedermayer
/**
1102 49bd8e4b Måns Rullgård
 * Allocate an AVFormatContext.
1103 4ed68fdf Martin Storsjö
 * avformat_free_context() can be used to free the context and everything
1104
 * allocated by the framework within it.
1105 88808c60 Michael Niedermayer
 */
1106 88a28965 Stefano Sabatini
AVFormatContext *avformat_alloc_context(void);
1107 b9a281db Fabrice Bellard
1108 3217cb42 Panagiotis Issaris
/**
1109 49bd8e4b Måns Rullgård
 * Read packets of a media file to get stream information. This
1110 3217cb42 Panagiotis Issaris
 * is useful for file formats with no headers such as MPEG. This
1111 22e77e44 Diego Biurrun
 * function also computes the real framerate in case of MPEG-2 repeat
1112 3217cb42 Panagiotis Issaris
 * frame mode.
1113
 * The logical file position is not changed by this function;
1114
 * examined packets may be buffered for later processing.
1115
 *
1116
 * @param ic media file handle
1117 4f57fa8c Diego Biurrun
 * @return >=0 if OK, AVERROR_xxx on error
1118
 * @todo Let the user decide somehow what information is needed so that
1119
 *       we do not waste time getting stuff the user does not need.
1120 3217cb42 Panagiotis Issaris
 */
1121 b9a281db Fabrice Bellard
int av_find_stream_info(AVFormatContext *ic);
1122 3217cb42 Panagiotis Issaris
1123
/**
1124 9128ae08 Nicolas George
 * Find the "best" stream in the file.
1125
 * The best stream is determined according to various heuristics as the most
1126
 * likely to be what the user expects.
1127
 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1128
 * default decoder for the stream's codec; streams for which no decoder can
1129
 * be found are ignored.
1130
 *
1131
 * @param ic                media file handle
1132
 * @param type              stream type: video, audio, subtitles, etc.
1133
 * @param wanted_stream_nb  user-requested stream number,
1134
 *                          or -1 for automatic selection
1135
 * @param related_stream    try to find a stream related (eg. in the same
1136
 *                          program) to this one, or -1 if none
1137
 * @param decoder_ret       if non-NULL, returns the decoder for the
1138
 *                          selected stream
1139
 * @param flags             flags; none are currently defined
1140
 * @return  the non-negative stream number in case of success,
1141
 *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1142
 *          could be found,
1143
 *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1144
 * @note  If av_find_best_stream returns successfully and decoder_ret is not
1145
 *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1146
 */
1147
int av_find_best_stream(AVFormatContext *ic,
1148
                        enum AVMediaType type,
1149
                        int wanted_stream_nb,
1150
                        int related_stream,
1151
                        AVCodec **decoder_ret,
1152
                        int flags);
1153
1154
/**
1155 49bd8e4b Måns Rullgård
 * Read a transport packet from a media file.
1156 3217cb42 Panagiotis Issaris
 *
1157 864ff8c1 Ramiro Polla
 * This function is obsolete and should never be used.
1158 3217cb42 Panagiotis Issaris
 * Use av_read_frame() instead.
1159
 *
1160
 * @param s media file handle
1161
 * @param pkt is filled
1162 4f57fa8c Diego Biurrun
 * @return 0 if OK, AVERROR_xxx on error
1163 3217cb42 Panagiotis Issaris
 */
1164 de6d9b64 Fabrice Bellard
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1165 3217cb42 Panagiotis Issaris
1166
/**
1167 49bd8e4b Måns Rullgård
 * Return the next frame of a stream.
1168 4faf628f Michael Niedermayer
 * This function returns what is stored in the file, and does not validate
1169
 * that what is there are valid frames for the decoder. It will split what is
1170
 * stored in the file into frames and return one for each call. It will not
1171
 * omit invalid data between valid frames so as to give the decoder the maximum
1172
 * information possible for decoding.
1173 3217cb42 Panagiotis Issaris
 *
1174
 * The returned packet is valid
1175
 * until the next av_read_frame() or until av_close_input_file() and
1176
 * must be freed with av_free_packet. For video, the packet contains
1177
 * exactly one frame. For audio, it contains an integer number of
1178
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1179
 * data). If the audio frames have a variable size (e.g. MPEG audio),
1180
 * then it contains one frame.
1181
 *
1182
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1183 22e77e44 Diego Biurrun
 * values in AVStream.time_base units (and guessed if the format cannot
1184 4f57fa8c Diego Biurrun
 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1185
 * has B-frames, so it is better to rely on pkt->dts if you do not
1186 3217cb42 Panagiotis Issaris
 * decompress the payload.
1187
 *
1188 4f57fa8c Diego Biurrun
 * @return 0 if OK, < 0 on error or end of file
1189 3217cb42 Panagiotis Issaris
 */
1190 fb2758c8 Fabrice Bellard
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1191 3217cb42 Panagiotis Issaris
1192
/**
1193 49bd8e4b Måns Rullgård
 * Seek to the keyframe at timestamp.
1194 3217cb42 Panagiotis Issaris
 * 'timestamp' in 'stream_index'.
1195
 * @param stream_index If stream_index is (-1), a default
1196
 * stream is selected, and timestamp is automatically converted
1197
 * from AV_TIME_BASE units to the stream specific time_base.
1198 4f57fa8c Diego Biurrun
 * @param timestamp Timestamp in AVStream.time_base units
1199
 *        or, if no stream is specified, in AV_TIME_BASE units.
1200 3217cb42 Panagiotis Issaris
 * @param flags flags which select direction and seeking mode
1201
 * @return >= 0 on success
1202
 */
1203 78cb7273 Diego Biurrun
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1204
                  int flags);
1205 3217cb42 Panagiotis Issaris
1206
/**
1207 49bd8e4b Måns Rullgård
 * Seek to timestamp ts.
1208 d04768fa Michael Niedermayer
 * Seeking will be done so that the point from which all active streams
1209
 * can be presented successfully will be closest to ts and within min/max_ts.
1210
 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1211
 *
1212 22e77e44 Diego Biurrun
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1213 d04768fa Michael Niedermayer
 * are the file position (this may not be supported by all demuxers).
1214 22e77e44 Diego Biurrun
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1215 d04768fa Michael Niedermayer
 * in the stream with stream_index (this may not be supported by all demuxers).
1216 22e77e44 Diego Biurrun
 * Otherwise all timestamps are in units of the stream selected by stream_index
1217
 * or if stream_index is -1, in AV_TIME_BASE units.
1218
 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1219 d04768fa Michael Niedermayer
 * keyframes (this may not be supported by all demuxers).
1220
 *
1221 22e77e44 Diego Biurrun
 * @param stream_index index of the stream which is used as time base reference
1222 d04768fa Michael Niedermayer
 * @param min_ts smallest acceptable timestamp
1223
 * @param ts target timestamp
1224
 * @param max_ts largest acceptable timestamp
1225
 * @param flags flags
1226 32e543f8 Benoit Fouet
 * @return >=0 on success, error code otherwise
1227 998b6f7c Michael Niedermayer
 *
1228 8a4d7a30 Diego Biurrun
 * @note This is part of the new seek API which is still under construction.
1229 22e77e44 Diego Biurrun
 *       Thus do not use this yet. It may change at any time, do not expect
1230
 *       ABI compatibility yet!
1231 d04768fa Michael Niedermayer
 */
1232
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1233
1234
/**
1235 49bd8e4b Måns Rullgård
 * Start playing a network-based stream (e.g. RTSP stream) at the
1236 4f57fa8c Diego Biurrun
 * current position.
1237 3217cb42 Panagiotis Issaris
 */
1238 fb2758c8 Fabrice Bellard
int av_read_play(AVFormatContext *s);
1239 3217cb42 Panagiotis Issaris
1240
/**
1241 49bd8e4b Måns Rullgård
 * Pause a network-based stream (e.g. RTSP stream).
1242 3217cb42 Panagiotis Issaris
 *
1243
 * Use av_read_play() to resume it.
1244
 */
1245 fb2758c8 Fabrice Bellard
int av_read_pause(AVFormatContext *s);
1246 3217cb42 Panagiotis Issaris
1247
/**
1248 49bd8e4b Måns Rullgård
 * Free a AVFormatContext allocated by av_open_input_stream.
1249 2506fd54 Reimar Döffinger
 * @param s context to free
1250
 */
1251
void av_close_input_stream(AVFormatContext *s);
1252
1253
/**
1254 49bd8e4b Måns Rullgård
 * Close a media file (but not its codecs).
1255 3217cb42 Panagiotis Issaris
 *
1256
 * @param s media file handle
1257
 */
1258 de6d9b64 Fabrice Bellard
void av_close_input_file(AVFormatContext *s);
1259 3217cb42 Panagiotis Issaris
1260
/**
1261 4ed68fdf Martin Storsjö
 * Free an AVFormatContext and all its streams.
1262
 * @param s context to free
1263
 */
1264
void avformat_free_context(AVFormatContext *s);
1265
1266
/**
1267 49bd8e4b Måns Rullgård
 * Add a new stream to a media file.
1268 3217cb42 Panagiotis Issaris
 *
1269
 * Can only be called in the read_header() function. If the flag
1270
 * AVFMTCTX_NOHEADER is in the format context, then new streams
1271
 * can be added in read_packet too.
1272
 *
1273
 * @param s media file handle
1274 4f57fa8c Diego Biurrun
 * @param id file-format-dependent stream ID
1275 3217cb42 Panagiotis Issaris
 */
1276 b9a281db Fabrice Bellard
AVStream *av_new_stream(AVFormatContext *s, int id);
1277 15afa396 Nico Sabbi
AVProgram *av_new_program(AVFormatContext *s, int id);
1278 3217cb42 Panagiotis Issaris
1279
/**
1280 2f35beae Reimar Döffinger
 * Set the pts for a given stream. If the new values would be invalid
1281
 * (<= 0), it leaves the AVStream unchanged.
1282 3217cb42 Panagiotis Issaris
 *
1283
 * @param s stream
1284
 * @param pts_wrap_bits number of bits effectively used by the pts
1285
 *        (used for wrap control, 33 is the value for MPEG)
1286
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1287
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1288
 */
1289 9ee91c2f Michael Niedermayer
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1290 dec14949 Michael Niedermayer
                     unsigned int pts_num, unsigned int pts_den);
1291 de6d9b64 Fabrice Bellard
1292 3ba1438d Michael Niedermayer
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1293
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1294 4f57fa8c Diego Biurrun
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1295 2bf74f49 Aurelien Jacobs
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1296 3ba1438d Michael Niedermayer
1297 b754978a Michael Niedermayer
int av_find_default_stream_index(AVFormatContext *s);
1298 3217cb42 Panagiotis Issaris
1299
/**
1300 49bd8e4b Måns Rullgård
 * Get the index for a specific timestamp.
1301 4f57fa8c Diego Biurrun
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1302
 *                 to the timestamp which is <= the requested one, if backward
1303
 *                 is 0, then it will be >=
1304 3217cb42 Panagiotis Issaris
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1305
 * @return < 0 if no such timestamp could be found
1306
 */
1307 dc56fc38 Michael Niedermayer
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1308 3217cb42 Panagiotis Issaris
1309
/**
1310 49bd8e4b Måns Rullgård
 * Add an index entry into a sorted list. Update the entry if the list
1311 4f57fa8c Diego Biurrun
 * already contains it.
1312 3217cb42 Panagiotis Issaris
 *
1313 4f57fa8c Diego Biurrun
 * @param timestamp timestamp in the time base of the given stream
1314 3217cb42 Panagiotis Issaris
 */
1315 78cb7273 Diego Biurrun
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1316
                       int size, int distance, int flags);
1317 3217cb42 Panagiotis Issaris
1318
/**
1319 49bd8e4b Måns Rullgård
 * Perform a binary search using av_index_search_timestamp() and
1320 3673f4ab Aurelien Jacobs
 * AVInputFormat.read_timestamp().
1321 78cb7273 Diego Biurrun
 * This is not supposed to be called directly by a user application,
1322
 * but by demuxers.
1323 3217cb42 Panagiotis Issaris
 * @param target_ts target timestamp in the time base of the given stream
1324
 * @param stream_index stream number
1325
 */
1326 78cb7273 Diego Biurrun
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1327
                         int64_t target_ts, int flags);
1328 3217cb42 Panagiotis Issaris
1329
/**
1330 49bd8e4b Måns Rullgård
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1331 3217cb42 Panagiotis Issaris
 *
1332 4f57fa8c Diego Biurrun
 * Stream ref_st unchanged, others set cur_dts in their native time base.
1333
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1334 3217cb42 Panagiotis Issaris
 * @param timestamp new dts expressed in time_base of param ref_st
1335
 * @param ref_st reference stream giving time_base of param timestamp
1336
 */
1337 22ffac70 Reimar Döffinger
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1338 3217cb42 Panagiotis Issaris
1339
/**
1340 49bd8e4b Måns Rullgård
 * Perform a binary search using read_timestamp().
1341 78cb7273 Diego Biurrun
 * This is not supposed to be called directly by a user application,
1342
 * but by demuxers.
1343 3217cb42 Panagiotis Issaris
 * @param target_ts target timestamp in the time base of the given stream
1344
 * @param stream_index stream number
1345
 */
1346 78cb7273 Diego Biurrun
int64_t av_gen_search(AVFormatContext *s, int stream_index,
1347
                      int64_t target_ts, int64_t pos_min,
1348
                      int64_t pos_max, int64_t pos_limit,
1349
                      int64_t ts_min, int64_t ts_max,
1350
                      int flags, int64_t *ts_ret,
1351
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1352 b754978a Michael Niedermayer
1353 76c56376 Michael Niedermayer
/**
1354
 * media file output
1355
 */
1356 290c5fa6 Fabrice Bellard
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1357 3217cb42 Panagiotis Issaris
1358
/**
1359 f3bfe388 Måns Rullgård
 * Split a URL string into components.
1360
 *
1361
 * The pointers to buffers for storing individual components may be null,
1362
 * in order to ignore that component. Buffers for components not found are
1363
 * set to empty strings. If the port is not found, it is set to a negative
1364
 * value.
1365
 *
1366
 * @param proto the buffer for the protocol
1367
 * @param proto_size the size of the proto buffer
1368
 * @param authorization the buffer for the authorization
1369
 * @param authorization_size the size of the authorization buffer
1370
 * @param hostname the buffer for the host name
1371
 * @param hostname_size the size of the hostname buffer
1372
 * @param port_ptr a pointer to store the port number in
1373
 * @param path the buffer for the path
1374
 * @param path_size the size of the path buffer
1375
 * @param url the URL to split
1376
 */
1377
void av_url_split(char *proto,         int proto_size,
1378
                  char *authorization, int authorization_size,
1379
                  char *hostname,      int hostname_size,
1380
                  int *port_ptr,
1381
                  char *path,          int path_size,
1382
                  const char *url);
1383
1384
/**
1385 49bd8e4b Måns Rullgård
 * Allocate the stream private data and write the stream header to an
1386 755bfeab Diego Biurrun
 * output media file.
1387 438198e7 Reimar Döffinger
 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1388 12763671 Reimar Döffinger
 * but for some formats it might also be some other time base
1389 3217cb42 Panagiotis Issaris
 *
1390
 * @param s media file handle
1391 4f57fa8c Diego Biurrun
 * @return 0 if OK, AVERROR_xxx on error
1392 3217cb42 Panagiotis Issaris
 */
1393 b9a281db Fabrice Bellard
int av_write_header(AVFormatContext *s);
1394 3217cb42 Panagiotis Issaris
1395
/**
1396 49bd8e4b Måns Rullgård
 * Write a packet to an output media file.
1397 3217cb42 Panagiotis Issaris
 *
1398
 * The packet shall contain one audio or video frame.
1399 78cb7273 Diego Biurrun
 * The packet must be correctly interleaved according to the container
1400
 * specification, if not then av_interleaved_write_frame must be used.
1401 3217cb42 Panagiotis Issaris
 *
1402
 * @param s media file handle
1403 78cb7273 Diego Biurrun
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1404
              dts/pts, ...
1405 4f57fa8c Diego Biurrun
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1406 3217cb42 Panagiotis Issaris
 */
1407 e928649b Michael Niedermayer
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1408 3217cb42 Panagiotis Issaris
1409
/**
1410 49bd8e4b Måns Rullgård
 * Write a packet to an output media file ensuring correct interleaving.
1411 3217cb42 Panagiotis Issaris
 *
1412
 * The packet must contain one audio or video frame.
1413 22e77e44 Diego Biurrun
 * If the packets are already correctly interleaved, the application should
1414 90b5b51e Diego Biurrun
 * call av_write_frame() instead as it is slightly faster. It is also important
1415
 * to keep in mind that completely non-interleaved input will need huge amounts
1416
 * of memory to interleave with this, so it is preferable to interleave at the
1417
 * demuxer level.
1418 3217cb42 Panagiotis Issaris
 *
1419
 * @param s media file handle
1420 78cb7273 Diego Biurrun
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1421
              dts/pts, ...
1422 4f57fa8c Diego Biurrun
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1423 3217cb42 Panagiotis Issaris
 */
1424 3c895fc0 Michael Niedermayer
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1425 3217cb42 Panagiotis Issaris
1426
/**
1427 49bd8e4b Måns Rullgård
 * Interleave a packet per dts in an output media file.
1428 3217cb42 Panagiotis Issaris
 *
1429 78cb7273 Diego Biurrun
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1430 22e77e44 Diego Biurrun
 * function, so they cannot be used after it. Note that calling av_free_packet()
1431 78cb7273 Diego Biurrun
 * on them is still safe.
1432 3217cb42 Panagiotis Issaris
 *
1433
 * @param s media file handle
1434
 * @param out the interleaved packet will be output here
1435 9a58234f Diego Biurrun
 * @param pkt the input packet
1436 3217cb42 Panagiotis Issaris
 * @param flush 1 if no further packets are available as input and all
1437
 *              remaining packets should be output
1438
 * @return 1 if a packet was output, 0 if no packet could be output,
1439 d9526386 Diego Biurrun
 *         < 0 if an error occurred
1440 3217cb42 Panagiotis Issaris
 */
1441 78cb7273 Diego Biurrun
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1442
                                 AVPacket *pkt, int flush);
1443 e928649b Michael Niedermayer
1444 3217cb42 Panagiotis Issaris
/**
1445 49bd8e4b Måns Rullgård
 * Write the stream trailer to an output media file and free the
1446 2b75bde6 Stefano Sabatini
 * file private data.
1447 3217cb42 Panagiotis Issaris
 *
1448 dc76fe13 Reimar Döffinger
 * May only be called after a successful call to av_write_header.
1449
 *
1450 3217cb42 Panagiotis Issaris
 * @param s media file handle
1451 4f57fa8c Diego Biurrun
 * @return 0 if OK, AVERROR_xxx on error
1452 3217cb42 Panagiotis Issaris
 */
1453 b9a281db Fabrice Bellard
int av_write_trailer(AVFormatContext *s);
1454 de6d9b64 Fabrice Bellard
1455 0ebf4754 Anton Khirnov
#if FF_API_DUMP_FORMAT
1456
attribute_deprecated void dump_format(AVFormatContext *ic,
1457
                                      int index,
1458
                                      const char *url,
1459
                                      int is_output);
1460
#endif
1461
1462
void av_dump_format(AVFormatContext *ic,
1463
                    int index,
1464
                    const char *url,
1465
                    int is_output);
1466 3217cb42 Panagiotis Issaris
1467 d87a521c Aurelien Jacobs
#if FF_API_PARSE_FRAME_PARAM
1468 3217cb42 Panagiotis Issaris
/**
1469 49bd8e4b Måns Rullgård
 * Parse width and height out of string str.
1470 26ef3220 Stefano Sabatini
 * @deprecated Use av_parse_video_frame_size instead.
1471 3217cb42 Panagiotis Issaris
 */
1472 78cb7273 Diego Biurrun
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1473
                                          const char *str);
1474 3217cb42 Panagiotis Issaris
1475
/**
1476 49bd8e4b Måns Rullgård
 * Convert framerate from a string to a fraction.
1477 26ef3220 Stefano Sabatini
 * @deprecated Use av_parse_video_frame_rate instead.
1478 3217cb42 Panagiotis Issaris
 */
1479 78cb7273 Diego Biurrun
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1480
                                          const char *arg);
1481 1ca9133f Stefano Sabatini
#endif
1482 3217cb42 Panagiotis Issaris
1483 40c3fe2c Stefano Sabatini
#if FF_API_PARSE_DATE
1484 3217cb42 Panagiotis Issaris
/**
1485 49bd8e4b Måns Rullgård
 * Parse datestr and return a corresponding number of microseconds.
1486 40c3fe2c Stefano Sabatini
 *
1487 f9436161 Stefano Sabatini
 * @param datestr String representing a date or a duration.
1488 40c3fe2c Stefano Sabatini
 * See av_parse_time() for the syntax of the provided string.
1489
 * @deprecated in favor of av_parse_time()
1490 3217cb42 Panagiotis Issaris
 */
1491 40c3fe2c Stefano Sabatini
attribute_deprecated
1492 0c1a9eda Zdenek Kabelac
int64_t parse_date(const char *datestr, int duration);
1493 40c3fe2c Stefano Sabatini
#endif
1494 de6d9b64 Fabrice Bellard
1495 76c56376 Michael Niedermayer
/**
1496
 * Get the current time in microseconds.
1497
 */
1498 0c1a9eda Zdenek Kabelac
int64_t av_gettime(void);
1499 94988531 Fabrice Bellard
1500 4f57fa8c Diego Biurrun
/* ffm-specific for ffserver */
1501 de6d9b64 Fabrice Bellard
#define FFM_PACKET_SIZE 4096
1502 bc5c918e Diego Biurrun
int64_t ffm_read_write_index(int fd);
1503 6fcce4f9 Patrik Kullman
int ffm_write_write_index(int fd, int64_t pos);
1504 bc5c918e Diego Biurrun
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1505 de6d9b64 Fabrice Bellard
1506 1b98107c Anton Khirnov
#if FF_API_FIND_INFO_TAG
1507 3217cb42 Panagiotis Issaris
/**
1508 1b98107c Anton Khirnov
 * @deprecated use av_find_info_tag in libavutil instead.
1509 3217cb42 Panagiotis Issaris
 */
1510 1b98107c Anton Khirnov
attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1511
#endif
1512 de6d9b64 Fabrice Bellard
1513 3217cb42 Panagiotis Issaris
/**
1514 49bd8e4b Måns Rullgård
 * Return in 'buf' the path with '%d' replaced by a number.
1515 4f57fa8c Diego Biurrun
 *
1516 3217cb42 Panagiotis Issaris
 * Also handles the '%0nd' format where 'n' is the total number
1517
 * of digits and '%%'.
1518
 *
1519
 * @param buf destination buffer
1520
 * @param buf_size destination buffer size
1521
 * @param path numbered sequence string
1522 8ea0e802 Panagiotis Issaris
 * @param number frame number
1523 4f57fa8c Diego Biurrun
 * @return 0 if OK, -1 on format error
1524 3217cb42 Panagiotis Issaris
 */
1525 5c07cf53 Michel Bardiaux
int av_get_frame_filename(char *buf, int buf_size,
1526
                          const char *path, int number);
1527 3217cb42 Panagiotis Issaris
1528
/**
1529 49bd8e4b Måns Rullgård
 * Check whether filename actually is a numbered sequence generator.
1530 3217cb42 Panagiotis Issaris
 *
1531
 * @param filename possible numbered sequence string
1532 4f57fa8c Diego Biurrun
 * @return 1 if a valid numbered sequence string, 0 otherwise
1533 3217cb42 Panagiotis Issaris
 */
1534 5c07cf53 Michel Bardiaux
int av_filename_number_test(const char *filename);
1535 96baaa6a Fabrice Bellard
1536 c5388c07 Luca Abeni
/**
1537 49bd8e4b Måns Rullgård
 * Generate an SDP for an RTP session.
1538 c5388c07 Luca Abeni
 *
1539
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1540
 *           array is composed by only one context, such context can contain
1541
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1542
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1543 4f57fa8c Diego Biurrun
 *           must contain only one AVStream.
1544 8767b80f Luca Abeni
 * @param n_files number of AVCodecContexts contained in ac
1545
 * @param buff buffer where the SDP will be stored (must be allocated by
1546 4f57fa8c Diego Biurrun
 *             the caller)
1547 8767b80f Luca Abeni
 * @param size the size of the buffer
1548 4f57fa8c Diego Biurrun
 * @return 0 if OK, AVERROR_xxx on error
1549 c5388c07 Luca Abeni
 */
1550 8767b80f Luca Abeni
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1551 c5388c07 Luca Abeni
1552 1a70d127 Stefano Sabatini
/**
1553 49bd8e4b Måns Rullgård
 * Return a positive value if the given filename has one of the given
1554 1a70d127 Stefano Sabatini
 * extensions, 0 otherwise.
1555
 *
1556
 * @param extensions a comma-separated list of filename extensions
1557
 */
1558
int av_match_ext(const char *filename, const char *extensions);
1559
1560 98790382 Stefano Sabatini
#endif /* AVFORMAT_AVFORMAT_H */