vlc_common.h 31.8 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
#ifndef VLC_COMMON_H
# define VLC_COMMON_H 1

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

42 43
#include "vlc_config.h"

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

50
#include <string.h>
51
#include <stdio.h>
52
#include <inttypes.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
53

54 55 56 57
#ifndef __cplusplus
# include <stdbool.h>
#endif

58 59 60 61 62 63 64 65 66
/* Format string sanity checks */
#ifdef __GNUC__
#   define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
#   define LIBVLC_USED __attribute__ ((warn_unused_result))
#else
#   define LIBVLC_FORMAT(x,y)
#   define LIBVLC_USED
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
67 68 69
/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
70
#if defined( WIN32 ) || defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
71
#   include <malloc.h>
72 73 74
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
75 76
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
77 78 79
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

80
/* Audio volume */
81 82
typedef uint16_t            audio_volume_t;

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
83 84 85
/**
 * High precision date or time interval
 *
86 87
 * 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
88
 * time interval is then 292271 years, which should be long enough for any
89 90
 * 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
91
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
92
 */
93
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
94

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
95
/**
96
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
97
 *
98
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
99
 */
100
typedef uint32_t vlc_fourcc_t;
101

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
#ifdef WORDS_BIGENDIAN
#   define VLC_FOURCC( a, b, c, d ) \
        ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
           | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
#   define VLC_TWOCC( a, b ) \
        ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )

#else
#   define VLC_FOURCC( a, b, c, d ) \
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
#   define VLC_TWOCC( a, b ) \
        ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )

#endif

118 119 120 121 122 123 124
/**
 * Translate a vlc_fourcc into its string representation. This function
 * assumes there is enough room in psz_fourcc to store 4 characters in.
 *
 * \param fcc a vlc_fourcc_t
 * \param psz_fourcc string to store string representation of vlc_fourcc in
 */
125 126
static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
{
127
    memcpy( psz_fourcc, &fcc, 4 );
128 129 130 131 132
}

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

Sam Hocevar's avatar
 
Sam Hocevar committed
133 134 135 136
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

137
/* Internal types */
138 139
typedef struct vlc_list_t vlc_list_t;
typedef struct vlc_object_t vlc_object_t;
140
typedef struct libvlc_int_t libvlc_int_t;
Sam Hocevar's avatar
Sam Hocevar committed
141
typedef struct variable_t variable_t;
142
typedef struct date_t date_t;
Clément Stenac's avatar
Clément Stenac committed
143 144
typedef struct dict_entry_t dict_entry_t;
typedef struct dict_t dict_t;
145
typedef struct gc_object_t gc_object_t ;
146

147
/* Messages */
148
typedef struct msg_subscription_t msg_subscription_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
149

Gildas Bazin's avatar
 
Gildas Bazin committed
150
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
151 152 153 154 155 156

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
157
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
158 159
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
160 161 162
    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
163 164 165
} playlist_command_t;


166 167
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
168
typedef struct playlist_view_t playlist_view_t;
169
typedef struct playlist_export_t playlist_export_t;
170 171
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
172
typedef struct playlist_add_t playlist_add_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
173

174
/* Modules */
175 176 177 178
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;
179
typedef struct module_cache_t module_cache_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
180

181 182
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
183
/* Interface */
184 185 186 187
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;
188 189 190
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
191 192

/* Input */
193
typedef struct input_thread_t input_thread_t;
194
typedef struct input_thread_sys_t input_thread_sys_t;
195
typedef struct input_item_t input_item_t;
196
typedef struct access_t access_t;
197
typedef struct access_sys_t access_sys_t;
198 199 200
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
201
typedef struct demux_meta_t demux_meta_t;
202
typedef struct demux_sys_t demux_sys_t;
203 204 205
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;
206
typedef struct es_descriptor_t es_descriptor_t;
Gildas Bazin's avatar
Gildas Bazin committed
207
typedef struct seekpoint_t seekpoint_t;
208 209
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
210
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
211

212 213 214 215
/* 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
216 217
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
218

Sam Hocevar's avatar
 
Sam Hocevar committed
219
/* Audio */
220 221
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
222
typedef struct aout_fifo_t aout_fifo_t;
223 224
typedef struct aout_input_t aout_input_t;
typedef struct aout_buffer_t aout_buffer_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
225
typedef audio_format_t audio_sample_format_t;
226
typedef struct audio_date_t audio_date_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
227
typedef struct aout_filter_t aout_filter_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
228 229

/* Video */
230 231
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
232

Gildas Bazin's avatar
 
Gildas Bazin committed
233
typedef video_format_t video_frame_format_t;
234 235 236
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
237

238
/* Subpictures */
239
typedef struct spu_t spu_t;
240 241
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
242
typedef struct subpicture_region_t subpicture_region_t;
243
typedef struct text_style_t text_style_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
244

245 246
typedef struct image_handler_t image_handler_t;

247 248
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
249 250
typedef struct sout_instance_sys_t sout_instance_sys_t;

251
typedef struct sout_input_t sout_input_t;
252
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
253

254
typedef struct sout_access_out_t sout_access_out_t;
255 256
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

257
typedef struct sout_mux_t sout_mux_t;
258 259
typedef struct sout_mux_sys_t sout_mux_sys_t;

260
typedef struct sout_stream_t    sout_stream_t;
261 262
typedef struct sout_stream_sys_t sout_stream_sys_t;

263
typedef struct config_chain_t       config_chain_t;
264 265
typedef struct session_descriptor_t session_descriptor_t;
typedef struct announce_method_t announce_method_t;
266

267 268
typedef struct sout_param_t sout_param_t;
typedef struct sout_pcat_t sout_pcat_t;
269 270 271 272 273 274 275 276
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;
277
typedef struct profile_parser_t profile_parser_t;
278

Sam Hocevar's avatar
 
Sam Hocevar committed
279
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
280 281 282
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
283

Gildas Bazin's avatar
 
Gildas Bazin committed
284 285 286 287
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

288 289 290 291
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

292
/* Network */
293
typedef struct network_socket_t network_socket_t;
294
typedef struct virtual_socket_t v_socket_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
295 296
typedef struct sockaddr sockaddr;
typedef struct addrinfo addrinfo;
297
typedef struct vlc_acl_t vlc_acl_t;
298
typedef struct vlc_url_t vlc_url_t;
299

300 301
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;
Clément Stenac's avatar
Clément Stenac committed
302
typedef struct device_t device_t;
303 304
typedef struct device_probe_t device_probe_t;
typedef struct probe_sys_t probe_sys_t;
305

306 307 308 309
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

310 311 312 313 314 315 316
/* 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
317
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
318 319
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
320 321 322
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
323
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 );
324 325 326
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
327 328 329 330
/* TLS support */
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

331 332 333
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
334 335 336 337 338 339
/* 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;

340 341 342
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
343
typedef struct vod_media_t vod_media_t;
344

345 346 347 348
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

349 350 351 352 353 354 355
/* 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;

356
/* VLM */
357 358
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
359 360 361

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

364
/* Stats */
365 366 367
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
368
typedef struct input_stats_t input_stats_t;
369
typedef struct global_stats_t global_stats_t;
370

371 372 373
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
374

375 376 377
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

378 379
/* stat/lstat/fstat */
#ifdef WIN32
380 381 382
# ifdef UNDER_CE
# undef _STAT_DEFINED
# endif
383
#include <sys/stat.h>
384
# ifndef UNDER_CE
385
struct _stati64;
386 387
#define stat _stati64
#define fstat _fstati64
388 389 390 391
# else
# define stat _stat
# define fstat _fstat
# endif
392
/* You should otherwise use utf8_stat and utf8_lstat. */
393 394 395 396
#else
struct stat;
#endif

397 398 399 400 401 402
/**
 * VLC value structure
 */
typedef union
{
    int             i_int;
403
    bool            b_bool;
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
    float           f_float;
    char *          psz_string;
    void *          p_address;
    vlc_object_t *  p_object;
    vlc_list_t *    p_list;
    mtime_t         i_time;

    struct { char *psz_name; int i_object_id; } var;

   /* Make sure the structure is at least 64bits */
    struct { char a, b, c, d, e, f, g, h; } padding;

} vlc_value_t;

/**
 * VLC list structure
 */
struct vlc_list_t
{
    int             i_count;
    vlc_value_t *   p_values;
    int *           pi_types;

};

/**
 * \defgroup var_type Variable types
 * These are the different types a vlc variable can have.
 * @{
 */
#define VLC_VAR_VOID      0x0010
#define VLC_VAR_BOOL      0x0020
#define VLC_VAR_INTEGER   0x0030
#define VLC_VAR_HOTKEY    0x0031
#define VLC_VAR_STRING    0x0040
#define VLC_VAR_MODULE    0x0041
#define VLC_VAR_FILE      0x0042
#define VLC_VAR_DIRECTORY 0x0043
#define VLC_VAR_VARIABLE  0x0044
#define VLC_VAR_FLOAT     0x0050
#define VLC_VAR_TIME      0x0060
#define VLC_VAR_ADDRESS   0x0070
#define VLC_VAR_MUTEX     0x0080
#define VLC_VAR_LIST      0x0090
/**@}*/

/*****************************************************************************
 * Error values (shouldn't be exposed)
 *****************************************************************************/
#define VLC_SUCCESS         -0                                   /* No error */
#define VLC_ENOMEM          -1                          /* Not enough memory */
#define VLC_ETHREAD         -2                               /* Thread error */
#define VLC_ETIMEOUT        -3                                    /* Timeout */

#define VLC_ENOMOD         -10                           /* Module not found */

#define VLC_ENOOBJ         -20                           /* Object not found */

#define VLC_ENOVAR         -30                         /* Variable not found */
#define VLC_EBADVAR        -31                         /* Bad variable value */

#define VLC_ENOITEM        -40                           /**< Item not found */

#define VLC_EEXIT         -255                             /* Program exited */
#define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
#define VLC_EGENERIC      -666                              /* Generic error */

471 472 473 474 475 476 477 478 479
/*****************************************************************************
 * 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
480 481 482
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
483

484 485 486 487 488
#ifdef __cplusplus
# define LIBVLC_EXTERN extern "C"
#else
# define LIBVLC_EXTERN extern
#endif
489
#if defined (WIN32) && defined (DLL_EXPORT)
490 491 492
#if defined (UNDER_CE)
# include <windef.h>
#endif
493
# define LIBVLC_EXPORT __declspec(dllexport)
494
#else
495
# define LIBVLC_EXPORT
Gildas Bazin's avatar
 
Gildas Bazin committed
496
#endif
497 498
#define VLC_EXPORT( type, name, args ) \
                        LIBVLC_EXTERN LIBVLC_EXPORT type name args
Gildas Bazin's avatar
 
Gildas Bazin committed
499

500 501 502
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
503
#if defined( WIN32 ) || defined( UNDER_CE )
504 505
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
506 507 508 509 510
#   if defined( UNDER_CE )
#      define IS_WINNT 0
#   else
#      define IS_WINNT ( GetVersion() < 0x80000000 )
#   endif
511 512
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
513
#include "vlc_mtime.h"
514 515 516 517 518 519 520 521
#include "vlc_threads.h"

/*****************************************************************************
 * Common structure members
 *****************************************************************************/

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

553
/* VLC_OBJECT: attempt at doing a clever cast */
554 555 556 557 558 559
#ifdef __GNUC__
# define VLC_OBJECT( x ) \
    (((vlc_object_t *)(x))+0*(((typeof(x))0)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct))
#else
# define VLC_OBJECT( x ) ((vlc_object_t *)(x))
#endif
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
{
573
    VLC_GC_MEMBERS
574 575
};

576 577 578 579
VLC_EXPORT(void, __vlc_gc_incref, ( gc_object_t * p_gc ));
VLC_EXPORT(void, __vlc_gc_decref, ( gc_object_t * p_gc ));
VLC_EXPORT(void, __vlc_gc_init, ( gc_object_t * p_gc,
    void (*pf_destructor)( gc_object_t * ), void * arg));
580 581 582

#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
583
#define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
584 585


Sam Hocevar's avatar
 
Sam Hocevar committed
586 587 588 589 590 591 592 593 594 595
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/

/* 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
596 597 598
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
599
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
600 601
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
602 603
#endif

604 605
LIBVLC_USED
static inline int64_t GCD ( int64_t a, int64_t b )
606
{
607 608 609 610 611 612 613
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
614 615
}

616
/* function imported from libavutil/common.h */
617
LIBVLC_USED
618 619 620 621 622 623
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

624
/* Malloc with automatic error */
625 626 627 628 629 630 631 632
#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)
633 634
#define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return;
635
#define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
636
                                    if( !var ) return VLC_ENOMEM;
637 638 639
#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return NULL;

640
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
641

642 643
#define EMPTY_STR(str) (!str || !*str)

644
VLC_EXPORT( char const *, vlc_error, ( int ) LIBVLC_USED );
Clément Stenac's avatar
Clément Stenac committed
645

646
#include <vlc_arrays.h>
647

Sam Hocevar's avatar
 
Sam Hocevar committed
648
/* MSB (big endian)/LSB (little endian) conversions - network order is always
649
 * MSB, and should be used for both network communications and files. */
650
LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
651
static inline uint16_t U16_AT( const void * _p )
652
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
653
    const uint8_t * p = (const uint8_t *)_p;
654
    return ( ((uint16_t)p[0] << 8) | p[1] );
655
}
656 657

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
658
static inline uint32_t U32_AT( const void * _p )
659
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
660
    const uint8_t * p = (const uint8_t *)_p;
661 662
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
663
}
664 665

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
666
static inline uint64_t U64_AT( const void * _p )
667
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
668
    const uint8_t * p = (const uint8_t *)_p;
669 670 671 672
    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] );
673
}
674

675
LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
676
static inline uint16_t GetWLE( const void * _p )
677
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
678
    const uint8_t * p = (const uint8_t *)_p;
679 680
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
681 682

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
683
static inline uint32_t GetDWLE( const void * _p )
684
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
685
    const uint8_t * p = (const uint8_t *)_p;
686 687 688
    return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
              | ((uint32_t)p[1] << 8) | p[0] );
}
689 690

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
691
static inline uint64_t GetQWLE( const void * _p )
692
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
693
    const uint8_t * p = (const uint8_t *)_p;
694 695 696 697 698 699 700 701 702 703
    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
704
/* Helper writer functions */
705
#define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
706 707 708 709 710 711
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

712
#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
713 714 715 716 717 718 719
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;
}
720
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
721 722 723 724 725
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
726
#define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
727 728 729 730 731 732
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

733
#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
734 735 736 737 738 739 740
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;
}
741
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
742 743 744 745 746
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
747

748 749 750 751 752
#define hton16(i) htons(i)
#define hton32(i) htonl(i)
#define ntoh16(i) ntohs(i)
#define ntoh32(i) ntohl(i)

753
LIBVLC_USED
754 755 756 757 758 759 760 761 762 763 764 765 766
static inline uint64_t ntoh64 (uint64_t ll)
{
    union { uint64_t qw; uint8_t b[16]; } v = { ll };
    return ((uint64_t)v.b[0] << 56)
         | ((uint64_t)v.b[1] << 48)
         | ((uint64_t)v.b[2] << 40)
         | ((uint64_t)v.b[3] << 32)
         | ((uint64_t)v.b[4] << 24)
         | ((uint64_t)v.b[5] << 16)
         | ((uint64_t)v.b[6] <<  8)
         | ((uint64_t)v.b[7] <<  0);
}
#define hton64(i) ntoh64(i)
Sam Hocevar's avatar
 
Sam Hocevar committed
767

768 769 770
/* */
#define VLC_UNUSED(x) (void)(x)

771
/* Stuff defined in src/extras/libc.c */
772
VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
773
VLC_EXPORT( long long, vlc_strtoll, ( const char *nptr, char **endptr, int base ) LIBVLC_USED );
774

775
VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) LIBVLC_USED );
776
char *vlc_strsep( char **, const char * );
777

778
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
779
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
780
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
781 782
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
783
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
784 785 786 787 788 789 790 791 792
#       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_ )
793 794
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
795 796
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
797 798 799
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
800 801 802 803
#           define off_t long long
#       endif
#   endif

804
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
805
#       if !defined( _OFF_T_DEFINED )
806
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
807 808
#           define _OFF_T_DEFINED
#       else
809
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
810 811 812 813
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
814
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
815
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
816
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
817 818
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
819 820
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
821 822 823 824
#   endif

#   ifndef alloca
#       define alloca _alloca
Gildas Bazin's avatar
 
Gildas Bazin committed
825 826
#   endif

827
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
 
Sam Hocevar committed
828
#   ifndef snprintf
829 830 831 832
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
 
Sam Hocevar committed
833 834
#   endif

835
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
836 837
#endif

838
VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
839

Gildas Bazin's avatar
 
Gildas Bazin committed
840 841
/* vlc_wraptext (defined in src/extras/libc.c) */
#define wraptext vlc_wraptext
842
VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) LIBVLC_USED );
Gildas Bazin's avatar
 
Gildas Bazin committed
843

844 845
/* iconv wrappers (defined in src/extras/libc.c) */
typedef void *vlc_iconv_t;
846 847
VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) LIBVLC_USED );
VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) LIBVLC_USED );
848 849
VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );

850
/* execve wrapper (defined in src/extras/libc.c) */
851
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 ) LIBVLC_USED );
852 853
#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)

854 855 856
/* dir wrappers (defined in src/extras/libc.c) */
VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));

Sam Hocevar's avatar
 
Sam Hocevar committed
857 858 859 860 861 862 863 864 865 866 867
/*****************************************************************************
 * 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)
868
#define CPU_CAPABILITY_SSE2    (1<<7)
Sam Hocevar's avatar
 
Sam Hocevar committed
869 870
#define CPU_CAPABILITY_ALTIVEC (1<<16)
#define CPU_CAPABILITY_FPU     (1<<31)
871
VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
872 873 874 875 876

typedef void *(*vlc_memcpy_t) (void *tgt, const void *src, size_t n);
typedef void *(*vlc_memset_t) (void *tgt, int c, size_t n);

VLC_EXPORT( void, vlc_fastmem_register, (vlc_memcpy_t cpy, vlc_memset_t set) );
877 878
VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
Sam Hocevar's avatar
 
Sam Hocevar committed
879 880 881 882

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
883
VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_USED );
884

885 886 887
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
888 889 890 891 892 893 894
VLC_EXPORT( const char *, VLC_Version, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_CompileBy, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_CompileHost, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_Compiler, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_Error, ( int ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_Changeset, ( void ) LIBVLC_USED );
895

896
/*****************************************************************************
897
 * Additional vlc stuff
898
 *****************************************************************************/
899
#include "vlc_messages.h"
Clément Stenac's avatar
Clément Stenac committed
900
#include "vlc_variables.h"
Sam Hocevar's avatar
Sam Hocevar committed
901
#include "vlc_objects.h"
Clément Stenac's avatar
Clément Stenac committed
902
#include "vlc_modules.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
903
#include "vlc_main.h"
Clément Stenac's avatar
Clément Stenac committed
904
#include "vlc_configuration.h"
905

Antoine Cellerier's avatar
Antoine Cellerier committed
906
#if defined( WIN32 ) || defined( UNDER_CE )
907
#   define DIR_SEP_CHAR '\\'
Antoine Cellerier's avatar
Antoine Cellerier committed
908
#   define DIR_SEP "\\"
909 910
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
Antoine Cellerier's avatar
Antoine Cellerier committed
911
#else
912
#   define DIR_SEP_CHAR '/'
Antoine Cellerier's avatar
Antoine Cellerier committed
913
#   define DIR_SEP "/"
914 915
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
Antoine Cellerier's avatar
Antoine Cellerier committed
916
#endif
917

918 919 920 921 922 923
#define LICENSE_MSG \
  _("This program comes with NO WARRANTY, to the extent permitted by " \
    "law.\nYou may redistribute it under the terms of the GNU General " \
    "Public License;\nsee the file named COPYING for details.\n" \
    "Written by the VideoLAN team; see the AUTHORS file.\n")

924
#endif /* !VLC_COMMON_H */