2 * consumer_sdl.c -- A Simple DirectMedia Layer consumer
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Dan Dennedy <dan@dennedy.org>
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.
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.
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.
21 #include "consumer_sdl.h"
22 #include <framework/mlt_frame.h>
23 #include <framework/mlt_deque.h>
29 #include <SDL/SDL_syswm.h>
32 /** This classes definition.
35 typedef struct consumer_sdl_s
*consumer_sdl
;
39 struct mlt_consumer_s parent
;
40 mlt_properties properties
;
45 uint8_t audio_buffer
[ 4096 * 10 ];
47 pthread_mutex_t audio_mutex
;
48 pthread_cond_t audio_cond
;
49 pthread_mutex_t video_mutex
;
50 pthread_cond_t video_cond
;
55 double last_frame_aspect
;
60 SDL_Surface
*sdl_screen
;
61 SDL_Overlay
*sdl_overlay
;
67 /** Forward references to static functions.
70 static int consumer_start( mlt_consumer parent
);
71 static int consumer_stop( mlt_consumer parent
);
72 static int consumer_is_stopped( mlt_consumer parent
);
73 static void consumer_close( mlt_consumer parent
);
74 static void *consumer_thread( void * );
75 static int consumer_get_dimensions( int *width
, int *height
);
76 static void consumer_sdl_event( mlt_listener listener
, mlt_properties owner
, mlt_service
this, void **args
);
78 /** This is what will be called by the factory - anything can be passed in
79 via the argument, but keep it simple.
82 mlt_consumer
consumer_sdl_init( char *arg
)
84 // Create the consumer object
85 consumer_sdl
this = calloc( sizeof( struct consumer_sdl_s
), 1 );
87 // If no malloc'd and consumer init ok
88 if ( this != NULL
&& mlt_consumer_init( &this->parent
, this ) == 0 )
91 this->queue
= mlt_deque_init( );
93 // Get the parent consumer object
94 mlt_consumer parent
= &this->parent
;
96 // We have stuff to clean up, so override the close method
97 parent
->close
= consumer_close
;
99 // get a handle on properties
100 mlt_service service
= mlt_consumer_service( parent
);
101 this->properties
= mlt_service_properties( service
);
103 // Set the default volume
104 mlt_properties_set_double( this->properties
, "volume", 1.0 );
106 // This is the initialisation of the consumer
107 pthread_mutex_init( &this->audio_mutex
, NULL
);
108 pthread_cond_init( &this->audio_cond
, NULL
);
109 pthread_mutex_init( &this->video_mutex
, NULL
);
110 pthread_cond_init( &this->video_cond
, NULL
);
112 // Default scaler (for now we'll use nearest)
113 mlt_properties_set( this->properties
, "rescale", "nearest" );
115 // Default buffer for low latency
116 mlt_properties_set_int( this->properties
, "buffer", 1 );
118 // Default progressive true
119 mlt_properties_set_int( this->properties
, "progressive", 0 );
121 // Default audio buffer
122 mlt_properties_set_int( this->properties
, "audio_buffer", 512 );
124 // Get sample aspect ratio
125 this->aspect_ratio
= mlt_properties_get_double( this->properties
, "aspect_ratio" );
127 // Ensure we don't join on a non-running object
130 // Default display aspect ratio
131 this->display_aspect
= 4.0 / 3.0;
133 // process actual param
134 if ( arg
== NULL
|| sscanf( arg
, "%dx%d", &this->width
, &this->height
) != 2 )
136 this->width
= mlt_properties_get_int( this->properties
, "width" );
137 this->height
= mlt_properties_get_int( this->properties
, "height" );
140 // Default window size
141 this->window_width
= ( float )this->height
* this->display_aspect
;
142 this->window_height
= this->height
;
145 this->sdl_flags
= SDL_HWSURFACE
| SDL_ASYNCBLIT
| SDL_HWACCEL
| SDL_RESIZABLE
| SDL_DOUBLEBUF
;
147 // Allow thread to be started/stopped
148 parent
->start
= consumer_start
;
149 parent
->stop
= consumer_stop
;
150 parent
->is_stopped
= consumer_is_stopped
;
152 // Register specific events
153 mlt_events_register( this->properties
, "consumer-sdl-event", ( mlt_transmitter
)consumer_sdl_event
);
155 // Return the consumer produced
159 // malloc or consumer init failed
166 static void consumer_sdl_event( mlt_listener listener
, mlt_properties owner
, mlt_service
this, void **args
)
168 if ( listener
!= NULL
)
169 listener( owner
, this, ( SDL_Event
* )args
[ 0 ] );
172 int consumer_start( mlt_consumer parent
)
174 consumer_sdl
this = parent
->child
;
176 if ( !this->running
)
178 pthread_attr_t thread_attributes
;
180 consumer_stop( parent
);
185 // Allow the user to force resizing to window size
186 if ( mlt_properties_get_int( this->properties
, "resize" ) )
188 mlt_properties_set_int( this->properties
, "width", this->width
);
189 mlt_properties_set_int( this->properties
, "height", this->height
);
192 // Inherit the scheduling priority
193 pthread_attr_init( &thread_attributes
);
194 pthread_attr_setinheritsched( &thread_attributes
, PTHREAD_INHERIT_SCHED
);
196 pthread_create( &this->thread
, &thread_attributes
, consumer_thread
, this );
202 int consumer_stop( mlt_consumer parent
)
204 // Get the actual object
205 consumer_sdl
this = parent
->child
;
207 if ( this->joined
== 0 )
209 // Kill the thread and clean up
212 pthread_mutex_lock( &this->audio_mutex
);
213 pthread_cond_broadcast( &this->audio_cond
);
214 pthread_mutex_unlock( &this->audio_mutex
);
216 pthread_join( this->thread
, NULL
);
223 int consumer_is_stopped( mlt_consumer parent
)
225 consumer_sdl
this = parent
->child
;
226 return !this->running
;
229 static int sdl_lock_display( )
231 SDL_Surface
*screen
= SDL_GetVideoSurface( );
232 return screen
!= NULL
&& ( !SDL_MUSTLOCK( screen
) || SDL_LockSurface( screen
) >= 0 );
235 static void sdl_unlock_display( )
237 SDL_Surface
*screen
= SDL_GetVideoSurface( );
238 if ( screen
!= NULL
&& SDL_MUSTLOCK( screen
) )
239 SDL_UnlockSurface( screen
);
242 static void sdl_fill_audio( void *udata
, uint8_t *stream
, int len
)
244 consumer_sdl
this = udata
;
247 float volume
= mlt_properties_get_double( this->properties
, "volume" );
249 pthread_mutex_lock( &this->audio_mutex
);
251 // Block until audio received
252 while ( this->running
&& len
> this->audio_avail
)
253 pthread_cond_wait( &this->audio_cond
, &this->audio_mutex
);
255 if ( this->audio_avail
>= len
)
257 // Place in the audio buffer
258 memcpy( stream
, this->audio_buffer
, len
);
260 // Remove len from the audio available
261 this->audio_avail
-= len
;
263 // Remove the samples
264 memmove( this->audio_buffer
, this->audio_buffer
+ len
, this->audio_avail
);
268 // Just to be safe, wipe the stream first
269 memset( stream
, 0, len
);
271 // Copy what we have into the stream
272 memcpy( stream
, this->audio_buffer
, this->audio_avail
);
275 SDL_MixAudio( stream
, stream
, len
, ( int )( ( float )SDL_MIX_MAXVOLUME
* volume
) );
278 this->audio_avail
= 0;
281 // We're definitely playing now
284 pthread_cond_broadcast( &this->audio_cond
);
285 pthread_mutex_unlock( &this->audio_mutex
);
288 static int consumer_play_audio( consumer_sdl
this, mlt_frame frame
, int init_audio
, int *duration
)
290 // Get the properties of this consumer
291 mlt_properties properties
= this->properties
;
292 mlt_audio_format afmt
= mlt_audio_pcm
;
294 // Set the preferred params of the test card signal
295 int channels
= mlt_properties_get_int( properties
, "channels" );
296 int frequency
= mlt_properties_get_int( properties
, "frequency" );
297 static int counter
= 0;
299 int samples
= mlt_sample_calculator( mlt_properties_get_double( this->properties
, "fps" ), frequency
, counter
++ );
304 mlt_frame_get_audio( frame
, &pcm
, &afmt
, &frequency
, &channels
, &samples
);
305 *duration
= ( ( samples
* 1000 ) / frequency
);
307 if ( mlt_properties_get_int( properties
, "audio_off" ) )
314 if ( init_audio
== 1 )
316 SDL_AudioSpec request
;
319 int audio_buffer
= mlt_properties_get_int( properties
, "audio_buffer" );
321 // specify audio format
322 memset( &request
, 0, sizeof( SDL_AudioSpec
) );
324 request
.freq
= frequency
;
325 request
.format
= AUDIO_S16
;
326 request
.channels
= channels
;
327 request
.samples
= audio_buffer
;
328 request
.callback
= sdl_fill_audio
;
329 request
.userdata
= (void *)this;
330 if ( SDL_OpenAudio( &request
, &got
) != 0 )
332 fprintf( stderr
, "SDL failed to open audio: %s\n", SDL_GetError() );
335 else if ( got
.size
!= 0 )
342 if ( init_audio
== 0 )
344 mlt_properties properties
= mlt_frame_properties( frame
);
345 bytes
= ( samples
* channels
* 2 );
346 pthread_mutex_lock( &this->audio_mutex
);
347 while ( this->running
&& bytes
> ( sizeof( this->audio_buffer
) - this->audio_avail
) )
348 pthread_cond_wait( &this->audio_cond
, &this->audio_mutex
);
351 if ( mlt_properties_get_double( properties
, "_speed" ) == 1 )
352 memcpy( &this->audio_buffer
[ this->audio_avail
], pcm
, bytes
);
354 memset( &this->audio_buffer
[ this->audio_avail
], 0, bytes
);
355 this->audio_avail
+= bytes
;
357 pthread_cond_broadcast( &this->audio_cond
);
358 pthread_mutex_unlock( &this->audio_mutex
);
368 static int consumer_play_video( consumer_sdl
this, mlt_frame frame
)
370 // Get the properties of this consumer
371 mlt_properties properties
= this->properties
;
373 mlt_image_format vfmt
= mlt_image_yuv422
;
374 int width
= this->width
, height
= this->height
;
378 if ( mlt_properties_get_int( properties
, "video_off" ) == 0 )
380 // Get the image, width and height
381 mlt_events_fire( properties
, "consumer-frame-show", frame
, NULL
);
382 mlt_frame_get_image( frame
, &image
, &vfmt
, &width
, &height
, 0 );
385 if ( this->sdl_screen
!= NULL
)
389 changed
= consumer_get_dimensions( &this->window_width
, &this->window_height
);
391 while ( SDL_PollEvent( &event
) )
393 mlt_events_fire( this->properties
, "consumer-sdl-event", &event
, NULL
);
397 case SDL_VIDEORESIZE
:
398 this->window_width
= event
.resize
.w
;
399 this->window_height
= event
.resize
.h
;
407 mlt_producer producer
= mlt_properties_get_data( properties
, "transport_producer", NULL
);
408 char keyboard
[ 2 ] = " ";
409 void (*callback
)( mlt_producer
, char * ) = mlt_properties_get_data( properties
, "transport_callback", NULL
);
410 if ( callback
!= NULL
&& producer
!= NULL
&& event
.key
.keysym
.unicode
< 0x80 && event
.key
.keysym
.unicode
> 0 )
412 keyboard
[ 0 ] = ( char )event
.key
.keysym
.unicode
;
413 callback( producer
, keyboard
);
421 if ( width
!= this->width
|| height
!= this->height
)
423 if ( this->sdl_overlay
!= NULL
)
424 SDL_FreeYUVOverlay( this->sdl_overlay
);
425 this->sdl_overlay
= NULL
;
428 if ( this->running
&& ( this->sdl_screen
== NULL
|| changed
) )
430 // Force an overlay recreation
431 if ( this->sdl_overlay
!= NULL
)
432 SDL_FreeYUVOverlay( this->sdl_overlay
);
433 this->sdl_overlay
= NULL
;
435 // open SDL window with video overlay, if possible
437 this->sdl_screen
= SDL_SetVideoMode( this->window_width
, this->window_height
, this->bpp
, this->sdl_flags
);
438 sdl_unlock_display();
439 if ( consumer_get_dimensions( &this->window_width
, &this->window_height
) )
440 this->sdl_screen
= SDL_SetVideoMode( this->window_width
, this->window_height
, this->bpp
, this->sdl_flags
);
441 //SDL_Flip( this->sdl_screen );
442 mlt_properties_set_int( properties
, "changed", 0 );
444 else if ( mlt_properties_get_int( properties
, "changed" ) )
447 this->sdl_screen
= SDL_SetVideoMode( this->window_width
, this->window_height
, this->bpp
, this->sdl_flags
);
448 SDL_SetClipRect( this->sdl_screen
, &this->rect
);
449 sdl_unlock_display();
450 mlt_properties_set_int( properties
, "changed", 0 );
455 // Determine window's new display aspect ratio
456 float this_aspect
= ( float )this->window_width
/ this->window_height
;
458 // Determine frame's display aspect ratio
459 float frame_aspect
= mlt_frame_get_aspect_ratio( frame
) * width
/ height
;
461 this->height
= height
;
463 // If using hardware scaler
464 if ( mlt_properties_get( properties
, "rescale" ) != NULL
&&
465 !strcmp( mlt_properties_get( properties
, "rescale" ), "none" ) )
467 // Special case optimisation to negate odd effect of sample aspect ratio
468 // not corresponding exactly with image resolution.
469 if ( ( (int)( this_aspect
* 1000 ) == (int)( this->display_aspect
* 1000 ) ) &&
470 ( (int)( mlt_frame_get_aspect_ratio( frame
) * 1000 ) == (int)( this->aspect_ratio
* 1000 ) ) )
472 this->rect
.w
= this->window_width
;
473 this->rect
.h
= this->window_height
;
477 // Use hardware scaler to normalise display aspect ratio
478 this->rect
.w
= frame_aspect
/ this_aspect
* this->window_width
;
479 this->rect
.h
= this->window_height
;
480 if ( this->rect
.w
> this->window_width
)
482 this->rect
.w
= this->window_width
;
483 this->rect
.h
= this_aspect
/ frame_aspect
* this->window_height
;
487 // Special case optimisation to negate odd effect of sample aspect ratio
488 // not corresponding exactly with image resolution.
489 else if ( (int)( this_aspect
* 1000 ) == (int)( this->display_aspect
* 1000 ) )
491 this->rect
.w
= this->window_width
;
492 this->rect
.h
= this->window_height
;
494 // Use hardware scaler to normalise sample aspect ratio
495 else if ( this->window_height
* this->display_aspect
> this->window_width
)
497 this->rect
.w
= this->window_width
;
498 this->rect
.h
= this->window_width
/ this->display_aspect
;
502 this->rect
.w
= this->window_height
* this->display_aspect
;
503 this->rect
.h
= this->window_height
;
506 this->rect
.x
= ( this->window_width
- this->rect
.w
) / 2;
507 this->rect
.y
= ( this->window_height
- this->rect
.h
) / 2;
509 mlt_properties_set_int( this->properties
, "rect_x", this->rect
.x
);
510 mlt_properties_set_int( this->properties
, "rect_y", this->rect
.y
);
511 mlt_properties_set_int( this->properties
, "rect_w", this->rect
.w
);
512 mlt_properties_set_int( this->properties
, "rect_h", this->rect
.h
);
514 SDL_SetClipRect( this->sdl_screen
, &this->rect
);
517 if ( this->sdl_screen
!= NULL
&& this->sdl_overlay
== NULL
)
519 SDL_SetClipRect( this->sdl_screen
, &this->rect
);
520 SDL_Flip( this->sdl_screen
);
522 this->sdl_overlay
= SDL_CreateYUVOverlay( this->width
, this->height
, SDL_YUY2_OVERLAY
, this->sdl_screen
);
523 sdl_unlock_display();
526 if ( this->sdl_screen
!= NULL
&& this->sdl_overlay
!= NULL
)
528 this->buffer
= this->sdl_overlay
->pixels
[ 0 ];
530 if ( SDL_LockYUVOverlay( this->sdl_overlay
) >= 0 )
533 memcpy( this->buffer
, image
, width
* height
* 2 );
534 SDL_UnlockYUVOverlay( this->sdl_overlay
);
535 SDL_DisplayYUVOverlay( this->sdl_overlay
, &this->sdl_screen
->clip_rect
);
537 sdl_unlock_display();
544 static void *video_thread( void *arg
)
547 consumer_sdl
this = arg
;
549 // Obtain time of thread start
554 mlt_frame next
= NULL
;
555 mlt_properties properties
= NULL
;
558 // Get real time flag
559 int real_time
= mlt_properties_get_int( this->properties
, "real_time" );
561 // Get the current time
562 gettimeofday( &now
, NULL
);
564 // Determine start time
565 start
= ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
;
567 while ( this->running
)
569 // Pop the next frame
570 pthread_mutex_lock( &this->video_mutex
);
571 while ( ( next
= mlt_deque_pop_front( this->queue
) ) == NULL
&& this->running
)
572 pthread_cond_wait( &this->video_cond
, &this->video_mutex
);
573 pthread_mutex_unlock( &this->video_mutex
);
575 // Get the properties
576 properties
= mlt_frame_properties( next
);
578 // Get the speed of the frame
579 speed
= mlt_properties_get_double( properties
, "_speed" );
581 // Get the current time
582 gettimeofday( &now
, NULL
);
584 // Get the elapsed time
585 elapsed
= ( ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
) - start
;
587 // See if we have to delay the display of the current frame
588 if ( mlt_properties_get_int( properties
, "rendered" ) == 1 && this->running
)
590 // Obtain the scheduled playout time
591 mlt_position scheduled
= mlt_properties_get_position( properties
, "playtime" );
593 // Determine the difference between the elapsed time and the scheduled playout time
594 mlt_position difference
= scheduled
- elapsed
;
596 // Smooth playback a bit
597 if ( real_time
&& ( difference
> 20000 && speed
== 1.0 ) )
599 tm
.tv_sec
= difference
/ 1000000;
600 tm
.tv_nsec
= ( difference
% 1000000 ) * 500;
601 nanosleep( &tm
, NULL
);
604 // Show current frame if not too old
605 if ( !real_time
|| ( difference
> -10000 || speed
!= 1.0 || mlt_deque_count( this->queue
) < 2 ) )
606 consumer_play_video( this, next
);
608 // If the queue is empty, recalculate start to allow build up again
609 if ( real_time
&& ( mlt_deque_count( this->queue
) == 0 && speed
== 1.0 ) )
611 gettimeofday( &now
, NULL
);
612 start
= ( ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
) - scheduled
+ 20000;
616 // This frame can now be closed
617 mlt_frame_close( next
);
620 mlt_consumer_stopped( &this->parent
);
625 /** Threaded wrapper for pipe.
628 static void *consumer_thread( void *arg
)
631 consumer_sdl
this = arg
;
634 mlt_consumer consumer
= &this->parent
;
639 // internal intialization
642 mlt_frame frame
= NULL
;
643 mlt_properties properties
= NULL
;
645 int64_t playtime
= 0;
646 struct timespec tm
= { 0, 100000 };
648 this->bpp
= mlt_properties_get_int( this->properties
, "bpp" );
650 if ( mlt_properties_get_int( mlt_consumer_properties( consumer
), "sdl_started" ) == 0 )
652 if ( SDL_Init( SDL_INIT_VIDEO
| SDL_INIT_NOPARACHUTE
) < 0 )
654 fprintf( stderr
, "Failed to initialize SDL: %s\n", SDL_GetError() );
658 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY
, SDL_DEFAULT_REPEAT_INTERVAL
);
659 SDL_EnableUNICODE( 1 );
663 if ( SDL_GetVideoSurface( ) != NULL
)
665 this->sdl_screen
= SDL_GetVideoSurface( );
666 consumer_get_dimensions( &this->window_width
, &this->window_height
);
667 mlt_properties_set_int( this->properties
, "changed", 0 );
671 if ( !mlt_properties_get_int( mlt_consumer_properties( consumer
), "audio_off" ) )
672 SDL_InitSubSystem( SDL_INIT_AUDIO
);
674 // Loop until told not to
675 while( this->running
)
677 // Get a frame from the attached producer
678 frame
= mlt_consumer_rt_frame( consumer
);
680 // Ensure that we have a frame
683 // Get the frame properties
684 properties
= mlt_frame_properties( frame
);
687 init_audio
= consumer_play_audio( this, frame
, init_audio
, &duration
);
689 // Determine the start time now
690 if ( this->playing
&& init_video
)
692 // Create the video thread
693 pthread_create( &thread
, NULL
, video_thread
, this );
695 // Video doesn't need to be initialised any more
699 // Set playtime for this frame
700 mlt_properties_set_position( properties
, "playtime", playtime
);
702 while ( this->running
&& mlt_deque_count( this->queue
) > 15 )
703 nanosleep( &tm
, NULL
);
705 // Push this frame to the back of the queue
706 pthread_mutex_lock( &this->video_mutex
);
707 mlt_deque_push_back( this->queue
, frame
);
708 pthread_cond_broadcast( &this->video_cond
);
709 pthread_mutex_unlock( &this->video_mutex
);
711 // Calculate the next playtime
712 playtime
+= ( duration
* 1000 );
716 // Kill the video thread
717 if ( init_video
== 0 )
719 pthread_mutex_lock( &this->video_mutex
);
720 pthread_cond_broadcast( &this->video_cond
);
721 pthread_mutex_unlock( &this->video_mutex
);
722 pthread_join( thread
, NULL
);
726 if ( this->sdl_overlay
!= NULL
)
727 SDL_FreeYUVOverlay( this->sdl_overlay
);
729 if ( !mlt_properties_get_int( mlt_consumer_properties( consumer
), "audio_off" ) )
730 SDL_QuitSubSystem( SDL_INIT_AUDIO
);
732 if ( mlt_properties_get_int( mlt_consumer_properties( consumer
), "sdl_started" ) == 0 )
735 while( mlt_deque_count( this->queue
) )
736 mlt_frame_close( mlt_deque_pop_back( this->queue
) );
738 this->sdl_screen
= NULL
;
739 this->sdl_overlay
= NULL
;
740 this->audio_avail
= 0;
745 static int consumer_get_dimensions( int *width
, int *height
)
749 // SDL windows manager structure
752 // Specify the SDL Version
753 SDL_VERSION( &wm
.version
);
758 // Get the wm structure
759 if ( SDL_GetWMInfo( &wm
) == 1 )
761 // Check that we have the X11 wm
762 if ( wm
.subsystem
== SDL_SYSWM_X11
)
764 // Get the SDL window
765 Window window
= wm
.info
.x11
.window
;
767 // Get the display session
768 Display
*display
= wm
.info
.x11
.display
;
770 // Get the window attributes
771 XWindowAttributes attr
;
772 XGetWindowAttributes( display
, window
, &attr
);
774 // Determine whether window has changed
775 changed
= *width
!= attr
.width
|| *height
!= attr
.height
;
777 // Return width and height
779 *height
= attr
.height
;
783 // Unlock the display
789 /** Callback to allow override of the close method.
792 static void consumer_close( mlt_consumer parent
)
794 // Get the actual object
795 consumer_sdl
this = parent
->child
;
798 mlt_consumer_stop( parent
);
801 mlt_deque_close( this->queue
);
804 pthread_mutex_destroy( &this->audio_mutex
);
805 pthread_cond_destroy( &this->audio_cond
);
807 // Now clean up the rest
808 mlt_consumer_close( parent
);
810 // Finally clean up this