Mercurial > hg > vamp-website
view code-doc/vamp-sdk_2RealTime_8h-source.html @ 21:cc0be37dc9d3 website
* Updates for 2.0
| author | cannam |
|---|---|
| date | Tue, 09 Dec 2008 11:02:57 +0000 |
| parents | |
| children | 0976232e353b |
line wrap: on
line source
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VampPluginSDK: RealTime.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a> </div> </div> <div class="contents"> <h1>vamp-sdk/RealTime.h</h1><a href="vamp-sdk_2RealTime_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span> <a name="l00002"></a>00002 <a name="l00003"></a>00003 <span class="comment">/*</span> <a name="l00004"></a>00004 <span class="comment"> Vamp</span> <a name="l00005"></a>00005 <span class="comment"></span> <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span> <a name="l00007"></a>00007 <span class="comment"></span> <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span> <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span> <a name="l00010"></a>00010 <span class="comment"> </span> <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span> <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span> <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span> <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span> <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span> <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span> <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span> <a name="l00018"></a>00018 <span class="comment"></span> <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span> <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span> <a name="l00021"></a>00021 <span class="comment"></span> <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span> <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span> <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span> <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span> <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span> <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span> <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span> <a name="l00029"></a>00029 <span class="comment"></span> <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span> <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span> <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span> <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span> <a name="l00034"></a>00034 <span class="comment"> authorization.</span> <a name="l00035"></a>00035 <span class="comment">*/</span> <a name="l00036"></a>00036 <a name="l00037"></a>00037 <span class="comment">/*</span> <a name="l00038"></a>00038 <span class="comment"> This is a modified version of a source file from the </span> <a name="l00039"></a>00039 <span class="comment"> Rosegarden MIDI and audio sequencer and notation editor.</span> <a name="l00040"></a>00040 <span class="comment"> This file copyright 2000-2006 Chris Cannam.</span> <a name="l00041"></a>00041 <span class="comment"> Relicensed by the author as detailed above.</span> <a name="l00042"></a>00042 <span class="comment">*/</span> <a name="l00043"></a>00043 <a name="l00044"></a>00044 <span class="preprocessor">#ifndef _VAMP_REAL_TIME_H_</span> <a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_REAL_TIME_H_</span> <a name="l00046"></a>00046 <span class="preprocessor"></span> <a name="l00047"></a>00047 <span class="preprocessor">#include <iostream></span> <a name="l00048"></a>00048 <span class="preprocessor">#include <string></span> <a name="l00049"></a>00049 <a name="l00050"></a>00050 <span class="preprocessor">#ifndef _WIN32</span> <a name="l00051"></a>00051 <span class="preprocessor"></span><span class="keyword">struct </span>timeval; <a name="l00052"></a>00052 <span class="preprocessor">#endif</span> <a name="l00053"></a>00053 <span class="preprocessor"></span> <a name="l00054"></a>00054 <span class="preprocessor">#include "<a class="code" href="plugguard_8h.html">plugguard.h</a>"</span> <a name="l00055"></a>00055 <a class="code" href="plugguard_8h.html#1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(RealTime.h) <a name="l00056"></a>00056 <a name="l00057"></a>00057 namespace Vamp { <a name="l00058"></a>00058 <a name="l00066"></a><a class="code" href="structVamp_1_1RealTime.html">00066</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> <a name="l00067"></a>00067 { <a name="l00068"></a><a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">00068</a> <span class="keywordtype">int</span> sec; <a name="l00069"></a><a class="code" href="structVamp_1_1RealTime.html#2078835bef7bb92514a65b6051cfc6c8">00069</a> <span class="keywordtype">int</span> nsec; <a name="l00070"></a>00070 <a name="l00071"></a><a class="code" href="structVamp_1_1RealTime.html#ace9e2c60af62273e45ccd98d623914c">00071</a> <span class="keywordtype">int</span> usec()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> nsec / 1000; } <a name="l00072"></a><a class="code" href="structVamp_1_1RealTime.html#76e22815db51ae180c38021110da9947">00072</a> <span class="keywordtype">int</span> msec()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> nsec / 1000000; } <a name="l00073"></a>00073 <a name="l00074"></a><a class="code" href="structVamp_1_1RealTime.html#d703be11b7beb07af08ddf133aa2ae79">00074</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a>(): sec(0), nsec(0) {} <a name="l00075"></a>00075 <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a>(<span class="keywordtype">int</span> s, <span class="keywordtype">int</span> n); <a name="l00076"></a>00076 <a name="l00077"></a><a class="code" href="structVamp_1_1RealTime.html#8f4dbd8ef24a0ec6a77dce67fff5434e">00077</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a>(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r) : <a name="l00078"></a>00078 sec(r.sec), nsec(r.nsec) { } <a name="l00079"></a>00079 <a name="l00080"></a>00080 <span class="keyword">static</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> fromSeconds(<span class="keywordtype">double</span> sec); <a name="l00081"></a>00081 <span class="keyword">static</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> fromMilliseconds(<span class="keywordtype">int</span> msec); <a name="l00082"></a>00082 <a name="l00083"></a>00083 <span class="preprocessor">#ifndef _WIN32</span> <a name="l00084"></a>00084 <span class="preprocessor"></span> <span class="keyword">static</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> fromTimeval(<span class="keyword">const</span> <span class="keyword">struct</span> timeval &); <a name="l00085"></a>00085 <span class="preprocessor">#endif</span> <a name="l00086"></a>00086 <span class="preprocessor"></span> <a name="l00087"></a><a class="code" href="structVamp_1_1RealTime.html#db82f838804a9a3ad49988de5944d090">00087</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &operator=(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r) { <a name="l00088"></a>00088 sec = r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a>; nsec = r.<a class="code" href="structVamp_1_1RealTime.html#2078835bef7bb92514a65b6051cfc6c8">nsec</a>; <span class="keywordflow">return</span> *<span class="keyword">this</span>; <a name="l00089"></a>00089 } <a name="l00090"></a>00090 <a name="l00091"></a><a class="code" href="structVamp_1_1RealTime.html#6b74748d1eb4c3c751e7a12aefae0bde">00091</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> operator+(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r)<span class="keyword"> const </span>{ <a name="l00092"></a>00092 <span class="keywordflow">return</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a>(sec + r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a>, nsec + r.<a class="code" href="structVamp_1_1RealTime.html#2078835bef7bb92514a65b6051cfc6c8">nsec</a>); <a name="l00093"></a>00093 } <a name="l00094"></a><a class="code" href="structVamp_1_1RealTime.html#f0360b5b0d23a464025a6823912c6291">00094</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> operator-(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r)<span class="keyword"> const </span>{ <a name="l00095"></a>00095 <span class="keywordflow">return</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a>(sec - r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a>, nsec - r.<a class="code" href="structVamp_1_1RealTime.html#2078835bef7bb92514a65b6051cfc6c8">nsec</a>); <a name="l00096"></a>00096 } <a name="l00097"></a><a class="code" href="structVamp_1_1RealTime.html#f62915355c482f2e1611a52a7f17f5ed">00097</a> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> operator-()<span class="keyword"> const </span>{ <a name="l00098"></a>00098 <span class="keywordflow">return</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a>(-sec, -nsec); <a name="l00099"></a>00099 } <a name="l00100"></a>00100 <a name="l00101"></a><a class="code" href="structVamp_1_1RealTime.html#78e378a5dd0137a6514dca18edda6f9a">00101</a> <span class="keywordtype">bool</span> operator <(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r)<span class="keyword"> const </span>{ <a name="l00102"></a>00102 <span class="keywordflow">if</span> (sec == r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a>) <span class="keywordflow">return</span> nsec < r.<a class="code" href="structVamp_1_1RealTime.html#2078835bef7bb92514a65b6051cfc6c8">nsec</a>; <a name="l00103"></a>00103 <span class="keywordflow">else</span> <span class="keywordflow">return</span> sec < r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a>; <a name="l00104"></a>00104 } <a name="l00105"></a>00105 <a name="l00106"></a><a class="code" href="structVamp_1_1RealTime.html#6f0aced679e2f97133ed63c688b335e4">00106</a> <span class="keywordtype">bool</span> operator >(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r)<span class="keyword"> const </span>{ <a name="l00107"></a>00107 <span class="keywordflow">if</span> (sec == r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a>) <span class="keywordflow">return</span> nsec > r.<a class="code" href="structVamp_1_1RealTime.html#2078835bef7bb92514a65b6051cfc6c8">nsec</a>; <a name="l00108"></a>00108 <span class="keywordflow">else</span> <span class="keywordflow">return</span> sec > r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a>; <a name="l00109"></a>00109 } <a name="l00110"></a>00110 <a name="l00111"></a><a class="code" href="structVamp_1_1RealTime.html#bc5f06b5b9973012cb7453192df3ea5e">00111</a> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r)<span class="keyword"> const </span>{ <a name="l00112"></a>00112 <span class="keywordflow">return</span> (sec == r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a> && nsec == r.<a class="code" href="structVamp_1_1RealTime.html#2078835bef7bb92514a65b6051cfc6c8">nsec</a>); <a name="l00113"></a>00113 } <a name="l00114"></a>00114 <a name="l00115"></a><a class="code" href="structVamp_1_1RealTime.html#e9b0ea7c217163d5327b1a2a0662a90b">00115</a> <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r)<span class="keyword"> const </span>{ <a name="l00116"></a>00116 <span class="keywordflow">return</span> !(r == *<span class="keyword">this</span>); <a name="l00117"></a>00117 } <a name="l00118"></a>00118 <a name="l00119"></a><a class="code" href="structVamp_1_1RealTime.html#5cb785a410e3a91ed3092b7bba22afc3">00119</a> <span class="keywordtype">bool</span> operator>=(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r)<span class="keyword"> const </span>{ <a name="l00120"></a>00120 <span class="keywordflow">if</span> (sec == r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a>) <span class="keywordflow">return</span> nsec >= r.<a class="code" href="structVamp_1_1RealTime.html#2078835bef7bb92514a65b6051cfc6c8">nsec</a>; <a name="l00121"></a>00121 <span class="keywordflow">else</span> <span class="keywordflow">return</span> sec >= r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a>; <a name="l00122"></a>00122 } <a name="l00123"></a>00123 <a name="l00124"></a><a class="code" href="structVamp_1_1RealTime.html#cf4278eec678c558d62bbda6bc1da44e">00124</a> <span class="keywordtype">bool</span> operator<=(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r)<span class="keyword"> const </span>{ <a name="l00125"></a>00125 <span class="keywordflow">if</span> (sec == r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a>) <span class="keywordflow">return</span> nsec <= r.<a class="code" href="structVamp_1_1RealTime.html#2078835bef7bb92514a65b6051cfc6c8">nsec</a>; <a name="l00126"></a>00126 <span class="keywordflow">else</span> <span class="keywordflow">return</span> sec <= r.<a class="code" href="structVamp_1_1RealTime.html#b4d81983384a9f57ce064e6c343f2267">sec</a>; <a name="l00127"></a>00127 } <a name="l00128"></a>00128 <a name="l00129"></a>00129 <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> operator/(<span class="keywordtype">int</span> d) <span class="keyword">const</span>; <a name="l00130"></a>00130 <a name="l00134"></a>00134 <span class="keywordtype">double</span> operator/(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r) <span class="keyword">const</span>; <a name="l00135"></a>00135 <a name="l00140"></a>00140 std::string toString() <span class="keyword">const</span>; <a name="l00141"></a>00141 <a name="l00146"></a>00146 std::string toText(<span class="keywordtype">bool</span> fixedDp = <span class="keyword">false</span>) <span class="keyword">const</span>; <a name="l00147"></a>00147 <a name="l00151"></a>00151 <span class="keyword">static</span> <span class="keywordtype">long</span> realTime2Frame(<span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &r, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate); <a name="l00152"></a>00152 <a name="l00156"></a>00156 <span class="keyword">static</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> frame2RealTime(<span class="keywordtype">long</span> frame, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sampleRate); <a name="l00157"></a>00157 <a name="l00158"></a><a class="code" href="structVamp_1_1RealTime.html#be453371597710148b0fd19bb452f8a9">00158</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> zeroTime; <a name="l00159"></a>00159 }; <a name="l00160"></a>00160 <a name="l00161"></a>00161 std::ostream &<a class="code" href="namespaceVamp.html#85842d554b6abf7bf9ff648b70f39fef">operator<<</a>(std::ostream &out, <span class="keyword">const</span> <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> &rt); <a name="l00162"></a>00162 <a name="l00163"></a>00163 } <a name="l00164"></a>00164 <a name="l00165"></a>00165 <a class="code" href="plugguard_8h.html#c879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(RealTime.h) <a name="l00166"></a>00166 <a name="l00167"></a>00167 <span class="preprocessor">#endif</span> </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>