Improved exception handling. Verbose exception. Fixed mirics plugin tuning bug.

Author: martinmarinov

JavaGUI/jni/TSDRLibraryNDK.c

@@ -9,7 +9,7 @@
 
 tsdr_lib_t tsdr_instance;
 
-#define THROW(x) error(env, x, "")
+#define THROW(x) error(env, x)
 
 struct java_context {
 		jobject obj;
@@ -58,19 +58,14 @@ void error_translate (int exception_code, char * exceptionclass) {
 		}
 }
 
-void error(JNIEnv * env, int exception_code, const char *inmsg, ...)
+void error(JNIEnv * env, int exception_code)
 {
 	if (exception_code == TSDR_OK) return;
 
 	char exceptionclass[256];
 	error_translate(exception_code, exceptionclass);
 
-	char msg[256];
-
-	va_list argptr;
-	va_start(argptr, inmsg);
-	vsprintf(msg, inmsg, argptr);
-	va_end(argptr);
+	char * msg = tsdr_getlasterrortext(&tsdr_instance);
 
     jclass cls = (*env)->FindClass(env, exceptionclass);
     /* if cls is NULL, an exception has already been thrown */

JavaGUI/jni/include/TSDRLibrary.h

@@ -26,6 +26,9 @@
 		float gain;
 		float motionblur;
 		volatile int syncoffset;
+		char * errormsg;
+		int errormsg_size;
+		int errormsg_code;
 	} typedef tsdr_lib_t;
 
 	typedef void(*tsdr_readasync_function)(float *buf, int width, int height, void *ctx);
@@ -41,5 +44,6 @@
 	int tsdr_isrunning(tsdr_lib_t * tsdr);
 	int tsdr_sync(tsdr_lib_t * tsdr, int pixels, int direction);
 	int tsdr_motionblur(tsdr_lib_t * tsdr, float coeff);
+	char * tsdr_getlasterrortext(tsdr_lib_t * tsdr);
 
 #endif

JavaGUI/src/martin/tempest/core/exceptions/TSDRLoadPluginException.java

@@ -6,4 +6,8 @@ public class TSDRLoadPluginException extends TSDRException {
 	public TSDRLoadPluginException(final String msg) {
 		super(msg);
 	}
+	
+	public TSDRLoadPluginException() {
+		super();
+	}
 }

TSDRPlugin_Mirics/src/TSDRPlugin.h

@@ -12,6 +12,7 @@
 	int tsdrplugin_setbasefreq(uint32_t freq);
 	int tsdrplugin_stop(void);
 	int tsdrplugin_setgain(float gain);
+	char * tsdrplugin_getlasterrortext(void);
 	int tsdrplugin_readasync(tsdrplugin_readasync_function cb, void *ctx);
 
 #endif

TSDRPlugin_Mirics/src/TSDRPlugin_Mirics.c

@@ -18,6 +18,34 @@ volatile int desiredgainred = 40;
 
 #define SAMPLES_TO_PROCESS_AT_ONCE (20)
 
+int errormsg_code;
+char * errormsg;
+int errormsg_size = 0;
+#define RETURN_EXCEPTION(message, status) {announceexception(message, status); return status;}
+#define RETURN_OK() {errormsg_code = TSDR_OK; return TSDR_OK;}
+
+static inline void announceexception(const char * message, int status) {
+	errormsg_code = status;
+	if (status == TSDR_OK) return;
+
+	const int length = strlen(message);
+	if (errormsg_size == 0) {
+			errormsg_size = length;
+			errormsg = (char *) malloc(length+1);
+		} else if (length > errormsg_size) {
+			errormsg_size = length;
+			errormsg = (char *) realloc((void*) errormsg, length+1);
+		}
+	strcpy(errormsg, message);
+}
+
+char * tsdrplugin_getlasterrortext(void) {
+	if (errormsg_code == TSDR_OK)
+		return NULL;
+	else
+		return errormsg;
+}
+
 void tsdrplugin_getName(char * name) {
 	strcpy(name, "TSDR Mirics SDR Plugin");
 }
@@ -32,23 +60,23 @@ uint32_t tsdrplugin_getsamplerate() {
 
 int tsdrplugin_setbasefreq(uint32_t freq) {
 	desiredfreq = freq;
-	return TSDR_OK;
+	RETURN_OK();
 }
 
 int tsdrplugin_stop(void) {
 	working = 0;
-	return TSDR_OK;
+	RETURN_OK();
 }
 
 int tsdrplugin_setgain(float gain) {
 	desiredgainred = 102 - (int) (gain * 102);
 	if (desiredgainred < 0) desiredgainred = 0;
 	else if (desiredgainred > 102) desiredgainred = 102;
-	return TSDR_OK;
+	RETURN_OK();
 }
 
 int tsdrplugin_setParams(const char * params) {
-	return TSDR_OK;
+	RETURN_OK();
 }
 
 int tsdrplugin_readasync(tsdrplugin_readasync_function cb, void *ctx) {
@@ -57,14 +85,16 @@ int tsdrplugin_readasync(tsdrplugin_readasync_function cb, void *ctx) {
 	int err, sps, grc, rfc, fsc, i, id;
 	unsigned int fs;
 	unsigned int frame = 0;
+	int inited = 0 ;
 
 	double freq = desiredfreq;
 	double gainred = desiredgainred;
 	err = mir_sdr_Init(gainred, 8, freq / 1000000.0, mir_sdr_BW_8_000, mir_sdr_IF_Zero, &sps);
 	if (err != 0) {
 		mir_sdr_Uninit();
-		return TSDR_CANNOT_OPEN_DEVICE;
-	}
+		RETURN_EXCEPTION("Can't access the Mirics SDR dongle. Make sure it is properly plugged in, drivers are installed and the mir_sdr_api.dll is in the executable's folder and try again. Please, refer to the TSDRPlugin_Miricis readme file for more information.", TSDR_CANNOT_OPEN_DEVICE);
+	} else
+		inited = 1;
 
 	short * xi = (short *)malloc(sps * SAMPLES_TO_PROCESS_AT_ONCE * sizeof(short));
 	short * xq = (short *)malloc(sps * SAMPLES_TO_PROCESS_AT_ONCE * sizeof(short));
@@ -89,46 +119,55 @@ int tsdrplugin_readasync(tsdrplugin_readasync_function cb, void *ctx) {
 		}
 
 		// if desired frequency is different and valid
-		if (freq != desiredfreq && !(desiredfreq < 60e6 || (desiredfreq > 245e6 && desiredfreq < 420e6) || desiredfreq > 1000e6)) {
+		if (err == 0 && freq != desiredfreq && !(desiredfreq < 60e6 || (desiredfreq > 245e6 && desiredfreq < 420e6) || desiredfreq > 1000e6)) {
 
 			err = mir_sdr_SetRf(desiredfreq, 1, 0);
 			if (err == 0)
 				freq = desiredfreq; // if OK, frequency has been changed
 			else if (err == mir_sdr_RfUpdateError) {
 				// if an error occurs, try to reset the device
-				mir_sdr_Uninit();
+				if (mir_sdr_Uninit() == 0) inited = 0;
 				gainred = desiredgainred;
-				err = mir_sdr_Init(gainred, 8, desiredfreq / 1000000.0, mir_sdr_BW_8_000, mir_sdr_IF_Zero, &sps);
-				if (err == 3) {
+				if ((err = mir_sdr_Init(gainred, 8, desiredfreq / 1000000.0, mir_sdr_BW_8_000, mir_sdr_IF_Zero, &sps))==0) inited = 1;
+				if (err == mir_sdr_OutOfRange) {
 					// if the desired frequency is outside operational range, go back to the working frequency
-					mir_sdr_Uninit();
-					mir_sdr_Init(gainred, 8, freq / 1000000.0, mir_sdr_BW_8_000, mir_sdr_IF_Zero, &sps);
+					if (mir_sdr_Uninit() == 0) inited = 0;
+					if (mir_sdr_Init(gainred, 8, freq / 1000000.0, mir_sdr_BW_8_000, mir_sdr_IF_Zero, &sps) == 0) inited = 1;
 					desiredfreq = freq;
 					err = 0;
-				}
-				else
+				} else if (err == 0)
 					freq = desiredfreq;
+			} else if (err == mir_sdr_OutOfRange) {
+				mir_sdr_SetRf(freq, 1, 0);
+				desiredfreq = freq;
+				err = 0;
 			}
 		}
 
-		if (gainred != desiredgainred) {
+		if (err == 0 && gainred != desiredgainred) {
 			gainred = desiredgainred;
 			mir_sdr_SetGr(gainred, 1, 0);
 		}
 
+		if (err == 0)
 		for (i = 0; i < outbufsize; i++) {
 			const short val = (i & 1) ? (xq[i >> 1]) : (xi[i >> 1]);
 			outbuf[i] = val / 32767.0;
 		}
 
-		cb(outbuf, outbufsize, ctx, dropped);
+		if (err != 0)
+			{ working = 0; break; }
+		else
+			cb(outbuf, outbufsize, ctx, dropped);
 	}
 
+
+
 	free(outbuf);
 	free(xi);
 	free(xq);
 
-	if (mir_sdr_Uninit() != 0) return TSDR_ERR_PLUGIN;
+	if (inited && mir_sdr_Uninit() != 0) RETURN_EXCEPTION("Cannot properly close the Mirics USB dongle. If you experience any further issues, please disconnect it and reconnect it again.", TSDR_CANNOT_OPEN_DEVICE);
 
-	return (err == 0) ? TSDR_OK : TSDR_ERR_PLUGIN;
+	RETURN_EXCEPTION("The Mirics SDR dongle stopped responding.", (err == 0) ? TSDR_OK : TSDR_ERR_PLUGIN);
 }

TSDRPlugin_RawFile/src/TSDRPlugin.h

@@ -12,6 +12,7 @@
 	int tsdrplugin_setbasefreq(uint32_t freq);
 	int tsdrplugin_stop(void);
 	int tsdrplugin_setgain(float gain);
+	char * tsdrplugin_getlasterrortext(void);
 	int tsdrplugin_readasync(tsdrplugin_readasync_function cb, void *ctx);
 
 #endif

TSDRPlugin_RawFile/src/TSDRPlugin_RawFile.c

@@ -43,6 +43,34 @@ void thread_sleep(uint32_t milliseconds) {
 #endif
 }
 
+int errormsg_code;
+char * errormsg;
+int errormsg_size = 0;
+#define RETURN_EXCEPTION(message, status) {announceexception(message, status); return status;}
+#define RETURN_OK() {errormsg_code = TSDR_OK; return TSDR_OK;}
+
+static inline void announceexception(const char * message, int status) {
+	errormsg_code = status;
+	if (status == TSDR_OK) return;
+
+	const int length = strlen(message);
+	if (errormsg_size == 0) {
+			errormsg_size = length;
+			errormsg = (char *) malloc(length+1);
+		} else if (length > errormsg_size) {
+			errormsg_size = length;
+			errormsg = (char *) realloc((void*) errormsg, length+1);
+		}
+	strcpy(errormsg, message);
+}
+
+char * tsdrplugin_getlasterrortext(void) {
+	if (errormsg_code == TSDR_OK)
+		return NULL;
+	else
+		return errormsg;
+}
+
 void tsdrplugin_getName(char * name) {
 	strcpy(name, "TSDR Raw File Source Plugin");
 }
@@ -56,16 +84,16 @@ uint32_t tsdrplugin_getsamplerate() {
 }
 
 int tsdrplugin_setbasefreq(uint32_t freq) {
-	return TSDR_OK;
+	RETURN_OK();
 }
 
 int tsdrplugin_stop(void) {
 	working = 0;
-	return TSDR_OK;
+	RETURN_OK();
 }
 
 int tsdrplugin_setgain(float gain) {
-	return TSDR_OK;
+	RETURN_OK();
 }
 
 char * strtoken = NULL;
@@ -115,13 +143,13 @@ char * nexttoken(char * input) {
 
 int tsdrplugin_setParams(const char * params) {
 	char * fname = nexttoken((char *) params);
-	if (fname == NULL) return TSDR_PLUGIN_PARAMETERS_WRONG;
+	if (fname == NULL) RETURN_EXCEPTION("File name was not specified. Commands should be: filename samplerate sampleformat. Format could be float, int8, uint8, int16 or uint16.", TSDR_PLUGIN_PARAMETERS_WRONG);
 	char * samplerate_s = nexttoken(NULL);
-	if (samplerate_s == NULL) return TSDR_SAMPLE_RATE_WRONG;
+	if (samplerate_s == NULL) RETURN_EXCEPTION("Sample rate was not specified. Commands should be: filename samplerate sampleformat. Format could be float, int8, uint8, int16 or uint16.", TSDR_PLUGIN_PARAMETERS_WRONG);
 	long samplerate_l = atol(samplerate_s);
-	if (samplerate_l > MAX_SAMP_RATE || samplerate_l <= 0) return TSDR_SAMPLE_RATE_WRONG;
+	if (samplerate_l > MAX_SAMP_RATE || samplerate_l <= 0) RETURN_EXCEPTION("Samplerate is invalid. Please specify the samplerate the original recording was done with.", TSDR_PLUGIN_PARAMETERS_WRONG);
 	char * type_s = nexttoken(NULL);
-	if (type_s == NULL) return TSDR_PLUGIN_PARAMETERS_WRONG;
+	if (type_s == NULL) RETURN_EXCEPTION("Sample type is not specified. Pick one between float, int8, uint8, int16 or uint16.", TSDR_PLUGIN_PARAMETERS_WRONG);
 
 	if (str_eq(type_s,"float")) {
 		type = TYPE_FLOAT;
@@ -139,12 +167,12 @@ int tsdrplugin_setParams(const char * params) {
 		type = TYPE_USHORT;
 		sizepersample = 2;
 	} else
-		return TSDR_PLUGIN_PARAMETERS_WRONG;
+		RETURN_EXCEPTION("Sample type is invalid. Pick one between float, int8, uint8, int16 or uint16.", TSDR_PLUGIN_PARAMETERS_WRONG);
 
 	strcpy(filename, fname);
 	samplerate = (uint32_t) samplerate_l;
 
-	return TSDR_OK;
+	RETURN_OK();
 }
 
 int tsdrplugin_readasync(tsdrplugin_readasync_function cb, void *ctx) {
@@ -154,11 +182,11 @@ int tsdrplugin_readasync(tsdrplugin_readasync_function cb, void *ctx) {
 	int counter;
 
 	if (sizepersample == -1)
-		return TSDR_PLUGIN_PARAMETERS_WRONG;
+		RETURN_EXCEPTION("Plugin was not initialized properly.", TSDR_PLUGIN_PARAMETERS_WRONG);
 
 	FILE * file=fopen(filename,"rb");
-	if (file == NULL) return TSDR_PLUGIN_PARAMETERS_WRONG;
-	if (samplerate > MAX_SAMP_RATE || samplerate <= 0) return TSDR_SAMPLE_RATE_WRONG;
+	if (file == NULL) RETURN_EXCEPTION("Cannot open the required file.", TSDR_PLUGIN_PARAMETERS_WRONG);
+	if (samplerate > MAX_SAMP_RATE || samplerate <= 0) RETURN_EXCEPTION("The samplerate the plugin was initialized with is invalid.", TSDR_SAMPLE_RATE_WRONG);
 
 	const size_t bytestoread = SAMPLES_TO_READ_AT_ONCE * sizepersample;
 	char * buf = (char *) malloc(bytestoread);
@@ -227,5 +255,5 @@ int tsdrplugin_readasync(tsdrplugin_readasync_function cb, void *ctx) {
 	free(outbuf);
 	fclose(file);
 
-	return TSDR_OK;
+	RETURN_OK();
 }