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>
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_producer.h>
22 #include <framework/mlt_frame.h>
23 #include <gdk-pixbuf/gdk-pixbuf.h>
30 #include <sys/types.h>
35 static pthread_mutex_t fastmutex
= PTHREAD_MUTEX_INITIALIZER
;
37 typedef struct producer_pixbuf_s
*producer_pixbuf
;
39 struct producer_pixbuf_s
41 struct mlt_producer_s parent
;
44 mlt_properties filenames
;
54 static int producer_get_frame( mlt_producer parent
, mlt_frame_ptr frame
, int index
);
55 static void producer_close( mlt_producer parent
);
57 mlt_producer
producer_pixbuf_init( char *filename
)
59 producer_pixbuf
this = calloc( sizeof( struct producer_pixbuf_s
), 1 );
60 if ( this != NULL
&& mlt_producer_init( &this->parent
, this ) == 0 )
62 mlt_producer producer
= &this->parent
;
64 // Get the properties interface
65 mlt_properties properties
= MLT_PRODUCER_PROPERTIES( &this->parent
);
67 // Callback registration
68 producer
->get_frame
= producer_get_frame
;
69 producer
->close
= ( mlt_destructor
)producer_close
;
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 );
83 static void refresh_image( mlt_frame frame
, int width
, int height
)
86 GdkPixbuf
*pixbuf
= mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame
), "pixbuf", NULL
);
89 // Obtain properties of frame
90 mlt_properties properties
= MLT_FRAME_PROPERTIES( frame
);
92 // Obtain the producer for this frame
93 producer_pixbuf
this = mlt_properties_get_data( properties
, "producer_pixbuf", NULL
);
95 // Obtain the producer
96 mlt_producer producer
= &this->parent
;
98 // Obtain properties of producer
99 mlt_properties producer_props
= MLT_PRODUCER_PROPERTIES( producer
);
101 // Check if user wants us to reload the image
102 if ( mlt_properties_get_int( producer_props
, "force_reload" ) )
106 mlt_properties_set_int( producer_props
, "force_reload", 0 );
109 // Obtain the cache flag and structure
110 int use_cache
= mlt_properties_get_int( producer_props
, "cache" );
111 mlt_properties cache
= mlt_properties_get_data( producer_props
, "_cache", NULL
);
112 int update_cache
= 0;
114 // Get the time to live for each frame
115 double ttl
= mlt_properties_get_int( producer_props
, "ttl" );
117 // Get the original position of this frame
118 mlt_position position
= mlt_properties_get_position( properties
, "pixbuf_position" );
119 position
+= mlt_producer_get_in( producer
);
122 int image_idx
= ( int )floor( ( double )position
/ ttl
) % this->count
;
125 char image_key
[ 10 ];
126 sprintf( image_key
, "%d", image_idx
);
128 pthread_mutex_lock( &fastmutex
);
130 // Check if the frame is already loaded
135 cache
= mlt_properties_new( );
136 mlt_properties_set_data( producer_props
, "_cache", cache
, 0, ( mlt_destructor
)mlt_properties_close
, NULL
);
139 mlt_frame cached
= mlt_properties_get_data( cache
, image_key
, NULL
);
143 this->image_idx
= image_idx
;
144 mlt_properties cached_props
= MLT_FRAME_PROPERTIES( cached
);
145 this->width
= mlt_properties_get_int( cached_props
, "width" );
146 this->height
= mlt_properties_get_int( cached_props
, "height" );
147 mlt_properties_set_int( producer_props
, "_real_width", mlt_properties_get_int( cached_props
, "real_width" ) );
148 mlt_properties_set_int( producer_props
, "_real_height", mlt_properties_get_int( cached_props
, "real_height" ) );
149 this->image
= mlt_properties_get_data( cached_props
, "image", NULL
);
150 this->alpha
= mlt_properties_get_data( cached_props
, "alpha", NULL
);
152 if ( width
!= 0 && ( width
!= this->width
|| height
!= this->height
) )
157 // optimization for subsequent iterations on single picture
158 if ( width
!= 0 && this->image
!= NULL
&& image_idx
== this->image_idx
)
160 if ( width
!= this->width
|| height
!= this->height
)
162 pixbuf
= mlt_properties_get_data( producer_props
, "_pixbuf", NULL
);
165 mlt_pool_release( this->image
);
166 mlt_pool_release( this->alpha
);
172 else if ( pixbuf
== NULL
&& ( this->image
== NULL
|| image_idx
!= this->image_idx
) )
176 mlt_pool_release( this->image
);
177 mlt_pool_release( this->alpha
);
182 this->image_idx
= image_idx
;
183 pixbuf
= gdk_pixbuf_new_from_file( mlt_properties_get_value( this->filenames
, image_idx
), &error
);
185 if ( pixbuf
!= NULL
)
187 // Register this pixbuf for destruction and reuse
188 mlt_events_block( producer_props
, NULL
);
189 mlt_properties_set_data( producer_props
, "_pixbuf", pixbuf
, 0, ( mlt_destructor
)g_object_unref
, NULL
);
190 g_object_ref( pixbuf
);
191 mlt_properties_set_data( MLT_FRAME_PROPERTIES( frame
), "pixbuf", pixbuf
, 0, ( mlt_destructor
)g_object_unref
, NULL
);
193 mlt_properties_set_int( producer_props
, "_real_width", gdk_pixbuf_get_width( pixbuf
) );
194 mlt_properties_set_int( producer_props
, "_real_height", gdk_pixbuf_get_height( pixbuf
) );
195 mlt_events_unblock( producer_props
, NULL
);
197 // Store the width/height of the pixbuf temporarily
198 this->width
= gdk_pixbuf_get_width( pixbuf
);
199 this->height
= gdk_pixbuf_get_height( pixbuf
);
203 // If we have a pixbuf
204 if ( pixbuf
&& width
> 0 )
206 char *interps
= mlt_properties_get( properties
, "rescale.interp" );
207 int interp
= GDK_INTERP_BILINEAR
;
209 if ( strcmp( interps
, "nearest" ) == 0 )
210 interp
= GDK_INTERP_NEAREST
;
211 else if ( strcmp( interps
, "tiles" ) == 0 )
212 interp
= GDK_INTERP_TILES
;
213 else if ( strcmp( interps
, "hyper" ) == 0 )
214 interp
= GDK_INTERP_HYPER
;
216 // Note - the original pixbuf is already safe and ready for destruction
217 pixbuf
= gdk_pixbuf_scale_simple( pixbuf
, width
, height
, interp
);
219 // Store width and height
221 this->height
= height
;
223 // Allocate/define image
224 this->image
= mlt_pool_alloc( width
* ( height
+ 1 ) * 2 );
226 // Extract YUV422 and alpha
227 if ( gdk_pixbuf_get_has_alpha( pixbuf
) )
229 // Allocate the alpha mask
230 this->alpha
= mlt_pool_alloc( this->width
* this->height
);
233 mlt_convert_rgb24a_to_yuv422( gdk_pixbuf_get_pixels( pixbuf
),
234 this->width
, this->height
,
235 gdk_pixbuf_get_rowstride( pixbuf
),
236 this->image
, this->alpha
);
240 // No alpha to extract
241 mlt_convert_rgb24_to_yuv422( gdk_pixbuf_get_pixels( pixbuf
),
242 this->width
, this->height
,
243 gdk_pixbuf_get_rowstride( pixbuf
),
247 // Finished with pixbuf now
248 g_object_unref( pixbuf
);
250 // Ensure we update the cache when we need to
251 update_cache
= use_cache
;
254 // Set width/height of frame
255 mlt_properties_set_int( properties
, "width", this->width
);
256 mlt_properties_set_int( properties
, "height", this->height
);
257 mlt_properties_set_int( properties
, "real_width", mlt_properties_get_int( producer_props
, "_real_width" ) );
258 mlt_properties_set_int( properties
, "real_height", mlt_properties_get_int( producer_props
, "_real_height" ) );
260 // pass the image data without destructor
261 mlt_properties_set_data( properties
, "image", this->image
, this->width
* ( this->height
+ 1 ) * 2, NULL
, NULL
);
262 mlt_properties_set_data( properties
, "alpha", this->alpha
, this->width
* this->height
, NULL
, NULL
);
266 mlt_frame cached
= mlt_frame_init( MLT_PRODUCER_SERVICE( producer
) );
267 mlt_properties cached_props
= MLT_FRAME_PROPERTIES( cached
);
268 mlt_properties_set_int( cached_props
, "width", this->width
);
269 mlt_properties_set_int( cached_props
, "height", this->height
);
270 mlt_properties_set_int( cached_props
, "real_width", mlt_properties_get_int( producer_props
, "_real_width" ) );
271 mlt_properties_set_int( cached_props
, "real_height", mlt_properties_get_int( producer_props
, "_real_height" ) );
272 mlt_properties_set_data( cached_props
, "image", this->image
, this->width
* ( this->height
+ 1 ) * 2, mlt_pool_release
, NULL
);
273 mlt_properties_set_data( cached_props
, "alpha", this->alpha
, this->width
* this->height
, mlt_pool_release
, NULL
);
274 mlt_properties_set_data( cache
, image_key
, cached
, 0, ( mlt_destructor
)mlt_frame_close
, NULL
);
277 pthread_mutex_unlock( &fastmutex
);
280 static int producer_get_image( mlt_frame frame
, uint8_t **buffer
, mlt_image_format
*format
, int *width
, int *height
, int writable
)
282 // Obtain properties of frame
283 mlt_properties properties
= MLT_FRAME_PROPERTIES( frame
);
285 // We need to know the size of the image to clone it
290 uint8_t *alpha
= NULL
;
292 *width
= mlt_properties_get_int( properties
, "rescale_width" );
293 *height
= mlt_properties_get_int( properties
, "rescale_height" );
296 refresh_image( frame
, *width
, *height
);
299 *buffer
= mlt_properties_get_data( properties
, "image", &image_size
);
300 alpha
= mlt_properties_get_data( properties
, "alpha", &alpha_size
);
302 // Get width and height (may have changed during the refresh)
303 *width
= mlt_properties_get_int( properties
, "width" );
304 *height
= mlt_properties_get_int( properties
, "height" );
306 // NB: Cloning is necessary with this producer (due to processing of images ahead of use)
307 // The fault is not in the design of mlt, but in the implementation of the pixbuf producer...
308 if ( *buffer
!= NULL
)
310 if ( *format
== mlt_image_yuv422
|| *format
== mlt_image_yuv420p
)
312 // Clone the image and the alpha
313 uint8_t *image_copy
= mlt_pool_alloc( image_size
);
314 uint8_t *alpha_copy
= mlt_pool_alloc( alpha_size
);
316 memcpy( image_copy
, *buffer
, image_size
);
318 // Copy or default the alpha
320 memcpy( alpha_copy
, alpha
, alpha_size
);
322 memset( alpha_copy
, 255, alpha_size
);
324 // Now update properties so we free the copy after
325 mlt_properties_set_data( properties
, "image", image_copy
, image_size
, mlt_pool_release
, NULL
);
326 mlt_properties_set_data( properties
, "alpha", alpha_copy
, alpha_size
, mlt_pool_release
, NULL
);
328 // We're going to pass the copy on
329 *buffer
= image_copy
;
331 else if ( *format
== mlt_image_rgb24a
)
333 // Clone the image and the alpha
334 image_size
= *width
* ( *height
+ 1 ) * 4;
335 alpha_size
= *width
* ( *height
+ 1 );
336 uint8_t *image_copy
= mlt_pool_alloc( image_size
);
337 uint8_t *alpha_copy
= mlt_pool_alloc( alpha_size
);
339 mlt_convert_yuv422_to_rgb24a(*buffer
, image_copy
, (*width
)*(*height
));
341 // Now update properties so we free the copy after
342 mlt_properties_set_data( properties
, "image", image_copy
, image_size
, mlt_pool_release
, NULL
);
343 mlt_properties_set_data( properties
, "alpha", alpha_copy
, alpha_size
, mlt_pool_release
, NULL
);
345 // We're going to pass the copy on
346 *buffer
= image_copy
;
352 // TODO: Review all cases of invalid images
353 *buffer
= mlt_pool_alloc( 50 * 50 * 2 );
354 mlt_properties_set_data( properties
, "image", *buffer
, image_size
, mlt_pool_release
, NULL
);
362 static uint8_t *producer_get_alpha_mask( mlt_frame
this )
364 // Obtain properties of frame
365 mlt_properties properties
= MLT_FRAME_PROPERTIES( this );
367 // Return the alpha mask
368 return mlt_properties_get_data( properties
, "alpha", NULL
);
371 static int producer_get_frame( mlt_producer producer
, mlt_frame_ptr frame
, int index
)
373 // Get the real structure for this producer
374 producer_pixbuf
this = producer
->child
;
376 // Fetch the producers properties
377 mlt_properties producer_properties
= MLT_PRODUCER_PROPERTIES( producer
);
379 if ( this->filenames
== NULL
&& mlt_properties_get( producer_properties
, "resource" ) != NULL
)
381 char *filename
= mlt_properties_get( producer_properties
, "resource" );
382 this->filenames
= mlt_properties_new( );
385 if ( strstr( filename
, "<svg" ) )
387 // Generate a temporary file for the svg
388 char fullname
[ 1024 ] = "/tmp/mlt.XXXXXX";
389 int fd
= mkstemp( fullname
);
393 // Write the svg into the temp file
394 ssize_t remaining_bytes
;
395 char *xml
= filename
;
397 // Strip leading crap
398 while ( xml
[0] != '<' )
401 remaining_bytes
= strlen( xml
);
402 while ( remaining_bytes
> 0 )
403 remaining_bytes
-= write( fd
, xml
+ strlen( xml
) - remaining_bytes
, remaining_bytes
);
406 mlt_properties_set( this->filenames
, "0", fullname
);
408 // Teehe - when the producer closes, delete the temp file and the space allo
409 mlt_properties_set_data( producer_properties
, "__temporary_file__", fullname
, 0, ( mlt_destructor
)unlink
, NULL
);
413 else if ( strchr( filename
, '%' ) != NULL
)
415 // handle picture sequences
416 int i
= mlt_properties_get_int( producer_properties
, "begin" );
425 snprintf( full
, 1023, filename
, i
++ );
426 if ( stat( full
, &buf
) == 0 )
428 sprintf( key
, "%d", keyvalue
++ );
429 mlt_properties_set( this->filenames
, key
, full
);
438 else if ( strstr( filename
, "/.all." ) != NULL
)
440 char wildcard
[ 1024 ];
441 char *dir_name
= strdup( filename
);
442 char *extension
= strrchr( dir_name
, '.' );
444 *( strstr( dir_name
, "/.all." ) + 1 ) = '\0';
445 sprintf( wildcard
, "*%s", extension
);
447 mlt_properties_dir_list( this->filenames
, dir_name
, wildcard
, 1 );
453 mlt_properties_set( this->filenames
, "0", filename
);
456 this->count
= mlt_properties_count( this->filenames
);
460 *frame
= mlt_frame_init( MLT_PRODUCER_SERVICE( producer
) );
462 if ( *frame
!= NULL
&& this->count
> 0 )
464 // Obtain properties of frame and producer
465 mlt_properties properties
= MLT_FRAME_PROPERTIES( *frame
);
467 // Set the producer on the frame properties
468 mlt_properties_set_data( properties
, "producer_pixbuf", this, 0, NULL
, NULL
);
470 // Update timecode on the frame we're creating
471 mlt_frame_set_position( *frame
, mlt_producer_position( producer
) );
473 // Ensure that we have a way to obtain the position in the get_image
474 mlt_properties_set_position( properties
, "pixbuf_position", mlt_producer_position( producer
) );
477 refresh_image( *frame
, 0, 0 );
479 // Set producer-specific frame properties
480 mlt_properties_set_int( properties
, "progressive", mlt_properties_get_int( producer_properties
, "progressive" ) );
481 mlt_properties_set_double( properties
, "aspect_ratio", mlt_properties_get_double( producer_properties
, "aspect_ratio" ) );
483 // Set alpha call back
484 ( *frame
)->get_alpha_mask
= producer_get_alpha_mask
;
486 // Push the get_image method
487 mlt_frame_push_get_image( *frame
, producer_get_image
);
490 // Calculate the next timecode
491 mlt_producer_prepare_next( producer
);
496 static void producer_close( mlt_producer parent
)
498 producer_pixbuf
this = parent
->child
;
499 if ( !mlt_properties_get_int( MLT_PRODUCER_PROPERTIES( parent
), "cache" ) )
501 mlt_pool_release( this->image
);
502 mlt_pool_release( this->alpha
);
504 parent
->close
= NULL
;
505 mlt_producer_close( parent
);
506 mlt_properties_close( this->filenames
);