X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fplaylist%2Fsort.c;h=e125b0d112cc639e5b3af8ebdf644526092cf565;hb=12ade3e3bc975d5426ba4af155b7372c31093b31;hp=8b4f152e9d71561b662f16f4cc8464283a92b678;hpb=c1788de6cb5edab674b2b4a98baa27bb17f912b9;p=vlc diff --git a/src/playlist/sort.c b/src/playlist/sort.c index 8b4f152e9d..e125b0d112 100644 --- a/src/playlist/sort.c +++ b/src/playlist/sort.c @@ -1,11 +1,12 @@ /***************************************************************************** * sort.c : Playlist sorting functions ***************************************************************************** - * Copyright (C) 1999-2007 the VideoLAN team + * Copyright (C) 1999-2009 the VideoLAN team * $Id$ * * Authors: Clément Stenac * Ilkka Ollakka + * Rémi Duraffort * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -17,39 +18,164 @@ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include +#include +#define VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS #include "vlc_playlist.h" #include "playlist_internal.h" -static int playlist_ItemArraySort( playlist_t *p_playlist, int i_items, - playlist_item_t **pp_items, int i_mode, - int i_type ); -static int playlist_cmp(const void *, const void *); +/* General comparison functions */ +/** + * Compare two items using their title or name + * @param first: the first item + * @param second: the second item + * @return -1, 0 or 1 like strcmp + */ +static inline int meta_strcasecmp_title( const playlist_item_t *first, + const playlist_item_t *second ) +{ + int i_ret; + char *psz_first = input_item_GetTitleFbName( first->p_input ); + char *psz_second = input_item_GetTitleFbName( second->p_input ); + + if( psz_first && psz_second ) + i_ret = strcasecmp( psz_first, psz_second ); + else if( !psz_first && psz_second ) + i_ret = 1; + else if( psz_first && !psz_second ) + i_ret = -1; + else + i_ret = 0; + free( psz_first ); + free( psz_second ); + + return i_ret; +} + +/** + * Compare two intems accoring to the given meta type + * @param first: the first item + * @param second: the second item + * @param meta: the meta type to use to sort the items + * @param b_integer: true if the meta are integers + * @return -1, 0 or 1 like strcmp + */ +static inline int meta_sort( const playlist_item_t *first, + const playlist_item_t *second, + vlc_meta_type_t meta, bool b_integer ) +{ + int i_ret; + char *psz_first = input_item_GetMeta( first->p_input, meta ); + char *psz_second = input_item_GetMeta( second->p_input, meta ); + + /* Nodes go first */ + if( first->i_children == -1 && second->i_children >= 0 ) + i_ret = 1; + else if( first->i_children >= 0 && second->i_children == -1 ) + i_ret = -1; + /* Both are nodes, sort by name */ + else if( first->i_children >= 0 && second->i_children >= 0 ) + i_ret = meta_strcasecmp_title( first, second ); + /* Both are items */ + else if( !psz_first && psz_second ) + i_ret = 1; + else if( psz_first && !psz_second ) + i_ret = -1; + /* No meta, sort by name */ + else if( !psz_first && !psz_second ) + i_ret = meta_strcasecmp_title( first, second ); + else + { + if( b_integer ) + i_ret = atoi( psz_first ) - atoi( psz_second ); + else + i_ret = strcasecmp( psz_first, psz_second ); + } + + free( psz_first ); + free( psz_second ); + return i_ret; +} + +/* Comparison functions */ /** - * Sort a node. + * Return the comparison function appropriate for the SORT_* and ORDER_* + * arguments given, or NULL for SORT_RANDOM. + * @param i_mode: a SORT_* enum indicating the field to sort on + * @param i_type: ORDER_NORMAL or ORDER_REVERSE + * @return function pointer, or NULL for SORT_RANDOM or invalid input + */ +typedef int (*sortfn_t)(const void *,const void *); +static const sortfn_t sorting_fns[NUM_SORT_FNS][2]; +static inline sortfn_t find_sorting_fn( unsigned i_mode, unsigned i_type ) +{ + if( i_mode>=NUM_SORT_FNS || i_type>1 ) + return 0; + return sorting_fns[i_mode][i_type]; +} + +/** + * Sort an array of items recursively + * @param i_items: number of items + * @param pp_items: the array of items + * @param p_sortfn: the sorting function + * @return nothing + */ +static inline +void playlist_ItemArraySort( unsigned i_items, playlist_item_t **pp_items, + sortfn_t p_sortfn ) +{ + if( p_sortfn ) + { + qsort( pp_items, i_items, sizeof( pp_items[0] ), p_sortfn ); + } + else /* Randomise */ + { + unsigned i_position; + unsigned i_new; + playlist_item_t *p_temp; + + for( i_position = i_items - 1; i_position > 0; i_position-- ) + { + i_new = ((unsigned)vlc_mrand48()) % (i_position+1); + p_temp = pp_items[i_position]; + pp_items[i_position] = pp_items[i_new]; + pp_items[i_new] = p_temp; + } + } +} + + +/** + * Sort a node recursively. * This function must be entered with the playlist lock ! - * - * \param p_playlist the playlist - * \param p_node the node to sort - * \param i_mode: SORT_ID, SORT_TITLE, SORT_ARTIST, SORT_ALBUM, SORT_RANDOM - * \param i_type: ORDER_NORMAL or ORDER_REVERSE (reversed order) - * \return VLC_SUCCESS on success + * @param p_playlist the playlist + * @param p_node the node to sort + * @param p_sortfn the sorting function + * @return VLC_SUCCESS on success */ -static int playlist_NodeSort( playlist_t * p_playlist , playlist_item_t *p_node, - int i_mode, int i_type ) +static int recursiveNodeSort( playlist_t *p_playlist, playlist_item_t *p_node, + sortfn_t p_sortfn ) { - playlist_ItemArraySort( p_playlist,p_node->i_children, - p_node->pp_children, i_mode, i_type ); + int i; + playlist_ItemArraySort(p_node->i_children,p_node->pp_children,p_sortfn); + for( i = 0 ; i< p_node->i_children; i++ ) + { + if( p_node->pp_children[i]->i_children != -1 ) + { + recursiveNodeSort( p_playlist, p_node->pp_children[i], p_sortfn ); + } + } return VLC_SUCCESS; } @@ -60,214 +186,172 @@ static int playlist_NodeSort( playlist_t * p_playlist , playlist_item_t *p_node, * * \param p_playlist the playlist * \param p_node the node to sort - * \param i_mode: SORT_ID, SORT_TITLE, SORT_ARTIST, SORT_ALBUM, SORT_RANDOM + * \param i_mode: a SORT_* constant indicating the field to sort on * \param i_type: ORDER_NORMAL or ORDER_REVERSE (reversed order) * \return VLC_SUCCESS on success */ int playlist_RecursiveNodeSort( playlist_t *p_playlist, playlist_item_t *p_node, int i_mode, int i_type ) { - int i; - playlist_NodeSort( p_playlist, p_node, i_mode, i_type ); - for( i = 0 ; i< p_node->i_children; i++ ) - { - if( p_node->pp_children[i]->i_children != -1 ) - { - playlist_RecursiveNodeSort( p_playlist, p_node->pp_children[i], - i_mode,i_type ); - } - } - return VLC_SUCCESS; + /* Ask the playlist to reset as we are changing the order */ + pl_priv(p_playlist)->b_reset_currently_playing = true; + + /* Do the real job recursively */ + return recursiveNodeSort(p_playlist,p_node,find_sorting_fn(i_mode,i_type)); } -static int sort_mode = 0; -static int sort_type = 0; -static int playlist_ItemArraySort( playlist_t *p_playlist, int i_items, - playlist_item_t **pp_items, int i_mode, - int i_type ) +/* This is the stuff the sorting functions are made of. The proto_## + * functions are wrapped in cmp_a_## and cmp_d_## functions that do + * void * to const playlist_item_t * casting and dereferencing and + * cmp_d_## inverts the result, too. proto_## are static inline, + * cmp_[ad]_## are merely static as they're the target of pointers. + * + * In any case, each SORT_## constant (except SORT_RANDOM) must have + * a matching SORTFN( )-declared function here. + */ + +#define SORTFN( SORT, first, second ) static inline int proto_##SORT \ + ( const playlist_item_t *first, const playlist_item_t *second ) + +SORTFN( SORT_ALBUM, first, second ) { - int i_position; - playlist_item_t *p_temp; - vlc_value_t val; - val.b_bool = true; - sort_mode = i_mode; - sort_type = i_type; + int i_ret = meta_sort( first, second, vlc_meta_Album, false ); + /* Items came from the same album: compare the track numbers */ + if( i_ret == 0 ) + i_ret = meta_sort( first, second, vlc_meta_TrackNumber, true ); - (void)p_playlist; // a bit surprising we don't need p_playlist! + return i_ret; +} - if( i_mode == SORT_RANDOM ) - { - for( i_position = 0; i_position < i_items ; i_position ++ ) - { - int i_new; +SORTFN( SORT_ARTIST, first, second ) +{ + int i_ret = meta_sort( first, second, vlc_meta_Artist, false ); + /* Items came from the same artist: compare the albums */ + if( i_ret == 0 ) + i_ret = proto_SORT_ALBUM( first, second ); - if( i_items > 1 ) - i_new = rand() % (i_items - 1); - else - i_new = 0; - p_temp = pp_items[i_position]; - pp_items[i_position] = pp_items[i_new]; - pp_items[i_new] = p_temp; - } + return i_ret; +} - return VLC_SUCCESS; - } - qsort(pp_items,i_items,sizeof(pp_items[0]),playlist_cmp); - return VLC_SUCCESS; +SORTFN( SORT_DESCRIPTION, first, second ) +{ + return meta_sort( first, second, vlc_meta_Description, false ); } -static int playlist_cmp(const void *first, const void *second) +SORTFN( SORT_DURATION, first, second ) { + mtime_t time1 = input_item_GetDuration( first->p_input ); + mtime_t time2 = input_item_GetDuration( second->p_input ); + int i_ret = time1 > time2 ? 1 : + ( time1 == time2 ? 0 : -1 ); + return i_ret; +} -#define META_STRCASECMP_NAME( ) { \ - char *psz_i = input_item_GetName( (*(playlist_item_t **)first)->p_input ); \ - char *psz_ismall = input_item_GetName( (*(playlist_item_t **)second)->p_input ); \ - if( psz_i != NULL && psz_ismall != NULL ) i_test = strcasecmp( psz_i, psz_ismall ); \ - else if ( psz_i == NULL && psz_ismall != NULL ) i_test = 1; \ - else if ( psz_ismall == NULL && psz_i != NULL ) i_test = -1; \ - else i_test = 0; \ - free( psz_i ); \ - free( psz_ismall ); \ +SORTFN( SORT_GENRE, first, second ) +{ + return meta_sort( first, second, vlc_meta_Genre, false ); } +SORTFN( SORT_ID, first, second ) +{ + return first->i_id - second->i_id; +} -#define DO_META_SORT_ADV( node, integer ) { \ - char *psz_a = input_item_GetMeta( (*(playlist_item_t **)first)->p_input, vlc_meta_##node ); \ - char *psz_b = input_item_GetMeta( (*(playlist_item_t **)second)->p_input, vlc_meta_##node ); \ - /* Nodes go first */ \ - if( (*(playlist_item_t **)first)->i_children == -1 && (*(playlist_item_t **)second)->i_children >= 0 ) \ - i_test = 1;\ - else if( (*(playlist_item_t **)first)->i_children >= 0 &&\ - (*(playlist_item_t **)second)->i_children == -1 ) \ - i_test = -1; \ - /* Both are nodes, sort by name */ \ - else if( (*(playlist_item_t **)first)->i_children >= 0 && \ - (*(playlist_item_t **)second)->i_children >= 0 ) \ - { \ - META_STRCASECMP_NAME( ) \ - } \ - /* Both are items */ \ - else if( psz_a == NULL && psz_b != NULL ) \ - i_test = 1; \ - else if( psz_a != NULL && psz_b == NULL ) \ - i_test = -1;\ - /* No meta, sort by name */ \ - else if( psz_a == NULL && psz_b == NULL ) \ - { \ - META_STRCASECMP_NAME( ); \ - } \ - else \ - { \ - if( !integer ) i_test = strcasecmp( psz_a, psz_b ); \ - else i_test = atoi( psz_a ) - atoi( psz_b ); \ - } \ - free( psz_a ); \ - free( psz_b ); \ +SORTFN( SORT_RATING, first, second ) +{ + return meta_sort( first, second, vlc_meta_Rating, true ); } -#define DO_META_SORT( node ) DO_META_SORT_ADV( node, false ) - int i_test = 0; +SORTFN( SORT_TITLE, first, second ) +{ + return meta_strcasecmp_title( first, second ); +} - if( sort_mode == SORT_TITLE ) - { - META_STRCASECMP_NAME( ); - } - else if( sort_mode == SORT_TITLE_NUMERIC ) - { - char *psz_i = input_item_GetName( (*(playlist_item_t **)first)->p_input ); - char *psz_ismall = - input_item_GetName( (*(playlist_item_t **)second)->p_input ); - i_test = atoi( psz_i ) - atoi( psz_ismall ); - free( psz_i ); - free( psz_ismall ); - } - else if( sort_mode == SORT_DURATION ) - { - i_test = input_item_GetDuration( (*(playlist_item_t **)first)->p_input ) - - input_item_GetDuration( (*(playlist_item_t **)second)->p_input ); - } - else if( sort_mode == SORT_ARTIST ) - { - DO_META_SORT( Artist ); - /* sort by artist, album, tracknumber */ - if( i_test == 0 ) - DO_META_SORT( Album ); - if( i_test == 0 ) - DO_META_SORT_ADV( TrackNumber, true ); - } - else if( sort_mode == SORT_GENRE ) - { - DO_META_SORT( Genre ); - } - else if( sort_mode == SORT_ALBUM ) - { - DO_META_SORT( Album ); - /* Sort by tracknumber if albums are the same */ - if( i_test == 0 ) - DO_META_SORT_ADV( TrackNumber, true ); - } - else if( sort_mode == SORT_TRACK_NUMBER ) - { - DO_META_SORT_ADV( TrackNumber, true ); - } - else if( sort_mode == SORT_DESCRIPTION ) - { - DO_META_SORT( Description ); - } - else if( sort_mode == SORT_ID ) - { - i_test = (*(playlist_item_t **)first)->i_id - (*(playlist_item_t **)second)->i_id; - } - else if( sort_mode == SORT_TITLE_NODES_FIRST ) - { - /* Alphabetic sort, all nodes first */ +SORTFN( SORT_TITLE_NODES_FIRST, first, second ) +{ + /* If first is a node but not second */ + if( first->i_children == -1 && second->i_children >= 0 ) + return -1; + /* If second is a node but not first */ + else if( first->i_children >= 0 && second->i_children == -1 ) + return 1; + /* Both are nodes or both are not nodes */ + else + return meta_strcasecmp_title( first, second ); +} - if( (*(playlist_item_t **)first)->i_children == -1 && - (*(playlist_item_t **)second)->i_children >= 0 ) - { - i_test = 1; - } - else if( (*(playlist_item_t **)first)->i_children >= 0 && - (*(playlist_item_t **)second)->i_children == -1 ) - { - i_test = -1; - } - else - { - if ( (*(playlist_item_t **)first)->p_input->psz_name != NULL && - (*(playlist_item_t **)second)->p_input->psz_name != NULL ) - { - i_test = strcasecmp( (*(playlist_item_t **)first)->p_input->psz_name, - (*(playlist_item_t **)second)->p_input->psz_name ); - } - else if ( (*(playlist_item_t **)first)->p_input->psz_name != NULL && - (*(playlist_item_t **)second)->p_input->psz_name == NULL ) - { - i_test = 1; - } - else if ( (*(playlist_item_t **)first)->p_input->psz_name == NULL && - (*(playlist_item_t **)second)->p_input->psz_name != NULL ) - { - i_test = -1; - } - else i_test = 0; - } - } - else if( sort_mode == SORT_URI ) - { - char *psz_i = input_item_GetURI( (*(playlist_item_t **)first)->p_input ); - char *psz_ismall = - input_item_GetURI( (*(playlist_item_t **)second)->p_input ); - i_test = strcasecmp( psz_i, psz_ismall ); - free( psz_i ); - free( psz_ismall ); - } +SORTFN( SORT_TITLE_NUMERIC, first, second ) +{ + int i_ret; + char *psz_first = input_item_GetTitleFbName( first->p_input ); + char *psz_second = input_item_GetTitleFbName( second->p_input ); + + if( psz_first && psz_second ) + i_ret = atoi( psz_first ) - atoi( psz_second ); + else if( !psz_first && psz_second ) + i_ret = 1; + else if( psz_first && !psz_second ) + i_ret = -1; + else + i_ret = 0; - if ( sort_type == ORDER_REVERSE ) - i_test = i_test * -1; -#undef DO_META_SORT -#undef DO_META_SORT_ADV + free( psz_first ); + free( psz_second ); + return i_ret; +} - return i_test; +SORTFN( SORT_TRACK_NUMBER, first, second ) +{ + return meta_sort( first, second, vlc_meta_TrackNumber, true ); } + +SORTFN( SORT_URI, first, second ) +{ + int i_ret; + char *psz_first = input_item_GetURI( first->p_input ); + char *psz_second = input_item_GetURI( second->p_input ); + + if( psz_first && psz_second ) + i_ret = strcasecmp( psz_first, psz_second ); + else if( !psz_first && psz_second ) + i_ret = 1; + else if( psz_first && !psz_second ) + i_ret = -1; + else + i_ret = 0; + + free( psz_first ); + free( psz_second ); + return i_ret; +} + +#undef SORTFN + +/* Generate stubs around the proto_## sorting functions, ascending and + * descending both. Preprocessor magic up ahead. Brace yourself. + */ + +#ifndef VLC_DEFINE_SORT_FUNCTIONS +#error Where is VLC_DEFINE_SORT_FUNCTIONS? +#endif + +#define DEF( s ) \ + static int cmp_a_##s(const void *l,const void *r) \ + { return proto_##s(*(const playlist_item_t *const *)l, \ + *(const playlist_item_t *const *)r); } \ + static int cmp_d_##s(const void *l,const void *r) \ + { return -1*proto_##s(*(const playlist_item_t * const *)l, \ + *(const playlist_item_t * const *)r); } + + VLC_DEFINE_SORT_FUNCTIONS + +#undef DEF + +/* And populate an array with the addresses */ + +static const sortfn_t sorting_fns[NUM_SORT_FNS][2] = +#define DEF( a ) { cmp_a_##a, cmp_d_##a }, +{ VLC_DEFINE_SORT_FUNCTIONS }; +#undef DEF +