]> git.sesse.net Git - ffmpeg/blob - libavformat/internal.h
Display a more descriptive log message when probe buffer limit is
[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
27 typedef struct AVCodecTag {
28     enum CodecID id;
29     unsigned int tag;
30 } AVCodecTag;
31
32 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
33
34 #ifdef __GNUC__
35 #define dynarray_add(tab, nb_ptr, elem)\
36 do {\
37     __typeof__(tab) _tab = (tab);\
38     __typeof__(elem) _elem = (elem);\
39     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
40     ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
41 } while(0)
42 #else
43 #define dynarray_add(tab, nb_ptr, elem)\
44 do {\
45     ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
46 } while(0)
47 #endif
48
49 time_t mktimegm(struct tm *tm);
50 struct tm *brktimegm(time_t secs, struct tm *tm);
51 const char *small_strptime(const char *p, const char *fmt,
52                            struct tm *dt);
53
54 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
55
56 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
57
58 /**
59  * Add packet to AVFormatContext->packet_buffer list, determining its
60  * interleaved position using compare() function argument.
61  */
62 void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
63                               int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
64
65 void ff_read_frame_flush(AVFormatContext *s);
66
67 #define NTP_OFFSET 2208988800ULL
68 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
69
70 /** Gets the current time since NTP epoch in microseconds. */
71 uint64_t ff_ntp_time(void);
72
73 /**
74  * Probes a bytestream to determine the input format. Each time a probe returns
75  * with a score that is too low, the probe buffer size is increased and another
76  * attempt is made. When the maximum probe size is reached, the input format
77  * with the highest score is returned.
78  *
79  * @param pb the bytestream to probe, it may be closed and opened again
80  * @param fmt the input format is put here
81  * @param filename the filename of the stream
82  * @param logctx the log context
83  * @param offset the offset within the bytestream to probe from
84  * @param max_probe_size the maximum probe buffer size (zero for default)
85  * @return 0 in case of success, a negative value corresponding to an
86  * AVERROR code otherwise
87  */
88 int ff_probe_input_buffer(ByteIOContext **pb, AVInputFormat **fmt,
89                           const char *filename, void *logctx,
90                           unsigned int offset, unsigned int max_probe_size);
91
92 /**
93  * Splits a URL string into components. To reassemble components back into
94  * a URL, use ff_url_join instead of using snprintf directly.
95  *
96  * The pointers to buffers for storing individual components may be null,
97  * in order to ignore that component. Buffers for components not found are
98  * set to empty strings. If the port isn't found, it is set to a negative
99  * value.
100  *
101  * @see ff_url_join
102  *
103  * @param proto the buffer for the protocol
104  * @param proto_size the size of the proto buffer
105  * @param authorization the buffer for the authorization
106  * @param authorization_size the size of the authorization buffer
107  * @param hostname the buffer for the host name
108  * @param hostname_size the size of the hostname buffer
109  * @param port_ptr a pointer to store the port number in
110  * @param path the buffer for the path
111  * @param path_size the size of the path buffer
112  * @param url the URL to split
113  */
114 void ff_url_split(char *proto, int proto_size,
115                   char *authorization, int authorization_size,
116                   char *hostname, int hostname_size,
117                   int *port_ptr,
118                   char *path, int path_size,
119                   const char *url);
120
121 /**
122  * Assembles a URL string from components. This is the reverse operation
123  * of ff_url_split.
124  *
125  * Note, this requires networking to be initialized, so the caller must
126  * ensure ff_network_init has been called.
127  *
128  * @see ff_url_split
129  *
130  * @param str the buffer to fill with the url
131  * @param size the size of the str buffer
132  * @param proto the protocol identifier, if null, the separator
133  *              after the identifier is left out, too
134  * @param authorization an optional authorization string, may be null
135  * @param hostname the host name string
136  * @param port the port number, left out from the string if negative
137  * @param fmt a generic format string for everything to add after the
138  *            host/port, may be null
139  * @return the number of characters written to the destination buffer
140  */
141 int ff_url_join(char *str, int size, const char *proto,
142                 const char *authorization, const char *hostname,
143                 int port, const char *fmt, ...);
144
145 /**
146  * Appends the media-specific SDP fragment for the media stream c
147  * to the buffer buff.
148  *
149  * Note, the buffer needs to be initialized, since it is appended to
150  * existing content.
151  *
152  * @param buff the buffer to append the SDP fragment to
153  * @param size the size of the buff buffer
154  * @param c the AVCodecContext of the media to describe
155  * @param dest_addr the destination address of the media stream, may be NULL
156  * @param port the destination port of the media stream, 0 if unknown
157  * @param ttl the time to live of the stream, 0 if not multicast
158  */
159 void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
160                         const char *dest_addr, int port, int ttl);
161
162 /**
163  * Write a packet to another muxer than the one the user originally
164  * intended. Useful when chaining muxers, where one muxer internally
165  * writes a received packet to another muxer.
166  *
167  * @param dst the muxer to write the packet to
168  * @param dst_stream the stream index within dst to write the packet to
169  * @param pkt the packet to be written
170  * @param src the muxer the packet originally was intended for
171  * @return the value av_write_frame returned
172  */
173 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
174                      AVFormatContext *src);
175
176 #endif /* AVFORMAT_INTERNAL_H */