Kwave::MP3CodecPlugin Class Reference

#include <MP3CodecPlugin.h>

Inheritance diagram for Kwave::MP3CodecPlugin:

Collaboration diagram for Kwave::MP3CodecPlugin:

Public Member Functions
	MP3CodecPlugin (QObject *parent, const QVariantList &args)
virtual	~MP3CodecPlugin ()
virtual void	load (QStringList &params)
virtual QStringList *	setup (QStringList &previous_params)
virtual QList< Kwave::Decoder * >	createDecoder ()
virtual QList< Kwave::Encoder * >	createEncoder ()
Public Member Functions inherited from Kwave::CodecPlugin
	CodecPlugin (QObject *parent, const QVariantList &args, Codec &codec)
virtual	~CodecPlugin () Q_DECL_OVERRIDE
virtual void	unload () Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::Plugin
	Plugin (QObject *parent, const QVariantList &args)
virtual	~Plugin () Q_DECL_OVERRIDE
virtual QString	name () const
virtual QString	description () const
virtual QString	progressText ()
virtual bool	canClose () const
bool	isRunning () const
bool	shouldStop () const
virtual int	start (QStringList &params)
virtual int	stop ()
virtual void	run (QStringList params)
Kwave::PluginManager &	manager () const
Kwave::SignalManager &	signalManager ()
QWidget *	parentWidget () const
QString	signalName ()
virtual sample_index_t	signalLength ()
virtual double	signalRate ()
virtual const QList< unsigned int >	selectedTracks ()
virtual sample_index_t	selection (QList< unsigned int > *tracks=Q_NULLPTR, sample_index_t *left=Q_NULLPTR, sample_index_t *right=Q_NULLPTR, bool expand_if_empty=false)
virtual void	selectRange (sample_index_t offset, sample_index_t length)
virtual void	migrateToActiveContext ()
Public Member Functions inherited from Kwave::Runnable
virtual	~Runnable ()

Static Private Attributes
static CodecPlugin::Codec	m_codec = EMPTY_CODEC

Additional Inherited Members
Public Slots inherited from Kwave::Plugin
virtual void	setProgressDialogEnabled (bool enable)
virtual void	updateProgress (qreal progress)
virtual void	cancel ()
virtual void	close ()
void	release ()
Signals inherited from Kwave::Plugin
void	sigRunning (Kwave::Plugin *plugin)
void	sigDone (Kwave::Plugin *plugin)
void	sigClosed (Kwave::Plugin *p)
void	sigCommand (const QString &command)
void	setProgressText (const QString &text)
Protected Member Functions inherited from Kwave::CodecPlugin
template<class T >
QList< Kwave::Decoder * >	singleDecoder ()
template<class T >
QList< Kwave::Encoder * >	singleEncoder ()
Protected Member Functions inherited from Kwave::Plugin
int	execute (QStringList &params)
void	emitCommand (const QString &command)
void	use ()
void	setPluginManager (Kwave::PluginManager *new_plugin_manager)
virtual void	run_wrapper (const QVariant &params) Q_DECL_OVERRIDE

Detailed Description

Definition at line 29 of file MP3CodecPlugin.h.

Constructor & Destructor Documentation

MP3CodecPlugin()

Kwave::MP3CodecPlugin::MP3CodecPlugin	(	QObject *	parent,
		const QVariantList &	args
	)

Constructor

Parameters

parent	reference to our plugin manager
args	argument list [unused]

Definition at line 33 of file MP3CodecPlugin.cpp.

    :Kwave::CodecPlugin(parent, args, m_codec)
{
}

~MP3CodecPlugin()

Kwave::MP3CodecPlugin::~MP3CodecPlugin ( )

virtual

Destructor

Definition at line 40 of file MP3CodecPlugin.cpp.

{
}

Member Function Documentation

createDecoder()

QList< Kwave::Decoder * > Kwave::MP3CodecPlugin::createDecoder ( )

virtual

Creates a new decoder

Implements Kwave::CodecPlugin.

Definition at line 81 of file MP3CodecPlugin.cpp.

{
    return singleDecoder<Kwave::MP3Decoder>();
}

createEncoder()

QList< Kwave::Encoder * > Kwave::MP3CodecPlugin::createEncoder ( )

virtual

Creates a new encoder

Implements Kwave::CodecPlugin.

Definition at line 87 of file MP3CodecPlugin.cpp.

{
    return singleEncoder<Kwave::MP3Encoder>();
}

load()

void Kwave::MP3CodecPlugin::load ( QStringList &  params )

virtual

See also

Kwave::Plugin::load()

Reimplemented from Kwave::CodecPlugin.

Definition at line 45 of file MP3CodecPlugin.cpp.

References _, Kwave::Plugin::emitCommand(), and Kwave::CodecPlugin::load().

{
    emitCommand(_("menu (plugin:setup(codec_mp3), Settings/%1)").arg(
        _(I18N_NOOP2("menu: /Settings/MP3 Encoder Setup",
                                     "MP3 Encoder Setup"))));
    Kwave::CodecPlugin::load(params);
}

Here is the call graph for this function:

setup()

QStringList * Kwave::MP3CodecPlugin::setup ( QStringList &  previous_params )

virtual

Shows a dialog to set up the plugin, configure all paths, presets and other parameters...

Parameters

previous_params

the parameters of a previous call

Returns

a string list with all parameters or null if the setup (dialog) has been canceled

Reimplemented from Kwave::Plugin.

Definition at line 54 of file MP3CodecPlugin.cpp.

References Kwave::Plugin::parentWidget(), and Kwave::MP3EncoderDialog::save().

{
    Q_UNUSED(previous_params);

    // create the setup dialog
    MP3EncoderDialog *dialog =
        new(std::nothrow) MP3EncoderDialog(parentWidget());
    Q_ASSERT(dialog);
    if (!dialog) return Q_NULLPTR;

    QStringList *list = new(std::nothrow) QStringList();
    Q_ASSERT(list);
    if (list && dialog->exec()) {
        // user has pressed "OK"
        dialog->save();
    } else {
        // user pressed "Cancel"
        if (list) delete list;
        list = Q_NULLPTR;
    }

    if (dialog) delete dialog;
    return list;

}

Here is the call graph for this function:

Member Data Documentation

m_codec

Kwave::CodecPlugin::Codec Kwave::MP3CodecPlugin::m_codec = EMPTY_CODEC

staticprivate

static codec container

Definition at line 64 of file MP3CodecPlugin.h.

---

The documentation for this class was generated from the following files:

• plugins/codec_mp3/MP3CodecPlugin.h
• plugins/codec_mp3/MP3CodecPlugin.cpp