Bug 1657107 - Use YUV22 format for uploading videos to IOSurfaces instead of NV12. r=mstange

Differential Revision: https://phabricator.services.mozilla.com/D86081

gfx/2d/MacIOSurface.cpp

@@ -181,6 +181,71 @@ already_AddRefed<MacIOSurface> MacIOSurface::CreateNV12Surface(
   return ioSurface.forget();
 }
 
+/* static */
+already_AddRefed<MacIOSurface> MacIOSurface::CreateYUV422Surface(
+    const IntSize& aSize, YUVColorSpace aColorSpace, ColorRange aColorRange) {
+  MOZ_ASSERT(aColorSpace == YUVColorSpace::BT601 ||
+             aColorSpace == YUVColorSpace::BT709);
+  MOZ_ASSERT(aColorRange == ColorRange::LIMITED ||
+             aColorRange == ColorRange::FULL);
+
+  auto props = CFTypeRefPtr<CFMutableDictionaryRef>::WrapUnderCreateRule(
+      ::CFDictionaryCreateMutable(kCFAllocatorDefault, 4,
+                                  &kCFTypeDictionaryKeyCallBacks,
+                                  &kCFTypeDictionaryValueCallBacks));
+  if (!props) return nullptr;
+
+  MOZ_ASSERT((size_t)aYSize.width <= GetMaxWidth());
+  MOZ_ASSERT((size_t)aYSize.height <= GetMaxHeight());
+
+  AddDictionaryInt(props, kIOSurfaceWidth, aSize.width);
+  AddDictionaryInt(props, kIOSurfaceHeight, aSize.height);
+  ::CFDictionaryAddValue(props.get(), kIOSurfaceIsGlobal, kCFBooleanTrue);
+  AddDictionaryInt(props, kIOSurfaceBytesPerElement, 2);
+
+  if (aColorRange == ColorRange::LIMITED) {
+    AddDictionaryInt(props, kIOSurfacePixelFormat,
+                     (uint32_t)kCVPixelFormatType_422YpCbCr8_yuvs);
+  } else {
+    AddDictionaryInt(props, kIOSurfacePixelFormat,
+                     (uint32_t)kCVPixelFormatType_422YpCbCr8FullRange);
+  }
+
+  CFTypeRefPtr<IOSurfaceRef> surfaceRef =
+      CFTypeRefPtr<IOSurfaceRef>::WrapUnderCreateRule(
+          ::IOSurfaceCreate(props.get()));
+
+  if (!surfaceRef) {
+    return nullptr;
+  }
+
+  // Setup the correct YCbCr conversion matrix on the IOSurface, in case we pass
+  // this directly to CoreAnimation.
+  if (aColorSpace == YUVColorSpace::BT601) {
+    IOSurfaceSetValue(surfaceRef.get(), CFSTR("IOSurfaceYCbCrMatrix"),
+                      CFSTR("ITU_R_601_4"));
+  } else {
+    IOSurfaceSetValue(surfaceRef.get(), CFSTR("IOSurfaceYCbCrMatrix"),
+                      CFSTR("ITU_R_709_2"));
+  }
+  // Override the color space to be the same as the main display, so that
+  // CoreAnimation won't try to do any color correction (from the IOSurface
+  // space, to the display). In the future we may want to try specifying this
+  // correctly, but probably only once we do the same for videos drawn through
+  // our gfx code.
+  auto colorSpace = CFTypeRefPtr<CGColorSpaceRef>::WrapUnderCreateRule(
+      CGDisplayCopyColorSpace(CGMainDisplayID()));
+  auto colorData = CFTypeRefPtr<CFDataRef>::WrapUnderCreateRule(
+      CGColorSpaceCopyICCProfile(colorSpace.get()));
+  IOSurfaceSetValue(surfaceRef.get(), CFSTR("IOSurfaceColorSpace"),
+                    colorData.get());
+
+  RefPtr<MacIOSurface> ioSurface =
+      new MacIOSurface(std::move(surfaceRef), 1.0, false, aColorSpace);
+
+  return ioSurface.forget();
+}
+
 /* static */
 already_AddRefed<MacIOSurface> MacIOSurface::LookupSurface(
     IOSurfaceID aIOSurfaceID, double aContentsScaleFactor, bool aHasAlpha,
@@ -329,6 +394,8 @@ SurfaceFormat MacIOSurface::GetFormat() const {
     case kCVPixelFormatType_420YpCbCr8BiPlanarFullRange:
       return SurfaceFormat::NV12;
     case kCVPixelFormatType_422YpCbCr8:
+    case kCVPixelFormatType_422YpCbCr8_yuvs:
+    case kCVPixelFormatType_422YpCbCr8FullRange:
       return SurfaceFormat::YUV422;
     case kCVPixelFormatType_32BGRA:
       return HasAlpha() ? SurfaceFormat::B8G8R8A8 : SurfaceFormat::B8G8R8X8;
@@ -383,7 +450,9 @@ CGLError MacIOSurface::CGLTexImageIOSurface2D(
     if (aOutReadFormat) {
       *aOutReadFormat = mozilla::gfx::SurfaceFormat::NV12;
     }
-  } else if (pixelFormat == kCVPixelFormatType_422YpCbCr8) {
+  } else if (pixelFormat == kCVPixelFormatType_422YpCbCr8 ||
+             pixelFormat == kCVPixelFormatType_422YpCbCr8_yuvs ||
+             pixelFormat == kCVPixelFormatType_422YpCbCr8FullRange) {
     MOZ_ASSERT(plane == 0);
     // The YCBCR_422_APPLE ext is only available in compatibility profile. So,
     // we should use RGB_422_APPLE for core profile. The difference between
@@ -406,7 +475,11 @@ CGLError MacIOSurface::CGLTexImageIOSurface2D(
       }
     }
     internalFormat = LOCAL_GL_RGB;
-    type = LOCAL_GL_UNSIGNED_SHORT_8_8_APPLE;
+    if (pixelFormat == kCVPixelFormatType_422YpCbCr8) {
+      type = LOCAL_GL_UNSIGNED_SHORT_8_8_APPLE;
+    } else {
+      type = LOCAL_GL_UNSIGNED_SHORT_8_8_REV_APPLE;
+    }
   } else {
     MOZ_ASSERT(plane == 0);
 

gfx/2d/MacIOSurface.h

@@ -62,6 +62,8 @@ class MacIOSurface final
   static already_AddRefed<MacIOSurface> CreateNV12Surface(
       const IntSize& aYSize, const IntSize& aCbCrSize,
       YUVColorSpace aColorSpace, ColorRange aColorRange);
+  static already_AddRefed<MacIOSurface> CreateYUV422Surface(
+      const IntSize& aSize, YUVColorSpace aColorSpace, ColorRange aColorRange);
   static void ReleaseIOSurface(MacIOSurface* aIOSurface);
   static already_AddRefed<MacIOSurface> LookupSurface(
       IOSurfaceID aSurfaceID, double aContentsScaleFactor = 1.0,

gfx/layers/MacIOSurfaceImage.cpp

@@ -51,6 +51,16 @@ bool MacIOSurfaceImage::SetData(ImageContainer* aContainer,
     return false;
   }
 
+  if (aData.mCbCrSize.width * 2 != aData.mYSize.width) {
+    return false;
+  }
+
+  // We can only support 4:2:2 and 4:2:0 formats currently.
+  if (aData.mCbCrSize.height != aData.mYSize.height &&
+      aData.mCbCrSize.height * 2 != aData.mYSize.height) {
+    return false;
+  }
+
   RefPtr<MacIOSurfaceRecycleAllocator> allocator =
       aContainer->GetMacIOSurfaceRecycleAllocator();
 
@@ -59,30 +69,44 @@ bool MacIOSurfaceImage::SetData(ImageContainer* aContainer,
 
   surf->Lock(false);
 
+  // If the CbCrSize's height is half of the YSize's height, then we'll
+  // need to duplicate the CbCr data on every second row.
+  size_t heightScale = aData.mYSize.height / aData.mCbCrSize.height;
+
+  MOZ_ASSERT(surf->GetFormat() == SurfaceFormat::YUV422);
+
+  // The underlying IOSurface has format kCVPixelFormatType_422YpCbCr8FullRange
+  // or kCVPixelFormatType_422YpCbCr8_yuvs, which uses a 4:2:2 Y`0 Cb Y` Cr
+  // layout. See CVPixelBuffer.h for the full list of format descriptions.
   MOZ_ASSERT(aData.mYSize.height > 0);
   uint8_t* dst = (uint8_t*)surf->GetBaseAddressOfPlane(0);
   size_t stride = surf->GetBytesPerRow(0);
   for (size_t i = 0; i < (size_t)aData.mYSize.height; i++) {
-    uint8_t* rowSrc = aData.mYChannel + aData.mYStride * i;
-    uint8_t* rowDst = dst + stride * i;
-    memcpy(rowDst, rowSrc, aData.mYSize.width);
-  }
-
-  // CoreAnimation doesn't appear to support planar YCbCr formats, so we
-  // allocated an NV12 surface and now we need to copy and interleave the Cb and
-  // Cr channels.
-  MOZ_ASSERT(aData.mCbCrSize.height > 0);
-  dst = (uint8_t*)surf->GetBaseAddressOfPlane(1);
-  stride = surf->GetBytesPerRow(1);
-  for (size_t i = 0; i < (size_t)aData.mCbCrSize.height; i++) {
-    uint8_t* rowCbSrc = aData.mCbChannel + aData.mCbCrStride * i;
-    uint8_t* rowCrSrc = aData.mCrChannel + aData.mCbCrStride * i;
+    // Compute the row addresses. If the input was 4:2:0, then
+    // we divide i by 2, so that each source row of CbCr maps to
+    // two dest rows.
+    uint8_t* rowYSrc = aData.mYChannel + aData.mYStride * i;
+    uint8_t* rowCbSrc =
+        aData.mCbChannel + aData.mCbCrStride * (i / heightScale);
+    uint8_t* rowCrSrc =
+        aData.mCrChannel + aData.mCbCrStride * (i / heightScale);
     uint8_t* rowDst = dst + stride * i;
 
+    // Iterate across the CbCr width (which we have guaranteed to be half of
+    // the surface width), and write two 16bit pixels each time.
     for (size_t j = 0; j < (size_t)aData.mCbCrSize.width; j++) {
+      *rowDst = *rowYSrc;
+      rowDst++;
+      rowYSrc++;
+
       *rowDst = *rowCbSrc;
       rowDst++;
       rowCbSrc++;
+
+      *rowDst = *rowYSrc;
+      rowDst++;
+      rowYSrc++;
+
       *rowDst = *rowCrSrc;
       rowDst++;
       rowCrSrc++;
@@ -101,15 +125,10 @@ already_AddRefed<MacIOSurface> MacIOSurfaceRecycleAllocator::Allocate(
   nsTArray<CFTypeRefPtr<IOSurfaceRef>> surfaces = std::move(mSurfaces);
   RefPtr<MacIOSurface> result;
   for (auto& surf : surfaces) {
-    MOZ_ASSERT(::IOSurfaceGetPlaneCount(surf.get()) == 2);
-
     // If the surface size has changed, then discard any surfaces of the old
     // size.
     if (::IOSurfaceGetWidthOfPlane(surf.get(), 0) != (size_t)aYSize.width ||
-        ::IOSurfaceGetHeightOfPlane(surf.get(), 0) != (size_t)aYSize.height ||
-        ::IOSurfaceGetWidthOfPlane(surf.get(), 1) != (size_t)aCbCrSize.width ||
-        ::IOSurfaceGetHeightOfPlane(surf.get(), 1) !=
-            (size_t)aCbCrSize.height) {
+        ::IOSurfaceGetHeightOfPlane(surf.get(), 0) != (size_t)aYSize.height) {
       continue;
     }
 
@@ -123,8 +142,8 @@ already_AddRefed<MacIOSurface> MacIOSurfaceRecycleAllocator::Allocate(
   }
 
   if (!result) {
-    result = MacIOSurface::CreateNV12Surface(aYSize, aCbCrSize, aYUVColorSpace,
-                                             aColorRange);
+    result =
+        MacIOSurface::CreateYUV422Surface(aYSize, aYUVColorSpace, aColorRange);
 
     if (mSurfaces.Length() <
         StaticPrefs::layers_iosurfaceimage_recycle_limit()) {