]> git.sesse.net Git - vlc/blobdiff - modules/access_output/udp.c
* Massive spelling corrections.
[vlc] / modules / access_output / udp.c
index 64dc063d98c8403e2a1c07b272926e2a187d6b92..883db293168456ab0ecadb35cb6554ef9d437978 100644 (file)
@@ -2,7 +2,7 @@
  * udp.c
  *****************************************************************************
  * Copyright (C) 2001, 2002 VideoLAN
- * $Id: udp.c,v 1.20 2004/02/20 17:13:42 massiot Exp $
+ * $Id$
  *
  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
  *          Eric Petit <titer@videolan.org>
@@ -33,7 +33,6 @@
 #include <fcntl.h>
 
 #include <vlc/vlc.h>
-#include <vlc/input.h>
 #include <vlc/sout.h>
 
 #ifdef HAVE_UNISTD_H
 
 #include "network.h"
 
-#define DEFAULT_PORT 1234
-/*****************************************************************************
- * Exported prototypes
- *****************************************************************************/
-static int     Open   ( vlc_object_t * );
-static void    Close  ( vlc_object_t * );
-
-static int     Write   ( sout_access_out_t *, sout_buffer_t * );
-static int     WriteRaw( sout_access_out_t *, sout_buffer_t * );
-static int     Seek    ( sout_access_out_t *, off_t  );
-
-static void    ThreadWrite( vlc_object_t * );
-
-static sout_buffer_t *NewUDPPacket( sout_access_out_t *, mtime_t );
 
 /*****************************************************************************
  * Module descriptor
  *****************************************************************************/
+static int  Open ( vlc_object_t * );
+static void Close( vlc_object_t * );
+
+#define SOUT_CFG_PREFIX "sout-udp-"
+
 #define CACHING_TEXT N_("Caching value (ms)")
 #define CACHING_LONGTEXT N_( \
-    "Allows you to modify the default caching value for udp streams. This " \
+    "Allows you to modify the default caching value for UDP streams. This " \
     "value should be set in millisecond units." )
 
+#define TTL_TEXT N_("Time To Live")
+#define TTL_LONGTEXT N_("Allows you to define the time to live of the " \
+                        "outgoing stream.")
+
+#define GROUP_TEXT N_("Group packets")
+#define GROUP_LONGTEXT N_("Packets can be sent one by one at the right time " \
+                          "or by groups. This allows you to give the number " \
+                          "of packets that will be sent at a time. It " \
+                          "helps reducing the scheduling load on " \
+                          "heavily-loaded systems." )
+#define LATE_TEXT N_("Late delay (ms)" )
+#define LATE_LONGTEXT N_("Late packets are dropped. This allows you to give " \
+                       "the time (in milliseconds) a packet is allowed to be" \
+                       " late.")
+#define RAW_TEXT N_("Raw write")
+#define RAW_LONGTEXT N_("If you enable this option, packets will be sent " \
+                       "directly, without trying to fill the MTU (ie, " \
+                       "without trying to make the biggest possible packets " \
+                       "in order to improve streaming)." )
+
 vlc_module_begin();
-    set_description( _("UDP stream ouput") );
-    add_integer( "udp-sout-caching", DEFAULT_PTS_DELAY / 1000, NULL,
-                 CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
+    set_description( _("UDP stream output") );
+    add_integer( SOUT_CFG_PREFIX "caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
+    add_integer( SOUT_CFG_PREFIX "ttl", 0, NULL,TTL_TEXT, TTL_LONGTEXT,
+                                 VLC_TRUE );
+    add_integer( SOUT_CFG_PREFIX "group", 1, NULL, GROUP_TEXT, GROUP_LONGTEXT,
+                                 VLC_TRUE );
+    add_integer( SOUT_CFG_PREFIX "late", 0, NULL, LATE_TEXT, LATE_LONGTEXT,
+                                 VLC_TRUE );
+    add_bool( SOUT_CFG_PREFIX "raw",  0, NULL, RAW_TEXT, RAW_LONGTEXT,
+                                 VLC_TRUE );
+
     set_capability( "sout access", 100 );
     add_shortcut( "udp" );
     add_shortcut( "rtp" ); // Will work only with ts muxer
     set_callbacks( Open, Close );
 vlc_module_end();
 
-typedef struct sout_access_thread_s
+/*****************************************************************************
+ * Exported prototypes
+ *****************************************************************************/
+
+static const char *ppsz_sout_options[] = {
+    "caching",
+    "ttl",
+    "group",
+    "late",
+    "raw",
+    NULL
+};
+
+static int  Write   ( sout_access_out_t *, block_t * );
+static int  WriteRaw( sout_access_out_t *, block_t * );
+static int  Seek    ( sout_access_out_t *, off_t  );
+
+static void ThreadWrite( vlc_object_t * );
+
+static block_t *NewUDPPacket( sout_access_out_t *, mtime_t );
+
+
+typedef struct sout_access_thread_t
 {
     VLC_COMMON_MEMBERS
 
     sout_instance_t *p_sout;
 
-    sout_fifo_t *p_fifo;
+    block_fifo_t *p_fifo;
 
     int         i_handle;
 
     int64_t     i_caching;
+    int64_t     i_late;
+    int         i_group;
 
 } sout_access_thread_t;
 
@@ -107,12 +149,14 @@ struct sout_access_out_sys_t
 
     unsigned int        i_mtu;
 
-    sout_buffer_t       *p_buffer;
+    block_t             *p_buffer;
 
     sout_access_thread_t *p_thread;
 
 };
 
+#define DEFAULT_PORT 1234
+
 /*****************************************************************************
  * Open: open the file
  *****************************************************************************/
@@ -129,12 +173,13 @@ static int Open( vlc_object_t *p_this )
     network_socket_t    socket_desc;
 
     vlc_value_t         val;
-    char                *psz_val;
+
+    sout_ParseCfg( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 
     if( !( p_sys = p_access->p_sys =
                 malloc( sizeof( sout_access_out_sys_t ) ) ) )
     {
-        msg_Err( p_access, "Not enough memory" );
+        msg_Err( p_access, "not enough memory" );
         return VLC_EGENERIC;
     }
 
@@ -142,8 +187,8 @@ static int Open( vlc_object_t *p_this )
     if( p_access->psz_access != NULL &&
         !strcmp( p_access->psz_access, "rtp" ) )
     {
-        msg_Warn( p_access, "be carefull that rtp ouput work only with ts "
-                  "payload(not an error)" );
+        msg_Warn( p_access, "be careful that rtp output only works with ts "
+                  "payload (not an error)" );
         p_sys->b_rtpts = 1;
     }
     else
@@ -189,20 +234,19 @@ static int Open( vlc_object_t *p_this )
     p_sys->p_thread->p_sout = p_access->p_sout;
     p_sys->p_thread->b_die  = 0;
     p_sys->p_thread->b_error= 0;
-    p_sys->p_thread->p_fifo = sout_FifoCreate( p_access->p_sout );
+    p_sys->p_thread->p_fifo = block_FifoNew( p_access );
 
     socket_desc.i_type = NETWORK_UDP;
     socket_desc.psz_server_addr = psz_dst_addr;
     socket_desc.i_server_port   = i_dst_port;
     socket_desc.psz_bind_addr   = "";
     socket_desc.i_bind_port     = 0;
-    socket_desc.i_ttl           = 0;
-    if( ( psz_val = sout_cfg_find_value( p_access->p_cfg, "ttl" ) ) )
-    {
-        socket_desc.i_ttl = atoi( psz_val );
-    }
+
+    var_Get( p_access, SOUT_CFG_PREFIX "ttl", &val );
+    socket_desc.i_ttl = val.i_int;
+
     p_sys->p_thread->p_private = (void*)&socket_desc;
-    if( !( p_network = module_Need( p_sys->p_thread, "network", "" ) ) )
+    if( !( p_network = module_Need( p_sys->p_thread, "network", NULL, 0 ) ) )
     {
         msg_Err( p_access, "failed to open a connection (udp)" );
         return VLC_EGENERIC;
@@ -211,19 +255,24 @@ static int Open( vlc_object_t *p_this )
 
     p_sys->p_thread->i_handle = socket_desc.i_handle;
 
-    var_Create( p_this, "udp-sout-caching",
-                VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    var_Get( p_this, "udp-sout-caching", &val );
-    p_sys->p_thread->i_caching = val.i_int * 1000;
-    if( ( psz_val = sout_cfg_find_value( p_access->p_cfg, "caching" ) ) )
-    {
-        p_sys->p_thread->i_caching = atoll( psz_val ) * 1000;
-    }
+    var_Get( p_access, SOUT_CFG_PREFIX "caching", &val );
+    p_sys->p_thread->i_caching = (int64_t)val.i_int * 1000;
+
+    var_Get( p_access, SOUT_CFG_PREFIX "group", &val );
+    p_sys->p_thread->i_group = val.i_int;
+
+    var_Get( p_access, SOUT_CFG_PREFIX "late", &val );
+    p_sys->p_thread->i_late = (int64_t)val.i_int * 1000;
 
     p_sys->i_mtu = socket_desc.i_mtu;
 
+#ifdef WIN32
+    if( vlc_thread_create( p_sys->p_thread, "sout write thread", ThreadWrite,
+                           VLC_THREAD_PRIORITY_HIGHEST, VLC_FALSE ) )
+#else
     if( vlc_thread_create( p_sys->p_thread, "sout write thread", ThreadWrite,
                            VLC_THREAD_PRIORITY_OUTPUT, VLC_FALSE ) )
+#endif
     {
         msg_Err( p_access->p_sout, "cannot spawn sout access thread" );
         vlc_object_destroy( p_sys->p_thread );
@@ -235,7 +284,8 @@ static int Open( vlc_object_t *p_this )
     p_sys->i_sequence_number = rand()&0xffff;
     p_sys->i_ssrc            = rand()&0xffffffff;
 
-    if( sout_cfg_find( p_access->p_cfg, "raw" ) )
+    var_Get( p_access, SOUT_CFG_PREFIX "raw", &val );
+    if( val.b_bool )
     {
         p_access->pf_write = WriteRaw;
     }
@@ -246,9 +296,13 @@ static int Open( vlc_object_t *p_this )
 
     p_access->pf_seek = Seek;
 
-    msg_Info( p_access, "Open: addr:`%s' port:`%d'", psz_dst_addr, i_dst_port);
+    msg_Dbg( p_access, "udp access output opened(%s:%d)", psz_dst_addr, i_dst_port );
 
     free( psz_dst_addr );
+
+    /* update p_sout->i_out_pace_nocontrol */
+    p_access->p_sout->i_out_pace_nocontrol++;
+
     return VLC_SUCCESS;
 }
 
@@ -264,61 +318,56 @@ static void Close( vlc_object_t * p_this )
     p_sys->p_thread->b_die = 1;
     for( i = 0; i < 10; i++ )
     {
-        sout_buffer_t *p_dummy;
-
-        p_dummy = sout_BufferNew( p_access->p_sout, p_sys->i_mtu );
+        block_t *p_dummy = block_New( p_access, p_sys->i_mtu );
         p_dummy->i_dts = 0;
         p_dummy->i_pts = 0;
         p_dummy->i_length = 0;
-        sout_FifoPut( p_sys->p_thread->p_fifo, p_dummy );
+        block_FifoPut( p_sys->p_thread->p_fifo, p_dummy );
     }
     vlc_thread_join( p_sys->p_thread );
 
-    sout_FifoDestroy( p_access->p_sout, p_sys->p_thread->p_fifo );
+    block_FifoRelease( p_sys->p_thread->p_fifo );
 
     if( p_sys->p_buffer )
     {
-        sout_BufferDelete( p_access->p_sout, p_sys->p_buffer );
+        block_Release( p_sys->p_buffer );
     }
 
-#if defined( UNDER_CE )
-    CloseHandle( (HANDLE)p_sys->p_thread->i_handle );
-#elif defined( WIN32 )
-    closesocket( p_sys->p_thread->i_handle );
-#else
-    close( p_sys->p_thread->i_handle );
-#endif
+    net_Close( p_sys->p_thread->i_handle );
 
+    /* update p_sout->i_out_pace_nocontrol */
+    p_access->p_sout->i_out_pace_nocontrol--;
+
+    msg_Dbg( p_access, "udp access output closed" );
     free( p_sys );
-    msg_Info( p_access, "Close" );
 }
 
 /*****************************************************************************
  * Write: standard write on a file descriptor.
  *****************************************************************************/
-static int Write( sout_access_out_t *p_access, sout_buffer_t *p_buffer )
+static int Write( sout_access_out_t *p_access, block_t *p_buffer )
 {
     sout_access_out_sys_t *p_sys = p_access->p_sys;
     unsigned int i_write;
 
     while( p_buffer )
     {
-        sout_buffer_t *p_next;
-        if( p_buffer->i_size > p_sys->i_mtu )
+        block_t *p_next;
+        if( p_buffer->i_buffer > p_sys->i_mtu )
         {
             msg_Warn( p_access, "arggggggggggggg packet size > mtu" );
             i_write = p_sys->i_mtu;
         }
         else
         {
-            i_write = p_buffer->i_size;
+            i_write = p_buffer->i_buffer;
         }
 
         /* if we have enough data, enque the buffer */
         if( p_sys->p_buffer &&
-            p_sys->p_buffer->i_size + i_write > p_sys->i_mtu )
+            p_sys->p_buffer->i_buffer + i_write > p_sys->i_mtu )
         {
-            sout_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
+            block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
             p_sys->p_buffer = NULL;
         }
 
@@ -327,14 +376,14 @@ static int Write( sout_access_out_t *p_access, sout_buffer_t *p_buffer )
             p_sys->p_buffer = NewUDPPacket( p_access, p_buffer->i_dts );
         }
 
-        if( p_buffer->i_size > 0 )
+        if( p_buffer->i_buffer > 0 )
         {
-            memcpy( p_sys->p_buffer->p_buffer + p_sys->p_buffer->i_size,
+            memcpy( p_sys->p_buffer->p_buffer + p_sys->p_buffer->i_buffer,
                     p_buffer->p_buffer, i_write );
-            p_sys->p_buffer->i_size += i_write;
+            p_sys->p_buffer->i_buffer += i_write;
         }
         p_next = p_buffer->p_next;
-        sout_BufferDelete( p_access->p_sout, p_buffer );
+        block_Release( p_buffer );
         p_buffer = p_next;
     }
 
@@ -344,11 +393,11 @@ static int Write( sout_access_out_t *p_access, sout_buffer_t *p_buffer )
 /*****************************************************************************
  * WriteRaw: write p_buffer without trying to fill mtu
  *****************************************************************************/
-static int WriteRaw( sout_access_out_t *p_access, sout_buffer_t *p_buffer )
+static int WriteRaw( sout_access_out_t *p_access, block_t *p_buffer )
 {
     sout_access_out_sys_t   *p_sys = p_access->p_sys;
 
-    sout_FifoPut( p_sys->p_thread->p_fifo, p_buffer );
+    block_FifoPut( p_sys->p_thread->p_fifo, p_buffer );
 
     return( p_sys->p_thread->b_error ? -1 : 0 );
 }
@@ -359,20 +408,20 @@ static int WriteRaw( sout_access_out_t *p_access, sout_buffer_t *p_buffer )
 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 {
     msg_Err( p_access, "UDP sout access cannot seek" );
-    return( -1 );
+    return -1;
 }
 
 /*****************************************************************************
  * NewUDPPacket: allocate a new UDP packet of size p_sys->i_mtu
  *****************************************************************************/
-static sout_buffer_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
+static block_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
 {
     sout_access_out_sys_t *p_sys = p_access->p_sys;
-    sout_buffer_t *p_buffer;
+    block_t *p_buffer;
 
-    p_buffer = sout_BufferNew( p_access->p_sout, p_sys->i_mtu );
+    p_buffer = block_New( p_access->p_sout, p_sys->i_mtu );
     p_buffer->i_dts = i_dts;
-    p_buffer->i_size = 0;
+    p_buffer->i_buffer = 0;
 
     if( p_sys->b_rtpts )
     {
@@ -396,7 +445,7 @@ static sout_buffer_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
         p_buffer->p_buffer[10] = ( p_sys->i_ssrc >>  8 )&0xff;
         p_buffer->p_buffer[11] = p_sys->i_ssrc&0xff;
 
-        p_buffer->i_size = 12;
+        p_buffer->i_buffer = 12;
     }
 
     return p_buffer;
@@ -408,57 +457,80 @@ static sout_buffer_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
 static void ThreadWrite( vlc_object_t *p_this )
 {
     sout_access_thread_t *p_thread = (sout_access_thread_t*)p_this;
-    sout_instance_t      *p_sout = p_thread->p_sout;
     mtime_t              i_date_last = -1;
+    mtime_t              i_to_send = p_thread->i_group;
+    int                  i_dropped_packets = 0;
 
-    while( ! p_thread->b_die )
+    while( !p_thread->b_die )
     {
-        sout_buffer_t *p_pk;
+        block_t *p_pk;
         mtime_t       i_date, i_sent;
 
-        p_pk = sout_FifoGet( p_thread->p_fifo );
+        p_pk = block_FifoGet( p_thread->p_fifo );
 
         i_date = p_thread->i_caching + p_pk->i_dts;
         if( i_date_last > 0 )
         {
             if( i_date - i_date_last > 2000000 )
             {
-                msg_Dbg( p_thread, "mmh, hole > 2s -> drop" );
+                if( !i_dropped_packets )
+                    msg_Dbg( p_thread, "mmh, hole > 2s -> drop" );
 
-                sout_BufferDelete( p_sout, p_pk );
+                block_Release( p_pk  );
                 i_date_last = i_date;
+                i_dropped_packets++;
                 continue;
             }
             else if( i_date - i_date_last < 0 )
             {
-                msg_Dbg( p_thread, "mmh, paquets in the past -> drop" );
+                if( !i_dropped_packets )
+                    msg_Dbg( p_thread, "mmh, paquets in the past -> drop" );
 
-                sout_BufferDelete( p_sout, p_pk );
+                block_Release( p_pk  );
                 i_date_last = i_date;
+                i_dropped_packets++;
                 continue;
             }
         }
 
         i_sent = mdate();
-        if ( i_sent > i_date + 100000 )
+        if( p_thread->i_late > 0 && i_sent > i_date + p_thread->i_late )
         {
-            msg_Dbg( p_thread, "late packet to send (" I64Fd ") -> drop",
-                     i_sent - i_date );
-            sout_BufferDelete( p_sout, p_pk );
+            if( !i_dropped_packets )
+            {
+                msg_Dbg( p_thread, "late packet to send (" I64Fd ") -> drop",
+                         i_sent - i_date );
+            }
+            block_Release( p_pk  );
             i_date_last = i_date;
+            i_dropped_packets++;
             continue;
         }
 
-        mwait( i_date );
-        send( p_thread->i_handle, p_pk->p_buffer, p_pk->i_size, 0 );
+        i_to_send--;
+        if ( !i_to_send )
+        {
+            mwait( i_date );
+            i_to_send = p_thread->i_group;
+        }
+        send( p_thread->i_handle, p_pk->p_buffer, p_pk->i_buffer, 0 );
+
+        if( i_dropped_packets )
+        {
+            msg_Dbg( p_thread, "dropped %i packets", i_dropped_packets );
+            i_dropped_packets = 0;
+        }
 
+#if 0
         i_sent = mdate();
         if ( i_sent > i_date + 20000 )
         {
             msg_Dbg( p_thread, "packet has been sent too late (" I64Fd ")",
                      i_sent - i_date );
         }
-        sout_BufferDelete( p_sout, p_pk );
+#endif
+
+        block_Release( p_pk  );
         i_date_last = i_date;
     }
 }