git.sesse.net Git - vlc/blob - src/misc/objects.c

   1 /*****************************************************************************
   2  * objects.c: vlc_object_t handling
   3  *****************************************************************************
   4  * Copyright (C) 2004-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 /**
  25  * \file
  26  * This file contains the functions to handle the vlc_object_t type
  27  */
  28
  29
  30 /*****************************************************************************
  31  * Preamble
  32  *****************************************************************************/
  33 #include <vlc/vlc.h>
  34
  35 #ifdef HAVE_STDLIB_H
  36 #   include <stdlib.h>                                          /* realloc() */
  37 #endif
  38
  39 #include "../libvlc.h"
  40 #include <vlc_vout.h>
  41 #include <vlc_aout.h>
  42 #include "audio_output/aout_internal.h"
  43
  44 #include <vlc_access.h>
  45 #include <vlc_demux.h>
  46 #include <vlc_stream.h>
  47
  48 #include <vlc_sout.h>
  49 #include "stream_output/stream_output.h"
  50
  51 #include "vlc_playlist.h"
  52 #include "vlc_interface.h"
  53 #include "vlc_codec.h"
  54 #include "vlc_filter.h"
  55
  56 #include "vlc_httpd.h"
  57 #include "vlc_vlm.h"
  58 #include "input/vlm_internal.h"
  59 #include "vlc_vod.h"
  60 #include "vlc_tls.h"
  61 #include "vlc_xml.h"
  62 #include "vlc_osd.h"
  63 #include "vlc_meta.h"
  64
  65 #include "variables.h"
  66
  67 /*****************************************************************************
  68  * Local prototypes
  69  *****************************************************************************/
  70 static int  DumpCommand( vlc_object_t *, char const *,
  71                          vlc_value_t, vlc_value_t, void * );
  72
  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 );
  80
  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 );
  86
  87 /*****************************************************************************
  88  * Local structure lock
  89  *****************************************************************************/
  90 static vlc_mutex_t    structure_lock;
  91 static vlc_object_internals_t global_internals;
  92
  93 vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
  94                                  int i_type, const char *psz_type )
  95 {
  96     vlc_object_t *p_new;
  97     vlc_object_internals_t *p_priv;
  98
  99     if( i_type == VLC_OBJECT_GLOBAL )
 100     {
 101         p_new = p_this;
 102         p_priv = &global_internals;
 103         memset( p_priv, 0, sizeof( *p_priv ) );
 104     }
 105     else
 106     {
 107         p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
 108         if( p_priv == NULL )
 109             return NULL;
 110
 111         p_new = (vlc_object_t *)(p_priv + 1);
 112     }
 113
 114     p_new->p_internals = p_priv;
 115     p_new->i_object_type = i_type;
 116     p_new->psz_object_type = psz_type;
 117
 118     p_new->psz_object_name = NULL;
 119
 120     p_new->b_die = VLC_FALSE;
 121     p_new->b_error = VLC_FALSE;
 122     p_new->b_dead = VLC_FALSE;
 123     p_new->b_attached = VLC_FALSE;
 124     p_new->b_force = VLC_FALSE;
 125
 126     p_new->psz_header = NULL;
 127
 128     if( p_this->i_flags & OBJECT_FLAGS_NODBG )
 129         p_new->i_flags |= OBJECT_FLAGS_NODBG;
 130     if( p_this->i_flags & OBJECT_FLAGS_QUIET )
 131         p_new->i_flags |= OBJECT_FLAGS_QUIET;
 132     if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
 133         p_new->i_flags |= OBJECT_FLAGS_NOINTERACT;
 134
 135     p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
 136
 137     if( !p_priv->p_vars )
 138     {
 139         if( i_type != VLC_OBJECT_GLOBAL )
 140             free( p_priv );
 141         return NULL;
 142     }
 143
 144     if( i_type == VLC_OBJECT_GLOBAL )
 145     {
 146         /* If i_type is global, then p_new is actually p_libvlc_global */
 147         libvlc_global_data_t *p_libvlc_global = (libvlc_global_data_t *)p_new;
 148         p_new->p_libvlc = NULL;
 149
 150         p_libvlc_global->i_counter = 0;
 151         p_new->i_object_id = 0;
 152
 153         p_libvlc_global->i_objects = 1;
 154         p_libvlc_global->pp_objects = malloc( sizeof(vlc_object_t *) );
 155         p_libvlc_global->pp_objects[0] = p_new;
 156         p_new->b_attached = VLC_TRUE;
 157     }
 158     else
 159     {
 160         libvlc_global_data_t *p_libvlc_global = vlc_global();
 161         p_new->p_libvlc = ( i_type == VLC_OBJECT_LIBVLC ) ? (libvlc_int_t*)p_new
 162                                                        : p_this->p_libvlc;
 163
 164         vlc_mutex_lock( &structure_lock );
 165
 166         p_libvlc_global->i_counter++;
 167         p_new->i_object_id = p_libvlc_global->i_counter;
 168
 169         /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
 170          * useless to try and recover anything if pp_objects gets smashed. */
 171         TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
 172                     p_new );
 173
 174         vlc_mutex_unlock( &structure_lock );
 175     }
 176
 177     p_new->i_refcount = 0;
 178     p_new->p_parent = NULL;
 179     p_new->pp_children = NULL;
 180     p_new->i_children = 0;
 181
 182     p_new->p_private = NULL;
 183
 184     /* Initialize mutexes and condvars */
 185     vlc_mutex_init( p_new, &p_new->object_lock );
 186     vlc_cond_init( p_new, &p_new->object_wait );
 187     vlc_mutex_init( p_new, &p_priv->var_lock );
 188
 189     if( i_type == VLC_OBJECT_GLOBAL )
 190     {
 191         vlc_mutex_init( p_new, &structure_lock );
 192
 193         var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 194         var_AddCallback( p_new, "list", DumpCommand, NULL );
 195         var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 196         var_AddCallback( p_new, "tree", DumpCommand, NULL );
 197         var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 198         var_AddCallback( p_new, "vars", DumpCommand, NULL );
 199     }
 200
 201     return p_new;
 202 }
 203
 204
 205 /**
 206  * Allocates and initializes a vlc object.
 207  *
 208  * @param i_type known object type (all of them are negative integer values),
 209  *               or object byte size (always positive).
 210  *
 211  * @return the new object, or NULL on error.
 212  */
 213 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
 214 {
 215     const char   * psz_type;
 216     size_t         i_size;
 217
 218     switch( i_type )
 219     {
 220         case VLC_OBJECT_GLOBAL:
 221             i_size = sizeof(libvlc_global_data_t);
 222             psz_type = "global";
 223             break;
 224         case VLC_OBJECT_LIBVLC:
 225             i_size = sizeof(libvlc_int_t);
 226             psz_type = "libvlc";
 227             break;
 228         case VLC_OBJECT_INTF:
 229             i_size = sizeof(intf_thread_t);
 230             psz_type = "interface";
 231             break;
 232         case VLC_OBJECT_DIALOGS:
 233             i_size = sizeof(intf_thread_t);
 234             psz_type = "dialogs";
 235             break;
 236         case VLC_OBJECT_PLAYLIST:
 237             i_size = sizeof(playlist_t);
 238             psz_type = "playlist";
 239             break;
 240         case VLC_OBJECT_SD:
 241             i_size = sizeof(services_discovery_t);
 242             psz_type = "services discovery";
 243             break;
 244         case VLC_OBJECT_INPUT:
 245             i_size = sizeof(input_thread_t);
 246             psz_type = "input";
 247             break;
 248         case VLC_OBJECT_DEMUX:
 249             i_size = sizeof(demux_t);
 250             psz_type = "demux";
 251             break;
 252         case VLC_OBJECT_ACCESS:
 253             i_size = sizeof(access_t);
 254             psz_type = "access";
 255             break;
 256         case VLC_OBJECT_DECODER:
 257             i_size = sizeof(decoder_t);
 258             psz_type = "decoder";
 259             break;
 260         case VLC_OBJECT_PACKETIZER:
 261             i_size = sizeof(decoder_t);
 262             psz_type = "packetizer";
 263             break;
 264         case VLC_OBJECT_ENCODER:
 265             i_size = sizeof(encoder_t);
 266             psz_type = "encoder";
 267             break;
 268         case VLC_OBJECT_FILTER:
 269             i_size = sizeof(filter_t);
 270             psz_type = "filter";
 271             break;
 272         case VLC_OBJECT_VOUT:
 273             i_size = sizeof(vout_thread_t);
 274             psz_type = "video output";
 275             break;
 276         case VLC_OBJECT_SPU:
 277             i_size = sizeof(spu_t);
 278             psz_type = "subpicture";
 279             break;
 280         case VLC_OBJECT_AOUT:
 281             i_size = sizeof(aout_instance_t);
 282             psz_type = "audio output";
 283             break;
 284         case VLC_OBJECT_SOUT:
 285             i_size = sizeof(sout_instance_t);
 286             psz_type = "stream output";
 287             break;
 288         case VLC_OBJECT_VLM:
 289             i_size = sizeof( vlm_t );
 290             psz_type = "vlm dameon";
 291             break;
 292         case VLC_OBJECT_VOD:
 293             i_size = sizeof( vod_t );
 294             psz_type = "vod server";
 295             break;
 296         case VLC_OBJECT_TLS:
 297             i_size = sizeof( tls_t );
 298             psz_type = "tls";
 299             break;
 300         case VLC_OBJECT_XML:
 301             i_size = sizeof( xml_t );
 302             psz_type = "xml";
 303             break;
 304         case VLC_OBJECT_OPENGL:
 305             i_size = sizeof( vout_thread_t );
 306             psz_type = "opengl";
 307             break;
 308         case VLC_OBJECT_ANNOUNCE:
 309             i_size = sizeof( announce_handler_t );
 310             psz_type = "announce";
 311             break;
 312         case VLC_OBJECT_META_ENGINE:
 313             i_size = sizeof( meta_engine_t );
 314             psz_type = "meta engine";
 315             break;
 316         case VLC_OBJECT_OSDMENU:
 317             i_size = sizeof( osd_menu_t );
 318             psz_type = "osd menu";
 319             break;
 320         default:
 321             i_size = i_type > (int)sizeof(vlc_object_t)
 322                          ? i_type : (int)sizeof(vlc_object_t);
 323             i_type = VLC_OBJECT_GENERIC;
 324             psz_type = "generic";
 325             break;
 326     }
 327
 328     return vlc_custom_create( p_this, i_size, i_type, psz_type );
 329 }
 330
 331
 332 /**
 333  ****************************************************************************
 334  * Destroy a vlc object
 335  *
 336  * This function destroys an object that has been previously allocated with
 337  * vlc_object_create. The object's refcount must be zero and it must not be
 338  * attached to other objects in any way.
 339  *****************************************************************************/
 340 void __vlc_object_destroy( vlc_object_t *p_this )
 341 {
 342     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 343     int i_delay = 0;
 344
 345     if( p_this->i_children )
 346     {
 347         msg_Err( p_this, "cannot delete object (%i, %s) with children" ,
 348                  p_this->i_object_id, p_this->psz_object_name );
 349         return;
 350     }
 351
 352     if( p_this->p_parent )
 353     {
 354         msg_Err( p_this, "cannot delete object (%i, %s) with a parent",
 355                  p_this->i_object_id, p_this->psz_object_name );
 356         return;
 357     }
 358
 359     while( p_this->i_refcount )
 360     {
 361         i_delay++;
 362
 363         /* Don't warn immediately ... 100ms seems OK */
 364         if( i_delay == 2 )
 365         {
 366             msg_Warn( p_this,
 367                   "refcount is %i, delaying before deletion (id=%d,type=%d)",
 368                   p_this->i_refcount, p_this->i_object_id,
 369                   p_this->i_object_type );
 370         }
 371         else if( i_delay == 10 )
 372         {
 373             msg_Err( p_this,
 374                   "refcount is %i, delaying again (id=%d,type=%d)",
 375                   p_this->i_refcount, p_this->i_object_id,
 376                   p_this->i_object_type );
 377         }
 378         else if( i_delay == 20 )
 379         {
 380             msg_Err( p_this,
 381                   "waited too long, cancelling destruction (id=%d,type=%d)",
 382                   p_this->i_object_id, p_this->i_object_type );
 383             return;
 384         }
 385
 386         msleep( 100000 );
 387     }
 388
 389     /* Destroy the associated variables, starting from the end so that
 390      * no memmove calls have to be done. */
 391     while( p_priv->i_vars )
 392     {
 393         var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
 394     }
 395
 396     free( p_priv->p_vars );
 397     vlc_mutex_destroy( &p_priv->var_lock );
 398
 399     if( p_this->psz_header ) free( p_this->psz_header );
 400
 401     if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
 402     {
 403         libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
 404         /* We are the global object ... no need to lock. */
 405         free( p_global->pp_objects );
 406         p_global->pp_objects = NULL;
 407         p_global->i_objects--;
 408
 409         vlc_mutex_destroy( &structure_lock );
 410     }
 411     else
 412     {
 413         libvlc_global_data_t *p_libvlc_global = vlc_global();
 414         int i_index;
 415
 416         vlc_mutex_lock( &structure_lock );
 417
 418         /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
 419          * useless to try and recover anything if pp_objects gets smashed. */
 420         i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
 421                              p_libvlc_global->i_objects );
 422         REMOVE_ELEM( p_libvlc_global->pp_objects,
 423                      p_libvlc_global->i_objects, i_index );
 424
 425         vlc_mutex_unlock( &structure_lock );
 426     }
 427
 428 #if defined(WIN32) || defined(UNDER_CE)
 429     /* if object has an associated thread, close it now */
 430     if( p_priv->thread_id.hThread )
 431        CloseHandle(p_priv->thread_id.hThread);
 432 #endif
 433
 434     vlc_mutex_destroy( &p_this->object_lock );
 435     vlc_cond_destroy( &p_this->object_wait );
 436
 437     /* global is not dynamically allocated by vlc_object_create */
 438     if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
 439         free( p_priv );
 440 }
 441
 442
 443 void __vlc_object_kill( vlc_object_t *p_this )
 444 {
 445     vlc_mutex_lock( &p_this->object_lock );
 446     p_this->b_die = VLC_TRUE;
 447     vlc_mutex_unlock( &p_this->object_lock );
 448 }
 449
 450
 451 vlc_bool_t __vlc_object_dying_unlocked( vlc_object_t *p_this )
 452 {
 453     vlc_assert_locked( &p_this->object_lock );
 454     return p_this->b_die;
 455 }
 456
 457
 458 vlc_bool_t __vlc_object_dying( vlc_object_t *p_this )
 459 {
 460      vlc_bool_t b;
 461      vlc_mutex_lock( &p_this->object_lock );
 462      b = __vlc_object_dying_unlocked( p_this );
 463      vlc_mutex_unlock( &p_this->object_lock );
 464      return b;
 465 }
 466
 467
 468 /**
 469  * find an object given its ID
 470  *
 471  * This function looks for the object whose i_object_id field is i_id. We
 472  * use a dichotomy so that lookups are in log2(n).
 473  *****************************************************************************/
 474 void * __vlc_object_get( vlc_object_t *p_this, int i_id )
 475 {
 476     int i_max, i_middle;
 477     vlc_object_t **pp_objects;
 478     libvlc_global_data_t *p_libvlc_global = vlc_global();
 479
 480     vlc_mutex_lock( &structure_lock );
 481
 482     pp_objects = p_libvlc_global->pp_objects;
 483
 484     /* Perform our dichotomy */
 485     for( i_max = p_libvlc_global->i_objects - 1 ; ; )
 486     {
 487         i_middle = i_max / 2;
 488
 489         if( pp_objects[i_middle]->i_object_id > i_id )
 490         {
 491             i_max = i_middle;
 492         }
 493         else if( pp_objects[i_middle]->i_object_id < i_id )
 494         {
 495             if( i_middle )
 496             {
 497                 pp_objects += i_middle;
 498                 i_max -= i_middle;
 499             }
 500             else
 501             {
 502                 /* This happens when there are only two remaining objects */
 503                 if( pp_objects[i_middle+1]->i_object_id == i_id )
 504                 {
 505                     vlc_mutex_unlock( &structure_lock );
 506                     pp_objects[i_middle+1]->i_refcount++;
 507                     return pp_objects[i_middle+1];
 508                 }
 509                 break;
 510             }
 511         }
 512         else
 513         {
 514             vlc_mutex_unlock( &structure_lock );
 515             pp_objects[i_middle]->i_refcount++;
 516             return pp_objects[i_middle];
 517         }
 518
 519         if( i_max == 0 )
 520         {
 521             /* this means that i_max == i_middle, and since we have already
 522              * tested pp_objects[i_middle]), p_found is properly set. */
 523             break;
 524         }
 525     }
 526
 527     vlc_mutex_unlock( &structure_lock );
 528     return NULL;
 529 }
 530
 531 /**
 532  ****************************************************************************
 533  * find a typed object and increment its refcount
 534  *****************************************************************************
 535  * This function recursively looks for a given object type. i_mode can be one
 536  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 537  *****************************************************************************/
 538 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
 539 {
 540     vlc_object_t *p_found;
 541
 542     vlc_mutex_lock( &structure_lock );
 543
 544     /* If we are of the requested type ourselves, don't look further */
 545     if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
 546     {
 547         p_this->i_refcount++;
 548         vlc_mutex_unlock( &structure_lock );
 549         return p_this;
 550     }
 551
 552     /* Otherwise, recursively look for the object */
 553     if( (i_mode & 0x000f) == FIND_ANYWHERE )
 554     {
 555         vlc_object_t *p_root = p_this;
 556
 557         /* Find the root */
 558         while( p_root->p_parent != NULL &&
 559                p_root != VLC_OBJECT( p_this->p_libvlc ) )
 560         {
 561             p_root = p_root->p_parent;
 562         }
 563
 564         p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
 565         if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
 566         {
 567             p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
 568                                   i_type, (i_mode & ~0x000f)|FIND_CHILD );
 569         }
 570     }
 571     else
 572     {
 573         p_found = FindObject( p_this, i_type, i_mode );
 574     }
 575
 576     vlc_mutex_unlock( &structure_lock );
 577
 578     return p_found;
 579 }
 580
 581 /**
 582  ****************************************************************************
 583  * find a named object and increment its refcount
 584  *****************************************************************************
 585  * This function recursively looks for a given object name. i_mode can be one
 586  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 587  *****************************************************************************/
 588 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
 589                                int i_mode )
 590 {
 591     vlc_object_t *p_found;
 592
 593     vlc_mutex_lock( &structure_lock );
 594
 595     /* If have the requested name ourselves, don't look further */
 596     if( !(i_mode & FIND_STRICT)
 597         && p_this->psz_object_name
 598         && !strcmp( p_this->psz_object_name, psz_name ) )
 599     {
 600         p_this->i_refcount++;
 601         vlc_mutex_unlock( &structure_lock );
 602         return p_this;
 603     }
 604
 605     /* Otherwise, recursively look for the object */
 606     if( (i_mode & 0x000f) == FIND_ANYWHERE )
 607     {
 608         vlc_object_t *p_root = p_this;
 609
 610         /* Find the root */
 611         while( p_root->p_parent != NULL &&
 612                p_root != VLC_OBJECT( p_this->p_libvlc ) )
 613         {
 614             p_root = p_root->p_parent;
 615         }
 616
 617         p_found = FindObjectName( p_root, psz_name,
 618                                  (i_mode & ~0x000f)|FIND_CHILD );
 619         if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
 620         {
 621             p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
 622                                       psz_name, (i_mode & ~0x000f)|FIND_CHILD );
 623         }
 624     }
 625     else
 626     {
 627         p_found = FindObjectName( p_this, psz_name, i_mode );
 628     }
 629
 630     vlc_mutex_unlock( &structure_lock );
 631
 632     return p_found;
 633 }
 634
 635 /**
 636  ****************************************************************************
 637  * increment an object refcount
 638  *****************************************************************************/
 639 void __vlc_object_yield( vlc_object_t *p_this )
 640 {
 641     vlc_mutex_lock( &structure_lock );
 642     p_this->i_refcount++;
 643     vlc_mutex_unlock( &structure_lock );
 644 }
 645
 646 /**
 647  ****************************************************************************
 648  * decrement an object refcount
 649  *****************************************************************************/
 650 void __vlc_object_release( vlc_object_t *p_this )
 651 {
 652     vlc_mutex_lock( &structure_lock );
 653     p_this->i_refcount--;
 654     vlc_mutex_unlock( &structure_lock );
 655 }
 656
 657 /**
 658  ****************************************************************************
 659  * attach object to a parent object
 660  *****************************************************************************
 661  * This function sets p_this as a child of p_parent, and p_parent as a parent
 662  * of p_this. This link can be undone using vlc_object_detach.
 663  *****************************************************************************/
 664 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
 665 {
 666     if( !p_this ) return;
 667
 668     vlc_mutex_lock( &structure_lock );
 669
 670     /* Attach the parent to its child */
 671     p_this->p_parent = p_parent;
 672
 673     /* Attach the child to its parent */
 674     INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
 675                  p_parent->i_children, p_this );
 676
 677     /* Climb up the tree to see whether we are connected with the root */
 678     if( p_parent->b_attached )
 679     {
 680         SetAttachment( p_this, VLC_TRUE );
 681     }
 682
 683     vlc_mutex_unlock( &structure_lock );
 684 }
 685
 686 /**
 687  ****************************************************************************
 688  * detach object from its parent
 689  *****************************************************************************
 690  * This function removes all links between an object and its parent.
 691  *****************************************************************************/
 692 void __vlc_object_detach( vlc_object_t *p_this )
 693 {
 694     if( !p_this ) return;
 695
 696     vlc_mutex_lock( &structure_lock );
 697     if( !p_this->p_parent )
 698     {
 699         msg_Err( p_this, "object is not attached" );
 700         vlc_mutex_unlock( &structure_lock );
 701         return;
 702     }
 703
 704     /* Climb up the tree to see whether we are connected with the root */
 705     if( p_this->p_parent->b_attached )
 706     {
 707         SetAttachment( p_this, VLC_FALSE );
 708     }
 709
 710     DetachObject( p_this );
 711     vlc_mutex_unlock( &structure_lock );
 712     p_this = NULL;
 713 }
 714
 715 /**
 716  ****************************************************************************
 717  * find a list typed objects and increment their refcount
 718  *****************************************************************************
 719  * This function recursively looks for a given object type. i_mode can be one
 720  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 721  *****************************************************************************/
 722 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
 723 {
 724     vlc_list_t *p_list;
 725     vlc_object_t **pp_current, **pp_end;
 726     int i_count = 0, i_index = 0;
 727     libvlc_global_data_t *p_libvlc_global = vlc_global();
 728
 729     vlc_mutex_lock( &structure_lock );
 730
 731     /* Look for the objects */
 732     switch( i_mode & 0x000f )
 733     {
 734     case FIND_ANYWHERE:
 735         pp_current = p_libvlc_global->pp_objects;
 736         pp_end = pp_current + p_libvlc_global->i_objects;
 737
 738         for( ; pp_current < pp_end ; pp_current++ )
 739         {
 740             if( (*pp_current)->b_attached
 741                  && (*pp_current)->i_object_type == i_type )
 742             {
 743                 i_count++;
 744             }
 745         }
 746
 747         p_list = NewList( i_count );
 748         pp_current = p_libvlc_global->pp_objects;
 749
 750         for( ; pp_current < pp_end ; pp_current++ )
 751         {
 752             if( (*pp_current)->b_attached
 753                  && (*pp_current)->i_object_type == i_type )
 754             {
 755                 ListReplace( p_list, *pp_current, i_index );
 756                 if( i_index < i_count ) i_index++;
 757             }
 758         }
 759     break;
 760
 761     case FIND_CHILD:
 762         i_count = CountChildren( p_this, i_type );
 763         p_list = NewList( i_count );
 764
 765         /* Check allocation was successful */
 766         if( p_list->i_count != i_count )
 767         {
 768             msg_Err( p_this, "list allocation failed!" );
 769             p_list->i_count = 0;
 770             break;
 771         }
 772
 773         p_list->i_count = 0;
 774         ListChildren( p_list, p_this, i_type );
 775         break;
 776
 777     default:
 778         msg_Err( p_this, "unimplemented!" );
 779         p_list = NewList( 0 );
 780         break;
 781     }
 782
 783     vlc_mutex_unlock( &structure_lock );
 784
 785     return p_list;
 786 }
 787
 788 /*****************************************************************************
 789  * DumpCommand: print the current vlc structure
 790  *****************************************************************************
 791  * This function prints either an ASCII tree showing the connections between
 792  * vlc objects, and additional information such as their refcount, thread ID,
 793  * etc. (command "tree"), or the same data as a simple list (command "list").
 794  *****************************************************************************/
 795 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
 796                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 797 {
 798     libvlc_global_data_t *p_libvlc_global = vlc_global();
 799
 800     (void)oldval; (void)p_data;
 801     if( *psz_cmd == 'l' )
 802     {
 803         vlc_mutex_lock( &structure_lock );
 804
 805         vlc_object_t **pp_current, **pp_end;
 806
 807         pp_current = p_libvlc_global->pp_objects;
 808         pp_end = pp_current + p_libvlc_global->i_objects;
 809
 810         for( ; pp_current < pp_end ; pp_current++ )
 811         {
 812             if( (*pp_current)->b_attached )
 813             {
 814                 PrintObject( *pp_current, "" );
 815             }
 816             else
 817             {
 818                 printf( " o %.8i %s (not attached)\n",
 819                         (*pp_current)->i_object_id,
 820                         (*pp_current)->psz_object_type );
 821             }
 822         }
 823
 824         vlc_mutex_unlock( &structure_lock );
 825     }
 826     else
 827     {
 828         vlc_object_t *p_object = NULL;
 829
 830         if( *newval.psz_string )
 831         {
 832             char *end;
 833             int i_id = strtol( newval.psz_string, &end, 0 );
 834             if( end != newval.psz_string )
 835                 p_object = vlc_object_get( p_this, i_id );
 836             else
 837             {
 838                 /* try using the object's name to find it */
 839                 vlc_object_t *p_libvlc = vlc_object_get( p_this, 1 );
 840                 if( p_libvlc )
 841                 {
 842                     /* Look in p_libvlc's children tree */
 843                     p_object = vlc_object_find_name( p_libvlc,
 844                                                      newval.psz_string,
 845                                                      FIND_CHILD );
 846                     vlc_object_release( p_libvlc );
 847                 }
 848                 if( !p_object )
 849                 {
 850                     /* If it's not in libvlc, look in libvlc_global (== p_this) */
 851                     p_object = vlc_object_find_name( p_this,
 852                                                      newval.psz_string,
 853                                                      FIND_CHILD );
 854                 }
 855             }
 856
 857             if( !p_object )
 858             {
 859                 return VLC_ENOOBJ;
 860             }
 861         }
 862
 863         vlc_mutex_lock( &structure_lock );
 864
 865         if( *psz_cmd == 't' )
 866         {
 867             char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
 868
 869             if( !p_object )
 870                 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
 871
 872             psz_foo[0] = '|';
 873             DumpStructure( p_object, 0, psz_foo );
 874         }
 875         else if( *psz_cmd == 'v' )
 876         {
 877             int i;
 878
 879             if( !p_object )
 880                 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
 881
 882             PrintObject( p_object, "" );
 883
 884             if( !p_object->p_internals->i_vars )
 885                 printf( " `-o No variables\n" );
 886             for( i = 0; i < p_object->p_internals->i_vars; i++ )
 887             {
 888                 variable_t *p_var = p_object->p_internals->p_vars + i;
 889
 890                 const char *psz_type = "unknown";
 891                 switch( p_var->i_type & VLC_VAR_TYPE )
 892                 {
 893 #define MYCASE( type, nice )                \
 894                     case VLC_VAR_ ## type:  \
 895                         psz_type = nice;    \
 896                         break;
 897                     MYCASE( VOID, "void" );
 898                     MYCASE( BOOL, "bool" );
 899                     MYCASE( INTEGER, "integer" );
 900                     MYCASE( HOTKEY, "hotkey" );
 901                     MYCASE( STRING, "string" );
 902                     MYCASE( MODULE, "module" );
 903                     MYCASE( FILE, "file" );
 904                     MYCASE( DIRECTORY, "directory" );
 905                     MYCASE( VARIABLE, "variable" );
 906                     MYCASE( FLOAT, "float" );
 907                     MYCASE( TIME, "time" );
 908                     MYCASE( ADDRESS, "address" );
 909                     MYCASE( MUTEX, "mutex" );
 910                     MYCASE( LIST, "list" );
 911 #undef MYCASE
 912                 }
 913                 printf( " %c-o \"%s\" (%s",
 914                         i + 1 == p_object->p_internals->i_vars ? '`' : '|',
 915                         p_var->psz_name, psz_type );
 916                 if( p_var->psz_text )
 917                     printf( ", %s", p_var->psz_text );
 918                 printf( ")" );
 919                 if( p_var->i_type & VLC_VAR_ISCOMMAND )
 920                     printf( ", command" );
 921                 if( p_var->i_entries )
 922                     printf( ", %d callbacks", p_var->i_entries );
 923                 switch( p_var->i_type & 0x00f0 )
 924                 {
 925                     case VLC_VAR_VOID:
 926                     case VLC_VAR_MUTEX:
 927                         break;
 928                     case VLC_VAR_BOOL:
 929                         printf( ": %s", p_var->val.b_bool ? "true" : "false" );
 930                         break;
 931                     case VLC_VAR_INTEGER:
 932                         printf( ": %d", p_var->val.i_int );
 933                         break;
 934                     case VLC_VAR_STRING:
 935                         printf( ": \"%s\"", p_var->val.psz_string );
 936                         break;
 937                     case VLC_VAR_FLOAT:
 938                         printf( ": %f", p_var->val.f_float );
 939                         break;
 940                     case VLC_VAR_TIME:
 941                         printf( ": " I64Fi, (int64_t)p_var->val.i_time );
 942                         break;
 943                     case VLC_VAR_ADDRESS:
 944                         printf( ": %p", p_var->val.p_address );
 945                         break;
 946                     case VLC_VAR_LIST:
 947                         printf( ": TODO" );
 948                         break;
 949                 }
 950                 printf( "\n" );
 951             }
 952         }
 953
 954         vlc_mutex_unlock( &structure_lock );
 955
 956         if( *newval.psz_string )
 957         {
 958             vlc_object_release( p_object );
 959         }
 960     }
 961
 962     return VLC_SUCCESS;
 963 }
 964
 965 /*****************************************************************************
 966  * vlc_list_release: free a list previously allocated by vlc_list_find
 967  *****************************************************************************
 968  * This function decreases the refcount of all objects in the list and
 969  * frees the list.
 970  *****************************************************************************/
 971 void vlc_list_release( vlc_list_t *p_list )
 972 {
 973     int i_index;
 974
 975     vlc_mutex_lock( &structure_lock );
 976     for( i_index = 0; i_index < p_list->i_count; i_index++ )
 977     {
 978         p_list->p_values[i_index].p_object->i_refcount--;
 979     }
 980     vlc_mutex_unlock( &structure_lock );
 981
 982     free( p_list->p_values );
 983     free( p_list );
 984 }
 985
 986 /* Following functions are local */
 987
 988 /*****************************************************************************
 989  * FindIndex: find the index of an object in an array of objects
 990  *****************************************************************************
 991  * This function assumes that p_this can be found in pp_objects. It will not
 992  * crash if p_this cannot be found, but will return a wrong value. It is your
 993  * duty to check the return value if you are not certain that the object could
 994  * be found for sure.
 995  *****************************************************************************/
 996 static int FindIndex( vlc_object_t *p_this,
 997                       vlc_object_t **pp_objects, int i_count )
 998 {
 999     int i_middle = i_count / 2;
1000
1001     if( i_count == 0 )
1002     {
1003         return 0;
1004     }
1005
1006     if( pp_objects[i_middle] == p_this )
1007     {
1008         return i_middle;
1009     }
1010
1011     if( i_count == 1 )
1012     {
1013         return 0;
1014     }
1015
1016     /* We take advantage of the sorted array */
1017     if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1018     {
1019         return i_middle + FindIndex( p_this, pp_objects + i_middle,
1020                                              i_count - i_middle );
1021     }
1022     else
1023     {
1024         return FindIndex( p_this, pp_objects, i_middle );
1025     }
1026 }
1027
1028 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1029 {
1030     int i;
1031     vlc_object_t *p_tmp;
1032
1033     switch( i_mode & 0x000f )
1034     {
1035     case FIND_PARENT:
1036         p_tmp = p_this->p_parent;
1037         if( p_tmp )
1038         {
1039             if( p_tmp->i_object_type == i_type )
1040             {
1041                 p_tmp->i_refcount++;
1042                 return p_tmp;
1043             }
1044             else
1045             {
1046                 return FindObject( p_tmp, i_type, i_mode );
1047             }
1048         }
1049         break;
1050
1051     case FIND_CHILD:
1052         for( i = p_this->i_children; i--; )
1053         {
1054             p_tmp = p_this->pp_children[i];
1055             if( p_tmp->i_object_type == i_type )
1056             {
1057                 p_tmp->i_refcount++;
1058                 return p_tmp;
1059             }
1060             else if( p_tmp->i_children )
1061             {
1062                 p_tmp = FindObject( p_tmp, i_type, i_mode );
1063                 if( p_tmp )
1064                 {
1065                     return p_tmp;
1066                 }
1067             }
1068         }
1069         break;
1070
1071     case FIND_ANYWHERE:
1072         /* Handled in vlc_object_find */
1073         break;
1074     }
1075
1076     return NULL;
1077 }
1078
1079 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1080                                       const char *psz_name,
1081                                       int i_mode )
1082 {
1083     int i;
1084     vlc_object_t *p_tmp;
1085
1086     switch( i_mode & 0x000f )
1087     {
1088     case FIND_PARENT:
1089         p_tmp = p_this->p_parent;
1090         if( p_tmp )
1091         {
1092             if( p_tmp->psz_object_name
1093                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1094             {
1095                 p_tmp->i_refcount++;
1096                 return p_tmp;
1097             }
1098             else
1099             {
1100                 return FindObjectName( p_tmp, psz_name, i_mode );
1101             }
1102         }
1103         break;
1104
1105     case FIND_CHILD:
1106         for( i = p_this->i_children; i--; )
1107         {
1108             p_tmp = p_this->pp_children[i];
1109             if( p_tmp->psz_object_name
1110                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1111             {
1112                 p_tmp->i_refcount++;
1113                 return p_tmp;
1114             }
1115             else if( p_tmp->i_children )
1116             {
1117                 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1118                 if( p_tmp )
1119                 {
1120                     return p_tmp;
1121                 }
1122             }
1123         }
1124         break;
1125
1126     case FIND_ANYWHERE:
1127         /* Handled in vlc_object_find */
1128         break;
1129     }
1130
1131     return NULL;
1132 }
1133
1134 static void DetachObject( vlc_object_t *p_this )
1135 {
1136     vlc_object_t *p_parent = p_this->p_parent;
1137     int i_index, i;
1138
1139     /* Remove p_this's parent */
1140     p_this->p_parent = NULL;
1141
1142     /* Remove all of p_parent's children which are p_this */
1143     for( i_index = p_parent->i_children ; i_index-- ; )
1144     {
1145         if( p_parent->pp_children[i_index] == p_this )
1146         {
1147             p_parent->i_children--;
1148             for( i = i_index ; i < p_parent->i_children ; i++ )
1149             {
1150                 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1151             }
1152         }
1153     }
1154
1155     if( p_parent->i_children )
1156     {
1157         p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1158                                p_parent->i_children * sizeof(vlc_object_t *) );
1159     }
1160     else
1161     {
1162         free( p_parent->pp_children );
1163         p_parent->pp_children = NULL;
1164     }
1165 }
1166
1167 /*****************************************************************************
1168  * SetAttachment: recursively set the b_attached flag of a subtree.
1169  *****************************************************************************
1170  * This function is used by the attach and detach functions to propagate
1171  * the b_attached flag in a subtree.
1172  *****************************************************************************/
1173 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
1174 {
1175     int i_index;
1176
1177     for( i_index = p_this->i_children ; i_index-- ; )
1178     {
1179         SetAttachment( p_this->pp_children[i_index], b_attached );
1180     }
1181
1182     p_this->b_attached = b_attached;
1183 }
1184
1185 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1186 {
1187     char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1188          psz_parent[20];
1189
1190     psz_name[0] = '\0';
1191     if( p_this->psz_object_name )
1192     {
1193         snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1194         if( psz_name[48] )
1195             psz_name[48] = '\"';
1196     }
1197
1198     psz_children[0] = '\0';
1199     switch( p_this->i_children )
1200     {
1201         case 0:
1202             break;
1203         case 1:
1204             strcpy( psz_children, ", 1 child" );
1205             break;
1206         default:
1207             snprintf( psz_children, 19, ", %i children", p_this->i_children );
1208             break;
1209     }
1210
1211     psz_refcount[0] = '\0';
1212     if( p_this->i_refcount )
1213         snprintf( psz_refcount, 19, ", refcount %i", p_this->i_refcount );
1214
1215     psz_thread[0] = '\0';
1216     if( p_this->p_internals->b_thread )
1217         snprintf( psz_thread, 29, " (thread %u)",
1218 #if defined(WIN32) || defined(UNDER_CE)
1219                   (unsigned)p_this->p_internals->thread_id.id );
1220 #else
1221                   (unsigned)p_this->p_internals->thread_id );
1222 #endif
1223
1224     psz_parent[0] = '\0';
1225     if( p_this->p_parent )
1226         snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1227
1228     printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1229             p_this->i_object_id, p_this->psz_object_type,
1230             psz_name, psz_thread, psz_refcount, psz_children,
1231             psz_parent );
1232 }
1233
1234 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1235 {
1236     int i;
1237     char i_back = psz_foo[i_level];
1238     psz_foo[i_level] = '\0';
1239
1240     PrintObject( p_this, psz_foo );
1241
1242     psz_foo[i_level] = i_back;
1243
1244     if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1245     {
1246         msg_Warn( p_this, "structure tree is too deep" );
1247         return;
1248     }
1249
1250     for( i = 0 ; i < p_this->i_children ; i++ )
1251     {
1252         if( i_level )
1253         {
1254             psz_foo[i_level-1] = ' ';
1255
1256             if( psz_foo[i_level-2] == '`' )
1257             {
1258                 psz_foo[i_level-2] = ' ';
1259             }
1260         }
1261
1262         if( i == p_this->i_children - 1 )
1263         {
1264             psz_foo[i_level] = '`';
1265         }
1266         else
1267         {
1268             psz_foo[i_level] = '|';
1269         }
1270
1271         psz_foo[i_level+1] = '-';
1272         psz_foo[i_level+2] = '\0';
1273
1274         DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1275     }
1276 }
1277
1278 static vlc_list_t * NewList( int i_count )
1279 {
1280     vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1281     if( p_list == NULL )
1282     {
1283         return NULL;
1284     }
1285
1286     p_list->i_count = i_count;
1287
1288     if( i_count == 0 )
1289     {
1290         p_list->p_values = NULL;
1291         return p_list;
1292     }
1293
1294     p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1295     if( p_list->p_values == NULL )
1296     {
1297         p_list->i_count = 0;
1298         return p_list;
1299     }
1300
1301     return p_list;
1302 }
1303
1304 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1305                          int i_index )
1306 {
1307     if( p_list == NULL || i_index >= p_list->i_count )
1308     {
1309         return;
1310     }
1311
1312     p_object->i_refcount++;
1313
1314     p_list->p_values[i_index].p_object = p_object;
1315
1316     return;
1317 }
1318
1319 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1320 {
1321     if( p_list == NULL )
1322     {
1323         return;
1324     }
1325
1326     p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1327                                 * sizeof( vlc_value_t ) );
1328     if( p_list->p_values == NULL )
1329     {
1330         p_list->i_count = 0;
1331         return;
1332     }
1333
1334     p_object->i_refcount++;
1335
1336     p_list->p_values[p_list->i_count].p_object = p_object;
1337     p_list->i_count++;
1338
1339     return;
1340 }*/
1341
1342 static int CountChildren( vlc_object_t *p_this, int i_type )
1343 {
1344     vlc_object_t *p_tmp;
1345     int i, i_count = 0;
1346
1347     for( i = 0; i < p_this->i_children; i++ )
1348     {
1349         p_tmp = p_this->pp_children[i];
1350
1351         if( p_tmp->i_object_type == i_type )
1352         {
1353             i_count++;
1354         }
1355
1356         if( p_tmp->i_children )
1357         {
1358             i_count += CountChildren( p_tmp, i_type );
1359         }
1360     }
1361
1362     return i_count;
1363 }
1364
1365 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1366 {
1367     vlc_object_t *p_tmp;
1368     int i;
1369
1370     for( i = 0; i < p_this->i_children; i++ )
1371     {
1372         p_tmp = p_this->pp_children[i];
1373
1374         if( p_tmp->i_object_type == i_type )
1375         {
1376             ListReplace( p_list, p_tmp, p_list->i_count++ );
1377         }
1378
1379         if( p_tmp->i_children )
1380         {
1381             ListChildren( p_list, p_tmp, i_type );
1382         }
1383     }
1384 }