---

stream_provider_raw.h

Go to the documentation of this file.

/*
        $Id: stream_provider_raw.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.

        ------------------------------------------------------------------------

        File purpose:
                Streamed sample header file
*/


#ifndef header_streamed_raw_sample
#define header_streamed_raw_sample

#include <stdlib.h>
#include "../stream_soundprovider.h"
#include "../soundbuffer.h"

class CL_Streamed_RawSample : public CL_StreamSoundProvider
//: Streamed sample in raw PCM format (no header).
// This class providers playback support for raw PCM samples. That is just
// the PCM sample data, not header.
// <br>
// Unlike CL_Sample_Raw, this class doesn't load the entire PCM stream into
// memory. Instead it slowly loads it from disk as the data is needed. With
// very large samples, this is a very good idea.
// <br>
// If the sample is small and used a lot, you should consider using
// CL_Sample_Raw instead.
{
public:
        static CL_SoundBuffer *create(
                const char *filename,
                SoundFormat format,
                int frequency,
                CL_InputSourceProvider *inputprovider = NULL,
                bool looped = false);
        // Creates a soundbuffer using this provider.

        CL_Streamed_RawSample(
                const char *filename,
                SoundFormat format,
                int frequency,
                CL_InputSourceProvider *inputprovider = NULL,
                bool looped = false);
        // Constructs an instance of this class.

        virtual ~CL_Streamed_RawSample();

        virtual CL_StreamSoundProvider_Session *begin_session();
        // Called by the sound implementation when a session is begun.

        virtual void end_session(CL_StreamSoundProvider_Session *session);
        // Called by the sound implementation just before a playback session has
        // ended.

protected:
        std::string filename;
        CL_InputSourceProvider *inputprovider;
        bool looped;
        SoundFormat format;
        int frequency;
};

class CL_Streamed_RawSample_Session : public CL_StreamSoundProvider_Session
{
protected:
        CL_InputSource *input;

        SoundFormat sample_format;
        int sample_size;
        int sample_freq;
        int sample_left;
        bool looped;

public:
        CL_Streamed_RawSample_Session(
                CL_InputSource *input,
                SoundFormat format,
                int frequency,
                bool looped);

        virtual ~CL_Streamed_RawSample_Session();

        virtual void stop() {}; //FIXME
        virtual bool play() { return false; }; //FIXME
        virtual bool set_position(int pos) { pos=pos; return false; }; //FIXME
        
        virtual bool eof() const;
        virtual int get_data(void *data_ptr, int data_requested);
        virtual int get_frequency() const;
        virtual SoundFormat get_format() const;
};

#endif

---