Deprecate av_open_input_* and remove their uses.
[libav.git] / libavformat / avformat.h
1 /*
2 * copyright (c) 2001 Fabrice Bellard
3 *
4 * This file is part of Libav.
5 *
6 * Libav 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 * Libav 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 Libav; 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
25 /**
26 * Return the LIBAVFORMAT_VERSION_INT constant.
27 */
28 unsigned avformat_version(void);
29
30 /**
31 * Return the libavformat build-time configuration.
32 */
33 const char *avformat_configuration(void);
34
35 /**
36 * Return the libavformat license.
37 */
38 const char *avformat_license(void);
39
40 #include <time.h>
41 #include <stdio.h> /* FILE */
42 #include "libavcodec/avcodec.h"
43 #include "libavutil/dict.h"
44
45 #include "avio.h"
46 #include "libavformat/version.h"
47
48 struct AVFormatContext;
49
50
51 /*
52 * Public Metadata API.
53 * The metadata API allows libavformat to export metadata tags to a client
54 * application using a sequence of key/value pairs. Like all strings in Libav,
55 * metadata must be stored as UTF-8 encoded Unicode. Note that metadata
56 * exported by demuxers isn't checked to be valid UTF-8 in most cases.
57 * Important concepts to keep in mind:
58 * 1. Keys are unique; there can never be 2 tags with the same key. This is
59 * also meant semantically, i.e., a demuxer should not knowingly produce
60 * several keys that are literally different but semantically identical.
61 * E.g., key=Author5, key=Author6. In this example, all authors must be
62 * placed in the same tag.
63 * 2. Metadata is flat, not hierarchical; there are no subtags. If you
64 * want to store, e.g., the email address of the child of producer Alice
65 * and actor Bob, that could have key=alice_and_bobs_childs_email_address.
66 * 3. Several modifiers can be applied to the tag name. This is done by
67 * appending a dash character ('-') and the modifier name in the order
68 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng.
69 * a) language -- a tag whose value is localized for a particular language
70 * is appended with the ISO 639-2/B 3-letter language code.
71 * For example: Author-ger=Michael, Author-eng=Mike
72 * The original/default language is in the unqualified "Author" tag.
73 * A demuxer should set a default if it sets any translated tag.
74 * b) sorting -- a modified version of a tag that should be used for
75 * sorting will have '-sort' appended. E.g. artist="The Beatles",
76 * artist-sort="Beatles, The".
77 *
78 * 4. Demuxers attempt to export metadata in a generic format, however tags
79 * with no generic equivalents are left as they are stored in the container.
80 * Follows a list of generic tag names:
81 *
82 * album -- name of the set this work belongs to
83 * album_artist -- main creator of the set/album, if different from artist.
84 * e.g. "Various Artists" for compilation albums.
85 * artist -- main creator of the work
86 * comment -- any additional description of the file.
87 * composer -- who composed the work, if different from artist.
88 * copyright -- name of copyright holder.
89 * creation_time-- date when the file was created, preferably in ISO 8601.
90 * date -- date when the work was created, preferably in ISO 8601.
91 * disc -- number of a subset, e.g. disc in a multi-disc collection.
92 * encoder -- name/settings of the software/hardware that produced the file.
93 * encoded_by -- person/group who created the file.
94 * filename -- original name of the file.
95 * genre -- <self-evident>.
96 * language -- main language in which the work is performed, preferably
97 * in ISO 639-2 format. Multiple languages can be specified by
98 * separating them with commas.
99 * performer -- artist who performed the work, if different from artist.
100 * E.g for "Also sprach Zarathustra", artist would be "Richard
101 * Strauss" and performer "London Philharmonic Orchestra".
102 * publisher -- name of the label/publisher.
103 * service_name -- name of the service in broadcasting (channel name).
104 * service_provider -- name of the service provider in broadcasting.
105 * title -- name of the work.
106 * track -- number of this work in the set, can be in form current/total.
107 * variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of
108 */
109
110 #if FF_API_OLD_METADATA2
111 /**
112 * @defgroup old_metadata Old metadata API
113 * The following functions are deprecated, use
114 * their equivalents from libavutil/dict.h instead.
115 * @{
116 */
117
118 #define AV_METADATA_MATCH_CASE AV_DICT_MATCH_CASE
119 #define AV_METADATA_IGNORE_SUFFIX AV_DICT_IGNORE_SUFFIX
120 #define AV_METADATA_DONT_STRDUP_KEY AV_DICT_DONT_STRDUP_KEY
121 #define AV_METADATA_DONT_STRDUP_VAL AV_DICT_DONT_STRDUP_VAL
122 #define AV_METADATA_DONT_OVERWRITE AV_DICT_DONT_OVERWRITE
123
124 typedef attribute_deprecated AVDictionary AVMetadata;
125 typedef attribute_deprecated AVDictionaryEntry AVMetadataTag;
126
127 typedef struct AVMetadataConv AVMetadataConv;
128
129 /**
130 * Get a metadata element with matching key.
131 *
132 * @param prev Set to the previous matching element to find the next.
133 * If set to NULL the first matching element is returned.
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 attribute_deprecated AVDictionaryEntry *
138 av_metadata_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags);
139
140 /**
141 * Set the given tag in *pm, overwriting an existing tag.
142 *
143 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
144 * a metadata struct is allocated and put in *pm.
145 * @param key tag key to add to *pm (will be av_strduped depending on flags)
146 * @param value tag value to add to *pm (will be av_strduped depending on flags).
147 * Passing a NULL value will cause an existing tag to be deleted.
148 * @return >= 0 on success otherwise an error code <0
149 */
150 attribute_deprecated int av_metadata_set2(AVDictionary **pm, const char *key, const char *value, int flags);
151
152 /**
153 * This function is provided for compatibility reason and currently does nothing.
154 */
155 attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv,
156 const AVMetadataConv *s_conv);
157
158 /**
159 * Copy metadata from one AVDictionary struct into another.
160 * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,
161 * this function will allocate a struct for you and put it in *dst
162 * @param src pointer to source AVDictionary struct
163 * @param flags flags to use when setting metadata in *dst
164 * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag
165 */
166 attribute_deprecated void av_metadata_copy(AVDictionary **dst, AVDictionary *src, int flags);
167
168 /**
169 * Free all the memory allocated for an AVDictionary struct.
170 */
171 attribute_deprecated void av_metadata_free(AVDictionary **m);
172 /**
173 * @}
174 */
175 #endif
176
177
178 /* packet functions */
179
180
181 /**
182 * Allocate and read the payload of a packet and initialize its
183 * fields with default values.
184 *
185 * @param pkt packet
186 * @param size desired payload size
187 * @return >0 (read size) if OK, AVERROR_xxx otherwise
188 */
189 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size);
190
191
192 /**
193 * Read data and append it to the current content of the AVPacket.
194 * If pkt->size is 0 this is identical to av_get_packet.
195 * Note that this uses av_grow_packet and thus involves a realloc
196 * which is inefficient. Thus this function should only be used
197 * when there is no reasonable way to know (an upper bound of)
198 * the final size.
199 *
200 * @param pkt packet
201 * @param size amount of data to read
202 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data
203 * will not be lost even if an error occurs.
204 */
205 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size);
206
207 /*************************************************/
208 /* fractional numbers for exact pts handling */
209
210 /**
211 * The exact value of the fractional number is: 'val + num / den'.
212 * num is assumed to be 0 <= num < den.
213 */
214 typedef struct AVFrac {
215 int64_t val, num, den;
216 } AVFrac;
217
218 /*************************************************/
219 /* input/output formats */
220
221 struct AVCodecTag;
222
223 /**
224 * This structure contains the data a format has to probe a file.
225 */
226 typedef struct AVProbeData {
227 const char *filename;
228 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */
229 int buf_size; /**< Size of buf except extra allocated bytes */
230 } AVProbeData;
231
232 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection
233 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
234
235 typedef struct AVFormatParameters {
236 #if FF_API_FORMAT_PARAMETERS
237 attribute_deprecated AVRational time_base;
238 attribute_deprecated int sample_rate;
239 attribute_deprecated int channels;
240 attribute_deprecated int width;
241 attribute_deprecated int height;
242 attribute_deprecated enum PixelFormat pix_fmt;
243 attribute_deprecated int channel; /**< Used to select DV channel. */
244 attribute_deprecated const char *standard; /**< deprecated, use demuxer-specific options instead. */
245 attribute_deprecated unsigned int mpeg2ts_raw:1; /**< deprecated, use mpegtsraw demuxer */
246 /**< deprecated, use mpegtsraw demuxer-specific options instead */
247 attribute_deprecated unsigned int mpeg2ts_compute_pcr:1;
248 attribute_deprecated unsigned int initial_pause:1; /**< Do not begin to play the stream
249 immediately (RTSP only). */
250 attribute_deprecated unsigned int prealloced_context:1;
251 #endif
252 } AVFormatParameters;
253
254 //! Demuxer will use avio_open, no opened file should be provided by the caller.
255 #define AVFMT_NOFILE 0x0001
256 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */
257 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */
258 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for
259 raw picture data. */
260 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */
261 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */
262 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */
263 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */
264 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */
265 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */
266 #define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */
267 #define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */
268 #define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fallback to generic search */
269
270 typedef struct AVOutputFormat {
271 const char *name;
272 /**
273 * Descriptive name for the format, meant to be more human-readable
274 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
275 * to define it.
276 */
277 const char *long_name;
278 const char *mime_type;
279 const char *extensions; /**< comma-separated filename extensions */
280 /**
281 * size of private data so that it can be allocated in the wrapper
282 */
283 int priv_data_size;
284 /* output support */
285 enum CodecID audio_codec; /**< default audio codec */
286 enum CodecID video_codec; /**< default video codec */
287 int (*write_header)(struct AVFormatContext *);
288 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
289 int (*write_trailer)(struct AVFormatContext *);
290 /**
291 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE,
292 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS,
293 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS
294 */
295 int flags;
296 /**
297 * Currently only used to set pixel format if not YUV420P.
298 */
299 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
300 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
301 AVPacket *in, int flush);
302
303 /**
304 * List of supported codec_id-codec_tag pairs, ordered by "better
305 * choice first". The arrays are all terminated by CODEC_ID_NONE.
306 */
307 const struct AVCodecTag * const *codec_tag;
308
309 enum CodecID subtitle_codec; /**< default subtitle codec */
310
311 #if FF_API_OLD_METADATA2
312 const AVMetadataConv *metadata_conv;
313 #endif
314
315 const AVClass *priv_class; ///< AVClass for the private context
316
317 /* private fields */
318 struct AVOutputFormat *next;
319 } AVOutputFormat;
320
321 typedef struct AVInputFormat {
322 /**
323 * A comma separated list of short names for the format. New names
324 * may be appended with a minor bump.
325 */
326 const char *name;
327
328 /**
329 * Descriptive name for the format, meant to be more human-readable
330 * than name. You should use the NULL_IF_CONFIG_SMALL() macro
331 * to define it.
332 */
333 const char *long_name;
334
335 /**
336 * Size of private data so that it can be allocated in the wrapper.
337 */
338 int priv_data_size;
339
340 /**
341 * Tell if a given file has a chance of being parsed as this format.
342 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
343 * big so you do not have to check for that unless you need more.
344 */
345 int (*read_probe)(AVProbeData *);
346
347 /**
348 * Read the format header and initialize the AVFormatContext
349 * structure. Return 0 if OK. 'ap' if non-NULL contains
350 * additional parameters. Only used in raw format right
351 * now. 'av_new_stream' should be called to create new streams.
352 */
353 int (*read_header)(struct AVFormatContext *,
354 AVFormatParameters *ap);
355
356 /**
357 * Read one packet and put it in 'pkt'. pts and flags are also
358 * set. 'av_new_stream' can be called only if the flag
359 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
360 * background thread).
361 * @return 0 on success, < 0 on error.
362 * When returning an error, pkt must not have been allocated
363 * or must be freed before returning
364 */
365 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
366
367 /**
368 * Close the stream. The AVFormatContext and AVStreams are not
369 * freed by this function
370 */
371 int (*read_close)(struct AVFormatContext *);
372
373 #if FF_API_READ_SEEK
374 /**
375 * Seek to a given timestamp relative to the frames in
376 * stream component stream_index.
377 * @param stream_index Must not be -1.
378 * @param flags Selects which direction should be preferred if no exact
379 * match is available.
380 * @return >= 0 on success (but not necessarily the new offset)
381 */
382 attribute_deprecated int (*read_seek)(struct AVFormatContext *,
383 int stream_index, int64_t timestamp, int flags);
384 #endif
385 /**
386 * Gets the next timestamp in stream[stream_index].time_base units.
387 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
388 */
389 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
390 int64_t *pos, int64_t pos_limit);
391
392 /**
393 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER.
394 */
395 int flags;
396
397 /**
398 * If extensions are defined, then no probe is done. You should
399 * usually not use extension format guessing because it is not
400 * reliable enough
401 */
402 const char *extensions;
403
404 /**
405 * General purpose read-only value that the format can use.
406 */
407 int value;
408
409 /**
410 * Start/resume playing - only meaningful if using a network-based format
411 * (RTSP).
412 */
413 int (*read_play)(struct AVFormatContext *);
414
415 /**
416 * Pause playing - only meaningful if using a network-based format
417 * (RTSP).
418 */
419 int (*read_pause)(struct AVFormatContext *);
420
421 const struct AVCodecTag * const *codec_tag;
422
423 /**
424 * Seek to timestamp ts.
425 * Seeking will be done so that the point from which all active streams
426 * can be presented successfully will be closest to ts and within min/max_ts.
427 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
428 */
429 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
430
431 #if FF_API_OLD_METADATA2
432 const AVMetadataConv *metadata_conv;
433 #endif
434
435 const AVClass *priv_class; ///< AVClass for the private context
436
437 /* private fields */
438 struct AVInputFormat *next;
439 } AVInputFormat;
440
441 enum AVStreamParseType {
442 AVSTREAM_PARSE_NONE,
443 AVSTREAM_PARSE_FULL, /**< full parsing and repack */
444 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */
445 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */
446 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */
447 };
448
449 typedef struct AVIndexEntry {
450 int64_t pos;
451 int64_t timestamp;
452 #define AVINDEX_KEYFRAME 0x0001
453 int flags:2;
454 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).
455 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */
456 } AVIndexEntry;
457
458 #define AV_DISPOSITION_DEFAULT 0x0001
459 #define AV_DISPOSITION_DUB 0x0002
460 #define AV_DISPOSITION_ORIGINAL 0x0004
461 #define AV_DISPOSITION_COMMENT 0x0008
462 #define AV_DISPOSITION_LYRICS 0x0010
463 #define AV_DISPOSITION_KARAOKE 0x0020
464
465 /**
466 * Track should be used during playback by default.
467 * Useful for subtitle track that should be displayed
468 * even when user did not explicitly ask for subtitles.
469 */
470 #define AV_DISPOSITION_FORCED 0x0040
471 #define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */
472 #define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */
473 #define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */
474
475 /**
476 * Stream structure.
477 * New fields can be added to the end with minor version bumps.
478 * Removal, reordering and changes to existing fields require a major
479 * version bump.
480 * sizeof(AVStream) must not be used outside libav*.
481 */
482 typedef struct AVStream {
483 int index; /**< stream index in AVFormatContext */
484 int id; /**< format-specific stream ID */
485 AVCodecContext *codec; /**< codec context */
486 /**
487 * Real base framerate of the stream.
488 * This is the lowest framerate with which all timestamps can be
489 * represented accurately (it is the least common multiple of all
490 * framerates in the stream). Note, this value is just a guess!
491 * For example, if the time base is 1/90000 and all frames have either
492 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1.
493 */
494 AVRational r_frame_rate;
495 void *priv_data;
496
497 /* internal data used in av_find_stream_info() */
498 int64_t first_dts;
499
500 /**
501 * encoding: pts generation when outputting stream
502 */
503 struct AVFrac pts;
504
505 /**
506 * This is the fundamental unit of time (in seconds) in terms
507 * of which frame timestamps are represented. For fixed-fps content,
508 * time base should be 1/framerate and timestamp increments should be 1.
509 * decoding: set by libavformat
510 * encoding: set by libavformat in av_write_header
511 */
512 AVRational time_base;
513 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
514 /* ffmpeg.c private use */
515 int stream_copy; /**< If set, just copy stream. */
516 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed.
517
518 //FIXME move stuff to a flags field?
519 /**
520 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame.
521 * MN: dunno if that is the right place for it
522 */
523 float quality;
524
525 /**
526 * Decoding: pts of the first frame of the stream, in stream time base.
527 * Only set this if you are absolutely 100% sure that the value you set
528 * it to really is the pts of the first frame.
529 * This may be undefined (AV_NOPTS_VALUE).
530 */
531 int64_t start_time;
532
533 /**
534 * Decoding: duration of the stream, in stream time base.
535 * If a source file does not specify a duration, but does specify
536 * a bitrate, this value will be estimated from bitrate and file size.
537 */
538 int64_t duration;
539
540 /* av_read_frame() support */
541 enum AVStreamParseType need_parsing;
542 struct AVCodecParserContext *parser;
543
544 int64_t cur_dts;
545 int last_IP_duration;
546 int64_t last_IP_pts;
547 /* av_seek_frame() support */
548 AVIndexEntry *index_entries; /**< Only used if the format does not
549 support seeking natively. */
550 int nb_index_entries;
551 unsigned int index_entries_allocated_size;
552
553 int64_t nb_frames; ///< number of frames in this stream if known or 0
554
555 int disposition; /**< AV_DISPOSITION_* bit field */
556
557 AVProbeData probe_data;
558 #define MAX_REORDER_DELAY 16
559 int64_t pts_buffer[MAX_REORDER_DELAY+1];
560
561 /**
562 * sample aspect ratio (0 if unknown)
563 * - encoding: Set by user.
564 * - decoding: Set by libavformat.
565 */
566 AVRational sample_aspect_ratio;
567
568 AVDictionary *metadata;
569
570 /* Intended mostly for av_read_frame() support. Not supposed to be used by */
571 /* external applications; try to use something else if at all possible. */
572 const uint8_t *cur_ptr;
573 int cur_len;
574 AVPacket cur_pkt;
575
576 // Timestamp generation support:
577 /**
578 * Timestamp corresponding to the last dts sync point.
579 *
580 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and
581 * a DTS is received from the underlying container. Otherwise set to
582 * AV_NOPTS_VALUE by default.
583 */
584 int64_t reference_dts;
585
586 /**
587 * Number of packets to buffer for codec probing
588 * NOT PART OF PUBLIC API
589 */
590 #define MAX_PROBE_PACKETS 2500
591 int probe_packets;
592
593 /**
594 * last packet in packet_buffer for this stream when muxing.
595 * used internally, NOT PART OF PUBLIC API, dont read or write from outside of libav*
596 */
597 struct AVPacketList *last_in_packet_buffer;
598
599 /**
600 * Average framerate
601 */
602 AVRational avg_frame_rate;
603
604 /**
605 * Number of frames that have been demuxed during av_find_stream_info()
606 */
607 int codec_info_nb_frames;
608
609 /**
610 * Stream informations used internally by av_find_stream_info()
611 */
612 #define MAX_STD_TIMEBASES (60*12+5)
613 struct {
614 int64_t last_dts;
615 int64_t duration_gcd;
616 int duration_count;
617 double duration_error[MAX_STD_TIMEBASES];
618 int64_t codec_info_duration;
619 } *info;
620 } AVStream;
621
622 #define AV_PROGRAM_RUNNING 1
623
624 /**
625 * New fields can be added to the end with minor version bumps.
626 * Removal, reordering and changes to existing fields require a major
627 * version bump.
628 * sizeof(AVProgram) must not be used outside libav*.
629 */
630 typedef struct AVProgram {
631 int id;
632 int flags;
633 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
634 unsigned int *stream_index;
635 unsigned int nb_stream_indexes;
636 AVDictionary *metadata;
637 } AVProgram;
638
639 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
640 (streams are added dynamically) */
641
642 typedef struct AVChapter {
643 int id; ///< unique ID to identify the chapter
644 AVRational time_base; ///< time base in which the start/end timestamps are specified
645 int64_t start, end; ///< chapter start/end time in time_base units
646 AVDictionary *metadata;
647 } AVChapter;
648
649 /**
650 * Format I/O context.
651 * New fields can be added to the end with minor version bumps.
652 * Removal, reordering and changes to existing fields require a major
653 * version bump.
654 * sizeof(AVFormatContext) must not be used outside libav*.
655 */
656 typedef struct AVFormatContext {
657 const AVClass *av_class; /**< Set by avformat_alloc_context. */
658 /* Can only be iformat or oformat, not both at the same time. */
659 struct AVInputFormat *iformat;
660 struct AVOutputFormat *oformat;
661 void *priv_data;
662 AVIOContext *pb;
663 unsigned int nb_streams;
664 AVStream **streams;
665 char filename[1024]; /**< input or output filename */
666 /* stream info */
667 int64_t timestamp;
668
669 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
670 /* private data for pts handling (do not modify directly). */
671 /**
672 * This buffer is only needed when packets were already buffered but
673 * not decoded, for example to get the codec parameters in MPEG
674 * streams.
675 */
676 struct AVPacketList *packet_buffer;
677
678 /**
679 * Decoding: position of the first frame of the component, in
680 * AV_TIME_BASE fractional seconds. NEVER set this value directly:
681 * It is deduced from the AVStream values.
682 */
683 int64_t start_time;
684
685 /**
686 * Decoding: duration of the stream, in AV_TIME_BASE fractional
687 * seconds. Only set this value if you know none of the individual stream
688 * durations and also dont set any of them. This is deduced from the
689 * AVStream values if not set.
690 */
691 int64_t duration;
692
693 /**
694 * decoding: total file size, 0 if unknown
695 */
696 int64_t file_size;
697
698 /**
699 * Decoding: total stream bitrate in bit/s, 0 if not
700 * available. Never set it directly if the file_size and the
701 * duration are known as Libav can compute it automatically.
702 */
703 int bit_rate;
704
705 /* av_read_frame() support */
706 AVStream *cur_st;
707
708 /* av_seek_frame() support */
709 int64_t data_offset; /**< offset of the first packet */
710
711 int mux_rate;
712 unsigned int packet_size;
713 int preload;
714 int max_delay;
715
716 #define AVFMT_NOOUTPUTLOOP -1
717 #define AVFMT_INFINITEOUTPUTLOOP 0
718 /**
719 * number of times to loop output in formats that support it
720 */
721 int loop_output;
722
723 int flags;
724 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames.
725 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index.
726 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input.
727 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS
728 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container
729 #define AVFMT_FLAG_NOPARSE 0x0020 ///< Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the fillin code works on frames and no parsing -> no frames. Also seeking to frames can not work if parsing to find frame boundaries has been disabled
730 #if FF_API_FLAG_RTP_HINT
731 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead
732 #endif
733 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it.
734
735 int loop_input;
736
737 /**
738 * decoding: size of data to probe; encoding: unused.
739 */
740 unsigned int probesize;
741
742 /**
743 * Maximum time (in AV_TIME_BASE units) during which the input should
744 * be analyzed in av_find_stream_info().
745 */
746 int max_analyze_duration;
747
748 const uint8_t *key;
749 int keylen;
750
751 unsigned int nb_programs;
752 AVProgram **programs;
753
754 /**
755 * Forced video codec_id.
756 * Demuxing: Set by user.
757 */
758 enum CodecID video_codec_id;
759
760 /**
761 * Forced audio codec_id.
762 * Demuxing: Set by user.
763 */
764 enum CodecID audio_codec_id;
765
766 /**
767 * Forced subtitle codec_id.
768 * Demuxing: Set by user.
769 */
770 enum CodecID subtitle_codec_id;
771
772 /**
773 * Maximum amount of memory in bytes to use for the index of each stream.
774 * If the index exceeds this size, entries will be discarded as
775 * needed to maintain a smaller size. This can lead to slower or less
776 * accurate seeking (depends on demuxer).
777 * Demuxers for which a full in-memory index is mandatory will ignore
778 * this.
779 * muxing : unused
780 * demuxing: set by user
781 */
782 unsigned int max_index_size;
783
784 /**
785 * Maximum amount of memory in bytes to use for buffering frames
786 * obtained from realtime capture devices.
787 */
788 unsigned int max_picture_buffer;
789
790 unsigned int nb_chapters;
791 AVChapter **chapters;
792
793 /**
794 * Flags to enable debugging.
795 */
796 int debug;
797 #define FF_FDEBUG_TS 0x0001
798
799 /**
800 * Raw packets from the demuxer, prior to parsing and decoding.
801 * This buffer is used for buffering packets until the codec can
802 * be identified, as parsing cannot be done without knowing the
803 * codec.
804 */
805 struct AVPacketList *raw_packet_buffer;
806 struct AVPacketList *raw_packet_buffer_end;
807
808 struct AVPacketList *packet_buffer_end;
809
810 AVDictionary *metadata;
811
812 /**
813 * Remaining size available for raw_packet_buffer, in bytes.
814 * NOT PART OF PUBLIC API
815 */
816 #define RAW_PACKET_BUFFER_SIZE 2500000
817 int raw_packet_buffer_remaining_size;
818
819 /**
820 * Start time of the stream in real world time, in microseconds
821 * since the unix epoch (00:00 1st January 1970). That is, pts=0
822 * in the stream was captured at this real world time.
823 * - encoding: Set by user.
824 * - decoding: Unused.
825 */
826 int64_t start_time_realtime;
827
828 /**
829 * decoding: number of frames used to probe fps
830 */
831 int fps_probe_size;
832 } AVFormatContext;
833
834 typedef struct AVPacketList {
835 AVPacket pkt;
836 struct AVPacketList *next;
837 } AVPacketList;
838
839 /**
840 * If f is NULL, returns the first registered input format,
841 * if f is non-NULL, returns the next registered input format after f
842 * or NULL if f is the last one.
843 */
844 AVInputFormat *av_iformat_next(AVInputFormat *f);
845
846 /**
847 * If f is NULL, returns the first registered output format,
848 * if f is non-NULL, returns the next registered output format after f
849 * or NULL if f is the last one.
850 */
851 AVOutputFormat *av_oformat_next(AVOutputFormat *f);
852
853 #if FF_API_GUESS_IMG2_CODEC
854 attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename);
855 #endif
856
857 /* XXX: Use automatic init with either ELF sections or C file parser */
858 /* modules. */
859
860 /* utils.c */
861 void av_register_input_format(AVInputFormat *format);
862 void av_register_output_format(AVOutputFormat *format);
863
864 /**
865 * Return the output format in the list of registered output formats
866 * which best matches the provided parameters, or return NULL if
867 * there is no match.
868 *
869 * @param short_name if non-NULL checks if short_name matches with the
870 * names of the registered formats
871 * @param filename if non-NULL checks if filename terminates with the
872 * extensions of the registered formats
873 * @param mime_type if non-NULL checks if mime_type matches with the
874 * MIME type of the registered formats
875 */
876 AVOutputFormat *av_guess_format(const char *short_name,
877 const char *filename,
878 const char *mime_type);
879
880 /**
881 * Guess the codec ID based upon muxer and filename.
882 */
883 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
884 const char *filename, const char *mime_type,
885 enum AVMediaType type);
886
887 /**
888 * Send a nice hexadecimal dump of a buffer to the specified file stream.
889 *
890 * @param f The file stream pointer where the dump should be sent to.
891 * @param buf buffer
892 * @param size buffer size
893 *
894 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2
895 */
896 void av_hex_dump(FILE *f, uint8_t *buf, int size);
897
898 /**
899 * Send a nice hexadecimal dump of a buffer to the log.
900 *
901 * @param avcl A pointer to an arbitrary struct of which the first field is a
902 * pointer to an AVClass struct.
903 * @param level The importance level of the message, lower values signifying
904 * higher importance.
905 * @param buf buffer
906 * @param size buffer size
907 *
908 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2
909 */
910 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
911
912 /**
913 * Send a nice dump of a packet to the specified file stream.
914 *
915 * @param f The file stream pointer where the dump should be sent to.
916 * @param pkt packet to dump
917 * @param dump_payload True if the payload must be displayed, too.
918 * @param st AVStream that the packet belongs to
919 */
920 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st);
921
922
923 /**
924 * Send a nice dump of a packet to the log.
925 *
926 * @param avcl A pointer to an arbitrary struct of which the first field is a
927 * pointer to an AVClass struct.
928 * @param level The importance level of the message, lower values signifying
929 * higher importance.
930 * @param pkt packet to dump
931 * @param dump_payload True if the payload must be displayed, too.
932 * @param st AVStream that the packet belongs to
933 */
934 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
935 AVStream *st);
936
937 #if FF_API_PKT_DUMP
938 attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
939 attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt,
940 int dump_payload);
941 #endif
942
943 /**
944 * Initialize libavformat and register all the muxers, demuxers and
945 * protocols. If you do not call this function, then you can select
946 * exactly which formats you want to support.
947 *
948 * @see av_register_input_format()
949 * @see av_register_output_format()
950 * @see av_register_protocol()
951 */
952 void av_register_all(void);
953
954 /**
955 * Get the CodecID for the given codec tag tag.
956 * If no codec id is found returns CODEC_ID_NONE.
957 *
958 * @param tags list of supported codec_id-codec_tag pairs, as stored
959 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
960 */
961 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
962
963 /**
964 * Get the codec tag for the given codec id id.
965 * If no codec tag is found returns 0.
966 *
967 * @param tags list of supported codec_id-codec_tag pairs, as stored
968 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
969 */
970 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
971
972 /* media file input */
973
974 /**
975 * Find AVInputFormat based on the short name of the input format.
976 */
977 AVInputFormat *av_find_input_format(const char *short_name);
978
979 /**
980 * Guess the file format.
981 *
982 * @param is_opened Whether the file is already opened; determines whether
983 * demuxers with or without AVFMT_NOFILE are probed.
984 */
985 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
986
987 /**
988 * Guess the file format.
989 *
990 * @param is_opened Whether the file is already opened; determines whether
991 * demuxers with or without AVFMT_NOFILE are probed.
992 * @param score_max A probe score larger that this is required to accept a
993 * detection, the variable is set to the actual detection
994 * score afterwards.
995 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended
996 * to retry with a larger probe buffer.
997 */
998 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max);
999
1000 /**
1001 * Probe a bytestream to determine the input format. Each time a probe returns
1002 * with a score that is too low, the probe buffer size is increased and another
1003 * attempt is made. When the maximum probe size is reached, the input format
1004 * with the highest score is returned.
1005 *
1006 * @param pb the bytestream to probe
1007 * @param fmt the input format is put here
1008 * @param filename the filename of the stream
1009 * @param logctx the log context
1010 * @param offset the offset within the bytestream to probe from
1011 * @param max_probe_size the maximum probe buffer size (zero for default)
1012 * @return 0 in case of success, a negative value corresponding to an
1013 * AVERROR code otherwise
1014 */
1015 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt,
1016 const char *filename, void *logctx,
1017 unsigned int offset, unsigned int max_probe_size);
1018
1019 #if FF_API_FORMAT_PARAMETERS
1020 /**
1021 * Allocate all the structures needed to read an input stream.
1022 * This does not open the needed codecs for decoding the stream[s].
1023 * @deprecated use avformat_open_input instead.
1024 */
1025 attribute_deprecated int av_open_input_stream(AVFormatContext **ic_ptr,
1026 AVIOContext *pb, const char *filename,
1027 AVInputFormat *fmt, AVFormatParameters *ap);
1028
1029 /**
1030 * Open a media file as input. The codecs are not opened. Only the file
1031 * header (if present) is read.
1032 *
1033 * @param ic_ptr The opened media file handle is put here.
1034 * @param filename filename to open
1035 * @param fmt If non-NULL, force the file format to use.
1036 * @param buf_size optional buffer size (zero if default is OK)
1037 * @param ap Additional parameters needed when opening the file
1038 * (NULL if default).
1039 * @return 0 if OK, AVERROR_xxx otherwise
1040 *
1041 * @deprecated use avformat_open_input instead.
1042 */
1043 attribute_deprecated int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
1044 AVInputFormat *fmt,
1045 int buf_size,
1046 AVFormatParameters *ap);
1047 #endif
1048
1049 /**
1050 * Open an input stream and read the header. The codecs are not opened.
1051 * The stream must be closed with av_close_input_file().
1052 *
1053 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context).
1054 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this
1055 * function and written into ps.
1056 * Note that a user-supplied AVFormatContext will be freed on failure.
1057 * @param filename Name of the stream to open.
1058 * @param fmt If non-NULL, this parameter forces a specific input format.
1059 * Otherwise the format is autodetected.
1060 * @param options A dictionary filled with AVFormatContext and demuxer-private options.
1061 * On return this parameter will be destroyed and replaced with a dict containing
1062 * options that were not found. May be NULL.
1063 *
1064 * @return 0 on success, a negative AVERROR on failure.
1065 *
1066 * @note If you want to use custom IO, preallocate the format context and set its pb field.
1067 */
1068 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options);
1069
1070 /**
1071 * Allocate an AVFormatContext.
1072 * avformat_free_context() can be used to free the context and everything
1073 * allocated by the framework within it.
1074 */
1075 AVFormatContext *avformat_alloc_context(void);
1076
1077 /**
1078 * Read packets of a media file to get stream information. This
1079 * is useful for file formats with no headers such as MPEG. This
1080 * function also computes the real framerate in case of MPEG-2 repeat
1081 * frame mode.
1082 * The logical file position is not changed by this function;
1083 * examined packets may be buffered for later processing.
1084 *
1085 * @param ic media file handle
1086 * @return >=0 if OK, AVERROR_xxx on error
1087 * @todo Let the user decide somehow what information is needed so that
1088 * we do not waste time getting stuff the user does not need.
1089 */
1090 int av_find_stream_info(AVFormatContext *ic);
1091
1092 /**
1093 * Find the "best" stream in the file.
1094 * The best stream is determined according to various heuristics as the most
1095 * likely to be what the user expects.
1096 * If the decoder parameter is non-NULL, av_find_best_stream will find the
1097 * default decoder for the stream's codec; streams for which no decoder can
1098 * be found are ignored.
1099 *
1100 * @param ic media file handle
1101 * @param type stream type: video, audio, subtitles, etc.
1102 * @param wanted_stream_nb user-requested stream number,
1103 * or -1 for automatic selection
1104 * @param related_stream try to find a stream related (eg. in the same
1105 * program) to this one, or -1 if none
1106 * @param decoder_ret if non-NULL, returns the decoder for the
1107 * selected stream
1108 * @param flags flags; none are currently defined
1109 * @return the non-negative stream number in case of success,
1110 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type
1111 * could be found,
1112 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder
1113 * @note If av_find_best_stream returns successfully and decoder_ret is not
1114 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec.
1115 */
1116 int av_find_best_stream(AVFormatContext *ic,
1117 enum AVMediaType type,
1118 int wanted_stream_nb,
1119 int related_stream,
1120 AVCodec **decoder_ret,
1121 int flags);
1122
1123 /**
1124 * Read a transport packet from a media file.
1125 *
1126 * This function is obsolete and should never be used.
1127 * Use av_read_frame() instead.
1128 *
1129 * @param s media file handle
1130 * @param pkt is filled
1131 * @return 0 if OK, AVERROR_xxx on error
1132 */
1133 int av_read_packet(AVFormatContext *s, AVPacket *pkt);
1134
1135 /**
1136 * Return the next frame of a stream.
1137 * This function returns what is stored in the file, and does not validate
1138 * that what is there are valid frames for the decoder. It will split what is
1139 * stored in the file into frames and return one for each call. It will not
1140 * omit invalid data between valid frames so as to give the decoder the maximum
1141 * information possible for decoding.
1142 *
1143 * The returned packet is valid
1144 * until the next av_read_frame() or until av_close_input_file() and
1145 * must be freed with av_free_packet. For video, the packet contains
1146 * exactly one frame. For audio, it contains an integer number of
1147 * frames if each frame has a known fixed size (e.g. PCM or ADPCM
1148 * data). If the audio frames have a variable size (e.g. MPEG audio),
1149 * then it contains one frame.
1150 *
1151 * pkt->pts, pkt->dts and pkt->duration are always set to correct
1152 * values in AVStream.time_base units (and guessed if the format cannot
1153 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format
1154 * has B-frames, so it is better to rely on pkt->dts if you do not
1155 * decompress the payload.
1156 *
1157 * @return 0 if OK, < 0 on error or end of file
1158 */
1159 int av_read_frame(AVFormatContext *s, AVPacket *pkt);
1160
1161 /**
1162 * Seek to the keyframe at timestamp.
1163 * 'timestamp' in 'stream_index'.
1164 * @param stream_index If stream_index is (-1), a default
1165 * stream is selected, and timestamp is automatically converted
1166 * from AV_TIME_BASE units to the stream specific time_base.
1167 * @param timestamp Timestamp in AVStream.time_base units
1168 * or, if no stream is specified, in AV_TIME_BASE units.
1169 * @param flags flags which select direction and seeking mode
1170 * @return >= 0 on success
1171 */
1172 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
1173 int flags);
1174
1175 /**
1176 * Seek to timestamp ts.
1177 * Seeking will be done so that the point from which all active streams
1178 * can be presented successfully will be closest to ts and within min/max_ts.
1179 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
1180 *
1181 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and
1182 * are the file position (this may not be supported by all demuxers).
1183 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames
1184 * in the stream with stream_index (this may not be supported by all demuxers).
1185 * Otherwise all timestamps are in units of the stream selected by stream_index
1186 * or if stream_index is -1, in AV_TIME_BASE units.
1187 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as
1188 * keyframes (this may not be supported by all demuxers).
1189 *
1190 * @param stream_index index of the stream which is used as time base reference
1191 * @param min_ts smallest acceptable timestamp
1192 * @param ts target timestamp
1193 * @param max_ts largest acceptable timestamp
1194 * @param flags flags
1195 * @return >=0 on success, error code otherwise
1196 *
1197 * @note This is part of the new seek API which is still under construction.
1198 * Thus do not use this yet. It may change at any time, do not expect
1199 * ABI compatibility yet!
1200 */
1201 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
1202
1203 /**
1204 * Start playing a network-based stream (e.g. RTSP stream) at the
1205 * current position.
1206 */
1207 int av_read_play(AVFormatContext *s);
1208
1209 /**
1210 * Pause a network-based stream (e.g. RTSP stream).
1211 *
1212 * Use av_read_play() to resume it.
1213 */
1214 int av_read_pause(AVFormatContext *s);
1215
1216 /**
1217 * Free a AVFormatContext allocated by av_open_input_stream.
1218 * @param s context to free
1219 */
1220 void av_close_input_stream(AVFormatContext *s);
1221
1222 /**
1223 * Close a media file (but not its codecs).
1224 *
1225 * @param s media file handle
1226 */
1227 void av_close_input_file(AVFormatContext *s);
1228
1229 /**
1230 * Free an AVFormatContext and all its streams.
1231 * @param s context to free
1232 */
1233 void avformat_free_context(AVFormatContext *s);
1234
1235 /**
1236 * Add a new stream to a media file.
1237 *
1238 * Can only be called in the read_header() function. If the flag
1239 * AVFMTCTX_NOHEADER is in the format context, then new streams
1240 * can be added in read_packet too.
1241 *
1242 * @param s media file handle
1243 * @param id file-format-dependent stream ID
1244 */
1245 AVStream *av_new_stream(AVFormatContext *s, int id);
1246 AVProgram *av_new_program(AVFormatContext *s, int id);
1247
1248 /**
1249 * Set the pts for a given stream. If the new values would be invalid
1250 * (<= 0), it leaves the AVStream unchanged.
1251 *
1252 * @param s stream
1253 * @param pts_wrap_bits number of bits effectively used by the pts
1254 * (used for wrap control, 33 is the value for MPEG)
1255 * @param pts_num numerator to convert to seconds (MPEG: 1)
1256 * @param pts_den denominator to convert to seconds (MPEG: 90000)
1257 */
1258 void av_set_pts_info(AVStream *s, int pts_wrap_bits,
1259 unsigned int pts_num, unsigned int pts_den);
1260
1261 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
1262 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
1263 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes
1264 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number
1265
1266 int av_find_default_stream_index(AVFormatContext *s);
1267
1268 /**
1269 * Get the index for a specific timestamp.
1270 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond
1271 * to the timestamp which is <= the requested one, if backward
1272 * is 0, then it will be >=
1273 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
1274 * @return < 0 if no such timestamp could be found
1275 */
1276 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
1277
1278 /**
1279 * Add an index entry into a sorted list. Update the entry if the list
1280 * already contains it.
1281 *
1282 * @param timestamp timestamp in the time base of the given stream
1283 */
1284 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp,
1285 int size, int distance, int flags);
1286
1287 /**
1288 * Perform a binary search using av_index_search_timestamp() and
1289 * AVInputFormat.read_timestamp().
1290 * This is not supposed to be called directly by a user application,
1291 * but by demuxers.
1292 * @param target_ts target timestamp in the time base of the given stream
1293 * @param stream_index stream number
1294 */
1295 int av_seek_frame_binary(AVFormatContext *s, int stream_index,
1296 int64_t target_ts, int flags);
1297
1298 /**
1299 * Update cur_dts of all streams based on the given timestamp and AVStream.
1300 *
1301 * Stream ref_st unchanged, others set cur_dts in their native time base.
1302 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
1303 * @param timestamp new dts expressed in time_base of param ref_st
1304 * @param ref_st reference stream giving time_base of param timestamp
1305 */
1306 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
1307
1308 /**
1309 * Perform a binary search using read_timestamp().
1310 * This is not supposed to be called directly by a user application,
1311 * but by demuxers.
1312 * @param target_ts target timestamp in the time base of the given stream
1313 * @param stream_index stream number
1314 */
1315 int64_t av_gen_search(AVFormatContext *s, int stream_index,
1316 int64_t target_ts, int64_t pos_min,
1317 int64_t pos_max, int64_t pos_limit,
1318 int64_t ts_min, int64_t ts_max,
1319 int flags, int64_t *ts_ret,
1320 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
1321
1322 /**
1323 * media file output
1324 */
1325 int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
1326
1327 /**
1328 * Split a URL string into components.
1329 *
1330 * The pointers to buffers for storing individual components may be null,
1331 * in order to ignore that component. Buffers for components not found are
1332 * set to empty strings. If the port is not found, it is set to a negative
1333 * value.
1334 *
1335 * @param proto the buffer for the protocol
1336 * @param proto_size the size of the proto buffer
1337 * @param authorization the buffer for the authorization
1338 * @param authorization_size the size of the authorization buffer
1339 * @param hostname the buffer for the host name
1340 * @param hostname_size the size of the hostname buffer
1341 * @param port_ptr a pointer to store the port number in
1342 * @param path the buffer for the path
1343 * @param path_size the size of the path buffer
1344 * @param url the URL to split
1345 */
1346 void av_url_split(char *proto, int proto_size,
1347 char *authorization, int authorization_size,
1348 char *hostname, int hostname_size,
1349 int *port_ptr,
1350 char *path, int path_size,
1351 const char *url);
1352
1353 /**
1354 * Allocate the stream private data and write the stream header to an
1355 * output media file.
1356 * @note: this sets stream time-bases, if possible to stream->codec->time_base
1357 * but for some formats it might also be some other time base
1358 *
1359 * @param s media file handle
1360 * @return 0 if OK, AVERROR_xxx on error
1361 */
1362 int av_write_header(AVFormatContext *s);
1363
1364 /**
1365 * Write a packet to an output media file.
1366 *
1367 * The packet shall contain one audio or video frame.
1368 * The packet must be correctly interleaved according to the container
1369 * specification, if not then av_interleaved_write_frame must be used.
1370 *
1371 * @param s media file handle
1372 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1373 dts/pts, ...
1374 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1375 */
1376 int av_write_frame(AVFormatContext *s, AVPacket *pkt);
1377
1378 /**
1379 * Write a packet to an output media file ensuring correct interleaving.
1380 *
1381 * The packet must contain one audio or video frame.
1382 * If the packets are already correctly interleaved, the application should
1383 * call av_write_frame() instead as it is slightly faster. It is also important
1384 * to keep in mind that completely non-interleaved input will need huge amounts
1385 * of memory to interleave with this, so it is preferable to interleave at the
1386 * demuxer level.
1387 *
1388 * @param s media file handle
1389 * @param pkt The packet, which contains the stream_index, buf/buf_size,
1390 dts/pts, ...
1391 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted
1392 */
1393 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
1394
1395 /**
1396 * Interleave a packet per dts in an output media file.
1397 *
1398 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
1399 * function, so they cannot be used after it. Note that calling av_free_packet()
1400 * on them is still safe.
1401 *
1402 * @param s media file handle
1403 * @param out the interleaved packet will be output here
1404 * @param pkt the input packet
1405 * @param flush 1 if no further packets are available as input and all
1406 * remaining packets should be output
1407 * @return 1 if a packet was output, 0 if no packet could be output,
1408 * < 0 if an error occurred
1409 */
1410 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
1411 AVPacket *pkt, int flush);
1412
1413 /**
1414 * Write the stream trailer to an output media file and free the
1415 * file private data.
1416 *
1417 * May only be called after a successful call to av_write_header.
1418 *
1419 * @param s media file handle
1420 * @return 0 if OK, AVERROR_xxx on error
1421 */
1422 int av_write_trailer(AVFormatContext *s);
1423
1424 #if FF_API_DUMP_FORMAT
1425 attribute_deprecated void dump_format(AVFormatContext *ic,
1426 int index,
1427 const char *url,
1428 int is_output);
1429 #endif
1430
1431 void av_dump_format(AVFormatContext *ic,
1432 int index,
1433 const char *url,
1434 int is_output);
1435
1436 #if FF_API_PARSE_DATE
1437 /**
1438 * Parse datestr and return a corresponding number of microseconds.
1439 *
1440 * @param datestr String representing a date or a duration.
1441 * See av_parse_time() for the syntax of the provided string.
1442 * @deprecated in favor of av_parse_time()
1443 */
1444 attribute_deprecated
1445 int64_t parse_date(const char *datestr, int duration);
1446 #endif
1447
1448 /**
1449 * Get the current time in microseconds.
1450 */
1451 int64_t av_gettime(void);
1452
1453 #if FF_API_FIND_INFO_TAG
1454 /**
1455 * @deprecated use av_find_info_tag in libavutil instead.
1456 */
1457 attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
1458 #endif
1459
1460 /**
1461 * Return in 'buf' the path with '%d' replaced by a number.
1462 *
1463 * Also handles the '%0nd' format where 'n' is the total number
1464 * of digits and '%%'.
1465 *
1466 * @param buf destination buffer
1467 * @param buf_size destination buffer size
1468 * @param path numbered sequence string
1469 * @param number frame number
1470 * @return 0 if OK, -1 on format error
1471 */
1472 int av_get_frame_filename(char *buf, int buf_size,
1473 const char *path, int number);
1474
1475 /**
1476 * Check whether filename actually is a numbered sequence generator.
1477 *
1478 * @param filename possible numbered sequence string
1479 * @return 1 if a valid numbered sequence string, 0 otherwise
1480 */
1481 int av_filename_number_test(const char *filename);
1482
1483 /**
1484 * Generate an SDP for an RTP session.
1485 *
1486 * @param ac array of AVFormatContexts describing the RTP streams. If the
1487 * array is composed by only one context, such context can contain
1488 * multiple AVStreams (one AVStream per RTP stream). Otherwise,
1489 * all the contexts in the array (an AVCodecContext per RTP stream)
1490 * must contain only one AVStream.
1491 * @param n_files number of AVCodecContexts contained in ac
1492 * @param buf buffer where the SDP will be stored (must be allocated by
1493 * the caller)
1494 * @param size the size of the buffer
1495 * @return 0 if OK, AVERROR_xxx on error
1496 */
1497 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size);
1498
1499 #if FF_API_SDP_CREATE
1500 attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
1501 #endif
1502
1503 /**
1504 * Return a positive value if the given filename has one of the given
1505 * extensions, 0 otherwise.
1506 *
1507 * @param extensions a comma-separated list of filename extensions
1508 */
1509 int av_match_ext(const char *filename, const char *extensions);
1510
1511 #endif /* AVFORMAT_AVFORMAT_H */