Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 198ac67f

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

    
61
/**
62
 * I return the LIBAVFORMAT_VERSION_INT constant.  You got
63
 * a fucking problem with that, douchebag?
64
 */
65
unsigned avformat_version(void);
66

    
67
/**
68
 * Return the libavformat build-time configuration.
69
 */
70
const char *avformat_configuration(void);
71

    
72
/**
73
 * Return the libavformat license.
74
 */
75
const char *avformat_license(void);
76

    
77
#include <time.h>
78
#include <stdio.h>  /* FILE */
79
#include "libavcodec/avcodec.h"
80

    
81
#include "avio.h"
82

    
83
struct AVFormatContext;
84

    
85

    
86
/*
87
 * Public Metadata API.
88
 * The metadata API allows libavformat to export metadata tags to a client
89
 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
90
 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
91
 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
92
 * Important concepts to keep in mind:
93
 * 1. Keys are unique; there can never be 2 tags with the same key. This is
94
 *    also meant semantically, i.e., a demuxer should not knowingly produce
95
 *    several keys that are literally different but semantically identical.
96
 *    E.g., key=Author5, key=Author6. In this example, all authors must be
97
 *    placed in the same tag.
98
 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
99
 *    want to store, e.g., the email address of the child of producer Alice
100
 *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
101
 * 3. Several modifiers can be applied to the tag name. This is done by
102
 *    appending a dash character ('-') and the modifier name in the order
103
 *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
104
 *    a) language -- a tag whose value is localized for a particular language
105
 *       is appended with the ISO 639-2/B 3-letter language code.
106
 *       For example: Author-ger=Michael, Author-eng=Mike
107
 *       The original/default language is in the unqualified "Author" tag.
108
 *       A demuxer should set a default if it sets any translated tag.
109
 *    b) sorting  -- a modified version of a tag that should be used for
110
 *       sorting will have '-sort' appended. E.g. artist="The Beatles",
111
 *       artist-sort="Beatles, The".
112
 *
113
 * 4. Tag names are normally exported exactly as stored in the container to
114
 *    allow lossless remuxing to the same format. For container-independent
115
 *    handling of metadata, av_metadata_conv() can convert it to ffmpeg generic
116
 *    format. Follows a list of generic tag names:
117
 *
118
 * album        -- name of the set this work belongs to
119
 * album_artist -- main creator of the set/album, if different from artist.
120
 *                 e.g. "Various Artists" for compilation albums.
121
 * artist       -- main creator of the work
122
 * comment      -- any additional description of the file.
123
 * composer     -- who composed the work, if different from artist.
124
 * copyright    -- name of copyright holder.
125
 * date         -- date when the work was created, preferably in ISO 8601.
126
 * disc         -- number of a subset, e.g. disc in a multi-disc collection.
127
 * encoder      -- name/settings of the software/hardware that produced the file.
128
 * encoded_by   -- person/group who created the file.
129
 * filename     -- original name of the file.
130
 * genre        -- <self-evident>.
131
 * language     -- main language in which the work is performed, preferably
132
 *                 in ISO 639-2 format.
133
 * performer    -- artist who performed the work, if different from artist.
134
 *                 E.g for "Also sprach Zarathustra", artist would be "Richard
135
 *                 Strauss" and performer "London Philharmonic Orchestra".
136
 * publisher    -- name of the label/publisher.
137
 * title        -- name of the work.
138
 * track        -- number of this work in the set, can be in form current/total.
139
 */
140

    
141
#define AV_METADATA_MATCH_CASE      1
142
#define AV_METADATA_IGNORE_SUFFIX   2
143
#define AV_METADATA_DONT_STRDUP_KEY 4
144
#define AV_METADATA_DONT_STRDUP_VAL 8
145
#define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
146

    
147
typedef struct {
148
    char *key;
149
    char *value;
150
}AVMetadataTag;
151

    
152
typedef struct AVMetadata AVMetadata;
153
typedef struct AVMetadataConv AVMetadataConv;
154

    
155
/**
156
 * Get a metadata element with matching key.
157
 *
158
 * @param prev Set to the previous matching element to find the next.
159
 *             If set to NULL the first matching element is returned.
160
 * @param flags Allows case as well as suffix-insensitive comparisons.
161
 * @return Found tag or NULL, changing key or value leads to undefined behavior.
162
 */
163
AVMetadataTag *
164
av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
165

    
166
#if FF_API_OLD_METADATA
167
/**
168
 * Set the given tag in *pm, overwriting an existing tag.
169
 *
170
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
171
 * a metadata struct is allocated and put in *pm.
172
 * @param key tag key to add to *pm (will be av_strduped)
173
 * @param value tag value to add to *pm (will be av_strduped)
174
 * @return >= 0 on success otherwise an error code <0
175
 * @deprecated Use av_metadata_set2() instead.
176
 */
177
attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
178
#endif
179

    
180
/**
181
 * Set the given tag in *pm, overwriting an existing tag.
182
 *
183
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
184
 * a metadata struct is allocated and put in *pm.
185
 * @param key tag key to add to *pm (will be av_strduped depending on flags)
186
 * @param value tag value to add to *pm (will be av_strduped depending on flags).
187
 *        Passing a NULL value will cause an existing tag to be deleted.
188
 * @return >= 0 on success otherwise an error code <0
189
 */
190
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
191

    
192
/**
193
 * Convert all the metadata sets from ctx according to the source and
194
 * destination conversion tables. If one of the tables is NULL, then
195
 * tags are converted to/from ffmpeg generic tag names.
196
 *
197
 * @param d_conv destination tags format conversion table
198
 * @param s_conv source tags format conversion table
199
 */
200
void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
201
                                                   const AVMetadataConv *s_conv);
202

    
203
/**
204
 * Free all the memory allocated for an AVMetadata struct.
205
 */
206
void av_metadata_free(AVMetadata **m);
207

    
208

    
209
/* packet functions */
210

    
211

    
212
/**
213
 * Allocate and read the payload of a packet and initialize its
214
 * fields with default values.
215
 *
216
 * @param pkt packet
217
 * @param size desired payload size
218
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
219
 */
220
int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
221

    
222

    
223
/*************************************************/
224
/* fractional numbers for exact pts handling */
225

    
226
/**
227
 * The exact value of the fractional number is: 'val + num / den'.
228
 * num is assumed to be 0 <= num < den.
229
 */
230
typedef struct AVFrac {
231
    int64_t val, num, den;
232
} AVFrac;
233

    
234
/*************************************************/
235
/* input/output formats */
236

    
237
struct AVCodecTag;
238

    
239
/**
240
 * This structure contains the data a format has to probe a file.
241
 */
242
typedef struct AVProbeData {
243
    const char *filename;
244
    unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
245
    int buf_size;       /**< Size of buf except extra allocated bytes */
246
} AVProbeData;
247

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

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

    
273
//! Demuxer will use url_fopen, no opened file should be provided by the caller.
274
#define AVFMT_NOFILE        0x0001
275
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
276
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
277
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
278
                                      raw picture data. */
279
#define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
280
#define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
281
#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
282
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. */
283
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
284
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
285

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

    
317
    /**
318
     * List of supported codec_id-codec_tag pairs, ordered by "better
319
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
320
     */
321
    const struct AVCodecTag * const *codec_tag;
322

    
323
    enum CodecID subtitle_codec; /**< default subtitle codec */
324

    
325
    const AVMetadataConv *metadata_conv;
326

    
327
    /* private fields */
328
    struct AVOutputFormat *next;
329
} AVOutputFormat;
330

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

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

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

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

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

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

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

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

    
402
    /**
403
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
404
     */
405
    int flags;
406

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

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

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

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

    
431
    const struct AVCodecTag * const *codec_tag;
432

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

    
441
    const AVMetadataConv *metadata_conv;
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

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

    
500
    /* internal data used in av_find_stream_info() */
501
    int64_t first_dts;
502

    
503
    /**
504
     * encoding: pts generation when outputting stream
505
     */
506
    struct AVFrac pts;
507

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

    
519
    //FIXME move stuff to a flags field?
520
    /**
521
     * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
522
     * MN: dunno if that is the right place for it
523
     */
524
    float quality;
525

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

    
536
    /**
537
     * Decoding: duration of the stream, in stream time base.
538
     * If a source file does not specify a duration, but does specify
539
     * a bitrate, this value will be estimated from bitrate and file size.
540
     */
541
    int64_t duration;
542

    
543
#if FF_API_OLD_METADATA
544
    attribute_deprecated char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
545
#endif
546

    
547
    /* av_read_frame() support */
548
    enum AVStreamParseType need_parsing;
549
    struct AVCodecParserContext *parser;
550

    
551
    int64_t cur_dts;
552
    int last_IP_duration;
553
    int64_t last_IP_pts;
554
    /* av_seek_frame() support */
555
    AVIndexEntry *index_entries; /**< Only used if the format does not
556
                                    support seeking natively. */
557
    int nb_index_entries;
558
    unsigned int index_entries_allocated_size;
559

    
560
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
561

    
562
#if LIBAVFORMAT_VERSION_INT < (53<<16)
563
    attribute_deprecated int64_t unused[4+1];
564
#endif
565

    
566
#if FF_API_OLD_METADATA
567
    attribute_deprecated char *filename; /**< source filename of the stream */
568
#endif
569

    
570
    int disposition; /**< AV_DISPOSITION_* bit field */
571

    
572
    AVProbeData probe_data;
573
#define MAX_REORDER_DELAY 16
574
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
575

    
576
    /**
577
     * sample aspect ratio (0 if unknown)
578
     * - encoding: Set by user.
579
     * - decoding: Set by libavformat.
580
     */
581
    AVRational sample_aspect_ratio;
582

    
583
    AVMetadata *metadata;
584

    
585
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
586
    /* external applications; try to use something else if at all possible.    */
587
    const uint8_t *cur_ptr;
588
    int cur_len;
589
    AVPacket cur_pkt;
590

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

    
601
    /**
602
     * Number of packets to buffer for codec probing
603
     * NOT PART OF PUBLIC API
604
     */
605
#define MAX_PROBE_PACKETS 2500
606
    int probe_packets;
607

    
608
    /**
609
     * last packet in packet_buffer for this stream when muxing.
610
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
611
     */
612
    struct AVPacketList *last_in_packet_buffer;
613

    
614
    /**
615
     * Average framerate
616
     */
617
    AVRational avg_frame_rate;
618

    
619
    /**
620
     * Number of frames that have been demuxed during av_find_stream_info()
621
     */
622
    int codec_info_nb_frames;
623

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

    
637
#define AV_PROGRAM_RUNNING 1
638

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

    
658
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
659
                                         (streams are added dynamically) */
660

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

    
671
#if FF_API_MAX_STREAMS
672
#define MAX_STREAMS 20
673
#endif
674

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

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

    
718
    /**
719
     * Decoding: position of the first frame of the component, in
720
     * AV_TIME_BASE fractional seconds. NEVER set this value directly:
721
     * It is deduced from the AVStream values.
722
     */
723
    int64_t start_time;
724

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

    
733
    /**
734
     * decoding: total file size, 0 if unknown
735
     */
736
    int64_t file_size;
737

    
738
    /**
739
     * Decoding: total stream bitrate in bit/s, 0 if not
740
     * available. Never set it directly if the file_size and the
741
     * duration are known as FFmpeg can compute it automatically.
742
     */
743
    int bit_rate;
744

    
745
    /* av_read_frame() support */
746
    AVStream *cur_st;
747
#if LIBAVFORMAT_VERSION_INT < (53<<16)
748
    const uint8_t *cur_ptr_deprecated;
749
    int cur_len_deprecated;
750
    AVPacket cur_pkt_deprecated;
751
#endif
752

    
753
    /* av_seek_frame() support */
754
    int64_t data_offset; /**< offset of the first packet */
755
    int index_built;
756

    
757
    int mux_rate;
758
    unsigned int packet_size;
759
    int preload;
760
    int max_delay;
761

    
762
#define AVFMT_NOOUTPUTLOOP -1
763
#define AVFMT_INFINITEOUTPUTLOOP 0
764
    /**
765
     * number of times to loop output in formats that support it
766
     */
767
    int loop_output;
768

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

    
778
    int loop_input;
779

    
780
    /**
781
     * decoding: size of data to probe; encoding: unused.
782
     */
783
    unsigned int probesize;
784

    
785
    /**
786
     * Maximum time (in AV_TIME_BASE units) during which the input should
787
     * be analyzed in av_find_stream_info().
788
     */
789
    int max_analyze_duration;
790

    
791
    const uint8_t *key;
792
    int keylen;
793

    
794
    unsigned int nb_programs;
795
    AVProgram **programs;
796

    
797
    /**
798
     * Forced video codec_id.
799
     * Demuxing: Set by user.
800
     */
801
    enum CodecID video_codec_id;
802

    
803
    /**
804
     * Forced audio codec_id.
805
     * Demuxing: Set by user.
806
     */
807
    enum CodecID audio_codec_id;
808

    
809
    /**
810
     * Forced subtitle codec_id.
811
     * Demuxing: Set by user.
812
     */
813
    enum CodecID subtitle_codec_id;
814

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

    
827
    /**
828
     * Maximum amount of memory in bytes to use for buffering frames
829
     * obtained from realtime capture devices.
830
     */
831
    unsigned int max_picture_buffer;
832

    
833
    unsigned int nb_chapters;
834
    AVChapter **chapters;
835

    
836
    /**
837
     * Flags to enable debugging.
838
     */
839
    int debug;
840
#define FF_FDEBUG_TS        0x0001
841

    
842
    /**
843
     * Raw packets from the demuxer, prior to parsing and decoding.
844
     * This buffer is used for buffering packets until the codec can
845
     * be identified, as parsing cannot be done without knowing the
846
     * codec.
847
     */
848
    struct AVPacketList *raw_packet_buffer;
849
    struct AVPacketList *raw_packet_buffer_end;
850

    
851
    struct AVPacketList *packet_buffer_end;
852

    
853
    AVMetadata *metadata;
854

    
855
    /**
856
     * Remaining size available for raw_packet_buffer, in bytes.
857
     * NOT PART OF PUBLIC API
858
     */
859
#define RAW_PACKET_BUFFER_SIZE 2500000
860
    int raw_packet_buffer_remaining_size;
861

    
862
    /**
863
     * Start time of the stream in real world time, in microseconds
864
     * since the unix epoch (00:00 1st January 1970). That is, pts=0
865
     * in the stream was captured at this real world time.
866
     * - encoding: Set by user.
867
     * - decoding: Unused.
868
     */
869
    int64_t start_time_realtime;
870
} AVFormatContext;
871

    
872
typedef struct AVPacketList {
873
    AVPacket pkt;
874
    struct AVPacketList *next;
875
} AVPacketList;
876

    
877
#if LIBAVFORMAT_VERSION_INT < (53<<16)
878
attribute_deprecated extern AVInputFormat *first_iformat;
879
attribute_deprecated extern AVOutputFormat *first_oformat;
880
#endif
881

    
882
/**
883
 * If f is NULL, returns the first registered input format,
884
 * if f is non-NULL, returns the next registered input format after f
885
 * or NULL if f is the last one.
886
 */
887
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
888

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

    
896
enum CodecID av_guess_image2_codec(const char *filename);
897

    
898
/* XXX: Use automatic init with either ELF sections or C file parser */
899
/* modules. */
900

    
901
/* utils.c */
902
void av_register_input_format(AVInputFormat *format);
903
void av_register_output_format(AVOutputFormat *format);
904
#if FF_API_GUESS_FORMAT
905
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
906
                                    const char *filename,
907
                                    const char *mime_type);
908

    
909
/**
910
 * @deprecated Use av_guess_format() instead.
911
 */
912
attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
913
                                                  const char *filename,
914
                                                  const char *mime_type);
915
#endif
916

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

    
933
/**
934
 * Guess the codec ID based upon muxer and filename.
935
 */
936
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
937
                            const char *filename, const char *mime_type,
938
                            enum AVMediaType type);
939

    
940
/**
941
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
942
 *
943
 * @param f The file stream pointer where the dump should be sent to.
944
 * @param buf buffer
945
 * @param size buffer size
946
 *
947
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
948
 */
949
void av_hex_dump(FILE *f, uint8_t *buf, int size);
950

    
951
/**
952
 * Send a nice hexadecimal dump of a buffer to the log.
953
 *
954
 * @param avcl A pointer to an arbitrary struct of which the first field is a
955
 * pointer to an AVClass struct.
956
 * @param level The importance level of the message, lower values signifying
957
 * higher importance.
958
 * @param buf buffer
959
 * @param size buffer size
960
 *
961
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
962
 */
963
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
964

    
965
/**
966
 * Send a nice dump of a packet to the specified file stream.
967
 *
968
 * @param f The file stream pointer where the dump should be sent to.
969
 * @param pkt packet to dump
970
 * @param dump_payload True if the payload must be displayed, too.
971
 */
972
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
973

    
974
/**
975
 * Send a nice dump of a packet to the log.
976
 *
977
 * @param avcl A pointer to an arbitrary struct of which the first field is a
978
 * pointer to an AVClass struct.
979
 * @param level The importance level of the message, lower values signifying
980
 * higher importance.
981
 * @param pkt packet to dump
982
 * @param dump_payload True if the payload must be displayed, too.
983
 */
984
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
985

    
986
/**
987
 * Initialize libavformat and register all the muxers, demuxers and
988
 * protocols. If you do not call this function, then you can select
989
 * exactly which formats you want to support.
990
 *
991
 * @see av_register_input_format()
992
 * @see av_register_output_format()
993
 * @see av_register_protocol()
994
 */
995
void av_register_all(void);
996

    
997
/**
998
 * Get the CodecID for the given codec tag tag.
999
 * If no codec id is found returns CODEC_ID_NONE.
1000
 *
1001
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1002
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1003
 */
1004
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
1005

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

    
1015
/* media file input */
1016

    
1017
/**
1018
 * Find AVInputFormat based on the short name of the input format.
1019
 */
1020
AVInputFormat *av_find_input_format(const char *short_name);
1021

    
1022
/**
1023
 * Guess the file format.
1024
 *
1025
 * @param is_opened Whether the file is already opened; determines whether
1026
 *                  demuxers with or without AVFMT_NOFILE are probed.
1027
 */
1028
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1029

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

    
1043
/**
1044
 * Allocate all the structures needed to read an input stream.
1045
 *        This does not open the needed codecs for decoding the stream[s].
1046
 */
1047
int av_open_input_stream(AVFormatContext **ic_ptr,
1048
                         ByteIOContext *pb, const char *filename,
1049
                         AVInputFormat *fmt, AVFormatParameters *ap);
1050

    
1051
/**
1052
 * Open a media file as input. The codecs are not opened. Only the file
1053
 * header (if present) is read.
1054
 *
1055
 * @param ic_ptr The opened media file handle is put here.
1056
 * @param filename filename to open
1057
 * @param fmt If non-NULL, force the file format to use.
1058
 * @param buf_size optional buffer size (zero if default is OK)
1059
 * @param ap Additional parameters needed when opening the file
1060
 *           (NULL if default).
1061
 * @return 0 if OK, AVERROR_xxx otherwise
1062
 */
1063
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1064
                       AVInputFormat *fmt,
1065
                       int buf_size,
1066
                       AVFormatParameters *ap);
1067

    
1068
#if LIBAVFORMAT_VERSION_MAJOR < 53
1069
/**
1070
 * @deprecated Use avformat_alloc_context() instead.
1071
 */
1072
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1073
#endif
1074

    
1075
/**
1076
 * Allocate an AVFormatContext.
1077
 * Can be freed with av_free() but do not forget to free everything you
1078
 * explicitly allocated as well!
1079
 */
1080
AVFormatContext *avformat_alloc_context(void);
1081

    
1082
/**
1083
 * Read packets of a media file to get stream information. This
1084
 * is useful for file formats with no headers such as MPEG. This
1085
 * function also computes the real framerate in case of MPEG-2 repeat
1086
 * frame mode.
1087
 * The logical file position is not changed by this function;
1088
 * examined packets may be buffered for later processing.
1089
 *
1090
 * @param ic media file handle
1091
 * @return >=0 if OK, AVERROR_xxx on error
1092
 * @todo Let the user decide somehow what information is needed so that
1093
 *       we do not waste time getting stuff the user does not need.
1094
 */
1095
int av_find_stream_info(AVFormatContext *ic);
1096

    
1097
/**
1098
 * Read a transport packet from a media file.
1099
 *
1100
 * This function is obsolete and should never be used.
1101
 * Use av_read_frame() instead.
1102
 *
1103
 * @param s media file handle
1104
 * @param pkt is filled
1105
 * @return 0 if OK, AVERROR_xxx on error
1106
 */
1107
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1108

    
1109
/**
1110
 * Return the next frame of a stream.
1111
 * This function returns what is stored in the file, and does not validate
1112
 * that what is there are valid frames for the decoder. It will split what is
1113
 * stored in the file into frames and return one for each call. It will not
1114
 * omit invalid data between valid frames so as to give the decoder the maximum
1115
 * information possible for decoding.
1116
 *
1117
 * The returned packet is valid
1118
 * until the next av_read_frame() or until av_close_input_file() and
1119
 * must be freed with av_free_packet. For video, the packet contains
1120
 * exactly one frame. For audio, it contains an integer number of
1121
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1122
 * data). If the audio frames have a variable size (e.g. MPEG audio),
1123
 * then it contains one frame.
1124
 *
1125
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1126
 * values in AVStream.time_base units (and guessed if the format cannot
1127
 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1128
 * has B-frames, so it is better to rely on pkt->dts if you do not
1129
 * decompress the payload.
1130
 *
1131
 * @return 0 if OK, < 0 on error or end of file
1132
 */
1133
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1134

    
1135
/**
1136
 * Seek to the keyframe at timestamp.
1137
 * 'timestamp' in 'stream_index'.
1138
 * @param stream_index If stream_index is (-1), a default
1139
 * stream is selected, and timestamp is automatically converted
1140
 * from AV_TIME_BASE units to the stream specific time_base.
1141
 * @param timestamp Timestamp in AVStream.time_base units
1142
 *        or, if no stream is specified, in AV_TIME_BASE units.
1143
 * @param flags flags which select direction and seeking mode
1144
 * @return >= 0 on success
1145
 */
1146
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1147
                  int flags);
1148

    
1149
/**
1150
 * Seek to timestamp ts.
1151
 * Seeking will be done so that the point from which all active streams
1152
 * can be presented successfully will be closest to ts and within min/max_ts.
1153
 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1154
 *
1155
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1156
 * are the file position (this may not be supported by all demuxers).
1157
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1158
 * in the stream with stream_index (this may not be supported by all demuxers).
1159
 * Otherwise all timestamps are in units of the stream selected by stream_index
1160
 * or if stream_index is -1, in AV_TIME_BASE units.
1161
 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1162
 * keyframes (this may not be supported by all demuxers).
1163
 *
1164
 * @param stream_index index of the stream which is used as time base reference
1165
 * @param min_ts smallest acceptable timestamp
1166
 * @param ts target timestamp
1167
 * @param max_ts largest acceptable timestamp
1168
 * @param flags flags
1169
 * @return >=0 on success, error code otherwise
1170
 *
1171
 * @note This is part of the new seek API which is still under construction.
1172
 *       Thus do not use this yet. It may change at any time, do not expect
1173
 *       ABI compatibility yet!
1174
 */
1175
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1176

    
1177
/**
1178
 * Start playing a network-based stream (e.g. RTSP stream) at the
1179
 * current position.
1180
 */
1181
int av_read_play(AVFormatContext *s);
1182

    
1183
/**
1184
 * Pause a network-based stream (e.g. RTSP stream).
1185
 *
1186
 * Use av_read_play() to resume it.
1187
 */
1188
int av_read_pause(AVFormatContext *s);
1189

    
1190
/**
1191
 * Free a AVFormatContext allocated by av_open_input_stream.
1192
 * @param s context to free
1193
 */
1194
void av_close_input_stream(AVFormatContext *s);
1195

    
1196
/**
1197
 * Close a media file (but not its codecs).
1198
 *
1199
 * @param s media file handle
1200
 */
1201
void av_close_input_file(AVFormatContext *s);
1202

    
1203
/**
1204
 * Add a new stream to a media file.
1205
 *
1206
 * Can only be called in the read_header() function. If the flag
1207
 * AVFMTCTX_NOHEADER is in the format context, then new streams
1208
 * can be added in read_packet too.
1209
 *
1210
 * @param s media file handle
1211
 * @param id file-format-dependent stream ID
1212
 */
1213
AVStream *av_new_stream(AVFormatContext *s, int id);
1214
AVProgram *av_new_program(AVFormatContext *s, int id);
1215

    
1216
/**
1217
 * Add a new chapter.
1218
 * This function is NOT part of the public API
1219
 * and should ONLY be used by demuxers.
1220
 *
1221
 * @param s media file handle
1222
 * @param id unique ID for this chapter
1223
 * @param start chapter start time in time_base units
1224
 * @param end chapter end time in time_base units
1225
 * @param title chapter title
1226
 *
1227
 * @return AVChapter or NULL on error
1228
 */
1229
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1230
                          int64_t start, int64_t end, const char *title);
1231

    
1232
/**
1233
 * Set the pts for a given stream.
1234
 *
1235
 * @param s stream
1236
 * @param pts_wrap_bits number of bits effectively used by the pts
1237
 *        (used for wrap control, 33 is the value for MPEG)
1238
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1239
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1240
 */
1241
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1242
                     unsigned int pts_num, unsigned int pts_den);
1243

    
1244
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1245
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1246
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1247
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1248

    
1249
int av_find_default_stream_index(AVFormatContext *s);
1250

    
1251
/**
1252
 * Get the index for a specific timestamp.
1253
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1254
 *                 to the timestamp which is <= the requested one, if backward
1255
 *                 is 0, then it will be >=
1256
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1257
 * @return < 0 if no such timestamp could be found
1258
 */
1259
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1260

    
1261
/**
1262
 * Ensure the index uses less memory than the maximum specified in
1263
 * AVFormatContext.max_index_size by discarding entries if it grows
1264
 * too large.
1265
 * This function is not part of the public API and should only be called
1266
 * by demuxers.
1267
 */
1268
void ff_reduce_index(AVFormatContext *s, int stream_index);
1269

    
1270
/**
1271
 * Add an index entry into a sorted list. Update the entry if the list
1272
 * already contains it.
1273
 *
1274
 * @param timestamp timestamp in the time base of the given stream
1275
 */
1276
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1277
                       int size, int distance, int flags);
1278

    
1279
/**
1280
 * Perform a binary search using av_index_search_timestamp() and
1281
 * AVInputFormat.read_timestamp().
1282
 * This is not supposed to be called directly by a user application,
1283
 * but by demuxers.
1284
 * @param target_ts target timestamp in the time base of the given stream
1285
 * @param stream_index stream number
1286
 */
1287
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1288
                         int64_t target_ts, int flags);
1289

    
1290
/**
1291
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1292
 *
1293
 * Stream ref_st unchanged, others set cur_dts in their native time base.
1294
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1295
 * @param timestamp new dts expressed in time_base of param ref_st
1296
 * @param ref_st reference stream giving time_base of param timestamp
1297
 */
1298
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1299

    
1300
/**
1301
 * Perform a binary search using read_timestamp().
1302
 * This is not supposed to be called directly by a user application,
1303
 * but by demuxers.
1304
 * @param target_ts target timestamp in the time base of the given stream
1305
 * @param stream_index stream number
1306
 */
1307
int64_t av_gen_search(AVFormatContext *s, int stream_index,
1308
                      int64_t target_ts, int64_t pos_min,
1309
                      int64_t pos_max, int64_t pos_limit,
1310
                      int64_t ts_min, int64_t ts_max,
1311
                      int flags, int64_t *ts_ret,
1312
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1313

    
1314
/**
1315
 * media file output
1316
 */
1317
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1318

    
1319
/**
1320
 * Split a URL string into components.
1321
 *
1322
 * The pointers to buffers for storing individual components may be null,
1323
 * in order to ignore that component. Buffers for components not found are
1324
 * set to empty strings. If the port is not found, it is set to a negative
1325
 * value.
1326
 *
1327
 * @param proto the buffer for the protocol
1328
 * @param proto_size the size of the proto buffer
1329
 * @param authorization the buffer for the authorization
1330
 * @param authorization_size the size of the authorization buffer
1331
 * @param hostname the buffer for the host name
1332
 * @param hostname_size the size of the hostname buffer
1333
 * @param port_ptr a pointer to store the port number in
1334
 * @param path the buffer for the path
1335
 * @param path_size the size of the path buffer
1336
 * @param url the URL to split
1337
 */
1338
void av_url_split(char *proto,         int proto_size,
1339
                  char *authorization, int authorization_size,
1340
                  char *hostname,      int hostname_size,
1341
                  int *port_ptr,
1342
                  char *path,          int path_size,
1343
                  const char *url);
1344

    
1345
/**
1346
 * Allocate the stream private data and write the stream header to an
1347
 * output media file.
1348
 *
1349
 * @param s media file handle
1350
 * @return 0 if OK, AVERROR_xxx on error
1351
 */
1352
int av_write_header(AVFormatContext *s);
1353

    
1354
/**
1355
 * Write a packet to an output media file.
1356
 *
1357
 * The packet shall contain one audio or video frame.
1358
 * The packet must be correctly interleaved according to the container
1359
 * specification, if not then av_interleaved_write_frame must be used.
1360
 *
1361
 * @param s media file handle
1362
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1363
              dts/pts, ...
1364
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1365
 */
1366
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1367

    
1368
/**
1369
 * Write a packet to an output media file ensuring correct interleaving.
1370
 *
1371
 * The packet must contain one audio or video frame.
1372
 * If the packets are already correctly interleaved, the application should
1373
 * call av_write_frame() instead as it is slightly faster. It is also important
1374
 * to keep in mind that completely non-interleaved input will need huge amounts
1375
 * of memory to interleave with this, so it is preferable to interleave at the
1376
 * demuxer level.
1377
 *
1378
 * @param s media file handle
1379
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1380
              dts/pts, ...
1381
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1382
 */
1383
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1384

    
1385
/**
1386
 * Interleave a packet per dts in an output media file.
1387
 *
1388
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1389
 * function, so they cannot be used after it. Note that calling av_free_packet()
1390
 * on them is still safe.
1391
 *
1392
 * @param s media file handle
1393
 * @param out the interleaved packet will be output here
1394
 * @param pkt the input packet
1395
 * @param flush 1 if no further packets are available as input and all
1396
 *              remaining packets should be output
1397
 * @return 1 if a packet was output, 0 if no packet could be output,
1398
 *         < 0 if an error occurred
1399
 */
1400
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1401
                                 AVPacket *pkt, int flush);
1402

    
1403
/**
1404
 * Write the stream trailer to an output media file and free the
1405
 * file private data.
1406
 *
1407
 * May only be called after a successful call to av_write_header.
1408
 *
1409
 * @param s media file handle
1410
 * @return 0 if OK, AVERROR_xxx on error
1411
 */
1412
int av_write_trailer(AVFormatContext *s);
1413

    
1414
void dump_format(AVFormatContext *ic,
1415
                 int index,
1416
                 const char *url,
1417
                 int is_output);
1418

    
1419
#if LIBAVFORMAT_VERSION_MAJOR < 53
1420
/**
1421
 * Parse width and height out of string str.
1422
 * @deprecated Use av_parse_video_frame_size instead.
1423
 */
1424
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1425
                                          const char *str);
1426

    
1427
/**
1428
 * Convert framerate from a string to a fraction.
1429
 * @deprecated Use av_parse_video_frame_rate instead.
1430
 */
1431
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1432
                                          const char *arg);
1433
#endif
1434

    
1435
/**
1436
 * Parse datestr and return a corresponding number of microseconds.
1437
 * @param datestr String representing a date or a duration.
1438
 * - If a date the syntax is:
1439
 * @code
1440
 *  now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]}
1441
 * @endcode
1442
 * If the value is "now" it takes the current time.
1443
 * Time is local time unless Z is appended, in which case it is
1444
 * interpreted as UTC.
1445
 * If the year-month-day part is not specified it takes the current
1446
 * year-month-day.
1447
 * @return the number of microseconds since 1st of January, 1970 up to
1448
 * the time of the parsed date or INT64_MIN if datestr cannot be
1449
 * successfully parsed.
1450
 * - If a duration the syntax is:
1451
 * @code
1452
 *  [-]HH[:MM[:SS[.m...]]]
1453
 *  [-]S+[.m...]
1454
 * @endcode
1455
 * @return the number of microseconds contained in a time interval
1456
 * with the specified duration or INT64_MIN if datestr cannot be
1457
 * successfully parsed.
1458
 * @param duration Flag which tells how to interpret datestr, if
1459
 * not zero datestr is interpreted as a duration, otherwise as a
1460
 * date.
1461
 */
1462
int64_t parse_date(const char *datestr, int duration);
1463

    
1464
/**
1465
 * Get the current time in microseconds.
1466
 */
1467
int64_t av_gettime(void);
1468

    
1469
/* ffm-specific for ffserver */
1470
#define FFM_PACKET_SIZE 4096
1471
int64_t ffm_read_write_index(int fd);
1472
int ffm_write_write_index(int fd, int64_t pos);
1473
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1474

    
1475
/**
1476
 * Attempt to find a specific tag in a URL.
1477
 *
1478
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1479
 * Return 1 if found.
1480
 */
1481
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1482

    
1483
/**
1484
 * Return in 'buf' the path with '%d' replaced by a number.
1485
 *
1486
 * Also handles the '%0nd' format where 'n' is the total number
1487
 * of digits and '%%'.
1488
 *
1489
 * @param buf destination buffer
1490
 * @param buf_size destination buffer size
1491
 * @param path numbered sequence string
1492
 * @param number frame number
1493
 * @return 0 if OK, -1 on format error
1494
 */
1495
int av_get_frame_filename(char *buf, int buf_size,
1496
                          const char *path, int number);
1497

    
1498
/**
1499
 * Check whether filename actually is a numbered sequence generator.
1500
 *
1501
 * @param filename possible numbered sequence string
1502
 * @return 1 if a valid numbered sequence string, 0 otherwise
1503
 */
1504
int av_filename_number_test(const char *filename);
1505

    
1506
/**
1507
 * Generate an SDP for an RTP session.
1508
 *
1509
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1510
 *           array is composed by only one context, such context can contain
1511
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1512
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1513
 *           must contain only one AVStream.
1514
 * @param n_files number of AVCodecContexts contained in ac
1515
 * @param buff buffer where the SDP will be stored (must be allocated by
1516
 *             the caller)
1517
 * @param size the size of the buffer
1518
 * @return 0 if OK, AVERROR_xxx on error
1519
 */
1520
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1521

    
1522
/**
1523
 * Return a positive value if the given filename has one of the given
1524
 * extensions, 0 otherwise.
1525
 *
1526
 * @param extensions a comma-separated list of filename extensions
1527
 */
1528
int av_match_ext(const char *filename, const char *extensions);
1529

    
1530
#endif /* AVFORMAT_AVFORMAT_H */