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 static void GuessType( input_item_t *p_item);
  33
  34 /**
  35  * Create a new item, without adding it to the playlist
  36  *
  37  * \param p_obj a vlc object (anyone will do)
  38  * \param psz_uri the mrl of the item
  39  * \param psz_name a text giving a name or description of the item
  40  * \return the new item or NULL on failure
  41  */
  42 playlist_item_t * __playlist_ItemNew( vlc_object_t *p_obj,
  43                                       const char *psz_uri,
  44                                       const char *psz_name )
  45 {
  46     playlist_item_t * p_item;
  47
  48     if( psz_uri == NULL) return NULL;
  49
  50     p_item = malloc( sizeof( playlist_item_t ) );
  51     if( p_item == NULL ) return NULL;
  52
  53     memset( p_item, 0, sizeof( playlist_item_t ) );
  54
  55     p_item->input.psz_uri = strdup( psz_uri );
  56
  57     if( psz_name != NULL ) p_item->input.psz_name = strdup( psz_name );
  58     else p_item->input.psz_name = strdup ( psz_uri );
  59
  60     p_item->b_enabled = VLC_TRUE;
  61     p_item->i_nb_played = 0;
  62
  63     p_item->i_children = -1;
  64     p_item->pp_children = NULL;
  65
  66     p_item->i_flags = 0;
  67     p_item->i_flags |= PLAYLIST_SKIP_FLAG;
  68
  69     p_item->input.i_duration = -1;
  70     p_item->input.ppsz_options = NULL;
  71     p_item->input.i_options = 0;
  72
  73     vlc_mutex_init( p_obj, &p_item->input.lock );
  74
  75     GuessType( &p_item->input );
  76
  77     playlist_ItemCreateCategory( p_item, _("General") );
  78
  79     return p_item;
  80 }
  81
  82 /**
  83  * Deletes a playlist item
  84  *
  85  * \param p_item the item to delete
  86  * \return nothing
  87  */
  88 int playlist_ItemDelete( playlist_item_t *p_item )
  89 {
  90     vlc_mutex_lock( &p_item->input.lock );
  91
  92     if( p_item->input.psz_name ) free( p_item->input.psz_name );
  93     if( p_item->input.psz_uri ) free( p_item->input.psz_uri );
  94
  95     /* Free the info categories */
  96     if( p_item->input.i_categories > 0 )
  97     {
  98         int i, j;
  99
 100         for( i = 0; i < p_item->input.i_categories; i++ )
 101         {
 102             info_category_t *p_category = p_item->input.pp_categories[i];
 103
 104             for( j = 0; j < p_category->i_infos; j++)
 105             {
 106                 if( p_category->pp_infos[j]->psz_name )
 107                 {
 108                     free( p_category->pp_infos[j]->psz_name);
 109                 }
 110                 if( p_category->pp_infos[j]->psz_value )
 111                 {
 112                     free( p_category->pp_infos[j]->psz_value );
 113                 }
 114                 free( p_category->pp_infos[j] );
 115             }
 116
 117             if( p_category->i_infos ) free( p_category->pp_infos );
 118             if( p_category->psz_name ) free( p_category->psz_name );
 119             free( p_category );
 120         }
 121
 122         free( p_item->input.pp_categories );
 123     }
 124
 125     for( ; p_item->input.i_options > 0; p_item->input.i_options-- )
 126     {
 127         free( p_item->input.ppsz_options[p_item->input.i_options - 1] );
 128         if( p_item->input.i_options == 1 ) free( p_item->input.ppsz_options );
 129     }
 130
 131     vlc_mutex_unlock( &p_item->input.lock );
 132     vlc_mutex_destroy( &p_item->input.lock );
 133
 134     free( p_item );
 135
 136     return VLC_SUCCESS;
 137 }
 138
 139 /**
 140  *  Add a option to one item ( no need for p_playlist )
 141  *
 142  * \param p_item the item on which we want the info
 143  * \param psz_option the option
 144  * \return 0 on success
 145  */
 146 int playlist_ItemAddOption( playlist_item_t *p_item, const char *psz_option )
 147 {
 148     if( !psz_option ) return VLC_EGENERIC;
 149
 150     vlc_mutex_lock( &p_item->input.lock );
 151     INSERT_ELEM( p_item->input.ppsz_options, p_item->input.i_options,
 152                  p_item->input.i_options, strdup( psz_option ) );
 153     vlc_mutex_unlock( &p_item->input.lock );
 154
 155     return VLC_SUCCESS;
 156 }
 157
 158 /**
 159  * Add a parent to an item
 160  *
 161  * \param p_item the item
 162  * \param i_view the view in which the parent is
 163  * \param p_parent the parent to add
 164  * \return nothing
 165  */
 166 int playlist_ItemAddParent( playlist_item_t *p_item, int i_view,
 167                             playlist_item_t *p_parent )
 168 {
 169    vlc_bool_t b_found = VLC_FALSE;
 170    int i;
 171
 172    for( i= 0; i< p_item->i_parents ; i++ )
 173    {
 174        if( p_item->pp_parents[i]->i_view == i_view )
 175
 176        {
 177            b_found = VLC_TRUE;
 178            break;
 179        }
 180    }
 181    if( b_found == VLC_FALSE )
 182    {
 183
 184        struct item_parent_t *p_ip = (struct item_parent_t *)
 185                malloc(sizeof(struct item_parent_t) );
 186        p_ip->i_view = i_view;
 187        p_ip->p_parent = p_parent;
 188
 189        INSERT_ELEM( p_item->pp_parents,
 190                     p_item->i_parents, p_item->i_parents,
 191                     p_ip );
 192    }
 193    return VLC_SUCCESS;
 194 }
 195
 196 /**
 197  * Copy all parents from parent to child
 198  */
 199 int playlist_CopyParents( playlist_item_t *p_parent,
 200                            playlist_item_t *p_child )
 201 {
 202     int i=0;
 203     for( i= 0 ; i< p_parent->i_parents; i ++ )
 204     {
 205         playlist_ItemAddParent( p_child,
 206                                 p_parent->pp_parents[i]->i_view,
 207                                 p_parent );
 208     }
 209     return VLC_SUCCESS;
 210 }
 211
 212
 213 /**********************************************************************
 214  * playlist_item_t structure accessors
 215  * These functions give access to the fields of the playlist_item_t
 216  * structure
 217  **********************************************************************/
 218
 219
 220 /**
 221  * Set the name of a playlist item
 222  *
 223  * \param p_item the item
 224  * \param psz_name the new name
 225  * \return VLC_SUCCESS on success, VLC_EGENERIC on failure
 226  */
 227 int playlist_ItemSetName( playlist_item_t *p_item, char *psz_name )
 228 {
 229     if( psz_name && p_item )
 230     {
 231         p_item->input.psz_name = strdup( psz_name );
 232         return VLC_SUCCESS;
 233     }
 234     return VLC_EGENERIC;
 235 }
 236
 237 /**
 238  * Set the duration of a playlist item
 239  * This function must be entered with the item lock
 240  *
 241  * \param p_item the item
 242  * \param i_duration the new duration
 243  * \return VLC_SUCCESS on success, VLC_EGENERIC on failure
 244  */
 245 int playlist_ItemSetDuration( playlist_item_t *p_item, mtime_t i_duration )
 246 {
 247     char psz_buffer[MSTRTIME_MAX_SIZE];
 248     if( p_item )
 249     {
 250         p_item->input.i_duration = i_duration;
 251         if( i_duration != -1 )
 252         {
 253             secstotimestr( psz_buffer, (int)(i_duration/1000000) );
 254         }
 255         else
 256         {
 257             memcpy( psz_buffer, "--:--:--", sizeof("--:--:--") );
 258         }
 259         playlist_ItemAddInfo( p_item, _("General") , _("Duration"),
 260                               "%s", psz_buffer );
 261
 262         return VLC_SUCCESS;
 263     }
 264     return VLC_EGENERIC;
 265 }
 266
 267 /*
 268  * Guess the type of the item using the beginning of the mrl */
 269 static void GuessType( input_item_t *p_item)
 270 {
 271     int i;
 272     static struct { char *psz_search; int i_type; }  types_array[] =
 273     {
 274         { "http", ITEM_TYPE_NET },
 275         { "dvd", ITEM_TYPE_DISC },
 276         { "cdda", ITEM_TYPE_DISC },
 277         { "mms", ITEM_TYPE_NET },
 278         { "rtsp", ITEM_TYPE_NET },
 279         { "udp", ITEM_TYPE_NET },
 280         { "rtp", ITEM_TYPE_NET },
 281         { "vcd", ITEM_TYPE_DISC },
 282         { "v4l", ITEM_TYPE_CARD },
 283         { "dshow", ITEM_TYPE_CARD },
 284         { "pvr", ITEM_TYPE_CARD },
 285         { "dvb", ITEM_TYPE_CARD },
 286         { "qpsk", ITEM_TYPE_CARD },
 287         { "sdp", ITEM_TYPE_NET },
 288         { NULL, 0 }
 289     };
 290
 291     for( i = 0; types_array[i].psz_search != NULL; i++ )
 292     {
 293         if( !strncmp( p_item->psz_uri, types_array[i].psz_search,
 294                       strlen( types_array[i].psz_search ) ) )
 295         {
 296             p_item->i_type = types_array[i].i_type;
 297             return;
 298         }
 299     }
 300     p_item->i_type = ITEM_TYPE_UNKNOWN;
 301 }