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