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
;
59 SDL_Surface
*sdl_screen
;
60 SDL_Overlay
*sdl_overlay
;
66 /** Forward references to static functions.
69 static int consumer_start( mlt_consumer parent
);
70 static int consumer_stop( mlt_consumer parent
);
71 static int consumer_is_stopped( mlt_consumer parent
);
72 static void consumer_close( mlt_consumer parent
);
73 static void *consumer_thread( void * );
74 static int consumer_get_dimensions( int *width
, int *height
);
75 static void consumer_sdl_event( mlt_listener listener
, mlt_properties owner
, mlt_service
this, void **args
);
77 /** This is what will be called by the factory - anything can be passed in
78 via the argument, but keep it simple.
81 mlt_consumer
consumer_sdl_init( char *arg
)
83 // Create the consumer object
84 consumer_sdl
this = calloc( sizeof( struct consumer_sdl_s
), 1 );
86 // If no malloc'd and consumer init ok
87 if ( this != NULL
&& mlt_consumer_init( &this->parent
, this ) == 0 )
90 this->queue
= mlt_deque_init( );
92 // Get the parent consumer object
93 mlt_consumer parent
= &this->parent
;
95 // We have stuff to clean up, so override the close method
96 parent
->close
= consumer_close
;
98 // get a handle on properties
99 mlt_service service
= MLT_CONSUMER_SERVICE( parent
);
100 this->properties
= MLT_SERVICE_PROPERTIES( service
);
102 // Default display aspect ratio
103 double display_ratio
= mlt_properties_get_double( this->properties
, "display_ratio" );
105 // Set the default volume
106 mlt_properties_set_double( this->properties
, "volume", 1.0 );
108 // This is the initialisation of the consumer
109 pthread_mutex_init( &this->audio_mutex
, NULL
);
110 pthread_cond_init( &this->audio_cond
, NULL
);
111 pthread_mutex_init( &this->video_mutex
, NULL
);
112 pthread_cond_init( &this->video_cond
, NULL
);
114 // Default scaler (for now we'll use nearest)
115 mlt_properties_set( this->properties
, "rescale", "nearest" );
117 // Default buffer for low latency
118 mlt_properties_set_int( this->properties
, "buffer", 1 );
120 // Default progressive true
121 mlt_properties_set_int( this->properties
, "progressive", 0 );
123 // Default audio buffer
124 mlt_properties_set_int( this->properties
, "audio_buffer", 512 );
126 // Ensure we don't join on a non-running object
129 // process actual param
130 if ( arg
== NULL
|| sscanf( arg
, "%dx%d", &this->width
, &this->height
) != 2 )
132 this->width
= mlt_properties_get_int( this->properties
, "width" );
133 this->height
= mlt_properties_get_int( this->properties
, "height" );
136 // Default window size
137 this->window_width
= ( double )this->height
* display_ratio
;
138 this->window_height
= this->height
;
141 this->sdl_flags
= SDL_HWSURFACE
| SDL_ASYNCBLIT
| SDL_HWACCEL
| SDL_RESIZABLE
| SDL_DOUBLEBUF
;
143 // Allow thread to be started/stopped
144 parent
->start
= consumer_start
;
145 parent
->stop
= consumer_stop
;
146 parent
->is_stopped
= consumer_is_stopped
;
148 // Register specific events
149 mlt_events_register( this->properties
, "consumer-sdl-event", ( mlt_transmitter
)consumer_sdl_event
);
151 // Return the consumer produced
155 // malloc or consumer init failed
162 static void consumer_sdl_event( mlt_listener listener
, mlt_properties owner
, mlt_service
this, void **args
)
164 if ( listener
!= NULL
)
165 listener( owner
, this, ( SDL_Event
* )args
[ 0 ] );
168 int consumer_start( mlt_consumer parent
)
170 consumer_sdl
this = parent
->child
;
172 if ( !this->running
)
174 consumer_stop( parent
);
179 this->width
= mlt_properties_get_int( this->properties
, "width" );
180 this->height
= mlt_properties_get_int( this->properties
, "height" );
182 this->bpp
= mlt_properties_get_int( this->properties
, "bpp" );
184 if ( mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent
), "sdl_started" ) == 0 )
186 if ( SDL_Init( SDL_INIT_VIDEO
| SDL_INIT_NOPARACHUTE
) < 0 )
188 fprintf( stderr
, "Failed to initialize SDL: %s\n", SDL_GetError() );
192 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY
, SDL_DEFAULT_REPEAT_INTERVAL
);
193 SDL_EnableUNICODE( 1 );
197 if ( SDL_GetVideoSurface( ) != NULL
)
199 this->sdl_screen
= SDL_GetVideoSurface( );
200 consumer_get_dimensions( &this->window_width
, &this->window_height
);
201 mlt_properties_set_int( this->properties
, "changed", 0 );
205 if ( !mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent
), "audio_off" ) )
206 SDL_InitSubSystem( SDL_INIT_AUDIO
);
208 this->sdl_screen
= SDL_SetVideoMode( this->window_width
, this->window_height
, 0, this->sdl_flags
);
210 pthread_create( &this->thread
, NULL
, consumer_thread
, this );
216 int consumer_stop( mlt_consumer parent
)
218 // Get the actual object
219 consumer_sdl
this = parent
->child
;
221 if ( this->joined
== 0 )
223 // Kill the thread and clean up
226 pthread_join( this->thread
, NULL
);
229 if ( this->sdl_overlay
!= NULL
)
230 SDL_FreeYUVOverlay( this->sdl_overlay
);
231 this->sdl_overlay
= NULL
;
233 if ( !mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent
), "audio_off" ) )
234 SDL_QuitSubSystem( SDL_INIT_AUDIO
);
236 if ( mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent
), "sdl_started" ) == 0 )
239 this->sdl_screen
= NULL
;
245 int consumer_is_stopped( mlt_consumer parent
)
247 consumer_sdl
this = parent
->child
;
248 return !this->running
;
251 static int sdl_lock_display( )
253 SDL_Surface
*screen
= SDL_GetVideoSurface( );
254 return screen
!= NULL
&& ( !SDL_MUSTLOCK( screen
) || SDL_LockSurface( screen
) >= 0 );
257 static void sdl_unlock_display( )
259 SDL_Surface
*screen
= SDL_GetVideoSurface( );
260 if ( screen
!= NULL
&& SDL_MUSTLOCK( screen
) )
261 SDL_UnlockSurface( screen
);
264 static void sdl_fill_audio( void *udata
, uint8_t *stream
, int len
)
266 consumer_sdl
this = udata
;
269 double volume
= mlt_properties_get_double( this->properties
, "volume" );
271 pthread_mutex_lock( &this->audio_mutex
);
273 // Block until audio received
274 while ( this->running
&& len
> this->audio_avail
)
275 pthread_cond_wait( &this->audio_cond
, &this->audio_mutex
);
277 if ( this->audio_avail
>= len
)
279 // Place in the audio buffer
281 SDL_MixAudio( stream
, this->audio_buffer
, len
, ( int )( ( float )SDL_MIX_MAXVOLUME
* volume
) );
283 memcpy( stream
, this->audio_buffer
, len
);
285 // Remove len from the audio available
286 this->audio_avail
-= len
;
288 // Remove the samples
289 memmove( this->audio_buffer
, this->audio_buffer
+ len
, this->audio_avail
);
293 // Just to be safe, wipe the stream first
294 memset( stream
, 0, len
);
296 // Copy what we have into the stream
297 memcpy( stream
, this->audio_buffer
, this->audio_avail
);
300 SDL_MixAudio( stream
, this->audio_buffer
, len
, ( int )( ( float )SDL_MIX_MAXVOLUME
* volume
) );
303 this->audio_avail
= 0;
306 // We're definitely playing now
309 pthread_cond_broadcast( &this->audio_cond
);
310 pthread_mutex_unlock( &this->audio_mutex
);
313 static int consumer_play_audio( consumer_sdl
this, mlt_frame frame
, int init_audio
, int *duration
)
315 // Get the properties of this consumer
316 mlt_properties properties
= this->properties
;
317 mlt_audio_format afmt
= mlt_audio_pcm
;
319 // Set the preferred params of the test card signal
320 int channels
= mlt_properties_get_int( properties
, "channels" );
321 int frequency
= mlt_properties_get_int( properties
, "frequency" );
322 static int counter
= 0;
324 int samples
= mlt_sample_calculator( mlt_properties_get_double( this->properties
, "fps" ), frequency
, counter
++ );
329 mlt_frame_get_audio( frame
, &pcm
, &afmt
, &frequency
, &channels
, &samples
);
330 *duration
= ( ( samples
* 1000 ) / frequency
);
332 if ( mlt_properties_get_int( properties
, "audio_off" ) )
339 if ( init_audio
== 1 )
341 SDL_AudioSpec request
;
344 int audio_buffer
= mlt_properties_get_int( properties
, "audio_buffer" );
346 // specify audio format
347 memset( &request
, 0, sizeof( SDL_AudioSpec
) );
349 request
.freq
= frequency
;
350 request
.format
= AUDIO_S16
;
351 request
.channels
= channels
;
352 request
.samples
= audio_buffer
;
353 request
.callback
= sdl_fill_audio
;
354 request
.userdata
= (void *)this;
355 if ( SDL_OpenAudio( &request
, &got
) != 0 )
357 fprintf( stderr
, "SDL failed to open audio: %s\n", SDL_GetError() );
360 else if ( got
.size
!= 0 )
367 if ( init_audio
== 0 )
369 mlt_properties properties
= MLT_FRAME_PROPERTIES( frame
);
370 bytes
= ( samples
* channels
* 2 );
371 pthread_mutex_lock( &this->audio_mutex
);
372 while ( this->running
&& bytes
> ( sizeof( this->audio_buffer
) - this->audio_avail
) )
373 pthread_cond_wait( &this->audio_cond
, &this->audio_mutex
);
376 if ( mlt_properties_get_double( properties
, "_speed" ) == 1 )
377 memcpy( &this->audio_buffer
[ this->audio_avail
], pcm
, bytes
);
379 memset( &this->audio_buffer
[ this->audio_avail
], 0, bytes
);
380 this->audio_avail
+= bytes
;
382 pthread_cond_broadcast( &this->audio_cond
);
383 pthread_mutex_unlock( &this->audio_mutex
);
393 static int consumer_play_video( consumer_sdl
this, mlt_frame frame
)
395 // Get the properties of this consumer
396 mlt_properties properties
= this->properties
;
398 mlt_image_format vfmt
= mlt_image_yuv422
;
399 int width
= this->width
, height
= this->height
;
403 if ( this->running
&& mlt_properties_get_int( properties
, "video_off" ) == 0 )
405 // Get the image, width and height
406 mlt_events_fire( properties
, "consumer-frame-show", frame
, NULL
);
407 mlt_frame_get_image( frame
, &image
, &vfmt
, &width
, &height
, 0 );
410 if ( this->sdl_screen
!= NULL
)
414 changed
= consumer_get_dimensions( &this->window_width
, &this->window_height
);
416 while ( SDL_PollEvent( &event
) )
418 mlt_events_fire( this->properties
, "consumer-sdl-event", &event
, NULL
);
422 case SDL_VIDEORESIZE
:
423 this->window_width
= event
.resize
.w
;
424 this->window_height
= event
.resize
.h
;
432 mlt_producer producer
= mlt_properties_get_data( properties
, "transport_producer", NULL
);
433 char keyboard
[ 2 ] = " ";
434 void (*callback
)( mlt_producer
, char * ) = mlt_properties_get_data( properties
, "transport_callback", NULL
);
435 if ( callback
!= NULL
&& producer
!= NULL
&& event
.key
.keysym
.unicode
< 0x80 && event
.key
.keysym
.unicode
> 0 )
437 keyboard
[ 0 ] = ( char )event
.key
.keysym
.unicode
;
438 callback( producer
, keyboard
);
446 if ( width
!= this->width
|| height
!= this->height
)
448 if ( this->sdl_overlay
!= NULL
)
449 SDL_FreeYUVOverlay( this->sdl_overlay
);
450 this->sdl_overlay
= NULL
;
453 if ( this->running
&& ( this->sdl_screen
== NULL
|| changed
) )
455 // Force an overlay recreation
456 if ( this->sdl_overlay
!= NULL
)
457 SDL_FreeYUVOverlay( this->sdl_overlay
);
458 this->sdl_overlay
= NULL
;
460 // open SDL window with video overlay, if possible
462 this->sdl_screen
= SDL_SetVideoMode( this->window_width
, this->window_height
, this->bpp
, this->sdl_flags
);
463 sdl_unlock_display();
464 if ( consumer_get_dimensions( &this->window_width
, &this->window_height
) )
465 this->sdl_screen
= SDL_SetVideoMode( this->window_width
, this->window_height
, this->bpp
, this->sdl_flags
);
466 //SDL_Flip( this->sdl_screen );
467 mlt_properties_set_int( properties
, "changed", 0 );
469 else if ( mlt_properties_get_int( properties
, "changed" ) )
472 this->sdl_screen
= SDL_SetVideoMode( this->window_width
, this->window_height
, this->bpp
, this->sdl_flags
);
473 SDL_SetClipRect( this->sdl_screen
, &this->rect
);
474 sdl_unlock_display();
475 mlt_properties_set_int( properties
, "changed", 0 );
480 // Determine window's new display aspect ratio
481 double this_aspect
= ( double )this->window_width
/ this->window_height
;
483 // Get the display aspect ratio
484 double display_ratio
= mlt_properties_get_double( properties
, "display_ratio" );
486 // Determine frame's display aspect ratio
487 double frame_aspect
= mlt_frame_get_aspect_ratio( frame
) * width
/ height
;
489 // Store the width and height received
491 this->height
= height
;
493 // If using hardware scaler
494 if ( mlt_properties_get( properties
, "rescale" ) != NULL
&&
495 !strcmp( mlt_properties_get( properties
, "rescale" ), "none" ) )
497 // Use hardware scaler to normalise display aspect ratio
498 this->rect
.w
= frame_aspect
/ this_aspect
* this->window_width
;
499 this->rect
.h
= this->window_height
;
500 if ( this->rect
.w
> this->window_width
)
502 this->rect
.w
= this->window_width
;
503 this->rect
.h
= this_aspect
/ frame_aspect
* this->window_height
;
506 // Special case optimisation to negate odd effect of sample aspect ratio
507 // not corresponding exactly with image resolution.
508 else if ( (int)( this_aspect
* 1000 ) == (int)( display_ratio
* 1000 ) )
510 this->rect
.w
= this->window_width
;
511 this->rect
.h
= this->window_height
;
513 // Use hardware scaler to normalise sample aspect ratio
514 else if ( this->window_height
* display_ratio
> this->window_width
)
516 this->rect
.w
= this->window_width
;
517 this->rect
.h
= this->window_width
/ display_ratio
;
521 this->rect
.w
= this->window_height
* display_ratio
;
522 this->rect
.h
= this->window_height
;
525 this->rect
.x
= ( this->window_width
- this->rect
.w
) / 2;
526 this->rect
.y
= ( this->window_height
- this->rect
.h
) / 2;
528 mlt_properties_set_int( this->properties
, "rect_x", this->rect
.x
);
529 mlt_properties_set_int( this->properties
, "rect_y", this->rect
.y
);
530 mlt_properties_set_int( this->properties
, "rect_w", this->rect
.w
);
531 mlt_properties_set_int( this->properties
, "rect_h", this->rect
.h
);
533 SDL_SetClipRect( this->sdl_screen
, &this->rect
);
536 if ( this->running
&& this->sdl_screen
!= NULL
&& this->sdl_overlay
== NULL
)
538 SDL_SetClipRect( this->sdl_screen
, &this->rect
);
539 SDL_Flip( this->sdl_screen
);
541 this->sdl_overlay
= SDL_CreateYUVOverlay( width
, height
, SDL_YUY2_OVERLAY
, this->sdl_screen
);
542 sdl_unlock_display();
545 if ( this->running
&& this->sdl_screen
!= NULL
&& this->sdl_overlay
!= NULL
)
547 this->buffer
= this->sdl_overlay
->pixels
[ 0 ];
549 if ( SDL_LockYUVOverlay( this->sdl_overlay
) >= 0 )
552 memcpy( this->buffer
, image
, width
* height
* 2 );
553 SDL_UnlockYUVOverlay( this->sdl_overlay
);
554 SDL_DisplayYUVOverlay( this->sdl_overlay
, &this->sdl_screen
->clip_rect
);
556 sdl_unlock_display();
563 static void *video_thread( void *arg
)
566 consumer_sdl
this = arg
;
568 // Obtain time of thread start
573 mlt_frame next
= NULL
;
574 mlt_properties properties
= NULL
;
577 // Get real time flag
578 int real_time
= mlt_properties_get_int( this->properties
, "real_time" );
580 // Get the current time
581 gettimeofday( &now
, NULL
);
583 // Determine start time
584 start
= ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
;
586 while ( this->running
)
588 // Pop the next frame
589 pthread_mutex_lock( &this->video_mutex
);
590 next
= mlt_deque_pop_front( this->queue
);
591 while ( next
== NULL
&& this->running
)
593 pthread_cond_wait( &this->video_cond
, &this->video_mutex
);
594 next
= mlt_deque_pop_front( this->queue
);
596 pthread_mutex_unlock( &this->video_mutex
);
598 if ( !this->running
|| next
== NULL
) break;
600 // Get the properties
601 properties
= MLT_FRAME_PROPERTIES( next
);
603 // Get the speed of the frame
604 speed
= mlt_properties_get_double( properties
, "_speed" );
606 // Get the current time
607 gettimeofday( &now
, NULL
);
609 // Get the elapsed time
610 elapsed
= ( ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
) - start
;
612 // See if we have to delay the display of the current frame
613 if ( mlt_properties_get_int( properties
, "rendered" ) == 1 && this->running
)
615 // Obtain the scheduled playout time
616 int64_t scheduled
= mlt_properties_get_int( properties
, "playtime" );
618 // Determine the difference between the elapsed time and the scheduled playout time
619 int64_t difference
= scheduled
- elapsed
;
621 // Smooth playback a bit
622 if ( real_time
&& ( difference
> 20000 && speed
== 1.0 ) )
624 tm
.tv_sec
= difference
/ 1000000;
625 tm
.tv_nsec
= ( difference
% 1000000 ) * 500;
626 nanosleep( &tm
, NULL
);
629 // Show current frame if not too old
630 if ( !real_time
|| ( difference
> -10000 || speed
!= 1.0 || mlt_deque_count( this->queue
) < 2 ) )
631 consumer_play_video( this, next
);
633 // If the queue is empty, recalculate start to allow build up again
634 if ( real_time
&& ( mlt_deque_count( this->queue
) == 0 && speed
== 1.0 ) )
636 gettimeofday( &now
, NULL
);
637 start
= ( ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
) - scheduled
+ 20000;
641 // This frame can now be closed
642 mlt_frame_close( next
);
647 mlt_frame_close( next
);
649 mlt_consumer_stopped( &this->parent
);
654 /** Threaded wrapper for pipe.
657 static void *consumer_thread( void *arg
)
660 consumer_sdl
this = arg
;
663 mlt_consumer consumer
= &this->parent
;
668 // internal intialization
671 mlt_frame frame
= NULL
;
672 mlt_properties properties
= NULL
;
674 int64_t playtime
= 0;
675 struct timespec tm
= { 0, 100000 };
677 // Loop until told not to
678 while( this->running
)
680 // Get a frame from the attached producer
681 frame
= mlt_consumer_rt_frame( consumer
);
683 // Ensure that we have a frame
686 // Get the frame properties
687 properties
= MLT_FRAME_PROPERTIES( frame
);
690 init_audio
= consumer_play_audio( this, frame
, init_audio
, &duration
);
692 // Determine the start time now
693 if ( this->playing
&& init_video
)
695 // Create the video thread
696 pthread_create( &thread
, NULL
, video_thread
, this );
698 // Video doesn't need to be initialised any more
702 // Set playtime for this frame
703 mlt_properties_set_int( properties
, "playtime", playtime
);
705 while ( this->running
&& mlt_deque_count( this->queue
) > 15 )
706 nanosleep( &tm
, NULL
);
708 // Push this frame to the back of the queue
709 pthread_mutex_lock( &this->video_mutex
);
710 mlt_deque_push_back( this->queue
, frame
);
711 pthread_cond_broadcast( &this->video_cond
);
712 pthread_mutex_unlock( &this->video_mutex
);
714 // Calculate the next playtime
715 playtime
+= ( duration
* 1000 );
719 // Kill the video thread
720 if ( init_video
== 0 )
722 pthread_mutex_lock( &this->video_mutex
);
723 pthread_cond_broadcast( &this->video_cond
);
724 pthread_mutex_unlock( &this->video_mutex
);
725 pthread_join( thread
, NULL
);
728 while( mlt_deque_count( this->queue
) )
729 mlt_frame_close( mlt_deque_pop_back( this->queue
) );
731 this->sdl_screen
= NULL
;
732 this->sdl_overlay
= NULL
;
733 this->audio_avail
= 0;
738 static int consumer_get_dimensions( int *width
, int *height
)
742 // SDL windows manager structure
745 // Specify the SDL Version
746 SDL_VERSION( &wm
.version
);
752 // Get the wm structure
753 if ( SDL_GetWMInfo( &wm
) == 1 )
755 // Check that we have the X11 wm
756 if ( wm
.subsystem
== SDL_SYSWM_X11
)
758 // Get the SDL window
759 Window window
= wm
.info
.x11
.window
;
761 // Get the display session
762 Display
*display
= wm
.info
.x11
.display
;
764 // Get the window attributes
765 XWindowAttributes attr
;
766 XGetWindowAttributes( display
, window
, &attr
);
768 // Determine whether window has changed
769 changed
= *width
!= attr
.width
|| *height
!= attr
.height
;
771 // Return width and height
773 *height
= attr
.height
;
778 // Unlock the display
779 sdl_unlock_display();
784 /** Callback to allow override of the close method.
787 static void consumer_close( mlt_consumer parent
)
789 // Get the actual object
790 consumer_sdl
this = parent
->child
;
793 ///mlt_consumer_stop( parent );
795 // Now clean up the rest
796 mlt_consumer_close( parent
);
799 mlt_deque_close( this->queue
);
802 pthread_mutex_destroy( &this->audio_mutex
);
803 pthread_cond_destroy( &this->audio_cond
);
805 // Finally clean up this