/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtMultimedia module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef SYMBIANAUDIOOUTPUT_H

#define SYMBIANAUDIOOUTPUT_H

#include <QtMultimedia/qaudioengine.h>

#include <QTime>

#include <QTimer>

#include <sounddevice.h>

#include "symbianaudio.h"

QT_BEGIN_NAMESPACE

class SymbianAudioOutput;

class SymbianAudioOutputPrivate : public QIODevice

{

    friend class SymbianAudioOutput;

    Q_OBJECT

public:

    SymbianAudioOutputPrivate(SymbianAudioOutput *audio);

    ~SymbianAudioOutputPrivate();

    qint64 readData(char *data, qint64 len);

    qint64 writeData(const char *data, qint64 len);

private:

    SymbianAudioOutput *const m_audioDevice;

};

class SymbianAudioOutput

    :   public QAbstractAudioOutput

    ,   public MDevSoundObserver

{

    friend class SymbianAudioOutputPrivate;

    Q_OBJECT

public:

    SymbianAudioOutput(const QByteArray &device,

                       const QAudioFormat &audioFormat);

    ~SymbianAudioOutput();

    // QAbstractAudioOutput

    QIODevice* start(QIODevice *device = 0);

    void stop();

    void reset();

    void suspend();

    void resume();

    int bytesFree() const;

    int periodSize() const;

    void setBufferSize(int value);

    int bufferSize() const;

    void setNotifyInterval(int milliSeconds);

    int notifyInterval() const;

    qint64 processedUSecs() const;

    qint64 elapsedUSecs() const;

    QAudio::Error error() const;

    QAudio::State state() const;

    QAudioFormat format() const;

    // MDevSoundObserver

    void InitializeComplete(TInt aError);

    void ToneFinished(TInt aError);

    void BufferToBeFilled(CMMFBuffer *aBuffer);

    void PlayError(TInt aError);

    void BufferToBeEmptied(CMMFBuffer *aBuffer);

    void RecordError(TInt aError);

    void ConvertError(TInt aError);

    void DeviceMessage(TUid aMessageType, const TDesC8 &aMsg);

private slots:

    void dataReady();

    void underflowTimerExpired();

private:

   void open();

   void startPlayback();

   void startDevSoundL();

   void writePaddingData();

   qint64 pushData(const char *data, qint64 len);

   void pullData();

   void bufferFilled();

   void lastBufferFilled();

   Q_INVOKABLE void close();

   qint64 getSamplesPlayed() const;

   void setError(QAudio::Error error);

   void setState(SymbianAudio::State state);

   bool isDataReady() const;

   QAudio::State initializingState() const;

private:

    const QByteArray m_device;

    const QAudioFormat m_format;

    int m_clientBufferSize;

    int m_notifyInterval;

    QScopedPointer<QTimer> m_notifyTimer;

    QTime m_elapsed;

    QAudio::Error m_error;

    SymbianAudio::State m_internalState;

    QAudio::State m_externalState;

    bool m_pullMode;

    QIODevice *m_source;

    QScopedPointer<CMMFDevSound> m_devSound;

    TUint32 m_nativeFourCC;

    TMMFCapabilities m_nativeFormat;

    // Buffer provided by DevSound, to be filled with data.

    CMMFDataBuffer *m_devSoundBuffer;

    int m_devSoundBufferSize;

    // Number of bytes transferred from QIODevice to QAudioOutput.  It is

    // necessary to count this because data is dropped when suspend() is

    // called.  The difference between the position reported by DevSound and

    // this value allows us to calculate m_bytesPadding;

    quint32 m_bytesWritten;

    // True if client has provided data while the audio subsystem was not

    // ready to consume it.

    bool m_pushDataReady;

    // Number of zero bytes which will be written when client calls resume().

    quint32 m_bytesPadding;

    // True if PlayError(KErrUnderflow) has been called.

    bool m_underflow;

    // True if a buffer marked with the "last buffer" flag has been provided

    // to DevSound.

    bool m_lastBuffer;

    // Some DevSound implementations ignore all underflow errors raised by the

    // audio driver, unless the last buffer flag has been set by the client.

    // In push-mode playback, this flag will never be set, so the underflow

    // error will never be reported.  In order to work around this, a timer

    // is used, which gets reset every time the client provides more data.  If

    // the timer expires, an underflow error is raised by this object.

    QScopedPointer<QTimer> m_underflowTimer;

    // Result of previous call to CMMFDevSound::SamplesPlayed().  This value is

    // used to determine whether, when m_underflowTimer expires, an

    // underflow error has actually occurred.

    quint32 m_samplesPlayed;

    // Samples played up to the last call to suspend().  It is necessary

    // to cache this because suspend() is implemented using

    // CMMFDevSound::Stop(), which resets DevSound's SamplesPlayed() counter.

    quint32 m_totalSamplesPlayed;

};

QT_END_NAMESPACE

#endif