msvc/icl: Use __declspec(deprecated)
[ffmpeg.git] / libavutil / parseutils.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef AVUTIL_PARSEUTILS_H
20 #define AVUTIL_PARSEUTILS_H
21
22 #include <time.h>
23
24 #include "rational.h"
25
26 /**
27  * @file
28  * misc parsing utilities
29  */
30
31 /**
32  * Parse str and put in width_ptr and height_ptr the detected values.
33  *
34  * @param[in,out] width_ptr pointer to the variable which will contain the detected
35  * width value
36  * @param[in,out] height_ptr pointer to the variable which will contain the detected
37  * height value
38  * @param[in] str the string to parse: it has to be a string in the format
39  * width x height or a valid video size abbreviation.
40  * @return >= 0 on success, a negative error code otherwise
41  */
42 int av_parse_video_size(int *width_ptr, int *height_ptr, const char *str);
43
44 /**
45  * Parse str and store the detected values in *rate.
46  *
47  * @param[in,out] rate pointer to the AVRational which will contain the detected
48  * frame rate
49  * @param[in] str the string to parse: it has to be a string in the format
50  * rate_num / rate_den, a float number or a valid video rate abbreviation
51  * @return >= 0 on success, a negative error code otherwise
52  */
53 int av_parse_video_rate(AVRational *rate, const char *str);
54
55 /**
56  * Put the RGBA values that correspond to color_string in rgba_color.
57  *
58  * @param color_string a string specifying a color. It can be the name of
59  * a color (case insensitive match) or a [0x|#]RRGGBB[AA] sequence,
60  * possibly followed by "@" and a string representing the alpha
61  * component.
62  * The alpha component may be a string composed by "0x" followed by an
63  * hexadecimal number or a decimal number between 0.0 and 1.0, which
64  * represents the opacity value (0x00/0.0 means completely transparent,
65  * 0xff/1.0 completely opaque).
66  * If the alpha component is not specified then 0xff is assumed.
67  * The string "random" will result in a random color.
68  * @param slen length of the initial part of color_string containing the
69  * color. It can be set to -1 if color_string is a null terminated string
70  * containing nothing else than the color.
71  * @return >= 0 in case of success, a negative value in case of
72  * failure (for example if color_string cannot be parsed).
73  */
74 int av_parse_color(uint8_t *rgba_color, const char *color_string, int slen,
75                    void *log_ctx);
76
77 /**
78  * Parse timestr and return in *time a corresponding number of
79  * microseconds.
80  *
81  * @param timeval puts here the number of microseconds corresponding
82  * to the string in timestr. If the string represents a duration, it
83  * is the number of microseconds contained in the time interval.  If
84  * the string is a date, is the number of microseconds since 1st of
85  * January, 1970 up to the time of the parsed date.  If timestr cannot
86  * be successfully parsed, set *time to INT64_MIN.
87
88  * @param timestr a string representing a date or a duration.
89  * - If a date the syntax is:
90  * @code
91  * [{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z]
92  * now
93  * @endcode
94  * If the value is "now" it takes the current time.
95  * Time is local time unless Z is appended, in which case it is
96  * interpreted as UTC.
97  * If the year-month-day part is not specified it takes the current
98  * year-month-day.
99  * - If a duration the syntax is:
100  * @code
101  * [-]HH[:MM[:SS[.m...]]]
102  * [-]S+[.m...]
103  * @endcode
104  * @param duration flag which tells how to interpret timestr, if not
105  * zero timestr is interpreted as a duration, otherwise as a date
106  * @return 0 in case of success, a negative value corresponding to an
107  * AVERROR code otherwise
108  */
109 int av_parse_time(int64_t *timeval, const char *timestr, int duration);
110
111 /**
112  * Attempt to find a specific tag in a URL.
113  *
114  * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
115  * Return 1 if found.
116  */
117 int av_find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
118
119 /**
120  * Convert the decomposed UTC time in tm to a time_t value.
121  */
122 time_t av_timegm(struct tm *tm);
123
124 #endif /* AVUTIL_PARSEUTILS_H */