-/*
- * mlt_consumer.c -- abstraction for all consumer services
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_consumer.c
+ * \brief abstraction for all consumer services
+ * \see mlt_consumer_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-2010 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
+ * \author Dan Dennedy <dan@dennedy.org>
*
- * 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_consumer.h"
#include "mlt_factory.h"
#include "mlt_producer.h"
#include "mlt_frame.h"
+#include "mlt_profile.h"
+#include "mlt_log.h"
+
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <sys/time.h>
+/** Define this if you want an automatic deinterlace (if necessary) when the
+ * consumer's producer is not running at normal speed.
+ */
+#undef DEINTERLACE_ON_NOT_NORMAL_SPEED
+
+/** This is not the ideal place for this, but it is needed by VDPAU as well.
+ */
+pthread_mutex_t mlt_sdl_mutex = PTHREAD_MUTEX_INITIALIZER;
+
static void mlt_consumer_frame_render( mlt_listener listener, mlt_properties owner, mlt_service this, void **args );
static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service this, void **args );
+static void mlt_consumer_property_changed( mlt_properties owner, mlt_consumer this, char *name );
+static void apply_profile_properties( mlt_consumer this, mlt_profile profile, mlt_properties properties );
+static void on_consumer_frame_show( mlt_properties owner, mlt_consumer this, mlt_frame frame );
-/** Public final methods
-*/
+/** Initialize a consumer service.
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this the consumer to initialize
+ * \param child a pointer to the object for the subclass
+ * \param profile the \p mlt_profile_s to use (optional but recommended,
+ * uses the environment variable MLT if this is NULL)
+ * \return true if there was an error
+ */
-int mlt_consumer_init( mlt_consumer this, void *child )
+int mlt_consumer_init( mlt_consumer this, void *child, mlt_profile profile )
{
int error = 0;
memset( this, 0, sizeof( struct mlt_consumer_s ) );
// Get the properties from the service
mlt_properties properties = MLT_SERVICE_PROPERTIES( &this->parent );
- // Get the normalisation preference
- char *normalisation = mlt_environment( "MLT_NORMALISATION" );
-
- // Deal with normalisation
- if ( normalisation == NULL || strcmp( normalisation, "NTSC" ) )
+ // Apply profile to properties
+ if ( profile == NULL )
{
- mlt_properties_set( properties, "normalisation", "PAL" );
- mlt_properties_set_double( properties, "fps", 25.0 );
- mlt_properties_set_int( properties, "width", 720 );
- mlt_properties_set_int( properties, "height", 576 );
- mlt_properties_set_int( properties, "progressive", 0 );
- mlt_properties_set_double( properties, "aspect_ratio", 59.0 / 54.0 );
- }
- else
- {
- mlt_properties_set( properties, "normalisation", "NTSC" );
- mlt_properties_set_double( properties, "fps", 30000.0 / 1001.0 );
- mlt_properties_set_int( properties, "width", 720 );
- mlt_properties_set_int( properties, "height", 480 );
- mlt_properties_set_int( properties, "progressive", 0 );
- mlt_properties_set_double( properties, "aspect_ratio", 10.0 / 11.0 );
+ // Normally the application creates the profile and controls its lifetime
+ // This is the fallback exception handling
+ profile = mlt_profile_init( NULL );
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+ mlt_properties_set_data( properties, "_profile", profile, 0, (mlt_destructor)mlt_profile_close, NULL );
}
+ apply_profile_properties( this, profile, properties );
// Default rescaler for all consumers
mlt_properties_set( properties, "rescale", "bilinear" );
mlt_events_register( properties, "consumer-frame-show", ( mlt_transmitter )mlt_consumer_frame_show );
mlt_events_register( properties, "consumer-frame-render", ( mlt_transmitter )mlt_consumer_frame_render );
mlt_events_register( properties, "consumer-stopped", NULL );
+ mlt_events_listen( properties, this, "consumer-frame-show", ( mlt_listener )on_consumer_frame_show );
+
+ // Register a property-changed listener to handle the profile property -
+ // subsequent properties can override the profile
+ this->event_listener = mlt_events_listen( properties, this, "property-changed", ( mlt_listener )mlt_consumer_property_changed );
// Create the push mutex and condition
pthread_mutex_init( &this->put_mutex, NULL );
return error;
}
+/** Convert the profile into properties on the consumer.
+ *
+ * \private \memberof mlt_consumer_s
+ * \param this a consumer
+ * \param profile a profile
+ * \param properties a properties list (typically, the consumer's)
+ */
+
+static void apply_profile_properties( mlt_consumer this, mlt_profile profile, mlt_properties properties )
+{
+ mlt_event_block( this->event_listener );
+ mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
+ mlt_properties_set_int( properties, "frame_rate_num", profile->frame_rate_num );
+ mlt_properties_set_int( properties, "frame_rate_den", profile->frame_rate_den );
+ mlt_properties_set_int( properties, "width", profile->width );
+ mlt_properties_set_int( properties, "height", profile->height );
+ mlt_properties_set_int( properties, "progressive", profile->progressive );
+ mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile ) );
+ mlt_properties_set_int( properties, "sample_aspect_num", profile->sample_aspect_num );
+ mlt_properties_set_int( properties, "sample_aspect_den", profile->sample_aspect_den );
+ mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile ) );
+ mlt_properties_set_int( properties, "display_aspect_num", profile->display_aspect_num );
+ mlt_properties_set_int( properties, "display_aspect_num", profile->display_aspect_num );
+ mlt_properties_set_int( properties, "colorspace", profile->colorspace );
+ mlt_event_unblock( this->event_listener );
+}
+
+/** The property-changed event listener
+ *
+ * \private \memberof mlt_consumer_s
+ * \param owner the events object
+ * \param this the consumer
+ * \param name the name of the property that changed
+ */
+
+static void mlt_consumer_property_changed( mlt_properties owner, mlt_consumer this, char *name )
+{
+ if ( !strcmp( name, "profile" ) )
+ {
+ // Get the properies
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+
+ // Get the current profile
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+
+ // Load the new profile
+ mlt_profile new_profile = mlt_profile_init( mlt_properties_get( properties, name ) );
+
+ if ( new_profile )
+ {
+ // Copy the profile
+ if ( profile != NULL )
+ {
+ free( profile->description );
+ memcpy( profile, new_profile, sizeof( struct mlt_profile_s ) );
+ profile->description = strdup( new_profile->description );
+ mlt_profile_close( new_profile );
+ }
+ else
+ {
+ profile = new_profile;
+ }
+
+ // Apply to properties
+ apply_profile_properties( this, profile, properties );
+ }
+ }
+ else if ( !strcmp( name, "frame_rate_num" ) )
+ {
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+ if ( profile )
+ {
+ profile->frame_rate_num = mlt_properties_get_int( properties, "frame_rate_num" );
+ mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
+ }
+ }
+ else if ( !strcmp( name, "frame_rate_den" ) )
+ {
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+ if ( profile )
+ {
+ profile->frame_rate_den = mlt_properties_get_int( properties, "frame_rate_den" );
+ mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
+ }
+ }
+ else if ( !strcmp( name, "width" ) )
+ {
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+ if ( profile )
+ profile->width = mlt_properties_get_int( properties, "width" );
+ }
+ else if ( !strcmp( name, "height" ) )
+ {
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+ if ( profile )
+ profile->height = mlt_properties_get_int( properties, "height" );
+ }
+ else if ( !strcmp( name, "progressive" ) )
+ {
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+ if ( profile )
+ profile->progressive = mlt_properties_get_int( properties, "progressive" );
+ }
+ else if ( !strcmp( name, "sample_aspect_num" ) )
+ {
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+ profile->sample_aspect_num = mlt_properties_get_int( properties, "sample_aspect_num" );
+ if ( profile )
+ mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile ) );
+ }
+ else if ( !strcmp( name, "sample_aspect_den" ) )
+ {
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+ profile->sample_aspect_den = mlt_properties_get_int( properties, "sample_aspect_den" );
+ if ( profile )
+ mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile ) );
+ }
+ else if ( !strcmp( name, "display_aspect_num" ) )
+ {
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+ if ( profile )
+ {
+ profile->display_aspect_num = mlt_properties_get_int( properties, "display_aspect_num" );
+ mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile ) );
+ }
+ }
+ else if ( !strcmp( name, "display_aspect_den" ) )
+ {
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+ if ( profile )
+ {
+ profile->display_aspect_den = mlt_properties_get_int( properties, "display_aspect_den" );
+ mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile ) );
+ }
+ }
+ else if ( !strcmp( name, "colorspace" ) )
+ {
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+ if ( profile )
+ profile->colorspace = mlt_properties_get_int( properties, "colorspace" );
+ }
+}
+
+/** The transmitter for the consumer-frame-show event
+ *
+ * Invokes the listener.
+ *
+ * \private \memberof mlt_consumer_s
+ * \param listener a function pointer that will be invoked
+ * \param owner the events object that will be passed to \p listener
+ * \param this a service that will be passed to \p listener
+ * \param args an array of pointers - the first entry is passed as a string to \p listener
+ */
+
static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
{
if ( listener != NULL )
listener( owner, this, ( mlt_frame )args[ 0 ] );
}
+/** The transmitter for the consumer-frame-render event
+ *
+ * Invokes the listener.
+ *
+ * \private \memberof mlt_consumer_s
+ * \param listener a function pointer that will be invoked
+ * \param owner the events object that will be passed to \p listener
+ * \param this a service that will be passed to \p listener
+ * \param args an array of pointers - the first entry is passed as a string to \p listener
+ */
+
static void mlt_consumer_frame_render( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
{
if ( listener != NULL )
listener( owner, this, ( mlt_frame )args[ 0 ] );
}
+/** A listener on the consumer-frame-show event
+ *
+ * Saves the position of the frame shown.
+ *
+ * \private \memberof mlt_consumer_s
+ * \param owner the events object
+ * \param consumer the consumer on which this event occurred
+ * \param frame the frame that was shown
+ */
+
+static void on_consumer_frame_show( mlt_properties owner, mlt_consumer consumer, mlt_frame frame )
+{
+ if ( frame )
+ consumer->position = mlt_frame_get_position( frame );
+}
+
/** Create a new consumer.
-*/
+ *
+ * \public \memberof mlt_consumer_s
+ * \param profile a profile (optional, but recommended)
+ * \return a new consumer
+ */
-mlt_consumer mlt_consumer_new( )
+mlt_consumer mlt_consumer_new( mlt_profile profile )
{
// Create the memory for the structure
mlt_consumer this = malloc( sizeof( struct mlt_consumer_s ) );
// Initialise it
if ( this != NULL )
- mlt_consumer_init( this, NULL );
+ mlt_consumer_init( this, NULL, profile );
// Return it
return this;
}
/** Get the parent service object.
-*/
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ * \return the parent service class
+ * \see MLT_CONSUMER_SERVICE
+ */
mlt_service mlt_consumer_service( mlt_consumer this )
{
}
/** Get the consumer properties.
-*/
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ * \return the consumer's properties list
+ * \see MLT_CONSUMER_PROPERTIES
+ */
mlt_properties mlt_consumer_properties( mlt_consumer this )
{
}
/** Connect the consumer to the producer.
-*/
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ * \param producer a producer
+ * \return > 0 warning, == 0 success, < 0 serious error,
+ * 1 = this service does not accept input,
+ * 2 = the producer is invalid,
+ * 3 = the producer is already registered with this consumer
+ */
int mlt_consumer_connect( mlt_consumer this, mlt_service producer )
{
}
/** Start the consumer.
-*/
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ * \return true if there was an error
+ */
int mlt_consumer_start( mlt_consumer this )
{
+ // Stop listening to the property-changed event
+ mlt_event_block( this->event_listener );
+
// Get the properies
mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
if ( mlt_properties_get_data( properties, "test_card_producer", NULL ) == NULL )
{
// Create a test card producer
- mlt_producer producer = mlt_factory_producer( NULL, test_card );
+ mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
+ mlt_producer producer = mlt_factory_producer( profile, NULL, test_card );
// Do we have a producer
if ( producer != NULL )
mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
}
+ // Set the frame duration in microseconds for the frame-dropping heuristic
+ int frame_duration = 1000000 / mlt_properties_get_int( properties, "frame_rate_num" ) *
+ mlt_properties_get_int( properties, "frame_rate_den" );
+ mlt_properties_set_int( properties, "frame_duration", frame_duration );
+
// Check and run an ante command
if ( mlt_properties_get( properties, "ante" ) )
- system( mlt_properties_get( properties, "ante" ) );
+ if ( system( mlt_properties_get( properties, "ante" ) ) == -1 )
+ mlt_log( MLT_CONSUMER_SERVICE( this ), MLT_LOG_ERROR, "system(%s) failed!\n", mlt_properties_get( properties, "ante" ) );
// Set the real_time preference
this->real_time = mlt_properties_get_int( properties, "real_time" );
+ // For worker threads implementation, buffer must be at least # threads
+ if ( abs( this->real_time ) > 1 && mlt_properties_get_int( properties, "buffer" ) <= abs( this->real_time ) )
+ mlt_properties_set_int( properties, "buffer", abs( this->real_time ) + 1 );
+
// Start the service
if ( this->start != NULL )
return this->start( this );
return 0;
}
-/** An alternative method to feed frames into the consumer - only valid if
- the consumer itself is not connected.
-*/
+/** An alternative method to feed frames into the consumer.
+ *
+ * Only valid if the consumer itself is not connected.
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ * \param frame a frame
+ * \return true (ignore this for now)
+ */
int mlt_consumer_put_frame( mlt_consumer this, mlt_frame frame )
{
}
/** Protected method for consumer to get frames from connected service
-*/
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ * \return a frame
+ */
mlt_frame mlt_consumer_get_frame( mlt_consumer this )
{
}
else
{
- frame = mlt_frame_init( );
+ frame = mlt_frame_init( service );
}
if ( frame != NULL )
// Aspect ratio and other jiggery pokery
mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "aspect_ratio" ) );
mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_int( properties, "progressive" ) | mlt_properties_get_int( properties, "deinterlace" ) );
+ mlt_properties_set( frame_properties, "deinterlace_method", mlt_properties_get( properties, "deinterlace_method" ) );
}
// Return the frame
return frame;
}
+/** Compute the time difference between now and a time value.
+ *
+ * \private \memberof mlt_consumer_s
+ * \param time1 a time value to be compared against now
+ * \return the difference in microseconds
+ */
+
static inline long time_difference( struct timeval *time1 )
{
struct timeval time2;
return time1->tv_sec * 1000000 + time1->tv_usec - time2.tv_sec * 1000000 - time2.tv_usec;
}
+/** The thread procedure for asynchronously pulling frames through the service
+ * network connected to a consumer.
+ *
+ * \private \memberof mlt_consumer_s
+ * \param arg a consumer
+ */
+
static void *consumer_read_ahead_thread( void *arg )
{
// The argument is the consumer
// See if video is turned off
int video_off = mlt_properties_get_int( properties, "video_off" );
+ int preview_off = mlt_properties_get_int( properties, "preview_off" );
+ int preview_format = mlt_properties_get_int( properties, "preview_format" );
// Get the audio settings
- mlt_audio_format afmt = mlt_audio_pcm;
+ mlt_audio_format afmt = mlt_audio_s16;
int counter = 0;
double fps = mlt_properties_get_double( properties, "fps" );
int channels = mlt_properties_get_int( properties, "channels" );
int frequency = mlt_properties_get_int( properties, "frequency" );
int samples = 0;
- int16_t *pcm = NULL;
+ void *audio = NULL;
// See if audio is turned off
int audio_off = mlt_properties_get_int( properties, "audio_off" );
int64_t time_frame = 0;
int64_t time_process = 0;
int skip_next = 0;
- mlt_service lock_object = NULL;
+
+ if ( preview_off && preview_format != 0 )
+ this->format = preview_format;
// Get the first frame
frame = mlt_consumer_get_frame( this );
- // Get the lock object
- lock_object = mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "consumer_lock_service", NULL );
-
- // Lock it
- if ( lock_object ) mlt_service_lock( lock_object );
-
// Get the image of the first frame
if ( !video_off )
{
if ( !audio_off )
{
samples = mlt_sample_calculator( fps, frequency, counter++ );
- mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
+ mlt_frame_get_audio( frame, &audio, &afmt, &frequency, &channels, &samples );
}
- // Unlock the lock object
- if ( lock_object ) mlt_service_unlock( lock_object );
-
// Mark as rendered
mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
// Continue to read ahead
while ( this->ahead )
{
+ // Fetch width/height again
+ width = mlt_properties_get_int( properties, "width" );
+ height = mlt_properties_get_int( properties, "height" );
+
// Put the current frame into the queue
- pthread_mutex_lock( &this->mutex );
+ pthread_mutex_lock( &this->queue_mutex );
while( this->ahead && mlt_deque_count( this->queue ) >= buffer )
- pthread_cond_wait( &this->cond, &this->mutex );
+ pthread_cond_wait( &this->queue_cond, &this->queue_mutex );
mlt_deque_push_back( this->queue, frame );
- pthread_cond_broadcast( &this->cond );
- pthread_mutex_unlock( &this->mutex );
+ pthread_cond_broadcast( &this->queue_cond );
+ pthread_mutex_unlock( &this->queue_mutex );
time_wait += time_difference( &ante );
if ( frame == NULL )
continue;
- // Attempt to fetch the lock object
- lock_object = mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "consumer_lock_service", NULL );
-
// Increment the count
count ++;
- // Lock if there's a lock object
- if ( lock_object ) mlt_service_lock( lock_object );
-
// All non normal playback frames should be shown
if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "_speed" ) != 1 )
{
+#ifdef DEINTERLACE_ON_NOT_NORMAL_SPEED
+ mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "consumer_deinterlace", 1 );
+#endif
skipped = 0;
time_frame = 0;
time_process = 0;
}
// Get the image
- if ( !skip_next )
+ if ( !skip_next || this->real_time == -1 )
{
// Get the image, mark as rendered and time it
if ( !video_off )
skip_next = 0;
// If we've reached an unacceptable level, reset everything
- if ( skipped > 5 )
+ if ( skipped > fps * 2 )
{
skipped = 0;
time_frame = 0;
if ( !audio_off )
{
samples = mlt_sample_calculator( fps, frequency, counter++ );
- mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
+ mlt_frame_get_audio( frame, &audio, &afmt, &frequency, &channels, &samples );
}
// Increment the time take for this frame
time_process += time_difference( &ante );
// Determine if the next frame should be skipped
- if ( mlt_deque_count( this->queue ) <= 5 && ( ( time_wait + time_frame + time_process ) / count ) > 40000 )
- skip_next = 1;
-
- // Unlock if there's a lock object
- if ( lock_object ) mlt_service_unlock( lock_object );
+ if ( mlt_deque_count( this->queue ) <= 5 )
+ {
+ int frame_duration = mlt_properties_get_int( properties, "frame_duration" );
+ if ( ( ( time_wait + time_frame + time_process ) / count ) > frame_duration )
+ skip_next = 1;
+ }
}
// Remove the last frame
return NULL;
}
+/** Locate the first unprocessed frame in the queue.
+ *
+ * When playing with realtime behavior, we do not use the true head, but
+ * rather an adjusted process_head. The process_head is adjusted based on
+ * the rate of frame-dropping or recovery from frame-dropping. The idea is
+ * that as the level of frame-dropping increases to move the process_head
+ * closer to the tail because the frames are not completing processing prior
+ * to their playout! Then, as frames are not dropped the process_head moves
+ * back closer to the head of the queue so that worker threads can work
+ * ahead of the playout point (queue head).
+ *
+ * \private \memberof mlt_consumer_s
+ * \param this a consumer
+ * \return an index into the queue
+ */
+
+static inline int first_unprocessed_frame( mlt_consumer this )
+{
+ int index = this->real_time <= 0 ? 0 : this->process_head;
+ while ( index < mlt_deque_count( this->queue ) && MLT_FRAME( mlt_deque_peek( this->queue, index ) )->is_processing )
+ index++;
+ return index;
+}
+
+/** The worker thread procedure for parallel processing frames.
+ *
+ * \private \memberof mlt_consumer_s
+ * \param arg a consumer
+ */
+
+static void *consumer_worker_thread( void *arg )
+{
+ // The argument is the consumer
+ mlt_consumer this = arg;
+
+ // Get the properties of the consumer
+ mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
+
+ // Get the width and height
+ int width = mlt_properties_get_int( properties, "width" );
+ int height = mlt_properties_get_int( properties, "height" );
+ mlt_image_format format = this->format;
+
+ // See if video is turned off
+ int video_off = mlt_properties_get_int( properties, "video_off" );
+ int preview_off = mlt_properties_get_int( properties, "preview_off" );
+ int preview_format = mlt_properties_get_int( properties, "preview_format" );
+
+ // General frame variable
+ mlt_frame frame = NULL;
+ uint8_t *image = NULL;
+
+ if ( preview_off && preview_format != 0 )
+ format = preview_format;
+
+ // Continue to read ahead
+ while ( this->ahead )
+ {
+ // Get the next unprocessed frame from the work queue
+ pthread_mutex_lock( &this->queue_mutex );
+ int index = first_unprocessed_frame( this );
+ while ( this->ahead && index >= mlt_deque_count( this->queue ) )
+ {
+ mlt_log_debug( MLT_CONSUMER_SERVICE(this), "waiting in worker index = %d queue count = %d\n",
+ index, mlt_deque_count( this->queue ) );
+ pthread_cond_wait( &this->queue_cond, &this->queue_mutex );
+ index = first_unprocessed_frame( this );
+ }
+ pthread_mutex_unlock( &this->queue_mutex );
+
+ // Mark the frame for processing
+ frame = mlt_deque_peek( this->queue, index );
+ if ( frame )
+ {
+ mlt_log_debug( MLT_CONSUMER_SERVICE(this), "worker processing index = %d frame %d queue count = %d\n",
+ index, mlt_frame_get_position(frame), mlt_deque_count( this->queue ) );
+ frame->is_processing = 1;
+ mlt_properties_inc_ref( MLT_FRAME_PROPERTIES( frame ) );
+ }
+
+ // If there's no frame, we're probably stopped...
+ if ( frame == NULL )
+ continue;
+
+#ifdef DEINTERLACE_ON_NOT_NORMAL_SPEED
+ // All non normal playback frames should be shown
+ if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "_speed" ) != 1 )
+ mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "consumer_deinterlace", 1 );
+#endif
+
+ // Get the image
+ if ( !video_off )
+ {
+ // Fetch width/height again
+ width = mlt_properties_get_int( properties, "width" );
+ height = mlt_properties_get_int( properties, "height" );
+ mlt_events_fire( MLT_CONSUMER_PROPERTIES( this ), "consumer-frame-render", frame, NULL );
+ mlt_frame_get_image( frame, &image, &format, &width, &height, 0 );
+ }
+ mlt_frame_close( frame );
+ mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
+
+ // Tell a waiting thread (non-realtime main consumer thread) that we are done.
+ pthread_mutex_lock( &this->done_mutex );
+ pthread_cond_broadcast( &this->done_cond );
+ pthread_mutex_unlock( &this->done_mutex );
+ }
+
+ return NULL;
+}
+
+/** Start the read/render thread.
+ *
+ * \private \memberof mlt_consumer_s
+ * \param this a consumer
+ */
+
static void consumer_read_ahead_start( mlt_consumer this )
{
- pthread_attr_t thread_attributes;
-
// We're running now
this->ahead = 1;
// Create the frame queue
this->queue = mlt_deque_init( );
- // Create the mutex
- pthread_mutex_init( &this->mutex, NULL );
+ // Create the queue mutex
+ pthread_mutex_init( &this->queue_mutex, NULL );
// Create the condition
- pthread_cond_init( &this->cond, NULL );
+ pthread_cond_init( &this->queue_cond, NULL );
+
+ // Create the read ahead
+ if ( mlt_properties_get( MLT_CONSUMER_PROPERTIES( this ), "priority" ) )
+ {
+ struct sched_param priority;
+ priority.sched_priority = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( this ), "priority" );
+ pthread_attr_t thread_attributes;
+ pthread_attr_init( &thread_attributes );
+ pthread_attr_setschedpolicy( &thread_attributes, SCHED_OTHER );
+ pthread_attr_setschedparam( &thread_attributes, &priority );
+ pthread_attr_setinheritsched( &thread_attributes, PTHREAD_EXPLICIT_SCHED );
+ pthread_attr_setscope( &thread_attributes, PTHREAD_SCOPE_SYSTEM );
+ if ( pthread_create( &this->ahead_thread, &thread_attributes, consumer_read_ahead_thread, this ) < 0 )
+ pthread_create( &this->ahead_thread, NULL, consumer_read_ahead_thread, this );
+ pthread_attr_destroy( &thread_attributes );
+ }
+ else
+ {
+ pthread_create( &this->ahead_thread, NULL, consumer_read_ahead_thread, this );
+ }
+}
- // Inherit the scheduling priority
- pthread_attr_init( &thread_attributes );
- pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
+/** Start the worker threads.
+ *
+ * \private \memberof mlt_consumer_s
+ * \param this a consumer
+ */
+
+static void consumer_work_start( mlt_consumer this )
+{
+ int n = abs( this->real_time );
+ pthread_t thread;
+
+ // We're running now
+ this->ahead = 1;
+
+ // These keep track of the accelleration of frame dropping or recovery.
+ this->consecutive_dropped = 0;
+ this->consecutive_rendered = 0;
- // Create the read ahead
- pthread_create( &this->ahead_thread, &thread_attributes, consumer_read_ahead_thread, this );
+ // This is the position in the queue from which to look for a frame to process.
+ // If we always start from the head, then we may likely not complete processing
+ // before the frame is played out.
+ this->process_head = 0;
+
+ // Create the queues
+ this->queue = mlt_deque_init();
+ this->worker_threads = mlt_deque_init();
+
+ // Create the mutexes
+ pthread_mutex_init( &this->queue_mutex, NULL );
+ pthread_mutex_init( &this->done_mutex, NULL );
+
+ // Create the conditions
+ pthread_cond_init( &this->queue_cond, NULL );
+ pthread_cond_init( &this->done_cond, NULL );
+
+ // Create the read ahead
+ if ( mlt_properties_get( MLT_CONSUMER_PROPERTIES( this ), "priority" ) )
+ {
+
+ struct sched_param priority;
+ pthread_attr_t thread_attributes;
+
+ priority.sched_priority = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( this ), "priority" );
+ pthread_attr_init( &thread_attributes );
+ pthread_attr_setschedpolicy( &thread_attributes, SCHED_OTHER );
+ pthread_attr_setschedparam( &thread_attributes, &priority );
+ pthread_attr_setinheritsched( &thread_attributes, PTHREAD_EXPLICIT_SCHED );
+ pthread_attr_setscope( &thread_attributes, PTHREAD_SCOPE_SYSTEM );
+
+ while ( n-- )
+ {
+ if ( pthread_create( &thread, &thread_attributes, consumer_read_ahead_thread, this ) < 0 )
+ if ( pthread_create( &thread, NULL, consumer_read_ahead_thread, this ) == 0 )
+ mlt_deque_push_back( this->worker_threads, (void*) thread );
+ }
+ pthread_attr_destroy( &thread_attributes );
+ }
+
+ else
+ {
+ while ( n-- )
+ {
+ if ( pthread_create( &thread, NULL, consumer_worker_thread, this ) == 0 )
+ mlt_deque_push_back( this->worker_threads, (void*) thread );
+ }
+ }
}
+/** Stop the read/render thread.
+ *
+ * \private \memberof mlt_consumer_s
+ * \param this a consumer
+ */
+
static void consumer_read_ahead_stop( mlt_consumer this )
{
// Make sure we're running
this->ahead = 0;
// Broadcast to the condition in case it's waiting
- pthread_mutex_lock( &this->mutex );
- pthread_cond_broadcast( &this->cond );
- pthread_mutex_unlock( &this->mutex );
+ pthread_mutex_lock( &this->queue_mutex );
+ pthread_cond_broadcast( &this->queue_cond );
+ pthread_mutex_unlock( &this->queue_mutex );
// Broadcast to the put condition in case it's waiting
pthread_mutex_lock( &this->put_mutex );
// Join the thread
pthread_join( this->ahead_thread, NULL );
- // Destroy the mutex
- pthread_mutex_destroy( &this->mutex );
+ // Destroy the frame queue mutex
+ pthread_mutex_destroy( &this->queue_mutex );
// Destroy the condition
- pthread_cond_destroy( &this->cond );
+ pthread_cond_destroy( &this->queue_cond );
// Wipe the queue
while ( mlt_deque_count( this->queue ) )
}
}
+/** Stop the worker threads.
+ *
+ * \private \memberof mlt_consumer_s
+ * \param this a consumer
+ */
+
+static void consumer_work_stop( mlt_consumer this )
+{
+ // Make sure we're running
+ if ( this->ahead )
+ {
+ // Inform thread to stop
+ this->ahead = 0;
+
+ // Broadcast to the queue condition in case it's waiting
+ pthread_mutex_lock( &this->queue_mutex );
+ pthread_cond_broadcast( &this->queue_cond );
+ pthread_mutex_unlock( &this->queue_mutex );
+
+ // Broadcast to the put condition in case it's waiting
+ pthread_mutex_lock( &this->put_mutex );
+ pthread_cond_broadcast( &this->put_cond );
+ pthread_mutex_unlock( &this->put_mutex );
+
+ // Join the threads
+ pthread_t thread;
+ while ( ( thread = (pthread_t) mlt_deque_pop_front( this->worker_threads ) ) )
+ pthread_join( thread, NULL );
+
+ // Destroy the mutexes
+ pthread_mutex_destroy( &this->queue_mutex );
+ pthread_mutex_destroy( &this->done_mutex );
+
+ // Destroy the conditions
+ pthread_cond_destroy( &this->queue_cond );
+ pthread_cond_destroy( &this->done_cond );
+
+ // Wipe the queues
+ while ( mlt_deque_count( this->queue ) )
+ mlt_frame_close( mlt_deque_pop_back( this->queue ) );
+
+ // Close the queues
+ mlt_deque_close( this->queue );
+ mlt_deque_close( this->worker_threads );
+ }
+}
+
+/** Flush the read/render thread's buffer.
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ */
+
void mlt_consumer_purge( mlt_consumer this )
{
if ( this->ahead )
{
- pthread_mutex_lock( &this->mutex );
+ pthread_mutex_lock( &this->queue_mutex );
while ( mlt_deque_count( this->queue ) )
mlt_frame_close( mlt_deque_pop_back( this->queue ) );
- pthread_cond_broadcast( &this->cond );
- pthread_mutex_unlock( &this->mutex );
+ pthread_cond_broadcast( &this->queue_cond );
+ pthread_mutex_unlock( &this->queue_mutex );
}
}
+/** Use multiple worker threads and a work queue.
+ */
+
+static mlt_frame worker_get_frame( mlt_consumer this, mlt_properties properties )
+{
+ // Frame to return
+ mlt_frame frame = NULL;
+
+ int size = abs( this->real_time );
+ int buffer = mlt_properties_get_int( properties, "buffer" );
+ // This is a heuristic to determine a suitable minimum buffer size for the number of threads.
+ int headroom = 2 + size * size;
+ buffer = buffer < headroom ? headroom : buffer;
+
+ // Start worker threads if not already started.
+ if ( ! this->ahead )
+ {
+ int prefill = mlt_properties_get_int( properties, "prefill" );
+ prefill = prefill > 0 && prefill < buffer ? prefill : buffer;
+
+ consumer_work_start( this );
+
+ // Fill the work queue.
+ int i = buffer;
+ while ( i-- )
+ {
+ frame = mlt_consumer_get_frame( this );
+ if ( frame )
+ {
+ pthread_mutex_lock( &this->queue_mutex );
+ mlt_deque_push_back( this->queue, frame );
+ pthread_cond_signal( &this->queue_cond );
+ pthread_mutex_unlock( &this->queue_mutex );
+ }
+ }
+
+ // Wait for prefill
+ while ( this->ahead && first_unprocessed_frame( this ) < prefill )
+ {
+ pthread_mutex_lock( &this->done_mutex );
+ pthread_cond_wait( &this->done_cond, &this->done_mutex );
+ pthread_mutex_unlock( &this->done_mutex );
+ }
+ this->process_head = size;
+ }
+
+ mlt_log_debug( MLT_CONSUMER_SERVICE(this), "size %d done count %d work count %d process_head %d\n",
+ size, first_unprocessed_frame( this ), mlt_deque_count( this->queue ), this->process_head );
+
+ // Feed the work queue
+ frame = mlt_consumer_get_frame( this );
+ if ( ! frame )
+ return frame;
+ pthread_mutex_lock( &this->queue_mutex );
+ mlt_deque_push_back( this->queue, frame );
+ pthread_cond_signal( &this->queue_cond );
+ pthread_mutex_unlock( &this->queue_mutex );
+
+ // Wait if not realtime.
+ while( this->ahead && this->real_time < 0 &&
+ ! mlt_properties_get_int( MLT_FRAME_PROPERTIES( MLT_FRAME( mlt_deque_peek_front( this->queue ) ) ), "rendered" ) )
+ {
+ pthread_mutex_lock( &this->done_mutex );
+ pthread_cond_wait( &this->done_cond, &this->done_mutex );
+ pthread_mutex_unlock( &this->done_mutex );
+ }
+
+ // Get the frame from the queue.
+ pthread_mutex_lock( &this->queue_mutex );
+ frame = mlt_deque_pop_front( this->queue );
+ pthread_mutex_unlock( &this->queue_mutex );
+
+ // Adapt the worker process head to the runtime conditions.
+ if ( this->real_time > 0 )
+ {
+ if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "rendered" ) )
+ {
+ this->consecutive_dropped = 0;
+ if ( this->process_head > size && this->consecutive_rendered >= this->process_head )
+ this->process_head--;
+ else
+ this->consecutive_rendered++;
+ }
+ else
+ {
+ this->consecutive_rendered = 0;
+ if ( this->process_head < buffer - size && this->consecutive_dropped > size )
+ this->process_head++;
+ else
+ this->consecutive_dropped++;
+ }
+ mlt_log_debug( MLT_CONSUMER_SERVICE(this), "dropped %d rendered %d process_head %d\n",
+ this->consecutive_dropped, this->consecutive_rendered, this->process_head );
+ }
+
+ return frame;
+}
+
+/** Get the next frame from the producer connected to a consumer.
+ *
+ * Typically, one uses this instead of \p mlt_consumer_get_frame to make
+ * the asynchronous/real-time behavior configurable at runtime.
+ * You should close the frame returned from this when you are done with it.
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ * \return a frame
+ */
+
mlt_frame mlt_consumer_rt_frame( mlt_consumer this )
{
// Frame to return
mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
// Check if the user has requested real time or not
- if ( this->real_time )
+ if ( this->real_time > 1 || this->real_time < -1 )
+ {
+ // see above
+ return worker_get_frame( this, properties );
+ }
+ else if ( this->real_time == 1 || this->real_time == -1 )
{
int size = 1;
if ( buffer > 1 )
size = prefill > 0 && prefill < buffer ? prefill : buffer;
}
-
+
// Get frame from queue
- pthread_mutex_lock( &this->mutex );
+ pthread_mutex_lock( &this->queue_mutex );
while( this->ahead && mlt_deque_count( this->queue ) < size )
- pthread_cond_wait( &this->cond, &this->mutex );
+ pthread_cond_wait( &this->queue_cond, &this->queue_mutex );
frame = mlt_deque_pop_front( this->queue );
- pthread_cond_broadcast( &this->cond );
- pthread_mutex_unlock( &this->mutex );
+ pthread_cond_broadcast( &this->queue_cond );
+ pthread_mutex_unlock( &this->queue_mutex );
}
- else
+ else // real_time == 0
{
// Get the frame in non real time
frame = mlt_consumer_get_frame( this );
}
/** Callback for the implementation to indicate a stopped condition.
-*/
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ */
void mlt_consumer_stopped( mlt_consumer this )
{
mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( this ), "running", 0 );
mlt_events_fire( MLT_CONSUMER_PROPERTIES( this ), "consumer-stopped", NULL );
+ mlt_event_unblock( this->event_listener );
}
/** Stop the consumer.
-*/
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ * \return true if there was an error
+ */
int mlt_consumer_stop( mlt_consumer this )
{
// Get the properies
mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
- char *debug = mlt_properties_get( MLT_CONSUMER_PROPERTIES( this ), "debug" );
// Just in case...
- if ( debug ) fprintf( stderr, "%s: stopping put waiting\n", debug );
+ mlt_log( MLT_CONSUMER_SERVICE( this ), MLT_LOG_DEBUG, "stopping put waiting\n" );
pthread_mutex_lock( &this->put_mutex );
this->put_active = 0;
pthread_cond_broadcast( &this->put_cond );
pthread_mutex_unlock( &this->put_mutex );
// Stop the consumer
- if ( debug ) fprintf( stderr, "%s: stopping consumer\n", debug );
+ mlt_log( MLT_CONSUMER_SERVICE( this ), MLT_LOG_DEBUG, "stopping consumer\n" );
if ( this->stop != NULL )
this->stop( this );
// Check if the user has requested real time or not and stop if necessary
- if ( debug ) fprintf( stderr, "%s: stopping read_ahead\n", debug );
- if ( mlt_properties_get_int( properties, "real_time" ) )
+ mlt_log( MLT_CONSUMER_SERVICE( this ), MLT_LOG_DEBUG, "stopping read_ahead\n" );
+ if ( abs( this->real_time ) == 1 )
consumer_read_ahead_stop( this );
+ else if ( abs( this->real_time ) > 1 )
+ consumer_work_stop( this );
// Kill the test card
mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
// Check and run a post command
if ( mlt_properties_get( properties, "post" ) )
- system( mlt_properties_get( properties, "post" ) );
+ if (system( mlt_properties_get( properties, "post" ) ) == -1 )
+ mlt_log( MLT_CONSUMER_SERVICE( this ), MLT_LOG_ERROR, "system(%s) failed!\n", mlt_properties_get( properties, "post" ) );
- if ( debug ) fprintf( stderr, "%s: stopped\n", debug );
+ mlt_log( MLT_CONSUMER_SERVICE( this ), MLT_LOG_DEBUG, "stopped\n" );
return 0;
}
/** Determine if the consumer is stopped.
-*/
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ * \return true if the consumer is stopped
+ */
int mlt_consumer_is_stopped( mlt_consumer this )
{
return 0;
}
-/** Close the consumer.
-*/
+/** Close and destroy the consumer.
+ *
+ * \public \memberof mlt_consumer_s
+ * \param this a consumer
+ */
void mlt_consumer_close( mlt_consumer this )
{
}
}
}
+
+/** Get the position of the last frame shown.
+ *
+ * \public \memberof mlt_consumer_s
+ * \param consumer a consumer
+ * \return the position
+ */
+
+mlt_position mlt_consumer_position( mlt_consumer consumer )
+{
+ return consumer->position;
+}
+
projects / mlt / blobdiff