use gdk_threads_add_idle_full(); update readme

Author: BenjaminPritchard

keyboard.c

@@ -1,26 +1,24 @@
+
+// this code mostly comes from here: https://github.com/anko/xkbcat/blob/master/xkbcat.c
+
 #include "keyboard.h"
 #include "vangoghflow.h"
 
 #include <X11/XKBlib.h>
 #include <X11/extensions/XInput2.h>
 
-const char *DEFAULT_DISPLAY = ":0";
-const bool DEFAULT_PRINT_UP = false;
-
 int xiOpcode;
-char xDisplayName[2];
-bool printKeyUps = DEFAULT_PRINT_UP;
 Display *disp;
 
 bool initKB()
 {
 
-       // Connect to X display
+    // Connect to X display
     // this is just harded for now...
     disp = XOpenDisplay(":0");
     if (NULL == disp)
     {
-        fprintf(stderr, "Cannot open X display: %s\n", xDisplayName);
+        fprintf(stderr, "Cannot open X display: %s\n", ":0");
         return false;
     }
 
@@ -54,8 +52,6 @@ bool initKB()
         m.mask_len = XIMaskLen(XI_LASTEVENT);
         m.mask = calloc(m.mask_len, sizeof(char));
         XISetMask(m.mask, XI_RawKeyPress);
-        if (printKeyUps)
-            XISetMask(m.mask, XI_RawKeyRelease);
         XISelectEvents(disp, root, &m, 1 /*number of masks*/);
         XSync(disp, false);
         free(m.mask);
@@ -92,7 +88,7 @@ void *CheckForHotKeys()
                 if (NULL == str)
                     continue;
 
-                DoUpdate(str);
+                gdk_threads_add_idle_full(G_PRIORITY_DEFAULT_IDLE, DoUpdate, str, NULL);
                 break;
             }
             }

readme.md

@@ -1,12 +1,43 @@
-#ABOUT
+# ABOUT
 
-GTK3 version of VanGoghFlow, a program for overlaying your display with beautiful visualizations pulled from YouTube.
-In addition to being aesthetically pleasing, it is useful for modulating brain states between focused and diffuse modes.
+GTK3 version of VanGoghFlow, a program for overlaying your display with beautiful visualizations pulled from YouTube. In addition to being aesthetically pleasing, it is useful for gently inducing psychological flow states.
 
 For more information on that, please see here: https://www.kundalinisoftware.com/van-gogh-flow/
 
-Source code available on GitHub here: https://github.com/BenjaminPritchard/VanGoghFlowGTK3. If you have any ideas, please feel free to fork and submit a pull request.
+# USAGE
 
-#CREDITS
+Just run the executable. You can use your F3 / F4 keys like "volume keys" to set the opacity of the visualizations.
 
-Original author: Benjamin Pritchard.
+To change visualizations, use the tray icon.
+
+# BUILDING
+
+Just run make, which builds using clang.
+
+You can see the dependancies needed by looking at the makefile:
+
+    clang -g -O0 -std=c11 -Wdeprecated vangoghflow.c tray.c screen.c keyboard.c -o vangoghflow -lappindicator3 -I/usr/include/libdbusmenu-glib-0.4/libdbusmenu-glib/ -I/usr/include/libappindicator-0.1/libappindicator `pkg-config --cflags --libs gtk+-3.0 webkit2gtk-4.0` -lX11 -lXi
+
+# TODO
+
+1.  Use local .HTML instead of just setting the YouTube URL directly. This will allow the use of the YouTube API to know when the videos are done playing, so that we can automatically advance to the next one.
+
+    Additionally, using local .HTML opens up the possibility to do realtime visualizations using Javascript, instead of just using prerendered ones from YouTube.
+
+2.  Allow user-configurable YouTube video configuration. Currently this is hardcoded.
+
+3.  It would be nice to package this up as a .deb file.
+
+# CAVEAT
+
+I am not sure what all systems this builds / works under. But for sure you need a [compositing window manager](https://en.wikipedia.org/wiki/Compositing_window_manager) for this to work, and I think a GKT desktop. I use Linux Mint (which comes with a compositing window manager called Muffin) and everything works fine.
+
+So maybe it is possible to get this working on different distros. But I have not tried. If you do something like that, please submit a pull request so others can benefit.
+
+# GITHUB
+
+Source code available on GitHub here: https://github.com/BenjaminPritchard/VanGoghFlowGTK3. If you have any ideas or improvements, please feel free to fork and submit a pull request.
+
+# CREDITS
+
+Original author: Benjamin Pritchard, August 2021.

tray.c

@@ -51,9 +51,10 @@ about_menu_clicked(GtkWidget *widget, gpointer data)
 static void
 item_clicked_cb(GtkWidget *widget, gpointer data)
 {
-
     static bool noRecursion;
 
+    // trying to set the menu items to checked/unchecked using gtk_check_menu_item_set_active()
+    // causes this function to be called again!!
     if (noRecursion)
         return;
 
@@ -78,10 +79,10 @@ item_clicked_cb(GtkWidget *widget, gpointer data)
         break;
     }
 
-    noRecursion = false;
-
     //loadURL() does range checking
     loadURL(web_view, index);
+
+    noRecursion = false;
 }
 
 void MakeTrayIcon()

vangoghflow.c

@@ -65,8 +65,14 @@ void startKeyBDThread()
     GThread *myThread = g_thread_new(NULL, (GThreadFunc)CheckForHotKeys, NULL);
 }
 
-void DoUpdate(char *key)
+// this routine is called by the thread created in startKeyBDThread()
+// by using gdk_threads_add_idle_full()
+// My understanding is that using gdk_threads_add_idle() is the way
+// we are suppossed to pass data from the background thread back to our
+// UI thread here
+gboolean DoUpdate(void *data)
 {
+    char *key = (char *)data;
     if (strcmp(key, "F3") == 0)
     {
         if (opacity != 0.0)
@@ -79,6 +85,10 @@ void DoUpdate(char *key)
     }
 
     gtk_widget_set_opacity(GTK_WIDGET(window), opacity);
+
+    // i think we have to return false each time, so that this routine won't be called more than one
+    // per invocation of gdk_threads_add_idle()
+    return false;
 }
 
 int main(int argc, char **argv)

vangoghflow.h

@@ -3,4 +3,4 @@
 #include <webkit2/webkit2.h>
 
 void loadURL(WebKitWebView *web_view, int index);
-void DoUpdate(char *key);
+gboolean DoUpdate(void *data);