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 this, 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( this ) );
50 filter = mlt_factory_filter( profile, type, arg );
52 // If we have a filter, then initialise and store it
56 mlt_properties properties = MLT_TRANSITION_PROPERTIES( this );
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 );
77 // Ensure that filter is assigned
78 mlt_properties_set_data( properties, id, filter, 0, ( mlt_destructor )mlt_filter_close, NULL );
82 // Indicate that an error has occurred
89 // Return error condition
93 static uint8_t *filter_get_alpha_mask( mlt_frame this )
95 uint8_t *alpha = NULL;
97 // Obtain properties of frame
98 mlt_properties properties = MLT_FRAME_PROPERTIES( this );
100 // Get the shape frame
101 mlt_frame shape_frame = mlt_properties_get_data( properties, "shape_frame", NULL );
103 // Get the width and height of the image
104 int region_width = mlt_properties_get_int( MLT_FRAME_PROPERTIES( this ), "width" );
105 int region_height = mlt_properties_get_int( MLT_FRAME_PROPERTIES( this ), "height" );
106 uint8_t *image = NULL;
107 mlt_image_format format = mlt_image_yuv422;
109 // Get the shape image to trigger alpha creation
110 mlt_properties_set_int( MLT_FRAME_PROPERTIES( shape_frame ), "distort", 1 );
111 mlt_frame_get_image( shape_frame, &image, &format, ®ion_width, ®ion_height, 0 );
113 alpha = mlt_frame_get_alpha_mask( shape_frame );
115 // Generate from the Y component of the image if no alpha available
118 int size = region_width * region_height;
119 uint8_t *p = mlt_pool_alloc( size );
123 *p ++ = ( int )( ( ( *image ++ - 16 ) * 299 ) / 255 );
126 mlt_frame_set_alpha( this, alpha, region_width * region_height, mlt_pool_release );
130 mlt_frame_set_alpha( this, alpha, region_width * region_height, NULL );
139 static int transition_get_image( mlt_frame frame, uint8_t **image, mlt_image_format *format, int *width, int *height, int writable )
141 // Error we will return
144 // We will get the 'b frame' from the frame stack
145 mlt_frame b_frame = mlt_frame_pop_frame( frame );
147 // Get the watermark transition object
148 mlt_transition this = mlt_frame_pop_service( frame );
150 // Get the properties of the transition
151 mlt_properties properties = MLT_TRANSITION_PROPERTIES( this );
153 mlt_service_lock( MLT_TRANSITION_SERVICE( this ) );
155 // Get the composite from the transition
156 mlt_transition composite = mlt_properties_get_data( properties, "composite", NULL );
158 // Look for the first filter
159 mlt_filter filter = mlt_properties_get_data( properties, "_filter_0", NULL );
162 mlt_position position = mlt_transition_get_position( this, frame );
164 // Create a composite if we don't have one
165 if ( composite == NULL )
167 // Create composite via the factory
168 mlt_profile profile = mlt_service_profile( MLT_TRANSITION_SERVICE( this ) );
169 composite = mlt_factory_transition( profile, "composite", NULL );
172 if ( composite != NULL )
174 // Get the properties
175 mlt_properties composite_properties = MLT_TRANSITION_PROPERTIES( composite );
177 // We want to ensure that we don't get a wobble...
178 //mlt_properties_set_int( composite_properties, "distort", 1 );
179 mlt_properties_set_int( composite_properties, "progressive", 1 );
181 // Pass all the composite. properties on the transition down
182 mlt_properties_pass( composite_properties, properties, "composite." );
184 // Register the composite for reuse/destruction
185 mlt_properties_set_data( properties, "composite", composite, 0, ( mlt_destructor )mlt_transition_close, NULL );
190 // Pass all current properties down
191 mlt_properties composite_properties = MLT_TRANSITION_PROPERTIES( composite );
192 mlt_properties_pass( composite_properties, properties, "composite." );
196 if ( filter == NULL )
201 // Number of filters created
204 // Loop for all properties
205 for ( i = 0; i < mlt_properties_count( properties ); i ++ )
207 // Get the name of this property
208 char *name = mlt_properties_get_name( properties, i );
210 // If the name does not contain a . and matches filter
211 if ( strchr( name, '.' ) == NULL && !strncmp( name, "filter", 6 ) )
213 // Get the filter constructor
214 char *value = mlt_properties_get_value( properties, i );
216 // Create an instance
217 if ( create_instance( this, name, value, count ) == 0 )
222 // Look for the first filter again
223 filter = mlt_properties_get_data( properties, "_filter_0", NULL );
227 // Pass all properties down
228 mlt_filter temp = NULL;
233 // Number of filters found
236 // Loop for all properties
237 for ( i = 0; i < mlt_properties_count( properties ); i ++ )
239 // Get the name of this property
240 char *name = mlt_properties_get_name( properties, i );
242 // If the name does not contain a . and matches filter
243 if ( strchr( name, '.' ) == NULL && !strncmp( name, "filter", 6 ) )
245 // Strings to hold the id and pass down key
249 // Construct id and key
250 sprintf( id, "_filter_%d", count );
251 sprintf( key, "%s.", name );
254 temp = mlt_properties_get_data( properties, id, NULL );
258 mlt_properties_pass( MLT_FILTER_PROPERTIES( temp ), properties, key );
265 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "width", *width );
266 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "height", *height );
268 // Only continue if we have both filter and composite
269 if ( composite != NULL )
271 // Get the resource of this filter (could be a shape [rectangle/circle] or an alpha provider of choice
272 const char *resource = mlt_properties_get( properties, "resource" );
274 // Get the old resource in case it's changed
275 char *old_resource = mlt_properties_get( properties, "_old_resource" );
277 // String to hold the filter to query on
280 // Index to hold the count
283 // We will get the 'b frame' from the composite only if it's NULL (region filter)
284 if ( b_frame == NULL )
287 b_frame = composite_copy_region( composite, frame, position );
289 // Ensure a destructor
290 char *name = mlt_properties_get( properties, "_unique_id" );
291 mlt_properties_set_data( MLT_FRAME_PROPERTIES( frame ), name, b_frame, 0, ( mlt_destructor )mlt_frame_close, NULL );
294 // filter_only prevents copying the alpha channel of the shape to the output frame
295 // by compositing filtered frame over itself
296 if ( mlt_properties_get_int( properties, "filter_only" ) )
298 frame = composite_copy_region( composite, b_frame, position );
301 // Make sure the filter is in the correct position
302 while ( filter != NULL )
305 if ( mlt_properties_get_int( MLT_FILTER_PROPERTIES( filter ), "off" ) == 0 )
306 mlt_filter_process( filter, b_frame );
308 // Generate the key for the next
309 sprintf( id, "_filter_%d", ++ i );
311 // Get the next filter
312 filter = mlt_properties_get_data( properties, id, NULL );
315 // Allow filters to be attached to a region filter
316 filter = mlt_properties_get_data( properties, "_region_filter", NULL );
317 if ( filter != NULL )
318 mlt_service_apply_filters( MLT_FILTER_SERVICE( filter ), b_frame, 0 );
320 // Hmm - this is probably going to go wrong....
321 mlt_frame_set_position( frame, position );
323 // Get the b frame and process with composite if successful
324 mlt_transition_process( composite, frame, b_frame );
326 // If we have a shape producer copy the alpha mask from the shape frame to the b_frame
327 if ( strcmp( resource, "rectangle" ) != 0 )
329 // Get the producer from the transition
330 mlt_producer producer = mlt_properties_get_data( properties, "producer", NULL );
332 // If We have no producer then create one
333 if ( producer == NULL || ( old_resource != NULL && strcmp( resource, old_resource ) ) )
335 // Get the factory producer service
336 char *factory = mlt_properties_get( properties, "factory" );
338 // Store the old resource
339 mlt_properties_set( properties, "_old_resource", resource );
341 // Special case circle resource
342 if ( strcmp( resource, "circle" ) == 0 )
343 resource = "pixbuf:<svg width='100' height='100'><circle cx='50' cy='50' r='50' fill='black'/></svg>";
345 // Create the producer
346 mlt_profile profile = mlt_service_profile( MLT_TRANSITION_SERVICE( this ) );
347 producer = mlt_factory_producer( profile, factory, resource );
350 if ( producer != NULL )
352 // Get the producer properties
353 mlt_properties producer_properties = MLT_PRODUCER_PROPERTIES( producer );
355 // Ensure that we loop
356 mlt_properties_set( producer_properties, "eof", "loop" );
358 // Now pass all producer. properties on the transition down
359 mlt_properties_pass( producer_properties, properties, "producer." );
361 // Register the producer for reuse/destruction
362 mlt_properties_set_data( properties, "producer", producer, 0, ( mlt_destructor )mlt_producer_close, NULL );
366 // Now use the shape producer
367 if ( producer != NULL )
369 // We will get the alpha frame from the producer
370 mlt_frame shape_frame = NULL;
372 // Make sure the producer is in the correct position
373 mlt_producer_seek( producer, position );
375 // Get the shape frame
376 if ( mlt_service_get_frame( MLT_PRODUCER_SERVICE( producer ), &shape_frame, 0 ) == 0 )
378 // Ensure that the shape frame will be closed
379 mlt_properties_set_data( MLT_FRAME_PROPERTIES( b_frame ), "shape_frame", shape_frame, 0, ( mlt_destructor )mlt_frame_close, NULL );
381 // Specify the callback for evaluation
382 b_frame->get_alpha_mask = filter_get_alpha_mask;
388 error = mlt_frame_get_image( frame, image, format, width, height, 0 );
391 mlt_service_unlock( MLT_TRANSITION_SERVICE( this ) );
396 /** Filter processing.
399 static mlt_frame transition_process( mlt_transition this, mlt_frame a_frame, mlt_frame b_frame )
401 // Push the transition on to the frame
402 mlt_frame_push_service( a_frame, this );
404 // Push the b_frame on to the stack
405 mlt_frame_push_frame( a_frame, b_frame );
407 // Push the transition method
408 mlt_frame_push_get_image( a_frame, transition_get_image );
414 /** Constructor for the transition.
417 mlt_transition transition_region_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
419 // Create a new transition
420 mlt_transition this = mlt_transition_new( );
422 // Further initialisation
425 // Get the properties from the transition
426 mlt_properties properties = MLT_TRANSITION_PROPERTIES( this );
428 // Assign the transition process method
429 this->process = transition_process;
432 mlt_properties_set( properties, "factory", mlt_environment( "MLT_PRODUCER" ) );
434 // Resource defines the shape of the region
435 mlt_properties_set( properties, "resource", arg == NULL ? "rectangle" : arg );
437 // Inform apps and framework that this is a video only transition
438 mlt_properties_set_int( properties, "_transition_type", 1 );
441 // Return the transition