<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: HRTF Class 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">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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-methods">Public Member Functions</a> |
<a href="classHRTF-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">HRTF Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class represents a complete set of HRTFs.
<a href="classHRTF.html#details">More...</a></p>
<p><code>#include <<a class="el" href="HRTF_8h_source.html">HRTF.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a649b4b72b3b9acccc6f2915445930dae"><td class="memItemLeft" align="right" valign="top"><a id="a649b4b72b3b9acccc6f2915445930dae"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classHRTF.html#a649b4b72b3b9acccc6f2915445930dae">HRTF</a> ()</td></tr>
<tr class="memdesc:a649b4b72b3b9acccc6f2915445930dae"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new empty <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a> object that will instance it own <a class="el" href="classFFTPlan.html" title="Thas class represents an plan object that allows to calculate FFTs and IFFTs.">FFTPlan</a> with default size. <br /></td></tr>
<tr class="separator:a649b4b72b3b9acccc6f2915445930dae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab00a2b6c33eaef760d1f0ca4b53f2217"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classHRTF.html#ab00a2b6c33eaef760d1f0ca4b53f2217">HRTF</a> (std::shared_ptr< <a class="el" href="classFFTPlan.html">FFTPlan</a> > plan)</td></tr>
<tr class="memdesc:ab00a2b6c33eaef760d1f0ca4b53f2217"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new empty <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a> object. <a href="#ab00a2b6c33eaef760d1f0ca4b53f2217">More...</a><br /></td></tr>
<tr class="separator:ab00a2b6c33eaef760d1f0ca4b53f2217"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a421c0926eb2d9041203cc31c58f6efce"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classHRTF.html#a421c0926eb2d9041203cc31c58f6efce">addImpulseResponse</a> (std::shared_ptr< <a class="el" href="classStreamBuffer.html">StreamBuffer</a> > impulseResponse, float azimuth, float elevation)</td></tr>
<tr class="memdesc:a421c0926eb2d9041203cc31c58f6efce"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a> to the class. <a href="#a421c0926eb2d9041203cc31c58f6efce">More...</a><br /></td></tr>
<tr class="separator:a421c0926eb2d9041203cc31c58f6efce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc02f9742c8012ab2384ef446aaae733"><td class="memItemLeft" align="right" valign="top">std::pair< std::shared_ptr< <a class="el" href="classImpulseResponse.html">ImpulseResponse</a> >, std::shared_ptr< <a class="el" href="classImpulseResponse.html">ImpulseResponse</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classHRTF.html#afc02f9742c8012ab2384ef446aaae733">getImpulseResponse</a> (float &azimuth, float &elevation)</td></tr>
<tr class="memdesc:afc02f9742c8012ab2384ef446aaae733"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a pair of HRTFs for a certain azimuth and elevation. <a href="#afc02f9742c8012ab2384ef446aaae733">More...</a><br /></td></tr>
<tr class="separator:afc02f9742c8012ab2384ef446aaae733"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71baab8f4cd4bfa5b60871dfd9404cd7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSpecs.html">Specs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classHRTF.html#a71baab8f4cd4bfa5b60871dfd9404cd7">getSpecs</a> ()</td></tr>
<tr class="memdesc:a71baab8f4cd4bfa5b60871dfd9404cd7"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the specs shared by all the HRTFs. <a href="#a71baab8f4cd4bfa5b60871dfd9404cd7">More...</a><br /></td></tr>
<tr class="separator:a71baab8f4cd4bfa5b60871dfd9404cd7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16311e2287dda1005d903e96352b15ec"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classHRTF.html#a16311e2287dda1005d903e96352b15ec">isEmpty</a> ()</td></tr>
<tr class="memdesc:a16311e2287dda1005d903e96352b15ec"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the state of the <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a> object. <a href="#a16311e2287dda1005d903e96352b15ec">More...</a><br /></td></tr>
<tr class="separator:a16311e2287dda1005d903e96352b15ec"><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 class represents a complete set of HRTFs. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab00a2b6c33eaef760d1f0ca4b53f2217"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab00a2b6c33eaef760d1f0ca4b53f2217">◆ </a></span>HRTF()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">HRTF::HRTF </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classFFTPlan.html">FFTPlan</a> > </td>
<td class="paramname"><em>plan</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new empty <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plan</td><td>A shared pointer to a FFT plan used to transform the impulse responses added. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a421c0926eb2d9041203cc31c58f6efce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a421c0926eb2d9041203cc31c58f6efce">◆ </a></span>addImpulseResponse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool HRTF::addImpulseResponse </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classStreamBuffer.html">StreamBuffer</a> > </td>
<td class="paramname"><em>impulseResponse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>azimuth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>elevation</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a> to the class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">impulseResponse</td><td>A shared pointer to an <a class="el" href="classStreamBuffer.html" title="This sound creates a buffer out of a reader.">StreamBuffer</a> with the <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a>. </td></tr>
<tr><td class="paramname">azimuth</td><td>The azimuth angle of the <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a>. Interval [0,360). </td></tr>
<tr><td class="paramname">elevation</td><td>The elevation angle of the <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the impulse response was added successfully, false otherwise (the specs weren't correct). </dd></dl>
</div>
</div>
<a id="afc02f9742c8012ab2384ef446aaae733"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc02f9742c8012ab2384ef446aaae733">◆ </a></span>getImpulseResponse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::pair<std::shared_ptr<<a class="el" href="classImpulseResponse.html">ImpulseResponse</a>>, std::shared_ptr<<a class="el" href="classImpulseResponse.html">ImpulseResponse</a>> > HRTF::getImpulseResponse </td>
<td>(</td>
<td class="paramtype">float & </td>
<td class="paramname"><em>azimuth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>elevation</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a pair of HRTFs for a certain azimuth and elevation. </p>
<p>If no exact match is found, the closest ones will be chosen (the elevation has priority over the azimuth). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">azimuth</td><td>The desired azimuth angle. If no exact match is found, the value of azimuth will represent the actual azimuth elevation of the chosen <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a>. Interval [0,360) </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">elevation</td><td>The desired elevation angle. If no exact match is found, the value of elevation will represent the actual elevation angle of the chosen <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pair of shared pointers to <a class="el" href="classImpulseResponse.html" title="This class represents an impulse response that can be used in convolution.">ImpulseResponse</a> objects containing the HRTFs for the left (first element) and right (second element) ears. </dd></dl>
</div>
</div>
<a id="a71baab8f4cd4bfa5b60871dfd9404cd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71baab8f4cd4bfa5b60871dfd9404cd7">◆ </a></span>getSpecs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSpecs.html">Specs</a> HRTF::getSpecs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the specs shared by all the HRTFs. </p>
<dl class="section return"><dt>Returns</dt><dd>The shared specs of all the HRTFs. </dd></dl>
</div>
</div>
<a id="a16311e2287dda1005d903e96352b15ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16311e2287dda1005d903e96352b15ec">◆ </a></span>isEmpty()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool HRTF::isEmpty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the state of the <a class="el" href="classHRTF.html" title="This class represents a complete set of HRTFs.">HRTF</a> object. </p>
<dl class="section return"><dt>Returns</dt><dd>True if it is empty, false otherwise. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fx/<a class="el" href="HRTF_8h_source.html">HRTF.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.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
1011
