Statistics
| Branch: | Revision:

ffmpeg / libavfilter / parseutils.h @ 6ed04040

History | View | Annotate | Download (3.16 KB)

1
/*
2
 * copyright (c) 2009 Stefano Sabatini
3
 * This file is part of FFmpeg.
4
 *
5
 * FFmpeg is free software; you can redistribute it and/or
6
 * modify it under the terms of the GNU Lesser General Public
7
 * License as published by the Free Software Foundation; either
8
 * version 2.1 of the License, or (at your option) any later version.
9
 *
10
 * FFmpeg is distributed in the hope that it will be useful,
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13
 * Lesser General Public License for more details.
14
 *
15
 * You should have received a copy of the GNU Lesser General Public
16
 * License along with FFmpeg; if not, write to the Free Software
17
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
 */
19

    
20
/**
21
 * @file
22
 * parsing utils
23
 */
24

    
25
#ifndef AVFILTER_PARSEUTILS_H
26
#define AVFILTER_PARSEUTILS_H
27

    
28
#include "libavutil/opt.h"
29

    
30
/**
31
 * Unescape the given string until a non escaped terminating char,
32
 * and return the token corresponding to the unescaped string.
33
 *
34
 * The normal \ and ' escaping is supported. Leading and trailing
35
 * whitespaces are removed.
36
 *
37
 * @param buf the buffer to parse, buf will be updated to point to the
38
 * terminating char
39
 * @param term a 0-terminated list of terminating chars
40
 * @return the malloced unescaped string, which must be av_freed by
41
 * the user, NULL in case of allocation failure
42
 */
43
char *av_get_token(const char **buf, const char *term);
44

    
45
/**
46
 * Put the RGBA values that correspond to color_string in rgba_color.
47
 *
48
 * @param color_string a string specifying a color. It can be the name of
49
 * a color (case insensitive match) or a 0xRRGGBB[AA] sequence,
50
 * possibly followed by "@" and a string representing the alpha
51
 * component.
52
 * The alpha component may be a string composed by "0x" followed by an
53
 * hexadecimal number or a base-10 number between 0 and 255, or a
54
 * decimal number between 0.0 and 1.0, which represents the opacity
55
 * value (0/0x00/0.0 means completely transparent, 255/0xff/1.0
56
 * completely opaque).
57
 * If the alpha component is not specified then 255 is assumed.
58
 * The string "random" will result in a random color.
59
 * @return >= 0 in case of success, a negative value in case of
60
 * failure (for example if color_string cannot be parsed).
61
 */
62
int av_parse_color(uint8_t *rgba_color, const char *color_string, void *log_ctx);
63

    
64
/**
65
 * Parse the key/value pairs list in opts. For each key/value pair
66
 * found, stores the value in the field in ctx that is named like the
67
 * key. ctx must be an AVClass context, storing is done using
68
 * AVOptions.
69
 *
70
 * @param key_val_sep a 0-terminated list of characters used to
71
 * separate key from value
72
 * @param pairs_sep a 0-terminated list of characters used to separate
73
 * two pairs from each other
74
 * @return the number of successfully set key/value pairs, or a negative
75
 * value corresponding to an AVERROR code in case of error:
76
 * AVERROR(EINVAL) if opts cannot be parsed,
77
 * the error code issued by av_set_string3() if a key/value pair
78
 * cannot be set
79
 */
80
int av_set_options_string(void *ctx, const char *opts,
81
                          const char *key_val_sep, const char *pairs_sep);
82

    
83
#endif  /* AVFILTER_PARSEUTILS_H */