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