mpengine/src/mpsongscanner.cpp
author hgs
Fri, 09 Jul 2010 16:27:03 -0500
changeset 43 0f32e550d9d8
parent 37 eb79a7c355bf
child 55 f3930dda3342
permissions -rw-r--r--
201027
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
37
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: Music Player song scanner.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#include "mpsongscanner.h"
hgs
parents:
diff changeset
    19
#include "mpmpxharvesterframeworkwrapper.h"
hgs
parents:
diff changeset
    20
#include "mptrace.h"
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
/*!
hgs
parents:
diff changeset
    23
    \class MpSongScanner
hgs
parents:
diff changeset
    24
    \brief Music Player song scanner.
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
    Song scanner interfaces with MPX Harvesting Framework to harvest
hgs
parents:
diff changeset
    27
    music files in the device.
hgs
parents:
diff changeset
    28
*/
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
/*!
hgs
parents:
diff changeset
    31
 \fn void scanStarted()
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
 This signal is emitted when scanning has started.
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
 */
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
/*!
hgs
parents:
diff changeset
    38
 \fn void scanCountChanged( int count )
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
 This signal is emitted to notify that scan count has changed.
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
 */
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
/*!
hgs
parents:
diff changeset
    45
 \fn void scanFinished( int error, int itemsAdded )
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
 Emitted when scanning has finished.
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
 */
hgs
parents:
diff changeset
    50
hgs
parents:
diff changeset
    51
/*!
hgs
parents:
diff changeset
    52
 Constructs the song scanner.
hgs
parents:
diff changeset
    53
 */
hgs
parents:
diff changeset
    54
MpSongScanner::MpSongScanner( MpMpxHarvesterFrameworkWrapper *wrapper, QObject *parent )
hgs
parents:
diff changeset
    55
    : QObject( parent ),
hgs
parents:
diff changeset
    56
      mMpxHarvesterWrapper(wrapper),
hgs
parents:
diff changeset
    57
      mScanning( false ),
hgs
parents:
diff changeset
    58
      mAutomaticScan( true )
hgs
parents:
diff changeset
    59
{
hgs
parents:
diff changeset
    60
    TX_ENTRY
hgs
parents:
diff changeset
    61
    connect( mMpxHarvesterWrapper, SIGNAL( scanStarted() ),
hgs
parents:
diff changeset
    62
            this, SIGNAL( scanStarted() ), Qt::QueuedConnection );
hgs
parents:
diff changeset
    63
    connect( mMpxHarvesterWrapper, SIGNAL( scanEnded( int, int ) ),
hgs
parents:
diff changeset
    64
            this, SLOT( handleScanEnded( int, int ) ), Qt::QueuedConnection );
hgs
parents:
diff changeset
    65
    connect( mMpxHarvesterWrapper, SIGNAL( scanCountChanged( int ) ), 
hgs
parents:
diff changeset
    66
            this, SIGNAL( scanCountChanged( int ) ), Qt::QueuedConnection );
43
hgs
parents: 37
diff changeset
    67
    // Disk events should be handled asap in order to stop the scan on time
37
hgs
parents:
diff changeset
    68
    connect( mMpxHarvesterWrapper, SIGNAL( diskEvent( MpxDiskEvents ) ),
43
hgs
parents: 37
diff changeset
    69
            this, SLOT( handleDiskEvent(MpxDiskEvents) ) );
37
hgs
parents:
diff changeset
    70
    TX_EXIT
hgs
parents:
diff changeset
    71
}
hgs
parents:
diff changeset
    72
hgs
parents:
diff changeset
    73
/*!
hgs
parents:
diff changeset
    74
 Destructs the song scanner.
hgs
parents:
diff changeset
    75
 */
hgs
parents:
diff changeset
    76
MpSongScanner::~MpSongScanner()
hgs
parents:
diff changeset
    77
{
hgs
parents:
diff changeset
    78
    TX_LOG
hgs
parents:
diff changeset
    79
}
hgs
parents:
diff changeset
    80
hgs
parents:
diff changeset
    81
/*!
hgs
parents:
diff changeset
    82
 Initiates song scanning.
hgs
parents:
diff changeset
    83
 */
hgs
parents:
diff changeset
    84
void MpSongScanner::scan( bool automaticScan )
hgs
parents:
diff changeset
    85
{
hgs
parents:
diff changeset
    86
    TX_ENTRY
hgs
parents:
diff changeset
    87
    if ( !mScanning ) {
hgs
parents:
diff changeset
    88
        mScanning = true;
hgs
parents:
diff changeset
    89
        mAutomaticScan = automaticScan;
hgs
parents:
diff changeset
    90
        mMpxHarvesterWrapper->scan();
hgs
parents:
diff changeset
    91
    }
hgs
parents:
diff changeset
    92
    TX_EXIT
hgs
parents:
diff changeset
    93
}
hgs
parents:
diff changeset
    94
hgs
parents:
diff changeset
    95
/*!
hgs
parents:
diff changeset
    96
 Returns mAutomaticScan value.
hgs
parents:
diff changeset
    97
 */
hgs
parents:
diff changeset
    98
bool MpSongScanner::isAutomaticScan()
hgs
parents:
diff changeset
    99
{
hgs
parents:
diff changeset
   100
    return mAutomaticScan;
hgs
parents:
diff changeset
   101
}
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
/*!
hgs
parents:
diff changeset
   104
 Cancels ongoing song scanning, if any.
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
 \sa scan()
hgs
parents:
diff changeset
   107
 */
hgs
parents:
diff changeset
   108
void MpSongScanner::cancelScan()
hgs
parents:
diff changeset
   109
{
hgs
parents:
diff changeset
   110
    TX_ENTRY
hgs
parents:
diff changeset
   111
    if ( mScanning ) {
hgs
parents:
diff changeset
   112
        mScanning = false;
hgs
parents:
diff changeset
   113
        mMpxHarvesterWrapper->cancelScan();
hgs
parents:
diff changeset
   114
    }
hgs
parents:
diff changeset
   115
    TX_EXIT
hgs
parents:
diff changeset
   116
}
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
/*!
hgs
parents:
diff changeset
   119
 Slot called upon notification from MPX Harvesting FW indicating end of
hgs
parents:
diff changeset
   120
 scanning process.
hgs
parents:
diff changeset
   121
 */
hgs
parents:
diff changeset
   122
void MpSongScanner::handleScanEnded( int numItemsAdded, int error )
hgs
parents:
diff changeset
   123
{
hgs
parents:
diff changeset
   124
    TX_ENTRY
hgs
parents:
diff changeset
   125
    if (error == KErrDiskFull) {
hgs
parents:
diff changeset
   126
        emit scanFinished( ScanErrorDiskFull, 0 );
hgs
parents:
diff changeset
   127
        mScanning = false;
hgs
parents:
diff changeset
   128
    }
hgs
parents:
diff changeset
   129
    else{
hgs
parents:
diff changeset
   130
        if( error < 0) {
hgs
parents:
diff changeset
   131
            emit scanFinished( ScanGeneralError, numItemsAdded );
hgs
parents:
diff changeset
   132
        }
hgs
parents:
diff changeset
   133
        else if ( mScanning ) {
hgs
parents:
diff changeset
   134
            emit scanFinished( ScanErrorNone, numItemsAdded );
hgs
parents:
diff changeset
   135
        }
hgs
parents:
diff changeset
   136
        else {
hgs
parents:
diff changeset
   137
            // Scan canceled
hgs
parents:
diff changeset
   138
            emit scanFinished( ScanGeneralError, numItemsAdded );
hgs
parents:
diff changeset
   139
        }
hgs
parents:
diff changeset
   140
        mScanning = false;
hgs
parents:
diff changeset
   141
    }
hgs
parents:
diff changeset
   142
    TX_EXIT
hgs
parents:
diff changeset
   143
}
hgs
parents:
diff changeset
   144
hgs
parents:
diff changeset
   145
/*!
hgs
parents:
diff changeset
   146
 Slot to be called when disk event is received from MPX framework.
hgs
parents:
diff changeset
   147
 */
hgs
parents:
diff changeset
   148
void MpSongScanner::handleDiskEvent( MpxDiskEvents event )
hgs
parents:
diff changeset
   149
{
hgs
parents:
diff changeset
   150
    TX_ENTRY
hgs
parents:
diff changeset
   151
    Q_UNUSED( event );
hgs
parents:
diff changeset
   152
    if ( mScanning ) {
hgs
parents:
diff changeset
   153
        emit scanFinished( ScanInterrupted, 0 );
hgs
parents:
diff changeset
   154
        mScanning = false;
hgs
parents:
diff changeset
   155
    }
hgs
parents:
diff changeset
   156
    TX_EXIT
hgs
parents:
diff changeset
   157
}
hgs
parents:
diff changeset
   158