|
|
|
@ -1,6 +1,6 @@
@@ -1,6 +1,6 @@
|
|
|
|
|
/****************************************************************************
|
|
|
|
|
* |
|
|
|
|
* Copyright (c) 2013, 2017 PX4 Development Team. All rights reserved. |
|
|
|
|
* Copyright (c) 2013, 2017-2018 PX4 Development Team. All rights reserved. |
|
|
|
|
* |
|
|
|
|
* Redistribution and use in source and binary forms, with or without |
|
|
|
|
* modification, are permitted provided that the following conditions |
|
|
|
@ -31,59 +31,10 @@
@@ -31,59 +31,10 @@
|
|
|
|
|
* |
|
|
|
|
****************************************************************************/ |
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Driver for the PX4 audio alarm port, /dev/tone_alarm. |
|
|
|
|
* |
|
|
|
|
* The tone_alarm driver supports a set of predefined "alarm" |
|
|
|
|
* tunes and one user-supplied tune. |
|
|
|
|
* |
|
|
|
|
* The TONE_SET_ALARM ioctl can be used to select a predefined |
|
|
|
|
* alarm tune, from 1 - <TBD>. Selecting tune zero silences |
|
|
|
|
* the alarm. |
|
|
|
|
* |
|
|
|
|
* Tunes follow the syntax of the Microsoft GWBasic/QBasic PLAY |
|
|
|
|
* statement, with some exceptions and extensions. |
|
|
|
|
* |
|
|
|
|
* From Wikibooks: |
|
|
|
|
* |
|
|
|
|
* PLAY "[string expression]" |
|
|
|
|
* |
|
|
|
|
* Used to play notes and a score ... The tones are indicated by letters A through G. |
|
|
|
|
* Accidentals are indicated with a "+" or "#" (for sharp) or "-" (for flat) |
|
|
|
|
* immediately after the note letter. See this example: |
|
|
|
|
* |
|
|
|
|
* PLAY "C C# C C#" |
|
|
|
|
* |
|
|
|
|
* Whitespaces are ignored inside the string expression. There are also codes that |
|
|
|
|
* set the duration, octave and tempo. They are all case-insensitive. PLAY executes |
|
|
|
|
* the commands or notes the order in which they appear in the string. Any indicators |
|
|
|
|
* that change the properties are effective for the notes following that indicator. |
|
|
|
|
* |
|
|
|
|
* Ln Sets the duration (length) of the notes. The variable n does not indicate an actual duration |
|
|
|
|
* amount but rather a note type; L1 - whole note, L2 - half note, L4 - quarter note, etc. |
|
|
|
|
* (L8, L16, L32, L64, ...). By default, n = 4. |
|
|
|
|
* For triplets and quintets, use L3, L6, L12, ... and L5, L10, L20, ... series respectively. |
|
|
|
|
* The shorthand notation of length is also provided for a note. For example, "L4 CDE L8 FG L4 AB" |
|
|
|
|
* can be shortened to "L4 CDE F8G8 AB". F and G play as eighth notes while others play as quarter notes. |
|
|
|
|
* On Sets the current octave. Valid values for n are 0 through 6. An octave begins with C and ends with B. |
|
|
|
|
* Remember that C- is equivalent to B. |
|
|
|
|
* < > Changes the current octave respectively down or up one level. |
|
|
|
|
* Nn Plays a specified note in the seven-octave range. Valid values are from 0 to 84. (0 is a pause.) |
|
|
|
|
* Cannot use with sharp and flat. Cannot use with the shorthand notation neither. |
|
|
|
|
* MN Stand for Music Normal. Note duration is 7/8ths of the length indicated by Ln. It is the default mode. |
|
|
|
|
* ML Stand for Music Legato. Note duration is full length of that indicated by Ln. |
|
|
|
|
* MS Stand for Music Staccato. Note duration is 3/4ths of the length indicated by Ln. |
|
|
|
|
* Pn Causes a silence (pause) for the length of note indicated (same as Ln). |
|
|
|
|
* Tn Sets the number of "L4"s per minute (tempo). Valid values are from 32 to 255. The default value is T120. |
|
|
|
|
* . When placed after a note, it causes the duration of the note to be 3/2 of the set duration. |
|
|
|
|
* This is how to get "dotted" notes. "L4 C#." would play C sharp as a dotted quarter note. |
|
|
|
|
* It can be used for a pause as well. |
|
|
|
|
* |
|
|
|
|
* Extensions/variations: |
|
|
|
|
* |
|
|
|
|
* MB MF The MF command causes the tune to play once and then stop. The MB command causes the |
|
|
|
|
* tune to repeat when it ends. |
|
|
|
|
* |
|
|
|
|
/*
|
|
|
|
|
* Simulated Low Level Driver for the PX4 audio alarm port. Subscribes to |
|
|
|
|
* tune_control and plays notes on this architecture specific |
|
|
|
|
* timer HW |
|
|
|
|
*/ |
|
|
|
|
|
|
|
|
|
#include <px4_config.h> |
|
|
|
@ -108,102 +59,77 @@
@@ -108,102 +59,77 @@
|
|
|
|
|
#include <drivers/drv_hrt.h> |
|
|
|
|
|
|
|
|
|
#include <systemlib/err.h> |
|
|
|
|
#include <circuit_breaker/circuit_breaker.h> |
|
|
|
|
|
|
|
|
|
#include <lib/tunes/tunes.h> |
|
|
|
|
#include <uORB/uORB.h> |
|
|
|
|
#include <uORB/topics/tune_control.h> |
|
|
|
|
|
|
|
|
|
#include "VirtDevObj.hpp" |
|
|
|
|
|
|
|
|
|
using namespace DriverFramework; |
|
|
|
|
|
|
|
|
|
#if !defined(UNUSED) |
|
|
|
|
# define UNUSED(a) ((void)(a)) |
|
|
|
|
#endif |
|
|
|
|
|
|
|
|
|
#define CBRK_BUZZER_KEY 782097 |
|
|
|
|
|
|
|
|
|
class ToneAlarm : public VirtDevObj |
|
|
|
|
{ |
|
|
|
|
public: |
|
|
|
|
ToneAlarm(); |
|
|
|
|
~ToneAlarm() = default; |
|
|
|
|
|
|
|
|
|
virtual int devIOCTL(unsigned long cmd, unsigned long arg); |
|
|
|
|
virtual ssize_t devWrite(const void *buffer, size_t len); |
|
|
|
|
inline const char *name(int tune) |
|
|
|
|
{ |
|
|
|
|
return _tune_names[tune]; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
private: |
|
|
|
|
static const unsigned _tune_max = 1024 * 8; // be reasonable about user tunes
|
|
|
|
|
const char *_default_tunes[TONE_NUMBER_OF_TUNES]; |
|
|
|
|
const char *_tune_names[TONE_NUMBER_OF_TUNES]; |
|
|
|
|
static const uint8_t _note_tab[]; |
|
|
|
|
~ToneAlarm(); |
|
|
|
|
|
|
|
|
|
unsigned _default_tune_number; // number of currently playing default tune (0 for none)
|
|
|
|
|
virtual int init(); |
|
|
|
|
void status(); |
|
|
|
|
|
|
|
|
|
const char *_user_tune; |
|
|
|
|
enum { |
|
|
|
|
CBRK_OFF = 0, |
|
|
|
|
CBRK_ON, |
|
|
|
|
CBRK_UNINIT |
|
|
|
|
}; |
|
|
|
|
|
|
|
|
|
const char *_tune; // current tune string
|
|
|
|
|
const char *_next; // next note in the string
|
|
|
|
|
private: |
|
|
|
|
volatile bool _running; |
|
|
|
|
volatile bool _should_run; |
|
|
|
|
bool _play_tone; |
|
|
|
|
|
|
|
|
|
unsigned _tempo; |
|
|
|
|
unsigned _note_length; |
|
|
|
|
enum { MODE_NORMAL, MODE_LEGATO, MODE_STACCATO} _note_mode; |
|
|
|
|
unsigned _octave; |
|
|
|
|
unsigned _silence_length; // if nonzero, silence before next note
|
|
|
|
|
bool _repeat; // if true, tune restarts at end
|
|
|
|
|
Tunes _tunes; |
|
|
|
|
|
|
|
|
|
hrt_call _note_call; // HRT callout for note completion
|
|
|
|
|
|
|
|
|
|
// Convert a note value in the range C1 to B7 into a divisor for
|
|
|
|
|
// the configured timer's clock.
|
|
|
|
|
//
|
|
|
|
|
unsigned note_to_divisor(unsigned note); |
|
|
|
|
unsigned _silence_length; // if nonzero, silence before next note
|
|
|
|
|
|
|
|
|
|
// Calculate the duration in microseconds of play and silence for a
|
|
|
|
|
// note given the current tempo, length and mode and the number of
|
|
|
|
|
// dots following in the play string.
|
|
|
|
|
//
|
|
|
|
|
unsigned note_duration(unsigned &silence, unsigned note_length, unsigned dots); |
|
|
|
|
int _cbrk; ///< if true, no audio output
|
|
|
|
|
int _tune_control_sub; |
|
|
|
|
|
|
|
|
|
// Calculate the duration in microseconds of a rest corresponding to
|
|
|
|
|
// a given note length.
|
|
|
|
|
tune_control_s _tune; |
|
|
|
|
|
|
|
|
|
// Convert a frequency value into a divisor for the configured timer's clock.
|
|
|
|
|
//
|
|
|
|
|
unsigned rest_duration(unsigned rest_length, unsigned dots); |
|
|
|
|
unsigned frequency_to_divisor(unsigned frequency); |
|
|
|
|
|
|
|
|
|
// Start playing the note
|
|
|
|
|
//
|
|
|
|
|
void start_note(unsigned note); |
|
|
|
|
void start_note(unsigned frequency); |
|
|
|
|
|
|
|
|
|
// Stop playing the current note and make the player 'safe'
|
|
|
|
|
//
|
|
|
|
|
void stop_note(); |
|
|
|
|
|
|
|
|
|
// Start playing the tune
|
|
|
|
|
//
|
|
|
|
|
void start_tune(const char *tune); |
|
|
|
|
void stop_note(); |
|
|
|
|
|
|
|
|
|
// Parse the next note out of the string and play it
|
|
|
|
|
//
|
|
|
|
|
void next_note(); |
|
|
|
|
|
|
|
|
|
// Find the next character in the string, discard any whitespace and
|
|
|
|
|
// return the canonical (uppercase) version.
|
|
|
|
|
//
|
|
|
|
|
int next_char(); |
|
|
|
|
|
|
|
|
|
// Extract a number from the string, consuming all the digit characters.
|
|
|
|
|
//
|
|
|
|
|
unsigned next_number(); |
|
|
|
|
|
|
|
|
|
// Consume dot characters from the string, returning the number consumed.
|
|
|
|
|
//
|
|
|
|
|
unsigned next_dots(); |
|
|
|
|
void next_note(); |
|
|
|
|
|
|
|
|
|
// hrt_call trampoline for next_note
|
|
|
|
|
//
|
|
|
|
|
static void next_trampoline(void *arg); |
|
|
|
|
static void next_trampoline(void *arg); |
|
|
|
|
|
|
|
|
|
// Unused
|
|
|
|
|
virtual void _measure() {} |
|
|
|
|
}; |
|
|
|
|
|
|
|
|
|
// semitone offsets from C for the characters 'A'-'G'
|
|
|
|
|
const uint8_t ToneAlarm::_note_tab[] = {9, 11, 0, 2, 4, 5, 7}; |
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Driver 'main' command. |
|
|
|
|
*/ |
|
|
|
@ -212,128 +138,75 @@ extern "C" __EXPORT int tone_alarm_main(int argc, char *argv[]);
@@ -212,128 +138,75 @@ extern "C" __EXPORT int tone_alarm_main(int argc, char *argv[]);
|
|
|
|
|
|
|
|
|
|
ToneAlarm::ToneAlarm() : |
|
|
|
|
VirtDevObj("tone_alarm", TONEALARM0_DEVICE_PATH, nullptr, 0), |
|
|
|
|
_default_tune_number(0), |
|
|
|
|
_user_tune(nullptr), |
|
|
|
|
_tune(nullptr), |
|
|
|
|
_next(nullptr), |
|
|
|
|
_note_call{} |
|
|
|
|
_running(false), |
|
|
|
|
_should_run(true), |
|
|
|
|
_play_tone(false), |
|
|
|
|
_tunes(), |
|
|
|
|
_silence_length(0), |
|
|
|
|
_cbrk(CBRK_UNINIT), |
|
|
|
|
_tune_control_sub(-1) |
|
|
|
|
{ |
|
|
|
|
_default_tunes[TONE_STARTUP_TUNE] = "MFT240L8 O4aO5dc O4aO5dc O4aO5dc L16dcdcdcdc"; // startup tune
|
|
|
|
|
_default_tunes[TONE_ERROR_TUNE] = "MBT200a8a8a8PaaaP"; // ERROR tone
|
|
|
|
|
_default_tunes[TONE_NOTIFY_POSITIVE_TUNE] = "MFT200e8a8a"; // Notify Positive tone
|
|
|
|
|
_default_tunes[TONE_NOTIFY_NEUTRAL_TUNE] = "MFT200e8e"; // Notify Neutral tone
|
|
|
|
|
_default_tunes[TONE_NOTIFY_NEGATIVE_TUNE] = "MFT200e8c8e8c8e8c8"; // Notify Negative tone
|
|
|
|
|
_default_tunes[TONE_ARMING_WARNING_TUNE] = "MNT75L1O2G"; //arming warning
|
|
|
|
|
_default_tunes[TONE_BATTERY_WARNING_SLOW_TUNE] = "MBNT100a8"; //battery warning slow
|
|
|
|
|
_default_tunes[TONE_BATTERY_WARNING_FAST_TUNE] = "MBNT255a8a8a8a8a8a8a8a8a8a8a8a8a8a8a8a8"; //battery warning fast
|
|
|
|
|
_default_tunes[TONE_GPS_WARNING_TUNE] = "MFT255L4AAAL1F#"; //gps warning slow
|
|
|
|
|
_default_tunes[TONE_ARMING_FAILURE_TUNE] = "MFT255L4<<<BAP"; |
|
|
|
|
_default_tunes[TONE_PARACHUTE_RELEASE_TUNE] = "MFT255L16agagagag"; // parachute release
|
|
|
|
|
_default_tunes[TONE_EKF_WARNING_TUNE] = "MFT255L8ddd#d#eeff"; // ekf warning
|
|
|
|
|
_default_tunes[TONE_BARO_WARNING_TUNE] = "MFT255L4gf#fed#d"; // baro warning
|
|
|
|
|
_default_tunes[TONE_SINGLE_BEEP_TUNE] = "MFT100a8"; // single beep
|
|
|
|
|
|
|
|
|
|
_tune_names[TONE_STARTUP_TUNE] = "startup"; // startup tune
|
|
|
|
|
_tune_names[TONE_ERROR_TUNE] = "error"; // ERROR tone
|
|
|
|
|
_tune_names[TONE_NOTIFY_POSITIVE_TUNE] = "positive"; // Notify Positive tone
|
|
|
|
|
_tune_names[TONE_NOTIFY_NEUTRAL_TUNE] = "neutral"; // Notify Neutral tone
|
|
|
|
|
_tune_names[TONE_NOTIFY_NEGATIVE_TUNE] = "negative"; // Notify Negative tone
|
|
|
|
|
_tune_names[TONE_ARMING_WARNING_TUNE] = "arming"; // arming warning
|
|
|
|
|
_tune_names[TONE_BATTERY_WARNING_SLOW_TUNE] = "slow_bat"; // battery warning slow
|
|
|
|
|
_tune_names[TONE_BATTERY_WARNING_FAST_TUNE] = "fast_bat"; // battery warning fast
|
|
|
|
|
_tune_names[TONE_GPS_WARNING_TUNE] = "gps_warning"; // gps warning
|
|
|
|
|
_tune_names[TONE_ARMING_FAILURE_TUNE] = "arming_failure"; //fail to arm
|
|
|
|
|
_tune_names[TONE_PARACHUTE_RELEASE_TUNE] = "parachute_release"; // parachute release
|
|
|
|
|
_tune_names[TONE_EKF_WARNING_TUNE] = "ekf_warning"; // ekf warning
|
|
|
|
|
_tune_names[TONE_BARO_WARNING_TUNE] = "baro_warning"; // baro warning
|
|
|
|
|
_tune_names[TONE_SINGLE_BEEP_TUNE] = "beep"; // single beep
|
|
|
|
|
_tune_names[TONE_HOME_SET] = "home_set"; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
unsigned |
|
|
|
|
ToneAlarm::note_to_divisor(unsigned note) |
|
|
|
|
ToneAlarm::~ToneAlarm() |
|
|
|
|
{ |
|
|
|
|
const int TONE_ALARM_CLOCK = 120000000ul / 4; |
|
|
|
|
_should_run = false; |
|
|
|
|
int counter = 0; |
|
|
|
|
|
|
|
|
|
// compute the frequency first (Hz)
|
|
|
|
|
float freq = 880.0f * expf(logf(2.0f) * ((int)note - 46) / 12.0f); |
|
|
|
|
|
|
|
|
|
float period = 0.5f / freq; |
|
|
|
|
|
|
|
|
|
// and the divisor, rounded to the nearest integer
|
|
|
|
|
unsigned divisor = (period * TONE_ALARM_CLOCK) + 0.5f; |
|
|
|
|
|
|
|
|
|
return divisor; |
|
|
|
|
while (_running && ++counter < 10) { |
|
|
|
|
usleep(100000); |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
unsigned |
|
|
|
|
ToneAlarm::note_duration(unsigned &silence, unsigned note_length, unsigned dots) |
|
|
|
|
int ToneAlarm::init() |
|
|
|
|
{ |
|
|
|
|
unsigned whole_note_period = (60 * 1000000 * 4) / _tempo; |
|
|
|
|
|
|
|
|
|
if (note_length == 0) { |
|
|
|
|
note_length = 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
unsigned note_period = whole_note_period / note_length; |
|
|
|
|
|
|
|
|
|
switch (_note_mode) { |
|
|
|
|
case MODE_NORMAL: |
|
|
|
|
silence = note_period / 8; |
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
case MODE_STACCATO: |
|
|
|
|
silence = note_period / 4; |
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
default: |
|
|
|
|
case MODE_LEGATO: |
|
|
|
|
silence = 0; |
|
|
|
|
break; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
note_period -= silence; |
|
|
|
|
int ret; |
|
|
|
|
|
|
|
|
|
unsigned dot_extension = note_period / 2; |
|
|
|
|
ret = VirtDevObj::init(); |
|
|
|
|
|
|
|
|
|
while (dots--) { |
|
|
|
|
note_period += dot_extension; |
|
|
|
|
dot_extension /= 2; |
|
|
|
|
if (ret != OK) { |
|
|
|
|
return ret; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
return note_period; |
|
|
|
|
_note_call = {}; |
|
|
|
|
hrt_call_after(&_note_call, (hrt_abstime)TUNE_MAX_UPDATE_INTERVAL_US, (hrt_callout)next_trampoline, this); |
|
|
|
|
_running = true; |
|
|
|
|
return OK; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
unsigned |
|
|
|
|
ToneAlarm::rest_duration(unsigned rest_length, unsigned dots) |
|
|
|
|
void ToneAlarm::status() |
|
|
|
|
{ |
|
|
|
|
unsigned whole_note_period = (60 * 1000000 * 4) / _tempo; |
|
|
|
|
if (_running) { |
|
|
|
|
PX4_INFO("running"); |
|
|
|
|
|
|
|
|
|
if (rest_length == 0) { |
|
|
|
|
rest_length = 1; |
|
|
|
|
} else { |
|
|
|
|
PX4_INFO("stopped"); |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
unsigned rest_period = whole_note_period / rest_length; |
|
|
|
|
unsigned ToneAlarm::frequency_to_divisor(unsigned frequency) |
|
|
|
|
{ |
|
|
|
|
const int TONE_ALARM_CLOCK = 120000000ul / 4; |
|
|
|
|
|
|
|
|
|
unsigned dot_extension = rest_period / 2; |
|
|
|
|
float period = 0.5f / frequency; |
|
|
|
|
|
|
|
|
|
while (dots--) { |
|
|
|
|
rest_period += dot_extension; |
|
|
|
|
dot_extension /= 2; |
|
|
|
|
} |
|
|
|
|
// and the divisor, rounded to the nearest integer
|
|
|
|
|
unsigned divisor = (period * TONE_ALARM_CLOCK) + 0.5f; |
|
|
|
|
|
|
|
|
|
return rest_period; |
|
|
|
|
return divisor; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
static void do_something(unsigned x) |
|
|
|
|
void ToneAlarm::start_note(unsigned frequency) |
|
|
|
|
{ |
|
|
|
|
} |
|
|
|
|
// check if circuit breaker is enabled
|
|
|
|
|
if (_cbrk == CBRK_UNINIT) { |
|
|
|
|
_cbrk = circuit_breaker_enabled("CBRK_BUZZER", CBRK_BUZZER_KEY); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
if (_cbrk != CBRK_OFF) { return; } |
|
|
|
|
|
|
|
|
|
void |
|
|
|
|
ToneAlarm::start_note(unsigned note) |
|
|
|
|
{ |
|
|
|
|
// compute the divisor
|
|
|
|
|
unsigned divisor = note_to_divisor(note); |
|
|
|
|
unsigned divisor = frequency_to_divisor(frequency); |
|
|
|
|
|
|
|
|
|
// pick the lowest prescaler value that we can use
|
|
|
|
|
// (note that the effective prescale value is 1 greater)
|
|
|
|
@ -343,42 +216,30 @@ ToneAlarm::start_note(unsigned note)
@@ -343,42 +216,30 @@ ToneAlarm::start_note(unsigned note)
|
|
|
|
|
unsigned period = (divisor / (prescale + 1)) - 1; |
|
|
|
|
|
|
|
|
|
// Silence warning of unused var
|
|
|
|
|
do_something(period); |
|
|
|
|
UNUSED(period); |
|
|
|
|
PX4_DEBUG("ToneAlarm::start_note %u", period); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
void |
|
|
|
|
ToneAlarm::stop_note() |
|
|
|
|
void ToneAlarm::stop_note() |
|
|
|
|
{ |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
void |
|
|
|
|
ToneAlarm::start_tune(const char *tune) |
|
|
|
|
void ToneAlarm::next_note() |
|
|
|
|
{ |
|
|
|
|
PX4_DEBUG("ToneAlarm::start_tune"); |
|
|
|
|
// kill any current playback
|
|
|
|
|
hrt_cancel(&_note_call); |
|
|
|
|
|
|
|
|
|
// record the tune
|
|
|
|
|
_tune = tune; |
|
|
|
|
_next = tune; |
|
|
|
|
|
|
|
|
|
// initialise player state
|
|
|
|
|
_tempo = 120; |
|
|
|
|
_note_length = 4; |
|
|
|
|
_note_mode = MODE_NORMAL; |
|
|
|
|
_octave = 4; |
|
|
|
|
_silence_length = 0; |
|
|
|
|
_repeat = false; // otherwise command-line tunes repeat forever...
|
|
|
|
|
|
|
|
|
|
// schedule a callback to start playing
|
|
|
|
|
_note_call = {}; |
|
|
|
|
hrt_call_after(&_note_call, 0, (hrt_callout)next_trampoline, this); |
|
|
|
|
} |
|
|
|
|
if (!_should_run) { |
|
|
|
|
if (_tune_control_sub >= 0) { |
|
|
|
|
orb_unsubscribe(_tune_control_sub); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
_running = false; |
|
|
|
|
return; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// subscribe to tune_control
|
|
|
|
|
if (_tune_control_sub < 0) { |
|
|
|
|
_tune_control_sub = orb_subscribe(ORB_ID(tune_control)); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
void |
|
|
|
|
ToneAlarm::next_note() |
|
|
|
|
{ |
|
|
|
|
// do we have an inter-note gap to wait for?
|
|
|
|
|
if (_silence_length > 0) { |
|
|
|
|
stop_note(); |
|
|
|
@ -388,347 +249,58 @@ ToneAlarm::next_note()
@@ -388,347 +249,58 @@ ToneAlarm::next_note()
|
|
|
|
|
return; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// make sure we still have a tune - may be removed by the write / ioctl handler
|
|
|
|
|
if ((_next == nullptr) || (_tune == nullptr)) { |
|
|
|
|
stop_note(); |
|
|
|
|
return; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// parse characters out of the string until we have resolved a note
|
|
|
|
|
unsigned note = 0; |
|
|
|
|
unsigned note_length = _note_length; |
|
|
|
|
unsigned duration; |
|
|
|
|
|
|
|
|
|
while (note == 0) { |
|
|
|
|
// we always need at least one character from the string
|
|
|
|
|
int c = next_char(); |
|
|
|
|
|
|
|
|
|
if (c == 0) { |
|
|
|
|
goto tune_end; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
_next++; |
|
|
|
|
|
|
|
|
|
switch (c) { |
|
|
|
|
case 'L': // select note length
|
|
|
|
|
_note_length = next_number(); |
|
|
|
|
|
|
|
|
|
if (_note_length < 1) { |
|
|
|
|
goto tune_error; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
case 'O': // select octave
|
|
|
|
|
_octave = next_number(); |
|
|
|
|
|
|
|
|
|
if (_octave > 6) { |
|
|
|
|
_octave = 6; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
case '<': // decrease octave
|
|
|
|
|
if (_octave > 0) { |
|
|
|
|
_octave--; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
case '>': // increase octave
|
|
|
|
|
if (_octave < 6) { |
|
|
|
|
_octave++; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
case 'M': // select inter-note gap
|
|
|
|
|
c = next_char(); |
|
|
|
|
|
|
|
|
|
if (c == 0) { |
|
|
|
|
goto tune_error; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
_next++; |
|
|
|
|
|
|
|
|
|
switch (c) { |
|
|
|
|
case 'N': |
|
|
|
|
_note_mode = MODE_NORMAL; |
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
case 'L': |
|
|
|
|
_note_mode = MODE_LEGATO; |
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
case 'S': |
|
|
|
|
_note_mode = MODE_STACCATO; |
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
case 'F': |
|
|
|
|
_repeat = false; |
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
case 'B': |
|
|
|
|
_repeat = true; |
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
default: |
|
|
|
|
goto tune_error; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
case 'P': // pause for a note length
|
|
|
|
|
stop_note(); |
|
|
|
|
_note_call = {}; |
|
|
|
|
hrt_call_after(&_note_call, |
|
|
|
|
(hrt_abstime)rest_duration(next_number(), next_dots()), |
|
|
|
|
(hrt_callout)next_trampoline, |
|
|
|
|
this); |
|
|
|
|
return; |
|
|
|
|
|
|
|
|
|
case 'T': { // change tempo
|
|
|
|
|
unsigned nt = next_number(); |
|
|
|
|
|
|
|
|
|
if ((nt >= 32) && (nt <= 255)) { |
|
|
|
|
_tempo = nt; |
|
|
|
|
|
|
|
|
|
} else { |
|
|
|
|
goto tune_error; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
break; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
case 'N': // play an arbitrary note
|
|
|
|
|
note = next_number(); |
|
|
|
|
|
|
|
|
|
if (note > 84) { |
|
|
|
|
goto tune_error; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
if (note == 0) { |
|
|
|
|
// this is a rest - pause for the current note length
|
|
|
|
|
_note_call = {}; |
|
|
|
|
hrt_call_after(&_note_call, |
|
|
|
|
(hrt_abstime)rest_duration(_note_length, next_dots()), |
|
|
|
|
(hrt_callout)next_trampoline, |
|
|
|
|
this); |
|
|
|
|
return; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
case 'A'...'G': // play a note in the current octave
|
|
|
|
|
note = _note_tab[c - 'A'] + (_octave * 12) + 1; |
|
|
|
|
c = next_char(); |
|
|
|
|
// check for updates
|
|
|
|
|
bool updated = false; |
|
|
|
|
orb_check(_tune_control_sub, &updated); |
|
|
|
|
|
|
|
|
|
switch (c) { |
|
|
|
|
case '#': // up a semitone
|
|
|
|
|
case '+': |
|
|
|
|
if (note < 84) { |
|
|
|
|
note++; |
|
|
|
|
} |
|
|
|
|
if (updated) { |
|
|
|
|
orb_copy(ORB_ID(tune_control), _tune_control_sub, &_tune); |
|
|
|
|
_play_tone = _tunes.set_control(_tune) == 0; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
_next++; |
|
|
|
|
break; |
|
|
|
|
unsigned frequency = 0; |
|
|
|
|
unsigned duration = 0; |
|
|
|
|
|
|
|
|
|
case '-': // down a semitone
|
|
|
|
|
if (note > 1) { |
|
|
|
|
note--; |
|
|
|
|
} |
|
|
|
|
if (_play_tone) { |
|
|
|
|
_play_tone = false; |
|
|
|
|
int parse_ret_val = _tunes.get_next_tune(frequency, duration, _silence_length); |
|
|
|
|
|
|
|
|
|
_next++; |
|
|
|
|
break; |
|
|
|
|
if (parse_ret_val >= 0) { |
|
|
|
|
// a frequency of 0 correspond to stop_note
|
|
|
|
|
if (frequency > 0) { |
|
|
|
|
// start playing the note
|
|
|
|
|
start_note(frequency); |
|
|
|
|
|
|
|
|
|
default: |
|
|
|
|
// 0 / no next char here is OK
|
|
|
|
|
break; |
|
|
|
|
} else { |
|
|
|
|
stop_note(); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// shorthand length notation
|
|
|
|
|
note_length = next_number(); |
|
|
|
|
|
|
|
|
|
if (note_length == 0) { |
|
|
|
|
note_length = _note_length; |
|
|
|
|
if (parse_ret_val > 0) { |
|
|
|
|
// continue playing
|
|
|
|
|
_play_tone = true; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
default: |
|
|
|
|
goto tune_error; |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// compute the duration of the note and the following silence (if any)
|
|
|
|
|
duration = note_duration(_silence_length, note_length, next_dots()); |
|
|
|
|
|
|
|
|
|
// start playing the note
|
|
|
|
|
start_note(note); |
|
|
|
|
|
|
|
|
|
// and arrange a callback when the note should stop
|
|
|
|
|
_note_call = {}; |
|
|
|
|
hrt_call_after(&_note_call, (hrt_abstime)duration, (hrt_callout)next_trampoline, this); |
|
|
|
|
return; |
|
|
|
|
|
|
|
|
|
// tune looks bad (unexpected EOF, bad character, etc.)
|
|
|
|
|
tune_error: |
|
|
|
|
PX4_ERR("tune error\n"); |
|
|
|
|
_repeat = false; // don't loop on error
|
|
|
|
|
|
|
|
|
|
// stop (and potentially restart) the tune
|
|
|
|
|
tune_end: |
|
|
|
|
stop_note(); |
|
|
|
|
|
|
|
|
|
if (_repeat) { |
|
|
|
|
start_tune(_tune); |
|
|
|
|
|
|
|
|
|
} else { |
|
|
|
|
_tune = nullptr; |
|
|
|
|
_default_tune_number = 0; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
int |
|
|
|
|
ToneAlarm::next_char() |
|
|
|
|
{ |
|
|
|
|
while (isspace(*_next)) { |
|
|
|
|
_next++; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
return toupper(*_next); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
unsigned |
|
|
|
|
ToneAlarm::next_number() |
|
|
|
|
{ |
|
|
|
|
unsigned number = 0; |
|
|
|
|
int c; |
|
|
|
|
|
|
|
|
|
for (;;) { |
|
|
|
|
c = next_char(); |
|
|
|
|
|
|
|
|
|
if (!isdigit(c)) { |
|
|
|
|
return number; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
_next++; |
|
|
|
|
number = (number * 10) + (c - '0'); |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
unsigned |
|
|
|
|
ToneAlarm::next_dots() |
|
|
|
|
{ |
|
|
|
|
unsigned dots = 0; |
|
|
|
|
|
|
|
|
|
while (next_char() == '.') { |
|
|
|
|
_next++; |
|
|
|
|
dots++; |
|
|
|
|
// schedule a call with the tunes max interval
|
|
|
|
|
duration = _tunes.get_maximum_update_interval(); |
|
|
|
|
// stop playing the last note after the duration elapsed
|
|
|
|
|
stop_note(); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
return dots; |
|
|
|
|
// and arrange a callback when the note should stop
|
|
|
|
|
assert(duration != 0); |
|
|
|
|
_note_call = {}; |
|
|
|
|
hrt_call_after(&_note_call, (hrt_abstime) duration, (hrt_callout)next_trampoline, this); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
void |
|
|
|
|
ToneAlarm::next_trampoline(void *arg) |
|
|
|
|
void ToneAlarm::next_trampoline(void *arg) |
|
|
|
|
{ |
|
|
|
|
ToneAlarm *ta = (ToneAlarm *)arg; |
|
|
|
|
|
|
|
|
|
ta->next_note(); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
int |
|
|
|
|
ToneAlarm::devIOCTL(unsigned long cmd, unsigned long arg) |
|
|
|
|
{ |
|
|
|
|
int result = OK; |
|
|
|
|
|
|
|
|
|
PX4_DEBUG("ToneAlarm::devIOCTL %i %lu", cmd, arg); |
|
|
|
|
|
|
|
|
|
/* decide whether to increase the alarm level to cmd or leave it alone */ |
|
|
|
|
switch (cmd) { |
|
|
|
|
case TONE_SET_ALARM: |
|
|
|
|
if (arg < TONE_NUMBER_OF_TUNES) { |
|
|
|
|
if (arg == TONE_STOP_TUNE) { |
|
|
|
|
// stop the tune
|
|
|
|
|
_tune = nullptr; |
|
|
|
|
_next = nullptr; |
|
|
|
|
_repeat = false; |
|
|
|
|
_default_tune_number = 0; |
|
|
|
|
|
|
|
|
|
} else { |
|
|
|
|
/* always interrupt alarms, unless they are repeating and already playing */ |
|
|
|
|
if (!(_repeat && _default_tune_number == arg)) { |
|
|
|
|
/* play the selected tune */ |
|
|
|
|
_default_tune_number = arg; |
|
|
|
|
start_tune(_default_tunes[arg]); |
|
|
|
|
PX4_INFO("%s", _tune_names[arg]); |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
} else { |
|
|
|
|
result = -EINVAL; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
break; |
|
|
|
|
|
|
|
|
|
default: |
|
|
|
|
result = -ENOTTY; |
|
|
|
|
break; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
/* give it to the superclass if we didn't like it */ |
|
|
|
|
if (result == -ENOTTY) { |
|
|
|
|
result = VirtDevObj::devIOCTL(cmd, arg); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
return result; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
ssize_t |
|
|
|
|
ToneAlarm::devWrite(const void *buffer, size_t len) |
|
|
|
|
{ |
|
|
|
|
// sanity-check the buffer for length and nul-termination
|
|
|
|
|
if (len > _tune_max) { |
|
|
|
|
return -EFBIG; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// if we have an existing user tune, free it
|
|
|
|
|
if (_user_tune != nullptr) { |
|
|
|
|
|
|
|
|
|
// if we are playing the user tune, stop
|
|
|
|
|
if (_tune == _user_tune) { |
|
|
|
|
_tune = nullptr; |
|
|
|
|
_next = nullptr; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// free the old user tune
|
|
|
|
|
free((void *)_user_tune); |
|
|
|
|
_user_tune = nullptr; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
const char *buf = reinterpret_cast<const char *>(buffer); |
|
|
|
|
|
|
|
|
|
// if the new tune is empty, we're done
|
|
|
|
|
if (buf[0] == '\0') { |
|
|
|
|
return OK; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// allocate a copy of the new tune
|
|
|
|
|
_user_tune = strndup(buf, len); |
|
|
|
|
|
|
|
|
|
if (_user_tune == nullptr) { |
|
|
|
|
return -ENOMEM; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// and play it
|
|
|
|
|
start_tune(_user_tune); |
|
|
|
|
|
|
|
|
|
return len; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Local functions in support of the shell command. |
|
|
|
|
*/ |
|
|
|
@ -737,147 +309,59 @@ namespace
@@ -737,147 +309,59 @@ namespace
|
|
|
|
|
|
|
|
|
|
ToneAlarm *g_dev; |
|
|
|
|
|
|
|
|
|
int |
|
|
|
|
play_tune(unsigned tune) |
|
|
|
|
{ |
|
|
|
|
int ret; |
|
|
|
|
|
|
|
|
|
DevHandle h; |
|
|
|
|
DevMgr::getHandle(TONEALARM0_DEVICE_PATH, h); |
|
|
|
|
|
|
|
|
|
if (!h.isValid()) { |
|
|
|
|
PX4_WARN("Error: failed to open %s (%d)", TONEALARM0_DEVICE_PATH, h.getError()); |
|
|
|
|
return 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
ret = h.ioctl(TONE_SET_ALARM, tune); |
|
|
|
|
|
|
|
|
|
if (ret != 0) { |
|
|
|
|
PX4_WARN("TONE_SET_ALARM"); |
|
|
|
|
return 1; |
|
|
|
|
} |
|
|
|
|
} // namespace
|
|
|
|
|
|
|
|
|
|
return ret; |
|
|
|
|
} |
|
|
|
|
void tone_alarm_usage(); |
|
|
|
|
|
|
|
|
|
int |
|
|
|
|
play_string(const char *str, bool free_buffer) |
|
|
|
|
void tone_alarm_usage() |
|
|
|
|
{ |
|
|
|
|
int ret; |
|
|
|
|
|
|
|
|
|
DevHandle h; |
|
|
|
|
DevMgr::getHandle(TONEALARM0_DEVICE_PATH, h); |
|
|
|
|
|
|
|
|
|
if (!h.isValid()) { |
|
|
|
|
PX4_WARN("Error: failed to get handle to %s", TONEALARM0_DEVICE_PATH); |
|
|
|
|
return 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
ret = h.write(str, strlen(str) + 1); |
|
|
|
|
DevMgr::releaseHandle(h); |
|
|
|
|
|
|
|
|
|
if (free_buffer) { |
|
|
|
|
free((void *)str); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
if (ret < 0) { |
|
|
|
|
PX4_WARN("play tune"); |
|
|
|
|
return 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
return ret; |
|
|
|
|
PX4_INFO("missing command, try 'start', status, 'stop'"); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
} // namespace
|
|
|
|
|
|
|
|
|
|
int |
|
|
|
|
tone_alarm_main(int argc, char *argv[]) |
|
|
|
|
int tone_alarm_main(int argc, char *argv[]) |
|
|
|
|
{ |
|
|
|
|
unsigned tune; |
|
|
|
|
int ret = 1; |
|
|
|
|
|
|
|
|
|
/* start the driver lazily */ |
|
|
|
|
if (g_dev == nullptr) { |
|
|
|
|
g_dev = new ToneAlarm; |
|
|
|
|
|
|
|
|
|
if (g_dev == nullptr) { |
|
|
|
|
PX4_WARN("couldn't allocate the ToneAlarm driver"); |
|
|
|
|
return 1; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
if (g_dev->init() != OK) { |
|
|
|
|
delete g_dev; |
|
|
|
|
PX4_WARN("ToneAlarm init failed"); |
|
|
|
|
return 1; |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
if (argc > 1) { |
|
|
|
|
const char *argv1 = argv[1]; |
|
|
|
|
|
|
|
|
|
if (!strcmp(argv1, "start")) { |
|
|
|
|
ret = play_tune(TONE_STOP_TUNE); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
else if (!strcmp(argv1, "stop")) { |
|
|
|
|
ret = play_tune(TONE_STOP_TUNE); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
else if ((tune = strtol(argv1, nullptr, 10)) != 0) { |
|
|
|
|
ret = play_tune(tune); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
/* If it is a file name then load and play it as a string */ |
|
|
|
|
else if (*argv1 == '/') { |
|
|
|
|
FILE *fd = fopen(argv1, "r"); |
|
|
|
|
int sz; |
|
|
|
|
char *buffer; |
|
|
|
|
|
|
|
|
|
if (fd == nullptr) { |
|
|
|
|
PX4_WARN("couldn't open '%s'", argv1); |
|
|
|
|
return 1; |
|
|
|
|
if (g_dev != nullptr) { |
|
|
|
|
PX4_ERR("already started"); |
|
|
|
|
exit(1); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
fseek(fd, 0, SEEK_END); |
|
|
|
|
sz = ftell(fd); |
|
|
|
|
fseek(fd, 0, SEEK_SET); |
|
|
|
|
buffer = (char *)malloc(sz + 1); |
|
|
|
|
if (g_dev == nullptr) { |
|
|
|
|
g_dev = new ToneAlarm(); |
|
|
|
|
|
|
|
|
|
if (buffer == nullptr) { |
|
|
|
|
PX4_WARN("not enough memory memory"); |
|
|
|
|
fclose(fd); |
|
|
|
|
return 1; |
|
|
|
|
} |
|
|
|
|
if (g_dev == nullptr) { |
|
|
|
|
PX4_ERR("couldn't allocate the ToneAlarm driver"); |
|
|
|
|
exit(1); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// FIXME - Make GCC happy
|
|
|
|
|
if (fread(buffer, sz, 1, fd)) { } |
|
|
|
|
if (OK != g_dev->init()) { |
|
|
|
|
delete g_dev; |
|
|
|
|
g_dev = nullptr; |
|
|
|
|
PX4_ERR("ToneAlarm init failed"); |
|
|
|
|
exit(1); |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
/* terminate the string */ |
|
|
|
|
buffer[sz] = 0; |
|
|
|
|
ret = play_string(buffer, true); |
|
|
|
|
fclose(fd); |
|
|
|
|
exit(0); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
/* if it looks like a PLAY string... */ |
|
|
|
|
else if (argv1 && (strlen(argv1) > 2)) { |
|
|
|
|
if (*argv1 == 'M') { |
|
|
|
|
ret = play_string(argv1, false); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
} else { |
|
|
|
|
/* It might be a tune name */ |
|
|
|
|
for (tune = 1; tune < TONE_NUMBER_OF_TUNES; tune++) { |
|
|
|
|
if (!strcmp(g_dev->name(tune), argv1)) { |
|
|
|
|
ret = play_tune(tune); |
|
|
|
|
return ret; |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
if (!strcmp(argv1, "stop")) { |
|
|
|
|
delete g_dev; |
|
|
|
|
g_dev = nullptr; |
|
|
|
|
exit(0); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
PX4_WARN("unrecognized command, try 'start', 'stop', an alarm number or name, or a file name starting with a '/'"); |
|
|
|
|
ret = 1; |
|
|
|
|
if (!strcmp(argv1, "status")) { |
|
|
|
|
g_dev->status(); |
|
|
|
|
exit(0); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
return ret; |
|
|
|
|
tone_alarm_usage(); |
|
|
|
|
exit(0); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|