* playlist.c : Playlist management functions
*****************************************************************************
* Copyright (C) 1999-2001 VideoLAN
- * $Id: playlist.c,v 1.1 2002/06/01 12:32:02 sam Exp $
+ * $Id: playlist.c,v 1.32 2003/02/13 00:09:51 hartman Exp $
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
- *
+ *
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
#include <stdlib.h> /* free(), strtol() */
#include <stdio.h> /* sprintf() */
#include <string.h> /* strerror() */
-#include <errno.h> /* ENOMEM */
#include <vlc/vlc.h>
#include "stream_control.h"
#include "input_ext-intf.h"
-#include "playlist.h"
+#include "vlc_playlist.h"
-#define PLAYLIST_STOPPED 0
-#define PLAYLIST_RUNNING 1
+#define PLAYLIST_FILE_HEADER_0_5 "# vlc playlist file version 0.5"
+#ifdef WIN32
+# define PLAYLIST_FILE_EOL "\r\n"
+#else
+# define PLAYLIST_FILE_EOL "\n"
+#endif
/*****************************************************************************
* Local prototypes
*****************************************************************************/
static void RunThread ( playlist_t * );
+static void SkipItem ( playlist_t *, int );
+static void PlayItem ( playlist_t * );
+
+static void Poubellize ( playlist_t *, input_thread_t * );
/*****************************************************************************
* playlist_Create: create playlist
*****************************************************************************
* Create a playlist structure.
*****************************************************************************/
-playlist_t * playlist_Create ( vlc_object_t *p_parent )
+playlist_t * __playlist_Create ( vlc_object_t *p_parent )
{
playlist_t *p_playlist;
+ vlc_value_t val;
/* Allocate structure */
p_playlist = vlc_object_create( p_parent, VLC_OBJECT_PLAYLIST );
return NULL;
}
- vlc_object_attach( p_playlist, p_parent );
+ var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
+ val.b_bool = VLC_TRUE;
+ var_Set( p_playlist, "intf-change", val );
p_playlist->p_input = NULL;
- p_playlist->i_status = PLAYLIST_RUNNING;
+ p_playlist->i_status = PLAYLIST_STOPPED;
p_playlist->i_index = -1;
p_playlist->i_size = 0;
p_playlist->pp_items = NULL;
- vlc_mutex_init( p_playlist, &p_playlist->change_lock );
- if( vlc_thread_create( p_playlist, "playlist", RunThread, 0 ) )
+ if( vlc_thread_create( p_playlist, "playlist", RunThread,
+ VLC_THREAD_PRIORITY_LOW, VLC_TRUE ) )
{
msg_Err( p_playlist, "cannot spawn playlist thread" );
- vlc_mutex_destroy( &p_playlist->change_lock );
- vlc_object_unlink_all( p_playlist );
vlc_object_destroy( p_playlist );
return NULL;
}
+ /* The object has been initialized, now attach it */
+ vlc_object_attach( p_playlist, p_parent );
+
return p_playlist;
}
vlc_thread_join( p_playlist );
- vlc_mutex_destroy( &p_playlist->change_lock );
+ var_Destroy( p_playlist, "intf-change" );
+
vlc_object_destroy( p_playlist );
}
* Add an item to the playlist at position i_pos. If i_pos is PLAYLIST_END,
* add it at the end regardless of the playlist current size.
*****************************************************************************/
-int playlist_Add( vlc_object_t *p_this, int i_pos, const char * psz_item )
+int playlist_Add( playlist_t *p_playlist, const char * psz_target,
+ int i_mode, int i_pos )
{
- playlist_t *p_playlist;
+ playlist_item_t * p_item;
+
+ p_item = malloc( sizeof( playlist_item_t ) );
+ if( p_item == NULL )
+ {
+ msg_Err( p_playlist, "out of memory" );
+ }
+
+ p_item->psz_name = strdup( psz_target );
+ p_item->psz_uri = strdup( psz_target );
+ p_item->i_type = 0;
+ p_item->i_status = 0;
+ p_item->b_autodeletion = VLC_FALSE;
+
+ return playlist_AddItem( p_playlist, p_item, i_mode, i_pos );
+}
- p_playlist = vlc_object_find( p_this->p_vlc, VLC_OBJECT_PLAYLIST,
- FIND_CHILD );
- if( p_playlist == NULL )
+int playlist_AddItem( playlist_t *p_playlist, playlist_item_t * p_item,
+ int i_mode, int i_pos)
+{
+ vlc_value_t val;
+
+ vlc_mutex_lock( &p_playlist->object_lock );
+
+ /*
+ * CHECK_INSERT : checks if the item is already enqued before
+ * enqueing it
+ */
+ if ( i_mode & PLAYLIST_CHECK_INSERT )
{
- msg_Dbg( p_this, "no playlist present, creating one" );
- p_playlist = playlist_Create( p_this->p_vlc->p_this );
+ int j;
+
+ if ( p_playlist->pp_items )
+ {
+ for ( j = 0; j < p_playlist->i_size; j++ )
+ {
+ if ( !strcmp( p_playlist->pp_items[j]->psz_uri, p_item->psz_uri ) )
+ {
+ if( p_item->psz_name )
+ {
+ free( p_item->psz_name );
+ }
+ if( p_item->psz_uri )
+ {
+ free( p_item->psz_uri );
+ }
+ free( p_item );
+ vlc_mutex_unlock( &p_playlist->object_lock );
+ return 0;
+ }
+ }
+ }
+ i_mode &= ~PLAYLIST_CHECK_INSERT;
+ i_mode |= PLAYLIST_APPEND;
+ }
+
+
+ msg_Dbg( p_playlist, "adding playlist item « %s »", p_item->psz_name );
+
+ /* Create the new playlist item */
- if( p_playlist == NULL )
+
+ /* Do a few boundary checks and allocate space for the item */
+ if( i_pos == PLAYLIST_END )
+ {
+ if( i_mode & PLAYLIST_INSERT )
{
- return VLC_EGENERIC;
+ i_mode &= ~PLAYLIST_INSERT;
+ i_mode |= PLAYLIST_APPEND;
}
- vlc_object_yield( p_playlist );
+ i_pos = p_playlist->i_size - 1;
}
- msg_Warn( p_this, "adding playlist item « %s »", psz_item );
+ if( !(i_mode & PLAYLIST_REPLACE)
+ || i_pos < 0 || i_pos >= p_playlist->i_size )
+ {
+ /* Additional boundary checks */
+ if( i_mode & PLAYLIST_APPEND )
+ {
+ i_pos++;
+ }
- vlc_mutex_lock( &p_playlist->change_lock );
+ if( i_pos < 0 )
+ {
+ i_pos = 0;
+ }
+ else if( i_pos > p_playlist->i_size )
+ {
+ i_pos = p_playlist->i_size;
+ }
+
+ INSERT_ELEM( p_playlist->pp_items,
+ p_playlist->i_size,
+ i_pos,
+ p_item );
- p_playlist->i_size++;
- p_playlist->pp_items = realloc( p_playlist->pp_items,
- p_playlist->i_size * sizeof(void*) );
- if( p_playlist->pp_items == NULL )
+ if( p_playlist->i_index >= i_pos )
+ {
+ p_playlist->i_index++;
+ }
+ }
+ else
{
- msg_Err( p_playlist, "out of memory" );
- vlc_mutex_unlock( &p_playlist->change_lock );
- vlc_object_release( p_playlist );
- return -1;
+ /* i_mode == PLAYLIST_REPLACE and 0 <= i_pos < p_playlist->i_size */
+ if( p_playlist->pp_items[i_pos]->psz_name )
+ {
+ free( p_playlist->pp_items[i_pos]->psz_name );
+ }
+ if( p_playlist->pp_items[i_pos]->psz_uri )
+ {
+ free( p_playlist->pp_items[i_pos]->psz_uri );
+ }
+ /* XXX: what if the item is still in use? */
+ free( p_playlist->pp_items[i_pos] );
+ p_playlist->pp_items[i_pos] = p_item;
}
- i_pos = p_playlist->i_size - 1; /* FIXME */
- p_playlist->pp_items[i_pos] = malloc( sizeof( playlist_item_t ) );
- p_playlist->pp_items[i_pos]->psz_name = strdup( psz_item );
- p_playlist->pp_items[i_pos]->i_type = 0;
- p_playlist->pp_items[i_pos]->i_status = 0;
+ if( i_mode & PLAYLIST_GO )
+ {
+ p_playlist->i_index = i_pos;
+ if( p_playlist->p_input )
+ {
+ input_StopThread( p_playlist->p_input );
+ }
+ p_playlist->i_status = PLAYLIST_RUNNING;
+ }
+
+ vlc_mutex_unlock( &p_playlist->object_lock );
- vlc_mutex_unlock( &p_playlist->change_lock );
- vlc_object_release( p_playlist );
+ val.b_bool = VLC_TRUE;
+ var_Set( p_playlist, "intf-change", val );
return 0;
}
*****************************************************************************/
int playlist_Delete( playlist_t * p_playlist, int i_pos )
{
+ vlc_value_t val;
+ vlc_mutex_lock( &p_playlist->object_lock );
+
+ if( i_pos >= 0 && i_pos < p_playlist->i_size )
+ {
+ msg_Dbg( p_playlist, "deleting playlist item « %s »",
+ p_playlist->pp_items[i_pos]->psz_name );
+
+ if( p_playlist->pp_items[i_pos]->psz_name )
+ {
+ free( p_playlist->pp_items[i_pos]->psz_name );
+ }
+ if( p_playlist->pp_items[i_pos]->psz_uri )
+ {
+ free( p_playlist->pp_items[i_pos]->psz_uri );
+ }
+
+ /* XXX: what if the item is still in use? */
+ free( p_playlist->pp_items[i_pos] );
+
+ if( i_pos <= p_playlist->i_index )
+ {
+ p_playlist->i_index--;
+ }
+
+ /* Renumber the playlist */
+ REMOVE_ELEM( p_playlist->pp_items,
+ p_playlist->i_size,
+ i_pos );
+ }
+
+ vlc_mutex_unlock( &p_playlist->object_lock );
+
+ val.b_bool = VLC_TRUE;
+ var_Set( p_playlist, "intf-change", val );
+
return 0;
}
/*****************************************************************************
* playlist_Command: do a playlist action
*****************************************************************************
- * Delete the item in the playlist with position i_pos.
+ *
*****************************************************************************/
void playlist_Command( playlist_t * p_playlist, int i_command, int i_arg )
-{
+{
+ vlc_mutex_lock( &p_playlist->object_lock );
+
switch( i_command )
{
case PLAYLIST_STOP:
- msg_Dbg( p_playlist, "stopping" );
p_playlist->i_status = PLAYLIST_STOPPED;
+ if( p_playlist->p_input )
+ {
+ input_StopThread( p_playlist->p_input );
+ }
break;
+
case PLAYLIST_PLAY:
- msg_Dbg( p_playlist, "running" );
p_playlist->i_status = PLAYLIST_RUNNING;
+ if( p_playlist->p_input )
+ {
+ input_SetStatus( p_playlist->p_input, INPUT_STATUS_PLAY );
+ }
break;
+
+ case PLAYLIST_PAUSE:
+ p_playlist->i_status = PLAYLIST_PAUSED;
+ if( p_playlist->p_input )
+ {
+ input_SetStatus( p_playlist->p_input, INPUT_STATUS_PAUSE );
+ }
+ break;
+
case PLAYLIST_SKIP:
- msg_Dbg( p_playlist, "next" );
- if( p_playlist->i_size )
+ p_playlist->i_status = PLAYLIST_STOPPED;
+ SkipItem( p_playlist, i_arg );
+ if( p_playlist->p_input )
+ {
+ input_StopThread( p_playlist->p_input );
+ }
+ p_playlist->i_status = PLAYLIST_RUNNING;
+ break;
+
+ case PLAYLIST_GOTO:
+ if( i_arg >= 0 && i_arg < p_playlist->i_size )
{
- p_playlist->i_index = 0;
+ p_playlist->i_index = i_arg;
+ if( p_playlist->p_input )
+ {
+ input_StopThread( p_playlist->p_input );
+ }
p_playlist->i_status = PLAYLIST_RUNNING;
}
break;
+
default:
+ msg_Err( p_playlist, "unknown playlist command" );
break;
}
+ vlc_mutex_unlock( &p_playlist->object_lock );
+
return;
}
*****************************************************************************/
static void RunThread ( playlist_t *p_playlist )
{
+ /* Tell above that we're ready */
+ vlc_thread_ready( p_playlist );
+
while( !p_playlist->b_die )
{
+ vlc_mutex_lock( &p_playlist->object_lock );
+
/* If there is an input, check that it doesn't need to die. */
if( p_playlist->p_input )
{
- if( p_playlist->p_input->i_status == THREAD_OVER )
+ /* This input is dead. Remove it ! */
+ if( p_playlist->p_input->b_dead )
{
input_thread_t *p_input;
/* Unlink current input */
- vlc_mutex_lock( &p_playlist->change_lock );
p_input = p_playlist->p_input;
p_playlist->p_input = NULL;
- vlc_mutex_unlock( &p_playlist->change_lock );
+ vlc_object_detach( p_input );
+
+ /* Release the playlist lock, because we may get stuck
+ * in input_DestroyThread() for some time. */
+ vlc_mutex_unlock( &p_playlist->object_lock );
/* Destroy input */
- vlc_object_unlink_all( p_input );
- vlc_object_release( p_input );
input_DestroyThread( p_input );
+ vlc_object_destroy( p_input );
+ continue;
}
- else if( ( p_playlist->p_input->i_status == THREAD_READY
- || p_playlist->p_input->i_status == THREAD_ERROR )
- && ( p_playlist->p_input->b_error
- || p_playlist->p_input->b_eof ) )
- {
- input_StopThread( p_playlist->p_input, NULL );
- }
- }
- else if( p_playlist->i_status != PLAYLIST_STOPPED )
- {
- /* Select the next playlist item */
- playlist_Next( p_playlist );
-
- /* don't loop by default: stop at playlist end */
- if( p_playlist->i_index == -1 )
+ /* This input is dying, let him do */
+ else if( p_playlist->p_input->b_die )
{
- p_playlist->i_status = PLAYLIST_STOPPED;
+ ;
}
- else
+ /* This input has finished, ask him to die ! */
+ else if( p_playlist->p_input->b_error
+ || p_playlist->p_input->b_eof )
{
- input_thread_t *p_input;
-
- //p_playlist->i_mode = PLAYLIST_FORWARD +
- // config_GetInt( p_playlist, "loop-playlist" );
- msg_Dbg( p_playlist, "creating new input thread" );
- p_input = input_CreateThread( p_playlist->p_this,
- p_playlist->pp_items[p_playlist->i_index], NULL );
- if( p_input != NULL )
+ /* Check for autodeletion */
+ if( p_playlist->pp_items[p_playlist->i_index]->b_autodeletion )
{
- /* Link current input */
- vlc_mutex_lock( &p_playlist->change_lock );
- p_playlist->p_input = p_input;
- vlc_mutex_unlock( &p_playlist->change_lock );
+ vlc_mutex_unlock( &p_playlist->object_lock );
+ playlist_Delete( p_playlist, p_playlist->i_index );
+ vlc_mutex_lock( &p_playlist->object_lock );
}
+
+ /* Select the next playlist item */
+ SkipItem( p_playlist, 1 );
+
+ /* Release the playlist lock, because we may get stuck
+ * in input_StopThread() for some time. */
+ vlc_mutex_unlock( &p_playlist->object_lock );
+ input_StopThread( p_playlist->p_input );
+ continue;
}
}
+ else if( p_playlist->i_status != PLAYLIST_STOPPED )
+ {
+ PlayItem( p_playlist );
+ }
+
+ vlc_mutex_unlock( &p_playlist->object_lock );
msleep( INTF_IDLE_SLEEP );
}
/* If there is an input, kill it */
- while( p_playlist->p_input )
+ while( 1 )
{
- if( p_playlist->p_input->i_status == THREAD_OVER )
+ vlc_mutex_lock( &p_playlist->object_lock );
+
+ if( p_playlist->p_input == NULL )
+ {
+ vlc_mutex_unlock( &p_playlist->object_lock );
+ break;
+ }
+
+ if( p_playlist->p_input->b_dead )
{
input_thread_t *p_input;
/* Unlink current input */
- vlc_mutex_lock( &p_playlist->change_lock );
p_input = p_playlist->p_input;
p_playlist->p_input = NULL;
- vlc_mutex_unlock( &p_playlist->change_lock );
+ vlc_object_detach( p_input );
+ vlc_mutex_unlock( &p_playlist->object_lock );
/* Destroy input */
- vlc_object_unlink_all( p_input );
- vlc_object_release( p_input );
input_DestroyThread( p_input );
+ vlc_object_destroy( p_input );
+ continue;
+ }
+ else if( p_playlist->p_input->b_die )
+ {
+ /* This input is dying, leave him alone */
+ ;
}
- else if( ( p_playlist->p_input->i_status == THREAD_READY
- || p_playlist->p_input->i_status == THREAD_ERROR )
- && ( p_playlist->p_input->b_error
- || p_playlist->p_input->b_eof ) )
+ else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
{
- input_StopThread( p_playlist->p_input, NULL );
+ vlc_mutex_unlock( &p_playlist->object_lock );
+ input_StopThread( p_playlist->p_input );
+ continue;
}
else
{
p_playlist->p_input->b_eof = 1;
}
+ vlc_mutex_unlock( &p_playlist->object_lock );
+
msleep( INTF_IDLE_SLEEP );
}
}
+/*****************************************************************************
+ * SkipItem: go to Xth playlist item
+ *****************************************************************************
+ * This function calculates the position of the next playlist item, depending
+ * on the playlist course mode (forward, backward, random...).
+ *****************************************************************************/
+static void SkipItem( playlist_t *p_playlist, int i_arg )
+{
+ int i_oldindex = p_playlist->i_index;
+ vlc_bool_t b_random;
+
+ /* If the playlist is empty, there is no current item */
+ if( p_playlist->i_size == 0 )
+ {
+ p_playlist->i_index = -1;
+ return;
+ }
+
+ b_random = config_GetInt( p_playlist, "random" );
+
+ /* Increment */
+ if( b_random )
+ {
+ srand( (unsigned int)mdate() );
+
+ /* Simple random stuff - we cheat a bit to minimize the chances to
+ * get the same index again. */
+ i_arg = (int)((float)p_playlist->i_size * rand() / (RAND_MAX+1.0));
+ if( i_arg == 0 )
+ {
+ i_arg = (int)((float)p_playlist->i_size * rand() / (RAND_MAX+1.0));
+ }
+ }
+
+ p_playlist->i_index += i_arg;
+
+ /* Boundary check */
+ if( p_playlist->i_index >= p_playlist->i_size )
+ {
+ if( p_playlist->i_status == PLAYLIST_STOPPED
+ || b_random
+ || config_GetInt( p_playlist, "loop" ) )
+ {
+ p_playlist->i_index -= p_playlist->i_size
+ * ( p_playlist->i_index / p_playlist->i_size );
+ }
+ else
+ {
+ /* Don't loop by default: stop at playlist end */
+ p_playlist->i_index = i_oldindex;
+ p_playlist->i_status = PLAYLIST_STOPPED;
+ }
+ }
+ else if( p_playlist->i_index < 0 )
+ {
+ p_playlist->i_index = p_playlist->i_size - 1;
+ }
+}
+
+/*****************************************************************************
+ * PlayItem: play current playlist item
+ *****************************************************************************
+ * This function calculates the position of the next playlist item, depending
+ * on the playlist course mode (forward, backward, random...).
+ *****************************************************************************/
+static void PlayItem( playlist_t *p_playlist )
+{
+ if( p_playlist->i_index == -1 )
+ {
+ if( p_playlist->i_size == 0 )
+ {
+ return;
+ }
+
+ SkipItem( p_playlist, 1 );
+ }
+
+ msg_Dbg( p_playlist, "creating new input thread" );
+ p_playlist->p_input = input_CreateThread( p_playlist,
+ p_playlist->pp_items[p_playlist->i_index] );
+}
+
+/*****************************************************************************
+ * Poubellize: put an input thread in the trashcan
+ *****************************************************************************
+ * XXX: unused
+ *****************************************************************************/
+static void Poubellize ( playlist_t *p_playlist, input_thread_t *p_input )
+{
+ msg_Dbg( p_playlist, "poubellizing input %i\n", p_input->i_object_id );
+}
+
+/*****************************************************************************
+ * playlist_LoadFile: load a playlist file.
+ ****************************************************************************/
+int playlist_LoadFile( playlist_t * p_playlist, const char *psz_filename )
+{
+ FILE *file;
+ char line[1024];
+ int i_current_status;
+ int i;
+
+ msg_Dbg( p_playlist, "opening playlist file %s", psz_filename );
+
+ file = fopen( psz_filename, "rt" );
+ if( !file )
+ {
+ msg_Err( p_playlist, "playlist file %s does not exist", psz_filename );
+ return -1;
+ }
+ fseek( file, 0L, SEEK_SET );
+
+ /* check the file is not empty */
+ if ( ! fgets( line, 1024, file ) )
+ {
+ msg_Err( p_playlist, "playlist file %s is empty", psz_filename );
+ fclose( file );
+ return -1;
+ }
+
+ /* get rid of line feed */
+ if( line[strlen(line)-1] == '\n' || line[strlen(line)-1] == '\r' )
+ {
+ line[strlen(line)-1] = (char)0;
+ if( line[strlen(line)-1] == '\r' ) line[strlen(line)-1] = (char)0;
+ }
+ /* check the file format is valid */
+ if ( strcmp ( line , PLAYLIST_FILE_HEADER_0_5 ) )
+ {
+ msg_Err( p_playlist, "playlist file %s format is unsupported"
+ , psz_filename );
+ fclose( file );
+ return -1;
+ }
+
+ /* stop playing */
+ i_current_status = p_playlist->i_status;
+ if ( p_playlist->i_status != PLAYLIST_STOPPED )
+ {
+ playlist_Stop ( p_playlist );
+ }
+
+ /* delete current content of the playlist */
+ for( i = p_playlist->i_size - 1; i >= 0; i-- )
+ {
+ playlist_Delete ( p_playlist , i );
+ }
+
+ /* simply add each line */
+ while( fgets( line, 1024, file ) )
+ {
+ /* ignore comments or empty lines */
+ if( (line[0] == '#') || (line[0] == '\r') || (line[0] == '\n')
+ || (line[0] == (char)0) )
+ continue;
+
+ /* get rid of line feed */
+ if( line[strlen(line)-1] == '\n' || line[strlen(line)-1] == '\r' )
+ {
+ line[strlen(line)-1] = (char)0;
+ if( line[strlen(line)-1] == '\r' ) line[strlen(line)-1] = (char)0;
+ }
+
+ playlist_Add ( p_playlist , (char*) &line , PLAYLIST_APPEND , PLAYLIST_END );
+ }
+
+ /* start playing */
+ if ( i_current_status != PLAYLIST_STOPPED )
+ {
+ playlist_Play ( p_playlist );
+ }
+
+ fclose( file );
+
+ return 0;
+}
+
+/*****************************************************************************
+ * playlist_SaveFile: Save a playlist in a file.
+ *****************************************************************************/
+int playlist_SaveFile( playlist_t * p_playlist, const char * psz_filename )
+{
+ FILE *file;
+ int i;
+
+ vlc_mutex_lock( &p_playlist->object_lock );
+
+ msg_Dbg( p_playlist, "saving playlist file %s", psz_filename );
+
+ file = fopen( psz_filename, "wt" );
+ if( !file )
+ {
+ msg_Err( p_playlist , "could not create playlist file %s"
+ , psz_filename );
+ return -1;
+ }
+
+ fprintf( file , PLAYLIST_FILE_HEADER_0_5 PLAYLIST_FILE_EOL );
+
+ for ( i = 0 ; i < p_playlist->i_size ; i++ )
+ {
+ fprintf( file , p_playlist->pp_items[i]->psz_uri );
+ fprintf( file , PLAYLIST_FILE_EOL );
+ }
+
+ fclose( file );
+
+ vlc_mutex_unlock( &p_playlist->object_lock );
+
+ return 0;
+}