X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fframework%2Fmlt_multitrack.c;h=463090729b2fb845ed78e4e31e55631118c76b86;hb=2e8969380c3bd190791cea6bf045e30d068ea480;hp=6f924843b326ac96ff521f28336e0143f808bf6e;hpb=1da06dddd4f117c21c07b3682fab5abab014d995;p=mlt diff --git a/src/framework/mlt_multitrack.c b/src/framework/mlt_multitrack.c index 6f924843..46309072 100644 --- a/src/framework/mlt_multitrack.c +++ b/src/framework/mlt_multitrack.c @@ -1,25 +1,26 @@ -/* - * mlt_multitrack.c -- multitrack service class - * Copyright (C) 2003-2004 Ushodaya Enterprises Limited - * Author: Charles Yates +/** + * \file mlt_multitrack.c + * \brief multitrack service class + * \see mlt_multitrack_s * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. + * Copyright (C) 2003-2009 Ushodaya Enterprises Limited + * \author Charles Yates * - * This program is distributed in the hope that it will be useful, + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software Foundation, - * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ -#include "config.h" - #include "mlt_multitrack.h" #include "mlt_playlist.h" #include "mlt_frame.h" @@ -27,132 +28,120 @@ #include #include -struct mlt_track_s -{ - mlt_producer producer; - mlt_event event; -}; - -typedef struct mlt_track_s *mlt_track; - -/** Private definition. -*/ +/* Forward reference. */ -struct mlt_multitrack_s -{ - // We're extending producer here - struct mlt_producer_s parent; - mlt_track *list; - int size; - int count; -}; - -/** Forward reference. -*/ - -static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int index ); +static int producer_get_frame( mlt_producer producer, mlt_frame_ptr frame, int index ); -/** Constructor. -*/ +/** Construct and initialize a new multitrack. + * + * Sets the resource property to "". + * + * \public \memberof mlt_multitrack_s + * \return a new multitrack + */ mlt_multitrack mlt_multitrack_init( ) { // Allocate the multitrack object - mlt_multitrack this = calloc( sizeof( struct mlt_multitrack_s ), 1 ); + mlt_multitrack self = calloc( 1, sizeof( struct mlt_multitrack_s ) ); - if ( this != NULL ) + if ( self != NULL ) { - mlt_producer producer = &this->parent; - if ( mlt_producer_init( producer, this ) == 0 ) + mlt_producer producer = &self->parent; + if ( mlt_producer_init( producer, self ) == 0 ) { - mlt_properties properties = mlt_multitrack_properties( this ); + mlt_properties properties = MLT_MULTITRACK_PROPERTIES( self ); producer->get_frame = producer_get_frame; - mlt_properties_set_data( properties, "multitrack", this, 0, NULL, NULL ); + mlt_properties_set_data( properties, "multitrack", self, 0, NULL, NULL ); mlt_properties_set( properties, "log_id", "multitrack" ); mlt_properties_set( properties, "resource", "" ); + mlt_properties_set_int( properties, "in", 0 ); + mlt_properties_set_int( properties, "out", -1 ); + mlt_properties_set_int( properties, "length", 0 ); + producer->close = ( mlt_destructor )mlt_multitrack_close; } else { - free( this ); - this = NULL; + free( self ); + self = NULL; } } - - return this; + + return self; } /** Get the producer associated to this multitrack. -*/ + * + * \public \memberof mlt_multitrack_s + * \param self a multitrack + * \return the producer object + * \see MLT_MULTITRACK_PRODUCER + */ -mlt_producer mlt_multitrack_producer( mlt_multitrack this ) +mlt_producer mlt_multitrack_producer( mlt_multitrack self ) { - return this != NULL ? &this->parent : NULL; + return self != NULL ? &self->parent : NULL; } /** Get the service associated this multitrack. -*/ + * + * \public \memberof mlt_multitrack_s + * \param self a multitrack + * \return the service object + * \see MLT_MULTITRACK_SERVICE + */ -mlt_service mlt_multitrack_service( mlt_multitrack this ) +mlt_service mlt_multitrack_service( mlt_multitrack self ) { - return mlt_producer_service( mlt_multitrack_producer( this ) ); + return MLT_MULTITRACK_SERVICE( self ); } /** Get the properties associated this multitrack. -*/ + * + * \public \memberof mlt_multitrack_s + * \param self a multitrack + * \return the multitrack's property list + * \see MLT_MULTITRACK_PROPERTIES + */ -mlt_properties mlt_multitrack_properties( mlt_multitrack this ) +mlt_properties mlt_multitrack_properties( mlt_multitrack self ) { - return mlt_service_properties( mlt_multitrack_service( this ) ); + return MLT_MULTITRACK_PROPERTIES( self ); } -/** Initialise position related information. -*/ +/** Initialize position related information. + * + * \public \memberof mlt_multitrack_s + * \param self a multitrack + */ -void mlt_multitrack_refresh( mlt_multitrack this ) +void mlt_multitrack_refresh( mlt_multitrack self ) { int i = 0; // Obtain the properties of this multitrack - mlt_properties properties = mlt_multitrack_properties( this ); + mlt_properties properties = MLT_MULTITRACK_PROPERTIES( self ); // We need to ensure that the multitrack reports the longest track as its length mlt_position length = 0; - // We need to ensure that fps are the same on all services - double fps = 0; - // Obtain stats on all connected services - for ( i = 0; i < this->count; i ++ ) + for ( i = 0; i < self->count; i ++ ) { // Get the producer from this index - mlt_track track = this->list[ i ]; + mlt_track track = self->list[ i ]; mlt_producer producer = track->producer; // If it's allocated then, update our stats if ( producer != NULL ) { // If we have more than 1 track, we must be in continue mode - if ( this->count > 1 ) - mlt_properties_set( mlt_producer_properties( producer ), "eof", "continue" ); - + if ( self->count > 1 ) + mlt_properties_set( MLT_PRODUCER_PROPERTIES( producer ), "eof", "continue" ); + // Determine the longest length - if ( !mlt_properties_get_int( mlt_producer_properties( producer ), "hide" ) ) + //if ( !mlt_properties_get_int( MLT_PRODUCER_PROPERTIES( producer ), "hide" ) ) length = mlt_producer_get_playtime( producer ) > length ? mlt_producer_get_playtime( producer ) : length; - - // Handle fps - if ( fps == 0 ) - { - // This is the first producer, so it controls the fps - fps = mlt_producer_get_fps( producer ); - } - else if ( fps != mlt_producer_get_fps( producer ) ) - { - // Generate a warning for now - the following attempt to fix may fail - fprintf( stderr, "Warning: fps mismatch on track %d\n", i ); - - // It should be safe to impose fps on an image producer, but not necessarily safe for video - mlt_properties_set_double( mlt_producer_properties( producer ), "fps", fps ); - } } } @@ -161,94 +150,135 @@ void mlt_multitrack_refresh( mlt_multitrack this ) mlt_properties_set_position( properties, "length", length ); mlt_events_unblock( properties, properties ); mlt_properties_set_position( properties, "out", length - 1 ); - mlt_properties_set_double( properties, "fps", fps ); } /** Listener for producers on the playlist. -*/ + * + * \private \memberof mlt_multitrack_s + * \param producer a producer + * \param self a multitrack + */ -static void mlt_multitrack_listener( mlt_producer producer, mlt_multitrack this ) +static void mlt_multitrack_listener( mlt_producer producer, mlt_multitrack self ) { - mlt_multitrack_refresh( this ); + mlt_multitrack_refresh( self ); } /** Connect a producer to a given track. + * + * Note that any producer can be connected here, but see special case treatment + * of playlist in clip point determination below. + * + * \public \memberof mlt_multitrack_s + * \param self a multitrack + * \param producer the producer to connect to the multitrack producer + * \param track the 0-based index of the track on which to connect the multitrack + * \return true on error + */ - Note that any producer can be connected here, but see special case treatment - of playlist in clip point determination below. -*/ - -int mlt_multitrack_connect( mlt_multitrack this, mlt_producer producer, int track ) +int mlt_multitrack_connect( mlt_multitrack self, mlt_producer producer, int track ) { // Connect to the producer to ourselves at the specified track - int result = mlt_service_connect_producer( mlt_multitrack_service( this ), mlt_producer_service( producer ), track ); + int result = mlt_service_connect_producer( MLT_MULTITRACK_SERVICE( self ), MLT_PRODUCER_SERVICE( producer ), track ); if ( result == 0 ) { // Resize the producer list if need be - if ( track >= this->size ) + if ( track >= self->size ) { int i; - this->list = realloc( this->list, ( track + 10 ) * sizeof( mlt_track ) ); - for ( i = this->size; i < track + 10; i ++ ) - this->list[ i ] = NULL; - this->size = track + 10; + self->list = realloc( self->list, ( track + 10 ) * sizeof( mlt_track ) ); + for ( i = self->size; i < track + 10; i ++ ) + self->list[ i ] = NULL; + self->size = track + 10; } - if ( this->list[ track ] != NULL ) + if ( self->list[ track ] != NULL ) { - mlt_event_close( this->list[ track ]->event ); - mlt_producer_close( this->list[ track ]->producer ); + mlt_event_close( self->list[ track ]->event ); + mlt_producer_close( self->list[ track ]->producer ); } else { - this->list[ track ] = malloc( sizeof( struct mlt_track_s ) ); + self->list[ track ] = malloc( sizeof( struct mlt_track_s ) ); } // Assign the track in our list here - this->list[ track ]->producer = producer; - this->list[ track ]->event = mlt_events_listen( mlt_producer_properties( producer ), this, + self->list[ track ]->producer = producer; + self->list[ track ]->event = mlt_events_listen( MLT_PRODUCER_PROPERTIES( producer ), self, "producer-changed", ( mlt_listener )mlt_multitrack_listener ); - mlt_properties_inc_ref( mlt_producer_properties( producer ) ); - mlt_event_inc_ref( this->list[ track ]->event ); - + mlt_properties_inc_ref( MLT_PRODUCER_PROPERTIES( producer ) ); + mlt_event_inc_ref( self->list[ track ]->event ); + // Increment the track count if need be - if ( track >= this->count ) - this->count = track + 1; - + if ( track >= self->count ) + { + self->count = track + 1; + + // TODO: Move this into producer_avformat.c when mlt_events broadcasting is available. + if ( self->count > mlt_service_cache_get_size( MLT_MULTITRACK_SERVICE( self ), "producer_avformat" ) ) + mlt_service_cache_set_size( MLT_MULTITRACK_SERVICE( self ), "producer_avformat", self->count + 1 ); + } + // Refresh our stats - mlt_multitrack_refresh( this ); + mlt_multitrack_refresh( self ); } return result; } /** Get the number of tracks. -*/ + * + * \public \memberof mlt_multitrack_s + * \param self a multitrack + * \return the number of tracks + */ -int mlt_multitrack_count( mlt_multitrack this ) +int mlt_multitrack_count( mlt_multitrack self ) { - return this->count; + return self->count; } /** Get an individual track as a producer. -*/ + * + * \public \memberof mlt_multitrack_s + * \param self a multitrack + * \param track the 0-based index of the producer to get + * \return the producer or NULL if not valid + */ -mlt_producer mlt_multitrack_track( mlt_multitrack this, int track ) +mlt_producer mlt_multitrack_track( mlt_multitrack self, int track ) { mlt_producer producer = NULL; - - if ( this->list != NULL && track < this->count ) - producer = this->list[ track ]->producer; + + if ( self->list != NULL && track < self->count ) + producer = self->list[ track ]->producer; return producer; } +/** Position comparison function for sorting. + * + * \private \memberof mlt_multitrack_s + * \param p1 a position + * \param p2 another position + * \return <0 if \p p1 is less than \p p2, 0 if equal, >0 if greater + */ + static int position_compare( const void *p1, const void *p2 ) { - return *( mlt_position * )p1 - *( mlt_position * )p2; + return *( const mlt_position * )p1 - *( const mlt_position * )p2; } +/** Add a position to a set. + * + * \private \memberof mlt_multitrack_s + * \param array an array of positions (the set) + * \param size the current number of positions in the array (not the capacity of the array) + * \param position the position to add + * \return the new size of the array + */ + static int add_unique( mlt_position *array, int size, mlt_position position ) { int i = 0; @@ -261,43 +291,51 @@ static int add_unique( mlt_position *array, int size, mlt_position position ) } /** Determine the clip point. + * + * 
+ * Special case here: a 'producer' has no concept of multiple clips - only the
+ * playlist and multitrack producers have clip functionality. Further to that a
+ * multitrack determines clip information from any connected tracks that happen
+ * to be playlists.
+ *
+ * Additionally, it must locate clips in the correct order, for example, consider
+ * the following track arrangement:
+ *
+ * playlist1 |0.0     |b0.0      |0.1          |0.1         |0.2           |
+ * playlist2 |b1.0  |1.0           |b1.1     |1.1             |
+ *
+ * Note - b clips represent blanks. They are also reported as clip positions.
+ *
+ * When extracting clip positions from these playlists, we should get a sequence of:
+ *
+ * 0.0, 1.0, b0.0, 0.1, b1.1, 1.1, 0.1, 0.2, [out of playlist2], [out of playlist1]
+ *
+ * + * \public \memberof mlt_multitrack_s + * \param self a multitrack + * \param whence from where to extract + * \param index the 0-based index of which clip to extract + * \return the position of clip \p index relative to \p whence + */ - Special case here: a 'producer' has no concept of multiple clips - only the - playlist and multitrack producers have clip functionality. Further to that a - multitrack determines clip information from any connected tracks that happen - to be playlists. - - Additionally, it must locate clips in the correct order, for example, consider - the following track arrangement: - - playlist1 |0.0 |b0.0 |0.1 |0.1 |0.2 | - playlist2 |b1.0 |1.0 |b1.1 |1.1 | - - Note - b clips represent blanks. They are also reported as clip positions. - - When extracting clip positions from these playlists, we should get a sequence of: - - 0.0, 1.0, b0.0, 0.1, b1.1, 1.1, 0.1, 0.2, [out of playlist2], [out of playlist1] -*/ - -mlt_position mlt_multitrack_clip( mlt_multitrack this, mlt_whence whence, int index ) +mlt_position mlt_multitrack_clip( mlt_multitrack self, mlt_whence whence, int index ) { mlt_position position = 0; int i = 0; int j = 0; - mlt_position *map = malloc( 1000 * sizeof( mlt_position ) ); + mlt_position *map = calloc( 1000, sizeof( mlt_position ) ); int count = 0; - for ( i = 0; i < this->count; i ++ ) + for ( i = 0; i < self->count; i ++ ) { // Get the producer for this track - mlt_producer producer = this->list[ i ]->producer; + mlt_producer producer = self->list[ i ]->producer; // If it's assigned and not a hidden track if ( producer != NULL ) { // Get the properties of this producer - mlt_properties properties = mlt_producer_properties( producer ); + mlt_properties properties = MLT_PRODUCER_PROPERTIES( producer ); // Determine if it's a playlist mlt_playlist playlist = mlt_properties_get_data( properties, "playlist", NULL ); @@ -331,8 +369,8 @@ mlt_position mlt_multitrack_clip( mlt_multitrack this, mlt_whence whence, int in break; case mlt_whence_relative_current: - position = mlt_producer_position( mlt_multitrack_producer( this ) ); - for ( i = 0; i < count - 2; i ++ ) + position = mlt_producer_position( MLT_MULTITRACK_PRODUCER( self ) ); + for ( i = 0; i < count - 2; i ++ ) if ( position >= map[ i ] && position < map[ i + 1 ] ) break; index += i; @@ -359,49 +397,57 @@ mlt_position mlt_multitrack_clip( mlt_multitrack this, mlt_whence whence, int in } /** Get frame method. - - Special case here: The multitrack must be used in a conjunction with a downstream - tractor-type service, ie: - - Producer1 \ - Producer2 - multitrack - { filters/transitions } - tractor - consumer - Producer3 / - - The get_frame of a tractor pulls frames from it's connected service on all tracks and - will terminate as soon as it receives a test card with a last_track property. The - important case here is that the mulitrack does not move to the next frame until all - tracks have been pulled. - - Reasoning: In order to seek on a network such as above, the multitrack needs to ensure - that all producers are positioned on the same frame. It uses the 'last track' logic - to determine when to move to the next frame. - - Flaw: if a transition is configured to read from a b-track which happens to trigger - the last frame logic (ie: it's configured incorrectly), then things are going to go - out of sync. - - See playlist logic too. -*/ + * + * 
+ * Special case here: The multitrack must be used in a conjunction with a downstream
+ * tractor-type service, ie:
+ *
+ * Producer1 \
+ * Producer2 - multitrack - { filters/transitions } - tractor - consumer
+ * Producer3 /
+ *
+ * The get_frame of a tractor pulls frames from it's connected service on all tracks and
+ * will terminate as soon as it receives a test card with a last_track property. The
+ * important case here is that the mulitrack does not move to the next frame until all
+ * tracks have been pulled.
+ *
+ * Reasoning: In order to seek on a network such as above, the multitrack needs to ensure
+ * that all producers are positioned on the same frame. It uses the 'last track' logic
+ * to determine when to move to the next frame.
+ *
+ * Flaw: if a transition is configured to read from a b-track which happens to trigger
+ * the last frame logic (ie: it's configured incorrectly), then things are going to go
+ * out of sync.
+ *
+ * See playlist logic too.
+ *
+ * + * \private \memberof mlt_multitrack_s + * \param parent the producer interface to a mulitrack + * \param[out] frame a frame by reference + * \param index the 0-based track index + * \return true if there was an error + */ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int index ) { // Get the mutiltrack object - mlt_multitrack this = parent->child; + mlt_multitrack self = parent->child; // Check if we have a track for this index - if ( index < this->count && this->list[ index ] != NULL ) + if ( index < self->count && self->list[ index ] != NULL ) { // Get the producer for this track - mlt_producer producer = this->list[ index ]->producer; + mlt_producer producer = self->list[ index ]->producer; // Get the track hide property - int hide = mlt_properties_get_int( mlt_producer_properties( mlt_producer_cut_parent( producer ) ), "hide" ); + int hide = mlt_properties_get_int( MLT_PRODUCER_PROPERTIES( mlt_producer_cut_parent( producer ) ), "hide" ); // Obtain the current position mlt_position position = mlt_producer_frame( parent ); // Get the parent properties - mlt_properties producer_properties = mlt_producer_properties( parent ); + mlt_properties producer_properties = MLT_PRODUCER_PROPERTIES( parent ); // Get the speed double speed = mlt_properties_get_double( producer_properties, "_speed" ); @@ -410,30 +456,27 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int ind mlt_producer_seek( producer, position ); // Get the frame from the producer - mlt_service_get_frame( mlt_producer_service( producer ), frame, 0 ); + mlt_service_get_frame( MLT_PRODUCER_SERVICE( producer ), frame, 0 ); // Indicate speed of this producer - mlt_properties properties = mlt_frame_properties( *frame ); + mlt_properties properties = MLT_FRAME_PROPERTIES( *frame ); mlt_properties_set_double( properties, "_speed", speed ); - mlt_properties_set_position( properties, "_position", position ); - if ( mlt_properties_get_int( properties, "test_image" ) == 0 ) - mlt_properties_set_int( properties, "test_image", hide & 1 ); - if ( mlt_properties_get_int( properties, "test_audio" ) == 0 ) - mlt_properties_set_int( properties, "test_audio", hide & 2 ); + mlt_frame_set_position( *frame, position ); + mlt_properties_set_int( properties, "hide", hide ); } else { // Generate a test frame - *frame = mlt_frame_init( ); + *frame = mlt_frame_init( MLT_PRODUCER_SERVICE( parent ) ); // Update position on the frame we're creating mlt_frame_set_position( *frame, mlt_producer_position( parent ) ); // Move on to the next frame - if ( index >= this->count ) + if ( index >= self->count ) { // Let tractor know if we've reached the end - mlt_properties_set_int( mlt_frame_properties( *frame ), "last_track", 1 ); + mlt_properties_set_int( MLT_FRAME_PROPERTIES( *frame ), "last_track", 1 ); // Move to the next frame mlt_producer_prepare_next( parent ); @@ -443,31 +486,35 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int ind return 0; } -/** Close this instance. -*/ +/** Close this instance and free its resources. + * + * \public \memberof mlt_multitrack_s + * \param self a multitrack + */ -void mlt_multitrack_close( mlt_multitrack this ) +void mlt_multitrack_close( mlt_multitrack self ) { - if ( this != NULL && mlt_properties_dec_ref( mlt_multitrack_properties( this ) ) <= 0 ) + if ( self != NULL && mlt_properties_dec_ref( MLT_MULTITRACK_PROPERTIES( self ) ) <= 0 ) { int i = 0; - for ( i = 0; i < this->count; i ++ ) + for ( i = 0; i < self->count; i ++ ) { - if ( this->list[ i ] != NULL ) + if ( self->list[ i ] != NULL ) { - mlt_event_close( this->list[ i ]->event ); - mlt_producer_close( this->list[ i ]->producer ); - free( this->list[ i ] ); + mlt_event_close( self->list[ i ]->event ); + mlt_producer_close( self->list[ i ]->producer ); + free( self->list[ i ] ); } } // Close the producer - mlt_producer_close( &this->parent ); + self->parent.close = NULL; + mlt_producer_close( &self->parent ); // Free the list - free( this->list ); + free( self->list ); // Free the object - free( this ); + free( self ); } }