Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / html / python / lib / module-sndhdr.html
CommitLineData
920dae64
AT
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<link rel="STYLESHEET" href="lib.css" type='text/css' />
5<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
6<link rel='start' href='../index.html' title='Python Documentation Index' />
7<link rel="first" href="lib.html" title='Python Library Reference' />
8<link rel='contents' href='contents.html' title="Contents" />
9<link rel='index' href='genindex.html' title='Index' />
10<link rel='last' href='about.html' title='About this document...' />
11<link rel='help' href='about.html' title='About this document...' />
12<link rel="next" href="module-ossaudiodev.html" />
13<link rel="prev" href="module-imghdr.html" />
14<link rel="parent" href="mmedia.html" />
15<link rel="next" href="module-ossaudiodev.html" />
16<meta name='aesop' content='information' />
17<title>14.10 sndhdr -- Determine type of sound file</title>
18</head>
19<body>
20<DIV CLASS="navigation">
21<div id='top-navigation-panel' xml:id='top-navigation-panel'>
22<table align="center" width="100%" cellpadding="0" cellspacing="2">
23<tr>
24<td class='online-navigation'><a rel="prev" title="14.9 imghdr "
25 href="module-imghdr.html"><img src='../icons/previous.png'
26 border='0' height='32' alt='Previous Page' width='32' /></A></td>
27<td class='online-navigation'><a rel="parent" title="14. Multimedia Services"
28 href="mmedia.html"><img src='../icons/up.png'
29 border='0' height='32' alt='Up One Level' width='32' /></A></td>
30<td class='online-navigation'><a rel="next" title="14.11 ossaudiodev "
31 href="module-ossaudiodev.html"><img src='../icons/next.png'
32 border='0' height='32' alt='Next Page' width='32' /></A></td>
33<td align="center" width="100%">Python Library Reference</td>
34<td class='online-navigation'><a rel="contents" title="Table of Contents"
35 href="contents.html"><img src='../icons/contents.png'
36 border='0' height='32' alt='Contents' width='32' /></A></td>
37<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
38 border='0' height='32' alt='Module Index' width='32' /></a></td>
39<td class='online-navigation'><a rel="index" title="Index"
40 href="genindex.html"><img src='../icons/index.png'
41 border='0' height='32' alt='Index' width='32' /></A></td>
42</tr></table>
43<div class='online-navigation'>
44<b class="navlabel">Previous:</b>
45<a class="sectref" rel="prev" href="module-imghdr.html">14.9 imghdr </A>
46<b class="navlabel">Up:</b>
47<a class="sectref" rel="parent" href="mmedia.html">14. Multimedia Services</A>
48<b class="navlabel">Next:</b>
49<a class="sectref" rel="next" href="module-ossaudiodev.html">14.11 ossaudiodev </A>
50</div>
51<hr /></div>
52</DIV>
53<!--End of Navigation Panel-->
54
55<H1><A NAME="SECTION00161000000000000000000">
5614.10 <tt class="module">sndhdr</tt> --
57 Determine type of sound file</A>
58</H1>
59
60<P>
61<A NAME="module-sndhdr"></A>
62
63<P>
64The <tt class="module">sndhdr</tt> provides utility functions which attempt to
65determine the type of sound data which is in a file. When these
66functions are able to determine what type of sound data is stored in a
67file, they return a tuple <code>(<var>type</var>, <var>sampling_rate</var>,
68<var>channels</var>, <var>frames</var>, <var>bits_per_sample</var>)</code>. The value for
69<var>type</var> indicates the data type and will be one of the strings
70<code>'aifc'</code>, <code>'aiff'</code>, <code>'au'</code>, <code>'hcom'</code>,
71<code>'sndr'</code>, <code>'sndt'</code>, <code>'voc'</code>, <code>'wav'</code>,
72<code>'8svx'</code>, <code>'sb'</code>, <code>'ub'</code>, or <code>'ul'</code>. The
73<var>sampling_rate</var> will be either the actual value or <code>0</code> if
74unknown or difficult to decode. Similarly, <var>channels</var> will be
75either the number of channels or <code>0</code> if it cannot be determined
76or if the value is difficult to decode. The value for <var>frames</var>
77will be either the number of frames or <code>-1</code>. The last item in
78the tuple, <var>bits_per_sample</var>, will either be the sample size in
79bits or <code>'A'</code> for A-LAW<a id='l2h-4767' xml:id='l2h-4767'></a> or <code>'U'</code> for
80u-LAW<a id='l2h-4768' xml:id='l2h-4768'></a>.
81
82<P>
83<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
84 <td><nobr><b><tt id='l2h-4765' xml:id='l2h-4765' class="function">what</tt></b>(</nobr></td>
85 <td><var>filename</var>)</td></tr></table></dt>
86<dd>
87 Determines the type of sound data stored in the file <var>filename</var>
88 using <tt class="function">whathdr()</tt>. If it succeeds, returns a tuple as
89 described above, otherwise <code>None</code> is returned.
90</dl>
91
92<P>
93<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
94 <td><nobr><b><tt id='l2h-4766' xml:id='l2h-4766' class="function">whathdr</tt></b>(</nobr></td>
95 <td><var>filename</var>)</td></tr></table></dt>
96<dd>
97 Determines the type of sound data stored in a file based on the file
98 header. The name of the file is given by <var>filename</var>. This
99 function returns a tuple as described above on success, or
100 <code>None</code>.
101</dl>
102
103<DIV CLASS="navigation">
104<div class='online-navigation'>
105<p></p><hr />
106<table align="center" width="100%" cellpadding="0" cellspacing="2">
107<tr>
108<td class='online-navigation'><a rel="prev" title="14.9 imghdr "
109 href="module-imghdr.html"><img src='../icons/previous.png'
110 border='0' height='32' alt='Previous Page' width='32' /></A></td>
111<td class='online-navigation'><a rel="parent" title="14. Multimedia Services"
112 href="mmedia.html"><img src='../icons/up.png'
113 border='0' height='32' alt='Up One Level' width='32' /></A></td>
114<td class='online-navigation'><a rel="next" title="14.11 ossaudiodev "
115 href="module-ossaudiodev.html"><img src='../icons/next.png'
116 border='0' height='32' alt='Next Page' width='32' /></A></td>
117<td align="center" width="100%">Python Library Reference</td>
118<td class='online-navigation'><a rel="contents" title="Table of Contents"
119 href="contents.html"><img src='../icons/contents.png'
120 border='0' height='32' alt='Contents' width='32' /></A></td>
121<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
122 border='0' height='32' alt='Module Index' width='32' /></a></td>
123<td class='online-navigation'><a rel="index" title="Index"
124 href="genindex.html"><img src='../icons/index.png'
125 border='0' height='32' alt='Index' width='32' /></A></td>
126</tr></table>
127<div class='online-navigation'>
128<b class="navlabel">Previous:</b>
129<a class="sectref" rel="prev" href="module-imghdr.html">14.9 imghdr </A>
130<b class="navlabel">Up:</b>
131<a class="sectref" rel="parent" href="mmedia.html">14. Multimedia Services</A>
132<b class="navlabel">Next:</b>
133<a class="sectref" rel="next" href="module-ossaudiodev.html">14.11 ossaudiodev </A>
134</div>
135</div>
136<hr />
137<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
138</DIV>
139<!--End of Navigation Panel-->
140<ADDRESS>
141See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
142</ADDRESS>
143</BODY>
144</HTML>