Spec-Zone.ru › Qt 5.11

Класс QVideoFrame

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

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

Типы public

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

Функции public

QVideoFrame()
QVideoFrame(QAbstractVideoBuffer *buffer, const QSize &size, QVideoFrame::PixelFormat format)
QVideoFrame(int bytes, const QSize &size, int bytesPerLine, QVideoFrame::PixelFormat format)
QVideoFrame(const QImage &image)
QVideoFrame(const QVideoFrame &other)
~QVideoFrame()
QVariantMap availableMetaData() const
uchar * bits()
uchar * bits(int plane)
const uchar * bits() const
const uchar * bits(int plane) const
int bytesPerLine() const
int bytesPerLine(int plane) const
qint64 endTime() const
QVideoFrame::FieldType fieldType() const
QVariant handle() const
QAbstractVideoBuffer::HandleType handleType() const
int height() const
bool isMapped() const
bool isReadable() const
bool isValid() const
bool isWritable() const
bool map(QAbstractVideoBuffer::MapMode mode)
QAbstractVideoBuffer::MapMode mapMode() const
int mappedBytes() const
QVariant metaData(const QString &key) const
QVideoFrame::PixelFormat pixelFormat() const
int planeCount() const
void setEndTime(qint64 time)
void setFieldType(QVideoFrame::FieldType field)
void setMetaData(const QString &key, const QVariant &value)
void setStartTime(qint64 time)
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

Статические public члены

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

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

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

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

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

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

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

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

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

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

enum 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 горизонтально и вертикально подвыборочны, т.е. высота и ширина плоскостей U и V вдвое меньше, чем у плоскости Y.
QVideoFrame::Format_YV12 19 Кадр хранится в формате YVU с 8 битами на компонент, где плоскости V и U горизонтально и вертикально подвыборочны, т.е. высота и ширина плоскостей 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, QVideoFrame::PixelFormat format)

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

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

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

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

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

QVideoFrame::QVideoFrame(const QImage &image)

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

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

См. также 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().

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)

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

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

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

Режим отображения 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().

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)

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

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

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

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

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

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

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

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

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

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

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

void QVideoFrame::setStartTime(qint64 time)

Устанавливает время презентации 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/archives/qt-5.11/qvideoframe.html

Spec-Zone.ru

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