git.sesse.net Git - mlt/blob - src/framework/mlt_profile.h

   1 /**
   2  * \file mlt_profile.h
   3  * \brief video output definition
   4  * \see mlt_profile_s
   5  *
   6  * Copyright (C) 2007-2009 Ushodaya Enterprises Limited
   7  * \author Dan Dennedy <dan@dennedy.org>
   8  *
   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.
  13  *
  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.
  18  *
  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
  22  */
  23
  24 #ifndef _MLT_PROFILE_H
  25 #define _MLT_PROFILE_H
  26
  27 #include "mlt_types.h"
  28
  29 /** \brief Profile class
  30  *
  31  */
  32
  33 struct mlt_profile_s
  34 {
  35         char* description;      /**< a brief description suitable as a label in UI menu */
  36         int frame_rate_num;     /**< the numerator of the video frame rate */
  37         int frame_rate_den;     /**< the denominator of the video frame rate */
  38         int width;              /**< the horizontal resolution of the video */
  39         int height;             /**< the vertical resolution of the video */
  40         int progressive;        /**< a flag to indicate if the video is progressive scan, interlace if not set */
  41         int sample_aspect_num;  /**< the numerator of the pixel aspect ratio */
  42         int sample_aspect_den;  /**< the denominator of the pixel aspect ratio */
  43         int display_aspect_num; /**< the numerator of the image aspect ratio in case it can not be simply derived (e.g. ITU-R 601) */
  44         int display_aspect_den; /**< the denominator of the image aspect ratio in case it can not be simply derived (e.g. ITU-R 601) */
  45         int colorspace;         /**< the Y'CbCr colorspace standard: =601 for ITU-R 601, =709 for ITU-R 709, or =240 for SMPTE240M */
  46         int is_explicit;        /**< used internally to indicate if the profile was requested explicitly or computed or defaulted */
  47 };
  48
  49 extern mlt_profile mlt_profile_init( const char *name );
  50 extern mlt_profile mlt_profile_load_file( const char *file );
  51 extern mlt_profile mlt_profile_load_properties( mlt_properties properties );
  52 extern mlt_profile mlt_profile_load_string( const char *string );
  53 extern double mlt_profile_fps( mlt_profile profile );
  54 extern double mlt_profile_sar( mlt_profile profile );
  55 extern double mlt_profile_dar( mlt_profile profile );
  56 extern void mlt_profile_close( mlt_profile profile );
  57 extern mlt_profile mlt_profile_clone( mlt_profile profile );
  58 extern mlt_properties mlt_profile_list( );
  59 extern void mlt_profile_from_producer( mlt_profile profile, mlt_producer producer );
  60 #endif