Chris@39: /** @file patest_callbackstop.c
Chris@39: 	@ingroup test_src
Chris@39: 	@brief Test the paComplete callback result code.
Chris@39: 	@author Ross Bencina <rossb@audiomulch.com>
Chris@39: */
Chris@39: /*
Chris@39:  * $Id: patest_callbackstop.c 1368 2008-03-01 00:38:27Z rossb $
Chris@39:  *
Chris@39:  * This program uses the PortAudio Portable Audio Library.
Chris@39:  * For more information see: http://www.portaudio.com/
Chris@39:  * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
Chris@39:  *
Chris@39:  * Permission is hereby granted, free of charge, to any person obtaining
Chris@39:  * a copy of this software and associated documentation files
Chris@39:  * (the "Software"), to deal in the Software without restriction,
Chris@39:  * including without limitation the rights to use, copy, modify, merge,
Chris@39:  * publish, distribute, sublicense, and/or sell copies of the Software,
Chris@39:  * and to permit persons to whom the Software is furnished to do so,
Chris@39:  * subject to the following conditions:
Chris@39:  *
Chris@39:  * The above copyright notice and this permission notice shall be
Chris@39:  * included in all copies or substantial portions of the Software.
Chris@39:  *
Chris@39:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@39:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@39:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Chris@39:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
Chris@39:  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@39:  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@39:  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@39:  */
Chris@39: 
Chris@39: /*
Chris@39:  * The text above constitutes the entire PortAudio license; however, 
Chris@39:  * the PortAudio community also makes the following non-binding requests:
Chris@39:  *
Chris@39:  * Any person wishing to distribute modifications to the Software is
Chris@39:  * requested to send the modifications to the original developer so that
Chris@39:  * they can be incorporated into the canonical version. It is also 
Chris@39:  * requested that these non-binding requests be included along with the 
Chris@39:  * license above.
Chris@39:  */
Chris@39: 
Chris@39: #include <stdio.h>
Chris@39: #include <math.h>
Chris@39: #include "portaudio.h"
Chris@39: 
Chris@39: #define NUM_SECONDS   (5)
Chris@39: #define NUM_LOOPS     (4)
Chris@39: #define SAMPLE_RATE   (44100)
Chris@39: #define FRAMES_PER_BUFFER  (67)
Chris@39: 
Chris@39: #ifndef M_PI
Chris@39: #define M_PI  (3.14159265)
Chris@39: #endif
Chris@39: 
Chris@39: #define TABLE_SIZE   (200)
Chris@39: typedef struct
Chris@39: {
Chris@39:     float sine[TABLE_SIZE];
Chris@39:     int phase;
Chris@39:     unsigned long generatedFramesCount;
Chris@39:     volatile int callbackReturnedPaComplete;
Chris@39:     volatile int callbackInvokedAfterReturningPaComplete;
Chris@39:     char message[100];
Chris@39: }
Chris@39: TestData;
Chris@39: 
Chris@39: /*
Chris@39:    This routine will be called by the PortAudio stream when audio is needed.
Chris@39:    It may be called at interrupt level on some machines so don't do anything
Chris@39:    that could mess up the system like calling malloc() or free().
Chris@39: */
Chris@39: static int TestCallback( const void *input, void *output,
Chris@39:                             unsigned long frameCount,
Chris@39:                             const PaStreamCallbackTimeInfo* timeInfo,
Chris@39:                             PaStreamCallbackFlags statusFlags,
Chris@39:                             void *userData )
Chris@39: {
Chris@39:     TestData *data = (TestData*)userData;
Chris@39:     float *out = (float*)output;
Chris@39:     unsigned long i;
Chris@39:     float x;
Chris@39: 
Chris@39:     (void) input;       /* Prevent unused variable warnings. */
Chris@39:     (void) timeInfo;
Chris@39:     (void) statusFlags;
Chris@39: 
Chris@39:     
Chris@39:     if( data->callbackReturnedPaComplete )
Chris@39:         data->callbackInvokedAfterReturningPaComplete = 1;
Chris@39: 
Chris@39:     for( i=0; i<frameCount; i++ )
Chris@39:     {
Chris@39:         /* generate tone */
Chris@39:         
Chris@39:         x = data->sine[ data->phase++ ];
Chris@39:         if( data->phase >= TABLE_SIZE )
Chris@39:             data->phase -= TABLE_SIZE;
Chris@39:         
Chris@39:         *out++ = x;  /* left */
Chris@39:         *out++ = x;  /* right */
Chris@39:     }
Chris@39: 
Chris@39:     data->generatedFramesCount += frameCount;
Chris@39:     if( data->generatedFramesCount >= (NUM_SECONDS * SAMPLE_RATE) )
Chris@39:     {
Chris@39:         data->callbackReturnedPaComplete = 1;
Chris@39:         return paComplete;
Chris@39:     }
Chris@39:     else
Chris@39:     {
Chris@39:         return paContinue;
Chris@39:     }
Chris@39: }
Chris@39: 
Chris@39: /*
Chris@39:  * This routine is called by portaudio when playback is done.
Chris@39:  */
Chris@39: static void StreamFinished( void* userData )
Chris@39: {
Chris@39:    TestData *data = (TestData *) userData;
Chris@39:    printf( "Stream Completed: %s\n", data->message );
Chris@39: }
Chris@39: 
Chris@39: 
Chris@39: /*----------------------------------------------------------------------------*/
Chris@39: int main(void);
Chris@39: int main(void)
Chris@39: {
Chris@39:     PaStreamParameters outputParameters;
Chris@39:     PaStream *stream;
Chris@39:     PaError err;
Chris@39:     TestData data;
Chris@39:     int i, j;
Chris@39: 
Chris@39:     
Chris@39:     printf( "PortAudio Test: output sine wave. SR = %d, BufSize = %d\n",
Chris@39:             SAMPLE_RATE, FRAMES_PER_BUFFER );
Chris@39:     
Chris@39:     /* initialise sinusoidal wavetable */
Chris@39:     for( i=0; i<TABLE_SIZE; i++ )
Chris@39:     {
Chris@39:         data.sine[i] = (float) sin( ((double)i/(double)TABLE_SIZE) * M_PI * 2. );
Chris@39:     }
Chris@39:     
Chris@39:     err = Pa_Initialize();
Chris@39:     if( err != paNoError ) goto error;
Chris@39: 
Chris@39:     outputParameters.device                    = Pa_GetDefaultOutputDevice();
Chris@39:     if (outputParameters.device == paNoDevice) {
Chris@39:       fprintf(stderr,"Error: No default output device.\n");
Chris@39:       goto error;
Chris@39:     }
Chris@39:     outputParameters.channelCount              = 2;               /* stereo output */
Chris@39:     outputParameters.sampleFormat              = paFloat32;       /* 32 bit floating point output */
Chris@39:     outputParameters.suggestedLatency          = Pa_GetDeviceInfo( outputParameters.device )->defaultLowOutputLatency;
Chris@39:     outputParameters.hostApiSpecificStreamInfo = NULL;
Chris@39: 
Chris@39:     err = Pa_OpenStream(
Chris@39:               &stream,
Chris@39:               NULL, /* no input */
Chris@39:               &outputParameters,
Chris@39:               SAMPLE_RATE,
Chris@39:               FRAMES_PER_BUFFER,
Chris@39:               paClipOff,      /* output will be in-range, so no need to clip */
Chris@39:               TestCallback,
Chris@39:               &data );
Chris@39:     if( err != paNoError ) goto error;
Chris@39: 
Chris@39:     sprintf( data.message, "Loop: XX" );
Chris@39:     err = Pa_SetStreamFinishedCallback( stream, &StreamFinished );
Chris@39:     if( err != paNoError ) goto error;
Chris@39: 
Chris@39:     printf("Repeating test %d times.\n", NUM_LOOPS );
Chris@39:     
Chris@39:     for( i=0; i < NUM_LOOPS; ++i )
Chris@39:     {
Chris@39:         data.phase = 0;
Chris@39:         data.generatedFramesCount = 0;
Chris@39:         data.callbackReturnedPaComplete = 0;
Chris@39:         data.callbackInvokedAfterReturningPaComplete = 0;
Chris@39:         sprintf( data.message, "Loop: %d", i );
Chris@39: 
Chris@39:         err = Pa_StartStream( stream );
Chris@39:         if( err != paNoError ) goto error;
Chris@39: 
Chris@39:         printf("Play for %d seconds.\n", NUM_SECONDS );
Chris@39: 
Chris@39:         /* wait for the callback to complete generating NUM_SECONDS of tone */
Chris@39: 
Chris@39:         do
Chris@39:         {
Chris@39:             Pa_Sleep( 500 );
Chris@39:         }
Chris@39:         while( !data.callbackReturnedPaComplete );
Chris@39: 
Chris@39:         printf( "Callback returned paComplete.\n" );
Chris@39:         printf( "Waiting for buffers to finish playing...\n" );
Chris@39: 
Chris@39:         /* wait for stream to become inactive,
Chris@39:            or for a timeout of approximately NUM_SECONDS
Chris@39:          */
Chris@39:      
Chris@39:         j = 0;
Chris@39:         while( (err = Pa_IsStreamActive( stream )) == 1 && j < NUM_SECONDS * 2 )
Chris@39:         {
Chris@39:             printf(".\n" );
Chris@39:             Pa_Sleep( 500 );
Chris@39:             ++j;
Chris@39:         }
Chris@39: 
Chris@39:         if( err < 0 )
Chris@39:         {
Chris@39:             goto error;
Chris@39:         }
Chris@39:         else if( err == 1 )
Chris@39:         {
Chris@39:             printf( "TEST FAILED: Timed out waiting for buffers to finish playing.\n" );
Chris@39:         }
Chris@39:         else
Chris@39:         {
Chris@39:             printf("Buffers finished.\n" );
Chris@39:         }
Chris@39: 
Chris@39:         if( data.callbackInvokedAfterReturningPaComplete )
Chris@39:         {
Chris@39:             printf( "TEST FAILED: Callback was invoked after returning paComplete.\n" );
Chris@39:         }
Chris@39: 
Chris@39: 
Chris@39:         err = Pa_StopStream( stream );
Chris@39:         if( err != paNoError ) goto error;
Chris@39: 
Chris@39:         printf( "sleeping for 1 second...\n" );
Chris@39:         Pa_Sleep( 1000 );
Chris@39:     }
Chris@39: 
Chris@39:     err = Pa_CloseStream( stream );
Chris@39:     if( err != paNoError ) goto error;
Chris@39: 
Chris@39:     Pa_Terminate();
Chris@39:     printf("Test finished.\n");
Chris@39:     
Chris@39:     return err;
Chris@39: error:
Chris@39:     Pa_Terminate();
Chris@39:     fprintf( stderr, "An error occured while using the portaudio stream\n" );
Chris@39:     fprintf( stderr, "Error number: %d\n", err );
Chris@39:     fprintf( stderr, "Error message: %s\n", Pa_GetErrorText( err ) );
Chris@39:     return err;
Chris@39: }