internal.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777
  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_INTERNAL_H
  21. #define AVFORMAT_INTERNAL_H
  22. #include <stdint.h>
  23. #include "libavutil/bprint.h"
  24. #include "avformat.h"
  25. #include "os_support.h"
  26. #define MAX_URL_SIZE 4096
  27. /** size of probe buffer, for guessing file type from file contents */
  28. #define PROBE_BUF_MIN 2048
  29. #define PROBE_BUF_MAX (1 << 20)
  30. #ifdef DEBUG
  31. # define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
  32. #else
  33. # define hex_dump_debug(class, buf, size) do { if (0) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size); } while(0)
  34. #endif
  35. typedef struct AVCodecTag {
  36. enum AVCodecID id;
  37. unsigned int tag;
  38. } AVCodecTag;
  39. typedef struct CodecMime{
  40. char str[32];
  41. enum AVCodecID id;
  42. } CodecMime;
  43. /*************************************************/
  44. /* fractional numbers for exact pts handling */
  45. /**
  46. * The exact value of the fractional number is: 'val + num / den'.
  47. * num is assumed to be 0 <= num < den.
  48. */
  49. typedef struct FFFrac {
  50. int64_t val, num, den;
  51. } FFFrac;
  52. struct AVFormatInternal {
  53. /**
  54. * Number of streams relevant for interleaving.
  55. * Muxing only.
  56. */
  57. int nb_interleaved_streams;
  58. /**
  59. * This buffer is only needed when packets were already buffered but
  60. * not decoded, for example to get the codec parameters in MPEG
  61. * streams.
  62. */
  63. struct AVPacketList *packet_buffer;
  64. struct AVPacketList *packet_buffer_end;
  65. /* av_seek_frame() support */
  66. int64_t data_offset; /**< offset of the first packet */
  67. /**
  68. * Raw packets from the demuxer, prior to parsing and decoding.
  69. * This buffer is used for buffering packets until the codec can
  70. * be identified, as parsing cannot be done without knowing the
  71. * codec.
  72. */
  73. struct AVPacketList *raw_packet_buffer;
  74. struct AVPacketList *raw_packet_buffer_end;
  75. /**
  76. * Packets split by the parser get queued here.
  77. */
  78. struct AVPacketList *parse_queue;
  79. struct AVPacketList *parse_queue_end;
  80. /**
  81. * Remaining size available for raw_packet_buffer, in bytes.
  82. */
  83. #define RAW_PACKET_BUFFER_SIZE 2500000
  84. int raw_packet_buffer_remaining_size;
  85. /**
  86. * Offset to remap timestamps to be non-negative.
  87. * Expressed in timebase units.
  88. * @see AVStream.mux_ts_offset
  89. */
  90. int64_t offset;
  91. /**
  92. * Timebase for the timestamp offset.
  93. */
  94. AVRational offset_timebase;
  95. #if FF_API_COMPUTE_PKT_FIELDS2
  96. int missing_ts_warning;
  97. #endif
  98. int inject_global_side_data;
  99. int avoid_negative_ts_use_pts;
  100. /**
  101. * Timestamp of the end of the shortest stream.
  102. */
  103. int64_t shortest_end;
  104. /**
  105. * Whether or not avformat_init_output has already been called
  106. */
  107. int initialized;
  108. /**
  109. * Whether or not avformat_init_output fully initialized streams
  110. */
  111. int streams_initialized;
  112. /**
  113. * ID3v2 tag useful for MP3 demuxing
  114. */
  115. AVDictionary *id3v2_meta;
  116. /*
  117. * Prefer the codec framerate for avg_frame_rate computation.
  118. */
  119. int prefer_codec_framerate;
  120. };
  121. struct AVStreamInternal {
  122. /**
  123. * Set to 1 if the codec allows reordering, so pts can be different
  124. * from dts.
  125. */
  126. int reorder;
  127. /**
  128. * bitstream filter to run on stream
  129. * - encoding: Set by muxer using ff_stream_add_bitstream_filter
  130. * - decoding: unused
  131. */
  132. AVBSFContext *bsfc;
  133. /**
  134. * Whether or not check_bitstream should still be run on each packet
  135. */
  136. int bitstream_checked;
  137. /**
  138. * The codec context used by avformat_find_stream_info, the parser, etc.
  139. */
  140. AVCodecContext *avctx;
  141. /**
  142. * 1 if avctx has been initialized with the values from the codec parameters
  143. */
  144. int avctx_inited;
  145. enum AVCodecID orig_codec_id;
  146. /* the context for extracting extradata in find_stream_info()
  147. * inited=1/bsf=NULL signals that extracting is not possible (codec not
  148. * supported) */
  149. struct {
  150. AVBSFContext *bsf;
  151. AVPacket *pkt;
  152. int inited;
  153. } extract_extradata;
  154. /**
  155. * Whether the internal avctx needs to be updated from codecpar (after a late change to codecpar)
  156. */
  157. int need_context_update;
  158. int is_intra_only;
  159. FFFrac *priv_pts;
  160. };
  161. #ifdef __GNUC__
  162. #define dynarray_add(tab, nb_ptr, elem)\
  163. do {\
  164. __typeof__(tab) _tab = (tab);\
  165. __typeof__(elem) _elem = (elem);\
  166. (void)sizeof(**_tab == _elem); /* check that types are compatible */\
  167. av_dynarray_add(_tab, nb_ptr, _elem);\
  168. } while(0)
  169. #else
  170. #define dynarray_add(tab, nb_ptr, elem)\
  171. do {\
  172. av_dynarray_add((tab), nb_ptr, (elem));\
  173. } while(0)
  174. #endif
  175. struct tm *ff_brktimegm(time_t secs, struct tm *tm);
  176. /**
  177. * Automatically create sub-directories
  178. *
  179. * @param path will create sub-directories by path
  180. * @return 0, or < 0 on error
  181. */
  182. int ff_mkdir_p(const char *path);
  183. char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
  184. /**
  185. * Parse a string of hexadecimal strings. Any space between the hexadecimal
  186. * digits is ignored.
  187. *
  188. * @param data if non-null, the parsed data is written to this pointer
  189. * @param p the string to parse
  190. * @return the number of bytes written (or to be written, if data is null)
  191. */
  192. int ff_hex_to_data(uint8_t *data, const char *p);
  193. /**
  194. * Add packet to an AVFormatContext's packet_buffer list, determining its
  195. * interleaved position using compare() function argument.
  196. * @return 0 on success, < 0 on error. pkt will always be blank on return.
  197. */
  198. int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
  199. int (*compare)(AVFormatContext *, const AVPacket *, const AVPacket *));
  200. void ff_read_frame_flush(AVFormatContext *s);
  201. #define NTP_OFFSET 2208988800ULL
  202. #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
  203. /** Get the current time since NTP epoch in microseconds. */
  204. uint64_t ff_ntp_time(void);
  205. /**
  206. * Get the NTP time stamp formatted as per the RFC-5905.
  207. *
  208. * @param ntp_time NTP time in micro seconds (since NTP epoch)
  209. * @return the formatted NTP time stamp
  210. */
  211. uint64_t ff_get_formatted_ntp_time(uint64_t ntp_time_us);
  212. /**
  213. * Append the media-specific SDP fragment for the media stream c
  214. * to the buffer buff.
  215. *
  216. * Note, the buffer needs to be initialized, since it is appended to
  217. * existing content.
  218. *
  219. * @param buff the buffer to append the SDP fragment to
  220. * @param size the size of the buff buffer
  221. * @param st the AVStream of the media to describe
  222. * @param idx the global stream index
  223. * @param dest_addr the destination address of the media stream, may be NULL
  224. * @param dest_type the destination address type, may be NULL
  225. * @param port the destination port of the media stream, 0 if unknown
  226. * @param ttl the time to live of the stream, 0 if not multicast
  227. * @param fmt the AVFormatContext, which might contain options modifying
  228. * the generated SDP
  229. */
  230. void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
  231. const char *dest_addr, const char *dest_type,
  232. int port, int ttl, AVFormatContext *fmt);
  233. /**
  234. * Write a packet to another muxer than the one the user originally
  235. * intended. Useful when chaining muxers, where one muxer internally
  236. * writes a received packet to another muxer.
  237. *
  238. * @param dst the muxer to write the packet to
  239. * @param dst_stream the stream index within dst to write the packet to
  240. * @param pkt the packet to be written
  241. * @param src the muxer the packet originally was intended for
  242. * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
  243. * @return the value av_write_frame returned
  244. */
  245. int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
  246. AVFormatContext *src, int interleave);
  247. /**
  248. * Read a whole line of text from AVIOContext. Stop reading after reaching
  249. * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
  250. * and may be truncated if the buffer is too small.
  251. *
  252. * @param s the read-only AVIOContext
  253. * @param buf buffer to store the read line
  254. * @param maxlen size of the buffer
  255. * @return the length of the string written in the buffer, not including the
  256. * final \\0
  257. */
  258. int ff_get_line(AVIOContext *s, char *buf, int maxlen);
  259. /**
  260. * Same as ff_get_line but strip the white-space characters in the text tail
  261. *
  262. * @param s the read-only AVIOContext
  263. * @param buf buffer to store the read line
  264. * @param maxlen size of the buffer
  265. * @return the length of the string written in the buffer
  266. */
  267. int ff_get_chomp_line(AVIOContext *s, char *buf, int maxlen);
  268. /**
  269. * Read a whole line of text from AVIOContext to an AVBPrint buffer. Stop
  270. * reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or EOF. The line
  271. * ending characters are NOT included in the buffer, but they are skipped on
  272. * the input.
  273. *
  274. * @param s the read-only AVIOContext
  275. * @param bp the AVBPrint buffer
  276. * @return the length of the read line, not including the line endings,
  277. * negative on error.
  278. */
  279. int64_t ff_read_line_to_bprint(AVIOContext *s, AVBPrint *bp);
  280. /**
  281. * Read a whole line of text from AVIOContext to an AVBPrint buffer overwriting
  282. * its contents. Stop reading after reaching a \\r, a \\n, a \\r\\n, a \\0 or
  283. * EOF. The line ending characters are NOT included in the buffer, but they
  284. * are skipped on the input.
  285. *
  286. * @param s the read-only AVIOContext
  287. * @param bp the AVBPrint buffer
  288. * @return the length of the read line not including the line endings,
  289. * negative on error, or if the buffer becomes truncated.
  290. */
  291. int64_t ff_read_line_to_bprint_overwrite(AVIOContext *s, AVBPrint *bp);
  292. #define SPACE_CHARS " \t\r\n"
  293. /**
  294. * Callback function type for ff_parse_key_value.
  295. *
  296. * @param key a pointer to the key
  297. * @param key_len the number of bytes that belong to the key, including the '='
  298. * char
  299. * @param dest return the destination pointer for the value in *dest, may
  300. * be null to ignore the value
  301. * @param dest_len the length of the *dest buffer
  302. */
  303. typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
  304. int key_len, char **dest, int *dest_len);
  305. /**
  306. * Parse a string with comma-separated key=value pairs. The value strings
  307. * may be quoted and may contain escaped characters within quoted strings.
  308. *
  309. * @param str the string to parse
  310. * @param callback_get_buf function that returns where to store the
  311. * unescaped value string.
  312. * @param context the opaque context pointer to pass to callback_get_buf
  313. */
  314. void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
  315. void *context);
  316. /**
  317. * Find stream index based on format-specific stream ID
  318. * @return stream index, or < 0 on error
  319. */
  320. int ff_find_stream_index(AVFormatContext *s, int id);
  321. /**
  322. * Internal version of av_index_search_timestamp
  323. */
  324. int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
  325. int64_t wanted_timestamp, int flags);
  326. /**
  327. * Internal version of av_add_index_entry
  328. */
  329. int ff_add_index_entry(AVIndexEntry **index_entries,
  330. int *nb_index_entries,
  331. unsigned int *index_entries_allocated_size,
  332. int64_t pos, int64_t timestamp, int size, int distance, int flags);
  333. void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
  334. /**
  335. * Add a new chapter.
  336. *
  337. * @param s media file handle
  338. * @param id unique ID for this chapter
  339. * @param start chapter start time in time_base units
  340. * @param end chapter end time in time_base units
  341. * @param title chapter title
  342. *
  343. * @return AVChapter or NULL on error
  344. */
  345. AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
  346. int64_t start, int64_t end, const char *title);
  347. /**
  348. * Ensure the index uses less memory than the maximum specified in
  349. * AVFormatContext.max_index_size by discarding entries if it grows
  350. * too large.
  351. */
  352. void ff_reduce_index(AVFormatContext *s, int stream_index);
  353. enum AVCodecID ff_guess_image2_codec(const char *filename);
  354. /**
  355. * Perform a binary search using av_index_search_timestamp() and
  356. * AVInputFormat.read_timestamp().
  357. *
  358. * @param target_ts target timestamp in the time base of the given stream
  359. * @param stream_index stream number
  360. */
  361. int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
  362. int64_t target_ts, int flags);
  363. /**
  364. * Update cur_dts of all streams based on the given timestamp and AVStream.
  365. *
  366. * Stream ref_st unchanged, others set cur_dts in their native time base.
  367. * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
  368. * @param timestamp new dts expressed in time_base of param ref_st
  369. * @param ref_st reference stream giving time_base of param timestamp
  370. */
  371. void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
  372. int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
  373. int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
  374. /**
  375. * Perform a binary search using read_timestamp().
  376. *
  377. * @param target_ts target timestamp in the time base of the given stream
  378. * @param stream_index stream number
  379. */
  380. int64_t ff_gen_search(AVFormatContext *s, int stream_index,
  381. int64_t target_ts, int64_t pos_min,
  382. int64_t pos_max, int64_t pos_limit,
  383. int64_t ts_min, int64_t ts_max,
  384. int flags, int64_t *ts_ret,
  385. int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
  386. /**
  387. * Set the time base and wrapping info for a given stream. This will be used
  388. * to interpret the stream's timestamps. If the new time base is invalid
  389. * (numerator or denominator are non-positive), it leaves the stream
  390. * unchanged.
  391. *
  392. * @param s stream
  393. * @param pts_wrap_bits number of bits effectively used by the pts
  394. * (used for wrap control)
  395. * @param pts_num time base numerator
  396. * @param pts_den time base denominator
  397. */
  398. void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
  399. unsigned int pts_num, unsigned int pts_den);
  400. /**
  401. * Add side data to a packet for changing parameters to the given values.
  402. * Parameters set to 0 aren't included in the change.
  403. */
  404. int ff_add_param_change(AVPacket *pkt, int32_t channels,
  405. uint64_t channel_layout, int32_t sample_rate,
  406. int32_t width, int32_t height);
  407. /**
  408. * Set the timebase for each stream from the corresponding codec timebase and
  409. * print it.
  410. */
  411. int ff_framehash_write_header(AVFormatContext *s);
  412. /**
  413. * Read a transport packet from a media file.
  414. *
  415. * @param s media file handle
  416. * @param pkt is filled
  417. * @return 0 if OK, AVERROR_xxx on error
  418. */
  419. int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
  420. /**
  421. * Interleave an AVPacket per dts so it can be muxed.
  422. *
  423. * @param s an AVFormatContext for output. pkt resp. out will be added to
  424. * resp. taken from its packet buffer.
  425. * @param out the interleaved packet will be output here
  426. * @param pkt the input packet; will be blank on return if not NULL
  427. * @param flush 1 if no further packets are available as input and all
  428. * remaining packets should be output
  429. * @return 1 if a packet was output, 0 if no packet could be output
  430. * (in which case out may be uninitialized), < 0 if an error occurred
  431. */
  432. int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
  433. AVPacket *pkt, int flush);
  434. void ff_free_stream(AVFormatContext *s, AVStream *st);
  435. /**
  436. * Return the frame duration in seconds. Return 0 if not available.
  437. */
  438. void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
  439. AVCodecParserContext *pc, AVPacket *pkt);
  440. unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
  441. enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
  442. int ff_is_intra_only(enum AVCodecID id);
  443. /**
  444. * Select a PCM codec based on the given parameters.
  445. *
  446. * @param bps bits-per-sample
  447. * @param flt floating-point
  448. * @param be big-endian
  449. * @param sflags signed flags. each bit corresponds to one byte of bit depth.
  450. * e.g. the 1st bit indicates if 8-bit should be signed or
  451. * unsigned, the 2nd bit indicates if 16-bit should be signed or
  452. * unsigned, etc... This is useful for formats such as WAVE where
  453. * only 8-bit is unsigned and all other bit depths are signed.
  454. * @return a PCM codec id or AV_CODEC_ID_NONE
  455. */
  456. enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
  457. /**
  458. * Chooses a timebase for muxing the specified stream.
  459. *
  460. * The chosen timebase allows sample accurate timestamps based
  461. * on the framerate or sample rate for audio streams. It also is
  462. * at least as precise as 1/min_precision would be.
  463. */
  464. AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
  465. /**
  466. * Chooses a timebase for muxing the specified stream.
  467. */
  468. enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
  469. /**
  470. * Generate standard extradata for AVC-Intra based on width/height and field
  471. * order.
  472. */
  473. int ff_generate_avci_extradata(AVStream *st);
  474. /**
  475. * Add a bitstream filter to a stream.
  476. *
  477. * @param st output stream to add a filter to
  478. * @param name the name of the filter to add
  479. * @param args filter-specific argument string
  480. * @return >0 on success;
  481. * AVERROR code on failure
  482. */
  483. int ff_stream_add_bitstream_filter(AVStream *st, const char *name, const char *args);
  484. /**
  485. * Copy encoding parameters from source to destination stream
  486. *
  487. * @param dst pointer to destination AVStream
  488. * @param src pointer to source AVStream
  489. * @return >=0 on success, AVERROR code on error
  490. */
  491. int ff_stream_encode_params_copy(AVStream *dst, const AVStream *src);
  492. /**
  493. * Wrap avpriv_io_move and log if error happens.
  494. *
  495. * @param url_src source path
  496. * @param url_dst destination path
  497. * @return 0 or AVERROR on failure
  498. */
  499. int ff_rename(const char *url_src, const char *url_dst, void *logctx);
  500. /**
  501. * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
  502. * which is always set to 0.
  503. *
  504. * Previously allocated extradata in par will be freed.
  505. *
  506. * @param size size of extradata
  507. * @return 0 if OK, AVERROR_xxx on error
  508. */
  509. int ff_alloc_extradata(AVCodecParameters *par, int size);
  510. /**
  511. * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
  512. * which is always set to 0 and fill it from pb.
  513. *
  514. * @param size size of extradata
  515. * @return >= 0 if OK, AVERROR_xxx on error
  516. */
  517. int ff_get_extradata(AVFormatContext *s, AVCodecParameters *par, AVIOContext *pb, int size);
  518. /**
  519. * add frame for rfps calculation.
  520. *
  521. * @param dts timestamp of the i-th frame
  522. * @return 0 if OK, AVERROR_xxx on error
  523. */
  524. int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
  525. void ff_rfps_calculate(AVFormatContext *ic);
  526. /**
  527. * Flags for AVFormatContext.write_uncoded_frame()
  528. */
  529. enum AVWriteUncodedFrameFlags {
  530. /**
  531. * Query whether the feature is possible on this stream.
  532. * The frame argument is ignored.
  533. */
  534. AV_WRITE_UNCODED_FRAME_QUERY = 0x0001,
  535. };
  536. /**
  537. * Copies the whilelists from one context to the other
  538. */
  539. int ff_copy_whiteblacklists(AVFormatContext *dst, const AVFormatContext *src);
  540. /**
  541. * Returned by demuxers to indicate that data was consumed but discarded
  542. * (ignored streams or junk data). The framework will re-call the demuxer.
  543. */
  544. #define FFERROR_REDO FFERRTAG('R','E','D','O')
  545. /**
  546. * Utility function to open IO stream of output format.
  547. *
  548. * @param s AVFormatContext
  549. * @param url URL or file name to open for writing
  550. * @options optional options which will be passed to io_open callback
  551. * @return >=0 on success, negative AVERROR in case of failure
  552. */
  553. int ff_format_output_open(AVFormatContext *s, const char *url, AVDictionary **options);
  554. /*
  555. * A wrapper around AVFormatContext.io_close that should be used
  556. * instead of calling the pointer directly.
  557. */
  558. void ff_format_io_close(AVFormatContext *s, AVIOContext **pb);
  559. /**
  560. * Utility function to check if the file uses http or https protocol
  561. *
  562. * @param s AVFormatContext
  563. * @param filename URL or file name to open for writing
  564. */
  565. int ff_is_http_proto(char *filename);
  566. /**
  567. * Parse creation_time in AVFormatContext metadata if exists and warn if the
  568. * parsing fails.
  569. *
  570. * @param s AVFormatContext
  571. * @param timestamp parsed timestamp in microseconds, only set on successful parsing
  572. * @param return_seconds set this to get the number of seconds in timestamp instead of microseconds
  573. * @return 1 if OK, 0 if the metadata was not present, AVERROR(EINVAL) on parse error
  574. */
  575. int ff_parse_creation_time_metadata(AVFormatContext *s, int64_t *timestamp, int return_seconds);
  576. /**
  577. * Standardize creation_time metadata in AVFormatContext to an ISO-8601
  578. * timestamp string.
  579. *
  580. * @param s AVFormatContext
  581. * @return <0 on error
  582. */
  583. int ff_standardize_creation_time(AVFormatContext *s);
  584. #define CONTAINS_PAL 2
  585. /**
  586. * Reshuffles the lines to use the user specified stride.
  587. *
  588. * @param ppkt input and output packet
  589. * @return negative error code or
  590. * 0 if no new packet was allocated
  591. * non-zero if a new packet was allocated and ppkt has to be freed
  592. * CONTAINS_PAL if in addition to a new packet the old contained a palette
  593. */
  594. int ff_reshuffle_raw_rgb(AVFormatContext *s, AVPacket **ppkt, AVCodecParameters *par, int expected_stride);
  595. /**
  596. * Retrieves the palette from a packet, either from side data, or
  597. * appended to the video data in the packet itself (raw video only).
  598. * It is commonly used after a call to ff_reshuffle_raw_rgb().
  599. *
  600. * Use 0 for the ret parameter to check for side data only.
  601. *
  602. * @param pkt pointer to packet before calling ff_reshuffle_raw_rgb()
  603. * @param ret return value from ff_reshuffle_raw_rgb(), or 0
  604. * @param palette pointer to palette buffer
  605. * @return negative error code or
  606. * 1 if the packet has a palette, else 0
  607. */
  608. int ff_get_packet_palette(AVFormatContext *s, AVPacket *pkt, int ret, uint32_t *palette);
  609. /**
  610. * Finalize buf into extradata and set its size appropriately.
  611. */
  612. int ff_bprint_to_codecpar_extradata(AVCodecParameters *par, struct AVBPrint *buf);
  613. /**
  614. * Find the next packet in the interleaving queue for the given stream.
  615. * The pkt parameter is filled in with the queued packet, including
  616. * references to the data (which the caller is not allowed to keep or
  617. * modify).
  618. *
  619. * @return 0 if a packet was found, a negative value if no packet was found
  620. */
  621. int ff_interleaved_peek(AVFormatContext *s, int stream,
  622. AVPacket *pkt, int add_offset);
  623. int ff_lock_avformat(void);
  624. int ff_unlock_avformat(void);
  625. /**
  626. * Set AVFormatContext url field to the provided pointer. The pointer must
  627. * point to a valid string. The existing url field is freed if necessary. Also
  628. * set the legacy filename field to the same string which was provided in url.
  629. */
  630. void ff_format_set_url(AVFormatContext *s, char *url);
  631. #define FF_PACKETLIST_FLAG_REF_PACKET (1 << 0) /**< Create a new reference for the packet instead of
  632. transferring the ownership of the existing one to the
  633. list. */
  634. /**
  635. * Append an AVPacket to the list.
  636. *
  637. * @param head List head element
  638. * @param tail List tail element
  639. * @param pkt The packet being appended. The data described in it will
  640. * be made reference counted if it isn't already.
  641. * @param flags Any combination of FF_PACKETLIST_FLAG_* flags
  642. * @return 0 on success, negative AVERROR value on failure. On failure,
  643. the list is unchanged
  644. */
  645. int ff_packet_list_put(AVPacketList **head, AVPacketList **tail,
  646. AVPacket *pkt, int flags);
  647. /**
  648. * Remove the oldest AVPacket in the list and return it.
  649. * The behaviour is undefined if the packet list is empty.
  650. *
  651. * @note The pkt will be overwritten completely. The caller owns the
  652. * packet and must unref it by itself.
  653. *
  654. * @param head List head element
  655. * @param tail List tail element
  656. * @param pkt Pointer to an AVPacket struct
  657. * @return 0 on success. Success is guaranteed
  658. * if the packet list is not empty.
  659. */
  660. int ff_packet_list_get(AVPacketList **head, AVPacketList **tail,
  661. AVPacket *pkt);
  662. /**
  663. * Wipe the list and unref all the packets in it.
  664. *
  665. * @param head List head element
  666. * @param tail List tail element
  667. */
  668. void ff_packet_list_free(AVPacketList **head, AVPacketList **tail);
  669. void avpriv_register_devices(const AVOutputFormat * const o[], const AVInputFormat * const i[]);
  670. #endif /* AVFORMAT_INTERNAL_H */