source: downloads/openal-0.0.8/src/al_mixer.c @ 27

/* -*- mode: C; tab-width:8; c-basic-offset:8 -*-
 * vi:set ts=8:
 *
 * al_mixer.c
 *
 * Place where most stuff happens.  The main mixer iteration function
 * is defined here.
 *
 */
#include "al_siteconfig.h"

#include <AL/al.h>
#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/time.h>
#include <sys/types.h>
#include <unistd.h>
#include <string.h>

#include "al_debug.h"
#include "al_error.h"
#include "al_types.h"
#include "al_main.h"
#include "al_buffer.h"
#include "al_filter.h"
#include "al_mixer.h"
#include "al_mixmanager.h"
#include "al_source.h"
#include "al_mspool.h"
#include "mixaudio16.h"

#include "alc/alc_context.h"
#include "alc/alc_device.h"
#include "alc/alc_speaker.h"

#include "audioconvert/audioconvert.h"

#include "al_threadlib.h"
#include "al_mutexlib.h"

#include "backends/alc_backend.h"

#define MIN(a,b) ((a) < (b) ? (a) : (b))
#define MAX(a,b) ((a) > (b) ? (a) : (b))

/*
 * The mixing function checks this variable for equality with AL_TRUE.  When
 * this is the case, it exits.  The default is AL_FALSE.
 */
ALboolean volatile time_for_mixer_to_die = AL_FALSE;

/* our thread ID, if async */
ThreadID mixthread = NULL;

/*
 * MixManager is the ALMixManager we use, in conjunction with MixFunc, to
 * dispatch mixing functions for combining streams of PCM data.
 */
static ALMixManager MixManager;

/*
 * MixFunc is the ALMixFunc we use, in conjunction with MixManager, to
 * dispatch mixing functions for combining streams of PCM data.
 */
static ALMixFunc MixFunc;

/*
 * mspool is our pool of mspool nodes.
 */
static _alMixPool mspool;

/*
 * s16le is the data structure we use to convert data from the canonical
 * format into the external format.
 */
static acAudioCVT s16le;

/*
 * mix_mutex is the guard around mspool.
 */
static MutexID mix_mutex   = NULL;

/*
 * pause_mutex is an aid to mixer pausing.
 */
static MutexID pause_mutex = NULL;

/*
 * Size of how much data we should mix at a time for each source.
 */
static ALuint bufsiz = 0;

static struct {
        void *data;
        ALuint length;
} mixbuf = { NULL, 0 };

/* streaming buffer array */
static struct {
        ALuint *streaming_buffers;
        ALuint size;
        ALuint items;
} sbufs = { NULL, 0, 0 };

/*
 * sync_mixer_iterate( void *dummy )
 *
 * Non-threaded top level mixing logic.
 */
int sync_mixer_iterate( void *dummy );

/*
 * async_mixer_iterate( void *dummy )
 *
 * Threaded top level mixing logic.
 */
int async_mixer_iterate( void *dummy )AL_ATTRIBUTE_NORETURN_;

/*
 * Pointer to either sync or async_mixer_iterate.
 */
int (*mixer_iterate)( void *dummy ) = NULL;

/*
 * _alAddDataToMixer( void *dataptr, ALuint bytes_to_write )
 *
 * Mixes bytes_to_write data from dataptr to the system buffer.  If
 * bytes_to_write exceeds the system buffer size, it is truncated and returns
 * the maximum it could write.
 */
static ALuint _alAddDataToMixer( void *dataptr, ALuint bytes_to_write );

/*
 * _alProcessFlags( void )
 *
 * Processes flags set by the top-level mixing function.  These flags control
 * things like deletion.
 */
static void _alProcessFlags( void );

/*
 * _alDestroyMixSource( void *ms )
 *
 * Finalize a _alMixSource object.
 */
static void _alDestroyMixSource( void *ms );

/*
 * _alAddBufferToStreamingList( ALuint bid )
 *
 * AL_buffers generated using alGenStreamingBuffers_LOKI need to be handled in
 * a special way.  This function does that special handling.
 */
static void _alAddBufferToStreamingList( ALuint bid );

/*
 * _alTryLockMixerPause( void )
 *
 * Try to lock the mix_pause mutex.  Return AL_TRUE if lock suceeded, AL_FALSE
 * otherwise.
 */
static ALboolean _alTryLockMixerPause( void );

/*
 * _alMixSources
 *
 * This is the where most of the action is directed.
 *
 * assumes locked mixbuf
 */
static void _alMixSources( void )
{
        AL_buffer *samp;
        AL_source *src;
        int *sampid;
        _alMixSource *itr = NULL;
        ALboolean islooping   = AL_FALSE;
        ALboolean isstreaming = AL_FALSE;
        ALboolean iscallback  = AL_FALSE;
        ALboolean isinqueue   = AL_FALSE;
        ALuint pitr; /* pool iterator */
        ALuint nc = _alcDCGetNumSpeakers();

        for(pitr = 0; pitr < mspool.size; pitr++)
        {
                if(mspool.pool[pitr].inuse == AL_FALSE)
                {
                        /* if not in use, can't be played anyway */
                        continue;
                }

                itr = _alMixPoolIndex( &mspool, pitr );
                assert(itr);

                if(!(itr->flags & ALM_PLAY_ME))
                {
                        /*
                         * current mix source on the way out, so
                         * ignore it
                         */
                        _alDebug(ALD_MIXER, __FILE__, __LINE__,
                                "_alMixSources: %d is on the out",
                                itr->sid);
                        continue;
                }

                _alDebug(ALD_MAXIMUS, __FILE__, __LINE__,
                        "_alMixSources: currently on source id %d",
                        itr->sid);

                /* check for paused context. */
                if( _alcIsContextSuspended( itr->context_id ) == AL_TRUE )
                {
                        continue;
                }

                _alLockSource( itr->context_id, itr->sid );

                src = _alGetSource(itr->context_id, itr->sid);
                if(src == NULL)
                {
                        /* not a valid src */
                        itr->flags = ALM_DESTROY_ME;

                        _alUnlockSource( itr->context_id, itr->sid );

                        continue;
                }

                if(src->state == AL_PAUSED)
                {
                        /* Paused sources don't get mixed */
                        _alUnlockSource( itr->context_id, itr->sid );
                        continue;
                }

                sampid = _alGetSourceParam(src, AL_BUFFER);
                if(sampid == NULL)
                {
                        /* source added with no buffer associated */
                        itr->flags = ALM_DESTROY_ME;

                        _alDebug(ALD_MIXER, __FILE__, __LINE__,
                                "No bid associated with sid %d", itr->sid);

                        _alUnlockSource( itr->context_id, itr->sid );

                        continue;
                }

                samp = _alGetBuffer(*sampid);
                if(samp == NULL)
                {
                        /* source added with no valid buffer associated */
                        _alDebug(ALD_MIXER, __FILE__, __LINE__,
                                "no such bid [sid|bid] [%d|%d]",
                                itr->sid, *sampid);

                        itr->flags = ALM_DESTROY_ME;

                        _alUnlockSource( itr->context_id, itr->sid );

                        continue;
                }

                /* get special needs */
                islooping   = _alSourceIsLooping( src );
                isinqueue   = _alSourceGetPendingBids( src ) > 0;
                isstreaming = _alBidIsStreaming( *sampid );
                iscallback  = _alBidIsCallback( *sampid );

                /* apply each filter to sourceid sid */
                _alApplyFilters(itr->context_id, itr->sid);

                _alAddDataToMixer(src->srcParams.outbuf, bufsiz);

                if(_alSourceShouldIncrement(src) == AL_TRUE)
                {
                        /*
                         * soundpos is an offset into the original buffer
                         * data, which is most likely mono.  We use nc (the
                         * number of channels in mixer's format) to scale
                         * soundpos.
                         *
                         * John Quigley noticed a bug resulting from the
                         * mix manager getting unequal amounts of data.
                         * so we always add the same amount of data to
                         * the mixer, because we should be memsetting it
                         * to 0 when we're applying the filters.
                         */
                        _alSourceIncrement(src, bufsiz / nc);
                }

                if((isinqueue == AL_TRUE) &&
                   (src->srcParams.new_readindex >= 0))
                {
                        /*
                         * If new_readindex is set, so should be
                         * new_soundpos.
                         */
                        assert(src->srcParams.new_soundpos >= 0);

                        src->bid_queue.read_index =src->srcParams.new_readindex;
                        src->srcParams.soundpos =  src->srcParams.new_soundpos;

                        /*
                         * Sanity check so that we don't read past the size
                         * of the next buffer in the queue.
                         */

#ifdef DEBUG_QUEUE
                        if(src->bid_queue.read_index < src->bid_queue.size)
                        {
                                ALint ri = src->bid_queue.read_index;
                                ALint bid = src->bid_queue.queue[ri];
                                AL_buffer *samp = _alGetBuffer(bid);

                                assert(samp);
                                assert(src->srcParams.soundpos < samp->size);
                        }
#endif

                        /*
                         * Flag so that we don't do this again
                         * until the next SplitSourceQueue.
                         */
                        src->srcParams.new_readindex = -1;
                        src->srcParams.new_soundpos = -1;
                }
                else if(_alSourceBytesLeft(src, samp) <= 0)
                {
                        /*
                         * end of sound.  streaming & looping are special
                         * cases.
                         */
                        if(islooping == AL_TRUE && _alSourceIsQueue( src ) == AL_FALSE )
                        {
                                if(iscallback == AL_TRUE)
                                {
                                        _alDebug(ALD_LOOP, __FILE__, __LINE__,
                                        "%d callback loop reset ", itr->sid);

                                        src->srcParams.soundpos = 0;

                                        /*
                                         * we've actually been fudging the
                                         * size
                                         */
                                        samp->size /= nc;
                                } else {
                                        _alDebug(ALD_LOOP, __FILE__, __LINE__,
                                        "%d loop reset", itr->sid);

                                        /*
                                         * Looping buffers are prefed via
                                         * SplitSources, so soundpos is
                                         * actually bigger than the buffer
                                         * size (because they wrap around).
                                         */
                                        src->srcParams.soundpos %= samp->size;
                                }
                        }
                        else if(!isstreaming && !isinqueue)
                        {
                            if ( _alSourceIsQueue( src ) )
                             {
                              _alDebug(ALD_QUEUE, __FILE__, __LINE__,
                              "%d queue loop reset",src->sid );
                              src->srcParams.new_readindex = 0;
                              src->srcParams.new_soundpos = 0;
                              src->bid_queue.read_index =src->srcParams.new_readindex;
                              src->srcParams.soundpos =  src->srcParams.new_soundpos;
                              itr->flags = ALM_PLAY_ME;
                             } else
                                {
                                    _alDebug(ALD_LOOP, __FILE__, __LINE__,
                                    "%d loop destroy",itr->sid);
                                    /* This buffer is solo */
                                    itr->flags = ALM_DESTROY_ME;
                                }
                        }
                }

                if(isinqueue && (_alSourceGetPendingBids(src) < 0))
                {
                        /*
                         * the read index might have been incremented
                         * past our tolerance
                         */
                        itr->flags = ALM_DESTROY_ME;
                }

                _alUnlockSource( itr->context_id, itr->sid );
        }

        return;
}

/*
 * _alAddDataToMixer( void *dataptr, ALuint bytes_to_write )
 *
 *
 * Mixes bytes_to_write data from dataptr to the system buffer.  If
 * bytes_to_write exceeds the system buffer size, it is truncated and returns
 * the maximum it could write.
 *
 * assumes that mixer and default context are locked
 */
static ALuint _alAddDataToMixer( void *dataptr, ALuint bytes_to_write )
{
        if((dataptr == NULL) || (bytes_to_write == 0))
        {
                /* Most likely, thread is waiting to die */
                return 0;
        }

        if(bytes_to_write > bufsiz)
        {
                bytes_to_write = bufsiz;
        }

        /* add entry to mix manager */
        _alMixManagerAdd( &MixManager, dataptr, bytes_to_write );

        return bytes_to_write;
}

/*
 * void _alDestroyMixer( void )
 *
 * Deallocate data allocated in _alInitMixer.
 */
void _alDestroyMixer( void )
{
        if( mix_mutex != NULL )
        {
                _alDestroyMutex( mix_mutex );
                mix_mutex = NULL;
        }

        _alMixPoolFree( &mspool, _alDestroyMixSource );
        mspool.size = 0;

        mixthread = NULL;

        _alMixFuncDestroy(&MixFunc);
        _alMixManagerDestroy(&MixManager);

        free(mixbuf.data);
        mixbuf.data   = NULL;
        mixbuf.length = 0;

        if( pause_mutex != NULL )
        {
                /* we may we destroyed while paused, which is bad, but
                 * not horrible.  Try to lock it.  If sucessful, then
                 * we weren't locked before, so we unlock and Destroy.
                 * Otherwise, just unlock and destroy, since we aren't
                 * going to be need async_mixer_iterate services anytime
                 * soon anyway.
                 */
                _alTryLockMixerPause();
                _alUnlockMixerPause(); /* at this point, we are either locked by
                                          the context or by our own doing, so it's
                                          okay to unlock.
                                        */

                _alDestroyMutex( pause_mutex );
                pause_mutex = NULL;
        }


        return;
}

/*
 * _alDestroyMixSource( void *ms )
 *
 * Finalize a _alMixSource object.
 */
static void _alDestroyMixSource( void *ms )
{
        _alMixSource *msrc = (_alMixSource *) ms;
        ALuint sid = msrc->sid;
        ALuint cid = msrc->context_id;
        AL_source *src;
        ALuint *bid;
        ALuint i;

        _alLockSource( cid, sid );

        src = _alGetSource( cid, sid );
        if(src == NULL) {
                /*
                 * source got nuked somewhere, or context was
                 * destroyed while paused.
                 */

                _alDebug(ALD_MIXER, __FILE__, __LINE__,
                        "_alDestroyMixSource: source id %d is not valid",
                        msrc->sid);

                _alUnlockSource( cid, sid );

                return;
        }

        /*
         * state should always be set to stopped by this point.
         */
        src->state = AL_STOPPED;

        /* clear sid */
        msrc->sid = 0;

        /*
         * Update buffer state
         */
        bid = _alGetSourceParam(src, AL_BUFFER);

        if(_alSourceQueuedBuffers(src) > 1)
        {
                int ri;

                ri = MIN(src->bid_queue.read_index, src->bid_queue.size - 1);

                assert( ri >= 0 );
                assert( ri < src->bid_queue.size );

                bid = &src->bid_queue.queue[ri];
        }
        else if(bid == NULL)
        {
                /*
                 * This shouldn't happend:  The buffer param of this
                 * source is now invalid, but we're stopping it.  This
                 * really is an ugly error: it most likely means that
                 * there's a bug in the refcounting stuff somewhere.
                 *
                 * Actually, there's an exception to this.  For queued
                 * sources, there will most likely be no buffer queued
                 * at the end of the run.  So we have to special case
                 * that.
                 */
                _alDebug(ALD_MIXER, __FILE__, __LINE__,
                      "_alDestroyMixSource: no bid for source id %d",
                      src->sid);

                _alUnlockSource( cid, sid );

                _alDCSetError( AL_INVALID_OPERATION );

                return;
        }

        _alBidRemoveCurrentRef(*bid, src->sid);

        if(src->bid_queue.size != 1)
        {
                /*
                 * This is the last entry in the queue (or the source
                 * was stopped) so we want to change the current state
                 * for this bid/sid to queue.
                 */
                _alBidAddQueueRef(*bid, src->sid);
        }

        /*
         * if we have a callback buffer, call the
         * destructor on the source (because the source
         * is over.
         */
        if(_alBidIsCallback(*bid) == AL_TRUE)
        {
                _alBidCallDestroyCallbackSource(src->sid);
        }

        /* streaming sources */
        if(_alBidIsStreaming(*bid) == AL_TRUE)
        {
                for(i = 0; i < sbufs.size; i++)
                {
                        if(sbufs.streaming_buffers[i] == *bid)
                        {
                                sbufs.streaming_buffers[i] = 0;
                                sbufs.items--;
                        }
                }
        }

        /*
         * reset read index
         * according to spec, a STOPPED source should
         * have all of its buffers processed, so read_index
         * should be the size of the queue.
         *
         * Hmmm, this is tricky, because many setter functions work of the
         * assumptions that read_index points to something valid!  Okay, we're
         * making the queue sourcestate getter ( used to access a lot of
         * stuff ) return NULL, or assert or whatever, should catch these
         * quick.
         */
        src->bid_queue.read_index = src->bid_queue.size;

        _alUnlockSource( cid, sid );

        return;
}

/*
 * _alInitMixer( void )
 *
 * Create and initialize data structures needed by the mixing function.
 */
ALboolean _alInitMixer( void )
{
        bufsiz = _alcDCGetWriteBufsiz();

        mix_mutex = _alCreateMutex();
        if(mix_mutex == NULL)
        {
                return AL_FALSE;
        }

        pause_mutex = _alCreateMutex();
        if(pause_mutex == NULL)
        {
                _alDestroyMutex( mix_mutex );
                mix_mutex = NULL;

                return AL_FALSE;
        }

        /* init Mixer funcs */
        if( _alMixFuncInit(&MixFunc, MAXMIXSOURCES ) == AL_FALSE)
        {
                _alDestroyMutex( mix_mutex );
                _alDestroyMutex( pause_mutex );
                mix_mutex = NULL;
                pause_mutex = NULL;

                return AL_FALSE;
        }

        /* init MixManager */
        if(_alMixManagerInit(&MixManager, MAXMIXSOURCES) == AL_FALSE)
        {
                _alDestroyMutex(mix_mutex);
                _alDestroyMutex(pause_mutex);
                mix_mutex = NULL;
                pause_mutex = NULL;

                _alMixFuncDestroy( &MixFunc );

                return AL_FALSE;
        }

        mspool.size = 0;

        return AL_TRUE;
}

/*
 * _alSetMixer( ALboolean synchronous )
 *
 * Sets mixer to match the current context.  If synchronous is AL_FALSE, a
 * seperate thread is launched.
 *
 * assumes locked context
 */
void _alSetMixer( ALboolean synchronous )
{
        AL_context *dc;
        ALuint ex_format;
        ALuint ex_speed;

        dc =  _alcDCGetContext();
        if(dc == NULL) {
                _alDebug(ALD_MIXER, __FILE__, __LINE__,
                        "_alSetMixer with no default context?  weird");
                return;
        }

        if ( dc->write_device ) {
                ex_format   = _alcDCGetWriteFormat();
                ex_speed    = _alcDCGetWriteSpeed();
                bufsiz      = _alcDCGetWriteBufsiz();
        } else {
                ex_format   = _alcDCGetReadFormat();
                ex_speed    = _alcDCGetReadSpeed();
                bufsiz      = _alcDCGetReadBufsiz();
        }

        _alDebug(ALD_CONVERT, __FILE__, __LINE__,
                "_alSetMixer f|c|s [0x%x|%d|%d] -> [0x%x|%d|%d]",
                /* from */
                canon_format,
                _alGetChannelsFromFormat( ex_format ), /* ignore channel settings.  We handle this */
                canon_speed,
                /* to */
                ex_format,
                _alGetChannelsFromFormat( ex_format ),
                ex_speed);

        if(acBuildAudioCVT(&s16le,
                /* from */
                _al_AL2ACFMT( canon_format ),
                _alGetChannelsFromFormat( ex_format ), /* ignore channel settings.  We handle this */
                canon_speed,

                /* to */
                _al_AL2ACFMT(ex_format),
                _alGetChannelsFromFormat(ex_format),/* ignore channel settings.  We handle this */
                ex_speed) < 0)
        {
                _alDebug(ALD_CONVERT, __FILE__, __LINE__,
                        "Couldn't build audio convertion data structure.");
        }

        if( s16le.len_mult > 1.0 )
        {
                /*
                 * we always alloc the larger value, because
                 * we need the extra space
                 */
                mixbuf.length = bufsiz * s16le.len_mult;
        } else {
                mixbuf.length = bufsiz;
        }

        free(mixbuf.data);
        mixbuf.data = malloc(mixbuf.length);
        assert(mixbuf.data);

        s16le.buf     = mixbuf.data;
        s16le.len     = bufsiz;

        if(synchronous == AL_TRUE) {
                mixer_iterate = sync_mixer_iterate;
        } else {
            mixer_iterate = async_mixer_iterate;
#ifndef USE_BACKEND_NATIVE_DARWIN
/*Since the new darwin backend uses a core audio thread, we don't need the mixing thread anymore and use the sync mixer */
                if(mixthread == NULL) {
                        mixthread = _alCreateThread(mixer_iterate);
                }
#endif
        }

        return;
}

/*
 * _alAllocMixSource( ALuint sid )
 *
 * Reserve an _alMixSource, associate it with the source named sid.  Returns
 * AL_TRUE if reservation was true, AL_FALSE if sid is invalid or allocation
 * was not possible.
 *
 * If sid is not a valid source, AL_INVALID_NAME is set.
 *
 * Assumes locked context
 */
static ALboolean _alAllocMixSource( ALuint sid )
{
        AL_source *src;
        ALuint *bid;
        _alMixSource *msrc;
        ALuint context_id = _alcCCId; /* current context id */
        int msindex;

        src = _alGetSource( context_id, sid );
        if( src == NULL ) {
                _alDebug(ALD_SOURCE, __FILE__, __LINE__,
                      "_alAllocMixSource: source id %d is not valid", sid);

                _alSetError( context_id, AL_INVALID_NAME );

                return AL_FALSE;
        }

        /*
         *  Make sure that the source isn't already playing.
         */
        if( src->state == AL_PLAYING ) {
                /*
                 * The source in question is already playing.
                 *
                 * Legal NOP
                 */
                _alDebug(ALD_MIXER, __FILE__, __LINE__,
                        "_alAllocMixSource: source id %d already playing", sid);

                return AL_FALSE;
        }

        if ( src->state == AL_STOPPED ) {
                /*
                 *  The source in question has been stopped.  Promote to
                 *  initial and play.
                 */

                src->srcParams.soundpos = 0;
                src->bid_queue.read_index = 0;
                src->state = AL_INITIAL;
        }

        /*
         *  Add reference for buffer
         */
        _alLockBuffer();

        bid = _alGetSourceParam( src, AL_BUFFER );
        if(bid == NULL) {
                _alUnlockBuffer();

                /*
                 * The source in question does not have the BUFFER
                 * attribute set.
                 */
                _alDebug(ALD_MIXER, __FILE__, __LINE__,
                        "_alAllocMixSource: source id %d has BUFFER unset",sid);

                _alSetError(context_id, AL_INVALID_OPERATION);

                return AL_FALSE;
        }

        if( _alIsBuffer(*bid) == AL_FALSE ) {
                /*
                 * The source in question has a buffer id, but it is not
                 * valid.
                 */
                _alUnlockBuffer();

                _alDebug(ALD_MIXER, __FILE__, __LINE__,
                        "_alAllocMixSource: source %d has invalid BUFFER %d:%d",
                        sid, src->bid_queue.read_index, *bid);

                _alSetError(context_id, AL_INVALID_NAME);

                return AL_FALSE;
        }

        _alUnlockBuffer();

        /* streaming buffers added to increment list */
        if( _alBidIsStreaming(*bid) == AL_TRUE ) {
                _alAddBufferToStreamingList(*bid);
        }

        if( src->bid_queue.read_index < src->bid_queue.size - 1 )
        {
                _alBidRemoveQueueRef(*bid, sid);
        }

        _alBidAddCurrentRef(*bid,  sid);

        /*
         *  Allocate space.
         */
        msindex = _alMixPoolAlloc( &mspool );
        if(msindex == -1) {
                return AL_FALSE;
        }

        /*
         *  Initialization mojo.
         *
         *  set sid to source's id, flags to ALM_PLAY_ME, and
         *  set the source's flags so that we know it's playing,
         *  and reset soundpos.
         */
        msrc = _alMixPoolIndex( &mspool, msindex );

        /* set mixsource information */
        msrc->context_id    = context_id;
        msrc->sid           = sid;
        msrc->flags         = ALM_PLAY_ME;

        /* set source information */
        if(src->state != AL_PAUSED)
        {
                src->srcParams.soundpos = 0;
                src->bid_queue.read_index     = 0;
        }

        src->state                    = AL_PLAYING;

        return AL_TRUE;
}

/*
 * _alRemoveSourceFromMixer( ALuint sid )
 *
 * Removes the source named sid from the mixer queue.
 */
ALboolean _alRemoveSourceFromMixer( ALuint sid ) {
        AL_source *src;
        ALuint i;

        src = _alDCGetSource( sid );
        if(src == NULL) {
                _alDebug( ALD_MIXER, __FILE__, __LINE__,
                          "_alRemoveSourceFromMixer: %d is an invalid source id",
                          sid );

                _alDCSetError( AL_INVALID_NAME );

                return AL_FALSE;
        }

        /*
         *      We are stopping now.    Which means we set the state:
         *
         *      active  -> stopped
         *      paused  -> stopped
         *      initial -> NOP
         *      stopped -> NOP
         *
         */
        switch(src->state) {
                case AL_INITIAL:
                case AL_STOPPED:
                        /* Stop on a non active source is a legal NOP */
                        _alDebug( ALD_MIXER, __FILE__, __LINE__,
                                  "_alRemoveSourceFromMixer(%d): source is not playing",
                                  sid );

                        return AL_FALSE;
                        break;
                default:
                        /* We're okay, otherwise */
                        break;
        }

        for(i = 0; i < mspool.size; i++) {
                if((mspool.pool[i].data.sid == sid) &&
                         (mspool.pool[i].inuse == AL_TRUE)) {
                        _alMixPoolDealloc( &mspool, i, _alDestroyMixSource );

                        _alDebug( ALD_MIXER, __FILE__, __LINE__,
                                        "_alRemoveSourceFromMixer: removed sid %d",
                                        sid );

                        return AL_TRUE;
                }
        }

        /*
         * We really shouldn't end up here.  It means that the ->flags
         * attribute got weird somewhere.
         */
        _alDebug(ALD_MIXER, __FILE__, __LINE__,
                "_alRemoveSourceFromMixer(%d): Could not remove source",
                sid);

        return AL_FALSE;
}

/*
 * _alAddSourceToMixer( ALuint sid )
 *
 * Adds the source named sid to the mixing queue.  Sets AL_INVALID_NAME if sid
 * is invalid.
 *
 * assumes that context is locked
 * assumes that mixbuf is locked
 */
void _alAddSourceToMixer( ALuint sid )
{
        AL_source *src;

        src = _alDCGetSource( sid );
        if(src == NULL) {
                /* invalid name */
                _alDebug( ALD_MIXER, __FILE__, __LINE__,
                          "_alAddSourceToMixer: source id %d is not valid",
                          sid );

                _alDCSetError( AL_INVALID_NAME );
                return;
        }

        /*
         * Now, we are going to set the state:
         *
         * initial -> active
         * paused  -> active
         * stopped -> active
         * active  -> active, but reset
         *
         * Paused sources are already in the mixer, but being
         * ignored, so we just "turn them on." initial and stopped
         * sources need to have new mixsources alloced for them.
         */
        switch(src->state) {
                case AL_PAUSED:
                        /* Paused sources, when played again, resume
                         * at their old location.  We don't need to
                         * alloc a new mixsource.
                         */
                        src->state = AL_PLAYING;
                        return;
                case AL_PLAYING:
                        /* This source is already playing.
                         *
                         * No state change, but reset.
                         */
                        src->srcParams.soundpos = 0;

                        return;
                default:
                        /* alloc a mix source */
                        break;
        }

        if(_alAllocMixSource( sid ) == AL_FALSE) {
                /* most likely, the buffer associated with the
                 * source in question has been deleted.  Return
                 * asap.
                 *
                 * We shouldn't set the error because _alAllocMixSource
                 * will actually be better aware of what the problem is,
                 * and so will set the error accordingly.
                 */
                _alDebug( ALD_MIXER, __FILE__, __LINE__,
                           "_alAddSourceToMixer: Could not add source sid %d",
                          sid );

                return;
        }

        _alDebug(ALD_MIXER, __FILE__, __LINE__,
                "_alAddSourceToMixer: added sid %d", sid);

        return;
}

/*
 * FL_alLockMixBuf(UNUSED(const char *fn), UNUSED(int ln))
 *
 * Locks the mutex guarding mixer data structures.
 */
void FL_alLockMixBuf( UNUSED(const char *fn), UNUSED(int ln) ) {
        _alLockPrintf("_alLockMixbuf", fn, ln);

        _alLockMutex( mix_mutex );

        return;
}

/*
 * FL_alUnlockMixBuf(UNUSED(const char *fn), UNUSED(int ln))
 *
 * Unlocks the mutex guarding mixer data structures.
 */
void FL_alUnlockMixBuf(UNUSED(const char *fn), UNUSED(int ln)) {
        _alLockPrintf("_alUnlockMixbuf", fn, ln);

        _alUnlockMutex( mix_mutex );

        return;
}

/*
 * async_mixer_iterate(UNUSED(void *dummy))
 *
 * threaded version of top level mixing function.  Doesn't end until the last
 * context is deleted.
 */
int async_mixer_iterate(UNUSED(void *dummy)) {
        ALuint bytes_to_write = 0;

        /* clear buffer */
        memset(mixbuf.data, 0, mixbuf.length);

        do {
                if(_alTryLockMixerPause() == AL_TRUE)
                {
                        _alLockMixBuf();

                        _alMixSources();

                        _alProcessFlags();

                        _alUnlockMixBuf();

                        /* we've accumulated sources, now mix */
                        _alMixManagerMix( &MixManager, &MixFunc, mixbuf.data );

                        if(acConvertAudio(&s16le) < 0)
                        {
                                _alDebug(ALD_MAXIMUS, __FILE__, __LINE__,
                                "Couldn't execute conversion from canon.");
                                /*
                                 * most likely we're just early.
                                 * Don't sweat it.
                                 */
                                continue;
                        }

                        bytes_to_write = s16le.len_cvt;

                        if(bytes_to_write)
                        {
                                _alcDCDeviceWrite(mixbuf.data, bytes_to_write);
                        }

                        /* clear buffer */
                        memset(mixbuf.data, 0, mixbuf.length);

                        _alUnlockMixerPause();
                }
                /* give other threads a chance to acquire the mixer lock */
                _alMicroSleep(1);
        } while(time_for_mixer_to_die == AL_FALSE);

        time_for_mixer_to_die = AL_FALSE;

        _alExitThread();
#ifndef HAVE___ATTRIBUTE__
        return 0;
#endif
}

/*
 * _alAddBufferToStreamingList( ALuint bid )
 *
 * Adds a buffer name to the streaming list, for special handling.
 *
 *  FIXME: need to free sbufs.stremaing_buffers on exit.
 */
static void _alAddBufferToStreamingList( ALuint bid ) {
        void *temp;
        int offset;
        ALuint newsize;
        ALuint i;

        if(sbufs.items >= sbufs.size) {
                /* realloc */
                newsize = sbufs.size + 1;

                temp = realloc(sbufs.streaming_buffers,
                                newsize * sizeof *sbufs.streaming_buffers);
                if(temp == NULL) {
                        /* what a bummer */
                        return;
                }
                sbufs.streaming_buffers = temp;

                for(i = sbufs.size; i < newsize; i++) {
                        sbufs.streaming_buffers[i] = 0;
                }

                sbufs.size = newsize;
        }

        /* add bid to streaming list */
        for(i = 0, offset = sbufs.items; i < sbufs.size; i++) {
                offset = (offset + 1) % sbufs.size;

                if(sbufs.streaming_buffers[offset] == 0) {
                        sbufs.streaming_buffers[offset] = bid;

                        sbufs.items++;

                        return;
                }
        }

        return;
}

/*
 * _alTryLockMixerPause( void )
 *
 * The function that alcMakeContextCurrent calls to pause
 * asynchronous mixers.  Return AL_TRUE if the pause mutex was locked,
 * AL_FALSE otherwise.
 */
static ALboolean _alTryLockMixerPause( void ) {
        if(_alTryLockMutex( pause_mutex ) == 0) {
                return AL_TRUE;
        }

        return AL_FALSE;
}

/*
 * _alLockMixerPause( void )
 *
 * The function that alcMakeContextCurrent calls to pause
 * asynchronous mixers
 */
void _alLockMixerPause( void ) {
        _alLockMutex( pause_mutex );

        return;
}

/*
 * _alUnlockMixerPause( void )
 *
 * The function that alcMakeContextCurrent calls to resume
 * asynchronous mixers
 */
void _alUnlockMixerPause( void ) {
        _alUnlockMutex( pause_mutex );

        return;
}


/*
 * _alProcessFlags( void )
 *
 * The mixing function (_alMixSources), in the course of its job marks the
 * mixsource nodes with commands that need to be executed after the completion
 * of the mixsource's iteration through the loop.  This is the function where
 * such things are done.
 *
 * Also, we process streaming buffers here because they need to be visited
 * once per call to _alMixSources, but the presence of multiple sources
 * refering to the same buffer precludes us from doing the processing in
 * _alMixSources.
 *
 * assumes locked mixbuf
 */
void _alProcessFlags( void ) {
        _alMixSource *itr = NULL;
        AL_buffer *bitr; /* buffer iterator */
        ALuint i;
        ALuint k;

        for(i = 0; i < mspool.size; i++) {
                if(mspool.pool[i].inuse == AL_FALSE) {
                        /* skip mixsources not in use */
                        continue;
                }

                itr = _alMixPoolIndex(&mspool, i);
                if(itr == NULL)
                {
                        /* shouldn't happen */
                        continue;
                }

                if(itr->flags & ALM_DESTROY_ME)
                {
                        /* this source associated with this mixsource
                         * has expired (either because it has been stopped
                         * or just run out.  Remove it.
                         */
                        if( alIsSource(itr->sid) == AL_FALSE )
                        {
                                /* sanity check */
                                continue;
                        }

                        /* deallocated mixsource */
                        _alMixPoolDealloc( &mspool, i, _alDestroyMixSource );
                }
        }

        _alLockBuffer();

        /* process streaming buffers */
        i = sbufs.items;
        k = sbufs.size - 1;

        while(i--) {
                int nc;

                while(sbufs.streaming_buffers[k] == 0) {
                        /*
                         * We don't worry about underflow because
                         * we are keying off of the number of sbuf
                         * items.
                         */
                        k--;
                }

                bitr = _alGetBuffer(sbufs.streaming_buffers[k]);
                if(bitr == NULL) {
                        _alDebug(ALD_STREAMING, __FILE__, __LINE__,
                                "invalid buffer id %d",
                                sbufs.streaming_buffers[k]);

                        /* invalid buffer
                         *
                         * Most likely, the buffer got deleted at some
                         * point.  We remove here, decrement the items
                         * count and get on with life.
                         */
                        sbufs.streaming_buffers[k] = 0;
                        sbufs.items--;

                        continue;
                }

                /* get the buffer's number of channels, so multichannel
                 * streaming sounds work properly.
                 */
                nc = _alcDCGetNumSpeakers();

                if(nc <= 0) {
                        nc = 1;
                }

                if(_alGetBufferState(bitr) == AL_UNUSED) {
                        /* refcount 0?  Don't bother. */
                        sbufs.streaming_buffers[k] = 0;
                        sbufs.items--;

                        continue;
                }

                bitr->streampos += bufsiz/nc;

                if(bitr->streampos >= bitr->size) {
                        if(bitr->flags & ALB_STREAMING_WRAP) {
                                /* If we have the wrap flag, wrap.
                                 * Otherwise, what?  End the source?
                                 * Loop forever?
                                 */

                                _alDebug(ALD_STREAMING, __FILE__, __LINE__,
                                        "Wrapping\n");

                                bitr->streampos = 0;
                                bitr->flags &= ~ALB_STREAMING_WRAP;
                        }
                }
        }

        _alUnlockBuffer();

        return;
}

/*
 * sync_mixer_iterate(UNUSED(void *dummy))
 *
 * non-threaded version of top level mixing function.  Called many times.
 */
int sync_mixer_iterate(UNUSED(void *dummy))
{
        ALshort *dataptr = mixbuf.data;
        int bytes_to_write = 0;

        /* clear buffer */
        if(dataptr)
        {
                memset( dataptr, 0, bufsiz );
        }

        _alLockMixBuf();
        _alMixSources();
        _alProcessFlags();
        _alUnlockMixBuf();

        /* we've accumulated sources, now mix */
        _alMixManagerMix(&MixManager, &MixFunc, mixbuf.data);

        if(acConvertAudio(&s16le) < 0)
        {
                _alDebug(ALD_CONVERT, __FILE__, __LINE__,
                        "Couldn't execute conversion from canon.");
                return -1;
        }

        bytes_to_write = s16le.len_cvt;

        if(dataptr)
        {
                _alcDCDeviceWrite( dataptr, bytes_to_write );
        }

        return 0;
}