gstreamer/ext/vulkan/cocoa/vkwindow_cocoa.m

/*
 * GStreamer
 * Copyright (C) 2019 Matthew Waters <matthew@centricular.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <Cocoa/Cocoa.h>
#include <QuartzCore/QuartzCore.h>

#include <gst/gst.h>

#include "vkwindow_cocoa.h"
#include "vkdisplay_cocoa.h"

#include "vkcocoa_utils.h"

#define GST_VULKAN_WINDOW_COCOA_GET_PRIVATE(o)  \
  (G_TYPE_INSTANCE_GET_PRIVATE((o), GST_TYPE_VULKAN_WINDOW_COCOA, GstVulkanWindowCocoaPrivate))

#define GST_CAT_DEFAULT gst_vulkan_window_cocoa_debug
GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);

static void
_init_debug (void)
{
  static volatile gsize _init = 0;

  if (g_once_init_enter (&_init)) {
    GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "vulkanwindowmacos", 0,
        "Vulkan MacOS Window");
    g_once_init_leave (&_init, 1);
  }
}

gboolean gst_vulkan_window_cocoa_handle_event (GstVulkanWindowCocoa * window_cocoa);

enum
{
  PROP_0,
};

struct _GstVulkanWindowCocoaPrivate
{
  gpointer internal_win_id;
  gpointer internal_view;

  gint preferred_width;
  gint preferred_height;

  gboolean visible;
};

#define gst_vulkan_window_cocoa_parent_class parent_class
G_DEFINE_TYPE_WITH_CODE (GstVulkanWindowCocoa, gst_vulkan_window_cocoa,
    GST_TYPE_VULKAN_WINDOW, G_ADD_PRIVATE (GstVulkanWindowCocoa) _init_debug ());

static VkSurfaceKHR gst_vulkan_window_cocoa_get_surface (GstVulkanWindow * window,
    GError ** error);
static gboolean gst_vulkan_window_cocoa_get_presentation_support (GstVulkanWindow
    * window, GstVulkanDevice * device, guint32 queue_family_idx);
static gboolean gst_vulkan_window_cocoa_open (GstVulkanWindow * window,
    GError ** error);
static void gst_vulkan_window_cocoa_close (GstVulkanWindow * window);

static void
gst_vulkan_window_cocoa_finalize (GObject * object)
{
  G_OBJECT_CLASS (parent_class)->finalize (object);
}

static void
gst_vulkan_window_cocoa_class_init (GstVulkanWindowCocoaClass * klass)
{
  GObjectClass *obj_class = G_OBJECT_CLASS (klass);
  GstVulkanWindowClass *window_class = (GstVulkanWindowClass *) klass;

  obj_class->finalize = gst_vulkan_window_cocoa_finalize;

  window_class->open = GST_DEBUG_FUNCPTR (gst_vulkan_window_cocoa_open);
  window_class->close = GST_DEBUG_FUNCPTR (gst_vulkan_window_cocoa_close);
  window_class->get_surface = gst_vulkan_window_cocoa_get_surface;
  window_class->get_presentation_support =
      gst_vulkan_window_cocoa_get_presentation_support;
}

static void
gst_vulkan_window_cocoa_init (GstVulkanWindowCocoa * window)
{
  window->priv = gst_vulkan_window_cocoa_get_instance_private (window);

  window->priv->preferred_width = 320;
  window->priv->preferred_height = 240;
}

/* Must be called in the gl thread */
GstVulkanWindowCocoa *
gst_vulkan_window_cocoa_new (GstVulkanDisplay * display)
{
  GstVulkanWindowCocoa *window;

  _init_debug ();

  if ((gst_vulkan_display_get_handle_type (display) &
          GST_VULKAN_DISPLAY_TYPE_COCOA)
      == GST_VULKAN_DISPLAY_TYPE_NONE) {
    GST_INFO ("Wrong display type %u for this window type %u", display->type,
        GST_VULKAN_DISPLAY_TYPE_COCOA);
    return NULL;
  }

  window = g_object_new (GST_TYPE_VULKAN_WINDOW_COCOA, NULL);
  gst_object_ref_sink (window);

  return window;
}

static void
_show_window (gpointer data)
{
  GstVulkanWindowCocoa *window_cocoa = GST_VULKAN_WINDOW_COCOA (data);
  GstVulkanWindowCocoaPrivate *priv = window_cocoa->priv;
  GstVulkanNSWindow *internal_win_id = (__bridge GstVulkanNSWindow *)priv->internal_win_id;

  GST_DEBUG_OBJECT (window_cocoa, "showing");
  [internal_win_id makeMainWindow];
  [internal_win_id orderFrontRegardless];
  [internal_win_id setViewsNeedDisplay:YES];

  priv->visible = TRUE;
}

static void
gst_vulkan_window_cocoa_show (GstVulkanWindow * window)
{
  GstVulkanWindowCocoa *window_cocoa = GST_VULKAN_WINDOW_COCOA (window);
  GstVulkanWindowCocoaPrivate *priv = window_cocoa->priv;

  if (!priv->visible)
    _invoke_on_main ((GstVulkanWindowFunc) _show_window, gst_object_ref (window),
        (GDestroyNotify) gst_object_unref);
}

static void
gst_vulkan_window_cocoa_hide (GstVulkanWindow * window)
{
//  GstVulkanWindowCocoa *window_cocoa = GST_VULKAN_WINDOW_COCOA (window);

  /* FIXME: implement */
}

static void
_create_window (GstVulkanWindowCocoa * window_cocoa)
{
  GstVulkanWindowCocoaPrivate *priv = window_cocoa->priv;
  NSRect mainRect = [[NSScreen mainScreen] visibleFrame];
  gint h = priv->preferred_height;
  gint y = mainRect.size.height > h ? (mainRect.size.height - h) * 0.5 : 0;
  NSRect rect = NSMakeRect (0, y, priv->preferred_width, priv->preferred_height);
  GstVulkanNSWindow *internal_win_id;
  GstVulkanNSView *view;

  view = [[GstVulkanNSView alloc] initWithFrame:rect];
  view.wantsLayer = YES;

  internal_win_id = [[GstVulkanNSWindow alloc] initWithContentRect:rect styleMask:
      (NSWindowStyleMaskTitled | NSWindowStyleMaskClosable |
      NSWindowStyleMaskResizable | NSWindowStyleMaskMiniaturizable)
      backing: NSBackingStoreBuffered defer: NO screen: nil gstWin: window_cocoa];

  [internal_win_id setContentView:view];

  priv->internal_win_id = (__bridge_retained gpointer)internal_win_id;
  priv->internal_view = (__bridge_retained gpointer)view;

  gst_vulkan_window_cocoa_show (GST_VULKAN_WINDOW (window_cocoa));
}

gboolean
gst_vulkan_window_cocoa_create_window (GstVulkanWindowCocoa * window_cocoa)
{
  _invoke_on_main ((GstVulkanWindowFunc) _create_window,
      gst_object_ref (window_cocoa), gst_object_unref);

  g_usleep(1000000);

  return TRUE;
}

static VkSurfaceKHR
gst_vulkan_window_cocoa_get_surface (GstVulkanWindow * window, GError ** error)
{
  GstVulkanWindowCocoa *window_cocoa = GST_VULKAN_WINDOW_COCOA (window);
  VkMacOSSurfaceCreateInfoMVK info = { 0, };
  VkSurfaceKHR ret;
  VkResult err;

  info.sType = VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK;
  info.pNext = NULL;
  info.flags = 0;
  info.pView = window_cocoa->priv->internal_view;

  if (!window_cocoa->CreateMacOSSurface)
    window_cocoa->CreateMacOSSurface =
        gst_vulkan_instance_get_proc_address (window->display->instance,
        "vkCreateMacOSSurfaceMVK");
  if (!window_cocoa->CreateMacOSSurface) {
    g_set_error_literal (error, GST_VULKAN_ERROR, VK_ERROR_FEATURE_NOT_PRESENT,
        "Could not retrieve \"vkCreateMacOSSurfaceMVK\" function pointer");
    return NULL;
  }

  err =
      window_cocoa->CreateMacOSSurface (window->display->instance->instance, &info,
      NULL, &ret);
  if (gst_vulkan_error_to_g_error (err, error, "vkCreateMacOSSurfaceMVK") < 0)
    return NULL;

  return ret;
}

static gboolean
gst_vulkan_window_cocoa_get_presentation_support (GstVulkanWindow * window,
    GstVulkanDevice * device, guint32 queue_family_idx)
{
  return TRUE;
}

static gboolean
gst_vulkan_window_cocoa_open (GstVulkanWindow * window, GError ** error)
{
  GstVulkanWindowCocoa *window_cocoa = GST_VULKAN_WINDOW_COCOA (window);

  if (!GST_VULKAN_WINDOW_CLASS (parent_class)->open (window, error))
    return FALSE;

  return gst_vulkan_window_cocoa_create_window (window_cocoa);
}

static void
_close_window (gpointer * data)
{
  GstVulkanWindowCocoa *window_cocoa = GST_VULKAN_WINDOW_COCOA (data);
  GstVulkanWindow *window = GST_VULKAN_WINDOW (window_cocoa);
  GstVulkanNSWindow *internal_win_id =
      (__bridge GstVulkanNSWindow *) window_cocoa->priv->internal_win_id;

  gst_vulkan_window_cocoa_hide (window);

  [[internal_win_id contentView] removeFromSuperview];
  CFBridgingRelease (window_cocoa->priv->internal_win_id);
  window_cocoa->priv->internal_win_id = NULL;
  CFBridgingRelease (window_cocoa->priv->internal_view);
  window_cocoa->priv->internal_view = NULL;
}

static void
gst_vulkan_window_cocoa_close (GstVulkanWindow * window)
{
  _invoke_on_main ((GstVulkanWindowFunc) _close_window, gst_object_ref (window),
      (GDestroyNotify) gst_object_unref);

  GST_VULKAN_WINDOW_CLASS (parent_class)->close (window);
}

@implementation GstVulkanNSWindow

- (id) initWithContentRect: (NSRect) contentRect
        styleMask: (unsigned int) styleMask
    backing: (NSBackingStoreType) bufferingType
    defer: (BOOL) flag screen: (NSScreen *) aScreen
    gstWin: (GstVulkanWindowCocoa *) cocoa {

  m_isClosed = NO;
  window_cocoa = cocoa;

  self = [super initWithContentRect: contentRect
        styleMask: styleMask backing: bufferingType
        defer: flag screen:aScreen];

  GST_DEBUG ("initializing GstVulkanNSWindow");

  [self setReleasedWhenClosed:NO];
  [self setTitle:@"Vulkan renderer"];
  [self setBackgroundColor:[NSColor blackColor]];
  [self orderOut:self];

  return self;
}

- (void) setClosed {
  m_isClosed = YES;
}

- (BOOL) isClosed {
  return m_isClosed;
}

- (BOOL) canBecomeMainWindow {
  return YES;
}

- (BOOL) canBecomeKeyWindow {
  return YES;
}

- (BOOL) windowShouldClose:(id)sender {

  GstVulkanWindowCocoaPrivate *priv = window_cocoa->priv;
  GstVulkanNSWindow *internal_win_id = (__bridge GstVulkanNSWindow *)priv->internal_win_id;
  GST_DEBUG ("user clicked the close button\n");
  [internal_win_id setClosed];
  return YES;
}

@end


@implementation GstVulkanNSView

-(BOOL) wantsUpdateLayer
{
   return YES;
}

+(Class) layerClass
{
  return [CAMetalLayer class];
}

-(CALayer*) makeBackingLayer
{
  CALayer* layer = [self.class.layerClass layer];
  CGSize viewScale = [self convertSizeToBacking: CGSizeMake(1.0, 1.0)];
  layer.contentsScale = MIN(viewScale.width, viewScale.height);
  return layer;
}

@end

void
_invoke_on_main (GstVulkanWindowFunc func, gpointer data, GDestroyNotify notify)
{
  if ([NSThread isMainThread]) {
    func (data);
    if (notify)
      notify (data);
  } else {
    dispatch_async (dispatch_get_main_queue (), ^{
      func (data);
      if (notify)
        notify (data);
    });
  }
}