gui/jack.c

   1 /* -*- Mode: C ; c-basic-offset: 2 -*- */
   2 /*
   3  * LADI Session Handler (ladish)
   4  *
   5  * Copyright (C) 2008, 2009, 2010 Nedko Arnaudov <nedko@arnaudov.name>
   6  * Copyright (C) 2007 Dave Robillard <http://drobilla.net>
   7  *
   8  **************************************************************************
   9  * This file contains the JACK related functionality
  10  **************************************************************************
  11  *
  12  * LADI Session Handler is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * LADI Session Handler is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with LADI Session Handler. If not, see <http://www.gnu.org/licenses/>
  24  * or write to the Free Software Foundation, Inc.,
  25  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  26  */
  27
  28 #include <math.h>
  29
  30 #include "graph_view.h"
  31 #include "studio.h"
  32 #include "menu.h"
  33 #include "statusbar.h"
  34 #include "action.h"
  35 #include "../proxies/jack_proxy.h"
  36 #include "gtk_builder.h"
  37
  38 /* JACK states */
  39 #define JACK_STATE_NA         0
  40 #define JACK_STATE_STOPPED    1
  41 #define JACK_STATE_STARTED    2
  42
  43 unsigned int g_jack_state = JACK_STATE_NA;
  44 static uint32_t g_xruns;
  45 static double g_jack_max_dsp_load = 0.0;
  46 static GtkWidget * g_xrun_progress_bar;
  47 static uint32_t g_sample_rate;
  48 static bool g_jack_view_enabled = false;
  49 static graph_view_handle g_jack_view = NULL;
  50 static guint g_jack_poll_source_tag;
  51
  52 static void update_raw_jack_visibility(void)
  53 {
  54   /* if there is no jack view and its display is enabled and jack is avaialable, create the raw jack view */
  55   if (g_jack_view == NULL && g_jack_view_enabled && g_jack_state != JACK_STATE_NA)
  56   {
  57     if (!create_view("Raw JACK", JACKDBUS_SERVICE_NAME, JACKDBUS_OBJECT_PATH, false, false, true, &g_jack_view))
  58     {
  59       log_error("create_view() failed for jack");
  60       return;
  61     }
  62   }
  63
  64   /* if there is jack view and its display is disabled or it is enabled byt jack is not avaialable, destroy the raw jack view */
  65   if (g_jack_view != NULL && (!g_jack_view_enabled || g_jack_state == JACK_STATE_NA))
  66   {
  67     destroy_view(g_jack_view);
  68     g_jack_view = NULL;
  69   }
  70 }
  71
  72 void buffer_size_clear(void)
  73 {
  74   menu_set_jack_latency_items_sensivity(false);
  75   clear_latency_text();
  76 }
  77
  78 static void buffer_size_set(uint32_t size, bool force)
  79 {
  80   char buf[100];
  81   static uint32_t last_buffer_size;
  82
  83   if (!menu_set_jack_latency(size, force))
  84   {
  85     buffer_size_clear();
  86     return;
  87   }
  88
  89   if (size != last_buffer_size)
  90   {
  91     log_info("JACK latency changed: %"PRIu32" samples", size);
  92
  93     snprintf(buf, sizeof(buf), "%4.1f ms (%"PRIu32")", (float)size / (float)g_sample_rate * 1000.0f, size);
  94     set_latency_text(buf);
  95   }
  96   last_buffer_size = size;
  97 }
  98
  99 static void update_buffer_size(bool force)
 100 {
 101   uint32_t size;
 102
 103   if (jack_proxy_get_buffer_size(&size))
 104   {
 105     buffer_size_set(size, force);
 106   }
 107   else
 108   {
 109     buffer_size_clear();
 110   }
 111 }
 112
 113 static void update_load(void)
 114 {
 115   double load;
 116   char tmp_buf[100];
 117   uint32_t xruns;
 118
 119   if (jack_proxy_get_xruns(&xruns))
 120   {
 121     snprintf(tmp_buf, sizeof(tmp_buf), "%" PRIu32 " dropouts", xruns);
 122     set_xruns_text(tmp_buf);
 123     gtk_progress_bar_set_text(GTK_PROGRESS_BAR(g_xrun_progress_bar), tmp_buf);
 124   }
 125   else
 126   {
 127     gtk_progress_bar_set_text(GTK_PROGRESS_BAR(g_xrun_progress_bar), "error");
 128     gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(g_xrun_progress_bar), 0.0);
 129     set_xruns_text("?");
 130   }
 131
 132   if (jack_proxy_get_dsp_load(&load))
 133   {
 134     if (load > g_jack_max_dsp_load)
 135     {
 136       g_jack_max_dsp_load = load;
 137       gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(g_xrun_progress_bar), load / 100.0);
 138     }
 139
 140     snprintf(tmp_buf, sizeof(tmp_buf), "DSP: %5.1f%% (%5.1f%%)", (float)load, (float)g_jack_max_dsp_load);
 141     set_dsp_load_text(tmp_buf);
 142   }
 143   else
 144   {
 145     set_xruns_text("?");
 146   }
 147
 148   if ((g_xruns == 0 && xruns != 0) || (g_xruns != 0 && xruns == 0))
 149   {
 150     g_xruns = xruns;
 151     studio_state_changed(NULL);
 152   }
 153   else
 154   {
 155     g_xruns = xruns;
 156   }
 157 }
 158
 159 static gboolean poll_jack(gpointer data)
 160 {
 161   update_load();
 162   update_buffer_size(false);
 163
 164   return TRUE;
 165 }
 166
 167 static void jack_appeared(void)
 168 {
 169   log_info("JACK appeared");
 170
 171   g_jack_state = JACK_STATE_STOPPED;
 172   studio_state_changed(NULL);
 173   update_raw_jack_visibility();
 174 }
 175
 176 static void jack_started(void)
 177 {
 178   log_info("JACK started");
 179
 180   g_jack_state = JACK_STATE_STARTED;
 181   studio_state_changed(NULL);
 182
 183   menu_set_jack_latency_items_sensivity(true);
 184   update_buffer_size(true);
 185   enable_action(g_clear_xruns_and_max_dsp_action);
 186
 187   g_jack_poll_source_tag = g_timeout_add(100, poll_jack, NULL);
 188 }
 189
 190 static void jack_stopped(void)
 191 {
 192   if (g_jack_state == JACK_STATE_STARTED)
 193   {
 194     log_info("JACK stopped");
 195
 196     g_source_remove(g_jack_poll_source_tag);
 197   }
 198
 199   g_jack_state = JACK_STATE_STOPPED;
 200   studio_state_changed(NULL);
 201
 202   menu_set_jack_latency_items_sensivity(false);
 203   buffer_size_clear();
 204   disable_action(g_clear_xruns_and_max_dsp_action);
 205   gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(g_xrun_progress_bar), 0.0);
 206 }
 207
 208 static void jack_disappeared(void)
 209 {
 210   log_info("JACK disappeared");
 211
 212   jack_stopped();
 213
 214   g_jack_state = JACK_STATE_NA;
 215   studio_state_changed(NULL);
 216   update_raw_jack_visibility();
 217 }
 218
 219 void clear_xruns_and_max_dsp(void)
 220 {
 221   log_info("clearing xruns and max dsp load");
 222   jack_proxy_reset_xruns();
 223   g_jack_max_dsp_load = 0.0;
 224 }
 225
 226 void menu_request_jack_latency_change(uint32_t buffer_size)
 227 {
 228   log_info("JACK latency change request: %"PRIu32" samples", buffer_size);
 229
 230   if (!jack_proxy_set_buffer_size(buffer_size))
 231   {
 232     log_error("cannot set JACK buffer size");
 233   }
 234 }
 235
 236 void menu_request_jack_configure(void)
 237 {
 238   GError * error_ptr;
 239   gchar * argv[] = {"ladiconf", NULL};
 240   GtkWidget * dialog;
 241
 242   log_info("JACK configure request");
 243
 244   error_ptr = NULL;
 245   if (!g_spawn_async(
 246         NULL,                   /* working directory */
 247         argv,
 248         NULL,                   /* envp */
 249         G_SPAWN_SEARCH_PATH,    /* flags */
 250         NULL,                   /* child_setup callback */
 251         NULL,                   /* user_data */
 252         NULL,
 253         &error_ptr))
 254   {
 255     dialog = get_gtk_builder_widget("error_dialog");
 256     gtk_message_dialog_set_markup(GTK_MESSAGE_DIALOG(dialog), "<b><big>Error executing ladiconf.\nAre LADI Tools installed?</big></b>");
 257     gtk_message_dialog_format_secondary_markup(GTK_MESSAGE_DIALOG(dialog), "%s", error_ptr->message);
 258     gtk_widget_show(dialog);
 259     gtk_dialog_run(GTK_DIALOG(dialog));
 260     gtk_widget_hide(dialog);
 261     g_error_free(error_ptr);
 262   }
 263 }
 264
 265 void menu_request_toggle_raw_jack(bool visible)
 266 {
 267   //log_info("toogle raw jack visibility -> %s", visible ? "visible" : "invisible");
 268   g_jack_view_enabled = visible;
 269   update_raw_jack_visibility();
 270 }
 271
 272 void init_jack_widgets(void)
 273 {
 274   g_xrun_progress_bar = get_gtk_builder_widget("xrun_progress_bar");
 275 }
 276
 277 bool init_jack(void)
 278 {
 279   return jack_proxy_init(jack_started, jack_stopped, jack_appeared, jack_disappeared);
 280 }
 281
 282 void uninit_jack(void)
 283 {
 284   jack_proxy_uninit();
 285 }
 286
 287 bool jack_xruns(void)
 288 {
 289   return g_xruns != 0;
 290 }
 291
 292 void set_xrun_progress_bar_text(const char * text)
 293 {
 294   gtk_progress_bar_set_text(GTK_PROGRESS_BAR(g_xrun_progress_bar), text);
 295
 296   /* workaround a bug in GtkProgressBar. it needs fraction change in order to redraw the changed text
 297    * GtkProgressBar tracks the dirty state and it is checked before painting, so sending redraw request
 298    * through gtk_widget_queue_draw() will not help because expose handler will ignore the redraw request */
 299   gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(g_xrun_progress_bar), 1.0);
 300   gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(g_xrun_progress_bar), 0.0);
 301 }
 302
 303 void update_jack_sample_rate(void)
 304 {
 305   if (jack_proxy_sample_rate(&g_sample_rate))
 306   {
 307     char buf[100];
 308
 309     if (fmod(g_sample_rate, 1000.0) != 0.0)
 310     {
 311       snprintf(buf, sizeof(buf), "%.1f kHz", (float)g_sample_rate / 1000.0f);
 312     }
 313     else
 314     {
 315       snprintf(buf, sizeof(buf), "%u kHz", g_sample_rate / 1000);
 316     }
 317
 318     set_sample_rate_text(buf);
 319   }
 320   else
 321   {
 322     clear_sample_rate_text();
 323   }
 324 }
 325
 326 unsigned int get_jack_state(void)
 327 {
 328   return g_jack_state;
 329 }