update with new semantics for padding
[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_SEEKING, /*@@@ NOTE: unused; remove this in the next minor-version */
32         FLAC__FILE_DECODER_END_OF_FILE,
33     FLAC__FILE_DECODER_ERROR_OPENING_FILE,
34     FLAC__FILE_DECODER_MEMORY_ALLOCATION_ERROR,
35         FLAC__FILE_DECODER_SEEK_ERROR,
36         FLAC__FILE_DECODER_STREAM_ERROR,
37         FLAC__FILE_DECODER_MD5_ERROR, /*@@@ NOTE: unused; remove this in the next minor-version */
38         FLAC__FILE_DECODER_STREAM_DECODER_ERROR,
39     FLAC__FILE_DECODER_ALREADY_INITIALIZED,
40     FLAC__FILE_DECODER_INVALID_CALLBACK,
41     FLAC__FILE_DECODER_UNINITIALIZED,
42         FLAC__FILE_DECODER_SEEKABLE_STREAM_ERROR = FLAC__FILE_DECODER_STREAM_ERROR /*@@@ NOTE: do the actual replacement in the next minor-version */
43 } FLAC__FileDecoderState;
44 extern const char *FLAC__FileDecoderStateString[];
45
46 /***********************************************************************
47  *
48  * class FLAC__FileDecoder : public FLAC__StreamDecoder
49  *
50  ***********************************************************************/
51
52 struct FLAC__FileDecoderProtected;
53 struct FLAC__FileDecoderPrivate;
54 typedef struct {
55         struct FLAC__FileDecoderProtected *protected_; /* avoid the C++ keyword 'protected' */
56         struct FLAC__FileDecoderPrivate *private_; /* avoid the C++ keyword 'private' */
57 } FLAC__FileDecoder;
58
59 /***********************************************************************
60  *
61  * Class constructor/destructor
62  *
63  ***********************************************************************/
64
65 /*
66  * Any parameters that are not set before FLAC__file_decoder_init()
67  * will take on the defaults from the constructor, shown below.
68  * For more on what the parameters mean, see the documentation.
69  *
70  * FLAC__bool  md5_checking                   (DEFAULT: false) MD5 checking will be turned off if a seek is requested
71  *           (*write_callback)()              (DEFAULT: NULL ) The callbacks are the only values that MUST be set before FLAC__file_decoder_init()
72  *           (*metadata_callback)()           (DEFAULT: NULL )
73  *           (*error_callback)()              (DEFAULT: NULL )
74  * void*       client_data                    (DEFAULT: NULL ) passed back through the callbacks
75  */
76 FLAC__FileDecoder *FLAC__file_decoder_new();
77 void FLAC__file_decoder_delete(FLAC__FileDecoder *);
78
79 /***********************************************************************
80  *
81  * Public class method prototypes
82  *
83  ***********************************************************************/
84
85 /*
86  * Various "set" methods.  These may only be called when the decoder
87  * is in the state FLAC__FILE_DECODER_UNINITIALIZED, i.e. after
88  * FLAC__file_decoder_new() or FLAC__file_decoder_finish(), but
89  * before FLAC__file_decoder_init().  If this is the case they will
90  * return true, otherwise false.
91  *
92  * NOTE that these functions do not validate the values as many are
93  * interdependent.  The FLAC__file_decoder_init() function will do
94  * this, so make sure to pay attention to the state returned by
95  * FLAC__file_decoder_init().
96  *
97  * Any parameters that are not set before FLAC__file_decoder_init()
98  * will take on the defaults from the constructor.  NOTE that
99  * FLAC__file_decoder_flush() or FLAC__file_decoder_reset() do
100  * NOT reset the values to the constructor defaults.
101  */
102 FLAC__bool FLAC__file_decoder_set_md5_checking(const FLAC__FileDecoder *decoder, FLAC__bool value);
103 FLAC__bool FLAC__file_decoder_set_filename(const FLAC__FileDecoder *decoder, const char *value); /* 'value' may not be 0; use "-" for stdin */
104 FLAC__bool FLAC__file_decoder_set_write_callback(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderWriteStatus (*value)(const FLAC__FileDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 *buffer[], void *client_data));
105 FLAC__bool FLAC__file_decoder_set_metadata_callback(const FLAC__FileDecoder *decoder, void (*value)(const FLAC__FileDecoder *decoder, const FLAC__StreamMetaData *metadata, void *client_data));
106 FLAC__bool FLAC__file_decoder_set_error_callback(const FLAC__FileDecoder *decoder, void (*value)(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data));
107 FLAC__bool FLAC__file_decoder_set_client_data(const FLAC__FileDecoder *decoder, void *value);
108 /*
109  * See the comments for the equivalent functions in stream_decoder.h
110  */
111 FLAC__bool FLAC__file_decoder_set_metadata_respond(const FLAC__FileDecoder *decoder, FLAC__MetaDataType type);
112 FLAC__bool FLAC__file_decoder_set_metadata_respond_application(const FLAC__FileDecoder *decoder, FLAC__byte id[4]);
113 FLAC__bool FLAC__file_decoder_set_metadata_respond_all(const FLAC__FileDecoder *decoder);
114 FLAC__bool FLAC__file_decoder_set_metadata_ignore(const FLAC__FileDecoder *decoder, FLAC__MetaDataType type);
115 FLAC__bool FLAC__file_decoder_set_metadata_ignore_application(const FLAC__FileDecoder *decoder, FLAC__byte id[4]);
116 FLAC__bool FLAC__file_decoder_set_metadata_ignore_all(const FLAC__FileDecoder *decoder);
117
118 /*
119  * Various "get" methods
120  */
121 FLAC__FileDecoderState FLAC__file_decoder_get_state(const FLAC__FileDecoder *decoder);
122 FLAC__bool FLAC__file_decoder_get_md5_checking(const FLAC__FileDecoder *decoder);
123
124 /*
125  * Initialize the instance; should be called after construction and
126  * 'set' calls but before any of the 'process' or 'seek' calls.  Will
127  * set and return the decoder state, which will be FLAC__FILE_DECODER_OK
128  * if initialization succeeded.
129  */
130 FLAC__FileDecoderState FLAC__file_decoder_init(FLAC__FileDecoder *decoder);
131
132 /*
133  * Flush the decoding buffer, release resources, and return the decoder
134  * state to FLAC__FILE_DECODER_UNINITIALIZED.  Only returns false if
135  * md5_checking is set AND the stored MD5 sum is non-zero AND the stored
136  * MD5 sum and computed MD5 sum do not match.
137  */
138 FLAC__bool FLAC__file_decoder_finish(FLAC__FileDecoder *decoder);
139
140 /*
141  * Methods for decoding the data
142  */
143 FLAC__bool FLAC__file_decoder_process_whole_file(FLAC__FileDecoder *decoder);
144 FLAC__bool FLAC__file_decoder_process_metadata(FLAC__FileDecoder *decoder);
145 FLAC__bool FLAC__file_decoder_process_one_frame(FLAC__FileDecoder *decoder);
146 FLAC__bool FLAC__file_decoder_process_remaining_frames(FLAC__FileDecoder *decoder);
147
148 FLAC__bool FLAC__file_decoder_seek_absolute(FLAC__FileDecoder *decoder, FLAC__uint64 sample);
149
150 #ifdef __cplusplus
151 }
152 #endif
153
154 #endif