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
;
44 uint8_t audio_buffer
[ 4096 * 10 ];
46 pthread_mutex_t audio_mutex
;
47 pthread_cond_t audio_cond
;
48 pthread_mutex_t video_mutex
;
49 pthread_cond_t video_cond
;
58 SDL_Surface
*sdl_screen
;
59 SDL_Overlay
*sdl_overlay
;
64 /** Forward references to static functions.
67 static int consumer_start( mlt_consumer parent
);
68 static int consumer_stop( mlt_consumer parent
);
69 static int consumer_is_stopped( mlt_consumer parent
);
70 static void consumer_close( mlt_consumer parent
);
71 static void *consumer_thread( void * );
72 static int consumer_get_dimensions( int *width
, int *height
);
74 /** This is what will be called by the factory - anything can be passed in
75 via the argument, but keep it simple.
78 mlt_consumer
consumer_sdl_init( char *arg
)
80 // Create the consumer object
81 consumer_sdl
this = calloc( sizeof( struct consumer_sdl_s
), 1 );
83 // If no malloc'd and consumer init ok
84 if ( this != NULL
&& mlt_consumer_init( &this->parent
, this ) == 0 )
87 this->queue
= mlt_deque_init( );
89 // Get the parent consumer object
90 mlt_consumer parent
= &this->parent
;
92 // We have stuff to clean up, so override the close method
93 parent
->close
= consumer_close
;
95 // get a handle on properties
96 mlt_service service
= mlt_consumer_service( parent
);
97 this->properties
= mlt_service_properties( service
);
99 // Set the default volume
100 mlt_properties_set_double( this->properties
, "volume", 1.0 );
102 // This is the initialisation of the consumer
103 pthread_mutex_init( &this->audio_mutex
, NULL
);
104 pthread_cond_init( &this->audio_cond
, NULL
);
105 pthread_mutex_init( &this->video_mutex
, NULL
);
106 pthread_cond_init( &this->video_cond
, NULL
);
108 // Default scaler (for now we'll use nearest)
109 mlt_properties_set( this->properties
, "rescale", "nearest" );
111 // Default buffer for low latency
112 mlt_properties_set_int( this->properties
, "buffer", 1 );
114 // Default progressive true
115 mlt_properties_set_int( this->properties
, "progressive", 0 );
117 // Default audio buffer
118 mlt_properties_set_int( this->properties
, "audio_buffer", 1024 );
120 // Get sample aspect ratio
121 this->aspect_ratio
= mlt_properties_get_double( this->properties
, "aspect_ratio" );
123 // Default display aspect ratio
124 this->display_aspect
= 4.0 / 3.0;
126 // process actual param
127 if ( arg
== NULL
|| sscanf( arg
, "%dx%d", &this->width
, &this->height
) != 2 )
129 this->width
= mlt_properties_get_int( this->properties
, "width" );
130 this->height
= mlt_properties_get_int( this->properties
, "height" );
132 // Default window size
133 this->window_width
= ( float )this->height
* this->display_aspect
+ 0.5;
134 this->window_height
= this->height
;
138 if ( (int)( ( float )this->width
/ this->height
* 1000 ) !=
139 (int)( this->display_aspect
* 1000 ) )
142 this->display_aspect
= ( float )this->width
/ this->height
;
143 this->aspect_ratio
= 1.0;
144 mlt_properties_set_double( this->properties
, "aspect_ratio", this->aspect_ratio
);
148 this->window_width
= this->width
;
149 this->window_height
= this->height
;
153 this->sdl_flags
= SDL_HWSURFACE
| SDL_ASYNCBLIT
| SDL_HWACCEL
| SDL_RESIZABLE
| SDL_DOUBLEBUF
;
155 // Allow thread to be started/stopped
156 parent
->start
= consumer_start
;
157 parent
->stop
= consumer_stop
;
158 parent
->is_stopped
= consumer_is_stopped
;
160 // Return the consumer produced
164 // malloc or consumer init failed
171 int consumer_start( mlt_consumer parent
)
173 consumer_sdl
this = parent
->child
;
175 if ( !this->running
)
177 pthread_attr_t thread_attributes
;
181 // Allow the user to force resizing to window size
182 if ( mlt_properties_get_int( this->properties
, "resize" ) )
184 mlt_properties_set_int( this->properties
, "width", this->width
);
185 mlt_properties_set_int( this->properties
, "height", this->height
);
188 // Inherit the scheduling priority
189 pthread_attr_init( &thread_attributes
);
190 pthread_attr_setinheritsched( &thread_attributes
, PTHREAD_INHERIT_SCHED
);
192 pthread_create( &this->thread
, &thread_attributes
, consumer_thread
, this );
198 int consumer_stop( mlt_consumer parent
)
200 // Get the actual object
201 consumer_sdl
this = parent
->child
;
205 // Kill the thread and clean up
208 pthread_mutex_lock( &this->audio_mutex
);
209 pthread_cond_broadcast( &this->audio_cond
);
210 pthread_mutex_unlock( &this->audio_mutex
);
212 pthread_join( this->thread
, NULL
);
218 int consumer_is_stopped( mlt_consumer parent
)
220 consumer_sdl
this = parent
->child
;
221 return !this->running
;
224 static int sdl_lock_display( )
226 SDL_Surface
*screen
= SDL_GetVideoSurface( );
227 return screen
!= NULL
&& ( !SDL_MUSTLOCK( screen
) || SDL_LockSurface( screen
) >= 0 );
230 static void sdl_unlock_display( )
232 SDL_Surface
*screen
= SDL_GetVideoSurface( );
233 if ( screen
!= NULL
&& SDL_MUSTLOCK( screen
) )
234 SDL_UnlockSurface( screen
);
237 static void sdl_fill_audio( void *udata
, uint8_t *stream
, int len
)
239 consumer_sdl
this = udata
;
242 float volume
= mlt_properties_get_double( this->properties
, "volume" );
244 pthread_mutex_lock( &this->audio_mutex
);
246 // Block until audio received
247 while ( this->running
&& len
> this->audio_avail
)
248 pthread_cond_wait( &this->audio_cond
, &this->audio_mutex
);
250 if ( this->audio_avail
>= len
)
252 // Place in the audio buffer
253 memcpy( stream
, this->audio_buffer
, len
);
255 // Remove len from the audio available
256 this->audio_avail
-= len
;
258 // Remove the samples
259 memmove( this->audio_buffer
, this->audio_buffer
+ len
, this->audio_avail
);
263 // Just to be safe, wipe the stream first
264 memset( stream
, 0, len
);
266 // Copy what we have into the stream
267 memcpy( stream
, this->audio_buffer
, this->audio_avail
);
270 SDL_MixAudio( stream
, stream
, len
, ( int )( ( float )SDL_MIX_MAXVOLUME
* volume
) );
273 this->audio_avail
= 0;
276 // We're definitely playing now
279 pthread_cond_broadcast( &this->audio_cond
);
280 pthread_mutex_unlock( &this->audio_mutex
);
283 static int consumer_play_audio( consumer_sdl
this, mlt_frame frame
, int init_audio
, int *duration
)
285 // Get the properties of this consumer
286 mlt_properties properties
= this->properties
;
287 mlt_audio_format afmt
= mlt_audio_pcm
;
289 // Set the preferred params of the test card signal
290 int channels
= mlt_properties_get_int( properties
, "channels" );
291 int frequency
= mlt_properties_get_int( properties
, "frequency" );
292 static int counter
= 0;
294 int samples
= mlt_sample_calculator( mlt_properties_get_double( this->properties
, "fps" ), frequency
, counter
++ );
299 mlt_frame_get_audio( frame
, &pcm
, &afmt
, &frequency
, &channels
, &samples
);
300 *duration
= ( ( samples
* 1000 ) / frequency
);
302 if ( mlt_properties_get_int( properties
, "audio_off" ) )
309 if ( init_audio
== 1 )
311 SDL_AudioSpec request
;
314 int audio_buffer
= mlt_properties_get_int( properties
, "audio_buffer" );
316 // specify audio format
317 memset( &request
, 0, sizeof( SDL_AudioSpec
) );
319 request
.freq
= frequency
;
320 request
.format
= AUDIO_S16
;
321 request
.channels
= channels
;
322 request
.samples
= audio_buffer
;
323 request
.callback
= sdl_fill_audio
;
324 request
.userdata
= (void *)this;
325 if ( SDL_OpenAudio( &request
, &got
) != 0 )
327 fprintf( stderr
, "SDL failed to open audio: %s\n", SDL_GetError() );
330 else if ( got
.size
!= 0 )
337 if ( init_audio
== 0 )
339 mlt_properties properties
= mlt_frame_properties( frame
);
340 bytes
= ( samples
* channels
* 2 );
341 pthread_mutex_lock( &this->audio_mutex
);
342 while ( bytes
> ( sizeof( this->audio_buffer
) - this->audio_avail
) )
343 pthread_cond_wait( &this->audio_cond
, &this->audio_mutex
);
344 if ( mlt_properties_get_double( properties
, "_speed" ) == 1 )
345 memcpy( &this->audio_buffer
[ this->audio_avail
], pcm
, bytes
);
347 memset( &this->audio_buffer
[ this->audio_avail
], 0, bytes
);
348 this->audio_avail
+= bytes
;
349 pthread_cond_broadcast( &this->audio_cond
);
350 pthread_mutex_unlock( &this->audio_mutex
);
360 static int consumer_play_video( consumer_sdl
this, mlt_frame frame
)
362 // Get the properties of this consumer
363 mlt_properties properties
= this->properties
;
365 mlt_image_format vfmt
= mlt_image_yuv422
;
366 int width
= this->width
, height
= this->height
;
370 if ( mlt_properties_get_int( properties
, "video_off" ) == 0 )
372 // Get the image, width and height
373 mlt_frame_get_image( frame
, &image
, &vfmt
, &width
, &height
, 0 );
376 if ( this->sdl_screen
!= NULL
)
380 changed
= consumer_get_dimensions( &this->window_width
, &this->window_height
);
382 while ( SDL_PollEvent( &event
) )
386 case SDL_VIDEORESIZE
:
387 this->window_width
= event
.resize
.w
;
388 this->window_height
= event
.resize
.h
;
396 mlt_producer producer
= mlt_properties_get_data( properties
, "transport_producer", NULL
);
397 char keyboard
[ 2 ] = " ";
398 void (*callback
)( mlt_producer
, char * ) = mlt_properties_get_data( properties
, "transport_callback", NULL
);
399 if ( callback
!= NULL
&& producer
!= NULL
&& event
.key
.keysym
.unicode
< 0x80 && event
.key
.keysym
.unicode
> 0 )
401 keyboard
[ 0 ] = ( char )event
.key
.keysym
.unicode
;
402 callback( producer
, keyboard
);
410 if ( width
!= this->width
|| height
!= this->height
)
413 this->height
= height
;
417 if ( this->sdl_screen
== NULL
|| changed
)
419 // Determine frame's display aspect ratio
420 float frame_aspect
= mlt_frame_get_aspect_ratio( frame
) * this->width
/ this->height
;
422 // Determine window's new display aspect ratio
423 float this_aspect
= ( float )this->window_width
/ this->window_height
;
425 // If using hardware scaler
426 if ( mlt_properties_get( properties
, "rescale" ) != NULL
&&
427 !strcmp( mlt_properties_get( properties
, "rescale" ), "none" ) )
429 // Special case optimisation to negate odd effect of sample aspect ratio
430 // not corresponding exactly with image resolution.
431 if ( ( (int)( this_aspect
* 1000 ) == (int)( this->display_aspect
* 1000 ) ) &&
432 ( (int)( mlt_frame_get_aspect_ratio( frame
) * 1000 ) == (int)( this->aspect_ratio
* 1000 ) ) )
434 this->rect
.w
= this->window_width
;
435 this->rect
.h
= this->window_height
;
439 // Use hardware scaler to normalise display aspect ratio
440 this->rect
.w
= frame_aspect
/ this_aspect
* this->window_width
+ 0.5;
441 this->rect
.h
= this->window_height
;
442 if ( this->rect
.w
> this->window_width
)
444 this->rect
.w
= this->window_width
;
445 this->rect
.h
= this_aspect
/ frame_aspect
* this->window_height
+ 0.5;
449 // Special case optimisation to negate odd effect of sample aspect ratio
450 // not corresponding exactly with image resolution.
451 else if ( (int)( this_aspect
* 1000 ) == (int)( this->display_aspect
* 1000 ) )
453 this->rect
.w
= this->window_width
;
454 this->rect
.h
= this->window_height
;
456 // Use hardware scaler to normalise sample aspect ratio
457 else if ( this->window_height
* frame_aspect
> this->window_width
)
459 this->rect
.w
= this->window_width
;
460 this->rect
.h
= this->window_width
/ frame_aspect
+ 0.5;
464 this->rect
.w
= this->window_height
* frame_aspect
+ 0.5;
465 this->rect
.h
= this->window_height
;
468 this->rect
.x
= ( this->window_width
- this->rect
.w
) / 2;
469 this->rect
.y
= ( this->window_height
- this->rect
.h
) / 2;
471 // Force an overlay recreation
472 if ( this->sdl_overlay
!= NULL
)
473 SDL_FreeYUVOverlay( this->sdl_overlay
);
475 // open SDL window with video overlay, if possible
476 this->sdl_screen
= SDL_SetVideoMode( this->window_width
, this->window_height
, 0, this->sdl_flags
);
478 if ( this->sdl_screen
!= NULL
)
480 SDL_SetClipRect( this->sdl_screen
, &this->rect
);
482 this->sdl_overlay
= SDL_CreateYUVOverlay( this->width
, this->height
, SDL_YUY2_OVERLAY
, this->sdl_screen
);
483 sdl_unlock_display();
487 if ( mlt_properties_get_int( properties
, "changed" ) )
490 this->sdl_screen
= SDL_SetVideoMode( this->window_width
, this->window_height
, 0, this->sdl_flags
);
491 SDL_SetClipRect( this->sdl_screen
, &this->rect
);
492 SDL_Flip( this->sdl_screen
);
493 sdl_unlock_display();
494 mlt_properties_set_int( properties
, "changed", 0 );
497 if ( this->sdl_screen
!= NULL
&& this->sdl_overlay
!= NULL
)
499 this->buffer
= this->sdl_overlay
->pixels
[ 0 ];
501 if ( SDL_LockYUVOverlay( this->sdl_overlay
) >= 0 )
504 memcpy( this->buffer
, image
, width
* height
* 2 );
505 SDL_UnlockYUVOverlay( this->sdl_overlay
);
506 SDL_DisplayYUVOverlay( this->sdl_overlay
, &this->sdl_screen
->clip_rect
);
508 sdl_unlock_display();
515 static void *video_thread( void *arg
)
518 consumer_sdl
this = arg
;
520 // Obtain time of thread start
525 mlt_frame next
= NULL
;
526 mlt_properties properties
= NULL
;
529 // Get the current time
530 gettimeofday( &now
, NULL
);
532 // Determine start time
533 start
= ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
;
535 while ( this->running
)
537 // Pop the next frame
538 pthread_mutex_lock( &this->video_mutex
);
539 while ( ( next
= mlt_deque_pop_front( this->queue
) ) == NULL
&& this->running
)
540 pthread_cond_wait( &this->video_cond
, &this->video_mutex
);
541 pthread_mutex_unlock( &this->video_mutex
);
543 // Get the properties
544 properties
= mlt_frame_properties( next
);
546 // Get the speed of the frame
547 speed
= mlt_properties_get_double( properties
, "_speed" );
549 // Get the current time
550 gettimeofday( &now
, NULL
);
552 // Get the elapsed time
553 elapsed
= ( ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
) - start
;
555 // See if we have to delay the display of the current frame
556 if ( mlt_properties_get_int( properties
, "rendered" ) == 1 && this->running
)
558 // Obtain the scheduled playout time
559 mlt_position scheduled
= mlt_properties_get_position( properties
, "playtime" );
561 // Determine the difference between the elapsed time and the scheduled playout time
562 mlt_position difference
= scheduled
- elapsed
;
564 // Smooth playback a bit
565 if ( difference
> 20000 && speed
== 1.0 )
567 tm
.tv_sec
= difference
/ 1000000;
568 tm
.tv_nsec
= ( difference
% 1000000 ) * 500;
569 nanosleep( &tm
, NULL
);
572 // Show current frame if not too old
573 if ( difference
> -10000 || speed
!= 1.0 || mlt_deque_count( this->queue
) < 2 )
574 consumer_play_video( this, next
);
576 // If the queue is empty, recalculate start to allow build up again
577 if ( mlt_deque_count( this->queue
) == 0 && speed
== 1.0 )
579 gettimeofday( &now
, NULL
);
580 start
= ( ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
) - scheduled
+ 20000;
584 // This frame can now be closed
585 mlt_frame_close( next
);
591 /** Threaded wrapper for pipe.
594 static void *consumer_thread( void *arg
)
597 consumer_sdl
this = arg
;
600 mlt_consumer consumer
= &this->parent
;
605 // internal intialization
608 mlt_frame frame
= NULL
;
609 mlt_properties properties
= NULL
;
611 int64_t playtime
= 0;
613 if ( SDL_Init( SDL_INIT_VIDEO
| SDL_INIT_AUDIO
| SDL_INIT_NOPARACHUTE
) < 0 )
615 fprintf( stderr
, "Failed to initialize SDL: %s\n", SDL_GetError() );
619 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY
, SDL_DEFAULT_REPEAT_INTERVAL
);
620 SDL_EnableUNICODE( 1 );
622 // Loop until told not to
623 while( this->running
)
625 // Get a frame from the attached producer
626 frame
= mlt_consumer_rt_frame( consumer
);
628 // Ensure that we have a frame
631 // Get the frame properties
632 properties
= mlt_frame_properties( frame
);
635 init_audio
= consumer_play_audio( this, frame
, init_audio
, &duration
);
637 // Determine the start time now
638 if ( this->playing
&& init_video
)
640 // Create the video thread
641 pthread_create( &thread
, NULL
, video_thread
, this );
643 // Video doesn't need to be initialised any more
647 // Set playtime for this frame
648 mlt_properties_set_position( properties
, "playtime", playtime
);
650 // Push this frame to the back of the queue
651 pthread_mutex_lock( &this->video_mutex
);
652 mlt_deque_push_back( this->queue
, frame
);
653 pthread_cond_broadcast( &this->video_cond
);
654 pthread_mutex_unlock( &this->video_mutex
);
656 // Calculate the next playtime
657 playtime
+= ( duration
* 1000 );
661 // Kill the video thread
662 if ( init_video
== 0 )
664 pthread_mutex_lock( &this->video_mutex
);
665 pthread_cond_broadcast( &this->video_cond
);
666 pthread_mutex_unlock( &this->video_mutex
);
667 pthread_join( thread
, NULL
);
671 if ( this->sdl_overlay
!= NULL
)
672 SDL_FreeYUVOverlay( this->sdl_overlay
);
675 while( mlt_deque_count( this->queue
) )
676 mlt_frame_close( mlt_deque_pop_back( this->queue
) );
678 this->sdl_screen
= NULL
;
679 this->sdl_overlay
= NULL
;
680 this->audio_avail
= 0;
685 static int consumer_get_dimensions( int *width
, int *height
)
689 // SDL windows manager structure
692 // Specify the SDL Version
693 SDL_VERSION( &wm
.version
);
695 // Get the wm structure
696 if ( SDL_GetWMInfo( &wm
) == 1 )
698 // Check that we have the X11 wm
699 if ( wm
.subsystem
== SDL_SYSWM_X11
)
701 // Get the SDL window
702 Window window
= wm
.info
.x11
.window
;
704 // Get the display session
705 Display
*display
= wm
.info
.x11
.display
;
707 // Get the window attributes
708 XWindowAttributes attr
;
709 XGetWindowAttributes( display
, window
, &attr
);
711 // Determine whether window has changed
712 changed
= *width
!= attr
.width
|| *height
!= attr
.height
;
714 // Return width and height
716 *height
= attr
.height
;
723 /** Callback to allow override of the close method.
726 static void consumer_close( mlt_consumer parent
)
728 // Get the actual object
729 consumer_sdl
this = parent
->child
;
732 mlt_consumer_stop( parent
);
735 mlt_deque_close( this->queue
);
738 pthread_mutex_destroy( &this->audio_mutex
);
739 pthread_cond_destroy( &this->audio_cond
);
741 // Now clean up the rest
742 mlt_consumer_close( parent
);
744 // Finally clean up this