Fixes and startup-notification - Alex
[terminatorX.git] / src / tX_engine.cc
1 /*
2     terminatorX - realtime audio scratching software
3     Copyright (C) 1999-2004  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();
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         /* check for GUI thread starvation */
115 //      if (cycles_ctr++ > 100) {
116 //              tX_error("engine detected overload condition.");
117 //              overload_error=true;
118 //              stop_flag=true;
119                 // give the audio thread some air to breathe
120                 // so it can acquire the mutex
121 //              usleep(500);
122 //      }
123         
124         return  data;
125 }
126
127 void tX_engine::loop() {
128         while (!thread_terminate) {
129                 /* Waiting for the trigger */
130                 pthread_mutex_lock(&start);
131                 reset_cycles_ctr();
132                 
133 #ifdef USE_SCHEDULER
134                 pid_t pid=getpid();
135                 struct sched_param parm;
136                         
137                 if (globals.use_realtime && (globals.audiodevice_type!=JACK)) {
138                         sched_getparam(pid, &parm);
139                         parm.sched_priority=sched_get_priority_max(SCHED_FIFO);
140                                                 
141                         if (pthread_setschedparam(pthread_self(), SCHED_FIFO, &parm)) {
142                                 tX_msg("loop(): failed to set realtime priority.");
143                         } else {
144                                 tX_debug("loop(): set SCHED_FIFO.");
145                         }
146                 } else {
147                         sched_getparam(pid, &parm);
148                         parm.sched_priority=sched_get_priority_max(SCHED_OTHER);
149                                                 
150                         if (pthread_setschedparam(pthread_self(), SCHED_OTHER, &parm)) {
151                                 tX_msg("loop(): failed to set non-realtime priority.");
152                         } else {
153                                 tX_debug("loop(): set SCHED_OTHER.");
154                         }                       
155                 }
156 #endif          
157                 loop_is_active=true;
158                 pthread_mutex_unlock(&start);
159
160                 if (!stop_flag) device->start(); // Hand flow control over to the device
161
162                 // in case we got kicked out by jack we might have
163                 // to kill the mouse grab
164                 if (grab_active) {
165                         mouse->ungrab();
166                         grab_active=false;
167                         grab_off();
168                 }
169                 
170                 if (!stop_flag) {
171                         runtime_error=true;
172                         usleep(100);
173                 }
174                 /* Stopping engine... */
175                 loop_is_active=false;
176         }
177 }
178
179 void *engine_thread_entry(void *engine_void) {
180         tX_engine *engine=(tX_engine*) engine_void;
181         int result;
182         
183 #ifdef USE_SCHEDULER
184         pid_t pid=getpid();
185         struct sched_param parm;
186
187         if (globals.use_realtime) {
188                 sched_getparam(pid, &parm);
189                 parm.sched_priority=sched_get_priority_max(SCHED_FIFO);
190                                         
191                 if (pthread_setschedparam(pthread_self(), SCHED_FIFO, &parm)) {
192                         tX_warning("engine_thread_entry(): failed to set realtime priority.");
193                 } else {
194                         tX_debug("engine_thread_entry(): set SCHED_FIFO via capabilities.");
195                 }
196         }
197         int policy=0;
198 #endif //USE_SCHEDULER
199                 
200 #ifdef USE_JACK
201         /* Create the client now, so the user has something to connect to. */
202         tX_jack_client::get_instance();
203 #endif  
204         
205         engine->loop();
206         tX_debug("engine_thread_entry() engine thread terminating.");
207         pthread_exit(NULL);
208 }
209
210 tX_engine :: tX_engine() {
211         int result;
212         
213         pthread_mutex_init(&start, NULL);
214         pthread_mutex_lock(&start);
215         thread_terminate=false;
216         
217         result=pthread_create(&thread, NULL, engine_thread_entry, (void *) this);
218         
219         if (result!=0) {
220                 tX_error("tX_engine() - Failed to create engine thread. Errno is %i.", errno);
221                 exit(1);
222         }
223         
224         mouse=new tx_mouse();
225 #ifdef USE_ALSA_MIDI_IN 
226         midi=new tX_midiin();
227 #endif  
228         tape=new tx_tapedeck();
229
230         device=NULL;
231         recording=false;
232         recording_request=false;
233         loop_is_active=false;
234         grab_request=false;
235         grab_active=false;
236 }
237
238 void tX_engine :: set_recording_request (bool recording) {
239         this->recording_request=recording;
240 }
241
242 tX_engine_error tX_engine :: run() {
243         list <vtt_class *> :: iterator vtt;
244         
245         runtime_error=false;
246         overload_error=false;
247         
248         if (loop_is_active) return ERROR_BUSY;
249         
250         switch (globals.audiodevice_type) {
251 #ifdef USE_OSS  
252                 case OSS:
253                         device=new tX_audiodevice_oss(); 
254                 break;
255 #endif                  
256
257 #ifdef USE_ALSA                 
258                 case ALSA:
259                         device=new tX_audiodevice_alsa(); 
260                 break;
261 #endif
262
263 #ifdef USE_JACK
264                 case JACK:
265                         device=new tX_audiodevice_jack();
266                 break;
267 #endif
268                 
269                 default:
270                         device=NULL; return ERROR_AUDIO;
271         }
272         
273         if (device->open()) {
274                 if (device->get_is_open()) device->close();
275                 delete device;
276                 device=NULL;            
277                 return ERROR_AUDIO;
278         }       
279
280         vtt_class::set_sample_rate(device->get_sample_rate());
281         
282         if (recording_request) {
283                 if (tape->start_record(globals.record_filename, vtt_class::get_mix_buffer_size(), device->get_sample_rate())) {
284                         device->close();
285                         delete device;
286                         device=NULL;                    
287                         return ERROR_TAPE;                      
288                 } else {
289                         recording=true;
290                 }
291         }
292         
293         for (vtt=vtt_class::main_list.begin(); vtt!=vtt_class::main_list.end(); vtt++) {
294                 (*vtt)->sync_countdown=0;
295                 if ((*vtt)->autotrigger) (*vtt)->trigger();
296         }
297
298         sequencer.forward_to_start_timestamp(1);        
299         stop_flag=false;
300         /* Trigger the engine thread... */
301         pthread_mutex_unlock(&start);
302         
303         return NO_ERROR;
304 }
305
306 void tX_engine :: stop() {
307         list <vtt_class *> :: iterator vtt;
308         
309         if (!loop_is_active) {
310                 tX_error("tX_engine::stop() - but loop's not running?");
311         }
312         
313         pthread_mutex_lock(&start);
314         stop_flag=true;
315         
316         tX_debug("tX_engine::stop() - waiting for loop to stop.");
317         
318         while (loop_is_active) {
319                 /* Due to gtk+ signal handling this can cause a deadlock
320                    on the seqpars' update list. So we need to handle events
321                    while waiting...                     
322                 */
323                 while (gtk_events_pending()) gtk_main_iteration();
324                 usleep(50);
325         }
326         
327         tX_debug("tX_engine::stop() - loop has stopped.");
328
329         if (device->get_is_open()) device->close();
330         delete device;
331         device=NULL;
332         
333         for (vtt=vtt_class::main_list.begin(); vtt!=vtt_class::main_list.end(); vtt++) {
334                 (*vtt)->stop();
335                 (*vtt)->ec_clear_buffer();
336         }
337         
338         if (is_recording()) tape->stop_record();
339         recording=false;
340 }
341
342 tX_engine :: ~tX_engine() {
343         void *dummy;
344                 
345         thread_terminate=true;
346         stop_flag=true;
347         pthread_mutex_unlock(&start);
348         tX_debug("~tX_engine() - Waiting for engine thread to terminate.");
349         pthread_join(thread, &dummy);   
350         
351         delete mouse;
352 #ifdef USE_ALSA_MIDI_IN         
353         delete midi;
354 #endif  
355         delete tape;    
356 }