<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Format Mask Functions</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.2.18 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindex" href="examples.html">Examples</a> </center> <hr><h1>Format Mask Functions<br> <small> [<a class="el" href="group___p_c_m.html">PCM Interface</a>]</small> </h1><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Defines</h2></td></tr> <tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group___p_c_m___format.html#a10">snd_pcm_format_mask_alloca</a>(ptr)</td></tr> <tr><td> </td><td><font size=-1><em>allocate an empty <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> using standard alloca</em> <a href="#a10"></a><em></em></font><br><br></td></tr> <tr><td colspan=2><br><h2>Functions</h2></td></tr> <tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="group___p_c_m___format.html#a0">snd_pcm_format_mask_sizeof</a> (void)</td></tr> <tr><td> </td><td><font size=-1><em>get size of <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a></em> <a href="#a0"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group___p_c_m___format.html#a1">snd_pcm_format_mask_malloc</a> (<a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> **ptr)</td></tr> <tr><td> </td><td><font size=-1><em>allocate an empty <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> using standard malloc</em> <a href="#a1"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group___p_c_m___format.html#a2">snd_pcm_format_mask_free</a> (<a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> *obj)</td></tr> <tr><td> </td><td><font size=-1><em>frees a previously allocated <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a></em> <a href="#a2"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group___p_c_m___format.html#a3">snd_pcm_format_mask_copy</a> (<a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> *dst, const <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> *src)</td></tr> <tr><td> </td><td><font size=-1><em>copy one <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> to another</em> <a href="#a3"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group___p_c_m___format.html#a4">snd_pcm_format_mask_none</a> (<a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> *mask)</td></tr> <tr><td> </td><td><font size=-1><em>reset all bits in a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a></em> <a href="#a4"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group___p_c_m___format.html#a5">snd_pcm_format_mask_any</a> (<a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> *mask)</td></tr> <tr><td> </td><td><font size=-1><em>set all bits in a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a></em> <a href="#a5"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group___p_c_m___format.html#a6">snd_pcm_format_mask_test</a> (const <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> *mask, <a class="el" href="group___p_c_m.html#a11">snd_pcm_format_t</a> val)</td></tr> <tr><td> </td><td><font size=-1><em>test the presence of a format in a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a></em> <a href="#a6"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group___p_c_m___format.html#a7">snd_pcm_format_mask_empty</a> (const <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> *mask)</td></tr> <tr><td> </td><td><font size=-1><em>test, if given a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> is empty</em> <a href="#a7"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group___p_c_m___format.html#a8">snd_pcm_format_mask_set</a> (<a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> *mask, <a class="el" href="group___p_c_m.html#a11">snd_pcm_format_t</a> val)</td></tr> <tr><td> </td><td><font size=-1><em>make a format present in a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a></em> <a href="#a8"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group___p_c_m___format.html#a9">snd_pcm_format_mask_reset</a> (<a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> *mask, <a class="el" href="group___p_c_m.html#a11">snd_pcm_format_t</a> val)</td></tr> <tr><td> </td><td><font size=-1><em>make a format missing from a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a></em> <a href="#a9"></a><em></em></font><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> See the <a href="pcm.html#pcm">PCM (digital audio) interface</a> page for more details. <hr><h2>Define Documentation</h2> <a name="a10" doxytag="pcm.h::snd_pcm_format_mask_alloca"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define snd_pcm_format_mask_alloca</td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">ptr </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> allocate an empty <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> using standard alloca <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>ptr</em> </td><td> returned pointer </td></tr> </table> </dl> </td> </tr> </table> <hr><h2>Function Documentation</h2> <a name="a5" doxytag="pcm.h::snd_pcm_format_mask_any"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void snd_pcm_format_mask_any </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>mask</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> set all bits in a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>mask</em> </td><td> pointer to mask </td></tr> </table> </dl> </td> </tr> </table> <a name="a3" doxytag="pcm.h::snd_pcm_format_mask_copy"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void snd_pcm_format_mask_copy </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> * </td> <td class="mdname" nowrap> <em>dst</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> * </td> <td class="mdname" nowrap> <em>src</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> copy one <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> to another <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>dst</em> </td><td> pointer to destination </td></tr> <tr><td valign=top><em>src</em> </td><td> pointer to source </td></tr> </table> </dl> </td> </tr> </table> <a name="a7" doxytag="pcm.h::snd_pcm_format_mask_empty"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int snd_pcm_format_mask_empty </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>mask</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> test, if given a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> is empty <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>mask</em> </td><td> pointer to mask </td></tr> </table> </dl><dl compact><dt><b>Return values: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>0</em> </td><td> not empty </td></tr> <tr><td valign=top><em>1</em> </td><td> empty </td></tr> </table> </dl> </td> </tr> </table> <a name="a2" doxytag="pcm.h::snd_pcm_format_mask_free"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void snd_pcm_format_mask_free </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>obj</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> frees a previously allocated <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>pointer</em> </td><td> to object to free </td></tr> </table> </dl> </td> </tr> </table> <a name="a1" doxytag="pcm.h::snd_pcm_format_mask_malloc"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int snd_pcm_format_mask_malloc </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> ** </td> <td class="mdname1" valign="top" nowrap> <em>ptr</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> allocate an empty <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> using standard malloc <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>ptr</em> </td><td> returned pointer </td></tr> </table> </dl><dl compact><dt><b>Returns: </b></dt><dd> 0 on success otherwise negative error code </dl> </td> </tr> </table> <a name="a4" doxytag="pcm.h::snd_pcm_format_mask_none"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void snd_pcm_format_mask_none </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>mask</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> reset all bits in a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>mask</em> </td><td> pointer to mask </td></tr> </table> </dl> </td> </tr> </table> <a name="a9" doxytag="pcm.h::snd_pcm_format_mask_reset"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void snd_pcm_format_mask_reset </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> * </td> <td class="mdname" nowrap> <em>mask</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="group___p_c_m.html#a11">snd_pcm_format_t</a> </td> <td class="mdname" nowrap> <em>val</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> make a format missing from a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>mask</em> </td><td> pointer to mask </td></tr> <tr><td valign=top><em>val</em> </td><td> format </td></tr> </table> </dl> </td> </tr> </table> <a name="a8" doxytag="pcm.h::snd_pcm_format_mask_set"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void snd_pcm_format_mask_set </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> * </td> <td class="mdname" nowrap> <em>mask</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="group___p_c_m.html#a11">snd_pcm_format_t</a> </td> <td class="mdname" nowrap> <em>val</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> make a format present in a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>mask</em> </td><td> pointer to mask </td></tr> <tr><td valign=top><em>val</em> </td><td> format </td></tr> </table> </dl> </td> </tr> </table> <a name="a0" doxytag="pcm.h::snd_pcm_format_mask_sizeof"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> size_t snd_pcm_format_mask_sizeof </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> get size of <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> <p> <dl compact><dt><b>Returns: </b></dt><dd> size in bytes </dl> </td> </tr> </table> <a name="a6" doxytag="pcm.h::snd_pcm_format_mask_test"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int snd_pcm_format_mask_test </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> * </td> <td class="mdname" nowrap> <em>mask</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="group___p_c_m.html#a11">snd_pcm_format_t</a> </td> <td class="mdname" nowrap> <em>val</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> test the presence of a format in a <a class="el" href="group___p_c_m.html#a5">snd_pcm_format_mask_t</a> <p> <dl compact><dt><b>Parameters: </b></dt><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>mask</em> </td><td> pointer to mask </td></tr> <tr><td valign=top><em>val</em> </td><td> format </td></tr> </table> </dl> </td> </tr> </table> <hr><address style="align: right;"><small>Generated on Wed Apr 2 16:06:38 2003 for ALSA project - the C library reference by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.18 </small></address> </body> </html>