Option to hold feed processing on a track
[melted] / 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
32 /** Forward references to static methods.
33 */
34
35 static int producer_get_frame( mlt_producer this, mlt_frame_ptr frame, int track );
36 static void mlt_tractor_listener( mlt_multitrack tracks, mlt_tractor this );
37
38 /** Constructor for the tractor.
39 */
40
41 mlt_tractor mlt_tractor_init( )
42 {
43 mlt_tractor this = calloc( sizeof( struct mlt_tractor_s ), 1 );
44 if ( this != NULL )
45 {
46 mlt_producer producer = &this->parent;
47 if ( mlt_producer_init( producer, this ) == 0 )
48 {
49 mlt_properties properties = MLT_PRODUCER_PROPERTIES( producer );
50
51 mlt_properties_set( properties, "resource", "<tractor>" );
52 mlt_properties_set( properties, "mlt_type", "mlt_producer" );
53 mlt_properties_set( properties, "mlt_service", "tractor" );
54 mlt_properties_set_int( properties, "in", 0 );
55 mlt_properties_set_int( properties, "out", -1 );
56 mlt_properties_set_int( properties, "length", 0 );
57
58 producer->get_frame = producer_get_frame;
59 producer->close = ( mlt_destructor )mlt_tractor_close;
60 producer->close_object = this;
61 }
62 else
63 {
64 free( this );
65 this = NULL;
66 }
67 }
68 return this;
69 }
70
71 mlt_tractor mlt_tractor_new( )
72 {
73 mlt_tractor this = calloc( sizeof( struct mlt_tractor_s ), 1 );
74 if ( this != NULL )
75 {
76 mlt_producer producer = &this->parent;
77 if ( mlt_producer_init( producer, this ) == 0 )
78 {
79 mlt_multitrack multitrack = mlt_multitrack_init( );
80 mlt_field field = mlt_field_new( multitrack, this );
81 mlt_properties props = MLT_PRODUCER_PROPERTIES( producer );
82
83 mlt_properties_set( props, "resource", "<tractor>" );
84 mlt_properties_set( props, "mlt_type", "mlt_producer" );
85 mlt_properties_set( props, "mlt_service", "tractor" );
86 mlt_properties_set_position( props, "in", 0 );
87 mlt_properties_set_position( props, "out", 0 );
88 mlt_properties_set_position( props, "length", 0 );
89 mlt_properties_set_data( props, "multitrack", multitrack, 0, ( mlt_destructor )mlt_multitrack_close, NULL );
90 mlt_properties_set_data( props, "field", field, 0, ( mlt_destructor )mlt_field_close, NULL );
91
92 mlt_events_listen( MLT_MULTITRACK_PROPERTIES( multitrack ), this, "producer-changed", ( mlt_listener )mlt_tractor_listener );
93
94 producer->get_frame = producer_get_frame;
95 producer->close = ( mlt_destructor )mlt_tractor_close;
96 producer->close_object = this;
97 }
98 else
99 {
100 free( this );
101 this = NULL;
102 }
103 }
104 return this;
105 }
106
107 /** Get the service object associated to the tractor.
108 */
109
110 mlt_service mlt_tractor_service( mlt_tractor this )
111 {
112 return MLT_PRODUCER_SERVICE( &this->parent );
113 }
114
115 /** Get the producer object associated to the tractor.
116 */
117
118 mlt_producer mlt_tractor_producer( mlt_tractor this )
119 {
120 return this != NULL ? &this->parent : NULL;
121 }
122
123 /** Get the properties object associated to the tractor.
124 */
125
126 mlt_properties mlt_tractor_properties( mlt_tractor this )
127 {
128 return MLT_PRODUCER_PROPERTIES( &this->parent );
129 }
130
131 /** Get the field this tractor is harvesting.
132 */
133
134 mlt_field mlt_tractor_field( mlt_tractor this )
135 {
136 return mlt_properties_get_data( MLT_TRACTOR_PROPERTIES( this ), "field", NULL );
137 }
138
139 /** Get the multitrack this tractor is pulling.
140 */
141
142 mlt_multitrack mlt_tractor_multitrack( mlt_tractor this )
143 {
144 return mlt_properties_get_data( MLT_TRACTOR_PROPERTIES( this ), "multitrack", NULL );
145 }
146
147 /** Ensure the tractors in/out points match the multitrack.
148 */
149
150 void mlt_tractor_refresh( mlt_tractor this )
151 {
152 mlt_multitrack multitrack = mlt_tractor_multitrack( this );
153 mlt_properties properties = MLT_MULTITRACK_PROPERTIES( multitrack );
154 mlt_properties self = MLT_TRACTOR_PROPERTIES( this );
155 mlt_events_block( properties, self );
156 mlt_events_block( self, self );
157 mlt_multitrack_refresh( multitrack );
158 mlt_properties_set_position( self, "in", 0 );
159 mlt_properties_set_position( self, "out", mlt_properties_get_position( properties, "out" ) );
160 mlt_events_unblock( self, self );
161 mlt_events_unblock( properties, self );
162 mlt_properties_set_position( self, "length", mlt_properties_get_position( properties, "length" ) );
163 }
164
165 static void mlt_tractor_listener( mlt_multitrack tracks, mlt_tractor this )
166 {
167 mlt_tractor_refresh( this );
168 }
169
170 /** Connect the tractor.
171 */
172
173 int mlt_tractor_connect( mlt_tractor this, mlt_service producer )
174 {
175 int ret = mlt_service_connect_producer( MLT_TRACTOR_SERVICE( this ), producer, 0 );
176
177 // This is the producer we're going to connect to
178 if ( ret == 0 )
179 this->producer = producer;
180
181 return ret;
182 }
183
184 /** Set the producer for a specific track.
185 */
186
187 int mlt_tractor_set_track( mlt_tractor this, mlt_producer producer, int index )
188 {
189 return mlt_multitrack_connect( mlt_tractor_multitrack( this ), producer, index );
190 }
191
192 /** Get the producer for a specific track.
193 */
194
195 mlt_producer mlt_tractor_get_track( mlt_tractor this, int index )
196 {
197 return mlt_multitrack_track( mlt_tractor_multitrack( this ), index );
198 }
199
200 static int producer_get_image( mlt_frame this, uint8_t **buffer, mlt_image_format *format, int *width, int *height, int writable )
201 {
202 uint8_t *data = NULL;
203 mlt_properties properties = MLT_FRAME_PROPERTIES( this );
204 mlt_frame frame = mlt_frame_pop_service( this );
205 mlt_properties frame_properties = MLT_FRAME_PROPERTIES( frame );
206 mlt_properties_set_int( frame_properties, "width", mlt_properties_get_int( properties, "width" ) );
207 mlt_properties_set_int( frame_properties, "height", mlt_properties_get_int( properties, "height" ) );
208 mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale.interp" ) );
209 mlt_properties_set_int( frame_properties, "distort", mlt_properties_get_int( properties, "distort" ) );
210 mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "consumer_aspect_ratio" ) );
211 mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_double( properties, "consumer_deinterlace" ) );
212 mlt_properties_set_int( frame_properties, "normalised_width", mlt_properties_get_double( properties, "normalised_width" ) );
213 mlt_properties_set_int( frame_properties, "normalised_height", mlt_properties_get_double( 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_double( properties, "aspect_ratio", mlt_frame_get_aspect_ratio( frame ) );
219 mlt_properties_set_int( properties, "progressive", mlt_properties_get_int( frame_properties, "progressive" ) );
220 mlt_properties_set_int( properties, "distort", mlt_properties_get_int( frame_properties, "distort" ) );
221 data = mlt_frame_get_alpha_mask( frame );
222 mlt_properties_set_data( properties, "alpha", data, 0, NULL, NULL );
223 return 0;
224 }
225
226 static int producer_get_audio( mlt_frame this, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples )
227 {
228 mlt_properties properties = MLT_FRAME_PROPERTIES( this );
229 mlt_frame frame = mlt_frame_pop_audio( this );
230 mlt_frame_get_audio( frame, buffer, format, frequency, channels, samples );
231 mlt_properties_set_data( properties, "audio", *buffer, 0, NULL, NULL );
232 mlt_properties_set_int( properties, "frequency", *frequency );
233 mlt_properties_set_int( properties, "channels", *channels );
234 return 0;
235 }
236
237 /** Get the next frame.
238 */
239
240 static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int track )
241 {
242 mlt_tractor this = parent->child;
243
244 // We only respond to the first track requests
245 if ( track == 0 && this->producer != NULL )
246 {
247 int i = 0;
248 int done = 0;
249 mlt_frame temp = NULL;
250 int count = 0;
251
252 // Get the properties of the parent producer
253 mlt_properties properties = MLT_PRODUCER_PROPERTIES( parent );
254
255 // Try to obtain the multitrack associated to the tractor
256 mlt_multitrack multitrack = mlt_properties_get_data( properties, "multitrack", NULL );
257
258 // Or a specific producer
259 mlt_producer producer = mlt_properties_get_data( properties, "producer", NULL );
260
261 // If we don't have one, we're in trouble...
262 if ( multitrack != NULL )
263 {
264 // Used to garbage collect all frames
265 char label[ 30 ];
266
267 // Get the id of the tractor
268 char *id = mlt_properties_get( properties, "_unique_id" );
269
270 // Will be used to store the frame properties object
271 mlt_properties frame_properties = NULL;
272
273 // We'll store audio and video frames to use here
274 mlt_frame audio = NULL;
275 mlt_frame video = NULL;
276
277 // Determine which data_queue to pass on...
278 void *data_queue = NULL;
279
280 // Temporary properties
281 mlt_properties temp_properties = NULL;
282
283 // Get the multitrack's producer
284 mlt_producer target = MLT_MULTITRACK_PRODUCER( multitrack );
285 mlt_producer_seek( target, mlt_producer_frame( parent ) );
286 mlt_producer_set_speed( target, mlt_producer_get_speed( parent ) );
287
288 // We will create one frame and attach everything to it
289 *frame = mlt_frame_init( );
290
291 // Get the properties of the frame
292 frame_properties = MLT_FRAME_PROPERTIES( *frame );
293
294 // Loop through each of the tracks we're harvesting
295 for ( i = 0; !done; i ++ )
296 {
297 // Get a frame from the producer
298 mlt_service_get_frame( this->producer, &temp, i );
299
300 // Get the temporary properties
301 temp_properties = MLT_FRAME_PROPERTIES( temp );
302
303 // Check for last track
304 done = mlt_properties_get_int( temp_properties, "last_track" );
305
306 // We store all frames with a destructor on the output frame
307 sprintf( label, "_%s_%d", id, count ++ );
308 mlt_properties_set_data( frame_properties, label, temp, 0, ( mlt_destructor )mlt_frame_close, NULL );
309
310 // We want the first data_queue, but after that, all queues are appended
311 if ( !done && mlt_properties_get_data( temp_properties, "data_queue", NULL ) != NULL &&
312 mlt_deque_count( mlt_properties_get_data( temp_properties, "data_queue", NULL ) ) != 0 )
313 {
314 if ( data_queue == NULL )
315 {
316 data_queue = mlt_properties_get_data( MLT_FRAME_PROPERTIES( temp ), "data_queue", NULL );
317 }
318 else
319 {
320 // Move the contents of this queue on to the output frames data queue
321 mlt_deque sub_queue = mlt_properties_get_data( MLT_FRAME_PROPERTIES( temp ), "data_queue", NULL );
322 mlt_deque temp = mlt_deque_init( );
323 while ( mlt_deque_count( sub_queue ) )
324 {
325 mlt_properties p = mlt_deque_pop_back( sub_queue );
326 if ( mlt_properties_get_int( p, "frame_lock" ) == 0 )
327 mlt_deque_push_back( data_queue, p );
328 else
329 mlt_deque_push_back( temp, p );
330 }
331 while( mlt_deque_count( temp ) )
332 mlt_deque_push_front( sub_queue, mlt_deque_pop_back( temp ) );
333 mlt_deque_close( temp );
334 }
335 }
336
337 // Pick up first video and audio frames
338 if ( !done && !mlt_frame_is_test_audio( temp ) && !( mlt_properties_get_int( temp_properties, "hide" ) & 2 ) )
339 audio = temp;
340 if ( !done && !mlt_frame_is_test_card( temp ) && !( mlt_properties_get_int( temp_properties, "hide" ) & 1 ) )
341 video = temp;
342 }
343
344 // Now stack callbacks
345 if ( audio != NULL )
346 {
347 mlt_frame_push_audio( *frame, audio );
348 ( *frame )->get_audio = producer_get_audio;
349 }
350
351 if ( video != NULL )
352 {
353 mlt_properties video_properties = MLT_FRAME_PROPERTIES( video );
354 mlt_frame_push_service( *frame, video );
355 mlt_frame_push_service( *frame, producer_get_image );
356 mlt_properties_set_data( frame_properties, "data_queue", data_queue, 0, NULL, NULL );
357 mlt_properties_set_int( frame_properties, "width", mlt_properties_get_int( video_properties, "width" ) );
358 mlt_properties_set_int( frame_properties, "height", mlt_properties_get_int( video_properties, "height" ) );
359 mlt_properties_set_int( frame_properties, "real_width", mlt_properties_get_int( video_properties, "real_width" ) );
360 mlt_properties_set_int( frame_properties, "real_height", mlt_properties_get_int( video_properties, "real_height" ) );
361 mlt_properties_set_int( frame_properties, "progressive", mlt_properties_get_int( video_properties, "progressive" ) );
362 mlt_properties_set_double( frame_properties, "aspect_ratio", mlt_properties_get_double( video_properties, "aspect_ratio" ) );
363 }
364
365 mlt_frame_set_position( *frame, mlt_producer_frame( parent ) );
366 mlt_properties_set_int( MLT_FRAME_PROPERTIES( *frame ), "test_audio", audio == NULL );
367 mlt_properties_set_int( MLT_FRAME_PROPERTIES( *frame ), "test_image", video == NULL );
368 }
369 else if ( producer != NULL )
370 {
371 mlt_producer_seek( producer, mlt_producer_frame( parent ) );
372 mlt_producer_set_speed( producer, mlt_producer_get_speed( parent ) );
373 mlt_service_get_frame( this->producer, frame, track );
374 }
375 else
376 {
377 fprintf( stderr, "tractor without a multitrack!!\n" );
378 mlt_service_get_frame( this->producer, frame, track );
379 }
380
381 // Prepare the next frame
382 mlt_producer_prepare_next( parent );
383
384 // Indicate our found status
385 return 0;
386 }
387 else
388 {
389 // Generate a test card
390 *frame = mlt_frame_init( );
391 return 0;
392 }
393 }
394
395 /** Close the tractor.
396 */
397
398 void mlt_tractor_close( mlt_tractor this )
399 {
400 if ( this != NULL && mlt_properties_dec_ref( MLT_TRACTOR_PROPERTIES( this ) ) <= 0 )
401 {
402 this->parent.close = NULL;
403 mlt_producer_close( &this->parent );
404 free( this );
405 }
406 }
407