2 * consumer_sdl_preview.c -- A Simple DirectMedia Layer consumer
3 * Copyright (C) 2004-2005, 2010 Ushodaya Enterprises Limited
4 * Author: Charles Yates
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library 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 GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <framework/mlt_consumer.h>
22 #include <framework/mlt_frame.h>
23 #include <framework/mlt_factory.h>
24 #include <framework/mlt_producer.h>
29 #include <SDL_syswm.h>
32 extern pthread_mutex_t mlt_sdl_mutex;
34 typedef struct consumer_sdl_s *consumer_sdl;
38 struct mlt_consumer_s parent;
48 mlt_position last_position;
50 pthread_cond_t refresh_cond;
51 pthread_mutex_t refresh_mutex;
55 /** Forward references to static functions.
58 static int consumer_start( mlt_consumer parent );
59 static int consumer_stop( mlt_consumer parent );
60 static int consumer_is_stopped( mlt_consumer parent );
61 static void consumer_close( mlt_consumer parent );
62 static void *consumer_thread( void * );
63 static void consumer_frame_show_cb( mlt_consumer sdl, mlt_consumer this, mlt_frame frame );
64 static void consumer_sdl_event_cb( mlt_consumer sdl, mlt_consumer this, SDL_Event *event );
65 static void consumer_refresh_cb( mlt_consumer sdl, mlt_consumer this, char *name );
67 mlt_consumer consumer_sdl_preview_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
69 consumer_sdl this = calloc( sizeof( struct consumer_sdl_s ), 1 );
70 if ( this != NULL && mlt_consumer_init( &this->parent, this, profile ) == 0 )
72 // Get the parent consumer object
73 mlt_consumer parent = &this->parent;
76 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
78 // Get the width and height
79 int width = mlt_properties_get_int( properties, "width" );
80 int height = mlt_properties_get_int( properties, "height" );
82 // Process actual param
83 if ( arg == NULL || sscanf( arg, "%dx%d", &width, &height ) == 2 )
85 mlt_properties_set_int( properties, "width", width );
86 mlt_properties_set_int( properties, "height", height );
89 // Create child consumers
90 this->play = mlt_factory_consumer( profile, "sdl", arg );
91 this->still = mlt_factory_consumer( profile, "sdl_still", arg );
92 mlt_properties_set( properties, "real_time", "0" );
93 mlt_properties_set( properties, "rescale", "nearest" );
94 mlt_properties_set( properties, "deinterlace_method", "onefield" );
95 parent->close = consumer_close;
96 parent->start = consumer_start;
97 parent->stop = consumer_stop;
98 parent->is_stopped = consumer_is_stopped;
100 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->play ), this, "consumer-frame-show", ( mlt_listener )consumer_frame_show_cb );
101 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->still ), this, "consumer-frame-show", ( mlt_listener )consumer_frame_show_cb );
102 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->play ), this, "consumer-sdl-event", ( mlt_listener )consumer_sdl_event_cb );
103 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->still ), this, "consumer-sdl-event", ( mlt_listener )consumer_sdl_event_cb );
104 pthread_cond_init( &this->refresh_cond, NULL );
105 pthread_mutex_init( &this->refresh_mutex, NULL );
106 mlt_events_listen( MLT_CONSUMER_PROPERTIES( parent ), this, "property-changed", ( mlt_listener )consumer_refresh_cb );
107 mlt_events_register( properties, "consumer-sdl-paused", NULL );
114 void consumer_frame_show_cb( mlt_consumer sdl, mlt_consumer parent, mlt_frame frame )
116 consumer_sdl this = parent->child;
117 this->last_speed = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" );
118 this->last_position = mlt_frame_get_position( frame );
119 mlt_events_fire( MLT_CONSUMER_PROPERTIES( parent ), "consumer-frame-show", frame, NULL );
122 static void consumer_sdl_event_cb( mlt_consumer sdl, mlt_consumer parent, SDL_Event *event )
124 mlt_events_fire( MLT_CONSUMER_PROPERTIES( parent ), "consumer-sdl-event", event, NULL );
127 static void consumer_refresh_cb( mlt_consumer sdl, mlt_consumer parent, char *name )
129 if ( !strcmp( name, "refresh" ) )
131 consumer_sdl this = parent->child;
132 pthread_mutex_lock( &this->refresh_mutex );
133 this->refresh_count = this->refresh_count <= 0 ? 1 : this->refresh_count + 1;
134 pthread_cond_broadcast( &this->refresh_cond );
135 pthread_mutex_unlock( &this->refresh_mutex );
139 static int consumer_start( mlt_consumer parent )
141 consumer_sdl this = parent->child;
143 if ( !this->running )
146 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
147 mlt_properties play = MLT_CONSUMER_PROPERTIES( this->play );
148 mlt_properties still = MLT_CONSUMER_PROPERTIES( this->still );
150 char *window_id = mlt_properties_get( properties, "window_id" );
151 char *audio_driver = mlt_properties_get( properties, "audio_driver" );
152 char *video_driver = mlt_properties_get( properties, "video_driver" );
153 char *audio_device = mlt_properties_get( properties, "audio_device" );
154 char *output_display = mlt_properties_get( properties, "output_display" );
155 int progressive = mlt_properties_get_int( properties, "progressive" ) | mlt_properties_get_int( properties, "deinterlace" );
157 consumer_stop( parent );
161 this->last_speed = 1;
163 if ( output_display != NULL )
164 setenv( "DISPLAY", output_display, 1 );
166 if ( window_id != NULL )
167 setenv( "SDL_WINDOWID", window_id, 1 );
169 if ( video_driver != NULL )
170 setenv( "SDL_VIDEODRIVER", video_driver, 1 );
172 if ( audio_driver != NULL )
173 setenv( "SDL_AUDIODRIVER", audio_driver, 1 );
175 if ( audio_device != NULL )
176 setenv( "AUDIODEV", audio_device, 1 );
178 pthread_mutex_lock( &mlt_sdl_mutex );
179 int ret = SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE );
180 pthread_mutex_unlock( &mlt_sdl_mutex );
183 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
187 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
188 SDL_EnableUNICODE( 1 );
190 // Pass properties down
191 mlt_properties_set_data( play, "transport_producer", mlt_properties_get_data( properties, "transport_producer", NULL ), 0, NULL, NULL );
192 mlt_properties_set_data( still, "transport_producer", mlt_properties_get_data( properties, "transport_producer", NULL ), 0, NULL, NULL );
193 mlt_properties_set_data( play, "transport_callback", mlt_properties_get_data( properties, "transport_callback", NULL ), 0, NULL, NULL );
194 mlt_properties_set_data( still, "transport_callback", mlt_properties_get_data( properties, "transport_callback", NULL ), 0, NULL, NULL );
196 mlt_properties_set_int( play, "progressive", progressive );
197 mlt_properties_set_int( still, "progressive", progressive );
199 mlt_properties_pass_list( play, properties, "resize,rescale,width,height,aspect_ratio,display_ratio,volume" );
200 mlt_properties_pass_list( still, properties, "resize,rescale,width,height,aspect_ratio,display_ratio" );
201 mlt_properties_pass_list( play, properties, "deinterlace_method" );
202 mlt_properties_pass_list( still, properties, "deinterlace_method" );
203 mlt_properties_pass_list( play, properties, "preview_off,preview_format,window_background" );
204 mlt_properties_pass_list( still, properties, "preview_off,preview_format,window_background" );
206 mlt_properties_pass( play, properties, "play." );
207 mlt_properties_pass( still, properties, "still." );
209 mlt_properties_set_data( play, "app_lock", mlt_properties_get_data( properties, "app_lock", NULL ), 0, NULL, NULL );
210 mlt_properties_set_data( still, "app_lock", mlt_properties_get_data( properties, "app_lock", NULL ), 0, NULL, NULL );
211 mlt_properties_set_data( play, "app_unlock", mlt_properties_get_data( properties, "app_unlock", NULL ), 0, NULL, NULL );
212 mlt_properties_set_data( still, "app_unlock", mlt_properties_get_data( properties, "app_unlock", NULL ), 0, NULL, NULL );
214 mlt_properties_set_int( play, "put_mode", 1 );
215 mlt_properties_set_int( still, "put_mode", 1 );
216 mlt_properties_set_int( play, "terminate_on_pause", 1 );
218 // Start the still producer just to initialise the gui
219 mlt_consumer_start( this->still );
220 this->active = this->still;
222 // Inform child consumers that we control the sdl
223 mlt_properties_set_int( play, "sdl_started", 1 );
224 mlt_properties_set_int( still, "sdl_started", 1 );
226 pthread_create( &this->thread, NULL, consumer_thread, this );
232 static int consumer_stop( mlt_consumer parent )
234 // Get the actual object
235 consumer_sdl this = parent->child;
237 if ( this->joined == 0 )
239 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
240 int app_locked = mlt_properties_get_int( properties, "app_locked" );
241 void ( *lock )( void ) = mlt_properties_get_data( properties, "app_lock", NULL );
242 void ( *unlock )( void ) = mlt_properties_get_data( properties, "app_unlock", NULL );
244 if ( app_locked && unlock ) unlock( );
246 // Kill the thread and clean up
249 pthread_mutex_lock( &this->refresh_mutex );
250 pthread_cond_broadcast( &this->refresh_cond );
251 pthread_mutex_unlock( &this->refresh_mutex );
253 pthread_join( this->thread, NULL );
256 if ( app_locked && lock ) lock( );
258 pthread_mutex_lock( &mlt_sdl_mutex );
260 pthread_mutex_unlock( &mlt_sdl_mutex );
266 static int consumer_is_stopped( mlt_consumer parent )
268 consumer_sdl this = parent->child;
269 return !this->running;
272 static void *consumer_thread( void *arg )
275 consumer_sdl this = arg;
278 mlt_consumer consumer = &this->parent;
280 // Get the properties
281 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
283 // internal intialization
285 mlt_frame frame = NULL;
286 int last_position = -1;
288 int eos_threshold = 20 + mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( this->play ), "buffer" );
290 // Determine if the application is dealing with the preview
291 int preview_off = mlt_properties_get_int( properties, "preview_off" );
293 this->refresh_count = 0;
295 // Loop until told not to
296 while( this->running )
298 // Get a frame from the attached producer
299 frame = mlt_consumer_get_frame( consumer );
301 // Ensure that we have a frame
302 if ( this->running && frame != NULL )
304 // Get the speed of the frame
305 double speed = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" );
307 // Lock during the operation
308 mlt_service_lock( MLT_CONSUMER_SERVICE( consumer ) );
310 // Get refresh request for the current frame
311 int refresh = mlt_properties_get_int( properties, "refresh" );
313 // Decrement refresh and clear changed
314 mlt_events_block( properties, properties );
315 mlt_properties_set_int( properties, "refresh", 0 );
316 mlt_events_unblock( properties, properties );
318 // Unlock after the operation
319 mlt_service_unlock( MLT_CONSUMER_SERVICE( consumer ) );
321 // Set the changed property on this frame for the benefit of still
322 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "refresh", refresh );
324 // Make sure the recipient knows that this frame isn't really rendered
325 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 0 );
327 // Optimisation to reduce latency
330 if ( last_position != -1 && last_position + 1 != mlt_frame_get_position( frame ) )
331 mlt_consumer_purge( this->play );
332 last_position = mlt_frame_get_position( frame );
336 //mlt_consumer_purge( this->play );
340 // If we aren't playing normally, then use the still
343 mlt_producer producer = MLT_PRODUCER( mlt_service_get_producer( MLT_CONSUMER_SERVICE( consumer ) ) );
344 mlt_position duration = mlt_producer_get_playtime( producer );
347 if ( this->active == this->play )
349 // Do not interrupt the play consumer near the end
350 if ( duration - this->last_position > eos_threshold )
352 // Get a new frame at the sought position
353 mlt_frame_close( frame );
355 mlt_producer_seek( producer, this->last_position );
356 frame = mlt_consumer_get_frame( consumer );
361 // Send frame with speed 0 once to stop it
362 if ( frame && !eos && speed == 0.0 )
364 mlt_consumer_put_frame( this->play, frame );
368 // Check for end of stream
369 if ( mlt_consumer_is_stopped( this->play ) )
373 eos = 0; // reset eof indicator
379 // Start the still consumer
380 mlt_consumer_stop( this->play );
381 this->last_speed = speed;
382 this->active = this->still;
383 this->ignore_change = 0;
384 mlt_consumer_start( this->still );
386 // Send the frame to the active child
389 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "refresh", 1 );
390 mlt_consumer_put_frame( this->active, frame );
392 if ( pause && speed == 0.0 )
394 mlt_events_fire( properties, "consumer-sdl-paused", NULL );
397 // Allow a little grace time before switching consumers on speed changes
398 else if ( this->ignore_change -- > 0 && this->active != NULL && !mlt_consumer_is_stopped( this->active ) )
400 mlt_consumer_put_frame( this->active, frame );
402 // Otherwise use the normal player
405 if ( !mlt_consumer_is_stopped( this->still ) )
406 mlt_consumer_stop( this->still );
407 if ( mlt_consumer_is_stopped( this->play ) )
409 this->last_speed = speed;
410 this->active = this->play;
411 this->ignore_change = 0;
412 mlt_consumer_start( this->play );
414 mlt_consumer_put_frame( this->play, frame );
417 // Copy the rectangle info from the active consumer
418 if ( this->running && preview_off == 0 )
420 mlt_properties active = MLT_CONSUMER_PROPERTIES( this->active );
421 mlt_service_lock( MLT_CONSUMER_SERVICE( consumer ) );
422 mlt_properties_set_int( properties, "rect_x", mlt_properties_get_int( active, "rect_x" ) );
423 mlt_properties_set_int( properties, "rect_y", mlt_properties_get_int( active, "rect_y" ) );
424 mlt_properties_set_int( properties, "rect_w", mlt_properties_get_int( active, "rect_w" ) );
425 mlt_properties_set_int( properties, "rect_h", mlt_properties_get_int( active, "rect_h" ) );
426 mlt_service_unlock( MLT_CONSUMER_SERVICE( consumer ) );
429 if ( this->active == this->still )
431 pthread_mutex_lock( &this->refresh_mutex );
432 if ( this->running && speed == 0 && this->refresh_count <= 0 )
434 mlt_events_fire( properties, "consumer-sdl-paused", NULL );
435 pthread_cond_wait( &this->refresh_cond, &this->refresh_mutex );
437 this->refresh_count --;
438 pthread_mutex_unlock( &this->refresh_mutex );
441 // We are definitely not waiting on the first frame any more
446 if ( frame ) mlt_frame_close( frame );
447 mlt_consumer_put_frame( this->active, NULL );
452 if ( this->play ) mlt_consumer_stop( this->play );
453 if ( this->still ) mlt_consumer_stop( this->still );
458 /** Callback to allow override of the close method.
461 static void consumer_close( mlt_consumer parent )
463 // Get the actual object
464 consumer_sdl this = parent->child;
467 mlt_consumer_stop( parent );
469 // Close the child consumers
470 mlt_consumer_close( this->play );
471 mlt_consumer_close( this->still );
473 // Now clean up the rest
474 mlt_consumer_close( parent );
476 // Finally clean up this