lqt_codecinfo.h

/*******************************************************************************
 lqt_codecinfo.h

 libquicktime - A library for reading and writing quicktime/avi/mp4 files.
 http://libquicktime.sourceforge.net

 Copyright (C) 2002 Heroine Virtual Ltd.
 Copyright (C) 2002-2011 Members of the libquicktime project.

 This library is free software; you can redistribute it and/or modify it under
 the terms of the GNU Lesser General Public License as published by the Free
 Software Foundation; either version 2.1 of the License, or (at your option)
 any later version.

 This library is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 details.

 You should have received a copy of the GNU Lesser General Public License along
 with this library; if not, write to the Free Software Foundation, Inc., 51
 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*******************************************************************************/

/*
 *   Codec info structure for libquicktime
 *   (first approximation)
 */

/* Type of a codec parameter */

#ifndef _LQT_CODEC_INFO_H_
#define _LQT_CODEC_INFO_H_

#pragma GCC visibility push(default)

#include <inttypes.h>



#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef enum
  {
    LQT_PARAMETER_INT,     
    LQT_PARAMETER_FLOAT,   
    LQT_PARAMETER_STRING,  
    LQT_PARAMETER_STRINGLIST, 
    /* This dummy type is used to separate sections (real_name will be on tab-label) */
    LQT_PARAMETER_SECTION, 
  } lqt_parameter_type_t;

typedef union
  {
  int val_int; 
  char * val_string; 
  float val_float; 
  } lqt_parameter_value_t;

typedef struct
  {
  char * name;   
  char * real_name; 
  lqt_parameter_type_t type; 
  lqt_parameter_value_t val_default; 
  /*
   *   Minimum and maximum values:
   *   These are only valid for numeric types and if val_min < val_max
   */
  
  lqt_parameter_value_t val_min; 
  lqt_parameter_value_t val_max; 
  int num_digits; 
  /*
   *  Possible options (only valid for LQT_STRINGLIST)
   */
  
  int num_stringlist_options; 
  char ** stringlist_options; 
  char ** stringlist_labels;  
  char * help_string; 
  } lqt_parameter_info_t;

typedef enum
  {
    LQT_CODEC_AUDIO,
    LQT_CODEC_VIDEO
  } lqt_codec_type;

typedef enum
  {
    LQT_DIRECTION_ENCODE,
    LQT_DIRECTION_DECODE,
    LQT_DIRECTION_BOTH
  } lqt_codec_direction;

typedef struct
  {
  int width;
  int height;
  } lqt_image_size_t;

  
#define LQT_CODEC_OBSOLETE (1<<24)
  
struct lqt_codec_info_s
  {
  int compatibility_flags; 
  /* These are set by the plugins */
  
  char * name;               
  char * long_name;          
  char * description;        
  lqt_codec_type type;           
  lqt_codec_direction direction; 
  int num_fourccs;      
  char ** fourccs;      
  int num_wav_ids; 
  int * wav_ids;   
  int num_encoding_parameters; 
  lqt_parameter_info_t * encoding_parameters; 
  int num_decoding_parameters; 
  lqt_parameter_info_t * decoding_parameters; 
  /* The following members are set by libquicktime      */
  
  char * module_filename;    
  int module_index;          
  uint32_t file_time;        
  char * gettext_domain;     
  char * gettext_directory;  
  int num_encoding_colormodels; 
  int * encoding_colormodels;  
  int num_image_sizes; 
  lqt_image_size_t * image_sizes; 
  lqt_compression_id_t compression_id; 
  struct lqt_codec_info_s * next;   
  };


/* Global Entry points */

void lqt_registry_init();

void lqt_registry_destroy();

/* \ingroup codec_registry
 *
 * Save the registry file $HOME/.libquicktime_codecs.
 * Under normal circumstances, you never need to call this function
 */

void lqt_registry_write();


/******************************************************
 *  Non thread save functions for querying the
 *  codec registry. Suitable for single threaded
 *  applications (might become obsolete)
 ******************************************************/

int lqt_get_num_audio_codecs();

int lqt_get_num_video_codecs();

const lqt_codec_info_t * lqt_get_audio_codec_info(int index);

const lqt_codec_info_t * lqt_get_video_codec_info(int index);

/********************************************************************
 *  Thread save function for getting codec parameters
 *  All these functions return a NULL terminated array of local
 *  copies of the codec data which must be freed using 
 *  lqt_destroy_codec_info(lqt_codec_info_t ** info) declared below
 ********************************************************************/

lqt_codec_info_t ** lqt_query_registry(int audio, int video,
                                       int encode, int decode);

lqt_codec_info_t ** lqt_find_audio_codec(char * fourcc, int encode);

lqt_codec_info_t ** lqt_find_audio_codec_by_wav_id(int wav_id, int encode);
  
lqt_codec_info_t ** lqt_find_video_codec(char * fourcc, int encode);



  

  
lqt_codec_info_t ** lqt_find_audio_codec_by_name(const char * name);

lqt_codec_info_t ** lqt_find_video_codec_by_name(const char * name);

lqt_codec_info_t ** lqt_audio_codec_from_file(quicktime_t * file, int track);

lqt_codec_info_t ** lqt_video_codec_from_file(quicktime_t * file, int track);
  
void lqt_destroy_codec_info(lqt_codec_info_t ** info);

void lqt_reorder_audio_codecs(lqt_codec_info_t ** codec_info);

void lqt_reorder_video_codecs(lqt_codec_info_t ** codec_info);

void lqt_set_default_parameter(lqt_codec_type type, int encode,
                               const char * codec_name,
                               const char * parameter_name,
                               lqt_parameter_value_t * val);

void lqt_restore_default_parameters(lqt_codec_info_t * codec_info,
                                    int encode, int decode);
    
                                      
void lqt_dump_codec_info(const lqt_codec_info_t * info);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#pragma GCC visibility pop

#endif /* _LQT_CODEC_INFO_H_ */