git.sesse.net Git - vlc/blob - src/control/flat_media_list_view.c

   1 /*****************************************************************************
   2  * flat_media_list_view.c: libvlc flat media list view functions.
   3  *****************************************************************************
   4  * Copyright (C) 2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Pierre d'Herbemont <pdherbemont # videolan.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 #include "libvlc_internal.h"
  25 #include <vlc/libvlc.h>
  26 #include <assert.h>
  27 #include "vlc_arrays.h"
  28
  29 //#define DEBUG_FLAT_VIEW
  30
  31 #ifdef DEBUG_FLAT_VIEW
  32 # define trace( fmt, ... ) printf( "%s(): " fmt, __FUNCTION__, ##__VA_ARGS__ )
  33 #else
  34 # define trace( ... )
  35 #endif
  36
  37 struct libvlc_media_list_view_private_t
  38 {
  39     vlc_array_t array;
  40 };
  41
  42 /*
  43  * Private functions
  44  */
  45
  46 /**************************************************************************
  47  *       ml_item_added  (private) (Callback from media_list_view item_added)
  48  **************************************************************************/
  49 static void
  50 ml_item_added( const libvlc_event_t * p_event, libvlc_media_list_view_t * p_mlv )
  51 {
  52     int index = vlc_array_count( &p_mlv->p_this_view_data->array );
  53     libvlc_media_t * p_md = p_event->u.media_list_item_added.item;
  54     libvlc_media_retain( p_md );
  55     trace("appending item at index %d\n", index);
  56
  57     libvlc_media_list_view_will_add_item( p_mlv, p_md, index );
  58     vlc_array_append( &p_mlv->p_this_view_data->array, p_md );
  59     libvlc_media_list_view_item_added( p_mlv, p_md, index );
  60 }
  61
  62 /**************************************************************************
  63  *       ml_item_removed  (private) (Callback from media_list_view)
  64  **************************************************************************/
  65 static void
  66 ml_item_removed( const libvlc_event_t * p_event, libvlc_media_list_view_t * p_mlv )
  67 {
  68     libvlc_media_t * p_md = p_event->u.media_list_item_deleted.item;
  69     int i = vlc_array_index_of_item( &p_mlv->p_this_view_data->array, p_md );
  70     if( i >= 0 )
  71     {
  72         libvlc_media_list_view_will_delete_item( p_mlv, p_md, i );
  73         vlc_array_remove( &p_mlv->p_this_view_data->array, i );
  74         libvlc_media_list_view_item_deleted( p_mlv, p_md, i );
  75         libvlc_media_release( p_md );
  76     }
  77 }
  78
  79 /**************************************************************************
  80  *       flat_media_list_view_count  (private)
  81  * (called by media_list_view_count)
  82  **************************************************************************/
  83 static int
  84 flat_media_list_view_count( libvlc_media_list_view_t * p_mlv,
  85                             libvlc_exception_t * p_e )
  86 {
  87     (void)p_e;
  88     return vlc_array_count( &p_mlv->p_this_view_data->array );
  89 }
  90
  91 /**************************************************************************
  92  *       flat_media_list_view_item_at_index  (private)
  93  * (called by flat_media_list_view_item_at_index)
  94  **************************************************************************/
  95 static libvlc_media_t *
  96 flat_media_list_view_item_at_index( libvlc_media_list_view_t * p_mlv,
  97                                     int index,
  98                                     libvlc_exception_t * p_e )
  99 {
 100     libvlc_media_t * p_md;
 101     (void)p_e;
 102     p_md = vlc_array_item_at_index( &p_mlv->p_this_view_data->array, index );
 103     libvlc_media_retain( p_md );
 104     return p_md;
 105 }
 106
 107 /**************************************************************************
 108  *       flat_media_list_view_item_at_index  (private)
 109  * (called by flat_media_list_view_item_at_index)
 110  **************************************************************************/
 111 static libvlc_media_list_view_t *
 112 flat_media_list_view_children_at_index( libvlc_media_list_view_t * p_mlv,
 113                                         int index,
 114                                         libvlc_exception_t * p_e )
 115 {
 116     (void)p_mlv; (void)index; (void)p_e;
 117     return NULL;
 118 }
 119
 120 /**************************************************************************
 121  *       flat_media_list_view_release (private)
 122  * (called by media_list_view_release)
 123  **************************************************************************/
 124 static void
 125 flat_media_list_view_release( libvlc_media_list_view_t * p_mlv )
 126 {
 127     vlc_array_clear( &p_mlv->p_this_view_data->array );
 128     free( p_mlv->p_this_view_data );
 129 }
 130
 131 /*
 132  * Public libvlc functions
 133  */
 134
 135 /* Little helper */
 136 static void
 137 import_mlist_rec( libvlc_media_list_view_t * p_mlv,
 138                   libvlc_media_list_t * p_mlist,
 139                   libvlc_exception_t * p_e )
 140 {
 141     int i, count;
 142     count = libvlc_media_list_count( p_mlist, p_e );
 143     for( i = 0; i < count; i++ )
 144     {
 145         libvlc_media_t * p_md;
 146         libvlc_media_list_t * p_submlist;
 147         p_md = libvlc_media_list_item_at_index( p_mlist, i, p_e );
 148         vlc_array_append( &p_mlv->p_this_view_data->array, p_md );
 149         p_submlist = libvlc_media_subitems( p_md, p_e );
 150         if( p_submlist )
 151         {
 152             libvlc_media_list_lock( p_submlist );
 153             import_mlist_rec( p_mlv, p_submlist, p_e );
 154             libvlc_media_list_unlock( p_submlist );
 155             libvlc_media_list_release( p_submlist );
 156         }
 157         /* No need to release the md, as we want to retain it, as it is
 158          * stored in our array */
 159     }
 160 }
 161
 162 /**************************************************************************
 163  *       libvlc_media_list_flat_view (Public)
 164  **************************************************************************/
 165 libvlc_media_list_view_t *
 166 libvlc_media_list_flat_view( libvlc_media_list_t * p_mlist,
 167                              libvlc_exception_t * p_e )
 168 {
 169     trace("\n");
 170     libvlc_media_list_view_t * p_mlv;
 171     struct libvlc_media_list_view_private_t * p_this_view_data;
 172     p_this_view_data = malloc(sizeof(struct libvlc_media_list_view_private_t));
 173     vlc_array_init( &p_this_view_data->array );
 174     p_mlv = libvlc_media_list_view_new( p_mlist,
 175                                         flat_media_list_view_count,
 176                                         flat_media_list_view_item_at_index,
 177                                         flat_media_list_view_children_at_index,
 178                                         libvlc_media_list_flat_view,
 179                                         flat_media_list_view_release,
 180                                         p_this_view_data,
 181                                         p_e );
 182     libvlc_media_list_lock( p_mlist );
 183     import_mlist_rec( p_mlv, p_mlist, p_e );
 184     libvlc_media_list_view_set_ml_notification_callback( p_mlv,
 185         ml_item_added,
 186         ml_item_removed );
 187     libvlc_media_list_unlock( p_mlist );
 188
 189     return p_mlv;
 190 }