<?xml version="1.0" encoding="UTF-8"?>
<!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" lang="en_US" xml:lang="en_US">
<head>
<title>libkmid: MidiMapper Class Reference (libkmid)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">libkmid</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">MidiMapper Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="MidiMapper" -->
<p>A Midi Mapper class which defines the way MIDI events are translated (or "mapped") to different ones.
<a href="classMidiMapper.html#details">More...</a></p>
<p><code>#include <<a class="el" href="midimapper_8h_source.html">midimapper.h</a>></code></p>
<p><a href="classMidiMapper-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiMapper.html#a0581eb1b30fa24553b7e15f9414cd932">MidiMapper</a> (const char *name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiMapper.html#ae9a6bf0c03b765875b62fe4375c6c502">~MidiMapper</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiMapper.html#ab9ad5f1abcb26b5270b645ccf5fa4313">loadFile</a> (const char *name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiMapper.html#ab8cb4f67405cd6f42571af7ab5ac6ec6">ok</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uchar </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiMapper.html#a17387e063703eba46a32e7c74e3701ad">channel</a> (uchar chn)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uchar </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiMapper.html#a7f6e49b422e84e432bc9d6f762135e7a">patch</a> (uchar chn, uchar pgm)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uchar </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiMapper.html#a88a6f8a23e19edd34341f921e5617953">key</a> (uchar chn, uchar pgm, uchar note)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiMapper.html#ad9a7003252ca02626cbbcc045a88f818">pitchBender</a> (uchar chn, uchar &lsb, uchar &msb)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiMapper.html#a099a43e7cc820261f04e152bc85db676">controller</a> (uchar chn, uchar &ctl, uchar &v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiMapper.html#abc06401726c20dcaeee0a4848c6b5178">filename</a> (void)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A Midi Mapper class which defines the way MIDI events are translated (or "mapped") to different ones. </p>
<p>This way, when two MIDI devices "talk" in a somehow different way, they can still communicate.</p>
<p>When the user has an external keyboard that is not compatible with the General Midi standard, he can use a MIDI mapper file to play files as if the synthesizer was GM compatible.</p>
<p>Please see the KMid documentation ( <a href="http://www.arrakis.es/~rlarrosa/kmid.html">http://www.arrakis.es/~rlarrosa/kmid.html</a> ) for information on the format of a MIDI mapper definition file, and how they work.</p>
<p>I created this class because I had one of those non-GM keyboards, so it can do everything I needed it to do for my keyboard to work exactly as a GM synth, and a few more things. Currently, it's the most featured MIDI mapper available.</p>
<p>The usage of this class is quite simple, just create an object with a correct filename in the constructor and then use this object as parameter for <a class="el" href="classDeviceManager.html#a8825249454dd2951aa8f6ba3aeb7f551" title="Sets a MidiMapper object to use.">DeviceManager::setMidiMap()</a>.</p>
<p>Midi Mapper </p>
<dl class="version"><dt><b>Version:</b></dt><dd>0.9.5 17/01/2000 </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Antonio Larrosa Jimenez <<a href="mailto:larrosa@kde.org">larrosa@kde.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="midimapper_8h_source.html#l00059">59</a> of file <a class="el" href="midimapper_8h_source.html">midimapper.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0581eb1b30fa24553b7e15f9414cd932"></a><!-- doxytag: member="MidiMapper::MidiMapper" ref="a0581eb1b30fa24553b7e15f9414cd932" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MidiMapper::MidiMapper </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Loads a MIDI Mapper definition from a file. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classMidiMapper.html#abc06401726c20dcaeee0a4848c6b5178" title="Returns the path and name of the file which the object loaded the mapper from.">filename()</a> </dd></dl>
<p>Definition at line <a class="el" href="midimapper_8cc_source.html#l00034">34</a> of file <a class="el" href="midimapper_8cc_source.html">midimapper.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ae9a6bf0c03b765875b62fe4375c6c502"></a><!-- doxytag: member="MidiMapper::~MidiMapper" ref="ae9a6bf0c03b765875b62fe4375c6c502" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MidiMapper::~MidiMapper </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="midimapper_8cc_source.html#l00056">56</a> of file <a class="el" href="midimapper_8cc_source.html">midimapper.cc</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a17387e063703eba46a32e7c74e3701ad"></a><!-- doxytag: member="MidiMapper::channel" ref="a17387e063703eba46a32e7c74e3701ad" args="(uchar chn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uchar MidiMapper::channel </td>
<td>(</td>
<td class="paramtype">uchar </td>
<td class="paramname"><em>chn</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the channel which chn should be mapped to. </p>
<p>Definition at line <a class="el" href="midimapper_8h_source.html#l00177">177</a> of file <a class="el" href="midimapper_8h_source.html">midimapper.h</a>.</p>
</div>
</div>
<a class="anchor" id="a099a43e7cc820261f04e152bc85db676"></a><!-- doxytag: member="MidiMapper::controller" ref="a099a43e7cc820261f04e152bc85db676" args="(uchar chn, uchar &ctl, uchar &v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiMapper::controller </td>
<td>(</td>
<td class="paramtype">uchar </td>
<td class="paramname"><em>chn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uchar & </td>
<td class="paramname"><em>ctl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uchar & </td>
<td class="paramname"><em>v</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value which a given controller and its value should be mapped to when played on channel chn. </p>
<p>Definition at line <a class="el" href="midimapper_8cc_source.html#l00453">453</a> of file <a class="el" href="midimapper_8cc_source.html">midimapper.cc</a>.</p>
</div>
</div>
<a class="anchor" id="abc06401726c20dcaeee0a4848c6b5178"></a><!-- doxytag: member="MidiMapper::filename" ref="abc06401726c20dcaeee0a4848c6b5178" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * MidiMapper::filename </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the path and name of the file which the object loaded the mapper from. </p>
<p>Definition at line <a class="el" href="midimapper_8cc_source.html#l00418">418</a> of file <a class="el" href="midimapper_8cc_source.html">midimapper.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a88a6f8a23e19edd34341f921e5617953"></a><!-- doxytag: member="MidiMapper::key" ref="a88a6f8a23e19edd34341f921e5617953" args="(uchar chn, uchar pgm, uchar note)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uchar MidiMapper::key </td>
<td>(</td>
<td class="paramtype">uchar </td>
<td class="paramname"><em>chn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uchar </td>
<td class="paramname"><em>pgm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uchar </td>
<td class="paramname"><em>note</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the key that key note playing a pgm patch on channel chn should be mapped to. </p>
<p>Definition at line <a class="el" href="midimapper_8cc_source.html#l00423">423</a> of file <a class="el" href="midimapper_8cc_source.html">midimapper.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ab9ad5f1abcb26b5270b645ccf5fa4313"></a><!-- doxytag: member="MidiMapper::loadFile" ref="ab9ad5f1abcb26b5270b645ccf5fa4313" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiMapper::loadFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads a MIDI Mapper definition file (you don't need to use this if you used a correct filename in constructor). </p>
<p>Definition at line <a class="el" href="midimapper_8cc_source.html#l00143">143</a> of file <a class="el" href="midimapper_8cc_source.html">midimapper.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ab8cb4f67405cd6f42571af7ab5ac6ec6"></a><!-- doxytag: member="MidiMapper::ok" ref="ab8cb4f67405cd6f42571af7ab5ac6ec6" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int MidiMapper::ok </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the status of the object. </p>
<p>Definition at line <a class="el" href="midimapper_8h_source.html#l00172">172</a> of file <a class="el" href="midimapper_8h_source.html">midimapper.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7f6e49b422e84e432bc9d6f762135e7a"></a><!-- doxytag: member="MidiMapper::patch" ref="a7f6e49b422e84e432bc9d6f762135e7a" args="(uchar chn, uchar pgm)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uchar MidiMapper::patch </td>
<td>(</td>
<td class="paramtype">uchar </td>
<td class="paramname"><em>chn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uchar </td>
<td class="paramname"><em>pgm</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the patch which pgm used on channel chn should be mapped to. </p>
<p>Definition at line <a class="el" href="midimapper_8cc_source.html#l00431">431</a> of file <a class="el" href="midimapper_8cc_source.html">midimapper.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ad9a7003252ca02626cbbcc045a88f818"></a><!-- doxytag: member="MidiMapper::pitchBender" ref="ad9a7003252ca02626cbbcc045a88f818" args="(uchar chn, uchar &lsb, uchar &msb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiMapper::pitchBender </td>
<td>(</td>
<td class="paramtype">uchar </td>
<td class="paramname"><em>chn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uchar & </td>
<td class="paramname"><em>lsb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uchar & </td>
<td class="paramname"><em>msb</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value which the pitch bender on channel chn should be mapped to. </p>
<p>Definition at line <a class="el" href="midimapper_8cc_source.html#l00437">437</a> of file <a class="el" href="midimapper_8cc_source.html">midimapper.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="midimapper_8h_source.html">midimapper.h</a></li>
<li><a class="el" href="midimapper_8cc_source.html">midimapper.cc</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>libkmid</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classAlsaOut.html">alsaout</option>, <option value="classDeviceManager.html">devicemanager</option>, <option value="classFMOut.html">fmout</option>, <option value="classGUSOut.html">gusout</option>, <option value="classMidiMapper.html">midimapper</option>, <option value="classMidiOut.html">midiout</option>, <option value="classMidiPlayer.html">midiplayer</option>, <option value="classMidiStatus.html">midistatus</option>, <option value="classMidiTrack.html">miditrack</option>, <option value="classNoteArray.html">notearray</option>, <option value="classSynthOut.html">synthout</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
