1 /*****************************************************************************
2 * objects.c: vlc_object_t handling
3 *****************************************************************************
4 * Copyright (C) 2004 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
26 * This file contains the functions to handle the vlc_object_t type
30 /*****************************************************************************
32 *****************************************************************************/
36 # include <stdlib.h> /* realloc() */
39 #include "../libvlc.h"
42 #include "audio_output/aout_internal.h"
44 #include <vlc_access.h>
45 #include <vlc_demux.h>
46 #include <vlc_stream.h>
49 #include "stream_output/stream_output.h"
51 #include "vlc_playlist.h"
52 #include "vlc_interface.h"
53 #include "vlc_codec.h"
54 #include "vlc_filter.h"
56 #include "vlc_httpd.h"
58 #include "input/vlm_internal.h"
65 #include "variables.h"
67 /*****************************************************************************
69 *****************************************************************************/
70 static int DumpCommand( vlc_object_t *, char const *,
71 vlc_value_t, vlc_value_t, void * );
73 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
74 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
75 static void DetachObject ( vlc_object_t * );
76 static void PrintObject ( vlc_object_t *, const char * );
77 static void DumpStructure ( vlc_object_t *, int, char * );
78 static int FindIndex ( vlc_object_t *, vlc_object_t **, int );
79 static void SetAttachment ( vlc_object_t *, vlc_bool_t );
81 static vlc_list_t * NewList ( int );
82 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
83 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
84 static int CountChildren ( vlc_object_t *, int );
85 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
87 /*****************************************************************************
88 * Local structure lock
89 *****************************************************************************/
90 static vlc_mutex_t structure_lock;
92 vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
93 int i_type, const char *psz_type )
95 vlc_object_t * p_new = NULL;
97 if( i_type == VLC_OBJECT_GLOBAL )
103 p_new = malloc( i_size );
104 if( !p_new ) return NULL;
105 memset( p_new, 0, i_size );
108 p_new->i_object_type = i_type;
109 p_new->psz_object_type = psz_type;
111 p_new->psz_object_name = NULL;
113 p_new->b_die = VLC_FALSE;
114 p_new->b_error = VLC_FALSE;
115 p_new->b_dead = VLC_FALSE;
116 p_new->b_attached = VLC_FALSE;
117 p_new->b_force = VLC_FALSE;
119 p_new->psz_header = NULL;
122 if( p_this->i_flags & OBJECT_FLAGS_NODBG )
123 p_new->i_flags |= OBJECT_FLAGS_NODBG;
124 if( p_this->i_flags & OBJECT_FLAGS_QUIET )
125 p_new->i_flags |= OBJECT_FLAGS_QUIET;
126 if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
127 p_new->i_flags |= OBJECT_FLAGS_NOINTERACT;
130 p_new->p_vars = (variable_t *)malloc( 16 * sizeof( variable_t ) );
134 if( i_type != VLC_OBJECT_GLOBAL )
139 if( i_type == VLC_OBJECT_GLOBAL )
141 /* If i_type is global, then p_new is actually p_libvlc_global */
142 p_new->p_libvlc_global = (libvlc_global_data_t*)p_new;
143 p_new->p_libvlc = NULL;
145 p_new->p_libvlc_global->i_counter = 0;
146 p_new->i_object_id = 0;
148 p_new->p_libvlc_global->i_objects = 1;
149 p_new->p_libvlc_global->pp_objects = malloc( sizeof(vlc_object_t *) );
150 p_new->p_libvlc_global->pp_objects[0] = p_new;
151 p_new->b_attached = VLC_TRUE;
155 p_new->p_libvlc_global = p_this->p_libvlc_global;
156 p_new->p_libvlc = ( i_type == VLC_OBJECT_LIBVLC ) ? (libvlc_int_t*)p_new
159 vlc_mutex_lock( &structure_lock );
161 p_new->p_libvlc_global->i_counter++;
162 p_new->i_object_id = p_new->p_libvlc_global->i_counter;
164 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
165 * useless to try and recover anything if pp_objects gets smashed. */
166 TAB_APPEND( p_new->p_libvlc_global->i_objects,
167 p_new->p_libvlc_global->pp_objects,
170 vlc_mutex_unlock( &structure_lock );
173 p_new->i_refcount = 0;
174 p_new->p_parent = NULL;
175 p_new->pp_children = NULL;
176 p_new->i_children = 0;
178 p_new->p_private = NULL;
180 /* Initialize mutexes and condvars */
181 vlc_mutex_init( p_new, &p_new->object_lock );
182 vlc_cond_init( p_new, &p_new->object_wait );
183 vlc_mutex_init( p_new, &p_new->var_lock );
185 if( i_type == VLC_OBJECT_GLOBAL )
187 vlc_mutex_init( p_new, &structure_lock );
189 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
190 var_AddCallback( p_new, "list", DumpCommand, NULL );
191 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
192 var_AddCallback( p_new, "tree", DumpCommand, NULL );
193 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
194 var_AddCallback( p_new, "vars", DumpCommand, NULL );
202 * Allocates and initializes a vlc object.
204 * @param i_type known object type (all of them are negative integer values),
205 * or object byte size (always positive).
207 * @return the new object, or NULL on error.
209 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
211 const char * psz_type;
216 case VLC_OBJECT_GLOBAL:
217 i_size = sizeof(libvlc_global_data_t);
220 case VLC_OBJECT_LIBVLC:
221 i_size = sizeof(libvlc_int_t);
224 case VLC_OBJECT_MODULE:
225 i_size = sizeof(module_t);
228 case VLC_OBJECT_INTF:
229 i_size = sizeof(intf_thread_t);
230 psz_type = "interface";
232 case VLC_OBJECT_DIALOGS:
233 i_size = sizeof(intf_thread_t);
234 psz_type = "dialogs";
236 case VLC_OBJECT_PLAYLIST:
237 i_size = sizeof(playlist_t);
238 psz_type = "playlist";
241 i_size = sizeof(services_discovery_t);
242 psz_type = "services discovery";
244 case VLC_OBJECT_INPUT:
245 i_size = sizeof(input_thread_t);
248 case VLC_OBJECT_DEMUX:
249 i_size = sizeof(demux_t);
252 case VLC_OBJECT_STREAM:
253 i_size = sizeof(stream_t);
256 case VLC_OBJECT_ACCESS:
257 i_size = sizeof(access_t);
260 case VLC_OBJECT_DECODER:
261 i_size = sizeof(decoder_t);
262 psz_type = "decoder";
264 case VLC_OBJECT_PACKETIZER:
265 i_size = sizeof(decoder_t);
266 psz_type = "packetizer";
268 case VLC_OBJECT_ENCODER:
269 i_size = sizeof(encoder_t);
270 psz_type = "encoder";
272 case VLC_OBJECT_FILTER:
273 i_size = sizeof(filter_t);
276 case VLC_OBJECT_VOUT:
277 i_size = sizeof(vout_thread_t);
278 psz_type = "video output";
281 i_size = sizeof(spu_t);
282 psz_type = "subpicture";
284 case VLC_OBJECT_AOUT:
285 i_size = sizeof(aout_instance_t);
286 psz_type = "audio output";
288 case VLC_OBJECT_SOUT:
289 i_size = sizeof(sout_instance_t);
290 psz_type = "stream output";
293 i_size = sizeof( vlm_t );
294 psz_type = "vlm dameon";
297 i_size = sizeof( vod_t );
298 psz_type = "vod server";
301 i_size = sizeof( tls_t );
305 i_size = sizeof( xml_t );
308 case VLC_OBJECT_OPENGL:
309 i_size = sizeof( vout_thread_t );
312 case VLC_OBJECT_ANNOUNCE:
313 i_size = sizeof( announce_handler_t );
314 psz_type = "announce";
316 case VLC_OBJECT_META_ENGINE:
317 i_size = sizeof( meta_engine_t );
318 psz_type = "meta engine";
320 case VLC_OBJECT_OSDMENU:
321 i_size = sizeof( osd_menu_t );
322 psz_type = "osd menu";
325 i_size = i_type > (int)sizeof(vlc_object_t)
326 ? i_type : (int)sizeof(vlc_object_t);
327 i_type = VLC_OBJECT_GENERIC;
328 psz_type = "generic";
332 return vlc_custom_create( p_this, i_size, i_type, psz_type );
337 ****************************************************************************
338 * Destroy a vlc object
340 * This function destroys an object that has been previously allocated with
341 * vlc_object_create. The object's refcount must be zero and it must not be
342 * attached to other objects in any way.
343 *****************************************************************************/
344 void __vlc_object_destroy( vlc_object_t *p_this )
348 if( p_this->i_children )
350 msg_Err( p_this, "cannot delete object (%i, %s) with children" ,
351 p_this->i_object_id, p_this->psz_object_name );
355 if( p_this->p_parent )
357 msg_Err( p_this, "cannot delete object (%i, %s) with a parent",
358 p_this->i_object_id, p_this->psz_object_name );
362 while( p_this->i_refcount )
366 /* Don't warn immediately ... 100ms seems OK */
370 "refcount is %i, delaying before deletion (id=%d,type=%d)",
371 p_this->i_refcount, p_this->i_object_id,
372 p_this->i_object_type );
374 else if( i_delay == 10 )
377 "refcount is %i, delaying again (id=%d,type=%d)",
378 p_this->i_refcount, p_this->i_object_id,
379 p_this->i_object_type );
381 else if( i_delay == 20 )
384 "waited too long, cancelling destruction (id=%d,type=%d)",
385 p_this->i_object_id, p_this->i_object_type );
392 /* Destroy the associated variables, starting from the end so that
393 * no memmove calls have to be done. */
394 while( p_this->i_vars )
396 var_Destroy( p_this, p_this->p_vars[p_this->i_vars - 1].psz_name );
399 free( p_this->p_vars );
400 vlc_mutex_destroy( &p_this->var_lock );
402 if( p_this->psz_header ) free( p_this->psz_header );
404 if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
406 /* We are the global object ... no need to lock. */
407 free( p_this->p_libvlc_global->pp_objects );
408 p_this->p_libvlc_global->pp_objects = NULL;
409 p_this->p_libvlc_global->i_objects--;
411 vlc_mutex_destroy( &structure_lock );
417 vlc_mutex_lock( &structure_lock );
419 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
420 * useless to try and recover anything if pp_objects gets smashed. */
421 i_index = FindIndex( p_this, p_this->p_libvlc_global->pp_objects,
422 p_this->p_libvlc_global->i_objects );
423 REMOVE_ELEM( p_this->p_libvlc_global->pp_objects,
424 p_this->p_libvlc_global->i_objects, i_index );
426 vlc_mutex_unlock( &structure_lock );
429 vlc_mutex_destroy( &p_this->object_lock );
430 vlc_cond_destroy( &p_this->object_wait );
432 /* global is not dynamically allocated by vlc_object_create */
433 if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
441 void __vlc_object_kill( vlc_object_t *p_this )
443 vlc_mutex_lock( &p_this->object_lock );
444 p_this->b_die = VLC_TRUE;
445 vlc_mutex_unlock( &p_this->object_lock );
450 * find an object given its ID
452 * This function looks for the object whose i_object_id field is i_id. We
453 * use a dichotomy so that lookups are in log2(n).
454 *****************************************************************************/
455 void * __vlc_object_get( vlc_object_t *p_this, int i_id )
458 vlc_object_t **pp_objects;
460 vlc_mutex_lock( &structure_lock );
462 pp_objects = p_this->p_libvlc_global->pp_objects;
464 /* Perform our dichotomy */
465 for( i_max = p_this->p_libvlc_global->i_objects - 1 ; ; )
467 i_middle = i_max / 2;
469 if( pp_objects[i_middle]->i_object_id > i_id )
473 else if( pp_objects[i_middle]->i_object_id < i_id )
477 pp_objects += i_middle;
482 /* This happens when there are only two remaining objects */
483 if( pp_objects[i_middle+1]->i_object_id == i_id )
485 vlc_mutex_unlock( &structure_lock );
486 pp_objects[i_middle+1]->i_refcount++;
487 return pp_objects[i_middle+1];
494 vlc_mutex_unlock( &structure_lock );
495 pp_objects[i_middle]->i_refcount++;
496 return pp_objects[i_middle];
501 /* this means that i_max == i_middle, and since we have already
502 * tested pp_objects[i_middle]), p_found is properly set. */
507 vlc_mutex_unlock( &structure_lock );
512 ****************************************************************************
513 * find a typed object and increment its refcount
514 *****************************************************************************
515 * This function recursively looks for a given object type. i_mode can be one
516 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
517 *****************************************************************************/
518 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
520 vlc_object_t *p_found;
522 vlc_mutex_lock( &structure_lock );
524 /* If we are of the requested type ourselves, don't look further */
525 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
527 p_this->i_refcount++;
528 vlc_mutex_unlock( &structure_lock );
532 /* Otherwise, recursively look for the object */
533 if( (i_mode & 0x000f) == FIND_ANYWHERE )
535 vlc_object_t *p_root = p_this;
538 while( p_root->p_parent != NULL &&
539 p_root != VLC_OBJECT( p_this->p_libvlc ) )
541 p_root = p_root->p_parent;
544 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
545 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
547 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
548 i_type, (i_mode & ~0x000f)|FIND_CHILD );
553 p_found = FindObject( p_this, i_type, i_mode );
556 vlc_mutex_unlock( &structure_lock );
562 ****************************************************************************
563 * find a named object and increment its refcount
564 *****************************************************************************
565 * This function recursively looks for a given object name. i_mode can be one
566 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
567 *****************************************************************************/
568 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
571 vlc_object_t *p_found;
573 vlc_mutex_lock( &structure_lock );
575 /* If have the requested name ourselves, don't look further */
576 if( !(i_mode & FIND_STRICT)
577 && p_this->psz_object_name
578 && !strcmp( p_this->psz_object_name, psz_name ) )
580 p_this->i_refcount++;
581 vlc_mutex_unlock( &structure_lock );
585 /* Otherwise, recursively look for the object */
586 if( (i_mode & 0x000f) == FIND_ANYWHERE )
588 vlc_object_t *p_root = p_this;
591 while( p_root->p_parent != NULL &&
592 p_root != VLC_OBJECT( p_this->p_libvlc ) )
594 p_root = p_root->p_parent;
597 p_found = FindObjectName( p_root, psz_name,
598 (i_mode & ~0x000f)|FIND_CHILD );
599 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
601 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
602 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
607 p_found = FindObjectName( p_this, psz_name, i_mode );
610 vlc_mutex_unlock( &structure_lock );
616 ****************************************************************************
617 * increment an object refcount
618 *****************************************************************************/
619 void __vlc_object_yield( vlc_object_t *p_this )
621 vlc_mutex_lock( &structure_lock );
622 p_this->i_refcount++;
623 vlc_mutex_unlock( &structure_lock );
627 ****************************************************************************
628 * decrement an object refcount
629 *****************************************************************************/
630 void __vlc_object_release( vlc_object_t *p_this )
632 vlc_mutex_lock( &structure_lock );
633 p_this->i_refcount--;
634 vlc_mutex_unlock( &structure_lock );
638 ****************************************************************************
639 * attach object to a parent object
640 *****************************************************************************
641 * This function sets p_this as a child of p_parent, and p_parent as a parent
642 * of p_this. This link can be undone using vlc_object_detach.
643 *****************************************************************************/
644 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
646 if( !p_this ) return;
648 vlc_mutex_lock( &structure_lock );
650 /* Attach the parent to its child */
651 p_this->p_parent = p_parent;
653 /* Attach the child to its parent */
654 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
655 p_parent->i_children, p_this );
657 /* Climb up the tree to see whether we are connected with the root */
658 if( p_parent->b_attached )
660 SetAttachment( p_this, VLC_TRUE );
663 vlc_mutex_unlock( &structure_lock );
667 ****************************************************************************
668 * detach object from its parent
669 *****************************************************************************
670 * This function removes all links between an object and its parent.
671 *****************************************************************************/
672 void __vlc_object_detach( vlc_object_t *p_this )
674 if( !p_this ) return;
676 vlc_mutex_lock( &structure_lock );
677 if( !p_this->p_parent )
679 msg_Err( p_this, "object is not attached" );
680 vlc_mutex_unlock( &structure_lock );
684 /* Climb up the tree to see whether we are connected with the root */
685 if( p_this->p_parent->b_attached )
687 SetAttachment( p_this, VLC_FALSE );
690 DetachObject( p_this );
691 vlc_mutex_unlock( &structure_lock );
696 ****************************************************************************
697 * find a list typed objects and increment their refcount
698 *****************************************************************************
699 * This function recursively looks for a given object type. i_mode can be one
700 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
701 *****************************************************************************/
702 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
705 vlc_object_t **pp_current, **pp_end;
706 int i_count = 0, i_index = 0;
708 vlc_mutex_lock( &structure_lock );
710 /* Look for the objects */
711 switch( i_mode & 0x000f )
714 pp_current = p_this->p_libvlc_global->pp_objects;
715 pp_end = pp_current + p_this->p_libvlc_global->i_objects;
717 for( ; pp_current < pp_end ; pp_current++ )
719 if( (*pp_current)->b_attached
720 && (*pp_current)->i_object_type == i_type )
726 p_list = NewList( i_count );
727 pp_current = p_this->p_libvlc_global->pp_objects;
729 for( ; pp_current < pp_end ; pp_current++ )
731 if( (*pp_current)->b_attached
732 && (*pp_current)->i_object_type == i_type )
734 ListReplace( p_list, *pp_current, i_index );
735 if( i_index < i_count ) i_index++;
741 i_count = CountChildren( p_this, i_type );
742 p_list = NewList( i_count );
744 /* Check allocation was successful */
745 if( p_list->i_count != i_count )
747 msg_Err( p_this, "list allocation failed!" );
753 ListChildren( p_list, p_this, i_type );
757 msg_Err( p_this, "unimplemented!" );
758 p_list = NewList( 0 );
762 vlc_mutex_unlock( &structure_lock );
767 /*****************************************************************************
768 * DumpCommand: print the current vlc structure
769 *****************************************************************************
770 * This function prints either an ASCII tree showing the connections between
771 * vlc objects, and additional information such as their refcount, thread ID,
772 * etc. (command "tree"), or the same data as a simple list (command "list").
773 *****************************************************************************/
774 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
775 vlc_value_t oldval, vlc_value_t newval, void *p_data )
777 if( *psz_cmd == 'l' )
779 vlc_mutex_lock( &structure_lock );
781 vlc_object_t **pp_current, **pp_end;
783 pp_current = p_this->p_libvlc_global->pp_objects;
784 pp_end = pp_current + p_this->p_libvlc_global->i_objects;
786 for( ; pp_current < pp_end ; pp_current++ )
788 if( (*pp_current)->b_attached )
790 PrintObject( *pp_current, "" );
794 printf( " o %.8i %s (not attached)\n",
795 (*pp_current)->i_object_id,
796 (*pp_current)->psz_object_type );
800 vlc_mutex_unlock( &structure_lock );
804 vlc_object_t *p_object = NULL;
806 if( *newval.psz_string )
808 p_object = vlc_object_get( p_this, atoi(newval.psz_string) );
816 vlc_mutex_lock( &structure_lock );
818 if( *psz_cmd == 't' )
820 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
823 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
826 DumpStructure( p_object, 0, psz_foo );
828 else if( *psz_cmd == 'v' )
833 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
835 PrintObject( p_object, "" );
837 if( !p_object->i_vars )
838 printf( " `-o No variables\n" );
839 for( i = 0; i < p_object->i_vars; i++ )
841 variable_t *p_var = p_object->p_vars + i;
843 const char *psz_type = "unknown";
844 switch( p_var->i_type & VLC_VAR_TYPE )
846 #define MYCASE( type, nice ) \
847 case VLC_VAR_ ## type: \
850 MYCASE( VOID, "void" );
851 MYCASE( BOOL, "bool" );
852 MYCASE( INTEGER, "integer" );
853 MYCASE( HOTKEY, "hotkey" );
854 MYCASE( STRING, "string" );
855 MYCASE( MODULE, "module" );
856 MYCASE( FILE, "file" );
857 MYCASE( DIRECTORY, "directory" );
858 MYCASE( VARIABLE, "variable" );
859 MYCASE( FLOAT, "float" );
860 MYCASE( TIME, "time" );
861 MYCASE( ADDRESS, "address" );
862 MYCASE( MUTEX, "mutex" );
863 MYCASE( LIST, "list" );
866 printf( " %c-o \"%s\" (%s",
867 i + 1 == p_object->i_vars ? '`' : '|',
868 p_var->psz_name, psz_type );
869 if( p_var->psz_text )
870 printf( ", %s", p_var->psz_text );
872 if( p_var->i_type & VLC_VAR_ISCOMMAND )
873 printf( ", command" );
874 if( p_var->i_entries )
875 printf( ", %d callbacks", p_var->i_entries );
876 switch( p_var->i_type & 0x00f0 )
882 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
884 case VLC_VAR_INTEGER:
885 printf( ": %d", p_var->val.i_int );
888 printf( ": \"%s\"", p_var->val.psz_string );
891 printf( ": %f", p_var->val.f_float );
894 printf( ": " I64Fi, p_var->val.i_time );
896 case VLC_VAR_ADDRESS:
897 printf( ": %p", p_var->val.p_address );
907 vlc_mutex_unlock( &structure_lock );
909 if( *newval.psz_string )
911 vlc_object_release( p_object );
918 /*****************************************************************************
919 * vlc_list_release: free a list previously allocated by vlc_list_find
920 *****************************************************************************
921 * This function decreases the refcount of all objects in the list and
923 *****************************************************************************/
924 void vlc_list_release( vlc_list_t *p_list )
928 vlc_mutex_lock( &structure_lock );
929 for( i_index = 0; i_index < p_list->i_count; i_index++ )
931 p_list->p_values[i_index].p_object->i_refcount--;
933 vlc_mutex_unlock( &structure_lock );
935 free( p_list->p_values );
939 /* Following functions are local */
941 /*****************************************************************************
942 * FindIndex: find the index of an object in an array of objects
943 *****************************************************************************
944 * This function assumes that p_this can be found in pp_objects. It will not
945 * crash if p_this cannot be found, but will return a wrong value. It is your
946 * duty to check the return value if you are not certain that the object could
948 *****************************************************************************/
949 static int FindIndex( vlc_object_t *p_this,
950 vlc_object_t **pp_objects, int i_count )
952 int i_middle = i_count / 2;
959 if( pp_objects[i_middle] == p_this )
969 /* We take advantage of the sorted array */
970 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
972 return i_middle + FindIndex( p_this, pp_objects + i_middle,
973 i_count - i_middle );
977 return FindIndex( p_this, pp_objects, i_middle );
981 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
986 switch( i_mode & 0x000f )
989 p_tmp = p_this->p_parent;
992 if( p_tmp->i_object_type == i_type )
999 return FindObject( p_tmp, i_type, i_mode );
1005 for( i = p_this->i_children; i--; )
1007 p_tmp = p_this->pp_children[i];
1008 if( p_tmp->i_object_type == i_type )
1010 p_tmp->i_refcount++;
1013 else if( p_tmp->i_children )
1015 p_tmp = FindObject( p_tmp, i_type, i_mode );
1025 /* Handled in vlc_object_find */
1032 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1033 const char *psz_name,
1037 vlc_object_t *p_tmp;
1039 switch( i_mode & 0x000f )
1042 p_tmp = p_this->p_parent;
1045 if( p_tmp->psz_object_name
1046 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1048 p_tmp->i_refcount++;
1053 return FindObjectName( p_tmp, psz_name, i_mode );
1059 for( i = p_this->i_children; i--; )
1061 p_tmp = p_this->pp_children[i];
1062 if( p_tmp->psz_object_name
1063 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1065 p_tmp->i_refcount++;
1068 else if( p_tmp->i_children )
1070 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1080 /* Handled in vlc_object_find */
1087 static void DetachObject( vlc_object_t *p_this )
1089 vlc_object_t *p_parent = p_this->p_parent;
1092 /* Remove p_this's parent */
1093 p_this->p_parent = NULL;
1095 /* Remove all of p_parent's children which are p_this */
1096 for( i_index = p_parent->i_children ; i_index-- ; )
1098 if( p_parent->pp_children[i_index] == p_this )
1100 p_parent->i_children--;
1101 for( i = i_index ; i < p_parent->i_children ; i++ )
1103 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1108 if( p_parent->i_children )
1110 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1111 p_parent->i_children * sizeof(vlc_object_t *) );
1115 free( p_parent->pp_children );
1116 p_parent->pp_children = NULL;
1120 /*****************************************************************************
1121 * SetAttachment: recursively set the b_attached flag of a subtree.
1122 *****************************************************************************
1123 * This function is used by the attach and detach functions to propagate
1124 * the b_attached flag in a subtree.
1125 *****************************************************************************/
1126 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
1130 for( i_index = p_this->i_children ; i_index-- ; )
1132 SetAttachment( p_this->pp_children[i_index], b_attached );
1135 p_this->b_attached = b_attached;
1138 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1140 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1144 if( p_this->psz_object_name )
1146 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1148 psz_name[48] = '\"';
1151 psz_children[0] = '\0';
1152 switch( p_this->i_children )
1157 strcpy( psz_children, ", 1 child" );
1160 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1164 psz_refcount[0] = '\0';
1165 if( p_this->i_refcount )
1166 snprintf( psz_refcount, 19, ", refcount %i", p_this->i_refcount );
1168 psz_thread[0] = '\0';
1169 if( p_this->b_thread )
1170 snprintf( psz_thread, 29, " (thread %d)", (int)p_this->thread_id );
1172 psz_parent[0] = '\0';
1173 if( p_this->p_parent )
1174 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1176 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1177 p_this->i_object_id, p_this->psz_object_type,
1178 psz_name, psz_thread, psz_refcount, psz_children,
1182 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1185 char i_back = psz_foo[i_level];
1186 psz_foo[i_level] = '\0';
1188 PrintObject( p_this, psz_foo );
1190 psz_foo[i_level] = i_back;
1192 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1194 msg_Warn( p_this, "structure tree is too deep" );
1198 for( i = 0 ; i < p_this->i_children ; i++ )
1202 psz_foo[i_level-1] = ' ';
1204 if( psz_foo[i_level-2] == '`' )
1206 psz_foo[i_level-2] = ' ';
1210 if( i == p_this->i_children - 1 )
1212 psz_foo[i_level] = '`';
1216 psz_foo[i_level] = '|';
1219 psz_foo[i_level+1] = '-';
1220 psz_foo[i_level+2] = '\0';
1222 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1226 static vlc_list_t * NewList( int i_count )
1228 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1229 if( p_list == NULL )
1234 p_list->i_count = i_count;
1238 p_list->p_values = NULL;
1242 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1243 if( p_list->p_values == NULL )
1245 p_list->i_count = 0;
1252 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1255 if( p_list == NULL || i_index >= p_list->i_count )
1260 p_object->i_refcount++;
1262 p_list->p_values[i_index].p_object = p_object;
1267 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1269 if( p_list == NULL )
1274 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1275 * sizeof( vlc_value_t ) );
1276 if( p_list->p_values == NULL )
1278 p_list->i_count = 0;
1282 p_object->i_refcount++;
1284 p_list->p_values[p_list->i_count].p_object = p_object;
1290 static int CountChildren( vlc_object_t *p_this, int i_type )
1292 vlc_object_t *p_tmp;
1295 for( i = 0; i < p_this->i_children; i++ )
1297 p_tmp = p_this->pp_children[i];
1299 if( p_tmp->i_object_type == i_type )
1304 if( p_tmp->i_children )
1306 i_count += CountChildren( p_tmp, i_type );
1313 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1315 vlc_object_t *p_tmp;
1318 for( i = 0; i < p_this->i_children; i++ )
1320 p_tmp = p_this->pp_children[i];
1322 if( p_tmp->i_object_type == i_type )
1324 ListReplace( p_list, p_tmp, p_list->i_count++ );
1327 if( p_tmp->i_children )
1329 ListChildren( p_list, p_tmp, i_type );