modules/stream_out/standard.c

   1 /*****************************************************************************
   2  * standard.c: standard stream output module
   3  *****************************************************************************
   4  * Copyright (C) 2003-2011 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_plugin.h>
  33 #include <vlc_sout.h>
  34
  35 #include <vlc_network.h>
  36 #include <vlc_url.h>
  37 #include <vlc_memstream.h>
  38
  39 /*****************************************************************************
  40  * Module descriptor
  41  *****************************************************************************/
  42 #define ACCESS_TEXT N_("Output access method")
  43 #define ACCESS_LONGTEXT N_( \
  44     "Output method to use for the stream." )
  45 #define MUX_TEXT N_("Output muxer")
  46 #define MUX_LONGTEXT N_( \
  47     "Muxer to use for the stream." )
  48 #define DEST_TEXT N_("Output destination")
  49 #define DEST_LONGTEXT N_( \
  50     "Destination (URL) to use for the stream. Overrides path and bind parameters" )
  51 #define BIND_TEXT N_("address to bind to (helper setting for dst)")
  52 #define BIND_LONGTEXT N_( \
  53   "address:port to bind vlc to listening incoming streams "\
  54   "helper setting for dst,dst=bind+'/'+path. dst-parameter overrides this" )
  55 #define PATH_TEXT N_("filename for stream (helper setting for dst)")
  56 #define PATH_LONGTEXT N_( \
  57   "Filename for stream "\
  58   "helper setting for dst, dst=bind+'/'+path, dst-parameter overrides this" )
  59 #define NAME_TEXT N_("Session name")
  60 #define NAME_LONGTEXT N_( \
  61     "This is the name of the session that will be announced in the SDP " \
  62     "(Session Descriptor)." )
  63 #define DESC_TEXT N_("Session description")
  64 #define DESC_LONGTEXT N_( \
  65     "This allows you to give a short description with details about the stream, " \
  66     "that will be announced in the SDP (Session Descriptor)." )
  67 #define URL_TEXT N_("Session URL")
  68 #define URL_LONGTEXT N_( \
  69     "This allows you to give a URL with more details about the stream " \
  70     "(often the website of the streaming organization), that will " \
  71     "be announced in the SDP (Session Descriptor)." )
  72 #define EMAIL_TEXT N_("Session email")
  73 #define EMAIL_LONGTEXT N_( \
  74     "This allows you to give a contact mail address for the stream, that will " \
  75     "be announced in the SDP (Session Descriptor)." )
  76
  77 #define SAP_TEXT N_("SAP announcing")
  78 #define SAP_LONGTEXT N_("Announce this session with SAP.")
  79
  80 static int      Open    ( vlc_object_t * );
  81 static void     Close   ( vlc_object_t * );
  82
  83 #define SOUT_CFG_PREFIX "sout-standard-"
  84
  85 vlc_module_begin ()
  86     set_shortname( N_("Standard"))
  87     set_description( N_("Standard stream output") )
  88     set_capability( "sout stream", 50 )
  89     add_shortcut( "standard", "std", "file", "http", "udp" )
  90     set_category( CAT_SOUT )
  91     set_subcategory( SUBCAT_SOUT_STREAM )
  92
  93     add_string( SOUT_CFG_PREFIX "access", "", ACCESS_TEXT, ACCESS_LONGTEXT, false )
  94     add_string( SOUT_CFG_PREFIX "mux", "", MUX_TEXT, MUX_LONGTEXT, false )
  95     add_string( SOUT_CFG_PREFIX "dst", "", DEST_TEXT, DEST_LONGTEXT, false )
  96     add_string( SOUT_CFG_PREFIX "bind", "", BIND_TEXT, BIND_LONGTEXT, false )
  97     add_string( SOUT_CFG_PREFIX "path", "", PATH_TEXT, PATH_LONGTEXT, false )
  98     add_bool(   SOUT_CFG_PREFIX "sap", false, SAP_TEXT, SAP_LONGTEXT, true )
  99     add_string( SOUT_CFG_PREFIX "name", "", NAME_TEXT, NAME_LONGTEXT, true )
 100     add_obsolete_string( SOUT_CFG_PREFIX "group" ) /* since 2.1.0 */
 101     add_string( SOUT_CFG_PREFIX "description", "", DESC_TEXT, DESC_LONGTEXT, true )
 102     add_string( SOUT_CFG_PREFIX "url", "", URL_TEXT, URL_LONGTEXT, true )
 103     add_string( SOUT_CFG_PREFIX "email", "", EMAIL_TEXT, EMAIL_LONGTEXT, true )
 104     add_obsolete_string( SOUT_CFG_PREFIX "phone" ) /* since 3.0.0 */
 105
 106     set_callbacks( Open, Close )
 107 vlc_module_end ()
 108
 109
 110 /*****************************************************************************
 111  * Exported prototypes
 112  *****************************************************************************/
 113 static const char *const ppsz_sout_options[] = {
 114     "access", "mux", "url", "dst",
 115     "sap", "name", "description", "url", "email",
 116     "bind", "path", NULL
 117 };
 118
 119 #define DEFAULT_PORT 1234
 120
 121 struct sout_stream_sys_t
 122 {
 123     sout_mux_t           *p_mux;
 124     session_descriptor_t *p_session;
 125 };
 126
 127 static sout_stream_id_sys_t * Add( sout_stream_t *p_stream, const es_format_t *p_fmt )
 128 {
 129     return (sout_stream_id_sys_t*)sout_MuxAddStream( p_stream->p_sys->p_mux, p_fmt );
 130 }
 131
 132 static void Del( sout_stream_t *p_stream, sout_stream_id_sys_t *id )
 133 {
 134     sout_MuxDeleteStream( p_stream->p_sys->p_mux, (sout_input_t*)id );
 135 }
 136
 137 static int Send( sout_stream_t *p_stream, sout_stream_id_sys_t *id,
 138                  block_t *p_buffer )
 139 {
 140     return sout_MuxSendBuffer( p_stream->p_sys->p_mux, (sout_input_t*)id, p_buffer );
 141 }
 142
 143 static void Flush( sout_stream_t *p_stream, sout_stream_id_sys_t *id )
 144 {
 145     sout_MuxFlush( p_stream->p_sys->p_mux, (sout_input_t*)id );
 146 }
 147
 148 static void create_SDP(sout_stream_t *p_stream, sout_access_out_t *p_access)
 149 {
 150     sout_stream_sys_t   *p_sys = p_stream->p_sys;
 151
 152     static const struct addrinfo hints = {
 153         .ai_family = AF_UNSPEC,
 154         .ai_socktype = SOCK_DGRAM,
 155         .ai_protocol = 0,
 156         .ai_flags = AI_NUMERICHOST | AI_NUMERICSERV | AI_IDN,
 157     };
 158     char *shost = var_GetNonEmptyString (p_access, "src-addr");
 159     char *dhost = var_GetNonEmptyString (p_access, "dst-addr");
 160     int sport = var_GetInteger (p_access, "src-port");
 161     int dport = var_GetInteger (p_access, "dst-port");
 162     struct sockaddr_storage src, dst;
 163     socklen_t srclen = 0, dstlen = 0;
 164     struct addrinfo *res;
 165
 166     if (!vlc_getaddrinfo (dhost, dport, &hints, &res))
 167     {
 168         memcpy (&dst, res->ai_addr, dstlen = res->ai_addrlen);
 169         freeaddrinfo (res);
 170     }
 171
 172     if (!vlc_getaddrinfo (shost, sport, &hints, &res))
 173     {
 174         memcpy (&src, res->ai_addr, srclen = res->ai_addrlen);
 175         freeaddrinfo (res);
 176     }
 177
 178     struct vlc_memstream sdp;
 179
 180     if (vlc_sdp_Start(&sdp, VLC_OBJECT (p_stream), SOUT_CFG_PREFIX,
 181                       (struct sockaddr *)&src, srclen,
 182                       (struct sockaddr *)&dst, dstlen) == 0)
 183     {
 184         vlc_memstream_printf(&sdp, "m=video %d udp mpeg\r\n", dport);
 185
 186         /* Register the SDP with the SAP thread */
 187         if (vlc_memstream_close(&sdp) == 0)
 188         {
 189             msg_Dbg(p_stream, "Generated SDP:\n%s", sdp.ptr);
 190             p_sys->p_session =
 191                 sout_AnnounceRegisterSDP(p_stream, sdp.ptr, dhost);
 192             free(sdp.ptr);
 193         }
 194     }
 195     free(shost);
 196     free(dhost);
 197 }
 198
 199 static const char *getMuxFromAlias( const char *psz_alias )
 200 {
 201     static struct { const char alias[6]; const char mux[32]; } mux_alias[] =
 202     {
 203         { "avi", "avi" },
 204         { "ogg", "ogg" },
 205         { "ogm", "ogg" },
 206         { "ogv", "ogg" },
 207         { "flac","raw" },
 208         { "mp3", "raw" },
 209         { "mp4", "mp4" },
 210         { "mov", "mov" },
 211         { "moov","mov" },
 212         { "asf", "asf" },
 213         { "wma", "asf" },
 214         { "wmv", "asf" },
 215         { "trp", "ts" },
 216         { "ts",  "ts" },
 217         { "mpg", "ps" },
 218         { "mpeg","ps" },
 219         { "ps",  "ps" },
 220         { "mpeg1","mpeg1" },
 221         { "wav", "wav" },
 222         { "flv", "avformat{mux=flv}" },
 223         { "mkv", "avformat{mux=matroska}"},
 224         { "webm", "avformat{mux=webm}"},
 225     };
 226
 227     if( !psz_alias )
 228         return NULL;
 229
 230     for( size_t i = 0; i < sizeof mux_alias / sizeof *mux_alias; i++ )
 231         if( !strcasecmp( psz_alias, mux_alias[i].alias ) )
 232             return mux_alias[i].mux;
 233
 234     return NULL;
 235 }
 236
 237 static int fixAccessMux( sout_stream_t *p_stream, char **ppsz_mux,
 238                           char **ppsz_access, const char *psz_url )
 239 {
 240     char *psz_mux = *ppsz_mux;
 241     char *psz_access = *ppsz_access;
 242     if( !psz_mux )
 243     {
 244         const char *psz_ext = psz_url ? strrchr( psz_url, '.' ) : NULL;
 245         if( psz_ext )
 246             psz_ext++; /* use extension */
 247         const char *psz_mux_byext = getMuxFromAlias( psz_ext );
 248
 249         if( !psz_access )
 250         {
 251             if( !psz_mux_byext )
 252             {
 253                 msg_Err( p_stream, "no access _and_ no muxer" );
 254                 return 1;
 255             }
 256
 257             msg_Warn( p_stream,
 258                     "no access _and_ no muxer, extension gives file/%s",
 259                     psz_mux_byext );
 260             *ppsz_access = strdup("file");
 261             *ppsz_mux    = strdup(psz_mux_byext);
 262         }
 263         else
 264         {
 265             if( !strncmp( psz_access, "mmsh", 4 ) )
 266                 *ppsz_mux = strdup("asfh");
 267             else if (!strcmp (psz_access, "udp"))
 268                 *ppsz_mux = strdup("ts");
 269             else if( psz_mux_byext )
 270                 *ppsz_mux = strdup(psz_mux_byext);
 271             else
 272             {
 273                 msg_Err( p_stream, "no mux specified or found by extension" );
 274                 return 1;
 275             }
 276         }
 277     }
 278     else if( !psz_access )
 279     {
 280         if( !strncmp( psz_mux, "asfh", 4 ) )
 281             *ppsz_access = strdup("mmsh");
 282         else /* default file */
 283             *ppsz_access = strdup("file");
 284     }
 285     return 0;
 286 }
 287
 288 static bool exactMatch( const char *psz_target, const char *psz_string,
 289                         size_t i_len )
 290 {
 291     if ( strncmp( psz_target, psz_string, i_len ) )
 292         return false;
 293     else
 294         return ( psz_target[i_len] < 'a' || psz_target[i_len] > 'z' );
 295 }
 296
 297 static void checkAccessMux( sout_stream_t *p_stream, char *psz_access,
 298                             char *psz_mux )
 299 {
 300     if( exactMatch( psz_access, "mmsh", 4 ) && !exactMatch( psz_mux, "asfh", 4 ) )
 301         msg_Err( p_stream, "mmsh output is only valid with asfh mux" );
 302     else if( !exactMatch( psz_access, "file", 4 ) &&
 303              ( exactMatch( psz_mux, "mov", 3 ) || exactMatch( psz_mux, "mp4", 3 ) ) )
 304         msg_Err( p_stream, "mov and mp4 mux are only valid with file output" );
 305     else if( exactMatch( psz_access, "udp", 3 ) )
 306     {
 307         if( exactMatch( psz_mux, "ffmpeg", 6 ) || exactMatch( psz_mux, "avformat", 8 ) )
 308         {   /* why would you use ffmpeg's ts muxer ? YOU DON'T LOVE VLC ??? */
 309             char *psz_ffmpeg_mux = var_CreateGetString( p_stream, "sout-avformat-mux" );
 310             if( !psz_ffmpeg_mux || strncmp( psz_ffmpeg_mux, "mpegts", 6 ) )
 311                 msg_Err( p_stream, "UDP output is only valid with TS mux" );
 312             free( psz_ffmpeg_mux );
 313         }
 314         else if( !exactMatch( psz_mux, "ts", 2 ) )
 315             msg_Err( p_stream, "UDP output is only valid with TS mux" );
 316     }
 317 }
 318
 319 /*****************************************************************************
 320  * Open:
 321  *****************************************************************************/
 322 static int Open( vlc_object_t *p_this )
 323 {
 324     sout_stream_t       *p_stream = (sout_stream_t*)p_this;
 325     sout_stream_sys_t   *p_sys;
 326     char *psz_mux, *psz_access, *psz_url;
 327     sout_access_out_t   *p_access;
 328     int                 ret = VLC_EGENERIC;
 329
 330     config_ChainParse( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options,
 331                    p_stream->p_cfg );
 332
 333     psz_mux = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "mux" );
 334
 335     psz_access = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "access" );
 336     if( !psz_access )
 337         psz_access = strdup(p_stream->psz_name);
 338
 339     psz_url = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "dst" );
 340     if (!psz_url)
 341     {
 342         char *psz_bind = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "bind" );
 343         if( psz_bind )
 344         {
 345             char *psz_path = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "path" );
 346             if( psz_path )
 347             {
 348                 if( asprintf( &psz_url, "%s/%s", psz_bind, psz_path ) == -1 )
 349                     psz_url = NULL;
 350                 free(psz_bind);
 351                 free( psz_path );
 352             }
 353             else
 354                 psz_url = psz_bind;
 355         }
 356     }
 357
 358     p_sys = p_stream->p_sys = malloc( sizeof( sout_stream_sys_t) );
 359     if( !p_sys )
 360     {
 361         ret = VLC_ENOMEM;
 362         goto end;
 363     }
 364     p_sys->p_session = NULL;
 365
 366     if( fixAccessMux( p_stream, &psz_mux, &psz_access, psz_url ) )
 367         goto end;
 368
 369     checkAccessMux( p_stream, psz_access, psz_mux );
 370
 371     p_access = sout_AccessOutNew( p_stream, psz_access, psz_url );
 372     if( p_access == NULL )
 373     {
 374         msg_Err( p_stream, "no suitable sout access module for `%s/%s://%s'",
 375                  psz_access, psz_mux, psz_url );
 376         goto end;
 377     }
 378
 379     p_sys->p_mux = sout_MuxNew( p_stream->p_sout, psz_mux, p_access );
 380     if( !p_sys->p_mux )
 381     {
 382         const char *psz_mux_guess = getMuxFromAlias( psz_mux );
 383         if( psz_mux_guess && strcmp( psz_mux_guess, psz_mux ) )
 384         {
 385             msg_Dbg( p_stream, "Couldn't open mux `%s', trying `%s' instead",
 386                 psz_mux, psz_mux_guess );
 387             p_sys->p_mux = sout_MuxNew( p_stream->p_sout, psz_mux_guess, p_access );
 388         }
 389
 390         if( !p_sys->p_mux )
 391         {
 392             msg_Err( p_stream, "no suitable sout mux module for `%s/%s://%s'",
 393                 psz_access, psz_mux, psz_url );
 394
 395             sout_AccessOutDelete( p_access );
 396             goto end;
 397         }
 398     }
 399
 400     if( var_GetBool( p_stream, SOUT_CFG_PREFIX"sap" ) )
 401         create_SDP( p_stream, p_access );
 402
 403     p_stream->pf_add    = Add;
 404     p_stream->pf_del    = Del;
 405     p_stream->pf_send   = Send;
 406     p_stream->pf_flush  = Flush;
 407     if( !sout_AccessOutCanControlPace( p_access ) )
 408         p_stream->pace_nocontrol = true;
 409
 410     ret = VLC_SUCCESS;
 411
 412     msg_Dbg( p_this, "using `%s/%s://%s'", psz_access, psz_mux, psz_url );
 413
 414 end:
 415     if( ret != VLC_SUCCESS )
 416         free( p_sys );
 417     free( psz_access );
 418     free( psz_mux );
 419     free( psz_url );
 420
 421     return ret;
 422 }
 423
 424 /*****************************************************************************
 425  * Close:
 426  *****************************************************************************/
 427 static void Close( vlc_object_t * p_this )
 428 {
 429     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
 430     sout_stream_sys_t *p_sys    = p_stream->p_sys;
 431     sout_access_out_t *p_access = p_sys->p_mux->p_access;
 432
 433     if( p_sys->p_session != NULL )
 434         sout_AnnounceUnRegister( p_stream, p_sys->p_session );
 435
 436     sout_MuxDelete( p_sys->p_mux );
 437     sout_AccessOutDelete( p_access );
 438
 439     free( p_sys );
 440 }