Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 7d727f13

History | View | Annotate | Download (53.2 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. 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
 * variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
108
 */
109

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

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

    
121
typedef struct AVMetadata AVMetadata;
122
#if FF_API_OLD_METADATA2
123
typedef struct AVMetadataConv AVMetadataConv;
124
#endif
125

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

    
137
/**
138
 * Set the given tag in *pm, overwriting an existing tag.
139
 *
140
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
141
 * a metadata struct is allocated and put in *pm.
142
 * @param key tag key to add to *pm (will be av_strduped depending on flags)
143
 * @param value tag value to add to *pm (will be av_strduped depending on flags).
144
 *        Passing a NULL value will cause an existing tag to be deleted.
145
 * @return >= 0 on success otherwise an error code <0
146
 */
147
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
148

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

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

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

    
172

    
173
/* packet functions */
174

    
175

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

    
186

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

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

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

    
213
/*************************************************/
214
/* input/output formats */
215

    
216
struct AVCodecTag;
217

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

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

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

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

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

    
289
    void *dummy;
290

    
291
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
292
                             AVPacket *in, int flush);
293

    
294
    /**
295
     * List of supported codec_id-codec_tag pairs, ordered by "better
296
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
297
     */
298
    const struct AVCodecTag * const *codec_tag;
299

    
300
    enum CodecID subtitle_codec; /**< default subtitle codec */
301

    
302
#if FF_API_OLD_METADATA2
303
    const AVMetadataConv *metadata_conv;
304
#endif
305

    
306
    const AVClass *priv_class; ///< AVClass for the private context
307

    
308
    /* private fields */
309
    struct AVOutputFormat *next;
310
} AVOutputFormat;
311

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

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

    
326
    /**
327
     * Size of private data so that it can be allocated in the wrapper.
328
     */
329
    int priv_data_size;
330

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

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

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

    
358
    /**
359
     * Close the stream. The AVFormatContext and AVStreams are not
360
     * freed by this function
361
     */
362
    int (*read_close)(struct AVFormatContext *);
363

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

    
383
    /**
384
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
385
     */
386
    int flags;
387

    
388
    /**
389
     * If extensions are defined, then no probe is done. You should
390
     * usually not use extension format guessing because it is not
391
     * reliable enough
392
     */
393
    const char *extensions;
394

    
395
    /**
396
     * General purpose read-only value that the format can use.
397
     */
398
    int value;
399

    
400
    /**
401
     * Start/resume playing - only meaningful if using a network-based format
402
     * (RTSP).
403
     */
404
    int (*read_play)(struct AVFormatContext *);
405

    
406
    /**
407
     * Pause playing - only meaningful if using a network-based format
408
     * (RTSP).
409
     */
410
    int (*read_pause)(struct AVFormatContext *);
411

    
412
    const struct AVCodecTag * const *codec_tag;
413

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

    
422
#if FF_API_OLD_METADATA2
423
    const AVMetadataConv *metadata_conv;
424
#endif
425

    
426
    /* private fields */
427
    struct AVInputFormat *next;
428
} AVInputFormat;
429

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

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

    
447
#define AV_DISPOSITION_DEFAULT   0x0001
448
#define AV_DISPOSITION_DUB       0x0002
449
#define AV_DISPOSITION_ORIGINAL  0x0004
450
#define AV_DISPOSITION_COMMENT   0x0008
451
#define AV_DISPOSITION_LYRICS    0x0010
452
#define AV_DISPOSITION_KARAOKE   0x0020
453

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

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

    
486
    /* internal data used in av_find_stream_info() */
487
    int64_t first_dts;
488

    
489
    /**
490
     * encoding: pts generation when outputting stream
491
     */
492
    struct AVFrac pts;
493

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

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

    
514
    /**
515
     * Decoding: pts of the first frame of the stream, in stream time base.
516
     * Only set this if you are absolutely 100% sure that the value you set
517
     * it to really is the pts of the first frame.
518
     * This may be undefined (AV_NOPTS_VALUE).
519
     * @note The ASF header does NOT contain a correct start_time the ASF
520
     * demuxer must NOT set this.
521
     */
522
    int64_t start_time;
523

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

    
531
    /* av_read_frame() support */
532
    enum AVStreamParseType need_parsing;
533
    struct AVCodecParserContext *parser;
534

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

    
544
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
545

    
546
    int disposition; /**< AV_DISPOSITION_* bit field */
547

    
548
    AVProbeData probe_data;
549
#define MAX_REORDER_DELAY 16
550
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
551

    
552
    /**
553
     * sample aspect ratio (0 if unknown)
554
     * - encoding: Set by user.
555
     * - decoding: Set by libavformat.
556
     */
557
    AVRational sample_aspect_ratio;
558

    
559
    AVMetadata *metadata;
560

    
561
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
562
    /* external applications; try to use something else if at all possible.    */
563
    const uint8_t *cur_ptr;
564
    int cur_len;
565
    AVPacket cur_pkt;
566

    
567
    // Timestamp generation support:
568
    /**
569
     * Timestamp corresponding to the last dts sync point.
570
     *
571
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
572
     * a DTS is received from the underlying container. Otherwise set to
573
     * AV_NOPTS_VALUE by default.
574
     */
575
    int64_t reference_dts;
576

    
577
    /**
578
     * Number of packets to buffer for codec probing
579
     * NOT PART OF PUBLIC API
580
     */
581
#define MAX_PROBE_PACKETS 2500
582
    int probe_packets;
583

    
584
    /**
585
     * last packet in packet_buffer for this stream when muxing.
586
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
587
     */
588
    struct AVPacketList *last_in_packet_buffer;
589

    
590
    /**
591
     * Average framerate
592
     */
593
    AVRational avg_frame_rate;
594

    
595
    /**
596
     * Number of frames that have been demuxed during av_find_stream_info()
597
     */
598
    int codec_info_nb_frames;
599

    
600
    /**
601
     * Stream informations used internally by av_find_stream_info()
602
     */
603
#define MAX_STD_TIMEBASES (60*12+5)
604
    struct {
605
        int64_t last_dts;
606
        int64_t duration_gcd;
607
        int duration_count;
608
        double duration_error[MAX_STD_TIMEBASES];
609
        int64_t codec_info_duration;
610
    } *info;
611

    
612
    /**
613
     * flag to indicate that probing is requested
614
     * NOT PART OF PUBLIC API
615
     */
616
    int request_probe;
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 FFmpeg can compute it automatically.
699
     */
700
    int bit_rate;
701

    
702
    /* av_read_frame() support */
703
    AVStream *cur_st;
704

    
705
    /* av_seek_frame() support */
706
    int64_t data_offset; /**< offset of the first packet */
707

    
708
    int mux_rate;
709
    unsigned int packet_size;
710
    int preload;
711
    int max_delay;
712

    
713
#define AVFMT_NOOUTPUTLOOP -1
714
#define AVFMT_INFINITEOUTPUTLOOP 0
715
    /**
716
     * number of times to loop output in formats that support it
717
     */
718
    int loop_output;
719

    
720
    int flags;
721
#define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
722
#define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.
723
#define AVFMT_FLAG_NONBLOCK     0x0004 ///< Do not block when reading packets from input.
724
#define AVFMT_FLAG_IGNDTS       0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
725
#define AVFMT_FLAG_NOFILLIN     0x0010 ///< Do not infer any values from other values, just return what is stored in the container
726
#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
727
#define AVFMT_FLAG_RTP_HINT     0x0040 ///< Add RTP hinting to the output file
728
#define AVFMT_FLAG_SORT_DTS    0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down)
729

    
730
    int loop_input;
731

    
732
    /**
733
     * decoding: size of data to probe; encoding: unused.
734
     */
735
    unsigned int probesize;
736

    
737
    /**
738
     * Maximum time (in AV_TIME_BASE units) during which the input should
739
     * be analyzed in av_find_stream_info().
740
     */
741
    int max_analyze_duration;
742

    
743
    const uint8_t *key;
744
    int keylen;
745

    
746
    unsigned int nb_programs;
747
    AVProgram **programs;
748

    
749
    /**
750
     * Forced video codec_id.
751
     * Demuxing: Set by user.
752
     */
753
    enum CodecID video_codec_id;
754

    
755
    /**
756
     * Forced audio codec_id.
757
     * Demuxing: Set by user.
758
     */
759
    enum CodecID audio_codec_id;
760

    
761
    /**
762
     * Forced subtitle codec_id.
763
     * Demuxing: Set by user.
764
     */
765
    enum CodecID subtitle_codec_id;
766

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

    
779
    /**
780
     * Maximum amount of memory in bytes to use for buffering frames
781
     * obtained from realtime capture devices.
782
     */
783
    unsigned int max_picture_buffer;
784

    
785
    unsigned int nb_chapters;
786
    AVChapter **chapters;
787

    
788
    /**
789
     * Flags to enable debugging.
790
     */
791
    int debug;
792
#define FF_FDEBUG_TS        0x0001
793

    
794
    /**
795
     * Raw packets from the demuxer, prior to parsing and decoding.
796
     * This buffer is used for buffering packets until the codec can
797
     * be identified, as parsing cannot be done without knowing the
798
     * codec.
799
     */
800
    struct AVPacketList *raw_packet_buffer;
801
    struct AVPacketList *raw_packet_buffer_end;
802

    
803
    struct AVPacketList *packet_buffer_end;
804

    
805
    AVMetadata *metadata;
806

    
807
    /**
808
     * Remaining size available for raw_packet_buffer, in bytes.
809
     * NOT PART OF PUBLIC API
810
     */
811
#define RAW_PACKET_BUFFER_SIZE 2500000
812
    int raw_packet_buffer_remaining_size;
813

    
814
    /**
815
     * Start time of the stream in real world time, in microseconds
816
     * since the unix epoch (00:00 1st January 1970). That is, pts=0
817
     * in the stream was captured at this real world time.
818
     * - encoding: Set by user.
819
     * - decoding: Unused.
820
     */
821
    int64_t start_time_realtime;
822
} AVFormatContext;
823

    
824
typedef struct AVPacketList {
825
    AVPacket pkt;
826
    struct AVPacketList *next;
827
} AVPacketList;
828

    
829
/**
830
 * If f is NULL, returns the first registered input format,
831
 * if f is non-NULL, returns the next registered input format after f
832
 * or NULL if f is the last one.
833
 */
834
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
835

    
836
/**
837
 * If f is NULL, returns the first registered output format,
838
 * if f is non-NULL, returns the next registered output format after f
839
 * or NULL if f is the last one.
840
 */
841
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
842

    
843
#if FF_API_GUESS_IMG2_CODEC
844
attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
845
#endif
846

    
847
/* XXX: Use automatic init with either ELF sections or C file parser */
848
/* modules. */
849

    
850
/* utils.c */
851
void av_register_input_format(AVInputFormat *format);
852
void av_register_output_format(AVOutputFormat *format);
853

    
854
/**
855
 * Return the output format in the list of registered output formats
856
 * which best matches the provided parameters, or return NULL if
857
 * there is no match.
858
 *
859
 * @param short_name if non-NULL checks if short_name matches with the
860
 * names of the registered formats
861
 * @param filename if non-NULL checks if filename terminates with the
862
 * extensions of the registered formats
863
 * @param mime_type if non-NULL checks if mime_type matches with the
864
 * MIME type of the registered formats
865
 */
866
AVOutputFormat *av_guess_format(const char *short_name,
867
                                const char *filename,
868
                                const char *mime_type);
869

    
870
/**
871
 * Guess the codec ID based upon muxer and filename.
872
 */
873
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
874
                            const char *filename, const char *mime_type,
875
                            enum AVMediaType type);
876

    
877
/**
878
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
879
 *
880
 * @param f The file stream pointer where the dump should be sent to.
881
 * @param buf buffer
882
 * @param size buffer size
883
 *
884
 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
885
 */
886
void av_hex_dump(FILE *f, uint8_t *buf, int size);
887

    
888
/**
889
 * Send a nice hexadecimal dump of a buffer to the log.
890
 *
891
 * @param avcl A pointer to an arbitrary struct of which the first field is a
892
 * pointer to an AVClass struct.
893
 * @param level The importance level of the message, lower values signifying
894
 * higher importance.
895
 * @param buf buffer
896
 * @param size buffer size
897
 *
898
 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
899
 */
900
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
901

    
902
/**
903
 * Send a nice dump of a packet to the specified file stream.
904
 *
905
 * @param f The file stream pointer where the dump should be sent to.
906
 * @param pkt packet to dump
907
 * @param dump_payload True if the payload must be displayed, too.
908
 * @param st AVStream that the packet belongs to
909
 */
910
void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
911

    
912

    
913
/**
914
 * Send a nice dump of a packet to the log.
915
 *
916
 * @param avcl A pointer to an arbitrary struct of which the first field is a
917
 * pointer to an AVClass struct.
918
 * @param level The importance level of the message, lower values signifying
919
 * higher importance.
920
 * @param pkt packet to dump
921
 * @param dump_payload True if the payload must be displayed, too.
922
 * @param st AVStream that the packet belongs to
923
 */
924
void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
925
                      AVStream *st);
926

    
927
#if FF_API_PKT_DUMP
928
attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
929
attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
930
                                          int dump_payload);
931
#endif
932

    
933
/**
934
 * Initialize libavformat and register all the muxers, demuxers and
935
 * protocols. If you do not call this function, then you can select
936
 * exactly which formats you want to support.
937
 *
938
 * @see av_register_input_format()
939
 * @see av_register_output_format()
940
 * @see av_register_protocol()
941
 */
942
void av_register_all(void);
943

    
944
/**
945
 * Get the CodecID for the given codec tag tag.
946
 * If no codec id is found returns CODEC_ID_NONE.
947
 *
948
 * @param tags list of supported codec_id-codec_tag pairs, as stored
949
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
950
 */
951
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
952

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

    
962
/* media file input */
963

    
964
/**
965
 * Find AVInputFormat based on the short name of the input format.
966
 */
967
AVInputFormat *av_find_input_format(const char *short_name);
968

    
969
/**
970
 * Guess the file format.
971
 *
972
 * @param is_opened Whether the file is already opened; determines whether
973
 *                  demuxers with or without AVFMT_NOFILE are probed.
974
 */
975
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
976

    
977
/**
978
 * Guess the file format.
979
 *
980
 * @param is_opened Whether the file is already opened; determines whether
981
 *                  demuxers with or without AVFMT_NOFILE are probed.
982
 * @param score_max A probe score larger that this is required to accept a
983
 *                  detection, the variable is set to the actual detection
984
 *                  score afterwards.
985
 *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
986
 *                  to retry with a larger probe buffer.
987
 */
988
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
989

    
990
/**
991
 * Guess the file format.
992
 *
993
 * @param is_opened Whether the file is already opened; determines whether
994
 *                  demuxers with or without AVFMT_NOFILE are probed.
995
 * @param score_ret The score of the best detection.
996
 */
997
AVInputFormat *av_probe_input_format3(AVProbeData *pd, int is_opened, int *score_ret);
998

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

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

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

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

    
1050
/**
1051
 * Allocate an AVFormatContext.
1052
 * avformat_free_context() can be used to free the context and everything
1053
 * allocated by the framework within it.
1054
 */
1055
AVFormatContext *avformat_alloc_output_context(const char *format, AVOutputFormat *oformat, const char *filename);
1056

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

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

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

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

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

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

    
1183
/**
1184
 * Start playing a network-based stream (e.g. RTSP stream) at the
1185
 * current position.
1186
 */
1187
int av_read_play(AVFormatContext *s);
1188

    
1189
/**
1190
 * Pause a network-based stream (e.g. RTSP stream).
1191
 *
1192
 * Use av_read_play() to resume it.
1193
 */
1194
int av_read_pause(AVFormatContext *s);
1195

    
1196
/**
1197
 * Free a AVFormatContext allocated by av_open_input_stream.
1198
 * @param s context to free
1199
 */
1200
void av_close_input_stream(AVFormatContext *s);
1201

    
1202
/**
1203
 * Close a media file (but not its codecs).
1204
 *
1205
 * @param s media file handle
1206
 */
1207
void av_close_input_file(AVFormatContext *s);
1208

    
1209
/**
1210
 * Free an AVFormatContext and all its streams.
1211
 * @param s context to free
1212
 */
1213
void avformat_free_context(AVFormatContext *s);
1214

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

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

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

    
1246
int av_find_default_stream_index(AVFormatContext *s);
1247

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

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

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

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

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

    
1302
/**
1303
 * media file output
1304
 */
1305
attribute_deprecated int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1306

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

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

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

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

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

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

    
1404
#if FF_API_DUMP_FORMAT
1405
attribute_deprecated void dump_format(AVFormatContext *ic,
1406
                                      int index,
1407
                                      const char *url,
1408
                                      int is_output);
1409
#endif
1410

    
1411
void av_dump_format(AVFormatContext *ic,
1412
                    int index,
1413
                    const char *url,
1414
                    int is_output);
1415

    
1416
#if FF_API_PARSE_DATE
1417
/**
1418
 * Parse datestr and return a corresponding number of microseconds.
1419
 *
1420
 * @param datestr String representing a date or a duration.
1421
 * See av_parse_time() for the syntax of the provided string.
1422
 * @deprecated in favor of av_parse_time()
1423
 */
1424
attribute_deprecated
1425
int64_t parse_date(const char *datestr, int duration);
1426
#endif
1427

    
1428
/**
1429
 * Get the current time in microseconds.
1430
 */
1431
int64_t av_gettime(void);
1432

    
1433
#if FF_API_FIND_INFO_TAG
1434
/**
1435
 * @deprecated use av_find_info_tag in libavutil instead.
1436
 */
1437
attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1438
#endif
1439

    
1440
/**
1441
 * Return in 'buf' the path with '%d' replaced by a number.
1442
 *
1443
 * Also handles the '%0nd' format where 'n' is the total number
1444
 * of digits and '%%'.
1445
 *
1446
 * @param buf destination buffer
1447
 * @param buf_size destination buffer size
1448
 * @param path numbered sequence string
1449
 * @param number frame number
1450
 * @return 0 if OK, -1 on format error
1451
 */
1452
int av_get_frame_filename(char *buf, int buf_size,
1453
                          const char *path, int number);
1454

    
1455
/**
1456
 * Check whether filename actually is a numbered sequence generator.
1457
 *
1458
 * @param filename possible numbered sequence string
1459
 * @return 1 if a valid numbered sequence string, 0 otherwise
1460
 */
1461
int av_filename_number_test(const char *filename);
1462

    
1463
/**
1464
 * Generate an SDP for an RTP session.
1465
 *
1466
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1467
 *           array is composed by only one context, such context can contain
1468
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1469
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1470
 *           must contain only one AVStream.
1471
 * @param n_files number of AVCodecContexts contained in ac
1472
 * @param buf buffer where the SDP will be stored (must be allocated by
1473
 *            the caller)
1474
 * @param size the size of the buffer
1475
 * @return 0 if OK, AVERROR_xxx on error
1476
 */
1477
int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1478

    
1479
#if FF_API_SDP_CREATE
1480
attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1481
#endif
1482

    
1483
/**
1484
 * Return a positive value if the given filename has one of the given
1485
 * extensions, 0 otherwise.
1486
 *
1487
 * @param extensions a comma-separated list of filename extensions
1488
 */
1489
int av_match_ext(const char *filename, const char *extensions);
1490

    
1491
#endif /* AVFORMAT_AVFORMAT_H */