Changeset 633400d for src/notes/notes.h

Timestamp:

Dec 5, 2018, 10:34:39 PM (5 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/cnn, feature/crepe, feature/pitchshift, feature/timestretch, fix/ffmpeg5, master

Children:

283a619a

Parents:

5b46bc3 (diff), f19db54 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge branch 'master' into feature/pitchshift

File:

• src/notes/notes.h (modified) (2 diffs)

src/notes/notes.h

@@ -16 +16 @@
   You should have received a copy of the GNU General Public License
   along with aubio.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+/** \file
+
+  Note detection object
 
 */
@@ -52 +58 @@
 
   \param o note detection object as returned by new_aubio_notes()
-  \param in input signal of size [hop_size]
-  \param out output notes of size [3] ? FIXME
+  \param input input signal of size [hop_size]
+  \param output output notes, fvec of length 3
+
+  The notes output is a vector of length 3 containing:
+   - 0. the midi note value, or 0 if no note was found
+   - 1. the note velocity
+   - 2. the midi note to turn off
 
 */
 void aubio_notes_do (aubio_notes_t *o, const fvec_t * input, fvec_t * output);
+
+/** set notes detection silence threshold
+
+  \param o notes detection object as returned by new_aubio_notes()
+  \param silence new silence detection threshold
+
+  \return 0 on success, non-zero otherwise
+
+*/
+uint_t aubio_notes_set_silence(aubio_notes_t * o, smpl_t silence);
+
+/** get notes detection silence threshold
+
+  \param o notes detection object as returned by new_aubio_notes()
+
+  \return current silence threshold
+
+*/
+smpl_t aubio_notes_get_silence(const aubio_notes_t * o);
+
+/** get notes detection minimum inter-onset interval, in millisecond
+
+  \param o notes detection object as returned by new_aubio_notes()
+
+  \return current minimum inter onset interval
+
+ */
+smpl_t aubio_notes_get_minioi_ms(const aubio_notes_t *o);
+
+/** set notes detection minimum inter-onset interval, in millisecond
+
+  \param o notes detection object as returned by new_aubio_notes()
+  \param minioi_ms new inter-onset interval
+
+  \return 0 on success, non-zero otherwise
+
+*/
+uint_t aubio_notes_set_minioi_ms (aubio_notes_t *o, smpl_t minioi_ms);
+
+/** get notes object release drop level, in dB
+
+  \param o notes detection object as returned by new_aubio_notes()
+
+  \return current release drop level, in dB
+
+ */
+smpl_t aubio_notes_get_release_drop (const aubio_notes_t *o);
+
+/** set note release drop level, in dB
+
+  This function sets the release_drop_level parameter, in dB. When a new note
+  is found, the current level in dB is measured. If the measured level drops
+  under that initial level - release_drop_level, then a note-off will be
+  emitted.
+
+  Defaults to `10`, in dB.
+
+  \note This parameter was added in version `0.4.8`. Results obtained with
+  earlier versions can be reproduced by setting this value to `100`, so that
+  note-off will not be played until the next note.
+
+  \param o notes detection object as returned by new_aubio_notes()
+  \param release_drop new release drop level, in dB
+
+  \return 0 on success, non-zero otherwise
+
+*/
+uint_t aubio_notes_set_release_drop (aubio_notes_t *o, smpl_t release_drop);
 
 #ifdef __cplusplus