2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
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.
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.
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
21 #ifndef AVFORMAT_INTERNAL_H
22 #define AVFORMAT_INTERNAL_H
26 #include "os_support.h"
28 #define MAX_URL_SIZE 4096
30 /** size of probe buffer, for guessing file type from file contents */
31 #define PROBE_BUF_MIN 2048
32 #define PROBE_BUF_MAX (1 << 20)
34 #define MAX_PROBE_PACKETS 2500
37 # define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
39 # define hex_dump_debug(class, buf, size) do { if (0) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size); } while(0)
42 typedef struct AVCodecTag {
47 typedef struct CodecMime{
52 /*************************************************/
53 /* fractional numbers for exact pts handling */
56 * The exact value of the fractional number is: 'val + num / den'.
57 * num is assumed to be 0 <= num < den.
59 typedef struct FFFrac {
60 int64_t val, num, den;
64 struct AVFormatInternal {
66 * Number of streams relevant for interleaving.
69 int nb_interleaved_streams;
72 * This buffer is only needed when packets were already buffered but
73 * not decoded, for example to get the codec parameters in MPEG
76 struct AVPacketList *packet_buffer;
77 struct AVPacketList *packet_buffer_end;
79 /* av_seek_frame() support */
80 int64_t data_offset; /**< offset of the first packet */
83 * Raw packets from the demuxer, prior to parsing and decoding.
84 * This buffer is used for buffering packets until the codec can
85 * be identified, as parsing cannot be done without knowing the
88 struct AVPacketList *raw_packet_buffer;
89 struct AVPacketList *raw_packet_buffer_end;
91 * Packets split by the parser get queued here.
93 struct AVPacketList *parse_queue;
94 struct AVPacketList *parse_queue_end;
96 * Remaining size available for raw_packet_buffer, in bytes.
98 #define RAW_PACKET_BUFFER_SIZE 2500000
99 int raw_packet_buffer_remaining_size;
102 * Offset to remap timestamps to be non-negative.
103 * Expressed in timebase units.
104 * @see AVStream.mux_ts_offset
109 * Timebase for the timestamp offset.
111 AVRational offset_timebase;
113 int inject_global_side_data;
115 int avoid_negative_ts_use_pts;
119 #define dynarray_add(tab, nb_ptr, elem)\
121 __typeof__(tab) _tab = (tab);\
122 __typeof__(elem) _elem = (elem);\
123 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
124 av_dynarray_add(_tab, nb_ptr, _elem);\
127 #define dynarray_add(tab, nb_ptr, elem)\
129 av_dynarray_add((tab), nb_ptr, (elem));\
133 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
135 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
138 * Parse a string of hexadecimal strings. Any space between the hexadecimal
141 * @param data if non-null, the parsed data is written to this pointer
142 * @param p the string to parse
143 * @return the number of bytes written (or to be written, if data is null)
145 int ff_hex_to_data(uint8_t *data, const char *p);
147 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
150 * Add packet to AVFormatContext->packet_buffer list, determining its
151 * interleaved position using compare() function argument.
152 * @return 0, or < 0 on error
154 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
155 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
157 void ff_read_frame_flush(AVFormatContext *s);
159 #define NTP_OFFSET 2208988800ULL
160 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
162 /** Get the current time since NTP epoch in microseconds. */
163 uint64_t ff_ntp_time(void);
166 * Append the media-specific SDP fragment for the media stream c
167 * to the buffer buff.
169 * Note, the buffer needs to be initialized, since it is appended to
172 * @param buff the buffer to append the SDP fragment to
173 * @param size the size of the buff buffer
174 * @param st the AVStream of the media to describe
175 * @param idx the global stream index
176 * @param dest_addr the destination address of the media stream, may be NULL
177 * @param dest_type the destination address type, may be NULL
178 * @param port the destination port of the media stream, 0 if unknown
179 * @param ttl the time to live of the stream, 0 if not multicast
180 * @param fmt the AVFormatContext, which might contain options modifying
183 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
184 const char *dest_addr, const char *dest_type,
185 int port, int ttl, AVFormatContext *fmt);
188 * Write a packet to another muxer than the one the user originally
189 * intended. Useful when chaining muxers, where one muxer internally
190 * writes a received packet to another muxer.
192 * @param dst the muxer to write the packet to
193 * @param dst_stream the stream index within dst to write the packet to
194 * @param pkt the packet to be written
195 * @param src the muxer the packet originally was intended for
196 * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
197 * @return the value av_write_frame returned
199 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
200 AVFormatContext *src, int interleave);
203 * Get the length in bytes which is needed to store val as v.
205 int ff_get_v_length(uint64_t val);
208 * Put val using a variable number of bytes.
210 void ff_put_v(AVIOContext *bc, uint64_t val);
213 * Read a whole line of text from AVIOContext. Stop reading after reaching
214 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
215 * and may be truncated if the buffer is too small.
217 * @param s the read-only AVIOContext
218 * @param buf buffer to store the read line
219 * @param maxlen size of the buffer
220 * @return the length of the string written in the buffer, not including the
223 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
225 #define SPACE_CHARS " \t\r\n"
228 * Callback function type for ff_parse_key_value.
230 * @param key a pointer to the key
231 * @param key_len the number of bytes that belong to the key, including the '='
233 * @param dest return the destination pointer for the value in *dest, may
234 * be null to ignore the value
235 * @param dest_len the length of the *dest buffer
237 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
238 int key_len, char **dest, int *dest_len);
240 * Parse a string with comma-separated key=value pairs. The value strings
241 * may be quoted and may contain escaped characters within quoted strings.
243 * @param str the string to parse
244 * @param callback_get_buf function that returns where to store the
245 * unescaped value string.
246 * @param context the opaque context pointer to pass to callback_get_buf
248 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
252 * Find stream index based on format-specific stream ID
253 * @return stream index, or < 0 on error
255 int ff_find_stream_index(AVFormatContext *s, int id);
258 * Internal version of av_index_search_timestamp
260 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
261 int64_t wanted_timestamp, int flags);
264 * Internal version of av_add_index_entry
266 int ff_add_index_entry(AVIndexEntry **index_entries,
267 int *nb_index_entries,
268 unsigned int *index_entries_allocated_size,
269 int64_t pos, int64_t timestamp, int size, int distance, int flags);
271 void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
276 * @param s media file handle
277 * @param id unique ID for this chapter
278 * @param start chapter start time in time_base units
279 * @param end chapter end time in time_base units
280 * @param title chapter title
282 * @return AVChapter or NULL on error
284 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
285 int64_t start, int64_t end, const char *title);
288 * Ensure the index uses less memory than the maximum specified in
289 * AVFormatContext.max_index_size by discarding entries if it grows
292 void ff_reduce_index(AVFormatContext *s, int stream_index);
294 enum AVCodecID ff_guess_image2_codec(const char *filename);
297 * Convert a date string in ISO8601 format to Unix timestamp.
299 int64_t ff_iso8601_to_unix_time(const char *datestr);
302 * Perform a binary search using av_index_search_timestamp() and
303 * AVInputFormat.read_timestamp().
305 * @param target_ts target timestamp in the time base of the given stream
306 * @param stream_index stream number
308 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
309 int64_t target_ts, int flags);
312 * Update cur_dts of all streams based on the given timestamp and AVStream.
314 * Stream ref_st unchanged, others set cur_dts in their native time base.
315 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
316 * @param timestamp new dts expressed in time_base of param ref_st
317 * @param ref_st reference stream giving time_base of param timestamp
319 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
321 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
322 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
325 * Perform a binary search using read_timestamp().
327 * @param target_ts target timestamp in the time base of the given stream
328 * @param stream_index stream number
330 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
331 int64_t target_ts, int64_t pos_min,
332 int64_t pos_max, int64_t pos_limit,
333 int64_t ts_min, int64_t ts_max,
334 int flags, int64_t *ts_ret,
335 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
338 * Set the time base and wrapping info for a given stream. This will be used
339 * to interpret the stream's timestamps. If the new time base is invalid
340 * (numerator or denominator are non-positive), it leaves the stream
344 * @param pts_wrap_bits number of bits effectively used by the pts
345 * (used for wrap control)
346 * @param pts_num time base numerator
347 * @param pts_den time base denominator
349 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
350 unsigned int pts_num, unsigned int pts_den);
353 * Add side data to a packet for changing parameters to the given values.
354 * Parameters set to 0 aren't included in the change.
356 int ff_add_param_change(AVPacket *pkt, int32_t channels,
357 uint64_t channel_layout, int32_t sample_rate,
358 int32_t width, int32_t height);
361 * Set the timebase for each stream from the corresponding codec timebase and
364 int ff_framehash_write_header(AVFormatContext *s);
367 * Read a transport packet from a media file.
369 * @param s media file handle
370 * @param pkt is filled
371 * @return 0 if OK, AVERROR_xxx on error
373 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
376 * Interleave a packet per dts in an output media file.
378 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
379 * function, so they cannot be used after it. Note that calling av_packet_unref()
380 * on them is still safe.
382 * @param s media file handle
383 * @param out the interleaved packet will be output here
384 * @param pkt the input packet
385 * @param flush 1 if no further packets are available as input and all
386 * remaining packets should be output
387 * @return 1 if a packet was output, 0 if no packet could be output,
388 * < 0 if an error occurred
390 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
391 AVPacket *pkt, int flush);
393 void ff_free_stream(AVFormatContext *s, AVStream *st);
396 * Return the frame duration in seconds. Return 0 if not available.
398 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
399 AVCodecParserContext *pc, AVPacket *pkt);
401 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
403 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
406 * Select a PCM codec based on the given parameters.
408 * @param bps bits-per-sample
409 * @param flt floating-point
410 * @param be big-endian
411 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
412 * e.g. the 1st bit indicates if 8-bit should be signed or
413 * unsigned, the 2nd bit indicates if 16-bit should be signed or
414 * unsigned, etc... This is useful for formats such as WAVE where
415 * only 8-bit is unsigned and all other bit depths are signed.
416 * @return a PCM codec id or AV_CODEC_ID_NONE
418 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
421 * Chooses a timebase for muxing the specified stream.
423 * The chosen timebase allows sample accurate timestamps based
424 * on the framerate or sample rate for audio streams. It also is
425 * at least as precise as 1/min_precision would be.
427 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
430 * Chooses a timebase for muxing the specified stream.
432 enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
435 * Generate standard extradata for AVC-Intra based on width/height and field
438 int ff_generate_avci_extradata(AVStream *st);
441 * Wrap errno on rename() error.
443 * @param oldpath source path
444 * @param newpath destination path
445 * @return 0 or AVERROR on failure
447 static inline int ff_rename(const char *oldpath, const char *newpath, void *logctx)
450 if (rename(oldpath, newpath) == -1) {
451 ret = AVERROR(errno);
453 av_log(logctx, AV_LOG_ERROR, "failed to rename file %s to %s\n", oldpath, newpath);
459 * Add new side data to a stream. If a side data of this type already exists, it
462 uint8_t *ff_stream_new_side_data(AVStream *st, enum AVPacketSideDataType type,
466 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
467 * which is always set to 0.
469 * @param size size of extradata
470 * @return 0 if OK, AVERROR_xxx on error
472 int ff_alloc_extradata(AVCodecContext *avctx, int size);
475 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
476 * which is always set to 0 and fill it from pb.
478 * @param size size of extradata
479 * @return >= 0 if OK, AVERROR_xxx on error
481 int ff_get_extradata(AVCodecContext *avctx, AVIOContext *pb, int size);
484 * add frame for rfps calculation.
486 * @param dts timestamp of the i-th frame
487 * @return 0 if OK, AVERROR_xxx on error
489 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
491 void ff_rfps_calculate(AVFormatContext *ic);
494 * Flags for AVFormatContext.write_uncoded_frame()
496 enum AVWriteUncodedFrameFlags {
499 * Query whether the feature is possible on this stream.
500 * The frame argument is ignored.
502 AV_WRITE_UNCODED_FRAME_QUERY = 0x0001,
507 * Copies the whilelists from one context to the other
509 int ff_copy_whitelists(AVFormatContext *dst, AVFormatContext *src);
511 int ffio_open2_wrapper(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags,
512 const AVIOInterruptCB *int_cb, AVDictionary **options);
514 #endif /* AVFORMAT_INTERNAL_H */