<!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"/>
<title>Jack2: JackDriver.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Jack2 <span id="projectnumber">1.9.7</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<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>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>JackDriver.h</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2001 Paul Davis</span>
<a name="l00003"></a>00003 <span class="comment"> Copyright (C) 2004-2008 Grame</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00006"></a>00006 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00007"></a>00007 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00008"></a>00008 <span class="comment"> (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00013"></a>00013 <span class="comment"> GNU General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00016"></a>00016 <span class="comment"> along with this program; if not, write to the Free Software</span>
<a name="l00017"></a>00017 <span class="comment"> Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef __JackDriver__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define __JackDriver__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "types.h"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "JackClientInterface.h"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "JackConstants.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "JackPlatformPlug.h"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "JackClientControl.h"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <list></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="keyword">namespace </span>Jack
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">class </span>JackLockedEngine;
<a name="l00035"></a>00035 <span class="keyword">class </span>JackGraphManager;
<a name="l00036"></a>00036 <span class="keyword">struct </span>JackEngineControl;
<a name="l00037"></a>00037
<a name="l00042"></a><a class="code" href="classJack_1_1JackDriverInterface.html">00042</a> <span class="keyword">class </span>SERVER_EXPORT <a class="code" href="classJack_1_1JackDriverInterface.html" title="The base interface for drivers.">JackDriverInterface</a>
<a name="l00043"></a>00043 {
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <a class="code" href="classJack_1_1JackDriverInterface.html" title="The base interface for drivers.">JackDriverInterface</a>()
<a name="l00048"></a>00048 {}
<a name="l00049"></a>00049 <span class="keyword">virtual</span> ~<a class="code" href="classJack_1_1JackDriverInterface.html" title="The base interface for drivers.">JackDriverInterface</a>()
<a name="l00050"></a>00050 {}
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Open() = 0;
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Open (<span class="keywordtype">bool</span> capturing,
<a name="l00055"></a>00055 <span class="keywordtype">bool</span> playing,
<a name="l00056"></a>00056 <span class="keywordtype">int</span> inchannels,
<a name="l00057"></a>00057 <span class="keywordtype">int</span> outchannels,
<a name="l00058"></a>00058 <span class="keywordtype">bool</span> monitor,
<a name="l00059"></a>00059 <span class="keyword">const</span> <span class="keywordtype">char</span>* capture_driver_name,
<a name="l00060"></a>00060 <span class="keyword">const</span> <span class="keywordtype">char</span>* playback_driver_name,
<a name="l00061"></a>00061 jack_nframes_t capture_latency,
<a name="l00062"></a>00062 jack_nframes_t playback_latency) = 0;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Open(jack_nframes_t buffer_size,
<a name="l00065"></a>00065 jack_nframes_t samplerate,
<a name="l00066"></a>00066 <span class="keywordtype">bool</span> capturing,
<a name="l00067"></a>00067 <span class="keywordtype">bool</span> playing,
<a name="l00068"></a>00068 <span class="keywordtype">int</span> inchannels,
<a name="l00069"></a>00069 <span class="keywordtype">int</span> outchannels,
<a name="l00070"></a>00070 <span class="keywordtype">bool</span> monitor,
<a name="l00071"></a>00071 <span class="keyword">const</span> <span class="keywordtype">char</span>* capture_driver_name,
<a name="l00072"></a>00072 <span class="keyword">const</span> <span class="keywordtype">char</span>* playback_driver_name,
<a name="l00073"></a>00073 jack_nframes_t capture_latency,
<a name="l00074"></a>00074 jack_nframes_t playback_latency) = 0;
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Attach() = 0;
<a name="l00077"></a>00077 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Detach() = 0;
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Read() = 0;
<a name="l00080"></a>00080 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Write() = 0;
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Start() = 0;
<a name="l00083"></a>00083 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Stop() = 0;
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsFixedBufferSize() = 0;
<a name="l00086"></a>00086 <span class="keyword">virtual</span> <span class="keywordtype">int</span> SetBufferSize(jack_nframes_t buffer_size) = 0;
<a name="l00087"></a>00087 <span class="keyword">virtual</span> <span class="keywordtype">int</span> SetSampleRate(jack_nframes_t sample_rate) = 0;
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Process() = 0;
<a name="l00090"></a>00090 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ProcessNull() = 0;
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetMaster(<span class="keywordtype">bool</span> onoff) = 0;
<a name="l00093"></a>00093 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> GetMaster() = 0;
<a name="l00094"></a>00094 <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddSlave(<a class="code" href="classJack_1_1JackDriverInterface.html" title="The base interface for drivers.">JackDriverInterface</a>* slave) = 0;
<a name="l00095"></a>00095 <span class="keyword">virtual</span> <span class="keywordtype">void</span> RemoveSlave(<a class="code" href="classJack_1_1JackDriverInterface.html" title="The base interface for drivers.">JackDriverInterface</a>* slave) = 0;
<a name="l00096"></a>00096 <span class="keyword">virtual</span> std::list<JackDriverInterface*> GetSlaves() = 0;
<a name="l00097"></a>00097 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ProcessSlaves() = 0;
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsRealTime() <span class="keyword">const</span> = 0;
<a name="l00100"></a>00100 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsRunning() <span class="keyword">const</span> = 0;
<a name="l00101"></a>00101 };
<a name="l00102"></a>00102
<a name="l00107"></a><a class="code" href="classJack_1_1JackDriverClientInterface.html">00107</a> <span class="keyword">class </span>SERVER_EXPORT <a class="code" href="classJack_1_1JackDriverClientInterface.html" title="The base interface for drivers clients.">JackDriverClientInterface</a> : <span class="keyword">public</span> <a class="code" href="classJack_1_1JackDriverInterface.html" title="The base interface for drivers.">JackDriverInterface</a>, <span class="keyword">public</span> <a class="code" href="classJack_1_1JackClientInterface.html" title="Client interface.">JackClientInterface</a>
<a name="l00108"></a>00108 {};
<a name="l00109"></a>00109
<a name="l00114"></a>00114 <span class="preprocessor">#define CaptureDriverFlags static_cast<JackPortFlags>(JackPortIsOutput | JackPortIsPhysical | JackPortIsTerminal)</span>
<a name="l00115"></a>00115 <span class="preprocessor"></span><span class="preprocessor">#define PlaybackDriverFlags static_cast<JackPortFlags>(JackPortIsInput | JackPortIsPhysical | JackPortIsTerminal)</span>
<a name="l00116"></a>00116 <span class="preprocessor"></span><span class="preprocessor">#define MonitorDriverFlags static_cast<JackPortFlags>(JackPortIsOutput)</span>
<a name="l00117"></a>00117 <span class="preprocessor"></span>
<a name="l00118"></a><a class="code" href="classJack_1_1JackDriver.html">00118</a> <span class="keyword">class </span>SERVER_EXPORT <a class="code" href="classJack_1_1JackDriver.html">JackDriver</a> : <span class="keyword">public</span> <a class="code" href="classJack_1_1JackDriverClientInterface.html" title="The base interface for drivers clients.">JackDriverClientInterface</a>
<a name="l00119"></a>00119 {
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="keyword">protected</span>:
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="keywordtype">char</span> fCaptureDriverName[JACK_CLIENT_NAME_SIZE + 1];
<a name="l00124"></a>00124 <span class="keywordtype">char</span> fPlaybackDriverName[JACK_CLIENT_NAME_SIZE + 1];
<a name="l00125"></a>00125 <span class="keywordtype">char</span> fAliasName[JACK_CLIENT_NAME_SIZE + 1];
<a name="l00126"></a>00126 jack_nframes_t fCaptureLatency;
<a name="l00127"></a>00127 jack_nframes_t fPlaybackLatency;
<a name="l00128"></a>00128 jack_time_t fBeginDateUst;
<a name="l00129"></a>00129 jack_time_t fEndDateUst;
<a name="l00130"></a>00130 <span class="keywordtype">float</span> fDelayedUsecs;
<a name="l00131"></a>00131 <a class="code" href="classJack_1_1JackLockedEngine.html" title="Locked Engine, access to methods is serialized using a mutex.">JackLockedEngine</a>* fEngine;
<a name="l00132"></a>00132 <a class="code" href="classJack_1_1JackGraphManager.html" title="Graph manager: contains the connection manager and the port array.">JackGraphManager</a>* fGraphManager;
<a name="l00133"></a>00133 <a class="code" href="classJack_1_1JackMachSemaphore.html" title="Inter process synchronization using using Mach semaphore.">JackSynchro</a>* fSynchroTable;
<a name="l00134"></a>00134 <a class="code" href="structJack_1_1JackEngineControl.html" title="Engine control in shared memory.">JackEngineControl</a>* fEngineControl;
<a name="l00135"></a>00135 <a class="code" href="structJack_1_1JackClientControl.html" title="Client control possibly in shared memory.">JackClientControl</a> fClientControl;
<a name="l00136"></a>00136 std::list<JackDriverInterface*> fSlaveList;
<a name="l00137"></a>00137 <span class="keywordtype">bool</span> fIsMaster;
<a name="l00138"></a>00138 <span class="keywordtype">bool</span> fIsRunning;
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="keywordtype">void</span> CycleIncTime();
<a name="l00141"></a>00141 <span class="keywordtype">void</span> CycleTakeBeginTime();
<a name="l00142"></a>00142 <span class="keywordtype">void</span> CycleTakeEndTime();
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <span class="keywordtype">void</span> SetupDriverSync(<span class="keywordtype">int</span> ref, <span class="keywordtype">bool</span> freewheel);
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="keywordtype">void</span> NotifyXRun(jack_time_t callback_usecs, <span class="keywordtype">float</span> delayed_usecs); <span class="comment">// XRun notification sent by the driver</span>
<a name="l00147"></a>00147 <span class="keywordtype">void</span> NotifyBufferSize(jack_nframes_t buffer_size); <span class="comment">// BufferSize notification sent by the driver</span>
<a name="l00148"></a>00148 <span class="keywordtype">void</span> NotifySampleRate(jack_nframes_t sample_rate); <span class="comment">// SampleRate notification sent by the driver</span>
<a name="l00149"></a>00149 <span class="keywordtype">void</span> NotifyFailure(<span class="keywordtype">int</span> code, <span class="keyword">const</span> <span class="keywordtype">char</span>* reason); <span class="comment">// Failure notification sent by the driver</span>
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="keyword">public</span>:
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <a class="code" href="classJack_1_1JackDriver.html">JackDriver</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keyword">const</span> <span class="keywordtype">char</span>* alias, <a class="code" href="classJack_1_1JackLockedEngine.html" title="Locked Engine, access to methods is serialized using a mutex.">JackLockedEngine</a>* engine, <a class="code" href="classJack_1_1JackMachSemaphore.html" title="Inter process synchronization using using Mach semaphore.">JackSynchro</a>* table);
<a name="l00154"></a>00154 <a class="code" href="classJack_1_1JackDriver.html">JackDriver</a>();
<a name="l00155"></a>00155 <span class="keyword">virtual</span> ~<a class="code" href="classJack_1_1JackDriver.html">JackDriver</a>();
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="keywordtype">void</span> SetMaster(<span class="keywordtype">bool</span> onoff);
<a name="l00158"></a>00158 <span class="keywordtype">bool</span> GetMaster();
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <span class="keywordtype">void</span> AddSlave(<a class="code" href="classJack_1_1JackDriverInterface.html" title="The base interface for drivers.">JackDriverInterface</a>* slave);
<a name="l00161"></a>00161 <span class="keywordtype">void</span> RemoveSlave(<a class="code" href="classJack_1_1JackDriverInterface.html" title="The base interface for drivers.">JackDriverInterface</a>* slave);
<a name="l00162"></a>00162 std::list<JackDriverInterface*> GetSlaves()
<a name="l00163"></a>00163 {
<a name="l00164"></a>00164 <span class="keywordflow">return</span> fSlaveList;
<a name="l00165"></a>00165 }
<a name="l00166"></a>00166 <span class="keywordtype">int</span> ProcessSlaves();
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Open();
<a name="l00169"></a>00169
<a name="l00170"></a>00170 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Open (<span class="keywordtype">bool</span> capturing,
<a name="l00171"></a>00171 <span class="keywordtype">bool</span> playing,
<a name="l00172"></a>00172 <span class="keywordtype">int</span> inchannels,
<a name="l00173"></a>00173 <span class="keywordtype">int</span> outchannels,
<a name="l00174"></a>00174 <span class="keywordtype">bool</span> monitor,
<a name="l00175"></a>00175 <span class="keyword">const</span> <span class="keywordtype">char</span>* capture_driver_name,
<a name="l00176"></a>00176 <span class="keyword">const</span> <span class="keywordtype">char</span>* playback_driver_name,
<a name="l00177"></a>00177 jack_nframes_t capture_latency,
<a name="l00178"></a>00178 jack_nframes_t playback_latency);
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Open(jack_nframes_t buffer_size,
<a name="l00181"></a>00181 jack_nframes_t samplerate,
<a name="l00182"></a>00182 <span class="keywordtype">bool</span> capturing,
<a name="l00183"></a>00183 <span class="keywordtype">bool</span> playing,
<a name="l00184"></a>00184 <span class="keywordtype">int</span> inchannels,
<a name="l00185"></a>00185 <span class="keywordtype">int</span> outchannels,
<a name="l00186"></a>00186 <span class="keywordtype">bool</span> monitor,
<a name="l00187"></a>00187 <span class="keyword">const</span> <span class="keywordtype">char</span>* capture_driver_name,
<a name="l00188"></a>00188 <span class="keyword">const</span> <span class="keywordtype">char</span>* playback_driver_name,
<a name="l00189"></a>00189 jack_nframes_t capture_latency,
<a name="l00190"></a>00190 jack_nframes_t playback_latency);
<a name="l00191"></a>00191 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Close();
<a name="l00192"></a>00192
<a name="l00193"></a>00193 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Process();
<a name="l00194"></a>00194 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ProcessNull();
<a name="l00195"></a>00195
<a name="l00196"></a>00196 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Attach();
<a name="l00197"></a>00197 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Detach();
<a name="l00198"></a>00198
<a name="l00199"></a>00199 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Read();
<a name="l00200"></a>00200 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Write();
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Start();
<a name="l00203"></a>00203 <span class="keyword">virtual</span> <span class="keywordtype">int</span> StartSlaves();
<a name="l00204"></a>00204 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Stop();
<a name="l00205"></a>00205 <span class="keyword">virtual</span> <span class="keywordtype">int</span> StopSlaves();
<a name="l00206"></a>00206
<a name="l00207"></a>00207 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsFixedBufferSize();
<a name="l00208"></a>00208 <span class="keyword">virtual</span> <span class="keywordtype">int</span> SetBufferSize(jack_nframes_t buffer_size);
<a name="l00209"></a>00209 <span class="keyword">virtual</span> <span class="keywordtype">int</span> SetSampleRate(jack_nframes_t sample_rate);
<a name="l00210"></a>00210
<a name="l00211"></a>00211 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ClientNotify(<span class="keywordtype">int</span> refnum, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keywordtype">int</span> notify, <span class="keywordtype">int</span> sync, <span class="keyword">const</span> <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> value1, <span class="keywordtype">int</span> value2);
<a name="l00212"></a>00212 <span class="keyword">virtual</span> <a class="code" href="structJack_1_1JackClientControl.html" title="Client control possibly in shared memory.">JackClientControl</a>* GetClientControl() <span class="keyword">const</span>;
<a name="l00213"></a>00213
<a name="l00214"></a>00214 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsRealTime() <span class="keyword">const</span>;
<a name="l00215"></a>00215 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsRunning()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> fIsRunning; }
<a name="l00216"></a>00216 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Initialize(); <span class="comment">// To be called by the wrapping thread Init method when the driver is a "blocking" one</span>
<a name="l00217"></a>00217
<a name="l00218"></a>00218 };
<a name="l00219"></a>00219
<a name="l00220"></a>00220 } <span class="comment">// end of namespace</span>
<a name="l00221"></a>00221
<a name="l00222"></a>00222 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated for Jack2 by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.7.3</small></address>
</body>
</html>
