2 * mlt_geometry.c -- provides the geometry API
3 * Copyright (C) 2004-2005 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 "mlt_geometry.h"
22 #include "mlt_tokeniser.h"
23 #include "mlt_factory.h"
24 #include "mlt_profile.h"
30 typedef struct geometry_item_s
32 struct mlt_geometry_item_s data;
33 struct geometry_item_s *next, *prev;
45 geometry_s, *geometry;
47 // Create a new geometry structure
48 mlt_geometry mlt_geometry_init( )
50 mlt_geometry this = calloc( 1, sizeof( struct mlt_geometry_s ) );
53 this->local = calloc( 1, sizeof( geometry_s ) );
54 if ( this->local != NULL )
56 geometry self = this->local;
72 static inline double linearstep( double start, double end, double position, int length )
74 double o = ( end - start ) / length;
75 return start + position * o;
78 static void mlt_geometry_virtual_refresh( mlt_geometry this )
80 geometry self = this->local;
82 // Parse of all items to ensure unspecified keys are calculated correctly
83 if ( self->item != NULL )
86 for ( i = 0; i < 5; i ++ )
88 geometry_item current = self->item;
89 while( current != NULL )
91 int fixed = current->data.f[ i ];
94 geometry_item prev = current->prev;
95 geometry_item next = current->next;
97 double prev_value = 0;
98 double next_value = 0;
101 while( prev != NULL && !prev->data.f[ i ] ) prev = prev->prev;
102 while( next != NULL && !next->data.f[ i ] ) next = next->next;
107 if ( prev ) prev_value = prev->data.x;
108 if ( next ) next_value = next->data.x;
111 if ( prev ) prev_value = prev->data.y;
112 if ( next ) next_value = next->data.y;
115 if ( prev ) prev_value = prev->data.w;
116 if ( next ) next_value = next->data.w;
119 if ( prev ) prev_value = prev->data.h;
120 if ( next ) next_value = next->data.h;
123 if ( prev ) prev_value = prev->data.mix;
124 if ( next ) next_value = next->data.mix;
128 // This should never happen
130 current->data.f[ i ] = 1;
131 else if ( next == NULL )
134 value = linearstep( prev_value, next_value, current->data.frame - prev->data.frame, next->data.frame - prev->data.frame );
138 case 0: current->data.x = value; break;
139 case 1: current->data.y = value; break;
140 case 2: current->data.w = value; break;
141 case 3: current->data.h = value; break;
142 case 4: current->data.mix = value; break;
146 // Move to the next item
147 current = current->next;
153 static int mlt_geometry_drop( mlt_geometry this, geometry_item item )
155 geometry self = this->local;
157 if ( item == self->item )
159 self->item = item->next;
160 if ( self->item != NULL )
161 self->item->prev = NULL;
162 // To ensure correct seeding, ensure all values are fixed
163 if ( self->item != NULL )
165 self->item->data.f[0] = 1;
166 self->item->data.f[1] = 1;
167 self->item->data.f[2] = 1;
168 self->item->data.f[3] = 1;
169 self->item->data.f[4] = 1;
172 else if ( item->next != NULL && item->prev != NULL )
174 item->prev->next = item->next;
175 item->next->prev = item->prev;
177 else if ( item->next != NULL )
179 item->next->prev = item->prev;
181 else if ( item->prev != NULL )
183 item->prev->next = item->next;
191 static void mlt_geometry_clean( mlt_geometry this )
193 geometry self = this->local;
197 mlt_geometry_drop( this, self->item );
200 // Parse the geometry specification for a given length and normalised width/height (-1 for default)
201 // data is constructed as: [frame=]X,Y:WxH[:mix][;[frame=]X,Y:WxH[:mix]]*
202 // and X, Y, W and H can have trailing % chars to indicate percentage of normalised size
203 int mlt_geometry_parse( mlt_geometry this, char *data, int length, int nw, int nh )
207 // Create a tokeniser
208 mlt_tokeniser tokens = mlt_tokeniser_init( );
210 // Get the local/private structure
211 geometry self = this->local;
213 // Clean the existing geometry
214 mlt_geometry_clean( this );
216 // Update the info on the data
218 self->length = length;
224 self->data = strdup( data );
228 mlt_tokeniser_parse_new( tokens, data, ";" );
230 // Iterate through each token
231 for ( i = 0; i < mlt_tokeniser_count( tokens ); i ++ )
233 struct mlt_geometry_item_s item;
234 char *value = mlt_tokeniser_get_string( tokens, i );
237 memset( &item, 0, sizeof( struct mlt_geometry_item_s ) );
239 // Now parse the item
240 mlt_geometry_parse_item( this, &item, value );
242 // Now insert into place
243 mlt_geometry_insert( this, &item );
246 // Remove the tokeniser
247 mlt_tokeniser_close( tokens );
253 // Conditionally refresh in case of a change
254 int mlt_geometry_refresh( mlt_geometry this, char *data, int length, int nw, int nh )
256 geometry self = this->local;
257 int changed = ( length != -1 && length != self->length );
258 changed = changed || ( nw != -1 && nw != self->nw );
259 changed = changed || ( nh != -1 && nh != self->nh );
260 changed = changed || ( data != NULL && ( self->data == NULL || strcmp( data, self->data ) ) );
262 return mlt_geometry_parse( this, data, length, nw, nh );
266 int mlt_geometry_get_length( mlt_geometry this )
268 // Get the local/private structure
269 geometry self = this->local;
275 void mlt_geometry_set_length( mlt_geometry this, int length )
277 // Get the local/private structure
278 geometry self = this->local;
281 self->length = length;
284 int mlt_geometry_parse_item( mlt_geometry this, mlt_geometry_item item, char *value )
288 // Get the local/private structure
289 geometry self = this->local;
291 if ( value != NULL && strcmp( value, "" ) )
293 char *p = strchr( value, '=' );
297 // Determine if a position has been specified
300 temp = atof( value );
301 if ( temp > -1 && temp < 1 )
302 item->frame = temp * self->length;
308 // Special case - frame < 0
309 if ( item->frame < 0 )
310 item->frame += self->length;
312 // Obtain the current value at this position - this allows new
313 // frames to be created which don't specify all values
314 mlt_geometry_fetch( this, item, item->frame );
316 // Special case - when an empty string is specified, all values are fixed
317 // TODO: Check if this is logical - it's convenient, but it's also odd...
327 // Iterate through the remainder of value
331 temp = strtod( value, &p );
333 // Check if a value was specified
339 if ( count == 0 || count == 2 )
340 temp *= self->nw / 100.0;
341 else if ( count == 1 || count == 3 )
342 temp *= self->nh / 100.0;
346 // Special case - distort token
347 if ( *p == '!' || *p == '*' )
353 // Actually, we don't care about the delimiter at all..
356 // Assign to the item
359 case 0: item->x = temp; item->f[0] = 1; break;
360 case 1: item->y = temp; item->f[1] = 1; break;
361 case 2: item->w = temp; item->f[2] = 1; break;
362 case 3: item->h = temp; item->f[3] = 1; break;
363 case 4: item->mix = temp; item->f[4] = 1; break;
371 // Update the value pointer
384 // Fetch a geometry item for an absolute position
385 int mlt_geometry_fetch( mlt_geometry this, mlt_geometry_item item, float position )
387 // Get the local geometry
388 geometry self = this->local;
390 // Need to find the nearest key to the position specifed
391 geometry_item key = self->item;
393 // Iterate through the keys until we reach last or have
394 while( key != NULL && key->next != NULL && position >= key->next->data.frame )
399 // Position is situated before the first key - all zeroes
400 if ( position < key->data.frame )
402 memset( item, 0, sizeof( struct mlt_geometry_item_s ) );
405 // Position is a key itself - no iterpolation need
406 else if ( position == key->data.frame )
408 memcpy( item, &key->data, sizeof( struct mlt_geometry_item_s ) );
410 // Position is after the last key - no interpolation, but not a key frame
411 else if ( key->next == NULL )
413 memcpy( item, &key->data, sizeof( struct mlt_geometry_item_s ) );
421 // Interpolation is needed - position > key and there is a following key
425 item->frame = position;
426 position -= key->data.frame;
427 item->x = linearstep( key->data.x, key->next->data.x, position, key->next->data.frame - key->data.frame );
428 item->y = linearstep( key->data.y, key->next->data.y, position, key->next->data.frame - key->data.frame );
429 item->w = linearstep( key->data.w, key->next->data.w, position, key->next->data.frame - key->data.frame );
430 item->h = linearstep( key->data.h, key->next->data.h, position, key->next->data.frame - key->data.frame );
431 item->mix = linearstep( key->data.mix, key->next->data.mix, position, key->next->data.frame - key->data.frame );
432 item->distort = key->data.distort;
433 position += key->data.frame;
436 item->frame = position;
440 memset( item, 0, sizeof( struct mlt_geometry_item_s ) );
441 item->frame = position;
448 // Specify a geometry item at an absolute position
449 int mlt_geometry_insert( mlt_geometry this, mlt_geometry_item item )
451 // Get the local/private geometry structure
452 geometry self = this->local;
454 // Create a new local item (this may be removed if a key already exists at this position)
455 geometry_item new = calloc( 1, sizeof( struct geometry_item_s ) );
456 memcpy( &new->data, item, sizeof( struct mlt_geometry_item_s ) );
459 // Determine if we need to insert or append to the list, or if it's a new list
460 if ( self->item != NULL )
462 // Get the first item
463 geometry_item place = self->item;
465 // Locate an existing nearby item
466 while ( place->next != NULL && item->frame > place->data.frame )
469 if ( item->frame < place->data.frame )
471 if ( place == self->item )
474 place->prev->next = new;
476 new->prev = place->prev;
479 else if ( item->frame > place->data.frame )
482 place->next->prev = new;
483 new->next = place->next;
489 memcpy( &place->data, &new->data, sizeof( struct mlt_geometry_item_s ) );
495 // Set the first item
498 // To ensure correct seeding, ensure all values are fixed
499 self->item->data.f[0] = 1;
500 self->item->data.f[1] = 1;
501 self->item->data.f[2] = 1;
502 self->item->data.f[3] = 1;
503 self->item->data.f[4] = 1;
506 // Refresh all geometries
507 mlt_geometry_virtual_refresh( this );
509 // TODO: Error checking
513 // Remove the key at the specified position
514 int mlt_geometry_remove( mlt_geometry this, int position )
518 // Get the local/private geometry structure
519 geometry self = this->local;
521 // Get the first item
522 geometry_item place = self->item;
524 while( place != NULL && position != place->data.frame )
527 if ( place != NULL && position == place->data.frame )
528 ret = mlt_geometry_drop( this, place );
530 // Refresh all geometries
531 mlt_geometry_virtual_refresh( this );
536 // Get the key at the position or the next following
537 int mlt_geometry_next_key( mlt_geometry this, mlt_geometry_item item, int position )
539 // Get the local/private geometry structure
540 geometry self = this->local;
542 // Get the first item
543 geometry_item place = self->item;
545 while( place != NULL && position > place->data.frame )
549 memcpy( item, &place->data, sizeof( struct mlt_geometry_item_s ) );
551 return place == NULL;
554 // Get the key at the position or the previous key
555 int mlt_geometry_prev_key( mlt_geometry this, mlt_geometry_item item, int position )
557 // Get the local/private geometry structure
558 geometry self = this->local;
560 // Get the first item
561 geometry_item place = self->item;
563 while( place != NULL && place->next != NULL && position >= place->next->data.frame )
567 memcpy( item, &place->data, sizeof( struct mlt_geometry_item_s ) );
569 return place == NULL;
572 char *mlt_geometry_serialise_cut( mlt_geometry this, int in, int out )
574 geometry self = this->local;
575 struct mlt_geometry_item_s item;
576 char *ret = malloc( 1000 );
583 out = mlt_geometry_get_length( this );
597 // If it's the first frame, then it's not necessarily a key
598 if ( item.frame == in )
600 if ( mlt_geometry_fetch( this, &item, item.frame ) )
603 // If the first key is larger than the current position
604 // then do nothing here
605 if ( self->item->data.frame > item.frame )
611 // To ensure correct seeding, ensure all values are fixed
618 // Typically, we move from key to key
619 else if ( item.frame < out )
621 if ( mlt_geometry_next_key( this, &item, item.frame ) )
624 // Special case - crop at the out point
625 if ( item.frame > out )
626 mlt_geometry_fetch( this, &item, out );
628 // We've handled the last key
634 if ( item.frame - in != 0 )
635 sprintf( temp, "%d=", item.frame - in );
638 sprintf( temp + strlen( temp ), "%.0f", item.x );
641 sprintf( temp + strlen( temp ), "%.0f", item.y );
644 sprintf( temp + strlen( temp ), "%.0f", item.w );
647 sprintf( temp + strlen( temp ), "%.0f", item.h );
649 sprintf( temp + strlen( temp ), ":%.0f", item.mix );
651 if ( used + strlen( temp ) > size )
654 ret = realloc( ret, size );
657 if ( ret != NULL && used != 0 )
664 used += strlen( temp );
675 // Serialise the current geometry
676 char *mlt_geometry_serialise( mlt_geometry this )
678 geometry self = this->local;
679 char *ret = mlt_geometry_serialise_cut( this, 0, self->length );
688 // Close the geometry
689 void mlt_geometry_close( mlt_geometry this )
693 mlt_geometry_clean( this );