soundbuffer.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 */
00028 
00031 
00032 #pragma once
00033 
00034 #include "api_sound.h"
00035 #include "../Core/System/sharedptr.h"
00036 #include "soundbuffer_session.h"
00037 
00038 class CL_ResourceManager;
00039 class CL_SoundOutput;
00040 class CL_SoundProvider;
00041 class CL_SoundBuffer_Session;
00042 class CL_SoundFilter;
00043 class CL_SoundBuffer_Impl;
00044 class CL_IODevice;
00045 class CL_VirtualDirectory;
00046 
00053 class CL_API_SOUND CL_SoundBuffer
00054 {
00057 
00058 public:
00060         CL_SoundBuffer();
00061 
00063 
00076         CL_SoundBuffer(
00077                 const CL_String &res_id,
00078                 CL_ResourceManager *manager);
00079 
00080         CL_SoundBuffer(
00081                 CL_SoundProvider *provider);
00082 
00083         CL_SoundBuffer(
00084                 const CL_String &fullname,
00085                 bool streamed = false,
00086                 const CL_String &format = "");
00087 
00088         CL_SoundBuffer(
00089                 const CL_String &filename,
00090                 bool streamed,
00091                 const CL_VirtualDirectory &directory,
00092                 const CL_String &type = "");
00093 
00094         CL_SoundBuffer(
00095                 CL_IODevice &file,
00096                 bool streamed,
00097                 const CL_String &type);
00098 
00099         virtual ~CL_SoundBuffer();
00100 
00104 
00105 public:
00107         CL_SoundProvider *get_provider() const;
00108 
00110         float get_volume() const;
00111 
00113         float get_pan() const;
00114 
00116         bool is_null() const { return !impl; }
00117 
00119         void throw_if_null() const;
00120 
00124 
00125 public:
00126 
00128 
00131         void set_volume(float new_volume);
00132 
00134 
00138         void set_pan(float new_pan);
00139 
00143         void add_filter(CL_SoundFilter &filter);
00144 
00146         void remove_filter(CL_SoundFilter &filter);
00147 
00154         CL_SoundBuffer_Session play(bool looping = false, CL_SoundOutput *output = 0);
00155 
00161         CL_SoundBuffer_Session prepare(bool looping = false, CL_SoundOutput *output = 0);
00162 
00166 
00167 private:
00168         CL_SharedPtr<CL_SoundBuffer_Impl> impl;
00170 };
00171