]> git.sesse.net Git - vlc/blobdiff - modules/access_output/http.c
Fix Metacube header handling with multiple header blocks.
[vlc] / modules / access_output / http.c
index 137d786e53f9cdb1dbc0aad2508b1a94fd9d63d7..61808406697bdeef6dd28431d2d9777c6822e408 100644 (file)
@@ -1,25 +1,25 @@
 /*****************************************************************************
  * http.c
  *****************************************************************************
- * Copyright (C) 2001-2009 the VideoLAN team
+ * Copyright (C) 2001-2009 VLC authors and VideoLAN
  * $Id$
  *
  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
- *          Jon Lech Johansen <jon@nanocrew.net>
+ *          Remi Denis-Courmont
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /*****************************************************************************
@@ -30,6 +30,8 @@
 # include "config.h"
 #endif
 
+#include <stdint.h>
+
 #include <vlc_common.h>
 #include <vlc_plugin.h>
 #include <vlc_sout.h>
 
 
 #include <vlc_input.h>
-#include <vlc_playlist.h>
-
-#if 0 //def HAVE_AVAHI_CLIENT
-    #include "bonjour.h"
-
-    #if defined( WIN32 )
-        #define DIRECTORY_SEPARATOR '\\'
-    #else
-        #define DIRECTORY_SEPARATOR '/'
-    #endif
-#endif
-
 #include <vlc_httpd.h>
 
 /*****************************************************************************
@@ -60,7 +50,7 @@ static void Close( vlc_object_t * );
 #define SOUT_CFG_PREFIX "sout-http-"
 
 #define USER_TEXT N_("Username")
-#define USER_LONGTEXT N_("User name that will be " \
+#define USER_LONGTEXT N_("Username that will be " \
                          "requested to access the stream." )
 #define PASS_TEXT N_("Password")
 #define PASS_LONGTEXT N_("Password that will be " \
@@ -68,8 +58,9 @@ static void Close( vlc_object_t * );
 #define MIME_TEXT N_("Mime")
 #define MIME_LONGTEXT N_("MIME returned by the server (autodetected " \
                         "if not specified)." )
-#define BONJOUR_TEXT N_( "Advertise with Bonjour")
-#define BONJOUR_LONGTEXT N_( "Advertise the stream with the Bonjour protocol." )
+#define METACUBE_TEXT N_("Metacube")
+#define METACUBE_LONGTEXT N_("Use the Metacube protocol. Needed for streaming " \
+                             "to the Cubemap reflector.")
 
 
 vlc_module_begin ()
@@ -85,10 +76,8 @@ vlc_module_begin ()
                   PASS_TEXT, PASS_LONGTEXT, true )
     add_string( SOUT_CFG_PREFIX "mime", "",
                 MIME_TEXT, MIME_LONGTEXT, true )
-#if 0 //def HAVE_AVAHI_CLIENT
-    add_bool( SOUT_CFG_PREFIX "bonjour", false,
-              BONJOUR_TEXT, BONJOUR_LONGTEXT, true);
-#endif
+    add_bool( SOUT_CFG_PREFIX "metacube", false,
+              METACUBE_TEXT, METACUBE_LONGTEXT, true )
     set_callbacks( Open, Close )
 vlc_module_end ()
 
@@ -97,7 +86,7 @@ vlc_module_end ()
  * Exported prototypes
  *****************************************************************************/
 static const char *const ppsz_sout_options[] = {
-    "user", "pwd", "mime", NULL
+    "user", "pwd", "mime", "metacube", NULL
 };
 
 static ssize_t Write( sout_access_out_t *, block_t * );
@@ -117,12 +106,69 @@ struct sout_access_out_sys_t
     int                 i_header_size;
     uint8_t             *p_header;
     bool          b_header_complete;
+    bool                b_metacube;
+    bool                b_has_keyframes;
+};
 
-#if 0 //def HAVE_AVAHI_CLIENT
-    void                *p_bonjour;
-#endif
+/* Definitions for the Metacube2 protocol, used to communicate with Cubemap. */
+
+static const uint8_t METACUBE2_SYNC[8] = {'c', 'u', 'b', 'e', '!', 'm', 'a', 'p'};
+#define METACUBE_FLAGS_HEADER 0x1
+#define METACUBE_FLAGS_NOT_SUITABLE_FOR_STREAM_START 0x2
+
+struct metacube2_block_header
+{
+    char sync[8];    /* METACUBE2_SYNC */
+    uint32_t size;   /* Network byte order. Does not include header. */
+    uint16_t flags;  /* Network byte order. METACUBE_FLAGS_*. */
+    uint16_t csum;   /* Network byte order. CRC16 of size and flags. */
 };
 
+/*
+ * Implementation of Metacube2 utility functions. Taken from the Cubemap
+ * distribution and then relicensed by the author to LGPL2.1+ for inclusion
+ * into VLC.
+ */
+
+/*
+ * https://www.ece.cmu.edu/~koopman/pubs/KoopmanCRCWebinar9May2012.pdf
+ * recommends this for messages as short as ours (see table at page 34).
+ */
+#define METACUBE2_CRC_POLYNOMIAL 0x8FDB
+
+/* Semi-random starting value to make sure all-zero won't pass. */
+#define METACUBE2_CRC_START 0x1234
+
+/* This code is based on code generated by pycrc. */
+static uint16_t metacube2_compute_crc(const struct metacube2_block_header *hdr)
+{
+    static const int data_len = sizeof(hdr->size) + sizeof(hdr->flags);
+    const uint8_t *data = (uint8_t *)&hdr->size;
+    uint16_t crc = METACUBE2_CRC_START;
+
+    for (int i = 0; i < data_len; ++i) {
+        uint8_t c = data[i];
+        for (int j = 0; j < 8; j++) {
+            int bit = crc & 0x8000;
+            crc = (crc << 1) | ((c >> (7 - j)) & 0x01);
+            if (bit) {
+                crc ^= METACUBE2_CRC_POLYNOMIAL;
+            }
+        }
+    }
+
+    /* Finalize. */
+    for (int i = 0; i < 16; i++) {
+        int bit = crc & 0x8000;
+        crc = crc << 1;
+        if (bit) {
+            crc ^= METACUBE2_CRC_POLYNOMIAL;
+        }
+    }
+
+    return crc;
+}
+
 /*****************************************************************************
  * Open: open the file
  *****************************************************************************/
@@ -210,9 +256,12 @@ static int Open( vlc_object_t *p_this )
         psz_mime = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "mime" );
     }
 
+    p_sys->b_metacube = var_GetBool( p_access, SOUT_CFG_PREFIX "metacube" );
+    p_sys->b_has_keyframes = false;
+
     p_sys->p_httpd_stream =
         httpd_StreamNew( p_sys->p_httpd_host, path, psz_mime,
-                         psz_user, psz_pwd, NULL );
+                         psz_user, psz_pwd );
     free( psz_user );
     free( psz_pwd );
     free( psz_mime );
@@ -226,37 +275,16 @@ static int Open( vlc_object_t *p_this )
         return VLC_EGENERIC;
     }
 
-#if 0 //def HAVE_AVAHI_CLIENT
-    if( var_InheritBool(p_this, SOUT_CFG_PREFIX "bonjour") )
+    if( p_sys->b_metacube )
     {
-        char                *psz_txt, *psz_name;
-        playlist_t          *p_playlist = pl_Get( p_access );
-
-        char *psz_uri = input_item_GetURI( p_playlist->status.p_item->p_input );
-        char *psz_newuri = psz_uri;
-        psz_name = strrchr( psz_newuri, DIRECTORY_SEPARATOR );
-        if( psz_name != NULL ) psz_name++;
-        else psz_name = psz_newuri;
-
-        if( asprintf( &psz_txt, "path=%s", path ) == -1 )
-            {
-                free( psz_uri );
-                return VLC_ENOMEM;
-            }
-
-        p_sys->p_bonjour = bonjour_start_service( (vlc_object_t *)p_access,
-                                    strcmp( p_access->psz_access, "https" )
-                                       ? "_vlc-http._tcp" : "_vlc-https._tcp",
-                                             psz_name, i_bind_port, psz_txt );
-        free( psz_uri );
-        free( psz_txt );
-
-        if( p_sys->p_bonjour == NULL )
-            msg_Err( p_access, "unable to start requested Bonjour announce" );
+        httpd_header headers[] = {{ "Content-encoding", "metacube" }};
+        int err = httpd_StreamSetHTTPHeaders( p_sys->p_httpd_stream, headers, sizeof( headers ) / sizeof( httpd_header ) );
+        if( err != VLC_SUCCESS )
+        {
+            free( p_sys );
+            return err;
+        }
     }
-    else
-        p_sys->p_bonjour = NULL;
-#endif
 
     p_sys->i_header_allocated = 1024;
     p_sys->i_header_size      = 0;
@@ -278,11 +306,6 @@ static void Close( vlc_object_t * p_this )
     sout_access_out_t       *p_access = (sout_access_out_t*)p_this;
     sout_access_out_sys_t   *p_sys = p_access->p_sys;
 
-#if 0 //def HAVE_AVAHI_CLIENT
-    if( p_sys->p_bonjour != NULL )
-        bonjour_stop_service( p_sys->p_bonjour );
-#endif
-
     httpd_StreamDelete( p_sys->p_httpd_stream );
     httpd_HostDelete( p_sys->p_httpd_host );
 
@@ -348,16 +371,74 @@ static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
         {
             p_sys->b_header_complete = true;
 
-            httpd_StreamHeader( p_sys->p_httpd_stream, p_sys->p_header,
-                                p_sys->i_header_size );
+            if ( p_sys->b_metacube )
+            {
+                struct metacube2_block_header hdr;
+                memcpy( hdr.sync, METACUBE2_SYNC, sizeof( METACUBE2_SYNC ) );
+                hdr.size = hton32( p_sys->i_header_size );
+                hdr.flags = hton16( METACUBE_FLAGS_HEADER );
+                hdr.csum = hton16( metacube2_compute_crc( &hdr ) );
+
+                int i_header_size = p_sys->i_header_size + sizeof( hdr );
+                block_t* p_hdr_block = block_Alloc( i_header_size );
+                p_hdr_block->i_flags = 0;
+                memcpy( p_hdr_block->p_buffer, &hdr, sizeof( hdr ) );
+                memcpy( p_hdr_block->p_buffer + sizeof( hdr ), p_sys->p_header, p_sys->i_header_size );
+
+                /* send the combined header here instead of sending them as regular
+                 * data, so that we get them as a single Metacube header block */
+                httpd_StreamHeader( p_sys->p_httpd_stream, p_hdr_block->p_buffer, p_hdr_block->i_buffer );
+                httpd_StreamSend( p_sys->p_httpd_stream, p_hdr_block );
+
+                block_Release( p_hdr_block );
+            }
+            else
+            {
+                httpd_StreamHeader( p_sys->p_httpd_stream, p_sys->p_header,
+                                    p_sys->i_header_size );
+            }
         }
 
         i_len += p_buffer->i_buffer;
-        /* send data */
-        i_err = httpd_StreamSend( p_sys->p_httpd_stream, p_buffer->p_buffer,
-                                  p_buffer->i_buffer );
+
+        if( p_buffer->i_flags & BLOCK_FLAG_TYPE_I )
+        {
+            p_sys->b_has_keyframes = true;
+        }
 
         p_next = p_buffer->p_next;
+
+        if( p_sys->b_metacube )
+        {
+            /* header data is combined into one packet and sent earlier */
+            if( p_buffer->i_flags & BLOCK_FLAG_HEADER ) {
+                block_Release( p_buffer );
+                p_buffer = p_next;
+                continue;
+            }
+
+            /* prepend Metacube header */
+            struct metacube2_block_header hdr;
+            memcpy( hdr.sync, METACUBE2_SYNC, sizeof( METACUBE2_SYNC ) );
+            hdr.size = hton32( p_buffer->i_buffer );
+            hdr.flags = hton16( 0 );
+            if( p_buffer->i_flags & BLOCK_FLAG_HEADER )
+                hdr.flags |= hton16( METACUBE_FLAGS_HEADER );
+            if( p_sys->b_has_keyframes && !( p_buffer->i_flags & BLOCK_FLAG_TYPE_I ) )
+                hdr.flags |= hton16( METACUBE_FLAGS_NOT_SUITABLE_FOR_STREAM_START );
+            hdr.csum = hton16( metacube2_compute_crc( &hdr ) );
+
+            p_buffer = block_Realloc( p_buffer, sizeof( hdr ), p_buffer->i_buffer );
+            if( p_buffer == NULL ) {
+                block_ChainRelease( p_next );
+                return VLC_ENOMEM;
+            }
+            memcpy( p_buffer->p_buffer, &hdr, sizeof( hdr ) );
+        }
+
+        /* send data */
+        i_err = httpd_StreamSend( p_sys->p_httpd_stream, p_buffer );
+
         block_Release( p_buffer );
         p_buffer = p_next;