Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 4df001d7

History | View | Annotate | Download (53.4 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_METADATA2
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
/**
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 depending on flags)
142
 * @param value tag value to add to *pm (will be av_strduped depending on flags).
143
 *        Passing a NULL value will cause an existing tag to be deleted.
144
 * @return >= 0 on success otherwise an error code <0
145
 */
146
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
147

    
148
#if FF_API_OLD_METADATA2
149
/**
150
 * This function is provided for compatibility reason and currently does nothing.
151
 */
152
attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
153
                                                                        const AVMetadataConv *s_conv);
154
#endif
155

    
156
/**
157
 * Copy metadata from one AVMetadata struct into another.
158
 * @param dst pointer to a pointer to a AVMetadata struct. If *dst is NULL,
159
 *            this function will allocate a struct for you and put it in *dst
160
 * @param src pointer to source AVMetadata struct
161
 * @param flags flags to use when setting metadata in *dst
162
 * @note metadata is read using the AV_METADATA_IGNORE_SUFFIX flag
163
 */
164
void av_metadata_copy(AVMetadata **dst, AVMetadata *src, int flags);
165

    
166
/**
167
 * Free all the memory allocated for an AVMetadata struct.
168
 */
169
void av_metadata_free(AVMetadata **m);
170

    
171

    
172
/* packet functions */
173

    
174

    
175
/**
176
 * Allocate and read the payload of a packet and initialize its
177
 * fields with default values.
178
 *
179
 * @param pkt packet
180
 * @param size desired payload size
181
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
182
 */
183
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
184

    
185

    
186
/**
187
 * Read data and append it to the current content of the AVPacket.
188
 * If pkt->size is 0 this is identical to av_get_packet.
189
 * Note that this uses av_grow_packet and thus involves a realloc
190
 * which is inefficient. Thus this function should only be used
191
 * when there is no reasonable way to know (an upper bound of)
192
 * the final size.
193
 *
194
 * @param pkt packet
195
 * @param size amount of data to read
196
 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
197
 *         will not be lost even if an error occurs.
198
 */
199
int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
200

    
201
/*************************************************/
202
/* fractional numbers for exact pts handling */
203

    
204
/**
205
 * The exact value of the fractional number is: 'val + num / den'.
206
 * num is assumed to be 0 <= num < den.
207
 */
208
typedef struct AVFrac {
209
    int64_t val, num, den;
210
} AVFrac;
211

    
212
/*************************************************/
213
/* input/output formats */
214

    
215
struct AVCodecTag;
216

    
217
/**
218
 * This structure contains the data a format has to probe a file.
219
 */
220
typedef struct AVProbeData {
221
    const char *filename;
222
    unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
223
    int buf_size;       /**< Size of buf except extra allocated bytes */
224
} AVProbeData;
225

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

    
229
typedef struct AVFormatParameters {
230
    AVRational time_base;
231
    int sample_rate;
232
    int channels;
233
    int width;
234
    int height;
235
    enum PixelFormat pix_fmt;
236
    int channel; /**< Used to select DV channel. */
237
    const char *standard; /**< TV standard, NTSC, PAL, SECAM */
238
    unsigned int mpeg2ts_raw:1;  /**< Force raw MPEG-2 transport stream output, if possible. */
239
    unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
240
                                            stream packet (only meaningful if
241
                                            mpeg2ts_raw is TRUE). */
242
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
243
                                            immediately (RTSP only). */
244
    unsigned int prealloced_context:1;
245
#if FF_API_PARAMETERS_CODEC_ID
246
    attribute_deprecated enum CodecID video_codec_id;
247
    attribute_deprecated enum CodecID audio_codec_id;
248
#endif
249
} AVFormatParameters;
250

    
251
//! Demuxer will use avio_open, no opened file should be provided by the caller.
252
#define AVFMT_NOFILE        0x0001
253
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
254
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
255
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
256
                                      raw picture data. */
257
#define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
258
#define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
259
#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
260
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
261
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
262
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
263
#define AVFMT_NOSTREAMS     0x1000 /**< Format does not require any streams */
264

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

    
298
    /**
299
     * List of supported codec_id-codec_tag pairs, ordered by "better
300
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
301
     */
302
    const struct AVCodecTag * const *codec_tag;
303

    
304
    enum CodecID subtitle_codec; /**< default subtitle codec */
305

    
306
#if FF_API_OLD_METADATA2
307
    const AVMetadataConv *metadata_conv;
308
#endif
309

    
310
    const AVClass *priv_class; ///< AVClass for the private context
311

    
312
    /* private fields */
313
    struct AVOutputFormat *next;
314
} AVOutputFormat;
315

    
316
typedef struct AVInputFormat {
317
    /**
318
     * A comma separated list of short names for the format. New names
319
     * may be appended with a minor bump.
320
     */
321
    const char *name;
322

    
323
    /**
324
     * Descriptive name for the format, meant to be more human-readable
325
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
326
     * to define it.
327
     */
328
    const char *long_name;
329

    
330
    /**
331
     * Size of private data so that it can be allocated in the wrapper.
332
     */
333
    int priv_data_size;
334

    
335
    /**
336
     * Tell if a given file has a chance of being parsed as this format.
337
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
338
     * big so you do not have to check for that unless you need more.
339
     */
340
    int (*read_probe)(AVProbeData *);
341

    
342
    /**
343
     * Read the format header and initialize the AVFormatContext
344
     * structure. Return 0 if OK. 'ap' if non-NULL contains
345
     * additional parameters. Only used in raw format right
346
     * now. 'av_new_stream' should be called to create new streams.
347
     */
348
    int (*read_header)(struct AVFormatContext *,
349
                       AVFormatParameters *ap);
350

    
351
    /**
352
     * Read one packet and put it in 'pkt'. pts and flags are also
353
     * set. 'av_new_stream' can be called only if the flag
354
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
355
     * background thread).
356
     * @return 0 on success, < 0 on error.
357
     *         When returning an error, pkt must not have been allocated
358
     *         or must be freed before returning
359
     */
360
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
361

    
362
    /**
363
     * Close the stream. The AVFormatContext and AVStreams are not
364
     * freed by this function
365
     */
366
    int (*read_close)(struct AVFormatContext *);
367

    
368
#if FF_API_READ_SEEK
369
    /**
370
     * Seek to a given timestamp relative to the frames in
371
     * stream component stream_index.
372
     * @param stream_index Must not be -1.
373
     * @param flags Selects which direction should be preferred if no exact
374
     *              match is available.
375
     * @return >= 0 on success (but not necessarily the new offset)
376
     */
377
    attribute_deprecated int (*read_seek)(struct AVFormatContext *,
378
                                          int stream_index, int64_t timestamp, int flags);
379
#endif
380
    /**
381
     * Gets the next timestamp in stream[stream_index].time_base units.
382
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
383
     */
384
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
385
                              int64_t *pos, int64_t pos_limit);
386

    
387
    /**
388
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
389
     */
390
    int flags;
391

    
392
    /**
393
     * If extensions are defined, then no probe is done. You should
394
     * usually not use extension format guessing because it is not
395
     * reliable enough
396
     */
397
    const char *extensions;
398

    
399
    /**
400
     * General purpose read-only value that the format can use.
401
     */
402
    int value;
403

    
404
    /**
405
     * Start/resume playing - only meaningful if using a network-based format
406
     * (RTSP).
407
     */
408
    int (*read_play)(struct AVFormatContext *);
409

    
410
    /**
411
     * Pause playing - only meaningful if using a network-based format
412
     * (RTSP).
413
     */
414
    int (*read_pause)(struct AVFormatContext *);
415

    
416
    const struct AVCodecTag * const *codec_tag;
417

    
418
    /**
419
     * Seek to timestamp ts.
420
     * Seeking will be done so that the point from which all active streams
421
     * can be presented successfully will be closest to ts and within min/max_ts.
422
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
423
     */
424
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
425

    
426
#if FF_API_OLD_METADATA2
427
    const AVMetadataConv *metadata_conv;
428
#endif
429

    
430
    /* private fields */
431
    struct AVInputFormat *next;
432
} AVInputFormat;
433

    
434
enum AVStreamParseType {
435
    AVSTREAM_PARSE_NONE,
436
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
437
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
438
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
439
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
440
};
441

    
442
typedef struct AVIndexEntry {
443
    int64_t pos;
444
    int64_t timestamp;
445
#define AVINDEX_KEYFRAME 0x0001
446
    int flags:2;
447
    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).
448
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
449
} AVIndexEntry;
450

    
451
#define AV_DISPOSITION_DEFAULT   0x0001
452
#define AV_DISPOSITION_DUB       0x0002
453
#define AV_DISPOSITION_ORIGINAL  0x0004
454
#define AV_DISPOSITION_COMMENT   0x0008
455
#define AV_DISPOSITION_LYRICS    0x0010
456
#define AV_DISPOSITION_KARAOKE   0x0020
457

    
458
/**
459
 * Track should be used during playback by default.
460
 * Useful for subtitle track that should be displayed
461
 * even when user did not explicitly ask for subtitles.
462
 */
463
#define AV_DISPOSITION_FORCED    0x0040
464
#define AV_DISPOSITION_HEARING_IMPAIRED  0x0080  /**< stream for hearing impaired audiences */
465
#define AV_DISPOSITION_VISUAL_IMPAIRED   0x0100  /**< stream for visual impaired audiences */
466
#define AV_DISPOSITION_CLEAN_EFFECTS     0x0200  /**< stream without voice */
467

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

    
490
    /* internal data used in av_find_stream_info() */
491
    int64_t first_dts;
492

    
493
    /**
494
     * encoding: pts generation when outputting stream
495
     */
496
    struct AVFrac pts;
497

    
498
    /**
499
     * This is the fundamental unit of time (in seconds) in terms
500
     * of which frame timestamps are represented. For fixed-fps content,
501
     * time base should be 1/framerate and timestamp increments should be 1.
502
     * decoding: set by libavformat
503
     * encoding: set by libavformat in av_write_header
504
     */
505
    AVRational time_base;
506
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
507
    /* ffmpeg.c private use */
508
    int stream_copy; /**< If set, just copy stream. */
509
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
510

    
511
    //FIXME move stuff to a flags field?
512
    /**
513
     * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
514
     * MN: dunno if that is the right place for it
515
     */
516
    float quality;
517

    
518
    /**
519
     * Decoding: pts of the first frame of the stream, in stream time base.
520
     * Only set this if you are absolutely 100% sure that the value you set
521
     * it to really is the pts of the first frame.
522
     * This may be undefined (AV_NOPTS_VALUE).
523
     */
524
    int64_t start_time;
525

    
526
    /**
527
     * Decoding: duration of the stream, in stream time base.
528
     * If a source file does not specify a duration, but does specify
529
     * a bitrate, this value will be estimated from bitrate and file size.
530
     */
531
    int64_t duration;
532

    
533
    /* av_read_frame() support */
534
    enum AVStreamParseType need_parsing;
535
    struct AVCodecParserContext *parser;
536

    
537
    int64_t cur_dts;
538
    int last_IP_duration;
539
    int64_t last_IP_pts;
540
    /* av_seek_frame() support */
541
    AVIndexEntry *index_entries; /**< Only used if the format does not
542
                                    support seeking natively. */
543
    int nb_index_entries;
544
    unsigned int index_entries_allocated_size;
545

    
546
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
547

    
548
#if FF_API_LAVF_UNUSED
549
    attribute_deprecated int64_t unused[4+1];
550
#endif
551

    
552
    int disposition; /**< AV_DISPOSITION_* bit field */
553

    
554
    AVProbeData probe_data;
555
#define MAX_REORDER_DELAY 16
556
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
557

    
558
    /**
559
     * sample aspect ratio (0 if unknown)
560
     * - encoding: Set by user.
561
     * - decoding: Set by libavformat.
562
     */
563
    AVRational sample_aspect_ratio;
564

    
565
    AVMetadata *metadata;
566

    
567
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
568
    /* external applications; try to use something else if at all possible.    */
569
    const uint8_t *cur_ptr;
570
    int cur_len;
571
    AVPacket cur_pkt;
572

    
573
    // Timestamp generation support:
574
    /**
575
     * Timestamp corresponding to the last dts sync point.
576
     *
577
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
578
     * a DTS is received from the underlying container. Otherwise set to
579
     * AV_NOPTS_VALUE by default.
580
     */
581
    int64_t reference_dts;
582

    
583
    /**
584
     * Number of packets to buffer for codec probing
585
     * NOT PART OF PUBLIC API
586
     */
587
#define MAX_PROBE_PACKETS 2500
588
    int probe_packets;
589

    
590
    /**
591
     * last packet in packet_buffer for this stream when muxing.
592
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
593
     */
594
    struct AVPacketList *last_in_packet_buffer;
595

    
596
    /**
597
     * Average framerate
598
     */
599
    AVRational avg_frame_rate;
600

    
601
    /**
602
     * Number of frames that have been demuxed during av_find_stream_info()
603
     */
604
    int codec_info_nb_frames;
605

    
606
    /**
607
     * Stream informations used internally by av_find_stream_info()
608
     */
609
#define MAX_STD_TIMEBASES (60*12+5)
610
    struct {
611
        int64_t last_dts;
612
        int64_t duration_gcd;
613
        int duration_count;
614
        double duration_error[MAX_STD_TIMEBASES];
615
        int64_t codec_info_duration;
616
    } *info;
617
} AVStream;
618

    
619
#define AV_PROGRAM_RUNNING 1
620

    
621
/**
622
 * New fields can be added to the end with minor version bumps.
623
 * Removal, reordering and changes to existing fields require a major
624
 * version bump.
625
 * sizeof(AVProgram) must not be used outside libav*.
626
 */
627
typedef struct AVProgram {
628
    int            id;
629
    int            flags;
630
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
631
    unsigned int   *stream_index;
632
    unsigned int   nb_stream_indexes;
633
    AVMetadata *metadata;
634
} AVProgram;
635

    
636
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
637
                                         (streams are added dynamically) */
638

    
639
typedef struct AVChapter {
640
    int id;                 ///< unique ID to identify the chapter
641
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
642
    int64_t start, end;     ///< chapter start/end time in time_base units
643
    AVMetadata *metadata;
644
} AVChapter;
645

    
646
/**
647
 * Format I/O context.
648
 * New fields can be added to the end with minor version bumps.
649
 * Removal, reordering and changes to existing fields require a major
650
 * version bump.
651
 * sizeof(AVFormatContext) must not be used outside libav*.
652
 */
653
typedef struct AVFormatContext {
654
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
655
    /* Can only be iformat or oformat, not both at the same time. */
656
    struct AVInputFormat *iformat;
657
    struct AVOutputFormat *oformat;
658
    void *priv_data;
659
    AVIOContext *pb;
660
    unsigned int nb_streams;
661
    AVStream **streams;
662
    char filename[1024]; /**< input or output filename */
663
    /* stream info */
664
    int64_t timestamp;
665

    
666
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
667
    /* private data for pts handling (do not modify directly). */
668
    /**
669
     * This buffer is only needed when packets were already buffered but
670
     * not decoded, for example to get the codec parameters in MPEG
671
     * streams.
672
     */
673
    struct AVPacketList *packet_buffer;
674

    
675
    /**
676
     * Decoding: position of the first frame of the component, in
677
     * AV_TIME_BASE fractional seconds. NEVER set this value directly:
678
     * It is deduced from the AVStream values.
679
     */
680
    int64_t start_time;
681

    
682
    /**
683
     * Decoding: duration of the stream, in AV_TIME_BASE fractional
684
     * seconds. Only set this value if you know none of the individual stream
685
     * durations and also dont set any of them. This is deduced from the
686
     * AVStream values if not set.
687
     */
688
    int64_t duration;
689

    
690
    /**
691
     * decoding: total file size, 0 if unknown
692
     */
693
    int64_t file_size;
694

    
695
    /**
696
     * Decoding: total stream bitrate in bit/s, 0 if not
697
     * available. Never set it directly if the file_size and the
698
     * duration are known as Libav can compute it automatically.
699
     */
700
    int bit_rate;
701

    
702
    /* av_read_frame() support */
703
    AVStream *cur_st;
704
#if FF_API_LAVF_UNUSED
705
    const uint8_t *cur_ptr_deprecated;
706
    int cur_len_deprecated;
707
    AVPacket cur_pkt_deprecated;
708
#endif
709

    
710
    /* av_seek_frame() support */
711
    int64_t data_offset; /**< offset of the first packet */
712
#if FF_API_INDEX_BUILT
713
    attribute_deprecated int index_built;
714
#endif
715

    
716
    int mux_rate;
717
    unsigned int packet_size;
718
    int preload;
719
    int max_delay;
720

    
721
#define AVFMT_NOOUTPUTLOOP -1
722
#define AVFMT_INFINITEOUTPUTLOOP 0
723
    /**
724
     * number of times to loop output in formats that support it
725
     */
726
    int loop_output;
727

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

    
737
    int loop_input;
738

    
739
    /**
740
     * decoding: size of data to probe; encoding: unused.
741
     */
742
    unsigned int probesize;
743

    
744
    /**
745
     * Maximum time (in AV_TIME_BASE units) during which the input should
746
     * be analyzed in av_find_stream_info().
747
     */
748
    int max_analyze_duration;
749

    
750
    const uint8_t *key;
751
    int keylen;
752

    
753
    unsigned int nb_programs;
754
    AVProgram **programs;
755

    
756
    /**
757
     * Forced video codec_id.
758
     * Demuxing: Set by user.
759
     */
760
    enum CodecID video_codec_id;
761

    
762
    /**
763
     * Forced audio codec_id.
764
     * Demuxing: Set by user.
765
     */
766
    enum CodecID audio_codec_id;
767

    
768
    /**
769
     * Forced subtitle codec_id.
770
     * Demuxing: Set by user.
771
     */
772
    enum CodecID subtitle_codec_id;
773

    
774
    /**
775
     * Maximum amount of memory in bytes to use for the index of each stream.
776
     * If the index exceeds this size, entries will be discarded as
777
     * needed to maintain a smaller size. This can lead to slower or less
778
     * accurate seeking (depends on demuxer).
779
     * Demuxers for which a full in-memory index is mandatory will ignore
780
     * this.
781
     * muxing  : unused
782
     * demuxing: set by user
783
     */
784
    unsigned int max_index_size;
785

    
786
    /**
787
     * Maximum amount of memory in bytes to use for buffering frames
788
     * obtained from realtime capture devices.
789
     */
790
    unsigned int max_picture_buffer;
791

    
792
    unsigned int nb_chapters;
793
    AVChapter **chapters;
794

    
795
    /**
796
     * Flags to enable debugging.
797
     */
798
    int debug;
799
#define FF_FDEBUG_TS        0x0001
800

    
801
    /**
802
     * Raw packets from the demuxer, prior to parsing and decoding.
803
     * This buffer is used for buffering packets until the codec can
804
     * be identified, as parsing cannot be done without knowing the
805
     * codec.
806
     */
807
    struct AVPacketList *raw_packet_buffer;
808
    struct AVPacketList *raw_packet_buffer_end;
809

    
810
    struct AVPacketList *packet_buffer_end;
811

    
812
    AVMetadata *metadata;
813

    
814
    /**
815
     * Remaining size available for raw_packet_buffer, in bytes.
816
     * NOT PART OF PUBLIC API
817
     */
818
#define RAW_PACKET_BUFFER_SIZE 2500000
819
    int raw_packet_buffer_remaining_size;
820

    
821
    /**
822
     * Start time of the stream in real world time, in microseconds
823
     * since the unix epoch (00:00 1st January 1970). That is, pts=0
824
     * in the stream was captured at this real world time.
825
     * - encoding: Set by user.
826
     * - decoding: Unused.
827
     */
828
    int64_t start_time_realtime;
829
} AVFormatContext;
830

    
831
typedef struct AVPacketList {
832
    AVPacket pkt;
833
    struct AVPacketList *next;
834
} AVPacketList;
835

    
836
#if FF_API_FIRST_FORMAT
837
attribute_deprecated extern AVInputFormat *first_iformat;
838
attribute_deprecated extern AVOutputFormat *first_oformat;
839
#endif
840

    
841
/**
842
 * If f is NULL, returns the first registered input format,
843
 * if f is non-NULL, returns the next registered input format after f
844
 * or NULL if f is the last one.
845
 */
846
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
847

    
848
/**
849
 * If f is NULL, returns the first registered output format,
850
 * if f is non-NULL, returns the next registered output format after f
851
 * or NULL if f is the last one.
852
 */
853
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
854

    
855
#if FF_API_GUESS_IMG2_CODEC
856
attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
857
#endif
858

    
859
/* XXX: Use automatic init with either ELF sections or C file parser */
860
/* modules. */
861

    
862
/* utils.c */
863
void av_register_input_format(AVInputFormat *format);
864
void av_register_output_format(AVOutputFormat *format);
865

    
866
/**
867
 * Return the output format in the list of registered output formats
868
 * which best matches the provided parameters, or return NULL if
869
 * there is no match.
870
 *
871
 * @param short_name if non-NULL checks if short_name matches with the
872
 * names of the registered formats
873
 * @param filename if non-NULL checks if filename terminates with the
874
 * extensions of the registered formats
875
 * @param mime_type if non-NULL checks if mime_type matches with the
876
 * MIME type of the registered formats
877
 */
878
AVOutputFormat *av_guess_format(const char *short_name,
879
                                const char *filename,
880
                                const char *mime_type);
881

    
882
/**
883
 * Guess the codec ID based upon muxer and filename.
884
 */
885
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
886
                            const char *filename, const char *mime_type,
887
                            enum AVMediaType type);
888

    
889
/**
890
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
891
 *
892
 * @param f The file stream pointer where the dump should be sent to.
893
 * @param buf buffer
894
 * @param size buffer size
895
 *
896
 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
897
 */
898
void av_hex_dump(FILE *f, uint8_t *buf, int size);
899

    
900
/**
901
 * Send a nice hexadecimal dump of a buffer to the log.
902
 *
903
 * @param avcl A pointer to an arbitrary struct of which the first field is a
904
 * pointer to an AVClass struct.
905
 * @param level The importance level of the message, lower values signifying
906
 * higher importance.
907
 * @param buf buffer
908
 * @param size buffer size
909
 *
910
 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
911
 */
912
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
913

    
914
/**
915
 * Send a nice dump of a packet to the specified file stream.
916
 *
917
 * @param f The file stream pointer where the dump should be sent to.
918
 * @param pkt packet to dump
919
 * @param dump_payload True if the payload must be displayed, too.
920
 * @param st AVStream that the packet belongs to
921
 */
922
void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
923

    
924

    
925
/**
926
 * Send a nice dump of a packet to the log.
927
 *
928
 * @param avcl A pointer to an arbitrary struct of which the first field is a
929
 * pointer to an AVClass struct.
930
 * @param level The importance level of the message, lower values signifying
931
 * higher importance.
932
 * @param pkt packet to dump
933
 * @param dump_payload True if the payload must be displayed, too.
934
 * @param st AVStream that the packet belongs to
935
 */
936
void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
937
                      AVStream *st);
938

    
939
#if FF_API_PKT_DUMP
940
attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
941
attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
942
                                          int dump_payload);
943
#endif
944

    
945
/**
946
 * Initialize libavformat and register all the muxers, demuxers and
947
 * protocols. If you do not call this function, then you can select
948
 * exactly which formats you want to support.
949
 *
950
 * @see av_register_input_format()
951
 * @see av_register_output_format()
952
 * @see av_register_protocol()
953
 */
954
void av_register_all(void);
955

    
956
/**
957
 * Get the CodecID for the given codec tag tag.
958
 * If no codec id is found returns CODEC_ID_NONE.
959
 *
960
 * @param tags list of supported codec_id-codec_tag pairs, as stored
961
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
962
 */
963
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
964

    
965
/**
966
 * Get the codec tag for the given codec id id.
967
 * If no codec tag is found returns 0.
968
 *
969
 * @param tags list of supported codec_id-codec_tag pairs, as stored
970
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
971
 */
972
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
973

    
974
/* media file input */
975

    
976
/**
977
 * Find AVInputFormat based on the short name of the input format.
978
 */
979
AVInputFormat *av_find_input_format(const char *short_name);
980

    
981
/**
982
 * Guess the file format.
983
 *
984
 * @param is_opened Whether the file is already opened; determines whether
985
 *                  demuxers with or without AVFMT_NOFILE are probed.
986
 */
987
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
988

    
989
/**
990
 * Guess the file format.
991
 *
992
 * @param is_opened Whether the file is already opened; determines whether
993
 *                  demuxers with or without AVFMT_NOFILE are probed.
994
 * @param score_max A probe score larger that this is required to accept a
995
 *                  detection, the variable is set to the actual detection
996
 *                  score afterwards.
997
 *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
998
 *                  to retry with a larger probe buffer.
999
 */
1000
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1001

    
1002
/**
1003
 * Probe a bytestream to determine the input format. Each time a probe returns
1004
 * with a score that is too low, the probe buffer size is increased and another
1005
 * attempt is made. When the maximum probe size is reached, the input format
1006
 * with the highest score is returned.
1007
 *
1008
 * @param pb the bytestream to probe
1009
 * @param fmt the input format is put here
1010
 * @param filename the filename of the stream
1011
 * @param logctx the log context
1012
 * @param offset the offset within the bytestream to probe from
1013
 * @param max_probe_size the maximum probe buffer size (zero for default)
1014
 * @return 0 in case of success, a negative value corresponding to an
1015
 * AVERROR code otherwise
1016
 */
1017
int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1018
                          const char *filename, void *logctx,
1019
                          unsigned int offset, unsigned int max_probe_size);
1020

    
1021
/**
1022
 * Allocate all the structures needed to read an input stream.
1023
 *        This does not open the needed codecs for decoding the stream[s].
1024
 */
1025
int av_open_input_stream(AVFormatContext **ic_ptr,
1026
                         AVIOContext *pb, const char *filename,
1027
                         AVInputFormat *fmt, AVFormatParameters *ap);
1028

    
1029
/**
1030
 * Open a media file as input. The codecs are not opened. Only the file
1031
 * header (if present) is read.
1032
 *
1033
 * @param ic_ptr The opened media file handle is put here.
1034
 * @param filename filename to open
1035
 * @param fmt If non-NULL, force the file format to use.
1036
 * @param buf_size optional buffer size (zero if default is OK)
1037
 * @param ap Additional parameters needed when opening the file
1038
 *           (NULL if default).
1039
 * @return 0 if OK, AVERROR_xxx otherwise
1040
 */
1041
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1042
                       AVInputFormat *fmt,
1043
                       int buf_size,
1044
                       AVFormatParameters *ap);
1045

    
1046
/**
1047
 * Allocate an AVFormatContext.
1048
 * avformat_free_context() can be used to free the context and everything
1049
 * allocated by the framework within it.
1050
 */
1051
AVFormatContext *avformat_alloc_context(void);
1052

    
1053
/**
1054
 * Read packets of a media file to get stream information. This
1055
 * is useful for file formats with no headers such as MPEG. This
1056
 * function also computes the real framerate in case of MPEG-2 repeat
1057
 * frame mode.
1058
 * The logical file position is not changed by this function;
1059
 * examined packets may be buffered for later processing.
1060
 *
1061
 * @param ic media file handle
1062
 * @return >=0 if OK, AVERROR_xxx on error
1063
 * @todo Let the user decide somehow what information is needed so that
1064
 *       we do not waste time getting stuff the user does not need.
1065
 */
1066
int av_find_stream_info(AVFormatContext *ic);
1067

    
1068
/**
1069
 * Find the "best" stream in the file.
1070
 * The best stream is determined according to various heuristics as the most
1071
 * likely to be what the user expects.
1072
 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1073
 * default decoder for the stream's codec; streams for which no decoder can
1074
 * be found are ignored.
1075
 *
1076
 * @param ic                media file handle
1077
 * @param type              stream type: video, audio, subtitles, etc.
1078
 * @param wanted_stream_nb  user-requested stream number,
1079
 *                          or -1 for automatic selection
1080
 * @param related_stream    try to find a stream related (eg. in the same
1081
 *                          program) to this one, or -1 if none
1082
 * @param decoder_ret       if non-NULL, returns the decoder for the
1083
 *                          selected stream
1084
 * @param flags             flags; none are currently defined
1085
 * @return  the non-negative stream number in case of success,
1086
 *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1087
 *          could be found,
1088
 *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1089
 * @note  If av_find_best_stream returns successfully and decoder_ret is not
1090
 *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1091
 */
1092
int av_find_best_stream(AVFormatContext *ic,
1093
                        enum AVMediaType type,
1094
                        int wanted_stream_nb,
1095
                        int related_stream,
1096
                        AVCodec **decoder_ret,
1097
                        int flags);
1098

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

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

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

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

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

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

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

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

    
1205
/**
1206
 * Free an AVFormatContext and all its streams.
1207
 * @param s context to free
1208
 */
1209
void avformat_free_context(AVFormatContext *s);
1210

    
1211
/**
1212
 * Add a new stream to a media file.
1213
 *
1214
 * Can only be called in the read_header() function. If the flag
1215
 * AVFMTCTX_NOHEADER is in the format context, then new streams
1216
 * can be added in read_packet too.
1217
 *
1218
 * @param s media file handle
1219
 * @param id file-format-dependent stream ID
1220
 */
1221
AVStream *av_new_stream(AVFormatContext *s, int id);
1222
AVProgram *av_new_program(AVFormatContext *s, int id);
1223

    
1224
/**
1225
 * Set the pts for a given stream. If the new values would be invalid
1226
 * (<= 0), it leaves the AVStream unchanged.
1227
 *
1228
 * @param s stream
1229
 * @param pts_wrap_bits number of bits effectively used by the pts
1230
 *        (used for wrap control, 33 is the value for MPEG)
1231
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1232
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1233
 */
1234
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1235
                     unsigned int pts_num, unsigned int pts_den);
1236

    
1237
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1238
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1239
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1240
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1241

    
1242
int av_find_default_stream_index(AVFormatContext *s);
1243

    
1244
/**
1245
 * Get the index for a specific timestamp.
1246
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1247
 *                 to the timestamp which is <= the requested one, if backward
1248
 *                 is 0, then it will be >=
1249
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1250
 * @return < 0 if no such timestamp could be found
1251
 */
1252
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1253

    
1254
/**
1255
 * Add an index entry into a sorted list. Update the entry if the list
1256
 * already contains it.
1257
 *
1258
 * @param timestamp timestamp in the time base of the given stream
1259
 */
1260
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1261
                       int size, int distance, int flags);
1262

    
1263
/**
1264
 * Perform a binary search using av_index_search_timestamp() and
1265
 * AVInputFormat.read_timestamp().
1266
 * This is not supposed to be called directly by a user application,
1267
 * but by demuxers.
1268
 * @param target_ts target timestamp in the time base of the given stream
1269
 * @param stream_index stream number
1270
 */
1271
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1272
                         int64_t target_ts, int flags);
1273

    
1274
/**
1275
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1276
 *
1277
 * Stream ref_st unchanged, others set cur_dts in their native time base.
1278
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1279
 * @param timestamp new dts expressed in time_base of param ref_st
1280
 * @param ref_st reference stream giving time_base of param timestamp
1281
 */
1282
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1283

    
1284
/**
1285
 * Perform a binary search using read_timestamp().
1286
 * This is not supposed to be called directly by a user application,
1287
 * but by demuxers.
1288
 * @param target_ts target timestamp in the time base of the given stream
1289
 * @param stream_index stream number
1290
 */
1291
int64_t av_gen_search(AVFormatContext *s, int stream_index,
1292
                      int64_t target_ts, int64_t pos_min,
1293
                      int64_t pos_max, int64_t pos_limit,
1294
                      int64_t ts_min, int64_t ts_max,
1295
                      int flags, int64_t *ts_ret,
1296
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1297

    
1298
/**
1299
 * media file output
1300
 */
1301
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1302

    
1303
/**
1304
 * Split a URL string into components.
1305
 *
1306
 * The pointers to buffers for storing individual components may be null,
1307
 * in order to ignore that component. Buffers for components not found are
1308
 * set to empty strings. If the port is not found, it is set to a negative
1309
 * value.
1310
 *
1311
 * @param proto the buffer for the protocol
1312
 * @param proto_size the size of the proto buffer
1313
 * @param authorization the buffer for the authorization
1314
 * @param authorization_size the size of the authorization buffer
1315
 * @param hostname the buffer for the host name
1316
 * @param hostname_size the size of the hostname buffer
1317
 * @param port_ptr a pointer to store the port number in
1318
 * @param path the buffer for the path
1319
 * @param path_size the size of the path buffer
1320
 * @param url the URL to split
1321
 */
1322
void av_url_split(char *proto,         int proto_size,
1323
                  char *authorization, int authorization_size,
1324
                  char *hostname,      int hostname_size,
1325
                  int *port_ptr,
1326
                  char *path,          int path_size,
1327
                  const char *url);
1328

    
1329
/**
1330
 * Allocate the stream private data and write the stream header to an
1331
 * output media file.
1332
 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1333
 * but for some formats it might also be some other time base
1334
 *
1335
 * @param s media file handle
1336
 * @return 0 if OK, AVERROR_xxx on error
1337
 */
1338
int av_write_header(AVFormatContext *s);
1339

    
1340
/**
1341
 * Write a packet to an output media file.
1342
 *
1343
 * The packet shall contain one audio or video frame.
1344
 * The packet must be correctly interleaved according to the container
1345
 * specification, if not then av_interleaved_write_frame must be used.
1346
 *
1347
 * @param s media file handle
1348
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1349
              dts/pts, ...
1350
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1351
 */
1352
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1353

    
1354
/**
1355
 * Write a packet to an output media file ensuring correct interleaving.
1356
 *
1357
 * The packet must contain one audio or video frame.
1358
 * If the packets are already correctly interleaved, the application should
1359
 * call av_write_frame() instead as it is slightly faster. It is also important
1360
 * to keep in mind that completely non-interleaved input will need huge amounts
1361
 * of memory to interleave with this, so it is preferable to interleave at the
1362
 * demuxer level.
1363
 *
1364
 * @param s media file handle
1365
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1366
              dts/pts, ...
1367
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1368
 */
1369
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1370

    
1371
/**
1372
 * Interleave a packet per dts in an output media file.
1373
 *
1374
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1375
 * function, so they cannot be used after it. Note that calling av_free_packet()
1376
 * on them is still safe.
1377
 *
1378
 * @param s media file handle
1379
 * @param out the interleaved packet will be output here
1380
 * @param pkt the input packet
1381
 * @param flush 1 if no further packets are available as input and all
1382
 *              remaining packets should be output
1383
 * @return 1 if a packet was output, 0 if no packet could be output,
1384
 *         < 0 if an error occurred
1385
 */
1386
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1387
                                 AVPacket *pkt, int flush);
1388

    
1389
/**
1390
 * Write the stream trailer to an output media file and free the
1391
 * file private data.
1392
 *
1393
 * May only be called after a successful call to av_write_header.
1394
 *
1395
 * @param s media file handle
1396
 * @return 0 if OK, AVERROR_xxx on error
1397
 */
1398
int av_write_trailer(AVFormatContext *s);
1399

    
1400
#if FF_API_DUMP_FORMAT
1401
attribute_deprecated void dump_format(AVFormatContext *ic,
1402
                                      int index,
1403
                                      const char *url,
1404
                                      int is_output);
1405
#endif
1406

    
1407
void av_dump_format(AVFormatContext *ic,
1408
                    int index,
1409
                    const char *url,
1410
                    int is_output);
1411

    
1412
#if FF_API_PARSE_FRAME_PARAM
1413
/**
1414
 * Parse width and height out of string str.
1415
 * @deprecated Use av_parse_video_frame_size instead.
1416
 */
1417
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1418
                                          const char *str);
1419

    
1420
/**
1421
 * Convert framerate from a string to a fraction.
1422
 * @deprecated Use av_parse_video_frame_rate instead.
1423
 */
1424
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1425
                                          const char *arg);
1426
#endif
1427

    
1428
#if FF_API_PARSE_DATE
1429
/**
1430
 * Parse datestr and return a corresponding number of microseconds.
1431
 *
1432
 * @param datestr String representing a date or a duration.
1433
 * See av_parse_time() for the syntax of the provided string.
1434
 * @deprecated in favor of av_parse_time()
1435
 */
1436
attribute_deprecated
1437
int64_t parse_date(const char *datestr, int duration);
1438
#endif
1439

    
1440
/**
1441
 * Get the current time in microseconds.
1442
 */
1443
int64_t av_gettime(void);
1444

    
1445
#if FF_API_FIND_INFO_TAG
1446
/**
1447
 * @deprecated use av_find_info_tag in libavutil instead.
1448
 */
1449
attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1450
#endif
1451

    
1452
/**
1453
 * Return in 'buf' the path with '%d' replaced by a number.
1454
 *
1455
 * Also handles the '%0nd' format where 'n' is the total number
1456
 * of digits and '%%'.
1457
 *
1458
 * @param buf destination buffer
1459
 * @param buf_size destination buffer size
1460
 * @param path numbered sequence string
1461
 * @param number frame number
1462
 * @return 0 if OK, -1 on format error
1463
 */
1464
int av_get_frame_filename(char *buf, int buf_size,
1465
                          const char *path, int number);
1466

    
1467
/**
1468
 * Check whether filename actually is a numbered sequence generator.
1469
 *
1470
 * @param filename possible numbered sequence string
1471
 * @return 1 if a valid numbered sequence string, 0 otherwise
1472
 */
1473
int av_filename_number_test(const char *filename);
1474

    
1475
/**
1476
 * Generate an SDP for an RTP session.
1477
 *
1478
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1479
 *           array is composed by only one context, such context can contain
1480
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1481
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1482
 *           must contain only one AVStream.
1483
 * @param n_files number of AVCodecContexts contained in ac
1484
 * @param buf buffer where the SDP will be stored (must be allocated by
1485
 *            the caller)
1486
 * @param size the size of the buffer
1487
 * @return 0 if OK, AVERROR_xxx on error
1488
 */
1489
int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1490

    
1491
#if FF_API_SDP_CREATE
1492
attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1493
#endif
1494

    
1495
/**
1496
 * Return a positive value if the given filename has one of the given
1497
 * extensions, 0 otherwise.
1498
 *
1499
 * @param extensions a comma-separated list of filename extensions
1500
 */
1501
int av_match_ext(const char *filename, const char *extensions);
1502

    
1503
#endif /* AVFORMAT_AVFORMAT_H */