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-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"/>
<title>FFmpeg: libavutil/bprint.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/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"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2012 Nicolas George</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * This file is part of FFmpeg.</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * FFmpeg is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00008"></a>00008 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * FFmpeg is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00014"></a>00014 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00017"></a>00017 <span class="comment"> * License along with FFmpeg; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef AVUTIL_BPRINT_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define AVUTIL_BPRINT_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <stdarg.h></span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="attributes_8h.html" title="Macro definitions for various function/variable attributes.">attributes.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="avstring_8h.html">avstring.h</a>"</span>
<a name="l00028"></a>00028 <span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment">/**</span>
<a name="l00030"></a>00030 <span class="comment"> * Define a structure with extra padding to a fixed size</span>
<a name="l00031"></a>00031 <span class="comment"> * This helps ensuring binary compatibility with future versions.</span>
<a name="l00032"></a>00032 <span class="comment"> */</span>
<a name="l00033"></a>00033
<a name="l00034"></a><a class="code" href="bprint_8h.html#a89675bde26f19bdd3775f9085a96ea05">00034</a> <span class="preprocessor">#define FF_PAD_STRUCTURE(name, size, ...) \</span>
<a name="l00035"></a>00035 <span class="preprocessor">struct ff_pad_helper_##name { __VA_ARGS__ }; \</span>
<a name="l00036"></a>00036 <span class="preprocessor">typedef struct name { \</span>
<a name="l00037"></a>00037 <span class="preprocessor"> __VA_ARGS__ \</span>
<a name="l00038"></a>00038 <span class="preprocessor"> char reserved_padding[size - sizeof(struct ff_pad_helper_##name)]; \</span>
<a name="l00039"></a>00039 <span class="preprocessor">} name;</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment">/**</span>
<a name="l00042"></a>00042 <span class="comment"> * Buffer to print data progressively</span>
<a name="l00043"></a>00043 <span class="comment"> *</span>
<a name="l00044"></a>00044 <span class="comment"> * The string buffer grows as necessary and is always 0-terminated.</span>
<a name="l00045"></a>00045 <span class="comment"> * The content of the string is never accessed, and thus is</span>
<a name="l00046"></a>00046 <span class="comment"> * encoding-agnostic and can even hold binary data.</span>
<a name="l00047"></a>00047 <span class="comment"> *</span>
<a name="l00048"></a>00048 <span class="comment"> * Small buffers are kept in the structure itself, and thus require no</span>
<a name="l00049"></a>00049 <span class="comment"> * memory allocation at all (unless the contents of the buffer is needed</span>
<a name="l00050"></a>00050 <span class="comment"> * after the structure goes out of scope). This is almost as lightweight as</span>
<a name="l00051"></a>00051 <span class="comment"> * declaring a local "char buf[512]".</span>
<a name="l00052"></a>00052 <span class="comment"> *</span>
<a name="l00053"></a>00053 <span class="comment"> * The length of the string can go beyond the allocated size: the buffer is</span>
<a name="l00054"></a>00054 <span class="comment"> * then truncated, but the functions still keep account of the actual total</span>
<a name="l00055"></a>00055 <span class="comment"> * length.</span>
<a name="l00056"></a>00056 <span class="comment"> *</span>
<a name="l00057"></a>00057 <span class="comment"> * In other words, buf->len can be greater than buf->size and records the</span>
<a name="l00058"></a>00058 <span class="comment"> * total length of what would have been to the buffer if there had been</span>
<a name="l00059"></a>00059 <span class="comment"> * enough memory.</span>
<a name="l00060"></a>00060 <span class="comment"> *</span>
<a name="l00061"></a>00061 <span class="comment"> * Append operations do not need to be tested for failure: if a memory</span>
<a name="l00062"></a>00062 <span class="comment"> * allocation fails, data stop being appended to the buffer, but the length</span>
<a name="l00063"></a>00063 <span class="comment"> * is still updated. This situation can be tested with</span>
<a name="l00064"></a>00064 <span class="comment"> * av_bprint_is_complete().</span>
<a name="l00065"></a>00065 <span class="comment"> *</span>
<a name="l00066"></a>00066 <span class="comment"> * The size_max field determines several possible behaviours:</span>
<a name="l00067"></a>00067 <span class="comment"> *</span>
<a name="l00068"></a>00068 <span class="comment"> * size_max = -1 (= UINT_MAX) or any large value will let the buffer be</span>
<a name="l00069"></a>00069 <span class="comment"> * reallocated as necessary, with an amortized linear cost.</span>
<a name="l00070"></a>00070 <span class="comment"> *</span>
<a name="l00071"></a>00071 <span class="comment"> * size_max = 0 prevents writing anything to the buffer: only the total</span>
<a name="l00072"></a>00072 <span class="comment"> * length is computed. The write operations can then possibly be repeated in</span>
<a name="l00073"></a>00073 <span class="comment"> * a buffer with exactly the necessary size</span>
<a name="l00074"></a>00074 <span class="comment"> * (using size_init = size_max = len + 1).</span>
<a name="l00075"></a>00075 <span class="comment"> *</span>
<a name="l00076"></a>00076 <span class="comment"> * size_max = 1 is automatically replaced by the exact size available in the</span>
<a name="l00077"></a>00077 <span class="comment"> * structure itself, thus ensuring no dynamic memory allocation. The</span>
<a name="l00078"></a>00078 <span class="comment"> * internal buffer is large enough to hold a reasonable paragraph of text,</span>
<a name="l00079"></a>00079 <span class="comment"> * such as the current paragraph.</span>
<a name="l00080"></a>00080 <span class="comment"> */</span>
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <a class="code" href="bprint_8h.html#a89675bde26f19bdd3775f9085a96ea05" title="Define a structure with extra padding to a fixed size This helps ensuring binary compatibility with f...">FF_PAD_STRUCTURE</a>(AVBPrint, 1024,
<a name="l00083"></a>00083 <span class="keywordtype">char</span> *str; <span class="comment">/**< string so far */</span>
<a name="l00084"></a>00084 <span class="keywordtype">unsigned</span> len; <span class="comment">/**< length so far */</span>
<a name="l00085"></a>00085 <span class="keywordtype">unsigned</span> size; <span class="comment">/**< allocated memory */</span>
<a name="l00086"></a>00086 <span class="keywordtype">unsigned</span> <a class="code" href="bprint_8h.html#acf8cd3996e691221ed7bdb8310ea2fc2">size_max</a>; <span class="comment">/**< maximum allocated memory */</span>
<a name="l00087"></a>00087 <span class="keywordtype">char</span> reserved_internal_buffer[1];
<a name="l00088"></a>00088 )
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment">/**</span>
<a name="l00091"></a>00091 <span class="comment"> * Convenience macros for special values for av_bprint_init() size_max</span>
<a name="l00092"></a>00092 <span class="comment"> * parameter.</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094 #define AV_BPRINT_SIZE_UNLIMITED ((<span class="keywordtype">unsigned</span>)-1)
<a name="l00095"></a>00095 <span class="preprocessor">#define AV_BPRINT_SIZE_AUTOMATIC 1</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span><span class="preprocessor">#define AV_BPRINT_SIZE_COUNT_ONLY 0</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment">/**</span>
<a name="l00099"></a>00099 <span class="comment"> * Init a print buffer.</span>
<a name="l00100"></a>00100 <span class="comment"> *</span>
<a name="l00101"></a>00101 <span class="comment"> * @param buf buffer to init</span>
<a name="l00102"></a>00102 <span class="comment"> * @param size_init initial size (including the final 0)</span>
<a name="l00103"></a>00103 <span class="comment"> * @param size_max maximum size;</span>
<a name="l00104"></a>00104 <span class="comment"> * 0 means do not write anything, just count the length;</span>
<a name="l00105"></a>00105 <span class="comment"> * 1 is replaced by the maximum value for automatic storage;</span>
<a name="l00106"></a>00106 <span class="comment"> * any large value means that the internal buffer will be</span>
<a name="l00107"></a>00107 <span class="comment"> * reallocated as needed up to that limit; -1 is converted to</span>
<a name="l00108"></a>00108 <span class="comment"> * UINT_MAX, the largest limit possible.</span>
<a name="l00109"></a>00109 <span class="comment"> * Check also AV_BPRINT_SIZE_* macros.</span>
<a name="l00110"></a>00110 <span class="comment"> */</span>
<a name="l00111"></a><a class="code" href="bprint_8h.html#acf8cd3996e691221ed7bdb8310ea2fc2">00111</a> <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);
<a name="l00112"></a>00112 <span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment">/**</span>
<a name="l00114"></a>00114 <span class="comment"> * Init a print buffer using a pre-existing buffer.</span>
<a name="l00115"></a>00115 <span class="comment"> *</span>
<a name="l00116"></a>00116 <span class="comment"> * The buffer will not be reallocated.</span>
<a name="l00117"></a>00117 <span class="comment"> *</span>
<a name="l00118"></a>00118 <span class="comment"> * @param buf buffer structure to init</span>
<a name="l00119"></a>00119 <span class="comment"> * @param buffer byte buffer to use for the string data</span>
<a name="l00120"></a>00120 <span class="comment"> * @param size size of buffer</span>
<a name="l00121"></a>00121 <span class="comment"> */</span>
<a name="l00122"></a>00122 <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#af70c16532f4ba50c599e4eaa67a1d63b" title="Init a print buffer using a pre-existing buffer.">av_bprint_init_for_buffer</a>(AVBPrint *buf, <span class="keywordtype">char</span> *buffer, <span class="keywordtype">unsigned</span> size);
<a name="l00123"></a>00123 <span class="comment"></span>
<a name="l00124"></a>00124 <span class="comment">/**</span>
<a name="l00125"></a>00125 <span class="comment"> * Append a formatted string to a print buffer.</span>
<a name="l00126"></a>00126 <span class="comment"> */</span>
<a name="l00127"></a>00127 <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#aa2e89377fd7c92db534f29caff1af209" title="Append a formatted string to a print buffer.">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);
<a name="l00128"></a>00128 <span class="comment"></span>
<a name="l00129"></a>00129 <span class="comment">/**</span>
<a name="l00130"></a>00130 <span class="comment"> * Append a formatted string to a print buffer.</span>
<a name="l00131"></a>00131 <span class="comment"> */</span>
<a name="l00132"></a>00132 <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#ae24ca62b5e2ba99651636c04b61240f1" title="Append a formatted string to a print buffer.">av_vbprintf</a>(AVBPrint *buf, const <span class="keywordtype">char</span> *fmt, va_list vl_arg);
<a name="l00133"></a>00133 <span class="comment"></span>
<a name="l00134"></a>00134 <span class="comment">/**</span>
<a name="l00135"></a>00135 <span class="comment"> * Append char c n times to a print buffer.</span>
<a name="l00136"></a>00136 <span class="comment"> */</span>
<a name="l00137"></a>00137 <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#aabc9a9d58de61dd824e625d59a7531bb" title="Append char c n times to a print buffer.">av_bprint_chars</a>(AVBPrint *buf, <span class="keywordtype">char</span> c, <span class="keywordtype">unsigned</span> n);
<a name="l00138"></a>00138 <span class="comment"></span>
<a name="l00139"></a>00139 <span class="comment">/**</span>
<a name="l00140"></a>00140 <span class="comment"> * Append data to a print buffer.</span>
<a name="l00141"></a>00141 <span class="comment"> *</span>
<a name="l00142"></a>00142 <span class="comment"> * param buf bprint buffer to use</span>
<a name="l00143"></a>00143 <span class="comment"> * param data pointer to data</span>
<a name="l00144"></a>00144 <span class="comment"> * param size size of data</span>
<a name="l00145"></a>00145 <span class="comment"> */</span>
<a name="l00146"></a>00146 <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#aa215ba46a975d996e483cf0b9dcc85e5" title="Append data to a print buffer.">av_bprint_append_data</a>(AVBPrint *buf, const <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> size);
<a name="l00147"></a>00147
<a name="l00148"></a>00148 struct tm;<span class="comment"></span>
<a name="l00149"></a>00149 <span class="comment">/**</span>
<a name="l00150"></a>00150 <span class="comment"> * Append a formatted date and time to a print buffer.</span>
<a name="l00151"></a>00151 <span class="comment"> *</span>
<a name="l00152"></a>00152 <span class="comment"> * param buf bprint buffer to use</span>
<a name="l00153"></a>00153 <span class="comment"> * param fmt date and time format string, see strftime()</span>
<a name="l00154"></a>00154 <span class="comment"> * param tm broken-down time structure to translate</span>
<a name="l00155"></a>00155 <span class="comment"> *</span>
<a name="l00156"></a>00156 <span class="comment"> * @note due to poor design of the standard strftime function, it may</span>
<a name="l00157"></a>00157 <span class="comment"> * produce poor results if the format string expands to a very long text and</span>
<a name="l00158"></a>00158 <span class="comment"> * the bprint buffer is near the limit stated by the size_max option.</span>
<a name="l00159"></a>00159 <span class="comment"> */</span>
<a name="l00160"></a>00160 <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#a4896e4efea5b234507bcbba45ca0397b" title="Append a formatted date and time to a print buffer.">av_bprint_strftime</a>(AVBPrint *buf, const <span class="keywordtype">char</span> *fmt, const struct tm *tm);
<a name="l00161"></a>00161 <span class="comment"></span>
<a name="l00162"></a>00162 <span class="comment">/**</span>
<a name="l00163"></a>00163 <span class="comment"> * Allocate bytes in the buffer for external use.</span>
<a name="l00164"></a>00164 <span class="comment"> *</span>
<a name="l00165"></a>00165 <span class="comment"> * @param[in] buf buffer structure</span>
<a name="l00166"></a>00166 <span class="comment"> * @param[in] size required size</span>
<a name="l00167"></a>00167 <span class="comment"> * @param[out] mem pointer to the memory area</span>
<a name="l00168"></a>00168 <span class="comment"> * @param[out] actual_size size of the memory area after allocation;</span>
<a name="l00169"></a>00169 <span class="comment"> * can be larger or smaller than size</span>
<a name="l00170"></a>00170 <span class="comment"> */</span>
<a name="l00171"></a>00171 <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#a32f3999614d90e082602d54a3c5237d6" title="Allocate bytes in the buffer for external use.">av_bprint_get_buffer</a>(AVBPrint *buf, <span class="keywordtype">unsigned</span> size,
<a name="l00172"></a>00172 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **mem, <span class="keywordtype">unsigned</span> *actual_size);
<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"> * Reset the string to "" but keep internal allocated data.</span>
<a name="l00176"></a>00176 <span class="comment"> */</span>
<a name="l00177"></a>00177 <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#ab1c28dbff5990dbd37e6c00e3d7c438b" title="Reset the string to "" but keep internal allocated data.">av_bprint_clear</a>(AVBPrint *buf);
<a name="l00178"></a>00178 <span class="comment"></span>
<a name="l00179"></a>00179 <span class="comment">/**</span>
<a name="l00180"></a>00180 <span class="comment"> * Test if the print buffer is complete (not truncated).</span>
<a name="l00181"></a>00181 <span class="comment"> *</span>
<a name="l00182"></a>00182 <span class="comment"> * It may have been truncated due to a memory allocation failure</span>
<a name="l00183"></a>00183 <span class="comment"> * or the size_max limit (compare size and size_max if necessary).</span>
<a name="l00184"></a>00184 <span class="comment"> */</span>
<a name="l00185"></a><a class="code" href="bprint_8h.html#a07432f704c49a6fa636197e2aa80bac0">00185</a> static inline <span class="keywordtype">int</span> <a class="code" href="bprint_8h.html#a07432f704c49a6fa636197e2aa80bac0" title="Test if the print buffer is complete (not truncated).">av_bprint_is_complete</a>(const AVBPrint *buf)
<a name="l00186"></a>00186 {
<a name="l00187"></a>00187 <span class="keywordflow">return</span> buf->len < buf->size;
<a name="l00188"></a>00188 }
<a name="l00189"></a>00189 <span class="comment"></span>
<a name="l00190"></a>00190 <span class="comment">/**</span>
<a name="l00191"></a>00191 <span class="comment"> * Finalize a print buffer.</span>
<a name="l00192"></a>00192 <span class="comment"> *</span>
<a name="l00193"></a>00193 <span class="comment"> * The print buffer can no longer be used afterwards,</span>
<a name="l00194"></a>00194 <span class="comment"> * but the len and size fields are still valid.</span>
<a name="l00195"></a>00195 <span class="comment"> *</span>
<a name="l00196"></a>00196 <span class="comment"> * @arg[out] ret_str if not NULL, used to return a permanent copy of the</span>
<a name="l00197"></a>00197 <span class="comment"> * buffer contents, or NULL if memory allocation fails;</span>
<a name="l00198"></a>00198 <span class="comment"> * if NULL, the buffer is discarded and freed</span>
<a name="l00199"></a>00199 <span class="comment"> * @return 0 for success or error code (probably AVERROR(ENOMEM))</span>
<a name="l00200"></a>00200 <span class="comment"> */</span>
<a name="l00201"></a>00201 <span class="keywordtype">int</span> <a class="code" href="bprint_8h.html#a3fd45f50d9d4f7cc8fed5331a37f47ea" title="Finalize a print buffer.">av_bprint_finalize</a>(AVBPrint *buf, <span class="keywordtype">char</span> **ret_str);
<a name="l00202"></a>00202 <span class="comment"></span>
<a name="l00203"></a>00203 <span class="comment">/**</span>
<a name="l00204"></a>00204 <span class="comment"> * Escape the content in src and append it to dstbuf.</span>
<a name="l00205"></a>00205 <span class="comment"> *</span>
<a name="l00206"></a>00206 <span class="comment"> * @param dstbuf already inited destination bprint buffer</span>
<a name="l00207"></a>00207 <span class="comment"> * @param src string containing the text to escape</span>
<a name="l00208"></a>00208 <span class="comment"> * @param special_chars string containing the special characters which</span>
<a name="l00209"></a>00209 <span class="comment"> * need to be escaped, can be NULL</span>
<a name="l00210"></a>00210 <span class="comment"> * @param mode escape mode to employ, see AV_ESCAPE_MODE_* macros.</span>
<a name="l00211"></a>00211 <span class="comment"> * Any unknown value for mode will be considered equivalent to</span>
<a name="l00212"></a>00212 <span class="comment"> * AV_ESCAPE_MODE_BACKSLASH, but this behaviour can change without</span>
<a name="l00213"></a>00213 <span class="comment"> * notice.</span>
<a name="l00214"></a>00214 <span class="comment"> * @param flags flags which control how to escape, see AV_ESCAPE_FLAG_* macros</span>
<a name="l00215"></a>00215 <span class="comment"> */</span>
<a name="l00216"></a>00216 <span class="keywordtype">void</span> <a class="code" href="bprint_8h.html#a14ec58eeaa6d4a3571cd9f0ffb873e62" title="Escape the content in src and append it to dstbuf.">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,
<a name="l00217"></a>00217 <span class="keyword">enum</span> <a class="code" href="group__lavu__string.html#gaef885958293f07153383f99db573ff5a">AVEscapeMode</a> mode, <span class="keywordtype">int</span> flags);
<a name="l00218"></a>00218
<a name="l00219"></a>00219 <span class="preprocessor">#endif </span><span class="comment">/* AVUTIL_BPRINT_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>