// Copyright (C) 2019 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qiosurfacegraphicsbuffer.h" #include #include #include #include // CGColorSpaceCopyPropertyList is available on 10.12 and above, // but was only added in the 10.14 SDK, so declare it just in case. extern "C" CFPropertyListRef CGColorSpaceCopyPropertyList(CGColorSpaceRef space); QT_BEGIN_NAMESPACE Q_LOGGING_CATEGORY(lcQpaIOSurface, "qt.qpa.backingstore.iosurface"); QIOSurfaceGraphicsBuffer::QIOSurfaceGraphicsBuffer(const QSize &size, const QPixelFormat &format) : QPlatformGraphicsBuffer(size, format) { const size_t width = size.width(); const size_t height = size.height(); Q_ASSERT(width <= IOSurfaceGetPropertyMaximum(kIOSurfaceWidth)); Q_ASSERT(height <= IOSurfaceGetPropertyMaximum(kIOSurfaceHeight)); static const char bytesPerElement = 4; const size_t bytesPerRow = IOSurfaceAlignProperty(kIOSurfaceBytesPerRow, width * bytesPerElement); const size_t totalBytes = IOSurfaceAlignProperty(kIOSurfaceAllocSize, height * bytesPerRow); NSDictionary *options = @{ (id)kIOSurfaceWidth: @(width), (id)kIOSurfaceHeight: @(height), (id)kIOSurfacePixelFormat: @(unsigned('BGRA')), (id)kIOSurfaceBytesPerElement: @(bytesPerElement), (id)kIOSurfaceBytesPerRow: @(bytesPerRow), (id)kIOSurfaceAllocSize: @(totalBytes), }; m_surface = IOSurfaceCreate((CFDictionaryRef)options); Q_ASSERT(m_surface); Q_ASSERT(size_t(bytesPerLine()) == bytesPerRow); Q_ASSERT(size_t(byteCount()) == totalBytes); } QIOSurfaceGraphicsBuffer::~QIOSurfaceGraphicsBuffer() { } void QIOSurfaceGraphicsBuffer::setColorSpace(QCFType colorSpace) { static const auto kIOSurfaceColorSpace = CFSTR("IOSurfaceColorSpace"); qCDebug(lcQpaIOSurface) << "Tagging" << this << "with color space" << colorSpace; if (colorSpace) { IOSurfaceSetValue(m_surface, kIOSurfaceColorSpace, QCFType(CGColorSpaceCopyPropertyList(colorSpace))); } else { IOSurfaceRemoveValue(m_surface, kIOSurfaceColorSpace); } } const uchar *QIOSurfaceGraphicsBuffer::data() const { return (const uchar *)IOSurfaceGetBaseAddress(m_surface); } uchar *QIOSurfaceGraphicsBuffer::data() { return (uchar *)IOSurfaceGetBaseAddress(m_surface); } int QIOSurfaceGraphicsBuffer::bytesPerLine() const { return IOSurfaceGetBytesPerRow(m_surface); } IOSurfaceRef QIOSurfaceGraphicsBuffer::surface() { return m_surface; } bool QIOSurfaceGraphicsBuffer::isInUse() const { return IOSurfaceIsInUse(m_surface); } IOSurfaceLockOptions lockOptionsForAccess(QPlatformGraphicsBuffer::AccessTypes access) { IOSurfaceLockOptions lockOptions = 0; if (!(access & QPlatformGraphicsBuffer::SWWriteAccess)) lockOptions |= kIOSurfaceLockReadOnly; return lockOptions; } bool QIOSurfaceGraphicsBuffer::doLock(AccessTypes access, const QRect &rect) { Q_UNUSED(rect); Q_ASSERT(!isLocked()); qCDebug(lcQpaIOSurface) << "Locking" << this << "for" << access; // FIXME: Teach QPlatformBackingStore::composeAndFlush about non-2D texture // targets, so that we can use CGLTexImageIOSurface2D to support TextureAccess. if (access & (TextureAccess | HWCompositor)) return false; auto lockOptions = lockOptionsForAccess(access); // Try without read-back first lockOptions |= kIOSurfaceLockAvoidSync; kern_return_t ret = IOSurfaceLock(m_surface, lockOptions, nullptr); if (ret == kIOSurfaceSuccess) return true; if (ret == kIOReturnCannotLock) { qCWarning(lcQpaIOSurface) << "Locking of" << this << "requires read-back"; lockOptions ^= kIOSurfaceLockAvoidSync; ret = IOSurfaceLock(m_surface, lockOptions, nullptr); } if (ret != kIOSurfaceSuccess) { qCWarning(lcQpaIOSurface) << "Failed to lock" << this << ret; return false; } return true; } void QIOSurfaceGraphicsBuffer::doUnlock() { qCDebug(lcQpaIOSurface) << "Unlocking" << this << "from" << isLocked(); auto lockOptions = lockOptionsForAccess(isLocked()); bool success = IOSurfaceUnlock(m_surface, lockOptions, nullptr) == kIOSurfaceSuccess; Q_ASSERT_X(success, "QIOSurfaceGraphicsBuffer", "Unlocking surface should succeed"); } #ifndef QT_NO_DEBUG_STREAM QDebug operator<<(QDebug debug, const QIOSurfaceGraphicsBuffer *graphicsBuffer) { QDebugStateSaver saver(debug); debug.nospace(); debug << "QIOSurfaceGraphicsBuffer(" << (const void *)graphicsBuffer; if (graphicsBuffer) { debug << ", surface=" << graphicsBuffer->m_surface; debug << ", size=" << graphicsBuffer->size(); debug << ", isLocked=" << bool(graphicsBuffer->isLocked()); debug << ", isInUse=" << graphicsBuffer->isInUse(); } debug << ')'; return debug; } #endif // !QT_NO_DEBUG_STREAM QT_END_NAMESPACE