modules/*: instantiate and use setups

Now modules allocate and return an opaque setup pointer in
res_setup when they implement a setup method.

Defaults are utilized when ${module}_create_context() receives a
NULL setup.  The default setup used in this case should match the
defaults/preferred values emitted by the module's setup method.
But performing setup should always be optional, so a NULL setup
provided to create_context() is to be expected.

No cleanup of these setup instances is currently performed, so
it's a small memory leak for now.  Since these are opaque and may
contain nested references to other allocations, simply using
free() somewhere in the frontend is insufficient.  There will
probably need to be something like a til_module_t.setup_free()
method added in the future which modules may assign libc's free()
to when appropriate, or their own more elaborate version.

Lifecycle for the settings is very simple; the setup method
returns an instance, the caller is expected to free it when no
longer needed (once free is implemented).  The create_context
consumer of a given setup must make its own copy of the settings
if necessary, and may not keep a reference - it must assume the
setup will be freed immediately after create_context() returns.
This enables the ability to reuse a setup instance across
multiple create_context() calls if desired, one can imagine
something like running the same module with the same settings
multiple times across multiple displays for instance.  If the
module has significant entropy the output will differ despite
being configured identically...

With this commit one may change settings for any of the modules
*while* the modules are actively rendering a given context, and
the settings should *not* be visible.  They should only affect
the context they're supplied to.

1 files changed, 24 insertions, 4 deletions

diff --git a/src/modules/stars/stars.c b/src/modules/stars/stars.c
index 055a495..288057f 100644
--- a/src/modules/stars/stars.c
+++ b/src/modules/stars/stars.c
@@ -1,3 +1,4 @@
+#include <errno.h>
 #include <stdint.h>
 #include <stdlib.h>
 #include <string.h>
@@ -17,8 +18,6 @@
 
 #define DEFAULT_ROT_ADJ	.00003
 
-static float	stars_rot_adj = DEFAULT_ROT_ADJ;
-
 struct points
 {
 	float x, y, z;
@@ -35,6 +34,14 @@ typedef struct stars_context_t {
 	float		offset_angle;
 } stars_context_t;
 
+typedef struct stars_setup_t {
+	float		rot_adj;
+} stars_setup_t;
+
+static stars_setup_t stars_default_setup = {
+	.rot_adj = DEFAULT_ROT_ADJ,
+};
+
 
 float get_random_unit_coord() {
 	return (((float)rand()/(float)RAND_MAX)*2.0)-1.0;
@@ -47,12 +54,15 @@ static void * stars_create_context(unsigned ticks, unsigned num_cpus, void *setu
 	float		z;
 	struct points* p_ptr = NULL;
 
+	if (!setup)
+		setup = &stars_default_setup;
+
 	ctxt = malloc(sizeof(stars_context_t));
 	if (!ctxt)
 		return NULL;
 
 	ctxt->points = NULL;
-	ctxt->rot_adj = stars_rot_adj;
+	ctxt->rot_adj = ((stars_setup_t *)setup)->rot_adj;
 	ctxt->rot_rate = 0.00;
 	ctxt->rot_angle = 0;
 	ctxt->offset_x = 0.5;
@@ -230,7 +240,17 @@ int stars_setup(const til_settings_t *settings, til_setting_t **res_setting, con
 	if (r)
 		return r;
 
-	sscanf(rot_adj, "%f", &stars_rot_adj);
+	if (res_setup) {
+		stars_setup_t	*setup;
+
+		setup = calloc(1, sizeof(*setup));
+		if (!setup)
+			return -ENOMEM;
+
+		sscanf(rot_adj, "%f", &setup->rot_adj);
+
+		*res_setup = setup;
+	}
 
 	return 0;
 }