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.19 2000/12/26 19:14:46 massiot 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 #ifndef SYS_SOLARIS
  41 typedef int                 boolean_t;
  42 #else
  43 #   include <sys/types.h>
  44 #endif
  45 #ifdef SYS_GNU
  46 #   define _MACH_I386_BOOLEAN_H_
  47 #endif
  48
  49 /* ptrdiff_t definition */
  50 #ifdef _HAVE_STDDEF_H
  51 #   include <stddef.h>
  52 #else
  53 #   include <malloc.h>
  54 #endif
  55
  56 #ifndef _PTRDIFF_T
  57 #   define _PTRDIFF_T
  58 /* Not portable in a 64-bit environment. */
  59 typedef int                 ptrdiff_t;
  60 #endif
  61
  62 /* Counter for statistics and profiling */
  63 typedef unsigned long       count_t;
  64
  65 /*****************************************************************************
  66  * Classes declaration
  67  *****************************************************************************/
  68
  69 /* Plugins */
  70 struct plugin_bank_s;
  71 struct plugin_info_s;
  72
  73 typedef struct plugin_bank_s *          p_plugin_bank_t;
  74 typedef struct plugin_info_s *          p_plugin_info_t;
  75
  76 /* Playlist */
  77 struct playlist_s;
  78
  79 typedef struct playlist_s *             p_playlist_t;
  80
  81 /* Interface */
  82 struct intf_thread_s;
  83 struct intf_sys_s;
  84 struct intf_console_s;
  85 struct intf_msg_s;
  86 struct intf_channel_s;
  87
  88 typedef struct intf_thread_s *          p_intf_thread_t;
  89 typedef struct intf_sys_s *             p_intf_sys_t;
  90 typedef struct intf_console_s *         p_intf_console_t;
  91 typedef struct intf_msg_s *             p_intf_msg_t;
  92 typedef struct intf_channel_s *         p_intf_channel_t;
  93
  94 /* Input */
  95 struct input_thread_s;
  96 struct input_vlan_s;
  97 struct input_cfg_s;
  98
  99 typedef struct input_thread_s *         p_input_thread_t;
 100 typedef struct input_vlan_s *           p_input_vlan_t;
 101 typedef struct input_cfg_s *            p_input_cfg_t;
 102
 103 /* Audio */
 104 struct aout_thread_s;
 105 struct aout_sys_s;
 106
 107 typedef struct aout_thread_s *          p_aout_thread_t;
 108 typedef struct aout_sys_s *             p_aout_sys_t;
 109
 110 /* Video */
 111 struct vout_thread_s;
 112 struct vout_font_s;
 113 struct vout_sys_s;
 114 struct vdec_thread_s;
 115 struct vpar_thread_s;
 116 struct video_parser_s;
 117
 118 typedef struct vout_thread_s *          p_vout_thread_t;
 119 typedef struct vout_font_s *            p_vout_font_t;
 120 typedef struct vout_sys_s *             p_vout_sys_t;
 121 typedef struct vdec_thread_s *          p_vdec_thread_t;
 122 typedef struct vpar_thread_s *          p_vpar_thread_t;
 123 typedef struct video_parser_s *         p_video_parser_t;
 124
 125 /*****************************************************************************
 126  * Macros and inline functions
 127  *****************************************************************************/
 128
 129 /* CEIL: division with round to nearest greater integer */
 130 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 131
 132 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 133 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 134
 135 /* MAX and MIN: self explanatory */
 136 #ifndef MAX
 137 #define MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 138 #endif
 139 #ifndef MIN
 140 #define MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 141 #endif
 142
 143 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 144  * MSB, and should be used for both network communications and files. Note that
 145  * byte orders other than little and big endians are not supported, but only
 146  * the VAX seems to have such exotic properties - note that these 'functions'
 147  * needs <netinet/in.h> or the local equivalent. */
 148 /* FIXME??: hton64 should be declared as an extern inline function to avoid border
 149  * effects (see byteorder.h) */
 150 #if __BYTE_ORDER == __LITTLE_ENDIAN
 151 #define hton16      htons
 152 #define hton32      htonl
 153 #define hton64(i)   ( ((u64)(htonl((i) & 0xffffffff)) << 32) | htonl(((i) >> 32) & 0xffffffff ) )
 154 #define ntoh16      ntohs
 155 #define ntoh32      ntohl
 156 #define ntoh64      hton64
 157 #elif __BYTE_ORDER == __BIG_ENDIAN
 158 #define hton16      htons
 159 #define hton32      htonl
 160 #define hton64(i)   ( i )
 161 #define ntoh16      ntohs
 162 #define ntoh32      ntohl
 163 #define ntoh64(i)   ( i )
 164 #else
 165 /* XXX??: cause a compilation error */
 166 #endif
 167
 168 /* Macros with automatic casts */
 169 #define U32_AT(p)   ( ntohl ( *( (u32 *)(p) ) ) )
 170 #define U16_AT(p)   ( ntohs ( *( (u16 *)(p) ) ) )