One of the most common support requests I get for NAudio is how it can be used for streaming MP3. Whilst all the requisite bits and pieces are present in NAudio, there has been no good example of how to do this. For NAudio 1.5 I will be rectifying this to include an example in the NAudioDemo application, and have made a few enhancements to the classes in NAudio to make this easier to implement. In this article I will explain how streaming MP3 playback is implemented in the NAudioDemo application.
The basic design for our streaming playback is that one thread will be downloading the audio, while another thread will play it back. One of the issues this raises is which thread should do the decompression. I have chosen that the download thread should do so. This takes work away from the playback thread and so should give additional protection against stuttering playback, but has the down-side that it requires more memory for buffered audio since it is stored in PCM.
The key class that enables us to queue up samples on one thread for playback on another is called the
IWaveProvider so it can be used as an input to any Wave Output device. When its
Read function is called it returns any bytes buffered, or zeroes the playback buffer if none are available. The
AddSamples function is called from the downloader thread to queue up samples as they become available.
Under the hood, the
BufferedWaveProvider in NAudio 1.4 used a queue of buffers to store the data. For NAudio 1.5 I am switching to a thread safe circular buffer. This means that memory is allocated once up front, and should result in better performance. By default it buffers enough for five seconds of audio, but this can be easily changed using
BufferDuration (although once you start reading, the buffer size is fixed). It also makes more sense to track the number of buffered bytes (a helper method,
BufferedDuration, turns this into a
TimeSpan) instead of the number of queued buffers.
Parsing MP3 Frames
One if the issues that people quickly run into when attempting to play back streaming MP3 is that the
MP3Frame class will throw an exception if it can’t read enough bytes to fully load an MP3 frame. Obviously while you are streaming you may well have half an MP3 frame available.
The solution is fairly simple. We wrap our network stream in a
ReadFullyStream, which is just a simple class inheriting from
System.IO.Stream that will not return from its
Read method until it has read the number of bytes requested or the source stream reaches its end. The
ReadFullyStream currently resides in the NAudioDemo project, but may be incorporated as a helper utility for NAudio 1.5.
Once you have parsed a complete MP3 frame, it is time to decompress it so we can buffer the PCM audio. NAudio includes a choice of two MP3 frame decompressors, one using the ACM codecs, which should be present on Windows XP onwards, and one for using the DMO (DirectX Media Object) decoder, which is available with Windows Vista onwards. These two classes were internal with NAudio 1.4, but will be made public for NAudio 1.5. You could alternatively use a fully managed MP3 decoder, such as NLayer which is my C# port of the Java MP3 decoder JavaLayer. If I get time I will update NAudioDemo to allow you to select between the available frame decompressors.
One of the trickiest design issues to work around is the fact that we don’t know the WaveFormat that the
BufferedWaveProvider should output until we have read the first MP3 frame. Most MP3s decompress to stereo 44.1kHz, but some are 48kHz or 22.1kHz, and others are mono. We therefore can’t open the soundcard yet because we don’t know what PCM format we will be supplying it with.
There are two ways you can tackle this problem. First you can choose a PCM format (e.g. 44.1kHz stereo) that you will convert the decompressed MP3 frames to even if they are of a different sample rate or channel count. Alternatively, as I have chosen for the demo, you hold back from creating the
BufferedWaveProvider until you have received the first MP3 frame and therefore know what format you will convert to.
In the NAudioDemo project this is handled by a timer running on the form periodically checking to see if we have a
BufferedWaveProvider yet. Once the
BufferedWaveProvider appears, we can initialise our
One of the problems with playing back from a network stream is that we may get stuttering audio if the MP3 file is not downloading fast enough. Although the
BufferedWaveProvider will continuously provide data to the soundcard, it could be very choppy if you are experiencing slow download speeds as there would be gaps between each decompressed frame.
For this reason, it is a good idea for the playback thread to go into pause when the buffered audio has run out, but not start playing again until there are at least a couple of seconds of buffered audio. This is accomplished in the NAudioDemo with a simple timer on the GUI thread firing four times a second and deciding if we should go into our come out of pause.
End of Stream
If you are streaming from internet radio, then there is no end of stream, you just keep listening until you have had enough. However, if you are streaming an MP3 file, it will come to an end at some point.
The first consequence is that our
MP3Frame constructor will throw an
EndOfStream exception because it was trying to read a new
MP3Frame and got to the end of the stream. Handling this is straightforward – the downloader thread can capture this exception and exit, knowing we have got everything. I am considering improving the API for the
MP3Frame to include a TryParse option so you can deal with this case without the need for catching exceptions.
The other issue is that the playback thread needs to know that the end of the file has been reached, otherwise it will go into pause, waiting for more audio to be buffered that will never arrive. A simple way to deal with this is to set a flag indicating that the whole stream has been read and that we no longer need to go into a buffering state.
Try It Yourself
The code is all checked in and will be part of NAudio 1.5. To try it yourself, go to the NAudio GitHub page and download the latest code. Here’s a screenshot of the NAudioDemo application playing from an internet radio stream: