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

   1 /*****************************************************************************
   2  * common.h: common definitions
   3  * Collection of useful common types and macros definitions
   4  *****************************************************************************
   5  * Copyright (C) 1998, 1999, 2000 VideoLAN
   6  * $Id: common.h,v 1.38 2001/08/14 04:52:39 sam Exp $
   7  *
   8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
   9  *          Vincent Seguin <seguin@via.ecp.fr>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * required headers:
  28  *  config.h
  29  *****************************************************************************/
  30
  31 /*****************************************************************************
  32  * Basic types definitions
  33  *****************************************************************************/
  34
  35 #include "int_types.h"
  36
  37 typedef u8                  byte_t;
  38
  39 /* Boolean type */
  40 #ifdef BOOLEAN_T_IN_SYS_TYPES_H
  41 #   include <sys/types.h>
  42 #elif defined(BOOLEAN_T_IN_PTHREAD_H)
  43 #   include <pthread.h>
  44 #elif defined(BOOLEAN_T_IN_CTHREADS_H)
  45 #   include <cthreads.h>
  46 #else
  47 typedef int                 boolean_t;
  48 #endif
  49 #ifdef SYS_GNU
  50 #   define _MACH_I386_BOOLEAN_H_
  51 #endif
  52
  53 /* ptrdiff_t definition */
  54 #ifdef HAVE_STDDEF_H
  55 #   include <stddef.h>
  56 #else
  57 #   include <malloc.h>
  58 #   ifndef _PTRDIFF_T
  59 #       define _PTRDIFF_T
  60 /* Not portable in a 64-bit environment. */
  61 typedef int                 ptrdiff_t;
  62 #   endif
  63 #endif
  64
  65 /* Counter for statistics and profiling */
  66 typedef unsigned long       count_t;
  67
  68 /* DCT elements types */
  69 #ifndef VDEC_DFT
  70 typedef short dctelem_t;
  71 #else
  72 typedef int dctelem_t;
  73 #endif
  74
  75 /*****************************************************************************
  76  * Classes declaration
  77  *****************************************************************************/
  78
  79 /* Plugins */
  80 struct plugin_bank_s;
  81 struct plugin_info_s;
  82
  83 typedef struct plugin_bank_s *          p_plugin_bank_t;
  84 typedef struct plugin_info_s *          p_plugin_info_t;
  85
  86 /* Plugins */
  87 struct playlist_s;
  88 struct playlist_item_s;
  89
  90 typedef struct playlist_s *             p_playlist_t;
  91 typedef struct playlist_item_s *        p_playlist_item_t;
  92
  93 /* Interface */
  94 struct intf_thread_s;
  95 struct intf_sys_s;
  96 struct intf_console_s;
  97 struct intf_msg_s;
  98 struct intf_channel_s;
  99
 100 typedef struct intf_thread_s *          p_intf_thread_t;
 101 typedef struct intf_sys_s *             p_intf_sys_t;
 102 typedef struct intf_console_s *         p_intf_console_t;
 103 typedef struct intf_msg_s *             p_intf_msg_t;
 104 typedef struct intf_channel_s *         p_intf_channel_t;
 105
 106 /* Input */
 107 struct input_thread_s;
 108 struct input_channel_s;
 109 struct input_cfg_s;
 110
 111 typedef struct input_thread_s *         p_input_thread_t;
 112 typedef struct input_channel_s *        p_input_channel_t;
 113 typedef struct input_cfg_s *            p_input_cfg_t;
 114
 115 /* Audio */
 116 struct aout_thread_s;
 117 struct aout_sys_s;
 118
 119 typedef struct aout_thread_s *          p_aout_thread_t;
 120 typedef struct aout_sys_s *             p_aout_sys_t;
 121
 122 /* Video */
 123 struct vout_thread_s;
 124 struct vout_font_s;
 125 struct vout_sys_s;
 126 struct vdec_thread_s;
 127 struct vpar_thread_s;
 128 struct video_parser_s;
 129
 130 typedef struct vout_thread_s *          p_vout_thread_t;
 131 typedef struct vout_font_s *            p_vout_font_t;
 132 typedef struct vout_sys_s *             p_vout_sys_t;
 133 typedef struct vdec_thread_s *          p_vdec_thread_t;
 134 typedef struct vpar_thread_s *          p_vpar_thread_t;
 135 typedef struct video_parser_s *         p_video_parser_t;
 136
 137 /* Misc */
 138 struct macroblock_s;
 139 struct data_packet_s;
 140 struct es_descriptor_s;
 141 struct pgrm_descriptor_s;
 142
 143 /*****************************************************************************
 144  * Macros and inline functions
 145  *****************************************************************************/
 146 #ifdef NTOHL_IN_SYS_PARAM_H
 147 #   include <sys/param.h>
 148 #elif defined(WIN32)
 149 #   include <winsock.h>
 150 #else
 151 #   include <netinet/in.h>
 152 #endif
 153
 154 /* CEIL: division with round to nearest greater integer */
 155 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 156
 157 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 158 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 159
 160 /* MAX and MIN: self explanatory */
 161 #ifndef MAX
 162 #   define MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 163 #endif
 164 #ifndef MIN
 165 #   define MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 166 #endif
 167
 168 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 169  * MSB, and should be used for both network communications and files. Note that
 170  * byte orders other than little and big endians are not supported, but only
 171  * the VAX seems to have such exotic properties - note that these 'functions'
 172  * needs <netinet/in.h> or the local equivalent. */
 173 /* FIXME: hton64 should be declared as an extern inline function to avoid
 174  * border effects (see byteorder.h) */
 175 #if WORDS_BIGENDIAN
 176 #   define hton16      htons
 177 #   define hton32      htonl
 178 #   define hton64(i)   ( i )
 179 #   define ntoh16      ntohs
 180 #   define ntoh32      ntohl
 181 #   define ntoh64(i)   ( i )
 182 #else
 183 #   define hton16      htons
 184 #   define hton32      htonl
 185 #   define hton64(i)   ( ((u64)(htonl((i) & 0xffffffff)) << 32) | htonl(((i) >> 32) & 0xffffffff ) )
 186 #   define ntoh16      ntohs
 187 #   define ntoh32      ntohl
 188 #   define ntoh64      hton64
 189 #endif
 190
 191 /* Macros with automatic casts */
 192 #define U64_AT(p)   ( ntoh64 ( *( (u64 *)(p) ) ) )
 193 #define U32_AT(p)   ( ntoh32 ( *( (u32 *)(p) ) ) )
 194 #define U16_AT(p)   ( ntoh16 ( *( (u16 *)(p) ) ) )
 195
 196 /* win32, cl and icl support */
 197 #if defined( _MSC_VER )
 198 #   define __attribute__(x)
 199 #   define __inline__      __inline
 200 #   define strncasecmp     strnicmp
 201 #   define strcasecmp      stricmp
 202 #   define S_ISBLK(m)      (0)
 203 #   define S_ISCHR(m)      (0)
 204 #   define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 205 #   define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 206 #   define I64C(x)         x
 207 #else
 208 #   define I64C(x)         x##LL
 209 #endif
 210
 211 #if defined( WIN32 )
 212 #   ifndef _OFF_T_DEFINED
 213 typedef __int64 off_t;
 214 #       define _OFF_T_DEFINED
 215 #   endif
 216 #   ifndef snprintf
 217 #       define snprintf _snprintf  /* snprintf not defined in mingw32 (bug?) */
 218 #   endif
 219 #endif