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