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 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/threadmessage.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="threadmessage_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"> * This file is part of FFmpeg.</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * FFmpeg is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> * modify it under the terms of the GNU Lesser General Public License</span>
<a name="l00006"></a>00006 <span class="comment"> * as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * FFmpeg is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Lesser General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span>
<a name="l00015"></a>00015 <span class="comment"> * along with FFmpeg; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00016"></a>00016 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00017"></a>00017 <span class="comment"> */</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef AVUTIL_THREADMESSAGE_H</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define AVUTIL_THREADMESSAGE_H</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a><a class="code" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">00022</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> <a class="code" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a>;
<a name="l00023"></a>00023
<a name="l00024"></a><a class="code" href="threadmessage_8h.html#a7fb8bd4d2b779ab5e2044a1b5a5b22f5">00024</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="threadmessage_8h.html#a7fb8bd4d2b779ab5e2044a1b5a5b22f5">AVThreadMessageFlags</a> {
<a name="l00025"></a>00025 <span class="comment"></span>
<a name="l00026"></a>00026 <span class="comment"> /**</span>
<a name="l00027"></a>00027 <span class="comment"> * Perform non-blocking operation.</span>
<a name="l00028"></a>00028 <span class="comment"> * If this flag is set, send and recv operations are non-blocking and</span>
<a name="l00029"></a>00029 <span class="comment"> * return AVERROR(EAGAIN) immediately if they can not proceed.</span>
<a name="l00030"></a>00030 <span class="comment"> */</span>
<a name="l00031"></a><a class="code" href="threadmessage_8h.html#a7fb8bd4d2b779ab5e2044a1b5a5b22f5adc72c40671a489c761960bafc41b1699">00031</a> <a class="code" href="threadmessage_8h.html#a7fb8bd4d2b779ab5e2044a1b5a5b22f5adc72c40671a489c761960bafc41b1699" title="Perform non-blocking operation.">AV_THREAD_MESSAGE_NONBLOCK</a> = 1,
<a name="l00032"></a>00032
<a name="l00033"></a>00033 } <a class="code" href="threadmessage_8h.html#a7fb8bd4d2b779ab5e2044a1b5a5b22f5">AVThreadMessageFlags</a>;
<a name="l00034"></a>00034 <span class="comment"></span>
<a name="l00035"></a>00035 <span class="comment">/**</span>
<a name="l00036"></a>00036 <span class="comment"> * Allocate a new message queue.</span>
<a name="l00037"></a>00037 <span class="comment"> *</span>
<a name="l00038"></a>00038 <span class="comment"> * @param mq pointer to the message queue</span>
<a name="l00039"></a>00039 <span class="comment"> * @param nelem maximum number of elements in the queue</span>
<a name="l00040"></a>00040 <span class="comment"> * @param elsize size of each element in the queue</span>
<a name="l00041"></a>00041 <span class="comment"> * @return >=0 for success; <0 for error, in particular AVERROR(ENOSYS) if</span>
<a name="l00042"></a>00042 <span class="comment"> * lavu was built without thread support</span>
<a name="l00043"></a>00043 <span class="comment"> */</span>
<a name="l00044"></a>00044 <span class="keywordtype">int</span> <a class="code" href="threadmessage_8h.html#a1734b65da48a88e7c78e8a29b1eee139" title="Allocate a new message queue.">av_thread_message_queue_alloc</a>(<a class="code" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> **mq,
<a name="l00045"></a>00045 <span class="keywordtype">unsigned</span> nelem,
<a name="l00046"></a>00046 <span class="keywordtype">unsigned</span> elsize);
<a name="l00047"></a>00047 <span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment">/**</span>
<a name="l00049"></a>00049 <span class="comment"> * Free a message queue.</span>
<a name="l00050"></a>00050 <span class="comment"> *</span>
<a name="l00051"></a>00051 <span class="comment"> * The message queue must no longer be in use by another thread.</span>
<a name="l00052"></a>00052 <span class="comment"> */</span>
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="threadmessage_8h.html#a95727669f1ebba16a6a49ea8b9f2276e" title="Free a message queue.">av_thread_message_queue_free</a>(<a class="code" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> **mq);
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment">/**</span>
<a name="l00056"></a>00056 <span class="comment"> * Send a message on the queue.</span>
<a name="l00057"></a>00057 <span class="comment"> */</span>
<a name="l00058"></a>00058 <span class="keywordtype">int</span> <a class="code" href="threadmessage_8h.html#a873d588ed106d8dde339c4a16411e0b8" title="Send a message on the queue.">av_thread_message_queue_send</a>(<a class="code" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> *mq,
<a name="l00059"></a>00059 <span class="keywordtype">void</span> *msg,
<a name="l00060"></a>00060 <span class="keywordtype">unsigned</span> flags);
<a name="l00061"></a>00061 <span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment">/**</span>
<a name="l00063"></a>00063 <span class="comment"> * Receive a message from the queue.</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a>00065 <span class="keywordtype">int</span> <a class="code" href="threadmessage_8h.html#a0fb9f4909ad77c541f8ba4409b253111" title="Receive a message from the queue.">av_thread_message_queue_recv</a>(<a class="code" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> *mq,
<a name="l00066"></a>00066 <span class="keywordtype">void</span> *msg,
<a name="l00067"></a>00067 <span class="keywordtype">unsigned</span> flags);
<a name="l00068"></a>00068 <span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment">/**</span>
<a name="l00070"></a>00070 <span class="comment"> * Set the sending error code.</span>
<a name="l00071"></a>00071 <span class="comment"> *</span>
<a name="l00072"></a>00072 <span class="comment"> * If the error code is set to non-zero, av_thread_message_queue_recv() will</span>
<a name="l00073"></a>00073 <span class="comment"> * return it immediately when there are no longer available messages.</span>
<a name="l00074"></a>00074 <span class="comment"> * Conventional values, such as AVERROR_EOF or AVERROR(EAGAIN), can be used</span>
<a name="l00075"></a>00075 <span class="comment"> * to cause the receiving thread to stop or suspend its operation.</span>
<a name="l00076"></a>00076 <span class="comment"> */</span>
<a name="l00077"></a>00077 <span class="keywordtype">void</span> <a class="code" href="threadmessage_8h.html#a01981ed85e713e682912ee6e063403ad" title="Set the sending error code.">av_thread_message_queue_set_err_send</a>(<a class="code" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> *mq,
<a name="l00078"></a>00078 <span class="keywordtype">int</span> err);
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment">/**</span>
<a name="l00081"></a>00081 <span class="comment"> * Set the receiving error code.</span>
<a name="l00082"></a>00082 <span class="comment"> *</span>
<a name="l00083"></a>00083 <span class="comment"> * If the error code is set to non-zero, av_thread_message_queue_send() will</span>
<a name="l00084"></a>00084 <span class="comment"> * return it immediately. Conventional values, such as AVERROR_EOF or</span>
<a name="l00085"></a>00085 <span class="comment"> * AVERROR(EAGAIN), can be used to cause the sending thread to stop or</span>
<a name="l00086"></a>00086 <span class="comment"> * suspend its operation.</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a>00088 <span class="keywordtype">void</span> <a class="code" href="threadmessage_8h.html#a6b2b6c47728e7d442b31a49ca8f9f971" title="Set the receiving error code.">av_thread_message_queue_set_err_recv</a>(<a class="code" href="threadmessage_8h.html#afe2b529ed869d4b672f1a4547dd160af">AVThreadMessageQueue</a> *mq,
<a name="l00089"></a>00089 <span class="keywordtype">int</span> err);
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="preprocessor">#endif </span><span class="comment">/* AVUTIL_THREADMESSAGE_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>