annotate lib/libavutil/parseutils.h @ 2575:a76d408c5132 tip

DrawTranslucent -> DrawTextureGrayShade Removed old texture drawing stuff
author a.parshin
date Wed, 09 Mar 2016 01:39:52 +0200
parents 992d2e6f907d
children
rev   line source
2134
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
1 /*
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
2 * This file is part of FFmpeg.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
3 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
4 * FFmpeg is free software; you can redistribute it and/or
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
5 * modify it under the terms of the GNU Lesser General Public
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
6 * License as published by the Free Software Foundation; either
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
7 * version 2.1 of the License, or (at your option) any later version.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
8 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
9 * FFmpeg is distributed in the hope that it will be useful,
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
12 * Lesser General Public License for more details.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
13 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
14 * You should have received a copy of the GNU Lesser General Public
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
15 * License along with FFmpeg; if not, write to the Free Software
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
17 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
18
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
19 #ifndef AVUTIL_PARSEUTILS_H
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
20 #define AVUTIL_PARSEUTILS_H
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
21
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
22 #include <time.h>
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
23
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
24 #include "rational.h"
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
25
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
26 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
27 * @file
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
28 * misc parsing utilities
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
29 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
30
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
31 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
32 * Parse str and store the parsed ratio in q.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
33 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
34 * Note that a ratio with infinite (1/0) or negative value is
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
35 * considered valid, so you should check on the returned value if you
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
36 * want to exclude those values.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
37 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
38 * The undefined value can be expressed using the "0:0" string.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
39 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
40 * @param[in,out] q pointer to the AVRational which will contain the ratio
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
41 * @param[in] str the string to parse: it has to be a string in the format
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
42 * num:den, a float number or an expression
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
43 * @param[in] max the maximum allowed numerator and denominator
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
44 * @param[in] log_offset log level offset which is applied to the log
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
45 * level of log_ctx
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
46 * @param[in] log_ctx parent logging context
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
47 * @return >= 0 on success, a negative error code otherwise
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
48 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
49 int av_parse_ratio(AVRational *q, const char *str, int max,
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
50 int log_offset, void *log_ctx);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
51
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
52 #define av_parse_ratio_quiet(rate, str, max) \
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
53 av_parse_ratio(rate, str, max, AV_LOG_MAX_OFFSET, NULL)
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
54
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
55 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
56 * Parse str and put in width_ptr and height_ptr the detected values.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
57 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
58 * @param[in,out] width_ptr pointer to the variable which will contain the detected
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
59 * width value
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
60 * @param[in,out] height_ptr pointer to the variable which will contain the detected
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
61 * height value
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
62 * @param[in] str the string to parse: it has to be a string in the format
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
63 * width x height or a valid video size abbreviation.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
64 * @return >= 0 on success, a negative error code otherwise
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
65 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
66 int av_parse_video_size(int *width_ptr, int *height_ptr, const char *str);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
67
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
68 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
69 * Parse str and store the detected values in *rate.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
70 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
71 * @param[in,out] rate pointer to the AVRational which will contain the detected
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
72 * frame rate
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
73 * @param[in] str the string to parse: it has to be a string in the format
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
74 * rate_num / rate_den, a float number or a valid video rate abbreviation
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
75 * @return >= 0 on success, a negative error code otherwise
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
76 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
77 int av_parse_video_rate(AVRational *rate, const char *str);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
78
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
79 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
80 * Put the RGBA values that correspond to color_string in rgba_color.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
81 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
82 * @param color_string a string specifying a color. It can be the name of
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
83 * a color (case insensitive match) or a [0x|#]RRGGBB[AA] sequence,
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
84 * possibly followed by "@" and a string representing the alpha
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
85 * component.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
86 * The alpha component may be a string composed by "0x" followed by an
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
87 * hexadecimal number or a decimal number between 0.0 and 1.0, which
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
88 * represents the opacity value (0x00/0.0 means completely transparent,
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
89 * 0xff/1.0 completely opaque).
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
90 * If the alpha component is not specified then 0xff is assumed.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
91 * The string "random" will result in a random color.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
92 * @param slen length of the initial part of color_string containing the
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
93 * color. It can be set to -1 if color_string is a null terminated string
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
94 * containing nothing else than the color.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
95 * @return >= 0 in case of success, a negative value in case of
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
96 * failure (for example if color_string cannot be parsed).
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
97 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
98 int av_parse_color(uint8_t *rgba_color, const char *color_string, int slen,
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
99 void *log_ctx);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
100
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
101 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
102 * Parse timestr and return in *time a corresponding number of
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
103 * microseconds.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
104 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
105 * @param timeval puts here the number of microseconds corresponding
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
106 * to the string in timestr. If the string represents a duration, it
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
107 * is the number of microseconds contained in the time interval. If
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
108 * the string is a date, is the number of microseconds since 1st of
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
109 * January, 1970 up to the time of the parsed date. If timestr cannot
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
110 * be successfully parsed, set *time to INT64_MIN.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
111
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
112 * @param timestr a string representing a date or a duration.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
113 * - If a date the syntax is:
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
114 * @code
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
115 * [{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH:MM:SS[.m...]]]}|{HHMMSS[.m...]]]}}[Z]
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
116 * now
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
117 * @endcode
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
118 * If the value is "now" it takes the current time.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
119 * Time is local time unless Z is appended, in which case it is
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
120 * interpreted as UTC.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
121 * If the year-month-day part is not specified it takes the current
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
122 * year-month-day.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
123 * - If a duration the syntax is:
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
124 * @code
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
125 * [-][HH:]MM:SS[.m...]
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
126 * [-]S+[.m...]
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
127 * @endcode
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
128 * @param duration flag which tells how to interpret timestr, if not
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
129 * zero timestr is interpreted as a duration, otherwise as a date
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
130 * @return 0 in case of success, a negative value corresponding to an
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
131 * AVERROR code otherwise
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
132 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
133 int av_parse_time(int64_t *timeval, const char *timestr, int duration);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
134
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
135 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
136 * Parse the input string p according to the format string fmt and
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
137 * store its results in the structure dt.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
138 * This implementation supports only a subset of the formats supported
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
139 * by the standard strptime().
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
140 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
141 * In particular it actually supports the parameters:
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
142 * - %H: the hour as a decimal number, using a 24-hour clock, in the
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
143 * range '00' through '23'
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
144 * - %J: hours as a decimal number, in the range '0' through INT_MAX
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
145 * - %M: the minute as a decimal number, using a 24-hour clock, in the
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
146 * range '00' through '59'
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
147 * - %S: the second as a decimal number, using a 24-hour clock, in the
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
148 * range '00' through '59'
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
149 * - %Y: the year as a decimal number, using the Gregorian calendar
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
150 * - %m: the month as a decimal number, in the range '1' through '12'
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
151 * - %d: the day of the month as a decimal number, in the range '1'
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
152 * through '31'
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
153 * - %%: a literal '%'
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
154 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
155 * @return a pointer to the first character not processed in this
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
156 * function call, or NULL in case the function fails to match all of
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
157 * the fmt string and therefore an error occurred
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
158 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
159 char *av_small_strptime(const char *p, const char *fmt, struct tm *dt);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
160
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
161 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
162 * Attempt to find a specific tag in a URL.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
163 *
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
164 * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
165 * Return 1 if found.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
166 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
167 int av_find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
168
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
169 /**
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
170 * Convert the decomposed UTC time in tm to a time_t value.
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
171 */
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
172 time_t av_timegm(struct tm *tm);
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
173
992d2e6f907d preparation for libavcodec
zipi
parents:
diff changeset
174 #endif /* AVUTIL_PARSEUTILS_H */