vamp.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: © 2021 Alexandros Theodotou <alex@zrythm.org>
 *
 * SPDX-License-Identifier: LicenseRef-ZrythmLicense
 *
 * This file incorporates work covered by the following copyright and
 * permission notices:
 *
 * Centre for Digital Music, Queen Mary, University of London.
 
  Copyright 2006 Chris Cannam.
 
  Permission is hereby granted, free of charge, to any person
 
  obtaining a copy of this software and associated documentation
 
  files (the "Software"), to deal in the Software without
 
  restriction, including without limitation the rights to use, copy,
 
  modify, merge, publish, distribute, sublicense, and/or sell copies
 
  of the Software, and to permit persons to whom the Software is
 
  furnished to do so, subject to the following conditions:
 
 
  The above copyright notice and this permission notice shall be
 
  included in all copies or substantial portions of the Software.
 
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
 
  ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 
  CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 
  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 
  Except as contained in this notice, the names of the Centre for
 
  Digital Music; Queen Mary, University of London; and Chris Cannam
 
  shall not be used in advertising or otherwise to promote the sale,
 
  use or other dealings in this Software without prior written
 
  authorization.
 
 */
 
#ifndef __UTILS_VAMP_H__
#define __UTILS_VAMP_H__
 
#include <glib.h>
 
#include <vamp-hostsdk/host-c.h>
#include <vamp/vamp.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void ZVampPlugin;
 
typedef enum ZVampPluginType
{
  Z_VAMP_PLUGIN_BEAT_TRACKER,
  Z_VAMP_PLUGIN_FIXED_TEMPO_ESTIMATOR,
} ZVampPluginType;
 
typedef struct ZVampFeature
{
  bool has_timestamp;
 
  long timestamp;
 
  bool has_duration;
 
  size_t duration;
 
  float * values;
 
  size_t num_values;
 
  char * label;
} ZVampFeature;
 
typedef struct ZVampOutputDescriptor
{
  char * identifier;
 
  char * name;
 
  char * description;
 
  char * unit;
 
  bool hasFixedBinCount;
 
  bool hasKnownExtents;
 
  float minValue;
 
  float maxValue;
 
  int sampleType;
 
  float sampleRate;
 
  bool hasDuration;
} ZVampOutputDescriptor;
 
typedef struct ZVampOutputList
{
  GPtrArray * outputs;
} ZVampOutputList;
 
typedef struct ZVampFeatureList
{
  GPtrArray * list;
} ZVampFeatureList;
 
typedef struct ZVampFeatureSet
{
  GPtrArray * set;
 
  GArray * outputs;
} ZVampFeatureSet;
 
void
vamp_print_all (void);
 
const VampPluginDescriptor *
vamp_get_simple_fixed_tempo_estimator_descriptor (void);
 
ZVampPlugin *
vamp_get_plugin (ZVampPluginType type, float samplerate);
 
void
vamp_plugin_initialize (
  ZVampPlugin * plugin,
  size_t        channels,
  size_t        step_size,
  size_t        block_size);
 
ZVampFeatureSet *
vamp_plugin_process (
  ZVampPlugin *         plugin,
  const float * const * input_buffers,
  long                  timestamp,
  unsigned int          samplerate);
 
ZVampFeatureSet *
vamp_plugin_get_remaining_features (
  ZVampPlugin * plugin,
  unsigned int  samplerate);
 
size_t
vamp_plugin_get_preferred_step_size (ZVampPlugin * plugin);
 
size_t
vamp_plugin_get_preferred_block_size (ZVampPlugin * plugin);
 
ZVampOutputList *
vamp_plugin_get_output_descriptors (ZVampPlugin * plugin);
 
ZVampOutputDescriptor *
vamp_output_descriptor_new (
  const char * identifier,
  const char * name,
  const char * description,
  const char * unit,
  bool         hasFixedBinCount,
  bool         hasKnownExtents,
  float        minValue,
  float        maxValue,
  int          sampleType,
  float        sampleRate,
  bool         hasDuration);
 
ZVampFeature *
vamp_feature_new (
  bool         has_timestamp,
  long         timestamp,
  bool         hasDuration,
  size_t       duration,
  float *      values,
  size_t       num_values,
  const char * label);
 
const ZVampFeatureList *
vamp_feature_set_get_list_for_output (ZVampFeatureSet * self, int output_idx);
 
void
vamp_feature_list_print (const ZVampFeatureList * self);
 
void
vamp_feature_set_print (const ZVampFeatureSet * self);
 
void
vamp_feature_print (ZVampFeature * self);
 
void
vamp_plugin_output_print (ZVampOutputDescriptor * self);
 
void
vamp_plugin_output_list_print (ZVampOutputList * self);
 
void
vamp_feature_free (void * self);
 
void
vamp_feature_list_free (void * list);
 
void
vamp_output_descriptor_free (void * descr);
 
void
vamp_feature_set_free (ZVampFeatureSet * self);
 
void
vamp_plugin_output_list_free (ZVampOutputList * self);
 
#ifdef __cplusplus
}
#endif
 
#endif // __UTILS_VAMP_H__