前言

各網查了一圈，NAudio相關中文資料較少。鑒于本人最近在使用此庫的播放音頻方面有所涉及，在此將自己的學習過程與經驗總結與大家分享，同時也歡迎大佬探討和指正。

簡介

為什么使用NAudio

NAudio為.NET平臺下的開源庫，采用ML-PL協議，開源地址：https://github.com/naudio/NAudio。截至今日，已有約2.4k的stars。

NAudio功能強大，且其入門容易。

強大在于：它支持許多音頻操作，可實現多種API播放與錄制、多種不同音頻格式、音頻格式轉換（重采樣、位深、聲道等）、音頻編碼、多通道播放、音頻效果處理等等（詳細介紹可以看Github readme）。
入門容易在于：對C#的語法、結構友好，且對于一個僅僅是播放聲音的需求，幾行即可搞定：

using(var audioFile = new AudioFileReader(audioFile))
using(var outputDevice = new WaveOutEvent())
{
    outputDevice.Init(audioFile);
    outputDevice.Play(); // 異步執行
    
    while (outputDevice.PlaybackState == PlaybackState.Playing)
    {
        Thread.Sleep(1000);
    }
}?

Demo來自于官方Readme

另一方面，基于NAudio本身的架構值得學習

其框架系統、完善，但實際開箱即用的功能并不是十分的齊全（相對于Bass），對于一個喜愛倒騰的人來說，容易激發學習研究的興趣，其官方教程與例子很是齊全。

快速入門：https://github.com/naudio/NAudio#tutorials

深入學習：https://markheath.net/category/naudio（作者博客）

與其他播放方式對比

基于使用角度考慮，NAudio的優勢在于，它是一個原生的.NET輕量庫（其底層與其他API交互，但透明于使用者）。在不需要COM、獨立SDK、手動P/Invoke的同時，對于音頻交互更加可控、并且可以完成比以上更加復雜的功能。當然其也有一定的不足，例如目前無法跨平臺，底層API強依賴于Windows（作者表示期待.NET Core的Span<T>的后續發展，時機成熟會考慮跨平臺）。

目前常見的播放方案：

方式	簡介	備注
系統事件聲音	僅播放系統事件聲音	`System.Media.SystemSounds` 靜態類
SoundPlayer	使用方便。但是僅支持PCM的wav播放、單通道播放	`System.Media.SoundPlayer`類
Windows Media Player COM組件	要求電腦上安裝WMP，僅能完成簡單播放功能，不利于自定義化
MME API (Multimedia Extensions)	自由度高。但是由于未經封裝，若需求復雜則操作復雜，且P/Invoke不安全	winmm.dll
DirectX	自由度高，相較于MME更為現代化，能從硬件層完成更多音頻功能	DirectX SDK
Bass	功能強大的封裝，但常見交換庫對C#的語法、結構不友好	Bass.NET（需進行授權使用）或 ManagedBass

還有很多未列出。

例1：制作一個簡易的音樂播放器

目標：制作一個Winform的音樂播放器，僅實現讀取mp3、播放、暫停、停止、進度拖動及顯示、音量控制功能。

為了直觀的展示，本例將弱化OOP封裝思想。

回顧開篇的代碼：

using(var audioFile = new AudioFileReader(audioFile))
using(var outputDevice = new WaveOutEvent())
{
    outputDevice.Init(audioFile);
    outputDevice.Play(); // 異步執行
    
    while (outputDevice.PlaybackState == PlaybackState.Playing)
    {
        Thread.Sleep(1000);
    }
}?

顯然，這只能完成最基礎的播放功能。而且對于一個GUI播放器而言，這樣做會帶來很多問題。

首先它會在播放時阻塞線程，其次當播放完畢就會立刻釋放資源，無法對其進行任何控制。

針對以上缺陷完善代碼：

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;
using NAudio.Wave;
using NAudio.Wave.SampleProviders;


namespace SimplePlayer
{
    public partial class FormPlayer : Form
    {
        private IWavePlayer _device;
        private AudioFileReader _reader;


        public FormPlayer()
        {
            InitializeComponent();
        }


        private void btnPlay_Click(object sender, EventArgs e)
        {
            PlayAction();
        }


        private void btnPause_Click(object sender, EventArgs e)
        {
            PauseAction();
        }


        private void btnStop_Click(object sender, EventArgs e)
        {
            StopAction();
        }


        private void btnOpen_Click(object sender, EventArgs e)
        {
            var ofd = new OpenFileDialog
            {
                Filter = "支持的文件|*.mp3;*.wav;*.aiff|所有文件|*.*",
                Multiselect = false
            };
            var result = ofd.ShowDialog();
            if (result != DialogResult.OK) return;


            DisposeAll();


            try
            {
                var fileName = ofd.FileName;


                if (!File.Exists(fileName))
                    throw new FileNotFoundException("所選文件不存在");
                _device = new WaveOutEvent(); // Create device
                _reader = new AudioFileReader(fileName); // Create reader


                _device.Init(_reader);
                _device.PlaybackStopped += Device_OnPlaybackStopped;
            }
            catch (Exception ex)
            {
                DisposeAll();
                MessageBox.Show(ex.Message);
            }
        }


        private void Form_Closed(object sender, EventArgs e)
        {
            DisposeAll();
        }


        private void Device_OnPlaybackStopped(object obj, StoppedEventArgs arg)
        {
            StopAction();
        }


        private void StopAction()
        {
            _device?.Stop();
            if (_reader != null) _reader.Position = 0;
        }


        private void PlayAction()
        {
            _device?.Play();
        }


        private void PauseAction()
        {
            _device?.Pause();
        }


        private void DisposeDevice()
        {
            if (_device != null)
            {
                _device.PlaybackStopped -= Device_OnPlaybackStopped;
                _device.Dispose();
            }
        }


        private void DisposeAll()
        {
            _reader?.Dispose();
            DisposeDevice();
        }
    }
}

以上完成了一個可以打開文件、播放、暫停、停止、釋放資源的基礎功能播放器。接下來完善一下進度顯示以及進度調整。

private CancellationTokenSource _cts;
private bool _sliderLock; // 邏輯鎖，當為true時不更新界面上的進度


private void sliderProgress_MouseDown(object sender, MouseEventArgs e)
{
    _sliderLock = true; // 拖動開始，停止更新界面
}


private void sliderProgress_MouseUp(object sender, MouseEventArgs e)
{
    // 釋放鼠標時，應用目標進度
    _reader.CurrentTime = TimeSpan.FromMilliseconds(sliderProgress.Value);
    UpdateProgress();
    _sliderLock = false; // 拖動結束，恢復更新界面
}


private void sliderProgress_ValueChanged(object sender, EventArgs e)
{
    if (_sliderLock)
    {
        // 拖動時可以直觀看到目標進度
        lblPosition.Text = TimeSpan.FromMilliseconds(sliderProgress.Value).ToString(@"mm\:ss");
    }
}


private void StartUpdateProgress()
{
  // 此處可用Timer完成而不是手動循環，但不建議使用UI線程上的Timer
    Task.Run(() =>
    {
        while (!_cts.IsCancellationRequested)
        {
            if (_device.PlaybackState == PlaybackState.Playing)
            {
              // 若為播放狀態，持續更新界面
                BeginInvoke(new Action(UpdateProgress));
                Thread.Sleep(100);
            }
            else
            {
                Thread.Sleep(50);
            }
        }
    });
}


private void UpdateProgress()
{
    var currentTime = _reader?.CurrentTime ?? TimeSpan.Zero; // 當前時間
    Console.WriteLine(currentTime);


    if (!_sliderLock)
    {
        sliderProgress.Value = (int)currentTime.TotalMilliseconds;
        lblPosition.Text = currentTime.ToString(@"mm\:ss");
    }
}


// 更新此方法
private void btnOpen_Click(object sender, EventArgs e)
{
    ...
        _device.Init(_reader);


        var duration = _reader.TotalTime; // 總時長
        sliderProgress.Maximum = (int)duration.TotalMilliseconds;
        lblDuration.Text = duration.ToString(@"mm\:ss");


        _cts = new CancellationTokenSource();
        StartUpdateProgress(); // 界面更新線程


        _device.PlaybackStopped += Device_OnPlaybackStopped;
    ...
}


// 更新此方法
private void StopAction()
{
    ...
    if (_reader != null) _reader.Position = 0;
    UpdateProgress(); 
}


// 更新此方法
private void DisposeAll()
{
    _cts?.Cancel();
    _cts?.Dispose();
    _reader?.Dispose();
    ...
}?

以上完成了進度顯示以及進度調整，里面包含了一些UI上的優化后的交互邏輯。其中涉及到了個人常用的Task / Cancellation的線程模式，可用Timer代替。

那么最后一個功能，如何進行音量控制？事實上，IWavePlayer接口包含了Volume這個屬性，所以如果僅僅要達成這個目標十分簡單，只需進行屬性設置即可：

private void SetVolume(float volume)
{
    if (_device != null) _device.Volume = volume;
}

然而，這樣做法并不推薦，因為對于內部的WaveOutEvent等IWavePlayer實現，實際效果是從改變了系統的合成器中的音量，如圖：

也就意味著，這將改變整個應用程序的音量，不利于之后進行程序內部混音。

那將如何實現內部音量處理呢？這就涉及了DSP音頻處理。在NAudio中，通過實現接口ISampleProvider，得到WaveStream提供音頻原始數據并且進行處理，再將處理后的數據返回。將多個ISampleProvider鏈接起來進行順序處理，最終將最外層的ISampleProvider交給IWavePlayer進行初始化Init()這樣的一個處理模式。也就是說，其實基于上面的代碼來看，AudioFileReader本身既是WaveStream，也實現了ISampleProvider。

https://stackoverflow.com/questions/46433790/how-to-chain-together-multiple-naudio-isampleprovider-effects

說了這么多有點繞口，用簡潔的方法表示，就是將之前的
AudioFileReader -> IWavePlayer.Init()
替換成
AudioFileReader -> 某種可以控制音量的處理 -> IWavePlayer.Init()

在NAudio內置提供的DSP中，實現了音量處理相關的類VolumeSampleProvider，因此直接拿來用即可。

以上內容推薦結合NAudio源碼食用

根據以上所述，更新代碼：

private VolumeSampleProvider _volumeProvider;


private void sliderVolume_ValueChanged(object sender, EventArgs e)
{
    UpdateVolume();
}


// 更新此方法
private void UpdateVolume()
{
    var volume = sliderVolume.Value / 100f;
    _volumeProvider.Volume = volume;
    //if (_device != null) _device.Volume = volume;  // 注釋這一句
}


// 更新此方法
private void btnOpen_Click(object sender, EventArgs e)
{
    ...
        _reader = new AudioFileReader(fileName); // Create reader


        // dsp start
        _volumeProvider = new VolumeSampleProvider(_reader)
        {
            Volume = sliderVolume.Value / 100f
        };
        // dsp end


        _device.Init(_volumeProvider);
        //_device.Init(_reader); // 之前是reader，現改為VolumeSampleProvider


        var duration = _reader.TotalTime; // 總時長
        ...
}

這樣就對原始音頻進行了處理（改變音量），然后輸出。

完成后的全部代碼：

using System;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;
using NAudio.Wave;
using NAudio.Wave.SampleProviders;


namespace SimplePlayer
{
    public partial class FormPlayer : Form
    {
        private IWavePlayer _device;
        private AudioFileReader _reader;


        private VolumeSampleProvider _volumeProvider;


        private CancellationTokenSource _cts;


        private bool _sliderLock; // 邏輯鎖，當為true時不更新界面上的進度


        public FormPlayer()
        {
            InitializeComponent();
        }


        private void btnPlay_Click(object sender, EventArgs e)
        {
            PlayAction();
        }


        private void btnPause_Click(object sender, EventArgs e)
        {
            PauseAction();
        }


        private void btnStop_Click(object sender, EventArgs e)
        {
            StopAction();
        }


        private void btnOpen_Click(object sender, EventArgs e)
        {
            var ofd = new OpenFileDialog
            {
                Filter = "支持的文件|*.mp3;*.wav;*.aiff|所有文件|*.*",
                Multiselect = false
            };
            var result = ofd.ShowDialog();
            if (result != DialogResult.OK) return;


            DisposeAll();


            try
            {
                var fileName = ofd.FileName;


                if (!File.Exists(fileName))
                    throw new FileNotFoundException("所選文件不存在");
                _device = new WaveOutEvent(); // Create device
                _reader = new AudioFileReader(fileName); // Create reader


                // dsp start
                _volumeProvider = new VolumeSampleProvider(_reader)
                {
                    Volume = sliderVolume.Value / 100f
                };
                // dsp end


                _device.Init(_volumeProvider);
                //_device.Init(_reader); // 之前是reader，現改為VolumeSampleProvider
                // https://stackoverflow.com/questions/46433790/how-to-chain-together-multiple-naudio-isampleprovider-effects


                var duration = _reader.TotalTime; // 總時長
                sliderProgress.Maximum = (int)duration.TotalMilliseconds;
                lblDuration.Text = duration.ToString(@"mm\:ss");


                _cts = new CancellationTokenSource();
                StartUpdateProgress(); // 界面更新線程


                _device.PlaybackStopped += Device_OnPlaybackStopped;
            }
            catch (Exception ex)
            {
                DisposeAll();
                MessageBox.Show(ex.Message);
            }
        }


        private void sliderProgress_MouseDown(object sender, MouseEventArgs e)
        {
            _sliderLock = true; // 拖動開始，停止更新界面
        }


        private void sliderProgress_MouseUp(object sender, MouseEventArgs e)
        {
            // 釋放鼠標時，應用目標進度
            _reader.CurrentTime = TimeSpan.FromMilliseconds(sliderProgress.Value);
            UpdateProgress();
            _sliderLock = false; // 拖動結束，恢復更新界面
        }


        private void sliderProgress_ValueChanged(object sender, EventArgs e)
        {
            if (_sliderLock)
            {
                // 拖動時可以直觀看到目標進度
                lblPosition.Text = TimeSpan.FromMilliseconds(sliderProgress.Value).ToString(@"mm\:ss");
            }
        }


        private void sliderVolume_ValueChanged(object sender, EventArgs e)
        {
            UpdateVolume();
        }


        private void Form_Load(object sender, EventArgs e)
        {


        }


        private void Form_Closed(object sender, EventArgs e)
        {
            DisposeAll();
        }


        private void Device_OnPlaybackStopped(object obj, StoppedEventArgs arg)
        {
            StopAction();
        }


        private void StartUpdateProgress()
        {
            // 此處可用Timer完成而不是手動循環，但不建議使用UI線程上的Timer
            Task.Run(() =>
            {
                while (!_cts.IsCancellationRequested)
                {
                    if (_device.PlaybackState == PlaybackState.Playing)
                    {
                        // 若為播放狀態，持續更新界面
                        BeginInvoke(new Action(UpdateProgress));
                        Thread.Sleep(100);
                    }
                    else
                    {
                        Thread.Sleep(50);
                    }
                }
            });
        }


        private void StopAction()
        {
            _device?.Stop();
            if (_reader != null) _reader.Position = 0;
            UpdateProgress();
        }


        private void PlayAction()
        {
            _device?.Play();
        }


        private void PauseAction()
        {
            _device?.Pause();
        }


        private void UpdateProgress()
        {
            var currentTime = _reader?.CurrentTime ?? TimeSpan.Zero; // 當前時間
            Console.WriteLine(currentTime);


            if (!_sliderLock)
            {
                sliderProgress.Value = (int)currentTime.TotalMilliseconds;
                lblPosition.Text = currentTime.ToString(@"mm\:ss");
            }
        }


        private void UpdateVolume()
        {
            var volume = sliderVolume.Value / 100f;
            _volumeProvider.Volume = volume;
            //if (_device != null) _device.Volume = volume;  // 注釋這一句
        }


        private void DisposeDevice()
        {
            if (_device != null)
            {
                _device.PlaybackStopped -= Device_OnPlaybackStopped;
                _device.Dispose();
            }
        }


        private void DisposeAll()
        {
            _cts?.Cancel();
            _cts?.Dispose();
            _reader?.Dispose();
            DisposeDevice();
        }
    }
}