rawdecoder.h

// © Copyright 2010 - 2016 BlackTopp Studios Inc.
/* This file is part of The Mezzanine Engine.

    The Mezzanine Engine is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    The Mezzanine Engine is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with The Mezzanine Engine.  If not, see <http://www.gnu.org/licenses/>.
*/
/* The original authors have included a copy of the license specified above in the
   'Docs' folder. See 'gpl.txt'
*/
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
   Build professional software and charge for their product.

   However there are some practical restrictions, so if your project involves
   any of the following you should contact us and we will try to work something
   out:
    - DRM or Copy Protection of any kind(except Copyrights)
    - Software Patents You Do Not Wish to Freely License
    - Any Kind of Linking to Non-GPL licensed Works
    - Are Currently In Violation of Another Copyright Holder's GPL License
    - If You want to change our code and not add a few hundred MB of stuff to
        your distribution

   These and other limitations could cause serious legal problems if you ignore
   them, so it is best to simply contact us or the Free Software Foundation, if
   you have any questions.

   Joseph Toppi - toppij@gmail.com
   John Blackwood - makoenergy02@gmail.com
*/
// Copyright (c) 2008-2010 Raynaldo (Wildicv) Rivera, Joshua (Dark_Kilauea) Jones
// This file is part of the "cAudio Engine"
// For conditions of distribution and use, see copyright notice in cAudio-ZLIBLicense.txt
#ifndef _audiorawdecoder_h
#define _audiorawdecoder_h

#ifdef ENABLE_RAW_ENCODE

#include "Audio/decoder.h"

namespace Mezzanine
{
    namespace Audio
    {
        ///////////////////////////////////////////////////////////////////////////////
        /// @brief This is a @ref iDecoder implementation for un-encoded data.
        /// @details
        ///////////////////////////////////////
        class MEZZ_LIB RawDecoder : public iDecoder
        {
        protected:
            /// @internal
            /// @brief This is a shared pointer to the stream being decoded.
            Resource::DataStreamPtr RawStream;
            /// @internal
            /// @brief This is used to cache the total size of the stream used by this decoder.
            Integer RawStreamSize;
            /// @internal
            /// @brief This is used to cache the current stream position for this decoder.
            Integer RawStreamPos;
            /// @internal
            /// @brief The frequency to expect when decoding the stream.
            UInt32 Frequency;
            /// @internal
            /// @brief The configuration of the samples to expect when decoding the stream.
            Audio::BitConfig BitConfiguration;

            /// @copydoc iDecoder::ClearStreamErrors()
            void ClearStreamErrors();
        public:
            /// @brief Class constructor.
            /// @param Stream The stream to decode.
            /// @param Freq The frequency of the audio being decoded.
            /// @param Config The bit configuration of the audio being decoded.
            RawDecoder(Resource::DataStreamPtr Stream, const UInt32 Freq = 22050, const Audio::BitConfig Config = Audio::BC_16Bit_Mono);
            /// @brief Class destructor.
            virtual ~RawDecoder();

            ///////////////////////////////////////////////////////////////////////////////
            // Utility

            /// @copydoc iDecoder::IsValid()
            Boole IsValid();
            /// @copydoc iDecoder::GetEncoding() const
            Audio::Encoding GetEncoding() const;
            /// @copydoc iDecoder::IsSeekingSupported()
            Boole IsSeekingSupported();
            /// @copydoc iDecoder::GetBitConfiguration() const
            Audio::BitConfig GetBitConfiguration() const;
            /// @copydoc iDecoder::GetFrequency() const
            UInt32 GetFrequency() const;
            /// @copydoc iDecoder::GetStream() const
            Resource::DataStreamPtr GetStream() const;
            /// @copydoc iDecoder::IsEndOfStream() const
            Boole IsEndOfStream() const;

            /// @copydoc iDecoder::SetPosition(Int32, const Boole)
            Boole SetPosition(Int32 Position, const Boole Relative);
            /// @copydoc iDecoder::Seek(const Real, const Boole)
            Boole Seek(const Real Seconds, const Boole Relative);

            /// @copydoc iDecoder::ReadAudioData(void*, UInt32)
            UInt32 ReadAudioData(void* Output, UInt32 Amount);

            ///////////////////////////////////////////////////////////////////////////////
            // Stream Stats

            /// @copydoc iDecoder::GetTotalTime() const
            Real GetTotalTime() const;
            /// @copydoc iDecoder::GetCurrentTime() const
            Real GetCurrentTime() const;
            /// @copydoc iDecoder::GetTotalSize() const
            UInt32 GetTotalSize() const;
            /// @copydoc iDecoder::GetCompressedSize() const
            UInt32 GetCompressedSize() const;
            /// @copydoc iDecoder::GetCurrentPosition() const
            UInt32 GetCurrentPosition() const;
            /// @copydoc iDecoder::GetCurrentCompressedPosition() const
            UInt32 GetCurrentCompressedPosition() const;
        };//RawDecoder
    }//Audio
}//Mezzanine

#endif //ENABLE_RAW_ENCODE

#endif