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