FFmpeg
Macros | Functions | Variables
utils.c File Reference

various utility functions for use within FFmpeg More...

#include <stdarg.h>
#include <stdint.h>
#include "config.h"
#include "libavutil/avassert.h"
#include "libavutil/avstring.h"
#include "libavutil/dict.h"
#include "libavutil/internal.h"
#include "libavutil/mathematics.h"
#include "libavutil/opt.h"
#include "libavutil/parseutils.h"
#include "libavutil/pixdesc.h"
#include "libavutil/thread.h"
#include "libavutil/time.h"
#include "libavutil/time_internal.h"
#include "libavutil/timestamp.h"
#include "libavcodec/bytestream.h"
#include "libavcodec/internal.h"
#include "libavcodec/raw.h"
#include "audiointerleave.h"
#include "avformat.h"
#include "avio_internal.h"
#include "id3v2.h"
#include "internal.h"
#include "metadata.h"
#include "riff.h"
#include "url.h"
#include "libavutil/ffversion.h"

Macros

#define LICENSE_PREFIX   "libavformat license: "
 
#define RELATIVE_TS_BASE   (INT64_MAX - (1LL<<48))
 
#define SANE_CHUNK_SIZE   (50000000)
 
#define DURATION_MAX_READ_SIZE   250000LL
 
#define DURATION_MAX_RETRY   6
 
#define FAIL(errmsg)
 

Functions

unsigned avformat_version (void)
 Return the LIBAVFORMAT_VERSION_INT constant.
 
const char * avformat_configuration (void)
 Return the libavformat build-time configuration.
 
const char * avformat_license (void)
 Return the libavformat license.
 
int ff_lock_avformat (void)
 
int ff_unlock_avformat (void)
 
int64_t av_stream_get_end_pts (const AVStream *st)
 Returns the pts of the last muxed packet + its duration. More...
 
struct AVCodecParserContextav_stream_get_parser (const AVStream *st)
 
void av_format_inject_global_side_data (AVFormatContext *s)
 This function will cause global side data to be injected in the next packet of each stream as well as after any subsequent seek.
 
int ff_copy_whiteblacklists (AVFormatContext *dst, const AVFormatContext *src)
 Copies the whilelists from one context to the other.
 
int ffio_limit (AVIOContext *s, int size)
 
int av_get_packet (AVIOContext *s, AVPacket *pkt, int size)
 Allocate and read the payload of a packet and initialize its fields with default values. More...
 
int av_append_packet (AVIOContext *s, AVPacket *pkt, int size)
 Read data and append it to the current content of the AVPacket. More...
 
int av_filename_number_test (const char *filename)
 Check whether filename actually is a numbered sequence generator. More...
 
int av_demuxer_open (AVFormatContext *ic)
 
int ff_packet_list_put (AVPacketList **packet_buffer, AVPacketList **plast_pktl, AVPacket *pkt, int flags)
 Append an AVPacket to the list. More...
 
int avformat_queue_attached_pictures (AVFormatContext *s)
 
int avformat_open_input (AVFormatContext **ps, const char *filename, AVInputFormat *fmt, AVDictionary **options)
 Open an input stream and read the header. More...
 
int ff_read_packet (AVFormatContext *s, AVPacket *pkt)
 Read a transport packet from a media file. More...
 
void ff_compute_frame_duration (AVFormatContext *s, int *pnum, int *pden, AVStream *st, AVCodecParserContext *pc, AVPacket *pkt)
 Return the frame duration in seconds. More...
 
void ff_packet_list_free (AVPacketList **pkt_buf, AVPacketList **pkt_buf_end)
 Wipe the list and unref all the packets in it. More...
 
int ff_packet_list_get (AVPacketList **pkt_buffer, AVPacketList **pkt_buffer_end, AVPacket *pkt)
 Remove the oldest AVPacket in the list and return it. More...
 
int av_read_frame (AVFormatContext *s, AVPacket *pkt)
 Return the next frame of a stream. More...
 
int av_find_default_stream_index (AVFormatContext *s)
 
void ff_read_frame_flush (AVFormatContext *s)
 Flush the frame reader. More...
 
void ff_update_cur_dts (AVFormatContext *s, AVStream *ref_st, int64_t timestamp)
 Update cur_dts of all streams based on the given timestamp and AVStream. More...
 
void ff_reduce_index (AVFormatContext *s, int stream_index)
 Ensure the index uses less memory than the maximum specified in AVFormatContext.max_index_size by discarding entries if it grows too large.
 
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)
 Internal version of av_add_index_entry.
 
int av_add_index_entry (AVStream *st, int64_t pos, int64_t timestamp, int size, int distance, int flags)
 Add an index entry into a sorted list. More...
 
int ff_index_search_timestamp (const AVIndexEntry *entries, int nb_entries, int64_t wanted_timestamp, int flags)
 Internal version of av_index_search_timestamp.
 
void ff_configure_buffers_for_index (AVFormatContext *s, int64_t time_tolerance)
 
int av_index_search_timestamp (AVStream *st, int64_t wanted_timestamp, int flags)
 Get the index for a specific timestamp. More...
 
int ff_seek_frame_binary (AVFormatContext *s, int stream_index, int64_t target_ts, int flags)
 Perform a binary search using av_index_search_timestamp() and AVInputFormat.read_timestamp(). More...
 
int ff_find_last_ts (AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos, int64_t(*read_timestamp)(struct AVFormatContext *, int, int64_t *, int64_t))
 
int64_t ff_gen_search (AVFormatContext *s, int stream_index, int64_t target_ts, int64_t pos_min, int64_t pos_max, int64_t pos_limit, int64_t ts_min, int64_t ts_max, int flags, int64_t *ts_ret, int64_t(*read_timestamp)(struct AVFormatContext *, int, int64_t *, int64_t))
 Perform a binary search using read_timestamp(). More...
 
int av_seek_frame (AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
 Seek to the keyframe at timestamp. More...
 
int avformat_seek_file (AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
 Seek to timestamp ts. More...
 
int avformat_flush (AVFormatContext *s)
 Discard all internally buffered data. More...
 
unsigned int ff_codec_get_tag (const AVCodecTag *tags, enum AVCodecID id)
 
enum AVCodecID ff_codec_get_id (const AVCodecTag *tags, unsigned int tag)
 
enum AVCodecID ff_get_pcm_codec_id (int bps, int flt, int be, int sflags)
 Select a PCM codec based on the given parameters. More...
 
unsigned int av_codec_get_tag (const AVCodecTag *const *tags, enum AVCodecID id)
 
int av_codec_get_tag2 (const AVCodecTag *const *tags, enum AVCodecID id, unsigned int *tag)
 
enum AVCodecID av_codec_get_id (const AVCodecTag *const *tags, unsigned int tag)
 
int ff_alloc_extradata (AVCodecParameters *par, int size)
 Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0. More...
 
int ff_get_extradata (AVFormatContext *s, AVCodecParameters *par, AVIOContext *pb, int size)
 Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0 and fill it from pb. More...
 
int ff_rfps_add_frame (AVFormatContext *ic, AVStream *st, int64_t ts)
 add frame for rfps calculation. More...
 
void ff_rfps_calculate (AVFormatContext *ic)
 
int avformat_find_stream_info (AVFormatContext *ic, AVDictionary **options)
 Read packets of a media file to get stream information. More...
 
AVProgramav_find_program_from_stream (AVFormatContext *ic, AVProgram *last, int s)
 Find the programs which belong to a given stream. More...
 
int av_find_best_stream (AVFormatContext *ic, enum AVMediaType type, int wanted_stream_nb, int related_stream, AVCodec **decoder_ret, int flags)
 Find the "best" stream in the file. More...
 
int av_read_play (AVFormatContext *s)
 Start playing a network-based stream (e.g. More...
 
int av_read_pause (AVFormatContext *s)
 Pause a network-based stream (e.g. More...
 
int ff_stream_encode_params_copy (AVStream *dst, const AVStream *src)
 Copy encoding parameters from source to destination stream. More...
 
void ff_free_stream (AVFormatContext *s, AVStream *st)
 
void avformat_free_context (AVFormatContext *s)
 Free an AVFormatContext and all its streams. More...
 
void avformat_close_input (AVFormatContext **ps)
 Close an opened input AVFormatContext. More...
 
AVStreamavformat_new_stream (AVFormatContext *s, const AVCodec *c)
 Add a new stream to a media file. More...
 
AVProgramav_new_program (AVFormatContext *ac, int id)
 
AVChapteravpriv_new_chapter (AVFormatContext *s, int id, AVRational time_base, int64_t start, int64_t end, const char *title)
 Add a new chapter. More...
 
void av_program_add_stream_index (AVFormatContext *ac, int progid, unsigned idx)
 
uint64_t ff_ntp_time (void)
 Get the current time since NTP epoch in microseconds. More...
 
int av_get_frame_filename2 (char *buf, int buf_size, const char *path, int number, int flags)
 Return in 'buf' the path with 'd' replaced by a number. More...
 
int av_get_frame_filename (char *buf, int buf_size, const char *path, int number)
 
void av_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)
 Split a URL string into components. More...
 
char * ff_data_to_hex (char *buff, const uint8_t *src, int s, int lowercase)
 
int ff_hex_to_data (uint8_t *data, const char *p)
 Parse a string of hexadecimal strings. More...
 
void avpriv_set_pts_info (AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
 Set the time base and wrapping info for a given stream. More...
 
void ff_parse_key_value (const char *str, ff_parse_key_val_cb callback_get_buf, void *context)
 Parse a string with comma-separated key=value pairs. More...
 
int ff_find_stream_index (AVFormatContext *s, int id)
 Find stream index based on format-specific stream ID. More...
 
int avformat_query_codec (const AVOutputFormat *ofmt, enum AVCodecID codec_id, int std_compliance)
 Test if the given container can store a codec. More...
 
int avformat_network_init (void)
 Do global initialization of network libraries. More...
 
int avformat_network_deinit (void)
 Undo the initialization done by avformat_network_init. More...
 
int ff_add_param_change (AVPacket *pkt, int32_t channels, uint64_t channel_layout, int32_t sample_rate, int32_t width, int32_t height)
 Add side data to a packet for changing parameters to the given values. More...
 
AVRational av_guess_sample_aspect_ratio (AVFormatContext *format, AVStream *stream, AVFrame *frame)
 Guess the sample aspect ratio of a frame, based on both the stream and the frame aspect ratio. More...
 
AVRational av_guess_frame_rate (AVFormatContext *format, AVStream *st, AVFrame *frame)
 Guess the frame rate, based on both the container and codec information. More...
 
int avformat_match_stream_specifier (AVFormatContext *s, AVStream *st, const char *spec)
 Check if the stream st contained in s is matched by the stream specifier spec. More...
 
int ff_generate_avci_extradata (AVStream *st)
 Generate standard extradata for AVC-Intra based on width/height and field order.
 
uint8_t * av_stream_get_side_data (const AVStream *st, enum AVPacketSideDataType type, int *size)
 Get side information from stream. More...
 
int av_stream_add_side_data (AVStream *st, enum AVPacketSideDataType type, uint8_t *data, size_t size)
 Wrap an existing array as stream side data. More...
 
uint8_t * av_stream_new_side_data (AVStream *st, enum AVPacketSideDataType type, int size)
 Allocate new information from stream. More...
 
int ff_stream_add_bitstream_filter (AVStream *st, const char *name, const char *args)
 Add a bitstream filter to a stream. More...
 
int ff_format_output_open (AVFormatContext *s, const char *url, AVDictionary **options)
 Utility function to open IO stream of output format. More...
 
void ff_format_io_close (AVFormatContext *s, AVIOContext **pb)
 
int ff_is_http_proto (char *filename)
 Utility function to check if the file uses http or https protocol. More...
 
int ff_parse_creation_time_metadata (AVFormatContext *s, int64_t *timestamp, int return_seconds)
 Parse creation_time in AVFormatContext metadata if exists and warn if the parsing fails. More...
 
int ff_standardize_creation_time (AVFormatContext *s)
 Standardize creation_time metadata in AVFormatContext to an ISO-8601 timestamp string. More...
 
int ff_get_packet_palette (AVFormatContext *s, AVPacket *pkt, int ret, uint32_t *palette)
 Retrieves the palette from a packet, either from side data, or appended to the video data in the packet itself (raw video only). More...
 
int ff_bprint_to_codecpar_extradata (AVCodecParameters *par, struct AVBPrint *buf)
 Finalize buf into extradata and set its size appropriately.
 
int avformat_transfer_internal_stream_timing_info (const AVOutputFormat *ofmt, AVStream *ost, const AVStream *ist, enum AVTimebaseSource copy_tb)
 Transfer internal timing information from one stream to another. More...
 
AVRational av_stream_get_codec_timebase (const AVStream *st)
 Get the internal codec timebase from a stream. More...
 
void ff_format_set_url (AVFormatContext *s, char *url)
 Set AVFormatContext url field to the provided pointer. More...
 

Variables

const char av_format_ffversion [] = "FFmpeg version " FFMPEG_VERSION
 

Detailed Description

various utility functions for use within FFmpeg

Macro Definition Documentation

§ FAIL

#define FAIL (   errmsg)
Value:
do { \
if (errmsg_ptr) \
*errmsg_ptr = errmsg; \
return 0; \
} while (0)

Function Documentation

§ av_append_packet()

int av_append_packet ( AVIOContext s,
AVPacket pkt,
int  size 
)

Read data and append it to the current content of the AVPacket.

If pkt->size is 0 this is identical to av_get_packet. Note that this uses av_grow_packet and thus involves a realloc which is inefficient. Thus this function should only be used when there is no reasonable way to know (an upper bound of) the final size.

Parameters
sassociated IO context
pktpacket
sizeamount of data to read
Returns
>0 (read size) if OK, AVERROR_xxx otherwise, previous data will not be lost even if an error occurs.

§ av_get_packet()

int av_get_packet ( AVIOContext s,
AVPacket pkt,
int  size 
)

Allocate and read the payload of a packet and initialize its fields with default values.

Parameters
sassociated IO context
pktpacket
sizedesired payload size
Returns
>0 (read size) if OK, AVERROR_xxx otherwise

§ av_stream_get_end_pts()

int64_t av_stream_get_end_pts ( const AVStream st)

Returns the pts of the last muxed packet + its duration.

the retuned value is undefined when used with a demuxer.

§ avpriv_new_chapter()

AVChapter* avpriv_new_chapter ( AVFormatContext s,
int  id,
AVRational  time_base,
int64_t  start,
int64_t  end,
const char *  title 
)

Add a new chapter.

Parameters
smedia file handle
idunique ID for this chapter
startchapter start time in time_base units
endchapter end time in time_base units
titlechapter title
Returns
AVChapter or NULL on error

§ avpriv_set_pts_info()

void avpriv_set_pts_info ( AVStream s,
int  pts_wrap_bits,
unsigned int  pts_num,
unsigned int  pts_den 
)

Set the time base and wrapping info for a given stream.

This will be used to interpret the stream's timestamps. If the new time base is invalid (numerator or denominator are non-positive), it leaves the stream unchanged.

Parameters
sstream
pts_wrap_bitsnumber of bits effectively used by the pts (used for wrap control)
pts_numtime base numerator
pts_dentime base denominator

§ ff_add_param_change()

int ff_add_param_change ( AVPacket pkt,
int32_t  channels,
uint64_t  channel_layout,
int32_t  sample_rate,
int32_t  width,
int32_t  height 
)

Add side data to a packet for changing parameters to the given values.

Parameters set to 0 aren't included in the change.

§ ff_alloc_extradata()

int ff_alloc_extradata ( AVCodecParameters par,
int  size 
)

Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0.

Previously allocated extradata in par will be freed.

Parameters
sizesize of extradata
Returns
0 if OK, AVERROR_xxx on error

§ ff_compute_frame_duration()

void ff_compute_frame_duration ( AVFormatContext s,
int *  pnum,
int *  pden,
AVStream st,
AVCodecParserContext pc,
AVPacket pkt 
)

Return the frame duration in seconds.

Return 0 if not available.

§ ff_find_stream_index()

int ff_find_stream_index ( AVFormatContext s,
int  id 
)

Find stream index based on format-specific stream ID.

Returns
stream index, or < 0 on error

§ ff_format_output_open()

int ff_format_output_open ( AVFormatContext s,
const char *  url,
AVDictionary **  options 
)

Utility function to open IO stream of output format.

Parameters
sAVFormatContext
urlURL or file name to open for writing optional options which will be passed to io_open callback
Returns
>=0 on success, negative AVERROR in case of failure

§ ff_format_set_url()

void ff_format_set_url ( AVFormatContext s,
char *  url 
)

Set AVFormatContext url field to the provided pointer.

The pointer must point to a valid string. The existing url field is freed if necessary. Also set the legacy filename field to the same string which was provided in url.

§ ff_gen_search()

int64_t ff_gen_search ( AVFormatContext s,
int  stream_index,
int64_t  target_ts,
int64_t  pos_min,
int64_t  pos_max,
int64_t  pos_limit,
int64_t  ts_min,
int64_t  ts_max,
int  flags,
int64_t *  ts_ret,
int64_t(*)(struct AVFormatContext *, int, int64_t *, int64_t)  read_timestamp 
)

Perform a binary search using read_timestamp().

Parameters
target_tstarget timestamp in the time base of the given stream
stream_indexstream number

§ ff_get_extradata()

int ff_get_extradata ( AVFormatContext s,
AVCodecParameters par,
AVIOContext pb,
int  size 
)

Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0 and fill it from pb.

Parameters
sizesize of extradata
Returns
>= 0 if OK, AVERROR_xxx on error

§ ff_get_packet_palette()

int ff_get_packet_palette ( AVFormatContext s,
AVPacket pkt,
int  ret,
uint32_t *  palette 
)

Retrieves the palette from a packet, either from side data, or appended to the video data in the packet itself (raw video only).

It is commonly used after a call to ff_reshuffle_raw_rgb().

Use 0 for the ret parameter to check for side data only.

Parameters
pktpointer to packet before calling ff_reshuffle_raw_rgb()
retreturn value from ff_reshuffle_raw_rgb(), or 0
palettepointer to palette buffer
Returns
negative error code or 1 if the packet has a palette, else 0

§ ff_get_pcm_codec_id()

enum AVCodecID ff_get_pcm_codec_id ( int  bps,
int  flt,
int  be,
int  sflags 
)

Select a PCM codec based on the given parameters.

Parameters
bpsbits-per-sample
fltfloating-point
bebig-endian
sflagssigned flags. each bit corresponds to one byte of bit depth. e.g. the 1st bit indicates if 8-bit should be signed or unsigned, the 2nd bit indicates if 16-bit should be signed or unsigned, etc... This is useful for formats such as WAVE where only 8-bit is unsigned and all other bit depths are signed.
Returns
a PCM codec id or AV_CODEC_ID_NONE

§ ff_hex_to_data()

int ff_hex_to_data ( uint8_t *  data,
const char *  p 
)

Parse a string of hexadecimal strings.

Any space between the hexadecimal digits is ignored.

Parameters
dataif non-null, the parsed data is written to this pointer
pthe string to parse
Returns
the number of bytes written (or to be written, if data is null)

§ ff_is_http_proto()

int ff_is_http_proto ( char *  filename)

Utility function to check if the file uses http or https protocol.

Parameters
sAVFormatContext
filenameURL or file name to open for writing

§ ff_ntp_time()

uint64_t ff_ntp_time ( void  )

Get the current time since NTP epoch in microseconds.

§ ff_packet_list_free()

void ff_packet_list_free ( AVPacketList **  head,
AVPacketList **  tail 
)

Wipe the list and unref all the packets in it.

Parameters
headList head element
tailList tail element

§ ff_packet_list_get()

int ff_packet_list_get ( AVPacketList **  head,
AVPacketList **  tail,
AVPacket pkt 
)

Remove the oldest AVPacket in the list and return it.

Note
The pkt will be overwritten completely. The caller owns the packet and must unref it by itself.
Parameters
headList head element
tailList tail element
pktPointer to an initialized AVPacket struct

§ ff_packet_list_put()

int ff_packet_list_put ( AVPacketList **  head,
AVPacketList **  tail,
AVPacket pkt,
int  flags 
)

Append an AVPacket to the list.

Parameters
headList head element
tailList tail element
pktThe packet being appended
flagsAny combination of FF_PACKETLIST_FLAG_* flags
Returns
0 on success, negative AVERROR value on failure. On failure, the list is unchanged

§ ff_parse_creation_time_metadata()

int ff_parse_creation_time_metadata ( AVFormatContext s,
int64_t *  timestamp,
int  return_seconds 
)

Parse creation_time in AVFormatContext metadata if exists and warn if the parsing fails.

Parameters
sAVFormatContext
timestampparsed timestamp in microseconds, only set on successful parsing
return_secondsset this to get the number of seconds in timestamp instead of microseconds
Returns
1 if OK, 0 if the metadata was not present, AVERROR(EINVAL) on parse error

§ ff_parse_key_value()

void ff_parse_key_value ( const char *  str,
ff_parse_key_val_cb  callback_get_buf,
void *  context 
)

Parse a string with comma-separated key=value pairs.

The value strings may be quoted and may contain escaped characters within quoted strings.

Parameters
strthe string to parse
callback_get_buffunction that returns where to store the unescaped value string.
contextthe opaque context pointer to pass to callback_get_buf

§ ff_read_frame_flush()

void ff_read_frame_flush ( AVFormatContext s)

Flush the frame reader.

§ ff_read_packet()

int ff_read_packet ( AVFormatContext s,
AVPacket pkt 
)

Read a transport packet from a media file.

Parameters
smedia file handle
pktis filled
Returns
0 if OK, AVERROR_xxx on error

§ ff_rfps_add_frame()

int ff_rfps_add_frame ( AVFormatContext ic,
AVStream st,
int64_t  dts 
)

add frame for rfps calculation.

Parameters
dtstimestamp of the i-th frame
Returns
0 if OK, AVERROR_xxx on error

§ ff_seek_frame_binary()

int ff_seek_frame_binary ( AVFormatContext s,
int  stream_index,
int64_t  target_ts,
int  flags 
)

Perform a binary search using av_index_search_timestamp() and AVInputFormat.read_timestamp().

Parameters
target_tstarget timestamp in the time base of the given stream
stream_indexstream number

§ ff_standardize_creation_time()

int ff_standardize_creation_time ( AVFormatContext s)

Standardize creation_time metadata in AVFormatContext to an ISO-8601 timestamp string.

Parameters
sAVFormatContext
Returns
<0 on error

§ ff_stream_add_bitstream_filter()

int ff_stream_add_bitstream_filter ( AVStream st,
const char *  name,
const char *  args 
)

Add a bitstream filter to a stream.

Parameters
stoutput stream to add a filter to
namethe name of the filter to add
argsfilter-specific argument string
Returns
>0 on success; AVERROR code on failure

§ ff_stream_encode_params_copy()

int ff_stream_encode_params_copy ( AVStream dst,
const AVStream src 
)

Copy encoding parameters from source to destination stream.

Parameters
dstpointer to destination AVStream
srcpointer to source AVStream
Returns
>=0 on success, AVERROR code on error

§ ff_update_cur_dts()

void ff_update_cur_dts ( AVFormatContext s,
AVStream ref_st,
int64_t  timestamp 
)

Update cur_dts of all streams based on the given timestamp and AVStream.

Stream ref_st unchanged, others set cur_dts in their native time base. Only needed for timestamp wrapping or if (dts not set and pts!=dts).

Parameters
timestampnew dts expressed in time_base of param ref_st
ref_streference stream giving time_base of param timestamp