cannam@162: /** @file paex_sine.c
cannam@162: 	@ingroup examples_src
cannam@162: 	@brief Play a sine wave for several seconds.
cannam@162: 	@author Ross Bencina <rossb@audiomulch.com>
cannam@162:     @author Phil Burk <philburk@softsynth.com>
cannam@162: */
cannam@162: /*
cannam@162:  * $Id: paex_sine.c 1752 2011-09-08 03:21:55Z philburk $
cannam@162:  *
cannam@162:  * This program uses the PortAudio Portable Audio Library.
cannam@162:  * For more information see: http://www.portaudio.com/
cannam@162:  * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
cannam@162:  *
cannam@162:  * Permission is hereby granted, free of charge, to any person obtaining
cannam@162:  * a copy of this software and associated documentation files
cannam@162:  * (the "Software"), to deal in the Software without restriction,
cannam@162:  * including without limitation the rights to use, copy, modify, merge,
cannam@162:  * publish, distribute, sublicense, and/or sell copies of the Software,
cannam@162:  * and to permit persons to whom the Software is furnished to do so,
cannam@162:  * subject to the following conditions:
cannam@162:  *
cannam@162:  * The above copyright notice and this permission notice shall be
cannam@162:  * included in all copies or substantial portions of the Software.
cannam@162:  *
cannam@162:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@162:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@162:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
cannam@162:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
cannam@162:  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@162:  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@162:  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@162:  */
cannam@162: 
cannam@162: /*
cannam@162:  * The text above constitutes the entire PortAudio license; however, 
cannam@162:  * the PortAudio community also makes the following non-binding requests:
cannam@162:  *
cannam@162:  * Any person wishing to distribute modifications to the Software is
cannam@162:  * requested to send the modifications to the original developer so that
cannam@162:  * they can be incorporated into the canonical version. It is also 
cannam@162:  * requested that these non-binding requests be included along with the 
cannam@162:  * license above.
cannam@162:  */
cannam@162: #include <stdio.h>
cannam@162: #include <math.h>
cannam@162: #include "portaudio.h"
cannam@162: 
cannam@162: #define NUM_SECONDS   (5)
cannam@162: #define SAMPLE_RATE   (44100)
cannam@162: #define FRAMES_PER_BUFFER  (64)
cannam@162: 
cannam@162: #ifndef M_PI
cannam@162: #define M_PI  (3.14159265)
cannam@162: #endif
cannam@162: 
cannam@162: #define TABLE_SIZE   (200)
cannam@162: 
cannam@162: class Sine
cannam@162: {
cannam@162: public:
cannam@162:     Sine() : stream(0), left_phase(0), right_phase(0)
cannam@162:     {
cannam@162:         /* initialise sinusoidal wavetable */
cannam@162:         for( int i=0; i<TABLE_SIZE; i++ )
cannam@162:         {
cannam@162:             sine[i] = (float) sin( ((double)i/(double)TABLE_SIZE) * M_PI * 2. );
cannam@162:         }
cannam@162: 
cannam@162:         sprintf( message, "No Message" );
cannam@162:     }
cannam@162: 
cannam@162:     bool open(PaDeviceIndex index)
cannam@162:     {
cannam@162:         PaStreamParameters outputParameters;
cannam@162: 
cannam@162:         outputParameters.device = index;
cannam@162:         if (outputParameters.device == paNoDevice) {
cannam@162:             return false;
cannam@162:         }
cannam@162: 
cannam@162:         const PaDeviceInfo* pInfo = Pa_GetDeviceInfo(index);
cannam@162:         if (pInfo != 0)
cannam@162:         {
cannam@162:             printf("Output device name: '%s'\r", pInfo->name);
cannam@162:         }
cannam@162: 
cannam@162:         outputParameters.channelCount = 2;       /* stereo output */
cannam@162:         outputParameters.sampleFormat = paFloat32; /* 32 bit floating point output */
cannam@162:         outputParameters.suggestedLatency = Pa_GetDeviceInfo( outputParameters.device )->defaultLowOutputLatency;
cannam@162:         outputParameters.hostApiSpecificStreamInfo = NULL;
cannam@162: 
cannam@162:         PaError err = Pa_OpenStream(
cannam@162:             &stream,
cannam@162:             NULL, /* no input */
cannam@162:             &outputParameters,
cannam@162:             SAMPLE_RATE,
cannam@162:             paFramesPerBufferUnspecified,
cannam@162:             paClipOff,      /* we won't output out of range samples so don't bother clipping them */
cannam@162:             &Sine::paCallback,
cannam@162:             this            /* Using 'this' for userData so we can cast to Sine* in paCallback method */
cannam@162:             );
cannam@162: 
cannam@162:         if (err != paNoError)
cannam@162:         {
cannam@162:             /* Failed to open stream to device !!! */
cannam@162:             return false;
cannam@162:         }
cannam@162: 
cannam@162:         err = Pa_SetStreamFinishedCallback( stream, &Sine::paStreamFinished );
cannam@162: 
cannam@162:         if (err != paNoError)
cannam@162:         {
cannam@162:             Pa_CloseStream( stream );
cannam@162:             stream = 0;
cannam@162: 
cannam@162:             return false;
cannam@162:         }
cannam@162: 
cannam@162:         return true;
cannam@162:     }
cannam@162: 
cannam@162:     bool close()
cannam@162:     {
cannam@162:         if (stream == 0)
cannam@162:             return false;
cannam@162: 
cannam@162:         PaError err = Pa_CloseStream( stream );
cannam@162:         stream = 0;
cannam@162: 
cannam@162:         return (err == paNoError);
cannam@162:     }
cannam@162: 
cannam@162: 
cannam@162:     bool start()
cannam@162:     {
cannam@162:         if (stream == 0)
cannam@162:             return false;
cannam@162: 
cannam@162:         PaError err = Pa_StartStream( stream );
cannam@162: 
cannam@162:         return (err == paNoError);
cannam@162:     }
cannam@162: 
cannam@162:     bool stop()
cannam@162:     {
cannam@162:         if (stream == 0)
cannam@162:             return false;
cannam@162: 
cannam@162:         PaError err = Pa_StopStream( stream );
cannam@162: 
cannam@162:         return (err == paNoError);
cannam@162:     }
cannam@162: 
cannam@162: private:
cannam@162:     /* The instance callback, where we have access to every method/variable in object of class Sine */
cannam@162:     int paCallbackMethod(const void *inputBuffer, void *outputBuffer,
cannam@162:         unsigned long framesPerBuffer,
cannam@162:         const PaStreamCallbackTimeInfo* timeInfo,
cannam@162:         PaStreamCallbackFlags statusFlags)
cannam@162:     {
cannam@162:         float *out = (float*)outputBuffer;
cannam@162:         unsigned long i;
cannam@162: 
cannam@162:         (void) timeInfo; /* Prevent unused variable warnings. */
cannam@162:         (void) statusFlags;
cannam@162:         (void) inputBuffer;
cannam@162: 
cannam@162:         for( i=0; i<framesPerBuffer; i++ )
cannam@162:         {
cannam@162:             *out++ = sine[left_phase];  /* left */
cannam@162:             *out++ = sine[right_phase];  /* right */
cannam@162:             left_phase += 1;
cannam@162:             if( left_phase >= TABLE_SIZE ) left_phase -= TABLE_SIZE;
cannam@162:             right_phase += 3; /* higher pitch so we can distinguish left and right. */
cannam@162:             if( right_phase >= TABLE_SIZE ) right_phase -= TABLE_SIZE;
cannam@162:         }
cannam@162: 
cannam@162:         return paContinue;
cannam@162: 
cannam@162:     }
cannam@162: 
cannam@162:     /* This routine will be called by the PortAudio engine when audio is needed.
cannam@162:     ** It may called at interrupt level on some machines so don't do anything
cannam@162:     ** that could mess up the system like calling malloc() or free().
cannam@162:     */
cannam@162:     static int paCallback( const void *inputBuffer, void *outputBuffer,
cannam@162:         unsigned long framesPerBuffer,
cannam@162:         const PaStreamCallbackTimeInfo* timeInfo,
cannam@162:         PaStreamCallbackFlags statusFlags,
cannam@162:         void *userData )
cannam@162:     {
cannam@162:         /* Here we cast userData to Sine* type so we can call the instance method paCallbackMethod, we can do that since 
cannam@162:            we called Pa_OpenStream with 'this' for userData */
cannam@162:         return ((Sine*)userData)->paCallbackMethod(inputBuffer, outputBuffer,
cannam@162:             framesPerBuffer,
cannam@162:             timeInfo,
cannam@162:             statusFlags);
cannam@162:     }
cannam@162: 
cannam@162: 
cannam@162:     void paStreamFinishedMethod()
cannam@162:     {
cannam@162:         printf( "Stream Completed: %s\n", message );
cannam@162:     }
cannam@162: 
cannam@162:     /*
cannam@162:      * This routine is called by portaudio when playback is done.
cannam@162:      */
cannam@162:     static void paStreamFinished(void* userData)
cannam@162:     {
cannam@162:         return ((Sine*)userData)->paStreamFinishedMethod();
cannam@162:     }
cannam@162: 
cannam@162:     PaStream *stream;
cannam@162:     float sine[TABLE_SIZE];
cannam@162:     int left_phase;
cannam@162:     int right_phase;
cannam@162:     char message[20];
cannam@162: };
cannam@162: 
cannam@162: class ScopedPaHandler
cannam@162: {
cannam@162: public:
cannam@162:     ScopedPaHandler()
cannam@162:         : _result(Pa_Initialize())
cannam@162:     {
cannam@162:     }
cannam@162:     ~ScopedPaHandler()
cannam@162:     {
cannam@162:         if (_result == paNoError)
cannam@162:         {
cannam@162:             Pa_Terminate();
cannam@162:         }
cannam@162:     }
cannam@162: 
cannam@162:     PaError result() const { return _result; }
cannam@162: 
cannam@162: private:
cannam@162:     PaError _result;
cannam@162: };
cannam@162: 
cannam@162: 
cannam@162: /*******************************************************************/
cannam@162: int main(void);
cannam@162: int main(void)
cannam@162: {
cannam@162:     Sine sine;
cannam@162: 
cannam@162:     printf("PortAudio Test: output sine wave. SR = %d, BufSize = %d\n", SAMPLE_RATE, FRAMES_PER_BUFFER);
cannam@162:     
cannam@162:     ScopedPaHandler paInit;
cannam@162:     if( paInit.result() != paNoError ) goto error;
cannam@162: 
cannam@162:     if (sine.open(Pa_GetDefaultOutputDevice()))
cannam@162:     {
cannam@162:         if (sine.start())
cannam@162:         {
cannam@162:             printf("Play for %d seconds.\n", NUM_SECONDS );
cannam@162:             Pa_Sleep( NUM_SECONDS * 1000 );
cannam@162: 
cannam@162:             sine.stop();
cannam@162:         }
cannam@162: 
cannam@162:         sine.close();
cannam@162:     }
cannam@162: 
cannam@162:     printf("Test finished.\n");
cannam@162:     return paNoError;
cannam@162: 
cannam@162: error:
cannam@162:     fprintf( stderr, "An error occured while using the portaudio stream\n" );
cannam@162:     fprintf( stderr, "Error number: %d\n", paInit.result() );
cannam@162:     fprintf( stderr, "Error message: %s\n", Pa_GetErrorText( paInit.result() ) );
cannam@162:     return 1;
cannam@162: }