]> git.sesse.net Git - mlt/blob - src/framework/mlt_profile.h
src/framework/*: improve the doxygen documentation (work in progress). This also...
[mlt] / src / framework / mlt_profile.h
1 /**
2  * \file mlt_profile.h
3  * \brief video output definition
4  *
5  * Copyright (C) 2007-2008 Ushodaya Enterprises Limited
6  * \author Dan Dennedy <dan@dennedy.org>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #ifndef _MLT_PROFILE_H
24 #define _MLT_PROFILE_H
25
26 #include "mlt_types.h"
27
28 /** \brief Profile class
29  *
30  */
31
32 struct mlt_profile_s
33 {
34         char* description;
35         int frame_rate_num;
36         int frame_rate_den;
37         int width;
38         int height;
39         int progressive;
40         int sample_aspect_num;
41         int sample_aspect_den;
42         int display_aspect_num;
43         int display_aspect_den;
44 };
45
46 extern mlt_profile mlt_profile_init( const char *name );
47 extern mlt_profile mlt_profile_load_file( const char *file );
48 extern mlt_profile mlt_profile_load_properties( mlt_properties properties );
49 extern mlt_profile mlt_profile_load_string( const char *string );
50 extern double mlt_profile_fps( mlt_profile profile );
51 extern double mlt_profile_sar( mlt_profile profile );
52 extern double mlt_profile_dar( mlt_profile profile );
53 extern void mlt_profile_close( mlt_profile profile );
54 #endif