libavformat/internal.h

   1 /*
   2  * copyright (c) 2001 Fabrice Bellard
   3  *
   4  * This file is part of Libav.
   5  *
   6  * Libav 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  * Libav 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 Libav; 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 AVCodecID id;
  37     unsigned int tag;
  38 } AVCodecTag;
  39
  40 typedef struct CodecMime{
  41     char str[32];
  42     enum AVCodecID id;
  43 } CodecMime;
  44
  45 struct AVFormatInternal {
  46     /**
  47      * Number of streams relevant for interleaving.
  48      * Muxing only.
  49      */
  50     int nb_interleaved_streams;
  51 };
  52
  53 void ff_dynarray_add(intptr_t **tab_ptr, int *nb_ptr, intptr_t elem);
  54
  55 #ifdef __GNUC__
  56 #define dynarray_add(tab, nb_ptr, elem)\
  57 do {\
  58     __typeof__(tab) _tab = (tab);\
  59     __typeof__(elem) _elem = (elem);\
  60     (void)sizeof(**_tab == _elem); /* check that types are compatible */\
  61     ff_dynarray_add((intptr_t **)_tab, nb_ptr, (intptr_t)_elem);\
  62 } while(0)
  63 #else
  64 #define dynarray_add(tab, nb_ptr, elem)\
  65 do {\
  66     ff_dynarray_add((intptr_t **)(tab), nb_ptr, (intptr_t)(elem));\
  67 } while(0)
  68 #endif
  69
  70 struct tm *ff_brktimegm(time_t secs, struct tm *tm);
  71
  72 char *ff_data_to_hex(char *buf, const uint8_t *src, int size, int lowercase);
  73
  74 /**
  75  * Parse a string of hexadecimal strings. Any space between the hexadecimal
  76  * digits is ignored.
  77  *
  78  * @param data if non-null, the parsed data is written to this pointer
  79  * @param p the string to parse
  80  * @return the number of bytes written (or to be written, if data is null)
  81  */
  82 int ff_hex_to_data(uint8_t *data, const char *p);
  83
  84 void ff_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx);
  85
  86 /**
  87  * Add packet to AVFormatContext->packet_buffer list, determining its
  88  * interleaved position using compare() function argument.
  89  */
  90 int ff_interleave_add_packet(AVFormatContext *s, AVPacket *pkt,
  91                              int (*compare)(AVFormatContext *, AVPacket *, AVPacket *));
  92
  93 void ff_read_frame_flush(AVFormatContext *s);
  94
  95 #define NTP_OFFSET 2208988800ULL
  96 #define NTP_OFFSET_US (NTP_OFFSET * 1000000ULL)
  97
  98 /** Get the current time since NTP epoch in microseconds. */
  99 uint64_t ff_ntp_time(void);
 100
 101 /**
 102  * Append the media-specific SDP fragment for the media stream c
 103  * to the buffer buff.
 104  *
 105  * Note, the buffer needs to be initialized, since it is appended to
 106  * existing content.
 107  *
 108  * @param buff the buffer to append the SDP fragment to
 109  * @param size the size of the buff buffer
 110  * @param st the AVStream of the media to describe
 111  * @param idx the global stream index
 112  * @param dest_addr the destination address of the media stream, may be NULL
 113  * @param dest_type the destination address type, may be NULL
 114  * @param port the destination port of the media stream, 0 if unknown
 115  * @param ttl the time to live of the stream, 0 if not multicast
 116  * @param fmt the AVFormatContext, which might contain options modifying
 117  *            the generated SDP
 118  */
 119 void ff_sdp_write_media(char *buff, int size, AVStream *st, int idx,
 120                         const char *dest_addr, const char *dest_type,
 121                         int port, int ttl, AVFormatContext *fmt);
 122
 123 /**
 124  * Write a packet to another muxer than the one the user originally
 125  * intended. Useful when chaining muxers, where one muxer internally
 126  * writes a received packet to another muxer.
 127  *
 128  * @param dst the muxer to write the packet to
 129  * @param dst_stream the stream index within dst to write the packet to
 130  * @param pkt the packet to be written
 131  * @param src the muxer the packet originally was intended for
 132  * @return the value av_write_frame returned
 133  */
 134 int ff_write_chained(AVFormatContext *dst, int dst_stream, AVPacket *pkt,
 135                      AVFormatContext *src);
 136
 137 /**
 138  * Get the length in bytes which is needed to store val as v.
 139  */
 140 int ff_get_v_length(uint64_t val);
 141
 142 /**
 143  * Put val using a variable number of bytes.
 144  */
 145 void ff_put_v(AVIOContext *bc, uint64_t val);
 146
 147 /**
 148  * Read a whole line of text from AVIOContext. Stop reading after reaching
 149  * either a \\n, a \\0 or EOF. The returned string is always \\0-terminated,
 150  * and may be truncated if the buffer is too small.
 151  *
 152  * @param s the read-only AVIOContext
 153  * @param buf buffer to store the read line
 154  * @param maxlen size of the buffer
 155  * @return the length of the string written in the buffer, not including the
 156  *         final \\0
 157  */
 158 int ff_get_line(AVIOContext *s, char *buf, int maxlen);
 159
 160 #define SPACE_CHARS " \t\r\n"
 161
 162 /**
 163  * Callback function type for ff_parse_key_value.
 164  *
 165  * @param key a pointer to the key
 166  * @param key_len the number of bytes that belong to the key, including the '='
 167  *                char
 168  * @param dest return the destination pointer for the value in *dest, may
 169  *             be null to ignore the value
 170  * @param dest_len the length of the *dest buffer
 171  */
 172 typedef void (*ff_parse_key_val_cb)(void *context, const char *key,
 173                                     int key_len, char **dest, int *dest_len);
 174 /**
 175  * Parse a string with comma-separated key=value pairs. The value strings
 176  * may be quoted and may contain escaped characters within quoted strings.
 177  *
 178  * @param str the string to parse
 179  * @param callback_get_buf function that returns where to store the
 180  *                         unescaped value string.
 181  * @param context the opaque context pointer to pass to callback_get_buf
 182  */
 183 void ff_parse_key_value(const char *str, ff_parse_key_val_cb callback_get_buf,
 184                         void *context);
 185
 186 /**
 187  * Find stream index based on format-specific stream ID
 188  * @return stream index, or < 0 on error
 189  */
 190 int ff_find_stream_index(AVFormatContext *s, int id);
 191
 192 /**
 193  * Internal version of av_index_search_timestamp
 194  */
 195 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
 196                               int64_t wanted_timestamp, int flags);
 197
 198 /**
 199  * Internal version of av_add_index_entry
 200  */
 201 int ff_add_index_entry(AVIndexEntry **index_entries,
 202                        int *nb_index_entries,
 203                        unsigned int *index_entries_allocated_size,
 204                        int64_t pos, int64_t timestamp, int size, int distance, int flags);
 205
 206 /**
 207  * Add a new chapter.
 208  *
 209  * @param s media file handle
 210  * @param id unique ID for this chapter
 211  * @param start chapter start time in time_base units
 212  * @param end chapter end time in time_base units
 213  * @param title chapter title
 214  *
 215  * @return AVChapter or NULL on error
 216  */
 217 AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
 218                               int64_t start, int64_t end, const char *title);
 219
 220 /**
 221  * Ensure the index uses less memory than the maximum specified in
 222  * AVFormatContext.max_index_size by discarding entries if it grows
 223  * too large.
 224  */
 225 void ff_reduce_index(AVFormatContext *s, int stream_index);
 226
 227 enum AVCodecID ff_guess_image2_codec(const char *filename);
 228
 229 /**
 230  * Convert a date string in ISO8601 format to Unix timestamp.
 231  */
 232 int64_t ff_iso8601_to_unix_time(const char *datestr);
 233
 234 /**
 235  * Perform a binary search using av_index_search_timestamp() and
 236  * AVInputFormat.read_timestamp().
 237  *
 238  * @param target_ts target timestamp in the time base of the given stream
 239  * @param stream_index stream number
 240  */
 241 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
 242                          int64_t target_ts, int flags);
 243
 244 /**
 245  * Update cur_dts of all streams based on the given timestamp and AVStream.
 246  *
 247  * Stream ref_st unchanged, others set cur_dts in their native time base.
 248  * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
 249  * @param timestamp new dts expressed in time_base of param ref_st
 250  * @param ref_st reference stream giving time_base of param timestamp
 251  */
 252 void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
 253
 254 /**
 255  * Perform a binary search using read_timestamp().
 256  *
 257  * @param target_ts target timestamp in the time base of the given stream
 258  * @param stream_index stream number
 259  */
 260 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
 261                       int64_t target_ts, int64_t pos_min,
 262                       int64_t pos_max, int64_t pos_limit,
 263                       int64_t ts_min, int64_t ts_max,
 264                       int flags, int64_t *ts_ret,
 265                       int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
 266
 267 /**
 268  * Set the time base and wrapping info for a given stream. This will be used
 269  * to interpret the stream's timestamps. If the new time base is invalid
 270  * (numerator or denominator are non-positive), it leaves the stream
 271  * unchanged.
 272  *
 273  * @param s stream
 274  * @param pts_wrap_bits number of bits effectively used by the pts
 275  *        (used for wrap control)
 276  * @param pts_num time base numerator
 277  * @param pts_den time base denominator
 278  */
 279 void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits,
 280                          unsigned int pts_num, unsigned int pts_den);
 281
 282 /**
 283  * Add side data to a packet for changing parameters to the given values.
 284  * Parameters set to 0 aren't included in the change.
 285  */
 286 int ff_add_param_change(AVPacket *pkt, int32_t channels,
 287                         uint64_t channel_layout, int32_t sample_rate,
 288                         int32_t width, int32_t height);
 289
 290 /**
 291  * Set the timebase for each stream from the corresponding codec timebase and
 292  * print it.
 293  */
 294 int ff_framehash_write_header(AVFormatContext *s);
 295
 296 /**
 297  * Read a transport packet from a media file.
 298  *
 299  * @param s media file handle
 300  * @param pkt is filled
 301  * @return 0 if OK, AVERROR_xxx on error
 302  */
 303 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
 304
 305 /**
 306  * Interleave a packet per dts in an output media file.
 307  *
 308  * Packets with pkt->destruct == av_destruct_packet will be freed inside this
 309  * function, so they cannot be used after it. Note that calling av_free_packet()
 310  * on them is still safe.
 311  *
 312  * @param s media file handle
 313  * @param out the interleaved packet will be output here
 314  * @param pkt the input packet
 315  * @param flush 1 if no further packets are available as input and all
 316  *              remaining packets should be output
 317  * @return 1 if a packet was output, 0 if no packet could be output,
 318  *         < 0 if an error occurred
 319  */
 320 int ff_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out,
 321                                  AVPacket *pkt, int flush);
 322
 323 /**
 324  * Return the frame duration in seconds. Return 0 if not available.
 325  */
 326 void ff_compute_frame_duration(int *pnum, int *pden, AVStream *st,
 327                                AVCodecParserContext *pc, AVPacket *pkt);
 328
 329 int ff_get_audio_frame_size(AVCodecContext *enc, int size, int mux);
 330
 331 unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id);
 332
 333 enum AVCodecID ff_codec_get_id(const AVCodecTag *tags, unsigned int tag);
 334
 335 /**
 336  * Select a PCM codec based on the given parameters.
 337  *
 338  * @param bps     bits-per-sample
 339  * @param flt     floating-point
 340  * @param be      big-endian
 341  * @param sflags  signed flags. each bit corresponds to one byte of bit depth.
 342  *                e.g. the 1st bit indicates if 8-bit should be signed or
 343  *                unsigned, the 2nd bit indicates if 16-bit should be signed or
 344  *                unsigned, etc... This is useful for formats such as WAVE where
 345  *                only 8-bit is unsigned and all other bit depths are signed.
 346  * @return        a PCM codec id or AV_CODEC_ID_NONE
 347  */
 348 enum AVCodecID ff_get_pcm_codec_id(int bps, int flt, int be, int sflags);
 349
 350 /**
 351  * Generate standard extradata for AVC-Intra based on width/height and field
 352  * order.
 353  */
 354 int ff_generate_avci_extradata(AVStream *st);
 355
 356 #endif /* AVFORMAT_INTERNAL_H */