/*****************************************************************************
* http.c
*****************************************************************************
- * Copyright (C) 2001-2005 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.
*****************************************************************************/
/*****************************************************************************
# include "config.h"
#endif
-#include <vlc/vlc.h>
+#include <stdint.h>
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
#include <vlc_sout.h>
#include <vlc_block.h>
#include <vlc_input.h>
-#include <vlc_playlist.h>
-
-#ifdef HAVE_AVAHI_CLIENT
- #include "bonjour.h"
-
- #if defined( WIN32 )
- #define DIRECTORY_SEPARATOR '\\'
- #else
- #define DIRECTORY_SEPARATOR '/'
- #endif
-#endif
-
-#include "vlc_httpd.h"
-
-#define DEFAULT_PORT 8080
-#define DEFAULT_SSL_PORT 8443
+#include <vlc_httpd.h>
/*****************************************************************************
* Module descriptor
#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 " \
#define MIME_TEXT N_("Mime")
#define MIME_LONGTEXT N_("MIME returned by the server (autodetected " \
"if not specified)." )
-#define CERT_TEXT N_( "Certificate file" )
-#define CERT_LONGTEXT N_( "Path to the x509 PEM certificate file that will "\
- "be used for HTTPS." )
-#define KEY_TEXT N_( "Private key file" )
-#define KEY_LONGTEXT N_( "Path to the x509 PEM private key file that will " \
- "be used for HTTPS. Leave " \
- "empty if you don't have one." )
-#define CA_TEXT N_( "Root CA file" )
-#define CA_LONGTEXT N_( "Path to the x509 PEM trusted root CA certificates " \
- "(certificate authority) file that will be used for " \
- "HTTPS. Leave empty if you " \
- "don't have one." )
-#define CRL_TEXT N_( "CRL file" )
-#define CRL_LONGTEXT N_( "Path to the x509 PEM Certificates Revocation List " \
- "file that will be used for SSL. Leave " \
- "empty if you don't have one." )
-#define BONJOUR_TEXT N_( "Advertise with Bonjour")
-#define BONJOUR_LONGTEXT N_( "Advertise the stream with the Bonjour protocol." )
-
-
-vlc_module_begin();
- set_description( _("HTTP stream output") );
- set_capability( "sout access", 0 );
- set_shortname( "HTTP" );
- add_shortcut( "http" );
- add_shortcut( "https" );
- add_shortcut( "mmsh" );
- set_category( CAT_SOUT );
- set_subcategory( SUBCAT_SOUT_ACO );
- add_string( SOUT_CFG_PREFIX "user", "", NULL,
- USER_TEXT, USER_LONGTEXT, true );
- add_string( SOUT_CFG_PREFIX "pwd", "", NULL,
- PASS_TEXT, PASS_LONGTEXT, true );
- add_string( SOUT_CFG_PREFIX "mime", "", NULL,
- MIME_TEXT, MIME_LONGTEXT, true );
- add_string( SOUT_CFG_PREFIX "cert", "vlc.pem", NULL,
- CERT_TEXT, CERT_LONGTEXT, true );
- add_string( SOUT_CFG_PREFIX "key", NULL, NULL,
- KEY_TEXT, KEY_LONGTEXT, true );
- add_string( SOUT_CFG_PREFIX "ca", NULL, NULL,
- CA_TEXT, CA_LONGTEXT, true );
- add_string( SOUT_CFG_PREFIX "crl", NULL, NULL,
- CRL_TEXT, CRL_LONGTEXT, true );
- add_bool( SOUT_CFG_PREFIX "bonjour", false, NULL,
- BONJOUR_TEXT, BONJOUR_LONGTEXT, true);
- set_callbacks( Open, Close );
-vlc_module_end();
+#define METACUBE_TEXT N_("Metacube")
+#define METACUBE_LONGTEXT N_("Use the Metacube protocol. Needed for streaming " \
+ "to the Cubemap reflector.")
+
+
+vlc_module_begin ()
+ set_description( N_("HTTP stream output") )
+ set_capability( "sout access", 0 )
+ set_shortname( "HTTP" )
+ add_shortcut( "http", "https", "mmsh" )
+ set_category( CAT_SOUT )
+ set_subcategory( SUBCAT_SOUT_ACO )
+ add_string( SOUT_CFG_PREFIX "user", "",
+ USER_TEXT, USER_LONGTEXT, true )
+ add_password( SOUT_CFG_PREFIX "pwd", "",
+ PASS_TEXT, PASS_LONGTEXT, true )
+ add_string( SOUT_CFG_PREFIX "mime", "",
+ MIME_TEXT, MIME_LONGTEXT, true )
+ add_bool( SOUT_CFG_PREFIX "metacube", false,
+ METACUBE_TEXT, METACUBE_LONGTEXT, true )
+ set_callbacks( Open, Close )
+vlc_module_end ()
/*****************************************************************************
* Exported prototypes
*****************************************************************************/
-static const char *ppsz_sout_options[] = {
- "user", "pwd", "mime", "cert", "key", "ca", "crl", NULL
+static const char *const ppsz_sout_options[] = {
+ "user", "pwd", "mime", "metacube", NULL
};
static ssize_t Write( sout_access_out_t *, block_t * );
static int Seek ( sout_access_out_t *, off_t );
+static int Control( sout_access_out_t *, int, va_list );
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;
+};
-#ifdef 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
*****************************************************************************/
sout_access_out_t *p_access = (sout_access_out_t*)p_this;
sout_access_out_sys_t *p_sys;
- char *psz_parser;
-
- char *psz_bind_addr;
- int i_bind_port;
- char *psz_file_name;
- char *psz_user = NULL;
- char *psz_pwd = NULL;
- char *psz_mime = NULL;
- const char *psz_cert = NULL, *psz_key = NULL, *psz_ca = NULL,
- *psz_crl = NULL;
- vlc_value_t val;
+ char *psz_user;
+ char *psz_pwd;
+ char *psz_mime;
if( !( p_sys = p_access->p_sys =
malloc( sizeof( sout_access_out_sys_t ) ) ) )
- {
- msg_Err( p_access, "Not enough memory" );
return VLC_ENOMEM ;
- }
config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
- /* p_access->psz_path = "hostname:port/filename" */
- psz_bind_addr = psz_parser = strdup( p_access->psz_path );
-
- i_bind_port = 0;
- psz_file_name = NULL;
-
- while( *psz_parser && *psz_parser != ':' && *psz_parser != '/' )
+ const char *path = p_access->psz_path;
+ path += strcspn( path, "/" );
+ if( path > p_access->psz_path )
{
- psz_parser++;
- }
- if( *psz_parser == ':' )
- {
- *psz_parser = '\0';
- psz_parser++;
- i_bind_port = atoi( psz_parser );
-
- while( *psz_parser && *psz_parser != '/' )
+ const char *port = strrchr( p_access->psz_path, ':' );
+ if( port != NULL && strchr( port, ']' ) != NULL )
+ port = NULL; /* IPv6 numeral */
+ if( port != p_access->psz_path )
{
- psz_parser++;
+ int len = (port ? port : path) - p_access->psz_path;
+ msg_Warn( p_access, "\"%.*s\" HTTP host might be ignored in "
+ "multiple-host configurations, use at your own risks.",
+ len, p_access->psz_path );
+ msg_Info( p_access, "Consider passing --http-host=IP on the "
+ "command line instead." );
+
+ char host[len + 1];
+ strncpy( host, p_access->psz_path, len );
+ host[len] = '\0';
+
+ var_Create( p_access, "http-host", VLC_VAR_STRING );
+ var_SetString( p_access, "http-host", host );
+ }
+ if( port != NULL )
+ {
+ /* int len = path - ++port;
+ msg_Info( p_access, "Consider passing --%s-port=%.*s on the "
+ "command line instead.",
+ strcasecmp( p_access->psz_access, "https" )
+ ? "http" : "https", len, port ); */
+ port++;
+
+ int bind_port = atoi( port );
+ if( bind_port > 0 )
+ {
+ const char *var = strcasecmp( p_access->psz_access, "https" )
+ ? "http-port" : "https-port";
+ var_Create( p_access, var, VLC_VAR_INTEGER );
+ var_SetInteger( p_access, var, bind_port );
+ }
}
}
- if( *psz_parser == '/' )
- {
- *psz_parser = '\0';
- psz_parser++;
- psz_file_name = psz_parser;
- }
-
- if( psz_file_name == NULL )
- {
- psz_file_name = strdup( "/" );
- }
- else if( *psz_file_name != '/' )
- {
- char *p = psz_file_name;
-
- psz_file_name = malloc( strlen( p ) + 2 );
- strcpy( psz_file_name, "/" );
- strcat( psz_file_name, p );
- }
- else
- {
- psz_file_name = strdup( psz_file_name );
- }
+ if( !*path )
+ path = "/";
- /* SSL support */
+ /* TLS support */
if( p_access->psz_access && !strcmp( p_access->psz_access, "https" ) )
- {
- psz_cert = config_GetPsz( p_this, SOUT_CFG_PREFIX"cert" );
- psz_key = config_GetPsz( p_this, SOUT_CFG_PREFIX"key" );
- psz_ca = config_GetPsz( p_this, SOUT_CFG_PREFIX"ca" );
- psz_crl = config_GetPsz( p_this, SOUT_CFG_PREFIX"crl" );
-
- if( i_bind_port <= 0 )
- i_bind_port = DEFAULT_SSL_PORT;
- }
+ p_sys->p_httpd_host = vlc_https_HostNew( VLC_OBJECT(p_access) );
else
- {
- if( i_bind_port <= 0 )
- i_bind_port = DEFAULT_PORT;
- }
+ p_sys->p_httpd_host = vlc_http_HostNew( VLC_OBJECT(p_access) );
- p_sys->p_httpd_host = httpd_TLSHostNew( VLC_OBJECT(p_access),
- psz_bind_addr, i_bind_port,
- psz_cert, psz_key, psz_ca,
- psz_crl );
if( p_sys->p_httpd_host == NULL )
{
- msg_Err( p_access, "cannot listen on %s:%d",
- psz_bind_addr, i_bind_port );
- free( psz_file_name );
- free( psz_bind_addr );
+ msg_Err( p_access, "cannot start HTTP server" );
free( p_sys );
return VLC_EGENERIC;
}
- free( psz_bind_addr );
+ psz_user = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "user" );
+ psz_pwd = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "pwd" );
if( p_access->psz_access && !strcmp( p_access->psz_access, "mmsh" ) )
{
psz_mime = strdup( "video/x-ms-asf-stream" );
}
else
{
- var_Get( p_access, SOUT_CFG_PREFIX "mime", &val );
- if( *val.psz_string )
- psz_mime = val.psz_string;
- else
- free( val.psz_string );
+ psz_mime = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "mime" );
}
- var_Get( p_access, SOUT_CFG_PREFIX "user", &val );
- if( *val.psz_string )
- psz_user = val.psz_string;
- else
- free( val.psz_string );
-
- var_Get( p_access, SOUT_CFG_PREFIX "pwd", &val );
- if( *val.psz_string )
- psz_pwd = val.psz_string;
- else
- free( val.psz_string );
+ 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, psz_file_name, psz_mime,
- psz_user, psz_pwd, NULL );
+ httpd_StreamNew( p_sys->p_httpd_host, path, psz_mime,
+ psz_user, psz_pwd );
free( psz_user );
free( psz_pwd );
free( psz_mime );
if( p_sys->p_httpd_stream == NULL )
{
- msg_Err( p_access, "cannot add stream %s", psz_file_name );
+ msg_Err( p_access, "cannot add stream %s", path );
httpd_HostDelete( p_sys->p_httpd_host );
- free( psz_file_name );
free( p_sys );
return VLC_EGENERIC;
}
-#ifdef HAVE_AVAHI_CLIENT
- if( config_GetInt(p_this, SOUT_CFG_PREFIX "bonjour") )
+ if( p_sys->b_metacube )
{
- char *psz_txt, *psz_name;
- playlist_t *p_playlist = pl_Yield( 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( psz_file_name &&
- asprintf( &psz_txt, "path=%s", psz_file_name ) == -1 )
- {
- pl_Release( p_playlist );
- 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( (void *)psz_txt );
-
- if( p_sys->p_bonjour == NULL )
- msg_Err( p_access, "unable to start requested Bonjour announce" );
- pl_Release( p_playlist );
+ 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
-
- free( psz_file_name );
p_sys->i_header_allocated = 1024;
p_sys->i_header_size = 0;
- p_sys->p_header = malloc( p_sys->i_header_allocated );
+ p_sys->p_header = xmalloc( p_sys->i_header_allocated );
p_sys->b_header_complete = false;
p_access->pf_write = Write;
p_access->pf_seek = Seek;
-
-
- /* update p_sout->i_out_pace_nocontrol */
- p_access->p_sout->i_out_pace_nocontrol++;
+ p_access->pf_control = Control;
return VLC_SUCCESS;
}
sout_access_out_t *p_access = (sout_access_out_t*)p_this;
sout_access_out_sys_t *p_sys = p_access->p_sys;
-#ifdef HAVE_AVAHI_CLIENT
- if( p_sys->p_bonjour != NULL )
- bonjour_stop_service( p_sys->p_bonjour );
-#endif
-
- /* update p_sout->i_out_pace_nocontrol */
- p_access->p_sout->i_out_pace_nocontrol--;
-
httpd_StreamDelete( p_sys->p_httpd_stream );
httpd_HostDelete( p_sys->p_httpd_host );
free( p_sys );
}
+static int Control( sout_access_out_t *p_access, int i_query, va_list args )
+{
+ (void)p_access;
+
+ switch( i_query )
+ {
+ case ACCESS_OUT_CONTROLS_PACE:
+ *va_arg( args, bool * ) = false;
+ break;
+
+ default:
+ return VLC_EGENERIC;
+ }
+ return VLC_SUCCESS;
+}
+
/*****************************************************************************
* Write:
*****************************************************************************/
{
p_sys->i_header_allocated =
p_buffer->i_buffer + p_sys->i_header_size + 1024;
- p_sys->p_header =
- realloc( p_sys->p_header, p_sys->i_header_allocated );
+ p_sys->p_header = xrealloc( p_sys->p_header,
+ p_sys->i_header_allocated );
}
memcpy( &p_sys->p_header[p_sys->i_header_size],
p_buffer->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;
*****************************************************************************/
static int Seek( sout_access_out_t *p_access, off_t i_pos )
{
+ (void)i_pos;
msg_Warn( p_access, "HTTP sout access cannot seek" );
return VLC_EGENERIC;
}
projects / vlc / blobdiff