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