internal.h 8.66 KB
Newer Older
1 2 3
/*
 * copyright (c) 2001 Fabrice Bellard
 *
4
 * This file is part of Libav.
5
 *
6
 * Libav is free software; you can redistribute it and/or
7 8 9 10
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
11
 * Libav is distributed in the hope that it will be useful,
12 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with Libav; if not, write to the Free Software
18 19 20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

21 22
#ifndef AVFORMAT_INTERNAL_H
#define AVFORMAT_INTERNAL_H
23

24
#include <stdint.h>
25
#include "avformat.h"
26

27 28
#define MAX_URL_SIZE 4096

29 30 31 32 33 34
#ifdef DEBUG
#    define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
#else
#    define hex_dump_debug(class, buf, size)
#endif

35 36 37 38 39
typedef struct AVCodecTag {
    enum CodecID id;
    unsigned int tag;
} AVCodecTag;

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);

#ifdef __GNUC__
#define dynarray_add(tab, nb_ptr, elem)\
do {\
    __typeof__(tab) _tab = (tab);\
    __typeof__(elem) _elem = (elem);\
    (void)sizeof(**_tab == _elem); /* check that types are compatible */\
    ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
} while(0)
#else
#define dynarray_add(tab, nb_ptr, elem)\
do {\
    ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
} while(0)
#endif

struct tm *brktimegm(time_t secs, struct tm *tm);

59
char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
60

61 62 63 64 65 66 67 68 69 70
/**
 * Parse a string of hexadecimal strings. Any space between the hexadecimal
 * digits is ignored.
 *
 * @param data if non-null, the parsed data is written to this pointer
 * @param p the string to parse
 * @return the number of bytes written (or to be written, if data is null)
 */
int ff_hex_to_data(uint8_t *data, const char *p);

71
void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
72

73 74 75 76 77 78 79
/**
 * Add packet to AVFormatContext->packet_buffer list, determining its
 * interleaved position using compare() function argument.
 */
void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
                              int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));

80
void ff_read_frame_flush(AVFormatContext *s);
81

82 83 84
#define NTP_OFFSET 2208988800ULL
#define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)

85
/** Get the current time since NTP epoch in microseconds. */
86 87
uint64_t ff_ntp_time(void);

88
/**
89
 * Assemble a URL string from components. This is the reverse operation
Måns Rullgård's avatar
Måns Rullgård committed
90
 * of av_url_split.
91 92 93 94
 *
 * Note, this requires networking to be initialized, so the caller must
 * ensure ff_network_init has been called.
 *
Måns Rullgård's avatar
Måns Rullgård committed
95
 * @see av_url_split
96 97 98 99 100
 *
 * @param str the buffer to fill with the url
 * @param size the size of the str buffer
 * @param proto the protocol identifier, if null, the separator
 *              after the identifier is left out, too
101 102
 * @param authorization an optional authorization string, may be null.
 *                      An empty string is treated the same as a null string.
103 104 105 106 107 108 109 110
 * @param hostname the host name string
 * @param port the port number, left out from the string if negative
 * @param fmt a generic format string for everything to add after the
 *            host/port, may be null
 * @return the number of characters written to the destination buffer
 */
int ff_url_join(char *str, int size, const char *proto,
                const char *authorization, const char *hostname,
111
                int port, const char *fmt, ...) av_printf_format(7, 8);
112

113
/**
114
 * Append the media-specific SDP fragment for the media stream c
115 116 117 118 119 120 121 122 123
 * to the buffer buff.
 *
 * Note, the buffer needs to be initialized, since it is appended to
 * existing content.
 *
 * @param buff the buffer to append the SDP fragment to
 * @param size the size of the buff buffer
 * @param c the AVCodecContext of the media to describe
 * @param dest_addr the destination address of the media stream, may be NULL
124
 * @param dest_type the destination address type, may be NULL
125 126
 * @param port the destination port of the media stream, 0 if unknown
 * @param ttl the time to live of the stream, 0 if not multicast
127 128
 * @param fmt the AVFormatContext, which might contain options modifying
 *            the generated SDP
129 130
 */
void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
131
                        const char *dest_addr, const char *dest_type,
132
                        int port, int ttl, AVFormatContext *fmt);
133

134 135 136 137 138 139 140 141 142 143 144 145 146 147
/**
 * Write a packet to another muxer than the one the user originally
 * intended. Useful when chaining muxers, where one muxer internally
 * writes a received packet to another muxer.
 *
 * @param dst the muxer to write the packet to
 * @param dst_stream the stream index within dst to write the packet to
 * @param pkt the packet to be written
 * @param src the muxer the packet originally was intended for
 * @return the value av_write_frame returned
 */
int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
                     AVFormatContext *src);

148 149 150 151 152 153 154 155
/**
 * Get the length in bytes which is needed to store val as v.
 */
int ff_get_v_length(uint64_t val);

/**
 * Put val using a variable number of bytes.
 */
156
void ff_put_v(AVIOContext *bc, uint64_t val);
157

Aurelien Jacobs's avatar
Aurelien Jacobs committed
158
/**
159
 * Read a whole line of text from AVIOContext. Stop reading after reaching
Aurelien Jacobs's avatar
Aurelien Jacobs committed
160 161 162
 * either a \n, a \0 or EOF. The returned string is always \0 terminated,
 * and may be truncated if the buffer is too small.
 *
163
 * @param s the read-only AVIOContext
Aurelien Jacobs's avatar
Aurelien Jacobs committed
164 165 166 167 168
 * @param buf buffer to store the read line
 * @param maxlen size of the buffer
 * @return the length of the string written in the buffer, not including the
 *         final \0
 */
169
int ff_get_line(AVIOContext *s, char *buf, int maxlen);
170

171 172
#define SPACE_CHARS " \t\r\n"

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
/**
 * Callback function type for ff_parse_key_value.
 *
 * @param key a pointer to the key
 * @param key_len the number of bytes that belong to the key, including the '='
 *                char
 * @param dest return the destination pointer for the value in *dest, may
 *             be null to ignore the value
 * @param dest_len the length of the *dest buffer
 */
typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
                                    int key_len, char **dest, int *dest_len);
/**
 * Parse a string with comma-separated key=value pairs. The value strings
 * may be quoted and may contain escaped characters within quoted strings.
 *
 * @param str the string to parse
 * @param callback_get_buf function that returns where to store the
 *                         unescaped value string.
 * @param context the opaque context pointer to pass to callback_get_buf
 */
void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
                        void *context);

Peter Ross's avatar
Peter Ross committed
197 198 199 200 201 202
/**
 * Find stream index based on format-specific stream ID
 * @return stream index, or < 0 on error
 */
int ff_find_stream_index(AVFormatContext *s, int id);

203 204 205 206 207 208 209 210 211 212 213 214 215 216
/**
 * Internal version of av_index_search_timestamp
 */
int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
                              int64_t wanted_timestamp, int flags);

/**
 * Internal version of av_add_index_entry
 */
int ff_add_index_entry(AVIndexEntry **index_entries,
                       int *nb_index_entries,
                       unsigned int *index_entries_allocated_size,
                       int64_t pos, int64_t timestamp, int size, int distance, int flags);

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
/**
 * Add a new chapter.
 *
 * @param s media file handle
 * @param id unique ID for this chapter
 * @param start chapter start time in time_base units
 * @param end chapter end time in time_base units
 * @param title chapter title
 *
 * @return AVChapter or NULL on error
 */
AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
                          int64_t start, int64_t end, const char *title);

/**
 * Ensure the index uses less memory than the maximum specified in
 * AVFormatContext.max_index_size by discarding entries if it grows
 * too large.
 */
void ff_reduce_index(AVFormatContext *s, int stream_index);

238 239 240 241 242 243 244 245 246 247 248
/*
 * Convert a relative url into an absolute url, given a base url.
 *
 * @param buf the buffer where output absolute url is written
 * @param size the size of buf
 * @param base the base url, may be equal to buf.
 * @param rel the new url, which is interpreted relative to base
 */
void ff_make_absolute_url(char *buf, int size, const char *base,
                          const char *rel);

249 250
enum CodecID ff_guess_image2_codec(const char *filename);

251
#endif /* AVFORMAT_INTERNAL_H */