view CHANGELOG @ 424:12a7f01c633b

Update docstrings

auditok Changelog
=================

Version 0.2.0
-------------

- Implement split function as a high-level API for tokenization
- Implement AudioRegion class for simple audio objects manipulation
- Use a much faster energy computation method (based on standard audioop module)
- Make ADSFactory deprecated
- Choose which channel(s) to use for tokenization
- Save multi-channel audio data
- Refactor code in all modules
- Use genty for tests
- Improve documentation
- Use ArgumentParser instead of OptionParser in command-line script
- Clean up command-line script and move functions and workers to dedicated modules
- Add "timestamp" placehoder to main script
- Play audio with a progress bar
- StreamSaverWorker: avoid caching data for a long time in memory, save data regularly to disk
- Use numpy style for documentation and update theme
- Ensure pep8 compliance (flake8) and formatting with black
- Add pre-commit hooks
- Change license to MIT
- Add project logo


Version 0.1.8
-------------

- Add command line argument to select audio device used by pyaudio
- Add command line argument to select buffer size for pyaudio


Version 0.1.7
-------------

- Add python 3.5/3.6 to test scheme
- Make source pep8 compliant
- Add shortcut names for AudioSource object properties
- Fix Python 3 bug with reading binary data from STDIN


Version 0.1.6
-------------

- Add 'duration' to output keywords


Version 0.1.5
-------------

- Fix description error for --drop-trailing-silence option (wrong default value)
- Bug fix: cmdline.py, take analysis_window into account when initializing a tokenizer object
- Bug fix: cmdline.py, --save-image option, set `record` to True when reading from the microphone
- Bug fix: util.py, method ADSFactory.ads, make a shallow copy of user's `kwargs` before calling _check_normalize_args
- Update documentation (mainly typos fixes)


Version 0.1.4
-------------

- auditok as command line tool
- Rst documentation
- Read audio data from stdin
- Add short alias for all ADSFactory.ads() keyword arguments
- Add tests for alias
- Break audio data into chunks for audio play back (to quickly detect interruptions like Ctrl-C)


Version 0.1.3
-------------

- Bug fix: util.AudioEnergyValidator._formats = {1: 'b' , 2: 'h', 4: 'i'} instead of {1: 'B' , 2: 'H', 4: 'I'}
- Typo fix in code: StreamTokenizer.DROP_TRAILING_SILENCE renamed StreamTokenizer.DROP_TAILING_SILENCE
- Documentation updated


Version 0.1.2
--------------

First public release on Github.