srt: fix build issue with recent SRT library
[vlc.git] / modules / access_output / rist.c
1 /*****************************************************************************
2  *  * rist.c: RIST (Reliable Internet Stream Transport) output module
3  *****************************************************************************
4  * Copyright (C) 2018, DVEO, the Broadcast Division of Computer Modules, Inc.
5  * Copyright (C) 2018, SipRadius LLC
6  *
7  * Authors: Sergio Ammirata <sergio@ammirata.net>
8  *          Daniele Lacamera <root@danielinux.net>
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #ifdef HAVE_CONFIG_H
26 # include "config.h"
27 #endif
28
29 #include <vlc_common.h>
30 #include <vlc_interrupt.h>
31 #include <vlc_fs.h>
32 #include <vlc_plugin.h>
33 #include <vlc_sout.h>
34 #include <vlc_block.h>
35 #include <vlc_network.h>
36 #include <vlc_queue.h>
37 #include <vlc_threads.h>
38 #include <vlc_rand.h>
39 #ifdef HAVE_POLL_H
40 #include <poll.h>
41 #endif
42 #include <sys/time.h>
43 #ifdef HAVE_SYS_SOCKET_H
44 #include <sys/socket.h>
45 #endif
46 #include <bitstream/ietf/rtcp_rr.h>
47 #include <bitstream/ietf/rtcp_sr.h>
48 #include <bitstream/ietf/rtcp_fb.h>
49 #include <bitstream/ietf/rtcp_sdes.h>
50 #include <bitstream/ietf/rtp.h>
51
52 #include "../access/rist.h"
53
54 /* Uncomment the following to introduce induced packet loss for TESTING purposes only */
55 /*#define TEST_PACKET_LOSS*/
56
57 /* The default target packet size */
58 #define RIST_TARGET_PACKET_SIZE 1328
59 /* The default caching delay for output data */
60 #define DEFAULT_CACHING_DELAY 50
61 /* The default buffer size in ms */
62 #define DEFAULT_BUFFER_SIZE 0
63 /* Calculate and print stats once per second */
64 #define STATS_INTERVAL 1000 /*ms*/
65
66 #define MPEG_II_TRANSPORT_STREAM (0x21)
67 #define RIST_DEFAULT_PORT 1968
68
69 #define SOUT_CFG_PREFIX "sout-rist-"
70
71 static const char *const ppsz_sout_options[] = {
72     "packet-size",
73     "caching",
74     "buffer-size",
75     "ssrc",
76     "stream-name",
77     NULL
78 };
79
80 typedef struct
81 {
82     struct       rist_flow *flow;
83     uint16_t     rtp_counter;
84     char         receiver_name[MAX_CNAME];
85     uint64_t     last_rtcp_tx;
86     vlc_thread_t ristthread;
87     vlc_thread_t senderthread;
88     size_t       i_packet_size;
89     bool         b_mtu_warning;
90     bool         b_ismulticast;
91     vlc_mutex_t  lock;
92     vlc_mutex_t  fd_lock;
93     block_t      *p_pktbuffer;
94     uint64_t     i_ticks_caching;
95     uint32_t     ssrc;
96     bool         dead;
97     vlc_queue_t  queue;
98     /* stats variables */
99     uint64_t     i_last_stat;
100     uint32_t     i_retransmit_packets;
101     uint32_t     i_total_packets;
102 } sout_access_out_sys_t;
103
104 static struct rist_flow *rist_init_tx()
105 {
106     struct rist_flow *flow = calloc(1, sizeof(struct rist_flow));
107     if (!flow)
108         return NULL;
109
110     flow->reset = 1;
111     flow->buffer = calloc(RIST_QUEUE_SIZE, sizeof(struct rtp_pkt));
112     if ( unlikely( flow->buffer == NULL ) )
113     {
114         free(flow);
115         return NULL;
116     }
117     flow->fd_out = -1;
118     flow->fd_rtcp = -1;
119     flow->fd_rtcp_m = -1;
120
121     return flow;
122 }
123
124 static struct rist_flow *rist_udp_transmitter(sout_access_out_t *p_access, char *psz_dst_server, 
125     int i_dst_port, bool b_ismulticast)
126 {
127     struct rist_flow *flow;
128     flow = rist_init_tx();
129     if (!flow)
130         return NULL;
131
132     flow->fd_out = net_ConnectDgram(p_access, psz_dst_server, i_dst_port, -1, IPPROTO_UDP );
133     if (flow->fd_out < 0)
134     {
135         msg_Err( p_access, "cannot open output socket" );
136         goto fail;
137     }
138
139     if (b_ismulticast) {
140         flow->fd_rtcp_m = net_OpenDgram(p_access, psz_dst_server, i_dst_port + 1,
141             NULL, 0, IPPROTO_UDP);
142         if (flow->fd_rtcp_m < 0)
143         {
144             msg_Err( p_access, "cannot open multicast nack socket" );
145             goto fail;
146         }
147     }
148
149     flow->fd_rtcp = net_ConnectDgram(p_access, psz_dst_server, i_dst_port + 1, -1, IPPROTO_UDP );
150     if (flow->fd_rtcp < 0)
151     {
152         msg_Err( p_access, "cannot open nack socket" );
153         goto fail;
154     }
155
156     char *psz_streamname = NULL;
157     psz_streamname = var_InheritString( p_access, SOUT_CFG_PREFIX "stream-name" );
158     if ( psz_streamname != NULL && psz_streamname[0] != '\0')
159     {
160         int name_length = snprintf(flow->cname, MAX_CNAME, "%s", psz_streamname);
161         if (name_length >= MAX_CNAME)
162             flow->cname[MAX_CNAME-1] = 0;
163         free( psz_streamname );
164     }
165     else
166         populate_cname(flow->fd_rtcp, flow->cname);
167
168     msg_Info(p_access, "our cname is %s", flow->cname);
169
170     return flow;
171
172 fail:
173     if (flow->fd_out != -1)
174         vlc_close(flow->fd_out);
175     if (flow->fd_rtcp != -1)
176         vlc_close(flow->fd_rtcp);
177     if (flow->fd_rtcp_m != -1)
178         vlc_close(flow->fd_rtcp_m);
179     free(flow->buffer);
180     free(flow);
181     return NULL;
182 }
183
184 static void rist_retransmit(sout_access_out_t *p_access, struct rist_flow *flow, uint16_t seq)
185 {
186     sout_access_out_sys_t *p_sys = p_access->p_sys;
187     struct rtp_pkt *pkt = &(flow->buffer[seq]);
188     if (pkt->buffer == NULL)
189     {
190         msg_Err(p_access, "RIST recovery: missing requested packet %d, buffer not yet full", seq);
191         return;
192     }
193
194     /* Mark SSID for retransmission (change the last bit of the ssrc to 1) */
195     pkt->buffer->p_buffer[11] |= (1 << 0);
196 #ifdef TEST_PACKET_LOSS
197 #   warning COMPILED WITH SELF INFLICTED PACKET LOSS
198         if ((flow->packets_count % 14) == 0) {
199             return;
200         }
201 #endif
202     uint32_t rtp_age = flow->hi_timestamp - pkt->rtp_ts;
203     uint64_t age = ts_get_from_rtp(rtp_age)/1000;
204     if (flow->rtp_latency > 0 && rtp_age > flow->rtp_latency)
205     {
206         msg_Err(p_access, "   Not Sending Nack #%d, too old (age %"PRId64" ms), current seq is:" \
207             " [%d]. Perhaps you should increase the buffer-size ...", seq, age, flow->wi);
208     }
209     else
210     {
211         msg_Dbg(p_access, "   Sending Nack #%d (age %"PRId64" ms), current seq is: [%d]", 
212             seq, age, flow->wi);
213         p_sys->i_retransmit_packets++;
214         vlc_mutex_lock( &p_sys->fd_lock );
215         if (rist_Write(flow->fd_out, pkt->buffer->p_buffer, pkt->buffer->i_buffer) 
216                 != (ssize_t)pkt->buffer->i_buffer) {
217             msg_Err(p_access, "Error sending retransmitted packet after 2 tries ...");
218         }
219
220         vlc_mutex_unlock( &p_sys->fd_lock );
221     }
222 }
223
224 static void process_nack(sout_access_out_t *p_access, uint8_t  ptype, uint16_t nrecords, 
225     struct rist_flow *flow, uint8_t *pkt)
226 {
227     sout_access_out_sys_t *p_sys = p_access->p_sys;
228     int i,j;
229
230     /*msg_Info(p_access, "   Nack (BbRR), %d record(s), Window: [%d:%d-->%d]", nrecords, 
231         flow->ri, flow->wi, flow->wi-flow->ri);*/
232
233     if (ptype == RTCP_PT_RTPFR)
234     {
235         uint8_t pi_ssrc[4];
236         rtcp_fb_get_ssrc_media_src(pkt, pi_ssrc);
237         if (memcmp(pi_ssrc, "RIST", 4) != 0)
238         {
239             msg_Info(p_access, "   Ignoring Nack with name %s", pi_ssrc);
240             return; /* Ignore app-type not RIST */
241         }
242
243         for (i = 0; i < (nrecords-2); i++) {
244             uint16_t missing;
245             uint16_t additional;
246             uint8_t *rtp_nack_record = (pkt + 12 + i * 4);
247             missing = rtcp_fb_nack_get_range_start(rtp_nack_record);
248             additional = rtcp_fb_nack_get_range_extra(rtp_nack_record);
249             /*msg_Info(p_access, "   Nack (Range), %d, current seq is: [%d]", missing, flow->wi);*/
250             vlc_mutex_lock( &p_sys->lock );
251             rist_retransmit(p_access, flow, missing);
252             for (j = 0; j < additional; j++) {
253                 rist_retransmit(p_access, flow, missing + j + 1);
254             }
255             vlc_mutex_unlock( &p_sys->lock );
256         }
257     }
258     else if (ptype == RTCP_PT_RTPFB)
259     {
260         for (i = 0; i < (nrecords-2); i++) {
261             uint16_t missing;
262             uint16_t bitmask;
263             uint8_t *rtp_nack_record = (pkt + 12 + i * 4);
264             missing = rtcp_fb_nack_get_packet_id(rtp_nack_record);
265             bitmask = rtcp_fb_nack_get_bitmask_lost(rtp_nack_record);
266             /*msg_Info(p_access, "  Nack (Bitmask), %d, current seq is: [%d]", missing, flow->wi);*/
267             vlc_mutex_lock( &p_sys->lock );
268             rist_retransmit(p_access, flow, missing);
269             for (j = 0; j < 16; j++) {
270                 if ((bitmask & (1 << j)) == (1 << j)) {
271                     rist_retransmit(p_access, flow, missing + j + 1);
272                 }
273             }
274             vlc_mutex_unlock( &p_sys->lock );
275         }
276     }
277     else
278     {
279         msg_Err(p_access, "   !!! Wrong feedback. Ptype is %02x!=%02x, FMT: %02x", ptype, 
280             RTCP_PT_RTPFR, rtcp_fb_get_fmt(pkt));
281     }
282 }
283
284 static void rist_rtcp_recv(sout_access_out_t *p_access, struct rist_flow *flow, uint8_t *pkt_raw, 
285     size_t len)
286 {
287     sout_access_out_sys_t *p_sys = p_access->p_sys;
288     uint8_t *pkt = pkt_raw;
289     uint8_t  ptype;
290     uint16_t processed_bytes = 0;
291     uint16_t records;
292
293     while (processed_bytes < len) {
294         pkt = pkt_raw + processed_bytes;
295         /* safety checks */
296         uint16_t bytes_left = len - processed_bytes + 1;
297         if ( bytes_left < 4 )
298         {
299             /* we must have at least 4 bytes */
300             msg_Err(p_access, "Rist rtcp packet must have at least 4 bytes, we have %d", 
301                 bytes_left);
302             return; 
303         }
304         else if (!rtp_check_hdr(pkt))
305         {
306             /* check for a valid rtp header */
307             msg_Err(p_access, "Malformed feedback packet starting with %02x, ignoring.", pkt[0]);
308             return;
309         }
310
311         ptype =  rtcp_get_pt(pkt);
312         records = rtcp_get_length(pkt);
313         uint16_t bytes = (uint16_t)(4 * (1 + records));
314         if (bytes > bytes_left)
315         {
316             /* check for a sane number of bytes */
317             msg_Err(p_access, "Malformed feedback packet, wrong len %d, expecting %u bytes in the" \
318                 " packet, got a buffer of %u bytes. ptype = %d", rtcp_get_length(pkt), bytes, 
319                 bytes_left, ptype);
320             return;
321         }
322
323         switch(ptype) {
324             case RTCP_PT_RTPFR:
325             case RTCP_PT_RTPFB:
326                 process_nack(p_access, ptype, records, flow, pkt);
327                 break;
328
329             case RTCP_PT_RR:
330                 /*
331                 if (p_sys->b_ismulticast == false)
332                     process_rr(f, pkt, len);
333                 */
334                 break;
335
336             case RTCP_PT_SDES:
337                 {
338                     if (p_sys->b_ismulticast == false)
339                     {
340                         int8_t name_length = rtcp_sdes_get_name_length(pkt);
341                         if (name_length > bytes_left)
342                         {
343                             /* check for a sane number of bytes */
344                             msg_Err(p_access, "Malformed SDES packet, wrong cname len %u, got a " \
345                                 "buffer of %u bytes.", name_length, bytes_left);
346                             return;
347                         }
348                         if (memcmp(pkt + RTCP_SDES_SIZE, p_sys->receiver_name, name_length) != 0)
349                         {
350                             memcpy(p_sys->receiver_name, pkt + RTCP_SDES_SIZE, name_length);
351                             msg_Info(p_access, "Receiver name: %s", p_sys->receiver_name);
352                         }
353                     }
354                 }
355                 break;
356
357             case RTCP_PT_SR:
358                 break;
359
360             default:
361                 msg_Err(p_access, "   Unrecognized RTCP packet with PTYPE=%02x!!", ptype);
362         }
363         processed_bytes += bytes;
364     }
365 }
366
367 static void rist_rtcp_send(sout_access_out_t *p_access)
368 {
369     sout_access_out_sys_t *p_sys = p_access->p_sys;
370     struct rist_flow *flow = p_sys->flow;
371     uint8_t rtcp_buf[RTCP_SR_SIZE + RTCP_SDES_SIZE + MAX_CNAME] = { };
372     struct timeval tv;
373     int r;
374     uint64_t fractions;
375     uint16_t namelen = strlen(flow->cname) + 1;
376     gettimeofday(&tv, NULL);
377
378     /* Populate SR for sender report */
379     uint8_t *p_sr = rtcp_buf;
380     rtp_set_hdr(p_sr);
381     rtcp_sr_set_pt(p_sr);
382     rtcp_sr_set_length(p_sr, 6);
383     rtcp_fb_set_int_ssrc_pkt_sender(p_sr, p_sys->ssrc);
384     rtcp_sr_set_ntp_time_msw(p_sr, tv.tv_sec + SEVENTY_YEARS_OFFSET);
385     fractions = (uint64_t)tv.tv_usec;
386     fractions <<= 32ULL;
387     fractions /= 1000000ULL;
388     rtcp_sr_set_ntp_time_lsw(p_sr, (uint32_t)fractions);
389     rtcp_sr_set_rtp_time(p_sr, rtp_get_ts(vlc_tick_now()));
390     vlc_mutex_lock( &p_sys->lock );
391     rtcp_sr_set_packet_count(p_sr, flow->packets_count);
392     rtcp_sr_set_octet_count(p_sr, flow->bytes_count);
393     vlc_mutex_unlock( &p_sys->lock );
394
395     /* Populate SDES for sender description */
396     uint8_t *p_sdes = (rtcp_buf + RTCP_SR_SIZE);
397     /* we need to make sure it is a multiple of 4, pad if necessary */
398     if ((namelen - 2) & 0x3)
399         namelen = ((((namelen - 2) >> 2) + 1) << 2) + 2;
400     rtp_set_hdr(p_sdes);
401     rtp_set_cc(p_sdes, 1); /* Actually it is source count in this case */
402     rtcp_sdes_set_pt(p_sdes);
403     rtcp_set_length(p_sdes, (namelen >> 2) + 2);
404     rtcp_sdes_set_cname(p_sdes, 1);
405     rtcp_sdes_set_name_length(p_sdes, strlen(flow->cname));
406     p_sdes += RTCP_SDES_SIZE;
407     strlcpy((char *)p_sdes, flow->cname, namelen);
408
409     /* Send the rtcp message */
410     r = send(flow->fd_rtcp, rtcp_buf, RTCP_SR_SIZE + RTCP_SDES_SIZE + namelen, 0);
411     (void)r;
412 }
413
414 static void *rist_thread(void *data)
415 {
416     sout_access_out_t *p_access = data;
417     sout_access_out_sys_t *p_sys = p_access->p_sys;
418     uint64_t now;
419     uint8_t pkt[RTP_PKT_SIZE];
420     struct pollfd pfd[2];
421     int ret;
422     ssize_t r;
423
424     int poll_sockets = 1;
425     pfd[0].fd = p_sys->flow->fd_rtcp;
426     pfd[0].events = POLLIN;
427     if (p_sys->b_ismulticast)
428     {
429         pfd[1].fd = p_sys->flow->fd_rtcp_m;
430         pfd[1].events = POLLIN;
431         poll_sockets++;
432     }
433
434     for (;;) {
435         ret = poll(pfd, poll_sockets, RTCP_INTERVAL >> 1);
436         int canc = vlc_savecancel();
437         if (ret > 0)
438         {
439             if (pfd[0].revents & POLLIN)
440             {
441                 r = rist_Read(p_sys->flow->fd_rtcp, pkt, RTP_PKT_SIZE);
442                 if (r == RTP_PKT_SIZE) {
443                     msg_Err(p_access, "Rist RTCP messsage is too big (%zd bytes) and was probably " \
444                         "cut, please keep it under %d bytes", r, RTP_PKT_SIZE);
445                 }
446                 if (unlikely(r == -1)) {
447                     msg_Err(p_access, "socket %d error: %s\n", p_sys->flow->fd_rtcp, 
448                         gai_strerror(errno));
449                 }
450                 else {
451                     rist_rtcp_recv(p_access, p_sys->flow, pkt, r);
452                 }
453             }
454             if (p_sys->b_ismulticast && (pfd[1].revents & POLLIN))
455             {
456                 r = rist_Read(p_sys->flow->fd_rtcp_m, pkt, RTP_PKT_SIZE);
457                 if (r == RTP_PKT_SIZE) {
458                     msg_Err(p_access, "Rist RTCP messsage is too big (%zd bytes) and was " \
459                         "probably cut, please keep it under %d bytes", r, RTP_PKT_SIZE);
460                 }
461                 if (unlikely(r == -1)) {
462                     msg_Err(p_access, "mcast socket %d error: %s\n", p_sys->flow->fd_rtcp_m,
463                         gai_strerror(errno));
464                 }
465                 else {
466                     rist_rtcp_recv(p_access, p_sys->flow, pkt, r);
467                 }
468             }
469         }
470
471         /* And, in any case: */
472         now = vlc_tick_now();
473         if ((now - p_sys->last_rtcp_tx) > VLC_TICK_FROM_MS(RTCP_INTERVAL))
474         {
475             rist_rtcp_send(p_access);
476             p_sys->last_rtcp_tx = now;
477         }
478         vlc_restorecancel (canc);
479     }
480
481     return NULL;
482 }
483
484 /****************************************************************************
485  * RTP send
486  ****************************************************************************/
487 static void* ThreadSend( void *data )
488 {
489     sout_access_out_t *p_access = data;
490     sout_access_out_sys_t *p_sys = p_access->p_sys;
491     vlc_tick_t i_caching = p_sys->i_ticks_caching;
492     struct rist_flow *flow = p_sys->flow;
493     block_t *out;
494
495     while ((out = vlc_queue_DequeueKillable(&p_sys->queue,
496                                             &p_sys->dead)) != NULL)
497     {
498         ssize_t len = 0;
499         uint16_t seq = 0;
500         uint32_t pkt_ts = 0;
501
502         vlc_tick_wait (out->i_dts + i_caching);
503
504         len = out->i_buffer;
505
506         seq = rtp_get_seqnum(out->p_buffer);
507         pkt_ts = rtp_get_timestamp(out->p_buffer);
508
509         vlc_mutex_lock( &p_sys->fd_lock );
510 #ifdef TEST_PACKET_LOSS
511 #   warning COMPILED WITH SELF INFLICTED PACKET LOSS
512         if ((seq % 14) == 0) {
513             /*msg_Err(p_access, "Dropped packet with seq number %d ...", seq);*/
514         }
515         else
516         {
517             if (rist_Write(flow->fd_out, out->p_buffer, len) != len) {
518                 msg_Err(p_access, "Error sending data packet after 2 tries ...");
519             }
520         }
521 #else
522         if (rist_Write(flow->fd_out, out->p_buffer, len) != len) {
523             msg_Err(p_access, "Error sending data packet after 2 tries ...");
524         }
525 #endif
526         vlc_mutex_unlock( &p_sys->fd_lock );
527
528         /* Insert Into Queue */
529         vlc_mutex_lock( &p_sys->lock );
530         /* Always replace the existing one with the new one */
531         struct rtp_pkt *pkt;
532         pkt = &(flow->buffer[seq]);
533         if (pkt->buffer)
534         {
535             block_Release(pkt->buffer);
536             pkt->buffer = NULL;
537         }
538         pkt->rtp_ts = pkt_ts;
539         pkt->buffer = out;
540
541         if (flow->reset == 1)
542         {
543             msg_Info(p_access, "Traffic detected");
544             /* First packet in the queue */
545             flow->reset = 0;
546         }
547         flow->wi = seq;
548         flow->hi_timestamp = pkt_ts;
549         /* Stats for RTCP feedback packets */
550         flow->packets_count++;
551         flow->bytes_count += len;
552         flow->last_out = seq;
553         vlc_mutex_unlock( &p_sys->lock );
554
555         /* We print out the stats once per second */
556         uint64_t now = vlc_tick_now();
557         uint64_t interval = (now - p_sys->i_last_stat);
558         if ( interval > VLC_TICK_FROM_MS(STATS_INTERVAL) )
559         {
560             if (p_sys->i_retransmit_packets > 0)
561             {
562                 float quality = 100;
563                 if (p_sys->i_total_packets > 0)
564                     quality = (float)100 - (float)100*(float)(p_sys->i_retransmit_packets)
565                         /(float)p_sys->i_total_packets;
566                 msg_Info(p_access, "STATS: Total %u, Retransmitted %u, Link Quality %.2f%%", 
567                     p_sys->i_total_packets, p_sys->i_retransmit_packets, quality);
568             }
569             p_sys->i_last_stat = now;
570             p_sys->i_retransmit_packets = 0;
571             p_sys->i_total_packets = 0;
572         }
573         p_sys->i_total_packets++;
574     }
575     return NULL;
576 }
577
578 static void SendtoFIFO( sout_access_out_t *p_access, block_t *buffer )
579 {
580     sout_access_out_sys_t *p_sys = p_access->p_sys;
581     uint16_t seq = p_sys->rtp_counter++;
582
583     /* Set fresh rtp header data */
584     uint8_t *bufhdr = buffer->p_buffer;
585     rtp_set_hdr(bufhdr);
586     rtp_set_type(bufhdr, MPEG_II_TRANSPORT_STREAM);
587     rtp_set_seqnum(bufhdr, seq);
588     rtp_set_int_ssrc(bufhdr, p_sys->ssrc);
589     uint32_t pkt_ts = rtp_get_ts(buffer->i_dts);
590     rtp_set_timestamp(bufhdr, pkt_ts);
591
592     vlc_queue_Enqueue(&p_sys->queue, block_Duplicate(buffer));
593 }
594
595 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
596 {
597     sout_access_out_sys_t *p_sys = p_access->p_sys;
598     int i_len = 0;
599
600     while( p_buffer )
601     {
602         block_t *p_next;
603         int i_block_split = 0;
604
605         if( !p_sys->b_mtu_warning && p_buffer->i_buffer > p_sys->i_packet_size )
606         {
607             msg_Warn( p_access, "Buffer data size (%zu) > configured packet size (%zu), you " \
608                 "should probably increase the configured packet size", p_buffer->i_buffer, 
609                 p_sys->i_packet_size );
610             p_sys->b_mtu_warning = true;
611         }
612
613         /* Temp buffer is already too large, flush */
614         if( p_sys->p_pktbuffer->i_buffer + p_buffer->i_buffer > p_sys->i_packet_size )
615         {
616             SendtoFIFO(p_access, p_sys->p_pktbuffer);
617             p_sys->p_pktbuffer->i_buffer = RTP_HEADER_SIZE;
618         }
619
620         i_len += p_buffer->i_buffer;
621
622         while( p_buffer->i_buffer )
623         {
624
625             size_t i_write = __MIN( p_buffer->i_buffer, p_sys->i_packet_size );
626
627             i_block_split++;
628
629             if( p_sys->p_pktbuffer->i_buffer == RTP_HEADER_SIZE )
630             {
631                 p_sys->p_pktbuffer->i_dts = p_buffer->i_dts;
632             }
633
634             memcpy( p_sys->p_pktbuffer->p_buffer + p_sys->p_pktbuffer->i_buffer,
635                     p_buffer->p_buffer, i_write );
636
637             p_sys->p_pktbuffer->i_buffer += i_write;
638             p_buffer->p_buffer += i_write;
639             p_buffer->i_buffer -= i_write;
640
641             /*  Flush if we reached the target size for the case of block size < target packet size.
642              *  Also flush when we are in block_split > 1 for the case when the block_size is
643              *  larger than the packet-size because we need to continue the inner loop */
644             if( p_sys->p_pktbuffer->i_buffer == p_sys->i_packet_size || i_block_split > 1 )
645             {
646                 SendtoFIFO(p_access, p_sys->p_pktbuffer);
647                 p_sys->p_pktbuffer->i_buffer = RTP_HEADER_SIZE;
648             }
649
650         }
651
652         p_next = p_buffer->p_next;
653         block_Release( p_buffer );
654         p_buffer = p_next;
655
656     }
657
658     if ( i_len <= 0 ) {
659         block_ChainRelease( p_buffer );
660     }
661     return i_len;
662 }
663
664 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
665 {
666     VLC_UNUSED( p_access );
667
668     int i_ret = VLC_SUCCESS;
669
670     switch( i_query )
671     {
672         case ACCESS_OUT_CONTROLS_PACE:
673             *va_arg( args, bool * ) = false;
674             break;
675
676         default:
677             i_ret = VLC_EGENERIC;
678             break;
679     }
680
681     return i_ret;
682 }
683
684 static void Clean( sout_access_out_t *p_access )
685 {
686     sout_access_out_sys_t *p_sys = p_access->p_sys;
687
688     if ( p_sys->flow )
689     {
690         if (p_sys->flow->fd_out >= 0) {
691             net_Close (p_sys->flow->fd_out);
692         }
693         if (p_sys->flow->fd_rtcp >= 0) {
694             net_Close (p_sys->flow->fd_rtcp);
695         }
696         if (p_sys->flow->fd_rtcp_m >= 0) {
697             net_Close (p_sys->flow->fd_rtcp_m);
698         }
699         for (int i=0; i<RIST_QUEUE_SIZE; i++) {
700             struct rtp_pkt *pkt = &(p_sys->flow->buffer[i]);
701             if (pkt->buffer)
702             {
703                 block_Release(pkt->buffer);
704                 pkt->buffer = NULL;
705             }
706         }
707         free(p_sys->flow->buffer);
708         free(p_sys->flow);
709     }
710
711     if (p_sys->p_pktbuffer)
712         block_Release(p_sys->p_pktbuffer);
713 }
714
715 static void Close( vlc_object_t * p_this )
716 {
717     sout_access_out_t     *p_access = (sout_access_out_t*)p_this;
718     sout_access_out_sys_t *p_sys = p_access->p_sys;
719
720     vlc_cancel(p_sys->ristthread);
721     vlc_queue_Kill(&p_sys->queue, &p_sys->dead);
722
723     vlc_join(p_sys->ristthread, NULL);
724     vlc_join(p_sys->senderthread, NULL);
725
726     Clean( p_access );
727 }
728
729 static int Open( vlc_object_t *p_this )
730 {
731     sout_access_out_t       *p_access = (sout_access_out_t*)p_this;
732     sout_access_out_sys_t   *p_sys = NULL;
733
734     if (var_Create ( p_access, "dst-port", VLC_VAR_INTEGER )
735      || var_Create ( p_access, "src-port", VLC_VAR_INTEGER )
736      || var_Create ( p_access, "dst-addr", VLC_VAR_STRING )
737      || var_Create ( p_access, "src-addr", VLC_VAR_STRING ) )
738     {
739         msg_Err( p_access, "Valid network information is required." );
740         return VLC_ENOMEM;
741     }
742
743     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
744
745     p_sys = vlc_obj_calloc( p_this, 1, sizeof( *p_sys ) );
746     if( unlikely( p_sys == NULL ) )
747         return VLC_ENOMEM;
748
749     int i_dst_port = RIST_DEFAULT_PORT;
750     char *psz_dst_addr;
751     char *psz_parser = psz_dst_addr = strdup( p_access->psz_path );
752     if( !psz_dst_addr )
753         return VLC_ENOMEM;
754
755     if ( psz_parser[0] == '[' )
756         psz_parser = strchr( psz_parser, ']' );
757
758     psz_parser = strchr( psz_parser ? psz_parser : psz_dst_addr, ':' );
759     if ( psz_parser != NULL )
760     {
761         *psz_parser++ = '\0';
762         i_dst_port = atoi( psz_parser );
763     }
764
765     vlc_mutex_init( &p_sys->lock );
766     vlc_mutex_init( &p_sys->fd_lock );
767
768     msg_Info(p_access, "Connecting RIST output to %s:%d and %s:%d", psz_dst_addr, i_dst_port, 
769         psz_dst_addr, i_dst_port+1);
770     p_sys->b_ismulticast = is_multicast_address(psz_dst_addr);
771     struct rist_flow *flow = rist_udp_transmitter(p_access, psz_dst_addr, i_dst_port,
772         p_sys->b_ismulticast);
773     free (psz_dst_addr);
774     if (!flow)
775         goto failed;
776
777     p_sys->flow = flow;
778     flow->latency = var_InheritInteger(p_access, SOUT_CFG_PREFIX "buffer-size");
779     flow->rtp_latency = rtp_get_ts(VLC_TICK_FROM_MS(flow->latency));
780     p_sys->ssrc = var_InheritInteger(p_access, SOUT_CFG_PREFIX "ssrc");
781     if (p_sys->ssrc == 0) {
782         vlc_rand_bytes(&p_sys->ssrc, 4);
783     }
784     /* Last bit of ssrc must be 0 for normal data and 1 for retries */
785     p_sys->ssrc &= ~(1 << 0);
786
787     msg_Info(p_access, "SSRC: 0x%08X", p_sys->ssrc);
788     p_sys->i_ticks_caching = VLC_TICK_FROM_MS(var_InheritInteger( p_access, 
789         SOUT_CFG_PREFIX "caching"));
790     p_sys->i_packet_size = var_InheritInteger(p_access, SOUT_CFG_PREFIX "packet-size" );
791     p_sys->dead = false;
792     vlc_queue_Init(&p_sys->queue, offsetof (block_t, p_next));
793     p_sys->p_pktbuffer = block_Alloc( p_sys->i_packet_size );
794     if( unlikely(p_sys->p_pktbuffer == NULL) )
795         goto failed;
796
797     p_sys->p_pktbuffer->i_buffer = RTP_HEADER_SIZE;
798
799     p_access->p_sys = p_sys;
800
801     if( vlc_clone(&p_sys->senderthread, ThreadSend, p_access, VLC_THREAD_PRIORITY_HIGHEST ) )
802     {
803         msg_Err(p_access, "Failed to create sender thread.");
804         goto failed;
805     }
806
807     if (vlc_clone(&p_sys->ristthread, rist_thread, p_access, VLC_THREAD_PRIORITY_INPUT))
808     {
809         msg_Err(p_access, "Failed to create worker thread.");
810         vlc_queue_Kill(&p_sys->queue, &p_sys->dead);
811         vlc_join(p_sys->senderthread, NULL);
812         goto failed;
813     }
814
815     p_access->pf_write = Write;
816     p_access->pf_control = Control;
817
818     return VLC_SUCCESS;
819
820 failed:
821     Clean( p_access );
822     return VLC_EGENERIC;
823 }
824
825 #define CACHING_TEXT N_("RIST data output caching size (ms)")
826 #define CACHING_LONGTEXT N_( \
827     "Having this cache will guarantee that the packets going out are " \
828     "delivered at a spacing determined by the chain timestamps thus ensuring " \
829     "a near jitter free output. Be aware that this setting will also add to " \
830     "the overall latency of the stream." )
831
832 #define BUFFER_TEXT N_("RIST retry-buffer queue size (ms)")
833 #define BUFFER_LONGTEXT N_( \
834     "This must match the buffer size (latency) configured on the server side. If you " \
835     "are not sure, leave the default of 0 which will set it the maximum " \
836     "value and will use about 100MB of RAM" )
837
838 #define SSRC_TEXT N_("SSRC used in RTP output (default is random, i.e. 0)")
839 #define SSRC_LONGTEXT N_( \
840     "Use this setting to specify a known SSRC for the RTP header. This is only useful " \
841     "if your receiver acts on it. When using VLC as receiver, it is not." )
842
843 #define NAME_TEXT N_("Stream name")
844 #define NAME_LONGTEXT N_( \
845     "This Stream name will be sent to the receiver using the rist RTCP channel" )
846
847 /* Module descriptor */
848 vlc_module_begin()
849
850     set_shortname( N_("RIST") )
851     set_description( N_("RIST stream output") )
852     set_category( CAT_SOUT )
853     set_subcategory( SUBCAT_SOUT_ACO )
854
855     add_integer( SOUT_CFG_PREFIX "packet-size", RIST_TARGET_PACKET_SIZE,
856             N_("RIST target packet size (bytes)"), NULL, true )
857     add_integer( SOUT_CFG_PREFIX "caching", DEFAULT_CACHING_DELAY,
858             CACHING_TEXT, CACHING_LONGTEXT, true )
859     add_integer( SOUT_CFG_PREFIX "buffer-size", DEFAULT_BUFFER_SIZE,
860             BUFFER_TEXT, BUFFER_LONGTEXT, true )
861     add_integer( SOUT_CFG_PREFIX "ssrc", 0,
862             SSRC_TEXT, SSRC_LONGTEXT, true )
863     add_string( SOUT_CFG_PREFIX "stream-name", NULL, NAME_TEXT, NAME_LONGTEXT, true )
864
865     set_capability( "sout access", 0 )
866     add_shortcut( "rist", "tr06" )
867
868     set_callbacks( Open, Close )
869
870 vlc_module_end ()