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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PipeWire: loop.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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">PipeWire
 <span id="projectnumber">0.2.9</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('loop_8h_source.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">loop.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="loop_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* PipeWire</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright © 2018 Wim Taymans</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * to deal in the Software without restriction, including without limitation</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * The above copyright notice and this permission notice (including the next</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * paragraph) shall be included in all copies or substantial portions of the</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef PIPEWIRE_LOOP_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define PIPEWIRE_LOOP_H</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <spa/support/loop.h></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <<a class="code" href="properties_8h.html">pipewire/properties.h</a>></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structpw__loop.html"> 42</a></span> <span class="keyword">struct </span><a class="code" href="structpw__loop.html">pw_loop</a> {</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structpw__loop.html#abab71679705176a16c9e27b3115701c3"> 43</a></span>  <span class="keyword">struct </span>spa_system *<a class="code" href="structpw__loop.html#abab71679705176a16c9e27b3115701c3">system</a>; </div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structpw__loop.html#a4624741580712c167c17bd9242be003f"> 44</a></span>  <span class="keyword">struct </span>spa_loop *<a class="code" href="structpw__loop.html#a4624741580712c167c17bd9242be003f">loop</a>; </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structpw__loop.html#a639de0bfd74cf9e292932aaed15182c5"> 45</a></span>  <span class="keyword">struct </span>spa_loop_control *<a class="code" href="structpw__loop.html#a639de0bfd74cf9e292932aaed15182c5">control</a>; </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structpw__loop.html#ad34e8c247c5a3e9760b1c0fb33a7cc2f"> 46</a></span>  <span class="keyword">struct </span>spa_loop_utils *<a class="code" href="structpw__loop.html#ad34e8c247c5a3e9760b1c0fb33a7cc2f">utils</a>; </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> };</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">struct </span><a class="code" href="structpw__loop.html">pw_loop</a> *</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <a class="code" href="structpw__loop.html#a67a638da8a3914b6fa0aa6d9eda6b6e0">pw_loop_new</a>(<span class="keyword">struct</span> <a class="code" href="structpw__properties.html">pw_properties</a> *properties);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">void</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <a class="code" href="structpw__loop.html#ae7e5a8b4500832184aa06705d3569933">pw_loop_destroy</a>(<span class="keyword">struct</span> <a class="code" href="structpw__loop.html">pw_loop</a> *<a class="code" href="structpw__loop.html#a4624741580712c167c17bd9242be003f">loop</a>);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="loop_8h.html#ac2a7224b391a302d02f75c4803c7f588"> 55</a></span> <span class="preprocessor">#define pw_loop_add_source(l,...) spa_loop_add_source((l)->loop,__VA_ARGS__)</span></div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="loop_8h.html#ad531597a43cad4669d627b2226011067"> 56</a></span> <span class="preprocessor">#define pw_loop_update_source(l,...) spa_loop_update_source(__VA_ARGS__)</span></div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="loop_8h.html#a101116180c84c3ddcad44d06e546e117"> 57</a></span> <span class="preprocessor">#define pw_loop_remove_source(l,...) spa_loop_remove_source(__VA_ARGS__)</span></div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="loop_8h.html#afff39c7f964a4b011c4fc589c6a6ec92"> 58</a></span> <span class="preprocessor">#define pw_loop_invoke(l,...) spa_loop_invoke((l)->loop,__VA_ARGS__)</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="loop_8h.html#a5789fb95e8a0ddd1c4cf8d0143878551"> 60</a></span> <span class="preprocessor">#define pw_loop_get_fd(l) spa_loop_control_get_fd((l)->control)</span></div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="loop_8h.html#abb397780fe21d077fa89d46e187e0ecb"> 61</a></span> <span class="preprocessor">#define pw_loop_add_hook(l,...) spa_loop_control_add_hook((l)->control,__VA_ARGS__)</span></div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="loop_8h.html#a12545a7e053006bf3865618edb6cf275"> 62</a></span> <span class="preprocessor">#define pw_loop_enter(l) spa_loop_control_enter((l)->control)</span></div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="loop_8h.html#a509d8e5f87cb79816ac99afd2765b0e6"> 63</a></span> <span class="preprocessor">#define pw_loop_iterate(l,...) spa_loop_control_iterate((l)->control,__VA_ARGS__)</span></div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="loop_8h.html#a8f6b6e07508edcd3413a05deb93b1bc0"> 64</a></span> <span class="preprocessor">#define pw_loop_leave(l) spa_loop_control_leave((l)->control)</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="loop_8h.html#a6edef1937eb5fc176a6a36485eebf8ad"> 66</a></span> <span class="preprocessor">#define pw_loop_add_io(l,...) spa_loop_utils_add_io((l)->utils,__VA_ARGS__)</span></div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="loop_8h.html#afd0bce4fa062fe5906318bbfa9442d0f"> 67</a></span> <span class="preprocessor">#define pw_loop_update_io(l,...) spa_loop_utils_update_io((l)->utils,__VA_ARGS__)</span></div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="loop_8h.html#a9cd661d2b33b7032f826c58614e91cfd"> 68</a></span> <span class="preprocessor">#define pw_loop_add_idle(l,...) spa_loop_utils_add_idle((l)->utils,__VA_ARGS__)</span></div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="loop_8h.html#a8bea041a509d072fbc54cccdb842944a"> 69</a></span> <span class="preprocessor">#define pw_loop_enable_idle(l,...) spa_loop_utils_enable_idle((l)->utils,__VA_ARGS__)</span></div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="loop_8h.html#ac62ac71350289ac2b1a312761b2bb82c"> 70</a></span> <span class="preprocessor">#define pw_loop_add_event(l,...) spa_loop_utils_add_event((l)->utils,__VA_ARGS__)</span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="loop_8h.html#aa26ce5ccf840db64b7e1de4b3f57de6e"> 71</a></span> <span class="preprocessor">#define pw_loop_signal_event(l,...) spa_loop_utils_signal_event((l)->utils,__VA_ARGS__)</span></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="loop_8h.html#a5e937f4e92704c5b7924c07605d06318"> 72</a></span> <span class="preprocessor">#define pw_loop_add_timer(l,...) spa_loop_utils_add_timer((l)->utils,__VA_ARGS__)</span></div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="loop_8h.html#a358a963dac14b2f6b57404b3fb13bb05"> 73</a></span> <span class="preprocessor">#define pw_loop_update_timer(l,...) spa_loop_utils_update_timer((l)->utils,__VA_ARGS__)</span></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="loop_8h.html#a714ada0b1d2d9092d4e659731ccc4cb8"> 74</a></span> <span class="preprocessor">#define pw_loop_add_signal(l,...) spa_loop_utils_add_signal((l)->utils,__VA_ARGS__)</span></div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="loop_8h.html#a5ca87923bfa2820ee6e73fbf890bac54"> 75</a></span> <span class="preprocessor">#define pw_loop_destroy_source(l,...) spa_loop_utils_destroy_source((l)->utils,__VA_ARGS__)</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> }</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#endif </span><span class="comment">/* PIPEWIRE_LOOP_H */</span><span class="preprocessor"></span></div><div class="ttc" id="structpw__properties_html"><div class="ttname"><a href="structpw__properties.html">pw_properties</a></div><div class="ttdoc">A collection of key/value pairs.</div><div class="ttdef"><b>Definition:</b> properties.h:43</div></div>
<div class="ttc" id="structpw__loop_html"><div class="ttname"><a href="structpw__loop.html">pw_loop</a></div><div class="ttdoc">PipeWire loop object provides an implementation of the spa loop interfaces.</div><div class="ttdef"><b>Definition:</b> loop.h:42</div></div>
<div class="ttc" id="structpw__loop_html_a67a638da8a3914b6fa0aa6d9eda6b6e0"><div class="ttname"><a href="structpw__loop.html#a67a638da8a3914b6fa0aa6d9eda6b6e0">pw_loop::pw_loop_new</a></div><div class="ttdeci">SPA_EXPORT struct pw_loop * pw_loop_new(struct pw_properties *properties)</div><div class="ttdoc">Create a new loop.</div><div class="ttdef"><b>Definition:</b> loop.c:53</div></div>
<div class="ttc" id="structpw__loop_html_a4624741580712c167c17bd9242be003f"><div class="ttname"><a href="structpw__loop.html#a4624741580712c167c17bd9242be003f">pw_loop::loop</a></div><div class="ttdeci">struct spa_loop * loop</div><div class="ttdoc">wrapped loop</div><div class="ttdef"><b>Definition:</b> loop.h:44</div></div>
<div class="ttc" id="structpw__loop_html_ad34e8c247c5a3e9760b1c0fb33a7cc2f"><div class="ttname"><a href="structpw__loop.html#ad34e8c247c5a3e9760b1c0fb33a7cc2f">pw_loop::utils</a></div><div class="ttdeci">struct spa_loop_utils * utils</div><div class="ttdoc">loop utils</div><div class="ttdef"><b>Definition:</b> loop.h:46</div></div>
<div class="ttc" id="structpw__loop_html_ae7e5a8b4500832184aa06705d3569933"><div class="ttname"><a href="structpw__loop.html#ae7e5a8b4500832184aa06705d3569933">pw_loop::pw_loop_destroy</a></div><div class="ttdeci">SPA_EXPORT void pw_loop_destroy(struct pw_loop *loop)</div><div class="ttdoc">Destroy a loop.</div><div class="ttdef"><b>Definition:</b> loop.c:158</div></div>
<div class="ttc" id="structpw__loop_html_a639de0bfd74cf9e292932aaed15182c5"><div class="ttname"><a href="structpw__loop.html#a639de0bfd74cf9e292932aaed15182c5">pw_loop::control</a></div><div class="ttdeci">struct spa_loop_control * control</div><div class="ttdoc">loop control</div><div class="ttdef"><b>Definition:</b> loop.h:45</div></div>
<div class="ttc" id="properties_8h_html"><div class="ttname"><a href="properties_8h.html">properties.h</a></div></div>
<div class="ttc" id="structpw__loop_html_abab71679705176a16c9e27b3115701c3"><div class="ttname"><a href="structpw__loop.html#abab71679705176a16c9e27b3115701c3">pw_loop::system</a></div><div class="ttdeci">struct spa_system * system</div><div class="ttdoc">system utils</div><div class="ttdef"><b>Definition:</b> loop.h:43</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_7129a66c92fe7beef816c2ac906ef0b3.html">pipewire</a></li><li class="navelem"><a class="el" href="loop_8h.html">loop.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>
|
