Класс QVideoFrame

Класс QVideoFrame представляет кадр видеоданных. Подробнее...

• Список всех членов, включая унаследованные

Открытые типы

Открытые функции

Статические открытые члены

Подробное описание

QVideoFrame инкапсулирует пиксельные данные кадра видео и информацию о кадре.

Видеокадры могут поступать из различных источников — декодированные медиа, камеры или генерироваться программно. Способы описания пикселей в этих кадрах могут существенно различаться, а некоторые форматы пикселей предлагают лучшие возможности сжатия в ущерб удобству использования.

Содержимое пикселей видеокадра может быть отображено в памяти с помощью функции map(). Во время отображения доступ к видеоданным можно получить с помощью функции bits(), которая возвращает указатель на буфер. Общий размер этого буфера задается функцией mappedBytes(), а размер каждой строки — функцией bytesPerLine(). Возвращаемое значение функции handle() также может использоваться для доступа к данным кадра с помощью собственных API-интерфейсов внутреннего буфера (например, дескриптор текстуры OpenGL).

Видеокадр также может содержать временную информацию. Эти временные метки могут использоваться реализацией QAbstractVideoSurface для определения момента начала и остановки отображения кадра, но не все поверхности могут учитывать это значение.

Видеоданные пикселей в QVideoFrame инкапсулированы в QAbstractVideoBuffer. QVideoFrame может быть создан из любого типа буфера путем наследования класса QAbstractVideoBuffer.

Примечание: Поскольку копирование видеокадров может быть дорогостоящим, QVideoFrame явно использует совместный доступ, поэтому любые изменения, внесенные в видеокадр, будут применяться ко всем его копиям.

Документация по типу члена

перечисление QVideoFrame::FieldType

Определяет поле, к которому принадлежит интерлинированный видеокадр.

enum QVideoFrame::PixelFormat

Перечисляет типы видеоданных.

Документация по функциям-членам

QVideoFrame::QVideoFrame(const QVideoFrame &other)

Создает неглубокую копию other. Поскольку QVideoFrame явно разделяется, эти два экземпляра будут отражать один и тот же кадр.

QVideoFrame::QVideoFrame(const QImage &image)

Создает видеокадр из image.

Примечание: Это создаст недействительный видеокадр, если нет типа кадра, эквивалентного формату изображения.

См. также pixelFormatFromImageFormat().

QVideoFrame::QVideoFrame(int bytes, const QSize &size, int bytesPerLine, QVideoFrame::PixelFormat format)

Создаёт видеокадр заданного пиксельного формата и размера в пикселях.

bytesPerLine (шаг) — длина каждой строки сканирования в байтах, а bytes — общее количество байтов, которое необходимо выделить для кадра.

QVideoFrame::QVideoFrame(QAbstractVideoBuffer *buffer, const QSize &size, QVideoFrame::PixelFormat format)

Создаёт видеокадр из буфера с заданным пиксельным форматом и размером в пикселях.

Примечание: Это не увеличивает счётчик ссылок видеобуфера.

QVideoFrame::QVideoFrame()

Создаёт пустой видеокадр.

QVideoFrame &QVideoFrame::operator=(const QVideoFrame &other)

Присваивает содержимое other этому видеокадру. Поскольку QVideoFrame явно разделяемый, эти два экземпляра будут отражать один и тот же кадр.

QVideoFrame::~QVideoFrame()

Удаляет видеокадр.

QVariantMap QVideoFrame::availableMetaData() const

Возвращает любые дополнительные метаданные, связанные с этим кадром.

uchar *QVideoFrame::bits()

Возвращает указатель на начало буфера данных кадра.

Это значение действительно только пока данные кадра отображены.

Изменения, внесённые в данные, доступные через этот указатель (при отображении с правом записи), гарантируются только после вызова unmap() и отображения буфера для записи.

См. также map(), mappedBytes() и bytesPerLine().

uchar *QVideoFrame::bits(int plane)

Возвращает указатель на начало буфера данных кадра для плоскости plane.

Это значение действительно только пока данные кадра отображены.

Изменения, внесённые в данные, доступные через этот указатель (при отображении с правом записи), гарантируются только после вызова unmap() и отображения буфера для записи.

Эта функция была добавлена в Qt 5.4.

См. также map(), mappedBytes(), bytesPerLine() и planeCount().

const uchar *QVideoFrame::bits() const

Возвращает указатель на начало буфера данных кадра.

Это значение действительно только пока данные кадра отображены.

Если буфер не был отображён с доступом для чтения, содержимое этого буфера изначально будет неопределённым.

См. также map(), mappedBytes() и bytesPerLine().

const uchar *QVideoFrame::bits(int plane) const

Возвращает указатель на начало буфера данных кадра для плоскости plane.

Это значение действительно только пока данные кадра отображены.

Если буфер не был отображён с доступом для чтения, содержимое этого буфера изначально будет неопределённым.

Эта функция была добавлена в Qt 5.4.

См. также map(), mappedBytes(), bytesPerLine() и planeCount().

QAbstractVideoBuffer *QVideoFrame::buffer() const

Возвращает базовый видеобуфер или null если его нет.

Эта функция была добавлена в Qt 5.13.

int QVideoFrame::bytesPerLine() const

Возвращает количество байтов в строке сканирования.

Примечание: Для планарных форматов это количество байтов в строке только для первой плоскости. Количество байтов в строке для последующих плоскостей должно рассчитываться в соответствии с форматом пикселей кадра.

Это значение действительно только пока данные кадра отображены.

См. также bits(), map() и mappedBytes().

int QVideoFrame::bytesPerLine(int plane) const

Возвращает количество байтов в строке сканирования для плоскости plane.

Это значение действительно только пока данные кадра отображены.

Эта функция была добавлена в Qt 5.4.

См. также bits(), map(), mappedBytes() и planeCount().

qint64 QVideoFrame::endTime() const

Возвращает время представления (в микросекундах), когда кадр должен перестать отображаться.

Неверное время представлено как -1.

См. также setEndTime().

QVideoFrame::FieldType QVideoFrame::fieldType() const

Возвращает поле, к которому относится интерлинированный видеокадр.

Если видео не является интерлинированным, возвращается WholeFrame.

См. также setFieldType().

QVariant QVideoFrame::handle() const

Возвращает специфичную для типа обработку буфера видеокадра.

Для текстуры OpenGL это будет идентификатор текстуры.

См. также QAbstractVideoBuffer::handle().

QAbstractVideoBuffer::HandleType QVideoFrame::handleType() const

Возвращает тип обработки видеокадра.

int QVideoFrame::height() const

Возвращает высоту видеокадра.

[static] QImage::Format QVideoFrame::imageFormatFromPixelFormat(QVideoFrame::PixelFormat format)

Возвращает формат изображения, эквивалентный пиксельному формату видеокадра. Если эквивалентного формата нет, возвращается QImage::Format_Invalid.

Примечание: В целом QImage не обрабатывает форматы YUV.

bool QVideoFrame::isMapped() const

Определяет, отображены ли содержимое видеокадра в системной памяти.

Это вспомогательная функция, которая проверяет, что MapMode кадра не равен QAbstractVideoBuffer::NotMapped.

Возвращает true, если содержимое видеокадра отображено в системной памяти, и false в противном случае.

См. также mapMode() и QAbstractVideoBuffer::MapMode.

bool QVideoFrame::isReadable() const

Определяет, были ли отображаемые данные видеокадра прочитаны из кадра при его отображении.

Это вспомогательная функция, которая проверяет, содержит ли MapMode флаг QAbstractVideoBuffer::WriteOnly.

Возвращает true, если содержимое отображаемой памяти было прочитано из видеокадра, и false в противном случае.

См. также mapMode() и QAbstractVideoBuffer::MapMode.

bool QVideoFrame::isValid() const

Определяет, является ли видеокадр допустимым.

Недопустимый кадр не имеет связанного с ним видеобуфера.

Возвращает true, если кадр допустим, и false в противном случае.

bool QVideoFrame::isWritable() const

Определяет, будут ли отображаемые данные видеокадра сохранены при размене кадра.

Это вспомогательная функция, которая проверяет, содержит ли MapMode флаг QAbstractVideoBuffer::WriteOnly.

Возвращает true, если видеокадр будет обновлён при размене, и false в противном случае.

Примечание: Результат изменения данных кадра, который отображается в режиме только для чтения, не определён. В зависимости от реализации буфера изменения могут быть сохранены или, что хуже, изменят общий буфер.

См. также mapMode() и QAbstractVideoBuffer::MapMode.

bool QVideoFrame::map(QAbstractVideoBuffer::MapMode mode)

Отображает содержимое видеокадра в системную (доступную по адресу ЦП) память.

В некоторых случаях данные видеокадра могут храниться в видеопамяти или в другой памяти, недоступной, поэтому необходимо отобразить кадр перед доступом к данным пикселей. Это может включать копирование содержимого, поэтому избегайте отображения и размена, если это не требуется.

Карта режима указывает, нужно ли считывать и/или записывать содержимое отображённой памяти в кадр. Если режим карты включает флаг QAbstractVideoBuffer::ReadOnly, отображённая память будет заполняться содержимым видеокадра при первоначальном отображении. Если режим карты включает флаг QAbstractVideoBuffer::WriteOnly, содержимое, возможно, изменённой отображённой памяти, будет записано обратно в кадр при его отображении.

Во время отображения к содержимому видеокадра можно получить прямой доступ через указатель, возвращаемый функцией bits().

Когда доступ к данным больше не нужен, убедитесь, что вызывается функция unmap() для освобождения отображённой памяти и, возможно, обновления содержимого видеокадра.

Если видеокадр был отображён в режиме только для чтения, разрешается отображать его несколько раз в режиме только для чтения (и скрывать его соответствующее количество раз). Во всех остальных случаях необходимо сначала скрыть кадр, прежде чем отображать его второй раз.

Примечание: Запись в память, отображённую как только для чтения, не определена и может привести к изменениям в общих данных или к сбоям.

Возвращает true, если кадр был отображён в памяти в заданном режиме, и false в противном случае.

См. также unmap(), mapMode() и bits().

QAbstractVideoBuffer::MapMode QVideoFrame::mapMode() const

Возвращает режим отображения видеокадра в системной памяти.

См. также map() и QAbstractVideoBuffer::MapMode.

int QVideoFrame::mappedBytes() const

Возвращает количество байтов, занимаемых данными отображённого кадра.

Это значение применимо только во время отображения данных кадра.

См. также map().

QVariant QVideoFrame::metaData(const QString &key) const

Возвращает любые метаданные для этого кадра по заданному ключу.

Это могут быть данные, специфичные для кадра, из камеры или субтитры из декодированного видеопотока.

См. документацию соответствующего производителя видеокадров для получения дополнительной информации о доступных метаданных.

См. также setMetaData().

QVideoFrame::PixelFormat QVideoFrame::pixelFormat() const

Возвращает цветовой формат видеокадра.

[static] QVideoFrame::PixelFormat QVideoFrame::pixelFormatFromImageFormat(QImage::Format format)

Возвращает эквивалентный видеопиксельный формат для изображения format. Если эквивалентного формата нет, вместо этого возвращается QVideoFrame::InvalidType.

Примечание: В целом, QImage не обрабатывает форматы YUV.

int QVideoFrame::planeCount() const

Возвращает количество планов в видеокадре.

Это значение применимо только во время отображения данных кадра.

Эта функция была добавлена в Qt 5.4.

См. также map().

void QVideoFrame::setEndTime(qint64 time)

Устанавливает время представления (в микросекундах) завершения отображения кадра.

Неверное время представлено как -1.

См. также endTime().

void QVideoFrame::setFieldType(QVideoFrame::FieldType field)

Устанавливает поле, к которому относится чересстрочный видеокадр.

См. также fieldType().

void QVideoFrame::setMetaData(const QString &key, const QVariant &value)

Устанавливает метаданные для заданного ключа в значение.

Если значение является пустым вариантом, любые метаданные для этого ключа будут удалены.

Производитель видеокадра может использовать это для связывания определённых данных с этим кадром, или промежуточный процессор может добавлять информацию для потребителя этого кадра.

См. также metaData().

void QVideoFrame::setStartTime(qint64 time)

Устанавливает время представления (в микросекундах) начала отображения кадра.

Неверное время представлено как -1.

См. также startTime().

QSize QVideoFrame::size() const

Возвращает размеры видеокадра.

qint64 QVideoFrame::startTime() const

Возвращает время представления (в микросекундах) начала отображения кадра.

Неверное время представлено как -1.

См. также setStartTime().

void QVideoFrame::unmap()

Освобождает память, отображённую функцией map().

Если MapMode включал флаг QAbstractVideoBuffer::WriteOnly, это сохранит текущее содержимое отображённой памяти в видеокадр.

unmap() не следует вызывать, если функция map() завершилась неудачно.

См. также map().

int QVideoFrame::width() const

Возвращает ширину видеокадра.

bool QVideoFrame::operator!=(const QVideoFrame &other) const

Возвращает true, если этот QVideoFrame и other не отражают один и тот же кадр.

bool QVideoFrame::operator==(const QVideoFrame &other) const

Возвращает true, если этот QVideoFrame и other отражают один и тот же кадр.