~ubuntu-branches/ubuntu/feisty/flac/feisty-security

« back to all changes in this revision

Viewing changes to doc/html/api/format_8h.html

  • Committer: Bazaar Package Importer
  • Author(s): Tollef Fog Heen
  • Date: 2005-11-10 12:55:33 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20051110125533-2fmlml8wnb06r5vg
Tags: 1.1.2-3ubuntu1
* Merge with Debian
  - We did the C++ transition earlier than Debian, so add c2 suffix to
    liboggflac++ and libflac++

Show diffs side-by-side

added added

removed removed

Lines of Context:
39
39
<tr><td nowrap align=right valign=top>struct &nbsp;</td><td valign=bottom><a class="el" href="structFLAC____StreamMetadata__Unknown.html">FLAC__StreamMetadata_Unknown</a></td></tr>
40
40
<tr><td nowrap align=right valign=top>struct &nbsp;</td><td valign=bottom><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a></td></tr>
41
41
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
42
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a72">FLAC__MAX_METADATA_TYPE_CODE</a>&nbsp;&nbsp;&nbsp;(126u)</td></tr>
43
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a73">FLAC__MIN_BLOCK_SIZE</a>&nbsp;&nbsp;&nbsp;(16u)</td></tr>
44
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a74">FLAC__MAX_BLOCK_SIZE</a>&nbsp;&nbsp;&nbsp;(65535u)</td></tr>
45
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a75">FLAC__MAX_CHANNELS</a>&nbsp;&nbsp;&nbsp;(8u)</td></tr>
46
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a76">FLAC__MIN_BITS_PER_SAMPLE</a>&nbsp;&nbsp;&nbsp;(4u)</td></tr>
47
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a77">FLAC__MAX_BITS_PER_SAMPLE</a>&nbsp;&nbsp;&nbsp;(32u)</td></tr>
48
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a78">FLAC__REFERENCE_CODEC_MAX_BITS_PER_SAMPLE</a>&nbsp;&nbsp;&nbsp;(24u)</td></tr>
49
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a79">FLAC__MAX_SAMPLE_RATE</a>&nbsp;&nbsp;&nbsp;(655350u)</td></tr>
50
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a80">FLAC__MAX_LPC_ORDER</a>&nbsp;&nbsp;&nbsp;(32u)</td></tr>
51
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a81">FLAC__MIN_QLP_COEFF_PRECISION</a>&nbsp;&nbsp;&nbsp;(5u)</td></tr>
52
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a82">FLAC__MAX_QLP_COEFF_PRECISION</a>&nbsp;&nbsp;&nbsp;(15u)</td></tr>
53
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a83">FLAC__MAX_FIXED_ORDER</a>&nbsp;&nbsp;&nbsp;(4u)</td></tr>
54
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a84">FLAC__MAX_RICE_PARTITION_ORDER</a>&nbsp;&nbsp;&nbsp;(15u)</td></tr>
55
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a85">FLAC__SUBSET_MAX_RICE_PARTITION_ORDER</a>&nbsp;&nbsp;&nbsp;(8u)</td></tr>
56
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a86">FLAC__STREAM_SYNC_LENGTH</a>&nbsp;&nbsp;&nbsp;(4u)</td></tr>
57
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a87">FLAC__STREAM_METADATA_STREAMINFO_LENGTH</a>&nbsp;&nbsp;&nbsp;(34u)</td></tr>
58
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a88">FLAC__STREAM_METADATA_SEEKPOINT_LENGTH</a>&nbsp;&nbsp;&nbsp;(18u)</td></tr>
59
 
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a89">FLAC__STREAM_METADATA_HEADER_LENGTH</a>&nbsp;&nbsp;&nbsp;(4u)</td></tr>
 
42
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a75">FLAC__MAX_METADATA_TYPE_CODE</a>&nbsp;&nbsp;&nbsp;(126u)</td></tr>
 
43
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a76">FLAC__MIN_BLOCK_SIZE</a>&nbsp;&nbsp;&nbsp;(16u)</td></tr>
 
44
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a77">FLAC__MAX_BLOCK_SIZE</a>&nbsp;&nbsp;&nbsp;(65535u)</td></tr>
 
45
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a78">FLAC__MAX_CHANNELS</a>&nbsp;&nbsp;&nbsp;(8u)</td></tr>
 
46
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a79">FLAC__MIN_BITS_PER_SAMPLE</a>&nbsp;&nbsp;&nbsp;(4u)</td></tr>
 
47
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a80">FLAC__MAX_BITS_PER_SAMPLE</a>&nbsp;&nbsp;&nbsp;(32u)</td></tr>
 
48
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a81">FLAC__REFERENCE_CODEC_MAX_BITS_PER_SAMPLE</a>&nbsp;&nbsp;&nbsp;(24u)</td></tr>
 
49
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a82">FLAC__MAX_SAMPLE_RATE</a>&nbsp;&nbsp;&nbsp;(655350u)</td></tr>
 
50
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a83">FLAC__MAX_LPC_ORDER</a>&nbsp;&nbsp;&nbsp;(32u)</td></tr>
 
51
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a84">FLAC__MIN_QLP_COEFF_PRECISION</a>&nbsp;&nbsp;&nbsp;(5u)</td></tr>
 
52
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a85">FLAC__MAX_QLP_COEFF_PRECISION</a>&nbsp;&nbsp;&nbsp;(15u)</td></tr>
 
53
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a86">FLAC__MAX_FIXED_ORDER</a>&nbsp;&nbsp;&nbsp;(4u)</td></tr>
 
54
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a87">FLAC__MAX_RICE_PARTITION_ORDER</a>&nbsp;&nbsp;&nbsp;(15u)</td></tr>
 
55
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a88">FLAC__SUBSET_MAX_RICE_PARTITION_ORDER</a>&nbsp;&nbsp;&nbsp;(8u)</td></tr>
 
56
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a89">FLAC__STREAM_SYNC_LENGTH</a>&nbsp;&nbsp;&nbsp;(4u)</td></tr>
 
57
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a90">FLAC__STREAM_METADATA_STREAMINFO_LENGTH</a>&nbsp;&nbsp;&nbsp;(34u)</td></tr>
 
58
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a91">FLAC__STREAM_METADATA_SEEKPOINT_LENGTH</a>&nbsp;&nbsp;&nbsp;(18u)</td></tr>
 
59
<tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a92">FLAC__STREAM_METADATA_HEADER_LENGTH</a>&nbsp;&nbsp;&nbsp;(4u)</td></tr>
60
60
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
61
 
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a90">FLAC__EntropyCodingMethodType</a> { <a class="el" href="group__flac__format.html#a90a86">FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE</a> =  0
62
 
 }</td></tr>
63
 
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a91">FLAC__SubframeType</a> { <a class="el" href="group__flac__format.html#a91a87">FLAC__SUBFRAME_TYPE_CONSTANT</a> =  0, 
64
 
<a class="el" href="group__flac__format.html#a91a88">FLAC__SUBFRAME_TYPE_VERBATIM</a> =  1, 
65
 
<a class="el" href="group__flac__format.html#a91a89">FLAC__SUBFRAME_TYPE_FIXED</a> =  2, 
66
 
<a class="el" href="group__flac__format.html#a91a90">FLAC__SUBFRAME_TYPE_LPC</a> =  3
67
 
 }</td></tr>
68
 
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a92">FLAC__ChannelAssignment</a> { <a class="el" href="group__flac__format.html#a92a91">FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT</a> =  0, 
69
 
<a class="el" href="group__flac__format.html#a92a92">FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE</a> =  1, 
70
 
<a class="el" href="group__flac__format.html#a92a93">FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE</a> =  2, 
71
 
<a class="el" href="group__flac__format.html#a92a94">FLAC__CHANNEL_ASSIGNMENT_MID_SIDE</a> =  3
72
 
 }</td></tr>
73
 
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a93">FLAC__FrameNumberType</a> { <a class="el" href="group__flac__format.html#a93a95">FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER</a>, 
74
 
<a class="el" href="group__flac__format.html#a93a96">FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER</a>
75
 
 }</td></tr>
76
 
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a94">FLAC__MetadataType</a> { <br>
77
 
&nbsp;&nbsp;<a class="el" href="group__flac__format.html#a94a97">FLAC__METADATA_TYPE_STREAMINFO</a> =  0, 
78
 
<a class="el" href="group__flac__format.html#a94a98">FLAC__METADATA_TYPE_PADDING</a> =  1, 
79
 
<a class="el" href="group__flac__format.html#a94a99">FLAC__METADATA_TYPE_APPLICATION</a> =  2, 
80
 
<a class="el" href="group__flac__format.html#a94a100">FLAC__METADATA_TYPE_SEEKTABLE</a> =  3, 
 
61
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a93">FLAC__EntropyCodingMethodType</a> { <a class="el" href="group__flac__format.html#a93a86">FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE</a> =  0
 
62
 }</td></tr>
 
63
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a94">FLAC__SubframeType</a> { <a class="el" href="group__flac__format.html#a94a87">FLAC__SUBFRAME_TYPE_CONSTANT</a> =  0, 
 
64
<a class="el" href="group__flac__format.html#a94a88">FLAC__SUBFRAME_TYPE_VERBATIM</a> =  1, 
 
65
<a class="el" href="group__flac__format.html#a94a89">FLAC__SUBFRAME_TYPE_FIXED</a> =  2, 
 
66
<a class="el" href="group__flac__format.html#a94a90">FLAC__SUBFRAME_TYPE_LPC</a> =  3
 
67
 }</td></tr>
 
68
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a95">FLAC__ChannelAssignment</a> { <a class="el" href="group__flac__format.html#a95a91">FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT</a> =  0, 
 
69
<a class="el" href="group__flac__format.html#a95a92">FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE</a> =  1, 
 
70
<a class="el" href="group__flac__format.html#a95a93">FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE</a> =  2, 
 
71
<a class="el" href="group__flac__format.html#a95a94">FLAC__CHANNEL_ASSIGNMENT_MID_SIDE</a> =  3
 
72
 }</td></tr>
 
73
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a96">FLAC__FrameNumberType</a> { <a class="el" href="group__flac__format.html#a96a95">FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER</a>, 
 
74
<a class="el" href="group__flac__format.html#a96a96">FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER</a>
 
75
 }</td></tr>
 
76
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a> { <br>
 
77
&nbsp;&nbsp;<a class="el" href="group__flac__format.html#a97a97">FLAC__METADATA_TYPE_STREAMINFO</a> =  0, 
 
78
<a class="el" href="group__flac__format.html#a97a98">FLAC__METADATA_TYPE_PADDING</a> =  1, 
 
79
<a class="el" href="group__flac__format.html#a97a99">FLAC__METADATA_TYPE_APPLICATION</a> =  2, 
 
80
<a class="el" href="group__flac__format.html#a97a100">FLAC__METADATA_TYPE_SEEKTABLE</a> =  3, 
81
81
<br>
82
 
&nbsp;&nbsp;<a class="el" href="group__flac__format.html#a94a101">FLAC__METADATA_TYPE_VORBIS_COMMENT</a> =  4, 
83
 
<a class="el" href="group__flac__format.html#a94a102">FLAC__METADATA_TYPE_CUESHEET</a> =  5, 
84
 
<a class="el" href="group__flac__format.html#a94a103">FLAC__METADATA_TYPE_UNDEFINED</a> =  6
 
82
&nbsp;&nbsp;<a class="el" href="group__flac__format.html#a97a101">FLAC__METADATA_TYPE_VORBIS_COMMENT</a> =  4, 
 
83
<a class="el" href="group__flac__format.html#a97a102">FLAC__METADATA_TYPE_CUESHEET</a> =  5, 
 
84
<a class="el" href="group__flac__format.html#a97a103">FLAC__METADATA_TYPE_UNDEFINED</a> =  6
85
85
<br>
86
86
 }</td></tr>
87
87
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
88
88
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a68">FLAC__format_sample_rate_is_valid</a> (unsigned sample_rate)</td></tr>
89
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a69">FLAC__format_seektable_is_legal</a> (const <a class="el" href="structFLAC____StreamMetadata__SeekTable.html">FLAC__StreamMetadata_SeekTable</a> *seek_table)</td></tr>
90
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a70">FLAC__format_seektable_sort</a> (<a class="el" href="structFLAC____StreamMetadata__SeekTable.html">FLAC__StreamMetadata_SeekTable</a> *seek_table)</td></tr>
91
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a71">FLAC__format_cuesheet_is_legal</a> (const <a class="el" href="structFLAC____StreamMetadata__CueSheet.html">FLAC__StreamMetadata_CueSheet</a> *cue_sheet, FLAC__bool check_cd_da_subset, const char **violation)</td></tr>
 
89
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a69">FLAC__format_vorbiscomment_entry_name_is_legal</a> (const char *name)</td></tr>
 
90
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a70">FLAC__format_vorbiscomment_entry_value_is_legal</a> (const FLAC__byte *value, unsigned length)</td></tr>
 
91
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a71">FLAC__format_vorbiscomment_entry_is_legal</a> (const FLAC__byte *entry, unsigned length)</td></tr>
 
92
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a72">FLAC__format_seektable_is_legal</a> (const <a class="el" href="structFLAC____StreamMetadata__SeekTable.html">FLAC__StreamMetadata_SeekTable</a> *seek_table)</td></tr>
 
93
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a73">FLAC__format_seektable_sort</a> (<a class="el" href="structFLAC____StreamMetadata__SeekTable.html">FLAC__StreamMetadata_SeekTable</a> *seek_table)</td></tr>
 
94
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a74">FLAC__format_cuesheet_is_legal</a> (const <a class="el" href="structFLAC____StreamMetadata__CueSheet.html">FLAC__StreamMetadata_CueSheet</a> *cue_sheet, FLAC__bool check_cd_da_subset, const char **violation)</td></tr>
92
95
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
93
96
<tr><td nowrap align=right valign=top>const char *&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a0">FLAC__VERSION_STRING</a></td></tr>
94
97
<tr><td nowrap align=right valign=top>const char *&nbsp;</td><td valign=bottom><a class="el" href="group__flac__format.html#a1">FLAC__VENDOR_STRING</a></td></tr>
172
175
<p>
173
176
 See the detailed documentation in the <a class="el" href="group__flac__format.html">format</a> module.
174
177
<p>
175
 
<hr><address><small>Generated on Tue Sep 28 21:19:42 2004 for FLAC by
 
178
<hr><address><small>Generated on Fri Feb 4 18:39:12 2005 for FLAC by
176
179
<a href="http://www.doxygen.org/index.html">
177
180
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
178
181
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,