/
gstrtpbasepayload.c
2370 lines (2039 loc) · 76.3 KB
/
gstrtpbasepayload.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* GStreamer
* Copyright (C) <2005> Wim Taymans <wim@fluendo.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more
*/
/**
* SECTION:gstrtpbasepayload
* @title: GstRTPBasePayload
* @short_description: Base class for RTP payloader
*
* Provides a base class for RTP payloaders
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <string.h>
#include <gst/rtp/gstrtpbuffer.h>
#include "gstrtpbasepayload.h"
#include "gstrtpmeta.h"
#include "gstrtphdrext.h"
GST_DEBUG_CATEGORY_STATIC (rtpbasepayload_debug);
#define GST_CAT_DEFAULT (rtpbasepayload_debug)
static gboolean enable_experimental_twcc = FALSE;
struct _GstRTPBasePayloadPrivate
{
gboolean ts_offset_random;
gboolean seqnum_offset_random;
gboolean ssrc_random;
guint16 next_seqnum;
gboolean perfect_rtptime;
gint notified_first_timestamp;
gboolean pt_set;
gboolean source_info;
GstBuffer *input_meta_buffer;
guint64 base_offset;
gint64 base_rtime;
guint64 base_rtime_hz;
guint64 running_time;
gboolean scale_rtptime;
gboolean auto_hdr_ext;
gint64 prop_max_ptime;
gint64 caps_max_ptime;
gboolean onvif_no_rate_control;
gboolean negotiated;
gboolean delay_segment;
GstEvent *pending_segment;
GstCaps *subclass_srccaps;
GstCaps *sinkcaps;
/* array of GstRTPHeaderExtension's * */
GPtrArray *header_exts;
};
/* RTPBasePayload signals and args */
enum
{
SIGNAL_0,
SIGNAL_REQUEST_EXTENSION,
SIGNAL_ADD_EXTENSION,
SIGNAL_CLEAR_EXTENSIONS,
LAST_SIGNAL
};
static guint gst_rtp_base_payload_signals[LAST_SIGNAL] = { 0 };
/* FIXME 0.11, a better default is the Ethernet MTU of
* 1500 - sizeof(headers) as pointed out by marcelm in IRC:
* So an Ethernet MTU of 1500, minus 60 for the max IP, minus 8 for UDP, gives
* 1432 bytes or so. And that should be adjusted downward further for other
* encapsulations like PPPoE, so 1400 at most.
*/
#define DEFAULT_MTU 1400
#define DEFAULT_PT 96
#define DEFAULT_SSRC -1
#define DEFAULT_TIMESTAMP_OFFSET -1
#define DEFAULT_SEQNUM_OFFSET -1
#define DEFAULT_MAX_PTIME -1
#define DEFAULT_MIN_PTIME 0
#define DEFAULT_PERFECT_RTPTIME TRUE
#define DEFAULT_PTIME_MULTIPLE 0
#define DEFAULT_RUNNING_TIME GST_CLOCK_TIME_NONE
#define DEFAULT_SOURCE_INFO FALSE
#define DEFAULT_ONVIF_NO_RATE_CONTROL FALSE
#define DEFAULT_SCALE_RTPTIME TRUE
#define DEFAULT_AUTO_HEADER_EXTENSION TRUE
#define RTP_HEADER_EXT_ONE_BYTE_MAX_SIZE 16
#define RTP_HEADER_EXT_TWO_BYTE_MAX_SIZE 256
#define RTP_HEADER_EXT_ONE_BYTE_MAX_ID 14
#define RTP_HEADER_EXT_TWO_BYTE_MAX_ID 255
enum
{
PROP_0,
PROP_MTU,
PROP_PT,
PROP_SSRC,
PROP_TIMESTAMP_OFFSET,
PROP_SEQNUM_OFFSET,
PROP_MAX_PTIME,
PROP_MIN_PTIME,
PROP_TIMESTAMP,
PROP_SEQNUM,
PROP_PERFECT_RTPTIME,
PROP_PTIME_MULTIPLE,
PROP_STATS,
PROP_SOURCE_INFO,
PROP_ONVIF_NO_RATE_CONTROL,
PROP_SCALE_RTPTIME,
PROP_AUTO_HEADER_EXTENSION,
PROP_LAST
};
static void gst_rtp_base_payload_class_init (GstRTPBasePayloadClass * klass);
static void gst_rtp_base_payload_init (GstRTPBasePayload * rtpbasepayload,
gpointer g_class);
static void gst_rtp_base_payload_finalize (GObject * object);
static GstCaps *gst_rtp_base_payload_getcaps_default (GstRTPBasePayload *
rtpbasepayload, GstPad * pad, GstCaps * filter);
static gboolean gst_rtp_base_payload_sink_event_default (GstRTPBasePayload *
rtpbasepayload, GstEvent * event);
static gboolean gst_rtp_base_payload_sink_event (GstPad * pad,
GstObject * parent, GstEvent * event);
static gboolean gst_rtp_base_payload_src_event_default (GstRTPBasePayload *
rtpbasepayload, GstEvent * event);
static gboolean gst_rtp_base_payload_src_event (GstPad * pad,
GstObject * parent, GstEvent * event);
static gboolean gst_rtp_base_payload_query_default (GstRTPBasePayload *
rtpbasepayload, GstPad * pad, GstQuery * query);
static gboolean gst_rtp_base_payload_query (GstPad * pad, GstObject * parent,
GstQuery * query);
static GstFlowReturn gst_rtp_base_payload_chain (GstPad * pad,
GstObject * parent, GstBuffer * buffer);
static void gst_rtp_base_payload_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
static void gst_rtp_base_payload_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
static GstStateChangeReturn gst_rtp_base_payload_change_state (GstElement *
element, GstStateChange transition);
static gboolean gst_rtp_base_payload_negotiate (GstRTPBasePayload * payload);
static void gst_rtp_base_payload_add_extension (GstRTPBasePayload * payload,
GstRTPHeaderExtension * ext);
static void gst_rtp_base_payload_clear_extensions (GstRTPBasePayload * payload);
static GstElementClass *parent_class = NULL;
static gint private_offset = 0;
GType
gst_rtp_base_payload_get_type (void)
{
static GType rtpbasepayload_type = 0;
if (g_once_init_enter ((gsize *) & rtpbasepayload_type)) {
static const GTypeInfo rtpbasepayload_info = {
sizeof (GstRTPBasePayloadClass),
NULL,
NULL,
(GClassInitFunc) gst_rtp_base_payload_class_init,
NULL,
NULL,
sizeof (GstRTPBasePayload),
0,
(GInstanceInitFunc) gst_rtp_base_payload_init,
};
GType _type;
_type = g_type_register_static (GST_TYPE_ELEMENT, "GstRTPBasePayload",
&rtpbasepayload_info, G_TYPE_FLAG_ABSTRACT);
private_offset =
g_type_add_instance_private (_type, sizeof (GstRTPBasePayloadPrivate));
g_once_init_leave ((gsize *) & rtpbasepayload_type, _type);
}
return rtpbasepayload_type;
}
static inline GstRTPBasePayloadPrivate *
gst_rtp_base_payload_get_instance_private (GstRTPBasePayload * self)
{
return (G_STRUCT_MEMBER_P (self, private_offset));
}
static GstRTPHeaderExtension *
gst_rtp_base_payload_request_extension_default (GstRTPBasePayload * payload,
guint ext_id, const gchar * uri)
{
GstRTPHeaderExtension *ext = NULL;
if (!payload->priv->auto_hdr_ext)
return NULL;
ext = gst_rtp_header_extension_create_from_uri (uri);
if (ext) {
GST_DEBUG_OBJECT (payload,
"Automatically enabled extension %s for uri \'%s\'",
GST_ELEMENT_NAME (ext), uri);
gst_rtp_header_extension_set_id (ext, ext_id);
} else {
GST_DEBUG_OBJECT (payload,
"Didn't find any extension implementing uri \'%s\'", uri);
}
return ext;
}
static gboolean
extension_accumulator (GSignalInvocationHint * ihint,
GValue * return_accu, const GValue * handler_return, gpointer data)
{
gpointer ext;
/* Call default handler if user callback didn't create the extension */
ext = g_value_get_object (handler_return);
if (!ext)
return TRUE;
g_value_set_object (return_accu, ext);
return FALSE;
}
static void
gst_rtp_base_payload_class_init (GstRTPBasePayloadClass * klass)
{
GObjectClass *gobject_class;
GstElementClass *gstelement_class;
gobject_class = (GObjectClass *) klass;
gstelement_class = (GstElementClass *) klass;
if (g_getenv ("GST_RTP_ENABLE_EXPERIMENTAL_TWCC_PROPERTY"))
enable_experimental_twcc = TRUE;
if (private_offset != 0)
g_type_class_adjust_private_offset (klass, &private_offset);
parent_class = g_type_class_peek_parent (klass);
gobject_class->finalize = gst_rtp_base_payload_finalize;
gobject_class->set_property = gst_rtp_base_payload_set_property;
gobject_class->get_property = gst_rtp_base_payload_get_property;
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MTU,
g_param_spec_uint ("mtu", "MTU",
"Maximum size of one packet",
28, G_MAXUINT, DEFAULT_MTU,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PT,
g_param_spec_uint ("pt", "payload type",
"The payload type of the packets", 0, 0x7f, DEFAULT_PT,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SSRC,
g_param_spec_uint ("ssrc", "SSRC",
"The SSRC of the packets (default == random)", 0, G_MAXUINT32,
DEFAULT_SSRC, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (G_OBJECT_CLASS (klass),
PROP_TIMESTAMP_OFFSET, g_param_spec_uint ("timestamp-offset",
"Timestamp Offset",
"Offset to add to all outgoing timestamps (default = random)", 0,
G_MAXUINT32, DEFAULT_TIMESTAMP_OFFSET,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM_OFFSET,
g_param_spec_int ("seqnum-offset", "Sequence number Offset",
"Offset to add to all outgoing seqnum (-1 = random)", -1, G_MAXUINT16,
DEFAULT_SEQNUM_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MAX_PTIME,
g_param_spec_int64 ("max-ptime", "Max packet time",
"Maximum duration of the packet data in ns (-1 = unlimited up to MTU)",
-1, G_MAXINT64, DEFAULT_MAX_PTIME,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTPBasePayload:min-ptime:
*
* Minimum duration of the packet data in ns (can't go above MTU)
**/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MIN_PTIME,
g_param_spec_int64 ("min-ptime", "Min packet time",
"Minimum duration of the packet data in ns (can't go above MTU)",
0, G_MAXINT64, DEFAULT_MIN_PTIME,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMESTAMP,
g_param_spec_uint ("timestamp", "Timestamp",
"The RTP timestamp of the last processed packet",
0, G_MAXUINT32, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM,
g_param_spec_uint ("seqnum", "Sequence number",
"The RTP sequence number of the last processed packet",
0, G_MAXUINT16, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
/**
* GstRTPBasePayload:perfect-rtptime:
*
* Try to use the offset fields to generate perfect RTP timestamps. When this
* option is disabled, RTP timestamps are generated from GST_BUFFER_PTS of
* each payloaded buffer. The PTSes of buffers may not necessarily increment
* with the amount of data in each input buffer, consider e.g. the case where
* the buffer arrives from a network which means that the PTS is unrelated to
* the amount of data. Because the RTP timestamps are generated from
* GST_BUFFER_PTS this can result in RTP timestamps that also don't increment
* with the amount of data in the payloaded packet. To circumvent this it is
* possible to set the perfect rtptime option enabled. When this option is
* enabled the payloader will increment the RTP timestamps based on
* GST_BUFFER_OFFSET which relates to the amount of data in each packet
* rather than the GST_BUFFER_PTS of each buffer and therefore the RTP
* timestamps will more closely correlate with the amount of data in each
* buffer. Currently GstRTPBasePayload is limited to handling perfect RTP
* timestamps for audio streams.
*/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PERFECT_RTPTIME,
g_param_spec_boolean ("perfect-rtptime", "Perfect RTP Time",
"Generate perfect RTP timestamps when possible",
DEFAULT_PERFECT_RTPTIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTPBasePayload:ptime-multiple:
*
* Force buffers to be multiples of this duration in ns (0 disables)
**/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PTIME_MULTIPLE,
g_param_spec_int64 ("ptime-multiple", "Packet time multiple",
"Force buffers to be multiples of this duration in ns (0 disables)",
0, G_MAXINT64, DEFAULT_PTIME_MULTIPLE,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTPBasePayload:stats:
*
* Various payloader statistics retrieved atomically (and are therefore
* synchroized with each other), these can be used e.g. to generate an
* RTP-Info header. This property return a GstStructure named
* application/x-rtp-payload-stats containing the following fields relating to
* the last processed buffer and current state of the stream being payloaded:
*
* * `clock-rate` :#G_TYPE_UINT, clock-rate of the stream
* * `running-time` :#G_TYPE_UINT64, running time
* * `seqnum` :#G_TYPE_UINT, sequence number, same as #GstRTPBasePayload:seqnum
* * `timestamp` :#G_TYPE_UINT, RTP timestamp, same as #GstRTPBasePayload:timestamp
* * `ssrc` :#G_TYPE_UINT, The SSRC in use
* * `pt` :#G_TYPE_UINT, The Payload type in use, same as #GstRTPBasePayload:pt
* * `seqnum-offset` :#G_TYPE_UINT, The current offset added to the seqnum
* * `timestamp-offset` :#G_TYPE_UINT, The current offset added to the timestamp
**/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_STATS,
g_param_spec_boxed ("stats", "Statistics", "Various statistics",
GST_TYPE_STRUCTURE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
/**
* GstRTPBasePayload:source-info:
*
* Enable writing the CSRC field in allocated RTP header based on RTP source
* information found in the input buffer's #GstRTPSourceMeta.
*
* Since: 1.16
**/
g_object_class_install_property (gobject_class, PROP_SOURCE_INFO,
g_param_spec_boolean ("source-info", "RTP source information",
"Write CSRC based on buffer meta RTP source information",
DEFAULT_SOURCE_INFO, G_PARAM_READWRITE));
/**
* GstRTPBasePayload:onvif-no-rate-control:
*
* Make the payloader timestamp packets according to the Rate-Control=no
* behaviour specified in the ONVIF replay spec.
*
* Since: 1.16
*/
g_object_class_install_property (G_OBJECT_CLASS (klass),
PROP_ONVIF_NO_RATE_CONTROL, g_param_spec_boolean ("onvif-no-rate-control",
"ONVIF no rate control",
"Enable ONVIF Rate-Control=no timestamping mode",
DEFAULT_ONVIF_NO_RATE_CONTROL,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTPBasePayload:scale-rtptime:
*
* Make the RTP packets' timestamps be scaled with the segment's rate
* (corresponding to RTSP speed parameter). Disabling this property means
* the timestamps will not be affected by the set delivery speed (RTSP speed).
*
* Example: A server wants to allow streaming a recorded video in double
* speed but still have the timestamps correspond to the position in the
* video. This is achieved by the client setting RTSP Speed to 2 while the
* server has this property disabled.
*
* Since: 1.18
*/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SCALE_RTPTIME,
g_param_spec_boolean ("scale-rtptime", "Scale RTP time",
"Whether the RTP timestamp should be scaled with the rate (speed)",
DEFAULT_SCALE_RTPTIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTPBasePayload:auto-header-extension:
*
* If enabled, the payloader will automatically try to enable all the
* RTP header extensions provided in the src caps, saving the application
* the need to handle these extensions manually using the
* GstRTPBasePayload::request-extension: signal.
*
* Since: 1.20
*/
g_object_class_install_property (G_OBJECT_CLASS (klass),
PROP_AUTO_HEADER_EXTENSION, g_param_spec_boolean ("auto-header-extension",
"Automatic RTP header extension",
"Whether RTP header extensions should be automatically enabled, if an implementation is available",
DEFAULT_AUTO_HEADER_EXTENSION,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstRTPBasePayload::add-extension:
* @object: the #GstRTPBasePayload
* @ext: (transfer full): the #GstRTPHeaderExtension
*
* Add @ext as an extension for writing part of an RTP header extension onto
* outgoing RTP packets.
*
* Since: 1.20
*/
gst_rtp_base_payload_signals[SIGNAL_ADD_EXTENSION] =
g_signal_new_class_handler ("add-extension", G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
G_CALLBACK (gst_rtp_base_payload_add_extension), NULL, NULL, NULL,
G_TYPE_NONE, 1, GST_TYPE_RTP_HEADER_EXTENSION);
/**
* GstRTPBasePayload::request-extension:
* @object: the #GstRTPBasePayload
* @ext_id: the extension id being requested
* @ext_uri: the extension URI being requested
*
* The returned @ext must be configured with the correct @ext_id and with the
* necessary attributes as required by the extension implementation.
*
* Returns: (transfer full): the #GstRTPHeaderExtension for @ext_id, or %NULL
*
* Since: 1.20
*/
gst_rtp_base_payload_signals[SIGNAL_REQUEST_EXTENSION] =
g_signal_new_class_handler ("request-extension",
G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
G_CALLBACK (gst_rtp_base_payload_request_extension_default),
extension_accumulator, NULL, NULL,
GST_TYPE_RTP_HEADER_EXTENSION, 2, G_TYPE_UINT, G_TYPE_STRING);
/**
* GstRTPBasePayload::clear-extensions:
* @object: the #GstRTPBasePayload
*
* Clear all RTP header extensions used by this payloader.
*
* Since: 1.20
*/
gst_rtp_base_payload_signals[SIGNAL_CLEAR_EXTENSIONS] =
g_signal_new_class_handler ("clear-extensions", G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
G_CALLBACK (gst_rtp_base_payload_clear_extensions), NULL, NULL, NULL,
G_TYPE_NONE, 0);
gstelement_class->change_state = gst_rtp_base_payload_change_state;
klass->get_caps = gst_rtp_base_payload_getcaps_default;
klass->sink_event = gst_rtp_base_payload_sink_event_default;
klass->src_event = gst_rtp_base_payload_src_event_default;
klass->query = gst_rtp_base_payload_query_default;
GST_DEBUG_CATEGORY_INIT (rtpbasepayload_debug, "rtpbasepayload", 0,
"Base class for RTP Payloaders");
}
static void
gst_rtp_base_payload_init (GstRTPBasePayload * rtpbasepayload, gpointer g_class)
{
GstPadTemplate *templ;
GstRTPBasePayloadPrivate *priv;
rtpbasepayload->priv = priv =
gst_rtp_base_payload_get_instance_private (rtpbasepayload);
templ =
gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "src");
g_return_if_fail (templ != NULL);
rtpbasepayload->srcpad = gst_pad_new_from_template (templ, "src");
gst_pad_set_event_function (rtpbasepayload->srcpad,
gst_rtp_base_payload_src_event);
gst_element_add_pad (GST_ELEMENT (rtpbasepayload), rtpbasepayload->srcpad);
templ =
gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
g_return_if_fail (templ != NULL);
rtpbasepayload->sinkpad = gst_pad_new_from_template (templ, "sink");
gst_pad_set_chain_function (rtpbasepayload->sinkpad,
gst_rtp_base_payload_chain);
gst_pad_set_event_function (rtpbasepayload->sinkpad,
gst_rtp_base_payload_sink_event);
gst_pad_set_query_function (rtpbasepayload->sinkpad,
gst_rtp_base_payload_query);
gst_element_add_pad (GST_ELEMENT (rtpbasepayload), rtpbasepayload->sinkpad);
rtpbasepayload->mtu = DEFAULT_MTU;
rtpbasepayload->pt = DEFAULT_PT;
rtpbasepayload->seqnum_offset = DEFAULT_SEQNUM_OFFSET;
rtpbasepayload->ssrc = DEFAULT_SSRC;
rtpbasepayload->ts_offset = DEFAULT_TIMESTAMP_OFFSET;
priv->running_time = DEFAULT_RUNNING_TIME;
priv->seqnum_offset_random = (rtpbasepayload->seqnum_offset == -1);
priv->ts_offset_random = (rtpbasepayload->ts_offset == -1);
priv->ssrc_random = (rtpbasepayload->ssrc == -1);
priv->pt_set = FALSE;
priv->source_info = DEFAULT_SOURCE_INFO;
rtpbasepayload->max_ptime = DEFAULT_MAX_PTIME;
rtpbasepayload->min_ptime = DEFAULT_MIN_PTIME;
rtpbasepayload->priv->perfect_rtptime = DEFAULT_PERFECT_RTPTIME;
rtpbasepayload->ptime_multiple = DEFAULT_PTIME_MULTIPLE;
rtpbasepayload->priv->base_offset = GST_BUFFER_OFFSET_NONE;
rtpbasepayload->priv->base_rtime_hz = GST_BUFFER_OFFSET_NONE;
rtpbasepayload->priv->onvif_no_rate_control = DEFAULT_ONVIF_NO_RATE_CONTROL;
rtpbasepayload->priv->scale_rtptime = DEFAULT_SCALE_RTPTIME;
rtpbasepayload->priv->auto_hdr_ext = DEFAULT_AUTO_HEADER_EXTENSION;
rtpbasepayload->media = NULL;
rtpbasepayload->encoding_name = NULL;
rtpbasepayload->clock_rate = 0;
rtpbasepayload->priv->caps_max_ptime = DEFAULT_MAX_PTIME;
rtpbasepayload->priv->prop_max_ptime = DEFAULT_MAX_PTIME;
rtpbasepayload->priv->header_exts =
g_ptr_array_new_with_free_func ((GDestroyNotify) gst_object_unref);
}
static void
gst_rtp_base_payload_finalize (GObject * object)
{
GstRTPBasePayload *rtpbasepayload;
rtpbasepayload = GST_RTP_BASE_PAYLOAD (object);
g_free (rtpbasepayload->media);
rtpbasepayload->media = NULL;
g_free (rtpbasepayload->encoding_name);
rtpbasepayload->encoding_name = NULL;
gst_caps_replace (&rtpbasepayload->priv->subclass_srccaps, NULL);
gst_caps_replace (&rtpbasepayload->priv->sinkcaps, NULL);
g_ptr_array_unref (rtpbasepayload->priv->header_exts);
rtpbasepayload->priv->header_exts = NULL;
G_OBJECT_CLASS (parent_class)->finalize (object);
}
static GstCaps *
gst_rtp_base_payload_getcaps_default (GstRTPBasePayload * rtpbasepayload,
GstPad * pad, GstCaps * filter)
{
GstCaps *caps;
caps = GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (pad));
GST_DEBUG_OBJECT (pad,
"using pad template %p with caps %p %" GST_PTR_FORMAT,
GST_PAD_PAD_TEMPLATE (pad), caps, caps);
if (filter)
caps = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
else
caps = gst_caps_ref (caps);
return caps;
}
static gboolean
gst_rtp_base_payload_sink_event_default (GstRTPBasePayload * rtpbasepayload,
GstEvent * event)
{
GstObject *parent = GST_OBJECT_CAST (rtpbasepayload);
gboolean res = FALSE;
switch (GST_EVENT_TYPE (event)) {
case GST_EVENT_FLUSH_START:
res = gst_pad_event_default (rtpbasepayload->sinkpad, parent, event);
break;
case GST_EVENT_FLUSH_STOP:
res = gst_pad_event_default (rtpbasepayload->sinkpad, parent, event);
gst_segment_init (&rtpbasepayload->segment, GST_FORMAT_UNDEFINED);
gst_event_replace (&rtpbasepayload->priv->pending_segment, NULL);
break;
case GST_EVENT_CAPS:
{
GstRTPBasePayloadClass *rtpbasepayload_class;
GstCaps *caps;
gst_event_parse_caps (event, &caps);
GST_DEBUG_OBJECT (rtpbasepayload, "setting caps %" GST_PTR_FORMAT, caps);
gst_caps_replace (&rtpbasepayload->priv->sinkcaps, caps);
rtpbasepayload_class = GST_RTP_BASE_PAYLOAD_GET_CLASS (rtpbasepayload);
if (rtpbasepayload_class->set_caps)
res = rtpbasepayload_class->set_caps (rtpbasepayload, caps);
else
res = gst_rtp_base_payload_negotiate (rtpbasepayload);
rtpbasepayload->priv->negotiated = res;
gst_event_unref (event);
break;
}
case GST_EVENT_SEGMENT:
{
GstSegment *segment;
segment = &rtpbasepayload->segment;
gst_event_copy_segment (event, segment);
rtpbasepayload->priv->base_offset = GST_BUFFER_OFFSET_NONE;
GST_DEBUG_OBJECT (rtpbasepayload,
"configured SEGMENT %" GST_SEGMENT_FORMAT, segment);
if (rtpbasepayload->priv->delay_segment) {
gst_event_replace (&rtpbasepayload->priv->pending_segment, event);
gst_event_unref (event);
res = TRUE;
} else {
res = gst_pad_event_default (rtpbasepayload->sinkpad, parent, event);
}
break;
}
case GST_EVENT_GAP:
{
if (G_UNLIKELY (rtpbasepayload->priv->pending_segment)) {
gst_pad_push_event (rtpbasepayload->srcpad,
rtpbasepayload->priv->pending_segment);
rtpbasepayload->priv->pending_segment = FALSE;
rtpbasepayload->priv->delay_segment = FALSE;
}
res = gst_pad_event_default (rtpbasepayload->sinkpad, parent, event);
break;
}
default:
res = gst_pad_event_default (rtpbasepayload->sinkpad, parent, event);
break;
}
return res;
}
static gboolean
gst_rtp_base_payload_sink_event (GstPad * pad, GstObject * parent,
GstEvent * event)
{
GstRTPBasePayload *rtpbasepayload;
GstRTPBasePayloadClass *rtpbasepayload_class;
gboolean res = FALSE;
rtpbasepayload = GST_RTP_BASE_PAYLOAD (parent);
rtpbasepayload_class = GST_RTP_BASE_PAYLOAD_GET_CLASS (rtpbasepayload);
if (rtpbasepayload_class->sink_event)
res = rtpbasepayload_class->sink_event (rtpbasepayload, event);
else
gst_event_unref (event);
return res;
}
static gboolean
gst_rtp_base_payload_src_event_default (GstRTPBasePayload * rtpbasepayload,
GstEvent * event)
{
GstObject *parent = GST_OBJECT_CAST (rtpbasepayload);
gboolean res = TRUE, forward = TRUE;
switch (GST_EVENT_TYPE (event)) {
case GST_EVENT_CUSTOM_UPSTREAM:
{
const GstStructure *s = gst_event_get_structure (event);
if (gst_structure_has_name (s, "GstRTPCollision")) {
guint ssrc = 0;
if (!gst_structure_get_uint (s, "ssrc", &ssrc))
ssrc = -1;
GST_DEBUG_OBJECT (rtpbasepayload, "collided ssrc: %" G_GUINT32_FORMAT,
ssrc);
/* choose another ssrc for our stream */
if (ssrc == rtpbasepayload->current_ssrc) {
GstCaps *caps;
guint suggested_ssrc = 0;
if (gst_structure_get_uint (s, "suggested-ssrc", &suggested_ssrc))
rtpbasepayload->current_ssrc = suggested_ssrc;
while (ssrc == rtpbasepayload->current_ssrc)
rtpbasepayload->current_ssrc = g_random_int ();
caps = gst_pad_get_current_caps (rtpbasepayload->srcpad);
if (caps) {
caps = gst_caps_make_writable (caps);
gst_caps_set_simple (caps,
"ssrc", G_TYPE_UINT, rtpbasepayload->current_ssrc, NULL);
res = gst_pad_set_caps (rtpbasepayload->srcpad, caps);
gst_caps_unref (caps);
}
/* the event was for us */
forward = FALSE;
}
}
break;
}
default:
break;
}
if (forward)
res = gst_pad_event_default (rtpbasepayload->srcpad, parent, event);
else
gst_event_unref (event);
return res;
}
static gboolean
gst_rtp_base_payload_src_event (GstPad * pad, GstObject * parent,
GstEvent * event)
{
GstRTPBasePayload *rtpbasepayload;
GstRTPBasePayloadClass *rtpbasepayload_class;
gboolean res = FALSE;
rtpbasepayload = GST_RTP_BASE_PAYLOAD (parent);
rtpbasepayload_class = GST_RTP_BASE_PAYLOAD_GET_CLASS (rtpbasepayload);
if (rtpbasepayload_class->src_event)
res = rtpbasepayload_class->src_event (rtpbasepayload, event);
else
gst_event_unref (event);
return res;
}
static gboolean
gst_rtp_base_payload_query_default (GstRTPBasePayload * rtpbasepayload,
GstPad * pad, GstQuery * query)
{
gboolean res = FALSE;
switch (GST_QUERY_TYPE (query)) {
case GST_QUERY_CAPS:
{
GstRTPBasePayloadClass *rtpbasepayload_class;
GstCaps *filter, *caps;
gst_query_parse_caps (query, &filter);
GST_DEBUG_OBJECT (rtpbasepayload, "getting caps with filter %"
GST_PTR_FORMAT, filter);
rtpbasepayload_class = GST_RTP_BASE_PAYLOAD_GET_CLASS (rtpbasepayload);
if (rtpbasepayload_class->get_caps) {
caps = rtpbasepayload_class->get_caps (rtpbasepayload, pad, filter);
gst_query_set_caps_result (query, caps);
gst_caps_unref (caps);
res = TRUE;
}
break;
}
default:
res =
gst_pad_query_default (pad, GST_OBJECT_CAST (rtpbasepayload), query);
break;
}
return res;
}
static gboolean
gst_rtp_base_payload_query (GstPad * pad, GstObject * parent, GstQuery * query)
{
GstRTPBasePayload *rtpbasepayload;
GstRTPBasePayloadClass *rtpbasepayload_class;
gboolean res = FALSE;
rtpbasepayload = GST_RTP_BASE_PAYLOAD (parent);
rtpbasepayload_class = GST_RTP_BASE_PAYLOAD_GET_CLASS (rtpbasepayload);
if (rtpbasepayload_class->query)
res = rtpbasepayload_class->query (rtpbasepayload, pad, query);
return res;
}
static GstFlowReturn
gst_rtp_base_payload_chain (GstPad * pad, GstObject * parent,
GstBuffer * buffer)
{
GstRTPBasePayload *rtpbasepayload;
GstRTPBasePayloadClass *rtpbasepayload_class;
GstFlowReturn ret;
rtpbasepayload = GST_RTP_BASE_PAYLOAD (parent);
rtpbasepayload_class = GST_RTP_BASE_PAYLOAD_GET_CLASS (rtpbasepayload);
if (!rtpbasepayload_class->handle_buffer)
goto no_function;
if (!rtpbasepayload->priv->negotiated)
goto not_negotiated;
if (rtpbasepayload->priv->source_info
|| rtpbasepayload->priv->header_exts->len > 0) {
/* Save a copy of meta (instead of taking an extra reference before
* handle_buffer) to make the meta available when allocating a output
* buffer. */
rtpbasepayload->priv->input_meta_buffer = gst_buffer_new ();
gst_buffer_copy_into (rtpbasepayload->priv->input_meta_buffer, buffer,
GST_BUFFER_COPY_META, 0, -1);
}
if (gst_pad_check_reconfigure (GST_RTP_BASE_PAYLOAD_SRCPAD (rtpbasepayload))) {
if (!gst_rtp_base_payload_negotiate (rtpbasepayload)) {
gst_pad_mark_reconfigure (GST_RTP_BASE_PAYLOAD_SRCPAD (rtpbasepayload));
if (GST_PAD_IS_FLUSHING (GST_RTP_BASE_PAYLOAD_SRCPAD (rtpbasepayload))) {
goto flushing;
} else {
goto negotiate_failed;
}
}
}
ret = rtpbasepayload_class->handle_buffer (rtpbasepayload, buffer);
gst_buffer_replace (&rtpbasepayload->priv->input_meta_buffer, NULL);
return ret;
/* ERRORS */
no_function:
{
GST_ELEMENT_ERROR (rtpbasepayload, STREAM, NOT_IMPLEMENTED, (NULL),
("subclass did not implement handle_buffer function"));
gst_buffer_unref (buffer);
return GST_FLOW_ERROR;
}
not_negotiated:
{
GST_ELEMENT_ERROR (rtpbasepayload, CORE, NEGOTIATION, (NULL),
("No input format was negotiated, i.e. no caps event was received. "
"Perhaps you need a parser or typefind element before the payloader"));
gst_buffer_unref (buffer);
return GST_FLOW_NOT_NEGOTIATED;
}
negotiate_failed:
{
GST_DEBUG_OBJECT (rtpbasepayload, "Not negotiated");
gst_buffer_unref (buffer);
return GST_FLOW_NOT_NEGOTIATED;
}
flushing:
{
GST_DEBUG_OBJECT (rtpbasepayload, "we are flushing");
gst_buffer_unref (buffer);
return GST_FLOW_FLUSHING;
}
}
/**
* gst_rtp_base_payload_set_options:
* @payload: a #GstRTPBasePayload
* @media: the media type (typically "audio" or "video")
* @dynamic: if the payload type is dynamic
* @encoding_name: the encoding name
* @clock_rate: the clock rate of the media
*
* Set the rtp options of the payloader. These options will be set in the caps
* of the payloader. Subclasses must call this method before calling
* gst_rtp_base_payload_push() or gst_rtp_base_payload_set_outcaps().
*/
void
gst_rtp_base_payload_set_options (GstRTPBasePayload * payload,
const gchar * media, gboolean dynamic, const gchar * encoding_name,
guint32 clock_rate)
{
g_return_if_fail (payload != NULL);
g_return_if_fail (clock_rate != 0);
g_free (payload->media);
payload->media = g_strdup (media);
payload->dynamic = dynamic;
g_free (payload->encoding_name);
payload->encoding_name = g_strdup (encoding_name);
payload->clock_rate = clock_rate;
}
static gboolean
copy_fixed (GQuark field_id, const GValue * value, GstStructure * dest)
{
if (gst_value_is_fixed (value)) {
gst_structure_id_set_value (dest, field_id, value);
}
return TRUE;
}
static void
update_max_ptime (GstRTPBasePayload * rtpbasepayload)
{
if (rtpbasepayload->priv->caps_max_ptime != -1 &&
rtpbasepayload->priv->prop_max_ptime != -1)
rtpbasepayload->max_ptime = MIN (rtpbasepayload->priv->caps_max_ptime,
rtpbasepayload->priv->prop_max_ptime);
else if (rtpbasepayload->priv->caps_max_ptime != -1)
rtpbasepayload->max_ptime = rtpbasepayload->priv->caps_max_ptime;
else if (rtpbasepayload->priv->prop_max_ptime != -1)
rtpbasepayload->max_ptime = rtpbasepayload->priv->prop_max_ptime;
else
rtpbasepayload->max_ptime = DEFAULT_MAX_PTIME;
}
static gboolean
_set_caps (GQuark field_id, const GValue * value, GstCaps * caps)
{
gst_caps_set_value (caps, g_quark_to_string (field_id), value);
return TRUE;
}
/**
* gst_rtp_base_payload_set_outcaps_structure:
* @payload: a #GstRTPBasePayload
* @s: (nullable): a #GstStructure with the caps fields
*
* Configure the output caps with the optional fields.
*
* Returns: %TRUE if the caps could be set.
*
* Since: 1.20
*/
gboolean
gst_rtp_base_payload_set_outcaps_structure (GstRTPBasePayload * payload,
GstStructure * s)
{
GstCaps *srccaps;
/* fill in the defaults, their properties cannot be negotiated. */
srccaps = gst_caps_new_simple ("application/x-rtp",
"media", G_TYPE_STRING, payload->media,
"clock-rate", G_TYPE_INT, payload->clock_rate,
"encoding-name", G_TYPE_STRING, payload->encoding_name, NULL);
GST_DEBUG_OBJECT (payload, "defaults: %" GST_PTR_FORMAT, srccaps);
if (s && gst_structure_n_fields (s) > 0) {
gst_structure_foreach (s, (GstStructureForeachFunc) _set_caps, srccaps);
GST_DEBUG_OBJECT (payload, "custom added: %" GST_PTR_FORMAT, srccaps);
}
gst_caps_replace (&payload->priv->subclass_srccaps, srccaps);
gst_caps_unref (srccaps);
return gst_rtp_base_payload_negotiate (payload);
}