2 * qimage_wrapper.cpp -- a QT/QImage based producer for MLT
3 * Copyright (C) 2006 Visual Media
4 * Author: Charles Yates <charles.yates@gmail.com>
6 * NB: This module is designed to be functionally equivalent to the
7 * gtk2 image loading module so it can be used as replacement.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 #include "qimage_wrapper.h"
31 #include <kinstance.h>
37 #include <kcomponentdata.h>
41 #include <QtGui/QImage>
42 #include <QtCore/QSysInfo>
43 #include <QtGui/QApplication>
44 #include <QtCore/QMutex>
45 #include <QtCore/QtEndian>
46 #include <QtCore/QTemporaryFile>
47 #include <QtCore/QLocale>
51 #include <libexif/exif-data.h>
59 #include <framework/mlt_pool.h>
60 #include <framework/mlt_cache.h>
63 static KComponentData *instance = 0L;
65 static KInstance *instance = 0L;
68 static QApplication *app = NULL;
70 static void qimage_delete( void *data )
72 QImage *image = ( QImage * )data;
75 #if defined(USE_KDE3) || defined(USE_KDE4)
76 if (instance) delete instance;
86 instance = new KComponentData( "qimage_prod" );
88 #elif defined(USE_KDE3)
90 instance = new KInstance( "qimage_prod" );
91 KImageIO::registerFormats();
97 static QImage* reorient_with_exif( producer_qimage self, int image_idx, QImage *qimage )
100 mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( &self->parent );
101 ExifData *d = exif_data_new_from_file( mlt_properties_get_value( self->filenames, image_idx ) );
103 int exif_orientation = 0;
104 /* get orientation and rotate image accordingly if necessary */
106 if ( ( entry = exif_content_get_entry ( d->ifd[EXIF_IFD_0], EXIF_TAG_ORIENTATION ) ) )
107 exif_orientation = exif_get_short (entry->data, exif_data_get_byte_order (d));
109 /* Free the EXIF data */
113 // Remember EXIF value, might be useful for someone
114 mlt_properties_set_int( producer_props, "_exif_orientation" , exif_orientation );
116 if ( exif_orientation > 1 )
118 // Rotate image according to exif data
122 switch ( exif_orientation ) {
124 matrix.scale( -1, 1 );
127 matrix.rotate( 180 );
130 matrix.scale( 1, -1 );
133 matrix.rotate( 270 );
134 matrix.scale( -1, 1 );
141 matrix.scale( -1, 1 );
144 matrix.rotate( 270 );
147 processed = qimage->transformed( matrix );
149 qimage = new QImage( processed );
155 int refresh_qimage( producer_qimage self, mlt_frame frame )
157 // Obtain properties of frame and producer
158 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
159 mlt_producer producer = &self->parent;
160 mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( producer );
162 // Check if user wants us to reload the image
163 if ( mlt_properties_get_int( producer_props, "force_reload" ) )
166 self->current_image = NULL;
167 mlt_properties_set_int( producer_props, "force_reload", 0 );
170 // Get the time to live for each frame
171 double ttl = mlt_properties_get_int( producer_props, "ttl" );
173 // Get the original position of this frame
174 mlt_position position = mlt_frame_original_position( frame );
175 position += mlt_producer_get_in( producer );
178 int image_idx = ( int )floor( ( double )position / ttl ) % self->count;
181 char image_key[ 10 ];
182 sprintf( image_key, "%d", image_idx );
184 int disable_exif = mlt_properties_get_int( producer_props, "disable_exif" );
196 if ( getenv("DISPLAY") == 0 )
198 mlt_log_panic( MLT_PRODUCER_SERVICE( producer ), "Error, cannot render titles without an X11 environment.\nPlease either run melt from an X session or use a fake X server like xvfb:\nxvfb-run -a melt (...)\n" );
205 argv[0] = (char*) "xxx";
206 app = new QApplication( argc, argv );
207 const char *localename = mlt_properties_get_lcnumeric( MLT_SERVICE_PROPERTIES( MLT_PRODUCER_SERVICE( producer ) ) );
208 QLocale::setDefault( QLocale( localename ) );
212 if ( image_idx != self->qimage_idx )
214 if ( !self->qimage || mlt_properties_get_int( producer_props, "_disable_exif" ) != disable_exif )
216 self->current_image = NULL;
217 QImage *qimage = new QImage( QString::fromUtf8( mlt_properties_get_value( self->filenames, image_idx ) ) );
218 self->qimage = qimage;
220 if ( !qimage->isNull( ) )
222 // Read the exif value for this file
224 qimage = reorient_with_exif( self, image_idx, qimage );
226 // Register qimage for destruction and reuse
227 mlt_cache_item_close( self->qimage_cache );
228 mlt_service_cache_put( MLT_PRODUCER_SERVICE( producer ), "qimage.qimage", qimage, 0, ( mlt_destructor )qimage_delete );
229 self->qimage_cache = mlt_service_cache_get( MLT_PRODUCER_SERVICE( producer ), "qimage.qimage" );
230 self->qimage_idx = image_idx;
232 // Store the width/height of the qimage
233 self->current_width = qimage->width( );
234 self->current_height = qimage->height( );
236 mlt_events_block( producer_props, NULL );
237 mlt_properties_set_int( producer_props, "meta.media.width", self->current_width );
238 mlt_properties_set_int( producer_props, "meta.media.height", self->current_height );
239 mlt_properties_set_int( producer_props, "_disable_exif", disable_exif );
240 mlt_events_unblock( producer_props, NULL );
249 // Set width/height of frame
250 mlt_properties_set_int( properties, "width", self->current_width );
251 mlt_properties_set_int( properties, "height", self->current_height );
256 void refresh_image( producer_qimage self, mlt_frame frame, mlt_image_format format, int width, int height )
258 // Obtain properties of frame and producer
259 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
260 mlt_producer producer = &self->parent;
262 // Get index and qimage
263 int image_idx = refresh_qimage( self, frame );
265 // optimization for subsequent iterations on single pictur
266 if ( image_idx != self->image_idx || width != self->current_width || height != self->current_height )
267 self->current_image = NULL;
269 // If we have a qimage and need a new scaled image
270 if ( self->qimage && ( !self->current_image || ( format != mlt_image_none && format != self->format ) ) )
272 char *interps = mlt_properties_get( properties, "rescale.interp" );
274 QImage *qimage = static_cast<QImage*>( self->qimage );
276 // QImage has two scaling modes - we'll toggle between them here
277 if ( strcmp( interps, "tiles" ) == 0
278 || strcmp( interps, "hyper" ) == 0
279 || strcmp( interps, "bicubic" ) == 0 )
283 // Note - the original qimage is already safe and ready for destruction
284 if ( qimage->depth() == 1 )
286 QImage temp = qimage->convertToFormat( QImage::Format_RGB32 );
288 qimage = new QImage( temp );
289 self->qimage = qimage;
291 QImage scaled = interp == 0 ? qimage->scaled( QSize( width, height ) ) :
292 qimage->scaled( QSize(width, height), Qt::IgnoreAspectRatio, Qt::SmoothTransformation );
293 int has_alpha = scaled.hasAlphaChannel();
297 // Note - the original qimage is already safe and ready for destruction
298 QImage scaled = interp == 0 ? qimage->scale( width, height, QImage::ScaleFree ) :
299 qimage->smoothScale( width, height, QImage::ScaleFree );
303 // Store width and height
304 self->current_width = width;
305 self->current_height = height;
307 // Allocate/define image
308 int dst_stride = width * ( has_alpha ? 4 : 3 );
309 int image_size = dst_stride * ( height + 1 );
310 self->current_image = ( uint8_t * )mlt_pool_alloc( image_size );
311 self->current_alpha = NULL;
312 self->format = has_alpha ? mlt_image_rgb24a : mlt_image_rgb24;
315 int y = self->current_height + 1;
316 uint8_t *dst = self->current_image;
319 QRgb *src = (QRgb*) scaled.scanLine( self->current_height - y );
320 int x = self->current_width + 1;
324 *dst++ = qGreen(*src);
325 *dst++ = qBlue(*src);
326 if ( has_alpha ) *dst++ = qAlpha(*src);
331 // Convert image to requested format
332 if ( format != mlt_image_none && format != self->format )
334 uint8_t *buffer = NULL;
336 // First, set the image so it can be converted when we get it
337 mlt_frame_replace_image( frame, self->current_image, self->format, width, height );
338 mlt_frame_set_image( frame, self->current_image, image_size, mlt_pool_release );
339 self->format = format;
341 // get_image will do the format conversion
342 mlt_frame_get_image( frame, &buffer, &format, &width, &height, 0 );
344 // cache copies of the image and alpha buffers
347 image_size = mlt_image_format_size( format, width, height, NULL );
348 self->current_image = (uint8_t*) mlt_pool_alloc( image_size );
349 memcpy( self->current_image, buffer, image_size );
351 if ( ( buffer = mlt_frame_get_alpha_mask( frame ) ) )
353 self->current_alpha = (uint8_t*) mlt_pool_alloc( width * height );
354 memcpy( self->current_alpha, buffer, width * height );
359 mlt_cache_item_close( self->image_cache );
360 mlt_service_cache_put( MLT_PRODUCER_SERVICE( producer ), "qimage.image", self->current_image, image_size, mlt_pool_release );
361 self->image_cache = mlt_service_cache_get( MLT_PRODUCER_SERVICE( producer ), "qimage.image" );
362 self->image_idx = image_idx;
363 mlt_cache_item_close( self->alpha_cache );
364 self->alpha_cache = NULL;
365 if ( self->current_alpha )
367 mlt_service_cache_put( MLT_PRODUCER_SERVICE( producer ), "qimage.alpha", self->current_alpha, width * height, mlt_pool_release );
368 self->alpha_cache = mlt_service_cache_get( MLT_PRODUCER_SERVICE( producer ), "qimage.alpha" );
372 // Set width/height of frame
373 mlt_properties_set_int( properties, "width", self->current_width );
374 mlt_properties_set_int( properties, "height", self->current_height );
377 extern void make_tempfile( producer_qimage self, const char *xml )
379 // Generate a temporary file for the svg
380 QTemporaryFile tempFile( "mlt.XXXXXX" );
382 tempFile.setAutoRemove( false );
383 if ( tempFile.open() )
385 // Write the svg into the temp file
386 char *fullname = tempFile.fileName().toUtf8().data();
388 // Strip leading crap
389 while ( xml[0] != '<' )
392 qint64 remaining_bytes = strlen( xml );
393 while ( remaining_bytes > 0 )
394 remaining_bytes -= tempFile.write( xml + strlen( xml ) - remaining_bytes, remaining_bytes );
397 mlt_properties_set( self->filenames, "0", fullname );
399 mlt_properties_set_data( MLT_PRODUCER_PROPERTIES( &self->parent ), "__temporary_file__",
400 fullname, 0, ( mlt_destructor )unlink, NULL );