Adding support for Linux' POSIX capabilities - Alex
[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::loop(): 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         pid_t pid=getpid();
160         tX_engine::get_instance()->set_pid(pid);
161
162 #ifdef USE_SCHEDULER
163 #ifdef USE_CAPABILITIES
164         if (have_nice_capability()) {
165                 if (globals.use_realtime) {
166                         struct sched_param parm;
167         
168                         sched_getparam(pid, &parm);
169                         parm.sched_priority=sched_get_priority_max(SCHED_FIFO);
170                         if (sched_setscheduler(pid, SCHED_FIFO, &parm)) {
171                                 tX_error("engine_thread_entry(): failed to set realtime priority.");
172                         }
173                 }
174         } else {
175                 tX_warning("engine_thread_entry(): can't set SCHED_FIFO -> lacking capabilities.");
176         }
177 #endif //USE_CAPABILITIES
178         
179         if (sched_getscheduler(pid)!=SCHED_FIFO) {
180                 tX_warning("engine_thread_entry() - engine has no realtime priority scheduling.");
181         }
182 #endif //USE_SCHEDULER
183                 
184 #ifdef USE_JACK
185         /* Create the client now, so the user has something to connect to. */
186         tX_jack_client::get_instance();
187 #endif  
188         
189         engine->loop();
190         
191         tX_debug("engine_thread_entry() - Engine thread terminating.");
192         
193         pthread_exit(NULL);
194 }
195
196 tX_engine :: tX_engine() {
197         int result;
198         
199         pthread_mutex_init(&start, NULL);
200         pthread_mutex_lock(&start);
201         thread_terminate=false;
202         pid=0;
203         
204         /* Creating the actual engine thread.. */
205 #ifdef USE_SCHEDULER    
206         if (!geteuid() && globals.use_realtime) {
207                 pthread_attr_t pattr;
208                 struct sched_param sparm;
209                 
210                 tX_debug("tX_engine() - Have root privileges - using SCHED_FIFO.");
211                 
212                 pthread_attr_init(&pattr);
213                 pthread_attr_setdetachstate(&pattr, PTHREAD_CREATE_JOINABLE);
214                 pthread_attr_setschedpolicy(&pattr, SCHED_FIFO);
215         
216                 sched_getparam(getpid(), &sparm);
217                 sparm.sched_priority=sched_get_priority_max(SCHED_FIFO);
218         
219                 pthread_attr_setschedparam(&pattr, &sparm);
220                 pthread_attr_setinheritsched(&pattr, PTHREAD_EXPLICIT_SCHED);
221                 pthread_attr_setscope(&pattr, PTHREAD_SCOPE_SYSTEM);
222                 
223                 result=pthread_create(&thread, &pattr, engine_thread_entry, (void *) this);
224         } else {
225 #endif // USE_SCHEDULER
226                 result=pthread_create(&thread, NULL, engine_thread_entry, (void *) this);
227 #ifdef USE_SCHEDULER            
228         }
229 #endif
230         
231         if (result!=0) {
232                 tX_error("tX_engine() - Failed to create engine thread. Errno is %i.", errno);
233                 exit(1);
234         }
235         
236         /* Dropping root privileges for the main thread - if running suid. */
237         
238         if ((!geteuid()) && (getuid() != geteuid())) {
239                 tX_debug("tX_engine() - Running suid root - dropping privileges.");
240                 
241                 result=setuid(getuid());
242                 
243                 if (result!=0) {
244                         tX_error("tX_engine() - Failed to drop root privileges.");
245                         exit(2);
246                 }
247         }
248         
249         mouse=new tx_mouse();
250 #ifdef USE_ALSA_MIDI_IN 
251         midi=new tX_midiin();
252 #endif  
253         tape=new tx_tapedeck();
254
255         device=NULL;
256         recording=false;
257         recording_request=false;
258         loop_is_active=false;
259         grab_request=false;
260         grab_active=false;
261 }
262
263 void tX_engine :: set_recording_request (bool recording) {
264         this->recording_request=recording;
265 }
266
267 tX_engine_error tX_engine :: run() {
268         list <vtt_class *> :: iterator vtt;
269         
270         if (loop_is_active) return ERROR_BUSY;
271         
272         switch (globals.audiodevice_type) {
273 #ifdef USE_OSS  
274                 case OSS:
275                         device=new tX_audiodevice_oss(); 
276                 break;
277 #endif                  
278
279 #ifdef USE_ALSA                 
280                 case ALSA:
281                         device=new tX_audiodevice_alsa(); 
282                 break;
283 #endif
284
285 #ifdef USE_JACK
286                 case JACK:
287                         device=new tX_audiodevice_jack();
288                 break;
289 #endif
290                 
291                 default:
292                         device=NULL; return ERROR_AUDIO;
293         }
294         
295         if (device->open()) {
296                 if (device->get_is_open()) device->close();
297                 delete device;
298                 device=NULL;            
299                 return ERROR_AUDIO;
300         }       
301
302         vtt_class::set_sample_rate(device->get_sample_rate());
303         
304         if (recording_request) {
305                 if (tape->start_record(globals.record_filename, vtt_class::get_mix_buffer_size(), device->get_sample_rate())) {
306                         device->close();
307                         delete device;
308                         device=NULL;                    
309                         return ERROR_TAPE;                      
310                 } else {
311                         recording=true;
312                 }
313         }
314         
315         for (vtt=vtt_class::main_list.begin(); vtt!=vtt_class::main_list.end(); vtt++) {
316                 (*vtt)->sync_countdown=0;
317                 if ((*vtt)->autotrigger) (*vtt)->trigger();
318         }
319
320         sequencer.forward_to_start_timestamp(1);        
321         stop_flag=false;
322         /* Trigger the engine thread... */
323         pthread_mutex_unlock(&start);
324         
325         return NO_ERROR;
326 }
327
328 void tX_engine :: stop() {
329         list <vtt_class *> :: iterator vtt;
330         
331         if (!loop_is_active) {
332                 tX_error("tX_engine::stop() - but loop's not running?");
333         }
334         
335         pthread_mutex_lock(&start);
336         stop_flag=true;
337         
338         tX_debug("tX_engine::stop() - waiting for loop to stop.");
339         
340         while (loop_is_active) {
341                 /* Due to gtk+ signal handling this can cause a deadlock
342                    on the seqpars' update list. So we need to handle events
343                    while waiting...                     
344                 */
345                 while (gtk_events_pending()) gtk_main_iteration();
346                 usleep(50);
347         }
348         
349         tX_debug("tX_engine::stop() - loop has stopped.");
350
351         if (device->get_is_open()) device->close();
352         delete device;
353         device=NULL;
354         
355         for (vtt=vtt_class::main_list.begin(); vtt!=vtt_class::main_list.end(); vtt++) {
356                 (*vtt)->stop();
357                 (*vtt)->ec_clear_buffer();
358         }
359         
360         if (is_recording()) tape->stop_record();
361         recording=false;
362 }
363
364 tX_engine :: ~tX_engine() {
365         void *dummy;
366                 
367         thread_terminate=true;
368         stop_flag=true;
369         pthread_mutex_unlock(&start);
370         tX_debug("~tX_engine() - Waiting for engine thread to terminate.");
371         pthread_join(thread, &dummy);   
372         
373         delete mouse;
374 #ifdef USE_ALSA_MIDI_IN         
375         delete midi;
376 #endif  
377         delete tape;    
378 }