-------------------------------------------------------------------------------
README: The UniMRCP Kaldi Plugin
-------------------------------------------------------------------------------

Full name:     The UniMRCP Kaldi Plugin

Desciption:    Kaldi plugin for UniMRCP, based on PocketSphinx plugin.

Version:       1.0

Size:          19MB

URL:           http://rma.nwu.ac.za/
               Any queries with regard to updated versions can be directed to
               rma@nwu.ac.za.

-------------------------------------------------------------------------------

The UniMRCP Kaldi plugin is licensed under the terms of the Apache License 2.0.
See the file "LICENSE" for more information.

Copyright 2014 : The Department of Arts and Culture of the government of the 
                 Republic of South Africa (DAC), IntSyst Labs CC (IntSyst), 
                 North-West University (NWU) and Molo Afrika Speech Technologies
                 (Pty) Ltd (Molo).

When using this plugin, please cite:
  Charl van Heerden, Marelie Davel and Etienne Barnard, "Performance analysis 
  of a multilingual directory enquiries application", in Proc. Annual Symp. 
  Pattern Recognition Association of South Africa (PRASA), pp 258-263, 
  Cape Town, South Africa, November 2014.

bibtex:
@inproceedings{vanheerden14dePerformanceAnalysis,
  author    = {Charl van Heerden, Marelie Davel and Etienne Barnard},
  title     = {Performance analysis of a multilingual directory enquiries
               application},
  booktitle = {Proc. Annual Symp. Pattern Recognition Association of South 
               Africa (PRASA)},
  pages     = {258--263},
  address   = {Cape Town, South Africa},
  year      = {2014},
  month     = {November}
}

-------------------------------------------------------------------------------

DETAILED INFORMATION

DESCRIPTION:

The PocketSphinx plugin was used as a template to create a plugin which allows
a Kaldi decoder to be made available via UniMRCP. Both Kaldi and UniMRCP are
released under the Apache 2.0 license.

The following files were added/modified:

unimrcp
├── build
│   └── acmacros
│       ├── kaldi.m4
│       └── webrtc.m4
├── conf
│   └── unimrcpserver.xml
├── configure.ac
├── libs
│   └── mpf
│       ├── Makefile.am
│       └── src
│           └── mpf_activity_detector.c
├── plugins
│   ├── Makefile.am
│   ├── mrcp-flite
│   │   └── Makefile.am
│   └── mrcp-kaldi
│       ├── conf
│       │   ├── kaldi.xml
│       │   └── online_decoding.conf
│       ├── include
│       │   ├── kaldi_properties.h
│       │   ├── kaldi_resources.h
│       │   ├── kaldi_unimrcp_utils.h
│       │   └── mpf-online-audio-source.h
│       ├── Makefile.am
│       └── src
│           ├── kaldi_properties.c
│           └── mrcp_kaldi.cpp
├── README.unimrcp
└── usr
    └── local
        └── unimrcp
            ├── conf
            │   ├── unimrcpclient.xml
            │   ├── unimrcpserver.xml
            └── data
                └── nnet_models_2014-07-29
                    └── OWN LICENSE FILE

-------------------------------------------------------------------------------

DIRECTORY/FILE STRUCTURE:

unimrcp
├── build
│   └── acmacros
│       ├── kaldi.m4
│       ├── libtool.m4
│       ├── lt~obsolete.m4
│       ├── ltoptions.m4
│       ├── ltsugar.m4
│       ├── ltversion.m4
│       ├── sofia-sip.m4
│       └── webrtc.m4
├── conf
│   └── unimrcpserver.xml
├── configure.ac
├── libs
│   └── mpf
│       ├── Makefile.am
│       └── src
│           └── mpf_activity_detector.c
├── LICENSE
├── NOTICE
├── plugins
│   ├── Makefile.am
│   ├── mrcp-flite
│   │   └── Makefile.am
│   └── mrcp-kaldi
│       ├── conf
│       │   ├── kaldi.xml
│       │   └── online_decoding.conf
│       ├── include
│       │   ├── kaldi_properties.h
│       │   ├── kaldi_resources.h
│       │   ├── kaldi_unimrcp_utils.h
│       │   └── mpf-online-audio-source.h
│       ├── Makefile.am
│       └── src
│           ├── kaldi_properties.c
│           └── mrcp_kaldi.cpp
├── README.unimrcp
└── usr
    └── local
        └── unimrcp
            ├── conf
            │   ├── unimrcpclient.xml
            │   └── unimrcpserver.xml
            └── data
                └── nnet_models_2014-07-29
                    ├── conf
                    │   ├── global_cmvn.stats
                    │   ├── mfcc.conf
                    │   ├── online_cmvn.conf
                    │   ├── online_decoding.conf
                    │   └── splice.conf
                    ├── graph_FREESTATE_EASTERNCAPE
                    │   ├── HCLG.fst
                    │   ├── word_boundary.int
                    │   └── words.txt
                    ├── graph_LOCALDISTRICT
                    │   ├── HCLG.fst
                    │   ├── word_boundary.int
                    │   └── words.txt
                    ├── graph_MUN
                    │   ├── HCLG.fst
                    │   ├── word_boundary.int
                    │   └── words.txt
                    ├── graph_YESNO
                    │   ├── HCLG.fst
                    │   ├── word_boundary.int
                    │   └── words.txt
                    ├── license.txt
                    ├── README.acoustic_model.v1.0.txt
                    └── tri6_nnet
                        ├── final.mat
                        └── final.mdl

24 directories, 49 files

-------------------------------------------------------------------------------

ADDITIONAL DOCUMENTATION:

[1]     Charl van Heerden, Marelie Davel and Etienne Barnard, "Performance
        analysis of a multilingual directory enquiries application", in Proc. 
        Annual Symp. Pattern Recognition Association of South Africa (PRASA), 
        pp 258-263, Cape Town, South Africa, November 2014.

[2]	J.W.F. Thirion and W. Basson, "South African Directory Enquiries SADE
        Installation, build and setup guide v. 0.1". Distributed with this
        release.
 
-------------------------------------------------------------------------------
