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