]> git.sesse.net Git - vlc/blobdiff - include/vlc_arrays.h
jvlc: wait for correct player status before releasing libvlc
[vlc] / include / vlc_arrays.h
index 676322a5e9a7d44863c8cb421f552eff078f6d63..7ac9290e3183ddf36ce366705a8ca9b7c8f102a0 100644 (file)
@@ -2,7 +2,7 @@
  * vlc_arrays.h : Arrays and data structures handling
  *****************************************************************************
  * Copyright (C) 1999-2004 the VideoLAN team
- * $Id: vlc_playlist.h 17108 2006-10-15 15:28:34Z zorglub $
+ * $Id$
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *          ClĂ©ment Stenac <zorglub@videolan.org>
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/
 
-#if !defined( __LIBVLC__ )
-  #error You are not libvlc or one of its plugins. You cannot include this file
-#endif
-
 #ifndef _VLC_ARRAYS_H_
 #define _VLC_ARRAYS_H_
 
-#include <assert.h>
-
 /**
  * Simple dynamic array handling. Array is realloced at each insert/removal
  */
@@ -83,7 +77,7 @@
 
 #define TAB_CLEAN( count, tab )                 \
   do {                                          \
-    if( tab ) free( tab );                      \
+    free( tab );                                \
     (count)= 0;                                 \
     (tab)= NULL;                                \
   } while(0)
         }                                       \
   } while(0)
 
+
 #define TAB_REMOVE( count, tab, p )             \
   do {                                          \
         int _i_index_;                          \
     } \
  } while(0)
 
-/************************************************************************
- * Dictionaries
- ************************************************************************/
-
-#ifdef __cplusplus__
-extern "C"
-{
-#endif
-/* This function is not intended to be crypto-secure, we only want it to be
- * fast and not suck too much. This one is pretty fast and did 0 collisions
- * in wenglish's dictionary.
- */
-static inline uint64_t DictHash( const char *psz_string )
-{
-    uint64_t i_hash = 0;
-    if( psz_string )
-    {
-        while( *psz_string )
-        {
-            i_hash += *psz_string++;
-            i_hash += i_hash << 10;
-            i_hash ^= i_hash >> 8;
-        }
-    }
-    return i_hash;
-}
 
-typedef struct vlc_dictionary_t
-{
-    struct vlc_dictionary_entries_t
-    {
-        char *   psz_key;
-        uint64_t i_hash;
-        void *   p_value;
-    } * p_entries;
-    int i_entries;
-} vlc_dictionary_t;
-
-static void * const kVLCDictionaryNotFound = (void *)-1;
-
-static inline void vlc_dictionary_init( vlc_dictionary_t * p_dict )
-{
-    p_dict->i_entries = 0;
-    p_dict->p_entries = NULL;
-}
-
-static inline void vlc_dictionary_clear( vlc_dictionary_t * p_dict )
-{
-    int i;
-    for ( i = 0; i < p_dict->i_entries; i++ )
-    {
-        free( p_dict->p_entries[i].psz_key );
-    }
-    free( p_dict->p_entries );
-    p_dict->i_entries = 0;
-    p_dict->p_entries = NULL;
-}
-
-
-static inline void *
-vlc_dictionary_value_for_key( vlc_dictionary_t * p_dict, const char * psz_key )
-{
-    uint64_t i_hash;
-    int i, i_pos;
-    
-    if( p_dict->i_entries == 0 )
-        return kVLCDictionaryNotFound;
-
-    i_hash = DictHash( psz_key );
-    BSEARCH( p_dict->p_entries, p_dict->i_entries, .i_hash, uint64_t,
-             i_hash, i_pos );
-    if( i_pos == -1 )
-        return kVLCDictionaryNotFound;
-
-    /* Hash found, let's check it looks like the entry */
-    if( !strcmp( psz_key, p_dict->p_entries[i_pos].psz_key ) )
-        return p_dict->p_entries[i_pos].p_value;
-
-    /* Hash collision! This should be very rare, but we cannot guarantee
-     * it will never happen. Just do an exhaustive search amongst all
-     * entries with the same hash. */
-    for( i = i_pos - 1 ; i > 0 && i_hash == p_dict->p_entries[i].i_hash ; i-- )
-    {
-        if( !strcmp( psz_key, p_dict->p_entries[i].psz_key ) )
-            return p_dict->p_entries[i_pos].p_value;
-    }
-    for( i = i_pos + 1 ; i < p_dict->i_entries &&
-                         i_hash == p_dict->p_entries[i].i_hash ; i++ )
-    {
-         if( !strcmp( psz_key, p_dict->p_entries[i].psz_key ))
-            return p_dict->p_entries[i_pos].p_value;
-    }
-    /* Hash found, but entry not found (shouldn't happen!) */
-    return kVLCDictionaryNotFound;
-}
-
-static inline void
-vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key, void * p_value )
-{
-    uint64_t i_hash = DictHash( psz_key );
-    int i_new;
-
-    /* First, caller should take care not to insert twice the same key */
-    /* This could be removed for optimization */
-    assert( vlc_dictionary_value_for_key( p_dict, psz_key ) == kVLCDictionaryNotFound );
-
-    /* Find a free slot */
-    if( p_dict->i_entries == 0 || i_hash <= p_dict->p_entries[0].i_hash )
-        i_new = 0;
-    else if( i_hash >= p_dict->p_entries[p_dict->i_entries-1].i_hash )
-        i_new = p_dict->i_entries;
-    else
-    {
-        int i_low = 0, i_high = p_dict->i_entries - 1;
-        while( i_high - i_low > 1 )
-        {
-            int i_mid = (i_low + i_high)/2;
-            if( p_dict->p_entries[i_mid].i_hash < i_hash ) {
-                i_low = i_mid;
-            } else if( p_dict->p_entries[i_mid].i_hash > i_hash ) {
-                i_high = i_mid;
-            }
-        }
-        if( p_dict->p_entries[i_low].i_hash < i_hash )
-            i_new = i_high;
-        else
-            i_new = i_low;
-    }
-    p_dict->p_entries = realloc( p_dict->p_entries, (p_dict->i_entries + 1) *
-        sizeof(struct vlc_dictionary_entries_t) );
-    p_dict->i_entries++;
-    if( i_new != p_dict->i_entries -1 )
-    {
-        memmove( &p_dict->p_entries[i_new+1], &p_dict->p_entries[i_new],
-         ( p_dict->i_entries - i_new - 1 ) *
-         sizeof(struct vlc_dictionary_entries_t) );
-    }
-
-    p_dict->p_entries[i_new].i_hash  = i_hash;
-    p_dict->p_entries[i_new].psz_key = strdup( psz_key );
-    p_dict->p_entries[i_new].p_value = p_value;
-}
-#ifdef __cplusplus__
-} /* extern "C" */
-#endif
 /************************************************************************
  * Dynamic arrays with progressive allocation
  ************************************************************************/
@@ -335,7 +186,6 @@ vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key, void * p
     array.i_alloc = newsize;                                                \
     array.p_elems = VLCCVP realloc( array.p_elems, array.i_alloc *          \
                                     sizeof(*array.p_elems) );               \
-    assert(array.p_elems);                                                  \
 }
 
 #define _ARRAY_GROW1(array) {                                               \
@@ -363,6 +213,7 @@ vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key, void * p
     }                                                                       \
 }
 
+#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 
 /* API */
 #define DECL_ARRAY(type) struct {                                           \
@@ -422,4 +273,316 @@ vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key, void * p
 
 #define FOREACH_END() } }
 
+
+/************************************************************************
+ * Dynamic arrays with progressive allocation (Preferred API)
+ ************************************************************************/
+typedef struct vlc_array_t
+{
+    int i_count;
+    void ** pp_elems;
+} vlc_array_t;
+
+static inline void vlc_array_init( vlc_array_t * p_array )
+{
+    memset( p_array, 0, sizeof(vlc_array_t) );
+}
+
+static inline void vlc_array_clear( vlc_array_t * p_array )
+{
+    free( p_array->pp_elems );
+    memset( p_array, 0, sizeof(vlc_array_t) );
+}
+
+static inline vlc_array_t * vlc_array_new( void )
+{
+    vlc_array_t * ret = (vlc_array_t *)malloc( sizeof(vlc_array_t) );
+    if( ret ) vlc_array_init( ret );
+    return ret;
+}
+
+static inline void vlc_array_destroy( vlc_array_t * p_array )
+{
+    if( !p_array )
+        return;
+    vlc_array_clear( p_array );
+    free( p_array );
+}
+
+
+/* Read */
+static inline int
+vlc_array_count( vlc_array_t * p_array )
+{
+    return p_array->i_count;
+}
+
+static inline void *
+vlc_array_item_at_index( vlc_array_t * p_array, int i_index )
+{
+    return p_array->pp_elems[i_index];
+}
+
+static inline int
+vlc_array_index_of_item( vlc_array_t * p_array, void * item )
+{
+    int i;
+    for( i = 0; i < p_array->i_count; i++)
+    {
+        if( p_array->pp_elems[i] == item )
+            return i;
+    }
+    return -1;
+}
+
+/* Write */
+static inline void
+vlc_array_insert( vlc_array_t * p_array, void * p_elem, int i_index )
+{
+    TAB_INSERT_CAST( (void **), p_array->i_count, p_array->pp_elems, p_elem, i_index );
+}
+
+static inline void
+vlc_array_append( vlc_array_t * p_array, void * p_elem )
+{
+    vlc_array_insert( p_array, p_elem, p_array->i_count );
+}
+
+static inline void
+vlc_array_remove( vlc_array_t * p_array, int i_index )
+{
+    if( i_index >= 0 )
+    {
+        if( p_array->i_count > 1 )
+        {
+            memmove( p_array->pp_elems + i_index,
+                     p_array->pp_elems + i_index+1,
+                     ( p_array->i_count - i_index - 1 ) * sizeof( void* ) );
+        }
+        p_array->i_count--;
+        if( p_array->i_count == 0 )
+        {
+            free( p_array->pp_elems );
+            p_array->pp_elems = NULL;
+        }
+    }
+}
+
+
+/************************************************************************
+ * Dictionaries
+ ************************************************************************/
+
+/* This function is not intended to be crypto-secure, we only want it to be
+ * fast and not suck too much. This one is pretty fast and did 0 collisions
+ * in wenglish's dictionary.
+ */
+static inline uint64_t DictHash( const char *psz_string, int hashsize )
+{
+    uint64_t i_hash = 0;
+    if( psz_string )
+    {
+        while( *psz_string )
+        {
+            i_hash += *psz_string++;
+            i_hash += i_hash << 10;
+            i_hash ^= i_hash >> 8;
+        }
+    }
+    return i_hash % hashsize;
+}
+
+struct vlc_dictionary_entry_t
+{
+    char *   psz_key;
+    void *   p_value;
+    struct vlc_dictionary_entry_t * p_next;
+};
+
+typedef struct vlc_dictionary_t
+{
+    int i_size;
+    struct vlc_dictionary_entry_t ** p_entries;
+} vlc_dictionary_t;
+
+static void * const kVLCDictionaryNotFound = NULL;
+
+static inline void vlc_dictionary_init( vlc_dictionary_t * p_dict, int i_size )
+{
+    if( i_size > 0 )
+    {
+        p_dict->p_entries = (struct vlc_dictionary_entry_t **)malloc(sizeof(struct vlc_dictionary_entry_t *) * i_size);
+        memset( p_dict->p_entries, 0, sizeof(struct vlc_dictionary_entry_t *) * i_size );
+    }
+    else
+        p_dict->p_entries = NULL;
+    p_dict->i_size = i_size;
+}
+
+static inline void vlc_dictionary_clear( vlc_dictionary_t * p_dict )
+{
+    int i;
+    struct vlc_dictionary_entry_t * p_current, * p_next;
+    if( p_dict->p_entries )
+    {
+        for( i = 0; i < p_dict->i_size; i++ )
+        {
+            p_current = p_dict->p_entries[i];
+            while( p_current )
+            {
+                p_next = p_current->p_next;
+                free( p_current->psz_key );
+                free( p_current );
+                p_current = p_next;
+            }
+        }
+        free( p_dict->p_entries );
+    }
+    p_dict->i_size = 0;
+}
+
+
+
+static inline void *
+vlc_dictionary_value_for_key( const vlc_dictionary_t * p_dict, const char * psz_key )
+{
+    if( !p_dict->p_entries )
+        return kVLCDictionaryNotFound;
+
+    int i_pos = DictHash( psz_key, p_dict->i_size );
+    struct vlc_dictionary_entry_t * p_entry = p_dict->p_entries[i_pos];
+
+    if( !p_entry )
+        return kVLCDictionaryNotFound;
+
+    /* Make sure we return the right item. (Hash collision) */
+    do {
+        if( !strcmp( psz_key, p_entry->psz_key ) )
+            return p_entry->p_value;
+        p_entry = p_entry->p_next;
+    } while( p_entry );
+
+    return kVLCDictionaryNotFound;
+}
+
+static inline int
+vlc_dictionary_keys_count( const vlc_dictionary_t * p_dict )
+{
+    struct vlc_dictionary_entry_t * p_entry;
+    int i, count = 0;
+
+    if( !p_dict->p_entries )
+        return 0;
+
+    for( i = 0; i < p_dict->i_size; i++ )
+    {
+        for( p_entry = p_dict->p_entries[i]; p_entry; p_entry = p_entry->p_next ) count++;
+    }
+    return count;
+}
+
+static inline char **
+vlc_dictionary_all_keys( const vlc_dictionary_t * p_dict )
+{
+    struct vlc_dictionary_entry_t * p_entry;
+    char ** ppsz_ret;
+    int i, count = vlc_dictionary_keys_count( p_dict );
+
+    ppsz_ret = (char**)malloc(sizeof(char *) * (count + 1));
+
+    count = 0;
+    for( i = 0; i < p_dict->i_size; i++ )
+    {
+        for( p_entry = p_dict->p_entries[i]; p_entry; p_entry = p_entry->p_next )
+            ppsz_ret[count++] = strdup( p_entry->psz_key );
+    }
+    ppsz_ret[count] = NULL;
+    return ppsz_ret;
+}
+
+static inline void
+__vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key,
+                         void * p_value, bool rebuild )
+{
+    if( !p_dict->p_entries )
+        vlc_dictionary_init( p_dict, 1 );
+
+    int i_pos = DictHash( psz_key, p_dict->i_size );
+    struct vlc_dictionary_entry_t * p_entry;
+
+    p_entry = (struct vlc_dictionary_entry_t *)malloc(sizeof(struct vlc_dictionary_entry_t));
+    p_entry->psz_key = strdup( psz_key );
+    p_entry->p_value = p_value;
+    p_entry->p_next = p_dict->p_entries[i_pos];
+    p_dict->p_entries[i_pos] = p_entry;
+    if( rebuild )
+    {
+        /* Count how many items there was */
+        int count;
+        for( count = 1; p_entry->p_next; count++ ) p_entry = p_entry->p_next;
+        if( count > 3 ) /* XXX: this need tuning */
+        {
+            /* Here it starts to be not good, rebuild a bigger dictionary */
+            struct vlc_dictionary_t new_dict;
+            int i_new_size = ( (p_dict->i_size+2) * 3) / 2; /* XXX: this need tuning */
+            int i;
+            vlc_dictionary_init( &new_dict, i_new_size );
+            for( i = 0; i < p_dict->i_size; i++ )
+            {
+                p_entry = p_dict->p_entries[i];
+                while( p_entry )
+                {
+                    __vlc_dictionary_insert( &new_dict, p_entry->psz_key,
+                                             p_entry->p_value,
+                                             0 /* To avoid multiple rebuild loop */);
+                    p_entry = p_entry->p_next;
+                }
+            }
+
+            vlc_dictionary_clear( p_dict );
+            p_dict->i_size = new_dict.i_size;
+            p_dict->p_entries = new_dict.p_entries;
+        }
+    }
+}
+
+static inline void
+vlc_dictionary_insert( vlc_dictionary_t * p_dict, const char * psz_key, void * p_value )
+{
+    __vlc_dictionary_insert( p_dict, psz_key, p_value, 1 );
+}
+
+static inline void
+vlc_dictionary_remove_value_for_key( const vlc_dictionary_t * p_dict, const char * psz_key )
+{
+    if( !p_dict->p_entries )
+        return;
+
+    int i_pos = DictHash( psz_key, p_dict->i_size );
+    struct vlc_dictionary_entry_t * p_entry = p_dict->p_entries[i_pos];
+    struct vlc_dictionary_entry_t * p_prev;
+
+    if( !p_entry )
+        return; /* Not found, nothing to do */
+
+    /* Hash collision */
+    p_prev = NULL;
+    do {
+        if( !strcmp( psz_key, p_entry->psz_key ) )
+        {
+            if( !p_prev )
+                p_dict->p_entries[i_pos] = p_entry->p_next;
+            else
+                p_prev->p_next = p_entry->p_next;
+            free( p_entry->psz_key );
+            free( p_entry );
+            return;
+        }
+        p_prev = p_entry;
+        p_entry = p_entry->p_next;
+    } while( p_entry );
+
+    /* No key was found */
+}
+
 #endif