cannam@140: /** @file patest_write_stop_threads.c
cannam@140: 	@brief Call Pa_StopStream() from another thread to see if PortAudio hangs.
cannam@140: 	@author Bjorn Roche of XO Audio (www.xoaudio.com)
cannam@140: 	@author Ross Bencina
cannam@140: 	@author Phil Burk
cannam@140: */
cannam@140: /*
cannam@140:  * $Id$
cannam@140:  *
cannam@140:  * This program uses the PortAudio Portable Audio Library.
cannam@140:  * For more information see: http://www.portaudio.com/
cannam@140:  * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
cannam@140:  *
cannam@140:  * Permission is hereby granted, free of charge, to any person obtaining
cannam@140:  * a copy of this software and associated documentation files
cannam@140:  * (the "Software"), to deal in the Software without restriction,
cannam@140:  * including without limitation the rights to use, copy, modify, merge,
cannam@140:  * publish, distribute, sublicense, and/or sell copies of the Software,
cannam@140:  * and to permit persons to whom the Software is furnished to do so,
cannam@140:  * subject to the following conditions:
cannam@140:  *
cannam@140:  * The above copyright notice and this permission notice shall be
cannam@140:  * included in all copies or substantial portions of the Software.
cannam@140:  *
cannam@140:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@140:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@140:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
cannam@140:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
cannam@140:  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@140:  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@140:  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@140:  */
cannam@140: 
cannam@140: /*
cannam@140:  * The text above constitutes the entire PortAudio license; however,
cannam@140:  * the PortAudio community also makes the following non-binding requests:
cannam@140:  *
cannam@140:  * Any person wishing to distribute modifications to the Software is
cannam@140:  * requested to send the modifications to the original developer so that
cannam@140:  * they can be incorporated into the canonical version. It is also
cannam@140:  * requested that these non-binding requests be included along with the
cannam@140:  * license above.
cannam@140:  */
cannam@140: 
cannam@140: #include <stdio.h>
cannam@140: #include <unistd.h>
cannam@140: #include <math.h>
cannam@140: #include <memory.h>
cannam@140: /* pthread may only be available on Mac and Linux. */
cannam@140: #include <pthread.h>
cannam@140: #include "portaudio.h"
cannam@140: 
cannam@140: #define SAMPLE_RATE         (44100)
cannam@140: #define FRAMES_PER_BUFFER   (2048)
cannam@140: 
cannam@140: static float s_buffer[FRAMES_PER_BUFFER][2]; /* stereo output buffer */
cannam@140: 
cannam@140: /**
cannam@140:  * WARNING: PortAudio is NOT thread safe. DO NOT call PortAudio
cannam@140:  * from multiple threads without synchronization. This test uses
cannam@140:  * PA in an ILLEGAL WAY in order to try to flush out potential hang bugs.
cannam@140:  * The test calls Pa_WriteStream() and Pa_StopStream() simultaneously
cannam@140:  * from separate threads in order to try to cause Pa_StopStream() to hang.
cannam@140:  * In the main thread we write to the stream in a loop.
cannam@140:  * Then try stopping PA from another thread to see if it hangs.
cannam@140:  *
cannam@140:  * @note: Do not expect this test to pass. The test is only here
cannam@140:  * as a debugging aid for hang bugs. Since this test uses PA in an
cannam@140:  * illegal way, it may fail for reasons that are not PA bugs.
cannam@140:  */
cannam@140: 
cannam@140: /* Wait for awhile then abort the stream. */
cannam@140: void *stop_thread_proc(void *arg)
cannam@140: {
cannam@140:     PaStream *stream = (PaStream *)arg;
cannam@140:     PaTime time;
cannam@140:     for (int i = 0; i < 20; i++)
cannam@140:     {
cannam@140:         /* ILLEGAL unsynchronised call to PA, see comment above */
cannam@140:         time = Pa_GetStreamTime( stream );
cannam@140:         printf("Stream time = %f\n", time);
cannam@140:         fflush(stdout);
cannam@140:         usleep(100 * 1000);
cannam@140:     }
cannam@140:     printf("Call Pa_StopStream()\n");
cannam@140:     fflush(stdout);
cannam@140:     /* ILLEGAL unsynchronised call to PA, see comment above */
cannam@140:     PaError err = Pa_StopStream( stream );
cannam@140:     printf("Pa_StopStream() returned %d\n", err);
cannam@140:     fflush(stdout);
cannam@140: 
cannam@140:     return stream;
cannam@140: }
cannam@140: 
cannam@140: int main(void);
cannam@140: int main(void)
cannam@140: {
cannam@140:     PaStreamParameters outputParameters;
cannam@140:     PaStream *stream;
cannam@140:     PaError err;
cannam@140:     int result;
cannam@140:     pthread_t thread;
cannam@140: 
cannam@140:     printf( "PortAudio Test: output silence and stop from another thread. SR = %d, BufSize = %d\n",
cannam@140:             SAMPLE_RATE, FRAMES_PER_BUFFER);
cannam@140: 
cannam@140:     err = Pa_Initialize();
cannam@140:     if( err != paNoError ) goto error;
cannam@140: 
cannam@140:     outputParameters.device = Pa_GetDefaultOutputDevice(); /* default output device */
cannam@140:     outputParameters.channelCount = 2;       /* stereo output */
cannam@140:     outputParameters.sampleFormat = paFloat32; /* 32 bit floating point output */
cannam@140:     outputParameters.suggestedLatency = Pa_GetDeviceInfo( outputParameters.device )->defaultHighOutputLatency * 5;
cannam@140:     outputParameters.hostApiSpecificStreamInfo = NULL;
cannam@140: 
cannam@140:     /* open the stream */
cannam@140:     err = Pa_OpenStream(
cannam@140:               &stream,
cannam@140:               NULL, /* no input */
cannam@140:               &outputParameters,
cannam@140:               SAMPLE_RATE,
cannam@140:               FRAMES_PER_BUFFER,
cannam@140:               paClipOff,      /* we won't output out of range samples so don't bother clipping them */
cannam@140:               NULL, /* no callback, use blocking API */
cannam@140:               NULL ); /* no callback, so no callback userData */
cannam@140:     if( err != paNoError ) goto error;
cannam@140: 
cannam@140:     result = pthread_create(&thread, NULL /* attributes */, stop_thread_proc, stream);
cannam@140: 
cannam@140:     /* start the stream */
cannam@140:     err = Pa_StartStream( stream );
cannam@140:     if( err != paNoError ) goto error;
cannam@140: 
cannam@140:     /* clear buffer */
cannam@140:     memset( s_buffer, 0, sizeof(s_buffer) );
cannam@140: 
cannam@140:     /* play the silent buffer many times */
cannam@140:     while( Pa_IsStreamActive(stream) > 0 )
cannam@140:     {
cannam@140:         err = Pa_WriteStream( stream, s_buffer, FRAMES_PER_BUFFER );
cannam@140:         printf("Pa_WriteStream returns %d = %s\n", err, Pa_GetErrorText( err ));
cannam@140:         if( err != paNoError )
cannam@140:         {
cannam@140:             err = paNoError;
cannam@140:             break;
cannam@140:         };
cannam@140:     }
cannam@140: 
cannam@140:     printf("Try to join the thread that called Pa_StopStream().\n");
cannam@140:     result = pthread_join( thread, NULL );
cannam@140:     printf("pthread_join returned %d\n", result);
cannam@140: 
cannam@140:     /* close, and terminate */
cannam@140:     printf("Call Pa_CloseStream\n");
cannam@140:     err = Pa_CloseStream( stream );
cannam@140:     if( err != paNoError ) goto error;
cannam@140: 
cannam@140:     Pa_Terminate();
cannam@140:     printf("Test finished.\n");
cannam@140: 
cannam@140:     return err;
cannam@140: error:
cannam@140:     Pa_Terminate();
cannam@140:     fprintf( stderr, "An error occured while using the portaudio stream\n" );
cannam@140:     fprintf( stderr, "Error number: %d\n", err );
cannam@140:     fprintf( stderr, "Error message: %s\n", Pa_GetErrorText( err ) );
cannam@140:     return err;
cannam@140: }