git.sesse.net Git - vlc/blob - src/playlist/item.c

   1 /*****************************************************************************
   2  * item.c : Playlist item functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 VideoLAN
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23 #include <stdlib.h>                                      /* free(), strtol() */
  24 #include <stdio.h>                                              /* sprintf() */
  25 #include <string.h>                                            /* strerror() */
  26
  27 #include <vlc/vlc.h>
  28 #include <vlc/input.h>
  29
  30 #include "vlc_playlist.h"
  31
  32 /**
  33  * Create a new item, without adding it to the playlist
  34  *
  35  * \param p_obj a vlc object (anyone will do)
  36  * \param psz_uri the mrl of the item
  37  * \param psz_name a text giving a name or description of the item
  38  * \return the new item or NULL on failure
  39  */
  40 playlist_item_t * __playlist_ItemNew( vlc_object_t *p_obj,
  41                                       const char *psz_uri,
  42                                       const char *psz_name )
  43 {
  44     playlist_item_t * p_item;
  45
  46     p_item = malloc( sizeof( playlist_item_t ) );
  47     if( p_item == NULL ) return NULL;
  48     if( psz_uri == NULL) return NULL;
  49
  50     memset( p_item, 0, sizeof( playlist_item_t ) );
  51
  52     p_item->input.psz_uri = strdup( psz_uri );
  53
  54     if( psz_name != NULL ) p_item->input.psz_name = strdup( psz_name );
  55     else p_item->input.psz_name = strdup ( psz_uri );
  56
  57     p_item->b_enabled = VLC_TRUE;
  58     p_item->i_group = PLAYLIST_TYPE_MANUAL;
  59     p_item->i_nb_played = 0;
  60
  61     p_item->input.i_duration = -1;
  62     p_item->input.ppsz_options = NULL;
  63     p_item->input.i_options = 0;
  64
  65     vlc_mutex_init( p_obj, &p_item->input.lock );
  66
  67     playlist_ItemCreateCategory( p_item, _("General") );
  68     return p_item;
  69 }
  70
  71 /**
  72  * Deletes a playlist item
  73  *
  74  * \param p_item the item to delete
  75  * \return nothing
  76  */
  77 void playlist_ItemDelete( playlist_item_t *p_item )
  78 {
  79     vlc_mutex_lock( &p_item->input.lock );
  80
  81     if( p_item->input.psz_name ) free( p_item->input.psz_name );
  82     if( p_item->input.psz_uri ) free( p_item->input.psz_uri );
  83
  84     /* Free the info categories */
  85     if( p_item->input.i_categories > 0 )
  86     {
  87         int i, j;
  88
  89         for( i = 0; i < p_item->input.i_categories; i++ )
  90         {
  91             info_category_t *p_category = p_item->input.pp_categories[i];
  92
  93             for( j = 0; j < p_category->i_infos; j++)
  94             {
  95                 if( p_category->pp_infos[j]->psz_name )
  96                 {
  97                     free( p_category->pp_infos[j]->psz_name);
  98                 }
  99                 if( p_category->pp_infos[j]->psz_value )
 100                 {
 101                     free( p_category->pp_infos[j]->psz_value );
 102                 }
 103                 free( p_category->pp_infos[j] );
 104             }
 105
 106             if( p_category->i_infos ) free( p_category->pp_infos );
 107             if( p_category->psz_name ) free( p_category->psz_name );
 108             free( p_category );
 109         }
 110
 111         free( p_item->input.pp_categories );
 112     }
 113
 114     for( ; p_item->input.i_options > 0; p_item->input.i_options-- )
 115     {
 116         free( p_item->input.ppsz_options[p_item->input.i_options - 1] );
 117         if( p_item->input.i_options == 1 ) free( p_item->input.ppsz_options );
 118     }
 119
 120     vlc_mutex_unlock( &p_item->input.lock );
 121     vlc_mutex_destroy( &p_item->input.lock );
 122
 123     free( p_item );
 124 }
 125
 126 /**
 127  * Add a playlist item into a playlist
 128  *
 129  * \param p_playlist the playlist to insert into
 130  * \param p_item the playlist item to insert
 131  * \param i_mode the mode used when adding
 132  * \param i_pos the possition in the playlist where to add. If this is
 133  *        PLAYLIST_END the item will be added at the end of the playlist
 134  *        regardless of it's size
 135  * \return The id of the playlist item
 136  */
 137 int playlist_AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
 138                       int i_mode, int i_pos)
 139 {
 140     vlc_value_t val;
 141
 142     vlc_mutex_lock( &p_playlist->object_lock );
 143
 144     /*
 145      * CHECK_INSERT : checks if the item is already enqued before
 146      * enqueing it
 147      */
 148     if ( i_mode & PLAYLIST_CHECK_INSERT )
 149     {
 150          int j;
 151
 152          if ( p_playlist->pp_items )
 153          {
 154              for ( j = 0; j < p_playlist->i_size; j++ )
 155              {
 156                  if ( !strcmp( p_playlist->pp_items[j]->input.psz_uri,
 157                                p_item->input.psz_uri ) )
 158                  {
 159                       if ( p_item->input.psz_name )
 160                       {
 161                           free( p_item->input.psz_name );
 162                       }
 163                       if ( p_item->input.psz_uri )
 164                       {
 165                           free ( p_item->input.psz_uri );
 166                       }
 167                       free( p_item );
 168                       vlc_mutex_unlock( &p_playlist->object_lock );
 169                       return -1;
 170                  }
 171              }
 172          }
 173          i_mode &= ~PLAYLIST_CHECK_INSERT;
 174          i_mode |= PLAYLIST_APPEND;
 175     }
 176
 177     msg_Dbg( p_playlist, "adding playlist item `%s' ( %s )",
 178              p_item->input.psz_name, p_item->input.psz_uri );
 179
 180     p_item->i_id = ++p_playlist->i_last_id;
 181
 182     /* Do a few boundary checks and allocate space for the item */
 183     if( i_pos == PLAYLIST_END )
 184     {
 185         if( i_mode & PLAYLIST_INSERT )
 186         {
 187             i_mode &= ~PLAYLIST_INSERT;
 188             i_mode |= PLAYLIST_APPEND;
 189         }
 190
 191         i_pos = p_playlist->i_size - 1;
 192     }
 193
 194     if( !(i_mode & PLAYLIST_REPLACE)
 195          || i_pos < 0 || i_pos >= p_playlist->i_size )
 196     {
 197         /* Additional boundary checks */
 198         if( i_mode & PLAYLIST_APPEND )
 199         {
 200             i_pos++;
 201         }
 202
 203         if( i_pos < 0 )
 204         {
 205             i_pos = 0;
 206         }
 207         else if( i_pos > p_playlist->i_size )
 208         {
 209             i_pos = p_playlist->i_size;
 210         }
 211
 212         INSERT_ELEM( p_playlist->pp_items, p_playlist->i_size, i_pos, p_item );
 213         p_playlist->i_enabled ++;
 214
 215         if( p_playlist->i_index >= i_pos )
 216         {
 217             p_playlist->i_index++;
 218         }
 219     }
 220     else
 221     {
 222         /* i_mode == PLAYLIST_REPLACE and 0 <= i_pos < p_playlist->i_size */
 223         if( p_playlist->pp_items[i_pos]->input.psz_name )
 224         {
 225             free( p_playlist->pp_items[i_pos]->input.psz_name );
 226         }
 227         if( p_playlist->pp_items[i_pos]->input.psz_uri )
 228         {
 229             free( p_playlist->pp_items[i_pos]->input.psz_uri );
 230         }
 231         /* XXX: what if the item is still in use? */
 232         free( p_playlist->pp_items[i_pos] );
 233         p_playlist->pp_items[i_pos] = p_item;
 234     }
 235
 236     if( i_mode & PLAYLIST_GO )
 237     {
 238         p_playlist->i_index = i_pos;
 239         if( p_playlist->p_input )
 240         {
 241             input_StopThread( p_playlist->p_input );
 242         }
 243         p_playlist->i_status = PLAYLIST_RUNNING;
 244     }
 245
 246     vlc_mutex_unlock( &p_playlist->object_lock );
 247
 248     val.b_bool = VLC_TRUE;
 249     var_Set( p_playlist, "intf-change", val );
 250
 251     return p_item->i_id;
 252 }
 253
 254 /**
 255  *  Add a option to one item ( no need for p_playlist )
 256  *
 257  * \param p_item the item on which we want the info
 258  * \param psz_option the option
 259  * \return 0 on success
 260  */
 261 int playlist_ItemAddOption( playlist_item_t *p_item, const char *psz_option )
 262 {
 263     if( !psz_option ) return VLC_EGENERIC;
 264
 265     vlc_mutex_lock( &p_item->input.lock );
 266     INSERT_ELEM( p_item->input.ppsz_options, p_item->input.i_options,
 267                  p_item->input.i_options, strdup( psz_option ) );
 268     vlc_mutex_unlock( &p_item->input.lock );
 269
 270     return VLC_SUCCESS;
 271 }