AVOptions: split av_set_string3 into opt type-specific functions
[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 "rational.h"
23
24 /**
25  * @file
26  * misc parsing utilities
27  */
28
29 /**
30  * Parse str and put in width_ptr and height_ptr the detected values.
31  *
32  * @param[in,out] width_ptr pointer to the variable which will contain the detected
33  * width value
34  * @param[in,out] height_ptr pointer to the variable which will contain the detected
35  * height value
36  * @param[in] str the string to parse: it has to be a string in the format
37  * width x height or a valid video size abbreviation.
38  * @return >= 0 on success, a negative error code otherwise
39  */
40 int av_parse_video_size(int *width_ptr, int *height_ptr, const char *str);
41
42 /**
43  * Parse str and store the detected values in *rate.
44  *
45  * @param[in,out] rate pointer to the AVRational which will contain the detected
46  * frame rate
47  * @param[in] str the string to parse: it has to be a string in the format
48  * rate_num / rate_den, a float number or a valid video rate abbreviation
49  * @return >= 0 on success, a negative error code otherwise
50  */
51 int av_parse_video_rate(AVRational *rate, const char *str);
52
53 /**
54  * Put the RGBA values that correspond to color_string in rgba_color.
55  *
56  * @param color_string a string specifying a color. It can be the name of
57  * a color (case insensitive match) or a [0x|#]RRGGBB[AA] sequence,
58  * possibly followed by "@" and a string representing the alpha
59  * component.
60  * The alpha component may be a string composed by "0x" followed by an
61  * hexadecimal number or a decimal number between 0.0 and 1.0, which
62  * represents the opacity value (0x00/0.0 means completely transparent,
63  * 0xff/1.0 completely opaque).
64  * If the alpha component is not specified then 0xff is assumed.
65  * The string "random" will result in a random color.
66  * @param slen length of the initial part of color_string containing the
67  * color. It can be set to -1 if color_string is a null terminated string
68  * containing nothing else than the color.
69  * @return >= 0 in case of success, a negative value in case of
70  * failure (for example if color_string cannot be parsed).
71  */
72 int av_parse_color(uint8_t *rgba_color, const char *color_string, int slen,
73                    void *log_ctx);
74
75 /**
76  * Parses timestr and returns in *time a corresponding number of
77  * microseconds.
78  *
79  * @param timeval puts here the number of microseconds corresponding
80  * to the string in timestr. If the string represents a duration, it
81  * is the number of microseconds contained in the time interval.  If
82  * the string is a date, is the number of microseconds since 1st of
83  * January, 1970 up to the time of the parsed date.  If timestr cannot
84  * be successfully parsed, set *time to INT64_MIN.
85
86  * @param timestr a string representing a date or a duration.
87  * - If a date the syntax is:
88  * @code
89  * [{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH[:MM[:SS[.m...]]]}|{HH[MM[SS[.m...]]]}}[Z]
90  * now
91  * @endcode
92  * If the value is "now" it takes the current time.
93  * Time is local time unless Z is appended, in which case it is
94  * interpreted as UTC.
95  * If the year-month-day part is not specified it takes the current
96  * year-month-day.
97  * - If a duration the syntax is:
98  * @code
99  * [-]HH[:MM[:SS[.m...]]]
100  * [-]S+[.m...]
101  * @endcode
102  * @param duration flag which tells how to interpret timestr, if not
103  * zero timestr is interpreted as a duration, otherwise as a date
104  * @return 0 in case of success, a negative value corresponding to an
105  * AVERROR code otherwise
106  */
107 int av_parse_time(int64_t *timeval, const char *timestr, int duration);
108
109 /**
110  * Attempt to find a specific tag in a URL.
111  *
112  * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
113  * Return 1 if found.
114  */
115 int av_find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
116
117 #endif /* AVUTIL_PARSEUTILS_H */