1 /*****************************************************************************
2 * objects.c: vlc_object_t handling
3 *****************************************************************************
4 * Copyright (C) 2002 VideoLAN
5 * $Id: objects.c,v 1.22 2002/10/03 18:56:10 sam Exp $
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
30 # include <stdlib.h> /* realloc() */
33 #include "stream_control.h"
34 #include "input_ext-intf.h"
35 #include "input_ext-dec.h"
38 #include "video_output.h"
40 #include "audio_output.h"
41 #include "aout_internal.h"
43 #include "vlc_playlist.h"
44 #include "interface.h"
46 /*****************************************************************************
48 *****************************************************************************/
49 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
50 static void DetachObject ( vlc_object_t * );
51 static void PrintObject ( vlc_object_t *, const char * );
52 static void DumpStructure ( vlc_object_t *, int, char * );
53 static int FindIndex ( vlc_object_t *, vlc_object_t **, int );
54 static void SetAttachment ( vlc_object_t *, vlc_bool_t );
56 static vlc_list_t * NewList ( void );
57 static vlc_list_t * ListAppend ( vlc_list_t *, vlc_object_t * );
59 /*****************************************************************************
60 * vlc_object_create: initialize a vlc object
61 *****************************************************************************
62 * This function allocates memory for a vlc object and initializes it. If
63 * i_type is not a known value such as VLC_OBJECT_ROOT, VLC_OBJECT_VOUT and
64 * so on, vlc_object_create will use its value for the object size.
65 *****************************************************************************/
66 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
75 i_size = sizeof(libvlc_t);
79 i_size = sizeof(vlc_t);
82 case VLC_OBJECT_MODULE:
83 i_size = sizeof(module_t);
87 i_size = sizeof(intf_thread_t);
88 psz_type = "interface";
90 case VLC_OBJECT_PLAYLIST:
91 i_size = sizeof(playlist_t);
92 psz_type = "playlist";
94 case VLC_OBJECT_INPUT:
95 i_size = sizeof(input_thread_t);
98 case VLC_OBJECT_DECODER:
99 i_size = sizeof(decoder_fifo_t);
100 psz_type = "decoder";
102 case VLC_OBJECT_VOUT:
103 i_size = sizeof(vout_thread_t);
104 psz_type = "video output";
106 case VLC_OBJECT_AOUT:
107 i_size = sizeof(aout_instance_t);
108 psz_type = "audio output";
111 i_size = i_type > sizeof(vlc_object_t)
112 ? i_type : sizeof(vlc_object_t);
113 i_type = VLC_OBJECT_GENERIC;
114 psz_type = "generic";
118 if( i_type == VLC_OBJECT_ROOT )
124 p_new = malloc( i_size );
131 memset( p_new, 0, i_size );
134 p_new->i_object_type = i_type;
135 p_new->psz_object_type = psz_type;
137 p_new->psz_object_name = NULL;
139 p_new->i_refcount = 0;
140 p_new->b_die = VLC_FALSE;
141 p_new->b_error = VLC_FALSE;
142 p_new->b_dead = VLC_FALSE;
143 p_new->b_attached = VLC_FALSE;
145 /* If i_type is root, then p_new is our own p_libvlc */
146 if( i_type == VLC_OBJECT_ROOT )
148 /* We are the first object ... no need to lock. */
149 p_new->p_libvlc = (libvlc_t*)p_new;
152 p_new->p_libvlc->i_counter = 0;
153 p_new->i_object_id = 0;
155 p_new->p_libvlc->i_objects = 1;
156 p_new->p_libvlc->pp_objects = malloc( sizeof(vlc_object_t *) );
157 p_new->p_libvlc->pp_objects[0] = p_new;
158 p_new->b_attached = VLC_TRUE;
162 p_new->p_libvlc = p_this->p_libvlc;
163 p_new->p_vlc = ( i_type == VLC_OBJECT_VLC ) ? (vlc_t*)p_new
166 vlc_mutex_lock( &p_this->p_libvlc->structure_lock );
168 p_new->p_libvlc->i_counter++;
169 p_new->i_object_id = p_new->p_libvlc->i_counter;
171 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
172 * useless to try and recover anything if pp_objects gets smashed. */
173 p_new->p_libvlc->i_objects++;
174 p_new->p_libvlc->pp_objects =
175 realloc( p_new->p_libvlc->pp_objects,
176 p_new->p_libvlc->i_objects * sizeof(vlc_object_t *) );
177 p_new->p_libvlc->pp_objects[ p_new->p_libvlc->i_objects - 1 ] = p_new;
179 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
182 p_new->p_parent = NULL;
183 p_new->pp_children = NULL;
184 p_new->i_children = 0;
186 p_new->p_private = NULL;
188 vlc_mutex_init( p_new, &p_new->object_lock );
189 vlc_cond_init( p_new, &p_new->object_wait );
194 /*****************************************************************************
195 * vlc_object_destroy: destroy a vlc object
196 *****************************************************************************
197 * This function destroys an object that has been previously allocated with
198 * vlc_object_create. The object's refcount must be zero and it must not be
199 * attached to other objects in any way.
200 *****************************************************************************/
201 void __vlc_object_destroy( vlc_object_t *p_this )
205 if( p_this->i_children )
207 msg_Err( p_this, "cannot delete object with children" );
208 vlc_dumpstructure( p_this );
212 if( p_this->p_parent )
214 msg_Err( p_this, "cannot delete object with a parent" );
215 vlc_dumpstructure( p_this );
219 while( p_this->i_refcount )
223 /* Don't warn immediately ... 100ms seems OK */
226 msg_Warn( p_this, "refcount is %i, delaying before deletion",
227 p_this->i_refcount );
229 else if( i_delay == 12 )
231 msg_Err( p_this, "refcount is %i, I have a bad feeling about this",
232 p_this->i_refcount );
234 else if( i_delay == 42 )
236 msg_Err( p_this, "we waited too long, cancelling destruction" );
243 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
244 * useless to try and recover anything if pp_objects gets smashed. */
245 if( p_this->i_object_type != VLC_OBJECT_ROOT )
249 vlc_mutex_lock( &p_this->p_libvlc->structure_lock );
251 i_index = FindIndex( p_this, p_this->p_libvlc->pp_objects,
252 p_this->p_libvlc->i_objects );
253 memmove( p_this->p_libvlc->pp_objects + i_index,
254 p_this->p_libvlc->pp_objects + i_index + 1,
255 (p_this->p_libvlc->i_objects - i_index - 1)
256 * sizeof( vlc_object_t *) );
258 p_this->p_libvlc->pp_objects =
259 realloc( p_this->p_libvlc->pp_objects,
260 (p_this->p_libvlc->i_objects - 1) * sizeof(vlc_object_t *) );
262 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
266 /* We are the root object ... no need to lock. */
267 free( p_this->p_libvlc->pp_objects );
268 p_this->p_libvlc->pp_objects = NULL;
271 p_this->p_libvlc->i_objects--;
273 vlc_mutex_destroy( &p_this->object_lock );
274 vlc_cond_destroy( &p_this->object_wait );
279 /*****************************************************************************
280 * vlc_object_find: find a typed object and increment its refcount
281 *****************************************************************************
282 * This function recursively looks for a given object type. i_mode can be one
283 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
284 *****************************************************************************/
285 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
287 vlc_object_t *p_found;
289 vlc_mutex_lock( &p_this->p_libvlc->structure_lock );
291 /* If we are of the requested type ourselves, don't look further */
292 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
294 p_this->i_refcount++;
295 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
299 /* Otherwise, recursively look for the object */
300 if( (i_mode & 0x000f) == FIND_ANYWHERE )
302 p_found = FindObject( VLC_OBJECT(p_this->p_vlc), i_type,
303 (i_mode & ~0x000f) | FIND_CHILD );
307 p_found = FindObject( p_this, i_type, i_mode );
310 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
315 /*****************************************************************************
316 * vlc_object_yield: increment an object refcount
317 *****************************************************************************/
318 void __vlc_object_yield( vlc_object_t *p_this )
320 vlc_mutex_lock( &p_this->p_libvlc->structure_lock );
321 p_this->i_refcount++;
322 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
325 /*****************************************************************************
326 * vlc_object_release: decrement an object refcount
327 *****************************************************************************/
328 void __vlc_object_release( vlc_object_t *p_this )
330 vlc_mutex_lock( &p_this->p_libvlc->structure_lock );
331 p_this->i_refcount--;
332 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
335 /*****************************************************************************
336 * vlc_object_attach: attach object to a parent object
337 *****************************************************************************
338 * This function sets p_this as a child of p_parent, and p_parent as a parent
339 * of p_this. This link can be undone using vlc_object_detach.
340 *****************************************************************************/
341 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
343 vlc_mutex_lock( &p_this->p_libvlc->structure_lock );
345 /* Attach the parent to its child */
346 p_this->p_parent = p_parent;
348 /* Attach the child to its parent */
349 p_parent->i_children++;
350 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
351 p_parent->i_children * sizeof(vlc_object_t *) );
352 p_parent->pp_children[p_parent->i_children - 1] = p_this;
354 /* Climb up the tree to see whether we are connected with the root */
355 if( p_parent->b_attached )
357 SetAttachment( p_this, VLC_TRUE );
360 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
363 /*****************************************************************************
364 * vlc_object_detach: detach object from its parent
365 *****************************************************************************
366 * This function removes all links between an object and its parent.
367 *****************************************************************************/
368 void __vlc_object_detach( vlc_object_t *p_this )
370 vlc_mutex_lock( &p_this->p_libvlc->structure_lock );
371 if( !p_this->p_parent )
373 msg_Err( p_this, "object is not attached" );
374 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
378 /* Climb up the tree to see whether we are connected with the root */
379 if( p_this->p_parent->b_attached )
381 SetAttachment( p_this, VLC_FALSE );
384 DetachObject( p_this );
385 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
388 /*****************************************************************************
389 * vlc_list_find: find a list typed objects and increment their refcount
390 *****************************************************************************
391 * This function recursively looks for a given object type. i_mode can be one
392 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
393 *****************************************************************************/
394 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
396 vlc_list_t *p_list = NewList();
398 vlc_mutex_lock( &p_this->p_libvlc->structure_lock );
400 /* Look for the objects */
401 if( (i_mode & 0x000f) == FIND_ANYWHERE )
403 vlc_object_t **pp_current, **pp_end;
405 pp_current = p_this->p_libvlc->pp_objects;
406 pp_end = pp_current + p_this->p_libvlc->i_objects;
408 for( ; pp_current < pp_end ; pp_current++ )
410 if( (*pp_current)->b_attached
411 && (*pp_current)->i_object_type == i_type )
413 p_list = ListAppend( p_list, *pp_current );
419 msg_Err( p_this, "unimplemented!" );
422 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
427 /*****************************************************************************
428 * vlc_liststructure: print the current vlc objects
429 *****************************************************************************
430 * This function prints alist of vlc objects, and additional information such
431 * as their refcount, thread ID, etc.
432 *****************************************************************************/
433 void __vlc_liststructure( vlc_object_t *p_this )
435 vlc_object_t **pp_current, **pp_end;
437 vlc_mutex_lock( &p_this->p_libvlc->structure_lock );
439 pp_current = p_this->p_libvlc->pp_objects;
440 pp_end = pp_current + p_this->p_libvlc->i_objects;
442 for( ; pp_current < pp_end ; pp_current++ )
444 if( (*pp_current)->b_attached )
446 PrintObject( *pp_current, "" );
450 printf( " o %.6x %s (not attached)\n",
451 (*pp_current)->i_object_id,
452 (*pp_current)->psz_object_type );
456 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
459 /*****************************************************************************
460 * vlc_dumpstructure: print the current vlc structure
461 *****************************************************************************
462 * This function prints an ASCII tree showing the connections between vlc
463 * objects, and additional information such as their refcount, thread ID, etc.
464 *****************************************************************************/
465 void __vlc_dumpstructure( vlc_object_t *p_this )
467 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
469 vlc_mutex_lock( &p_this->p_libvlc->structure_lock );
471 DumpStructure( p_this, 0, psz_foo );
472 vlc_mutex_unlock( &p_this->p_libvlc->structure_lock );
475 /*****************************************************************************
476 * vlc_list_release: free a list previously allocated by vlc_list_find
477 *****************************************************************************
478 * This function decreases the refcount of all objects in the list and
480 *****************************************************************************/
481 void vlc_list_release( vlc_list_t *p_list )
483 if( p_list->i_count )
485 libvlc_t * p_libvlc = p_list->pp_objects[0]->p_libvlc;
486 vlc_object_t ** pp_current = p_list->pp_objects;
488 vlc_mutex_lock( &p_libvlc->structure_lock );
490 while( pp_current[0] )
492 pp_current[0]->i_refcount--;
496 vlc_mutex_unlock( &p_libvlc->structure_lock );
502 /* Following functions are local */
504 /*****************************************************************************
505 * FindIndex: find the index of an object in an array of objects
506 *****************************************************************************
507 * This function assumes that p_this can be found in pp_objects. It will not
508 * crash if p_this cannot be found, but will return a wrong value. It is your
509 * duty to check the return value if you are not certain that the object could
511 *****************************************************************************/
512 static int FindIndex( vlc_object_t *p_this,
513 vlc_object_t **pp_objects, int i_count )
515 int i_middle = i_count / 2;
522 if( pp_objects[i_middle] == p_this )
532 /* We take advantage of the sorted array */
533 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
535 return i_middle + FindIndex( p_this, pp_objects + i_middle,
536 i_count - i_middle );
540 return FindIndex( p_this, pp_objects, i_middle );
544 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
549 switch( i_mode & 0x000f )
552 p_tmp = p_this->p_parent;
555 if( p_tmp->i_object_type == i_type )
562 return FindObject( p_tmp, i_type, i_mode );
568 for( i = p_this->i_children; i--; )
570 p_tmp = p_this->pp_children[i];
571 if( p_tmp->i_object_type == i_type )
576 else if( p_tmp->i_children )
578 p_tmp = FindObject( p_tmp, i_type, i_mode );
588 /* Handled in vlc_object_find */
595 static void DetachObject( vlc_object_t *p_this )
597 vlc_object_t *p_parent = p_this->p_parent;
600 /* Remove p_this's parent */
601 p_this->p_parent = NULL;
603 /* Remove all of p_parent's children which are p_this */
604 for( i_index = p_parent->i_children ; i_index-- ; )
606 if( p_parent->pp_children[i_index] == p_this )
608 p_parent->i_children--;
609 for( i = i_index ; i < p_parent->i_children ; i++ )
611 p_parent->pp_children[i] = p_parent->pp_children[i+1];
616 if( p_parent->i_children )
618 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
619 p_parent->i_children * sizeof(vlc_object_t *) );
623 free( p_parent->pp_children );
624 p_parent->pp_children = NULL;
628 /*****************************************************************************
629 * SetAttachment: recursively set the b_attached flag of a subtree.
630 *****************************************************************************
631 * This function is used by the attach and detach functions to propagate
632 * the b_attached flag in a subtree.
633 *****************************************************************************/
634 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
638 for( i_index = p_this->i_children ; i_index-- ; )
640 SetAttachment( p_this->pp_children[i_index], b_attached );
643 p_this->b_attached = b_attached;
646 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
648 char psz_children[20], psz_refcount[20], psz_thread[20], psz_name[50];
651 if( p_this->psz_object_name )
653 snprintf( psz_name, 50, " \"%s\"", p_this->psz_object_name );
658 psz_children[0] = '\0';
659 switch( p_this->i_children )
664 strcpy( psz_children, ", 1 child" );
667 snprintf( psz_children, 20,
668 ", %i children", p_this->i_children );
669 psz_children[19] = '\0';
673 psz_refcount[0] = '\0';
674 if( p_this->i_refcount )
676 snprintf( psz_refcount, 20, ", refcount %i", p_this->i_refcount );
677 psz_refcount[19] = '\0';
680 psz_thread[0] = '\0';
681 if( p_this->b_thread )
683 snprintf( psz_thread, 20, " (thread %d)", (int)p_this->thread_id );
684 psz_thread[19] = '\0';
687 printf( " %so %.6x %s%s%s%s%s\n", psz_prefix,
688 p_this->i_object_id, p_this->psz_object_type,
689 psz_name, psz_thread, psz_refcount, psz_children );
692 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
695 char i_back = psz_foo[i_level];
696 psz_foo[i_level] = '\0';
698 PrintObject( p_this, psz_foo );
700 psz_foo[i_level] = i_back;
702 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
704 msg_Warn( p_this, "structure tree is too deep" );
708 for( i = 0 ; i < p_this->i_children ; i++ )
712 psz_foo[i_level-1] = ' ';
714 if( psz_foo[i_level-2] == '`' )
716 psz_foo[i_level-2] = ' ';
720 if( i == p_this->i_children - 1 )
722 psz_foo[i_level] = '`';
726 psz_foo[i_level] = '|';
729 psz_foo[i_level+1] = '-';
730 psz_foo[i_level+2] = '\0';
732 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
736 static vlc_list_t * NewList( void )
738 vlc_list_t *p_list = malloc( sizeof( vlc_list_t )
739 + 3 * sizeof( vlc_object_t * ) );
747 p_list->pp_objects = &p_list->_p_first;
749 /* We allocated space for NULL and for three extra objects */
750 p_list->_i_extra = 3;
751 p_list->_p_first = NULL;
756 static vlc_list_t * ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
763 if( p_list->_i_extra == 0 )
765 /* If we had X objects it means the array has a size of X+1, we
766 * make it size 2X+2, so we alloc 2X+1 because there is already
767 * one allocated in the real structure */
768 p_list = realloc( p_list, sizeof( vlc_list_t )
769 + (p_list->i_count * 2 + 1)
770 * sizeof( vlc_object_t * ) );
776 /* We have X+1 extra slots */
777 p_list->_i_extra = p_list->i_count + 1;
778 p_list->pp_objects = &p_list->_p_first;
781 p_object->i_refcount++;
783 p_list->pp_objects[p_list->i_count] = p_object;
785 p_list->pp_objects[p_list->i_count] = NULL;