You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1468 lines
52KB

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