Merge with -r 22620:23107.
[blender.git] / intern / audaspace / sndfile / AUD_SndFileReader.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN LGPL LICENSE BLOCK *****
5  *
6  * Copyright 2009 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * AudaSpace is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with AudaSpace.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * ***** END LGPL LICENSE BLOCK *****
24  */
25
26 #ifndef AUD_SNDFILEREADER
27 #define AUD_SNDFILEREADER
28
29 #include "AUD_IReader.h"
30 #include "AUD_Reference.h"
31 class AUD_Buffer;
32
33 #include <sndfile.h>
34
35 typedef sf_count_t (*sf_read_f)(SNDFILE *sndfile, void *ptr, sf_count_t frames);
36
37 /**
38  * This class reads a sound file via libsndfile.
39  */
40 class AUD_SndFileReader : public AUD_IReader
41 {
42 private:
43         /**
44          * The current position in samples.
45          */
46         int m_position;
47
48         /**
49          * The sample count in the file.
50          */
51         int m_length;
52
53         /**
54          * Whether the file is seekable.
55          */
56         bool m_seekable;
57
58         /**
59          * The specification of the audio data.
60          */
61         AUD_Specs m_specs;
62
63         /**
64          * The playback buffer.
65          */
66         AUD_Buffer* m_buffer;
67
68         /**
69          * The sndfile.
70          */
71         SNDFILE* m_sndfile;
72
73         /**
74          * The reading function.
75          */
76         sf_read_f m_read;
77
78         /**
79          * The virtual IO structure for memory file reading.
80          */
81         SF_VIRTUAL_IO m_vio;
82
83         /**
84          * The pointer to the memory file.
85          */
86         AUD_Reference<AUD_Buffer> m_membuffer;
87
88         /**
89          * The current reading pointer of the memory file.
90          */
91         int m_memoffset;
92
93         // Functions for libsndfile virtual IO functionality
94         static sf_count_t vio_get_filelen(void *user_data);
95         static sf_count_t vio_seek(sf_count_t offset, int whence, void *user_data);
96         static sf_count_t vio_read(void *ptr, sf_count_t count, void *user_data);
97         static sf_count_t vio_tell(void *user_data);
98
99 public:
100         /**
101          * Creates a new reader.
102          * \param filename The path to the file to be read.
103          * \exception AUD_Exception Thrown if the file specified does not exist or
104          *            cannot be read with libsndfile.
105          */
106         AUD_SndFileReader(const char* filename);
107
108         /**
109          * Creates a new reader.
110          * \param buffer The buffer to read from.
111          * \exception AUD_Exception Thrown if the buffer specified cannot be read
112          *                          with libsndfile.
113          */
114         AUD_SndFileReader(AUD_Reference<AUD_Buffer> buffer);
115
116         /**
117          * Destroys the reader and closes the file.
118          */
119         virtual ~AUD_SndFileReader();
120
121         virtual bool isSeekable();
122         virtual void seek(int position);
123         virtual int getLength();
124         virtual int getPosition();
125         virtual AUD_Specs getSpecs();
126         virtual AUD_ReaderType getType();
127         virtual bool notify(AUD_Message &message);
128         virtual void read(int & length, sample_t* & buffer);
129 };
130
131 #endif //AUD_SNDFILEREADER