framework/Makefile, metaschema.yaml: add a Kwalify schema for metadata
[melted] / src / framework / mlt_consumer.c
index 5b48e6d..83ef8ff 100644 (file)
@@ -3,26 +3,27 @@
  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
  * Author: Charles Yates <charles.yates@pandora.be>
  *
- * 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.
+ * 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 program is distributed in the hope that it will be useful,
+ * 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 <stdio.h>
 #include <string.h>
 #include <stdlib.h>
 
 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_service owner, mlt_consumer this, char *name );
+static void apply_profile_properties( mlt_consumer this, mlt_profile profile, mlt_properties properties );
 
 /** Public final methods
 */
 
-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 ) );
@@ -44,43 +47,17 @@ int mlt_consumer_init( mlt_consumer this, void *child )
        {
                // 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" ) )
-               {
-                       mlt_properties_set( properties, "normalisation", "PAL" );
-                       mlt_properties_set_double( properties, "fps", 25.0 );
-                       mlt_properties_set_int( properties, "frame_rate_num", 25 );
-                       mlt_properties_set_int( properties, "frame_rate_den", 1 );
-                       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 );
-                       mlt_properties_set_int( properties, "aspect_ratio_num", 59 );
-                       mlt_properties_set_int( properties, "aspect_ratio_den", 54 );
-                       mlt_properties_set_double( properties, "display_ratio", 4.0 / 3.0 );
-                       mlt_properties_set_int( properties, "display_ratio_num", 4 );
-                       mlt_properties_set_int( properties, "display_ratio_den", 3 );
-               }
-               else
+       
+               // Apply profile to properties
+               if ( profile == NULL )
                {
-                       mlt_properties_set( properties, "normalisation", "NTSC" );
-                       mlt_properties_set_double( properties, "fps", 30000.0 / 1001.0 );
-                       mlt_properties_set_int( properties, "frame_rate_num", 30000 );
-                       mlt_properties_set_int( properties, "frame_rate_den", 1001 );
-                       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 );
-                       mlt_properties_set_int( properties, "aspect_ratio_num", 10 );
-                       mlt_properties_set_int( properties, "aspect_ratio_den", 11 );
-                       mlt_properties_set_double( properties, "display_ratio", 4.0 / 3.0 );
-                       mlt_properties_set_int( properties, "display_ratio_num", 4 );
-                       mlt_properties_set_int( properties, "display_ratio_den", 3 );
+                       // 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" );
@@ -105,6 +82,10 @@ int mlt_consumer_init( mlt_consumer this, void *child )
                mlt_events_register( properties, "consumer-frame-render", ( mlt_transmitter )mlt_consumer_frame_render );
                mlt_events_register( properties, "consumer-stopped", NULL );
 
+               // 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 );
                pthread_cond_init( &this->put_cond, NULL );
@@ -113,6 +94,135 @@ int mlt_consumer_init( mlt_consumer this, void *child )
        return error;
 }
 
+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_event_unblock( this->event_listener );
+}
+
+static void mlt_consumer_property_changed( mlt_service 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 )  );
+               }
+       }
+}
+
 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
 {
        if ( listener != NULL )
@@ -128,14 +238,14 @@ static void mlt_consumer_frame_render( mlt_listener listener, mlt_properties own
 /** Create 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;
@@ -170,22 +280,15 @@ int mlt_consumer_connect( mlt_consumer this, mlt_service producer )
 
 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 );
 
        // Determine if there's a test card producer
        char *test_card = mlt_properties_get( properties, "test_card" );
 
-       // Handle profiles
-       char *profile = mlt_properties_get( properties, "profile" );
-       int profile_ok = mlt_consumer_profile( properties, profile );
-
-       // Check that everything is OK
-       if ( !profile_ok )
-               fprintf( stderr, "Unrecognised profile %s - continuing with defaults.\n", mlt_properties_get( properties, "profile" ) );
-       else if ( profile_ok < 0 )
-               fprintf( stderr, "Recognised profile %s with warnings - trying to continue with some defaults.\n", mlt_properties_get( properties, "profile" ) );
-
        // Just to make sure nothing is hanging around...
        mlt_frame_close( this->put );
        this->put = NULL;
@@ -197,7 +300,8 @@ int mlt_consumer_start( mlt_consumer 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 )
@@ -310,7 +414,7 @@ mlt_frame mlt_consumer_get_frame( mlt_consumer this )
        }
        else
        {
-               frame = mlt_frame_init( );
+               frame = mlt_frame_init( service );
        }
 
        if ( frame != NULL )
@@ -347,168 +451,6 @@ static inline long time_difference( struct timeval *time1 )
        return time1->tv_sec * 1000000 + time1->tv_usec - time2.tv_sec * 1000000 - time2.tv_usec;
 }
 
-int mlt_consumer_profile( mlt_properties properties, char *profile )
-{
-       double fps = mlt_properties_get_double( properties, "fps" );
-       int recognised = 1;
-       double display_num = 0;
-       double display_den = 0;
-       double pixel_num = 0;
-       double pixel_den = 0;
-       int width = 0;
-       int height = 0;
-
-       if ( fps == 25.0 && profile != NULL )
-       {
-               width = 720;
-               height = 576;
-               display_num = 4;
-               display_den = 3;
-               pixel_num = 59;
-               pixel_den = 54;
-
-               if ( !strcmp( profile, "dv_wide" ) )
-               {
-                       display_num = 16;
-                       display_den = 9;
-                       pixel_num = 118;
-                       pixel_den = 81;
-               }
-               else if ( !strncmp( profile, "square_wide", 11 ) )
-               {
-                       display_num = 16;
-                       display_den = 9;
-                       pixel_num = 1;
-                       pixel_den = 1;
-                       width = 1024;
-                       height = 576;
-               }
-               else if ( !strncmp( profile, "square", 6 ) )
-               {
-                       pixel_num = 1;
-                       pixel_den = 1;
-                       width = 768;
-                       height = 576;
-               }
-               else if ( !strncmp( profile, "vcd", 3 ) )
-               {
-                       width = 352;
-                       height = 288;
-               }
-               else if ( !strncmp( profile, "cvd", 3 ) )
-               {
-                       width = 352;
-                       height = 576;
-                       pixel_num = 59;
-                       pixel_den = 27;
-               }
-               else if ( !strncmp( profile, "svcd_wide", 9 ) )
-               {
-                       width = 480;
-                       height = 576;
-                       pixel_num = 59;
-                       pixel_den = 27;
-                       display_num = 16;
-                       display_den = 9;
-               }
-               else if ( !strncmp( profile, "svcd", 4 ) )
-               {
-                       width = 480;
-                       height = 576;
-                       pixel_num = 59;
-                       pixel_den = 36;
-               }
-               else if ( strncmp( profile, "frame", 5 ) && strcmp( profile, "dv" ) )
-               {
-                       recognised = 0;
-               }
-       }
-       else if ( profile != NULL )
-       {
-               width = 720;
-               height = 480;
-               display_num = 4;
-               display_den = 3;
-               pixel_num = 10;
-               pixel_den = 11;
-
-               if ( !strcmp( profile, "dv_wide" ) )
-               {
-                       display_num = 16;
-                       display_den = 9;
-                       pixel_num = 40;
-                       pixel_den = 33;
-               }
-               else if ( !strncmp( profile, "square_wide", 11 ) )
-               {
-                       display_num = 16;
-                       display_den = 9;
-                       pixel_num = 1;
-                       pixel_den = 1;
-                       width = 854;
-                       height = 480;
-               }
-               else if ( !strncmp( profile, "square", 6 ) )
-               {
-                       pixel_num = 1;
-                       pixel_den = 1;
-                       width = 640;
-                       height = 480;
-               }
-               else if ( !strncmp( profile, "vcd", 3 ) )
-               {
-                       width = 352;
-                       height = 240;
-               }
-               else if ( !strncmp( profile, "cvd", 3 ) )
-               {
-                       width = 352;
-                       height = 480;
-                       pixel_num = 20;
-                       pixel_den = 11;
-               }
-               else if ( !strncmp( profile, "svcd_wide", 9 ) )
-               {
-                       width = 480;
-                       height = 480;
-                       pixel_num = 20;
-                       pixel_den = 11;
-                       display_num = 16;
-                       display_den = 9;
-               }
-               else if ( !strncmp( profile, "svcd", 4 ) )
-               {
-                       width = 480;
-                       height = 480;
-                       pixel_num = 15;
-                       pixel_den = 11;
-               }
-               else if ( strncmp( profile, "frame", 5 ) && strcmp( profile, "dv" ) )
-               {
-                       recognised = 0;
-               }
-       }
-
-       // If width (or any of the above are 0), we use defaults otherwise we switch to recognised
-       if ( width != 0 && recognised )
-       {
-               if ( recognised && strchr( profile, ':' ) )
-                       if ( sscanf( strchr( profile, ':' ) + 1, "%dx%d", &width, &height ) != 2 )
-                               recognised = -1;
-
-               mlt_properties_set_int( properties, "width", width );
-               mlt_properties_set_int( properties, "height", height );
-               mlt_properties_set_double( properties, "aspect_ratio", pixel_num / pixel_den );
-               mlt_properties_set_int( properties, "aspect_ratio_num", pixel_num );
-               mlt_properties_set_int( properties, "aspect_ratio_den", pixel_den );
-               mlt_properties_set_double( properties, "display_ratio", display_num / display_den );
-               mlt_properties_set_int( properties, "display_ratio_num", display_num );
-               mlt_properties_set_int( properties, "display_ratio_den", display_den );
-       }
-
-       return recognised;
-}
-
 static void *consumer_read_ahead_thread( void *arg )
 {
        // The argument is the consumer
@@ -523,6 +465,8 @@ static void *consumer_read_ahead_thread( void *arg )
 
        // 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;
@@ -555,6 +499,9 @@ static void *consumer_read_ahead_thread( void *arg )
        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 );
 
@@ -633,7 +580,7 @@ static void *consumer_read_ahead_thread( void *arg )
                }
 
                // 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 )
@@ -801,6 +748,7 @@ 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.