Added a i_original_fourcc field to es_format_t.
[vlc.git] / 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 /* FIXME: i'm not too sure about this include but it fixes compilation of
28  * video chromas -- dionoea */
29 #include "vlc_common.h"
30 #include <vlc_fourcc.h>
31
32 /**
33  * \file
34  * This file defines the elementary streams format types
35  */
36
37 /**
38  * video palette data
39  * \see video_format_t
40  * \see subs_format_t
41  */
42 struct video_palette_t
43 {
44     int i_entries;      /**< to keep the compatibility with ffmpeg's palette */
45     uint8_t palette[256][4];                   /**< 4-byte RGBA/YUVA palette */
46 };
47
48 /**
49  * audio replay gain description
50  */
51 #define AUDIO_REPLAY_GAIN_MAX (2)
52 #define AUDIO_REPLAY_GAIN_TRACK (0)
53 #define AUDIO_REPLAY_GAIN_ALBUM (1)
54 typedef struct
55 {
56     /* true if we have the peak value */
57     bool pb_peak[AUDIO_REPLAY_GAIN_MAX];
58     /* peak value where 1.0 means full sample value */
59     float      pf_peak[AUDIO_REPLAY_GAIN_MAX];
60
61     /* true if we have the gain value */
62     bool pb_gain[AUDIO_REPLAY_GAIN_MAX];
63     /* gain value in dB */
64     float      pf_gain[AUDIO_REPLAY_GAIN_MAX];
65 } audio_replay_gain_t;
66
67 /**
68  * audio format description
69  */
70 struct audio_format_t
71 {
72     vlc_fourcc_t i_format;                          /**< audio format fourcc */
73     unsigned int i_rate;                              /**< audio sample-rate */
74
75     /* Describes the channels configuration of the samples (ie. number of
76      * channels which are available in the buffer, and positions). */
77     uint32_t     i_physical_channels;
78
79     /* Describes from which original channels, before downmixing, the
80      * buffer is derived. */
81     uint32_t     i_original_channels;
82
83     /* Optional - for A/52, SPDIF and DTS types : */
84     /* Bytes used by one compressed frame, depends on bitrate. */
85     unsigned int i_bytes_per_frame;
86
87     /* Number of sampleframes contained in one compressed frame. */
88     unsigned int i_frame_length;
89     /* Please note that it may be completely arbitrary - buffers are not
90      * obliged to contain a integral number of so-called "frames". It's
91      * just here for the division :
92      * buffer_size = i_nb_samples * i_bytes_per_frame / i_frame_length
93      */
94
95     /* FIXME ? (used by the codecs) */
96     unsigned     i_bitspersample;
97     unsigned     i_blockalign;
98     uint8_t      i_channels; /* must be <=32 */
99     uint8_t      i_flavor;
100 };
101
102 #ifdef WORDS_BIGENDIAN
103 #   define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','b')
104 #   define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','b')
105 #else
106 #   define AUDIO_FMT_S16_NE VLC_FOURCC('s','1','6','l')
107 #   define AUDIO_FMT_U16_NE VLC_FOURCC('u','1','6','l')
108 #endif
109
110 /**
111  * video format description
112  */
113 struct video_format_t
114 {
115     vlc_fourcc_t i_chroma;                               /**< picture chroma */
116     unsigned int i_aspect;                                 /**< aspect ratio */
117
118     unsigned int i_width;                                 /**< picture width */
119     unsigned int i_height;                               /**< picture height */
120     unsigned int i_x_offset;               /**< start offset of visible area */
121     unsigned int i_y_offset;               /**< start offset of visible area */
122     unsigned int i_visible_width;                 /**< width of visible area */
123     unsigned int i_visible_height;               /**< height of visible area */
124
125     unsigned int i_bits_per_pixel;             /**< number of bits per pixel */
126
127     unsigned int i_sar_num;                   /**< sample/pixel aspect ratio */
128     unsigned int i_sar_den;
129
130     unsigned int i_frame_rate;                     /**< frame rate numerator */
131     unsigned int i_frame_rate_base;              /**< frame rate denominator */
132
133     int i_rmask, i_gmask, i_bmask;          /**< color masks for RGB chroma */
134     int i_rrshift, i_lrshift;
135     int i_rgshift, i_lgshift;
136     int i_rbshift, i_lbshift;
137     video_palette_t *p_palette;              /**< video palette from demuxer */
138 };
139
140 /**
141  * Initialize a video_format_t structure with chroma 'i_chroma'
142  * \param p_src pointer to video_format_t structure
143  * \param i_chroma chroma value to use
144  */
145 static inline void video_format_Init( video_format_t *p_src, vlc_fourcc_t i_chroma )
146 {
147     memset( p_src, 0, sizeof( video_format_t ) );
148     p_src->i_chroma = i_chroma;
149     p_src->i_sar_num = p_src->i_sar_den = 1;
150     p_src->p_palette = NULL;
151 }
152
153 /**
154  * Copy video_format_t including the palette
155  * \param p_dst video_format_t to copy to
156  * \param p_src video_format_t to copy from
157  */
158 static inline int video_format_Copy( video_format_t *p_dst, video_format_t *p_src )
159 {
160     memcpy( p_dst, p_src, sizeof( video_format_t ) );
161     if( p_src->p_palette )
162     {
163         p_dst->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
164         if( !p_dst->p_palette )
165             return VLC_ENOMEM;
166         memcpy( p_dst->p_palette, p_src->p_palette, sizeof( video_palette_t ) );
167     }
168     return VLC_SUCCESS;
169 };
170
171 /**
172  * Cleanup and free palette of this video_format_t
173  * \param p_src video_format_t structure to clean
174  */
175 static inline void video_format_Clean( video_format_t *p_src )
176 {
177     free( p_src->p_palette );
178     memset( p_src, 0, sizeof( video_format_t ) );
179     p_src->p_palette = NULL;
180 }
181
182 /**
183  * subtitles format description
184  */
185 struct subs_format_t
186 {
187     /* the character encoding of the text of the subtitle.
188      * all gettext recognized shorts can be used */
189     char *psz_encoding;
190
191
192     int  i_x_origin; /**< x coordinate of the subtitle. 0 = left */
193     int  i_y_origin; /**< y coordinate of the subtitle. 0 = top */
194
195     struct
196     {
197         /*  */
198         uint32_t palette[16+1];
199
200         /* the width of the original movie the spu was extracted from */
201         int i_original_frame_width;
202         /* the height of the original movie the spu was extracted from */
203         int i_original_frame_height;
204     } spu;
205
206     struct
207     {
208         int i_id;
209     } dvb;
210     struct
211     {
212         int i_magazine;
213         int i_page;
214     } teletext;
215 };
216
217 /**
218  * ES language definition
219  */
220 typedef struct extra_languages_t
221 {
222         char *psz_language;
223         char *psz_description;
224 } extra_languages_t;
225
226 /**
227  * ES format definition
228  */
229 struct es_format_t
230 {
231     int             i_cat;              /**< ES category @see es_format_category_e */
232     vlc_fourcc_t    i_codec;            /**< FOURCC value as used in vlc */
233     vlc_fourcc_t    i_original_fourcc;  /**< original FOURCC from the container */
234
235     int             i_id;       /**< es identifier, where means
236                                     -1: let the core mark the right id
237                                     >=0: valid id */
238     int             i_group;    /**< group identifier, where means:
239                                     -1 : standalone
240                                     >= 0 then a "group" (program) is created
241                                         for each value */
242     int             i_priority; /**< priority, where means:
243                                     -2 : mean not selectable by the users
244                                     -1 : mean not selected by default even
245                                          when no other stream
246                                     >=0: priority */
247
248     char            *psz_language;        /**< human readible language name */
249     char            *psz_description;     /**< human readible description of language */
250     int             i_extra_languages;    /**< length in bytes of extra language data pointer */
251     extra_languages_t *p_extra_languages; /**< extra language data needed by some decoders */
252
253     audio_format_t  audio;    /**< description of audio format */
254     audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
255     video_format_t video;     /**< description of video format */
256     subs_format_t  subs;      /**< description of subtitle format */
257
258     unsigned int   i_bitrate; /**< bitrate of this ES */
259
260     bool     b_packetized;  /**< wether the data is packetized (ie. not truncated) */
261     int     i_extra;        /**< length in bytes of extra data pointer */
262     void    *p_extra;       /**< extra data needed by some decoders or muxers */
263
264 };
265
266 /** ES Categories */
267 enum es_format_category_e
268 {
269     UNKNOWN_ES = 0x00,
270     VIDEO_ES   = 0x01,
271     AUDIO_ES   = 0x02,
272     SPU_ES     = 0x03,
273     NAV_ES     = 0x04,
274 };
275
276 /**
277  * This function will fill all RGB shift from RGB masks.
278  */
279 VLC_EXPORT( void, video_format_FixRgb, ( video_format_t * ) );
280
281 /**
282  * This funtion will initialize a es_format_t structure.
283  */
284 VLC_EXPORT( void, es_format_Init, ( es_format_t *, int i_cat, vlc_fourcc_t i_codec ) );
285
286 /**
287  * This functions will copy a es_format_t.
288  */
289 VLC_EXPORT( int, es_format_Copy, ( es_format_t *p_dst, const es_format_t *p_src ) );
290
291 /**
292  * This function will clean up a es_format_t and relasing all associated
293  * resources.
294  * You can call it multiple times on the same structure.
295  */
296 VLC_EXPORT( void, es_format_Clean, ( es_format_t *fmt ) );
297
298 #endif