2 * mlt_tractor.c -- tractor service class
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates <charles.yates@pandora.be>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program 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
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include "mlt_tractor.h"
24 #include "mlt_frame.h"
25 #include "mlt_multitrack.h"
26 #include "mlt_field.h"
33 /** Forward references to static methods.
36 static int producer_get_frame( mlt_producer
this, mlt_frame_ptr frame
, int track
);
37 static void mlt_tractor_listener( mlt_multitrack tracks
, mlt_tractor
this );
39 /** Constructor for the tractor.
42 mlt_tractor
mlt_tractor_init( )
44 mlt_tractor
this = calloc( sizeof( struct mlt_tractor_s
), 1 );
47 mlt_producer producer
= &this->parent
;
48 if ( mlt_producer_init( producer
, this ) == 0 )
50 mlt_properties properties
= MLT_PRODUCER_PROPERTIES( producer
);
52 mlt_properties_set( properties
, "resource", "<tractor>" );
53 mlt_properties_set( properties
, "mlt_type", "mlt_producer" );
54 mlt_properties_set( properties
, "mlt_service", "tractor" );
55 mlt_properties_set_int( properties
, "in", 0 );
56 mlt_properties_set_int( properties
, "out", -1 );
57 mlt_properties_set_int( properties
, "length", 0 );
59 producer
->get_frame
= producer_get_frame
;
60 producer
->close
= ( mlt_destructor
)mlt_tractor_close
;
61 producer
->close_object
= this;
72 mlt_tractor
mlt_tractor_new( )
74 mlt_tractor
this = calloc( sizeof( struct mlt_tractor_s
), 1 );
77 mlt_producer producer
= &this->parent
;
78 if ( mlt_producer_init( producer
, this ) == 0 )
80 mlt_multitrack multitrack
= mlt_multitrack_init( );
81 mlt_field field
= mlt_field_new( multitrack
, this );
82 mlt_properties props
= MLT_PRODUCER_PROPERTIES( producer
);
84 mlt_properties_set( props
, "resource", "<tractor>" );
85 mlt_properties_set( props
, "mlt_type", "mlt_producer" );
86 mlt_properties_set( props
, "mlt_service", "tractor" );
87 mlt_properties_set_position( props
, "in", 0 );
88 mlt_properties_set_position( props
, "out", 0 );
89 mlt_properties_set_position( props
, "length", 0 );
90 mlt_properties_set_data( props
, "multitrack", multitrack
, 0, ( mlt_destructor
)mlt_multitrack_close
, NULL
);
91 mlt_properties_set_data( props
, "field", field
, 0, ( mlt_destructor
)mlt_field_close
, NULL
);
93 mlt_events_listen( MLT_MULTITRACK_PROPERTIES( multitrack
), this, "producer-changed", ( mlt_listener
)mlt_tractor_listener
);
95 producer
->get_frame
= producer_get_frame
;
96 producer
->close
= ( mlt_destructor
)mlt_tractor_close
;
97 producer
->close_object
= this;
108 /** Get the service object associated to the tractor.
111 mlt_service
mlt_tractor_service( mlt_tractor
this )
113 return MLT_PRODUCER_SERVICE( &this->parent
);
116 /** Get the producer object associated to the tractor.
119 mlt_producer
mlt_tractor_producer( mlt_tractor
this )
121 return this != NULL ?
&this->parent
: NULL
;
124 /** Get the properties object associated to the tractor.
127 mlt_properties
mlt_tractor_properties( mlt_tractor
this )
129 return MLT_PRODUCER_PROPERTIES( &this->parent
);
132 /** Get the field this tractor is harvesting.
135 mlt_field
mlt_tractor_field( mlt_tractor
this )
137 return mlt_properties_get_data( MLT_TRACTOR_PROPERTIES( this ), "field", NULL
);
140 /** Get the multitrack this tractor is pulling.
143 mlt_multitrack
mlt_tractor_multitrack( mlt_tractor
this )
145 return mlt_properties_get_data( MLT_TRACTOR_PROPERTIES( this ), "multitrack", NULL
);
148 /** Ensure the tractors in/out points match the multitrack.
151 void mlt_tractor_refresh( mlt_tractor
this )
153 mlt_multitrack multitrack
= mlt_tractor_multitrack( this );
154 mlt_properties properties
= MLT_MULTITRACK_PROPERTIES( multitrack
);
155 mlt_properties self
= MLT_TRACTOR_PROPERTIES( this );
156 mlt_events_block( properties
, self
);
157 mlt_events_block( self
, self
);
158 mlt_multitrack_refresh( multitrack
);
159 mlt_properties_set_position( self
, "in", 0 );
160 mlt_properties_set_position( self
, "out", mlt_properties_get_position( properties
, "out" ) );
161 mlt_events_unblock( self
, self
);
162 mlt_events_unblock( properties
, self
);
163 mlt_properties_set_position( self
, "length", mlt_properties_get_position( properties
, "length" ) );
166 static void mlt_tractor_listener( mlt_multitrack tracks
, mlt_tractor
this )
168 mlt_tractor_refresh( this );
171 /** Connect the tractor.
174 int mlt_tractor_connect( mlt_tractor
this, mlt_service producer
)
176 int ret
= mlt_service_connect_producer( MLT_TRACTOR_SERVICE( this ), producer
, 0 );
178 // This is the producer we're going to connect to
180 this->producer
= producer
;
185 /** Set the producer for a specific track.
188 int mlt_tractor_set_track( mlt_tractor
this, mlt_producer producer
, int index
)
190 return mlt_multitrack_connect( mlt_tractor_multitrack( this ), producer
, index
);
193 /** Get the producer for a specific track.
196 mlt_producer
mlt_tractor_get_track( mlt_tractor
this, int index
)
198 return mlt_multitrack_track( mlt_tractor_multitrack( this ), index
);
201 static int producer_get_image( mlt_frame
this, uint8_t **buffer
, mlt_image_format
*format
, int *width
, int *height
, int writable
)
203 uint8_t *data
= NULL
;
204 mlt_properties properties
= MLT_FRAME_PROPERTIES( this );
205 mlt_frame frame
= mlt_frame_pop_service( this );
206 mlt_properties frame_properties
= MLT_FRAME_PROPERTIES( frame
);
207 mlt_properties_set_int( frame_properties
, "width", mlt_properties_get_int( properties
, "width" ) );
208 mlt_properties_set_int( frame_properties
, "height", mlt_properties_get_int( properties
, "height" ) );
209 mlt_properties_set( frame_properties
, "rescale.interp", mlt_properties_get( properties
, "rescale.interp" ) );
210 mlt_properties_set_int( frame_properties
, "distort", mlt_properties_get_int( properties
, "distort" ) );
211 mlt_properties_set_double( frame_properties
, "consumer_aspect_ratio", mlt_properties_get_double( properties
, "consumer_aspect_ratio" ) );
212 mlt_properties_set_int( frame_properties
, "consumer_deinterlace", mlt_properties_get_double( properties
, "consumer_deinterlace" ) );
213 mlt_properties_set( frame_properties
, "deinterlace_method", mlt_properties_get( properties
, "deinterlace_method" ) );
214 mlt_properties_set_int( frame_properties
, "normalised_width", mlt_properties_get_double( properties
, "normalised_width" ) );
215 mlt_properties_set_int( frame_properties
, "normalised_height", mlt_properties_get_double( properties
, "normalised_height" ) );
216 mlt_frame_get_image( frame
, buffer
, format
, width
, height
, writable
);
217 mlt_properties_set_data( properties
, "image", *buffer
, *width
* *height
* 2, NULL
, NULL
);
218 mlt_properties_set_int( properties
, "width", *width
);
219 mlt_properties_set_int( properties
, "height", *height
);
220 mlt_properties_set_double( properties
, "aspect_ratio", mlt_frame_get_aspect_ratio( frame
) );
221 mlt_properties_set_int( properties
, "progressive", mlt_properties_get_int( frame_properties
, "progressive" ) );
222 mlt_properties_set_int( properties
, "distort", mlt_properties_get_int( frame_properties
, "distort" ) );
223 data
= mlt_frame_get_alpha_mask( frame
);
224 mlt_properties_set_data( properties
, "alpha", data
, 0, NULL
, NULL
);
228 static int producer_get_audio( mlt_frame
this, int16_t **buffer
, mlt_audio_format
*format
, int *frequency
, int *channels
, int *samples
)
230 mlt_properties properties
= MLT_FRAME_PROPERTIES( this );
231 mlt_frame frame
= mlt_frame_pop_audio( this );
232 mlt_frame_get_audio( frame
, buffer
, format
, frequency
, channels
, samples
);
233 mlt_properties_set_data( properties
, "audio", *buffer
, 0, NULL
, NULL
);
234 mlt_properties_set_int( properties
, "frequency", *frequency
);
235 mlt_properties_set_int( properties
, "channels", *channels
);
239 static void destroy_data_queue( void *arg
)
243 // Assign the correct type
244 mlt_deque queue
= arg
;
246 // Iterate through each item and destroy them
247 while ( mlt_deque_peek_front( queue
) != NULL
)
248 mlt_properties_close( mlt_deque_pop_back( queue
) );
251 mlt_deque_close( queue
);
255 /** Get the next frame.
257 TODO: This function needs to be redesigned...
260 static int producer_get_frame( mlt_producer parent
, mlt_frame_ptr frame
, int track
)
262 mlt_tractor
this = parent
->child
;
264 // We only respond to the first track requests
265 if ( track
== 0 && this->producer
!= NULL
)
269 mlt_frame temp
= NULL
;
272 // Get the properties of the parent producer
273 mlt_properties properties
= MLT_PRODUCER_PROPERTIES( parent
);
275 // Try to obtain the multitrack associated to the tractor
276 mlt_multitrack multitrack
= mlt_properties_get_data( properties
, "multitrack", NULL
);
278 // Or a specific producer
279 mlt_producer producer
= mlt_properties_get_data( properties
, "producer", NULL
);
281 // The output frame will hold the 'global' data feeds (ie: those which are targetted for the final frame)
282 mlt_deque data_queue
= mlt_deque_init( );
284 // Determine whether this tractor feeds to the consumer or stops here
285 int global_feed
= mlt_properties_get_int( properties
, "global_feed" );
287 // If we don't have one, we're in trouble...
288 if ( multitrack
!= NULL
)
290 // Used to garbage collect all frames
293 // Get the id of the tractor
294 char *id
= mlt_properties_get( properties
, "_unique_id" );
296 // Will be used to store the frame properties object
297 mlt_properties frame_properties
= NULL
;
299 // We'll store audio and video frames to use here
300 mlt_frame audio
= NULL
;
301 mlt_frame video
= NULL
;
303 // Temporary properties
304 mlt_properties temp_properties
= NULL
;
306 // Get the multitrack's producer
307 mlt_producer target
= MLT_MULTITRACK_PRODUCER( multitrack
);
308 mlt_producer_seek( target
, mlt_producer_frame( parent
) );
309 mlt_producer_set_speed( target
, mlt_producer_get_speed( parent
) );
311 // We will create one frame and attach everything to it
312 *frame
= mlt_frame_init( );
314 // Get the properties of the frame
315 frame_properties
= MLT_FRAME_PROPERTIES( *frame
);
317 // Loop through each of the tracks we're harvesting
318 for ( i
= 0; !done
; i
++ )
320 // Get a frame from the producer
321 mlt_service_get_frame( this->producer
, &temp
, i
);
323 // Get the temporary properties
324 temp_properties
= MLT_FRAME_PROPERTIES( temp
);
326 // Check for last track
327 done
= mlt_properties_get_int( temp_properties
, "last_track" );
329 // Handle fx only tracks
330 if ( mlt_properties_get_int( temp_properties
, "meta.fx_cut" ) )
332 mlt_properties copy
= video
== NULL ? frame_properties
: MLT_FRAME_PROPERTIES( video
);
335 for ( i
= 0; i
< mlt_properties_count( temp_properties
); i
++ )
337 char *name
= mlt_properties_get_name( temp_properties
, i
);
338 char *value
= mlt_properties_get_value( temp_properties
, i
);
339 // For animated filters
340 if ( isdigit( name
[ 0 ] ) && value
!= NULL
)
341 mlt_properties_set( copy
, name
, value
);
346 // Take all but the first placeholding producer and dump on to the image stack
347 void *p
= mlt_deque_pop_front( MLT_FRAME_IMAGE_STACK( temp
) );
348 while ( ( p
= mlt_deque_pop_front( MLT_FRAME_IMAGE_STACK( temp
) ) ) != NULL
)
349 mlt_deque_push_back( MLT_FRAME_IMAGE_STACK( video
), p
);
353 mlt_frame_push_service( *frame
, temp
);
354 mlt_frame_push_service( *frame
, producer_get_image
);
355 mlt_properties_set_int( frame_properties
, "meta.fx_cut", 1 );
360 // Take all but the first placeholding producer and dump on to the audio stack
361 void *p
= !mlt_frame_is_test_audio( temp
) ?
mlt_deque_pop_front( MLT_FRAME_AUDIO_STACK( temp
) ) : NULL
;
362 while ( ( p
= mlt_deque_pop_front( MLT_FRAME_AUDIO_STACK( temp
) ) ) != NULL
)
363 mlt_deque_push_back( MLT_FRAME_AUDIO_STACK( audio
), p
);
367 mlt_frame_push_audio( *frame
, temp
);
368 mlt_frame_push_audio( *frame
, producer_get_audio
);
369 mlt_properties_set_int( frame_properties
, "meta.fx_cut", 1 );
372 // Ensure everything is hidden
373 mlt_properties_set_int( temp_properties
, "hide", 3 );
376 // We store all frames with a destructor on the output frame
377 sprintf( label
, "_%s_%d", id
, count
++ );
378 mlt_properties_set_data( frame_properties
, label
, temp
, 0, ( mlt_destructor
)mlt_frame_close
, NULL
);
380 // We want to append all 'final' feeds to the global queue
381 if ( !done
&& mlt_properties_get_data( temp_properties
, "data_queue", NULL
) != NULL
)
383 // Move the contents of this queue on to the output frames data queue
384 mlt_deque sub_queue
= mlt_properties_get_data( MLT_FRAME_PROPERTIES( temp
), "data_queue", NULL
);
385 mlt_deque temp
= mlt_deque_init( );
386 while ( global_feed
&& mlt_deque_count( sub_queue
) )
388 mlt_properties p
= mlt_deque_pop_back( sub_queue
);
389 if ( mlt_properties_get_int( p
, "final" ) )
390 mlt_deque_push_back( data_queue
, p
);
392 mlt_deque_push_back( temp
, p
);
394 while( mlt_deque_count( temp
) )
395 mlt_deque_push_front( sub_queue
, mlt_deque_pop_back( temp
) );
396 mlt_deque_close( temp
);
399 // Now do the same with the global queue but without the conditional behaviour
400 if ( mlt_properties_get_data( temp_properties
, "global_queue", NULL
) != NULL
)
402 mlt_deque sub_queue
= mlt_properties_get_data( MLT_FRAME_PROPERTIES( temp
), "global_queue", NULL
);
403 while ( mlt_deque_count( sub_queue
) )
405 mlt_properties p
= mlt_deque_pop_back( sub_queue
);
406 mlt_deque_push_back( data_queue
, p
);
410 // Pick up first video and audio frames
411 if ( !done
&& !mlt_frame_is_test_audio( temp
) && !( mlt_properties_get_int( temp_properties
, "hide" ) & 2 ) )
413 // Order of frame creation is starting to get problematic
416 mlt_deque_push_front( MLT_FRAME_AUDIO_STACK( temp
), producer_get_audio
);
417 mlt_deque_push_front( MLT_FRAME_AUDIO_STACK( temp
), audio
);
421 if ( !done
&& !mlt_frame_is_test_card( temp
) && !( mlt_properties_get_int( temp_properties
, "hide" ) & 1 ) )
425 mlt_deque_push_front( MLT_FRAME_IMAGE_STACK( temp
), producer_get_image
);
426 mlt_deque_push_front( MLT_FRAME_IMAGE_STACK( temp
), video
);
432 // Now stack callbacks
435 mlt_frame_push_audio( *frame
, audio
);
436 mlt_frame_push_audio( *frame
, producer_get_audio
);
441 mlt_properties video_properties
= MLT_FRAME_PROPERTIES( video
);
442 mlt_frame_push_service( *frame
, video
);
443 mlt_frame_push_service( *frame
, producer_get_image
);
445 mlt_properties_set_data( frame_properties
, "data_queue", data_queue
, 0, NULL
, NULL
);
446 mlt_properties_set_data( video_properties
, "global_queue", data_queue
, 0, destroy_data_queue
, NULL
);
447 mlt_properties_set_int( frame_properties
, "width", mlt_properties_get_int( video_properties
, "width" ) );
448 mlt_properties_set_int( frame_properties
, "height", mlt_properties_get_int( video_properties
, "height" ) );
449 mlt_properties_set_int( frame_properties
, "real_width", mlt_properties_get_int( video_properties
, "real_width" ) );
450 mlt_properties_set_int( frame_properties
, "real_height", mlt_properties_get_int( video_properties
, "real_height" ) );
451 mlt_properties_set_int( frame_properties
, "progressive", mlt_properties_get_int( video_properties
, "progressive" ) );
452 mlt_properties_set_double( frame_properties
, "aspect_ratio", mlt_properties_get_double( video_properties
, "aspect_ratio" ) );
456 destroy_data_queue( data_queue
);
459 mlt_frame_set_position( *frame
, mlt_producer_frame( parent
) );
460 mlt_properties_set_int( MLT_FRAME_PROPERTIES( *frame
), "test_audio", audio
== NULL
);
461 mlt_properties_set_int( MLT_FRAME_PROPERTIES( *frame
), "test_image", video
== NULL
);
462 mlt_properties_set_data( MLT_FRAME_PROPERTIES( *frame
), "consumer_lock_service", this, 0, NULL
, NULL
);
464 else if ( producer
!= NULL
)
466 mlt_producer_seek( producer
, mlt_producer_frame( parent
) );
467 mlt_producer_set_speed( producer
, mlt_producer_get_speed( parent
) );
468 mlt_service_get_frame( this->producer
, frame
, track
);
472 fprintf( stderr
, "tractor without a multitrack!!\n" );
473 mlt_service_get_frame( this->producer
, frame
, track
);
476 // Prepare the next frame
477 mlt_producer_prepare_next( parent
);
479 // Indicate our found status
484 // Generate a test card
485 *frame
= mlt_frame_init( );
490 /** Close the tractor.
493 void mlt_tractor_close( mlt_tractor
this )
495 if ( this != NULL
&& mlt_properties_dec_ref( MLT_TRACTOR_PROPERTIES( this ) ) <= 0 )
497 this->parent
.close
= NULL
;
498 mlt_producer_close( &this->parent
);