* turn til_fb_fragment_t.stream into a discrete parameter

This was mostly done out of convenience at the expense of turning
the fragment struct into more of a junk drawer.

But properly cleaning up owned stream pipes on context destroy
makes the inappropriateness of being part of til_fb_fragment_t
glaringly apparent.

Now the stream is just a separate thing passed to context create,
with a reference kept in the context for use throughout.  Cleanup
of the owned pipes on the stream supplied to context create is
automagic when the context gets destroyed.

Note that despite there being a stream in the module context, the
stream to use is still supplied to all the rendering family
functions (prepare/render/finish) and it's the passed-in stream
which should be used by these functions.  This is done to support
the possibility of switching out the stream frame-to-frame, which
may be interesting.  Imagine doing things like a latent stream
and a future stream and switching between them on the fly for
instance.  If there's a sequencing composite module, it could
flip between multiple sets of tracks or jump around multiple
streams with the visuals immediately flipping accordingly.

This should fix the --print-pipes crashing issues caused by lack
of cleanup when contexts were removed (like rtv does so often).

1 files changed, 9 insertions, 8 deletions

diff --git a/src/til.h b/src/til.h
index 852cb96..b863868 100644
--- a/src/til.h
+++ b/src/til.h
@@ -18,15 +18,16 @@ typedef struct til_frame_plan_t {
 typedef struct til_settings_t settings;
 typedef struct til_setting_desc_t til_setting_desc_t;
 typedef struct til_knob_t til_knob_t;
+typedef struct til_stream_t til_stream_t;
 
 #define TIL_MODULE_OVERLAYABLE	1u
 
 typedef struct til_module_t {
-	til_module_context_t *	(*create_context)(unsigned seed, unsigned ticks, unsigned n_cpus, char *path, til_setup_t *setup);
-	void			(*destroy_context)(til_module_context_t *context);
-	void			(*prepare_frame)(til_module_context_t *context, unsigned ticks, til_fb_fragment_t **fragment_ptr, til_frame_plan_t *res_frame_plan);
-	void			(*render_fragment)(til_module_context_t *context, unsigned ticks, unsigned cpu, til_fb_fragment_t **fragment_ptr);
-	void			(*finish_frame)(til_module_context_t *context, unsigned ticks, til_fb_fragment_t **fragment_ptr);
+	til_module_context_t *	(*create_context)(til_stream_t *stream, unsigned seed, unsigned ticks, unsigned n_cpus, char *path, til_setup_t *setup);
+	void			(*destroy_context)(til_module_context_t *context);	/* destroy gets stream in context, but the render-related functions should always use the passed-in stream so it can potentially change */
+	void			(*prepare_frame)(til_module_context_t *context, til_stream_t *stream, unsigned ticks, til_fb_fragment_t **fragment_ptr, til_frame_plan_t *res_frame_plan);
+	void			(*render_fragment)(til_module_context_t *context, til_stream_t *stream, unsigned ticks, unsigned cpu, til_fb_fragment_t **fragment_ptr);
+	void			(*finish_frame)(til_module_context_t *context, til_stream_t *stream, unsigned ticks, til_fb_fragment_t **fragment_ptr);
 	int			(*setup)(const til_settings_t *settings, til_setting_t **res_setting, const til_setting_desc_t **res_desc, til_setup_t **res_setup);
 	size_t			(*knobs)(til_module_context_t *context, til_knob_t **res_knobs);
 	char			*name;
@@ -40,9 +41,9 @@ void til_quiesce(void);
 void til_shutdown(void);
 const til_module_t * til_lookup_module(const char *name);
 void til_get_modules(const til_module_t ***res_modules, size_t *res_n_modules);
-void til_module_render(til_module_context_t *context, unsigned ticks, til_fb_fragment_t **fragment_ptr);
-int til_module_create_context(const til_module_t *module, unsigned seed, unsigned ticks, unsigned n_cpus, const char *parent_path, til_setup_t *setup, til_module_context_t **res_context);
-til_module_context_t * til_module_destroy_context(til_module_context_t *context);
+void til_module_render(til_module_context_t *context, til_stream_t *stream, unsigned ticks, til_fb_fragment_t **fragment_ptr);
+int til_module_create_context(const til_module_t *module, til_stream_t *stream, unsigned seed, unsigned ticks, unsigned n_cpus, const char *parent_path, til_setup_t *setup, til_module_context_t **res_context);
+til_module_context_t * til_module_destroy_context(til_module_context_t *context, til_stream_t *stream);
 int til_module_setup(til_settings_t *settings, til_setting_t **res_setting, const til_setting_desc_t **res_desc, til_setup_t **res_setup);
 int til_module_randomize_setup(const til_module_t *module, unsigned seed, til_setup_t **res_setup, char **res_arg);
 int til_fragmenter_slice_per_cpu(til_module_context_t *context, const til_fb_fragment_t *fragment, unsigned number, til_fb_fragment_t *res_fragment);