playlist.h

Go to the documentation of this file.

// © 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
*/
#ifndef _audioplaylist_h
#define _audioplsylist_h

#include "datatypes.h"
#include "Resource/datastream.h"

/// @file
/// @brief The declaration of the Playlist class.

namespace Mezzanine
{
    namespace Audio
    {
        class iSound;
        ///////////////////////////////////////////////////////////////////////////////
        /// @brief This class is a list of sounds with common playlist features.
        /// @details
        ///////////////////////////////////////
        class MEZZ_LIB Playlist : public std::list< Audio::iSound* >
        {
        protected:
        public:
            /// @brief Class constructor.
            Playlist();
            /// @brief Class destructor.
            ~Playlist();

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

            /// @brief Adds a sound to the playlist.
            /// @param ToAdd The sound to be added.
            void AddSound(iSound* ToAdd);
            /// @brief Randomly shuffles the content in the Playlist.
            void Shuffle();

            /// @brief Checks the playlist to see if it contains a sound.
            /// @param TheSound The sound to check for.
            /// @return Returns true if this playlist contains the provided sound, false otherwise.
            Boole ContainsSound(iSound* TheSound);
        };//Playlist
    }//Audio
}//Mezzanine

#endif