X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_profile.c;h=3c016263e881353545caa3d8be2fa133df197d93;hb=f4d4669b66a9f23be85527f65dec19a566db561c;hp=b9e230f68b834d5b85fdf72a2e1823c8e5de77b5;hpb=1a16869c02718e42807618ed5c7a37478dd9577c;p=melted diff --git a/src/framework/mlt_profile.c b/src/framework/mlt_profile.c index b9e230f..3c01626 100644 --- a/src/framework/mlt_profile.c +++ b/src/framework/mlt_profile.c @@ -1,7 +1,10 @@ -/* - * mlt_profile.c -- video output definition - * Copyright (C) 2007 Ushodaya Enterprises Limited - * Author: Dan Dennedy +/** + * \file mlt_profile.c + * \brief video output definition + * \see mlt_profile_s + * + * Copyright (C) 2007-2009 Ushodaya Enterprises Limited + * \author Dan Dennedy * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -26,10 +29,19 @@ #include #include + +/** the default subdirectory of the prefix for holding profiles */ #define PROFILES_DIR "/share/mlt/profiles/" -/** Load a profile from the system folder -*/ +/** Load a profile from the system folder. + * + * The environment variable MLT_PROFILES_PATH overrides the default \p PROFILES_DIR. + * + * \private \memberof mlt_profile_s + * \param name the name of a profile settings file located in the standard location or + * the full path name to a profile settings file + * \return a profile or NULL on error + */ static mlt_profile mlt_profile_select( const char *name ) { @@ -37,7 +49,7 @@ static mlt_profile mlt_profile_select( const char *name ) const char *prefix = getenv( "MLT_PROFILES_PATH" ); mlt_properties properties = mlt_properties_load( name ); mlt_profile profile = NULL; - + // Try to load from file specification if ( properties && mlt_properties_get_int( properties, "width" ) ) { @@ -61,7 +73,7 @@ static mlt_profile mlt_profile_select( const char *name ) if ( filename[ strlen( filename ) - 1 ] != '/' ) filename[ strlen( filename ) ] = '/'; } - + // Finish loading strcat( filename, name ); profile = mlt_profile_load_file( filename ); @@ -74,7 +86,14 @@ static mlt_profile mlt_profile_select( const char *name ) } /** Construct a profile. -*/ + * + * This will never return NULL as it uses the dv_pal settings as hard-coded fallback default. + * + * \public \memberof mlt_profile_s + * @param name the name of a profile settings file located in the standard location or + * the full path name to a profile settings file + * @return a profile + */ mlt_profile mlt_profile_init( const char *name ) { @@ -109,8 +128,8 @@ mlt_profile mlt_profile_init( const char *name ) profile->width = 720; profile->height = 576; profile->progressive = 0; - profile->sample_aspect_num = 59; - profile->sample_aspect_den = 54; + profile->sample_aspect_num = 16; + profile->sample_aspect_den = 15; profile->display_aspect_num = 4; profile->display_aspect_den = 3; } @@ -119,8 +138,12 @@ mlt_profile mlt_profile_init( const char *name ) return profile; } -/** Load a profile from specific file -*/ +/** Load a profile from specific file. + * + * \public \memberof mlt_profile_s + * @param file the full path name to a properties file + * @return a profile or NULL on error + */ mlt_profile mlt_profile_load_file( const char *file ) { @@ -144,7 +167,7 @@ mlt_profile mlt_profile_load_file( const char *file ) } // Set MLT_NORMALISATION to appease legacy modules - char *profile_name = getenv( "MLT_PROFILE" ); + char *profile_name = mlt_environment( "MLT_PROFILE" ); if ( profile_name ) { if ( strstr( profile_name, "_ntsc" ) || @@ -163,8 +186,12 @@ mlt_profile mlt_profile_load_file( const char *file ) return profile; } -/** Load a profile from a properties object -*/ +/** Load a profile from a properties object. + * + * \public \memberof mlt_profile_s + * @param properties a properties list + * @return a profile or NULL if out of memory + */ mlt_profile mlt_profile_load_properties( mlt_properties properties ) { @@ -188,8 +215,12 @@ mlt_profile mlt_profile_load_properties( mlt_properties properties ) return profile; } -/** Load an anonymous profile from string -*/ +/** Load an anonymous profile from string. + * + * \public \memberof mlt_profile_s + * @param string a newline-delimited list of properties as name=value pairs + * @return a profile or NULL if out of memory + */ mlt_profile mlt_profile_load_string( const char *string ) { @@ -208,8 +239,12 @@ mlt_profile mlt_profile_load_string( const char *string ) return mlt_profile_load_properties( properties ); } -/** Get the framerate as float -*/ +/** Get the video frame rate as a floating point value. + * + * \public \memberof mlt_profile_s + * @param aprofile a profile + * @return the frame rate + */ double mlt_profile_fps( mlt_profile aprofile ) { @@ -219,8 +254,12 @@ double mlt_profile_fps( mlt_profile aprofile ) return 0; } -/** Get the sample aspect ratio as float -*/ +/** Get the sample aspect ratio as a floating point value. + * + * \public \memberof mlt_profile_s + * @param aprofile a profile + * @return the pixel aspect ratio + */ double mlt_profile_sar( mlt_profile aprofile ) { @@ -230,8 +269,12 @@ double mlt_profile_sar( mlt_profile aprofile ) return 0; } -/** Get the display aspect ratio as float -*/ +/** Get the display aspect ratio as floating point value. + * + * \public \memberof mlt_profile_s + * @param aprofile a profile + * @return the image aspect ratio + */ double mlt_profile_dar( mlt_profile aprofile ) { @@ -241,8 +284,11 @@ double mlt_profile_dar( mlt_profile aprofile ) return 0; } -/** Free up the global profile resources -*/ +/** Free up the global profile resources. + * + * \public \memberof mlt_profile_s + * @param profile a profile + */ void mlt_profile_close( mlt_profile profile ) {