Click here to Skip to main content
11,492,523 members (61,265 online)
Click here to Skip to main content

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

, 31 Aug 2003 1M 17.1K 250
Rate this:
Please Sign up or sign in to vote.
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.

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:

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:

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.

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

Share

About the Author

Ianier Munoz
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

 
GeneralMy vote of 1 Pin
Member 943842722-Sep-14 3:59
memberMember 943842722-Sep-14 3:59 
QuestionPlz help : How to record audio buffer to a .wav file Pin
Member 865071615-Jan-14 2:59
memberMember 865071615-Jan-14 2:59 
BugFound a bug in WaveStream.cs, the class WaveStream Pin
Sergey Alexandrovich Kryukov18-Dec-13 16:27
mvpSergey Alexandrovich Kryukov18-Dec-13 16:27 
Questionnullreferenceexception Pin
Member 877069515-Jun-13 10:32
memberMember 877069515-Jun-13 10:32 
AnswerHow to fix WaveOut for Windows 64-bit (fix Null Reference exception) Pin
Kevin North20-May-13 9:21
memberKevin North20-May-13 9:21 
GeneralRe: How to fix WaveOut for Windows 64-bit (fix Null Reference exception) Pin
BillWoodruff25-Jun-13 7:42
memberBillWoodruff25-Jun-13 7:42 
Upvoted !

Many thanks, Kevin, for the detailed hints.

fyi: the current downloadable .NET solution, will convert, run, and work as expected in VS 2012, compiled against FrameWork 4.5, as long as the compile target is set to x86.

Changing the compile target to x64:

I've implemented all your suggestions, and studied the linked references to social.msdn.

After lots of fiddling with parameter types in the delegate definition in WaveNative.WaveDelegate, and the two usages of it in the internal, static, callback methods:

WaveIn.WaveInBuffer.WaveInProc
WaveOut.WaveOutBuffer.WaveOutProc

I've actually gotten the application to compile, and run.

But, no functionality, and, after a period of time, there's a null reference exception thrown: triggered I think by the WaveIn.WaveLib.WaveInBuffer call to: m_Header.dwUser = (IntPtr)GCHandle.Alloc(this);

Note: your contributions to this thread are already quite generous, and I am not soliciting you to go any further with this Smile | :)

thanks, Bill
“Human beings do not live in the objective world alone, nor alone in the world of social activity as ordinarily understood, but are very much at the mercy of the particular language which has become the medium of expression for their society. It is quite an illusion to imagine that one adjusts to reality essentially without the use of language and that language is merely an incidental means of solving specific problems of communication or reflection." Edward Sapir, 1929

QuestionHi Mr. Ianier Munoz Pin
ahmed5_273-Feb-13 10:33
memberahmed5_273-Feb-13 10:33 
QuestionHow to save in a .Wav file ? Pin
smartradio3-Nov-12 9:20
membersmartradio3-Nov-12 9:20 
QuestionException is thrown while you start recording on Win7 Pin
prajaaaa22-Oct-12 22:20
memberprajaaaa22-Oct-12 22:20 
AnswerRe: Exception is thrown while you start recording on Win7 Pin
Wes Jones1-Mar-13 12:58
memberWes Jones1-Mar-13 12:58 
QuestionWhere the file is saved on your computer Pin
nomigan7-Jul-12 13:22
membernomigan7-Jul-12 13:22 
GeneralMy vote of 5 Pin
Farhan Ghumra6-Jun-12 22:38
memberFarhan Ghumra6-Jun-12 22:38 
BugHangs on Stop Pin
shivbuyya10-Mar-12 22:09
membershivbuyya10-Mar-12 22:09 
AnswerRe: Hangs on Stop Pin
AyrA.ch10-Apr-12 11:48
memberAyrA.ch10-Apr-12 11:48 
GeneralRe: Hangs on Stop Pin
shivbuyya5-Oct-12 0:12
membershivbuyya5-Oct-12 0:12 
GeneralRe: Hangs on Stop Pin
AyrA.ch23-Oct-12 8:24
memberAyrA.ch23-Oct-12 8:24 
AnswerRe: Hangs on Stop Pin
vozmen26-Jan-13 5:02
membervozmen26-Jan-13 5:02 
GeneralRe: Hangs on Stop Pin
bimbambumbum27-Mar-13 10:35
memberbimbambumbum27-Mar-13 10:35 
AnswerRe: Hangs on Stop Pin
vozmen27-Mar-13 11:53
membervozmen27-Mar-13 11:53 
GeneralRe: Hangs on Stop Pin
bimbambumbum28-Mar-13 0:29
memberbimbambumbum28-Mar-13 0:29 
GeneralRe: Hangs on Stop Pin
Ariadne15-May-14 6:25
memberAriadne15-May-14 6:25 
GeneralMy vote of 5 Pin
Member 10944438-Jan-12 19:56
memberMember 10944438-Jan-12 19:56 
Questionhow can I get the sound data? Pin
Member 79558498-Aug-11 3:48
memberMember 79558498-Aug-11 3:48 
AnswerRe: how can I get the sound data? Pin
Member 40308897-Jan-12 23:24
memberMember 40308897-Jan-12 23:24 
GeneralListen voice in a particular sound card Pin
sawass24-May-11 6:17
membersawass24-May-11 6:17 

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

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

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.150520.1 | Last Updated 1 Sep 2003
Article Copyright 2003 by Ianier Munoz
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid