Fawn
76ffa57efe
- Updates Doxyfile for Doxygen 1.18.0 and minifies Doxyfile - Use PROJECT_LOGO & PROJECT_ICON in Doxyfile - Add custom Doxygen CSS - Move documentation comments in first-party code from source files to their corresponding headers, where applicable - Resolves nearly all Doxygen warnings in first-party code - Remove unused INPUTDIRS from doc/CMakeLists.txt - Use CMake's DOXYGEN_ADD_DOCS() instead of a custom doc target - Bump portsmf submodule to get upstream Doxygen fixes - Only autorun Doxygen CI for master branch - Skip Doxygen CI if Github Pages aren't enabled
88 lines
3.0 KiB
C++
88 lines
3.0 KiB
C++
/*
|
|
* Microtuner.h - manage tuning and scale information of an instrument
|
|
*
|
|
* Copyright (c) 2020 Martin Pavelek <he29.HS/at/gmail.com>
|
|
*
|
|
* This file is part of LMMS - https://lmms.io
|
|
*
|
|
* This program 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 of the License, or (at your option) any later version.
|
|
*
|
|
* This program 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 this program (see COPYING); if not, write to the
|
|
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301 USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef LMMS_MICROTUNER_H
|
|
#define LMMS_MICROTUNER_H
|
|
|
|
#include "AutomatableModel.h"
|
|
#include "ComboBoxModel.h"
|
|
#include "JournallingObject.h"
|
|
|
|
namespace lmms
|
|
{
|
|
|
|
class LMMS_EXPORT Microtuner : public Model, public JournallingObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
explicit Microtuner();
|
|
|
|
bool enabled() const {return m_enabledModel.value();}
|
|
bool keyRangeImport() const {return enabled() && m_keyRangeImportModel.value();}
|
|
int currentScale() const {return m_scaleModel.value();}
|
|
int currentKeymap() const {return m_keymapModel.value();}
|
|
|
|
BoolModel *enabledModel() {return &m_enabledModel;}
|
|
ComboBoxModel *scaleModel() {return &m_scaleModel;}
|
|
ComboBoxModel *keymapModel() {return &m_keymapModel;}
|
|
BoolModel *keyRangeImportModel() {return &m_keyRangeImportModel;}
|
|
|
|
int firstKey() const;
|
|
int lastKey() const;
|
|
int baseKey() const;
|
|
float baseFreq() const;
|
|
|
|
//! @brief Return frequency for a given MIDI key, using the active mapping and scale.
|
|
//! @param key A MIDI key number ranging from 0 to 127.
|
|
//! @param userBaseNote The "A4" or "440 Hz" equivalent "base note". @see InstrumentTrack::baseNoteModel
|
|
//! @return Frequency in Hz; 0 if key is out of range or not mapped.
|
|
float keyToFreq(int key, int userBaseNote) const;
|
|
|
|
int octaveSize() const;
|
|
|
|
QString nodeName() const override {return "microtuner";}
|
|
void saveSettings(QDomDocument & document, QDomElement &element) override;
|
|
void loadSettings(const QDomElement &element) override;
|
|
|
|
protected slots:
|
|
//! @brief Update scale name displayed in the microtuner scale list.
|
|
//! @param index Index of the scale to update; update all scales if -1 or out of range.
|
|
void updateScaleList(int index);
|
|
|
|
//! @brief Update keymap name displayed in the microtuner scale list.
|
|
//! @param index Index of the keymap to update; update all keymaps if -1 or out of range.
|
|
void updateKeymapList(int index);
|
|
|
|
private:
|
|
BoolModel m_enabledModel; //!< Enable microtuner (otherwise using 12-TET @440 Hz)
|
|
ComboBoxModel m_scaleModel;
|
|
ComboBoxModel m_keymapModel;
|
|
BoolModel m_keyRangeImportModel;
|
|
|
|
};
|
|
|
|
} // namespace lmms
|
|
|
|
#endif // LMMS_MICROTUNER_H
|