<!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: netjack_packet.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>netjack_packet.h</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * NetJack - Packet Handling functions</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * used by the driver and the jacknet_client</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Copyright (C) 2006 Torben Hohn <torbenh@gmx.de></span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> * (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00017"></a>00017 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00020"></a>00020 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00021"></a>00021 <span class="comment"> * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00022"></a>00022 <span class="comment"> *</span>
<a name="l00023"></a>00023 <span class="comment"> * $Id: net_driver.c,v 1.16 2006/03/20 19:41:37 torbenh Exp $</span>
<a name="l00024"></a>00024 <span class="comment"> *</span>
<a name="l00025"></a>00025 <span class="comment"> */</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="preprocessor">#ifndef __JACK_NET_PACKET_H__</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define __JACK_NET_PACKET_H__</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span>
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 <span class="preprocessor">#endif</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <jack/jack.h></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <jack/types.h></span>
<a name="l00037"></a>00037 <span class="comment">//#include <jack/engine.h></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include <jack/jslist.h></span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="preprocessor">#include <jack/midiport.h></span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="comment">//#include <netinet/in.h></span>
<a name="l00043"></a>00043 <span class="comment">// The Packet Header.</span>
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="preprocessor">#define CELT_MODE 1000 // Magic bitdepth value that indicates CELT compression</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#define MASTER_FREEWHEELS 0x80000000</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span>
<a name="l00048"></a>00048 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__jacknet__packet__header.html">_jacknet_packet_header</a> <a class="code" href="struct__jacknet__packet__header.html">jacknet_packet_header</a>;
<a name="l00049"></a>00049
<a name="l00050"></a><a class="code" href="struct__jacknet__packet__header.html">00050</a> <span class="keyword">struct </span><a class="code" href="struct__jacknet__packet__header.html">_jacknet_packet_header</a>
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052 <span class="comment">// General AutoConf Data</span>
<a name="l00053"></a>00053 jack_nframes_t capture_channels_audio;
<a name="l00054"></a>00054 jack_nframes_t playback_channels_audio;
<a name="l00055"></a>00055 jack_nframes_t capture_channels_midi;
<a name="l00056"></a>00056 jack_nframes_t playback_channels_midi;
<a name="l00057"></a>00057 jack_nframes_t period_size;
<a name="l00058"></a>00058 jack_nframes_t sample_rate;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="comment">// Transport Sync</span>
<a name="l00061"></a>00061 jack_nframes_t sync_state;
<a name="l00062"></a>00062 jack_nframes_t transport_frame;
<a name="l00063"></a>00063 jack_nframes_t transport_state;
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="comment">// Packet loss Detection, and latency reduction</span>
<a name="l00066"></a>00066 jack_nframes_t framecnt;
<a name="l00067"></a>00067 jack_nframes_t latency;
<a name="l00068"></a>00068
<a name="l00069"></a>00069 jack_nframes_t reply_port;
<a name="l00070"></a>00070 jack_nframes_t mtu;
<a name="l00071"></a>00071 jack_nframes_t fragment_nr;
<a name="l00072"></a>00072 };
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="keyword">typedef</span> <span class="keyword">union </span><a class="code" href="union__int__float.html">_int_float</a> <a class="code" href="union__int__float.html">int_float_t</a>;
<a name="l00075"></a>00075
<a name="l00076"></a><a class="code" href="union__int__float.html">00076</a> <span class="keyword">union </span><a class="code" href="union__int__float.html">_int_float</a>
<a name="l00077"></a>00077 {
<a name="l00078"></a>00078 uint32_t i;
<a name="l00079"></a>00079 <span class="keywordtype">float</span> f;
<a name="l00080"></a>00080 };
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="comment">// fragment reorder cache.</span>
<a name="l00083"></a>00083 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__cache__packet.html">_cache_packet</a> <a class="code" href="struct__cache__packet.html">cache_packet</a>;
<a name="l00084"></a>00084
<a name="l00085"></a><a class="code" href="struct__cache__packet.html">00085</a> <span class="keyword">struct </span><a class="code" href="struct__cache__packet.html">_cache_packet</a>
<a name="l00086"></a>00086 {
<a name="l00087"></a>00087 <span class="keywordtype">int</span> valid;
<a name="l00088"></a>00088 <span class="keywordtype">int</span> num_fragments;
<a name="l00089"></a>00089 <span class="keywordtype">int</span> packet_size;
<a name="l00090"></a>00090 <span class="keywordtype">int</span> mtu;
<a name="l00091"></a>00091 jack_time_t recv_timestamp;
<a name="l00092"></a>00092 jack_nframes_t framecnt;
<a name="l00093"></a>00093 <span class="keywordtype">char</span> * fragment_array;
<a name="l00094"></a>00094 <span class="keywordtype">char</span> * packet_buf;
<a name="l00095"></a>00095 };
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__packet__cache.html">_packet_cache</a> <a class="code" href="struct__packet__cache.html">packet_cache</a>;
<a name="l00098"></a>00098
<a name="l00099"></a><a class="code" href="struct__packet__cache.html">00099</a> <span class="keyword">struct </span><a class="code" href="struct__packet__cache.html">_packet_cache</a>
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 <span class="keywordtype">int</span> size;
<a name="l00102"></a>00102 <a class="code" href="struct__cache__packet.html">cache_packet</a> *packets;
<a name="l00103"></a>00103 <span class="keywordtype">int</span> mtu;
<a name="l00104"></a>00104 <span class="keyword">struct </span>sockaddr_in master_address;
<a name="l00105"></a>00105 <span class="keywordtype">int</span> master_address_valid;
<a name="l00106"></a>00106 jack_nframes_t last_framecnt_retreived;
<a name="l00107"></a>00107 <span class="keywordtype">int</span> last_framecnt_retreived_valid;
<a name="l00108"></a>00108 };
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="comment">// fragment cache function prototypes</span>
<a name="l00111"></a>00111 <span class="comment">// XXX: Some of these are private.</span>
<a name="l00112"></a>00112 <a class="code" href="struct__packet__cache.html">packet_cache</a> *packet_cache_new(<span class="keywordtype">int</span> num_packets, <span class="keywordtype">int</span> pkt_size, <span class="keywordtype">int</span> mtu);
<a name="l00113"></a>00113 <span class="keywordtype">void</span> packet_cache_free(<a class="code" href="struct__packet__cache.html">packet_cache</a> *pkt_cache);
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <a class="code" href="struct__cache__packet.html">cache_packet</a> *packet_cache_get_packet(<a class="code" href="struct__packet__cache.html">packet_cache</a> *pkt_cache, jack_nframes_t framecnt);
<a name="l00116"></a>00116 <a class="code" href="struct__cache__packet.html">cache_packet</a> *packet_cache_get_oldest_packet(<a class="code" href="struct__packet__cache.html">packet_cache</a> *pkt_cache);
<a name="l00117"></a>00117 <a class="code" href="struct__cache__packet.html">cache_packet</a> *packet_cache_get_free_packet(<a class="code" href="struct__packet__cache.html">packet_cache</a> *pkt_cache);
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="keywordtype">void</span> cache_packet_reset(<a class="code" href="struct__cache__packet.html">cache_packet</a> *pack);
<a name="l00120"></a>00120 <span class="keywordtype">void</span> cache_packet_set_framecnt(<a class="code" href="struct__cache__packet.html">cache_packet</a> *pack, jack_nframes_t framecnt);
<a name="l00121"></a>00121 <span class="keywordtype">void</span> cache_packet_add_fragment(<a class="code" href="struct__cache__packet.html">cache_packet</a> *pack, <span class="keywordtype">char</span> *packet_buf, <span class="keywordtype">int</span> rcv_len);
<a name="l00122"></a>00122 <span class="keywordtype">int</span> cache_packet_is_complete(<a class="code" href="struct__cache__packet.html">cache_packet</a> *pack);
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="keywordtype">void</span> packet_cache_drain_socket( <a class="code" href="struct__packet__cache.html">packet_cache</a> *pcache, <span class="keywordtype">int</span> sockfd );
<a name="l00125"></a>00125 <span class="keywordtype">void</span> packet_cache_reset_master_address( <a class="code" href="struct__packet__cache.html">packet_cache</a> *pcache );
<a name="l00126"></a>00126 <span class="keywordtype">float</span> packet_cache_get_fill( <a class="code" href="struct__packet__cache.html">packet_cache</a> *pcache, jack_nframes_t expected_framecnt );
<a name="l00127"></a>00127 <span class="keywordtype">int</span> packet_cache_retreive_packet_pointer( <a class="code" href="struct__packet__cache.html">packet_cache</a> *pcache, jack_nframes_t framecnt, <span class="keywordtype">char</span> **packet_buf, <span class="keywordtype">int</span> pkt_size, jack_time_t *timestamp );
<a name="l00128"></a>00128 <span class="keywordtype">int</span> packet_cache_release_packet( <a class="code" href="struct__packet__cache.html">packet_cache</a> *pcache, jack_nframes_t framecnt );
<a name="l00129"></a>00129 <span class="keywordtype">int</span> packet_cache_get_next_available_framecnt( <a class="code" href="struct__packet__cache.html">packet_cache</a> *pcache, jack_nframes_t expected_framecnt, jack_nframes_t *framecnt );
<a name="l00130"></a>00130 <span class="keywordtype">int</span> packet_cache_get_highest_available_framecnt( <a class="code" href="struct__packet__cache.html">packet_cache</a> *pcache, jack_nframes_t *framecnt );
<a name="l00131"></a>00131 <span class="keywordtype">int</span> packet_cache_find_latency( <a class="code" href="struct__packet__cache.html">packet_cache</a> *pcache, jack_nframes_t expected_framecnt, jack_nframes_t *framecnt );
<a name="l00132"></a>00132 <span class="comment">// Function Prototypes</span>
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="keywordtype">int</span> netjack_poll_deadline (<span class="keywordtype">int</span> sockfd, jack_time_t deadline);
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="keywordtype">void</span> netjack_sendto(<span class="keywordtype">int</span> sockfd, <span class="keywordtype">char</span> *packet_buf, <span class="keywordtype">int</span> pkt_size, <span class="keywordtype">int</span> flags, <span class="keyword">struct</span> sockaddr *addr, <span class="keywordtype">int</span> addr_size, <span class="keywordtype">int</span> mtu);
<a name="l00137"></a>00137
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keywordtype">int</span> get_sample_size(<span class="keywordtype">int</span> bitdepth);
<a name="l00140"></a>00140 <span class="keywordtype">void</span> packet_header_hton(<a class="code" href="struct__jacknet__packet__header.html">jacknet_packet_header</a> *pkthdr);
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keywordtype">void</span> packet_header_ntoh(<a class="code" href="struct__jacknet__packet__header.html">jacknet_packet_header</a> *pkthdr);
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <span class="keywordtype">void</span> render_payload_to_jack_ports(<span class="keywordtype">int</span> bitdepth, <span class="keywordtype">void</span> *packet_payload, jack_nframes_t net_period_down, <a class="code" href="struct__JSList.html">JSList</a> *capture_ports, <a class="code" href="struct__JSList.html">JSList</a> *capture_srcs, jack_nframes_t nframes, <span class="keywordtype">int</span> dont_htonl_floats );
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="keywordtype">void</span> render_jack_ports_to_payload(<span class="keywordtype">int</span> bitdepth, <a class="code" href="struct__JSList.html">JSList</a> *playback_ports, <a class="code" href="struct__JSList.html">JSList</a> *playback_srcs, jack_nframes_t nframes, <span class="keywordtype">void</span> *packet_payload, jack_nframes_t net_period_up, <span class="keywordtype">int</span> dont_htonl_floats );
<a name="l00147"></a>00147
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="comment">// XXX: This is sort of deprecated:</span>
<a name="l00150"></a>00150 <span class="comment">// This one waits forever. an is not using ppoll</span>
<a name="l00151"></a>00151 <span class="keywordtype">int</span> netjack_poll(<span class="keywordtype">int</span> sockfd, <span class="keywordtype">int</span> timeout);
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="keywordtype">void</span> decode_midi_buffer (uint32_t *buffer_uint32, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> buffer_size_uint32, jack_default_audio_sample_t* buf);
<a name="l00154"></a>00154 <span class="keywordtype">void</span> encode_midi_buffer (uint32_t *buffer_uint32, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> buffer_size_uint32, jack_default_audio_sample_t* buf);
<a name="l00155"></a>00155 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00156"></a>00156 <span class="preprocessor"></span> }
<a name="l00157"></a>00157 <span class="preprocessor">#endif</span>
<a name="l00158"></a>00158 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00159"></a>00159 <span class="preprocessor"></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>
