git.sesse.net Git - ffmpeg/blob - libavcore/parseutils.h

   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
  19 #ifndef AVCORE_PARSEUTILS_H
  20 #define AVCORE_PARSEUTILS_H
  21
  22 #include "libavutil/rational.h"
  23
  24 /**
  25  * @file
  26  * misc parsing utilities for libavcore
  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 #endif /* AVCORE_PARSEUTILS_H */