Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 9128ae08

History | View | Annotate | Download (56.6 KB)

1
/*
2
 * copyright (c) 2001 Fabrice Bellard
3
 *
4
 * This file is part of FFmpeg.
5
 *
6
 * FFmpeg is free software; you can redistribute it and/or
7
 * modify it under the terms of the GNU Lesser General Public
8
 * License as published by the Free Software Foundation; either
9
 * version 2.1 of the License, or (at your option) any later version.
10
 *
11
 * FFmpeg is distributed in the hope that it will be useful,
12
 * 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
 * License along with FFmpeg; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
 */
20

    
21
#ifndef AVFORMAT_AVFORMAT_H
22
#define AVFORMAT_AVFORMAT_H
23

    
24
#define LIBAVFORMAT_VERSION_MAJOR 52
25
#define LIBAVFORMAT_VERSION_MINOR 91
26
#define LIBAVFORMAT_VERSION_MICRO  0
27

    
28
#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
#define LIBAVFORMAT_BUILD       LIBAVFORMAT_VERSION_INT
35

    
36
#define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
37

    
38
/**
39
 * Those FF_API_* defines are not part of public API.
40
 * They may change, break or disappear at any time.
41
 */
42
#ifndef FF_API_MAX_STREAMS
43
#define FF_API_MAX_STREAMS             (LIBAVFORMAT_VERSION_MAJOR < 53)
44
#endif
45
#ifndef FF_API_OLD_METADATA
46
#define FF_API_OLD_METADATA            (LIBAVFORMAT_VERSION_MAJOR < 53)
47
#endif
48
#ifndef FF_API_URL_CLASS
49
#define FF_API_URL_CLASS               (LIBAVFORMAT_VERSION_MAJOR >= 53)
50
#endif
51
#ifndef FF_API_URL_RESETBUF
52
#define FF_API_URL_RESETBUF            (LIBAVFORMAT_VERSION_MAJOR < 53)
53
#endif
54
#ifndef FF_API_REGISTER_PROTOCOL
55
#define FF_API_REGISTER_PROTOCOL       (LIBAVFORMAT_VERSION_MAJOR < 53)
56
#endif
57
#ifndef FF_API_GUESS_FORMAT
58
#define FF_API_GUESS_FORMAT            (LIBAVFORMAT_VERSION_MAJOR < 53)
59
#endif
60
#ifndef FF_API_UDP_GET_FILE
61
#define FF_API_UDP_GET_FILE            (LIBAVFORMAT_VERSION_MAJOR < 53)
62
#endif
63
#ifndef FF_API_URL_SPLIT
64
#define FF_API_URL_SPLIT               (LIBAVFORMAT_VERSION_MAJOR < 53)
65
#endif
66
#ifndef FF_API_ALLOC_FORMAT_CONTEXT
67
#define FF_API_ALLOC_FORMAT_CONTEXT    (LIBAVFORMAT_VERSION_MAJOR < 53)
68
#endif
69
#ifndef FF_API_PARSE_FRAME_PARAM
70
#define FF_API_PARSE_FRAME_PARAM       (LIBAVFORMAT_VERSION_MAJOR < 53)
71
#endif
72
#ifndef FF_API_READ_SEEK
73
#define FF_API_READ_SEEK               (LIBAVFORMAT_VERSION_MAJOR < 54)
74
#endif
75
#ifndef FF_API_LAVF_UNUSED
76
#define FF_API_LAVF_UNUSED             (LIBAVFORMAT_VERSION_MAJOR < 53)
77
#endif
78
#ifndef FF_API_PARAMETERS_CODEC_ID
79
#define FF_API_PARAMETERS_CODEC_ID     (LIBAVFORMAT_VERSION_MAJOR < 53)
80
#endif
81
#ifndef FF_API_FIRST_FORMAT
82
#define FF_API_FIRST_FORMAT            (LIBAVFORMAT_VERSION_MAJOR < 53)
83
#endif
84
#ifndef FF_API_SYMVER
85
#define FF_API_SYMVER                  (LIBAVFORMAT_VERSION_MAJOR < 53)
86
#endif
87

    
88
/**
89
 * I return the LIBAVFORMAT_VERSION_INT constant.  You got
90
 * a fucking problem with that, douchebag?
91
 */
92
unsigned avformat_version(void);
93

    
94
/**
95
 * Return the libavformat build-time configuration.
96
 */
97
const char *avformat_configuration(void);
98

    
99
/**
100
 * Return the libavformat license.
101
 */
102
const char *avformat_license(void);
103

    
104
#include <time.h>
105
#include <stdio.h>  /* FILE */
106
#include "libavcodec/avcodec.h"
107

    
108
#include "avio.h"
109

    
110
struct AVFormatContext;
111

    
112

    
113
/*
114
 * Public Metadata API.
115
 * The metadata API allows libavformat to export metadata tags to a client
116
 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
117
 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
118
 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
119
 * Important concepts to keep in mind:
120
 * 1. Keys are unique; there can never be 2 tags with the same key. This is
121
 *    also meant semantically, i.e., a demuxer should not knowingly produce
122
 *    several keys that are literally different but semantically identical.
123
 *    E.g., key=Author5, key=Author6. In this example, all authors must be
124
 *    placed in the same tag.
125
 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
126
 *    want to store, e.g., the email address of the child of producer Alice
127
 *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
128
 * 3. Several modifiers can be applied to the tag name. This is done by
129
 *    appending a dash character ('-') and the modifier name in the order
130
 *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
131
 *    a) language -- a tag whose value is localized for a particular language
132
 *       is appended with the ISO 639-2/B 3-letter language code.
133
 *       For example: Author-ger=Michael, Author-eng=Mike
134
 *       The original/default language is in the unqualified "Author" tag.
135
 *       A demuxer should set a default if it sets any translated tag.
136
 *    b) sorting  -- a modified version of a tag that should be used for
137
 *       sorting will have '-sort' appended. E.g. artist="The Beatles",
138
 *       artist-sort="Beatles, The".
139
 *
140
 * 4. Demuxers attempt to export metadata in a generic format, however tags
141
 *    with no generic equivalents are left as they are stored in the container.
142
 *    Follows a list of generic tag names:
143
 *
144
 * album        -- name of the set this work belongs to
145
 * album_artist -- main creator of the set/album, if different from artist.
146
 *                 e.g. "Various Artists" for compilation albums.
147
 * artist       -- main creator of the work
148
 * comment      -- any additional description of the file.
149
 * composer     -- who composed the work, if different from artist.
150
 * copyright    -- name of copyright holder.
151
 * creation_time-- date when the file was created, preferably in ISO 8601.
152
 * date         -- date when the work was created, preferably in ISO 8601.
153
 * disc         -- number of a subset, e.g. disc in a multi-disc collection.
154
 * encoder      -- name/settings of the software/hardware that produced the file.
155
 * encoded_by   -- person/group who created the file.
156
 * filename     -- original name of the file.
157
 * genre        -- <self-evident>.
158
 * language     -- main language in which the work is performed, preferably
159
 *                 in ISO 639-2 format.
160
 * performer    -- artist who performed the work, if different from artist.
161
 *                 E.g for "Also sprach Zarathustra", artist would be "Richard
162
 *                 Strauss" and performer "London Philharmonic Orchestra".
163
 * publisher    -- name of the label/publisher.
164
 * title        -- name of the work.
165
 * track        -- number of this work in the set, can be in form current/total.
166
 */
167

    
168
#define AV_METADATA_MATCH_CASE      1
169
#define AV_METADATA_IGNORE_SUFFIX   2
170
#define AV_METADATA_DONT_STRDUP_KEY 4
171
#define AV_METADATA_DONT_STRDUP_VAL 8
172
#define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
173

    
174
typedef struct {
175
    char *key;
176
    char *value;
177
}AVMetadataTag;
178

    
179
typedef struct AVMetadata AVMetadata;
180
#if FF_API_OLD_METADATA
181
typedef struct AVMetadataConv AVMetadataConv;
182
#endif
183

    
184
/**
185
 * Get a metadata element with matching key.
186
 *
187
 * @param prev Set to the previous matching element to find the next.
188
 *             If set to NULL the first matching element is returned.
189
 * @param flags Allows case as well as suffix-insensitive comparisons.
190
 * @return Found tag or NULL, changing key or value leads to undefined behavior.
191
 */
192
AVMetadataTag *
193
av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
194

    
195
#if FF_API_OLD_METADATA
196
/**
197
 * Set the given tag in *pm, overwriting an existing tag.
198
 *
199
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
200
 * a metadata struct is allocated and put in *pm.
201
 * @param key tag key to add to *pm (will be av_strduped)
202
 * @param value tag value to add to *pm (will be av_strduped)
203
 * @return >= 0 on success otherwise an error code <0
204
 * @deprecated Use av_metadata_set2() instead.
205
 */
206
attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
207
#endif
208

    
209
/**
210
 * Set the given tag in *pm, overwriting an existing tag.
211
 *
212
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
213
 * a metadata struct is allocated and put in *pm.
214
 * @param key tag key to add to *pm (will be av_strduped depending on flags)
215
 * @param value tag value to add to *pm (will be av_strduped depending on flags).
216
 *        Passing a NULL value will cause an existing tag to be deleted.
217
 * @return >= 0 on success otherwise an error code <0
218
 */
219
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
220

    
221
#if FF_API_OLD_METADATA
222
/**
223
 * This function is provided for compatibility reason and currently does nothing.
224
 */
225
attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
226
                                                                        const AVMetadataConv *s_conv);
227
#endif
228

    
229
/**
230
 * Free all the memory allocated for an AVMetadata struct.
231
 */
232
void av_metadata_free(AVMetadata **m);
233

    
234

    
235
/* packet functions */
236

    
237

    
238
/**
239
 * Allocate and read the payload of a packet and initialize its
240
 * fields with default values.
241
 *
242
 * @param pkt packet
243
 * @param size desired payload size
244
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
245
 */
246
int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
247

    
248

    
249
/**
250
 * Read data and append it to the current content of the AVPacket.
251
 * If pkt->size is 0 this is identical to av_get_packet.
252
 * Note that this uses av_grow_packet and thus involves a realloc
253
 * which is inefficient. Thus this function should only be used
254
 * when there is no reasonable way to know (an upper bound of)
255
 * the final size.
256
 *
257
 * @param pkt packet
258
 * @param size amount of data to read
259
 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
260
 *         will not be lost even if an error occurs.
261
 */
262
int av_append_packet(ByteIOContext *s, AVPacket *pkt, int size);
263

    
264
/*************************************************/
265
/* fractional numbers for exact pts handling */
266

    
267
/**
268
 * The exact value of the fractional number is: 'val + num / den'.
269
 * num is assumed to be 0 <= num < den.
270
 */
271
typedef struct AVFrac {
272
    int64_t val, num, den;
273
} AVFrac;
274

    
275
/*************************************************/
276
/* input/output formats */
277

    
278
struct AVCodecTag;
279

    
280
/**
281
 * This structure contains the data a format has to probe a file.
282
 */
283
typedef struct AVProbeData {
284
    const char *filename;
285
    unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
286
    int buf_size;       /**< Size of buf except extra allocated bytes */
287
} AVProbeData;
288

    
289
#define AVPROBE_SCORE_MAX 100               ///< maximum score, half of that is used for file-extension-based detection
290
#define AVPROBE_PADDING_SIZE 32             ///< extra allocated bytes at the end of the probe buffer
291

    
292
typedef struct AVFormatParameters {
293
    AVRational time_base;
294
    int sample_rate;
295
    int channels;
296
    int width;
297
    int height;
298
    enum PixelFormat pix_fmt;
299
    int channel; /**< Used to select DV channel. */
300
    const char *standard; /**< TV standard, NTSC, PAL, SECAM */
301
    unsigned int mpeg2ts_raw:1;  /**< Force raw MPEG-2 transport stream output, if possible. */
302
    unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
303
                                            stream packet (only meaningful if
304
                                            mpeg2ts_raw is TRUE). */
305
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
306
                                            immediately (RTSP only). */
307
    unsigned int prealloced_context:1;
308
#if FF_API_PARAMETERS_CODEC_ID
309
    attribute_deprecated enum CodecID video_codec_id;
310
    attribute_deprecated enum CodecID audio_codec_id;
311
#endif
312
} AVFormatParameters;
313

    
314
//! Demuxer will use url_fopen, no opened file should be provided by the caller.
315
#define AVFMT_NOFILE        0x0001
316
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
317
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
318
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
319
                                      raw picture data. */
320
#define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
321
#define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
322
#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
323
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
324
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
325
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
326
#define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
327

    
328
typedef struct AVOutputFormat {
329
    const char *name;
330
    /**
331
     * Descriptive name for the format, meant to be more human-readable
332
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
333
     * to define it.
334
     */
335
    const char *long_name;
336
    const char *mime_type;
337
    const char *extensions; /**< comma-separated filename extensions */
338
    /**
339
     * size of private data so that it can be allocated in the wrapper
340
     */
341
    int priv_data_size;
342
    /* output support */
343
    enum CodecID audio_codec; /**< default audio codec */
344
    enum CodecID video_codec; /**< default video codec */
345
    int (*write_header)(struct AVFormatContext *);
346
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
347
    int (*write_trailer)(struct AVFormatContext *);
348
    /**
349
     * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER
350
     */
351
    int flags;
352
    /**
353
     * Currently only used to set pixel format if not YUV420P.
354
     */
355
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
356
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
357
                             AVPacket *in, int flush);
358

    
359
    /**
360
     * List of supported codec_id-codec_tag pairs, ordered by "better
361
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
362
     */
363
    const struct AVCodecTag * const *codec_tag;
364

    
365
    enum CodecID subtitle_codec; /**< default subtitle codec */
366

    
367
#if FF_API_OLD_METADATA
368
    const AVMetadataConv *metadata_conv;
369
#endif
370

    
371
    /* private fields */
372
    struct AVOutputFormat *next;
373
} AVOutputFormat;
374

    
375
typedef struct AVInputFormat {
376
    /**
377
     * A comma separated list of short names for the format. New names
378
     * may be appended with a minor bump.
379
     */
380
    const char *name;
381

    
382
    /**
383
     * Descriptive name for the format, meant to be more human-readable
384
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
385
     * to define it.
386
     */
387
    const char *long_name;
388

    
389
    /**
390
     * Size of private data so that it can be allocated in the wrapper.
391
     */
392
    int priv_data_size;
393

    
394
    /**
395
     * Tell if a given file has a chance of being parsed as this format.
396
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
397
     * big so you do not have to check for that unless you need more.
398
     */
399
    int (*read_probe)(AVProbeData *);
400

    
401
    /**
402
     * Read the format header and initialize the AVFormatContext
403
     * structure. Return 0 if OK. 'ap' if non-NULL contains
404
     * additional parameters. Only used in raw format right
405
     * now. 'av_new_stream' should be called to create new streams.
406
     */
407
    int (*read_header)(struct AVFormatContext *,
408
                       AVFormatParameters *ap);
409

    
410
    /**
411
     * Read one packet and put it in 'pkt'. pts and flags are also
412
     * set. 'av_new_stream' can be called only if the flag
413
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
414
     * background thread).
415
     * @return 0 on success, < 0 on error.
416
     *         When returning an error, pkt must not have been allocated
417
     *         or must be freed before returning
418
     */
419
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
420

    
421
    /**
422
     * Close the stream. The AVFormatContext and AVStreams are not
423
     * freed by this function
424
     */
425
    int (*read_close)(struct AVFormatContext *);
426

    
427
#if FF_API_READ_SEEK
428
    /**
429
     * Seek to a given timestamp relative to the frames in
430
     * stream component stream_index.
431
     * @param stream_index Must not be -1.
432
     * @param flags Selects which direction should be preferred if no exact
433
     *              match is available.
434
     * @return >= 0 on success (but not necessarily the new offset)
435
     */
436
    attribute_deprecated int (*read_seek)(struct AVFormatContext *,
437
                                          int stream_index, int64_t timestamp, int flags);
438
#endif
439
    /**
440
     * Gets the next timestamp in stream[stream_index].time_base units.
441
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
442
     */
443
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
444
                              int64_t *pos, int64_t pos_limit);
445

    
446
    /**
447
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
448
     */
449
    int flags;
450

    
451
    /**
452
     * If extensions are defined, then no probe is done. You should
453
     * usually not use extension format guessing because it is not
454
     * reliable enough
455
     */
456
    const char *extensions;
457

    
458
    /**
459
     * General purpose read-only value that the format can use.
460
     */
461
    int value;
462

    
463
    /**
464
     * Start/resume playing - only meaningful if using a network-based format
465
     * (RTSP).
466
     */
467
    int (*read_play)(struct AVFormatContext *);
468

    
469
    /**
470
     * Pause playing - only meaningful if using a network-based format
471
     * (RTSP).
472
     */
473
    int (*read_pause)(struct AVFormatContext *);
474

    
475
    const struct AVCodecTag * const *codec_tag;
476

    
477
    /**
478
     * Seek to timestamp ts.
479
     * Seeking will be done so that the point from which all active streams
480
     * can be presented successfully will be closest to ts and within min/max_ts.
481
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
482
     */
483
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
484

    
485
#if FF_API_OLD_METADATA
486
    const AVMetadataConv *metadata_conv;
487
#endif
488

    
489
    /* private fields */
490
    struct AVInputFormat *next;
491
} AVInputFormat;
492

    
493
enum AVStreamParseType {
494
    AVSTREAM_PARSE_NONE,
495
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
496
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
497
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
498
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
499
};
500

    
501
typedef struct AVIndexEntry {
502
    int64_t pos;
503
    int64_t timestamp;
504
#define AVINDEX_KEYFRAME 0x0001
505
    int flags:2;
506
    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).
507
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
508
} AVIndexEntry;
509

    
510
#define AV_DISPOSITION_DEFAULT   0x0001
511
#define AV_DISPOSITION_DUB       0x0002
512
#define AV_DISPOSITION_ORIGINAL  0x0004
513
#define AV_DISPOSITION_COMMENT   0x0008
514
#define AV_DISPOSITION_LYRICS    0x0010
515
#define AV_DISPOSITION_KARAOKE   0x0020
516

    
517
/**
518
 * Track should be used during playback by default.
519
 * Useful for subtitle track that should be displayed
520
 * even when user did not explicitly ask for subtitles.
521
 */
522
#define AV_DISPOSITION_FORCED    0x0040
523

    
524
/**
525
 * Stream structure.
526
 * New fields can be added to the end with minor version bumps.
527
 * Removal, reordering and changes to existing fields require a major
528
 * version bump.
529
 * sizeof(AVStream) must not be used outside libav*.
530
 */
531
typedef struct AVStream {
532
    int index;    /**< stream index in AVFormatContext */
533
    int id;       /**< format-specific stream ID */
534
    AVCodecContext *codec; /**< codec context */
535
    /**
536
     * Real base framerate of the stream.
537
     * This is the lowest framerate with which all timestamps can be
538
     * represented accurately (it is the least common multiple of all
539
     * framerates in the stream). Note, this value is just a guess!
540
     * For example, if the time base is 1/90000 and all frames have either
541
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
542
     */
543
    AVRational r_frame_rate;
544
    void *priv_data;
545

    
546
    /* internal data used in av_find_stream_info() */
547
    int64_t first_dts;
548

    
549
    /**
550
     * encoding: pts generation when outputting stream
551
     */
552
    struct AVFrac pts;
553

    
554
    /**
555
     * This is the fundamental unit of time (in seconds) in terms
556
     * of which frame timestamps are represented. For fixed-fps content,
557
     * time base should be 1/framerate and timestamp increments should be 1.
558
     */
559
    AVRational time_base;
560
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
561
    /* ffmpeg.c private use */
562
    int stream_copy; /**< If set, just copy stream. */
563
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
564

    
565
    //FIXME move stuff to a flags field?
566
    /**
567
     * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
568
     * MN: dunno if that is the right place for it
569
     */
570
    float quality;
571

    
572
    /**
573
     * Decoding: pts of the first frame of the stream, in stream time base.
574
     * Only set this if you are absolutely 100% sure that the value you set
575
     * it to really is the pts of the first frame.
576
     * This may be undefined (AV_NOPTS_VALUE).
577
     * @note The ASF header does NOT contain a correct start_time the ASF
578
     * demuxer must NOT set this.
579
     */
580
    int64_t start_time;
581

    
582
    /**
583
     * Decoding: duration of the stream, in stream time base.
584
     * If a source file does not specify a duration, but does specify
585
     * a bitrate, this value will be estimated from bitrate and file size.
586
     */
587
    int64_t duration;
588

    
589
#if FF_API_OLD_METADATA
590
    attribute_deprecated char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
591
#endif
592

    
593
    /* av_read_frame() support */
594
    enum AVStreamParseType need_parsing;
595
    struct AVCodecParserContext *parser;
596

    
597
    int64_t cur_dts;
598
    int last_IP_duration;
599
    int64_t last_IP_pts;
600
    /* av_seek_frame() support */
601
    AVIndexEntry *index_entries; /**< Only used if the format does not
602
                                    support seeking natively. */
603
    int nb_index_entries;
604
    unsigned int index_entries_allocated_size;
605

    
606
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
607

    
608
#if FF_API_LAVF_UNUSED
609
    attribute_deprecated int64_t unused[4+1];
610
#endif
611

    
612
#if FF_API_OLD_METADATA
613
    attribute_deprecated char *filename; /**< source filename of the stream */
614
#endif
615

    
616
    int disposition; /**< AV_DISPOSITION_* bit field */
617

    
618
    AVProbeData probe_data;
619
#define MAX_REORDER_DELAY 16
620
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
621

    
622
    /**
623
     * sample aspect ratio (0 if unknown)
624
     * - encoding: Set by user.
625
     * - decoding: Set by libavformat.
626
     */
627
    AVRational sample_aspect_ratio;
628

    
629
    AVMetadata *metadata;
630

    
631
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
632
    /* external applications; try to use something else if at all possible.    */
633
    const uint8_t *cur_ptr;
634
    int cur_len;
635
    AVPacket cur_pkt;
636

    
637
    // Timestamp generation support:
638
    /**
639
     * Timestamp corresponding to the last dts sync point.
640
     *
641
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
642
     * a DTS is received from the underlying container. Otherwise set to
643
     * AV_NOPTS_VALUE by default.
644
     */
645
    int64_t reference_dts;
646

    
647
    /**
648
     * Number of packets to buffer for codec probing
649
     * NOT PART OF PUBLIC API
650
     */
651
#define MAX_PROBE_PACKETS 2500
652
    int probe_packets;
653

    
654
    /**
655
     * last packet in packet_buffer for this stream when muxing.
656
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
657
     */
658
    struct AVPacketList *last_in_packet_buffer;
659

    
660
    /**
661
     * Average framerate
662
     */
663
    AVRational avg_frame_rate;
664

    
665
    /**
666
     * Number of frames that have been demuxed during av_find_stream_info()
667
     */
668
    int codec_info_nb_frames;
669

    
670
    /**
671
     * Stream informations used internally by av_find_stream_info()
672
     */
673
#define MAX_STD_TIMEBASES (60*12+5)
674
    struct {
675
        int64_t last_dts;
676
        int64_t duration_gcd;
677
        int duration_count;
678
        double duration_error[MAX_STD_TIMEBASES];
679
        int64_t codec_info_duration;
680
    } *info;
681
} AVStream;
682

    
683
#define AV_PROGRAM_RUNNING 1
684

    
685
/**
686
 * New fields can be added to the end with minor version bumps.
687
 * Removal, reordering and changes to existing fields require a major
688
 * version bump.
689
 * sizeof(AVProgram) must not be used outside libav*.
690
 */
691
typedef struct AVProgram {
692
    int            id;
693
#if FF_API_OLD_METADATA
694
    attribute_deprecated char           *provider_name; ///< network name for DVB streams
695
    attribute_deprecated char           *name;          ///< service name for DVB streams
696
#endif
697
    int            flags;
698
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
699
    unsigned int   *stream_index;
700
    unsigned int   nb_stream_indexes;
701
    AVMetadata *metadata;
702
} AVProgram;
703

    
704
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
705
                                         (streams are added dynamically) */
706

    
707
typedef struct AVChapter {
708
    int id;                 ///< unique ID to identify the chapter
709
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
710
    int64_t start, end;     ///< chapter start/end time in time_base units
711
#if FF_API_OLD_METADATA
712
    attribute_deprecated char *title;            ///< chapter title
713
#endif
714
    AVMetadata *metadata;
715
} AVChapter;
716

    
717
#if FF_API_MAX_STREAMS
718
#define MAX_STREAMS 20
719
#endif
720

    
721
/**
722
 * Format I/O context.
723
 * New fields can be added to the end with minor version bumps.
724
 * Removal, reordering and changes to existing fields require a major
725
 * version bump.
726
 * sizeof(AVFormatContext) must not be used outside libav*.
727
 */
728
typedef struct AVFormatContext {
729
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
730
    /* Can only be iformat or oformat, not both at the same time. */
731
    struct AVInputFormat *iformat;
732
    struct AVOutputFormat *oformat;
733
    void *priv_data;
734
    ByteIOContext *pb;
735
    unsigned int nb_streams;
736
#if FF_API_MAX_STREAMS
737
    AVStream *streams[MAX_STREAMS];
738
#else
739
    AVStream **streams;
740
#endif
741
    char filename[1024]; /**< input or output filename */
742
    /* stream info */
743
    int64_t timestamp;
744
#if FF_API_OLD_METADATA
745
    attribute_deprecated char title[512];
746
    attribute_deprecated char author[512];
747
    attribute_deprecated char copyright[512];
748
    attribute_deprecated char comment[512];
749
    attribute_deprecated char album[512];
750
    attribute_deprecated int year;  /**< ID3 year, 0 if none */
751
    attribute_deprecated int track; /**< track number, 0 if none */
752
    attribute_deprecated char genre[32]; /**< ID3 genre */
753
#endif
754

    
755
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
756
    /* private data for pts handling (do not modify directly). */
757
    /**
758
     * This buffer is only needed when packets were already buffered but
759
     * not decoded, for example to get the codec parameters in MPEG
760
     * streams.
761
     */
762
    struct AVPacketList *packet_buffer;
763

    
764
    /**
765
     * Decoding: position of the first frame of the component, in
766
     * AV_TIME_BASE fractional seconds. NEVER set this value directly:
767
     * It is deduced from the AVStream values.
768
     */
769
    int64_t start_time;
770

    
771
    /**
772
     * Decoding: duration of the stream, in AV_TIME_BASE fractional
773
     * seconds. Only set this value if you know none of the individual stream
774
     * durations and also dont set any of them. This is deduced from the
775
     * AVStream values if not set.
776
     */
777
    int64_t duration;
778

    
779
    /**
780
     * decoding: total file size, 0 if unknown
781
     */
782
    int64_t file_size;
783

    
784
    /**
785
     * Decoding: total stream bitrate in bit/s, 0 if not
786
     * available. Never set it directly if the file_size and the
787
     * duration are known as FFmpeg can compute it automatically.
788
     */
789
    int bit_rate;
790

    
791
    /* av_read_frame() support */
792
    AVStream *cur_st;
793
#if FF_API_LAVF_UNUSED
794
    const uint8_t *cur_ptr_deprecated;
795
    int cur_len_deprecated;
796
    AVPacket cur_pkt_deprecated;
797
#endif
798

    
799
    /* av_seek_frame() support */
800
    int64_t data_offset; /**< offset of the first packet */
801
    int index_built;
802

    
803
    int mux_rate;
804
    unsigned int packet_size;
805
    int preload;
806
    int max_delay;
807

    
808
#define AVFMT_NOOUTPUTLOOP -1
809
#define AVFMT_INFINITEOUTPUTLOOP 0
810
    /**
811
     * number of times to loop output in formats that support it
812
     */
813
    int loop_output;
814

    
815
    int flags;
816
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
817
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
818
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
819
#define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
820
#define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
821
#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
822
#define AVFMT_FLAG_RTP_HINT     0x0040 ///< Add RTP hinting to the output file
823

    
824
    int loop_input;
825

    
826
    /**
827
     * decoding: size of data to probe; encoding: unused.
828
     */
829
    unsigned int probesize;
830

    
831
    /**
832
     * Maximum time (in AV_TIME_BASE units) during which the input should
833
     * be analyzed in av_find_stream_info().
834
     */
835
    int max_analyze_duration;
836

    
837
    const uint8_t *key;
838
    int keylen;
839

    
840
    unsigned int nb_programs;
841
    AVProgram **programs;
842

    
843
    /**
844
     * Forced video codec_id.
845
     * Demuxing: Set by user.
846
     */
847
    enum CodecID video_codec_id;
848

    
849
    /**
850
     * Forced audio codec_id.
851
     * Demuxing: Set by user.
852
     */
853
    enum CodecID audio_codec_id;
854

    
855
    /**
856
     * Forced subtitle codec_id.
857
     * Demuxing: Set by user.
858
     */
859
    enum CodecID subtitle_codec_id;
860

    
861
    /**
862
     * Maximum amount of memory in bytes to use for the index of each stream.
863
     * If the index exceeds this size, entries will be discarded as
864
     * needed to maintain a smaller size. This can lead to slower or less
865
     * accurate seeking (depends on demuxer).
866
     * Demuxers for which a full in-memory index is mandatory will ignore
867
     * this.
868
     * muxing  : unused
869
     * demuxing: set by user
870
     */
871
    unsigned int max_index_size;
872

    
873
    /**
874
     * Maximum amount of memory in bytes to use for buffering frames
875
     * obtained from realtime capture devices.
876
     */
877
    unsigned int max_picture_buffer;
878

    
879
    unsigned int nb_chapters;
880
    AVChapter **chapters;
881

    
882
    /**
883
     * Flags to enable debugging.
884
     */
885
    int debug;
886
#define FF_FDEBUG_TS        0x0001
887

    
888
    /**
889
     * Raw packets from the demuxer, prior to parsing and decoding.
890
     * This buffer is used for buffering packets until the codec can
891
     * be identified, as parsing cannot be done without knowing the
892
     * codec.
893
     */
894
    struct AVPacketList *raw_packet_buffer;
895
    struct AVPacketList *raw_packet_buffer_end;
896

    
897
    struct AVPacketList *packet_buffer_end;
898

    
899
    AVMetadata *metadata;
900

    
901
    /**
902
     * Remaining size available for raw_packet_buffer, in bytes.
903
     * NOT PART OF PUBLIC API
904
     */
905
#define RAW_PACKET_BUFFER_SIZE 2500000
906
    int raw_packet_buffer_remaining_size;
907

    
908
    /**
909
     * Start time of the stream in real world time, in microseconds
910
     * since the unix epoch (00:00 1st January 1970). That is, pts=0
911
     * in the stream was captured at this real world time.
912
     * - encoding: Set by user.
913
     * - decoding: Unused.
914
     */
915
    int64_t start_time_realtime;
916
} AVFormatContext;
917

    
918
typedef struct AVPacketList {
919
    AVPacket pkt;
920
    struct AVPacketList *next;
921
} AVPacketList;
922

    
923
#if FF_API_FIRST_FORMAT
924
attribute_deprecated extern AVInputFormat *first_iformat;
925
attribute_deprecated extern AVOutputFormat *first_oformat;
926
#endif
927

    
928
/**
929
 * If f is NULL, returns the first registered input format,
930
 * if f is non-NULL, returns the next registered input format after f
931
 * or NULL if f is the last one.
932
 */
933
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
934

    
935
/**
936
 * If f is NULL, returns the first registered output format,
937
 * if f is non-NULL, returns the next registered output format after f
938
 * or NULL if f is the last one.
939
 */
940
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
941

    
942
enum CodecID av_guess_image2_codec(const char *filename);
943

    
944
/* XXX: Use automatic init with either ELF sections or C file parser */
945
/* modules. */
946

    
947
/* utils.c */
948
void av_register_input_format(AVInputFormat *format);
949
void av_register_output_format(AVOutputFormat *format);
950
#if FF_API_GUESS_FORMAT
951
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
952
                                    const char *filename,
953
                                    const char *mime_type);
954

    
955
/**
956
 * @deprecated Use av_guess_format() instead.
957
 */
958
attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
959
                                                  const char *filename,
960
                                                  const char *mime_type);
961
#endif
962

    
963
/**
964
 * Return the output format in the list of registered output formats
965
 * which best matches the provided parameters, or return NULL if
966
 * there is no match.
967
 *
968
 * @param short_name if non-NULL checks if short_name matches with the
969
 * names of the registered formats
970
 * @param filename if non-NULL checks if filename terminates with the
971
 * extensions of the registered formats
972
 * @param mime_type if non-NULL checks if mime_type matches with the
973
 * MIME type of the registered formats
974
 */
975
AVOutputFormat *av_guess_format(const char *short_name,
976
                                const char *filename,
977
                                const char *mime_type);
978

    
979
/**
980
 * Guess the codec ID based upon muxer and filename.
981
 */
982
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
983
                            const char *filename, const char *mime_type,
984
                            enum AVMediaType type);
985

    
986
/**
987
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
988
 *
989
 * @param f The file stream pointer where the dump should be sent to.
990
 * @param buf buffer
991
 * @param size buffer size
992
 *
993
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
994
 */
995
void av_hex_dump(FILE *f, uint8_t *buf, int size);
996

    
997
/**
998
 * Send a nice hexadecimal dump of a buffer to the log.
999
 *
1000
 * @param avcl A pointer to an arbitrary struct of which the first field is a
1001
 * pointer to an AVClass struct.
1002
 * @param level The importance level of the message, lower values signifying
1003
 * higher importance.
1004
 * @param buf buffer
1005
 * @param size buffer size
1006
 *
1007
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
1008
 */
1009
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
1010

    
1011
/**
1012
 * Send a nice dump of a packet to the specified file stream.
1013
 *
1014
 * @param f The file stream pointer where the dump should be sent to.
1015
 * @param pkt packet to dump
1016
 * @param dump_payload True if the payload must be displayed, too.
1017
 */
1018
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
1019

    
1020
/**
1021
 * Send a nice dump of a packet to the log.
1022
 *
1023
 * @param avcl A pointer to an arbitrary struct of which the first field is a
1024
 * pointer to an AVClass struct.
1025
 * @param level The importance level of the message, lower values signifying
1026
 * higher importance.
1027
 * @param pkt packet to dump
1028
 * @param dump_payload True if the payload must be displayed, too.
1029
 */
1030
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
1031

    
1032
/**
1033
 * Initialize libavformat and register all the muxers, demuxers and
1034
 * protocols. If you do not call this function, then you can select
1035
 * exactly which formats you want to support.
1036
 *
1037
 * @see av_register_input_format()
1038
 * @see av_register_output_format()
1039
 * @see av_register_protocol()
1040
 */
1041
void av_register_all(void);
1042

    
1043
/**
1044
 * Get the CodecID for the given codec tag tag.
1045
 * If no codec id is found returns CODEC_ID_NONE.
1046
 *
1047
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1048
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1049
 */
1050
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1051

    
1052
/**
1053
 * Get the codec tag for the given codec id id.
1054
 * If no codec tag is found returns 0.
1055
 *
1056
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1057
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1058
 */
1059
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1060

    
1061
/* media file input */
1062

    
1063
/**
1064
 * Find AVInputFormat based on the short name of the input format.
1065
 */
1066
AVInputFormat *av_find_input_format(const char *short_name);
1067

    
1068
/**
1069
 * Guess the file format.
1070
 *
1071
 * @param is_opened Whether the file is already opened; determines whether
1072
 *                  demuxers with or without AVFMT_NOFILE are probed.
1073
 */
1074
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1075

    
1076
/**
1077
 * Guess the file format.
1078
 *
1079
 * @param is_opened Whether the file is already opened; determines whether
1080
 *                  demuxers with or without AVFMT_NOFILE are probed.
1081
 * @param score_max A probe score larger that this is required to accept a
1082
 *                  detection, the variable is set to the actual detection
1083
 *                  score afterwards.
1084
 *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1085
 *                  to retry with a larger probe buffer.
1086
 */
1087
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1088

    
1089
/**
1090
 * Allocate all the structures needed to read an input stream.
1091
 *        This does not open the needed codecs for decoding the stream[s].
1092
 */
1093
int av_open_input_stream(AVFormatContext **ic_ptr,
1094
                         ByteIOContext *pb, const char *filename,
1095
                         AVInputFormat *fmt, AVFormatParameters *ap);
1096

    
1097
/**
1098
 * Open a media file as input. The codecs are not opened. Only the file
1099
 * header (if present) is read.
1100
 *
1101
 * @param ic_ptr The opened media file handle is put here.
1102
 * @param filename filename to open
1103
 * @param fmt If non-NULL, force the file format to use.
1104
 * @param buf_size optional buffer size (zero if default is OK)
1105
 * @param ap Additional parameters needed when opening the file
1106
 *           (NULL if default).
1107
 * @return 0 if OK, AVERROR_xxx otherwise
1108
 */
1109
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1110
                       AVInputFormat *fmt,
1111
                       int buf_size,
1112
                       AVFormatParameters *ap);
1113

    
1114
#if FF_API_ALLOC_FORMAT_CONTEXT
1115
/**
1116
 * @deprecated Use avformat_alloc_context() instead.
1117
 */
1118
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1119
#endif
1120

    
1121
/**
1122
 * Allocate an AVFormatContext.
1123
 * Can be freed with av_free() but do not forget to free everything you
1124
 * explicitly allocated as well!
1125
 */
1126
AVFormatContext *avformat_alloc_context(void);
1127

    
1128
/**
1129
 * Read packets of a media file to get stream information. This
1130
 * is useful for file formats with no headers such as MPEG. This
1131
 * function also computes the real framerate in case of MPEG-2 repeat
1132
 * frame mode.
1133
 * The logical file position is not changed by this function;
1134
 * examined packets may be buffered for later processing.
1135
 *
1136
 * @param ic media file handle
1137
 * @return >=0 if OK, AVERROR_xxx on error
1138
 * @todo Let the user decide somehow what information is needed so that
1139
 *       we do not waste time getting stuff the user does not need.
1140
 */
1141
int av_find_stream_info(AVFormatContext *ic);
1142

    
1143
/**
1144
 * Find the "best" stream in the file.
1145
 * The best stream is determined according to various heuristics as the most
1146
 * likely to be what the user expects.
1147
 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1148
 * default decoder for the stream's codec; streams for which no decoder can
1149
 * be found are ignored.
1150
 *
1151
 * @param ic                media file handle
1152
 * @param type              stream type: video, audio, subtitles, etc.
1153
 * @param wanted_stream_nb  user-requested stream number,
1154
 *                          or -1 for automatic selection
1155
 * @param related_stream    try to find a stream related (eg. in the same
1156
 *                          program) to this one, or -1 if none
1157
 * @param decoder_ret       if non-NULL, returns the decoder for the
1158
 *                          selected stream
1159
 * @param flags             flags; none are currently defined
1160
 * @return  the non-negative stream number in case of success,
1161
 *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1162
 *          could be found,
1163
 *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1164
 * @note  If av_find_best_stream returns successfully and decoder_ret is not
1165
 *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1166
 */
1167
int av_find_best_stream(AVFormatContext *ic,
1168
                        enum AVMediaType type,
1169
                        int wanted_stream_nb,
1170
                        int related_stream,
1171
                        AVCodec **decoder_ret,
1172
                        int flags);
1173

    
1174
/**
1175
 * Read a transport packet from a media file.
1176
 *
1177
 * This function is obsolete and should never be used.
1178
 * Use av_read_frame() instead.
1179
 *
1180
 * @param s media file handle
1181
 * @param pkt is filled
1182
 * @return 0 if OK, AVERROR_xxx on error
1183
 */
1184
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1185

    
1186
/**
1187
 * Return the next frame of a stream.
1188
 * This function returns what is stored in the file, and does not validate
1189
 * that what is there are valid frames for the decoder. It will split what is
1190
 * stored in the file into frames and return one for each call. It will not
1191
 * omit invalid data between valid frames so as to give the decoder the maximum
1192
 * information possible for decoding.
1193
 *
1194
 * The returned packet is valid
1195
 * until the next av_read_frame() or until av_close_input_file() and
1196
 * must be freed with av_free_packet. For video, the packet contains
1197
 * exactly one frame. For audio, it contains an integer number of
1198
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1199
 * data). If the audio frames have a variable size (e.g. MPEG audio),
1200
 * then it contains one frame.
1201
 *
1202
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1203
 * values in AVStream.time_base units (and guessed if the format cannot
1204
 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1205
 * has B-frames, so it is better to rely on pkt->dts if you do not
1206
 * decompress the payload.
1207
 *
1208
 * @return 0 if OK, < 0 on error or end of file
1209
 */
1210
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1211

    
1212
/**
1213
 * Seek to the keyframe at timestamp.
1214
 * 'timestamp' in 'stream_index'.
1215
 * @param stream_index If stream_index is (-1), a default
1216
 * stream is selected, and timestamp is automatically converted
1217
 * from AV_TIME_BASE units to the stream specific time_base.
1218
 * @param timestamp Timestamp in AVStream.time_base units
1219
 *        or, if no stream is specified, in AV_TIME_BASE units.
1220
 * @param flags flags which select direction and seeking mode
1221
 * @return >= 0 on success
1222
 */
1223
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1224
                  int flags);
1225

    
1226
/**
1227
 * Seek to timestamp ts.
1228
 * Seeking will be done so that the point from which all active streams
1229
 * can be presented successfully will be closest to ts and within min/max_ts.
1230
 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1231
 *
1232
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1233
 * are the file position (this may not be supported by all demuxers).
1234
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1235
 * in the stream with stream_index (this may not be supported by all demuxers).
1236
 * Otherwise all timestamps are in units of the stream selected by stream_index
1237
 * or if stream_index is -1, in AV_TIME_BASE units.
1238
 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1239
 * keyframes (this may not be supported by all demuxers).
1240
 *
1241
 * @param stream_index index of the stream which is used as time base reference
1242
 * @param min_ts smallest acceptable timestamp
1243
 * @param ts target timestamp
1244
 * @param max_ts largest acceptable timestamp
1245
 * @param flags flags
1246
 * @return >=0 on success, error code otherwise
1247
 *
1248
 * @note This is part of the new seek API which is still under construction.
1249
 *       Thus do not use this yet. It may change at any time, do not expect
1250
 *       ABI compatibility yet!
1251
 */
1252
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1253

    
1254
/**
1255
 * Start playing a network-based stream (e.g. RTSP stream) at the
1256
 * current position.
1257
 */
1258
int av_read_play(AVFormatContext *s);
1259

    
1260
/**
1261
 * Pause a network-based stream (e.g. RTSP stream).
1262
 *
1263
 * Use av_read_play() to resume it.
1264
 */
1265
int av_read_pause(AVFormatContext *s);
1266

    
1267
/**
1268
 * Free a AVFormatContext allocated by av_open_input_stream.
1269
 * @param s context to free
1270
 */
1271
void av_close_input_stream(AVFormatContext *s);
1272

    
1273
/**
1274
 * Close a media file (but not its codecs).
1275
 *
1276
 * @param s media file handle
1277
 */
1278
void av_close_input_file(AVFormatContext *s);
1279

    
1280
/**
1281
 * Add a new stream to a media file.
1282
 *
1283
 * Can only be called in the read_header() function. If the flag
1284
 * AVFMTCTX_NOHEADER is in the format context, then new streams
1285
 * can be added in read_packet too.
1286
 *
1287
 * @param s media file handle
1288
 * @param id file-format-dependent stream ID
1289
 */
1290
AVStream *av_new_stream(AVFormatContext *s, int id);
1291
AVProgram *av_new_program(AVFormatContext *s, int id);
1292

    
1293
/**
1294
 * Add a new chapter.
1295
 * This function is NOT part of the public API
1296
 * and should ONLY be used by demuxers.
1297
 *
1298
 * @param s media file handle
1299
 * @param id unique ID for this chapter
1300
 * @param start chapter start time in time_base units
1301
 * @param end chapter end time in time_base units
1302
 * @param title chapter title
1303
 *
1304
 * @return AVChapter or NULL on error
1305
 */
1306
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1307
                          int64_t start, int64_t end, const char *title);
1308

    
1309
/**
1310
 * Set the pts for a given stream.
1311
 *
1312
 * @param s stream
1313
 * @param pts_wrap_bits number of bits effectively used by the pts
1314
 *        (used for wrap control, 33 is the value for MPEG)
1315
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1316
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1317
 */
1318
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1319
                     unsigned int pts_num, unsigned int pts_den);
1320

    
1321
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1322
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1323
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1324
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1325

    
1326
int av_find_default_stream_index(AVFormatContext *s);
1327

    
1328
/**
1329
 * Get the index for a specific timestamp.
1330
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1331
 *                 to the timestamp which is <= the requested one, if backward
1332
 *                 is 0, then it will be >=
1333
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1334
 * @return < 0 if no such timestamp could be found
1335
 */
1336
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1337

    
1338
/**
1339
 * Ensure the index uses less memory than the maximum specified in
1340
 * AVFormatContext.max_index_size by discarding entries if it grows
1341
 * too large.
1342
 * This function is not part of the public API and should only be called
1343
 * by demuxers.
1344
 */
1345
void ff_reduce_index(AVFormatContext *s, int stream_index);
1346

    
1347
/**
1348
 * Add an index entry into a sorted list. Update the entry if the list
1349
 * already contains it.
1350
 *
1351
 * @param timestamp timestamp in the time base of the given stream
1352
 */
1353
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1354
                       int size, int distance, int flags);
1355

    
1356
/**
1357
 * Perform a binary search using av_index_search_timestamp() and
1358
 * AVInputFormat.read_timestamp().
1359
 * This is not supposed to be called directly by a user application,
1360
 * but by demuxers.
1361
 * @param target_ts target timestamp in the time base of the given stream
1362
 * @param stream_index stream number
1363
 */
1364
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1365
                         int64_t target_ts, int flags);
1366

    
1367
/**
1368
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1369
 *
1370
 * Stream ref_st unchanged, others set cur_dts in their native time base.
1371
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1372
 * @param timestamp new dts expressed in time_base of param ref_st
1373
 * @param ref_st reference stream giving time_base of param timestamp
1374
 */
1375
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1376

    
1377
/**
1378
 * Perform a binary search using read_timestamp().
1379
 * This is not supposed to be called directly by a user application,
1380
 * but by demuxers.
1381
 * @param target_ts target timestamp in the time base of the given stream
1382
 * @param stream_index stream number
1383
 */
1384
int64_t av_gen_search(AVFormatContext *s, int stream_index,
1385
                      int64_t target_ts, int64_t pos_min,
1386
                      int64_t pos_max, int64_t pos_limit,
1387
                      int64_t ts_min, int64_t ts_max,
1388
                      int flags, int64_t *ts_ret,
1389
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1390

    
1391
/**
1392
 * media file output
1393
 */
1394
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1395

    
1396
/**
1397
 * Split a URL string into components.
1398
 *
1399
 * The pointers to buffers for storing individual components may be null,
1400
 * in order to ignore that component. Buffers for components not found are
1401
 * set to empty strings. If the port is not found, it is set to a negative
1402
 * value.
1403
 *
1404
 * @param proto the buffer for the protocol
1405
 * @param proto_size the size of the proto buffer
1406
 * @param authorization the buffer for the authorization
1407
 * @param authorization_size the size of the authorization buffer
1408
 * @param hostname the buffer for the host name
1409
 * @param hostname_size the size of the hostname buffer
1410
 * @param port_ptr a pointer to store the port number in
1411
 * @param path the buffer for the path
1412
 * @param path_size the size of the path buffer
1413
 * @param url the URL to split
1414
 */
1415
void av_url_split(char *proto,         int proto_size,
1416
                  char *authorization, int authorization_size,
1417
                  char *hostname,      int hostname_size,
1418
                  int *port_ptr,
1419
                  char *path,          int path_size,
1420
                  const char *url);
1421

    
1422
/**
1423
 * Allocate the stream private data and write the stream header to an
1424
 * output media file.
1425
 *
1426
 * @param s media file handle
1427
 * @return 0 if OK, AVERROR_xxx on error
1428
 */
1429
int av_write_header(AVFormatContext *s);
1430

    
1431
/**
1432
 * Write a packet to an output media file.
1433
 *
1434
 * The packet shall contain one audio or video frame.
1435
 * The packet must be correctly interleaved according to the container
1436
 * specification, if not then av_interleaved_write_frame must be used.
1437
 *
1438
 * @param s media file handle
1439
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1440
              dts/pts, ...
1441
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1442
 */
1443
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1444

    
1445
/**
1446
 * Write a packet to an output media file ensuring correct interleaving.
1447
 *
1448
 * The packet must contain one audio or video frame.
1449
 * If the packets are already correctly interleaved, the application should
1450
 * call av_write_frame() instead as it is slightly faster. It is also important
1451
 * to keep in mind that completely non-interleaved input will need huge amounts
1452
 * of memory to interleave with this, so it is preferable to interleave at the
1453
 * demuxer level.
1454
 *
1455
 * @param s media file handle
1456
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1457
              dts/pts, ...
1458
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1459
 */
1460
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1461

    
1462
/**
1463
 * Interleave a packet per dts in an output media file.
1464
 *
1465
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1466
 * function, so they cannot be used after it. Note that calling av_free_packet()
1467
 * on them is still safe.
1468
 *
1469
 * @param s media file handle
1470
 * @param out the interleaved packet will be output here
1471
 * @param pkt the input packet
1472
 * @param flush 1 if no further packets are available as input and all
1473
 *              remaining packets should be output
1474
 * @return 1 if a packet was output, 0 if no packet could be output,
1475
 *         < 0 if an error occurred
1476
 */
1477
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1478
                                 AVPacket *pkt, int flush);
1479

    
1480
/**
1481
 * Write the stream trailer to an output media file and free the
1482
 * file private data.
1483
 *
1484
 * May only be called after a successful call to av_write_header.
1485
 *
1486
 * @param s media file handle
1487
 * @return 0 if OK, AVERROR_xxx on error
1488
 */
1489
int av_write_trailer(AVFormatContext *s);
1490

    
1491
void dump_format(AVFormatContext *ic,
1492
                 int index,
1493
                 const char *url,
1494
                 int is_output);
1495

    
1496
#if FF_API_PARSE_FRAME_PARAM
1497
/**
1498
 * Parse width and height out of string str.
1499
 * @deprecated Use av_parse_video_frame_size instead.
1500
 */
1501
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1502
                                          const char *str);
1503

    
1504
/**
1505
 * Convert framerate from a string to a fraction.
1506
 * @deprecated Use av_parse_video_frame_rate instead.
1507
 */
1508
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1509
                                          const char *arg);
1510
#endif
1511

    
1512
/**
1513
 * Parse datestr and return a corresponding number of microseconds.
1514
 * @param datestr String representing a date or a duration.
1515
 * - If a date the syntax is:
1516
 * @code
1517
 *  now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]}
1518
 * @endcode
1519
 * If the value is "now" it takes the current time.
1520
 * Time is local time unless Z is appended, in which case it is
1521
 * interpreted as UTC.
1522
 * If the year-month-day part is not specified it takes the current
1523
 * year-month-day.
1524
 * @return the number of microseconds since 1st of January, 1970 up to
1525
 * the time of the parsed date or INT64_MIN if datestr cannot be
1526
 * successfully parsed.
1527
 * - If a duration the syntax is:
1528
 * @code
1529
 *  [-]HH[:MM[:SS[.m...]]]
1530
 *  [-]S+[.m...]
1531
 * @endcode
1532
 * @return the number of microseconds contained in a time interval
1533
 * with the specified duration or INT64_MIN if datestr cannot be
1534
 * successfully parsed.
1535
 * @param duration Flag which tells how to interpret datestr, if
1536
 * not zero datestr is interpreted as a duration, otherwise as a
1537
 * date.
1538
 */
1539
int64_t parse_date(const char *datestr, int duration);
1540

    
1541
/**
1542
 * Get the current time in microseconds.
1543
 */
1544
int64_t av_gettime(void);
1545

    
1546
/* ffm-specific for ffserver */
1547
#define FFM_PACKET_SIZE 4096
1548
int64_t ffm_read_write_index(int fd);
1549
int ffm_write_write_index(int fd, int64_t pos);
1550
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1551

    
1552
/**
1553
 * Attempt to find a specific tag in a URL.
1554
 *
1555
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1556
 * Return 1 if found.
1557
 */
1558
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1559

    
1560
/**
1561
 * Return in 'buf' the path with '%d' replaced by a number.
1562
 *
1563
 * Also handles the '%0nd' format where 'n' is the total number
1564
 * of digits and '%%'.
1565
 *
1566
 * @param buf destination buffer
1567
 * @param buf_size destination buffer size
1568
 * @param path numbered sequence string
1569
 * @param number frame number
1570
 * @return 0 if OK, -1 on format error
1571
 */
1572
int av_get_frame_filename(char *buf, int buf_size,
1573
                          const char *path, int number);
1574

    
1575
/**
1576
 * Check whether filename actually is a numbered sequence generator.
1577
 *
1578
 * @param filename possible numbered sequence string
1579
 * @return 1 if a valid numbered sequence string, 0 otherwise
1580
 */
1581
int av_filename_number_test(const char *filename);
1582

    
1583
/**
1584
 * Generate an SDP for an RTP session.
1585
 *
1586
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1587
 *           array is composed by only one context, such context can contain
1588
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1589
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1590
 *           must contain only one AVStream.
1591
 * @param n_files number of AVCodecContexts contained in ac
1592
 * @param buff buffer where the SDP will be stored (must be allocated by
1593
 *             the caller)
1594
 * @param size the size of the buffer
1595
 * @return 0 if OK, AVERROR_xxx on error
1596
 */
1597
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1598

    
1599
/**
1600
 * Return a positive value if the given filename has one of the given
1601
 * extensions, 0 otherwise.
1602
 *
1603
 * @param extensions a comma-separated list of filename extensions
1604
 */
1605
int av_match_ext(const char *filename, const char *extensions);
1606

    
1607
#endif /* AVFORMAT_AVFORMAT_H */