2 This file is part of PulseAudio.
4 Copyright 2006 Lennart Poettering
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2.1 of the License,
9 or (at your option) any later version.
11 PulseAudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
27 #include <sys/socket.h>
28 #include <netinet/in.h>
33 #include <pulse/rtclock.h>
34 #include <pulse/timeval.h>
35 #include <pulse/util.h>
36 #include <pulse/xmalloc.h>
38 #include <pulsecore/core-error.h>
39 #include <pulsecore/module.h>
40 #include <pulsecore/llist.h>
41 #include <pulsecore/source.h>
42 #include <pulsecore/source-output.h>
43 #include <pulsecore/memblockq.h>
44 #include <pulsecore/log.h>
45 #include <pulsecore/core-util.h>
46 #include <pulsecore/modargs.h>
47 #include <pulsecore/namereg.h>
48 #include <pulsecore/sample-util.h>
49 #include <pulsecore/macro.h>
50 #include <pulsecore/socket-util.h>
51 #include <pulsecore/arpa-inet.h>
53 #include "module-rtp-send-symdef.h"
59 PA_MODULE_AUTHOR("Lennart Poettering");
60 PA_MODULE_DESCRIPTION("Read data from source and send it to the network via RTP/SAP/SDP");
61 PA_MODULE_VERSION(PACKAGE_VERSION
);
62 PA_MODULE_LOAD_ONCE(FALSE
);
64 "source=<name of the source> "
65 "format=<sample format> "
66 "channels=<number of channels> "
68 "destination=<destination IP address> "
70 "mtu=<maximum transfer unit> "
71 "loop=<loopback to local host?> "
75 #define DEFAULT_PORT 46000
78 #define DEFAULT_DESTINATION "224.0.0.56"
79 #define MEMBLOCKQ_MAXLENGTH (1024*170)
80 #define DEFAULT_MTU 1280
81 #define SAP_INTERVAL (5*PA_USEC_PER_SEC)
83 static const char* const valid_modargs
[] = {
99 pa_source_output
*source_output
;
100 pa_memblockq
*memblockq
;
102 pa_rtp_context rtp_context
;
103 pa_sap_context sap_context
;
106 pa_time_event
*sap_event
;
109 /* Called from I/O thread context */
110 static int source_output_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
112 pa_assert_se(u
= PA_SOURCE_OUTPUT(o
)->userdata
);
115 case PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY
:
116 *((pa_usec_t
*) data
) = pa_bytes_to_usec(pa_memblockq_get_length(u
->memblockq
), &u
->source_output
->sample_spec
);
118 /* Fall through, the default handler will add in the extra
119 * latency added by the resampler */
123 return pa_source_output_process_msg(o
, code
, data
, offset
, chunk
);
126 /* Called from I/O thread context */
127 static void source_output_push(pa_source_output
*o
, const pa_memchunk
*chunk
) {
129 pa_source_output_assert_ref(o
);
130 pa_assert_se(u
= o
->userdata
);
132 if (pa_memblockq_push(u
->memblockq
, chunk
) < 0) {
133 pa_log_warn("Failed to push chunk into memblockq.");
137 pa_rtp_send(&u
->rtp_context
, u
->mtu
, u
->memblockq
);
140 /* Called from main context */
141 static void source_output_kill(pa_source_output
* o
) {
143 pa_source_output_assert_ref(o
);
144 pa_assert_se(u
= o
->userdata
);
146 pa_module_unload_request(u
->module
, TRUE
);
148 pa_source_output_unlink(u
->source_output
);
149 pa_source_output_unref(u
->source_output
);
150 u
->source_output
= NULL
;
153 static void sap_event_cb(pa_mainloop_api
*m
, pa_time_event
*t
, const struct timeval
*tv
, void *userdata
) {
154 struct userdata
*u
= userdata
;
160 pa_sap_send(&u
->sap_context
, 0);
162 pa_core_rttime_restart(u
->module
->core
, t
, pa_rtclock_now() + SAP_INTERVAL
);
165 int pa__init(pa_module
*m
) {
167 pa_modargs
*ma
= NULL
;
169 uint32_t port
= DEFAULT_PORT
, mtu
;
170 uint32_t ttl
= DEFAULT_TTL
;
172 int fd
= -1, sap_fd
= -1;
176 struct sockaddr_in sa4
, sap_sa4
;
178 struct sockaddr_in6 sa6
, sap_sa6
;
180 struct sockaddr_storage sa_dst
;
181 pa_source_output
*o
= NULL
;
187 pa_bool_t loop
= FALSE
;
188 pa_source_output_new_data data
;
192 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
193 pa_log("Failed to parse module arguments");
197 if (!(s
= pa_namereg_get(m
->core
, pa_modargs_get_value(ma
, "source", NULL
), PA_NAMEREG_SOURCE
))) {
198 pa_log("Source does not exist.");
202 if (pa_modargs_get_value_boolean(ma
, "loop", &loop
) < 0) {
203 pa_log("Failed to parse \"loop\" parameter.");
208 pa_rtp_sample_spec_fixup(&ss
);
210 if (pa_modargs_get_sample_spec(ma
, &ss
) < 0) {
211 pa_log("Failed to parse sample specification");
215 if (!pa_rtp_sample_spec_valid(&ss
)) {
216 pa_log("Specified sample type not compatible with RTP");
220 if (ss
.channels
!= cm
.channels
)
221 pa_channel_map_init_auto(&cm
, ss
.channels
, PA_CHANNEL_MAP_AIFF
);
223 payload
= pa_rtp_payload_from_sample_spec(&ss
);
225 mtu
= (uint32_t) pa_frame_align(DEFAULT_MTU
, &ss
);
227 if (pa_modargs_get_value_u32(ma
, "mtu", &mtu
) < 0 || mtu
< 1 || mtu
% pa_frame_size(&ss
) != 0) {
228 pa_log("Invalid MTU.");
232 port
= DEFAULT_PORT
+ ((uint32_t) (rand() % 512) << 1);
233 if (pa_modargs_get_value_u32(ma
, "port", &port
) < 0 || port
< 1 || port
> 0xFFFF) {
234 pa_log("port= expects a numerical argument between 1 and 65535.");
239 pa_log_warn("Port number not even as suggested in RFC3550!");
241 if (pa_modargs_get_value_u32(ma
, "ttl", &ttl
) < 0 || ttl
< 1 || ttl
> 0xFF) {
242 pa_log("ttl= expects a numerical argument between 1 and 255.");
246 dest
= pa_modargs_get_value(ma
, "destination", DEFAULT_DESTINATION
);
248 if (inet_pton(AF_INET
, dest
, &sa4
.sin_addr
) > 0) {
249 sa4
.sin_family
= af
= AF_INET
;
250 sa4
.sin_port
= htons((uint16_t) port
);
252 sap_sa4
.sin_port
= htons(SAP_PORT
);
254 } else if (inet_pton(AF_INET6
, dest
, &sa6
.sin6_addr
) > 0) {
255 sa6
.sin6_family
= af
= AF_INET6
;
256 sa6
.sin6_port
= htons((uint16_t) port
);
258 sap_sa6
.sin6_port
= htons(SAP_PORT
);
261 pa_log("Invalid destination '%s'", dest
);
265 if ((fd
= pa_socket_cloexec(af
, SOCK_DGRAM
, 0)) < 0) {
266 pa_log("socket() failed: %s", pa_cstrerror(errno
));
270 if (af
== AF_INET
&& connect(fd
, (struct sockaddr
*) &sa4
, sizeof(sa4
)) < 0) {
271 pa_log("connect() failed: %s", pa_cstrerror(errno
));
274 } else if (af
== AF_INET6
&& connect(fd
, (struct sockaddr
*) &sa6
, sizeof(sa6
)) < 0) {
275 pa_log("connect() failed: %s", pa_cstrerror(errno
));
280 if ((sap_fd
= pa_socket_cloexec(af
, SOCK_DGRAM
, 0)) < 0) {
281 pa_log("socket() failed: %s", pa_cstrerror(errno
));
285 if (af
== AF_INET
&& connect(sap_fd
, (struct sockaddr
*) &sap_sa4
, sizeof(sap_sa4
)) < 0) {
286 pa_log("connect() failed: %s", pa_cstrerror(errno
));
289 } else if (af
== AF_INET6
&& connect(sap_fd
, (struct sockaddr
*) &sap_sa6
, sizeof(sap_sa6
)) < 0) {
290 pa_log("connect() failed: %s", pa_cstrerror(errno
));
296 if (setsockopt(fd
, IPPROTO_IP
, IP_MULTICAST_LOOP
, &j
, sizeof(j
)) < 0 ||
297 setsockopt(sap_fd
, IPPROTO_IP
, IP_MULTICAST_LOOP
, &j
, sizeof(j
)) < 0) {
298 pa_log("IP_MULTICAST_LOOP failed: %s", pa_cstrerror(errno
));
302 if (ttl
!= DEFAULT_TTL
) {
303 int _ttl
= (int) ttl
;
305 if (setsockopt(fd
, IPPROTO_IP
, IP_MULTICAST_TTL
, &_ttl
, sizeof(_ttl
)) < 0) {
306 pa_log("IP_MULTICAST_TTL failed: %s", pa_cstrerror(errno
));
310 if (setsockopt(sap_fd
, IPPROTO_IP
, IP_MULTICAST_TTL
, &_ttl
, sizeof(_ttl
)) < 0) {
311 pa_log("IP_MULTICAST_TTL (sap) failed: %s", pa_cstrerror(errno
));
316 /* If the socket queue is full, let's drop packets */
317 pa_make_fd_nonblock(fd
);
318 pa_make_udp_socket_low_delay(fd
);
320 pa_source_output_new_data_init(&data
);
321 pa_proplist_sets(data
.proplist
, PA_PROP_MEDIA_NAME
, "RTP Monitor Stream");
322 pa_proplist_sets(data
.proplist
, "rtp.destination", dest
);
323 pa_proplist_setf(data
.proplist
, "rtp.mtu", "%lu", (unsigned long) mtu
);
324 pa_proplist_setf(data
.proplist
, "rtp.port", "%lu", (unsigned long) port
);
325 pa_proplist_setf(data
.proplist
, "rtp.ttl", "%lu", (unsigned long) ttl
);
326 data
.driver
= __FILE__
;
329 pa_source_output_new_data_set_sample_spec(&data
, &ss
);
330 pa_source_output_new_data_set_channel_map(&data
, &cm
);
331 data
.flags
= PA_SOURCE_OUTPUT_DONT_INHIBIT_AUTO_SUSPEND
;
333 pa_source_output_new(&o
, m
->core
, &data
);
334 pa_source_output_new_data_done(&data
);
337 pa_log("failed to create source output.");
341 o
->parent
.process_msg
= source_output_process_msg
;
342 o
->push
= source_output_push
;
343 o
->kill
= source_output_kill
;
345 pa_log_info("Configured source latency of %llu ms.",
346 (unsigned long long) pa_source_output_set_requested_latency(o
, pa_bytes_to_usec(mtu
, &o
->sample_spec
)) / PA_USEC_PER_MSEC
);
348 m
->userdata
= o
->userdata
= u
= pa_xnew(struct userdata
, 1);
350 u
->source_output
= o
;
352 u
->memblockq
= pa_memblockq_new(
365 pa_assert_se((r
= getsockname(fd
, (struct sockaddr
*) &sa_dst
, &k
)) >= 0);
367 n
= pa_sprintf_malloc("PulseAudio RTP Stream on %s", pa_get_fqdn(hn
, sizeof(hn
)));
371 (void*) &((struct sockaddr_in
*) &sa_dst
)->sin_addr
,
372 (void*) &sa4
.sin_addr
,
373 n
, (uint16_t) port
, payload
, &ss
);
377 (void*) &((struct sockaddr_in6
*) &sa_dst
)->sin6_addr
,
378 (void*) &sa6
.sin6_addr
,
379 n
, (uint16_t) port
, payload
, &ss
);
385 pa_rtp_context_init_send(&u
->rtp_context
, fd
, m
->core
->cookie
, payload
, pa_frame_size(&ss
));
386 pa_sap_context_init_send(&u
->sap_context
, sap_fd
, p
);
388 pa_log_info("RTP stream initialized with mtu %u on %s:%u ttl=%u, SSRC=0x%08x, payload=%u, initial sequence #%u", mtu
, dest
, port
, ttl
, u
->rtp_context
.ssrc
, payload
, u
->rtp_context
.sequence
);
389 pa_log_info("SDP-Data:\n%s\nEOF", p
);
391 pa_sap_send(&u
->sap_context
, 0);
393 u
->sap_event
= pa_core_rttime_new(m
->core
, pa_rtclock_now() + SAP_INTERVAL
, sap_event_cb
, u
);
395 pa_source_output_put(u
->source_output
);
412 pa_source_output_unlink(o
);
413 pa_source_output_unref(o
);
419 void pa__done(pa_module
*m
) {
423 if (!(u
= m
->userdata
))
427 m
->core
->mainloop
->time_free(u
->sap_event
);
429 if (u
->source_output
) {
430 pa_source_output_unlink(u
->source_output
);
431 pa_source_output_unref(u
->source_output
);
434 pa_rtp_context_destroy(&u
->rtp_context
);
436 pa_sap_send(&u
->sap_context
, 1);
437 pa_sap_context_destroy(&u
->sap_context
);
440 pa_memblockq_free(u
->memblockq
);