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-14
showbox-public-14 / ffmpeg-doc deb
Repository URL to install this package:
|
Version:
8:3.0.2-1ubuntu3 ▾
|
<!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"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>FFmpeg: libavutil/dict.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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">3.0.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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>
<!-- 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>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</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>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8d855866ba5d436d839c7fc557836cd9.html">libavutil</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">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"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * This file is part of FFmpeg.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * FFmpeg is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * FFmpeg is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * License along with FFmpeg; if not, write to the Free Software</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * @file</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Public dictionary API.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * @deprecated</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * AVDictionary is provided for compatibility with libav. It is both in</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * implementation as well as API inefficient. It does not scale and is</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * extremely slow with large dictionaries.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * It is recommended that new code uses our tree container from tree.c/h</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * where applicable, which uses AVL trees to achieve O(log n) performance.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifndef AVUTIL_DICT_H</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"></span><span class="preprocessor">#define AVUTIL_DICT_H</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <stdint.h></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "<a class="code" href="libavutil_2version_8h.html">version.h</a>"</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @addtogroup lavu_dict AVDictionary</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @ingroup lavu_data</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @brief Simple key:value store</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * @{</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * Dictionaries are used for storing key:value pairs. To create</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * an AVDictionary, simply pass an address of a NULL pointer to</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * av_dict_set(). NULL can be used as an empty dictionary wherever</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * a pointer to an AVDictionary is required.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * Use av_dict_get() to retrieve an entry or iterate over all</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * entries and finally av_dict_free() to free the dictionary</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * and all its contents.</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> @code</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> AVDictionary *d = NULL; // "create" an empty dictionary</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> AVDictionaryEntry *t = NULL;</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> av_dict_set(&d, "foo", "bar", 0); // add an entry</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> char *k = av_strdup("key"); // if your strings are already allocated,</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> char *v = av_strdup("value"); // you can avoid copying them like this</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> av_dict_set(&d, k, v, AV_DICT_DONT_STRDUP_KEY | AV_DICT_DONT_STRDUP_VAL);</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> while (t = av_dict_get(d, "", t, AV_DICT_IGNORE_SUFFIX)) {</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> <....> // iterate over all entries in d</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> }</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> av_dict_free(&d);</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> @endcode</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="group__lavu__dict.html#gad9cbc53cec515b72ae7caa2e194c6bc0"> 71</a></span> <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><span class="preprocessor"></span></div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="group__lavu__dict.html#ga341bbd1ea599dfb0510f419e5272fecc"> 72</a></span> <span class="preprocessor"></span><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></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> ignoring the suffix of the found key string. Only relevant in av_dict_get(). */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"></span><span class="preprocessor">#define AV_DICT_DONT_STRDUP_KEY 4 </span><span class="comment">/**< Take ownership of a key that's been</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="group__lavu__dict.html#gacb0ce4f20c15bf174f93590ace0fc8fd"> 75</a></span> <span class="comment"> allocated with av_malloc() or another memory allocation function. */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"></span><span class="preprocessor">#define AV_DICT_DONT_STRDUP_VAL 8 </span><span class="comment">/**< Take ownership of a value that's been</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> allocated with av_malloc() or another memory allocation function. */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="group__lavu__dict.html#ga7a9a991cb7837b10ffd44725263de425"> 78</a></span> <span class="preprocessor"></span><span class="preprocessor">#define AV_DICT_DONT_OVERWRITE 16 </span><span class="comment">///< Don't overwrite existing entries.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span>#define AV_DICT_APPEND 32 <span class="comment">/**< If the entry already exists, append to it. Note that no</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> delimiter is added, the strings are simply concatenated. */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="group__lavu__dict.html#ga8ed4237acfc3d68484301a5d1859936c"> 81</a></span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="group__lavu__dict.html#ga64018c01d1e8c44d1d8c03dfb099f2c2"> 82</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structAVDictionaryEntry.html">AVDictionaryEntry</a> {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">char</span> *<a class="code" href="structAVDictionaryEntry.html#a38fc80176f8f839282bb61c03392e194">key</a>;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">char</span> *<a class="code" href="structAVDictionaryEntry.html#aa38678f2cad36f120d42e56449c5edb4">value</a>;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> } <a class="code" href="structAVDictionaryEntry.html">AVDictionaryEntry</a>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="structAVDictionaryEntry.html"> 86</a></span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="structAVDictionaryEntry.html#a38fc80176f8f839282bb61c03392e194"> 87</a></span> <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>;</div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="structAVDictionaryEntry.html#aa38678f2cad36f120d42e56449c5edb4"> 88</a></span> <span class="comment"></span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * Get a dictionary entry with matching key.</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f"> 91</a></span> <span class="comment"> *</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * The returned entry key or value must not be changed, or it will</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * cause undefined behavior.</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * To iterate through all the dictionary entries, you can set the matching key</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * to the null string "" and set the AV_DICT_IGNORE_SUFFIX flag.</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @param prev Set to the previous matching element to find the next.</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * If set to NULL the first matching element is returned.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * @param key matching key</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * @param flags a collection of AV_DICT_* flags controlling how the entry is retrieved</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @return found entry or NULL in case no matching entry was found in the dictionary</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <a class="code" href="structAVDictionaryEntry.html">AVDictionaryEntry</a> *<a class="code" href="group__lavu__dict.html#gae67f143237b2cb2936c9b147aa6dfde3">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,</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">const</span> <a class="code" href="structAVDictionaryEntry.html">AVDictionaryEntry</a> *prev, <span class="keywordtype">int</span> flags);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"></span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * Get number of entries in dictionary.</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @param m dictionary</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * @return number of entries in dictionary</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keywordtype">int</span> <a class="code" href="group__lavu__dict.html#gad21456d6601aa096c7c78dce8848d50a">av_dict_count</a>(<span class="keyword">const</span> <a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> *m);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"></span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * Set the given entry in *pm, overwriting an existing entry.</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * Note: If AV_DICT_DONT_STRDUP_KEY or AV_DICT_DONT_STRDUP_VAL is set,</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * these arguments will be freed on error.</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @param pm pointer to a pointer to a dictionary struct. If *pm is NULL</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * a dictionary struct is allocated and put in *pm.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @param key entry key to add to *pm (will be av_strduped depending on flags)</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @param value entry value to add to *pm (will be av_strduped depending on flags).</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * Passing a NULL value will cause an existing entry to be deleted.</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @return >= 0 on success otherwise an error code <0</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keywordtype">int</span> <a class="code" href="group__lavu__dict.html#ga8d9c2de72b310cef8e6a28c9cd3acbbe">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);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"></span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * Convenience wrapper for av_dict_set that converts the value to a string</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * and stores it.</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * Note: If AV_DICT_DONT_STRDUP_KEY is set, key will be freed on error.</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keywordtype">int</span> <a class="code" href="group__lavu__dict.html#gafd013a88620b2da7d497b083f6ea7d29">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);</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"></span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * Parse the key/value pairs list and add the parsed entries to a dictionary.</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * In case of failure, all the successfully set entries are stored in</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * *pm. You may need to manually free the created dictionary.</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * @param key_val_sep a 0-terminated list of characters used to separate</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * key from value</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * @param pairs_sep a 0-terminated list of characters used to separate</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * two pairs from each other</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @param flags flags to use when adding to dictionary.</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * AV_DICT_DONT_STRDUP_KEY and AV_DICT_DONT_STRDUP_VAL</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * are ignored since the key/value tokens will always</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * be duplicated.</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * @return 0 on success, negative AVERROR code on failure</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="keywordtype">int</span> <a class="code" href="group__lavu__dict.html#gaca5ff7c251e60bd13164d13c82f21b79">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,</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <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,</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">int</span> flags);</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"></span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * Copy entries from one AVDictionary struct into another.</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL,</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * this function will allocate a struct for you and put it in *dst</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * @param src pointer to source AVDictionary struct</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * @param flags flags to use when setting entries in *dst</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * @return 0 on success, negative AVERROR code on failure. If dst was allocated</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * by this function, callers should free the associated memory.</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="keywordtype">int</span> <a class="code" href="group__lavu__dict.html#ga59a6372b124b306e3a2233723c5cdc78">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);</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"></span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * Free all the memory allocated for an AVDictionary struct</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * and all keys and values.</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="keywordtype">void</span> <a class="code" href="group__lavu__dict.html#ga1bafd682b1fbb90e48a4cc3814b820f7">av_dict_free</a>(<a class="code" href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a> **m);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"></span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * Get dictionary entries as a string.</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * Create a string containing dictionary's entries.</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * Such string may be passed back to av_dict_parse_string().</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * @note String is escaped with backslashes ('\').</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * @param[in] m dictionary</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * @param[out] buffer Pointer to buffer that will be allocated with string containg entries.</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * Buffer must be freed by the caller when is no longer needed.</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * @param[in] key_val_sep character used to separate key from value</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * @param[in] pairs_sep character used to separate two pairs from each other</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @return >= 0 on success, negative on error</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @warning Separators cannot be neither '\\' nor '\0'. They also cannot be the same.</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="keywordtype">int</span> <a class="code" href="group__lavu__dict.html#ga480ab3fb3ac6cae8e60e97f58ec30b66">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,</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <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);</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"></span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * @}</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="preprocessor">#endif </span><span class="comment">/* AVUTIL_DICT_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="structAVDictionaryEntry_html"><div class="ttname"><a href="structAVDictionaryEntry.html">AVDictionaryEntry</a></div><div class="ttdef"><b>Definition:</b> <a href="dict_8h_source.html#l00086">dict.h:86</a></div></div>
<div class="ttc" id="group__lavu__dict_html_gad21456d6601aa096c7c78dce8848d50a"><div class="ttname"><a href="group__lavu__dict.html#gad21456d6601aa096c7c78dce8848d50a">av_dict_count</a></div><div class="ttdeci">int av_dict_count(const AVDictionary *m)</div><div class="ttdoc">Get number of entries in dictionary. </div></div>
<div class="ttc" id="group__lavu__dict_html_ga480ab3fb3ac6cae8e60e97f58ec30b66"><div class="ttname"><a href="group__lavu__dict.html#ga480ab3fb3ac6cae8e60e97f58ec30b66">av_dict_get_string</a></div><div class="ttdeci">int av_dict_get_string(const AVDictionary *m, char **buffer, const char key_val_sep, const char pairs_sep)</div><div class="ttdoc">Get dictionary entries as a string. </div></div>
<div class="ttc" id="group__lavu__dict_html_ga59a6372b124b306e3a2233723c5cdc78"><div class="ttname"><a href="group__lavu__dict.html#ga59a6372b124b306e3a2233723c5cdc78">av_dict_copy</a></div><div class="ttdeci">int av_dict_copy(AVDictionary **dst, const AVDictionary *src, int flags)</div><div class="ttdoc">Copy entries from one AVDictionary struct into another. </div></div>
<div class="ttc" id="group__lavu__dict_html_gae67f143237b2cb2936c9b147aa6dfde3"><div class="ttname"><a href="group__lavu__dict.html#gae67f143237b2cb2936c9b147aa6dfde3">av_dict_get</a></div><div class="ttdeci">AVDictionaryEntry * av_dict_get(const AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags)</div><div class="ttdoc">Get a dictionary entry with matching key. </div></div>
<div class="ttc" id="group__lavu__dict_html_ga1d7cc0833bee918994a600556410315f"><div class="ttname"><a href="group__lavu__dict.html#ga1d7cc0833bee918994a600556410315f">AVDictionary</a></div><div class="ttdeci">struct AVDictionary AVDictionary</div><div class="ttdef"><b>Definition:</b> <a href="dict_8h_source.html#l00091">dict.h:91</a></div></div>
<div class="ttc" id="group__lavu__dict_html_ga1bafd682b1fbb90e48a4cc3814b820f7"><div class="ttname"><a href="group__lavu__dict.html#ga1bafd682b1fbb90e48a4cc3814b820f7">av_dict_free</a></div><div class="ttdeci">void av_dict_free(AVDictionary **m)</div><div class="ttdoc">Free all the memory allocated for an AVDictionary struct and all keys and values. ...</div></div>
<div class="ttc" id="libavutil_2version_8h_html"><div class="ttname"><a href="libavutil_2version_8h.html">version.h</a></div><div class="ttdoc">Libavutil version macros. </div></div>
<div class="ttc" id="group__lavu__dict_html_gaca5ff7c251e60bd13164d13c82f21b79"><div class="ttname"><a href="group__lavu__dict.html#gaca5ff7c251e60bd13164d13c82f21b79">av_dict_parse_string</a></div><div class="ttdeci">int av_dict_parse_string(AVDictionary **pm, const char *str, const char *key_val_sep, const char *pairs_sep, int flags)</div><div class="ttdoc">Parse the key/value pairs list and add the parsed entries to a dictionary. </div></div>
<div class="ttc" id="group__lavu__dict_html_ga8d9c2de72b310cef8e6a28c9cd3acbbe"><div class="ttname"><a href="group__lavu__dict.html#ga8d9c2de72b310cef8e6a28c9cd3acbbe">av_dict_set</a></div><div class="ttdeci">int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)</div><div class="ttdoc">Set the given entry in *pm, overwriting an existing entry. </div></div>
<div class="ttc" id="group__lavu__dict_html_gafd013a88620b2da7d497b083f6ea7d29"><div class="ttname"><a href="group__lavu__dict.html#gafd013a88620b2da7d497b083f6ea7d29">av_dict_set_int</a></div><div class="ttdeci">int av_dict_set_int(AVDictionary **pm, const char *key, int64_t value, int flags)</div><div class="ttdoc">Convenience wrapper for av_dict_set that converts the value to a string and stores it...</div></div>
<div class="ttc" id="structAVDictionaryEntry_html_a38fc80176f8f839282bb61c03392e194"><div class="ttname"><a href="structAVDictionaryEntry.html#a38fc80176f8f839282bb61c03392e194">AVDictionaryEntry::key</a></div><div class="ttdeci">char * key</div><div class="ttdef"><b>Definition:</b> <a href="dict_8h_source.html#l00087">dict.h:87</a></div></div>
<div class="ttc" id="structAVDictionaryEntry_html_aa38678f2cad36f120d42e56449c5edb4"><div class="ttname"><a href="structAVDictionaryEntry.html#aa38678f2cad36f120d42e56449c5edb4">AVDictionaryEntry::value</a></div><div class="ttdeci">char * value</div><div class="ttdef"><b>Definition:</b> <a href="dict_8h_source.html#l00088">dict.h:88</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<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.8.6
</small></address>
</body>
</html>