Skip to content
LibSip_Steps.ttcn 203 KiB
Newer Older
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375
                vc_callee_From := {
                    fieldName := FROM_E,
                    addressField := vc_caller_To.addressField,
                    fromParams := vc_caller_To.toParams
                };

                vc_via := p_response.msgHeader.via;

                // Route Management
                if (isvalue(p_response.msgHeader.recordRoute)) {
                    vc_recordRoute := p_response.msgHeader.recordRoute;
                    v_nbroute := lengthof(vc_recordRoute.routeBody);
                    // copy and reverse the order of the routes in route header
                    for (i := 0; i <= (v_nbroute - 1); i := i + 1) {
                        j := v_nbroute - 1 - i;
                        vc_route.routeBody[j] := vc_recordRoute.routeBody[i];
                    }
                    vc_route.fieldName := ROUTE_E;
                    vc_boo_recordRoute := true;
                    vc_boo_route := true;
                }
                else {
                    vc_boo_recordRoute := false;
                    vc_boo_route := false;
                }


                // extentions due to new fields in PRACK and UPDATE messages
                if (isvalue(p_response.msgHeader.rSeq)) {
                    vc_rAck := {
                        fieldName := RACK_E,
                        responseNum := valueof(p_response.msgHeader.rSeq.responseNum),
                        seqNumber := valueof(p_response.msgHeader.cSeq.seqNumber),
                        method := valueof(p_response.msgHeader.cSeq.method)
                    };
                }

                // extentions due to new HistoryInfo fields 180 or 200OK messages
                if (isvalue(p_response.msgHeader.historyInfo)) {
                    vc_historyInfoList := valueof(p_response.msgHeader.historyInfo.historyInfoList);
                    vc_history_is_valid := true;
                }
                else {
                    vc_history_is_valid := false;
                }

                // sdpMessageBody answer
                if (isvalue(p_response.messageBody)) {
                    if (ischosen(p_response.messageBody.sdpMessageBody)) {
                        vc_sdp_remote := p_response.messageBody.sdpMessageBody;
                        vc_sdp_remote_is_valid := true;
                    }

                    if (ischosen(p_response.messageBody.xmlBody)) {
                        vc_xml_remote := p_response.messageBody.xmlBody;
                    }

                    if (ischosen(p_response.messageBody.mimeMessageBody)) {

                        for (j := 0; j < lengthof(p_response.messageBody.mimeMessageBody.mimeEncapsulatedList); j := j + 1) {
                            if (match(p_response.messageBody.mimeMessageBody.mimeEncapsulatedList[j].content_type, c_sdpApplication)) {
                                vc_sdp_remote := p_response.messageBody.mimeMessageBody.mimeEncapsulatedList[j].mime_encapsulated_part.sdpMessageBody;
                            }
                            if (match(p_response.messageBody.mimeMessageBody.mimeEncapsulatedList[j].content_type, c_xmlApplication)) {
                                vc_xml_remote := p_response.messageBody.mimeMessageBody.mimeEncapsulatedList[j].mime_encapsulated_part.xmlBody;
                            }
                        }
                    }
                }
            } // end function f_setHeadersOnReceiptOfResponse

            /**
             * @desc functions reads ServiceRoute header field from an incoming 200 Response message in registration
             * @param p_cSeq
             * @param p_response received response message
             */
            function f_getServiceRouteMapIntoRouteInRegistration(
                Response p_response
            ) runs on SipComponent  {
                var integer i, j, v_nbroute;
                var template(omit) ServiceRoute v_serviceRoute;

                // Route Management
                if (isvalue(p_response.msgHeader.serviceRoute.fieldName)) {////Due to ES 201 873-1/C.3.3 Better to check if fieldName of Record Route is present
                    v_serviceRoute := p_response.msgHeader.serviceRoute;
                    v_nbroute := lengthof(v_serviceRoute.routeBody);
                    // copy and reverse the order of the routes in route header
                    for (i := 0; i <= (v_nbroute - 1); i := i + 1) {
                        j := v_nbroute - 1 - i;
                        vc_route.routeBody[j] := v_serviceRoute.routeBody[i];
                    }
                    vc_route.fieldName := ROUTE_E;
                    vc_route_REG := vc_route;
                    vc_boo_route := true;
                }
            } // end function f_getServiceRouteMapIntoRouteInRegistration

            /**
             * @desc functions reads Route header field from an incoming Request message and generate RecordRoute
             * @param p_cSeq
             * @param p_request received request message
             */
            function f_getRouteMapIntoRecordRoute(
                Request p_request
            ) runs on SipComponent  {
                var integer i, j, v_nbroute;
                var template(omit) Route v_route;

                // Route Management
                if (isvalue(p_request.msgHeader.route)) {
                    v_route := p_request.msgHeader.route;
                    v_nbroute := lengthof(v_route.routeBody);
                    // copy and reverse the order of the routes in route header
                    for (i := 0; i <= (v_nbroute - 1); i := i + 1) {
                        j := v_nbroute - 1 - i;
                        vc_recordRoute.routeBody[j] := v_route.routeBody[i];
                    }
                    vc_recordRoute.fieldName := RECORD_ROUTE_E;

                    vc_boo_recordRoute := true;
                }
            } // end function f_getRouteMapIntoRecordRoute


        } // end group SetHeaders



    } // end group FieldOperations

    group SDPOperations {

        /**
         * @desc check if message body include SDP attribute (2nd parameter) for any media
         */
        function f_check_attribute(
            in SDP_Message p_sdp,
            in template SDP_attribute p_attribute
        ) runs on SipComponent 
        return boolean  {
            var integer i, j;

            if (isvalue(p_sdp.media_list)) {
                for (j := 0; j < lengthof(p_sdp.media_list); j := j + 1) {
                    if (isvalue(p_sdp.media_list[j].attributes)) {
                        for (i := 0; i < lengthof(p_sdp.media_list[j].attributes); i := i + 1) {
                            if (match(p_sdp.media_list[j].attributes[i], p_attribute)) {
                                return (true);
                            }
                        }
                    }
                }
            }
            if (isvalue(p_sdp.attributes)) {
                for (j := 0; j < lengthof(p_sdp.attributes); j := j + 1) {
                    if (match(p_sdp.attributes[j], p_attribute)) {
                        return (true);
                    }
                }
            }

            return (false);
        }

        /**
         * @desc check if message body include SDP (session level) attribute (2nd parameter) for any media
         */
        function f_check_session_attribute(
            in SDP_Message p_sdp,
            in template SDP_attribute p_attribute
        ) runs on SipComponent 
        return boolean  {
            var integer j;

            if (isvalue(p_sdp.attributes)) {
                for (j := 0; j < lengthof(p_sdp.attributes); j := j + 1) {
                    if (match(p_sdp.attributes[j], p_attribute)) {
                        return (true);
                    }
                }
            }

            return (false);
        }

        /**
         * @desc identify an SDP direction attribute (session or first media attribute) in a SDP message and return its answer value
         * @param p_sdp the SDP message that has been received
         * @param p_attribute incoming SDP attribute that need to be used for the SDP direction (answer)
         * @return the new attribute (to be send out) derived from the incoming SDP value
         * @verdict
         */
        function f_get_attribute_answer(
            in SDP_Message p_sdp,
            in template SDP_attribute p_attribute
        ) runs on SipComponent 
        return SDP_attribute  {
            var integer i, j;
            var template SDP_attribute v_attribute := p_attribute;

            // check if the selected attribute is included in the SDP offer (session attributes)
            if (isvalue(p_sdp.attributes)) {
                for (j := 0; j < lengthof(p_sdp.attributes); j := j + 1) {
                    if (match(p_sdp.attributes[j], p_attribute)) {
                        v_attribute := p_sdp.attributes[j];
                    }
                }
            }
            else
            // check if the selected attribute is included in the SDP offer (any of the media attributes)
            {
                if (isvalue(p_sdp.media_list)) {
                    for (j := 0; j < lengthof(p_sdp.media_list); j := j + 1) {
                        if (isvalue(p_sdp.media_list[j].attributes)) {
                            for (i := 0; i < lengthof(p_sdp.media_list[j].attributes); i := i + 1) {
                                if (match(p_sdp.media_list[j].attributes[i], p_attribute)) {
                                    v_attribute := p_sdp.media_list[j].attributes[i];
                                }
                            }
                        }
                    }
                }
            }

            select (valueof(v_attribute)) {
                case (mw_attribute_sendonly) {
                    return (valueof(m_attribute_recvonly));
                }
                case (mw_attribute_sendrecv) {
                    return (valueof(m_attribute_sendrecv));
                } // MRO
                case (mw_attribute_inactive) {
                    return (valueof(m_attribute_inactive));
                } // MRO
                case (mw_attribute_recvonly) {
                    return (valueof(m_attribute_sendonly));
                } // MRO
            }
            return (valueof(m_attribute_sendrecv)); // the default return value in case of missing attribute offer
        }

        /**
         * @desc check if message body include SDP bandwidth (2nd parameter) either for the session or a media description
         */
        function f_check_bandwidth(
            in SDP_Message p_loc_sdp,
            in template SDP_bandwidth p_loc_bandw
        ) runs on SipComponent 
        return boolean  {
            var integer i, j;
            if (isvalue(p_loc_sdp.bandwidth)) {
                for (j := 0; j < lengthof(p_loc_sdp.bandwidth); j := j + 1) {
                    if (match(p_loc_sdp.bandwidth[j], p_loc_bandw)) {
                        return (true);
                    }
                }
            }
            if (isvalue(p_loc_sdp.media_list)) {
                for (j := 0; j < lengthof(p_loc_sdp.media_list); j := j + 1) {
                    if (isvalue(p_loc_sdp.media_list[j].bandwidth)) {
                        for (i := 0; i < lengthof(p_loc_sdp.media_list[j].bandwidth); i := i + 1) {
                            if (match(p_loc_sdp.media_list[j].bandwidth[i], p_loc_bandw)) {
                                return (true);
                            }
                        }
                    }
                }
            }

            return (false);
        }

        /**
         * @desc check if message body include SDP media (2nd parameter)
         */
        function f_check_media(
            in SDP_Message p_loc_sdp,
            in template(present) SDP_media_desc p_loc_media
        ) runs on SipComponent 
        return boolean  {
            var integer j;
            if (isvalue(p_loc_sdp.media_list)) {
                for (j := 0; j < lengthof(p_loc_sdp.media_list); j := j + 1) {
                    if (match(p_loc_sdp.media_list[j].media_field.transport, p_loc_media.media_field.transport) and match(p_loc_sdp.media_list[j].media_field.fmts, p_loc_media.media_field.fmts)) {
                        return (true);
                    }
                }
            }
            return (false);
        }

        /**
         * @desc check if message body include precondition mechanism (a=des and a=curr) retrun true, else false
         * @param loc_sdp SDP message
         */
        function f_check_precondition(
            in SDP_Message p_loc_sdp
        ) runs on SipComponent 
        return boolean  {
            if (f_check_attribute(p_loc_sdp, mw_attribute_des) or f_check_attribute(p_loc_sdp, mw_attribute_curr)) {
                return (true);
            }

            return (false);
        }


        /**
         * @desc check if message body include SDP media direction return true, else false
         */
        function f_check_media_direction(
            in SDP_Message p_loc_sdp
        ) runs on SipComponent 
        return boolean  {

            if (f_check_attribute(p_loc_sdp, mw_attribute_sendonly) or f_check_attribute(p_loc_sdp, mw_attribute_recvonly) or f_check_attribute(p_loc_sdp, mw_attribute_sendrecv) or f_check_attribute(p_loc_sdp, mw_attribute_inactive)) {
                return (true);
            }

            return (false);
        }

        /**
         * @desc copy media/attribute lines from remote to local SDP variable
         */
        function f_check_SDP(
            integer p_loc_sdp,
            integer p_loc_codec
        ) runs on SipComponent 
        return boolean  {
            var SDP_media_desc v_media := f_prepare_media(p_loc_sdp, p_loc_codec);
            if (vc_sdp_remote.media_list[0].media_field.media != v_media.media_field.media) {
                return false;
            }
            if (vc_sdp_remote.media_list[0].media_field.transport != v_media.media_field.transport) {
                return false;
            }
            if (vc_sdp_remote.media_list[0].media_field.fmts != v_media.media_field.fmts) {
                return false;
            }

            return true;
        }

        /**
         * @desc replace the first curr media attribute with the given value.
         * @param p_sdp SDP message to modify
         * @param p_curr new curr attribute
         */
        function f_replace_curr_attribute(
            inout SDP_Message p_sdp,
            in SDP_attribute_curr p_curr
        ) {
            var integer i;
            var integer v_mn;
            if (isvalue(p_sdp.media_list)) {
                v_mn := lengthof(p_sdp.media_list[0].attributes);
                for (i := 0; i < v_mn; i := i + 1) {
                    if (ischosen(p_sdp.media_list[0].attributes[i].curr)) {
                        p_sdp.media_list[0].attributes[i].curr := p_curr;
                        i := v_mn;
                    }
                }
            }
        }

        /**
         * @desc append new media attribute to the first media description.
         * @param p_sdp SDP message to modify
         * @param p_att SDP attribute to appand
         */
        function f_append_media_attribute(
            inout SDP_Message p_sdp,
            in SDP_attribute p_att
        ) {
Yann Garcia's avatar
Yann Garcia committed
          var integer v_mn := 0;
Yann Garcia's avatar
Yann Garcia committed
              if(ispresent(p_sdp.media_list[0].attributes)) {
                v_mn := lengthof(p_sdp.media_list[0].attributes);
Yann Garcia's avatar
Yann Garcia committed
              }
              p_sdp.media_list[0].attributes[v_mn] := p_att;
            }
        }


        /**
         * @desc append new media to the existing media list in SDP
         */
        function f_append_media(
            inout SDP_Message p_loc_SDP,
            template(value) SDP_media_desc p_loc_media
        ) {
            var integer v_mn := lengthof(p_loc_SDP.media_list);
            p_loc_SDP.media_list[v_mn] := valueof(p_loc_media);
        }

Yann Garcia's avatar
Yann Garcia committed
        /**
         * @desc append new connection to the existing connection list in SDP
         */
        function f_set_connectiom(
            inout SDP_Message p_loc_SDP,
            template(value) SDP_connection p_connection
        ) {
            p_loc_SDP.connection := valueof(p_connection);
        }

2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000
        /**
         * @desc repare media/attribute lines
         */
        function f_prepare_media(
            integer p_loc_sdp,
            integer p_loc_codec
        ) runs on SipComponent 
        return SDP_media_desc  {
            var SDP_attribute_rtpmap_codec v_codecs[32] := {
                {"PCMU", "8000", omit}, {"GSM", "8000", omit}, {"G723", "8000", omit}, {"DVI4", "8000", omit}, 
                {"DVI4", "16000", omit}, {"LPC", "8000", omit}, {"PCMA", "8000", omit}, {"G722", "8000", omit},
                {"L16", "44100", "2"}, {"L16", "44100", omit}, {"QCELP", "8000", omit}, {"CN","8000", omit}, 
                {"MPA", "90000", omit}, {"G728", "8000", omit}, {"DVI4", "11025", omit}, {"DVI4", "22050", omit},
                {"G729", "8000", omit}, {"G726-40", "8000", omit}, {"G726-32", "8000", omit}, {"G726-24", "8000", omit},
                {"G726-16", "8000", omit}, {"G726D", "8000", omit}, {"G726E", "8000", omit}, {"GSM-EFR", "8000", omit},
                {"CelB", "90000", omit}, {"JPEG", "90000", omit}, {"Nv", "90000", omit}, {"H261", "90000", omit}, 
                {"MPV", "90000", omit}, {"MP2T" ,"90000", omit}, {"H263", "90000", omit}, {"H263-1998", "90000", omit}};
            var SDP_media_desc v_media := {
                    media_field := {
                        media := "audio",
                        ports := {
                            port_number := 10000,
                            num_of_ports := omit
                        },
                        transport := "RTP/AVP",
                        fmts := {"0"}
                    },  // m=audio
                        // 8500
                        // RTP/AVP
                        // 0
                    information := omit,
                    connections := omit,
                    bandwidth := omit,
                    key := omit,
                    attributes := omit
                };

            if (32 < p_loc_codec or p_loc_codec < 1) {
                log("*** " & __SCOPE__ & ": INFO: Unexpected SDP variant ***");
                setverdict(inconc);
                return (v_media);
            }

            if (p_loc_sdp == 1) {
            }
            else if (p_loc_sdp == 2) {
                v_media.media_field.fmts := {PX_SIP_SDP_DYN}; // { "98", "0" };
                v_media.attributes := {
                    {
                        rtpmap := {
                            payload_type := PX_SIP_SDP_DYN,
                            codec := v_codecs[p_loc_codec - 1]
                        }
                    }
                };
            }
            else if (p_loc_sdp == 3) {
                v_media.media_field.fmts := {"8"};
            }
            else if (p_loc_sdp == 4) {
                v_media.media_field.fmts := {"99", "8"};
                v_media.attributes := {
                        {
                        rtpmap := {
                            payload_type := "99",
                            codec := v_codecs[p_loc_codec - 1]
                        }
                    }
                };
            }
            else if (p_loc_sdp == 5) {
                v_media.media_field.media := "image";
                v_media.media_field.transport := "udptl";
                v_media.media_field.fmts := {"t38"};
            }
            else if (p_loc_sdp == 6) {
                v_media.media_field.media := "image";
                v_media.media_field.transport := "tcptl";
                v_media.media_field.fmts := {"t38"};
            }
            else {
                log("*** " & __SCOPE__ & ": INFO: Unexpected SDP variant ***");
                setverdict(inconc);
            }

            return (v_media);
        }

        /**
         * @desc repare media/attribute lines
         */
        function f_prepare_SDP(
            integer p_loc_sdp,
            integer p_loc_codec
        ) runs on SipComponent  {

            vc_sdp_local.media_list := {f_prepare_media(p_loc_sdp, p_loc_codec)};
        }

        /**
         * @desc function that copy media/attribute lines from remote to local SDP variable
         */
        function f_prepare_SDP_answer(
        ) runs on SipComponent  {
            var integer v_mn, v_cn := 0, i, j, k := 0;
            var charstring v_PT;
            var SDP_attribute_rtpmap_codec v_rtpmap := { "", "", omit};
            var SDP_attribute_list v_mediaAttributes := {};
            // increase session version
            vc_sdp_local.origin.session_version := int2str(str2int(vc_sdp_remote.origin.session_version) + 1);
            // if more than one codec, select the firs one
            v_mn := lengthof(vc_sdp_remote.media_list);
            for (i := 0; i < v_mn; i := i + 1) {
                // for every single media
                if (isvalue(vc_sdp_remote.media_list[i].attributes)) {
                    v_cn := lengthof(vc_sdp_remote.media_list[i].attributes);
                }
                if (lengthof(vc_sdp_remote.media_list[i].media_field.fmts) > 0) {
                    // select the first one
                    v_PT := vc_sdp_remote.media_list[i].media_field.fmts[0];
                    vc_sdp_local.media_list[i].media_field.fmts := {v_PT};
                    for (j := 0; j < v_cn; j := j + 1) {
                        if (ischosen(vc_sdp_remote.media_list[i].attributes[j].rtpmap)) {
                            if (v_PT == vc_sdp_remote.media_list[i].attributes[j].rtpmap.payload_type) {
                                v_rtpmap := vc_sdp_remote.media_list[i].attributes[j].rtpmap.codec;
                                v_mediaAttributes[k] := {rtpmap := {v_PT, v_rtpmap}};
                                k := k + 1;
                            } // else line is not copied
                        }
                        else {
                            // simple copy of attribute
                            v_mediaAttributes[k] := vc_sdp_remote.media_list[i].attributes[j];
                            k := k + 1;
                        }
                    }
                    vc_sdp_local.media_list[i].attributes := v_mediaAttributes;

                    if (isvalue(vc_sdp_local.media_list[i].attributes)) {
                        v_cn := lengthof(vc_sdp_local.media_list[i].attributes);
                        for (j := 0; j < v_cn; j := j + 1) {
                            // simplified handling of status attributes (copy/keep status from peer):
                            // a) copy/keep SDP_attribute_curr (invert tags if applicable)
                            if (ischosen(vc_sdp_local.media_list[i].attributes[j].curr)) {
                                // invert local/remote status tags
                                if (vc_sdp_local.media_list[i].attributes[j].curr.statusType == "local") {
                                    vc_sdp_local.media_list[i].attributes[j].curr.statusType := "remote";
                                }
                                if (vc_sdp_local.media_list[i].attributes[j].curr.statusType == "remote") {
                                    vc_sdp_local.media_list[i].attributes[j].curr.statusType := "local";
                                }
                                // invert send/recv direction tags
                                if (vc_sdp_local.media_list[i].attributes[j].curr.direction == "send") {
                                    vc_sdp_local.media_list[i].attributes[j].curr.direction := "recv";
                                }
                                if (vc_sdp_local.media_list[i].attributes[j].curr.direction == "recv") {
                                    vc_sdp_local.media_list[i].attributes[j].curr.direction := "send";
                                }
                            }
                            else
                            if (
                                // b) copy/keep SDP_attribute_des (keep strength, invert tags if applicable)
                                ischosen(vc_sdp_local.media_list[i].attributes[j].des)
                            ) {
                                // invert local/remote status tags
                                if (vc_sdp_local.media_list[i].attributes[j].des.statusType == "local") {
                                    vc_sdp_local.media_list[i].attributes[j].des.statusType := "remote";
                                }
                                if (vc_sdp_local.media_list[i].attributes[j].des.statusType == "remote") {
                                    vc_sdp_local.media_list[i].attributes[j].des.statusType := "local";
                                }
                                // invert send/recv direction tags
                                if (vc_sdp_local.media_list[i].attributes[j].des.direction == "send") {
                                    vc_sdp_local.media_list[i].attributes[j].des.direction := "recv";
                                }
                                if (vc_sdp_local.media_list[i].attributes[j].des.direction == "recv") {
                                    vc_sdp_local.media_list[i].attributes[j].des.direction := "send";
                                }
                            }
                            else
                            if (
                                // c) simplification: assume no SDP_attribute_conf
                                ischosen(vc_sdp_local.media_list[i].attributes[j].conf)
                            ) {
                                // handle SDP_attribute_conf
                            }
                        }
                    }
                }
            }
        // add handling of prenegotiation, change ports if required etc.
        // if prenegotiation...
        }

        /**
         * @desc reject SDP offer by setting media ports to 0
         */
        function f_reject_SDP_offer(
        ) runs on SipComponent  {
            var integer mn, i;
            f_copy_SDP(); // TO BE DONE with more details!
            // increase session version
            vc_sdp_local.origin.session_version := int2str(str2int(vc_sdp_local.origin.session_version) + 1);
            // if more than one codec, select the firs one
            mn := lengthof(vc_sdp_local.media_list);
            for (i := 0; i < mn; i := i + 1) {
                vc_sdp_local.media_list[i].media_field.ports := {0, omit};
                vc_sdp_local.media_list[i].attributes := omit; // {};
            }
        }

        /**
         * @desc copies SDP message elements from remote to local component variable: - bandwidth - session version (will be incremented) - media list modify the direction attribute of an SDP media list entry within an SDP message (vc_sdp_local)
         * @param p_medianum list position number of the media (if value 0 identifies first media list element)
         * @param p_direction the new direction attribute to be included in the media entry
         * @verdict
         */
        function f_SIP_modMediaDirection(
            integer p_medianum,
            template(value) SDP_attribute p_direction
        ) runs on SipComponent  {
            var boolean v_set_direction;

            // flag indicates if direction attribute has been modified
            var integer v_mn := 0;

            // length of media list (number of entries)
            var integer v_cn := 0;

            // number of attributes of a media entry
            var integer i, j, k := 0;
            var SDP_attribute_list v_mediaAttributes := {};
            // collect the media attributes (to be assigned at end of function)
            f_copy_SDP(); // copy SDP session bandwidth and media list from remote to local component variable
            // increment session version
            vc_sdp_local.origin.session_version := int2str(str2int(vc_sdp_local.origin.session_version) + 1);

            // if more than one codec, select the first one
            v_mn := lengthof(vc_sdp_local.media_list);

            if (p_medianum == 0)
            // specific media requested
            {
                p_medianum := 1; // start checking from first media
            }
            if (p_medianum > 0)
            // specific media requested
            {
                if (not (p_medianum > v_mn)) {
                    v_mn := p_medianum;
                }
            }

            // handling of media list elements
            for (i := 0; i < v_mn; i := i + 1) {
                v_cn := 0; // initialize the number of attributes of the media list entry
                if (isvalue(vc_sdp_local.media_list))
                // media_list is optional
                {
                    // log("vc_sdp_local.media_list[i ] ",vc_sdp_local.media_list[i ] );
                    if (isvalue(vc_sdp_local.media_list[i].attributes)) {
                        v_cn := lengthof(vc_sdp_local.media_list[i].attributes);
                    }

                    v_set_direction := false;

                    // if (lengthof(vc_sdp_local.media_list[i ] .media_field.fmts)>1)
                    // select the first one
                    for (j := 0; j < v_cn; j := j + 1) {
                        if (ischosen(vc_sdp_local.media_list[i].attributes[j].recvonly) or ischosen(vc_sdp_local.media_list[i].attributes[j].sendonly) or ischosen(vc_sdp_local.media_list[i].attributes[j].inactive) or ischosen(vc_sdp_local.media_list[i].attributes[j].sendrecv)) {
                            v_mediaAttributes[k] := valueof(p_direction);
                            v_set_direction := true;
                        }
                        else
                        // non-direction attributes will be copied
                        {
                            v_mediaAttributes[k] := vc_sdp_local.media_list[i].attributes[j];
                        }
                        k := k + 1;
                    }

                    if (not v_set_direction) {
                        v_mediaAttributes[k] := valueof(p_direction);
                    }
                    vc_sdp_local.media_list[i].attributes := v_mediaAttributes;
                    // }
                }
            }
        // add handling of prenegotiation, change ports if required etc.
        // if prenegotiation...
        }

        /**
         * @desc modify session and media attributes direction
         */
        function f_SIP_modSessionDirection(
            template(value) SDP_attribute p_direction
        ) runs on SipComponent  {
            var boolean v_set_direction := false;
            var integer v_mn := 0, i := 0;

            if (isvalue(vc_sdp_local.attributes)) {
                v_mn := lengthof(vc_sdp_local.attributes);

                for (i := 0; i < v_mn; i := i + 1) {
                    // for every single attribute (that is not omit)
                    if (ischosen(vc_sdp_local.attributes[i].recvonly) or ischosen(vc_sdp_local.attributes[i].sendonly) or ischosen(vc_sdp_local.attributes[i].inactive) or ischosen(vc_sdp_local.attributes[i].sendrecv)) {
                        vc_sdp_local.attributes[i] := valueof(p_direction);
                        v_set_direction := true;
                    }
                }
                if (not v_set_direction)
                // if not sent before
                {
                    vc_sdp_local.attributes[v_mn] := valueof(p_direction);
                }
            }
            else {
                vc_sdp_local.attributes[0] := valueof(p_direction);
            }
        }

        /**
         * @desc check (from remote) and set (local) the session/media attribute lines on directions
         * @param p_direction_in incoming SDP attribute that need to be checked
         * @param p_direction_out SDP attribute that should be included in the SDP answer (to be returned to peer)
         * @return
         * @verdict
         */
        function f_SIP_checksetSDPreqDirection(
            template(value) SDP_attribute p_direction_in,
            template(value) SDP_attribute p_direction_out
        ) runs on SipComponent  {
            var template(value) SDP_attribute v_direction_out := p_direction_out;
            // check incoming SDP attribute
            if (not (isvalue(vc_request.messageBody) and (f_check_attribute(vc_request.messageBody.sdpMessageBody, p_direction_in)))) {
                if (match(valueof(p_direction_in), mw_attribute_sendrecv) and not (f_check_attribute(vc_request.messageBody.sdpMessageBody, mw_attribute_sendrecv) or f_check_attribute(vc_request.messageBody.sdpMessageBody, mw_attribute_sendonly) or f_check_attribute(vc_request.messageBody.sdpMessageBody, mw_attribute_recvonly) or f_check_attribute(vc_request.messageBody.sdpMessageBody, mw_attribute_inactive))) {
                    log("*** " &__SCOPE__& ": INFO: no direction attributes with expectation: ", p_direction_in, " ***");
                }
                else {
                    setverdict(fail);
                }
            }
            else {
                setverdict(pass);
                log("*** " &__SCOPE__& ": INFO: attribute found in message body ***");
            }
            if (not(isbound(p_direction_out)))
            // STF549 if (match(omit, p_direction_out))
            {
                v_direction_out := f_get_attribute_answer(vc_request.messageBody.sdpMessageBody, p_direction_in);
            }
            f_SIP_modMediaDirection(1, v_direction_out); // handling of attribute in media description
            f_SIP_modSessionDirection(v_direction_out); // handling of attribute in session
        }

        /*
     *
     * @desc check (from remote) and set (local) the session/media attribute lines on directions
     * @param p_direction_in incoming SDP attribute that need to be checked
     * @param p_direction_out SDP attribute that should be included in the SDP answer (to be returned to peer)
     * @return
     * @verdict
     */
        function f_SIP_checkResponsesetSDPreqDirection(
            template(value) SDP_attribute p_direction_in,
            template(value) SDP_attribute p_direction_out
        ) runs on SipComponent  {
            var template(value) SDP_attribute v_direction_out := p_direction_out;
            // check incoming SDP attribute
            if (not (isvalue(vc_response.messageBody) and (f_check_attribute(vc_response.messageBody.sdpMessageBody, p_direction_in)))) {
                if (match(valueof(p_direction_in), mw_attribute_sendrecv) and not (f_check_attribute(vc_response.messageBody.sdpMessageBody, mw_attribute_sendrecv) or f_check_attribute(vc_response.messageBody.sdpMessageBody, mw_attribute_sendonly) or f_check_attribute(vc_response.messageBody.sdpMessageBody, mw_attribute_recvonly) or f_check_attribute(vc_response.messageBody.sdpMessageBody, mw_attribute_inactive))) {
                    log("*** " &__SCOPE__& ": INFO: no direction attributes with expectation: ", p_direction_in, " ***");
                }
                else {
                    setverdict(fail);
                }
            }
            else {
                setverdict(pass);
                log("*** " &__SCOPE__& ": INFO: attribute found in message body ***");
            }
            if (not(isbound(p_direction_out)))
            // STF549 if (match(omit, p_direction_out))
            {
                v_direction_out := f_get_attribute_answer(vc_response.messageBody.sdpMessageBody, p_direction_in);
            }
            f_SIP_modMediaDirection(1, v_direction_out); // handling of attribute in media description
            f_SIP_modSessionDirection(v_direction_out); // handling of attribute in session
        }

        /*
     *
     * @desc check (from remote) and set (local) the session attribute lines on directions
     * @param p_direction_in incoming SDP attribute that need to be checked
     * @param p_direction_out SDP attribute that should be included in the SDP answer (to be returned to peer)
     * @return
     * @verdict
     */
        function f_SIP_checksetSDPreqDirectionSession(
            template(value) SDP_attribute p_direction_in,
            template(value) SDP_attribute p_direction_out
        ) runs on SipComponent  {
            var template(value) SDP_attribute v_direction_out := p_direction_out;
            // check incoming SDP attribute
            if (not (isvalue(vc_request.messageBody) and (f_check_session_attribute(vc_request.messageBody.sdpMessageBody, p_direction_in)))) {
                if (match(valueof(p_direction_in), mw_attribute_sendrecv) and not (f_check_session_attribute(vc_request.messageBody.sdpMessageBody, mw_attribute_sendrecv) or f_check_session_attribute(vc_request.messageBody.sdpMessageBody, mw_attribute_sendonly) or f_check_session_attribute(vc_request.messageBody.sdpMessageBody, mw_attribute_recvonly) or f_check_session_attribute(vc_request.messageBody.sdpMessageBody, mw_attribute_inactive))) {
                    log("*** " &__SCOPE__& ": INFO: no direction attributes with expectation: ", p_direction_in, " ***");
                }
                else {
                    setverdict(fail);
                }
            }
            if (not(isbound(p_direction_out)))
            // STF549 if (match(omit, p_direction_out))
            {
                v_direction_out := f_get_attribute_answer(vc_request.messageBody.sdpMessageBody, p_direction_in);
            }
            f_SIP_modSessionDirection(v_direction_out); // handling of attribute in session
        }

        /*
     *
     * @desc check (from remote) and set (local) the session attribute lines on directions
     * @param p_direction_in incoming SDP attribute that need to be checked
     * @param p_direction_out SDP attribute that should be included in the SDP answer (to be returned to peer)
     * @return
     * @verdict
     */
        function f_SIP_checkResponsesetSDPreqDirectionSession(
            template(value) SDP_attribute p_direction_in,
            template(value) SDP_attribute p_direction_out
        ) runs on SipComponent  {
            var template(value) SDP_attribute v_direction_out := p_direction_out;
            // check incoming SDP attribute
            if (not (isvalue(vc_response.messageBody) and (f_check_session_attribute(vc_response.messageBody.sdpMessageBody, p_direction_in)))) {
                if (match(valueof(p_direction_in), mw_attribute_sendrecv) and not (f_check_session_attribute(vc_response.messageBody.sdpMessageBody, mw_attribute_sendrecv) or f_check_session_attribute(vc_response.messageBody.sdpMessageBody, mw_attribute_sendonly) or f_check_session_attribute(vc_response.messageBody.sdpMessageBody, mw_attribute_recvonly) or f_check_session_attribute(vc_response.messageBody.sdpMessageBody, mw_attribute_inactive))) {
                    log("*** " &__SCOPE__& ": INFO: no direction attributes with expectation: ", p_direction_in, " ***");
                }
                else {
                    setverdict(fail);
                }
            }
            if (not(isbound(p_direction_out)))
            // STF549 if (match(omit, p_direction_out))
            {
                v_direction_out := f_get_attribute_answer(vc_response.messageBody.sdpMessageBody, p_direction_in);
            }
            f_SIP_modSessionDirection(v_direction_out); // handling of attribute in session
        }


        /*
        *
        * @desc check (from remote) and set (local)the session/media attribute lines on directions
        * @param p_direction_in attribute to be check
        * @param p_direction_out attrubyte to be
        * @return
        * @verdict
        */
        function f_SIP_checkSDPrespDirection(
            template SDP_attribute p_direction_in
        ) runs on SipComponent  {
            // check incoming SDP attribute
            if (not (isvalue(vc_response.messageBody) and f_check_attribute(vc_response.messageBody.sdpMessageBody, p_direction_in))) {
                setverdict(fail);
            }
        }

        /**
         * @desc check media/attribute lines from remote
         */
        function f_SIP_checkMediaDirection(
            integer p_medianum,
            template SDP_attribute p_direction
        ) runs on SipComponent 
        return boolean  {
            var integer v_mn, v_cn := 0, i, j;
            var boolean v_result := false;
            // increase session version
            vc_sdp_remote.origin.session_version := int2str(str2int(vc_sdp_remote.origin.session_version) + 1);
            // if more than one codec, select the firs one
            v_mn := lengthof(vc_sdp_remote.media_list);
            if (p_medianum == 0)
            // specific media requested
            {
                p_medianum := 1; // start checking from first media
            }
            if (p_medianum > 0)
            // specific media requested
            {
                if (p_medianum > v_mn) {
                    return false;
                }
                else {
                    v_mn := p_medianum;
                }
            }
            for (i := p_medianum - 1; i < v_mn; i := i + 1) {
                // for every single media
                if (isvalue(vc_sdp_remote.media_list[i].attributes)) {
                    v_cn := lengthof(vc_sdp_remote.media_list[i].attributes);
                }
                if (lengthof(vc_sdp_remote.media_list[i].attributes) > 0) {
                    // select the first one
                    for (j := 0; j < lengthof(vc_sdp_remote.media_list[i].attributes); j := j + 1) {
                        if (ischosen(vc_sdp_remote.media_list[i].attributes[j].recvonly) or ischosen(vc_sdp_remote.media_list[i].attributes[j].sendonly) or ischosen(vc_sdp_remote.media_list[i].attributes[j].inactive) or ischosen(vc_sdp_remote.media_list[i].attributes[j].sendrecv)) {
                            if (match(vc_sdp_remote.media_list[i].attributes[j], p_direction)) {
                                v_result := true;
                            }
                            else {
                                return false;
                            }
                        }
                    }
                }
            }
            return v_result;
        }

        /**
         * @desc copy media/attribute lines from remote to local SDP variable
         */
        function f_copy_SDP(
        ) runs on SipComponent  {
            if (isvalue(vc_sdp_remote.connection)) {
                vc_sdp_local.connection := vc_sdp_remote.connection;
            }
            else {
                vc_sdp_local.connection := omit;
            }

            vc_sdp_local.origin := vc_sdp_remote.origin;
            vc_sdp_local.session_name := vc_sdp_remote.session_name;

            if (isvalue(vc_sdp_remote.bandwidth)) {
                vc_sdp_local.bandwidth := vc_sdp_remote.bandwidth;
            }
            else {
                vc_sdp_local.bandwidth := {};
            }

            if (isvalue(vc_sdp_remote.media_list)) {
                // // cleaning of media before assignment
                // if (isvalue(vc_sdp_local.media_list))
                // {
                //                      for (var integer i:=0; i<lengthof(vc_sdp_local.media_list); i:=i+1)
                // {
                // vc_sdp_local.media_list[i ] := omit ;
                // }
                // };
                vc_sdp_local.media_list := vc_sdp_remote.media_list;
            }
        }


    } // end group SDPOperations

    group AwaitingMessage {

        /**
         * @desc Function for time delay
         */
        function f_awaitingDelayTimer(
            float p_delay
        ) runs on SipComponent  {
            tc_tDelay.start(p_delay);
            alt {
                [] tc_tDelay.timeout {
                    setverdict(pass);
                }
            }
        } // end f_awaitingDelayTimer

        /**
         * @desc Function waiting for any MSG -request/response
         */
        function f_awaitingAnyPassOnTimeout(
        ) runs on SipComponent  {
            tc_wait.start(PX_SIP_TWAIT);
            alt {
                [] SIPP.receive
                {
                    tc_wait.stop;
                    vc_boo_response := true;
                    vc_boo_request := true;
                // setverdict(pass)
                }
                [] tc_wait.timeout {
                    vc_boo_response := false;
                    vc_boo_request := false;
                // setverdict (pass)
                }
            }
        } // end f_awaitingResponsePassOnTimeout