Click here to Skip to main content
15,908,674 members
Articles / Programming Languages / C#
Article

A full-duplex audio player in C# using the waveIn/waveOut APIs

Rate me:
Please Sign up or sign in to vote.
4.75/5 (113 votes)
31 Aug 20033 min read 2.2M   22.3K   262   362
An article on low-level audio capture and playback using the waveIn/waveOut APIs through P/Invoke in C#.

Sample Image - cswavrec.gif

Introduction

As I already mentioned in my article A low-level audio player in C#, there are no built-in classes in the .NET framework for dealing with sound. This holds true not only for audio playback, but also for audio capture.

It should be noted, though, that the Managed DirectX 9 SDK does include classes for high-level and low-level audio manipulation. However, sometimes you don’t want your application to depend on the full DX 9 runtime, just to do basic sound playback and capture, and there are also some areas where Managed DirectSound doesn’t help at all (for example, multi-channel sound playback and capture).

Nevertheless, I strongly recommend you to use Managed DirectSound for sound playback and capture unless you have a good reason for not doing so.

This article describes a sample application that uses the waveIn and waveOut APIs in C# through P/Invoke to capture an audio signal from the sound card’s input, and play it back (almost) at the same time.

Using the code

The sample code reuses the WaveOutPlayer class from my article A low-level audio player in C#. The new classes in this sample are WaveInRecorder and FifoStream.

The FifoStream class extends System.IO.Stream to implement a FIFO (first-in first-out) of bytes. The overridden Write method adds data to the FIFO’s tail, and the Read method peeks and removes data from the FIFO’s head. The Length property returns the amount of buffered data at any time. Calling Flush will clear all pending data.

The WaveInRecorder class is analogous to the WaveOutPlayer class. In fact, if you look at the source files, you’ll notice that the implementations of these classes are very similar. As with WaveOutPlayer, the interface of this class has been reduced to the strict minimum.

Creating an instance of WaveInRecorder will cause the system to start recording immediately. Here’s the code that creates the WaveOutPlayer and WaveInRecorder instances.

C#
private void Start()
{
    Stop();
    try
    {
        WaveLib.WaveFormat fmt = new WaveLib.WaveFormat(44100, 16, 2);
        m_Player = new WaveLib.WaveOutPlayer(-1, fmt, 16384, 3, 
                        new WaveLib.BufferFillEventHandler(Filler));
        m_Recorder = new WaveLib.WaveInRecorder(-1, fmt, 16384, 3, 
                        new WaveLib.BufferDoneEventHandler(DataArrived));
    }
    catch
    {
        Stop();
        throw;
    }
}

The WaveInRecorder constructor takes five parameters. Except for the last parameter, their meaning is the same as in WaveOutPlayer.

The first parameter is the ID of the wave input device that you want to use. The value -1 represents the default system device, but if your system has more than one sound card, then you can pass any number from 0 to the number of installed sound cards minus one, to select a particular device.

The second parameter is the format of the audio samples.

The third and forth parameters are the size of the internal wave buffers and the number of buffers to allocate. You should set these to reasonable values. Smaller buffers will give you less latency, but the captured audio may have gaps on it if your computer is not fast enough.

The fifth and last parameter is a delegate that will be called periodically as internal audio buffers are full of captured data. In the sample application we just write the captured data to the FIFO, like this:

C#
private void DataArrived(IntPtr data, int size)
{
    if (m_RecBuffer == null || m_RecBuffer.Length < size)
        m_RecBuffer = new byte[size];
    System.Runtime.InteropServices.Marshal.Copy(data, m_RecBuffer, 0, size);
    m_Fifo.Write(m_RecBuffer, 0, m_RecBuffer.Length);
}

Similarly, the Filler method is called every time the player needs more data. Our implementation just reads the data from the FIFO, as shown below:

C#
private void Filler(IntPtr data, int size)
{
    if (m_PlayBuffer == null || m_PlayBuffer.Length < size)
        m_PlayBuffer = new byte[size];
    if (m_Fifo.Length >= size)
        m_Fifo.Read(m_PlayBuffer, 0, size);
    else
        for (int i = 0; i < m_PlayBuffer.Length; i++)
            m_PlayBuffer[i] = 0;
    System.Runtime.InteropServices.Marshal.Copy(m_PlayBuffer, 
                                                 0, data, size);
}

Note that we declared the temporary buffers m_RecBuffer and m_PlayBuffer as member fields in order to improve performance by saving some garbage collections.

To stop streaming, just call Dispose on the player and capture objects. We also need to flush the FIFO so that the next time Start is called there is no residual data to play.

C#
private void Stop()
{
    if (m_Player != null)
        try
        {
            m_Player.Dispose();
        }
        finally
        {
            m_Player = null;
        }
    if (m_Recorder != null)
        try
        {
            m_Recorder.Dispose();
        }
        finally
        {
            m_Recorder = null;
        }
    m_Fifo.Flush(); // clear all pending data
}

Conclusion

This sample demonstrates how to combine the waveIn and waveOut APIs in C#. As an exercise, you may want to combine this code with the audio effect framework in the article Programming Audio Effects in C#, to apply effects to a live audio input in real-time, although latency may be an issue for certain applications.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


Written By
Web Developer
Luxembourg Luxembourg
Ianier Munoz lives in France and works as a senior consultant and analyst for an international consulting firm. His specialty is in multimedia applications, and he has authored some popular software, such as American DJ's Pro-Mix, Chronotron and Adapt-X.

Comments and Discussions

 
GeneralRe: pausing playback Pin
Ianier Munoz3-Mar-05 16:57
Ianier Munoz3-Mar-05 16:57 
Generalwrite data to file Pin
Member 168460021-Feb-05 2:50
Member 168460021-Feb-05 2:50 
GeneralRe: write data to file Pin
Ianier Munoz21-Feb-05 3:11
Ianier Munoz21-Feb-05 3:11 
GeneralWith CALLBACK_WINDOW Pin
Filetopia4719-Feb-05 0:26
Filetopia4719-Feb-05 0:26 
GeneralRe: With CALLBACK_WINDOW Pin
Ianier Munoz24-Feb-05 18:48
Ianier Munoz24-Feb-05 18:48 
Generalprogram running... Pin
Anonymous15-Feb-05 8:15
Anonymous15-Feb-05 8:15 
GeneralRe: program running... Pin
Ianier Munoz24-Feb-05 18:40
Ianier Munoz24-Feb-05 18:40 
GeneralRestart a FifoStream object Pin
Ricardo Mendes10-Feb-05 4:33
Ricardo Mendes10-Feb-05 4:33 
In the sample you´ve provided it´s possible to play the data contained in a FifoStream object. However, when all the data is played and I want to play it again, the position is at the end of the stream so it doesn´t play anything.
The FifoStream class doesn´t provide a way to do it. The Position property throws an exception. What´s the right implementation of the Position property so that I can set it to the beginning of the stream?

Thanks
GeneralRe: Restart a FifoStream object Pin
Ianier Munoz10-Feb-05 5:11
Ianier Munoz10-Feb-05 5:11 
QuestionSoucre of noise in buffer ? Pin
Demarina4-Feb-05 6:12
Demarina4-Feb-05 6:12 
AnswerRe: Soucre of noise in buffer ? Pin
Ianier Munoz24-Feb-05 18:35
Ianier Munoz24-Feb-05 18:35 
GeneralWriting sound data real time Pin
redgreen28-Jan-05 16:46
redgreen28-Jan-05 16:46 
GeneralRe: Writing sound data real time Pin
Ianier Munoz28-Jan-05 18:56
Ianier Munoz28-Jan-05 18:56 
GeneralRe: Writing sound data real time Pin
Member 794901113-Aug-11 18:49
Member 794901113-Aug-11 18:49 
Generalusing C Pin
Member 166006627-Jan-05 19:40
Member 166006627-Jan-05 19:40 
GeneralRe: using C Pin
mav.northwind27-Jan-05 22:57
mav.northwind27-Jan-05 22:57 
GeneralRe: using C Pin
Ianier Munoz28-Jan-05 0:34
Ianier Munoz28-Jan-05 0:34 
Generalit's possible.... Pin
Anonymous11-Jan-05 15:55
Anonymous11-Jan-05 15:55 
GeneralRe: it's possible.... Pin
Ianier Munoz13-Jan-05 19:16
Ianier Munoz13-Jan-05 19:16 
Questionhow can i tramsmit real-time data such as video or audio over network ??? Pin
tuan1798324-Dec-04 5:17
tuan1798324-Dec-04 5:17 
AnswerRe: how can i tramsmit real-time data such as video or audio over network ??? Pin
Ianier Munoz1-Jan-05 2:16
Ianier Munoz1-Jan-05 2:16 
GeneralSelecting Line-In or Microphone Pin
jasonrowland27-Oct-04 12:16
jasonrowland27-Oct-04 12:16 
GeneralRe: Selecting Line-In or Microphone Pin
Ianier Munoz27-Oct-04 19:38
Ianier Munoz27-Oct-04 19:38 
Generaldisplay 2 i.e. to wave out device is present Pin
muddasar mehmood26-Oct-04 19:59
muddasar mehmood26-Oct-04 19:59 
GeneralRe: display 2 i.e. to wave out device is present Pin
Ianier Munoz27-Oct-04 19:41
Ianier Munoz27-Oct-04 19:41 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.