common.h 5.92 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2
 * common.h: common definitions
3
 * Collection of useful common types and macros definitions
4
 *****************************************************************************
5
 * Copyright (C) 1998, 1999, 2000 VideoLAN
Sam Hocevar's avatar
 
Sam Hocevar committed
6
 * $Id: common.h,v 1.32 2001/05/30 17:03:11 sam Exp $
7
 *
8 9
 * Authors: Samuel Hocevar <sam@via.ecp.fr>
 *          Vincent Seguin <seguin@via.ecp.fr>
10 11 12 13 14
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
15
 * 
16 17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
20
 *
21 22 23
 * 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.
24 25 26
 *****************************************************************************/

/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
27 28
 * required headers:
 *  config.h
29
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
30

31
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
32
 * Basic types definitions
33
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
34

Michel Lespinasse's avatar
 
Michel Lespinasse committed
35
#include "int_types.h"
Michel Kaempf's avatar
Michel Kaempf committed
36 37

typedef u8                  byte_t;
38

Michel Kaempf's avatar
Michel Kaempf committed
39
/* Boolean type */
Sam Hocevar's avatar
 
Sam Hocevar committed
40
#ifdef BOOLEAN_T_IN_SYS_TYPES_H
41
#   include <sys/types.h>
42 43
#elif defined(BOOLEAN_T_IN_PTHREAD_H)
#   include <pthread.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
44 45
#else
typedef int                 boolean_t;
Benoit Steiner's avatar
Benoit Steiner committed
46
#endif
47
#ifdef SYS_GNU
48 49 50 51
#   define _MACH_I386_BOOLEAN_H_
#endif

/* ptrdiff_t definition */
Christophe Massiot's avatar
Christophe Massiot committed
52
#ifdef HAVE_STDDEF_H
53 54 55
#   include <stddef.h>
#else
#   include <malloc.h>
Christophe Massiot's avatar
Christophe Massiot committed
56 57
#   ifndef _PTRDIFF_T
#       define _PTRDIFF_T
58 59
/* Not portable in a 64-bit environment. */
typedef int                 ptrdiff_t;
Christophe Massiot's avatar
Christophe Massiot committed
60
#   endif
61
#endif
Michel Kaempf's avatar
Michel Kaempf committed
62 63 64 65

/* Counter for statistics and profiling */
typedef unsigned long       count_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
66 67 68 69 70 71 72
/* DCT elements types */
#ifndef VDEC_DFT
typedef short dctelem_t;
#else
typedef int dctelem_t;
#endif

73
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
74
 * Classes declaration
75
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
76

77 78 79 80 81 82 83
/* Plugins */
struct plugin_bank_s;
struct plugin_info_s;

typedef struct plugin_bank_s *          p_plugin_bank_t;
typedef struct plugin_info_s *          p_plugin_info_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
84
/* Plugins */
85
struct playlist_s;
Sam Hocevar's avatar
 
Sam Hocevar committed
86
struct playlist_item_s;
87 88

typedef struct playlist_s *             p_playlist_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
89
typedef struct playlist_item_s *        p_playlist_item_t;
90

Vincent Seguin's avatar
Vincent Seguin committed
91 92 93 94 95
/* Interface */
struct intf_thread_s;
struct intf_sys_s;
struct intf_console_s;
struct intf_msg_s;
96
struct intf_channel_s;
Vincent Seguin's avatar
Vincent Seguin committed
97 98 99 100 101

typedef struct intf_thread_s *          p_intf_thread_t;
typedef struct intf_sys_s *             p_intf_sys_t;
typedef struct intf_console_s *         p_intf_console_t;
typedef struct intf_msg_s *             p_intf_msg_t;
102
typedef struct intf_channel_s *         p_intf_channel_t;
Vincent Seguin's avatar
Vincent Seguin committed
103 104 105

/* Input */
struct input_thread_s;
Henri Fallon's avatar
 
Henri Fallon committed
106
struct input_channel_s;
Vincent Seguin's avatar
Vincent Seguin committed
107 108 109
struct input_cfg_s;

typedef struct input_thread_s *         p_input_thread_t;
Henri Fallon's avatar
 
Henri Fallon committed
110
typedef struct input_channel_s *        p_input_channel_t;
Vincent Seguin's avatar
Vincent Seguin committed
111 112 113 114
typedef struct input_cfg_s *            p_input_cfg_t;

/* Audio */
struct aout_thread_s;
115
struct aout_sys_s;
Vincent Seguin's avatar
Vincent Seguin committed
116 117

typedef struct aout_thread_s *          p_aout_thread_t;
118
typedef struct aout_sys_s *             p_aout_sys_t;
Vincent Seguin's avatar
Vincent Seguin committed
119 120 121

/* Video */
struct vout_thread_s;
Vincent Seguin's avatar
Vincent Seguin committed
122
struct vout_font_s;
Vincent Seguin's avatar
Vincent Seguin committed
123 124 125 126 127 128
struct vout_sys_s;
struct vdec_thread_s;
struct vpar_thread_s;
struct video_parser_s;

typedef struct vout_thread_s *          p_vout_thread_t;
Vincent Seguin's avatar
Vincent Seguin committed
129
typedef struct vout_font_s *            p_vout_font_t;
Vincent Seguin's avatar
Vincent Seguin committed
130 131 132 133 134
typedef struct vout_sys_s *             p_vout_sys_t;
typedef struct vdec_thread_s *          p_vdec_thread_t;
typedef struct vpar_thread_s *          p_vpar_thread_t;
typedef struct video_parser_s *         p_video_parser_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
135 136
/* Misc */
struct macroblock_s;
Sam Hocevar's avatar
 
Sam Hocevar committed
137
struct data_packet_s;
Sam Hocevar's avatar
 
Sam Hocevar committed
138
struct es_descriptor_s;
Sam Hocevar's avatar
 
Sam Hocevar committed
139

140
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
141
 * Macros and inline functions
142
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
143

Christophe Massiot's avatar
Christophe Massiot committed
144 145
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
146
#elif defined(WIN32)
Christophe Massiot's avatar
Christophe Massiot committed
147 148 149 150
#else
#   include <netinet/in.h>
#endif

Michel Kaempf's avatar
Michel Kaempf committed
151 152 153 154 155 156 157
/* CEIL: division with round to nearest greater integer */
#define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )

/* PAD: PAD(n, d) = CEIL(n ,d) * d */
#define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )

/* MAX and MIN: self explanatory */
158
#ifndef MAX
Michel Kaempf's avatar
Michel Kaempf committed
159
#define MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
160 161
#endif
#ifndef MIN
Michel Kaempf's avatar
Michel Kaempf committed
162
#define MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
163
#endif
Michel Kaempf's avatar
Michel Kaempf committed
164

165
/* MSB (big endian)/LSB (little endian) conversions - network order is always
Michel Kaempf's avatar
Michel Kaempf committed
166 167 168 169
 * MSB, and should be used for both network communications and files. Note that
 * byte orders other than little and big endians are not supported, but only
 * the VAX seems to have such exotic properties - note that these 'functions'
 * needs <netinet/in.h> or the local equivalent. */
Sam Hocevar's avatar
 
Sam Hocevar committed
170 171 172
/* FIXME: hton64 should be declared as an extern inline function to avoid
 * border effects (see byteorder.h) */
#if WORDS_BIGENDIAN
Michel Kaempf's avatar
Michel Kaempf committed
173 174
#define hton16      htons
#define hton32      htonl
Sam Hocevar's avatar
 
Sam Hocevar committed
175
#define hton64(i)   ( i )
176
#define ntoh16      ntohs
Michel Kaempf's avatar
Michel Kaempf committed
177
#define ntoh32      ntohl
Sam Hocevar's avatar
 
Sam Hocevar committed
178 179
#define ntoh64(i)   ( i )
#else
Michel Kaempf's avatar
Michel Kaempf committed
180 181
#define hton16      htons
#define hton32      htonl
Sam Hocevar's avatar
 
Sam Hocevar committed
182
#define hton64(i)   ( ((u64)(htonl((i) & 0xffffffff)) << 32) | htonl(((i) >> 32) & 0xffffffff ) )
Michel Kaempf's avatar
Michel Kaempf committed
183 184
#define ntoh16      ntohs
#define ntoh32      ntohl
Sam Hocevar's avatar
 
Sam Hocevar committed
185
#define ntoh64      hton64
Michel Kaempf's avatar
Michel Kaempf committed
186 187
#endif

188
/* Macros with automatic casts */
189 190 191
#define U64_AT(p)   ( ntoh64 ( *( (u64 *)(p) ) ) )
#define U32_AT(p)   ( ntoh32 ( *( (u32 *)(p) ) ) )
#define U16_AT(p)   ( ntoh16 ( *( (u16 *)(p) ) ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
192