Representación de una secuencia
El cliente llama a los métodos de la interfaz IAudioRenderClient para escribir datos de representación en un búfer de punto de conexión. Para una secuencia en modo compartido, el cliente comparte el búfer del punto de conexión con el motor de audio. Para una secuencia en modo exclusivo, el cliente comparte el búfer del punto de conexión con el dispositivo de audio. Para solicitar un búfer de punto de conexión de un tamaño determinado, el cliente llama al método IAudioClient::Initialize . Para obtener el tamaño del búfer asignado, que podría ser diferente del tamaño solicitado, el cliente llama al método IAudioClient::GetBufferSize .
Para mover un flujo de datos de representación a través del búfer del punto de conexión, el cliente llama alternativamente al método IAudioRenderClient::GetBuffer y al método IAudioRenderClient::ReleaseBuffer . El cliente accede a los datos del búfer del punto de conexión como una serie de paquetes de datos. La llamada GetBuffer recupera el siguiente paquete para que el cliente pueda rellenarlo con datos de representación. Después de escribir los datos en el paquete, el cliente llama a ReleaseBuffer para agregar el paquete completado a la cola de representación.
Para un búfer de representación, el valor de relleno notificado por el método IAudioClient::GetCurrentPadding representa la cantidad de datos de representación que se ponen en cola para reproducir en el búfer. Una aplicación de representación puede usar el valor de relleno para determinar la cantidad de datos nuevos que puede escribir de forma segura en el búfer sin el riesgo de sobrescribir los datos escritos anteriormente que el motor de audio aún no ha leído del búfer. El espacio disponible es simplemente el tamaño del búfer menos el tamaño del relleno. El cliente puede solicitar un tamaño de paquete que represente parte o todo este espacio disponible en su siguiente llamada a GetBuffer .
El tamaño de un paquete se expresa en fotogramas de audio. Un fotograma de audio en una secuencia PCM es un conjunto de muestras (el conjunto contiene una muestra para cada canal de la secuencia) que se reproducen o se graban al mismo tiempo (tic de reloj). Por lo tanto, el tamaño de un fotograma de audio es el tamaño de la muestra multiplicado por el número de canales de la secuencia. Por ejemplo, el tamaño de fotograma de una secuencia estéreo (2 canales) con muestras de 16 bits es de cuatro bytes.
En el ejemplo de código siguiente se muestra cómo reproducir una secuencia de audio en el dispositivo de representación predeterminado:
//-----------------------------------------------------------
// Play an audio stream on the default audio rendering
// device. The PlayAudioStream function allocates a shared
// buffer big enough to hold one second of PCM audio data.
// The function uses this buffer to stream data to the
// rendering device. The inner loop runs every 1/2 second.
//-----------------------------------------------------------
// REFERENCE_TIME time units per second and per millisecond
#define REFTIMES_PER_SEC 10000000
#define REFTIMES_PER_MILLISEC 10000
#define EXIT_ON_ERROR(hres) \
if (FAILED(hres)) { goto Exit; }
#define SAFE_RELEASE(punk) \
if ((punk) != NULL) \
{ (punk)->Release(); (punk) = NULL; }
const CLSID CLSID_MMDeviceEnumerator = __uuidof(MMDeviceEnumerator);
const IID IID_IMMDeviceEnumerator = __uuidof(IMMDeviceEnumerator);
const IID IID_IAudioClient = __uuidof(IAudioClient);
const IID IID_IAudioRenderClient = __uuidof(IAudioRenderClient);
HRESULT PlayAudioStream(MyAudioSource *pMySource)
{
HRESULT hr;
REFERENCE_TIME hnsRequestedDuration = REFTIMES_PER_SEC;
REFERENCE_TIME hnsActualDuration;
IMMDeviceEnumerator *pEnumerator = NULL;
IMMDevice *pDevice = NULL;
IAudioClient *pAudioClient = NULL;
IAudioRenderClient *pRenderClient = NULL;
WAVEFORMATEX *pwfx = NULL;
UINT32 bufferFrameCount;
UINT32 numFramesAvailable;
UINT32 numFramesPadding;
BYTE *pData;
DWORD flags = 0;
hr = CoCreateInstance(
CLSID_MMDeviceEnumerator, NULL,
CLSCTX_ALL, IID_IMMDeviceEnumerator,
(void**)&pEnumerator);
EXIT_ON_ERROR(hr)
hr = pEnumerator->GetDefaultAudioEndpoint(
eRender, eConsole, &pDevice);
EXIT_ON_ERROR(hr)
hr = pDevice->Activate(
IID_IAudioClient, CLSCTX_ALL,
NULL, (void**)&pAudioClient);
EXIT_ON_ERROR(hr)
hr = pAudioClient->GetMixFormat(&pwfx);
EXIT_ON_ERROR(hr)
hr = pAudioClient->Initialize(
AUDCLNT_SHAREMODE_SHARED,
0,
hnsRequestedDuration,
0,
pwfx,
NULL);
EXIT_ON_ERROR(hr)
// Tell the audio source which format to use.
hr = pMySource->SetFormat(pwfx);
EXIT_ON_ERROR(hr)
// Get the actual size of the allocated buffer.
hr = pAudioClient->GetBufferSize(&bufferFrameCount);
EXIT_ON_ERROR(hr)
hr = pAudioClient->GetService(
IID_IAudioRenderClient,
(void**)&pRenderClient);
EXIT_ON_ERROR(hr)
// Grab the entire buffer for the initial fill operation.
hr = pRenderClient->GetBuffer(bufferFrameCount, &pData);
EXIT_ON_ERROR(hr)
// Load the initial data into the shared buffer.
hr = pMySource->LoadData(bufferFrameCount, pData, &flags);
EXIT_ON_ERROR(hr)
hr = pRenderClient->ReleaseBuffer(bufferFrameCount, flags);
EXIT_ON_ERROR(hr)
// Calculate the actual duration of the allocated buffer.
hnsActualDuration = (double)REFTIMES_PER_SEC *
bufferFrameCount / pwfx->nSamplesPerSec;
hr = pAudioClient->Start(); // Start playing.
EXIT_ON_ERROR(hr)
// Each loop fills about half of the shared buffer.
while (flags != AUDCLNT_BUFFERFLAGS_SILENT)
{
// Sleep for half the buffer duration.
Sleep((DWORD)(hnsActualDuration/REFTIMES_PER_MILLISEC/2));
// See how much buffer space is available.
hr = pAudioClient->GetCurrentPadding(&numFramesPadding);
EXIT_ON_ERROR(hr)
numFramesAvailable = bufferFrameCount - numFramesPadding;
// Grab all the available space in the shared buffer.
hr = pRenderClient->GetBuffer(numFramesAvailable, &pData);
EXIT_ON_ERROR(hr)
// Get next 1/2-second of data from the audio source.
hr = pMySource->LoadData(numFramesAvailable, pData, &flags);
EXIT_ON_ERROR(hr)
hr = pRenderClient->ReleaseBuffer(numFramesAvailable, flags);
EXIT_ON_ERROR(hr)
}
// Wait for last data in buffer to play before stopping.
Sleep((DWORD)(hnsActualDuration/REFTIMES_PER_MILLISEC/2));
hr = pAudioClient->Stop(); // Stop playing.
EXIT_ON_ERROR(hr)
Exit:
CoTaskMemFree(pwfx);
SAFE_RELEASE(pEnumerator)
SAFE_RELEASE(pDevice)
SAFE_RELEASE(pAudioClient)
SAFE_RELEASE(pRenderClient)
return hr;
}
En el ejemplo anterior, la función PlayAudioStream toma un único parámetro, pMySource, que es un puntero a un objeto que pertenece a una clase definida por el cliente, MyAudioSource, con dos funciones miembro, LoadData y SetFormat. El código de ejemplo no incluye la implementación de MyAudioSource porque:
- Ninguno de los miembros de clase se comunica directamente con ninguno de los métodos de las interfaces de WASAPI.
- La clase se podría implementar de varias maneras, en función de los requisitos del cliente. (Por ejemplo, podría leer los datos de representación de un archivo WAV y realizar la conversión sobre la marcha al formato de secuencia).
Sin embargo, cierta información sobre el funcionamiento de las dos funciones es útil para comprender el ejemplo.
La función LoadData escribe un número especificado de fotogramas de audio (primer parámetro) en una ubicación de búfer especificada (segundo parámetro). (El tamaño de un fotograma de audio es el número de canales de la secuencia multiplicado por el tamaño de la muestra). La función PlayAudioStream usa LoadData para rellenar partes del búfer compartido con datos de audio. La función SetFormat especifica el formato de la función LoadData que se va a usar para los datos. Si la función LoadData puede escribir al menos un marco en la ubicación de búfer especificada, pero se queda sin datos antes de que haya escrito el número especificado de fotogramas, escribe silencio en los fotogramas restantes.
Siempre que LoadData escriba al menos un fotograma de datos reales (no silencio) en la ubicación del búfer especificada, genera 0 a su tercer parámetro, que, en el ejemplo de código anterior, es un puntero de salida a la flags variable. Cuando LoadData no tiene datos y no puede escribir ni un solo fotograma en la ubicación del búfer especificada, no escribe nada en el búfer (ni siquiera silencio) y escribe el valor AUDCLNT_BUFFERFLAGS_SILENT en la flags variable. La flags variable transmite este valor al método IAudioRenderClient::ReleaseBuffer , que responde rellenando el número especificado de fotogramas en el búfer con silencio.
En su llamada al método IAudioClient::Initialize , la función PlayAudioStream del ejemplo anterior solicita un búfer compartido que tiene una duración de un segundo. (El búfer asignado puede tener una duración ligeramente más larga). En sus llamadas iniciales a los métodos IAudioRenderClient::GetBuffer e IAudioRenderClient::ReleaseBuffer , la función rellena todo el búfer antes de llamar al método IAudioClient::Start para empezar a reproducir el búfer.
Dentro del bucle principal, la función rellena de forma iterativa la mitad del búfer en intervalos de medio segundo. Justo antes de cada llamada a la función Suspensión de Windows en el bucle principal, el búfer está lleno o casi lleno. Cuando se devuelve la llamada de suspensión , el búfer se llena aproximadamente a la mitad. El bucle finaliza después de la llamada final a la función LoadData establece la flags variable en el valor AUDCLNT_BUFFERFLAGS_SILENT. En ese momento, el búfer contiene al menos una trama de datos reales y puede contener hasta medio segundo de datos reales. El resto del búfer contiene silencio. La llamada sleep que sigue al bucle proporciona tiempo suficiente (medio segundo) para reproducir todos los datos restantes. El silencio que sigue a los datos evita sonidos no deseados antes de que la llamada al método IAudioClient::Stop detenga la secuencia de audio. Para obtener más información sobre suspensión, consulte la documentación de Windows SDK.
Después de la llamada al método IAudioClient::Initialize , la secuencia permanece abierta hasta que el cliente libera todas sus referencias a la interfaz IAudioClient y a todas las referencias a las interfaces de servicio que el cliente obtuvo a través del método IAudioClient::GetService . La llamada de versión final cierra la secuencia.
La función PlayAudioStream del ejemplo de código anterior llama a la función CoCreateInstance para crear un enumerador para los dispositivos de punto de conexión de audio del sistema. A menos que el programa de llamada anteriormente llamara a la función CoCreateInstance o CoInitializeEx para inicializar la biblioteca COM, se producirá un error en la llamada a CoCreateInstance . Para obtener más información sobre CoCreateInstance, CoCreateInstance y CoInitializeEx, consulte la documentación de Windows SDK.
Temas relacionados