juce/source/extras/JuceDemo/Source/demos/AudioDemoLatencyPage.cpp

   1 /*
   2   ==============================================================================
   3
   4   This is an automatically generated file created by the Jucer!
   5
   6   Creation date:  1 May 2011 1:54:50pm
   7
   8   Be careful when adding custom code to these files, as only the code within
   9   the "//[xyz]" and "//[/xyz]" sections will be retained when the file is loaded
  10   and re-saved.
  11
  12   Jucer version: 1.12
  13
  14   ------------------------------------------------------------------------------
  15
  16   The Jucer is part of the JUCE library - "Jules' Utility Class Extensions"
  17   Copyright 2004-6 by Raw Material Software ltd.
  18
  19   ==============================================================================
  20 */
  21
  22 //[Headers] You can add your own extra header files here...
  23 //[/Headers]
  24
  25 #include "AudioDemoLatencyPage.h"
  26
  27
  28 //[MiscUserDefs] You can add your own user definitions and misc code here...
  29
  30 //==============================================================================
  31 class LatencyTester  : public AudioIODeviceCallback,
  32                        public Timer
  33 {
  34 public:
  35     LatencyTester (TextEditor* resultsBox_)
  36         : testSound (1, 1),
  37           recordedSound (1, 1),
  38           playingSampleNum (0),
  39           recordedSampleNum (-1),
  40           sampleRate (0),
  41           isRunning (false),
  42           resultsBox (resultsBox_)
  43     {
  44     }
  45
  46     ~LatencyTester()
  47     {
  48     }
  49
  50     //==============================================================================
  51     void beginTest()
  52     {
  53         startTimer (50);
  54
  55         const ScopedLock sl (lock);
  56         createTestSound();
  57         recordedSound.clear();
  58         playingSampleNum = recordedSampleNum = 0;
  59         isRunning = true;
  60     }
  61
  62     void timerCallback()
  63     {
  64         if (isRunning && recordedSampleNum >= recordedSound.getNumSamples())
  65         {
  66             isRunning = false;
  67             stopTimer();
  68
  69             // Test has finished, so calculate the result..
  70             String message;
  71
  72             const int latencySamples = calculateLatencySamples();
  73
  74             if (latencySamples >= 0)
  75             {
  76                 message << "\n\nLatency test results:\n"
  77                         << latencySamples << " samples (" << String (latencySamples * 1000.0 / sampleRate, 1) << " milliseconds)\n"
  78                         << "The audio device reports an input latency of "
  79                         << deviceInputLatency << " samples, output latency of "
  80                         << deviceOutputLatency << " samples."
  81                         << "\nSo the corrected latency = "
  82                         << (latencySamples - deviceInputLatency - deviceOutputLatency)
  83                         << " samples (" << String ((latencySamples - deviceInputLatency - deviceOutputLatency) * 1000.0 / sampleRate, 2)
  84                         << " milliseconds)";
  85             }
  86             else
  87             {
  88                 message = "\n\nCouldn't detect the test signal!!\nMake sure there's no background noise that might be confusing it..";
  89             }
  90
  91             resultsBox->setCaretPosition (INT_MAX);
  92             resultsBox->insertTextAtCaret (message);
  93             resultsBox->setCaretPosition (INT_MAX);
  94         }
  95     }
  96
  97     //==============================================================================
  98     void audioDeviceAboutToStart (AudioIODevice* device)
  99     {
 100         isRunning = false;
 101         sampleRate = device->getCurrentSampleRate();
 102         deviceInputLatency = device->getInputLatencyInSamples();
 103         deviceOutputLatency = device->getOutputLatencyInSamples();
 104         playingSampleNum = recordedSampleNum = 0;
 105
 106         recordedSound.setSize (1, (int) (1.5 * sampleRate));
 107         recordedSound.clear();
 108     }
 109
 110     void audioDeviceStopped()
 111     {
 112     }
 113
 114     void audioDeviceIOCallback (const float** inputChannelData,
 115                                 int numInputChannels,
 116                                 float** outputChannelData,
 117                                 int numOutputChannels,
 118                                 int numSamples)
 119     {
 120         const ScopedLock sl (lock);
 121
 122         if (isRunning)
 123         {
 124             float* const recordingBuffer = recordedSound.getSampleData (0, 0);
 125             const float* const playBuffer = testSound.getSampleData (0, 0);
 126
 127             for (int i = 0; i < numSamples; ++i)
 128             {
 129                 if (recordedSampleNum < recordedSound.getNumSamples())
 130                 {
 131                     float inputSamp = 0;
 132                     for (int j = numInputChannels; --j >= 0;)
 133                         if (inputChannelData[j] != 0)
 134                             inputSamp += inputChannelData[j][i];
 135
 136                     recordingBuffer [recordedSampleNum] = inputSamp;
 137                 }
 138
 139                 ++recordedSampleNum;
 140
 141                 float outputSamp = (playingSampleNum < testSound.getNumSamples()) ? playBuffer [playingSampleNum] : 0;
 142
 143                 for (int j = numOutputChannels; --j >= 0;)
 144                     if (outputChannelData[j] != 0)
 145                         outputChannelData[j][i] = outputSamp;
 146
 147                 ++playingSampleNum;
 148             }
 149         }
 150         else
 151         {
 152             // We need to clear the output buffers, in case they're full of junk..
 153             for (int i = 0; i < numOutputChannels; ++i)
 154                 if (outputChannelData[i] != 0)
 155                     zeromem (outputChannelData[i], sizeof (float) * numSamples);
 156         }
 157     }
 158
 159 private:
 160     AudioSampleBuffer testSound, recordedSound;
 161     int playingSampleNum, recordedSampleNum;
 162     CriticalSection lock;
 163     double sampleRate;
 164     bool isRunning;
 165     TextEditor* resultsBox;
 166     int deviceInputLatency, deviceOutputLatency;
 167
 168     Array <int> spikes;
 169
 170     void createTestSound()
 171     {
 172         const int length = ((int) sampleRate) / 4;
 173         testSound.setSize (1, length);
 174         testSound.clear();
 175         float* s = testSound.getSampleData (0, 0);
 176
 177         Random rand (0);
 178         rand.setSeedRandomly();
 179
 180         for (int i = 0; i < length; ++i)
 181             s[i] = (rand.nextFloat() - rand.nextFloat() + rand.nextFloat() - rand.nextFloat()) * 0.06f;
 182
 183         spikes.clear();
 184
 185         int spikePos = 0;
 186         int spikeDelta = 50;
 187
 188         while (spikePos < length)
 189         {
 190             spikes.add (spikePos);
 191
 192             s [spikePos] = 0.99f;
 193             s [spikePos + 1] = -0.99f;
 194
 195             spikePos += spikeDelta;
 196             spikeDelta += spikeDelta / 6 + rand.nextInt (5);
 197         }
 198     }
 199
 200     // Searches a buffer for a set of spikes that matches those in the test sound
 201     int findOffsetOfSpikes (const AudioSampleBuffer& buffer) const
 202     {
 203         const float minSpikeLevel = 5.0f;
 204         const double smooth = 0.975;
 205         const float* s = buffer.getSampleData (0, 0);
 206         const int spikeDriftAllowed = 5;
 207
 208         Array <int> spikesFound;
 209         spikesFound.ensureStorageAllocated (100);
 210         double runningAverage = 0;
 211         int lastSpike = 0;
 212
 213         for (int i = 0; i < buffer.getNumSamples() - 10; ++i)
 214         {
 215             const float samp = fabsf (s[i]);
 216
 217             if (samp > runningAverage * minSpikeLevel && i > lastSpike + 20)
 218             {
 219                 lastSpike = i;
 220                 spikesFound.add (i);
 221             }
 222
 223             runningAverage = runningAverage * smooth + (1.0 - smooth) * samp;
 224         }
 225
 226         int bestMatch = -1;
 227         int bestNumMatches = spikes.size() / 3; // the minimum number of matches required
 228
 229         if (spikesFound.size() < bestNumMatches)
 230             return -1;
 231
 232         for (int offsetToTest = 0; offsetToTest < buffer.getNumSamples() - 2048; ++offsetToTest)
 233         {
 234             int numMatchesHere = 0;
 235             int foundIndex = 0;
 236
 237             for (int refIndex = 0; refIndex < spikes.size(); ++refIndex)
 238             {
 239                 const int referenceSpike = spikes.getUnchecked (refIndex) + offsetToTest;
 240                 int spike = 0;
 241
 242                 while ((spike = spikesFound.getUnchecked (foundIndex)) < referenceSpike - spikeDriftAllowed
 243                          && foundIndex < spikesFound.size() - 1)
 244                     ++foundIndex;
 245
 246                 if (spike >= referenceSpike - spikeDriftAllowed && spike <= referenceSpike + spikeDriftAllowed)
 247                     ++numMatchesHere;
 248             }
 249
 250             if (numMatchesHere > bestNumMatches)
 251             {
 252                 bestNumMatches = numMatchesHere;
 253                 bestMatch = offsetToTest;
 254
 255                 if (numMatchesHere == spikes.size())
 256                     break;
 257             }
 258         }
 259
 260         return bestMatch;
 261     }
 262
 263     int calculateLatencySamples() const
 264     {
 265         // Detect the sound in both our test sound and the recording of it, and measure the difference
 266         // in their start times..
 267         const int referenceStart = findOffsetOfSpikes (testSound);
 268         jassert (referenceStart >= 0);
 269
 270         const int recordedStart = findOffsetOfSpikes (recordedSound);
 271
 272         return (recordedStart < 0) ? -1 : (recordedStart - referenceStart);
 273     }
 274
 275     LatencyTester (const LatencyTester&);
 276     LatencyTester& operator= (const LatencyTester&);
 277 };
 278
 279
 280 //[/MiscUserDefs]
 281
 282 //==============================================================================
 283 AudioDemoLatencyPage::AudioDemoLatencyPage (AudioDeviceManager& deviceManager_)
 284     : deviceManager (deviceManager_),
 285       liveAudioDisplayComp (0),
 286       startTestButton (0),
 287       testResultsBox (0)
 288 {
 289     addAndMakeVisible (liveAudioDisplayComp = new LiveAudioInputDisplayComp());
 290
 291     addAndMakeVisible (startTestButton = new TextButton (String::empty));
 292     startTestButton->setButtonText (L"Test Latency");
 293     startTestButton->addListener (this);
 294
 295     addAndMakeVisible (testResultsBox = new TextEditor (String::empty));
 296     testResultsBox->setMultiLine (true);
 297     testResultsBox->setReturnKeyStartsNewLine (true);
 298     testResultsBox->setReadOnly (true);
 299     testResultsBox->setScrollbarsShown (true);
 300     testResultsBox->setCaretVisible (false);
 301     testResultsBox->setPopupMenuEnabled (true);
 302     testResultsBox->setColour (TextEditor::backgroundColourId, Colour (0x32ffffff));
 303     testResultsBox->setColour (TextEditor::outlineColourId, Colour (0x1c000000));
 304     testResultsBox->setColour (TextEditor::shadowColourId, Colour (0x16000000));
 305     testResultsBox->setText (L"Running this test measures the round-trip latency between the audio output and input devices you\'ve got selected.\n\nIt\'ll play a sound, then try to measure the time at which the sound arrives back at the audio input. Obviously for this to work you need to have your microphone somewhere near your speakers...");
 306
 307
 308     //[UserPreSize]
 309     //[/UserPreSize]
 310
 311     setSize (600, 400);
 312
 313
 314     //[Constructor] You can add your own custom stuff here..
 315     deviceManager.addAudioCallback (liveAudioDisplayComp);
 316
 317     latencyTester = new LatencyTester (testResultsBox);
 318     deviceManager.addAudioCallback (latencyTester);
 319     //[/Constructor]
 320 }
 321
 322 AudioDemoLatencyPage::~AudioDemoLatencyPage()
 323 {
 324     //[Destructor_pre]. You can add your own custom destruction code here..
 325     deviceManager.removeAudioCallback (liveAudioDisplayComp);
 326
 327     deviceManager.removeAudioCallback (latencyTester);
 328     //[/Destructor_pre]
 329
 330     deleteAndZero (liveAudioDisplayComp);
 331     deleteAndZero (startTestButton);
 332     deleteAndZero (testResultsBox);
 333
 334
 335     //[Destructor]. You can add your own custom destruction code here..
 336     //[/Destructor]
 337 }
 338
 339 //==============================================================================
 340 void AudioDemoLatencyPage::paint (Graphics& g)
 341 {
 342     //[UserPrePaint] Add your own custom painting code here..
 343     //[/UserPrePaint]
 344
 345     g.fillAll (Colours::lightgrey);
 346
 347     //[UserPaint] Add your own custom painting code here..
 348     //[/UserPaint]
 349 }
 350
 351 void AudioDemoLatencyPage::resized()
 352 {
 353     liveAudioDisplayComp->setBounds (8, 8, getWidth() - 16, 64);
 354     startTestButton->setBounds (8, getHeight() - 41, 168, 32);
 355     testResultsBox->setBounds (8, 88, getWidth() - 16, getHeight() - 137);
 356     //[UserResized] Add your own custom resize handling here..
 357     //[/UserResized]
 358 }
 359
 360 void AudioDemoLatencyPage::buttonClicked (Button* buttonThatWasClicked)
 361 {
 362     //[UserbuttonClicked_Pre]
 363     //[/UserbuttonClicked_Pre]
 364
 365     if (buttonThatWasClicked == startTestButton)
 366     {
 367         //[UserButtonCode_startTestButton] -- add your button handler code here..
 368         latencyTester->beginTest();
 369         //[/UserButtonCode_startTestButton]
 370     }
 371
 372     //[UserbuttonClicked_Post]
 373     //[/UserbuttonClicked_Post]
 374 }
 375
 376
 377
 378 //[MiscUserCode] You can add your own definitions of your custom methods or any other code here...
 379 //[/MiscUserCode]
 380
 381
 382 //==============================================================================
 383 #if 0
 384 /*  -- Jucer information section --
 385
 386     This is where the Jucer puts all of its metadata, so don't change anything in here!
 387
 388 BEGIN_JUCER_METADATA
 389
 390 <JUCER_COMPONENT documentType="Component" className="AudioDemoLatencyPage" componentName=""
 391                  parentClasses="public Component" constructorParams="AudioDeviceManager&amp; deviceManager_"
 392                  variableInitialisers="deviceManager (deviceManager_)" snapPixels="8"
 393                  snapActive="1" snapShown="1" overlayOpacity="0.330000013" fixedSize="0"
 394                  initialWidth="600" initialHeight="400">
 395   <BACKGROUND backgroundColour="ffd3d3d3"/>
 396   <GENERICCOMPONENT name="" id="7d70eb2617f56220" memberName="liveAudioDisplayComp"
 397                     virtualName="" explicitFocusOrder="0" pos="8 8 16M 64" class="LiveAudioInputDisplayComp"
 398                     params=""/>
 399   <TEXTBUTTON name="" id="83ed8fcbf36419df" memberName="startTestButton" virtualName=""
 400               explicitFocusOrder="0" pos="8 41R 168 32" buttonText="Test Latency"
 401               connectedEdges="0" needsCallback="1" radioGroupId="0"/>
 402   <TEXTEDITOR name="" id="95d03a8403bc35da" memberName="testResultsBox" virtualName=""
 403               explicitFocusOrder="0" pos="8 88 16M 137M" bkgcol="32ffffff"
 404               outlinecol="1c000000" shadowcol="16000000" initialText="Running this test measures the round-trip latency between the audio output and input devices you've got selected.&#10;&#10;It'll play a sound, then try to measure the time at which the sound arrives back at the audio input. Obviously for this to work you need to have your microphone somewhere near your speakers..."
 405               multiline="1" retKeyStartsLine="1" readonly="1" scrollbars="1"
 406               caret="0" popupmenu="1"/>
 407 </JUCER_COMPONENT>
 408
 409 END_JUCER_METADATA
 410 */
 411 #endif