vlc_common.h 32.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
#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

Sam Hocevar's avatar
 
Sam Hocevar committed
58 59 60
/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
61
#if defined( WIN32 ) || defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
62
#   include <malloc.h>
63 64 65
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
66 67
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
68 69 70 71
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

/* DCT elements types */
72
typedef int16_t             dctelem_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
73 74

/* Video buffer types */
75
typedef uint8_t             yuv_data_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
76

77
/* Audio volume */
78 79
typedef uint16_t            audio_volume_t;

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

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

99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
#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

115 116
static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
{
117
    memcpy( psz_fourcc, &fcc, 4 );
118 119 120 121 122
}

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

Sam Hocevar's avatar
 
Sam Hocevar committed
123 124 125 126
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

127
/* Internal types */
128 129
typedef struct vlc_list_t vlc_list_t;
typedef struct vlc_object_t vlc_object_t;
130
typedef struct libvlc_int_t libvlc_int_t;
Sam Hocevar's avatar
Sam Hocevar committed
131
typedef struct variable_t variable_t;
132
typedef struct date_t date_t;
Clément Stenac's avatar
Clément Stenac committed
133 134
typedef struct dict_entry_t dict_entry_t;
typedef struct dict_t dict_t;
135
typedef struct gc_object_t gc_object_t ;
136

137
/* Messages */
138
typedef struct msg_subscription_t msg_subscription_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
139

Gildas Bazin's avatar
 
Gildas Bazin committed
140
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
141 142 143 144 145 146

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
147
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
148 149
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
150 151 152
    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
153 154 155
} playlist_command_t;


156 157
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
158
typedef struct playlist_view_t playlist_view_t;
159
typedef struct playlist_export_t playlist_export_t;
160 161
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
162
typedef struct playlist_add_t playlist_add_t;
163
typedef struct playlist_preparse_t playlist_preparse_t;
164
typedef struct playlist_fetcher_t playlist_fetcher_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
165

166
/* Modules */
167 168 169 170
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;
171
typedef struct module_cache_t module_cache_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
172

173 174
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
175
/* Interface */
176 177 178 179
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;
180 181 182
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
183 184

/* Input */
185
typedef struct input_thread_t input_thread_t;
186
typedef struct input_thread_sys_t input_thread_sys_t;
187
typedef struct input_item_t input_item_t;
188
typedef struct access_t access_t;
189
typedef struct access_sys_t access_sys_t;
190 191 192
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
193
typedef struct demux_meta_t demux_meta_t;
194
typedef struct demux_sys_t demux_sys_t;
195 196 197
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;
198
typedef struct es_descriptor_t es_descriptor_t;
Gildas Bazin's avatar
Gildas Bazin committed
199
typedef struct seekpoint_t seekpoint_t;
200 201
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
202
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
203

204 205 206 207
/* 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
208 209
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
210

Sam Hocevar's avatar
 
Sam Hocevar committed
211
/* Audio */
212 213
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
214
typedef struct aout_fifo_t aout_fifo_t;
215 216
typedef struct aout_input_t aout_input_t;
typedef struct aout_buffer_t aout_buffer_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
217
typedef audio_format_t audio_sample_format_t;
218
typedef struct audio_date_t audio_date_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
219
typedef struct aout_filter_t aout_filter_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
220 221

/* Video */
222 223
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
224

Gildas Bazin's avatar
 
Gildas Bazin committed
225
typedef video_format_t video_frame_format_t;
226 227 228
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
229

230
/* Subpictures */
231
typedef struct spu_t spu_t;
232 233
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
234
typedef struct subpicture_region_t subpicture_region_t;
235
typedef struct text_style_t text_style_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
236

237 238
typedef struct image_handler_t image_handler_t;

239 240
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
241 242
typedef struct sout_instance_sys_t sout_instance_sys_t;

243
typedef struct sout_input_t sout_input_t;
244
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
245

246
typedef struct sout_access_out_t sout_access_out_t;
247 248
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

249
typedef struct sout_mux_t sout_mux_t;
250 251
typedef struct sout_mux_sys_t sout_mux_sys_t;

252
typedef struct sout_stream_t    sout_stream_t;
253 254
typedef struct sout_stream_sys_t sout_stream_sys_t;

255
typedef struct config_chain_t       config_chain_t;
256 257 258 259 260 261
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;
262

263 264
typedef struct sout_param_t sout_param_t;
typedef struct sout_pcat_t sout_pcat_t;
265 266 267 268 269 270 271 272
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;
273
typedef struct profile_parser_t profile_parser_t;
274

Sam Hocevar's avatar
 
Sam Hocevar committed
275
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
276 277 278
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
279

Gildas Bazin's avatar
 
Gildas Bazin committed
280 281 282 283
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

284 285 286 287
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

288
/* Network */
289
typedef struct network_socket_t network_socket_t;
290
typedef struct virtual_socket_t v_socket_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
291 292
typedef struct sockaddr sockaddr;
typedef struct addrinfo addrinfo;
293
typedef struct vlc_acl_t vlc_acl_t;
294
typedef struct vlc_url_t vlc_url_t;
295

296 297
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;
Clément Stenac's avatar
Clément Stenac committed
298
typedef struct device_t device_t;
299 300
typedef struct device_probe_t device_probe_t;
typedef struct probe_sys_t probe_sys_t;
301

302 303 304 305
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

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

327 328 329
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
330 331 332 333 334 335
/* 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;

336 337 338
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
339
typedef struct vod_media_t vod_media_t;
340

341 342 343 344
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

345 346 347 348 349 350 351
/* 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;

352
/* VLM */
353 354
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
355 356 357

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

360
/* Stats */
361 362 363
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
364
typedef struct input_stats_t input_stats_t;
365
typedef struct global_stats_t global_stats_t;
366

367 368 369
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
370

371 372 373
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

374 375
/* stat/lstat/fstat */
#ifdef WIN32
376
#include <sys/stat.h>
377
struct _stati64;
378 379 380
#define stat _stati64
#define fstat _fstati64
/* You should otherwise use utf8_stat and utf8_lstat. */
381 382 383 384
#else
struct stat;
#endif

385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 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
/**
 * VLC value structure
 */
typedef union
{
    int             i_int;
    bool      b_bool;
    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_EBADOBJ        -21                            /* Bad object type */

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

460 461 462 463 464 465 466 467 468
/*****************************************************************************
 * 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
469 470 471
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
472

473 474 475 476 477
#ifdef __cplusplus
# define LIBVLC_EXTERN extern "C"
#else
# define LIBVLC_EXTERN extern
#endif
478
#if defined (WIN32) && defined (DLL_EXPORT)
479
# define LIBVLC_EXPORT __declspec(dllexport)
480
#else
481
# define LIBVLC_EXPORT
Gildas Bazin's avatar
 
Gildas Bazin committed
482
#endif
483 484
#define VLC_EXPORT( type, name, args ) \
                        LIBVLC_EXTERN LIBVLC_EXPORT type name args
Gildas Bazin's avatar
 
Gildas Bazin committed
485

486 487 488
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
489
#if defined( WIN32 ) || defined( UNDER_CE )
490 491
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
492 493 494 495 496
#   if defined( UNDER_CE )
#      define IS_WINNT 0
#   else
#      define IS_WINNT ( GetVersion() < 0x80000000 )
#   endif
497 498
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
499
#include "vlc_mtime.h"
500 501
#include "vlc_threads.h"

502 503
typedef struct vlc_object_internals_t vlc_object_internals_t;

504 505 506 507 508 509
/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
510 511 512 513
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
514 515
    int   i_object_id;                                                      \
    int   i_object_type;                                                    \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
516
    const char *psz_object_type;                                            \
517
    char *psz_object_name;                                                  \
518
                                                                            \
519 520
    /* Messages header */                                                   \
    char *psz_header;                                                       \
521
    int  i_flags;                                                           \
522
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
523 524 525
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
526
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
527
    /* Object properties */                                                 \
528 529 530 531
    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()) */ \
532
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
533
    /* Stuff related to the libvlc structure */                             \
534
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
535
                                                                            \
536
    vlc_object_t *  p_parent;                            /**< our parent */ \
537
                                                                            \
538 539 540
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
541
    /** Just a reminder so that people don't cast garbage */                \
542
    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
543
/**@}*/                                                                     \
544

545 546
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
547
    (((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct)
548

549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
#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
};

static inline void __vlc_gc_incref( gc_object_t * p_gc )
{
    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
571 572
    if( !p_gc ) return;

573 574 575 576 577 578
    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
579 580 581 582 583 584 585 586 587 588
    }
}

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;
589 590 591 592
}

#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
593
#define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
594 595


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

614
static inline int64_t GCD( int64_t a, int64_t b )
615
{
616 617 618 619 620 621 622
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
623 624
}

625 626 627 628 629 630 631
/* 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;
}

632
/* Malloc with automatic error */
633 634 635 636 637 638 639 640
#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)
641 642
#define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return;
643
#define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
644
                                    if( !var ) return VLC_ENOMEM;
645 646 647
#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return NULL;

648
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
649

650 651
#define EMPTY_STR(str) (!str || !*str)

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

654
#include <vlc_arrays.h>
655

Sam Hocevar's avatar
 
Sam Hocevar committed
656 657 658
/* 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
659
 * the VAX seems to have such exotic properties. */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
660
static inline uint16_t U16_AT( const void * _p )
661
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
662
    const uint8_t * p = (const uint8_t *)_p;
663
    return ( ((uint16_t)p[0] << 8) | p[1] );
664
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
665
static inline uint32_t U32_AT( const void * _p )
666
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
667
    const uint8_t * p = (const uint8_t *)_p;
668 669
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
670
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
671
static inline uint64_t U64_AT( const void * _p )
672
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
673
    const uint8_t * p = (const uint8_t *)_p;
674 675 676 677
    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] );
678
}
679

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
680
static inline uint16_t GetWLE( const void * _p )
681
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
682
    const uint8_t * p = (const uint8_t *)_p;
683 684
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
685
static inline uint32_t GetDWLE( const void * _p )
686
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
687
    const uint8_t * p = (const uint8_t *)_p;
688 689 690
    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
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 754 755 756 757 758 759 760 761 762 763 764 765
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
766

767
/* Format string sanity checks */
768 769
#ifdef __GNUC__
#   define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
770
#else
771
#   define LIBVLC_FORMAT(x,y)
772 773
#endif

774 775 776
/* */
#define VLC_UNUSED(x) (void)(x)

777
/* Stuff defined in src/extras/libc.c */
778
VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
779
VLC_EXPORT( long long, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
780

781
VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
782

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

809
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
810
#       if !defined( _OFF_T_DEFINED )
811
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
812 813
#           define _OFF_T_DEFINED
#       else
814
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
815 816 817 818
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
819
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
820
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
821
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
822 823
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
824 825
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
826 827 828 829
#   endif

#   ifndef alloca
#       define alloca _alloca
Gildas Bazin's avatar
 
Gildas Bazin committed
830 831
#   endif

832
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
 
Sam Hocevar committed
833
#   ifndef snprintf
834 835 836 837
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
 
Sam Hocevar committed
838 839
#   endif

840
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
841 842
#endif

843
VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
844

Gildas Bazin's avatar
 
Gildas Bazin committed
845 846
/* vlc_wraptext (defined in src/extras/libc.c) */
#define wraptext vlc_wraptext
847
VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
Gildas Bazin's avatar
 
Gildas Bazin committed
848

849 850 851
/* 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 * ) );
852
VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
853 854
VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );

855
/* execve wrapper (defined in src/extras/libc.c) */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
856
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 ) );
857 858
#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)

859 860 861
/* dir wrappers (defined in src/extras/libc.c) */
VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));

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

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) );
882 883
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
884 885 886 887

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
888
VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) );
889

890 891 892 893 894 895 896 897 898
/*****************************************************************************
 * 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 ) );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
899
VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
900

901
/*****************************************************************************
902
 * Additional vlc stuff
903
 *****************************************************************************/
904
#include "vlc_messages.h"
Clément Stenac's avatar
Clément Stenac committed
905
#include "vlc_variables.h"
Sam Hocevar's avatar
Sam Hocevar committed
906
#include "vlc_objects.h"
Clément Stenac's avatar
Clément Stenac committed
907
#include "vlc_modules.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
908
#include "vlc_main.h"
Clément Stenac's avatar
Clément Stenac committed
909
#include "vlc_configuration.h"
910

Antoine Cellerier's avatar
Antoine Cellerier committed
911
#if defined( WIN32 ) || defined( UNDER_CE )
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
#else
917
#   define DIR_SEP_CHAR '/'
Antoine Cellerier's avatar
Antoine Cellerier committed
918
#   define DIR_SEP "/"
919 920
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
Antoine Cellerier's avatar
Antoine Cellerier committed
921
#endif
922

923 924 925 926 927 928
#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")

929
#endif /* !VLC_COMMON_H */