/*
 * BRLTTY - A background process providing access to the console screen (when in
 *          text mode) for a blind person using a refreshable braille display.
 *
 * Copyright (C) 1995-2025 by The BRLTTY Developers.
 *
 * BRLTTY comes with ABSOLUTELY NO WARRANTY.
 *
 * This is free software, placed under the terms of the
 * GNU Lesser General Public License, as published by the Free Software
 * Foundation; either version 2.1 of the License, or (at your option) any
 * later version. Please see the file LICENSE-LGPL for details.
 *
 * Web Page: http://brltty.app/
 *
 * This software is maintained by Dave Mielke <dave@mielke.cc>.
 */

#ifndef BRLTTY_INCLUDED_NOTES
#define BRLTTY_INCLUDED_NOTES

#include "note_types.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define NOTES_PER_OCTAVE 12
#define NOTE_MIDDLE_C 60

extern unsigned char getLowestNote (void);
extern unsigned char getHighestNote (void);

extern uint32_t getIntegerNoteFrequency (unsigned char note);
extern unsigned char getNearestNote (NoteFrequency frequency);

#ifdef NO_FLOAT
#define getNoteFrequency getIntegerNoteFrequency
#else /* NO_FLOAT */
extern float getRealNoteFrequency (unsigned char note);
#define getNoteFrequency getRealNoteFrequency
#endif /* NO_FLOAT */

typedef struct NoteDeviceStruct NoteDevice;

typedef struct {
  NoteDevice * (*construct) (int errorLevel);
  void (*destruct) (NoteDevice *device);

  int (*tone) (NoteDevice *device, unsigned int duration, NoteFrequency frequency);
  int (*note) (NoteDevice *device, unsigned int duration, unsigned char note);

  int (*flush) (NoteDevice *device);
} NoteMethods;

extern const NoteMethods beepNoteMethods;
extern const NoteMethods pcmNoteMethods;
extern const NoteMethods midiNoteMethods;
extern const NoteMethods fmNoteMethods;

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* BRLTTY_INCLUDED_NOTES */
