Clean up streamed and processed buffers

redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/audio/AudioRenderer.groovy

@@ -30,15 +30,6 @@ import java.nio.ByteBuffer
  */
 interface AudioRenderer {
 
-	/**
-	 * Return the number of buffers that have been processed for the given source,
-	 * which is the number of buffers that can be safely unqueued from the source.
-	 *
-	 * @param sourceId
-	 * @return Number of processed buffers.
-	 */
-	int buffersProcessed(int sourceId)
-
 	/**
 	 * Creates and fills a sound buffer with the given data.
 	 *
@@ -71,22 +62,6 @@ interface AudioRenderer {
 	 */
 	void deleteSource(Source source)
 
-	/**
-	 * Queue some buffers to an existing source.
-	 *
-	 * @param sourceId
-	 * @param bufferIds
-	 */
-	void queueBuffers(int sourceId, int ... bufferId)
-
-	/**
-	 * Unqueue some buffers from an existing source.
-	 *
-	 * @param sourceId
-	 * @param bufferIds
-	 */
-	void unqueueBuffers(int sourceId, int ... bufferId)
-
 	/**
 	 * Update details about the listener.
 	 *

redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/audio/Source.groovy

@@ -30,6 +30,14 @@ abstract class Source implements AudioResource {
 	 */
 	abstract void attachBuffer(Buffer buffer)
 
+	/**
+	 * Return the number of queued buffers that have been processed for this
+	 * source.
+	 *
+	 * @return Number of processed buffers.
+	 */
+	abstract int buffersProcessed()
+
 	/**
 	 * Rether whether this source is currently paused.
 	 *
@@ -79,4 +87,9 @@ abstract class Source implements AudioResource {
 	 * Stop playing the sound through this source.
 	 */
 	abstract void stop()
+
+	/**
+	 * Unqueue buffers from this source.
+	 */
+	abstract void unqueueBuffers(Buffer... buffers)
 }

redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/audio/openal/OpenALRenderer.groovy

@@ -74,12 +74,6 @@ class OpenALRenderer implements AudioRenderer, EventTarget {
 		return result
 	}
 
-	@Override
-	int buffersProcessed(int sourceId) {
-
-		return checkForError { -> alGetSourcei(sourceId, AL_BUFFERS_PROCESSED) }
-	}
-
 	@Override
 	Buffer createBuffer(int bits, int channels, int frequency, ByteBuffer data) {
 
@@ -109,12 +103,6 @@ class OpenALRenderer implements AudioRenderer, EventTarget {
 		trigger(new SourceDeletedEvent(source))
 	}
 
-	@Override
-	void queueBuffers(int sourceId, int ... bufferIds) {
-
-		checkForError { -> alSourceQueueBuffers(sourceId, bufferIds) }
-	}
-
 	/**
 	 * Emit some information about the OpenAL rendering device.
 	 *
@@ -131,12 +119,6 @@ class OpenALRenderer implements AudioRenderer, EventTarget {
 		""".stripIndent()
 	}
 
-	@Override
-	void unqueueBuffers(int sourceId, int ... bufferIds) {
-
-		checkForError { -> alSourceUnqueueBuffers(sourceId, bufferIds) }
-	}
-
 	@Override
 	void updateListener(Vector3f position, Vector3f velocity, Orientation orientation) {
 

redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/audio/openal/OpenALSource.groovy

@@ -51,6 +51,12 @@ class OpenALSource extends Source {
 		}
 	}
 
+	@Override
+	int buffersProcessed() {
+
+		return alGetSourcei(sourceId, AL_BUFFERS_PROCESSED)
+	}
+
 	@Override
 	void close() {
 
@@ -108,7 +114,7 @@ class OpenALSource extends Source {
 	@Override
 	void queueBuffers(Buffer... buffers) {
 
-		alSourceQueueBuffers(sourceId, ((OpenALBuffer[])buffers)*.bufferId as int[])
+		alSourceQueueBuffers(sourceId, *((OpenALBuffer[])buffers)*.bufferId)
 	}
 
 	@Override
@@ -124,4 +130,10 @@ class OpenALSource extends Source {
 			alSourceStop(sourceId)
 		}
 	}
+
+	@Override
+	void unqueueBuffers(Buffer... buffers) {
+
+		alSourceUnqueueBuffers(sourceId, *((OpenALBuffer[])buffers)*.bufferId)
+	}
 }

redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/scenegraph/nodes/Sound.groovy

@@ -36,6 +36,7 @@ import groovy.transform.TupleConstructor
 import java.util.concurrent.ArrayBlockingQueue
 import java.util.concurrent.BlockingQueue
 import java.util.concurrent.Executors
+import java.util.concurrent.LinkedBlockingQueue
 
 /**
  * An emitter of sound in the scene.
@@ -52,7 +53,7 @@ class Sound implements Node<Sound>, AudioElement, Playable {
 	private Source source
 	private Buffer staticBuffer
 	private BlockingQueue<Buffer> streamingBuffers = new ArrayBlockingQueue<>(10)
-	private final List<Buffer> streamedBuffers = []
+	private final BlockingQueue<Buffer> streamedBuffers = new LinkedBlockingQueue<>()
 
 	@Override
 	void delete(AudioRenderer renderer) {
@@ -99,7 +100,7 @@ class Sound implements Node<Sound>, AudioElement, Playable {
 		if (staticBuffer) {
 			scene.requestDelete(staticBuffer)
 		}
-		if (streamingBuffers) {
+		if (streamedBuffers) {
 			scene.requestDelete(*streamedBuffers)
 		}
 	}
@@ -111,6 +112,7 @@ class Sound implements Node<Sound>, AudioElement, Playable {
 			return
 		}
 
+		// Add static or streaming buffers to the source
 		if (staticBuffer) {
 			source.attachBuffer(staticBuffer)
 		}
@@ -120,6 +122,7 @@ class Sound implements Node<Sound>, AudioElement, Playable {
 			streamedBuffers.addAll(newBuffers)
 		}
 
+		// Control playback
 		if (playing) {
 			if (source.stopped) {
 				logger.debug("Buffer exhausted, stopping")
@@ -143,5 +146,15 @@ class Sound implements Node<Sound>, AudioElement, Playable {
 				source.stop()
 			}
 		}
+
+		// Clean up used buffers for a streaming source
+		if (soundFile.forStreaming) {
+			var buffersProcessed = source.buffersProcessed()
+			if (buffersProcessed) {
+				var processedBuffers = streamedBuffers.drain(buffersProcessed)
+				source.unqueueBuffers(*processedBuffers)
+				renderer.deleteBuffers(*processedBuffers)
+			}
+		}
 	}
 }