parseutils.h 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  1. /*
  2. * This file is part of FFmpeg.
  3. *
  4. * FFmpeg 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. * FFmpeg 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 FFmpeg; if not, write to the Free Software
  16. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17. */
  18. #ifndef AVUTIL_PARSEUTILS_H
  19. #define AVUTIL_PARSEUTILS_H
  20. #include <time.h>
  21. #include "rational.h"
  22. /**
  23. * @file
  24. * misc parsing utilities
  25. */
  26. /**
  27. * Parse str and store the parsed ratio in q.
  28. *
  29. * Note that a ratio with infinite (1/0) or negative value is
  30. * considered valid, so you should check on the returned value if you
  31. * want to exclude those values.
  32. *
  33. * The undefined value can be expressed using the "0:0" string.
  34. *
  35. * @param[in,out] q pointer to the AVRational which will contain the ratio
  36. * @param[in] str the string to parse: it has to be a string in the format
  37. * num:den, a float number or an expression
  38. * @param[in] max the maximum allowed numerator and denominator
  39. * @param[in] log_offset log level offset which is applied to the log
  40. * level of log_ctx
  41. * @param[in] log_ctx parent logging context
  42. * @return >= 0 on success, a negative error code otherwise
  43. */
  44. int av_parse_ratio(AVRational *q, const char *str, int max,
  45. int log_offset, void *log_ctx);
  46. #define av_parse_ratio_quiet(rate, str, max) \
  47. av_parse_ratio(rate, str, max, AV_LOG_MAX_OFFSET, NULL)
  48. /**
  49. * Parse str and put in width_ptr and height_ptr the detected values.
  50. *
  51. * @param[in,out] width_ptr pointer to the variable which will contain the detected
  52. * width value
  53. * @param[in,out] height_ptr pointer to the variable which will contain the detected
  54. * height value
  55. * @param[in] str the string to parse: it has to be a string in the format
  56. * width x height or a valid video size abbreviation.
  57. * @return >= 0 on success, a negative error code otherwise
  58. */
  59. int av_parse_video_size(int *width_ptr, int *height_ptr, const char *str);
  60. /**
  61. * Parse str and store the detected values in *rate.
  62. *
  63. * @param[in,out] rate pointer to the AVRational which will contain the detected
  64. * frame rate
  65. * @param[in] str the string to parse: it has to be a string in the format
  66. * rate_num / rate_den, a float number or a valid video rate abbreviation
  67. * @return >= 0 on success, a negative error code otherwise
  68. */
  69. int av_parse_video_rate(AVRational *rate, const char *str);
  70. /**
  71. * Put the RGBA values that correspond to color_string in rgba_color.
  72. *
  73. * @param color_string a string specifying a color. It can be the name of
  74. * a color (case insensitive match) or a [0x|#]RRGGBB[AA] sequence,
  75. * possibly followed by "@" and a string representing the alpha
  76. * component.
  77. * The alpha component may be a string composed by "0x" followed by an
  78. * hexadecimal number or a decimal number between 0.0 and 1.0, which
  79. * represents the opacity value (0x00/0.0 means completely transparent,
  80. * 0xff/1.0 completely opaque).
  81. * If the alpha component is not specified then 0xff is assumed.
  82. * The string "random" will result in a random color.
  83. * @param slen length of the initial part of color_string containing the
  84. * color. It can be set to -1 if color_string is a null terminated string
  85. * containing nothing else than the color.
  86. * @return >= 0 in case of success, a negative value in case of
  87. * failure (for example if color_string cannot be parsed).
  88. */
  89. int av_parse_color(uint8_t *rgba_color, const char *color_string, int slen,
  90. void *log_ctx);
  91. /**
  92. * Get the name of a color from the internal table of hard-coded named
  93. * colors.
  94. *
  95. * This function is meant to enumerate the color names recognized by
  96. * av_parse_color().
  97. *
  98. * @param color_idx index of the requested color, starting from 0
  99. * @param rgbp if not NULL, will point to a 3-elements array with the color value in RGB
  100. * @return the color name string or NULL if color_idx is not in the array
  101. */
  102. const char *av_get_known_color_name(int color_idx, const uint8_t **rgb);
  103. /**
  104. * Parse timestr and return in *time a corresponding number of
  105. * microseconds.
  106. *
  107. * @param timeval puts here the number of microseconds corresponding
  108. * to the string in timestr. If the string represents a duration, it
  109. * is the number of microseconds contained in the time interval. If
  110. * the string is a date, is the number of microseconds since 1st of
  111. * January, 1970 up to the time of the parsed date. If timestr cannot
  112. * be successfully parsed, set *time to INT64_MIN.
  113. * @param timestr a string representing a date or a duration.
  114. * - If a date the syntax is:
  115. * @code
  116. * [{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH:MM:SS[.m...]]]}|{HHMMSS[.m...]]]}}[Z]
  117. * now
  118. * @endcode
  119. * If the value is "now" it takes the current time.
  120. * Time is local time unless Z is appended, in which case it is
  121. * interpreted as UTC.
  122. * If the year-month-day part is not specified it takes the current
  123. * year-month-day.
  124. * - If a duration the syntax is:
  125. * @code
  126. * [-][HH:]MM:SS[.m...]
  127. * [-]S+[.m...]
  128. * @endcode
  129. * @param duration flag which tells how to interpret timestr, if not
  130. * zero timestr is interpreted as a duration, otherwise as a date
  131. * @return >= 0 in case of success, a negative value corresponding to an
  132. * AVERROR code otherwise
  133. */
  134. int av_parse_time(int64_t *timeval, const char *timestr, int duration);
  135. /**
  136. * Attempt to find a specific tag in a URL.
  137. *
  138. * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
  139. * Return 1 if found.
  140. */
  141. int av_find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
  142. /**
  143. * Simplified version of strptime
  144. *
  145. * Parse the input string p according to the format string fmt and
  146. * store its results in the structure dt.
  147. * This implementation supports only a subset of the formats supported
  148. * by the standard strptime().
  149. *
  150. * The supported input field descriptors are listed below.
  151. * - %H: the hour as a decimal number, using a 24-hour clock, in the
  152. * range '00' through '23'
  153. * - %J: hours as a decimal number, in the range '0' through INT_MAX
  154. * - %M: the minute as a decimal number, using a 24-hour clock, in the
  155. * range '00' through '59'
  156. * - %S: the second as a decimal number, using a 24-hour clock, in the
  157. * range '00' through '59'
  158. * - %Y: the year as a decimal number, using the Gregorian calendar
  159. * - %m: the month as a decimal number, in the range '1' through '12'
  160. * - %d: the day of the month as a decimal number, in the range '1'
  161. * through '31'
  162. * - %T: alias for '%H:%M:%S'
  163. * - %%: a literal '%'
  164. *
  165. * @return a pointer to the first character not processed in this function
  166. * call. In case the input string contains more characters than
  167. * required by the format string the return value points right after
  168. * the last consumed input character. In case the whole input string
  169. * is consumed the return value points to the null byte at the end of
  170. * the string. On failure NULL is returned.
  171. */
  172. char *av_small_strptime(const char *p, const char *fmt, struct tm *dt);
  173. /**
  174. * Convert the decomposed UTC time in tm to a time_t value.
  175. */
  176. time_t av_timegm(struct tm *tm);
  177. #endif /* AVUTIL_PARSEUTILS_H */