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
31 /** the default subdirectory of the prefix for holding profiles */
32 #define PROFILES_DIR "/share/mlt/profiles/"
34 /** Load a profile from the system folder.
36 * The environment variable MLT_PROFILES_PATH overrides the default \p PROFILES_DIR.
38 * \private \memberof mlt_profile_s
39 * \param name the name of a profile settings file located in the standard location or
40 * the full path name to a profile settings file
41 * \return a profile or NULL on error
44 static mlt_profile mlt_profile_select( const char *name )
46 char *filename = NULL;
47 const char *prefix = getenv( "MLT_PROFILES_PATH" );
48 mlt_properties properties = mlt_properties_load( name );
49 mlt_profile profile = NULL;
51 // Try to load from file specification
52 if ( properties && mlt_properties_get_int( properties, "width" ) )
54 filename = calloc( 1, strlen( name ) + 1 );
56 // Load from $prefix/share/mlt/profiles
57 else if ( prefix == NULL )
60 filename = calloc( 1, strlen( prefix ) + strlen( PROFILES_DIR ) + strlen( name ) + 2 );
61 strcpy( filename, prefix );
62 if ( filename[ strlen( filename ) - 1 ] != '/' )
63 filename[ strlen( filename ) ] = '/';
64 strcat( filename, PROFILES_DIR );
66 // Use environment variable instead
69 filename = calloc( 1, strlen( prefix ) + strlen( name ) + 2 );
70 strcpy( filename, prefix );
71 if ( filename[ strlen( filename ) - 1 ] != '/' )
72 filename[ strlen( filename ) ] = '/';
76 strcat( filename, name );
77 profile = mlt_profile_load_file( filename );
80 mlt_properties_close( properties );
86 /** Construct a profile.
88 * This will never return NULL as it uses the dv_pal settings as hard-coded fallback default.
90 * \public \memberof mlt_profile_s
91 * \param name the name of a profile settings file located in the standard location or
92 * the full path name to a profile settings file
96 mlt_profile mlt_profile_init( const char *name )
98 mlt_profile profile = NULL;
100 // Explicit profile by name gets priority over environment variables
102 profile = mlt_profile_select( name );
104 // Try to load by environment variable
105 if ( profile == NULL )
107 // MLT_PROFILE is preferred environment variable
108 if ( getenv( "MLT_PROFILE" ) )
109 profile = mlt_profile_select( getenv( "MLT_PROFILE" ) );
110 // MLT_NORMALISATION backwards compatibility
111 else if ( getenv( "MLT_NORMALISATION" ) && strcmp( getenv( "MLT_NORMALISATION" ), "PAL" ) )
112 profile = mlt_profile_select( "dv_ntsc" );
114 profile = mlt_profile_select( "dv_pal" );
116 // If still not loaded (no profile files), default to PAL
117 if ( profile == NULL )
119 profile = calloc( 1, sizeof( struct mlt_profile_s ) );
122 mlt_environment_set( "MLT_PROFILE", "dv_pal" );
123 profile->description = strdup( "PAL 4:3 DV or DVD" );
124 profile->frame_rate_num = 25;
125 profile->frame_rate_den = 1;
126 profile->width = 720;
127 profile->height = 576;
128 profile->progressive = 0;
129 profile->sample_aspect_num = 16;
130 profile->sample_aspect_den = 15;
131 profile->display_aspect_num = 4;
132 profile->display_aspect_den = 3;
133 profile->colorspace = 601;
140 static void set_mlt_normalisation( const char *profile_name )
144 if ( strstr( profile_name, "_ntsc" ) ||
145 strstr( profile_name, "_60" ) ||
146 strstr( profile_name, "_5994" ) ||
147 strstr( profile_name, "_2997" ) ||
148 strstr( profile_name, "_30" ) )
150 mlt_environment_set( "MLT_NORMALISATION", "NTSC" );
152 else if ( strstr( profile_name, "_pal" ) ||
153 strstr( profile_name, "_50" ) ||
154 strstr( profile_name, "_25" ) )
156 mlt_environment_set( "MLT_NORMALISATION", "PAL" );
161 /** Load a profile from specific file.
163 * \public \memberof mlt_profile_s
164 * \param file the full path name to a properties file
165 * \return a profile or NULL on error
168 mlt_profile mlt_profile_load_file( const char *file )
170 mlt_profile profile = NULL;
172 // Load the profile as properties
173 mlt_properties properties = mlt_properties_load( file );
176 // Simple check if the profile is valid
177 if ( mlt_properties_get_int( properties, "width" ) )
179 profile = mlt_profile_load_properties( properties );
181 // Set MLT_PROFILE to basename
182 char *filename = strdup( file );
183 mlt_environment_set( "MLT_PROFILE", basename( filename ) );
184 set_mlt_normalisation( basename( filename ) );
187 mlt_properties_close( properties );
190 // Set MLT_NORMALISATION to appease legacy modules
191 char *profile_name = mlt_environment( "MLT_PROFILE" );
192 set_mlt_normalisation( profile_name );
196 /** Load a profile from a properties object.
198 * \public \memberof mlt_profile_s
199 * \param properties a properties list
200 * \return a profile or NULL if out of memory
203 mlt_profile mlt_profile_load_properties( mlt_properties properties )
205 mlt_profile profile = calloc( 1, sizeof( struct mlt_profile_s ) );
208 if ( mlt_properties_get( properties, "name" ) )
209 mlt_environment_set( "MLT_PROFILE", mlt_properties_get( properties, "name" ) );
210 if ( mlt_properties_get( properties, "description" ) )
211 profile->description = strdup( mlt_properties_get( properties, "description" ) );
212 profile->frame_rate_num = mlt_properties_get_int( properties, "frame_rate_num" );
213 profile->frame_rate_den = mlt_properties_get_int( properties, "frame_rate_den" );
214 profile->width = mlt_properties_get_int( properties, "width" );
215 profile->height = mlt_properties_get_int( properties, "height" );
216 profile->progressive = mlt_properties_get_int( properties, "progressive" );
217 profile->sample_aspect_num = mlt_properties_get_int( properties, "sample_aspect_num" );
218 profile->sample_aspect_den = mlt_properties_get_int( properties, "sample_aspect_den" );
219 profile->display_aspect_num = mlt_properties_get_int( properties, "display_aspect_num" );
220 profile->display_aspect_den = mlt_properties_get_int( properties, "display_aspect_den" );
221 profile->colorspace = mlt_properties_get_int( properties, "colorspace" );
226 /** Load an anonymous profile from string.
228 * \public \memberof mlt_profile_s
229 * \param string a newline-delimited list of properties as name=value pairs
230 * \return a profile or NULL if out of memory
233 mlt_profile mlt_profile_load_string( const char *string )
235 mlt_properties properties = mlt_properties_new();
238 const char *p = string;
241 if ( strcmp( p, "" ) && p[ 0 ] != '#' )
242 mlt_properties_parse( properties, p );
243 p = strchr( p, '\n' );
247 return mlt_profile_load_properties( properties );
250 /** Get the video frame rate as a floating point value.
252 * \public \memberof mlt_profile_s
253 * @param profile a profile
254 * @return the frame rate
257 double mlt_profile_fps( mlt_profile profile )
260 return ( double ) profile->frame_rate_num / profile->frame_rate_den;
265 /** Get the sample aspect ratio as a floating point value.
267 * \public \memberof mlt_profile_s
268 * \param profile a profile
269 * \return the pixel aspect ratio
272 double mlt_profile_sar( mlt_profile profile )
275 return ( double ) profile->sample_aspect_num / profile->sample_aspect_den;
280 /** Get the display aspect ratio as floating point value.
282 * \public \memberof mlt_profile_s
283 * \param profile a profile
284 * \return the image aspect ratio
287 double mlt_profile_dar( mlt_profile profile )
290 return ( double ) profile->display_aspect_num / profile->display_aspect_den;
295 /** Free up the global profile resources.
297 * \public \memberof mlt_profile_s
298 * \param profile a profile
301 void mlt_profile_close( mlt_profile profile )
305 if ( profile->description )
306 free( profile->description );
307 profile->description = NULL;
313 /** Make a copy of a profile.
315 * \public \memberof mlt_profile_s
316 * \param profile the profile to clone
317 * \return a copy of the profile
320 mlt_profile mlt_profile_clone( mlt_profile profile )
322 mlt_profile clone = NULL;
326 clone = calloc( 1, sizeof( *profile ) );
329 memcpy( clone, profile, sizeof( *profile ) );
330 clone->description = strdup( profile->description );
337 /** Get the list of profiles.
339 * The caller MUST close the returned properties object!
340 * Each entry in the list is keyed on its name, and its value is another
341 * properties object that contains the attributes of the profile.
342 * \public \memberof mlt_profile_s
343 * \return a list of profiles
346 mlt_properties mlt_profile_list( )
348 char *filename = NULL;
349 const char *prefix = getenv( "MLT_PROFILES_PATH" );
350 mlt_properties properties = mlt_properties_new();
351 mlt_properties dir = mlt_properties_new();
353 const char *wildcard = NULL;
356 // Load from $prefix/share/mlt/profiles if no env var
357 if ( prefix == NULL )
360 filename = calloc( 1, strlen( prefix ) + strlen( PROFILES_DIR ) + 2 );
361 strcpy( filename, prefix );
362 if ( filename[ strlen( filename ) - 1 ] != '/' )
363 filename[ strlen( filename ) ] = '/';
364 strcat( filename, PROFILES_DIR );
368 mlt_properties_dir_list( dir, prefix, wildcard, sort );
370 for ( i = 0; i < mlt_properties_count( dir ); i++ )
372 char *filename = mlt_properties_get_value( dir, i );
373 char *profile_name = basename( filename );
374 if ( profile_name[0] != '.' && strcmp( profile_name, "Makefile" ) &&
375 profile_name[ strlen( profile_name ) - 1 ] != '~' )
377 mlt_properties profile = mlt_properties_load( filename );
380 mlt_properties_set_data( properties, profile_name, profile, 0,
381 (mlt_destructor) mlt_properties_close, NULL );
385 mlt_properties_close( dir );
392 /** Update the profile using the attributes of a producer.
394 * Use this to make an "auto-profile." Typically, you need to re-open the producer
395 * after you use this because some producers (e.g. avformat) adjust their framerate
396 * to that of the profile used when you created it.
397 * \public \memberof mlt_profile_s
398 * \param profile the profile to update
399 * \param producer the producer to inspect
402 void mlt_profile_from_producer( mlt_profile profile, mlt_producer producer )
406 mlt_image_format fmt = mlt_image_yuv422;
408 int w = profile->width;
409 int h = profile->height;
411 if ( ! mlt_service_get_frame( MLT_PRODUCER_SERVICE(producer), &fr, 0 ) && fr )
413 mlt_properties_set_double( MLT_FRAME_PROPERTIES( fr ), "consumer_aspect_ratio", mlt_profile_sar( profile ) );
414 if ( ! mlt_frame_get_image( fr, &buffer, &fmt, &w, &h, 0 ) )
416 // Some source properties are not exposed until after the first get_image call.
417 mlt_frame_close( fr );
418 mlt_service_get_frame( MLT_PRODUCER_SERVICE(producer), &fr, 0 );
419 p = MLT_FRAME_PROPERTIES( fr );
420 // mlt_properties_dump(p, stderr);
421 if ( mlt_properties_get_int( p, "meta.media.frame_rate_den" ) && mlt_properties_get_int( p, "meta.media.sample_aspect_den" ) )
423 profile->width = mlt_properties_get_int( p, "meta.media.width" );
424 profile->height = mlt_properties_get_int( p, "meta.media.height" );
425 profile->progressive = mlt_properties_get_int( p, "meta.media.progressive" );
426 profile->frame_rate_num = mlt_properties_get_int( p, "meta.media.frame_rate_num" );
427 profile->frame_rate_den = mlt_properties_get_int( p, "meta.media.frame_rate_den" );
428 // AVCHD is mis-reported as double frame rate.
429 if ( profile->progressive == 0 && (
430 profile->frame_rate_num / profile->frame_rate_den == 50 ||
431 profile->frame_rate_num / profile->frame_rate_den == 59 ) )
432 profile->frame_rate_num /= 2;
433 profile->sample_aspect_num = mlt_properties_get_int( p, "meta.media.sample_aspect_num" );
434 profile->sample_aspect_den = mlt_properties_get_int( p, "meta.media.sample_aspect_den" );
435 profile->colorspace = mlt_properties_get_int( p, "meta.media.colorspace" );
436 profile->display_aspect_num = (int) ( (double) profile->sample_aspect_num * profile->width / profile->sample_aspect_den + 0.5 );
437 profile->display_aspect_den = profile->height;
438 free( profile->description );
439 profile->description = strdup( "automatic" );
440 profile->is_explicit = 0;
444 mlt_frame_close( fr );
445 mlt_producer_seek( producer, 0 );