Statistics
| Branch: | Revision:

ffmpeg / libavformat / avformat.h @ 160c896c

History | View | Annotate | Download (49.7 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 67
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
 * 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
 * Returns the libavformat build-time configuration.
46
 */
47
const char *avformat_configuration(void);
48

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

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

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

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

    
172
/**
173
 * Frees all the memory allocated for an AVMetadata struct.
174
 */
175
void av_metadata_free(AVMetadata **m);
176

    
177

    
178
/* packet functions */
179

    
180

    
181
/**
182
 * Allocates and reads the payload of a packet and initializes its
183
 * fields with default values.
184
 *
185
 * @param pkt packet
186
 * @param size desired payload size
187
 * @return >0 (read size) if OK, AVERROR_xxx otherwise
188
 */
189
int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
190

    
191

    
192
/*************************************************/
193
/* fractional numbers for exact pts handling */
194

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

    
203
/*************************************************/
204
/* input/output formats */
205

    
206
struct AVCodecTag;
207

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

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

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

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

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

    
278
    /**
279
     * List of supported codec_id-codec_tag pairs, ordered by "better
280
     * choice first". The arrays are all terminated by CODEC_ID_NONE.
281
     */
282
    const struct AVCodecTag * const *codec_tag;
283

    
284
    enum CodecID subtitle_codec; /**< default subtitle codec */
285

    
286
    const AVMetadataConv *metadata_conv;
287

    
288
    /* private fields */
289
    struct AVOutputFormat *next;
290
} AVOutputFormat;
291

    
292
typedef struct AVInputFormat {
293
    const char *name;
294
    /**
295
     * Descriptive name for the format, meant to be more human-readable
296
     * than name. You should use the NULL_IF_CONFIG_SMALL() macro
297
     * to define it.
298
     */
299
    const char *long_name;
300
    /** Size of private data so that it can be allocated in the wrapper. */
301
    int priv_data_size;
302
    /**
303
     * Tell if a given file has a chance of being parsed as this format.
304
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
305
     * big so you do not have to check for that unless you need more.
306
     */
307
    int (*read_probe)(AVProbeData *);
308
    /** Read the format header and initialize the AVFormatContext
309
       structure. Return 0 if OK. 'ap' if non-NULL contains
310
       additional parameters. Only used in raw format right
311
       now. 'av_new_stream' should be called to create new streams.  */
312
    int (*read_header)(struct AVFormatContext *,
313
                       AVFormatParameters *ap);
314
    /** Read one packet and put it in 'pkt'. pts and flags are also
315
       set. 'av_new_stream' can be called only if the flag
316
       AVFMTCTX_NOHEADER is used.
317
       @return 0 on success, < 0 on error.
318
               When returning an error, pkt must not have been allocated
319
               or must be freed before returning */
320
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
321
    /** Close the stream. The AVFormatContext and AVStreams are not
322
       freed by this function */
323
    int (*read_close)(struct AVFormatContext *);
324

    
325
#if LIBAVFORMAT_VERSION_MAJOR < 53
326
    /**
327
     * Seek to a given timestamp relative to the frames in
328
     * stream component stream_index.
329
     * @param stream_index Must not be -1.
330
     * @param flags Selects which direction should be preferred if no exact
331
     *              match is available.
332
     * @return >= 0 on success (but not necessarily the new offset)
333
     */
334
    int (*read_seek)(struct AVFormatContext *,
335
                     int stream_index, int64_t timestamp, int flags);
336
#endif
337
    /**
338
     * Gets the next timestamp in stream[stream_index].time_base units.
339
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
340
     */
341
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
342
                              int64_t *pos, int64_t pos_limit);
343
    /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */
344
    int flags;
345
    /** If extensions are defined, then no probe is done. You should
346
       usually not use extension format guessing because it is not
347
       reliable enough */
348
    const char *extensions;
349
    /** General purpose read-only value that the format can use. */
350
    int value;
351

    
352
    /** Starts/resumes playing - only meaningful if using a network-based format
353
       (RTSP). */
354
    int (*read_play)(struct AVFormatContext *);
355

    
356
    /** Pauses playing - only meaningful if using a network-based format
357
       (RTSP). */
358
    int (*read_pause)(struct AVFormatContext *);
359

    
360
    const struct AVCodecTag * const *codec_tag;
361

    
362
    /**
363
     * Seeks to timestamp ts.
364
     * Seeking will be done so that the point from which all active streams
365
     * can be presented successfully will be closest to ts and within min/max_ts.
366
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
367
     */
368
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
369

    
370
    const AVMetadataConv *metadata_conv;
371

    
372
    /* private fields */
373
    struct AVInputFormat *next;
374
} AVInputFormat;
375

    
376
enum AVStreamParseType {
377
    AVSTREAM_PARSE_NONE,
378
    AVSTREAM_PARSE_FULL,       /**< full parsing and repack */
379
    AVSTREAM_PARSE_HEADERS,    /**< Only parse headers, do not repack. */
380
    AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
381
    AVSTREAM_PARSE_FULL_ONCE,  /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
382
};
383

    
384
typedef struct AVIndexEntry {
385
    int64_t pos;
386
    int64_t timestamp;
387
#define AVINDEX_KEYFRAME 0x0001
388
    int flags:2;
389
    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).
390
    int min_distance;         /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
391
} AVIndexEntry;
392

    
393
#define AV_DISPOSITION_DEFAULT   0x0001
394
#define AV_DISPOSITION_DUB       0x0002
395
#define AV_DISPOSITION_ORIGINAL  0x0004
396
#define AV_DISPOSITION_COMMENT   0x0008
397
#define AV_DISPOSITION_LYRICS    0x0010
398
#define AV_DISPOSITION_KARAOKE   0x0020
399

    
400
/**
401
 * Stream structure.
402
 * New fields can be added to the end with minor version bumps.
403
 * Removal, reordering and changes to existing fields require a major
404
 * version bump.
405
 * sizeof(AVStream) must not be used outside libav*.
406
 */
407
typedef struct AVStream {
408
    int index;    /**< stream index in AVFormatContext */
409
    int id;       /**< format-specific stream ID */
410
    AVCodecContext *codec; /**< codec context */
411
    /**
412
     * Real base framerate of the stream.
413
     * This is the lowest framerate with which all timestamps can be
414
     * represented accurately (it is the least common multiple of all
415
     * framerates in the stream). Note, this value is just a guess!
416
     * For example, if the time base is 1/90000 and all frames have either
417
     * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
418
     */
419
    AVRational r_frame_rate;
420
    void *priv_data;
421

    
422
    /* internal data used in av_find_stream_info() */
423
    int64_t first_dts;
424
    /** encoding: pts generation when outputting stream */
425
    struct AVFrac pts;
426

    
427
    /**
428
     * This is the fundamental unit of time (in seconds) in terms
429
     * of which frame timestamps are represented. For fixed-fps content,
430
     * time base should be 1/framerate and timestamp increments should be 1.
431
     */
432
    AVRational time_base;
433
    int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
434
    /* ffmpeg.c private use */
435
    int stream_copy; /**< If set, just copy stream. */
436
    enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
437
    //FIXME move stuff to a flags field?
438
    /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
439
     * MN: dunno if that is the right place for it */
440
    float quality;
441
    /**
442
     * Decoding: pts of the first frame of the stream, in stream time base.
443
     * Only set this if you are absolutely 100% sure that the value you set
444
     * it to really is the pts of the first frame.
445
     * This may be undefined (AV_NOPTS_VALUE).
446
     * @note The ASF header does NOT contain a correct start_time the ASF
447
     * demuxer must NOT set this.
448
     */
449
    int64_t start_time;
450
    /**
451
     * Decoding: duration of the stream, in stream time base.
452
     * If a source file does not specify a duration, but does specify
453
     * a bitrate, this value will be estimated from bitrate and file size.
454
     */
455
    int64_t duration;
456

    
457
#if LIBAVFORMAT_VERSION_INT < (53<<16)
458
    char language[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */
459
#endif
460

    
461
    /* av_read_frame() support */
462
    enum AVStreamParseType need_parsing;
463
    struct AVCodecParserContext *parser;
464

    
465
    int64_t cur_dts;
466
    int last_IP_duration;
467
    int64_t last_IP_pts;
468
    /* av_seek_frame() support */
469
    AVIndexEntry *index_entries; /**< Only used if the format does not
470
                                    support seeking natively. */
471
    int nb_index_entries;
472
    unsigned int index_entries_allocated_size;
473

    
474
    int64_t nb_frames;                 ///< number of frames in this stream if known or 0
475

    
476
#if LIBAVFORMAT_VERSION_INT < (53<<16)
477
    int64_t unused[4+1];
478

    
479
    char *filename; /**< source filename of the stream */
480
#endif
481

    
482
    int disposition; /**< AV_DISPOSITION_* bit field */
483

    
484
    AVProbeData probe_data;
485
#define MAX_REORDER_DELAY 16
486
    int64_t pts_buffer[MAX_REORDER_DELAY+1];
487

    
488
    /**
489
     * sample aspect ratio (0 if unknown)
490
     * - encoding: Set by user.
491
     * - decoding: Set by libavformat.
492
     */
493
    AVRational sample_aspect_ratio;
494

    
495
    AVMetadata *metadata;
496

    
497
    /* av_read_frame() support */
498
    const uint8_t *cur_ptr;
499
    int cur_len;
500
    AVPacket cur_pkt;
501

    
502
    // Timestamp generation support:
503
    /**
504
     * Timestamp corresponding to the last dts sync point.
505
     *
506
     * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
507
     * a DTS is received from the underlying container. Otherwise set to
508
     * AV_NOPTS_VALUE by default.
509
     */
510
    int64_t reference_dts;
511

    
512
    /**
513
     * Number of packets to buffer for codec probing
514
     * NOT PART OF PUBLIC API
515
     */
516
#define MAX_PROBE_PACKETS 2500
517
    int probe_packets;
518

    
519
    /**
520
     * last packet in packet_buffer for this stream when muxing.
521
     * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
522
     */
523
    struct AVPacketList *last_in_packet_buffer;
524

    
525
    /**
526
     * Average framerate
527
     */
528
    AVRational avg_frame_rate;
529

    
530
    /**
531
     * Number of frames that have been demuxed during av_find_stream_info()
532
     */
533
    int codec_info_nb_frames;
534
} AVStream;
535

    
536
#define AV_PROGRAM_RUNNING 1
537

    
538
/**
539
 * New fields can be added to the end with minor version bumps.
540
 * Removal, reordering and changes to existing fields require a major
541
 * version bump.
542
 * sizeof(AVProgram) must not be used outside libav*.
543
 */
544
typedef struct AVProgram {
545
    int            id;
546
#if LIBAVFORMAT_VERSION_INT < (53<<16)
547
    char           *provider_name; ///< network name for DVB streams
548
    char           *name;          ///< service name for DVB streams
549
#endif
550
    int            flags;
551
    enum AVDiscard discard;        ///< selects which program to discard and which to feed to the caller
552
    unsigned int   *stream_index;
553
    unsigned int   nb_stream_indexes;
554
    AVMetadata *metadata;
555
} AVProgram;
556

    
557
#define AVFMTCTX_NOHEADER      0x0001 /**< signal that no header is present
558
                                         (streams are added dynamically) */
559

    
560
typedef struct AVChapter {
561
    int id;                 ///< unique ID to identify the chapter
562
    AVRational time_base;   ///< time base in which the start/end timestamps are specified
563
    int64_t start, end;     ///< chapter start/end time in time_base units
564
#if LIBAVFORMAT_VERSION_INT < (53<<16)
565
    char *title;            ///< chapter title
566
#endif
567
    AVMetadata *metadata;
568
} AVChapter;
569

    
570
#if LIBAVFORMAT_VERSION_MAJOR < 53
571
#define MAX_STREAMS 20
572
#else
573
#define MAX_STREAMS 100
574
#endif
575

    
576
/**
577
 * Format I/O context.
578
 * New fields can be added to the end with minor version bumps.
579
 * Removal, reordering and changes to existing fields require a major
580
 * version bump.
581
 * sizeof(AVFormatContext) must not be used outside libav*.
582
 */
583
typedef struct AVFormatContext {
584
    const AVClass *av_class; /**< Set by avformat_alloc_context. */
585
    /* Can only be iformat or oformat, not both at the same time. */
586
    struct AVInputFormat *iformat;
587
    struct AVOutputFormat *oformat;
588
    void *priv_data;
589
    ByteIOContext *pb;
590
    unsigned int nb_streams;
591
    AVStream *streams[MAX_STREAMS];
592
    char filename[1024]; /**< input or output filename */
593
    /* stream info */
594
    int64_t timestamp;
595
#if LIBAVFORMAT_VERSION_INT < (53<<16)
596
    char title[512];
597
    char author[512];
598
    char copyright[512];
599
    char comment[512];
600
    char album[512];
601
    int year;  /**< ID3 year, 0 if none */
602
    int track; /**< track number, 0 if none */
603
    char genre[32]; /**< ID3 genre */
604
#endif
605

    
606
    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
607
    /* private data for pts handling (do not modify directly). */
608
    /** This buffer is only needed when packets were already buffered but
609
       not decoded, for example to get the codec parameters in MPEG
610
       streams. */
611
    struct AVPacketList *packet_buffer;
612

    
613
    /** Decoding: position of the first frame of the component, in
614
       AV_TIME_BASE fractional seconds. NEVER set this value directly:
615
       It is deduced from the AVStream values.  */
616
    int64_t start_time;
617
    /** Decoding: duration of the stream, in AV_TIME_BASE fractional
618
       seconds. Only set this value if you know none of the individual stream
619
       durations and also dont set any of them. This is deduced from the
620
       AVStream values if not set.  */
621
    int64_t duration;
622
    /** decoding: total file size, 0 if unknown */
623
    int64_t file_size;
624
    /** Decoding: total stream bitrate in bit/s, 0 if not
625
       available. Never set it directly if the file_size and the
626
       duration are known as FFmpeg can compute it automatically. */
627
    int bit_rate;
628

    
629
    /* av_read_frame() support */
630
    AVStream *cur_st;
631
#if LIBAVFORMAT_VERSION_INT < (53<<16)
632
    const uint8_t *cur_ptr_deprecated;
633
    int cur_len_deprecated;
634
    AVPacket cur_pkt_deprecated;
635
#endif
636

    
637
    /* av_seek_frame() support */
638
    int64_t data_offset; /** offset of the first packet */
639
    int index_built;
640

    
641
    int mux_rate;
642
    unsigned int packet_size;
643
    int preload;
644
    int max_delay;
645

    
646
#define AVFMT_NOOUTPUTLOOP -1
647
#define AVFMT_INFINITEOUTPUTLOOP 0
648
    /** number of times to loop output in formats that support it */
649
    int loop_output;
650

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

    
660
    int loop_input;
661
    /** decoding: size of data to probe; encoding: unused. */
662
    unsigned int probesize;
663

    
664
    /**
665
     * Maximum time (in AV_TIME_BASE units) during which the input should
666
     * be analyzed in av_find_stream_info().
667
     */
668
    int max_analyze_duration;
669

    
670
    const uint8_t *key;
671
    int keylen;
672

    
673
    unsigned int nb_programs;
674
    AVProgram **programs;
675

    
676
    /**
677
     * Forced video codec_id.
678
     * Demuxing: Set by user.
679
     */
680
    enum CodecID video_codec_id;
681
    /**
682
     * Forced audio codec_id.
683
     * Demuxing: Set by user.
684
     */
685
    enum CodecID audio_codec_id;
686
    /**
687
     * Forced subtitle codec_id.
688
     * Demuxing: Set by user.
689
     */
690
    enum CodecID subtitle_codec_id;
691

    
692
    /**
693
     * Maximum amount of memory in bytes to use for the index of each stream.
694
     * If the index exceeds this size, entries will be discarded as
695
     * needed to maintain a smaller size. This can lead to slower or less
696
     * accurate seeking (depends on demuxer).
697
     * Demuxers for which a full in-memory index is mandatory will ignore
698
     * this.
699
     * muxing  : unused
700
     * demuxing: set by user
701
     */
702
    unsigned int max_index_size;
703

    
704
    /**
705
     * Maximum amount of memory in bytes to use for buffering frames
706
     * obtained from realtime capture devices.
707
     */
708
    unsigned int max_picture_buffer;
709

    
710
    unsigned int nb_chapters;
711
    AVChapter **chapters;
712

    
713
    /**
714
     * Flags to enable debugging.
715
     */
716
    int debug;
717
#define FF_FDEBUG_TS        0x0001
718

    
719
    /**
720
     * Raw packets from the demuxer, prior to parsing and decoding.
721
     * This buffer is used for buffering packets until the codec can
722
     * be identified, as parsing cannot be done without knowing the
723
     * codec.
724
     */
725
    struct AVPacketList *raw_packet_buffer;
726
    struct AVPacketList *raw_packet_buffer_end;
727

    
728
    struct AVPacketList *packet_buffer_end;
729

    
730
    AVMetadata *metadata;
731

    
732
    /**
733
     * Remaining size available for raw_packet_buffer, in bytes.
734
     * NOT PART OF PUBLIC API
735
     */
736
#define RAW_PACKET_BUFFER_SIZE 2500000
737
    int raw_packet_buffer_remaining_size;
738

    
739
    /**
740
     * Start time of the stream in real world time, in microseconds
741
     * since the unix epoch (00:00 1st January 1970). That is, pts=0
742
     * in the stream was captured at this real world time.
743
     * - encoding: Set by user.
744
     * - decoding: Unused.
745
     */
746
    int64_t start_time_realtime;
747
} AVFormatContext;
748

    
749
typedef struct AVPacketList {
750
    AVPacket pkt;
751
    struct AVPacketList *next;
752
} AVPacketList;
753

    
754
#if LIBAVFORMAT_VERSION_INT < (53<<16)
755
extern AVInputFormat *first_iformat;
756
extern AVOutputFormat *first_oformat;
757
#endif
758

    
759
/**
760
 * If f is NULL, returns the first registered input format,
761
 * if f is non-NULL, returns the next registered input format after f
762
 * or NULL if f is the last one.
763
 */
764
AVInputFormat  *av_iformat_next(AVInputFormat  *f);
765

    
766
/**
767
 * If f is NULL, returns the first registered output format,
768
 * if f is non-NULL, returns the next registered output format after f
769
 * or NULL if f is the last one.
770
 */
771
AVOutputFormat *av_oformat_next(AVOutputFormat *f);
772

    
773
enum CodecID av_guess_image2_codec(const char *filename);
774

    
775
/* XXX: Use automatic init with either ELF sections or C file parser */
776
/* modules. */
777

    
778
/* utils.c */
779
void av_register_input_format(AVInputFormat *format);
780
void av_register_output_format(AVOutputFormat *format);
781
#if LIBAVFORMAT_VERSION_MAJOR < 53
782
attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
783
                                    const char *filename,
784
                                    const char *mime_type);
785

    
786
/**
787
 * @deprecated Use av_guess_format() instead.
788
 */
789
attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
790
                                                  const char *filename,
791
                                                  const char *mime_type);
792
#endif
793

    
794
/**
795
 * Returns the output format in the list of registered output formats
796
 * which best matches the provided parameters, or returns NULL if
797
 * there is no match.
798
 *
799
 * @param short_name if non-NULL checks if short_name matches with the
800
 * names of the registered formats
801
 * @param filename if non-NULL checks if filename terminates with the
802
 * extensions of the registered formats
803
 * @param mime_type if non-NULL checks if mime_type matches with the
804
 * MIME type of the registered formats
805
 */
806
AVOutputFormat *av_guess_format(const char *short_name,
807
                                const char *filename,
808
                                const char *mime_type);
809

    
810
/**
811
 * Guesses the codec ID based upon muxer and filename.
812
 */
813
enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
814
                            const char *filename, const char *mime_type,
815
                            enum AVMediaType type);
816

    
817
/**
818
 * Sends a nice hexadecimal dump of a buffer to the specified file stream.
819
 *
820
 * @param f The file stream pointer where the dump should be sent to.
821
 * @param buf buffer
822
 * @param size buffer size
823
 *
824
 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
825
 */
826
void av_hex_dump(FILE *f, uint8_t *buf, int size);
827

    
828
/**
829
 * Sends a nice hexadecimal dump of a buffer to the log.
830
 *
831
 * @param avcl A pointer to an arbitrary struct of which the first field is a
832
 * pointer to an AVClass struct.
833
 * @param level The importance level of the message, lower values signifying
834
 * higher importance.
835
 * @param buf buffer
836
 * @param size buffer size
837
 *
838
 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
839
 */
840
void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
841

    
842
/**
843
 * Sends a nice dump of a packet to the specified file stream.
844
 *
845
 * @param f The file stream pointer where the dump should be sent to.
846
 * @param pkt packet to dump
847
 * @param dump_payload True if the payload must be displayed, too.
848
 */
849
void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
850

    
851
/**
852
 * Sends a nice dump of a packet to the log.
853
 *
854
 * @param avcl A pointer to an arbitrary struct of which the first field is a
855
 * pointer to an AVClass struct.
856
 * @param level The importance level of the message, lower values signifying
857
 * higher importance.
858
 * @param pkt packet to dump
859
 * @param dump_payload True if the payload must be displayed, too.
860
 */
861
void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
862

    
863
/**
864
 * Initializes libavformat and registers all the muxers, demuxers and
865
 * protocols. If you do not call this function, then you can select
866
 * exactly which formats you want to support.
867
 *
868
 * @see av_register_input_format()
869
 * @see av_register_output_format()
870
 * @see av_register_protocol()
871
 */
872
void av_register_all(void);
873

    
874
/**
875
 * Gets the CodecID for the given codec tag tag.
876
 * If no codec id is found returns CODEC_ID_NONE.
877
 *
878
 * @param tags list of supported codec_id-codec_tag pairs, as stored
879
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
880
 */
881
enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
882

    
883
/**
884
 * Gets the codec tag for the given codec id id.
885
 * If no codec tag is found returns 0.
886
 *
887
 * @param tags list of supported codec_id-codec_tag pairs, as stored
888
 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
889
 */
890
unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
891

    
892
/* media file input */
893

    
894
/**
895
 * Finds AVInputFormat based on the short name of the input format.
896
 */
897
AVInputFormat *av_find_input_format(const char *short_name);
898

    
899
/**
900
 * Guesses the file format.
901
 *
902
 * @param is_opened Whether the file is already opened; determines whether
903
 *                  demuxers with or without AVFMT_NOFILE are probed.
904
 */
905
AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
906

    
907
/**
908
 * Guesses the file format.
909
 *
910
 * @param is_opened Whether the file is already opened; determines whether
911
 *                  demuxers with or without AVFMT_NOFILE are probed.
912
 * @param score_max A probe score larger that this is required to accept a
913
 *                  detection, the variable is set to the actual detection
914
 *                  score afterwards.
915
 *                  If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
916
 *                  to retry with a larger probe buffer.
917
 */
918
AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
919

    
920
/**
921
 * Allocates all the structures needed to read an input stream.
922
 *        This does not open the needed codecs for decoding the stream[s].
923
 */
924
int av_open_input_stream(AVFormatContext **ic_ptr,
925
                         ByteIOContext *pb, const char *filename,
926
                         AVInputFormat *fmt, AVFormatParameters *ap);
927

    
928
/**
929
 * Opens a media file as input. The codecs are not opened. Only the file
930
 * header (if present) is read.
931
 *
932
 * @param ic_ptr The opened media file handle is put here.
933
 * @param filename filename to open
934
 * @param fmt If non-NULL, force the file format to use.
935
 * @param buf_size optional buffer size (zero if default is OK)
936
 * @param ap Additional parameters needed when opening the file
937
 *           (NULL if default).
938
 * @return 0 if OK, AVERROR_xxx otherwise
939
 */
940
int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
941
                       AVInputFormat *fmt,
942
                       int buf_size,
943
                       AVFormatParameters *ap);
944

    
945
#if LIBAVFORMAT_VERSION_MAJOR < 53
946
/**
947
 * @deprecated Use avformat_alloc_context() instead.
948
 */
949
attribute_deprecated AVFormatContext *av_alloc_format_context(void);
950
#endif
951

    
952
/**
953
 * Allocates an AVFormatContext.
954
 * Can be freed with av_free() but do not forget to free everything you
955
 * explicitly allocated as well!
956
 */
957
AVFormatContext *avformat_alloc_context(void);
958

    
959
/**
960
 * Reads packets of a media file to get stream information. This
961
 * is useful for file formats with no headers such as MPEG. This
962
 * function also computes the real framerate in case of MPEG-2 repeat
963
 * frame mode.
964
 * The logical file position is not changed by this function;
965
 * examined packets may be buffered for later processing.
966
 *
967
 * @param ic media file handle
968
 * @return >=0 if OK, AVERROR_xxx on error
969
 * @todo Let the user decide somehow what information is needed so that
970
 *       we do not waste time getting stuff the user does not need.
971
 */
972
int av_find_stream_info(AVFormatContext *ic);
973

    
974
/**
975
 * Reads a transport packet from a media file.
976
 *
977
 * This function is obsolete and should never be used.
978
 * Use av_read_frame() instead.
979
 *
980
 * @param s media file handle
981
 * @param pkt is filled
982
 * @return 0 if OK, AVERROR_xxx on error
983
 */
984
int av_read_packet(AVFormatContext *s, AVPacket *pkt);
985

    
986
/**
987
 * Returns the next frame of a stream.
988
 *
989
 * The returned packet is valid
990
 * until the next av_read_frame() or until av_close_input_file() and
991
 * must be freed with av_free_packet. For video, the packet contains
992
 * exactly one frame. For audio, it contains an integer number of
993
 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
994
 * data). If the audio frames have a variable size (e.g. MPEG audio),
995
 * then it contains one frame.
996
 *
997
 * pkt->pts, pkt->dts and pkt->duration are always set to correct
998
 * values in AVStream.time_base units (and guessed if the format cannot
999
 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1000
 * has B-frames, so it is better to rely on pkt->dts if you do not
1001
 * decompress the payload.
1002
 *
1003
 * @return 0 if OK, < 0 on error or end of file
1004
 */
1005
int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1006

    
1007
/**
1008
 * Seeks to the keyframe at timestamp.
1009
 * 'timestamp' in 'stream_index'.
1010
 * @param stream_index If stream_index is (-1), a default
1011
 * stream is selected, and timestamp is automatically converted
1012
 * from AV_TIME_BASE units to the stream specific time_base.
1013
 * @param timestamp Timestamp in AVStream.time_base units
1014
 *        or, if no stream is specified, in AV_TIME_BASE units.
1015
 * @param flags flags which select direction and seeking mode
1016
 * @return >= 0 on success
1017
 */
1018
int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1019
                  int flags);
1020

    
1021
/**
1022
 * Seeks to timestamp ts.
1023
 * Seeking will be done so that the point from which all active streams
1024
 * can be presented successfully will be closest to ts and within min/max_ts.
1025
 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1026
 *
1027
 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1028
 * are the file position (this may not be supported by all demuxers).
1029
 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1030
 * in the stream with stream_index (this may not be supported by all demuxers).
1031
 * Otherwise all timestamps are in units of the stream selected by stream_index
1032
 * or if stream_index is -1, in AV_TIME_BASE units.
1033
 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1034
 * keyframes (this may not be supported by all demuxers).
1035
 *
1036
 * @param stream_index index of the stream which is used as time base reference
1037
 * @param min_ts smallest acceptable timestamp
1038
 * @param ts target timestamp
1039
 * @param max_ts largest acceptable timestamp
1040
 * @param flags flags
1041
 * @return >=0 on success, error code otherwise
1042
 *
1043
 * @NOTE This is part of the new seek API which is still under construction.
1044
 *       Thus do not use this yet. It may change at any time, do not expect
1045
 *       ABI compatibility yet!
1046
 */
1047
int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1048

    
1049
/**
1050
 * Starts playing a network-based stream (e.g. RTSP stream) at the
1051
 * current position.
1052
 */
1053
int av_read_play(AVFormatContext *s);
1054

    
1055
/**
1056
 * Pauses a network-based stream (e.g. RTSP stream).
1057
 *
1058
 * Use av_read_play() to resume it.
1059
 */
1060
int av_read_pause(AVFormatContext *s);
1061

    
1062
/**
1063
 * Frees a AVFormatContext allocated by av_open_input_stream.
1064
 * @param s context to free
1065
 */
1066
void av_close_input_stream(AVFormatContext *s);
1067

    
1068
/**
1069
 * Closes a media file (but not its codecs).
1070
 *
1071
 * @param s media file handle
1072
 */
1073
void av_close_input_file(AVFormatContext *s);
1074

    
1075
/**
1076
 * Adds a new stream to a media file.
1077
 *
1078
 * Can only be called in the read_header() function. If the flag
1079
 * AVFMTCTX_NOHEADER is in the format context, then new streams
1080
 * can be added in read_packet too.
1081
 *
1082
 * @param s media file handle
1083
 * @param id file-format-dependent stream ID
1084
 */
1085
AVStream *av_new_stream(AVFormatContext *s, int id);
1086
AVProgram *av_new_program(AVFormatContext *s, int id);
1087

    
1088
/**
1089
 * Adds a new chapter.
1090
 * This function is NOT part of the public API
1091
 * and should ONLY be used by demuxers.
1092
 *
1093
 * @param s media file handle
1094
 * @param id unique ID for this chapter
1095
 * @param start chapter start time in time_base units
1096
 * @param end chapter end time in time_base units
1097
 * @param title chapter title
1098
 *
1099
 * @return AVChapter or NULL on error
1100
 */
1101
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1102
                          int64_t start, int64_t end, const char *title);
1103

    
1104
/**
1105
 * Sets the pts for a given stream.
1106
 *
1107
 * @param s stream
1108
 * @param pts_wrap_bits number of bits effectively used by the pts
1109
 *        (used for wrap control, 33 is the value for MPEG)
1110
 * @param pts_num numerator to convert to seconds (MPEG: 1)
1111
 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1112
 */
1113
void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1114
                     unsigned int pts_num, unsigned int pts_den);
1115

    
1116
#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1117
#define AVSEEK_FLAG_BYTE     2 ///< seeking based on position in bytes
1118
#define AVSEEK_FLAG_ANY      4 ///< seek to any frame, even non-keyframes
1119
#define AVSEEK_FLAG_FRAME    8 ///< seeking based on frame number
1120

    
1121
int av_find_default_stream_index(AVFormatContext *s);
1122

    
1123
/**
1124
 * Gets the index for a specific timestamp.
1125
 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1126
 *                 to the timestamp which is <= the requested one, if backward
1127
 *                 is 0, then it will be >=
1128
 *              if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1129
 * @return < 0 if no such timestamp could be found
1130
 */
1131
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1132

    
1133
/**
1134
 * Ensures the index uses less memory than the maximum specified in
1135
 * AVFormatContext.max_index_size by discarding entries if it grows
1136
 * too large.
1137
 * This function is not part of the public API and should only be called
1138
 * by demuxers.
1139
 */
1140
void ff_reduce_index(AVFormatContext *s, int stream_index);
1141

    
1142
/**
1143
 * Adds an index entry into a sorted list. Updates the entry if the list
1144
 * already contains it.
1145
 *
1146
 * @param timestamp timestamp in the time base of the given stream
1147
 */
1148
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1149
                       int size, int distance, int flags);
1150

    
1151
/**
1152
 * Does a binary search using av_index_search_timestamp() and
1153
 * AVCodec.read_timestamp().
1154
 * This is not supposed to be called directly by a user application,
1155
 * but by demuxers.
1156
 * @param target_ts target timestamp in the time base of the given stream
1157
 * @param stream_index stream number
1158
 */
1159
int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1160
                         int64_t target_ts, int flags);
1161

    
1162
/**
1163
 * Updates cur_dts of all streams based on the given timestamp and AVStream.
1164
 *
1165
 * Stream ref_st unchanged, others set cur_dts in their native time base.
1166
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1167
 * @param timestamp new dts expressed in time_base of param ref_st
1168
 * @param ref_st reference stream giving time_base of param timestamp
1169
 */
1170
void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1171

    
1172
/**
1173
 * Does a binary search using read_timestamp().
1174
 * This is not supposed to be called directly by a user application,
1175
 * but by demuxers.
1176
 * @param target_ts target timestamp in the time base of the given stream
1177
 * @param stream_index stream number
1178
 */
1179
int64_t av_gen_search(AVFormatContext *s, int stream_index,
1180
                      int64_t target_ts, int64_t pos_min,
1181
                      int64_t pos_max, int64_t pos_limit,
1182
                      int64_t ts_min, int64_t ts_max,
1183
                      int flags, int64_t *ts_ret,
1184
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1185

    
1186
/** media file output */
1187
int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1188

    
1189
/**
1190
 * Allocates the stream private data and writes the stream header to an
1191
 * output media file.
1192
 *
1193
 * @param s media file handle
1194
 * @return 0 if OK, AVERROR_xxx on error
1195
 */
1196
int av_write_header(AVFormatContext *s);
1197

    
1198
/**
1199
 * Writes a packet to an output media file.
1200
 *
1201
 * The packet shall contain one audio or video frame.
1202
 * The packet must be correctly interleaved according to the container
1203
 * specification, if not then av_interleaved_write_frame must be used.
1204
 *
1205
 * @param s media file handle
1206
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1207
              dts/pts, ...
1208
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1209
 */
1210
int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1211

    
1212
/**
1213
 * Writes a packet to an output media file ensuring correct interleaving.
1214
 *
1215
 * The packet must contain one audio or video frame.
1216
 * If the packets are already correctly interleaved, the application should
1217
 * call av_write_frame() instead as it is slightly faster. It is also important
1218
 * to keep in mind that completely non-interleaved input will need huge amounts
1219
 * of memory to interleave with this, so it is preferable to interleave at the
1220
 * demuxer level.
1221
 *
1222
 * @param s media file handle
1223
 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1224
              dts/pts, ...
1225
 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1226
 */
1227
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1228

    
1229
/**
1230
 * Interleaves a packet per dts in an output media file.
1231
 *
1232
 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1233
 * function, so they cannot be used after it. Note that calling av_free_packet()
1234
 * on them is still safe.
1235
 *
1236
 * @param s media file handle
1237
 * @param out the interleaved packet will be output here
1238
 * @param in the input packet
1239
 * @param flush 1 if no further packets are available as input and all
1240
 *              remaining packets should be output
1241
 * @return 1 if a packet was output, 0 if no packet could be output,
1242
 *         < 0 if an error occurred
1243
 */
1244
int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1245
                                 AVPacket *pkt, int flush);
1246

    
1247
/**
1248
 * Writes the stream trailer to an output media file and frees the
1249
 * file private data.
1250
 *
1251
 * May only be called after a successful call to av_write_header.
1252
 *
1253
 * @param s media file handle
1254
 * @return 0 if OK, AVERROR_xxx on error
1255
 */
1256
int av_write_trailer(AVFormatContext *s);
1257

    
1258
void dump_format(AVFormatContext *ic,
1259
                 int index,
1260
                 const char *url,
1261
                 int is_output);
1262

    
1263
#if LIBAVFORMAT_VERSION_MAJOR < 53
1264
/**
1265
 * Parses width and height out of string str.
1266
 * @deprecated Use av_parse_video_frame_size instead.
1267
 */
1268
attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1269
                                          const char *str);
1270

    
1271
/**
1272
 * Converts framerate from a string to a fraction.
1273
 * @deprecated Use av_parse_video_frame_rate instead.
1274
 */
1275
attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1276
                                          const char *arg);
1277
#endif
1278

    
1279
/**
1280
 * Parses datestr and returns a corresponding number of microseconds.
1281
 * @param datestr String representing a date or a duration.
1282
 * - If a date the syntax is:
1283
 * @code
1284
 *  [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
1285
 * @endcode
1286
 * Time is local time unless Z is appended, in which case it is
1287
 * interpreted as UTC.
1288
 * If the year-month-day part is not specified it takes the current
1289
 * year-month-day.
1290
 * Returns the number of microseconds since 1st of January, 1970 up to
1291
 * the time of the parsed date or INT64_MIN if datestr cannot be
1292
 * successfully parsed.
1293
 * - If a duration the syntax is:
1294
 * @code
1295
 *  [-]HH[:MM[:SS[.m...]]]
1296
 *  [-]S+[.m...]
1297
 * @endcode
1298
 * Returns the number of microseconds contained in a time interval
1299
 * with the specified duration or INT64_MIN if datestr cannot be
1300
 * successfully parsed.
1301
 * @param duration Flag which tells how to interpret datestr, if
1302
 * not zero datestr is interpreted as a duration, otherwise as a
1303
 * date.
1304
 */
1305
int64_t parse_date(const char *datestr, int duration);
1306

    
1307
/** Gets the current time in microseconds. */
1308
int64_t av_gettime(void);
1309

    
1310
/* ffm-specific for ffserver */
1311
#define FFM_PACKET_SIZE 4096
1312
int64_t ffm_read_write_index(int fd);
1313
int ffm_write_write_index(int fd, int64_t pos);
1314
void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1315

    
1316
/**
1317
 * Attempts to find a specific tag in a URL.
1318
 *
1319
 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1320
 * Return 1 if found.
1321
 */
1322
int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1323

    
1324
/**
1325
 * Returns in 'buf' the path with '%d' replaced by a number.
1326
 *
1327
 * Also handles the '%0nd' format where 'n' is the total number
1328
 * of digits and '%%'.
1329
 *
1330
 * @param buf destination buffer
1331
 * @param buf_size destination buffer size
1332
 * @param path numbered sequence string
1333
 * @param number frame number
1334
 * @return 0 if OK, -1 on format error
1335
 */
1336
int av_get_frame_filename(char *buf, int buf_size,
1337
                          const char *path, int number);
1338

    
1339
/**
1340
 * Checks whether filename actually is a numbered sequence generator.
1341
 *
1342
 * @param filename possible numbered sequence string
1343
 * @return 1 if a valid numbered sequence string, 0 otherwise
1344
 */
1345
int av_filename_number_test(const char *filename);
1346

    
1347
/**
1348
 * Generates an SDP for an RTP session.
1349
 *
1350
 * @param ac array of AVFormatContexts describing the RTP streams. If the
1351
 *           array is composed by only one context, such context can contain
1352
 *           multiple AVStreams (one AVStream per RTP stream). Otherwise,
1353
 *           all the contexts in the array (an AVCodecContext per RTP stream)
1354
 *           must contain only one AVStream.
1355
 * @param n_files number of AVCodecContexts contained in ac
1356
 * @param buff buffer where the SDP will be stored (must be allocated by
1357
 *             the caller)
1358
 * @param size the size of the buffer
1359
 * @return 0 if OK, AVERROR_xxx on error
1360
 */
1361
int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1362

    
1363
/**
1364
 * Returns a positive value if the given filename has one of the given
1365
 * extensions, 0 otherwise.
1366
 *
1367
 * @param extensions a comma-separated list of filename extensions
1368
 */
1369
int av_match_ext(const char *filename, const char *extensions);
1370

    
1371
#endif /* AVFORMAT_AVFORMAT_H */