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  }
102  if (!(flags & AV_DICT_MULTIKEY)) {
103  tag = av_dict_get(m, key, NULL, flags);
104  }
106  copy_key = (void *)key;
107  else
108  copy_key = av_strdup(key);
109  if (!m)
110  m = *pm = av_mallocz(sizeof(*m));
111  if (!m || !copy_key || (value && !copy_value))
112  goto enomem;
113 
114  if (tag) {
116  av_free(copy_key);
117  av_free(copy_value);
118  return 0;
119  }
120  if (copy_value && flags & AV_DICT_APPEND) {
121  size_t oldlen = strlen(tag->value);
122  size_t new_part_len = strlen(copy_value);
123  size_t len = oldlen + new_part_len + 1;
124  char *newval = av_realloc(tag->value, len);
125  if (!newval)
126  goto enomem;
127  memcpy(newval + oldlen, copy_value, new_part_len + 1);
128  av_freep(&copy_value);
129  copy_value = newval;
130  } else
131  av_free(tag->value);
132  av_free(tag->key);
133  *tag = m->elems[--m->count];
134  } else if (copy_value) {
136  m->count + 1, sizeof(*m->elems));
137  if (!tmp)
138  goto enomem;
139  m->elems = tmp;
140  }
141  if (copy_value) {
142  m->elems[m->count].key = copy_key;
143  m->elems[m->count].value = copy_value;
144  m->count++;
145  } else {
146  err = 0;
147  goto end;
148  }
149 
150  return 0;
151 
152 enomem:
153  err = AVERROR(ENOMEM);
154 err_out:
155  av_free(copy_value);
156 end:
157  if (m && !m->count) {
158  av_freep(&m->elems);
159  av_freep(pm);
160  }
161  av_free(copy_key);
162  return err;
163 }
164 
166  int flags)
167 {
168  char valuestr[22];
169  snprintf(valuestr, sizeof(valuestr), "%"PRId64, value);
171  return av_dict_set(pm, key, valuestr, flags);
172 }
173 
174 static int parse_key_value_pair(AVDictionary **pm, const char **buf,
175  const char *key_val_sep, const char *pairs_sep,
176  int flags)
177 {
178  char *key = av_get_token(buf, key_val_sep);
179  char *val = NULL;
180  int ret;
181 
182  if (key && *key && strspn(*buf, key_val_sep)) {
183  (*buf)++;
184  val = av_get_token(buf, pairs_sep);
185  }
186 
187  if (key && *key && val && *val)
188  ret = av_dict_set(pm, key, val, flags);
189  else
190  ret = AVERROR(EINVAL);
191 
192  av_freep(&key);
193  av_freep(&val);
194 
195  return ret;
196 }
197 
198 int av_dict_parse_string(AVDictionary **pm, const char *str,
199  const char *key_val_sep, const char *pairs_sep,
200  int flags)
201 {
202  int ret;
203 
204  if (!str)
205  return 0;
206 
207  /* ignore STRDUP flags */
209 
210  while (*str) {
211  if ((ret = parse_key_value_pair(pm, &str, key_val_sep, pairs_sep, flags)) < 0)
212  return ret;
213 
214  if (*str)
215  str++;
216  }
217 
218  return 0;
219 }
220 
222 {
223  AVDictionary *m = *pm;
224 
225  if (m) {
226  while (m->count--) {
227  av_freep(&m->elems[m->count].key);
228  av_freep(&m->elems[m->count].value);
229  }
230  av_freep(&m->elems);
231  }
232  av_freep(pm);
233 }
234 
236 {
237  const AVDictionaryEntry *t = NULL;
238 
239  while ((t = av_dict_iterate(src, t))) {
240  int ret = av_dict_set(dst, t->key, t->value, flags);
241  if (ret < 0)
242  return ret;
243  }
244 
245  return 0;
246 }
247 
249  const char key_val_sep, const char pairs_sep)
250 {
251  const AVDictionaryEntry *t = NULL;
252  AVBPrint bprint;
253  int cnt = 0;
254  char special_chars[] = {pairs_sep, key_val_sep, '\0'};
255 
256  if (!buffer || pairs_sep == '\0' || key_val_sep == '\0' || pairs_sep == key_val_sep ||
257  pairs_sep == '\\' || key_val_sep == '\\')
258  return AVERROR(EINVAL);
259 
260  if (!av_dict_count(m)) {
261  *buffer = av_strdup("");
262  return *buffer ? 0 : AVERROR(ENOMEM);
263  }
264 
266  while ((t = av_dict_iterate(m, t))) {
267  if (cnt++)
268  av_bprint_append_data(&bprint, &pairs_sep, 1);
269  av_bprint_escape(&bprint, t->key, special_chars, AV_ESCAPE_MODE_BACKSLASH, 0);
270  av_bprint_append_data(&bprint, &key_val_sep, 1);
271  av_bprint_escape(&bprint, t->value, special_chars, AV_ESCAPE_MODE_BACKSLASH, 0);
272  }
273  return av_bprint_finalize(&bprint, buffer);
274 }
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
tmp
static uint8_t tmp[11]
Definition: aes_ctr.c:28
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:90
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
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_free
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values.
Definition: dict.c:221
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:174
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:198
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:165
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:89
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:248
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:235
AV_ESCAPE_MODE_BACKSLASH
@ AV_ESCAPE_MODE_BACKSLASH
Use backslash escaping.
Definition: avstring.h:316
AVDictionaryEntry::value
char * value
Definition: dict.h:91
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