b839a841a8c2bd9e08ed583f68c198065ee559fa
[terminatorX.git] / 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 #include <sched.h>
54 #include "tX_capabilities.h"
55
56 #include <sys/time.h>
57 #include <sys/resource.h>
58
59 tX_engine *tX_engine::engine=NULL;
60
61 tX_engine *tX_engine::get_instance() {
62         if (!engine) {
63                 engine=new tX_engine();
64         }
65         
66         return engine;
67 }
68
69 void tX_engine::set_grab_request() {
70         grab_request=true;
71 }
72
73 int16_t* tX_engine::render_cycle() {
74         /* Checking whether to grab or not  */
75         if (grab_request!=grab_active) {
76                 if (grab_request) {
77                         /* Activating grab... */
78                         int result=mouse->grab(); 
79                         if (result!=0) {
80                                 tX_error("tX_engine::render_cycle(): failed to grab mouse - error %i", result);
81                                 grab_active=false;
82                                 /* Reseting grab_request, too - doesn't help keeping it, does it ? ;) */
83                                 grab_request=false;
84                                 mouse->ungrab();
85                                 grab_off();
86                         } else {
87                                 grab_active=true;
88                         }
89                 } else {
90                         /* Deactivating grab... */
91                         mouse->ungrab();
92                         grab_active=false;
93                         grab_off(); // for the mastergui this is...
94                 }
95         }
96
97         /* Handling input events... */
98         if (grab_active) {
99                 if (mouse->check_event()) {
100                         /* If we're here the user pressed ESC */
101                         grab_request=false;
102                 }
103         }
104
105         /* Forward the sequencer... */
106         sequencer.step();
107
108         /* Render the next block... */
109         int16_t *data=vtt_class::render_all_turntables();
110         
111         /* Record the audio if necessary... */
112         if (is_recording()) tape->eat(data);
113         
114         return  data;
115 }
116
117 void tX_engine::loop() {
118         while (!thread_terminate) {
119                 /* Waiting for the trigger */
120                 pthread_mutex_lock(&start);
121                 loop_is_active=true;
122                 pthread_mutex_unlock(&start);
123
124                 if (!stop_flag) device->start(); // Hand flow control over to the device
125                 
126                 /* Stopping engine... */
127                 loop_is_active=false;
128         }
129 }
130
131 void *engine_thread_entry(void *engine_void) {
132         tX_engine *engine=(tX_engine*) engine_void;
133         int result;
134         
135         /* Dropping root privileges for the engine thread - if running suid. */
136         
137         if ((!geteuid()) && (getuid() != geteuid())) {
138 #ifdef USE_CAPABILITIES
139                 tX_error("engine_thread_entry(): using capabilities but still suid root?");
140                 tX_error("engine_thread_entry(): Please report this.");
141                 exit(-1);
142 #endif
143                 
144 #ifndef ALLOW_SUID_ROOT
145                 tX_error("This binary doesn't support running suid-root.");
146                 tX_error("Reconfigure with --enable-suidroot if you really want that.");
147                 exit(-1);
148 #endif          
149                 tX_debug("engine_thread_entry() - Running suid root - dropping privileges.");
150                 
151                 result=setuid(getuid());
152                 
153                 if (result!=0) {
154                         tX_error("engine_thread_entry() - Failed to drop root privileges.");
155                         exit(2);
156                 }
157         }
158
159 #ifdef USE_SCHEDULER
160         pid_t pid=getpid();
161         struct sched_param parm;
162
163 #ifdef USE_CAPABILITIES
164         if (have_nice_capability()) {
165                 if (globals.use_realtime) {
166                         sched_getparam(pid, &parm);
167                         parm.sched_priority=sched_get_priority_max(SCHED_FIFO);
168                                                 
169                         if (pthread_setschedparam(pthread_self(), SCHED_FIFO, &parm)) {
170                                 tX_error("engine_thread_entry(): failed to set realtime priority.");
171                         } else {
172                                 tX_debug("engine_thread_entry(): set SCHED_FIFO via capabilities.");
173                         }
174                 }
175         } else {
176                 tX_warning("engine_thread_entry(): can't set SCHED_FIFO -> lacking capabilities.");
177         }
178 #endif //USE_CAPABILITIES
179         int policy=0;
180         
181         pthread_getschedparam(pthread_self(), &policy, &parm);
182         if (policy!=SCHED_FIFO) {
183                 tX_warning("engine_thread_entry() - engine has no realtime priority scheduling.");
184         }
185 #endif //USE_SCHEDULER
186                 
187 #ifdef USE_JACK
188         /* Create the client now, so the user has something to connect to. */
189         tX_jack_client::get_instance();
190 #endif  
191
192 #ifdef USE_SCHEDULER
193         tX_debug("engine_thread_entry() engine thread is p: %i, t: %i and has policy %i.", getpid(), pthread_self(), sched_getscheduler(getpid()));
194 #endif
195         
196         engine->loop();
197         
198         tX_debug("engine_thread_entry() engine thread terminating.");
199         
200         pthread_exit(NULL);
201 }
202
203 tX_engine :: tX_engine() {
204         int result;
205         
206         pthread_mutex_init(&start, NULL);
207         pthread_mutex_lock(&start);
208         thread_terminate=false;
209         
210         /* Creating the actual engine thread.. */
211 #ifdef USE_SCHEDULER    
212         if (!geteuid() && globals.use_realtime) {
213                 pthread_attr_t pattr;
214                 struct sched_param sparm;
215                 
216                 tX_debug("tX_engine() - setting SCHED_FIFO.");
217                 
218                 pthread_attr_init(&pattr);
219                 pthread_attr_setdetachstate(&pattr, PTHREAD_CREATE_JOINABLE);
220                 pthread_attr_setschedpolicy(&pattr, SCHED_FIFO);
221         
222                 sched_getparam(getpid(), &sparm);
223                 sparm.sched_priority=sched_get_priority_max(SCHED_FIFO);
224         
225                 pthread_attr_setschedparam(&pattr, &sparm);
226                 pthread_attr_setinheritsched(&pattr, PTHREAD_EXPLICIT_SCHED);
227                 pthread_attr_setscope(&pattr, PTHREAD_SCOPE_SYSTEM);
228                 
229                 result=pthread_create(&thread, &pattr, engine_thread_entry, (void *) this);
230         } else {
231 #endif // USE_SCHEDULER
232                 result=pthread_create(&thread, NULL, engine_thread_entry, (void *) this);
233 #ifdef USE_SCHEDULER            
234         }
235 #endif
236         
237         if (result!=0) {
238                 tX_error("tX_engine() - Failed to create engine thread. Errno is %i.", errno);
239                 exit(1);
240         }
241         
242         /* Dropping root privileges for the main thread - if running suid. */
243         
244         if ((!geteuid()) && (getuid() != geteuid())) {
245                 tX_debug("tX_engine() - Running suid root - dropping privileges.");
246                 
247                 result=setuid(getuid());
248                 
249                 if (result!=0) {
250                         tX_error("tX_engine() - Failed to drop root privileges.");
251                         exit(2);
252                 }
253         }
254         
255         mouse=new tx_mouse();
256 #ifdef USE_ALSA_MIDI_IN 
257         midi=new tX_midiin();
258 #endif  
259         tape=new tx_tapedeck();
260
261         device=NULL;
262         recording=false;
263         recording_request=false;
264         loop_is_active=false;
265         grab_request=false;
266         grab_active=false;
267 }
268
269 void tX_engine :: set_recording_request (bool recording) {
270         this->recording_request=recording;
271 }
272
273 tX_engine_error tX_engine :: run() {
274         list <vtt_class *> :: iterator vtt;
275         
276         if (loop_is_active) return ERROR_BUSY;
277         
278         switch (globals.audiodevice_type) {
279 #ifdef USE_OSS  
280                 case OSS:
281                         device=new tX_audiodevice_oss(); 
282                 break;
283 #endif                  
284
285 #ifdef USE_ALSA                 
286                 case ALSA:
287                         device=new tX_audiodevice_alsa(); 
288                 break;
289 #endif
290
291 #ifdef USE_JACK
292                 case JACK:
293                         device=new tX_audiodevice_jack();
294                 break;
295 #endif
296                 
297                 default:
298                         device=NULL; return ERROR_AUDIO;
299         }
300         
301         if (device->open()) {
302                 if (device->get_is_open()) device->close();
303                 delete device;
304                 device=NULL;            
305                 return ERROR_AUDIO;
306         }       
307
308         vtt_class::set_sample_rate(device->get_sample_rate());
309         
310         if (recording_request) {
311                 if (tape->start_record(globals.record_filename, vtt_class::get_mix_buffer_size(), device->get_sample_rate())) {
312                         device->close();
313                         delete device;
314                         device=NULL;                    
315                         return ERROR_TAPE;                      
316                 } else {
317                         recording=true;
318                 }
319         }
320         
321         for (vtt=vtt_class::main_list.begin(); vtt!=vtt_class::main_list.end(); vtt++) {
322                 (*vtt)->sync_countdown=0;
323                 if ((*vtt)->autotrigger) (*vtt)->trigger();
324         }
325
326         sequencer.forward_to_start_timestamp(1);        
327         stop_flag=false;
328         /* Trigger the engine thread... */
329         pthread_mutex_unlock(&start);
330         
331         return NO_ERROR;
332 }
333
334 void tX_engine :: stop() {
335         list <vtt_class *> :: iterator vtt;
336         
337         if (!loop_is_active) {
338                 tX_error("tX_engine::stop() - but loop's not running?");
339         }
340         
341         pthread_mutex_lock(&start);
342         stop_flag=true;
343         
344         tX_debug("tX_engine::stop() - waiting for loop to stop.");
345         
346         while (loop_is_active) {
347                 /* Due to gtk+ signal handling this can cause a deadlock
348                    on the seqpars' update list. So we need to handle events
349                    while waiting...                     
350                 */
351                 while (gtk_events_pending()) gtk_main_iteration();
352                 usleep(50);
353         }
354         
355         tX_debug("tX_engine::stop() - loop has stopped.");
356
357         if (device->get_is_open()) device->close();
358         delete device;
359         device=NULL;
360         
361         for (vtt=vtt_class::main_list.begin(); vtt!=vtt_class::main_list.end(); vtt++) {
362                 (*vtt)->stop();
363                 (*vtt)->ec_clear_buffer();
364         }
365         
366         if (is_recording()) tape->stop_record();
367         recording=false;
368 }
369
370 tX_engine :: ~tX_engine() {
371         void *dummy;
372                 
373         thread_terminate=true;
374         stop_flag=true;
375         pthread_mutex_unlock(&start);
376         tX_debug("~tX_engine() - Waiting for engine thread to terminate.");
377         pthread_join(thread, &dummy);   
378         
379         delete mouse;
380 #ifdef USE_ALSA_MIDI_IN         
381         delete midi;
382 #endif  
383         delete tape;    
384 }