Add Changelog entry and bump lavf micro version for the addition of
[libav.git] / libavformat / avformat.h
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 56
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 * 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
123 typedef struct {
124 char *key;
125 char *value;
126 }AVMetadataTag;
127
128 typedef struct AVMetadata AVMetadata;
129 typedef struct AVMetadataConv AVMetadataConv;
130
131 /**
132 * Gets a metadata element with matching key.
133 * @param prev Set to the previous matching element to find the next.
134 * @param flags Allows case as well as suffix-insensitive comparisons.
135 * @return Found tag or NULL, changing key or value leads to undefined behavior.
136 */
137 AVMetadataTag *
138 av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int flags);
139
140 #if LIBAVFORMAT_VERSION_MAJOR == 52
141 /**
142 * Sets the given tag in m, overwriting an existing tag.
143 * @param key tag key to add to m (will be av_strduped)
144 * @param value tag value to add to m (will be av_strduped)
145 * @return >= 0 on success otherwise an error code <0
146 */
147 int av_metadata_set(AVMetadata **pm, const char *key, const char *value);
148 #endif
149
150 /**
151 * Sets the given tag in m, overwriting an existing tag.
152 * @param key tag key to add to m (will be av_strduped depending on flags)
153 * @param value tag value to add to m (will be av_strduped depending on flags)
154 * @return >= 0 on success otherwise an error code <0
155 */
156 int av_metadata_set2(AVMetadata **pm, const char *key, const char *value, int flags);
157
158 /**
159 * Converts all the metadata sets from ctx according to the source and
160 * destination conversion tables. If one of the tables is NULL, then
161 * tags are converted to/from ffmpeg generic tag names.
162 * @param d_conv destination tags format conversion table
163 * @param s_conv source tags format conversion table
164 */
165 void av_metadata_conv(struct AVFormatContext *ctx,const AVMetadataConv *d_conv,
166 const AVMetadataConv *s_conv);
167
168 /**
169 * Frees all the memory allocated for an AVMetadata struct.
170 */
171 void av_metadata_free(AVMetadata **m);
172
173
174 /* packet functions */
175
176
177 /**
178 * Allocates and reads the payload of a packet and initializes its
179 * fields with default values.
180 *
181 * @param pkt packet
182 * @param size desired payload size
183 * @return >0 (read size) if OK, AVERROR_xxx otherwise
184 */
185 int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
186
187
188 /*************************************************/
189 /* fractional numbers for exact pts handling */
190
191 /**
192 * The exact value of the fractional number is: 'val + num / den'.
193 * num is assumed to be 0 <= num < den.
194 */
195 typedef struct AVFrac {
196 int64_t val, num, den;
197 } AVFrac;
198
199 /*************************************************/
200 /* input/output formats */
201
202 struct AVCodecTag;
203
204 /** This structure contains the data a format has to probe a file. */
205 typedef struct AVProbeData {
206 const char *filename;
207 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
208 int buf_size; /**< Size of buf except extra allocated bytes */
209 } AVProbeData;
210
211 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
212 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
213
214 typedef struct AVFormatParameters {
215 AVRational time_base;
216 int sample_rate;
217 int channels;
218 int width;
219 int height;
220 enum PixelFormat pix_fmt;
221 int channel; /**< Used to select DV channel. */
222 const char *standard; /**< TV standard, NTSC, PAL, SECAM */
223 unsigned int mpeg2ts_raw:1; /**< Force raw MPEG-2 transport stream output, if possible. */
224 unsigned int mpeg2ts_compute_pcr:1; /**< Compute exact PCR for each transport
225 stream packet (only meaningful if
226 mpeg2ts_raw is TRUE). */
227 unsigned int initial_pause:1; /**< Do not begin to play the stream
228 immediately (RTSP only). */
229 unsigned int prealloced_context:1;
230 #if LIBAVFORMAT_VERSION_INT < (53<<16)
231 enum CodecID video_codec_id;
232 enum CodecID audio_codec_id;
233 #endif
234 } AVFormatParameters;
235
236 //! Demuxer will use url_fopen, no opened file should be provided by the caller.
237 #define AVFMT_NOFILE 0x0001
238 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
239 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
240 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
241 raw picture data. */
242 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
243 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
244 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
245 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. */
246 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
247 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
248
249 typedef struct AVOutputFormat {
250 const char *name;
251 /**
252 * Descriptive name for the format, meant to be more human-readable
253 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
254 * to define it.
255 */
256 const char *long_name;
257 const char *mime_type;
258 const char *extensions; /**< comma-separated filename extensions */
259 /** size of private data so that it can be allocated in the wrapper */
260 int priv_data_size;
261 /* output support */
262 enum CodecID audio_codec; /**< default audio codec */
263 enum CodecID video_codec; /**< default video codec */
264 int (*write_header)(struct AVFormatContext *);
265 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
266 int (*write_trailer)(struct AVFormatContext *);
267 /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
268 int flags;
269 /** Currently only used to set pixel format if not YUV420P. */
270 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
271 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
272 AVPacket *in, int flush);
273
274 /**
275 * List of supported codec_id-codec_tag pairs, ordered by "better
276 * choice first". The arrays are all terminated by CODEC_ID_NONE.
277 */
278 const struct AVCodecTag * const *codec_tag;
279
280 enum CodecID subtitle_codec; /**< default subtitle codec */
281
282 const AVMetadataConv *metadata_conv;
283
284 /* private fields */
285 struct AVOutputFormat *next;
286 } AVOutputFormat;
287
288 typedef struct AVInputFormat {
289 const char *name;
290 /**
291 * Descriptive name for the format, meant to be more human-readable
292 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
293 * to define it.
294 */
295 const char *long_name;
296 /** Size of private data so that it can be allocated in the wrapper. */
297 int priv_data_size;
298 /**
299 * Tell if a given file has a chance of being parsed as this format.
300 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
301 * big so you do not have to check for that unless you need more.
302 */
303 int (*read_probe)(AVProbeData *);
304 /** Read the format header and initialize the AVFormatContext
305 structure. Return 0 if OK. 'ap' if non-NULL contains
306 additional parameters. Only used in raw format right
307 now. 'av_new_stream' should be called to create new streams. */
308 int (*read_header)(struct AVFormatContext *,
309 AVFormatParameters *ap);
310 /** Read one packet and put it in 'pkt'. pts and flags are also
311 set. 'av_new_stream' can be called only if the flag
312 AVFMTCTX_NOHEADER is used.
313 @return 0 on success, < 0 on error.
314 When returning an error, pkt must not have been allocated
315 or must be freed before returning */
316 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
317 /** Close the stream. The AVFormatContext and AVStreams are not
318 freed by this function */
319 int (*read_close)(struct AVFormatContext *);
320
321 #if LIBAVFORMAT_VERSION_MAJOR < 53
322 /**
323 * Seek to a given timestamp relative to the frames in
324 * stream component stream_index.
325 * @param stream_index Must not be -1.
326 * @param flags Selects which direction should be preferred if no exact
327 * match is available.
328 * @return >= 0 on success (but not necessarily the new offset)
329 */
330 int (*read_seek)(struct AVFormatContext *,
331 int stream_index, int64_t timestamp, int flags);
332 #endif
333 /**
334 * Gets the next timestamp in stream[stream_index].time_base units.
335 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
336 */
337 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
338 int64_t *pos, int64_t pos_limit);
339 /** Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER. */
340 int flags;
341 /** If extensions are defined, then no probe is done. You should
342 usually not use extension format guessing because it is not
343 reliable enough */
344 const char *extensions;
345 /** General purpose read-only value that the format can use. */
346 int value;
347
348 /** Starts/resumes playing - only meaningful if using a network-based format
349 (RTSP). */
350 int (*read_play)(struct AVFormatContext *);
351
352 /** Pauses playing - only meaningful if using a network-based format
353 (RTSP). */
354 int (*read_pause)(struct AVFormatContext *);
355
356 const struct AVCodecTag * const *codec_tag;
357
358 /**
359 * Seeks to timestamp ts.
360 * Seeking will be done so that the point from which all active streams
361 * can be presented successfully will be closest to ts and within min/max_ts.
362 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
363 */
364 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
365
366 const AVMetadataConv *metadata_conv;
367
368 /* private fields */
369 struct AVInputFormat *next;
370 } AVInputFormat;
371
372 enum AVStreamParseType {
373 AVSTREAM_PARSE_NONE,
374 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
375 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
376 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
377 };
378
379 typedef struct AVIndexEntry {
380 int64_t pos;
381 int64_t timestamp;
382 #define AVINDEX_KEYFRAME 0x0001
383 int flags:2;
384 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).
385 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
386 } AVIndexEntry;
387
388 #define AV_DISPOSITION_DEFAULT 0x0001
389 #define AV_DISPOSITION_DUB 0x0002
390 #define AV_DISPOSITION_ORIGINAL 0x0004
391 #define AV_DISPOSITION_COMMENT 0x0008
392 #define AV_DISPOSITION_LYRICS 0x0010
393 #define AV_DISPOSITION_KARAOKE 0x0020
394
395 /**
396 * Stream structure.
397 * New fields can be added to the end with minor version bumps.
398 * Removal, reordering and changes to existing fields require a major
399 * version bump.
400 * sizeof(AVStream) must not be used outside libav*.
401 */
402 typedef struct AVStream {
403 int index; /**< stream index in AVFormatContext */
404 int id; /**< format-specific stream ID */
405 AVCodecContext *codec; /**< codec context */
406 /**
407 * Real base framerate of the stream.
408 * This is the lowest framerate with which all timestamps can be
409 * represented accurately (it is the least common multiple of all
410 * framerates in the stream). Note, this value is just a guess!
411 * For example, if the time base is 1/90000 and all frames have either
412 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
413 */
414 AVRational r_frame_rate;
415 void *priv_data;
416
417 /* internal data used in av_find_stream_info() */
418 int64_t first_dts;
419 /** encoding: pts generation when outputting stream */
420 struct AVFrac pts;
421
422 /**
423 * This is the fundamental unit of time (in seconds) in terms
424 * of which frame timestamps are represented. For fixed-fps content,
425 * time base should be 1/framerate and timestamp increments should be 1.
426 */
427 AVRational time_base;
428 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
429 /* ffmpeg.c private use */
430 int stream_copy; /**< If set, just copy stream. */
431 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
432 //FIXME move stuff to a flags field?
433 /** Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
434 * MN: dunno if that is the right place for it */
435 float quality;
436 /**
437 * Decoding: pts of the first frame of the stream, in stream time base.
438 * Only set this if you are absolutely 100% sure that the value you set
439 * it to really is the pts of the first frame.
440 * This may be undefined (AV_NOPTS_VALUE).
441 * @note The ASF header does NOT contain a correct start_time the ASF
442 * demuxer must NOT set this.
443 */
444 int64_t start_time;
445 /**
446 * Decoding: duration of the stream, in stream time base.
447 * If a source file does not specify a duration, but does specify
448 * a bitrate, this value will be estimated from bitrate and file size.
449 */
450 int64_t duration;
451
452 #if LIBAVFORMAT_VERSION_INT < (53<<16)
453 char language[4]; /** ISO 639-2/B 3-letter language code (empty string if undefined) */
454 #endif
455
456 /* av_read_frame() support */
457 enum AVStreamParseType need_parsing;
458 struct AVCodecParserContext *parser;
459
460 int64_t cur_dts;
461 int last_IP_duration;
462 int64_t last_IP_pts;
463 /* av_seek_frame() support */
464 AVIndexEntry *index_entries; /**< Only used if the format does not
465 support seeking natively. */
466 int nb_index_entries;
467 unsigned int index_entries_allocated_size;
468
469 int64_t nb_frames; ///< number of frames in this stream if known or 0
470
471 #if LIBAVFORMAT_VERSION_INT < (53<<16)
472 int64_t unused[4+1];
473
474 char *filename; /**< source filename of the stream */
475 #endif
476
477 int disposition; /**< AV_DISPOSITION_* bit field */
478
479 AVProbeData probe_data;
480 #define MAX_REORDER_DELAY 16
481 int64_t pts_buffer[MAX_REORDER_DELAY+1];
482
483 /**
484 * sample aspect ratio (0 if unknown)
485 * - encoding: Set by user.
486 * - decoding: Set by libavformat.
487 */
488 AVRational sample_aspect_ratio;
489
490 AVMetadata *metadata;
491
492 /* av_read_frame() support */
493 const uint8_t *cur_ptr;
494 int cur_len;
495 AVPacket cur_pkt;
496
497 // Timestamp generation support:
498 /**
499 * Timestamp corresponding to the last dts sync point.
500 *
501 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
502 * a DTS is received from the underlying container. Otherwise set to
503 * AV_NOPTS_VALUE by default.
504 */
505 int64_t reference_dts;
506
507 /**
508 * Number of packets to buffer for codec probing
509 * NOT PART OF PUBLIC API
510 */
511 #define MAX_PROBE_PACKETS 2500
512 int probe_packets;
513
514 /**
515 * last packet in packet_buffer for this stream when muxing.
516 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
517 */
518 struct AVPacketList *last_in_packet_buffer;
519
520 /**
521 * Average framerate
522 */
523 AVRational avg_frame_rate;
524
525 /**
526 * Number of frames that have been demuxed during av_find_stream_info()
527 */
528 int codec_info_nb_frames;
529 } AVStream;
530
531 #define AV_PROGRAM_RUNNING 1
532
533 /**
534 * New fields can be added to the end with minor version bumps.
535 * Removal, reordering and changes to existing fields require a major
536 * version bump.
537 * sizeof(AVProgram) must not be used outside libav*.
538 */
539 typedef struct AVProgram {
540 int id;
541 #if LIBAVFORMAT_VERSION_INT < (53<<16)
542 char *provider_name; ///< network name for DVB streams
543 char *name; ///< service name for DVB streams
544 #endif
545 int flags;
546 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
547 unsigned int *stream_index;
548 unsigned int nb_stream_indexes;
549 AVMetadata *metadata;
550 } AVProgram;
551
552 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
553 (streams are added dynamically) */
554
555 typedef struct AVChapter {
556 int id; ///< unique ID to identify the chapter
557 AVRational time_base; ///< time base in which the start/end timestamps are specified
558 int64_t start, end; ///< chapter start/end time in time_base units
559 #if LIBAVFORMAT_VERSION_INT < (53<<16)
560 char *title; ///< chapter title
561 #endif
562 AVMetadata *metadata;
563 } AVChapter;
564
565 #if LIBAVFORMAT_VERSION_MAJOR < 53
566 #define MAX_STREAMS 20
567 #else
568 #define MAX_STREAMS 100
569 #endif
570
571 /**
572 * Format I/O context.
573 * New fields can be added to the end with minor version bumps.
574 * Removal, reordering and changes to existing fields require a major
575 * version bump.
576 * sizeof(AVFormatContext) must not be used outside libav*.
577 */
578 typedef struct AVFormatContext {
579 const AVClass *av_class; /**< Set by avformat_alloc_context. */
580 /* Can only be iformat or oformat, not both at the same time. */
581 struct AVInputFormat *iformat;
582 struct AVOutputFormat *oformat;
583 void *priv_data;
584 ByteIOContext *pb;
585 unsigned int nb_streams;
586 AVStream *streams[MAX_STREAMS];
587 char filename[1024]; /**< input or output filename */
588 /* stream info */
589 int64_t timestamp;
590 #if LIBAVFORMAT_VERSION_INT < (53<<16)
591 char title[512];
592 char author[512];
593 char copyright[512];
594 char comment[512];
595 char album[512];
596 int year; /**< ID3 year, 0 if none */
597 int track; /**< track number, 0 if none */
598 char genre[32]; /**< ID3 genre */
599 #endif
600
601 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
602 /* private data for pts handling (do not modify directly). */
603 /** This buffer is only needed when packets were already buffered but
604 not decoded, for example to get the codec parameters in MPEG
605 streams. */
606 struct AVPacketList *packet_buffer;
607
608 /** Decoding: position of the first frame of the component, in
609 AV_TIME_BASE fractional seconds. NEVER set this value directly:
610 It is deduced from the AVStream values. */
611 int64_t start_time;
612 /** Decoding: duration of the stream, in AV_TIME_BASE fractional
613 seconds. NEVER set this value directly: it is deduced from the
614 AVStream values. */
615 int64_t duration;
616 /** decoding: total file size, 0 if unknown */
617 int64_t file_size;
618 /** Decoding: total stream bitrate in bit/s, 0 if not
619 available. Never set it directly if the file_size and the
620 duration are known as FFmpeg can compute it automatically. */
621 int bit_rate;
622
623 /* av_read_frame() support */
624 AVStream *cur_st;
625 #if LIBAVFORMAT_VERSION_INT < (53<<16)
626 const uint8_t *cur_ptr_deprecated;
627 int cur_len_deprecated;
628 AVPacket cur_pkt_deprecated;
629 #endif
630
631 /* av_seek_frame() support */
632 int64_t data_offset; /** offset of the first packet */
633 int index_built;
634
635 int mux_rate;
636 unsigned int packet_size;
637 int preload;
638 int max_delay;
639
640 #define AVFMT_NOOUTPUTLOOP -1
641 #define AVFMT_INFINITEOUTPUTLOOP 0
642 /** number of times to loop output in formats that support it */
643 int loop_output;
644
645 int flags;
646 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
647 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
648 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
649 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
650
651 int loop_input;
652 /** decoding: size of data to probe; encoding: unused. */
653 unsigned int probesize;
654
655 /**
656 * Maximum time (in AV_TIME_BASE units) during which the input should
657 * be analyzed in av_find_stream_info().
658 */
659 int max_analyze_duration;
660
661 const uint8_t *key;
662 int keylen;
663
664 unsigned int nb_programs;
665 AVProgram **programs;
666
667 /**
668 * Forced video codec_id.
669 * Demuxing: Set by user.
670 */
671 enum CodecID video_codec_id;
672 /**
673 * Forced audio codec_id.
674 * Demuxing: Set by user.
675 */
676 enum CodecID audio_codec_id;
677 /**
678 * Forced subtitle codec_id.
679 * Demuxing: Set by user.
680 */
681 enum CodecID subtitle_codec_id;
682
683 /**
684 * Maximum amount of memory in bytes to use for the index of each stream.
685 * If the index exceeds this size, entries will be discarded as
686 * needed to maintain a smaller size. This can lead to slower or less
687 * accurate seeking (depends on demuxer).
688 * Demuxers for which a full in-memory index is mandatory will ignore
689 * this.
690 * muxing : unused
691 * demuxing: set by user
692 */
693 unsigned int max_index_size;
694
695 /**
696 * Maximum amount of memory in bytes to use for buffering frames
697 * obtained from realtime capture devices.
698 */
699 unsigned int max_picture_buffer;
700
701 unsigned int nb_chapters;
702 AVChapter **chapters;
703
704 /**
705 * Flags to enable debugging.
706 */
707 int debug;
708 #define FF_FDEBUG_TS 0x0001
709
710 /**
711 * Raw packets from the demuxer, prior to parsing and decoding.
712 * This buffer is used for buffering packets until the codec can
713 * be identified, as parsing cannot be done without knowing the
714 * codec.
715 */
716 struct AVPacketList *raw_packet_buffer;
717 struct AVPacketList *raw_packet_buffer_end;
718
719 struct AVPacketList *packet_buffer_end;
720
721 AVMetadata *metadata;
722
723 /**
724 * Remaining size available for raw_packet_buffer, in bytes.
725 * NOT PART OF PUBLIC API
726 */
727 #define RAW_PACKET_BUFFER_SIZE 2500000
728 int raw_packet_buffer_remaining_size;
729
730 /**
731 * Start time of the stream in real world time, in microseconds
732 * since the unix epoch (00:00 1st January 1970). That is, pts=0
733 * in the stream was captured at this real world time.
734 * - encoding: Set by user.
735 * - decoding: Unused.
736 */
737 int64_t start_time_realtime;
738 } AVFormatContext;
739
740 typedef struct AVPacketList {
741 AVPacket pkt;
742 struct AVPacketList *next;
743 } AVPacketList;
744
745 #if LIBAVFORMAT_VERSION_INT < (53<<16)
746 extern AVInputFormat *first_iformat;
747 extern AVOutputFormat *first_oformat;
748 #endif
749
750 /**
751 * If f is NULL, returns the first registered input format,
752 * if f is non-NULL, returns the next registered input format after f
753 * or NULL if f is the last one.
754 */
755 AVInputFormat *av_iformat_next(AVInputFormat *f);
756
757 /**
758 * If f is NULL, returns the first registered output format,
759 * if f is non-NULL, returns the next registered output format after f
760 * or NULL if f is the last one.
761 */
762 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
763
764 enum CodecID av_guess_image2_codec(const char *filename);
765
766 /* XXX: Use automatic init with either ELF sections or C file parser */
767 /* modules. */
768
769 /* utils.c */
770 void av_register_input_format(AVInputFormat *format);
771 void av_register_output_format(AVOutputFormat *format);
772 #if LIBAVFORMAT_VERSION_MAJOR < 53
773 attribute_deprecated AVOutputFormat *guess_stream_format(const char *short_name,
774 const char *filename,
775 const char *mime_type);
776
777 /**
778 * @deprecated Use av_guess_format() instead.
779 */
780 attribute_deprecated AVOutputFormat *guess_format(const char *short_name,
781 const char *filename,
782 const char *mime_type);
783 #endif
784
785 /**
786 * Returns the output format in the list of registered output formats
787 * which best matches the provided parameters, or returns NULL if
788 * there is no match.
789 *
790 * @param short_name if non-NULL checks if short_name matches with the
791 * names of the registered formats
792 * @param filename if non-NULL checks if filename terminates with the
793 * extensions of the registered formats
794 * @param mime_type if non-NULL checks if mime_type matches with the
795 * MIME type of the registered formats
796 */
797 AVOutputFormat *av_guess_format(const char *short_name,
798 const char *filename,
799 const char *mime_type);
800
801 /**
802 * Guesses the codec ID based upon muxer and filename.
803 */
804 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
805 const char *filename, const char *mime_type,
806 enum CodecType type);
807
808 /**
809 * Sends a nice hexadecimal dump of a buffer to the specified file stream.
810 *
811 * @param f The file stream pointer where the dump should be sent to.
812 * @param buf buffer
813 * @param size buffer size
814 *
815 * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
816 */
817 void av_hex_dump(FILE *f, uint8_t *buf, int size);
818
819 /**
820 * Sends a nice hexadecimal dump of a buffer to the log.
821 *
822 * @param avcl A pointer to an arbitrary struct of which the first field is a
823 * pointer to an AVClass struct.
824 * @param level The importance level of the message, lower values signifying
825 * higher importance.
826 * @param buf buffer
827 * @param size buffer size
828 *
829 * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
830 */
831 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
832
833 /**
834 * Sends a nice dump of a packet to the specified file stream.
835 *
836 * @param f The file stream pointer where the dump should be sent to.
837 * @param pkt packet to dump
838 * @param dump_payload True if the payload must be displayed, too.
839 */
840 void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
841
842 /**
843 * Sends a nice dump of a packet to the log.
844 *
845 * @param avcl A pointer to an arbitrary struct of which the first field is a
846 * pointer to an AVClass struct.
847 * @param level The importance level of the message, lower values signifying
848 * higher importance.
849 * @param pkt packet to dump
850 * @param dump_payload True if the payload must be displayed, too.
851 */
852 void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
853
854 /**
855 * Initializes libavformat and registers all the muxers, demuxers and
856 * protocols. If you do not call this function, then you can select
857 * exactly which formats you want to support.
858 *
859 * @see av_register_input_format()
860 * @see av_register_output_format()
861 * @see av_register_protocol()
862 */
863 void av_register_all(void);
864
865 /** codec tag <-> codec id */
866 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
867 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
868
869 /* media file input */
870
871 /**
872 * Finds AVInputFormat based on the short name of the input format.
873 */
874 AVInputFormat *av_find_input_format(const char *short_name);
875
876 /**
877 * Guesses the file format.
878 *
879 * @param is_opened Whether the file is already opened; determines whether
880 * demuxers with or without AVFMT_NOFILE are probed.
881 */
882 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
883
884 /**
885 * Allocates all the structures needed to read an input stream.
886 * This does not open the needed codecs for decoding the stream[s].
887 */
888 int av_open_input_stream(AVFormatContext **ic_ptr,
889 ByteIOContext *pb, const char *filename,
890 AVInputFormat *fmt, AVFormatParameters *ap);
891
892 /**
893 * Opens a media file as input. The codecs are not opened. Only the file
894 * header (if present) is read.
895 *
896 * @param ic_ptr The opened media file handle is put here.
897 * @param filename filename to open
898 * @param fmt If non-NULL, force the file format to use.
899 * @param buf_size optional buffer size (zero if default is OK)
900 * @param ap Additional parameters needed when opening the file
901 * (NULL if default).
902 * @return 0 if OK, AVERROR_xxx otherwise
903 */
904 int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
905 AVInputFormat *fmt,
906 int buf_size,
907 AVFormatParameters *ap);
908
909 #if LIBAVFORMAT_VERSION_MAJOR < 53
910 /**
911 * @deprecated Use avformat_alloc_context() instead.
912 */
913 attribute_deprecated AVFormatContext *av_alloc_format_context(void);
914 #endif
915
916 /**
917 * Allocates an AVFormatContext.
918 * Can be freed with av_free() but do not forget to free everything you
919 * explicitly allocated as well!
920 */
921 AVFormatContext *avformat_alloc_context(void);
922
923 /**
924 * Reads packets of a media file to get stream information. This
925 * is useful for file formats with no headers such as MPEG. This
926 * function also computes the real framerate in case of MPEG-2 repeat
927 * frame mode.
928 * The logical file position is not changed by this function;
929 * examined packets may be buffered for later processing.
930 *
931 * @param ic media file handle
932 * @return >=0 if OK, AVERROR_xxx on error
933 * @todo Let the user decide somehow what information is needed so that
934 * we do not waste time getting stuff the user does not need.
935 */
936 int av_find_stream_info(AVFormatContext *ic);
937
938 /**
939 * Reads a transport packet from a media file.
940 *
941 * This function is obsolete and should never be used.
942 * Use av_read_frame() instead.
943 *
944 * @param s media file handle
945 * @param pkt is filled
946 * @return 0 if OK, AVERROR_xxx on error
947 */
948 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
949
950 /**
951 * Returns the next frame of a stream.
952 *
953 * The returned packet is valid
954 * until the next av_read_frame() or until av_close_input_file() and
955 * must be freed with av_free_packet. For video, the packet contains
956 * exactly one frame. For audio, it contains an integer number of
957 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
958 * data). If the audio frames have a variable size (e.g. MPEG audio),
959 * then it contains one frame.
960 *
961 * pkt->pts, pkt->dts and pkt->duration are always set to correct
962 * values in AVStream.time_base units (and guessed if the format cannot
963 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
964 * has B-frames, so it is better to rely on pkt->dts if you do not
965 * decompress the payload.
966 *
967 * @return 0 if OK, < 0 on error or end of file
968 */
969 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
970
971 /**
972 * Seeks to the keyframe at timestamp.
973 * 'timestamp' in 'stream_index'.
974 * @param stream_index If stream_index is (-1), a default
975 * stream is selected, and timestamp is automatically converted
976 * from AV_TIME_BASE units to the stream specific time_base.
977 * @param timestamp Timestamp in AVStream.time_base units
978 * or, if no stream is specified, in AV_TIME_BASE units.
979 * @param flags flags which select direction and seeking mode
980 * @return >= 0 on success
981 */
982 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
983 int flags);
984
985 /**
986 * Seeks to timestamp ts.
987 * Seeking will be done so that the point from which all active streams
988 * can be presented successfully will be closest to ts and within min/max_ts.
989 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
990 *
991 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
992 * are the file position (this may not be supported by all demuxers).
993 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
994 * in the stream with stream_index (this may not be supported by all demuxers).
995 * Otherwise all timestamps are in units of the stream selected by stream_index
996 * or if stream_index is -1, in AV_TIME_BASE units.
997 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
998 * keyframes (this may not be supported by all demuxers).
999 *
1000 * @param stream_index index of the stream which is used as time base reference
1001 * @param min_ts smallest acceptable timestamp
1002 * @param ts target timestamp
1003 * @param max_ts largest acceptable timestamp
1004 * @param flags flags
1005 * @returns >=0 on success, error code otherwise
1006 *
1007 * @NOTE This is part of the new seek API which is still under construction.
1008 * Thus do not use this yet. It may change at any time, do not expect
1009 * ABI compatibility yet!
1010 */
1011 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1012
1013 /**
1014 * Starts playing a network-based stream (e.g. RTSP stream) at the
1015 * current position.
1016 */
1017 int av_read_play(AVFormatContext *s);
1018
1019 /**
1020 * Pauses a network-based stream (e.g. RTSP stream).
1021 *
1022 * Use av_read_play() to resume it.
1023 */
1024 int av_read_pause(AVFormatContext *s);
1025
1026 /**
1027 * Frees a AVFormatContext allocated by av_open_input_stream.
1028 * @param s context to free
1029 */
1030 void av_close_input_stream(AVFormatContext *s);
1031
1032 /**
1033 * Closes a media file (but not its codecs).
1034 *
1035 * @param s media file handle
1036 */
1037 void av_close_input_file(AVFormatContext *s);
1038
1039 /**
1040 * Adds a new stream to a media file.
1041 *
1042 * Can only be called in the read_header() function. If the flag
1043 * AVFMTCTX_NOHEADER is in the format context, then new streams
1044 * can be added in read_packet too.
1045 *
1046 * @param s media file handle
1047 * @param id file-format-dependent stream ID
1048 */
1049 AVStream *av_new_stream(AVFormatContext *s, int id);
1050 AVProgram *av_new_program(AVFormatContext *s, int id);
1051
1052 /**
1053 * Adds a new chapter.
1054 * This function is NOT part of the public API
1055 * and should ONLY be used by demuxers.
1056 *
1057 * @param s media file handle
1058 * @param id unique ID for this chapter
1059 * @param start chapter start time in time_base units
1060 * @param end chapter end time in time_base units
1061 * @param title chapter title
1062 *
1063 * @return AVChapter or NULL on error
1064 */
1065 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
1066 int64_t start, int64_t end, const char *title);
1067
1068 /**
1069 * Sets the pts for a given stream.
1070 *
1071 * @param s stream
1072 * @param pts_wrap_bits number of bits effectively used by the pts
1073 * (used for wrap control, 33 is the value for MPEG)
1074 * @param pts_num numerator to convert to seconds (MPEG: 1)
1075 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1076 */
1077 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1078 unsigned int pts_num, unsigned int pts_den);
1079
1080 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1081 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1082 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1083 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1084
1085 int av_find_default_stream_index(AVFormatContext *s);
1086
1087 /**
1088 * Gets the index for a specific timestamp.
1089 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1090 * to the timestamp which is <= the requested one, if backward
1091 * is 0, then it will be >=
1092 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1093 * @return < 0 if no such timestamp could be found
1094 */
1095 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1096
1097 /**
1098 * Ensures the index uses less memory than the maximum specified in
1099 * AVFormatContext.max_index_size by discarding entries if it grows
1100 * too large.
1101 * This function is not part of the public API and should only be called
1102 * by demuxers.
1103 */
1104 void ff_reduce_index(AVFormatContext *s, int stream_index);
1105
1106 /**
1107 * Adds an index entry into a sorted list. Updates the entry if the list
1108 * already contains it.
1109 *
1110 * @param timestamp timestamp in the time base of the given stream
1111 */
1112 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1113 int size, int distance, int flags);
1114
1115 /**
1116 * Does a binary search using av_index_search_timestamp() and
1117 * AVCodec.read_timestamp().
1118 * This is not supposed to be called directly by a user application,
1119 * but by demuxers.
1120 * @param target_ts target timestamp in the time base of the given stream
1121 * @param stream_index stream number
1122 */
1123 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1124 int64_t target_ts, int flags);
1125
1126 /**
1127 * Updates cur_dts of all streams based on the given timestamp and AVStream.
1128 *
1129 * Stream ref_st unchanged, others set cur_dts in their native time base.
1130 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1131 * @param timestamp new dts expressed in time_base of param ref_st
1132 * @param ref_st reference stream giving time_base of param timestamp
1133 */
1134 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1135
1136 /**
1137 * Does a binary search using read_timestamp().
1138 * This is not supposed to be called directly by a user application,
1139 * but by demuxers.
1140 * @param target_ts target timestamp in the time base of the given stream
1141 * @param stream_index stream number
1142 */
1143 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1144 int64_t target_ts, int64_t pos_min,
1145 int64_t pos_max, int64_t pos_limit,
1146 int64_t ts_min, int64_t ts_max,
1147 int flags, int64_t *ts_ret,
1148 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1149
1150 /** media file output */
1151 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1152
1153 /**
1154 * Allocates the stream private data and writes the stream header to an
1155 * output media file.
1156 *
1157 * @param s media file handle
1158 * @return 0 if OK, AVERROR_xxx on error
1159 */
1160 int av_write_header(AVFormatContext *s);
1161
1162 /**
1163 * Writes a packet to an output media file.
1164 *
1165 * The packet shall contain one audio or video frame.
1166 * The packet must be correctly interleaved according to the container
1167 * specification, if not then av_interleaved_write_frame must be used.
1168 *
1169 * @param s media file handle
1170 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1171 dts/pts, ...
1172 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1173 */
1174 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1175
1176 /**
1177 * Writes a packet to an output media file ensuring correct interleaving.
1178 *
1179 * The packet must contain one audio or video frame.
1180 * If the packets are already correctly interleaved, the application should
1181 * call av_write_frame() instead as it is slightly faster. It is also important
1182 * to keep in mind that completely non-interleaved input will need huge amounts
1183 * of memory to interleave with this, so it is preferable to interleave at the
1184 * demuxer level.
1185 *
1186 * @param s media file handle
1187 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1188 dts/pts, ...
1189 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1190 */
1191 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1192
1193 /**
1194 * Interleaves a packet per dts in an output media file.
1195 *
1196 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1197 * function, so they cannot be used after it. Note that calling av_free_packet()
1198 * on them is still safe.
1199 *
1200 * @param s media file handle
1201 * @param out the interleaved packet will be output here
1202 * @param in the input packet
1203 * @param flush 1 if no further packets are available as input and all
1204 * remaining packets should be output
1205 * @return 1 if a packet was output, 0 if no packet could be output,
1206 * < 0 if an error occurred
1207 */
1208 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1209 AVPacket *pkt, int flush);
1210
1211 /**
1212 * Writes the stream trailer to an output media file and frees the
1213 * file private data.
1214 *
1215 * May only be called after a successful call to av_write_header.
1216 *
1217 * @param s media file handle
1218 * @return 0 if OK, AVERROR_xxx on error
1219 */
1220 int av_write_trailer(AVFormatContext *s);
1221
1222 void dump_format(AVFormatContext *ic,
1223 int index,
1224 const char *url,
1225 int is_output);
1226
1227 #if LIBAVFORMAT_VERSION_MAJOR < 53
1228 /**
1229 * Parses width and height out of string str.
1230 * @deprecated Use av_parse_video_frame_size instead.
1231 */
1232 attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr,
1233 const char *str);
1234
1235 /**
1236 * Converts framerate from a string to a fraction.
1237 * @deprecated Use av_parse_video_frame_rate instead.
1238 */
1239 attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base,
1240 const char *arg);
1241 #endif
1242
1243 /**
1244 * Parses datestr and returns a corresponding number of microseconds.
1245 * @param datestr String representing a date or a duration.
1246 * - If a date the syntax is:
1247 * @code
1248 * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
1249 * @endcode
1250 * Time is local time unless Z is appended, in which case it is
1251 * interpreted as UTC.
1252 * If the year-month-day part is not specified it takes the current
1253 * year-month-day.
1254 * Returns the number of microseconds since 1st of January, 1970 up to
1255 * the time of the parsed date or INT64_MIN if datestr cannot be
1256 * successfully parsed.
1257 * - If a duration the syntax is:
1258 * @code
1259 * [-]HH[:MM[:SS[.m...]]]
1260 * [-]S+[.m...]
1261 * @endcode
1262 * Returns the number of microseconds contained in a time interval
1263 * with the specified duration or INT64_MIN if datestr cannot be
1264 * successfully parsed.
1265 * @param duration Flag which tells how to interpret datestr, if
1266 * not zero datestr is interpreted as a duration, otherwise as a
1267 * date.
1268 */
1269 int64_t parse_date(const char *datestr, int duration);
1270
1271 /** Gets the current time in microseconds. */
1272 int64_t av_gettime(void);
1273
1274 /* ffm-specific for ffserver */
1275 #define FFM_PACKET_SIZE 4096
1276 int64_t ffm_read_write_index(int fd);
1277 int ffm_write_write_index(int fd, int64_t pos);
1278 void ffm_set_write_index(AVFormatContext *s, int64_t pos, int64_t file_size);
1279
1280 /**
1281 * Attempts to find a specific tag in a URL.
1282 *
1283 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
1284 * Return 1 if found.
1285 */
1286 int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1287
1288 /**
1289 * Returns in 'buf' the path with '%d' replaced by a number.
1290 *
1291 * Also handles the '%0nd' format where 'n' is the total number
1292 * of digits and '%%'.
1293 *
1294 * @param buf destination buffer
1295 * @param buf_size destination buffer size
1296 * @param path numbered sequence string
1297 * @param number frame number
1298 * @return 0 if OK, -1 on format error
1299 */
1300 int av_get_frame_filename(char *buf, int buf_size,
1301 const char *path, int number);
1302
1303 /**
1304 * Checks whether filename actually is a numbered sequence generator.
1305 *
1306 * @param filename possible numbered sequence string
1307 * @return 1 if a valid numbered sequence string, 0 otherwise
1308 */
1309 int av_filename_number_test(const char *filename);
1310
1311 /**
1312 * Generates an SDP for an RTP session.
1313 *
1314 * @param ac array of AVFormatContexts describing the RTP streams. If the
1315 * array is composed by only one context, such context can contain
1316 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1317 * all the contexts in the array (an AVCodecContext per RTP stream)
1318 * must contain only one AVStream.
1319 * @param n_files number of AVCodecContexts contained in ac
1320 * @param buff buffer where the SDP will be stored (must be allocated by
1321 * the caller)
1322 * @param size the size of the buffer
1323 * @return 0 if OK, AVERROR_xxx on error
1324 */
1325 int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1326
1327 #ifdef HAVE_AV_CONFIG_H
1328
1329 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
1330
1331 #ifdef __GNUC__
1332 #define dynarray_add(tab, nb_ptr, elem)\
1333 do {\
1334 __typeof__(tab) _tab = (tab);\
1335 __typeof__(elem) _elem = (elem);\
1336 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
1337 ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
1338 } while(0)
1339 #else
1340 #define dynarray_add(tab, nb_ptr, elem)\
1341 do {\
1342 ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
1343 } while(0)
1344 #endif
1345
1346 time_t mktimegm(struct tm *tm);
1347 struct tm *brktimegm(time_t secs, struct tm *tm);
1348 const char *small_strptime(const char *p, const char *fmt,
1349 struct tm *dt);
1350
1351 /**
1352 * Returns a positive value if the given filename has one of the given
1353 * extensions, 0 otherwise.
1354 *
1355 * @param extensions a comma-separated list of filename extensions
1356 */
1357 int av_match_ext(const char *filename, const char *extensions);
1358
1359 #endif /* HAVE_AV_CONFIG_H */
1360
1361 #endif /* AVFORMAT_AVFORMAT_H */