1 /* 2 * copyright (c) 2001 Fabrice Bellard 3 * 4 * This file is part of FFmpeg. 5 * 6 * FFmpeg is free software; you can redistribute it and/or 7 * modify it under the terms of the GNU Lesser General Public 8 * License as published by the Free Software Foundation; either 9 * version 2.1 of the License, or (at your option) any later version. 10 * 11 * FFmpeg is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 * Lesser General Public License for more details. 15 * 16 * You should have received a copy of the GNU Lesser General Public 17 * License along with FFmpeg; if not, write to the Free Software 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 19 */ 20 21 module ffmpeg.libavformat.avformat; 22 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 Libavformat 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 * @section lavf_options Passing options to (de)muxers 70 * It is possible to configure lavf muxers and demuxers using the @ref avoptions 71 * mechanism. Generic (format-independent) libavformat options are provided by 72 * AVFormatContext, they can be examined from a user program by calling 73 * av_opt_next() / av_opt_find() on an allocated AVFormatContext (or its AVClass 74 * from avformat_get_class()). Private (format-specific) options are provided by 75 * AVFormatContext.priv_data if and only if AVInputFormat.priv_class / 76 * AVOutputFormat.priv_class of the corresponding format struct is non-NULL. 77 * Further options may be provided by the @ref AVFormatContext.pb "I/O context", 78 * if its AVClass is non-NULL, and the protocols layer. See the discussion on 79 * nesting in @ref avoptions documentation to learn how to access those. 80 * 81 * @section urls 82 * URL strings in libavformat are made of a scheme/protocol, a ':', and a 83 * scheme specific string. URLs without a scheme and ':' used for local files 84 * are supported but deprecated. "file:" should be used for local files. 85 * 86 * It is important that the scheme string is not taken from untrusted 87 * sources without checks. 88 * 89 * Note that some schemes/protocols are quite powerful, allowing access to 90 * both local and remote files, parts of them, concatenations of them, local 91 * audio and video devices and so on. 92 * 93 * @defgroup lavf_decoding Demuxing 94 * @{ 95 * Demuxers read a media file and split it into chunks of data (@em packets). A 96 * @ref AVPacket "packet" contains one or more encoded frames which belongs to a 97 * single elementary stream. In the lavf API this process is represented by the 98 * avformat_open_input() function for opening a file, av_read_frame() for 99 * reading a single packet and finally avformat_close_input(), which does the 100 * cleanup. 101 * 102 * @section lavf_decoding_open Opening a media file 103 * The minimum information required to open a file is its URL, which 104 * is passed to avformat_open_input(), as in the following code: 105 * @code 106 * const char *url = "file:in.mp3"; 107 * AVFormatContext *s = NULL; 108 * int ret = avformat_open_input(&s, url, NULL, NULL); 109 * if (ret < 0) 110 * abort(); 111 * @endcode 112 * The above code attempts to allocate an AVFormatContext, open the 113 * specified file (autodetecting the format) and read the header, exporting the 114 * information stored there into s. Some formats do not have a header or do not 115 * store enough information there, so it is recommended that you call the 116 * avformat_find_stream_info() function which tries to read and decode a few 117 * frames to find missing information. 118 * 119 * In some cases you might want to preallocate an AVFormatContext yourself with 120 * avformat_alloc_context() and do some tweaking on it before passing it to 121 * avformat_open_input(). One such case is when you want to use custom functions 122 * for reading input data instead of lavf internal I/O layer. 123 * To do that, create your own AVIOContext with avio_alloc_context(), passing 124 * your reading callbacks to it. Then set the @em pb field of your 125 * AVFormatContext to newly created AVIOContext. 126 * 127 * Since the format of the opened file is in general not known until after 128 * avformat_open_input() has returned, it is not possible to set demuxer private 129 * options on a preallocated context. Instead, the options should be passed to 130 * avformat_open_input() wrapped in an AVDictionary: 131 * @code 132 * AVDictionary *options = NULL; 133 * av_dict_set(&options, "video_size", "640x480", 0); 134 * av_dict_set(&options, "pixel_format", "rgb24", 0); 135 * 136 * if (avformat_open_input(&s, url, NULL, &options) < 0) 137 * abort(); 138 * av_dict_free(&options); 139 * @endcode 140 * This code passes the private options 'video_size' and 'pixel_format' to the 141 * demuxer. They would be necessary for e.g. the rawvideo demuxer, since it 142 * cannot know how to interpret raw video data otherwise. If the format turns 143 * out to be something different than raw video, those options will not be 144 * recognized by the demuxer and therefore will not be applied. Such unrecognized 145 * options are then returned in the options dictionary (recognized options are 146 * consumed). The calling program can handle such unrecognized options as it 147 * wishes, e.g. 148 * @code 149 * AVDictionaryEntry *e; 150 * if (e = av_dict_get(options, "", NULL, AV_DICT_IGNORE_SUFFIX)) { 151 * fprintf(stderr, "Option %s not recognized by the demuxer.\n", e->key); 152 * abort(); 153 * } 154 * @endcode 155 * 156 * After you have finished reading the file, you must close it with 157 * avformat_close_input(). It will free everything associated with the file. 158 * 159 * @section lavf_decoding_read Reading from an opened file 160 * Reading data from an opened AVFormatContext is done by repeatedly calling 161 * av_read_frame() on it. Each call, if successful, will return an AVPacket 162 * containing encoded data for one AVStream, identified by 163 * AVPacket.stream_index. This packet may be passed straight into the libavcodec 164 * decoding functions avcodec_send_packet() or avcodec_decode_subtitle2() if the 165 * caller wishes to decode the data. 166 * 167 * AVPacket.pts, AVPacket.dts and AVPacket.duration timing information will be 168 * set if known. They may also be unset (i.e. AV_NOPTS_VALUE for 169 * pts/dts, 0 for duration) if the stream does not provide them. The timing 170 * information will be in AVStream.time_base units, i.e. it has to be 171 * multiplied by the timebase to convert them to seconds. 172 * 173 * If AVPacket.buf is set on the returned packet, then the packet is 174 * allocated dynamically and the user may keep it indefinitely. 175 * Otherwise, if AVPacket.buf is NULL, the packet data is backed by a 176 * static storage somewhere inside the demuxer and the packet is only valid 177 * until the next av_read_frame() call or closing the file. If the caller 178 * requires a longer lifetime, av_dup_packet() will make an av_malloc()ed copy 179 * of it. 180 * In both cases, the packet must be freed with av_packet_unref() when it is no 181 * longer needed. 182 * 183 * @section lavf_decoding_seek Seeking 184 * @} 185 * 186 * @defgroup lavf_encoding Muxing 187 * @{ 188 * Muxers take encoded data in the form of @ref AVPacket "AVPackets" and write 189 * it into files or other output bytestreams in the specified container format. 190 * 191 * The main API functions for muxing are avformat_write_header() for writing the 192 * file header, av_write_frame() / av_interleaved_write_frame() for writing the 193 * packets and av_write_trailer() for finalizing the file. 194 * 195 * At the beginning of the muxing process, the caller must first call 196 * avformat_alloc_context() to create a muxing context. The caller then sets up 197 * the muxer by filling the various fields in this context: 198 * 199 * - The @ref AVFormatContext.oformat "oformat" field must be set to select the 200 * muxer that will be used. 201 * - Unless the format is of the AVFMT_NOFILE type, the @ref AVFormatContext.pb 202 * "pb" field must be set to an opened IO context, either returned from 203 * avio_open2() or a custom one. 204 * - Unless the format is of the AVFMT_NOSTREAMS type, at least one stream must 205 * be created with the avformat_new_stream() function. The caller should fill 206 * the @ref AVStream.codecpar "stream codec parameters" information, such as the 207 * codec @ref AVCodecParameters.codec_type "type", @ref AVCodecParameters.codec_id 208 * "id" and other parameters (e.g. width / height, the pixel or sample format, 209 * etc.) as known. The @ref AVStream.time_base "stream timebase" should 210 * be set to the timebase that the caller desires to use for this stream (note 211 * that the timebase actually used by the muxer can be different, as will be 212 * described later). 213 * - It is advised to manually initialize only the relevant fields in 214 * AVCodecParameters, rather than using @ref avcodec_parameters_copy() during 215 * remuxing: there is no guarantee that the codec context values remain valid 216 * for both input and output format contexts. 217 * - The caller may fill in additional information, such as @ref 218 * AVFormatContext.metadata "global" or @ref AVStream.metadata "per-stream" 219 * metadata, @ref AVFormatContext.chapters "chapters", @ref 220 * AVFormatContext.programs "programs", etc. as described in the 221 * AVFormatContext documentation. Whether such information will actually be 222 * stored in the output depends on what the container format and the muxer 223 * support. 224 * 225 * When the muxing context is fully set up, the caller must call 226 * avformat_write_header() to initialize the muxer internals and write the file 227 * header. Whether anything actually is written to the IO context at this step 228 * depends on the muxer, but this function must always be called. Any muxer 229 * private options must be passed in the options parameter to this function. 230 * 231 * The data is then sent to the muxer by repeatedly calling av_write_frame() or 232 * av_interleaved_write_frame() (consult those functions' documentation for 233 * discussion on the difference between them; only one of them may be used with 234 * a single muxing context, they should not be mixed). Do note that the timing 235 * information on the packets sent to the muxer must be in the corresponding 236 * AVStream's timebase. That timebase is set by the muxer (in the 237 * avformat_write_header() step) and may be different from the timebase 238 * requested by the caller. 239 * 240 * Once all the data has been written, the caller must call av_write_trailer() 241 * to flush any buffered packets and finalize the output file, then close the IO 242 * context (if any) and finally free the muxing context with 243 * avformat_free_context(). 244 * @} 245 * 246 * @defgroup lavf_io I/O Read/Write 247 * @{ 248 * @section lavf_io_dirlist Directory listing 249 * The directory listing API makes it possible to list files on remote servers. 250 * 251 * Some of possible use cases: 252 * - an "open file" dialog to choose files from a remote location, 253 * - a recursive media finder providing a player with an ability to play all 254 * files from a given directory. 255 * 256 * @subsection lavf_io_dirlist_open Opening a directory 257 * At first, a directory needs to be opened by calling avio_open_dir() 258 * supplied with a URL and, optionally, ::AVDictionary containing 259 * protocol-specific parameters. The function returns zero or positive 260 * integer and allocates AVIODirContext on success. 261 * 262 * @code 263 * AVIODirContext *ctx = NULL; 264 * if (avio_open_dir(&ctx, "smb://example.com/some_dir", NULL) < 0) { 265 * fprintf(stderr, "Cannot open directory.\n"); 266 * abort(); 267 * } 268 * @endcode 269 * 270 * This code tries to open a sample directory using smb protocol without 271 * any additional parameters. 272 * 273 * @subsection lavf_io_dirlist_read Reading entries 274 * Each directory's entry (i.e. file, another directory, anything else 275 * within ::AVIODirEntryType) is represented by AVIODirEntry. 276 * Reading consecutive entries from an opened AVIODirContext is done by 277 * repeatedly calling avio_read_dir() on it. Each call returns zero or 278 * positive integer if successful. Reading can be stopped right after the 279 * NULL entry has been read -- it means there are no entries left to be 280 * read. The following code reads all entries from a directory associated 281 * with ctx and prints their names to standard output. 282 * @code 283 * AVIODirEntry *entry = NULL; 284 * for (;;) { 285 * if (avio_read_dir(ctx, &entry) < 0) { 286 * fprintf(stderr, "Cannot list directory.\n"); 287 * abort(); 288 * } 289 * if (!entry) 290 * break; 291 * printf("%s\n", entry->name); 292 * avio_free_directory_entry(&entry); 293 * } 294 * @endcode 295 * @} 296 * 297 * @defgroup lavf_codec Demuxers 298 * @{ 299 * @defgroup lavf_codec_native Native Demuxers 300 * @{ 301 * @} 302 * @defgroup lavf_codec_wrappers External library wrappers 303 * @{ 304 * @} 305 * @} 306 * @defgroup lavf_protos I/O Protocols 307 * @{ 308 * @} 309 * @defgroup lavf_internal Internal 310 * @{ 311 * @} 312 * @} 313 */ 314 import std.stdint; 315 import std.bitmanip; 316 import std.stdio; 317 import core.vararg; 318 import ffmpeg.libavutil.avutil; 319 import ffmpeg.libavutil.dict; 320 import ffmpeg.libavutil.frame; 321 import ffmpeg.libavcodec.avcodec; 322 import ffmpeg.libavformat.avio; 323 import ffmpeg.libavformat.internal; 324 import ffmpeg.libavdevice.avdevice; 325 import ffmpeg.libavformat.avformat_version; 326 import ffmpeg.libavcodec.avcodec_version; 327 import ffmpeg.libavcodec.avcodec; 328 @nogc nothrow extern(C): 329 /** 330 * @defgroup metadata_api Public Metadata API 331 * @{ 332 * @ingroup libavf 333 * The metadata API allows libavformat to export metadata tags to a client 334 * application when demuxing. Conversely it allows a client application to 335 * set metadata when muxing. 336 * 337 * Metadata is exported or set as pairs of key/value strings in the 'metadata' 338 * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs 339 * using the @ref lavu_dict "AVDictionary" API. Like all strings in FFmpeg, 340 * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata 341 * exported by demuxers isn't checked to be valid UTF-8 in most cases. 342 * 343 * Important concepts to keep in mind: 344 * - Keys are unique; there can never be 2 tags with the same key. This is 345 * also meant semantically, i.e., a demuxer should not knowingly produce 346 * several keys that are literally different but semantically identical. 347 * E.g., key=Author5, key=Author6. In this example, all authors must be 348 * placed in the same tag. 349 * - Metadata is flat, not hierarchical; there are no subtags. If you 350 * want to store, e.g., the email address of the child of producer Alice 351 * and actor Bob, that could have key=alice_and_bobs_childs_email_address. 352 * - Several modifiers can be applied to the tag name. This is done by 353 * appending a dash character ('-') and the modifier name in the order 354 * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng. 355 * - language -- a tag whose value is localized for a particular language 356 * is appended with the ISO 639-2/B 3-letter language code. 357 * For example: Author-ger=Michael, Author-eng=Mike 358 * The original/default language is in the unqualified "Author" tag. 359 * A demuxer should set a default if it sets any translated tag. 360 * - sorting -- a modified version of a tag that should be used for 361 * sorting will have '-sort' appended. E.g. artist="The Beatles", 362 * artist-sort="Beatles, The". 363 * - Some protocols and demuxers support metadata updates. After a successful 364 * call to av_read_packet(), AVFormatContext.event_flags or AVStream.event_flags 365 * will be updated to indicate if metadata changed. In order to detect metadata 366 * changes on a stream, you need to loop through all streams in the AVFormatContext 367 * and check their individual event_flags. 368 * 369 * - Demuxers attempt to export metadata in a generic format, however tags 370 * with no generic equivalents are left as they are stored in the container. 371 * Follows a list of generic tag names: 372 * 373 @verbatim 374 album -- name of the set this work belongs to 375 album_artist -- main creator of the set/album, if different from artist. 376 e.g. "Various Artists" for compilation albums. 377 artist -- main creator of the work 378 comment -- any additional description of the file. 379 composer -- who composed the work, if different from artist. 380 copyright -- name of copyright holder. 381 creation_time-- date when the file was created, preferably in ISO 8601. 382 date -- date when the work was created, preferably in ISO 8601. 383 disc -- number of a subset, e.g. disc in a multi-disc collection. 384 encoder -- name/settings of the software/hardware that produced the file. 385 encoded_by -- person/group who created the file. 386 filename -- original name of the file. 387 genre -- <self-evident>. 388 language -- main language in which the work is performed, preferably 389 in ISO 639-2 format. Multiple languages can be specified by 390 separating them with commas. 391 performer -- artist who performed the work, if different from artist. 392 E.g for "Also sprach Zarathustra", artist would be "Richard 393 Strauss" and performer "London Philharmonic Orchestra". 394 publisher -- name of the label/publisher. 395 service_name -- name of the service in broadcasting (channel name). 396 service_provider -- name of the service provider in broadcasting. 397 title -- name of the work. 398 track -- number of this work in the set, can be in form current/total. 399 variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of 400 @endverbatim 401 * 402 * Look in the examples section for an application example how to use the Metadata API. 403 * 404 * @} 405 */ 406 407 /* packet functions */ 408 409 410 /** 411 * Allocate and read the payload of a packet and initialize its 412 * fields with default values. 413 * 414 * @param s associated IO context 415 * @param pkt packet 416 * @param size desired payload size 417 * @return >0 (read size) if OK, AVERROR_xxx otherwise 418 */ 419 int av_get_packet(AVIOContext *s, AVPacket *pkt, int size); 420 421 422 /** 423 * Read data and append it to the current content of the AVPacket. 424 * If pkt->size is 0 this is identical to av_get_packet. 425 * Note that this uses av_grow_packet and thus involves a realloc 426 * which is inefficient. Thus this function should only be used 427 * when there is no reasonable way to know (an upper bound of) 428 * the final size. 429 * 430 * @param s associated IO context 431 * @param pkt packet 432 * @param size amount of data to read 433 * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data 434 * will not be lost even if an error occurs. 435 */ 436 int av_append_packet(AVIOContext *s, AVPacket *pkt, int size); 437 438 static if (FF_API_LAVF_FRAC) { 439 /*************************************************/ 440 /* fractional numbers for exact pts handling */ 441 442 /** 443 * The exact value of the fractional number is: 'val + num / den'. 444 * num is assumed to be 0 <= num < den. 445 */ 446 struct AVFrac { 447 int64_t val, num, den; 448 } 449 } 450 451 /*************************************************/ 452 /* input/output formats */ 453 454 struct AVCodecTag; 455 456 /** 457 * This structure contains the data a format has to probe a file. 458 */ 459 struct AVProbeData { 460 const char *filename; 461 ubyte *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */ 462 int buf_size; /**< Size of buf except extra allocated bytes */ 463 uint8_t *mime_type; /**< mime_type, when known. */ 464 } 465 466 enum AVPROBE_SCORE_RETRY = (AVPROBE_SCORE_MAX/4); 467 enum AVPROBE_SCORE_STREAM_RETRY=(AVPROBE_SCORE_MAX/4-1); 468 469 enum AVPROBE_SCORE_EXTENSION= 50; ///< score for file extension 470 enum AVPROBE_SCORE_MIME = 75; ///< score for file mime type 471 enum AVPROBE_SCORE_MAX = 100; ///< maximum score 472 473 enum AVPROBE_PADDING_SIZE = 32; ///< extra allocated bytes at the end of the probe buffer 474 475 /// Demuxer will use avio_open, no opened file should be provided by the caller. 476 enum AVFMT_NOFILE = 0x0001; 477 enum AVFMT_NEEDNUMBER = 0x0002; /**< Needs '%d' in filename. */ 478 enum AVFMT_SHOW_IDS = 0x0008; /**< Show format stream IDs numbers. */ 479 static if(FF_API_LAVF_FMT_RAWPICTURE){ 480 enum AVFMT_RAWPICTURE = 0x0020; /**< Format wants AVPicture structure for 481 raw picture data. */ 482 } 483 enum AVFMT_GLOBALHEADER= 0x0040; /**< Format wants global header. */ 484 enum AVFMT_NOTIMESTAMPS= 0x0080; /**< Format does not need / have any timestamps. */ 485 enum AVFMT_GENERIC_INDEX=0x0100; /**< Use generic index building code. */ 486 enum AVFMT_TS_DISCONT = 0x0200; /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */ 487 enum AVFMT_VARIABLE_FPS= 0x0400; /**< Format allows variable fps. */ 488 enum AVFMT_NODIMENSIONS= 0x0800; /**< Format does not need width/height */ 489 enum AVFMT_NOSTREAMS = 0x1000; /**< Format does not require any streams */ 490 enum AVFMT_NOBINSEARCH = 0x2000; /**< Format does not allow to fallback to binary search via read_timestamp */ 491 enum AVFMT_NOGENSEARCH = 0x4000; /**< Format does not allow to fallback to generic search */ 492 enum AVFMT_NO_BYTE_SEEK= 0x8000; /**< Format does not allow seeking by bytes */ 493 enum AVFMT_ALLOW_FLUSH =0x10000; /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */ 494 enum AVFMT_TS_NONSTRICT=0x20000; /**< Format does not require strictly 495 increasing timestamps, but they must 496 still be monotonic */ 497 enum AVFMT_TS_NEGATIVE =0x40000; /**< Format allows muxing negative 498 timestamps. If not set the timestamp 499 will be shifted in av_write_frame and 500 av_interleaved_write_frame so they 501 start from 0. 502 The user or muxer can override this through 503 AVFormatContext.avoid_negative_ts 504 */ 505 506 enum AVFMT_SEEK_TO_PTS = 0x4000000; /**< Seeking is based on PTS */ 507 508 /** 509 * @addtogroup lavf_encoding 510 * @{ 511 */ 512 struct AVOutputFormat { 513 const char *name; 514 /** 515 * Descriptive name for the format, meant to be more human-readable 516 * than name. You should use the NULL_IF_CONFIG_SMALL() macro 517 * to define it. 518 */ 519 const char *long_name; 520 const char *mime_type; 521 const char *extensions; /**< comma-separated filename extensions */ 522 /* output support */ 523 AVCodecID audio_codec; /**< default audio codec */ 524 AVCodecID video_codec; /**< default video codec */ 525 AVCodecID subtitle_codec; /**< default subtitle codec */ 526 /** 527 * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_RAWPICTURE, 528 * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS, 529 * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH, 530 * AVFMT_TS_NONSTRICT 531 */ 532 int flags; 533 534 /** 535 * List of supported codec_id-codec_tag pairs, ordered by "better 536 * choice first". The arrays are all terminated by AV_CODEC_ID_NONE. 537 */ 538 const AVCodecTag **codec_tag; 539 540 541 const AVClass *priv_class; ///< AVClass for the private context 542 543 /***************************************************************** 544 * No fields below this line are part of the public API. They 545 * may not be used outside of libavformat and can be changed and 546 * removed at will. 547 * New public fields should be added right above. 548 ***************************************************************** 549 */ 550 AVOutputFormat *next; 551 /** 552 * size of private data so that it can be allocated in the wrapper 553 */ 554 int priv_data_size; 555 556 int function(AVFormatContext *) write_header; 557 /** 558 * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags, 559 * pkt can be NULL in order to flush data buffered in the muxer. 560 * When flushing, return 0 if there still is more data to flush, 561 * or 1 if everything was flushed and there is no more buffered 562 * data. 563 */ 564 int function(AVFormatContext *, AVPacket *pkt) write_packet; 565 int function(AVFormatContext *) write_trailer; 566 /** 567 * Currently only used to set pixel format if not YUV420P. 568 */ 569 int function(AVFormatContext *, AVPacket *out_pkt, 570 AVPacket *in_pkt, int flush) interleave_packet; 571 /** 572 * Test if the given codec can be stored in this container. 573 * 574 * @return 1 if the codec is supported, 0 if it is not. 575 * A negative number if unknown. 576 * MKTAG('A', 'P', 'I', 'C') if the codec is only supported as AV_DISPOSITION_ATTACHED_PIC 577 */ 578 int function(AVCodecID id, int std_compliance) query_codec; 579 580 void function (AVFormatContext *s, int stream, 581 int64_t *dts, int64_t *wall) get_output_timestamp; 582 /** 583 * Allows sending messages from application to device. 584 */ 585 int function(AVFormatContext *s, int type, 586 void *data, size_t data_size) control_message; 587 588 /** 589 * Write an uncoded AVFrame. 590 * 591 * See av_write_uncoded_frame() for details. 592 * 593 * The library will free *frame afterwards, but the muxer can prevent it 594 * by setting the pointer to NULL. 595 */ 596 int function(AVFormatContext *, int stream_index, 597 AVFrame **frame, uint flags) write_uncoded_frame; 598 /** 599 * Returns device list with it properties. 600 * @see avdevice_list_devices() for more details. 601 */ 602 int function(AVFormatContext *s, AVDeviceInfoList *device_list) get_device_list; 603 /** 604 * Initialize device capabilities submodule. 605 * @see avdevice_capabilities_create() for more details. 606 */ 607 int function(AVFormatContext *s, AVDeviceCapabilitiesQuery *caps) create_device_capabilities; 608 /** 609 * Free device capabilities submodule. 610 * @see avdevice_capabilities_free() for more details. 611 */ 612 int function(AVFormatContext *s, AVDeviceCapabilitiesQuery *caps) free_device_capabilities; 613 AVCodecID data_codec; /**< default data codec */ 614 /** 615 * Initialize format. May allocate data here, and set any AVFormatContext or 616 * AVStream parameters that need to be set before packets are sent. 617 * This method must not write output. 618 * 619 * Any allocations made here must be freed in deinit(). 620 */ 621 int function(AVFormatContext *) init; 622 /** 623 * Deinitialize format. If present, this is called whenever the muxer is being 624 * destroyed, regardless of whether or not the header has been written. 625 * 626 * If a trailer is being written, this is called after write_trailer(). 627 * 628 * This is called if init() fails as well. 629 */ 630 void function(AVFormatContext *) deinit; 631 /** 632 * Set up any necessary bitstream filtering and extract any extra data needed 633 * for the global header. 634 * Return 0 if more packets from this stream must be checked; 1 if not. 635 */ 636 int function(AVFormatContext *, const AVPacket *pkt) check_bitstream; 637 } 638 /** 639 * @} 640 */ 641 642 /** 643 * @addtogroup lavf_decoding 644 * @{ 645 */ 646 struct AVInputFormat { 647 /** 648 * A comma separated list of short names for the format. New names 649 * may be appended with a minor bump. 650 */ 651 const char *name; 652 653 /** 654 * Descriptive name for the format, meant to be more human-readable 655 * than name. You should use the NULL_IF_CONFIG_SMALL() macro 656 * to define it. 657 */ 658 const char *long_name; 659 660 /** 661 * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS, 662 * AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH, 663 * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK, AVFMT_SEEK_TO_PTS. 664 */ 665 int flags; 666 667 /** 668 * If extensions are defined, then no probe is done. You should 669 * usually not use extension format guessing because it is not 670 * reliable enough 671 */ 672 const char *extensions; 673 674 const AVCodecTag **codec_tag; 675 676 const AVClass *priv_class; ///< AVClass for the private context 677 678 /** 679 * Comma-separated list of mime types. 680 * It is used check for matching mime types while probing. 681 * @see av_probe_input_format2 682 */ 683 const char *mime_type; 684 685 /***************************************************************** 686 * No fields below this line are part of the public API. They 687 * may not be used outside of libavformat and can be changed and 688 * removed at will. 689 * New public fields should be added right above. 690 ***************************************************************** 691 */ 692 AVInputFormat *next; 693 694 /** 695 * Raw demuxers store their codec ID here. 696 */ 697 int raw_codec_id; 698 699 /** 700 * Size of private data so that it can be allocated in the wrapper. 701 */ 702 int priv_data_size; 703 704 /** 705 * Tell if a given file has a chance of being parsed as this format. 706 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes 707 * big so you do not have to check for that unless you need more. 708 */ 709 int function(AVProbeData *) read_probe; 710 711 /** 712 * Read the format header and initialize the AVFormatContext 713 * structure. Return 0 if OK. Only used in raw format right 714 * now. 'avformat_new_stream' should be called to create new streams. 715 */ 716 int function(AVFormatContext *) read_header; 717 718 /** 719 * Read one packet and put it in 'pkt'. pts and flags are also 720 * set. 'avformat_new_stream' can be called only if the flag 721 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a 722 * background thread). 723 * @return 0 on success, < 0 on error. 724 * When returning an error, pkt must not have been allocated 725 * or must be freed before returning 726 */ 727 int function(AVFormatContext *, AVPacket *pkt) read_packet; 728 729 /** 730 * Close the stream. The AVFormatContext and AVStreams are not 731 * freed by this function 732 */ 733 int function(AVFormatContext *) read_close; 734 735 /** 736 * Seek to a given timestamp relative to the frames in 737 * stream component stream_index. 738 * @param stream_index Must not be -1. 739 * @param flags Selects which direction should be preferred if no exact 740 * match is available. 741 * @return >= 0 on success (but not necessarily the new offset) 742 */ 743 int function(AVFormatContext *, 744 int stream_index, int64_t timestamp, int flags) read_seek; 745 746 /** 747 * Get the next timestamp in stream[stream_index].time_base units. 748 * @return the timestamp or AV_NOPTS_VALUE if an error occurred 749 */ 750 int64_t function(AVFormatContext *s, int stream_index, 751 int64_t *pos, int64_t pos_limit) read_timestamp; 752 753 /** 754 * Start/resume playing - only meaningful if using a network-based format 755 * (RTSP). 756 */ 757 int function(AVFormatContext *) read_play; 758 759 /** 760 * Pause playing - only meaningful if using a network-based format 761 * (RTSP). 762 */ 763 int function(AVFormatContext *) read_pause; 764 765 /** 766 * Seek to timestamp ts. 767 * Seeking will be done so that the point from which all active streams 768 * can be presented successfully will be closest to ts and within min/max_ts. 769 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. 770 */ 771 int function(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags) read_seek2; 772 773 /** 774 * Returns device list with it properties. 775 * @see avdevice_list_devices() for more details. 776 */ 777 int function(AVFormatContext *s, AVDeviceInfoList *device_list) get_device_list; 778 779 /** 780 * Initialize device capabilities submodule. 781 * @see avdevice_capabilities_create() for more details. 782 */ 783 int function(AVFormatContext *s, AVDeviceCapabilitiesQuery *caps) create_device_capabilities; 784 785 /** 786 * Free device capabilities submodule. 787 * @see avdevice_capabilities_free() for more details. 788 */ 789 int function(AVFormatContext *s, AVDeviceCapabilitiesQuery *caps) free_device_capabilities; 790 } 791 /** 792 * @} 793 */ 794 795 enum AVStreamParseType:int { 796 AVSTREAM_PARSE_NONE, 797 AVSTREAM_PARSE_FULL, /**< full parsing and repack */ 798 AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */ 799 AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */ 800 AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */ 801 AVSTREAM_PARSE_FULL_RAW=MKTAG!(0,'R','A','W') /**< full parsing and repack with timestamp and position generation by parser for raw 802 this assumes that each packet in the file contains no demuxer level headers and 803 just codec level data, otherwise position generation would fail */ 804 } 805 806 struct AVIndexEntry { 807 int64_t pos; 808 int64_t timestamp; /**< 809 * Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are available 810 * when seeking to this entry. That means preferable PTS on keyframe based formats. 811 * But demuxers can choose to store a different timestamp, if it is more convenient for the implementation or nothing better 812 * is known 813 */ 814 //#define AVINDEX_KEYFRAME 0x0001 815 extern(D){ 816 mixin( bitfields!( int, "flags", 2, 817 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). 818 } 819 int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */ 820 } 821 822 enum AV_DISPOSITION_DEFAULT = 0x0001; 823 enum AV_DISPOSITION_DUB = 0x0002; 824 enum AV_DISPOSITION_ORIGINAL= 0x0004; 825 enum AV_DISPOSITION_COMMENT = 0x0008; 826 enum AV_DISPOSITION_LYRICS = 0x0010; 827 enum AV_DISPOSITION_KARAOKE = 0x0020; 828 829 /** 830 * Track should be used during playback by default. 831 * Useful for subtitle track that should be displayed 832 * even when user did not explicitly ask for subtitles. 833 */ 834 enum AV_DISPOSITION_FORCED = 0x0040; 835 enum AV_DISPOSITION_HEARING_IMPAIRED =0x0080; /**< stream for hearing impaired audiences */ 836 enum AV_DISPOSITION_VISUAL_IMPAIRED =0x0100; /**< stream for visual impaired audiences */ 837 enum AV_DISPOSITION_CLEAN_EFFECTS =0x0200; /**< stream without voice */ 838 /** 839 * The stream is stored in the file as an attached picture/"cover art" (e.g. 840 * APIC frame in ID3v2). The single packet associated with it will be returned 841 * among the first few packets read from the file unless seeking takes place. 842 * It can also be accessed at any time in AVStream.attached_pic. 843 */ 844 enum AV_DISPOSITION_ATTACHED_PIC =0x0400; 845 846 struct AVStreamInternal; 847 848 /** 849 * To specify text track kind (different from subtitles default). 850 */ 851 enum AV_DISPOSITION_CAPTIONS =0x10000; 852 enum AV_DISPOSITION_DESCRIPTIONS=0x20000; 853 enum AV_DISPOSITION_METADATA =0x40000; 854 855 /** 856 * Options for behavior on timestamp wrap detection. 857 */ 858 enum AV_PTS_WRAP_IGNORE = 0; ///< ignore the wrap 859 enum AV_PTS_WRAP_ADD_OFFSET = 1; ///< add the format specific offset on wrap detection 860 enum AV_PTS_WRAP_SUB_OFFSET = -1; ///< subtract the format specific offset on wrap detection 861 862 /** 863 * Stream structure. 864 * New fields can be added to the end with minor version bumps. 865 * Removal, reordering and changes to existing fields require a major 866 * version bump. 867 * sizeof(AVStream) must not be used outside libav*. 868 */ 869 struct AVStream { 870 int index; /**< stream index in AVFormatContext */ 871 /** 872 * Format-specific stream ID. 873 * decoding: set by libavformat 874 * encoding: set by the user, replaced by libavformat if left unset 875 */ 876 int id; 877 static if(FF_API_LAVF_AVCTX){ 878 /** 879 * @deprecated use the codecpar struct instead 880 */ 881 deprecated 882 AVCodecContext *codec; 883 } 884 void *priv_data; 885 886 static if(FF_API_LAVF_FRAC) { 887 /** 888 * @deprecated this field is unused 889 */ 890 deprecated 891 AVFrac pts; 892 } 893 894 /** 895 * This is the fundamental unit of time (in seconds) in terms 896 * of which frame timestamps are represented. 897 * 898 * decoding: set by libavformat 899 * encoding: May be set by the caller before avformat_write_header() to 900 * provide a hint to the muxer about the desired timebase. In 901 * avformat_write_header(), the muxer will overwrite this field 902 * with the timebase that will actually be used for the timestamps 903 * written into the file (which may or may not be related to the 904 * user-provided one, depending on the format). 905 */ 906 AVRational time_base; 907 908 /** 909 * Decoding: pts of the first frame of the stream in presentation order, in stream time base. 910 * Only set this if you are absolutely 100% sure that the value you set 911 * it to really is the pts of the first frame. 912 * This may be undefined (AV_NOPTS_VALUE). 913 * @note The ASF header does NOT contain a correct start_time the ASF 914 * demuxer must NOT set this. 915 */ 916 int64_t start_time; 917 918 /** 919 * Decoding: duration of the stream, in stream time base. 920 * If a source file does not specify a duration, but does specify 921 * a bitrate, this value will be estimated from bitrate and file size. 922 */ 923 int64_t duration; 924 925 int64_t nb_frames; ///< number of frames in this stream if known or 0 926 927 int disposition; /**< AV_DISPOSITION_* bit field */ 928 929 AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed. 930 931 /** 932 * sample aspect ratio (0 if unknown) 933 * - encoding: Set by user. 934 * - decoding: Set by libavformat. 935 */ 936 AVRational sample_aspect_ratio; 937 938 AVDictionary *metadata; 939 940 /** 941 * Average framerate 942 * 943 * - demuxing: May be set by libavformat when creating the stream or in 944 * avformat_find_stream_info(). 945 * - muxing: May be set by the caller before avformat_write_header(). 946 */ 947 AVRational avg_frame_rate; 948 949 /** 950 * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet 951 * will contain the attached picture. 952 * 953 * decoding: set by libavformat, must not be modified by the caller. 954 * encoding: unused 955 */ 956 AVPacket attached_pic; 957 958 /** 959 * An array of side data that applies to the whole stream (i.e. the 960 * container does not allow it to change between packets). 961 * 962 * There may be no overlap between the side data in this array and side data 963 * in the packets. I.e. a given side data is either exported by the muxer 964 * (demuxing) / set by the caller (muxing) in this array, then it never 965 * appears in the packets, or the side data is exported / sent through 966 * the packets (always in the first packet where the value becomes known or 967 * changes), then it does not appear in this array. 968 * 969 * - demuxing: Set by libavformat when the stream is created. 970 * - muxing: May be set by the caller before avformat_write_header(). 971 * 972 * Freed by libavformat in avformat_free_context(). 973 * 974 * @see av_format_inject_global_side_data() 975 */ 976 AVPacketSideData *side_data; 977 /** 978 * The number of elements in the AVStream.side_data array. 979 */ 980 int nb_side_data; 981 982 /** 983 * Flags for the user to detect events happening on the stream. Flags must 984 * be cleared by the user once the event has been handled. 985 * A combination of AVSTREAM_EVENT_FLAG_*. 986 */ 987 int event_flags; 988 //#define AVSTREAM_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata. 989 990 /***************************************************************** 991 * All fields below this line are not part of the public API. They 992 * may not be used outside of libavformat and can be changed and 993 * removed at will. 994 * New public fields should be added right above. 995 ***************************************************************** 996 */ 997 998 /** 999 * Stream information used internally by av_find_stream_info() 1000 */ 1001 //#define MAX_STD_TIMEBASES (60*12+6) 1002 struct Info { 1003 int64_t last_dts; 1004 int64_t duration_gcd; 1005 int duration_count; 1006 int64_t rfps_duration_sum; 1007 double function() [2][MAX_STD_TIMEBASES]duration_error; 1008 int64_t codec_info_duration; 1009 int64_t codec_info_duration_fields; 1010 1011 /** 1012 * 0 -> decoder has not been searched for yet. 1013 * >0 -> decoder found 1014 * <0 -> decoder with codec_id == -found_decoder has not been found 1015 */ 1016 int found_decoder; 1017 1018 int64_t last_duration; 1019 1020 /** 1021 * Those are used for average framerate estimation. 1022 */ 1023 int64_t fps_first_dts; 1024 int fps_first_dts_idx; 1025 int64_t fps_last_dts; 1026 int fps_last_dts_idx; 1027 1028 } Info* info; 1029 1030 int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */ 1031 1032 // Timestamp generation support: 1033 /** 1034 * Timestamp corresponding to the last dts sync point. 1035 * 1036 * Initialized when AVCodecParserContext.dts_sync_point >= 0 and 1037 * a DTS is received from the underlying container. Otherwise set to 1038 * AV_NOPTS_VALUE by default. 1039 */ 1040 int64_t first_dts; 1041 int64_t cur_dts; 1042 int64_t last_IP_pts; 1043 int last_IP_duration; 1044 1045 /** 1046 * Number of packets to buffer for codec probing 1047 */ 1048 int probe_packets; 1049 1050 /** 1051 * Number of frames that have been demuxed during av_find_stream_info() 1052 */ 1053 int codec_info_nb_frames; 1054 1055 /* av_read_frame() support */ 1056 AVStreamParseType need_parsing; 1057 AVCodecParserContext *parser; 1058 1059 /** 1060 * last packet in packet_buffer for this stream when muxing. 1061 */ 1062 AVPacketList *last_in_packet_buffer; 1063 AVProbeData probe_data; 1064 //#define MAX_REORDER_DELAY 16 1065 int64_t [MAX_REORDER_DELAY+1]pts_buffer; 1066 1067 AVIndexEntry *index_entries; /**< Only used if the format does not 1068 support seeking natively. */ 1069 int nb_index_entries; 1070 uint index_entries_allocated_size; 1071 1072 /** 1073 * Real base framerate of the stream. 1074 * This is the lowest framerate with which all timestamps can be 1075 * represented accurately (it is the least common multiple of all 1076 * framerates in the stream). Note, this value is just a guess! 1077 * For example, if the time base is 1/90000 and all frames have either 1078 * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1. 1079 * 1080 * Code outside avformat should access this field using: 1081 * av_stream_get/set_r_frame_rate(stream) 1082 */ 1083 AVRational r_frame_rate; 1084 1085 /** 1086 * Stream Identifier 1087 * This is the MPEG-TS stream identifier +1 1088 * 0 means unknown 1089 */ 1090 int stream_identifier; 1091 1092 int64_t interleaver_chunk_size; 1093 int64_t interleaver_chunk_duration; 1094 1095 /** 1096 * stream probing state 1097 * -1 -> probing finished 1098 * 0 -> no probing requested 1099 * rest -> perform probing with request_probe being the minimum score to accept. 1100 * NOT PART OF PUBLIC API 1101 */ 1102 int request_probe; 1103 /** 1104 * Indicates that everything up to the next keyframe 1105 * should be discarded. 1106 */ 1107 int skip_to_keyframe; 1108 1109 /** 1110 * Number of samples to skip at the start of the frame decoded from the next packet. 1111 */ 1112 int skip_samples; 1113 1114 /** 1115 * If not 0, the number of samples that should be skipped from the start of 1116 * the stream (the samples are removed from packets with pts==0, which also 1117 * assumes negative timestamps do not happen). 1118 * Intended for use with formats such as mp3 with ad-hoc gapless audio 1119 * support. 1120 */ 1121 int64_t start_skip_samples; 1122 1123 /** 1124 * If not 0, the first audio sample that should be discarded from the stream. 1125 * This is broken by design (needs global sample count), but can't be 1126 * avoided for broken by design formats such as mp3 with ad-hoc gapless 1127 * audio support. 1128 */ 1129 int64_t first_discard_sample; 1130 1131 /** 1132 * The sample after last sample that is intended to be discarded after 1133 * first_discard_sample. Works on frame boundaries only. Used to prevent 1134 * early EOF if the gapless info is broken (considered concatenated mp3s). 1135 */ 1136 int64_t last_discard_sample; 1137 1138 /** 1139 * Number of internally decoded frames, used internally in libavformat, do not access 1140 * its lifetime differs from info which is why it is not in that structure. 1141 */ 1142 int nb_decoded_frames; 1143 1144 /** 1145 * Timestamp offset added to timestamps before muxing 1146 * NOT PART OF PUBLIC API 1147 */ 1148 int64_t mux_ts_offset; 1149 1150 /** 1151 * Internal data to check for wrapping of the time stamp 1152 */ 1153 int64_t pts_wrap_reference; 1154 1155 /** 1156 * Options for behavior, when a wrap is detected. 1157 * 1158 * Defined by AV_PTS_WRAP_ values. 1159 * 1160 * If correction is enabled, there are two possibilities: 1161 * If the first time stamp is near the wrap point, the wrap offset 1162 * will be subtracted, which will create negative time stamps. 1163 * Otherwise the offset will be added. 1164 */ 1165 int pts_wrap_behavior; 1166 1167 /** 1168 * Internal data to prevent doing update_initial_durations() twice 1169 */ 1170 int update_initial_durations_done; 1171 1172 /** 1173 * Internal data to generate dts from pts 1174 */ 1175 int64_t [MAX_REORDER_DELAY+1]pts_reorder_error; 1176 uint8_t [MAX_REORDER_DELAY+1]pts_reorder_error_count; 1177 1178 /** 1179 * Internal data to analyze DTS and detect faulty mpeg streams 1180 */ 1181 int64_t last_dts_for_order_check; 1182 uint8_t dts_ordered; 1183 uint8_t dts_misordered; 1184 1185 /** 1186 * Internal data to inject global side data 1187 */ 1188 int inject_global_side_data; 1189 1190 /** 1191 * String containing paris of key and values describing recommended encoder configuration. 1192 * Paris are separated by ','. 1193 * Keys are separated from values by '='. 1194 */ 1195 char *recommended_encoder_configuration; 1196 1197 /** 1198 * display aspect ratio (0 if unknown) 1199 * - encoding: unused 1200 * - decoding: Set by libavformat to calculate sample_aspect_ratio internally 1201 */ 1202 AVRational display_aspect_ratio; 1203 1204 FFFrac *priv_pts; 1205 1206 /** 1207 * An opaque field for libavformat internal usage. 1208 * Must not be accessed in any way by callers. 1209 */ 1210 AVStreamInternal *internal; 1211 1212 /* 1213 * Codec parameters associated with this stream. Allocated and freed by 1214 * libavformat in avformat_new_stream() and avformat_free_context() 1215 * respectively. 1216 * 1217 * - demuxing: filled by libavformat on stream creation or in 1218 * avformat_find_stream_info() 1219 * - muxing: filled by the caller before avformat_write_header() 1220 */ 1221 AVCodecParameters *codecpar; 1222 } 1223 1224 AVRational av_stream_get_r_frame_rate(const AVStream *s); 1225 void av_stream_set_r_frame_rate(AVStream *s, AVRational r); 1226 AVCodecParserContext *av_stream_get_parser(const AVStream *s); 1227 char* av_stream_get_recommended_encoder_configuration(const AVStream *s); 1228 void av_stream_set_recommended_encoder_configuration(AVStream *s, char *configuration); 1229 1230 /** 1231 * Returns the pts of the last muxed packet + its duration 1232 * 1233 * the retuned value is undefined when used with a demuxer. 1234 */ 1235 int64_t av_stream_get_end_pts(const AVStream *st); 1236 1237 enum AV_PROGRAM_RUNNING=1; 1238 1239 /** 1240 * New fields can be added to the end with minor version bumps. 1241 * Removal, reordering and changes to existing fields require a major 1242 * version bump. 1243 * sizeof(AVProgram) must not be used outside libav*. 1244 */ 1245 struct AVProgram { 1246 int id; 1247 int flags; 1248 AVDiscard discard; ///< selects which program to discard and which to feed to the caller 1249 uint *stream_index; 1250 uint nb_stream_indexes; 1251 AVDictionary *metadata; 1252 1253 int program_num; 1254 int pmt_pid; 1255 int pcr_pid; 1256 1257 /***************************************************************** 1258 * All fields below this line are not part of the public API. They 1259 * may not be used outside of libavformat and can be changed and 1260 * removed at will. 1261 * New public fields should be added right above. 1262 ***************************************************************** 1263 */ 1264 int64_t start_time; 1265 int64_t end_time; 1266 1267 int64_t pts_wrap_reference; ///< reference dts for wrap detection 1268 int pts_wrap_behavior; ///< behavior on wrap detection 1269 } 1270 1271 enum AVFMTCTX_NOHEADER = 0x0001; /**< signal that no header is present 1272 (streams are added dynamically) */ 1273 1274 struct AVChapter { 1275 int id; ///< unique ID to identify the chapter 1276 AVRational time_base; ///< time base in which the start/end timestamps are specified 1277 int64_t start, end; ///< chapter start/end time in time_base units 1278 AVDictionary *metadata; 1279 } 1280 1281 1282 /** 1283 * Callback used by devices to communicate with application. 1284 */ 1285 alias av_format_control_message = int function( AVFormatContext *s, int type, 1286 void *data, size_t data_size); 1287 1288 alias AVOpenCallback = int function(AVFormatContext *s, AVIOContext **pb, const char *url, int flags, 1289 const AVIOInterruptCB *int_cb, AVDictionary **options); 1290 1291 /** 1292 * The duration of a video can be estimated through various ways, and this enum can be used 1293 * to know how the duration was estimated. 1294 */ 1295 enum AVDurationEstimationMethod { 1296 AVFMT_DURATION_FROM_PTS, ///< Duration accurately estimated from PTSes 1297 AVFMT_DURATION_FROM_STREAM, ///< Duration estimated from a stream with a known duration 1298 AVFMT_DURATION_FROM_BITRATE ///< Duration estimated from bitrate (less accurate) 1299 } 1300 1301 struct AVFormatInternal; 1302 1303 /** 1304 * Format I/O context. 1305 * New fields can be added to the end with minor version bumps. 1306 * Removal, reordering and changes to existing fields require a major 1307 * version bump. 1308 * sizeof(AVFormatContext) must not be used outside libav*, use 1309 * avformat_alloc_context() to create an AVFormatContext. 1310 * 1311 * Fields can be accessed through AVOptions (av_opt*), 1312 * the name string used matches the associated command line parameter name and 1313 * can be found in libavformat/options_table.h. 1314 * The AVOption/command line parameter names differ in some cases from the C 1315 * structure field names for historic reasons or brevity. 1316 */ 1317 struct AVFormatContext { 1318 /** 1319 * A class for logging and @ref avoptions. Set by avformat_alloc_context(). 1320 * Exports (de)muxer private options if they exist. 1321 */ 1322 const AVClass *av_class; 1323 1324 /** 1325 * The input container format. 1326 * 1327 * Demuxing only, set by avformat_open_input(). 1328 */ 1329 AVInputFormat *iformat; 1330 1331 /** 1332 * The output container format. 1333 * 1334 * Muxing only, must be set by the caller before avformat_write_header(). 1335 */ 1336 AVOutputFormat *oformat; 1337 1338 /** 1339 * Format private data. This is an AVOptions-enabled struct 1340 * if and only if iformat/oformat.priv_class is not NULL. 1341 * 1342 * - muxing: set by avformat_write_header() 1343 * - demuxing: set by avformat_open_input() 1344 */ 1345 void *priv_data; 1346 1347 /** 1348 * I/O context. 1349 * 1350 * - demuxing: either set by the user before avformat_open_input() (then 1351 * the user must close it manually) or set by avformat_open_input(). 1352 * - muxing: set by the user before avformat_write_header(). The caller must 1353 * take care of closing / freeing the IO context. 1354 * 1355 * Do NOT set this field if AVFMT_NOFILE flag is set in 1356 * iformat/oformat.flags. In such a case, the (de)muxer will handle 1357 * I/O in some other way and this field will be NULL. 1358 */ 1359 AVIOContext *pb; 1360 1361 /* stream info */ 1362 /** 1363 * Flags signalling stream properties. A combination of AVFMTCTX_*. 1364 * Set by libavformat. 1365 */ 1366 int ctx_flags; 1367 1368 /** 1369 * Number of elements in AVFormatContext.streams. 1370 * 1371 * Set by avformat_new_stream(), must not be modified by any other code. 1372 */ 1373 uint nb_streams; 1374 /** 1375 * A list of all streams in the file. New streams are created with 1376 * avformat_new_stream(). 1377 * 1378 * - demuxing: streams are created by libavformat in avformat_open_input(). 1379 * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also 1380 * appear in av_read_frame(). 1381 * - muxing: streams are created by the user before avformat_write_header(). 1382 * 1383 * Freed by libavformat in avformat_free_context(). 1384 */ 1385 AVStream **streams; 1386 1387 /** 1388 * input or output filename 1389 * 1390 * - demuxing: set by avformat_open_input() 1391 * - muxing: may be set by the caller before avformat_write_header() 1392 */ 1393 char [1024]filename; 1394 1395 /** 1396 * Position of the first frame of the component, in 1397 * AV_TIME_BASE fractional seconds. NEVER set this value directly: 1398 * It is deduced from the AVStream values. 1399 * 1400 * Demuxing only, set by libavformat. 1401 */ 1402 int64_t start_time; 1403 1404 /** 1405 * Duration of the stream, in AV_TIME_BASE fractional 1406 * seconds. Only set this value if you know none of the individual stream 1407 * durations and also do not set any of them. This is deduced from the 1408 * AVStream values if not set. 1409 * 1410 * Demuxing only, set by libavformat. 1411 */ 1412 int64_t duration; 1413 1414 /** 1415 * Total stream bitrate in bit/s, 0 if not 1416 * available. Never set it directly if the file_size and the 1417 * duration are known as FFmpeg can compute it automatically. 1418 */ 1419 int64_t bit_rate; 1420 1421 uint packet_size; 1422 int max_delay; 1423 1424 /** 1425 * Flags modifying the (de)muxer behaviour. A combination of AVFMT_FLAG_*. 1426 * Set by the user before avformat_open_input() / avformat_write_header(). 1427 */ 1428 int flags; 1429 //#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames. 1430 //#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index. 1431 //#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input. 1432 //#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS 1433 //#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container 1434 //#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 1435 //#define AVFMT_FLAG_NOBUFFER 0x0040 ///< Do not buffer frames when possible 1436 //#define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it. 1437 //#define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted 1438 //#define AVFMT_FLAG_FLUSH_PACKETS 0x0200 ///< Flush the AVIOContext every packet. 1439 /** 1440 * When muxing, try to avoid writing any random/volatile data to the output. 1441 * This includes any random IDs, real-time timestamps/dates, muxer version, etc. 1442 * 1443 * This flag is mainly intended for testing. 1444 */ 1445 //#define AVFMT_FLAG_BITEXACT 0x0400 1446 //#define AVFMT_FLAG_MP4A_LATM 0x8000 ///< Enable RTP MP4A-LATM payload 1447 //#define AVFMT_FLAG_SORT_DTS 0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down) 1448 //#define AVFMT_FLAG_PRIV_OPT 0x20000 ///< Enable use of private options by delaying codec open (this could be made default once all code is converted) 1449 //#define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Don't merge side data but keep it separate. 1450 //#define AVFMT_FLAG_FAST_SEEK 0x80000 ///< Enable fast, but inaccurate seeks for some formats 1451 1452 /** 1453 * Maximum size of the data read from input for determining 1454 * the input container format. 1455 * Demuxing only, set by the caller before avformat_open_input(). 1456 */ 1457 int64_t probesize; 1458 1459 /** 1460 * Maximum duration (in AV_TIME_BASE units) of the data read 1461 * from input in avformat_find_stream_info(). 1462 * Demuxing only, set by the caller before avformat_find_stream_info(). 1463 * Can be set to 0 to let avformat choose using a heuristic. 1464 */ 1465 int64_t max_analyze_duration; 1466 1467 const uint8_t *key; 1468 int keylen; 1469 1470 uint nb_programs; 1471 AVProgram **programs; 1472 1473 /** 1474 * Forced video codec_id. 1475 * Demuxing: Set by user. 1476 */ 1477 AVCodecID video_codec_id; 1478 1479 /** 1480 * Forced audio codec_id. 1481 * Demuxing: Set by user. 1482 */ 1483 AVCodecID audio_codec_id; 1484 1485 /** 1486 * Forced subtitle codec_id. 1487 * Demuxing: Set by user. 1488 */ 1489 AVCodecID subtitle_codec_id; 1490 1491 /** 1492 * Maximum amount of memory in bytes to use for the index of each stream. 1493 * If the index exceeds this size, entries will be discarded as 1494 * needed to maintain a smaller size. This can lead to slower or less 1495 * accurate seeking (depends on demuxer). 1496 * Demuxers for which a full in-memory index is mandatory will ignore 1497 * this. 1498 * - muxing: unused 1499 * - demuxing: set by user 1500 */ 1501 uint max_index_size; 1502 1503 /** 1504 * Maximum amount of memory in bytes to use for buffering frames 1505 * obtained from realtime capture devices. 1506 */ 1507 uint max_picture_buffer; 1508 1509 /** 1510 * Number of chapters in AVChapter array. 1511 * When muxing, chapters are normally written in the file header, 1512 * so nb_chapters should normally be initialized before write_header 1513 * is called. Some muxers (e.g. mov and mkv) can also write chapters 1514 * in the trailer. To write chapters in the trailer, nb_chapters 1515 * must be zero when write_header is called and non-zero when 1516 * write_trailer is called. 1517 * - muxing: set by user 1518 * - demuxing: set by libavformat 1519 */ 1520 uint nb_chapters; 1521 AVChapter **chapters; 1522 1523 /** 1524 * Metadata that applies to the whole file. 1525 * 1526 * - demuxing: set by libavformat in avformat_open_input() 1527 * - muxing: may be set by the caller before avformat_write_header() 1528 * 1529 * Freed by libavformat in avformat_free_context(). 1530 */ 1531 AVDictionary *metadata; 1532 1533 /** 1534 * Start time of the stream in real world time, in microseconds 1535 * since the Unix epoch (00:00 1st January 1970). That is, pts=0 in the 1536 * stream was captured at this real world time. 1537 * - muxing: Set by the caller before avformat_write_header(). If set to 1538 * either 0 or AV_NOPTS_VALUE, then the current wall-time will 1539 * be used. 1540 * - demuxing: Set by libavformat. AV_NOPTS_VALUE if unknown. Note that 1541 * the value may become known after some number of frames 1542 * have been received. 1543 */ 1544 int64_t start_time_realtime; 1545 1546 /** 1547 * The number of frames used for determining the framerate in 1548 * avformat_find_stream_info(). 1549 * Demuxing only, set by the caller before avformat_find_stream_info(). 1550 */ 1551 int fps_probe_size; 1552 1553 /** 1554 * Error recognition; higher values will detect more errors but may 1555 * misdetect some more or less valid parts as errors. 1556 * Demuxing only, set by the caller before avformat_open_input(). 1557 */ 1558 int error_recognition; 1559 1560 /** 1561 * Custom interrupt callbacks for the I/O layer. 1562 * 1563 * demuxing: set by the user before avformat_open_input(). 1564 * muxing: set by the user before avformat_write_header() 1565 * (mainly useful for AVFMT_NOFILE formats). The callback 1566 * should also be passed to avio_open2() if it's used to 1567 * open the file. 1568 */ 1569 AVIOInterruptCB interrupt_callback; 1570 1571 /** 1572 * Flags to enable debugging. 1573 */ 1574 int _debug; 1575 //#define FF_FDEBUG_TS 0x0001 1576 1577 /** 1578 * Maximum buffering duration for interleaving. 1579 * 1580 * To ensure all the streams are interleaved correctly, 1581 * av_interleaved_write_frame() will wait until it has at least one packet 1582 * for each stream before actually writing any packets to the output file. 1583 * When some streams are "sparse" (i.e. there are large gaps between 1584 * successive packets), this can result in excessive buffering. 1585 * 1586 * This field specifies the maximum difference between the timestamps of the 1587 * first and the last packet in the muxing queue, above which libavformat 1588 * will output a packet regardless of whether it has queued a packet for all 1589 * the streams. 1590 * 1591 * Muxing only, set by the caller before avformat_write_header(). 1592 */ 1593 int64_t max_interleave_delta; 1594 1595 /** 1596 * Allow non-standard and experimental extension 1597 * @see AVCodecContext.strict_std_compliance 1598 */ 1599 int strict_std_compliance; 1600 1601 /** 1602 * Flags for the user to detect events happening on the file. Flags must 1603 * be cleared by the user once the event has been handled. 1604 * A combination of AVFMT_EVENT_FLAG_*. 1605 */ 1606 int event_flags; 1607 //#define AVFMT_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata. 1608 1609 /** 1610 * Maximum number of packets to read while waiting for the first timestamp. 1611 * Decoding only. 1612 */ 1613 int max_ts_probe; 1614 1615 /** 1616 * Avoid negative timestamps during muxing. 1617 * Any value of the AVFMT_AVOID_NEG_TS_* constants. 1618 * Note, this only works when using av_interleaved_write_frame. (interleave_packet_per_dts is in use) 1619 * - muxing: Set by user 1620 * - demuxing: unused 1621 */ 1622 int avoid_negative_ts; 1623 //#define AVFMT_AVOID_NEG_TS_AUTO -1 ///< Enabled when required by target format 1624 //#define AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE 1 ///< Shift timestamps so they are non negative 1625 //#define AVFMT_AVOID_NEG_TS_MAKE_ZERO 2 ///< Shift timestamps so that they start at 0 1626 1627 /** 1628 * Transport stream id. 1629 * This will be moved into demuxer private options. Thus no API/ABI compatibility 1630 */ 1631 int ts_id; 1632 1633 /** 1634 * Audio preload in microseconds. 1635 * Note, not all formats support this and unpredictable things may happen if it is used when not supported. 1636 * - encoding: Set by user via AVOptions (NO direct access) 1637 * - decoding: unused 1638 */ 1639 int audio_preload; 1640 1641 /** 1642 * Max chunk time in microseconds. 1643 * Note, not all formats support this and unpredictable things may happen if it is used when not supported. 1644 * - encoding: Set by user via AVOptions (NO direct access) 1645 * - decoding: unused 1646 */ 1647 int max_chunk_duration; 1648 1649 /** 1650 * Max chunk size in bytes 1651 * Note, not all formats support this and unpredictable things may happen if it is used when not supported. 1652 * - encoding: Set by user via AVOptions (NO direct access) 1653 * - decoding: unused 1654 */ 1655 int max_chunk_size; 1656 1657 /** 1658 * forces the use of wallclock timestamps as pts/dts of packets 1659 * This has undefined results in the presence of B frames. 1660 * - encoding: unused 1661 * - decoding: Set by user via AVOptions (NO direct access) 1662 */ 1663 int use_wallclock_as_timestamps; 1664 1665 /** 1666 * avio flags, used to force AVIO_FLAG_DIRECT. 1667 * - encoding: unused 1668 * - decoding: Set by user via AVOptions (NO direct access) 1669 */ 1670 int avio_flags; 1671 1672 /** 1673 * The duration field can be estimated through various ways, and this field can be used 1674 * to know how the duration was estimated. 1675 * - encoding: unused 1676 * - decoding: Read by user via AVOptions (NO direct access) 1677 */ 1678 AVDurationEstimationMethod duration_estimation_method; 1679 1680 /** 1681 * Skip initial bytes when opening stream 1682 * - encoding: unused 1683 * - decoding: Set by user via AVOptions (NO direct access) 1684 */ 1685 int64_t skip_initial_bytes; 1686 1687 /** 1688 * Correct single timestamp overflows 1689 * - encoding: unused 1690 * - decoding: Set by user via AVOPtions (NO direct access) 1691 */ 1692 uint correct_ts_overflow; 1693 1694 /** 1695 * Force seeking to any (also non key) frames. 1696 * - encoding: unused 1697 * - decoding: Set by user via AVOPtions (NO direct access) 1698 */ 1699 int seek2any; 1700 1701 /** 1702 * Flush the I/O context after each packet. 1703 * - encoding: Set by user via AVOptions (NO direct access) 1704 * - decoding: unused 1705 */ 1706 int flush_packets; 1707 1708 /** 1709 * format probing score. 1710 * The maximal score is AVPROBE_SCORE_MAX, its set when the demuxer probes 1711 * the format. 1712 * - encoding: unused 1713 * - decoding: set by avformat, read by user via av_format_get_probe_score() (NO direct access) 1714 */ 1715 int probe_score; 1716 1717 /** 1718 * number of bytes to read maximally to identify format. 1719 * - encoding: unused 1720 * - decoding: set by user through AVOPtions (NO direct access) 1721 */ 1722 int format_probesize; 1723 1724 /** 1725 * ',' separated list of allowed decoders. 1726 * If NULL then all are allowed 1727 * - encoding: unused 1728 * - decoding: set by user through AVOptions (NO direct access) 1729 */ 1730 char *codec_whitelist; 1731 1732 /** 1733 * ',' separated list of allowed demuxers. 1734 * If NULL then all are allowed 1735 * - encoding: unused 1736 * - decoding: set by user through AVOptions (NO direct access) 1737 */ 1738 char *format_whitelist; 1739 1740 /** 1741 * An opaque field for libavformat internal usage. 1742 * Must not be accessed in any way by callers. 1743 */ 1744 AVFormatInternal *internal; 1745 1746 /** 1747 * IO repositioned flag. 1748 * This is set by avformat when the underlaying IO context read pointer 1749 * is repositioned, for example when doing byte based seeking. 1750 * Demuxers can use the flag to detect such changes. 1751 */ 1752 int io_repositioned; 1753 1754 /** 1755 * Forced video codec. 1756 * This allows forcing a specific decoder, even when there are multiple with 1757 * the same codec_id. 1758 * Demuxing: Set by user via av_format_set_video_codec (NO direct access). 1759 */ 1760 AVCodec *video_codec; 1761 1762 /** 1763 * Forced audio codec. 1764 * This allows forcing a specific decoder, even when there are multiple with 1765 * the same codec_id. 1766 * Demuxing: Set by user via av_format_set_audio_codec (NO direct access). 1767 */ 1768 AVCodec *audio_codec; 1769 1770 /** 1771 * Forced subtitle codec. 1772 * This allows forcing a specific decoder, even when there are multiple with 1773 * the same codec_id. 1774 * Demuxing: Set by user via av_format_set_subtitle_codec (NO direct access). 1775 */ 1776 AVCodec *subtitle_codec; 1777 1778 /** 1779 * Forced data codec. 1780 * This allows forcing a specific decoder, even when there are multiple with 1781 * the same codec_id. 1782 * Demuxing: Set by user via av_format_set_data_codec (NO direct access). 1783 */ 1784 AVCodec *data_codec; 1785 1786 /** 1787 * Number of bytes to be written as padding in a metadata header. 1788 * Demuxing: Unused. 1789 * Muxing: Set by user via av_format_set_metadata_header_padding. 1790 */ 1791 int metadata_header_padding; 1792 1793 /** 1794 * User data. 1795 * This is a place for some private data of the user. 1796 */ 1797 void *opaque; 1798 1799 /** 1800 * Callback used by devices to communicate with application. 1801 */ 1802 av_format_control_message control_message_cb; 1803 1804 /** 1805 * Output timestamp offset, in microseconds. 1806 * Muxing: set by user via AVOptions (NO direct access) 1807 */ 1808 int64_t output_ts_offset; 1809 1810 /** 1811 * dump format separator. 1812 * can be ", " or "\n " or anything else 1813 * Code outside libavformat should access this field using AVOptions 1814 * (NO direct access). 1815 * - muxing: Set by user. 1816 * - demuxing: Set by user. 1817 */ 1818 uint8_t *dump_separator; 1819 1820 /** 1821 * Forced Data codec_id. 1822 * Demuxing: Set by user. 1823 */ 1824 AVCodecID data_codec_id; 1825 1826 static if(FF_API_OLD_OPEN_CALLBACKS){ 1827 /** 1828 * Called to open further IO contexts when needed for demuxing. 1829 * 1830 * This can be set by the user application to perform security checks on 1831 * the URLs before opening them. 1832 * The function should behave like avio_open2(), AVFormatContext is provided 1833 * as contextual information and to reach AVFormatContext.opaque. 1834 * 1835 * If NULL then some simple checks are used together with avio_open2(). 1836 * 1837 * Must not be accessed directly from outside avformat. 1838 * @See av_format_set_open_cb() 1839 * 1840 * Demuxing: Set by user. 1841 * 1842 * @deprecated Use io_open and io_close. 1843 */ 1844 deprecated 1845 int function(AVFormatContext *s, AVIOContext **p, const char *url, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options) open_cb; 1846 } 1847 1848 /** 1849 * ',' separated list of allowed protocols. 1850 * - encoding: unused 1851 * - decoding: set by user through AVOptions (NO direct access) 1852 */ 1853 char *protocol_whitelist; 1854 1855 /* 1856 * A callback for opening new IO streams. 1857 * 1858 * Certain muxers or demuxers (e.g. for various playlist-based formats) need 1859 * to open additional files during muxing or demuxing. This callback allows 1860 * the caller to provide custom IO in such cases. 1861 * 1862 * @param s the format context 1863 * @param pb on success, the newly opened IO context should be returned here 1864 * @param url the url to open 1865 * @param flags a combination of AVIO_FLAG_* 1866 * @param options a dictionary of additional options, with the same 1867 * semantics as in avio_open2() 1868 * @return 0 on success, a negative AVERROR code on failure 1869 * 1870 * @note Certain muxers and demuxers do nesting, i.e. they open one or more 1871 * additional internal format contexts. Thus the AVFormatContext pointer 1872 * passed to this callback may be different from the one facing the caller. 1873 * It will, however, have the same 'opaque' field. 1874 */ 1875 int function(AVFormatContext *s, AVIOContext **pb, const char *url, 1876 int flags, AVDictionary **options) io_open; 1877 1878 /** 1879 * A callback for closing the streams opened with AVFormatContext.io_open(). 1880 */ 1881 void function(AVFormatContext *s, AVIOContext *pb) io_close; 1882 1883 /** 1884 * ',' separated list of disallowed protocols. 1885 * - encoding: unused 1886 * - decoding: set by user through AVOptions (NO direct access) 1887 */ 1888 char *protocol_blacklist; 1889 1890 /** 1891 * The maximum number of streams. 1892 * - encoding: unused 1893 * - decoding: set by user through AVOptions (NO direct access) 1894 */ 1895 int max_streams; 1896 } 1897 1898 int av_format_get_probe_score(const AVFormatContext *s); 1899 AVCodec * av_format_get_video_codec(const AVFormatContext *s); 1900 void av_format_set_video_codec(AVFormatContext *s, AVCodec *c); 1901 AVCodec * av_format_get_audio_codec(const AVFormatContext *s); 1902 void av_format_set_audio_codec(AVFormatContext *s, AVCodec *c); 1903 AVCodec * av_format_get_subtitle_codec(const AVFormatContext *s); 1904 void av_format_set_subtitle_codec(AVFormatContext *s, AVCodec *c); 1905 AVCodec * av_format_get_data_codec(const AVFormatContext *s); 1906 void av_format_set_data_codec(AVFormatContext *s, AVCodec *c); 1907 int av_format_get_metadata_header_padding(const AVFormatContext *s); 1908 void av_format_set_metadata_header_padding(AVFormatContext *s, int c); 1909 void * av_format_get_opaque(const AVFormatContext *s); 1910 void av_format_set_opaque(AVFormatContext *s, void *opaque); 1911 av_format_control_message av_format_get_control_message_cb(const AVFormatContext *s); 1912 void av_format_set_control_message_cb(AVFormatContext *s, av_format_control_message callback); 1913 static if(FF_API_OLD_OPEN_CALLBACKS){ 1914 deprecated AVOpenCallback av_format_get_open_cb(const AVFormatContext *s); 1915 deprecated void av_format_set_open_cb(AVFormatContext *s, AVOpenCallback callback); 1916 } 1917 1918 /** 1919 * This function will cause global side data to be injected in the next packet 1920 * of each stream as well as after any subsequent seek. 1921 */ 1922 void av_format_inject_global_side_data(AVFormatContext *s); 1923 1924 /** 1925 * Returns the method used to set ctx->duration. 1926 * 1927 * @return AVFMT_DURATION_FROM_PTS, AVFMT_DURATION_FROM_STREAM, or AVFMT_DURATION_FROM_BITRATE. 1928 */ 1929 AVDurationEstimationMethod av_fmt_ctx_get_duration_estimation_method(const AVFormatContext* ctx); 1930 1931 struct AVPacketList { 1932 AVPacket pkt; 1933 AVPacketList *next; 1934 } 1935 1936 1937 /** 1938 * @defgroup lavf_core Core functions 1939 * @ingroup libavf 1940 * 1941 * Functions for querying libavformat capabilities, allocating core structures, 1942 * etc. 1943 * @{ 1944 */ 1945 1946 /** 1947 * Return the LIBAVFORMAT_VERSION_INT constant. 1948 */ 1949 uint avformat_version(); 1950 1951 /** 1952 * Return the libavformat build-time configuration. 1953 */ 1954 char *avformat_configuration(); 1955 1956 /** 1957 * Return the libavformat license. 1958 */ 1959 char *avformat_license(); 1960 1961 /** 1962 * Initialize libavformat and register all the muxers, demuxers and 1963 * protocols. If you do not call this function, then you can select 1964 * exactly which formats you want to support. 1965 * 1966 * @see av_register_input_format() 1967 * @see av_register_output_format() 1968 */ 1969 void av_register_all(); 1970 1971 void av_register_input_format(AVInputFormat *format); 1972 void av_register_output_format(AVOutputFormat *format); 1973 1974 /** 1975 * Do global initialization of network components. This is optional, 1976 * but recommended, since it avoids the overhead of implicitly 1977 * doing the setup for each session. 1978 * 1979 * Calling this function will become mandatory if using network 1980 * protocols at some major version bump. 1981 */ 1982 int avformat_network_init(); 1983 1984 /** 1985 * Undo the initialization done by avformat_network_init. 1986 */ 1987 int avformat_network_deinit(); 1988 1989 /** 1990 * If f is NULL, returns the first registered input format, 1991 * if f is non-NULL, returns the next registered input format after f 1992 * or NULL if f is the last one. 1993 */ 1994 AVInputFormat *av_iformat_next(AVInputFormat *f); 1995 1996 /** 1997 * If f is NULL, returns the first registered output format, 1998 * if f is non-NULL, returns the next registered output format after f 1999 * or NULL if f is the last one. 2000 */ 2001 AVOutputFormat *av_oformat_next(AVOutputFormat *f); 2002 2003 /** 2004 * Allocate an AVFormatContext. 2005 * avformat_free_context() can be used to free the context and everything 2006 * allocated by the framework within it. 2007 */ 2008 AVFormatContext *avformat_alloc_context(); 2009 2010 /** 2011 * Free an AVFormatContext and all its streams. 2012 * @param s context to free 2013 */ 2014 void avformat_free_context(AVFormatContext *s); 2015 2016 /** 2017 * Get the AVClass for AVFormatContext. It can be used in combination with 2018 * AV_OPT_SEARCH_FAKE_OBJ for examining options. 2019 * 2020 * @see av_opt_find(). 2021 */ 2022 AVClass *avformat_get_class(); 2023 2024 /** 2025 * Add a new stream to a media file. 2026 * 2027 * When demuxing, it is called by the demuxer in read_header(). If the 2028 * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also 2029 * be called in read_packet(). 2030 * 2031 * When muxing, should be called by the user before avformat_write_header(). 2032 * 2033 * User is required to call avcodec_close() and avformat_free_context() to 2034 * clean up the allocation by avformat_new_stream(). 2035 * 2036 * @param s media file handle 2037 * @param c If non-NULL, the AVCodecContext corresponding to the new stream 2038 * will be initialized to use this codec. This is needed for e.g. codec-specific 2039 * defaults to be set, so codec should be provided if it is known. 2040 * 2041 * @return newly created stream or NULL on error. 2042 */ 2043 AVStream *avformat_new_stream(AVFormatContext *s, const AVCodec *c); 2044 2045 /** 2046 * Allocate new information from stream. 2047 * 2048 * @param stream stream 2049 * @param type desired side information type 2050 * @param size side information size 2051 * @return pointer to fresh allocated data or NULL otherwise 2052 */ 2053 uint8_t *av_stream_new_side_data(AVStream *stream, 2054 AVPacketSideDataType type, int size); 2055 /** 2056 * Get side information from stream. 2057 * 2058 * @param stream stream 2059 * @param type desired side information type 2060 * @param size pointer for side information size to store (optional) 2061 * @return pointer to data if present or NULL otherwise 2062 */ 2063 uint8_t *av_stream_get_side_data(AVStream *stream, 2064 AVPacketSideDataType type, int *size); 2065 2066 AVProgram *av_new_program(AVFormatContext *s, int id); 2067 2068 /** 2069 * @} 2070 */ 2071 2072 2073 /** 2074 * Allocate an AVFormatContext for an output format. 2075 * avformat_free_context() can be used to free the context and 2076 * everything allocated by the framework within it. 2077 * 2078 * @param *ctx is set to the created format context, or to NULL in 2079 * case of failure 2080 * @param oformat format to use for allocating the context, if NULL 2081 * format_name and filename are used instead 2082 * @param format_name the name of output format to use for allocating the 2083 * context, if NULL filename is used instead 2084 * @param filename the name of the filename to use for allocating the 2085 * context, may be NULL 2086 * @return >= 0 in case of success, a negative AVERROR code in case of 2087 * failure 2088 */ 2089 int avformat_alloc_output_context2(AVFormatContext **ctx, AVOutputFormat *oformat, 2090 const char *format_name, const char *filename); 2091 2092 /** 2093 * @addtogroup lavf_decoding 2094 * @{ 2095 */ 2096 2097 /** 2098 * Find AVInputFormat based on the short name of the input format. 2099 */ 2100 AVInputFormat *av_find_input_format(const char *short_name); 2101 2102 /** 2103 * Guess the file format. 2104 * 2105 * @param pd data to be probed 2106 * @param is_opened Whether the file is already opened; determines whether 2107 * demuxers with or without AVFMT_NOFILE are probed. 2108 */ 2109 AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened); 2110 2111 /** 2112 * Guess the file format. 2113 * 2114 * @param pd data to be probed 2115 * @param is_opened Whether the file is already opened; determines whether 2116 * demuxers with or without AVFMT_NOFILE are probed. 2117 * @param score_max A probe score larger that this is required to accept a 2118 * detection, the variable is set to the actual detection 2119 * score afterwards. 2120 * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended 2121 * to retry with a larger probe buffer. 2122 */ 2123 AVInputFormat *av_probe_input_format2(AVProbeData *pd, int is_opened, int *score_max); 2124 2125 /** 2126 * Guess the file format. 2127 * 2128 * @param is_opened Whether the file is already opened; determines whether 2129 * demuxers with or without AVFMT_NOFILE are probed. 2130 * @param score_ret The score of the best detection. 2131 */ 2132 AVInputFormat *av_probe_input_format3(AVProbeData *pd, int is_opened, int *score_ret); 2133 2134 /** 2135 * Probe a bytestream to determine the input format. Each time a probe returns 2136 * with a score that is too low, the probe buffer size is increased and another 2137 * attempt is made. When the maximum probe size is reached, the input format 2138 * with the highest score is returned. 2139 * 2140 * @param pb the bytestream to probe 2141 * @param fmt the input format is put here 2142 * @param filename the filename of the stream 2143 * @param logctx the log context 2144 * @param offset the offset within the bytestream to probe from 2145 * @param max_probe_size the maximum probe buffer size (zero for default) 2146 * @return the score in case of success, a negative value corresponding to an 2147 * the maximal score is AVPROBE_SCORE_MAX 2148 * AVERROR code otherwise 2149 */ 2150 int av_probe_input_buffer2(AVIOContext *pb, AVInputFormat **fmt, 2151 const char *filename, void *logctx, 2152 uint offset, uint max_probe_size); 2153 2154 /** 2155 * Like av_probe_input_buffer2() but returns 0 on success 2156 */ 2157 int av_probe_input_buffer(AVIOContext *pb, AVInputFormat **fmt, 2158 const char *filename, void *logctx, 2159 uint offset, uint max_probe_size); 2160 2161 /** 2162 * Open an input stream and read the header. The codecs are not opened. 2163 * The stream must be closed with avformat_close_input(). 2164 * 2165 * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context). 2166 * May be a pointer to NULL, in which case an AVFormatContext is allocated by this 2167 * function and written into ps. 2168 * Note that a user-supplied AVFormatContext will be freed on failure. 2169 * @param filename Name of the stream to open. 2170 * @param fmt If non-NULL, this parameter forces a specific input format. 2171 * Otherwise the format is autodetected. 2172 * @param options A dictionary filled with AVFormatContext and demuxer-private options. 2173 * On return this parameter will be destroyed and replaced with a dict containing 2174 * options that were not found. May be NULL. 2175 * 2176 * @return 0 on success, a negative AVERROR on failure. 2177 * 2178 * @note If you want to use custom IO, preallocate the format context and set its pb field. 2179 */ 2180 int avformat_open_input(AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options); 2181 2182 deprecated 2183 int av_demuxer_open(AVFormatContext *ic); 2184 2185 /** 2186 * Read packets of a media file to get stream information. This 2187 * is useful for file formats with no headers such as MPEG. This 2188 * function also computes the real framerate in case of MPEG-2 repeat 2189 * frame mode. 2190 * The logical file position is not changed by this function; 2191 * examined packets may be buffered for later processing. 2192 * 2193 * @param ic media file handle 2194 * @param options If non-NULL, an ic.nb_streams long array of pointers to 2195 * dictionaries, where i-th member contains options for 2196 * codec corresponding to i-th stream. 2197 * On return each dictionary will be filled with options that were not found. 2198 * @return >=0 if OK, AVERROR_xxx on error 2199 * 2200 * @note this function isn't guaranteed to open all the codecs, so 2201 * options being non-empty at return is a perfectly normal behavior. 2202 * 2203 * @todo Let the user decide somehow what information is needed so that 2204 * we do not waste time getting stuff the user does not need. 2205 */ 2206 int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options); 2207 2208 /** 2209 * Find the programs which belong to a given stream. 2210 * 2211 * @param ic media file handle 2212 * @param last the last found program, the search will start after this 2213 * program, or from the beginning if it is NULL 2214 * @param s stream index 2215 * @return the next program which belongs to s, NULL if no program is found or 2216 * the last program is not among the programs of ic. 2217 */ 2218 AVProgram *av_find_program_from_stream(AVFormatContext *ic, AVProgram *last, int s); 2219 2220 void av_program_add_stream_index(AVFormatContext *ac, int progid, uint idx); 2221 2222 /** 2223 * Find the "best" stream in the file. 2224 * The best stream is determined according to various heuristics as the most 2225 * likely to be what the user expects. 2226 * If the decoder parameter is non-NULL, av_find_best_stream will find the 2227 * default decoder for the stream's codec; streams for which no decoder can 2228 * be found are ignored. 2229 * 2230 * @param ic media file handle 2231 * @param type stream type: video, audio, subtitles, etc. 2232 * @param wanted_stream_nb user-requested stream number, 2233 * or -1 for automatic selection 2234 * @param related_stream try to find a stream related (eg. in the same 2235 * program) to this one, or -1 if none 2236 * @param decoder_ret if non-NULL, returns the decoder for the 2237 * selected stream 2238 * @param flags flags; none are currently defined 2239 * @return the non-negative stream number in case of success, 2240 * AVERROR_STREAM_NOT_FOUND if no stream with the requested type 2241 * could be found, 2242 * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder 2243 * @note If av_find_best_stream returns successfully and decoder_ret is not 2244 * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec. 2245 */ 2246 int av_find_best_stream(AVFormatContext *ic, 2247 AVMediaType media_type, 2248 int wanted_stream_nb, 2249 int related_stream, 2250 AVCodec **decoder_ret, 2251 int flags); 2252 2253 /** 2254 * Return the next frame of a stream. 2255 * This function returns what is stored in the file, and does not validate 2256 * that what is there are valid frames for the decoder. It will split what is 2257 * stored in the file into frames and return one for each call. It will not 2258 * omit invalid data between valid frames so as to give the decoder the maximum 2259 * information possible for decoding. 2260 * 2261 * If pkt->buf is NULL, then the packet is valid until the next 2262 * av_read_frame() or until avformat_close_input(). Otherwise the packet 2263 * is valid indefinitely. In both cases the packet must be freed with 2264 * av_free_packet when it is no longer needed. For video, the packet contains 2265 * exactly one frame. For audio, it contains an integer number of frames if each 2266 * frame has a known fixed size (e.g. PCM or ADPCM data). If the audio frames 2267 * have a variable size (e.g. MPEG audio), then it contains one frame. 2268 * 2269 * pkt->pts, pkt->dts and pkt->duration are always set to correct 2270 * values in AVStream.time_base units (and guessed if the format cannot 2271 * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format 2272 * has B-frames, so it is better to rely on pkt->dts if you do not 2273 * decompress the payload. 2274 * 2275 * @return 0 if OK, < 0 on error or end of file 2276 */ 2277 int av_read_frame(AVFormatContext *s, AVPacket *pkt); 2278 2279 /** 2280 * Seek to the keyframe at timestamp. 2281 * 'timestamp' in 'stream_index'. 2282 * 2283 * @param s media file handle 2284 * @param stream_index If stream_index is (-1), a default 2285 * stream is selected, and timestamp is automatically converted 2286 * from AV_TIME_BASE units to the stream specific time_base. 2287 * @param timestamp Timestamp in AVStream.time_base units 2288 * or, if no stream is specified, in AV_TIME_BASE units. 2289 * @param flags flags which select direction and seeking mode 2290 * @return >= 0 on success 2291 */ 2292 int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, 2293 int flags); 2294 2295 /** 2296 * Seek to timestamp ts. 2297 * Seeking will be done so that the point from which all active streams 2298 * can be presented successfully will be closest to ts and within min/max_ts. 2299 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. 2300 * 2301 * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and 2302 * are the file position (this may not be supported by all demuxers). 2303 * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames 2304 * in the stream with stream_index (this may not be supported by all demuxers). 2305 * Otherwise all timestamps are in units of the stream selected by stream_index 2306 * or if stream_index is -1, in AV_TIME_BASE units. 2307 * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as 2308 * keyframes (this may not be supported by all demuxers). 2309 * If flags contain AVSEEK_FLAG_BACKWARD, it is ignored. 2310 * 2311 * @param s media file handle 2312 * @param stream_index index of the stream which is used as time base reference 2313 * @param min_ts smallest acceptable timestamp 2314 * @param ts target timestamp 2315 * @param max_ts largest acceptable timestamp 2316 * @param flags flags 2317 * @return >=0 on success, error code otherwise 2318 * 2319 * @note This is part of the new seek API which is still under construction. 2320 * Thus do not use this yet. It may change at any time, do not expect 2321 * ABI compatibility yet! 2322 */ 2323 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); 2324 2325 /** 2326 * Discard all internally buffered data. This can be useful when dealing with 2327 * discontinuities in the byte stream. Generally works only with formats that 2328 * can resync. This includes headerless formats like MPEG-TS/TS but should also 2329 * work with NUT, Ogg and in a limited way AVI for example. 2330 * 2331 * The set of streams, the detected duration, stream parameters and codecs do 2332 * not change when calling this function. If you want a complete reset, it's 2333 * better to open a new AVFormatContext. 2334 * 2335 * This does not flush the AVIOContext (s->pb). If necessary, call 2336 * avio_flush(s->pb) before calling this function. 2337 * 2338 * @param s media file handle 2339 * @return >=0 on success, error code otherwise 2340 */ 2341 int avformat_flush(AVFormatContext *s); 2342 2343 /** 2344 * Start playing a network-based stream (e.g. RTSP stream) at the 2345 * current position. 2346 */ 2347 int av_read_play(AVFormatContext *s); 2348 2349 /** 2350 * Pause a network-based stream (e.g. RTSP stream). 2351 * 2352 * Use av_read_play() to resume it. 2353 */ 2354 int av_read_pause(AVFormatContext *s); 2355 2356 /** 2357 * Close an opened input AVFormatContext. Free it and all its contents 2358 * and set *s to NULL. 2359 */ 2360 void avformat_close_input(AVFormatContext **s); 2361 /** 2362 * @} 2363 */ 2364 2365 enum AVSEEK_FLAG_BACKWARD = 1; ///< seek backward 2366 enum AVSEEK_FLAG_BYTE = 2; ///< seeking based on position in bytes 2367 enum AVSEEK_FLAG_ANY = 4; ///< seek to any frame, even non-keyframes 2368 enum AVSEEK_FLAG_FRAME = 8; ///< seeking based on frame number 2369 2370 /** 2371 * @addtogroup lavf_encoding 2372 * @{ 2373 */ 2374 /** 2375 * Allocate the stream private data and write the stream header to 2376 * an output media file. 2377 * 2378 * @param s Media file handle, must be allocated with avformat_alloc_context(). 2379 * Its oformat field must be set to the desired output format; 2380 * Its pb field must be set to an already opened AVIOContext. 2381 * @param options An AVDictionary filled with AVFormatContext and muxer-private options. 2382 * On return this parameter will be destroyed and replaced with a dict containing 2383 * options that were not found. May be NULL. 2384 * 2385 * @return 0 on success, negative AVERROR on failure. 2386 * 2387 * @see av_opt_find, av_dict_set, avio_open, av_oformat_next. 2388 */ 2389 //av_warn_unused_result 2390 int avformat_write_header(AVFormatContext *s, AVDictionary **options); 2391 2392 /** 2393 * Write a packet to an output media file. 2394 * 2395 * This function passes the packet directly to the muxer, without any buffering 2396 * or reordering. The caller is responsible for correctly interleaving the 2397 * packets if the format requires it. Callers that want libavformat to handle 2398 * the interleaving should call av_interleaved_write_frame() instead of this 2399 * function. 2400 * 2401 * @param s media file handle 2402 * @param pkt The packet containing the data to be written. Note that unlike 2403 * av_interleaved_write_frame(), this function does not take 2404 * ownership of the packet passed to it (though some muxers may make 2405 * an internal reference to the input packet). 2406 * <br> 2407 * This parameter can be NULL (at any time, not just at the end), in 2408 * order to immediately flush data buffered within the muxer, for 2409 * muxers that buffer up data internally before writing it to the 2410 * output. 2411 * <br> 2412 * Packet's @ref AVPacket.stream_index "stream_index" field must be 2413 * set to the index of the corresponding stream in @ref 2414 * AVFormatContext.streams "s->streams". 2415 * <br> 2416 * The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts") 2417 * must be set to correct values in the stream's timebase (unless the 2418 * output format is flagged with the AVFMT_NOTIMESTAMPS flag, then 2419 * they can be set to AV_NOPTS_VALUE). 2420 * The dts for subsequent packets passed to this function must be strictly 2421 * increasing when compared in their respective timebases (unless the 2422 * output format is flagged with the AVFMT_TS_NONSTRICT, then they 2423 * merely have to be nondecreasing). @ref AVPacket.duration 2424 * "duration") should also be set if known. 2425 * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush 2426 * 2427 * @see av_interleaved_write_frame() 2428 */ 2429 int av_write_frame(AVFormatContext *s, AVPacket *pkt); 2430 2431 /** 2432 * Write a packet to an output media file ensuring correct interleaving. 2433 * 2434 * This function will buffer the packets internally as needed to make sure the 2435 * packets in the output file are properly interleaved in the order of 2436 * increasing dts. Callers doing their own interleaving should call 2437 * av_write_frame() instead of this function. 2438 * 2439 * Using this function instead of av_write_frame() can give muxers advance 2440 * knowledge of future packets, improving e.g. the behaviour of the mp4 2441 * muxer for VFR content in fragmenting mode. 2442 * 2443 * @param s media file handle 2444 * @param pkt The packet containing the data to be written. 2445 * <br> 2446 * If the packet is reference-counted, this function will take 2447 * ownership of this reference and unreference it later when it sees 2448 * fit. 2449 * The caller must not access the data through this reference after 2450 * this function returns. If the packet is not reference-counted, 2451 * libavformat will make a copy. 2452 * <br> 2453 * This parameter can be NULL (at any time, not just at the end), to 2454 * flush the interleaving queues. 2455 * <br> 2456 * Packet's @ref AVPacket.stream_index "stream_index" field must be 2457 * set to the index of the corresponding stream in @ref 2458 * AVFormatContext.streams "s->streams". 2459 * <br> 2460 * The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts") 2461 * must be set to correct values in the stream's timebase (unless the 2462 * output format is flagged with the AVFMT_NOTIMESTAMPS flag, then 2463 * they can be set to AV_NOPTS_VALUE). 2464 * The dts for subsequent packets in one stream must be strictly 2465 * increasing (unless the output format is flagged with the 2466 * AVFMT_TS_NONSTRICT, then they merely have to be nondecreasing). 2467 * @ref AVPacket.duration "duration") should also be set if known. 2468 * 2469 * @return 0 on success, a negative AVERROR on error. Libavformat will always 2470 * take care of freeing the packet, even if this function fails. 2471 * 2472 * @see av_write_frame(), AVFormatContext.max_interleave_delta 2473 */ 2474 int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt); 2475 2476 /** 2477 * Write a uncoded frame to an output media file. 2478 * 2479 * The frame must be correctly interleaved according to the container 2480 * specification; if not, then av_interleaved_write_frame() must be used. 2481 * 2482 * See av_interleaved_write_frame() for details. 2483 */ 2484 int av_write_uncoded_frame(AVFormatContext *s, int stream_index, 2485 AVFrame *frame); 2486 2487 /** 2488 * Write a uncoded frame to an output media file. 2489 * 2490 * If the muxer supports it, this function allows to write an AVFrame 2491 * structure directly, without encoding it into a packet. 2492 * It is mostly useful for devices and similar special muxers that use raw 2493 * video or PCM data and will not serialize it into a byte stream. 2494 * 2495 * To test whether it is possible to use it with a given muxer and stream, 2496 * use av_write_uncoded_frame_query(). 2497 * 2498 * The caller gives up ownership of the frame and must not access it 2499 * afterwards. 2500 * 2501 * @return >=0 for success, a negative code on error 2502 */ 2503 int av_interleaved_write_uncoded_frame(AVFormatContext *s, int stream_index, 2504 AVFrame *frame); 2505 2506 /** 2507 * Test whether a muxer supports uncoded frame. 2508 * 2509 * @return >=0 if an uncoded frame can be written to that muxer and stream, 2510 * <0 if not 2511 */ 2512 int av_write_uncoded_frame_query(AVFormatContext *s, int stream_index); 2513 2514 /** 2515 * Write the stream trailer to an output media file and free the 2516 * file private data. 2517 * 2518 * May only be called after a successful call to avformat_write_header. 2519 * 2520 * @param s media file handle 2521 * @return 0 if OK, AVERROR_xxx on error 2522 */ 2523 int av_write_trailer(AVFormatContext *s); 2524 2525 /** 2526 * Return the output format in the list of registered output formats 2527 * which best matches the provided parameters, or return NULL if 2528 * there is no match. 2529 * 2530 * @param short_name if non-NULL checks if short_name matches with the 2531 * names of the registered formats 2532 * @param filename if non-NULL checks if filename terminates with the 2533 * extensions of the registered formats 2534 * @param mime_type if non-NULL checks if mime_type matches with the 2535 * MIME type of the registered formats 2536 */ 2537 AVOutputFormat *av_guess_format(const char *short_name, 2538 const char *filename, 2539 const char *mime_type); 2540 2541 /** 2542 * Guess the codec ID based upon muxer and filename. 2543 */ 2544 AVCodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name, 2545 const char *filename, const char *mime_type, 2546 AVMediaType type); 2547 2548 /** 2549 * Get timing information for the data currently output. 2550 * The exact meaning of "currently output" depends on the format. 2551 * It is mostly relevant for devices that have an internal buffer and/or 2552 * work in real time. 2553 * @param s media file handle 2554 * @param stream stream in the media file 2555 * @param[out] dts DTS of the last packet output for the stream, in stream 2556 * time_base units 2557 * @param[out] wall absolute time when that packet whas output, 2558 * in microsecond 2559 * @return 0 if OK, AVERROR(ENOSYS) if the format does not support it 2560 * Note: some formats or devices may not allow to measure dts and wall 2561 * atomically. 2562 */ 2563 int av_get_output_timestamp(AVFormatContext *s, int stream, 2564 int64_t *dts, int64_t *wall); 2565 2566 2567 /** 2568 * @} 2569 */ 2570 2571 2572 /** 2573 * @defgroup lavf_misc Utility functions 2574 * @ingroup libavf 2575 * @{ 2576 * 2577 * Miscellaneous utility functions related to both muxing and demuxing 2578 * (or neither). 2579 */ 2580 2581 /** 2582 * Send a nice hexadecimal dump of a buffer to the specified file stream. 2583 * 2584 * @param f The file stream pointer where the dump should be sent to. 2585 * @param buf buffer 2586 * @param size buffer size 2587 * 2588 * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2 2589 */ 2590 void av_hex_dump(FILE *f, const uint8_t *buf, int size); 2591 2592 /** 2593 * Send a nice hexadecimal dump of a buffer to the log. 2594 * 2595 * @param avcl A pointer to an arbitrary struct of which the first field is a 2596 * pointer to an AVClass struct. 2597 * @param level The importance level of the message, lower values signifying 2598 * higher importance. 2599 * @param buf buffer 2600 * @param size buffer size 2601 * 2602 * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2 2603 */ 2604 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size); 2605 2606 /** 2607 * Send a nice dump of a packet to the specified file stream. 2608 * 2609 * @param f The file stream pointer where the dump should be sent to. 2610 * @param pkt packet to dump 2611 * @param dump_payload True if the payload must be displayed, too. 2612 * @param st AVStream that the packet belongs to 2613 */ 2614 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st); 2615 2616 2617 /** 2618 * Send a nice dump of a packet to the log. 2619 * 2620 * @param avcl A pointer to an arbitrary struct of which the first field is a 2621 * pointer to an AVClass struct. 2622 * @param level The importance level of the message, lower values signifying 2623 * higher importance. 2624 * @param pkt packet to dump 2625 * @param dump_payload True if the payload must be displayed, too. 2626 * @param st AVStream that the packet belongs to 2627 */ 2628 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload, 2629 AVStream *st); 2630 2631 /** 2632 * Get the AVCodecID for the given codec tag tag. 2633 * If no codec id is found returns AV_CODEC_ID_NONE. 2634 * 2635 * @param tags list of supported codec_id-codec_tag pairs, as stored 2636 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag 2637 * @param tag codec tag to match to a codec ID 2638 */ 2639 AVCodecID av_codec_get_id(const AVCodecTag **tags, uint tag); 2640 2641 /** 2642 * Get the codec tag for the given codec id id. 2643 * If no codec tag is found returns 0. 2644 * 2645 * @param tags list of supported codec_id-codec_tag pairs, as stored 2646 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag 2647 * @param id codec ID to match to a codec tag 2648 */ 2649 uint av_codec_get_tag(const AVCodecTag * *tags, AVCodecID id); 2650 2651 /** 2652 * Get the codec tag for the given codec id. 2653 * 2654 * @param tags list of supported codec_id - codec_tag pairs, as stored 2655 * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag 2656 * @param id codec id that should be searched for in the list 2657 * @param tag A pointer to the found tag 2658 * @return 0 if id was not found in tags, > 0 if it was found 2659 */ 2660 int av_codec_get_tag2(const AVCodecTag **tags, AVCodecID id, 2661 uint *tag); 2662 2663 int av_find_default_stream_index(AVFormatContext *s); 2664 2665 /** 2666 * Get the index for a specific timestamp. 2667 * 2668 * @param st stream that the timestamp belongs to 2669 * @param timestamp timestamp to retrieve the index for 2670 * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond 2671 * to the timestamp which is <= the requested one, if backward 2672 * is 0, then it will be >= 2673 * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise 2674 * @return < 0 if no such timestamp could be found 2675 */ 2676 int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags); 2677 2678 /** 2679 * Add an index entry into a sorted list. Update the entry if the list 2680 * already contains it. 2681 * 2682 * @param timestamp timestamp in the time base of the given stream 2683 */ 2684 int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp, 2685 int size, int distance, int flags); 2686 2687 2688 /** 2689 * Split a URL string into components. 2690 * 2691 * The pointers to buffers for storing individual components may be null, 2692 * in order to ignore that component. Buffers for components not found are 2693 * set to empty strings. If the port is not found, it is set to a negative 2694 * value. 2695 * 2696 * @param proto the buffer for the protocol 2697 * @param proto_size the size of the proto buffer 2698 * @param authorization the buffer for the authorization 2699 * @param authorization_size the size of the authorization buffer 2700 * @param hostname the buffer for the host name 2701 * @param hostname_size the size of the hostname buffer 2702 * @param port_ptr a pointer to store the port number in 2703 * @param path the buffer for the path 2704 * @param path_size the size of the path buffer 2705 * @param url the URL to split 2706 */ 2707 void av_url_split(char *proto, int proto_size, 2708 char *authorization, int authorization_size, 2709 char *hostname, int hostname_size, 2710 int *port_ptr, 2711 char *path, int path_size, 2712 const char *url); 2713 2714 2715 /** 2716 * Print detailed information about the input or output format, such as 2717 * duration, bitrate, streams, container, programs, metadata, side data, 2718 * codec and time base. 2719 * 2720 * @param ic the context to analyze 2721 * @param index index of the stream to dump information about 2722 * @param url the URL to print, such as source or destination file 2723 * @param is_output Select whether the specified context is an input(0) or output(1) 2724 */ 2725 void av_dump_format(AVFormatContext *ic, 2726 int index, 2727 const char *url, 2728 int is_output); 2729 2730 /** 2731 * Return in 'buf' the path with '%d' replaced by a number. 2732 * 2733 * Also handles the '%0nd' format where 'n' is the total number 2734 * of digits and '%%'. 2735 * 2736 * @param buf destination buffer 2737 * @param buf_size destination buffer size 2738 * @param path numbered sequence string 2739 * @param number frame number 2740 * @return 0 if OK, -1 on format error 2741 */ 2742 int av_get_frame_filename(char *buf, int buf_size, 2743 const char *path, int number); 2744 2745 /** 2746 * Check whether filename actually is a numbered sequence generator. 2747 * 2748 * @param filename possible numbered sequence string 2749 * @return 1 if a valid numbered sequence string, 0 otherwise 2750 */ 2751 int av_filename_number_test(const char *filename); 2752 2753 /** 2754 * Generate an SDP for an RTP session. 2755 * 2756 * Note, this overwrites the id values of AVStreams in the muxer contexts 2757 * for getting unique dynamic payload types. 2758 * 2759 * @param ac array of AVFormatContexts describing the RTP streams. If the 2760 * array is composed by only one context, such context can contain 2761 * multiple AVStreams (one AVStream per RTP stream). Otherwise, 2762 * all the contexts in the array (an AVCodecContext per RTP stream) 2763 * must contain only one AVStream. 2764 * @param n_files number of AVCodecContexts contained in ac 2765 * @param buf buffer where the SDP will be stored (must be allocated by 2766 * the caller) 2767 * @param size the size of the buffer 2768 * @return 0 if OK, AVERROR_xxx on error 2769 */ 2770 int av_sdp_create(AVFormatContext *[]ac, int n_files, char *buf, int size); 2771 2772 /** 2773 * Return a positive value if the given filename has one of the given 2774 * extensions, 0 otherwise. 2775 * 2776 * @param filename file name to check against the given extensions 2777 * @param extensions a comma-separated list of filename extensions 2778 */ 2779 int av_match_ext(const char *filename, const char *extensions); 2780 2781 /** 2782 * Test if the given container can store a codec. 2783 * 2784 * @param ofmt container to check for compatibility 2785 * @param codec_id codec to potentially store in container 2786 * @param std_compliance standards compliance level, one of FF_COMPLIANCE_* 2787 * 2788 * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot. 2789 * A negative number if this information is not available. 2790 */ 2791 int avformat_query_codec(AVOutputFormat *ofmt, AVCodecID codec_id, 2792 int std_compliance); 2793 2794 /** 2795 * @defgroup riff_fourcc RIFF FourCCs 2796 * @{ 2797 * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are 2798 * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the 2799 * following code: 2800 * @code 2801 * uint32_t tag = MKTAG('H', '2', '6', '4'); 2802 * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 }; 2803 * enum AVCodecID id = av_codec_get_id(table, tag); 2804 * @endcode 2805 */ 2806 /** 2807 * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID. 2808 */ 2809 AVCodecTag *avformat_get_riff_video_tags(); 2810 /** 2811 * @return the table mapping RIFF FourCCs for audio to AVCodecID. 2812 */ 2813 AVCodecTag *avformat_get_riff_audio_tags(); 2814 /** 2815 * @return the table mapping MOV FourCCs for video to libavcodec AVCodecID. 2816 */ 2817 AVCodecTag *avformat_get_mov_video_tags(); 2818 /** 2819 * @return the table mapping MOV FourCCs for audio to AVCodecID. 2820 */ 2821 AVCodecTag *avformat_get_mov_audio_tags(); 2822 2823 /** 2824 * @} 2825 */ 2826 2827 /** 2828 * Guess the sample aspect ratio of a frame, based on both the stream and the 2829 * frame aspect ratio. 2830 * 2831 * Since the frame aspect ratio is set by the codec but the stream aspect ratio 2832 * is set by the demuxer, these two may not be equal. This function tries to 2833 * return the value that you should use if you would like to display the frame. 2834 * 2835 * Basic logic is to use the stream aspect ratio if it is set to something sane 2836 * otherwise use the frame aspect ratio. This way a container setting, which is 2837 * usually easy to modify can override the coded value in the frames. 2838 * 2839 * @param format the format context which the stream is part of 2840 * @param stream the stream which the frame is part of 2841 * @param frame the frame with the aspect ratio to be determined 2842 * @return the guessed (valid) sample_aspect_ratio, 0/1 if no idea 2843 */ 2844 AVRational av_guess_sample_aspect_ratio(AVFormatContext *format, AVStream *stream, AVFrame *frame); 2845 2846 /** 2847 * Guess the frame rate, based on both the container and codec information. 2848 * 2849 * @param ctx the format context which the stream is part of 2850 * @param stream the stream which the frame is part of 2851 * @param frame the frame for which the frame rate should be determined, may be NULL 2852 * @return the guessed (valid) frame rate, 0/1 if no idea 2853 */ 2854 AVRational av_guess_frame_rate(AVFormatContext *ctx, AVStream *stream, AVFrame *frame); 2855 2856 /** 2857 * Check if the stream st contained in s is matched by the stream specifier 2858 * spec. 2859 * 2860 * See the "stream specifiers" chapter in the documentation for the syntax 2861 * of spec. 2862 * 2863 * @return >0 if st is matched by spec; 2864 * 0 if st is not matched by spec; 2865 * AVERROR code if spec is invalid 2866 * 2867 * @note A stream specifier can match several streams in the format. 2868 */ 2869 int avformat_match_stream_specifier(AVFormatContext *s, AVStream *st, 2870 const char *spec); 2871 2872 void avformat_queue_attached_pictures(AVFormatContext *s); 2873 2874 /** 2875 * Apply a list of bitstream filters to a packet. 2876 * 2877 * @param codec AVCodecContext, usually from an AVStream 2878 * @param pkt the packet to apply filters to 2879 * @param bsfc a NULL-terminated list of filters to apply 2880 * @return >=0 on success; 2881 * AVERROR code on failure 2882 */ 2883 static if(FF_API_OLD_BSF){ 2884 deprecated 2885 int av_apply_bitstream_filters(AVCodecContext *codec, AVPacket *pkt, 2886 AVBitStreamFilterContext *bsfc); 2887 } 2888 2889 2890 /** 2891 * @} 2892 */ 2893 2894 //#endif /* AVFORMAT_AVFORMAT_H */ 2895 2896 2897 // #defines made inline in structs or enums 2898 enum MAX_STD_TIMEBASES = (60*12+6); 2899 enum AVSTREAM_EVENT_FLAG_METADATA_UPDATED = 0x0001; 2900 enum RAW_PACKET_BUFFER_SIZE = 2500_000; 2901 enum AVFMT_EVENT_FLAG_METADATA_UPDATED = 0x0001; ///< The call resulted in updated metadata. 2902 enum FF_FDEBUG_TS = 0x0001; 2903 2904 enum AVFMT_FLAG_GENPTS = 0x0001; ///< Generate missing pts even if it requires parsing future frames. 2905 enum AVFMT_FLAG_IGNIDX = 0x0002; ///< Ignore index. 2906 enum AVFMT_FLAG_NONBLOCK = 0x0004; ///< Do not block when reading packets from input. 2907 enum AVFMT_FLAG_IGNDTS = 0x0008; ///< Ignore DTS on frames that contain both DTS & PTS 2908 enum AVFMT_FLAG_NOFILLIN = 0x0010; ///< Do not infer any values from other values, just return what is stored in the container 2909 enum 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 2910 enum AVFMT_FLAG_NOBUFFER = 0x0040; ///< Do not buffer frames when possible 2911 enum AVFMT_FLAG_CUSTOM_IO = 0x0080; ///< The caller has supplied a custom AVIOContext, don't avio_close() it. 2912 enum AVFMT_FLAG_DISCARD_CORRUPT= 0x0100; ///< Discard frames marked corrupted 2913 enum AVFMT_FLAG_FLUSH_PACKETS = 0x0200; ///< Flush the AVIOContext every packet. 2914 /** 2915 * When muxing, try to avoid writing any random/volatile data to the output. 2916 * This includes any random IDs, real-time timestamps/dates, muxer version, etc. 2917 * 2918 * This flag is mainly intended for testing. 2919 */ 2920 enum AVFMT_FLAG_BITEXACT = 0x0400; 2921 enum AVFMT_FLAG_MP4A_LATM = 0x8000; ///< Enable RTP MP4A-LATM payload 2922 enum AVFMT_FLAG_SORT_DTS = 0x10000; ///< try to interleave outputted packets by dts (using this flag can slow demuxing down) 2923 enum AVFMT_FLAG_PRIV_OPT = 0x20000; ///< Enable use of private options by delaying codec open (this could be made default once all code is converted) 2924 enum AVFMT_FLAG_KEEP_SIDE_DATA=0x40000; ///< Don't merge side data but keep it separate. 2925 enum AVFMT_FLAG_FAST_SEEK = 0x80000; ///< Enable fast, but inaccurate seeks for some formats 2926 2927 enum MAX_REORDER_DELAY=16; 2928 2929 enum AVINDEX_KEYFRAME = 0x0001; 2930 2931 enum AVFMT_AVOID_NEG_TS_AUTO = -1; ///< Enabled when required by target format 2932 enum AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE = 1; ///< Shift timestamps so they are non negative 2933 enum AVFMT_AVOID_NEG_TS_MAKE_ZERO = 2; ///< Shift timestamps so that they start at 0