Make hex_to_data a lavf internal function
[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 #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 /**
57  * Parse a string of hexadecimal strings. Any space between the hexadecimal
58  * digits is ignored.
59  *
60  * @param data if non-null, the parsed data is written to this pointer
61  * @param p the string to parse
62  * @return the number of bytes written (or to be written, if data is null)
63  */
64 int ff_hex_to_data(uint8_t *data, const char *p);
65
66 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
67
68 /**
69  * Add packet to AVFormatContext->packet_buffer list, determining its
70  * interleaved position using compare() function argument.
71  */
72 void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
73                               int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
74
75 void ff_read_frame_flush(AVFormatContext *s);
76
77 #define NTP_OFFSET 2208988800ULL
78 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
79
80 /** Get the current time since NTP epoch in microseconds. */
81 uint64_t ff_ntp_time(void);
82
83 /**
84  * Probe a bytestream to determine the input format. Each time a probe returns
85  * with a score that is too low, the probe buffer size is increased and another
86  * attempt is made. When the maximum probe size is reached, the input format
87  * with the highest score is returned.
88  *
89  * @param pb the bytestream to probe, it may be closed and opened again
90  * @param fmt the input format is put here
91  * @param filename the filename of the stream
92  * @param logctx the log context
93  * @param offset the offset within the bytestream to probe from
94  * @param max_probe_size the maximum probe buffer size (zero for default)
95  * @return 0 in case of success, a negative value corresponding to an
96  * AVERROR code otherwise
97  */
98 int ff_probe_input_buffer(ByteIOContext **pb, AVInputFormat **fmt,
99                           const char *filename, void *logctx,
100                           unsigned int offset, unsigned int max_probe_size);
101
102 #if LIBAVFORMAT_VERSION_MAJOR < 53
103 /**
104  * @deprecated use av_url_split() instead
105  */
106 void ff_url_split(char *proto, int proto_size,
107                   char *authorization, int authorization_size,
108                   char *hostname, int hostname_size,
109                   int *port_ptr,
110                   char *path, int path_size,
111                   const char *url);
112 #endif
113
114 /**
115  * Assemble a URL string from components. This is the reverse operation
116  * of av_url_split.
117  *
118  * Note, this requires networking to be initialized, so the caller must
119  * ensure ff_network_init has been called.
120  *
121  * @see av_url_split
122  *
123  * @param str the buffer to fill with the url
124  * @param size the size of the str buffer
125  * @param proto the protocol identifier, if null, the separator
126  *              after the identifier is left out, too
127  * @param authorization an optional authorization string, may be null.
128  *                      An empty string is treated the same as a null string.
129  * @param hostname the host name string
130  * @param port the port number, left out from the string if negative
131  * @param fmt a generic format string for everything to add after the
132  *            host/port, may be null
133  * @return the number of characters written to the destination buffer
134  */
135 int ff_url_join(char *str, int size, const char *proto,
136                 const char *authorization, const char *hostname,
137                 int port, const char *fmt, ...);
138
139 /**
140  * Append the media-specific SDP fragment for the media stream c
141  * to the buffer buff.
142  *
143  * Note, the buffer needs to be initialized, since it is appended to
144  * existing content.
145  *
146  * @param buff the buffer to append the SDP fragment to
147  * @param size the size of the buff buffer
148  * @param c the AVCodecContext of the media to describe
149  * @param dest_addr the destination address of the media stream, may be NULL
150  * @param port the destination port of the media stream, 0 if unknown
151  * @param ttl the time to live of the stream, 0 if not multicast
152  */
153 void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
154                         const char *dest_addr, int port, int ttl);
155
156 /**
157  * Write a packet to another muxer than the one the user originally
158  * intended. Useful when chaining muxers, where one muxer internally
159  * writes a received packet to another muxer.
160  *
161  * @param dst the muxer to write the packet to
162  * @param dst_stream the stream index within dst to write the packet to
163  * @param pkt the packet to be written
164  * @param src the muxer the packet originally was intended for
165  * @return the value av_write_frame returned
166  */
167 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
168                      AVFormatContext *src);
169
170 /**
171  * Get the length in bytes which is needed to store val as v.
172  */
173 int ff_get_v_length(uint64_t val);
174
175 /**
176  * Put val using a variable number of bytes.
177  */
178 void ff_put_v(ByteIOContext *bc, uint64_t val);
179
180 /**
181  * Read a whole line of text from ByteIOContext. Stop reading after reaching
182  * either a \n, a \0 or EOF. The returned string is always \0 terminated,
183  * and may be truncated if the buffer is too small.
184  *
185  * @param s the read-only ByteIOContext
186  * @param buf buffer to store the read line
187  * @param maxlen size of the buffer
188  * @return the length of the string written in the buffer, not including the
189  *         final \0
190  */
191 int ff_get_line(ByteIOContext *s, char *buf, int maxlen);
192
193 #define SPACE_CHARS " \t\r\n"
194
195 #endif /* AVFORMAT_INTERNAL_H */