]> git.sesse.net Git - vlc/blob - modules/stream_out/standard.c
Add bind and path aliases for standard streamoutput, so you can document
[vlc] / modules / stream_out / standard.c
1 /*****************************************************************************
2  * standard.c: standard stream output module
3  *****************************************************************************
4  * Copyright (C) 2003-2007 the VideoLAN team
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
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 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 General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, 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/vlc.h>
32 #include <vlc_sout.h>
33
34 #include <vlc_network.h>
35 #include "vlc_url.h"
36
37 /*****************************************************************************
38  * Module descriptor
39  *****************************************************************************/
40 #define ACCESS_TEXT N_("Output access method")
41 #define ACCESS_LONGTEXT N_( \
42     "Output method to use for the stream." )
43 #define MUX_TEXT N_("Output muxer")
44 #define MUX_LONGTEXT N_( \
45     "Muxer to use for the stream." )
46 #define DEST_TEXT N_("Output destination")
47 #define DEST_LONGTEXT N_( \
48     "Destination (URL) to use for the stream." )
49 #define BIND_TEXT N_("address to bind to (helper setting for dst)")
50 #define BIND_LONGTEXT N_( \
51   "address:port to bind vlc to listening incoming streams "\
52   "helper setting for dst,dst=bind+'/'+path" )
53 #define PATH_TEXT N_("filename for stream (helper setting for dst)")
54 #define PATH_LONGTEXT N_( \
55   "Filename for stream "\
56   "helper setting for dst, dst=bind+'/'+path" )
57 #define NAME_TEXT N_("Session name")
58 #define NAME_LONGTEXT N_( \
59   "This allows you to specify a name for the session, that will be announced "\
60   "if you choose to use SAP." )
61
62 #define GROUP_TEXT N_("Session groupname")
63 #define GROUP_LONGTEXT N_( \
64   "This allows you to specify a group for the session, that will be announced "\
65   "if you choose to use SAP." )
66
67 #define DESC_TEXT N_("Session description")
68 #define DESC_LONGTEXT N_( \
69     "This allows you to give a short description with details about the stream, " \
70     "that will be announced in the SDP (Session Descriptor)." )
71 #define URL_TEXT N_("Session URL")
72 #define URL_LONGTEXT N_( \
73     "This allows you to give an URL with more details about the stream " \
74     "(often the website of the streaming organization), that will " \
75     "be announced in the SDP (Session Descriptor)." )
76 #define EMAIL_TEXT N_("Session email")
77 #define EMAIL_LONGTEXT N_( \
78     "This allows you to give a contact mail address for the stream, that will " \
79     "be announced in the SDP (Session Descriptor)." )
80 #define PHONE_TEXT N_("Session phone number")
81 #define PHONE_LONGTEXT N_( \
82     "This allows you to give a contact telephone number for the stream, that will " \
83     "be announced in the SDP (Session Descriptor)." )
84
85
86 #define SAP_TEXT N_("SAP announcing")
87 #define SAP_LONGTEXT N_("Announce this session with SAP.")
88
89 static int      Open    ( vlc_object_t * );
90 static void     Close   ( vlc_object_t * );
91
92 #define SOUT_CFG_PREFIX "sout-standard-"
93
94 vlc_module_begin();
95     set_shortname( _("Standard"));
96     set_description( _("Standard stream output") );
97     set_capability( "sout stream", 50 );
98     add_shortcut( "standard" );
99     add_shortcut( "std" );
100     set_category( CAT_SOUT );
101     set_subcategory( SUBCAT_SOUT_STREAM );
102
103     add_string( SOUT_CFG_PREFIX "access", "", NULL, ACCESS_TEXT,
104                 ACCESS_LONGTEXT, VLC_FALSE );
105     add_string( SOUT_CFG_PREFIX "mux", "", NULL, MUX_TEXT,
106                 MUX_LONGTEXT, VLC_FALSE );
107     add_string( SOUT_CFG_PREFIX "dst", "", NULL, DEST_TEXT,
108                 DEST_LONGTEXT, VLC_FALSE );
109     add_string( SOUT_CFG_PREFIX "bind", "", NULL, BIND_TEXT,
110                 BIND_LONGTEXT, VLC_FALSE );
111     add_string( SOUT_CFG_PREFIX "path", "", NULL, PATH_TEXT,
112                 PATH_LONGTEXT, VLC_FALSE );
113         change_unsafe();
114
115     add_bool( SOUT_CFG_PREFIX "sap", VLC_FALSE, NULL, SAP_TEXT, SAP_LONGTEXT,
116               VLC_TRUE );
117     add_string( SOUT_CFG_PREFIX "name", "", NULL, NAME_TEXT, NAME_LONGTEXT,
118                                         VLC_TRUE );
119     add_string( SOUT_CFG_PREFIX "group", "", NULL, GROUP_TEXT, GROUP_LONGTEXT,
120                                         VLC_TRUE );
121     add_string( SOUT_CFG_PREFIX "description", "", NULL, DESC_TEXT, DESC_LONGTEXT,
122                                         VLC_TRUE );
123     add_string( SOUT_CFG_PREFIX "url", "", NULL, URL_TEXT, URL_LONGTEXT,
124                                         VLC_TRUE );
125     add_string( SOUT_CFG_PREFIX "email", "", NULL, EMAIL_TEXT, EMAIL_LONGTEXT,
126                                         VLC_TRUE );
127     add_string( SOUT_CFG_PREFIX "phone", "", NULL, PHONE_TEXT, PHONE_LONGTEXT,
128                                         VLC_TRUE );
129     add_obsolete_bool( SOUT_CFG_PREFIX "sap-ipv6" );
130
131     set_callbacks( Open, Close );
132 vlc_module_end();
133
134
135 /*****************************************************************************
136  * Exported prototypes
137  *****************************************************************************/
138 static const char *ppsz_sout_options[] = {
139     "access", "mux", "url", "dst",
140     "sap", "name", "group", "description", "url", "email", "phone",
141     "bind", "path", NULL
142 };
143
144 #define DEFAULT_PORT 1234
145
146 static sout_stream_id_t *Add ( sout_stream_t *, es_format_t * );
147 static int               Del ( sout_stream_t *, sout_stream_id_t * );
148 static int               Send( sout_stream_t *, sout_stream_id_t *, block_t* );
149
150 struct sout_stream_sys_t
151 {
152     sout_mux_t           *p_mux;
153     session_descriptor_t *p_session;
154 };
155
156 /*****************************************************************************
157  * Open:
158  *****************************************************************************/
159 static int Open( vlc_object_t *p_this )
160 {
161     sout_stream_t       *p_stream = (sout_stream_t*)p_this;
162     sout_instance_t     *p_sout = p_stream->p_sout;
163     sout_stream_sys_t   *p_sys;
164
165     char *psz_mux;
166     char *psz_access;
167     char *psz_url;
168     char *psz_bind;
169     char *psz_path;
170
171     vlc_value_t val;
172
173     sout_access_out_t   *p_access;
174     sout_mux_t          *p_mux;
175
176     const char          *psz_mux_byext = NULL;
177
178     config_ChainParse( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options,
179                    p_stream->p_cfg );
180
181     var_Get( p_stream, SOUT_CFG_PREFIX "access", &val );
182     psz_access = *val.psz_string ? val.psz_string : NULL;
183     if( !*val.psz_string ) free( val.psz_string );
184
185     var_Get( p_stream, SOUT_CFG_PREFIX "mux", &val );
186     psz_mux = *val.psz_string ? val.psz_string : NULL;
187     if( !*val.psz_string ) free( val.psz_string );
188
189     var_Get( p_stream, SOUT_CFG_PREFIX "bind", &val );
190     psz_bind = *val.psz_string ? val.psz_string : NULL;
191     if( !*val.psz_string ) free( val.psz_string);
192
193     var_Get( p_stream, SOUT_CFG_PREFIX "path", &val );
194     psz_path = *val.psz_string ? val.psz_string : NULL;
195     if( !*val.psz_string ) free( val.psz_string);
196
197     if( psz_bind ) psz_url = psz_bind;
198     if( psz_url && psz_path ) 
199     {
200         if( asprintf( &psz_url,"%s/%s",psz_url,psz_path ) == -1 )
201             psz_url = NULL;
202         free( psz_path );
203     }
204
205     var_Get( p_stream, SOUT_CFG_PREFIX "dst", &val );
206     if( *val.psz_string ) psz_url = val.psz_string;
207     if( !*val.psz_string ) free( val.psz_string );
208
209     p_sys = p_stream->p_sys = malloc( sizeof( sout_stream_sys_t) );
210     if( !p_sys ) return VLC_ENOMEM;
211     p_stream->p_sys->p_session = NULL;
212
213     msg_Dbg( p_this, "creating `%s/%s://%s'", psz_access, psz_mux, psz_url );
214
215     /* ext -> muxer name */
216     if( psz_url && strrchr( psz_url, '.' ) )
217     {
218         /* by extension */
219         static struct { const char ext[6]; const char mux[32]; } exttomux[] =
220         {
221             { "avi", "avi" },
222             { "ogg", "ogg" },
223             { "ogm", "ogg" },
224             { "mp4", "mp4" },
225             { "mov", "mov" },
226             { "moov","mov" },
227             { "asf", "asf" },
228             { "wma", "asf" },
229             { "wmv", "asf" },
230             { "trp", "ts" },
231             { "ts",  "ts" },
232             { "mpg", "ps" },
233             { "mpeg","ps" },
234             { "ps",  "ps" },
235             { "mpeg1","mpeg1" },
236             { "wav", "wav" },
237             { "flv", "ffmpeg{mux=flv}" },
238             { "mkv", "ffmpeg{mux=matroska}"},
239             { "",    "" }
240         };
241         const char *psz_ext = strrchr( psz_url, '.' ) + 1;
242         int  i;
243
244         msg_Dbg( p_this, "extension is %s", psz_ext );
245         for( i = 0; exttomux[i].ext[0]; i++ )
246         {
247             if( !strcasecmp( psz_ext, exttomux[i].ext ) )
248             {
249                 psz_mux_byext = exttomux[i].mux;
250                 break;
251             }
252         }
253         msg_Dbg( p_this, "extension -> mux=%s", psz_mux_byext );
254     }
255
256     /* We fix access/mux to valid couple */
257
258     if( !psz_access && !psz_mux )
259     {
260         if( psz_mux_byext )
261         {
262             msg_Warn( p_stream,
263                       "no access _and_ no muxer, extension gives file/%s",
264                       psz_mux_byext );
265             psz_access = strdup("file");
266             psz_mux    = strdup(psz_mux_byext);
267         }
268         else
269         {
270             msg_Err( p_stream, "no access _and_ no muxer (fatal error)" );
271             return VLC_EGENERIC;
272         }
273     }
274
275     if( psz_access && !psz_mux )
276     {
277         /* access given, no mux */
278         if( !strncmp( psz_access, "mmsh", 4 ) )
279         {
280             psz_mux = strdup("asfh");
281         }
282         else if (!strcmp (psz_access, "udp")
283               || !strcmp (psz_access, "rtp"))
284         {
285             psz_mux = strdup("ts");
286         }
287         else if( psz_mux_byext )
288         {
289             psz_mux = strdup(psz_mux_byext);
290         }
291         else
292         {
293             msg_Err( p_stream, "no mux specified or found by extension" );
294             return VLC_EGENERIC;
295         }
296     }
297     else if( psz_mux && !psz_access )
298     {
299         /* mux given, no access */
300         if( !strncmp( psz_mux, "asfh", 4 ) )
301         {
302             psz_access = strdup("mmsh");
303         }
304         else
305         {
306             /* default file */
307             psz_access = strdup("file");
308         }
309     }
310
311     /* fix or warn of incompatible couple */
312     if( !strncmp( psz_access, "mmsh", 4 ) &&
313         strncmp( psz_mux, "asfh", 4 ) )
314     {
315         char *p = strchr( psz_mux,'{' );
316
317         msg_Warn( p_stream, "fixing to mmsh/asfh" );
318         if( p )
319         {
320             if( asprintf( &p, "asfh%s", p ) == -1 )
321                 p = NULL;
322             free( psz_mux );
323             psz_mux = p;
324         }
325         else
326         {
327             free( psz_mux );
328             psz_mux = strdup("asfh");
329         }
330     }
331     else if( ( !strncmp( psz_access, "rtp", 3 ) ||
332                !strncmp( psz_access, "udp", 3 ) ) )
333     {
334         if( !strncmp( psz_mux, "ffmpeg", 6 ) )
335         {   /* why would you use ffmpeg's ts muxer ? YOU DON'T LOVE VLC ??? */
336             char *psz_ffmpeg_mux = var_CreateGetString( p_this, "ffmpeg-mux" );
337             if( !psz_ffmpeg_mux || strncmp( psz_ffmpeg_mux, "mpegts", 6 ) )
338                 msg_Err( p_stream, "UDP and RTP are only valid with TS" );
339             free( psz_ffmpeg_mux );
340         }
341         else if( strncmp( psz_mux, "ts", 2 ) )
342         {
343             msg_Err( p_stream, "UDP and RTP are only valid with TS" );
344         }
345     }
346     else if( strncmp( psz_access, "file", 4 ) &&
347              ( !strncmp( psz_mux, "mov", 3 ) ||
348                !strncmp( psz_mux, "mp4", 3 ) ) )
349     {
350         msg_Err( p_stream, "mov and mp4 work only with file output" );
351     }
352
353     msg_Dbg( p_this, "using `%s/%s://%s'", psz_access, psz_mux, psz_url );
354
355     /* *** find and open appropriate access module *** */
356     p_access = sout_AccessOutNew( p_sout, psz_access, psz_url );
357     if( p_access == NULL )
358     {
359         msg_Err( p_stream, "no suitable sout access module for `%s/%s://%s'",
360                  psz_access, psz_mux, psz_url );
361         free( psz_access );
362         free( psz_mux );
363         return VLC_EGENERIC;
364     }
365     msg_Dbg( p_stream, "access opened" );
366
367     /* *** find and open appropriate mux module *** */
368     p_mux = sout_MuxNew( p_sout, psz_mux, p_access );
369     if( p_mux == NULL )
370     {
371         msg_Err( p_stream, "no suitable sout mux module for `%s/%s://%s'",
372                  psz_access, psz_mux, psz_url );
373
374         sout_AccessOutDelete( p_access );
375         free( psz_access );
376         free( psz_mux );
377         return VLC_EGENERIC;
378     }
379     msg_Dbg( p_stream, "mux opened" );
380
381     /* *** Create the SAP Session structure *** */
382     if( var_GetBool( p_stream, SOUT_CFG_PREFIX"sap" ) )
383     {
384         /* Create the SDP */
385         char *shost = var_GetNonEmptyString (p_access, "src-addr");
386         char *dhost = var_GetNonEmptyString (p_access, "dst-addr");
387         int sport = var_GetInteger (p_access, "src-port");
388         int dport = var_GetInteger (p_access, "dst-port");
389         struct sockaddr_storage src, dst;
390         socklen_t srclen = 0, dstlen = 0;
391
392         struct addrinfo *res;
393         if (vlc_getaddrinfo (VLC_OBJECT (p_stream), dhost, dport, NULL, &res) == 0)
394         {
395             memcpy (&dst, res->ai_addr, dstlen = res->ai_addrlen);
396             vlc_freeaddrinfo (res);
397         }
398
399         if (vlc_getaddrinfo (VLC_OBJECT (p_stream), shost, sport, NULL, &res) == 0)
400         {
401             memcpy (&src, res->ai_addr, srclen = res->ai_addrlen);
402             vlc_freeaddrinfo (res);
403         }
404
405         char *head = vlc_sdp_Start (VLC_OBJECT (p_stream), SOUT_CFG_PREFIX,
406                                     (struct sockaddr *)&src, srclen,
407                                     (struct sockaddr *)&dst, dstlen);
408         free (shost);
409
410         char *psz_sdp = NULL;
411         if (head != NULL)
412         {
413             if (asprintf (&psz_sdp, "%s"
414                           "m=video %d udp mpeg\r\n", head, dport) == -1)
415                 psz_sdp = NULL;
416             free (head);
417         }
418
419         /* Register the SDP with the SAP thread */
420         if (psz_sdp != NULL)
421         {
422             announce_method_t *p_method = sout_SAPMethod ();
423             msg_Dbg (p_stream, "Generated SDP:\n%s", psz_sdp);
424
425             p_sys->p_session =
426                 sout_AnnounceRegisterSDP (p_sout, psz_sdp, dhost, p_method);
427             sout_MethodRelease (p_method);
428         }
429         free (dhost);
430     }
431
432     p_stream->pf_add    = Add;
433     p_stream->pf_del    = Del;
434     p_stream->pf_send   = Send;
435
436     p_sys->p_mux = p_mux;
437
438     free( psz_access );
439     free( psz_mux );
440     free( psz_url );
441
442     return VLC_SUCCESS;
443 }
444
445 /*****************************************************************************
446  * Close:
447  *****************************************************************************/
448 static void Close( vlc_object_t * p_this )
449 {
450     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
451     sout_stream_sys_t *p_sys    = p_stream->p_sys;
452     sout_access_out_t *p_access = p_sys->p_mux->p_access;
453
454     if( p_sys->p_session != NULL )
455         sout_AnnounceUnRegister( p_stream->p_sout, p_sys->p_session );
456
457     sout_MuxDelete( p_sys->p_mux );
458     sout_AccessOutDelete( p_access );
459
460     free( p_sys );
461 }
462
463 struct sout_stream_id_t
464 {
465     sout_input_t *p_input;
466 };
467
468
469 static sout_stream_id_t * Add( sout_stream_t *p_stream, es_format_t *p_fmt )
470 {
471     sout_stream_sys_t *p_sys = p_stream->p_sys;
472     sout_stream_id_t  *id;
473
474     id = malloc( sizeof( sout_stream_id_t ) );
475     if( ( id->p_input = sout_MuxAddStream( p_sys->p_mux, p_fmt ) ) == NULL )
476     {
477         free( id );
478
479         return NULL;
480     }
481
482     return id;
483 }
484
485 static int Del( sout_stream_t *p_stream, sout_stream_id_t *id )
486 {
487     sout_stream_sys_t *p_sys = p_stream->p_sys;
488
489     sout_MuxDeleteStream( p_sys->p_mux, id->p_input );
490
491     free( id );
492
493     return VLC_SUCCESS;
494 }
495
496 static int Send( sout_stream_t *p_stream, sout_stream_id_t *id,
497                  block_t *p_buffer )
498 {
499     sout_stream_sys_t *p_sys = p_stream->p_sys;
500
501     sout_MuxSendBuffer( p_sys->p_mux, id->p_input, p_buffer );
502
503     return VLC_SUCCESS;
504 }