Lv2ControlBase.h

Go to the documentation of this file.

/*
 * Lv2ControlBase.h - Lv2 control base class
 *
 * Copyright (c) 2018-2023 Johannes Lorenz <jlsf2013$users.sourceforge.net, $=@>
 *
 * 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_LV2_CONTROL_BASE_H
#define LMMS_LV2_CONTROL_BASE_H
 
#include "lmmsconfig.h"
 
#ifdef LMMS_HAVE_LV2
 
#include <lilv/lilv.h>
#include <memory>
 
#include "LinkedModelGroups.h"
#include "lmms_export.h"
#include "Plugin.h"
 
namespace lmms
{
 
 
class Lv2Proc;
class PluginIssue;
class SampleFrame;

class LMMS_EXPORT Lv2ControlBase : public LinkedModelGroups
{
public:
    static Plugin::Type check(const LilvPlugin* m_plugin,
        std::vector<PluginIssue> &issues);
 
    void shutdown();
    void init(Model* meAsModel);
 
    const LilvPlugin* getPlugin() const { return m_plugin; }
 
    Lv2Proc *control(std::size_t idx) { return m_procs[idx].get(); }
    const Lv2Proc *control(std::size_t idx) const { return m_procs[idx].get(); }
 
    bool hasGui() const { return m_hasGUI; }
    void setHasGui(bool val) { m_hasGUI = val; }
 
protected:
    /*
        ctor/dtor
     */
    Lv2ControlBase(class Model *that, const QString& uri);
    Lv2ControlBase(const Lv2ControlBase&) = delete;
    ~Lv2ControlBase() override;
    void reload();
 
    Lv2ControlBase& operator=(const Lv2ControlBase&) = delete;
 
    /*
        overrides
    */
    LinkedModelGroup* getGroup(std::size_t idx) override;
    const LinkedModelGroup* getGroup(std::size_t idx) const override;
 
    /*
        utils for the run thread
    */
    void copyModelsFromLmms();
    void copyModelsToLmms() const;

    void copyBuffersFromLmms(const SampleFrame* buf, f_cnt_t frames);
    void copyBuffersToLmms(SampleFrame* buf, f_cnt_t frames) const;
    void run(f_cnt_t frames);
 
    /*
        load/save, must be called from virtuals
    */
    void saveSettings(QDomDocument &doc, QDomElement &that);
    void loadSettings(const QDomElement &that);
    void loadFile(const QString &file);
 
    /*
        more functions that must be called from virtuals
    */
    std::size_t controlCount() const;
    QString nodeName() const { return "lv2controls"; }
    bool hasNoteInput() const;
    void handleMidiInputEvent(const class MidiEvent &event,
        const class TimePos &time, f_cnt_t offset);
 
private:
    std::vector<std::unique_ptr<Lv2Proc>> m_procs;
 
    bool m_hasGUI = false;
    unsigned m_channelsPerProc;
 
    const LilvPlugin* m_plugin;
};
 
 
} // namespace lmms
 
#endif // LMMS_HAVE_LV2
 
#endif // LMMS_LV2_CONTROL_BASE_H