Spinning Topp Logo BlackTopp Studios
inc
rawdecoder.h
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine 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
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 // Copyright (c) 2008-2010 Raynaldo (Wildicv) Rivera, Joshua (Dark_Kilauea) Jones
41 // This file is part of the "cAudio Engine"
42 // For conditions of distribution and use, see copyright notice in cAudio-ZLIBLicense.txt
43 #ifndef _audiorawdecoder_h
44 #define _audiorawdecoder_h
45 
46 #ifdef ENABLE_RAW_ENCODE
47 
48 #include "Audio/decoder.h"
49 
50 namespace Mezzanine
51 {
52  namespace Audio
53  {
54  ///////////////////////////////////////////////////////////////////////////////
55  /// @brief This is a @ref iDecoder implementation for un-encoded data.
56  /// @details
57  ///////////////////////////////////////
58  class MEZZ_LIB RawDecoder : public iDecoder
59  {
60  protected:
61  /// @internal
62  /// @brief This is a shared pointer to the stream being decoded.
63  Resource::DataStreamPtr RawStream;
64  /// @internal
65  /// @brief This is used to cache the total size of the stream used by this decoder.
66  Integer RawStreamSize;
67  /// @internal
68  /// @brief This is used to cache the current stream position for this decoder.
69  Integer RawStreamPos;
70  /// @internal
71  /// @brief The frequency to expect when decoding the stream.
72  UInt32 Frequency;
73  /// @internal
74  /// @brief The configuration of the samples to expect when decoding the stream.
75  Audio::BitConfig BitConfiguration;
76 
77  /// @copydoc iDecoder::ClearStreamErrors()
78  void ClearStreamErrors();
79  public:
80  /// @brief Class constructor.
81  /// @param Stream The stream to decode.
82  /// @param Freq The frequency of the audio being decoded.
83  /// @param Config The bit configuration of the audio being decoded.
84  RawDecoder(Resource::DataStreamPtr Stream, const UInt32 Freq = 22050, const Audio::BitConfig Config = Audio::BC_16Bit_Mono);
85  /// @brief Class destructor.
86  virtual ~RawDecoder();
87 
88  ///////////////////////////////////////////////////////////////////////////////
89  // Utility
90 
91  /// @copydoc iDecoder::IsValid()
92  Boole IsValid();
93  /// @copydoc iDecoder::GetEncoding() const
94  Audio::Encoding GetEncoding() const;
95  /// @copydoc iDecoder::IsSeekingSupported()
96  Boole IsSeekingSupported();
97  /// @copydoc iDecoder::GetBitConfiguration() const
98  Audio::BitConfig GetBitConfiguration() const;
99  /// @copydoc iDecoder::GetFrequency() const
100  UInt32 GetFrequency() const;
101  /// @copydoc iDecoder::GetStream() const
102  Resource::DataStreamPtr GetStream() const;
103  /// @copydoc iDecoder::IsEndOfStream() const
104  Boole IsEndOfStream() const;
105 
106  /// @copydoc iDecoder::SetPosition(Int32, const Boole)
107  Boole SetPosition(Int32 Position, const Boole Relative);
108  /// @copydoc iDecoder::Seek(const Real, const Boole)
109  Boole Seek(const Real Seconds, const Boole Relative);
110 
111  /// @copydoc iDecoder::ReadAudioData(void*, UInt32)
112  UInt32 ReadAudioData(void* Output, UInt32 Amount);
113 
114  ///////////////////////////////////////////////////////////////////////////////
115  // Stream Stats
116 
117  /// @copydoc iDecoder::GetTotalTime() const
118  Real GetTotalTime() const;
119  /// @copydoc iDecoder::GetCurrentTime() const
120  Real GetCurrentTime() const;
121  /// @copydoc iDecoder::GetTotalSize() const
122  UInt32 GetTotalSize() const;
123  /// @copydoc iDecoder::GetCompressedSize() const
124  UInt32 GetCompressedSize() const;
125  /// @copydoc iDecoder::GetCurrentPosition() const
126  UInt32 GetCurrentPosition() const;
127  /// @copydoc iDecoder::GetCurrentCompressedPosition() const
128  UInt32 GetCurrentCompressedPosition() const;
129  };//RawDecoder
130  }//Audio
131 }//Mezzanine
132 
133 #endif //ENABLE_RAW_ENCODE
134 
135 #endif
int32_t Int32
An 32-bit integer.
Definition: datatypes.h:124
bool Boole
Generally acts a single bit, true or false.
Definition: datatypes.h:173
int Integer
A datatype used to represent any integer close to.
Definition: datatypes.h:154
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
uint32_t UInt32
An 32-bit unsigned integer.
Definition: datatypes.h:126
Encoding
The encoding to use when reading or writing an audio buffer.
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
CountedPtr< DataStream > DataStreamPtr
This is a convenience type for a data stream in a counted pointer.
Definition: datastream.h:383
BitConfig
Used to describe the different bit configurations supported by this audio system. ...