]> git.sesse.net Git - ffmpeg/blob - libavformat/internal.h
electronicarts: move video stream properties into dedicated structure
[ffmpeg] / libavformat / internal.h
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>
25 #include "avformat.h"
26 #include "os_support.h"
27
28 #define MAX_URL_SIZE 4096
29
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)
33
34 #ifdef DEBUG
35 #    define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
36 #else
37 #    define hex_dump_debug(class, buf, size) do { if (0) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size); } while(0)
38 #endif
39
40 typedef struct AVCodecTag {
41     enum AVCodecID id;
42     unsigned int tag;
43 } AVCodecTag;
44
45 typedef struct CodecMime{
46     char str[32];
47     enum AVCodecID id;
48 } CodecMime;
49
50 struct AVFormatInternal {
51     /**
52      * Number of streams relevant for interleaving.
53      * Muxing only.
54      */
55     int nb_interleaved_streams;
56
57     /**
58      * This buffer is only needed when packets were already buffered but
59      * not decoded, for example to get the codec parameters in MPEG
60      * streams.
61      */
62     struct AVPacketList *packet_buffer;
63     struct AVPacketList *packet_buffer_end;
64
65     /* av_seek_frame() support */
66     int64_t data_offset; /**< offset of the first packet */
67
68     /**
69      * Raw packets from the demuxer, prior to parsing and decoding.
70      * This buffer is used for buffering packets until the codec can
71      * be identified, as parsing cannot be done without knowing the
72      * codec.
73      */
74     struct AVPacketList *raw_packet_buffer;
75     struct AVPacketList *raw_packet_buffer_end;
76     /**
77      * Packets split by the parser get queued here.
78      */
79     struct AVPacketList *parse_queue;
80     struct AVPacketList *parse_queue_end;
81     /**
82      * Remaining size available for raw_packet_buffer, in bytes.
83      */
84 #define RAW_PACKET_BUFFER_SIZE 2500000
85     int raw_packet_buffer_remaining_size;
86
87     /**
88      * Offset to remap timestamps to be non-negative.
89      * Expressed in timebase units.
90      * @see AVStream.mux_ts_offset
91      */
92     int64_t offset;
93
94     /**
95      * Timebase for the timestamp offset.
96      */
97     AVRational offset_timebase;
98
99     int inject_global_side_data;
100
101     int avoid_negative_ts_use_pts;
102 };
103
104 #ifdef __GNUC__
105 #define dynarray_add(tab, nb_ptr, elem)\
106 do {\
107     __typeof__(tab) _tab = (tab);\
108     __typeof__(elem) _elem = (elem);\
109     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
110     av_dynarray_add(_tab, nb_ptr, _elem);\
111 } while(0)
112 #else
113 #define dynarray_add(tab, nb_ptr, elem)\
114 do {\
115     av_dynarray_add((tab), nb_ptr, (elem));\
116 } while(0)
117 #endif
118
119 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
120
121 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
122
123 /**
124  * Parse a string of hexadecimal strings. Any space between the hexadecimal
125  * digits is ignored.
126  *
127  * @param data if non-null, the parsed data is written to this pointer
128  * @param p the string to parse
129  * @return the number of bytes written (or to be written, if data is null)
130  */
131 int ff_hex_to_data(uint8_t *data, const char *p);
132
133 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
134
135 /**
136  * Add packet to AVFormatContext->packet_buffer list, determining its
137  * interleaved position using compare() function argument.
138  * @return 0, or < 0 on error
139  */
140 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
141                              int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
142
143 void ff_read_frame_flush(AVFormatContext *s);
144
145 #define NTP_OFFSET 2208988800ULL
146 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
147
148 /** Get the current time since NTP epoch in microseconds. */
149 uint64_t ff_ntp_time(void);
150
151 /**
152  * Append the media-specific SDP fragment for the media stream c
153  * to the buffer buff.
154  *
155  * Note, the buffer needs to be initialized, since it is appended to
156  * existing content.
157  *
158  * @param buff the buffer to append the SDP fragment to
159  * @param size the size of the buff buffer
160  * @param st the AVStream of the media to describe
161  * @param idx the global stream index
162  * @param dest_addr the destination address of the media stream, may be NULL
163  * @param dest_type the destination address type, may be NULL
164  * @param port the destination port of the media stream, 0 if unknown
165  * @param ttl the time to live of the stream, 0 if not multicast
166  * @param fmt the AVFormatContext, which might contain options modifying
167  *            the generated SDP
168  */
169 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
170                         const char *dest_addr, const char *dest_type,
171                         int port, int ttl, AVFormatContext *fmt);
172
173 /**
174  * Write a packet to another muxer than the one the user originally
175  * intended. Useful when chaining muxers, where one muxer internally
176  * writes a received packet to another muxer.
177  *
178  * @param dst the muxer to write the packet to
179  * @param dst_stream the stream index within dst to write the packet to
180  * @param pkt the packet to be written
181  * @param src the muxer the packet originally was intended for
182  * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
183  * @return the value av_write_frame returned
184  */
185 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
186                      AVFormatContext *src, int interleave);
187
188 /**
189  * Get the length in bytes which is needed to store val as v.
190  */
191 int ff_get_v_length(uint64_t val);
192
193 /**
194  * Put val using a variable number of bytes.
195  */
196 void ff_put_v(AVIOContext *bc, uint64_t val);
197
198 /**
199  * Read a whole line of text from AVIOContext. Stop reading after reaching
200  * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
201  * and may be truncated if the buffer is too small.
202  *
203  * @param s the read-only AVIOContext
204  * @param buf buffer to store the read line
205  * @param maxlen size of the buffer
206  * @return the length of the string written in the buffer, not including the
207  *         final \\0
208  */
209 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
210
211 #define SPACE_CHARS " \t\r\n"
212
213 /**
214  * Callback function type for ff_parse_key_value.
215  *
216  * @param key a pointer to the key
217  * @param key_len the number of bytes that belong to the key, including the '='
218  *                char
219  * @param dest return the destination pointer for the value in *dest, may
220  *             be null to ignore the value
221  * @param dest_len the length of the *dest buffer
222  */
223 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
224                                     int key_len, char **dest, int *dest_len);
225 /**
226  * Parse a string with comma-separated key=value pairs. The value strings
227  * may be quoted and may contain escaped characters within quoted strings.
228  *
229  * @param str the string to parse
230  * @param callback_get_buf function that returns where to store the
231  *                         unescaped value string.
232  * @param context the opaque context pointer to pass to callback_get_buf
233  */
234 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
235                         void *context);
236
237 /**
238  * Find stream index based on format-specific stream ID
239  * @return stream index, or < 0 on error
240  */
241 int ff_find_stream_index(AVFormatContext *s, int id);
242
243 /**
244  * Internal version of av_index_search_timestamp
245  */
246 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
247                               int64_t wanted_timestamp, int flags);
248
249 /**
250  * Internal version of av_add_index_entry
251  */
252 int ff_add_index_entry(AVIndexEntry **index_entries,
253                        int *nb_index_entries,
254                        unsigned int *index_entries_allocated_size,
255                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
256
257 /**
258  * Add a new chapter.
259  *
260  * @param s media file handle
261  * @param id unique ID for this chapter
262  * @param start chapter start time in time_base units
263  * @param end chapter end time in time_base units
264  * @param title chapter title
265  *
266  * @return AVChapter or NULL on error
267  */
268 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
269                               int64_t start, int64_t end, const char *title);
270
271 /**
272  * Ensure the index uses less memory than the maximum specified in
273  * AVFormatContext.max_index_size by discarding entries if it grows
274  * too large.
275  */
276 void ff_reduce_index(AVFormatContext *s, int stream_index);
277
278 enum AVCodecID ff_guess_image2_codec(const char *filename);
279
280 /**
281  * Convert a date string in ISO8601 format to Unix timestamp.
282  */
283 int64_t ff_iso8601_to_unix_time(const char *datestr);
284
285 /**
286  * Perform a binary search using av_index_search_timestamp() and
287  * AVInputFormat.read_timestamp().
288  *
289  * @param target_ts target timestamp in the time base of the given stream
290  * @param stream_index stream number
291  */
292 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
293                          int64_t target_ts, int flags);
294
295 /**
296  * Update cur_dts of all streams based on the given timestamp and AVStream.
297  *
298  * Stream ref_st unchanged, others set cur_dts in their native time base.
299  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
300  * @param timestamp new dts expressed in time_base of param ref_st
301  * @param ref_st reference stream giving time_base of param timestamp
302  */
303 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
304
305 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
306                     int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
307
308 /**
309  * Perform a binary search using read_timestamp().
310  *
311  * @param target_ts target timestamp in the time base of the given stream
312  * @param stream_index stream number
313  */
314 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
315                       int64_t target_ts, int64_t pos_min,
316                       int64_t pos_max, int64_t pos_limit,
317                       int64_t ts_min, int64_t ts_max,
318                       int flags, int64_t *ts_ret,
319                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
320
321 /**
322  * Set the time base and wrapping info for a given stream. This will be used
323  * to interpret the stream's timestamps. If the new time base is invalid
324  * (numerator or denominator are non-positive), it leaves the stream
325  * unchanged.
326  *
327  * @param s stream
328  * @param pts_wrap_bits number of bits effectively used by the pts
329  *        (used for wrap control)
330  * @param pts_num time base numerator
331  * @param pts_den time base denominator
332  */
333 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
334                          unsigned int pts_num, unsigned int pts_den);
335
336 /**
337  * Add side data to a packet for changing parameters to the given values.
338  * Parameters set to 0 aren't included in the change.
339  */
340 int ff_add_param_change(AVPacket *pkt, int32_t channels,
341                         uint64_t channel_layout, int32_t sample_rate,
342                         int32_t width, int32_t height);
343
344 /**
345  * Set the timebase for each stream from the corresponding codec timebase and
346  * print it.
347  */
348 int ff_framehash_write_header(AVFormatContext *s);
349
350 /**
351  * Read a transport packet from a media file.
352  *
353  * @param s media file handle
354  * @param pkt is filled
355  * @return 0 if OK, AVERROR_xxx on error
356  */
357 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
358
359 /**
360  * Interleave a packet per dts in an output media file.
361  *
362  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
363  * function, so they cannot be used after it. Note that calling av_free_packet()
364  * on them is still safe.
365  *
366  * @param s media file handle
367  * @param out the interleaved packet will be output here
368  * @param pkt the input packet
369  * @param flush 1 if no further packets are available as input and all
370  *              remaining packets should be output
371  * @return 1 if a packet was output, 0 if no packet could be output,
372  *         < 0 if an error occurred
373  */
374 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
375                                  AVPacket *pkt, int flush);
376
377 void ff_free_stream(AVFormatContext *s, AVStream *st);
378
379 /**
380  * Return the frame duration in seconds. Return 0 if not available.
381  */
382 void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
383                                AVCodecParserContext *pc, AVPacket *pkt);
384
385 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
386
387 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
388
389 /**
390  * Select a PCM codec based on the given parameters.
391  *
392  * @param bps     bits-per-sample
393  * @param flt     floating-point
394  * @param be      big-endian
395  * @param sflags  signed flags. each bit corresponds to one byte of bit depth.
396  *                e.g. the 1st bit indicates if 8-bit should be signed or
397  *                unsigned, the 2nd bit indicates if 16-bit should be signed or
398  *                unsigned, etc... This is useful for formats such as WAVE where
399  *                only 8-bit is unsigned and all other bit depths are signed.
400  * @return        a PCM codec id or AV_CODEC_ID_NONE
401  */
402 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
403
404 /**
405  * Chooses a timebase for muxing the specified stream.
406  *
407  * The chosen timebase allows sample accurate timestamps based
408  * on the framerate or sample rate for audio streams. It also is
409  * at least as precise as 1/min_precision would be.
410  */
411 AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
412
413 /**
414  * Chooses a timebase for muxing the specified stream.
415  */
416 enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
417
418 /**
419  * Generate standard extradata for AVC-Intra based on width/height and field
420  * order.
421  */
422 int ff_generate_avci_extradata(AVStream *st);
423
424 /**
425  * Wrap errno on rename() error.
426  *
427  * @param oldpath source path
428  * @param newpath destination path
429  * @return        0 or AVERROR on failure
430  */
431 static inline int ff_rename(const char *oldpath, const char *newpath, void *logctx)
432 {
433     int ret = 0;
434     if (rename(oldpath, newpath) == -1) {
435         ret = AVERROR(errno);
436         if (logctx)
437             av_log(logctx, AV_LOG_ERROR, "failed to rename file %s to %s\n", oldpath, newpath);
438     }
439     return ret;
440 }
441
442 /**
443  * Add new side data to a stream. If a side data of this type already exists, it
444  * is replaced.
445  */
446 uint8_t *ff_stream_new_side_data(AVStream *st, enum AVPacketSideDataType type,
447                                  int size);
448
449 /**
450  * Allocate extradata with additional FF_INPUT_BUFFER_PADDING_SIZE at end
451  * which is always set to 0.
452  *
453  * @param size size of extradata
454  * @return 0 if OK, AVERROR_xxx on error
455  */
456 int ff_alloc_extradata(AVCodecContext *avctx, int size);
457
458 /**
459  * Allocate extradata with additional FF_INPUT_BUFFER_PADDING_SIZE at end
460  * which is always set to 0 and fill it from pb.
461  *
462  * @param size size of extradata
463  * @return >= 0 if OK, AVERROR_xxx on error
464  */
465 int ff_get_extradata(AVCodecContext *avctx, AVIOContext *pb, int size);
466
467 /**
468  * add frame for rfps calculation.
469  *
470  * @param dts timestamp of the i-th frame
471  * @return 0 if OK, AVERROR_xxx on error
472  */
473 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
474
475 void ff_rfps_calculate(AVFormatContext *ic);
476
477 /**
478  * Flags for AVFormatContext.write_uncoded_frame()
479  */
480 enum AVWriteUncodedFrameFlags {
481
482     /**
483      * Query whether the feature is possible on this stream.
484      * The frame argument is ignored.
485      */
486     AV_WRITE_UNCODED_FRAME_QUERY           = 0x0001,
487
488 };
489
490 /**
491  * Copies the whilelists from one context to the other
492  */
493 int ff_copy_whitelists(AVFormatContext *dst, AVFormatContext *src);
494
495 int ffio_open2_wrapper(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags,
496                        const AVIOInterruptCB *int_cb, AVDictionary **options);
497
498 #endif /* AVFORMAT_INTERNAL_H */