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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
|
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FLAC: FLAC/stream_decoder.h: stream decoder interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FLAC
 <span id="projectnumber">1.3.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">FLAC/stream_decoder.h: stream decoder interface<div class="ingroups"><a class="el" href="group__flac.html">FLAC C API</a> » <a class="el" href="group__flac__decoder.html">FLAC/_decoder.h: decoder interfaces</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga25d4321dc2f122d35ddc9061f44beae7"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__decoder.html#gad793ead451206c64a91dc0b851027b93">FLAC__StreamDecoderReadStatus</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga25d4321dc2f122d35ddc9061f44beae7">FLAC__StreamDecoderReadCallback</a>) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data)</td></tr>
<tr class="separator:ga25d4321dc2f122d35ddc9061f44beae7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c18b0216e0f7a83d7e4e7001230545d"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__decoder.html#gac8d269e3c7af1a5889d3bd38409ed67d">FLAC__StreamDecoderSeekStatus</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga4c18b0216e0f7a83d7e4e7001230545d">FLAC__StreamDecoderSeekCallback</a>) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 absolute_byte_offset, void *client_data)</td></tr>
<tr class="separator:ga4c18b0216e0f7a83d7e4e7001230545d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafdf1852486617a40c285c0d76d451a5a"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__decoder.html#ga83708207969383bd7b5c1e9148528845">FLAC__StreamDecoderTellStatus</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gafdf1852486617a40c285c0d76d451a5a">FLAC__StreamDecoderTellCallback</a>) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data)</td></tr>
<tr class="separator:gafdf1852486617a40c285c0d76d451a5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5363f3b46e3f7d6a73385f6560f7e7ef"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__decoder.html#gad5860157c2bb34501b8b9370472d727a">FLAC__StreamDecoderLengthStatus</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga5363f3b46e3f7d6a73385f6560f7e7ef">FLAC__StreamDecoderLengthCallback</a>) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 *stream_length, void *client_data)</td></tr>
<tr class="separator:ga5363f3b46e3f7d6a73385f6560f7e7ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4eac094fc609363532d90cf8374b4f7e"><td class="memItemLeft" align="right" valign="top">typedef FLAC__bool(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga4eac094fc609363532d90cf8374b4f7e">FLAC__StreamDecoderEofCallback</a>) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, void *client_data)</td></tr>
<tr class="separator:ga4eac094fc609363532d90cf8374b4f7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga61e48dc2c0d2f6c5519290ff046874a4"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__decoder.html#ga73f67eb9e0ab57945afe038751bc62c8">FLAC__StreamDecoderWriteStatus</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a>) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, const <a class="el" href="structFLAC____Frame.html">FLAC__Frame</a> *frame, const FLAC__int32 *const buffer[], void *client_data)</td></tr>
<tr class="separator:ga61e48dc2c0d2f6c5519290ff046874a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6aa87c01744c1c601b7f371f627b6e14"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a>) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, const <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, void *client_data)</td></tr>
<tr class="separator:ga6aa87c01744c1c601b7f371f627b6e14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac896ee6a12668e9015fab4fbc6aae996"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a>) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, <a class="el" href="group__flac__stream__decoder.html#ga130e70bd9a73d3c2416247a3e5132ecf">FLAC__StreamDecoderErrorStatus</a> status, void *client_data)</td></tr>
<tr class="separator:gac896ee6a12668e9015fab4fbc6aae996"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga3adb6891c5871a87cd5bbae6c770ba2d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga3adb6891c5871a87cd5bbae6c770ba2d">FLAC__StreamDecoderState</a> { <br />
  <a class="el" href="group__flac__stream__decoder.html#gga3adb6891c5871a87cd5bbae6c770ba2dacf4455f4f681a6737a553e10f614704a">FLAC__STREAM_DECODER_SEARCH_FOR_METADATA</a> = 0,
<a class="el" href="group__flac__stream__decoder.html#gga3adb6891c5871a87cd5bbae6c770ba2da4c1853ed1babdcede9a908e12cf7ccf7">FLAC__STREAM_DECODER_READ_METADATA</a>,
<a class="el" href="group__flac__stream__decoder.html#gga3adb6891c5871a87cd5bbae6c770ba2daccff915757978117720ba1613d088ddf">FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC</a>,
<a class="el" href="group__flac__stream__decoder.html#gga3adb6891c5871a87cd5bbae6c770ba2da06dc6158a51a8eb9537b65f2fbb6dc49">FLAC__STREAM_DECODER_READ_FRAME</a>,
<br />
  <a class="el" href="group__flac__stream__decoder.html#gga3adb6891c5871a87cd5bbae6c770ba2da28ce845052d9d1a780f4107e97f4c853">FLAC__STREAM_DECODER_END_OF_STREAM</a>,
<a class="el" href="group__flac__stream__decoder.html#gga3adb6891c5871a87cd5bbae6c770ba2da3bc0343f47153c5779baf7f37f6e95cf">FLAC__STREAM_DECODER_OGG_ERROR</a>,
<a class="el" href="group__flac__stream__decoder.html#gga3adb6891c5871a87cd5bbae6c770ba2daf2c6efcabdfe889081c2260e6681db49">FLAC__STREAM_DECODER_SEEK_ERROR</a>,
<a class="el" href="group__flac__stream__decoder.html#gga3adb6891c5871a87cd5bbae6c770ba2dadb52ab4785bd2eb84a95e8aa82311cd5">FLAC__STREAM_DECODER_ABORTED</a>,
<br />
  <a class="el" href="group__flac__stream__decoder.html#gga3adb6891c5871a87cd5bbae6c770ba2da0d08c527252420813e6a6d6d3e19324a">FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR</a>,
<a class="el" href="group__flac__stream__decoder.html#gga3adb6891c5871a87cd5bbae6c770ba2da565eaf4d5e68b440ecec771cb22d3427">FLAC__STREAM_DECODER_UNINITIALIZED</a>
<br />
}</td></tr>
<tr class="separator:ga3adb6891c5871a87cd5bbae6c770ba2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaed54a24ac6310d29c5cafba79759c44"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> { <br />
  <a class="el" href="group__flac__stream__decoder.html#ggaaed54a24ac6310d29c5cafba79759c44ac94c7e9396f30642f34805e5d626e011">FLAC__STREAM_DECODER_INIT_STATUS_OK</a> = 0,
<a class="el" href="group__flac__stream__decoder.html#ggaaed54a24ac6310d29c5cafba79759c44a8f2188c616c9bc09638eece3ae55f152">FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER</a>,
<a class="el" href="group__flac__stream__decoder.html#ggaaed54a24ac6310d29c5cafba79759c44a798ad4b6c4e556fd4cb1afbc29562eca">FLAC__STREAM_DECODER_INIT_STATUS_INVALID_CALLBACKS</a>,
<a class="el" href="group__flac__stream__decoder.html#ggaaed54a24ac6310d29c5cafba79759c44a0110567f0715c6f87357388bc7fa98f9">FLAC__STREAM_DECODER_INIT_STATUS_MEMORY_ALLOCATION_ERROR</a>,
<br />
  <a class="el" href="group__flac__stream__decoder.html#ggaaed54a24ac6310d29c5cafba79759c44a8184c306e0cd2565a8c5adc1381cb469">FLAC__STREAM_DECODER_INIT_STATUS_ERROR_OPENING_FILE</a>,
<a class="el" href="group__flac__stream__decoder.html#ggaaed54a24ac6310d29c5cafba79759c44a98bc501c9b2fb5d92d8bb0b3321d504f">FLAC__STREAM_DECODER_INIT_STATUS_ALREADY_INITIALIZED</a>
<br />
}</td></tr>
<tr class="separator:gaaed54a24ac6310d29c5cafba79759c44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad793ead451206c64a91dc0b851027b93"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gad793ead451206c64a91dc0b851027b93">FLAC__StreamDecoderReadStatus</a> { <a class="el" href="group__flac__stream__decoder.html#ggad793ead451206c64a91dc0b851027b93a9a5be0fcf0279b98b2fd462bc4871d06">FLAC__STREAM_DECODER_READ_STATUS_CONTINUE</a>,
<a class="el" href="group__flac__stream__decoder.html#ggad793ead451206c64a91dc0b851027b93a0a0687d25dc9f7163e6e5e294672170f">FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM</a>,
<a class="el" href="group__flac__stream__decoder.html#ggad793ead451206c64a91dc0b851027b93a923123aebb349e35662e35a7621b7535">FLAC__STREAM_DECODER_READ_STATUS_ABORT</a>
}</td></tr>
<tr class="separator:gad793ead451206c64a91dc0b851027b93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac8d269e3c7af1a5889d3bd38409ed67d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gac8d269e3c7af1a5889d3bd38409ed67d">FLAC__StreamDecoderSeekStatus</a> { <a class="el" href="group__flac__stream__decoder.html#ggac8d269e3c7af1a5889d3bd38409ed67daca58132d896ad7755827d3f2b72488cc">FLAC__STREAM_DECODER_SEEK_STATUS_OK</a>,
<a class="el" href="group__flac__stream__decoder.html#ggac8d269e3c7af1a5889d3bd38409ed67da969ce92a42a2a95609452e9cf01fcc09">FLAC__STREAM_DECODER_SEEK_STATUS_ERROR</a>,
<a class="el" href="group__flac__stream__decoder.html#ggac8d269e3c7af1a5889d3bd38409ed67da4a01f1e48baf015e78535cc20683ec53">FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED</a>
}</td></tr>
<tr class="separator:gac8d269e3c7af1a5889d3bd38409ed67d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga83708207969383bd7b5c1e9148528845"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga83708207969383bd7b5c1e9148528845">FLAC__StreamDecoderTellStatus</a> { <a class="el" href="group__flac__stream__decoder.html#gga83708207969383bd7b5c1e9148528845a516a202ebf4bb61d4a1fb5b029a104dd">FLAC__STREAM_DECODER_TELL_STATUS_OK</a>,
<a class="el" href="group__flac__stream__decoder.html#gga83708207969383bd7b5c1e9148528845aceefd3feb853d5e68a149f2bdd1a9db1">FLAC__STREAM_DECODER_TELL_STATUS_ERROR</a>,
<a class="el" href="group__flac__stream__decoder.html#gga83708207969383bd7b5c1e9148528845add75538234493c9f7a20a846a223ca91">FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED</a>
}</td></tr>
<tr class="separator:ga83708207969383bd7b5c1e9148528845"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad5860157c2bb34501b8b9370472d727a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gad5860157c2bb34501b8b9370472d727a">FLAC__StreamDecoderLengthStatus</a> { <a class="el" href="group__flac__stream__decoder.html#ggad5860157c2bb34501b8b9370472d727aaef01bfcdc3099686e106d8f88397653d">FLAC__STREAM_DECODER_LENGTH_STATUS_OK</a>,
<a class="el" href="group__flac__stream__decoder.html#ggad5860157c2bb34501b8b9370472d727aab000e31c0c20c0d19df4f2203b01ea23">FLAC__STREAM_DECODER_LENGTH_STATUS_ERROR</a>,
<a class="el" href="group__flac__stream__decoder.html#ggad5860157c2bb34501b8b9370472d727aae35949f46f887e6d826fe0fe4b2a32c1">FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED</a>
}</td></tr>
<tr class="separator:gad5860157c2bb34501b8b9370472d727a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga73f67eb9e0ab57945afe038751bc62c8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga73f67eb9e0ab57945afe038751bc62c8">FLAC__StreamDecoderWriteStatus</a> { <a class="el" href="group__flac__stream__decoder.html#gga73f67eb9e0ab57945afe038751bc62c8acea48326e0ab8370d2814f4126fcb84e">FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE</a>,
<a class="el" href="group__flac__stream__decoder.html#gga73f67eb9e0ab57945afe038751bc62c8a23bd6bfec34af704e0d5ea273f14d95d">FLAC__STREAM_DECODER_WRITE_STATUS_ABORT</a>
}</td></tr>
<tr class="separator:ga73f67eb9e0ab57945afe038751bc62c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga130e70bd9a73d3c2416247a3e5132ecf"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga130e70bd9a73d3c2416247a3e5132ecf">FLAC__StreamDecoderErrorStatus</a> { <a class="el" href="group__flac__stream__decoder.html#gga130e70bd9a73d3c2416247a3e5132ecfa3ceec2a553dc142ad487ae88eb6f7222">FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC</a>,
<a class="el" href="group__flac__stream__decoder.html#gga130e70bd9a73d3c2416247a3e5132ecfae393a9b91a6b2f23398675b5b57e1e86">FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER</a>,
<a class="el" href="group__flac__stream__decoder.html#gga130e70bd9a73d3c2416247a3e5132ecfa208fe77a04e6ff684e50f0eae1214e26">FLAC__STREAM_DECODER_ERROR_STATUS_FRAME_CRC_MISMATCH</a>,
<a class="el" href="group__flac__stream__decoder.html#gga130e70bd9a73d3c2416247a3e5132ecfa8b6864ad65edd8fea039838b6d3e5575">FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM</a>
}</td></tr>
<tr class="separator:ga130e70bd9a73d3c2416247a3e5132ecf"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga529c3c1e46417570767fb8e4c76f5477"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga529c3c1e46417570767fb8e4c76f5477">FLAC__stream_decoder_new</a> (void)</td></tr>
<tr class="separator:ga529c3c1e46417570767fb8e4c76f5477"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad9cf299956da091111d13e83517d8c44"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gad9cf299956da091111d13e83517d8c44">FLAC__stream_decoder_delete</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:gad9cf299956da091111d13e83517d8c44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7fd232e7a2b5070bd26450487edbc2a1"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga7fd232e7a2b5070bd26450487edbc2a1">FLAC__stream_decoder_set_ogg_serial_number</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, long serial_number)</td></tr>
<tr class="separator:ga7fd232e7a2b5070bd26450487edbc2a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8f402243eed54f400ddd2f296ff54497"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga8f402243eed54f400ddd2f296ff54497">FLAC__stream_decoder_set_md5_checking</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__bool value)</td></tr>
<tr class="separator:ga8f402243eed54f400ddd2f296ff54497"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad4e685f3d055f70fbaed9ffa4f70f74b"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gad4e685f3d055f70fbaed9ffa4f70f74b">FLAC__stream_decoder_set_metadata_respond</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, <a class="el" href="group__flac__format.html#gac71714ba8ddbbd66d26bb78a427fac01">FLAC__MetadataType</a> type)</td></tr>
<tr class="separator:gad4e685f3d055f70fbaed9ffa4f70f74b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaee1196ff5fa97df9810f708dc2bc8326"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gaee1196ff5fa97df9810f708dc2bc8326">FLAC__stream_decoder_set_metadata_respond_application</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, const FLAC__byte id[4])</td></tr>
<tr class="separator:gaee1196ff5fa97df9810f708dc2bc8326"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1ce03d8f305a818ff9a573473af99dc4"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga1ce03d8f305a818ff9a573473af99dc4">FLAC__stream_decoder_set_metadata_respond_all</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:ga1ce03d8f305a818ff9a573473af99dc4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad75f067720da89c4e9d96dedc45f73e6"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gad75f067720da89c4e9d96dedc45f73e6">FLAC__stream_decoder_set_metadata_ignore</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, <a class="el" href="group__flac__format.html#gac71714ba8ddbbd66d26bb78a427fac01">FLAC__MetadataType</a> type)</td></tr>
<tr class="separator:gad75f067720da89c4e9d96dedc45f73e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaab41e8bc505b24df4912de53de06b085"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gaab41e8bc505b24df4912de53de06b085">FLAC__stream_decoder_set_metadata_ignore_application</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, const FLAC__byte id[4])</td></tr>
<tr class="separator:gaab41e8bc505b24df4912de53de06b085"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa1307f07fae5d7a4a0c18beeae7ec5e6"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gaa1307f07fae5d7a4a0c18beeae7ec5e6">FLAC__stream_decoder_set_metadata_ignore_all</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:gaa1307f07fae5d7a4a0c18beeae7ec5e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf99dac2d9255f7db4df8a6d9974a9a9a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__decoder.html#ga3adb6891c5871a87cd5bbae6c770ba2d">FLAC__StreamDecoderState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gaf99dac2d9255f7db4df8a6d9974a9a9a">FLAC__stream_decoder_get_state</a> (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:gaf99dac2d9255f7db4df8a6d9974a9a9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad28257412951ca266751a19e2cf54be2"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gad28257412951ca266751a19e2cf54be2">FLAC__stream_decoder_get_resolved_state_string</a> (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:gad28257412951ca266751a19e2cf54be2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae27a6b30b55beda03559c12a5df21537"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gae27a6b30b55beda03559c12a5df21537">FLAC__stream_decoder_get_md5_checking</a> (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:gae27a6b30b55beda03559c12a5df21537"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga930d9b591fcfaea74359c722cdfb980c"><td class="memItemLeft" align="right" valign="top">FLAC__uint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga930d9b591fcfaea74359c722cdfb980c">FLAC__stream_decoder_get_total_samples</a> (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:ga930d9b591fcfaea74359c722cdfb980c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga802d5f4c48a711b690d6d66d2e3f20a5"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga802d5f4c48a711b690d6d66d2e3f20a5">FLAC__stream_decoder_get_channels</a> (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:ga802d5f4c48a711b690d6d66d2e3f20a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae62fdf93c1fedd5fea9258ecdc78bb53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__format.html#ga79855f8525672e37f299bbe02952ef9c">FLAC__ChannelAssignment</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gae62fdf93c1fedd5fea9258ecdc78bb53">FLAC__stream_decoder_get_channel_assignment</a> (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:gae62fdf93c1fedd5fea9258ecdc78bb53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga689893cde90c171ca343192e92679842"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga689893cde90c171ca343192e92679842">FLAC__stream_decoder_get_bits_per_sample</a> (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:ga689893cde90c171ca343192e92679842"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga95f7cdfefba169d964e3c08672a0f0ad"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga95f7cdfefba169d964e3c08672a0f0ad">FLAC__stream_decoder_get_sample_rate</a> (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:ga95f7cdfefba169d964e3c08672a0f0ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafe07ad9949cc54944fd369fe9335c4bc"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gafe07ad9949cc54944fd369fe9335c4bc">FLAC__stream_decoder_get_blocksize</a> (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:gafe07ad9949cc54944fd369fe9335c4bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaffd9b0d0832ed01e6d75930b5391def5"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gaffd9b0d0832ed01e6d75930b5391def5">FLAC__stream_decoder_get_decode_position</a> (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 *position)</td></tr>
<tr class="separator:gaffd9b0d0832ed01e6d75930b5391def5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga150d381abc5249168e439bc076544b29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga150d381abc5249168e439bc076544b29">FLAC__stream_decoder_init_stream</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, <a class="el" href="group__flac__stream__decoder.html#ga25d4321dc2f122d35ddc9061f44beae7">FLAC__StreamDecoderReadCallback</a> read_callback, <a class="el" href="group__flac__stream__decoder.html#ga4c18b0216e0f7a83d7e4e7001230545d">FLAC__StreamDecoderSeekCallback</a> seek_callback, <a class="el" href="group__flac__stream__decoder.html#gafdf1852486617a40c285c0d76d451a5a">FLAC__StreamDecoderTellCallback</a> tell_callback, <a class="el" href="group__flac__stream__decoder.html#ga5363f3b46e3f7d6a73385f6560f7e7ef">FLAC__StreamDecoderLengthCallback</a> length_callback, <a class="el" href="group__flac__stream__decoder.html#ga4eac094fc609363532d90cf8374b4f7e">FLAC__StreamDecoderEofCallback</a> eof_callback, <a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> write_callback, <a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> metadata_callback, <a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> error_callback, void *client_data)</td></tr>
<tr class="separator:ga150d381abc5249168e439bc076544b29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1b043adeb805c779c1e97cb68959d1ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga1b043adeb805c779c1e97cb68959d1ab">FLAC__stream_decoder_init_ogg_stream</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, <a class="el" href="group__flac__stream__decoder.html#ga25d4321dc2f122d35ddc9061f44beae7">FLAC__StreamDecoderReadCallback</a> read_callback, <a class="el" href="group__flac__stream__decoder.html#ga4c18b0216e0f7a83d7e4e7001230545d">FLAC__StreamDecoderSeekCallback</a> seek_callback, <a class="el" href="group__flac__stream__decoder.html#gafdf1852486617a40c285c0d76d451a5a">FLAC__StreamDecoderTellCallback</a> tell_callback, <a class="el" href="group__flac__stream__decoder.html#ga5363f3b46e3f7d6a73385f6560f7e7ef">FLAC__StreamDecoderLengthCallback</a> length_callback, <a class="el" href="group__flac__stream__decoder.html#ga4eac094fc609363532d90cf8374b4f7e">FLAC__StreamDecoderEofCallback</a> eof_callback, <a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> write_callback, <a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> metadata_callback, <a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> error_callback, void *client_data)</td></tr>
<tr class="separator:ga1b043adeb805c779c1e97cb68959d1ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga80aa83631460a53263c84e654586dff0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga80aa83631460a53263c84e654586dff0">FLAC__stream_decoder_init_FILE</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FILE *file, <a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> write_callback, <a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> metadata_callback, <a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> error_callback, void *client_data)</td></tr>
<tr class="separator:ga80aa83631460a53263c84e654586dff0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4cc7fbaf905c24d6db48b53b7942fe72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga4cc7fbaf905c24d6db48b53b7942fe72">FLAC__stream_decoder_init_ogg_FILE</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FILE *file, <a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> write_callback, <a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> metadata_callback, <a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> error_callback, void *client_data)</td></tr>
<tr class="separator:ga4cc7fbaf905c24d6db48b53b7942fe72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4021ead5cff29fd589c915756f902f1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga4021ead5cff29fd589c915756f902f1a">FLAC__stream_decoder_init_file</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, const char *filename, <a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> write_callback, <a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> metadata_callback, <a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> error_callback, void *client_data)</td></tr>
<tr class="separator:ga4021ead5cff29fd589c915756f902f1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga548f15d7724f3bff7f2608abe8b12f6c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga548f15d7724f3bff7f2608abe8b12f6c">FLAC__stream_decoder_init_ogg_file</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, const char *filename, <a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> write_callback, <a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> metadata_callback, <a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> error_callback, void *client_data)</td></tr>
<tr class="separator:ga548f15d7724f3bff7f2608abe8b12f6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga96c47c96920f363cd0972b54067818a9"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:ga96c47c96920f363cd0972b54067818a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga95570a455e582b2ab46ab9bb529f26ac"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga95570a455e582b2ab46ab9bb529f26ac">FLAC__stream_decoder_flush</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:ga95570a455e582b2ab46ab9bb529f26ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa4183c2d925d5a5edddde9d1ca145725"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gaa4183c2d925d5a5edddde9d1ca145725">FLAC__stream_decoder_reset</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:gaa4183c2d925d5a5edddde9d1ca145725"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9d6df4a39892c05955122cf7f987f856"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga9d6df4a39892c05955122cf7f987f856">FLAC__stream_decoder_process_single</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:ga9d6df4a39892c05955122cf7f987f856"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga027ffb5b75dc39b3d26f55c5e6b42682"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga027ffb5b75dc39b3d26f55c5e6b42682">FLAC__stream_decoder_process_until_end_of_metadata</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:ga027ffb5b75dc39b3d26f55c5e6b42682"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga89a0723812fa6ef7cdb173715f1bc81f"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga89a0723812fa6ef7cdb173715f1bc81f">FLAC__stream_decoder_process_until_end_of_stream</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:ga89a0723812fa6ef7cdb173715f1bc81f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga85b666aba976f29e8dd9d7956fce4301"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga85b666aba976f29e8dd9d7956fce4301">FLAC__stream_decoder_skip_single_frame</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder)</td></tr>
<tr class="separator:ga85b666aba976f29e8dd9d7956fce4301"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6a2eb6072b9fafefc3f80f1959805ccb"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga6a2eb6072b9fafefc3f80f1959805ccb">FLAC__stream_decoder_seek_absolute</a> (<a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 sample)</td></tr>
<tr class="separator:ga6a2eb6072b9fafefc3f80f1959805ccb"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:gac192360ac435614394bf43235cb7981e"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gac192360ac435614394bf43235cb7981e">FLAC__StreamDecoderStateString</a> []</td></tr>
<tr class="separator:gac192360ac435614394bf43235cb7981e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0effa1d3031c3206a1719faf984a4f21"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga0effa1d3031c3206a1719faf984a4f21">FLAC__StreamDecoderInitStatusString</a> []</td></tr>
<tr class="separator:ga0effa1d3031c3206a1719faf984a4f21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab1ee941839b05045ae1d73ee0fdcb8c9"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gab1ee941839b05045ae1d73ee0fdcb8c9">FLAC__StreamDecoderReadStatusString</a> []</td></tr>
<tr class="separator:gab1ee941839b05045ae1d73ee0fdcb8c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac49aff0593584b7ed5fd0b2508f824fc"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gac49aff0593584b7ed5fd0b2508f824fc">FLAC__StreamDecoderSeekStatusString</a> []</td></tr>
<tr class="separator:gac49aff0593584b7ed5fd0b2508f824fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3c1b7d5a174d6c2e6bcf1b9a87b5a5cb"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga3c1b7d5a174d6c2e6bcf1b9a87b5a5cb">FLAC__StreamDecoderTellStatusString</a> []</td></tr>
<tr class="separator:ga3c1b7d5a174d6c2e6bcf1b9a87b5a5cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga792933fa9e8b65bfcac62d82e52415f5"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga792933fa9e8b65bfcac62d82e52415f5">FLAC__StreamDecoderLengthStatusString</a> []</td></tr>
<tr class="separator:ga792933fa9e8b65bfcac62d82e52415f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9df7f0fd8cf9888f97a52b5f3f33cdb0"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#ga9df7f0fd8cf9888f97a52b5f3f33cdb0">FLAC__StreamDecoderWriteStatusString</a> []</td></tr>
<tr class="separator:ga9df7f0fd8cf9888f97a52b5f3f33cdb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac428c69b084529322df05ee793440b88"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html#gac428c69b084529322df05ee793440b88">FLAC__StreamDecoderErrorStatusString</a> []</td></tr>
<tr class="separator:gac428c69b084529322df05ee793440b88"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This module contains the functions which implement the stream decoder. </p>
<p>The stream decoder can decode native FLAC, and optionally Ogg FLAC (check FLAC_API_SUPPORTS_OGG_FLAC) streams and files.</p>
<p>The basic usage of this decoder is as follows:</p><ul>
<li>The program creates an instance of a decoder using <a class="el" href="group__flac__stream__decoder.html#ga529c3c1e46417570767fb8e4c76f5477">FLAC__stream_decoder_new()</a>.</li>
<li>The program overrides the default settings using FLAC__stream_decoder_set_*() functions.</li>
<li>The program initializes the instance to validate the settings and prepare for decoding using<ul>
<li><a class="el" href="group__flac__stream__decoder.html#ga150d381abc5249168e439bc076544b29">FLAC__stream_decoder_init_stream()</a> or <a class="el" href="group__flac__stream__decoder.html#ga80aa83631460a53263c84e654586dff0">FLAC__stream_decoder_init_FILE()</a> or <a class="el" href="group__flac__stream__decoder.html#ga4021ead5cff29fd589c915756f902f1a">FLAC__stream_decoder_init_file()</a> for native FLAC,</li>
<li><a class="el" href="group__flac__stream__decoder.html#ga1b043adeb805c779c1e97cb68959d1ab">FLAC__stream_decoder_init_ogg_stream()</a> or <a class="el" href="group__flac__stream__decoder.html#ga4cc7fbaf905c24d6db48b53b7942fe72">FLAC__stream_decoder_init_ogg_FILE()</a> or <a class="el" href="group__flac__stream__decoder.html#ga548f15d7724f3bff7f2608abe8b12f6c">FLAC__stream_decoder_init_ogg_file()</a> for Ogg FLAC</li>
</ul>
</li>
<li>The program calls the FLAC__stream_decoder_process_*() functions to decode data, which subsequently calls the callbacks.</li>
<li>The program finishes the decoding with <a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish()</a>, which flushes the input and output and resets the decoder to the uninitialized state.</li>
<li>The instance may be used again or deleted with <a class="el" href="group__flac__stream__decoder.html#gad9cf299956da091111d13e83517d8c44">FLAC__stream_decoder_delete()</a>.</li>
</ul>
<p>In more detail, the program will create a new instance by calling <a class="el" href="group__flac__stream__decoder.html#ga529c3c1e46417570767fb8e4c76f5477">FLAC__stream_decoder_new()</a>, then call FLAC__stream_decoder_set_*() functions to override the default decoder options, and call one of the FLAC__stream_decoder_init_*() functions.</p>
<p>There are three initialization functions for native FLAC, one for setting up the decoder to decode FLAC data from the client via callbacks, and two for decoding directly from a FLAC file.</p>
<p>For decoding via callbacks, use <a class="el" href="group__flac__stream__decoder.html#ga150d381abc5249168e439bc076544b29">FLAC__stream_decoder_init_stream()</a>. You must also supply several callbacks for handling I/O. Some (like seeking) are optional, depending on the capabilities of the input.</p>
<p>For decoding directly from a file, use <a class="el" href="group__flac__stream__decoder.html#ga80aa83631460a53263c84e654586dff0">FLAC__stream_decoder_init_FILE()</a> or <a class="el" href="group__flac__stream__decoder.html#ga4021ead5cff29fd589c915756f902f1a">FLAC__stream_decoder_init_file()</a>. Then you must only supply an open <code>FILE*</code> or filename and fewer callbacks; the decoder will handle the other callbacks internally.</p>
<p>There are three similarly-named init functions for decoding from Ogg FLAC streams. Check <code>FLAC_API_SUPPORTS_OGG_FLAC</code> to find out if the library has been built with Ogg support.</p>
<p>Once the decoder is initialized, your program will call one of several functions to start the decoding process:</p>
<ul>
<li><a class="el" href="group__flac__stream__decoder.html#ga9d6df4a39892c05955122cf7f987f856">FLAC__stream_decoder_process_single()</a> - Tells the decoder to process at most one metadata block or audio frame and return, calling either the metadata callback or write callback, respectively, once. If the decoder loses sync it will return with only the error callback being called.</li>
<li><a class="el" href="group__flac__stream__decoder.html#ga027ffb5b75dc39b3d26f55c5e6b42682">FLAC__stream_decoder_process_until_end_of_metadata()</a> - Tells the decoder to process the stream from the current location and stop upon reaching the first audio frame. The client will get one metadata, write, or error callback per metadata block, audio frame, or sync error, respectively.</li>
<li><a class="el" href="group__flac__stream__decoder.html#ga89a0723812fa6ef7cdb173715f1bc81f">FLAC__stream_decoder_process_until_end_of_stream()</a> - Tells the decoder to process the stream from the current location until the read callback returns FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM or FLAC__STREAM_DECODER_READ_STATUS_ABORT. The client will get one metadata, write, or error callback per metadata block, audio frame, or sync error, respectively.</li>
</ul>
<p>When the decoder has finished decoding (normally or through an abort), the instance is finished by calling <a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish()</a>, which ensures the decoder is in the correct state and frees memory. Then the instance may be deleted with <a class="el" href="group__flac__stream__decoder.html#gad9cf299956da091111d13e83517d8c44">FLAC__stream_decoder_delete()</a> or initialized again to decode another stream.</p>
<p>Seeking is exposed through the <a class="el" href="group__flac__stream__decoder.html#ga6a2eb6072b9fafefc3f80f1959805ccb">FLAC__stream_decoder_seek_absolute()</a> method. At any point after the stream decoder has been initialized, the client can call this function to seek to an exact sample within the stream. Subsequently, the first time the write callback is called it will be passed a (possibly partial) block starting at that sample.</p>
<p>If the client cannot seek via the callback interface provided, but still has another way of seeking, it can flush the decoder using <a class="el" href="group__flac__stream__decoder.html#ga95570a455e582b2ab46ab9bb529f26ac">FLAC__stream_decoder_flush()</a> and start feeding data from the new position through the read callback.</p>
<p>The stream decoder also provides MD5 signature checking. If this is turned on before initialization, <a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish()</a> will report when the decoded MD5 signature does not match the one stored in the STREAMINFO block. MD5 checking is automatically turned off (until the next <a class="el" href="group__flac__stream__decoder.html#gaa4183c2d925d5a5edddde9d1ca145725">FLAC__stream_decoder_reset()</a>) if there is no signature in the STREAMINFO block or when a seek is attempted.</p>
<p>The FLAC__stream_decoder_set_metadata_*() functions deserve special attention. By default, the decoder only calls the metadata_callback for the STREAMINFO block. These functions allow you to tell the decoder explicitly which blocks to parse and return via the metadata_callback and/or which to skip. Use a <a class="el" href="group__flac__stream__decoder.html#ga1ce03d8f305a818ff9a573473af99dc4">FLAC__stream_decoder_set_metadata_respond_all()</a>, <a class="el" href="group__flac__stream__decoder.html#gad75f067720da89c4e9d96dedc45f73e6">FLAC__stream_decoder_set_metadata_ignore()</a> ... or <a class="el" href="group__flac__stream__decoder.html#gaa1307f07fae5d7a4a0c18beeae7ec5e6">FLAC__stream_decoder_set_metadata_ignore_all()</a>, <a class="el" href="group__flac__stream__decoder.html#gad4e685f3d055f70fbaed9ffa4f70f74b">FLAC__stream_decoder_set_metadata_respond()</a> ... sequence to exactly specify which blocks to return. Remember that metadata blocks can potentially be big (for example, cover art) so filtering out the ones you don't use can reduce the memory requirements of the decoder. Also note the special forms FLAC__stream_decoder_set_metadata_respond_application(id) and FLAC__stream_decoder_set_metadata_ignore_application(id) for filtering APPLICATION blocks based on the application ID.</p>
<p>STREAMINFO and SEEKTABLE blocks are always parsed and used internally, but they still can legally be filtered from the metadata_callback.</p>
<dl class="section note"><dt>Note</dt><dd>The "set" functions may only be called when the decoder is in the state FLAC__STREAM_DECODER_UNINITIALIZED, i.e. after <a class="el" href="group__flac__stream__decoder.html#ga529c3c1e46417570767fb8e4c76f5477">FLAC__stream_decoder_new()</a> or <a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish()</a>, but before FLAC__stream_decoder_init_*(). If this is the case they will return <code>true</code>, otherwise <code>false</code>.</dd>
<dd>
<a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish()</a> resets all settings to the constructor defaults, including the callbacks. </dd></dl>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga25d4321dc2f122d35ddc9061f44beae7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga25d4321dc2f122d35ddc9061f44beae7">◆ </a></span>FLAC__StreamDecoderReadCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__flac__stream__decoder.html#gad793ead451206c64a91dc0b851027b93">FLAC__StreamDecoderReadStatus</a>(* FLAC__StreamDecoderReadCallback) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the read callback.</p>
<p>A function pointer matching this signature must be passed to FLAC__stream_decoder_init*_stream(). The supplied function will be called when the decoder needs more input data. The address of the buffer to be filled is supplied, along with the number of bytes the buffer can hold. The callback may choose to supply less data and modify the byte count but must be careful not to overflow the buffer. The callback then returns a status code chosen from FLAC__StreamDecoderReadStatus.</p>
<p>Here is an example of a read callback for stdio streams: </p><div class="fragment"><div class="line"><a class="code" href="group__flac__stream__decoder.html#gad793ead451206c64a91dc0b851027b93">FLAC__StreamDecoderReadStatus</a> read_cb(<span class="keyword">const</span> <a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__byte buffer[], <span class="keywordtype">size_t</span> *bytes, <span class="keywordtype">void</span> *client_data)</div><div class="line">{</div><div class="line"> FILE *file = ((MyClientData*)client_data)->file;</div><div class="line"> <span class="keywordflow">if</span>(*bytes > 0) {</div><div class="line"> *bytes = fread(buffer, <span class="keyword">sizeof</span>(FLAC__byte), *bytes, file);</div><div class="line"> <span class="keywordflow">if</span>(ferror(file))</div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#ggad793ead451206c64a91dc0b851027b93a923123aebb349e35662e35a7621b7535">FLAC__STREAM_DECODER_READ_STATUS_ABORT</a>;</div><div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span>(*bytes == 0)</div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#ggad793ead451206c64a91dc0b851027b93a0a0687d25dc9f7163e6e5e294672170f">FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM</a>;</div><div class="line"> <span class="keywordflow">else</span></div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#ggad793ead451206c64a91dc0b851027b93a9a5be0fcf0279b98b2fd462bc4871d06">FLAC__STREAM_DECODER_READ_STATUS_CONTINUE</a>;</div><div class="line"> }</div><div class="line"> <span class="keywordflow">else</span></div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#ggad793ead451206c64a91dc0b851027b93a923123aebb349e35662e35a7621b7535">FLAC__STREAM_DECODER_READ_STATUS_ABORT</a>;</div><div class="line">}</div></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> functions which change the state should not be called on the <em>decoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>The decoder instance calling the callback. </td></tr>
<tr><td class="paramname">buffer</td><td>A pointer to a location for the callee to store data to be decoded. </td></tr>
<tr><td class="paramname">bytes</td><td>A pointer to the size of the buffer. On entry to the callback, it contains the maximum number of bytes that may be stored in <em>buffer</em>. The callee must set it to the actual number of bytes stored (0 in case of error or end-of-stream) before returning. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_decoder_init_*(). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderReadStatus</td><td>The callee's return status. Note that the callback should return <code>FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM</code> if and only if zero bytes were read and there is no more data to be read. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4c18b0216e0f7a83d7e4e7001230545d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c18b0216e0f7a83d7e4e7001230545d">◆ </a></span>FLAC__StreamDecoderSeekCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__flac__stream__decoder.html#gac8d269e3c7af1a5889d3bd38409ed67d">FLAC__StreamDecoderSeekStatus</a>(* FLAC__StreamDecoderSeekCallback) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 absolute_byte_offset, void *client_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the seek callback.</p>
<p>A function pointer matching this signature may be passed to FLAC__stream_decoder_init*_stream(). The supplied function will be called when the decoder needs to seek the input stream. The decoder will pass the absolute byte offset to seek to, 0 meaning the beginning of the stream.</p>
<p>Here is an example of a seek callback for stdio streams: </p><div class="fragment"><div class="line"><a class="code" href="group__flac__stream__decoder.html#gac8d269e3c7af1a5889d3bd38409ed67d">FLAC__StreamDecoderSeekStatus</a> seek_cb(<span class="keyword">const</span> <a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 absolute_byte_offset, <span class="keywordtype">void</span> *client_data)</div><div class="line">{</div><div class="line"> FILE *file = ((MyClientData*)client_data)->file;</div><div class="line"> <span class="keywordflow">if</span>(file == stdin)</div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#ggac8d269e3c7af1a5889d3bd38409ed67da4a01f1e48baf015e78535cc20683ec53">FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED</a>;</div><div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span>(fseeko(file, (off_t)absolute_byte_offset, SEEK_SET) < 0)</div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#ggac8d269e3c7af1a5889d3bd38409ed67da969ce92a42a2a95609452e9cf01fcc09">FLAC__STREAM_DECODER_SEEK_STATUS_ERROR</a>;</div><div class="line"> <span class="keywordflow">else</span></div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#ggac8d269e3c7af1a5889d3bd38409ed67daca58132d896ad7755827d3f2b72488cc">FLAC__STREAM_DECODER_SEEK_STATUS_OK</a>;</div><div class="line">}</div></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> functions which change the state should not be called on the <em>decoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>The decoder instance calling the callback. </td></tr>
<tr><td class="paramname">absolute_byte_offset</td><td>The offset from the beginning of the stream to seek to. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_decoder_init_*(). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderSeekStatus</td><td>The callee's return status. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gafdf1852486617a40c285c0d76d451a5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafdf1852486617a40c285c0d76d451a5a">◆ </a></span>FLAC__StreamDecoderTellCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__flac__stream__decoder.html#ga83708207969383bd7b5c1e9148528845">FLAC__StreamDecoderTellStatus</a>(* FLAC__StreamDecoderTellCallback) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the tell callback.</p>
<p>A function pointer matching this signature may be passed to FLAC__stream_decoder_init*_stream(). The supplied function will be called when the decoder wants to know the current position of the stream. The callback should return the byte offset from the beginning of the stream.</p>
<p>Here is an example of a tell callback for stdio streams: </p><div class="fragment"><div class="line"><a class="code" href="group__flac__stream__decoder.html#ga83708207969383bd7b5c1e9148528845">FLAC__StreamDecoderTellStatus</a> tell_cb(<span class="keyword">const</span> <a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 *absolute_byte_offset, <span class="keywordtype">void</span> *client_data)</div><div class="line">{</div><div class="line"> FILE *file = ((MyClientData*)client_data)->file;</div><div class="line"> off_t pos;</div><div class="line"> <span class="keywordflow">if</span>(file == stdin)</div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#gga83708207969383bd7b5c1e9148528845add75538234493c9f7a20a846a223ca91">FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED</a>;</div><div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span>((pos = ftello(file)) < 0)</div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#gga83708207969383bd7b5c1e9148528845aceefd3feb853d5e68a149f2bdd1a9db1">FLAC__STREAM_DECODER_TELL_STATUS_ERROR</a>;</div><div class="line"> <span class="keywordflow">else</span> {</div><div class="line"> *absolute_byte_offset = (FLAC__uint64)pos;</div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#gga83708207969383bd7b5c1e9148528845a516a202ebf4bb61d4a1fb5b029a104dd">FLAC__STREAM_DECODER_TELL_STATUS_OK</a>;</div><div class="line"> }</div><div class="line">}</div></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> functions which change the state should not be called on the <em>decoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>The decoder instance calling the callback. </td></tr>
<tr><td class="paramname">absolute_byte_offset</td><td>A pointer to storage for the current offset from the beginning of the stream. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_decoder_init_*(). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderTellStatus</td><td>The callee's return status. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga5363f3b46e3f7d6a73385f6560f7e7ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5363f3b46e3f7d6a73385f6560f7e7ef">◆ </a></span>FLAC__StreamDecoderLengthCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__flac__stream__decoder.html#gad5860157c2bb34501b8b9370472d727a">FLAC__StreamDecoderLengthStatus</a>(* FLAC__StreamDecoderLengthCallback) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 *stream_length, void *client_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the length callback.</p>
<p>A function pointer matching this signature may be passed to FLAC__stream_decoder_init*_stream(). The supplied function will be called when the decoder wants to know the total length of the stream in bytes.</p>
<p>Here is an example of a length callback for stdio streams: </p><div class="fragment"><div class="line"><a class="code" href="group__flac__stream__decoder.html#gad5860157c2bb34501b8b9370472d727a">FLAC__StreamDecoderLengthStatus</a> length_cb(<span class="keyword">const</span> <a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 *stream_length, <span class="keywordtype">void</span> *client_data)</div><div class="line">{</div><div class="line"> FILE *file = ((MyClientData*)client_data)->file;</div><div class="line"> <span class="keyword">struct </span>stat filestats;</div><div class="line"></div><div class="line"> <span class="keywordflow">if</span>(file == stdin)</div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#ggad5860157c2bb34501b8b9370472d727aae35949f46f887e6d826fe0fe4b2a32c1">FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED</a>;</div><div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span>(fstat(fileno(file), &filestats) != 0)</div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#ggad5860157c2bb34501b8b9370472d727aab000e31c0c20c0d19df4f2203b01ea23">FLAC__STREAM_DECODER_LENGTH_STATUS_ERROR</a>;</div><div class="line"> <span class="keywordflow">else</span> {</div><div class="line"> *stream_length = (FLAC__uint64)filestats.st_size;</div><div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__flac__stream__decoder.html#ggad5860157c2bb34501b8b9370472d727aaef01bfcdc3099686e106d8f88397653d">FLAC__STREAM_DECODER_LENGTH_STATUS_OK</a>;</div><div class="line"> }</div><div class="line">}</div></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> functions which change the state should not be called on the <em>decoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>The decoder instance calling the callback. </td></tr>
<tr><td class="paramname">stream_length</td><td>A pointer to storage for the length of the stream in bytes. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_decoder_init_*(). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderLengthStatus</td><td>The callee's return status. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4eac094fc609363532d90cf8374b4f7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4eac094fc609363532d90cf8374b4f7e">◆ </a></span>FLAC__StreamDecoderEofCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef FLAC__bool(* FLAC__StreamDecoderEofCallback) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, void *client_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the EOF callback.</p>
<p>A function pointer matching this signature may be passed to FLAC__stream_decoder_init*_stream(). The supplied function will be called when the decoder needs to know if the end of the stream has been reached.</p>
<p>Here is an example of a EOF callback for stdio streams: FLAC__bool eof_cb(const FLAC__StreamDecoder *decoder, void *client_data) </p><div class="fragment"><div class="line">{</div><div class="line"> FILE *file = ((MyClientData*)client_data)->file;</div><div class="line"> <span class="keywordflow">return</span> feof(file)? true : <span class="keyword">false</span>;</div><div class="line">}</div></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> functions which change the state should not be called on the <em>decoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>The decoder instance calling the callback. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_decoder_init_*(). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>true</code> if the currently at the end of the stream, else <code>false</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga61e48dc2c0d2f6c5519290ff046874a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga61e48dc2c0d2f6c5519290ff046874a4">◆ </a></span>FLAC__StreamDecoderWriteCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__flac__stream__decoder.html#ga73f67eb9e0ab57945afe038751bc62c8">FLAC__StreamDecoderWriteStatus</a>(* FLAC__StreamDecoderWriteCallback) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, const <a class="el" href="structFLAC____Frame.html">FLAC__Frame</a> *frame, const FLAC__int32 *const buffer[], void *client_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the write callback.</p>
<p>A function pointer matching this signature must be passed to one of the FLAC__stream_decoder_init_*() functions. The supplied function will be called when the decoder has decoded a single audio frame. The decoder will pass the frame metadata as well as an array of pointers (one for each channel) pointing to the decoded audio.</p>
<dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> functions which change the state should not be called on the <em>decoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>The decoder instance calling the callback. </td></tr>
<tr><td class="paramname">frame</td><td>The description of the decoded frame. See <a class="el" href="structFLAC____Frame.html">FLAC__Frame</a>. </td></tr>
<tr><td class="paramname">buffer</td><td>An array of pointers to decoded channels of data. Each pointer will point to an array of signed samples of length <em>frame->header.blocksize</em>. Channels will be ordered according to the FLAC specification; see the documentation for the <a href="../format.html#frame_header">frame header</a>. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_decoder_init_*(). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderWriteStatus</td><td>The callee's return status. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6aa87c01744c1c601b7f371f627b6e14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6aa87c01744c1c601b7f371f627b6e14">◆ </a></span>FLAC__StreamDecoderMetadataCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* FLAC__StreamDecoderMetadataCallback) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, const <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, void *client_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the metadata callback.</p>
<p>A function pointer matching this signature must be passed to one of the FLAC__stream_decoder_init_*() functions. The supplied function will be called when the decoder has decoded a metadata block. In a valid FLAC file there will always be one <code>STREAMINFO</code> block, followed by zero or more other metadata blocks. These will be supplied by the decoder in the same order as they appear in the stream and always before the first audio frame (i.e. write callback). The metadata block that is passed in must not be modified, and it doesn't live beyond the callback, so you should make a copy of it with <a class="el" href="group__flac__metadata__object.html#ga29af0ecc2a015ef22289f206bc308d80">FLAC__metadata_object_clone()</a> if you will need it elsewhere. Since metadata blocks can potentially be large, by default the decoder only calls the metadata callback for the <code>STREAMINFO</code> block; you can instruct the decoder to pass or filter other blocks with FLAC__stream_decoder_set_metadata_*() calls.</p>
<dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> functions which change the state should not be called on the <em>decoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>The decoder instance calling the callback. </td></tr>
<tr><td class="paramname">metadata</td><td>The decoded metadata block. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_decoder_init_*(). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gac896ee6a12668e9015fab4fbc6aae996"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac896ee6a12668e9015fab4fbc6aae996">◆ </a></span>FLAC__StreamDecoderErrorCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* FLAC__StreamDecoderErrorCallback) (const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, <a class="el" href="group__flac__stream__decoder.html#ga130e70bd9a73d3c2416247a3e5132ecf">FLAC__StreamDecoderErrorStatus</a> status, void *client_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the error callback.</p>
<p>A function pointer matching this signature must be passed to one of the FLAC__stream_decoder_init_*() functions. The supplied function will be called whenever an error occurs during decoding.</p>
<dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> functions which change the state should not be called on the <em>decoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>The decoder instance calling the callback. </td></tr>
<tr><td class="paramname">status</td><td>The error encountered by the decoder. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_decoder_init_*(). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga3adb6891c5871a87cd5bbae6c770ba2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3adb6891c5871a87cd5bbae6c770ba2d">◆ </a></span>FLAC__StreamDecoderState</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__decoder.html#ga3adb6891c5871a87cd5bbae6c770ba2d">FLAC__StreamDecoderState</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>State values for a <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a></p>
<p>The decoder's state can be obtained by calling <a class="el" href="group__flac__stream__decoder.html#gaf99dac2d9255f7db4df8a6d9974a9a9a">FLAC__stream_decoder_get_state()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga3adb6891c5871a87cd5bbae6c770ba2dacf4455f4f681a6737a553e10f614704a"></a>FLAC__STREAM_DECODER_SEARCH_FOR_METADATA </td><td class="fielddoc"><p>The decoder is ready to search for metadata. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3adb6891c5871a87cd5bbae6c770ba2da4c1853ed1babdcede9a908e12cf7ccf7"></a>FLAC__STREAM_DECODER_READ_METADATA </td><td class="fielddoc"><p>The decoder is ready to or is in the process of reading metadata. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3adb6891c5871a87cd5bbae6c770ba2daccff915757978117720ba1613d088ddf"></a>FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC </td><td class="fielddoc"><p>The decoder is ready to or is in the process of searching for the frame sync code. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3adb6891c5871a87cd5bbae6c770ba2da06dc6158a51a8eb9537b65f2fbb6dc49"></a>FLAC__STREAM_DECODER_READ_FRAME </td><td class="fielddoc"><p>The decoder is ready to or is in the process of reading a frame. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3adb6891c5871a87cd5bbae6c770ba2da28ce845052d9d1a780f4107e97f4c853"></a>FLAC__STREAM_DECODER_END_OF_STREAM </td><td class="fielddoc"><p>The decoder has reached the end of the stream. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3adb6891c5871a87cd5bbae6c770ba2da3bc0343f47153c5779baf7f37f6e95cf"></a>FLAC__STREAM_DECODER_OGG_ERROR </td><td class="fielddoc"><p>An error occurred in the underlying Ogg layer. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3adb6891c5871a87cd5bbae6c770ba2daf2c6efcabdfe889081c2260e6681db49"></a>FLAC__STREAM_DECODER_SEEK_ERROR </td><td class="fielddoc"><p>An error occurred while seeking. The decoder must be flushed with <a class="el" href="group__flac__stream__decoder.html#ga95570a455e582b2ab46ab9bb529f26ac">FLAC__stream_decoder_flush()</a> or reset with <a class="el" href="group__flac__stream__decoder.html#gaa4183c2d925d5a5edddde9d1ca145725">FLAC__stream_decoder_reset()</a> before decoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3adb6891c5871a87cd5bbae6c770ba2dadb52ab4785bd2eb84a95e8aa82311cd5"></a>FLAC__STREAM_DECODER_ABORTED </td><td class="fielddoc"><p>The decoder was aborted by the read or write callback. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3adb6891c5871a87cd5bbae6c770ba2da0d08c527252420813e6a6d6d3e19324a"></a>FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR </td><td class="fielddoc"><p>An error occurred allocating memory. The decoder is in an invalid state and can no longer be used. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3adb6891c5871a87cd5bbae6c770ba2da565eaf4d5e68b440ecec771cb22d3427"></a>FLAC__STREAM_DECODER_UNINITIALIZED </td><td class="fielddoc"><p>The decoder is in the uninitialized state; one of the FLAC__stream_decoder_init_*() functions must be called before samples can be processed. </p>
</td></tr>
</table>
</div>
</div>
<a id="gaaed54a24ac6310d29c5cafba79759c44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaed54a24ac6310d29c5cafba79759c44">◆ </a></span>FLAC__StreamDecoderInitStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Possible return values for the FLAC__stream_decoder_init_*() functions. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaaed54a24ac6310d29c5cafba79759c44ac94c7e9396f30642f34805e5d626e011"></a>FLAC__STREAM_DECODER_INIT_STATUS_OK </td><td class="fielddoc"><p>Initialization was successful. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaaed54a24ac6310d29c5cafba79759c44a8f2188c616c9bc09638eece3ae55f152"></a>FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER </td><td class="fielddoc"><p>The library was not compiled with support for the given container format. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaaed54a24ac6310d29c5cafba79759c44a798ad4b6c4e556fd4cb1afbc29562eca"></a>FLAC__STREAM_DECODER_INIT_STATUS_INVALID_CALLBACKS </td><td class="fielddoc"><p>A required callback was not supplied. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaaed54a24ac6310d29c5cafba79759c44a0110567f0715c6f87357388bc7fa98f9"></a>FLAC__STREAM_DECODER_INIT_STATUS_MEMORY_ALLOCATION_ERROR </td><td class="fielddoc"><p>An error occurred allocating memory. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaaed54a24ac6310d29c5cafba79759c44a8184c306e0cd2565a8c5adc1381cb469"></a>FLAC__STREAM_DECODER_INIT_STATUS_ERROR_OPENING_FILE </td><td class="fielddoc"><p>fopen() failed in <a class="el" href="group__flac__stream__decoder.html#ga4021ead5cff29fd589c915756f902f1a">FLAC__stream_decoder_init_file()</a> or <a class="el" href="group__flac__stream__decoder.html#ga548f15d7724f3bff7f2608abe8b12f6c">FLAC__stream_decoder_init_ogg_file()</a>. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaaed54a24ac6310d29c5cafba79759c44a98bc501c9b2fb5d92d8bb0b3321d504f"></a>FLAC__STREAM_DECODER_INIT_STATUS_ALREADY_INITIALIZED </td><td class="fielddoc"><p>FLAC__stream_decoder_init_*() was called when the decoder was already initialized, usually because <a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish()</a> was not called. </p>
</td></tr>
</table>
</div>
</div>
<a id="gad793ead451206c64a91dc0b851027b93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad793ead451206c64a91dc0b851027b93">◆ </a></span>FLAC__StreamDecoderReadStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__decoder.html#gad793ead451206c64a91dc0b851027b93">FLAC__StreamDecoderReadStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> read callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggad793ead451206c64a91dc0b851027b93a9a5be0fcf0279b98b2fd462bc4871d06"></a>FLAC__STREAM_DECODER_READ_STATUS_CONTINUE </td><td class="fielddoc"><p>The read was OK and decoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggad793ead451206c64a91dc0b851027b93a0a0687d25dc9f7163e6e5e294672170f"></a>FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM </td><td class="fielddoc"><p>The read was attempted while at the end of the stream. Note that the client must only return this value when the read callback was called when already at the end of the stream. Otherwise, if the read itself moves to the end of the stream, the client should still return the data and <code>FLAC__STREAM_DECODER_READ_STATUS_CONTINUE</code>, and then on the next read callback it should return <code>FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM</code> with a byte count of <code>0</code>. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggad793ead451206c64a91dc0b851027b93a923123aebb349e35662e35a7621b7535"></a>FLAC__STREAM_DECODER_READ_STATUS_ABORT </td><td class="fielddoc"><p>An unrecoverable error occurred. The decoder will return from the process call. </p>
</td></tr>
</table>
</div>
</div>
<a id="gac8d269e3c7af1a5889d3bd38409ed67d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac8d269e3c7af1a5889d3bd38409ed67d">◆ </a></span>FLAC__StreamDecoderSeekStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__decoder.html#gac8d269e3c7af1a5889d3bd38409ed67d">FLAC__StreamDecoderSeekStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> seek callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggac8d269e3c7af1a5889d3bd38409ed67daca58132d896ad7755827d3f2b72488cc"></a>FLAC__STREAM_DECODER_SEEK_STATUS_OK </td><td class="fielddoc"><p>The seek was OK and decoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac8d269e3c7af1a5889d3bd38409ed67da969ce92a42a2a95609452e9cf01fcc09"></a>FLAC__STREAM_DECODER_SEEK_STATUS_ERROR </td><td class="fielddoc"><p>An unrecoverable error occurred. The decoder will return from the process call. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac8d269e3c7af1a5889d3bd38409ed67da4a01f1e48baf015e78535cc20683ec53"></a>FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED </td><td class="fielddoc"><p>Client does not support seeking. </p>
</td></tr>
</table>
</div>
</div>
<a id="ga83708207969383bd7b5c1e9148528845"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga83708207969383bd7b5c1e9148528845">◆ </a></span>FLAC__StreamDecoderTellStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__decoder.html#ga83708207969383bd7b5c1e9148528845">FLAC__StreamDecoderTellStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> tell callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga83708207969383bd7b5c1e9148528845a516a202ebf4bb61d4a1fb5b029a104dd"></a>FLAC__STREAM_DECODER_TELL_STATUS_OK </td><td class="fielddoc"><p>The tell was OK and decoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga83708207969383bd7b5c1e9148528845aceefd3feb853d5e68a149f2bdd1a9db1"></a>FLAC__STREAM_DECODER_TELL_STATUS_ERROR </td><td class="fielddoc"><p>An unrecoverable error occurred. The decoder will return from the process call. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga83708207969383bd7b5c1e9148528845add75538234493c9f7a20a846a223ca91"></a>FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED </td><td class="fielddoc"><p>Client does not support telling the position. </p>
</td></tr>
</table>
</div>
</div>
<a id="gad5860157c2bb34501b8b9370472d727a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad5860157c2bb34501b8b9370472d727a">◆ </a></span>FLAC__StreamDecoderLengthStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__decoder.html#gad5860157c2bb34501b8b9370472d727a">FLAC__StreamDecoderLengthStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> length callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggad5860157c2bb34501b8b9370472d727aaef01bfcdc3099686e106d8f88397653d"></a>FLAC__STREAM_DECODER_LENGTH_STATUS_OK </td><td class="fielddoc"><p>The length call was OK and decoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggad5860157c2bb34501b8b9370472d727aab000e31c0c20c0d19df4f2203b01ea23"></a>FLAC__STREAM_DECODER_LENGTH_STATUS_ERROR </td><td class="fielddoc"><p>An unrecoverable error occurred. The decoder will return from the process call. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggad5860157c2bb34501b8b9370472d727aae35949f46f887e6d826fe0fe4b2a32c1"></a>FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED </td><td class="fielddoc"><p>Client does not support reporting the length. </p>
</td></tr>
</table>
</div>
</div>
<a id="ga73f67eb9e0ab57945afe038751bc62c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga73f67eb9e0ab57945afe038751bc62c8">◆ </a></span>FLAC__StreamDecoderWriteStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__decoder.html#ga73f67eb9e0ab57945afe038751bc62c8">FLAC__StreamDecoderWriteStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> write callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga73f67eb9e0ab57945afe038751bc62c8acea48326e0ab8370d2814f4126fcb84e"></a>FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE </td><td class="fielddoc"><p>The write was OK and decoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga73f67eb9e0ab57945afe038751bc62c8a23bd6bfec34af704e0d5ea273f14d95d"></a>FLAC__STREAM_DECODER_WRITE_STATUS_ABORT </td><td class="fielddoc"><p>An unrecoverable error occurred. The decoder will return from the process call. </p>
</td></tr>
</table>
</div>
</div>
<a id="ga130e70bd9a73d3c2416247a3e5132ecf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga130e70bd9a73d3c2416247a3e5132ecf">◆ </a></span>FLAC__StreamDecoderErrorStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__decoder.html#ga130e70bd9a73d3c2416247a3e5132ecf">FLAC__StreamDecoderErrorStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Possible values passed back to the <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> error callback. <code>FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC</code> is the generic catch- all. The rest could be caused by bad sync (false synchronization on data that is not the start of a frame) or corrupted data. The error itself is the decoder's best guess at what happened assuming a correct sync. For example <code>FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER</code> could be caused by a correct sync on the start of a frame, but some data in the frame header was corrupted. Or it could be the result of syncing on a point the stream that looked like the starting of a frame but was not. <code>FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM</code> could be because the decoder encountered a valid frame made by a future version of the encoder which it cannot parse, or because of a false sync making it appear as though an encountered frame was generated by a future encoder. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga130e70bd9a73d3c2416247a3e5132ecfa3ceec2a553dc142ad487ae88eb6f7222"></a>FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC </td><td class="fielddoc"><p>An error in the stream caused the decoder to lose synchronization. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga130e70bd9a73d3c2416247a3e5132ecfae393a9b91a6b2f23398675b5b57e1e86"></a>FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER </td><td class="fielddoc"><p>The decoder encountered a corrupted frame header. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga130e70bd9a73d3c2416247a3e5132ecfa208fe77a04e6ff684e50f0eae1214e26"></a>FLAC__STREAM_DECODER_ERROR_STATUS_FRAME_CRC_MISMATCH </td><td class="fielddoc"><p>The frame's data did not match the CRC in the footer. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga130e70bd9a73d3c2416247a3e5132ecfa8b6864ad65edd8fea039838b6d3e5575"></a>FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM </td><td class="fielddoc"><p>The decoder encountered reserved fields in use in the stream. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga529c3c1e46417570767fb8e4c76f5477"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga529c3c1e46417570767fb8e4c76f5477">◆ </a></span>FLAC__stream_decoder_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>* FLAC__stream_decoder_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new stream decoder instance. The instance is created with default settings; see the individual FLAC__stream_decoder_set_*() functions for each setting's default.</p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoder*</td><td><code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gad9cf299956da091111d13e83517d8c44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad9cf299956da091111d13e83517d8c44">◆ </a></span>FLAC__stream_decoder_delete()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FLAC__stream_decoder_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a decoder instance. Deletes the object pointed to by <em>decoder</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A pointer to an existing decoder. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="ga7fd232e7a2b5070bd26450487edbc2a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7fd232e7a2b5070bd26450487edbc2a1">◆ </a></span>FLAC__stream_decoder_set_ogg_serial_number()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_set_ogg_serial_number </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>serial_number</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the serial number for the FLAC stream within the Ogg container. The default behavior is to use the serial number of the first Ogg page. Setting a serial number here will explicitly specify which stream is to be decoded.</p>
<dl class="section note"><dt>Note</dt><dd>This does not need to be set for native FLAC decoding.</dd></dl>
<dl class="section user"><dt>Default Value:</dt><dd><code>use</code> serial number of first page </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to set. </td></tr>
<tr><td class="paramname">serial_number</td><td>See above. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga8f402243eed54f400ddd2f296ff54497"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8f402243eed54f400ddd2f296ff54497">◆ </a></span>FLAC__stream_decoder_set_md5_checking()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_set_md5_checking </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FLAC__bool </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the "MD5 signature checking" flag. If <code>true</code>, the decoder will compute the MD5 signature of the unencoded audio data while decoding and compare it to the signature from the STREAMINFO block, if it exists, during <a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish()</a>.</p>
<p>MD5 signature checking will be turned off (until the next <a class="el" href="group__flac__stream__decoder.html#gaa4183c2d925d5a5edddde9d1ca145725">FLAC__stream_decoder_reset()</a>) if there is no signature in the STREAMINFO block or when a seek is attempted.</p>
<p>Clients that do not use the MD5 check should leave this off to speed up decoding.</p>
<dl class="section user"><dt>Default Value:</dt><dd><code>false</code> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to set. </td></tr>
<tr><td class="paramname">value</td><td>Flag value (see above). </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gad4e685f3d055f70fbaed9ffa4f70f74b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad4e685f3d055f70fbaed9ffa4f70f74b">◆ </a></span>FLAC__stream_decoder_set_metadata_respond()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_set_metadata_respond </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__format.html#gac71714ba8ddbbd66d26bb78a427fac01">FLAC__MetadataType</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Direct the decoder to pass on all metadata blocks of type <em>type</em>.</p>
<dl class="section user"><dt>Default Value:</dt><dd>By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to set. </td></tr>
<tr><td class="paramname">type</td><td>See above. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> <em>type</em> is valid </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaee1196ff5fa97df9810f708dc2bc8326"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaee1196ff5fa97df9810f708dc2bc8326">◆ </a></span>FLAC__stream_decoder_set_metadata_respond_application()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_set_metadata_respond_application </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const FLAC__byte </td>
<td class="paramname"><em>id</em>[4] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Direct the decoder to pass on all APPLICATION metadata blocks of the given <em>id</em>.</p>
<dl class="section user"><dt>Default Value:</dt><dd>By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to set. </td></tr>
<tr><td class="paramname">id</td><td>See above. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> <div class="fragment"><div class="line"><span class="keywordtype">id</span> != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga1ce03d8f305a818ff9a573473af99dc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1ce03d8f305a818ff9a573473af99dc4">◆ </a></span>FLAC__stream_decoder_set_metadata_respond_all()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_set_metadata_respond_all </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Direct the decoder to pass on all metadata blocks of any type.</p>
<dl class="section user"><dt>Default Value:</dt><dd>By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to set. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gad75f067720da89c4e9d96dedc45f73e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad75f067720da89c4e9d96dedc45f73e6">◆ </a></span>FLAC__stream_decoder_set_metadata_ignore()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_set_metadata_ignore </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__format.html#gac71714ba8ddbbd66d26bb78a427fac01">FLAC__MetadataType</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Direct the decoder to filter out all metadata blocks of type <em>type</em>.</p>
<dl class="section user"><dt>Default Value:</dt><dd>By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to set. </td></tr>
<tr><td class="paramname">type</td><td>See above. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> <em>type</em> is valid </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaab41e8bc505b24df4912de53de06b085"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaab41e8bc505b24df4912de53de06b085">◆ </a></span>FLAC__stream_decoder_set_metadata_ignore_application()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_set_metadata_ignore_application </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const FLAC__byte </td>
<td class="paramname"><em>id</em>[4] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Direct the decoder to filter out all APPLICATION metadata blocks of the given <em>id</em>.</p>
<dl class="section user"><dt>Default Value:</dt><dd>By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to set. </td></tr>
<tr><td class="paramname">id</td><td>See above. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> <div class="fragment"><div class="line"><span class="keywordtype">id</span> != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa1307f07fae5d7a4a0c18beeae7ec5e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa1307f07fae5d7a4a0c18beeae7ec5e6">◆ </a></span>FLAC__stream_decoder_set_metadata_ignore_all()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_set_metadata_ignore_all </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Direct the decoder to filter out all metadata blocks of any type.</p>
<dl class="section user"><dt>Default Value:</dt><dd>By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to set. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf99dac2d9255f7db4df8a6d9974a9a9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf99dac2d9255f7db4df8a6d9974a9a9a">◆ </a></span>FLAC__stream_decoder_get_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flac__stream__decoder.html#ga3adb6891c5871a87cd5bbae6c770ba2d">FLAC__StreamDecoderState</a> FLAC__stream_decoder_get_state </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current decoder state.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderState</td><td>The current decoder state. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gad28257412951ca266751a19e2cf54be2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad28257412951ca266751a19e2cf54be2">◆ </a></span>FLAC__stream_decoder_get_resolved_state_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* FLAC__stream_decoder_get_resolved_state_string </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current decoder state as a C string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">const</td><td>char * The decoder state as a C string. Do not modify the contents. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gae27a6b30b55beda03559c12a5df21537"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae27a6b30b55beda03559c12a5df21537">◆ </a></span>FLAC__stream_decoder_get_md5_checking()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_get_md5_checking </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the "MD5 signature checking" flag. This is the value of the setting, not whether or not the decoder is currently checking the MD5 (remember, it can be turned off automatically by a seek). When the decoder is reset the flag will be restored to the value returned by this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td>See above. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga930d9b591fcfaea74359c722cdfb980c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga930d9b591fcfaea74359c722cdfb980c">◆ </a></span>FLAC__stream_decoder_get_total_samples()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__uint64 FLAC__stream_decoder_get_total_samples </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the total number of samples in the stream being decoded. Will only be valid after decoding has started and will contain the value from the <code>STREAMINFO</code> block. A value of <code>0</code> means "unknown".</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">uint32_t</td><td>See above. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga802d5f4c48a711b690d6d66d2e3f20a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga802d5f4c48a711b690d6d66d2e3f20a5">◆ </a></span>FLAC__stream_decoder_get_channels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t FLAC__stream_decoder_get_channels </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current number of channels in the stream being decoded. Will only be valid after decoding has started and will contain the value from the most recently decoded frame header.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">uint32_t</td><td>See above. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gae62fdf93c1fedd5fea9258ecdc78bb53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae62fdf93c1fedd5fea9258ecdc78bb53">◆ </a></span>FLAC__stream_decoder_get_channel_assignment()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flac__format.html#ga79855f8525672e37f299bbe02952ef9c">FLAC__ChannelAssignment</a> FLAC__stream_decoder_get_channel_assignment </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current channel assignment in the stream being decoded. Will only be valid after decoding has started and will contain the value from the most recently decoded frame header.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__ChannelAssignment</td><td>See above. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga689893cde90c171ca343192e92679842"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga689893cde90c171ca343192e92679842">◆ </a></span>FLAC__stream_decoder_get_bits_per_sample()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t FLAC__stream_decoder_get_bits_per_sample </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current sample resolution in the stream being decoded. Will only be valid after decoding has started and will contain the value from the most recently decoded frame header.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">uint32_t</td><td>See above. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga95f7cdfefba169d964e3c08672a0f0ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga95f7cdfefba169d964e3c08672a0f0ad">◆ </a></span>FLAC__stream_decoder_get_sample_rate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t FLAC__stream_decoder_get_sample_rate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current sample rate in Hz of the stream being decoded. Will only be valid after decoding has started and will contain the value from the most recently decoded frame header.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">uint32_t</td><td>See above. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gafe07ad9949cc54944fd369fe9335c4bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafe07ad9949cc54944fd369fe9335c4bc">◆ </a></span>FLAC__stream_decoder_get_blocksize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t FLAC__stream_decoder_get_blocksize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current blocksize of the stream being decoded. Will only be valid after decoding has started and will contain the value from the most recently decoded frame header.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">uint32_t</td><td>See above. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaffd9b0d0832ed01e6d75930b5391def5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaffd9b0d0832ed01e6d75930b5391def5">◆ </a></span>FLAC__stream_decoder_get_decode_position()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_get_decode_position </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FLAC__uint64 * </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the decoder's current read position within the stream. The position is the byte offset from the start of the stream. Bytes before this position have been fully decoded. Note that there may still be undecoded bytes in the decoder's read FIFO. The returned position is correct even after a seek.</p>
<dl class="section warning"><dt>Warning</dt><dd>This function currently only works for native FLAC, not Ogg FLAC streams.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance to query. </td></tr>
<tr><td class="paramname">position</td><td>Address at which to return the desired position. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> <div class="fragment"><div class="line">position != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>true</code> if successful, <code>false</code> if the stream is not native FLAC, or there was an error from the 'tell' callback or it returned <code>FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga150d381abc5249168e439bc076544b29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga150d381abc5249168e439bc076544b29">◆ </a></span>FLAC__stream_decoder_init_stream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> FLAC__stream_decoder_init_stream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga25d4321dc2f122d35ddc9061f44beae7">FLAC__StreamDecoderReadCallback</a> </td>
<td class="paramname"><em>read_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga4c18b0216e0f7a83d7e4e7001230545d">FLAC__StreamDecoderSeekCallback</a> </td>
<td class="paramname"><em>seek_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#gafdf1852486617a40c285c0d76d451a5a">FLAC__StreamDecoderTellCallback</a> </td>
<td class="paramname"><em>tell_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga5363f3b46e3f7d6a73385f6560f7e7ef">FLAC__StreamDecoderLengthCallback</a> </td>
<td class="paramname"><em>length_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga4eac094fc609363532d90cf8374b4f7e">FLAC__StreamDecoderEofCallback</a> </td>
<td class="paramname"><em>eof_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> </td>
<td class="paramname"><em>write_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> </td>
<td class="paramname"><em>metadata_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> </td>
<td class="paramname"><em>error_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>client_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the decoder instance to decode native FLAC streams.</p>
<p>This flavor of initialization sets up the decoder to decode from a native FLAC stream. I/O is performed via callbacks to the client. For decoding from a plain file via filename or open FILE*, <a class="el" href="group__flac__stream__decoder.html#ga4021ead5cff29fd589c915756f902f1a">FLAC__stream_decoder_init_file()</a> and <a class="el" href="group__flac__stream__decoder.html#ga80aa83631460a53263c84e654586dff0">FLAC__stream_decoder_init_FILE()</a> provide a simpler interface.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__decoder.html#ga529c3c1e46417570767fb8e4c76f5477">FLAC__stream_decoder_new()</a> and FLAC__stream_decoder_set_*() but before any of the FLAC__stream_decoder_process_*() functions. Will set and return the decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA if initialization succeeded.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>An uninitialized decoder instance. </td></tr>
<tr><td class="paramname">read_callback</td><td>See FLAC__StreamDecoderReadCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">seek_callback</td><td>See FLAC__StreamDecoderSeekCallback. This pointer may be <code>NULL</code> if seeking is not supported. If <em>seek_callback</em> is not <code>NULL</code> then a <em>tell_callback</em>, <em>length_callback</em>, and <em>eof_callback</em> must also be supplied. Alternatively, a dummy seek callback that just returns <code>FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED</code> may also be supplied, all though this is slightly less efficient for the decoder. </td></tr>
<tr><td class="paramname">tell_callback</td><td>See FLAC__StreamDecoderTellCallback. This pointer may be <code>NULL</code> if not supported by the client. If <em>seek_callback</em> is not <code>NULL</code> then a <em>tell_callback</em> must also be supplied. Alternatively, a dummy tell callback that just returns <code>FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED</code> may also be supplied, all though this is slightly less efficient for the decoder. </td></tr>
<tr><td class="paramname">length_callback</td><td>See FLAC__StreamDecoderLengthCallback. This pointer may be <code>NULL</code> if not supported by the client. If <em>seek_callback</em> is not <code>NULL</code> then a <em>length_callback</em> must also be supplied. Alternatively, a dummy length callback that just returns <code>FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED</code> may also be supplied, all though this is slightly less efficient for the decoder. </td></tr>
<tr><td class="paramname">eof_callback</td><td>See FLAC__StreamDecoderEofCallback. This pointer may be <code>NULL</code> if not supported by the client. If <em>seek_callback</em> is not <code>NULL</code> then a <em>eof_callback</em> must also be supplied. Alternatively, a dummy length callback that just returns <code>false</code> may also be supplied, all though this is slightly less efficient for the decoder. </td></tr>
<tr><td class="paramname">write_callback</td><td>See FLAC__StreamDecoderWriteCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">metadata_callback</td><td>See FLAC__StreamDecoderMetadataCallback. This pointer may be <code>NULL</code> if the callback is not desired. </td></tr>
<tr><td class="paramname">error_callback</td><td>See FLAC__StreamDecoderErrorCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderInitStatus</td><td><code>FLAC__STREAM_DECODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamDecoderInitStatus for the meanings of other return values. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga1b043adeb805c779c1e97cb68959d1ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1b043adeb805c779c1e97cb68959d1ab">◆ </a></span>FLAC__stream_decoder_init_ogg_stream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> FLAC__stream_decoder_init_ogg_stream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga25d4321dc2f122d35ddc9061f44beae7">FLAC__StreamDecoderReadCallback</a> </td>
<td class="paramname"><em>read_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga4c18b0216e0f7a83d7e4e7001230545d">FLAC__StreamDecoderSeekCallback</a> </td>
<td class="paramname"><em>seek_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#gafdf1852486617a40c285c0d76d451a5a">FLAC__StreamDecoderTellCallback</a> </td>
<td class="paramname"><em>tell_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga5363f3b46e3f7d6a73385f6560f7e7ef">FLAC__StreamDecoderLengthCallback</a> </td>
<td class="paramname"><em>length_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga4eac094fc609363532d90cf8374b4f7e">FLAC__StreamDecoderEofCallback</a> </td>
<td class="paramname"><em>eof_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> </td>
<td class="paramname"><em>write_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> </td>
<td class="paramname"><em>metadata_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> </td>
<td class="paramname"><em>error_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>client_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the decoder instance to decode Ogg FLAC streams.</p>
<p>This flavor of initialization sets up the decoder to decode from a FLAC stream in an Ogg container. I/O is performed via callbacks to the client. For decoding from a plain file via filename or open FILE*, <a class="el" href="group__flac__stream__decoder.html#ga548f15d7724f3bff7f2608abe8b12f6c">FLAC__stream_decoder_init_ogg_file()</a> and <a class="el" href="group__flac__stream__decoder.html#ga4cc7fbaf905c24d6db48b53b7942fe72">FLAC__stream_decoder_init_ogg_FILE()</a> provide a simpler interface.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__decoder.html#ga529c3c1e46417570767fb8e4c76f5477">FLAC__stream_decoder_new()</a> and FLAC__stream_decoder_set_*() but before any of the FLAC__stream_decoder_process_*() functions. Will set and return the decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA if initialization succeeded.</p>
<dl class="section note"><dt>Note</dt><dd>Support for Ogg FLAC in the library is optional. If this library has been built without support for Ogg FLAC, this function will return <code>FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER</code>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>An uninitialized decoder instance. </td></tr>
<tr><td class="paramname">read_callback</td><td>See FLAC__StreamDecoderReadCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">seek_callback</td><td>See FLAC__StreamDecoderSeekCallback. This pointer may be <code>NULL</code> if seeking is not supported. If <em>seek_callback</em> is not <code>NULL</code> then a <em>tell_callback</em>, <em>length_callback</em>, and <em>eof_callback</em> must also be supplied. Alternatively, a dummy seek callback that just returns <code>FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED</code> may also be supplied, all though this is slightly less efficient for the decoder. </td></tr>
<tr><td class="paramname">tell_callback</td><td>See FLAC__StreamDecoderTellCallback. This pointer may be <code>NULL</code> if not supported by the client. If <em>seek_callback</em> is not <code>NULL</code> then a <em>tell_callback</em> must also be supplied. Alternatively, a dummy tell callback that just returns <code>FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED</code> may also be supplied, all though this is slightly less efficient for the decoder. </td></tr>
<tr><td class="paramname">length_callback</td><td>See FLAC__StreamDecoderLengthCallback. This pointer may be <code>NULL</code> if not supported by the client. If <em>seek_callback</em> is not <code>NULL</code> then a <em>length_callback</em> must also be supplied. Alternatively, a dummy length callback that just returns <code>FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED</code> may also be supplied, all though this is slightly less efficient for the decoder. </td></tr>
<tr><td class="paramname">eof_callback</td><td>See FLAC__StreamDecoderEofCallback. This pointer may be <code>NULL</code> if not supported by the client. If <em>seek_callback</em> is not <code>NULL</code> then a <em>eof_callback</em> must also be supplied. Alternatively, a dummy length callback that just returns <code>false</code> may also be supplied, all though this is slightly less efficient for the decoder. </td></tr>
<tr><td class="paramname">write_callback</td><td>See FLAC__StreamDecoderWriteCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">metadata_callback</td><td>See FLAC__StreamDecoderMetadataCallback. This pointer may be <code>NULL</code> if the callback is not desired. </td></tr>
<tr><td class="paramname">error_callback</td><td>See FLAC__StreamDecoderErrorCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderInitStatus</td><td><code>FLAC__STREAM_DECODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamDecoderInitStatus for the meanings of other return values. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga80aa83631460a53263c84e654586dff0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga80aa83631460a53263c84e654586dff0">◆ </a></span>FLAC__stream_decoder_init_FILE()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> FLAC__stream_decoder_init_FILE </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> </td>
<td class="paramname"><em>write_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> </td>
<td class="paramname"><em>metadata_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> </td>
<td class="paramname"><em>error_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>client_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the decoder instance to decode native FLAC files.</p>
<p>This flavor of initialization sets up the decoder to decode from a plain native FLAC file. For non-stdio streams, you must use <a class="el" href="group__flac__stream__decoder.html#ga150d381abc5249168e439bc076544b29">FLAC__stream_decoder_init_stream()</a> and provide callbacks for the I/O.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__decoder.html#ga529c3c1e46417570767fb8e4c76f5477">FLAC__stream_decoder_new()</a> and FLAC__stream_decoder_set_*() but before any of the FLAC__stream_decoder_process_*() functions. Will set and return the decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA if initialization succeeded.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>An uninitialized decoder instance. </td></tr>
<tr><td class="paramname">file</td><td>An open FLAC file. The file should have been opened with mode <code>"rb"</code> and rewound. The file becomes owned by the decoder and should not be manipulated by the client while decoding. Unless <em>file</em> is <code>stdin</code>, it will be closed when <a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish()</a> is called. Note however that seeking will not work when decoding from <code>stdin</code> since it is not seekable. </td></tr>
<tr><td class="paramname">write_callback</td><td>See FLAC__StreamDecoderWriteCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">metadata_callback</td><td>See FLAC__StreamDecoderMetadataCallback. This pointer may be <code>NULL</code> if the callback is not desired. </td></tr>
<tr><td class="paramname">error_callback</td><td>See FLAC__StreamDecoderErrorCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> <div class="fragment"><div class="line">file != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderInitStatus</td><td><code>FLAC__STREAM_DECODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamDecoderInitStatus for the meanings of other return values. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4cc7fbaf905c24d6db48b53b7942fe72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4cc7fbaf905c24d6db48b53b7942fe72">◆ </a></span>FLAC__stream_decoder_init_ogg_FILE()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> FLAC__stream_decoder_init_ogg_FILE </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> </td>
<td class="paramname"><em>write_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> </td>
<td class="paramname"><em>metadata_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> </td>
<td class="paramname"><em>error_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>client_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the decoder instance to decode Ogg FLAC files.</p>
<p>This flavor of initialization sets up the decoder to decode from a plain Ogg FLAC file. For non-stdio streams, you must use <a class="el" href="group__flac__stream__decoder.html#ga1b043adeb805c779c1e97cb68959d1ab">FLAC__stream_decoder_init_ogg_stream()</a> and provide callbacks for the I/O.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__decoder.html#ga529c3c1e46417570767fb8e4c76f5477">FLAC__stream_decoder_new()</a> and FLAC__stream_decoder_set_*() but before any of the FLAC__stream_decoder_process_*() functions. Will set and return the decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA if initialization succeeded.</p>
<dl class="section note"><dt>Note</dt><dd>Support for Ogg FLAC in the library is optional. If this library has been built without support for Ogg FLAC, this function will return <code>FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER</code>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>An uninitialized decoder instance. </td></tr>
<tr><td class="paramname">file</td><td>An open FLAC file. The file should have been opened with mode <code>"rb"</code> and rewound. The file becomes owned by the decoder and should not be manipulated by the client while decoding. Unless <em>file</em> is <code>stdin</code>, it will be closed when <a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish()</a> is called. Note however that seeking will not work when decoding from <code>stdin</code> since it is not seekable. </td></tr>
<tr><td class="paramname">write_callback</td><td>See FLAC__StreamDecoderWriteCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">metadata_callback</td><td>See FLAC__StreamDecoderMetadataCallback. This pointer may be <code>NULL</code> if the callback is not desired. </td></tr>
<tr><td class="paramname">error_callback</td><td>See FLAC__StreamDecoderErrorCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> <div class="fragment"><div class="line">file != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderInitStatus</td><td><code>FLAC__STREAM_DECODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamDecoderInitStatus for the meanings of other return values. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4021ead5cff29fd589c915756f902f1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4021ead5cff29fd589c915756f902f1a">◆ </a></span>FLAC__stream_decoder_init_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> FLAC__stream_decoder_init_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> </td>
<td class="paramname"><em>write_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> </td>
<td class="paramname"><em>metadata_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> </td>
<td class="paramname"><em>error_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>client_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the decoder instance to decode native FLAC files.</p>
<p>This flavor of initialization sets up the decoder to decode from a plain native FLAC file. If POSIX fopen() semantics are not sufficient, (for example, with Unicode filenames on Windows), you must use <a class="el" href="group__flac__stream__decoder.html#ga80aa83631460a53263c84e654586dff0">FLAC__stream_decoder_init_FILE()</a>, or <a class="el" href="group__flac__stream__decoder.html#ga150d381abc5249168e439bc076544b29">FLAC__stream_decoder_init_stream()</a> and provide callbacks for the I/O.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__decoder.html#ga529c3c1e46417570767fb8e4c76f5477">FLAC__stream_decoder_new()</a> and FLAC__stream_decoder_set_*() but before any of the FLAC__stream_decoder_process_*() functions. Will set and return the decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA if initialization succeeded.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>An uninitialized decoder instance. </td></tr>
<tr><td class="paramname">filename</td><td>The name of the file to decode from. The file will be opened with fopen(). Use <code>NULL</code> to decode from <code>stdin</code>. Note that <code>stdin</code> is not seekable. </td></tr>
<tr><td class="paramname">write_callback</td><td>See FLAC__StreamDecoderWriteCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">metadata_callback</td><td>See FLAC__StreamDecoderMetadataCallback. This pointer may be <code>NULL</code> if the callback is not desired. </td></tr>
<tr><td class="paramname">error_callback</td><td>See FLAC__StreamDecoderErrorCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderInitStatus</td><td><code>FLAC__STREAM_DECODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamDecoderInitStatus for the meanings of other return values. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga548f15d7724f3bff7f2608abe8b12f6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga548f15d7724f3bff7f2608abe8b12f6c">◆ </a></span>FLAC__stream_decoder_init_ogg_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__flac__stream__decoder.html#gaaed54a24ac6310d29c5cafba79759c44">FLAC__StreamDecoderInitStatus</a> FLAC__stream_decoder_init_ogg_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga61e48dc2c0d2f6c5519290ff046874a4">FLAC__StreamDecoderWriteCallback</a> </td>
<td class="paramname"><em>write_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#ga6aa87c01744c1c601b7f371f627b6e14">FLAC__StreamDecoderMetadataCallback</a> </td>
<td class="paramname"><em>metadata_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__flac__stream__decoder.html#gac896ee6a12668e9015fab4fbc6aae996">FLAC__StreamDecoderErrorCallback</a> </td>
<td class="paramname"><em>error_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>client_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the decoder instance to decode Ogg FLAC files.</p>
<p>This flavor of initialization sets up the decoder to decode from a plain Ogg FLAC file. If POSIX fopen() semantics are not sufficient, (for example, with Unicode filenames on Windows), you must use <a class="el" href="group__flac__stream__decoder.html#ga4cc7fbaf905c24d6db48b53b7942fe72">FLAC__stream_decoder_init_ogg_FILE()</a>, or <a class="el" href="group__flac__stream__decoder.html#ga1b043adeb805c779c1e97cb68959d1ab">FLAC__stream_decoder_init_ogg_stream()</a> and provide callbacks for the I/O.</p>
<p>This function should be called after <a class="el" href="group__flac__stream__decoder.html#ga529c3c1e46417570767fb8e4c76f5477">FLAC__stream_decoder_new()</a> and FLAC__stream_decoder_set_*() but before any of the FLAC__stream_decoder_process_*() functions. Will set and return the decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA if initialization succeeded.</p>
<dl class="section note"><dt>Note</dt><dd>Support for Ogg FLAC in the library is optional. If this library has been built without support for Ogg FLAC, this function will return <code>FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER</code>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>An uninitialized decoder instance. </td></tr>
<tr><td class="paramname">filename</td><td>The name of the file to decode from. The file will be opened with fopen(). Use <code>NULL</code> to decode from <code>stdin</code>. Note that <code>stdin</code> is not seekable. </td></tr>
<tr><td class="paramname">write_callback</td><td>See FLAC__StreamDecoderWriteCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">metadata_callback</td><td>See FLAC__StreamDecoderMetadataCallback. This pointer may be <code>NULL</code> if the callback is not desired. </td></tr>
<tr><td class="paramname">error_callback</td><td>See FLAC__StreamDecoderErrorCallback. This pointer must not be <code>NULL</code>. </td></tr>
<tr><td class="paramname">client_data</td><td>This value will be supplied to callbacks in their <em>client_data</em> argument. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamDecoderInitStatus</td><td><code>FLAC__STREAM_DECODER_INIT_STATUS_OK</code> if initialization was successful; see FLAC__StreamDecoderInitStatus for the meanings of other return values. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga96c47c96920f363cd0972b54067818a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga96c47c96920f363cd0972b54067818a9">◆ </a></span>FLAC__stream_decoder_finish()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_finish </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finish the decoding process. Flushes the decoding buffer, releases resources, resets the decoder settings to their defaults, and returns the decoder state to FLAC__STREAM_DECODER_UNINITIALIZED.</p>
<p>In the event of a prematurely-terminated decode, it is not strictly necessary to call this immediately before <a class="el" href="group__flac__stream__decoder.html#gad9cf299956da091111d13e83517d8c44">FLAC__stream_decoder_delete()</a> but it is good practice to match every FLAC__stream_decoder_init_*() with a <a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>An uninitialized decoder instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if MD5 checking is on AND a STREAMINFO block was available AND the MD5 signature in the STREAMINFO block was non-zero AND the signature does not match the one computed by the decoder; else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga95570a455e582b2ab46ab9bb529f26ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga95570a455e582b2ab46ab9bb529f26ac">◆ </a></span>FLAC__stream_decoder_flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_flush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush the stream input. The decoder's input buffer will be cleared and the state set to <code>FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC</code>. This will also turn off MD5 checking.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>true</code> if successful, else <code>false</code> if a memory allocation error occurs (in which case the state will be set to <code>FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR</code>). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa4183c2d925d5a5edddde9d1ca145725"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa4183c2d925d5a5edddde9d1ca145725">◆ </a></span>FLAC__stream_decoder_reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the decoding process. The decoder's input buffer will be cleared and the state set to <code>FLAC__STREAM_DECODER_SEARCH_FOR_METADATA</code>. This is similar to <a class="el" href="group__flac__stream__decoder.html#ga96c47c96920f363cd0972b54067818a9">FLAC__stream_decoder_finish()</a> except that the settings are preserved; there is no need to call FLAC__stream_decoder_init_*() before decoding again. MD5 checking will be restored to its original setting.</p>
<p>If the decoder is seekable, or was initialized with FLAC__stream_decoder_init*_FILE() or FLAC__stream_decoder_init*_file(), the decoder will also attempt to seek to the beginning of the file. If this rewind fails, this function will return <code>false</code>. It follows that <a class="el" href="group__flac__stream__decoder.html#gaa4183c2d925d5a5edddde9d1ca145725">FLAC__stream_decoder_reset()</a> cannot be used when decoding from <code>stdin</code>.</p>
<p>If the decoder was initialized with FLAC__stream_encoder_init*_stream() and is not seekable (i.e. no seek callback was provided or the seek callback returns <code>FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED</code>), it is the duty of the client to start feeding data from the beginning of the stream on the next FLAC__stream_decoder_process_*() call.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>true</code> if successful, else <code>false</code> if a memory allocation occurs (in which case the state will be set to <code>FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR</code>) or a seek error occurs (the state will be unchanged). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9d6df4a39892c05955122cf7f987f856"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9d6df4a39892c05955122cf7f987f856">◆ </a></span>FLAC__stream_decoder_process_single()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_process_single </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode one metadata block or audio frame. This version instructs the decoder to decode a either a single metadata block or a single frame and stop, unless the callbacks return a fatal error or the read callback returns <code>FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM</code>.</p>
<p>As the decoder needs more input it will call the read callback. Depending on what was decoded, the metadata or write callback will be called with the decoded metadata block or audio frame.</p>
<p>Unless there is a fatal read error or end of stream, this function will return once one whole frame is decoded. In other words, if the stream is not synchronized or points to a corrupt frame header, the decoder will continue to try and resync until it gets to a valid frame, then decode one frame, then return. If the decoder points to a frame whose frame CRC in the frame footer does not match the computed frame CRC, this function will issue a FLAC__STREAM_DECODER_ERROR_STATUS_FRAME_CRC_MISMATCH error to the error callback, and return, having decoded one complete, although corrupt, frame. (Such corrupted frames are sent as silence of the correct length to the write callback.)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>An initialized decoder instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if any fatal read, write, or memory allocation error occurred (meaning decoding must stop), else <code>true</code>; for more information about the decoder, check the decoder state with <a class="el" href="group__flac__stream__decoder.html#gaf99dac2d9255f7db4df8a6d9974a9a9a">FLAC__stream_decoder_get_state()</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga027ffb5b75dc39b3d26f55c5e6b42682"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga027ffb5b75dc39b3d26f55c5e6b42682">◆ </a></span>FLAC__stream_decoder_process_until_end_of_metadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_process_until_end_of_metadata </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode until the end of the metadata. This version instructs the decoder to decode from the current position and continue until all the metadata has been read, or until the callbacks return a fatal error or the read callback returns <code>FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM</code>.</p>
<p>As the decoder needs more input it will call the read callback. As each metadata block is decoded, the metadata callback will be called with the decoded metadata.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>An initialized decoder instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if any fatal read, write, or memory allocation error occurred (meaning decoding must stop), else <code>true</code>; for more information about the decoder, check the decoder state with <a class="el" href="group__flac__stream__decoder.html#gaf99dac2d9255f7db4df8a6d9974a9a9a">FLAC__stream_decoder_get_state()</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga89a0723812fa6ef7cdb173715f1bc81f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga89a0723812fa6ef7cdb173715f1bc81f">◆ </a></span>FLAC__stream_decoder_process_until_end_of_stream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_process_until_end_of_stream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode until the end of the stream. This version instructs the decoder to decode from the current position and continue until the end of stream (the read callback returns <code>FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM</code>), or until the callbacks return a fatal error.</p>
<p>As the decoder needs more input it will call the read callback. As each metadata block and frame is decoded, the metadata or write callback will be called with the decoded metadata or frame.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>An initialized decoder instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if any fatal read, write, or memory allocation error occurred (meaning decoding must stop), else <code>true</code>; for more information about the decoder, check the decoder state with <a class="el" href="group__flac__stream__decoder.html#gaf99dac2d9255f7db4df8a6d9974a9a9a">FLAC__stream_decoder_get_state()</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga85b666aba976f29e8dd9d7956fce4301"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga85b666aba976f29e8dd9d7956fce4301">◆ </a></span>FLAC__stream_decoder_skip_single_frame()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_skip_single_frame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Skip one audio frame. This version instructs the decoder to 'skip' a single frame and stop, unless the callbacks return a fatal error or the read callback returns <code>FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM</code>.</p>
<p>The decoding flow is the same as what occurs when <a class="el" href="group__flac__stream__decoder.html#ga9d6df4a39892c05955122cf7f987f856">FLAC__stream_decoder_process_single()</a> is called to process an audio frame, except that this function does not decode the parsed data into PCM or call the write callback. The integrity of the frame is still checked the same way as in the other process functions.</p>
<p>This function will return once one whole frame is skipped, in the same way that <a class="el" href="group__flac__stream__decoder.html#ga9d6df4a39892c05955122cf7f987f856">FLAC__stream_decoder_process_single()</a> will return once one whole frame is decoded.</p>
<p>This function can be used in more quickly determining FLAC frame boundaries when decoding of the actual data is not needed, for example when an application is separating a FLAC stream into frames for editing or storing in a container. To do this, the application can use <a class="el" href="group__flac__stream__decoder.html#ga85b666aba976f29e8dd9d7956fce4301">FLAC__stream_decoder_skip_single_frame()</a> to quickly advance to the next frame, then use <a class="el" href="group__flac__stream__decoder.html#gaffd9b0d0832ed01e6d75930b5391def5">FLAC__stream_decoder_get_decode_position()</a> to find the new frame boundary.</p>
<p>This function should only be called when the stream has advanced past all the metadata, otherwise it will return <code>false</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>An initialized decoder instance not in a metadata state. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>false</code> if any fatal read, write, or memory allocation error occurred (meaning decoding must stop), or if the decoder is in the FLAC__STREAM_DECODER_SEARCH_FOR_METADATA or FLAC__STREAM_DECODER_READ_METADATA state, else <code>true</code>; for more information about the decoder, check the decoder state with <a class="el" href="group__flac__stream__decoder.html#gaf99dac2d9255f7db4df8a6d9974a9a9a">FLAC__stream_decoder_get_state()</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6a2eb6072b9fafefc3f80f1959805ccb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6a2eb6072b9fafefc3f80f1959805ccb">◆ </a></span>FLAC__stream_decoder_seek_absolute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_decoder_seek_absolute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> * </td>
<td class="paramname"><em>decoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FLAC__uint64 </td>
<td class="paramname"><em>sample</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush the input and seek to an absolute sample. Decoding will resume at the given sample. Note that because of this, the next write callback may contain a partial block. The client must support seeking the input or this function will fail and return <code>false</code>. Furthermore, if the decoder state is <code>FLAC__STREAM_DECODER_SEEK_ERROR</code>, then the decoder must be flushed with <a class="el" href="group__flac__stream__decoder.html#ga95570a455e582b2ab46ab9bb529f26ac">FLAC__stream_decoder_flush()</a> or reset with <a class="el" href="group__flac__stream__decoder.html#gaa4183c2d925d5a5edddde9d1ca145725">FLAC__stream_decoder_reset()</a> before decoding can continue.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decoder</td><td>A decoder instance. </td></tr>
<tr><td class="paramname">sample</td><td>The target sample number to seek to. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">decoder != NULL </div></div><!-- fragment --> </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__bool</td><td><code>true</code> if successful, else <code>false</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="gac192360ac435614394bf43235cb7981e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac192360ac435614394bf43235cb7981e">◆ </a></span>FLAC__StreamDecoderStateString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const FLAC__StreamDecoderStateString[]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamDecoderState to a C string.</p>
<p>Using a FLAC__StreamDecoderState as the index to this array will give the string equivalent. The contents should not be modified. </p>
</div>
</div>
<a id="ga0effa1d3031c3206a1719faf984a4f21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0effa1d3031c3206a1719faf984a4f21">◆ </a></span>FLAC__StreamDecoderInitStatusString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const FLAC__StreamDecoderInitStatusString[]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamDecoderInitStatus to a C string.</p>
<p>Using a FLAC__StreamDecoderInitStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>
</div>
</div>
<a id="gab1ee941839b05045ae1d73ee0fdcb8c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab1ee941839b05045ae1d73ee0fdcb8c9">◆ </a></span>FLAC__StreamDecoderReadStatusString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const FLAC__StreamDecoderReadStatusString[]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamDecoderReadStatus to a C string.</p>
<p>Using a FLAC__StreamDecoderReadStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>
</div>
</div>
<a id="gac49aff0593584b7ed5fd0b2508f824fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac49aff0593584b7ed5fd0b2508f824fc">◆ </a></span>FLAC__StreamDecoderSeekStatusString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const FLAC__StreamDecoderSeekStatusString[]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamDecoderSeekStatus to a C string.</p>
<p>Using a FLAC__StreamDecoderSeekStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>
</div>
</div>
<a id="ga3c1b7d5a174d6c2e6bcf1b9a87b5a5cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3c1b7d5a174d6c2e6bcf1b9a87b5a5cb">◆ </a></span>FLAC__StreamDecoderTellStatusString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const FLAC__StreamDecoderTellStatusString[]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamDecoderTellStatus to a C string.</p>
<p>Using a FLAC__StreamDecoderTellStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>
</div>
</div>
<a id="ga792933fa9e8b65bfcac62d82e52415f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga792933fa9e8b65bfcac62d82e52415f5">◆ </a></span>FLAC__StreamDecoderLengthStatusString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const FLAC__StreamDecoderLengthStatusString[]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamDecoderLengthStatus to a C string.</p>
<p>Using a FLAC__StreamDecoderLengthStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>
</div>
</div>
<a id="ga9df7f0fd8cf9888f97a52b5f3f33cdb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9df7f0fd8cf9888f97a52b5f3f33cdb0">◆ </a></span>FLAC__StreamDecoderWriteStatusString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const FLAC__StreamDecoderWriteStatusString[]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamDecoderWriteStatus to a C string.</p>
<p>Using a FLAC__StreamDecoderWriteStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>
</div>
</div>
<a id="gac428c69b084529322df05ee793440b88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac428c69b084529322df05ee793440b88">◆ </a></span>FLAC__StreamDecoderErrorStatusString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const FLAC__StreamDecoderErrorStatusString[]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maps a FLAC__StreamDecoderErrorStatus to a C string.</p>
<p>Using a FLAC__StreamDecoderErrorStatus as the index to this array will give the string equivalent. The contents should not be modified. </p>
</div>
</div>
</div><!-- contents -->
<hr size="1"/>
<div class="copyright">
<!-- @@@ oh so hacky -->
<table>
<tr>
<td align="left">
Copyright (c) 2000-2009 Josh Coalson
Copyright (c) 2011-2016 Xiph.Org Foundation
</td>
<td width="1%" align="right">
<a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
</td>
</tr>
</table>
</div>
<!-- Copyright (c) 2000-2009 Josh Coalson -->
<!-- Copyright (c) 2011-2016 Xiph.Org Foundation -->
<!-- Permission is granted to copy, distribute and/or modify this document -->
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
<!-- or any later version published by the Free Software Foundation; -->
<!-- with no invariant sections. -->
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
</body>
</html>
|
