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              : 
      23              : #pragma once
      24              : 
      25              : #include "modularity/imoduleinterface.h"
      26              : 
      27              : #include "global/types/ret.h"
      28              : #include "global/io/path.h"
      29              : #include "global/progress.h"
      30              : #include "audiopluginstypes.h"
      31              : 
      32              : namespace muse::audioplugins {
      33              : struct PluginScanResult {
      34              :     io::paths_t newPluginPaths;      // not in cache, or back after Missing; validated via subprocess
      35              :     io::paths_t missingPluginPaths;  // in cache but not found by any scanner
      36              : };
      37              : 
      38              : class IRegisterAudioPluginsScenario : MODULE_CONTEXT_INTERFACE
      39              : {
      40            0 :     INTERFACE_ID(IRegisterAudioPluginsScenario)
      41              : 
      42              : public:
      43           18 :     virtual ~IRegisterAudioPluginsScenario() = default;
      44              : 
      45              :     virtual PluginScanResult scanPlugins(Progress* progress = nullptr) const = 0;
      46              : 
      47              :     virtual Ret updatePluginsRegistry() = 0;
      48              :     virtual Ret rescanAllPlugins() = 0;
      49              : 
      50              :     // validate=false only persists Discovered placeholders, to be validated on the next scan
      51              :     virtual Ret registerNewPlugins(const io::paths_t& pluginPaths, bool validate = true) = 0;
      52              :     virtual Ret unregisterRemovedPlugins(const PluginResourceIdList& pluginIds) = 0;
      53              : 
      54              :     virtual Ret registerPlugin(const io::path_t& pluginPath) = 0;
      55              :     virtual Ret validatePlugin(const io::path_t& pluginPath, const io::path_t& outputFile) = 0;
      56              : };
      57              : }