internal.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  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 "avformat.h"
  24. #define MAX_URL_SIZE 4096
  25. #ifdef DEBUG
  26. # define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
  27. #else
  28. # define hex_dump_debug(class, buf, size)
  29. #endif
  30. typedef struct AVCodecTag {
  31. enum CodecID id;
  32. unsigned int tag;
  33. } AVCodecTag;
  34. #ifdef __GNUC__
  35. #define dynarray_add(tab, nb_ptr, elem)\
  36. do {\
  37. __typeof__(tab) _tab = (tab);\
  38. __typeof__(elem) _elem = (elem);\
  39. (void)sizeof(**_tab == _elem); /* check that types are compatible */\
  40. av_dynarray_add(_tab, nb_ptr, _elem);\
  41. } while(0)
  42. #else
  43. #define dynarray_add(tab, nb_ptr, elem)\
  44. do {\
  45. av_dynarray_add((tab), nb_ptr, (elem));\
  46. } while(0)
  47. #endif
  48. struct tm *brktimegm(time_t secs, struct tm *tm);
  49. char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
  50. /**
  51. * Parse a string of hexadecimal strings. Any space between the hexadecimal
  52. * digits is ignored.
  53. *
  54. * @param data if non-null, the parsed data is written to this pointer
  55. * @param p the string to parse
  56. * @return the number of bytes written (or to be written, if data is null)
  57. */
  58. int ff_hex_to_data(uint8_t *data, const char *p);
  59. void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
  60. /**
  61. * Add packet to AVFormatContext->packet_buffer list, determining its
  62. * interleaved position using compare() function argument.
  63. * @return 0, or < 0 on error
  64. */
  65. int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
  66. int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
  67. void ff_read_frame_flush(AVFormatContext *s);
  68. #define NTP_OFFSET 2208988800ULL
  69. #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
  70. /** Get the current time since NTP epoch in microseconds. */
  71. uint64_t ff_ntp_time(void);
  72. /**
  73. * Assemble a URL string from components. This is the reverse operation
  74. * of av_url_split.
  75. *
  76. * Note, this requires networking to be initialized, so the caller must
  77. * ensure ff_network_init has been called.
  78. *
  79. * @see av_url_split
  80. *
  81. * @param str the buffer to fill with the url
  82. * @param size the size of the str buffer
  83. * @param proto the protocol identifier, if null, the separator
  84. * after the identifier is left out, too
  85. * @param authorization an optional authorization string, may be null.
  86. * An empty string is treated the same as a null string.
  87. * @param hostname the host name string
  88. * @param port the port number, left out from the string if negative
  89. * @param fmt a generic format string for everything to add after the
  90. * host/port, may be null
  91. * @return the number of characters written to the destination buffer
  92. */
  93. int ff_url_join(char *str, int size, const char *proto,
  94. const char *authorization, const char *hostname,
  95. int port, const char *fmt, ...) av_printf_format(7, 8);
  96. /**
  97. * Append the media-specific SDP fragment for the media stream c
  98. * to the buffer buff.
  99. *
  100. * Note, the buffer needs to be initialized, since it is appended to
  101. * existing content.
  102. *
  103. * @param buff the buffer to append the SDP fragment to
  104. * @param size the size of the buff buffer
  105. * @param c the AVCodecContext of the media to describe
  106. * @param dest_addr the destination address of the media stream, may be NULL
  107. * @param dest_type the destination address type, may be NULL
  108. * @param port the destination port of the media stream, 0 if unknown
  109. * @param ttl the time to live of the stream, 0 if not multicast
  110. * @param fmt the AVFormatContext, which might contain options modifying
  111. * the generated SDP
  112. */
  113. void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
  114. const char *dest_addr, const char *dest_type,
  115. int port, int ttl, AVFormatContext *fmt);
  116. /**
  117. * Write a packet to another muxer than the one the user originally
  118. * intended. Useful when chaining muxers, where one muxer internally
  119. * writes a received packet to another muxer.
  120. *
  121. * @param dst the muxer to write the packet to
  122. * @param dst_stream the stream index within dst to write the packet to
  123. * @param pkt the packet to be written
  124. * @param src the muxer the packet originally was intended for
  125. * @return the value av_write_frame returned
  126. */
  127. int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
  128. AVFormatContext *src);
  129. /**
  130. * Get the length in bytes which is needed to store val as v.
  131. */
  132. int ff_get_v_length(uint64_t val);
  133. /**
  134. * Put val using a variable number of bytes.
  135. */
  136. void ff_put_v(AVIOContext *bc, uint64_t val);
  137. /**
  138. * Read a whole line of text from AVIOContext. Stop reading after reaching
  139. * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
  140. * and may be truncated if the buffer is too small.
  141. *
  142. * @param s the read-only AVIOContext
  143. * @param buf buffer to store the read line
  144. * @param maxlen size of the buffer
  145. * @return the length of the string written in the buffer, not including the
  146. * final \\0
  147. */
  148. int ff_get_line(AVIOContext *s, char *buf, int maxlen);
  149. #define SPACE_CHARS " \t\r\n"
  150. /**
  151. * Callback function type for ff_parse_key_value.
  152. *
  153. * @param key a pointer to the key
  154. * @param key_len the number of bytes that belong to the key, including the '='
  155. * char
  156. * @param dest return the destination pointer for the value in *dest, may
  157. * be null to ignore the value
  158. * @param dest_len the length of the *dest buffer
  159. */
  160. typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
  161. int key_len, char **dest, int *dest_len);
  162. /**
  163. * Parse a string with comma-separated key=value pairs. The value strings
  164. * may be quoted and may contain escaped characters within quoted strings.
  165. *
  166. * @param str the string to parse
  167. * @param callback_get_buf function that returns where to store the
  168. * unescaped value string.
  169. * @param context the opaque context pointer to pass to callback_get_buf
  170. */
  171. void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
  172. void *context);
  173. /**
  174. * Find stream index based on format-specific stream ID
  175. * @return stream index, or < 0 on error
  176. */
  177. int ff_find_stream_index(AVFormatContext *s, int id);
  178. /**
  179. * Internal version of av_index_search_timestamp
  180. */
  181. int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
  182. int64_t wanted_timestamp, int flags);
  183. /**
  184. * Internal version of av_add_index_entry
  185. */
  186. int ff_add_index_entry(AVIndexEntry **index_entries,
  187. int *nb_index_entries,
  188. unsigned int *index_entries_allocated_size,
  189. int64_t pos, int64_t timestamp, int size, int distance, int flags);
  190. /**
  191. * Add a new chapter.
  192. *
  193. * @param s media file handle
  194. * @param id unique ID for this chapter
  195. * @param start chapter start time in time_base units
  196. * @param end chapter end time in time_base units
  197. * @param title chapter title
  198. *
  199. * @return AVChapter or NULL on error
  200. */
  201. AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
  202. int64_t start, int64_t end, const char *title);
  203. /**
  204. * Ensure the index uses less memory than the maximum specified in
  205. * AVFormatContext.max_index_size by discarding entries if it grows
  206. * too large.
  207. */
  208. void ff_reduce_index(AVFormatContext *s, int stream_index);
  209. /*
  210. * Convert a relative url into an absolute url, given a base url.
  211. *
  212. * @param buf the buffer where output absolute url is written
  213. * @param size the size of buf
  214. * @param base the base url, may be equal to buf.
  215. * @param rel the new url, which is interpreted relative to base
  216. */
  217. void ff_make_absolute_url(char *buf, int size, const char *base,
  218. const char *rel);
  219. enum CodecID ff_guess_image2_codec(const char *filename);
  220. /**
  221. * Convert a date string in ISO8601 format to Unix timestamp.
  222. */
  223. int64_t ff_iso8601_to_unix_time(const char *datestr);
  224. /**
  225. * Perform a binary search using av_index_search_timestamp() and
  226. * AVInputFormat.read_timestamp().
  227. *
  228. * @param target_ts target timestamp in the time base of the given stream
  229. * @param stream_index stream number
  230. */
  231. int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
  232. int64_t target_ts, int flags);
  233. /**
  234. * Update cur_dts of all streams based on the given timestamp and AVStream.
  235. *
  236. * Stream ref_st unchanged, others set cur_dts in their native time base.
  237. * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
  238. * @param timestamp new dts expressed in time_base of param ref_st
  239. * @param ref_st reference stream giving time_base of param timestamp
  240. */
  241. void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
  242. /**
  243. * Perform a binary search using read_timestamp().
  244. *
  245. * @param target_ts target timestamp in the time base of the given stream
  246. * @param stream_index stream number
  247. */
  248. int64_t ff_gen_search(AVFormatContext *s, int stream_index,
  249. int64_t target_ts, int64_t pos_min,
  250. int64_t pos_max, int64_t pos_limit,
  251. int64_t ts_min, int64_t ts_max,
  252. int flags, int64_t *ts_ret,
  253. int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
  254. /**
  255. * Set the pts for a given stream. If the new values would be invalid
  256. * (<= 0), it leaves the AVStream unchanged.
  257. *
  258. * @param s stream
  259. * @param pts_wrap_bits number of bits effectively used by the pts
  260. * (used for wrap control, 33 is the value for MPEG)
  261. * @param pts_num numerator to convert to seconds (MPEG: 1)
  262. * @param pts_den denominator to convert to seconds (MPEG: 90000)
  263. */
  264. void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
  265. unsigned int pts_num, unsigned int pts_den);
  266. /**
  267. * Add side data to a packet for changing parameters to the given values.
  268. * Parameters set to 0 aren't included in the change.
  269. */
  270. int ff_add_param_change(AVPacket *pkt, int32_t channels,
  271. uint64_t channel_layout, int32_t sample_rate,
  272. int32_t width, int32_t height);
  273. #endif /* AVFORMAT_INTERNAL_H */