Document Actions

MPTK Developer Documentation

by broy — last modified 2020-11-14 16:41

The aim of the MPTK developer part is to describe how to implement MPTK new functionalities and to inform the developer's community with the news in term of development.

Developers tools

Tools for the development of MPTK (version management, bug tracking, mailing lists, ...) were hosted on the INRIA GForge, which closed in 2020. Much of the project was then moved to Inria's Gitlab repository. If you want to get involved in the development of the project, please visit its Gitlab repository.


  • Most of the MPTK package is fairly stable now. However, we haven't reached version 1.0 yet. In particular, the data format of the "books" (the collections of atoms resulting from the MPTK processing). We are working on a system of backwards compatibility, but it is not ready yet: in the meantime, the formats may change with each new version (we will warn the users and developers about it). We are conscious that this is a nuisance, and we are working on it.

  • Known bug : clipping sound output. MPTK currently use libsndfile library to manage the file I/O management in wave format and in the libsndfile implementation, this format is not protected against clipping, which may happen for some books and is not an artifact of the MPTK analysis. A message now warns you and indicates the gain you should apply on the input signal to avoid clipping.

Features under development

  • Matlab new features

This new features allow to access MPTK library using Matlab, in beta version. (contributions welcome !)
  • Graphical User Interface:

A GUI based on Qt (open source version) is under development. It runs on all the MPTK supported platform, and will allow the creation of dictionary files. (contributions welcome !)

  • New type of decompositon:

Use the plugin system to implement new types of decomposition like Gradient Pursuit or Orthogonal Matching Pursuit.

Implementing new functionalities in MPTK

  • Implement MPTK GUI functionalities
  • Implement MPTK API functionalities under Matlab
  • Create MPTK plugins