3 * \brief video output definition
6 * Copyright (C) 2007-2009 Ushodaya Enterprises Limited
7 * \author Dan Dennedy <dan@dennedy.org>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include "mlt_profile.h"
25 #include "mlt_factory.h"
26 #include "mlt_properties.h"
33 /** the default subdirectory of the prefix for holding profiles */
34 #define PROFILES_DIR "/share/mlt/profiles/"
36 /** Load a profile from the system folder.
38 * The environment variable MLT_PROFILES_PATH overrides the default \p PROFILES_DIR.
40 * \private \memberof mlt_profile_s
41 * \param name the name of a profile settings file located in the standard location or
42 * the full path name to a profile settings file
43 * \return a profile or NULL on error
46 static mlt_profile mlt_profile_select( const char *name )
48 char *filename = NULL;
49 const char *prefix = getenv( "MLT_PROFILES_PATH" );
50 mlt_properties properties = mlt_properties_load( name );
51 mlt_profile profile = NULL;
53 // Try to load from file specification
54 if ( properties && mlt_properties_get_int( properties, "width" ) )
56 filename = calloc( 1, strlen( name ) + 1 );
58 // Load from $prefix/share/mlt/profiles
59 else if ( prefix == NULL )
62 filename = calloc( 1, strlen( prefix ) + strlen( PROFILES_DIR ) + strlen( name ) + 2 );
63 strcpy( filename, prefix );
64 if ( filename[ strlen( filename ) - 1 ] != '/' )
65 filename[ strlen( filename ) ] = '/';
66 strcat( filename, PROFILES_DIR );
68 // Use environment variable instead
71 filename = calloc( 1, strlen( prefix ) + strlen( name ) + 2 );
72 strcpy( filename, prefix );
73 if ( filename[ strlen( filename ) - 1 ] != '/' )
74 filename[ strlen( filename ) ] = '/';
78 strcat( filename, name );
79 profile = mlt_profile_load_file( filename );
82 mlt_properties_close( properties );
88 /** Construct a profile.
90 * This will never return NULL as it uses the dv_pal settings as hard-coded fallback default.
92 * \public \memberof mlt_profile_s
93 * \param name the name of a profile settings file located in the standard location or
94 * the full path name to a profile settings file
98 mlt_profile mlt_profile_init( const char *name )
100 mlt_profile profile = NULL;
102 // Explicit profile by name gets priority over environment variables
104 profile = mlt_profile_select( name );
106 // Try to load by environment variable
107 if ( profile == NULL )
109 // MLT_PROFILE is preferred environment variable
110 if ( getenv( "MLT_PROFILE" ) )
111 profile = mlt_profile_select( getenv( "MLT_PROFILE" ) );
112 // MLT_NORMALISATION backwards compatibility
113 else if ( getenv( "MLT_NORMALISATION" ) && strcmp( getenv( "MLT_NORMALISATION" ), "PAL" ) )
114 profile = mlt_profile_select( "dv_ntsc" );
116 profile = mlt_profile_select( "dv_pal" );
118 // If still not loaded (no profile files), default to PAL
119 if ( profile == NULL )
121 profile = calloc( 1, sizeof( struct mlt_profile_s ) );
124 mlt_environment_set( "MLT_PROFILE", "dv_pal" );
125 profile->description = strdup( "PAL 4:3 DV or DVD" );
126 profile->frame_rate_num = 25;
127 profile->frame_rate_den = 1;
128 profile->width = 720;
129 profile->height = 576;
130 profile->progressive = 0;
131 profile->sample_aspect_num = 16;
132 profile->sample_aspect_den = 15;
133 profile->display_aspect_num = 4;
134 profile->display_aspect_den = 3;
135 profile->colorspace = 601;
142 static void set_mlt_normalisation( const char *profile_name )
146 if ( strstr( profile_name, "_ntsc" ) ||
147 strstr( profile_name, "_60" ) ||
148 strstr( profile_name, "_5994" ) ||
149 strstr( profile_name, "_2997" ) ||
150 strstr( profile_name, "_30" ) )
152 mlt_environment_set( "MLT_NORMALISATION", "NTSC" );
154 else if ( strstr( profile_name, "_pal" ) ||
155 strstr( profile_name, "_50" ) ||
156 strstr( profile_name, "_25" ) )
158 mlt_environment_set( "MLT_NORMALISATION", "PAL" );
163 /** Load a profile from specific file.
165 * \public \memberof mlt_profile_s
166 * \param file the full path name to a properties file
167 * \return a profile or NULL on error
170 mlt_profile mlt_profile_load_file( const char *file )
172 mlt_profile profile = NULL;
174 // Load the profile as properties
175 mlt_properties properties = mlt_properties_load( file );
178 // Simple check if the profile is valid
179 if ( mlt_properties_get_int( properties, "width" ) )
181 profile = mlt_profile_load_properties( properties );
183 // Set MLT_PROFILE to basename
184 char *filename = strdup( file );
185 mlt_environment_set( "MLT_PROFILE", basename( filename ) );
186 set_mlt_normalisation( basename( filename ) );
189 mlt_properties_close( properties );
192 // Set MLT_NORMALISATION to appease legacy modules
193 char *profile_name = mlt_environment( "MLT_PROFILE" );
194 set_mlt_normalisation( profile_name );
198 /** Load a profile from a properties object.
200 * \public \memberof mlt_profile_s
201 * \param properties a properties list
202 * \return a profile or NULL if out of memory
205 mlt_profile mlt_profile_load_properties( mlt_properties properties )
207 mlt_profile profile = calloc( 1, sizeof( struct mlt_profile_s ) );
210 if ( mlt_properties_get( properties, "name" ) )
211 mlt_environment_set( "MLT_PROFILE", mlt_properties_get( properties, "name" ) );
212 if ( mlt_properties_get( properties, "description" ) )
213 profile->description = strdup( mlt_properties_get( properties, "description" ) );
214 profile->frame_rate_num = mlt_properties_get_int( properties, "frame_rate_num" );
215 profile->frame_rate_den = mlt_properties_get_int( properties, "frame_rate_den" );
216 profile->width = mlt_properties_get_int( properties, "width" );
217 profile->height = mlt_properties_get_int( properties, "height" );
218 profile->progressive = mlt_properties_get_int( properties, "progressive" );
219 profile->sample_aspect_num = mlt_properties_get_int( properties, "sample_aspect_num" );
220 profile->sample_aspect_den = mlt_properties_get_int( properties, "sample_aspect_den" );
221 profile->display_aspect_num = mlt_properties_get_int( properties, "display_aspect_num" );
222 profile->display_aspect_den = mlt_properties_get_int( properties, "display_aspect_den" );
223 profile->colorspace = mlt_properties_get_int( properties, "colorspace" );
228 /** Load an anonymous profile from string.
230 * \public \memberof mlt_profile_s
231 * \param string a newline-delimited list of properties as name=value pairs
232 * \return a profile or NULL if out of memory
235 mlt_profile mlt_profile_load_string( const char *string )
237 mlt_properties properties = mlt_properties_new();
240 const char *p = string;
243 if ( strcmp( p, "" ) && p[ 0 ] != '#' )
244 mlt_properties_parse( properties, p );
245 p = strchr( p, '\n' );
249 return mlt_profile_load_properties( properties );
252 /** Get the video frame rate as a floating point value.
254 * \public \memberof mlt_profile_s
255 * @param profile a profile
256 * @return the frame rate
259 double mlt_profile_fps( mlt_profile profile )
262 return ( double ) profile->frame_rate_num / profile->frame_rate_den;
267 /** Get the sample aspect ratio as a floating point value.
269 * \public \memberof mlt_profile_s
270 * \param profile a profile
271 * \return the pixel aspect ratio
274 double mlt_profile_sar( mlt_profile profile )
277 return ( double ) profile->sample_aspect_num / profile->sample_aspect_den;
282 /** Get the display aspect ratio as floating point value.
284 * \public \memberof mlt_profile_s
285 * \param profile a profile
286 * \return the image aspect ratio
289 double mlt_profile_dar( mlt_profile profile )
292 return ( double ) profile->display_aspect_num / profile->display_aspect_den;
297 /** Free up the global profile resources.
299 * \public \memberof mlt_profile_s
300 * \param profile a profile
303 void mlt_profile_close( mlt_profile profile )
307 if ( profile->description )
308 free( profile->description );
309 profile->description = NULL;
315 /** Make a copy of a profile.
317 * \public \memberof mlt_profile_s
318 * \param profile the profile to clone
319 * \return a copy of the profile
322 mlt_profile mlt_profile_clone( mlt_profile profile )
324 mlt_profile clone = NULL;
328 clone = calloc( 1, sizeof( *profile ) );
331 memcpy( clone, profile, sizeof( *profile ) );
332 clone->description = strdup( profile->description );
339 /** Get the list of profiles.
341 * The caller MUST free the returned properties object!
342 * Each entry in the list is keyed on its name, and its value is another
343 * properties object that contains the attributes of the profile.
344 * \public \memberof mlt_profile_s
345 * \return a list of profiles
348 mlt_properties mlt_profile_list( )
350 char *filename = NULL;
351 const char *prefix = getenv( "MLT_PROFILES_PATH" );
352 mlt_properties properties = mlt_properties_new();
353 mlt_properties dir = mlt_properties_new();
355 const char *wildcard = NULL;
358 // Load from $prefix/share/mlt/profiles if no env var
359 if ( prefix == NULL )
362 filename = calloc( 1, strlen( prefix ) + strlen( PROFILES_DIR ) + 2 );
363 strcpy( filename, prefix );
364 if ( filename[ strlen( filename ) - 1 ] != '/' )
365 filename[ strlen( filename ) ] = '/';
366 strcat( filename, PROFILES_DIR );
370 mlt_properties_dir_list( dir, prefix, wildcard, sort );
372 for ( i = 0; i < mlt_properties_count( dir ); i++ )
374 char *filename = mlt_properties_get_value( dir, i );
375 char *profile_name = basename( filename );
376 if ( profile_name[0] != '.' && strcmp( profile_name, "Makefile" ) &&
377 profile_name[ strlen( profile_name ) - 1 ] != '~' )
379 mlt_properties profile = mlt_properties_load( filename );
382 mlt_properties_set_data( properties, profile_name, profile, 0,
383 (mlt_destructor) mlt_properties_close, NULL );
387 mlt_properties_close( dir );