git.sesse.net Git - vlc/blob - include/vlc_es.h

   1 /*****************************************************************************
   2  * vlc_es.h: Elementary stream formats descriptions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2001 the VideoLAN team
   5  * $Id$
   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 /**
  28  * \file
  29  * This file defines the elementary streams format types
  30  */
  31
  32 /**
  33  * video palette data
  34  * \see video_format_t
  35  * \see subs_format_t
  36  */
  37 struct video_palette_t
  38 {
  39     int i_entries;      /**< to keep the compatibility with ffmpeg's palette */
  40     uint8_t palette[256][4];                   /**< 4-byte RGBA/YUVA palette */
  41 };
  42
  43 /**
  44  * audio format description
  45  */
  46 struct audio_format_t
  47 {
  48     vlc_fourcc_t i_format;                          /**< audio format fourcc */
  49     unsigned int i_rate;                              /**< audio sample-rate */
  50
  51     /* Describes the channels configuration of the samples (ie. number of
  52      * channels which are available in the buffer, and positions). */
  53     uint32_t     i_physical_channels;
  54
  55     /* Describes from which original channels, before downmixing, the
  56      * buffer is derived. */
  57     uint32_t     i_original_channels;
  58
  59     /* Optional - for A/52, SPDIF and DTS types : */
  60     /* Bytes used by one compressed frame, depends on bitrate. */
  61     unsigned int i_bytes_per_frame;
  62
  63     /* Number of sampleframes contained in one compressed frame. */
  64     unsigned int i_frame_length;
  65     /* Please note that it may be completely arbitrary - buffers are not
  66      * obliged to contain a integral number of so-called "frames". It's
  67      * just here for the division :
  68      * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
  69      */
  70
  71     /* FIXME ? (used by the codecs) */
  72     int i_channels;
  73     int i_blockalign;
  74     int i_bitspersample;
  75 };
  76
  77 #ifdef WORDS_BIGENDIAN
  78 #   define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','b')
  79 #   define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','b')
  80 #else
  81 #   define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','l')
  82 #   define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','l')
  83 #endif
  84
  85 /**
  86  * video format description
  87  */
  88 struct video_format_t
  89 {
  90     vlc_fourcc_t i_chroma;                               /**< picture chroma */
  91     unsigned int i_aspect;                                 /**< aspect ratio */
  92
  93     unsigned int i_width;                                 /**< picture width */
  94     unsigned int i_height;                               /**< picture height */
  95     unsigned int i_x_offset;               /**< start offset of visible area */
  96     unsigned int i_y_offset;               /**< start offset of visible area */
  97     unsigned int i_visible_width;                 /**< width of visible area */
  98     unsigned int i_visible_height;               /**< height of visible area */
  99
 100     unsigned int i_bits_per_pixel;             /**< number of bits per pixel */
 101
 102     unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
 103     unsigned int i_sar_den;
 104
 105     unsigned int i_frame_rate;                     /**< frame rate numerator */
 106     unsigned int i_frame_rate_base;              /**< frame rate denominator */
 107
 108     int i_rmask, i_gmask, i_bmask;          /**< color masks for RGB chroma */
 109     video_palette_t *p_palette;              /**< video palette from demuxer */
 110 };
 111
 112 /**
 113  * subtitles format description
 114  */
 115 struct subs_format_t
 116 {
 117     /* the character encoding of the text of the subtitle.
 118      * all gettext recognized shorts can be used */
 119     char *psz_encoding;
 120
 121
 122     int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
 123     int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */
 124
 125     struct
 126     {
 127         /*  */
 128         uint32_t palette[16+1];
 129
 130         /* the width of the original movie the spu was extracted from */
 131         int i_original_frame_width;
 132         /* the height of the original movie the spu was extracted from */
 133         int i_original_frame_height;
 134     } spu;
 135
 136     struct
 137     {
 138         int i_id;
 139     } dvb;
 140 };
 141
 142 /**
 143  * ES definition
 144  */
 145 typedef struct extra_languages_t
 146 {
 147         char *psz_language;
 148         char *psz_description;
 149 } extra_languages_t;
 150
 151
 152 struct es_format_t
 153 {
 154     int             i_cat;
 155     vlc_fourcc_t    i_codec;
 156
 157     int             i_id;       /* -1: let the core mark the right id
 158                                    >=0: valid id */
 159     int             i_group;    /* -1 : standalone
 160                                    >= 0 then a "group" (program) is created
 161                                         for each value */
 162     int             i_priority; /*  -2 : mean not selectable by the users
 163                                     -1 : mean not selected by default even
 164                                         when no other stream
 165                                     >=0: priority */
 166
 167     char            *psz_language;
 168     char            *psz_description;
 169     int             i_extra_languages;
 170     extra_languages_t *p_extra_languages;
 171
 172     audio_format_t audio;
 173     video_format_t video;
 174     subs_format_t  subs;
 175
 176     unsigned int   i_bitrate;
 177
 178     vlc_bool_t     b_packetized; /* wether the data is packetized
 179                                     (ie. not truncated) */
 180     int     i_extra;
 181     void    *p_extra;
 182
 183 };
 184
 185 /* ES Categories */
 186 #define UNKNOWN_ES      0x00
 187 #define VIDEO_ES        0x01
 188 #define AUDIO_ES        0x02
 189 #define SPU_ES          0x03
 190 #define NAV_ES          0x04
 191
 192 static inline void es_format_Init( es_format_t *fmt,
 193                                    int i_cat, vlc_fourcc_t i_codec )
 194 {
 195     fmt->i_cat                  = i_cat;
 196     fmt->i_codec                = i_codec;
 197     fmt->i_id                   = -1;
 198     fmt->i_group                = 0;
 199     fmt->i_priority             = 0;
 200     fmt->psz_language           = NULL;
 201     fmt->psz_description        = NULL;
 202
 203     fmt->i_extra_languages      = 0;
 204     fmt->p_extra_languages      = NULL;
 205
 206     memset( &fmt->audio, 0, sizeof(audio_format_t) );
 207     memset( &fmt->video, 0, sizeof(video_format_t) );
 208     memset( &fmt->subs, 0, sizeof(subs_format_t) );
 209
 210     fmt->b_packetized           = VLC_TRUE;
 211     fmt->i_bitrate              = 0;
 212     fmt->i_extra                = 0;
 213     fmt->p_extra                = NULL;
 214 }
 215
 216 static inline void es_format_Copy( es_format_t *dst, es_format_t *src )
 217 {
 218     int i;
 219     memcpy( dst, src, sizeof( es_format_t ) );
 220     if( src->psz_language )
 221          dst->psz_language = strdup( src->psz_language );
 222     if( src->psz_description )
 223         dst->psz_description = strdup( src->psz_description );
 224     if( src->i_extra > 0 )
 225     {
 226         dst->i_extra = src->i_extra;
 227         dst->p_extra = malloc( src->i_extra );
 228         memcpy( dst->p_extra, src->p_extra, src->i_extra );
 229     }
 230     else
 231     {
 232         dst->i_extra = 0;
 233         dst->p_extra = NULL;
 234     }
 235
 236     if( src->subs.psz_encoding )
 237         dst->subs.psz_encoding = strdup( src->subs.psz_encoding );
 238
 239     if( src->video.p_palette )
 240     {
 241         dst->video.p_palette =
 242             (video_palette_t*)malloc( sizeof( video_palette_t ) );
 243         memcpy( dst->video.p_palette, src->video.p_palette,
 244                 sizeof( video_palette_t ) );
 245     }
 246
 247     dst->i_extra_languages = src->i_extra_languages;
 248     dst->p_extra_languages = (extra_languages_t*) malloc( dst->i_extra_languages * sizeof(*dst->p_extra_languages ) );
 249     for( i = 0; i < dst->i_extra_languages; i++ ) {
 250         if( src->p_extra_languages[i].psz_language )
 251             dst->p_extra_languages[i].psz_language = strdup(src->p_extra_languages[i].psz_language);
 252         else
 253             dst->p_extra_languages[i].psz_language = NULL;
 254         if( src->p_extra_languages[i].psz_description )
 255             dst->p_extra_languages[i].psz_description = strdup(src->p_extra_languages[i].psz_description);
 256         else
 257             dst->p_extra_languages[i].psz_description = NULL;
 258     }
 259 }
 260
 261 static inline void es_format_Clean( es_format_t *fmt )
 262 {
 263     if( fmt->psz_language ) free( fmt->psz_language );
 264     fmt->psz_language = NULL;
 265
 266     if( fmt->psz_description ) free( fmt->psz_description );
 267     fmt->psz_description = NULL;
 268
 269     if( fmt->i_extra > 0 ) free( fmt->p_extra );
 270     fmt->i_extra = 0;
 271     fmt->p_extra = NULL;
 272
 273     if( fmt->video.p_palette ) free( fmt->video.p_palette );
 274     fmt->video.p_palette = NULL;
 275
 276     if( fmt->subs.psz_encoding ) free( fmt->subs.psz_encoding );
 277     fmt->subs.psz_encoding = NULL;
 278
 279     if( fmt->i_extra_languages && fmt->p_extra_languages ) {
 280         int i = 0;
 281         while( i < fmt->i_extra_languages ) {
 282             if( fmt->p_extra_languages[i].psz_language )
 283                 free( fmt->p_extra_languages[i].psz_language );
 284             if( fmt->p_extra_languages[i].psz_description )
 285                 free( fmt->p_extra_languages[i].psz_description );
 286             i++;
 287         }
 288         free(fmt->p_extra_languages);
 289     }
 290 }
 291 #endif