Initial revision
[flac.git] / include / FLAC / stream_decoder.h
1 /* libFLAC - Free Lossless Audio Coder library
2  * Copyright (C) 2000  Josh Coalson
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA  02111-1307, USA.
18  */
19
20 #ifndef FLAC__STREAM_DECODER_H
21 #define FLAC__STREAM_DECODER_H
22
23 #include "format.h"
24
25 typedef enum {
26         FLAC__STREAM_DECODER_SEARCH_FOR_METADATA,
27         FLAC__STREAM_DECODER_READ_METADATA,
28         FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC,
29         FLAC__STREAM_DECODER_READ_FRAME,
30         FLAC__STREAM_DECODER_RESYNC_IN_HEADER,
31         FLAC__STREAM_DECODER_END_OF_STREAM,
32         FLAC__STREAM_DECODER_ABORTED,
33         FLAC__STREAM_DECODER_UNPARSEABLE_STREAM,
34         FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR,
35         FLAC__STREAM_DECODER_UNINITIALIZED
36 } FLAC__StreamDecoderState;
37
38 typedef enum {
39         FLAC__STREAM_DECODER_READ_CONTINUE,
40         FLAC__STREAM_DECODER_READ_END_OF_STREAM,
41         FLAC__STREAM_DECODER_READ_ABORT
42 } FLAC__StreamDecoderReadStatus;
43
44 typedef enum {
45         FLAC__STREAM_DECODER_WRITE_CONTINUE,
46         FLAC__STREAM_DECODER_WRITE_ABORT
47 } FLAC__StreamDecoderWriteStatus;
48
49 typedef enum {
50         FLAC__STREAM_DECODER_ERROR_LOST_SYNC
51 } FLAC__StreamDecoderErrorStatus;
52
53 struct FLAC__StreamDecoderPrivate;
54 typedef struct {
55         /* these fields are read-only and valid as of the last write_callback() */
56         unsigned channels;
57         FLAC__ChannelAssignment channel_assignment;
58         unsigned bits_per_sample;
59         unsigned sample_rate; /* in Hz */
60         unsigned blocksize; /* in samples (per channel) */
61         FLAC__StreamDecoderState state; /* must be FLAC__STREAM_DECODER_UNINITIALIZED when passed to FLAC__stream_decoder_init() */
62         struct FLAC__StreamDecoderPrivate *guts; /* must be 0 when passed to FLAC__stream_decoder_init() */
63 } FLAC__StreamDecoder;
64
65 FLAC__StreamDecoder *FLAC__stream_decoder_get_new_instance();
66 void FLAC__stream_decoder_free_instance(FLAC__StreamDecoder *decoder);
67 FLAC__StreamDecoderState FLAC__stream_decoder_init(
68         FLAC__StreamDecoder *decoder,
69         FLAC__StreamDecoderReadStatus (*read_callback)(const FLAC__StreamDecoder *decoder, byte buffer[], unsigned *bytes, void *client_data),
70         FLAC__StreamDecoderWriteStatus (*write_callback)(const FLAC__StreamDecoder *decoder, const FLAC__FrameHeader *header, const int32 *buffer[], void *client_data),
71         void (*metadata_callback)(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetaData *metadata, void *client_data),
72         void (*error_callback)(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data),
73         void *client_data
74 );
75 void FLAC__stream_decoder_finish(FLAC__StreamDecoder *decoder);
76 bool FLAC__stream_decoder_flush(FLAC__StreamDecoder *decoder);
77 bool FLAC__stream_decoder_reset(FLAC__StreamDecoder *decoder);
78 bool FLAC__stream_decoder_process_whole_stream(FLAC__StreamDecoder *decoder);
79 bool FLAC__stream_decoder_process_metadata(FLAC__StreamDecoder *decoder);
80 bool FLAC__stream_decoder_process_one_frame(FLAC__StreamDecoder *decoder);
81 bool FLAC__stream_decoder_process_remaining_frames(FLAC__StreamDecoder *decoder);
82
83 #endif