group__flac__stream__encoder.html
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
<!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_encoder.h: stream encoder 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_encoder.h: stream encoder interface<div class="ingroups"><a class="el" href="group__flac.html">FLAC C API</a> » <a class="el" href="group__flac__encoder.html">FLAC/_encoder.h: encoder 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____StreamEncoder.html">FLAC__StreamEncoder</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:ga18b7941b93bae067192732e913536d44"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__encoder.html#ga2e81f007fb0a7414c0bbb453f37ea37f">FLAC__StreamEncoderReadStatus</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga18b7941b93bae067192732e913536d44">FLAC__StreamEncoderReadCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data)</td></tr>
<tr class="separator:ga18b7941b93bae067192732e913536d44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2998a0af774d793928a7cc3bbc84dcdf"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__encoder.html#ga3737471fd49730bb8cf9b182bdeda05e">FLAC__StreamEncoderWriteStatus</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga2998a0af774d793928a7cc3bbc84dcdf">FLAC__StreamEncoderWriteCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame, void *client_data)</td></tr>
<tr class="separator:ga2998a0af774d793928a7cc3bbc84dcdf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga70b85349d5242e4401c4d8ddf6d9bbca"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__encoder.html#ga6d5be3489f45fcf0c252022c65d87aca">FLAC__StreamEncoderSeekStatus</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga70b85349d5242e4401c4d8ddf6d9bbca">FLAC__StreamEncoderSeekCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 absolute_byte_offset, void *client_data)</td></tr>
<tr class="separator:ga70b85349d5242e4401c4d8ddf6d9bbca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabefdf2279e1d0347d9f98f46da4e415b"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__flac__stream__encoder.html#gab628f63181250eb977a28bf12b7dd9ff">FLAC__StreamEncoderTellStatus</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gabefdf2279e1d0347d9f98f46da4e415b">FLAC__StreamEncoderTellCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data)</td></tr>
<tr class="separator:gabefdf2279e1d0347d9f98f46da4e415b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga091fbf3340d85bcbda1090c31bc320cf"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga091fbf3340d85bcbda1090c31bc320cf">FLAC__StreamEncoderMetadataCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, void *client_data)</td></tr>
<tr class="separator:ga091fbf3340d85bcbda1090c31bc320cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga42a5fab5f91c1b0c3f7098499285f277"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a>) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate, void *client_data)</td></tr>
<tr class="separator:ga42a5fab5f91c1b0c3f7098499285f277"><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:gac5e9db4fc32ca2fa74abd9c8a87c02a5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gac5e9db4fc32ca2fa74abd9c8a87c02a5">FLAC__StreamEncoderState</a> { <br />
  <a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a3a6666ae61a64d955341cec285695bf6">FLAC__STREAM_ENCODER_OK</a> = 0,
<a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a04912e04a3c57d3c53de34742f96d635">FLAC__STREAM_ENCODER_UNINITIALIZED</a>,
<a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5abb312cc8318c7a541cadacd23ceb3bbb">FLAC__STREAM_ENCODER_OGG_ERROR</a>,
<a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a4cb80be4f83eb71f04e74968af1d259e">FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR</a>,
<br />
  <a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a011e3d8b2d02a940bfd0e59c05cf5ae0">FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA</a>,
<a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a8c2b2e9efb43a4f9b25b1d2bd9af5f23">FLAC__STREAM_ENCODER_CLIENT_ERROR</a>,
<a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5af0e4738522e05a7248435c7148f58f91">FLAC__STREAM_ENCODER_IO_ERROR</a>,
<a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a2c2937b7f1600a4ac7c84fc70ab34cf1">FLAC__STREAM_ENCODER_FRAMING_ERROR</a>,
<br />
  <a class="el" href="group__flac__stream__encoder.html#ggac5e9db4fc32ca2fa74abd9c8a87c02a5a35db99d9958bd6c2301a04715fbc44fd">FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR</a>
<br />
}</td></tr>
<tr class="separator:gac5e9db4fc32ca2fa74abd9c8a87c02a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3bb869620af2b188d77982a5c30b047d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> { <br />
  <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da20501dce552da74c5df935eeaa0c9ee3">FLAC__STREAM_ENCODER_INIT_STATUS_OK</a> = 0,
<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da9c64e5f9020d8799e1cd9d39d50e6955">FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR</a>,
<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da8a822b011de88b67c114505ffef39327">FLAC__STREAM_ENCODER_INIT_STATUS_UNSUPPORTED_CONTAINER</a>,
<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047dac2cf461f02e20513003b8cadeae03f9f">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_CALLBACKS</a>,
<br />
  <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da0541c4f827f081b9f1c54c9441e4aa65">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_NUMBER_OF_CHANNELS</a>,
<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047dad6d2631f464183c0c165155200882e6b">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BITS_PER_SAMPLE</a>,
<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da6fdcde9e18c37450c79e8f12b9d9c134">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_SAMPLE_RATE</a>,
<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da652c445f1bd8b6cfb963a30bf416c95a">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BLOCK_SIZE</a>,
<br />
  <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da38a69e94b3333e4ba779d2ff8f43f64e">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_MAX_LPC_ORDER</a>,
<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da5be80403bd7a43450139442e0f34ad7e">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_QLP_COEFF_PRECISION</a>,
<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047da62a17a3ed3c05ddf8ea7f6fecbd4e4a1">FLAC__STREAM_ENCODER_INIT_STATUS_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER</a>,
<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047daa793405c858c7606539082750080a47e">FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE</a>,
<br />
  <a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047daa85afdd1849c75a19594416cef63e3e9">FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA</a>,
<a class="el" href="group__flac__stream__encoder.html#gga3bb869620af2b188d77982a5c30b047dab4e7b50d176a127575df90383cb15e1d">FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED</a>
<br />
}</td></tr>
<tr class="separator:ga3bb869620af2b188d77982a5c30b047d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2e81f007fb0a7414c0bbb453f37ea37f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga2e81f007fb0a7414c0bbb453f37ea37f">FLAC__StreamEncoderReadStatus</a> { <a class="el" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa4bdd691d3666f19ec96ff99402347a2e">FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE</a>,
<a class="el" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa562fef84bf86a9a39682e23066d9cfee">FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM</a>,
<a class="el" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa69b94eeab60e07d5fd33f2b3c8b85759">FLAC__STREAM_ENCODER_READ_STATUS_ABORT</a>,
<a class="el" href="group__flac__stream__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa9bb730b8f6354cc1e810017a2f700316">FLAC__STREAM_ENCODER_READ_STATUS_UNSUPPORTED</a>
}</td></tr>
<tr class="separator:ga2e81f007fb0a7414c0bbb453f37ea37f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3737471fd49730bb8cf9b182bdeda05e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga3737471fd49730bb8cf9b182bdeda05e">FLAC__StreamEncoderWriteStatus</a> { <a class="el" href="group__flac__stream__encoder.html#gga3737471fd49730bb8cf9b182bdeda05ea5622e0199f0203c402fcb7b4ca76f808">FLAC__STREAM_ENCODER_WRITE_STATUS_OK</a> = 0,
<a class="el" href="group__flac__stream__encoder.html#gga3737471fd49730bb8cf9b182bdeda05ea18e7cd6a443fb8bd303c3ba89946bc85">FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR</a>
}</td></tr>
<tr class="separator:ga3737471fd49730bb8cf9b182bdeda05e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6d5be3489f45fcf0c252022c65d87aca"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga6d5be3489f45fcf0c252022c65d87aca">FLAC__StreamEncoderSeekStatus</a> { <a class="el" href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaa99853066610d798627888ec2e5afa667">FLAC__STREAM_ENCODER_SEEK_STATUS_OK</a>,
<a class="el" href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaabf93227938b4e1bf3656fe4ba4159c60">FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR</a>,
<a class="el" href="group__flac__stream__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaa8930179a426134caf30a70147448f037">FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED</a>
}</td></tr>
<tr class="separator:ga6d5be3489f45fcf0c252022c65d87aca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab628f63181250eb977a28bf12b7dd9ff"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gab628f63181250eb977a28bf12b7dd9ff">FLAC__StreamEncoderTellStatus</a> { <a class="el" href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffa48e071d89494ac8f5471e7c0d7a6f43b">FLAC__STREAM_ENCODER_TELL_STATUS_OK</a>,
<a class="el" href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffaf638882e04d7c58e6c29dcc7f410864b">FLAC__STREAM_ENCODER_TELL_STATUS_ERROR</a>,
<a class="el" href="group__flac__stream__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffa9d6bbd317f85fd2d6fc72f64e3cb56e7">FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED</a>
}</td></tr>
<tr class="separator:gab628f63181250eb977a28bf12b7dd9ff"><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:gab09f7620a0ba9c30020c189ce112a52f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new</a> (void)</td></tr>
<tr class="separator:gab09f7620a0ba9c30020c189ce112a52f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7212e6846f543618b6289666de216b29"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga7212e6846f543618b6289666de216b29">FLAC__stream_encoder_delete</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga7212e6846f543618b6289666de216b29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf4f75f7689b6b3fff16b03028aa38326"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaf4f75f7689b6b3fff16b03028aa38326">FLAC__stream_encoder_set_ogg_serial_number</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, long serial_number)</td></tr>
<tr class="separator:gaf4f75f7689b6b3fff16b03028aa38326"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga795be6527a9eb1219331afef2f182a41"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga795be6527a9eb1219331afef2f182a41">FLAC__stream_encoder_set_verify</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga795be6527a9eb1219331afef2f182a41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga35a18815a58141b88db02317892d059b"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga35a18815a58141b88db02317892d059b">FLAC__stream_encoder_set_streamable_subset</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga35a18815a58141b88db02317892d059b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9ec612a48f81805eafdb059548cdaf92"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga9ec612a48f81805eafdb059548cdaf92">FLAC__stream_encoder_set_channels</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:ga9ec612a48f81805eafdb059548cdaf92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7453fc29d7e86b499f23b1adfba98da1"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga7453fc29d7e86b499f23b1adfba98da1">FLAC__stream_encoder_set_bits_per_sample</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:ga7453fc29d7e86b499f23b1adfba98da1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa6b6537875900a6e0f4418a504f55f25"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaa6b6537875900a6e0f4418a504f55f25">FLAC__stream_encoder_set_sample_rate</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:gaa6b6537875900a6e0f4418a504f55f25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaacc01aab02849119f929b8516420fcd3"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaacc01aab02849119f929b8516420fcd3">FLAC__stream_encoder_set_compression_level</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:gaacc01aab02849119f929b8516420fcd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac35cb1b5614464658262e684c4ac3a2f"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gac35cb1b5614464658262e684c4ac3a2f">FLAC__stream_encoder_set_blocksize</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:gac35cb1b5614464658262e684c4ac3a2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3bff001a1efc2e4eb520c954066330f4"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga3bff001a1efc2e4eb520c954066330f4">FLAC__stream_encoder_set_do_mid_side_stereo</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga3bff001a1efc2e4eb520c954066330f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7965d51b93f14cbd6ad5bb9d34f10536"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga7965d51b93f14cbd6ad5bb9d34f10536">FLAC__stream_encoder_set_loose_mid_side_stereo</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga7965d51b93f14cbd6ad5bb9d34f10536"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6598f09ac782a1f2a5743ddf247c81c8"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga6598f09ac782a1f2a5743ddf247c81c8">FLAC__stream_encoder_set_apodization</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const char *specification)</td></tr>
<tr class="separator:ga6598f09ac782a1f2a5743ddf247c81c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad8a0ff058c46f9ce95dc0508f4bdfb0c"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gad8a0ff058c46f9ce95dc0508f4bdfb0c">FLAC__stream_encoder_set_max_lpc_order</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:gad8a0ff058c46f9ce95dc0508f4bdfb0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga179751f915a3d6fc2ca4b33a67bb8780"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga179751f915a3d6fc2ca4b33a67bb8780">FLAC__stream_encoder_set_qlp_coeff_precision</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:ga179751f915a3d6fc2ca4b33a67bb8780"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga495890067203958e5d67a641f8757b1c"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga495890067203958e5d67a641f8757b1c">FLAC__stream_encoder_set_do_qlp_coeff_prec_search</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga495890067203958e5d67a641f8757b1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaed594c373d829f77808a935c54a25fa4"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaed594c373d829f77808a935c54a25fa4">FLAC__stream_encoder_set_do_escape_coding</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:gaed594c373d829f77808a935c54a25fa4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga054313e7f6eaf5c6122d82c6a8b3b808"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga054313e7f6eaf5c6122d82c6a8b3b808">FLAC__stream_encoder_set_do_exhaustive_model_search</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__bool value)</td></tr>
<tr class="separator:ga054313e7f6eaf5c6122d82c6a8b3b808"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8f2ed5a2b35bfea13e6605b0fe55f0fa"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga8f2ed5a2b35bfea13e6605b0fe55f0fa">FLAC__stream_encoder_set_min_residual_partition_order</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:ga8f2ed5a2b35bfea13e6605b0fe55f0fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab9e02bfbbb1d4fcdb666e2e9a678b4f6"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gab9e02bfbbb1d4fcdb666e2e9a678b4f6">FLAC__stream_encoder_set_max_residual_partition_order</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:gab9e02bfbbb1d4fcdb666e2e9a678b4f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2cc4a05caba8a4058f744d9eb8732caa"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga2cc4a05caba8a4058f744d9eb8732caa">FLAC__stream_encoder_set_rice_parameter_search_dist</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, uint32_t value)</td></tr>
<tr class="separator:ga2cc4a05caba8a4058f744d9eb8732caa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab943094585d1c0a4bec497e73567cf85"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gab943094585d1c0a4bec497e73567cf85">FLAC__stream_encoder_set_total_samples_estimate</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 value)</td></tr>
<tr class="separator:gab943094585d1c0a4bec497e73567cf85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga80d57f9069e354cbf1a15a3e3ad9ca78"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga80d57f9069e354cbf1a15a3e3ad9ca78">FLAC__stream_encoder_set_metadata</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **metadata, uint32_t num_blocks)</td></tr>
<tr class="separator:ga80d57f9069e354cbf1a15a3e3ad9ca78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0803321b37189dc5eea4fe1cea25c29a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#gac5e9db4fc32ca2fa74abd9c8a87c02a5">FLAC__StreamEncoderState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga0803321b37189dc5eea4fe1cea25c29a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga820704b95a711e77d55363e8753f9f9f"><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__encoder.html#ga820704b95a711e77d55363e8753f9f9f">FLAC__stream_encoder_get_verify_decoder_state</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga820704b95a711e77d55363e8753f9f9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0916f813358eb6f1e44148353acd4d42"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga0916f813358eb6f1e44148353acd4d42">FLAC__stream_encoder_get_resolved_state_string</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga0916f813358eb6f1e44148353acd4d42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga28373aaf2c47336828d5672696c36662"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga28373aaf2c47336828d5672696c36662">FLAC__stream_encoder_get_verify_decoder_error_stats</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 *absolute_sample, uint32_t *frame_number, uint32_t *channel, uint32_t *sample, FLAC__int32 *expected, FLAC__int32 *got)</td></tr>
<tr class="separator:ga28373aaf2c47336828d5672696c36662"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9efc4964992e001bcec0a8eaedee8d60"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga9efc4964992e001bcec0a8eaedee8d60">FLAC__stream_encoder_get_verify</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga9efc4964992e001bcec0a8eaedee8d60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga201e64032ea4298b2379c93652b28245"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga201e64032ea4298b2379c93652b28245">FLAC__stream_encoder_get_streamable_subset</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga201e64032ea4298b2379c93652b28245"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga412401503141dd42e37831140f78cfa1"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga412401503141dd42e37831140f78cfa1">FLAC__stream_encoder_get_channels</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga412401503141dd42e37831140f78cfa1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga169bbf662b2a2df017b93f663deadd1d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga169bbf662b2a2df017b93f663deadd1d">FLAC__stream_encoder_get_bits_per_sample</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga169bbf662b2a2df017b93f663deadd1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae56f27536528f13375ffdd23fa9045f7"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gae56f27536528f13375ffdd23fa9045f7">FLAC__stream_encoder_get_sample_rate</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:gae56f27536528f13375ffdd23fa9045f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf8a9715b2d09a6876b8dc104bfd70cdc"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaf8a9715b2d09a6876b8dc104bfd70cdc">FLAC__stream_encoder_get_blocksize</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:gaf8a9715b2d09a6876b8dc104bfd70cdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga32da1f89997ab94ce5d677fcd7e24d56"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga32da1f89997ab94ce5d677fcd7e24d56">FLAC__stream_encoder_get_do_mid_side_stereo</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga32da1f89997ab94ce5d677fcd7e24d56"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1455859cf3d233bd4dfff86af010f4fa"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga1455859cf3d233bd4dfff86af010f4fa">FLAC__stream_encoder_get_loose_mid_side_stereo</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga1455859cf3d233bd4dfff86af010f4fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5e1d1c9acd3d5a17106b51f0c0107567"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga5e1d1c9acd3d5a17106b51f0c0107567">FLAC__stream_encoder_get_max_lpc_order</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga5e1d1c9acd3d5a17106b51f0c0107567"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga909830fb7f4a0a35710452df39c269a3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga909830fb7f4a0a35710452df39c269a3">FLAC__stream_encoder_get_qlp_coeff_precision</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga909830fb7f4a0a35710452df39c269a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga65bee5a769d4c5fdc95b81c2fb95061c"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga65bee5a769d4c5fdc95b81c2fb95061c">FLAC__stream_encoder_get_do_qlp_coeff_prec_search</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga65bee5a769d4c5fdc95b81c2fb95061c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0c944049800991422c1bfb3b1c0567a5"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga0c944049800991422c1bfb3b1c0567a5">FLAC__stream_encoder_get_do_escape_coding</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga0c944049800991422c1bfb3b1c0567a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7bc8b32f58df5564db4b6114cb11042d"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga7bc8b32f58df5564db4b6114cb11042d">FLAC__stream_encoder_get_do_exhaustive_model_search</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga7bc8b32f58df5564db4b6114cb11042d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4fa722297092aeaebc9d9e743a327d14"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga4fa722297092aeaebc9d9e743a327d14">FLAC__stream_encoder_get_min_residual_partition_order</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga4fa722297092aeaebc9d9e743a327d14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6f5dfbfb5c6e569c4bae5555c9bf87e6"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga6f5dfbfb5c6e569c4bae5555c9bf87e6">FLAC__stream_encoder_get_max_residual_partition_order</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga6f5dfbfb5c6e569c4bae5555c9bf87e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaca0e38f283b2772b92da7cb4495d909a"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaca0e38f283b2772b92da7cb4495d909a">FLAC__stream_encoder_get_rice_parameter_search_dist</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:gaca0e38f283b2772b92da7cb4495d909a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa22d8935bd985b9cccf6592160ffc6f2"><td class="memItemLeft" align="right" valign="top">FLAC__uint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaa22d8935bd985b9cccf6592160ffc6f2">FLAC__stream_encoder_get_total_samples_estimate</a> (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:gaa22d8935bd985b9cccf6592160ffc6f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7d801879812b48fcbc40f409800c453c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga7d801879812b48fcbc40f409800c453c">FLAC__stream_encoder_init_stream</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, <a class="el" href="group__flac__stream__encoder.html#ga2998a0af774d793928a7cc3bbc84dcdf">FLAC__StreamEncoderWriteCallback</a> write_callback, <a class="el" href="group__flac__stream__encoder.html#ga70b85349d5242e4401c4d8ddf6d9bbca">FLAC__StreamEncoderSeekCallback</a> seek_callback, <a class="el" href="group__flac__stream__encoder.html#gabefdf2279e1d0347d9f98f46da4e415b">FLAC__StreamEncoderTellCallback</a> tell_callback, <a class="el" href="group__flac__stream__encoder.html#ga091fbf3340d85bcbda1090c31bc320cf">FLAC__StreamEncoderMetadataCallback</a> metadata_callback, void *client_data)</td></tr>
<tr class="separator:ga7d801879812b48fcbc40f409800c453c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9d1981bcd30b8db4d73b5466be5570f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga9d1981bcd30b8db4d73b5466be5570f5">FLAC__stream_encoder_init_ogg_stream</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, <a class="el" href="group__flac__stream__encoder.html#ga18b7941b93bae067192732e913536d44">FLAC__StreamEncoderReadCallback</a> read_callback, <a class="el" href="group__flac__stream__encoder.html#ga2998a0af774d793928a7cc3bbc84dcdf">FLAC__StreamEncoderWriteCallback</a> write_callback, <a class="el" href="group__flac__stream__encoder.html#ga70b85349d5242e4401c4d8ddf6d9bbca">FLAC__StreamEncoderSeekCallback</a> seek_callback, <a class="el" href="group__flac__stream__encoder.html#gabefdf2279e1d0347d9f98f46da4e415b">FLAC__StreamEncoderTellCallback</a> tell_callback, <a class="el" href="group__flac__stream__encoder.html#ga091fbf3340d85bcbda1090c31bc320cf">FLAC__StreamEncoderMetadataCallback</a> metadata_callback, void *client_data)</td></tr>
<tr class="separator:ga9d1981bcd30b8db4d73b5466be5570f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga12789a1c4a4e31cd2e7187259fe127f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga12789a1c4a4e31cd2e7187259fe127f8">FLAC__stream_encoder_init_FILE</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FILE *file, <a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a> progress_callback, void *client_data)</td></tr>
<tr class="separator:ga12789a1c4a4e31cd2e7187259fe127f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga57fc668f50ffd99a93df326bfab5e2b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga57fc668f50ffd99a93df326bfab5e2b1">FLAC__stream_encoder_init_ogg_FILE</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FILE *file, <a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a> progress_callback, void *client_data)</td></tr>
<tr class="separator:ga57fc668f50ffd99a93df326bfab5e2b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9d5117c2ac0eeb572784116bf2eb541b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga9d5117c2ac0eeb572784116bf2eb541b">FLAC__stream_encoder_init_file</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const char *filename, <a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a> progress_callback, void *client_data)</td></tr>
<tr class="separator:ga9d5117c2ac0eeb572784116bf2eb541b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4891de2f56045941ae222b61b0fd83a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga4891de2f56045941ae222b61b0fd83a4">FLAC__stream_encoder_init_ogg_file</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const char *filename, <a class="el" href="group__flac__stream__encoder.html#ga42a5fab5f91c1b0c3f7098499285f277">FLAC__StreamEncoderProgressCallback</a> progress_callback, void *client_data)</td></tr>
<tr class="separator:ga4891de2f56045941ae222b61b0fd83a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3522f9de5af29807df1b9780a418b7f3"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder)</td></tr>
<tr class="separator:ga3522f9de5af29807df1b9780a418b7f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga87b9c361292da5c5928a8fb5fda7c423"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const FLAC__int32 *const buffer[], uint32_t samples)</td></tr>
<tr class="separator:ga87b9c361292da5c5928a8fb5fda7c423"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6e31c221f7e23345267c52f53c046c24"><td class="memItemLeft" align="right" valign="top">FLAC__bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved</a> (<a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const FLAC__int32 buffer[], uint32_t samples)</td></tr>
<tr class="separator:ga6e31c221f7e23345267c52f53c046c24"><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:ga1410b7a076b0c8401682f9f812b66df5"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga1410b7a076b0c8401682f9f812b66df5">FLAC__StreamEncoderStateString</a> []</td></tr>
<tr class="separator:ga1410b7a076b0c8401682f9f812b66df5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ec1fa7b3f55b4f07a2727846c285776"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga0ec1fa7b3f55b4f07a2727846c285776">FLAC__StreamEncoderInitStatusString</a> []</td></tr>
<tr class="separator:ga0ec1fa7b3f55b4f07a2727846c285776"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1654422c81846b9b399ac5fb98df61dd"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga1654422c81846b9b399ac5fb98df61dd">FLAC__StreamEncoderReadStatusString</a> []</td></tr>
<tr class="separator:ga1654422c81846b9b399ac5fb98df61dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9f64480accd01525cbfa25c11e6bb74e"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#ga9f64480accd01525cbfa25c11e6bb74e">FLAC__StreamEncoderWriteStatusString</a> []</td></tr>
<tr class="separator:ga9f64480accd01525cbfa25c11e6bb74e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb137b2d787756bf97398f0b60e54c20"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gabb137b2d787756bf97398f0b60e54c20">FLAC__StreamEncoderSeekStatusString</a> []</td></tr>
<tr class="separator:gabb137b2d787756bf97398f0b60e54c20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf8ab921ae968be2be255be1f136e1eec"><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__encoder.html#gaf8ab921ae968be2be255be1f136e1eec">FLAC__StreamEncoderTellStatusString</a> []</td></tr>
<tr class="separator:gaf8ab921ae968be2be255be1f136e1eec"><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 encoder. </p>
<p>The stream encoder can encode to native FLAC, and optionally Ogg FLAC (check FLAC_API_SUPPORTS_OGG_FLAC) streams and files.</p>
<p>The basic usage of this encoder is as follows:</p><ul>
<li>The program creates an instance of an encoder using <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a>.</li>
<li>The program overrides the default settings using FLAC__stream_encoder_set_*() functions. At a minimum, the following functions should be called:<ul>
<li><a class="el" href="group__flac__stream__encoder.html#ga9ec612a48f81805eafdb059548cdaf92">FLAC__stream_encoder_set_channels()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga7453fc29d7e86b499f23b1adfba98da1">FLAC__stream_encoder_set_bits_per_sample()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#gaa6b6537875900a6e0f4418a504f55f25">FLAC__stream_encoder_set_sample_rate()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#gaf4f75f7689b6b3fff16b03028aa38326">FLAC__stream_encoder_set_ogg_serial_number()</a> (if encoding to Ogg FLAC)</li>
<li><a class="el" href="group__flac__stream__encoder.html#gab943094585d1c0a4bec497e73567cf85">FLAC__stream_encoder_set_total_samples_estimate()</a> (if known)</li>
</ul>
</li>
<li>If the application wants to control the compression level or set its own metadata, then the following should also be called:<ul>
<li><a class="el" href="group__flac__stream__encoder.html#gaacc01aab02849119f929b8516420fcd3">FLAC__stream_encoder_set_compression_level()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga795be6527a9eb1219331afef2f182a41">FLAC__stream_encoder_set_verify()</a></li>
<li><a class="el" href="group__flac__stream__encoder.html#ga80d57f9069e354cbf1a15a3e3ad9ca78">FLAC__stream_encoder_set_metadata()</a></li>
</ul>
</li>
<li>The rest of the set functions should only be called if the client needs exact control over how the audio is compressed; thorough understanding of the FLAC format is necessary to achieve good results.</li>
<li>The program initializes the instance to validate the settings and prepare for encoding using<ul>
<li><a class="el" href="group__flac__stream__encoder.html#ga7d801879812b48fcbc40f409800c453c">FLAC__stream_encoder_init_stream()</a> or <a class="el" href="group__flac__stream__encoder.html#ga12789a1c4a4e31cd2e7187259fe127f8">FLAC__stream_encoder_init_FILE()</a> or <a class="el" href="group__flac__stream__encoder.html#ga9d5117c2ac0eeb572784116bf2eb541b">FLAC__stream_encoder_init_file()</a> for native FLAC</li>
<li><a class="el" href="group__flac__stream__encoder.html#ga9d1981bcd30b8db4d73b5466be5570f5">FLAC__stream_encoder_init_ogg_stream()</a> or <a class="el" href="group__flac__stream__encoder.html#ga57fc668f50ffd99a93df326bfab5e2b1">FLAC__stream_encoder_init_ogg_FILE()</a> or <a class="el" href="group__flac__stream__encoder.html#ga4891de2f56045941ae222b61b0fd83a4">FLAC__stream_encoder_init_ogg_file()</a> for Ogg FLAC</li>
</ul>
</li>
<li>The program calls <a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process()</a> or <a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved()</a> to encode data, which subsequently calls the callbacks when there is encoder data ready to be written.</li>
<li>The program finishes the encoding with <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a>, which causes the encoder to encode any data still in its input pipe, update the metadata with the final encoding statistics if output seeking is possible, and finally reset the encoder to the uninitialized state.</li>
<li>The instance may be used again or deleted with <a class="el" href="group__flac__stream__encoder.html#ga7212e6846f543618b6289666de216b29">FLAC__stream_encoder_delete()</a>.</li>
</ul>
<p>In more detail, the stream encoder functions similarly to the <a class="el" href="group__flac__stream__decoder.html">stream decoder </a>, but has fewer callbacks and more options. Typically the client will create a new instance by calling <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a>, then set the necessary parameters with FLAC__stream_encoder_set_*(), and initialize it by calling one of the FLAC__stream_encoder_init_*() functions.</p>
<p>Unlike the decoders, the stream encoder has many options that can affect the speed and compression ratio. When setting these parameters you should have some basic knowledge of the format (see the <a href="../documentation_format_overview.html">user-level documentation</a> or the <a href="../format.html">formal description</a>). The FLAC__stream_encoder_set_*() functions themselves do not validate the values as many are interdependent. The FLAC__stream_encoder_init_*() functions will do this, so make sure to pay attention to the state returned by FLAC__stream_encoder_init_*() to make sure that it is FLAC__STREAM_ENCODER_INIT_STATUS_OK. Any parameters that are not set before FLAC__stream_encoder_init_*() will take on the defaults from the constructor.</p>
<p>There are three initialization functions for native FLAC, one for setting up the encoder to encode FLAC data to the client via callbacks, and two for encoding directly to a file.</p>
<p>For encoding via callbacks, use <a class="el" href="group__flac__stream__encoder.html#ga7d801879812b48fcbc40f409800c453c">FLAC__stream_encoder_init_stream()</a>. You must also supply a write callback which will be called anytime there is raw encoded data to write. If the client can seek the output it is best to also supply seek and tell callbacks, as this allows the encoder to go back after encoding is finished to write back information that was collected while encoding, like seek point offsets, frame sizes, etc.</p>
<p>For encoding directly to a file, use <a class="el" href="group__flac__stream__encoder.html#ga12789a1c4a4e31cd2e7187259fe127f8">FLAC__stream_encoder_init_FILE()</a> or <a class="el" href="group__flac__stream__encoder.html#ga9d5117c2ac0eeb572784116bf2eb541b">FLAC__stream_encoder_init_file()</a>. Then you must only supply a filename or open <code>FILE*</code>; the encoder will handle all the callbacks internally. You may also supply a progress callback for periodic notification of the encoding progress.</p>
<p>There are three similarly-named init functions for encoding to 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>The call to FLAC__stream_encoder_init_*() currently will also immediately call the write callback several times, once with the <code>fLaC</code> signature, and once for each encoded metadata block. Note that for Ogg FLAC encoding you will usually get at least twice the number of callbacks than with native FLAC, one for the Ogg page header and one for the page body.</p>
<p>After initializing the instance, the client may feed audio data to the encoder in one of two ways:</p>
<ul>
<li>Channel separate, through <a class="el" href="group__flac__stream__encoder.html#ga87b9c361292da5c5928a8fb5fda7c423">FLAC__stream_encoder_process()</a> - The client will pass an array of pointers to buffers, one for each channel, to the encoder, each of the same length. The samples need not be block-aligned, but each channel should have the same number of samples.</li>
<li>Channel interleaved, through <a class="el" href="group__flac__stream__encoder.html#ga6e31c221f7e23345267c52f53c046c24">FLAC__stream_encoder_process_interleaved()</a> - The client will pass a single pointer to data that is channel-interleaved (i.e. channel0_sample0, channel1_sample0, ... , channelN_sample0, channel0_sample1, ...). Again, the samples need not be block-aligned but they must be sample-aligned, i.e. the first value should be channel0_sample0 and the last value channelN_sampleM.</li>
</ul>
<p>Note that for either process call, each sample in the buffers should be a signed integer, right-justified to the resolution set by <a class="el" href="group__flac__stream__encoder.html#ga7453fc29d7e86b499f23b1adfba98da1">FLAC__stream_encoder_set_bits_per_sample()</a>. For example, if the resolution is 16 bits per sample, the samples should all be in the range [-32768,32767].</p>
<p>When the client is finished encoding data, it calls <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a>, which causes the encoder to encode any data still in its input pipe, and call the metadata callback with the final encoding statistics. Then the instance may be deleted with <a class="el" href="group__flac__stream__encoder.html#ga7212e6846f543618b6289666de216b29">FLAC__stream_encoder_delete()</a> or initialized again to encode another stream.</p>
<p>For programs that write their own metadata, but that do not know the actual metadata until after encoding, it is advantageous to instruct the encoder to write a PADDING block of the correct size, so that instead of rewriting the whole stream after encoding, the program can just overwrite the PADDING block. If only the maximum size of the metadata is known, the program can write a slightly larger padding block, then split it after encoding.</p>
<p>Make sure you understand how lengths are calculated. All FLAC metadata blocks have a 4 byte header which contains the type and length. This length does not include the 4 bytes of the header. See the format page for the specification of metadata blocks and their lengths.</p>
<dl class="section note"><dt>Note</dt><dd>If you are writing the FLAC data to a file via callbacks, make sure it is open for update (e.g. mode "w+" for stdio streams). This is because after the first encoding pass, the encoder will try to seek back to the beginning of the stream, to the STREAMINFO block, to write some data there. (If using FLAC__stream_encoder_init*_file() or FLAC__stream_encoder_init*_FILE(), the file is managed internally.)</dd>
<dd>
The "set" functions may only be called when the encoder is in the state FLAC__STREAM_ENCODER_UNINITIALIZED, i.e. after <a class="el" href="group__flac__stream__encoder.html#gab09f7620a0ba9c30020c189ce112a52f">FLAC__stream_encoder_new()</a> or <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a>, but before FLAC__stream_encoder_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__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a> resets all settings to the constructor defaults. </dd></dl>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga18b7941b93bae067192732e913536d44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga18b7941b93bae067192732e913536d44">◆ </a></span>FLAC__StreamEncoderReadCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__flac__stream__encoder.html#ga2e81f007fb0a7414c0bbb453f37ea37f">FLAC__StreamEncoderReadStatus</a>(* FLAC__StreamEncoderReadCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, 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 <a class="el" href="group__flac__stream__encoder.html#ga9d1981bcd30b8db4d73b5466be5570f5">FLAC__stream_encoder_init_ogg_stream()</a> if seeking is supported. The supplied function will be called when the encoder needs to read back encoded data. This happens during the metadata callback, when the encoder has to read, modify, and rewrite the metadata (e.g. seekpoints) gathered while encoding. 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__StreamEncoderReadStatus.</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__encoder.html#ga2e81f007fb0a7414c0bbb453f37ea37f">FLAC__StreamEncoderReadStatus</a> read_cb(<span class="keyword">const</span> <a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, 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__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa69b94eeab60e07d5fd33f2b3c8b85759">FLAC__STREAM_ENCODER_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__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa562fef84bf86a9a39682e23066d9cfee">FLAC__STREAM_ENCODER_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__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa4bdd691d3666f19ec96ff99402347a2e">FLAC__STREAM_ENCODER_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__encoder.html#gga2e81f007fb0a7414c0bbb453f37ea37fa69b94eeab60e07d5fd33f2b3c8b85759">FLAC__STREAM_ENCODER_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____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>The encoder 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 encoded. </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_encoder_set_client_data(). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamEncoderReadStatus</td><td>The callee's return status. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga2998a0af774d793928a7cc3bbc84dcdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2998a0af774d793928a7cc3bbc84dcdf">◆ </a></span>FLAC__StreamEncoderWriteCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__flac__stream__encoder.html#ga3737471fd49730bb8cf9b182bdeda05e">FLAC__StreamEncoderWriteStatus</a>(* FLAC__StreamEncoderWriteCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame, 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 FLAC__stream_encoder_init*_stream(). The supplied function will be called by the encoder anytime there is raw encoded data ready to write. It may include metadata mixed with encoded audio frames and the data is not guaranteed to be aligned on frame or metadata block boundaries.</p>
<p>The only duty of the callback is to write out the <em>bytes</em> worth of data in <em>buffer</em> to the current position in the output stream. The arguments <em>samples</em> and <em>current_frame</em> are purely informational. If <em>samples</em> is greater than <code>0</code>, then <em>current_frame</em> will hold the current frame number that is being written; otherwise it indicates that the write callback is being called to write metadata.</p>
<dl class="section note"><dt>Note</dt><dd>Unlike when writing to native FLAC, when writing to Ogg FLAC the write callback will be called twice when writing each audio frame; once for the page header, and once for the page body. When writing the page header, the <em>samples</em> argument to the write callback will be <code>0</code>.</dd>
<dd>
In general, <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>The encoder instance calling the callback. </td></tr>
<tr><td class="paramname">buffer</td><td>An array of encoded data of length <em>bytes</em>. </td></tr>
<tr><td class="paramname">bytes</td><td>The byte length of <em>buffer</em>. </td></tr>
<tr><td class="paramname">samples</td><td>The number of samples encoded by <em>buffer</em>. <code>0</code> has a special meaning; see above. </td></tr>
<tr><td class="paramname">current_frame</td><td>The number of the current frame being encoded. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_encoder_init_*(). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamEncoderWriteStatus</td><td>The callee's return status. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga70b85349d5242e4401c4d8ddf6d9bbca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga70b85349d5242e4401c4d8ddf6d9bbca">◆ </a></span>FLAC__StreamEncoderSeekCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__flac__stream__encoder.html#ga6d5be3489f45fcf0c252022c65d87aca">FLAC__StreamEncoderSeekStatus</a>(* FLAC__StreamEncoderSeekCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, 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_encoder_init*_stream(). The supplied function will be called when the encoder needs to seek the output stream. The encoder 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__encoder.html#ga6d5be3489f45fcf0c252022c65d87aca">FLAC__StreamEncoderSeekStatus</a> seek_cb(<span class="keyword">const</span> <a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, 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__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaa8930179a426134caf30a70147448f037">FLAC__STREAM_ENCODER_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__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaabf93227938b4e1bf3656fe4ba4159c60">FLAC__STREAM_ENCODER_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__encoder.html#gga6d5be3489f45fcf0c252022c65d87acaa99853066610d798627888ec2e5afa667">FLAC__STREAM_ENCODER_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____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>The encoder 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_encoder_init_*(). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamEncoderSeekStatus</td><td>The callee's return status. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gabefdf2279e1d0347d9f98f46da4e415b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabefdf2279e1d0347d9f98f46da4e415b">◆ </a></span>FLAC__StreamEncoderTellCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__flac__stream__encoder.html#gab628f63181250eb977a28bf12b7dd9ff">FLAC__StreamEncoderTellStatus</a>(* FLAC__StreamEncoderTellCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, 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_encoder_init*_stream(). The supplied function will be called when the encoder needs to know the current position of the output stream.</p>
<dl class="section warning"><dt>Warning</dt><dd>The callback must return the true current byte offset of the output to which the encoder is writing. If you are buffering the output, make sure and take this into account. If you are writing directly to a FILE* from your write callback, ftell() is sufficient. If you are writing directly to a file descriptor from your write callback, you can use lseek(fd, SEEK_CUR, 0). The encoder may later seek back to these points to rewrite metadata after encoding.</dd></dl>
<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__encoder.html#gab628f63181250eb977a28bf12b7dd9ff">FLAC__StreamEncoderTellStatus</a> tell_cb(<span class="keyword">const</span> <a class="code" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, 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__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffa9d6bbd317f85fd2d6fc72f64e3cb56e7">FLAC__STREAM_ENCODER_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__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffaf638882e04d7c58e6c29dcc7f410864b">FLAC__STREAM_ENCODER_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__encoder.html#ggab628f63181250eb977a28bf12b7dd9ffa48e071d89494ac8f5471e7c0d7a6f43b">FLAC__STREAM_ENCODER_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____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>The encoder instance calling the callback. </td></tr>
<tr><td class="paramname">absolute_byte_offset</td><td>The address at which to store the current position of the output. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_encoder_init_*(). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamEncoderTellStatus</td><td>The callee's return status. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga091fbf3340d85bcbda1090c31bc320cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga091fbf3340d85bcbda1090c31bc320cf">◆ </a></span>FLAC__StreamEncoderMetadataCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* FLAC__StreamEncoderMetadataCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, 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 may be passed to FLAC__stream_encoder_init*_stream(). The supplied function will be called once at the end of encoding with the populated STREAMINFO structure. This is so the client can seek back to the beginning of the file and write the STREAMINFO block with the correct statistics after encoding (like minimum/maximum frame size and total samples).</p>
<dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>The encoder instance calling the callback. </td></tr>
<tr><td class="paramname">metadata</td><td>The final populated STREAMINFO block. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_encoder_init_*(). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga42a5fab5f91c1b0c3f7098499285f277"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga42a5fab5f91c1b0c3f7098499285f277">◆ </a></span>FLAC__StreamEncoderProgressCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* FLAC__StreamEncoderProgressCallback) (const <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate, void *client_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the progress callback.</p>
<p>A function pointer matching this signature may be passed to FLAC__stream_encoder_init*_file() or FLAC__stream_encoder_init*_FILE(). The supplied function will be called when the encoder has finished writing a frame. The <code>total_frames_estimate</code> argument to the callback will be based on the value from <a class="el" href="group__flac__stream__encoder.html#gab943094585d1c0a4bec497e73567cf85">FLAC__stream_encoder_set_total_samples_estimate()</a>.</p>
<dl class="section note"><dt>Note</dt><dd>In general, <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> functions which change the state should not be called on the <em>encoder</em> while in the callback.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>The encoder instance calling the callback. </td></tr>
<tr><td class="paramname">bytes_written</td><td>Bytes written so far. </td></tr>
<tr><td class="paramname">samples_written</td><td>Samples written so far. </td></tr>
<tr><td class="paramname">frames_written</td><td>Frames written so far. </td></tr>
<tr><td class="paramname">total_frames_estimate</td><td>The estimate of the total number of frames to be written. </td></tr>
<tr><td class="paramname">client_data</td><td>The callee's client data set through FLAC__stream_encoder_init_*(). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gac5e9db4fc32ca2fa74abd9c8a87c02a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac5e9db4fc32ca2fa74abd9c8a87c02a5">◆ </a></span>FLAC__StreamEncoderState</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#gac5e9db4fc32ca2fa74abd9c8a87c02a5">FLAC__StreamEncoderState</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>State values for a <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>.</p>
<p>The encoder's state can be obtained by calling <a class="el" href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state()</a>.</p>
<p>If the encoder gets into any other state besides <code>FLAC__STREAM_ENCODER_OK</code> or <code>FLAC__STREAM_ENCODER_UNINITIALIZED</code>, it becomes invalid for encoding and must be deleted with <a class="el" href="group__flac__stream__encoder.html#ga7212e6846f543618b6289666de216b29">FLAC__stream_encoder_delete()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a3a6666ae61a64d955341cec285695bf6"></a>FLAC__STREAM_ENCODER_OK </td><td class="fielddoc"><p>The encoder is in the normal OK state and samples can be processed. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a04912e04a3c57d3c53de34742f96d635"></a>FLAC__STREAM_ENCODER_UNINITIALIZED </td><td class="fielddoc"><p>The encoder is in the uninitialized state; one of the FLAC__stream_encoder_init_*() functions must be called before samples can be processed. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5abb312cc8318c7a541cadacd23ceb3bbb"></a>FLAC__STREAM_ENCODER_OGG_ERROR </td><td class="fielddoc"><p>An error occurred in the underlying Ogg layer. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a4cb80be4f83eb71f04e74968af1d259e"></a>FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR </td><td class="fielddoc"><p>An error occurred in the underlying verify stream decoder; check <a class="el" href="group__flac__stream__encoder.html#ga820704b95a711e77d55363e8753f9f9f">FLAC__stream_encoder_get_verify_decoder_state()</a>. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a011e3d8b2d02a940bfd0e59c05cf5ae0"></a>FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA </td><td class="fielddoc"><p>The verify decoder detected a mismatch between the original audio signal and the decoded audio signal. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a8c2b2e9efb43a4f9b25b1d2bd9af5f23"></a>FLAC__STREAM_ENCODER_CLIENT_ERROR </td><td class="fielddoc"><p>One of the callbacks returned a fatal error. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5af0e4738522e05a7248435c7148f58f91"></a>FLAC__STREAM_ENCODER_IO_ERROR </td><td class="fielddoc"><p>An I/O error occurred while opening/reading/writing a file. Check <code>errno</code>. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a2c2937b7f1600a4ac7c84fc70ab34cf1"></a>FLAC__STREAM_ENCODER_FRAMING_ERROR </td><td class="fielddoc"><p>An error occurred while writing the stream; usually, the write_callback returned an error. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac5e9db4fc32ca2fa74abd9c8a87c02a5a35db99d9958bd6c2301a04715fbc44fd"></a>FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR </td><td class="fielddoc"><p>Memory allocation failed. </p>
</td></tr>
</table>
</div>
</div>
<a id="ga3bb869620af2b188d77982a5c30b047d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3bb869620af2b188d77982a5c30b047d">◆ </a></span>FLAC__StreamEncoderInitStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#ga3bb869620af2b188d77982a5c30b047d">FLAC__StreamEncoderInitStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Possible return values for the FLAC__stream_encoder_init_*() functions. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da20501dce552da74c5df935eeaa0c9ee3"></a>FLAC__STREAM_ENCODER_INIT_STATUS_OK </td><td class="fielddoc"><p>Initialization was successful. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da9c64e5f9020d8799e1cd9d39d50e6955"></a>FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR </td><td class="fielddoc"><p>General failure to set up encoder; call <a class="el" href="group__flac__stream__encoder.html#ga0803321b37189dc5eea4fe1cea25c29a">FLAC__stream_encoder_get_state()</a> for cause. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da8a822b011de88b67c114505ffef39327"></a>FLAC__STREAM_ENCODER_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="gga3bb869620af2b188d77982a5c30b047dac2cf461f02e20513003b8cadeae03f9f"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_CALLBACKS </td><td class="fielddoc"><p>A required callback was not supplied. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da0541c4f827f081b9f1c54c9441e4aa65"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_NUMBER_OF_CHANNELS </td><td class="fielddoc"><p>The encoder has an invalid setting for number of channels. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047dad6d2631f464183c0c165155200882e6b"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BITS_PER_SAMPLE </td><td class="fielddoc"><p>The encoder has an invalid setting for bits-per-sample. FLAC supports 4-32 bps but the reference encoder currently supports only up to 24 bps. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da6fdcde9e18c37450c79e8f12b9d9c134"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_SAMPLE_RATE </td><td class="fielddoc"><p>The encoder has an invalid setting for the input sample rate. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da652c445f1bd8b6cfb963a30bf416c95a"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BLOCK_SIZE </td><td class="fielddoc"><p>The encoder has an invalid setting for the block size. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da38a69e94b3333e4ba779d2ff8f43f64e"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_MAX_LPC_ORDER </td><td class="fielddoc"><p>The encoder has an invalid setting for the maximum LPC order. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da5be80403bd7a43450139442e0f34ad7e"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_QLP_COEFF_PRECISION </td><td class="fielddoc"><p>The encoder has an invalid setting for the precision of the quantized linear predictor coefficients. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047da62a17a3ed3c05ddf8ea7f6fecbd4e4a1"></a>FLAC__STREAM_ENCODER_INIT_STATUS_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER </td><td class="fielddoc"><p>The specified block size is less than the maximum LPC order. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047daa793405c858c7606539082750080a47e"></a>FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE </td><td class="fielddoc"><p>The encoder is bound to the <a href="../format.html#subset">Subset</a> but other settings violate it. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047daa85afdd1849c75a19594416cef63e3e9"></a>FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA </td><td class="fielddoc"><p>The metadata input to the encoder is invalid, in one of the following ways:</p><ul>
<li><a class="el" href="group__flac__stream__encoder.html#ga80d57f9069e354cbf1a15a3e3ad9ca78">FLAC__stream_encoder_set_metadata()</a> was called with a null pointer but a block count > 0</li>
<li>One of the metadata blocks contains an undefined type</li>
<li>It contains an illegal CUESHEET as checked by <a class="el" href="group__flac__format.html#gaa9ed0fa4ed04dbfdaa163d0f5308c080">FLAC__format_cuesheet_is_legal()</a></li>
<li>It contains an illegal SEEKTABLE as checked by <a class="el" href="group__flac__format.html#ga02ed0843553fb8f718fe8e7c54d12244">FLAC__format_seektable_is_legal()</a></li>
<li>It contains more than one SEEKTABLE block or more than one VORBIS_COMMENT block </li>
</ul>
</td></tr>
<tr><td class="fieldname"><a id="gga3bb869620af2b188d77982a5c30b047dab4e7b50d176a127575df90383cb15e1d"></a>FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED </td><td class="fielddoc"><p>FLAC__stream_encoder_init_*() was called when the encoder was already initialized, usually because <a class="el" href="group__flac__stream__encoder.html#ga3522f9de5af29807df1b9780a418b7f3">FLAC__stream_encoder_finish()</a> was not called. </p>
</td></tr>
</table>
</div>
</div>
<a id="ga2e81f007fb0a7414c0bbb453f37ea37f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2e81f007fb0a7414c0bbb453f37ea37f">◆ </a></span>FLAC__StreamEncoderReadStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#ga2e81f007fb0a7414c0bbb453f37ea37f">FLAC__StreamEncoderReadStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> read callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga2e81f007fb0a7414c0bbb453f37ea37fa4bdd691d3666f19ec96ff99402347a2e"></a>FLAC__STREAM_ENCODER_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="gga2e81f007fb0a7414c0bbb453f37ea37fa562fef84bf86a9a39682e23066d9cfee"></a>FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM </td><td class="fielddoc"><p>The read was attempted at the end of the stream. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga2e81f007fb0a7414c0bbb453f37ea37fa69b94eeab60e07d5fd33f2b3c8b85759"></a>FLAC__STREAM_ENCODER_READ_STATUS_ABORT </td><td class="fielddoc"><p>An unrecoverable error occurred. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga2e81f007fb0a7414c0bbb453f37ea37fa9bb730b8f6354cc1e810017a2f700316"></a>FLAC__STREAM_ENCODER_READ_STATUS_UNSUPPORTED </td><td class="fielddoc"><p>Client does not support reading back from the output. </p>
</td></tr>
</table>
</div>
</div>
<a id="ga3737471fd49730bb8cf9b182bdeda05e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3737471fd49730bb8cf9b182bdeda05e">◆ </a></span>FLAC__StreamEncoderWriteStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#ga3737471fd49730bb8cf9b182bdeda05e">FLAC__StreamEncoderWriteStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> write callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga3737471fd49730bb8cf9b182bdeda05ea5622e0199f0203c402fcb7b4ca76f808"></a>FLAC__STREAM_ENCODER_WRITE_STATUS_OK </td><td class="fielddoc"><p>The write was OK and encoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga3737471fd49730bb8cf9b182bdeda05ea18e7cd6a443fb8bd303c3ba89946bc85"></a>FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR </td><td class="fielddoc"><p>An unrecoverable error occurred. The encoder will return from the process call. </p>
</td></tr>
</table>
</div>
</div>
<a id="ga6d5be3489f45fcf0c252022c65d87aca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6d5be3489f45fcf0c252022c65d87aca">◆ </a></span>FLAC__StreamEncoderSeekStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#ga6d5be3489f45fcf0c252022c65d87aca">FLAC__StreamEncoderSeekStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> seek callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga6d5be3489f45fcf0c252022c65d87acaa99853066610d798627888ec2e5afa667"></a>FLAC__STREAM_ENCODER_SEEK_STATUS_OK </td><td class="fielddoc"><p>The seek was OK and encoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga6d5be3489f45fcf0c252022c65d87acaabf93227938b4e1bf3656fe4ba4159c60"></a>FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR </td><td class="fielddoc"><p>An unrecoverable error occurred. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga6d5be3489f45fcf0c252022c65d87acaa8930179a426134caf30a70147448f037"></a>FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED </td><td class="fielddoc"><p>Client does not support seeking. </p>
</td></tr>
</table>
</div>
</div>
<a id="gab628f63181250eb977a28bf12b7dd9ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab628f63181250eb977a28bf12b7dd9ff">◆ </a></span>FLAC__StreamEncoderTellStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__flac__stream__encoder.html#gab628f63181250eb977a28bf12b7dd9ff">FLAC__StreamEncoderTellStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return values for the <a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> tell callback. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggab628f63181250eb977a28bf12b7dd9ffa48e071d89494ac8f5471e7c0d7a6f43b"></a>FLAC__STREAM_ENCODER_TELL_STATUS_OK </td><td class="fielddoc"><p>The tell was OK and encoding can continue. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggab628f63181250eb977a28bf12b7dd9ffaf638882e04d7c58e6c29dcc7f410864b"></a>FLAC__STREAM_ENCODER_TELL_STATUS_ERROR </td><td class="fielddoc"><p>An unrecoverable error occurred. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggab628f63181250eb977a28bf12b7dd9ffa9d6bbd317f85fd2d6fc72f64e3cb56e7"></a>FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED </td><td class="fielddoc"><p>Client does not support seeking. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gab09f7620a0ba9c30020c189ce112a52f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab09f7620a0ba9c30020c189ce112a52f">◆ </a></span>FLAC__stream_encoder_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a>* FLAC__stream_encoder_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 encoder instance. The instance is created with default settings; see the individual FLAC__stream_encoder_set_*() functions for each setting's default.</p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__StreamEncoder*</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="ga7212e6846f543618b6289666de216b29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7212e6846f543618b6289666de216b29">◆ </a></span>FLAC__stream_encoder_delete()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FLAC__stream_encoder_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> * </td>
<td class="paramname"><em>encoder</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free an encoder instance. Deletes the object pointed to by <em>encoder</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>A pointer to an existing encoder. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != NULL </div></div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="gaf4f75f7689b6b3fff16b03028aa38326"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf4f75f7689b6b3fff16b03028aa38326">◆ </a></span>FLAC__stream_encoder_set_ogg_serial_number()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_encoder_set_ogg_serial_number </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> * </td>
<td class="paramname"><em>encoder</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 to use in the Ogg container.</p>
<dl class="section note"><dt>Note</dt><dd>This does not need to be set for native FLAC encoding.</dd>
<dd>
It is recommended to set a serial number explicitly as the default of '0' may collide with other streams.</dd></dl>
<dl class="section user"><dt>Default Value:</dt><dd><code>0</code> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>An encoder 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">encoder != 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 encoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga795be6527a9eb1219331afef2f182a41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga795be6527a9eb1219331afef2f182a41">◆ </a></span>FLAC__stream_encoder_set_verify()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_encoder_set_verify </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> * </td>
<td class="paramname"><em>encoder</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 "verify" flag. If <code>true</code>, the encoder will verify it's own encoded output by feeding it through an internal decoder and comparing the original signal against the decoded signal. If a mismatch occurs, the process call will return <code>false</code>. Note that this will slow the encoding process by the extra time required for decoding and comparison.</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">encoder</td><td>An encoder 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">encoder != 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 encoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga35a18815a58141b88db02317892d059b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga35a18815a58141b88db02317892d059b">◆ </a></span>FLAC__stream_encoder_set_streamable_subset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_encoder_set_streamable_subset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> * </td>
<td class="paramname"><em>encoder</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 <a href="../format.html#subset">Subset</a> flag. If <code>true</code>, the encoder will comply with the Subset and will check the settings during FLAC__stream_encoder_init_*() to see if all settings comply. If <code>false</code>, the settings may take advantage of the full range that the format allows.</p>
<p>Make sure you know what it entails before setting this to <code>false</code>.</p>
<dl class="section user"><dt>Default Value:</dt><dd><code>true</code> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>An encoder 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">encoder != 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 encoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9ec612a48f81805eafdb059548cdaf92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9ec612a48f81805eafdb059548cdaf92">◆ </a></span>FLAC__stream_encoder_set_channels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_encoder_set_channels </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> * </td>
<td class="paramname"><em>encoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </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 number of channels to be encoded.</p>
<dl class="section user"><dt>Default Value:</dt><dd><code>2</code> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
<tr><td class="paramname">value</td><td>See above. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != 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 encoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga7453fc29d7e86b499f23b1adfba98da1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7453fc29d7e86b499f23b1adfba98da1">◆ </a></span>FLAC__stream_encoder_set_bits_per_sample()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_encoder_set_bits_per_sample </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> * </td>
<td class="paramname"><em>encoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </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 sample resolution of the input to be encoded.</p>
<dl class="section warning"><dt>Warning</dt><dd>Do not feed the encoder data that is wider than the value you set here or you will generate an invalid stream.</dd></dl>
<dl class="section user"><dt>Default Value:</dt><dd><code>16</code> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
<tr><td class="paramname">value</td><td>See above. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != 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 encoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa6b6537875900a6e0f4418a504f55f25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa6b6537875900a6e0f4418a504f55f25">◆ </a></span>FLAC__stream_encoder_set_sample_rate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_encoder_set_sample_rate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFLAC____StreamEncoder.html">FLAC__StreamEncoder</a> * </td>
<td class="paramname"><em>encoder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </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 sample rate (in Hz) of the input to be encoded.</p>
<dl class="section user"><dt>Default Value:</dt><dd><code>44100</code> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoder</td><td>An encoder instance to set. </td></tr>
<tr><td class="paramname">value</td><td>See above. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Assertions:</dt><dd><div class="fragment"><div class="line">encoder != 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 encoder is already initialized, else <code>true</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaacc01aab02849119f929b8516420fcd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaacc01aab02849119f929b8516420fcd3">◆ </a></span>FLAC__stream_encoder_set_compression_level()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLAC__bool FLAC__stream_encoder_set_compression_level </td>