Blame gst-libs/gst/gl/cocoa/gstglcontext_cocoa.m

Packit 971217
/*
Packit 971217
 * GStreamer
Packit 971217
 * Copyright (C) 2012 Matthew Waters <ystreet00@gmail.com>
Packit 971217
 *
Packit 971217
 * This library is free software; you can redistribute it and/or
Packit 971217
 * modify it under the terms of the GNU Library General Public
Packit 971217
 * License as published by the Free Software Foundation; either
Packit 971217
 * version 2 of the License, or (at your option) any later version.
Packit 971217
 *
Packit 971217
 * This library is distributed in the hope that it will be useful,
Packit 971217
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 971217
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 971217
 * Library General Public License for more details.
Packit 971217
 *
Packit 971217
 * You should have received a copy of the GNU Library General Public
Packit 971217
 * License along with this library; if not, write to the
Packit 971217
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
Packit 971217
 * Boston, MA 02110-1301, USA.
Packit 971217
 */
Packit 971217
Packit 971217
#ifdef HAVE_CONFIG_H
Packit 971217
#include "config.h"
Packit 971217
#endif
Packit 971217
Packit 971217
#include <Cocoa/Cocoa.h>
Packit 971217
Packit 971217
#include "gstglcontext_cocoa.h"
Packit 971217
#include "gstgl_cocoa_private.h"
Packit 971217
Packit 971217
static gboolean gst_gl_context_cocoa_create_context (GstGLContext *context, GstGLAPI gl_api,
Packit 971217
    GstGLContext * other_context, GError **error);
Packit 971217
static void gst_gl_context_cocoa_destroy_context (GstGLContext *context);
Packit 971217
static guintptr gst_gl_context_cocoa_get_gl_context (GstGLContext * window);
Packit 971217
static gboolean gst_gl_context_cocoa_activate (GstGLContext * context, gboolean activate);
Packit 971217
static GstGLAPI gst_gl_context_cocoa_get_gl_api (GstGLContext * context);
Packit 971217
static GstGLPlatform gst_gl_context_cocoa_get_gl_platform (GstGLContext * context);
Packit 971217
static void gst_gl_context_cocoa_swap_buffers (GstGLContext * context);
Packit 971217
Packit 971217
#define GST_GL_CONTEXT_COCOA_GET_PRIVATE(o)  \
Packit 971217
  (G_TYPE_INSTANCE_GET_PRIVATE((o), GST_TYPE_GL_CONTEXT_COCOA, GstGLContextCocoaPrivate))
Packit 971217
Packit 971217
GST_DEBUG_CATEGORY_STATIC (gst_gl_context_cocoa_debug);
Packit 971217
#define GST_CAT_DEFAULT gst_gl_context_cocoa_debug
Packit 971217
Packit 971217
G_DEFINE_TYPE_WITH_CODE (GstGLContextCocoa, gst_gl_context_cocoa,
Packit 971217
    GST_TYPE_GL_CONTEXT, GST_DEBUG_CATEGORY_INIT (gst_gl_context_cocoa_debug, "glcontext_cocoa", 0, "Cocoa GL Context"); );
Packit 971217
Packit 971217
static void
Packit 971217
gst_gl_context_cocoa_class_init (GstGLContextCocoaClass * klass)
Packit 971217
{
Packit 971217
  GstGLContextClass *context_class = (GstGLContextClass *) klass;
Packit 971217
Packit 971217
  g_type_class_add_private (klass, sizeof (GstGLContextCocoaPrivate));
Packit 971217
Packit 971217
  context_class->swap_buffers =
Packit 971217
    GST_DEBUG_FUNCPTR (gst_gl_context_cocoa_swap_buffers);
Packit 971217
  context_class->destroy_context =
Packit 971217
      GST_DEBUG_FUNCPTR (gst_gl_context_cocoa_destroy_context);
Packit 971217
  context_class->create_context =
Packit 971217
      GST_DEBUG_FUNCPTR (gst_gl_context_cocoa_create_context);
Packit 971217
  context_class->get_gl_context =
Packit 971217
      GST_DEBUG_FUNCPTR (gst_gl_context_cocoa_get_gl_context);
Packit 971217
  context_class->activate = GST_DEBUG_FUNCPTR (gst_gl_context_cocoa_activate);
Packit 971217
  context_class->get_gl_api =
Packit 971217
      GST_DEBUG_FUNCPTR (gst_gl_context_cocoa_get_gl_api);
Packit 971217
  context_class->get_gl_platform =
Packit 971217
      GST_DEBUG_FUNCPTR (gst_gl_context_cocoa_get_gl_platform);
Packit 971217
}
Packit 971217
Packit 971217
static void
Packit 971217
gst_gl_context_cocoa_init (GstGLContextCocoa * context)
Packit 971217
{
Packit 971217
  context->priv = GST_GL_CONTEXT_COCOA_GET_PRIVATE (context);
Packit 971217
}
Packit 971217
Packit 971217
/* Must be called in the gl thread */
Packit 971217
GstGLContextCocoa *
Packit 971217
gst_gl_context_cocoa_new (GstGLDisplay * display)
Packit 971217
{
Packit 971217
  GstGLContextCocoa *context;
Packit 971217
Packit 971217
  if ((gst_gl_display_get_handle_type (display) & GST_GL_DISPLAY_TYPE_COCOA) == 0)
Packit 971217
    /* we require an cocoa display to create CGL contexts */
Packit 971217
    return NULL;
Packit 971217
Packit 971217
  context = g_object_new (GST_TYPE_GL_CONTEXT_COCOA, NULL);
Packit 971217
  gst_object_ref_sink (context);
Packit 971217
Packit 971217
  return context;
Packit 971217
}
Packit 971217
Packit 971217
struct pixel_attr
Packit 971217
{
Packit 971217
  CGLPixelFormatAttribute attr;
Packit 971217
  const gchar *attr_name;
Packit 971217
};
Packit 971217
Packit 971217
static struct pixel_attr pixel_attrs[] = {
Packit 971217
  {kCGLPFAAllRenderers, "All Renderers"},
Packit 971217
  {kCGLPFADoubleBuffer, "Double Buffered"},
Packit 971217
  {kCGLPFAAuxBuffers, "Aux Buffers"},
Packit 971217
  {kCGLPFAColorSize, "Color Size"},
Packit 971217
  {kCGLPFAAlphaSize, "Alpha Size"},
Packit 971217
  {kCGLPFADepthSize, "Depth Size"},
Packit 971217
  {kCGLPFAStencilSize, "Stencil Size"},
Packit 971217
  {kCGLPFAAccumSize, "Accum Size"},
Packit 971217
  {kCGLPFAMinimumPolicy, "Minimum Policy"},
Packit 971217
  {kCGLPFAMaximumPolicy, "Maximum Policy"},
Packit 971217
  {kCGLPFASampleBuffers, "Sample Buffers"},
Packit 971217
  {kCGLPFASamples, "Samples"},
Packit 971217
  {kCGLPFAAuxDepthStencil, "Aux Depth Stencil"},
Packit 971217
  {kCGLPFAColorFloat, "Color Float"},
Packit 971217
  {kCGLPFAMultisample, "Multisample"},
Packit 971217
  {kCGLPFASupersample, "Supersample"},
Packit 971217
  {kCGLPFARendererID, "Renderer ID"},
Packit 971217
  {kCGLPFANoRecovery, "No Recovery"},
Packit 971217
  {kCGLPFAAccelerated, "Accelerated"},
Packit 971217
  {kCGLPFAClosestPolicy, "Closest Policy"},
Packit 971217
  {kCGLPFABackingStore, "Backing Store"},
Packit 971217
  {kCGLPFADisplayMask, "Display Mask"},
Packit 971217
  {kCGLPFAAllowOfflineRenderers, "Allow Offline Renderers"},
Packit 971217
  {kCGLPFAAcceleratedCompute, "Accelerated Compute"},
Packit 971217
  {kCGLPFAOpenGLProfile, "OpenGL Profile"},
Packit 971217
  {kCGLPFAVirtualScreenCount, "Virtual Screen Count"},
Packit 971217
#if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_11
Packit 971217
  {kCGLPFAStereo, "Stereo"},
Packit 971217
#endif
Packit 971217
#if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_9
Packit 971217
  {kCGLPFACompliant, "Compliant"},
Packit 971217
  {kCGLPFARemotePBuffer, "Remote PBuffer"},
Packit 971217
  {kCGLPFASingleRenderer, "Single Renderer"},
Packit 971217
  {kCGLPFAWindow, "Window"},
Packit 971217
#endif
Packit 971217
#if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_7
Packit 971217
//  {kCGLPFAOffScreen, "Off Screen"},
Packit 971217
//  {kCGLPFAPBuffer, "PBuffer"},
Packit 971217
#endif
Packit 971217
#if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
Packit 971217
//  {kCGLPFAFullScreen, "Full Screen"},
Packit 971217
#endif
Packit 971217
#if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
Packit 971217
//  {kCGLPFAMPSafe, "MP Safe"},
Packit 971217
//  {kCGLPFAMultiScreen, "Multi Screen"},
Packit 971217
//  {kCGLPFARobust, "Robust"},
Packit 971217
#endif
Packit 971217
};
Packit 971217
Packit 971217
void
Packit 971217
gst_gl_context_cocoa_dump_pixel_format (CGLPixelFormatObj fmt)
Packit 971217
{
Packit 971217
  int i;
Packit 971217
Packit 971217
  for (i = 0; i < G_N_ELEMENTS (pixel_attrs); i++) {
Packit 971217
    gint val;
Packit 971217
    CGLError ret = CGLDescribePixelFormat (fmt, 0, pixel_attrs[i].attr, &val;;
Packit 971217
Packit 971217
    if (ret != kCGLNoError) {
Packit 971217
      GST_WARNING ("failed to get pixel format %p attribute %s", fmt, pixel_attrs[i].attr_name);
Packit 971217
    } else {
Packit 971217
      GST_DEBUG ("Pixel format %p attr %s = %i", fmt, pixel_attrs[i].attr_name,
Packit 971217
          val);
Packit 971217
    }
Packit 971217
  }
Packit 971217
}
Packit 971217
Packit 971217
CGLPixelFormatObj
Packit 971217
gst_gl_context_cocoa_get_pixel_format (GstGLContextCocoa *context)
Packit 971217
{
Packit 971217
  return context->priv->pixel_format;
Packit 971217
}
Packit 971217
Packit 971217
static gboolean
Packit 971217
gst_gl_context_cocoa_create_context (GstGLContext *context, GstGLAPI gl_api,
Packit 971217
    GstGLContext *other_context, GError **error)
Packit 971217
{
Packit 971217
  GstGLContextCocoa *context_cocoa = GST_GL_CONTEXT_COCOA (context);
Packit 971217
  GstGLContextCocoaPrivate *priv = context_cocoa->priv;
Packit 971217
  GstGLWindow *window = gst_gl_context_get_window (context);
Packit 971217
  GstGLWindowCocoa *window_cocoa = GST_GL_WINDOW_COCOA (window);
Packit 971217
  GstGLAPI context_api = GST_GL_API_NONE;
Packit 971217
  const GLint swapInterval = 1;
Packit 971217
  CGLPixelFormatObj fmt = NULL;
Packit 971217
  CGLContextObj glContext;
Packit 971217
  CGLPixelFormatAttribute attribs[] = {
Packit 971217
    kCGLPFADoubleBuffer,
Packit 971217
    kCGLPFAAccumSize, 32,
Packit 971217
    0
Packit 971217
  };
Packit 971217
  CGLError ret;
Packit 971217
  gint pix_fmt_i = 0;
Packit 971217
  gint npix;
Packit 971217
Packit 971217
  if ((gl_api & (GST_GL_API_OPENGL | GST_GL_API_OPENGL3)) == GST_GL_API_NONE) {
Packit 971217
    g_set_error (error, GST_GL_CONTEXT_ERROR,
Packit 971217
        GST_GL_CONTEXT_ERROR_CREATE_CONTEXT,
Packit 971217
        "The CGL backend only supports GL and GL3");
Packit 971217
    goto error;
Packit 971217
  }
Packit 971217
Packit 971217
  priv->gl_context = nil;
Packit 971217
  if (other_context)
Packit 971217
    priv->external_gl_context = (CGLContextObj) gst_gl_context_get_gl_context (other_context);
Packit 971217
  else
Packit 971217
    priv->external_gl_context = NULL;
Packit 971217
Packit 971217
  if (priv->external_gl_context) {
Packit 971217
    gint profile;
Packit 971217
Packit 971217
    fmt = CGLGetPixelFormat (priv->external_gl_context);
Packit 971217
Packit 971217
#if MAC_OS_X_VERSION_MIN_REQUIRED >= 1070
Packit 971217
    /* core profile is only available in >= 10.7 */
Packit 971217
    if (kCGLNoError == CGLDescribePixelFormat (fmt, 0, kCGLPFAOpenGLProfile,
Packit 971217
          &profile)) {
Packit 971217
      if (profile == kCGLOGLPVersion_3_2_Core) {
Packit 971217
        context_api = GST_GL_API_OPENGL3;
Packit 971217
      } else {
Packit 971217
        context_api =GST_GL_API_OPENGL;
Packit 971217
      }
Packit 971217
    }
Packit 971217
#else
Packit 971217
    context_api = GST_GL_API_OPENGL;
Packit 971217
#endif
Packit 971217
  }
Packit 971217
Packit 971217
  if (!fmt) {
Packit 971217
#if MAC_OS_X_VERSION_MIN_REQUIRED >= 1070
Packit 971217
    if (gl_api & GST_GL_API_OPENGL3) {
Packit 971217
      attribs[pix_fmt_i++] = kCGLPFAOpenGLProfile;
Packit 971217
      attribs[pix_fmt_i++] = (int) kCGLOGLPVersion_3_2_Core;
Packit 971217
      context_api = GST_GL_API_OPENGL3;
Packit 971217
    } else {
Packit 971217
      context_api = GST_GL_API_OPENGL;
Packit 971217
    }
Packit 971217
#else
Packit 971217
    context_api = GST_GL_API_OPENGL;
Packit 971217
#endif
Packit 971217
Packit 971217
    attribs[pix_fmt_i++] = 0;
Packit 971217
Packit 971217
    ret = CGLChoosePixelFormat (attribs, &fmt, &npix);
Packit 971217
    if (ret != kCGLNoError) {
Packit 971217
      g_set_error (error, GST_GL_CONTEXT_ERROR,
Packit 971217
          GST_GL_CONTEXT_ERROR_WRONG_CONFIG, "cannot choose a pixel format: %s", CGLErrorString (ret));
Packit 971217
      goto error;
Packit 971217
    }
Packit 971217
  }
Packit 971217
Packit 971217
  gst_gl_context_cocoa_dump_pixel_format (fmt);
Packit 971217
Packit 971217
  ret = CGLCreateContext (fmt, priv->external_gl_context, &glContext);
Packit 971217
  if (ret != kCGLNoError) {
Packit 971217
    g_set_error (error, GST_GL_CONTEXT_ERROR, GST_GL_CONTEXT_ERROR_CREATE_CONTEXT,
Packit 971217
        "failed to create context: %s", CGLErrorString (ret));
Packit 971217
    goto error;
Packit 971217
  }
Packit 971217
Packit 971217
  context_cocoa->priv->pixel_format = fmt;
Packit 971217
  context_cocoa->priv->gl_context = glContext;
Packit 971217
Packit 971217
  _invoke_on_main ((GstGLWindowCB) gst_gl_window_cocoa_create_window,
Packit 971217
      gst_object_ref (window_cocoa), (GDestroyNotify) gst_object_unref);
Packit 971217
Packit 971217
  if (!context_cocoa->priv->gl_context) {
Packit 971217
    goto error;
Packit 971217
  }
Packit 971217
Packit 971217
  GST_INFO_OBJECT (context, "GL context created: %p", context_cocoa->priv->gl_context);
Packit 971217
Packit 971217
  CGLSetCurrentContext (context_cocoa->priv->gl_context);
Packit 971217
Packit 971217
  /* Back and front buffers are swapped only during the vertical retrace of the monitor.
Packit 971217
   * Discarded if you configured your driver to Never-use-V-Sync.
Packit 971217
   */
Packit 971217
  CGLSetParameter (context_cocoa->priv->gl_context, kCGLCPSwapInterval, &swapInterval);
Packit 971217
Packit 971217
  context_cocoa->priv->context_api = context_api;
Packit 971217
Packit 971217
  if (window)
Packit 971217
    gst_object_unref (window);
Packit 971217
Packit 971217
  return TRUE;
Packit 971217
Packit 971217
error:
Packit 971217
  {
Packit 971217
    if (window)
Packit 971217
      gst_object_unref (window);
Packit 971217
    return FALSE;
Packit 971217
  }
Packit 971217
}
Packit 971217
Packit 971217
static void
Packit 971217
gst_gl_context_cocoa_swap_buffers (GstGLContext * context)
Packit 971217
{
Packit 971217
}
Packit 971217
Packit 971217
static void
Packit 971217
gst_gl_context_cocoa_destroy_context (GstGLContext *context)
Packit 971217
{
Packit 971217
  /* FIXME: Need to release context and other things? */
Packit 971217
}
Packit 971217
Packit 971217
static guintptr
Packit 971217
gst_gl_context_cocoa_get_gl_context (GstGLContext * context)
Packit 971217
{
Packit 971217
  return (guintptr) GST_GL_CONTEXT_COCOA (context)->priv->gl_context;
Packit 971217
}
Packit 971217
Packit 971217
static gboolean
Packit 971217
gst_gl_context_cocoa_activate (GstGLContext * context, gboolean activate)
Packit 971217
{
Packit 971217
  GstGLContextCocoa *context_cocoa = GST_GL_CONTEXT_COCOA (context);
Packit 971217
  gpointer context_handle = activate ? context_cocoa->priv->gl_context : NULL;
Packit 971217
Packit 971217
  return kCGLNoError == CGLSetCurrentContext (context_handle);
Packit 971217
}
Packit 971217
Packit 971217
static GstGLAPI
Packit 971217
gst_gl_context_cocoa_get_gl_api (GstGLContext * context)
Packit 971217
{
Packit 971217
  GstGLContextCocoa *context_cocoa = GST_GL_CONTEXT_COCOA (context);
Packit 971217
Packit 971217
  if (context_cocoa->priv->gl_context)
Packit 971217
    return context_cocoa->priv->context_api;
Packit 971217
Packit 971217
  return GST_GL_API_OPENGL | GST_GL_API_OPENGL3;
Packit 971217
}
Packit 971217
Packit 971217
static GstGLPlatform
Packit 971217
gst_gl_context_cocoa_get_gl_platform (GstGLContext * context)
Packit 971217
{
Packit 971217
  return GST_GL_PLATFORM_CGL;
Packit 971217
}
Packit 971217
Packit 971217
guintptr
Packit 971217
gst_gl_context_cocoa_get_current_context (void)
Packit 971217
{
Packit 971217
  return (guintptr) CGLGetCurrentContext ();
Packit 971217
}