* 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.
- *******************************************************************************/
+ ******************************************************************************/
/**
* \file modules/demux/playlist/xspf.c
* \brief XSPF playlist import functions
*/
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
#include <vlc_demux.h>
-#include "playlist.h"
-#include "vlc_xml.h"
-#include "vlc_strings.h"
-#include "vlc_url.h"
+#include <vlc_xml.h>
+#include <vlc_strings.h>
+#include <vlc_url.h>
#include "xspf.h"
+#include "playlist.h"
struct demux_sys_t
{
- playlist_item_t *p_item_in_category;
input_item_t **pp_tracklist;
int i_tracklist_entries;
int i_identifier;
/**
* \brief XSPF submodule initialization function
*/
-int E_(Import_xspf)( vlc_object_t *p_this )
+int Import_xspf( vlc_object_t *p_this )
{
DEMUX_BY_EXTENSION_OR_FORCED_MSG( ".xspf", "xspf-open",
"using XSPF playlist reader" );
return VLC_SUCCESS;
}
-void E_(Close_xspf)( vlc_object_t *p_this )
+void Close_xspf( vlc_object_t *p_this )
{
demux_t *p_demux = (demux_t *)p_this;
FREENULL( p_demux->p_sys->pp_tracklist );
*/
int Demux( demux_t *p_demux )
{
- int i_ret = VLC_SUCCESS;
+ int i_ret = 1;
xml_t *p_xml = NULL;
xml_reader_t *p_xml_reader = NULL;
char *psz_name = NULL;
/* create new xml parser from stream */
p_xml = xml_Create( p_demux );
if( !p_xml )
- i_ret = VLC_ENOMOD;
+ i_ret = -1;
else
{
p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
if( !p_xml_reader )
- i_ret = VLC_EGENERIC;
+ i_ret = -1;
}
/* locating the root node */
- if( i_ret == VLC_SUCCESS )
+ if( i_ret == 1 )
{
do
{
if( xml_ReaderRead( p_xml_reader ) != 1 )
{
msg_Err( p_demux, "can't read xml stream" );
- i_ret = VLC_EGENERIC;
+ i_ret = -1;
}
} while( i_ret == VLC_SUCCESS &&
xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
}
/* checking root node name */
- if( i_ret == VLC_SUCCESS )
+ if( i_ret == 1 )
{
psz_name = xml_ReaderName( p_xml_reader );
if( !psz_name || strcmp( psz_name, "playlist" ) )
{
msg_Err( p_demux, "invalid root node name: %s", psz_name );
- i_ret = VLC_EGENERIC;
+ i_ret = -1;
}
FREE_NAME();
}
- i_ret = parse_playlist_node( p_demux, p_playlist, p_current_input,
- p_xml_reader, "playlist" );
+ if( i_ret == 1 )
+ i_ret = parse_playlist_node( p_demux, p_current_input,
+ p_xml_reader, "playlist" ) ? 0 : -1;
+
+ int i;
+ for( i = 0 ; i < p_demux->p_sys->i_tracklist_entries ; i++ )
+ {
+ input_item_t *p_new_input = p_demux->p_sys->pp_tracklist[i];
+ if( p_new_input )
+ {
+ input_ItemAddSubItem( p_current_input, p_new_input );
+ }
+ }
+
HANDLE_PLAY_AND_RELEASE;
if( p_xml_reader )
xml_ReaderDelete( p_xml, p_xml_reader );
if( p_xml )
xml_Delete( p_xml );
- return -1; /* Needed for correct operation of go back */
+ return i_ret; /* Needed for correct operation of go back */
}
/** \brief dummy function for demux callback interface */
static int Control( demux_t *p_demux, int i_query, va_list args )
{
+ VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
return VLC_EGENERIC;
}
/**
* \brief parse the root node of a XSPF playlist
* \param p_demux demuxer instance
- * \param p_playlist playlist instance
* \param p_input_item current input item
* \param p_xml_reader xml reader instance
* \param psz_element name of element to parse
*/
-static vlc_bool_t parse_playlist_node COMPLEX_INTERFACE
+static bool parse_playlist_node COMPLEX_INTERFACE
{
char *psz_name=NULL;
char *psz_value=NULL;
- vlc_bool_t b_version_found = VLC_FALSE;
+ bool b_version_found = false;
int i_node;
xml_elem_hnd_t *p_handler=NULL;
{"info", SIMPLE_CONTENT, {NULL} },
{"location", SIMPLE_CONTENT, {NULL} },
{"identifier", SIMPLE_CONTENT, {NULL} },
- {"image", SIMPLE_CONTENT, {NULL} },
+ {"image", SIMPLE_CONTENT, {.smpl = set_item_info} },
{"date", SIMPLE_CONTENT, {NULL} },
{"license", SIMPLE_CONTENT, {NULL} },
{"attribution", COMPLEX_CONTENT, {.cmplx = skip_element} },
{
msg_Err( p_demux, "invalid xml stream @ <playlist>" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
/* attribute: version */
if( !strcmp( psz_name, "version" ) )
{
- b_version_found = VLC_TRUE;
+ b_version_found = true;
if( strcmp( psz_value, "0" ) && strcmp( psz_value, "1" ) )
msg_Warn( p_demux, "unsupported XSPF version" );
}
{
msg_Err( p_demux, "invalid xml stream" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
/* choose handler */
for( p_handler = pl_elements;
{
msg_Err( p_demux, "unexpected element <%s>", psz_name );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
FREE_NAME();
/* complex content is parsed in a separate function */
if( p_handler->type == COMPLEX_CONTENT )
{
if( p_handler->pf_handler.cmplx( p_demux,
- p_playlist,
p_input_item,
p_xml_reader,
p_handler->name ) )
else
{
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
}
break;
{
msg_Err( p_demux, "invalid xml stream" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
break;
{
msg_Err( p_demux, "invalid xml stream" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
/* leave if the current parent node <playlist> is terminated */
if( !strcmp( psz_name, psz_element ) )
{
FREE_ATT();
- return VLC_TRUE;
+ return true;
}
/* there MUST have been a start tag for that element name */
if( !p_handler || !p_handler->name
msg_Err( p_demux, "there's no open element left for <%s>",
psz_name );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
if( p_handler->pf_handler.smpl )
/* unknown/unexpected xml node */
msg_Err( p_demux, "unexpected xml node %i", i_node );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
FREE_NAME();
}
- return VLC_FALSE;
+ return false;
}
/**
* \brief parses the tracklist node which only may contain <track>s
*/
-static vlc_bool_t parse_tracklist_node COMPLEX_INTERFACE
+static bool parse_tracklist_node COMPLEX_INTERFACE
{
+ VLC_UNUSED(psz_element);
char *psz_name=NULL;
int i_node;
int i_ntracks = 0;
{
msg_Err( p_demux, "unexpected end of xml data" );
FREE_NAME();
- return VLC_FALSE;
+ return false;
}
if( strcmp( psz_name, "track") )
{
msg_Err( p_demux, "unexpected child of <trackList>: <%s>",
psz_name );
FREE_NAME();
- return VLC_FALSE;
+ return false;
}
FREE_NAME();
/* parse the track data in a separate function */
- if( parse_track_node( p_demux, p_playlist, p_input_item,
- p_xml_reader,"track" ) == VLC_TRUE )
+ if( parse_track_node( p_demux, p_input_item,
+ p_xml_reader,"track" ) == true )
i_ntracks++;
}
else if( i_node == XML_READER_ENDELEM )
{
msg_Err( p_demux, "there's a missing </trackList>" );
FREE_NAME();
- return VLC_FALSE;
+ return false;
}
psz_name = xml_ReaderName( p_xml_reader );
if( !psz_name || strcmp( psz_name, "trackList" ) )
{
msg_Err( p_demux, "expected: </trackList>, found: </%s>", psz_name );
FREE_NAME();
- return VLC_FALSE;
+ return false;
}
FREE_NAME();
msg_Dbg( p_demux, "parsed %i tracks successfully", i_ntracks );
- return VLC_TRUE;
+ return true;
}
/**
* \brief parse one track element
* \param COMPLEX_INTERFACE
*/
-static vlc_bool_t parse_track_node COMPLEX_INTERFACE
+static bool parse_track_node COMPLEX_INTERFACE
{
input_item_t *p_new_input = NULL;
int i_node;
{"creator", SIMPLE_CONTENT, {.smpl = set_item_info} },
{"annotation", SIMPLE_CONTENT, {.smpl = set_item_info} },
{"info", SIMPLE_CONTENT, {NULL} },
- {"image", SIMPLE_CONTENT, {NULL} },
+ {"image", SIMPLE_CONTENT, {.smpl = set_item_info} },
{"album", SIMPLE_CONTENT, {.smpl = set_item_info} },
{"trackNum", SIMPLE_CONTENT, {.smpl = set_item_info} },
{"duration", SIMPLE_CONTENT, {.smpl = set_item_info} },
{"link", SIMPLE_CONTENT, {NULL} },
{"meta", SIMPLE_CONTENT, {NULL} },
- {"extension", COMPLEX_CONTENT, {.cmplx = skip_element} },
+ {"extension", COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
{NULL, UNKNOWN_CONTENT, {NULL} }
};
{
msg_Err( p_demux, "invalid xml stream" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
/* choose handler */
for( p_handler = track_elements;
{
msg_Err( p_demux, "unexpected element <%s>", psz_name );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
FREE_NAME();
/* complex content is parsed in a separate function */
"at <%s> level no new item has been allocated",
p_handler->name );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
if( p_handler->pf_handler.cmplx( p_demux,
- p_playlist,
p_new_input,
p_xml_reader,
p_handler->name ) )
else
{
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
}
break;
{
msg_Err( p_demux, "invalid xml stream" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
break;
{
msg_Err( p_demux, "invalid xml stream" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
/* leave if the current parent node <track> is terminated */
if( !strcmp( psz_name, psz_element ) )
{
FREE_ATT();
- input_ItemAddSubItem( p_input_item, p_new_input );
if( p_demux->p_sys->i_identifier <
p_demux->p_sys->i_tracklist_entries )
{
p_demux->p_sys->i_tracklist_entries,
p_new_input );
}
- return VLC_TRUE;
+ return true;
}
/* there MUST have been a start tag for that element name */
if( !p_handler || !p_handler->name
msg_Err( p_demux, "there's no open element left for <%s>",
psz_name );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
/* special case: location */
msg_Err( p_demux, "item <%s> already created",
psz_name );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
psz_uri = decode_URI_duplicate( psz_value );
strlen(p_demux->p_sys->psz_base) +
strlen(psz_uri) +1 );
if( !psz_tmp )
- {
- msg_Err( p_demux, "out of memory");
- return VLC_FALSE;
- }
+ return false;
sprintf( psz_tmp, "%s%s",
p_demux->p_sys->psz_base, psz_uri );
free( psz_uri );
psz_uri = psz_tmp;
}
- p_new_input = input_ItemNewExt( p_playlist, psz_uri,
+ p_new_input = input_ItemNewExt( p_demux, psz_uri,
NULL, 0, NULL, -1 );
free( psz_uri );
input_ItemCopyOptions( p_input_item, p_new_input );
else
{
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
}
else if( !strcmp( p_handler->name, "identifier" ) )
msg_Err( p_demux, "item not yet created at <%s>",
psz_name );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
if( p_handler->pf_handler.smpl )
{
/* unknown/unexpected xml node */
msg_Err( p_demux, "unexpected xml node %i", i_node );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
FREE_NAME();
}
msg_Err( p_demux, "unexpected end of xml data" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
/**
* \brief handles the supported <track> sub-elements
*/
-static vlc_bool_t set_item_info SIMPLE_INTERFACE
+static bool set_item_info SIMPLE_INTERFACE
{
/* exit if setting is impossible */
if( !psz_name || !psz_value || !p_input )
- return VLC_FALSE;
+ return false;
/* re-convert xml special characters inside psz_value */
/* handle each info element in a separate "if" clause */
if( !strcmp( psz_name, "title" ) )
{
- p_input->psz_name = strdup( (char*)psz_value );
+ input_item_SetTitle( p_input, psz_value );
}
else if( !strcmp( psz_name, "creator" ) )
{
{
input_item_SetDescription( p_input, psz_value );
}
- return VLC_TRUE;
+ else if( !strcmp( psz_name, "image" ) )
+ {
+ char *psz_uri = decode_URI_duplicate( psz_value );
+ input_item_SetArtURL( p_input, psz_uri );
+ free( psz_uri );
+ }
+ return true;
}
+/**
+ * \brief handles the <option> elements
+ */
+static bool set_option SIMPLE_INTERFACE
+{
+ /* exit if setting is impossible */
+ if( !psz_name || !psz_value || !p_input )
+ return false;
+
+ /* re-convert xml special characters inside psz_value */
+ resolve_xml_special_chars( psz_value );
+
+ input_ItemAddOpt( p_input, psz_value, 0 );
+
+ return true;
+}
/**
* \brief parse the extension node of a XSPF playlist
*/
-static vlc_bool_t parse_extension_node COMPLEX_INTERFACE
+static bool parse_extension_node COMPLEX_INTERFACE
{
char *psz_name = NULL;
char *psz_value = NULL;
char *psz_title = NULL;
+ char *psz_application = NULL;
int i_node;
xml_elem_hnd_t *p_handler = NULL;
+ input_item_t *p_new_input = NULL;
xml_elem_hnd_t pl_elements[] =
{ {"node", COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
{"item", COMPLEX_CONTENT, {.cmplx = parse_extitem_node} },
+ {"option", SIMPLE_CONTENT, {.smpl = set_option} },
{NULL, UNKNOWN_CONTENT, {NULL} }
};
{
msg_Err( p_demux, "invalid xml stream @ <node>" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
/* attribute: title */
if( !strcmp( psz_name, "title" ) )
{
- psz_title = unescape_URI_duplicate( psz_value );
+ resolve_xml_special_chars( psz_value );
+ psz_title = strdup( psz_value );
+ }
+ /* extension attribute: application */
+ else if( !strcmp( psz_name, "application" ) )
+ {
+ psz_application = strdup( psz_value );
}
/* unknown attribute */
else
- msg_Warn( p_demux, "invalid <node> attribute:\"%s\"", psz_name);
+ msg_Warn( p_demux, "invalid <%s> attribute:\"%s\"", psz_element, psz_name );
FREE_ATT();
}
/* attribute title is mandatory except for <extension> */
- if( !strcmp( psz_element, "node" ) && !psz_title )
+ if( !strcmp( psz_element, "node" ) )
+ {
+ if( !psz_title )
+ {
+ msg_Warn( p_demux, "<node> requires \"title\" attribute" );
+ return false;
+ }
+ p_new_input = input_ItemNewWithType( VLC_OBJECT( p_demux ), "vlc://nop",
+ psz_title, 0, NULL, -1, ITEM_TYPE_DIRECTORY );
+ if( p_new_input )
+ {
+ input_ItemAddSubItem( p_input_item, p_new_input );
+ p_input_item = p_new_input;
+ vlc_gc_decref( p_new_input );
+ }
+ free( psz_title );
+ }
+ else if( !strcmp( psz_element, "extension" ) )
{
- msg_Warn( p_demux, "<node> requires \"title\" attribute" );
- return VLC_FALSE;
+ if( !psz_application )
+ {
+ msg_Warn( p_demux, "<extension> requires \"application\" attribute" );
+ return false;
+ }
+ else if( strcmp( psz_application, "http://www.videolan.org/vlc/playlist/0" ) )
+ {
+ msg_Dbg( p_demux, "Skipping \"%s\" extension tag", psz_application );
+ free( psz_application );
+ return false;
+ }
}
- if( psz_title ) free( psz_title );
+ free( psz_application );
/* parse the child elements */
while( xml_ReaderRead( p_xml_reader ) == 1 )
{
msg_Err( p_demux, "invalid xml stream" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
/* choose handler */
for( p_handler = pl_elements;
{
msg_Err( p_demux, "unexpected element <%s>", psz_name );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
FREE_NAME();
/* complex content is parsed in a separate function */
if( p_handler->type == COMPLEX_CONTENT )
{
if( p_handler->pf_handler.cmplx( p_demux,
- p_playlist,
p_input_item,
p_xml_reader,
p_handler->name ) )
else
{
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
}
break;
{
msg_Err( p_demux, "invalid xml stream" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
break;
{
msg_Err( p_demux, "invalid xml stream" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
/* leave if the current parent node is terminated */
if( !strcmp( psz_name, psz_element ) )
{
FREE_ATT();
- return VLC_TRUE;
+ return true;
}
/* there MUST have been a start tag for that element name */
if( !p_handler || !p_handler->name
msg_Err( p_demux, "there's no open element left for <%s>",
psz_name );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
if( p_handler->pf_handler.smpl )
/* unknown/unexpected xml node */
msg_Err( p_demux, "unexpected xml node %i", i_node );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
FREE_NAME();
}
- return VLC_FALSE;
+ return false;
}
/**
* \brief parse the extension item node of a XSPF playlist
*/
-static vlc_bool_t parse_extitem_node COMPLEX_INTERFACE
+static bool parse_extitem_node COMPLEX_INTERFACE
{
+ VLC_UNUSED(psz_element);
+ input_item_t *p_new_input = NULL;
char *psz_name = NULL;
char *psz_value = NULL;
int i_href = -1;
{
msg_Err( p_demux, "invalid xml stream @ <item>" );
FREE_ATT();
- return VLC_FALSE;
+ return false;
}
/* attribute: href */
if( !strcmp( psz_name, "href" ) )
if( i_href < 0 )
{
msg_Warn( p_demux, "<item> requires \"href\" attribute" );
- return VLC_FALSE;
+ return false;
}
- if( i_href > p_demux->p_sys->i_tracklist_entries )
+ if( i_href >= p_demux->p_sys->i_tracklist_entries )
{
msg_Warn( p_demux, "invalid \"href\" attribute" );
- return VLC_FALSE;
+ return false;
}
- return VLC_TRUE;
+
+ p_new_input = p_demux->p_sys->pp_tracklist[ i_href ];
+ if( p_new_input )
+ {
+ input_ItemAddSubItem( p_input_item, p_new_input );
+ vlc_gc_decref( p_new_input );
+ p_demux->p_sys->pp_tracklist[i_href] = NULL;
+ }
+
+ /* kludge for #1293 - XTAG sends ENDELEM for self closing tag */
+ /* (libxml sends NONE) */
+ xml_ReaderRead( p_xml_reader );
+
+ return true;
}
/**
* \brief skips complex element content that we can't manage
*/
-static vlc_bool_t skip_element COMPLEX_INTERFACE
+static bool skip_element COMPLEX_INTERFACE
{
+ VLC_UNUSED(p_demux); VLC_UNUSED(p_input_item);
char *psz_endname;
while( xml_ReaderRead( p_xml_reader ) == 1 )
{
psz_endname = xml_ReaderName( p_xml_reader );
if( !psz_endname )
- return VLC_FALSE;
+ return false;
if( !strcmp( psz_element, psz_endname ) )
{
free( psz_endname );
- return VLC_TRUE;
+ return true;
}
else
free( psz_endname );
}
}
- return VLC_FALSE;
+ return false;
}
projects / vlc / blobdiff