in point fix, low latency sdl, minor fixes
[melted] / src / modules / sdl / consumer_sdl.c
1 /*
2 * consumer_sdl.c -- A Simple DirectMedia Layer consumer
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Dan Dennedy <dan@dennedy.org>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
21 #include "consumer_sdl.h"
22 #include <framework/mlt_frame.h>
23 #include <framework/mlt_deque.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <pthread.h>
28 #include <SDL/SDL.h>
29 #include <SDL/SDL_syswm.h>
30 #include <sys/time.h>
31
32 /** This classes definition.
33 */
34
35 typedef struct consumer_sdl_s *consumer_sdl;
36
37 struct consumer_sdl_s
38 {
39 struct mlt_consumer_s parent;
40 mlt_properties properties;
41 mlt_deque queue;
42 pthread_t thread;
43 int running;
44 uint8_t audio_buffer[ 4096 * 19 ];
45 int audio_avail;
46 pthread_mutex_t audio_mutex;
47 pthread_cond_t audio_cond;
48 int window_width;
49 int window_height;
50 float aspect_ratio;
51 int width;
52 int height;
53 int playing;
54 int sdl_flags;
55 SDL_Surface *sdl_screen;
56 SDL_Overlay *sdl_overlay;
57 uint8_t *buffer;
58 };
59
60 /** Forward references to static functions.
61 */
62
63 static int consumer_start( mlt_consumer parent );
64 static int consumer_stop( mlt_consumer parent );
65 static int consumer_is_stopped( mlt_consumer parent );
66 static void consumer_close( mlt_consumer parent );
67 static void *consumer_thread( void * );
68 static int consumer_get_dimensions( int *width, int *height );
69
70 /** This is what will be called by the factory - anything can be passed in
71 via the argument, but keep it simple.
72 */
73
74 mlt_consumer consumer_sdl_init( char *arg )
75 {
76 // Create the consumer object
77 consumer_sdl this = calloc( sizeof( struct consumer_sdl_s ), 1 );
78
79 // If no malloc'd and consumer init ok
80 if ( this != NULL && mlt_consumer_init( &this->parent, this ) == 0 )
81 {
82 // Create the queue
83 this->queue = mlt_deque_init( );
84
85 // Get the parent consumer object
86 mlt_consumer parent = &this->parent;
87
88 // We have stuff to clean up, so override the close method
89 parent->close = consumer_close;
90
91 // get a handle on properties
92 mlt_service service = mlt_consumer_service( parent );
93 this->properties = mlt_service_properties( service );
94
95 // Set the default volume
96 mlt_properties_set_double( this->properties, "volume", 1.0 );
97
98 // This is the initialisation of the consumer
99 pthread_mutex_init( &this->audio_mutex, NULL );
100 pthread_cond_init( &this->audio_cond, NULL);
101
102 // Default scaler (for now we'll use nearest)
103 mlt_properties_set( this->properties, "rescale", "nearest" );
104
105 // Default buffer for low latency
106 mlt_properties_set_int( this->properties, "buffer", 2 );
107
108 // Default progressive true
109 mlt_properties_set_int( this->properties, "progressive", 0 );
110
111 // Get aspect ratio
112 this->aspect_ratio = mlt_properties_get_double( this->properties, "aspect_ratio" );
113
114 // process actual param
115 if ( arg == NULL || sscanf( arg, "%dx%d", &this->width, &this->height ) != 2 )
116 {
117 this->width = mlt_properties_get_int( this->properties, "width" );
118 this->height = mlt_properties_get_int( this->properties, "height" );
119 }
120
121 // Default window size
122 this->window_width = (int)( (float)this->height * 4.0/3.0 + 0.5);
123 this->window_height = this->height;
124
125 // Set the sdl flags
126 this->sdl_flags = SDL_HWSURFACE | SDL_ASYNCBLIT | SDL_HWACCEL | SDL_RESIZABLE;
127
128 // Allow thread to be started/stopped
129 parent->start = consumer_start;
130 parent->stop = consumer_stop;
131 parent->is_stopped = consumer_is_stopped;
132
133 // Return the consumer produced
134 return parent;
135 }
136
137 // malloc or consumer init failed
138 free( this );
139
140 // Indicate failure
141 return NULL;
142 }
143
144 int consumer_start( mlt_consumer parent )
145 {
146 consumer_sdl this = parent->child;
147
148 if ( !this->running )
149 {
150 this->running = 1;
151 pthread_create( &this->thread, NULL, consumer_thread, this );
152 }
153
154 return 0;
155 }
156
157 int consumer_stop( mlt_consumer parent )
158 {
159 // Get the actual object
160 consumer_sdl this = parent->child;
161
162 if ( this->running )
163 {
164 // Kill the thread and clean up
165 this->running = 0;
166
167 pthread_mutex_lock( &this->audio_mutex );
168 pthread_cond_broadcast( &this->audio_cond );
169 pthread_mutex_unlock( &this->audio_mutex );
170
171 pthread_join( this->thread, NULL );
172 }
173
174 return 0;
175 }
176
177 int consumer_is_stopped( mlt_consumer parent )
178 {
179 consumer_sdl this = parent->child;
180 return !this->running;
181 }
182
183 static int sdl_lock_display( )
184 {
185 SDL_Surface *screen = SDL_GetVideoSurface( );
186 return screen != NULL && ( !SDL_MUSTLOCK( screen ) || SDL_LockSurface( screen ) >= 0 );
187 }
188
189 static void sdl_unlock_display( )
190 {
191 SDL_Surface *screen = SDL_GetVideoSurface( );
192 if ( screen != NULL && SDL_MUSTLOCK( screen ) )
193 SDL_UnlockSurface( screen );
194 }
195
196 static void sdl_fill_audio( void *udata, uint8_t *stream, int len )
197 {
198 consumer_sdl this = udata;
199
200 // Get the volume
201 float volume = mlt_properties_get_double( this->properties, "volume" );
202
203 pthread_mutex_lock( &this->audio_mutex );
204
205 // Block until audio received
206 while ( this->running && len > this->audio_avail )
207 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
208
209 if ( this->audio_avail >= len )
210 {
211 // Place in the audio buffer
212 SDL_MixAudio( stream, this->audio_buffer, len, ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
213
214 // Remove len from the audio available
215 this->audio_avail -= len;
216
217 // Remove the samples
218 memmove( this->audio_buffer, this->audio_buffer + len, this->audio_avail );
219 }
220 else
221 {
222 // Just to be safe, wipe the stream first
223 memset( stream, 0, len );
224
225 // Copy what we have into the stream
226 memcpy( stream, this->audio_buffer, this->audio_avail );
227
228 // Mix the audio
229 SDL_MixAudio( stream, stream, len, ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
230
231 // No audio left
232 this->audio_avail = 0;
233 }
234
235 // We're definitely playing now
236 this->playing = 1;
237
238 pthread_cond_broadcast( &this->audio_cond );
239 pthread_mutex_unlock( &this->audio_mutex );
240 }
241
242 static int consumer_play_audio( consumer_sdl this, mlt_frame frame, int init_audio, int *duration )
243 {
244 // Get the properties of this consumer
245 mlt_properties properties = this->properties;
246 mlt_audio_format afmt = mlt_audio_pcm;
247
248 // Set the preferred params of the test card signal
249 int channels = 2;
250 int frequency = 48000;
251 static int counter = 0;
252 if ( mlt_properties_get_int( properties, "frequency" ) != 0 )
253 frequency = mlt_properties_get_int( properties, "frequency" );
254
255 int samples = mlt_sample_calculator( mlt_properties_get_double( this->properties, "fps" ), frequency, counter++ );
256
257 int16_t *pcm;
258 int bytes;
259
260 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
261 *duration = ( ( samples * 1000 ) / frequency );
262
263 if ( mlt_properties_get_int( properties, "audio_off" ) )
264 {
265 this->playing = 1;
266 init_audio = 1;
267 return init_audio;
268 }
269
270 if ( init_audio == 1 )
271 {
272 SDL_AudioSpec request;
273 SDL_AudioSpec got;
274
275 // specify audio format
276 memset( &request, 0, sizeof( SDL_AudioSpec ) );
277 this->playing = 0;
278 request.freq = frequency;
279 request.format = AUDIO_S16;
280 request.channels = channels;
281 request.samples = 1024;
282 request.callback = sdl_fill_audio;
283 request.userdata = (void *)this;
284 if ( SDL_OpenAudio( &request, &got ) != 0 )
285 {
286 fprintf( stderr, "SDL failed to open audio: %s\n", SDL_GetError() );
287 init_audio = 2;
288 }
289 else if ( got.size != 0 )
290 {
291 SDL_PauseAudio( 0 );
292 init_audio = 0;
293 }
294 }
295
296 if ( init_audio == 0 )
297 {
298 mlt_properties properties = mlt_frame_properties( frame );
299 bytes = ( samples * channels * 2 );
300 pthread_mutex_lock( &this->audio_mutex );
301 while ( bytes > ( sizeof( this->audio_buffer) - this->audio_avail ) )
302 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
303 if ( mlt_properties_get_double( properties, "_speed" ) == 1 )
304 memcpy( &this->audio_buffer[ this->audio_avail ], pcm, bytes );
305 else
306 memset( &this->audio_buffer[ this->audio_avail ], 0, bytes );
307 this->audio_avail += bytes;
308 pthread_cond_broadcast( &this->audio_cond );
309 pthread_mutex_unlock( &this->audio_mutex );
310 }
311 else
312 {
313 this->playing = 1;
314 }
315
316 return init_audio;
317 }
318
319 static int consumer_play_video( consumer_sdl this, mlt_frame frame )
320 {
321 // Get the properties of this consumer
322 mlt_properties properties = this->properties;
323
324 mlt_image_format vfmt = mlt_image_yuv422;
325 int width = this->width, height = this->height;
326 uint8_t *image;
327 int changed = 0;
328
329 if ( mlt_properties_get_int( properties, "video_off" ) == 0 )
330 {
331 // Get the image, width and height
332 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
333
334 // Handle events
335 if ( this->sdl_screen != NULL )
336 {
337 SDL_Event event;
338
339 changed = consumer_get_dimensions( &this->window_width, &this->window_height );
340
341 while ( SDL_PollEvent( &event ) )
342 {
343 switch( event.type )
344 {
345 case SDL_VIDEORESIZE:
346 this->window_width = event.resize.w;
347 this->window_height = event.resize.h;
348 changed = 1;
349 break;
350 case SDL_QUIT:
351 this->running = 0;
352 break;
353 case SDL_KEYDOWN:
354 {
355 mlt_producer producer = mlt_properties_get_data( properties, "transport_producer", NULL );
356 char keyboard[ 2 ] = " ";
357 void (*callback)( mlt_producer, char * ) = mlt_properties_get_data( properties, "transport_callback", NULL );
358 if ( callback != NULL && producer != NULL && event.key.keysym.unicode < 0x80 && event.key.keysym.unicode > 0 )
359 {
360 keyboard[ 0 ] = ( char )event.key.keysym.unicode;
361 callback( producer, keyboard );
362 }
363 }
364 break;
365 }
366 }
367 }
368
369 if ( width != this->width || height != this->height )
370 {
371 this->width = width;
372 this->height = height;
373 changed = 1;
374 }
375
376 if ( this->sdl_screen == NULL || changed )
377 {
378 double aspect_ratio = ( float )this->aspect_ratio * this->width / this->height;
379 float display_aspect_ratio = ( float )width / height;
380 SDL_Rect rect;
381 if ( mlt_properties_get( properties, "rescale" ) != NULL &&
382 !strcmp( mlt_properties_get( properties, "rescale" ), "none" ) )
383 aspect_ratio = mlt_frame_get_aspect_ratio( frame ) * mlt_properties_get_int(mlt_frame_properties(frame),"width") / mlt_properties_get_int(mlt_frame_properties(frame),"height");
384
385 if ( aspect_ratio == 1 )
386 {
387 rect.w = this->window_width;
388 rect.h = this->window_height;
389 }
390 else if ( this->window_width < this->window_height * aspect_ratio )
391 {
392 rect.w = this->window_width;
393 rect.h = this->window_width / aspect_ratio + 1;
394 }
395 else
396 {
397 rect.w = this->window_height * aspect_ratio + 1;
398 rect.h = this->window_height;
399 }
400
401 if ( mlt_properties_get_int( properties, "scale_overlay" ) )
402 {
403 if ( ( float )rect.w * display_aspect_ratio < this->window_width )
404 rect.w = ( int )( ( float )rect.w * display_aspect_ratio );
405 else if ( ( float )rect.h * display_aspect_ratio < this->window_height )
406 rect.h = ( int )( ( float )rect.h * display_aspect_ratio );
407 }
408
409 rect.x = ( this->window_width - rect.w ) / 2;
410 rect.y = ( this->window_height - rect.h ) / 2;
411
412 // Force an overlay recreation
413 if ( this->sdl_overlay != NULL )
414 SDL_FreeYUVOverlay( this->sdl_overlay );
415
416 // open SDL window with video overlay, if possible
417 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
418
419 if ( this->sdl_screen != NULL )
420 {
421 SDL_SetClipRect( this->sdl_screen, &rect );
422
423 sdl_lock_display();
424 this->sdl_overlay = SDL_CreateYUVOverlay( this->width - (this->width % 4), this->height- (this->height % 2 ), SDL_YUY2_OVERLAY, this->sdl_screen );
425 sdl_unlock_display();
426 }
427 }
428
429 if ( this->sdl_screen != NULL && this->sdl_overlay != NULL )
430 {
431 this->buffer = this->sdl_overlay->pixels[ 0 ];
432 if ( SDL_LockYUVOverlay( this->sdl_overlay ) >= 0 )
433 {
434 memcpy( this->buffer, image, width * height * 2 );
435 SDL_UnlockYUVOverlay( this->sdl_overlay );
436 SDL_DisplayYUVOverlay( this->sdl_overlay, &this->sdl_screen->clip_rect );
437 }
438 }
439 }
440
441 // Close the frame
442 mlt_frame_close( frame );
443
444 return 0;
445 }
446
447 /** Threaded wrapper for pipe.
448 */
449
450 static void *consumer_thread( void *arg )
451 {
452 // Identify the arg
453 consumer_sdl this = arg;
454
455 // Get the consumer
456 mlt_consumer consumer = &this->parent;
457
458 // internal intialization
459 int init_audio = 1;
460
461 // Obtain time of thread start
462 struct timeval now;
463 int64_t start = 0;
464 int64_t elapsed = 0;
465 int duration = 0;
466 int64_t playtime = 0;
467 struct timespec tm;
468 mlt_frame next = NULL;
469 mlt_frame frame = NULL;
470
471 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_AUDIO | SDL_INIT_NOPARACHUTE ) < 0 )
472 {
473 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
474 return NULL;
475 }
476
477 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
478 SDL_EnableUNICODE( 1 );
479
480 // Loop until told not to
481 while( this->running )
482 {
483 // Get a frame from the attached producer
484 frame = mlt_consumer_rt_frame( consumer );
485
486 // Ensure that we have a frame
487 if ( frame != NULL )
488 {
489 // Play audio
490 init_audio = consumer_play_audio( this, frame, init_audio, &duration );
491
492 if ( this->playing )
493 {
494 // Get the current time
495 gettimeofday( &now, NULL );
496
497 // Determine elapsed time
498 if ( start == 0 )
499 start = ( int64_t )now.tv_sec * 1000000 + now.tv_usec;
500 else
501 elapsed = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec) - start;
502 }
503
504 // Set playtime for this frame
505 mlt_properties_set_position( mlt_frame_properties( frame ), "playtime", playtime );
506
507 // Push this frame to the back of the queue
508 mlt_deque_push_back( this->queue, frame );
509
510 // Calculate the next playtime
511 playtime += ( duration * 1000 );
512 }
513
514 if ( this->playing )
515 {
516 // Pop the next frame
517 next = mlt_deque_pop_front( this->queue );
518
519 // See if we have to delay the display of the current frame
520 if ( next != NULL && mlt_properties_get_int( mlt_frame_properties( next ), "rendered" ) == 1 )
521 {
522 mlt_position scheduled = mlt_properties_get_position( mlt_frame_properties( next ), "playtime" ) + 5000;
523 if ( scheduled > elapsed && mlt_deque_count( this->queue ) > 25 )
524 {
525 tm.tv_sec = ( scheduled - elapsed ) / 1000000;
526 tm.tv_nsec = ( ( scheduled - elapsed ) % 1000000 ) * 1000;
527 nanosleep( &tm, NULL );
528
529 // Show current frame
530 consumer_play_video( this, next );
531 }
532 else if ( scheduled > elapsed )
533 {
534 // More time to kill
535 mlt_deque_push_front( this->queue, next );
536 }
537 else
538 {
539 // Show current frame
540 consumer_play_video( this, next );
541 }
542 }
543 else
544 {
545 // This is an unrendered frame - just close it
546 mlt_frame_close( next );
547 }
548 }
549 }
550
551 // internal cleanup
552 if ( init_audio == 0 )
553 SDL_AudioQuit( );
554 if ( this->sdl_overlay != NULL )
555 SDL_FreeYUVOverlay( this->sdl_overlay );
556 SDL_Quit( );
557
558 while( mlt_deque_count( this->queue ) )
559 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
560
561 this->sdl_screen = NULL;
562 this->sdl_overlay = NULL;
563 this->audio_avail = 0;
564
565 return NULL;
566 }
567
568 static int consumer_get_dimensions( int *width, int *height )
569 {
570 int changed = 0;
571
572 // SDL windows manager structure
573 SDL_SysWMinfo wm;
574
575 // Specify the SDL Version
576 SDL_VERSION( &wm.version );
577
578 // Get the wm structure
579 if ( SDL_GetWMInfo( &wm ) == 1 )
580 {
581 // Check that we have the X11 wm
582 if ( wm.subsystem == SDL_SYSWM_X11 )
583 {
584 // Get the SDL window
585 Window window = wm.info.x11.window;
586
587 // Get the display session
588 Display *display = wm.info.x11.display;
589
590 // Get the window attributes
591 XWindowAttributes attr;
592 XGetWindowAttributes( display, window, &attr );
593
594 // Determine whether window has changed
595 changed = *width != attr.width || *height != attr.height;
596
597 // Return width and height
598 *width = attr.width;
599 *height = attr.height;
600 }
601 }
602
603 return changed;
604 }
605
606 /** Callback to allow override of the close method.
607 */
608
609 static void consumer_close( mlt_consumer parent )
610 {
611 // Get the actual object
612 consumer_sdl this = parent->child;
613
614 // Stop the consumer
615 mlt_consumer_stop( parent );
616
617 // Destroy mutexes
618 pthread_mutex_destroy( &this->audio_mutex );
619 pthread_cond_destroy( &this->audio_cond );
620
621 // Now clean up the rest
622 mlt_consumer_close( parent );
623
624 // Finally clean up this
625 free( this );
626 }