Merge lp:~stellarium/stellarium/gz_insufficient-shader-level into lp:stellarium

[gzotti]

Better OpenGL startup diagnostics and error messaging towards the user.

[Fabien Chéreau (xalioth)]

It's fine for me, but it would be good to also allow user to click on something like "Understood, don't show me this again" which will set the option in the config file

review: Needs Fixing

[lp:~stellarium/stellarium/gz_insufficient-shader-level]

7113. By gzotti on 2014-11-01

removed command line option to ignore OpenGL version errors, same functionality will be taken by config flag.

7114. By gzotti on 2014-11-01

added config option main/ignore_opengl_warning to suppress further notice.

[gzotti (georg-zotti)]

OK, I changed this from command line option to config.ini setting.

I don't see a "Run Once" option in the QMessagebox buttons (Ignore without saving), but this whole addition should just be enough to catch most "does not run", "black screen", etc. bug reports. What would be nice would be GLSL1.20 fallback planet shaders for OpenGL2.1-only systems. (No shadows, just Phong model.) I also wonder about the GLSL answer string on OpenGL ES2.0, I have no system to test.

review: Needs Resubmitting

[Fabien Chéreau (xalioth)]

Please also get rid of QGLFormat and related deprecated classes.

review: Needs Fixing

[lp:~stellarium/stellarium/gz_insufficient-shader-level]

7115. By gzotti on 2014-11-05

Removed QGLFormat-based startup tests for OpenGL capabilities. (Old version just commented away)

[gzotti (georg-zotti)]

OK, I could remove all QGLFormat things in the startup tests. But the context creation in StelMainView l.306 was something I did not dare touching. I cannot test the GLES tests, have no ANGLE build system here.

The old version is only commented away, I would remove it on merge.

review: Needs Resubmitting

[lp:~stellarium/stellarium/gz_insufficient-shader-level]

7116. By gzotti on 2014-11-07

better startup hardware diagnostics esp. for ANGLE users

7117. By gzotti on 2014-11-07

Formatting fix for nicer OpenGL version message. (Thanks AW)

7118. By gzotti on 2014-11-07

Improved startup test and diagnostic for ANGLE.

7119. By gzotti on 2014-11-07

prettified detected OpenGL version string.

7120. By gzotti on 2014-11-11

code cleanup

[gzotti (georg-zotti)]

The only thing that remains appears to be changing the (Stel)QGLWidget and other QGL... classes. On http://qt-project.org/wiki/New-Features-in-Qt-5.4 you can read there will be a QOpenGLWidget to replace QGLWidget. I would prefer to make this (hopefully easy) change after Qt5.4 is out, and merge this now so that our test builds and RCs can be tested and diagnosed on the various hardware already now.

review: Needs Resubmitting

[Alexander Wolf (alexwolf)]

QOpenGLWidget & QGLWidget should be used with ifdef's IMHO (if we not set minimal Qt as 5.4.0)

[lp:~stellarium/stellarium/gz_insufficient-shader-level]

7121. By gzotti on 2014-11-11

added two more test for detection of obviously unusable systems.

7122. By gzotti on 2014-11-14

Reactivate 0.12 line smoothing for AngleMeasure and CompassMarks plugins and activate it for Gridline drawing on capable systems. It really looks better. Compilation should not fail on ANGLE or other OpenGLES builds.

7123. By gzotti on 2014-11-16

Started migration towards QOpenGLwidget for Qt5.4. THIS COMPILES, BUT DOES NOT YET RUN!

7124. By gzotti on 2014-11-24

added a test for minimal Mesa version (10) if Mesa is used.
changed conditional compiling with the new QtOpenGL... classes from checking Qt version (>=5.4) to a single #define. Migration towards using these new classes is not finished, help wanted...

7125. By gzotti on 2014-11-24

merged with trunk r7172

Unmerged revisions

=== modified file 'src/StelMainView.cpp'
--- src/StelMainView.cpp	2014-10-26 13:26:29 +0000
+++ src/StelMainView.cpp	2014-11-11 14:09:15 +0000
@@ -46,6 +46,7 @@
 #include <QTimer>
 #include <QWidget>
 #include <QWindow>
+#include <QMessageBox>
 #include <QDeclarativeContext>
 #ifdef Q_OS_WIN
 	#include <QPinchGesture>
@@ -344,17 +345,197 @@
 	Q_ASSERT(glWidget->isValid());
 	glWidget->makeCurrent();
 
-	// Debug info about supported version of OpenGL and vendor/renderer
-	qDebug() << "OpenGL versions supported:" << getSupportedOpenGLVersion();
+	// Find out lots of debug info about supported version of OpenGL and vendor/renderer
+	QOpenGLContext* context=QOpenGLContext::currentContext();
+	QSurfaceFormat format=context->format();
+
+	bool openGLerror=false;
+	if (format.renderableType()==QSurfaceFormat::OpenGL || format.renderableType()==QSurfaceFormat::OpenGLES)
+	{
+		qDebug() << "Detected:" << (format.renderableType()==QSurfaceFormat::OpenGL  ? "OpenGL" : "OpenGL ES" ) << QString("%1.%2").arg(format.majorVersion()).arg(format.minorVersion());
+	}
+	else
+	{
+		openGLerror=true;
+		qDebug() << "Neither OpenGL nor OpenGL ES detected: Unsupported Format!";
+	}
+
 	qDebug() << "Driver version string:" << QString(reinterpret_cast<const char*>(glGetString(GL_VERSION)));
 	qDebug() << "GL vendor is" << QString(reinterpret_cast<const char*>(glGetString(GL_VENDOR)));
-	qDebug() << "GL renderer is" << QString(reinterpret_cast<const char*>(glGetString(GL_RENDERER)));
-	qDebug() << "GL Shading Language version is" << QString(reinterpret_cast<const char*>(glGetString(GL_SHADING_LANGUAGE_VERSION)));
-	
+	QString glRenderer(reinterpret_cast<const char*>(glGetString(GL_RENDERER)));
+	qDebug() << "GL renderer is" << glRenderer;
+
+	// Minimal required version of OpenGL for Qt5 is 2.1 and OpenGL Shading Language may be 1.20 (or OpenGL ES is 2.0 and GLSL ES is 1.0).
+	// As of V0.13.0..1, we use OpenGL Shading Language 1.30, i.e. we need in fact OpenGL 3.0 and above.
+	// If platform does not even support minimal OpenGL version for Qt5, then tell the user about troubles and quit from application.
+	if ( openGLerror ||
+	     ((format.renderableType()==QSurfaceFormat::OpenGL  ) && (format.version() < QPair<int, int>(2, 1))) ||
+	     ((format.renderableType()==QSurfaceFormat::OpenGLES) && (format.version() < QPair<int, int>(2, 0)))  )
+	{
+		#ifdef Q_OS_WIN
+		qWarning() << "Oops... Insufficient OpenGL version. Please update drivers, graphics hardware, or use MESA (or ANGLE) version.";
+		QMessageBox::critical(0, "Stellarium", q_("Insufficient OpenGL version. Please update drivers, graphics hardware, or use MESA (or ANGLE) version."), QMessageBox::Abort, QMessageBox::Abort);
+		#else
+		qWarning() << "Oops... Insufficient OpenGL version. Please update drivers, or graphics hardware.";
+		QMessageBox::critical(0, "Stellarium", q_("Insufficient OpenGL version. Please update drivers, or graphics hardware."), QMessageBox::Abort, QMessageBox::Abort);
+		#endif
+		exit(0);
+	}
+	// This call requires OpenGL2+.
+	QString glslString(reinterpret_cast<const char*>(glGetString(GL_SHADING_LANGUAGE_VERSION)));
+	qDebug() << "GL Shading Language version is" << glslString;
+
 	// Only give extended info if called on command line, for diagnostic.
 	if (qApp->property("dump_OpenGL_details").toBool())
 		dumpOpenGLdiagnostics();
 
+#ifdef Q_OS_WIN
+	// If we have ANGLE, check esp. for insufficient ps_2 level.
+	if (glRenderer.startsWith("ANGLE"))
+	{
+		QRegExp angleVsPsRegExp(" vs_(\\d)_(\\d) ps_(\\d)_(\\d)");
+		int angleVSPSpos=angleVsPsRegExp.indexIn(glRenderer);
+
+		if (angleVSPSpos >-1)
+		{
+			float vsVersion=angleVsPsRegExp.cap(1).toFloat() + 0.1*angleVsPsRegExp.cap(2).toFloat();
+			float psVersion=angleVsPsRegExp.cap(3).toFloat() + 0.1*angleVsPsRegExp.cap(4).toFloat();
+			qDebug() << "VS Version Number after parsing: " << vsVersion;
+			qDebug() << "PS Version Number after parsing: " << psVersion;
+			if ((vsVersion<2.0) || (psVersion<3.0))
+			{
+				openGLerror=true;
+				qDebug() << "This is not enough: we need DirectX9 with vs_2_0 and ps_3_0 or later.";
+				qDebug() << "You should update graphics drivers, graphics hardware, or use the OpenGL-MESA version.";
+				qDebug() << "Else, please try to use an older version like 0.12.4, and try there with --safe-mode";
+
+				if (conf->value("main/ignore_opengl_warning", false).toBool())
+				{
+					qDebug() << "Config option main/ignore_opengl_warning found, continuing. Expect problems.";
+				}
+				else
+				{
+					qDebug() << "You can try to run in an unsupported degraded mode by ignoring the warning and continuing.";
+					qDebug() << "But more than likely problems will persist.";
+					QMessageBox::StandardButton answerButton=
+					QMessageBox::critical(0, "Stellarium", q_("Your DirectX/OpenGL ES subsystem has problems. See log for details.\nIgnore and suppress this notice in the future and try to continue in degraded mode anyway?"),
+							      QMessageBox::Ignore|QMessageBox::Abort, QMessageBox::Abort);
+					if (answerButton == QMessageBox::Abort)
+					{
+						qDebug() << "Aborting due to ANGLE OpenGL ES / DirectX vs or ps version problems.";
+						exit(0);
+					}
+					else
+					{
+						qDebug() << "Ignoring all warnings, continuing without further question.";
+						conf->setValue("main/ignore_opengl_warning", true);
+					}
+				}
+			}
+			else
+				qDebug() << "vs/ps version is fine, we should not see a graphics problem.";
+		}
+		else
+		{
+			qDebug() << "Cannot parse ANGLE shader version string. This may indicate future problems.";
+			qDebug() << "Please send a bug report that includes this log file and states if Stellarium runs or has problems.";
+		}
+	}
+#endif
+
+
+
+	// If GLSL version is less than 1.30 or GLSL ES 1.00, Stellarium cannot run properly. Depending on whatever driver/implementation details,
+	// Stellarium may crash or show only minor graphical errors. We show a soft-crash panel that can be suppressed by a startup option.
+	QRegExp glslRegExp("^(\\d\\.\\d\\d)");
+	int pos=glslRegExp.indexIn(glslString);
+	QRegExp glslesRegExp("ES (\\d\\.\\d\\d)");
+	int posES=glslesRegExp.indexIn(glslString);
+	if (pos >-1)
+	{
+		float glslVersion=glslRegExp.cap(1).toFloat();
+		qDebug() << "GLSL Version Number after parsing: " << glslVersion;
+		if (glslVersion<1.3)
+		{
+			openGLerror=true;
+			qDebug() << "This is not enough: we need GLSL1.30 or later.";
+			qDebug() << "You should update graphics drivers, graphics hardware, or use the MESA version.";
+			qDebug() << "Else, please try to use an older version like 0.12.4, and try there with --safe-mode";
+
+			if (conf->value("main/ignore_opengl_warning", false).toBool())
+			{
+				qDebug() << "Config option main/ignore_opengl_warning found, continuing. Expect problems.";
+			}
+			else
+			{
+				qDebug() << "You can try to run in an unsupported degraded mode by ignoring the warning and continuing.";
+				qDebug() << "But more than likely problems will persist.";
+				QMessageBox::StandardButton answerButton=
+				QMessageBox::critical(0, "Stellarium", q_("Your OpenGL subsystem has problems. See log for details.\nIgnore and suppress this notice in the future and try to continue in degraded mode anyway?"),
+						      QMessageBox::Ignore|QMessageBox::Abort, QMessageBox::Abort);
+				if (answerButton == QMessageBox::Abort)
+				{
+					qDebug() << "Aborting due to OpenGL/GLSL version problems.";
+					exit(0);
+				}
+				else
+				{
+					qDebug() << "Ignoring all warnings, continuing without further question.";
+					conf->setValue("main/ignore_opengl_warning", true);
+				}
+			}
+		}
+		else
+			qDebug() << "GLSL version is fine, we should not see a graphics problem.";
+	}
+	else if (posES >-1)
+	{
+		float glslesVersion=glslesRegExp.cap(1).toFloat();
+		qDebug() << "GLSL ES Version Number after parsing: " << glslesVersion;
+		if (glslesVersion<1.0)
+		{
+			openGLerror=true;
+			qDebug() << "This is not enough: we need GLSL ES 1.00 or later.";
+			qDebug() << "You should update graphics drivers, graphics hardware, or use the OpenGL-MESA version.";
+			qDebug() << "Else, please try to use an older version like 0.12.4, and try there with --safe-mode";
+
+			if (conf->value("main/ignore_opengl_warning", false).toBool())
+			{
+				qDebug() << "Config option main/ignore_opengl_warning found, continuing. Expect problems.";
+			}
+			else
+			{
+				qDebug() << "You can try to run in an unsupported degraded mode by ignoring the warning and continuing.";
+				qDebug() << "But more than likely problems will persist.";
+				QMessageBox::StandardButton answerButton=
+				QMessageBox::critical(0, "Stellarium", q_("Your OpenGL ES subsystem has problems. See log for details.\nIgnore and suppress this notice in the future and try to continue in degraded mode anyway?"),
+						      QMessageBox::Ignore|QMessageBox::Abort, QMessageBox::Abort);
+				if (answerButton == QMessageBox::Abort)
+				{
+					qDebug() << "Aborting due to OpenGL ES/GLSL ES version problems.";
+					exit(0);
+				}
+				else
+				{
+					qDebug() << "Ignoring all warnings, continuing without further question.";
+					conf->setValue("main/ignore_opengl_warning", true);
+				}
+			}
+		}
+		else
+		{
+			if (openGLerror)
+				qDebug() << "GLSL ES version is OK, but there were previous errors, expect problems.";
+			else
+				qDebug() << "GLSL ES version is fine, we should not see a graphics problem.";
+		}
+	}
+	else
+	{
+		qDebug() << "Cannot parse GLSL (ES) version string. This may indicate future problems.";
+		qDebug() << "Please send a bug report that includes this log file and states if Stellarium works or has problems.";
+	}
+
 	stelApp= new StelApp();
 	stelApp->setGui(gui);
 	stelApp->init(conf);
@@ -406,55 +587,6 @@
 	startMainLoop();
 }
 
-QString StelMainView::getSupportedOpenGLVersion() const
-{
-	int version = QGLFormat::openGLVersionFlags();
-	QStringList ver;
-
-	if (version&QGLFormat::OpenGL_Version_1_1)
-		ver << "1.1";
-	if (version&QGLFormat::OpenGL_Version_1_2)
-		ver << "1.2";
-	if (version&QGLFormat::OpenGL_Version_1_3)
-		ver << "1.3";
-	if (version&QGLFormat::OpenGL_Version_1_4)
-		ver << "1.4";
-	if (version&QGLFormat::OpenGL_Version_1_5)
-		ver << "1.5";
-	if (version&QGLFormat::OpenGL_Version_2_0)
-		ver << "2.0";
-	if (version&QGLFormat::OpenGL_Version_2_1)
-		ver << "2.1";
-	if (version&QGLFormat::OpenGL_Version_3_0)
-		ver << "3.0";
-	if (version&QGLFormat::OpenGL_Version_3_1)
-		ver << "3.1";
-	if (version&QGLFormat::OpenGL_Version_3_2)
-		ver << "3.2";
-	if (version&QGLFormat::OpenGL_Version_3_3)
-		ver << "3.3";
-	if (version&QGLFormat::OpenGL_Version_4_0)
-		ver << "4.0";
-	if (version&QGLFormat::OpenGL_Version_4_1)
-		ver << "4.1";
-	if (version&QGLFormat::OpenGL_Version_4_2)
-		ver << "4.2";
-	if (version&QGLFormat::OpenGL_Version_4_3)
-		ver << "4.3";
-	if (version&QGLFormat::OpenGL_ES_CommonLite_Version_1_0)
-		ver << "1.0 (ES CL)";
-	if (version&QGLFormat::OpenGL_ES_CommonLite_Version_1_1)
-		ver << "1.1 (ES CL)";
-	if (version&QGLFormat::OpenGL_ES_Common_Version_1_0)
-		ver << "1.0 (ES C)";
-	if (version&QGLFormat::OpenGL_ES_Common_Version_1_1)
-		ver << "1.1 (ES C)";
-	if (version&QGLFormat::OpenGL_ES_Version_2_0)
-		ver << "2.0 (ES)";
-
-	return ver.join(", ");
-}
-
 void StelMainView::dumpOpenGLdiagnostics() const
 {
 	// GZ: Debug info about OpenGL capabilities.
@@ -507,6 +639,8 @@
 	QMapIterator<QString, QString> iter2(extensionMap);
 	while (iter2.hasNext())
 		qDebug() << " -" << iter2.next().key();
+	// Apparently EXT_gpu_shader4 is required for GLSL1.3. (http://en.wikipedia.org/wiki/OpenGL#OpenGL_3.0).
+	qDebug() << "EXT_gpu_shader4" << (extensionSet.contains(("EXT_gpu_shader4")) ? "present, OK." : "MISSING!");
 
 	QFunctionPointer programParameterPtr =context->getProcAddress("glProgramParameteri");
 	if (programParameterPtr == 0)

=== modified file 'src/StelMainView.hpp'
--- src/StelMainView.hpp	2014-11-04 10:59:12 +0000
+++ src/StelMainView.hpp	2014-11-11 14:09:15 +0000
@@ -145,7 +145,8 @@
 	//! Start the display loop
 	void startMainLoop();
 	
-	QString getSupportedOpenGLVersion() const;
+	//QString getSupportedOpenGLVersion() const;
+	//QPair getSupportedOpenGLVersion() const;
 	//! provide extensive OpenGL dignostics in logfile.
 	void dumpOpenGLdiagnostics() const;
 

=== modified file 'src/core/modules/Planet.cpp'
--- src/core/modules/Planet.cpp	2014-11-08 20:24:59 +0000
+++ src/core/modules/Planet.cpp	2014-11-11 14:09:15 +0000
@@ -1271,6 +1271,10 @@
 {
 	delete planetShaderProgram;
 	planetShaderProgram = NULL;
+	delete ringPlanetShaderProgram;
+	ringPlanetShaderProgram = NULL;
+	delete moonShaderProgram;
+	moonShaderProgram = NULL;
 }
 
 void Planet::draw3dModel(StelCore* core, StelProjector::ModelViewTranformP transfo, float screenSz, bool drawOnlyRing)

=== modified file 'src/main.cpp'
--- src/main.cpp	2014-09-27 11:37:20 +0000
+++ src/main.cpp	2014-11-11 14:09:15 +0000
@@ -43,7 +43,6 @@
 #include <QFile>
 #include <QFileInfo>
 #include <QFontDatabase>
-#include <QGLFormat>
 #include <QGuiApplication>
 #include <QSettings>
 #include <QSplashScreen>
@@ -344,55 +343,24 @@
 	app.installTranslator(&trans);
 
 	StelMainView mainWin;
-
-	bool appCanRun = true;
-	// some basic diagnostics
-	if (!QGLFormat::hasOpenGL()){
-		qWarning() << "Oops... This system does not support OpenGL.";
-		QMessageBox::warning(0, "Stellarium", q_("This system does not support OpenGL."));
-		appCanRun = false;
-	}
-
-	if (!(QGLFormat::openGLVersionFlags() & QGLFormat::OpenGL_Version_2_1) && !(QGLFormat::openGLVersionFlags() & QGLFormat::OpenGL_ES_Version_2_0)) // Check supported version of OpenGL
-	{
-		// OK, minimal required version of OpenGL is 2.1 and OpenGL Shading Language is 1.20 (or OpenGL ES is 2.0 and GLSL ES is 2.0).
-		// Recommended OpenGL 3.0 and OpenGL Shading Language 1.30 and above.
-		// If platform does not support this version then say to user about troubles and quit from application.
-		#ifdef Q_OS_WIN
-		qWarning() << "Oops... Insufficient OpenGL version. Please update drivers, graphics hardware, or use MESA (or ANGLE) version.";
-		QMessageBox::warning(0, "Stellarium", q_("Insufficient OpenGL version. Please update drivers, graphics hardware, or use MESA (or ANGLE) version."));
-		#else
-		qWarning() << "Oops... Insufficient OpenGL version. Please update drivers, or graphics hardware.";
-		QMessageBox::warning(0, "Stellarium", q_("Insufficient OpenGL version. Please update drivers, or graphics hardware."));
-		#endif
-		appCanRun = false;
-	}
-
-	if (appCanRun)
-	{
-		mainWin.init(confSettings);
-		splash.finish(&mainWin);
-		app.exec();
-		mainWin.deinit();
-
-		delete confSettings;
-		StelLogger::deinit();
-
-		#ifdef Q_OS_WIN
-		if(timerGrain)
-			timeEndPeriod(timerGrain);
-		#endif //Q_OS_WIN
-		#ifdef Q_OS_MAC
-		delete(newArgv);
-		delete(option);
-		delete(value);
-		#endif
-
-		return 0;
-	}
-	else
-	{
-		app.quit();
-	}
+	mainWin.init(confSettings); // May exit(0) when OpenGL subsystem insufficient
+	splash.finish(&mainWin);
+	app.exec();
+	mainWin.deinit();
+
+	delete confSettings;
+	StelLogger::deinit();
+
+	#ifdef Q_OS_WIN
+	if(timerGrain)
+		timeEndPeriod(timerGrain);
+	#endif //Q_OS_WIN
+	#ifdef Q_OS_MAC
+	delete(newArgv);
+	delete(option);
+	delete(value);
+	#endif
+
+	return 0;
 }