pprz_chirp.h

Go to the documentation of this file.

/*
 * Copyright (C) Joost Meulenbeld
 *
 * This file is part of paparazzi
 *
 * paparazzi is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * paparazzi is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with paparazzi; see the file COPYING.  If not, see
 * <http://www.gnu.org/licenses/>.
 */
#ifndef PPRZ_CHIRP_H
#define PPRZ_CHIRP_H
 
#include "std.h"
 
struct chirp_t {
  float f0_hz;
  float f1_hz;
  float start_time_s;
  float length_s; // Amount of seconds of the chirp, excluding fade-in if applicable
  float total_length_s; // Amount of seconds of the chirp, including fade-in if applicable
 
  float current_frequency_hz;
  float current_value; // Value is [-1, 1]
  float current_time_s;
  float percentage_done; // t / total_length: [0, 1]
 
  bool exponential_chirp;
  bool fade_in;
};
 
void chirp_init(struct chirp_t *chirp, float f0_hz, float f1_hz, float length_s, float current_time_s,
                bool exponential_chirp, bool fade_in);
 
void chirp_reset(struct chirp_t *chirp, float current_time_s);
 
bool chirp_is_running(struct chirp_t *chirp, float current_time_s);
 
float chirp_update(struct chirp_t *chirp, float current_time_s);
 
#endif