Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ f124b087

History | View | Annotate | Download (55.1 KB)

1
/*
2
 * copyright (c) 2001 Fabrice Bellard
3
 *
4
 * This file is part of FFmpeg.
5
 *
6
 * FFmpeg is free software; you can redistribute it and/or
7
 * modify it under the terms of the GNU Lesser General Public
8
 * License as published by the Free Software Foundation; either
9
 * version 2.1 of the License, or (at your option) any later version.
10
 *
11
 * FFmpeg is distributed in the hope that it will be useful,
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 * Lesser General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with FFmpeg; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
 */
20

    
21
#ifndef AVFORMAT_AVFORMAT_H
22
#define AVFORMAT_AVFORMAT_H
23

    
24

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

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

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

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

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

    
48
struct AVFormatContext;
49

    
50

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

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

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

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

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

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

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

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

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

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

    
184

    
185
/* packet functions */
186

    
187

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

    
198

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

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

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

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

    
228
struct AVCodecTag;
229

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

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

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

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

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

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

    
315
    enum CodecID subtitle_codec; /**< default subtitle codec */
316

    
317
#if FF_API_OLD_METADATA
318
    const AVMetadataConv *metadata_conv;
319
#endif
320

    
321
    const AVClass *priv_class; ///< AVClass for the private context
322

    
323
    /* private fields */
324
    struct AVOutputFormat *next;
325
} AVOutputFormat;
326

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

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

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

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

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

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

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

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

    
398
    /**
399
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
400
     */
401
    int flags;
402

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

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

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

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

    
427
    const struct AVCodecTag * const *codec_tag;
428

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

    
437
#if FF_API_OLD_METADATA
438
    const AVMetadataConv *metadata_conv;
439
#endif
440

    
441
    /* private fields */
442
    struct AVInputFormat *next;
443
} AVInputFormat;
444

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

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

    
462
#define AV_DISPOSITION_DEFAULT   0x0001
463
#define AV_DISPOSITION_DUB       0x0002
464
#define AV_DISPOSITION_ORIGINAL  0x0004
465
#define AV_DISPOSITION_COMMENT   0x0008
466
#define AV_DISPOSITION_LYRICS    0x0010
467
#define AV_DISPOSITION_KARAOKE   0x0020
468

    
469
/**
470
 * Track should be used during playback by default.
471
 * Useful for subtitle track that should be displayed
472
 * even when user did not explicitly ask for subtitles.
473
 */
474
#define AV_DISPOSITION_FORCED    0x0040
475

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

    
498
    /* internal data used in av_find_stream_info() */
499
    int64_t first_dts;
500

    
501
    /**
502
     * encoding: pts generation when outputting stream
503
     */
504
    struct AVFrac pts;
505

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

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

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

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

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

    
545
    /* av_read_frame() support */
546
    enum AVStreamParseType need_parsing;
547
    struct AVCodecParserContext *parser;
548

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

    
558
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
559

    
560
#if FF_API_LAVF_UNUSED
561
    attribute_deprecated int64_t unused[4+1];
562
#endif
563

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

    
568
    int disposition; /**< AV_DISPOSITION_* bit field */
569

    
570
    AVProbeData probe_data;
571
#define MAX_REORDER_DELAY 16
572
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
573

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

    
581
    AVMetadata *metadata;
582

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

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

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

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

    
612
    /**
613
     * Average framerate
614
     */
615
    AVRational avg_frame_rate;
616

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

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

    
635
#define AV_PROGRAM_RUNNING 1
636

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

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

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

    
669
#if FF_API_MAX_STREAMS
670
#define MAX_STREAMS 20
671
#endif
672

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

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

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

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

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

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

    
743
    /* av_read_frame() support */
744
    AVStream *cur_st;
745
#if FF_API_LAVF_UNUSED
746
    const uint8_t *cur_ptr_deprecated;
747
    int cur_len_deprecated;
748
    AVPacket cur_pkt_deprecated;
749
#endif
750

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

    
755
    int mux_rate;
756
    unsigned int packet_size;
757
    int preload;
758
    int max_delay;
759

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

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

    
776
    int loop_input;
777

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

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

    
789
    const uint8_t *key;
790
    int keylen;
791

    
792
    unsigned int nb_programs;
793
    AVProgram **programs;
794

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

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

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

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

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

    
831
    unsigned int nb_chapters;
832
    AVChapter **chapters;
833

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

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

    
849
    struct AVPacketList *packet_buffer_end;
850

    
851
    AVMetadata *metadata;
852

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

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

    
870
typedef struct AVPacketList {
871
    AVPacket pkt;
872
    struct AVPacketList *next;
873
} AVPacketList;
874

    
875
#if FF_API_FIRST_FORMAT
876
attribute_deprecated extern AVInputFormat *first_iformat;
877
attribute_deprecated extern AVOutputFormat *first_oformat;
878
#endif
879

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

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

    
894
enum CodecID av_guess_image2_codec(const char *filename);
895

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

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

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

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

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

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

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

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

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

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

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

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

    
1013
/* media file input */
1014

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

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

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

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

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

    
1066
#if FF_API_ALLOC_FORMAT_CONTEXT
1067
/**
1068
 * @deprecated Use avformat_alloc_context() instead.
1069
 */
1070
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1071
#endif
1072

    
1073
/**
1074
 * Allocate an AVFormatContext.
1075
 * avformat_free_context() can be used to free the context and everything
1076
 * allocated by the framework within it.
1077
 */
1078
AVFormatContext *avformat_alloc_context(void);
1079

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

    
1095
/**
1096
 * Find the "best" stream in the file.
1097
 * The best stream is determined according to various heuristics as the most
1098
 * likely to be what the user expects.
1099
 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1100
 * default decoder for the stream's codec; streams for which no decoder can
1101
 * be found are ignored.
1102
 *
1103
 * @param ic                media file handle
1104
 * @param type              stream type: video, audio, subtitles, etc.
1105
 * @param wanted_stream_nb  user-requested stream number,
1106
 *                          or -1 for automatic selection
1107
 * @param related_stream    try to find a stream related (eg. in the same
1108
 *                          program) to this one, or -1 if none
1109
 * @param decoder_ret       if non-NULL, returns the decoder for the
1110
 *                          selected stream
1111
 * @param flags             flags; none are currently defined
1112
 * @return  the non-negative stream number in case of success,
1113
 *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1114
 *          could be found,
1115
 *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1116
 * @note  If av_find_best_stream returns successfully and decoder_ret is not
1117
 *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1118
 */
1119
int av_find_best_stream(AVFormatContext *ic,
1120
                        enum AVMediaType type,
1121
                        int wanted_stream_nb,
1122
                        int related_stream,
1123
                        AVCodec **decoder_ret,
1124
                        int flags);
1125

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

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

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

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

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

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

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

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

    
1232
/**
1233
 * Free an AVFormatContext and all its streams.
1234
 * @param s context to free
1235
 */
1236
void avformat_free_context(AVFormatContext *s);
1237

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

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

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

    
1279
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1280
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1281
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1282
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1283

    
1284
int av_find_default_stream_index(AVFormatContext *s);
1285

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

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

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

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

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

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

    
1349
/**
1350
 * media file output
1351
 */
1352
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1353

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

    
1380
/**
1381
 * Allocate the stream private data and write the stream header to an
1382
 * output media file.
1383
 *
1384
 * @param s media file handle
1385
 * @return 0 if OK, AVERROR_xxx on error
1386
 */
1387
int av_write_header(AVFormatContext *s);
1388

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

    
1403
/**
1404
 * Write a packet to an output media file ensuring correct interleaving.
1405
 *
1406
 * The packet must contain one audio or video frame.
1407
 * If the packets are already correctly interleaved, the application should
1408
 * call av_write_frame() instead as it is slightly faster. It is also important
1409
 * to keep in mind that completely non-interleaved input will need huge amounts
1410
 * of memory to interleave with this, so it is preferable to interleave at the
1411
 * demuxer level.
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_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1419

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

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

    
1449
void dump_format(AVFormatContext *ic,
1450
                 int index,
1451
                 const char *url,
1452
                 int is_output);
1453

    
1454
#if FF_API_PARSE_FRAME_PARAM
1455
/**
1456
 * Parse width and height out of string str.
1457
 * @deprecated Use av_parse_video_frame_size instead.
1458
 */
1459
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1460
                                          const char *str);
1461

    
1462
/**
1463
 * Convert framerate from a string to a fraction.
1464
 * @deprecated Use av_parse_video_frame_rate instead.
1465
 */
1466
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1467
                                          const char *arg);
1468
#endif
1469

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

    
1499
/**
1500
 * Get the current time in microseconds.
1501
 */
1502
int64_t av_gettime(void);
1503

    
1504
/* ffm-specific for ffserver */
1505
#define FFM_PACKET_SIZE 4096
1506
int64_t ffm_read_write_index(int fd);
1507
int ffm_write_write_index(int fd, int64_t pos);
1508
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1509

    
1510
/**
1511
 * Attempt to find a specific tag in a URL.
1512
 *
1513
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1514
 * Return 1 if found.
1515
 */
1516
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
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 buff 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 avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1556

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

    
1565
#endif /* AVFORMAT_AVFORMAT_H */