Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 03700d39

History | View | Annotate | Download (54.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
#define LIBAVFORMAT_VERSION_MAJOR 52
25
#define LIBAVFORMAT_VERSION_MINOR 83
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
 * date         -- date when the work was created, preferably in ISO 8601.
152
 * disc         -- number of a subset, e.g. disc in a multi-disc collection.
153
 * encoder      -- name/settings of the software/hardware that produced the file.
154
 * encoded_by   -- person/group who created the file.
155
 * filename     -- original name of the file.
156
 * genre        -- <self-evident>.
157
 * language     -- main language in which the work is performed, preferably
158
 *                 in ISO 639-2 format.
159
 * performer    -- artist who performed the work, if different from artist.
160
 *                 E.g for "Also sprach Zarathustra", artist would be "Richard
161
 *                 Strauss" and performer "London Philharmonic Orchestra".
162
 * publisher    -- name of the label/publisher.
163
 * title        -- name of the work.
164
 * track        -- number of this work in the set, can be in form current/total.
165
 */
166

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

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

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

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

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

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

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

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

    
233

    
234
/* packet functions */
235

    
236

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

    
247

    
248
/*************************************************/
249
/* fractional numbers for exact pts handling */
250

    
251
/**
252
 * The exact value of the fractional number is: 'val + num / den'.
253
 * num is assumed to be 0 <= num < den.
254
 */
255
typedef struct AVFrac {
256
    int64_t val, num, den;
257
} AVFrac;
258

    
259
/*************************************************/
260
/* input/output formats */
261

    
262
struct AVCodecTag;
263

    
264
/**
265
 * This structure contains the data a format has to probe a file.
266
 */
267
typedef struct AVProbeData {
268
    const char *filename;
269
    unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
270
    int buf_size;       /**< Size of buf except extra allocated bytes */
271
} AVProbeData;
272

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

    
276
typedef struct AVFormatParameters {
277
    AVRational time_base;
278
    int sample_rate;
279
    int channels;
280
    int width;
281
    int height;
282
    enum PixelFormat pix_fmt;
283
    int channel; /**< Used to select DV channel. */
284
    const char *standard; /**< TV standard, NTSC, PAL, SECAM */
285
    unsigned int mpeg2ts_raw:1;  /**< Force raw MPEG-2 transport stream output, if possible. */
286
    unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
287
                                            stream packet (only meaningful if
288
                                            mpeg2ts_raw is TRUE). */
289
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
290
                                            immediately (RTSP only). */
291
    unsigned int prealloced_context:1;
292
#if FF_API_PARAMETERS_CODEC_ID
293
    attribute_deprecated enum CodecID video_codec_id;
294
    attribute_deprecated enum CodecID audio_codec_id;
295
#endif
296
} AVFormatParameters;
297

    
298
//! Demuxer will use url_fopen, no opened file should be provided by the caller.
299
#define AVFMT_NOFILE        0x0001
300
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
301
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
302
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
303
                                      raw picture data. */
304
#define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
305
#define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
306
#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
307
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. */
308
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
309
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
310

    
311
typedef struct AVOutputFormat {
312
    const char *name;
313
    /**
314
     * Descriptive name for the format, meant to be more human-readable
315
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
316
     * to define it.
317
     */
318
    const char *long_name;
319
    const char *mime_type;
320
    const char *extensions; /**< comma-separated filename extensions */
321
    /**
322
     * size of private data so that it can be allocated in the wrapper
323
     */
324
    int priv_data_size;
325
    /* output support */
326
    enum CodecID audio_codec; /**< default audio codec */
327
    enum CodecID video_codec; /**< default video codec */
328
    int (*write_header)(struct AVFormatContext *);
329
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
330
    int (*write_trailer)(struct AVFormatContext *);
331
    /**
332
     * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER
333
     */
334
    int flags;
335
    /**
336
     * Currently only used to set pixel format if not YUV420P.
337
     */
338
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
339
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
340
                             AVPacket *in, int flush);
341

    
342
    /**
343
     * List of supported codec_id-codec_tag pairs, ordered by "better
344
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
345
     */
346
    const struct AVCodecTag * const *codec_tag;
347

    
348
    enum CodecID subtitle_codec; /**< default subtitle codec */
349

    
350
#if FF_API_OLD_METADATA
351
    const AVMetadataConv *metadata_conv;
352
#endif
353

    
354
    /* private fields */
355
    struct AVOutputFormat *next;
356
} AVOutputFormat;
357

    
358
typedef struct AVInputFormat {
359
    /**
360
     * A comma separated list of short names for the format. New names
361
     * may be appended with a minor bump.
362
     */
363
    const char *name;
364

    
365
    /**
366
     * Descriptive name for the format, meant to be more human-readable
367
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
368
     * to define it.
369
     */
370
    const char *long_name;
371

    
372
    /**
373
     * Size of private data so that it can be allocated in the wrapper.
374
     */
375
    int priv_data_size;
376

    
377
    /**
378
     * Tell if a given file has a chance of being parsed as this format.
379
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
380
     * big so you do not have to check for that unless you need more.
381
     */
382
    int (*read_probe)(AVProbeData *);
383

    
384
    /**
385
     * Read the format header and initialize the AVFormatContext
386
     * structure. Return 0 if OK. 'ap' if non-NULL contains
387
     * additional parameters. Only used in raw format right
388
     * now. 'av_new_stream' should be called to create new streams.
389
     */
390
    int (*read_header)(struct AVFormatContext *,
391
                       AVFormatParameters *ap);
392

    
393
    /**
394
     * Read one packet and put it in 'pkt'. pts and flags are also
395
     * set. 'av_new_stream' can be called only if the flag
396
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
397
     * background thread).
398
     * @return 0 on success, < 0 on error.
399
     *         When returning an error, pkt must not have been allocated
400
     *         or must be freed before returning
401
     */
402
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
403

    
404
    /**
405
     * Close the stream. The AVFormatContext and AVStreams are not
406
     * freed by this function
407
     */
408
    int (*read_close)(struct AVFormatContext *);
409

    
410
#if FF_API_READ_SEEK
411
    /**
412
     * Seek to a given timestamp relative to the frames in
413
     * stream component stream_index.
414
     * @param stream_index Must not be -1.
415
     * @param flags Selects which direction should be preferred if no exact
416
     *              match is available.
417
     * @return >= 0 on success (but not necessarily the new offset)
418
     */
419
    attribute_deprecated int (*read_seek)(struct AVFormatContext *,
420
                                          int stream_index, int64_t timestamp, int flags);
421
#endif
422
    /**
423
     * Gets the next timestamp in stream[stream_index].time_base units.
424
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
425
     */
426
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
427
                              int64_t *pos, int64_t pos_limit);
428

    
429
    /**
430
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
431
     */
432
    int flags;
433

    
434
    /**
435
     * If extensions are defined, then no probe is done. You should
436
     * usually not use extension format guessing because it is not
437
     * reliable enough
438
     */
439
    const char *extensions;
440

    
441
    /**
442
     * General purpose read-only value that the format can use.
443
     */
444
    int value;
445

    
446
    /**
447
     * Start/resume playing - only meaningful if using a network-based format
448
     * (RTSP).
449
     */
450
    int (*read_play)(struct AVFormatContext *);
451

    
452
    /**
453
     * Pause playing - only meaningful if using a network-based format
454
     * (RTSP).
455
     */
456
    int (*read_pause)(struct AVFormatContext *);
457

    
458
    const struct AVCodecTag * const *codec_tag;
459

    
460
    /**
461
     * Seek to timestamp ts.
462
     * Seeking will be done so that the point from which all active streams
463
     * can be presented successfully will be closest to ts and within min/max_ts.
464
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
465
     */
466
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
467

    
468
#if FF_API_OLD_METADATA
469
    const AVMetadataConv *metadata_conv;
470
#endif
471

    
472
    /* private fields */
473
    struct AVInputFormat *next;
474
} AVInputFormat;
475

    
476
enum AVStreamParseType {
477
    AVSTREAM_PARSE_NONE,
478
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
479
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
480
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
481
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
482
};
483

    
484
typedef struct AVIndexEntry {
485
    int64_t pos;
486
    int64_t timestamp;
487
#define AVINDEX_KEYFRAME 0x0001
488
    int flags:2;
489
    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).
490
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
491
} AVIndexEntry;
492

    
493
#define AV_DISPOSITION_DEFAULT   0x0001
494
#define AV_DISPOSITION_DUB       0x0002
495
#define AV_DISPOSITION_ORIGINAL  0x0004
496
#define AV_DISPOSITION_COMMENT   0x0008
497
#define AV_DISPOSITION_LYRICS    0x0010
498
#define AV_DISPOSITION_KARAOKE   0x0020
499

    
500
/**
501
 * Track should be used during playback by default.
502
 * Useful for subtitle track that should be displayed
503
 * even when user did not explicitly ask for subtitles.
504
 */
505
#define AV_DISPOSITION_FORCED    0x0040
506

    
507
/**
508
 * Stream structure.
509
 * New fields can be added to the end with minor version bumps.
510
 * Removal, reordering and changes to existing fields require a major
511
 * version bump.
512
 * sizeof(AVStream) must not be used outside libav*.
513
 */
514
typedef struct AVStream {
515
    int index;    /**< stream index in AVFormatContext */
516
    int id;       /**< format-specific stream ID */
517
    AVCodecContext *codec; /**< codec context */
518
    /**
519
     * Real base framerate of the stream.
520
     * This is the lowest framerate with which all timestamps can be
521
     * represented accurately (it is the least common multiple of all
522
     * framerates in the stream). Note, this value is just a guess!
523
     * For example, if the time base is 1/90000 and all frames have either
524
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
525
     */
526
    AVRational r_frame_rate;
527
    void *priv_data;
528

    
529
    /* internal data used in av_find_stream_info() */
530
    int64_t first_dts;
531

    
532
    /**
533
     * encoding: pts generation when outputting stream
534
     */
535
    struct AVFrac pts;
536

    
537
    /**
538
     * This is the fundamental unit of time (in seconds) in terms
539
     * of which frame timestamps are represented. For fixed-fps content,
540
     * time base should be 1/framerate and timestamp increments should be 1.
541
     */
542
    AVRational time_base;
543
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
544
    /* ffmpeg.c private use */
545
    int stream_copy; /**< If set, just copy stream. */
546
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
547

    
548
    //FIXME move stuff to a flags field?
549
    /**
550
     * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
551
     * MN: dunno if that is the right place for it
552
     */
553
    float quality;
554

    
555
    /**
556
     * Decoding: pts of the first frame of the stream, in stream time base.
557
     * Only set this if you are absolutely 100% sure that the value you set
558
     * it to really is the pts of the first frame.
559
     * This may be undefined (AV_NOPTS_VALUE).
560
     * @note The ASF header does NOT contain a correct start_time the ASF
561
     * demuxer must NOT set this.
562
     */
563
    int64_t start_time;
564

    
565
    /**
566
     * Decoding: duration of the stream, in stream time base.
567
     * If a source file does not specify a duration, but does specify
568
     * a bitrate, this value will be estimated from bitrate and file size.
569
     */
570
    int64_t duration;
571

    
572
#if FF_API_OLD_METADATA
573
    attribute_deprecated char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
574
#endif
575

    
576
    /* av_read_frame() support */
577
    enum AVStreamParseType need_parsing;
578
    struct AVCodecParserContext *parser;
579

    
580
    int64_t cur_dts;
581
    int last_IP_duration;
582
    int64_t last_IP_pts;
583
    /* av_seek_frame() support */
584
    AVIndexEntry *index_entries; /**< Only used if the format does not
585
                                    support seeking natively. */
586
    int nb_index_entries;
587
    unsigned int index_entries_allocated_size;
588

    
589
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
590

    
591
#if FF_API_LAVF_UNUSED
592
    attribute_deprecated int64_t unused[4+1];
593
#endif
594

    
595
#if FF_API_OLD_METADATA
596
    attribute_deprecated char *filename; /**< source filename of the stream */
597
#endif
598

    
599
    int disposition; /**< AV_DISPOSITION_* bit field */
600

    
601
    AVProbeData probe_data;
602
#define MAX_REORDER_DELAY 16
603
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
604

    
605
    /**
606
     * sample aspect ratio (0 if unknown)
607
     * - encoding: Set by user.
608
     * - decoding: Set by libavformat.
609
     */
610
    AVRational sample_aspect_ratio;
611

    
612
    AVMetadata *metadata;
613

    
614
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
615
    /* external applications; try to use something else if at all possible.    */
616
    const uint8_t *cur_ptr;
617
    int cur_len;
618
    AVPacket cur_pkt;
619

    
620
    // Timestamp generation support:
621
    /**
622
     * Timestamp corresponding to the last dts sync point.
623
     *
624
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
625
     * a DTS is received from the underlying container. Otherwise set to
626
     * AV_NOPTS_VALUE by default.
627
     */
628
    int64_t reference_dts;
629

    
630
    /**
631
     * Number of packets to buffer for codec probing
632
     * NOT PART OF PUBLIC API
633
     */
634
#define MAX_PROBE_PACKETS 2500
635
    int probe_packets;
636

    
637
    /**
638
     * last packet in packet_buffer for this stream when muxing.
639
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
640
     */
641
    struct AVPacketList *last_in_packet_buffer;
642

    
643
    /**
644
     * Average framerate
645
     */
646
    AVRational avg_frame_rate;
647

    
648
    /**
649
     * Number of frames that have been demuxed during av_find_stream_info()
650
     */
651
    int codec_info_nb_frames;
652

    
653
    /**
654
     * Stream informations used internally by av_find_stream_info()
655
     */
656
#define MAX_STD_TIMEBASES (60*12+5)
657
    struct {
658
        int64_t last_dts;
659
        int64_t duration_gcd;
660
        int duration_count;
661
        double duration_error[MAX_STD_TIMEBASES];
662
        int64_t codec_info_duration;
663
    } *info;
664
} AVStream;
665

    
666
#define AV_PROGRAM_RUNNING 1
667

    
668
/**
669
 * New fields can be added to the end with minor version bumps.
670
 * Removal, reordering and changes to existing fields require a major
671
 * version bump.
672
 * sizeof(AVProgram) must not be used outside libav*.
673
 */
674
typedef struct AVProgram {
675
    int            id;
676
#if FF_API_OLD_METADATA
677
    attribute_deprecated char           *provider_name; ///< network name for DVB streams
678
    attribute_deprecated char           *name;          ///< service name for DVB streams
679
#endif
680
    int            flags;
681
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
682
    unsigned int   *stream_index;
683
    unsigned int   nb_stream_indexes;
684
    AVMetadata *metadata;
685
} AVProgram;
686

    
687
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
688
                                         (streams are added dynamically) */
689

    
690
typedef struct AVChapter {
691
    int id;                 ///< unique ID to identify the chapter
692
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
693
    int64_t start, end;     ///< chapter start/end time in time_base units
694
#if FF_API_OLD_METADATA
695
    attribute_deprecated char *title;            ///< chapter title
696
#endif
697
    AVMetadata *metadata;
698
} AVChapter;
699

    
700
#if FF_API_MAX_STREAMS
701
#define MAX_STREAMS 20
702
#endif
703

    
704
/**
705
 * Format I/O context.
706
 * New fields can be added to the end with minor version bumps.
707
 * Removal, reordering and changes to existing fields require a major
708
 * version bump.
709
 * sizeof(AVFormatContext) must not be used outside libav*.
710
 */
711
typedef struct AVFormatContext {
712
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
713
    /* Can only be iformat or oformat, not both at the same time. */
714
    struct AVInputFormat *iformat;
715
    struct AVOutputFormat *oformat;
716
    void *priv_data;
717
    ByteIOContext *pb;
718
    unsigned int nb_streams;
719
#if FF_API_MAX_STREAMS
720
    AVStream *streams[MAX_STREAMS];
721
#else
722
    AVStream **streams;
723
#endif
724
    char filename[1024]; /**< input or output filename */
725
    /* stream info */
726
    int64_t timestamp;
727
#if FF_API_OLD_METADATA
728
    attribute_deprecated char title[512];
729
    attribute_deprecated char author[512];
730
    attribute_deprecated char copyright[512];
731
    attribute_deprecated char comment[512];
732
    attribute_deprecated char album[512];
733
    attribute_deprecated int year;  /**< ID3 year, 0 if none */
734
    attribute_deprecated int track; /**< track number, 0 if none */
735
    attribute_deprecated char genre[32]; /**< ID3 genre */
736
#endif
737

    
738
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
739
    /* private data for pts handling (do not modify directly). */
740
    /**
741
     * This buffer is only needed when packets were already buffered but
742
     * not decoded, for example to get the codec parameters in MPEG
743
     * streams.
744
     */
745
    struct AVPacketList *packet_buffer;
746

    
747
    /**
748
     * Decoding: position of the first frame of the component, in
749
     * AV_TIME_BASE fractional seconds. NEVER set this value directly:
750
     * It is deduced from the AVStream values.
751
     */
752
    int64_t start_time;
753

    
754
    /**
755
     * Decoding: duration of the stream, in AV_TIME_BASE fractional
756
     * seconds. Only set this value if you know none of the individual stream
757
     * durations and also dont set any of them. This is deduced from the
758
     * AVStream values if not set.
759
     */
760
    int64_t duration;
761

    
762
    /**
763
     * decoding: total file size, 0 if unknown
764
     */
765
    int64_t file_size;
766

    
767
    /**
768
     * Decoding: total stream bitrate in bit/s, 0 if not
769
     * available. Never set it directly if the file_size and the
770
     * duration are known as FFmpeg can compute it automatically.
771
     */
772
    int bit_rate;
773

    
774
    /* av_read_frame() support */
775
    AVStream *cur_st;
776
#if FF_API_LAVF_UNUSED
777
    const uint8_t *cur_ptr_deprecated;
778
    int cur_len_deprecated;
779
    AVPacket cur_pkt_deprecated;
780
#endif
781

    
782
    /* av_seek_frame() support */
783
    int64_t data_offset; /**< offset of the first packet */
784
    int index_built;
785

    
786
    int mux_rate;
787
    unsigned int packet_size;
788
    int preload;
789
    int max_delay;
790

    
791
#define AVFMT_NOOUTPUTLOOP -1
792
#define AVFMT_INFINITEOUTPUTLOOP 0
793
    /**
794
     * number of times to loop output in formats that support it
795
     */
796
    int loop_output;
797

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

    
807
    int loop_input;
808

    
809
    /**
810
     * decoding: size of data to probe; encoding: unused.
811
     */
812
    unsigned int probesize;
813

    
814
    /**
815
     * Maximum time (in AV_TIME_BASE units) during which the input should
816
     * be analyzed in av_find_stream_info().
817
     */
818
    int max_analyze_duration;
819

    
820
    const uint8_t *key;
821
    int keylen;
822

    
823
    unsigned int nb_programs;
824
    AVProgram **programs;
825

    
826
    /**
827
     * Forced video codec_id.
828
     * Demuxing: Set by user.
829
     */
830
    enum CodecID video_codec_id;
831

    
832
    /**
833
     * Forced audio codec_id.
834
     * Demuxing: Set by user.
835
     */
836
    enum CodecID audio_codec_id;
837

    
838
    /**
839
     * Forced subtitle codec_id.
840
     * Demuxing: Set by user.
841
     */
842
    enum CodecID subtitle_codec_id;
843

    
844
    /**
845
     * Maximum amount of memory in bytes to use for the index of each stream.
846
     * If the index exceeds this size, entries will be discarded as
847
     * needed to maintain a smaller size. This can lead to slower or less
848
     * accurate seeking (depends on demuxer).
849
     * Demuxers for which a full in-memory index is mandatory will ignore
850
     * this.
851
     * muxing  : unused
852
     * demuxing: set by user
853
     */
854
    unsigned int max_index_size;
855

    
856
    /**
857
     * Maximum amount of memory in bytes to use for buffering frames
858
     * obtained from realtime capture devices.
859
     */
860
    unsigned int max_picture_buffer;
861

    
862
    unsigned int nb_chapters;
863
    AVChapter **chapters;
864

    
865
    /**
866
     * Flags to enable debugging.
867
     */
868
    int debug;
869
#define FF_FDEBUG_TS        0x0001
870

    
871
    /**
872
     * Raw packets from the demuxer, prior to parsing and decoding.
873
     * This buffer is used for buffering packets until the codec can
874
     * be identified, as parsing cannot be done without knowing the
875
     * codec.
876
     */
877
    struct AVPacketList *raw_packet_buffer;
878
    struct AVPacketList *raw_packet_buffer_end;
879

    
880
    struct AVPacketList *packet_buffer_end;
881

    
882
    AVMetadata *metadata;
883

    
884
    /**
885
     * Remaining size available for raw_packet_buffer, in bytes.
886
     * NOT PART OF PUBLIC API
887
     */
888
#define RAW_PACKET_BUFFER_SIZE 2500000
889
    int raw_packet_buffer_remaining_size;
890

    
891
    /**
892
     * Start time of the stream in real world time, in microseconds
893
     * since the unix epoch (00:00 1st January 1970). That is, pts=0
894
     * in the stream was captured at this real world time.
895
     * - encoding: Set by user.
896
     * - decoding: Unused.
897
     */
898
    int64_t start_time_realtime;
899
} AVFormatContext;
900

    
901
typedef struct AVPacketList {
902
    AVPacket pkt;
903
    struct AVPacketList *next;
904
} AVPacketList;
905

    
906
#if FF_API_FIRST_FORMAT
907
attribute_deprecated extern AVInputFormat *first_iformat;
908
attribute_deprecated extern AVOutputFormat *first_oformat;
909
#endif
910

    
911
/**
912
 * If f is NULL, returns the first registered input format,
913
 * if f is non-NULL, returns the next registered input format after f
914
 * or NULL if f is the last one.
915
 */
916
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
917

    
918
/**
919
 * If f is NULL, returns the first registered output format,
920
 * if f is non-NULL, returns the next registered output format after f
921
 * or NULL if f is the last one.
922
 */
923
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
924

    
925
enum CodecID av_guess_image2_codec(const char *filename);
926

    
927
/* XXX: Use automatic init with either ELF sections or C file parser */
928
/* modules. */
929

    
930
/* utils.c */
931
void av_register_input_format(AVInputFormat *format);
932
void av_register_output_format(AVOutputFormat *format);
933
#if FF_API_GUESS_FORMAT
934
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
935
                                    const char *filename,
936
                                    const char *mime_type);
937

    
938
/**
939
 * @deprecated Use av_guess_format() instead.
940
 */
941
attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
942
                                                  const char *filename,
943
                                                  const char *mime_type);
944
#endif
945

    
946
/**
947
 * Return the output format in the list of registered output formats
948
 * which best matches the provided parameters, or return NULL if
949
 * there is no match.
950
 *
951
 * @param short_name if non-NULL checks if short_name matches with the
952
 * names of the registered formats
953
 * @param filename if non-NULL checks if filename terminates with the
954
 * extensions of the registered formats
955
 * @param mime_type if non-NULL checks if mime_type matches with the
956
 * MIME type of the registered formats
957
 */
958
AVOutputFormat *av_guess_format(const char *short_name,
959
                                const char *filename,
960
                                const char *mime_type);
961

    
962
/**
963
 * Guess the codec ID based upon muxer and filename.
964
 */
965
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
966
                            const char *filename, const char *mime_type,
967
                            enum AVMediaType type);
968

    
969
/**
970
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
971
 *
972
 * @param f The file stream pointer where the dump should be sent to.
973
 * @param buf buffer
974
 * @param size buffer size
975
 *
976
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
977
 */
978
void av_hex_dump(FILE *f, uint8_t *buf, int size);
979

    
980
/**
981
 * Send a nice hexadecimal dump of a buffer to the log.
982
 *
983
 * @param avcl A pointer to an arbitrary struct of which the first field is a
984
 * pointer to an AVClass struct.
985
 * @param level The importance level of the message, lower values signifying
986
 * higher importance.
987
 * @param buf buffer
988
 * @param size buffer size
989
 *
990
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
991
 */
992
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
993

    
994
/**
995
 * Send a nice dump of a packet to the specified file stream.
996
 *
997
 * @param f The file stream pointer where the dump should be sent to.
998
 * @param pkt packet to dump
999
 * @param dump_payload True if the payload must be displayed, too.
1000
 */
1001
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
1002

    
1003
/**
1004
 * Send a nice dump of a packet to the log.
1005
 *
1006
 * @param avcl A pointer to an arbitrary struct of which the first field is a
1007
 * pointer to an AVClass struct.
1008
 * @param level The importance level of the message, lower values signifying
1009
 * higher importance.
1010
 * @param pkt packet to dump
1011
 * @param dump_payload True if the payload must be displayed, too.
1012
 */
1013
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
1014

    
1015
/**
1016
 * Initialize libavformat and register all the muxers, demuxers and
1017
 * protocols. If you do not call this function, then you can select
1018
 * exactly which formats you want to support.
1019
 *
1020
 * @see av_register_input_format()
1021
 * @see av_register_output_format()
1022
 * @see av_register_protocol()
1023
 */
1024
void av_register_all(void);
1025

    
1026
/**
1027
 * Get the CodecID for the given codec tag tag.
1028
 * If no codec id is found returns CODEC_ID_NONE.
1029
 *
1030
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1031
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1032
 */
1033
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1034

    
1035
/**
1036
 * Get the codec tag for the given codec id id.
1037
 * If no codec tag is found returns 0.
1038
 *
1039
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1040
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1041
 */
1042
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1043

    
1044
/* media file input */
1045

    
1046
/**
1047
 * Find AVInputFormat based on the short name of the input format.
1048
 */
1049
AVInputFormat *av_find_input_format(const char *short_name);
1050

    
1051
/**
1052
 * Guess the file format.
1053
 *
1054
 * @param is_opened Whether the file is already opened; determines whether
1055
 *                  demuxers with or without AVFMT_NOFILE are probed.
1056
 */
1057
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1058

    
1059
/**
1060
 * Guess the file format.
1061
 *
1062
 * @param is_opened Whether the file is already opened; determines whether
1063
 *                  demuxers with or without AVFMT_NOFILE are probed.
1064
 * @param score_max A probe score larger that this is required to accept a
1065
 *                  detection, the variable is set to the actual detection
1066
 *                  score afterwards.
1067
 *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1068
 *                  to retry with a larger probe buffer.
1069
 */
1070
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1071

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

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

    
1097
#if FF_API_ALLOC_FORMAT_CONTEXT
1098
/**
1099
 * @deprecated Use avformat_alloc_context() instead.
1100
 */
1101
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1102
#endif
1103

    
1104
/**
1105
 * Allocate an AVFormatContext.
1106
 * Can be freed with av_free() but do not forget to free everything you
1107
 * explicitly allocated as well!
1108
 */
1109
AVFormatContext *avformat_alloc_context(void);
1110

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

    
1126
/**
1127
 * Read a transport packet from a media file.
1128
 *
1129
 * This function is obsolete and should never be used.
1130
 * Use av_read_frame() instead.
1131
 *
1132
 * @param s media file handle
1133
 * @param pkt is filled
1134
 * @return 0 if OK, AVERROR_xxx on error
1135
 */
1136
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1137

    
1138
/**
1139
 * Return the next frame of a stream.
1140
 * This function returns what is stored in the file, and does not validate
1141
 * that what is there are valid frames for the decoder. It will split what is
1142
 * stored in the file into frames and return one for each call. It will not
1143
 * omit invalid data between valid frames so as to give the decoder the maximum
1144
 * information possible for decoding.
1145
 *
1146
 * The returned packet is valid
1147
 * until the next av_read_frame() or until av_close_input_file() and
1148
 * must be freed with av_free_packet. For video, the packet contains
1149
 * exactly one frame. For audio, it contains an integer number of
1150
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1151
 * data). If the audio frames have a variable size (e.g. MPEG audio),
1152
 * then it contains one frame.
1153
 *
1154
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1155
 * values in AVStream.time_base units (and guessed if the format cannot
1156
 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1157
 * has B-frames, so it is better to rely on pkt->dts if you do not
1158
 * decompress the payload.
1159
 *
1160
 * @return 0 if OK, < 0 on error or end of file
1161
 */
1162
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1163

    
1164
/**
1165
 * Seek to the keyframe at timestamp.
1166
 * 'timestamp' in 'stream_index'.
1167
 * @param stream_index If stream_index is (-1), a default
1168
 * stream is selected, and timestamp is automatically converted
1169
 * from AV_TIME_BASE units to the stream specific time_base.
1170
 * @param timestamp Timestamp in AVStream.time_base units
1171
 *        or, if no stream is specified, in AV_TIME_BASE units.
1172
 * @param flags flags which select direction and seeking mode
1173
 * @return >= 0 on success
1174
 */
1175
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1176
                  int flags);
1177

    
1178
/**
1179
 * Seek to timestamp ts.
1180
 * Seeking will be done so that the point from which all active streams
1181
 * can be presented successfully will be closest to ts and within min/max_ts.
1182
 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1183
 *
1184
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1185
 * are the file position (this may not be supported by all demuxers).
1186
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1187
 * in the stream with stream_index (this may not be supported by all demuxers).
1188
 * Otherwise all timestamps are in units of the stream selected by stream_index
1189
 * or if stream_index is -1, in AV_TIME_BASE units.
1190
 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1191
 * keyframes (this may not be supported by all demuxers).
1192
 *
1193
 * @param stream_index index of the stream which is used as time base reference
1194
 * @param min_ts smallest acceptable timestamp
1195
 * @param ts target timestamp
1196
 * @param max_ts largest acceptable timestamp
1197
 * @param flags flags
1198
 * @return >=0 on success, error code otherwise
1199
 *
1200
 * @note This is part of the new seek API which is still under construction.
1201
 *       Thus do not use this yet. It may change at any time, do not expect
1202
 *       ABI compatibility yet!
1203
 */
1204
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1205

    
1206
/**
1207
 * Start playing a network-based stream (e.g. RTSP stream) at the
1208
 * current position.
1209
 */
1210
int av_read_play(AVFormatContext *s);
1211

    
1212
/**
1213
 * Pause a network-based stream (e.g. RTSP stream).
1214
 *
1215
 * Use av_read_play() to resume it.
1216
 */
1217
int av_read_pause(AVFormatContext *s);
1218

    
1219
/**
1220
 * Free a AVFormatContext allocated by av_open_input_stream.
1221
 * @param s context to free
1222
 */
1223
void av_close_input_stream(AVFormatContext *s);
1224

    
1225
/**
1226
 * Close a media file (but not its codecs).
1227
 *
1228
 * @param s media file handle
1229
 */
1230
void av_close_input_file(AVFormatContext *s);
1231

    
1232
/**
1233
 * Add a new stream to a media file.
1234
 *
1235
 * Can only be called in the read_header() function. If the flag
1236
 * AVFMTCTX_NOHEADER is in the format context, then new streams
1237
 * can be added in read_packet too.
1238
 *
1239
 * @param s media file handle
1240
 * @param id file-format-dependent stream ID
1241
 */
1242
AVStream *av_new_stream(AVFormatContext *s, int id);
1243
AVProgram *av_new_program(AVFormatContext *s, int id);
1244

    
1245
/**
1246
 * Add a new chapter.
1247
 * This function is NOT part of the public API
1248
 * and should ONLY be used by demuxers.
1249
 *
1250
 * @param s media file handle
1251
 * @param id unique ID for this chapter
1252
 * @param start chapter start time in time_base units
1253
 * @param end chapter end time in time_base units
1254
 * @param title chapter title
1255
 *
1256
 * @return AVChapter or NULL on error
1257
 */
1258
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1259
                          int64_t start, int64_t end, const char *title);
1260

    
1261
/**
1262
 * Set the pts for a given stream.
1263
 *
1264
 * @param s stream
1265
 * @param pts_wrap_bits number of bits effectively used by the pts
1266
 *        (used for wrap control, 33 is the value for MPEG)
1267
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1268
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1269
 */
1270
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1271
                     unsigned int pts_num, unsigned int pts_den);
1272

    
1273
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1274
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1275
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1276
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1277

    
1278
int av_find_default_stream_index(AVFormatContext *s);
1279

    
1280
/**
1281
 * Get the index for a specific timestamp.
1282
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1283
 *                 to the timestamp which is <= the requested one, if backward
1284
 *                 is 0, then it will be >=
1285
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1286
 * @return < 0 if no such timestamp could be found
1287
 */
1288
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1289

    
1290
/**
1291
 * Ensure the index uses less memory than the maximum specified in
1292
 * AVFormatContext.max_index_size by discarding entries if it grows
1293
 * too large.
1294
 * This function is not part of the public API and should only be called
1295
 * by demuxers.
1296
 */
1297
void ff_reduce_index(AVFormatContext *s, int stream_index);
1298

    
1299
/**
1300
 * Add an index entry into a sorted list. Update the entry if the list
1301
 * already contains it.
1302
 *
1303
 * @param timestamp timestamp in the time base of the given stream
1304
 */
1305
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1306
                       int size, int distance, int flags);
1307

    
1308
/**
1309
 * Perform a binary search using av_index_search_timestamp() and
1310
 * AVInputFormat.read_timestamp().
1311
 * This is not supposed to be called directly by a user application,
1312
 * but by demuxers.
1313
 * @param target_ts target timestamp in the time base of the given stream
1314
 * @param stream_index stream number
1315
 */
1316
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1317
                         int64_t target_ts, int flags);
1318

    
1319
/**
1320
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1321
 *
1322
 * Stream ref_st unchanged, others set cur_dts in their native time base.
1323
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1324
 * @param timestamp new dts expressed in time_base of param ref_st
1325
 * @param ref_st reference stream giving time_base of param timestamp
1326
 */
1327
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1328

    
1329
/**
1330
 * Perform a binary search using read_timestamp().
1331
 * This is not supposed to be called directly by a user application,
1332
 * but by demuxers.
1333
 * @param target_ts target timestamp in the time base of the given stream
1334
 * @param stream_index stream number
1335
 */
1336
int64_t av_gen_search(AVFormatContext *s, int stream_index,
1337
                      int64_t target_ts, int64_t pos_min,
1338
                      int64_t pos_max, int64_t pos_limit,
1339
                      int64_t ts_min, int64_t ts_max,
1340
                      int flags, int64_t *ts_ret,
1341
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1342

    
1343
/**
1344
 * media file output
1345
 */
1346
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1347

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

    
1374
/**
1375
 * Allocate the stream private data and write the stream header to an
1376
 * output media file.
1377
 *
1378
 * @param s media file handle
1379
 * @return 0 if OK, AVERROR_xxx on error
1380
 */
1381
int av_write_header(AVFormatContext *s);
1382

    
1383
/**
1384
 * Write a packet to an output media file.
1385
 *
1386
 * The packet shall contain one audio or video frame.
1387
 * The packet must be correctly interleaved according to the container
1388
 * specification, if not then av_interleaved_write_frame must be used.
1389
 *
1390
 * @param s media file handle
1391
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1392
              dts/pts, ...
1393
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1394
 */
1395
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1396

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

    
1414
/**
1415
 * Interleave a packet per dts in an output media file.
1416
 *
1417
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1418
 * function, so they cannot be used after it. Note that calling av_free_packet()
1419
 * on them is still safe.
1420
 *
1421
 * @param s media file handle
1422
 * @param out the interleaved packet will be output here
1423
 * @param pkt the input packet
1424
 * @param flush 1 if no further packets are available as input and all
1425
 *              remaining packets should be output
1426
 * @return 1 if a packet was output, 0 if no packet could be output,
1427
 *         < 0 if an error occurred
1428
 */
1429
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1430
                                 AVPacket *pkt, int flush);
1431

    
1432
/**
1433
 * Write the stream trailer to an output media file and free the
1434
 * file private data.
1435
 *
1436
 * May only be called after a successful call to av_write_header.
1437
 *
1438
 * @param s media file handle
1439
 * @return 0 if OK, AVERROR_xxx on error
1440
 */
1441
int av_write_trailer(AVFormatContext *s);
1442

    
1443
void dump_format(AVFormatContext *ic,
1444
                 int index,
1445
                 const char *url,
1446
                 int is_output);
1447

    
1448
#if FF_API_PARSE_FRAME_PARAM
1449
/**
1450
 * Parse width and height out of string str.
1451
 * @deprecated Use av_parse_video_frame_size instead.
1452
 */
1453
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1454
                                          const char *str);
1455

    
1456
/**
1457
 * Convert framerate from a string to a fraction.
1458
 * @deprecated Use av_parse_video_frame_rate instead.
1459
 */
1460
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1461
                                          const char *arg);
1462
#endif
1463

    
1464
/**
1465
 * Parse datestr and return a corresponding number of microseconds.
1466
 * @param datestr String representing a date or a duration.
1467
 * - If a date the syntax is:
1468
 * @code
1469
 *  now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]}
1470
 * @endcode
1471
 * If the value is "now" it takes the current time.
1472
 * Time is local time unless Z is appended, in which case it is
1473
 * interpreted as UTC.
1474
 * If the year-month-day part is not specified it takes the current
1475
 * year-month-day.
1476
 * @return the number of microseconds since 1st of January, 1970 up to
1477
 * the time of the parsed date or INT64_MIN if datestr cannot be
1478
 * successfully parsed.
1479
 * - If a duration the syntax is:
1480
 * @code
1481
 *  [-]HH[:MM[:SS[.m...]]]
1482
 *  [-]S+[.m...]
1483
 * @endcode
1484
 * @return the number of microseconds contained in a time interval
1485
 * with the specified duration or INT64_MIN if datestr cannot be
1486
 * successfully parsed.
1487
 * @param duration Flag which tells how to interpret datestr, if
1488
 * not zero datestr is interpreted as a duration, otherwise as a
1489
 * date.
1490
 */
1491
int64_t parse_date(const char *datestr, int duration);
1492

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

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

    
1504
/**
1505
 * Attempt to find a specific tag in a URL.
1506
 *
1507
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1508
 * Return 1 if found.
1509
 */
1510
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1511

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

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

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

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

    
1559
#endif /* AVFORMAT_AVFORMAT_H */