Add debugging to the ring buffers.

RingBuffer.h

@@ -1,5 +1,5 @@
 /*
- *   Copyright (C) 2006-2009,2012,2013,2015 by Jonathan Naylor G4KLX
+ *   Copyright (C) 2006-2009,2012,2013,2015,2016 by Jonathan Naylor G4KLX
  *
  *   This program is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
@@ -19,18 +19,24 @@
 #ifndef RingBuffer_H
 #define RingBuffer_H
 
+#include "Log.h"
+
+#include <cstdio>
 #include <cassert>
 #include <cstring>
 
 template<class T> class CRingBuffer {
 public:
-	CRingBuffer(unsigned int length) :
+	CRingBuffer(unsigned int length, const char* name) :
 	m_length(length),
+	m_name(name),
 	m_buffer(NULL),
 	m_iPtr(0U),
-	m_oPtr(0U)
+	m_oPtr(0U),
+	m_full(false)
 	{
 		assert(length > 0U);
+		assert(name != NULL);
 
 		m_buffer = new T[length];
 
@@ -42,19 +48,24 @@ public:
 		delete[] m_buffer;
 	}
 
-	unsigned int addData(const T* buffer, unsigned int nSamples)
+	bool addData(const T* buffer, unsigned int nSamples)
 	{
-		if (nSamples > freeSpace())
-			return 0U;
-
 		for (unsigned int i = 0U; i < nSamples; i++) {
+			if (m_full) {
+				LogError("**** Overflow in %s ring buffer", m_name);
+				return false;
+			}
+
 			m_buffer[m_iPtr++] = buffer[i];
 
 			if (m_iPtr == m_length)
 				m_iPtr = 0U;
+
+			if (m_iPtr == m_oPtr)
+				m_full = true;
 		}
 
-		return nSamples;
+		return true;
 	}
 
 	unsigned int getData(T* buffer, unsigned int nSamples)
@@ -65,6 +76,8 @@ public:
 			nSamples = data;
 
 		for (unsigned int i = 0U; i < nSamples; i++) {
+			m_full = false;
+
 			buffer[i] = m_buffer[m_oPtr++];
 
 			if (m_oPtr == m_length)
@@ -94,21 +107,30 @@ public:
 
 	void clear()
 	{
-		m_iPtr  = 0U;
-		m_oPtr  = 0U;
+		m_iPtr = 0U;
+		m_oPtr = 0U;
+		m_full = false;
 
 		::memset(m_buffer, 0x00, m_length * sizeof(T));
 	}
 
 	unsigned int freeSpace() const
 	{
-		if (m_oPtr == m_iPtr)
-			return m_length - 1U;
+		if (m_oPtr == m_iPtr && !m_full)
+			return m_length;
 
-		if (m_oPtr > m_iPtr)
-			return m_oPtr - m_iPtr - 1U;
+		if (m_oPtr == m_iPtr && m_full)
+			return 0U;
 
-		return m_length - (m_iPtr - m_oPtr) - 1U;
+		if (m_iPtr > m_oPtr)
+			return m_iPtr - m_oPtr;
+
+		return (m_length + m_iPtr) - m_oPtr;
+	}
+
+	unsigned int dataSize() const
+	{
+		return m_length - freeSpace();
 	}
 
 	bool hasSpace(unsigned int length) const
@@ -118,27 +140,21 @@ public:
 
 	bool hasData() const
 	{
-		return m_oPtr != m_iPtr;
+		return m_oPtr != m_iPtr || (m_oPtr == m_iPtr && m_full);
 	}
 
 	bool isEmpty() const
 	{
-		return m_oPtr == m_iPtr;
+		return m_oPtr == m_iPtr && !m_full;
 	}
 
 private:
 	unsigned int          m_length;
+	const char*           m_name;
 	T*                    m_buffer;
 	volatile unsigned int m_iPtr;
 	volatile unsigned int m_oPtr;
-
-	unsigned int dataSize() const
-	{
-		if (m_iPtr >= m_oPtr)
-			return m_iPtr - m_oPtr;
-
-		return m_length - (m_oPtr - m_iPtr);
-	}
+	volatile bool         m_full;
 };
 
 #endif