vlc_common.h 38.2 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3 4
/*****************************************************************************
 * common.h: common definitions
 * Collection of useful common types and macros definitions
 *****************************************************************************
5
 * Copyright (C) 1998-2005 the VideoLAN team
6
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
7 8 9
 *
 * Authors: Samuel Hocevar <sam@via.ecp.fr>
 *          Vincent Seguin <seguin@via.ecp.fr>
10
 *          Gildas Bazin <gbazin@videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
11 12 13 14 15
 *
 * 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.
16
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
17 18 19 20 21 22 23
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
25 26
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
27
/**
Sam Hocevar's avatar
Sam Hocevar committed
28
 * \file
Clément Stenac's avatar
Clément Stenac committed
29 30 31
 * This file is a collection of common definitions and types
 */

32 33 34 35 36
#ifndef PACKAGE
/* Temporary regression test */
#error You probably forgot to include config.h!!
#endif

37
/*****************************************************************************
38
 * Required vlc headers
39
 *****************************************************************************/
40
#if defined( _MSC_VER )
Gildas Bazin's avatar
 
Gildas Bazin committed
41
#   pragma warning( disable : 4244 )
42 43
#endif

44 45
#include "vlc_config.h"

Sam Hocevar's avatar
 
Sam Hocevar committed
46 47 48
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
49
#include <stdlib.h>
50 51
#include <stdarg.h>

52
#include <string.h>
53
#include <stdio.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
54 55 56 57

#ifdef HAVE_SYS_TYPES_H
#   include <sys/types.h>
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
58 59 60 61

/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
62
#if defined( HAVE_STDINT_H )
63
#   include <stdint.h>
64 65
#elif defined( HAVE_INTTYPES_H )
#   include <inttypes.h>
66 67 68 69 70 71 72
#elif defined( SYS_CYGWIN )
#   include <sys/types.h>
    /* Cygwin only defines half of these... */
    typedef u_int8_t            uint8_t;
    typedef u_int16_t           uint16_t;
    typedef u_int32_t           uint32_t;
    typedef u_int64_t           uint64_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
73
#else
74 75 76 77 78 79 80
    /* Fallback types (very x86-centric, sorry) */
    typedef unsigned char       uint8_t;
    typedef signed char         int8_t;
    typedef unsigned short      uint16_t;
    typedef signed short        int16_t;
    typedef unsigned int        uint32_t;
    typedef signed int          int32_t;
81 82 83
#   if defined( _MSC_VER ) \
      || defined( UNDER_CE ) \
      || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
84 85
    typedef unsigned __int64    uint64_t;
    typedef signed __int64      int64_t;
86
#   else
87 88
    typedef unsigned long long  uint64_t;
    typedef signed long long    int64_t;
89
#   endif
Sam Hocevar's avatar
Sam Hocevar committed
90 91
    typedef uint32_t            uintptr_t;
    typedef int32_t             intptr_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
92 93
#endif

94 95 96 97 98 99 100 101 102
/* Systems that don't have stdint.h may not define INT64_MIN and
   INT64_MAX */
#ifndef INT64_MIN
#define INT64_MIN (-9223372036854775807LL-1)
#endif
#ifndef INT64_MAX
#define INT64_MAX (9223372036854775807LL)
#endif

103
#if defined( WIN32 ) || defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
104
#   include <malloc.h>
105 106 107
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
108 109
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
110 111 112 113
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

/* DCT elements types */
114
typedef int16_t             dctelem_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
115 116

/* Video buffer types */
117
typedef uint8_t             yuv_data_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
118

119
/* Audio volume */
120 121
typedef uint16_t            audio_volume_t;

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
122 123 124
/**
 * High precision date or time interval
 *
125 126
 * Store a high precision date or time interval. The maximum precision is the
 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
Sam Hocevar's avatar
 
Sam Hocevar committed
127
 * time interval is then 292271 years, which should be long enough for any
128 129
 * video). Dates are stored as microseconds since a common date (usually the
 * epoch). Note that date and time intervals can be manipulated using regular
Sam Hocevar's avatar
 
Sam Hocevar committed
130
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
131
 */
132
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
133

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
134
/**
135
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
136
 *
137
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
138
 */
139
typedef uint32_t vlc_fourcc_t;
140

141 142
#ifdef WORDS_BIGENDIAN
#   define VLC_FOURCC( a, b, c, d ) \
143 144
        ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
           | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
145
#   define VLC_TWOCC( a, b ) \
146
        ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
147

148 149
#else
#   define VLC_FOURCC( a, b, c, d ) \
150 151
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
152
#   define VLC_TWOCC( a, b ) \
153
        ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
154 155

#endif
156

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
{
#ifdef WORDS_BIGENDIAN
    psz_fourcc[0] = (uint32_t) (fcc >> 24);
    psz_fourcc[1] = (uint32_t) (fcc >> 16);
    psz_fourcc[2] = (uint32_t) (fcc >> 8);
    psz_fourcc[3] = (uint32_t) (fcc);
#else
    psz_fourcc[3] = (uint32_t) (fcc >> 24);
    psz_fourcc[2] = (uint32_t) (fcc >> 16);
    psz_fourcc[1] = (uint32_t) (fcc >> 8);
    psz_fourcc[0] = (uint32_t) (fcc);
#endif
}

#define vlc_fourcc_to_char( a, b ) \
    __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )

Sam Hocevar's avatar
 
Sam Hocevar committed
175 176 177 178
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

179
/* Internal types */
180 181
typedef struct libvlc_global_data_t libvlc_global_data_t;
typedef struct libvlc_int_t libvlc_int_t;
Sam Hocevar's avatar
Sam Hocevar committed
182
typedef struct variable_t variable_t;
183
typedef struct date_t date_t;
Clément Stenac's avatar
Clément Stenac committed
184 185
typedef struct dict_entry_t dict_entry_t;
typedef struct dict_t dict_t;
186
typedef struct gc_object_t gc_object_t ;
187

188
/* Messages */
189
typedef struct msg_bank_t msg_bank_t;
190
typedef struct msg_queue_t msg_queue_t;
191
typedef struct msg_subscription_t msg_subscription_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
192

Gildas Bazin's avatar
 
Gildas Bazin committed
193
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
194 195 196 197 198 199

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
200
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
201 202
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
203 204 205
    PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
    PLAYLIST_STOP,      /**< No arg                             res=can fail*/
    PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
206 207 208
} playlist_command_t;


209 210
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
211
typedef struct playlist_view_t playlist_view_t;
212
typedef struct playlist_export_t playlist_export_t;
213 214
typedef struct services_discovery_t services_discovery_t;
typedef struct services_discovery_sys_t services_discovery_sys_t;
Clément Stenac's avatar
Clément Stenac committed
215
typedef struct playlist_add_t playlist_add_t;
216
typedef struct playlist_preparse_t playlist_preparse_t;
217
typedef struct playlist_fetcher_t playlist_fetcher_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
218

219
/* Modules */
220 221 222 223
typedef struct module_bank_t module_bank_t;
typedef struct module_t module_t;
typedef struct module_config_t module_config_t;
typedef struct module_symbols_t module_symbols_t;
224
typedef struct module_cache_t module_cache_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
225

Clément Stenac's avatar
Clément Stenac committed
226 227
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
228
/* Interface */
229 230 231 232
typedef struct intf_thread_t intf_thread_t;
typedef struct intf_sys_t intf_sys_t;
typedef struct intf_console_t intf_console_t;
typedef struct intf_msg_t intf_msg_t;
233 234 235
typedef struct interaction_t interaction_t;
typedef struct interaction_dialog_t interaction_dialog_t;
typedef struct user_widget_t user_widget_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
236 237

/* Input */
238
typedef struct input_thread_t input_thread_t;
239
typedef struct input_thread_sys_t input_thread_sys_t;
240
typedef struct input_item_t input_item_t;
241
typedef struct access_t access_t;
242
typedef struct access_sys_t access_sys_t;
243 244 245
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
246
typedef struct demux_meta_t demux_meta_t;
247
typedef struct demux_sys_t demux_sys_t;
248 249 250
typedef struct es_out_t     es_out_t;
typedef struct es_out_id_t  es_out_id_t;
typedef struct es_out_sys_t es_out_sys_t;
251
typedef struct es_descriptor_t es_descriptor_t;
Gildas Bazin's avatar
Gildas Bazin committed
252
typedef struct seekpoint_t seekpoint_t;
253 254
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
255
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
256

257 258 259 260
/* Format */
typedef struct audio_format_t audio_format_t;
typedef struct video_format_t video_format_t;
typedef struct subs_format_t subs_format_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
261 262
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
263

Sam Hocevar's avatar
 
Sam Hocevar committed
264
/* Audio */
265 266
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
267
typedef struct aout_fifo_t aout_fifo_t;
268 269
typedef struct aout_input_t aout_input_t;
typedef struct aout_buffer_t aout_buffer_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
270
typedef audio_format_t audio_sample_format_t;
271
typedef struct audio_date_t audio_date_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
272
typedef struct aout_filter_t aout_filter_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
273 274

/* Video */
275 276 277
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
typedef struct chroma_sys_t chroma_sys_t;
278

Gildas Bazin's avatar
 
Gildas Bazin committed
279
typedef video_format_t video_frame_format_t;
280 281 282
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
283

284
/* Subpictures */
285
typedef struct spu_t spu_t;
286 287
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
288
typedef struct subpicture_region_t subpicture_region_t;
289
typedef struct text_style_t text_style_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
290

291 292
typedef struct image_handler_t image_handler_t;

293 294
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
295 296
typedef struct sout_instance_sys_t sout_instance_sys_t;

297
typedef struct sout_input_t sout_input_t;
298
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
299

300
typedef struct sout_access_out_t sout_access_out_t;
301 302
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

303
typedef struct sout_mux_t sout_mux_t;
304 305
typedef struct sout_mux_sys_t sout_mux_sys_t;

306
typedef struct sout_stream_t    sout_stream_t;
307 308
typedef struct sout_stream_sys_t sout_stream_sys_t;

309
typedef struct config_chain_t       config_chain_t;
310 311 312 313 314 315
typedef struct sap_session_t    sap_session_t;
typedef struct sap_address_t sap_address_t;
typedef struct session_descriptor_t session_descriptor_t;
typedef struct announce_method_t announce_method_t;
typedef struct announce_handler_t announce_handler_t;
typedef struct sap_handler_t sap_handler_t;
316

317 318
typedef struct sout_param_t sout_param_t;
typedef struct sout_pcat_t sout_pcat_t;
319 320 321 322 323 324 325 326
typedef struct sout_std_t sout_std_t;
typedef struct sout_display_t sout_display_t;
typedef struct sout_duplicate_t sout_duplicate_t;
typedef struct sout_transcode_t sout_transcode_t;
typedef struct sout_chain_t sout_chain_t;
typedef struct streaming_profile_t streaming_profile_t;
typedef struct sout_module_t sout_module_t;
typedef struct sout_gui_descr_t sout_gui_descr_t;
327
typedef struct profile_parser_t profile_parser_t;
328

Sam Hocevar's avatar
 
Sam Hocevar committed
329
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
330 331 332
typedef struct decoder_t         decoder_t;
typedef struct decoder_sys_t     decoder_sys_t;
typedef struct decoder_synchro_t decoder_synchro_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
333

Gildas Bazin's avatar
 
Gildas Bazin committed
334 335 336 337
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

338 339 340 341
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

342
/* Network */
343
typedef struct network_socket_t network_socket_t;
344
typedef struct virtual_socket_t v_socket_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
345 346
typedef struct sockaddr sockaddr;
typedef struct addrinfo addrinfo;
347
typedef struct vlc_acl_t vlc_acl_t;
348
typedef struct vlc_url_t vlc_url_t;
349

350 351
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;
Clément Stenac's avatar
Clément Stenac committed
352
typedef struct device_t device_t;
353 354
typedef struct device_probe_t device_probe_t;
typedef struct probe_sys_t probe_sys_t;
355

356 357 358 359
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

360 361 362 363 364 365 366
/* httpd */
typedef struct httpd_t          httpd_t;
typedef struct httpd_host_t     httpd_host_t;
typedef struct httpd_url_t      httpd_url_t;
typedef struct httpd_client_t   httpd_client_t;
typedef struct httpd_callback_sys_t httpd_callback_sys_t;
typedef struct httpd_message_t  httpd_message_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
367
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
368 369
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
370 371 372
typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
typedef struct httpd_handler_t  httpd_handler_t;
typedef struct httpd_handler_sys_t httpd_handler_sys_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
373
typedef int (*httpd_handler_callback_t)( httpd_handler_sys_t *, httpd_handler_t *, char *psz_url, uint8_t *psz_request, int i_type, uint8_t *p_in, int i_in, char *psz_remote_addr, char *psz_remote_host, uint8_t **pp_data, int *pi_data );
374 375 376
typedef struct httpd_redirect_t httpd_redirect_t;
typedef struct httpd_stream_t httpd_stream_t;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
377 378 379 380
/* TLS support */
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

381 382 383
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
384 385 386 387 388 389
/* XML */
typedef struct xml_t xml_t;
typedef struct xml_sys_t xml_sys_t;
typedef struct xml_reader_t xml_reader_t;
typedef struct xml_reader_sys_t xml_reader_sys_t;

390 391 392
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
393
typedef struct vod_media_t vod_media_t;
394

395 396 397 398
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

399 400 401 402 403 404 405
/* osdmenu */
typedef struct osd_menu_t   osd_menu_t;
typedef struct osd_state_t  osd_state_t;
typedef struct osd_event_t  osd_event_t;
typedef struct osd_button_t osd_button_t;
typedef struct osd_menu_state_t osd_menu_state_t;

406
/* VLM */
407 408
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
409 410 411

/* divers */
typedef struct vlc_meta_t    vlc_meta_t;
Rafaël Carré's avatar
Rafaël Carré committed
412
typedef struct meta_export_t meta_export_t;
413

414
/* Stats */
415 416 417
typedef struct counter_t     counter_t;
typedef struct counter_sample_t counter_sample_t;
typedef struct stats_handler_t stats_handler_t;
Clément Stenac's avatar
Clément Stenac committed
418
typedef struct input_stats_t input_stats_t;
419
typedef struct global_stats_t global_stats_t;
420

421 422 423
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
424

425 426 427
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

428 429
/* stat/lstat/fstat */
#ifdef WIN32
430
#include <sys/stat.h>
431
struct _stati64;
432 433 434
#define stat _stati64
#define fstat _fstati64
/* You should otherwise use utf8_stat and utf8_lstat. */
435 436 437 438
#else
struct stat;
#endif

439 440 441 442 443 444 445 446 447
/*****************************************************************************
 * Variable callbacks
 *****************************************************************************/
typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
                                   char const *,            /* variable name */
                                   vlc_value_t,                 /* old value */
                                   vlc_value_t,                 /* new value */
                                   void * );                /* callback data */

Gildas Bazin's avatar
 
Gildas Bazin committed
448 449 450
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
451

Clément Stenac's avatar
Clément Stenac committed
452
#include "vlc_modules_macros.h"
453

454 455
#if defined (WIN32) && defined (DLL_EXPORT)
#  ifdef __cplusplus
456 457
#    define VLC_PUBLIC_API extern "C" __declspec(dllexport)
#    define VLC_PRIVATE_API extern "C" __declspec(dllexport)
Damien Fouilleul's avatar
Damien Fouilleul committed
458
#    define   VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
459 460
#    define VLC_INTERNAL( type, name, args ) extern "C" type name args
#  else
461 462
#    define VLC_PUBLIC_API extern __declspec(dllexport)
#    define VLC_PRIVATE_API extern __declspec(dllexport)
Damien Fouilleul's avatar
Damien Fouilleul committed
463
#    define   VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
464 465 466
#    define VLC_INTERNAL( type, name, args ) type name args
#  endif
#else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
467
#  ifdef __cplusplus
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
468
#    ifdef HAVE_ATTRIBUTE_VISIBILITY
469 470
#      define VLC_PUBLIC_API extern "C" __attribute__((visibility("default")))
#      define VLC_PRIVATE_API extern "C" __attribute__((visibility("default")))
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
471 472
#      define   VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
#      define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
Damien Fouilleul's avatar
Damien Fouilleul committed
473
#    else
474
#      define VLC_PUBLIC_API extern "C"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
475 476
#      define   VLC_EXPORT( type, name, args ) extern "C" type name args
#      define VLC_INTERNAL( type, name, args ) extern "C" type name args
Damien Fouilleul's avatar
Damien Fouilleul committed
477
#    endif
478
#  else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
479
#    ifdef HAVE_ATTRIBUTE_VISIBILITY
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
480 481 482 483 484
#      define VLC_PUBLIC_API extern __attribute__((visibility("default")))
#      define VLC_PRIVATE_API extern __attribute__((visibility("default")))
#      define   VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
#      define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
#    else
485
#      define VLC_PUBLIC_API extern
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
486
#      define VLC_PRIVATE_API extern
487
#      define   VLC_EXPORT( type, name, args ) extern type name args
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
488 489
#      define VLC_INTERNAL( type, name, args ) type name args
#    endif
490
#  endif
Gildas Bazin's avatar
 
Gildas Bazin committed
491 492
#endif

493 494 495
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
496
#if defined( WIN32 ) || defined( UNDER_CE )
497 498
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
499 500 501 502 503
#   if defined( UNDER_CE )
#      define IS_WINNT 0
#   else
#      define IS_WINNT ( GetVersion() < 0x80000000 )
#   endif
504 505
#endif

506 507
#include "vlc_threads.h"

508 509
typedef struct vlc_object_internals_t vlc_object_internals_t;

510 511 512 513 514 515
/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
516 517 518 519
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
520
    vlc_object_internals_t *p_internals;                                    \
521 522
    int   i_object_id;                                                      \
    int   i_object_type;                                                    \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
523
    const char *psz_object_type;                                            \
524
    char *psz_object_name;                                                  \
525
                                                                            \
526 527
    /* Messages header */                                                   \
    char *psz_header;                                                       \
528
    int  i_flags;                                                           \
529
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
530 531 532
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
533
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
534
    /* Object properties */                                                 \
535 536 537 538
    volatile bool b_error;                  /**< set by the object */ \
    volatile bool b_die;                   /**< set by the outside */ \
    volatile bool b_dead;                   /**< set by the object */ \
    bool b_force;      /**< set by the outside (eg. module_Need()) */ \
539
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
540
    /* Stuff related to the libvlc structure */                             \
541
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
542
                                                                            \
543 544
    vlc_object_t *  p_parent;                            /**< our parent */ \
    vlc_object_t ** pp_children;                       /**< our children */ \
545 546
    volatile int    i_children;                                             \
                                                                            \
547 548 549
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
550
    /** Just a reminder so that people don't cast garbage */                \
551
    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
552
/**@}*/                                                                     \
553

554 555
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
556
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
557

558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
#define VLC_GC_MEMBERS                                                       \
/** \name VLC_GC_MEMBERS                                                     \
 * these members are common to all objects that wish to be garbage-collected \
 */                                                                          \
/**@{*/                                                                      \
    int i_gc_refcount;                                                       \
    void (*pf_destructor) ( gc_object_t * );                                 \
    void *p_destructor_arg;                                                  \
/**@}*/

struct gc_object_t
{
            VLC_GC_MEMBERS
};

573 574
#include <assert.h> /* FIXME: should not be included here */

575 576
static inline void __vlc_gc_incref( gc_object_t * p_gc )
{
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
577 578
    assert( p_gc->i_gc_refcount > 0 );

579 580 581 582 583
    p_gc->i_gc_refcount ++;
};

static inline void __vlc_gc_decref( gc_object_t *p_gc )
{
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
584 585 586 587
    if( !p_gc ) return;

    assert( p_gc->i_gc_refcount > 0 );

588 589 590 591 592 593
    p_gc->i_gc_refcount -- ;

    if( p_gc->i_gc_refcount == 0 )
    {
        p_gc->pf_destructor( p_gc );
        /* Do not use the p_gc pointer from now on ! */
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
594 595 596 597 598 599 600 601 602 603
    }
}

static inline void
__vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
               void * arg)
{
    p_gc->i_gc_refcount = 1;
    p_gc->pf_destructor = pf_destructor;
    p_gc->p_destructor_arg = arg;
604 605 606 607
}

#define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
#define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
608
#define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
609 610


Sam Hocevar's avatar
 
Sam Hocevar committed
611 612 613 614 615 616
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

617
#elif !defined(WIN32) && !defined( UNDER_CE )
Sam Hocevar's avatar
 
Sam Hocevar committed
618 619 620 621 622 623 624 625 626 627
#   include <netinet/in.h>

#endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */

/* 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) )

Sam Hocevar's avatar
 
Sam Hocevar committed
628 629 630
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
631
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
632 633
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
634 635
#endif

636
static inline int64_t GCD( int64_t a, int64_t b )
637
{
638 639 640 641 642 643 644
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
645 646
}

647 648 649 650 651 652 653
/* function imported from libavutil/common.h */
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

654
/* Malloc with automatic error */
655 656 657 658 659 660 661 662
#define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return; } while(0)
#define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return NULL; } while(0)
#define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return VLC_ENOMEM; } while(0)
#define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                      if( !var ) goto error; } while(0)
663 664
#define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return;
665
#define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
666
                                    if( !var ) return VLC_ENOMEM;
667 668 669
#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return NULL;

670
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
Clément Stenac's avatar
Clément Stenac committed
671

672 673
#define EMPTY_STR(str) (!str || !*str)

Clément Stenac's avatar
Clément Stenac committed
674 675
VLC_EXPORT( char const *, vlc_error, ( int ) );

676
#include <vlc_arrays.h>
677

Sam Hocevar's avatar
 
Sam Hocevar committed
678 679 680
/* MSB (big endian)/LSB (little endian) conversions - network order is always
 * 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
681
 * the VAX seems to have such exotic properties. */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
682
static inline uint16_t U16_AT( const void * _p )
683
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
684
    const uint8_t * p = (const uint8_t *)_p;
685
    return ( ((uint16_t)p[0] << 8) | p[1] );
686
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
687
static inline uint32_t U32_AT( const void * _p )
688
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
689
    const uint8_t * p = (const uint8_t *)_p;
690 691
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
692
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
693
static inline uint64_t U64_AT( const void * _p )
694
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
695
    const uint8_t * p = (const uint8_t *)_p;
696 697 698 699
    return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
              | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
              | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
              | ((uint64_t)p[6] << 8) | p[7] );
700
}
701

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
702
static inline uint16_t GetWLE( const void * _p )
703
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
704
    const uint8_t * p = (const uint8_t *)_p;
705 706
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
707
static inline uint32_t GetDWLE( const void * _p )
708
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
709
    const uint8_t * p = (const uint8_t *)_p;
710 711 712
    return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
              | ((uint32_t)p[1] << 8) | p[0] );
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
713
static inline uint64_t GetQWLE( const void * _p )
714
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
715
    const uint8_t * p = (const uint8_t *)_p;
716 717 718 719 720 721 722 723 724 725
    return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
              | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
              | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
              | ((uint64_t)p[1] << 8) | p[0] );
}

#define GetWBE( p )     U16_AT( p )
#define GetDWBE( p )    U32_AT( p )
#define GetQWBE( p )    U64_AT( p )

Gildas Bazin's avatar
 
Gildas Bazin committed
726
/* Helper writer functions */
727
#define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
728 729 730 731 732 733
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

734
#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
735 736 737 738 739 740 741
static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
{
    p[3] = ( i_dw >> 24 )&0xff;
    p[2] = ( i_dw >> 16 )&0xff;
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}
742
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
743 744 745 746 747
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
748
#define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
749 750 751 752 753 754
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

755
#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
756 757 758 759 760 761 762
static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
{
    p[0] = ( i_dw >> 24 )&0xff;
    p[1] = ( i_dw >> 16 )&0xff;
    p[2] = ( i_dw >>  8 )&0xff;
    p[3] = ( i_dw       )&0xff;
}
763
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
764 765 766 767 768
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
769

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
770
#ifdef WORDS_BIGENDIAN
771 772
#   define hton16(i)   ( i )
#   define hton32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
773
#   define hton64(i)   ( i )
774 775
#   define ntoh16(i)   ( i )
#   define ntoh32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
776 777
#   define ntoh64(i)   ( i )
#else
778 779 780 781 782 783
#   define hton16(i)   U16_AT(&i)
#   define hton32(i)   U32_AT(&i)
#   define hton64(i)   U64_AT(&i)
#   define ntoh16(i)   U16_AT(&i)
#   define ntoh32(i)   U32_AT(&i)
#   define ntoh64(i)   U64_AT(&i)
Sam Hocevar's avatar
 
Sam Hocevar committed
784 785
#endif

786 787 788 789 790 791 792
/* Format string sanity checks */
#ifdef HAVE_ATTRIBUTE_FORMAT
#   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
#else
#   define ATTRIBUTE_FORMAT(x,y)
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
793 794 795 796 797 798 799
/* Alignment of critical static data structures */
#ifdef ATTRIBUTE_ALIGNED_MAX
#   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
#else
#   define ATTR_ALIGN(align)
#endif

800 801 802
/* */
#define VLC_UNUSED(x) (void)(x)

803
/* Stuff defined in src/extras/libc.c */
804 805 806 807 808 809 810 811
VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
812
VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
813

814
#if defined(SYS_BEOS) \
815
 || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
816 817 818 819
    typedef struct {
        long long quot; /* Quotient. */
        long long rem;  /* Remainder. */
    } lldiv_t;
820
#endif
821
VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
822

823 824 825
struct dirent;
VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
826

827
VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
828

829 830 831
VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
832

833
#ifndef HAVE_DIRENT_H
834
    typedef void DIR;
835 836 837 838 839 840 841 842 843 844 845 846 847
#   ifndef FILENAME_MAX
#       define FILENAME_MAX (260)
#   endif
    struct dirent
    {
        long            d_ino;          /* Always zero. */
        unsigned short  d_reclen;       /* Always zero. */
        unsigned short  d_namlen;       /* Length of name in d_name. */
        char            d_name[FILENAME_MAX]; /* File name. */
    };
#   define opendir vlc_opendir
#   define readdir vlc_readdir
#   define closedir vlc_closedir
848 849 850
#   define rewinddir vlc_rewindir
#   define seekdir vlc_seekdir
#   define telldir vlc_telldir
851 852 853
    VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
    VLC_EXPORT( void *, vlc_readdir, ( void * ) );
    VLC_EXPORT( int, vlc_closedir, ( void * ) );
854 855 856
    VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
    VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
    VLC_INTERNAL( long, vlc_telldir, ( void * ) );
857 858
#endif

859 860
#if defined (WIN32)
#   include <dirent.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
861 862 863 864 865 866
 VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
 VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
 VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
867 868 869 870 871
#   define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
#   define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
#   define closedir vlc_wclosedir
#   define _wopendir vlc_wopendir
#   define _wreaddir vlc_wreaddir
872
#   define _wclosedir vlc_wclosedir
873 874 875
#   define rewinddir vlc_rewinddir
#   define seekdir vlc_seekdir
#   define telldir vlc_telldir
876
#endif
877

Gildas Bazin's avatar
 
Gildas Bazin committed
878
/* Format type specifiers for 64 bits numbers */
Damien Fouilleul's avatar
Damien Fouilleul committed
879
#if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
#   if defined(__WORDSIZE) && __WORDSIZE == 64
#       define I64Fd "%ld"
#       define I64Fi "%li"
#       define I64Fo "%lo"
#       define I64Fu "%lu"
#       define I64Fx "%lx"
#       define I64FX "%lX"
#   else
#       define I64Fd "%lld"
#       define I64Fi "%lli"
#       define I64Fo "%llo"
#       define I64Fu "%llu"
#       define I64Fx "%llx"
#       define I64FX "%llX"
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
895 896 897 898 899 900 901
#else
#   define I64Fd "%I64d"
#   define I64Fi "%I64i"
#   define I64Fo "%I64o"
#   define I64Fu "%I64u"
#   define I64Fx "%I64x"
#   define I64FX "%I64X"
902
#endif /* defined(WIN32)||defined(UNDER_CE) */
Gildas Bazin's avatar
 
Gildas Bazin committed
903 904

/* 64 bits integer constant suffix */
Gildas Bazin's avatar
 
Gildas Bazin committed
905
#if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
906 907 908 909 910 911 912
#   if defined(__WORDSIZE) && __WORDSIZE == 64
#       define I64C(x)         x##L
#       define UI64C(x)        x##UL
#   else
#       define I64C(x)         x##LL
#       define UI64C(x)        x##ULL
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
913 914
#else
#   define I64C(x)         x##i64
Gildas Bazin's avatar
 
Gildas Bazin committed
915
#   define UI64C(x)        x##ui64
916
#endif /* defined(WIN32)||defined(UNDER_CE) */
Sam Hocevar's avatar
 
Sam Hocevar committed
917

918
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
919
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
920
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
921 922
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
923
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
924 925 926 927 928 929 930 931 932
#       define S_ISBLK(m)      (0)
#       define S_ISCHR(m)      (0)
#       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
#       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
#   endif

/* several type definitions */
#   if defined( __MINGW32__ )
#       if !defined( _OFF_T_ )
933 934
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
935 936
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
937 938 939
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
940 941 942 943
#           define off_t long long
#       endif
#   endif

944
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
945
#       if !defined( _OFF_T_DEFINED )
946
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
947 948
#           define _OFF_T_DEFINED
#       else
949
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
950 951 952 953
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
954
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
955
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
956
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
957 958
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
959 960
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
961 962 963 964
#   endif

#   ifndef alloca
#       define alloca _alloca
Gildas Bazin's avatar
 
Gildas Bazin committed
965 966
#   endif

967
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
 
Sam Hocevar committed
968
#   ifndef snprintf
969 970 971 972
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
 
Sam Hocevar committed
973 974
#   endif

975
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
976 977
#endif

978
VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
979
VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
980

Gildas Bazin's avatar
 
Gildas Bazin committed
981 982
/* vlc_wraptext (defined in src/extras/libc.c) */
#define wraptext vlc_wraptext
983
VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
Gildas Bazin's avatar
 
Gildas Bazin committed
984

985 986 987
/* iconv wrappers (defined in src/extras/libc.c) */
typedef void *vlc_iconv_t;
VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
988
VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
989 990
VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );

991
/* execve wrapper (defined in src/extras/libc.c) */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
992
VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char *const *pp_argv, char *const *pp_env, const char *psz_cwd, const char *p_in, size_t i_in, char **pp_data, size_t *pi_data ) );
993 994
#define vlc_execve(a,b,c,d,e,f,g,h,i) __vlc_execve(VLC_OBJECT(a),b,c,d,e,f,g,h,i)

Sam Hocevar's avatar
 
Sam Hocevar committed
995 996 997 998 999 1000 1001 1002 1003 1004 1005
/*****************************************************************************
 * CPU capabilities
 *****************************************************************************/
#define CPU_CAPABILITY_NONE    0
#define CPU_CAPABILITY_486     (1<<0)
#define CPU_CAPABILITY_586     (1<<1)
#define CPU_CAPABILITY_PPRO    (1<<2)
#define CPU_CAPABILITY_MMX     (1<<3)
#define CPU_CAPABILITY_3DNOW   (1<<4)
#define CPU_CAPABILITY_MMXEXT  (1<<5)
#define CPU_CAPABILITY_SSE     (1<<6)
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
1006
#define CPU_CAPABILITY_SSE2    (1<<7)
Sam Hocevar's avatar
 
Sam Hocevar committed
1007 1008
#define CPU_CAPABILITY_ALTIVEC (1<<16)
#define CPU_CAPABILITY_FPU     (1<<31)
1009
VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
Sam Hocevar's avatar
 
Sam Hocevar committed
1010 1011 1012 1013

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1014
#ifdef WIN32
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1015
    VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1016
#endif
1017

1018
#if defined( ENABLE_NLS ) && \
1019
     (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
Jean-Paul Saman's avatar
Jean-Paul Saman committed
1020 1021
      defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
      defined(MODULE_NAME_IS_pda))
1022
    /* Declare nothing: gnome.h will do it for us */
1023
#elif defined( ENABLE_NLS )
Sam Hocevar's avatar
Sam Hocevar committed
1024 1025 1026 1027 1028
#   if defined( HAVE_INCLUDED_GETTEXT )
#       include "libintl.h"
#   else
#       include <libintl.h>
#   endif
1029
#   undef _
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1030
#   ifdef WIN32
1031
#       define _(String) vlc_dgettext (PACKAGE_NAME, String)
1032
#   else
1033
#       define _(String) dgettext(PACKAGE_NAME, String)
1034
#   endif
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1035
#   define N_(String) (String)
1036
#else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1037 1038
#   define _(String) (String)
#   define N_(String) (String)
Sam Hocevar's avatar
 
Sam Hocevar committed
1039 1040
#endif

1041 1042 1043 1044 1045 1046 1047 1048 1049
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
VLC_EXPORT( const char *, VLC_Version, ( void ) );
VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
VLC_EXPORT( const char *, VLC_Error, ( int ) );