more doxygen docs
[flac.git] / include / FLAC / file_decoder.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001,2002  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__FILE_DECODER_H
21 #define FLAC__FILE_DECODER_H
22
23 #include "stream_decoder.h"
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 typedef enum {
30     FLAC__FILE_DECODER_OK = 0,
31         FLAC__FILE_DECODER_END_OF_FILE,
32     FLAC__FILE_DECODER_ERROR_OPENING_FILE,
33     FLAC__FILE_DECODER_MEMORY_ALLOCATION_ERROR,
34         FLAC__FILE_DECODER_SEEK_ERROR,
35         FLAC__FILE_DECODER_SEEKABLE_STREAM_DECODER_ERROR,
36     FLAC__FILE_DECODER_ALREADY_INITIALIZED,
37     FLAC__FILE_DECODER_INVALID_CALLBACK,
38     FLAC__FILE_DECODER_UNINITIALIZED
39 } FLAC__FileDecoderState;
40 extern const char * const FLAC__FileDecoderStateString[];
41
42 /***********************************************************************
43  *
44  * class FLAC__FileDecoder : public FLAC__StreamDecoder
45  *
46  ***********************************************************************/
47
48 struct FLAC__FileDecoderProtected;
49 struct FLAC__FileDecoderPrivate;
50 typedef struct {
51         struct FLAC__FileDecoderProtected *protected_; /* avoid the C++ keyword 'protected' */
52         struct FLAC__FileDecoderPrivate *private_; /* avoid the C++ keyword 'private' */
53 } FLAC__FileDecoder;
54
55 /***********************************************************************
56  *
57  * Class constructor/destructor
58  *
59  ***********************************************************************/
60
61 /*
62  * Any parameters that are not set before FLAC__file_decoder_init()
63  * will take on the defaults from the constructor, shown below.
64  * For more on what the parameters mean, see the documentation.
65  *
66  * FLAC__bool  md5_checking                   (DEFAULT: false) MD5 checking will be turned off if a seek is requested
67  *           (*write_callback)()              (DEFAULT: NULL ) The callbacks are the only values that MUST be set before FLAC__file_decoder_init()
68  *           (*metadata_callback)()           (DEFAULT: NULL )
69  *           (*error_callback)()              (DEFAULT: NULL )
70  * void*       client_data                    (DEFAULT: NULL ) passed back through the callbacks
71  *          metadata_respond/ignore        By default, only the STREAMINFO block is returned via metadata_callback()
72  */
73 FLAC__FileDecoder *FLAC__file_decoder_new();
74 void FLAC__file_decoder_delete(FLAC__FileDecoder *);
75
76 /***********************************************************************
77  *
78  * Public class method prototypes
79  *
80  ***********************************************************************/
81
82 /*
83  * Various "set" methods.  These may only be called when the decoder
84  * is in the state FLAC__FILE_DECODER_UNINITIALIZED, i.e. after
85  * FLAC__file_decoder_new() or FLAC__file_decoder_finish(), but
86  * before FLAC__file_decoder_init().  If this is the case they will
87  * return true, otherwise false.
88  *
89  * NOTE that these functions do not validate the values as many are
90  * interdependent.  The FLAC__file_decoder_init() function will do
91  * this, so make sure to pay attention to the state returned by
92  * FLAC__file_decoder_init().
93  *
94  * Any parameters that are not set before FLAC__file_decoder_init()
95  * will take on the defaults from the constructor.  NOTE that
96  * FLAC__file_decoder_flush() or FLAC__file_decoder_reset() do
97  * NOT reset the values to the constructor defaults.
98  */
99 FLAC__bool FLAC__file_decoder_set_md5_checking(FLAC__FileDecoder *decoder, FLAC__bool value);
100 FLAC__bool FLAC__file_decoder_set_filename(FLAC__FileDecoder *decoder, const char *value); /* 'value' may not be 0; use "-" for stdin */
101 FLAC__bool FLAC__file_decoder_set_write_callback(FLAC__FileDecoder *decoder, FLAC__StreamDecoderWriteStatus (*value)(const FLAC__FileDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data));
102 FLAC__bool FLAC__file_decoder_set_metadata_callback(FLAC__FileDecoder *decoder, void (*value)(const FLAC__FileDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data));
103 FLAC__bool FLAC__file_decoder_set_error_callback(FLAC__FileDecoder *decoder, void (*value)(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data));
104 FLAC__bool FLAC__file_decoder_set_client_data(FLAC__FileDecoder *decoder, void *value);
105 /*
106  * See the comments for the equivalent functions in stream_decoder.h
107  */
108 FLAC__bool FLAC__file_decoder_set_metadata_respond(FLAC__FileDecoder *decoder, FLAC__MetadataType type);
109 FLAC__bool FLAC__file_decoder_set_metadata_respond_application(FLAC__FileDecoder *decoder, const FLAC__byte id[4]);
110 FLAC__bool FLAC__file_decoder_set_metadata_respond_all(FLAC__FileDecoder *decoder);
111 FLAC__bool FLAC__file_decoder_set_metadata_ignore(FLAC__FileDecoder *decoder, FLAC__MetadataType type);
112 FLAC__bool FLAC__file_decoder_set_metadata_ignore_application(FLAC__FileDecoder *decoder, const FLAC__byte id[4]);
113 FLAC__bool FLAC__file_decoder_set_metadata_ignore_all(FLAC__FileDecoder *decoder);
114
115 /*
116  * Various "get" methods
117  */
118 FLAC__FileDecoderState FLAC__file_decoder_get_state(const FLAC__FileDecoder *decoder);
119 FLAC__bool FLAC__file_decoder_get_md5_checking(const FLAC__FileDecoder *decoder);
120 /*
121  * Methods to return the current number of channels, channel assignment
122  * bits-per-sample, sample rate in Hz, and blocksize in samples.  These
123  * will only be valid after decoding has started.
124  */
125 unsigned FLAC__file_decoder_get_channels(const FLAC__FileDecoder *decoder);
126 FLAC__ChannelAssignment FLAC__file_decoder_get_channel_assignment(const FLAC__FileDecoder *decoder);
127 unsigned FLAC__file_decoder_get_bits_per_sample(const FLAC__FileDecoder *decoder);
128 unsigned FLAC__file_decoder_get_sample_rate(const FLAC__FileDecoder *decoder);
129 unsigned FLAC__file_decoder_get_blocksize(const FLAC__FileDecoder *decoder);
130
131 /*
132  * Initialize the instance; should be called after construction and
133  * 'set' calls but before any of the 'process' or 'seek' calls.  Will
134  * set and return the decoder state, which will be FLAC__FILE_DECODER_OK
135  * if initialization succeeded.
136  */
137 FLAC__FileDecoderState FLAC__file_decoder_init(FLAC__FileDecoder *decoder);
138
139 /*
140  * Flush the decoding buffer, release resources, and return the decoder
141  * state to FLAC__FILE_DECODER_UNINITIALIZED.  Only returns false if
142  * md5_checking is set AND the stored MD5 sum is non-zero AND the stored
143  * MD5 sum and computed MD5 sum do not match.
144  */
145 FLAC__bool FLAC__file_decoder_finish(FLAC__FileDecoder *decoder);
146
147 /*
148  * Methods for decoding the data
149  */
150 FLAC__bool FLAC__file_decoder_process_whole_file(FLAC__FileDecoder *decoder);
151 FLAC__bool FLAC__file_decoder_process_metadata(FLAC__FileDecoder *decoder);
152 FLAC__bool FLAC__file_decoder_process_one_frame(FLAC__FileDecoder *decoder);
153 FLAC__bool FLAC__file_decoder_process_remaining_frames(FLAC__FileDecoder *decoder);
154
155 FLAC__bool FLAC__file_decoder_seek_absolute(FLAC__FileDecoder *decoder, FLAC__uint64 sample);
156
157 #ifdef __cplusplus
158 }
159 #endif
160
161 #endif