jackaudio.github.com/api/inprocess_8c.html at master · riveravaldez/jackaudio.github.com · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JACK-AUDIO-CONNECTION-KIT: inprocess.c File Reference</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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">JACK-AUDIO-CONNECTION-KIT
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d611c2c1e1e252f8153c91ce21a161f9.html">example-clients</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">inprocess.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This demonstrates the basic concepts for writing a client that runs within the JACK server process.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;memory.h&gt;</code><br />
<code>#include &lt;<a class="el" href="jack_8h_source.html">jack/jack.h</a>&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structport__pair__t.html">port_pair_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a244f7325de6ebc7c003d808fb7c78b72"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="inprocess_8c.html#a244f7325de6ebc7c003d808fb7c78b72">inprocess</a> (<a class="el" href="types_8h.html#aa954df532e901ae5172e68a23f3da9b6">jack_nframes_t</a> nframes, void *arg)</td></tr>
<tr class="separator:a244f7325de6ebc7c003d808fb7c78b72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a872c1ad15ec7ba35574b0bafc91212c9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="inprocess_8c.html#a872c1ad15ec7ba35574b0bafc91212c9">jack_initialize</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *<a class="el" href="simple__client_8c.html#afed7053cd7bdd1cce33dec7213f340ea">client</a>, const char *load_init)</td></tr>
<tr class="separator:a872c1ad15ec7ba35574b0bafc91212c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1343309803bc07aacba7f4fd8f46b0a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="inprocess_8c.html#a1343309803bc07aacba7f4fd8f46b0a3">jack_finish</a> (void *arg)</td></tr>
<tr class="separator:a1343309803bc07aacba7f4fd8f46b0a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This demonstrates the basic concepts for writing a client that runs within the JACK server process. </p>
<p>For the sake of example, a <a class="el" href="structport__pair__t.html">port_pair_t</a> is allocated in <a class="el" href="inprocess_8c.html#a872c1ad15ec7ba35574b0bafc91212c9">jack_initialize()</a>, passed to <a class="el" href="inprocess_8c.html#a244f7325de6ebc7c003d808fb7c78b72">inprocess()</a> as an argument, then freed in <a class="el" href="inprocess_8c.html#a1343309803bc07aacba7f4fd8f46b0a3">jack_finish()</a>. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a244f7325de6ebc7c003d808fb7c78b72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a244f7325de6ebc7c003d808fb7c78b72">&#9670;&nbsp;</a></span>inprocess()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int inprocess </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="types_8h.html#aa954df532e901ae5172e68a23f3da9b6">jack_nframes_t</a>&#160;</td>
          <td class="paramname"><em>nframes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>arg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Called in the realtime thread on every process cycle. The entry point name was passed to <a class="el" href="group__ClientCallbacks.html#gafb5ec9fb4b736606d676c135fb97888b">jack_set_process_callback()</a> from <a class="el" href="inprocess_8c.html#a872c1ad15ec7ba35574b0bafc91212c9">jack_initialize()</a>. Although this is an internal client, its <a class="el" href="simple__client_8c.html#a01271cc6cf692278ae35d0062935d7ae">process()</a> interface is identical to <a class="el" href="simple__client_8c.html">simple_client.c</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful; otherwise <a class="el" href="inprocess_8c.html#a1343309803bc07aacba7f4fd8f46b0a3">jack_finish()</a> will be called and the client terminated immediately. </dd></dl>

<p class="reference">References <a class="el" href="structport__pair__t.html#a24fa0aff892faa49aeb61297d024605e">port_pair_t::input_port</a>, <a class="el" href="group__PortFunctions.html#ga209880b64774dd039c703ea8e3b9ca63">jack_port_get_buffer()</a>, and <a class="el" href="structport__pair__t.html#a3dc6231b538a867d1f310383cf9e60e2">port_pair_t::output_port</a>.</p>

<p class="reference">Referenced by <a class="el" href="inprocess_8c.html#a872c1ad15ec7ba35574b0bafc91212c9">jack_initialize()</a>.</p>

</div>
</div>
<a id="a1343309803bc07aacba7f4fd8f46b0a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1343309803bc07aacba7f4fd8f46b0a3">&#9670;&nbsp;</a></span>jack_finish()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void jack_finish </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>arg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This required entry point is called immediately before the client is unloaded, which could happen due to a call to <a class="el" href="intclient_8h.html#a0cb5e85d41c1d0fd0163a64859ba3672">jack_internal_client_unload()</a>, or a nonzero return from either <a class="el" href="inprocess_8c.html#a872c1ad15ec7ba35574b0bafc91212c9">jack_initialize()</a> or <a class="el" href="inprocess_8c.html#a244f7325de6ebc7c003d808fb7c78b72">inprocess()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">arg</td><td>the same parameter provided to <a class="el" href="inprocess_8c.html#a244f7325de6ebc7c003d808fb7c78b72">inprocess()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a872c1ad15ec7ba35574b0bafc91212c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a872c1ad15ec7ba35574b0bafc91212c9">&#9670;&nbsp;</a></span>jack_initialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int jack_initialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *&#160;</td>
          <td class="paramname"><em>client</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>load_init</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This required entry point is called after the client is loaded by <a class="el" href="intclient_8h.html#aff038e9c251a2cdf4a5ce94d9d0ea88c">jack_internal_client_load()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">client</td><td>pointer to JACK client structure. </td></tr>
    <tr><td class="paramname">load_init</td><td>character string passed to the load operation.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful; otherwise <a class="el" href="inprocess_8c.html#a1343309803bc07aacba7f4fd8f46b0a3">jack_finish()</a> will be called and the client terminated immediately. </dd></dl>

<p class="reference">References <a class="el" href="inprocess_8c.html#a244f7325de6ebc7c003d808fb7c78b72">inprocess()</a>, <a class="el" href="structport__pair__t.html#a24fa0aff892faa49aeb61297d024605e">port_pair_t::input_port</a>, <a class="el" href="group__ClientFunctions.html#ga9800d5b29bd7670d9944a15f6ea0ecf8">jack_activate()</a>, <a class="el" href="group__PortFunctions.html#gae6090e81f2ee23b5c0e432a899085ec8">jack_connect()</a>, <a class="el" href="types_8h.html#a189c90b28518cb24cdb1800a5bfebe1b">JACK_DEFAULT_AUDIO_TYPE</a>, <a class="el" href="group__PortFunctions.html#ga2abf1e9c3fa7d2afae6fd85a6e2ba843">jack_port_name()</a>, <a class="el" href="group__PortFunctions.html#ga3e21d145c3c82d273a889272f0e405e7">jack_port_register()</a>, <a class="el" href="group__ClientCallbacks.html#gafb5ec9fb4b736606d676c135fb97888b">jack_set_process_callback()</a>, <a class="el" href="types_8h.html#acbcada380e9dfdd5bff1296e7156f478a9dea0e7c0d7f57b9674f7c321a5cc50c">JackPortIsInput</a>, <a class="el" href="types_8h.html#acbcada380e9dfdd5bff1296e7156f478aa0e103ad40ec14c6b50120dd85089c26">JackPortIsOutput</a>, and <a class="el" href="structport__pair__t.html#a3dc6231b538a867d1f310383cf9e60e2">port_pair_t::output_port</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>