]> git.sesse.net Git - vlc/blobdiff - include/vlc_es.h
Preferences: fix some memleaks and fix horrible video-filter bug. :D
[vlc] / include / vlc_es.h
index b204c07612e959c948f0ac625716d9a0a8998a23..d020d134ac7442f0568b5a67edc70b2220190c6e 100644 (file)
@@ -1,8 +1,8 @@
 /*****************************************************************************
- * vlc_es.h
+ * vlc_es.h: Elementary stream formats descriptions
  *****************************************************************************
- * Copyright (C) 1999-2001 VideoLAN
- * $Id: vlc_es.h,v 1.4 2003/11/24 00:39:00 fenrir Exp $
+ * Copyright (C) 1999-2001 the VideoLAN team
+ * $Id$
  *
  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
  *
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 #ifndef _VLC_ES_H
 #define _VLC_ES_H 1
 
+/* FIXME: i'm not too sure about this include but it fixes compilation of
+ * video chromas -- dionoea */
+#include "vlc_common.h"
+
 /**
- * Description of a audio frame
+ * \file
+ * This file defines the elementary streams format types
  */
-struct audio_format_t
+
+/**
+ * video palette data
+ * \see video_format_t
+ * \see subs_format_t
+ */
+struct video_palette_t
+{
+    int i_entries;      /**< to keep the compatibility with ffmpeg's palette */
+    uint8_t palette[256][4];                   /**< 4-byte RGBA/YUVA palette */
+};
+
+/**
+ * audio replay gain description
+ */
+#define AUDIO_REPLAY_GAIN_MAX (2)
+#define AUDIO_REPLAY_GAIN_TRACK (0)
+#define AUDIO_REPLAY_GAIN_ALBUM (1)
+typedef struct
 {
-    vlc_fourcc_t        i_format;
+    /* true if we have the peak value */
+    bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
+    /* peak value where 1.0 means full sample value */
+    float      pf_peak[AUDIO_REPLAY_GAIN_MAX];
 
-    unsigned int        i_rate;
+    /* true if we have the gain value */
+    bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
+    /* gain value in dB */
+    float      pf_gain[AUDIO_REPLAY_GAIN_MAX];
+} audio_replay_gain_t;
+
+/**
+ * audio format description
+ */
+struct audio_format_t
+{
+    vlc_fourcc_t i_format;                          /**< audio format fourcc */
+    unsigned int i_rate;                              /**< audio sample-rate */
 
     /* Describes the channels configuration of the samples (ie. number of
      * channels which are available in the buffer, and positions). */
-    uint32_t            i_physical_channels;
+    uint32_t     i_physical_channels;
 
     /* Describes from which original channels, before downmixing, the
      * buffer is derived. */
-    uint32_t            i_original_channels;
+    uint32_t     i_original_channels;
 
     /* Optional - for A/52, SPDIF and DTS types : */
     /* Bytes used by one compressed frame, depends on bitrate. */
-    unsigned int        i_bytes_per_frame;
+    unsigned int i_bytes_per_frame;
 
     /* Number of sampleframes contained in one compressed frame. */
-    unsigned int        i_frame_length;
+    unsigned int i_frame_length;
     /* Please note that it may be completely arbitrary - buffers are not
      * obliged to contain a integral number of so-called "frames". It's
      * just here for the division :
@@ -54,13 +92,22 @@ struct audio_format_t
      */
 
     /* FIXME ? (used by the codecs) */
-    int i_channels;
-    int i_blockalign;
-    int i_bitspersample;
+    unsigned     i_bitspersample;
+    unsigned     i_blockalign;
+    uint8_t      i_channels; /* must be <=32 */
+    uint8_t      i_flavor;
 };
 
+#ifdef WORDS_BIGENDIAN
+#   define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','b')
+#   define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','b')
+#else
+#   define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','l')
+#   define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','l')
+#endif
+
 /**
- * Description of a video frame
+ * video format description
  */
 struct video_format_t
 {
@@ -76,32 +123,66 @@ struct video_format_t
 
     unsigned int i_bits_per_pixel;             /**< number of bits per pixel */
 
+    unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
+    unsigned int i_sar_den;
+
     unsigned int i_frame_rate;                     /**< frame rate numerator */
     unsigned int i_frame_rate_base;              /**< frame rate denominator */
+
+    int i_rmask, i_gmask, i_bmask;          /**< color masks for RGB chroma */
+    int i_rrshift, i_lrshift;
+    int i_rgshift, i_lgshift;
+    int i_rbshift, i_lbshift;
+    video_palette_t *p_palette;              /**< video palette from demuxer */
 };
 
 /**
- * Description of subs
+ * subtitles format description
  */
 struct subs_format_t
 {
+    /* the character encoding of the text of the subtitle.
+     * all gettext recognized shorts can be used */
     char *psz_encoding;
 
+
+    int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
+    int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */
+
     struct
     {
-        /* FIXME */
+        /*  */
         uint32_t palette[16+1];
+
+        /* the width of the original movie the spu was extracted from */
+        int i_original_frame_width;
+        /* the height of the original movie the spu was extracted from */
+        int i_original_frame_height;
     } spu;
+
+    struct
+    {
+        int i_id;
+    } dvb;
 };
 
 /**
  * ES definition
  */
+typedef struct extra_languages_t
+{
+        char *psz_language;
+        char *psz_description;
+} extra_languages_t;
+
+
 struct es_format_t
 {
     int             i_cat;
     vlc_fourcc_t    i_codec;
 
+    int             i_id;       /* -1: let the core mark the right id
+                                   >=0: valid id */
     int             i_group;    /* -1 : standalone
                                    >= 0 then a "group" (program) is created
                                         for each value */
@@ -109,15 +190,21 @@ struct es_format_t
                                     -1 : mean not selected by default even
                                         when no other stream
                                     >=0: priority */
+
     char            *psz_language;
     char            *psz_description;
+    int             i_extra_languages;
+    extra_languages_t *p_extra_languages;
 
-    audio_format_t audio;
+    audio_format_t  audio;
+    audio_replay_gain_t audio_replay_gain;
     video_format_t video;
     subs_format_t  subs;
 
-    int     i_bitrate;
+    unsigned int   i_bitrate;
 
+    bool     b_packetized; /* wether the data is packetized
+                                    (ie. not truncated) */
     int     i_extra;
     void    *p_extra;
 
@@ -135,35 +222,96 @@ static inline void es_format_Init( es_format_t *fmt,
 {
     fmt->i_cat                  = i_cat;
     fmt->i_codec                = i_codec;
+    fmt->i_id                   = -1;
     fmt->i_group                = 0;
     fmt->i_priority             = 0;
     fmt->psz_language           = NULL;
     fmt->psz_description        = NULL;
 
+    fmt->i_extra_languages      = 0;
+    fmt->p_extra_languages      = NULL;
+
     memset( &fmt->audio, 0, sizeof(audio_format_t) );
+    memset( &fmt->audio_replay_gain, 0, sizeof(audio_replay_gain_t) );
     memset( &fmt->video, 0, sizeof(video_format_t) );
     memset( &fmt->subs, 0, sizeof(subs_format_t) );
 
+    fmt->b_packetized           = true;
     fmt->i_bitrate              = 0;
     fmt->i_extra                = 0;
     fmt->p_extra                = NULL;
 }
 
-static inline void es_format_Copy( es_format_t *dst, es_format_t *src )
+static inline int es_format_Copy( es_format_t *dst, const es_format_t *src )
 {
+    int i;
     memcpy( dst, src, sizeof( es_format_t ) );
+    if( src->psz_language )
+         dst->psz_language = strdup( src->psz_language );
+    if( src->psz_description )
+        dst->psz_description = strdup( src->psz_description );
     if( src->i_extra > 0 )
     {
+        dst->i_extra = src->i_extra;
         dst->p_extra = malloc( src->i_extra );
-        memcpy( dst->p_extra, src->p_extra,
-                src->i_extra );
+        memcpy( dst->p_extra, src->p_extra, src->i_extra );
     }
     else
     {
         dst->i_extra = 0;
         dst->p_extra = NULL;
     }
+
+    if( src->subs.psz_encoding )
+        dst->subs.psz_encoding = strdup( src->subs.psz_encoding );
+
+    if( src->video.p_palette )
+    {
+        dst->video.p_palette =
+            (video_palette_t*)malloc( sizeof( video_palette_t ) );
+        memcpy( dst->video.p_palette, src->video.p_palette,
+                sizeof( video_palette_t ) );
+    }
+
+    dst->i_extra_languages = src->i_extra_languages;
+    if( dst->i_extra_languages )
+        dst->p_extra_languages = (extra_languages_t*)
+            malloc(dst->i_extra_languages * sizeof(*dst->p_extra_languages ));
+    for( i = 0; i < dst->i_extra_languages; i++ ) {
+        if( src->p_extra_languages[i].psz_language )
+            dst->p_extra_languages[i].psz_language = strdup( src->p_extra_languages[i].psz_language );
+        else
+            dst->p_extra_languages[i].psz_language = NULL;
+        if( src->p_extra_languages[i].psz_description )
+            dst->p_extra_languages[i].psz_description = strdup( src->p_extra_languages[i].psz_description );
+        else
+            dst->p_extra_languages[i].psz_description = NULL;
+    }
+    return VLC_SUCCESS;
 }
 
-#endif
+static inline void es_format_Clean( es_format_t *fmt )
+{
+    free( fmt->psz_language );
+    free( fmt->psz_description );
+
+    if( fmt->i_extra > 0 ) free( fmt->p_extra );
+
+    free( fmt->video.p_palette );
+    free( fmt->subs.psz_encoding );
 
+    if( fmt->i_extra_languages > 0 && fmt->p_extra_languages )
+    {
+        int i;
+        for( i = 0; i < fmt->i_extra_languages; i++ )
+        {
+            free( fmt->p_extra_languages[i].psz_language );
+            free( fmt->p_extra_languages[i].psz_description );
+        }
+        free( fmt->p_extra_languages );
+    }
+
+    /* es_format_Clean can be called multiple times */
+    memset( fmt, 0, sizeof(*fmt) );
+}
+#endif