Initial revision
[blender.git] / intern / SoundSystem / SND_WaveSlot.h
1 /*
2  * SND_WaveSlot.cpp
3  *
4  * class for storing sample related information
5  *
6  * $Id$
7  *
8  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version. The Blender
14  * Foundation also sells licenses for use in proprietary software under
15  * the Blender License.  See http://www.blender.org/BL/ for information
16  * about this.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
26  *
27  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
28  * All rights reserved.
29  *
30  * The Original Code is: all of this file.
31  *
32  * Contributor(s): none yet.
33  *
34  * ***** END GPL/BL DUAL LICENSE BLOCK *****
35  */
36
37 #ifndef __SND_WAVESLOT_H
38 #define __SND_WAVESLOT_H
39
40 #include "STR_String.h"
41
42 class SND_WaveSlot
43 {
44         STR_String              m_samplename;
45         bool                    m_loaded;
46         void*                   m_data;
47         unsigned int    m_buffer;
48         unsigned int    m_sampleformat;
49         unsigned int    m_numberofchannels;
50         unsigned int    m_samplerate;
51         unsigned int    m_bitrate;
52         unsigned int    m_numberofsamples;
53         unsigned int    m_filesize;
54
55 public:
56
57         SND_WaveSlot(): m_loaded(false),
58                                         m_data(NULL),
59                                         m_buffer(0),
60                                         m_sampleformat(0),
61                                         m_numberofchannels(0),
62                                         m_samplerate(0),
63                                         m_bitrate(0),
64                                         m_numberofsamples(0),
65                                         m_filesize(0)
66                                         {};
67         ~SND_WaveSlot();
68
69         void SetSampleName(STR_String samplename);
70         void SetLoaded(bool loaded);
71         void SetData(void* data);
72         void SetBuffer(unsigned int buffer);
73         void SetSampleFormat(unsigned int sampleformat);
74         void SetNumberOfChannels(unsigned int numberofchannels);
75         void SetSampleRate(unsigned int samplerate);
76         void SetBitRate(unsigned int bitrate);
77         void SetNumberOfSamples(unsigned int numberofsamples);
78         void SetFileSize(unsigned int filesize);
79         
80
81         const STR_String&       GetSampleName();
82         bool                            IsLoaded() const;
83         void*                           GetData();
84         unsigned int            GetBuffer() const;
85         unsigned int            GetSampleFormat() const;
86         unsigned int            GetNumberOfChannels() const;
87         unsigned int            GetSampleRate() const;
88         unsigned int            GetBitRate() const;
89         unsigned int            GetNumberOfSamples() const;
90         unsigned int            GetFileSize() const;
91
92 };
93
94 #endif //__SND_WAVESLOT_H