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
21 #ifndef AVFORMAT_INTERNAL_H
22 #define AVFORMAT_INTERNAL_H
23
24 #include <stdint.h>
26
27 #define MAX_URL_SIZE 4096
28
29 /** size of probe buffer, for guessing file type from file contents */
30 #define PROBE_BUF_MIN 2048
31 #define PROBE_BUF_MAX (1 << 20)
32
33 #ifdef DEBUG
34 # define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
35 #else
36 # define hex_dump_debug(class, buf, size)
37 #endif
38
43
48
50 /**
51 * Number of streams relevant for interleaving.
52 * Muxing only.
53 */
55 };
56
57 #ifdef __GNUC__
58 #define dynarray_add(tab, nb_ptr, elem)\
59 do {\
60 __typeof__(tab) _tab = (tab);\
61 __typeof__(elem) _elem = (elem);\
62 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
63 av_dynarray_add(_tab, nb_ptr, _elem);\
64 } while(0)
65 #else
66 #define dynarray_add(tab, nb_ptr, elem)\
67 do {\
68 av_dynarray_add((tab), nb_ptr, (elem));\
69 } while(0)
70 #endif
71
73
75
76 /**
77 * Parse a string of hexadecimal strings. Any space between the hexadecimal
78 * digits is ignored.
79 *
80 * @param data if non-null, the parsed data is written to this pointer
81 * @param p the string to parse
82 * @return the number of bytes written (or to be written, if data is null)
83 */
85
87
88 /**
89 * Add packet to AVFormatContext->packet_buffer list, determining its
90 * interleaved position using compare() function argument.
91 * @return 0, or < 0 on error
92 */
95
97
98 #define NTP_OFFSET 2208988800ULL
99 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
100
101 /** Get the current time since NTP epoch in microseconds. */
103
104 /**
105 * Append the media-specific SDP fragment for the media stream c
106 * to the buffer buff.
107 *
108 * Note, the buffer needs to be initialized, since it is appended to
109 * existing content.
110 *
111 * @param buff the buffer to append the SDP fragment to
112 * @param size the size of the buff buffer
113 * @param st the AVStream of the media to describe
114 * @param idx the global stream index
115 * @param dest_addr the destination address of the media stream, may be NULL
116 * @param dest_type the destination address type, may be NULL
117 * @param port the destination port of the media stream, 0 if unknown
118 * @param ttl the time to live of the stream, 0 if not multicast
119 * @param fmt the AVFormatContext, which might contain options modifying
120 * the generated SDP
121 */
123 const char *dest_addr, const char *dest_type,
125
126 /**
127 * Write a packet to another muxer than the one the user originally
128 * intended. Useful when chaining muxers, where one muxer internally
129 * writes a received packet to another muxer.
130 *
131 * @param dst the muxer to write the packet to
132 * @param dst_stream the stream index within dst to write the packet to
133 * @param pkt the packet to be written
134 * @param src the muxer the packet originally was intended for
135 * @return the value av_write_frame returned
136 */
139
140 /**
141 * Get the length in bytes which is needed to store val as v.
142 */
144
145 /**
146 * Put val using a variable number of bytes.
147 */
149
150 /**
151 * Read a whole line of text from AVIOContext. Stop reading after reaching
152 * either a \\n, a \0円 or EOF. The returned string is always \0円-terminated,
153 * and may be truncated if the buffer is too small.
154 *
155 * @param s the read-only AVIOContext
156 * @param buf buffer to store the read line
157 * @param maxlen size of the buffer
158 * @return the length of the string written in the buffer, not including the
159 * final \0円
160 */
162
163 #define SPACE_CHARS " \t\r\n"
164
165 /**
166 * Callback function type for ff_parse_key_value.
167 *
168 * @param key a pointer to the key
169 * @param key_len the number of bytes that belong to the key, including the '='
170 * char
171 * @param dest return the destination pointer for the value in *dest, may
172 * be null to ignore the value
173 * @param dest_len the length of the *dest buffer
174 */
176 int key_len, char **dest, int *dest_len);
177 /**
178 * Parse a string with comma-separated key=value pairs. The value strings
179 * may be quoted and may contain escaped characters within quoted strings.
180 *
181 * @param str the string to parse
182 * @param callback_get_buf function that returns where to store the
183 * unescaped value string.
184 * @param context the opaque context pointer to pass to callback_get_buf
185 */
187 void *context);
188
189 /**
190 * Find stream index based on format-specific stream ID
191 * @return stream index, or < 0 on error
192 */
194
195 /**
196 * Internal version of av_index_search_timestamp
197 */
199 int64_t wanted_timestamp,
int flags);
200
201 /**
202 * Internal version of av_add_index_entry
203 */
205 int *nb_index_entries,
206 unsigned int *index_entries_allocated_size,
208
209 /**
210 * Add a new chapter.
211 *
212 * @param s media file handle
213 * @param id unique ID for this chapter
214 * @param start chapter start time in time_base units
215 * @param end chapter end time in time_base units
216 * @param title chapter title
217 *
218 * @return AVChapter or NULL on error
219 */
221 int64_t
start, int64_t
end,
const char *title);
222
223 /**
224 * Ensure the index uses less memory than the maximum specified in
225 * AVFormatContext.max_index_size by discarding entries if it grows
226 * too large.
227 */
229
231
232 /**
233 * Convert a date string in ISO8601 format to Unix timestamp.
234 */
236
237 /**
238 * Perform a binary search using av_index_search_timestamp() and
239 * AVInputFormat.read_timestamp().
240 *
241 * @param target_ts target timestamp in the time base of the given stream
242 * @param stream_index stream number
243 */
245 int64_t target_ts,
int flags);
246
247 /**
248 * Update cur_dts of all streams based on the given timestamp and AVStream.
249 *
250 * Stream ref_st unchanged, others set cur_dts in their native time base.
251 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
252 * @param timestamp new dts expressed in time_base of param ref_st
253 * @param ref_st reference stream giving time_base of param timestamp
254 */
256
258 int64_t (*read_timestamp)(
struct AVFormatContext *,
int , int64_t *, int64_t ));
259
260 /**
261 * Perform a binary search using read_timestamp().
262 *
263 * @param target_ts target timestamp in the time base of the given stream
264 * @param stream_index stream number
265 */
267 int64_t target_ts, int64_t pos_min,
268 int64_t pos_max, int64_t pos_limit,
269 int64_t ts_min, int64_t ts_max,
270 int flags, int64_t *ts_ret,
271 int64_t (*read_timestamp)(
struct AVFormatContext *,
int , int64_t *, int64_t ));
272
273 /**
274 * Set the time base and wrapping info for a given stream. This will be used
275 * to interpret the stream's timestamps. If the new time base is invalid
276 * (numerator or denominator are non-positive), it leaves the stream
277 * unchanged.
278 *
279 * @param s stream
280 * @param pts_wrap_bits number of bits effectively used by the pts
281 * (used for wrap control)
282 * @param pts_num time base numerator
283 * @param pts_den time base denominator
284 */
286 unsigned int pts_num, unsigned int pts_den);
287
288 /**
289 * Add side data to a packet for changing parameters to the given values.
290 * Parameters set to 0 aren't included in the change.
291 */
295
296 /**
297 * Set the timebase for each stream from the corresponding codec timebase and
298 * print it.
299 */
301
302 /**
303 * Read a transport packet from a media file.
304 *
305 * @param s media file handle
306 * @param pkt is filled
307 * @return 0 if OK, AVERROR_xxx on error
308 */
310
311 /**
312 * Interleave a packet per dts in an output media file.
313 *
314 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
315 * function, so they cannot be used after it. Note that calling av_free_packet()
316 * on them is still safe.
317 *
318 * @param s media file handle
319 * @param out the interleaved packet will be output here
320 * @param pkt the input packet
321 * @param flush 1 if no further packets are available as input and all
322 * remaining packets should be output
323 * @return 1 if a packet was output, 0 if no packet could be output,
324 * < 0 if an error occurred
325 */
328
330
331 /**
332 * Return the frame duration in seconds. Return 0 if not available.
333 */
336
338
340
342
343 /**
344 * Select a PCM codec based on the given parameters.
345 *
346 * @param bps bits-per-sample
347 * @param flt floating-point
348 * @param be big-endian
349 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
350 * e.g. the 1st bit indicates if 8-bit should be signed or
351 * unsigned, the 2nd bit indicates if 16-bit should be signed or
352 * unsigned, etc... This is useful for formats such as WAVE where
353 * only 8-bit is unsigned and all other bit depths are signed.
354 * @return a PCM codec id or AV_CODEC_ID_NONE
355 */
357
358 /**
359 * Chooses a timebase for muxing the specified stream.
360 *
361 * The choosen timebase allows sample accurate timestamps based
362 * on the framerate or sample rate for audio streams. It also is
363 * at least as precisse as 1/min_precission would be.
364 */
366
367 /**
368 * Generate standard extradata for AVC-Intra based on width/height and field
369 * order.
370 */
372
373 /**
374 * Allocate extradata with additional FF_INPUT_BUFFER_PADDING_SIZE at end
375 * which is always set to 0.
376 *
377 * @param size size of extradata
378 * @return 0 if OK, AVERROR_xxx on error
379 */
381
382 /**
383 * Allocate extradata with additional FF_INPUT_BUFFER_PADDING_SIZE at end
384 * which is always set to 0 and fill it from pb.
385 *
386 * @param size size of extradata
387 * @return >= 0 if OK, AVERROR_xxx on error
388 */
390
391 /**
392 * add frame for rfps calculation.
393 *
394 * @param dts timestamp of the i-th frame
395 * @return 0 if OK, AVERROR_xxx on error
396 */
398
400
401 /**
402 * Flags for AVFormatContext.write_uncoded_frame()
403 */
405
406 /**
407 * Query whether the feature is possible on this stream.
408 * The frame argument is ignored.
409 */
411
412 };
413
414
415 #endif /* AVFORMAT_INTERNAL_H */