git.sesse.net Git - vlc/blob - modules/demux/playlist/m3u.c

   1 /*****************************************************************************
   2  * m3u.c : M3U playlist format import
   3  *****************************************************************************
   4  * Copyright (C) 2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Sigmund Augdal Helberg <dnumgis@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_demux.h>
  35 #include <vlc_charset.h>
  36
  37 #include "playlist.h"
  38
  39 struct demux_sys_t
  40 {
  41     char *psz_prefix;
  42     char *(*pf_dup) (const char *);
  43 };
  44
  45 /*****************************************************************************
  46  * Local prototypes
  47  *****************************************************************************/
  48 static int Demux( demux_t *p_demux);
  49 static int Control( demux_t *p_demux, int i_query, va_list args );
  50 static void parseEXTINF( char *psz_string, char **ppsz_artist, char **ppsz_name, int *pi_duration );
  51 static bool ContainsURL( demux_t *p_demux );
  52
  53 static char *GuessEncoding (const char *str)
  54 {
  55     return IsUTF8 (str) ? strdup (str) : FromLatin1 (str);
  56 }
  57
  58 /*****************************************************************************
  59  * Import_M3U: main import function
  60  *****************************************************************************/
  61 int Import_M3U( vlc_object_t *p_this )
  62 {
  63     demux_t *p_demux = (demux_t *)p_this;
  64     const uint8_t *p_peek;
  65     CHECK_PEEK( p_peek, 8 );
  66     char *(*pf_dup) (const char *);
  67
  68     if( POKE( p_peek, "RTSPtext", 8 ) /* QuickTime */
  69      || demux_IsPathExtension( p_demux, ".m3u8" )
  70      || demux_IsForced( p_demux, "m3u8" ) )
  71         pf_dup = strdup; /* UTF-8 */
  72     else
  73     if( POKE( p_peek, "#EXTM3U", 7 )
  74      || demux_IsPathExtension( p_demux, ".m3u" )
  75      || demux_IsPathExtension( p_demux, ".vlc" )
  76      || demux_IsForced( p_demux, "m3u" )
  77      || ContainsURL( p_demux ) )
  78         pf_dup = GuessEncoding;
  79     else
  80         return VLC_EGENERIC;
  81
  82     STANDARD_DEMUX_INIT_MSG( "found valid M3U playlist" );
  83     p_demux->p_sys->psz_prefix = FindPrefix( p_demux );
  84     p_demux->p_sys->pf_dup = pf_dup;
  85
  86     return VLC_SUCCESS;
  87 }
  88
  89 static bool ContainsURL( demux_t *p_demux )
  90 {
  91     const uint8_t *p_peek, *p_peek_end;
  92     int i_peek;
  93
  94     i_peek = stream_Peek( p_demux->s, &p_peek, 1024 );
  95     if( i_peek <= 0 ) return false;
  96     p_peek_end = p_peek + i_peek;
  97
  98     while( p_peek + sizeof( "https://" ) < p_peek_end )
  99     {
 100         /* One line starting with an URL is enough */
 101         if( !strncasecmp( (const char *)p_peek, "http://", 7 ) ||
 102             !strncasecmp( (const char *)p_peek, "mms://", 6 ) ||
 103             !strncasecmp( (const char *)p_peek, "rtsp://", 7 ) ||
 104             !strncasecmp( (const char *)p_peek, "https://", 8 ) ||
 105             !strncasecmp( (const char *)p_peek, "ftp://", 6 ) )
 106         {
 107             return true;
 108         }
 109         /* Comments and blank lines are ignored */
 110         else if( *p_peek != '#' && *p_peek != '\n' && *p_peek != '\r')
 111         {
 112             return false;
 113         }
 114
 115         while( p_peek < p_peek_end && *p_peek != '\n' )
 116             p_peek++;
 117         if ( *p_peek == '\n' )
 118             p_peek++;
 119     }
 120     return false;
 121 }
 122
 123 /*****************************************************************************
 124  * Deactivate: frees unused data
 125  *****************************************************************************/
 126 void Close_M3U( vlc_object_t *p_this )
 127 {
 128     demux_t *p_demux = (demux_t *)p_this;
 129     free( p_demux->p_sys->psz_prefix );
 130     free( p_demux->p_sys );
 131 }
 132
 133
 134 static int Demux( demux_t *p_demux )
 135 {
 136     char       *psz_line;
 137     char       *psz_name = NULL;
 138     char       *psz_artist = NULL;
 139     char       *psz_album_art = NULL;
 140     int        i_parsed_duration = 0;
 141     mtime_t    i_duration = -1;
 142     const char**ppsz_options = NULL;
 143     char *    (*pf_dup) (const char *) = p_demux->p_sys->pf_dup;
 144     int        i_options = 0;
 145     bool b_cleanup = false;
 146     input_item_t *p_input;
 147
 148     input_item_t *p_current_input = GetCurrentItem(p_demux);
 149     input_item_node_t *p_subitems = input_item_node_Create( p_current_input );
 150
 151     psz_line = stream_ReadLine( p_demux->s );
 152     while( psz_line )
 153     {
 154         char *psz_parse = psz_line;
 155
 156         /* Skip leading tabs and spaces */
 157         while( *psz_parse == ' ' || *psz_parse == '\t' ||
 158                *psz_parse == '\n' || *psz_parse == '\r' ) psz_parse++;
 159
 160         if( *psz_parse == '#' )
 161         {
 162             /* Parse extra info */
 163
 164             /* Skip leading tabs and spaces */
 165             while( *psz_parse == ' ' || *psz_parse == '\t' ||
 166                    *psz_parse == '\n' || *psz_parse == '\r' ||
 167                    *psz_parse == '#' ) psz_parse++;
 168
 169             if( !*psz_parse ) goto error;
 170
 171             if( !strncasecmp( psz_parse, "EXTINF:", sizeof("EXTINF:") -1 ) )
 172             {
 173                 /* Extended info */
 174                 psz_parse += sizeof("EXTINF:") - 1;
 175                 free(psz_name);
 176                 free(psz_artist);
 177                 parseEXTINF( psz_parse, &psz_artist, &psz_name, &i_parsed_duration );
 178                 if( i_parsed_duration >= 0 )
 179                     i_duration = i_parsed_duration * INT64_C(1000000);
 180                 if( psz_name )
 181                     psz_name = pf_dup( psz_name );
 182                 if( psz_artist )
 183                     psz_artist = pf_dup( psz_artist );
 184             }
 185             else if( !strncasecmp( psz_parse, "EXTVLCOPT:",
 186                                    sizeof("EXTVLCOPT:") -1 ) )
 187             {
 188                 /* VLC Option */
 189                 char *psz_option;
 190                 psz_parse += sizeof("EXTVLCOPT:") -1;
 191                 if( !*psz_parse ) goto error;
 192
 193                 psz_option = pf_dup( psz_parse );
 194                 if( psz_option )
 195                     INSERT_ELEM( ppsz_options, i_options, i_options,
 196                                  psz_option );
 197             }
 198             /* Special case for jamendo which provide the albumart */
 199             else if( !strncasecmp( psz_parse, "EXTALBUMARTURL:",
 200                      sizeof( "EXTALBUMARTURL:" ) -1 ) )
 201             {
 202                 psz_parse += sizeof( "EXTALBUMARTURL:" ) - 1;
 203                 free( psz_album_art );
 204                 psz_album_art = pf_dup( psz_parse );
 205             }
 206         }
 207         else if( !strncasecmp( psz_parse, "RTSPtext", sizeof("RTSPtext") -1 ) )
 208         {
 209             ;/* special case to handle QuickTime RTSPtext redirect files */
 210         }
 211         else if( *psz_parse )
 212         {
 213             char *psz_mrl;
 214
 215             psz_parse = pf_dup( psz_parse );
 216             if( !psz_name && psz_parse )
 217                 /* Use filename as name for relative entries */
 218                 psz_name = strdup( psz_parse );
 219
 220             psz_mrl = ProcessMRL( psz_parse, p_demux->p_sys->psz_prefix );
 221
 222             b_cleanup = true;
 223             if( !psz_mrl )
 224             {
 225                 LocaleFree( psz_parse );
 226                 goto error;
 227             }
 228
 229             p_input = input_item_NewExt( p_demux, psz_mrl, psz_name,
 230                                         i_options, ppsz_options, 0, i_duration );
 231
 232             LocaleFree( psz_parse );
 233             free( psz_mrl );
 234
 235             if ( psz_artist && *psz_artist )
 236                 input_item_SetArtist( p_input, psz_artist );
 237             if( psz_name ) input_item_SetTitle( p_input, psz_name );
 238             if( !EMPTY_STR(psz_album_art) )
 239                 input_item_SetArtURL( p_input, psz_album_art );
 240
 241             input_item_node_AppendItem( p_subitems, p_input );
 242             vlc_gc_decref( p_input );
 243         }
 244
 245  error:
 246
 247         /* Fetch another line */
 248         free( psz_line );
 249         psz_line = stream_ReadLine( p_demux->s );
 250         if( !psz_line ) b_cleanup = true;
 251
 252         if( b_cleanup )
 253         {
 254             /* Cleanup state */
 255             while( i_options-- ) free( (char*)ppsz_options[i_options] );
 256             free( ppsz_options );
 257             ppsz_options = NULL; i_options = 0;
 258             free( psz_name );
 259             psz_name = NULL;
 260             free( psz_artist );
 261             psz_artist = NULL;
 262             free( psz_album_art );
 263             psz_album_art = NULL;
 264             i_parsed_duration = 0;
 265             i_duration = -1;
 266
 267             b_cleanup = false;
 268         }
 269     }
 270     input_item_node_PostAndDelete( p_subitems );
 271     vlc_gc_decref(p_current_input);
 272     var_Destroy( p_demux, "m3u-extvlcopt" );
 273     return 0; /* Needed for correct operation of go back */
 274 }
 275
 276 static int Control( demux_t *p_demux, int i_query, va_list args )
 277 {
 278     VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
 279     return VLC_EGENERIC;
 280 }
 281
 282 static void parseEXTINF(char *psz_string, char **ppsz_artist,
 283                         char **ppsz_name, int *pi_duration)
 284 {
 285     char *end = NULL;
 286     char *psz_item = NULL;
 287
 288     end = psz_string + strlen( psz_string );
 289
 290     /* ignore whitespaces */
 291     for (; psz_string < end && ( *psz_string == '\t' || *psz_string == ' ' );
 292          psz_string++ );
 293
 294     /* duration: read to next comma */
 295     psz_item = psz_string;
 296     psz_string = strchr( psz_string, ',' );
 297     if ( psz_string )
 298     {
 299         *psz_string = '\0';
 300         *pi_duration = atoi( psz_item );
 301     }
 302     else
 303     {
 304         return;
 305     }
 306
 307     if ( psz_string < end )               /* continue parsing if possible */
 308         psz_string++;
 309
 310     /* analyse the remaining string */
 311     psz_item = strstr( psz_string, " - " );
 312
 313     /* here we have the 0.8.2+ format with artist */
 314     if ( psz_item )
 315     {
 316         /* *** "EXTINF:time,artist - name" */
 317         *psz_item = '\0';
 318         *ppsz_artist = psz_string;
 319         *ppsz_name = psz_item + 3;          /* points directly after ' - ' */
 320         return;
 321     }
 322
 323     /* reaching this point means: 0.8.1- with artist or something without artist */
 324     if ( *psz_string == ',' )
 325     {
 326         /* *** "EXTINF:time,,name" */
 327         psz_string++;
 328         *ppsz_name = psz_string;
 329         return;
 330     }
 331
 332     psz_item = psz_string;
 333     psz_string = strchr( psz_string, ',' );
 334     if ( psz_string )
 335     {
 336         /* *** "EXTINF:time,artist,name" */
 337         *psz_string = '\0';
 338         *ppsz_artist = psz_item;
 339         *ppsz_name = psz_string+1;
 340     }
 341     else
 342     {
 343         /* *** "EXTINF:time,name" */
 344         *ppsz_name = psz_item;
 345     }
 346     return;
 347 }
 348