Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QFFmpeg::EncoderThread Class Referenceabstract

#include <qffmpegencoderthread_p.h>

Inheritance diagram for QFFmpeg::EncoderThread:
Collaboration diagram for QFFmpeg::EncoderThread:

Signals

void canPushFrameChanged ()
void endOfSourceStream ()
void initialized ()
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.

Public Member Functions

 EncoderThread (RecordingEngine &recordingEngine)
void setPaused (bool paused)
void setAutoStop (bool autoStop)
void setSource (QObject *source)
QObject * source () const
bool canPushFrame () const override
void setEndOfSourceStream ()
bool isEndOfSourceStream () const
void startEncoding (bool noError)
bool isInitialized () const
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 noexcept
void setServiceLevel (QualityOfService serviceLevel)
QualityOfService serviceLevel () 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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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.
Public Member Functions inherited from QMediaInputEncoderInterface
virtual ~QMediaInputEncoderInterface ()=default

Protected Member Functions

bool init () override
 Called on this thread when thread starts.
void updateCanPushFrame ()
virtual bool checkIfCanPushFrame () const =0
void resetEndOfSourceStream ()
auto lockLoopData ()
Protected Member Functions inherited from QFFmpeg::ConsumerThread
void stopAndDelete ()
 Stops the thread and deletes this object.
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)

Protected Attributes

bool m_paused = false
bool m_endOfSourceStream = false
bool m_autoStop = false
bool m_initialized = false
bool m_encodingStarted = false
std::atomic_bool m_canPushFrame = false
RecordingEngine & m_recordingEngine
QPointer< QObject > m_source
QSemaphore m_encodingStartSemaphore
Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr

Additional Inherited Members

Public Types inherited from QThread
enum  Priority {
  IdlePriority , LowestPriority , LowPriority , NormalPriority ,
  HighPriority , HighestPriority , TimeCriticalPriority , InheritPriority
}
enum class  QualityOfService { Auto , High , Eco }
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
Static Public Member Functions inherited from QThread
static Q_DECL_PURE_FUNCTION Qt::HANDLE currentThreadId () noexcept
static QThread * currentThread ()
static bool isMainThread () noexcept
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)
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

Definition at line 29 of file qffmpegencoderthread_p.h.

Constructor & Destructor Documentation

◆ EncoderThread()

QFFmpeg::EncoderThread::EncoderThread ( RecordingEngine & recordingEngine)

Definition at line 10 of file qffmpegencoderthread.cpp.

References m_recordingEngine.

Member Function Documentation

◆ canPushFrame()

bool QFFmpeg::EncoderThread::canPushFrame ( ) const
inlineoverridevirtual

Implements QMediaInputEncoderInterface.

Definition at line 43 of file qffmpegencoderthread_p.h.

◆ canPushFrameChanged

void QFFmpeg::EncoderThread::canPushFrameChanged ( )
signal

◆ checkIfCanPushFrame()

virtual bool QFFmpeg::EncoderThread::checkIfCanPushFrame ( ) const
protectedpure virtual

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

Referenced by lockLoopData().

Here is the caller graph for this function:

◆ endOfSourceStream

void QFFmpeg::EncoderThread::endOfSourceStream ( )
signal

◆ init()

bool QFFmpeg::EncoderThread::init ( )
overrideprotectedvirtual

Called on this thread when thread starts.

Implements QFFmpeg::ConsumerThread.

Reimplemented in QFFmpeg::VideoEncoder.

Definition at line 44 of file qffmpegencoderthread.cpp.

References m_initialized.

◆ initialized

void QFFmpeg::EncoderThread::initialized ( )
signal

◆ isEndOfSourceStream()

bool QFFmpeg::EncoderThread::isEndOfSourceStream ( ) const
inline

Definition at line 47 of file qffmpegencoderthread_p.h.

References m_endOfSourceStream.

◆ isInitialized()

bool QFFmpeg::EncoderThread::isInitialized ( ) const
inline

Definition at line 51 of file qffmpegencoderthread_p.h.

References m_initialized.

◆ lockLoopData()

auto QFFmpeg::EncoderThread::lockLoopData ( )
inlineprotected

Definition at line 62 of file qffmpegencoderthread_p.h.

References checkIfCanPushFrame(), m_autoStop, m_endOfSourceStream, and m_paused.

Here is the call graph for this function:

◆ resetEndOfSourceStream()

void QFFmpeg::EncoderThread::resetEndOfSourceStream ( )
inlineprotected

Definition at line 60 of file qffmpegencoderthread_p.h.

References m_endOfSourceStream.

◆ setAutoStop()

void QFFmpeg::EncoderThread::setAutoStop ( bool autoStop)

Definition at line 20 of file qffmpegencoderthread.cpp.

References m_autoStop.

◆ setEndOfSourceStream()

void QFFmpeg::EncoderThread::setEndOfSourceStream ( )

Definition at line 26 of file qffmpegencoderthread.cpp.

References m_endOfSourceStream.

◆ setPaused()

void QFFmpeg::EncoderThread::setPaused ( bool paused)

Definition at line 14 of file qffmpegencoderthread.cpp.

References m_paused.

◆ setSource()

void QFFmpeg::EncoderThread::setSource ( QObject * source)
inline

Definition at line 39 of file qffmpegencoderthread_p.h.

◆ source()

QObject * QFFmpeg::EncoderThread::source ( ) const
inline

Definition at line 41 of file qffmpegencoderthread_p.h.

Referenced by QFFmpeg::disconnectEncoderFromSource().

Here is the caller graph for this function:

◆ startEncoding()

void QFFmpeg::EncoderThread::startEncoding ( bool noError)

Definition at line 36 of file qffmpegencoderthread.cpp.

References m_encodingStarted.

◆ updateCanPushFrame()

void QFFmpeg::EncoderThread::updateCanPushFrame ( )
protected

Member Data Documentation

◆ m_autoStop

bool QFFmpeg::EncoderThread::m_autoStop = false
protected

Definition at line 81 of file qffmpegencoderthread_p.h.

Referenced by lockLoopData(), and setAutoStop().

◆ m_canPushFrame

std::atomic_bool QFFmpeg::EncoderThread::m_canPushFrame = false
protected

Definition at line 84 of file qffmpegencoderthread_p.h.

◆ m_encodingStarted

bool QFFmpeg::EncoderThread::m_encodingStarted = false
protected

Definition at line 83 of file qffmpegencoderthread_p.h.

Referenced by startEncoding().

◆ m_encodingStartSemaphore

QSemaphore QFFmpeg::EncoderThread::m_encodingStartSemaphore
protected

Definition at line 87 of file qffmpegencoderthread_p.h.

◆ m_endOfSourceStream

bool QFFmpeg::EncoderThread::m_endOfSourceStream = false
protected

Definition at line 80 of file qffmpegencoderthread_p.h.

Referenced by isEndOfSourceStream(), lockLoopData(), resetEndOfSourceStream(), and setEndOfSourceStream().

◆ m_initialized

bool QFFmpeg::EncoderThread::m_initialized = false
protected

Definition at line 82 of file qffmpegencoderthread_p.h.

Referenced by init(), and isInitialized().

◆ m_paused

bool QFFmpeg::EncoderThread::m_paused = false
protected

Definition at line 79 of file qffmpegencoderthread_p.h.

Referenced by lockLoopData(), and setPaused().

◆ m_recordingEngine

RecordingEngine& QFFmpeg::EncoderThread::m_recordingEngine
protected

Definition at line 85 of file qffmpegencoderthread_p.h.

Referenced by EncoderThread().

◆ m_source

QPointer<QObject> QFFmpeg::EncoderThread::m_source
protected

Definition at line 86 of file qffmpegencoderthread_p.h.

The documentation for this class was generated from the following files: