mpengine/src/mpequalizerframeworkwrapper.cpp
author hgs
Fri, 09 Jul 2010 16:27:03 -0500
changeset 43 0f32e550d9d8
parent 35 fdb31ab341af
permissions -rw-r--r--
201027
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
35
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
* 
hgs
parents:
diff changeset
    14
* Description: Wrapper for equalizer framework.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
// System includes
hgs
parents:
diff changeset
    19
#include <QStringList>
hgs
parents:
diff changeset
    20
#include <QDebug>
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
// User includes
hgs
parents:
diff changeset
    23
#include "mpequalizerframeworkwrapper.h"
hgs
parents:
diff changeset
    24
#include "mpequalizerframeworkwrapper_p.h"
hgs
parents:
diff changeset
    25
#include "mptrace.h"
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
/*!
hgs
parents:
diff changeset
    28
    \class MpEqualizerFrameworkWrapper
hgs
parents:
diff changeset
    29
    \ingroup musicplayer
hgs
parents:
diff changeset
    30
    \brief Wrapper for equalizer framework.
hgs
parents:
diff changeset
    31
    \since 10.1
hgs
parents:
diff changeset
    32
    
hgs
parents:
diff changeset
    33
    Equalizer wrapper provides Qt style interface to the audio equalizer
hgs
parents:
diff changeset
    34
    utilities. Its implementation is hidden using private class data pattern.
hgs
parents:
diff changeset
    35
    
hgs
parents:
diff changeset
    36
    This class defines several APIs that are needed from \a MpPlaybackView
hgs
parents:
diff changeset
    37
    and other components in \a mpplaybackviewplugin.
hgs
parents:
diff changeset
    38
hgs
parents:
diff changeset
    39
    \sa MpEqualizerFrameworkWrapperPrivate
hgs
parents:
diff changeset
    40
*/
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
/*!
hgs
parents:
diff changeset
    43
    \fn MpEqualizerFrameworkWrapper::equalizerReady()
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
    This signal will be emitted when Audio Eqalizer is initialized. This is
hgs
parents:
diff changeset
    46
    when all APIs, like \a applyPreset, are ready to be used.
hgs
parents:
diff changeset
    47
    
hgs
parents:
diff changeset
    48
    \sa MpEqualizerFrameworkWrapperPrivate::MapcInitComplete
hgs
parents:
diff changeset
    49
*/
hgs
parents:
diff changeset
    50
hgs
parents:
diff changeset
    51
/*!
hgs
parents:
diff changeset
    52
    Constructs a new MpEqualizerFrameworkWrapper with \a parent and initializes
hgs
parents:
diff changeset
    53
    private imaplementation.
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
*/
hgs
parents:
diff changeset
    56
MpEqualizerFrameworkWrapper::MpEqualizerFrameworkWrapper( QObject *parent )
hgs
parents:
diff changeset
    57
    : QObject(parent)
hgs
parents:
diff changeset
    58
{
hgs
parents:
diff changeset
    59
    TX_ENTRY
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
    d_ptr = new MpEqualizerFrameworkWrapperPrivate(this);
hgs
parents:
diff changeset
    62
    d_ptr->init();
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
    TX_EXIT
hgs
parents:
diff changeset
    65
}
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
/*!
hgs
parents:
diff changeset
    68
    Destructs the class and its private imaplementation.
hgs
parents:
diff changeset
    69
    
hgs
parents:
diff changeset
    70
 */
hgs
parents:
diff changeset
    71
MpEqualizerFrameworkWrapper::~MpEqualizerFrameworkWrapper()
hgs
parents:
diff changeset
    72
{
hgs
parents:
diff changeset
    73
    TX_LOG
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
    delete d_ptr;
hgs
parents:
diff changeset
    76
}
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
/*!
hgs
parents:
diff changeset
    79
    Get the preset name key by giving \a presetIndex. The command then 
hgs
parents:
diff changeset
    80
    relays to its private implementation.
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
 */
hgs
parents:
diff changeset
    83
int MpEqualizerFrameworkWrapper::getPresetNameKey( int presetIndex )
hgs
parents:
diff changeset
    84
{
hgs
parents:
diff changeset
    85
    TX_LOG_ARGS( "Preset index: " << presetIndex );
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
	return d_ptr->getPresetNameKey( presetIndex );
hgs
parents:
diff changeset
    88
}
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
/*!
hgs
parents:
diff changeset
    91
    Get the preset index by giving \a presetNameKey. The command then 
hgs
parents:
diff changeset
    92
    relays to its private implementation.
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
 */
hgs
parents:
diff changeset
    95
int MpEqualizerFrameworkWrapper::getPresetIndex( int presetNameKey )
hgs
parents:
diff changeset
    96
{
hgs
parents:
diff changeset
    97
    TX_LOG_ARGS( "Preset name key: " << presetNameKey );
hgs
parents:
diff changeset
    98
    
hgs
parents:
diff changeset
    99
    return d_ptr->getPresetIndex( presetNameKey );
hgs
parents:
diff changeset
   100
}
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
/*!
hgs
parents:
diff changeset
   103
    Returning the list of availale preset names. The command then relays to its 
hgs
parents:
diff changeset
   104
    private implementation. 
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
 */
hgs
parents:
diff changeset
   107
 QStringList MpEqualizerFrameworkWrapper::presetNames()
hgs
parents:
diff changeset
   108
{
hgs
parents:
diff changeset
   109
    return d_ptr->presetNames();
hgs
parents:
diff changeset
   110
}
hgs
parents:
diff changeset
   111
hgs
parents:
diff changeset
   112
 //End of File