SessionDescription.java

  1package eu.siacs.conversations.xmpp.jingle;
  2
  3import android.util.Log;
  4import android.util.Pair;
  5
  6import com.google.common.base.CharMatcher;
  7import com.google.common.base.Joiner;
  8import com.google.common.base.Strings;
  9import com.google.common.collect.ArrayListMultimap;
 10import com.google.common.collect.ImmutableList;
 11
 12import java.util.List;
 13import java.util.Locale;
 14import java.util.Map;
 15
 16import eu.siacs.conversations.Config;
 17import eu.siacs.conversations.xmpp.jingle.stanzas.Group;
 18import eu.siacs.conversations.xmpp.jingle.stanzas.IceUdpTransportInfo;
 19import eu.siacs.conversations.xmpp.jingle.stanzas.RtpDescription;
 20
 21public class SessionDescription {
 22
 23    public final static String LINE_DIVIDER = "\r\n";
 24    private final static String HARDCODED_MEDIA_PROTOCOL = "UDP/TLS/RTP/SAVPF"; //probably only true for DTLS-SRTP aka when we have a fingerprint
 25    private final static int HARDCODED_MEDIA_PORT = 9;
 26    private final static String HARDCODED_ICE_OPTIONS = "trickle renomination";
 27    private final static String HARDCODED_CONNECTION = "IN IP4 0.0.0.0";
 28
 29    public final int version;
 30    public final String name;
 31    public final String connectionData;
 32    public final ArrayListMultimap<String, String> attributes;
 33    public final List<Media> media;
 34
 35
 36    public SessionDescription(int version, String name, String connectionData, ArrayListMultimap<String, String> attributes, List<Media> media) {
 37        this.version = version;
 38        this.name = name;
 39        this.connectionData = connectionData;
 40        this.attributes = attributes;
 41        this.media = media;
 42    }
 43
 44    private static void appendAttributes(StringBuilder s, ArrayListMultimap<String, String> attributes) {
 45        for (Map.Entry<String, String> attribute : attributes.entries()) {
 46            final String key = attribute.getKey();
 47            final String value = attribute.getValue();
 48            s.append("a=").append(key);
 49            if (!Strings.isNullOrEmpty(value)) {
 50                s.append(':').append(value);
 51            }
 52            s.append(LINE_DIVIDER);
 53        }
 54    }
 55
 56    public static SessionDescription parse(final Map<String, RtpContentMap.DescriptionTransport> contents) {
 57        final SessionDescriptionBuilder sessionDescriptionBuilder = new SessionDescriptionBuilder();
 58        return sessionDescriptionBuilder.createSessionDescription();
 59    }
 60
 61    public static SessionDescription parse(final String input) {
 62        final SessionDescriptionBuilder sessionDescriptionBuilder = new SessionDescriptionBuilder();
 63        MediaBuilder currentMediaBuilder = null;
 64        ArrayListMultimap<String, String> attributeMap = ArrayListMultimap.create();
 65        ImmutableList.Builder<Media> mediaBuilder = new ImmutableList.Builder<>();
 66        for (final String line : input.split(LINE_DIVIDER)) {
 67            final String[] pair = line.trim().split("=", 2);
 68            if (pair.length < 2 || pair[0].length() != 1) {
 69                Log.d(Config.LOGTAG, "skipping sdp parsing on line " + line);
 70                continue;
 71            }
 72            final char key = pair[0].charAt(0);
 73            final String value = pair[1];
 74            switch (key) {
 75                case 'v':
 76                    sessionDescriptionBuilder.setVersion(ignorantIntParser(value));
 77                    break;
 78                case 'c':
 79                    if (currentMediaBuilder != null) {
 80                        currentMediaBuilder.setConnectionData(value);
 81                    } else {
 82                        sessionDescriptionBuilder.setConnectionData(value);
 83                    }
 84                    break;
 85                case 's':
 86                    sessionDescriptionBuilder.setName(value);
 87                    break;
 88                case 'a':
 89                    final Pair<String, String> attribute = parseAttribute(value);
 90                    attributeMap.put(attribute.first, attribute.second);
 91                    break;
 92                case 'm':
 93                    if (currentMediaBuilder == null) {
 94                        sessionDescriptionBuilder.setAttributes(attributeMap);
 95                        ;
 96                    } else {
 97                        currentMediaBuilder.setAttributes(attributeMap);
 98                        mediaBuilder.add(currentMediaBuilder.createMedia());
 99                    }
100                    attributeMap = ArrayListMultimap.create();
101                    currentMediaBuilder = new MediaBuilder();
102                    final String[] parts = value.split(" ");
103                    if (parts.length >= 3) {
104                        currentMediaBuilder.setMedia(parts[0]);
105                        currentMediaBuilder.setPort(ignorantIntParser(parts[1]));
106                        currentMediaBuilder.setProtocol(parts[2]);
107                        ImmutableList.Builder<Integer> formats = new ImmutableList.Builder<>();
108                        for (int i = 3; i < parts.length; ++i) {
109                            formats.add(ignorantIntParser(parts[i]));
110                        }
111                        currentMediaBuilder.setFormats(formats.build());
112                    } else {
113                        Log.d(Config.LOGTAG, "skipping media line " + line);
114                    }
115                    break;
116            }
117
118        }
119        if (currentMediaBuilder != null) {
120            currentMediaBuilder.setAttributes(attributeMap);
121            mediaBuilder.add(currentMediaBuilder.createMedia());
122        } else {
123            sessionDescriptionBuilder.setAttributes(attributeMap);
124        }
125        sessionDescriptionBuilder.setMedia(mediaBuilder.build());
126        return sessionDescriptionBuilder.createSessionDescription();
127    }
128
129    public static SessionDescription of(final RtpContentMap contentMap) {
130        final SessionDescriptionBuilder sessionDescriptionBuilder = new SessionDescriptionBuilder();
131        final ArrayListMultimap<String, String> attributeMap = ArrayListMultimap.create();
132        final ImmutableList.Builder<Media> mediaListBuilder = new ImmutableList.Builder<>();
133        final Group group = contentMap.group;
134        if (group != null) {
135            final String semantics = group.getSemantics();
136            checkNoWhitespace(semantics, "group semantics value must not contain any whitespace");
137            attributeMap.put("group", group.getSemantics() + " " + Joiner.on(' ').join(group.getIdentificationTags()));
138        }
139
140        attributeMap.put("msid-semantic", " WMS my-media-stream");
141
142        for (final Map.Entry<String, RtpContentMap.DescriptionTransport> entry : contentMap.contents.entrySet()) {
143            final String name = entry.getKey();
144            RtpContentMap.DescriptionTransport descriptionTransport = entry.getValue();
145            RtpDescription description = descriptionTransport.description;
146            IceUdpTransportInfo transport = descriptionTransport.transport;
147            final ArrayListMultimap<String, String> mediaAttributes = ArrayListMultimap.create();
148            final String ufrag = transport.getAttribute("ufrag");
149            final String pwd = transport.getAttribute("pwd");
150            if (!Strings.isNullOrEmpty(ufrag)) {
151                mediaAttributes.put("ice-ufrag", ufrag);
152            }
153            checkNoWhitespace(ufrag, "ufrag value must not contain any whitespaces");
154            if (!Strings.isNullOrEmpty(pwd)) {
155                mediaAttributes.put("ice-pwd", pwd);
156            }
157            checkNoWhitespace(pwd, "pwd value must not contain any whitespaces");
158            mediaAttributes.put("ice-options", HARDCODED_ICE_OPTIONS);
159            final IceUdpTransportInfo.Fingerprint fingerprint = transport.getFingerprint();
160            if (fingerprint != null) {
161                mediaAttributes.put("fingerprint", fingerprint.getHash() + " " + fingerprint.getContent());
162                mediaAttributes.put("setup", fingerprint.getSetup());
163            }
164            final ImmutableList.Builder<Integer> formatBuilder = new ImmutableList.Builder<>();
165            for (RtpDescription.PayloadType payloadType : description.getPayloadTypes()) {
166                final String id = payloadType.getId();
167                if (Strings.isNullOrEmpty(id)) {
168                    throw new IllegalArgumentException("Payload type is missing id");
169                }
170                if (!isInt(id)) {
171                    throw new IllegalArgumentException("Payload id is not numeric");
172                }
173                formatBuilder.add(payloadType.getIntId());
174                mediaAttributes.put("rtpmap", payloadType.toSdpAttribute());
175                List<RtpDescription.Parameter> parameters = payloadType.getParameters();
176                if (parameters.size() > 0) {
177                    mediaAttributes.put("fmtp", RtpDescription.Parameter.toSdpString(id, parameters));
178                }
179                for (RtpDescription.FeedbackNegotiation feedbackNegotiation : payloadType.getFeedbackNegotiations()) {
180                    final String type = feedbackNegotiation.getType();
181                    final String subtype = feedbackNegotiation.getSubType();
182                    if (Strings.isNullOrEmpty(type)) {
183                        throw new IllegalArgumentException("a feedback for payload-type " + id + " negotiation is missing type");
184                    }
185                    checkNoWhitespace(type, "feedback negotiation type must not contain whitespace");
186                    mediaAttributes.put("rtcp-fb", id + " " + type + (Strings.isNullOrEmpty(subtype) ? "" : " " + subtype));
187                }
188                for (RtpDescription.FeedbackNegotiationTrrInt feedbackNegotiationTrrInt : payloadType.feedbackNegotiationTrrInts()) {
189                    mediaAttributes.put("rtcp-fb", id + " trr-int " + feedbackNegotiationTrrInt.getValue());
190                }
191            }
192
193            for (RtpDescription.FeedbackNegotiation feedbackNegotiation : description.getFeedbackNegotiations()) {
194                final String type = feedbackNegotiation.getType();
195                final String subtype = feedbackNegotiation.getSubType();
196                if (Strings.isNullOrEmpty(type)) {
197                    throw new IllegalArgumentException("a feedback negotiation is missing type");
198                }
199                checkNoWhitespace(type, "feedback negotiation type must not contain whitespace");
200                mediaAttributes.put("rtcp-fb", "* " + type + (Strings.isNullOrEmpty(subtype) ? "" : " " + subtype));
201            }
202            for (RtpDescription.FeedbackNegotiationTrrInt feedbackNegotiationTrrInt : description.feedbackNegotiationTrrInts()) {
203                mediaAttributes.put("rtcp-fb", "* trr-int " + feedbackNegotiationTrrInt.getValue());
204            }
205            for (RtpDescription.RtpHeaderExtension extension : description.getHeaderExtensions()) {
206                final String id = extension.getId();
207                final String uri = extension.getUri();
208                if (Strings.isNullOrEmpty(id)) {
209                    throw new IllegalArgumentException("A header extension is missing id");
210                }
211                checkNoWhitespace(id, "header extension id must not contain whitespace");
212                if (Strings.isNullOrEmpty(uri)) {
213                    throw new IllegalArgumentException("A header extension is missing uri");
214                }
215                checkNoWhitespace(uri, "feedback negotiation uri must not contain whitespace");
216                mediaAttributes.put("extmap", id + " " + uri);
217            }
218            for (RtpDescription.SourceGroup sourceGroup : description.getSourceGroups()) {
219                final String semantics = sourceGroup.getSemantics();
220                final List<String> groups = sourceGroup.getSsrcs();
221                if (Strings.isNullOrEmpty(semantics)) {
222                    throw new IllegalArgumentException("A SSRC group is missing semantics attribute");
223                }
224                checkNoWhitespace(semantics, "source group semantics must not contain whitespace");
225                if (groups.size() == 0) {
226                    throw new IllegalArgumentException("A SSRC group is missing SSRC ids");
227                }
228                mediaAttributes.put("ssrc-group", String.format("%s %s", semantics, Joiner.on(' ').join(groups)));
229            }
230            for (RtpDescription.Source source : description.getSources()) {
231                for (RtpDescription.Source.Parameter parameter : source.getParameters()) {
232                    final String id = source.getSsrcId();
233                    final String parameterName = parameter.getParameterName();
234                    final String parameterValue = parameter.getParameterValue();
235                    if (Strings.isNullOrEmpty(id)) {
236                        throw new IllegalArgumentException("A source specific media attribute is missing the id");
237                    }
238                    checkNoWhitespace(id, "A source specific media attributes must not contain whitespaces");
239                    if (Strings.isNullOrEmpty(parameterName)) {
240                        throw new IllegalArgumentException("A source specific media attribute is missing its name");
241                    }
242                    if (Strings.isNullOrEmpty(parameterValue)) {
243                        throw new IllegalArgumentException("A source specific media attribute is missing its value");
244                    }
245                    mediaAttributes.put("ssrc", id + " " + parameterName + ":" + parameterValue);
246                }
247            }
248
249            mediaAttributes.put("mid", name);
250
251            //random additional attributes
252            mediaAttributes.put("rtcp", "9 IN IP4 0.0.0.0");
253            mediaAttributes.put("sendrecv", "");
254            mediaAttributes.put("rtcp-mux", "");
255
256            final MediaBuilder mediaBuilder = new MediaBuilder();
257            mediaBuilder.setMedia(description.getMedia().toString().toLowerCase(Locale.ROOT));
258            mediaBuilder.setConnectionData(HARDCODED_CONNECTION);
259            mediaBuilder.setPort(HARDCODED_MEDIA_PORT);
260            mediaBuilder.setProtocol(HARDCODED_MEDIA_PROTOCOL);
261            mediaBuilder.setAttributes(mediaAttributes);
262            mediaBuilder.setFormats(formatBuilder.build());
263            mediaListBuilder.add(mediaBuilder.createMedia());
264
265        }
266        sessionDescriptionBuilder.setVersion(0);
267        sessionDescriptionBuilder.setName("-");
268        sessionDescriptionBuilder.setMedia(mediaListBuilder.build());
269        sessionDescriptionBuilder.setAttributes(attributeMap);
270
271        return sessionDescriptionBuilder.createSessionDescription();
272    }
273
274    public static String checkNoWhitespace(final String input, final String message) {
275        if (CharMatcher.whitespace().matchesAnyOf(input)) {
276            throw new IllegalArgumentException(message);
277        }
278        return input;
279    }
280
281    public static int ignorantIntParser(final String input) {
282        try {
283            return Integer.parseInt(input);
284        } catch (NumberFormatException e) {
285            return 0;
286        }
287    }
288
289    public static boolean isInt(final String input) {
290        if (input == null) {
291            return false;
292        }
293        try {
294            Integer.parseInt(input);
295            return true;
296        } catch (NumberFormatException e) {
297            return false;
298        }
299    }
300
301    public static Pair<String, String> parseAttribute(final String input) {
302        final String[] pair = input.split(":", 2);
303        if (pair.length == 2) {
304            return new Pair<>(pair[0], pair[1]);
305        } else {
306            return new Pair<>(pair[0], "");
307        }
308    }
309
310    @Override
311    public String toString() {
312        final StringBuilder s = new StringBuilder()
313                .append("v=").append(version).append(LINE_DIVIDER)
314                //TODO randomize or static
315                .append("o=- 8770656990916039506 2 IN IP4 127.0.0.1").append(LINE_DIVIDER) //what ever that means
316                .append("s=").append(name).append(LINE_DIVIDER)
317                .append("t=0 0").append(LINE_DIVIDER);
318        appendAttributes(s, attributes);
319        for (Media media : this.media) {
320            s.append("m=").append(media.media).append(' ').append(media.port).append(' ').append(media.protocol).append(' ').append(Joiner.on(' ').join(media.formats)).append(LINE_DIVIDER);
321            s.append("c=").append(media.connectionData).append(LINE_DIVIDER);
322            appendAttributes(s, media.attributes);
323        }
324        return s.toString();
325    }
326
327    public static class Media {
328        public final String media;
329        public final int port;
330        public final String protocol;
331        public final List<Integer> formats;
332        public final String connectionData;
333        public final ArrayListMultimap<String, String> attributes;
334
335        public Media(String media, int port, String protocol, List<Integer> formats, String connectionData, ArrayListMultimap<String, String> attributes) {
336            this.media = media;
337            this.port = port;
338            this.protocol = protocol;
339            this.formats = formats;
340            this.connectionData = connectionData;
341            this.attributes = attributes;
342        }
343    }
344
345}