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