src/tX_engine.cc

   1 /*
   2     terminatorX - realtime audio scratching software
   3     Copyright (C) 1999-2003  Alexander König
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19     File: tX_engine.c
  20
  21     Description: Contains the code that does the real "Scratching
  22                  business": XInput, DGA, Mouse and Keyboardgrabbing
  23                  etc.
  24
  25     02 Jun 1999: Implemented high-priority/rt-FIFO-Scheduling use for
  26                  engine-thread.
  27
  28     04 Jun 1999: Changed warp-feature behaviour: still connected to
  29                  mouse-speed (should be changed to maybe) but now
  30                  depends on sample size -> you can warp through all
  31                  samples with the same mouse-distance.
  32
  33     12 Aug 2002: Complete rewrite - tX_engine is now a class and the thread
  34         is created on startup and kept alive until termination
  35 */
  36
  37 #include <config.h>
  38 #include "tX_types.h"
  39 #include "tX_engine.h"
  40 #include "tX_audiodevice.h"
  41 #include "tX_mouse.h"
  42 #include "tX_vtt.h"
  43 #include <pthread.h>
  44 #include <gtk/gtk.h>
  45 #include <gdk/gdkprivate.h>
  46 #include "tX_mastergui.h"
  47 #include "tX_global.h"
  48 #include "tX_tape.h"
  49 #include "tX_widget.h"
  50 #include <config.h>
  51 #include "tX_sequencer.h"
  52 #include <errno.h>
  53
  54 #include <sys/time.h>
  55 #include <sys/resource.h>
  56
  57 tX_engine *tX_engine :: engine=NULL;
  58
  59 tX_engine *tX_engine :: get_instance() {
  60         if (!engine) {
  61                 engine=new tX_engine();
  62         }
  63
  64         return engine;
  65 }
  66
  67 void tX_engine :: set_grab_request() {
  68         grab_request=true;
  69 }
  70
  71 int16_t* tX_engine :: render_cycle() {
  72         /* Checking whether to grab or not  */
  73         if (grab_request!=grab_active) {
  74                 if (grab_request) {
  75                         /* Activating grab... */
  76                         int result=mouse->grab();
  77                         if (result!=0) {
  78                                 tX_error("tX_engine::loop(): failed to grab mouse - error %i", result);
  79                                 grab_active=false;
  80                                 /* Reseting grab_request, too - doesn't help keeping it, does it ? ;) */
  81                                 grab_request=false;
  82                                 mouse->ungrab();
  83                                 grab_off();
  84                         } else {
  85                                 grab_active=true;
  86                         }
  87                 } else {
  88                         /* Deactivating grab... */
  89                         mouse->ungrab();
  90                         grab_active=false;
  91                         grab_off(); // for the mastergui this is...
  92                 }
  93         }
  94
  95         /* Handling input events... */
  96         if (grab_active) {
  97                 if (mouse->check_event()) {
  98                         /* If we're here the user pressed ESC */
  99                         grab_request=false;
 100                 }
 101         }
 102
 103         /* Forward the sequencer... */
 104         sequencer.step();
 105
 106         /* Render the next block... */
 107         int16_t *data=vtt_class::render_all_turntables();
 108
 109         /* Record the audio if necessary... */
 110         if (is_recording()) tape->eat(data);
 111
 112         return  data;
 113 }
 114
 115 void tX_engine :: loop() {
 116         while (!thread_terminate) {
 117                 /* Waiting for the trigger */
 118                 pthread_mutex_lock(&start);
 119                 loop_is_active=true;
 120                 pthread_mutex_unlock(&start);
 121
 122                 if (!stop_flag) device->start(); // Hand flow control over to the device
 123
 124                 /* Stopping engine... */
 125                 loop_is_active=false;
 126         }
 127 }
 128
 129
 130 void *engine_thread_entry(void *engine_void) {
 131         tX_engine *engine=(tX_engine*) engine_void;
 132         int result;
 133
 134         /* Dropping root privileges for the engine thread - if running suid. */
 135
 136         if ((!geteuid()) && (getuid() != geteuid())) {
 137                 tX_debug("engine_thread_entry() - Running suid root - dropping privileges.");
 138
 139                 result=setuid(getuid());
 140
 141                 if (result!=0) {
 142                         tX_error("engine_thread_entry() - Failed to drop root privileges.");
 143                         exit(2);
 144                 }
 145         }
 146
 147         engine->loop();
 148
 149         tX_debug("engine_thread_entry() - Engine thread terminating.");
 150
 151         pthread_exit(NULL);
 152 }
 153
 154 tX_engine :: tX_engine() {
 155         int result;
 156
 157         pthread_mutex_init(&start, NULL);
 158         pthread_mutex_lock(&start);
 159         thread_terminate=false;
 160
 161         /* Creating the actual engine thread.. */
 162 #ifdef USE_SCHEDULER
 163         if (!geteuid()) {
 164                 pthread_attr_t pattr;
 165                 struct sched_param sparm;
 166
 167                 tX_debug("tX_engine() - Have root privileges - using SCHED_FIFO.");
 168
 169                 pthread_attr_init(&pattr);
 170                 pthread_attr_setdetachstate(&pattr, PTHREAD_CREATE_JOINABLE);
 171                 pthread_attr_setschedpolicy(&pattr, SCHED_FIFO);
 172
 173                 sched_getparam(getpid(), &sparm);
 174                 sparm.sched_priority=sched_get_priority_max(SCHED_FIFO);
 175
 176                 pthread_attr_setschedparam(&pattr, &sparm);
 177                 pthread_attr_setinheritsched(&pattr, PTHREAD_EXPLICIT_SCHED);
 178                 pthread_attr_setscope(&pattr, PTHREAD_SCOPE_SYSTEM);
 179
 180                 result=pthread_create(&thread, &pattr, engine_thread_entry, (void *) this);
 181         } else {
 182                 tX_debug("tX_engine() - Lacking root privileges - no realtime scheduling!");
 183 #endif
 184                 result=pthread_create(&thread, NULL, engine_thread_entry, (void *) this);
 185 #ifdef USE_SCHEDULER
 186         }
 187 #endif
 188
 189         if (result!=0) {
 190                 tX_error("tX_engine() - Failed to create engine thread. Errno is %i.", errno);
 191                 exit(1);
 192         }
 193
 194         /* Dropping root privileges for the main thread - if running suid. */
 195
 196         if ((!geteuid()) && (getuid() != geteuid())) {
 197                 tX_debug("tX_engine() - Running suid root - dropping privileges.");
 198
 199                 result=setuid(getuid());
 200
 201                 if (result!=0) {
 202                         tX_error("tX_engine() - Failed to drop root privileges.");
 203                         exit(2);
 204                 }
 205         }
 206
 207         mouse=new tx_mouse();
 208 #ifdef USE_ALSA_MIDI_IN
 209         midi=new tX_midiin();
 210 #endif
 211         tape=new tx_tapedeck();
 212
 213         device=NULL;
 214         recording=false;
 215         recording_request=false;
 216         loop_is_active=false;
 217         grab_request=false;
 218         grab_active=false;
 219 }
 220
 221 void tX_engine :: set_recording_request (bool recording) {
 222         this->recording_request=recording;
 223 }
 224
 225 tX_engine_error tX_engine :: run() {
 226         list <vtt_class *> :: iterator vtt;
 227
 228         if (loop_is_active) return ERROR_BUSY;
 229
 230         switch (globals.audiodevice_type) {
 231 #ifdef USE_OSS
 232                 case OSS:
 233                         device=new tX_audiodevice_oss();
 234                 break;
 235 #endif
 236
 237 #ifdef USE_ALSA
 238                 case ALSA:
 239                         device=new tX_audiodevice_alsa();
 240                 break;
 241 #endif
 242
 243                 default:
 244                         device=NULL; return ERROR_AUDIO;
 245         }
 246
 247         if (device->open()) {
 248                 if (device->get_is_open()) device->close();
 249                 delete device;
 250                 device=NULL;
 251                 return ERROR_AUDIO;
 252         }
 253
 254         vtt_class::set_sample_rate(device->get_sample_rate());
 255
 256         if (recording_request) {
 257                 if (tape->start_record(globals.record_filename, vtt_class::get_mix_buffer_size(), device->get_sample_rate())) {
 258                         device->close();
 259                         delete device;
 260                         device=NULL;
 261                         return ERROR_TAPE;
 262                 } else {
 263                         recording=true;
 264                 }
 265         }
 266
 267         for (vtt=vtt_class::main_list.begin(); vtt!=vtt_class::main_list.end(); vtt++) {
 268                 if ((*vtt)->autotrigger) (*vtt)->trigger();
 269         }
 270
 271         sequencer.forward_to_start_timestamp(1);
 272         stop_flag=false;
 273         /* Trigger the engine thread... */
 274         pthread_mutex_unlock(&start);
 275
 276         return NO_ERROR;
 277 }
 278
 279 void tX_engine :: stop() {
 280         list <vtt_class *> :: iterator vtt;
 281
 282         if (!loop_is_active) {
 283                 tX_error("tX_engine::stop() - but loop's not running?");
 284         }
 285
 286         pthread_mutex_lock(&start);
 287         stop_flag=true;
 288
 289         tX_debug("tX_engine::stop() - waiting for loop to stop.");
 290
 291         while (loop_is_active) {
 292                 /* Due to gtk+ signal handling this can cause a deadlock
 293                    on the seqpars' update list. So we need to handle events
 294                    while waiting...
 295                 */
 296                 while (gtk_events_pending()) gtk_main_iteration();
 297                 usleep(50);
 298         }
 299
 300         tX_debug("tX_engine::stop() - loop has stopped.");
 301
 302         if (device->get_is_open()) device->close();
 303         delete device;
 304         device=NULL;
 305
 306         for (vtt=vtt_class::main_list.begin(); vtt!=vtt_class::main_list.end(); vtt++) {
 307                 (*vtt)->stop();
 308                 (*vtt)->ec_clear_buffer();
 309         }
 310
 311         if (is_recording()) tape->stop_record();
 312         recording=false;
 313 }
 314
 315 tX_engine :: ~tX_engine() {
 316         void *dummy;
 317
 318         thread_terminate=true;
 319         stop_flag=true;
 320         pthread_mutex_unlock(&start);
 321         tX_debug("~tX_engine() - Waiting for engine thread to terminate.");
 322         pthread_join(thread, &dummy);
 323
 324         delete mouse;
 325         delete midi;
 326         delete tape;
 327 }