Kwave::CompressionWidget Class Reference

#include <CompressionWidget.h>

Inheritance diagram for Kwave::CompressionWidget:

Collaboration diagram for Kwave::CompressionWidget:

Public Types
enum	Mode { ABR_MODE = 0, VBR_MODE }

Public Member Functions
	CompressionWidget (QWidget *parent)
virtual	~CompressionWidget ()
virtual void	init (Kwave::FileInfo &info)
virtual void	enableABR (bool enable, bool lowest, bool highest)
virtual void	enableVBR (bool enable)
virtual void	setBitrates (int nominal, int lower, int upper)
virtual void	setQuality (int quality)
virtual Mode	mode ()
virtual void	setMode (Mode mode)
virtual bool	lowestEnabled ()
virtual bool	highestEnabled ()
virtual void	getABRrates (int &nominal, int &lowest, int &highest)
virtual int	baseQuality ()

Private Slots
virtual void	selectABR (bool checked)
virtual void	lowestToggled (bool on)
virtual void	abrChanged (int value)
virtual void	lowestChanged (int value)
virtual void	highestChanged (int value)
virtual void	highestToggled (bool on)

Private Member Functions
void	describeWidget (QWidget *widget, const QString &name, const QString &description)
void	initInfo (QLabel *label, QWidget *widget, Kwave::FileProperty property, Kwave::FileInfo &info)

Detailed Description

Definition at line 33 of file CompressionWidget.h.

Member Enumeration Documentation

Mode

enum Kwave::CompressionWidget::Mode

Compression Mode: ABR or VBR

Enumerator
ABR_MODE	average bitrate mode
VBR_MODE	variable bitrate mode

Definition at line 39 of file CompressionWidget.h.

                     {
            ABR_MODE = 0, 
            VBR_MODE      
        } Mode;

Constructor & Destructor Documentation

CompressionWidget()

Kwave::CompressionWidget::CompressionWidget ( QWidget *  parent )

explicit

Constructor

Definition at line 39 of file CompressionWidget.cpp.

References abrChanged(), Kwave::connect(), enableABR(), enableVBR(), highestChanged(), highestToggled(), Kwave::StandardBitrates::instance(), lowestChanged(), lowestToggled(), and selectABR().

    :QWidget(parent), Ui::CompressionWidgetBase()
{
    setupUi(this);

    // use well-known bitrates from MP3
    const Kwave::StandardBitrates &rates = Kwave::StandardBitrates::instance();
    abrBitrate->allowRates(rates);
    abrHighestBitrate->allowRates(rates);
    abrLowestBitrate->allowRates(rates);

    connect(rbABR, SIGNAL(toggled(bool)),
            this,  SLOT(selectABR(bool)));
    connect(chkLowestBitrate, SIGNAL(toggled(bool)),
            this,  SLOT(lowestToggled(bool)));
    connect(chkHighestBitrate, SIGNAL(toggled(bool)),
            this,  SLOT(highestToggled(bool)));
    connect(abrBitrate, SIGNAL(valueChanged(int)),
            this, SLOT(abrChanged(int)));
    connect(abrLowestBitrate, SIGNAL(valueChanged(int)),
            this, SLOT(lowestChanged(int)));
    connect(abrHighestBitrate, SIGNAL(valueChanged(int)),
            this, SLOT(highestChanged(int)));

    enableABR(false, false, false);
    enableVBR(false);
}

Here is the call graph for this function:

~CompressionWidget()

Kwave::CompressionWidget::~CompressionWidget ( )

virtual

Destructor

Definition at line 68 of file CompressionWidget.cpp.

{
}

Member Function Documentation

abrChanged

void Kwave::CompressionWidget::abrChanged ( int  value )

privatevirtualslot

called when the "average bitrate" slider has changed

Definition at line 175 of file CompressionWidget.cpp.

Referenced by CompressionWidget().

{
    if (value < abrLowestBitrate->value())
        abrLowestBitrate->setValue(value);
    if (value > abrHighestBitrate->value())
        abrHighestBitrate->setValue(value);
}

Here is the caller graph for this function:

baseQuality()

int Kwave::CompressionWidget::baseQuality ( )

virtual

Returns the base quality in VBR mode, as percentage from 1...100

Definition at line 272 of file CompressionWidget.cpp.

{
    return sbBaseQuality->value();
}

describeWidget()

void Kwave::CompressionWidget::describeWidget ( QWidget *  widget, const QString &  name, const QString &  description  )

private

Sets the tooltip and "what's this" of a widget.

Parameters

widget	any QWidget derived widget
name	of the setting, normally equal to it's label
description	verbose descriptive text that says what can be set

Definition at line 88 of file CompressionWidget.cpp.

References _.

Referenced by initInfo().

{
    if (!widget) return;
    widget->setToolTip(description);
    widget->setWhatsThis(_("<b>") + name + _("</b><br>") + description);
}

Here is the caller graph for this function:

enableABR()

void Kwave::CompressionWidget::enableABR ( bool  enable, bool  lowest, bool  highest  )

virtual

Enable or disable ABR mode controls

Parameters

enable	controls the global ABR mode setting enable/disable
lowest	checks/unchecks the lowest bitrate setting checkbox
highest	checks/unchecks the highest bitrate setting checkbox

Definition at line 109 of file CompressionWidget.cpp.

Referenced by CompressionWidget().

{
    rbABR->setEnabled(enable);
    if (!enable) rbABR->setChecked(false);

    const bool on = (rbABR->isChecked() && enable);
    lblCompressionNominalBitrate->setEnabled(on);
    abrBitrate->setEnabled(on);
    abrHighestBitrate->setEnabled(on);
    abrLowestBitrate->setEnabled(on);
    chkHighestBitrate->setEnabled(on);
    chkLowestBitrate->setEnabled(on);

    chkLowestBitrate->setChecked(lowest);
    chkHighestBitrate->setChecked(highest);
}

Here is the caller graph for this function:

enableVBR()

void Kwave::CompressionWidget::enableVBR ( bool  enable )

virtual

Enable or disable VBR mode

Definition at line 127 of file CompressionWidget.cpp.

Referenced by CompressionWidget().

{
    rbVBR->setEnabled(enable);
    if (!enable) rbVBR->setChecked(false);

    const bool on = (rbVBR->isChecked() && enable);
    lblCompressionBaseQuality->setEnabled(on);
    sbBaseQuality->setEnabled(on);
    slBaseQuality->setEnabled(on);

}

Here is the caller graph for this function:

getABRrates()

void Kwave::CompressionWidget::getABRrates ( int &  nominal, int &  lowest, int &  highest  )

virtual

Returns the bitrate settings of ABR mode

Parameters

nominal	receives the nominal bitrate
lowest	receives the lowest bitrate or null if unused
highest	receives the highest bitrate or null if unused

Definition at line 263 of file CompressionWidget.cpp.

{
    nominal = abrBitrate->value();
    lowest  = abrLowestBitrate->value();
    highest = abrHighestBitrate->value();
}

highestChanged

void Kwave::CompressionWidget::highestChanged ( int  value )

privatevirtualslot

called when the "highest bitrate" slider has changed

Definition at line 193 of file CompressionWidget.cpp.

Referenced by CompressionWidget().

{
    if (value < abrLowestBitrate->value())
        abrLowestBitrate->setValue(value);
    if (value < abrBitrate->value())
        abrBitrate->setValue(value);
}

Here is the caller graph for this function:

highestEnabled()

bool Kwave::CompressionWidget::highestEnabled ( )

virtual

Returns the state of the "use highest" checkbox

Definition at line 257 of file CompressionWidget.cpp.

{
    return chkHighestBitrate->isChecked();
}

highestToggled

void Kwave::CompressionWidget::highestToggled ( bool  on )

privatevirtualslot

called when the "highest bitrate" checkbox has been toggled

Definition at line 161 of file CompressionWidget.cpp.

Referenced by CompressionWidget().

{
    if (on) {
        // if previous state was off: transition off->on
        // make sure that the highest ABR is above the current ABR
        int abr = abrBitrate->value();
        if (abrHighestBitrate->value() < abr)
            abrHighestBitrate->setValue(abr);
    }
    abrHighestBitrate->setEnabled(chkHighestBitrate->isEnabled() && on);
}

Here is the caller graph for this function:

init()

void Kwave::CompressionWidget::init ( Kwave::FileInfo &  info )

virtual

Parameters

info	the FileInfo used for getting the property descriptions

Definition at line 73 of file CompressionWidget.cpp.

References Kwave::INF_BITRATE_LOWER, Kwave::INF_BITRATE_NOMINAL, Kwave::INF_BITRATE_UPPER, Kwave::INF_VBR_QUALITY, and initInfo().

{
    initInfo(lblCompressionNominalBitrate, abrBitrate,
             Kwave::INF_BITRATE_NOMINAL, info);
    initInfo(Q_NULLPTR, abrHighestBitrate,
             Kwave::INF_BITRATE_UPPER, info);
    initInfo(Q_NULLPTR, abrLowestBitrate,
             Kwave::INF_BITRATE_LOWER, info);
    initInfo(lblCompressionBaseQuality, sbBaseQuality,
             Kwave::INF_VBR_QUALITY, info);
    initInfo(Q_NULLPTR, slBaseQuality,
             Kwave::INF_VBR_QUALITY, info);
}

Here is the call graph for this function:

initInfo()

void Kwave::CompressionWidget::initInfo ( QLabel *  label, QWidget *  widget, Kwave::FileProperty  property, Kwave::FileInfo &  info  )

private

Sets the text of the label to the name of a file property and initializes the tool tip of the corresponding edit/display control.

Parameters

label	the label to be set
widget	the control to get the tool tip
property	the file property which it belongs to
info	the FileInfo used for getting the property descriptions

Definition at line 98 of file CompressionWidget.cpp.

References _, describeWidget(), Kwave::FileInfo::description(), and Kwave::FileInfo::name().

Referenced by init().

{
    Q_ASSERT(widget);
    if (label) label->setText(i18n(info.name(property).toLatin1()) + _(":"));
    describeWidget(widget, i18n(info.name(property).toLatin1()),
                   i18n(info.description(property).toLatin1()));
}

Here is the call graph for this function:

Here is the caller graph for this function:

lowestChanged

void Kwave::CompressionWidget::lowestChanged ( int  value )

privatevirtualslot

called when the "lowest bitrate" slider has changed

Definition at line 184 of file CompressionWidget.cpp.

Referenced by CompressionWidget().

{
    if (value > abrBitrate->value())
        abrBitrate->setValue(value);
    if (value > abrHighestBitrate->value())
        abrHighestBitrate->setValue(value);
}

Here is the caller graph for this function:

lowestEnabled()

bool Kwave::CompressionWidget::lowestEnabled ( )

virtual

Returns the state of the "use lowest" checkbox

Definition at line 251 of file CompressionWidget.cpp.

{
    return chkLowestBitrate->isChecked();
}

lowestToggled

void Kwave::CompressionWidget::lowestToggled ( bool  on )

privatevirtualslot

called when the "lowest bitrate" checkbox has been toggled

Definition at line 147 of file CompressionWidget.cpp.

Referenced by CompressionWidget().

{
    if (on) {
        // if previous state was off: transition off->on
        // make sure that the lowest ABR is below the current ABR
        int abr = abrBitrate->value();
        if (abrLowestBitrate->value() > abr)
            abrLowestBitrate->setValue(abr);
    }
    abrLowestBitrate->setEnabled(chkLowestBitrate->isEnabled() && on);
}

Here is the caller graph for this function:

mode()

Kwave::CompressionWidget::Mode Kwave::CompressionWidget::mode ( )

virtual

Returns the current bitrate mode: ABR or VBR

Definition at line 216 of file CompressionWidget.cpp.

References ABR_MODE, and VBR_MODE.

{
    return (rbABR->isChecked()) ? ABR_MODE : VBR_MODE;
}

selectABR

void Kwave::CompressionWidget::selectABR ( bool  checked )

privatevirtualslot

called when the selection state of the ABR radio button changed

Definition at line 140 of file CompressionWidget.cpp.

Referenced by CompressionWidget().

{
    abrHighestBitrate->setEnabled(checked && chkHighestBitrate->isChecked());
    abrLowestBitrate->setEnabled( checked && chkLowestBitrate->isChecked());
}

Here is the caller graph for this function:

setBitrates()

void Kwave::CompressionWidget::setBitrates ( int  nominal, int  lower, int  upper  )

virtual

Sets the bitrates in ABR mode

Parameters

nominal	the nominal bitrate or zero if not used
lower	the lowest bitrate or zero if not used
upper	the highest bitrate or zero if not used

Definition at line 202 of file CompressionWidget.cpp.

{
    abrLowestBitrate->setValue(lower);
    abrHighestBitrate->setValue(upper);
    abrBitrate->setValue(nominal);
}

setMode()

void Kwave::CompressionWidget::setMode ( Mode  mode )

virtual

Selects ABR or VBR mode

Definition at line 222 of file CompressionWidget.cpp.

References ABR_MODE, and VBR_MODE.

{
    bool abr = rbABR->isEnabled();
    bool vbr = rbVBR->isEnabled();
    switch (mode) {
        case ABR_MODE:
            rbVBR->setChecked(false);
            rbVBR->setChecked(true);
            rbVBR->setChecked(false);

            rbABR->setChecked(true);
            rbABR->setChecked(false);
            rbABR->setChecked(true);
            rbABR->setChecked(abr);
            break;
        case VBR_MODE:
            rbABR->setChecked(false);
            rbABR->setChecked(true);
            rbABR->setChecked(false);

            rbVBR->setChecked(true);
            rbVBR->setChecked(false);
            rbVBR->setChecked(true);
            rbVBR->setChecked(vbr);
            break;
    }
}

setQuality()

void Kwave::CompressionWidget::setQuality ( int  quality )

virtual

Sets the VBR base quality or zero if unused.

Definition at line 210 of file CompressionWidget.cpp.

{
    sbBaseQuality->setValue(quality);
}

---

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

• plugins/fileinfo/CompressionWidget.h
• plugins/fileinfo/CompressionWidget.cpp