git.sesse.net Git - mlt/blob - 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 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.
  10  *
  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.
  15  *
  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
  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, "resize_alpha", mlt_properties_get_int( properties, "resize_alpha" ) );
 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_int( properties, "consumer_deinterlace" ) );
 212         mlt_properties_set( frame_properties, "deinterlace_method", mlt_properties_get( properties, "deinterlace_method" ) );
 213         mlt_properties_set_int( frame_properties, "normalised_width", mlt_properties_get_int( properties, "normalised_width" ) );
 214         mlt_properties_set_int( frame_properties, "normalised_height", mlt_properties_get_int( properties, "normalised_height" ) );
 215         mlt_frame_get_image( frame, buffer, format, width, height, writable );
 216         mlt_properties_set_data( properties, "image", *buffer, *width * *height * 2, NULL, NULL );
 217         mlt_properties_set_int( properties, "width", *width );
 218         mlt_properties_set_int( properties, "height", *height );
 219         mlt_properties_set_int( properties, "format", *format );
 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 );
 225         return 0;
 226 }
 227
 228 static int producer_get_audio( mlt_frame this, int16_t **buffer, mlt_audio_format *format, int *frequency, int *channels, int *samples )
 229 {
 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 );
 236         return 0;
 237 }
 238
 239 static void destroy_data_queue( void *arg )
 240 {
 241         if ( arg != NULL )
 242         {
 243                 // Assign the correct type
 244                 mlt_deque queue = arg;
 245
 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 ) );
 249
 250                 // Close the deque
 251                 mlt_deque_close( queue );
 252         }
 253 }
 254
 255 /** Get the next frame.
 256
 257         TODO: This function needs to be redesigned...
 258 */
 259
 260 static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int track )
 261 {
 262         mlt_tractor this = parent->child;
 263
 264         // We only respond to the first track requests
 265         if ( track == 0 && this->producer != NULL )
 266         {
 267                 int i = 0;
 268                 int done = 0;
 269                 mlt_frame temp = NULL;
 270                 int count = 0;
 271                 int image_count = 0;
 272
 273                 // Get the properties of the parent producer
 274                 mlt_properties properties = MLT_PRODUCER_PROPERTIES( parent );
 275
 276                 // Try to obtain the multitrack associated to the tractor
 277                 mlt_multitrack multitrack = mlt_properties_get_data( properties, "multitrack", NULL );
 278
 279                 // Or a specific producer
 280                 mlt_producer producer = mlt_properties_get_data( properties, "producer", NULL );
 281
 282                 // The output frame will hold the 'global' data feeds (ie: those which are targetted for the final frame)
 283                 mlt_deque data_queue = mlt_deque_init( );
 284
 285                 // Determine whether this tractor feeds to the consumer or stops here
 286                 int global_feed = mlt_properties_get_int( properties, "global_feed" );
 287
 288                 // If we don't have one, we're in trouble...
 289                 if ( multitrack != NULL )
 290                 {
 291                         // Used to garbage collect all frames
 292                         char label[ 30 ];
 293
 294                         // Get the id of the tractor
 295                         char *id = mlt_properties_get( properties, "_unique_id" );
 296
 297                         // Will be used to store the frame properties object
 298                         mlt_properties frame_properties = NULL;
 299
 300                         // We'll store audio and video frames to use here
 301                         mlt_frame audio = NULL;
 302                         mlt_frame video = NULL;
 303                         mlt_frame first_video = NULL;
 304
 305                         // Temporary properties
 306                         mlt_properties temp_properties = NULL;
 307
 308                         // Get the multitrack's producer
 309                         mlt_producer target = MLT_MULTITRACK_PRODUCER( multitrack );
 310                         mlt_producer_seek( target, mlt_producer_frame( parent ) );
 311                         mlt_producer_set_speed( target, mlt_producer_get_speed( parent ) );
 312
 313                         // We will create one frame and attach everything to it
 314                         *frame = mlt_frame_init( MLT_PRODUCER_SERVICE( parent ) );
 315
 316                         // Get the properties of the frame
 317                         frame_properties = MLT_FRAME_PROPERTIES( *frame );
 318
 319                         // Loop through each of the tracks we're harvesting
 320                         for ( i = 0; !done; i ++ )
 321                         {
 322                                 // Get a frame from the producer
 323                                 mlt_service_get_frame( this->producer, &temp, i );
 324
 325                                 // Get the temporary properties
 326                                 temp_properties = MLT_FRAME_PROPERTIES( temp );
 327
 328                                 // Check for last track
 329                                 done = mlt_properties_get_int( temp_properties, "last_track" );
 330
 331                                 // Handle fx only tracks
 332                                 if ( mlt_properties_get_int( temp_properties, "fx_cut" ) )
 333                                 {
 334                                         int hide = ( video == NULL ? 1 : 0 ) | ( audio == NULL ? 2 : 0 );
 335                                         mlt_properties_set_int( temp_properties, "hide", hide );
 336                                 }
 337
 338                                 // We store all frames with a destructor on the output frame
 339                                 sprintf( label, "_%s_%d", id, count ++ );
 340                                 mlt_properties_set_data( frame_properties, label, temp, 0, ( mlt_destructor )mlt_frame_close, NULL );
 341
 342                                 // We want to append all 'final' feeds to the global queue
 343                                 if ( !done && mlt_properties_get_data( temp_properties, "data_queue", NULL ) != NULL )
 344                                 {
 345                                         // Move the contents of this queue on to the output frames data queue
 346                                         mlt_deque sub_queue = mlt_properties_get_data( MLT_FRAME_PROPERTIES( temp ), "data_queue", NULL );
 347                                         mlt_deque temp = mlt_deque_init( );
 348                                         while ( global_feed && mlt_deque_count( sub_queue ) )
 349                                         {
 350                                                 mlt_properties p = mlt_deque_pop_back( sub_queue );
 351                                                 if ( mlt_properties_get_int( p, "final" ) )
 352                                                         mlt_deque_push_back( data_queue, p );
 353                                                 else
 354                                                         mlt_deque_push_back( temp, p );
 355                                         }
 356                                         while( mlt_deque_count( temp ) )
 357                                                 mlt_deque_push_front( sub_queue, mlt_deque_pop_back( temp ) );
 358                                         mlt_deque_close( temp );
 359                                 }
 360
 361                                 // Now do the same with the global queue but without the conditional behaviour
 362                                 if ( mlt_properties_get_data( temp_properties, "global_queue", NULL ) != NULL )
 363                                 {
 364                                         mlt_deque sub_queue = mlt_properties_get_data( MLT_FRAME_PROPERTIES( temp ), "global_queue", NULL );
 365                                         while ( mlt_deque_count( sub_queue ) )
 366                                         {
 367                                                 mlt_properties p = mlt_deque_pop_back( sub_queue );
 368                                                 mlt_deque_push_back( data_queue, p );
 369                                         }
 370                                 }
 371
 372                                 // Pick up first video and audio frames
 373                                 if ( !done && !mlt_frame_is_test_audio( temp ) && !( mlt_properties_get_int( temp_properties, "hide" ) & 2 ) )
 374                                 {
 375                                         // Order of frame creation is starting to get problematic
 376                                         if ( audio != NULL )
 377                                         {
 378                                                 mlt_deque_push_front( MLT_FRAME_AUDIO_STACK( temp ), producer_get_audio );
 379                                                 mlt_deque_push_front( MLT_FRAME_AUDIO_STACK( temp ), audio );
 380                                         }
 381                                         audio = temp;
 382                                 }
 383                                 if ( !done && !mlt_frame_is_test_card( temp ) && !( mlt_properties_get_int( temp_properties, "hide" ) & 1 ) )
 384                                 {
 385                                         if ( video != NULL )
 386                                         {
 387                                                 mlt_deque_push_front( MLT_FRAME_IMAGE_STACK( temp ), producer_get_image );
 388                                                 mlt_deque_push_front( MLT_FRAME_IMAGE_STACK( temp ), video );
 389                                         }
 390                                         video = temp;
 391                                         if ( first_video == NULL )
 392                                                 first_video = temp;
 393
 394                                         // Ensure that all frames know the aspect ratio of the background
 395                                         mlt_properties_set_double( temp_properties, "output_ratio",
 396                                                                                            mlt_properties_get_double( MLT_FRAME_PROPERTIES( first_video ), "aspect_ratio" ) );
 397
 398                                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( temp ), "image_count", ++ image_count );
 399                                         image_count = 1;
 400                                 }
 401                         }
 402
 403                         // Now stack callbacks
 404                         if ( audio != NULL )
 405                         {
 406                                 mlt_frame_push_audio( *frame, audio );
 407                                 mlt_frame_push_audio( *frame, producer_get_audio );
 408                         }
 409
 410                         if ( video != NULL )
 411                         {
 412                                 mlt_properties video_properties = MLT_FRAME_PROPERTIES( first_video );
 413                                 mlt_frame_push_service( *frame, video );
 414                                 mlt_frame_push_service( *frame, producer_get_image );
 415                                 if ( global_feed )
 416                                         mlt_properties_set_data( frame_properties, "data_queue", data_queue, 0, NULL, NULL );
 417                                 mlt_properties_set_data( video_properties, "global_queue", data_queue, 0, destroy_data_queue, NULL );
 418                                 mlt_properties_set_int( frame_properties, "width", mlt_properties_get_int( video_properties, "width" ) );
 419                                 mlt_properties_set_int( frame_properties, "height", mlt_properties_get_int( video_properties, "height" ) );
 420                                 mlt_properties_set_int( frame_properties, "real_width", mlt_properties_get_int( video_properties, "real_width" ) );
 421                                 mlt_properties_set_int( frame_properties, "real_height", mlt_properties_get_int( video_properties, "real_height" ) );
 422                                 mlt_properties_set_int( frame_properties, "progressive", mlt_properties_get_int( video_properties, "progressive" ) );
 423                                 mlt_properties_set_double( frame_properties, "aspect_ratio", mlt_properties_get_double( video_properties, "aspect_ratio" ) );
 424                                 mlt_properties_set_int( frame_properties, "image_count", image_count );
 425                         }
 426                         else
 427                         {
 428                                 destroy_data_queue( data_queue );
 429                         }
 430
 431                         mlt_frame_set_position( *frame, mlt_producer_frame( parent ) );
 432                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( *frame ), "test_audio", audio == NULL );
 433                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( *frame ), "test_image", video == NULL );
 434                         mlt_properties_set_data( MLT_FRAME_PROPERTIES( *frame ), "consumer_lock_service", this, 0, NULL, NULL );
 435                 }
 436                 else if ( producer != NULL )
 437                 {
 438                         mlt_producer_seek( producer, mlt_producer_frame( parent ) );
 439                         mlt_producer_set_speed( producer, mlt_producer_get_speed( parent ) );
 440                         mlt_service_get_frame( this->producer, frame, track );
 441                 }
 442                 else
 443                 {
 444                         fprintf( stderr, "tractor without a multitrack!!\n" );
 445                         mlt_service_get_frame( this->producer, frame, track );
 446                 }
 447
 448                 // Prepare the next frame
 449                 mlt_producer_prepare_next( parent );
 450
 451                 // Indicate our found status
 452                 return 0;
 453         }
 454         else
 455         {
 456                 // Generate a test card
 457                 *frame = mlt_frame_init( MLT_PRODUCER_SERVICE( parent ) );
 458                 return 0;
 459         }
 460 }
 461
 462 /** Close the tractor.
 463 */
 464
 465 void mlt_tractor_close( mlt_tractor this )
 466 {
 467         if ( this != NULL && mlt_properties_dec_ref( MLT_TRACTOR_PROPERTIES( this ) ) <= 0 )
 468         {
 469                 this->parent.close = NULL;
 470                 mlt_producer_close( &this->parent );
 471                 free( this );
 472         }
 473 }
 474