blob: 65d6e77454b6368c26857126c661dafb764264a1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> TemplateMediaData&lt; ChainClass, max_frags, local_bufsize &gt; class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>MediaData&lt; ChainClass, max_frags, local_bufsize &gt; Class Template Reference<br>
<small>
[<a class="el" href="group__osclutil.html">OSCL Util</a>]</small>
</h1><code>#include &lt;<a class="el" href="oscl__media__data_8h-source.html">oscl_media_data.h</a>&gt;</code>
<p>
<p>Inheritance diagram for MediaData&lt; ChainClass, max_frags, local_bufsize &gt;:
<p><center><img src="classMediaData.png" usemap="#MediaData< ChainClass, max_frags, local_bufsize >_map" border="0" alt=""></center>
<map name="MediaData< ChainClass, max_frags, local_bufsize >_map">
<area href="classBufFragGroup.html" alt="BufFragGroup< ChainClass, max_frags >" shape="rect" coords="0,0,311,24">
</map>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a0">MediaData</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a1">~MediaData</a> ()</td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a2">GetLocalBufsize</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group__osclutil.html#a2">MediaTimestamp</a>&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a3">GetTimestamp</a> () const</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a4">SetTimestamp</a> (<a class="el" href="group__osclutil.html#a2">MediaTimestamp</a> in_timestamp)</td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a5">GetAvailableBufferSize</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classBufFragStatusClass.html#s8">MediaStatusClass::status_t</a>&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a6">GetLocalFragment</a> (<a class="el" href="classBufferFragment.html">BufferFragment</a> &amp;fragment)</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a7">Clear</a> ()</td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a8">IsLocalData</a> (const <a class="el" href="structOsclMemoryFragment.html">OsclMemoryFragment</a> &amp;frag) const</td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a9">GetMediaSize</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classBufferFragment.html">BufferFragment</a> *&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a10">GetMediaFragment</a> (const uint32 idx)</td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#a11">GetNumMediaFrags</a> (const uint32 idx) const</td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classBufFragStatusClass.html#s8">MediaStatusClass::status_t</a>&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#b0">AddLocalFragment</a> (const <a class="el" href="classBufferFragment.html">BufferFragment</a> &amp;frag, int32 location_offset)</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group__osclutil.html#a2">MediaTimestamp</a>&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#n0">timestamp</a></td></tr>
<tr><td nowrap align=right valign=top>uint8&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#n1">localbuf</a> [local_bufsize]</td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#n2">available_localbuf</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classMediaData.html#n3">num_reserved_fragments</a></td></tr>
</table>
<h3>template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt;<br>
class MediaData&lt; ChainClass, max_frags, local_bufsize &gt;</h3>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="MediaData::MediaData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::MediaData </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="MediaData::~MediaData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> virtual MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::~MediaData </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b0" doxytag="MediaData::AddLocalFragment"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classBufFragStatusClass.html#s8">MediaStatusClass::status_t</a> MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::AddLocalFragment </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classBufferFragment.html">BufferFragment</a> &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>frag</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>location_offset</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a7" doxytag="MediaData::Clear"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> virtual void MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::Clear </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classBufFragGroup.html#b0">BufFragGroup&lt; ChainClass, max_frags &gt;</a>. </td>
</tr>
</table>
<a name="a5" doxytag="MediaData::GetAvailableBufferSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> uint32 MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::GetAvailableBufferSize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="MediaData::GetLocalBufsize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> uint32 MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::GetLocalBufsize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a6" doxytag="MediaData::GetLocalFragment"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classBufFragStatusClass.html#s8">MediaStatusClass::status_t</a> MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::GetLocalFragment </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classBufferFragment.html">BufferFragment</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>fragment</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a10" doxytag="MediaData::GetMediaFragment"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classBufferFragment.html">BufferFragment</a>* MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::GetMediaFragment </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const uint32&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>idx</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a9" doxytag="MediaData::GetMediaSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> int MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::GetMediaSize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a11" doxytag="MediaData::GetNumMediaFrags"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> uint32 MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::GetNumMediaFrags </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const uint32&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>idx</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="MediaData::GetTimestamp"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="group__osclutil.html#a2">MediaTimestamp</a> MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::GetTimestamp </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a8" doxytag="MediaData::IsLocalData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> bool MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::IsLocalData </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="structOsclMemoryFragment.html">OsclMemoryFragment</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>frag</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a4" doxytag="MediaData::SetTimestamp"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> void MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::SetTimestamp </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="group__osclutil.html#a2">MediaTimestamp</a>&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>in_timestamp</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Field Documentation</h2>
<a name="n2" doxytag="MediaData::available_localbuf"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> uint32 MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::available_localbuf<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n1" doxytag="MediaData::localbuf"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> uint8 MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::localbuf[local_bufsize]<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n3" doxytag="MediaData::num_reserved_fragments"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> int MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::num_reserved_fragments<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n0" doxytag="MediaData::timestamp"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags, uint32 local_bufsize&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="group__osclutil.html#a2">MediaTimestamp</a> MediaData&lt; ChainClass, max_frags, local_bufsize &gt;::timestamp<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__media__data_8h-source.html">oscl_media_data.h</a></ul>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>