Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 12c14cd4

History | View | Annotate | Download (55.4 KB)

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

    
21
#ifndef AVFORMAT_AVFORMAT_H
22
#define AVFORMAT_AVFORMAT_H
23

    
24

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

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

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

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

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

    
48
struct AVFormatContext;
49

    
50

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

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

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

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

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

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

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

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

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

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

    
184

    
185
/* packet functions */
186

    
187

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

    
198

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

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

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

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

    
228
struct AVCodecTag;
229

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
427
    const struct AVCodecTag * const *codec_tag;
428

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

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

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

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

    
453
typedef struct AVIndexEntry {
454
    int64_t pos;
455
    int64_t timestamp;
456
#define AVINDEX_KEYFRAME 0x0001
457
    int flags:2;
458
    int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs. 32 bytes due to possible 8-byte alignment).
459
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
460
} AVIndexEntry;
461

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

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

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

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

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

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

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

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

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

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

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

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

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

    
562
#if FF_API_LAVF_UNUSED
563
    attribute_deprecated int64_t unused[4+1];
564
#endif
565

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

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

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

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

    
583
    AVMetadata *metadata;
584

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

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

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

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

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

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

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

    
637
#define AV_PROGRAM_RUNNING 1
638

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
778
    int loop_input;
779

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

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

    
791
    const uint8_t *key;
792
    int keylen;
793

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

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

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

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

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

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

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

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

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

    
851
    struct AVPacketList *packet_buffer_end;
852

    
853
    AVMetadata *metadata;
854

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

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

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

    
877
#if FF_API_FIRST_FORMAT
878
attribute_deprecated extern AVInputFormat *first_iformat;
879
attribute_deprecated extern AVOutputFormat *first_oformat;
880
#endif
881

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
1015
/* media file input */
1016

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

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

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

    
1043
/**
1044
 * Probe a bytestream to determine the input format. Each time a probe returns
1045
 * with a score that is too low, the probe buffer size is increased and another
1046
 * attempt is made. When the maximum probe size is reached, the input format
1047
 * with the highest score is returned.
1048
 *
1049
 * @param pb the bytestream to probe
1050
 * @param fmt the input format is put here
1051
 * @param filename the filename of the stream
1052
 * @param logctx the log context
1053
 * @param offset the offset within the bytestream to probe from
1054
 * @param max_probe_size the maximum probe buffer size (zero for default)
1055
 * @return 0 in case of success, a negative value corresponding to an
1056
 * AVERROR code otherwise
1057
 */
1058
int av_probe_input_buffer(ByteIOContext *pb, AVInputFormat **fmt,
1059
                          const char *filename, void *logctx,
1060
                          unsigned int offset, unsigned int max_probe_size);
1061

    
1062
/**
1063
 * Allocate all the structures needed to read an input stream.
1064
 *        This does not open the needed codecs for decoding the stream[s].
1065
 */
1066
int av_open_input_stream(AVFormatContext **ic_ptr,
1067
                         ByteIOContext *pb, const char *filename,
1068
                         AVInputFormat *fmt, AVFormatParameters *ap);
1069

    
1070
/**
1071
 * Open a media file as input. The codecs are not opened. Only the file
1072
 * header (if present) is read.
1073
 *
1074
 * @param ic_ptr The opened media file handle is put here.
1075
 * @param filename filename to open
1076
 * @param fmt If non-NULL, force the file format to use.
1077
 * @param buf_size optional buffer size (zero if default is OK)
1078
 * @param ap Additional parameters needed when opening the file
1079
 *           (NULL if default).
1080
 * @return 0 if OK, AVERROR_xxx otherwise
1081
 */
1082
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1083
                       AVInputFormat *fmt,
1084
                       int buf_size,
1085
                       AVFormatParameters *ap);
1086

    
1087
#if FF_API_ALLOC_FORMAT_CONTEXT
1088
/**
1089
 * @deprecated Use avformat_alloc_context() instead.
1090
 */
1091
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1092
#endif
1093

    
1094
/**
1095
 * Allocate an AVFormatContext.
1096
 * avformat_free_context() can be used to free the context and everything
1097
 * allocated by the framework within it.
1098
 */
1099
AVFormatContext *avformat_alloc_context(void);
1100

    
1101
/**
1102
 * Read packets of a media file to get stream information. This
1103
 * is useful for file formats with no headers such as MPEG. This
1104
 * function also computes the real framerate in case of MPEG-2 repeat
1105
 * frame mode.
1106
 * The logical file position is not changed by this function;
1107
 * examined packets may be buffered for later processing.
1108
 *
1109
 * @param ic media file handle
1110
 * @return >=0 if OK, AVERROR_xxx on error
1111
 * @todo Let the user decide somehow what information is needed so that
1112
 *       we do not waste time getting stuff the user does not need.
1113
 */
1114
int av_find_stream_info(AVFormatContext *ic);
1115

    
1116
/**
1117
 * Find the "best" stream in the file.
1118
 * The best stream is determined according to various heuristics as the most
1119
 * likely to be what the user expects.
1120
 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1121
 * default decoder for the stream's codec; streams for which no decoder can
1122
 * be found are ignored.
1123
 *
1124
 * @param ic                media file handle
1125
 * @param type              stream type: video, audio, subtitles, etc.
1126
 * @param wanted_stream_nb  user-requested stream number,
1127
 *                          or -1 for automatic selection
1128
 * @param related_stream    try to find a stream related (eg. in the same
1129
 *                          program) to this one, or -1 if none
1130
 * @param decoder_ret       if non-NULL, returns the decoder for the
1131
 *                          selected stream
1132
 * @param flags             flags; none are currently defined
1133
 * @return  the non-negative stream number in case of success,
1134
 *          AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1135
 *          could be found,
1136
 *          AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1137
 * @note  If av_find_best_stream returns successfully and decoder_ret is not
1138
 *        NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1139
 */
1140
int av_find_best_stream(AVFormatContext *ic,
1141
                        enum AVMediaType type,
1142
                        int wanted_stream_nb,
1143
                        int related_stream,
1144
                        AVCodec **decoder_ret,
1145
                        int flags);
1146

    
1147
/**
1148
 * Read a transport packet from a media file.
1149
 *
1150
 * This function is obsolete and should never be used.
1151
 * Use av_read_frame() instead.
1152
 *
1153
 * @param s media file handle
1154
 * @param pkt is filled
1155
 * @return 0 if OK, AVERROR_xxx on error
1156
 */
1157
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1158

    
1159
/**
1160
 * Return the next frame of a stream.
1161
 * This function returns what is stored in the file, and does not validate
1162
 * that what is there are valid frames for the decoder. It will split what is
1163
 * stored in the file into frames and return one for each call. It will not
1164
 * omit invalid data between valid frames so as to give the decoder the maximum
1165
 * information possible for decoding.
1166
 *
1167
 * The returned packet is valid
1168
 * until the next av_read_frame() or until av_close_input_file() and
1169
 * must be freed with av_free_packet. For video, the packet contains
1170
 * exactly one frame. For audio, it contains an integer number of
1171
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1172
 * data). If the audio frames have a variable size (e.g. MPEG audio),
1173
 * then it contains one frame.
1174
 *
1175
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1176
 * values in AVStream.time_base units (and guessed if the format cannot
1177
 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1178
 * has B-frames, so it is better to rely on pkt->dts if you do not
1179
 * decompress the payload.
1180
 *
1181
 * @return 0 if OK, < 0 on error or end of file
1182
 */
1183
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1184

    
1185
/**
1186
 * Seek to the keyframe at timestamp.
1187
 * 'timestamp' in 'stream_index'.
1188
 * @param stream_index If stream_index is (-1), a default
1189
 * stream is selected, and timestamp is automatically converted
1190
 * from AV_TIME_BASE units to the stream specific time_base.
1191
 * @param timestamp Timestamp in AVStream.time_base units
1192
 *        or, if no stream is specified, in AV_TIME_BASE units.
1193
 * @param flags flags which select direction and seeking mode
1194
 * @return >= 0 on success
1195
 */
1196
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1197
                  int flags);
1198

    
1199
/**
1200
 * Seek to timestamp ts.
1201
 * Seeking will be done so that the point from which all active streams
1202
 * can be presented successfully will be closest to ts and within min/max_ts.
1203
 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1204
 *
1205
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1206
 * are the file position (this may not be supported by all demuxers).
1207
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1208
 * in the stream with stream_index (this may not be supported by all demuxers).
1209
 * Otherwise all timestamps are in units of the stream selected by stream_index
1210
 * or if stream_index is -1, in AV_TIME_BASE units.
1211
 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1212
 * keyframes (this may not be supported by all demuxers).
1213
 *
1214
 * @param stream_index index of the stream which is used as time base reference
1215
 * @param min_ts smallest acceptable timestamp
1216
 * @param ts target timestamp
1217
 * @param max_ts largest acceptable timestamp
1218
 * @param flags flags
1219
 * @return >=0 on success, error code otherwise
1220
 *
1221
 * @note This is part of the new seek API which is still under construction.
1222
 *       Thus do not use this yet. It may change at any time, do not expect
1223
 *       ABI compatibility yet!
1224
 */
1225
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1226

    
1227
/**
1228
 * Start playing a network-based stream (e.g. RTSP stream) at the
1229
 * current position.
1230
 */
1231
int av_read_play(AVFormatContext *s);
1232

    
1233
/**
1234
 * Pause a network-based stream (e.g. RTSP stream).
1235
 *
1236
 * Use av_read_play() to resume it.
1237
 */
1238
int av_read_pause(AVFormatContext *s);
1239

    
1240
/**
1241
 * Free a AVFormatContext allocated by av_open_input_stream.
1242
 * @param s context to free
1243
 */
1244
void av_close_input_stream(AVFormatContext *s);
1245

    
1246
/**
1247
 * Close a media file (but not its codecs).
1248
 *
1249
 * @param s media file handle
1250
 */
1251
void av_close_input_file(AVFormatContext *s);
1252

    
1253
/**
1254
 * Free an AVFormatContext and all its streams.
1255
 * @param s context to free
1256
 */
1257
void avformat_free_context(AVFormatContext *s);
1258

    
1259
/**
1260
 * Add a new stream to a media file.
1261
 *
1262
 * Can only be called in the read_header() function. If the flag
1263
 * AVFMTCTX_NOHEADER is in the format context, then new streams
1264
 * can be added in read_packet too.
1265
 *
1266
 * @param s media file handle
1267
 * @param id file-format-dependent stream ID
1268
 */
1269
AVStream *av_new_stream(AVFormatContext *s, int id);
1270
AVProgram *av_new_program(AVFormatContext *s, int id);
1271

    
1272
/**
1273
 * Set the pts for a given stream. If the new values would be invalid
1274
 * (<= 0), it leaves the AVStream unchanged.
1275
 *
1276
 * @param s stream
1277
 * @param pts_wrap_bits number of bits effectively used by the pts
1278
 *        (used for wrap control, 33 is the value for MPEG)
1279
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1280
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1281
 */
1282
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1283
                     unsigned int pts_num, unsigned int pts_den);
1284

    
1285
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1286
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1287
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1288
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1289

    
1290
int av_find_default_stream_index(AVFormatContext *s);
1291

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

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

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

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

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

    
1346
/**
1347
 * media file output
1348
 */
1349
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1350

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

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

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

    
1400
/**
1401
 * Write a packet to an output media file ensuring correct interleaving.
1402
 *
1403
 * The packet must contain one audio or video frame.
1404
 * If the packets are already correctly interleaved, the application should
1405
 * call av_write_frame() instead as it is slightly faster. It is also important
1406
 * to keep in mind that completely non-interleaved input will need huge amounts
1407
 * of memory to interleave with this, so it is preferable to interleave at the
1408
 * demuxer level.
1409
 *
1410
 * @param s media file handle
1411
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1412
              dts/pts, ...
1413
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1414
 */
1415
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1416

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

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

    
1446
void dump_format(AVFormatContext *ic,
1447
                 int index,
1448
                 const char *url,
1449
                 int is_output);
1450

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

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

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

    
1496
/**
1497
 * Get the current time in microseconds.
1498
 */
1499
int64_t av_gettime(void);
1500

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

    
1507
/**
1508
 * Attempt to find a specific tag in a URL.
1509
 *
1510
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1511
 * Return 1 if found.
1512
 */
1513
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1514

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

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

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

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

    
1562
#endif /* AVFORMAT_AVFORMAT_H */