aimdvcli

====================
AIMDV Client
====================

This is for **SNS AIMDV (AI based Mood Detection thru Voice)** clients, who want to install and test mood AIMDV engine.

.. contents:: Table of Contents


Installation
=========================

System Requirements
-------------------------------

- OS: Windows, Linux (and maybe Mac)
- Python 3.4+

Installataion
--------------------------

.. code:: bash
  
  pip install aimdvcli  
  # or
  pip3 install aimdvcli

Upgrade
---------------

.. code:: bash
  
  # for updating  
  pip install -U aimdvcli


Basic Usage
================

Type like this at your console,

.. code:: bash

  aimdvcli <command> [options]


Audio Format Converter
=========================
 
This is a audio format converter to standardize the wave format to fit into AIMIDV embedded version in embedded environment, esp., in Android. It can convert all files of the directory you specify, and save into target directory.

Target format:

- sampling rate: 22,050
- quantization bit: 16 bit
- channels: 1 (mono)
- byte order: little endian

*usage:*

.. code:: bash

  aimdvcli audio [options] <source directory> [output directory]
  
*options:*

.. code:: bash
  
      --help: display help
  -r:  convert all audio files and their sub directories recursively
  
*arguments:*

.. code:: bash

  source directory: directory contains audio files 
  output directory: default is <source directory>/AIMDV

*example:*

.. code:: bash
  
  # convert all audios in testset directory recursively
  aimdvcli convert -r ./testset ./output


Change Logs
=============

- 0.1 (June 28, 2018): project initialized