Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-release > by-pkgid > 87aded5420321e37af1000cab6d33378 > files > 434

libomxil-bellagio-doc-0.9.3-6.mga5.noarch.rpm

<!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.8"/>
<title>OpenMAXBellagio: queue.c 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</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 style="padding-left: 0.5em;">
   <div id="projectname">OpenMAXBellagio
   &#160;<span id="projectnumber">0.9.3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('queue_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">queue.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;<a class="el" href="queue_8h_source.html">queue.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="omx__comp__debug__levels_8h_source.html">omx_comp_debug_levels.h</a>&quot;</code><br />
</div>
<p><a href="queue_8c_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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8f5abe559cd352d91efb79bc6e1788de"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#a8f5abe559cd352d91efb79bc6e1788de">queue_init</a> (<a class="el" href="structqueue__t.html">queue_t</a> *<a class="el" href="queue_8h.html#a29e8cac7d151c030f0e1ac1c07f18323">queue</a>)</td></tr>
<tr class="separator:a8f5abe559cd352d91efb79bc6e1788de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ed0f920c24a1c31472c8fc571100e37"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#a7ed0f920c24a1c31472c8fc571100e37">queue_deinit</a> (<a class="el" href="structqueue__t.html">queue_t</a> *<a class="el" href="queue_8h.html#a29e8cac7d151c030f0e1ac1c07f18323">queue</a>)</td></tr>
<tr class="separator:a7ed0f920c24a1c31472c8fc571100e37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29e8cac7d151c030f0e1ac1c07f18323"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#a29e8cac7d151c030f0e1ac1c07f18323">queue</a> (<a class="el" href="structqueue__t.html">queue_t</a> *queue, void *data)</td></tr>
<tr class="separator:a29e8cac7d151c030f0e1ac1c07f18323"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada3e91c280824049e9aaa8bb9439bc91"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#ada3e91c280824049e9aaa8bb9439bc91">dequeue</a> (<a class="el" href="structqueue__t.html">queue_t</a> *<a class="el" href="queue_8h.html#a29e8cac7d151c030f0e1ac1c07f18323">queue</a>)</td></tr>
<tr class="separator:ada3e91c280824049e9aaa8bb9439bc91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adebc8aa8d0be687bce26fb8c458c447a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#adebc8aa8d0be687bce26fb8c458c447a">getquenelem</a> (<a class="el" href="structqueue__t.html">queue_t</a> *<a class="el" href="queue_8h.html#a29e8cac7d151c030f0e1ac1c07f18323">queue</a>)</td></tr>
<tr class="separator:adebc8aa8d0be687bce26fb8c458c447a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ada3e91c280824049e9aaa8bb9439bc91"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* dequeue </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
          <td class="paramname"><em>queue</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Dequeue an element from the given queue descriptor</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queue</td><td>the queue descriptor from which to dequeue the element</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the element that has bee dequeued. If the queue is empty a NULL value is returned </dd></dl>

<p>Definition at line <a class="el" href="queue_8c_source.html#l00122">122</a> of file <a class="el" href="queue_8c_source.html">queue.c</a>.</p>

<p>References <a class="el" href="queue_8h_source.html#l00038">qelem_t::data</a>, <a class="el" href="queue_8h_source.html#l00044">queue_t::first</a>, <a class="el" href="queue_8h_source.html#l00047">queue_t::mutex</a>, <a class="el" href="queue_8h_source.html#l00046">queue_t::nelem</a>, and <a class="el" href="queue_8h_source.html#l00037">qelem_t::q_forw</a>.</p>

<p>Referenced by <a class="el" href="omx__base__port_8c_source.html#l00273">base_port_DisablePort()</a>, <a class="el" href="omx__base__port_8c_source.html#l00176">base_port_FlushProcessingBuffers()</a>, <a class="el" href="omx__clocksrc__component_8c_source.html#l00807">clocksrc_port_FlushProcessingBuffers()</a>, <a class="el" href="omx__base__component_8c_source.html#l01438">compMessageHandlerFunction()</a>, <a class="el" href="omx__audiomixer__component_8c_source.html#l00399">omx_audio_mixer_BufferMgmtFunction()</a>, <a class="el" href="omx__base__component_8c_source.html#l00370">omx_base_component_DoStateSet()</a>, <a class="el" href="omx__base__filter_8c_source.html#l00083">omx_base_filter_BufferMgmtFunction()</a>, <a class="el" href="omx__base__sink_8c_source.html#l00067">omx_base_sink_BufferMgmtFunction()</a>, <a class="el" href="omx__base__sink_8c_source.html#l00206">omx_base_sink_twoport_BufferMgmtFunction()</a>, <a class="el" href="omx__base__source_8c_source.html#l00068">omx_base_source_BufferMgmtFunction()</a>, <a class="el" href="omx__base__source_8c_source.html#l00211">omx_base_source_twoport_BufferMgmtFunction()</a>, <a class="el" href="omx__clocksrc__component_8c_source.html#l00628">omx_clocksrc_BufferMgmtFunction()</a>, <a class="el" href="omx__video__scheduler__component_8c_source.html#l00272">omx_video_scheduler_component_ClockPortHandleFunction()</a>, and <a class="el" href="omx__video__scheduler__component_8c_source.html#l00417">omx_video_scheduler_component_port_FlushProcessingBuffers()</a>.</p>

</div>
</div>
<a class="anchor" id="adebc8aa8d0be687bce26fb8c458c447a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int getquenelem </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
          <td class="paramname"><em>queue</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns the number of elements hold in the queue</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queue</td><td>the requested queue</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of elements in the queue </dd></dl>

<p>Definition at line <a class="el" href="queue_8c_source.html#l00143">143</a> of file <a class="el" href="queue_8c_source.html">queue.c</a>.</p>

<p>References <a class="el" href="queue_8h_source.html#l00047">queue_t::mutex</a>, and <a class="el" href="queue_8h_source.html#l00046">queue_t::nelem</a>.</p>

</div>
</div>
<a class="anchor" id="a29e8cac7d151c030f0e1ac1c07f18323"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int queue </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
          <td class="paramname"><em>queue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Enqueue an element to the given queue descriptor</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queue</td><td>the queue descriptor where to queue data</td></tr>
    <tr><td class="paramname">data</td><td>the data to be enqueued</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-1 if the queue is full </dd></dl>

<p>Definition at line <a class="el" href="queue_8c_source.html#l00103">103</a> of file <a class="el" href="queue_8c_source.html">queue.c</a>.</p>

<p>References <a class="el" href="queue_8h_source.html#l00038">qelem_t::data</a>, <a class="el" href="queue_8h_source.html#l00045">queue_t::last</a>, <a class="el" href="queue_8h_source.html#l00047">queue_t::mutex</a>, <a class="el" href="queue_8h_source.html#l00046">queue_t::nelem</a>, and <a class="el" href="queue_8h_source.html#l00037">qelem_t::q_forw</a>.</p>

<p>Referenced by <a class="el" href="omx__base__clock__port_8c_source.html#l00133">base_clock_port_SendBufferFunction()</a>, <a class="el" href="omx__base__port_8c_source.html#l00613">base_port_AllocateTunnelBuffer()</a>, <a class="el" href="omx__base__port_8c_source.html#l00176">base_port_FlushProcessingBuffers()</a>, <a class="el" href="omx__base__port_8c_source.html#l00918">base_port_ReturnBufferFunction()</a>, <a class="el" href="omx__base__port_8c_source.html#l00818">base_port_SendBufferFunction()</a>, <a class="el" href="omx__clocksrc__component_8c_source.html#l00807">clocksrc_port_FlushProcessingBuffers()</a>, <a class="el" href="omx__base__component_8c_source.html#l01289">omx_base_component_SendCommand()</a>, <a class="el" href="omx__video__scheduler__component_8c_source.html#l00417">omx_video_scheduler_component_port_FlushProcessingBuffers()</a>, and <a class="el" href="omx__video__scheduler__component_8c_source.html#l00168">omx_video_scheduler_component_port_SendBufferFunction()</a>.</p>

</div>
</div>
<a class="anchor" id="a7ed0f920c24a1c31472c8fc571100e37"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void queue_deinit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
          <td class="paramname"><em>queue</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Deinitialize a queue descriptor flushing all of its internal data</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queue</td><td>the queue descriptor to dump </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="queue_8c_source.html#l00077">77</a> of file <a class="el" href="queue_8c_source.html">queue.c</a>.</p>

<p>References <a class="el" href="queue_8h_source.html#l00044">queue_t::first</a>, <a class="el" href="queue_8h_source.html#l00032">MAX_QUEUE_ELEMENTS</a>, <a class="el" href="queue_8h_source.html#l00047">queue_t::mutex</a>, and <a class="el" href="queue_8h_source.html#l00037">qelem_t::q_forw</a>.</p>

<p>Referenced by <a class="el" href="omx__base__component_8c_source.html#l00044">base_constructor_remove_garbage_collected()</a>, <a class="el" href="omx__base__port_8c_source.html#l00134">base_port_Destructor()</a>, and <a class="el" href="omx__base__component_8c_source.html#l00271">omx_base_component_Destructor()</a>.</p>

</div>
</div>
<a class="anchor" id="a8f5abe559cd352d91efb79bc6e1788de"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int queue_init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
          <td class="paramname"><em>queue</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p><a class="el" href="queue_8c.html">src/queue.c</a></p>
<p>Implements a simple FIFO structure used for queueing OMX buffers.</p>
<p>Copyright (C) 2007-2009 STMicroelectronics Copyright (C) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).</p>
<p>This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.</p>
<p>This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Initialize a queue descriptor</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queue</td><td>The queue descriptor to initialize. The user needs to allocate the queue </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="queue_8c_source.html#l00038">38</a> of file <a class="el" href="queue_8c_source.html">queue.c</a>.</p>

<p>References <a class="el" href="queue_8h_source.html#l00044">queue_t::first</a>, <a class="el" href="queue_8h_source.html#l00045">queue_t::last</a>, <a class="el" href="queue_8h_source.html#l00032">MAX_QUEUE_ELEMENTS</a>, <a class="el" href="queue_8h_source.html#l00047">queue_t::mutex</a>, <a class="el" href="queue_8h_source.html#l00046">queue_t::nelem</a>, and <a class="el" href="queue_8h_source.html#l00037">qelem_t::q_forw</a>.</p>

<p>Referenced by <a class="el" href="omx__base__port_8c_source.html#l00055">base_port_Constructor()</a>, and <a class="el" href="omx__base__component_8c_source.html#l00095">omx_base_component_Constructor()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<html>
<body>
<hr size="1"><small>Generated for OpenMAX Bellagio rel. 0.9.3 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small>
<br>
<a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=160680&amp;type=4" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a>
</body>
</html>