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 #define MAX_URL_SIZE 4096
  28
  29 #ifdef DEBUG
  30 #    define hex_dump_debug(class, buf, size) av_hex_dump_log(class, AV_LOG_DEBUG, buf, size)
  31 #else
  32 #    define hex_dump_debug(class, buf, size)
  33 #endif
  34
  35 typedef struct AVCodecTag {
  36     enum CodecID id;
  37     unsigned int tag;
  38 } AVCodecTag;
  39
  40 #ifdef __GNUC__
  41 #define dynarray_add(tab, nb_ptr, elem)\
  42 do {\
  43     __typeof__(tab) _tab = (tab);\
  44     __typeof__(elem) _elem = (elem);\
  45     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
  46     av_dynarray_add(_tab, nb_ptr, _elem);\
  47 } while(0)
  48 #else
  49 #define dynarray_add(tab, nb_ptr, elem)\
  50 do {\
  51     av_dynarray_add((tab), nb_ptr, (elem));\
  52 } while(0)
  53 #endif
  54
  55 struct tm *brktimegm(time_t secs, struct tm *tm);
  56
  57 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
  58
  59 /**
  60  * Parse a string of hexadecimal strings. Any space between the hexadecimal
  61  * digits is ignored.
  62  *
  63  * @param data if non-null, the parsed data is written to this pointer
  64  * @param p the string to parse
  65  * @return the number of bytes written (or to be written, if data is null)
  66  */
  67 int ff_hex_to_data(uint8_t *data, const char *p);
  68
  69 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
  70
  71 /**
  72  * Add packet to AVFormatContext->packet_buffer list, determining its
  73  * interleaved position using compare() function argument.
  74  */
  75 void ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
  76                               int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
  77
  78 void ff_read_frame_flush(AVFormatContext *s);
  79
  80 #define NTP_OFFSET 2208988800ULL
  81 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
  82
  83 /** Get the current time since NTP epoch in microseconds. */
  84 uint64_t ff_ntp_time(void);
  85
  86 /**
  87  * Assemble a URL string from components. This is the reverse operation
  88  * of av_url_split.
  89  *
  90  * Note, this requires networking to be initialized, so the caller must
  91  * ensure ff_network_init has been called.
  92  *
  93  * @see av_url_split
  94  *
  95  * @param str the buffer to fill with the url
  96  * @param size the size of the str buffer
  97  * @param proto the protocol identifier, if null, the separator
  98  *              after the identifier is left out, too
  99  * @param authorization an optional authorization string, may be null.
 100  *                      An empty string is treated the same as a null string.
 101  * @param hostname the host name string
 102  * @param port the port number, left out from the string if negative
 103  * @param fmt a generic format string for everything to add after the
 104  *            host/port, may be null
 105  * @return the number of characters written to the destination buffer
 106  */
 107 int ff_url_join(char *str, int size, const char *proto,
 108                 const char *authorization, const char *hostname,
 109                 int port, const char *fmt, ...);
 110
 111 /**
 112  * Append the media-specific SDP fragment for the media stream c
 113  * to the buffer buff.
 114  *
 115  * Note, the buffer needs to be initialized, since it is appended to
 116  * existing content.
 117  *
 118  * @param buff the buffer to append the SDP fragment to
 119  * @param size the size of the buff buffer
 120  * @param c the AVCodecContext of the media to describe
 121  * @param dest_addr the destination address of the media stream, may be NULL
 122  * @param dest_type the destination address type, may be NULL
 123  * @param port the destination port of the media stream, 0 if unknown
 124  * @param ttl the time to live of the stream, 0 if not multicast
 125  * @param fmt the AVFormatContext, which might contain options modifying
 126  *            the generated SDP
 127  */
 128 void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
 129                         const char *dest_addr, const char *dest_type,
 130                         int port, int ttl, AVFormatContext *fmt);
 131
 132 /**
 133  * Write a packet to another muxer than the one the user originally
 134  * intended. Useful when chaining muxers, where one muxer internally
 135  * writes a received packet to another muxer.
 136  *
 137  * @param dst the muxer to write the packet to
 138  * @param dst_stream the stream index within dst to write the packet to
 139  * @param pkt the packet to be written
 140  * @param src the muxer the packet originally was intended for
 141  * @return the value av_write_frame returned
 142  */
 143 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
 144                      AVFormatContext *src);
 145
 146 /**
 147  * Get the length in bytes which is needed to store val as v.
 148  */
 149 int ff_get_v_length(uint64_t val);
 150
 151 /**
 152  * Put val using a variable number of bytes.
 153  */
 154 void ff_put_v(AVIOContext *bc, uint64_t val);
 155
 156 /**
 157  * Read a whole line of text from AVIOContext. Stop reading after reaching
 158  * either a \n, a \0 or EOF. The returned string is always \0 terminated,
 159  * and may be truncated if the buffer is too small.
 160  *
 161  * @param s the read-only AVIOContext
 162  * @param buf buffer to store the read line
 163  * @param maxlen size of the buffer
 164  * @return the length of the string written in the buffer, not including the
 165  *         final \0
 166  */
 167 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
 168
 169 #define SPACE_CHARS " \t\r\n"
 170
 171 /**
 172  * Callback function type for ff_parse_key_value.
 173  *
 174  * @param key a pointer to the key
 175  * @param key_len the number of bytes that belong to the key, including the '='
 176  *                char
 177  * @param dest return the destination pointer for the value in *dest, may
 178  *             be null to ignore the value
 179  * @param dest_len the length of the *dest buffer
 180  */
 181 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
 182                                     int key_len, char **dest, int *dest_len);
 183 /**
 184  * Parse a string with comma-separated key=value pairs. The value strings
 185  * may be quoted and may contain escaped characters within quoted strings.
 186  *
 187  * @param str the string to parse
 188  * @param callback_get_buf function that returns where to store the
 189  *                         unescaped value string.
 190  * @param context the opaque context pointer to pass to callback_get_buf
 191  */
 192 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
 193                         void *context);
 194
 195 /**
 196  * Find stream index based on format-specific stream ID
 197  * @return stream index, or < 0 on error
 198  */
 199 int ff_find_stream_index(AVFormatContext *s, int id);
 200
 201 /**
 202  * Internal version of av_index_search_timestamp
 203  */
 204 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
 205                               int64_t wanted_timestamp, int flags);
 206
 207 /**
 208  * Internal version of av_add_index_entry
 209  */
 210 int ff_add_index_entry(AVIndexEntry **index_entries,
 211                        int *nb_index_entries,
 212                        unsigned int *index_entries_allocated_size,
 213                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
 214
 215 /**
 216  * Add a new chapter.
 217  *
 218  * @param s media file handle
 219  * @param id unique ID for this chapter
 220  * @param start chapter start time in time_base units
 221  * @param end chapter end time in time_base units
 222  * @param title chapter title
 223  *
 224  * @return AVChapter or NULL on error
 225  */
 226 AVChapter *ff_new_chapter(AVFormatContext *s, int id, AVRational time_base,
 227                           int64_t start, int64_t end, const char *title);
 228
 229 /**
 230  * Ensure the index uses less memory than the maximum specified in
 231  * AVFormatContext.max_index_size by discarding entries if it grows
 232  * too large.
 233  */
 234 void ff_reduce_index(AVFormatContext *s, int stream_index);
 235
 236 /*
 237  * Convert a relative url into an absolute url, given a base url.
 238  *
 239  * @param buf the buffer where output absolute url is written
 240  * @param size the size of buf
 241  * @param base the base url, may be equal to buf.
 242  * @param rel the new url, which is interpreted relative to base
 243  */
 244 void ff_make_absolute_url(char *buf, int size, const char *base,
 245                           const char *rel);
 246
 247 enum CodecID ff_guess_image2_codec(const char *filename);
 248
 249 #endif /* AVFORMAT_INTERNAL_H */