Класс AudioTrackS16

Граф наследования:AudioTrackS16:

Граф связей класса AudioTrackS16:

Открытые члены
	AudioTrackS16 ()
virtual	~AudioTrackS16 ()
virtual bool	Open (PAudioDataSource data_source)
virtual bool	IsValid ()
virtual bool	Play ()
virtual bool	Stop ()
virtual bool	Pause ()
virtual bool	Resume ()
virtual bool	SetVolume (float volume)
virtual float	GetVolume ()
Открытые члены унаследованные от IAudioTrack
	IAudioTrack ()
virtual	~IAudioTrack ()

Защищенные члены
void	Close ()
void	DrainBuffers ()
void	Update ()

Защищенные данные
PAudioDataSource	pDataSource
CallBackTimer	updater
ALenum	al_format
ALuint	al_source
ALsizei	al_sample_rate
size_t	uiReservedData
size_t	uiReservedDataMinimum

Подробное описание

См. определение в файле OpenALSoundProvider.cpp строка 428

Конструктор(ы)

AudioTrackS16()

AudioTrackS16::AudioTrackS16

(

)

См. определение в файле OpenALSoundProvider.cpp строка 457

                             {
    al_format = AL_FORMAT_STEREO16;
    al_source = -1;
    al_sample_rate = 0;
    uiReservedData = 0;
    uiReservedDataMinimum = 0;
}

Перекрестные ссылки al_format, al_sample_rate, al_source, uiReservedData и uiReservedDataMinimum.

~AudioTrackS16()

AudioTrackS16::~AudioTrackS16 ( )

virtual

См. определение в файле OpenALSoundProvider.cpp строка 465

{ Close(); }

Перекрестные ссылки Close().

Граф вызовов:

Методы

Open()

bool AudioTrackS16::Open ( PAudioDataSource  data_source )

virtual

Замещает IAudioTrack.

См. определение в файле OpenALSoundProvider.cpp строка 467

                                                     {
    pDataSource = data_source;
    if (!pDataSource) {
        return false;
    }
 
    if (!pDataSource->Open()) {
        return false;
    }
 
    alGenSources((ALuint)1, &al_source);
    if (CheckError()) {
        return false;
    }
 
    alSourcei(al_source, AL_LOOPING, AL_FALSE);
    alSourcef(al_source, AL_PITCH, 1.f);
    alSourcef(al_source, AL_GAIN, 1.f);
    alSourcei(al_source, AL_SOURCE_RELATIVE, AL_TRUE);
    alSource3f(al_source, AL_POSITION, 0.f, 0.f, 0.f);
    alSource3f(al_source, AL_VELOCITY, 0.f, 0.f, 0.f);
 
    al_sample_rate = pDataSource->GetSampleRate();
 
    uiReservedData = 0;
    uiReservedDataMinimum = 1000 * (al_sample_rate / 1000) * 4;
 
    return true;
}

Перекрестные ссылки al_sample_rate, al_source, alGenSources(), alSource3f(), alSourcef(), alSourcei(), CheckError(), pDataSource, uiReservedData и uiReservedDataMinimum.

Граф вызовов:

IsValid()

bool AudioTrackS16::IsValid ( )

virtual

Замещает IAudioTrack.

См. определение в файле OpenALSoundProvider.cpp строка 497

{ return (alIsSource(al_source) != 0); }

Перекрестные ссылки al_source и alIsSource().

Используется в GetVolume(), Pause(), Play(), SetVolume() и Stop().

Граф вызовов:

Граф вызова функции:

Play()

bool AudioTrackS16::Play ( )

virtual

Замещает IAudioTrack.

См. определение в файле OpenALSoundProvider.cpp строка 499

                         {
    if (!IsValid()) {
        return false;
    }
 
    ALint status;
    alGetSourcei(al_source, AL_SOURCE_STATE, &status);
    if (status == AL_PLAYING) {
        return true;
    }
 
    Update();
 
    alSourcePlay(al_source);
    if (CheckError()) {
        return false;
    }
 
    updater.Start(10, [this]() { Update(); });
 
    return true;
}

Перекрестные ссылки al_source, alGetSourcei(), alSourcePlay(), CheckError(), IsValid(), CallBackTimer::Start(), Update() и updater.

Используется в Resume().

Граф вызовов:

Граф вызова функции:

Stop()

bool AudioTrackS16::Stop ( )

virtual

Замещает IAudioTrack.

См. определение в файле OpenALSoundProvider.cpp строка 522

                         {
    if (!IsValid()) {
        return false;
    }
 
    Close();
 
    return true;
}

Перекрестные ссылки Close() и IsValid().

Граф вызовов:

Pause()

bool AudioTrackS16::Pause ( )

virtual

Замещает IAudioTrack.

См. определение в файле OpenALSoundProvider.cpp строка 532

                          {
    if (!IsValid()) {
        return false;
    }
 
    alSourcePause(al_source);
    if (CheckError()) {
        return false;
    }
 
    updater.Stop();
 
    return true;
}

Перекрестные ссылки al_source, alSourcePause(), CheckError(), IsValid(), CallBackTimer::Stop() и updater.

Граф вызовов:

Resume()

bool AudioTrackS16::Resume ( )

virtual

Замещает IAudioTrack.

См. определение в файле OpenALSoundProvider.cpp строка 547

{ return Play(); }

Перекрестные ссылки Play().

Граф вызовов:

SetVolume()

bool AudioTrackS16::SetVolume ( float  volume )

virtual

Замещает IAudioTrack.

См. определение в файле OpenALSoundProvider.cpp строка 549

                                          {
    if (!IsValid()) {
        return false;
    }
 
    alSourcef(al_source, AL_GAIN, volume);
    if (CheckError()) {
        return false;
    }
 
    return true;
}

Перекрестные ссылки al_source, alSourcef(), CheckError() и IsValid().

Граф вызовов:

GetVolume()

float AudioTrackS16::GetVolume ( )

virtual

Замещает IAudioTrack.

См. определение в файле OpenALSoundProvider.cpp строка 562

                               {
    if (!IsValid()) {
        return 0.f;
    }
 
    ALfloat volume = 0.f;
    alGetSourcef(al_source, AL_GAIN, &volume);
    if (CheckError()) {
        volume = 0.f;
    }
    return volume;
}

Перекрестные ссылки al_source, alGetSourcef(), CheckError() и IsValid().

Граф вызовов:

Close()

void AudioTrackS16::Close ( )

protected

См. определение в файле OpenALSoundProvider.cpp строка 575

                          {
    updater.Stop();
    if (pDataSource) {
        pDataSource->Close();
    }
 
    if (alIsSource(al_source) != 0) {
        alSourceStop(al_source);
        CheckError();
        alDeleteSources(1, &al_source);
        CheckError();
    }
 
    al_source = -1;
    al_sample_rate = 0;
    uiReservedData = 0;
    uiReservedDataMinimum = 0;
}

Перекрестные ссылки al_sample_rate, al_source, alDeleteSources(), alIsSource(), alSourceStop(), CheckError(), pDataSource, CallBackTimer::Stop(), uiReservedData, uiReservedDataMinimum и updater.

Используется в Stop(), Update() и ~AudioTrackS16().

Граф вызовов:

Граф вызова функции:

DrainBuffers()

void AudioTrackS16::DrainBuffers ( )

protected

См. определение в файле OpenALSoundProvider.cpp строка 594

                                 {
    ALint num_processed_buffers = 0;
    alGetSourcei(al_source, AL_BUFFERS_PROCESSED, &num_processed_buffers);
    if (num_processed_buffers <= 0) {
        return;
    }
 
    ALuint *processed_buffer_ids = new ALuint[num_processed_buffers];
    if (CheckError()) {
        log("OpenAL: Faile to get played buffers.");
    } else {
        for (ALint i = 0; i < num_processed_buffers; i++) {
            ALuint buffer = processed_buffer_ids[i];
            alSourceUnqueueBuffers(al_source, 1, &buffer);
            if (CheckError()) {
                log("OpenAL: Faile to unqueue played buffer.");
            } else {
                ALint size = 0;
                alGetBufferi(buffer, AL_SIZE, &size);
                uiReservedData -= size;
                alDeleteBuffers(1, &buffer);
                if (CheckError()) {
                    log("OpenAL: Faile to delete played buffer.");
                }
            }
        }
    }
    delete[] processed_buffer_ids;
}

Перекрестные ссылки al_source, alDeleteBuffers(), alGetBufferi(), alGetSourcei(), alSourceUnqueueBuffers(), CheckError(), log() и uiReservedData.

Используется в Update().

Граф вызовов:

Граф вызова функции:

Update()

void AudioTrackS16::Update ( )

protected

См. определение в файле OpenALSoundProvider.cpp строка 624

                           {
    DrainBuffers();
 
    while (uiReservedData < uiReservedDataMinimum) {
        PMemBuffer buffer = pDataSource->GetNextBuffer();
 
        if (!buffer) {
            return;
        }
 
        ALuint al_buffer = -1;
        alGenBuffers(1, &al_buffer);
        if (CheckError()) {
            Close();
            return;
        }
 
        alBufferData(al_buffer, al_format, buffer->GetData(), buffer->GetSize(), al_sample_rate);
        if (CheckError()) {
            Close();
            return;
        }
 
        alSourceQueueBuffers(al_source, 1, &al_buffer);
        if (CheckError()) {
            Close();
            return;
        }
 
        uiReservedData += buffer->GetSize();
    }
}

Перекрестные ссылки al_format, al_sample_rate, al_source, alBufferData(), alGenBuffers(), alSourceQueueBuffers(), CheckError(), Close(), DrainBuffers(), pDataSource, uiReservedData и uiReservedDataMinimum.

Используется в Play().

Граф вызовов:

Граф вызова функции:

Данные класса

pDataSource

PAudioDataSource AudioTrackS16::pDataSource

protected

См. определение в файле OpenALSoundProvider.cpp строка 448

Используется в Close(), Open() и Update().

updater

CallBackTimer AudioTrackS16::updater

protected

См. определение в файле OpenALSoundProvider.cpp строка 449

Используется в Close(), Pause() и Play().

al_format

ALenum AudioTrackS16::al_format

protected

См. определение в файле OpenALSoundProvider.cpp строка 450

Используется в AudioTrackS16() и Update().

al_source

ALuint AudioTrackS16::al_source

protected

См. определение в файле OpenALSoundProvider.cpp строка 451

Используется в AudioTrackS16(), Close(), DrainBuffers(), GetVolume(), IsValid(), Open(), Pause(), Play(), SetVolume() и Update().

al_sample_rate

ALsizei AudioTrackS16::al_sample_rate

protected

См. определение в файле OpenALSoundProvider.cpp строка 452

Используется в AudioTrackS16(), Close(), Open() и Update().

uiReservedData

size_t AudioTrackS16::uiReservedData

protected

См. определение в файле OpenALSoundProvider.cpp строка 453

Используется в AudioTrackS16(), Close(), DrainBuffers(), Open() и Update().

uiReservedDataMinimum

size_t AudioTrackS16::uiReservedDataMinimum

protected

См. определение в файле OpenALSoundProvider.cpp строка 454

Используется в AudioTrackS16(), Close(), Open() и Update().

---

Объявления и описания членов класса находятся в файле:

• C:/git/world-of-might-and-magic/Media/Audio/OpenALSoundProvider.cpp