---

soundbuffer.h

Go to the documentation of this file.

/*
        $Id: soundbuffer.h,v 1.1 2001/03/06 15:09:12 mbn Exp $

        ------------------------------------------------------------------------
        ClanLib, the platform independent game SDK.

        This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
        version 2. See COPYING for details.

        For a total list of contributers see CREDITS.

        ------------------------------------------------------------------------
*/


#ifndef header_soundbuffer
#define header_soundbuffer

#include "soundbuffer_session.h"
#include "../Core/Resources/resource_manager.h"

class CL_StaticSoundProvider;
class CL_StreamSoundProvider;
class CL_SoundCard;

class CL_SoundBuffer
//: Sample interface in ClanLib.
// The CL_SoundBuffer class represents a sample in ClanLib. It can either be
// static or streamed. The soundbuffer gets its sample data from a
// soundprovider, that is passed during construction.
// <br>
// A static sample are normally sound effects and other sounds, that do not
// change. ClanLib will always load the entire sample into memory, and
// possibly upload it to the soundcard.
// <br>
// Streamed samples are either large sample that should be loaded a bit at a
// time (music for instance), or sounds that change from playback to
// playback (a microphone, speech over the net, etc).
{
public:
        virtual ~CL_SoundBuffer();

        static CL_SoundBuffer *load(
                const char *res_id,
                CL_ResourceManager *manager);

        static CL_SoundBuffer *create(
                CL_StaticSoundProvider *provider,
                bool delete_provider=false);
        //: Creates a static soundbuffer. If 'delete_provider' is true, the provider
        //: will be deleted when the soundbuffer is deleted.
        
        static CL_SoundBuffer *create(
                CL_StreamSoundProvider *provider,
                bool delete_provider=false);
        //: Creates a streamed soundbuffer. If 'delete_provider' is true, the provider
        //: will be delete when the soundbuffer is deleted.

        CL_SoundBuffer(
                const char *res_id,
                CL_ResourceManager *manager);
        //: Loads a soundbuffer (sample) from a resource.

        CL_SoundBuffer(
                CL_StaticSoundProvider *provider,
                bool delete_provider=false,
                class CL_Resource *resource = NULL);
        //: Creates a static soundbuffer. If 'delete_provider' is true, the provider
        //: will be deleted when the soundbuffer is deleted.
        
        CL_SoundBuffer(
                CL_StreamSoundProvider *provider,
                bool delete_provider=false,
                class CL_Resource *resource = NULL);
        //: Creates a streamed soundbuffer. If 'delete_provider' is true, the provider
        //: will be delete when the soundbuffer is deleted.

        CL_SoundBuffer(const CL_SoundBuffer &copy);
        //: Create a copy of this soundbuffer. The copy will share the buffer with the
        //: original.

        CL_StaticSoundProvider *get_static_provider() const;
        //: Returns the static soundprovider attached or NULL if it is a streamed
        //: sound buffer.

        CL_StreamSoundProvider *get_stream_provider() const;
        //: Return the streamed soundprovider attached or NULL if it is a static
        //: sound buffer.

        int get_length() const;
        //: Returns the length of the soundbuffer. 
        //: That is num_samples * bytes_per_sample.
        
        int get_num_samples() const;
        //: Returns the number of samples in the soundbuffer.

        int get_frequency() const;
        //: Returns the start frequency used when the buffer is played.
        
        bool set_frequency(int new_freq);
        //: Sets the start frequency used when the buffer is played.

        float get_volume() const;
        //: Returns the start/default volume used when the buffer is played.
        
        bool set_volume(float new_volume);
        //: Sets the default volume used when the buffer is played.

        float get_pan() const;
        //: Returns the default panning position when the buffer is played.

        bool set_pan(float new_pan);
        //: Sets the default panning position when the buffer is played.

        bool is_playing(CL_SoundBuffer_Session **session=NULL, CL_SoundCard *card=NULL) const;
        //: Returns true if an instance of this soundbuffer is playing

        void stop(CL_SoundCard *card=NULL);
        //: Stops any sessions playing this soundbuffer

        CL_SoundBuffer_Session play(bool looping=false, CL_SoundCard *card=NULL);
        //: Plays the soundbuffer on the specified soundcard 
        //: and using the specified playback description.

        CL_SoundBuffer_Session prepare(bool looping=false, CL_SoundCard *card=NULL);
        //: Prepares the soundbuffer for playback on the specified soundcard.

public:
        class CL_SoundBuffer_Generic *impl;
};

#endif

---