diff options
Diffstat (limited to 'src/plugins/multimedia/ffmpeg/qffmpegthread_p.h')
-rw-r--r-- | src/plugins/multimedia/ffmpeg/qffmpegthread_p.h | 116 |
1 files changed, 54 insertions, 62 deletions
diff --git a/src/plugins/multimedia/ffmpeg/qffmpegthread_p.h b/src/plugins/multimedia/ffmpeg/qffmpegthread_p.h index bd5ecbba5..a7c5b0927 100644 --- a/src/plugins/multimedia/ffmpeg/qffmpegthread_p.h +++ b/src/plugins/multimedia/ffmpeg/qffmpegthread_p.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// 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 QFFMPEGTHREAD_P_H #define QFFMPEGTHREAD_P_H @@ -63,38 +27,66 @@ class QAudioSink; namespace QFFmpeg { -class Thread : public QThread +/*! + FFmpeg thread that is used to implement a consumer pattern. + + This thread processes work items until no more data is available. + When no more data is available, it sleeps until it is notified about + more available data. + */ +class ConsumerThread : public QThread { public: - mutable QMutex mutex; - qint64 timeOut = -1; -private: - QWaitCondition condition; + /*! + Stops the thread and deletes this object + */ + void stopAndDelete(); protected: - QAtomicInteger<bool> exit = false; - -public: - // public API is thread-safe - void kill(); - virtual void killHelper() {} - - void wake() { - condition.wakeAll(); - } - -protected: - virtual void init() {} - virtual void cleanup() {} - // loop() should never block, all blocking has to happen in shouldWait() - virtual void loop() = 0; - virtual bool shouldWait() const { return false; } + /*! + Called on this thread when thread starts + */ + virtual void init() = 0; + + /*! + Called on this thread before thread exits + */ + virtual void cleanup() = 0; + + /*! + Process one work item. Called repeatedly until hasData() returns + false, in which case the thread sleeps until the next dataReady() + notification. + + Note: processOne() should never block. + */ + virtual void processOne() = 0; + + /*! + Wake thread from sleep and process data until + hasData() returns false. The method is supposed to be invoked + right after the scope of QMutexLocker that lockLoopData returns. + */ + void dataReady(); + + /*! + Must return true when data is available for processing + */ + virtual bool hasData() const = 0; + + /*! + Locks the loop data mutex. It must be used to protect loop data + like a queue of video frames. + */ + QMutexLocker<QMutex> lockLoopData() const; private: - void maybePause(); + void run() final; - void run() override; + mutable QMutex m_loopDataMutex; + QWaitCondition m_condition; + bool m_exit = false; }; } |