File: //usr/share/doc/libvpx-devel/html/vpx__frame__buffer_8h.html
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WebM Codec SDK: vpx/vpx_frame_buffer.h File Reference</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="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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">WebM Codec SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_ce0ab26228883e873492c15423e35021.html">vpx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">vpx_frame_buffer.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Describes the decoder external frame buffer interface.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "./vpx_integer.h"</code><br />
</div>
<p><a href="vpx__frame__buffer_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structvpx__codec__frame__buffer.html">vpx_codec_frame_buffer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">External frame buffer. <a href="structvpx__codec__frame__buffer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a92d4c1a691bffa03789df35386788295"><td class="memItemLeft" align="right" valign="top"><a id="a92d4c1a691bffa03789df35386788295"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vpx__frame__buffer_8h.html#a92d4c1a691bffa03789df35386788295">VPX_MAXIMUM_WORK_BUFFERS</a>   8</td></tr>
<tr class="memdesc:a92d4c1a691bffa03789df35386788295"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of work buffers used by libvpx. Support maximum 4 threads to decode video in parallel. Each thread will use one work buffer. TODO(hkuang): Add support to set number of worker threads dynamically. <br /></td></tr>
<tr class="separator:a92d4c1a691bffa03789df35386788295"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf69f005955646519b1379d5ed67b002"><td class="memItemLeft" align="right" valign="top"><a id="abf69f005955646519b1379d5ed67b002"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vpx__frame__buffer_8h.html#abf69f005955646519b1379d5ed67b002">VP9_MAXIMUM_REF_BUFFERS</a>   8</td></tr>
<tr class="memdesc:abf69f005955646519b1379d5ed67b002"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of reference buffers that a VP9 encoder may use. <br /></td></tr>
<tr class="separator:abf69f005955646519b1379d5ed67b002"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a4de4803ac50d034a9119fde97ef7520b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structvpx__codec__frame__buffer.html">vpx_codec_frame_buffer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vpx__frame__buffer_8h.html#a4de4803ac50d034a9119fde97ef7520b">vpx_codec_frame_buffer_t</a></td></tr>
<tr class="memdesc:a4de4803ac50d034a9119fde97ef7520b"><td class="mdescLeft"> </td><td class="mdescRight">External frame buffer. <a href="#a4de4803ac50d034a9119fde97ef7520b">More...</a><br /></td></tr>
<tr class="separator:a4de4803ac50d034a9119fde97ef7520b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a178a7aeb9acedc2d9e5227cea1301169"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="vpx__frame__buffer_8h.html#a178a7aeb9acedc2d9e5227cea1301169">vpx_get_frame_buffer_cb_fn_t</a>) (void *priv, size_t min_size, <a class="el" href="vpx__frame__buffer_8h.html#a4de4803ac50d034a9119fde97ef7520b">vpx_codec_frame_buffer_t</a> *fb)</td></tr>
<tr class="memdesc:a178a7aeb9acedc2d9e5227cea1301169"><td class="mdescLeft"> </td><td class="mdescRight">get frame buffer callback prototype <a href="#a178a7aeb9acedc2d9e5227cea1301169">More...</a><br /></td></tr>
<tr class="separator:a178a7aeb9acedc2d9e5227cea1301169"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79d9a6a92e4eb753fc2d27f50d996de1"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="vpx__frame__buffer_8h.html#a79d9a6a92e4eb753fc2d27f50d996de1">vpx_release_frame_buffer_cb_fn_t</a>) (void *priv, <a class="el" href="vpx__frame__buffer_8h.html#a4de4803ac50d034a9119fde97ef7520b">vpx_codec_frame_buffer_t</a> *fb)</td></tr>
<tr class="memdesc:a79d9a6a92e4eb753fc2d27f50d996de1"><td class="mdescLeft"> </td><td class="mdescRight">release frame buffer callback prototype <a href="#a79d9a6a92e4eb753fc2d27f50d996de1">More...</a><br /></td></tr>
<tr class="separator:a79d9a6a92e4eb753fc2d27f50d996de1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Describes the decoder external frame buffer interface. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a4de4803ac50d034a9119fde97ef7520b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4de4803ac50d034a9119fde97ef7520b">◆ </a></span>vpx_codec_frame_buffer_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structvpx__codec__frame__buffer.html">vpx_codec_frame_buffer</a> <a class="el" href="vpx__frame__buffer_8h.html#a4de4803ac50d034a9119fde97ef7520b">vpx_codec_frame_buffer_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>External frame buffer. </p>
<p>This structure holds allocated frame buffers used by the decoder. </p>
</div>
</div>
<a id="a178a7aeb9acedc2d9e5227cea1301169"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a178a7aeb9acedc2d9e5227cea1301169">◆ </a></span>vpx_get_frame_buffer_cb_fn_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* vpx_get_frame_buffer_cb_fn_t) (void *priv, size_t min_size, <a class="el" href="vpx__frame__buffer_8h.html#a4de4803ac50d034a9119fde97ef7520b">vpx_codec_frame_buffer_t</a> *fb)</td>
</tr>
</table>
</div><div class="memdoc">
<p>get frame buffer callback prototype </p>
<p>This callback is invoked by the decoder to retrieve data for the frame buffer in order for the decode call to complete. The callback must allocate at least min_size in bytes and assign it to fb->data. The callback must zero out all the data allocated. Then the callback must set fb->size to the allocated size. The application does not need to align the allocated data. The callback is triggered when the decoder needs a frame buffer to decode a compressed image into. This function may be called more than once for every call to vpx_codec_decode. The application may set fb->priv to some data which will be passed back in the ximage and the release function call. |fb| is guaranteed to not be NULL. On success the callback must return 0. Any failure the callback must return a value less than 0.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">priv</td><td>Callback's private data </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">new_size</td><td>Size in bytes needed by the buffer </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">fb</td><td>Pointer to vpx_codec_frame_buffer_t </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a79d9a6a92e4eb753fc2d27f50d996de1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79d9a6a92e4eb753fc2d27f50d996de1">◆ </a></span>vpx_release_frame_buffer_cb_fn_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* vpx_release_frame_buffer_cb_fn_t) (void *priv, <a class="el" href="vpx__frame__buffer_8h.html#a4de4803ac50d034a9119fde97ef7520b">vpx_codec_frame_buffer_t</a> *fb)</td>
</tr>
</table>
</div><div class="memdoc">
<p>release frame buffer callback prototype </p>
<p>This callback is invoked by the decoder when the frame buffer is not referenced by any other buffers. |fb| is guaranteed to not be NULL. On success the callback must return 0. Any failure the callback must return a value less than 0.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">priv</td><td>Callback's private data </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fb</td><td>Pointer to vpx_codec_frame_buffer_t </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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.14
</small></address>
</body>
</html>