Mostly ALSA fixing - Alex
[terminatorX.git] / terminatorX / 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         int16_t *temp=NULL;
117         int result;
118         
119         while (!thread_terminate) {
120                 /* Waiting for the trigger */
121                 pthread_mutex_lock(&start);
122                 loop_is_active=true;
123                 pthread_mutex_unlock(&start);
124
125                 if (!stop_flag) device->start(); // Hand flow control over to the device
126                 
127                 /* Stopping engine... */
128                 loop_is_active=false;
129         }
130 }
131
132
133 void *engine_thread_entry(void *engine_void) {
134         tX_engine *engine=(tX_engine*) engine_void;
135         int result;
136         
137         /* Dropping root privileges for the engine thread - if running suid. */
138         
139         if ((!geteuid()) && (getuid() != geteuid())) {
140                 tX_debug("engine_thread_entry() - Running suid root - dropping privileges.");
141                 
142                 result=setuid(getuid());
143                 
144                 if (result!=0) {
145                         tX_error("engine_thread_entry() - Failed to drop root privileges.");
146                         exit(2);
147                 }
148         }
149         
150         engine->loop();
151         
152         tX_debug("engine_thread_entry() - Engine thread terminating.");
153         
154         pthread_exit(NULL);
155 }
156
157 tX_engine :: tX_engine() {
158         int result;
159         
160         pthread_mutex_init(&start, NULL);
161         pthread_mutex_lock(&start);
162         thread_terminate=false;
163         
164         /* Creating the actual engine thread.. */
165 #ifdef USE_SCHEDULER    
166         if (!geteuid()) {
167                 pthread_attr_t pattr;
168                 struct sched_param sparm;
169                 
170                 tX_debug("tX_engine() - Have root privileges - using SCHED_FIFO.");
171                 
172                 pthread_attr_init(&pattr);
173                 pthread_attr_setdetachstate(&pattr, PTHREAD_CREATE_JOINABLE);
174                 pthread_attr_setschedpolicy(&pattr, SCHED_FIFO);
175         
176                 sched_getparam(getpid(), &sparm);
177                 sparm.sched_priority=sched_get_priority_max(SCHED_FIFO);
178         
179                 pthread_attr_setschedparam(&pattr, &sparm);
180                 pthread_attr_setinheritsched(&pattr, PTHREAD_EXPLICIT_SCHED);
181                 pthread_attr_setscope(&pattr, PTHREAD_SCOPE_SYSTEM);
182                 
183                 result=pthread_create(&thread, &pattr, engine_thread_entry, (void *) this);
184         } else {
185                 tX_debug("tX_engine() - Lacking root privileges - no realtime scheduling!");
186 #endif          
187                 result=pthread_create(&thread, NULL, engine_thread_entry, (void *) this);
188 #ifdef USE_SCHEDULER            
189         }
190 #endif
191         
192         if (result!=0) {
193                 tX_error("tX_engine() - Failed to create engine thread. Errno is %i.", errno);
194                 exit(1);
195         }
196         
197         /* Dropping root privileges for the main thread - if running suid. */
198         
199         if ((!geteuid()) && (getuid() != geteuid())) {
200                 tX_debug("tX_engine() - Running suid root - dropping privileges.");
201                 
202                 result=setuid(getuid());
203                 
204                 if (result!=0) {
205                         tX_error("tX_engine() - Failed to drop root privileges.");
206                         exit(2);
207                 }
208         }
209         
210         mouse=new tx_mouse();
211 #ifdef USE_ALSA_MIDI_IN 
212         midi=new tX_midiin();
213 #endif  
214         tape=new tx_tapedeck();
215
216         device=NULL;
217         recording=false;
218         recording_request=false;
219         loop_is_active=false;
220         grab_request=false;
221         grab_active=false;
222 }
223
224 void tX_engine :: set_recording_request (bool recording) {
225         this->recording_request=recording;
226 }
227
228 tX_engine_error tX_engine :: run() {
229         list <vtt_class *> :: iterator vtt;
230         
231         if (loop_is_active) return ERROR_BUSY;
232         
233         switch (globals.audiodevice_type) {
234 #ifdef USE_OSS  
235                 case OSS:
236                         device=new tX_audiodevice_oss(); 
237                 break;
238 #endif                  
239
240 #ifdef USE_ALSA                 
241                 case ALSA:
242                         device=new tX_audiodevice_alsa(); 
243                 break;
244 #endif
245                 
246                 default:
247                         device=NULL; return ERROR_AUDIO;
248         }
249         
250         if (device->open()) {
251                 device->close();
252                 delete device;
253                 device=NULL;            
254                 return ERROR_AUDIO;
255         }       
256
257         vtt_class::set_sample_rate(device->get_sample_rate());
258         
259         if (recording_request) {
260                 if (tape->start_record(globals.record_filename, device->get_buffersize()*sizeof(int16_t), device->get_sample_rate())) {
261                         device->close();
262                         delete device;
263                         device=NULL;                    
264                         return ERROR_TAPE;                      
265                 } else {
266                         recording=true;
267                 }
268         }
269         
270         for (vtt=vtt_class::main_list.begin(); vtt!=vtt_class::main_list.end(); vtt++) {
271                 if ((*vtt)->autotrigger) (*vtt)->trigger();
272         }
273
274         sequencer.forward_to_start_timestamp(1);        
275         stop_flag=false;
276         /* Trigger the engine thread... */
277         pthread_mutex_unlock(&start);
278         
279         return NO_ERROR;
280 }
281
282 void tX_engine :: stop() {
283         list <vtt_class *> :: iterator vtt;
284         
285         if (!loop_is_active) {
286                 tX_error("tX_engine::stop() - but loop's not running?");
287         }
288         
289         pthread_mutex_lock(&start);
290         stop_flag=true;
291         
292         tX_debug("tX_engine::stop() - waiting for loop to stop.");
293         
294         while (loop_is_active) {
295                 usleep(50);
296         }
297         
298         tX_debug("tX_engine::stop() - loop has stopped.");
299
300         device->close();
301         delete device;
302         device=NULL;
303         
304         for (vtt=vtt_class::main_list.begin(); vtt!=vtt_class::main_list.end(); vtt++) {
305                 (*vtt)->stop();
306                 (*vtt)->ec_clear_buffer();
307         }
308         
309         if (is_recording()) tape->stop_record();
310         recording=false;
311 }
312
313 tX_engine :: ~tX_engine() {
314         void *dummy;
315         
316         thread_terminate=true;
317         stop_flag=true;
318         pthread_mutex_unlock(&start);
319         tX_debug("~tX_engine() - Waiting for engine thread to terminate.");
320         pthread_join(thread, &dummy);   
321 }