diff options
Diffstat (limited to 'fifo_8h_source.html')
| -rw-r--r-- | fifo_8h_source.html | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/fifo_8h_source.html b/fifo_8h_source.html new file mode 100644 index 000000000..57092fbd9 --- /dev/null +++ b/fifo_8h_source.html @@ -0,0 +1,144 @@ +<!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.6"/> +<title>navit: support/espeak/fifo.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="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</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">navit +  <span id="projectnumber">0.5.1-trunk</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> + <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="namespaces.html"><span>Namespaces</span></a></li> + <li><a href="annotated.html"><span>Data Structures</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>Globals</span></a></li> + </ul> + </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"> +$(document).ready(function(){initNavTree('fifo_8h_source.html','');}); +</script> +<div id="doc-content"> +<div class="header"> + <div class="headertitle"> +<div class="title">fifo.h</div> </div> +</div><!--header--> +<div class="contents"> +<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef FIFO_H</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define FIFO_H</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Helps to add espeak commands in a first-in first-out queue </span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// and run them asynchronously.</span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "espeak_command.h"</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "speak_lib.h"</span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// Initialize the fifo component.</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// First function to be called.</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="keywordtype">void</span> fifo_init();</div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// Add an espeak command.</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">// Note: this function fails if too many commands are already buffered.</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// In such a case, the calling function could wait and then add again its command. </span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//</span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// Return: EE_OK: operation achieved </span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// EE_BUFFER_FULL: the command can not be buffered; </span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// you may try after a while to call the function again.</span></div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// EE_INTERNAL_ERROR.</span></div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> espeak_ERROR fifo_add_command (<a class="code" href="structt__espeak__command.html">t_espeak_command</a>* c);</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="comment">// Add two espeak commands in a single transaction.</span></div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">//</span></div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// Note: this function fails if too many commands are already buffered.</span></div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// In such a case, the calling function could wait and then add again these commands. </span></div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">//</span></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// Return: EE_OK: operation achieved </span></div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// EE_BUFFER_FULL: at least one command can not be buffered; </span></div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// you may try after a while to call the function again.</span></div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// EE_INTERNAL_ERROR.</span></div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> espeak_ERROR fifo_add_commands (<a class="code" href="structt__espeak__command.html">t_espeak_command</a>* c1, <a class="code" href="structt__espeak__command.html">t_espeak_command</a>* c2);</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// The current running command must be stopped and the awaiting commands are cleared.</span></div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// Return: EE_OK: operation achieved </span></div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// EE_INTERNAL_ERROR.</span></div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> espeak_ERROR fifo_stop ();</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// Is there a running command?</span></div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// Returns 1 if yes; 0 otherwise.</span></div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">int</span> fifo_is_busy ();</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// Terminate the fifo component.</span></div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// Last function to be called.</span></div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">void</span> fifo_terminate();</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="comment">// Indicates if the running command is still enabled.</span></div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">//</span></div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// Note: this function is mainly called by the SynthCallback (speak_lib.cpp)</span></div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// It indicates if the actual wave sample can still be played. It is helpful for </span></div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// stopping speech as soon as a cancel command is applied. </span></div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">//</span></div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// Returns 1 if yes, or 0 otherwise.</span></div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">int</span> fifo_is_command_enabled();</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div> +<div class="ttc" id="structt__espeak__command_html"><div class="ttname"><a href="structt__espeak__command.html">t_espeak_command</a></div><div class="ttdef"><b>Definition:</b> espeak_command.h:81</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_5815af820a9cc9481f1d0990a0d60286.html">support</a></li><li class="navelem"><a class="el" href="dir_6ffc0f016d2deaea924d934b564632d3.html">espeak</a></li><li class="navelem"><b>fifo.h</b></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.6 </li> + </ul> +</div> +</body> +</html> |