]> git.sesse.net Git - mlt/blob - src/framework/mlt_tractor.c
src/framework/mlt_consumer.c
[mlt] / src / framework / mlt_tractor.c
1 /*
2  * mlt_tractor.c -- tractor service class
3  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4  * Author: Charles Yates <charles.yates@pandora.be>
5  *
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.
10  *
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.
15  *
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.
19  */
20
21 #include "config.h"
22
23 #include "mlt_tractor.h"
24 #include "mlt_frame.h"
25 #include "mlt_multitrack.h"
26 #include "mlt_field.h"
27
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <string.h>
31 #include <ctype.h>
32
33 /** Forward references to static methods.
34 */
35
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 );
38
39 /** Constructor for the tractor.
40 */
41
42 mlt_tractor mlt_tractor_init( )
43 {
44         mlt_tractor this = calloc( sizeof( struct mlt_tractor_s ), 1 );
45         if ( this != NULL )
46         {
47                 mlt_producer producer = &this->parent;
48                 if ( mlt_producer_init( producer, this ) == 0 )
49                 {
50                         mlt_properties properties = MLT_PRODUCER_PROPERTIES( producer );
51
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 );
58
59                         producer->get_frame = producer_get_frame;
60                         producer->close = ( mlt_destructor )mlt_tractor_close;
61                         producer->close_object = this;
62                 }
63                 else
64                 {
65                         free( this );
66                         this = NULL;
67                 }
68         }
69         return this;
70 }
71
72 mlt_tractor mlt_tractor_new( )
73 {
74         mlt_tractor this = calloc( sizeof( struct mlt_tractor_s ), 1 );
75         if ( this != NULL )
76         {
77                 mlt_producer producer = &this->parent;
78                 if ( mlt_producer_init( producer, this ) == 0 )
79                 {
80                         mlt_multitrack multitrack = mlt_multitrack_init( );
81                         mlt_field field = mlt_field_new( multitrack, this );
82                         mlt_properties props = MLT_PRODUCER_PROPERTIES( producer );
83
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 );
92
93                         mlt_events_listen( MLT_MULTITRACK_PROPERTIES( multitrack ), this, "producer-changed", ( mlt_listener )mlt_tractor_listener );
94
95                         producer->get_frame = producer_get_frame;
96                         producer->close = ( mlt_destructor )mlt_tractor_close;
97                         producer->close_object = this;
98                 }
99                 else
100                 {
101                         free( this );
102                         this = NULL;
103                 }
104         }
105         return this;
106 }
107
108 /** Get the service object associated to the tractor.
109 */
110
111 mlt_service mlt_tractor_service( mlt_tractor this )
112 {
113         return MLT_PRODUCER_SERVICE( &this->parent );
114 }
115
116 /** Get the producer object associated to the tractor.
117 */
118
119 mlt_producer mlt_tractor_producer( mlt_tractor this )
120 {
121         return this != NULL ? &this->parent : NULL;
122 }
123
124 /** Get the properties object associated to the tractor.
125 */
126
127 mlt_properties mlt_tractor_properties( mlt_tractor this )
128 {
129         return MLT_PRODUCER_PROPERTIES( &this->parent );
130 }
131
132 /** Get the field this tractor is harvesting.
133 */
134
135 mlt_field mlt_tractor_field( mlt_tractor this )
136 {
137         return mlt_properties_get_data( MLT_TRACTOR_PROPERTIES( this ), "field", NULL );
138 }
139
140 /** Get the multitrack this tractor is pulling.
141 */
142
143 mlt_multitrack mlt_tractor_multitrack( mlt_tractor this )
144 {
145         return mlt_properties_get_data( MLT_TRACTOR_PROPERTIES( this ), "multitrack", NULL );
146 }
147
148 /** Ensure the tractors in/out points match the multitrack.
149 */
150
151 void mlt_tractor_refresh( mlt_tractor this )
152 {
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" ) );
164 }
165
166 static void mlt_tractor_listener( mlt_multitrack tracks, mlt_tractor this )
167 {
168         mlt_tractor_refresh( this );
169 }
170
171 /** Connect the tractor.
172 */
173
174 int mlt_tractor_connect( mlt_tractor this, mlt_service producer )
175 {
176         int ret = mlt_service_connect_producer( MLT_TRACTOR_SERVICE( this ), producer, 0 );
177
178         // This is the producer we're going to connect to
179         if ( ret == 0 )
180                 this->producer = producer;
181
182         return ret;
183 }
184
185 /** Set the producer for a specific track.
186 */
187
188 int mlt_tractor_set_track( mlt_tractor this, mlt_producer producer, int index )
189 {
190         return mlt_multitrack_connect( mlt_tractor_multitrack( this ), producer, index );
191 }
192
193 /** Get the producer for a specific track.
194 */
195
196 mlt_producer mlt_tractor_get_track( mlt_tractor this, int index )
197 {
198         return mlt_multitrack_track( mlt_tractor_multitrack( this ), index );
199 }
200
201 static int producer_get_image( mlt_frame this, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable )
202 {
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( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale.interp" ) );
208         mlt_properties_set_int( frame_properties, "distort", mlt_properties_get_int( properties, "distort" ) );
209         mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "consumer_aspect_ratio" ) );
210         mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_int( properties, "consumer_deinterlace" ) );
211         mlt_properties_set( frame_properties, "deinterlace_method", mlt_properties_get( properties, "deinterlace_method" ) );
212         mlt_properties_set_int( frame_properties, "normalised_width", mlt_properties_get_int( properties, "normalised_width" ) );
213         mlt_properties_set_int( frame_properties, "normalised_height", mlt_properties_get_int( properties, "normalised_height" ) );
214         mlt_frame_get_image( frame, buffer, format, width, height, writable );
215         mlt_properties_set_data( properties, "image", *buffer, *width * *height * 2, NULL, NULL );
216         mlt_properties_set_int( properties, "width", *width );
217         mlt_properties_set_int( properties, "height", *height );
218         mlt_properties_set_int( properties, "format", *format );
219         mlt_properties_set_double( properties, "aspect_ratio", mlt_frame_get_aspect_ratio( frame ) );
220         mlt_properties_set_int( properties, "progressive", mlt_properties_get_int( frame_properties, "progressive" ) );
221         mlt_properties_set_int( properties, "distort", mlt_properties_get_int( frame_properties, "distort" ) );
222         data = mlt_frame_get_alpha_mask( frame );
223         mlt_properties_set_data( properties, "alpha", data, 0, NULL, NULL );
224         return 0;
225 }
226
227 static int producer_get_audio( mlt_frame this, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples )
228 {
229         mlt_properties properties = MLT_FRAME_PROPERTIES( this );
230         mlt_frame frame = mlt_frame_pop_audio( this );
231         mlt_frame_get_audio( frame, buffer, format, frequency, channels, samples );
232         mlt_properties_set_data( properties, "audio", *buffer, 0, NULL, NULL );
233         mlt_properties_set_int( properties, "frequency", *frequency );
234         mlt_properties_set_int( properties, "channels", *channels );
235         return 0;
236 }
237
238 static void destroy_data_queue( void *arg )
239 {
240         if ( arg != NULL )
241         {
242                 // Assign the correct type
243                 mlt_deque queue = arg;
244
245                 // Iterate through each item and destroy them
246                 while ( mlt_deque_peek_front( queue ) != NULL )
247                         mlt_properties_close( mlt_deque_pop_back( queue ) );
248
249                 // Close the deque
250                 mlt_deque_close( queue );
251         }
252 }
253
254 /** Get the next frame.
255
256         TODO: This function needs to be redesigned...
257 */
258
259 static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int track )
260 {
261         mlt_tractor this = parent->child;
262
263         // We only respond to the first track requests
264         if ( track == 0 && this->producer != NULL )
265         {
266                 int i = 0;
267                 int done = 0;
268                 mlt_frame temp = NULL;
269                 int count = 0;
270                 int image_count = 0;
271
272                 // Get the properties of the parent producer
273                 mlt_properties properties = MLT_PRODUCER_PROPERTIES( parent );
274
275                 // Try to obtain the multitrack associated to the tractor
276                 mlt_multitrack multitrack = mlt_properties_get_data( properties, "multitrack", NULL );
277
278                 // Or a specific producer
279                 mlt_producer producer = mlt_properties_get_data( properties, "producer", NULL );
280
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( );
283
284                 // Determine whether this tractor feeds to the consumer or stops here
285                 int global_feed = mlt_properties_get_int( properties, "global_feed" );
286
287                 // If we don't have one, we're in trouble... 
288                 if ( multitrack != NULL )
289                 {
290                         // Used to garbage collect all frames
291                         char label[ 30 ];
292
293                         // Get the id of the tractor
294                         char *id = mlt_properties_get( properties, "_unique_id" );
295
296                         // Will be used to store the frame properties object
297                         mlt_properties frame_properties = NULL;
298
299                         // We'll store audio and video frames to use here
300                         mlt_frame audio = NULL;
301                         mlt_frame video = NULL;
302                         mlt_frame first_video = NULL;
303
304                         // Temporary properties
305                         mlt_properties temp_properties = NULL;
306
307                         // Get the multitrack's producer
308                         mlt_producer target = MLT_MULTITRACK_PRODUCER( multitrack );
309                         mlt_producer_seek( target, mlt_producer_frame( parent ) );
310                         mlt_producer_set_speed( target, mlt_producer_get_speed( parent ) );
311
312                         // We will create one frame and attach everything to it
313                         *frame = mlt_frame_init( );
314
315                         // Get the properties of the frame
316                         frame_properties = MLT_FRAME_PROPERTIES( *frame );
317
318                         // Loop through each of the tracks we're harvesting
319                         for ( i = 0; !done; i ++ )
320                         {
321                                 // Get a frame from the producer
322                                 mlt_service_get_frame( this->producer, &temp, i );
323
324                                 // Get the temporary properties
325                                 temp_properties = MLT_FRAME_PROPERTIES( temp );
326
327                                 // Check for last track
328                                 done = mlt_properties_get_int( temp_properties, "last_track" );
329
330                                 // Handle fx only tracks
331                                 if ( mlt_properties_get_int( temp_properties, "fx_cut" ) )
332                                 {
333                                         int hide = ( video == NULL ? 1 : 0 ) | ( audio == NULL ? 2 : 0 );
334                                         mlt_properties_set_int( temp_properties, "hide", hide );
335                                 }
336
337                                 // We store all frames with a destructor on the output frame
338                                 sprintf( label, "_%s_%d", id, count ++ );
339                                 mlt_properties_set_data( frame_properties, label, temp, 0, ( mlt_destructor )mlt_frame_close, NULL );
340
341                                 // We want to append all 'final' feeds to the global queue
342                                 if ( !done && mlt_properties_get_data( temp_properties, "data_queue", NULL ) != NULL )
343                                 {
344                                         // Move the contents of this queue on to the output frames data queue
345                                         mlt_deque sub_queue = mlt_properties_get_data( MLT_FRAME_PROPERTIES( temp ), "data_queue", NULL );
346                                         mlt_deque temp = mlt_deque_init( );
347                                         while ( global_feed && mlt_deque_count( sub_queue ) )
348                                         {
349                                                 mlt_properties p = mlt_deque_pop_back( sub_queue );
350                                                 if ( mlt_properties_get_int( p, "final" ) )
351                                                         mlt_deque_push_back( data_queue, p );
352                                                 else
353                                                         mlt_deque_push_back( temp, p );
354                                         }
355                                         while( mlt_deque_count( temp ) )
356                                                 mlt_deque_push_front( sub_queue, mlt_deque_pop_back( temp ) );
357                                         mlt_deque_close( temp );
358                                 }
359
360                                 // Now do the same with the global queue but without the conditional behaviour
361                                 if ( mlt_properties_get_data( temp_properties, "global_queue", NULL ) != NULL )
362                                 {
363                                         mlt_deque sub_queue = mlt_properties_get_data( MLT_FRAME_PROPERTIES( temp ), "global_queue", NULL );
364                                         while ( mlt_deque_count( sub_queue ) )
365                                         {
366                                                 mlt_properties p = mlt_deque_pop_back( sub_queue );
367                                                 mlt_deque_push_back( data_queue, p );
368                                         }
369                                 }
370
371                                 // Pick up first video and audio frames
372                                 if ( !done && !mlt_frame_is_test_audio( temp ) && !( mlt_properties_get_int( temp_properties, "hide" ) & 2 ) )
373                                 {
374                                         // Order of frame creation is starting to get problematic
375                                         if ( audio != NULL )
376                                         {
377                                                 mlt_deque_push_front( MLT_FRAME_AUDIO_STACK( temp ), producer_get_audio );
378                                                 mlt_deque_push_front( MLT_FRAME_AUDIO_STACK( temp ), audio );
379                                         }
380                                         audio = temp;
381                                 }
382                                 if ( !done && !mlt_frame_is_test_card( temp ) && !( mlt_properties_get_int( temp_properties, "hide" ) & 1 ) )
383                                 {
384                                         if ( video != NULL )
385                                         {
386                                                 mlt_deque_push_front( MLT_FRAME_IMAGE_STACK( temp ), producer_get_image );
387                                                 mlt_deque_push_front( MLT_FRAME_IMAGE_STACK( temp ), video );
388                                         }
389                                         video = temp;
390                                         if ( first_video == NULL )
391                                                 first_video = temp;
392                                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( temp ), "image_count", ++ image_count );
393                                         image_count = 1;
394                                 }
395                         }
396         
397                         // Now stack callbacks
398                         if ( audio != NULL )
399                         {
400                                 mlt_frame_push_audio( *frame, audio );
401                                 mlt_frame_push_audio( *frame, producer_get_audio );
402                         }
403
404                         if ( video != NULL )
405                         {
406                                 mlt_properties video_properties = MLT_FRAME_PROPERTIES( first_video );
407                                 mlt_frame_push_service( *frame, video );
408                                 mlt_frame_push_service( *frame, producer_get_image );
409                                 if ( global_feed )
410                                         mlt_properties_set_data( frame_properties, "data_queue", data_queue, 0, NULL, NULL );
411                                 mlt_properties_set_data( video_properties, "global_queue", data_queue, 0, destroy_data_queue, NULL );
412                                 mlt_properties_set_int( frame_properties, "width", mlt_properties_get_int( video_properties, "width" ) );
413                                 mlt_properties_set_int( frame_properties, "height", mlt_properties_get_int( video_properties, "height" ) );
414                                 mlt_properties_set_int( frame_properties, "real_width", mlt_properties_get_int( video_properties, "real_width" ) );
415                                 mlt_properties_set_int( frame_properties, "real_height", mlt_properties_get_int( video_properties, "real_height" ) );
416                                 mlt_properties_set_int( frame_properties, "progressive", mlt_properties_get_int( video_properties, "progressive" ) );
417                                 mlt_properties_set_double( frame_properties, "aspect_ratio", mlt_properties_get_double( video_properties, "aspect_ratio" ) );
418                                 mlt_properties_set_int( frame_properties, "image_count", image_count );
419                         }
420                         else
421                         {
422                                 destroy_data_queue( data_queue );
423                         }
424
425                         mlt_frame_set_position( *frame, mlt_producer_frame( parent ) );
426                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( *frame ), "test_audio", audio == NULL );
427                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( *frame ), "test_image", video == NULL );
428                         mlt_properties_set_data( MLT_FRAME_PROPERTIES( *frame ), "consumer_lock_service", this, 0, NULL, NULL );
429                 }
430                 else if ( producer != NULL )
431                 {
432                         mlt_producer_seek( producer, mlt_producer_frame( parent ) );
433                         mlt_producer_set_speed( producer, mlt_producer_get_speed( parent ) );
434                         mlt_service_get_frame( this->producer, frame, track );
435                 }
436                 else
437                 {
438                         fprintf( stderr, "tractor without a multitrack!!\n" );
439                         mlt_service_get_frame( this->producer, frame, track );
440                 }
441
442                 // Prepare the next frame
443                 mlt_producer_prepare_next( parent );
444
445                 // Indicate our found status
446                 return 0;
447         }
448         else
449         {
450                 // Generate a test card
451                 *frame = mlt_frame_init( );
452                 return 0;
453         }
454 }
455
456 /** Close the tractor.
457 */
458
459 void mlt_tractor_close( mlt_tractor this )
460 {
461         if ( this != NULL && mlt_properties_dec_ref( MLT_TRACTOR_PROPERTIES( this ) ) <= 0 )
462         {
463                 this->parent.close = NULL;
464                 mlt_producer_close( &this->parent );
465                 free( this );
466         }
467 }
468