git.sesse.net Git - vlc/blob - modules/access/udp.c

   1 /*****************************************************************************
   2  * udp.c: raw UDP & RTP access plug-in
   3  *****************************************************************************
   4  * Copyright (C) 2001, 2002 VideoLAN
   5  * $Id: udp.c,v 1.27 2004/01/21 10:22:31 fenrir Exp $
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Tristan Leteurtre <tooney@via.ecp.fr>
   9  *          Laurent Aimar <fenrir@via.ecp.fr>
  10  *
  11  * Reviewed: 23 October 2003, Jean-Paul Saman <jpsaman@wxs.nl>
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  26  *****************************************************************************/
  27
  28 /*****************************************************************************
  29  * Preamble
  30  *****************************************************************************/
  31 #include <stdlib.h>
  32
  33 #include <vlc/vlc.h>
  34 #include <vlc/input.h>
  35
  36 #include "network.h"
  37
  38 /*****************************************************************************
  39  * Module descriptor
  40  *****************************************************************************/
  41 #define CACHING_TEXT N_("caching value in ms")
  42 #define CACHING_LONGTEXT N_( \
  43     "Allows you to modify the default caching value for udp streams. This " \
  44     "value should be set in miliseconds units." )
  45
  46 static int  Open ( vlc_object_t * );
  47 static void Close( vlc_object_t * );
  48
  49 vlc_module_begin();
  50     set_description( _("UDP/RTP input") );
  51     add_category_hint( N_("UDP"), NULL , VLC_TRUE );
  52     add_integer( "udp-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
  53     set_capability( "access", 0 );
  54     add_shortcut( "udp" );
  55     add_shortcut( "udpstream" );
  56     add_shortcut( "udp4" );
  57     add_shortcut( "udp6" );
  58     add_shortcut( "rtp" );
  59     add_shortcut( "rtp4" );
  60     add_shortcut( "rtp6" );
  61     set_callbacks( Open, Close );
  62 vlc_module_end();
  63
  64 /*****************************************************************************
  65  * Local prototypes
  66  *****************************************************************************/
  67 #define RTP_HEADER_LEN 12
  68
  69 static ssize_t Read    ( input_thread_t *, byte_t *, size_t );
  70 static ssize_t RTPRead ( input_thread_t *, byte_t *, size_t );
  71 static ssize_t RTPChoose( input_thread_t *, byte_t *, size_t );
  72
  73 struct access_sys_t
  74 {
  75     int fd;
  76 };
  77
  78 /*****************************************************************************
  79  * Open: open the socket
  80  *****************************************************************************/
  81 static int Open( vlc_object_t *p_this )
  82 {
  83     input_thread_t     *p_input = (input_thread_t *)p_this;
  84     access_sys_t       *p_sys;
  85
  86     char *              psz_name = strdup(p_input->psz_name);
  87     char *              psz_parser = psz_name;
  88     char *              psz_server_addr = "";
  89     char *              psz_server_port = "";
  90     char *              psz_bind_addr = "";
  91     char *              psz_bind_port = "";
  92     int                 i_bind_port = 0, i_server_port = 0;
  93     vlc_value_t         val;
  94
  95
  96     /* First set ipv4/ipv6 */
  97     var_Create( p_input, "ipv4", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
  98     var_Create( p_input, "ipv6", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
  99
 100     if( *p_input->psz_access )
 101     {
 102         /* Find out which shortcut was used */
 103         if( !strncmp( p_input->psz_access, "udp4", 6 ) || !strncmp( p_input->psz_access, "rtp4", 6 ))
 104         {
 105             val.b_bool = VLC_TRUE;
 106             var_Set( p_input, "ipv4", val );
 107
 108             val.b_bool = VLC_FALSE;
 109             var_Set( p_input, "ipv6", val );
 110         }
 111         else if( !strncmp( p_input->psz_access, "udp6", 6 ) || !strncmp( p_input->psz_access, "rtp6", 6 ) )
 112         {
 113             val.b_bool = VLC_TRUE;
 114             var_Set( p_input, "ipv6", val );
 115
 116             val.b_bool = VLC_FALSE;
 117             var_Set( p_input, "ipv4", val );
 118         }
 119     }
 120
 121     /* Parse psz_name syntax :
 122      * [serveraddr[:serverport]][@[bindaddr]:[bindport]] */
 123     if( *psz_parser && *psz_parser != '@' )
 124     {
 125         /* Found server */
 126         psz_server_addr = psz_parser;
 127
 128         while( *psz_parser && *psz_parser != ':' && *psz_parser != '@' )
 129         {
 130             if( *psz_parser == '[' )
 131             {
 132                 /* IPv6 address */
 133                 while( *psz_parser && *psz_parser != ']' )
 134                 {
 135                     psz_parser++;
 136                 }
 137             }
 138             psz_parser++;
 139         }
 140
 141         if( *psz_parser == ':' )
 142         {
 143             /* Found server port */
 144             *psz_parser++ = '\0'; /* Terminate server name */
 145             psz_server_port = psz_parser;
 146
 147             while( *psz_parser && *psz_parser != '@' )
 148             {
 149                 psz_parser++;
 150             }
 151         }
 152     }
 153
 154     if( *psz_parser == '@' )
 155     {
 156         /* Found bind address or bind port */
 157         *psz_parser++ = '\0'; /* Terminate server port or name if necessary */
 158
 159         if( *psz_parser && *psz_parser != ':' )
 160         {
 161             /* Found bind address */
 162             psz_bind_addr = psz_parser;
 163
 164             while( *psz_parser && *psz_parser != ':' )
 165             {
 166                 if( *psz_parser == '[' )
 167                 {
 168                     /* IPv6 address */
 169                     while( *psz_parser && *psz_parser != ']' )
 170                     {
 171                         psz_parser++;
 172                     }
 173                 }
 174                 psz_parser++;
 175             }
 176         }
 177
 178         if( *psz_parser == ':' )
 179         {
 180             /* Found bind port */
 181             *psz_parser++ = '\0'; /* Terminate bind address if necessary */
 182             psz_bind_port = psz_parser;
 183         }
 184     }
 185
 186     i_server_port = strtol( psz_server_port, NULL, 10 );
 187     if( ( i_bind_port   = strtol( psz_bind_port,   NULL, 10 ) ) == 0 )
 188     {
 189         i_bind_port = config_GetInt( p_this, "server-port" );
 190     }
 191
 192     if( *psz_server_addr || i_server_port )
 193     {
 194         msg_Err( p_input, "this UDP syntax is deprecated; the server argument will be");
 195         msg_Err( p_input, "ignored (%s:%d). If you wanted to enter a multicast address",
 196                           psz_server_addr, i_server_port);
 197         msg_Err( p_input, "or local port, type : %s:@%s:%d",
 198                           *p_input->psz_access ? p_input->psz_access : "udp",
 199                           psz_server_addr, i_server_port );
 200
 201         i_server_port = 0;
 202         psz_server_addr = "";
 203     }
 204
 205     msg_Dbg( p_input, "opening server=%s:%d local=%s:%d",
 206              psz_server_addr, i_server_port, psz_bind_addr, i_bind_port );
 207
 208     p_sys = p_input->p_access_data = malloc( sizeof( access_sys_t ) );
 209     if( p_sys == NULL )
 210     {
 211         msg_Err( p_input, "out of memory" );
 212         return VLC_EGENERIC;
 213     }
 214
 215     p_sys->fd = net_OpenUDP( p_input, psz_bind_addr, i_bind_port,
 216                                       psz_server_addr, i_server_port );
 217     if( p_sys->fd < 0 )
 218     {
 219         msg_Err( p_input, "cannot open socket" );
 220         free( psz_name );
 221         free( p_sys );
 222         return VLC_EGENERIC;
 223     }
 224     free( psz_name );
 225
 226     /* FIXME */
 227     p_input->i_mtu = config_GetInt( p_this, "mtu" );
 228
 229     /* fill p_input fields */
 230     p_input->pf_read = RTPChoose;
 231     p_input->pf_set_program = input_SetProgram;
 232     p_input->pf_set_area = NULL;
 233     p_input->pf_seek = NULL;
 234
 235     vlc_mutex_lock( &p_input->stream.stream_lock );
 236     p_input->stream.b_pace_control = VLC_FALSE;
 237     p_input->stream.b_seekable = VLC_FALSE;
 238     p_input->stream.p_selected_area->i_tell = 0;
 239     p_input->stream.i_method = INPUT_METHOD_NETWORK;
 240     vlc_mutex_unlock( &p_input->stream.stream_lock );
 241
 242     /* Update default_pts to a suitable value for udp access */
 243     var_Create( p_input, "udp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 244     var_Get( p_input, "udp-caching", &val );
 245     p_input->i_pts_delay = val.i_int * 1000;
 246
 247     return VLC_SUCCESS;
 248 }
 249
 250 /*****************************************************************************
 251  * Close: free unused data structures
 252  *****************************************************************************/
 253 static void Close( vlc_object_t *p_this )
 254 {
 255     input_thread_t *p_input = (input_thread_t *)p_this;
 256     access_sys_t   *p_sys = p_input->p_access_data;
 257
 258     msg_Info( p_input, "closing UDP target `%s'", p_input->psz_source );
 259
 260     net_Close( p_sys->fd );
 261
 262     free( p_sys );
 263 }
 264
 265 /*****************************************************************************
 266  * Read: read on a file descriptor, checking b_die periodically
 267  *****************************************************************************/
 268 static ssize_t Read( input_thread_t * p_input, byte_t * p_buffer, size_t i_len )
 269 {
 270     access_sys_t   *p_sys = p_input->p_access_data;
 271
 272     return net_Read( p_input, p_sys->fd, p_buffer, i_len, VLC_FALSE );
 273 }
 274
 275 /*****************************************************************************
 276  * RTPRead : read from the network, and parse the RTP header
 277  *****************************************************************************/
 278 static ssize_t RTPRead( input_thread_t * p_input, byte_t * p_buffer,
 279                         size_t i_len )
 280 {
 281     int         i_rtp_version;
 282     int         i_CSRC_count;
 283     int         i_payload_type;
 284     int         i_skip = 0;
 285
 286     byte_t *    p_tmp_buffer = alloca( p_input->i_mtu );
 287
 288     /* Get the raw data from the socket.
 289      * We first assume that RTP header size is the classic RTP_HEADER_LEN. */
 290     ssize_t i_ret = Read( p_input, p_tmp_buffer, p_input->i_mtu );
 291
 292     if ( i_ret <= 0 ) return 0; /* i_ret is at least 1 */
 293
 294     /* Parse the header and make some verifications.
 295      * See RFC 1889 & RFC 2250. */
 296
 297     i_rtp_version  = ( p_tmp_buffer[0] & 0xC0 ) >> 6;
 298     i_CSRC_count   = ( p_tmp_buffer[0] & 0x0F );
 299     i_payload_type = ( p_tmp_buffer[1] & 0x7F );
 300
 301     if ( i_rtp_version != 2 )
 302         msg_Dbg( p_input, "RTP version is %u, should be 2", i_rtp_version );
 303
 304     if( i_payload_type == 14 )
 305     {
 306         i_skip = 4;
 307     }
 308     else if( i_payload_type !=  33 && i_payload_type != 32 )
 309     {
 310         msg_Dbg( p_input, "unsupported RTP payload type (%u)", i_payload_type );
 311     }
 312     i_skip += RTP_HEADER_LEN + 4*i_CSRC_count;
 313
 314     /* A CSRC extension field is 32 bits in size (4 bytes) */
 315     if ( i_ret < i_skip )
 316     {
 317         /* Packet is not big enough to hold the complete RTP_HEADER with
 318          * CSRC extensions.
 319          */
 320         msg_Warn( p_input, "RTP input trashing %d bytes", i_ret - i_len );
 321         return 0;
 322     }
 323
 324     /* Return the packet without the RTP header. */
 325     i_ret -= i_skip;
 326
 327     if ( (size_t)i_ret > i_len )
 328     {
 329         /* This should NOT happen. */
 330         msg_Warn( p_input, "RTP input trashing %d bytes", i_ret - i_len );
 331         i_ret = i_len;
 332     }
 333
 334     p_input->p_vlc->pf_memcpy( p_buffer, &p_tmp_buffer[i_skip], i_ret );
 335
 336     return i_ret;
 337 }
 338
 339 /*****************************************************************************
 340  * RTPChoose : read from the network, and decide whether it's UDP or RTP
 341  *****************************************************************************/
 342 static ssize_t RTPChoose( input_thread_t * p_input, byte_t * p_buffer,
 343                           size_t i_len )
 344 {
 345     int         i_rtp_version;
 346     int         i_CSRC_count;
 347     int         i_payload_type;
 348
 349     byte_t *    p_tmp_buffer = alloca( p_input->i_mtu );
 350
 351     /* Get the raw data from the socket.
 352      * We first assume that RTP header size is the classic RTP_HEADER_LEN. */
 353     ssize_t i_ret = Read( p_input, p_tmp_buffer, p_input->i_mtu );
 354
 355     if ( i_ret <= 0 ) return 0; /* i_ret is at least 1 */
 356
 357     /* Check that it's not TS. */
 358     if ( p_tmp_buffer[0] == 0x47 )
 359     {
 360         msg_Dbg( p_input, "detected TS over raw UDP" );
 361         p_input->pf_read = Read;
 362         p_input->p_vlc->pf_memcpy( p_buffer, p_tmp_buffer, i_ret );
 363         return i_ret;
 364     }
 365
 366     /* Parse the header and make some verifications.
 367      * See RFC 1889 & RFC 2250. */
 368
 369     i_rtp_version  = ( p_tmp_buffer[0] & 0xC0 ) >> 6;
 370     i_CSRC_count   = ( p_tmp_buffer[0] & 0x0F );
 371     i_payload_type = ( p_tmp_buffer[1] & 0x7F );
 372
 373     if ( i_rtp_version != 2 )
 374     {
 375         msg_Dbg( p_input, "no supported RTP header detected" );
 376         p_input->pf_read = Read;
 377         p_input->p_vlc->pf_memcpy( p_buffer, p_tmp_buffer, i_ret );
 378         return i_ret;
 379     }
 380
 381     switch ( i_payload_type )
 382     {
 383     case 33:
 384         msg_Dbg( p_input, "detected TS over RTP" );
 385         break;
 386
 387     case 14:
 388         msg_Dbg( p_input, "detected MPEG audio over RTP" );
 389         if( !p_input->psz_demux || *p_input->psz_demux == '\0' )
 390         {
 391             p_input->psz_demux = "mp3";
 392         }
 393         break;
 394
 395     case 32:
 396         msg_Dbg( p_input, "detected MPEG video over RTP" );
 397         break;
 398
 399     default:
 400         msg_Dbg( p_input, "no RTP header detected" );
 401         p_input->pf_read = Read;
 402         p_input->p_vlc->pf_memcpy( p_buffer, p_tmp_buffer, i_ret );
 403         return i_ret;
 404     }
 405
 406     p_input->pf_read = RTPRead;
 407
 408     /* A CSRC extension field is 32 bits in size (4 bytes) */
 409     if( i_ret < RTP_HEADER_LEN + 4*i_CSRC_count )
 410     {
 411         /* Packet is not big enough to hold the complete RTP_HEADER with
 412          * CSRC extensions.
 413          */
 414         msg_Warn( p_input, "RTP input trashing %d bytes", i_ret - i_len );
 415         return 0;
 416     }
 417
 418     /* Return the packet without the RTP header. */
 419     i_ret -= RTP_HEADER_LEN + 4*i_CSRC_count;
 420
 421     if ( (size_t)i_ret > i_len )
 422     {
 423         /* This should NOT happen. */
 424         msg_Warn( p_input, "RTP input trashing %d bytes", i_ret - i_len );
 425         i_ret = i_len;
 426     }
 427
 428     p_input->p_vlc->pf_memcpy( p_buffer, &p_tmp_buffer[RTP_HEADER_LEN + 4*i_CSRC_count], i_ret );
 429
 430     return i_ret;
 431 }