demux/playlist/ : removes useless unused parameter warnings
[vlc.git] / 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 #ifdef HAVE_CONFIG_H
102 # include "config.h"
103 #endif
104
105 #include <vlc/vlc.h>
106 #include <vlc_demux.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     vlc_bool_t  b_concert;      /* DeliveryService=cds */
129     vlc_bool_t  b_rtsp_kasenna; /* kasenna style RTSP */
130 };
131
132 static int Demux ( demux_t *p_demux );
133 static int Control( demux_t *p_demux, int i_query, va_list args );
134
135 /*****************************************************************************
136  * Activate: initializes m3u demux structures
137  *****************************************************************************/
138 int E_(Import_SGIMB)( vlc_object_t * p_this )
139 {
140     demux_t *p_demux = (demux_t *)p_this;
141     const byte_t *p_peek;
142     int i_size;
143
144     /* Lets check the content to see if this is a sgi mediabase file */
145     i_size = 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             STANDARD_DEMUX_INIT_MSG( "using SGIMB playlist reader" );
158             p_demux->p_sys->psz_uri = NULL;
159             p_demux->p_sys->psz_server = NULL;
160             p_demux->p_sys->psz_location = NULL;
161             p_demux->p_sys->psz_name = NULL;
162             p_demux->p_sys->psz_user = NULL;
163             p_demux->p_sys->psz_password = NULL;
164             p_demux->p_sys->psz_mcast_ip = NULL;
165             p_demux->p_sys->i_mcast_port = 0;
166             p_demux->p_sys->i_packet_size = 0;
167             p_demux->p_sys->i_duration = 0;
168             p_demux->p_sys->i_port = 0;
169             p_demux->p_sys->i_sid = 0;
170             p_demux->p_sys->b_rtsp_kasenna = VLC_FALSE;
171             p_demux->p_sys->b_concert = VLC_FALSE;
172  
173             return VLC_SUCCESS;
174         }
175     }
176     return VLC_EGENERIC;
177 }
178
179 /*****************************************************************************
180  * Deactivate: frees unused data
181  *****************************************************************************/
182 void E_(Close_SGIMB)( vlc_object_t *p_this )
183 {
184     demux_t *p_demux = (demux_t*)p_this;
185     demux_sys_t *p_sys = p_demux->p_sys;
186     if( p_sys->psz_uri )
187         free( p_sys->psz_uri );
188     if( p_sys->psz_server )
189         free( p_sys->psz_server );
190     if( p_sys->psz_location )
191         free( p_sys->psz_location );
192     if( p_sys->psz_name )
193         free( p_sys->psz_name );
194     if( p_sys->psz_user )
195         free( p_sys->psz_user );
196     if( p_sys->psz_password )
197         free( p_sys->psz_password );
198     if( p_sys->psz_mcast_ip )
199         free( p_sys->psz_mcast_ip );
200     free( p_demux->p_sys );
201     return;
202 }
203
204 static int ParseLine ( demux_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         p_sys->psz_uri = strdup( psz_bol );
222     }
223     else if( !strncasecmp( psz_bol, "Stream=\"", sizeof("Stream=\"") - 1 ) )
224     {
225         psz_bol += sizeof("Stream=\"") - 1;
226         if ( !psz_bol )
227             return 0;
228         strrchr( psz_bol, '"' )[0] = '\0';
229         /* We cheat around xdma. for some reason xdma links work different then rtsp */
230         if( !strncasecmp( psz_bol, "xdma://", sizeof("xdma://") - 1 ) )
231         {
232             psz_bol[0] = 'r';
233             psz_bol[1] = 't';
234             psz_bol[2] = 's';
235             psz_bol[3] = 'p';
236         }
237         p_sys->psz_uri = strdup( psz_bol );
238     }
239     else if( !strncasecmp( psz_bol, "sgiNameServerHost=", sizeof("sgiNameServerHost=") - 1 ) )
240     {
241         psz_bol += sizeof("sgiNameServerHost=") - 1;
242         p_sys->psz_server = strdup( psz_bol );
243     }
244     else if( !strncasecmp( psz_bol, "sgiMovieName=", sizeof("sgiMovieName=") - 1 ) )
245     {
246         psz_bol += sizeof("sgiMovieName=") - 1;
247         p_sys->psz_location = strdup( psz_bol );
248     }
249     else if( !strncasecmp( psz_bol, "sgiUserAccount=", sizeof("sgiUserAccount=") - 1 ) )
250     {
251         psz_bol += sizeof("sgiUserAccount=") - 1;
252         p_sys->psz_user = strdup( psz_bol );
253     }
254     else if( !strncasecmp( psz_bol, "sgiUserPassword=", sizeof("sgiUserPassword=") - 1 ) )
255     {
256         psz_bol += sizeof("sgiUserPassword=") - 1;
257         p_sys->psz_password = strdup( psz_bol );
258     }
259     else if( !strncasecmp( psz_bol, "sgiShowingName=", sizeof("sgiShowingName=") - 1 ) )
260     {
261         psz_bol += sizeof("sgiShowingName=") - 1;
262         p_sys->psz_name = strdup( psz_bol );
263     }
264     else if( !strncasecmp( psz_bol, "sgiFormatName=", sizeof("sgiFormatName=") - 1 ) )
265     {
266         psz_bol += sizeof("sgiFormatName=") - 1;
267         if( strcasestr( psz_bol, "MPEG-4") == NULL ) /*not mpeg4 found in string */
268             p_sys->b_rtsp_kasenna = VLC_TRUE;
269     }
270     else if( !strncasecmp( psz_bol, "sgiMulticastAddress=", sizeof("sgiMulticastAddress=") - 1 ) )
271     {
272         psz_bol += sizeof("sgiMulticastAddress=") - 1;
273         p_sys->psz_mcast_ip = strdup( psz_bol );
274     }
275     else if( !strncasecmp( psz_bol, "sgiMulticastPort=", sizeof("sgiMulticastPort=") - 1 ) )
276     {
277         psz_bol += sizeof("sgiMulticastPort=") - 1;
278         p_sys->i_mcast_port = (int) strtol( psz_bol, NULL, 0 );
279     }
280     else if( !strncasecmp( psz_bol, "sgiPacketSize=", sizeof("sgiPacketSize=") - 1 ) )
281     {
282         psz_bol += sizeof("sgiPacketSize=") - 1;
283         p_sys->i_packet_size = (int) strtol( psz_bol, NULL, 0 );
284     }
285     else if( !strncasecmp( psz_bol, "sgiDuration=", sizeof("sgiDuration=") - 1 ) )
286     {
287         psz_bol += sizeof("sgiDuration=") - 1;
288         p_sys->i_duration = (mtime_t) strtol( psz_bol, NULL, 0 );
289     }
290     else if( !strncasecmp( psz_bol, "sgiRtspPort=", sizeof("sgiRtspPort=") - 1 ) )
291     {
292         psz_bol += sizeof("sgiRtspPort=") - 1;
293         p_sys->i_port = (int) strtol( psz_bol, NULL, 0 );
294     }
295     else if( !strncasecmp( psz_bol, "sgiSid=", sizeof("sgiSid=") - 1 ) )
296     {
297         psz_bol += sizeof("sgiSid=") - 1;
298         p_sys->i_sid = (int) strtol( psz_bol, NULL, 0 );
299     }
300     else if( !strncasecmp( psz_bol, "DeliveryService=cds", sizeof("DeliveryService=cds") - 1 ) )
301     {
302         p_sys->b_concert = VLC_TRUE;
303     }
304     else
305     {
306         /* This line isn't really important */
307         return 0;
308     }
309     return VLC_SUCCESS;
310 }
311
312 /*****************************************************************************
313  * Demux: reads and demuxes data packets
314  *****************************************************************************
315  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
316  *****************************************************************************/
317 static int Demux ( demux_t *p_demux )
318 {
319     demux_sys_t     *p_sys = p_demux->p_sys;
320     input_item_t    *p_child = NULL;
321     char            *psz_line;
322
323     INIT_PLAYLIST_STUFF;
324
325     while( ( psz_line = stream_ReadLine( p_demux->s ) ) )
326     {
327         ParseLine( p_demux, psz_line );
328         if( psz_line ) free( psz_line );
329     }
330
331     if( p_sys->psz_mcast_ip )
332     {
333         /* Definetly schedules multicast session */
334         /* We don't care if it's live or not */
335         char *temp;
336
337         asprintf( &temp, "udp://@" "%s:%i", p_sys->psz_mcast_ip, p_sys->i_mcast_port );
338         if( p_sys->psz_uri ) free( p_sys->psz_uri );
339         p_sys->psz_uri = strdup( temp );
340         free( temp );
341     }
342
343     if( p_sys->psz_uri == NULL )
344     {
345         if( p_sys->psz_server && p_sys->psz_location )
346         {
347             char *temp;
348
349             asprintf( &temp, "rtsp://" "%s:%i%s",
350                      p_sys->psz_server, p_sys->i_port > 0 ? p_sys->i_port : 554, p_sys->psz_location );
351
352             p_sys->psz_uri = strdup( temp );
353             free( temp );
354         }
355     }
356
357     if( p_sys->b_concert )
358     {
359         /* It's definetly a simulcasted scheduled stream */
360         /* We don't care if it's live or not */
361         char *temp;
362
363         if( p_sys->psz_uri == NULL )
364         {
365             msg_Err( p_demux, "no URI was found" );
366             return -1;
367         }
368
369         asprintf( &temp, "%s%%3FMeDiAbAsEshowingId=%d%%26MeDiAbAsEconcert%%3FMeDiAbAsE",
370                 p_sys->psz_uri, p_sys->i_sid );
371
372         free( p_sys->psz_uri );
373         p_sys->psz_uri = strdup( temp );
374         free( temp );
375     }
376
377     p_child = input_ItemNewWithType( (vlc_object_t *)p_playlist, p_sys->psz_uri,
378                       p_sys->psz_name ? p_sys->psz_name : p_sys->psz_uri,
379                       0, NULL, p_sys->i_duration, ITEM_TYPE_NET );
380  
381     if( !p_child )
382     {
383         msg_Err( p_demux, "A valid playlistitem could not be created" );
384         return -1;
385     }
386
387     input_ItemCopyOptions( p_current_input, p_child );
388     if( p_sys->i_packet_size && p_sys->psz_mcast_ip )
389     {
390         char *psz_option;
391         p_sys->i_packet_size += 1000;
392         asprintf( &psz_option, "mtu=%i", p_sys->i_packet_size );
393         input_ItemAddOption( p_child, psz_option );
394         free( psz_option );
395     }
396     if( !p_sys->psz_mcast_ip )
397     {
398         char *psz_option;
399         asprintf( &psz_option, "rtsp-caching=5000" );
400         input_ItemAddOption( p_child, psz_option );
401         free( psz_option );
402     }
403     if( !p_sys->psz_mcast_ip && p_sys->b_rtsp_kasenna )
404     {
405         char *psz_option;
406         asprintf( &psz_option, "rtsp-kasenna" );
407         input_ItemAddOption( p_child, psz_option );
408         free( psz_option );
409     }
410
411     input_ItemAddSubItem( p_current_input, p_child );
412     vlc_gc_decref( p_child );
413     HANDLE_PLAY_AND_RELEASE
414     return 0; /* Needed for correct operation of go back */
415 }
416
417 static int Control( demux_t *p_demux, int i_query, va_list args )
418 {
419     VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
420     return VLC_EGENERIC;
421 }
422