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 };
  43
  44 /*****************************************************************************
  45  * Local prototypes
  46  *****************************************************************************/
  47 static int Demux( demux_t *p_demux);
  48 static int Control( demux_t *p_demux, int i_query, va_list args );
  49 static void parseEXTINF( char *psz_string, char **ppsz_artist, char **ppsz_name, int *pi_duration );
  50 static bool ContainsURL( demux_t *p_demux );
  51
  52 /*****************************************************************************
  53  * Import_M3U: main import function
  54  *****************************************************************************/
  55 int Import_M3U( vlc_object_t *p_this )
  56 {
  57     demux_t *p_demux = (demux_t *)p_this;
  58     const uint8_t *p_peek;
  59     CHECK_PEEK( p_peek, 8 );
  60
  61     if(! ( POKE( p_peek, "#EXTM3U", 7 ) || POKE( p_peek, "RTSPtext", 8 ) ||
  62            demux_IsPathExtension( p_demux, ".m3u" ) || demux_IsPathExtension( p_demux, ".vlc" ) ||
  63            /* A .ram file can contain a single rtsp link */
  64            demux_IsPathExtension( p_demux, ".ram" ) || demux_IsPathExtension( p_demux, ".rm" ) ||
  65            demux_IsForced( p_demux,  "m3u" ) || ContainsURL( p_demux ) ) )
  66         return VLC_EGENERIC;
  67
  68     STANDARD_DEMUX_INIT_MSG( "found valid M3U playlist" );
  69     p_demux->p_sys->psz_prefix = FindPrefix( p_demux );
  70
  71     return VLC_SUCCESS;
  72 }
  73
  74 static bool ContainsURL( demux_t *p_demux )
  75 {
  76     uint8_t *p_peek;
  77     int i_peek;
  78     uint8_t *p_peek_end;
  79
  80     i_peek = stream_Peek( p_demux->s, &p_peek, 1024 );
  81     if( i_peek <= 0 ) return false;
  82     p_peek_end = p_peek + i_peek;
  83
  84     while( p_peek + sizeof( "https://" ) < p_peek_end )
  85     {
  86         /* One line starting with an URL is enough */
  87         if( !strncasecmp( p_peek, "http://", sizeof( "http://" ) - 1 ) ||
  88             !strncasecmp( p_peek, "mms://", sizeof( "mms://" ) - 1 ) ||
  89             !strncasecmp( p_peek, "rtsp://", sizeof( "rtsp://" ) - 1 ) ||
  90             !strncasecmp( p_peek, "https://", sizeof( "https://" ) - 1 ) ||
  91             !strncasecmp( p_peek, "ftp://", sizeof( "ftp://" ) - 1 ) )
  92         {
  93             return true;
  94         }
  95         /* Comments and blank lines are ignored */
  96         else if( *p_peek != '#' && *p_peek != '\n' && *p_peek != '\r')
  97         {
  98             return false;
  99         }
 100
 101         while( p_peek < p_peek_end && *p_peek != '\n' )
 102             p_peek++;
 103         if ( *p_peek == '\n' )
 104             p_peek++;
 105     }
 106     return false;
 107 }
 108
 109 /*****************************************************************************
 110  * Deactivate: frees unused data
 111  *****************************************************************************/
 112 void Close_M3U( vlc_object_t *p_this )
 113 {
 114     demux_t *p_demux = (demux_t *)p_this;
 115     free( p_demux->p_sys->psz_prefix );
 116     free( p_demux->p_sys );
 117 }
 118
 119
 120 /* Gruik! */
 121 static inline char *MaybeFromLocaleDup (const char *str)
 122 {
 123     if (str == NULL)
 124         return NULL;
 125
 126     return IsUTF8 (str) ? strdup (str) : FromLocaleDup (str);
 127 }
 128
 129
 130 static inline void MaybeFromLocaleRep (char **str)
 131 {
 132     char *const orig_str = *str;
 133
 134     if ((orig_str != NULL) && !IsUTF8 (orig_str))
 135     {
 136         *str = FromLocaleDup (orig_str);
 137         free (orig_str);
 138     }
 139 }
 140
 141
 142 static int Demux( demux_t *p_demux )
 143 {
 144     char       *psz_line;
 145     char       *psz_name = NULL;
 146     char       *psz_artist = NULL;
 147     int        i_parsed_duration = 0;
 148     mtime_t    i_duration = -1;
 149     const char**ppsz_options = NULL;
 150     int        i_options = 0;
 151     bool b_cleanup = false;
 152     input_item_t *p_input;
 153
 154     INIT_PLAYLIST_STUFF;
 155
 156     psz_line = stream_ReadLine( p_demux->s );
 157     while( psz_line )
 158     {
 159         char *psz_parse = psz_line;
 160
 161         /* Skip leading tabs and spaces */
 162         while( *psz_parse == ' ' || *psz_parse == '\t' ||
 163                *psz_parse == '\n' || *psz_parse == '\r' ) psz_parse++;
 164
 165         if( *psz_parse == '#' )
 166         {
 167             /* Parse extra info */
 168
 169             /* Skip leading tabs and spaces */
 170             while( *psz_parse == ' ' || *psz_parse == '\t' ||
 171                    *psz_parse == '\n' || *psz_parse == '\r' ||
 172                    *psz_parse == '#' ) psz_parse++;
 173
 174             if( !*psz_parse ) goto error;
 175
 176             if( !strncasecmp( psz_parse, "EXTINF:", sizeof("EXTINF:") -1 ) )
 177             {
 178                 /* Extended info */
 179                 psz_parse += sizeof("EXTINF:") - 1;
 180                 parseEXTINF( psz_parse, &psz_artist, &psz_name, &i_parsed_duration );
 181                 if( i_parsed_duration >= 0 )
 182                     i_duration = i_parsed_duration * INT64_C(1000000);
 183                 if( psz_name )
 184                     psz_name = strdup( psz_name );
 185                 if( psz_artist )
 186                     psz_artist = strdup( psz_artist );
 187             }
 188             else if( !strncasecmp( psz_parse, "EXTVLCOPT:",
 189                                    sizeof("EXTVLCOPT:") -1 ) )
 190             {
 191                 /* VLC Option */
 192                 char *psz_option;
 193                 psz_parse += sizeof("EXTVLCOPT:") -1;
 194                 if( !*psz_parse ) goto error;
 195
 196                 psz_option = MaybeFromLocaleDup( psz_parse );
 197                 if( psz_option )
 198                     INSERT_ELEM( ppsz_options, i_options, i_options,
 199                                  psz_option );
 200             }
 201         }
 202         else if( !strncasecmp( psz_parse, "RTSPtext", sizeof("RTSPtext") -1 ) )
 203         {
 204             ;/* special case to handle QuickTime RTSPtext redirect files */
 205         }
 206         else if( *psz_parse )
 207         {
 208             char *psz_mrl;
 209             if( !psz_name || !*psz_name )
 210             {
 211                 /* Use filename as name for relative entries */
 212                 psz_name = MaybeFromLocaleDup( psz_parse );
 213             }
 214
 215             psz_mrl = ProcessMRL( psz_parse, p_demux->p_sys->psz_prefix );
 216             MaybeFromLocaleRep( &psz_mrl );
 217
 218             b_cleanup = true;
 219             if( !psz_mrl ) goto error;
 220
 221             p_input = input_ItemNewExt( p_demux, psz_mrl, psz_name,
 222                                         0, NULL, i_duration );
 223
 224             if ( psz_artist && *psz_artist )
 225                 input_item_SetArtist( p_input, psz_artist );
 226
 227             input_ItemAddSubItem( p_current_input, p_input );
 228             for( int i = 0; i < i_options; i++ )
 229                 input_ItemAddOpt( p_input, ppsz_options[i], 0 );
 230             vlc_gc_decref( p_input );
 231             free( psz_mrl );
 232         }
 233
 234  error:
 235
 236         /* Fetch another line */
 237         free( psz_line );
 238         psz_line = stream_ReadLine( p_demux->s );
 239         if( !psz_line ) b_cleanup = true;
 240
 241         if( b_cleanup )
 242         {
 243             /* Cleanup state */
 244             while( i_options-- ) free( (char*)ppsz_options[i_options] );
 245             free( ppsz_options );
 246             ppsz_options = NULL; i_options = 0;
 247             free( psz_name );
 248             psz_name = NULL;
 249             free( psz_artist );
 250             psz_artist = NULL;
 251             i_parsed_duration = 0;
 252             i_duration = -1;
 253
 254             b_cleanup = false;
 255         }
 256     }
 257     HANDLE_PLAY_AND_RELEASE;
 258     var_Destroy( p_demux, "m3u-extvlcopt" );
 259     return 0; /* Needed for correct operation of go back */
 260 }
 261
 262 static int Control( demux_t *p_demux, int i_query, va_list args )
 263 {
 264     VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
 265     return VLC_EGENERIC;
 266 }
 267
 268 static void parseEXTINF(char *psz_string, char **ppsz_artist,
 269                         char **ppsz_name, int *pi_duration)
 270 {
 271     char *end = NULL;
 272     char *psz_item = NULL;
 273
 274     end = psz_string + strlen( psz_string );
 275
 276     /* ignore whitespaces */
 277     for (; psz_string < end && ( *psz_string == '\t' || *psz_string == ' ' );
 278          psz_string++ );
 279
 280     /* duration: read to next comma */
 281     psz_item = psz_string;
 282     psz_string = strchr( psz_string, ',' );
 283     if ( psz_string )
 284     {
 285         *psz_string = '\0';
 286         *pi_duration = atoi( psz_item );
 287     }
 288     else
 289     {
 290         return;
 291     }
 292
 293     if ( psz_string < end )               /* continue parsing if possible */
 294         psz_string++;
 295
 296     /* analyse the remaining string */
 297     psz_item = strstr( psz_string, " - " );
 298
 299     /* here we have the 0.8.2+ format with artist */
 300     if ( psz_item )
 301     {
 302         /* *** "EXTINF:time,artist - name" */
 303         *psz_item = '\0';
 304         *ppsz_artist = psz_string;
 305         *ppsz_name = psz_item + 3;          /* points directly after ' - ' */
 306         return;
 307     }
 308
 309     /* reaching this point means: 0.8.1- with artist or something without artist */
 310     if ( *psz_string == ',' )
 311     {
 312         /* *** "EXTINF:time,,name" */
 313         psz_string++;
 314         *ppsz_name = psz_string;
 315         return;
 316     }
 317
 318     psz_item = psz_string;
 319     psz_string = strchr( psz_string, ',' );
 320     if ( psz_string )
 321     {
 322         /* *** "EXTINF:time,artist,name" */
 323         *psz_string = '\0';
 324         *ppsz_artist = psz_item;
 325         *ppsz_name = psz_string+1;
 326     }
 327     else
 328     {
 329         /* *** "EXTINF:time,name" */
 330         *ppsz_name = psz_item;
 331     }
 332     return;
 333 }
 334