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
;
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
);
76 /** This is what will be called by the factory - anything can be passed in
77 via the argument, but keep it simple.
80 mlt_consumer
consumer_sdl_init( char *arg
)
82 // Create the consumer object
83 consumer_sdl
this = calloc( sizeof( struct consumer_sdl_s
), 1 );
85 // If no malloc'd and consumer init ok
86 if ( this != NULL
&& mlt_consumer_init( &this->parent
, this ) == 0 )
89 this->queue
= mlt_deque_init( );
91 // Get the parent consumer object
92 mlt_consumer parent
= &this->parent
;
94 // We have stuff to clean up, so override the close method
95 parent
->close
= consumer_close
;
97 // get a handle on properties
98 mlt_service service
= mlt_consumer_service( parent
);
99 this->properties
= mlt_service_properties( service
);
101 // Set the default volume
102 mlt_properties_set_double( this->properties
, "volume", 1.0 );
104 // This is the initialisation of the consumer
105 pthread_mutex_init( &this->audio_mutex
, NULL
);
106 pthread_cond_init( &this->audio_cond
, NULL
);
107 pthread_mutex_init( &this->video_mutex
, NULL
);
108 pthread_cond_init( &this->video_cond
, NULL
);
110 // Default scaler (for now we'll use nearest)
111 mlt_properties_set( this->properties
, "rescale", "nearest" );
113 // Default buffer for low latency
114 mlt_properties_set_int( this->properties
, "buffer", 1 );
116 // Default progressive true
117 mlt_properties_set_int( this->properties
, "progressive", 0 );
119 // Default audio buffer
120 mlt_properties_set_int( this->properties
, "audio_buffer", 1024 );
122 // Get sample aspect ratio
123 this->aspect_ratio
= mlt_properties_get_double( this->properties
, "aspect_ratio" );
125 // Ensure we don't join on a non-running object
128 // Default display aspect ratio
129 this->display_aspect
= 4.0 / 3.0;
131 // process actual param
132 if ( arg
== NULL
|| sscanf( arg
, "%dx%d", &this->width
, &this->height
) != 2 )
134 this->width
= mlt_properties_get_int( this->properties
, "width" );
135 this->height
= mlt_properties_get_int( this->properties
, "height" );
137 // Default window size
138 this->window_width
= ( float )this->height
* this->display_aspect
;
139 this->window_height
= this->height
;
143 if ( (int)( ( float )this->width
/ this->height
* 1000 ) !=
144 (int)( this->display_aspect
* 1000 ) )
147 this->display_aspect
= ( float )this->width
/ this->height
;
148 this->aspect_ratio
= 1.0;
149 mlt_properties_set_double( this->properties
, "aspect_ratio", this->aspect_ratio
);
153 this->window_width
= this->width
;
154 this->window_height
= this->height
;
158 this->sdl_flags
= SDL_HWSURFACE
| SDL_ASYNCBLIT
| SDL_HWACCEL
| SDL_RESIZABLE
| SDL_DOUBLEBUF
;
160 // Allow thread to be started/stopped
161 parent
->start
= consumer_start
;
162 parent
->stop
= consumer_stop
;
163 parent
->is_stopped
= consumer_is_stopped
;
165 // Return the consumer produced
169 // malloc or consumer init failed
176 int consumer_start( mlt_consumer parent
)
178 consumer_sdl
this = parent
->child
;
180 if ( !this->running
)
182 pthread_attr_t thread_attributes
;
184 consumer_stop( parent
);
189 // Allow the user to force resizing to window size
190 if ( mlt_properties_get_int( this->properties
, "resize" ) )
192 mlt_properties_set_int( this->properties
, "width", this->width
);
193 mlt_properties_set_int( this->properties
, "height", this->height
);
196 // Inherit the scheduling priority
197 pthread_attr_init( &thread_attributes
);
198 pthread_attr_setinheritsched( &thread_attributes
, PTHREAD_INHERIT_SCHED
);
200 pthread_create( &this->thread
, &thread_attributes
, consumer_thread
, this );
206 int consumer_stop( mlt_consumer parent
)
208 // Get the actual object
209 consumer_sdl
this = parent
->child
;
211 if ( this->joined
== 0 )
213 // Kill the thread and clean up
216 pthread_mutex_lock( &this->audio_mutex
);
217 pthread_cond_broadcast( &this->audio_cond
);
218 pthread_mutex_unlock( &this->audio_mutex
);
220 pthread_join( this->thread
, NULL
);
227 int consumer_is_stopped( mlt_consumer parent
)
229 consumer_sdl
this = parent
->child
;
230 return !this->running
;
233 static int sdl_lock_display( )
235 SDL_Surface
*screen
= SDL_GetVideoSurface( );
236 return screen
!= NULL
&& ( !SDL_MUSTLOCK( screen
) || SDL_LockSurface( screen
) >= 0 );
239 static void sdl_unlock_display( )
241 SDL_Surface
*screen
= SDL_GetVideoSurface( );
242 if ( screen
!= NULL
&& SDL_MUSTLOCK( screen
) )
243 SDL_UnlockSurface( screen
);
246 static void sdl_fill_audio( void *udata
, uint8_t *stream
, int len
)
248 consumer_sdl
this = udata
;
251 float volume
= mlt_properties_get_double( this->properties
, "volume" );
253 pthread_mutex_lock( &this->audio_mutex
);
255 // Block until audio received
256 while ( this->running
&& len
> this->audio_avail
)
257 pthread_cond_wait( &this->audio_cond
, &this->audio_mutex
);
259 if ( this->audio_avail
>= len
)
261 // Place in the audio buffer
262 memcpy( stream
, this->audio_buffer
, len
);
264 // Remove len from the audio available
265 this->audio_avail
-= len
;
267 // Remove the samples
268 memmove( this->audio_buffer
, this->audio_buffer
+ len
, this->audio_avail
);
272 // Just to be safe, wipe the stream first
273 memset( stream
, 0, len
);
275 // Copy what we have into the stream
276 memcpy( stream
, this->audio_buffer
, this->audio_avail
);
279 SDL_MixAudio( stream
, stream
, len
, ( int )( ( float )SDL_MIX_MAXVOLUME
* volume
) );
282 this->audio_avail
= 0;
285 // We're definitely playing now
288 pthread_cond_broadcast( &this->audio_cond
);
289 pthread_mutex_unlock( &this->audio_mutex
);
292 static int consumer_play_audio( consumer_sdl
this, mlt_frame frame
, int init_audio
, int *duration
)
294 // Get the properties of this consumer
295 mlt_properties properties
= this->properties
;
296 mlt_audio_format afmt
= mlt_audio_pcm
;
298 // Set the preferred params of the test card signal
299 int channels
= mlt_properties_get_int( properties
, "channels" );
300 int frequency
= mlt_properties_get_int( properties
, "frequency" );
301 static int counter
= 0;
303 int samples
= mlt_sample_calculator( mlt_properties_get_double( this->properties
, "fps" ), frequency
, counter
++ );
308 mlt_frame_get_audio( frame
, &pcm
, &afmt
, &frequency
, &channels
, &samples
);
309 *duration
= ( ( samples
* 1000 ) / frequency
);
311 if ( mlt_properties_get_int( properties
, "audio_off" ) )
318 if ( init_audio
== 1 )
320 SDL_AudioSpec request
;
323 int audio_buffer
= mlt_properties_get_int( properties
, "audio_buffer" );
325 // specify audio format
326 memset( &request
, 0, sizeof( SDL_AudioSpec
) );
328 request
.freq
= frequency
;
329 request
.format
= AUDIO_S16
;
330 request
.channels
= channels
;
331 request
.samples
= audio_buffer
;
332 request
.callback
= sdl_fill_audio
;
333 request
.userdata
= (void *)this;
334 if ( SDL_OpenAudio( &request
, &got
) != 0 )
336 fprintf( stderr
, "SDL failed to open audio: %s\n", SDL_GetError() );
339 else if ( got
.size
!= 0 )
346 if ( init_audio
== 0 )
348 mlt_properties properties
= mlt_frame_properties( frame
);
349 bytes
= ( samples
* channels
* 2 );
350 pthread_mutex_lock( &this->audio_mutex
);
351 while ( this->running
&& bytes
> ( sizeof( this->audio_buffer
) - this->audio_avail
) )
352 pthread_cond_wait( &this->audio_cond
, &this->audio_mutex
);
355 if ( mlt_properties_get_double( properties
, "_speed" ) == 1 )
356 memcpy( &this->audio_buffer
[ this->audio_avail
], pcm
, bytes
);
358 memset( &this->audio_buffer
[ this->audio_avail
], 0, bytes
);
359 this->audio_avail
+= bytes
;
361 pthread_cond_broadcast( &this->audio_cond
);
362 pthread_mutex_unlock( &this->audio_mutex
);
372 static int consumer_play_video( consumer_sdl
this, mlt_frame frame
)
374 // Get the properties of this consumer
375 mlt_properties properties
= this->properties
;
377 mlt_image_format vfmt
= mlt_image_yuv422
;
378 int width
= this->width
, height
= this->height
;
382 if ( mlt_properties_get_int( properties
, "video_off" ) == 0 )
384 // Get the image, width and height
385 mlt_frame_get_image( frame
, &image
, &vfmt
, &width
, &height
, 0 );
388 if ( this->sdl_screen
!= NULL
)
392 changed
= consumer_get_dimensions( &this->window_width
, &this->window_height
);
394 while ( SDL_PollEvent( &event
) )
398 case SDL_VIDEORESIZE
:
399 this->window_width
= event
.resize
.w
;
400 this->window_height
= event
.resize
.h
;
408 mlt_producer producer
= mlt_properties_get_data( properties
, "transport_producer", NULL
);
409 char keyboard
[ 2 ] = " ";
410 void (*callback
)( mlt_producer
, char * ) = mlt_properties_get_data( properties
, "transport_callback", NULL
);
411 if ( callback
!= NULL
&& producer
!= NULL
&& event
.key
.keysym
.unicode
< 0x80 && event
.key
.keysym
.unicode
> 0 )
413 keyboard
[ 0 ] = ( char )event
.key
.keysym
.unicode
;
414 callback( producer
, keyboard
);
422 if ( width
!= this->width
|| height
!= this->height
|| this->last_frame_aspect
!= mlt_frame_get_aspect_ratio( frame
) )
425 this->height
= height
;
426 this->last_frame_aspect
= mlt_frame_get_aspect_ratio( frame
);
430 if ( this->sdl_screen
== NULL
|| changed
)
432 // Determine frame's display aspect ratio
433 float frame_aspect
= mlt_frame_get_aspect_ratio( frame
) * this->width
/ this->height
;
435 // Determine window's new display aspect ratio
436 float this_aspect
= ( float )this->window_width
/ this->window_height
;
438 // If using hardware scaler
439 if ( mlt_properties_get( properties
, "rescale" ) != NULL
&&
440 !strcmp( mlt_properties_get( properties
, "rescale" ), "none" ) )
442 // Special case optimisation to negate odd effect of sample aspect ratio
443 // not corresponding exactly with image resolution.
444 if ( ( (int)( this_aspect
* 1000 ) == (int)( this->display_aspect
* 1000 ) ) &&
445 ( (int)( mlt_frame_get_aspect_ratio( frame
) * 1000 ) == (int)( this->aspect_ratio
* 1000 ) ) )
447 this->rect
.w
= this->window_width
;
448 this->rect
.h
= this->window_height
;
452 // Use hardware scaler to normalise display aspect ratio
453 this->rect
.w
= frame_aspect
/ this_aspect
* this->window_width
;
454 this->rect
.h
= this->window_height
;
455 if ( this->rect
.w
> this->window_width
)
457 this->rect
.w
= this->window_width
;
458 this->rect
.h
= this_aspect
/ frame_aspect
* this->window_height
;
462 // Special case optimisation to negate odd effect of sample aspect ratio
463 // not corresponding exactly with image resolution.
464 else if ( (int)( this_aspect
* 1000 ) == (int)( this->display_aspect
* 1000 ) )
466 this->rect
.w
= this->window_width
;
467 this->rect
.h
= this->window_height
;
469 // Use hardware scaler to normalise sample aspect ratio
470 else if ( this->window_height
* this->display_aspect
> this->window_width
)
472 this->rect
.w
= this->window_width
;
473 this->rect
.h
= this->window_width
/ this->display_aspect
;
477 this->rect
.w
= this->window_height
* this->display_aspect
;
478 this->rect
.h
= this->window_height
;
481 this->rect
.x
= ( this->window_width
- this->rect
.w
) / 2;
482 this->rect
.y
= ( this->window_height
- this->rect
.h
) / 2;
484 mlt_properties_set_int( this->properties
, "rect_x", this->rect
.x
);
485 mlt_properties_set_int( this->properties
, "rect_y", this->rect
.y
);
486 mlt_properties_set_int( this->properties
, "rect_w", this->rect
.w
);
487 mlt_properties_set_int( this->properties
, "rect_h", this->rect
.h
);
489 // Force an overlay recreation
490 if ( this->sdl_overlay
!= NULL
)
491 SDL_FreeYUVOverlay( this->sdl_overlay
);
493 // open SDL window with video overlay, if possible
495 this->sdl_screen
= SDL_SetVideoMode( this->window_width
, this->window_height
, 0, this->sdl_flags
);
496 sdl_unlock_display();
498 if ( this->sdl_screen
!= NULL
)
500 SDL_SetClipRect( this->sdl_screen
, &this->rect
);
502 this->sdl_overlay
= SDL_CreateYUVOverlay( this->width
, this->height
, SDL_YUY2_OVERLAY
, this->sdl_screen
);
503 sdl_unlock_display();
507 if ( mlt_properties_get_int( properties
, "changed" ) )
510 this->sdl_screen
= SDL_SetVideoMode( this->window_width
, this->window_height
, 0, this->sdl_flags
);
511 SDL_SetClipRect( this->sdl_screen
, &this->rect
);
512 SDL_Flip( this->sdl_screen
);
513 sdl_unlock_display();
514 mlt_properties_set_int( properties
, "changed", 0 );
517 if ( this->sdl_screen
!= NULL
&& this->sdl_overlay
!= NULL
)
519 this->buffer
= this->sdl_overlay
->pixels
[ 0 ];
521 if ( SDL_LockYUVOverlay( this->sdl_overlay
) >= 0 )
524 memcpy( this->buffer
, image
, width
* height
* 2 );
525 SDL_UnlockYUVOverlay( this->sdl_overlay
);
526 SDL_DisplayYUVOverlay( this->sdl_overlay
, &this->sdl_screen
->clip_rect
);
528 sdl_unlock_display();
535 static void *video_thread( void *arg
)
538 consumer_sdl
this = arg
;
540 // Obtain time of thread start
545 mlt_frame next
= NULL
;
546 mlt_properties properties
= NULL
;
549 // Get real time flag
550 int real_time
= mlt_properties_get_int( this->properties
, "real_time" );
552 // Get the current time
553 gettimeofday( &now
, NULL
);
555 // Determine start time
556 start
= ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
;
558 while ( this->running
)
560 // Pop the next frame
561 pthread_mutex_lock( &this->video_mutex
);
562 while ( ( next
= mlt_deque_pop_front( this->queue
) ) == NULL
&& this->running
)
563 pthread_cond_wait( &this->video_cond
, &this->video_mutex
);
564 pthread_mutex_unlock( &this->video_mutex
);
566 // Get the properties
567 properties
= mlt_frame_properties( next
);
569 // Get the speed of the frame
570 speed
= mlt_properties_get_double( properties
, "_speed" );
572 // Get the current time
573 gettimeofday( &now
, NULL
);
575 // Get the elapsed time
576 elapsed
= ( ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
) - start
;
578 // See if we have to delay the display of the current frame
579 if ( mlt_properties_get_int( properties
, "rendered" ) == 1 && this->running
)
581 // Obtain the scheduled playout time
582 mlt_position scheduled
= mlt_properties_get_position( properties
, "playtime" );
584 // Determine the difference between the elapsed time and the scheduled playout time
585 mlt_position difference
= scheduled
- elapsed
;
587 // Smooth playback a bit
588 if ( real_time
&& ( difference
> 20000 && speed
== 1.0 ) )
590 tm
.tv_sec
= difference
/ 1000000;
591 tm
.tv_nsec
= ( difference
% 1000000 ) * 500;
592 nanosleep( &tm
, NULL
);
595 // Show current frame if not too old
596 if ( !real_time
|| ( difference
> -10000 || speed
!= 1.0 || mlt_deque_count( this->queue
) < 2 ) )
597 consumer_play_video( this, next
);
599 // If the queue is empty, recalculate start to allow build up again
600 if ( real_time
&& ( mlt_deque_count( this->queue
) == 0 && speed
== 1.0 ) )
602 gettimeofday( &now
, NULL
);
603 start
= ( ( int64_t )now
.tv_sec
* 1000000 + now
.tv_usec
) - scheduled
+ 20000;
607 // This frame can now be closed
608 mlt_frame_close( next
);
611 mlt_consumer_stopped( &this->parent
);
616 /** Threaded wrapper for pipe.
619 static void *consumer_thread( void *arg
)
622 consumer_sdl
this = arg
;
625 mlt_consumer consumer
= &this->parent
;
630 // internal intialization
633 mlt_frame frame
= NULL
;
634 mlt_properties properties
= NULL
;
636 int64_t playtime
= 0;
637 struct timespec tm
= { 0, 100000 };
639 if ( SDL_Init( SDL_INIT_VIDEO
| SDL_INIT_AUDIO
| SDL_INIT_NOPARACHUTE
) < 0 )
641 fprintf( stderr
, "Failed to initialize SDL: %s\n", SDL_GetError() );
645 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY
, SDL_DEFAULT_REPEAT_INTERVAL
);
646 SDL_EnableUNICODE( 1 );
648 // Loop until told not to
649 while( this->running
)
651 // Get a frame from the attached producer
652 frame
= mlt_consumer_rt_frame( consumer
);
654 // Ensure that we have a frame
657 // Get the frame properties
658 properties
= mlt_frame_properties( frame
);
661 init_audio
= consumer_play_audio( this, frame
, init_audio
, &duration
);
663 // Determine the start time now
664 if ( this->playing
&& init_video
)
666 // Create the video thread
667 pthread_create( &thread
, NULL
, video_thread
, this );
669 // Video doesn't need to be initialised any more
673 // Set playtime for this frame
674 mlt_properties_set_position( properties
, "playtime", playtime
);
676 while ( this->running
&& mlt_deque_count( this->queue
) > 15 )
677 nanosleep( &tm
, NULL
);
679 // Push this frame to the back of the queue
680 pthread_mutex_lock( &this->video_mutex
);
681 mlt_deque_push_back( this->queue
, frame
);
682 pthread_cond_broadcast( &this->video_cond
);
683 pthread_mutex_unlock( &this->video_mutex
);
685 // Calculate the next playtime
686 playtime
+= ( duration
* 1000 );
690 // Kill the video thread
691 if ( init_video
== 0 )
693 pthread_mutex_lock( &this->video_mutex
);
694 pthread_cond_broadcast( &this->video_cond
);
695 pthread_mutex_unlock( &this->video_mutex
);
696 pthread_join( thread
, NULL
);
700 if ( this->sdl_overlay
!= NULL
)
701 SDL_FreeYUVOverlay( this->sdl_overlay
);
704 while( mlt_deque_count( this->queue
) )
705 mlt_frame_close( mlt_deque_pop_back( this->queue
) );
707 this->sdl_screen
= NULL
;
708 this->sdl_overlay
= NULL
;
709 this->audio_avail
= 0;
714 static int consumer_get_dimensions( int *width
, int *height
)
718 // SDL windows manager structure
721 // Specify the SDL Version
722 SDL_VERSION( &wm
.version
);
727 // Get the wm structure
728 if ( SDL_GetWMInfo( &wm
) == 1 )
730 // Check that we have the X11 wm
731 if ( wm
.subsystem
== SDL_SYSWM_X11
)
733 // Get the SDL window
734 Window window
= wm
.info
.x11
.window
;
736 // Get the display session
737 Display
*display
= wm
.info
.x11
.display
;
739 // Get the window attributes
740 XWindowAttributes attr
;
741 XGetWindowAttributes( display
, window
, &attr
);
743 // Determine whether window has changed
744 changed
= *width
!= attr
.width
|| *height
!= attr
.height
;
746 // Return width and height
748 *height
= attr
.height
;
752 // Unlock the display
758 /** Callback to allow override of the close method.
761 static void consumer_close( mlt_consumer parent
)
763 // Get the actual object
764 consumer_sdl
this = parent
->child
;
767 mlt_consumer_stop( parent
);
770 mlt_deque_close( this->queue
);
773 pthread_mutex_destroy( &this->audio_mutex
);
774 pthread_cond_destroy( &this->audio_cond
);
776 // Now clean up the rest
777 mlt_consumer_close( parent
);
779 // Finally clean up this