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     for( ; p_item->i_parents > 0 ; )
 132     {
 133         struct item_parent_t *p_parent =  p_item->pp_parents[0];
 134         REMOVE_ELEM( p_item->pp_parents, p_item->i_parents, 0 );
 135         free( p_parent );
 136     }
 137
 138     vlc_mutex_unlock( &p_item->input.lock );
 139     vlc_mutex_destroy( &p_item->input.lock );
 140
 141     free( p_item );
 142
 143     return VLC_SUCCESS;
 144 }
 145
 146 /**
 147  *  Add a option to one item ( no need for p_playlist )
 148  *
 149  * \param p_item the item on which we want the info
 150  * \param psz_option the option
 151  * \return 0 on success
 152  */
 153 int playlist_ItemAddOption( playlist_item_t *p_item, const char *psz_option )
 154 {
 155     if( !psz_option ) return VLC_EGENERIC;
 156
 157     vlc_mutex_lock( &p_item->input.lock );
 158     INSERT_ELEM( p_item->input.ppsz_options, p_item->input.i_options,
 159                  p_item->input.i_options, strdup( psz_option ) );
 160     vlc_mutex_unlock( &p_item->input.lock );
 161
 162     return VLC_SUCCESS;
 163 }
 164
 165 /**
 166  * Add a parent to an item
 167  *
 168  * \param p_item the item
 169  * \param i_view the view in which the parent is
 170  * \param p_parent the parent to add
 171  * \return nothing
 172  */
 173 int playlist_ItemAddParent( playlist_item_t *p_item, int i_view,
 174                             playlist_item_t *p_parent )
 175 {
 176    vlc_bool_t b_found = VLC_FALSE;
 177    int i;
 178
 179    for( i= 0; i< p_item->i_parents ; i++ )
 180    {
 181        if( p_item->pp_parents[i]->i_view == i_view )
 182
 183        {
 184            b_found = VLC_TRUE;
 185            break;
 186        }
 187    }
 188    if( b_found == VLC_FALSE )
 189    {
 190
 191        struct item_parent_t *p_ip = (struct item_parent_t *)
 192                malloc(sizeof(struct item_parent_t) );
 193        p_ip->i_view = i_view;
 194        p_ip->p_parent = p_parent;
 195
 196        INSERT_ELEM( p_item->pp_parents,
 197                     p_item->i_parents, p_item->i_parents,
 198                     p_ip );
 199    }
 200    return VLC_SUCCESS;
 201 }
 202
 203 /**
 204  * Copy all parents from parent to child
 205  */
 206 int playlist_CopyParents( playlist_item_t *p_parent,
 207                            playlist_item_t *p_child )
 208 {
 209     int i=0;
 210     for( i= 0 ; i< p_parent->i_parents; i ++ )
 211     {
 212         playlist_ItemAddParent( p_child,
 213                                 p_parent->pp_parents[i]->i_view,
 214                                 p_parent );
 215     }
 216     return VLC_SUCCESS;
 217 }
 218
 219
 220 /**********************************************************************
 221  * playlist_item_t structure accessors
 222  * These functions give access to the fields of the playlist_item_t
 223  * structure
 224  **********************************************************************/
 225
 226
 227 /**
 228  * Set the name of a playlist item
 229  *
 230  * \param p_item the item
 231  * \param psz_name the new name
 232  * \return VLC_SUCCESS on success, VLC_EGENERIC on failure
 233  */
 234 int playlist_ItemSetName( playlist_item_t *p_item, char *psz_name )
 235 {
 236     if( psz_name && p_item )
 237     {
 238         p_item->input.psz_name = strdup( psz_name );
 239         return VLC_SUCCESS;
 240     }
 241     return VLC_EGENERIC;
 242 }
 243
 244 /**
 245  * Set the duration of a playlist item
 246  * This function must be entered with the item lock
 247  *
 248  * \param p_item the item
 249  * \param i_duration the new duration
 250  * \return VLC_SUCCESS on success, VLC_EGENERIC on failure
 251  */
 252 int playlist_ItemSetDuration( playlist_item_t *p_item, mtime_t i_duration )
 253 {
 254     char psz_buffer[MSTRTIME_MAX_SIZE];
 255     if( p_item )
 256     {
 257         p_item->input.i_duration = i_duration;
 258         if( i_duration != -1 )
 259         {
 260             secstotimestr( psz_buffer, (int)(i_duration/1000000) );
 261         }
 262         else
 263         {
 264             memcpy( psz_buffer, "--:--:--", sizeof("--:--:--") );
 265         }
 266         playlist_ItemAddInfo( p_item, _("General") , _("Duration"),
 267                               "%s", psz_buffer );
 268
 269         return VLC_SUCCESS;
 270     }
 271     return VLC_EGENERIC;
 272 }
 273
 274 /*
 275  * Guess the type of the item using the beginning of the mrl */
 276 static void GuessType( input_item_t *p_item)
 277 {
 278     int i;
 279     static struct { char *psz_search; int i_type; }  types_array[] =
 280     {
 281         { "http", ITEM_TYPE_NET },
 282         { "dvd", ITEM_TYPE_DISC },
 283         { "cdda", ITEM_TYPE_DISC },
 284         { "mms", ITEM_TYPE_NET },
 285         { "rtsp", ITEM_TYPE_NET },
 286         { "udp", ITEM_TYPE_NET },
 287         { "rtp", ITEM_TYPE_NET },
 288         { "vcd", ITEM_TYPE_DISC },
 289         { "v4l", ITEM_TYPE_CARD },
 290         { "dshow", ITEM_TYPE_CARD },
 291         { "pvr", ITEM_TYPE_CARD },
 292         { "dvb", ITEM_TYPE_CARD },
 293         { "qpsk", ITEM_TYPE_CARD },
 294         { "sdp", ITEM_TYPE_NET },
 295         { NULL, 0 }
 296     };
 297
 298     for( i = 0; types_array[i].psz_search != NULL; i++ )
 299     {
 300         if( !strncmp( p_item->psz_uri, types_array[i].psz_search,
 301                       strlen( types_array[i].psz_search ) ) )
 302         {
 303             p_item->i_type = types_array[i].i_type;
 304             return;
 305         }
 306     }
 307     p_item->i_type = ITEM_TYPE_UNKNOWN;
 308 }