decoderfactory.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 _audiodecoderfactory_h
#define _audiodecoderfactory_h

#include "Audio/decoder.h"

namespace Mezzanine
{
    namespace Audio
    {
        ///////////////////////////////////////////////////////////////////////////////
        /// @brief This is an interface class for factories that create decoders.
        /// @details
        ///////////////////////////////////////
        class iDecoderFactory
        {
        public:
            /// @brief Class constructor.
            iDecoderFactory() {  }
            /// @brief Class destructor.
            virtual ~iDecoderFactory() {  }

            /// @brief Creates a new @ref iDecoder for use.
            /// @param Stream A smart pointer to the stream containing audio data.
            /// @return Returns the newly created @ref iDecoder, or NULL if there was a failure.
            virtual iDecoder* CreateDecoder(Resource::DataStreamPtr Stream) = 0;
            /// @brief Gets the encoding supported by decoders made by this factory.
            /// @return Returns an @ref Audio::Encoding value representing the encoding supported by this factory.
            virtual Audio::Encoding GetSupportedEncoding() const = 0;
        };//iDecoderFactory
    }//Audio
}//Mezzanine

#endif