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 <framework/mlt_cache.h>
24 #include <framework/mlt_log.h>
25 #include <framework/mlt_tokeniser.h>
26 #include <gdk-pixbuf/gdk-pixbuf.h>
31 #include <libexif/exif-data.h>
39 #include <sys/types.h>
45 // this protects concurrent access to gdk_pixbuf
46 static pthread_mutex_t g_mutex = PTHREAD_MUTEX_INITIALIZER;
48 typedef struct producer_pixbuf_s *producer_pixbuf;
50 struct producer_pixbuf_s
52 struct mlt_producer_s parent;
55 mlt_properties filenames;
63 mlt_cache_item image_cache;
64 mlt_cache_item alpha_cache;
65 mlt_cache_item pixbuf_cache;
67 mlt_image_format format;
70 static void load_filenames( producer_pixbuf self, mlt_properties producer_properties );
71 static int refresh_pixbuf( producer_pixbuf self, mlt_frame frame );
72 static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int index );
73 static void producer_close( mlt_producer parent );
75 mlt_producer producer_pixbuf_init( char *filename )
77 producer_pixbuf self = calloc( 1, sizeof( struct producer_pixbuf_s ) );
78 if ( self != NULL && mlt_producer_init( &self->parent, self ) == 0 )
80 mlt_producer producer = &self->parent;
82 // Get the properties interface
83 mlt_properties properties = MLT_PRODUCER_PROPERTIES( &self->parent );
85 // Callback registration
86 producer->get_frame = producer_get_frame;
87 producer->close = ( mlt_destructor )producer_close;
89 // Set the default properties
90 mlt_properties_set( properties, "resource", filename );
91 mlt_properties_set_int( properties, "ttl", 25 );
92 mlt_properties_set_int( properties, "aspect_ratio", 1 );
93 mlt_properties_set_int( properties, "progressive", 1 );
94 mlt_properties_set_int( properties, "seekable", 1 );
95 mlt_properties_set_int( properties, "loop", 1 );
97 // Validate the resource
99 load_filenames( self, properties );
102 mlt_frame frame = mlt_frame_init( MLT_PRODUCER_SERVICE( producer ) );
105 mlt_properties frame_properties = MLT_FRAME_PROPERTIES( frame );
106 mlt_properties_set_data( frame_properties, "producer_pixbuf", self, 0, NULL, NULL );
107 mlt_frame_set_position( frame, mlt_producer_position( producer ) );
108 refresh_pixbuf( self, frame );
109 mlt_cache_item_close( self->pixbuf_cache );
110 mlt_frame_close( frame );
113 if ( self->width == 0 )
115 producer_close( producer );
124 static int load_svg( producer_pixbuf self, mlt_properties properties, const char *filename )
129 if ( strstr( filename, "<svg" ) )
131 // Generate a temporary file for the svg
132 char fullname[ 1024 ] = "/tmp/mlt.XXXXXX";
133 int fd = g_mkstemp( fullname );
137 // Write the svg into the temp file
138 ssize_t remaining_bytes;
139 const char *xml = filename;
141 // Strip leading crap
142 while ( xml[0] != '<' )
145 remaining_bytes = strlen( xml );
146 while ( remaining_bytes > 0 )
147 remaining_bytes -= write( fd, xml + strlen( xml ) - remaining_bytes, remaining_bytes );
150 mlt_properties_set( self->filenames, "0", fullname );
152 // Teehe - when the producer closes, delete the temp file and the space allo
153 mlt_properties_set_data( properties, "__temporary_file__", fullname, 0, ( mlt_destructor )unlink, NULL );
160 static int load_sequence_sprintf( producer_pixbuf self, mlt_properties properties, const char *filename )
164 // Obtain filenames with pattern
165 if ( strchr( filename, '%' ) != NULL )
167 // handle picture sequences
168 int i = mlt_properties_get_int( properties, "begin" );
177 snprintf( full, 1023, filename, i ++ );
178 if ( stat( full, &buf ) == 0 )
180 sprintf( key, "%d", keyvalue ++ );
181 mlt_properties_set( self->filenames, key, full );
189 if ( mlt_properties_count( self->filenames ) > 0 )
191 mlt_properties_set_int( properties, "ttl", 1 );
198 static int load_sequence_deprecated( producer_pixbuf self, mlt_properties properties, const char *filename )
203 // This approach is deprecated in favor of the begin querystring parameter.
204 // Obtain filenames with pattern containing a begin value, e.g. foo%1234d.png
205 if ( ( start = strchr( filename, '%' ) ) )
207 const char *end = ++start;
208 while ( isdigit( *end ) ) end++;
209 if ( end > start && ( end[0] == 'd' || end[0] == 'i' || end[0] == 'u' ) )
212 char *s = calloc( 1, n + 1 );
213 strncpy( s, start, n );
214 mlt_properties_set( properties, "begin", s );
216 s = calloc( 1, strlen( filename ) + 2 );
217 strncpy( s, filename, start - filename );
218 sprintf( s + ( start - filename ), ".%d%s", n, end );
219 result = load_sequence_sprintf( self, properties, s );
226 static int load_sequence_querystring( producer_pixbuf self, mlt_properties properties, const char *filename )
230 // Obtain filenames with pattern and begin value in query string
231 if ( strchr( filename, '%' ) && strchr( filename, '?' ) )
233 // Split filename into pattern and query string
234 char *s = strdup( filename );
235 char *querystring = strrchr( s, '?' );
236 *querystring++ = '\0';
237 if ( strstr( filename, "begin=" ) )
238 mlt_properties_set( properties, "begin", strstr( querystring, "begin=" ) + 6 );
239 else if ( strstr( filename, "begin:" ) )
240 mlt_properties_set( properties, "begin", strstr( querystring, "begin:" ) + 6 );
241 // Coerce to an int value so serialization does not have any extra query string cruft
242 mlt_properties_set_int( properties, "begin", mlt_properties_get_int( properties, "begin" ) );
243 result = load_sequence_sprintf( self, properties, s );
249 static int load_folder( producer_pixbuf self, mlt_properties properties, const char *filename )
253 // Obtain filenames with folder
254 if ( strstr( filename, "/.all." ) != NULL )
256 char wildcard[ 1024 ];
257 char *dir_name = strdup( filename );
258 char *extension = strrchr( dir_name, '.' );
260 *( strstr( dir_name, "/.all." ) + 1 ) = '\0';
261 sprintf( wildcard, "*%s", extension );
263 mlt_properties_dir_list( self->filenames, dir_name, wildcard, 1 );
271 static void load_filenames( producer_pixbuf self, mlt_properties properties )
273 char *filename = mlt_properties_get( properties, "resource" );
274 self->filenames = mlt_properties_new( );
276 if (!load_svg( self, properties, filename ) &&
277 !load_sequence_querystring( self, properties, filename ) &&
278 !load_sequence_sprintf( self, properties, filename ) &&
279 !load_sequence_deprecated( self, properties, filename ) &&
280 !load_folder( self, properties, filename ) )
282 mlt_properties_set( self->filenames, "0", filename );
284 self->count = mlt_properties_count( self->filenames );
287 static GdkPixbuf* reorient_with_exif( producer_pixbuf self, int image_idx, GdkPixbuf *pixbuf )
290 mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( &self->parent );
291 ExifData *d = exif_data_new_from_file( mlt_properties_get_value( self->filenames, image_idx ) );
293 int exif_orientation = 0;
295 /* get orientation and rotate image accordingly if necessary */
298 if ( ( entry = exif_content_get_entry ( d->ifd[EXIF_IFD_0], EXIF_TAG_ORIENTATION ) ) )
299 exif_orientation = exif_get_short (entry->data, exif_data_get_byte_order (d));
301 /* Free the EXIF data */
305 // Remember EXIF value, might be useful for someone
306 mlt_properties_set_int( producer_props, "_exif_orientation" , exif_orientation );
308 if ( exif_orientation > 1 )
310 GdkPixbuf *processed = NULL;
311 GdkPixbufRotation matrix = GDK_PIXBUF_ROTATE_NONE;
313 // Rotate image according to exif data
314 switch ( exif_orientation ) {
316 processed = gdk_pixbuf_flip ( pixbuf, TRUE );
319 matrix = GDK_PIXBUF_ROTATE_UPSIDEDOWN;
323 processed = gdk_pixbuf_flip ( pixbuf, FALSE );
326 matrix = GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE;
327 processed = gdk_pixbuf_flip ( pixbuf, TRUE );
330 matrix = GDK_PIXBUF_ROTATE_CLOCKWISE;
334 matrix = GDK_PIXBUF_ROTATE_CLOCKWISE;
335 processed = gdk_pixbuf_flip ( pixbuf, TRUE );
338 matrix = GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE;
344 pixbuf = gdk_pixbuf_rotate_simple( processed, matrix );
345 g_object_unref( processed );
352 static int refresh_pixbuf( producer_pixbuf self, mlt_frame frame )
354 // Obtain properties of frame and producer
355 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
356 mlt_producer producer = &self->parent;
357 mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( producer );
359 // Check if user wants us to reload the image
360 if ( mlt_properties_get_int( producer_props, "force_reload" ) )
364 mlt_properties_set_int( producer_props, "force_reload", 0 );
367 // Get the time to live for each frame
368 double ttl = mlt_properties_get_int( producer_props, "ttl" );
370 // Get the original position of this frame
371 mlt_position position = mlt_frame_original_position( frame );
372 position += mlt_producer_get_in( producer );
375 int loop = mlt_properties_get_int( producer_props, "loop" );
378 current_idx = ( int )floor( ( double )position / ttl ) % self->count;
380 current_idx = MIN(( double )position / ttl, self->count - 1);
384 char image_key[ 10 ];
385 sprintf( image_key, "%d", current_idx );
387 int disable_exif = mlt_properties_get_int( producer_props, "disable_exif" );
389 if ( current_idx != self->pixbuf_idx )
391 if ( !self->pixbuf || mlt_properties_get_int( producer_props, "_disable_exif" ) != disable_exif )
393 GError *error = NULL;
396 pthread_mutex_lock( &g_mutex );
397 self->pixbuf = gdk_pixbuf_new_from_file( mlt_properties_get_value( self->filenames, current_idx ), &error );
400 // Read the exif value for this file
402 self->pixbuf = reorient_with_exif( self, current_idx, self->pixbuf );
404 // Register this pixbuf for destruction and reuse
405 mlt_cache_item_close( self->pixbuf_cache );
406 mlt_service_cache_put( MLT_PRODUCER_SERVICE( producer ), "pixbuf.pixbuf", self->pixbuf, 0, ( mlt_destructor )g_object_unref );
407 self->pixbuf_cache = mlt_service_cache_get( MLT_PRODUCER_SERVICE( producer ), "pixbuf.pixbuf" );
408 self->pixbuf_idx = current_idx;
410 // Store the width/height of the pixbuf temporarily
411 self->width = gdk_pixbuf_get_width( self->pixbuf );
412 self->height = gdk_pixbuf_get_height( self->pixbuf );
414 mlt_events_block( producer_props, NULL );
415 mlt_properties_set_int( producer_props, "meta.media.width", self->width );
416 mlt_properties_set_int( producer_props, "meta.media.height", self->height );
417 mlt_properties_set_int( producer_props, "_disable_exif", disable_exif );
418 mlt_events_unblock( producer_props, NULL );
421 pthread_mutex_unlock( &g_mutex );
424 // Set width/height of frame
425 mlt_properties_set_int( properties, "width", self->width );
426 mlt_properties_set_int( properties, "height", self->height );
431 static void refresh_image( producer_pixbuf self, mlt_frame frame, mlt_image_format format, int width, int height )
433 // Obtain properties of frame and producer
434 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
435 mlt_producer producer = &self->parent;
437 // Get index and pixbuf
438 int current_idx = refresh_pixbuf( self, frame );
440 // optimization for subsequent iterations on single picture
441 if ( current_idx != self->image_idx || width != self->width || height != self->height )
443 mlt_log_debug( MLT_PRODUCER_SERVICE( producer ), "image %p pixbuf %p idx %d current_idx %d pixbuf_idx %d width %d\n",
444 self->image, self->pixbuf, current_idx, self->image_idx, self->pixbuf_idx, width );
446 // If we have a pixbuf and we need an image
447 if ( self->pixbuf && ( !self->image || ( format != mlt_image_none && format != self->format ) ) )
449 char *interps = mlt_properties_get( properties, "rescale.interp" );
450 int interp = GDK_INTERP_BILINEAR;
453 // Keep bilinear by default
455 else if ( strcmp( interps, "nearest" ) == 0 )
456 interp = GDK_INTERP_NEAREST;
457 else if ( strcmp( interps, "tiles" ) == 0 )
458 interp = GDK_INTERP_TILES;
459 else if ( strcmp( interps, "hyper" ) == 0 || strcmp( interps, "bicubic" ) == 0 )
460 interp = GDK_INTERP_HYPER;
462 // Note - the original pixbuf is already safe and ready for destruction
463 pthread_mutex_lock( &g_mutex );
464 GdkPixbuf* pixbuf = gdk_pixbuf_scale_simple( self->pixbuf, width, height, interp );
466 // Store width and height
468 self->height = height;
470 // Allocate/define image
471 int has_alpha = gdk_pixbuf_get_has_alpha( pixbuf );
472 int src_stride = gdk_pixbuf_get_rowstride( pixbuf );
473 int dst_stride = self->width * ( has_alpha ? 4 : 3 );
474 int image_size = dst_stride * ( height + 1 );
475 self->image = mlt_pool_alloc( image_size );
477 self->format = has_alpha ? mlt_image_rgb24a : mlt_image_rgb24;
479 if ( src_stride != dst_stride )
481 int y = self->height;
482 uint8_t *src = gdk_pixbuf_get_pixels( pixbuf );
483 uint8_t *dst = self->image;
486 memcpy( dst, src, dst_stride );
493 memcpy( self->image, gdk_pixbuf_get_pixels( pixbuf ), src_stride * height );
495 pthread_mutex_unlock( &g_mutex );
497 // Convert image to requested format
498 if ( format != mlt_image_none && format != self->format )
500 uint8_t *buffer = NULL;
502 // First, set the image so it can be converted when we get it
503 mlt_frame_replace_image( frame, self->image, self->format, width, height );
504 mlt_frame_set_image( frame, self->image, image_size, mlt_pool_release );
505 self->format = format;
507 // get_image will do the format conversion
508 mlt_frame_get_image( frame, &buffer, &format, &width, &height, 0 );
510 // cache copies of the image and alpha buffers
513 image_size = mlt_image_format_size( format, width, height, NULL );
514 self->image = mlt_pool_alloc( image_size );
515 memcpy( self->image, buffer, image_size );
517 if ( ( buffer = mlt_frame_get_alpha_mask( frame ) ) )
519 self->alpha = mlt_pool_alloc( width * height );
520 memcpy( self->alpha, buffer, width * height );
525 mlt_cache_item_close( self->image_cache );
526 mlt_service_cache_put( MLT_PRODUCER_SERVICE( producer ), "pixbuf.image", self->image, image_size, mlt_pool_release );
527 self->image_cache = mlt_service_cache_get( MLT_PRODUCER_SERVICE( producer ), "pixbuf.image" );
528 self->image_idx = current_idx;
529 mlt_cache_item_close( self->alpha_cache );
530 self->alpha_cache = NULL;
533 mlt_service_cache_put( MLT_PRODUCER_SERVICE( producer ), "pixbuf.alpha", self->alpha, width * height, mlt_pool_release );
534 self->alpha_cache = mlt_service_cache_get( MLT_PRODUCER_SERVICE( producer ), "pixbuf.alpha" );
537 // Finished with pixbuf now
538 g_object_unref( pixbuf );
541 // Set width/height of frame
542 mlt_properties_set_int( properties, "width", self->width );
543 mlt_properties_set_int( properties, "height", self->height );
546 static int producer_get_image( mlt_frame frame, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable )
550 // Obtain properties of frame and producer
551 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
552 producer_pixbuf self = mlt_properties_get_data( properties, "producer_pixbuf", NULL );
553 mlt_producer producer = &self->parent;
555 // Use the width and height suggested by the rescale filter because we can do our own scaling.
556 *width = mlt_properties_get_int( properties, "rescale_width" );
557 *height = mlt_properties_get_int( properties, "rescale_height" );
559 // Restore pixbuf and image
560 mlt_service_lock( MLT_PRODUCER_SERVICE( producer ) );
561 self->pixbuf_cache = mlt_service_cache_get( MLT_PRODUCER_SERVICE( producer ), "pixbuf.pixbuf" );
562 self->pixbuf = mlt_cache_item_data( self->pixbuf_cache, NULL );
563 self->image_cache = mlt_service_cache_get( MLT_PRODUCER_SERVICE( producer ), "pixbuf.image" );
564 self->image = mlt_cache_item_data( self->image_cache, NULL );
565 self->alpha_cache = mlt_service_cache_get( MLT_PRODUCER_SERVICE( producer ), "pixbuf.alpha" );
566 self->alpha = mlt_cache_item_data( self->alpha_cache, NULL );
569 refresh_image( self, frame, *format, *width, *height );
571 // Get width and height (may have changed during the refresh)
572 *width = self->width;
573 *height = self->height;
574 *format = self->format;
576 // NB: Cloning is necessary with this producer (due to processing of images ahead of use)
577 // The fault is not in the design of mlt, but in the implementation of the pixbuf producer...
581 int image_size = mlt_image_format_size( self->format, self->width, self->height, NULL );
582 uint8_t *image_copy = mlt_pool_alloc( image_size );
583 memcpy( image_copy, self->image, image_size );
584 // Now update properties so we free the copy after
585 mlt_frame_set_image( frame, image_copy, image_size, mlt_pool_release );
586 // We're going to pass the copy on
587 *buffer = image_copy;
588 mlt_log_debug( MLT_PRODUCER_SERVICE( &self->parent ), "%dx%d (%s)\n",
589 self->width, self->height, mlt_image_format_name( *format ) );
590 // Clone the alpha channel
593 image_copy = mlt_pool_alloc( self->width * self->height );
594 memcpy( image_copy, self->alpha, self->width * self->height );
595 mlt_frame_set_alpha( frame, image_copy, self->width * self->height, mlt_pool_release );
603 // Release references and locks
604 mlt_cache_item_close( self->pixbuf_cache );
605 mlt_cache_item_close( self->image_cache );
606 mlt_cache_item_close( self->alpha_cache );
607 mlt_service_unlock( MLT_PRODUCER_SERVICE( &self->parent ) );
612 static int producer_get_frame( mlt_producer producer, mlt_frame_ptr frame, int index )
614 // Get the real structure for this producer
615 producer_pixbuf self = producer->child;
617 // Fetch the producers properties
618 mlt_properties producer_properties = MLT_PRODUCER_PROPERTIES( producer );
620 if ( self->filenames == NULL && mlt_properties_get( producer_properties, "resource" ) != NULL )
621 load_filenames( self, producer_properties );
624 *frame = mlt_frame_init( MLT_PRODUCER_SERVICE( producer ) );
626 if ( *frame != NULL && self->count > 0 )
628 // Obtain properties of frame and producer
629 mlt_properties properties = MLT_FRAME_PROPERTIES( *frame );
631 // Set the producer on the frame properties
632 mlt_properties_set_data( properties, "producer_pixbuf", self, 0, NULL, NULL );
634 // Update timecode on the frame we're creating
635 mlt_frame_set_position( *frame, mlt_producer_position( producer ) );
637 // Refresh the pixbuf
638 self->pixbuf_cache = mlt_service_cache_get( MLT_PRODUCER_SERVICE( producer ), "pixbuf.pixbuf" );
639 self->pixbuf = mlt_cache_item_data( self->pixbuf_cache, NULL );
640 refresh_pixbuf( self, *frame );
641 mlt_cache_item_close( self->pixbuf_cache );
643 // Set producer-specific frame properties
644 mlt_properties_set_int( properties, "progressive", mlt_properties_get_int( producer_properties, "progressive" ) );
646 double force_ratio = mlt_properties_get_double( producer_properties, "force_aspect_ratio" );
647 if ( force_ratio > 0.0 )
648 mlt_properties_set_double( properties, "aspect_ratio", force_ratio );
650 mlt_properties_set_double( properties, "aspect_ratio", mlt_properties_get_double( producer_properties, "aspect_ratio" ) );
652 // Push the get_image method
653 mlt_frame_push_get_image( *frame, producer_get_image );
656 // Calculate the next timecode
657 mlt_producer_prepare_next( producer );
662 static void producer_close( mlt_producer parent )
664 producer_pixbuf self = parent->child;
665 parent->close = NULL;
666 mlt_service_cache_purge( MLT_PRODUCER_SERVICE(parent) );
667 mlt_producer_close( parent );
668 mlt_properties_close( self->filenames );