common/JackAudioAdapterInterface.cpp

   1 /*
   2 Copyright (C) 2008 Grame
   3
   4 This program is free software; you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation; either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "JackAudioAdapter.h"
  21 #include "JackLibSampleRateResampler.h"
  22 #include "JackTime.h"
  23 #include <stdio.h>
  24
  25 namespace Jack
  26 {
  27
  28 #ifdef JACK_MONITOR
  29
  30     void MeasureTable::Write(int time1, int time2, float r1, float r2, int pos1, int pos2)
  31     {
  32         int pos = (++fCount) % TABLE_MAX;
  33         fTable[pos].time1 = time1;
  34         fTable[pos].time2 = time2;
  35         fTable[pos].r1 = r1;
  36         fTable[pos].r2 = r2;
  37         fTable[pos].pos1 = pos1;
  38         fTable[pos].pos2 = pos2;
  39     }
  40
  41     void MeasureTable::Save(unsigned int fHostBufferSize, unsigned int fHostSampleRate, unsigned int fAdaptedSampleRate, unsigned int fAdaptedBufferSize)
  42     {
  43         char buffer[1024];
  44         FILE* file = fopen("JackAudioAdapter.log", "w");
  45
  46         int max = (fCount) % TABLE_MAX - 1;
  47         for (int i = 1; i < max; i++)
  48         {
  49             fprintf(file, "%d \t %d \t %d  \t %f \t %f \t %d \t %d \n",
  50                     fTable[i].delta, fTable[i].time1, fTable[i].time2,
  51                     fTable[i].r1, fTable[i].r2, fTable[i].pos1, fTable[i].pos2);
  52         }
  53         fclose(file);
  54
  55         // No used for now
  56         // Adapter timing 1
  57         file = fopen("AdapterTiming1.plot", "w");
  58         fprintf(file, "set multiplot\n");
  59         fprintf(file, "set grid\n");
  60         fprintf(file, "set title \"Audio adapter timing: host [rate = %.1f kHz buffer = %d frames] adapter [rate = %.1f kHz buffer = %d frames] \"\n"
  61             ,float(fHostSampleRate)/1000.f, fHostBufferSize, float(fAdaptedSampleRate)/1000.f, fAdaptedBufferSize);
  62         fprintf(file, "set xlabel \"audio cycles\"\n");
  63         fprintf(file, "set ylabel \"frames\"\n");
  64         fprintf(file, "plot ");
  65         sprintf(buffer, "\"JackAudioAdapter.log\" using 2 title \"Ringbuffer error\" with lines,");
  66         fprintf(file, buffer);
  67         sprintf(buffer, "\"JackAudioAdapter.log\" using 3 title \"Ringbuffer error with timing correction\" with lines");
  68         fprintf(file, buffer);
  69
  70         fprintf(file, "\n unset multiplot\n");
  71         fprintf(file, "set output 'AdapterTiming1.svg\n");
  72         fprintf(file, "set terminal svg\n");
  73
  74         fprintf(file, "set multiplot\n");
  75         fprintf(file, "set grid\n");
  76         fprintf(file, "set title \"Audio adapter timing: host [rate = %.1f kHz buffer = %d frames] adapter [rate = %.1f kHz buffer = %d frames] \"\n"
  77             ,float(fHostSampleRate)/1000.f, fHostBufferSize, float(fAdaptedSampleRate)/1000.f, fAdaptedBufferSize);
  78         fprintf(file, "set xlabel \"audio cycles\"\n");
  79         fprintf(file, "set ylabel \"frames\"\n");
  80         fprintf(file, "plot ");
  81         sprintf(buffer, "\"JackAudioAdapter.log\" using 2 title \"Consumer interrupt period\" with lines,");
  82         fprintf(file, buffer);
  83         sprintf(buffer, "\"JackAudioAdapter.log\" using 3 title \"Producer interrupt period\" with lines\n");
  84         fprintf(file, buffer);
  85         fprintf(file, "unset multiplot\n");
  86         fprintf(file, "unset output\n");
  87
  88         fclose(file);
  89
  90         // Adapter timing 2
  91         file = fopen("AdapterTiming2.plot", "w");
  92         fprintf(file, "set multiplot\n");
  93         fprintf(file, "set grid\n");
  94         fprintf(file, "set title \"Audio adapter timing: host [rate = %.1f kHz buffer = %d frames] adapter [rate = %.1f kHz buffer = %d frames] \"\n"
  95             ,float(fHostSampleRate)/1000.f, fHostBufferSize, float(fAdaptedSampleRate)/1000.f, fAdaptedBufferSize);
  96         fprintf(file, "set xlabel \"audio cycles\"\n");
  97         fprintf(file, "set ylabel \"resampling ratio\"\n");
  98         fprintf(file, "plot ");
  99         sprintf(buffer, "\"JackAudioAdapter.log\" using 4 title \"Ratio 1\" with lines,");
 100         fprintf(file, buffer);
 101         sprintf(buffer, "\"JackAudioAdapter.log\" using 5 title \"Ratio 2\" with lines");
 102         fprintf(file, buffer);
 103
 104         fprintf(file, "\n unset multiplot\n");
 105         fprintf(file, "set output 'AdapterTiming2.svg\n");
 106         fprintf(file, "set terminal svg\n");
 107
 108         fprintf(file, "set multiplot\n");
 109         fprintf(file, "set grid\n");
 110         fprintf(file, "set title \"Audio adapter timing: host [rate = %.1f kHz buffer = %d frames] adapter [rate = %.1f kHz buffer = %d frames] \"\n"
 111             ,float(fHostSampleRate)/1000.f, fHostBufferSize, float(fAdaptedSampleRate)/1000.f, fAdaptedBufferSize);
 112         fprintf(file, "set xlabel \"audio cycles\"\n");
 113         fprintf(file, "set ylabel \"resampling ratio\"\n");
 114         fprintf(file, "plot ");
 115         sprintf(buffer, "\"JackAudioAdapter.log\" using 4 title \"Ratio 1\" with lines,");
 116         fprintf(file, buffer);
 117         sprintf(buffer, "\"JackAudioAdapter.log\" using 5 title \"Ratio 2\" with lines\n");
 118         fprintf(file, buffer);
 119         fprintf(file, "unset multiplot\n");
 120         fprintf(file, "unset output\n");
 121
 122         fclose(file);
 123
 124         // Adapter timing 3
 125         file = fopen("AdapterTiming3.plot", "w");
 126         fprintf(file, "set multiplot\n");
 127         fprintf(file, "set grid\n");
 128         fprintf(file, "set title \"Audio adapter timing: host [rate = %.1f kHz buffer = %d frames] adapter [rate = %.1f kHz buffer = %d frames] \"\n"
 129             ,float(fHostSampleRate)/1000.f, fHostBufferSize, float(fAdaptedSampleRate)/1000.f, fAdaptedBufferSize);
 130          fprintf(file, "set xlabel \"audio cycles\"\n");
 131         fprintf(file, "set ylabel \"frames\"\n");
 132         fprintf(file, "plot ");
 133         sprintf(buffer, "\"JackAudioAdapter.log\" using 6 title \"Frames position in consumer ringbuffer\" with lines,");
 134         fprintf(file, buffer);
 135         sprintf(buffer, "\"JackAudioAdapter.log\" using 7 title \"Frames position in producer ringbuffer\" with lines");
 136         fprintf(file, buffer);
 137
 138         fprintf(file, "\n unset multiplot\n");
 139         fprintf(file, "set output 'AdapterTiming3.svg\n");
 140         fprintf(file, "set terminal svg\n");
 141
 142         fprintf(file, "set multiplot\n");
 143         fprintf(file, "set grid\n");
 144         fprintf(file, "set title \"Audio adapter timing: host [rate = %.1f kHz buffer = %d frames] adapter [rate = %.1f kHz buffer = %d frames] \"\n"
 145             ,float(fHostSampleRate)/1000.f, fHostBufferSize, float(fAdaptedSampleRate)/1000.f, fAdaptedBufferSize);
 146         fprintf(file, "set xlabel \"audio cycles\"\n");
 147         fprintf(file, "set ylabel \"frames\"\n");
 148         fprintf(file, "plot ");
 149         sprintf(buffer, "\"JackAudioAdapter.log\" using 6 title \"Frames position in consumer ringbuffer\" with lines,");
 150         fprintf(file, buffer);
 151         sprintf(buffer, "\"JackAudioAdapter.log\" using 7 title \"Frames position in producer ringbuffer\" with lines\n");
 152         fprintf(file, buffer);
 153         fprintf(file, "unset multiplot\n");
 154         fprintf(file, "unset output\n");
 155
 156         fclose(file);
 157     }
 158
 159 #endif
 160
 161     void JackAudioAdapterInterface::GrowRingBufferSize()
 162     {
 163         fRingbufferCurSize *= 2;
 164     }
 165
 166     void JackAudioAdapterInterface::AdaptRingBufferSize()
 167     {
 168         if (fHostBufferSize > fAdaptedBufferSize)
 169             fRingbufferCurSize = 4 * fHostBufferSize;
 170         else
 171             fRingbufferCurSize = 4 * fAdaptedBufferSize;
 172     }
 173
 174     void JackAudioAdapterInterface::ResetRingBuffers()
 175     {
 176         if (fRingbufferCurSize > DEFAULT_RB_SIZE)
 177             fRingbufferCurSize = DEFAULT_RB_SIZE;
 178
 179         for (int i = 0; i < fCaptureChannels; i++)
 180             fCaptureRingBuffer[i]->Reset(fRingbufferCurSize);
 181         for (int i = 0; i < fPlaybackChannels; i++)
 182             fPlaybackRingBuffer[i]->Reset(fRingbufferCurSize);
 183     }
 184
 185     void JackAudioAdapterInterface::Reset()
 186     {
 187         ResetRingBuffers();
 188         fRunning = false;
 189     }
 190
 191     void JackAudioAdapterInterface::Create()
 192     {
 193         //ringbuffers
 194         fCaptureRingBuffer = new JackResampler*[fCaptureChannels];
 195         fPlaybackRingBuffer = new JackResampler*[fPlaybackChannels];
 196
 197         if (fAdaptative) {
 198             AdaptRingBufferSize();
 199             jack_info("Ringbuffer automatic adaptative mode size = %d frames", fRingbufferCurSize);
 200         } else {
 201             if (fRingbufferCurSize > DEFAULT_RB_SIZE)
 202                 fRingbufferCurSize = DEFAULT_RB_SIZE;
 203             jack_info("Fixed ringbuffer size = %d frames", fRingbufferCurSize);
 204         }
 205
 206         for (int i = 0; i < fCaptureChannels; i++ ) {
 207             fCaptureRingBuffer[i] = new JackLibSampleRateResampler(fQuality);
 208             fCaptureRingBuffer[i]->Reset(fRingbufferCurSize);
 209         }
 210         for (int i = 0; i < fPlaybackChannels; i++ ) {
 211             fPlaybackRingBuffer[i] = new JackLibSampleRateResampler(fQuality);
 212             fPlaybackRingBuffer[i]->Reset(fRingbufferCurSize);
 213         }
 214
 215         if (fCaptureChannels > 0)
 216             jack_log("ReadSpace = %ld", fCaptureRingBuffer[0]->ReadSpace());
 217         if (fPlaybackChannels > 0)
 218             jack_log("WriteSpace = %ld", fPlaybackRingBuffer[0]->WriteSpace());
 219     }
 220
 221     void JackAudioAdapterInterface::Destroy()
 222     {
 223         for (int i = 0; i < fCaptureChannels; i++ )
 224             delete ( fCaptureRingBuffer[i] );
 225         for (int i = 0; i < fPlaybackChannels; i++ )
 226             delete ( fPlaybackRingBuffer[i] );
 227
 228         delete[] fCaptureRingBuffer;
 229         delete[] fPlaybackRingBuffer;
 230     }
 231
 232     int JackAudioAdapterInterface::PushAndPull(float** inputBuffer, float** outputBuffer, unsigned int frames)
 233     {
 234         bool failure = false;
 235         fRunning = true;
 236
 237         // Finer estimation of the position in the ringbuffer
 238         int delta_frames = (fPullAndPushTime > 0) ? (int)((float(long(GetMicroSeconds() - fPullAndPushTime)) * float(fAdaptedSampleRate)) / 1000000.f) : 0;
 239
 240         double ratio = 1;
 241
 242         // TODO : done like this just to avoid crash when input only or output only...
 243         if (fCaptureChannels > 0)
 244             ratio = fPIControler.GetRatio(fCaptureRingBuffer[0]->GetError() - delta_frames);
 245         else if (fPlaybackChannels > 0)
 246             ratio = fPIControler.GetRatio(fPlaybackRingBuffer[0]->GetError() - delta_frames);
 247
 248     #ifdef JACK_MONITOR
 249         if (fCaptureRingBuffer[0] != NULL)
 250             fTable.Write(fCaptureRingBuffer[0]->GetError(), fCaptureRingBuffer[0]->GetError() - delta_frames, ratio, 1/ratio, fCaptureRingBuffer[0]->ReadSpace(), fCaptureRingBuffer[0]->ReadSpace());
 251     #endif
 252
 253         // Push/pull from ringbuffer
 254         for (int i = 0; i < fCaptureChannels; i++) {
 255             fCaptureRingBuffer[i]->SetRatio(ratio);
 256             if (fCaptureRingBuffer[i]->WriteResample(inputBuffer[i], frames) < frames)
 257                 failure = true;
 258         }
 259
 260         for (int i = 0; i < fPlaybackChannels; i++) {
 261             fPlaybackRingBuffer[i]->SetRatio(1/ratio);
 262             if (fPlaybackRingBuffer[i]->ReadResample(outputBuffer[i], frames) < frames)
 263                  failure = true;
 264         }
 265         // Reset all ringbuffers in case of failure
 266         if (failure) {
 267             jack_error("JackAudioAdapterInterface::PushAndPull ringbuffer failure... reset");
 268             if (fAdaptative) {
 269                 GrowRingBufferSize();
 270                 jack_info("Ringbuffer size = %d frames", fRingbufferCurSize);
 271             }
 272             ResetRingBuffers();
 273             return -1;
 274         } else {
 275             return 0;
 276         }
 277     }
 278
 279     int JackAudioAdapterInterface::PullAndPush(float** inputBuffer, float** outputBuffer, unsigned int frames)
 280     {
 281         fPullAndPushTime = GetMicroSeconds();
 282         if (!fRunning)
 283             return 0;
 284
 285         int res = 0;
 286
 287         // Push/pull from ringbuffer
 288         for (int i = 0; i < fCaptureChannels; i++) {
 289             if (fCaptureRingBuffer[i]->Read(inputBuffer[i], frames) < frames)
 290                 res = -1;
 291         }
 292
 293         for (int i = 0; i < fPlaybackChannels; i++) {
 294             if (fPlaybackRingBuffer[i]->Write(outputBuffer[i], frames) < frames)
 295                 res = -1;
 296         }
 297
 298         return res;
 299     }
 300
 301 } // namespace