Defines code shared accross all target platform s. More...

#include <stdlib.h>
#include <stddef.h>
#include <tempo_tapper.h>

Include dependency graph for tempo_tapper_common.cxx:

Functions
unsigned long	tt_period_us (tempo_tapper *tapper)
	Returns the period of a tempo in microseconds. More...

void	tt_tap (tempo_tapper *tapper)
	"Taps" the tempo tapper More...

tempo_tapper *	tt_new ()
	Creates a new tempo tapper instance. More...

BPM_t	tt_bpm (tempo_tapper *tapper)
	Returns the tempo in BPM. More...

void	tt_reset (tempo_tapper *tapper)
	Resets the tempo tapper. More...

Detailed Description

Defines code shared accross all target platform s.

Author: Patrick Pedersen

Date: 2021-08-05

The following file defines tempo tapper functions that are shared across all target platforms.

All function descriptions can be found in the tempo_tapper.h file.

Definition in file tempo_tapper_common.cxx.

Function Documentation

◆ tt_bpm()

BPM_t tt_bpm ( tempo_tapper * tapper )

Returns the tempo in BPM.

The following function returns the tempo of the tempo tapper in BPM. The decimal precision is platform dependant.

Returns: Tempo in BPM

Definition at line 72 of file tempo_tapper_common.cxx.

 {
         unsigned long us = tt_period_us(tapper);
         
         if (us == 0)
                 return 0;
  
         
         return (60 * S_TO_US)/(BPM_t)tt_period_us(tapper);
 }

References tt_period_us().

Referenced by tempo_tapper_cpp::bpm().

◆ tt_new()

tempo_tapper* tt_new ( )

Creates a new tempo tapper instance.

The following function creates and initializes a tempo tapper struct instance.

Returns: A initialized tempo_tapper struct instance or NULL on failure

Definition at line 61 of file tempo_tapper_common.cxx.

 {
         tempo_tapper *tapper = (tempo_tapper *) malloc(sizeof(tempo_tapper));
         
         if (tapper == NULL)
                 return NULL;
         
         tt_reset(tapper);
         return tapper;
 }

References tt_reset().

Referenced by tempo_tapper_cpp::tempo_tapper_cpp().

◆ tt_period_us()

unsigned long tt_period_us ( tempo_tapper * tapper )

Returns the period of a tempo in microseconds.

The following function returns the time in microseconds for a period of the current tempo set by the tempo tapper struct.

Returns: Period time in microseconds

Definition at line 37 of file tempo_tapper_common.cxx.

 {
         if (tapper->taps < 1)
                 return 0;
  
         unsigned long us = time_to_us(&tapper->prd_sum);
         return us/tapper->taps;
 }

References tempo_tapper::prd_sum, tempo_tapper::taps, and time_to_us().

Referenced by tempo_tapper_cpp::period_us(), and tt_bpm().

◆ tt_reset()

void tt_reset ( tempo_tapper * tapper )

Resets the tempo tapper.

The following function resets the tempo tapper to its iniital values.

Definition at line 83 of file tempo_tapper_common.cxx.

 {
         tapper->taps = -1;
         reset_time(&tapper->prd_sum);
 }

References tempo_tapper::prd_sum, reset_time(), and tempo_tapper::taps.

Referenced by tempo_tapper_cpp::reset(), and tt_new().

◆ tt_tap()

void tt_tap ( tempo_tapper * tapper )

"Taps" the tempo tapper

The following function is used to "tap" a tempo tapper struct instance. Calling this function on a tempo tapper struct will increase the value of taps, add the time that has passed since the last tap to prd_sum and update lst_t to the current clock time.

Definition at line 46 of file tempo_tapper_common.cxx.

 {
         tt_time_t c_time;
         current_time(&c_time);
  
         if (tapper->taps >= 0) {
                 tt_time_t tdiff;
                 sub_time(&c_time, &tapper->lst_t, &tdiff);
                 add_time(&tapper->prd_sum, &tdiff, &tapper->prd_sum);
         }
  
         tapper->taps++;
         tapper->lst_t = c_time;
 }

References add_time(), current_time(), tempo_tapper::lst_t, tempo_tapper::prd_sum, sub_time(), and tempo_tapper::taps.

Referenced by tempo_tapper_cpp::tap().