/apidocs/echonest.support.midi.DataTypeConverters-module.html
http://echo-nest-remix.googlecode.com/ · HTML · 439 lines · 381 code · 36 blank · 22 comment · 0 complexity · e67663f7ce22d63fcc1a243105222d31 MD5 · raw file
- <?xml version="1.0" encoding="ascii"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <title>echonest.support.midi.DataTypeConverters</title>
- <link rel="stylesheet" href="epydoc.css" type="text/css" />
- <script type="text/javascript" src="epydoc.js"></script>
- </head>
- <body bgcolor="white" text="black" link="blue" vlink="#204080"
- alink="#204080">
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table width="100%" cellpadding="0" cellspacing="0">
- <tr valign="top">
- <td width="100%">
- <span class="breadcrumbs">
- <a href="echonest-module.html">Package echonest</a> ::
- <a href="echonest.support-module.html">Package support</a> ::
- <a href="echonest.support.midi-module.html">Package midi</a> ::
- Module DataTypeConverters
- </span>
- </td>
- <td>
- <table cellpadding="0" cellspacing="0">
- <!-- hide/show private -->
- <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
- onclick="toggle_private();">hide private</a>]</span></td></tr>
- <tr><td align="right"><span class="options"
- >[<a href="frames.html" target="_top">frames</a
- >] | <a href="echonest.support.midi.DataTypeConverters-module.html"
- target="_top">no frames</a>]</span></td></tr>
- </table>
- </td>
- </tr>
- </table>
- <!-- ==================== MODULE DESCRIPTION ==================== -->
- <h1 class="epydoc">Module DataTypeConverters</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html">source code</a></span></p>
- <!-- ==================== FUNCTIONS ==================== -->
- <a name="section-Functions"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Functions</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Functions"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.support.midi.DataTypeConverters-module.html#getNibbles" class="summary-sig-name">getNibbles</a>(<span class="summary-sig-arg">byte</span>)</span><br />
- Returns hi and lo bits in a byte as a tuple
- >>> getNibbles(142)
- (8, 14)</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#getNibbles">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="setNibbles"></a><span class="summary-sig-name">setNibbles</span>(<span class="summary-sig-arg">hiNibble</span>,
- <span class="summary-sig-arg">loNibble</span>)</span><br />
- Returns byte with value set according to hi and lo bits
- Asserts hiNibble and loNibble in range(16)
- >>> setNibbles(8, 14)
- 142</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#setNibbles">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="readBew"></a><span class="summary-sig-name">readBew</span>(<span class="summary-sig-arg">value</span>)</span><br />
- Reads string as big endian word, (asserts len(value) in [1,2,4])
- >>> readBew('aáâã')
- 1642193635L
- >>> readBew('aá')
- 25057</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#readBew">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.support.midi.DataTypeConverters-module.html#writeBew" class="summary-sig-name">writeBew</a>(<span class="summary-sig-arg">value</span>,
- <span class="summary-sig-arg">length</span>)</span><br />
- Write int as big endian formatted string, (asserts length in [1,2,4])
- Difficult to print the result in doctest, so I do a simple roundabout test.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#writeBew">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.support.midi.DataTypeConverters-module.html#readVar" class="summary-sig-name">readVar</a>(<span class="summary-sig-arg">value</span>)</span><br />
- Converts varlength format to integer.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#readVar">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="varLen"></a><span class="summary-sig-name">varLen</span>(<span class="summary-sig-arg">value</span>)</span><br />
- Returns the the number of bytes an integer will be when
- converted to varlength</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#varLen">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="writeVar"></a><span class="summary-sig-name">writeVar</span>(<span class="summary-sig-arg">value</span>)</span><br />
- Converts an integer to varlength format</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#writeVar">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="to_n_bits"></a><span class="summary-sig-name">to_n_bits</span>(<span class="summary-sig-arg">value</span>,
- <span class="summary-sig-arg">length</span>=<span class="summary-sig-default">1</span>,
- <span class="summary-sig-arg">nbits</span>=<span class="summary-sig-default">7</span>)</span><br />
- returns the integer value as a sequence of nbits bytes</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#to_n_bits">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="toBytes"></a><span class="summary-sig-name">toBytes</span>(<span class="summary-sig-arg">value</span>)</span><br />
- Turns a string into a list of byte values</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#toBytes">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="fromBytes"></a><span class="summary-sig-name">fromBytes</span>(<span class="summary-sig-arg">value</span>)</span><br />
- Turns a list of bytes into a string</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#fromBytes">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- </table>
- <!-- ==================== VARIABLES ==================== -->
- <a name="section-Variables"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Variables</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Variables"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'echonest.support.midi'"><code class="variable-quote">'</code><code class="variable-string">echonest.support.midi</code><code class="variable-quote">'</code></code>
- </td>
- </tr>
- </table>
- <!-- ==================== FUNCTION DETAILS ==================== -->
- <a name="section-FunctionDetails"></a>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Function Details</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-FunctionDetails"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <a name="getNibbles"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">getNibbles</span>(<span class="sig-arg">byte</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#getNibbles">source code</a></span>
- </td>
- </tr></table>
-
- <pre class="literalblock">
- Returns hi and lo bits in a byte as a tuple
- >>> getNibbles(142)
- (8, 14)
- Asserts byte value in byte range
- >>> getNibbles(256)
- Traceback (most recent call last):
- ...
- ValueError: Byte value out of range 0-255: 256
- </pre>
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="writeBew"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">writeBew</span>(<span class="sig-arg">value</span>,
- <span class="sig-arg">length</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#writeBew">source code</a></span>
- </td>
- </tr></table>
-
- Write int as big endian formatted string, (asserts length in [1,2,4])
- Difficult to print the result in doctest, so I do a simple roundabout test.
- >>> readBew(writeBew(25057, 2))
- 25057
- >>> readBew(writeBew(1642193635L, 4))
- 1642193635L
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="readVar"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">readVar</span>(<span class="sig-arg">value</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.support.midi.DataTypeConverters-pysrc.html#readVar">source code</a></span>
- </td>
- </tr></table>
-
- Converts varlength format to integer. Just pass it 0 or more chars that
- might be a varlen and it will only use the relevant chars.
- use varLen(readVar(value)) to see how many bytes the integer value takes.
- asserts len(value) >= 0
- >>> readVar('€@')
- 64
- >>> readVar('áâãa')
- 205042145
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <br />
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table border="0" cellpadding="0" cellspacing="0" width="100%%">
- <tr>
- <td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Wed Sep 1 16:08:57 2010
- </td>
- <td align="right" class="footer">
- <a target="mainFrame" href="http://epydoc.sourceforge.net"
- >http://epydoc.sourceforge.net</a>
- </td>
- </tr>
- </table>
- <script type="text/javascript">
- <!--
- // Private objects are initially displayed (because if
- // javascript is turned off then we want them to be
- // visible); but by default, we want to hide them. So hide
- // them unless we have a cookie that says to show them.
- checkCookie();
- // -->
- </script>
- </body>
- </html>