Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 198ac67f

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