Merge branch 'xa_branch'
[mesa.git] / src / egl / main / eglmode.c
index 201ddb17f71a0c51682f3ba983456dbabbd9769b..617d4c2d60aca6a6aff2d968410ffdd1a9f61ba5 100644 (file)
+/**************************************************************************
+ *
+ * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
+ * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
+ * Copyright 2010 LunarG, Inc.
+ * All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sub license, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the
+ * next paragraph) shall be included in all copies or substantial portions
+ * of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ *
+ **************************************************************************/
+
+
+#include <assert.h>
+#include <stdlib.h>
+#include <string.h>
+
 #include "egldisplay.h"
-#include "egldriver.h"
 #include "eglmode.h"
-#include "eglglobals.h"
+#include "eglcurrent.h"
 #include "eglscreen.h"
 
 
+#ifdef EGL_MESA_screen_surface
+
+
 #define MIN2(A, B)  (((A) < (B)) ? (A) : (B))
 
 
+/**
+ * Given an EGLModeMESA handle, return the corresponding _EGLMode object
+ * or null if non-existant.
+ */
 _EGLMode *
-_eglLookupMode(EGLDisplay dpy, EGLModeMESA mode)
+_eglLookupMode(EGLModeMESA mode, _EGLDisplay *disp)
 {
-   const _EGLDisplay *disp = _eglLookupDisplay(dpy);
    EGLint scrnum;
 
-   for (scrnum = 0; scrnum < disp->NumScreens; scrnum++) {
-      const _EGLScreen *scrn = disp->Screens + scrnum;
-      EGLint i;
-      for (i = 0; i < scrn->NumModes; i++) {
-         if (scrn->Modes[i].Handle == mode) {
-            return scrn->Modes + i;
-         }
+   if (!disp || !disp->Screens)
+      return NULL;
+
+   /* loop over all screens on the display */
+   for (scrnum = 0; scrnum < disp->Screens->Size; scrnum++) {
+      const _EGLScreen *scrn = disp->Screens->Elements[scrnum];
+      EGLint idx;
+
+      /*
+       * the mode ids of a screen ranges from scrn->Handle to scrn->Handle +
+       * scrn->NumModes
+       */
+      if (mode >= scrn->Handle &&
+          mode < scrn->Handle + _EGL_SCREEN_MAX_MODES) {
+         idx = mode - scrn->Handle;
+
+         assert(idx < scrn->NumModes && scrn->Modes[idx].Handle == mode);
+
+         return &scrn->Modes[idx];
       }
    }
+
    return NULL;
 }
 
 
 /**
- * Search for the EGLMode that best matches the given attribute list.
+ * Parse the attrib_list to fill in the fields of the given _eglMode
+ * Return EGL_FALSE if any errors, EGL_TRUE otherwise.
  */
-EGLBoolean
-_eglChooseModeMESA(_EGLDriver *drv, EGLDisplay dpy, EGLint screen_number,
-                   const EGLint *attrib_list, EGLModeMESA *modes,
-                   EGLint modes_size, EGLint *num_modes)
+static EGLBoolean
+_eglParseModeAttribs(_EGLMode *mode, const EGLint *attrib_list)
 {
    EGLint i;
 
-   /* XXX incomplete */
+   /* init all attribs to EGL_DONT_CARE */
+   mode->Handle = EGL_DONT_CARE;
+   mode->Width = EGL_DONT_CARE;
+   mode->Height = EGL_DONT_CARE;
+   mode->RefreshRate = EGL_DONT_CARE;
+   mode->Optimal = EGL_DONT_CARE;
+   mode->Interlaced = EGL_DONT_CARE;
+   mode->Name = NULL;
 
-   for (i = 0; attrib_list[i] != EGL_NONE; i++) {
+   for (i = 0; attrib_list && attrib_list[i] != EGL_NONE; i++) {
       switch (attrib_list[i]) {
+      case EGL_MODE_ID_MESA:
+         mode->Handle = attrib_list[++i];
+         if (mode->Handle <= 0) {
+            _eglError(EGL_BAD_PARAMETER, "eglChooseModeMESA(handle)");
+            return EGL_FALSE;
+         }
+         break;
       case EGL_WIDTH:
-         i++;
+         mode->Width = attrib_list[++i];
+         if (mode->Width <= 0) {
+            _eglError(EGL_BAD_PARAMETER, "eglChooseModeMESA(width)");
+            return EGL_FALSE;
+         }
          break;
       case EGL_HEIGHT:
-         i++;
+         mode->Height = attrib_list[++i];
+         if (mode->Height <= 0) {
+            _eglError(EGL_BAD_PARAMETER, "eglChooseModeMESA(height)");
+            return EGL_FALSE;
+         }
          break;
       case EGL_REFRESH_RATE_MESA:
-         i++;
+         mode->RefreshRate = attrib_list[++i];
+         if (mode->RefreshRate <= 0) {
+            _eglError(EGL_BAD_PARAMETER, "eglChooseModeMESA(refresh rate)");
+            return EGL_FALSE;
+         }
+         break;
+      case EGL_INTERLACED_MESA:
+         mode->Interlaced = attrib_list[++i];
+         if (mode->Interlaced != EGL_TRUE && mode->Interlaced != EGL_FALSE) {
+            _eglError(EGL_BAD_PARAMETER, "eglChooseModeMESA(interlaced)");
+            return EGL_FALSE;
+         }
          break;
-#if 0
-      case EGL_STEREO_MESA:
-         i++;
+      case EGL_OPTIMAL_MESA:
+         mode->Optimal = attrib_list[++i];
+         if (mode->Optimal != EGL_TRUE && mode->Optimal != EGL_FALSE) {
+            _eglError(EGL_BAD_PARAMETER, "eglChooseModeMESA(optimal)");
+            return EGL_FALSE;
+         }
          break;
-#endif
       default:
-         _eglError(EGL_BAD_ATTRIBUTE, "eglChooseMode");
+         _eglError(EGL_BAD_ATTRIBUTE, "eglChooseModeMESA");
          return EGL_FALSE;
       }
    }
+   return EGL_TRUE;
+}
+
+
+/**
+ * Determine if the candidate mode's attributes are at least as good
+ * as the minimal mode's.
+ * \return EGL_TRUE if qualifies, EGL_FALSE otherwise
+ */
+static EGLBoolean
+_eglModeQualifies(const _EGLMode *c, const _EGLMode *min)
+{
+   if (min->Handle != EGL_DONT_CARE && c->Handle != min->Handle)
+      return EGL_FALSE;
+   if (min->Width != EGL_DONT_CARE && c->Width < min->Width)
+      return EGL_FALSE;
+   if (min->Height != EGL_DONT_CARE && c->Height < min->Height)
+      return EGL_FALSE;
+   if (min->RefreshRate != EGL_DONT_CARE && c->RefreshRate < min->RefreshRate)
+      return EGL_FALSE;
+   if (min->Optimal != EGL_DONT_CARE && c->Optimal != min->Optimal)
+      return EGL_FALSE;
+   if (min->Interlaced != EGL_DONT_CARE && c->Interlaced != min->Interlaced)
+      return EGL_FALSE;
 
    return EGL_TRUE;
 }
 
 
+/**
+ * Return value of given mode attribute, or -1 if bad attrib.
+ */
+static EGLint
+getModeAttrib(const _EGLMode *m, EGLint attrib)
+{
+   switch (attrib) {
+   case EGL_MODE_ID_MESA:
+      return m->Handle;
+   case EGL_WIDTH:
+      return m->Width;
+   case EGL_HEIGHT:
+      return m->Height;
+   case EGL_REFRESH_RATE_MESA:
+      return m->RefreshRate;
+   case EGL_OPTIMAL_MESA:
+      return m->Optimal;
+   case EGL_INTERLACED_MESA:
+      return m->Interlaced;
+   default:
+      return -1;
+   }
+}
+
+
+#define SMALLER 1
+#define LARGER  2
+
+struct sort_info {
+   EGLint Attrib;
+   EGLint Order; /* SMALLER or LARGER */
+};
+
+/* the order of these entries is the priority */
+static struct sort_info SortInfo[] = {
+   { EGL_OPTIMAL_MESA, LARGER },
+   { EGL_INTERLACED_MESA, SMALLER },
+   { EGL_WIDTH, LARGER },
+   { EGL_HEIGHT, LARGER },
+   { EGL_REFRESH_RATE_MESA, LARGER },
+   { EGL_MODE_ID_MESA, SMALLER },
+   { 0, 0 }
+};
+
 
 /**
- * Return all possible modes for the given screen
+ * Compare modes 'a' and 'b' and return -1 if a belongs before b, or 1 if a
+ * belongs after b, or 0 if they're equal.
+ * Used by qsort().
  */
-EGLBoolean
-_eglGetModesMESA(_EGLDriver *drv, EGLDisplay dpy, EGLint screen_number,
-                 EGLModeMESA *modes, EGLint modes_size, EGLint *num_modes)
+static int
+_eglCompareModes(const void *a, const void *b)
 {
-   _EGLScreen *scrn = _eglLookupScreen(dpy, screen_number);
+   const _EGLMode *aMode = *((const _EGLMode **) a);
+   const _EGLMode *bMode = *((const _EGLMode **) b);
    EGLint i;
 
-   if (!scrn) {
-      _eglError(EGL_BAD_SCREEN_MESA, "eglGetModes");
+   for (i = 0; SortInfo[i].Attrib; i++) {
+      const EGLint aVal = getModeAttrib(aMode, SortInfo[i].Attrib);
+      const EGLint bVal = getModeAttrib(bMode, SortInfo[i].Attrib);
+      if (aVal == bVal) {
+         /* a tie */
+         continue;
+      }
+      else if (SortInfo[i].Order == SMALLER) {
+         return (aVal < bVal) ? -1 : 1;
+      }
+      else if (SortInfo[i].Order == LARGER) {
+         return (aVal > bVal) ? -1 : 1;
+      }
+   }
+
+   /* all attributes identical */
+   return 0;
+}
+
+
+/**
+ * Search for EGLModes which match the given attribute list.
+ * Called via eglChooseModeMESA API function.
+ */
+EGLBoolean
+_eglChooseModeMESA(_EGLDriver *drv, _EGLDisplay *dpy, _EGLScreen *scrn,
+                   const EGLint *attrib_list, EGLModeMESA *modes,
+                   EGLint modes_size, EGLint *num_modes)
+{
+   _EGLMode **modeList, min;
+   EGLint i, count;
+
+   if (!_eglParseModeAttribs(&min, attrib_list)) {
+      /* error code will have been recorded */
       return EGL_FALSE;
    }
 
-   *num_modes = MIN2(modes_size, scrn->NumModes);
-   for (i = 0; i < *num_modes; i++) {
-      modes[i] = scrn->Modes[i].Handle;
+   /* allocate array of mode pointers */
+   modeList = (_EGLMode **) malloc(modes_size * sizeof(_EGLMode *));
+   if (!modeList) {
+      _eglError(EGL_BAD_MODE_MESA, "eglChooseModeMESA(out of memory)");
+      return EGL_FALSE;
+   }
+
+   /* make array of pointers to qualifying modes */
+   for (i = count = 0; i < scrn->NumModes && count < modes_size; i++) {
+      if (_eglModeQualifies(scrn->Modes + i, &min)) {
+         modeList[count++] = scrn->Modes + i;
+      }
+   }
+
+   /* sort array of pointers */
+   qsort(modeList, count, sizeof(_EGLMode *), _eglCompareModes);
+
+   /* copy mode handles to output array */
+   for (i = 0; i < count; i++) {
+      modes[i] = modeList[i]->Handle;
+   }
+
+   free(modeList);
+
+   *num_modes = count;
+
+   return EGL_TRUE;
+}
+
+
+
+/**
+ * Return all possible modes for the given screen.  No sorting of results.
+ * Called via eglGetModesMESA() API function.
+ */
+EGLBoolean
+_eglGetModesMESA(_EGLDriver *drv, _EGLDisplay *dpy, _EGLScreen *scrn,
+                 EGLModeMESA *modes, EGLint modes_size, EGLint *num_modes)
+{
+   if (modes) {
+      EGLint i;
+      *num_modes = MIN2(scrn->NumModes, modes_size);
+      for (i = 0; i < *num_modes; i++) {
+         modes[i] = scrn->Modes[i].Handle;
+      }
+   }
+   else {
+      /* just return total number of supported modes */
+      *num_modes = scrn->NumModes;
    }
 
    return EGL_TRUE;
@@ -94,37 +328,30 @@ _eglGetModesMESA(_EGLDriver *drv, EGLDisplay dpy, EGLint screen_number,
  * Query an attribute of a mode.
  */
 EGLBoolean
-_eglGetModeAttribMESA(_EGLDriver *drv, EGLDisplay dpy,
-                      EGLModeMESA mode, EGLint attribute, EGLint *value)
+_eglGetModeAttribMESA(_EGLDriver *drv, _EGLDisplay *dpy,
+                      _EGLMode *m, EGLint attribute, EGLint *value)
 {
-   _EGLMode *m = _eglLookupMode(dpy, mode);
+   EGLint v;
 
-   switch (attribute) {
-   case EGL_MODE_ID_MESA:
-      *value = m->Handle;
-      break;
-   case EGL_WIDTH:
-      *value = m->Width;
-      break;
-   case EGL_HEIGHT:
-      *value = m->Height;
-      break;
-#if 0
-   case EGL_DEPTH_MESA:
-      *value = m->Depth;
-      break;
-#endif
-   case EGL_REFRESH_RATE_MESA:
-      *value = m->RefreshRate;
-      break;
-#if 0
-   case EGL_STEREO_MESA:
-      *value = m->Stereo;
-      break;
-#endif
-   default:
-      _eglError(EGL_BAD_ATTRIBUTE, "eglGetModeAttrib");
+   v = getModeAttrib(m, attribute);
+   if (v < 0) {
+      _eglError(EGL_BAD_ATTRIBUTE, "eglGetModeAttribMESA");
       return EGL_FALSE;
    }
+   *value = v;
    return EGL_TRUE;
 }
+
+
+/**
+ * Return human-readable string for given mode.
+ * This is the default function called by eglQueryModeStringMESA().
+ */
+const char *
+_eglQueryModeStringMESA(_EGLDriver *drv, _EGLDisplay *dpy, _EGLMode *m)
+{
+   return m->Name;
+}
+
+
+#endif /* EGL_MESA_screen_surface */