Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
showbox-public / ffmpeg-doc deb
Repository URL to install this package:
|
Version:
7:2.7.1-1ubuntu2 ▾
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FFmpeg: libavutil/dict.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FFmpeg
 <span id="projectnumber">2.7.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">libavutil/dict.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="dict_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> *</span>
<a name="l00003"></a>00003 <span class="comment"> * This file is part of FFmpeg.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * FFmpeg is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00007"></a>00007 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * FFmpeg is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00016"></a>00016 <span class="comment"> * License along with FFmpeg; if not, write to the Free Software</span>
<a name="l00017"></a>00017 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00018"></a>00018 <span class="comment"> */</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">/**</span>
<a name="l00021"></a>00021 <span class="comment"> * @file</span>
<a name="l00022"></a>00022 <span class="comment"> * Public dictionary API.</span>
<a name="l00023"></a>00023 <span class="comment"> * @deprecated</span>
<a name="l00024"></a>00024 <span class="comment"> * AVDictionary is provided for compatibility with libav. It is both in</span>
<a name="l00025"></a>00025 <span class="comment"> * implementation as well as API inefficient. It does not scale and is</span>
<a name="l00026"></a>00026 <span class="comment"> * extremely slow with large dictionaries.</span>
<a name="l00027"></a>00027 <span class="comment"> * It is recommended that new code uses our tree container from tree.c/h</span>
<a name="l00028"></a>00028 <span class="comment"> * where applicable, which uses AVL trees to achieve O(log n) performance.</span>
<a name="l00029"></a>00029 <span class="comment"> */</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#ifndef AVUTIL_DICT_H</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define AVUTIL_DICT_H</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <stdint.h></span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="preprocessor">#include "<a class="code" href="libavutil_2version_8h.html" title="Libavutil version macros.">version.h</a>"</span>
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/**</span>
<a name="l00039"></a>00039 <span class="comment"> * @addtogroup lavu_dict AVDictionary</span>
<a name="l00040"></a>00040 <span class="comment"> * @ingroup lavu_data</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> * @brief Simple key:value store</span>
<a name="l00043"></a>00043 <span class="comment"> *</span>
<a name="l00044"></a>00044 <span class="comment"> * @{</span>
<a name="l00045"></a>00045 <span class="comment"> * Dictionaries are used for storing key:value pairs. To create</span>
<a name="l00046"></a>00046 <span class="comment"> * an AVDictionary, simply pass an address of a NULL pointer to</span>
<a name="l00047"></a>00047 <span class="comment"> * av_dict_set(). NULL can be used as an empty dictionary wherever</span>
<a name="l00048"></a>00048 <span class="comment"> * a pointer to an AVDictionary is required.</span>
<a name="l00049"></a>00049 <span class="comment"> * Use av_dict_get() to retrieve an entry or iterate over all</span>
<a name="l00050"></a>00050 <span class="comment"> * entries and finally av_dict_free() to free the dictionary</span>
<a name="l00051"></a>00051 <span class="comment"> * and all its contents.</span>
<a name="l00052"></a>00052 <span class="comment"> *</span>
<a name="l00053"></a>00053 <span class="comment"> @code</span>
<a name="l00054"></a>00054 <span class="comment"> AVDictionary *d = NULL; // "create" an empty dictionary</span>
<a name="l00055"></a>00055 <span class="comment"> AVDictionaryEntry *t = NULL;</span>
<a name="l00056"></a>00056 <span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> av_dict_set(&d, "foo", "bar", 0); // add an entry</span>
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> char *k = av_strdup("key"); // if your strings are already allocated,</span>
<a name="l00060"></a>00060 <span class="comment"> char *v = av_strdup("value"); // you can avoid copying them like this</span>
<a name="l00061"></a>00061 <span class="comment"> av_dict_set(&d, k, v, AV_DICT_DONT_STRDUP_KEY | AV_DICT_DONT_STRDUP_VAL);</span>
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> while (t = av_dict_get(d, "", t, AV_DICT_IGNORE_SUFFIX)) {</span>
<a name="l00064"></a>00064 <span class="comment"> <....> // iterate over all entries in d</span>
<a name="l00065"></a>00065 <span class="comment"> }</span>
<a name="l00066"></a>00066 <span class="comment"> av_dict_free(&d);</span>
<a name="l00067"></a>00067 <span class="comment"> @endcode</span>
<a name="l00068"></a>00068 <span class="comment"> *</span>
<a name="l00069"></a>00069 <span class="comment"> */</span>
<a name="l00070"></a>00070
<a name="l00071"></a><a class="code" href="group__lavu__dict.html#gad9cbc53cec515b72ae7caa2e194c6bc0">00071</a> <span class="preprocessor">#define AV_DICT_MATCH_CASE 1 </span><span class="comment">/**< Only get an entry with exact-case key match. Only relevant in av_dict_get(). */</span>
<a name="l00072"></a><a class="code" href="group__lavu__dict.html#ga341bbd1ea599dfb0510f419e5272fecc">00072</a> <span class="preprocessor">#define AV_DICT_IGNORE_SUFFIX 2 </span><span class="comment">/**< Return first entry in a dictionary whose first part corresponds to the search key,</span>
<a name="l00073"></a>00073 <span class="comment"> ignoring the suffix of the found key string. Only relevant in av_dict_get(). */</span>
<a name="l00074"></a><a class="code" href="group__lavu__dict.html#gacb0ce4f20c15bf174f93590ace0fc8fd">00074</a> <span class="preprocessor">#define AV_DICT_DONT_STRDUP_KEY 4 </span><span class="comment">/**< Take ownership of a key that's been</span>
<a name="l00075"></a>00075 <span class="comment"> allocated with av_malloc() or another memory allocation function. */</span>
<a name="l00076"></a><a class="code" href="group__lavu__dict.html#ga7a9a991cb7837b10ffd44725263de425">00076</a> <span class="preprocessor">#define AV_DICT_DONT_STRDUP_VAL 8 </span><span class="comment">/**< Take ownership of a value that's been</span>
<a name="l00077"></a>00077 <span class="comment"> allocated with av_malloc() or another memory allocation function. */</span>
<a name="l00078"></a><a class="code" href="group__lavu__dict.html#ga8ed4237acfc3d68484301a5d1859936c">00078</a> <span class="preprocessor">#define AV_DICT_DONT_OVERWRITE 16 ///< Don't overwrite existing entries.</span>
<a name="l00079"></a><a class="code" href="group__lavu__dict.html#ga64018c01d1e8c44d1d8c03dfb099f2c2">00079</a> <span class="preprocessor"></span><span class="preprocessor">#define AV_DICT_APPEND 32 </span><span class="comment">/**< If the entry already exists, append to it. Note that no</span>
<a name="l00080"></a>00080 <span class="comment"> delimiter is added, the strings are simply concatenated. */</span>
<a name="l00081"></a>00081
<a name="l00082"></a><a class="code" href="structAVDictionaryEntry.html">00082</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structAVDictionaryEntry.html">AVDictionaryEntry</a> {
<a name="l00083"></a><a class="code" href="structAVDictionaryEntry.html#a38fc80176f8f839282bb61c03392e194">00083</a> <span class="keywordtype">char</span> *<a class="code" href="structAVDictionaryEntry.html#a38fc80176f8f839282bb61c03392e194">key</a>;
<a name="l00084"></a><a class="code" href="structAVDictionaryEntry.html#aa38678f2cad36f120d42e56449c5edb4">00084</a> <span class="keywordtype">char</span> *<a class="code" href="structAVDictionaryEntry.html#aa38678f2cad36f120d42e56449c5edb4">value</a>;
<a name="l00085"></a>00085 } <a class="code" href="structAVDictionaryEntry.html">AVDictionaryEntry</a>;
<a name="l00086"></a>00086
<a name="l00087"></a><a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">00087</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> <a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a>;
<a name="l00088"></a>00088 <span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment">/**</span>
<a name="l00090"></a>00090 <span class="comment"> * Get a dictionary entry with matching key.</span>
<a name="l00091"></a>00091 <span class="comment"> *</span>
<a name="l00092"></a>00092 <span class="comment"> * The returned entry key or value must not be changed, or it will</span>
<a name="l00093"></a>00093 <span class="comment"> * cause undefined behavior.</span>
<a name="l00094"></a>00094 <span class="comment"> *</span>
<a name="l00095"></a>00095 <span class="comment"> * To iterate through all the dictionary entries, you can set the matching key</span>
<a name="l00096"></a>00096 <span class="comment"> * to the null string "" and set the AV_DICT_IGNORE_SUFFIX flag.</span>
<a name="l00097"></a>00097 <span class="comment"> *</span>
<a name="l00098"></a>00098 <span class="comment"> * @param prev Set to the previous matching element to find the next.</span>
<a name="l00099"></a>00099 <span class="comment"> * If set to NULL the first matching element is returned.</span>
<a name="l00100"></a>00100 <span class="comment"> * @param key matching key</span>
<a name="l00101"></a>00101 <span class="comment"> * @param flags a collection of AV_DICT_* flags controlling how the entry is retrieved</span>
<a name="l00102"></a>00102 <span class="comment"> * @return found entry or NULL in case no matching entry was found in the dictionary</span>
<a name="l00103"></a>00103 <span class="comment"> */</span>
<a name="l00104"></a>00104 <a class="code" href="structAVDictionaryEntry.html">AVDictionaryEntry</a> *<a class="code" href="group__lavu__dict.html#gae67f143237b2cb2936c9b147aa6dfde3" title="Get a dictionary entry with matching key.">av_dict_get</a>(<span class="keyword">const</span> <a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> *m, <span class="keyword">const</span> <span class="keywordtype">char</span> *key,
<a name="l00105"></a>00105 <span class="keyword">const</span> <a class="code" href="structAVDictionaryEntry.html">AVDictionaryEntry</a> *prev, <span class="keywordtype">int</span> flags);
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment">/**</span>
<a name="l00108"></a>00108 <span class="comment"> * Get number of entries in dictionary.</span>
<a name="l00109"></a>00109 <span class="comment"> *</span>
<a name="l00110"></a>00110 <span class="comment"> * @param m dictionary</span>
<a name="l00111"></a>00111 <span class="comment"> * @return number of entries in dictionary</span>
<a name="l00112"></a>00112 <span class="comment"> */</span>
<a name="l00113"></a>00113 <span class="keywordtype">int</span> <a class="code" href="group__lavu__dict.html#gad21456d6601aa096c7c78dce8848d50a" title="Get number of entries in dictionary.">av_dict_count</a>(<span class="keyword">const</span> <a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> *m);
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment">/**</span>
<a name="l00116"></a>00116 <span class="comment"> * Set the given entry in *pm, overwriting an existing entry.</span>
<a name="l00117"></a>00117 <span class="comment"> *</span>
<a name="l00118"></a>00118 <span class="comment"> * Note: If AV_DICT_DONT_STRDUP_KEY or AV_DICT_DONT_STRDUP_VAL is set,</span>
<a name="l00119"></a>00119 <span class="comment"> * these arguments will be freed on error.</span>
<a name="l00120"></a>00120 <span class="comment"> *</span>
<a name="l00121"></a>00121 <span class="comment"> * @param pm pointer to a pointer to a dictionary struct. If *pm is NULL</span>
<a name="l00122"></a>00122 <span class="comment"> * a dictionary struct is allocated and put in *pm.</span>
<a name="l00123"></a>00123 <span class="comment"> * @param key entry key to add to *pm (will be av_strduped depending on flags)</span>
<a name="l00124"></a>00124 <span class="comment"> * @param value entry value to add to *pm (will be av_strduped depending on flags).</span>
<a name="l00125"></a>00125 <span class="comment"> * Passing a NULL value will cause an existing entry to be deleted.</span>
<a name="l00126"></a>00126 <span class="comment"> * @return >= 0 on success otherwise an error code <0</span>
<a name="l00127"></a>00127 <span class="comment"> */</span>
<a name="l00128"></a>00128 <span class="keywordtype">int</span> <a class="code" href="group__lavu__dict.html#ga8d9c2de72b310cef8e6a28c9cd3acbbe" title="Set the given entry in *pm, overwriting an existing entry.">av_dict_set</a>(<a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> **pm, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keyword">const</span> <span class="keywordtype">char</span> *value, <span class="keywordtype">int</span> flags);
<a name="l00129"></a>00129 <span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment">/**</span>
<a name="l00131"></a>00131 <span class="comment"> * Convenience wrapper for av_dict_set that converts the value to a string</span>
<a name="l00132"></a>00132 <span class="comment"> * and stores it.</span>
<a name="l00133"></a>00133 <span class="comment"> *</span>
<a name="l00134"></a>00134 <span class="comment"> * Note: If AV_DICT_DONT_STRDUP_KEY is set, key will be freed on error.</span>
<a name="l00135"></a>00135 <span class="comment"> */</span>
<a name="l00136"></a>00136 <span class="keywordtype">int</span> <a class="code" href="group__lavu__dict.html#gafd013a88620b2da7d497b083f6ea7d29" title="Convenience wrapper for av_dict_set that converts the value to a string and stores it...">av_dict_set_int</a>(<a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> **pm, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, int64_t value, <span class="keywordtype">int</span> flags);
<a name="l00137"></a>00137 <span class="comment"></span>
<a name="l00138"></a>00138 <span class="comment">/**</span>
<a name="l00139"></a>00139 <span class="comment"> * Parse the key/value pairs list and add the parsed entries to a dictionary.</span>
<a name="l00140"></a>00140 <span class="comment"> *</span>
<a name="l00141"></a>00141 <span class="comment"> * In case of failure, all the successfully set entries are stored in</span>
<a name="l00142"></a>00142 <span class="comment"> * *pm. You may need to manually free the created dictionary.</span>
<a name="l00143"></a>00143 <span class="comment"> *</span>
<a name="l00144"></a>00144 <span class="comment"> * @param key_val_sep a 0-terminated list of characters used to separate</span>
<a name="l00145"></a>00145 <span class="comment"> * key from value</span>
<a name="l00146"></a>00146 <span class="comment"> * @param pairs_sep a 0-terminated list of characters used to separate</span>
<a name="l00147"></a>00147 <span class="comment"> * two pairs from each other</span>
<a name="l00148"></a>00148 <span class="comment"> * @param flags flags to use when adding to dictionary.</span>
<a name="l00149"></a>00149 <span class="comment"> * AV_DICT_DONT_STRDUP_KEY and AV_DICT_DONT_STRDUP_VAL</span>
<a name="l00150"></a>00150 <span class="comment"> * are ignored since the key/value tokens will always</span>
<a name="l00151"></a>00151 <span class="comment"> * be duplicated.</span>
<a name="l00152"></a>00152 <span class="comment"> * @return 0 on success, negative AVERROR code on failure</span>
<a name="l00153"></a>00153 <span class="comment"> */</span>
<a name="l00154"></a>00154 <span class="keywordtype">int</span> <a class="code" href="group__lavu__dict.html#gaca5ff7c251e60bd13164d13c82f21b79" title="Parse the key/value pairs list and add the parsed entries to a dictionary.">av_dict_parse_string</a>(<a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> **pm, <span class="keyword">const</span> <span class="keywordtype">char</span> *str,
<a name="l00155"></a>00155 <span class="keyword">const</span> <span class="keywordtype">char</span> *key_val_sep, <span class="keyword">const</span> <span class="keywordtype">char</span> *pairs_sep,
<a name="l00156"></a>00156 <span class="keywordtype">int</span> flags);
<a name="l00157"></a>00157 <span class="comment"></span>
<a name="l00158"></a>00158 <span class="comment">/**</span>
<a name="l00159"></a>00159 <span class="comment"> * Copy entries from one AVDictionary struct into another.</span>
<a name="l00160"></a>00160 <span class="comment"> * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,</span>
<a name="l00161"></a>00161 <span class="comment"> * this function will allocate a struct for you and put it in *dst</span>
<a name="l00162"></a>00162 <span class="comment"> * @param src pointer to source AVDictionary struct</span>
<a name="l00163"></a>00163 <span class="comment"> * @param flags flags to use when setting entries in *dst</span>
<a name="l00164"></a>00164 <span class="comment"> * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag</span>
<a name="l00165"></a>00165 <span class="comment"> */</span>
<a name="l00166"></a>00166 <span class="keywordtype">void</span> <a class="code" href="group__lavu__dict.html#ga6dabaab2d8a53674db6ffd5ac8de3d9f" title="Copy entries from one AVDictionary struct into another.">av_dict_copy</a>(<a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> **dst, <span class="keyword">const</span> <a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> *src, <span class="keywordtype">int</span> flags);
<a name="l00167"></a>00167 <span class="comment"></span>
<a name="l00168"></a>00168 <span class="comment">/**</span>
<a name="l00169"></a>00169 <span class="comment"> * Free all the memory allocated for an AVDictionary struct</span>
<a name="l00170"></a>00170 <span class="comment"> * and all keys and values.</span>
<a name="l00171"></a>00171 <span class="comment"> */</span>
<a name="l00172"></a>00172 <span class="keywordtype">void</span> <a class="code" href="group__lavu__dict.html#ga1bafd682b1fbb90e48a4cc3814b820f7" title="Free all the memory allocated for an AVDictionary struct and all keys and values.">av_dict_free</a>(<a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> **m);
<a name="l00173"></a>00173 <span class="comment"></span>
<a name="l00174"></a>00174 <span class="comment">/**</span>
<a name="l00175"></a>00175 <span class="comment"> * Get dictionary entries as a string.</span>
<a name="l00176"></a>00176 <span class="comment"> *</span>
<a name="l00177"></a>00177 <span class="comment"> * Create a string containing dictionary's entries.</span>
<a name="l00178"></a>00178 <span class="comment"> * Such string may be passed back to av_dict_parse_string().</span>
<a name="l00179"></a>00179 <span class="comment"> * @note String is escaped with backslashes ('\').</span>
<a name="l00180"></a>00180 <span class="comment"> *</span>
<a name="l00181"></a>00181 <span class="comment"> * @param[in] m dictionary</span>
<a name="l00182"></a>00182 <span class="comment"> * @param[out] buffer Pointer to buffer that will be allocated with string containg entries.</span>
<a name="l00183"></a>00183 <span class="comment"> * Buffer must be freed by the caller when is no longer needed.</span>
<a name="l00184"></a>00184 <span class="comment"> * @param[in] key_val_sep character used to separate key from value</span>
<a name="l00185"></a>00185 <span class="comment"> * @param[in] pairs_sep character used to separate two pairs from each other</span>
<a name="l00186"></a>00186 <span class="comment"> * @return >= 0 on success, negative on error</span>
<a name="l00187"></a>00187 <span class="comment"> * @warning Separators cannot be neither '\\' nor '\0'. They also cannot be the same.</span>
<a name="l00188"></a>00188 <span class="comment"> */</span>
<a name="l00189"></a>00189 <span class="keywordtype">int</span> <a class="code" href="group__lavu__dict.html#ga480ab3fb3ac6cae8e60e97f58ec30b66" title="Get dictionary entries as a string.">av_dict_get_string</a>(<span class="keyword">const</span> <a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> *m, <span class="keywordtype">char</span> **buffer,
<a name="l00190"></a>00190 <span class="keyword">const</span> <span class="keywordtype">char</span> key_val_sep, <span class="keyword">const</span> <span class="keywordtype">char</span> pairs_sep);
<a name="l00191"></a>00191 <span class="comment"></span>
<a name="l00192"></a>00192 <span class="comment">/**</span>
<a name="l00193"></a>00193 <span class="comment"> * @}</span>
<a name="l00194"></a>00194 <span class="comment"> */</span>
<a name="l00195"></a>00195
<a name="l00196"></a>00196 <span class="preprocessor">#endif </span><span class="comment">/* AVUTIL_DICT_H */</span>
</pre></div></div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>