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 * @file 26 * @ingroup libavf 27 * Main libavformat public API header 28 */ 29 30 /** 31 * @defgroup libavf I/O and Muxing/Demuxing Library 32 * @{ 33 * 34 * Libavformat (lavf) is a library for dealing with various media container 35 * formats. Its main two purposes are demuxing - i.e. splitting a media file 36 * into component streams, and the reverse process of muxing - writing supplied 37 * data in a specified container format. It also has an @ref lavf_io 38 * "I/O module" which supports a number of protocols for accessing the data (e.g. 39 * file, tcp, http and others). Before using lavf, you need to call 40 * av_register_all() to register all compiled muxers, demuxers and protocols. 41 * Unless you are absolutely sure you won't use libavformat's network 42 * capabilities, you should also call avformat_network_init(). 43 * 44 * A supported input format is described by an AVInputFormat struct, conversely 45 * an output format is described by AVOutputFormat. You can iterate over all 46 * registered input/output formats using the av_iformat_next() / 47 * av_oformat_next() functions. The protocols layer is not part of the public 48 * API, so you can only get the names of supported protocols with the 49 * avio_enum_protocols() function. 50 * 51 * Main lavf structure used for both muxing and demuxing is AVFormatContext, 52 * which exports all information about the file being read or written. As with 53 * most Libav structures, its size is not part of public ABI, so it cannot be 54 * allocated on stack or directly with av_malloc(). To create an 55 * AVFormatContext, use avformat_alloc_context() (some functions, like 56 * avformat_open_input() might do that for you). 57 * 58 * Most importantly an AVFormatContext contains: 59 * @li the @ref AVFormatContext.iformat "input" or @ref AVFormatContext.oformat 60 * "output" format. It is either autodetected or set by user for input; 61 * always set by user for output. 62 * @li an @ref AVFormatContext.streams "array" of AVStreams, which describe all 63 * elementary streams stored in the file. AVStreams are typically referred to 64 * using their index in this array. 65 * @li an @ref AVFormatContext.pb "I/O context". It is either opened by lavf or 66 * set by user for input, always set by user for output (unless you are dealing 67 * with an AVFMT_NOFILE format). 68 * 69 * @defgroup lavf_decoding Demuxing 70 * @{ 71 * Demuxers read a media file and split it into chunks of data (@em packets). A 72 * @ref AVPacket "packet" contains one or more frames which belong a single 73 * elementary stream. In lavf API this process is represented by the 74 * avformat_open_input() function for opening a file, av_read_frame() for 75 * reading a single packet and finally avformat_close_input(), which does the 76 * cleanup. 77 * 78 * @section lavf_decoding_open Opening a media file 79 * The minimum information required to open a file is its URL or filename, which 80 * is passed to avformat_open_input(), as in the following code: 81 * @code 82 * const char *url = "in.mp3"; 83 * AVFormatContext *s = NULL; 84 * int ret = avformat_open_input(&s, url, NULL, NULL); 85 * if (ret < 0) 86 * abort(); 87 * @endcode 88 * The above code attempts to allocate an AVFormatContext, open the 89 * specified file (autodetecting the format) and read the header, exporting the 90 * information stored there into s. Some formats do not have a header or do not 91 * store enough information there, so it is recommended that you call the 92 * avformat_find_stream_info() function which tries to read and decode a few 93 * frames to find missing information. 94 * 95 * In some cases you might want to preallocate an AVFormatContext yourself with 96 * avformat_alloc_context() and do some tweaking on it before passing it to 97 * avformat_open_input(). One such case is when you want to use custom functions 98 * for reading input data instead of lavf internal I/O layer. 99 * To do that, create your own AVIOContext with avio_alloc_context(), passing 100 * your reading callbacks to it. Then set the @em pb field of your 101 * AVFormatContext to newly created AVIOContext. 102 * 103 * After you have finished reading the file, you must close it with 104 * avformat_close_input(). It will free everything associated with the file. 105 * 106 * @section lavf_decoding_read Reading from an opened file 107 * 108 * @section lavf_decoding_seek Seeking 109 * @} 110 * 111 * @defgroup lavf_encoding Muxing 112 * @{ 113 * @} 114 * 115 * @defgroup lavf_io I/O Read/Write 116 * @{ 117 * @} 118 * 119 * @defgroup lavf_codec Demuxers 120 * @{ 121 * @defgroup lavf_codec_native Native Demuxers 122 * @{ 123 * @} 124 * @defgroup lavf_codec_wrappers External library wrappers 125 * @{ 126 * @} 127 * @} 128 * @defgroup lavf_protos I/O Protocols 129 * @{ 130 * @} 131 * @defgroup lavf_internal Internal 132 * @{ 133 * @} 134 * @} 135 * 136 */ 137 138 #include <time.h> 139 #include <stdio.h> /* FILE */ 140 #include "libavcodec/avcodec.h" 141 #include "libavutil/dict.h" 142 #include "libavutil/log.h" 143 144 #include "avio.h" 145 #include "libavformat/version.h" 146 147 struct AVFormatContext; 148 149 150 /** 151 * @defgroup metadata_api Public Metadata API 152 * @{ 153 * @ingroup libavf 154 * The metadata API allows libavformat to export metadata tags to a client 155 * application when demuxing. Conversely it allows a client application to 156 * set metadata when muxing. 157 * 158 * Metadata is exported or set as pairs of key/value strings in the 'metadata' 159 * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs 160 * using the @ref lavu_dict "AVDictionary" API. Like all strings in Libav, 161 * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata 162 * exported by demuxers isn't checked to be valid UTF-8 in most cases. 163 * 164 * Important concepts to keep in mind: 165 * - Keys are unique; there can never be 2 tags with the same key. This is 166 * also meant semantically, i.e., a demuxer should not knowingly produce 167 * several keys that are literally different but semantically identical. 168 * E.g., key=Author5, key=Author6. In this example, all authors must be 169 * placed in the same tag. 170 * - Metadata is flat, not hierarchical; there are no subtags. If you 171 * want to store, e.g., the email address of the child of producer Alice 172 * and actor Bob, that could have key=alice_and_bobs_childs_email_address. 173 * - Several modifiers can be applied to the tag name. This is done by 174 * appending a dash character ('-') and the modifier name in the order 175 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng. 176 * - language -- a tag whose value is localized for a particular language 177 * is appended with the ISO 639-2/B 3-letter language code. 178 * For example: Author-ger=Michael, Author-eng=Mike 179 * The original/default language is in the unqualified "Author" tag. 180 * A demuxer should set a default if it sets any translated tag. 181 * - sorting -- a modified version of a tag that should be used for 182 * sorting will have '-sort' appended. E.g. artist="The Beatles", 183 * artist-sort="Beatles, The". 184 * 185 * - Demuxers attempt to export metadata in a generic format, however tags 186 * with no generic equivalents are left as they are stored in the container. 187 * Follows a list of generic tag names: 188 * 189 @verbatim 190 album -- name of the set this work belongs to 191 album_artist -- main creator of the set/album, if different from artist. 192 e.g. "Various Artists" for compilation albums. 193 artist -- main creator of the work 194 comment -- any additional description of the file. 195 composer -- who composed the work, if different from artist. 196 copyright -- name of copyright holder. 197 creation_time-- date when the file was created, preferably in ISO 8601. 198 date -- date when the work was created, preferably in ISO 8601. 199 disc -- number of a subset, e.g. disc in a multi-disc collection. 200 encoder -- name/settings of the software/hardware that produced the file. 201 encoded_by -- person/group who created the file. 202 filename -- original name of the file. 203 genre -- <self-evident>. 204 language -- main language in which the work is performed, preferably 205 in ISO 639-2 format. Multiple languages can be specified by 206 separating them with commas. 207 performer -- artist who performed the work, if different from artist. 208 E.g for "Also sprach Zarathustra", artist would be "Richard 209 Strauss" and performer "London Philharmonic Orchestra". 210 publisher -- name of the label/publisher. 211 service_name -- name of the service in broadcasting (channel name). 212 service_provider -- name of the service provider in broadcasting. 213 title -- name of the work. 214 track -- number of this work in the set, can be in form current/total. 215 variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of 216 @endverbatim 217 * 218 * Look in the examples section for an application example how to use the Metadata API. 219 * 220 * @} 221 */ 222 223 #if FF_API_OLD_METADATA2 224 /** 225 * @defgroup old_metadata Old metadata API 226 * The following functions are deprecated, use 227 * their equivalents from libavutil/dict.h instead. 228 * @{ 229 */ 230 231 #define AV_METADATA_MATCH_CASE AV_DICT_MATCH_CASE 232 #define AV_METADATA_IGNORE_SUFFIX AV_DICT_IGNORE_SUFFIX 233 #define AV_METADATA_DONT_STRDUP_KEY AV_DICT_DONT_STRDUP_KEY 234 #define AV_METADATA_DONT_STRDUP_VAL AV_DICT_DONT_STRDUP_VAL 235 #define AV_METADATA_DONT_OVERWRITE AV_DICT_DONT_OVERWRITE 236 237 typedef attribute_deprecated AVDictionary AVMetadata; 238 typedef attribute_deprecated AVDictionaryEntry AVMetadataTag; 239 240 typedef struct AVMetadataConv AVMetadataConv; 241 242 /** 243 * Get a metadata element with matching key. 244 * 245 * @param prev Set to the previous matching element to find the next. 246 * If set to NULL the first matching element is returned. 247 * @param flags Allows case as well as suffix-insensitive comparisons. 248 * @return Found tag or NULL, changing key or value leads to undefined behavior. 249 */ 250 attribute_deprecated AVDictionaryEntry * 251 av_metadata_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags); 252 253 /** 254 * Set the given tag in *pm, overwriting an existing tag. 255 * 256 * @param pm pointer to a pointer to a metadata struct. If *pm is NULL 257 * a metadata struct is allocated and put in *pm. 258 * @param key tag key to add to *pm (will be av_strduped depending on flags) 259 * @param value tag value to add to *pm (will be av_strduped depending on flags). 260 * Passing a NULL value will cause an existing tag to be deleted. 261 * @return >= 0 on success otherwise an error code <0 262 */ 263 attribute_deprecated int av_metadata_set2(AVDictionary **pm, const char *key, const char *value, int flags); 264 265 /** 266 * This function is provided for compatibility reason and currently does nothing. 267 */ 268 attribute_deprecated void av_metadata_conv(struct AVFormatContext *ctx, const AVMetadataConv *d_conv, 269 const AVMetadataConv *s_conv); 270 271 /** 272 * Copy metadata from one AVDictionary struct into another. 273 * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL, 274 * this function will allocate a struct for you and put it in *dst 275 * @param src pointer to source AVDictionary struct 276 * @param flags flags to use when setting metadata in *dst 277 * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag 278 */ 279 attribute_deprecated void av_metadata_copy(AVDictionary **dst, AVDictionary *src, int flags); 280 281 /** 282 * Free all the memory allocated for an AVDictionary struct. 283 */ 284 attribute_deprecated void av_metadata_free(AVDictionary **m); 285 /** 286 * @} 287 */ 288 #endif 289 290 291 /* packet functions */ 292 293 294 /** 295 * Allocate and read the payload of a packet and initialize its 296 * fields with default values. 297 * 298 * @param pkt packet 299 * @param size desired payload size 300 * @return >0 (read size) if OK, AVERROR_xxx otherwise 301 */ 302 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size); 303 304 305 /** 306 * Read data and append it to the current content of the AVPacket. 307 * If pkt->size is 0 this is identical to av_get_packet. 308 * Note that this uses av_grow_packet and thus involves a realloc 309 * which is inefficient. Thus this function should only be used 310 * when there is no reasonable way to know (an upper bound of) 311 * the final size. 312 * 313 * @param pkt packet 314 * @param size amount of data to read 315 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data 316 * will not be lost even if an error occurs. 317 */ 318 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size); 319 320 /*************************************************/ 321 /* fractional numbers for exact pts handling */ 322 323 /** 324 * The exact value of the fractional number is: 'val + num / den'. 325 * num is assumed to be 0 <= num < den. 326 */ 327 typedef struct AVFrac { 328 int64_t val, num, den; 329 } AVFrac; 330 331 /*************************************************/ 332 /* input/output formats */ 333 334 struct AVCodecTag; 335 336 /** 337 * This structure contains the data a format has to probe a file. 338 */ 339 typedef struct AVProbeData { 340 const char *filename; 341 unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */ 342 int buf_size; /**< Size of buf except extra allocated bytes */ 343 } AVProbeData; 344 345 #define AVPROBE_SCORE_MAX 100 ///< maximum score, half of that is used for file-extension-based detection 346 #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer 347 348 typedef struct AVFormatParameters { 349 #if FF_API_FORMAT_PARAMETERS 350 attribute_deprecated AVRational time_base; 351 attribute_deprecated int sample_rate; 352 attribute_deprecated int channels; 353 attribute_deprecated int width; 354 attribute_deprecated int height; 355 attribute_deprecated enum PixelFormat pix_fmt; 356 attribute_deprecated int channel; /**< Used to select DV channel. */ 357 attribute_deprecated const char *standard; /**< deprecated, use demuxer-specific options instead. */ 358 attribute_deprecated unsigned int mpeg2ts_raw:1; /**< deprecated, use mpegtsraw demuxer */ 359 /**< deprecated, use mpegtsraw demuxer-specific options instead */ 360 attribute_deprecated unsigned int mpeg2ts_compute_pcr:1; 361 attribute_deprecated unsigned int initial_pause:1; /**< Do not begin to play the stream 362 immediately (RTSP only). */ 363 attribute_deprecated unsigned int prealloced_context:1; 364 #endif 365 } AVFormatParameters; 366 367 /// Demuxer will use avio_open, no opened file should be provided by the caller. 368 #define AVFMT_NOFILE 0x0001 369 #define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */ 370 #define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */ 371 #define AVFMT_RAWPICTURE 0x0020 /**< Format wants AVPicture structure for 372 raw picture data. */ 373 #define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */ 374 #define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */ 375 #define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */ 376 #define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */ 377 #define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */ 378 #define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */ 379 #define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */ 380 #define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fallback to binary search via read_timestamp */ 381 #define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fallback to generic search */ 382 #define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */ 383 384 /** 385 * @addtogroup lavf_encoding 386 * @{ 387 */ 388 typedef struct AVOutputFormat { 389 const char *name; 390 /** 391 * Descriptive name for the format, meant to be more human-readable 392 * than name. You should use the NULL_IF_CONFIG_SMALL() macro 393 * to define it. 394 */ 395 const char *long_name; 396 const char *mime_type; 397 const char *extensions; /**< comma-separated filename extensions */ 398 /** 399 * size of private data so that it can be allocated in the wrapper 400 */ 401 int priv_data_size; 402 /* output support */ 403 enum CodecID audio_codec; /**< default audio codec */ 404 enum CodecID video_codec; /**< default video codec */ 405 int (*write_header)(struct AVFormatContext *); 406 int (*write_packet)(struct AVFormatContext *, AVPacket *pkt); 407 int (*write_trailer)(struct AVFormatContext *); 408 /** 409 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE, 410 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS, 411 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS 412 */ 413 int flags; 414 /** 415 * Currently only used to set pixel format if not YUV420P. 416 */ 417 int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *); 418 int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, 419 AVPacket *in, int flush); 420 421 /** 422 * List of supported codec_id-codec_tag pairs, ordered by "better 423 * choice first". The arrays are all terminated by CODEC_ID_NONE. 424 */ 425 const struct AVCodecTag * const *codec_tag; 426 427 enum CodecID subtitle_codec; /**< default subtitle codec */ 428 429 #if FF_API_OLD_METADATA2 430 const AVMetadataConv *metadata_conv; 431 #endif 432 433 const AVClass *priv_class; ///< AVClass for the private context 434 435 /** 436 * Test if the given codec can be stored in this container. 437 * 438 * @return 1 if the codec is supported, 0 if it is not. 439 * A negative number if unknown. 440 */ 441 int (*query_codec)(enum CodecID id, int std_compliance); 442 443 /* private fields */ 444 struct AVOutputFormat *next; 445 } AVOutputFormat; 446 /** 447 * @} 448 */ 449 450 /** 451 * @addtogroup lavf_decoding 452 * @{ 453 */ 454 typedef struct AVInputFormat { 455 /** 456 * A comma separated list of short names for the format. New names 457 * may be appended with a minor bump. 458 */ 459 const char *name; 460 461 /** 462 * Descriptive name for the format, meant to be more human-readable 463 * than name. You should use the NULL_IF_CONFIG_SMALL() macro 464 * to define it. 465 */ 466 const char *long_name; 467 468 /** 469 * Size of private data so that it can be allocated in the wrapper. 470 */ 471 int priv_data_size; 472 473 /** 474 * Tell if a given file has a chance of being parsed as this format. 475 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes 476 * big so you do not have to check for that unless you need more. 477 */ 478 int (*read_probe)(AVProbeData *); 479 480 /** 481 * Read the format header and initialize the AVFormatContext 482 * structure. Return 0 if OK. 'ap' if non-NULL contains 483 * additional parameters. Only used in raw format right 484 * now. 'av_new_stream' should be called to create new streams. 485 */ 486 int (*read_header)(struct AVFormatContext *, 487 AVFormatParameters *ap); 488 489 /** 490 * Read one packet and put it in 'pkt'. pts and flags are also 491 * set. 'av_new_stream' can be called only if the flag 492 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a 493 * background thread). 494 * @return 0 on success, < 0 on error. 495 * When returning an error, pkt must not have been allocated 496 * or must be freed before returning 497 */ 498 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt); 499 500 /** 501 * Close the stream. The AVFormatContext and AVStreams are not 502 * freed by this function 503 */ 504 int (*read_close)(struct AVFormatContext *); 505 506 /** 507 * Seek to a given timestamp relative to the frames in 508 * stream component stream_index. 509 * @param stream_index Must not be -1. 510 * @param flags Selects which direction should be preferred if no exact 511 * match is available. 512 * @return >= 0 on success (but not necessarily the new offset) 513 */ 514 int (*read_seek)(struct AVFormatContext *, 515 int stream_index, int64_t timestamp, int flags); 516 517 /** 518 * Get the next timestamp in stream[stream_index].time_base units. 519 * @return the timestamp or AV_NOPTS_VALUE if an error occurred 520 */ 521 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index, 522 int64_t *pos, int64_t pos_limit); 523 524 /** 525 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS, 526 * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH, 527 * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK. 528 */ 529 int flags; 530 531 /** 532 * If extensions are defined, then no probe is done. You should 533 * usually not use extension format guessing because it is not 534 * reliable enough 535 */ 536 const char *extensions; 537 538 /** 539 * General purpose read-only value that the format can use. 540 */ 541 int value; 542 543 /** 544 * Start/resume playing - only meaningful if using a network-based format 545 * (RTSP). 546 */ 547 int (*read_play)(struct AVFormatContext *); 548 549 /** 550 * Pause playing - only meaningful if using a network-based format 551 * (RTSP). 552 */ 553 int (*read_pause)(struct AVFormatContext *); 554 555 const struct AVCodecTag * const *codec_tag; 556 557 /** 558 * Seek to timestamp ts. 559 * Seeking will be done so that the point from which all active streams 560 * can be presented successfully will be closest to ts and within min/max_ts. 561 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. 562 */ 563 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); 564 565 #if FF_API_OLD_METADATA2 566 const AVMetadataConv *metadata_conv; 567 #endif 568 569 const AVClass *priv_class; ///< AVClass for the private context 570 571 /* private fields */ 572 struct AVInputFormat *next; 573 } AVInputFormat; 574 /** 575 * @} 576 */ 577 578 enum AVStreamParseType { 579 AVSTREAM_PARSE_NONE, 580 AVSTREAM_PARSE_FULL, /**< full parsing and repack */ 581 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */ 582 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */ 583 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */ 584 }; 585 586 typedef struct AVIndexEntry { 587 int64_t pos; 588 int64_t timestamp; 589 #define AVINDEX_KEYFRAME 0x0001 590 int flags:2; 591 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). 592 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */ 593 } AVIndexEntry; 594 595 #define AV_DISPOSITION_DEFAULT 0x0001 596 #define AV_DISPOSITION_DUB 0x0002 597 #define AV_DISPOSITION_ORIGINAL 0x0004 598 #define AV_DISPOSITION_COMMENT 0x0008 599 #define AV_DISPOSITION_LYRICS 0x0010 600 #define AV_DISPOSITION_KARAOKE 0x0020 601 602 /** 603 * Track should be used during playback by default. 604 * Useful for subtitle track that should be displayed 605 * even when user did not explicitly ask for subtitles. 606 */ 607 #define AV_DISPOSITION_FORCED 0x0040 608 #define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */ 609 #define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */ 610 #define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */ 611 612 /** 613 * Stream structure. 614 * New fields can be added to the end with minor version bumps. 615 * Removal, reordering and changes to existing fields require a major 616 * version bump. 617 * sizeof(AVStream) must not be used outside libav*. 618 */ 619 typedef struct AVStream { 620 int index; /**< stream index in AVFormatContext */ 621 int id; /**< format-specific stream ID */ 622 AVCodecContext *codec; /**< codec context */ 623 /** 624 * Real base framerate of the stream. 625 * This is the lowest framerate with which all timestamps can be 626 * represented accurately (it is the least common multiple of all 627 * framerates in the stream). Note, this value is just a guess! 628 * For example, if the time base is 1/90000 and all frames have either 629 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1. 630 */ 631 AVRational r_frame_rate; 632 void *priv_data; 633 634 #if FF_API_REORDER_PRIVATE 635 /* internal data used in av_find_stream_info() */ 636 int64_t first_dts; 637 #endif 638 639 /** 640 * encoding: pts generation when outputting stream 641 */ 642 struct AVFrac pts; 643 644 /** 645 * This is the fundamental unit of time (in seconds) in terms 646 * of which frame timestamps are represented. For fixed-fps content, 647 * time base should be 1/framerate and timestamp increments should be 1. 648 * decoding: set by libavformat 649 * encoding: set by libavformat in av_write_header 650 */ 651 AVRational time_base; 652 #if FF_API_REORDER_PRIVATE 653 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */ 654 #endif 655 #if FF_API_STREAM_COPY 656 /* ffmpeg.c private use */ 657 attribute_deprecated int stream_copy; /**< If set, just copy stream. */ 658 #endif 659 enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed. 660 661 #if FF_API_AVSTREAM_QUALITY 662 //FIXME move stuff to a flags field? 663 /** 664 * Quality, as it has been removed from AVCodecContext and put in AVVideoFrame. 665 * MN: dunno if that is the right place for it 666 */ 667 attribute_deprecated float quality; 668 #endif 669 670 /** 671 * Decoding: pts of the first frame of the stream, in stream time base. 672 * Only set this if you are absolutely 100% sure that the value you set 673 * it to really is the pts of the first frame. 674 * This may be undefined (AV_NOPTS_VALUE). 675 */ 676 int64_t start_time; 677 678 /** 679 * Decoding: duration of the stream, in stream time base. 680 * If a source file does not specify a duration, but does specify 681 * a bitrate, this value will be estimated from bitrate and file size. 682 */ 683 int64_t duration; 684 685 #if FF_API_REORDER_PRIVATE 686 /* av_read_frame() support */ 687 enum AVStreamParseType need_parsing; 688 struct AVCodecParserContext *parser; 689 690 int64_t cur_dts; 691 int last_IP_duration; 692 int64_t last_IP_pts; 693 /* av_seek_frame() support */ 694 AVIndexEntry *index_entries; /**< Only used if the format does not 695 support seeking natively. */ 696 int nb_index_entries; 697 unsigned int index_entries_allocated_size; 698 #endif 699 700 int64_t nb_frames; ///< number of frames in this stream if known or 0 701 702 int disposition; /**< AV_DISPOSITION_* bit field */ 703 704 #if FF_API_REORDER_PRIVATE 705 AVProbeData probe_data; 706 #define MAX_REORDER_DELAY 16 707 int64_t pts_buffer[MAX_REORDER_DELAY+1]; 708 #endif 709 710 /** 711 * sample aspect ratio (0 if unknown) 712 * - encoding: Set by user. 713 * - decoding: Set by libavformat. 714 */ 715 AVRational sample_aspect_ratio; 716 717 AVDictionary *metadata; 718 719 #if FF_API_REORDER_PRIVATE 720 /* Intended mostly for av_read_frame() support. Not supposed to be used by */ 721 /* external applications; try to use something else if at all possible. */ 722 const uint8_t *cur_ptr; 723 int cur_len; 724 AVPacket cur_pkt; 725 726 // Timestamp generation support: 727 /** 728 * Timestamp corresponding to the last dts sync point. 729 * 730 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and 731 * a DTS is received from the underlying container. Otherwise set to 732 * AV_NOPTS_VALUE by default. 733 */ 734 int64_t reference_dts; 735 736 /** 737 * Number of packets to buffer for codec probing 738 * NOT PART OF PUBLIC API 739 */ 740 #define MAX_PROBE_PACKETS 2500 741 int probe_packets; 742 743 /** 744 * last packet in packet_buffer for this stream when muxing. 745 * Used internally, NOT PART OF PUBLIC API, do not read or 746 * write from outside of libav* 747 */ 748 struct AVPacketList *last_in_packet_buffer; 749 #endif 750 751 /** 752 * Average framerate 753 */ 754 AVRational avg_frame_rate; 755 756 /***************************************************************** 757 * All fields below this line are not part of the public API. They 758 * may not be used outside of libavformat and can be changed and 759 * removed at will. 760 * New public fields should be added right above. 761 ***************************************************************** 762 */ 763 764 /** 765 * Number of frames that have been demuxed during av_find_stream_info() 766 */ 767 int codec_info_nb_frames; 768 769 /** 770 * Stream information used internally by av_find_stream_info() 771 */ 772 #define MAX_STD_TIMEBASES (60*12+5) 773 struct { 774 int64_t last_dts; 775 int64_t duration_gcd; 776 int duration_count; 777 double duration_error[MAX_STD_TIMEBASES]; 778 int64_t codec_info_duration; 779 int nb_decoded_frames; 780 } *info; 781 #if !FF_API_REORDER_PRIVATE 782 const uint8_t *cur_ptr; 783 int cur_len; 784 AVPacket cur_pkt; 785 786 // Timestamp generation support: 787 /** 788 * Timestamp corresponding to the last dts sync point. 789 * 790 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and 791 * a DTS is received from the underlying container. Otherwise set to 792 * AV_NOPTS_VALUE by default. 793 */ 794 int64_t reference_dts; 795 int64_t first_dts; 796 int64_t cur_dts; 797 int last_IP_duration; 798 int64_t last_IP_pts; 799 800 /** 801 * Number of packets to buffer for codec probing 802 */ 803 #define MAX_PROBE_PACKETS 2500 804 int probe_packets; 805 806 /** 807 * last packet in packet_buffer for this stream when muxing. 808 */ 809 struct AVPacketList *last_in_packet_buffer; 810 AVProbeData probe_data; 811 #define MAX_REORDER_DELAY 16 812 int64_t pts_buffer[MAX_REORDER_DELAY+1]; 813 /* av_read_frame() support */ 814 enum AVStreamParseType need_parsing; 815 struct AVCodecParserContext *parser; 816 817 AVIndexEntry *index_entries; /**< Only used if the format does not 818 support seeking natively. */ 819 int nb_index_entries; 820 unsigned int index_entries_allocated_size; 821 822 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */ 823 #endif 824 } AVStream; 825 826 #define AV_PROGRAM_RUNNING 1 827 828 /** 829 * New fields can be added to the end with minor version bumps. 830 * Removal, reordering and changes to existing fields require a major 831 * version bump. 832 * sizeof(AVProgram) must not be used outside libav*. 833 */ 834 typedef struct AVProgram { 835 int id; 836 int flags; 837 enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller 838 unsigned int *stream_index; 839 unsigned int nb_stream_indexes; 840 AVDictionary *metadata; 841 } AVProgram; 842 843 #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present 844 (streams are added dynamically) */ 845 846 typedef struct AVChapter { 847 int id; ///< unique ID to identify the chapter 848 AVRational time_base; ///< time base in which the start/end timestamps are specified 849 int64_t start, end; ///< chapter start/end time in time_base units 850 AVDictionary *metadata; 851 } AVChapter; 852 853 /** 854 * Format I/O context. 855 * New fields can be added to the end with minor version bumps. 856 * Removal, reordering and changes to existing fields require a major 857 * version bump. 858 * sizeof(AVFormatContext) must not be used outside libav*, use 859 * avformat_alloc_context() to create an AVFormatContext. 860 */ 861 typedef struct AVFormatContext { 862 /** 863 * A class for logging and AVOptions. Set by avformat_alloc_context(). 864 * Exports (de)muxer private options if they exist. 865 */ 866 const AVClass *av_class; 867 868 /** 869 * Can only be iformat or oformat, not both at the same time. 870 * 871 * decoding: set by avformat_open_input(). 872 * encoding: set by the user. 873 */ 874 struct AVInputFormat *iformat; 875 struct AVOutputFormat *oformat; 876 877 /** 878 * Format private data. This is an AVOptions-enabled struct 879 * if and only if iformat/oformat.priv_class is not NULL. 880 */ 881 void *priv_data; 882 883 /* 884 * I/O context. 885 * 886 * decoding: either set by the user before avformat_open_input() (then 887 * the user must close it manually) or set by avformat_open_input(). 888 * encoding: set by the user. 889 * 890 * Do NOT set this field if AVFMT_NOFILE flag is set in 891 * iformat/oformat.flags. In such a case, the (de)muxer will handle 892 * I/O in some other way and this field will be NULL. 893 */ 894 AVIOContext *pb; 895 896 /** 897 * A list of all streams in the file. New streams are created with 898 * avformat_new_stream(). 899 * 900 * decoding: streams are created by libavformat in avformat_open_input(). 901 * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also 902 * appear in av_read_frame(). 903 * encoding: streams are created by the user before avformat_write_header(). 904 */ 905 unsigned int nb_streams; 906 AVStream **streams; 907 908 char filename[1024]; /**< input or output filename */ 909 /* stream info */ 910 #if FF_API_TIMESTAMP 911 /** 912 * @deprecated use 'creation_time' metadata tag instead 913 */ 914 attribute_deprecated int64_t timestamp; 915 #endif 916 917 int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */ 918 #if FF_API_REORDER_PRIVATE 919 /* private data for pts handling (do not modify directly). */ 920 /** 921 * This buffer is only needed when packets were already buffered but 922 * not decoded, for example to get the codec parameters in MPEG 923 * streams. 924 */ 925 struct AVPacketList *packet_buffer; 926 #endif 927 928 /** 929 * Decoding: position of the first frame of the component, in 930 * AV_TIME_BASE fractional seconds. NEVER set this value directly: 931 * It is deduced from the AVStream values. 932 */ 933 int64_t start_time; 934 935 /** 936 * Decoding: duration of the stream, in AV_TIME_BASE fractional 937 * seconds. Only set this value if you know none of the individual stream 938 * durations and also do not set any of them. This is deduced from the 939 * AVStream values if not set. 940 */ 941 int64_t duration; 942 943 #if FF_API_FILESIZE 944 /** 945 * decoding: total file size, 0 if unknown 946 */ 947 attribute_deprecated int64_t file_size; 948 #endif 949 950 /** 951 * Decoding: total stream bitrate in bit/s, 0 if not 952 * available. Never set it directly if the file_size and the 953 * duration are known as Libav can compute it automatically. 954 */ 955 int bit_rate; 956 957 #if FF_API_REORDER_PRIVATE 958 /* av_read_frame() support */ 959 AVStream *cur_st; 960 961 /* av_seek_frame() support */ 962 int64_t data_offset; /**< offset of the first packet */ 963 #endif 964 965 #if FF_API_MUXRATE 966 /** 967 * use mpeg muxer private options instead 968 */ 969 attribute_deprecated int mux_rate; 970 #endif 971 unsigned int packet_size; 972 #if FF_API_PRELOAD 973 attribute_deprecated int preload; 974 #endif 975 int max_delay; 976 977 #if FF_API_LOOP_OUTPUT 978 #define AVFMT_NOOUTPUTLOOP -1 979 #define AVFMT_INFINITEOUTPUTLOOP 0 980 /** 981 * number of times to loop output in formats that support it 982 * 983 * @deprecated use the 'loop' private option in the gif muxer. 984 */ 985 attribute_deprecated int loop_output; 986 #endif 987 988 int flags; 989 #define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames. 990 #define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index. 991 #define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input. 992 #define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS 993 #define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container 994 #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 995 #if FF_API_FLAG_RTP_HINT 996 #define AVFMT_FLAG_RTP_HINT 0x0040 ///< Deprecated, use the -movflags rtphint muxer specific AVOption instead 997 #endif 998 #define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it. 999 #define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted 1000 1001 #if FF_API_LOOP_INPUT 1002 /** 1003 * @deprecated, use the 'loop' img2 demuxer private option. 1004 */ 1005 attribute_deprecated int loop_input; 1006 #endif 1007 1008 /** 1009 * decoding: size of data to probe; encoding: unused. 1010 */ 1011 unsigned int probesize; 1012 1013 /** 1014 * decoding: maximum time (in AV_TIME_BASE units) during which the input should 1015 * be analyzed in avformat_find_stream_info(). 1016 */ 1017 int max_analyze_duration; 1018 1019 const uint8_t *key; 1020 int keylen; 1021 1022 unsigned int nb_programs; 1023 AVProgram **programs; 1024 1025 /** 1026 * Forced video codec_id. 1027 * Demuxing: Set by user. 1028 */ 1029 enum CodecID video_codec_id; 1030 1031 /** 1032 * Forced audio codec_id. 1033 * Demuxing: Set by user. 1034 */ 1035 enum CodecID audio_codec_id; 1036 1037 /** 1038 * Forced subtitle codec_id. 1039 * Demuxing: Set by user. 1040 */ 1041 enum CodecID subtitle_codec_id; 1042 1043 /** 1044 * Maximum amount of memory in bytes to use for the index of each stream. 1045 * If the index exceeds this size, entries will be discarded as 1046 * needed to maintain a smaller size. This can lead to slower or less 1047 * accurate seeking (depends on demuxer). 1048 * Demuxers for which a full in-memory index is mandatory will ignore 1049 * this. 1050 * muxing : unused 1051 * demuxing: set by user 1052 */ 1053 unsigned int max_index_size; 1054 1055 /** 1056 * Maximum amount of memory in bytes to use for buffering frames 1057 * obtained from realtime capture devices. 1058 */ 1059 unsigned int max_picture_buffer; 1060 1061 unsigned int nb_chapters; 1062 AVChapter **chapters; 1063 1064 /** 1065 * Flags to enable debugging. 1066 */ 1067 int debug; 1068 #define FF_FDEBUG_TS 0x0001 1069 1070 #if FF_API_REORDER_PRIVATE 1071 /** 1072 * Raw packets from the demuxer, prior to parsing and decoding. 1073 * This buffer is used for buffering packets until the codec can 1074 * be identified, as parsing cannot be done without knowing the 1075 * codec. 1076 */ 1077 struct AVPacketList *raw_packet_buffer; 1078 struct AVPacketList *raw_packet_buffer_end; 1079 1080 struct AVPacketList *packet_buffer_end; 1081 #endif 1082 1083 AVDictionary *metadata; 1084 1085 #if FF_API_REORDER_PRIVATE 1086 /** 1087 * Remaining size available for raw_packet_buffer, in bytes. 1088 * NOT PART OF PUBLIC API 1089 */ 1090 #define RAW_PACKET_BUFFER_SIZE 2500000 1091 int raw_packet_buffer_remaining_size; 1092 #endif 1093 1094 /** 1095 * Start time of the stream in real world time, in microseconds 1096 * since the unix epoch (00:00 1st January 1970). That is, pts=0 1097 * in the stream was captured at this real world time. 1098 * - encoding: Set by user. 1099 * - decoding: Unused. 1100 */ 1101 int64_t start_time_realtime; 1102 1103 /** 1104 * decoding: number of frames used to probe fps 1105 */ 1106 int fps_probe_size; 1107 1108 /** 1109 * Error recognition; higher values will detect more errors but may 1110 * misdetect some more or less valid parts as errors. 1111 * - encoding: unused 1112 * - decoding: Set by user. 1113 */ 1114 int error_recognition; 1115 1116 /** 1117 * Custom interrupt callbacks for the I/O layer. 1118 * 1119 * decoding: set by the user before avformat_open_input(). 1120 * encoding: set by the user before avformat_write_header() 1121 * (mainly useful for AVFMT_NOFILE formats). The callback 1122 * should also be passed to avio_open2() if it's used to 1123 * open the file. 1124 */ 1125 AVIOInterruptCB interrupt_callback; 1126 1127 /***************************************************************** 1128 * All fields below this line are not part of the public API. They 1129 * may not be used outside of libavformat and can be changed and 1130 * removed at will. 1131 * New public fields should be added right above. 1132 ***************************************************************** 1133 */ 1134 #if !FF_API_REORDER_PRIVATE 1135 /** 1136 * Raw packets from the demuxer, prior to parsing and decoding. 1137 * This buffer is used for buffering packets until the codec can 1138 * be identified, as parsing cannot be done without knowing the 1139 * codec. 1140 */ 1141 struct AVPacketList *raw_packet_buffer; 1142 struct AVPacketList *raw_packet_buffer_end; 1143 /** 1144 * Remaining size available for raw_packet_buffer, in bytes. 1145 */ 1146 #define RAW_PACKET_BUFFER_SIZE 2500000 1147 int raw_packet_buffer_remaining_size; 1148 1149 /** 1150 * This buffer is only needed when packets were already buffered but 1151 * not decoded, for example to get the codec parameters in MPEG 1152 * streams. 1153 */ 1154 struct AVPacketList *packet_buffer; 1155 struct AVPacketList *packet_buffer_end; 1156 1157 /* av_read_frame() support */ 1158 AVStream *cur_st; 1159 1160 /* av_seek_frame() support */ 1161 int64_t data_offset; /**< offset of the first packet */ 1162 #endif 1163 } AVFormatContext; 1164 1165 typedef struct AVPacketList { 1166 AVPacket pkt; 1167 struct AVPacketList *next; 1168 } AVPacketList; 1169 1170 1171 /** 1172 * @defgroup lavf_core Core functions 1173 * @ingroup libavf 1174 * 1175 * Functions for querying libavformat capabilities, allocating core structures, 1176 * etc. 1177 * @{ 1178 */ 1179 1180 /** 1181 * Return the LIBAVFORMAT_VERSION_INT constant. 1182 */ 1183 unsigned avformat_version(void); 1184 1185 /** 1186 * Return the libavformat build-time configuration. 1187 */ 1188 const char *avformat_configuration(void); 1189 1190 /** 1191 * Return the libavformat license. 1192 */ 1193 const char *avformat_license(void); 1194 1195 /** 1196 * Initialize libavformat and register all the muxers, demuxers and 1197 * protocols. If you do not call this function, then you can select 1198 * exactly which formats you want to support. 1199 * 1200 * @see av_register_input_format() 1201 * @see av_register_output_format() 1202 * @see av_register_protocol() 1203 */ 1204 void av_register_all(void); 1205 1206 void av_register_input_format(AVInputFormat *format); 1207 void av_register_output_format(AVOutputFormat *format); 1208 1209 /** 1210 * Do global initialization of network components. This is optional, 1211 * but recommended, since it avoids the overhead of implicitly 1212 * doing the setup for each session. 1213 * 1214 * Calling this function will become mandatory if using network 1215 * protocols at some major version bump. 1216 */ 1217 int avformat_network_init(void); 1218 1219 /** 1220 * Undo the initialization done by avformat_network_init. 1221 */ 1222 int avformat_network_deinit(void); 1223 1224 /** 1225 * If f is NULL, returns the first registered input format, 1226 * if f is non-NULL, returns the next registered input format after f 1227 * or NULL if f is the last one. 1228 */ 1229 AVInputFormat *av_iformat_next(AVInputFormat *f); 1230 1231 /** 1232 * If f is NULL, returns the first registered output format, 1233 * if f is non-NULL, returns the next registered output format after f 1234 * or NULL if f is the last one. 1235 */ 1236 AVOutputFormat *av_oformat_next(AVOutputFormat *f); 1237 1238 /** 1239 * Allocate an AVFormatContext. 1240 * avformat_free_context() can be used to free the context and everything 1241 * allocated by the framework within it. 1242 */ 1243 AVFormatContext *avformat_alloc_context(void); 1244 1245 /** 1246 * Free an AVFormatContext and all its streams. 1247 * @param s context to free 1248 */ 1249 void avformat_free_context(AVFormatContext *s); 1250 1251 /** 1252 * Get the AVClass for AVFormatContext. It can be used in combination with 1253 * AV_OPT_SEARCH_FAKE_OBJ for examining options. 1254 * 1255 * @see av_opt_find(). 1256 */ 1257 const AVClass *avformat_get_class(void); 1258 1259 /** 1260 * Add a new stream to a media file. 1261 * 1262 * When demuxing, it is called by the demuxer in read_header(). If the 1263 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also 1264 * be called in read_packet(). 1265 * 1266 * When muxing, should be called by the user before avformat_write_header(). 1267 * 1268 * @param c If non-NULL, the AVCodecContext corresponding to the new stream 1269 * will be initialized to use this codec. This is needed for e.g. codec-specific 1270 * defaults to be set, so codec should be provided if it is known. 1271 * 1272 * @return newly created stream or NULL on error. 1273 */ 1274 AVStream *avformat_new_stream(AVFormatContext *s, AVCodec *c); 1275 1276 AVProgram *av_new_program(AVFormatContext *s, int id); 1277 1278 /** 1279 * @} 1280 */ 1281 1282 1283 #if FF_API_GUESS_IMG2_CODEC 1284 attribute_deprecated enum CodecID av_guess_image2_codec(const char *filename); 1285 #endif 1286 1287 #if FF_API_PKT_DUMP 1288 attribute_deprecated void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload); 1289 attribute_deprecated void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, 1290 int dump_payload); 1291 #endif 1292 1293 1294 /** 1295 * @addtogroup lavf_decoding 1296 * @{ 1297 */ 1298 1299 /** 1300 * Find AVInputFormat based on the short name of the input format. 1301 */ 1302 AVInputFormat *av_find_input_format(const char *short_name); 1303 1304 /** 1305 * Guess the file format. 1306 * 1307 * @param is_opened Whether the file is already opened; determines whether 1308 * demuxers with or without AVFMT_NOFILE are probed. 1309 */ 1310 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened); 1311 1312 /** 1313 * Guess the file format. 1314 * 1315 * @param is_opened Whether the file is already opened; determines whether 1316 * demuxers with or without AVFMT_NOFILE are probed. 1317 * @param score_max A probe score larger that this is required to accept a 1318 * detection, the variable is set to the actual detection 1319 * score afterwards. 1320 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended 1321 * to retry with a larger probe buffer. 1322 */ 1323 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max); 1324 1325 /** 1326 * Probe a bytestream to determine the input format. Each time a probe returns 1327 * with a score that is too low, the probe buffer size is increased and another 1328 * attempt is made. When the maximum probe size is reached, the input format 1329 * with the highest score is returned. 1330 * 1331 * @param pb the bytestream to probe 1332 * @param fmt the input format is put here 1333 * @param filename the filename of the stream 1334 * @param logctx the log context 1335 * @param offset the offset within the bytestream to probe from 1336 * @param max_probe_size the maximum probe buffer size (zero for default) 1337 * @return 0 in case of success, a negative value corresponding to an 1338 * AVERROR code otherwise 1339 */ 1340 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt, 1341 const char *filename, void *logctx, 1342 unsigned int offset, unsigned int max_probe_size); 1343 1344 #if FF_API_FORMAT_PARAMETERS 1345 /** 1346 * Allocate all the structures needed to read an input stream. 1347 * This does not open the needed codecs for decoding the stream[s]. 1348 * @deprecated use avformat_open_input instead. 1349 */ 1350 attribute_deprecated int av_open_input_stream(AVFormatContext **ic_ptr, 1351 AVIOContext *pb, const char *filename, 1352 AVInputFormat *fmt, AVFormatParameters *ap); 1353 1354 /** 1355 * Open a media file as input. The codecs are not opened. Only the file 1356 * header (if present) is read. 1357 * 1358 * @param ic_ptr The opened media file handle is put here. 1359 * @param filename filename to open 1360 * @param fmt If non-NULL, force the file format to use. 1361 * @param buf_size optional buffer size (zero if default is OK) 1362 * @param ap Additional parameters needed when opening the file 1363 * (NULL if default). 1364 * @return 0 if OK, AVERROR_xxx otherwise 1365 * 1366 * @deprecated use avformat_open_input instead. 1367 */ 1368 attribute_deprecated int av_open_input_file(AVFormatContext **ic_ptr, const char *filename, 1369 AVInputFormat *fmt, 1370 int buf_size, 1371 AVFormatParameters *ap); 1372 #endif 1373 1374 /** 1375 * Open an input stream and read the header. The codecs are not opened. 1376 * The stream must be closed with av_close_input_file(). 1377 * 1378 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context). 1379 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this 1380 * function and written into ps. 1381 * Note that a user-supplied AVFormatContext will be freed on failure. 1382 * @param filename Name of the stream to open. 1383 * @param fmt If non-NULL, this parameter forces a specific input format. 1384 * Otherwise the format is autodetected. 1385 * @param options A dictionary filled with AVFormatContext and demuxer-private options. 1386 * On return this parameter will be destroyed and replaced with a dict containing 1387 * options that were not found. May be NULL. 1388 * 1389 * @return 0 on success, a negative AVERROR on failure. 1390 * 1391 * @note If you want to use custom IO, preallocate the format context and set its pb field. 1392 */ 1393 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options); 1394 1395 #if FF_API_FORMAT_PARAMETERS 1396 /** 1397 * Read packets of a media file to get stream information. This 1398 * is useful for file formats with no headers such as MPEG. This 1399 * function also computes the real framerate in case of MPEG-2 repeat 1400 * frame mode. 1401 * The logical file position is not changed by this function; 1402 * examined packets may be buffered for later processing. 1403 * 1404 * @param ic media file handle 1405 * @return >=0 if OK, AVERROR_xxx on error 1406 * @todo Let the user decide somehow what information is needed so that 1407 * we do not waste time getting stuff the user does not need. 1408 * 1409 * @deprecated use avformat_find_stream_info. 1410 */ 1411 attribute_deprecated 1412 int av_find_stream_info(AVFormatContext *ic); 1413 #endif 1414 1415 /** 1416 * Read packets of a media file to get stream information. This 1417 * is useful for file formats with no headers such as MPEG. This 1418 * function also computes the real framerate in case of MPEG-2 repeat 1419 * frame mode. 1420 * The logical file position is not changed by this function; 1421 * examined packets may be buffered for later processing. 1422 * 1423 * @param ic media file handle 1424 * @param options If non-NULL, an ic.nb_streams long array of pointers to 1425 * dictionaries, where i-th member contains options for 1426 * codec corresponding to i-th stream. 1427 * On return each dictionary will be filled with options that were not found. 1428 * @return >=0 if OK, AVERROR_xxx on error 1429 * 1430 * @note this function isn't guaranteed to open all the codecs, so 1431 * options being non-empty at return is a perfectly normal behavior. 1432 * 1433 * @todo Let the user decide somehow what information is needed so that 1434 * we do not waste time getting stuff the user does not need. 1435 */ 1436 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options); 1437 1438 /** 1439 * Find the "best" stream in the file. 1440 * The best stream is determined according to various heuristics as the most 1441 * likely to be what the user expects. 1442 * If the decoder parameter is non-NULL, av_find_best_stream will find the 1443 * default decoder for the stream's codec; streams for which no decoder can 1444 * be found are ignored. 1445 * 1446 * @param ic media file handle 1447 * @param type stream type: video, audio, subtitles, etc. 1448 * @param wanted_stream_nb user-requested stream number, 1449 * or -1 for automatic selection 1450 * @param related_stream try to find a stream related (eg. in the same 1451 * program) to this one, or -1 if none 1452 * @param decoder_ret if non-NULL, returns the decoder for the 1453 * selected stream 1454 * @param flags flags; none are currently defined 1455 * @return the non-negative stream number in case of success, 1456 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type 1457 * could be found, 1458 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder 1459 * @note If av_find_best_stream returns successfully and decoder_ret is not 1460 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec. 1461 */ 1462 int av_find_best_stream(AVFormatContext *ic, 1463 enum AVMediaType type, 1464 int wanted_stream_nb, 1465 int related_stream, 1466 AVCodec **decoder_ret, 1467 int flags); 1468 1469 /** 1470 * Read a transport packet from a media file. 1471 * 1472 * This function is obsolete and should never be used. 1473 * Use av_read_frame() instead. 1474 * 1475 * @param s media file handle 1476 * @param pkt is filled 1477 * @return 0 if OK, AVERROR_xxx on error 1478 */ 1479 int av_read_packet(AVFormatContext *s, AVPacket *pkt); 1480 1481 /** 1482 * Return the next frame of a stream. 1483 * This function returns what is stored in the file, and does not validate 1484 * that what is there are valid frames for the decoder. It will split what is 1485 * stored in the file into frames and return one for each call. It will not 1486 * omit invalid data between valid frames so as to give the decoder the maximum 1487 * information possible for decoding. 1488 * 1489 * The returned packet is valid 1490 * until the next av_read_frame() or until av_close_input_file() and 1491 * must be freed with av_free_packet. For video, the packet contains 1492 * exactly one frame. For audio, it contains an integer number of 1493 * frames if each frame has a known fixed size (e.g. PCM or ADPCM 1494 * data). If the audio frames have a variable size (e.g. MPEG audio), 1495 * then it contains one frame. 1496 * 1497 * pkt->pts, pkt->dts and pkt->duration are always set to correct 1498 * values in AVStream.time_base units (and guessed if the format cannot 1499 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format 1500 * has B-frames, so it is better to rely on pkt->dts if you do not 1501 * decompress the payload. 1502 * 1503 * @return 0 if OK, < 0 on error or end of file 1504 */ 1505 int av_read_frame(AVFormatContext *s, AVPacket *pkt); 1506 1507 /** 1508 * Seek to the keyframe at timestamp. 1509 * 'timestamp' in 'stream_index'. 1510 * @param stream_index If stream_index is (-1), a default 1511 * stream is selected, and timestamp is automatically converted 1512 * from AV_TIME_BASE units to the stream specific time_base. 1513 * @param timestamp Timestamp in AVStream.time_base units 1514 * or, if no stream is specified, in AV_TIME_BASE units. 1515 * @param flags flags which select direction and seeking mode 1516 * @return >= 0 on success 1517 */ 1518 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, 1519 int flags); 1520 1521 /** 1522 * Seek to timestamp ts. 1523 * Seeking will be done so that the point from which all active streams 1524 * can be presented successfully will be closest to ts and within min/max_ts. 1525 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. 1526 * 1527 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and 1528 * are the file position (this may not be supported by all demuxers). 1529 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames 1530 * in the stream with stream_index (this may not be supported by all demuxers). 1531 * Otherwise all timestamps are in units of the stream selected by stream_index 1532 * or if stream_index is -1, in AV_TIME_BASE units. 1533 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as 1534 * keyframes (this may not be supported by all demuxers). 1535 * 1536 * @param stream_index index of the stream which is used as time base reference 1537 * @param min_ts smallest acceptable timestamp 1538 * @param ts target timestamp 1539 * @param max_ts largest acceptable timestamp 1540 * @param flags flags 1541 * @return >=0 on success, error code otherwise 1542 * 1543 * @note This is part of the new seek API which is still under construction. 1544 * Thus do not use this yet. It may change at any time, do not expect 1545 * ABI compatibility yet! 1546 */ 1547 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); 1548 1549 /** 1550 * Start playing a network-based stream (e.g. RTSP stream) at the 1551 * current position. 1552 */ 1553 int av_read_play(AVFormatContext *s); 1554 1555 /** 1556 * Pause a network-based stream (e.g. RTSP stream). 1557 * 1558 * Use av_read_play() to resume it. 1559 */ 1560 int av_read_pause(AVFormatContext *s); 1561 1562 #if FF_API_FORMAT_PARAMETERS 1563 /** 1564 * Free a AVFormatContext allocated by av_open_input_stream. 1565 * @param s context to free 1566 * @deprecated use av_close_input_file() 1567 */ 1568 attribute_deprecated 1569 void av_close_input_stream(AVFormatContext *s); 1570 #endif 1571 1572 #if FF_API_CLOSE_INPUT_FILE 1573 /** 1574 * @deprecated use avformat_close_input() 1575 * Close a media file (but not its codecs). 1576 * 1577 * @param s media file handle 1578 */ 1579 attribute_deprecated 1580 void av_close_input_file(AVFormatContext *s); 1581 #endif 1582 1583 /** 1584 * Close an opened input AVFormatContext. Free it and all its contents 1585 * and set *s to NULL. 1586 */ 1587 void avformat_close_input(AVFormatContext **s); 1588 /** 1589 * @} 1590 */ 1591 1592 #if FF_API_NEW_STREAM 1593 /** 1594 * Add a new stream to a media file. 1595 * 1596 * Can only be called in the read_header() function. If the flag 1597 * AVFMTCTX_NOHEADER is in the format context, then new streams 1598 * can be added in read_packet too. 1599 * 1600 * @param s media file handle 1601 * @param id file-format-dependent stream ID 1602 */ 1603 attribute_deprecated 1604 AVStream *av_new_stream(AVFormatContext *s, int id); 1605 #endif 1606 1607 #if FF_API_SET_PTS_INFO 1608 /** 1609 * @deprecated this function is not supposed to be called outside of lavf 1610 */ 1611 attribute_deprecated 1612 void av_set_pts_info(AVStream *s, int pts_wrap_bits, 1613 unsigned int pts_num, unsigned int pts_den); 1614 #endif 1615 1616 #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward 1617 #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes 1618 #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes 1619 #define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number 1620 1621 #if FF_API_SEEK_PUBLIC 1622 attribute_deprecated 1623 int av_seek_frame_binary(AVFormatContext *s, int stream_index, 1624 int64_t target_ts, int flags); 1625 attribute_deprecated 1626 void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp); 1627 attribute_deprecated 1628 int64_t av_gen_search(AVFormatContext *s, int stream_index, 1629 int64_t target_ts, int64_t pos_min, 1630 int64_t pos_max, int64_t pos_limit, 1631 int64_t ts_min, int64_t ts_max, 1632 int flags, int64_t *ts_ret, 1633 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t )); 1634 #endif 1635 1636 #if FF_API_FORMAT_PARAMETERS 1637 /** 1638 * @deprecated pass the options to avformat_write_header directly. 1639 */ 1640 attribute_deprecated int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap); 1641 #endif 1642 1643 /** 1644 * @addtogroup lavf_encoding 1645 * @{ 1646 */ 1647 /** 1648 * Allocate the stream private data and write the stream header to 1649 * an output media file. 1650 * 1651 * @param s Media file handle, must be allocated with avformat_alloc_context(). 1652 * Its oformat field must be set to the desired output format; 1653 * Its pb field must be set to an already openened AVIOContext. 1654 * @param options An AVDictionary filled with AVFormatContext and muxer-private options. 1655 * On return this parameter will be destroyed and replaced with a dict containing 1656 * options that were not found. May be NULL. 1657 * 1658 * @return 0 on success, negative AVERROR on failure. 1659 * 1660 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next. 1661 */ 1662 int avformat_write_header(AVFormatContext *s, AVDictionary **options); 1663 1664 #if FF_API_FORMAT_PARAMETERS 1665 /** 1666 * Allocate the stream private data and write the stream header to an 1667 * output media file. 1668 * @note: this sets stream time-bases, if possible to stream->codec->time_base 1669 * but for some formats it might also be some other time base 1670 * 1671 * @param s media file handle 1672 * @return 0 if OK, AVERROR_xxx on error 1673 * 1674 * @deprecated use avformat_write_header. 1675 */ 1676 attribute_deprecated int av_write_header(AVFormatContext *s); 1677 #endif 1678 1679 /** 1680 * Write a packet to an output media file. 1681 * 1682 * The packet shall contain one audio or video frame. 1683 * The packet must be correctly interleaved according to the container 1684 * specification, if not then av_interleaved_write_frame must be used. 1685 * 1686 * @param s media file handle 1687 * @param pkt The packet, which contains the stream_index, buf/buf_size, 1688 dts/pts, ... 1689 * @return < 0 on error, = 0 if OK, 1 if end of stream wanted 1690 */ 1691 int av_write_frame(AVFormatContext *s, AVPacket *pkt); 1692 1693 /** 1694 * Write a packet to an output media file ensuring correct interleaving. 1695 * 1696 * The packet must contain one audio or video frame. 1697 * If the packets are already correctly interleaved, the application should 1698 * call av_write_frame() instead as it is slightly faster. It is also important 1699 * to keep in mind that completely non-interleaved input will need huge amounts 1700 * of memory to interleave with this, so it is preferable to interleave at the 1701 * demuxer level. 1702 * 1703 * @param s media file handle 1704 * @param pkt The packet containing the data to be written. Libavformat takes 1705 * ownership of the data and will free it when it sees fit using the packet's 1706 * @ref AVPacket.destruct "destruct" field. The caller must not access the data 1707 * after this function returns, as it may already be freed. 1708 * Packet's @ref AVPacket.stream_index "stream_index" field must be set to the 1709 * index of the corresponding stream in @ref AVFormatContext.streams 1710 * "s.streams". 1711 * It is very strongly recommended that timing information (@ref AVPacket.pts 1712 * "pts", @ref AVPacket.dts "dts" @ref AVPacket.duration "duration") is set to 1713 * correct values. 1714 * 1715 * @return 0 on success, a negative AVERROR on error. 1716 */ 1717 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt); 1718 1719 /** 1720 * Interleave a packet per dts in an output media file. 1721 * 1722 * Packets with pkt->destruct == av_destruct_packet will be freed inside this 1723 * function, so they cannot be used after it. Note that calling av_free_packet() 1724 * on them is still safe. 1725 * 1726 * @param s media file handle 1727 * @param out the interleaved packet will be output here 1728 * @param pkt the input packet 1729 * @param flush 1 if no further packets are available as input and all 1730 * remaining packets should be output 1731 * @return 1 if a packet was output, 0 if no packet could be output, 1732 * < 0 if an error occurred 1733 */ 1734 int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, 1735 AVPacket *pkt, int flush); 1736 1737 /** 1738 * Write the stream trailer to an output media file and free the 1739 * file private data. 1740 * 1741 * May only be called after a successful call to av_write_header. 1742 * 1743 * @param s media file handle 1744 * @return 0 if OK, AVERROR_xxx on error 1745 */ 1746 int av_write_trailer(AVFormatContext *s); 1747 1748 /** 1749 * Return the output format in the list of registered output formats 1750 * which best matches the provided parameters, or return NULL if 1751 * there is no match. 1752 * 1753 * @param short_name if non-NULL checks if short_name matches with the 1754 * names of the registered formats 1755 * @param filename if non-NULL checks if filename terminates with the 1756 * extensions of the registered formats 1757 * @param mime_type if non-NULL checks if mime_type matches with the 1758 * MIME type of the registered formats 1759 */ 1760 AVOutputFormat *av_guess_format(const char *short_name, 1761 const char *filename, 1762 const char *mime_type); 1763 1764 /** 1765 * Guess the codec ID based upon muxer and filename. 1766 */ 1767 enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name, 1768 const char *filename, const char *mime_type, 1769 enum AVMediaType type); 1770 1771 /** 1772 * @} 1773 */ 1774 1775 1776 /** 1777 * @defgroup lavf_misc Utility functions 1778 * @ingroup libavf 1779 * @{ 1780 * 1781 * Miscelaneous utility functions related to both muxing and demuxing 1782 * (or neither). 1783 */ 1784 1785 /** 1786 * Send a nice hexadecimal dump of a buffer to the specified file stream. 1787 * 1788 * @param f The file stream pointer where the dump should be sent to. 1789 * @param buf buffer 1790 * @param size buffer size 1791 * 1792 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2 1793 */ 1794 void av_hex_dump(FILE *f, uint8_t *buf, int size); 1795 1796 /** 1797 * Send a nice hexadecimal dump of a buffer to the log. 1798 * 1799 * @param avcl A pointer to an arbitrary struct of which the first field is a 1800 * pointer to an AVClass struct. 1801 * @param level The importance level of the message, lower values signifying 1802 * higher importance. 1803 * @param buf buffer 1804 * @param size buffer size 1805 * 1806 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2 1807 */ 1808 void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size); 1809 1810 /** 1811 * Send a nice dump of a packet to the specified file stream. 1812 * 1813 * @param f The file stream pointer where the dump should be sent to. 1814 * @param pkt packet to dump 1815 * @param dump_payload True if the payload must be displayed, too. 1816 * @param st AVStream that the packet belongs to 1817 */ 1818 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st); 1819 1820 1821 /** 1822 * Send a nice dump of a packet to the log. 1823 * 1824 * @param avcl A pointer to an arbitrary struct of which the first field is a 1825 * pointer to an AVClass struct. 1826 * @param level The importance level of the message, lower values signifying 1827 * higher importance. 1828 * @param pkt packet to dump 1829 * @param dump_payload True if the payload must be displayed, too. 1830 * @param st AVStream that the packet belongs to 1831 */ 1832 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload, 1833 AVStream *st); 1834 1835 /** 1836 * Get the CodecID for the given codec tag tag. 1837 * If no codec id is found returns CODEC_ID_NONE. 1838 * 1839 * @param tags list of supported codec_id-codec_tag pairs, as stored 1840 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag 1841 */ 1842 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag); 1843 1844 /** 1845 * Get the codec tag for the given codec id id. 1846 * If no codec tag is found returns 0. 1847 * 1848 * @param tags list of supported codec_id-codec_tag pairs, as stored 1849 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag 1850 */ 1851 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id); 1852 1853 int av_find_default_stream_index(AVFormatContext *s); 1854 1855 /** 1856 * Get the index for a specific timestamp. 1857 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond 1858 * to the timestamp which is <= the requested one, if backward 1859 * is 0, then it will be >= 1860 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise 1861 * @return < 0 if no such timestamp could be found 1862 */ 1863 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags); 1864 1865 /** 1866 * Add an index entry into a sorted list. Update the entry if the list 1867 * already contains it. 1868 * 1869 * @param timestamp timestamp in the time base of the given stream 1870 */ 1871 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp, 1872 int size, int distance, int flags); 1873 1874 1875 /** 1876 * Split a URL string into components. 1877 * 1878 * The pointers to buffers for storing individual components may be null, 1879 * in order to ignore that component. Buffers for components not found are 1880 * set to empty strings. If the port is not found, it is set to a negative 1881 * value. 1882 * 1883 * @param proto the buffer for the protocol 1884 * @param proto_size the size of the proto buffer 1885 * @param authorization the buffer for the authorization 1886 * @param authorization_size the size of the authorization buffer 1887 * @param hostname the buffer for the host name 1888 * @param hostname_size the size of the hostname buffer 1889 * @param port_ptr a pointer to store the port number in 1890 * @param path the buffer for the path 1891 * @param path_size the size of the path buffer 1892 * @param url the URL to split 1893 */ 1894 void av_url_split(char *proto, int proto_size, 1895 char *authorization, int authorization_size, 1896 char *hostname, int hostname_size, 1897 int *port_ptr, 1898 char *path, int path_size, 1899 const char *url); 1900 1901 #if FF_API_DUMP_FORMAT 1902 attribute_deprecated void dump_format(AVFormatContext *ic, 1903 int index, 1904 const char *url, 1905 int is_output); 1906 #endif 1907 1908 void av_dump_format(AVFormatContext *ic, 1909 int index, 1910 const char *url, 1911 int is_output); 1912 1913 #if FF_API_PARSE_DATE 1914 /** 1915 * Parse datestr and return a corresponding number of microseconds. 1916 * 1917 * @param datestr String representing a date or a duration. 1918 * See av_parse_time() for the syntax of the provided string. 1919 * @deprecated in favor of av_parse_time() 1920 */ 1921 attribute_deprecated 1922 int64_t parse_date(const char *datestr, int duration); 1923 #endif 1924 1925 /** 1926 * Get the current time in microseconds. 1927 */ 1928 int64_t av_gettime(void); 1929 1930 #if FF_API_FIND_INFO_TAG 1931 /** 1932 * @deprecated use av_find_info_tag in libavutil instead. 1933 */ 1934 attribute_deprecated int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info); 1935 #endif 1936 1937 /** 1938 * Return in 'buf' the path with '%d' replaced by a number. 1939 * 1940 * Also handles the '%0nd' format where 'n' is the total number 1941 * of digits and '%%'. 1942 * 1943 * @param buf destination buffer 1944 * @param buf_size destination buffer size 1945 * @param path numbered sequence string 1946 * @param number frame number 1947 * @return 0 if OK, -1 on format error 1948 */ 1949 int av_get_frame_filename(char *buf, int buf_size, 1950 const char *path, int number); 1951 1952 /** 1953 * Check whether filename actually is a numbered sequence generator. 1954 * 1955 * @param filename possible numbered sequence string 1956 * @return 1 if a valid numbered sequence string, 0 otherwise 1957 */ 1958 int av_filename_number_test(const char *filename); 1959 1960 /** 1961 * Generate an SDP for an RTP session. 1962 * 1963 * @param ac array of AVFormatContexts describing the RTP streams. If the 1964 * array is composed by only one context, such context can contain 1965 * multiple AVStreams (one AVStream per RTP stream). Otherwise, 1966 * all the contexts in the array (an AVCodecContext per RTP stream) 1967 * must contain only one AVStream. 1968 * @param n_files number of AVCodecContexts contained in ac 1969 * @param buf buffer where the SDP will be stored (must be allocated by 1970 * the caller) 1971 * @param size the size of the buffer 1972 * @return 0 if OK, AVERROR_xxx on error 1973 */ 1974 int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size); 1975 1976 #if FF_API_SDP_CREATE 1977 attribute_deprecated int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size); 1978 #endif 1979 1980 /** 1981 * Return a positive value if the given filename has one of the given 1982 * extensions, 0 otherwise. 1983 * 1984 * @param extensions a comma-separated list of filename extensions 1985 */ 1986 int av_match_ext(const char *filename, const char *extensions); 1987 1988 /** 1989 * Test if the given container can store a codec. 1990 * 1991 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_* 1992 * 1993 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot. 1994 * A negative number if this information is not available. 1995 */ 1996 int avformat_query_codec(AVOutputFormat *ofmt, enum CodecID codec_id, int std_compliance); 1997 1998 /** 1999 * @defgroup riff_fourcc RIFF FourCCs 2000 * @{ 2001 * Get the tables mapping RIFF FourCCs to libavcodec CodecIDs. The tables are 2002 * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the 2003 * following code: 2004 * @code 2005 * uint32_t tag = MKTAG('H', '2', '6', '4'); 2006 * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 }; 2007 * enum CodecID id = av_codec_get_id(table, tag); 2008 * @endcode 2009 */ 2010 /** 2011 * @return the table mapping RIFF FourCCs for video to libavcodec CodecID. 2012 */ 2013 const struct AVCodecTag *avformat_get_riff_video_tags(void); 2014 /** 2015 * @return the table mapping RIFF FourCCs for audio to CodecID. 2016 */ 2017 const struct AVCodecTag *avformat_get_riff_audio_tags(void); 2018 /** 2019 * @} 2020 */ 2021 2022 /** 2023 * @} 2024 */ 2025 2026 #endif /* AVFORMAT_AVFORMAT_H */ 2027