plugin_scan_manager.h

// SPDX-FileCopyrightText: © 2024-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
/*
 * This file incorporates work covered by the following copyright and
 * permission notice:
 * ---
 *
 * This file is part of the JUCE framework.
 * Copyright (c) Raw Material Software Limited
 *
 * JUCE is an open source framework subject to commercial or open source
 * licensing.
 *
 * By downloading, installing, or using the JUCE framework, or combining the
 * JUCE framework with any other source code, object code, content or any other
 * copyrightable work, you agree to the terms of the JUCE End User Licence
 * Agreement, and all incorporated terms including the JUCE Privacy Policy and
 * the JUCE Website Terms of Service, as applicable, which will bind you. If you
 * do not agree to the terms of these agreements, we will not license the JUCE
 * framework to you, and you must discontinue the installation or download
 * process and cease use of the JUCE framework.
 *
 * JUCE End User Licence Agreement: https://juce.com/legal/juce-8-licence/
 * JUCE Privacy Policy: https://juce.com/juce-privacy-policy
 * JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/
 *
 * Or:
 *
 * You may also use this code under the terms of the AGPLv3:
 * https://www.gnu.org/licenses/agpl-3.0.en.html
 *
 * THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL
 * WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.
 * ---
 * SPDX-FileCopyrightText: (c) Raw Material Software Limited
 * SPDX-License-Identifier: AGPL-3.0-only
 */
 
#pragma once
 
#include "plugins/plugin_protocol.h"
#include "utils/file_path_list.h"
#include "utils/qt.h"
 
#include <QList>
#include <QMutex>
#include <QObject>
#include <QString>
#include <QThread>
#include <QtQmlIntegration/qqmlintegration.h>
 
#include "juce_wrapper.h"
 
namespace zrythm::plugins
{
 
//==============================================================================
 
using ProtocolPluginPathsProvider =
  std::function<std::unique_ptr<utils::FilePathList> (Protocol::ProtocolType)>;
 
class PluginScanManager;
 
// can't use QObject in nested classes so we put it in a namespace
namespace scanner_private
{
class Worker final : public QObject
{
  Q_OBJECT
 
public:
  Worker (PluginScanManager &scanner_);
 
public:
  Q_SLOT void process ();

  void requestStop ();

  Q_SIGNAL void finished ();
 
private:
  PluginScanManager &scanner_;
  std::atomic<bool>  should_stop_{ false };
};
} // namespace scanner_private
 
//==============================================================================

class PluginScanManager final : public QObject
{
  Q_OBJECT
  QML_ELEMENT
  Q_PROPERTY (
    QString currentlyScanningPlugin READ getCurrentlyScanningPlugin NOTIFY
      currentlyScanningPluginChanged FINAL)
  QML_UNCREATABLE ("")
 
  Q_DISABLE_COPY_MOVE (PluginScanManager)
 
public:
  explicit PluginScanManager (
    std::shared_ptr<juce::KnownPluginList>          known_plugins,
    std::shared_ptr<juce::AudioPluginFormatManager> format_manager,
    ProtocolPluginPathsProvider                     plugin_paths_provider,
    QObject *                                       parent = nullptr);
 
  ~PluginScanManager () override;

  Q_INVOKABLE void requestStop ();
 
  friend class scanner_private::Worker;

  Q_INVOKABLE void beginScan ();

  QString getCurrentlyScanningPlugin () const;

  Q_SIGNAL void scanningFinished ();

  // Q_SIGNAL void pluginsAdded ();

  Q_SIGNAL void currentlyScanningPluginChanged (const QString &plugin);

  // auto get_scanned_plugins () const { return known_plugin_list_; }
 
private:
  void scan_for_plugins ();
 
  void set_currently_scanning_plugin (const QString &plugin);

  Q_SLOT void scan_finished ();
 
private:
  std::shared_ptr<juce::KnownPluginList>          known_plugin_list_;
  ProtocolPluginPathsProvider                     plugin_paths_provider_;
  std::shared_ptr<juce::AudioPluginFormatManager> format_manager_;
 
  mutable QMutex currently_scanning_plugin_mutex_;
  QString        currently_scanning_plugin_;
 
  // Temporaries
  utils::QObjectUniquePtr<QThread>                 scan_thread_;
  utils::QObjectUniquePtr<scanner_private::Worker> worker_;
};
 
} // namespace zrythm::plugins