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.

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