qplatformaudiodecoder_p.h

Enable keyboard shortcuts

// Copyright (C) 2021 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#ifndef QAUDIODECODERCONTROL_H

#define QAUDIODECODERCONTROL_H

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

//

#include <QtMultimedia/qaudiobuffer.h>

#include <QtMultimedia/qaudiodecoder.h>

#include <QtCore/private/qglobal_p.h>

#include <QtCore/qurl.h>

#include <chrono>

QT_BEGIN_NAMESPACE

class QIODevice;

class Q_MULTIMEDIA_EXPORT QPlatformAudioDecoder : public QObject

    Q_OBJECT

public:

    static constexpr std::chrono::milliseconds kInvalidDuration{ -1 };

    static constexpr std::chrono::milliseconds kInvalidPosition{ -1 };

    virtual QUrl source() const = 0;

    virtual void setSource(const QUrl &fileName) = 0;

    virtual QIODevice* sourceDevice() const = 0;

    virtual void setSourceDevice(QIODevice *device) = 0;

    virtual void start() = 0;

    virtual void stop() = 0;

    virtual QAudioFormat audioFormat() const = 0;

    virtual void setAudioFormat(const QAudioFormat &format) = 0;

    virtual QAudioBuffer read() = 0;

    virtual bool bufferAvailable() const { return m_bufferAvailable; }

    std::chrono::milliseconds position() const { return m_position; }

    std::chrono::milliseconds duration() const { return m_duration; }

    void formatChanged(const QAudioFormat &format);

    void sourceChanged();

    void error(QAudioDecoder::Error error, const QString &errorString);

    void clearError() { error(QAudioDecoder::NoError, QString()); }

    void bufferReady();

    void bufferAvailableChanged(bool available);

    void setIsDecoding(bool running = true) {

        if (m_isDecoding == running)

            return;

        m_isDecoding = running;

        Q_EMIT q->isDecodingChanged(m_isDecoding);

    void finished();

    bool isDecoding() const { return m_isDecoding; }

    void positionChanged(std::chrono::milliseconds);

    void durationChanged(std::chrono::milliseconds);

    QAudioDecoder::Error error() const { return m_error; }

    QString errorString() const { return m_errorString; }

    virtual bool canReadQrc() const { return false; }

    ~QPlatformAudioDecoder() override;

protected:

    explicit QPlatformAudioDecoder(QAudioDecoder *parent);

private:

    QAudioDecoder *q = nullptr;

    // stored in milliseconds resolution

    std::chrono::milliseconds m_duration = kInvalidDuration;

    std::chrono::milliseconds m_position = kInvalidPosition;

    QAudioDecoder::Error m_error = QAudioDecoder::NoError;

    QString m_errorString;

    bool m_isDecoding = false;

    bool m_bufferAvailable = false;

};

QT_END_NAMESPACE

#endif  // QAUDIODECODERCONTROL_H