add support for last_metadata_is_last flag in the stream encoder
[flac.git] / include / FLAC / file_decoder.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001  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 typedef enum {
26     FLAC__FILE_DECODER_OK = 0,
27         FLAC__FILE_DECODER_SEEKING,
28         FLAC__FILE_DECODER_END_OF_FILE,
29     FLAC__FILE_DECODER_ERROR_OPENING_FILE,
30     FLAC__FILE_DECODER_MEMORY_ALLOCATION_ERROR,
31         FLAC__FILE_DECODER_SEEK_ERROR,
32         FLAC__FILE_DECODER_STREAM_ERROR,
33         FLAC__FILE_DECODER_MD5_ERROR,
34         FLAC__FILE_DECODER_STREAM_DECODER_ERROR,
35     FLAC__FILE_DECODER_ALREADY_INITIALIZED,
36     FLAC__FILE_DECODER_UNINITIALIZED
37 } FLAC__FileDecoderState;
38 extern const char *FLAC__FileDecoderStateString[];
39
40 /***********************************************************************
41  *
42  * class FLAC__FileDecoder : public FLAC__StreamDecoder
43  *
44  ***********************************************************************/
45
46 struct FLAC__FileDecoderProtected;
47 struct FLAC__FileDecoderPrivate;
48 typedef struct {
49         struct FLAC__FileDecoderProtected *protected;
50         struct FLAC__FileDecoderPrivate *private;
51 } FLAC__FileDecoder;
52
53 /***********************************************************************
54  *
55  * Class constructor/destructor
56  *
57  ***********************************************************************/
58
59 FLAC__FileDecoder *FLAC__file_decoder_new();
60 void FLAC__file_decoder_delete(FLAC__FileDecoder *);
61
62 /***********************************************************************
63  *
64  * Public class method prototypes
65  *
66  ***********************************************************************/
67
68 /*
69  * Initialize the instance; should be called after construction and
70  * before any other calls.  Will set and return the decoder state,
71  * which will be FLAC__FILE_DECODER_OK if initialization succeeded.
72  */
73 FLAC__FileDecoderState FLAC__file_decoder_init(
74         FLAC__FileDecoder *decoder,
75         bool check_md5,
76         const char *filename,
77         FLAC__StreamDecoderWriteStatus (*write_callback)(const FLAC__FileDecoder *decoder, const FLAC__Frame *frame, const int32 *buffer[], void *client_data),
78         void (*metadata_callback)(const FLAC__FileDecoder *decoder, const FLAC__StreamMetaData *metadata, void *client_data),
79         void (*error_callback)(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data),
80         void *client_data
81 );
82 /*
83  * only returns false if check_md5 is set AND the stored MD5 sum
84  * is non-zero AND the stored MD5 sum and computed MD5 sum do not
85  * match
86  */
87 bool FLAC__file_decoder_finish(FLAC__FileDecoder *decoder);
88
89 /*
90  * methods to return the file decoder state and check_md5 flag
91  */
92 FLAC__FileDecoderState FLAC__file_decoder_state(const FLAC__FileDecoder *decoder);
93 bool FLAC__file_decoder_check_md5(const FLAC__FileDecoder *decoder);
94
95 /*
96  * methods for decoding the data
97  */
98 bool FLAC__file_decoder_process_whole_file(FLAC__FileDecoder *decoder);
99 bool FLAC__file_decoder_process_metadata(FLAC__FileDecoder *decoder);
100 bool FLAC__file_decoder_process_one_frame(FLAC__FileDecoder *decoder);
101 bool FLAC__file_decoder_process_remaining_frames(FLAC__FileDecoder *decoder);
102
103 bool FLAC__file_decoder_seek_absolute(FLAC__FileDecoder *decoder, uint64 sample);
104
105 #endif