qimage module: add mutex, fix caching and use alpha only if necessary (mostly borrowe...
[melted] / src / modules / qimage / qimage_wrapper.cpp
1 /*
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>
5 *
6 * NB: This module is designed to be functionally equivalent to the
7 * gtk2 image loading module so it can be used as replacement.
8 *
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.
13 *
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.
18 *
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.
22 */
23
24 #include "qimage_wrapper.h"
25
26 #ifdef USE_QT3
27 #include <qimage.h>
28 #include <qmutex.h>
29
30 #ifdef USE_KDE
31 #include <kinstance.h>
32 #include <kimageio.h>
33 #endif
34
35 #endif
36
37
38 #ifdef USE_QT4
39 #include <QtGui/QImage>
40 #include <QtCore/QSysInfo>
41 #include <QtCore/QMutex>
42 #endif
43
44
45 #include <cmath>
46
47 extern "C" {
48
49 #include <framework/mlt_pool.h>
50
51 #ifdef USE_KDE
52 static KInstance *instance = 0L;
53 #endif
54
55 static void qimage_delete( void *data )
56 {
57 QImage *image = ( QImage * )data;
58 delete image;
59 image = NULL;
60 #ifdef USE_KDE
61 if (instance) delete instance;
62 instance = 0L;
63 #endif
64 }
65
66 QMutex mutex;
67
68 #ifdef USE_KDE
69 void init_qimage()
70 {
71 if (!instance) {
72 instance = new KInstance("qimage_prod");
73 KImageIO::registerFormats();
74 }
75 }
76 #endif
77
78 void refresh_qimage( mlt_frame frame, int width, int height )
79 {
80 // Obtain a previous assigned qimage (if it exists)
81 QImage *qimage = static_cast <QImage *>(mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "qimage", NULL ));
82
83 // Obtain properties of frame
84 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
85
86 // Obtain the producer for this frame
87 producer_qimage self = ( producer_qimage )mlt_properties_get_data( properties, "producer_qimage", NULL );
88
89 // Obtain the producer
90 mlt_producer producer = &self->parent;
91
92 // Obtain properties of producer
93 mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( producer );
94
95 // Obtain the cache flag and structure
96 int use_cache = mlt_properties_get_int( producer_props, "cache" );
97 mlt_properties cache = ( mlt_properties )mlt_properties_get_data( producer_props, "_cache", NULL );
98 int update_cache = 0;
99
100 // Get the time to live for each frame
101 double ttl = mlt_properties_get_int( producer_props, "ttl" );
102
103 // Get the original position of this frame
104 mlt_position position = mlt_properties_get_position( properties, "qimage_position" );
105 position += mlt_producer_get_in( producer );
106
107 // Image index
108 int image_idx = ( int )floor( ( double )position / ttl ) % self->count;
109
110 // Key for the cache
111 char image_key[ 10 ];
112 sprintf( image_key, "%d", image_idx );
113
114 mutex.lock();
115
116 // Check if the frame is already loaded
117 if ( use_cache )
118 {
119 if ( cache == NULL )
120 {
121 cache = mlt_properties_new( );
122 mlt_properties_set_data( producer_props, "_cache", cache, 0, ( mlt_destructor )mlt_properties_close, NULL );
123 }
124
125 mlt_frame cached = ( mlt_frame )mlt_properties_get_data( cache, image_key, NULL );
126
127 if ( cached )
128 {
129 self->image_idx = image_idx;
130 mlt_properties cached_props = MLT_FRAME_PROPERTIES( cached );
131 self->current_width = mlt_properties_get_int( cached_props, "width" );
132 self->current_height = mlt_properties_get_int( cached_props, "height" );
133 mlt_properties_set_int( producer_props, "_real_width", mlt_properties_get_int( cached_props, "real_width" ) );
134 mlt_properties_set_int( producer_props, "_real_height", mlt_properties_get_int( cached_props, "real_height" ) );
135 self->current_image = ( uint8_t * )mlt_properties_get_data( cached_props, "image", NULL );
136 self->current_alpha = ( uint8_t * )mlt_properties_get_data( cached_props, "alpha", NULL );
137
138 if ( width != 0 && ( width != self->current_width || height != self->current_height ) )
139 self->current_image = NULL;
140 }
141 }
142
143 // optimization for subsequent iterations on single picture
144 if ( width != 0 && self->current_image != NULL && image_idx == self->image_idx )
145 {
146 if ( width != self->current_width || height != self->current_height )
147 {
148 qimage = static_cast<QImage *>(mlt_properties_get_data( producer_props, "_qimage", NULL ));
149 if ( !use_cache )
150 {
151 mlt_pool_release( self->current_image );
152 mlt_pool_release( self->current_alpha );
153 }
154 self->current_image = NULL;
155 self->current_alpha = NULL;
156 }
157 }
158 else if ( qimage == NULL && ( self->current_image == NULL || image_idx != self->image_idx ) )
159 {
160 if ( !use_cache )
161 {
162 mlt_pool_release( self->current_image );
163 mlt_pool_release( self->current_alpha );
164 }
165 self->current_image = NULL;
166 self->current_alpha = NULL;
167
168 self->image_idx = image_idx;
169 qimage = new QImage( mlt_properties_get_value( self->filenames, image_idx ) );
170
171 if ( !qimage->isNull( ) )
172 {
173 QImage *frame_copy = new QImage( *qimage );
174
175 // Store the width/height of the pixbuf
176 self->current_width = qimage->width( );
177 self->current_height = qimage->height( );
178
179 // Register qimage for destruction and reuse
180 mlt_events_block( producer_props, NULL );
181 mlt_properties_set_data( producer_props, "_qimage", qimage, 0, ( mlt_destructor )qimage_delete, NULL );
182 mlt_properties_set_data( MLT_FRAME_PROPERTIES( frame ), "qimage", frame_copy, 0, ( mlt_destructor )qimage_delete, NULL );
183 mlt_properties_set_int( producer_props, "_real_width", self->current_width );
184 mlt_properties_set_int( producer_props, "_real_height", self->current_height );
185 mlt_events_unblock( producer_props, NULL );
186 }
187 else
188 {
189 delete qimage;
190 qimage = NULL;
191 }
192 }
193
194 // If we have a pixbuf and this request specifies a valid dimension and we haven't already got a cached version...
195 if ( qimage && width > 0 && self->current_image == NULL )
196 {
197 char *interps = mlt_properties_get( properties, "rescale.interp" );
198 int interp = 0;
199
200 // QImage has two scaling modes - we'll toggle between them here
201 if ( strcmp( interps, "tiles" ) == 0 )
202 interp = 1;
203 else if ( strcmp( interps, "hyper" ) == 0 )
204 interp = 1;
205
206 #ifdef USE_QT4
207 // Note - the original qimage is already safe and ready for destruction
208 QImage scaled = interp == 0 ? qimage->scaled( QSize( width, height)) : qimage->scaled( QSize(width, height), Qt::IgnoreAspectRatio, Qt::SmoothTransformation);
209 QImage temp;
210 bool hasAlpha = scaled.hasAlphaChannel();
211 if (hasAlpha)
212 temp = scaled.convertToFormat(QImage::Format_ARGB32);
213 else
214 temp = scaled.convertToFormat(QImage::Format_RGB888);
215 #endif
216
217 #ifdef USE_QT3
218 // Note - the original qimage is already safe and ready for destruction
219 QImage scaled = interp == 0 ? qimage->scale( width, height, QImage::ScaleFree ) : qimage->smoothScale( width, height, QImage::ScaleFree );
220 QImage temp = scaled.convertDepth( 32 );
221 bool hasAlpha = true;
222 #endif
223
224 // Store width and height
225 self->current_width = width;
226 self->current_height = height;
227
228 // Allocate/define image
229 self->current_image = ( uint8_t * )mlt_pool_alloc( width * ( height + 1 ) * 2 );
230
231
232 if (!hasAlpha) {
233 mlt_convert_rgb24_to_yuv422( temp.bits(), self->current_width, self->current_height, temp.bytesPerLine(), self->current_image );
234 }
235 else {
236 // Allocate the alpha mask
237 self->current_alpha = ( uint8_t * )mlt_pool_alloc( self->current_width * self->current_height );
238 #ifdef USE_QT4
239 if ( QSysInfo::ByteOrder == QSysInfo::BigEndian )
240 mlt_convert_argb_to_yuv422( temp.bits( ), self->current_width, self->current_height, temp.bytesPerLine(), self->current_image, self->current_alpha );
241 else
242 mlt_convert_bgr24a_to_yuv422( temp.bits( ), self->current_width, self->current_height, temp.bytesPerLine( ), self->current_image, self->current_alpha );
243 #endif
244
245 #ifdef USE_QT3
246 // Convert the image
247 if ( QImage::systemByteOrder( ) == QImage::BigEndian )
248 mlt_convert_argb_to_yuv422( temp.bits( ), self->current_width, self->current_height, temp.bytesPerLine( ), self->current_image, self->current_alpha );
249 else
250 mlt_convert_bgr24a_to_yuv422( temp.bits( ), self->current_width, self->current_height, temp.bytesPerLine( ), self->current_image, self->current_alpha );
251 #endif
252 }
253
254 // Ensure we update the cache when we need to
255 update_cache = use_cache;
256 }
257
258 // Set width/height of frame
259 mlt_properties_set_int( properties, "width", self->current_width );
260 mlt_properties_set_int( properties, "height", self->current_height );
261 mlt_properties_set_int( properties, "real_width", mlt_properties_get_int( producer_props, "_real_width" ) );
262 mlt_properties_set_int( properties, "real_height", mlt_properties_get_int( producer_props, "_real_height" ) );
263
264 // pass the image data without destructor
265 mlt_properties_set_data( properties, "image", self->current_image, self->current_width * ( self->current_height + 1 ) * 2, NULL, NULL );
266 mlt_properties_set_data( properties, "alpha", self->current_alpha, self->current_width * self->current_height, NULL, NULL );
267
268 if ( update_cache )
269 {
270 mlt_frame cached = mlt_frame_init( MLT_PRODUCER_SERVICE( producer ) );
271 mlt_properties cached_props = MLT_FRAME_PROPERTIES( cached );
272 mlt_properties_set_int( cached_props, "width", self->current_width );
273 mlt_properties_set_int( cached_props, "height", self->current_height );
274 mlt_properties_set_int( cached_props, "real_width", mlt_properties_get_int( producer_props, "_real_width" ) );
275 mlt_properties_set_int( cached_props, "real_height", mlt_properties_get_int( producer_props, "_real_height" ) );
276 mlt_properties_set_data( cached_props, "image", self->current_image, self->current_width * ( self->current_height + 1 ) * 2, mlt_pool_release, NULL );
277 mlt_properties_set_data( cached_props, "alpha", self->current_alpha, self->current_width * self->current_height, mlt_pool_release, NULL );
278 mlt_properties_set_data( cache, image_key, cached, 0, ( mlt_destructor )mlt_frame_close, NULL );
279 }
280 mutex.unlock();
281 }
282 }
283