EmbedSound.h

Go to the documentation of this file.

// EmbedSound.h - embedded sound definition, for gnash
// 
//   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
//   Free Software Foundation, Inc
// 
// This program 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.
// 
// This program 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 this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

#ifndef SOUND_EMBEDSOUND_H
#define SOUND_EMBEDSOUND_H

#include <vector>
#include <memory> // for auto_ptr (composition)
#include <set> // for composition (_soundInstances)
#include <cassert>
#include <boost/thread/mutex.hpp>
#include <boost/scoped_ptr.hpp>

#include "SimpleBuffer.h" // for composition
#include "SoundInfo.h" // for composition
#include "SoundEnvelope.h" // for SoundEnvelopes define

// Forward declarations
namespace gnash {
    namespace sound {
        class EmbedSoundInst;
        class InputStream;
    }
    namespace media {
        class MediaHandler;
    }
}

namespace gnash {
namespace sound {

class EmbedSound
{
public:

    //
    typedef std::list<EmbedSoundInst*> Instances;

    //
    EmbedSound(std::auto_ptr<SimpleBuffer> data, const media::SoundInfo& info,
            int volume);

    ~EmbedSound();

    size_t size() const {
        return _buf->size();
    }

    bool empty() const {
        return _buf->empty();
    }

    const boost::uint8_t* data() const {
        return _buf->data();
    }

    //
    const boost::uint8_t* data(size_t pos) const {
        assert(pos < _buf->size());
        return _buf->data()+pos;
    }

    //
    bool isPlaying() const;

    //
    size_t numPlayingInstances() const;

    void getPlayingInstances(std::vector<InputStream*>& to) const;

    //
    EmbedSoundInst* firstPlayingInstance() const;

    //
    std::auto_ptr<EmbedSoundInst> createInstance(media::MediaHandler& mh,
            unsigned int inPoint, unsigned int outPoint,
            const SoundEnvelopes* envelopes, unsigned int loopCount);

    //
    void clearInstances();

    //
    Instances::iterator eraseActiveSound(Instances::iterator i);

    //
    void eraseActiveSound(EmbedSoundInst* inst);

    media::SoundInfo soundinfo;

    int volume;

private:

    boost::scoped_ptr<SimpleBuffer> _buf;

    //
    Instances _soundInstances;

    //
    mutable boost::mutex _soundInstancesMutex;
};

} // gnash.sound namespace 
} // namespace gnash

#endif // SOUND_EMBEDSOUND_H