<!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>SphinxBase: include/sphinxbase/bio.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<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">SphinxBase <span id="projectnumber">0.6</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="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>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('bio_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>include/sphinxbase/bio.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Cross platform binary IO to process files in sphinx3 format.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <stdio.h></code><br/>
<code>#include <stdarg.h></code><br/>
<code>#include <sphinxbase/sphinxbase_export.h></code><br/>
<code>#include <sphinxbase/prim_type.h></code><br/>
<code>#include <sphinxbase/byteorder.h></code><br/>
</div>
<p><a href="bio_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac08e1e4728563a03ff6c937bfa8fd845"></a><!-- doxytag: member="bio.h::BYTE_ORDER_MAGIC" ref="ac08e1e4728563a03ff6c937bfa8fd845" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>BYTE_ORDER_MAGIC</b>   (0x11223344)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bio_8h.html#abf9af8ac9d8a67710371365812869c92">REVERSE_SENSE_SWAP_INT16</a>(x)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">"reversed senses" SWAP, ARCHAN: This is still incorporated in Sphinx 3 because lm3g2dmp used it. <a href="#abf9af8ac9d8a67710371365812869c92"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c277e579a007b5c46bd762a7d18b2cf"></a><!-- doxytag: member="bio.h::REVERSE_SENSE_SWAP_INT32" ref="a2c277e579a007b5c46bd762a7d18b2cf" args="(x)" -->
#define </td><td class="memItemRight" valign="bottom"><b>REVERSE_SENSE_SWAP_INT32</b>(x)</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="bio_8h.html#a7a155ff51740f1d9a31f7bb7b6e4bc3a">bio_readhdr</a> (FILE *fp, char ***name, char ***val, int32 *swap)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read binary file format header: has the following format. <a href="#a7a155ff51740f1d9a31f7bb7b6e4bc3a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="bio_8h.html#a9662c09be1f18377488dedb8e7ca0bfd">bio_writehdr_version</a> (FILE *fp, char *version)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a simple binary file header, containing only the version string. <a href="#a9662c09be1f18377488dedb8e7ca0bfd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc41fc6124fa3e52267c0a2c1036246f"></a><!-- doxytag: member="bio.h::bio_writehdr" ref="adc41fc6124fa3e52267c0a2c1036246f" args="(FILE *fp,...)" -->
SPHINXBASE_EXPORT int32 </td><td class="memItemRight" valign="bottom"><b>bio_writehdr</b> (FILE *fp,...)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="bio_8h.html#adb3c858a50381aeff022ccd4271af2d9">bio_hdrarg_free</a> (char **name, char **val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free name and value strings previously allocated and returned by bio_readhdr. <a href="#adb3c858a50381aeff022ccd4271af2d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="bio_8h.html#a7068bb61e421bc46a6989cef3b37c833">bio_fread</a> (void *buf, int32 el_sz, int32 n_el, FILE *fp, int32 swap, uint32 *chksum)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Like fread but perform byteswapping and accumulate checksum (the 2 extra arguments). <a href="#a7068bb61e421bc46a6989cef3b37c833"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="bio_8h.html#a3b131beb20492e1a6f46c9b4dd81a64e">bio_fwrite</a> (void *buf, int32 el_sz, int32 n_el, FILE *fp, int32 swap, uint32 *chksum)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Like fwrite but perform byteswapping and accumulate checksum (the 2 extra arguments). <a href="#a3b131beb20492e1a6f46c9b4dd81a64e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="bio_8h.html#aaeda1ca5a5c0ca5a9e5b4820c442bbe5">bio_fread_1d</a> (void **buf, size_t el_sz, uint32 *n_el, FILE *fp, int32 sw, uint32 *ck)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a 1-d array (fashioned after fread): <a href="#aaeda1ca5a5c0ca5a9e5b4820c442bbe5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="bio_8h.html#a70604d0f8035f0868f9284fa82e4fdb8">bio_fread_2d</a> (void ***arr, size_t e_sz, uint32 *d1, uint32 *d2, FILE *fp, uint32 swap, uint32 *chksum)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a 2-d matrix: <a href="#a70604d0f8035f0868f9284fa82e4fdb8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="bio_8h.html#aca6a6b71d02b9e5ca6b136a28640e0c1">bio_fread_3d</a> (void ****arr, size_t e_sz, uint32 *d1, uint32 *d2, uint32 *d3, FILE *fp, uint32 swap, uint32 *chksum)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a 3-d array (set of matrices) <a href="#aca6a6b71d02b9e5ca6b136a28640e0c1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="bio_8h.html#ad07e2ee9f2f01d3ff3232008098295a0">bio_verify_chksum</a> (FILE *fp, int32 byteswap, uint32 chksum)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read and verify checksum at the end of binary file. <a href="#ad07e2ee9f2f01d3ff3232008098295a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int16 * </td><td class="memItemRight" valign="bottom"><a class="el" href="bio_8h.html#afe3c58abf0f2584fbd49e3eae7ac4509">bio_read_wavfile</a> (char const *directory, char const *filename, char const *extension, int32 header, int32 endian, int32 *nsamps)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read raw data from the wav file. <a href="#afe3c58abf0f2584fbd49e3eae7ac4509"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Cross platform binary IO to process files in sphinx3 format. </p>
<p>Definition in file <a class="el" href="bio_8h_source.html">bio.h</a>.</p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="abf9af8ac9d8a67710371365812869c92"></a><!-- doxytag: member="bio.h::REVERSE_SENSE_SWAP_INT16" ref="abf9af8ac9d8a67710371365812869c92" args="(x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define REVERSE_SENSE_SWAP_INT16</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x</td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>"reversed senses" SWAP, ARCHAN: This is still incorporated in Sphinx 3 because lm3g2dmp used it. </p>
<p>Don't think that I am very happy with it. </p>
<p>Definition at line <a class="el" href="bio_8h_source.html#l00103">103</a> of file <a class="el" href="bio_8h_source.html">bio.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a7068bb61e421bc46a6989cef3b37c833"></a><!-- doxytag: member="bio.h::bio_fread" ref="a7068bb61e421bc46a6989cef3b37c833" args="(void *buf, int32 el_sz, int32 n_el, FILE *fp, int32 swap, uint32 *chksum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int32 bio_fread </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>el_sz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>n_el</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>swap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 * </td>
<td class="paramname"><em>chksum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Like fread but perform byteswapping and accumulate checksum (the 2 extra arguments). </p>
<p>But unlike fread, returns -1 if required number of elements (n_el) not read; also, no byteswapping or checksum accumulation is performed in that case. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>In: An input file pointer </td></tr>
<tr><td class="paramname">swap</td><td>In: Byteswap iff (swap != 0) </td></tr>
<tr><td class="paramname">chksum</td><td>In/Out: Accumulated checksum </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bio_8c_source.html#l00326">326</a> of file <a class="el" href="bio_8c_source.html">bio.c</a>.</p>
<p>References <a class="el" href="bio_8c_source.html#l00326">bio_fread()</a>.</p>
<p>Referenced by <a class="el" href="bio_8c_source.html#l00326">bio_fread()</a>, <a class="el" href="bio_8c_source.html#l00364">bio_fread_1d()</a>, <a class="el" href="bio_8c_source.html#l00384">bio_fread_2d()</a>, <a class="el" href="bio_8c_source.html#l00430">bio_fread_3d()</a>, and <a class="el" href="logmath_8c_source.html#l00164">logmath_read()</a>.</p>
</div>
</div>
<a class="anchor" id="aaeda1ca5a5c0ca5a9e5b4820c442bbe5"></a><!-- doxytag: member="bio.h::bio_fread_1d" ref="aaeda1ca5a5c0ca5a9e5b4820c442bbe5" args="(void **buf, size_t el_sz, uint32 *n_el, FILE *fp, int32 sw, uint32 *ck)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int32 bio_fread_1d </td>
<td>(</td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>el_sz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 * </td>
<td class="paramname"><em>n_el</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>sw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 * </td>
<td class="paramname"><em>ck</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read a 1-d array (fashioned after fread): </p>
<ul>
<li>4-byte array size (returned in n_el)</li>
<li>memory allocated for the array and read (returned in buf)</li>
</ul>
<p>Byteswapping and checksum accumulation performed as necessary. Fails fatally if expected data not read. Return value: number of array elements allocated and read; -1 if error. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>Out: contains array data; allocated by this function; can be freed using ckd_free </td></tr>
<tr><td class="paramname">el_sz</td><td>In: Array element size </td></tr>
<tr><td class="paramname">n_el</td><td>Out: Number of array elements allocated/read </td></tr>
<tr><td class="paramname">fp</td><td>In: File to read </td></tr>
<tr><td class="paramname">sw</td><td>In: Byteswap iff (swap != 0) </td></tr>
<tr><td class="paramname">ck</td><td>In/Out: Accumulated checksum </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bio_8c_source.html#l00364">364</a> of file <a class="el" href="bio_8c_source.html">bio.c</a>.</p>
<p>References <a class="el" href="bio_8c_source.html#l00326">bio_fread()</a>, <a class="el" href="bio_8c_source.html#l00364">bio_fread_1d()</a>, <a class="el" href="ckd__alloc_8h_source.html#l00248">ckd_calloc</a>, and <a class="el" href="err_8h_source.html#l00127">E_FATAL</a>.</p>
<p>Referenced by <a class="el" href="bio_8c_source.html#l00364">bio_fread_1d()</a>, <a class="el" href="bio_8c_source.html#l00384">bio_fread_2d()</a>, and <a class="el" href="bio_8c_source.html#l00430">bio_fread_3d()</a>.</p>
</div>
</div>
<a class="anchor" id="a70604d0f8035f0868f9284fa82e4fdb8"></a><!-- doxytag: member="bio.h::bio_fread_2d" ref="a70604d0f8035f0868f9284fa82e4fdb8" args="(void ***arr, size_t e_sz, uint32 *d1, uint32 *d2, FILE *fp, uint32 swap, uint32 *chksum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int32 bio_fread_2d </td>
<td>(</td>
<td class="paramtype">void *** </td>
<td class="paramname"><em>arr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>e_sz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 * </td>
<td class="paramname"><em>d1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 * </td>
<td class="paramname"><em>d2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 </td>
<td class="paramname"><em>swap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 * </td>
<td class="paramname"><em>chksum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read a 2-d matrix: </p>
<ul>
<li>4-byte # rows, # columns (returned in d1, d2, d3)</li>
<li>memory allocated for the array and read (returned in buf)</li>
</ul>
<p>Byteswapping and checksum accumulation performed as necessary. Fails fatally if expected data not read. Return value: number of array elements allocated and read; -1 if error. </p>
<p>Definition at line <a class="el" href="bio_8c_source.html#l00384">384</a> of file <a class="el" href="bio_8c_source.html">bio.c</a>.</p>
<p>References <a class="el" href="bio_8c_source.html#l00326">bio_fread()</a>, <a class="el" href="bio_8c_source.html#l00364">bio_fread_1d()</a>, <a class="el" href="bio_8c_source.html#l00384">bio_fread_2d()</a>, <a class="el" href="ckd__alloc_8h_source.html#l00287">ckd_alloc_2d_ptr</a>, and <a class="el" href="err_8h_source.html#l00142">E_ERROR_SYSTEM</a>.</p>
<p>Referenced by <a class="el" href="bio_8c_source.html#l00384">bio_fread_2d()</a>.</p>
</div>
</div>
<a class="anchor" id="aca6a6b71d02b9e5ca6b136a28640e0c1"></a><!-- doxytag: member="bio.h::bio_fread_3d" ref="aca6a6b71d02b9e5ca6b136a28640e0c1" args="(void ****arr, size_t e_sz, uint32 *d1, uint32 *d2, uint32 *d3, FILE *fp, uint32 swap, uint32 *chksum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int32 bio_fread_3d </td>
<td>(</td>
<td class="paramtype">void **** </td>
<td class="paramname"><em>arr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>e_sz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 * </td>
<td class="paramname"><em>d1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 * </td>
<td class="paramname"><em>d2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 * </td>
<td class="paramname"><em>d3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 </td>
<td class="paramname"><em>swap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 * </td>
<td class="paramname"><em>chksum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read a 3-d array (set of matrices) </p>
<ul>
<li>4-byte # matrices, # rows, # columns (returned in d1, d2, d3)</li>
<li>memory allocated for the array and read (returned in buf)</li>
</ul>
<p>Byteswapping and checksum accumulation performed as necessary. Fails fatally if expected data not read. Return value: number of array elements allocated and read; -1 if error. </p>
<p>Definition at line <a class="el" href="bio_8c_source.html#l00430">430</a> of file <a class="el" href="bio_8c_source.html">bio.c</a>.</p>
<p>References <a class="el" href="bio_8c_source.html#l00326">bio_fread()</a>, <a class="el" href="bio_8c_source.html#l00364">bio_fread_1d()</a>, <a class="el" href="bio_8c_source.html#l00430">bio_fread_3d()</a>, <a class="el" href="ckd__alloc_8h_source.html#l00298">ckd_alloc_3d_ptr</a>, and <a class="el" href="err_8h_source.html#l00142">E_ERROR_SYSTEM</a>.</p>
<p>Referenced by <a class="el" href="bio_8c_source.html#l00430">bio_fread_3d()</a>, and <a class="el" href="lda_8c_source.html#l00061">feat_read_lda()</a>.</p>
</div>
</div>
<a class="anchor" id="a3b131beb20492e1a6f46c9b4dd81a64e"></a><!-- doxytag: member="bio.h::bio_fwrite" ref="a3b131beb20492e1a6f46c9b4dd81a64e" args="(void *buf, int32 el_sz, int32 n_el, FILE *fp, int32 swap, uint32 *chksum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int32 bio_fwrite </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>el_sz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>n_el</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>swap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 * </td>
<td class="paramname"><em>chksum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Like fwrite but perform byteswapping and accumulate checksum (the 2 extra arguments). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of elemens written (like fwrite). </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>In: An input file pointer </td></tr>
<tr><td class="paramname">swap</td><td>In: Byteswap iff (swap != 0) </td></tr>
<tr><td class="paramname">chksum</td><td>In/Out: Accumulated checksum </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bio_8c_source.html#l00342">342</a> of file <a class="el" href="bio_8c_source.html">bio.c</a>.</p>
<p>References <a class="el" href="bio_8c_source.html#l00342">bio_fwrite()</a>, <a class="el" href="ckd__alloc_8h_source.html#l00248">ckd_calloc</a>, and <a class="el" href="ckd__alloc_8c_source.html#l00241">ckd_free()</a>.</p>
<p>Referenced by <a class="el" href="bio_8c_source.html#l00342">bio_fwrite()</a>, and <a class="el" href="logmath_8c_source.html#l00272">logmath_write()</a>.</p>
</div>
</div>
<a class="anchor" id="adb3c858a50381aeff022ccd4271af2d9"></a><!-- doxytag: member="bio.h::bio_hdrarg_free" ref="adb3c858a50381aeff022ccd4271af2d9" args="(char **name, char **val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT void bio_hdrarg_free </td>
<td>(</td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free name and value strings previously allocated and returned by bio_readhdr. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>In: Array previously returned by bio_readhdr </td></tr>
<tr><td class="paramname">val</td><td>In: Array previously returned by bio_readhdr </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bio_8c_source.html#l00121">121</a> of file <a class="el" href="bio_8c_source.html">bio.c</a>.</p>
<p>References <a class="el" href="bio_8c_source.html#l00121">bio_hdrarg_free()</a>, and <a class="el" href="ckd__alloc_8c_source.html#l00241">ckd_free()</a>.</p>
<p>Referenced by <a class="el" href="bio_8c_source.html#l00121">bio_hdrarg_free()</a>, <a class="el" href="bio_8c_source.html#l00187">bio_readhdr()</a>, <a class="el" href="lda_8c_source.html#l00061">feat_read_lda()</a>, and <a class="el" href="logmath_8c_source.html#l00164">logmath_read()</a>.</p>
</div>
</div>
<a class="anchor" id="afe3c58abf0f2584fbd49e3eae7ac4509"></a><!-- doxytag: member="bio.h::bio_read_wavfile" ref="afe3c58abf0f2584fbd49e3eae7ac4509" args="(char const *directory, char const *filename, char const *extension, int32 header, int32 endian, int32 *nsamps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16* bio_read_wavfile </td>
<td>(</td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>directory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>extension</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>header</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>endian</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 * </td>
<td class="paramname"><em>nsamps</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read raw data from the wav file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">directory</td><td>the folder where the file is located </td></tr>
<tr><td class="paramname">filename</td><td>the name of the file </td></tr>
<tr><td class="paramname">extension</td><td>file extension </td></tr>
<tr><td class="paramname">header</td><td>the size of the header to skip usually 44 bytes. </td></tr>
<tr><td class="paramname">endian</td><td>Endian of the data </td></tr>
<tr><td class="paramname">nsamps</td><td>number of samples read </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the data </dd></dl>
<p>Definition at line <a class="el" href="bio_8c_source.html#l00507">507</a> of file <a class="el" href="bio_8c_source.html">bio.c</a>.</p>
<p>References <a class="el" href="bio_8c_source.html#l00507">bio_read_wavfile()</a>, <a class="el" href="ckd__alloc_8h_source.html#l00248">ckd_calloc</a>, <a class="el" href="ckd__alloc_8c_source.html#l00241">ckd_free()</a>, <a class="el" href="err_8h_source.html#l00169">E_ERROR</a>, <a class="el" href="err_8h_source.html#l00142">E_ERROR_SYSTEM</a>, and <a class="el" href="err_8h_source.html#l00127">E_FATAL</a>.</p>
<p>Referenced by <a class="el" href="bio_8c_source.html#l00507">bio_read_wavfile()</a>.</p>
</div>
</div>
<a class="anchor" id="a7a155ff51740f1d9a31f7bb7b6e4bc3a"></a><!-- doxytag: member="bio.h::bio_readhdr" ref="a7a155ff51740f1d9a31f7bb7b6e4bc3a" args="(FILE *fp, char ***name, char ***val, int32 *swap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int32 bio_readhdr </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *** </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *** </td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 * </td>
<td class="paramname"><em>swap</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read binary file format header: has the following format. </p>
<pre>
s3
<argument-name> <argument-value>
<argument-name> <argument-value>
...
endhdr
4-byte byte-order word used to find file byte ordering relative to host machine.
</pre><p> Lines beginning with # are ignored. Memory for name and val allocated by this function; use bio_hdrarg_free to free them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>: 0 if successful, -1 otherwise. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>In: File to read </td></tr>
<tr><td class="paramname">name</td><td>Out: array of argument name strings read </td></tr>
<tr><td class="paramname">val</td><td>Out: corresponding value strings read </td></tr>
<tr><td class="paramname">swap</td><td>Out: file needs byteswapping iff (*swap) </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bio_8c_source.html#l00187">187</a> of file <a class="el" href="bio_8c_source.html">bio.c</a>.</p>
<p>References <a class="el" href="bio_8c_source.html#l00121">bio_hdrarg_free()</a>, <a class="el" href="bio_8c_source.html#l00187">bio_readhdr()</a>, <a class="el" href="ckd__alloc_8h_source.html#l00248">ckd_calloc</a>, <a class="el" href="ckd__alloc_8h_source.html#l00264">ckd_salloc</a>, and <a class="el" href="err_8h_source.html#l00169">E_ERROR</a>.</p>
<p>Referenced by <a class="el" href="bio_8c_source.html#l00187">bio_readhdr()</a>, <a class="el" href="lda_8c_source.html#l00061">feat_read_lda()</a>, and <a class="el" href="logmath_8c_source.html#l00164">logmath_read()</a>.</p>
</div>
</div>
<a class="anchor" id="ad07e2ee9f2f01d3ff3232008098295a0"></a><!-- doxytag: member="bio.h::bio_verify_chksum" ref="ad07e2ee9f2f01d3ff3232008098295a0" args="(FILE *fp, int32 byteswap, uint32 chksum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT void bio_verify_chksum </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>byteswap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 </td>
<td class="paramname"><em>chksum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read and verify checksum at the end of binary file. </p>
<p>Fails fatally if there is a mismatch. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>In: File to read </td></tr>
<tr><td class="paramname">byteswap</td><td>In: Byteswap iff (swap != 0) </td></tr>
<tr><td class="paramname">chksum</td><td>In: Value to compare with checksum in file </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bio_8c_source.html#l00492">492</a> of file <a class="el" href="bio_8c_source.html">bio.c</a>.</p>
<p>References <a class="el" href="bio_8c_source.html#l00492">bio_verify_chksum()</a>, and <a class="el" href="err_8h_source.html#l00127">E_FATAL</a>.</p>
<p>Referenced by <a class="el" href="bio_8c_source.html#l00492">bio_verify_chksum()</a>, and <a class="el" href="logmath_8c_source.html#l00164">logmath_read()</a>.</p>
</div>
</div>
<a class="anchor" id="a9662c09be1f18377488dedb8e7ca0bfd"></a><!-- doxytag: member="bio.h::bio_writehdr_version" ref="a9662c09be1f18377488dedb8e7ca0bfd" args="(FILE *fp, char *version)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int32 bio_writehdr_version </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>version</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write a simple binary file header, containing only the version string. </p>
<p>Also write the byte order magic word. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>: 0 if successful, -1 otherwise. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>Output: File to write </td></tr>
<tr><td class="paramname">version</td><td>Input: A string of version </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="bio_8c_source.html#l00137">137</a> of file <a class="el" href="bio_8c_source.html">bio.c</a>.</p>
<p>References <a class="el" href="bio_8c_source.html#l00137">bio_writehdr_version()</a>.</p>
<p>Referenced by <a class="el" href="bio_8c_source.html#l00137">bio_writehdr_version()</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="bio_8h.html">bio.h</a> </li>
<li class="footer">Generated on Tue Apr 19 2011 for SphinxBase by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
0b420d0fce195cf4115dc6a3be5c2da2
>
files
>
63
