libavformat/internal.h
f1c80e35
 /*
  * copyright (c) 2001 Fabrice Bellard
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * 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.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * 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
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
98790382
 #ifndef AVFORMAT_INTERNAL_H
 #define AVFORMAT_INTERNAL_H
f1c80e35
 
95137bbb
 #include <stdint.h>
bad40637
 #include "avformat.h"
95137bbb
 
e55ebcc3
 #define MAX_URL_SIZE 4096
 
43b6c3eb
 #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
 
80b39e1c
 typedef struct AVCodecTag {
     enum CodecID id;
     unsigned int tag;
 } AVCodecTag;
 
9a2cb05f
 #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 */\
35ceaa73
     av_dynarray_add(_tab, nb_ptr, _elem);\
9a2cb05f
 } while(0)
 #else
 #define dynarray_add(tab, nb_ptr, elem)\
 do {\
35ceaa73
     av_dynarray_add((tab), nb_ptr, (elem));\
9a2cb05f
 } while(0)
 #endif
 
 struct tm *brktimegm(time_t secs, struct tm *tm);
 
ddbeb954
 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
f1c80e35
 
311baee7
 /**
  * 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);
 
588af13f
 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
bad40637
 
1cc65cec
 /**
  * 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 *));
 
972ffe62
 void ff_read_frame_flush(AVFormatContext *s);
e16c73e6
 
2dad0dce
 #define NTP_OFFSET 2208988800ULL
 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
 
49bd8e4b
 /** Get the current time since NTP epoch in microseconds. */
594a9aeb
 uint64_t ff_ntp_time(void);
 
88e44314
 #if FF_API_URL_SPLIT
e4a9e3cc
 /**
f3bfe388
  * @deprecated use av_url_split() instead
e4a9e3cc
  */
 void ff_url_split(char *proto, int proto_size,
                   char *authorization, int authorization_size,
                   char *hostname, int hostname_size,
                   int *port_ptr,
                   char *path, int path_size,
                   const char *url);
f3bfe388
 #endif
e4a9e3cc
 
 /**
49bd8e4b
  * Assemble a URL string from components. This is the reverse operation
f3bfe388
  * of av_url_split.
e4a9e3cc
  *
  * Note, this requires networking to be initialized, so the caller must
  * ensure ff_network_init has been called.
  *
f3bfe388
  * @see av_url_split
e4a9e3cc
  *
  * @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
a955fc5e
  * @param authorization an optional authorization string, may be null.
  *                      An empty string is treated the same as a null string.
e4a9e3cc
  * @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,
                 int port, const char *fmt, ...);
 
0341b699
 /**
49bd8e4b
  * Append the media-specific SDP fragment for the media stream c
0341b699
  * 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
7ad1dc54
  * @param dest_type the destination address type, may be NULL
0341b699
  * @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
0558e266
  * @param fmt the AVFormatContext, which might contain options modifying
  *            the generated SDP
0341b699
  */
 void ff_sdp_write_media(char *buff, int size, AVCodecContext *c,
7ad1dc54
                         const char *dest_addr, const char *dest_type,
0558e266
                         int port, int ttl, AVFormatContext *fmt);
0341b699
 
9a761250
 /**
  * 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);
 
603e5c0b
 /**
  * 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.
  */
ae628ec1
 void ff_put_v(AVIOContext *bc, uint64_t val);
603e5c0b
 
b0335fd9
 /**
ae628ec1
  * Read a whole line of text from AVIOContext. Stop reading after reaching
43de5c03
  * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
b0335fd9
  * and may be truncated if the buffer is too small.
  *
ae628ec1
  * @param s the read-only AVIOContext
b0335fd9
  * @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
43de5c03
  *         final \\0
b0335fd9
  */
ae628ec1
 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
7c892951
 
1537817e
 #define SPACE_CHARS " \t\r\n"
 
f9c399c4
 /**
  * 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);
 
141de5a9
 /**
  * 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);
 
e6fb5a4f
 /**
  * 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);
 
19711af5
 /**
  * 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);
 
f1f60f52
 /*
  * 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);
 
a9bf9d8e
 enum CodecID ff_guess_image2_codec(const char *filename);
 
98790382
 #endif /* AVFORMAT_INTERNAL_H */