avs-device-sdk/srcs/extension/avs-weakup-sdk/docs/getting-started/filesim.html

1627 lines
40 KiB
HTML

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="shortcut icon" href="../resources/images/alexa-favicon-02.png">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.0.2">
<title>File Simulators - Amazon Wake Word Engine</title>
<link rel="stylesheet" href="../assets/stylesheets/main.38780c08.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.3f72e892.min.css">
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
<style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
<link rel="stylesheet" href="../resources/stylesheets/extra.css">
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#file-simulators" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header-nav md-grid" aria-label="Header">
<a href=".." title="Amazon Wake Word Engine" class="md-header-nav__button md-logo" aria-label="Amazon Wake Word Engine">
<img src="../resources/images/logo-alexa-blue-ring.png" alt="logo">
</a>
<label class="md-header-nav__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
</label>
<div class="md-header-nav__title" data-md-component="header-title">
<div class="md-header-nav__ellipsis">
<span class="md-header-nav__topic md-ellipsis">
Amazon Wake Word Engine
</span>
<span class="md-header-nav__topic md-ellipsis">
File Simulators
</span>
</div>
</div>
<label class="md-header-nav__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active">
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</label>
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
</button>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs md-tabs--active" aria-label="Tabs" data-md-component="tabs">
<div class="md-tabs__inner md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../index.html" class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="api-samples/index.html" class="md-tabs__link">
Getting Started
</a>
</li>
<li class="md-tabs__item">
<a href="../features/wakeword/overview.html" class="md-tabs__link">
Features
</a>
</li>
<li class="md-tabs__item">
<a href="../avs-device-sdk/index.html" class="md-tabs__link">
AVS Device SDK
</a>
</li>
<li class="md-tabs__item">
<a href="../api-reference/index.html" class="md-tabs__link">
API Reference
</a>
</li>
<li class="md-tabs__item">
<a href="../support/getting-help.html" class="md-tabs__link">
Support
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Amazon Wake Word Engine" class="md-nav__button md-logo" aria-label="Amazon Wake Word Engine">
<img src="../resources/images/logo-alexa-blue-ring.png" alt="logo">
</a>
Amazon Wake Word Engine
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-1" type="checkbox" id="nav-1">
<label class="md-nav__link" for="nav-1">
Home
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Home" data-md-level="1">
<label class="md-nav__title" for="nav-1">
<span class="md-nav__icon md-icon"></span>
Home
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../index.html" class="md-nav__link">
Welcome
</a>
</li>
<li class="md-nav__item">
<a href="../general-architecture.html" class="md-nav__link">
General Architecture
</a>
</li>
<li class="md-nav__item">
<a href="../api-versions-features.html" class="md-nav__link">
API Versions & Features
</a>
</li>
<li class="md-nav__item">
<a href="../wrappers-sdk-integrations.html" class="md-nav__link">
Wrappers & SDK Integrations
</a>
</li>
<li class="md-nav__item">
<a href="../supported-architectures.html" class="md-nav__link">
Supported Architectures
</a>
</li>
<li class="md-nav__item">
<a href="../release-history.html" class="md-nav__link">
Release History
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" checked>
<label class="md-nav__link" for="nav-2">
Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Getting Started" data-md-level="1">
<label class="md-nav__title" for="nav-2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-2-1" type="checkbox" id="nav-2-1">
<label class="md-nav__link" for="nav-2-1">
API Usage Samples
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="API Usage Samples" data-md-level="2">
<label class="md-nav__title" for="nav-2-1">
<span class="md-nav__icon md-icon"></span>
API Usage Samples
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="api-samples/index.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="api-samples/api-sample-v1.html" class="md-nav__link">
API v1
</a>
</li>
<li class="md-nav__item">
<a href="api-samples/api-sample-v2.html" class="md-nav__link">
API v2
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="release-contents/index.html" class="md-nav__link">
Release Contents
</a>
</li>
<li class="md-nav__item">
<a href="model-selection.html" class="md-nav__link">
Model Selection
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
File Simulators
<span class="md-nav__icon md-icon"></span>
</label>
<a href="filesim.html" class="md-nav__link md-nav__link--active">
File Simulators
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#how-to-run-the-application" class="md-nav__link">
How to run the application
</a>
<nav class="md-nav" aria-label="How to run the application">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#locate-the-executable-in-the-package" class="md-nav__link">
Locate the executable in the package
</a>
</li>
<li class="md-nav__item">
<a href="#prepare-input-audio-list" class="md-nav__link">
Prepare Input Audio List
</a>
</li>
<li class="md-nav__item">
<a href="#select-a-wake-word-model" class="md-nav__link">
Select a wake word model
</a>
</li>
<li class="md-nav__item">
<a href="#run-the-application" class="md-nav__link">
Run the application
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#reference-file-simulation-output" class="md-nav__link">
Reference file simulation output
</a>
</li>
<li class="md-nav__item">
<a href="#fingerprinting-file-simulator" class="md-nav__link">
Fingerprinting File Simulator
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
<label class="md-nav__link" for="nav-3">
Features
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Features" data-md-level="1">
<label class="md-nav__title" for="nav-3">
<span class="md-nav__icon md-icon"></span>
Features
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-1" type="checkbox" id="nav-3-1">
<label class="md-nav__link" for="nav-3-1">
Wake Word
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Wake Word" data-md-level="2">
<label class="md-nav__title" for="nav-3-1">
<span class="md-nav__icon md-icon"></span>
Wake Word
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../features/wakeword/overview.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../features/wakeword/performance.html" class="md-nav__link">
Wake Word Performance
</a>
</li>
<li class="md-nav__item">
<a href="../features/wakeword/detection-threshold.html" class="md-nav__link">
Detection Threshold
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-1-4" type="checkbox" id="nav-3-1-4">
<label class="md-nav__link" for="nav-3-1-4">
Media Wake Suppression
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Media Wake Suppression" data-md-level="3">
<label class="md-nav__title" for="nav-3-1-4">
<span class="md-nav__icon md-icon"></span>
Media Wake Suppression
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../features/wakeword/media-wakes/media-wakes.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-1-4-2" type="checkbox" id="nav-3-1-4-2">
<label class="md-nav__link" for="nav-3-1-4-2">
Fingerprinting
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Fingerprinting" data-md-level="4">
<label class="md-nav__title" for="nav-3-1-4-2">
<span class="md-nav__icon md-icon"></span>
Fingerprinting
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../features/wakeword/media-wakes/fingerprinting/overview.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../features/wakeword/media-wakes/fingerprinting/integration-guide.html" class="md-nav__link">
Integration Guide
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-1-4-3" type="checkbox" id="nav-3-1-4-3">
<label class="md-nav__link" for="nav-3-1-4-3">
Watermarking
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Watermarking" data-md-level="4">
<label class="md-nav__title" for="nav-3-1-4-3">
<span class="md-nav__icon md-icon"></span>
Watermarking
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../features/wakeword/media-wakes/watermarking/overview.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../features/wakeword/media-wakes/watermarking/integration.html" class="md-nav__link">
Integration Guide
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../features/wakeword/self-wake/self-wake-overview.html" class="md-nav__link">
Self-Wake Suppression
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-1-6" type="checkbox" id="nav-3-1-6">
<label class="md-nav__link" for="nav-3-1-6">
Pre-roll
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Pre-roll" data-md-level="3">
<label class="md-nav__title" for="nav-3-1-6">
<span class="md-nav__icon md-icon"></span>
Pre-roll
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../features/wakeword/preroll/preroll-overview.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../features/wakeword/preroll/preroll-integration-guide.html" class="md-nav__link">
Integration Guide
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../features/wakeword/cascade-mode.html" class="md-nav__link">
Cascade Mode
</a>
</li>
<li class="md-nav__item">
<a href="../features/wakeword/client-properties.html" class="md-nav__link">
Client Properties
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-2" type="checkbox" id="nav-3-2">
<label class="md-nav__link" for="nav-3-2">
Diagnostic Information (WWDI)
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Diagnostic Information (WWDI)" data-md-level="2">
<label class="md-nav__title" for="nav-3-2">
<span class="md-nav__icon md-icon"></span>
Diagnostic Information (WWDI)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../features/wwdi/overview.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../features/wwdi/integration-guide.html" class="md-nav__link">
Integration Guide
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-3" type="checkbox" id="nav-3-3">
<label class="md-nav__link" for="nav-3-3">
Standalone Voice Activity Detection (VAD)
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Standalone Voice Activity Detection (VAD)" data-md-level="2">
<label class="md-nav__title" for="nav-3-3">
<span class="md-nav__icon md-icon"></span>
Standalone Voice Activity Detection (VAD)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../features/vad/overview.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-3-2" type="checkbox" id="nav-3-3-2">
<label class="md-nav__link" for="nav-3-3-2">
Energy Detection
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Energy Detection" data-md-level="3">
<label class="md-nav__title" for="nav-3-3-2">
<span class="md-nav__icon md-icon"></span>
Energy Detection
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../features/vad/energydetection/overview.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../features/vad/energydetection/integration-guide.html" class="md-nav__link">
Integration Guide
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-3-4" type="checkbox" id="nav-3-4">
<label class="md-nav__link" for="nav-3-4">
Device Artifact Vending Service (DAVS)
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Device Artifact Vending Service (DAVS)" data-md-level="2">
<label class="md-nav__title" for="nav-3-4">
<span class="md-nav__icon md-icon"></span>
Device Artifact Vending Service (DAVS)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../features/davs/overview.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../features/davs/integration-guide.html" class="md-nav__link">
Integration Guide
</a>
</li>
<li class="md-nav__item">
<a href="../features/davs/davs-filters.html" class="md-nav__link">
DAVS filters in wakeword engine package
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
<label class="md-nav__link" for="nav-4">
AVS Device SDK
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="AVS Device SDK" data-md-level="1">
<label class="md-nav__title" for="nav-4">
<span class="md-nav__icon md-icon"></span>
AVS Device SDK
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../avs-device-sdk/index.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../avs-device-sdk/integration-guide.html" class="md-nav__link">
Integration Guide
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
<label class="md-nav__link" for="nav-5">
API Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="API Reference" data-md-level="1">
<label class="md-nav__title" for="nav-5">
<span class="md-nav__icon md-icon"></span>
API Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../api-reference/index.html" class="md-nav__link">
API Reference
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-5-2" type="checkbox" id="nav-5-2">
<label class="md-nav__link" for="nav-5-2">
Wrappers
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Wrappers" data-md-level="2">
<label class="md-nav__title" for="nav-5-2">
<span class="md-nav__icon md-icon"></span>
Wrappers
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-5-2-1" type="checkbox" id="nav-5-2-1">
<label class="md-nav__link" for="nav-5-2-1">
Java
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Java" data-md-level="3">
<label class="md-nav__title" for="nav-5-2-1">
<span class="md-nav__icon md-icon"></span>
Java
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../api-reference/wrappers/java/java-binding-overview.html" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../api-reference/wrappers/java/java-binding-reference.html" class="md-nav__link">
Reference
</a>
</li>
<li class="md-nav__item">
<a href="../api-reference/wrappers/java/java-binding-engine-reference.html" class="md-nav__link">
Engine API
</a>
</li>
<li class="md-nav__item">
<a href="../api-reference/wrappers/java/java-binding-wake-word-reference.html" class="md-nav__link">
Wake Word API
</a>
</li>
<li class="md-nav__item">
<a href="../api-reference/wrappers/java/java-binding-fingerprinting-reference.html" class="md-nav__link">
Fingerprinting API
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../api-reference/wrappers/swift/index.html" class="md-nav__link">
Swift
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
<label class="md-nav__link" for="nav-6">
Support
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Support" data-md-level="1">
<label class="md-nav__title" for="nav-6">
<span class="md-nav__icon md-icon"></span>
Support
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../support/getting-help.html" class="md-nav__link">
Getting Help
</a>
</li>
<li class="md-nav__item">
<a href="../support/faq/index.html" class="md-nav__link">
FAQ
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#how-to-run-the-application" class="md-nav__link">
How to run the application
</a>
<nav class="md-nav" aria-label="How to run the application">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#locate-the-executable-in-the-package" class="md-nav__link">
Locate the executable in the package
</a>
</li>
<li class="md-nav__item">
<a href="#prepare-input-audio-list" class="md-nav__link">
Prepare Input Audio List
</a>
</li>
<li class="md-nav__item">
<a href="#select-a-wake-word-model" class="md-nav__link">
Select a wake word model
</a>
</li>
<li class="md-nav__item">
<a href="#run-the-application" class="md-nav__link">
Run the application
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#reference-file-simulation-output" class="md-nav__link">
Reference file simulation output
</a>
</li>
<li class="md-nav__item">
<a href="#fingerprinting-file-simulator" class="md-nav__link">
Fingerprinting File Simulator
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content">
<article class="md-content__inner md-typeset">
<h1 id="file-simulators">File Simulators</h1>
<p>File simulators are offline .wav file processor utilities to aid in evaluation of the Wake Word engine on pre-recoded audio files. It takes WAV files containing in a mono 16-bit 16 kHz audio format, a wake word model, and outputs detection events to stdout.</p>
<p>The file simulator application is provided only for those architectures where file I/O and stdio C run-time
library functionality is readily available (i.e. x86, darwin, linux, etc.).</p>
<h2 id="how-to-run-the-application">How to run the application</h2>
<p>For an exhaustive list of options, run the application with <code>-h</code>.</p>
<h3 id="locate-the-executable-in-the-package">Locate the executable in the package</h3>
<p>If supplied as part of the PryonLite package, an <code>amazon_ww_filesim</code> application binary will be present in a given
<code>&lt;target&gt;</code> subfolder. For example, an Ubuntu x86 version of the filesim application would be found in the <code>x86</code> folder.</p>
<p>File simulators for V2 API are located in subfolders of the architecture folder. The following table shows locations of file simulator applications built for various API versions:</p>
<table>
<thead>
<tr>
<th>API / Version</th>
<th>File Simulator Location</th>
</tr>
</thead>
<tbody>
<tr>
<td>v2 <a href="../api-versions-features.html">PRL1000</a></td>
<td><code>./&lt;architecture&gt;/PRL1000/amazon_filesim-PRL1000</code></td>
</tr>
<tr>
<td>v2 <a href="../api-versions-features.html">PRL2000</a></td>
<td><code>./&lt;architecture&gt;/PRL2000/amazon_filesim-PRL2000</code></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Some target subfolders will not contain an amazon filesim application binary. This is due to lack of the target's file i/o capabilities.</p>
</div>
<h3 id="prepare-input-audio-list">Prepare Input Audio List</h3>
<p>If you have a directory containing the .wav files to process, run the following command to generate
a list file with all the .wav files in that directory:</p>
<p><div class="highlight"><pre><span></span><code>ls -1 *.wav &gt; all_wavs.list
</code></pre></div>
The wake word engine uses adaptation logic to learn the characteristics of the acoustic environment. This improves
detection quality. However if the audio clips are from different environments and do not contain at least 1 second of
background noise prior to the wake word, we suggest using -c which will force the engine to clear the adaptation
statistics after each file.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>You can also run a single .wav file without a list. Just use the .wav file path instead of a list file path on the command line</p>
</div>
<h4 id="sample-input">Sample input</h4>
<p>A sample WAV list file and associated .WAV files can be found in the following package locations:</p>
<div class="highlight"><pre><span></span><code>./sample-wakeword/alexas.list
./sample-wakeword/alexa-*.wav
</code></pre></div>
<p>The list file will look like this:</p>
<div class="highlight"><pre><span></span><code>alexa-01.wav
alexa-02.wav
alexa-03.wav
alexa-04.wav
alexa-05.wav
alexa-06.wav
alexa-07.wav
alexa-08.wav
alexa-09.wav
alexa-10.wav
</code></pre></div>
<h3 id="select-a-wake-word-model">Select a wake word model</h3>
<p>The wake word model must be selected based on the paths specified by a particular architecture's WakewordModelMapping.json
configuration file. For example, for the x86 (Ubuntu) architecture, the WakewordModelMapping.json file specifies that the
following model is suitable for the x86 Ubuntu PryonLite engine:</p>
<div class="highlight"><pre><span></span><code>common/D.en-US.alexa
</code></pre></div>
<p>The appropriate wake word model is then found in the 'models' subfolder, with a .bin extension. For example:</p>
<div class="highlight"><pre><span></span><code>path_to_model = models/common/D.en-US.alexa.bin
</code></pre></div>
<p>For detailed information on model selection, see <a href="model-selection.html">this section</a></p>
<h3 id="run-the-application">Run the application</h3>
<p>The application takes the wake word model and an audio list file in as command line parameters:</p>
<div class="highlight"><pre><span></span><code>./&lt;filesim application name&gt; -m &lt;path_to_model&gt; all_wavs.list
</code></pre></div>
<p>To display a full list of options, run the filesim application with the '-h' option.</p>
<h2 id="reference-file-simulation-output">Reference file simulation output</h2>
<p>Reference output from file simulation applications is provided in the package. In the example below, the reference file name is specifically for an x86 Ubuntu architecture using a D.en-US.alexa wake word model.
Your package may contain a sample output for a different architecture or model, depending on your package request.</p>
<div class="highlight"><pre><span></span><code>./sample-wakeword/ref-output-x86-D.en-US.alexa-alexas.list
</code></pre></div>
<p>The application output will look similar to the following:</p>
<div class="highlight"><pre><span></span><code>Loaded model from path: models/common/D.en-US.alexa.bin
Decoder instance memory allocated: 266344
Model Version: en-US_D_ALEXA+STOP_2018SuperBowl_v5.0
Engine Version: 2.9.0
Supported keywords: ALEXA, STOP
Threshold: 500
alexa-01: &#39;ALEXA&#39; detected during [0, 9600]
alexa-02: &#39;ALEXA&#39; detected during [8640, 17920]
alexa-03: &#39;ALEXA&#39; detected during [3680, 13920]
alexa-04: &#39;ALEXA&#39; detected during [4480, 14720]
alexa-05: &#39;ALEXA&#39; detected during [3040, 13280]
alexa-06: &#39;ALEXA&#39; detected during [5440, 15680]
alexa-07: &#39;ALEXA&#39; detected during [8800, 20480]
alexa-08: &#39;ALEXA&#39; detected during [7840, 19520]
alexa-09: &#39;ALEXA&#39; detected during [12000, 24160]
alexa-10: &#39;ALEXA&#39; detected during [30400, 43040]
*** 10 wake word(s) detected in 10 files ***
</code></pre></div>
<h2 id="fingerprinting-file-simulator">Fingerprinting File Simulator</h2>
<p>See the <a href="../features/wakeword/media-wakes/fingerprinting/integration-guide.html">Fingerprinting Integration Guide</a> for instructions on how to pass a fingerprint list to the file simulator.</p>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
<a href="model-selection.html" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Previous
</span>
Model Selection
</div>
</div>
</a>
<a href="../features/wakeword/overview.html" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Overview
</div>
</div>
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
</div>
</a>
</nav>
</div>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
<div class="md-footer-copyright__highlight">
AMAZON CONFIDENTIAL. Copyright &copy; 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<script src="../assets/javascripts/vendor.77e55a48.min.js"></script>
<script src="../assets/javascripts/bundle.9554a270.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
<script src="https://unpkg.com/iframe-worker/polyfill"></script>
<script src="../search/search_index.js"></script>
<script>
app = initialize({
base: "..",
features: ['navigation.tabs', 'navigation.expand'],
search: Object.assign({
worker: "../assets/javascripts/worker/search.4ac00218.min.js"
}, typeof search !== "undefined" && search)
})
</script>
<script src="../resources/javascripts/MathJax.min.js"></script>
</body>
</html>