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