Line data    Source code

       1              : /*
       2              :  * SPDX-License-Identifier: GPL-3.0-only
       3              :  * MuseScore-CLA-applies
       4              :  *
       5              :  * MuseScore Studio
       6              :  * Music Composition & Notation
       7              :  *
       8              :  * Copyright (C) 2021 MuseScore Limited and others
       9              :  *
      10              :  * This program is free software: you can redistribute it and/or modify
      11              :  * it under the terms of the GNU General Public License version 3 as
      12              :  * published by the Free Software Foundation.
      13              :  *
      14              :  * This program is distributed in the hope that it will be useful,
      15              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      16              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      17              :  * GNU General Public License for more details.
      18              :  *
      19              :  * You should have received a copy of the GNU General Public License
      20              :  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
      21              :  */
      22              : #pragma once
      23              : 
      24              : #include "modularity/imoduleinterface.h"
      25              : 
      26              : #include "global/async/notification.h"
      27              : #include "global/types/ret.h"
      28              : #include "global/types/retval.h"
      29              : #include "global/io/path.h"
      30              : 
      31              : #include "audiopluginstypes.h"
      32              : 
      33              : namespace muse::audioplugins {
      34              : class IKnownAudioPluginsRegister : MODULE_GLOBAL_INTERFACE
      35              : {
      36            0 :     INTERFACE_ID(IKnownAudioPluginsRegister)
      37              : 
      38              : public:
      39           26 :     virtual ~IKnownAudioPluginsRegister() = default;
      40              : 
      41              :     virtual Ret load() = 0;
      42              :     virtual Ret clear() = 0;
      43              : 
      44              :     using PluginInfoAccepted = std::function<bool (const AudioPluginInfo& info)>;
      45              : 
      46              :     virtual AudioPluginInfoList pluginInfoList(PluginInfoAccepted accepted = PluginInfoAccepted()) const = 0;
      47              :     virtual muse::async::Notification pluginInfoListChanged() const = 0;
      48              : 
      49              :     virtual const io::path_t& pluginPath(const PluginResourceId& resourceId) const = 0;
      50              : 
      51              :     virtual bool exists(const io::path_t& pluginPath) const = 0;
      52              :     virtual bool exists(const PluginResourceId& resourceId) const = 0;
      53              : 
      54              :     virtual Ret registerPlugins(const AudioPluginInfoList& list) = 0;
      55              :     virtual Ret unregisterPlugins(const PluginResourceIdList& resourceIds) = 0;
      56              : 
      57              :     virtual Ret setPluginsState(const io::paths_t& paths, AudioPluginState state) = 0;
      58              : 
      59              :     virtual Ret removePluginsAtPath(const io::path_t& path) = 0;
      60              : 
      61              :     virtual Ret writePluginsTo(const io::path_t& file, const AudioPluginInfoList& list) const = 0;
      62              :     virtual RetVal<AudioPluginInfoList> readPluginsFrom(const io::path_t& file) const = 0;
      63              : };
      64              : }