DummyEffect.h

Go to the documentation of this file.

/*
 * DummyEffect.h - effect used as fallback if an effect couldn't be loaded
 *
 * Copyright (c) 2006-2014 Tobias Doerffel <tobydox/at/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_DUMMY_EFFECT_H
#define LMMS_DUMMY_EFFECT_H
 
#include <QDomElement>
 
#include "Effect.h"
#include "EffectControls.h"
#include "EffectControlDialog.h"
 
namespace lmms
{
 
namespace gui
{
 
class Knob;
 
 
class DummyEffectControlDialog : public EffectControlDialog
{
public:
        DummyEffectControlDialog( EffectControls * _controls ) :
                EffectControlDialog( _controls )
        {
        }
 
} ;
 
} // namespace gui
 
class DummyEffectControls : public EffectControls
{
public:
        DummyEffectControls( Effect * _eff ) :
                EffectControls( _eff )
        {
        }
 
        ~DummyEffectControls() override = default;
 
        int controlCount() override
        {
                return 0;
        }
 
        void saveSettings( QDomDocument &, QDomElement & ) override
        {
        }
 
        void loadSettings( const QDomElement & ) override
        {
        }
 
        QString nodeName() const override
        {
                return "DummyControls";
        }
 
        gui::EffectControlDialog * createView() override
        {
                return new gui::DummyEffectControlDialog( this );
        }
} ;
 
 
 
class DummyEffect : public Effect
{
        Q_OBJECT
public:
        DummyEffect( Model * _parent, const QDomElement& originalPluginData ) :
                Effect( nullptr, _parent, nullptr ),
                m_controls( this ),
                m_originalPluginData( originalPluginData )
        {
                setName();
                setDontRun(true);
        }
 
        ~DummyEffect() override = default;
 
        EffectControls * controls() override
        {
                return &m_controls;
        }
 
        ProcessStatus processImpl(SampleFrame*, const f_cnt_t) override
        {
                return ProcessStatus::Sleep;
        }
 
        const QDomElement& originalPluginData() const
        {
                return m_originalPluginData;
        }
 
 
 
private:
        DummyEffectControls m_controls;
        const QDomElement m_originalPluginData;
        
        // Parse the display name from the dom
        virtual void setName()
        {
                QDomNodeList keys = originalPluginData().elementsByTagName( "key" );
                for( int i = 0; !keys.item( i ).isNull(); ++i )
                {
                        QDomNodeList attributes = keys.item( i ).toElement().elementsByTagName( "attribute" );
                        for( int j = 0; !attributes.item( j ).isNull(); ++j )
                        {
                                QDomElement attribute = attributes.item( j ).toElement();
                                if( attribute.hasAttribute( "value" ) )
                                {
                                        QString name = tr("NOT FOUND") + " (" + attribute.attribute( "value" ) + ")";
                                        setDisplayName(name);
                                        return;
                                }
 
                        }
 
                }
        }
} ;
 
 
} // namespace lmms
 
#endif // LMMS_DUMMY_EFFECT_H