git.sesse.net Git - mlt/blob - src/modules/sdl/consumer_sdl_preview.c

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