<!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.7"/>
<title>ALSA project - the C library reference: Sequencer event <-> MIDI byte stream coder</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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">ALSA project - the C library reference
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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 class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Sequencer event <-> MIDI byte stream coder<div class="ingroups"><a class="el" href="group___sequencer.html">MIDI Sequencer</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaf4d255a5c5228aa8d46a9c3e368a0e4b"><td class="memItemLeft" align="right" valign="top">typedef struct snd_midi_event </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a></td></tr>
<tr class="separator:gaf4d255a5c5228aa8d46a9c3e368a0e4b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa3c1797128d84a182197f5dd853c53ec"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_i_d_i___event.html#gaa3c1797128d84a182197f5dd853c53ec">snd_midi_event_new</a> (size_t bufsize, <a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> **rdev)</td></tr>
<tr class="memdesc:gaa3c1797128d84a182197f5dd853c53ec"><td class="mdescLeft"> </td><td class="mdescRight">Creates a MIDI event parser. <a href="#gaa3c1797128d84a182197f5dd853c53ec">More...</a><br /></td></tr>
<tr class="separator:gaa3c1797128d84a182197f5dd853c53ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga22cffc488269968de6cae6796f92ee12"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_i_d_i___event.html#ga22cffc488269968de6cae6796f92ee12">snd_midi_event_resize_buffer</a> (<a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> *dev, size_t bufsize)</td></tr>
<tr class="memdesc:ga22cffc488269968de6cae6796f92ee12"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the MIDI message encoding buffer. <a href="#ga22cffc488269968de6cae6796f92ee12">More...</a><br /></td></tr>
<tr class="separator:ga22cffc488269968de6cae6796f92ee12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga84b9fdddfc1996d0abf759773593931f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_i_d_i___event.html#ga84b9fdddfc1996d0abf759773593931f">snd_midi_event_free</a> (<a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> *dev)</td></tr>
<tr class="memdesc:ga84b9fdddfc1996d0abf759773593931f"><td class="mdescLeft"> </td><td class="mdescRight">Frees a MIDI event parser. <a href="#ga84b9fdddfc1996d0abf759773593931f">More...</a><br /></td></tr>
<tr class="separator:ga84b9fdddfc1996d0abf759773593931f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga670f51a0ce1402b7d03c2a3f5b2801ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_i_d_i___event.html#ga670f51a0ce1402b7d03c2a3f5b2801ed">snd_midi_event_init</a> (<a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> *dev)</td></tr>
<tr class="memdesc:ga670f51a0ce1402b7d03c2a3f5b2801ed"><td class="mdescLeft"> </td><td class="mdescRight">Resets MIDI encode/decode parsers. <a href="#ga670f51a0ce1402b7d03c2a3f5b2801ed">More...</a><br /></td></tr>
<tr class="separator:ga670f51a0ce1402b7d03c2a3f5b2801ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga54a3d6f03dc0f83ae32d7b12b1da7e63"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_i_d_i___event.html#ga54a3d6f03dc0f83ae32d7b12b1da7e63">snd_midi_event_reset_encode</a> (<a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> *dev)</td></tr>
<tr class="memdesc:ga54a3d6f03dc0f83ae32d7b12b1da7e63"><td class="mdescLeft"> </td><td class="mdescRight">Resets MIDI encode parser. <a href="#ga54a3d6f03dc0f83ae32d7b12b1da7e63">More...</a><br /></td></tr>
<tr class="separator:ga54a3d6f03dc0f83ae32d7b12b1da7e63"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1d6bd40b70cdd77e500b25e6eec19484"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_i_d_i___event.html#ga1d6bd40b70cdd77e500b25e6eec19484">snd_midi_event_reset_decode</a> (<a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> *dev)</td></tr>
<tr class="memdesc:ga1d6bd40b70cdd77e500b25e6eec19484"><td class="mdescLeft"> </td><td class="mdescRight">Resets MIDI decode parser. <a href="#ga1d6bd40b70cdd77e500b25e6eec19484">More...</a><br /></td></tr>
<tr class="separator:ga1d6bd40b70cdd77e500b25e6eec19484"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c32d90809d0c2d44fb41be0276100df"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_i_d_i___event.html#ga4c32d90809d0c2d44fb41be0276100df">snd_midi_event_no_status</a> (<a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> *dev, int on)</td></tr>
<tr class="memdesc:ga4c32d90809d0c2d44fb41be0276100df"><td class="mdescLeft"> </td><td class="mdescRight">Enables/disables MIDI command merging. <a href="#ga4c32d90809d0c2d44fb41be0276100df">More...</a><br /></td></tr>
<tr class="separator:ga4c32d90809d0c2d44fb41be0276100df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae44531e8091bdd6e97a5b70e7b81ea10"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_i_d_i___event.html#gae44531e8091bdd6e97a5b70e7b81ea10">snd_midi_event_encode</a> (<a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> *dev, const unsigned char *buf, long count, <a class="el" href="structsnd__seq__event__t.html">snd_seq_event_t</a> *ev)</td></tr>
<tr class="memdesc:gae44531e8091bdd6e97a5b70e7b81ea10"><td class="mdescLeft"> </td><td class="mdescRight">Encodes bytes to sequencer event. <a href="#gae44531e8091bdd6e97a5b70e7b81ea10">More...</a><br /></td></tr>
<tr class="separator:gae44531e8091bdd6e97a5b70e7b81ea10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab758a60cfa82dfa28e08ba2e2cbe2149"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_i_d_i___event.html#gab758a60cfa82dfa28e08ba2e2cbe2149">snd_midi_event_encode_byte</a> (<a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> *dev, int c, <a class="el" href="structsnd__seq__event__t.html">snd_seq_event_t</a> *ev)</td></tr>
<tr class="memdesc:gab758a60cfa82dfa28e08ba2e2cbe2149"><td class="mdescLeft"> </td><td class="mdescRight">Encodes byte to sequencer event. <a href="#gab758a60cfa82dfa28e08ba2e2cbe2149">More...</a><br /></td></tr>
<tr class="separator:gab758a60cfa82dfa28e08ba2e2cbe2149"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9ef018a85ec7f61d45d8b17083bf8cc3"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_i_d_i___event.html#ga9ef018a85ec7f61d45d8b17083bf8cc3">snd_midi_event_decode</a> (<a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> *dev, unsigned char *buf, long count, const <a class="el" href="structsnd__seq__event__t.html">snd_seq_event_t</a> *ev)</td></tr>
<tr class="memdesc:ga9ef018a85ec7f61d45d8b17083bf8cc3"><td class="mdescLeft"> </td><td class="mdescRight">Decodes sequencer event to MIDI byte stream. <a href="#ga9ef018a85ec7f61d45d8b17083bf8cc3">More...</a><br /></td></tr>
<tr class="separator:ga9ef018a85ec7f61d45d8b17083bf8cc3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Sequencer event <-> MIDI byte stream coder </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gaf4d255a5c5228aa8d46a9c3e368a0e4b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct snd_midi_event <a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>container for sequencer midi event parsers </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga9ef018a85ec7f61d45d8b17083bf8cc3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long snd_midi_event_decode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> * </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structsnd__seq__event__t.html">snd_seq_event_t</a> * </td>
<td class="paramname"><em>ev</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decodes sequencer event to MIDI byte stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>MIDI event parser. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer for the resulting MIDI byte stream. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes in <em>buf</em>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ev</td><td>The sequencer event to decode. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes written to <em>buf</em>, or a negative error code.</dd></dl>
<p>This function tries to decode the sequencer event into one or more MIDI messages, and writes the raw MIDI byte(s) into <em>buf</em>.</p>
<p>The generated MIDI messages may use running status, unless disabled with <a class="el" href="group___m_i_d_i___event.html#ga4c32d90809d0c2d44fb41be0276100df" title="Enables/disables MIDI command merging. ">snd_midi_event_no_status</a>.</p>
<p>The required buffer size for a sequencer event it as most 12 bytes, except for System Exclusive events (<em>ev->type</em> == <a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a053842a32bef6aac4c8b21b2fc80fc74">SND_SEQ_EVENT_SYSEX</a>) which can have any length (as specified by <em>ev->data.ext.len</em>).</p>
<p>The following sequencer events correspond to MIDI messages:</p><ul>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40aa7359bc2f050a79c5021cfa90d0705f8">SND_SEQ_EVENT_NOTEOFF</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40af35df63c334c5388ff349550e31460c2">SND_SEQ_EVENT_NOTEON</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a6d7adef3e4f2ed96cd7e2def9d541510">SND_SEQ_EVENT_KEYPRESS</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a926c84318eb653c739e1d21fa20a0d95">SND_SEQ_EVENT_CONTROLLER</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40ae8264fb5f3870a1e5f6c2724b916cefd">SND_SEQ_EVENT_PGMCHANGE</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a7eb97df129127eb771e9800da217f1fe">SND_SEQ_EVENT_CHANPRESS</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40ab1bb9ffa38e5247f993f9368a144336b">SND_SEQ_EVENT_PITCHBEND</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a053842a32bef6aac4c8b21b2fc80fc74">SND_SEQ_EVENT_SYSEX</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40ad2bcd713ea5fc228791eb95545cdf23f">SND_SEQ_EVENT_QFRAME</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a04f1e8a2a2201a7fbddf628b127dab39">SND_SEQ_EVENT_SONGPOS</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40afc621686c4f2ac288e24ff8d0aa448bd">SND_SEQ_EVENT_SONGSEL</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a60918a2617fd3435decbf96029994ac1">SND_SEQ_EVENT_TUNE_REQUEST</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a54f38f955c675d0e9624f67befe513b9">SND_SEQ_EVENT_CLOCK</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40aeca878e55b4482dc3d83bbc1c1411f0a">SND_SEQ_EVENT_START</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a85633da32af8af5efa596a7f68cff5c7">SND_SEQ_EVENT_CONTINUE</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a8bda57193eede5c6d45a34a135c8d95d">SND_SEQ_EVENT_STOP</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40af0cd5b4a2aa37ee9b34c6ecdde1b32b2">SND_SEQ_EVENT_SENSING</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40aefe6bb7adade51add7905856d70efc65">SND_SEQ_EVENT_RESET</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a931edc93b65db5e11be1670166a6623b">SND_SEQ_EVENT_CONTROL14</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a83eb21e2fe5bf509d0d9c4a911f0cd36">SND_SEQ_EVENT_NONREGPARAM</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40ae85ad451b5012c5d4f37bec4cb39516c">SND_SEQ_EVENT_REGPARAM</a></li>
</ul>
<dl class="section user"><dt>Errors:</dt><dd><dl>
<dt>-EINVAL</dt>
<dd><em>ev</em> is not a valid sequencer event. </dd>
<dt>-ENOENT</dt>
<dd>The sequencer event does not correspond to one or more MIDI messages. </dd>
<dt>-ENOMEM</dt>
<dd><p class="startdd">The MIDI message(s) would not fit into <em>count</em> bytes.</p>
<p class="enddd"></p>
</dd>
</dl>
</dd></dl>
<dl class="section user"><dt>Conforming to:</dt><dd>LSB 3.2</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___m_i_d_i___event.html#ga1d6bd40b70cdd77e500b25e6eec19484" title="Resets MIDI decode parser. ">snd_midi_event_reset_decode</a>, <a class="el" href="group___m_i_d_i___event.html#ga4c32d90809d0c2d44fb41be0276100df" title="Enables/disables MIDI command merging. ">snd_midi_event_no_status</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae44531e8091bdd6e97a5b70e7b81ea10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long snd_midi_event_encode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> * </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsnd__seq__event__t.html">snd_seq_event_t</a> * </td>
<td class="paramname"><em>ev</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encodes bytes to sequencer event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>MIDI event parser. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer containing bytes of a raw MIDI stream. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes in <em>buf</em>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ev</td><td>Sequencer event. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes consumed, or a negative error code.</dd></dl>
<p>This function tries to use up to <em>count</em> bytes from the beginning of the buffer to encode a sequencer event. If a complete MIDI message has been encoded, the sequencer event is written to <em>ev</em>; otherwise, <em>ev->type</em> is set to <a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a78b0f3e8f6d674f01d3823481c0b90f6">SND_SEQ_EVENT_NONE</a>, and further bytes are required to complete a message.</p>
<p>The buffer in <em>dev</em> is used to hold any bytes of a not-yet-complete MIDI message. If a System Exclusive message is larger than the buffer, the message is split into multiple parts, and a sequencer event is returned at the end of each part.</p>
<p>Any bytes that are not part of a valid MIDI message are silently ignored, i.e., they are consumed without signaling an error.</p>
<p>When this function returns a system exclusive sequencer event (<em>ev->type</em> is <a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a053842a32bef6aac4c8b21b2fc80fc74">SND_SEQ_EVENT_SYSEX</a>), the data pointer (<em>ev->data.ext.ptr</em>) points into the MIDI event parser's buffer. Therefore, the sequencer event can only be used as long as that buffer remains valid, i.e., until the next call to <a class="el" href="group___m_i_d_i___event.html#gae44531e8091bdd6e97a5b70e7b81ea10" title="Encodes bytes to sequencer event. ">snd_midi_event_encode</a>, <a class="el" href="group___m_i_d_i___event.html#gab758a60cfa82dfa28e08ba2e2cbe2149" title="Encodes byte to sequencer event. ">snd_midi_event_encode_byte</a>, <a class="el" href="group___m_i_d_i___event.html#ga22cffc488269968de6cae6796f92ee12" title="Resizes the MIDI message encoding buffer. ">snd_midi_event_resize_buffer</a>, <a class="el" href="group___m_i_d_i___event.html#ga670f51a0ce1402b7d03c2a3f5b2801ed" title="Resets MIDI encode/decode parsers. ">snd_midi_event_init</a>, <a class="el" href="group___m_i_d_i___event.html#ga54a3d6f03dc0f83ae32d7b12b1da7e63" title="Resets MIDI encode parser. ">snd_midi_event_reset_encode</a>, or <a class="el" href="group___m_i_d_i___event.html#ga84b9fdddfc1996d0abf759773593931f" title="Frees a MIDI event parser. ">snd_midi_event_free</a> for that MIDI event parser.</p>
<p>This function can generate any sequencer event that corresponds to a MIDI message, i.e.:</p><ul>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40aa7359bc2f050a79c5021cfa90d0705f8">SND_SEQ_EVENT_NOTEOFF</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40af35df63c334c5388ff349550e31460c2">SND_SEQ_EVENT_NOTEON</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a6d7adef3e4f2ed96cd7e2def9d541510">SND_SEQ_EVENT_KEYPRESS</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a926c84318eb653c739e1d21fa20a0d95">SND_SEQ_EVENT_CONTROLLER</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40ae8264fb5f3870a1e5f6c2724b916cefd">SND_SEQ_EVENT_PGMCHANGE</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a7eb97df129127eb771e9800da217f1fe">SND_SEQ_EVENT_CHANPRESS</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40ab1bb9ffa38e5247f993f9368a144336b">SND_SEQ_EVENT_PITCHBEND</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a053842a32bef6aac4c8b21b2fc80fc74">SND_SEQ_EVENT_SYSEX</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40ad2bcd713ea5fc228791eb95545cdf23f">SND_SEQ_EVENT_QFRAME</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a04f1e8a2a2201a7fbddf628b127dab39">SND_SEQ_EVENT_SONGPOS</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40afc621686c4f2ac288e24ff8d0aa448bd">SND_SEQ_EVENT_SONGSEL</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a60918a2617fd3435decbf96029994ac1">SND_SEQ_EVENT_TUNE_REQUEST</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a54f38f955c675d0e9624f67befe513b9">SND_SEQ_EVENT_CLOCK</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40aeca878e55b4482dc3d83bbc1c1411f0a">SND_SEQ_EVENT_START</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a85633da32af8af5efa596a7f68cff5c7">SND_SEQ_EVENT_CONTINUE</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a8bda57193eede5c6d45a34a135c8d95d">SND_SEQ_EVENT_STOP</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40af0cd5b4a2aa37ee9b34c6ecdde1b32b2">SND_SEQ_EVENT_SENSING</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40aefe6bb7adade51add7905856d70efc65">SND_SEQ_EVENT_RESET</a></li>
</ul>
<p>Some implementations may also be able to generate the following events for a sequence of controller change messages:</p><ul>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a931edc93b65db5e11be1670166a6623b">SND_SEQ_EVENT_CONTROL14</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40a83eb21e2fe5bf509d0d9c4a911f0cd36">SND_SEQ_EVENT_NONREGPARAM</a></li>
<li><a class="el" href="group___seq_events.html#ggaef39e1f267006faf7abc91c3cb32ea40ae85ad451b5012c5d4f37bec4cb39516c">SND_SEQ_EVENT_REGPARAM</a></li>
</ul>
<dl class="section user"><dt>Conforming to:</dt><dd>LSB 3.2</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___m_i_d_i___event.html#gaa3c1797128d84a182197f5dd853c53ec" title="Creates a MIDI event parser. ">snd_midi_event_new</a>, <a class="el" href="group___m_i_d_i___event.html#ga54a3d6f03dc0f83ae32d7b12b1da7e63" title="Resets MIDI encode parser. ">snd_midi_event_reset_encode</a>, <a class="el" href="group___m_i_d_i___event.html#gab758a60cfa82dfa28e08ba2e2cbe2149" title="Encodes byte to sequencer event. ">snd_midi_event_encode_byte</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab758a60cfa82dfa28e08ba2e2cbe2149"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_midi_event_encode_byte </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> * </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsnd__seq__event__t.html">snd_seq_event_t</a> * </td>
<td class="paramname"><em>ev</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encodes byte to sequencer event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>MIDI event parser. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>A byte of a raw MIDI stream. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ev</td><td>Sequencer event. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if a sequenver event has been completed, 0 if more bytes are required to complete an event, or a negative error code.</dd></dl>
<p>This function tries to use the byte <em>c</em> to encode a sequencer event. If a complete MIDI message has been encoded, the sequencer event is written to <em>ev</em>; otherwise, further bytes are required to complete a message.</p>
<p>See also the description of <a class="el" href="group___m_i_d_i___event.html#gae44531e8091bdd6e97a5b70e7b81ea10" title="Encodes bytes to sequencer event. ">snd_midi_event_encode</a>.</p>
<dl class="section user"><dt>Conforming to:</dt><dd>LSB 3.2</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___m_i_d_i___event.html#gaa3c1797128d84a182197f5dd853c53ec" title="Creates a MIDI event parser. ">snd_midi_event_new</a>, <a class="el" href="group___m_i_d_i___event.html#ga54a3d6f03dc0f83ae32d7b12b1da7e63" title="Resets MIDI encode parser. ">snd_midi_event_reset_encode</a>, <a class="el" href="group___m_i_d_i___event.html#gae44531e8091bdd6e97a5b70e7b81ea10" title="Encodes bytes to sequencer event. ">snd_midi_event_encode</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga84b9fdddfc1996d0abf759773593931f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_midi_event_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> * </td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees a MIDI event parser. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>MIDI event parser.</td></tr>
</table>
</dd>
</dl>
<p>Frees a MIDI event parser.</p>
<dl class="section user"><dt>Conforming to:</dt><dd>LSB 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ga670f51a0ce1402b7d03c2a3f5b2801ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_midi_event_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> * </td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets MIDI encode/decode parsers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>MIDI event parser.</td></tr>
</table>
</dd>
</dl>
<p>This function resets both encoder and decoder of the MIDI event parser. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group___m_i_d_i___event.html#ga54a3d6f03dc0f83ae32d7b12b1da7e63" title="Resets MIDI encode parser. ">snd_midi_event_reset_encode</a>, <a class="el" href="group___m_i_d_i___event.html#ga1d6bd40b70cdd77e500b25e6eec19484" title="Resets MIDI decode parser. ">snd_midi_event_reset_decode</a></dd></dl>
<dl class="section user"><dt>Conforming to:</dt><dd>LSB 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="gaa3c1797128d84a182197f5dd853c53ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_midi_event_new </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bufsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> ** </td>
<td class="paramname"><em>rdev</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a MIDI event parser. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">bufsize</td><td>Size of the buffer used for encoding; this should be large enough to hold the largest MIDI message to be encoded. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">rdev</td><td>The new MIDI event parser. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, otherwise a negative error code.</dd></dl>
<p>This function creates and initializes a MIDI parser object that can be used to convert a MIDI byte stream to sequencer events (encoding) and/or to convert sequencer events to a MIDI byte stream (decoding).</p>
<dl class="section user"><dt>Errors:</dt><dd><dl>
<dt>-ENOMEM</dt>
<dd><p class="startdd">Out of memory.</p>
<p class="enddd"></p>
</dd>
</dl>
</dd></dl>
<dl class="section user"><dt>Conforming to:</dt><dd>LSB 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ga4c32d90809d0c2d44fb41be0276100df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_midi_event_no_status </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> * </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>on</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables/disables MIDI command merging. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>MIDI event parser. </td></tr>
<tr><td class="paramname">on</td><td>0 to enable MIDI command merging, 1 to always write the command byte.</td></tr>
</table>
</dd>
</dl>
<p>This function enables or disables MIDI command merging (running status).</p>
<p>When MIDI command merging is not disabled, <a class="el" href="group___m_i_d_i___event.html#ga9ef018a85ec7f61d45d8b17083bf8cc3" title="Decodes sequencer event to MIDI byte stream. ">snd_midi_event_decode</a> is allowed to omit any status byte that is identical to the previous status byte. </p>
</div>
</div>
<a class="anchor" id="ga1d6bd40b70cdd77e500b25e6eec19484"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_midi_event_reset_decode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> * </td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets MIDI decode parser. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>MIDI event parser.</td></tr>
</table>
</dd>
</dl>
<p>This function resets the MIDI decoder of the parser <em>dev</em>. The next decoded message does not use running status from before the call to <em>snd_midi_event_reset_decode</em>.</p>
<dl class="section user"><dt>Conforming to:</dt><dd>LSB 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ga54a3d6f03dc0f83ae32d7b12b1da7e63"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_midi_event_reset_encode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> * </td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets MIDI encode parser. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>MIDI event parser.</td></tr>
</table>
</dd>
</dl>
<p>This function resets the MIDI encoder of the parser <em>dev</em>. Any partially encoded MIDI message is dropped, and running status state is cleared.</p>
<dl class="section user"><dt>Conforming to:</dt><dd>LSB 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ga22cffc488269968de6cae6796f92ee12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_midi_event_resize_buffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___m_i_d_i___event.html#gaf4d255a5c5228aa8d46a9c3e368a0e4b">snd_midi_event_t</a> * </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bufsize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resizes the MIDI message encoding buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>MIDI event parser. </td></tr>
<tr><td class="paramname">bufsize</td><td>The new buffer size. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, otherwise a negative error code.</dd></dl>
<p>This function resizes the buffer that is used to hold partially encoded MIDI messages.</p>
<p>If there is a partially encoded message in the buffer, it is dropped.</p>
<dl class="section user"><dt>Errors:</dt><dd><dl>
<dt>-ENOMEM</dt>
<dd><p class="startdd">Out of memory.</p>
<p class="enddd"></p>
</dd>
</dl>
</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___m_i_d_i___event.html#gae44531e8091bdd6e97a5b70e7b81ea10" title="Encodes bytes to sequencer event. ">snd_midi_event_encode</a>, <a class="el" href="group___m_i_d_i___event.html#ga54a3d6f03dc0f83ae32d7b12b1da7e63" title="Resets MIDI encode parser. ">snd_midi_event_reset_encode</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 18 2014 05:47:50 for ALSA project - the C library reference by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
406d9b580cc28afca9442eab7324087d
>
files
>
103
