FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros | Functions
parseutils.h File Reference

misc parsing utilities More...

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

Go to the source code of this file.

Macros

#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.
 
const char * av_get_known_color_name (int color_idx, const uint8_t **rgb)
 Get the name of a color from the internal table of hard-coded named colors.
 
int av_parse_time (int64_t *timeval, const char *timestr, int duration)
 Parse timestr and return in *time a corresponding number of microseconds.
 
char * av_small_strptime (const char *p, const char *fmt, struct tm *dt)
 Parse the input string p according to the format string fmt and store its results in the structure dt.
 
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.

Macro Definition 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_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]qpointer to the AVRational which will contain the ratio
[in]strthe string to parse: it has to be a string in the format num:den, a float number or an expression
[in]maxthe maximum allowed numerator and denominator
[in]log_offsetlog level offset which is applied to the log level of log_ctx
[in]log_ctxparent logging context
Returns
>= 0 on success, a negative error code otherwise

Definition at line 44 of file parseutils.c.

Referenced by ff_parse_time_base(), get_aspect_ratio(), new_video_stream(), and vivo_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_ptrpointer to the variable which will contain the detected width value
[in,out]height_ptrpointer to the variable which will contain the detected height value
[in]strthe 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 138 of file parseutils.c.

Referenced by add_input_streams(), av_opt_is_set_to_default(), create_stream(), dc1394_read_common(), ffserver_parse_config_stream(), init_dict(), main(), new_subtitle_stream(), new_video_stream(), set_string_image_size(), and vfw_read_header().

int av_parse_video_rate ( AVRational rate,
const char *  str 
)

Parse str and store the detected values in *rate.

Parameters
[in,out]ratepointer to the AVRational which will contain the detected frame rate
[in]strthe 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 169 of file parseutils.c.

Referenced by add_input_streams(), av_opt_is_set_to_default(), cdxl_read_header(), create_stream(), dc1394_read_common(), dshow_read_header(), ffserver_parse_config_stream(), grab_read_header(), new_video_stream(), set_string_video_rate(), v4l2_set_parameters(), and vfw_read_header().

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_stringa 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.
slenlength 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 344 of file parseutils.c.

Referenced by av_opt_is_set_to_default(), draw_text(), html_color_parse(), init(), set_param(), and set_string_color().

const char* av_get_known_color_name ( int  color_idx,
const uint8_t **  rgb 
)

Get the name of a color from the internal table of hard-coded named colors.

This function is meant to enumerate the color names recognized by av_parse_color().

Parameters
color_idxindex of the requested color, starting from 0
rgbpif not NULL, will point to a 3-elements array with the color value in RGB
Returns
the color name string or NULL if color_idx is not in the array

Definition at line 424 of file parseutils.c.

Referenced by show_colors().

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

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

Parameters
timevalputs 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.
timestra 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...]
durationflag 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 551 of file parseutils.c.

Referenced by av_opt_set(), concat_read_header(), ffm_write_header(), func_pts(), open_input_stream(), parse_interval(), parse_read_interval(), parse_time_or_die(), parse_times(), rtsp_parse_range_npt(), and seg_write_header().

char* av_small_strptime ( const char *  p,
const char *  fmt,
struct tm *  dt 
)

Parse the input string p according to the format string fmt and store its results in the structure dt.

This implementation supports only a subset of the formats supported by the standard strptime().

In particular it actually supports the parameters:

  • H: the hour as a decimal number, using a 24-hour clock, in the range '00' through '23'
  • J: hours as a decimal number, in the range '0' through INT_MAX
  • M: the minute as a decimal number, using a 24-hour clock, in the range '00' through '59'
  • S: the second as a decimal number, using a 24-hour clock, in the range '00' through '59'
  • Y: the year as a decimal number, using the Gregorian calendar
  • m: the month as a decimal number, in the range '1' through '12'
  • d: the day of the month as a decimal number, in the range '1' through '31'
  • %%: a literal ''
Returns
a pointer to the first character not processed in this function call, or NULL in case the function fails to match all of the fmt string and therefore an error occurred

Definition at line 464 of file parseutils.c.

Referenced by av_parse_time(), and ff_iso8601_to_unix_time().

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 670 of file parseutils.c.

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

time_t av_timegm ( struct tm *  tm)

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

Definition at line 532 of file parseutils.c.

Referenced by av_parse_time(), and ff_iso8601_to_unix_time().