producer_pixbuf.c: bugfix (kdenlive-575) memory leak; revert unnecessary part of...
[melted] / src / modules / gtk2 / producer_pixbuf.c
index e2f4d25..9e0d4cf 100644 (file)
@@ -3,22 +3,22 @@
  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
  * Author: Dan Dennedy <dan@dennedy.org>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This program is distributed in the hope that it will be useful,
+ * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
-#include "producer_pixbuf.h"
+#include <framework/mlt_producer.h>
 #include <framework/mlt_frame.h>
 #include <gdk-pixbuf/gdk-pixbuf.h>
 
@@ -32,7 +32,7 @@
 #include <unistd.h>
 #include <dirent.h>
 
-pthread_mutex_t fastmutex = PTHREAD_MUTEX_INITIALIZER;
+static pthread_mutex_t fastmutex = PTHREAD_MUTEX_INITIALIZER;
 
 typedef struct producer_pixbuf_s *producer_pixbuf;
 
@@ -41,7 +41,7 @@ struct producer_pixbuf_s
        struct mlt_producer_s parent;
 
        // File name list
-       char **filenames;
+       mlt_properties filenames;
        int count;
        int image_idx;
 
@@ -51,17 +51,11 @@ struct producer_pixbuf_s
        uint8_t *alpha;
 };
 
+static void load_filenames( producer_pixbuf this, mlt_properties producer_properties );
+static void refresh_image( mlt_frame frame, int width, int height );
 static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int index );
 static void producer_close( mlt_producer parent );
 
-static int filter_files( const struct dirent *de )
-{
-       if ( de->d_name[ 0 ] != '.' )
-               return 1;
-       else
-               return 0;
-}
-
 mlt_producer producer_pixbuf_init( char *filename )
 {
        producer_pixbuf this = calloc( sizeof( struct producer_pixbuf_s ), 1 );
@@ -81,17 +75,118 @@ mlt_producer producer_pixbuf_init( char *filename )
                mlt_properties_set_int( properties, "ttl", 25 );
                mlt_properties_set_int( properties, "aspect_ratio", 1 );
                mlt_properties_set_int( properties, "progressive", 1 );
-               
+
+               // Validate the resource
+               if ( filename )
+                       load_filenames( this, properties );
+               if ( this->count )
+               {
+                       mlt_frame frame = mlt_frame_init( MLT_PRODUCER_SERVICE( producer ) );
+                       if ( frame )
+                       {
+                               mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
+                               mlt_properties_set_data( properties, "producer_pixbuf", this, 0, NULL, NULL );
+                               mlt_frame_set_position( frame, mlt_producer_position( producer ) );
+                               mlt_properties_set_position( properties, "pixbuf_position", mlt_producer_position( producer ) );
+                               refresh_image( frame, 0, 0 );
+                               mlt_frame_close( frame );
+                       }
+               }
+               if ( this->width == 0 )
+               {
+                       producer_close( producer );
+                       producer = NULL;
+               }
                return producer;
        }
        free( this );
        return NULL;
 }
 
+static void load_filenames( producer_pixbuf this, mlt_properties producer_properties )
+{
+       char *filename = mlt_properties_get( producer_properties, "resource" );
+       this->filenames = mlt_properties_new( );
+
+       // Read xml string
+       if ( strstr( filename, "<svg" ) )
+       {
+               // Generate a temporary file for the svg
+               char fullname[ 1024 ] = "/tmp/mlt.XXXXXX";
+               int fd = mkstemp( fullname );
+
+               if ( fd > -1 )
+               {
+                       // Write the svg into the temp file
+                       ssize_t remaining_bytes;
+                       char *xml = filename;
+                       
+                       // Strip leading crap
+                       while ( xml[0] != '<' )
+                               xml++;
+                       
+                       remaining_bytes = strlen( xml );
+                       while ( remaining_bytes > 0 )
+                               remaining_bytes -= write( fd, xml + strlen( xml ) - remaining_bytes, remaining_bytes );
+                       close( fd );
+
+                       mlt_properties_set( this->filenames, "0", fullname );
+
+                       // Teehe - when the producer closes, delete the temp file and the space allo
+                       mlt_properties_set_data( producer_properties, "__temporary_file__", fullname, 0, ( mlt_destructor )unlink, NULL );
+               }
+       }
+       // Obtain filenames
+       else if ( strchr( filename, '%' ) != NULL )
+       {
+               // handle picture sequences
+               int i = mlt_properties_get_int( producer_properties, "begin" );
+               int gap = 0;
+               char full[1024];
+               int keyvalue = 0;
+               char key[ 50 ];
+
+               while ( gap < 100 )
+               {
+                       struct stat buf;
+                       snprintf( full, 1023, filename, i ++ );
+                       if ( stat( full, &buf ) == 0 )
+                       {
+                               sprintf( key, "%d", keyvalue ++ );
+                               mlt_properties_set( this->filenames, key, full );
+                               gap = 0;
+                       }
+                       else
+                       {
+                               gap ++;
+                       }
+               }
+       }
+       else if ( strstr( filename, "/.all." ) != NULL )
+       {
+               char wildcard[ 1024 ];
+               char *dir_name = strdup( filename );
+               char *extension = strrchr( dir_name, '.' );
+
+               *( strstr( dir_name, "/.all." ) + 1 ) = '\0';
+               sprintf( wildcard, "*%s", extension );
+
+               mlt_properties_dir_list( this->filenames, dir_name, wildcard, 1 );
+
+               free( dir_name );
+       }
+       else
+       {
+               mlt_properties_set( this->filenames, "0", filename );
+       }
+
+       this->count = mlt_properties_count( this->filenames );
+}
+
 static void refresh_image( mlt_frame frame, int width, int height )
 {
        // Pixbuf 
-       GdkPixbuf *pixbuf = NULL;
+       GdkPixbuf *pixbuf = mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "pixbuf", NULL );
        GError *error = NULL;
 
        // Obtain properties of frame
@@ -106,46 +201,88 @@ static void refresh_image( mlt_frame frame, int width, int height )
        // Obtain properties of producer
        mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( producer );
 
+       // Obtain the cache flag and structure
+       int use_cache = mlt_properties_get_int( producer_props, "cache" );
+       mlt_properties cache = mlt_properties_get_data( producer_props, "_cache", NULL );
+       int update_cache = 0;
+
+       // Check if user wants us to reload the image
+       if ( mlt_properties_get_int( producer_props, "force_reload" ) ) 
+       {
+               pixbuf = NULL;
+               if ( !use_cache && this->image )
+                       mlt_pool_release( this->image );
+               this->image = NULL;
+               mlt_properties_set_int( producer_props, "force_reload", 0 );
+       }
+
        // Get the time to live for each frame
        double ttl = mlt_properties_get_int( producer_props, "ttl" );
 
        // Get the original position of this frame
        mlt_position position = mlt_properties_get_position( properties, "pixbuf_position" );
+       position += mlt_producer_get_in( producer );
 
        // Image index
        int image_idx = ( int )floor( ( double )position / ttl ) % this->count;
 
+       // Key for the cache
+       char image_key[ 10 ];
+       sprintf( image_key, "%d", image_idx );
+
        pthread_mutex_lock( &fastmutex );
 
+       // Check if the frame is already loaded
+       if ( use_cache )
+       {
+               if ( cache == NULL )
+               {
+                       cache = mlt_properties_new( );
+                       mlt_properties_set_data( producer_props, "_cache", cache, 0, ( mlt_destructor )mlt_properties_close, NULL );
+               }
+
+               mlt_frame cached = mlt_properties_get_data( cache, image_key, NULL );
+
+               if ( cached )
+               {
+                       this->image_idx = image_idx;
+                       mlt_properties cached_props = MLT_FRAME_PROPERTIES( cached );
+                       this->width = mlt_properties_get_int( cached_props, "width" );
+                       this->height = mlt_properties_get_int( cached_props, "height" );
+                       mlt_properties_set_int( producer_props, "_real_width", mlt_properties_get_int( cached_props, "real_width" ) );
+                       mlt_properties_set_int( producer_props, "_real_height", mlt_properties_get_int( cached_props, "real_height" ) );
+                       this->image = mlt_properties_get_data( cached_props, "image", NULL );
+                       this->alpha = mlt_properties_get_data( cached_props, "alpha", NULL );
+
+                       if ( width != 0 && ( width != this->width || height != this->height ) )
+                               this->image = NULL;
+               }
+       }
+
     // optimization for subsequent iterations on single picture
        if ( width != 0 && this->image != NULL && image_idx == this->image_idx )
        {
                if ( width != this->width || height != this->height )
                {
-                       pixbuf = mlt_properties_get_data( producer_props, "pixbuf", NULL );
-                       mlt_pool_release( this->image );
-                       mlt_pool_release( this->alpha );
-                       this->image = NULL;
-                       this->alpha = NULL;
+                       pixbuf = mlt_properties_get_data( producer_props, "_pixbuf", NULL );
                }
        }
-       else if ( this->image == NULL || image_idx != this->image_idx )
+       else if ( pixbuf == NULL && ( this->image == NULL || image_idx != this->image_idx ) )
        {
-               mlt_pool_release( this->image );
-               mlt_pool_release( this->alpha );
-               this->image = NULL;
-               this->alpha = NULL;
-
                this->image_idx = image_idx;
-               pixbuf = gdk_pixbuf_new_from_file( this->filenames[ image_idx ], &error );
+               pixbuf = gdk_pixbuf_new_from_file( mlt_properties_get_value( this->filenames, image_idx ), &error );
 
                if ( pixbuf != NULL )
                {
                        // Register this pixbuf for destruction and reuse
-                       mlt_properties_set_data( producer_props, "pixbuf", pixbuf, 0, ( mlt_destructor )g_object_unref, NULL );
+                       mlt_events_block( producer_props, NULL );
+                       mlt_properties_set_data( producer_props, "_pixbuf", pixbuf, 0, ( mlt_destructor )g_object_unref, NULL );
+                       g_object_ref( pixbuf );
+                       mlt_properties_set_data( MLT_FRAME_PROPERTIES( frame ), "pixbuf", pixbuf, 0, ( mlt_destructor )g_object_unref, NULL );
 
-                       mlt_properties_set_int( producer_props, "real_width", gdk_pixbuf_get_width( pixbuf ) );
-                       mlt_properties_set_int( producer_props, "real_height", gdk_pixbuf_get_height( pixbuf ) );
+                       mlt_properties_set_int( producer_props, "_real_width", gdk_pixbuf_get_width( pixbuf ) );
+                       mlt_properties_set_int( producer_props, "_real_height", gdk_pixbuf_get_height( pixbuf ) );
+                       mlt_events_unblock( producer_props, NULL );
 
                        // Store the width/height of the pixbuf temporarily
                        this->width = gdk_pixbuf_get_width( pixbuf );
@@ -174,12 +311,16 @@ static void refresh_image( mlt_frame frame, int width, int height )
                this->height = height;
                
                // Allocate/define image
+               if ( !use_cache && this->image )
+                       mlt_pool_release( this->image );
                this->image = mlt_pool_alloc( width * ( height + 1 ) * 2 );
 
                // Extract YUV422 and alpha
                if ( gdk_pixbuf_get_has_alpha( pixbuf ) )
                {
                        // Allocate the alpha mask
+                       if ( !use_cache && this->alpha )
+                               mlt_pool_release( this->alpha );
                        this->alpha = mlt_pool_alloc( this->width * this->height );
 
                        // Convert the image
@@ -199,18 +340,34 @@ static void refresh_image( mlt_frame frame, int width, int height )
 
                // Finished with pixbuf now
                g_object_unref( pixbuf );
+
+               // Ensure we update the cache when we need to
+               update_cache = use_cache;
        }
 
        // Set width/height of frame
        mlt_properties_set_int( properties, "width", this->width );
        mlt_properties_set_int( properties, "height", this->height );
-       mlt_properties_set_int( properties, "real_width", mlt_properties_get_int( producer_props, "real_width" ) );
-       mlt_properties_set_int( properties, "real_height", mlt_properties_get_int( producer_props, "real_height" ) );
+       mlt_properties_set_int( properties, "real_width", mlt_properties_get_int( producer_props, "_real_width" ) );
+       mlt_properties_set_int( properties, "real_height", mlt_properties_get_int( producer_props, "_real_height" ) );
 
        // pass the image data without destructor
        mlt_properties_set_data( properties, "image", this->image, this->width * ( this->height + 1 ) * 2, NULL, NULL );
        mlt_properties_set_data( properties, "alpha", this->alpha, this->width * this->height, NULL, NULL );
 
+       if ( update_cache )
+       {
+               mlt_frame cached = mlt_frame_init( MLT_PRODUCER_SERVICE( producer ) );
+               mlt_properties cached_props = MLT_FRAME_PROPERTIES( cached );
+               mlt_properties_set_int( cached_props, "width", this->width );
+               mlt_properties_set_int( cached_props, "height", this->height );
+               mlt_properties_set_int( cached_props, "real_width", mlt_properties_get_int( producer_props, "_real_width" ) );
+               mlt_properties_set_int( cached_props, "real_height", mlt_properties_get_int( producer_props, "_real_height" ) );
+               mlt_properties_set_data( cached_props, "image", this->image, this->width * ( this->height + 1 ) * 2, mlt_pool_release, NULL );
+               mlt_properties_set_data( cached_props, "alpha", this->alpha, this->width * this->height, mlt_pool_release, NULL );
+               mlt_properties_set_data( cache, image_key, cached, 0, ( mlt_destructor )mlt_frame_close, NULL );
+       }
+
        pthread_mutex_unlock( &fastmutex );
 }
 
@@ -219,54 +376,80 @@ static int producer_get_image( mlt_frame frame, uint8_t **buffer, mlt_image_form
        // Obtain properties of frame
        mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
 
+       // We need to know the size of the image to clone it
+       int image_size = 0;
+       int alpha_size = 0;
+
+       // Alpha channel
+       uint8_t *alpha = NULL;
+
        *width = mlt_properties_get_int( properties, "rescale_width" );
        *height = mlt_properties_get_int( properties, "rescale_height" );
 
        // Refresh the image
        refresh_image( frame, *width, *height );
 
-       // May need to know the size of the image to clone it
-       int size = 0;
-
        // Get the image
-       uint8_t *image = mlt_properties_get_data( properties, "image", &size );
+       *buffer = mlt_properties_get_data( properties, "image", &image_size );
+       alpha = mlt_properties_get_data( properties, "alpha", &alpha_size );
 
-       // Get width and height
+       // Get width and height (may have changed during the refresh)
        *width = mlt_properties_get_int( properties, "width" );
        *height = mlt_properties_get_int( properties, "height" );
 
-       if ( size == 0 )
-       {
-               *width = mlt_properties_get_int( properties, "normalised_width" );
-               *height = mlt_properties_get_int( properties, "normalised_height" );
-               size = *width * ( *height + 1 );
-       }
-
-       // Clone if necessary
        // NB: Cloning is necessary with this producer (due to processing of images ahead of use)
        // The fault is not in the design of mlt, but in the implementation of the pixbuf producer...
-       if ( image != NULL )
+       if ( *buffer != NULL )
        {
-               // Clone our image
-               uint8_t *copy = mlt_pool_alloc( size );
-               if ( image != NULL )
-                       memcpy( copy, image, size );
+               if ( *format == mlt_image_yuv422 || *format == mlt_image_yuv420p )
+               {
+                       // Clone the image and the alpha
+                       uint8_t *image_copy = mlt_pool_alloc( image_size );
+                       uint8_t *alpha_copy = mlt_pool_alloc( alpha_size );
+
+                       memcpy( image_copy, *buffer, image_size );
+
+                       // Copy or default the alpha
+                       if ( alpha != NULL )
+                               memcpy( alpha_copy, alpha, alpha_size );
+                       else
+                               memset( alpha_copy, 255, alpha_size );
+
+                       // Now update properties so we free the copy after
+                       mlt_properties_set_data( properties, "image", image_copy, image_size, mlt_pool_release, NULL );
+                       mlt_properties_set_data( properties, "alpha", alpha_copy, alpha_size, mlt_pool_release, NULL );
 
-               // We're going to pass the copy on
-               image = copy;
+                       // We're going to pass the copy on
+                       *buffer = image_copy;
+               }
+               else if ( *format == mlt_image_rgb24a )
+               {
+                       // Clone the image and the alpha
+                       image_size = *width * ( *height + 1 ) * 4;
+                       alpha_size = *width * ( *height + 1 );
+                       uint8_t *image_copy = mlt_pool_alloc( image_size );
+                       uint8_t *alpha_copy = mlt_pool_alloc( alpha_size );
+
+                       mlt_convert_yuv422_to_rgb24a(*buffer, image_copy, (*width)*(*height));
+
+                       // Now update properties so we free the copy after
+                       mlt_properties_set_data( properties, "image", image_copy, image_size, mlt_pool_release, NULL );
+                       mlt_properties_set_data( properties, "alpha", alpha_copy, alpha_size, mlt_pool_release, NULL );
+
+                       // We're going to pass the copy on
+                       *buffer = image_copy;
+               }
 
-               // Now update properties so we free the copy after
-               mlt_properties_set_data( properties, "image", copy, size, mlt_pool_release, NULL );
        }
        else
        {
-               // Fall back to the test card...
-               mlt_frame_get_image( frame, buffer, format, width, height, writable );
+               // TODO: Review all cases of invalid images
+               *buffer = mlt_pool_alloc( 50 * 50 * 2 );
+               mlt_properties_set_data( properties, "image", *buffer, image_size, mlt_pool_release, NULL );
+               *width = 50;
+               *height = 50;
        }
 
-       // Pass on the image
-       *buffer = image;
-
        return 0;
 }
 
@@ -287,100 +470,11 @@ static int producer_get_frame( mlt_producer producer, mlt_frame_ptr frame, int i
        // Fetch the producers properties
        mlt_properties producer_properties = MLT_PRODUCER_PROPERTIES( producer );
 
-       if ( this->count == 0 && mlt_properties_get( producer_properties, "resource" ) != NULL )
-       {
-               char *filename = mlt_properties_get( producer_properties, "resource" );
-               
-               // Read xml string
-               if ( strstr( filename, "<svg" ) )
-               {
-                       // Generate a temporary file for the svg
-                       char fullname[ 1024 ] = "/tmp/mlt.XXXXXX";
-                       int fd = mkstemp( fullname );
-
-                       if ( fd > -1 )
-                       {
-                               // Write the svg into the temp file
-                               ssize_t remaining_bytes;
-                               char *xml = filename;
-                               
-                               // Strip leading crap
-                               while ( xml[0] != '<' )
-                                       xml++;
-                               
-                               remaining_bytes = strlen( xml );
-                               while ( remaining_bytes > 0 )
-                                       remaining_bytes -= write( fd, xml + strlen( xml ) - remaining_bytes, remaining_bytes );
-                               close( fd );
-
-                               this->filenames = realloc( this->filenames, sizeof( char * ) * ( this->count + 1 ) );
-                               this->filenames[ this->count ++ ] = strdup( fullname );
-
-                               // Teehe - when the producer closes, delete the temp file and the space allo
-                               mlt_properties_set_data( producer_properties, "__temporary_file__", this->filenames[ this->count - 1 ], 0, ( mlt_destructor )unlink, NULL );
-                       }
-               }
-               // Obtain filenames
-               else if ( strchr( filename, '%' ) != NULL )
-               {
-                       // handle picture sequences
-                       int i = mlt_properties_get_int( producer_properties, "begin" );
-                       int gap = 0;
-                       char full[1024];
-
-                       while ( gap < 100 )
-                       {
-                               struct stat buf;
-                               snprintf( full, 1023, filename, i ++ );
-                               if ( stat( full, &buf ) == 0 )
-                               {
-                                       this->filenames = realloc( this->filenames, sizeof( char * ) * ( this->count + 1 ) );
-                                       this->filenames[ this->count ++ ] = strdup( full );
-                                       gap = 0;
-                               }
-                               else
-                               {
-                                       gap ++;
-                               }
-                       }
-               }
-               else if ( strstr( filename, "/.all." ) != NULL )
-               {
-                       char *dir_name = strdup( filename );
-                       char *extension = strrchr( filename, '.' );
-                       *( strstr( dir_name, "/.all." ) + 1 ) = '\0';
-                       char fullname[ 1024 ];
-                       strcpy( fullname, dir_name );
-                       struct dirent **de = NULL;
-                       int n = scandir( fullname, &de, filter_files, alphasort );
-                       int i;
-                       struct stat info;
-
-                       for (i = 0; i < n; i++ )
-                       {
-                               snprintf( fullname, 1023, "%s%s", dir_name, de[i]->d_name );
-
-                               if ( strstr( fullname, extension ) && lstat( fullname, &info ) == 0 &&
-                                       ( S_ISREG( info.st_mode ) || info.st_mode | S_IXUSR ) )
-                               {
-                                       this->filenames = realloc( this->filenames, sizeof( char * ) * ( this->count + 1 ) );
-                                       this->filenames[ this->count ++ ] = strdup( fullname );
-                               }
-                               free( de[ i ] );
-                       }
-
-                       free( de );
-                       free( dir_name );
-               }
-               else
-               {
-                       this->filenames = realloc( this->filenames, sizeof( char * ) * ( this->count + 1 ) );
-                       this->filenames[ this->count ++ ] = strdup( filename );
-               }
-       }
+       if ( this->filenames == NULL && mlt_properties_get( producer_properties, "resource" ) != NULL )
+               load_filenames( this, producer_properties );
 
        // Generate a frame
-       *frame = mlt_frame_init( );
+       *frame = mlt_frame_init( MLT_PRODUCER_SERVICE( producer ) );
 
        if ( *frame != NULL && this->count > 0 )
        {
@@ -419,11 +513,13 @@ static int producer_get_frame( mlt_producer producer, mlt_frame_ptr frame, int i
 static void producer_close( mlt_producer parent )
 {
        producer_pixbuf this = parent->child;
-       mlt_pool_release( this->image );
+       if ( !mlt_properties_get_int( MLT_PRODUCER_PROPERTIES( parent ), "cache" ) )
+       {
+               mlt_pool_release( this->image );
+               mlt_pool_release( this->alpha );
+       }
        parent->close = NULL;
        mlt_producer_close( parent );
-       while ( this->count -- )
-               free( this->filenames[ this->count ] );
-       free( this->filenames );
+       mlt_properties_close( this->filenames );
        free( this );
 }