49ea1599dbaefdba253762ec0765d40aa62bf943
[vlc.git] / extras / MacOSX / Framework / Sources / VLCEventManager.m
1 /*****************************************************************************
2  * VLCEventManager.h: VLC.framework VLCEventManager implementation
3  * This is used to communicate in a sound way accross threads.
4  *****************************************************************************
5  * Copyright (C) 2007 Pierre d'Herbemont
6  * Copyright (C) 2007 the VideoLAN team
7  * $Id$
8  *
9  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 #import "VLCEventManager.h"
27 #import <pthread.h>
28
29 static VLCEventManager * defaultManager = NULL;
30
31 enum message_type_t
32 {
33     VLCNotification,
34     VLCObjectMethodWithObjectArg,
35     VLCObjectMethodWithArrayArg
36 };
37
38 struct message {
39     id target;
40     SEL sel;
41     union u
42     {
43         NSString * name;
44         id object;
45     } u;
46     enum message_type_t type;
47 };
48
49 @interface VLCEventManager (Private)
50 - (void)callDelegateOfObjectAndSendNotificationWithArgs:(NSData*)data;
51 - (void)callObjectMethodWithArgs:(NSData*)data;
52 - (void)callDelegateOfObject:(id) aTarget withDelegateMethod:(SEL)aSelector withNotificationName: (NSString *)aNotificationName;
53 - (pthread_cond_t *)signalData;
54 - (pthread_mutex_t *)queueLock;
55 - (NSMutableArray *)messageQueue;
56 @end
57
58 static void * EventDispatcherMainLoop(void * user_data)
59 {
60     VLCEventManager * self = user_data;
61     
62     for(;;)
63     {
64         NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
65         struct message * message, * message_newer = NULL;
66         NSData * dataMessage;
67         int i;
68
69         /* Sleep a bit not to flood the interface */
70         msleep(300);
71         /* Wait for some data */
72
73         pthread_mutex_lock( [self queueLock] );
74         /* Wait until we have something on the queue */
75         while( [[self messageQueue] count] <= 0 )
76         {
77             pthread_cond_wait( [self signalData], [self queueLock] );
78         }
79
80         //if( [[self messageQueue] count] % 100 == 0 || [[self messageQueue] count] < 100 )
81           //  NSLog(@"[EVENT_MANAGER] On the stack we have %d elements", [[self messageQueue] count]);
82
83         message = (struct message *)[(NSData *)[[self messageQueue] lastObject] bytes];
84         
85         /* Don't send the same notification twice */
86         if( message->type == VLCNotification )
87         {
88             for( i = 0; i < [[self messageQueue] count]-1; i++ )
89             {
90                 message_newer = (struct message *)[(NSData *)[[self messageQueue] objectAtIndex:i] bytes];
91                 if( message_newer->type == VLCNotification &&
92                     message_newer->target == message->target &&
93                    [message_newer->u.name isEqualToString:message->u.name] )
94                 {
95                     [message_newer->target release];
96                     [message_newer->u.name release];
97                     [[self messageQueue] removeObjectAtIndex:i];
98                     i--;
99                     continue;
100                 }
101             }
102         }
103         else if( message->type == VLCObjectMethodWithArrayArg )
104         {
105             NSMutableArray * newArg = nil;
106             /* Collapse messages that takes array arg by sending one bigger array */
107             for( i = [[self messageQueue] count]-2; i >= 0; i-- )
108             {
109                 message_newer = (struct message *)[(NSData *)[[self messageQueue] objectAtIndex: i] bytes];
110                 if( message_newer->type == VLCObjectMethodWithArrayArg &&
111                     message_newer->target == message->target && 
112                     message_newer->sel == message->sel )
113                 {
114                     if(!newArg)
115                         newArg = [NSMutableArray arrayWithArray:message->u.object];
116                     [newArg addObjectsFromArray:message_newer->u.object];
117                     [message_newer->target release];
118                     [message_newer->u.object release];
119                     [[self messageQueue] removeObjectAtIndex: i];
120                     continue;
121                 }
122                 /* It should be a good idea not to collapse event, with other kind of event in-between
123                  * Ignore for now only if target is the same */
124                 else if( message_newer->target == message->target )
125                     break;
126             }
127             if( newArg )
128             {
129                 [message->u.object release];
130                 message->u.object = [newArg retain];
131                 [newArg retain];
132             }
133         }
134
135         dataMessage = [[self messageQueue] lastObject];
136         
137         pthread_mutex_unlock( [self queueLock] );
138
139         if( message->type == VLCNotification )
140             [self performSelectorOnMainThread:@selector(callDelegateOfObjectAndSendNotificationWithArgs:) withObject:[dataMessage retain]  /* released in the call */ waitUntilDone: NO];
141         else
142             [self performSelectorOnMainThread:@selector(callObjectMethodWithArgs:) withObject:[dataMessage retain]  /* released in the call */ waitUntilDone: YES];
143
144         pthread_mutex_lock( [self queueLock] );
145         [[self messageQueue] removeLastObject];
146         pthread_mutex_unlock( [self queueLock] );
147     
148         [pool release];
149     }
150     return nil;
151 }
152
153 @implementation VLCEventManager
154 + (id)sharedManager
155 {
156     /* We do want a lock here to avoid leaks */
157     if ( !defaultManager )
158     {
159         defaultManager = [[VLCEventManager alloc] init];
160     }
161
162     return defaultManager;
163 }
164
165 - (void)dummy
166 {
167     /* Put Cocoa in multithreaded mode by calling a dummy function */
168 }
169
170 - (id)init
171 {
172     if( self = [super init] )
173     {
174         if(![NSThread isMultiThreaded])
175         {
176             [NSThread detachNewThreadSelector:@selector(dummy) toTarget:self withObject:nil];
177             NSAssert([NSThread isMultiThreaded], @"Can't put Cocoa in multithreaded mode");
178         }
179
180         pthread_mutex_init( &queueLock, NULL );
181         pthread_cond_init( &signalData, NULL );
182         pthread_create( &dispatcherThread, NULL, EventDispatcherMainLoop, self );
183         messageQueue = [[NSMutableArray alloc] initWithCapacity:10];
184     }
185     return self;
186 }
187
188 - (void)dealloc
189 {
190     pthread_kill( dispatcherThread, SIGKILL );
191     pthread_join( dispatcherThread, NULL );
192
193     [messageQueue release];
194     [super dealloc];
195 }
196
197 - (void)callOnMainThreadDelegateOfObject:(id)aTarget withDelegateMethod:(SEL)aSelector withNotificationName: (NSString *)aNotificationName
198 {
199     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
200     
201     struct message message = 
202     { 
203         [aTarget retain], 
204         aSelector, 
205         [aNotificationName retain], 
206         VLCNotification 
207     };
208
209     if([NSThread isMainThread])
210     {
211         [self callDelegateOfObjectAndSendNotificationWithArgs:[[NSData dataWithBytes:&message length:sizeof(struct message)] retain] /* released in the call */];
212         return;
213     }
214
215    // pthread_mutex_lock( [self queueLock] );
216    // [[self messageQueue] insertObject:[NSData dataWithBytes:&message length:sizeof(struct message)] atIndex:0];
217    // pthread_cond_signal( [self signalData] );
218    // pthread_mutex_unlock( [self queueLock] );
219     
220     [pool release];
221 }
222
223 - (void)callOnMainThreadObject:(id)aTarget withMethod:(SEL)aSelector withArgumentAsObject: (id)arg
224 {
225     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
226     struct message message = 
227     { 
228         [aTarget retain], 
229         aSelector, 
230         [arg retain], 
231         [arg isKindOfClass:[NSArray class]] ? VLCObjectMethodWithArrayArg : VLCObjectMethodWithObjectArg 
232     };
233
234     pthread_mutex_lock( [self queueLock] );
235     [[self messageQueue] insertObject:[NSData dataWithBytes:&message length:sizeof(struct message)] atIndex:0];
236     pthread_cond_signal( [self signalData] );
237     pthread_mutex_unlock( [self queueLock] );
238     
239     [pool release];
240 }
241 @end
242
243 @implementation VLCEventManager (Private)
244 - (void)callDelegateOfObjectAndSendNotificationWithArgs:(NSData*)data
245 {
246     struct message * message = (struct message *)[data bytes];
247
248     [self callDelegateOfObject:message->target withDelegateMethod:message->sel withNotificationName:message->u.name];
249     [message->u.name release];
250     [message->target release];
251     [data release];
252 }
253
254 - (void)callObjectMethodWithArgs:(NSData*)data
255 {
256     struct message * message = (struct message *)[data bytes];
257     void (*method)(id, SEL, id) = (void (*)(id, SEL, id))[message->target methodForSelector: message->sel];
258
259     method( message->target, message->sel, message->u.object);
260     [message->u.object release];
261     [message->target release];
262     [data release];
263 }
264
265 - (NSMutableArray *)messageQueue
266 {
267     return messageQueue;
268 }
269
270 - (pthread_cond_t *)signalData
271 {
272     return &signalData;
273 }
274
275 - (pthread_mutex_t *)queueLock
276 {
277     return &queueLock;
278 }
279
280 - (void)callDelegateOfObject:(id) aTarget withDelegateMethod:(SEL)aSelector withNotificationName: (NSString *)aNotificationName
281 {
282 //    [[NSNotificationCenter defaultCenter] postNotification: [NSNotification notificationWithName:aNotificationName object:aTarget]];
283
284     if (![aTarget delegate] || ![[aTarget delegate] respondsToSelector: aSelector])
285         return;
286
287     void (*method)(id, SEL, id) = (void (*)(id, SEL, id))[[aTarget delegate] methodForSelector: aSelector];
288     method( [aTarget delegate], aSelector, [NSNotification notificationWithName:aNotificationName object:aTarget]);
289 }
290 @end