/usr/share/doc/ffmpeg/api/structAVHWDeviceContext.html is in ffmpeg-doc 7:3.4.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FFmpeg: AVHWDeviceContext Struct 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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">FFmpeg
 <span id="projectnumber">3.4.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">AVHWDeviceContext Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e.
<a href="structAVHWDeviceContext.html#details">More...</a></p>
<p><code>#include <<a class="el" href="hwcontext_8h_source.html">libavutil/hwcontext.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a6f5b8377fc69e248d3cc6c51c825911c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structAVClass.html">AVClass</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVHWDeviceContext.html#a6f5b8377fc69e248d3cc6c51c825911c">av_class</a></td></tr>
<tr class="memdesc:a6f5b8377fc69e248d3cc6c51c825911c"><td class="mdescLeft"> </td><td class="mdescRight">A class for logging. <a href="#a6f5b8377fc69e248d3cc6c51c825911c">More...</a><br /></td></tr>
<tr class="separator:a6f5b8377fc69e248d3cc6c51c825911c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c3758c73b0f29925ccb2f60b5c1a803"><td class="memItemLeft" align="right" valign="top"><a class="el" href="hwcontext_8h.html#afd6b9b94d31220b0a46135e3ab5663fc">AVHWDeviceInternal</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVHWDeviceContext.html#a9c3758c73b0f29925ccb2f60b5c1a803">internal</a></td></tr>
<tr class="memdesc:a9c3758c73b0f29925ccb2f60b5c1a803"><td class="mdescLeft"> </td><td class="mdescRight">Private data used internally by libavutil. <a href="#a9c3758c73b0f29925ccb2f60b5c1a803">More...</a><br /></td></tr>
<tr class="separator:a9c3758c73b0f29925ccb2f60b5c1a803"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc92603a11768828ef3aea1f9d089308"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="hwcontext_8h.html#acf25724be4b066a51ad86aa9214b0d34">AVHWDeviceType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVHWDeviceContext.html#abc92603a11768828ef3aea1f9d089308">type</a></td></tr>
<tr class="memdesc:abc92603a11768828ef3aea1f9d089308"><td class="mdescLeft"> </td><td class="mdescRight">This field identifies the underlying API used for hardware access. <a href="#abc92603a11768828ef3aea1f9d089308">More...</a><br /></td></tr>
<tr class="separator:abc92603a11768828ef3aea1f9d089308"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46055b48d1a40445d775b4ae24f77f20"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVHWDeviceContext.html#a46055b48d1a40445d775b4ae24f77f20">hwctx</a></td></tr>
<tr class="memdesc:a46055b48d1a40445d775b4ae24f77f20"><td class="mdescLeft"> </td><td class="mdescRight">The format-specific data, allocated and freed by libavutil along with this context. <a href="#a46055b48d1a40445d775b4ae24f77f20">More...</a><br /></td></tr>
<tr class="separator:a46055b48d1a40445d775b4ae24f77f20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c9a379fa6b08bacadf6af8ea8b84ff5"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVHWDeviceContext.html#a8c9a379fa6b08bacadf6af8ea8b84ff5">free</a> )(struct <a class="el" href="structAVHWDeviceContext.html">AVHWDeviceContext</a> *ctx)</td></tr>
<tr class="memdesc:a8c9a379fa6b08bacadf6af8ea8b84ff5"><td class="mdescLeft"> </td><td class="mdescRight">This field may be set by the caller before calling <a class="el" href="hwcontext_8h.html#a11d8c9101c95cdcab3dbc5b4c03dfd4d" title="Finalize the device context before use. ">av_hwdevice_ctx_init()</a>. <a href="#a8c9a379fa6b08bacadf6af8ea8b84ff5">More...</a><br /></td></tr>
<tr class="separator:a8c9a379fa6b08bacadf6af8ea8b84ff5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2cfd2b41b89acd81c495d1a1d9124c5"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVHWDeviceContext.html#ae2cfd2b41b89acd81c495d1a1d9124c5">user_opaque</a></td></tr>
<tr class="memdesc:ae2cfd2b41b89acd81c495d1a1d9124c5"><td class="mdescLeft"> </td><td class="mdescRight">Arbitrary user data, to be used e.g. <a href="#ae2cfd2b41b89acd81c495d1a1d9124c5">More...</a><br /></td></tr>
<tr class="separator:ae2cfd2b41b89acd81c495d1a1d9124c5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e. </p>
<p>state that is not tied to a concrete processing configuration. E.g., in an API that supports hardware-accelerated encoding and decoding, this struct will (if possible) wrap the state that is common to both encoding and decoding and from which specific instances of encoders or decoders can be derived.</p>
<p>This struct is reference-counted with the AVBuffer mechanism. The <a class="el" href="hwcontext_8h.html#a1cb1f874bb5a0ed7743f9a2b73b47e6e" title="Allocate an AVHWDeviceContext for a given hardware type. ">av_hwdevice_ctx_alloc()</a> constructor yields a reference, whose data field points to the actual <a class="el" href="structAVHWDeviceContext.html" title="This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e. ">AVHWDeviceContext</a>. Further objects derived from <a class="el" href="structAVHWDeviceContext.html" title="This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e. ">AVHWDeviceContext</a> (such as <a class="el" href="structAVHWFramesContext.html" title="This struct describes a set or pool of "hardware" frames (i.e. ">AVHWFramesContext</a>, describing a frame pool with specific properties) will hold an internal reference to it. After all the references are released, the <a class="el" href="structAVHWDeviceContext.html" title="This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e. ">AVHWDeviceContext</a> itself will be freed, optionally invoking a user-specified callback for uninitializing the hardware state. </p>
<p class="definition">Definition at line <a class="el" href="hwcontext_8h_source.html#l00058">58</a> of file <a class="el" href="hwcontext_8h_source.html">hwcontext.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a6f5b8377fc69e248d3cc6c51c825911c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f5b8377fc69e248d3cc6c51c825911c">◆ </a></span>av_class</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structAVClass.html">AVClass</a>* AVHWDeviceContext::av_class</td>
</tr>
</table>
</div><div class="memdoc">
<p>A class for logging. </p>
<p>Set by <a class="el" href="hwcontext_8h.html#a1cb1f874bb5a0ed7743f9a2b73b47e6e" title="Allocate an AVHWDeviceContext for a given hardware type. ">av_hwdevice_ctx_alloc()</a>. </p>
<p class="definition">Definition at line <a class="el" href="hwcontext_8h_source.html#l00062">62</a> of file <a class="el" href="hwcontext_8h_source.html">hwcontext.h</a>.</p>
</div>
</div>
<a id="a9c3758c73b0f29925ccb2f60b5c1a803"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c3758c73b0f29925ccb2f60b5c1a803">◆ </a></span>internal</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="hwcontext_8h.html#afd6b9b94d31220b0a46135e3ab5663fc">AVHWDeviceInternal</a>* AVHWDeviceContext::internal</td>
</tr>
</table>
</div><div class="memdoc">
<p>Private data used internally by libavutil. </p>
<p>Must not be accessed in any way by the caller. </p>
<p class="definition">Definition at line <a class="el" href="hwcontext_8h_source.html#l00068">68</a> of file <a class="el" href="hwcontext_8h_source.html">hwcontext.h</a>.</p>
</div>
</div>
<a id="abc92603a11768828ef3aea1f9d089308"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc92603a11768828ef3aea1f9d089308">◆ </a></span>type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="hwcontext_8h.html#acf25724be4b066a51ad86aa9214b0d34">AVHWDeviceType</a> AVHWDeviceContext::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>This field identifies the underlying API used for hardware access. </p>
<p>This field is set when this struct is allocated and never changed afterwards. </p>
<p class="definition">Definition at line <a class="el" href="hwcontext_8h_source.html#l00076">76</a> of file <a class="el" href="hwcontext_8h_source.html">hwcontext.h</a>.</p>
</div>
</div>
<a id="a46055b48d1a40445d775b4ae24f77f20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46055b48d1a40445d775b4ae24f77f20">◆ </a></span>hwctx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* AVHWDeviceContext::hwctx</td>
</tr>
</table>
</div><div class="memdoc">
<p>The format-specific data, allocated and freed by libavutil along with this context. </p>
<p>Should be cast by the user to the format-specific context defined in the corresponding header (hwcontext_*.h) and filled as described in the documentation before calling <a class="el" href="hwcontext_8h.html#a11d8c9101c95cdcab3dbc5b4c03dfd4d" title="Finalize the device context before use. ">av_hwdevice_ctx_init()</a>.</p>
<p>After calling <a class="el" href="hwcontext_8h.html#a11d8c9101c95cdcab3dbc5b4c03dfd4d" title="Finalize the device context before use. ">av_hwdevice_ctx_init()</a> this struct should not be modified by the caller. </p>
<p class="definition">Definition at line <a class="el" href="hwcontext_8h_source.html#l00089">89</a> of file <a class="el" href="hwcontext_8h_source.html">hwcontext.h</a>.</p>
</div>
</div>
<a id="a8c9a379fa6b08bacadf6af8ea8b84ff5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c9a379fa6b08bacadf6af8ea8b84ff5">◆ </a></span>free</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* AVHWDeviceContext::free) (struct <a class="el" href="structAVHWDeviceContext.html">AVHWDeviceContext</a> *ctx)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This field may be set by the caller before calling <a class="el" href="hwcontext_8h.html#a11d8c9101c95cdcab3dbc5b4c03dfd4d" title="Finalize the device context before use. ">av_hwdevice_ctx_init()</a>. </p>
<p>If non-NULL, this callback will be called when the last reference to this context is unreferenced, immediately before it is freed.</p>
<dl class="section note"><dt>Note</dt><dd>when other objects (e.g an <a class="el" href="structAVHWFramesContext.html" title="This struct describes a set or pool of "hardware" frames (i.e. ">AVHWFramesContext</a>) are derived from this struct, this callback will be invoked after all such child objects are fully uninitialized and their respective destructors invoked. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hwcontext_8h_source.html#l00101">101</a> of file <a class="el" href="hwcontext_8h_source.html">hwcontext.h</a>.</p>
</div>
</div>
<a id="ae2cfd2b41b89acd81c495d1a1d9124c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2cfd2b41b89acd81c495d1a1d9124c5">◆ </a></span>user_opaque</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* AVHWDeviceContext::user_opaque</td>
</tr>
</table>
</div><div class="memdoc">
<p>Arbitrary user data, to be used e.g. </p>
<p>by the <a class="el" href="structAVHWDeviceContext.html#a8c9a379fa6b08bacadf6af8ea8b84ff5" title="This field may be set by the caller before calling av_hwdevice_ctx_init(). ">free()</a> callback. </p>
<p class="definition">Definition at line <a class="el" href="hwcontext_8h_source.html#l00106">106</a> of file <a class="el" href="hwcontext_8h_source.html">hwcontext.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>libavutil/<a class="el" href="hwcontext_8h_source.html">hwcontext.h</a></li>
</ul>
</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.13
</small></address>
</body>
</html>
|