]> git.sesse.net Git - mlt/blob - src/modules/sdl/consumer_sdl_preview.c
Fix video glitches when switching still and normal sdl consumers.
[mlt] / src / modules / sdl / consumer_sdl_preview.c
1 /*
2  * consumer_sdl_preview.c -- A Simple DirectMedia Layer consumer
3  * Copyright (C) 2004-2005 Ushodaya Enterprises Limited
4  * Author: Charles Yates
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #include <framework/mlt_consumer.h>
22 #include <framework/mlt_frame.h>
23 #include <framework/mlt_factory.h>
24 #include <framework/mlt_producer.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <pthread.h>
28 #include <SDL/SDL.h>
29 #include <SDL/SDL_syswm.h>
30
31 extern pthread_mutex_t mlt_sdl_mutex;
32
33 typedef struct consumer_sdl_s *consumer_sdl;
34
35 struct consumer_sdl_s
36 {
37         struct mlt_consumer_s parent;
38         mlt_consumer active;
39         int ignore_change;
40         mlt_consumer play;
41         mlt_consumer still;
42         pthread_t thread;
43         int joined;
44         int running;
45         int sdl_flags;
46         double last_speed;
47         mlt_position last_position;
48
49         pthread_cond_t refresh_cond;
50         pthread_mutex_t refresh_mutex;
51         int refresh_count;
52 };
53
54 /** Forward references to static functions.
55 */
56
57 static int consumer_start( mlt_consumer parent );
58 static int consumer_stop( mlt_consumer parent );
59 static int consumer_is_stopped( mlt_consumer parent );
60 static void consumer_close( mlt_consumer parent );
61 static void *consumer_thread( void * );
62 static void consumer_frame_show_cb( mlt_consumer sdl, mlt_consumer this, mlt_frame frame );
63 static void consumer_sdl_event_cb( mlt_consumer sdl, mlt_consumer this, SDL_Event *event );
64 static void consumer_refresh_cb( mlt_consumer sdl, mlt_consumer this, char *name );
65
66 mlt_consumer consumer_sdl_preview_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
67 {
68         consumer_sdl this = calloc( sizeof( struct consumer_sdl_s ), 1 );
69         if ( this != NULL && mlt_consumer_init( &this->parent, this, profile ) == 0 )
70         {
71                 // Get the parent consumer object
72                 mlt_consumer parent = &this->parent;
73
74                 // Get the properties
75                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
76
77                 // Get the width and height
78                 int width = mlt_properties_get_int( properties, "width" );
79                 int height = mlt_properties_get_int( properties, "height" );
80
81                 // Process actual param
82                 if ( arg == NULL || sscanf( arg, "%dx%d", &width, &height ) == 2 )
83                 {
84                         mlt_properties_set_int( properties, "width", width );
85                         mlt_properties_set_int( properties, "height", height );
86                 }
87
88                 // Create child consumers
89                 this->play = mlt_factory_consumer( profile, "sdl", arg );
90                 this->still = mlt_factory_consumer( profile, "sdl_still", arg );
91                 mlt_properties_set( properties, "real_time", "0" );
92                 mlt_properties_set( properties, "rescale", "nearest" );
93                 mlt_properties_set( properties, "deinterlace_method", "onefield" );
94                 parent->close = consumer_close;
95                 parent->start = consumer_start;
96                 parent->stop = consumer_stop;
97                 parent->is_stopped = consumer_is_stopped;
98                 this->joined = 1;
99                 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->play ), this, "consumer-frame-show", ( mlt_listener )consumer_frame_show_cb );
100                 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->still ), this, "consumer-frame-show", ( mlt_listener )consumer_frame_show_cb );
101                 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->play ), this, "consumer-sdl-event", ( mlt_listener )consumer_sdl_event_cb );
102                 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->still ), this, "consumer-sdl-event", ( mlt_listener )consumer_sdl_event_cb );
103                 pthread_cond_init( &this->refresh_cond, NULL );
104                 pthread_mutex_init( &this->refresh_mutex, NULL );
105                 mlt_events_listen( MLT_CONSUMER_PROPERTIES( parent ), this, "property-changed", ( mlt_listener )consumer_refresh_cb );
106                 return parent;
107         }
108         free( this );
109         return NULL;
110 }
111
112 void consumer_frame_show_cb( mlt_consumer sdl, mlt_consumer parent, mlt_frame frame )
113 {
114         consumer_sdl this = parent->child;
115         this->last_speed = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" );
116         this->last_position = mlt_frame_get_position( frame );
117         mlt_events_fire( MLT_CONSUMER_PROPERTIES( parent ), "consumer-frame-show", frame, NULL );
118 }
119
120 static void consumer_sdl_event_cb( mlt_consumer sdl, mlt_consumer parent, SDL_Event *event )
121 {
122         mlt_events_fire( MLT_CONSUMER_PROPERTIES( parent ), "consumer-sdl-event", event, NULL );
123 }
124
125 static void consumer_refresh_cb( mlt_consumer sdl, mlt_consumer parent, char *name )
126 {
127         if ( !strcmp( name, "refresh" ) )
128         {
129                 consumer_sdl this = parent->child;
130                 pthread_mutex_lock( &this->refresh_mutex );
131                 this->refresh_count = this->refresh_count <= 0 ? 1 : this->refresh_count ++;
132                 pthread_cond_broadcast( &this->refresh_cond );
133                 pthread_mutex_unlock( &this->refresh_mutex );
134         }
135 }
136
137 static int consumer_start( mlt_consumer parent )
138 {
139         consumer_sdl this = parent->child;
140
141         if ( !this->running )
142         {
143                 // properties
144                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
145                 mlt_properties play = MLT_CONSUMER_PROPERTIES( this->play );
146                 mlt_properties still = MLT_CONSUMER_PROPERTIES( this->still );
147
148                 char *window_id = mlt_properties_get( properties, "window_id" );
149                 char *audio_driver = mlt_properties_get( properties, "audio_driver" );
150                 char *video_driver = mlt_properties_get( properties, "video_driver" );
151                 char *audio_device = mlt_properties_get( properties, "audio_device" );
152                 char *output_display = mlt_properties_get( properties, "output_display" );
153                 int progressive = mlt_properties_get_int( properties, "progressive" ) | mlt_properties_get_int( properties, "deinterlace" );
154
155                 consumer_stop( parent );
156
157                 this->running = 1;
158                 this->joined = 0;
159                 this->last_speed = 1;
160
161                 if ( output_display != NULL )
162                         setenv( "DISPLAY", output_display, 1 );
163
164                 if ( window_id != NULL )
165                         setenv( "SDL_WINDOWID", window_id, 1 );
166
167                 if ( video_driver != NULL )
168                         setenv( "SDL_VIDEODRIVER", video_driver, 1 );
169
170                 if ( audio_driver != NULL )
171                         setenv( "SDL_AUDIODRIVER", audio_driver, 1 );
172
173                 if ( audio_device != NULL )
174                         setenv( "AUDIODEV", audio_device, 1 );
175
176                 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE ) < 0 )
177                 {
178                         fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
179                         return -1;
180                 }
181
182                 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
183                 SDL_EnableUNICODE( 1 );
184
185                 // Pass properties down
186                 mlt_properties_set_data( play, "transport_producer", mlt_properties_get_data( properties, "transport_producer", NULL ), 0, NULL, NULL );
187                 mlt_properties_set_data( still, "transport_producer", mlt_properties_get_data( properties, "transport_producer", NULL ), 0, NULL, NULL );
188                 mlt_properties_set_data( play, "transport_callback", mlt_properties_get_data( properties, "transport_callback", NULL ), 0, NULL, NULL );
189                 mlt_properties_set_data( still, "transport_callback", mlt_properties_get_data( properties, "transport_callback", NULL ), 0, NULL, NULL );
190
191                 mlt_properties_set_int( play, "progressive", progressive );
192                 mlt_properties_set_int( still, "progressive", progressive );
193
194                 mlt_properties_pass_list( play, properties, "resize,rescale,width,height,aspect_ratio,display_ratio,volume" );
195                 mlt_properties_pass_list( still, properties, "resize,rescale,width,height,aspect_ratio,display_ratio" );
196                 mlt_properties_pass_list( play, properties, "deinterlace_method" );
197                 mlt_properties_pass_list( still, properties, "deinterlace_method" );
198                 mlt_properties_pass_list( play, properties, "preview_off,preview_format,window_background" );
199                 mlt_properties_pass_list( still, properties, "preview_off,preview_format,window_background" );
200
201                 mlt_properties_pass( play, properties, "play." );
202                 mlt_properties_pass( still, properties, "still." );
203
204                 mlt_properties_set_data( play, "app_lock", mlt_properties_get_data( properties, "app_lock", NULL ), 0, NULL, NULL );
205                 mlt_properties_set_data( still, "app_lock", mlt_properties_get_data( properties, "app_lock", NULL ), 0, NULL, NULL );
206                 mlt_properties_set_data( play, "app_unlock", mlt_properties_get_data( properties, "app_unlock", NULL ), 0, NULL, NULL );
207                 mlt_properties_set_data( still, "app_unlock", mlt_properties_get_data( properties, "app_unlock", NULL ), 0, NULL, NULL );
208
209                 mlt_properties_set_int( play, "put_mode", 1 );
210                 mlt_properties_set_int( still, "put_mode", 1 );
211
212                 // Start the still producer just to initialise the gui
213                 mlt_consumer_start( this->still );
214                 this->active = this->still;
215
216                 // Inform child consumers that we control the sdl
217                 mlt_properties_set_int( play, "sdl_started", 1 );
218                 mlt_properties_set_int( still, "sdl_started", 1 );
219
220                 pthread_create( &this->thread, NULL, consumer_thread, this );
221         }
222
223         return 0;
224 }
225
226 static int consumer_stop( mlt_consumer parent )
227 {
228         // Get the actual object
229         consumer_sdl this = parent->child;
230
231         if ( this->joined == 0 )
232         {
233                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
234                 int app_locked = mlt_properties_get_int( properties, "app_locked" );
235                 void ( *lock )( void ) = mlt_properties_get_data( properties, "app_lock", NULL );
236                 void ( *unlock )( void ) = mlt_properties_get_data( properties, "app_unlock", NULL );
237
238                 if ( app_locked && unlock ) unlock( );
239
240                 // Kill the thread and clean up
241                 this->running = 0;
242
243                 pthread_mutex_lock( &this->refresh_mutex );
244                 pthread_cond_broadcast( &this->refresh_cond );
245                 pthread_mutex_unlock( &this->refresh_mutex );
246                 if ( this->thread )
247                         pthread_join( this->thread, NULL );
248                 this->joined = 1;
249
250                 if ( app_locked && lock ) lock( );
251                 
252                 pthread_mutex_lock( &mlt_sdl_mutex );
253                 SDL_Quit( );
254                 pthread_mutex_unlock( &mlt_sdl_mutex );
255         }
256
257         return 0;
258 }
259
260 static int consumer_is_stopped( mlt_consumer parent )
261 {
262         consumer_sdl this = parent->child;
263         return !this->running;
264 }
265
266 static void *consumer_thread( void *arg )
267 {
268         // Identify the arg
269         consumer_sdl this = arg;
270
271         // Get the consumer
272         mlt_consumer consumer = &this->parent;
273
274         // Get the properties
275         mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
276
277         // internal intialization
278         int first = 1;
279         mlt_frame frame = NULL;
280         int last_position = -1;
281
282         // Determine if the application is dealing with the preview
283         int preview_off = mlt_properties_get_int( properties, "preview_off" );
284
285         this->refresh_count = 0;
286
287         // Loop until told not to
288         while( this->running )
289         {
290                 // Get a frame from the attached producer
291                 frame = mlt_consumer_get_frame( consumer );
292
293                 // Ensure that we have a frame
294                 if ( this->running && frame != NULL )
295                 {
296                         // Get the speed of the frame
297                         double speed = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" );
298
299                         // Lock during the operation
300                         mlt_service_lock( MLT_CONSUMER_SERVICE( consumer ) );
301
302                         // Get refresh request for the current frame
303                         int refresh = mlt_properties_get_int( properties, "refresh" );
304
305                         // Decrement refresh and clear changed
306                         mlt_events_block( properties, properties );
307                         mlt_properties_set_int( properties, "refresh", 0 );
308                         mlt_events_unblock( properties, properties );
309
310                         // Unlock after the operation
311                         mlt_service_unlock( MLT_CONSUMER_SERVICE( consumer ) );
312
313                         // Set the changed property on this frame for the benefit of still
314                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "refresh", refresh );
315
316                         // Make sure the recipient knows that this frame isn't really rendered
317                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 0 );
318
319                         // Optimisation to reduce latency
320                         if ( speed == 1.0 )
321                         {
322                                 if ( last_position != -1 && last_position + 1 != mlt_frame_get_position( frame ) )
323                                         mlt_consumer_purge( this->play );
324                                 last_position = mlt_frame_get_position( frame );
325                         }
326                         else
327                         {
328                                 //mlt_consumer_purge( this->play );
329                                 last_position = -1;
330                         }
331
332                         // If we're not the first frame and both consumers are stopped, then stop ourselves
333                         if ( !first && mlt_consumer_is_stopped( this->play ) && mlt_consumer_is_stopped( this->still ) )
334                         {
335                                 this->running = 0;
336                                 mlt_frame_close( frame );
337                         }
338                         // Allow a little grace time before switching consumers on speed changes
339                         else if ( this->ignore_change -- > 0 && this->active != NULL && !mlt_consumer_is_stopped( this->active ) )
340                         {
341                                 mlt_consumer_put_frame( this->active, frame );
342                         }
343                         // If we aren't playing normally, then use the still
344                         else if ( speed != 1 )
345                         {
346                                 if ( !mlt_consumer_is_stopped( this->play ) )
347                                         mlt_consumer_stop( this->play );
348                                 if ( mlt_consumer_is_stopped( this->still ) )
349                                 {
350                                         mlt_producer producer = mlt_service_get_producer( MLT_CONSUMER_SERVICE( consumer ) );
351                                         if ( producer )
352                                                 mlt_producer_seek( producer, this->last_position );
353                                         this->last_speed = speed;
354                                         this->active = this->still;
355                                         this->ignore_change = 0;
356                                         mlt_consumer_start( this->still );
357                                         mlt_frame_close( frame );
358                                 }
359                                 else
360                                 {
361                                         mlt_consumer_put_frame( this->still, frame );
362                                 }
363                         }
364                         // Otherwise use the normal player
365                         else
366                         {
367                                 if ( !mlt_consumer_is_stopped( this->still ) )
368                                         mlt_consumer_stop( this->still );
369                                 if ( mlt_consumer_is_stopped( this->play ) )
370                                 {
371                                         this->last_speed = speed;
372                                         this->active = this->play;
373                                         this->ignore_change = 25;
374                                         mlt_consumer_start( this->play );
375                                 }
376                                 mlt_consumer_put_frame( this->play, frame );
377                         }
378
379                         // Copy the rectangle info from the active consumer
380                         if ( this->running && preview_off == 0 )
381                         {
382                                 mlt_properties active = MLT_CONSUMER_PROPERTIES( this->active );
383                                 mlt_service_lock( MLT_CONSUMER_SERVICE( consumer ) );
384                                 mlt_properties_set_int( properties, "rect_x", mlt_properties_get_int( active, "rect_x" ) );
385                                 mlt_properties_set_int( properties, "rect_y", mlt_properties_get_int( active, "rect_y" ) );
386                                 mlt_properties_set_int( properties, "rect_w", mlt_properties_get_int( active, "rect_w" ) );
387                                 mlt_properties_set_int( properties, "rect_h", mlt_properties_get_int( active, "rect_h" ) );
388                                 mlt_service_unlock( MLT_CONSUMER_SERVICE( consumer ) );
389                         }
390
391                         if ( this->active == this->still )
392                         {
393                                 pthread_mutex_lock( &this->refresh_mutex );
394                                 if ( this->running && speed == 0 && this->refresh_count <= 0 )
395                                         pthread_cond_wait( &this->refresh_cond, &this->refresh_mutex );
396                                 this->refresh_count --;
397                                 pthread_mutex_unlock( &this->refresh_mutex );
398                         }
399
400                         // We are definitely not waiting on the first frame any more
401                         first = 0;
402                 }
403                 else
404                 {
405                         if ( frame ) mlt_frame_close( frame );
406                         mlt_consumer_put_frame( this->active, NULL );
407                         this->running = 0;
408                 }
409         }
410
411         if ( this->play ) mlt_consumer_stop( this->play );
412         if ( this->still ) mlt_consumer_stop( this->still );
413
414         return NULL;
415 }
416
417 /** Callback to allow override of the close method.
418 */
419
420 static void consumer_close( mlt_consumer parent )
421 {
422         // Get the actual object
423         consumer_sdl this = parent->child;
424
425         // Stop the consumer
426         mlt_consumer_stop( parent );
427
428         // Close the child consumers
429         mlt_consumer_close( this->play );
430         mlt_consumer_close( this->still );
431
432         // Now clean up the rest
433         mlt_consumer_close( parent );
434
435         // Finally clean up this
436         free( this );
437 }