summaryrefslogtreecommitdiff
path: root/libavformat/internal.h (plain)
blob: 63a1724cfaa4f0dc372b70ce039466ba7a785584
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
44typedef struct AVCodecTag {
45 enum AVCodecID id;
46 unsigned int tag;
47} AVCodecTag;
48
49typedef 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 */
61typedef struct FFFrac {
62 int64_t val, num, den;
63} FFFrac;
64
65
66struct 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 int write_header_ret;
128
129 /**
130 * Timestamp of the end of the shortest stream.
131 */
132 int64_t shortest_end;
133
134 /**
135 * Whether or not avformat_init_output has already been called
136 */
137 int initialized;
138
139 /**
140 * Whether or not avformat_init_output fully initialized streams
141 */
142 int streams_initialized;
143
144 /**
145 * ID3v2 tag useful for MP3 demuxing
146 */
147 AVDictionary *id3v2_meta;
148};
149
150struct AVStreamInternal {
151 /**
152 * Set to 1 if the codec allows reordering, so pts can be different
153 * from dts.
154 */
155 int reorder;
156
157 /**
158 * bitstream filters to run on stream
159 * - encoding: Set by muxer using ff_stream_add_bitstream_filter
160 * - decoding: unused
161 */
162 AVBSFContext **bsfcs;
163 int nb_bsfcs;
164
165 /**
166 * Whether or not check_bitstream should still be run on each packet
167 */
168 int bitstream_checked;
169
170 /**
171 * The codec context used by avformat_find_stream_info, the parser, etc.
172 */
173 AVCodecContext *avctx;
174 /**
175 * 1 if avctx has been initialized with the values from the codec parameters
176 */
177 int avctx_inited;
178
179 enum AVCodecID orig_codec_id;
180
181 /**
182 * Whether the internal avctx needs to be updated from codecpar (after a late change to codecpar)
183 */
184 int need_context_update;
185};
186
187#ifdef __GNUC__
188#define dynarray_add(tab, nb_ptr, elem)\
189do {\
190 __typeof__(tab) _tab = (tab);\
191 __typeof__(elem) _elem = (elem);\
192 (void)sizeof(**_tab == _elem); /* check that types are compatible */\
193 av_dynarray_add(_tab, nb_ptr, _elem);\
194} while(0)
195#else
196#define dynarray_add(tab, nb_ptr, elem)\
197do {\
198 av_dynarray_add((tab), nb_ptr, (elem));\
199} while(0)
200#endif
201
202struct tm *ff_brktimegm(time_t secs, struct tm *tm);
203
204char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
205
206/**
207 * Parse a string of hexadecimal strings. Any space between the hexadecimal
208 * digits is ignored.
209 *
210 * @param data if non-null, the parsed data is written to this pointer
211 * @param p the string to parse
212 * @return the number of bytes written (or to be written, if data is null)
213 */
214int ff_hex_to_data(uint8_t *data, const char *p);
215
216/**
217 * Add packet to AVFormatContext->packet_buffer list, determining its
218 * interleaved position using compare() function argument.
219 * @return 0, or < 0 on error
220 */
221int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
222 int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
223
224void ff_read_frame_flush(AVFormatContext *s);
225
226#define NTP_OFFSET 2208988800ULL
227#define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
228
229/** Get the current time since NTP epoch in microseconds. */
230uint64_t ff_ntp_time(void);
231
232/**
233 * Append the media-specific SDP fragment for the media stream c
234 * to the buffer buff.
235 *
236 * Note, the buffer needs to be initialized, since it is appended to
237 * existing content.
238 *
239 * @param buff the buffer to append the SDP fragment to
240 * @param size the size of the buff buffer
241 * @param st the AVStream of the media to describe
242 * @param idx the global stream index
243 * @param dest_addr the destination address of the media stream, may be NULL
244 * @param dest_type the destination address type, may be NULL
245 * @param port the destination port of the media stream, 0 if unknown
246 * @param ttl the time to live of the stream, 0 if not multicast
247 * @param fmt the AVFormatContext, which might contain options modifying
248 * the generated SDP
249 */
250void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
251 const char *dest_addr, const char *dest_type,
252 int port, int ttl, AVFormatContext *fmt);
253
254/**
255 * Write a packet to another muxer than the one the user originally
256 * intended. Useful when chaining muxers, where one muxer internally
257 * writes a received packet to another muxer.
258 *
259 * @param dst the muxer to write the packet to
260 * @param dst_stream the stream index within dst to write the packet to
261 * @param pkt the packet to be written
262 * @param src the muxer the packet originally was intended for
263 * @param interleave 0->use av_write_frame, 1->av_interleaved_write_frame
264 * @return the value av_write_frame returned
265 */
266int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
267 AVFormatContext *src, int interleave);
268
269/**
270 * Get the length in bytes which is needed to store val as v.
271 */
272int ff_get_v_length(uint64_t val);
273
274/**
275 * Put val using a variable number of bytes.
276 */
277void ff_put_v(AVIOContext *bc, uint64_t val);
278
279/**
280 * Read a whole line of text from AVIOContext. Stop reading after reaching
281 * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
282 * and may be truncated if the buffer is too small.
283 *
284 * @param s the read-only AVIOContext
285 * @param buf buffer to store the read line
286 * @param maxlen size of the buffer
287 * @return the length of the string written in the buffer, not including the
288 * final \\0
289 */
290int ff_get_line(AVIOContext *s, char *buf, int maxlen);
291
292#define SPACE_CHARS " \t\r\n"
293
294/**
295 * Callback function type for ff_parse_key_value.
296 *
297 * @param key a pointer to the key
298 * @param key_len the number of bytes that belong to the key, including the '='
299 * char
300 * @param dest return the destination pointer for the value in *dest, may
301 * be null to ignore the value
302 * @param dest_len the length of the *dest buffer
303 */
304typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
305 int key_len, char **dest, int *dest_len);
306/**
307 * Parse a string with comma-separated key=value pairs. The value strings
308 * may be quoted and may contain escaped characters within quoted strings.
309 *
310 * @param str the string to parse
311 * @param callback_get_buf function that returns where to store the
312 * unescaped value string.
313 * @param context the opaque context pointer to pass to callback_get_buf
314 */
315void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
316 void *context);
317
318/**
319 * Find stream index based on format-specific stream ID
320 * @return stream index, or < 0 on error
321 */
322int ff_find_stream_index(AVFormatContext *s, int id);
323
324/**
325 * Internal version of av_index_search_timestamp
326 */
327int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
328 int64_t wanted_timestamp, int flags);
329
330/**
331 * Internal version of av_add_index_entry
332 */
333int ff_add_index_entry(AVIndexEntry **index_entries,
334 int *nb_index_entries,
335 unsigned int *index_entries_allocated_size,
336 int64_t pos, int64_t timestamp, int size, int distance, int flags);
337
338void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
339
340/**
341 * Add a new chapter.
342 *
343 * @param s media file handle
344 * @param id unique ID for this chapter
345 * @param start chapter start time in time_base units
346 * @param end chapter end time in time_base units
347 * @param title chapter title
348 *
349 * @return AVChapter or NULL on error
350 */
351AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
352 int64_t start, int64_t end, const char *title);
353
354/**
355 * Ensure the index uses less memory than the maximum specified in
356 * AVFormatContext.max_index_size by discarding entries if it grows
357 * too large.
358 */
359void ff_reduce_index(AVFormatContext *s, int stream_index);
360
361enum AVCodecID ff_guess_image2_codec(const char *filename);
362
363/**
364 * Perform a binary search using av_index_search_timestamp() and
365 * AVInputFormat.read_timestamp().
366 *
367 * @param target_ts target timestamp in the time base of the given stream
368 * @param stream_index stream number
369 */
370int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
371 int64_t target_ts, int flags);
372
373/**
374 * Update cur_dts of all streams based on the given timestamp and AVStream.
375 *
376 * Stream ref_st unchanged, others set cur_dts in their native time base.
377 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
378 * @param timestamp new dts expressed in time_base of param ref_st
379 * @param ref_st reference stream giving time_base of param timestamp
380 */
381void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
382
383int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
384 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
385
386/**
387 * Perform a binary search using read_timestamp().
388 *
389 * @param target_ts target timestamp in the time base of the given stream
390 * @param stream_index stream number
391 */
392int64_t ff_gen_search(AVFormatContext *s, int stream_index,
393 int64_t target_ts, int64_t pos_min,
394 int64_t pos_max, int64_t pos_limit,
395 int64_t ts_min, int64_t ts_max,
396 int flags, int64_t *ts_ret,
397 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
398
399/**
400 * Set the time base and wrapping info for a given stream. This will be used
401 * to interpret the stream's timestamps. If the new time base is invalid
402 * (numerator or denominator are non-positive), it leaves the stream
403 * unchanged.
404 *
405 * @param s stream
406 * @param pts_wrap_bits number of bits effectively used by the pts
407 * (used for wrap control)
408 * @param pts_num time base numerator
409 * @param pts_den time base denominator
410 */
411void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
412 unsigned int pts_num, unsigned int pts_den);
413
414/**
415 * Add side data to a packet for changing parameters to the given values.
416 * Parameters set to 0 aren't included in the change.
417 */
418int ff_add_param_change(AVPacket *pkt, int32_t channels,
419 uint64_t channel_layout, int32_t sample_rate,
420 int32_t width, int32_t height);
421
422/**
423 * Set the timebase for each stream from the corresponding codec timebase and
424 * print it.
425 */
426int ff_framehash_write_header(AVFormatContext *s);
427
428/**
429 * Read a transport packet from a media file.
430 *
431 * @param s media file handle
432 * @param pkt is filled
433 * @return 0 if OK, AVERROR_xxx on error
434 */
435int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
436
437/**
438 * Interleave a packet per dts in an output media file.
439 *
440 * Packets with pkt->destruct == av_destruct_packet will be freed inside this
441 * function, so they cannot be used after it. Note that calling av_packet_unref()
442 * on them is still safe.
443 *
444 * @param s media file handle
445 * @param out the interleaved packet will be output here
446 * @param pkt the input packet
447 * @param flush 1 if no further packets are available as input and all
448 * remaining packets should be output
449 * @return 1 if a packet was output, 0 if no packet could be output,
450 * < 0 if an error occurred
451 */
452int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
453 AVPacket *pkt, int flush);
454
455void ff_free_stream(AVFormatContext *s, AVStream *st);
456
457/**
458 * Return the frame duration in seconds. Return 0 if not available.
459 */
460void ff_compute_frame_duration(AVFormatContext *s, int *pnum, int *pden, AVStream *st,
461 AVCodecParserContext *pc, AVPacket *pkt);
462
463unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
464
465enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
466
467/**
468 * Select a PCM codec based on the given parameters.
469 *
470 * @param bps bits-per-sample
471 * @param flt floating-point
472 * @param be big-endian
473 * @param sflags signed flags. each bit corresponds to one byte of bit depth.
474 * e.g. the 1st bit indicates if 8-bit should be signed or
475 * unsigned, the 2nd bit indicates if 16-bit should be signed or
476 * unsigned, etc... This is useful for formats such as WAVE where
477 * only 8-bit is unsigned and all other bit depths are signed.
478 * @return a PCM codec id or AV_CODEC_ID_NONE
479 */
480enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
481
482/**
483 * Chooses a timebase for muxing the specified stream.
484 *
485 * The chosen timebase allows sample accurate timestamps based
486 * on the framerate or sample rate for audio streams. It also is
487 * at least as precise as 1/min_precision would be.
488 */
489AVRational ff_choose_timebase(AVFormatContext *s, AVStream *st, int min_precision);
490
491/**
492 * Chooses a timebase for muxing the specified stream.
493 */
494enum AVChromaLocation ff_choose_chroma_location(AVFormatContext *s, AVStream *st);
495
496/**
497 * Generate standard extradata for AVC-Intra based on width/height and field
498 * order.
499 */
500int ff_generate_avci_extradata(AVStream *st);
501
502/**
503 * Add a bitstream filter to a stream.
504 *
505 * @param st output stream to add a filter to
506 * @param name the name of the filter to add
507 * @param args filter-specific argument string
508 * @return >0 on success;
509 * AVERROR code on failure
510 */
511int ff_stream_add_bitstream_filter(AVStream *st, const char *name, const char *args);
512
513/**
514 * Copy encoding parameters from source to destination stream
515 *
516 * @param dst pointer to destination AVStream
517 * @param src pointer to source AVStream
518 * @return >=0 on success, AVERROR code on error
519 */
520int ff_stream_encode_params_copy(AVStream *dst, const AVStream *src);
521
522/**
523 * Wrap errno on rename() error.
524 *
525 * @param oldpath source path
526 * @param newpath destination path
527 * @return 0 or AVERROR on failure
528 */
529static inline int ff_rename(const char *oldpath, const char *newpath, void *logctx)
530{
531 int ret = 0;
532 if (rename(oldpath, newpath) == -1) {
533 ret = AVERROR(errno);
534 if (logctx)
535 av_log(logctx, AV_LOG_ERROR, "failed to rename file %s to %s\n", oldpath, newpath);
536 }
537 return ret;
538}
539
540/**
541 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
542 * which is always set to 0.
543 *
544 * @param size size of extradata
545 * @return 0 if OK, AVERROR_xxx on error
546 */
547int ff_alloc_extradata(AVCodecParameters *par, int size);
548
549/**
550 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
551 * which is always set to 0 and fill it from pb.
552 *
553 * @param size size of extradata
554 * @return >= 0 if OK, AVERROR_xxx on error
555 */
556int ff_get_extradata(AVFormatContext *s, AVCodecParameters *par, AVIOContext *pb, int size);
557
558/**
559 * add frame for rfps calculation.
560 *
561 * @param dts timestamp of the i-th frame
562 * @return 0 if OK, AVERROR_xxx on error
563 */
564int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
565
566void ff_rfps_calculate(AVFormatContext *ic);
567
568/**
569 * Flags for AVFormatContext.write_uncoded_frame()
570 */
571enum AVWriteUncodedFrameFlags {
572
573 /**
574 * Query whether the feature is possible on this stream.
575 * The frame argument is ignored.
576 */
577 AV_WRITE_UNCODED_FRAME_QUERY = 0x0001,
578
579};
580
581/**
582 * Copies the whilelists from one context to the other
583 */
584int ff_copy_whiteblacklists(AVFormatContext *dst, const AVFormatContext *src);
585
586int ffio_open2_wrapper(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags,
587 const AVIOInterruptCB *int_cb, AVDictionary **options);
588
589/**
590 * Returned by demuxers to indicate that data was consumed but discarded
591 * (ignored streams or junk data). The framework will re-call the demuxer.
592 */
593#define FFERROR_REDO FFERRTAG('R','E','D','O')
594
595/**
596 * Utility function to open IO stream of output format.
597 *
598 * @param s AVFormatContext
599 * @param url URL or file name to open for writing
600 * @options optional options which will be passed to io_open callback
601 * @return >=0 on success, negative AVERROR in case of failure
602 */
603int ff_format_output_open(AVFormatContext *s, const char *url, AVDictionary **options);
604
605/*
606 * A wrapper around AVFormatContext.io_close that should be used
607 * instead of calling the pointer directly.
608 */
609void ff_format_io_close(AVFormatContext *s, AVIOContext **pb);
610
611/**
612 * Parse creation_time in AVFormatContext metadata if exists and warn if the
613 * parsing fails.
614 *
615 * @param s AVFormatContext
616 * @param timestamp parsed timestamp in microseconds, only set on successful parsing
617 * @param return_seconds set this to get the number of seconds in timestamp instead of microseconds
618 * @return 1 if OK, 0 if the metadata was not present, AVERROR(EINVAL) on parse error
619 */
620int ff_parse_creation_time_metadata(AVFormatContext *s, int64_t *timestamp, int return_seconds);
621
622/**
623 * Standardize creation_time metadata in AVFormatContext to an ISO-8601
624 * timestamp string.
625 *
626 * @param s AVFormatContext
627 * @return <0 on error
628 */
629int ff_standardize_creation_time(AVFormatContext *s);
630
631#define CONTAINS_PAL 2
632/**
633 * Reshuffles the lines to use the user specified stride.
634 *
635 * @param ppkt input and output packet
636 * @return negative error code or
637 * 0 if no new packet was allocated
638 * non-zero if a new packet was allocated and ppkt has to be freed
639 * CONTAINS_PAL if in addition to a new packet the old contained a palette
640 */
641int ff_reshuffle_raw_rgb(AVFormatContext *s, AVPacket **ppkt, AVCodecParameters *par, int expected_stride);
642
643/**
644 * Retrieves the palette from a packet, either from side data, or
645 * appended to the video data in the packet itself (raw video only).
646 * It is commonly used after a call to ff_reshuffle_raw_rgb().
647 *
648 * Use 0 for the ret parameter to check for side data only.
649 *
650 * @param pkt pointer to packet before calling ff_reshuffle_raw_rgb()
651 * @param ret return value from ff_reshuffle_raw_rgb(), or 0
652 * @param palette pointer to palette buffer
653 * @return negative error code or
654 * 1 if the packet has a palette, else 0
655 */
656int ff_get_packet_palette(AVFormatContext *s, AVPacket *pkt, int ret, uint32_t *palette);
657
658/**
659 * Finalize buf into extradata and set its size appropriately.
660 */
661int ff_bprint_to_codecpar_extradata(AVCodecParameters *par, struct AVBPrint *buf);
662
663/**
664 * Find the next packet in the interleaving queue for the given stream.
665 * The pkt parameter is filled in with the queued packet, including
666 * references to the data (which the caller is not allowed to keep or
667 * modify).
668 *
669 * @return 0 if a packet was found, a negative value if no packet was found
670 */
671int ff_interleaved_peek(AVFormatContext *s, int stream,
672 AVPacket *pkt, int add_offset);
673
674#endif /* AVFORMAT_INTERNAL_H */
675
generated by cgit at 2024-05-17 05:02:03 (GMT)