Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ a1c4b65b

History | View | Annotate | Download (55.3 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

    
25
/**
26
 * I return the LIBAVFORMAT_VERSION_INT constant.  You got
27
 * a fucking problem with that, douchebag?
28
 */
29
unsigned avformat_version(void);
30

    
31
/**
32
 * Return the libavformat build-time configuration.
33
 */
34
const char *avformat_configuration(void);
35

    
36
/**
37
 * Return the libavformat license.
38
 */
39
const char *avformat_license(void);
40

    
41
#include <time.h>
42
#include <stdio.h>  /* FILE */
43
#include "libavcodec/avcodec.h"
44

    
45
#include "avio.h"
46
#include "libavformat/version.h"
47

    
48
struct AVFormatContext;
49

    
50

    
51
/*
52
 * Public Metadata API.
53
 * The metadata API allows libavformat to export metadata tags to a client
54
 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
55
 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
56
 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
57
 * Important concepts to keep in mind:
58
 * 1. Keys are unique; there can never be 2 tags with the same key. This is
59
 *    also meant semantically, i.e., a demuxer should not knowingly produce
60
 *    several keys that are literally different but semantically identical.
61
 *    E.g., key=Author5, key=Author6. In this example, all authors must be
62
 *    placed in the same tag.
63
 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
64
 *    want to store, e.g., the email address of the child of producer Alice
65
 *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
66
 * 3. Several modifiers can be applied to the tag name. This is done by
67
 *    appending a dash character ('-') and the modifier name in the order
68
 *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
69
 *    a) language -- a tag whose value is localized for a particular language
70
 *       is appended with the ISO 639-2/B 3-letter language code.
71
 *       For example: Author-ger=Michael, Author-eng=Mike
72
 *       The original/default language is in the unqualified "Author" tag.
73
 *       A demuxer should set a default if it sets any translated tag.
74
 *    b) sorting  -- a modified version of a tag that should be used for
75
 *       sorting will have '-sort' appended. E.g. artist="The Beatles",
76
 *       artist-sort="Beatles, The".
77
 *
78
 * 4. Demuxers attempt to export metadata in a generic format, however tags
79
 *    with no generic equivalents are left as they are stored in the container.
80
 *    Follows a list of generic tag names:
81
 *
82
 * album        -- name of the set this work belongs to
83
 * album_artist -- main creator of the set/album, if different from artist.
84
 *                 e.g. "Various Artists" for compilation albums.
85
 * artist       -- main creator of the work
86
 * comment      -- any additional description of the file.
87
 * composer     -- who composed the work, if different from artist.
88
 * copyright    -- name of copyright holder.
89
 * creation_time-- date when the file was created, preferably in ISO 8601.
90
 * date         -- date when the work was created, preferably in ISO 8601.
91
 * disc         -- number of a subset, e.g. disc in a multi-disc collection.
92
 * encoder      -- name/settings of the software/hardware that produced the file.
93
 * encoded_by   -- person/group who created the file.
94
 * filename     -- original name of the file.
95
 * genre        -- <self-evident>.
96
 * language     -- main language in which the work is performed, preferably
97
 *                 in ISO 639-2 format.
98
 * performer    -- artist who performed the work, if different from artist.
99
 *                 E.g for "Also sprach Zarathustra", artist would be "Richard
100
 *                 Strauss" and performer "London Philharmonic Orchestra".
101
 * publisher    -- name of the label/publisher.
102
 * service_name     -- name of the service in broadcasting (channel name).
103
 * service_provider -- name of the service provider in broadcasting.
104
 * title        -- name of the work.
105
 * track        -- number of this work in the set, can be in form current/total.
106
 */
107

    
108
#define AV_METADATA_MATCH_CASE      1
109
#define AV_METADATA_IGNORE_SUFFIX   2
110
#define AV_METADATA_DONT_STRDUP_KEY 4
111
#define AV_METADATA_DONT_STRDUP_VAL 8
112
#define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
113

    
114
typedef struct {
115
    char *key;
116
    char *value;
117
}AVMetadataTag;
118

    
119
typedef struct AVMetadata AVMetadata;
120
#if FF_API_OLD_METADATA2
121
typedef struct AVMetadataConv AVMetadataConv;
122
#endif
123

    
124
/**
125
 * Get a metadata element with matching key.
126
 *
127
 * @param prev Set to the previous matching element to find the next.
128
 *             If set to NULL the first matching element is returned.
129
 * @param flags Allows case as well as suffix-insensitive comparisons.
130
 * @return Found tag or NULL, changing key or value leads to undefined behavior.
131
 */
132
AVMetadataTag *
133
av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
134

    
135
#if FF_API_OLD_METADATA
136
/**
137
 * Set the given tag in *pm, overwriting an existing tag.
138
 *
139
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
140
 * a metadata struct is allocated and put in *pm.
141
 * @param key tag key to add to *pm (will be av_strduped)
142
 * @param value tag value to add to *pm (will be av_strduped)
143
 * @return >= 0 on success otherwise an error code <0
144
 * @deprecated Use av_metadata_set2() instead.
145
 */
146
attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
147
#endif
148

    
149
/**
150
 * Set the given tag in *pm, overwriting an existing tag.
151
 *
152
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
153
 * a metadata struct is allocated and put in *pm.
154
 * @param key tag key to add to *pm (will be av_strduped depending on flags)
155
 * @param value tag value to add to *pm (will be av_strduped depending on flags).
156
 *        Passing a NULL value will cause an existing tag to be deleted.
157
 * @return >= 0 on success otherwise an error code <0
158
 */
159
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
160

    
161
#if FF_API_OLD_METADATA2
162
/**
163
 * This function is provided for compatibility reason and currently does nothing.
164
 */
165
attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
166
                                                                        const AVMetadataConv *s_conv);
167
#endif
168

    
169
/**
170
 * Copy metadata from one AVMetadata struct into another.
171
 * @param dst pointer to a pointer to a AVMetadata struct. If *dst is NULL,
172
 *            this function will allocate a struct for you and put it in *dst
173
 * @param src pointer to source AVMetadata struct
174
 * @param flags flags to use when setting metadata in *dst
175
 * @note metadata is read using the AV_METADATA_IGNORE_SUFFIX flag
176
 */
177
void av_metadata_copy(AVMetadata **dst, AVMetadata *src, int flags);
178

    
179
/**
180
 * Free all the memory allocated for an AVMetadata struct.
181
 */
182
void av_metadata_free(AVMetadata **m);
183

    
184

    
185
/* packet functions */
186

    
187

    
188
/**
189
 * Allocate and read the payload of a packet and initialize its
190
 * fields with default values.
191
 *
192
 * @param pkt packet
193
 * @param size desired payload size
194
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
195
 */
196
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
197

    
198

    
199
/**
200
 * Read data and append it to the current content of the AVPacket.
201
 * If pkt->size is 0 this is identical to av_get_packet.
202
 * Note that this uses av_grow_packet and thus involves a realloc
203
 * which is inefficient. Thus this function should only be used
204
 * when there is no reasonable way to know (an upper bound of)
205
 * the final size.
206
 *
207
 * @param pkt packet
208
 * @param size amount of data to read
209
 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
210
 *         will not be lost even if an error occurs.
211
 */
212
int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
213

    
214
/*************************************************/
215
/* fractional numbers for exact pts handling */
216

    
217
/**
218
 * The exact value of the fractional number is: 'val + num / den'.
219
 * num is assumed to be 0 <= num < den.
220
 */
221
typedef struct AVFrac {
222
    int64_t val, num, den;
223
} AVFrac;
224

    
225
/*************************************************/
226
/* input/output formats */
227

    
228
struct AVCodecTag;
229

    
230
/**
231
 * This structure contains the data a format has to probe a file.
232
 */
233
typedef struct AVProbeData {
234
    const char *filename;
235
    unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
236
    int buf_size;       /**< Size of buf except extra allocated bytes */
237
} AVProbeData;
238

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

    
242
typedef struct AVFormatParameters {
243
    AVRational time_base;
244
    int sample_rate;
245
    int channels;
246
    int width;
247
    int height;
248
    enum PixelFormat pix_fmt;
249
    int channel; /**< Used to select DV channel. */
250
    const char *standard; /**< TV standard, NTSC, PAL, SECAM */
251
    unsigned int mpeg2ts_raw:1;  /**< Force raw MPEG-2 transport stream output, if possible. */
252
    unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
253
                                            stream packet (only meaningful if
254
                                            mpeg2ts_raw is TRUE). */
255
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
256
                                            immediately (RTSP only). */
257
    unsigned int prealloced_context:1;
258
#if FF_API_PARAMETERS_CODEC_ID
259
    attribute_deprecated enum CodecID video_codec_id;
260
    attribute_deprecated enum CodecID audio_codec_id;
261
#endif
262
} AVFormatParameters;
263

    
264
//! Demuxer will use avio_open, no opened file should be provided by the caller.
265
#define AVFMT_NOFILE        0x0001
266
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
267
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
268
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
269
                                      raw picture data. */
270
#define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
271
#define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
272
#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
273
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
274
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
275
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
276
#define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
277

    
278
typedef struct AVOutputFormat {
279
    const char *name;
280
    /**
281
     * Descriptive name for the format, meant to be more human-readable
282
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
283
     * to define it.
284
     */
285
    const char *long_name;
286
    const char *mime_type;
287
    const char *extensions; /**< comma-separated filename extensions */
288
    /**
289
     * size of private data so that it can be allocated in the wrapper
290
     */
291
    int priv_data_size;
292
    /* output support */
293
    enum CodecID audio_codec; /**< default audio codec */
294
    enum CodecID video_codec; /**< default video codec */
295
    int (*write_header)(struct AVFormatContext *);
296
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
297
    int (*write_trailer)(struct AVFormatContext *);
298
    /**
299
     * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
300
     * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
301
     * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
302
     */
303
    int flags;
304
    /**
305
     * Currently only used to set pixel format if not YUV420P.
306
     */
307
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
308
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
309
                             AVPacket *in, int flush);
310

    
311
    /**
312
     * List of supported codec_id-codec_tag pairs, ordered by "better
313
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
314
     */
315
    const struct AVCodecTag * const *codec_tag;
316

    
317
    enum CodecID subtitle_codec; /**< default subtitle codec */
318

    
319
#if FF_API_OLD_METADATA
320
    const AVMetadataConv *metadata_conv;
321
#endif
322

    
323
    const AVClass *priv_class; ///< AVClass for the private context
324

    
325
    /* private fields */
326
    struct AVOutputFormat *next;
327
} AVOutputFormat;
328

    
329
typedef struct AVInputFormat {
330
    /**
331
     * A comma separated list of short names for the format. New names
332
     * may be appended with a minor bump.
333
     */
334
    const char *name;
335

    
336
    /**
337
     * Descriptive name for the format, meant to be more human-readable
338
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
339
     * to define it.
340
     */
341
    const char *long_name;
342

    
343
    /**
344
     * Size of private data so that it can be allocated in the wrapper.
345
     */
346
    int priv_data_size;
347

    
348
    /**
349
     * Tell if a given file has a chance of being parsed as this format.
350
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
351
     * big so you do not have to check for that unless you need more.
352
     */
353
    int (*read_probe)(AVProbeData *);
354

    
355
    /**
356
     * Read the format header and initialize the AVFormatContext
357
     * structure. Return 0 if OK. 'ap' if non-NULL contains
358
     * additional parameters. Only used in raw format right
359
     * now. 'av_new_stream' should be called to create new streams.
360
     */
361
    int (*read_header)(struct AVFormatContext *,
362
                       AVFormatParameters *ap);
363

    
364
    /**
365
     * Read one packet and put it in 'pkt'. pts and flags are also
366
     * set. 'av_new_stream' can be called only if the flag
367
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
368
     * background thread).
369
     * @return 0 on success, < 0 on error.
370
     *         When returning an error, pkt must not have been allocated
371
     *         or must be freed before returning
372
     */
373
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
374

    
375
    /**
376
     * Close the stream. The AVFormatContext and AVStreams are not
377
     * freed by this function
378
     */
379
    int (*read_close)(struct AVFormatContext *);
380

    
381
#if FF_API_READ_SEEK
382
    /**
383
     * Seek to a given timestamp relative to the frames in
384
     * stream component stream_index.
385
     * @param stream_index Must not be -1.
386
     * @param flags Selects which direction should be preferred if no exact
387
     *              match is available.
388
     * @return >= 0 on success (but not necessarily the new offset)
389
     */
390
    attribute_deprecated int (*read_seek)(struct AVFormatContext *,
391
                                          int stream_index, int64_t timestamp, int flags);
392
#endif
393
    /**
394
     * Gets the next timestamp in stream[stream_index].time_base units.
395
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
396
     */
397
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
398
                              int64_t *pos, int64_t pos_limit);
399

    
400
    /**
401
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
402
     */
403
    int flags;
404

    
405
    /**
406
     * If extensions are defined, then no probe is done. You should
407
     * usually not use extension format guessing because it is not
408
     * reliable enough
409
     */
410
    const char *extensions;
411

    
412
    /**
413
     * General purpose read-only value that the format can use.
414
     */
415
    int value;
416

    
417
    /**
418
     * Start/resume playing - only meaningful if using a network-based format
419
     * (RTSP).
420
     */
421
    int (*read_play)(struct AVFormatContext *);
422

    
423
    /**
424
     * Pause playing - only meaningful if using a network-based format
425
     * (RTSP).
426
     */
427
    int (*read_pause)(struct AVFormatContext *);
428

    
429
    const struct AVCodecTag * const *codec_tag;
430

    
431
    /**
432
     * Seek to timestamp ts.
433
     * Seeking will be done so that the point from which all active streams
434
     * can be presented successfully will be closest to ts and within min/max_ts.
435
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
436
     */
437
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
438

    
439
#if FF_API_OLD_METADATA
440
    const AVMetadataConv *metadata_conv;
441
#endif
442

    
443
    /* private fields */
444
    struct AVInputFormat *next;
445
} AVInputFormat;
446

    
447
enum AVStreamParseType {
448
    AVSTREAM_PARSE_NONE,
449
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
450
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
451
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
452
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
453
};
454

    
455
typedef struct AVIndexEntry {
456
    int64_t pos;
457
    int64_t timestamp;
458
#define AVINDEX_KEYFRAME 0x0001
459
    int flags:2;
460
    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
} AVIndexEntry;
463

    
464
#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

    
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
#define AV_DISPOSITION_FORCED    0x0040
477
#define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
478
#define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
479
#define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
480

    
481
/**
482
 * Stream structure.
483
 * New fields can be added to the end with minor version bumps.
484
 * Removal, reordering and changes to existing fields require a major
485
 * version bump.
486
 * sizeof(AVStream) must not be used outside libav*.
487
 */
488
typedef struct AVStream {
489
    int index;    /**< stream index in AVFormatContext */
490
    int id;       /**< format-specific stream ID */
491
    AVCodecContext *codec; /**< codec context */
492
    /**
493
     * Real base framerate of the stream.
494
     * This is the lowest framerate with which all timestamps can be
495
     * represented accurately (it is the least common multiple of all
496
     * framerates in the stream). Note, this value is just a guess!
497
     * For example, if the time base is 1/90000 and all frames have either
498
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
499
     */
500
    AVRational r_frame_rate;
501
    void *priv_data;
502

    
503
    /* internal data used in av_find_stream_info() */
504
    int64_t first_dts;
505

    
506
    /**
507
     * encoding: pts generation when outputting stream
508
     */
509
    struct AVFrac pts;
510

    
511
    /**
512
     * This is the fundamental unit of time (in seconds) in terms
513
     * of which frame timestamps are represented. For fixed-fps content,
514
     * time base should be 1/framerate and timestamp increments should be 1.
515
     * decoding: set by libavformat
516
     * encoding: set by libavformat in av_write_header
517
     */
518
    AVRational time_base;
519
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
520
    /* ffmpeg.c private use */
521
    int stream_copy; /**< If set, just copy stream. */
522
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
523

    
524
    //FIXME move stuff to a flags field?
525
    /**
526
     * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
527
     * MN: dunno if that is the right place for it
528
     */
529
    float quality;
530

    
531
    /**
532
     * Decoding: pts of the first frame of the stream, in stream time base.
533
     * Only set this if you are absolutely 100% sure that the value you set
534
     * it to really is the pts of the first frame.
535
     * This may be undefined (AV_NOPTS_VALUE).
536
     * @note The ASF header does NOT contain a correct start_time the ASF
537
     * demuxer must NOT set this.
538
     */
539
    int64_t start_time;
540

    
541
    /**
542
     * Decoding: duration of the stream, in stream time base.
543
     * If a source file does not specify a duration, but does specify
544
     * a bitrate, this value will be estimated from bitrate and file size.
545
     */
546
    int64_t duration;
547

    
548
#if FF_API_OLD_METADATA
549
    attribute_deprecated char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
550
#endif
551

    
552
    /* av_read_frame() support */
553
    enum AVStreamParseType need_parsing;
554
    struct AVCodecParserContext *parser;
555

    
556
    int64_t cur_dts;
557
    int last_IP_duration;
558
    int64_t last_IP_pts;
559
    /* av_seek_frame() support */
560
    AVIndexEntry *index_entries; /**< Only used if the format does not
561
                                    support seeking natively. */
562
    int nb_index_entries;
563
    unsigned int index_entries_allocated_size;
564

    
565
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
566

    
567
#if FF_API_LAVF_UNUSED
568
    attribute_deprecated int64_t unused[4+1];
569
#endif
570

    
571
#if FF_API_OLD_METADATA
572
    attribute_deprecated char *filename; /**< source filename of the stream */
573
#endif
574

    
575
    int disposition; /**< AV_DISPOSITION_* bit field */
576

    
577
    AVProbeData probe_data;
578
#define MAX_REORDER_DELAY 16
579
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
580

    
581
    /**
582
     * sample aspect ratio (0 if unknown)
583
     * - encoding: Set by user.
584
     * - decoding: Set by libavformat.
585
     */
586
    AVRational sample_aspect_ratio;
587

    
588
    AVMetadata *metadata;
589

    
590
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
591
    /* external applications; try to use something else if at all possible.    */
592
    const uint8_t *cur_ptr;
593
    int cur_len;
594
    AVPacket cur_pkt;
595

    
596
    // Timestamp generation support:
597
    /**
598
     * Timestamp corresponding to the last dts sync point.
599
     *
600
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
601
     * a DTS is received from the underlying container. Otherwise set to
602
     * AV_NOPTS_VALUE by default.
603
     */
604
    int64_t reference_dts;
605

    
606
    /**
607
     * Number of packets to buffer for codec probing
608
     * NOT PART OF PUBLIC API
609
     */
610
#define MAX_PROBE_PACKETS 2500
611
    int probe_packets;
612

    
613
    /**
614
     * last packet in packet_buffer for this stream when muxing.
615
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
616
     */
617
    struct AVPacketList *last_in_packet_buffer;
618

    
619
    /**
620
     * Average framerate
621
     */
622
    AVRational avg_frame_rate;
623

    
624
    /**
625
     * Number of frames that have been demuxed during av_find_stream_info()
626
     */
627
    int codec_info_nb_frames;
628

    
629
    /**
630
     * Stream informations used internally by av_find_stream_info()
631
     */
632
#define MAX_STD_TIMEBASES (60*12+5)
633
    struct {
634
        int64_t last_dts;
635
        int64_t duration_gcd;
636
        int duration_count;
637
        double duration_error[MAX_STD_TIMEBASES];
638
        int64_t codec_info_duration;
639
    } *info;
640
} AVStream;
641

    
642
#define AV_PROGRAM_RUNNING 1
643

    
644
/**
645
 * New fields can be added to the end with minor version bumps.
646
 * Removal, reordering and changes to existing fields require a major
647
 * version bump.
648
 * sizeof(AVProgram) must not be used outside libav*.
649
 */
650
typedef struct AVProgram {
651
    int            id;
652
#if FF_API_OLD_METADATA
653
    attribute_deprecated char           *provider_name; ///< network name for DVB streams
654
    attribute_deprecated char           *name;          ///< service name for DVB streams
655
#endif
656
    int            flags;
657
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
658
    unsigned int   *stream_index;
659
    unsigned int   nb_stream_indexes;
660
    AVMetadata *metadata;
661
} AVProgram;
662

    
663
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
664
                                         (streams are added dynamically) */
665

    
666
typedef struct AVChapter {
667
    int id;                 ///< unique ID to identify the chapter
668
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
669
    int64_t start, end;     ///< chapter start/end time in time_base units
670
#if FF_API_OLD_METADATA
671
    attribute_deprecated char *title;            ///< chapter title
672
#endif
673
    AVMetadata *metadata;
674
} AVChapter;
675

    
676
#if FF_API_MAX_STREAMS
677
#define MAX_STREAMS 20
678
#endif
679

    
680
/**
681
 * Format I/O context.
682
 * New fields can be added to the end with minor version bumps.
683
 * Removal, reordering and changes to existing fields require a major
684
 * version bump.
685
 * sizeof(AVFormatContext) must not be used outside libav*.
686
 */
687
typedef struct AVFormatContext {
688
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
689
    /* Can only be iformat or oformat, not both at the same time. */
690
    struct AVInputFormat *iformat;
691
    struct AVOutputFormat *oformat;
692
    void *priv_data;
693
    AVIOContext *pb;
694
    unsigned int nb_streams;
695
#if FF_API_MAX_STREAMS
696
    AVStream *streams[MAX_STREAMS];
697
#else
698
    AVStream **streams;
699
#endif
700
    char filename[1024]; /**< input or output filename */
701
    /* stream info */
702
    int64_t timestamp;
703
#if FF_API_OLD_METADATA
704
    attribute_deprecated char title[512];
705
    attribute_deprecated char author[512];
706
    attribute_deprecated char copyright[512];
707
    attribute_deprecated char comment[512];
708
    attribute_deprecated char album[512];
709
    attribute_deprecated int year;  /**< ID3 year, 0 if none */
710
    attribute_deprecated int track; /**< track number, 0 if none */
711
    attribute_deprecated char genre[32]; /**< ID3 genre */
712
#endif
713

    
714
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
715
    /* private data for pts handling (do not modify directly). */
716
    /**
717
     * This buffer is only needed when packets were already buffered but
718
     * not decoded, for example to get the codec parameters in MPEG
719
     * streams.
720
     */
721
    struct AVPacketList *packet_buffer;
722

    
723
    /**
724
     * Decoding: position of the first frame of the component, in
725
     * AV_TIME_BASE fractional seconds. NEVER set this value directly:
726
     * It is deduced from the AVStream values.
727
     */
728
    int64_t start_time;
729

    
730
    /**
731
     * Decoding: duration of the stream, in AV_TIME_BASE fractional
732
     * seconds. Only set this value if you know none of the individual stream
733
     * durations and also dont set any of them. This is deduced from the
734
     * AVStream values if not set.
735
     */
736
    int64_t duration;
737

    
738
    /**
739
     * decoding: total file size, 0 if unknown
740
     */
741
    int64_t file_size;
742

    
743
    /**
744
     * Decoding: total stream bitrate in bit/s, 0 if not
745
     * available. Never set it directly if the file_size and the
746
     * duration are known as FFmpeg can compute it automatically.
747
     */
748
    int bit_rate;
749

    
750
    /* av_read_frame() support */
751
    AVStream *cur_st;
752
#if FF_API_LAVF_UNUSED
753
    const uint8_t *cur_ptr_deprecated;
754
    int cur_len_deprecated;
755
    AVPacket cur_pkt_deprecated;
756
#endif
757

    
758
    /* av_seek_frame() support */
759
    int64_t data_offset; /**< offset of the first packet */
760
#if FF_API_INDEX_BUILT
761
    attribute_deprecated int index_built;
762
#endif
763

    
764
    int mux_rate;
765
    unsigned int packet_size;
766
    int preload;
767
    int max_delay;
768

    
769
#define AVFMT_NOOUTPUTLOOP -1
770
#define AVFMT_INFINITEOUTPUTLOOP 0
771
    /**
772
     * number of times to loop output in formats that support it
773
     */
774
    int loop_output;
775

    
776
    int flags;
777
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
778
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
779
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
780
#define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
781
#define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
782
#define AVFMT_FLAG_NOPARSE      0x0020 ///< Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the fillin code works on frames and no parsing -> no frames. Also seeking to frames can not work if parsing to find frame boundaries has been disabled
783
#define AVFMT_FLAG_RTP_HINT     0x0040 ///< Add RTP hinting to the output file
784

    
785
    int loop_input;
786

    
787
    /**
788
     * decoding: size of data to probe; encoding: unused.
789
     */
790
    unsigned int probesize;
791

    
792
    /**
793
     * Maximum time (in AV_TIME_BASE units) during which the input should
794
     * be analyzed in av_find_stream_info().
795
     */
796
    int max_analyze_duration;
797

    
798
    const uint8_t *key;
799
    int keylen;
800

    
801
    unsigned int nb_programs;
802
    AVProgram **programs;
803

    
804
    /**
805
     * Forced video codec_id.
806
     * Demuxing: Set by user.
807
     */
808
    enum CodecID video_codec_id;
809

    
810
    /**
811
     * Forced audio codec_id.
812
     * Demuxing: Set by user.
813
     */
814
    enum CodecID audio_codec_id;
815

    
816
    /**
817
     * Forced subtitle codec_id.
818
     * Demuxing: Set by user.
819
     */
820
    enum CodecID subtitle_codec_id;
821

    
822
    /**
823
     * Maximum amount of memory in bytes to use for the index of each stream.
824
     * If the index exceeds this size, entries will be discarded as
825
     * needed to maintain a smaller size. This can lead to slower or less
826
     * accurate seeking (depends on demuxer).
827
     * Demuxers for which a full in-memory index is mandatory will ignore
828
     * this.
829
     * muxing  : unused
830
     * demuxing: set by user
831
     */
832
    unsigned int max_index_size;
833

    
834
    /**
835
     * Maximum amount of memory in bytes to use for buffering frames
836
     * obtained from realtime capture devices.
837
     */
838
    unsigned int max_picture_buffer;
839

    
840
    unsigned int nb_chapters;
841
    AVChapter **chapters;
842

    
843
    /**
844
     * Flags to enable debugging.
845
     */
846
    int debug;
847
#define FF_FDEBUG_TS        0x0001
848

    
849
    /**
850
     * Raw packets from the demuxer, prior to parsing and decoding.
851
     * This buffer is used for buffering packets until the codec can
852
     * be identified, as parsing cannot be done without knowing the
853
     * codec.
854
     */
855
    struct AVPacketList *raw_packet_buffer;
856
    struct AVPacketList *raw_packet_buffer_end;
857

    
858
    struct AVPacketList *packet_buffer_end;
859

    
860
    AVMetadata *metadata;
861

    
862
    /**
863
     * Remaining size available for raw_packet_buffer, in bytes.
864
     * NOT PART OF PUBLIC API
865
     */
866
#define RAW_PACKET_BUFFER_SIZE 2500000
867
    int raw_packet_buffer_remaining_size;
868

    
869
    /**
870
     * Start time of the stream in real world time, in microseconds
871
     * since the unix epoch (00:00 1st January 1970). That is, pts=0
872
     * in the stream was captured at this real world time.
873
     * - encoding: Set by user.
874
     * - decoding: Unused.
875
     */
876
    int64_t start_time_realtime;
877
} AVFormatContext;
878

    
879
typedef struct AVPacketList {
880
    AVPacket pkt;
881
    struct AVPacketList *next;
882
} AVPacketList;
883

    
884
#if FF_API_FIRST_FORMAT
885
attribute_deprecated extern AVInputFormat *first_iformat;
886
attribute_deprecated extern AVOutputFormat *first_oformat;
887
#endif
888

    
889
/**
890
 * If f is NULL, returns the first registered input format,
891
 * if f is non-NULL, returns the next registered input format after f
892
 * or NULL if f is the last one.
893
 */
894
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
895

    
896
/**
897
 * If f is NULL, returns the first registered output format,
898
 * if f is non-NULL, returns the next registered output format after f
899
 * or NULL if f is the last one.
900
 */
901
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
902

    
903
enum CodecID av_guess_image2_codec(const char *filename);
904

    
905
/* XXX: Use automatic init with either ELF sections or C file parser */
906
/* modules. */
907

    
908
/* utils.c */
909
void av_register_input_format(AVInputFormat *format);
910
void av_register_output_format(AVOutputFormat *format);
911
#if FF_API_GUESS_FORMAT
912
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
913
                                    const char *filename,
914
                                    const char *mime_type);
915

    
916
/**
917
 * @deprecated Use av_guess_format() instead.
918
 */
919
attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
920
                                                  const char *filename,
921
                                                  const char *mime_type);
922
#endif
923

    
924
/**
925
 * Return the output format in the list of registered output formats
926
 * which best matches the provided parameters, or return NULL if
927
 * there is no match.
928
 *
929
 * @param short_name if non-NULL checks if short_name matches with the
930
 * names of the registered formats
931
 * @param filename if non-NULL checks if filename terminates with the
932
 * extensions of the registered formats
933
 * @param mime_type if non-NULL checks if mime_type matches with the
934
 * MIME type of the registered formats
935
 */
936
AVOutputFormat *av_guess_format(const char *short_name,
937
                                const char *filename,
938
                                const char *mime_type);
939

    
940
/**
941
 * Guess the codec ID based upon muxer and filename.
942
 */
943
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
944
                            const char *filename, const char *mime_type,
945
                            enum AVMediaType type);
946

    
947
/**
948
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
949
 *
950
 * @param f The file stream pointer where the dump should be sent to.
951
 * @param buf buffer
952
 * @param size buffer size
953
 *
954
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
955
 */
956
void av_hex_dump(FILE *f, uint8_t *buf, int size);
957

    
958
/**
959
 * Send a nice hexadecimal dump of a buffer to the log.
960
 *
961
 * @param avcl A pointer to an arbitrary struct of which the first field is a
962
 * pointer to an AVClass struct.
963
 * @param level The importance level of the message, lower values signifying
964
 * higher importance.
965
 * @param buf buffer
966
 * @param size buffer size
967
 *
968
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
969
 */
970
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
971

    
972
/**
973
 * Send a nice dump of a packet to the specified file stream.
974
 *
975
 * @param f The file stream pointer where the dump should be sent to.
976
 * @param pkt packet to dump
977
 * @param dump_payload True if the payload must be displayed, too.
978
 */
979
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
980

    
981
/**
982
 * Send a nice dump of a packet to the log.
983
 *
984
 * @param avcl A pointer to an arbitrary struct of which the first field is a
985
 * pointer to an AVClass struct.
986
 * @param level The importance level of the message, lower values signifying
987
 * higher importance.
988
 * @param pkt packet to dump
989
 * @param dump_payload True if the payload must be displayed, too.
990
 */
991
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
992

    
993
/**
994
 * Initialize libavformat and register all the muxers, demuxers and
995
 * protocols. If you do not call this function, then you can select
996
 * exactly which formats you want to support.
997
 *
998
 * @see av_register_input_format()
999
 * @see av_register_output_format()
1000
 * @see av_register_protocol()
1001
 */
1002
void av_register_all(void);
1003

    
1004
/**
1005
 * Get the CodecID for the given codec tag tag.
1006
 * If no codec id is found returns CODEC_ID_NONE.
1007
 *
1008
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1009
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1010
 */
1011
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1012

    
1013
/**
1014
 * Get the codec tag for the given codec id id.
1015
 * If no codec tag is found returns 0.
1016
 *
1017
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1018
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1019
 */
1020
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1021

    
1022
/* media file input */
1023

    
1024
/**
1025
 * Find AVInputFormat based on the short name of the input format.
1026
 */
1027
AVInputFormat *av_find_input_format(const char *short_name);
1028

    
1029
/**
1030
 * Guess the file format.
1031
 *
1032
 * @param is_opened Whether the file is already opened; determines whether
1033
 *                  demuxers with or without AVFMT_NOFILE are probed.
1034
 */
1035
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1036

    
1037
/**
1038
 * Guess the file format.
1039
 *
1040
 * @param is_opened Whether the file is already opened; determines whether
1041
 *                  demuxers with or without AVFMT_NOFILE are probed.
1042
 * @param score_max A probe score larger that this is required to accept a
1043
 *                  detection, the variable is set to the actual detection
1044
 *                  score afterwards.
1045
 *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1046
 *                  to retry with a larger probe buffer.
1047
 */
1048
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1049

    
1050
/**
1051
 * Probe a bytestream to determine the input format. Each time a probe returns
1052
 * with a score that is too low, the probe buffer size is increased and another
1053
 * attempt is made. When the maximum probe size is reached, the input format
1054
 * with the highest score is returned.
1055
 *
1056
 * @param pb the bytestream to probe
1057
 * @param fmt the input format is put here
1058
 * @param filename the filename of the stream
1059
 * @param logctx the log context
1060
 * @param offset the offset within the bytestream to probe from
1061
 * @param max_probe_size the maximum probe buffer size (zero for default)
1062
 * @return 0 in case of success, a negative value corresponding to an
1063
 * AVERROR code otherwise
1064
 */
1065
int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1066
                          const char *filename, void *logctx,
1067
                          unsigned int offset, unsigned int max_probe_size);
1068

    
1069
/**
1070
 * Allocate all the structures needed to read an input stream.
1071
 *        This does not open the needed codecs for decoding the stream[s].
1072
 */
1073
int av_open_input_stream(AVFormatContext **ic_ptr,
1074
                         AVIOContext *pb, const char *filename,
1075
                         AVInputFormat *fmt, AVFormatParameters *ap);
1076

    
1077
/**
1078
 * Open a media file as input. The codecs are not opened. Only the file
1079
 * header (if present) is read.
1080
 *
1081
 * @param ic_ptr The opened media file handle is put here.
1082
 * @param filename filename to open
1083
 * @param fmt If non-NULL, force the file format to use.
1084
 * @param buf_size optional buffer size (zero if default is OK)
1085
 * @param ap Additional parameters needed when opening the file
1086
 *           (NULL if default).
1087
 * @return 0 if OK, AVERROR_xxx otherwise
1088
 */
1089
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1090
                       AVInputFormat *fmt,
1091
                       int buf_size,
1092
                       AVFormatParameters *ap);
1093

    
1094
#if FF_API_ALLOC_FORMAT_CONTEXT
1095
/**
1096
 * @deprecated Use avformat_alloc_context() instead.
1097
 */
1098
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1099
#endif
1100

    
1101
/**
1102
 * Allocate an AVFormatContext.
1103
 * avformat_free_context() can be used to free the context and everything
1104
 * allocated by the framework within it.
1105
 */
1106
AVFormatContext *avformat_alloc_context(void);
1107

    
1108
/**
1109
 * Read packets of a media file to get stream information. This
1110
 * is useful for file formats with no headers such as MPEG. This
1111
 * function also computes the real framerate in case of MPEG-2 repeat
1112
 * frame mode.
1113
 * The logical file position is not changed by this function;
1114
 * examined packets may be buffered for later processing.
1115
 *
1116
 * @param ic media file handle
1117
 * @return >=0 if OK, AVERROR_xxx on error
1118
 * @todo Let the user decide somehow what information is needed so that
1119
 *       we do not waste time getting stuff the user does not need.
1120
 */
1121
int av_find_stream_info(AVFormatContext *ic);
1122

    
1123
/**
1124
 * Find the "best" stream in the file.
1125
 * The best stream is determined according to various heuristics as the most
1126
 * likely to be what the user expects.
1127
 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1128
 * default decoder for the stream's codec; streams for which no decoder can
1129
 * be found are ignored.
1130
 *
1131
 * @param ic                media file handle
1132
 * @param type              stream type: video, audio, subtitles, etc.
1133
 * @param wanted_stream_nb  user-requested stream number,
1134
 *                          or -1 for automatic selection
1135
 * @param related_stream    try to find a stream related (eg. in the same
1136
 *                          program) to this one, or -1 if none
1137
 * @param decoder_ret       if non-NULL, returns the decoder for the
1138
 *                          selected stream
1139
 * @param flags             flags; none are currently defined
1140
 * @return  the non-negative stream number in case of success,
1141
 *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1142
 *          could be found,
1143
 *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1144
 * @note  If av_find_best_stream returns successfully and decoder_ret is not
1145
 *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1146
 */
1147
int av_find_best_stream(AVFormatContext *ic,
1148
                        enum AVMediaType type,
1149
                        int wanted_stream_nb,
1150
                        int related_stream,
1151
                        AVCodec **decoder_ret,
1152
                        int flags);
1153

    
1154
/**
1155
 * Read a transport packet from a media file.
1156
 *
1157
 * This function is obsolete and should never be used.
1158
 * Use av_read_frame() instead.
1159
 *
1160
 * @param s media file handle
1161
 * @param pkt is filled
1162
 * @return 0 if OK, AVERROR_xxx on error
1163
 */
1164
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1165

    
1166
/**
1167
 * Return the next frame of a stream.
1168
 * This function returns what is stored in the file, and does not validate
1169
 * that what is there are valid frames for the decoder. It will split what is
1170
 * stored in the file into frames and return one for each call. It will not
1171
 * omit invalid data between valid frames so as to give the decoder the maximum
1172
 * information possible for decoding.
1173
 *
1174
 * The returned packet is valid
1175
 * until the next av_read_frame() or until av_close_input_file() and
1176
 * must be freed with av_free_packet. For video, the packet contains
1177
 * exactly one frame. For audio, it contains an integer number of
1178
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1179
 * data). If the audio frames have a variable size (e.g. MPEG audio),
1180
 * then it contains one frame.
1181
 *
1182
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1183
 * values in AVStream.time_base units (and guessed if the format cannot
1184
 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1185
 * has B-frames, so it is better to rely on pkt->dts if you do not
1186
 * decompress the payload.
1187
 *
1188
 * @return 0 if OK, < 0 on error or end of file
1189
 */
1190
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1191

    
1192
/**
1193
 * Seek to the keyframe at timestamp.
1194
 * 'timestamp' in 'stream_index'.
1195
 * @param stream_index If stream_index is (-1), a default
1196
 * stream is selected, and timestamp is automatically converted
1197
 * from AV_TIME_BASE units to the stream specific time_base.
1198
 * @param timestamp Timestamp in AVStream.time_base units
1199
 *        or, if no stream is specified, in AV_TIME_BASE units.
1200
 * @param flags flags which select direction and seeking mode
1201
 * @return >= 0 on success
1202
 */
1203
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1204
                  int flags);
1205

    
1206
/**
1207
 * Seek to timestamp ts.
1208
 * Seeking will be done so that the point from which all active streams
1209
 * can be presented successfully will be closest to ts and within min/max_ts.
1210
 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1211
 *
1212
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1213
 * are the file position (this may not be supported by all demuxers).
1214
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1215
 * in the stream with stream_index (this may not be supported by all demuxers).
1216
 * Otherwise all timestamps are in units of the stream selected by stream_index
1217
 * or if stream_index is -1, in AV_TIME_BASE units.
1218
 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1219
 * keyframes (this may not be supported by all demuxers).
1220
 *
1221
 * @param stream_index index of the stream which is used as time base reference
1222
 * @param min_ts smallest acceptable timestamp
1223
 * @param ts target timestamp
1224
 * @param max_ts largest acceptable timestamp
1225
 * @param flags flags
1226
 * @return >=0 on success, error code otherwise
1227
 *
1228
 * @note This is part of the new seek API which is still under construction.
1229
 *       Thus do not use this yet. It may change at any time, do not expect
1230
 *       ABI compatibility yet!
1231
 */
1232
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1233

    
1234
/**
1235
 * Start playing a network-based stream (e.g. RTSP stream) at the
1236
 * current position.
1237
 */
1238
int av_read_play(AVFormatContext *s);
1239

    
1240
/**
1241
 * Pause a network-based stream (e.g. RTSP stream).
1242
 *
1243
 * Use av_read_play() to resume it.
1244
 */
1245
int av_read_pause(AVFormatContext *s);
1246

    
1247
/**
1248
 * Free a AVFormatContext allocated by av_open_input_stream.
1249
 * @param s context to free
1250
 */
1251
void av_close_input_stream(AVFormatContext *s);
1252

    
1253
/**
1254
 * Close a media file (but not its codecs).
1255
 *
1256
 * @param s media file handle
1257
 */
1258
void av_close_input_file(AVFormatContext *s);
1259

    
1260
/**
1261
 * Free an AVFormatContext and all its streams.
1262
 * @param s context to free
1263
 */
1264
void avformat_free_context(AVFormatContext *s);
1265

    
1266
/**
1267
 * Add a new stream to a media file.
1268
 *
1269
 * Can only be called in the read_header() function. If the flag
1270
 * AVFMTCTX_NOHEADER is in the format context, then new streams
1271
 * can be added in read_packet too.
1272
 *
1273
 * @param s media file handle
1274
 * @param id file-format-dependent stream ID
1275
 */
1276
AVStream *av_new_stream(AVFormatContext *s, int id);
1277
AVProgram *av_new_program(AVFormatContext *s, int id);
1278

    
1279
/**
1280
 * Set the pts for a given stream. If the new values would be invalid
1281
 * (<= 0), it leaves the AVStream unchanged.
1282
 *
1283
 * @param s stream
1284
 * @param pts_wrap_bits number of bits effectively used by the pts
1285
 *        (used for wrap control, 33 is the value for MPEG)
1286
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1287
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1288
 */
1289
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1290
                     unsigned int pts_num, unsigned int pts_den);
1291

    
1292
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1293
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1294
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1295
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1296

    
1297
int av_find_default_stream_index(AVFormatContext *s);
1298

    
1299
/**
1300
 * Get the index for a specific timestamp.
1301
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1302
 *                 to the timestamp which is <= the requested one, if backward
1303
 *                 is 0, then it will be >=
1304
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1305
 * @return < 0 if no such timestamp could be found
1306
 */
1307
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1308

    
1309
/**
1310
 * Add an index entry into a sorted list. Update the entry if the list
1311
 * already contains it.
1312
 *
1313
 * @param timestamp timestamp in the time base of the given stream
1314
 */
1315
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1316
                       int size, int distance, int flags);
1317

    
1318
/**
1319
 * Perform a binary search using av_index_search_timestamp() and
1320
 * AVInputFormat.read_timestamp().
1321
 * This is not supposed to be called directly by a user application,
1322
 * but by demuxers.
1323
 * @param target_ts target timestamp in the time base of the given stream
1324
 * @param stream_index stream number
1325
 */
1326
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1327
                         int64_t target_ts, int flags);
1328

    
1329
/**
1330
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1331
 *
1332
 * Stream ref_st unchanged, others set cur_dts in their native time base.
1333
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1334
 * @param timestamp new dts expressed in time_base of param ref_st
1335
 * @param ref_st reference stream giving time_base of param timestamp
1336
 */
1337
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1338

    
1339
/**
1340
 * Perform a binary search using read_timestamp().
1341
 * This is not supposed to be called directly by a user application,
1342
 * but by demuxers.
1343
 * @param target_ts target timestamp in the time base of the given stream
1344
 * @param stream_index stream number
1345
 */
1346
int64_t av_gen_search(AVFormatContext *s, int stream_index,
1347
                      int64_t target_ts, int64_t pos_min,
1348
                      int64_t pos_max, int64_t pos_limit,
1349
                      int64_t ts_min, int64_t ts_max,
1350
                      int flags, int64_t *ts_ret,
1351
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1352

    
1353
/**
1354
 * media file output
1355
 */
1356
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1357

    
1358
/**
1359
 * Split a URL string into components.
1360
 *
1361
 * The pointers to buffers for storing individual components may be null,
1362
 * in order to ignore that component. Buffers for components not found are
1363
 * set to empty strings. If the port is not found, it is set to a negative
1364
 * value.
1365
 *
1366
 * @param proto the buffer for the protocol
1367
 * @param proto_size the size of the proto buffer
1368
 * @param authorization the buffer for the authorization
1369
 * @param authorization_size the size of the authorization buffer
1370
 * @param hostname the buffer for the host name
1371
 * @param hostname_size the size of the hostname buffer
1372
 * @param port_ptr a pointer to store the port number in
1373
 * @param path the buffer for the path
1374
 * @param path_size the size of the path buffer
1375
 * @param url the URL to split
1376
 */
1377
void av_url_split(char *proto,         int proto_size,
1378
                  char *authorization, int authorization_size,
1379
                  char *hostname,      int hostname_size,
1380
                  int *port_ptr,
1381
                  char *path,          int path_size,
1382
                  const char *url);
1383

    
1384
/**
1385
 * Allocate the stream private data and write the stream header to an
1386
 * output media file.
1387
 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1388
 * but for some formats it might also be some other time base
1389
 *
1390
 * @param s media file handle
1391
 * @return 0 if OK, AVERROR_xxx on error
1392
 */
1393
int av_write_header(AVFormatContext *s);
1394

    
1395
/**
1396
 * Write a packet to an output media file.
1397
 *
1398
 * The packet shall contain one audio or video frame.
1399
 * The packet must be correctly interleaved according to the container
1400
 * specification, if not then av_interleaved_write_frame must be used.
1401
 *
1402
 * @param s media file handle
1403
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1404
              dts/pts, ...
1405
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1406
 */
1407
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1408

    
1409
/**
1410
 * Write a packet to an output media file ensuring correct interleaving.
1411
 *
1412
 * The packet must contain one audio or video frame.
1413
 * If the packets are already correctly interleaved, the application should
1414
 * call av_write_frame() instead as it is slightly faster. It is also important
1415
 * to keep in mind that completely non-interleaved input will need huge amounts
1416
 * of memory to interleave with this, so it is preferable to interleave at the
1417
 * demuxer level.
1418
 *
1419
 * @param s media file handle
1420
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1421
              dts/pts, ...
1422
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1423
 */
1424
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1425

    
1426
/**
1427
 * Interleave a packet per dts in an output media file.
1428
 *
1429
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1430
 * function, so they cannot be used after it. Note that calling av_free_packet()
1431
 * on them is still safe.
1432
 *
1433
 * @param s media file handle
1434
 * @param out the interleaved packet will be output here
1435
 * @param pkt the input packet
1436
 * @param flush 1 if no further packets are available as input and all
1437
 *              remaining packets should be output
1438
 * @return 1 if a packet was output, 0 if no packet could be output,
1439
 *         < 0 if an error occurred
1440
 */
1441
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1442
                                 AVPacket *pkt, int flush);
1443

    
1444
/**
1445
 * Write the stream trailer to an output media file and free the
1446
 * file private data.
1447
 *
1448
 * May only be called after a successful call to av_write_header.
1449
 *
1450
 * @param s media file handle
1451
 * @return 0 if OK, AVERROR_xxx on error
1452
 */
1453
int av_write_trailer(AVFormatContext *s);
1454

    
1455
#if FF_API_DUMP_FORMAT
1456
attribute_deprecated void dump_format(AVFormatContext *ic,
1457
                                      int index,
1458
                                      const char *url,
1459
                                      int is_output);
1460
#endif
1461

    
1462
void av_dump_format(AVFormatContext *ic,
1463
                    int index,
1464
                    const char *url,
1465
                    int is_output);
1466

    
1467
#if FF_API_PARSE_FRAME_PARAM
1468
/**
1469
 * Parse width and height out of string str.
1470
 * @deprecated Use av_parse_video_frame_size instead.
1471
 */
1472
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1473
                                          const char *str);
1474

    
1475
/**
1476
 * Convert framerate from a string to a fraction.
1477
 * @deprecated Use av_parse_video_frame_rate instead.
1478
 */
1479
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1480
                                          const char *arg);
1481
#endif
1482

    
1483
#if FF_API_PARSE_DATE
1484
/**
1485
 * Parse datestr and return a corresponding number of microseconds.
1486
 *
1487
 * @param datestr String representing a date or a duration.
1488
 * See av_parse_time() for the syntax of the provided string.
1489
 * @deprecated in favor of av_parse_time()
1490
 */
1491
attribute_deprecated
1492
int64_t parse_date(const char *datestr, int duration);
1493
#endif
1494

    
1495
/**
1496
 * Get the current time in microseconds.
1497
 */
1498
int64_t av_gettime(void);
1499

    
1500
/* ffm-specific for ffserver */
1501
#define FFM_PACKET_SIZE 4096
1502
int64_t ffm_read_write_index(int fd);
1503
int ffm_write_write_index(int fd, int64_t pos);
1504
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1505

    
1506
#if FF_API_FIND_INFO_TAG
1507
/**
1508
 * @deprecated use av_find_info_tag in libavutil instead.
1509
 */
1510
attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1511
#endif
1512

    
1513
/**
1514
 * Return in 'buf' the path with '%d' replaced by a number.
1515
 *
1516
 * Also handles the '%0nd' format where 'n' is the total number
1517
 * of digits and '%%'.
1518
 *
1519
 * @param buf destination buffer
1520
 * @param buf_size destination buffer size
1521
 * @param path numbered sequence string
1522
 * @param number frame number
1523
 * @return 0 if OK, -1 on format error
1524
 */
1525
int av_get_frame_filename(char *buf, int buf_size,
1526
                          const char *path, int number);
1527

    
1528
/**
1529
 * Check whether filename actually is a numbered sequence generator.
1530
 *
1531
 * @param filename possible numbered sequence string
1532
 * @return 1 if a valid numbered sequence string, 0 otherwise
1533
 */
1534
int av_filename_number_test(const char *filename);
1535

    
1536
/**
1537
 * Generate an SDP for an RTP session.
1538
 *
1539
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1540
 *           array is composed by only one context, such context can contain
1541
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1542
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1543
 *           must contain only one AVStream.
1544
 * @param n_files number of AVCodecContexts contained in ac
1545
 * @param buff buffer where the SDP will be stored (must be allocated by
1546
 *             the caller)
1547
 * @param size the size of the buffer
1548
 * @return 0 if OK, AVERROR_xxx on error
1549
 */
1550
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1551

    
1552
/**
1553
 * Return a positive value if the given filename has one of the given
1554
 * extensions, 0 otherwise.
1555
 *
1556
 * @param extensions a comma-separated list of filename extensions
1557
 */
1558
int av_match_ext(const char *filename, const char *extensions);
1559

    
1560
#endif /* AVFORMAT_AVFORMAT_H */