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

   1 /*****************************************************************************
   2  * sgimb.c: a meta demux to parse sgimb referrer files
   3  *****************************************************************************
   4  * Copyright (C) 2004 the VideoLAN team
   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
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, 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 readible 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 #include <vlc/vlc.h>
 102 #include <vlc_demux.h>
 103 #include "playlist.h"
 104
 105 /*****************************************************************************
 106  * Local prototypes
 107  *****************************************************************************/
 108 #define MAX_LINE 1024
 109
 110 struct demux_sys_t
 111 {
 112     char        *psz_uri;       /* Stream= or sgiQTFileBegin rtsp link */
 113     char        *psz_server;    /* sgiNameServerHost= */
 114     char        *psz_location;  /* sgiMovieName= */
 115     char        *psz_name;      /* sgiShowingName= */
 116     char        *psz_user;      /* sgiUserAccount= */
 117     char        *psz_password;  /* sgiUserPassword= */
 118     char        *psz_mcast_ip;  /* sgiMulticastAddress= */
 119     int         i_mcast_port;   /* sgiMulticastPort= */
 120     int         i_packet_size;  /* sgiPacketSize= */
 121     mtime_t     i_duration;     /* sgiDuration= */
 122     int         i_port;         /* sgiRtspPort= */
 123     int         i_sid;          /* sgiSid= */
 124     vlc_bool_t  b_concert;      /* DeliveryService=cds */
 125     vlc_bool_t  b_rtsp_kasenna; /* kasenna style RTSP */
 126 };
 127
 128 static int Demux ( demux_t *p_demux );
 129 static int Control( demux_t *p_demux, int i_query, va_list args );
 130
 131 /*****************************************************************************
 132  * Activate: initializes m3u demux structures
 133  *****************************************************************************/
 134 int E_(Import_SGIMB)( vlc_object_t * p_this )
 135 {
 136     demux_t *p_demux = (demux_t *)p_this;
 137     const byte_t *p_peek;
 138     int i_size;
 139
 140     /* Lets check the content to see if this is a sgi mediabase file */
 141     i_size = stream_Peek( p_demux->s, &p_peek, MAX_LINE );
 142     i_size -= sizeof("sgiNameServerHost=") - 1;
 143     if ( i_size > 0 )
 144     {
 145         unsigned int i_len = sizeof("sgiNameServerHost=") - 1;
 146         while ( i_size && strncasecmp( (char *)p_peek, "sgiNameServerHost=", i_len ) )
 147         {
 148             p_peek++;
 149             i_size--;
 150         }
 151         if ( !strncasecmp( (char *)p_peek, "sgiNameServerHost=", i_len ) )
 152         {
 153             STANDARD_DEMUX_INIT_MSG( "using SGIMB playlist reader" );
 154             p_demux->p_sys->psz_uri = NULL;
 155             p_demux->p_sys->psz_server = NULL;
 156             p_demux->p_sys->psz_location = NULL;
 157             p_demux->p_sys->psz_name = NULL;
 158             p_demux->p_sys->psz_user = NULL;
 159             p_demux->p_sys->psz_password = NULL;
 160             p_demux->p_sys->psz_mcast_ip = NULL;
 161             p_demux->p_sys->i_mcast_port = 0;
 162             p_demux->p_sys->i_packet_size = 0;
 163             p_demux->p_sys->i_duration = 0;
 164             p_demux->p_sys->i_port = 0;
 165             p_demux->p_sys->i_sid = 0;
 166             p_demux->p_sys->b_rtsp_kasenna = VLC_FALSE;
 167             p_demux->p_sys->b_concert = VLC_FALSE;
 168
 169             return VLC_SUCCESS;
 170         }
 171     }
 172     return VLC_EGENERIC;
 173 }
 174
 175 /*****************************************************************************
 176  * Deactivate: frees unused data
 177  *****************************************************************************/
 178 void E_(Close_SGIMB)( vlc_object_t *p_this )
 179 {
 180     demux_t *p_demux = (demux_t*)p_this;
 181     demux_sys_t *p_sys = p_demux->p_sys;
 182     if( p_sys->psz_uri )
 183         free( p_sys->psz_uri );
 184     if( p_sys->psz_server )
 185         free( p_sys->psz_server );
 186     if( p_sys->psz_location )
 187         free( p_sys->psz_location );
 188     if( p_sys->psz_name )
 189         free( p_sys->psz_name );
 190     if( p_sys->psz_user )
 191         free( p_sys->psz_user );
 192     if( p_sys->psz_password )
 193         free( p_sys->psz_password );
 194     if( p_sys->psz_mcast_ip )
 195         free( p_sys->psz_mcast_ip );
 196     free( p_demux->p_sys );
 197     return;
 198 }
 199
 200 static int ParseLine ( demux_t *p_demux, char *psz_line )
 201 {
 202     char        *psz_bol;
 203     demux_sys_t *p_sys = p_demux->p_sys;
 204
 205     psz_bol = psz_line;
 206
 207     /* Remove unnecessary tabs or spaces at the beginning of line */
 208     while( *psz_bol == ' ' || *psz_bol == '\t' ||
 209            *psz_bol == '\n' || *psz_bol == '\r' )
 210     {
 211         psz_bol++;
 212     }
 213
 214     if( !strncasecmp( psz_bol, "rtsp://", sizeof("rtsp://") - 1 ) )
 215     {
 216         /* We found the link, it was inside a sgiQTFileBegin */
 217         p_sys->psz_uri = strdup( psz_bol );
 218     }
 219     else if( !strncasecmp( psz_bol, "Stream=\"", sizeof("Stream=\"") - 1 ) )
 220     {
 221         psz_bol += sizeof("Stream=\"") - 1;
 222         if ( !psz_bol )
 223             return 0;
 224         strrchr( psz_bol, '"' )[0] = '\0';
 225         /* We cheat around xdma. for some reason xdma links work different then rtsp */
 226         if( !strncasecmp( psz_bol, "xdma://", sizeof("xdma://") - 1 ) )
 227         {
 228             psz_bol[0] = 'r';
 229             psz_bol[1] = 't';
 230             psz_bol[2] = 's';
 231             psz_bol[3] = 'p';
 232         }
 233         p_sys->psz_uri = strdup( psz_bol );
 234     }
 235     else if( !strncasecmp( psz_bol, "sgiNameServerHost=", sizeof("sgiNameServerHost=") - 1 ) )
 236     {
 237         psz_bol += sizeof("sgiNameServerHost=") - 1;
 238         p_sys->psz_server = strdup( psz_bol );
 239     }
 240     else if( !strncasecmp( psz_bol, "sgiMovieName=", sizeof("sgiMovieName=") - 1 ) )
 241     {
 242         psz_bol += sizeof("sgiMovieName=") - 1;
 243         p_sys->psz_location = strdup( psz_bol );
 244     }
 245     else if( !strncasecmp( psz_bol, "sgiUserAccount=", sizeof("sgiUserAccount=") - 1 ) )
 246     {
 247         psz_bol += sizeof("sgiUserAccount=") - 1;
 248         p_sys->psz_user = strdup( psz_bol );
 249     }
 250     else if( !strncasecmp( psz_bol, "sgiUserPassword=", sizeof("sgiUserPassword=") - 1 ) )
 251     {
 252         psz_bol += sizeof("sgiUserPassword=") - 1;
 253         p_sys->psz_password = strdup( psz_bol );
 254     }
 255     else if( !strncasecmp( psz_bol, "sgiShowingName=", sizeof("sgiShowingName=") - 1 ) )
 256     {
 257         psz_bol += sizeof("sgiShowingName=") - 1;
 258         p_sys->psz_name = strdup( psz_bol );
 259     }
 260     else if( !strncasecmp( psz_bol, "sgiFormatName=", sizeof("sgiFormatName=") - 1 ) )
 261     {
 262         psz_bol += sizeof("sgiFormatName=") - 1;
 263         if( strcasestr( psz_bol, "MPEG-4") == NULL ) /*not mpeg4 found in string */
 264             p_sys->b_rtsp_kasenna = VLC_TRUE;
 265     }
 266     else if( !strncasecmp( psz_bol, "sgiMulticastAddress=", sizeof("sgiMulticastAddress=") - 1 ) )
 267     {
 268         psz_bol += sizeof("sgiMulticastAddress=") - 1;
 269         p_sys->psz_mcast_ip = strdup( psz_bol );
 270     }
 271     else if( !strncasecmp( psz_bol, "sgiMulticastPort=", sizeof("sgiMulticastPort=") - 1 ) )
 272     {
 273         psz_bol += sizeof("sgiMulticastPort=") - 1;
 274         p_sys->i_mcast_port = (int) strtol( psz_bol, NULL, 0 );
 275     }
 276     else if( !strncasecmp( psz_bol, "sgiPacketSize=", sizeof("sgiPacketSize=") - 1 ) )
 277     {
 278         psz_bol += sizeof("sgiPacketSize=") - 1;
 279         p_sys->i_packet_size = (int) strtol( psz_bol, NULL, 0 );
 280     }
 281     else if( !strncasecmp( psz_bol, "sgiDuration=", sizeof("sgiDuration=") - 1 ) )
 282     {
 283         psz_bol += sizeof("sgiDuration=") - 1;
 284         p_sys->i_duration = (mtime_t) strtol( psz_bol, NULL, 0 );
 285     }
 286     else if( !strncasecmp( psz_bol, "sgiRtspPort=", sizeof("sgiRtspPort=") - 1 ) )
 287     {
 288         psz_bol += sizeof("sgiRtspPort=") - 1;
 289         p_sys->i_port = (int) strtol( psz_bol, NULL, 0 );
 290     }
 291     else if( !strncasecmp( psz_bol, "sgiSid=", sizeof("sgiSid=") - 1 ) )
 292     {
 293         psz_bol += sizeof("sgiSid=") - 1;
 294         p_sys->i_sid = (int) strtol( psz_bol, NULL, 0 );
 295     }
 296     else if( !strncasecmp( psz_bol, "DeliveryService=cds", sizeof("DeliveryService=cds") - 1 ) )
 297     {
 298         p_sys->b_concert = VLC_TRUE;
 299     }
 300     else
 301     {
 302         /* This line isn't really important */
 303         return 0;
 304     }
 305     return VLC_SUCCESS;
 306 }
 307
 308 /*****************************************************************************
 309  * Demux: reads and demuxes data packets
 310  *****************************************************************************
 311  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
 312  *****************************************************************************/
 313 static int Demux ( demux_t *p_demux )
 314 {
 315     demux_sys_t     *p_sys = p_demux->p_sys;
 316     input_item_t    *p_child = NULL;
 317     char            *psz_line;
 318
 319     INIT_PLAYLIST_STUFF;
 320
 321     while( ( psz_line = stream_ReadLine( p_demux->s ) ) )
 322     {
 323         ParseLine( p_demux, psz_line );
 324         if( psz_line ) free( psz_line );
 325     }
 326
 327     if( p_sys->psz_mcast_ip )
 328     {
 329         /* Definetly schedules multicast session */
 330         /* We don't care if it's live or not */
 331         char *temp;
 332
 333         asprintf( &temp, "udp://@" "%s:%i", p_sys->psz_mcast_ip, p_sys->i_mcast_port );
 334         if( p_sys->psz_uri ) free( p_sys->psz_uri );
 335         p_sys->psz_uri = strdup( temp );
 336         free( temp );
 337     }
 338
 339     if( p_sys->psz_uri == NULL )
 340     {
 341         if( p_sys->psz_server && p_sys->psz_location )
 342         {
 343             char *temp;
 344
 345             asprintf( &temp, "rtsp://" "%s:%i%s",
 346                      p_sys->psz_server, p_sys->i_port > 0 ? p_sys->i_port : 554, p_sys->psz_location );
 347
 348             p_sys->psz_uri = strdup( temp );
 349             free( temp );
 350         }
 351     }
 352
 353     if( p_sys->b_concert )
 354     {
 355         /* It's definetly a simulcasted scheduled stream */
 356         /* We don't care if it's live or not */
 357         char *temp;
 358
 359         if( p_sys->psz_uri == NULL )
 360         {
 361             msg_Err( p_demux, "no URI was found" );
 362             return -1;
 363         }
 364
 365         asprintf( &temp, "%s%%3FMeDiAbAsEshowingId=%d%%26MeDiAbAsEconcert%%3FMeDiAbAsE",
 366                 p_sys->psz_uri, p_sys->i_sid );
 367
 368         free( p_sys->psz_uri );
 369         p_sys->psz_uri = strdup( temp );
 370         free( temp );
 371     }
 372
 373     p_child = input_ItemNewWithType( (vlc_object_t *)p_playlist, p_sys->psz_uri,
 374                       p_sys->psz_name ? p_sys->psz_name : p_sys->psz_uri,
 375                       0, NULL, p_sys->i_duration, ITEM_TYPE_NET );
 376
 377     if( !p_child )
 378     {
 379         msg_Err( p_demux, "A valid playlistitem could not be created" );
 380         return -1;
 381     }
 382
 383     input_ItemCopyOptions( p_current_input, p_child );
 384     if( p_sys->i_packet_size && p_sys->psz_mcast_ip )
 385     {
 386         char *psz_option;
 387         p_sys->i_packet_size += 1000;
 388         asprintf( &psz_option, "mtu=%i", p_sys->i_packet_size );
 389         input_ItemAddOption( p_child, psz_option );
 390         free( psz_option );
 391     }
 392     if( !p_sys->psz_mcast_ip )
 393     {
 394         char *psz_option;
 395         asprintf( &psz_option, "rtsp-caching=5000" );
 396         input_ItemAddOption( p_child, psz_option );
 397         free( psz_option );
 398     }
 399     if( !p_sys->psz_mcast_ip && p_sys->b_rtsp_kasenna )
 400     {
 401         char *psz_option;
 402         asprintf( &psz_option, "rtsp-kasenna" );
 403         input_ItemAddOption( p_child, psz_option );
 404         free( psz_option );
 405     }
 406
 407     input_ItemAddSubItem( p_current_input, p_child );
 408     vlc_gc_decref( p_child );
 409     HANDLE_PLAY_AND_RELEASE
 410     return 0; /* Needed for correct operation of go back */
 411 }
 412
 413 static int Control( demux_t *p_demux, int i_query, va_list args )
 414 {
 415     return VLC_EGENERIC;
 416 }
 417