Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 3ee53dab

History | View | Annotate | Download (55.7 KB)

1
/*
2
 * copyright (c) 2001 Fabrice Bellard
3
 *
4
 * This file is part of Libav.
5
 *
6
 * Libav 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
 * Libav 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 Libav; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
 */
20

    
21
#ifndef AVFORMAT_AVFORMAT_H
22
#define AVFORMAT_AVFORMAT_H
23

    
24

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

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

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

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

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

    
48
struct AVFormatContext;
49

    
50

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

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

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

    
120
typedef struct AVMetadata AVMetadata;
121
#if FF_API_OLD_METADATA
122
typedef struct AVMetadataConv AVMetadataConv;
123
#endif
124

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

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

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

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

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

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

    
185

    
186
/* packet functions */
187

    
188

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

    
199

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

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

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

    
226
/*************************************************/
227
/* input/output formats */
228

    
229
struct AVCodecTag;
230

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
430
    const struct AVCodecTag * const *codec_tag;
431

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

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

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

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

    
456
typedef struct AVIndexEntry {
457
    int64_t pos;
458
    int64_t timestamp;
459
#define AVINDEX_KEYFRAME 0x0001
460
    int flags:2;
461
    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).
462
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
463
} AVIndexEntry;
464

    
465
#define AV_DISPOSITION_DEFAULT   0x0001
466
#define AV_DISPOSITION_DUB       0x0002
467
#define AV_DISPOSITION_ORIGINAL  0x0004
468
#define AV_DISPOSITION_COMMENT   0x0008
469
#define AV_DISPOSITION_LYRICS    0x0010
470
#define AV_DISPOSITION_KARAOKE   0x0020
471

    
472
/**
473
 * Track should be used during playback by default.
474
 * Useful for subtitle track that should be displayed
475
 * even when user did not explicitly ask for subtitles.
476
 */
477
#define AV_DISPOSITION_FORCED    0x0040
478
#define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
479
#define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
480
#define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
481

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

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

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

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

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

    
532
    /**
533
     * Decoding: pts of the first frame of the stream, in stream time base.
534
     * Only set this if you are absolutely 100% sure that the value you set
535
     * it to really is the pts of the first frame.
536
     * This may be undefined (AV_NOPTS_VALUE).
537
     */
538
    int64_t start_time;
539

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

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

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

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

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

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

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

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

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

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

    
587
    AVMetadata *metadata;
588

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

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

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

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

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

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

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

    
641
#define AV_PROGRAM_RUNNING 1
642

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
784
    int loop_input;
785

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

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

    
797
    const uint8_t *key;
798
    int keylen;
799

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

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

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

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

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

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

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

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

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

    
857
    struct AVPacketList *packet_buffer_end;
858

    
859
    AVMetadata *metadata;
860

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

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

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

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

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

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

    
902
#if FF_API_GUESS_IMG2_CODEC
903
attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
904
#endif
905

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

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

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

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

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

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

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

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

    
983

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

    
998
#if FF_API_PKT_DUMP
999
attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
1000
attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
1001
#endif
1002
                                          int dump_payload);
1003

    
1004
/**
1005
 * Initialize libavformat and register all the muxers, demuxers and
1006
 * protocols. If you do not call this function, then you can select
1007
 * exactly which formats you want to support.
1008
 *
1009
 * @see av_register_input_format()
1010
 * @see av_register_output_format()
1011
 * @see av_register_protocol()
1012
 */
1013
void av_register_all(void);
1014

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

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

    
1033
/* media file input */
1034

    
1035
/**
1036
 * Find AVInputFormat based on the short name of the input format.
1037
 */
1038
AVInputFormat *av_find_input_format(const char *short_name);
1039

    
1040
/**
1041
 * Guess the file format.
1042
 *
1043
 * @param is_opened Whether the file is already opened; determines whether
1044
 *                  demuxers with or without AVFMT_NOFILE are probed.
1045
 */
1046
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1047

    
1048
/**
1049
 * Guess the file format.
1050
 *
1051
 * @param is_opened Whether the file is already opened; determines whether
1052
 *                  demuxers with or without AVFMT_NOFILE are probed.
1053
 * @param score_max A probe score larger that this is required to accept a
1054
 *                  detection, the variable is set to the actual detection
1055
 *                  score afterwards.
1056
 *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1057
 *                  to retry with a larger probe buffer.
1058
 */
1059
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1060

    
1061
/**
1062
 * Probe a bytestream to determine the input format. Each time a probe returns
1063
 * with a score that is too low, the probe buffer size is increased and another
1064
 * attempt is made. When the maximum probe size is reached, the input format
1065
 * with the highest score is returned.
1066
 *
1067
 * @param pb the bytestream to probe
1068
 * @param fmt the input format is put here
1069
 * @param filename the filename of the stream
1070
 * @param logctx the log context
1071
 * @param offset the offset within the bytestream to probe from
1072
 * @param max_probe_size the maximum probe buffer size (zero for default)
1073
 * @return 0 in case of success, a negative value corresponding to an
1074
 * AVERROR code otherwise
1075
 */
1076
int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1077
                          const char *filename, void *logctx,
1078
                          unsigned int offset, unsigned int max_probe_size);
1079

    
1080
/**
1081
 * Allocate all the structures needed to read an input stream.
1082
 *        This does not open the needed codecs for decoding the stream[s].
1083
 */
1084
int av_open_input_stream(AVFormatContext **ic_ptr,
1085
                         AVIOContext *pb, const char *filename,
1086
                         AVInputFormat *fmt, AVFormatParameters *ap);
1087

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

    
1105
#if FF_API_ALLOC_FORMAT_CONTEXT
1106
/**
1107
 * @deprecated Use avformat_alloc_context() instead.
1108
 */
1109
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1110
#endif
1111

    
1112
/**
1113
 * Allocate an AVFormatContext.
1114
 * avformat_free_context() can be used to free the context and everything
1115
 * allocated by the framework within it.
1116
 */
1117
AVFormatContext *avformat_alloc_context(void);
1118

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

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

    
1165
/**
1166
 * Read a transport packet from a media file.
1167
 *
1168
 * This function is obsolete and should never be used.
1169
 * Use av_read_frame() instead.
1170
 *
1171
 * @param s media file handle
1172
 * @param pkt is filled
1173
 * @return 0 if OK, AVERROR_xxx on error
1174
 */
1175
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1176

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

    
1203
/**
1204
 * Seek to the keyframe at timestamp.
1205
 * 'timestamp' in 'stream_index'.
1206
 * @param stream_index If stream_index is (-1), a default
1207
 * stream is selected, and timestamp is automatically converted
1208
 * from AV_TIME_BASE units to the stream specific time_base.
1209
 * @param timestamp Timestamp in AVStream.time_base units
1210
 *        or, if no stream is specified, in AV_TIME_BASE units.
1211
 * @param flags flags which select direction and seeking mode
1212
 * @return >= 0 on success
1213
 */
1214
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1215
                  int flags);
1216

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

    
1245
/**
1246
 * Start playing a network-based stream (e.g. RTSP stream) at the
1247
 * current position.
1248
 */
1249
int av_read_play(AVFormatContext *s);
1250

    
1251
/**
1252
 * Pause a network-based stream (e.g. RTSP stream).
1253
 *
1254
 * Use av_read_play() to resume it.
1255
 */
1256
int av_read_pause(AVFormatContext *s);
1257

    
1258
/**
1259
 * Free a AVFormatContext allocated by av_open_input_stream.
1260
 * @param s context to free
1261
 */
1262
void av_close_input_stream(AVFormatContext *s);
1263

    
1264
/**
1265
 * Close a media file (but not its codecs).
1266
 *
1267
 * @param s media file handle
1268
 */
1269
void av_close_input_file(AVFormatContext *s);
1270

    
1271
/**
1272
 * Free an AVFormatContext and all its streams.
1273
 * @param s context to free
1274
 */
1275
void avformat_free_context(AVFormatContext *s);
1276

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

    
1290
/**
1291
 * Set the pts for a given stream. If the new values would be invalid
1292
 * (<= 0), it leaves the AVStream unchanged.
1293
 *
1294
 * @param s stream
1295
 * @param pts_wrap_bits number of bits effectively used by the pts
1296
 *        (used for wrap control, 33 is the value for MPEG)
1297
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1298
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1299
 */
1300
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1301
                     unsigned int pts_num, unsigned int pts_den);
1302

    
1303
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1304
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1305
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1306
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1307

    
1308
int av_find_default_stream_index(AVFormatContext *s);
1309

    
1310
/**
1311
 * Get the index for a specific timestamp.
1312
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1313
 *                 to the timestamp which is <= the requested one, if backward
1314
 *                 is 0, then it will be >=
1315
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1316
 * @return < 0 if no such timestamp could be found
1317
 */
1318
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1319

    
1320
/**
1321
 * Add an index entry into a sorted list. Update the entry if the list
1322
 * already contains it.
1323
 *
1324
 * @param timestamp timestamp in the time base of the given stream
1325
 */
1326
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1327
                       int size, int distance, int flags);
1328

    
1329
/**
1330
 * Perform a binary search using av_index_search_timestamp() and
1331
 * AVInputFormat.read_timestamp().
1332
 * This is not supposed to be called directly by a user application,
1333
 * but by demuxers.
1334
 * @param target_ts target timestamp in the time base of the given stream
1335
 * @param stream_index stream number
1336
 */
1337
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1338
                         int64_t target_ts, int flags);
1339

    
1340
/**
1341
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1342
 *
1343
 * Stream ref_st unchanged, others set cur_dts in their native time base.
1344
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1345
 * @param timestamp new dts expressed in time_base of param ref_st
1346
 * @param ref_st reference stream giving time_base of param timestamp
1347
 */
1348
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1349

    
1350
/**
1351
 * Perform a binary search using read_timestamp().
1352
 * This is not supposed to be called directly by a user application,
1353
 * but by demuxers.
1354
 * @param target_ts target timestamp in the time base of the given stream
1355
 * @param stream_index stream number
1356
 */
1357
int64_t av_gen_search(AVFormatContext *s, int stream_index,
1358
                      int64_t target_ts, int64_t pos_min,
1359
                      int64_t pos_max, int64_t pos_limit,
1360
                      int64_t ts_min, int64_t ts_max,
1361
                      int flags, int64_t *ts_ret,
1362
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1363

    
1364
/**
1365
 * media file output
1366
 */
1367
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1368

    
1369
/**
1370
 * Split a URL string into components.
1371
 *
1372
 * The pointers to buffers for storing individual components may be null,
1373
 * in order to ignore that component. Buffers for components not found are
1374
 * set to empty strings. If the port is not found, it is set to a negative
1375
 * value.
1376
 *
1377
 * @param proto the buffer for the protocol
1378
 * @param proto_size the size of the proto buffer
1379
 * @param authorization the buffer for the authorization
1380
 * @param authorization_size the size of the authorization buffer
1381
 * @param hostname the buffer for the host name
1382
 * @param hostname_size the size of the hostname buffer
1383
 * @param port_ptr a pointer to store the port number in
1384
 * @param path the buffer for the path
1385
 * @param path_size the size of the path buffer
1386
 * @param url the URL to split
1387
 */
1388
void av_url_split(char *proto,         int proto_size,
1389
                  char *authorization, int authorization_size,
1390
                  char *hostname,      int hostname_size,
1391
                  int *port_ptr,
1392
                  char *path,          int path_size,
1393
                  const char *url);
1394

    
1395
/**
1396
 * Allocate the stream private data and write the stream header to an
1397
 * output media file.
1398
 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1399
 * but for some formats it might also be some other time base
1400
 *
1401
 * @param s media file handle
1402
 * @return 0 if OK, AVERROR_xxx on error
1403
 */
1404
int av_write_header(AVFormatContext *s);
1405

    
1406
/**
1407
 * Write a packet to an output media file.
1408
 *
1409
 * The packet shall contain one audio or video frame.
1410
 * The packet must be correctly interleaved according to the container
1411
 * specification, if not then av_interleaved_write_frame must be used.
1412
 *
1413
 * @param s media file handle
1414
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1415
              dts/pts, ...
1416
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1417
 */
1418
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1419

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

    
1437
/**
1438
 * Interleave a packet per dts in an output media file.
1439
 *
1440
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1441
 * function, so they cannot be used after it. Note that calling av_free_packet()
1442
 * on them is still safe.
1443
 *
1444
 * @param s media file handle
1445
 * @param out the interleaved packet will be output here
1446
 * @param pkt the input packet
1447
 * @param flush 1 if no further packets are available as input and all
1448
 *              remaining packets should be output
1449
 * @return 1 if a packet was output, 0 if no packet could be output,
1450
 *         < 0 if an error occurred
1451
 */
1452
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1453
                                 AVPacket *pkt, int flush);
1454

    
1455
/**
1456
 * Write the stream trailer to an output media file and free the
1457
 * file private data.
1458
 *
1459
 * May only be called after a successful call to av_write_header.
1460
 *
1461
 * @param s media file handle
1462
 * @return 0 if OK, AVERROR_xxx on error
1463
 */
1464
int av_write_trailer(AVFormatContext *s);
1465

    
1466
#if FF_API_DUMP_FORMAT
1467
attribute_deprecated void dump_format(AVFormatContext *ic,
1468
                                      int index,
1469
                                      const char *url,
1470
                                      int is_output);
1471
#endif
1472

    
1473
void av_dump_format(AVFormatContext *ic,
1474
                    int index,
1475
                    const char *url,
1476
                    int is_output);
1477

    
1478
#if FF_API_PARSE_FRAME_PARAM
1479
/**
1480
 * Parse width and height out of string str.
1481
 * @deprecated Use av_parse_video_frame_size instead.
1482
 */
1483
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1484
                                          const char *str);
1485

    
1486
/**
1487
 * Convert framerate from a string to a fraction.
1488
 * @deprecated Use av_parse_video_frame_rate instead.
1489
 */
1490
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1491
                                          const char *arg);
1492
#endif
1493

    
1494
#if FF_API_PARSE_DATE
1495
/**
1496
 * Parse datestr and return a corresponding number of microseconds.
1497
 *
1498
 * @param datestr String representing a date or a duration.
1499
 * See av_parse_time() for the syntax of the provided string.
1500
 * @deprecated in favor of av_parse_time()
1501
 */
1502
attribute_deprecated
1503
int64_t parse_date(const char *datestr, int duration);
1504
#endif
1505

    
1506
/**
1507
 * Get the current time in microseconds.
1508
 */
1509
int64_t av_gettime(void);
1510

    
1511
#if FF_API_FIND_INFO_TAG
1512
/**
1513
 * @deprecated use av_find_info_tag in libavutil instead.
1514
 */
1515
attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1516
#endif
1517

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

    
1533
/**
1534
 * Check whether filename actually is a numbered sequence generator.
1535
 *
1536
 * @param filename possible numbered sequence string
1537
 * @return 1 if a valid numbered sequence string, 0 otherwise
1538
 */
1539
int av_filename_number_test(const char *filename);
1540

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

    
1557
#if FF_API_SDP_CREATE
1558
attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1559
#endif
1560

    
1561
/**
1562
 * Return a positive value if the given filename has one of the given
1563
 * extensions, 0 otherwise.
1564
 *
1565
 * @param extensions a comma-separated list of filename extensions
1566
 */
1567
int av_match_ext(const char *filename, const char *extensions);
1568

    
1569
#endif /* AVFORMAT_AVFORMAT_H */