Porcupine 1.8.9

.NET Standard 2.0
There is a newer version of this package available.
See the version list below for details.
NuGet\Install-Package Porcupine -Version 1.8.9
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
dotnet add package Porcupine --version 1.8.9
<PackageReference Include="Porcupine" Version="1.8.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Porcupine --version 1.8.9
#r "nuget: Porcupine, 1.8.9"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Porcupine as a Cake Addin
#addin nuget:?package=Porcupine&version=1.8.9

// Install Porcupine as a Cake Tool
#tool nuget:?package=Porcupine&version=1.8.9

Porcupine Wake Word Engine

Made in Vancouver, Canada by Picovoice

Porcupine is a highly-accurate and lightweight wake word engine. It enables building always-listening voice-enabled applications.

Porcupine is:

  • using deep neural networks trained in real-world environments.
  • compact and computationally-efficient making it perfect for IoT.
  • scalable. It can detect multiple always-listening voice commands with no added CPU/memory footprint.
  • self-service. Developers can train custom wake phrases using Picovoice Console.

Compatibility

  • .NET Standard 2.0, .NET Core 2.0+, .NET Framework 4.6.1+
  • Runs on Linux (x86_64), macOS (x86_64) and Windows (x86_64)

Installation

You can install the latest version of Porcupine by getting the latest Porcupine Nuget package in Visual Studio or using the .NET CLI.

dotnet add package Porcupine

Usage

Create an instance of the engine

using Pv;

Porcupine handle = Porcupine.Create(keywords: new List<string> { "picovoice" });

handle is an instance of Porcupine that detects utterances of "Picovoice". The keywords input argument is a shorthand for accessing default keyword model files shipped with the package. The list of default keywords can be retrieved by

using Pv;

foreach (string keyword in Porcupine.KEYWORDS)
{
    Console.WriteLine(keyword);
}

Porcupine can detect multiple keywords concurrently

using Pv;

Porcupine handle = Porcupine.Create(keywords: new List<string>{ "bumblebee", "picovoice" });

To detect non-default keywords use the keywordPaths input argument instead

using Pv;

var keywordPaths = new List<string>{ "/absolute/path/to/keyword/one", "/absolute/path/to/keyword/two", ...}

Porcupine handle = Porcupine.Create(keywordPaths: keywordPaths);

The sensitivity of the engine can be tuned per-keyword using the sensitivities input argument

using Pv;

Porcupine handle = Porcupine.Create(keywords: new List<string>{ "grapefruit", "porcupine" },  
                                    sensitivities: new List<float>{ 0.6f, 0.35f });

Sensitivity is the parameter that enables trading miss rate for the false alarm rate. It is a floating point number within [0, 1]. A higher sensitivity reduces the miss rate at the cost of increased false alarm rate.

When initialized, the valid sample rate is given by handle.SampleRate. Expected frame length (number of audio samples in an input array) is handle.FrameLength. The engine accepts 16-bit linearly-encoded PCM and operates on single-channel audio.

short[] GetNextAudioFrame()
{
    // .. get audioFrame
    return audioFrame;
}

while(true)
{
    var keywordIndex = handle.Process(GetNextAudioFrame());
    if(keywordIndex >= 0)
    {
	    // .. detection event logic/callback
    }
}

Porcupine will have its resources freed by the garbage collector, but to have resources freed immediately after use, wrap it in a using statement:

using(Porcupine handle = Porcupine.Create(keywords: new List<string> { "picovoice" }))
{
    // .. Porcupine usage here
}

Demos

The Porcupine dotnet demo project is a .NET Core command line application that allows for processing real-time audio (i.e. microphone) and files using Porcupine.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Porcupine:

Package Downloads
Picovoice

Picovoice is an end-to-end platform for building voice products on your terms. It enables creating voice experiences similar to Alexa and Google. But it entirely runs 100% on-device. Picovoice is: - Private: Everything is processed offline. Intrinsically HIPAA and GDPR compliant. - Reliable: Runs without needing constant connectivity. - Zero Latency: Edge-first architecture eliminates unpredictable network delay. - Accurate: Resilient to noise and reverberation. It outperforms cloud-based alternatives by wide margins *. - Cross-Platform: Design once, deploy anywhere. Build using familiar languages and frameworks.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.5 528 6/29/2022
2.1.4 311 6/13/2022
2.1.3 294 5/16/2022
2.1.2 257 3/11/2022
2.1.1 309 2/3/2022
2.1.0 222 1/19/2022
2.0.1 263 11/30/2021
1.9.4 339 9/3/2021
1.9.3 859 5/11/2021
1.9.0 655 12/2/2020
1.8.9 380 10/21/2020