Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 32e6f246

History | View | Annotate | Download (51.5 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 78
26
#define LIBAVFORMAT_VERSION_MICRO  1
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
 * I return the LIBAVFORMAT_VERSION_INT constant.  You got
40
 * a fucking problem with that, douchebag?
41
 */
42
unsigned avformat_version(void);
43

    
44
/**
45
 * Return the libavformat build-time configuration.
46
 */
47
const char *avformat_configuration(void);
48

    
49
/**
50
 * Return the libavformat license.
51
 */
52
const char *avformat_license(void);
53

    
54
#include <time.h>
55
#include <stdio.h>  /* FILE */
56
#include "libavcodec/avcodec.h"
57

    
58
#include "avio.h"
59

    
60
struct AVFormatContext;
61

    
62

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

    
118
#define AV_METADATA_MATCH_CASE      1
119
#define AV_METADATA_IGNORE_SUFFIX   2
120
#define AV_METADATA_DONT_STRDUP_KEY 4
121
#define AV_METADATA_DONT_STRDUP_VAL 8
122
#define AV_METADATA_DONT_OVERWRITE 16   ///< Don't overwrite existing tags.
123

    
124
typedef struct {
125
    char *key;
126
    char *value;
127
}AVMetadataTag;
128

    
129
typedef struct AVMetadata AVMetadata;
130
typedef struct AVMetadataConv AVMetadataConv;
131

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

    
143
#if LIBAVFORMAT_VERSION_MAJOR == 52
144
/**
145
 * Set the given tag in *pm, overwriting an existing tag.
146
 *
147
 * @param key tag key to add to *pm (will be av_strduped)
148
 * @param value tag value to add to *pm (will be av_strduped)
149
 * @return >= 0 on success otherwise an error code <0
150
 * @deprecated Use av_metadata_set2() instead.
151
 */
152
attribute_deprecated int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
153
#endif
154

    
155
/**
156
 * Set the given tag in *pm, overwriting an existing tag.
157
 *
158
 * @param key tag key to add to *pm (will be av_strduped depending on flags)
159
 * @param value tag value to add to *pm (will be av_strduped depending on flags).
160
 *        Passing a NULL value will cause an existing tag to be deleted.
161
 * @return >= 0 on success otherwise an error code <0
162
 */
163
int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
164

    
165
/**
166
 * Convert all the metadata sets from ctx according to the source and
167
 * destination conversion tables. If one of the tables is NULL, then
168
 * tags are converted to/from ffmpeg generic tag names.
169
 *
170
 * @param d_conv destination tags format conversion table
171
 * @param s_conv source tags format conversion table
172
 */
173
void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
174
                                                   const AVMetadataConv *s_conv);
175

    
176
/**
177
 * Free all the memory allocated for an AVMetadata struct.
178
 */
179
void av_metadata_free(AVMetadata **m);
180

    
181

    
182
/* packet functions */
183

    
184

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

    
195

    
196
/*************************************************/
197
/* fractional numbers for exact pts handling */
198

    
199
/**
200
 * The exact value of the fractional number is: 'val + num / den'.
201
 * num is assumed to be 0 <= num < den.
202
 */
203
typedef struct AVFrac {
204
    int64_t val, num, den;
205
} AVFrac;
206

    
207
/*************************************************/
208
/* input/output formats */
209

    
210
struct AVCodecTag;
211

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

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

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

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

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

    
290
    /**
291
     * List of supported codec_id-codec_tag pairs, ordered by "better
292
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
293
     */
294
    const struct AVCodecTag * const *codec_tag;
295

    
296
    enum CodecID subtitle_codec; /**< default subtitle codec */
297

    
298
    const AVMetadataConv *metadata_conv;
299

    
300
    /* private fields */
301
    struct AVOutputFormat *next;
302
} AVOutputFormat;
303

    
304
typedef struct AVInputFormat {
305
    /**
306
     * A comma separated list of short names for the format. New names
307
     * may be appended with a minor bump.
308
     */
309
    const char *name;
310

    
311
    /**
312
     * Descriptive name for the format, meant to be more human-readable
313
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
314
     * to define it.
315
     */
316
    const char *long_name;
317

    
318
    /**
319
     * Size of private data so that it can be allocated in the wrapper.
320
     */
321
    int priv_data_size;
322

    
323
    /**
324
     * Tell if a given file has a chance of being parsed as this format.
325
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
326
     * big so you do not have to check for that unless you need more.
327
     */
328
    int (*read_probe)(AVProbeData *);
329

    
330
    /**
331
     * Read the format header and initialize the AVFormatContext
332
     * structure. Return 0 if OK. 'ap' if non-NULL contains
333
     * additional parameters. Only used in raw format right
334
     * now. 'av_new_stream' should be called to create new streams.
335
     */
336
    int (*read_header)(struct AVFormatContext *,
337
                       AVFormatParameters *ap);
338

    
339
    /**
340
     * Read one packet and put it in 'pkt'. pts and flags are also
341
     * set. 'av_new_stream' can be called only if the flag
342
     * AVFMTCTX_NOHEADER is used.
343
     * @return 0 on success, < 0 on error.
344
     *         When returning an error, pkt must not have been allocated
345
     *         or must be freed before returning
346
     */
347
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
348

    
349
    /**
350
     * Close the stream. The AVFormatContext and AVStreams are not
351
     * freed by this function
352
     */
353
    int (*read_close)(struct AVFormatContext *);
354

    
355
#if LIBAVFORMAT_VERSION_MAJOR < 53
356
    /**
357
     * Seek to a given timestamp relative to the frames in
358
     * stream component stream_index.
359
     * @param stream_index Must not be -1.
360
     * @param flags Selects which direction should be preferred if no exact
361
     *              match is available.
362
     * @return >= 0 on success (but not necessarily the new offset)
363
     */
364
    int (*read_seek)(struct AVFormatContext *,
365
                     int stream_index, int64_t timestamp, int flags);
366
#endif
367
    /**
368
     * Gets the next timestamp in stream[stream_index].time_base units.
369
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
370
     */
371
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
372
                              int64_t *pos, int64_t pos_limit);
373

    
374
    /**
375
     * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
376
     */
377
    int flags;
378

    
379
    /**
380
     * If extensions are defined, then no probe is done. You should
381
     * usually not use extension format guessing because it is not
382
     * reliable enough
383
     */
384
    const char *extensions;
385

    
386
    /**
387
     * General purpose read-only value that the format can use.
388
     */
389
    int value;
390

    
391
    /**
392
     * Start/resume playing - only meaningful if using a network-based format
393
     * (RTSP).
394
     */
395
    int (*read_play)(struct AVFormatContext *);
396

    
397
    /**
398
     * Pause playing - only meaningful if using a network-based format
399
     * (RTSP).
400
     */
401
    int (*read_pause)(struct AVFormatContext *);
402

    
403
    const struct AVCodecTag * const *codec_tag;
404

    
405
    /**
406
     * Seek to timestamp ts.
407
     * Seeking will be done so that the point from which all active streams
408
     * can be presented successfully will be closest to ts and within min/max_ts.
409
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
410
     */
411
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
412

    
413
    const AVMetadataConv *metadata_conv;
414

    
415
    /* private fields */
416
    struct AVInputFormat *next;
417
} AVInputFormat;
418

    
419
enum AVStreamParseType {
420
    AVSTREAM_PARSE_NONE,
421
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
422
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
423
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
424
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
425
};
426

    
427
typedef struct AVIndexEntry {
428
    int64_t pos;
429
    int64_t timestamp;
430
#define AVINDEX_KEYFRAME 0x0001
431
    int flags:2;
432
    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).
433
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
434
} AVIndexEntry;
435

    
436
#define AV_DISPOSITION_DEFAULT   0x0001
437
#define AV_DISPOSITION_DUB       0x0002
438
#define AV_DISPOSITION_ORIGINAL  0x0004
439
#define AV_DISPOSITION_COMMENT   0x0008
440
#define AV_DISPOSITION_LYRICS    0x0010
441
#define AV_DISPOSITION_KARAOKE   0x0020
442

    
443
/**
444
 * Track should be used during playback by default.
445
 * Useful for subtitle track that should be displayed
446
 * even when user did not explicitly ask for subtitles.
447
 */
448
#define AV_DISPOSITION_FORCED    0x0040
449

    
450
/**
451
 * Stream structure.
452
 * New fields can be added to the end with minor version bumps.
453
 * Removal, reordering and changes to existing fields require a major
454
 * version bump.
455
 * sizeof(AVStream) must not be used outside libav*.
456
 */
457
typedef struct AVStream {
458
    int index;    /**< stream index in AVFormatContext */
459
    int id;       /**< format-specific stream ID */
460
    AVCodecContext *codec; /**< codec context */
461
    /**
462
     * Real base framerate of the stream.
463
     * This is the lowest framerate with which all timestamps can be
464
     * represented accurately (it is the least common multiple of all
465
     * framerates in the stream). Note, this value is just a guess!
466
     * For example, if the time base is 1/90000 and all frames have either
467
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
468
     */
469
    AVRational r_frame_rate;
470
    void *priv_data;
471

    
472
    /* internal data used in av_find_stream_info() */
473
    int64_t first_dts;
474

    
475
    /**
476
     * encoding: pts generation when outputting stream
477
     */
478
    struct AVFrac pts;
479

    
480
    /**
481
     * This is the fundamental unit of time (in seconds) in terms
482
     * of which frame timestamps are represented. For fixed-fps content,
483
     * time base should be 1/framerate and timestamp increments should be 1.
484
     */
485
    AVRational time_base;
486
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
487
    /* ffmpeg.c private use */
488
    int stream_copy; /**< If set, just copy stream. */
489
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
490

    
491
    //FIXME move stuff to a flags field?
492
    /**
493
     * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
494
     * MN: dunno if that is the right place for it
495
     */
496
    float quality;
497

    
498
    /**
499
     * Decoding: pts of the first frame of the stream, in stream time base.
500
     * Only set this if you are absolutely 100% sure that the value you set
501
     * it to really is the pts of the first frame.
502
     * This may be undefined (AV_NOPTS_VALUE).
503
     * @note The ASF header does NOT contain a correct start_time the ASF
504
     * demuxer must NOT set this.
505
     */
506
    int64_t start_time;
507

    
508
    /**
509
     * Decoding: duration of the stream, in stream time base.
510
     * If a source file does not specify a duration, but does specify
511
     * a bitrate, this value will be estimated from bitrate and file size.
512
     */
513
    int64_t duration;
514

    
515
#if LIBAVFORMAT_VERSION_INT < (53<<16)
516
    char language[4]; /**< ISO 639-2/B 3-letter language code (empty string if undefined) */
517
#endif
518

    
519
    /* av_read_frame() support */
520
    enum AVStreamParseType need_parsing;
521
    struct AVCodecParserContext *parser;
522

    
523
    int64_t cur_dts;
524
    int last_IP_duration;
525
    int64_t last_IP_pts;
526
    /* av_seek_frame() support */
527
    AVIndexEntry *index_entries; /**< Only used if the format does not
528
                                    support seeking natively. */
529
    int nb_index_entries;
530
    unsigned int index_entries_allocated_size;
531

    
532
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
533

    
534
#if LIBAVFORMAT_VERSION_INT < (53<<16)
535
    int64_t unused[4+1];
536

    
537
    char *filename; /**< source filename of the stream */
538
#endif
539

    
540
    int disposition; /**< AV_DISPOSITION_* bit field */
541

    
542
    AVProbeData probe_data;
543
#define MAX_REORDER_DELAY 16
544
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
545

    
546
    /**
547
     * sample aspect ratio (0 if unknown)
548
     * - encoding: Set by user.
549
     * - decoding: Set by libavformat.
550
     */
551
    AVRational sample_aspect_ratio;
552

    
553
    AVMetadata *metadata;
554

    
555
    /* Intended mostly for av_read_frame() support. Not supposed to be used by */
556
    /* external applications; try to use something else if at all possible.    */
557
    const uint8_t *cur_ptr;
558
    int cur_len;
559
    AVPacket cur_pkt;
560

    
561
    // Timestamp generation support:
562
    /**
563
     * Timestamp corresponding to the last dts sync point.
564
     *
565
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
566
     * a DTS is received from the underlying container. Otherwise set to
567
     * AV_NOPTS_VALUE by default.
568
     */
569
    int64_t reference_dts;
570

    
571
    /**
572
     * Number of packets to buffer for codec probing
573
     * NOT PART OF PUBLIC API
574
     */
575
#define MAX_PROBE_PACKETS 2500
576
    int probe_packets;
577

    
578
    /**
579
     * last packet in packet_buffer for this stream when muxing.
580
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
581
     */
582
    struct AVPacketList *last_in_packet_buffer;
583

    
584
    /**
585
     * Average framerate
586
     */
587
    AVRational avg_frame_rate;
588

    
589
    /**
590
     * Number of frames that have been demuxed during av_find_stream_info()
591
     */
592
    int codec_info_nb_frames;
593
} AVStream;
594

    
595
#define AV_PROGRAM_RUNNING 1
596

    
597
/**
598
 * New fields can be added to the end with minor version bumps.
599
 * Removal, reordering and changes to existing fields require a major
600
 * version bump.
601
 * sizeof(AVProgram) must not be used outside libav*.
602
 */
603
typedef struct AVProgram {
604
    int            id;
605
#if LIBAVFORMAT_VERSION_INT < (53<<16)
606
    char           *provider_name; ///< network name for DVB streams
607
    char           *name;          ///< service name for DVB streams
608
#endif
609
    int            flags;
610
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
611
    unsigned int   *stream_index;
612
    unsigned int   nb_stream_indexes;
613
    AVMetadata *metadata;
614
} AVProgram;
615

    
616
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
617
                                         (streams are added dynamically) */
618

    
619
typedef struct AVChapter {
620
    int id;                 ///< unique ID to identify the chapter
621
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
622
    int64_t start, end;     ///< chapter start/end time in time_base units
623
#if LIBAVFORMAT_VERSION_INT < (53<<16)
624
    char *title;            ///< chapter title
625
#endif
626
    AVMetadata *metadata;
627
} AVChapter;
628

    
629
#if LIBAVFORMAT_VERSION_MAJOR < 53
630
#define MAX_STREAMS 20
631
#endif
632

    
633
/**
634
 * Format I/O context.
635
 * New fields can be added to the end with minor version bumps.
636
 * Removal, reordering and changes to existing fields require a major
637
 * version bump.
638
 * sizeof(AVFormatContext) must not be used outside libav*.
639
 */
640
typedef struct AVFormatContext {
641
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
642
    /* Can only be iformat or oformat, not both at the same time. */
643
    struct AVInputFormat *iformat;
644
    struct AVOutputFormat *oformat;
645
    void *priv_data;
646
    ByteIOContext *pb;
647
    unsigned int nb_streams;
648
    AVStream *streams[MAX_STREAMS];
649
    char filename[1024]; /**< input or output filename */
650
    /* stream info */
651
    int64_t timestamp;
652
#if LIBAVFORMAT_VERSION_INT < (53<<16)
653
    char title[512];
654
    char author[512];
655
    char copyright[512];
656
    char comment[512];
657
    char album[512];
658
    int year;  /**< ID3 year, 0 if none */
659
    int track; /**< track number, 0 if none */
660
    char genre[32]; /**< ID3 genre */
661
#endif
662

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

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

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

    
687
    /**
688
     * decoding: total file size, 0 if unknown
689
     */
690
    int64_t file_size;
691

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

    
699
    /* av_read_frame() support */
700
    AVStream *cur_st;
701
#if LIBAVFORMAT_VERSION_INT < (53<<16)
702
    const uint8_t *cur_ptr_deprecated;
703
    int cur_len_deprecated;
704
    AVPacket cur_pkt_deprecated;
705
#endif
706

    
707
    /* av_seek_frame() support */
708
    int64_t data_offset; /**< offset of the first packet */
709
    int index_built;
710

    
711
    int mux_rate;
712
    unsigned int packet_size;
713
    int preload;
714
    int max_delay;
715

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

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

    
732
    int loop_input;
733

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

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

    
745
    const uint8_t *key;
746
    int keylen;
747

    
748
    unsigned int nb_programs;
749
    AVProgram **programs;
750

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

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

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

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

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

    
787
    unsigned int nb_chapters;
788
    AVChapter **chapters;
789

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

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

    
805
    struct AVPacketList *packet_buffer_end;
806

    
807
    AVMetadata *metadata;
808

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

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

    
826
typedef struct AVPacketList {
827
    AVPacket pkt;
828
    struct AVPacketList *next;
829
} AVPacketList;
830

    
831
#if LIBAVFORMAT_VERSION_INT < (53<<16)
832
extern AVInputFormat *first_iformat;
833
extern AVOutputFormat *first_oformat;
834
#endif
835

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

    
843
/**
844
 * If f is NULL, returns the first registered output format,
845
 * if f is non-NULL, returns the next registered output format after f
846
 * or NULL if f is the last one.
847
 */
848
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
849

    
850
enum CodecID av_guess_image2_codec(const char *filename);
851

    
852
/* XXX: Use automatic init with either ELF sections or C file parser */
853
/* modules. */
854

    
855
/* utils.c */
856
void av_register_input_format(AVInputFormat *format);
857
void av_register_output_format(AVOutputFormat *format);
858
#if LIBAVFORMAT_VERSION_MAJOR < 53
859
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
860
                                    const char *filename,
861
                                    const char *mime_type);
862

    
863
/**
864
 * @deprecated Use av_guess_format() instead.
865
 */
866
attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
867
                                                  const char *filename,
868
                                                  const char *mime_type);
869
#endif
870

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

    
887
/**
888
 * Guess the codec ID based upon muxer and filename.
889
 */
890
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
891
                            const char *filename, const char *mime_type,
892
                            enum AVMediaType type);
893

    
894
/**
895
 * Send a nice hexadecimal dump of a buffer to the specified file stream.
896
 *
897
 * @param f The file stream pointer where the dump should be sent to.
898
 * @param buf buffer
899
 * @param size buffer size
900
 *
901
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
902
 */
903
void av_hex_dump(FILE *f, uint8_t *buf, int size);
904

    
905
/**
906
 * Send a nice hexadecimal dump of a buffer to the log.
907
 *
908
 * @param avcl A pointer to an arbitrary struct of which the first field is a
909
 * pointer to an AVClass struct.
910
 * @param level The importance level of the message, lower values signifying
911
 * higher importance.
912
 * @param buf buffer
913
 * @param size buffer size
914
 *
915
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
916
 */
917
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
918

    
919
/**
920
 * Send a nice dump of a packet to the specified file stream.
921
 *
922
 * @param f The file stream pointer where the dump should be sent to.
923
 * @param pkt packet to dump
924
 * @param dump_payload True if the payload must be displayed, too.
925
 */
926
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
927

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

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

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

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

    
969
/* media file input */
970

    
971
/**
972
 * Find AVInputFormat based on the short name of the input format.
973
 */
974
AVInputFormat *av_find_input_format(const char *short_name);
975

    
976
/**
977
 * Guess the file format.
978
 *
979
 * @param is_opened Whether the file is already opened; determines whether
980
 *                  demuxers with or without AVFMT_NOFILE are probed.
981
 */
982
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
983

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

    
997
/**
998
 * Allocate all the structures needed to read an input stream.
999
 *        This does not open the needed codecs for decoding the stream[s].
1000
 */
1001
int av_open_input_stream(AVFormatContext **ic_ptr,
1002
                         ByteIOContext *pb, const char *filename,
1003
                         AVInputFormat *fmt, AVFormatParameters *ap);
1004

    
1005
/**
1006
 * Open a media file as input. The codecs are not opened. Only the file
1007
 * header (if present) is read.
1008
 *
1009
 * @param ic_ptr The opened media file handle is put here.
1010
 * @param filename filename to open
1011
 * @param fmt If non-NULL, force the file format to use.
1012
 * @param buf_size optional buffer size (zero if default is OK)
1013
 * @param ap Additional parameters needed when opening the file
1014
 *           (NULL if default).
1015
 * @return 0 if OK, AVERROR_xxx otherwise
1016
 */
1017
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1018
                       AVInputFormat *fmt,
1019
                       int buf_size,
1020
                       AVFormatParameters *ap);
1021

    
1022
#if LIBAVFORMAT_VERSION_MAJOR < 53
1023
/**
1024
 * @deprecated Use avformat_alloc_context() instead.
1025
 */
1026
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
1027
#endif
1028

    
1029
/**
1030
 * Allocate an AVFormatContext.
1031
 * Can be freed with av_free() but do not forget to free everything you
1032
 * explicitly allocated as well!
1033
 */
1034
AVFormatContext *avformat_alloc_context(void);
1035

    
1036
/**
1037
 * Read packets of a media file to get stream information. This
1038
 * is useful for file formats with no headers such as MPEG. This
1039
 * function also computes the real framerate in case of MPEG-2 repeat
1040
 * frame mode.
1041
 * The logical file position is not changed by this function;
1042
 * examined packets may be buffered for later processing.
1043
 *
1044
 * @param ic media file handle
1045
 * @return >=0 if OK, AVERROR_xxx on error
1046
 * @todo Let the user decide somehow what information is needed so that
1047
 *       we do not waste time getting stuff the user does not need.
1048
 */
1049
int av_find_stream_info(AVFormatContext *ic);
1050

    
1051
/**
1052
 * Read a transport packet from a media file.
1053
 *
1054
 * This function is obsolete and should never be used.
1055
 * Use av_read_frame() instead.
1056
 *
1057
 * @param s media file handle
1058
 * @param pkt is filled
1059
 * @return 0 if OK, AVERROR_xxx on error
1060
 */
1061
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1062

    
1063
/**
1064
 * Return the next frame of a stream.
1065
 *
1066
 * The returned packet is valid
1067
 * until the next av_read_frame() or until av_close_input_file() and
1068
 * must be freed with av_free_packet. For video, the packet contains
1069
 * exactly one frame. For audio, it contains an integer number of
1070
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1071
 * data). If the audio frames have a variable size (e.g. MPEG audio),
1072
 * then it contains one frame.
1073
 *
1074
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1075
 * values in AVStream.time_base units (and guessed if the format cannot
1076
 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1077
 * has B-frames, so it is better to rely on pkt->dts if you do not
1078
 * decompress the payload.
1079
 *
1080
 * @return 0 if OK, < 0 on error or end of file
1081
 */
1082
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1083

    
1084
/**
1085
 * Seek to the keyframe at timestamp.
1086
 * 'timestamp' in 'stream_index'.
1087
 * @param stream_index If stream_index is (-1), a default
1088
 * stream is selected, and timestamp is automatically converted
1089
 * from AV_TIME_BASE units to the stream specific time_base.
1090
 * @param timestamp Timestamp in AVStream.time_base units
1091
 *        or, if no stream is specified, in AV_TIME_BASE units.
1092
 * @param flags flags which select direction and seeking mode
1093
 * @return >= 0 on success
1094
 */
1095
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1096
                  int flags);
1097

    
1098
/**
1099
 * Seek to timestamp ts.
1100
 * Seeking will be done so that the point from which all active streams
1101
 * can be presented successfully will be closest to ts and within min/max_ts.
1102
 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1103
 *
1104
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1105
 * are the file position (this may not be supported by all demuxers).
1106
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1107
 * in the stream with stream_index (this may not be supported by all demuxers).
1108
 * Otherwise all timestamps are in units of the stream selected by stream_index
1109
 * or if stream_index is -1, in AV_TIME_BASE units.
1110
 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1111
 * keyframes (this may not be supported by all demuxers).
1112
 *
1113
 * @param stream_index index of the stream which is used as time base reference
1114
 * @param min_ts smallest acceptable timestamp
1115
 * @param ts target timestamp
1116
 * @param max_ts largest acceptable timestamp
1117
 * @param flags flags
1118
 * @return >=0 on success, error code otherwise
1119
 *
1120
 * @note This is part of the new seek API which is still under construction.
1121
 *       Thus do not use this yet. It may change at any time, do not expect
1122
 *       ABI compatibility yet!
1123
 */
1124
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1125

    
1126
/**
1127
 * Start playing a network-based stream (e.g. RTSP stream) at the
1128
 * current position.
1129
 */
1130
int av_read_play(AVFormatContext *s);
1131

    
1132
/**
1133
 * Pause a network-based stream (e.g. RTSP stream).
1134
 *
1135
 * Use av_read_play() to resume it.
1136
 */
1137
int av_read_pause(AVFormatContext *s);
1138

    
1139
/**
1140
 * Free a AVFormatContext allocated by av_open_input_stream.
1141
 * @param s context to free
1142
 */
1143
void av_close_input_stream(AVFormatContext *s);
1144

    
1145
/**
1146
 * Close a media file (but not its codecs).
1147
 *
1148
 * @param s media file handle
1149
 */
1150
void av_close_input_file(AVFormatContext *s);
1151

    
1152
/**
1153
 * Add a new stream to a media file.
1154
 *
1155
 * Can only be called in the read_header() function. If the flag
1156
 * AVFMTCTX_NOHEADER is in the format context, then new streams
1157
 * can be added in read_packet too.
1158
 *
1159
 * @param s media file handle
1160
 * @param id file-format-dependent stream ID
1161
 */
1162
AVStream *av_new_stream(AVFormatContext *s, int id);
1163
AVProgram *av_new_program(AVFormatContext *s, int id);
1164

    
1165
/**
1166
 * Add a new chapter.
1167
 * This function is NOT part of the public API
1168
 * and should ONLY be used by demuxers.
1169
 *
1170
 * @param s media file handle
1171
 * @param id unique ID for this chapter
1172
 * @param start chapter start time in time_base units
1173
 * @param end chapter end time in time_base units
1174
 * @param title chapter title
1175
 *
1176
 * @return AVChapter or NULL on error
1177
 */
1178
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1179
                          int64_t start, int64_t end, const char *title);
1180

    
1181
/**
1182
 * Set the pts for a given stream.
1183
 *
1184
 * @param s stream
1185
 * @param pts_wrap_bits number of bits effectively used by the pts
1186
 *        (used for wrap control, 33 is the value for MPEG)
1187
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1188
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1189
 */
1190
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1191
                     unsigned int pts_num, unsigned int pts_den);
1192

    
1193
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1194
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1195
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1196
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1197

    
1198
int av_find_default_stream_index(AVFormatContext *s);
1199

    
1200
/**
1201
 * Get the index for a specific timestamp.
1202
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1203
 *                 to the timestamp which is <= the requested one, if backward
1204
 *                 is 0, then it will be >=
1205
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1206
 * @return < 0 if no such timestamp could be found
1207
 */
1208
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1209

    
1210
/**
1211
 * Ensure the index uses less memory than the maximum specified in
1212
 * AVFormatContext.max_index_size by discarding entries if it grows
1213
 * too large.
1214
 * This function is not part of the public API and should only be called
1215
 * by demuxers.
1216
 */
1217
void ff_reduce_index(AVFormatContext *s, int stream_index);
1218

    
1219
/**
1220
 * Add an index entry into a sorted list. Update the entry if the list
1221
 * already contains it.
1222
 *
1223
 * @param timestamp timestamp in the time base of the given stream
1224
 */
1225
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1226
                       int size, int distance, int flags);
1227

    
1228
/**
1229
 * Perform a binary search using av_index_search_timestamp() and
1230
 * AVInputFormat.read_timestamp().
1231
 * This is not supposed to be called directly by a user application,
1232
 * but by demuxers.
1233
 * @param target_ts target timestamp in the time base of the given stream
1234
 * @param stream_index stream number
1235
 */
1236
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1237
                         int64_t target_ts, int flags);
1238

    
1239
/**
1240
 * Update cur_dts of all streams based on the given timestamp and AVStream.
1241
 *
1242
 * Stream ref_st unchanged, others set cur_dts in their native time base.
1243
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1244
 * @param timestamp new dts expressed in time_base of param ref_st
1245
 * @param ref_st reference stream giving time_base of param timestamp
1246
 */
1247
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1248

    
1249
/**
1250
 * Perform a binary search using read_timestamp().
1251
 * This is not supposed to be called directly by a user application,
1252
 * but by demuxers.
1253
 * @param target_ts target timestamp in the time base of the given stream
1254
 * @param stream_index stream number
1255
 */
1256
int64_t av_gen_search(AVFormatContext *s, int stream_index,
1257
                      int64_t target_ts, int64_t pos_min,
1258
                      int64_t pos_max, int64_t pos_limit,
1259
                      int64_t ts_min, int64_t ts_max,
1260
                      int flags, int64_t *ts_ret,
1261
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1262

    
1263
/**
1264
 * media file output
1265
 */
1266
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1267

    
1268
/**
1269
 * Split a URL string into components.
1270
 *
1271
 * The pointers to buffers for storing individual components may be null,
1272
 * in order to ignore that component. Buffers for components not found are
1273
 * set to empty strings. If the port is not found, it is set to a negative
1274
 * value.
1275
 *
1276
 * @param proto the buffer for the protocol
1277
 * @param proto_size the size of the proto buffer
1278
 * @param authorization the buffer for the authorization
1279
 * @param authorization_size the size of the authorization buffer
1280
 * @param hostname the buffer for the host name
1281
 * @param hostname_size the size of the hostname buffer
1282
 * @param port_ptr a pointer to store the port number in
1283
 * @param path the buffer for the path
1284
 * @param path_size the size of the path buffer
1285
 * @param url the URL to split
1286
 */
1287
void av_url_split(char *proto,         int proto_size,
1288
                  char *authorization, int authorization_size,
1289
                  char *hostname,      int hostname_size,
1290
                  int *port_ptr,
1291
                  char *path,          int path_size,
1292
                  const char *url);
1293

    
1294
/**
1295
 * Allocate the stream private data and write the stream header to an
1296
 * output media file.
1297
 *
1298
 * @param s media file handle
1299
 * @return 0 if OK, AVERROR_xxx on error
1300
 */
1301
int av_write_header(AVFormatContext *s);
1302

    
1303
/**
1304
 * Write a packet to an output media file.
1305
 *
1306
 * The packet shall contain one audio or video frame.
1307
 * The packet must be correctly interleaved according to the container
1308
 * specification, if not then av_interleaved_write_frame must be used.
1309
 *
1310
 * @param s media file handle
1311
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1312
              dts/pts, ...
1313
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1314
 */
1315
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1316

    
1317
/**
1318
 * Write a packet to an output media file ensuring correct interleaving.
1319
 *
1320
 * The packet must contain one audio or video frame.
1321
 * If the packets are already correctly interleaved, the application should
1322
 * call av_write_frame() instead as it is slightly faster. It is also important
1323
 * to keep in mind that completely non-interleaved input will need huge amounts
1324
 * of memory to interleave with this, so it is preferable to interleave at the
1325
 * demuxer level.
1326
 *
1327
 * @param s media file handle
1328
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1329
              dts/pts, ...
1330
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1331
 */
1332
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1333

    
1334
/**
1335
 * Interleave a packet per dts in an output media file.
1336
 *
1337
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1338
 * function, so they cannot be used after it. Note that calling av_free_packet()
1339
 * on them is still safe.
1340
 *
1341
 * @param s media file handle
1342
 * @param out the interleaved packet will be output here
1343
 * @param pkt the input packet
1344
 * @param flush 1 if no further packets are available as input and all
1345
 *              remaining packets should be output
1346
 * @return 1 if a packet was output, 0 if no packet could be output,
1347
 *         < 0 if an error occurred
1348
 */
1349
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1350
                                 AVPacket *pkt, int flush);
1351

    
1352
/**
1353
 * Write the stream trailer to an output media file and free the
1354
 * file private data.
1355
 *
1356
 * May only be called after a successful call to av_write_header.
1357
 *
1358
 * @param s media file handle
1359
 * @return 0 if OK, AVERROR_xxx on error
1360
 */
1361
int av_write_trailer(AVFormatContext *s);
1362

    
1363
void dump_format(AVFormatContext *ic,
1364
                 int index,
1365
                 const char *url,
1366
                 int is_output);
1367

    
1368
#if LIBAVFORMAT_VERSION_MAJOR < 53
1369
/**
1370
 * Parse width and height out of string str.
1371
 * @deprecated Use av_parse_video_frame_size instead.
1372
 */
1373
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1374
                                          const char *str);
1375

    
1376
/**
1377
 * Convert framerate from a string to a fraction.
1378
 * @deprecated Use av_parse_video_frame_rate instead.
1379
 */
1380
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1381
                                          const char *arg);
1382
#endif
1383

    
1384
/**
1385
 * Parse datestr and return a corresponding number of microseconds.
1386
 * @param datestr String representing a date or a duration.
1387
 * - If a date the syntax is:
1388
 * @code
1389
 *  now|{[{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z|z]}
1390
 * @endcode
1391
 * If the value is "now" it takes the current time.
1392
 * Time is local time unless Z is appended, in which case it is
1393
 * interpreted as UTC.
1394
 * If the year-month-day part is not specified it takes the current
1395
 * year-month-day.
1396
 * @return the number of microseconds since 1st of January, 1970 up to
1397
 * the time of the parsed date or INT64_MIN if datestr cannot be
1398
 * successfully parsed.
1399
 * - If a duration the syntax is:
1400
 * @code
1401
 *  [-]HH[:MM[:SS[.m...]]]
1402
 *  [-]S+[.m...]
1403
 * @endcode
1404
 * @return the number of microseconds contained in a time interval
1405
 * with the specified duration or INT64_MIN if datestr cannot be
1406
 * successfully parsed.
1407
 * @param duration Flag which tells how to interpret datestr, if
1408
 * not zero datestr is interpreted as a duration, otherwise as a
1409
 * date.
1410
 */
1411
int64_t parse_date(const char *datestr, int duration);
1412

    
1413
/**
1414
 * Get the current time in microseconds.
1415
 */
1416
int64_t av_gettime(void);
1417

    
1418
/* ffm-specific for ffserver */
1419
#define FFM_PACKET_SIZE 4096
1420
int64_t ffm_read_write_index(int fd);
1421
int ffm_write_write_index(int fd, int64_t pos);
1422
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1423

    
1424
/**
1425
 * Attempt to find a specific tag in a URL.
1426
 *
1427
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1428
 * Return 1 if found.
1429
 */
1430
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1431

    
1432
/**
1433
 * Return in 'buf' the path with '%d' replaced by a number.
1434
 *
1435
 * Also handles the '%0nd' format where 'n' is the total number
1436
 * of digits and '%%'.
1437
 *
1438
 * @param buf destination buffer
1439
 * @param buf_size destination buffer size
1440
 * @param path numbered sequence string
1441
 * @param number frame number
1442
 * @return 0 if OK, -1 on format error
1443
 */
1444
int av_get_frame_filename(char *buf, int buf_size,
1445
                          const char *path, int number);
1446

    
1447
/**
1448
 * Check whether filename actually is a numbered sequence generator.
1449
 *
1450
 * @param filename possible numbered sequence string
1451
 * @return 1 if a valid numbered sequence string, 0 otherwise
1452
 */
1453
int av_filename_number_test(const char *filename);
1454

    
1455
/**
1456
 * Generate an SDP for an RTP session.
1457
 *
1458
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1459
 *           array is composed by only one context, such context can contain
1460
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1461
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1462
 *           must contain only one AVStream.
1463
 * @param n_files number of AVCodecContexts contained in ac
1464
 * @param buff buffer where the SDP will be stored (must be allocated by
1465
 *             the caller)
1466
 * @param size the size of the buffer
1467
 * @return 0 if OK, AVERROR_xxx on error
1468
 */
1469
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1470

    
1471
/**
1472
 * Return a positive value if the given filename has one of the given
1473
 * extensions, 0 otherwise.
1474
 *
1475
 * @param extensions a comma-separated list of filename extensions
1476
 */
1477
int av_match_ext(const char *filename, const char *extensions);
1478

    
1479
#endif /* AVFORMAT_AVFORMAT_H */