2007-04-22 03:23:25 +02:00
|
|
|
// Copyright (c) 2005-2007, Rodrigo Braz Monteiro
|
2006-02-25 07:04:46 +01:00
|
|
|
// All rights reserved.
|
|
|
|
//
|
|
|
|
// Redistribution and use in source and binary forms, with or without
|
|
|
|
// modification, are permitted provided that the following conditions are met:
|
|
|
|
//
|
|
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
|
|
// this list of conditions and the following disclaimer.
|
|
|
|
// * Redistributions in binary form must reproduce the above copyright notice,
|
|
|
|
// this list of conditions and the following disclaimer in the documentation
|
|
|
|
// and/or other materials provided with the distribution.
|
|
|
|
// * Neither the name of the Aegisub Group nor the names of its contributors
|
|
|
|
// may be used to endorse or promote products derived from this software
|
|
|
|
// without specific prior written permission.
|
|
|
|
//
|
|
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
//
|
2009-07-29 07:43:02 +02:00
|
|
|
// Aegisub Project http://www.aegisub.org/
|
2006-02-25 07:04:46 +01:00
|
|
|
//
|
2011-11-28 21:01:46 +01:00
|
|
|
// $Id: audio_player_portaudio.cpp 5897 2011-11-20 03:43:52Z plorkyeran $
|
2009-07-29 07:43:02 +02:00
|
|
|
|
|
|
|
/// @file audio_player_portaudio.cpp
|
|
|
|
/// @brief PortAudio v18-based audio output
|
|
|
|
/// @ingroup audio_output
|
|
|
|
///
|
2006-02-25 07:04:46 +01:00
|
|
|
|
|
|
|
|
2009-01-04 07:31:48 +01:00
|
|
|
#include "config.h"
|
|
|
|
|
2008-01-21 21:57:20 +01:00
|
|
|
#ifdef WITH_PORTAUDIO
|
|
|
|
|
2010-06-09 01:21:39 +02:00
|
|
|
#include <libaegisub/log.h>
|
|
|
|
|
2008-03-05 03:43:01 +01:00
|
|
|
#include "audio_player_portaudio.h"
|
2009-09-10 12:51:49 +02:00
|
|
|
#include "charset_conv.h"
|
2011-11-28 21:01:58 +01:00
|
|
|
#include "include/aegisub/audio_provider.h"
|
2010-05-21 03:13:36 +02:00
|
|
|
#include "main.h"
|
2006-02-25 07:04:46 +01:00
|
|
|
#include "utils.h"
|
2007-04-22 03:23:25 +02:00
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
// Uncomment to enable extremely spammy debug logging
|
2009-06-10 06:45:57 +02:00
|
|
|
//#define PORTAUDIO_DEBUG
|
2007-04-22 03:23:25 +02:00
|
|
|
|
2009-08-25 07:31:20 +02:00
|
|
|
// Init reference counter
|
|
|
|
int PortAudioPlayer::pa_refcount = 0;
|
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
|
|
|
|
2006-02-25 07:04:46 +01:00
|
|
|
PortAudioPlayer::PortAudioPlayer() {
|
|
|
|
// Initialize portaudio
|
|
|
|
if (!pa_refcount) {
|
|
|
|
PaError err = Pa_Initialize();
|
2009-06-10 06:45:57 +02:00
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
if (err != paNoError)
|
|
|
|
throw PortAudioError(std::string("Failed opening PortAudio:") + Pa_GetErrorText(err));
|
2006-02-25 07:04:46 +01:00
|
|
|
pa_refcount++;
|
|
|
|
}
|
|
|
|
|
|
|
|
volume = 1.0f;
|
2011-11-28 21:01:46 +01:00
|
|
|
pa_start = 0.0;
|
2006-02-25 07:04:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
PortAudioPlayer::~PortAudioPlayer() {
|
|
|
|
// Deinit portaudio
|
|
|
|
if (!--pa_refcount) Pa_Terminate();
|
|
|
|
}
|
|
|
|
|
2009-06-10 06:45:57 +02:00
|
|
|
void PortAudioPlayer::OpenStream() {
|
2011-11-28 21:01:58 +01:00
|
|
|
PaDeviceIndex pa_device = paNoDevice;
|
|
|
|
|
|
|
|
std::string device_name = OPT_GET("Player/Audio/PortAudio/Device Name")->GetString();
|
|
|
|
|
|
|
|
if (device_name.size() && device_name != "Default") {
|
|
|
|
int devices = Pa_GetDeviceCount();
|
|
|
|
for (int i = 0; i < devices; i++) {
|
|
|
|
const PaDeviceInfo *info = Pa_GetDeviceInfo(i);
|
|
|
|
if (info->maxOutputChannels > 0 && info->name == device_name) {
|
|
|
|
pa_device = i;
|
|
|
|
LOG_D("audio/player/portaudio") << "using config device: " << device_name << ": " << pa_device;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
2009-06-10 06:45:57 +02:00
|
|
|
|
2011-11-28 21:01:58 +01:00
|
|
|
if (pa_device == paNoDevice)
|
|
|
|
LOG_D("audio/player/portaudio") << "config device " << device_name << " not found, using default";
|
|
|
|
}
|
|
|
|
|
|
|
|
if (pa_device == paNoDevice) {
|
2009-06-10 06:45:57 +02:00
|
|
|
pa_device = Pa_GetDefaultOutputDevice();
|
2011-11-28 21:01:58 +01:00
|
|
|
if (pa_device == paNoDevice)
|
|
|
|
throw PortAudioError("No PortAudio output devices found");
|
2010-06-09 01:21:39 +02:00
|
|
|
LOG_D("audio/player/portaudio") << "using default output device:" << pa_device;
|
2006-02-25 07:04:46 +01:00
|
|
|
}
|
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
PaStreamParameters pa_output_p;
|
2009-06-10 06:45:57 +02:00
|
|
|
pa_output_p.device = pa_device;
|
|
|
|
pa_output_p.channelCount = provider->GetChannels();
|
|
|
|
pa_output_p.sampleFormat = paInt16;
|
|
|
|
pa_output_p.suggestedLatency = Pa_GetDeviceInfo(pa_device)->defaultLowOutputLatency;
|
|
|
|
pa_output_p.hostApiSpecificStreamInfo = NULL;
|
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
LOG_D("audio/player/portaudio") << "OpenStream:"
|
|
|
|
<< " output channels: " << pa_output_p.channelCount
|
|
|
|
<< " latency: " << pa_output_p.suggestedLatency
|
|
|
|
<< " sample rate: " << pa_output_p.sampleFormat;
|
2009-06-10 06:45:57 +02:00
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
PaError err = Pa_OpenStream(&stream, NULL, &pa_output_p, provider->GetSampleRate(), 0, paPrimeOutputBuffersUsingStreamCallback, paCallback, this);
|
2009-06-10 06:45:57 +02:00
|
|
|
|
|
|
|
if (err != paNoError) {
|
|
|
|
const PaHostErrorInfo *pa_err = Pa_GetLastHostErrorInfo();
|
2010-06-09 01:21:39 +02:00
|
|
|
LOG_D_IF(pa_err->errorCode != 0, "audio/player/portaudio") << "HostError: API: " << pa_err->hostApiType << ", " << pa_err->errorText << ", " << pa_err->errorCode;
|
|
|
|
LOG_D("audio/player/portaudio") << "Failed initializing PortAudio stream with error: " << Pa_GetErrorText(err);
|
2011-11-28 21:01:46 +01:00
|
|
|
throw PortAudioError("Failed initializing PortAudio stream with error: " + std::string(Pa_GetErrorText(err)));
|
2006-02-25 07:04:46 +01:00
|
|
|
}
|
2009-06-10 06:45:57 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
void PortAudioPlayer::CloseStream() {
|
2009-08-21 22:08:58 +02:00
|
|
|
Stop(false);
|
|
|
|
Pa_CloseStream(stream);
|
2009-06-10 06:45:57 +02:00
|
|
|
}
|
2006-02-25 07:04:46 +01:00
|
|
|
|
2009-06-10 06:45:57 +02:00
|
|
|
void PortAudioPlayer::paStreamFinishedCallback(void *userData) {
|
2011-11-28 21:01:46 +01:00
|
|
|
PortAudioPlayer *player = (PortAudioPlayer *) userData;
|
2006-02-25 07:04:46 +01:00
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
if (player->displayTimer)
|
2009-06-10 06:45:57 +02:00
|
|
|
player->displayTimer->Stop();
|
2010-06-09 01:21:39 +02:00
|
|
|
LOG_D("audio/player/portaudio") << "stopping stream";
|
2006-02-25 07:04:46 +01:00
|
|
|
}
|
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
void PortAudioPlayer::Play(int64_t start_sample, int64_t count) {
|
|
|
|
current = start_sample;
|
|
|
|
start = start_sample;
|
|
|
|
end = start_sample + count;
|
2006-02-25 07:04:46 +01:00
|
|
|
|
|
|
|
// Start playing
|
2009-08-21 22:08:58 +02:00
|
|
|
if (!IsPlaying()) {
|
2011-11-28 21:01:46 +01:00
|
|
|
PaError err = Pa_SetStreamFinishedCallback(stream, paStreamFinishedCallback);
|
2009-06-10 06:45:57 +02:00
|
|
|
if (err != paNoError) {
|
2010-06-09 01:21:39 +02:00
|
|
|
LOG_D("audio/player/portaudio") << "could not set FinishedCallback";
|
2009-06-10 06:45:57 +02:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
err = Pa_StartStream(stream);
|
2006-02-25 07:04:46 +01:00
|
|
|
if (err != paNoError) {
|
2010-06-09 01:21:39 +02:00
|
|
|
LOG_D("audio/player/portaudio") << "error playing stream";
|
2006-02-25 07:04:46 +01:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
2011-11-28 21:01:46 +01:00
|
|
|
pa_start = Pa_GetStreamTime(stream);
|
2006-02-25 07:04:46 +01:00
|
|
|
|
|
|
|
// Update timer
|
2011-11-28 21:01:46 +01:00
|
|
|
if (displayTimer && !displayTimer->IsRunning())
|
|
|
|
displayTimer->Start(15);
|
2006-02-25 07:04:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
void PortAudioPlayer::Stop(bool timerToo) {
|
2011-11-28 21:01:46 +01:00
|
|
|
Pa_StopStream(stream);
|
2006-02-25 07:04:46 +01:00
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
if (timerToo && displayTimer)
|
2006-02-25 07:04:46 +01:00
|
|
|
displayTimer->Stop();
|
|
|
|
}
|
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
int PortAudioPlayer::paCallback(const void *inputBuffer, void *outputBuffer,
|
|
|
|
unsigned long framesPerBuffer, const PaStreamCallbackTimeInfo* timeInfo,
|
|
|
|
PaStreamCallbackFlags statusFlags, void *userData)
|
|
|
|
{
|
|
|
|
PortAudioPlayer *player = (PortAudioPlayer *)userData;
|
2009-06-10 06:45:57 +02:00
|
|
|
|
|
|
|
#ifdef PORTAUDIO_DEBUG
|
2011-11-28 21:01:46 +01:00
|
|
|
LOG_D("audio/player/portaudio") << "psCallback:"
|
|
|
|
<< " current: " << player->current
|
|
|
|
<< " start: " << player->start
|
|
|
|
<< " pa_start: " << player->pa_start
|
|
|
|
<< " currentTime: " << timeInfo->currentTime
|
|
|
|
<< " AdcTime: " << timeInfo->inputBufferAdcTime
|
|
|
|
<< " DacTime: " << timeInfo->outputBufferDacTime
|
|
|
|
<< " framesPerBuffer: " << framesPerBuffer
|
|
|
|
<< " CPU: " << Pa_GetStreamCpuLoad(player->stream);
|
2007-04-05 18:39:49 +02:00
|
|
|
#endif
|
|
|
|
|
2009-06-10 06:45:57 +02:00
|
|
|
// Calculate how much left
|
2011-11-28 21:01:46 +01:00
|
|
|
int64_t lenAvailable = std::min<int64_t>(player->end - player->current, framesPerBuffer);
|
2009-06-10 06:45:57 +02:00
|
|
|
|
|
|
|
// Play something
|
|
|
|
if (lenAvailable > 0) {
|
2011-11-28 21:01:46 +01:00
|
|
|
player->GetProvider()->GetAudioWithVolume(outputBuffer, player->current, lenAvailable, player->GetVolume());
|
2009-06-10 06:45:57 +02:00
|
|
|
|
|
|
|
// Set play position
|
2011-11-28 21:01:46 +01:00
|
|
|
player->current += lenAvailable;
|
2009-06-10 06:45:57 +02:00
|
|
|
|
|
|
|
// Continue as normal
|
|
|
|
return 0;
|
2006-02-25 09:26:29 +01:00
|
|
|
}
|
2009-06-10 06:45:57 +02:00
|
|
|
|
|
|
|
// Abort stream and stop the callback.
|
|
|
|
return paAbort;
|
2006-02-25 07:04:46 +01:00
|
|
|
}
|
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
int64_t PortAudioPlayer::GetCurrentPosition() {
|
2009-08-21 22:08:58 +02:00
|
|
|
if (!IsPlaying()) return 0;
|
2009-06-10 06:45:57 +02:00
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
PaTime pa_time = Pa_GetStreamTime(stream);
|
|
|
|
int64_t real = (pa_time - pa_start) * provider->GetSampleRate() + start;
|
2009-06-10 06:45:57 +02:00
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
// If portaudio isn't giving us time info then estimate based on buffer fill and current latency
|
|
|
|
if (pa_time == 0 && pa_start == 0)
|
|
|
|
real = current - Pa_GetStreamInfo(stream)->outputLatency * provider->GetSampleRate();
|
2009-06-10 06:45:57 +02:00
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
#ifdef PORTAUDIO_DEBUG
|
|
|
|
LOG_D("audio/player/portaudio") << "GetCurrentPosition:"
|
|
|
|
<< " pa_time: " << pa_time
|
|
|
|
<< " start: " << start
|
|
|
|
<< " current: " << current
|
|
|
|
<< " pa_start: " << pa_start
|
|
|
|
<< " real: " << real
|
|
|
|
<< " diff: " << pa_time - pa_start;
|
2009-06-10 06:45:57 +02:00
|
|
|
#endif
|
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
return real;
|
2006-02-25 07:04:46 +01:00
|
|
|
}
|
2006-12-23 15:15:04 +01:00
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
wxArrayString PortAudioPlayer::GetOutputDevices() {
|
|
|
|
PortAudioPlayer player; // temp player to ensure PA is initialized
|
2008-01-21 21:57:20 +01:00
|
|
|
|
2009-06-10 06:45:57 +02:00
|
|
|
int devices = Pa_GetDeviceCount();
|
2011-11-28 21:01:58 +01:00
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
wxArrayString list;
|
2011-11-28 21:01:58 +01:00
|
|
|
list.push_back("Default");
|
|
|
|
|
2011-11-28 21:01:46 +01:00
|
|
|
for (int i = 0; i < devices; i++) {
|
2011-11-28 21:01:58 +01:00
|
|
|
const PaDeviceInfo *info = Pa_GetDeviceInfo(i);
|
|
|
|
if (info->maxOutputChannels > 0)
|
|
|
|
list.push_back(wxString(info->name, wxConvUTF8));
|
2009-06-10 06:45:57 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
return list;
|
|
|
|
}
|
|
|
|
|
2009-08-21 22:08:58 +02:00
|
|
|
bool PortAudioPlayer::IsPlaying() {
|
2011-11-28 21:01:46 +01:00
|
|
|
return !!Pa_IsStreamActive(stream);
|
2009-08-21 22:08:58 +02:00
|
|
|
}
|
|
|
|
|
2008-01-21 21:57:20 +01:00
|
|
|
#endif // WITH_PORTAUDIO
|