]> git.sesse.net Git - vlc/blob - src/playlist/search.c
playlist_search:
[vlc] / src / playlist / search.c
1 /*****************************************************************************
2  * search.c : Search functions
3  *****************************************************************************
4  * Copyright (C) 1999-2009 the VideoLAN team
5  * $Id$
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@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 #ifdef HAVE_CONFIG_H
24 # include "config.h"
25 #endif
26 #include <assert.h>
27
28 #include <vlc_common.h>
29 #include "vlc_playlist.h"
30 #include "playlist_internal.h"
31
32 /***************************************************************************
33  * Item search functions
34  ***************************************************************************/
35
36 /**
37  * Search a playlist item by its playlist_item id
38  *
39  * \param p_playlist the playlist
40  * \param i_id the id to find
41  * \return the item or NULL on failure
42  */
43 playlist_item_t * playlist_ItemGetById( playlist_t * p_playlist , int i_id,
44                                         bool b_locked )
45 {
46     int i;
47     PL_LOCK_IF( !b_locked );
48     ARRAY_BSEARCH( p_playlist->all_items,->i_id, int, i_id, i );
49     if( i != -1 )
50     {
51         PL_UNLOCK_IF( !b_locked );
52         return ARRAY_VAL( p_playlist->all_items, i );
53     }
54     PL_UNLOCK_IF( !b_locked );
55     return NULL;
56 }
57
58 /**
59  * Search an item by its input_item_t
60  *
61  * \param p_playlist the playlist
62  * \param p_item the input_item_t to find
63  * \return the item, or NULL on failure
64  */
65 playlist_item_t * playlist_ItemGetByInput( playlist_t * p_playlist ,
66                                            input_item_t *p_item,
67                                            bool b_locked )
68 {
69     int i;
70     PL_LOCK_IF( !b_locked );
71     if( get_current_status_item( p_playlist ) &&
72         get_current_status_item( p_playlist )->p_input == p_item )
73     {
74         /* FIXME: this is potentially dangerous, we could destroy
75          * p_ret any time soon */
76         playlist_item_t *p_ret = get_current_status_item( p_playlist );
77         PL_UNLOCK_IF( !b_locked );
78         return p_ret;
79     }
80     /** \todo Check if this is always incremental and whether we can bsearch */
81     for( i =  0 ; i < p_playlist->all_items.i_size; i++ )
82     {
83         if( ARRAY_VAL(p_playlist->all_items, i)->p_input->i_id == p_item->i_id )
84         {
85             PL_UNLOCK_IF( !b_locked );
86             return ARRAY_VAL(p_playlist->all_items, i);
87         }
88     }
89     PL_UNLOCK_IF( !b_locked );
90     return NULL;
91 }
92
93
94 /**
95  * Get input by item id
96  *
97  * Find the playlist item matching the input id under the given node
98  * \param p_playlist the playlist
99  * \param i_input_id the id of the input to find
100  * \param p_root the root node of the search
101  * \return the playlist item or NULL on failure
102  */
103 playlist_item_t * playlist_ItemGetByInputId( playlist_t *p_playlist,
104                                              int i_input_id,
105                                              playlist_item_t *p_root )
106 {
107     int i;
108     PL_ASSERT_LOCKED;
109     assert( p_root != NULL );
110     for( i = 0 ; i< p_root->i_children ; i++ )
111     {
112         if( p_root->pp_children[i]->p_input &&
113             p_root->pp_children[i]->p_input->i_id == i_input_id )
114         {
115             return p_root->pp_children[i];
116         }
117         else if( p_root->pp_children[i]->i_children >= 0 )
118         {
119             return playlist_ItemGetByInputId( p_playlist, i_input_id,
120                                               p_root->pp_children[i] );
121         }
122     }
123     return NULL;
124 }
125
126 /***************************************************************************
127  * Live search handling
128  ***************************************************************************/
129
130 /**
131  * Enable all items in the playlist
132  * @param p_root: the current root item
133  */
134 static void playlist_LiveSearchClean( playlist_item_t *p_root )
135 {
136     for( int i = 0; i < p_root->i_children; i++ )
137     {
138         playlist_item_t *p_item = p_root->pp_children[i];
139         if( p_item->i_children >= 0 )
140             playlist_LiveSearchClean( p_item );
141         p_item->i_flags &= ~PLAYLIST_DBL_FLAG;
142     }
143 }
144
145
146 /**
147  * Enable/Disable items in the playlist according to the search argument
148  * @param p_root: the current root item
149  * @param psz_string: the string to search
150  * @return true if an item match
151  */
152 static bool playlist_LiveSearchUpdateInternal( playlist_item_t *p_root,
153                                                const char *psz_string )
154 {
155     int i;
156     bool b_match = false;
157     for( i = 0 ; i < p_root->i_children ; i ++ )
158     {
159         bool b_enable = false;
160         playlist_item_t *p_item = p_root->pp_children[i];
161         // Go recurssively if their is some children
162         if( p_item->i_children >= 0 &&
163             playlist_LiveSearchUpdateInternal( p_item, psz_string ) )
164         {
165             b_enable = true;
166         }
167
168         if( !b_enable )
169         {
170             vlc_mutex_lock( &p_item->p_input->lock );
171             // Do we have some meta ?
172             if( p_item->p_input->p_meta )
173             {
174                 // Use Title or fall back to psz_name
175                 const char *psz_title = vlc_meta_Get( p_item->p_input->p_meta, vlc_meta_Title );
176                 if( !psz_title )
177                     psz_title = p_item->p_input->psz_name;
178                 const char *psz_album = vlc_meta_Get( p_item->p_input->p_meta, vlc_meta_Album );
179                 const char *psz_artist = vlc_meta_Get( p_item->p_input->p_meta, vlc_meta_Artist );
180                 b_enable = ( psz_title && strcasestr( psz_title, psz_string ) ) ||
181                            ( psz_album && strcasestr( psz_album, psz_string ) ) ||
182                            ( psz_artist && strcasestr( psz_artist, psz_string ) );
183             }
184             else
185                 b_enable = p_item->p_input->psz_name && strcasestr( p_item->p_input->psz_name, psz_string );
186             vlc_mutex_unlock( &p_item->p_input->lock );
187         }
188
189         if( b_enable )
190             p_item->i_flags &= ~PLAYLIST_DBL_FLAG;
191         else
192             p_item->i_flags |= PLAYLIST_DBL_FLAG;
193
194         b_match |= b_enable;
195    }
196    return b_match;
197 }
198
199
200
201 /**
202  * Launch the recursive search in the playlist
203  * @param p_playlist: the playlist
204  * @param p_root: the current root item
205  * @param psz_string: the string to find
206  * @return VLC_SUCCESS
207  */
208 int playlist_LiveSearchUpdate( playlist_t *p_playlist, playlist_item_t *p_root,
209                                const char *psz_string )
210 {
211     PL_ASSERT_LOCKED;
212     pl_priv(p_playlist)->b_reset_currently_playing = true;
213     if( *psz_string )
214         playlist_LiveSearchUpdateInternal( p_root, psz_string );
215     else
216         playlist_LiveSearchClean( p_root );
217     vlc_cond_signal( &pl_priv(p_playlist)->signal );
218     return VLC_SUCCESS;
219 }
220