Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
QFFmpeg::ConsumerThread Class Referenceabstract

FFmpeg thread that is used to implement a consumer pattern. More...

#include <qffmpegthread_p.h>

+ Inheritance diagram for QFFmpeg::ConsumerThread:
+ Collaboration diagram for QFFmpeg::ConsumerThread:

Public Member Functions

void stopAndDelete ()
 Stops the thread and deletes this object.
 
- Public Member Functions inherited from QThread
 QThread (QObject *parent=nullptr)
 
 ~QThread ()
 
void setPriority (Priority priority)
 
Priority priority () const
 
bool isFinished () const
 
bool isRunning () const
 
void requestInterruption ()
 
bool isInterruptionRequested () const
 
void setStackSize (uint stackSize)
 
uint stackSize () const
 
QAbstractEventDispatcher * eventDispatcher () const
 
void setEventDispatcher (QAbstractEventDispatcher *eventDispatcher)
 
bool event (QEvent *event) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
int loopLevel () const
 
bool isCurrentThread () const
 
bool wait (QDeadlineTimer deadline=QDeadlineTimer(QDeadlineTimer::Forever))
 
bool wait (unsigned long time)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. time is the time to wait in milliseconds.
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Protected Member Functions

virtual void init ()=0
 Called on this thread when thread starts.
 
virtual void cleanup ()=0
 Called on this thread before thread exits.
 
virtual void processOne ()=0
 Process one work item.
 
void dataReady ()
 Wake thread from sleep and process data until hasData() returns false.
 
virtual bool hasData () const =0
 Must return true when data is available for processing.
 
QMutexLocker< QMutex > lockLoopData () const
 Locks the loop data mutex.
 
- Protected Member Functions inherited from QThread
int exec ()
 
 QThread (QThreadPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Private Member Functions

void run () final
 

Additional Inherited Members

- Public Types inherited from QThread
enum  Priority {
  IdlePriority , LowestPriority , LowPriority , NormalPriority ,
  HighPriority , HighestPriority , TimeCriticalPriority , InheritPriority
}
 
- Public Slots inherited from QThread
void start (Priority=InheritPriority)
 
void terminate ()
 
void exit (int retcode=0)
 
void quit ()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QThread
void started (QPrivateSignal)
 
void finished (QPrivateSignal)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 
- Static Public Member Functions inherited from QThread
static Qt::HANDLE currentThreadId () noexcept Q_DECL_PURE_FUNCTION
 
static QThread * currentThread ()
 
static bool isMainThread ()
 
static int idealThreadCount () noexcept
 
static void yieldCurrentThread ()
 
template<typename Function , typename... Args>
static QThread * create (Function &&f, Args &&... args)
 
static void sleep (unsigned long)
 
static void msleep (unsigned long)
 
static void usleep (unsigned long)
 
static void sleep (std::chrono::nanoseconds nsec)
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Static Protected Member Functions inherited from QThread
static void setTerminationEnabled (bool enabled=true)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

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.

Definition at line 37 of file qffmpegthread_p.h.

Member Function Documentation

◆ cleanup()

virtual void QFFmpeg::ConsumerThread::cleanup ( )
protectedpure virtual

Called on this thread before thread exits.

Implemented in QFFmpeg::AudioEncoder, QFFmpeg::Muxer, and QFFmpeg::VideoEncoder.

Referenced by run().

+ Here is the caller graph for this function:

◆ dataReady()

void ConsumerThread::dataReady ( )
protected

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.

Definition at line 22 of file qffmpegthread.cpp.

References QWaitCondition::wakeAll().

Referenced by QFFmpeg::AudioEncoder::addBuffer(), QFFmpeg::VideoEncoder::addFrame(), QFFmpeg::Muxer::addPacket(), and stopAndDelete().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hasData()

virtual bool QFFmpeg::ConsumerThread::hasData ( ) const
protectedpure virtual

Must return true when data is available for processing.

Implemented in QFFmpeg::AudioEncoder, QFFmpeg::Muxer, and QFFmpeg::VideoEncoder.

Referenced by run().

+ Here is the caller graph for this function:

◆ init()

virtual void QFFmpeg::ConsumerThread::init ( )
protectedpure virtual

Called on this thread when thread starts.

Implemented in QFFmpeg::AudioEncoder, QFFmpeg::Muxer, and QFFmpeg::VideoEncoder.

Referenced by run().

+ Here is the caller graph for this function:

◆ lockLoopData()

QMutexLocker< QMutex > ConsumerThread::lockLoopData ( ) const
protected

Locks the loop data mutex.

It must be used to protect loop data like a queue of video frames.

Definition at line 48 of file qffmpegthread.cpp.

Referenced by QFFmpeg::AudioEncoder::addBuffer(), QFFmpeg::VideoEncoder::addFrame(), and QFFmpeg::Muxer::addPacket().

+ Here is the caller graph for this function:

◆ processOne()

virtual void QFFmpeg::ConsumerThread::processOne ( )
protectedpure virtual

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.

Implemented in QFFmpeg::AudioEncoder, QFFmpeg::Muxer, and QFFmpeg::VideoEncoder.

Referenced by run().

+ Here is the caller graph for this function:

◆ run()

void ConsumerThread::run ( void )
finalprivatevirtual

Reimplemented from QThread.

Definition at line 27 of file qffmpegthread.cpp.

References cleanup(), hasData(), init(), processOne(), and QWaitCondition::wait().

+ Here is the call graph for this function:

◆ stopAndDelete()

void ConsumerThread::stopAndDelete ( )

Stops the thread and deletes this object.

Definition at line 11 of file qffmpegthread.cpp.

References dataReady(), and QThread::wait().

+ Here is the call graph for this function:
The documentation for this class was generated from the following files: