Spec-Zone.ru › Qt 5.9

Класс QVideoFrame

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

Заголовок: #include <QVideoFrame>
qmake: QT += multimedia
  • Список всех членов, включая унаследованные

Типы

Перечисление FieldType { ProgressiveFrame, TopField, BottomField, InterlacedFrame }
Перечисление PixelFormat { Format_Invalid, Format_ARGB32, Format_ARGB32_Premultiplied, Format_RGB32, ..., Format_User }

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

QVideoFrame()
QVideoFrame(QAbstractVideoBuffer *buffer, const QSize &size, PixelFormat format)
QVideoFrame(int bytes, const QSize &size, int bytesPerLine, PixelFormat format)
QVideoFrame(const QImage &image)
QVideoFrame(const QVideoFrame &other)
~QVideoFrame()
QVariantMap availableMetaData() const
uchar * bits()
QSize size() const
qint64 startTime() const
void unmap()
int width() const
bool operator!=(const QVideoFrame &other) const
QVideoFrame & operator=(const QVideoFrame &other)
bool operator==(const QVideoFrame &other) const

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

QImage::Format imageFormatFromPixelFormat(PixelFormat format)
PixelFormat pixelFormatFromImageFormat(QImage::Format format)

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

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

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

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

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

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

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

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

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

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

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

Постоянная Значение Описание
QVideoFrame::ProgressiveFrame 0 Кадр не чересстрочный.
QVideoFrame::TopField 1 Кадр содержит верхнее поле.
QVideoFrame::BottomField 2 Кадр содержит нижнее поле.
QVideoFrame::InterlacedFrame 3 Кадр содержит объединённое верхнее и нижнее поле.

enum QVideoFrame::PixelFormat

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

Постоянная Значение Описание
QVideoFrame::Format_Invalid 0 Кадр недействителен.
QVideoFrame::Format_ARGB32 1 Кадр хранится в формате ARGB 32 бита (0xAARRGGBB). Эквивалентен QImage::Format_ARGB32.
QVideoFrame::Format_ARGB32_Premultiplied 2 Кадр хранится в предопределённом формате ARGB 32 бита (0xAARRGGBB). Эквивалентен QImage::Format_ARGB32_Premultiplied.
QVideoFrame::Format_RGB32 3 Кадр хранится в формате RGB 32 бита (0xffRRGGBB). Эквивалентен QImage::Format_RGB32
QVideoFrame::Format_RGB24 4 Кадр хранится в формате RGB 24 бита (8-8-8). Эквивалентен QImage::Format_RGB888
QVideoFrame::Format_RGB565 5 Кадр хранится в формате RGB 16 бита (5-6-5). Эквивалентен QImage::Format_RGB16.
QVideoFrame::Format_RGB555 6 Кадр хранится в формате RGB 16 бита (5-5-5). Эквивалентен QImage::Format_RGB555.
QVideoFrame::Format_ARGB8565_Premultiplied 7 Кадр хранится в предопределённом формате ARGB 24 бита (8-5-6-5).
QVideoFrame::Format_BGRA32 8 Кадр хранится в формате BGRA 32 бита (0xBBGGRRAA).
QVideoFrame::Format_BGRA32_Premultiplied 9 Кадр хранится в предопределённом формате BGRA 32 бита.
QVideoFrame::Format_BGR32 10 Кадр хранится в формате BGR 32 бита (0xBBGGRRff).
QVideoFrame::Format_BGR24 11 Кадр хранится в формате BGR 24 бита (0xBBGGRR).
QVideoFrame::Format_BGR565 12 Кадр хранится в формате BGR 16 бита (5-6-5).
QVideoFrame::Format_BGR555 13 Кадр хранится в формате BGR 16 бита (5-5-5).
QVideoFrame::Format_BGRA5658_Premultiplied 14 Кадр хранится в предопределённом формате BGRA 24 бита (5-6-5-8).
QVideoFrame::Format_AYUV444 15 Кадр хранится в упакованном формате AYUV 32 бита (0xAAYYUUVV).
QVideoFrame::Format_AYUV444_Premultiplied 16 Кадр хранится в предопределённом упакованном формате AYUV 32 бита (0xAAYYUUVV).
QVideoFrame::Format_YUV444 17 Кадр хранится в формате YUV 24 бита (8-8-8).
QVideoFrame::Format_YUV420P 18 Кадр хранится в планарном формате YUV 8 бит на компонент, с подвыборочным размещением U и V планов по горизонтали и вертикали (половина высоты и ширины по сравнению с планом Y).
QVideoFrame::Format_YV12 19 Кадр хранится в планарном формате YVU 8 бит на компонент, с подвыборочным размещением V и U планов по горизонтали и вертикали (половина высоты и ширины по сравнению с планом Y).
QVideoFrame::Format_UYVY 20 Кадр хранится в упакованном формате YUV 8 бит на компонент с подвыборочным размещением U и V планов по горизонтали (U-Y-V-Y). Два соседних пикселя по горизонтали хранятся как макропиксель 32 бита, имеющий значение Y для каждого пикселя и общие значения U и V.
QVideoFrame::Format_YUYV 21 Кадр хранится в упакованном формате YUV 8 бит на компонент с подвыборочным размещением U и V планов по горизонтали (Y-U-Y-V). Два соседних пикселя по горизонтали хранятся как макропиксель 32 бита, имеющий значение Y для каждого пикселя и общие значения U и V.
QVideoFrame::Format_NV12 22 Кадр хранится в полупланарном формате YUV 8 бит на компонент с планом Y, за которым следует упакованный подвыборочный UV-план (U-V).
QVideoFrame::Format_NV21 23 Кадр хранится в полупланарном формате YUV 8 бит на компонент с планом Y, за которым следует упакованный подвыборочный VU-план (V-U).
QVideoFrame::Format_IMC1 24 Кадр хранится в планарном формате YUV 8 бит на компонент с подвыборочным размещением U и V планов по горизонтали и вертикали. Аналогичен типу Format_YUV420P, за исключением того, что байты на строку в U и V планах дополнены до того же шага, что и в плане Y.
QVideoFrame::Format_IMC2 25 Кадр хранится в планарном формате YUV 8 бит на компонент с подвыборочным размещением U и V планов по горизонтали и вертикали. Аналогичен типу Format_YUV420P, за исключением того, что строки U и V планов чередуются, т.е. за каждой строкой данных U следует строка данных V, создавая единую строку с тем же шагом, что и данные Y.
QVideoFrame::Format_IMC3 26 Кадр хранится в планарном формате YVU 8 бит на компонент с подвыборочным размещением V и U планов по горизонтали и вертикали. Аналогичен типу Format_YV12, за исключением того, что байты на строку в V и U планах дополнены до того же шага, что и в плане Y.
QVideoFrame::Format_IMC4 27 Кадр хранится в планарном формате YVU 8 бит на компонент с подвыборочным размещением V и U планов по горизонтали и вертикали. Аналогичен типу Format_YV12, за исключением того, что строки V и U планов чередуются, т.е. за каждой строкой данных V следует строка данных U, создавая единую строку с тем же шагом, что и данные Y.
QVideoFrame::Format_Y8 28 Кадр хранится в формате 8-битного серого цвета.
QVideoFrame::Format_Y16 29 Кадр хранится в линейном 16-битном формате серого цвета. Маленький порядок байтов.
QVideoFrame::Format_Jpeg 30 Кадр хранится в сжатом формате JPEG.
QVideoFrame::Format_CameraRaw 31 Кадр хранится в формате камеры, специфичном для устройства.
QVideoFrame::Format_AdobeDng 32 Кадр хранится в формате сырых данных Adobe Digital Negative (DNG).
QVideoFrame::Format_User 1000 Начальное значение для пользовательских форматов пикселей.

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

QVideoFrame::QVideoFrame()

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

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

Создаёт видеокадр из buffer с заданным форматом пикселей format и размерами size в пикселях.

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

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

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

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

QVideoFrame::QVideoFrame(const QImage &image)

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

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

END_OF_DOCUMENT_MARKER

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

QVideoFrame::QVideoFrame(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().

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().

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(PixelFormat format)

Возвращает формат изображения, эквивалентный формату пикселей видеокадра 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)

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

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

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

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

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

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

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

Возвращает true, если кадр был отображен в памяти в заданном режиме mode, и 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().

PixelFormat QVideoFrame::pixelFormat() const

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

[static] 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(FieldType field)

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

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

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

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

Если 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 не отражают один и тот же кадр.

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

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

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

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

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qvideoframe.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API