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.

1479 lines
53KB

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