Store over/underflows

Author: mgeier

examples/delay.py

@@ -23,4 +23,8 @@
     stream.record_ringbuffer(q, start=start, allow_belated=False)
     stream.play_ringbuffer(q, start=start + delay, allow_belated=False)
     # TODO: check if start was successful
+    print('#' * 80)
+    print('press Return to quit')
+    print('#' * 80)
     input()
+# TODO: check xruns

examples/plot_input.py

@@ -74,5 +74,6 @@ def update_plot(frame):
 with stream:
     elementsize = channels * stream.samplesize
     q = rtmixer.RingBuffer(elementsize, stepsize * qsize)
-    stream.record_ringbuffer(q)
+    action = stream.record_ringbuffer(q)
     plt.show()
+print('Input overflows:', action.stats.input_overflows)

examples/plot_recording.py

@@ -45,7 +45,8 @@
         m.wait(action)
         buffer = buffer[:action.done_frames]
         t = t[:action.done_frames]
-# TODO: check for xruns
+
+print('Input overflows during recording:', action.stats.input_overflows)
 
 plt.plot(t, buffer)
 plt.xlabel('Time / seconds')

src/rtmixer.c

@@ -33,6 +33,16 @@ void remove_action(struct action** addr, struct state* state)
   }
 }
 
+void get_stats(PaStreamCallbackFlags flags, struct stats* stats)
+{
+  ++stats->blocks;
+
+  if (flags & paInputUnderflow)  { ++stats->input_underflows; }
+  if (flags & paInputOverflow)   { ++stats->input_overflows; }
+  if (flags & paOutputUnderflow) { ++stats->output_underflows; }
+  if (flags & paOutputOverflow)  { ++stats->output_overflows; }
+}
+
 int callback(const void* input, void* output, frame_t frameCount
   , const PaStreamCallbackTimeInfo* timeInfo, PaStreamCallbackFlags statusFlags
   , void* userData)
@@ -42,14 +52,7 @@ int callback(const void* input, void* output, frame_t frameCount
 
   memset(output, 0, sizeof(float) * state->output_channels * frameCount);
 
-  if (statusFlags & paInputUnderflow)  { printf("Input underflow!\n"); }
-  if (statusFlags & paInputOverflow)   { printf("Input overflow!\n"); }
-  if (statusFlags & paOutputUnderflow) { printf("Output underflow!\n"); }
-  if (statusFlags & paOutputOverflow)  { printf("Output overflow!\n"); }
-
-  // TODO: store information about overflows/underflows
-
-  // TODO: check if main thread is still running?
+  get_stats(statusFlags, &(state->stats));
 
   for (struct action* action = NULL
       ; PaUtil_ReadRingBuffer(state->action_q, &action, 1)
@@ -145,6 +148,10 @@ int callback(const void* input, void* output, frame_t frameCount
       continue;
     }
 
+    // Store buffer over-/underflow information
+
+    get_stats(statusFlags, &(action->stats));
+
     // Get number of remaining frames in the current block
 
     frame_t frames = action->total_frames - action->done_frames;

src/rtmixer.h

@@ -10,6 +10,15 @@ enum actiontype
   // TODO: action to query xrun stats etc.?
 };
 
+struct stats
+{
+  frame_t blocks;
+  frame_t input_underflows;
+  frame_t input_overflows;
+  frame_t output_underflows;
+  frame_t output_overflows;
+};
+
 struct action
 {
   const enum actiontype type;
@@ -25,7 +34,7 @@ struct action
   frame_t total_frames;
   frame_t done_frames;
   // TODO: something to store the result of the action?
-  // TODO: number of xruns during the runtime of the current action?
+  struct stats stats;
   // TODO: queue usage: store smallest available write/read size?
   const frame_t channels;  // Size of the following array
   const frame_t mapping[];  // "flexible array member"
@@ -39,6 +48,7 @@ struct state
   PaUtilRingBuffer* const action_q;  // Queue for incoming commands
   PaUtilRingBuffer* const result_q;  // Queue for results and command disposal
   struct action* actions;  // Singly linked list of actions
+  struct stats stats;
 };
 
 int callback(const void* input, void* output, frame_t frameCount