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/bprint.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">bprint.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="bprint_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"> * Copyright (c) 2012 Nicolas George</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This file is part of FFmpeg.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * FFmpeg is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * FFmpeg is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * License along with FFmpeg; if not, write to the Free Software</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</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> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef AVUTIL_BPRINT_H</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span><span class="preprocessor">#define AVUTIL_BPRINT_H</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <stdarg.h></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="attributes_8h.html">attributes.h</a>"</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="avstring_8h.html">avstring.h</a>"</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></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> <span class="comment"> * Define a structure with extra padding to a fixed size</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * This helps ensuring binary compatibility with future versions.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="bprint_8h.html#a89675bde26f19bdd3775f9085a96ea05"> 34</a></span> <span class="preprocessor">#define FF_PAD_STRUCTURE(name, size, ...) \</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">struct ff_pad_helper_##name { __VA_ARGS__ }; \</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">typedef struct name { \</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"> __VA_ARGS__ \</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"> char reserved_padding[size - sizeof(struct ff_pad_helper_##name)]; \</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">} name;</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="comment"></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"> * Buffer to print data progressively</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"> * The string buffer grows as necessary and is always 0-terminated.</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * The content of the string is never accessed, and thus is</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * encoding-agnostic and can even hold binary data.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * Small buffers are kept in the structure itself, and thus require no</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * memory allocation at all (unless the contents of the buffer is needed</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * after the structure goes out of scope). This is almost as lightweight as</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * declaring a local "char buf[512]".</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"> * The length of the string can go beyond the allocated size: the buffer is</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * then truncated, but the functions still keep account of the actual total</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * length.</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"> * In other words, buf->len can be greater than buf->size and records the</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * total length of what would have been to the buffer if there had been</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * enough memory.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * Append operations do not need to be tested for failure: if a memory</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * allocation fails, data stop being appended to the buffer, but the length</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * is still updated. This situation can be tested with</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * av_bprint_is_complete().</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"> * The size_max field determines several possible behaviours:</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * size_max = -1 (= UINT_MAX) or any large value will let the buffer be</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * reallocated as necessary, with an amortized linear cost.</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * size_max = 0 prevents writing anything to the buffer: only the total</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * length is computed. The write operations can then possibly be repeated in</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * a buffer with exactly the necessary size</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * (using size_init = size_max = len + 1).</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * size_max = 1 is automatically replaced by the exact size available in the</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * structure itself, thus ensuring no dynamic memory allocation. The</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * internal buffer is large enough to hold a reasonable paragraph of text,</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * such as the current paragraph.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <a class="code" href="bprint_8h.html#a89675bde26f19bdd3775f9085a96ea05">FF_PAD_STRUCTURE</a>(AVBPrint, 1024,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">char</span> *str; <span class="comment">/**< string so far */</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">unsigned</span> len; <span class="comment">/**< length so far */</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">unsigned</span> size; <span class="comment">/**< allocated memory */</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">unsigned</span> <a class="code" href="bprint_8h.html#acf8cd3996e691221ed7bdb8310ea2fc2">size_max</a>; <span class="comment">/**< maximum allocated memory */</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">char</span> reserved_internal_buffer[1];</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</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">/**</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * Convenience macros for special values for av_bprint_init() size_max</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * parameter.</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> #define <a class="code" href="bprint_8h.html#a01aefbce0615a828eae24135a9b35c45">AV_BPRINT_SIZE_UNLIMITED</a> ((<span class="keywordtype">unsigned</span>)-1)</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#define AV_BPRINT_SIZE_AUTOMATIC 1</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor"></span><span class="preprocessor">#define AV_BPRINT_SIZE_COUNT_ONLY 0</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * Init a print buffer.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * @param buf buffer to init</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @param size_init initial size (including the final 0)</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @param size_max maximum size;</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * 0 means do not write anything, just count the length;</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * 1 is replaced by the maximum value for automatic storage;</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * any large value means that the internal buffer will be</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * reallocated as needed up to that limit; -1 is converted to</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * UINT_MAX, the largest limit possible.</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * Check also AV_BPRINT_SIZE_* macros.</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="bprint_8h.html#acf8cd3996e691221ed7bdb8310ea2fc2"> 111</a></span> <span class="keywordtype">void</span> av_bprint_init(AVBPrint *buf, <span class="keywordtype">unsigned</span> <a class="code" href="bprint_8h.html#a938b4c4eed995775474a106731647736">size_init</a>, <span class="keywordtype">unsigned</span> size_max);</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="comment">/**</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * Init a print buffer using a pre-existing buffer.</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"> * The buffer will not be reallocated.</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"> * @param buf buffer structure to init</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @param buffer byte buffer to use for the string data</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * @param size size of buffer</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#af70c16532f4ba50c599e4eaa67a1d63b">av_bprint_init_for_buffer</a>(AVBPrint *buf, <span class="keywordtype">char</span> *buffer, <span class="keywordtype">unsigned</span> size);</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"></span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * Append a formatted string to a print buffer.</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#aa2e89377fd7c92db534f29caff1af209">av_bprintf</a>(AVBPrint *buf, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...) <a class="code" href="attributes_8h.html#a4b078d4b8e02c0f452ee1dcaa7d983d3">av_printf_format</a>(2, 3);</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"></span></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"> * Append a formatted string to a print buffer.</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#ae24ca62b5e2ba99651636c04b61240f1">av_vbprintf</a>(AVBPrint *buf, const <span class="keywordtype">char</span> *fmt, va_list vl_arg);</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">/**</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * Append char c n times to a print buffer.</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#aabc9a9d58de61dd824e625d59a7531bb">av_bprint_chars</a>(AVBPrint *buf, <span class="keywordtype">char</span> c, <span class="keywordtype">unsigned</span> n);</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">/**</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * Append data to a print buffer.</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * param buf bprint buffer to use</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * param data pointer to data</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * param size size of data</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#aa215ba46a975d996e483cf0b9dcc85e5">av_bprint_append_data</a>(AVBPrint *buf, const <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> size);</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> struct tm;<span class="comment"></span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * Append a formatted date and time to a print buffer.</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * param buf bprint buffer to use</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * param fmt date and time format string, see strftime()</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * param tm broken-down time structure to translate</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @note due to poor design of the standard strftime function, it may</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * produce poor results if the format string expands to a very long text and</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * the bprint buffer is near the limit stated by the size_max option.</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#a4896e4efea5b234507bcbba45ca0397b">av_bprint_strftime</a>(AVBPrint *buf, const <span class="keywordtype">char</span> *fmt, const struct tm *tm);</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"></span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * Allocate bytes in the buffer for external use.</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * @param[in] buf buffer structure</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * @param[in] size required size</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * @param[out] mem pointer to the memory area</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * @param[out] actual_size size of the memory area after allocation;</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * can be larger or smaller than size</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="keywordtype">void</span> <a class="code" href="bprint_8h.html#a32f3999614d90e082602d54a3c5237d6">av_bprint_get_buffer</a>(AVBPrint *buf, <span class="keywordtype">unsigned</span> size,</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **mem, <span class="keywordtype">unsigned</span> *actual_size);</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="comment">/**</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * Reset the string to "" but keep internal allocated data.</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="keywordtype">void</span> <a class="code" href="bprint_8h.html#ab1c28dbff5990dbd37e6c00e3d7c438b">av_bprint_clear</a>(AVBPrint *buf);</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">/**</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * Test if the print buffer is complete (not truncated).</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * It may have been truncated due to a memory allocation failure</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * or the size_max limit (compare size and size_max if necessary).</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"><a class="line" href="bprint_8h.html#a07432f704c49a6fa636197e2aa80bac0"> 185</a></span> static inline <span class="keywordtype">int</span> <a class="code" href="bprint_8h.html#a07432f704c49a6fa636197e2aa80bac0">av_bprint_is_complete</a>(const AVBPrint *buf)</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> {</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keywordflow">return</span> buf->len < buf->size;</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> }</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"></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="comment"> * Finalize a print buffer.</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> * The print buffer can no longer be used afterwards,</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> * but the len and size fields are still valid.</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"> * @arg[out] ret_str if not NULL, used to return a permanent copy of the</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * buffer contents, or NULL if memory allocation fails;</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * if NULL, the buffer is discarded and freed</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * @return 0 for success or error code (probably AVERROR(ENOMEM))</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keywordtype">int</span> <a class="code" href="bprint_8h.html#a3fd45f50d9d4f7cc8fed5331a37f47ea">av_bprint_finalize</a>(AVBPrint *buf, <span class="keywordtype">char</span> **ret_str);</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"></span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * Escape the content in src and append it to dstbuf.</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * @param dstbuf already inited destination bprint buffer</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * @param src string containing the text to escape</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * @param special_chars string containing the special characters which</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * need to be escaped, can be NULL</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * @param mode escape mode to employ, see AV_ESCAPE_MODE_* macros.</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * Any unknown value for mode will be considered equivalent to</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * AV_ESCAPE_MODE_BACKSLASH, but this behaviour can change without</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * notice.</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * @param flags flags which control how to escape, see AV_ESCAPE_FLAG_* macros</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#a14ec58eeaa6d4a3571cd9f0ffb873e62">av_bprint_escape</a>(AVBPrint *dstbuf, <span class="keyword">const</span> <span class="keywordtype">char</span> *src, <span class="keyword">const</span> <span class="keywordtype">char</span> *special_chars,</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keyword">enum</span> <a class="code" href="group__lavu__string.html#gaef885958293f07153383f99db573ff5a">AVEscapeMode</a> mode, <span class="keywordtype">int</span> flags);</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="preprocessor">#endif </span><span class="comment">/* AVUTIL_BPRINT_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="bprint_8h_html_ab1c28dbff5990dbd37e6c00e3d7c438b"><div class="ttname"><a href="bprint_8h.html#ab1c28dbff5990dbd37e6c00e3d7c438b">av_bprint_clear</a></div><div class="ttdeci">void av_bprint_clear(AVBPrint *buf)</div><div class="ttdoc">Reset the string to "" but keep internal allocated data. </div></div>
<div class="ttc" id="bprint_8h_html_aabc9a9d58de61dd824e625d59a7531bb"><div class="ttname"><a href="bprint_8h.html#aabc9a9d58de61dd824e625d59a7531bb">av_bprint_chars</a></div><div class="ttdeci">void av_bprint_chars(AVBPrint *buf, char c, unsigned n)</div><div class="ttdoc">Append char c n times to a print buffer. </div></div>
<div class="ttc" id="bprint_8h_html_aa215ba46a975d996e483cf0b9dcc85e5"><div class="ttname"><a href="bprint_8h.html#aa215ba46a975d996e483cf0b9dcc85e5">av_bprint_append_data</a></div><div class="ttdeci">void av_bprint_append_data(AVBPrint *buf, const char *data, unsigned size)</div><div class="ttdoc">Append data to a print buffer. </div></div>
<div class="ttc" id="avstring_8h_html"><div class="ttname"><a href="avstring_8h.html">avstring.h</a></div></div>
<div class="ttc" id="bprint_8h_html_ae24ca62b5e2ba99651636c04b61240f1"><div class="ttname"><a href="bprint_8h.html#ae24ca62b5e2ba99651636c04b61240f1">av_vbprintf</a></div><div class="ttdeci">void void av_vbprintf(AVBPrint *buf, const char *fmt, va_list vl_arg)</div><div class="ttdoc">Append a formatted string to a print buffer. </div></div>
<div class="ttc" id="attributes_8h_html"><div class="ttname"><a href="attributes_8h.html">attributes.h</a></div><div class="ttdoc">Macro definitions for various function/variable attributes. </div></div>
<div class="ttc" id="bprint_8h_html_af70c16532f4ba50c599e4eaa67a1d63b"><div class="ttname"><a href="bprint_8h.html#af70c16532f4ba50c599e4eaa67a1d63b">av_bprint_init_for_buffer</a></div><div class="ttdeci">void av_bprint_init_for_buffer(AVBPrint *buf, char *buffer, unsigned size)</div><div class="ttdoc">Init a print buffer using a pre-existing buffer. </div></div>
<div class="ttc" id="bprint_8h_html_a32f3999614d90e082602d54a3c5237d6"><div class="ttname"><a href="bprint_8h.html#a32f3999614d90e082602d54a3c5237d6">av_bprint_get_buffer</a></div><div class="ttdeci">void av_bprint_get_buffer(AVBPrint *buf, unsigned size, unsigned char **mem, unsigned *actual_size)</div><div class="ttdoc">Allocate bytes in the buffer for external use. </div></div>
<div class="ttc" id="bprint_8h_html_a01aefbce0615a828eae24135a9b35c45"><div class="ttname"><a href="bprint_8h.html#a01aefbce0615a828eae24135a9b35c45">AV_BPRINT_SIZE_UNLIMITED</a></div><div class="ttdeci">#define AV_BPRINT_SIZE_UNLIMITED</div></div>
<div class="ttc" id="attributes_8h_html_a4b078d4b8e02c0f452ee1dcaa7d983d3"><div class="ttname"><a href="attributes_8h.html#a4b078d4b8e02c0f452ee1dcaa7d983d3">av_printf_format</a></div><div class="ttdeci">#define av_printf_format(fmtpos, attrpos)</div><div class="ttdef"><b>Definition:</b> <a href="attributes_8h_source.html#l00156">attributes.h:156</a></div></div>
<div class="ttc" id="bprint_8h_html_aa2e89377fd7c92db534f29caff1af209"><div class="ttname"><a href="bprint_8h.html#aa2e89377fd7c92db534f29caff1af209">av_bprintf</a></div><div class="ttdeci">void av_bprintf(AVBPrint *buf, const char *fmt,...) av_printf_format(2</div><div class="ttdoc">Append a formatted string to a print buffer. </div></div>
<div class="ttc" id="bprint_8h_html_a4896e4efea5b234507bcbba45ca0397b"><div class="ttname"><a href="bprint_8h.html#a4896e4efea5b234507bcbba45ca0397b">av_bprint_strftime</a></div><div class="ttdeci">void av_bprint_strftime(AVBPrint *buf, const char *fmt, const struct tm *tm)</div><div class="ttdoc">Append a formatted date and time to a print buffer. </div></div>
<div class="ttc" id="bprint_8h_html_a07432f704c49a6fa636197e2aa80bac0"><div class="ttname"><a href="bprint_8h.html#a07432f704c49a6fa636197e2aa80bac0">av_bprint_is_complete</a></div><div class="ttdeci">static int av_bprint_is_complete(const AVBPrint *buf)</div><div class="ttdoc">Test if the print buffer is complete (not truncated). </div><div class="ttdef"><b>Definition:</b> <a href="bprint_8h_source.html#l00185">bprint.h:185</a></div></div>
<div class="ttc" id="bprint_8h_html_a89675bde26f19bdd3775f9085a96ea05"><div class="ttname"><a href="bprint_8h.html#a89675bde26f19bdd3775f9085a96ea05">FF_PAD_STRUCTURE</a></div><div class="ttdeci">#define FF_PAD_STRUCTURE(name, size,...)</div><div class="ttdoc">Define a structure with extra padding to a fixed size This helps ensuring binary compatibility with f...</div><div class="ttdef"><b>Definition:</b> <a href="bprint_8h_source.html#l00034">bprint.h:34</a></div></div>
<div class="ttc" id="bprint_8h_html_a14ec58eeaa6d4a3571cd9f0ffb873e62"><div class="ttname"><a href="bprint_8h.html#a14ec58eeaa6d4a3571cd9f0ffb873e62">av_bprint_escape</a></div><div class="ttdeci">void av_bprint_escape(AVBPrint *dstbuf, const char *src, const char *special_chars, enum AVEscapeMode mode, int flags)</div><div class="ttdoc">Escape the content in src and append it to dstbuf. </div></div>
<div class="ttc" id="bprint_8h_html_a3fd45f50d9d4f7cc8fed5331a37f47ea"><div class="ttname"><a href="bprint_8h.html#a3fd45f50d9d4f7cc8fed5331a37f47ea">av_bprint_finalize</a></div><div class="ttdeci">int av_bprint_finalize(AVBPrint *buf, char **ret_str)</div><div class="ttdoc">Finalize a print buffer. </div></div>
<div class="ttc" id="bprint_8h_html_acf8cd3996e691221ed7bdb8310ea2fc2"><div class="ttname"><a href="bprint_8h.html#acf8cd3996e691221ed7bdb8310ea2fc2">size_max</a></div><div class="ttdeci">unsigned unsigned size_max</div><div class="ttdef"><b>Definition:</b> <a href="bprint_8h_source.html#l00111">bprint.h:111</a></div></div>
<div class="ttc" id="bprint_8h_html_a938b4c4eed995775474a106731647736"><div class="ttname"><a href="bprint_8h.html#a938b4c4eed995775474a106731647736">size_init</a></div><div class="ttdeci">unsigned size_init</div><div class="ttdef"><b>Definition:</b> <a href="bprint_8h_source.html#l00111">bprint.h:111</a></div></div>
<div class="ttc" id="group__lavu__string_html_gaef885958293f07153383f99db573ff5a"><div class="ttname"><a href="group__lavu__string.html#gaef885958293f07153383f99db573ff5a">AVEscapeMode</a></div><div class="ttdeci">AVEscapeMode</div><div class="ttdef"><b>Definition:</b> <a href="avstring_8h_source.html#l00308">avstring.h:308</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>