1e54d1bd7b7408c4ecf5e8bc76a6890cc6fba802
[vlc.git] / modules / stream_out / standard.c
1 /*****************************************************************************
2  * standard.c: standard stream output module
3  *****************************************************************************
4  * Copyright (C) 2003-2011 VLC authors and VideoLAN
5  *
6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 /*****************************************************************************
24  * Preamble
25  *****************************************************************************/
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #include <vlc_common.h>
31 #include <vlc_plugin.h>
32 #include <vlc_sout.h>
33
34 #include <vlc_network.h>
35 #include <vlc_url.h>
36 #include <vlc_memstream.h>
37 #include "sdp_helper.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 SAP_TEXT N_("SAP announcing")
68 #define SAP_LONGTEXT N_("Announce this session with SAP.")
69
70 static int      Open    ( vlc_object_t * );
71 static void     Close   ( vlc_object_t * );
72
73 #define SOUT_CFG_PREFIX "sout-standard-"
74
75 #ifdef ENABLE_SRT
76 #define SRT_SHORTCUT "srt"
77 #else
78 #define SRT_SHORTCUT
79 #endif
80
81 vlc_module_begin ()
82     set_shortname( N_("Standard"))
83     set_description( N_("Standard stream output") )
84     set_capability( "sout output", 50 )
85     add_shortcut( "standard", "std", "file", "http", "udp", SRT_SHORTCUT )
86     set_category( CAT_SOUT )
87     set_subcategory( SUBCAT_SOUT_STREAM )
88
89     add_string( SOUT_CFG_PREFIX "access", "", ACCESS_TEXT, ACCESS_LONGTEXT, false )
90     add_string( SOUT_CFG_PREFIX "mux", "", MUX_TEXT, MUX_LONGTEXT, false )
91     add_string( SOUT_CFG_PREFIX "dst", "", DEST_TEXT, DEST_LONGTEXT, false )
92     add_string( SOUT_CFG_PREFIX "bind", "", BIND_TEXT, BIND_LONGTEXT, false )
93     add_string( SOUT_CFG_PREFIX "path", "", PATH_TEXT, PATH_LONGTEXT, false )
94     add_bool(   SOUT_CFG_PREFIX "sap", false, SAP_TEXT, SAP_LONGTEXT, true )
95     add_string( SOUT_CFG_PREFIX "name", "", NAME_TEXT, NAME_LONGTEXT, true )
96     add_obsolete_string( SOUT_CFG_PREFIX "group" ) /* since 2.1.0 */
97     add_string( SOUT_CFG_PREFIX "description", "", DESC_TEXT, DESC_LONGTEXT, true )
98     add_obsolete_string( SOUT_CFG_PREFIX "url" ) /* since 4.0.0 */
99     add_obsolete_string( SOUT_CFG_PREFIX "email" ) /* since 4.0.0 */
100     add_obsolete_string( SOUT_CFG_PREFIX "phone" ) /* since 3.0.0 */
101
102     set_callbacks( Open, Close )
103 vlc_module_end ()
104
105
106 /*****************************************************************************
107  * Exported prototypes
108  *****************************************************************************/
109 static const char *const ppsz_sout_options[] = {
110     "access", "mux", "url", "dst",
111     "sap", "name", "description",
112     "bind", "path", NULL
113 };
114
115 #define DEFAULT_PORT 1234
116
117 typedef struct
118 {
119     sout_mux_t           *p_mux;
120     session_descriptor_t *p_session;
121     bool                  synchronous;
122 } sout_stream_sys_t;
123
124 static void *Add( sout_stream_t *p_stream, const es_format_t *p_fmt )
125 {
126     sout_stream_sys_t *p_sys = p_stream->p_sys;
127     return sout_MuxAddStream( p_sys->p_mux, p_fmt );
128 }
129
130 static void Del( sout_stream_t *p_stream, void *id )
131 {
132     sout_stream_sys_t *p_sys = p_stream->p_sys;
133     sout_MuxDeleteStream( p_sys->p_mux, (sout_input_t*)id );
134 }
135
136 static int Send( sout_stream_t *p_stream, void *id, block_t *p_buffer )
137 {
138     sout_stream_sys_t *p_sys = p_stream->p_sys;
139     return sout_MuxSendBuffer( p_sys->p_mux, (sout_input_t*)id, p_buffer );
140 }
141
142 static void Flush( sout_stream_t *p_stream, void *id )
143 {
144     sout_stream_sys_t *p_sys = p_stream->p_sys;
145     sout_MuxFlush( 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 static int Control(sout_stream_t *stream, int query, va_list args)
320 {
321     sout_stream_sys_t *sys = stream->p_sys;
322
323     switch (query)
324     {
325         case SOUT_STREAM_IS_SYNCHRONOUS:
326             *va_arg(args, bool *) = sys->synchronous;
327             break;
328
329         default:
330             return VLC_EGENERIC;
331     }
332
333     return VLC_SUCCESS;
334 }
335
336 static const struct sout_stream_operations ops = {
337     Add, Del, Send, Control, Flush,
338 };
339
340 /*****************************************************************************
341  * Open:
342  *****************************************************************************/
343 static int Open( vlc_object_t *p_this )
344 {
345     sout_stream_t       *p_stream = (sout_stream_t*)p_this;
346     sout_stream_sys_t   *p_sys;
347     char *psz_mux, *psz_access, *psz_url;
348     sout_access_out_t   *p_access;
349     int                 ret = VLC_EGENERIC;
350
351     config_ChainParse( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options,
352                    p_stream->p_cfg );
353
354     psz_mux = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "mux" );
355
356     psz_access = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "access" );
357     if( !psz_access )
358         psz_access = strdup(p_stream->psz_name);
359
360     psz_url = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "dst" );
361     if (!psz_url)
362     {
363         char *psz_bind = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "bind" );
364         if( psz_bind )
365         {
366             char *psz_path = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "path" );
367             if( psz_path )
368             {
369                 if( asprintf( &psz_url, "%s/%s", psz_bind, psz_path ) == -1 )
370                     psz_url = NULL;
371                 free(psz_bind);
372                 free( psz_path );
373             }
374             else
375                 psz_url = psz_bind;
376         }
377     }
378
379     p_sys = p_stream->p_sys = malloc( sizeof( sout_stream_sys_t) );
380     if( !p_sys )
381     {
382         ret = VLC_ENOMEM;
383         goto end;
384     }
385     p_sys->p_session = NULL;
386
387     if( fixAccessMux( p_stream, &psz_mux, &psz_access, psz_url ) )
388         goto end;
389
390     checkAccessMux( p_stream, psz_access, psz_mux );
391
392     p_access = sout_AccessOutNew( p_stream, psz_access, psz_url );
393     if( p_access == NULL )
394     {
395         msg_Err( p_stream, "no suitable sout access module for `%s/%s://%s'",
396                  psz_access, psz_mux, psz_url );
397         goto end;
398     }
399
400     p_sys->synchronous = !sout_AccessOutCanControlPace(p_access);
401     p_sys->p_mux = sout_MuxNew( p_access, psz_mux );
402     if( !p_sys->p_mux )
403     {
404         const char *psz_mux_guess = getMuxFromAlias( psz_mux );
405         if( psz_mux_guess && strcmp( psz_mux_guess, psz_mux ) )
406         {
407             msg_Dbg( p_stream, "Couldn't open mux `%s', trying `%s' instead",
408                 psz_mux, psz_mux_guess );
409             p_sys->p_mux = sout_MuxNew( p_access, psz_mux_guess );
410         }
411
412         if( !p_sys->p_mux )
413         {
414             msg_Err( p_stream, "no suitable sout mux module for `%s/%s://%s'",
415                 psz_access, psz_mux, psz_url );
416
417             sout_AccessOutDelete( p_access );
418             goto end;
419         }
420     }
421
422     if( var_GetBool( p_stream, SOUT_CFG_PREFIX"sap" ) )
423         create_SDP( p_stream, p_access );
424
425     p_stream->ops = &ops;
426     ret = VLC_SUCCESS;
427     msg_Dbg( p_this, "using `%s/%s://%s'", psz_access, psz_mux, psz_url );
428
429 end:
430     if( ret != VLC_SUCCESS )
431         free( p_sys );
432     free( psz_access );
433     free( psz_mux );
434     free( psz_url );
435
436     return ret;
437 }
438
439 /*****************************************************************************
440  * Close:
441  *****************************************************************************/
442 static void Close( vlc_object_t * p_this )
443 {
444     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
445     sout_stream_sys_t *p_sys    = p_stream->p_sys;
446     sout_access_out_t *p_access = p_sys->p_mux->p_access;
447
448     if( p_sys->p_session != NULL )
449         sout_AnnounceUnRegister( p_stream, p_sys->p_session );
450
451     sout_MuxDelete( p_sys->p_mux );
452     sout_AccessOutDelete( p_access );
453
454     free( p_sys );
455 }