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.

1492 lines
53KB

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