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