libavutil/parseutils.h File Reference

misc parsing utilities More...

#include <time.h>
#include "rational.h"

Go to the source code of this file.

Defines

#define av_parse_ratio_quiet(rate, str, max) av_parse_ratio(rate, str, max, AV_LOG_MAX_OFFSET, NULL)

Functions

int av_parse_ratio (AVRational *q, const char *str, int max, int log_offset, void *log_ctx)

Parse str and store the parsed ratio in q.

int av_parse_video_size (int *width_ptr, int *height_ptr, const char *str)

Parse str and put in width_ptr and height_ptr the detected values.

int av_parse_video_rate (AVRational *rate, const char *str)

Parse str and store the detected values in *rate.

int av_parse_color (uint8_t *rgba_color, const char *color_string, int slen, void *log_ctx)

Put the RGBA values that correspond to color_string in rgba_color.

int av_parse_time (int64_t *timeval, const char *timestr, int duration)

Parse timestr and return in *time a corresponding number of microseconds.

int av_find_info_tag (char *arg, int arg_size, const char *tag1, const char *info)

Attempt to find a specific tag in a URL.

time_t av_timegm (struct tm *tm)

Convert the decomposed UTC time in tm to a time_t value.

Detailed Description

misc parsing utilities

Definition in file parseutils.h.

Define Documentation

#define av_parse_ratio_quiet	(	rate,
		str,
		max	)	av_parse_ratio(rate, str, max, AV_LOG_MAX_OFFSET, NULL)

Definition at line 52 of file parseutils.h.

Referenced by av_parse_video_rate().

Function Documentation

int av_find_info_tag	(	char *	arg,
		int	arg_size,
		const char *	tag1,
		const char *	info
	)

Attempt to find a specific tag in a URL.

syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done. Return 1 if found.

Definition at line 641 of file parseutils.c.

Referenced by ff_udp_set_remote_url(), open_input_stream(), rtp_open(), sap_write_header(), sctp_open(), tcp_open(), and udp_open().

int av_parse_color	(	uint8_t *	rgba_color,
		const char *	color_string,
		int	slen,
		void *	log_ctx
	)

Put the RGBA values that correspond to color_string in rgba_color.

Parameters:

	color_string	a string specifying a color. It can be the name of a color (case insensitive match) or a [0x\|#]RRGGBB[AA] sequence, possibly followed by "@" and a string representing the alpha component. The alpha component may be a string composed by "0x" followed by an hexadecimal number or a decimal number between 0.0 and 1.0, which represents the opacity value (0x00/0.0 means completely transparent, 0xff/1.0 completely opaque). If the alpha component is not specified then 0xff is assumed. The string "random" will result in a random color.
	slen	length of the initial part of color_string containing the color. It can be set to -1 if color_string is a null terminated string containing nothing else than the color.

Returns:: >= 0 in case of success, a negative value in case of failure (for example if color_string cannot be parsed).

Definition at line 335 of file parseutils.c.

Referenced by color_init(), html_color_parse(), init(), and set_param().

int av_parse_ratio	(	AVRational *	q,
		const char *	str,
		int	max,
		int	log_offset,
		void *	log_ctx
	)

Parse str and store the parsed ratio in q.

Note that a ratio with infinite (1/0) or negative value is considered valid, so you should check on the returned value if you want to exclude those values.

The undefined value can be expressed using the "0:0" string.

Parameters:

`[in,out]`	q	pointer to the AVRational which will contain the ratio
`[in]`	str	the string to parse: it has to be a string in the format num:den, a float number or an expression
`[in]`	max	the maximum allowed numerator and denominator
`[in]`	log_offset	log level offset which is applied to the log level of log_ctx
`[in]`	log_ctx	parent logging context

Returns:: >= 0 on success, a negative error code otherwise

Definition at line 45 of file parseutils.c.

Referenced by ff_parse_time_base(), init(), and new_video_stream().

int av_parse_time	(	int64_t *	timeval,
		const char *	timestr,
		int	duration
	)

Parse timestr and return in *time a corresponding number of microseconds.

Parameters:

	timeval	puts here the number of microseconds corresponding to the string in timestr. If the string represents a duration, it is the number of microseconds contained in the time interval. If the string is a date, is the number of microseconds since 1st of January, 1970 up to the time of the parsed date. If timestr cannot be successfully parsed, set *time to INT64_MIN.
	timestr	a string representing a date or a duration. If a date the syntax is: [{YYYY-MM-DD\|YYYYMMDD}[T\|t\| ]]{{HH:MM:SS[.m...]]]}\|{HHMMSS[.m...]]]}}[Z] now If the value is "now" it takes the current time. Time is local time unless Z is appended, in which case it is interpreted as UTC. If the year-month-day part is not specified it takes the current year-month-day. If a duration the syntax is: [-]HH:MM:SS[.m...]]] [-]S+[.m...]
	duration	flag which tells how to interpret timestr, if not zero timestr is interpreted as a duration, otherwise as a date

Returns:: 0 in case of success, a negative value corresponding to an AVERROR code otherwise

Definition at line 531 of file parseutils.c.

Referenced by init(), open_input_stream(), parse_time_or_die(), and rtsp_parse_range_npt().

int av_parse_video_rate	(	AVRational *	rate,
		const char *	str
	)

Parse str and store the detected values in *rate.

Parameters:

`[in,out]`	rate	pointer to the AVRational which will contain the detected frame rate
`[in]`	str	the string to parse: it has to be a string in the format rate_num / rate_den, a float number or a valid video rate abbreviation

Returns:: >= 0 on success, a negative error code otherwise

Definition at line 160 of file parseutils.c.

Referenced by cdxl_read_header(), color_init(), dc1394_read_common(), dshow_read_header(), fbdev_read_header(), ff_raw_read_header(), ff_raw_video_read_header(), grab_read_header(), init(), new_video_stream(), parse_ffconfig(), read_header(), source_init(), v4l2_set_parameters(), vfw_read_header(), and x11grab_read_header().

int av_parse_video_size	(	int *	width_ptr,
		int *	height_ptr,
		const char *	str
	)

Parse str and put in width_ptr and height_ptr the detected values.

Parameters:

`[in,out]`	width_ptr	pointer to the variable which will contain the detected width value
`[in,out]`	height_ptr	pointer to the variable which will contain the detected height value
`[in]`	str	the string to parse: it has to be a string in the format width x height or a valid video size abbreviation.

Returns:: >= 0 on success, a negative error code otherwise

Definition at line 132 of file parseutils.c.

Referenced by av_opt_set(), color_init(), dc1394_read_common(), dshow_read_header(), ff_raw_read_header(), new_video_stream(), parse_ffconfig(), read_header(), source_init(), and vfw_read_header().

time_t av_timegm ( struct tm * tm )

Convert the decomposed UTC time in tm to a time_t value.

Definition at line 512 of file parseutils.c.

Referenced by av_parse_time(), and ff_iso8601_to_unix_time().


Defines
#define	av_parse_ratio_quiet(rate, str, max) av_parse_ratio(rate, str, max, AV_LOG_MAX_OFFSET, NULL)
Functions
int	av_parse_ratio (AVRational q, const char str, int max, int log_offset, void *log_ctx)
	Parse str and store the parsed ratio in q.
int	av_parse_video_size (int width_ptr, int height_ptr, const char *str)
	Parse str and put in width_ptr and height_ptr the detected values.
int	av_parse_video_rate (AVRational rate, const char str)
	Parse str and store the detected values in *rate.
int	av_parse_color (uint8_t rgba_color, const char color_string, int slen, void *log_ctx)
	Put the RGBA values that correspond to color_string in rgba_color.
int	av_parse_time (int64_t timeval, const char timestr, int duration)
	Parse timestr and return in *time a corresponding number of microseconds.
int	av_find_info_tag (char arg, int arg_size, const char tag1, const char *info)
	Attempt to find a specific tag in a URL.
time_t	av_timegm (struct tm *tm)
	Convert the decomposed UTC time in tm to a time_t value.