git.sesse.net Git - vlc/blob - modules/demux/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 loose 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 #include <stdlib.h>                                      /* malloc(), free() */
 101
 102 #include <vlc/vlc.h>
 103 #include <vlc/input.h>
 104 #include <vlc_playlist.h>
 105
 106 /*****************************************************************************
 107  * Module descriptor
 108  *****************************************************************************/
 109 static int  Activate  ( vlc_object_t * );
 110 static void Deactivate( vlc_object_t * );
 111
 112 vlc_module_begin();
 113     set_description( _("Kasenna MediaBase parser") );
 114     set_category( CAT_INPUT );
 115     set_subcategory( SUBCAT_INPUT_DEMUX );
 116     set_capability( "demux2", 170 );
 117     set_callbacks( Activate, Deactivate );
 118     add_shortcut( "sgimb" );
 119 vlc_module_end();
 120
 121 /*****************************************************************************
 122  * Local prototypes
 123  *****************************************************************************/
 124 #define MAX_LINE 1024
 125
 126 struct demux_sys_t
 127 {
 128     char        *psz_uri;       /* Stream= or sgiQTFileBegin rtsp link */
 129     char        *psz_server;    /* sgiNameServerHost= */
 130     char        *psz_location;  /* sgiMovieName= */
 131     char        *psz_name;      /* sgiShowingName= */
 132     char        *psz_user;      /* sgiUserAccount= */
 133     char        *psz_password;  /* sgiUserPassword= */
 134     char        *psz_mcast_ip;  /* sgiMulticastAddress= */
 135     int         i_mcast_port;   /* sgiMulticastPort= */
 136     int         i_packet_size;  /* sgiPacketSize= */
 137     mtime_t     i_duration;     /* sgiDuration= */
 138     int         i_port;         /* sgiRtspPort= */
 139     int         i_sid;          /* sgiSid= */
 140     vlc_bool_t  b_concert;      /* DeliveryService=cds */
 141     vlc_bool_t  b_rtsp_kasenna; /* kasenna style RTSP */
 142 };
 143
 144 static int Demux ( demux_t *p_demux );
 145 static int Control( demux_t *p_demux, int i_query, va_list args );
 146
 147 /*****************************************************************************
 148  * Activate: initializes m3u demux structures
 149  *****************************************************************************/
 150 static int Activate( vlc_object_t * p_this )
 151 {
 152     demux_t *p_demux = (demux_t *)p_this;
 153     demux_sys_t *p_sys;
 154     byte_t *p_peek;
 155     int i_size;
 156
 157     /* Lets check the content to see if this is a sgi mediabase file */
 158     i_size = stream_Peek( p_demux->s, &p_peek, MAX_LINE );
 159     i_size -= sizeof("sgiNameServerHost=") - 1;
 160     if ( i_size > 0 )
 161     {
 162         while ( i_size && strncasecmp( p_peek, "sgiNameServerHost=",
 163                                        sizeof("sgiNameServerHost=") - 1 ) )
 164         {
 165             p_peek++;
 166             i_size--;
 167         }
 168         if ( !strncasecmp( p_peek, "sgiNameServerHost=",
 169                            sizeof("sgiNameServerHost=") -1 ) )
 170         {
 171             p_demux->pf_demux = Demux;
 172             p_demux->pf_control = Control;
 173
 174             p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
 175             p_sys->psz_uri = NULL;
 176             p_sys->psz_server = NULL;
 177             p_sys->psz_location = NULL;
 178             p_sys->psz_name = NULL;
 179             p_sys->psz_user = NULL;
 180             p_sys->psz_password = NULL;
 181             p_sys->psz_mcast_ip = NULL;
 182             p_sys->i_mcast_port = 0;
 183             p_sys->i_packet_size = 0;
 184             p_sys->i_duration = 0;
 185             p_sys->i_port = 0;
 186             p_sys->i_sid = 0;
 187             p_sys->b_rtsp_kasenna = VLC_FALSE;
 188             p_sys->b_concert = VLC_FALSE;
 189
 190             return VLC_SUCCESS;
 191         }
 192     }
 193     return VLC_EGENERIC;
 194 }
 195
 196 /*****************************************************************************
 197  * Deactivate: frees unused data
 198  *****************************************************************************/
 199 static void Deactivate( vlc_object_t *p_this )
 200 {
 201     demux_t *p_demux = (demux_t*)p_this;
 202     demux_sys_t *p_sys = p_demux->p_sys;
 203     if( p_sys->psz_uri )
 204         free( p_sys->psz_uri );
 205     if( p_sys->psz_server )
 206         free( p_sys->psz_server );
 207     if( p_sys->psz_location )
 208         free( p_sys->psz_location );
 209     if( p_sys->psz_name )
 210         free( p_sys->psz_name );
 211     if( p_sys->psz_user )
 212         free( p_sys->psz_user );
 213     if( p_sys->psz_password )
 214         free( p_sys->psz_password );
 215     if( p_sys->psz_mcast_ip )
 216         free( p_sys->psz_mcast_ip );
 217     free( p_demux->p_sys );
 218     return;
 219 }
 220
 221 static int ParseLine ( demux_t *p_demux, char *psz_line )
 222 {
 223     char        *psz_bol;
 224     demux_sys_t *p_sys = p_demux->p_sys;
 225
 226     psz_bol = psz_line;
 227
 228     /* Remove unnecessary tabs or spaces at the beginning of line */
 229     while( *psz_bol == ' ' || *psz_bol == '\t' ||
 230            *psz_bol == '\n' || *psz_bol == '\r' )
 231     {
 232         psz_bol++;
 233     }
 234
 235     if( !strncasecmp( psz_bol, "rtsp://", sizeof("rtsp://") - 1 ) )
 236     {
 237         /* We found the link, it was inside a sgiQTFileBegin */
 238         p_sys->psz_uri = strdup( psz_bol );
 239     }
 240     else if( !strncasecmp( psz_bol, "Stream=\"", sizeof("Stream=\"") - 1 ) )
 241     {
 242         psz_bol += sizeof("Stream=\"") - 1;
 243         if ( !psz_bol )
 244             return 0;
 245         strrchr( psz_bol, '"' )[0] = '\0';
 246         /* We cheat around xdma. for some reason xdma links work different then rtsp */
 247         if( !strncasecmp( psz_bol, "xdma://", sizeof("xdma://") - 1 ) )
 248         {
 249             psz_bol[0] = 'r';
 250             psz_bol[1] = 't';
 251             psz_bol[2] = 's';
 252             psz_bol[3] = 'p';
 253         }
 254         p_sys->psz_uri = strdup( psz_bol );
 255     }
 256     else if( !strncasecmp( psz_bol, "sgiNameServerHost=", sizeof("sgiNameServerHost=") - 1 ) )
 257     {
 258         psz_bol += sizeof("sgiNameServerHost=") - 1;
 259         p_sys->psz_server = strdup( psz_bol );
 260     }
 261     else if( !strncasecmp( psz_bol, "sgiMovieName=", sizeof("sgiMovieName=") - 1 ) )
 262     {
 263         psz_bol += sizeof("sgiMovieName=") - 1;
 264         p_sys->psz_location = strdup( psz_bol );
 265     }
 266     else if( !strncasecmp( psz_bol, "sgiUserAccount=", sizeof("sgiUserAccount=") - 1 ) )
 267     {
 268         psz_bol += sizeof("sgiUserAccount=") - 1;
 269         p_sys->psz_user = strdup( psz_bol );
 270     }
 271     else if( !strncasecmp( psz_bol, "sgiUserPassword=", sizeof("sgiUserPassword=") - 1 ) )
 272     {
 273         psz_bol += sizeof("sgiUserPassword=") - 1;
 274         p_sys->psz_password = strdup( psz_bol );
 275     }
 276     else if( !strncasecmp( psz_bol, "sgiShowingName=", sizeof("sgiShowingName=") - 1 ) )
 277     {
 278         psz_bol += sizeof("sgiShowingName=") - 1;
 279         p_sys->psz_name = strdup( psz_bol );
 280     }
 281     else if( !strncasecmp( psz_bol, "sgiFormatName=", sizeof("sgiFormatName=") - 1 ) )
 282     {
 283         psz_bol += sizeof("sgiFormatName=") - 1;
 284         if( strcasestr( psz_bol, "MPEG-4") == NULL ) /*not mpeg4 found in string */
 285             p_sys->b_rtsp_kasenna = VLC_TRUE;
 286     }
 287     else if( !strncasecmp( psz_bol, "sgiMulticastAddress=", sizeof("sgiMulticastAddress=") - 1 ) )
 288     {
 289         psz_bol += sizeof("sgiMulticastAddress=") - 1;
 290         p_sys->psz_mcast_ip = strdup( psz_bol );
 291     }
 292     else if( !strncasecmp( psz_bol, "sgiMulticastPort=", sizeof("sgiMulticastPort=") - 1 ) )
 293     {
 294         psz_bol += sizeof("sgiMulticastPort=") - 1;
 295         p_sys->i_mcast_port = (int) strtol( psz_bol, NULL, 0 );
 296     }
 297     else if( !strncasecmp( psz_bol, "sgiPacketSize=", sizeof("sgiPacketSize=") - 1 ) )
 298     {
 299         psz_bol += sizeof("sgiPacketSize=") - 1;
 300         p_sys->i_packet_size = (int) strtol( psz_bol, NULL, 0 );
 301     }
 302     else if( !strncasecmp( psz_bol, "sgiDuration=", sizeof("sgiDuration=") - 1 ) )
 303     {
 304         psz_bol += sizeof("sgiDuration=") - 1;
 305         p_sys->i_duration = (mtime_t) strtol( psz_bol, NULL, 0 );
 306     }
 307     else if( !strncasecmp( psz_bol, "sgiRtspPort=", sizeof("sgiRtspPort=") - 1 ) )
 308     {
 309         psz_bol += sizeof("sgiRtspPort=") - 1;
 310         p_sys->i_port = (int) strtol( psz_bol, NULL, 0 );
 311     }
 312     else if( !strncasecmp( psz_bol, "sgiSid=", sizeof("sgiSid=") - 1 ) )
 313     {
 314         psz_bol += sizeof("sgiSid=") - 1;
 315         p_sys->i_sid = (int) strtol( psz_bol, NULL, 0 );
 316     }
 317     else if( !strncasecmp( psz_bol, "DeliveryService=cds", sizeof("DeliveryService=cds") - 1 ) )
 318     {
 319         p_sys->b_concert = VLC_TRUE;
 320     }
 321     else
 322     {
 323         /* This line isn't really important */
 324         return 0;
 325     }
 326     return VLC_SUCCESS;
 327 }
 328
 329 /*****************************************************************************
 330  * Demux: reads and demuxes data packets
 331  *****************************************************************************
 332  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
 333  *****************************************************************************/
 334 static int Demux ( demux_t *p_demux )
 335 {
 336     demux_sys_t     *p_sys = p_demux->p_sys;
 337     playlist_t      *p_playlist;
 338     playlist_item_t *p_item;
 339     playlist_item_t *p_child;
 340
 341     char            *psz_line;
 342
 343     p_playlist = (playlist_t *) vlc_object_find( p_demux, VLC_OBJECT_PLAYLIST,
 344                                                  FIND_ANYWHERE );
 345     if( !p_playlist )
 346     {
 347         msg_Err( p_demux, "can't find playlist" );
 348         return -1;
 349     }
 350
 351     p_item = playlist_LockItemGetByInput( p_playlist,
 352                         ((input_thread_t *)p_demux->p_parent)->input.p_item );
 353     playlist_ItemToNode( p_playlist, p_item );
 354
 355     while( ( psz_line = stream_ReadLine( p_demux->s ) ) )
 356     {
 357         ParseLine( p_demux, psz_line );
 358         if( psz_line ) free( psz_line );
 359     }
 360
 361     if( p_sys->psz_mcast_ip )
 362     {
 363         /* Definetly schedules multicast session */
 364         /* We don't care if it's live or not */
 365         char *temp;
 366
 367         asprintf( &temp, "udp://@" "%s:%i", p_sys->psz_mcast_ip, p_sys->i_mcast_port );
 368         if( p_sys->psz_uri ) free( p_sys->psz_uri );
 369         p_sys->psz_uri = strdup( temp );
 370         free( temp );
 371     }
 372
 373     if( p_sys->psz_uri == NULL )
 374     {
 375         if( p_sys->psz_server && p_sys->psz_location )
 376         {
 377             char *temp;
 378
 379             asprintf( &temp, "rtsp://" "%s:%i%s",
 380                      p_sys->psz_server, p_sys->i_port > 0 ? p_sys->i_port : 554, p_sys->psz_location );
 381
 382             p_sys->psz_uri = strdup( temp );
 383             free( temp );
 384         }
 385     }
 386
 387     if( p_sys->b_concert )
 388     {
 389         /* It's definetly a simulcasted scheduled stream */
 390         /* We don't care if it's live or not */
 391         char *temp;
 392
 393         if( p_sys->psz_uri == NULL )
 394         {
 395             msg_Err( p_demux, "no URI was found" );
 396             return -1;
 397         }
 398
 399         asprintf( &temp, "%s%%3FMeDiAbAsEshowingId=%d%%26MeDiAbAsEconcert%%3FMeDiAbAsE",
 400                 p_sys->psz_uri, p_sys->i_sid );
 401
 402         free( p_sys->psz_uri );
 403         p_sys->psz_uri = strdup( temp );
 404         free( temp );
 405     }
 406
 407     p_child = playlist_ItemNew( p_playlist, p_sys->psz_uri,
 408                       p_sys->psz_name ? p_sys->psz_name : p_sys->psz_uri );
 409
 410     if( !p_child || !p_child->input.psz_uri )
 411     {
 412         msg_Err( p_demux, "A valid playlistitem could not be created" );
 413         return VLC_EGENERIC;
 414     }
 415
 416     if( p_sys->i_packet_size && p_sys->psz_mcast_ip )
 417     {
 418         char *psz_option;
 419         p_sys->i_packet_size += 1000;
 420         asprintf( &psz_option, "mtu=%i", p_sys->i_packet_size );
 421         playlist_ItemAddOption( p_child, psz_option );
 422         free( psz_option );
 423     }
 424     if( !p_sys->psz_mcast_ip )
 425     {
 426         char *psz_option;
 427         asprintf( &psz_option, "rtsp-caching=5000" );
 428         playlist_ItemAddOption( p_child, psz_option );
 429         free( psz_option );
 430     }
 431     if( !p_sys->psz_mcast_ip && p_sys->b_rtsp_kasenna )
 432     {
 433         char *psz_option;
 434         asprintf( &psz_option, "rtsp-kasenna" );
 435         playlist_ItemAddOption( p_child, psz_option );
 436         free( psz_option );
 437     }
 438
 439     playlist_ItemSetDuration( p_child, p_sys->i_duration );
 440     playlist_NodeAddItem( p_playlist, p_child, p_item->pp_parents[0]->i_view, p_item, PLAYLIST_APPEND, PLAYLIST_END );
 441     playlist_CopyParents( p_item, p_child );
 442     playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
 443                            p_playlist->status.i_view,
 444                            p_playlist->status.p_item, NULL );
 445
 446     vlc_object_release( p_playlist );
 447     return VLC_SUCCESS;
 448 }
 449
 450 static int Control( demux_t *p_demux, int i_query, va_list args )
 451 {
 452     return VLC_EGENERIC;
 453 }
 454