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.

1467 lines
52KB

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