Pyroomacoustics

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

Added
~~~~~

- Added FastMNMF (Fast Multichannel Nonnegative Matrix Factorization) to ``bss`` subpackage.
- Griffin-Lim algorithm for phase reconstruction from STFT magnitude measurements.

Changed
~~~~~~~

- Removed the supperfluous warnings in `pyroomacoustics.transform.stft`.
- Add option in `pyroomacoustics.room.Room.plot_rir` to set pair of channels
to plot; useful when there's too many impulse responses.
- Add some window functions in `windows.py` and rearranged it in alphabetical order
- Fixed various warnings in tests.
- Faster implementation of AuxIVA that also includes OverIVA (more mics than sources).
It also comes with a slightly changed API, Laplace and time-varying Gauss statistical
models, and two possible initialization schemes.
- Faster implementation of ILRMA.
- SparseAuxIVA has slightly changed API, ``f_contrast`` has been replaced by ``model``
keyword argument.

Bugfix
~~~~~~

- Set ``rcond=None`` in all calls to ``numpy.linalg.lstsq`` to remove a ``FutureWarning``
- Add a lower bound to activations in ``pyroomacoustics.bss.auxiva`` to avoid
underflow and divide by zero.
- Fixed a memory leak in the C engine for polyhedral room (issue 116).
- Fixed problem caused by dependency of setup.py on Cython (Issue 117)

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

Bugfix
~~~~~~

- Expose ``mu`` parameter for ``adaptive.subband_lms.SubbandLMS``.
- Add SSL context to ``download_uncompress`` and unit test; error for Python 2.7.

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

Added
~~~~~
- Added "precision" parameter to "stft" class to choose between 'single' (float32/complex64) or 'double'
(float64/complex128) for processing precision.
- Unified unit test file for frequency-domain souce separation methods.
- New algorithm for blind source separation (BSS): Sparse Independent Vector Analysis (SparseAuxIVA).

Changed
~~~~~~~

- Few README improvements

Bugfix
~~~~~~

- Remove ``np.squeeze`` in STFT as it caused errors when an axis that shouldn't
be squeezed was equal to 1.
- ``Beamformer.process`` was using old (non-existent) STFT function. Changed to
using one-shot function from ``transform`` module.
- Fixed a bug in ``utilities.fractional_delay_filter_bank`` that would cause the
function to crash on some inputs (`issue 87 <https://github.com/LCAV/pyroomacoustics/issues/87>`__).

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

Added
~~~~~

- Adds several options to ``pyroomacoustics.room.Room.simulate`` to finely
control the SNR of the microphone signals and also return the microphone
signals with individual sources, prior to mix (useful for BSS evaluation)
- Add subspace denoising approach in ``pyroomacoustics.denoise.subspace``.
- Add iterative Wiener filtering approach for single channel denoising in
``pyroomacoustics.denoise.iterative_wiener``.


Changed
~~~~~~~

- Add build instructions for python 3.7 and wheels for Mac OS X in the
continuous integration (Travis and Appveyor)
- Limits imports of matplotlib to within plotting functions so that the
matplotlib backend can still be changed, even after importing pyroomacoustics
- Better Vectorization of the computations in ``pyroomacoustics.bss.auxiva``

Bugfix
~~~~~~

- Corrects a bug that causes different behavior whether sources are provided to the constructor of ``Room`` or to the ``add_source`` method
- Corrects a typo in ``pyroomacoustics.SoundSource.add_signal``
- Corrects a bug in the update of the demixing matrix in ``pyroomacoustics.bss.auxiva``
- Corrects invalid memory access in the ``pyroomacoustics.build_rir`` cython accelerator
and adds a unit test that checks the cython code output is correct
- Fix bad handling of 1D `b` vectors in pyroomacoustics.levinson``.

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

Added
~~~~~

- STFT tutorial and demo notebook.
- New algorithm for blind source separation (BSS): Independent Low-Rank Matrix Analysis (ILRMA)

Changed
~~~~~~~

- Matplotlib is not a hard requirement anymore. When matplotlib is not
installed, only a warning is issued on plotting commands. This is useful
to run pyroomacoustics on headless servers that might not have matplotlib
installed
- Removed dependencies on ``joblib`` and ``requests`` packages
- Apply ``matplotlib.pyplot.tight_layout`` in ``pyroomacoustics.Room.plot_rir``

Bugfix
~~~~~~

- Monaural signals are now properly handled in one-shot stft/istft
- Corrected check of size of absorption coefficients list in ``Room.from_corners``

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

Added
~~~~~

- Added noise reduction sub-package ``denoise`` with spectral subtraction
class and example.
- Renamed ``realtime`` to ``transform`` and added deprecation warning.
- Added a cython function to efficiently compute the fractional delays in the room
impulse response from time delays and attenuations
- `notebooks` folder.
- Demo IPython notebook (with WAV files) of several features of the package.
- Wrapper for Google's Speech Command Dataset and an example usage script in ``examples``.
- Lots of new features in the ``pyroomacoustics.realtime`` subpackage

* The ``STFT`` class can now be used both for frame-by-frame processing
or for bulk processing
* The functionality will replace the methods ``pyroomacoustics.stft``,
``pyroomacoustics.istft``, ``pyroomacoustics.overlap_add``, etc,
* The **new** function ``pyroomacoustics.realtime.compute_synthesis_window``
computes the optimal synthesis window given an analysis window and
the frame shift
* Extensive tests for the ``pyroomacoustics.realtime`` module
* Convenience functions ``pyroomacoustics.realtime.analysis`` and
``pyroomacoustics.realtime.synthesis`` with an interface similar
to ``pyroomacoustics.stft`` and ``pyroomacoustics.istft`` (which
are now deprecated and will disappear soon)
* The ordering of axis in the output from bulk STFT is now
``(n_frames, n_frequencies, n_channels)``
* Support for Intel's ``mkl_fft`` `package <https://github.com/IntelPython/mkl_fft>`_
* ``axis`` (along which to perform DFT) and ``bits`` parameters for ``DFT`` class.

Changed
~~~~~~~

- Improved documentation and docstrings
- Using now the built-in RIR generator in `examples/doa_algorithms.py`
- Improved the download/uncompress function for large datasets
- Dusted the code for plotting on the sphere in ``pyroomacoustics.doa.grid.GridSphere``

Deprecation Notice
~~~~~~~~~~~~~~~~~~

- The methods ``pyroomacoustics.stft``, ``pyroomacoustics.istft``,
``pyroomacoustics.overlap_add``, etc, are now **deprecated**
and will be removed in the near future