git.sesse.net Git - mlt/blob - src/modules/gtk2/producer_pixbuf.c

   1 /*
   2  * producer_pixbuf.c -- raster image loader based upon gdk-pixbuf
   3  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
   4  * Author: Dan Dennedy <dan@dennedy.org>
   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 "producer_pixbuf.h"
  22 #include <framework/mlt_frame.h>
  23 #include <gdk-pixbuf/gdk-pixbuf.h>
  24
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <pthread.h>
  29 #include <math.h>
  30 #include <sys/types.h>
  31 #include <sys/stat.h>
  32 #include <unistd.h>
  33 #include <dirent.h>
  34
  35 static pthread_mutex_t fastmutex = PTHREAD_MUTEX_INITIALIZER;
  36
  37 typedef struct producer_pixbuf_s *producer_pixbuf;
  38
  39 struct producer_pixbuf_s
  40 {
  41         struct mlt_producer_s parent;
  42
  43         // File name list
  44         mlt_properties filenames;
  45         int count;
  46         int image_idx;
  47
  48         int width;
  49         int height;
  50         uint8_t *image;
  51         uint8_t *alpha;
  52 };
  53
  54 static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int index );
  55 static void producer_close( mlt_producer parent );
  56
  57 mlt_producer producer_pixbuf_init( char *filename )
  58 {
  59         producer_pixbuf this = calloc( sizeof( struct producer_pixbuf_s ), 1 );
  60         if ( this != NULL && mlt_producer_init( &this->parent, this ) == 0 )
  61         {
  62                 mlt_producer producer = &this->parent;
  63
  64                 // Get the properties interface
  65                 mlt_properties properties = MLT_PRODUCER_PROPERTIES( &this->parent );
  66
  67                 // Callback registration
  68                 producer->get_frame = producer_get_frame;
  69                 producer->close = ( mlt_destructor )producer_close;
  70
  71                 // Set the default properties
  72                 mlt_properties_set( properties, "resource", filename );
  73                 mlt_properties_set_int( properties, "ttl", 25 );
  74                 mlt_properties_set_int( properties, "aspect_ratio", 1 );
  75                 mlt_properties_set_int( properties, "progressive", 1 );
  76
  77                 return producer;
  78         }
  79         free( this );
  80         return NULL;
  81 }
  82
  83 static void refresh_image( mlt_frame frame, int width, int height )
  84 {
  85         // Pixbuf
  86         GdkPixbuf *pixbuf = mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "pixbuf", NULL );
  87         GError *error = NULL;
  88
  89         // Obtain properties of frame
  90         mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
  91
  92         // Obtain the producer for this frame
  93         producer_pixbuf this = mlt_properties_get_data( properties, "producer_pixbuf", NULL );
  94
  95         // Obtain the producer
  96         mlt_producer producer = &this->parent;
  97
  98         // Obtain properties of producer
  99         mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( producer );
 100
 101         // Obtain the cache flag and structure
 102         int use_cache = mlt_properties_get_int( producer_props, "cache" );
 103         mlt_properties cache = mlt_properties_get_data( producer_props, "_cache", NULL );
 104         int update_cache = 0;
 105
 106         // Get the time to live for each frame
 107         double ttl = mlt_properties_get_int( producer_props, "ttl" );
 108
 109         // Get the original position of this frame
 110         mlt_position position = mlt_properties_get_position( properties, "pixbuf_position" );
 111
 112         // Image index
 113         int image_idx = ( int )floor( ( double )position / ttl ) % this->count;
 114
 115         // Key for the cache
 116         char image_key[ 10 ];
 117         sprintf( image_key, "%d", image_idx );
 118
 119         pthread_mutex_lock( &fastmutex );
 120
 121         // Check if the frame is already loaded
 122         if ( use_cache )
 123         {
 124                 if ( cache == NULL )
 125                 {
 126                         cache = mlt_properties_new( );
 127                         mlt_properties_set_data( producer_props, "_cache", cache, 0, ( mlt_destructor )mlt_properties_close, NULL );
 128                 }
 129
 130                 mlt_frame cached = mlt_properties_get_data( cache, image_key, NULL );
 131
 132                 if ( cached )
 133                 {
 134                         this->image_idx = image_idx;
 135                         mlt_properties cached_props = MLT_FRAME_PROPERTIES( cached );
 136                         this->width = mlt_properties_get_int( cached_props, "width" );
 137                         this->height = mlt_properties_get_int( cached_props, "height" );
 138                         mlt_properties_set_int( producer_props, "_real_width", mlt_properties_get_int( cached_props, "real_width" ) );
 139                         mlt_properties_set_int( producer_props, "_real_height", mlt_properties_get_int( cached_props, "real_height" ) );
 140                         this->image = mlt_properties_get_data( cached_props, "image", NULL );
 141                         this->alpha = mlt_properties_get_data( cached_props, "alpha", NULL );
 142
 143                         if ( width != 0 && ( width != this->width || height != this->height ) )
 144                                 this->image = NULL;
 145                 }
 146         }
 147
 148     // optimization for subsequent iterations on single picture
 149         if ( width != 0 && this->image != NULL && image_idx == this->image_idx )
 150         {
 151                 if ( width != this->width || height != this->height )
 152                 {
 153                         pixbuf = mlt_properties_get_data( producer_props, "_pixbuf", NULL );
 154                         if ( !use_cache )
 155                         {
 156                                 mlt_pool_release( this->image );
 157                                 mlt_pool_release( this->alpha );
 158                         }
 159                         this->image = NULL;
 160                         this->alpha = NULL;
 161                 }
 162         }
 163         else if ( pixbuf == NULL && ( this->image == NULL || image_idx != this->image_idx ) )
 164         {
 165                 if ( !use_cache )
 166                 {
 167                         mlt_pool_release( this->image );
 168                         mlt_pool_release( this->alpha );
 169                 }
 170                 this->image = NULL;
 171                 this->alpha = NULL;
 172
 173                 this->image_idx = image_idx;
 174                 pixbuf = gdk_pixbuf_new_from_file( mlt_properties_get_value( this->filenames, image_idx ), &error );
 175
 176                 if ( pixbuf != NULL )
 177                 {
 178                         // Register this pixbuf for destruction and reuse
 179                         mlt_events_block( producer_props, NULL );
 180                         mlt_properties_set_data( producer_props, "_pixbuf", pixbuf, 0, ( mlt_destructor )g_object_unref, NULL );
 181                         g_object_ref( pixbuf );
 182                         mlt_properties_set_data( MLT_FRAME_PROPERTIES( frame ), "pixbuf", pixbuf, 0, ( mlt_destructor )g_object_unref, NULL );
 183
 184                         mlt_properties_set_int( producer_props, "_real_width", gdk_pixbuf_get_width( pixbuf ) );
 185                         mlt_properties_set_int( producer_props, "_real_height", gdk_pixbuf_get_height( pixbuf ) );
 186                         mlt_events_unblock( producer_props, NULL );
 187
 188                         // Store the width/height of the pixbuf temporarily
 189                         this->width = gdk_pixbuf_get_width( pixbuf );
 190                         this->height = gdk_pixbuf_get_height( pixbuf );
 191                 }
 192         }
 193
 194         // If we have a pixbuf
 195         if ( pixbuf && width > 0 )
 196         {
 197                 char *interps = mlt_properties_get( properties, "rescale.interp" );
 198                 int interp = GDK_INTERP_BILINEAR;
 199
 200                 if ( strcmp( interps, "nearest" ) == 0 )
 201                         interp = GDK_INTERP_NEAREST;
 202                 else if ( strcmp( interps, "tiles" ) == 0 )
 203                         interp = GDK_INTERP_TILES;
 204                 else if ( strcmp( interps, "hyper" ) == 0 )
 205                         interp = GDK_INTERP_HYPER;
 206
 207                 // Note - the original pixbuf is already safe and ready for destruction
 208                 pixbuf = gdk_pixbuf_scale_simple( pixbuf, width, height, interp );
 209
 210                 // Store width and height
 211                 this->width = width;
 212                 this->height = height;
 213
 214                 // Allocate/define image
 215                 this->image = mlt_pool_alloc( width * ( height + 1 ) * 2 );
 216
 217                 // Extract YUV422 and alpha
 218                 if ( gdk_pixbuf_get_has_alpha( pixbuf ) )
 219                 {
 220                         // Allocate the alpha mask
 221                         this->alpha = mlt_pool_alloc( this->width * this->height );
 222
 223                         // Convert the image
 224                         mlt_convert_rgb24a_to_yuv422( gdk_pixbuf_get_pixels( pixbuf ),
 225                                                                                   this->width, this->height,
 226                                                                                   gdk_pixbuf_get_rowstride( pixbuf ),
 227                                                                                   this->image, this->alpha );
 228                 }
 229                 else
 230                 {
 231                         // No alpha to extract
 232                         mlt_convert_rgb24_to_yuv422( gdk_pixbuf_get_pixels( pixbuf ),
 233                                                                                  this->width, this->height,
 234                                                                                  gdk_pixbuf_get_rowstride( pixbuf ),
 235                                                                                  this->image );
 236                 }
 237
 238                 // Finished with pixbuf now
 239                 g_object_unref( pixbuf );
 240
 241                 // Ensure we update the cache when we need to
 242                 update_cache = use_cache;
 243         }
 244
 245         // Set width/height of frame
 246         mlt_properties_set_int( properties, "width", this->width );
 247         mlt_properties_set_int( properties, "height", this->height );
 248         mlt_properties_set_int( properties, "real_width", mlt_properties_get_int( producer_props, "_real_width" ) );
 249         mlt_properties_set_int( properties, "real_height", mlt_properties_get_int( producer_props, "_real_height" ) );
 250
 251         // pass the image data without destructor
 252         mlt_properties_set_data( properties, "image", this->image, this->width * ( this->height + 1 ) * 2, NULL, NULL );
 253         mlt_properties_set_data( properties, "alpha", this->alpha, this->width * this->height, NULL, NULL );
 254
 255         if ( update_cache )
 256         {
 257                 mlt_frame cached = mlt_frame_init( );
 258                 mlt_properties cached_props = MLT_FRAME_PROPERTIES( cached );
 259                 mlt_properties_set_int( cached_props, "width", this->width );
 260                 mlt_properties_set_int( cached_props, "height", this->height );
 261                 mlt_properties_set_int( cached_props, "real_width", mlt_properties_get_int( producer_props, "_real_width" ) );
 262                 mlt_properties_set_int( cached_props, "real_height", mlt_properties_get_int( producer_props, "_real_height" ) );
 263                 mlt_properties_set_data( cached_props, "image", this->image, this->width * ( this->height + 1 ) * 2, mlt_pool_release, NULL );
 264                 mlt_properties_set_data( cached_props, "alpha", this->alpha, this->width * this->height, mlt_pool_release, NULL );
 265                 mlt_properties_set_data( cache, image_key, cached, 0, ( mlt_destructor )mlt_frame_close, NULL );
 266         }
 267
 268         pthread_mutex_unlock( &fastmutex );
 269 }
 270
 271 static int producer_get_image( mlt_frame frame, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable )
 272 {
 273         // Obtain properties of frame
 274         mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
 275
 276         // We need to know the size of the image to clone it
 277         int image_size = 0;
 278         int alpha_size = 0;
 279
 280         // Alpha channel
 281         uint8_t *alpha = NULL;
 282
 283         *width = mlt_properties_get_int( properties, "rescale_width" );
 284         *height = mlt_properties_get_int( properties, "rescale_height" );
 285
 286         // Refresh the image
 287         refresh_image( frame, *width, *height );
 288
 289         // Get the image
 290         *buffer = mlt_properties_get_data( properties, "image", &image_size );
 291         alpha = mlt_properties_get_data( properties, "alpha", &alpha_size );
 292
 293         // Get width and height (may have changed during the refresh)
 294         *width = mlt_properties_get_int( properties, "width" );
 295         *height = mlt_properties_get_int( properties, "height" );
 296
 297         // NB: Cloning is necessary with this producer (due to processing of images ahead of use)
 298         // The fault is not in the design of mlt, but in the implementation of the pixbuf producer...
 299         if ( *buffer != NULL )
 300         {
 301                 // Clone the image and the alpha
 302                 uint8_t *image_copy = mlt_pool_alloc( image_size );
 303                 uint8_t *alpha_copy = mlt_pool_alloc( alpha_size );
 304
 305                 memcpy( image_copy, *buffer, image_size );
 306
 307                 // Copy or default the alpha
 308                 if ( alpha != NULL )
 309                         memcpy( alpha_copy, alpha, alpha_size );
 310                 else
 311                         memset( alpha_copy, 255, alpha_size );
 312
 313                 // Now update properties so we free the copy after
 314                 mlt_properties_set_data( properties, "image", image_copy, image_size, mlt_pool_release, NULL );
 315                 mlt_properties_set_data( properties, "alpha", alpha_copy, alpha_size, mlt_pool_release, NULL );
 316
 317                 // We're going to pass the copy on
 318                 *buffer = image_copy;
 319         }
 320         else
 321         {
 322                 // TODO: Review all cases of invalid images
 323                 *buffer = mlt_pool_alloc( 50 * 50 * 2 );
 324                 mlt_properties_set_data( properties, "image", *buffer, image_size, mlt_pool_release, NULL );
 325                 *width = 50;
 326                 *height = 50;
 327         }
 328
 329         return 0;
 330 }
 331
 332 static uint8_t *producer_get_alpha_mask( mlt_frame this )
 333 {
 334         // Obtain properties of frame
 335         mlt_properties properties = MLT_FRAME_PROPERTIES( this );
 336
 337         // Return the alpha mask
 338         return mlt_properties_get_data( properties, "alpha", NULL );
 339 }
 340
 341 static int producer_get_frame( mlt_producer producer, mlt_frame_ptr frame, int index )
 342 {
 343         // Get the real structure for this producer
 344         producer_pixbuf this = producer->child;
 345
 346         // Fetch the producers properties
 347         mlt_properties producer_properties = MLT_PRODUCER_PROPERTIES( producer );
 348
 349         if ( this->filenames == NULL && mlt_properties_get( producer_properties, "resource" ) != NULL )
 350         {
 351                 char *filename = mlt_properties_get( producer_properties, "resource" );
 352                 this->filenames = mlt_properties_new( );
 353
 354                 // Read xml string
 355                 if ( strstr( filename, "<svg" ) )
 356                 {
 357                         // Generate a temporary file for the svg
 358                         char fullname[ 1024 ] = "/tmp/mlt.XXXXXX";
 359                         int fd = mkstemp( fullname );
 360
 361                         if ( fd > -1 )
 362                         {
 363                                 // Write the svg into the temp file
 364                                 ssize_t remaining_bytes;
 365                                 char *xml = filename;
 366
 367                                 // Strip leading crap
 368                                 while ( xml[0] != '<' )
 369                                         xml++;
 370
 371                                 remaining_bytes = strlen( xml );
 372                                 while ( remaining_bytes > 0 )
 373                                         remaining_bytes -= write( fd, xml + strlen( xml ) - remaining_bytes, remaining_bytes );
 374                                 close( fd );
 375
 376                                 mlt_properties_set( this->filenames, "0", fullname );
 377
 378                                 // Teehe - when the producer closes, delete the temp file and the space allo
 379                                 mlt_properties_set_data( producer_properties, "__temporary_file__", fullname, 0, ( mlt_destructor )unlink, NULL );
 380                         }
 381                 }
 382                 // Obtain filenames
 383                 else if ( strchr( filename, '%' ) != NULL )
 384                 {
 385                         // handle picture sequences
 386                         int i = mlt_properties_get_int( producer_properties, "begin" );
 387                         int gap = 0;
 388                         char full[1024];
 389                         int keyvalue = 0;
 390                         char key[ 50 ];
 391
 392                         while ( gap < 100 )
 393                         {
 394                                 struct stat buf;
 395                                 snprintf( full, 1023, filename, i ++ );
 396                                 if ( stat( full, &buf ) == 0 )
 397                                 {
 398                                         sprintf( key, "%d", keyvalue ++ );
 399                                         mlt_properties_set( this->filenames, "0", full );
 400                                         gap = 0;
 401                                 }
 402                                 else
 403                                 {
 404                                         gap ++;
 405                                 }
 406                         }
 407                 }
 408                 else if ( strstr( filename, "/.all." ) != NULL )
 409                 {
 410                         char wildcard[ 1024 ];
 411                         char *dir_name = strdup( filename );
 412                         char *extension = strrchr( dir_name, '.' );
 413
 414                         *( strstr( dir_name, "/.all." ) + 1 ) = '\0';
 415                         sprintf( wildcard, "*%s", extension );
 416
 417                         mlt_properties_dir_list( this->filenames, dir_name, wildcard, 1 );
 418
 419                         free( dir_name );
 420                 }
 421                 else
 422                 {
 423                         mlt_properties_set( this->filenames, "0", filename );
 424                 }
 425
 426                 this->count = mlt_properties_count( this->filenames );
 427         }
 428
 429         // Generate a frame
 430         *frame = mlt_frame_init( );
 431
 432         if ( *frame != NULL && this->count > 0 )
 433         {
 434                 // Obtain properties of frame and producer
 435                 mlt_properties properties = MLT_FRAME_PROPERTIES( *frame );
 436
 437                 // Set the producer on the frame properties
 438                 mlt_properties_set_data( properties, "producer_pixbuf", this, 0, NULL, NULL );
 439
 440                 // Update timecode on the frame we're creating
 441                 mlt_frame_set_position( *frame, mlt_producer_position( producer ) );
 442
 443                 // Ensure that we have a way to obtain the position in the get_image
 444                 mlt_properties_set_position( properties, "pixbuf_position", mlt_producer_position( producer ) );
 445
 446                 // Refresh the image
 447                 refresh_image( *frame, 0, 0 );
 448
 449                 // Set producer-specific frame properties
 450                 mlt_properties_set_int( properties, "progressive", mlt_properties_get_int( producer_properties, "progressive" ) );
 451                 mlt_properties_set_double( properties, "aspect_ratio", mlt_properties_get_double( producer_properties, "aspect_ratio" ) );
 452
 453                 // Set alpha call back
 454                 ( *frame )->get_alpha_mask = producer_get_alpha_mask;
 455
 456                 // Push the get_image method
 457                 mlt_frame_push_get_image( *frame, producer_get_image );
 458         }
 459
 460         // Calculate the next timecode
 461         mlt_producer_prepare_next( producer );
 462
 463         return 0;
 464 }
 465
 466 static void producer_close( mlt_producer parent )
 467 {
 468         producer_pixbuf this = parent->child;
 469         if ( !mlt_properties_get_int( MLT_PRODUCER_PROPERTIES( parent ), "cache" ) )
 470         {
 471                 mlt_pool_release( this->image );
 472                 mlt_pool_release( this->alpha );
 473         }
 474         parent->close = NULL;
 475         mlt_producer_close( parent );
 476         mlt_properties_close( this->filenames );
 477         free( this );
 478 }