]> git.sesse.net Git - vlc/blob - include/vlc_common.h
* src/misc/vlm.c: start exporting some VLM control functions
[vlc] / include / vlc_common.h
1 /*****************************************************************************
2  * common.h: common definitions
3  * Collection of useful common types and macros definitions
4  *****************************************************************************
5  * Copyright (C) 1998-2004 VideoLAN
6  * $Id$
7  *
8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
9  *          Vincent Seguin <seguin@via.ecp.fr>
10  *          Gildas Bazin <gbazin@videolan.org>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
25  *****************************************************************************/
26
27 /**
28  * \file
29  * This file is a collection of common definitions and types
30  */
31
32 /*****************************************************************************
33  * Required vlc headers
34  *****************************************************************************/
35 #if defined( __BORLANDC__ )
36 #   undef PACKAGE
37 #endif
38
39 #include "config.h"
40
41 #if defined(PACKAGE)
42 #   undef PACKAGE_NAME
43 #   define PACKAGE_NAME PACKAGE
44 #endif
45 #if defined(VERSION)
46 #   undef PACKAGE_VERSION
47 #   define PACKAGE_VERSION VERSION
48 #endif
49
50 #if defined( __BORLANDC__ )
51 #   undef HAVE_VARIADIC_MACROS
52 #   undef HAVE_STDINT_H
53 #   undef HAVE_INTTYPES_H
54 #   undef off_t
55 #elif defined( _MSC_VER )
56 #   pragma warning( disable : 4244 )
57 #endif
58
59 #include "vlc_config.h"
60 #include "modules_inner.h"
61
62 /*****************************************************************************
63  * Required system headers
64  *****************************************************************************/
65 #include <stdlib.h>
66 #include <stdarg.h>
67
68 #ifdef HAVE_STRING_H
69 #   include <string.h>                                         /* strerror() */
70 #endif
71
72 #ifdef HAVE_SYS_TYPES_H
73 #   include <sys/types.h>
74 #endif
75
76 /*****************************************************************************
77  * Basic types definitions
78  *****************************************************************************/
79 #if defined( HAVE_STDINT_H )
80 #   include <stdint.h>
81 #elif defined( HAVE_INTTYPES_H )
82 #   include <inttypes.h>
83 #elif defined( SYS_CYGWIN )
84 #   include <sys/types.h>
85     /* Cygwin only defines half of these... */
86     typedef u_int8_t            uint8_t;
87     typedef u_int16_t           uint16_t;
88     typedef u_int32_t           uint32_t;
89     typedef u_int64_t           uint64_t;
90 #else
91     /* Fallback types (very x86-centric, sorry) */
92     typedef unsigned char       uint8_t;
93     typedef signed char         int8_t;
94     typedef unsigned short      uint16_t;
95     typedef signed short        int16_t;
96     typedef unsigned int        uint32_t;
97     typedef signed int          int32_t;
98 #   if defined( _MSC_VER ) \
99       || defined( UNDER_CE ) \
100       || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
101     typedef unsigned __int64    uint64_t;
102     typedef signed __int64      int64_t;
103 #   else
104     typedef unsigned long long  uint64_t;
105     typedef signed long long    int64_t;
106 #   endif
107     typedef uint32_t            uintptr_t;
108     typedef int32_t             intptr_t;
109 #endif
110
111 typedef uint8_t                 byte_t;
112
113 /* ptrdiff_t definition */
114 #ifdef HAVE_STDDEF_H
115 #   include <stddef.h>
116 #else
117 #   include <malloc.h>
118 #   ifndef _PTRDIFF_T
119 #       define _PTRDIFF_T
120 /* Not portable in a 64-bit environment. */
121 typedef int                 ptrdiff_t;
122 #   endif
123 #endif
124
125 #if defined( WIN32 ) || defined( UNDER_CE )
126 #   include <malloc.h>
127 #   ifndef PATH_MAX
128 #       define PATH_MAX MAX_PATH
129 #   endif
130 #endif
131
132 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
133 typedef int                 ssize_t;
134 #endif
135
136 /* Counter for statistics and profiling */
137 typedef unsigned long       count_t;
138
139 /* DCT elements types */
140 typedef int16_t             dctelem_t;
141
142 /* Video buffer types */
143 typedef uint8_t             yuv_data_t;
144
145 /* Audio volume */
146 typedef uint16_t            audio_volume_t;
147
148 #ifndef HAVE_SOCKLEN_T
149 typedef int                 socklen_t;
150 #endif
151
152 /**
153  * High precision date or time interval
154  *
155  * Store a high precision date or time interval. The maximum precision is the
156  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
157  * time interval is then 292271 years, which should be long enough for any
158  * video). Dates are stored as microseconds since a common date (usually the
159  * epoch). Note that date and time intervals can be manipulated using regular
160  * arithmetic operators, and that no special functions are required.
161  */
162 typedef int64_t mtime_t;
163
164 /**
165  * The vlc_fourcc_t type.
166  *
167  * See http://www.webartz.com/fourcc/ for a very detailed list.
168  */
169 typedef uint32_t vlc_fourcc_t;
170
171 #ifdef WORDS_BIGENDIAN
172 #   define VLC_FOURCC( a, b, c, d ) \
173         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
174            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
175 #   define VLC_TWOCC( a, b ) \
176         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
177
178 #else
179 #   define VLC_FOURCC( a, b, c, d ) \
180         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
181            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
182 #   define VLC_TWOCC( a, b ) \
183         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
184
185 #endif
186
187 /*****************************************************************************
188  * Classes declaration
189  *****************************************************************************/
190
191 /* Internal types */
192 typedef struct libvlc_t libvlc_t;
193 typedef struct vlc_t vlc_t;
194 typedef struct variable_t variable_t;
195 typedef struct date_t date_t;
196
197 /* Messages */
198 typedef struct msg_bank_t msg_bank_t;
199 typedef struct msg_subscription_t msg_subscription_t;
200
201 /* Playlist */
202
203 /* FIXME */
204 /**
205  * Playlist commands
206  */
207 typedef enum {
208     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
209     PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
210     PLAYLIST_VIEWPLAY,  /**< arg1= int, arg2= playlist_item_t*,*/
211                         /**  arg3 = playlist_item_t*          , res=can fail */
212     PLAYLIST_ITEMPLAY,  /** <arg1 = playlist_item_t *         , res=can fail */
213     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
214     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
215     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
216     PLAYLIST_GOTO,      /**< arg1=int                           res=can fail */
217     PLAYLIST_VIEWGOTO,      /**< arg1=int                       res=can fail */
218 } playlist_command_t;
219
220
221 typedef struct playlist_t playlist_t;
222 typedef struct playlist_item_t playlist_item_t;
223 typedef struct playlist_view_t playlist_view_t;
224 typedef struct playlist_export_t playlist_export_t;
225 typedef struct services_discovery_t services_discovery_t;
226 typedef struct services_discovery_sys_t services_discovery_sys_t;
227 typedef struct playlist_add_t playlist_add_t;
228 typedef struct playlist_preparse_t playlist_preparse_t;
229
230 /* Modules */
231 typedef struct module_bank_t module_bank_t;
232 typedef struct module_t module_t;
233 typedef struct module_config_t module_config_t;
234 typedef struct module_symbols_t module_symbols_t;
235 typedef struct module_cache_t module_cache_t;
236
237 typedef struct config_category_t config_category_t;
238
239 /* Interface */
240 typedef struct intf_thread_t intf_thread_t;
241 typedef struct intf_sys_t intf_sys_t;
242 typedef struct intf_console_t intf_console_t;
243 typedef struct intf_msg_t intf_msg_t;
244 typedef struct intf_channel_t intf_channel_t;
245
246 /* Input */
247 typedef struct input_thread_t input_thread_t;
248 typedef struct input_thread_sys_t input_thread_sys_t;
249 typedef struct input_item_t input_item_t;
250 typedef struct input_area_t input_area_t;
251 typedef struct input_buffers_t input_buffers_t;
252 typedef struct input_socket_t input_socket_t;
253 typedef struct access_sys_t access_sys_t;
254 typedef struct demux_sys_t demux_sys_t;
255 typedef struct es_descriptor_t es_descriptor_t;
256 typedef struct es_sys_t es_sys_t;
257 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
258 typedef struct pgrm_sys_t pgrm_sys_t;
259 typedef struct stream_descriptor_t stream_descriptor_t;
260 typedef struct seekpoint_t seekpoint_t;
261 typedef struct info_t info_t;
262 typedef struct info_category_t info_category_t;
263
264 /* Format */
265 typedef struct audio_format_t audio_format_t;
266 typedef struct video_format_t video_format_t;
267 typedef struct subs_format_t subs_format_t;
268 typedef struct es_format_t es_format_t;
269 typedef struct video_palette_t video_palette_t;
270
271 /* NInput */
272 typedef struct stream_sys_t stream_sys_t;
273 typedef struct stream_t     stream_t;
274 typedef struct es_out_t     es_out_t;
275 typedef struct es_out_id_t  es_out_id_t;
276 typedef struct es_out_sys_t es_out_sys_t;
277 typedef struct demux_t  demux_t;
278 typedef struct access_t access_t;
279
280 /* Audio */
281 typedef struct aout_instance_t aout_instance_t;
282 typedef struct aout_sys_t aout_sys_t;
283 typedef struct aout_fifo_t aout_fifo_t;
284 typedef struct aout_input_t aout_input_t;
285 typedef struct aout_buffer_t aout_buffer_t;
286 typedef audio_format_t audio_sample_format_t;
287 typedef struct audio_date_t audio_date_t;
288 typedef struct aout_filter_t aout_filter_t;
289
290 /* Video */
291 typedef struct vout_thread_t vout_thread_t;
292 typedef struct vout_sys_t vout_sys_t;
293 typedef struct vout_synchro_t vout_synchro_t;
294 typedef struct chroma_sys_t chroma_sys_t;
295
296 typedef video_format_t video_frame_format_t;
297 typedef struct picture_t picture_t;
298 typedef struct picture_sys_t picture_sys_t;
299 typedef struct picture_heap_t picture_heap_t;
300
301 typedef struct spu_t spu_t;
302 typedef struct subpicture_t subpicture_t;
303 typedef struct subpicture_sys_t subpicture_sys_t;
304 typedef struct subpicture_region_t subpicture_region_t;
305 typedef struct text_style_t text_style_t;
306
307 typedef struct image_handler_t image_handler_t;
308
309 /* Stream output */
310 typedef struct sout_instance_t sout_instance_t;
311 typedef struct sout_instance_sys_t sout_instance_sys_t;
312
313 typedef struct sout_input_t sout_input_t;
314 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
315
316 typedef struct sout_access_out_t sout_access_out_t;
317 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
318
319 typedef struct sout_mux_t sout_mux_t;
320 typedef struct sout_mux_sys_t sout_mux_sys_t;
321
322 typedef struct sout_stream_t    sout_stream_t;
323 typedef struct sout_stream_sys_t sout_stream_sys_t;
324
325 typedef struct sout_cfg_t       sout_cfg_t;
326 typedef struct sap_session_t    sap_session_t;
327 typedef struct sap_address_t sap_address_t;
328 typedef struct session_descriptor_t session_descriptor_t;
329 typedef struct announce_method_t announce_method_t;
330 typedef struct announce_handler_t announce_handler_t;
331 typedef struct sap_handler_t sap_handler_t;
332 //typedef struct slp_session_t    slp_session_t;
333
334 /* Decoders */
335 typedef struct decoder_t      decoder_t;
336 typedef struct decoder_sys_t  decoder_sys_t;
337
338 /* Encoders */
339 typedef struct encoder_t      encoder_t;
340 typedef struct encoder_sys_t  encoder_sys_t;
341
342 /* Filters */
343 typedef struct filter_t filter_t;
344 typedef struct filter_sys_t filter_sys_t;
345
346 /* Misc */
347 typedef struct data_packet_t data_packet_t;
348 typedef struct data_buffer_t data_buffer_t;
349 typedef struct stream_ctrl_t stream_ctrl_t;
350 typedef struct pes_packet_t pes_packet_t;
351 typedef struct network_socket_t network_socket_t;
352 typedef struct virtual_socket_t v_socket_t;
353 typedef struct iso639_lang_t iso639_lang_t;
354
355 /* block */
356 typedef struct block_t      block_t;
357 typedef struct block_fifo_t block_fifo_t;
358
359 /* httpd */
360 typedef struct httpd_t          httpd_t;
361 typedef struct httpd_host_t     httpd_host_t;
362 typedef struct httpd_url_t      httpd_url_t;
363 typedef struct httpd_client_t   httpd_client_t;
364 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
365 typedef struct httpd_message_t  httpd_message_t;
366 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query );
367 typedef struct httpd_file_t     httpd_file_t;
368 typedef struct httpd_file_sys_t httpd_file_sys_t;
369 typedef int (*httpd_file_callback_t)( httpd_file_sys_t*, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
370 typedef struct httpd_redirect_t httpd_redirect_t;
371 typedef struct httpd_stream_t httpd_stream_t;
372
373 /* TLS support */
374 typedef struct tls_t tls_t;
375 typedef struct tls_server_t tls_server_t;
376 typedef struct tls_session_t tls_session_t;
377
378 /* XML */
379 typedef struct xml_t xml_t;
380 typedef struct xml_sys_t xml_sys_t;
381 typedef struct xml_reader_t xml_reader_t;
382 typedef struct xml_reader_sys_t xml_reader_sys_t;
383
384 /* vod server */
385 typedef struct vod_t     vod_t;
386 typedef struct vod_sys_t vod_sys_t;
387 typedef struct vod_media_t vod_media_t;
388
389 /* opengl */
390 typedef struct opengl_t     opengl_t;
391 typedef struct opengl_sys_t opengl_sys_t;
392
393 /* VLM */
394 typedef struct vlm_t         vlm_t;
395 typedef struct vlm_message_t vlm_message_t;
396 typedef struct vlm_media_t   vlm_media_t;
397 typedef struct vlm_schedule_t vlm_schedule_t;
398
399 /* divers */
400 typedef struct vlc_meta_t    vlc_meta_t;
401
402
403 /*****************************************************************************
404  * Variable callbacks
405  *****************************************************************************/
406 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
407                                    char const *,            /* variable name */
408                                    vlc_value_t,                 /* old value */
409                                    vlc_value_t,                 /* new value */
410                                    void * );                /* callback data */
411
412 /*****************************************************************************
413  * Plug-in stuff
414  *****************************************************************************/
415 #ifndef __PLUGIN__
416 #   define VLC_EXPORT( type, name, args ) type name args
417 #else
418 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
419     extern module_symbols_t* p_symbols;
420 #endif
421
422 /*****************************************************************************
423  * OS-specific headers and thread types
424  *****************************************************************************/
425 #if defined( WIN32 ) || defined( UNDER_CE )
426 #   define WIN32_LEAN_AND_MEAN
427 #   include <windows.h>
428 #   if defined( UNDER_CE )
429 #      define IS_WINNT 0
430 #   else
431 #      define IS_WINNT ( GetVersion() < 0x80000000 )
432 #   endif
433 #endif
434
435 #include "vlc_threads.h"
436
437 /*****************************************************************************
438  * Common structure members
439  *****************************************************************************/
440
441 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
442 #define VLC_COMMON_MEMBERS                                                  \
443 /** \name VLC_COMMON_MEMBERS                                                \
444  * these members are common for all vlc objects                             \
445  */                                                                         \
446 /**@{*/                                                                     \
447     int   i_object_id;                                                      \
448     int   i_object_type;                                                    \
449     char *psz_object_type;                                                  \
450     char *psz_object_name;                                                  \
451                                                                             \
452     /* Thread properties, if any */                                         \
453     vlc_bool_t   b_thread;                                                  \
454     vlc_thread_t thread_id;                                                 \
455                                                                             \
456     /* Object access lock */                                                \
457     vlc_mutex_t  object_lock;                                               \
458     vlc_cond_t   object_wait;                                               \
459                                                                             \
460     /* Object properties */                                                 \
461     volatile vlc_bool_t b_error;                  /**< set by the object */ \
462     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
463     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
464     volatile vlc_bool_t b_attached;               /**< set by the object */ \
465     vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
466                                                                             \
467     /* Object variables */                                                  \
468     vlc_mutex_t     var_lock;                                               \
469     int             i_vars;                                                 \
470     variable_t *    p_vars;                                                 \
471                                                                             \
472     /* Stuff related to the libvlc structure */                             \
473     libvlc_t *      p_libvlc;                      /**< root of all evil */ \
474     vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
475                                                                             \
476     volatile int    i_refcount;                         /**< usage count */ \
477     vlc_object_t *  p_parent;                            /**< our parent */ \
478     vlc_object_t ** pp_children;                       /**< our children */ \
479     volatile int    i_children;                                             \
480                                                                             \
481     /* Private data */                                                      \
482     void *          p_private;                                              \
483                                                                             \
484     /** Just a reminder so that people don't cast garbage */                \
485     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
486 /**@}*/                                                                     \
487
488 /* VLC_OBJECT: attempt at doing a clever cast */
489 #define VLC_OBJECT( x ) \
490     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
491
492 /*****************************************************************************
493  * Macros and inline functions
494  *****************************************************************************/
495 #ifdef NTOHL_IN_SYS_PARAM_H
496 #   include <sys/param.h>
497
498 #elif !defined(WIN32) && !defined( UNDER_CE )
499 #   include <netinet/in.h>
500
501 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
502
503 /* CEIL: division with round to nearest greater integer */
504 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
505
506 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
507 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
508
509 /* __MAX and __MIN: self explanatory */
510 #ifndef __MAX
511 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
512 #endif
513 #ifndef __MIN
514 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
515 #endif
516
517 static int64_t GCD( int64_t a, int64_t b )
518 {
519     if( b ) return GCD( b, a % b );
520     else return a;
521 }
522
523 /* Dynamic array handling: realloc array, move data, increment position */
524 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
525     do                                                                        \
526     {                                                                         \
527         if( i_oldsize )                                                       \
528         {                                                                     \
529             (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) );  \
530         }                                                                     \
531         else                                                                  \
532         {                                                                     \
533             (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) );         \
534         }                                                                     \
535         if( (i_oldsize) - (i_pos) )                                           \
536         {                                                                     \
537             memmove( (p_ar) + (i_pos) + 1,                                    \
538                      (p_ar) + (i_pos),                                        \
539                      ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
540         }                                                                     \
541         (p_ar)[i_pos] = elem;                                                 \
542         (i_oldsize)++;                                                        \
543     }                                                                         \
544     while( 0 )
545
546 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
547     do                                                                        \
548     {                                                                         \
549         if( (i_oldsize) - (i_pos) - 1 )                                       \
550         {                                                                     \
551             memmove( (p_ar) + (i_pos),                                        \
552                      (p_ar) + (i_pos) + 1,                                    \
553                      ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
554         }                                                                     \
555         if( i_oldsize > 1 )                                                   \
556         {                                                                     \
557             (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) );  \
558         }                                                                     \
559         else                                                                  \
560         {                                                                     \
561             free( p_ar );                                                     \
562             (p_ar) = NULL;                                                    \
563         }                                                                     \
564         (i_oldsize)--;                                                        \
565     }                                                                         \
566     while( 0 )
567
568
569 #define TAB_APPEND( count, tab, p )             \
570     if( (count) > 0 )                           \
571     {                                           \
572         (tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
573     }                                           \
574     else                                        \
575     {                                           \
576         (tab) = malloc( sizeof( void ** ) );    \
577     }                                           \
578     (tab)[count] = (p);        \
579     (count)++
580
581 #define TAB_FIND( count, tab, p, index )        \
582     {                                           \
583         int _i_;                                \
584         (index) = -1;                           \
585         for( _i_ = 0; _i_ < (count); _i_++ )    \
586         {                                       \
587             if( (tab)[_i_] == (p) )  \
588             {                                   \
589                 (index) = _i_;                  \
590                 break;                          \
591             }                                   \
592         }                                       \
593     }
594
595 #define TAB_REMOVE( count, tab, p )             \
596     {                                           \
597         int _i_index_;                          \
598         TAB_FIND( count, tab, p, _i_index_ );   \
599         if( _i_index_ >= 0 )                    \
600         {                                       \
601             if( (count) > 1 )                     \
602             {                                   \
603                 memmove( ((void**)(tab) + _i_index_),    \
604                          ((void**)(tab) + _i_index_+1),  \
605                          ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
606             }                                   \
607             (count)--;                          \
608             if( (count) == 0 )                  \
609             {                                   \
610                 free( tab );                    \
611                 (tab) = NULL;                   \
612             }                                   \
613         }                                       \
614     }
615
616 /* MSB (big endian)/LSB (little endian) conversions - network order is always
617  * MSB, and should be used for both network communications and files. Note that
618  * byte orders other than little and big endians are not supported, but only
619  * the VAX seems to have such exotic properties. */
620 static inline uint16_t U16_AT( void const * _p )
621 {
622     uint8_t * p = (uint8_t *)_p;
623     return ( ((uint16_t)p[0] << 8) | p[1] );
624 }
625 static inline uint32_t U32_AT( void const * _p )
626 {
627     uint8_t * p = (uint8_t *)_p;
628     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
629               | ((uint32_t)p[2] << 8) | p[3] );
630 }
631 static inline uint64_t U64_AT( void const * _p )
632 {
633     uint8_t * p = (uint8_t *)_p;
634     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
635               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
636               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
637               | ((uint64_t)p[6] << 8) | p[7] );
638 }
639
640 static inline uint16_t GetWLE( void const * _p )
641 {
642     uint8_t * p = (uint8_t *)_p;
643     return ( ((uint16_t)p[1] << 8) | p[0] );
644 }
645 static inline uint32_t GetDWLE( void const * _p )
646 {
647     uint8_t * p = (uint8_t *)_p;
648     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
649               | ((uint32_t)p[1] << 8) | p[0] );
650 }
651 static inline uint64_t GetQWLE( void const * _p )
652 {
653     uint8_t * p = (uint8_t *)_p;
654     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
655               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
656               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
657               | ((uint64_t)p[1] << 8) | p[0] );
658 }
659
660 #define GetWBE( p )     U16_AT( p )
661 #define GetDWBE( p )    U32_AT( p )
662 #define GetQWBE( p )    U64_AT( p )
663
664 /* Helper writer functions */
665 #define SetWLE( p, v ) _SetWLE( (uint8_t*)p, v)
666 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
667 {
668     p[1] = ( i_dw >>  8 )&0xff;
669     p[0] = ( i_dw       )&0xff;
670 }
671
672 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)p, v)
673 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
674 {
675     p[3] = ( i_dw >> 24 )&0xff;
676     p[2] = ( i_dw >> 16 )&0xff;
677     p[1] = ( i_dw >>  8 )&0xff;
678     p[0] = ( i_dw       )&0xff;
679 }
680 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)p, v)
681 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
682 {
683     SetDWLE( p,   i_qw&0xffffffff );
684     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
685 }
686 #define SetWBE( p, v ) _SetWBE( (uint8_t*)p, v)
687 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
688 {
689     p[0] = ( i_dw >>  8 )&0xff;
690     p[1] = ( i_dw       )&0xff;
691 }
692
693 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)p, v)
694 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
695 {
696     p[0] = ( i_dw >> 24 )&0xff;
697     p[1] = ( i_dw >> 16 )&0xff;
698     p[2] = ( i_dw >>  8 )&0xff;
699     p[3] = ( i_dw       )&0xff;
700 }
701 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)p, v)
702 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
703 {
704     SetDWBE( p+4,   i_qw&0xffffffff );
705     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
706 }
707
708 #if WORDS_BIGENDIAN
709 #   define hton16(i)   ( i )
710 #   define hton32(i)   ( i )
711 #   define hton64(i)   ( i )
712 #   define ntoh16(i)   ( i )
713 #   define ntoh32(i)   ( i )
714 #   define ntoh64(i)   ( i )
715 #else
716 #   define hton16(i)   U16_AT(&i)
717 #   define hton32(i)   U32_AT(&i)
718 #   define hton64(i)   U64_AT(&i)
719 #   define ntoh16(i)   U16_AT(&i)
720 #   define ntoh32(i)   U32_AT(&i)
721 #   define ntoh64(i)   U64_AT(&i)
722 #endif
723
724 /* Format string sanity checks */
725 #ifdef HAVE_ATTRIBUTE_FORMAT
726 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
727 #else
728 #   define ATTRIBUTE_FORMAT(x,y)
729 #endif
730
731 /* Alignment of critical static data structures */
732 #ifdef ATTRIBUTE_ALIGNED_MAX
733 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
734 #else
735 #   define ATTR_ALIGN(align)
736 #endif
737
738 /* Alignment of critical dynamic data structure
739  *
740  * Not all platforms support memalign so we provide a vlc_memalign wrapper
741  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
742  * *pp_orig is the pointer that has to be freed afterwards.
743  */
744 #if 0
745 #ifdef HAVE_POSIX_MEMALIGN
746 #   define vlc_memalign(align,size,pp_orig) \
747     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
748 #endif
749 #endif
750 #ifdef HAVE_MEMALIGN
751     /* Some systems have memalign() but no declaration for it */
752     void * memalign( size_t align, size_t size );
753
754 #   define vlc_memalign(pp_orig,align,size) \
755     ( *(pp_orig) = memalign( align, size ) )
756
757 #else /* We don't have any choice but to align manually */
758 #   define vlc_memalign(pp_orig,align,size) \
759     (( *(pp_orig) = malloc( size + align - 1 )) \
760         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
761                        & (~(unsigned long)(align-1)) ) \
762         : NULL )
763
764 #endif
765
766 /* Stuff defined in src/extras/libc.c */
767 #ifndef HAVE_STRDUP
768 #   define strdup vlc_strdup
769     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
770 #elif !defined(__PLUGIN__)
771 #   define vlc_strdup NULL
772 #endif
773
774 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
775 #   define vasprintf vlc_vasprintf
776     VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
777 #elif !defined(__PLUGIN__)
778 #   define vlc_vasprintf NULL
779 #endif
780
781 #if !defined(HAVE_ASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
782 #   define asprintf vlc_asprintf
783     VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
784 #elif !defined(__PLUGIN__)
785 #   define vlc_asprintf NULL
786 #endif
787
788 #ifndef HAVE_STRNDUP
789 #   if defined(STRNDUP_IN_GNOME_H) && \
790         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
791          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
792         /* Do nothing: gnome.h defines strndup for us */
793 #   else
794 #       define strndup vlc_strndup
795         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
796 #   endif
797 #elif !defined(__PLUGIN__)
798 #   define vlc_strndup NULL
799 #endif
800
801 #ifndef HAVE_ATOF
802 #   define atof vlc_atof
803     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
804 #elif !defined(__PLUGIN__)
805 #   define vlc_atof NULL
806 #endif
807
808 #ifndef HAVE_STRTOF
809 #   ifdef HAVE_STRTOD
810 #       define strtof strtod
811 #   endif
812 #endif
813
814 #ifndef HAVE_ATOLL
815 #   define atoll vlc_atoll
816     VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
817 #elif !defined(__PLUGIN__)
818 #   define vlc_atoll NULL
819 #endif
820
821 #ifndef HAVE_STRTOLL
822 #   define strtoll vlc_strtoll
823     VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
824 #elif !defined(__PLUGIN__)
825 #   define vlc_strtoll NULL
826 #endif
827
828 #ifndef HAVE_GETENV
829 #   define getenv vlc_getenv
830     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
831 #elif !defined(__PLUGIN__)
832 #   define vlc_getenv NULL
833 #endif
834
835 #ifndef HAVE_STRCASECMP
836 #   ifndef HAVE_STRICMP
837 #       define strcasecmp vlc_strcasecmp
838         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
839 #   else
840 #       define strcasecmp stricmp
841 #       if !defined(__PLUGIN__)
842 #           define vlc_strcasecmp NULL
843 #       endif
844 #   endif
845 #elif !defined(__PLUGIN__)
846 #   define vlc_strcasecmp NULL
847 #endif
848
849 #ifndef HAVE_STRNCASECMP
850 #   ifndef HAVE_STRNICMP
851 #       define strncasecmp vlc_strncasecmp
852         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
853 #   else
854 #       define strncasecmp strnicmp
855 #       if !defined(__PLUGIN__)
856 #           define vlc_strncasecmp NULL
857 #       endif
858 #   endif
859 #elif !defined(__PLUGIN__)
860 #   define vlc_strncasecmp NULL
861 #endif
862
863 #ifndef HAVE_STRCASESTR
864 #   ifndef HAVE_STRISTR
865 #       define strcasestr vlc_strcasestr
866         VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
867 #   else
868 #       define strcasestr stristr
869 #       if !defined(__PLUGIN__)
870 #           define vlc_strcasestr NULL
871 #       endif
872 #   endif
873 #elif !defined(__PLUGIN__)
874 #   define vlc_strcasestr NULL
875 #endif
876
877 /* Format type specifiers for 64 bits numbers */
878 #if !defined(WIN32) && !defined(UNDER_CE)
879 #   define I64Fd "%lld"
880 #   define I64Fi "%lli"
881 #   define I64Fo "%llo"
882 #   define I64Fu "%llu"
883 #   define I64Fx "%llx"
884 #   define I64FX "%llX"
885 #else
886 #   define I64Fd "%I64d"
887 #   define I64Fi "%I64i"
888 #   define I64Fo "%I64o"
889 #   define I64Fu "%I64u"
890 #   define I64Fx "%I64x"
891 #   define I64FX "%I64X"
892 #endif /* defined(WIN32)||defined(UNDER_CE) */
893
894 /* 64 bits integer constant suffix */
895 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
896 #   define I64C(x)         x##LL
897 #   define UI64C(x)        x##ULL
898 #else
899 #   define I64C(x)         x##i64
900 #   define UI64C(x)        x##ui64
901 #endif /* defined(WIN32)||defined(UNDER_CE) */
902
903 #if defined(WIN32) || defined(UNDER_CE)
904 /* win32, cl and icl support */
905 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
906 #       define __attribute__(x)
907 #       define __inline__      __inline
908 #       define S_IFBLK         0x3000  /* Block */
909 #       define S_ISBLK(m)      (0)
910 #       define S_ISCHR(m)      (0)
911 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
912 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
913 #   endif
914
915 /* several type definitions */
916 #   if defined( __MINGW32__ )
917 #       if !defined( _OFF_T_ )
918 typedef long long _off_t;
919 typedef _off_t off_t;
920 #           define _OFF_T_
921 #       else
922 #           ifdef off_t
923 #               undef off_t
924 #           endif
925 #           define off_t long long
926 #       endif
927 #   endif
928
929 #   if defined( _MSC_VER )
930 #       if !defined( _OFF_T_DEFINED )
931 typedef __int64 off_t;
932 #           define _OFF_T_DEFINED
933 #       else
934 #           define off_t __int64
935 #       endif
936 #   endif
937
938 #   if defined( __BORLANDC__ )
939 #       undef off_t
940 #       define off_t unsigned __int64
941 #   endif
942
943 #   ifndef O_NONBLOCK
944 #       define O_NONBLOCK 0
945 #   endif
946
947 #   ifndef alloca
948 #       define alloca _alloca
949 #   endif
950
951     /* These two are not defined in mingw32 (bug?) */
952 #   ifndef snprintf
953 #       define snprintf _snprintf
954 #   endif
955 #   ifndef vsnprintf
956 #       define vsnprintf _vsnprintf
957 #   endif
958
959 #   ifndef _T
960 #       ifdef UNICODE
961 #           define _T(q) L##q
962 #       else
963 #           define _T(q) q
964 #       endif
965 #   endif
966 #endif
967
968 /* lseek (defined in src/extras/libc.c) */
969 #ifndef HAVE_LSEEK
970 #   define lseek vlc_lseek
971     VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
972 #elif !defined(__PLUGIN__)
973 #   define vlc_lseek NULL
974 #endif
975
976 VLC_EXPORT( vlc_bool_t, vlc_reduce, ( int *, int *, int64_t, int64_t, int64_t ) );
977 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
978
979 /* vlc_wraptext (defined in src/extras/libc.c) */
980 #define wraptext vlc_wraptext
981 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) );
982
983 /* iconv wrappers (defined in src/extras/libc.c) */
984 typedef void *vlc_iconv_t;
985 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
986 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, char **, size_t *, char **, size_t * ) );
987 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
988
989 /*****************************************************************************
990  * CPU capabilities
991  *****************************************************************************/
992 #define CPU_CAPABILITY_NONE    0
993 #define CPU_CAPABILITY_486     (1<<0)
994 #define CPU_CAPABILITY_586     (1<<1)
995 #define CPU_CAPABILITY_PPRO    (1<<2)
996 #define CPU_CAPABILITY_MMX     (1<<3)
997 #define CPU_CAPABILITY_3DNOW   (1<<4)
998 #define CPU_CAPABILITY_MMXEXT  (1<<5)
999 #define CPU_CAPABILITY_SSE     (1<<6)
1000 #define CPU_CAPABILITY_SSE2    (1<<7)
1001 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1002 #define CPU_CAPABILITY_FPU     (1<<31)
1003
1004 /*****************************************************************************
1005  * I18n stuff
1006  *****************************************************************************/
1007 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1008
1009 #if defined( ENABLE_NLS ) && \
1010      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1011       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1012       defined(MODULE_NAME_IS_pda))
1013     /* Declare nothing: gnome.h will do it for us */
1014 #elif defined( ENABLE_NLS )
1015 #   if defined( HAVE_INCLUDED_GETTEXT )
1016 #       include "libintl.h"
1017 #   else
1018 #       include <libintl.h>
1019 #   endif
1020 #   undef _
1021 #   define _(String) vlc_dgettext (PACKAGE_NAME, String)
1022 #   define N_(String) ((char*)(String))
1023 #else
1024 #   define _(String) ((char*)(String))
1025 #   define N_(String) ((char*)(String))
1026 #endif
1027
1028 /*****************************************************************************
1029  * Additional vlc stuff
1030  *****************************************************************************/
1031 #include "vlc_symbols.h"
1032 #include "os_specific.h"
1033 #include "vlc_messages.h"
1034 #include "variables.h"
1035 #include "vlc_objects.h"
1036 #include "vlc_threads_funcs.h"
1037 #include "mtime.h"
1038 #include "modules.h"
1039 #include "main.h"
1040 #include "configuration.h"
1041
1042 #if defined( __BORLANDC__ )
1043 #   undef PACKAGE
1044 #   define PACKAGE
1045 #endif
1046