Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ ed09233f

History | View | Annotate | Download (54.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
#define LIBAVFORMAT_VERSION_MAJOR 52
25
#define LIBAVFORMAT_VERSION_MINOR 82
26
#define LIBAVFORMAT_VERSION_MICRO  0
27

    
28
#define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \
29
                                               LIBAVFORMAT_VERSION_MINOR, \
30
                                               LIBAVFORMAT_VERSION_MICRO)
31
#define LIBAVFORMAT_VERSION     AV_VERSION(LIBAVFORMAT_VERSION_MAJOR,   \
32
                                           LIBAVFORMAT_VERSION_MINOR,   \
33
                                           LIBAVFORMAT_VERSION_MICRO)
34
#define LIBAVFORMAT_BUILD       LIBAVFORMAT_VERSION_INT
35

    
36
#define LIBAVFORMAT_IDENT       "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
37

    
38
/**
39
 * Those FF_API_* defines are not part of public API.
40
 * They may change, break or disappear at any time.
41
 */
42
#ifndef FF_API_MAX_STREAMS
43
#define FF_API_MAX_STREAMS             (LIBAVFORMAT_VERSION_MAJOR < 53)
44
#endif
45
#ifndef FF_API_OLD_METADATA
46
#define FF_API_OLD_METADATA            (LIBAVFORMAT_VERSION_MAJOR < 53)
47
#endif
48
#ifndef FF_API_URL_CLASS
49
#define FF_API_URL_CLASS               (LIBAVFORMAT_VERSION_MAJOR >= 53)
50
#endif
51
#ifndef FF_API_URL_RESETBUF
52
#define FF_API_URL_RESETBUF            (LIBAVFORMAT_VERSION_MAJOR < 53)
53
#endif
54
#ifndef FF_API_REGISTER_PROTOCOL
55
#define FF_API_REGISTER_PROTOCOL       (LIBAVFORMAT_VERSION_MAJOR < 53)
56
#endif
57
#ifndef FF_API_GUESS_FORMAT
58
#define FF_API_GUESS_FORMAT            (LIBAVFORMAT_VERSION_MAJOR < 53)
59
#endif
60
#ifndef FF_API_UDP_GET_FILE
61
#define FF_API_UDP_GET_FILE            (LIBAVFORMAT_VERSION_MAJOR < 53)
62
#endif
63
#ifndef FF_API_URL_SPLIT
64
#define FF_API_URL_SPLIT               (LIBAVFORMAT_VERSION_MAJOR < 53)
65
#endif
66
#ifndef FF_API_ALLOC_FORMAT_CONTEXT
67
#define FF_API_ALLOC_FORMAT_CONTEXT    (LIBAVFORMAT_VERSION_MAJOR < 53)
68
#endif
69
#ifndef FF_API_PARSE_FRAME_PARAM
70
#define FF_API_PARSE_FRAME_PARAM       (LIBAVFORMAT_VERSION_MAJOR < 53)
71
#endif
72
#ifndef FF_API_READ_SEEK
73
#define FF_API_READ_SEEK               (LIBAVFORMAT_VERSION_MAJOR < 54)
74
#endif
75
#ifndef FF_API_LAVF_UNUSED
76
#define FF_API_LAVF_UNUSED             (LIBAVFORMAT_VERSION_MAJOR < 53)
77
#endif
78
#ifndef FF_API_PARAMETERS_CODEC_ID
79
#define FF_API_PARAMETERS_CODEC_ID     (LIBAVFORMAT_VERSION_MAJOR < 53)
80
#endif
81
#ifndef FF_API_FIRST_FORMAT
82
#define FF_API_FIRST_FORMAT            (LIBAVFORMAT_VERSION_MAJOR < 53)
83
#endif
84
#ifndef FF_API_SYMVER
85
#define FF_API_SYMVER                  (LIBAVFORMAT_VERSION_MAJOR < 53)
86
#endif
87

    
88
/**
89
 * I return the LIBAVFORMAT_VERSION_INT constant.  You got
90
 * a fucking problem with that, douchebag?
91
 */
92
unsigned avformat_version(void);
93

    
94
/**
95
 * Return the libavformat build-time configuration.
96
 */
97
const char *avformat_configuration(void);
98

    
99
/**
100
 * Return the libavformat license.
101
 */
102
const char *avformat_license(void);
103

    
104
#include <time.h>
105
#include <stdio.h>  /* FILE */
106
#include "libavcodec/avcodec.h"
107

    
108
#include "avio.h"
109

    
110
struct AVFormatContext;
111

    
112

    
113
/*
114
 * Public Metadata API.
115
 * The metadata API allows libavformat to export metadata tags to a client
116
 * application using a sequence of key/value pairs. Like all strings in FFmpeg,
117
 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
118
 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
119
 * Important concepts to keep in mind:
120
 * 1. Keys are unique; there can never be 2 tags with the same key. This is
121
 *    also meant semantically, i.e., a demuxer should not knowingly produce
122
 *    several keys that are literally different but semantically identical.
123
 *    E.g., key=Author5, key=Author6. In this example, all authors must be
124
 *    placed in the same tag.
125
 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
126
 *    want to store, e.g., the email address of the child of producer Alice
127
 *    and actor Bob, that could have key=alice_and_bobs_childs_email_address.
128
 * 3. Several modifiers can be applied to the tag name. This is done by
129
 *    appending a dash character ('-') and the modifier name in the order
130
 *    they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
131
 *    a) language -- a tag whose value is localized for a particular language
132
 *       is appended with the ISO 639-2/B 3-letter language code.
133
 *       For example: Author-ger=Michael, Author-eng=Mike
134
 *       The original/default language is in the unqualified "Author" tag.
135
 *       A demuxer should set a default if it sets any translated tag.
136
 *    b) sorting  -- a modified version of a tag that should be used for
137
 *       sorting will have '-sort' appended. E.g. artist="The Beatles",
138
 *       artist-sort="Beatles, The".
139
 *
140
 * 4. Tag names are normally exported exactly as stored in the container to
141
 *    allow lossless remuxing to the same format. For container-independent
142
 *    handling of metadata, av_metadata_conv() can convert it to ffmpeg generic
143
 *    format. Follows a list of generic tag names:
144
 *
145
 * album        -- name of the set this work belongs to
146
 * album_artist -- main creator of the set/album, if different from artist.
147
 *                 e.g. "Various Artists" for compilation albums.
148
 * artist       -- main creator of the work
149
 * comment      -- any additional description of the file.
150
 * composer     -- who composed the work, if different from artist.
151
 * copyright    -- name of copyright holder.
152
 * date         -- date when the work was created, preferably in ISO 8601.
153
 * disc         -- number of a subset, e.g. disc in a multi-disc collection.
154
 * encoder      -- name/settings of the software/hardware that produced the file.
155
 * encoded_by   -- person/group who created the file.
156
 * filename     -- original name of the file.
157
 * genre        -- <self-evident>.
158
 * language     -- main language in which the work is performed, preferably
159
 *                 in ISO 639-2 format.
160
 * performer    -- artist who performed the work, if different from artist.
161
 *                 E.g for "Also sprach Zarathustra", artist would be "Richard
162
 *                 Strauss" and performer "London Philharmonic Orchestra".
163
 * publisher    -- name of the label/publisher.
164
 * title        -- name of the work.
165
 * track        -- number of this work in the set, can be in form current/total.
166
 */
167

    
168
#define AV_METADATA_MATCH_CASE      1
169
#define AV_METADATA_IGNORE_SUFFIX   2
170
#define AV_METADATA_DONT_STRDUP_KEY 4
171
#define AV_METADATA_DONT_STRDUP_VAL 8
172
#define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
173

    
174
typedef struct {
175
    char *key;
176
    char *value;
177
}AVMetadataTag;
178

    
179
typedef struct AVMetadata AVMetadata;
180
typedef struct AVMetadataConv AVMetadataConv;
181

    
182
/**
183
 * Get a metadata element with matching key.
184
 *
185
 * @param prev Set to the previous matching element to find the next.
186
 *             If set to NULL the first matching element is returned.
187
 * @param flags Allows case as well as suffix-insensitive comparisons.
188
 * @return Found tag or NULL, changing key or value leads to undefined behavior.
189
 */
190
AVMetadataTag *
191
av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
192

    
193
#if FF_API_OLD_METADATA
194
/**
195
 * Set the given tag in *pm, overwriting an existing tag.
196
 *
197
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
198
 * a metadata struct is allocated and put in *pm.
199
 * @param key tag key to add to *pm (will be av_strduped)
200
 * @param value tag value to add to *pm (will be av_strduped)
201
 * @return >= 0 on success otherwise an error code <0
202
 * @deprecated Use av_metadata_set2() instead.
203
 */
204
attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
205
#endif
206

    
207
/**
208
 * Set the given tag in *pm, overwriting an existing tag.
209
 *
210
 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
211
 * a metadata struct is allocated and put in *pm.
212
 * @param key tag key to add to *pm (will be av_strduped depending on flags)
213
 * @param value tag value to add to *pm (will be av_strduped depending on flags).
214
 *        Passing a NULL value will cause an existing tag to be deleted.
215
 * @return >= 0 on success otherwise an error code <0
216
 */
217
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
218

    
219
/**
220
 * Convert all the metadata sets from ctx according to the source and
221
 * destination conversion tables. If one of the tables is NULL, then
222
 * tags are converted to/from ffmpeg generic tag names.
223
 *
224
 * @param d_conv destination tags format conversion table
225
 * @param s_conv source tags format conversion table
226
 */
227
void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
228
                                                   const AVMetadataConv *s_conv);
229

    
230
/**
231
 * Free all the memory allocated for an AVMetadata struct.
232
 */
233
void av_metadata_free(AVMetadata **m);
234

    
235

    
236
/* packet functions */
237

    
238

    
239
/**
240
 * Allocate and read the payload of a packet and initialize its
241
 * fields with default values.
242
 *
243
 * @param pkt packet
244
 * @param size desired payload size
245
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
246
 */
247
int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
248

    
249

    
250
/*************************************************/
251
/* fractional numbers for exact pts handling */
252

    
253
/**
254
 * The exact value of the fractional number is: 'val + num / den'.
255
 * num is assumed to be 0 <= num < den.
256
 */
257
typedef struct AVFrac {
258
    int64_t val, num, den;
259
} AVFrac;
260

    
261
/*************************************************/
262
/* input/output formats */
263

    
264
struct AVCodecTag;
265

    
266
/**
267
 * This structure contains the data a format has to probe a file.
268
 */
269
typedef struct AVProbeData {
270
    const char *filename;
271
    unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
272
    int buf_size;       /**< Size of buf except extra allocated bytes */
273
} AVProbeData;
274

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

    
278
typedef struct AVFormatParameters {
279
    AVRational time_base;
280
    int sample_rate;
281
    int channels;
282
    int width;
283
    int height;
284
    enum PixelFormat pix_fmt;
285
    int channel; /**< Used to select DV channel. */
286
    const char *standard; /**< TV standard, NTSC, PAL, SECAM */
287
    unsigned int mpeg2ts_raw:1;  /**< Force raw MPEG-2 transport stream output, if possible. */
288
    unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
289
                                            stream packet (only meaningful if
290
                                            mpeg2ts_raw is TRUE). */
291
    unsigned int initial_pause:1;       /**< Do not begin to play the stream
292
                                            immediately (RTSP only). */
293
    unsigned int prealloced_context:1;
294
#if FF_API_PARAMETERS_CODEC_ID
295
    attribute_deprecated enum CodecID video_codec_id;
296
    attribute_deprecated enum CodecID audio_codec_id;
297
#endif
298
} AVFormatParameters;
299

    
300
//! Demuxer will use url_fopen, no opened file should be provided by the caller.
301
#define AVFMT_NOFILE        0x0001
302
#define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
303
#define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
304
#define AVFMT_RAWPICTURE    0x0020 /**< Format wants AVPicture structure for
305
                                      raw picture data. */
306
#define AVFMT_GLOBALHEADER  0x0040 /**< Format wants global header. */
307
#define AVFMT_NOTIMESTAMPS  0x0080 /**< Format does not need / have any timestamps. */
308
#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
309
#define AVFMT_TS_DISCONT    0x0200 /**< Format allows timestamp discontinuities. */
310
#define AVFMT_VARIABLE_FPS  0x0400 /**< Format allows variable fps. */
311
#define AVFMT_NODIMENSIONS  0x0800 /**< Format does not need width/height */
312

    
313
typedef struct AVOutputFormat {
314
    const char *name;
315
    /**
316
     * Descriptive name for the format, meant to be more human-readable
317
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
318
     * to define it.
319
     */
320
    const char *long_name;
321
    const char *mime_type;
322
    const char *extensions; /**< comma-separated filename extensions */
323
    /**
324
     * size of private data so that it can be allocated in the wrapper
325
     */
326
    int priv_data_size;
327
    /* output support */
328
    enum CodecID audio_codec; /**< default audio codec */
329
    enum CodecID video_codec; /**< default video codec */
330
    int (*write_header)(struct AVFormatContext *);
331
    int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
332
    int (*write_trailer)(struct AVFormatContext *);
333
    /**
334
     * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER
335
     */
336
    int flags;
337
    /**
338
     * Currently only used to set pixel format if not YUV420P.
339
     */
340
    int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
341
    int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
342
                             AVPacket *in, int flush);
343

    
344
    /**
345
     * List of supported codec_id-codec_tag pairs, ordered by "better
346
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
347
     */
348
    const struct AVCodecTag * const *codec_tag;
349

    
350
    enum CodecID subtitle_codec; /**< default subtitle codec */
351

    
352
    const AVMetadataConv *metadata_conv;
353

    
354
    /* private fields */
355
    struct AVOutputFormat *next;
356
} AVOutputFormat;
357

    
358
typedef struct AVInputFormat {
359
    /**
360
     * A comma separated list of short names for the format. New names
361
     * may be appended with a minor bump.
362
     */
363
    const char *name;
364

    
365
    /**
366
     * Descriptive name for the format, meant to be more human-readable
367
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
368
     * to define it.
369
     */
370
    const char *long_name;
371

    
372
    /**
373
     * Size of private data so that it can be allocated in the wrapper.
374
     */
375
    int priv_data_size;
376

    
377
    /**
378
     * Tell if a given file has a chance of being parsed as this format.
379
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
380
     * big so you do not have to check for that unless you need more.
381
     */
382
    int (*read_probe)(AVProbeData *);
383

    
384
    /**
385
     * Read the format header and initialize the AVFormatContext
386
     * structure. Return 0 if OK. 'ap' if non-NULL contains
387
     * additional parameters. Only used in raw format right
388
     * now. 'av_new_stream' should be called to create new streams.
389
     */
390
    int (*read_header)(struct AVFormatContext *,
391
                       AVFormatParameters *ap);
392

    
393
    /**
394
     * Read one packet and put it in 'pkt'. pts and flags are also
395
     * set. 'av_new_stream' can be called only if the flag
396
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
397
     * background thread).
398
     * @return 0 on success, < 0 on error.
399
     *         When returning an error, pkt must not have been allocated
400
     *         or must be freed before returning
401
     */
402
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
403

    
404
    /**
405
     * Close the stream. The AVFormatContext and AVStreams are not
406
     * freed by this function
407
     */
408
    int (*read_close)(struct AVFormatContext *);
409

    
410
#if FF_API_READ_SEEK
411
    /**
412
     * Seek to a given timestamp relative to the frames in
413
     * stream component stream_index.
414
     * @param stream_index Must not be -1.
415
     * @param flags Selects which direction should be preferred if no exact
416
     *              match is available.
417
     * @return >= 0 on success (but not necessarily the new offset)
418
     */
419
    attribute_deprecated int (*read_seek)(struct AVFormatContext *,
420
                                          int stream_index, int64_t timestamp, int flags);
421
#endif
422
    /**
423
     * Gets the next timestamp in stream[stream_index].time_base units.
424
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
425
     */
426
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
427
                              int64_t *pos, int64_t pos_limit);
428

    
429
    /**
430
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
431
     */
432
    int flags;
433

    
434
    /**
435
     * If extensions are defined, then no probe is done. You should
436
     * usually not use extension format guessing because it is not
437
     * reliable enough
438
     */
439
    const char *extensions;
440

    
441
    /**
442
     * General purpose read-only value that the format can use.
443
     */
444
    int value;
445

    
446
    /**
447
     * Start/resume playing - only meaningful if using a network-based format
448
     * (RTSP).
449
     */
450
    int (*read_play)(struct AVFormatContext *);
451

    
452
    /**
453
     * Pause playing - only meaningful if using a network-based format
454
     * (RTSP).
455
     */
456
    int (*read_pause)(struct AVFormatContext *);
457

    
458
    const struct AVCodecTag * const *codec_tag;
459

    
460
    /**
461
     * Seek to timestamp ts.
462
     * Seeking will be done so that the point from which all active streams
463
     * can be presented successfully will be closest to ts and within min/max_ts.
464
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
465
     */
466
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
467

    
468
    const AVMetadataConv *metadata_conv;
469

    
470
    /* private fields */
471
    struct AVInputFormat *next;
472
} AVInputFormat;
473

    
474
enum AVStreamParseType {
475
    AVSTREAM_PARSE_NONE,
476
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
477
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
478
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
479
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
480
};
481

    
482
typedef struct AVIndexEntry {
483
    int64_t pos;
484
    int64_t timestamp;
485
#define AVINDEX_KEYFRAME 0x0001
486
    int flags:2;
487
    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).
488
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
489
} AVIndexEntry;
490

    
491
#define AV_DISPOSITION_DEFAULT   0x0001
492
#define AV_DISPOSITION_DUB       0x0002
493
#define AV_DISPOSITION_ORIGINAL  0x0004
494
#define AV_DISPOSITION_COMMENT   0x0008
495
#define AV_DISPOSITION_LYRICS    0x0010
496
#define AV_DISPOSITION_KARAOKE   0x0020
497

    
498
/**
499
 * Track should be used during playback by default.
500
 * Useful for subtitle track that should be displayed
501
 * even when user did not explicitly ask for subtitles.
502
 */
503
#define AV_DISPOSITION_FORCED    0x0040
504

    
505
/**
506
 * Stream structure.
507
 * New fields can be added to the end with minor version bumps.
508
 * Removal, reordering and changes to existing fields require a major
509
 * version bump.
510
 * sizeof(AVStream) must not be used outside libav*.
511
 */
512
typedef struct AVStream {
513
    int index;    /**< stream index in AVFormatContext */
514
    int id;       /**< format-specific stream ID */
515
    AVCodecContext *codec; /**< codec context */
516
    /**
517
     * Real base framerate of the stream.
518
     * This is the lowest framerate with which all timestamps can be
519
     * represented accurately (it is the least common multiple of all
520
     * framerates in the stream). Note, this value is just a guess!
521
     * For example, if the time base is 1/90000 and all frames have either
522
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
523
     */
524
    AVRational r_frame_rate;
525
    void *priv_data;
526

    
527
    /* internal data used in av_find_stream_info() */
528
    int64_t first_dts;
529

    
530
    /**
531
     * encoding: pts generation when outputting stream
532
     */
533
    struct AVFrac pts;
534

    
535
    /**
536
     * This is the fundamental unit of time (in seconds) in terms
537
     * of which frame timestamps are represented. For fixed-fps content,
538
     * time base should be 1/framerate and timestamp increments should be 1.
539
     */
540
    AVRational time_base;
541
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
542
    /* ffmpeg.c private use */
543
    int stream_copy; /**< If set, just copy stream. */
544
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
545

    
546
    //FIXME move stuff to a flags field?
547
    /**
548
     * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
549
     * MN: dunno if that is the right place for it
550
     */
551
    float quality;
552

    
553
    /**
554
     * Decoding: pts of the first frame of the stream, in stream time base.
555
     * Only set this if you are absolutely 100% sure that the value you set
556
     * it to really is the pts of the first frame.
557
     * This may be undefined (AV_NOPTS_VALUE).
558
     * @note The ASF header does NOT contain a correct start_time the ASF
559
     * demuxer must NOT set this.
560
     */
561
    int64_t start_time;
562

    
563
    /**
564
     * Decoding: duration of the stream, in stream time base.
565
     * If a source file does not specify a duration, but does specify
566
     * a bitrate, this value will be estimated from bitrate and file size.
567
     */
568
    int64_t duration;
569

    
570
#if FF_API_OLD_METADATA
571
    attribute_deprecated char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
572
#endif
573

    
574
    /* av_read_frame() support */
575
    enum AVStreamParseType need_parsing;
576
    struct AVCodecParserContext *parser;
577

    
578
    int64_t cur_dts;
579
    int last_IP_duration;
580
    int64_t last_IP_pts;
581
    /* av_seek_frame() support */
582
    AVIndexEntry *index_entries; /**< Only used if the format does not
583
                                    support seeking natively. */
584
    int nb_index_entries;
585
    unsigned int index_entries_allocated_size;
586

    
587
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
588

    
589
#if FF_API_LAVF_UNUSED
590
    attribute_deprecated int64_t unused[4+1];
591
#endif
592

    
593
#if FF_API_OLD_METADATA
594
    attribute_deprecated char *filename; /**< source filename of the stream */
595
#endif
596

    
597
    int disposition; /**< AV_DISPOSITION_* bit field */
598

    
599
    AVProbeData probe_data;
600
#define MAX_REORDER_DELAY 16
601
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
602

    
603
    /**
604
     * sample aspect ratio (0 if unknown)
605
     * - encoding: Set by user.
606
     * - decoding: Set by libavformat.
607
     */
608
    AVRational sample_aspect_ratio;
609

    
610
    AVMetadata *metadata;
611

    
612
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
613
    /* external applications; try to use something else if at all possible.    */
614
    const uint8_t *cur_ptr;
615
    int cur_len;
616
    AVPacket cur_pkt;
617

    
618
    // Timestamp generation support:
619
    /**
620
     * Timestamp corresponding to the last dts sync point.
621
     *
622
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
623
     * a DTS is received from the underlying container. Otherwise set to
624
     * AV_NOPTS_VALUE by default.
625
     */
626
    int64_t reference_dts;
627

    
628
    /**
629
     * Number of packets to buffer for codec probing
630
     * NOT PART OF PUBLIC API
631
     */
632
#define MAX_PROBE_PACKETS 2500
633
    int probe_packets;
634

    
635
    /**
636
     * last packet in packet_buffer for this stream when muxing.
637
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
638
     */
639
    struct AVPacketList *last_in_packet_buffer;
640

    
641
    /**
642
     * Average framerate
643
     */
644
    AVRational avg_frame_rate;
645

    
646
    /**
647
     * Number of frames that have been demuxed during av_find_stream_info()
648
     */
649
    int codec_info_nb_frames;
650

    
651
    /**
652
     * Stream informations used internally by av_find_stream_info()
653
     */
654
#define MAX_STD_TIMEBASES (60*12+5)
655
    struct {
656
        int64_t last_dts;
657
        int64_t duration_gcd;
658
        int duration_count;
659
        double duration_error[MAX_STD_TIMEBASES];
660
        int64_t codec_info_duration;
661
    } *info;
662
} AVStream;
663

    
664
#define AV_PROGRAM_RUNNING 1
665

    
666
/**
667
 * New fields can be added to the end with minor version bumps.
668
 * Removal, reordering and changes to existing fields require a major
669
 * version bump.
670
 * sizeof(AVProgram) must not be used outside libav*.
671
 */
672
typedef struct AVProgram {
673
    int            id;
674
#if FF_API_OLD_METADATA
675
    attribute_deprecated char           *provider_name; ///< network name for DVB streams
676
    attribute_deprecated char           *name;          ///< service name for DVB streams
677
#endif
678
    int            flags;
679
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
680
    unsigned int   *stream_index;
681
    unsigned int   nb_stream_indexes;
682
    AVMetadata *metadata;
683
} AVProgram;
684

    
685
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
686
                                         (streams are added dynamically) */
687

    
688
typedef struct AVChapter {
689
    int id;                 ///< unique ID to identify the chapter
690
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
691
    int64_t start, end;     ///< chapter start/end time in time_base units
692
#if FF_API_OLD_METADATA
693
    attribute_deprecated char *title;            ///< chapter title
694
#endif
695
    AVMetadata *metadata;
696
} AVChapter;
697

    
698
#if FF_API_MAX_STREAMS
699
#define MAX_STREAMS 20
700
#endif
701

    
702
/**
703
 * Format I/O context.
704
 * New fields can be added to the end with minor version bumps.
705
 * Removal, reordering and changes to existing fields require a major
706
 * version bump.
707
 * sizeof(AVFormatContext) must not be used outside libav*.
708
 */
709
typedef struct AVFormatContext {
710
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
711
    /* Can only be iformat or oformat, not both at the same time. */
712
    struct AVInputFormat *iformat;
713
    struct AVOutputFormat *oformat;
714
    void *priv_data;
715
    ByteIOContext *pb;
716
    unsigned int nb_streams;
717
#if FF_API_MAX_STREAMS
718
    AVStream *streams[MAX_STREAMS];
719
#else
720
    AVStream **streams;
721
#endif
722
    char filename[1024]; /**< input or output filename */
723
    /* stream info */
724
    int64_t timestamp;
725
#if FF_API_OLD_METADATA
726
    attribute_deprecated char title[512];
727
    attribute_deprecated char author[512];
728
    attribute_deprecated char copyright[512];
729
    attribute_deprecated char comment[512];
730
    attribute_deprecated char album[512];
731
    attribute_deprecated int year;  /**< ID3 year, 0 if none */
732
    attribute_deprecated int track; /**< track number, 0 if none */
733
    attribute_deprecated char genre[32]; /**< ID3 genre */
734
#endif
735

    
736
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
737
    /* private data for pts handling (do not modify directly). */
738
    /**
739
     * This buffer is only needed when packets were already buffered but
740
     * not decoded, for example to get the codec parameters in MPEG
741
     * streams.
742
     */
743
    struct AVPacketList *packet_buffer;
744

    
745
    /**
746
     * Decoding: position of the first frame of the component, in
747
     * AV_TIME_BASE fractional seconds. NEVER set this value directly:
748
     * It is deduced from the AVStream values.
749
     */
750
    int64_t start_time;
751

    
752
    /**
753
     * Decoding: duration of the stream, in AV_TIME_BASE fractional
754
     * seconds. Only set this value if you know none of the individual stream
755
     * durations and also dont set any of them. This is deduced from the
756
     * AVStream values if not set.
757
     */
758
    int64_t duration;
759

    
760
    /**
761
     * decoding: total file size, 0 if unknown
762
     */
763
    int64_t file_size;
764

    
765
    /**
766
     * Decoding: total stream bitrate in bit/s, 0 if not
767
     * available. Never set it directly if the file_size and the
768
     * duration are known as FFmpeg can compute it automatically.
769
     */
770
    int bit_rate;
771

    
772
    /* av_read_frame() support */
773
    AVStream *cur_st;
774
#if FF_API_LAVF_UNUSED
775
    const uint8_t *cur_ptr_deprecated;
776
    int cur_len_deprecated;
777
    AVPacket cur_pkt_deprecated;
778
#endif
779

    
780
    /* av_seek_frame() support */
781
    int64_t data_offset; /**< offset of the first packet */
782
    int index_built;
783

    
784
    int mux_rate;
785
    unsigned int packet_size;
786
    int preload;
787
    int max_delay;
788

    
789
#define AVFMT_NOOUTPUTLOOP -1
790
#define AVFMT_INFINITEOUTPUTLOOP 0
791
    /**
792
     * number of times to loop output in formats that support it
793
     */
794
    int loop_output;
795

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

    
805
    int loop_input;
806

    
807
    /**
808
     * decoding: size of data to probe; encoding: unused.
809
     */
810
    unsigned int probesize;
811

    
812
    /**
813
     * Maximum time (in AV_TIME_BASE units) during which the input should
814
     * be analyzed in av_find_stream_info().
815
     */
816
    int max_analyze_duration;
817

    
818
    const uint8_t *key;
819
    int keylen;
820

    
821
    unsigned int nb_programs;
822
    AVProgram **programs;
823

    
824
    /**
825
     * Forced video codec_id.
826
     * Demuxing: Set by user.
827
     */
828
    enum CodecID video_codec_id;
829

    
830
    /**
831
     * Forced audio codec_id.
832
     * Demuxing: Set by user.
833
     */
834
    enum CodecID audio_codec_id;
835

    
836
    /**
837
     * Forced subtitle codec_id.
838
     * Demuxing: Set by user.
839
     */
840
    enum CodecID subtitle_codec_id;
841

    
842
    /**
843
     * Maximum amount of memory in bytes to use for the index of each stream.
844
     * If the index exceeds this size, entries will be discarded as
845
     * needed to maintain a smaller size. This can lead to slower or less
846
     * accurate seeking (depends on demuxer).
847
     * Demuxers for which a full in-memory index is mandatory will ignore
848
     * this.
849
     * muxing  : unused
850
     * demuxing: set by user
851
     */
852
    unsigned int max_index_size;
853

    
854
    /**
855
     * Maximum amount of memory in bytes to use for buffering frames
856
     * obtained from realtime capture devices.
857
     */
858
    unsigned int max_picture_buffer;
859

    
860
    unsigned int nb_chapters;
861
    AVChapter **chapters;
862

    
863
    /**
864
     * Flags to enable debugging.
865
     */
866
    int debug;
867
#define FF_FDEBUG_TS        0x0001
868

    
869
    /**
870
     * Raw packets from the demuxer, prior to parsing and decoding.
871
     * This buffer is used for buffering packets until the codec can
872
     * be identified, as parsing cannot be done without knowing the
873
     * codec.
874
     */
875
    struct AVPacketList *raw_packet_buffer;
876
    struct AVPacketList *raw_packet_buffer_end;
877

    
878
    struct AVPacketList *packet_buffer_end;
879

    
880
    AVMetadata *metadata;
881

    
882
    /**
883
     * Remaining size available for raw_packet_buffer, in bytes.
884
     * NOT PART OF PUBLIC API
885
     */
886
#define RAW_PACKET_BUFFER_SIZE 2500000
887
    int raw_packet_buffer_remaining_size;
888

    
889
    /**
890
     * Start time of the stream in real world time, in microseconds
891
     * since the unix epoch (00:00 1st January 1970). That is, pts=0
892
     * in the stream was captured at this real world time.
893
     * - encoding: Set by user.
894
     * - decoding: Unused.
895
     */
896
    int64_t start_time_realtime;
897
} AVFormatContext;
898

    
899
typedef struct AVPacketList {
900
    AVPacket pkt;
901
    struct AVPacketList *next;
902
} AVPacketList;
903

    
904
#if FF_API_FIRST_FORMAT
905
attribute_deprecated extern AVInputFormat *first_iformat;
906
attribute_deprecated extern AVOutputFormat *first_oformat;
907
#endif
908

    
909
/**
910
 * If f is NULL, returns the first registered input format,
911
 * if f is non-NULL, returns the next registered input format after f
912
 * or NULL if f is the last one.
913
 */
914
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
915

    
916
/**
917
 * If f is NULL, returns the first registered output format,
918
 * if f is non-NULL, returns the next registered output format after f
919
 * or NULL if f is the last one.
920
 */
921
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
922

    
923
enum CodecID av_guess_image2_codec(const char *filename);
924

    
925
/* XXX: Use automatic init with either ELF sections or C file parser */
926
/* modules. */
927

    
928
/* utils.c */
929
void av_register_input_format(AVInputFormat *format);
930
void av_register_output_format(AVOutputFormat *format);
931
#if FF_API_GUESS_FORMAT
932
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
933
                                    const char *filename,
934
                                    const char *mime_type);
935

    
936
/**
937
 * @deprecated Use av_guess_format() instead.
938
 */
939
attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
940
                                                  const char *filename,
941
                                                  const char *mime_type);
942
#endif
943

    
944
/**
945
 * Return the output format in the list of registered output formats
946
 * which best matches the provided parameters, or return NULL if
947
 * there is no match.
948
 *
949
 * @param short_name if non-NULL checks if short_name matches with the
950
 * names of the registered formats
951
 * @param filename if non-NULL checks if filename terminates with the
952
 * extensions of the registered formats
953
 * @param mime_type if non-NULL checks if mime_type matches with the
954
 * MIME type of the registered formats
955
 */
956
AVOutputFormat *av_guess_format(const char *short_name,
957
                                const char *filename,
958
                                const char *mime_type);
959

    
960
/**
961
 * Guess the codec ID based upon muxer and filename.
962
 */
963
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
964
                            const char *filename, const char *mime_type,
965
                            enum AVMediaType type);
966

    
967
/**
968
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
969
 *
970
 * @param f The file stream pointer where the dump should be sent to.
971
 * @param buf buffer
972
 * @param size buffer size
973
 *
974
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
975
 */
976
void av_hex_dump(FILE *f, uint8_t *buf, int size);
977

    
978
/**
979
 * Send a nice hexadecimal dump of a buffer to the log.
980
 *
981
 * @param avcl A pointer to an arbitrary struct of which the first field is a
982
 * pointer to an AVClass struct.
983
 * @param level The importance level of the message, lower values signifying
984
 * higher importance.
985
 * @param buf buffer
986
 * @param size buffer size
987
 *
988
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
989
 */
990
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
991

    
992
/**
993
 * Send a nice dump of a packet to the specified file stream.
994
 *
995
 * @param f The file stream pointer where the dump should be sent to.
996
 * @param pkt packet to dump
997
 * @param dump_payload True if the payload must be displayed, too.
998
 */
999
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
1000

    
1001
/**
1002
 * Send a nice dump of a packet to the log.
1003
 *
1004
 * @param avcl A pointer to an arbitrary struct of which the first field is a
1005
 * pointer to an AVClass struct.
1006
 * @param level The importance level of the message, lower values signifying
1007
 * higher importance.
1008
 * @param pkt packet to dump
1009
 * @param dump_payload True if the payload must be displayed, too.
1010
 */
1011
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
1012

    
1013
/**
1014
 * Initialize libavformat and register all the muxers, demuxers and
1015
 * protocols. If you do not call this function, then you can select
1016
 * exactly which formats you want to support.
1017
 *
1018
 * @see av_register_input_format()
1019
 * @see av_register_output_format()
1020
 * @see av_register_protocol()
1021
 */
1022
void av_register_all(void);
1023

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

    
1033
/**
1034
 * Get the codec tag for the given codec id id.
1035
 * If no codec tag is found returns 0.
1036
 *
1037
 * @param tags list of supported codec_id-codec_tag pairs, as stored
1038
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
1039
 */
1040
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
1041

    
1042
/* media file input */
1043

    
1044
/**
1045
 * Find AVInputFormat based on the short name of the input format.
1046
 */
1047
AVInputFormat *av_find_input_format(const char *short_name);
1048

    
1049
/**
1050
 * Guess the file format.
1051
 *
1052
 * @param is_opened Whether the file is already opened; determines whether
1053
 *                  demuxers with or without AVFMT_NOFILE are probed.
1054
 */
1055
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
1056

    
1057
/**
1058
 * Guess the file format.
1059
 *
1060
 * @param is_opened Whether the file is already opened; determines whether
1061
 *                  demuxers with or without AVFMT_NOFILE are probed.
1062
 * @param score_max A probe score larger that this is required to accept a
1063
 *                  detection, the variable is set to the actual detection
1064
 *                  score afterwards.
1065
 *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
1066
 *                  to retry with a larger probe buffer.
1067
 */
1068
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
1069

    
1070
/**
1071
 * Allocate all the structures needed to read an input stream.
1072
 *        This does not open the needed codecs for decoding the stream[s].
1073
 */
1074
int av_open_input_stream(AVFormatContext **ic_ptr,
1075
                         ByteIOContext *pb, const char *filename,
1076
                         AVInputFormat *fmt, AVFormatParameters *ap);
1077

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

    
1095
#if FF_API_ALLOC_FORMAT_CONTEXT
1096
/**
1097
 * @deprecated Use avformat_alloc_context() instead.
1098
 */
1099
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1100
#endif
1101

    
1102
/**
1103
 * Allocate an AVFormatContext.
1104
 * Can be freed with av_free() but do not forget to free everything you
1105
 * explicitly allocated as well!
1106
 */
1107
AVFormatContext *avformat_alloc_context(void);
1108

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

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

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

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

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

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

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

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

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

    
1230
/**
1231
 * Add a new stream to a media file.
1232
 *
1233
 * Can only be called in the read_header() function. If the flag
1234
 * AVFMTCTX_NOHEADER is in the format context, then new streams
1235
 * can be added in read_packet too.
1236
 *
1237
 * @param s media file handle
1238
 * @param id file-format-dependent stream ID
1239
 */
1240
AVStream *av_new_stream(AVFormatContext *s, int id);
1241
AVProgram *av_new_program(AVFormatContext *s, int id);
1242

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

    
1259
/**
1260
 * Set the pts for a given stream.
1261
 *
1262
 * @param s stream
1263
 * @param pts_wrap_bits number of bits effectively used by the pts
1264
 *        (used for wrap control, 33 is the value for MPEG)
1265
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1266
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1267
 */
1268
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1269
                     unsigned int pts_num, unsigned int pts_den);
1270

    
1271
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1272
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1273
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1274
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1275

    
1276
int av_find_default_stream_index(AVFormatContext *s);
1277

    
1278
/**
1279
 * Get the index for a specific timestamp.
1280
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1281
 *                 to the timestamp which is <= the requested one, if backward
1282
 *                 is 0, then it will be >=
1283
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1284
 * @return < 0 if no such timestamp could be found
1285
 */
1286
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1287

    
1288
/**
1289
 * Ensure the index uses less memory than the maximum specified in
1290
 * AVFormatContext.max_index_size by discarding entries if it grows
1291
 * too large.
1292
 * This function is not part of the public API and should only be called
1293
 * by demuxers.
1294
 */
1295
void ff_reduce_index(AVFormatContext *s, int stream_index);
1296

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

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

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

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

    
1341
/**
1342
 * media file output
1343
 */
1344
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1345

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

    
1372
/**
1373
 * Allocate the stream private data and write the stream header to an
1374
 * output media file.
1375
 *
1376
 * @param s media file handle
1377
 * @return 0 if OK, AVERROR_xxx on error
1378
 */
1379
int av_write_header(AVFormatContext *s);
1380

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

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

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

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

    
1441
void dump_format(AVFormatContext *ic,
1442
                 int index,
1443
                 const char *url,
1444
                 int is_output);
1445

    
1446
#if FF_API_PARSE_FRAME_PARAM
1447
/**
1448
 * Parse width and height out of string str.
1449
 * @deprecated Use av_parse_video_frame_size instead.
1450
 */
1451
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1452
                                          const char *str);
1453

    
1454
/**
1455
 * Convert framerate from a string to a fraction.
1456
 * @deprecated Use av_parse_video_frame_rate instead.
1457
 */
1458
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1459
                                          const char *arg);
1460
#endif
1461

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

    
1491
/**
1492
 * Get the current time in microseconds.
1493
 */
1494
int64_t av_gettime(void);
1495

    
1496
/* ffm-specific for ffserver */
1497
#define FFM_PACKET_SIZE 4096
1498
int64_t ffm_read_write_index(int fd);
1499
int ffm_write_write_index(int fd, int64_t pos);
1500
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1501

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

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

    
1525
/**
1526
 * Check whether filename actually is a numbered sequence generator.
1527
 *
1528
 * @param filename possible numbered sequence string
1529
 * @return 1 if a valid numbered sequence string, 0 otherwise
1530
 */
1531
int av_filename_number_test(const char *filename);
1532

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

    
1549
/**
1550
 * Return a positive value if the given filename has one of the given
1551
 * extensions, 0 otherwise.
1552
 *
1553
 * @param extensions a comma-separated list of filename extensions
1554
 */
1555
int av_match_ext(const char *filename, const char *extensions);
1556

    
1557
#endif /* AVFORMAT_AVFORMAT_H */