modules/demux/playlist/sgimb.c

   1 /*****************************************************************************
   2  * sgimb.c: a meta demux to parse sgimb referrer files
   3  *****************************************************************************
   4  * Copyright (C) 2004 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Derk-Jan Hartman <hartman at videolan dot org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * This is a metademux for the Kasenna MediaBase metafile format.
  26  * Kasenna MediaBase first returns this file when you are trying to access
  27  * their MPEG streams (MIME: application/x-sgimb). Very few applications
  28  * understand this format and the format is not really documented on the net.
  29  * Following a typical MediaBase file. Notice the sgi prefix of all the elements.
  30  * This stems from the fact that the MediaBase servers were first introduced by SGI?????.
  31  *
  32  * sgiNameServerHost=host.name.tld
  33  *     Obvious: the host hosting this stream
  34  * Stream="xdma://host.name.tld/demo/a_very_cool.mpg"
  35  *     Not always present. xdma can be read as RTSP.
  36  * sgiMovieName=/demo/a_very_cool.mpg
  37  *     The path to the asset
  38  * sgiAuxState=1|2
  39  *     AuxState=2 is always Video On Demand (so not Scheduled)
  40  *     Not present with Live streams
  41  * sgiLiveFeed=True|False
  42  *     Denounces if the stream is live or from assets (Canned?)
  43  *     Live appears as a little sattelite dish in the web interface of Kasenna
  44  * sgiFormatName=PARTNER_41_MPEG-4
  45  *     The type of stream. One of:
  46  *       PARTNER_41_MPEG-4 (RTSP MPEG-4 fully compliant)
  47  *       MPEG1-Audio       (MP3 Audio streams in MPEG TS)
  48  *       MPEG-1            (MPEG 1 A/V in MPEG TS)
  49  *       MPEG-2            (MPEG 2 A/V in MPEG TS)
  50  * sgiWidth=720
  51  *     The width of the to be received stream. Only present if stream is not Live.
  52  * sgiHeight=576
  53  *     The height of the to be received stream. Only present if stream is not Live.
  54  * sgiBitrate=1630208
  55  *     The bitrate of the to be received stream. Only present if stream is not Live.
  56  * sgiDuration=378345000
  57  *     The duration of the to be received stream. Only present if stream is not Live.
  58  * sgiQTFileBegin
  59  * rtsptext
  60  * rtsp://host.name.tld/demo/a_very_cool.mpg
  61  * sgiQTFileEnd
  62  *     Sometimes present. QT will recognize this as a RTSP reference file, if present.
  63  * sgiApplicationName=MediaBaseURL
  64  *     Beats me !! :)
  65  * sgiElapsedTime=0
  66  *     Time passed since the asset was started (resets for repeating non live assets?)
  67  * sgiMulticastAddress=233.81.233.15
  68  *     The multicast IP used for the Multicast feed.
  69  *     Also defines if a stream is multicast or not. (blue dot in kasenna web interface)
  70  * sgiMulticastPort=1234
  71  *     The multicast port for the same Multicast feed.
  72  * sgiPacketSize=16384
  73  *     The packetsize of the UDP frames that Kasenna sends. They should have used a default
  74  *     that is a multiple of 188 (TS frame size). Most networks don't support more than 1500 anyways.
  75  *     Also, when you lose a frame of this size, imagecorruption is more likely then with smaller
  76  *     frames.
  77  * sgiServerVersion=6.1.2
  78  *     Version of the server
  79  * sgiRtspPort=554
  80  *     TCP port used for RTSP communication
  81  * AutoStart=True
  82  *     Start playing automatically
  83  * DeliveryService=cds
  84  *     Simulcasted (scheduled unicast) content. (Green dot in Kasenna web interface)
  85  * sgiShowingName=A nice name that everyone likes
  86  *     A human-readable descriptive title for this stream.
  87  * sgiSid=2311
  88  *     Looks like this is the ID of the scheduled asset?
  89  * sgiUserAccount=pid=1724&time=1078527309&displayText=You%20are%20logged%20as%20guest&
  90  *     User Authentication. Above is a default guest entry. Not required for RTSP communication.
  91  * sgiUserPassword=
  92  *     Password :)
  93  *
  94  *****************************************************************************/
  95
  96
  97 /*****************************************************************************
  98  * Preamble
  99  *****************************************************************************/
 100
 101 #ifdef HAVE_CONFIG_H
 102 # include "config.h"
 103 #endif
 104
 105 #include <vlc_common.h>
 106 #include <vlc_access.h>
 107 #include "playlist.h"
 108
 109 /*****************************************************************************
 110  * Local prototypes
 111  *****************************************************************************/
 112 #define MAX_LINE 1024
 113
 114 struct demux_sys_t
 115 {
 116     char        *psz_uri;       /* Stream= or sgiQTFileBegin rtsp link */
 117     char        *psz_server;    /* sgiNameServerHost= */
 118     char        *psz_location;  /* sgiMovieName= */
 119     char        *psz_name;      /* sgiShowingName= */
 120     char        *psz_user;      /* sgiUserAccount= */
 121     char        *psz_password;  /* sgiUserPassword= */
 122     char        *psz_mcast_ip;  /* sgiMulticastAddress= */
 123     int         i_mcast_port;   /* sgiMulticastPort= */
 124     int         i_packet_size;  /* sgiPacketSize= */
 125     mtime_t     i_duration;     /* sgiDuration= */
 126     int         i_port;         /* sgiRtspPort= */
 127     int         i_sid;          /* sgiSid= */
 128     bool  b_concert;      /* DeliveryService=cds */
 129     bool  b_rtsp_kasenna; /* kasenna style RTSP */
 130 };
 131
 132 static int ReadDir( stream_t *, input_item_node_t * );
 133
 134 /*****************************************************************************
 135  * Activate: initializes m3u demux structures
 136  *****************************************************************************/
 137 int Import_SGIMB( vlc_object_t * p_this )
 138 {
 139     stream_t *p_demux = (stream_t *)p_this;
 140     const uint8_t *p_peek;
 141     int i_size;
 142
 143     CHECK_FILE(p_demux);
 144     /* Lets check the content to see if this is a sgi mediabase file */
 145     i_size = vlc_stream_Peek( p_demux->s, &p_peek, MAX_LINE );
 146     i_size -= sizeof("sgiNameServerHost=") - 1;
 147     if ( i_size > 0 )
 148     {
 149         unsigned int i_len = sizeof("sgiNameServerHost=") - 1;
 150         while ( i_size && strncasecmp( (char *)p_peek, "sgiNameServerHost=", i_len ) )
 151         {
 152             p_peek++;
 153             i_size--;
 154         }
 155         if ( !strncasecmp( (char *)p_peek, "sgiNameServerHost=", i_len ) )
 156         {
 157             demux_sys_t *p_sys = malloc(sizeof (*p_sys));
 158             if( unlikely(p_sys == NULL) )
 159                 return VLC_ENOMEM;
 160
 161             msg_Dbg( p_demux, "using SGIMB playlist reader" );
 162             p_demux->pf_readdir = ReadDir;
 163             p_demux->pf_control = access_vaDirectoryControlHelper;
 164             p_demux->p_sys = p_sys;
 165             p_sys->psz_uri = NULL;
 166             p_sys->psz_server = NULL;
 167             p_sys->psz_location = NULL;
 168             p_sys->psz_name = NULL;
 169             p_sys->psz_user = NULL;
 170             p_sys->psz_password = NULL;
 171             p_sys->psz_mcast_ip = NULL;
 172             p_sys->i_mcast_port = 0;
 173             p_sys->i_packet_size = 0;
 174             p_sys->i_duration = 0;
 175             p_sys->i_port = 0;
 176             p_sys->i_sid = 0;
 177             p_sys->b_rtsp_kasenna = false;
 178             p_sys->b_concert = false;
 179
 180             return VLC_SUCCESS;
 181         }
 182     }
 183     return VLC_EGENERIC;
 184 }
 185
 186 /*****************************************************************************
 187  * Deactivate: frees unused data
 188  *****************************************************************************/
 189 void Close_SGIMB( vlc_object_t *p_this )
 190 {
 191     stream_t *p_demux = (stream_t*)p_this;
 192     demux_sys_t *p_sys = p_demux->p_sys;
 193     free( p_sys->psz_uri );
 194     free( p_sys->psz_server );
 195     free( p_sys->psz_location );
 196     free( p_sys->psz_name );
 197     free( p_sys->psz_user );
 198     free( p_sys->psz_password );
 199     free( p_sys->psz_mcast_ip );
 200     free( p_demux->p_sys );
 201     return;
 202 }
 203
 204 static int ParseLine ( stream_t *p_demux, char *psz_line )
 205 {
 206     char        *psz_bol;
 207     demux_sys_t *p_sys = p_demux->p_sys;
 208
 209     psz_bol = psz_line;
 210
 211     /* Remove unnecessary tabs or spaces at the beginning of line */
 212     while( *psz_bol == ' ' || *psz_bol == '\t' ||
 213            *psz_bol == '\n' || *psz_bol == '\r' )
 214     {
 215         psz_bol++;
 216     }
 217
 218     if( !strncasecmp( psz_bol, "rtsp://", sizeof("rtsp://") - 1 ) )
 219     {
 220         /* We found the link, it was inside a sgiQTFileBegin */
 221         free( p_sys->psz_uri );
 222         p_sys->psz_uri = strdup( psz_bol );
 223     }
 224     else if( !strncasecmp( psz_bol, "Stream=\"", sizeof("Stream=\"") - 1 ) )
 225     {
 226         psz_bol += sizeof("Stream=\"") - 1;
 227         char* psz_tmp = strrchr( psz_bol, '"' );
 228         if( !psz_tmp )
 229             return 0;
 230         psz_tmp[0] = '\0';
 231         /* We cheat around xdma. for some reason xdma links work different then rtsp */
 232         if( !strncasecmp( psz_bol, "xdma://", sizeof("xdma://") - 1 ) )
 233         {
 234             psz_bol[0] = 'r';
 235             psz_bol[1] = 't';
 236             psz_bol[2] = 's';
 237             psz_bol[3] = 'p';
 238         }
 239         free( p_sys->psz_uri );
 240         p_sys->psz_uri = strdup( psz_bol );
 241     }
 242     else if( !strncasecmp( psz_bol, "sgiNameServerHost=", sizeof("sgiNameServerHost=") - 1 ) )
 243     {
 244         psz_bol += sizeof("sgiNameServerHost=") - 1;
 245         free( p_sys->psz_server );
 246         p_sys->psz_server = strdup( psz_bol );
 247     }
 248     else if( !strncasecmp( psz_bol, "sgiMovieName=", sizeof("sgiMovieName=") - 1 ) )
 249     {
 250         psz_bol += sizeof("sgiMovieName=") - 1;
 251         free( p_sys->psz_location );
 252         p_sys->psz_location = strdup( psz_bol );
 253     }
 254     else if( !strncasecmp( psz_bol, "sgiUserAccount=", sizeof("sgiUserAccount=") - 1 ) )
 255     {
 256         psz_bol += sizeof("sgiUserAccount=") - 1;
 257         free( p_sys->psz_user );
 258         p_sys->psz_user = strdup( psz_bol );
 259     }
 260     else if( !strncasecmp( psz_bol, "sgiUserPassword=", sizeof("sgiUserPassword=") - 1 ) )
 261     {
 262         psz_bol += sizeof("sgiUserPassword=") - 1;
 263         free( p_sys->psz_password );
 264         p_sys->psz_password = strdup( psz_bol );
 265     }
 266     else if( !strncasecmp( psz_bol, "sgiShowingName=", sizeof("sgiShowingName=") - 1 ) )
 267     {
 268         psz_bol += sizeof("sgiShowingName=") - 1;
 269         free( p_sys->psz_name );
 270         p_sys->psz_name = strdup( psz_bol );
 271     }
 272     else if( !strncasecmp( psz_bol, "sgiFormatName=", sizeof("sgiFormatName=") - 1 ) )
 273     {
 274         psz_bol += sizeof("sgiFormatName=") - 1;
 275         if( strcasestr( psz_bol, "MPEG-4") == NULL ) /*not mpeg4 found in string */
 276             p_sys->b_rtsp_kasenna = true;
 277     }
 278     else if( !strncasecmp( psz_bol, "sgiMulticastAddress=", sizeof("sgiMulticastAddress=") - 1 ) )
 279     {
 280         psz_bol += sizeof("sgiMulticastAddress=") - 1;
 281         free( p_sys->psz_mcast_ip );
 282         p_sys->psz_mcast_ip = strdup( psz_bol );
 283     }
 284     else if( !strncasecmp( psz_bol, "sgiMulticastPort=", sizeof("sgiMulticastPort=") - 1 ) )
 285     {
 286         psz_bol += sizeof("sgiMulticastPort=") - 1;
 287         p_sys->i_mcast_port = (int) strtol( psz_bol, NULL, 0 );
 288     }
 289     else if( !strncasecmp( psz_bol, "sgiPacketSize=", sizeof("sgiPacketSize=") - 1 ) )
 290     {
 291         psz_bol += sizeof("sgiPacketSize=") - 1;
 292         p_sys->i_packet_size = (int) strtol( psz_bol, NULL, 0 );
 293     }
 294     else if( !strncasecmp( psz_bol, "sgiDuration=", sizeof("sgiDuration=") - 1 ) )
 295     {
 296         psz_bol += sizeof("sgiDuration=") - 1;
 297         p_sys->i_duration = (mtime_t) strtol( psz_bol, NULL, 0 );
 298     }
 299     else if( !strncasecmp( psz_bol, "sgiRtspPort=", sizeof("sgiRtspPort=") - 1 ) )
 300     {
 301         psz_bol += sizeof("sgiRtspPort=") - 1;
 302         p_sys->i_port = (int) strtol( psz_bol, NULL, 0 );
 303     }
 304     else if( !strncasecmp( psz_bol, "sgiSid=", sizeof("sgiSid=") - 1 ) )
 305     {
 306         psz_bol += sizeof("sgiSid=") - 1;
 307         p_sys->i_sid = (int) strtol( psz_bol, NULL, 0 );
 308     }
 309     else if( !strncasecmp( psz_bol, "DeliveryService=cds", sizeof("DeliveryService=cds") - 1 ) )
 310     {
 311         p_sys->b_concert = true;
 312     }
 313     else
 314     {
 315         /* This line isn't really important */
 316         return 0;
 317     }
 318     return VLC_SUCCESS;
 319 }
 320
 321 static int ReadDir( stream_t *p_demux, input_item_node_t *node )
 322 {
 323     demux_sys_t     *p_sys = p_demux->p_sys;
 324     input_item_t    *p_child = NULL;
 325     char            *psz_line;
 326
 327     while( ( psz_line = vlc_stream_ReadLine( p_demux->s ) ) )
 328     {
 329         ParseLine( p_demux, psz_line );
 330         free( psz_line );
 331     }
 332
 333     if( p_sys->psz_mcast_ip )
 334     {
 335         /* Definetly schedules multicast session */
 336         /* We don't care if it's live or not */
 337         free( p_sys->psz_uri );
 338         if( asprintf( &p_sys->psz_uri, "udp://@" "%s:%i", p_sys->psz_mcast_ip, p_sys->i_mcast_port ) == -1 )
 339         {
 340             p_sys->psz_uri = NULL;
 341             return -1;
 342         }
 343     }
 344
 345     if( p_sys->psz_uri == NULL )
 346     {
 347         if( p_sys->psz_server && p_sys->psz_location )
 348         {
 349             if( asprintf( &p_sys->psz_uri, "rtsp://" "%s:%i%s",
 350                      p_sys->psz_server, p_sys->i_port > 0 ? p_sys->i_port : 554, p_sys->psz_location ) == -1 )
 351             {
 352                 p_sys->psz_uri = NULL;
 353                 return -1;
 354             }
 355         }
 356     }
 357
 358     if( p_sys->b_concert )
 359     {
 360         /* It's definetly a simulcasted scheduled stream */
 361         /* We don't care if it's live or not */
 362         if( p_sys->psz_uri == NULL )
 363         {
 364             msg_Err( p_demux, "no URI was found" );
 365             return -1;
 366         }
 367
 368         char *uri;
 369         if( asprintf( &uri, "%s%%3FMeDiAbAsEshowingId=%d%%26MeDiAbAsEconcert"
 370                       "%%3FMeDiAbAsE", p_sys->psz_uri, p_sys->i_sid ) == -1 )
 371             return -1;
 372         free( p_sys->psz_uri );
 373         p_sys->psz_uri = uri;
 374     }
 375
 376     p_child = input_item_NewStream( p_sys->psz_uri,
 377                       p_sys->psz_name ? p_sys->psz_name : p_sys->psz_uri,
 378                       p_sys->i_duration  );
 379
 380     if( !p_child )
 381     {
 382         msg_Err( p_demux, "A valid playlistitem could not be created" );
 383         return -1;
 384     }
 385
 386     if( p_sys->i_packet_size && p_sys->psz_mcast_ip )
 387     {
 388         char *psz_option;
 389         p_sys->i_packet_size += 1000;
 390         if( asprintf( &psz_option, "mtu=%i", p_sys->i_packet_size ) != -1 )
 391         {
 392             input_item_AddOption( p_child, psz_option, VLC_INPUT_OPTION_TRUSTED );
 393             free( psz_option );
 394         }
 395     }
 396     if( !p_sys->psz_mcast_ip )
 397         input_item_AddOption( p_child, "rtsp-caching=5000", VLC_INPUT_OPTION_TRUSTED );
 398     if( !p_sys->psz_mcast_ip && p_sys->b_rtsp_kasenna )
 399         input_item_AddOption( p_child, "rtsp-kasenna", VLC_INPUT_OPTION_TRUSTED );
 400
 401     input_item_node_AppendItem( node, p_child );
 402     input_item_Release( p_child );
 403     return VLC_SUCCESS;
 404 }