3 * Copyright (c) 2002 Fabrice Bellard
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "libavutil/mathematics.h"
26 #include "libavutil/random_seed.h"
27 #include "libavutil/opt.h"
31 static const AVOption options[] = {
32 FF_RTP_FLAG_OPTS(RTPMuxContext, flags),
33 { "payload_type", "Specify RTP payload type", offsetof(RTPMuxContext, payload_type), AV_OPT_TYPE_INT, {.i64 = -1 }, -1, 127, AV_OPT_FLAG_ENCODING_PARAM },
34 { "ssrc", "Stream identifier", offsetof(RTPMuxContext, ssrc), AV_OPT_TYPE_INT, { .i64 = 0 }, INT_MIN, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
35 { "cname", "CNAME to include in RTCP SR packets", offsetof(RTPMuxContext, cname), AV_OPT_TYPE_STRING, { .str = NULL }, 0, 0, AV_OPT_FLAG_ENCODING_PARAM },
36 { "seq", "Starting sequence number", offsetof(RTPMuxContext, seq), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 65535, AV_OPT_FLAG_ENCODING_PARAM },
40 static const AVClass rtp_muxer_class = {
41 .class_name = "RTP muxer",
42 .item_name = av_default_item_name,
44 .version = LIBAVUTIL_VERSION_INT,
47 #define RTCP_SR_SIZE 28
49 static int is_supported(enum AVCodecID id)
52 case AV_CODEC_ID_H263:
53 case AV_CODEC_ID_H263P:
54 case AV_CODEC_ID_H264:
55 case AV_CODEC_ID_MPEG1VIDEO:
56 case AV_CODEC_ID_MPEG2VIDEO:
57 case AV_CODEC_ID_MPEG4:
61 case AV_CODEC_ID_PCM_ALAW:
62 case AV_CODEC_ID_PCM_MULAW:
63 case AV_CODEC_ID_PCM_S8:
64 case AV_CODEC_ID_PCM_S16BE:
65 case AV_CODEC_ID_PCM_S16LE:
66 case AV_CODEC_ID_PCM_U16BE:
67 case AV_CODEC_ID_PCM_U16LE:
68 case AV_CODEC_ID_PCM_U8:
69 case AV_CODEC_ID_MPEG2TS:
70 case AV_CODEC_ID_AMR_NB:
71 case AV_CODEC_ID_AMR_WB:
72 case AV_CODEC_ID_VORBIS:
73 case AV_CODEC_ID_THEORA:
75 case AV_CODEC_ID_ADPCM_G722:
76 case AV_CODEC_ID_ADPCM_G726:
77 case AV_CODEC_ID_ILBC:
78 case AV_CODEC_ID_MJPEG:
79 case AV_CODEC_ID_SPEEX:
80 case AV_CODEC_ID_OPUS:
87 static int rtp_write_header(AVFormatContext *s1)
89 RTPMuxContext *s = s1->priv_data;
93 if (s1->nb_streams != 1) {
94 av_log(s1, AV_LOG_ERROR, "Only one stream supported in the RTP muxer\n");
95 return AVERROR(EINVAL);
98 if (!is_supported(st->codec->codec_id)) {
99 av_log(s1, AV_LOG_ERROR, "Unsupported codec %s\n", avcodec_get_name(st->codec->codec_id));
104 if (s->payload_type < 0) {
105 /* Re-validate non-dynamic payload types */
106 if (st->id < RTP_PT_PRIVATE)
107 st->id = ff_rtp_get_payload_type(s1, st->codec, -1);
109 s->payload_type = st->id;
111 /* private option takes priority */
112 st->id = s->payload_type;
115 s->base_timestamp = av_get_random_seed();
116 s->timestamp = s->base_timestamp;
117 s->cur_timestamp = 0;
119 s->ssrc = av_get_random_seed();
121 s->first_rtcp_ntp_time = ff_ntp_time();
122 if (s1->start_time_realtime)
123 /* Round the NTP time to whole milliseconds. */
124 s->first_rtcp_ntp_time = (s1->start_time_realtime / 1000) * 1000 +
126 // Pick a random sequence start number, but in the lower end of the
127 // available range, so that any wraparound doesn't happen immediately.
128 // (Immediate wraparound would be an issue for SRTP.)
130 if (st->codec->flags & CODEC_FLAG_BITEXACT) {
133 s->seq = av_get_random_seed() & 0x0fff;
135 s->seq &= 0xffff; // Use the given parameter, wrapped to the right interval
137 if (s1->packet_size) {
138 if (s1->pb->max_packet_size)
139 s1->packet_size = FFMIN(s1->packet_size,
140 s1->pb->max_packet_size);
142 s1->packet_size = s1->pb->max_packet_size;
143 if (s1->packet_size <= 12) {
144 av_log(s1, AV_LOG_ERROR, "Max packet size %d too low\n", s1->packet_size);
147 s->buf = av_malloc(s1->packet_size);
148 if (s->buf == NULL) {
149 return AVERROR(ENOMEM);
151 s->max_payload_size = s1->packet_size - 12;
153 s->max_frames_per_packet = 0;
154 if (s1->max_delay > 0) {
155 if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
156 int frame_size = av_get_audio_frame_duration(st->codec, 0);
158 frame_size = st->codec->frame_size;
159 if (frame_size == 0) {
160 av_log(s1, AV_LOG_ERROR, "Cannot respect max delay: frame size = 0\n");
162 s->max_frames_per_packet =
163 av_rescale_q_rnd(s1->max_delay,
165 (AVRational){ frame_size, st->codec->sample_rate },
169 if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
170 /* FIXME: We should round down here... */
171 s->max_frames_per_packet = av_rescale_q(s1->max_delay, (AVRational){1, 1000000}, st->codec->time_base);
175 avpriv_set_pts_info(st, 32, 1, 90000);
176 switch(st->codec->codec_id) {
177 case AV_CODEC_ID_MP2:
178 case AV_CODEC_ID_MP3:
179 s->buf_ptr = s->buf + 4;
181 case AV_CODEC_ID_MPEG1VIDEO:
182 case AV_CODEC_ID_MPEG2VIDEO:
184 case AV_CODEC_ID_MPEG2TS:
185 n = s->max_payload_size / TS_PACKET_SIZE;
188 s->max_payload_size = n * TS_PACKET_SIZE;
191 case AV_CODEC_ID_H264:
192 /* check for H.264 MP4 syntax */
193 if (st->codec->extradata_size > 4 && st->codec->extradata[0] == 1) {
194 s->nal_length_size = (st->codec->extradata[4] & 0x03) + 1;
197 case AV_CODEC_ID_VORBIS:
198 case AV_CODEC_ID_THEORA:
199 if (!s->max_frames_per_packet) s->max_frames_per_packet = 15;
200 s->max_frames_per_packet = av_clip(s->max_frames_per_packet, 1, 15);
201 s->max_payload_size -= 6; // ident+frag+tdt/vdt+pkt_num+pkt_length
204 case AV_CODEC_ID_ADPCM_G722:
205 /* Due to a historical error, the clock rate for G722 in RTP is
206 * 8000, even if the sample rate is 16000. See RFC 3551. */
207 avpriv_set_pts_info(st, 32, 1, 8000);
209 case AV_CODEC_ID_OPUS:
210 if (st->codec->channels > 2) {
211 av_log(s1, AV_LOG_ERROR, "Multistream opus not supported in RTP\n");
214 /* The opus RTP RFC says that all opus streams should use 48000 Hz
215 * as clock rate, since all opus sample rates can be expressed in
216 * this clock rate, and sample rate changes on the fly are supported. */
217 avpriv_set_pts_info(st, 32, 1, 48000);
219 case AV_CODEC_ID_ILBC:
220 if (st->codec->block_align != 38 && st->codec->block_align != 50) {
221 av_log(s1, AV_LOG_ERROR, "Incorrect iLBC block size specified\n");
224 if (!s->max_frames_per_packet)
225 s->max_frames_per_packet = 1;
226 s->max_frames_per_packet = FFMIN(s->max_frames_per_packet,
227 s->max_payload_size / st->codec->block_align);
229 case AV_CODEC_ID_AMR_NB:
230 case AV_CODEC_ID_AMR_WB:
231 if (!s->max_frames_per_packet)
232 s->max_frames_per_packet = 12;
233 if (st->codec->codec_id == AV_CODEC_ID_AMR_NB)
237 /* max_header_toc_size + the largest AMR payload must fit */
238 if (1 + s->max_frames_per_packet + n > s->max_payload_size) {
239 av_log(s1, AV_LOG_ERROR, "RTP max payload size too small for AMR\n");
242 if (st->codec->channels != 1) {
243 av_log(s1, AV_LOG_ERROR, "Only mono is supported\n");
246 case AV_CODEC_ID_AAC:
250 if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
251 avpriv_set_pts_info(st, 32, 1, st->codec->sample_rate);
261 return AVERROR(EINVAL);
264 /* send an rtcp sender report packet */
265 static void rtcp_send_sr(AVFormatContext *s1, int64_t ntp_time, int bye)
267 RTPMuxContext *s = s1->priv_data;
270 av_dlog(s1, "RTCP: %02x %"PRIx64" %x\n", s->payload_type, ntp_time, s->timestamp);
272 s->last_rtcp_ntp_time = ntp_time;
273 rtp_ts = av_rescale_q(ntp_time - s->first_rtcp_ntp_time, (AVRational){1, 1000000},
274 s1->streams[0]->time_base) + s->base_timestamp;
275 avio_w8(s1->pb, RTP_VERSION << 6);
276 avio_w8(s1->pb, RTCP_SR);
277 avio_wb16(s1->pb, 6); /* length in words - 1 */
278 avio_wb32(s1->pb, s->ssrc);
279 avio_wb64(s1->pb, NTP_TO_RTP_FORMAT(ntp_time));
280 avio_wb32(s1->pb, rtp_ts);
281 avio_wb32(s1->pb, s->packet_count);
282 avio_wb32(s1->pb, s->octet_count);
285 int len = FFMIN(strlen(s->cname), 255);
286 avio_w8(s1->pb, (RTP_VERSION << 6) + 1);
287 avio_w8(s1->pb, RTCP_SDES);
288 avio_wb16(s1->pb, (7 + len + 3) / 4); /* length in words - 1 */
290 avio_wb32(s1->pb, s->ssrc);
291 avio_w8(s1->pb, 0x01); /* CNAME */
292 avio_w8(s1->pb, len);
293 avio_write(s1->pb, s->cname, len);
294 avio_w8(s1->pb, 0); /* END */
295 for (len = (7 + len) % 4; len % 4; len++)
300 avio_w8(s1->pb, (RTP_VERSION << 6) | 1);
301 avio_w8(s1->pb, RTCP_BYE);
302 avio_wb16(s1->pb, 1); /* length in words - 1 */
303 avio_wb32(s1->pb, s->ssrc);
309 /* send an rtp packet. sequence number is incremented, but the caller
310 must update the timestamp itself */
311 void ff_rtp_send_data(AVFormatContext *s1, const uint8_t *buf1, int len, int m)
313 RTPMuxContext *s = s1->priv_data;
315 av_dlog(s1, "rtp_send_data size=%d\n", len);
317 /* build the RTP header */
318 avio_w8(s1->pb, RTP_VERSION << 6);
319 avio_w8(s1->pb, (s->payload_type & 0x7f) | ((m & 0x01) << 7));
320 avio_wb16(s1->pb, s->seq);
321 avio_wb32(s1->pb, s->timestamp);
322 avio_wb32(s1->pb, s->ssrc);
324 avio_write(s1->pb, buf1, len);
327 s->seq = (s->seq + 1) & 0xffff;
328 s->octet_count += len;
332 /* send an integer number of samples and compute time stamp and fill
333 the rtp send buffer before sending. */
334 static int rtp_send_samples(AVFormatContext *s1,
335 const uint8_t *buf1, int size, int sample_size_bits)
337 RTPMuxContext *s = s1->priv_data;
338 int len, max_packet_size, n;
339 /* Calculate the number of bytes to get samples aligned on a byte border */
340 int aligned_samples_size = sample_size_bits/av_gcd(sample_size_bits, 8);
342 max_packet_size = (s->max_payload_size / aligned_samples_size) * aligned_samples_size;
343 /* Not needed, but who knows. Don't check if samples aren't an even number of bytes. */
344 if ((sample_size_bits % 8) == 0 && ((8 * size) % sample_size_bits) != 0)
345 return AVERROR(EINVAL);
349 len = FFMIN(max_packet_size, size);
352 memcpy(s->buf_ptr, buf1, len);
356 s->timestamp = s->cur_timestamp + n * 8 / sample_size_bits;
357 ff_rtp_send_data(s1, s->buf, s->buf_ptr - s->buf, 0);
358 n += (s->buf_ptr - s->buf);
363 static void rtp_send_mpegaudio(AVFormatContext *s1,
364 const uint8_t *buf1, int size)
366 RTPMuxContext *s = s1->priv_data;
367 int len, count, max_packet_size;
369 max_packet_size = s->max_payload_size;
371 /* test if we must flush because not enough space */
372 len = (s->buf_ptr - s->buf);
373 if ((len + size) > max_packet_size) {
375 ff_rtp_send_data(s1, s->buf, s->buf_ptr - s->buf, 0);
376 s->buf_ptr = s->buf + 4;
379 if (s->buf_ptr == s->buf + 4) {
380 s->timestamp = s->cur_timestamp;
384 if (size > max_packet_size) {
385 /* big packet: fragment */
388 len = max_packet_size - 4;
391 /* build fragmented packet */
394 s->buf[2] = count >> 8;
396 memcpy(s->buf + 4, buf1, len);
397 ff_rtp_send_data(s1, s->buf, len + 4, 0);
403 if (s->buf_ptr == s->buf + 4) {
404 /* no fragmentation possible */
410 memcpy(s->buf_ptr, buf1, size);
415 static void rtp_send_raw(AVFormatContext *s1,
416 const uint8_t *buf1, int size)
418 RTPMuxContext *s = s1->priv_data;
419 int len, max_packet_size;
421 max_packet_size = s->max_payload_size;
424 len = max_packet_size;
428 s->timestamp = s->cur_timestamp;
429 ff_rtp_send_data(s1, buf1, len, (len == size));
436 /* NOTE: size is assumed to be an integer multiple of TS_PACKET_SIZE */
437 static void rtp_send_mpegts_raw(AVFormatContext *s1,
438 const uint8_t *buf1, int size)
440 RTPMuxContext *s = s1->priv_data;
443 while (size >= TS_PACKET_SIZE) {
444 len = s->max_payload_size - (s->buf_ptr - s->buf);
447 memcpy(s->buf_ptr, buf1, len);
452 out_len = s->buf_ptr - s->buf;
453 if (out_len >= s->max_payload_size) {
454 ff_rtp_send_data(s1, s->buf, out_len, 0);
460 static int rtp_send_ilbc(AVFormatContext *s1, const uint8_t *buf, int size)
462 RTPMuxContext *s = s1->priv_data;
463 AVStream *st = s1->streams[0];
464 int frame_duration = av_get_audio_frame_duration(st->codec, 0);
465 int frame_size = st->codec->block_align;
466 int frames = size / frame_size;
469 int n = FFMIN(s->max_frames_per_packet - s->num_frames, frames);
471 if (!s->num_frames) {
473 s->timestamp = s->cur_timestamp;
475 memcpy(s->buf_ptr, buf, n * frame_size);
478 s->buf_ptr += n * frame_size;
479 buf += n * frame_size;
480 s->cur_timestamp += n * frame_duration;
482 if (s->num_frames == s->max_frames_per_packet) {
483 ff_rtp_send_data(s1, s->buf, s->buf_ptr - s->buf, 1);
490 static int rtp_write_packet(AVFormatContext *s1, AVPacket *pkt)
492 RTPMuxContext *s = s1->priv_data;
493 AVStream *st = s1->streams[0];
497 av_dlog(s1, "%d: write len=%d\n", pkt->stream_index, size);
499 rtcp_bytes = ((s->octet_count - s->last_octet_count) * RTCP_TX_RATIO_NUM) /
501 if ((s->first_packet || ((rtcp_bytes >= RTCP_SR_SIZE) &&
502 (ff_ntp_time() - s->last_rtcp_ntp_time > 5000000))) &&
503 !(s->flags & FF_RTP_FLAG_SKIP_RTCP)) {
504 rtcp_send_sr(s1, ff_ntp_time(), 0);
505 s->last_octet_count = s->octet_count;
508 s->cur_timestamp = s->base_timestamp + pkt->pts;
510 switch(st->codec->codec_id) {
511 case AV_CODEC_ID_PCM_MULAW:
512 case AV_CODEC_ID_PCM_ALAW:
513 case AV_CODEC_ID_PCM_U8:
514 case AV_CODEC_ID_PCM_S8:
515 return rtp_send_samples(s1, pkt->data, size, 8 * st->codec->channels);
516 case AV_CODEC_ID_PCM_U16BE:
517 case AV_CODEC_ID_PCM_U16LE:
518 case AV_CODEC_ID_PCM_S16BE:
519 case AV_CODEC_ID_PCM_S16LE:
520 return rtp_send_samples(s1, pkt->data, size, 16 * st->codec->channels);
521 case AV_CODEC_ID_ADPCM_G722:
522 /* The actual sample size is half a byte per sample, but since the
523 * stream clock rate is 8000 Hz while the sample rate is 16000 Hz,
524 * the correct parameter for send_samples_bits is 8 bits per stream
526 return rtp_send_samples(s1, pkt->data, size, 8 * st->codec->channels);
527 case AV_CODEC_ID_ADPCM_G726:
528 return rtp_send_samples(s1, pkt->data, size,
529 st->codec->bits_per_coded_sample * st->codec->channels);
530 case AV_CODEC_ID_MP2:
531 case AV_CODEC_ID_MP3:
532 rtp_send_mpegaudio(s1, pkt->data, size);
534 case AV_CODEC_ID_MPEG1VIDEO:
535 case AV_CODEC_ID_MPEG2VIDEO:
536 ff_rtp_send_mpegvideo(s1, pkt->data, size);
538 case AV_CODEC_ID_AAC:
539 if (s->flags & FF_RTP_FLAG_MP4A_LATM)
540 ff_rtp_send_latm(s1, pkt->data, size);
542 ff_rtp_send_aac(s1, pkt->data, size);
544 case AV_CODEC_ID_AMR_NB:
545 case AV_CODEC_ID_AMR_WB:
546 ff_rtp_send_amr(s1, pkt->data, size);
548 case AV_CODEC_ID_MPEG2TS:
549 rtp_send_mpegts_raw(s1, pkt->data, size);
551 case AV_CODEC_ID_H264:
552 ff_rtp_send_h264(s1, pkt->data, size);
554 case AV_CODEC_ID_H263:
555 if (s->flags & FF_RTP_FLAG_RFC2190) {
556 int mb_info_size = 0;
557 const uint8_t *mb_info =
558 av_packet_get_side_data(pkt, AV_PKT_DATA_H263_MB_INFO,
560 ff_rtp_send_h263_rfc2190(s1, pkt->data, size, mb_info, mb_info_size);
564 case AV_CODEC_ID_H263P:
565 ff_rtp_send_h263(s1, pkt->data, size);
567 case AV_CODEC_ID_VORBIS:
568 case AV_CODEC_ID_THEORA:
569 ff_rtp_send_xiph(s1, pkt->data, size);
571 case AV_CODEC_ID_VP8:
572 ff_rtp_send_vp8(s1, pkt->data, size);
574 case AV_CODEC_ID_ILBC:
575 rtp_send_ilbc(s1, pkt->data, size);
577 case AV_CODEC_ID_MJPEG:
578 ff_rtp_send_jpeg(s1, pkt->data, size);
580 case AV_CODEC_ID_OPUS:
581 if (size > s->max_payload_size) {
582 av_log(s1, AV_LOG_ERROR,
583 "Packet size %d too large for max RTP payload size %d\n",
584 size, s->max_payload_size);
585 return AVERROR(EINVAL);
587 /* Intentional fallthrough */
589 /* better than nothing : send the codec raw data */
590 rtp_send_raw(s1, pkt->data, size);
596 static int rtp_write_trailer(AVFormatContext *s1)
598 RTPMuxContext *s = s1->priv_data;
600 /* If the caller closes and recreates ->pb, this might actually
601 * be NULL here even if it was successfully allocated at the start. */
602 if (s1->pb && (s->flags & FF_RTP_FLAG_SEND_BYE))
603 rtcp_send_sr(s1, ff_ntp_time(), 1);
609 AVOutputFormat ff_rtp_muxer = {
611 .long_name = NULL_IF_CONFIG_SMALL("RTP output"),
612 .priv_data_size = sizeof(RTPMuxContext),
613 .audio_codec = AV_CODEC_ID_PCM_MULAW,
614 .video_codec = AV_CODEC_ID_MPEG4,
615 .write_header = rtp_write_header,
616 .write_packet = rtp_write_packet,
617 .write_trailer = rtp_write_trailer,
618 .priv_class = &rtp_muxer_class,