File: reader_8h.html

package info (click to toggle)
libmpcdec 1.2.2-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, lenny
  • size: 2,900 kB
  • ctags: 4,893
  • sloc: sh: 8,435; ansic: 2,735; cpp: 237; makefile: 88
file content (113 lines) | stat: -rw-r--r-- 6,749 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libmpcdec: include/mpcdec/reader.h File Reference</title>
<link href="custom.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<div class="nav">
<a class="el" href="dir_000000.html">include</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000001.html">mpcdec</a></div>
<h1>reader.h File Reference</h1>
<p>
<a href="reader_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmpc__reader__t.html">mpc_reader_t</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stream reader interface structure.  <a href="structmpc__reader__t.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmpc__reader__file__t.html">mpc_reader_file_t</a></td></tr>

<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structmpc__reader__t.html">mpc_reader_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="reader_8h.html#a0">mpc_reader</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stream reader interface structure.  <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="reader.h::mpc_reader_file" ref="a1" args="" -->
typedef <a class="el" href="structmpc__reader__file__t.html">mpc_reader_file_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>mpc_reader_file</b></td></tr>

<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="reader_8h.html#a2">mpc_reader_setup_file_reader</a> (<a class="el" href="structmpc__reader__file__t.html">mpc_reader_file</a> *r, FILE *input)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>

<p>
Definition in file <a class="el" href="reader_8h-source.html">reader.h</a>.<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="a0"></a><!-- doxytag: member="reader.h::mpc_reader" ref="a0" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">typedef struct <a class="el" href="structmpc__reader__t.html">mpc_reader_t</a>  <a class="el" href="structmpc__reader__t.html">mpc_reader</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Stream reader interface structure. 
<p>
This is the structure you must supply to the musepack decoding library to feed it with raw data. Implement the five member functions to provide a functional reader.     </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a2"></a><!-- doxytag: member="reader.h::mpc_reader_setup_file_reader" ref="a2" args="(mpc_reader_file *r, FILE *input)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void mpc_reader_setup_file_reader           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="structmpc__reader__file__t.html">mpc_reader_file</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>r</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>FILE *&nbsp;</td>
          <td class="mdname" nowrap> <em>input</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Initializes reader with default stdio file reader implementation. Use this if you're just reading from a plain file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>r</em>&nbsp;</td><td>reader struct to initalize </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>input</em>&nbsp;</td><td>input stream to attach to the reader </td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="mpc__reader_8c-source.html#l00082">82</a> of file <a class="el" href="mpc__reader_8c-source.html">mpc_reader.c</a>.
<p>
References <a class="el" href="structmpc__reader__t.html#o4">mpc_reader_t::canseek</a>, <a class="el" href="reader_8h-source.html#l00063">mpc_reader_t::data</a>, <a class="el" href="reader_8h-source.html#l00070">mpc_reader_file_t::file</a>, <a class="el" href="reader_8h-source.html#l00071">mpc_reader_file_t::file_size</a>, <a class="el" href="structmpc__reader__t.html#o3">mpc_reader_t::get_size</a>, <a class="el" href="reader_8h-source.html#l00072">mpc_reader_file_t::is_seekable</a>, <a class="el" href="structmpc__reader__t.html#o0">mpc_reader_t::read</a>, <a class="el" href="reader_8h-source.html#l00068">mpc_reader_file_t::reader</a>, <a class="el" href="structmpc__reader__t.html#o1">mpc_reader_t::seek</a>, and <a class="el" href="structmpc__reader__t.html#o2">mpc_reader_t::tell</a>.    </td>
  </tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun Oct 23 16:35:24 2005 for libmpcdec by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
</body>
</html>