FFmpeg
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
dict.c
Go to the documentation of this file.
1 /*
2  * copyright (c) 2009 Michael Niedermayer
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #include <inttypes.h>
22 #include <stdio.h>
23 #include <string.h>
24 
25 #include "avassert.h"
26 #include "avstring.h"
27 #include "dict.h"
28 #include "error.h"
29 #include "mem.h"
30 #include "bprint.h"
31 
32 struct AVDictionary {
33  int count;
35 };
36 
38 {
39  return m ? m->count : 0;
40 }
41 
43  const AVDictionaryEntry *prev)
44 {
45  int i = 0;
46 
47  if (!m)
48  return NULL;
49 
50  if (prev)
51  i = prev - m->elems + 1;
52 
53  av_assert2(i >= 0);
54  if (i >= m->count)
55  return NULL;
56 
57  return &m->elems[i];
58 }
59 
61  const AVDictionaryEntry *prev, int flags)
62 {
63  const AVDictionaryEntry *entry = prev;
64  unsigned int j;
65 
66  if (!key)
67  return NULL;
68 
69  while ((entry = av_dict_iterate(m, entry))) {
70  const char *s = entry->key;
72  for (j = 0; s[j] == key[j] && key[j]; j++)
73  ;
74  else
75  for (j = 0; av_toupper(s[j]) == av_toupper(key[j]) && key[j]; j++)
76  ;
77  if (key[j])
78  continue;
79  if (s[j] && !(flags & AV_DICT_IGNORE_SUFFIX))
80  continue;
81  return (AVDictionaryEntry *)entry;
82  }
83  return NULL;
84 }
85 
86 int av_dict_set(AVDictionary **pm, const char *key, const char *value,
87  int flags)
88 {
89  AVDictionary *m = *pm;
91  char *copy_key = NULL, *copy_value = NULL;
92  int err;
93 
95  copy_value = (void *)value;
96  else if (value)
97  copy_value = av_strdup(value);
98  if (!key) {
99  err = AVERROR(EINVAL);
100  goto err_out;
101  }
103  copy_key = (void *)key;
104  else
105  copy_key = av_strdup(key);
106  if (!copy_key || (value && !copy_value))
107  goto enomem;
108 
109  if (!(flags & AV_DICT_MULTIKEY)) {
110  tag = av_dict_get(m, key, NULL, flags);
111  } else if (flags & AV_DICT_DEDUP) {
112  while ((tag = av_dict_get(m, key, tag, flags))) {
113  if ((!value && !tag->value) ||
114  (value && tag->value && !strcmp(value, tag->value))) {
115  av_free(copy_key);
116  av_free(copy_value);
117  return 0;
118  }
119  }
120  }
121  if (!m)
122  m = *pm = av_mallocz(sizeof(*m));
123  if (!m)
124  goto enomem;
125 
126  if (tag) {
128  av_free(copy_key);
129  av_free(copy_value);
130  return 0;
131  }
132  if (copy_value && flags & AV_DICT_APPEND) {
133  size_t oldlen = strlen(tag->value);
134  size_t new_part_len = strlen(copy_value);
135  size_t len = oldlen + new_part_len + 1;
136  char *newval = av_realloc(tag->value, len);
137  if (!newval)
138  goto enomem;
139  memcpy(newval + oldlen, copy_value, new_part_len + 1);
140  av_freep(&copy_value);
141  copy_value = newval;
142  } else
143  av_free(tag->value);
144  av_free(tag->key);
145  *tag = m->elems[--m->count];
146  } else if (copy_value) {
148  m->count + 1, sizeof(*m->elems));
149  if (!tmp)
150  goto enomem;
151  m->elems = tmp;
152  }
153  if (copy_value) {
154  m->elems[m->count].key = copy_key;
155  m->elems[m->count].value = copy_value;
156  m->count++;
157  } else {
158  err = 0;
159  goto end;
160  }
161 
162  return 0;
163 
164 enomem:
165  err = AVERROR(ENOMEM);
166 err_out:
167  av_free(copy_value);
168 end:
169  if (m && !m->count) {
170  av_freep(&m->elems);
171  av_freep(pm);
172  }
173  av_free(copy_key);
174  return err;
175 }
176 
178  int flags)
179 {
180  char valuestr[22];
181  snprintf(valuestr, sizeof(valuestr), "%"PRId64, value);
183  return av_dict_set(pm, key, valuestr, flags);
184 }
185 
186 static int parse_key_value_pair(AVDictionary **pm, const char **buf,
187  const char *key_val_sep, const char *pairs_sep,
188  int flags)
189 {
190  char *key = av_get_token(buf, key_val_sep);
191  char *val = NULL;
192  int ret;
193 
194  if (key && *key && strspn(*buf, key_val_sep)) {
195  (*buf)++;
196  val = av_get_token(buf, pairs_sep);
197  }
198 
199  if (key && *key && val && *val)
200  ret = av_dict_set(pm, key, val, flags);
201  else
202  ret = AVERROR(EINVAL);
203 
204  av_freep(&key);
205  av_freep(&val);
206 
207  return ret;
208 }
209 
210 int av_dict_parse_string(AVDictionary **pm, const char *str,
211  const char *key_val_sep, const char *pairs_sep,
212  int flags)
213 {
214  int ret;
215 
216  if (!str)
217  return 0;
218 
219  /* ignore STRDUP flags */
221 
222  while (*str) {
223  if ((ret = parse_key_value_pair(pm, &str, key_val_sep, pairs_sep, flags)) < 0)
224  return ret;
225 
226  if (*str)
227  str++;
228  }
229 
230  return 0;
231 }
232 
234 {
235  AVDictionary *m = *pm;
236 
237  if (m) {
238  while (m->count--) {
239  av_freep(&m->elems[m->count].key);
240  av_freep(&m->elems[m->count].value);
241  }
242  av_freep(&m->elems);
243  }
244  av_freep(pm);
245 }
246 
248 {
249  const AVDictionaryEntry *t = NULL;
250 
251  while ((t = av_dict_iterate(src, t))) {
252  int ret = av_dict_set(dst, t->key, t->value, flags);
253  if (ret < 0)
254  return ret;
255  }
256 
257  return 0;
258 }
259 
261  const char key_val_sep, const char pairs_sep)
262 {
263  const AVDictionaryEntry *t = NULL;
264  AVBPrint bprint;
265  int cnt = 0;
266  char special_chars[] = {pairs_sep, key_val_sep, '\0'};
267 
268  if (!buffer || pairs_sep == '\0' || key_val_sep == '\0' || pairs_sep == key_val_sep ||
269  pairs_sep == '\\' || key_val_sep == '\\')
270  return AVERROR(EINVAL);
271 
272  if (!av_dict_count(m)) {
273  *buffer = av_strdup("");
274  return *buffer ? 0 : AVERROR(ENOMEM);
275  }
276 
278  while ((t = av_dict_iterate(m, t))) {
279  if (cnt++)
280  av_bprint_append_data(&bprint, &pairs_sep, 1);
281  av_bprint_escape(&bprint, t->key, special_chars, AV_ESCAPE_MODE_BACKSLASH, 0);
282  av_bprint_append_data(&bprint, &key_val_sep, 1);
283  av_bprint_escape(&bprint, t->value, special_chars, AV_ESCAPE_MODE_BACKSLASH, 0);
284  }
285  return av_bprint_finalize(&bprint, buffer);
286 }
flags
const SwsFlags flags[]
Definition: swscale.c:61
AV_BPRINT_SIZE_UNLIMITED
#define AV_BPRINT_SIZE_UNLIMITED
entry
#define entry
Definition: aom_film_grain_template.c:66
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
av_bprint_init
void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max)
Definition: bprint.c:69
av_dict_count
int av_dict_count(const AVDictionary *m)
Get number of entries in dictionary.
Definition: dict.c:37
int64_t
long long int64_t
Definition: coverity.c:34
AVDictionary::elems
AVDictionaryEntry * elems
Definition: dict.c:34
AV_DICT_APPEND
#define AV_DICT_APPEND
If the entry already exists, append to it.
Definition: dict.h:82
AV_DICT_IGNORE_SUFFIX
#define AV_DICT_IGNORE_SUFFIX
Return first entry in a dictionary whose first part corresponds to the search key,...
Definition: dict.h:75
AVDictionary
Definition: dict.c:32
val
static double val(void *priv, double ch)
Definition: aeval.c:77
AV_DICT_DONT_STRDUP_VAL
#define AV_DICT_DONT_STRDUP_VAL
Take ownership of a value that's been allocated with av_malloc() or another memory allocation functio...
Definition: dict.h:79
avassert.h
av_dict_get
AVDictionaryEntry * av_dict_get(const AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags)
Get a dictionary entry with matching key.
Definition: dict.c:60
s
#define s(width, name)
Definition: cbs_vp9.c:198
av_realloc_array
void * av_realloc_array(void *ptr, size_t nmemb, size_t size)
Definition: mem.c:217
AVDictionaryEntry::key
char * key
Definition: dict.h:91
key
const char * key
Definition: hwcontext_opencl.c:189
AVDictionary::count
int count
Definition: dict.c:33
NULL
#define NULL
Definition: coverity.c:32
AV_DICT_MULTIKEY
#define AV_DICT_MULTIKEY
Allow to store several equal keys in the dictionary.
Definition: dict.h:84
tmp
static uint8_t tmp[20]
Definition: aes_ctr.c:47
av_bprint_escape
void av_bprint_escape(AVBPrint *dstbuf, const char *src, const char *special_chars, enum AVEscapeMode mode, int flags)
Escape the content in src and append it to dstbuf.
Definition: bprint.c:268
AV_DICT_DONT_OVERWRITE
#define AV_DICT_DONT_OVERWRITE
Don't overwrite existing entries.
Definition: dict.h:81
error.h
av_bprint_finalize
int av_bprint_finalize(AVBPrint *buf, char **ret_str)
Finalize a print buffer.
Definition: bprint.c:240
dst
uint8_t ptrdiff_t const uint8_t ptrdiff_t int intptr_t intptr_t int int16_t * dst
Definition: dsp.h:83
AV_DICT_DEDUP
#define AV_DICT_DEDUP
If inserting a value that already exists for a key, do nothing.
Definition: dict.h:85
av_dict_free
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values.
Definition: dict.c:233
av_assert2
#define av_assert2(cond)
assert() equivalent, that does lie in speed critical code.
Definition: avassert.h:67
bprint.h
parse_key_value_pair
static int parse_key_value_pair(AVDictionary **pm, const char **buf, const char *key_val_sep, const char *pairs_sep, int flags)
Definition: dict.c:186
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
value
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default value
Definition: writing_filters.txt:86
av_toupper
static av_const int av_toupper(int c)
Locale-independent conversion of ASCII characters to uppercase.
Definition: avstring.h:227
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:256
len
int len
Definition: vorbis_enc_data.h:426
tag
uint32_t tag
Definition: movenc.c:1911
ret
ret
Definition: filter_design.txt:187
dict.h
AV_DICT_MATCH_CASE
#define AV_DICT_MATCH_CASE
Only get an entry with exact-case key match.
Definition: dict.h:74
buffer
the frame and frame reference mechanism is intended to as much as expensive copies of that data while still allowing the filters to produce correct results The data is stored in buffers represented by AVFrame structures Several references can point to the same frame buffer
Definition: filter_design.txt:49
av_get_token
char * av_get_token(const char **buf, const char *term)
Unescape the given string until a non escaped terminating char, and return the token corresponding to...
Definition: avstring.c:143
av_dict_parse_string
int av_dict_parse_string(AVDictionary **pm, const char *str, const char *key_val_sep, const char *pairs_sep, int flags)
Parse the key/value pairs list and add the parsed entries to a dictionary.
Definition: dict.c:210
av_dict_set_int
int av_dict_set_int(AVDictionary **pm, const char *key, int64_t value, int flags)
Convenience wrapper for av_dict_set() that converts the value to a string and stores it.
Definition: dict.c:177
av_strdup
char * av_strdup(const char *s)
Duplicate a string.
Definition: mem.c:272
mem.h
av_free
#define av_free(p)
Definition: tableprint_vlc.h:34
AVDictionaryEntry
Definition: dict.h:90
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
av_dict_set
int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)
Set the given entry in *pm, overwriting an existing entry.
Definition: dict.c:86
av_dict_get_string
int av_dict_get_string(const AVDictionary *m, char **buffer, const char key_val_sep, const char pairs_sep)
Get dictionary entries as a string.
Definition: dict.c:260
av_dict_copy
int av_dict_copy(AVDictionary **dst, const AVDictionary *src, int flags)
Copy entries from one AVDictionary struct into another.
Definition: dict.c:247
AV_ESCAPE_MODE_BACKSLASH
@ AV_ESCAPE_MODE_BACKSLASH
Use backslash escaping.
Definition: avstring.h:316
AVDictionaryEntry::value
char * value
Definition: dict.h:92
avstring.h
av_bprint_append_data
void av_bprint_append_data(AVBPrint *buf, const char *data, unsigned size)
Append data to a print buffer.
Definition: bprint.c:163
snprintf
#define snprintf
Definition: snprintf.h:34
av_dict_iterate
const AVDictionaryEntry * av_dict_iterate(const AVDictionary *m, const AVDictionaryEntry *prev)
Iterate over a dictionary.
Definition: dict.c:42
src
#define src
Definition: vp8dsp.c:248
AV_DICT_DONT_STRDUP_KEY
#define AV_DICT_DONT_STRDUP_KEY
Take ownership of a key that's been allocated with av_malloc() or another memory allocation function.
Definition: dict.h:77
av_realloc
void * av_realloc(void *ptr, size_t size)
Allocate, reallocate, or free a block of memory.
Definition: mem.c:155