2 * transition_region.c -- region transition
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates <charles.yates@pandora.be>
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 "transition_region.h"
22 #include "transition_composite.h"
24 #include <framework/mlt.h>
30 static int create_instance( mlt_transition transition, char *name, char *value, int count )
32 // Return from this function
35 // Duplicate the value
36 char *type = strdup( value );
38 // Pointer to filter argument
39 char *arg = type == NULL ? NULL : strchr( type, ':' );
41 // New filter being created
42 mlt_filter filter = NULL;
44 // Cleanup type and arg
49 mlt_profile profile = mlt_service_profile( MLT_TRANSITION_SERVICE( transition ) );
50 filter = mlt_factory_filter( profile, type, arg );
52 // If we have a filter, then initialise and store it
55 // Properties of transition
56 mlt_properties properties = MLT_TRANSITION_PROPERTIES( transition );
58 // String to hold the property name
61 // String to hold the passdown key
65 sprintf( id, "_filter_%d", count );
68 sprintf( key, "%s.", name );
70 // Just in case, let's assume that the filter here has a composite
71 //mlt_properties_set( MLT_FILTER_PROPERTIES( filter ), "composite.geometry", "0%/0%:100%x100%" );
72 //mlt_properties_set_int( MLT_FILTER_PROPERTIES( filter ), "composite.fill", 1 );
74 // Pass all the key properties on the filter down
75 mlt_properties_pass( MLT_FILTER_PROPERTIES( filter ), properties, key );
76 mlt_properties_pass_list( MLT_FILTER_PROPERTIES( filter ), properties, "in, out, length" );
78 // Ensure that filter is assigned
79 mlt_properties_set_data( properties, id, filter, 0, ( mlt_destructor )mlt_filter_close, NULL );
83 // Indicate that an error has occurred
90 // Return error condition
94 static uint8_t *filter_get_alpha_mask( mlt_frame frame )
96 uint8_t *alpha = NULL;
98 // Obtain properties of frame
99 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
101 // Get the shape frame
102 mlt_frame shape_frame = mlt_properties_get_data( properties, "shape_frame", NULL );
104 // Get the width and height of the image
105 int region_width = mlt_properties_get_int( properties, "width" );
106 int region_height = mlt_properties_get_int( properties, "height" );
107 uint8_t *image = NULL;
108 mlt_image_format format = mlt_image_yuv422;
110 // Get the shape image to trigger alpha creation
111 mlt_properties_set_int( MLT_FRAME_PROPERTIES( shape_frame ), "distort", 1 );
112 mlt_frame_get_image( shape_frame, &image, &format, ®ion_width, ®ion_height, 0 );
114 alpha = mlt_frame_get_alpha_mask( shape_frame );
116 int size = region_width * region_height;
117 uint8_t *alpha_duplicate = mlt_pool_alloc( size );
119 // Generate from the Y component of the image if no alpha available
122 alpha = alpha_duplicate;
125 *alpha ++ = ( int )( ( ( *image ++ - 16 ) * 299 ) / 255 );
131 memcpy( alpha_duplicate, alpha, size );
133 mlt_frame_set_alpha( frame, alpha_duplicate, region_width * region_height, mlt_pool_release );
135 return alpha_duplicate;
141 static int transition_get_image( mlt_frame frame, uint8_t **image, mlt_image_format *format, int *width, int *height, int writable )
143 // Error we will return
146 // We will get the 'b frame' from the frame stack
147 mlt_frame b_frame = mlt_frame_pop_frame( frame );
149 // Get the watermark transition object
150 mlt_transition transition = mlt_frame_pop_service( frame );
152 // Get the properties of the transition
153 mlt_properties properties = MLT_TRANSITION_PROPERTIES( transition );
155 // Get the properties of the a frame
156 mlt_properties a_props = MLT_FRAME_PROPERTIES( frame );
158 mlt_service_lock( MLT_TRANSITION_SERVICE( transition ) );
160 // Get the composite from the transition
161 mlt_transition composite = mlt_properties_get_data( properties, "composite", NULL );
163 // Look for the first filter
164 mlt_filter filter = mlt_properties_get_data( properties, "_filter_0", NULL );
167 mlt_position position = mlt_transition_get_position( transition, frame );
169 // Create a composite if we don't have one
170 if ( composite == NULL )
172 // Create composite via the factory
173 mlt_profile profile = mlt_service_profile( MLT_TRANSITION_SERVICE( transition ) );
174 composite = mlt_factory_transition( profile, "composite", NULL );
177 if ( composite != NULL )
179 // Get the properties
180 mlt_properties composite_properties = MLT_TRANSITION_PROPERTIES( composite );
182 // We want to ensure that we don't get a wobble...
183 //mlt_properties_set_int( composite_properties, "distort", 1 );
184 mlt_properties_set_int( composite_properties, "progressive", 1 );
186 // Pass all the composite. properties on the transition down
187 mlt_properties_pass( composite_properties, properties, "composite." );
189 // Register the composite for reuse/destruction
190 mlt_properties_set_data( properties, "composite", composite, 0, ( mlt_destructor )mlt_transition_close, NULL );
195 // Pass all current properties down
196 mlt_properties composite_properties = MLT_TRANSITION_PROPERTIES( composite );
197 mlt_properties_pass( composite_properties, properties, "composite." );
201 if ( filter == NULL )
206 // Number of filters created
209 // Loop for all properties
210 for ( i = 0; i < mlt_properties_count( properties ); i ++ )
212 // Get the name of this property
213 char *name = mlt_properties_get_name( properties, i );
215 // If the name does not contain a . and matches filter
216 if ( strchr( name, '.' ) == NULL && !strncmp( name, "filter", 6 ) )
218 // Get the filter constructor
219 char *value = mlt_properties_get_value( properties, i );
221 // Create an instance
222 if ( create_instance( transition, name, value, count ) == 0 )
227 // Look for the first filter again
228 filter = mlt_properties_get_data( properties, "_filter_0", NULL );
232 // Pass all properties down
233 mlt_filter temp = NULL;
238 // Number of filters found
241 // Loop for all properties
242 for ( i = 0; i < mlt_properties_count( properties ); i ++ )
244 // Get the name of this property
245 char *name = mlt_properties_get_name( properties, i );
247 // If the name does not contain a . and matches filter
248 if ( strchr( name, '.' ) == NULL && !strncmp( name, "filter", 6 ) )
250 // Strings to hold the id and pass down key
254 // Construct id and key
255 sprintf( id, "_filter_%d", count );
256 sprintf( key, "%s.", name );
259 temp = mlt_properties_get_data( properties, id, NULL );
263 mlt_properties_pass( MLT_FILTER_PROPERTIES( temp ), properties, key );
270 mlt_properties_set_int( a_props, "width", *width );
271 mlt_properties_set_int( a_props, "height", *height );
273 // Only continue if we have both filter and composite
274 if ( composite != NULL )
276 // Get the resource of this filter (could be a shape [rectangle/circle] or an alpha provider of choice
277 const char *resource = mlt_properties_get( properties, "resource" );
279 // Get the old resource in case it's changed
280 char *old_resource = mlt_properties_get( properties, "_old_resource" );
282 // String to hold the filter to query on
285 // Index to hold the count
288 // We will get the 'b frame' from the composite only if it's NULL (region filter)
289 if ( b_frame == NULL )
292 b_frame = composite_copy_region( composite, frame, position );
294 // Ensure a destructor
295 char *name = mlt_properties_get( properties, "_unique_id" );
296 mlt_properties_set_data( a_props, name, b_frame, 0, ( mlt_destructor )mlt_frame_close, NULL );
299 // Properties of the B frame
300 mlt_properties b_props = MLT_FRAME_PROPERTIES( b_frame );
302 // filter_only prevents copying the alpha channel of the shape to the output frame
303 // by compositing filtered frame over itself
304 if ( mlt_properties_get_int( properties, "filter_only" ) )
306 char *name = mlt_properties_get( properties, "_unique_id" );
307 frame = composite_copy_region( composite, b_frame, position );
308 mlt_properties_set_data( b_props, name, frame, 0, ( mlt_destructor )mlt_frame_close, NULL );
311 // Make sure the filter is in the correct position
312 while ( filter != NULL )
315 if ( mlt_properties_get_int( MLT_FILTER_PROPERTIES( filter ), "off" ) == 0 )
316 mlt_filter_process( filter, b_frame );
318 // Generate the key for the next
319 sprintf( id, "_filter_%d", ++ i );
321 // Get the next filter
322 filter = mlt_properties_get_data( properties, id, NULL );
325 // Allow filters to be attached to a region filter
326 filter = mlt_properties_get_data( properties, "_region_filter", NULL );
327 if ( filter != NULL )
328 mlt_service_apply_filters( MLT_FILTER_SERVICE( filter ), b_frame, 0 );
330 // Hmm - this is probably going to go wrong....
331 mlt_frame_set_position( frame, position );
333 // Get the b frame and process with composite if successful
334 mlt_transition_process( composite, frame, b_frame );
336 // If we have a shape producer copy the alpha mask from the shape frame to the b_frame
337 if ( strcmp( resource, "rectangle" ) != 0 )
339 // Get the producer from the transition
340 mlt_producer producer = mlt_properties_get_data( properties, "producer", NULL );
342 // If We have no producer then create one
343 if ( producer == NULL || ( old_resource != NULL && strcmp( resource, old_resource ) ) )
345 // Get the factory producer service
346 char *factory = mlt_properties_get( properties, "factory" );
348 // Store the old resource
349 mlt_properties_set( properties, "_old_resource", resource );
351 // Special case circle resource
352 if ( strcmp( resource, "circle" ) == 0 )
353 resource = "pixbuf:<svg width='100' height='100'><circle cx='50' cy='50' r='50' fill='black'/></svg>";
355 // Create the producer
356 mlt_profile profile = mlt_service_profile( MLT_TRANSITION_SERVICE( transition ) );
357 producer = mlt_factory_producer( profile, factory, resource );
360 if ( producer != NULL )
362 // Get the producer properties
363 mlt_properties producer_properties = MLT_PRODUCER_PROPERTIES( producer );
365 // Ensure that we loop
366 mlt_properties_set( producer_properties, "eof", "loop" );
368 // Now pass all producer. properties on the transition down
369 mlt_properties_pass( producer_properties, properties, "producer." );
371 // Register the producer for reuse/destruction
372 mlt_properties_set_data( properties, "producer", producer, 0, ( mlt_destructor )mlt_producer_close, NULL );
376 // Now use the shape producer
377 if ( producer != NULL )
379 // We will get the alpha frame from the producer
380 mlt_frame shape_frame = NULL;
382 // Make sure the producer is in the correct position
383 mlt_producer_seek( producer, position );
385 // Get the shape frame
386 if ( mlt_service_get_frame( MLT_PRODUCER_SERVICE( producer ), &shape_frame, 0 ) == 0 )
388 // Ensure that the shape frame will be closed
389 mlt_properties_set_data( b_props, "shape_frame", shape_frame, 0, ( mlt_destructor )mlt_frame_close, NULL );
391 // Specify the callback for evaluation
392 b_frame->get_alpha_mask = filter_get_alpha_mask;
398 error = mlt_frame_get_image( frame, image, format, width, height, 0 );
401 mlt_service_unlock( MLT_TRANSITION_SERVICE( transition ) );
406 /** Filter processing.
409 static mlt_frame transition_process( mlt_transition transition, mlt_frame a_frame, mlt_frame b_frame )
411 // Push the transition on to the frame
412 mlt_frame_push_service( a_frame, transition );
414 // Push the b_frame on to the stack
415 mlt_frame_push_frame( a_frame, b_frame );
417 // Push the transition method
418 mlt_frame_push_get_image( a_frame, transition_get_image );
424 /** Constructor for the transition.
427 mlt_transition transition_region_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
429 // Create a new transition
430 mlt_transition transition = mlt_transition_new( );
432 // Further initialisation
433 if ( transition != NULL )
435 // Get the properties from the transition
436 mlt_properties properties = MLT_TRANSITION_PROPERTIES( transition );
438 // Assign the transition process method
439 transition->process = transition_process;
442 mlt_properties_set( properties, "factory", mlt_environment( "MLT_PRODUCER" ) );
444 // Resource defines the shape of the region
445 mlt_properties_set( properties, "resource", arg == NULL ? "rectangle" : arg );
447 // Inform apps and framework that this is a video only transition
448 mlt_properties_set_int( properties, "_transition_type", 1 );
451 // Return the transition