Permalink
Browse files

Document updates

  • Loading branch information...
nitslp-ri committed Jan 20, 2019
1 parent 45435b5 commit 9934b4484127a747d55ad81ab5a4c27214d735bc
Showing with 658 additions and 532 deletions.
  1. +2 −1 .gitignore
  2. +75 −0 .vscode/manual.code-snippets
  3. +84 −78 adinrec/README.ja.md
  4. +85 −80 adinrec/README.md
  5. +205 −186 adintool/README.ja.md
  6. +207 −187 adintool/README.md
@@ -41,7 +41,8 @@


### VisualStudioCode ###
.vscode/
.vscode/*
!.vscode/manual.code-snippets

### Autotools ###

@@ -0,0 +1,75 @@
{
// Place your global snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
// Placeholders with the same ids are connected.
// Example:
// "Print to console": {
// "scope": "javascript,typescript",
// "prefix": "log",
// "body": [
// "console.log('$1');",
// "$2"
// ],
// "description": "Log output to console"
// }
"README template": {
"scope": "markdown",
"prefix": "readme",
"body": [
"<!-- markdownlint-disable MD041 -->",
"",
"English / [Japanese](README.ja.md)",
"",
"# ${1:Title}",
"",
"## Synopsys",
"",
"```shell",
"% ${1:Title} [options]",
"```",
"",
"## Description",
"",
"`${1:Title}` is ",
"",
"### Prerequisites",
"",
"### Installing",
"",
"## Usage",
"",
"Usage 1:",
"",
"```shell",
"% ${1:Title} ...",
"```",
"",
"Usage 2:",
"",
"```shell",
"% ${1:Title} ...",
"```",
"",
"## Options",
"",
"## Environment Variables",
"",
"## License",
""
],
"description": "README template"
},
"Options": {
"scope": "markdown",
"prefix": "options",
"body": [
"#### $1",
"",
"$2 (default: $3)"
],
"description": "README option"
}
}
@@ -1,79 +1,85 @@
[English](README.md) / Japanese

adinrec
========

1発話の音声入力データをファイルに記録する

## Synopsys

```
% adinrec [options...] file.wav
```

## Description

`adinrec` はオーディオ入力から音声発話を検出し、ファイルに保存して終了します。

このツールはJuliusのVADモジュールを使用して音声検出を行います。使用するアルゴリズムとパラメータはJuliusと同一であり、Juliusの動きを再現することができます。

保存オーディオファイルの形式は 16bit モノラルの .wav ファイルです。指定されたファイル名が既にある場合は上書きします。ファイル名が "-" のときは no header (raw) 形式で標準出力へ出力されます。

### Prerequisites

マイク入力を用いる場合は実行環境に音声録音デバイスが必要です。複数デバイスがある場合はデフォルトのデバイスが使用されます。環境変数でデバイスを変更することができます(Juliusと同様に)

### Installing

このツールはJuliusのインストール時に同時に同じ場所にインストールされます。

## Usage

16kHz, 16bit モノラルでファイルに記録:
```
% adinrec test.wav
```
48kHz で記録
```
% adinrec -freq 48000 test.wav
```
adinnet から音声ストリームを受信しながら音声検出と保存を行う。また libfvad ベースのVADモジュールを使用する。
```
% adinrec -input adinnet -fvad 3 test.wav
```

## Options

### -freq

サンプリングレート(単位:Hz)(Default: 16000)

### -raw

raw (no header) 形式で出力 (Default: .wav 形式で出力)

### Other options (-input, -lv, ...)

音声入力部に Julius のライブラリを用いており、Juliusの音声入力オプションがすべて指定可能です。環境変数による入力デバイスの選択や、レベル閾値の設定、区間前後の無音区間マージンの長さの変更、Julius用の jconf ファイルの読み込み、等を指定できます。詳しくは Juliusのマニュアルの音声入力オプションの項を見てください。

## Environment Variables

### ALSADEV

ALSA で音声入力デバイス名を指定 (default: "default")

### AUDIODEV

OSS で音声入力デバイス名を指定 (default: "/dev/dsp")

### PORTAUDIO_DEV

PortAudio で音声入力デバイの番号を指定。起動時にデバイスリストが出力されるのでその中から番号を指定する。

### LATENCY_MSEC

マイク入力のレイテンシをミリ秒で指定。小さくすると遅延は少なくなるが動作が不安定になる。デフォルト値はデバイス・OSによって自動決定される。

## License

<!-- markdownlint-disable MD041 -->

[English](README.md) / Japanese

# adinrec

1発話の音声入力データをファイルに記録する

## Synopsys

```shell
% adinrec [options...] file.wav
```

## Description

`adinrec` はオーディオ入力から音声発話を検出し、ファイルに保存して終了します。

このツールはJuliusのVADモジュールを使用して音声検出を行います。使用するアルゴリズムとパラメータはJuliusと同一であり、Juliusの動きを再現することができます。

保存オーディオファイルの形式は 16bit モノラルの .wav ファイルです。指定されたファイル名が既にある場合は上書きします。ファイル名が "-" のときは no header (raw) 形式で標準出力へ出力されます。

### Prerequisites

マイク入力を用いる場合は実行環境に音声録音デバイスが必要です。複数デバイスがある場合はデフォルトのデバイスが使用されます。環境変数でデバイスを変更することができます(Juliusと同様に)

### Installing

このツールはJuliusのインストール時に同時に同じ場所にインストールされます。

## Usage

16kHz, 16bit モノラルでファイルに記録:

```shell
% adinrec test.wav
```

48kHz で記録

```shell
% adinrec -freq 48000 test.wav
```

adinnet から音声ストリームを受信しながら音声検出と保存を行う。また libfvad ベースのVADモジュールを使用する。

```shell
% adinrec -input adinnet -fvad 3 test.wav
```

## Options

### -freq

サンプリングレート(単位:Hz)(Default: 16000)

### -raw

raw (no header) 形式で出力 (Default: .wav 形式で出力)

### Other options (-input, -lv, ...)

音声入力部に Julius のライブラリを用いており、Juliusの音声入力オプションがすべて指定可能です。環境変数による入力デバイスの選択や、レベル閾値の設定、区間前後の無音区間マージンの長さの変更、Julius用の jconf ファイルの読み込み、等を指定できます。詳しくは Juliusのマニュアルの音声入力オプションの項を見てください。

## Environment Variables

### ALSADEV

ALSA で音声入力デバイス名を指定 (default: "default")

### AUDIODEV

OSS で音声入力デバイス名を指定 (default: "/dev/dsp")

### PORTAUDIO_DEV

PortAudio で音声入力デバイの番号を指定。起動時にデバイスリストが出力されるのでその中から番号を指定する。

### LATENCY_MSEC

マイク入力のレイテンシをミリ秒で指定。小さくすると遅延は少なくなるが動作が不安定になる。デフォルト値はデバイス・OSによって自動決定される。

## License

本ツールは Julius と同じオープンソースライセンスを保有しています。詳しくはJuliusのライセンスをご覧ください。
Oops, something went wrong.

0 comments on commit 9934b44

Please sign in to comment.