gfx/thebes/GLContextProviderOSMesa.cpp

   1 /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  * ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Initial Developer of the Original Code is Mozilla Foundation.
  16  * Portions created by the Initial Developer are Copyright (C) 2010
  17  * the Initial Developer. All Rights Reserved.
  18  *
  19  * Contributor(s):
  20  *   Benoit Jacob <bjacob@mozilla.com>
  21  *   Bas Schouten <bschouten@mozilla.com>
  22  *   Vladimir Vukicevic <vladimir@pobox.com>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "GLContextProvider.h"
  39 #include "GLContext.h"
  40 #include "nsDebug.h"
  41 #include "nsString.h"
  42 #include "nsIWidget.h"
  43 #include "nsDirectoryServiceUtils.h"
  44 #include "nsAppDirectoryServiceDefs.h"
  45 #include "nsIConsoleService.h"
  46 #include "nsIPrefService.h"
  47 #include "gfxASurface.h"
  48 #include "gfxImageSurface.h"
  49
  50 // from GL/osmesa.h. We don't include that file so as to avoid having a build-time dependency on OSMesa.
  51 #define OSMESA_RGBA     GL_RGBA
  52 #define OSMESA_BGRA     0x1
  53 #define OSMESA_ARGB     0x2
  54 #define OSMESA_RGB      GL_RGB
  55 #define OSMESA_BGR      0x4
  56 #define OSMESA_RGB_565  0x5
  57 #define OSMESA_Y_UP     0x11
  58
  59 namespace mozilla {
  60 namespace gl {
  61
  62 static void LogMessage(const char *msg)
  63 {
  64   nsCOMPtr<nsIConsoleService> console(do_GetService(NS_CONSOLESERVICE_CONTRACTID));
  65   if (console) {
  66     console->LogStringMessage(NS_ConvertUTF8toUTF16(nsDependentCString(msg)).get());
  67     fprintf(stderr, "%s\n", msg);
  68   }
  69 }
  70
  71 typedef void* PrivateOSMesaContext;
  72
  73 class OSMesaLibrary
  74 {
  75 public:
  76     OSMesaLibrary() : mInitialized(PR_FALSE), mOSMesaLibrary(nsnull) {}
  77
  78     typedef PrivateOSMesaContext (GLAPIENTRY * PFNOSMESACREATECONTEXTEXT) (GLenum, GLint, GLint, GLint, PrivateOSMesaContext);
  79     typedef void (GLAPIENTRY * PFNOSMESADESTROYCONTEXT) (PrivateOSMesaContext);
  80     typedef bool (GLAPIENTRY * PFNOSMESAMAKECURRENT) (PrivateOSMesaContext, void *, GLenum, GLsizei, GLsizei);
  81     typedef PrivateOSMesaContext (GLAPIENTRY * PFNOSMESAGETCURRENTCONTEXT) (void);
  82     typedef void (GLAPIENTRY * PFNOSMESAPIXELSTORE) (GLint, GLint);
  83     typedef PRFuncPtr (GLAPIENTRY * PFNOSMESAGETPROCADDRESS) (const char*);
  84
  85     PFNOSMESACREATECONTEXTEXT fCreateContextExt;
  86     PFNOSMESADESTROYCONTEXT fDestroyContext;
  87     PFNOSMESAMAKECURRENT fMakeCurrent;
  88     PFNOSMESAGETCURRENTCONTEXT fGetCurrentContext;
  89     PFNOSMESAPIXELSTORE fPixelStore;
  90     PFNOSMESAGETPROCADDRESS fGetProcAddress;
  91
  92     PRBool EnsureInitialized();
  93
  94 private:
  95     PRBool mInitialized;
  96     PRLibrary *mOSMesaLibrary;
  97 };
  98
  99 OSMesaLibrary sOSMesaLibrary;
 100
 101 PRBool
 102 OSMesaLibrary::EnsureInitialized()
 103 {
 104     if (mInitialized)
 105         return PR_TRUE;
 106
 107     nsresult rv;
 108
 109     nsCOMPtr<nsIPrefService> prefService = do_GetService(NS_PREFSERVICE_CONTRACTID, &rv);
 110     NS_ENSURE_SUCCESS(rv, PR_FALSE);
 111
 112     nsCOMPtr<nsIPrefBranch> prefBranch;
 113     rv = prefService->GetBranch("webgl.", getter_AddRefs(prefBranch));
 114     NS_ENSURE_SUCCESS(rv, PR_FALSE);
 115
 116     nsCString osmesalib;
 117
 118     rv = prefBranch->GetCharPref("osmesalib", getter_Copies(osmesalib));
 119
 120     if (NS_FAILED(rv) ||
 121         osmesalib.Length() == 0)
 122     {
 123         return PR_FALSE;
 124     }
 125
 126     mOSMesaLibrary = PR_LoadLibrary(osmesalib.get());
 127
 128     if (!mOSMesaLibrary) {
 129         LogMessage("Couldn't open OSMesa lib for software rendering -- webgl.osmesalib path is incorrect, or not a valid shared library");
 130         return PR_FALSE;
 131     }
 132
 133     LibrarySymbolLoader::SymLoadStruct symbols[] = {
 134         { (PRFuncPtr*) &fCreateContextExt, { "OSMesaCreateContextExt", NULL } },
 135         { (PRFuncPtr*) &fMakeCurrent, { "OSMesaMakeCurrent", NULL } },
 136         { (PRFuncPtr*) &fPixelStore, { "OSMesaPixelStore", NULL } },
 137         { (PRFuncPtr*) &fDestroyContext, { "OSMesaDestroyContext", NULL } },
 138         { (PRFuncPtr*) &fGetCurrentContext, { "OSMesaGetCurrentContext", NULL } },
 139         { (PRFuncPtr*) &fMakeCurrent, { "OSMesaMakeCurrent", NULL } },
 140         { (PRFuncPtr*) &fGetProcAddress, { "OSMesaGetProcAddress", NULL } },
 141         { NULL, { NULL } }
 142     };
 143
 144     if (!LibrarySymbolLoader::LoadSymbols(mOSMesaLibrary, &symbols[0])) {
 145         LogMessage("Couldn't find required entry points in OSMesa libary");
 146         return PR_FALSE;
 147     }
 148
 149     mInitialized = PR_TRUE;
 150     return PR_TRUE;
 151 }
 152
 153 class GLContextOSMesa : public GLContext
 154 {
 155 public:
 156     GLContextOSMesa(const ContextFormat& aFormat)
 157         : GLContext(aFormat, PR_TRUE, nsnull),
 158           mThebesSurface(nsnull),
 159           mContext(nsnull)
 160     {
 161     }
 162
 163     ~GLContextOSMesa()
 164     {
 165         if (mContext)
 166             sOSMesaLibrary.fDestroyContext(mContext);
 167     }
 168
 169     GLContextType GetContextType() {
 170         return ContextTypeOSMesa;
 171     }
 172
 173     PRBool Init(const gfxIntSize &aSize)
 174     {
 175         int osmesa_format = -1;
 176         int gfxasurface_imageformat = -1;
 177         PRBool format_accepted = PR_FALSE;
 178
 179         if (mCreationFormat.red > 0 &&
 180             mCreationFormat.green > 0 &&
 181             mCreationFormat.blue > 0 &&
 182             mCreationFormat.red <= 8 &&
 183             mCreationFormat.green <= 8 &&
 184             mCreationFormat.blue <= 8)
 185         {
 186             if (mCreationFormat.alpha == 0) {
 187                 // we can't use OSMESA_BGR because it is packed 24 bits per pixel.
 188                 // So we use OSMESA_BGRA and have to use ImageFormatRGB24
 189                 // to make sure that the dummy alpha channel is ignored.
 190                 osmesa_format = OSMESA_BGRA;
 191                 gfxasurface_imageformat = gfxASurface::ImageFormatRGB24;
 192                 format_accepted = PR_TRUE;
 193             } else if (mCreationFormat.alpha <= 8) {
 194                 osmesa_format = OSMESA_BGRA;
 195                 gfxasurface_imageformat = gfxASurface::ImageFormatARGB32;
 196                 format_accepted = PR_TRUE;
 197             }
 198         }
 199         if (!format_accepted) {
 200             NS_WARNING("Pixel format not supported with OSMesa.");
 201             return PR_FALSE;
 202         }
 203
 204         mThebesSurface = new gfxImageSurface(aSize, gfxASurface::gfxImageFormat(gfxasurface_imageformat));
 205         if (mThebesSurface->CairoStatus() != 0) {
 206             NS_WARNING("image surface failed");
 207             return PR_FALSE;
 208         }
 209
 210         mContext = sOSMesaLibrary.fCreateContextExt(osmesa_format, mCreationFormat.depth, mCreationFormat.stencil, 0, NULL);
 211         if (!mContext) {
 212             NS_WARNING("OSMesaCreateContextExt failed!");
 213             return PR_FALSE;
 214         }
 215
 216         if (!MakeCurrent()) return PR_FALSE;
 217         if (!SetupLookupFunction()) return PR_FALSE;
 218
 219         // OSMesa's different from the other GL providers, it renders to an image surface, not to a pbuffer
 220         sOSMesaLibrary.fPixelStore(OSMESA_Y_UP, 0);
 221
 222         return InitWithPrefix("gl", PR_TRUE);
 223     }
 224
 225     PRBool MakeCurrent()
 226     {
 227         PRBool succeeded
 228           = sOSMesaLibrary.fMakeCurrent(mContext, mThebesSurface->Data(),
 229                                         LOCAL_GL_UNSIGNED_BYTE,
 230                                         mThebesSurface->Width(),
 231                                         mThebesSurface->Height());
 232         NS_ASSERTION(succeeded, "Failed to make OSMesa context current!");
 233
 234         return succeeded;
 235     }
 236
 237     PRBool SetupLookupFunction()
 238     {
 239         mLookupFunc = (PlatformLookupFunction)sOSMesaLibrary.fGetProcAddress;
 240         return PR_TRUE;
 241     }
 242
 243     void *GetNativeData(NativeDataType aType)
 244     {
 245         switch (aType) {
 246         case NativeImageSurface:
 247             return mThebesSurface.get();
 248         default:
 249             return nsnull;
 250         }
 251     }
 252
 253 private:
 254     nsRefPtr<gfxImageSurface> mThebesSurface;
 255     PrivateOSMesaContext mContext;
 256 };
 257
 258 already_AddRefed<GLContext>
 259 GLContextProviderOSMesa::CreateForWindow(nsIWidget *aWidget)
 260 {
 261     return nsnull;
 262 }
 263
 264 already_AddRefed<GLContext>
 265 GLContextProviderOSMesa::CreateOffscreen(const gfxIntSize& aSize,
 266                                          const ContextFormat& aFormat)
 267 {
 268     if (!sOSMesaLibrary.EnsureInitialized()) {
 269         return nsnull;
 270     }
 271
 272     nsRefPtr<GLContextOSMesa> glContext = new GLContextOSMesa(aFormat);
 273
 274     if (!glContext->Init(aSize))
 275     {
 276         return nsnull;
 277     }
 278
 279     return glContext.forget();
 280 }
 281
 282 GLContext *
 283 GLContextProviderOSMesa::GetGlobalContext()
 284 {
 285     return nsnull;
 286 }
 287
 288 void
 289 GLContextProviderOSMesa::Shutdown()
 290 {
 291 }
 292
 293 } /* namespace gl */
 294 } /* namespace mozilla */