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/threadmessage.h File Reference</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="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">libavutil/threadmessage.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="threadmessage_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="threadmessage_8h.html#a7fb8bd4d2b779ab5e2044a1b5a5b22f5">AVThreadMessageFlags</a> { <a class="el" href="threadmessage_8h.html#a7fb8bd4d2b779ab5e2044a1b5a5b22f5adc72c40671a489c761960bafc41b1699">AV_THREAD_MESSAGE_NONBLOCK</a> = 1
}</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="threadmessage_8h.html#a1734b65da48a88e7c78e8a29b1eee139">av_thread_message_queue_alloc</a> (<a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> **mq, unsigned nelem, unsigned elsize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a new message queue. <a href="#a1734b65da48a88e7c78e8a29b1eee139"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="threadmessage_8h.html#a95727669f1ebba16a6a49ea8b9f2276e">av_thread_message_queue_free</a> (<a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> **mq)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free a message queue. <a href="#a95727669f1ebba16a6a49ea8b9f2276e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="threadmessage_8h.html#a873d588ed106d8dde339c4a16411e0b8">av_thread_message_queue_send</a> (<a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> *mq, void *msg, unsigned flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message on the queue. <a href="#a873d588ed106d8dde339c4a16411e0b8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="threadmessage_8h.html#a0fb9f4909ad77c541f8ba4409b253111">av_thread_message_queue_recv</a> (<a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> *mq, void *msg, unsigned flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a message from the queue. <a href="#a0fb9f4909ad77c541f8ba4409b253111"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="threadmessage_8h.html#a01981ed85e713e682912ee6e063403ad">av_thread_message_queue_set_err_send</a> (<a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> *mq, int err)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the sending error code. <a href="#a01981ed85e713e682912ee6e063403ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="threadmessage_8h.html#a6b2b6c47728e7d442b31a49ca8f9f971">av_thread_message_queue_set_err_recv</a> (<a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> *mq, int err)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the receiving error code. <a href="#a6b2b6c47728e7d442b31a49ca8f9f971"></a><br/></td></tr>
</table>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="afe2b529ed869d4b672f1a4547dd160af"></a><!-- doxytag: member="threadmessage.h::AVThreadMessageQueue" ref="afe2b529ed869d4b672f1a4547dd160af" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> <a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="threadmessage_8h_source.html#l00022">22</a> of file <a class="el" href="threadmessage_8h_source.html">threadmessage.h</a>.</p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a7fb8bd4d2b779ab5e2044a1b5a5b22f5"></a><!-- doxytag: member="threadmessage.h::AVThreadMessageFlags" ref="a7fb8bd4d2b779ab5e2044a1b5a5b22f5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="threadmessage_8h.html#a7fb8bd4d2b779ab5e2044a1b5a5b22f5">AVThreadMessageFlags</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a7fb8bd4d2b779ab5e2044a1b5a5b22f5adc72c40671a489c761960bafc41b1699"></a><!-- doxytag: member="AV_THREAD_MESSAGE_NONBLOCK" ref="a7fb8bd4d2b779ab5e2044a1b5a5b22f5adc72c40671a489c761960bafc41b1699" args="" -->AV_THREAD_MESSAGE_NONBLOCK</em> </td><td>
<p>Perform non-blocking operation. </p>
<p>If this flag is set, send and recv operations are non-blocking and return <a class="el" href="group__lavu__error.html#gae4bb6f165973d09584e0ec0f335f69ca">AVERROR(EAGAIN)</a> immediately if they can not proceed. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="threadmessage_8h_source.html#l00024">24</a> of file <a class="el" href="threadmessage_8h_source.html">threadmessage.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a1734b65da48a88e7c78e8a29b1eee139"></a><!-- doxytag: member="threadmessage.h::av_thread_message_queue_alloc" ref="a1734b65da48a88e7c78e8a29b1eee139" args="(AVThreadMessageQueue **mq, unsigned nelem, unsigned elsize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="threadmessage_8h.html#a1734b65da48a88e7c78e8a29b1eee139">av_thread_message_queue_alloc</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> ** </td>
<td class="paramname"><em>mq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>nelem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>elsize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocate a new message queue. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mq</td><td>pointer to the message queue </td></tr>
<tr><td class="paramname">nelem</td><td>maximum number of elements in the queue </td></tr>
<tr><td class="paramname">elsize</td><td>size of each element in the queue </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>>=0 for success; <0 for error, in particular <a class="el" href="group__lavu__error.html#gae4bb6f165973d09584e0ec0f335f69ca">AVERROR(ENOSYS)</a> if lavu was built without thread support </dd></dl>
</div>
</div>
<a class="anchor" id="a95727669f1ebba16a6a49ea8b9f2276e"></a><!-- doxytag: member="threadmessage.h::av_thread_message_queue_free" ref="a95727669f1ebba16a6a49ea8b9f2276e" args="(AVThreadMessageQueue **mq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="threadmessage_8h.html#a95727669f1ebba16a6a49ea8b9f2276e">av_thread_message_queue_free</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> ** </td>
<td class="paramname"><em>mq</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free a message queue. </p>
<p>The message queue must no longer be in use by another thread. </p>
</div>
</div>
<a class="anchor" id="a873d588ed106d8dde339c4a16411e0b8"></a><!-- doxytag: member="threadmessage.h::av_thread_message_queue_send" ref="a873d588ed106d8dde339c4a16411e0b8" args="(AVThreadMessageQueue *mq, void *msg, unsigned flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="threadmessage_8h.html#a873d588ed106d8dde339c4a16411e0b8">av_thread_message_queue_send</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> * </td>
<td class="paramname"><em>mq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send a message on the queue. </p>
</div>
</div>
<a class="anchor" id="a0fb9f4909ad77c541f8ba4409b253111"></a><!-- doxytag: member="threadmessage.h::av_thread_message_queue_recv" ref="a0fb9f4909ad77c541f8ba4409b253111" args="(AVThreadMessageQueue *mq, void *msg, unsigned flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="threadmessage_8h.html#a0fb9f4909ad77c541f8ba4409b253111">av_thread_message_queue_recv</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> * </td>
<td class="paramname"><em>mq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receive a message from the queue. </p>
</div>
</div>
<a class="anchor" id="a01981ed85e713e682912ee6e063403ad"></a><!-- doxytag: member="threadmessage.h::av_thread_message_queue_set_err_send" ref="a01981ed85e713e682912ee6e063403ad" args="(AVThreadMessageQueue *mq, int err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="threadmessage_8h.html#a01981ed85e713e682912ee6e063403ad">av_thread_message_queue_set_err_send</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> * </td>
<td class="paramname"><em>mq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the sending error code. </p>
<p>If the error code is set to non-zero, <a class="el" href="threadmessage_8h.html#a0fb9f4909ad77c541f8ba4409b253111" title="Receive a message from the queue.">av_thread_message_queue_recv()</a> will return it immediately when there are no longer available messages. Conventional values, such as AVERROR_EOF or <a class="el" href="group__lavu__error.html#gae4bb6f165973d09584e0ec0f335f69ca">AVERROR(EAGAIN)</a>, can be used to cause the receiving thread to stop or suspend its operation. </p>
</div>
</div>
<a class="anchor" id="a6b2b6c47728e7d442b31a49ca8f9f971"></a><!-- doxytag: member="threadmessage.h::av_thread_message_queue_set_err_recv" ref="a6b2b6c47728e7d442b31a49ca8f9f971" args="(AVThreadMessageQueue *mq, int err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="threadmessage_8h.html#a6b2b6c47728e7d442b31a49ca8f9f971">av_thread_message_queue_set_err_recv</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> * </td>
<td class="paramname"><em>mq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the receiving error code. </p>
<p>If the error code is set to non-zero, <a class="el" href="threadmessage_8h.html#a873d588ed106d8dde339c4a16411e0b8" title="Send a message on the queue.">av_thread_message_queue_send()</a> will return it immediately. Conventional values, such as AVERROR_EOF or <a class="el" href="group__lavu__error.html#gae4bb6f165973d09584e0ec0f335f69ca">AVERROR(EAGAIN)</a>, can be used to cause the sending thread to stop or suspend its operation. </p>
</div>
</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>