Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavutil / dict.h
1 /*
2  *
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  * Public dictionary API.
23  * @deprecated
24  *  AVDictionary is provided for compatibility with libav. It is both in
25  *  implementation as well as API inefficient. It does not scale and is
26  *  extremely slow with large dictionaries.
27  *  It is recommended that new code uses our tree container from tree.c/h
28  *  where applicable, which uses AVL trees to achieve O(log n) performance.
29  */
30
31 #ifndef AVUTIL_DICT_H
32 #define AVUTIL_DICT_H
33
34 #define AV_DICT_MATCH_CASE      1
35 #define AV_DICT_IGNORE_SUFFIX   2
36 #define AV_DICT_DONT_STRDUP_KEY 4
37 #define AV_DICT_DONT_STRDUP_VAL 8
38 #define AV_DICT_DONT_OVERWRITE 16   ///< Don't overwrite existing entries.
39 #define AV_DICT_APPEND         32   /**< If the entry already exists, append to it.  Note that no
40                                       delimiter is added, the strings are simply concatenated. */
41
42 typedef struct {
43     char *key;
44     char *value;
45 } AVDictionaryEntry;
46
47 typedef struct AVDictionary AVDictionary;
48
49 /**
50  * Get a dictionary entry with matching key.
51  *
52  * @param prev Set to the previous matching element to find the next.
53  *             If set to NULL the first matching element is returned.
54  * @param flags Allows case as well as suffix-insensitive comparisons.
55  * @return Found entry or NULL, changing key or value leads to undefined behavior.
56  */
57 AVDictionaryEntry *
58 av_dict_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags);
59
60 /**
61  * Set the given entry in *pm, overwriting an existing entry.
62  *
63  * @param pm pointer to a pointer to a dictionary struct. If *pm is NULL
64  * a dictionary struct is allocated and put in *pm.
65  * @param key entry key to add to *pm (will be av_strduped depending on flags)
66  * @param value entry value to add to *pm (will be av_strduped depending on flags).
67  *        Passing a NULL value will cause an existing tag to be deleted.
68  * @return >= 0 on success otherwise an error code <0
69  */
70 int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags);
71
72 /**
73  * Copy entries from one AVDictionary struct into another.
74  * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,
75  *            this function will allocate a struct for you and put it in *dst
76  * @param src pointer to source AVDictionary struct
77  * @param flags flags to use when setting entries in *dst
78  * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag
79  */
80 void av_dict_copy(AVDictionary **dst, AVDictionary *src, int flags);
81
82 /**
83  * Free all the memory allocated for an AVDictionary struct.
84  */
85 void av_dict_free(AVDictionary **m);
86
87 #endif // AVUTIL_DICT_H