home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 May / maximum-cd-2009-05.iso / DiscContents / vlc-0.9.8a-win32.exe / sdk / include / vlc / plugins / vlc_es.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-06  |  7.6 KB  |  247 lines
  1. /*****************************************************************************
  2.  * vlc_es.h: Elementary stream formats descriptions
  3.  *****************************************************************************
  4.  * Copyright (C) 1999-2001 the VideoLAN team
  5.  * $Id: ad45797bfa591d6a4f77f7d33900f7dabdde1bc1 $
  6.  *
  7.  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
  8.  *
  9.  * This program is free software; you can redistribute it and/or modify
  10.  * it under the terms of the GNU General Public License as published by
  11.  * the Free Software Foundation; either version 2 of the License, or
  12.  * (at your option) any later version.
  13.  *
  14.  * This program 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
  17.  * GNU General Public License for more details.
  18.  *
  19.  * You should have received a copy of the GNU General Public License
  20.  * along with this program; if not, write to the Free Software
  21.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22.  *****************************************************************************/
  23.  
  24. #ifndef VLC_ES_H
  25. #define VLC_ES_H 1
  26.  
  27. /* FIXME: i'm not too sure about this include but it fixes compilation of
  28.  * video chromas -- dionoea */
  29. #include "vlc_common.h"
  30.  
  31. /**
  32.  * \file
  33.  * This file defines the elementary streams format types
  34.  */
  35.  
  36. /**
  37.  * video palette data
  38.  * \see video_format_t
  39.  * \see subs_format_t
  40.  */
  41. struct video_palette_t
  42. {
  43.     int i_entries;      /**< to keep the compatibility with ffmpeg's palette */
  44.     uint8_t palette[256][4];                   /**< 4-byte RGBA/YUVA palette */
  45. };
  46.  
  47. /**
  48.  * audio replay gain description
  49.  */
  50. #define AUDIO_REPLAY_GAIN_MAX (2)
  51. #define AUDIO_REPLAY_GAIN_TRACK (0)
  52. #define AUDIO_REPLAY_GAIN_ALBUM (1)
  53. typedef struct
  54. {
  55.     /* true if we have the peak value */
  56.     bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
  57.     /* peak value where 1.0 means full sample value */
  58.     float      pf_peak[AUDIO_REPLAY_GAIN_MAX];
  59.  
  60.     /* true if we have the gain value */
  61.     bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
  62.     /* gain value in dB */
  63.     float      pf_gain[AUDIO_REPLAY_GAIN_MAX];
  64. } audio_replay_gain_t;
  65.  
  66. /**
  67.  * audio format description
  68.  */
  69. struct audio_format_t
  70. {
  71.     vlc_fourcc_t i_format;                          /**< audio format fourcc */
  72.     unsigned int i_rate;                              /**< audio sample-rate */
  73.  
  74.     /* Describes the channels configuration of the samples (ie. number of
  75.      * channels which are available in the buffer, and positions). */
  76.     uint32_t     i_physical_channels;
  77.  
  78.     /* Describes from which original channels, before downmixing, the
  79.      * buffer is derived. */
  80.     uint32_t     i_original_channels;
  81.  
  82.     /* Optional - for A/52, SPDIF and DTS types : */
  83.     /* Bytes used by one compressed frame, depends on bitrate. */
  84.     unsigned int i_bytes_per_frame;
  85.  
  86.     /* Number of sampleframes contained in one compressed frame. */
  87.     unsigned int i_frame_length;
  88.     /* Please note that it may be completely arbitrary - buffers are not
  89.      * obliged to contain a integral number of so-called "frames". It's
  90.      * just here for the division :
  91.      * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
  92.      */
  93.  
  94.     /* FIXME ? (used by the codecs) */
  95.     unsigned     i_bitspersample;
  96.     unsigned     i_blockalign;
  97.     uint8_t      i_channels; /* must be <=32 */
  98.     uint8_t      i_flavor;
  99. };
  100.  
  101. #ifdef WORDS_BIGENDIAN
  102. #   define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','b')
  103. #   define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','b')
  104. #else
  105. #   define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','l')
  106. #   define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','l')
  107. #endif
  108.  
  109. /**
  110.  * video format description
  111.  */
  112. struct video_format_t
  113. {
  114.     vlc_fourcc_t i_chroma;                               /**< picture chroma */
  115.     unsigned int i_aspect;                                 /**< aspect ratio */
  116.  
  117.     unsigned int i_width;                                 /**< picture width */
  118.     unsigned int i_height;                               /**< picture height */
  119.     unsigned int i_x_offset;               /**< start offset of visible area */
  120.     unsigned int i_y_offset;               /**< start offset of visible area */
  121.     unsigned int i_visible_width;                 /**< width of visible area */
  122.     unsigned int i_visible_height;               /**< height of visible area */
  123.  
  124.     unsigned int i_bits_per_pixel;             /**< number of bits per pixel */
  125.  
  126.     unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
  127.     unsigned int i_sar_den;
  128.  
  129.     unsigned int i_frame_rate;                     /**< frame rate numerator */
  130.     unsigned int i_frame_rate_base;              /**< frame rate denominator */
  131.  
  132.     int i_rmask, i_gmask, i_bmask;          /**< color masks for RGB chroma */
  133.     int i_rrshift, i_lrshift;
  134.     int i_rgshift, i_lgshift;
  135.     int i_rbshift, i_lbshift;
  136.     video_palette_t *p_palette;              /**< video palette from demuxer */
  137. };
  138.  
  139. /**
  140.  * subtitles format description
  141.  */
  142. struct subs_format_t
  143. {
  144.     /* the character encoding of the text of the subtitle.
  145.      * all gettext recognized shorts can be used */
  146.     char *psz_encoding;
  147.  
  148.  
  149.     int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
  150.     int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */
  151.  
  152.     struct
  153.     {
  154.         /*  */
  155.         uint32_t palette[16+1];
  156.  
  157.         /* the width of the original movie the spu was extracted from */
  158.         int i_original_frame_width;
  159.         /* the height of the original movie the spu was extracted from */
  160.         int i_original_frame_height;
  161.     } spu;
  162.  
  163.     struct
  164.     {
  165.         int i_id;
  166.     } dvb;
  167. };
  168.  
  169. /**
  170.  * ES definition
  171.  */
  172. typedef struct extra_languages_t
  173. {
  174.         char *psz_language;
  175.         char *psz_description;
  176. } extra_languages_t;
  177.  
  178.  
  179. struct es_format_t
  180. {
  181.     int             i_cat;
  182.     vlc_fourcc_t    i_codec;
  183.  
  184.     int             i_id;       /* -1: let the core mark the right id
  185.                                    >=0: valid id */
  186.     int             i_group;    /* -1 : standalone
  187.                                    >= 0 then a "group" (program) is created
  188.                                         for each value */
  189.     int             i_priority; /*  -2 : mean not selectable by the users
  190.                                     -1 : mean not selected by default even
  191.                                         when no other stream
  192.                                     >=0: priority */
  193.  
  194.     char            *psz_language;
  195.     char            *psz_description;
  196.     int             i_extra_languages;
  197.     extra_languages_t *p_extra_languages;
  198.  
  199.     audio_format_t  audio;
  200.     audio_replay_gain_t audio_replay_gain;
  201.     video_format_t video;
  202.     subs_format_t  subs;
  203.  
  204.     unsigned int   i_bitrate;
  205.  
  206.     bool     b_packetized; /* wether the data is packetized
  207.                                     (ie. not truncated) */
  208.     int     i_extra;
  209.     void    *p_extra;
  210.  
  211. };
  212.  
  213. /* ES Categories */
  214. enum es_format_category_e
  215. {
  216.     UNKNOWN_ES = 0x00,
  217.     VIDEO_ES   = 0x01,
  218.     AUDIO_ES   = 0x02,
  219.     SPU_ES     = 0x03,
  220.     NAV_ES     = 0x04,
  221. };
  222.  
  223. /**
  224.  * This function will fill all RGB shift from RGB masks.
  225.  */
  226. VLC_EXPORT( void, video_format_FixRgb, ( video_format_t * ) );
  227.  
  228. /**
  229.  * This funtion will initialize a es_format_t structure.
  230.  */
  231. VLC_EXPORT( void, es_format_Init, ( es_format_t *, int i_cat, vlc_fourcc_t i_codec ) );
  232.  
  233. /**
  234.  * This functions will copy a es_format_t.
  235.  */
  236. VLC_EXPORT( int, es_format_Copy, ( es_format_t *p_dst, const es_format_t *p_src ) );
  237.  
  238. /**
  239.  * This function will clean up a es_format_t and relasing all associated
  240.  * resources.
  241.  * You can call it multiple times on the same structure.
  242.  */
  243. VLC_EXPORT( void, es_format_Clean, ( es_format_t *fmt ) );
  244.  
  245. #endif
  246.  
  247.