git.sesse.net Git - casparcg/blob - dependencies/ffmpeg/include/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 /**
  35  * @addtogroup lavu_dict AVDictionary
  36  * @ingroup lavu_data
  37  *
  38  * @brief Simple key:value store
  39  *
  40  * @{
  41  * Dictionaries are used for storing key:value pairs. To create
  42  * an AVDictionary, simply pass an address of a NULL pointer to
  43  * av_dict_set(). NULL can be used as an empty dictionary wherever
  44  * a pointer to an AVDictionary is required.
  45  * Use av_dict_get() to retrieve an entry or iterate over all
  46  * entries and finally av_dict_free() to free the dictionary
  47  * and all its contents.
  48  *
  49  * @code
  50  * AVDictionary *d = NULL;                // "create" an empty dictionary
  51  * av_dict_set(&d, "foo", "bar", 0);      // add an entry
  52  *
  53  * char *k = av_strdup("key");            // if your strings are already allocated,
  54  * char *v = av_strdup("value");          // you can avoid copying them like this
  55  * av_dict_set(&d, k, v, AV_DICT_DONT_STRDUP_KEY | AV_DICT_DONT_STRDUP_VAL);
  56  *
  57  * AVDictionaryEntry *t = NULL;
  58  * while (t = av_dict_get(d, "", t, AV_DICT_IGNORE_SUFFIX)) {
  59  *     <....>                             // iterate over all entries in d
  60  * }
  61  *
  62  * av_dict_free(&d);
  63  * @endcode
  64  *
  65  */
  66
  67 #define AV_DICT_MATCH_CASE      1   /**< Only get an entry with exact-case key match. Only relevant in av_dict_get(). */
  68 #define AV_DICT_IGNORE_SUFFIX   2   /**< Return first entry in a dictionary whose first part corresponds to the search key,
  69                                          ignoring the suffix of the found key string. Only relevant in av_dict_get(). */
  70 #define AV_DICT_DONT_STRDUP_KEY 4   /**< Take ownership of a key that's been
  71                                          allocated with av_malloc() or another memory allocation function. */
  72 #define AV_DICT_DONT_STRDUP_VAL 8   /**< Take ownership of a value that's been
  73                                          allocated with av_malloc() or another memory allocation function. */
  74 #define AV_DICT_DONT_OVERWRITE 16   ///< Don't overwrite existing entries.
  75 #define AV_DICT_APPEND         32   /**< If the entry already exists, append to it.  Note that no
  76                                       delimiter is added, the strings are simply concatenated. */
  77
  78 typedef struct AVDictionaryEntry {
  79     char *key;
  80     char *value;
  81 } AVDictionaryEntry;
  82
  83 typedef struct AVDictionary AVDictionary;
  84
  85 /**
  86  * Get a dictionary entry with matching key.
  87  *
  88  * To iterate through all the dictionary entries, you can set the matching key
  89  * to the null string "" and set the AV_DICT_IGNORE_SUFFIX flag.
  90  *
  91  * @param prev Set to the previous matching element to find the next.
  92  *             If set to NULL the first matching element is returned.
  93  * @param key matching key
  94  * @param flags Allows case as well as suffix-insensitive comparisons.
  95  * @return Found entry or NULL, changing key or value leads to undefined behavior.
  96  */
  97 AVDictionaryEntry *
  98 av_dict_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags);
  99
 100 /**
 101  * Get number of entries in dictionary.
 102  *
 103  * @param m dictionary
 104  * @return  number of entries in dictionary
 105  */
 106 int av_dict_count(const AVDictionary *m);
 107
 108 /**
 109  * Set the given entry in *pm, overwriting an existing entry.
 110  *
 111  * @param pm pointer to a pointer to a dictionary struct. If *pm is NULL
 112  * a dictionary struct is allocated and put in *pm.
 113  * @param key entry key to add to *pm (will be av_strduped depending on flags)
 114  * @param value entry value to add to *pm (will be av_strduped depending on flags).
 115  *        Passing a NULL value will cause an existing entry to be deleted.
 116  * @return >= 0 on success otherwise an error code <0
 117  */
 118 int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags);
 119
 120 /**
 121  * Parse the key/value pairs list and add the parsed entries to a dictionary.
 122  *
 123  * In case of failure, all the successfully set entries are stored in
 124  * *pm. You may need to manually free the created dictionary.
 125  *
 126  * @param key_val_sep  a 0-terminated list of characters used to separate
 127  *                     key from value
 128  * @param pairs_sep    a 0-terminated list of characters used to separate
 129  *                     two pairs from each other
 130  * @param flags        flags to use when adding to dictionary.
 131  *                     AV_DICT_DONT_STRDUP_KEY and AV_DICT_DONT_STRDUP_VAL
 132  *                     are ignored since the key/value tokens will always
 133  *                     be duplicated.
 134  * @return             0 on success, negative AVERROR code on failure
 135  */
 136 int av_dict_parse_string(AVDictionary **pm, const char *str,
 137                          const char *key_val_sep, const char *pairs_sep,
 138                          int flags);
 139
 140 /**
 141  * Copy entries from one AVDictionary struct into another.
 142  * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,
 143  *            this function will allocate a struct for you and put it in *dst
 144  * @param src pointer to source AVDictionary struct
 145  * @param flags flags to use when setting entries in *dst
 146  * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag
 147  */
 148 void av_dict_copy(AVDictionary **dst, AVDictionary *src, int flags);
 149
 150 /**
 151  * Free all the memory allocated for an AVDictionary struct
 152  * and all keys and values.
 153  */
 154 void av_dict_free(AVDictionary **m);
 155
 156 /**
 157  * @}
 158  */
 159
 160 #endif /* AVUTIL_DICT_H */