1 /*****************************************************************************
2 * vlc_common.h: common definitions
3 * Collection of useful common types and macros definitions
4 *****************************************************************************
5 * Copyright (C) 1998-2011 VLC authors and VideoLAN
7 * Authors: Samuel Hocevar <sam@via.ecp.fr>
8 * Vincent Seguin <seguin@via.ecp.fr>
9 * Gildas Bazin <gbazin@videolan.org>
10 * RĂ©mi Denis-Courmont
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU Lesser General Public License as published by
14 * the Free Software Foundation; either version 2.1 of the License, or
15 * (at your option) any later version.
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 Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public License
23 * along with this program; if not, write to the Free Software Foundation,
24 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
29 * This file is a collection of common definitions and types
33 # define VLC_COMMON_H 1
35 /*****************************************************************************
36 * Required vlc headers
37 *****************************************************************************/
38 #include "vlc_config.h"
40 /*****************************************************************************
41 * Required system headers
42 *****************************************************************************/
55 /*****************************************************************************
56 * Compilers definitions
57 *****************************************************************************/
58 /* Helper for GCC version checks */
60 # define VLC_GCC_VERSION(maj,min) \
61 ((__GNUC__ > (maj)) || (__GNUC__ == (maj) && __GNUC_MINOR__ >= (min)))
63 # define VLC_GCC_VERSION(maj,min) (0)
66 /* Try to fix format strings for all versions of mingw and mingw64 */
67 #if defined( _WIN32 ) && defined( __USE_MINGW_ANSI_STDIO )
78 #define snprintf __mingw_snprintf
79 #define vsnprintf __mingw_vsnprintf
80 #define swprintf _snwprintf
83 /* Function attributes for compiler warnings */
85 # define VLC_DEPRECATED __attribute__((deprecated))
87 # if defined( _WIN32 ) && VLC_GCC_VERSION(4,4)
88 # define VLC_FORMAT(x,y) __attribute__ ((format(gnu_printf,x,y)))
90 # define VLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
92 # define VLC_FORMAT_ARG(x) __attribute__ ((format_arg(x)))
94 # define VLC_MALLOC __attribute__ ((malloc))
95 # define VLC_NORETURN __attribute__ ((noreturn))
97 # if VLC_GCC_VERSION(3,4)
98 # define VLC_USED __attribute__ ((warn_unused_result))
104 # define VLC_DEPRECATED
105 # define VLC_FORMAT(x,y)
106 # define VLC_FORMAT_ARG(x)
108 # define VLC_NORETURN
113 /* Branch prediction */
115 # define likely(p) __builtin_expect(!!(p), 1)
116 # define unlikely(p) __builtin_expect(!!(p), 0)
117 # define unreachable() __builtin_unreachable()
119 # define likely(p) (!!(p))
120 # define unlikely(p) (!!(p))
121 # define unreachable() ((void)0)
124 #define vlc_assert_unreachable() (assert(!"unreachable"), unreachable())
128 # define VLC_EXTERN extern "C"
133 #if defined (_WIN32) && defined (DLL_EXPORT)
134 # define VLC_EXPORT __declspec(dllexport)
135 #elif VLC_GCC_VERSION(4,0)
136 # define VLC_EXPORT __attribute__((visibility("default")))
141 #define VLC_API VLC_EXTERN VLC_EXPORT
144 /*****************************************************************************
145 * Basic types definitions
146 *****************************************************************************/
148 * High precision date or time interval
150 * Store a high precision date or time interval. The maximum precision is the
151 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
152 * time interval is then 292271 years, which should be long enough for any
153 * video). Dates are stored as microseconds since a common date (usually the
154 * epoch). Note that date and time intervals can be manipulated using regular
155 * arithmetic operators, and that no special functions are required.
157 typedef int64_t mtime_t;
160 * The vlc_fourcc_t type.
162 * See http://www.webartz.com/fourcc/ for a very detailed list.
164 typedef uint32_t vlc_fourcc_t;
166 #ifdef WORDS_BIGENDIAN
167 # define VLC_FOURCC( a, b, c, d ) \
168 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
169 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
170 # define VLC_TWOCC( a, b ) \
171 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
174 # define VLC_FOURCC( a, b, c, d ) \
175 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
176 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
177 # define VLC_TWOCC( a, b ) \
178 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
183 * Translate a vlc_fourcc into its string representation. This function
184 * assumes there is enough room in psz_fourcc to store 4 characters in.
186 * \param fcc a vlc_fourcc_t
187 * \param psz_fourcc string to store string representation of vlc_fourcc in
189 static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
191 memcpy( psz_fourcc, &fcc, 4 );
194 #define vlc_fourcc_to_char( a, b ) \
195 vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
197 /*****************************************************************************
198 * Classes declaration
199 *****************************************************************************/
202 typedef struct vlc_list_t vlc_list_t;
203 typedef struct vlc_object_t vlc_object_t;
204 typedef struct libvlc_int_t libvlc_int_t;
205 typedef struct date_t date_t;
209 typedef struct playlist_t playlist_t;
210 typedef struct playlist_item_t playlist_item_t;
211 typedef struct services_discovery_t services_discovery_t;
212 typedef struct services_discovery_sys_t services_discovery_sys_t;
213 typedef struct playlist_add_t playlist_add_t;
216 typedef struct module_t module_t;
217 typedef struct module_config_t module_config_t;
219 typedef struct config_category_t config_category_t;
222 typedef struct input_thread_t input_thread_t;
223 typedef struct input_item_t input_item_t;
224 typedef struct input_item_node_t input_item_node_t;
225 typedef struct access_t access_t;
226 typedef struct access_sys_t access_sys_t;
227 typedef struct stream_t stream_t;
228 typedef struct stream_sys_t stream_sys_t;
229 typedef struct demux_t demux_t;
230 typedef struct demux_sys_t demux_sys_t;
231 typedef struct es_out_t es_out_t;
232 typedef struct es_out_id_t es_out_id_t;
233 typedef struct es_out_sys_t es_out_sys_t;
234 typedef struct seekpoint_t seekpoint_t;
235 typedef struct info_t info_t;
236 typedef struct info_category_t info_category_t;
237 typedef struct input_attachment_t input_attachment_t;
240 typedef struct audio_format_t audio_format_t;
241 typedef struct video_format_t video_format_t;
242 typedef struct subs_format_t subs_format_t;
243 typedef struct es_format_t es_format_t;
244 typedef struct video_palette_t video_palette_t;
247 typedef struct audio_output audio_output_t;
248 typedef struct aout_sys_t aout_sys_t;
249 typedef audio_format_t audio_sample_format_t;
252 typedef struct vout_thread_t vout_thread_t;
254 typedef video_format_t video_frame_format_t;
255 typedef struct picture_t picture_t;
256 typedef struct picture_sys_t picture_sys_t;
259 typedef struct spu_t spu_t;
260 typedef struct subpicture_t subpicture_t;
261 typedef struct subpicture_region_t subpicture_region_t;
263 typedef struct image_handler_t image_handler_t;
266 typedef struct sout_instance_t sout_instance_t;
268 typedef struct sout_input_t sout_input_t;
269 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
271 typedef struct sout_access_out_t sout_access_out_t;
272 typedef struct sout_access_out_sys_t sout_access_out_sys_t;
274 typedef struct sout_mux_t sout_mux_t;
275 typedef struct sout_mux_sys_t sout_mux_sys_t;
277 typedef struct sout_stream_t sout_stream_t;
278 typedef struct sout_stream_sys_t sout_stream_sys_t;
280 typedef struct config_chain_t config_chain_t;
281 typedef struct session_descriptor_t session_descriptor_t;
284 typedef struct decoder_t decoder_t;
285 typedef struct decoder_sys_t decoder_sys_t;
286 typedef struct decoder_synchro_t decoder_synchro_t;
289 typedef struct encoder_t encoder_t;
290 typedef struct encoder_sys_t encoder_sys_t;
293 typedef struct filter_t filter_t;
294 typedef struct filter_sys_t filter_sys_t;
297 typedef struct virtual_socket_t v_socket_t;
298 typedef struct vlc_url_t vlc_url_t;
301 typedef struct iso639_lang_t iso639_lang_t;
304 typedef struct block_t block_t;
305 typedef struct block_fifo_t block_fifo_t;
308 typedef struct md5_s md5_t;
311 typedef struct xml_t xml_t;
312 typedef struct xml_sys_t xml_sys_t;
313 typedef struct xml_reader_t xml_reader_t;
314 typedef struct xml_reader_sys_t xml_reader_sys_t;
317 typedef struct vod_t vod_t;
318 typedef struct vod_sys_t vod_sys_t;
319 typedef struct vod_media_t vod_media_t;
322 typedef struct vlm_t vlm_t;
323 typedef struct vlm_message_t vlm_message_t;
326 typedef struct vlc_meta_t vlc_meta_t;
327 typedef struct input_stats_t input_stats_t;
328 typedef struct addon_entry_t addon_entry_t;
331 typedef struct update_t update_t;
334 * VLC value structure
345 struct { int32_t x; int32_t y; } coords;
356 vlc_value_t *p_values;
359 /*****************************************************************************
360 * Error values (shouldn't be exposed)
361 *****************************************************************************/
362 #define VLC_SUCCESS (-0) /**< No error */
363 #define VLC_EGENERIC (-1) /**< Unspecified error */
364 #define VLC_ENOMEM (-2) /**< Not enough memory */
365 #define VLC_ETIMEOUT (-3) /**< Timeout */
366 #define VLC_ENOMOD (-4) /**< Module not found */
367 #define VLC_ENOOBJ (-5) /**< Object not found */
368 #define VLC_ENOVAR (-6) /**< Variable not found */
369 #define VLC_EBADVAR (-7) /**< Bad variable value */
370 #define VLC_ENOITEM (-8) /**< Item not found */
372 /*****************************************************************************
373 * Variable callbacks: called when the value is modified
374 *****************************************************************************/
375 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
376 char const *, /* variable name */
377 vlc_value_t, /* old value */
378 vlc_value_t, /* new value */
379 void * ); /* callback data */
381 /*****************************************************************************
382 * List callbacks: called when elements are added/removed from the list
383 *****************************************************************************/
384 typedef int ( * vlc_list_callback_t ) ( vlc_object_t *, /* variable's object */
385 char const *, /* variable name */
386 int, /* VLC_VAR_* action */
387 vlc_value_t *, /* new/deleted value */
388 void *); /* callback data */
394 } vlc_callback_type_t;
396 /*****************************************************************************
397 * OS-specific headers and thread types
398 *****************************************************************************/
399 #if defined( _WIN32 )
402 # define PATH_MAX MAX_PATH
404 # include <windows.h>
408 #include <sys/syslimits.h>
412 # define OS2EMX_PLAIN_CHAR
415 # include <os2safe.h>
419 #include "vlc_mtime.h"
420 #include "vlc_threads.h"
422 /*****************************************************************************
423 * Common structure members
424 *****************************************************************************/
426 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
427 #define VLC_COMMON_MEMBERS \
428 /** \name VLC_COMMON_MEMBERS \
429 * these members are common for all vlc objects \
432 const char *psz_object_type; \
434 /* Messages header */ \
438 /* Object properties */ \
439 bool b_force; /**< set by the outside (eg. module_need()) */ \
441 /* Stuff related to the libvlc structure */ \
442 libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \
444 vlc_object_t * p_parent; /**< our parent */ \
448 /* VLC_OBJECT: attempt at doing a clever cast */
449 #if VLC_GCC_VERSION(4,0)
451 # define VLC_OBJECT( x ) \
452 __builtin_choose_expr( \
453 __builtin_offsetof(__typeof__(*(x)), psz_object_type), \
454 (void)0 /* screw you */, \
457 # define VLC_OBJECT( x ) \
458 ((vlc_object_t *)(x) \
459 + 0 * __builtin_offsetof(__typeof__(*(x)), psz_object_type))
462 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
465 /*****************************************************************************
466 * Macros and inline functions
467 *****************************************************************************/
469 /* CEIL: division with round to nearest greater integer */
470 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
472 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
473 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
475 /* __MAX and __MIN: self explanatory */
477 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
480 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
483 /* clip v in [min, max] */
484 #define VLC_CLIP(v, min, max) __MIN(__MAX((v), (min)), (max))
487 static inline int64_t GCD ( int64_t a, int64_t b )
498 /* function imported from libavutil/common.h */
500 static inline uint8_t clip_uint8_vlc( int32_t a )
502 if( a&(~255) ) return (-a)>>31;
506 /** Count leading zeroes */
508 static inline unsigned clz (unsigned x)
510 #if VLC_GCC_VERSION(3,4)
511 return __builtin_clz (x);
513 unsigned i = sizeof (x) * 8;
524 #define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
525 #define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
526 /* XXX: this assumes that int is 32-bits or more */
527 #define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
529 /** Count trailing zeroes */
531 static inline unsigned ctz (unsigned x)
533 #if VLC_GCC_VERSION(3,4)
534 return __builtin_ctz (x);
536 unsigned i = sizeof (x) * 8;
549 static inline unsigned popcount (unsigned x)
551 #if VLC_GCC_VERSION(3,4)
552 return __builtin_popcount (x);
565 static inline unsigned parity (unsigned x)
567 #if VLC_GCC_VERSION(3,4)
568 return __builtin_parity (x);
570 for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
582 /** Byte swap (16 bits) */
584 static inline uint16_t bswap16 (uint16_t x)
586 return (x << 8) | (x >> 8);
589 /** Byte swap (32 bits) */
591 static inline uint32_t bswap32 (uint32_t x)
593 #if VLC_GCC_VERSION(4,3) || defined(__clang__)
594 return __builtin_bswap32 (x);
596 return ((x & 0x000000FF) << 24)
597 | ((x & 0x0000FF00) << 8)
598 | ((x & 0x00FF0000) >> 8)
599 | ((x & 0xFF000000) >> 24);
603 /** Byte swap (64 bits) */
605 static inline uint64_t bswap64 (uint64_t x)
607 #if VLC_GCC_VERSION(4,3) || defined(__clang__)
608 return __builtin_bswap64 (x);
609 #elif !defined (__cplusplus)
610 return ((x & 0x00000000000000FF) << 56)
611 | ((x & 0x000000000000FF00) << 40)
612 | ((x & 0x0000000000FF0000) << 24)
613 | ((x & 0x00000000FF000000) << 8)
614 | ((x & 0x000000FF00000000) >> 8)
615 | ((x & 0x0000FF0000000000) >> 24)
616 | ((x & 0x00FF000000000000) >> 40)
617 | ((x & 0xFF00000000000000) >> 56);
619 return ((x & 0x00000000000000FFULL) << 56)
620 | ((x & 0x000000000000FF00ULL) << 40)
621 | ((x & 0x0000000000FF0000ULL) << 24)
622 | ((x & 0x00000000FF000000ULL) << 8)
623 | ((x & 0x000000FF00000000ULL) >> 8)
624 | ((x & 0x0000FF0000000000ULL) >> 24)
625 | ((x & 0x00FF000000000000ULL) >> 40)
626 | ((x & 0xFF00000000000000ULL) >> 56);
631 /* Free and set set the variable to NULL */
632 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
634 #define EMPTY_STR(str) (!str || !*str)
636 VLC_API char const * vlc_error( int ) VLC_USED;
638 #include <vlc_arrays.h>
640 /* MSB (big endian)/LSB (little endian) conversions - network order is always
641 * MSB, and should be used for both network communications and files. */
643 #ifdef WORDS_BIGENDIAN
644 # define hton16(i) ((uint16_t)(i))
645 # define hton32(i) ((uint32_t)(i))
646 # define hton64(i) ((uint64_t)(i))
648 # define hton16(i) bswap16(i)
649 # define hton32(i) bswap32(i)
650 # define hton64(i) bswap64(i)
652 #define ntoh16(i) hton16(i)
653 #define ntoh32(i) hton32(i)
654 #define ntoh64(i) hton64(i)
656 /** Reads 16 bits in network byte order */
658 static inline uint16_t U16_AT (const void *p)
662 memcpy (&x, p, sizeof (x));
666 /** Reads 32 bits in network byte order */
668 static inline uint32_t U32_AT (const void *p)
672 memcpy (&x, p, sizeof (x));
676 /** Reads 64 bits in network byte order */
678 static inline uint64_t U64_AT (const void *p)
682 memcpy (&x, p, sizeof (x));
686 #define GetWBE(p) U16_AT(p)
687 #define GetDWBE(p) U32_AT(p)
688 #define GetQWBE(p) U64_AT(p)
690 /** Reads 16 bits in little-endian order */
692 static inline uint16_t GetWLE (const void *p)
696 memcpy (&x, p, sizeof (x));
697 #ifdef WORDS_BIGENDIAN
703 /** Reads 32 bits in little-endian order */
705 static inline uint32_t GetDWLE (const void *p)
709 memcpy (&x, p, sizeof (x));
710 #ifdef WORDS_BIGENDIAN
716 /** Reads 64 bits in little-endian order */
718 static inline uint64_t GetQWLE (const void *p)
722 memcpy (&x, p, sizeof (x));
723 #ifdef WORDS_BIGENDIAN
729 /** Writes 16 bits in network byte order */
730 static inline void SetWBE (void *p, uint16_t w)
733 memcpy (p, &w, sizeof (w));
736 /** Writes 32 bits in network byte order */
737 static inline void SetDWBE (void *p, uint32_t dw)
740 memcpy (p, &dw, sizeof (dw));
743 /** Writes 64 bits in network byte order */
744 static inline void SetQWBE (void *p, uint64_t qw)
747 memcpy (p, &qw, sizeof (qw));
750 /** Writes 16 bits in little endian order */
751 static inline void SetWLE (void *p, uint16_t w)
753 #ifdef WORDS_BIGENDIAN
756 memcpy (p, &w, sizeof (w));
759 /** Writes 32 bits in little endian order */
760 static inline void SetDWLE (void *p, uint32_t dw)
762 #ifdef WORDS_BIGENDIAN
765 memcpy (p, &dw, sizeof (dw));
768 /** Writes 64 bits in little endian order */
769 static inline void SetQWLE (void *p, uint64_t qw)
771 #ifdef WORDS_BIGENDIAN
774 memcpy (p, &qw, sizeof (qw));
778 #define VLC_UNUSED(x) (void)(x)
780 /* Stuff defined in src/extras/libc.c */
783 /* several type definitions */
784 # if defined( __MINGW32__ )
785 # if !defined( _OFF_T_ )
786 typedef long long _off_t;
787 typedef _off_t off_t;
793 # define off_t long long
798 # define O_NONBLOCK 0
804 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
806 /* Aligned memory allocator */
808 #include <AvailabilityMacros.h>
812 # define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
813 # define vlc_free(base) (__mingw_aligned_free(base))
814 #elif defined(_MSC_VER)
815 # define vlc_memalign(align, size) (_aligned_malloc(size, align))
816 # define vlc_free(base) (_aligned_free(base))
817 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
818 static inline void *vlc_memalign(size_t align, size_t size)
823 ptr = malloc(size+align);
826 diff = ((-(long)ptr - 1)&(align-1)) + 1;
827 ptr = (char*)ptr + diff;
828 ((char*)ptr)[-1]= diff;
832 static void vlc_free(void *ptr)
835 free((char*)ptr - ((char*)ptr)[-1]);
838 static inline void *vlc_memalign(size_t align, size_t size)
841 if (unlikely(posix_memalign(&base, align, size)))
845 # define vlc_free(base) free(base)
848 VLC_API void vlc_tdestroy( void *, void (*)(void *) );
850 /*****************************************************************************
852 *****************************************************************************/
853 VLC_API char *vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
854 VLC_API char *vlc_ngettext( const char *s, const char *p, unsigned long n ) VLC_FORMAT_ARG(1) VLC_FORMAT_ARG(2);
856 #define vlc_pgettext( ctx, id ) \
857 vlc_pgettext_aux( ctx "\004" id, id )
860 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
862 const char *tr = vlc_gettext( ctx );
863 return (tr == ctx) ? id : tr;
866 /*****************************************************************************
867 * Loosy memory allocation functions. Do not use in new code.
868 *****************************************************************************/
869 static inline void *xmalloc (size_t len)
871 void *ptr = malloc (len);
872 if (unlikely (ptr == NULL))
877 static inline void *xrealloc (void *ptr, size_t len)
879 void *nptr = realloc (ptr, len);
880 if (unlikely (nptr == NULL))
885 static inline void *xcalloc (size_t n, size_t size)
887 void *ptr = calloc (n, size);
888 if (unlikely (ptr == NULL))
893 static inline char *xstrdup (const char *str)
895 char *ptr = strdup (str);
896 if (unlikely(ptr == NULL))
901 /*****************************************************************************
903 *****************************************************************************/
904 VLC_API const char * VLC_CompileBy( void ) VLC_USED;
905 VLC_API const char * VLC_CompileHost( void ) VLC_USED;
906 VLC_API const char * VLC_Compiler( void ) VLC_USED;
908 /*****************************************************************************
909 * Additional vlc stuff
910 *****************************************************************************/
911 #include "vlc_messages.h"
912 #include "vlc_objects.h"
913 #include "vlc_variables.h"
914 #include "vlc_main.h"
915 #include "vlc_configuration.h"
917 #if defined( _WIN32 ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
918 # define DIR_SEP_CHAR '\\'
919 # define DIR_SEP "\\"
920 # define PATH_SEP_CHAR ';'
921 # define PATH_SEP ";"
923 # define DIR_SEP_CHAR '/'
925 # define PATH_SEP_CHAR ':'
926 # define PATH_SEP ":"
929 #define LICENSE_MSG \
930 _("This program comes with NO WARRANTY, to the extent permitted by " \
931 "law.\nYou may redistribute it under the terms of the GNU General " \
932 "Public License;\nsee the file named COPYING for details.\n" \
933 "Written by the VideoLAN team; see the AUTHORS file.\n")
935 #endif /* !VLC_COMMON_H */