diff --git a/marked/Rel-18/26_series/26101/1d27fed9c01eb99f6535283f35fe3bbf_img.jpg b/marked/Rel-18/26_series/26101/1d27fed9c01eb99f6535283f35fe3bbf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7f542770bc0dadedbfa0df287d931bc9984341d9 --- /dev/null +++ b/marked/Rel-18/26_series/26101/1d27fed9c01eb99f6535283f35fe3bbf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:02054314e2e8972ff54a099876329ec12d2b8e1964b0ab0e03aba5ac3a8ed333 +size 50765 diff --git a/marked/Rel-18/26_series/26101/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/26_series/26101/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fb0ddc62223d3a0a39f5769a7e23b803146a5793 --- /dev/null +++ b/marked/Rel-18/26_series/26101/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:35be4edbc2604643c32dcc4cd6fe843ce831969752ede2babffc93aba7014eb4 +size 8501 diff --git a/marked/Rel-18/26_series/26101/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/26_series/26101/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a97a7b97257e8726be4c6c81b9e808c859de074d --- /dev/null +++ b/marked/Rel-18/26_series/26101/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:31040127108731526ec8b56f7a4f10db53ce9a3d0b31fb0007509013b391bff5 +size 5669 diff --git a/marked/Rel-18/26_series/26101/ddc7460821484f1ae2835c67955c554c_img.jpg b/marked/Rel-18/26_series/26101/ddc7460821484f1ae2835c67955c554c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c36258e411910e959a4fed821e0172e043806324 --- /dev/null +++ b/marked/Rel-18/26_series/26101/ddc7460821484f1ae2835c67955c554c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2aedab4b4f105a5783d9261beeba8f4b6b2478556f6b7b2d2c8165a4e5d3bd34 +size 32020 diff --git a/marked/Rel-18/26_series/26101/raw.md b/marked/Rel-18/26_series/26101/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9c0e1c61d9bed092332942536b2b4a2ec644cdf5 --- /dev/null +++ b/marked/Rel-18/26_series/26101/raw.md @@ -0,0 +1,732 @@ + + +# 3GPP TS 26.101 V18.0.0 (2024-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Mandatory speech codec speech processing functions; Adaptive Multi-Rate (AMR) speech codec frame structure (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The logo for 3GPP, featuring the letters '3GPP' in a stylized font with a red signal wave icon below the 'P'. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|-----------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and Abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 5 | +| 4 AMR codec frame format (AMR IF1)..... | 6 | +| 4.1 AMR Header and AMR Auxiliary Information ..... | 6 | +| 4.1.1 Frame Type, Mode Indication, and Mode Request ..... | 6 | +| 4.1.2 Frame Quality Indicator ..... | 7 | +| 4.1.3 Mapping to TX_TYPE and RX_TYPE..... | 7 | +| 4.1.4 Codec CRC ..... | 8 | +| 4.2 AMR Core Frame..... | 8 | +| 4.2.1 AMR Core Frame with speech bits: Bit ordering..... | 8 | +| 4.2.2 AMR Core Frame with speech bits: Class division..... | 9 | +| 4.2.3 AMR Core Frame with comfort noise bits ..... | 9 | +| 4.3 AMR frame composition..... | 10 | +| 4.4 GSM-EFR Frame Composition..... | 11 | +| 4.4.1 GSM-EFR Frame with speech bits..... | 12 | +| 4.4.2 GSM-EFR Frame with comfort noise bits..... | 12 | +| Annex A (informative): AMR Interface Format 2 (with octet alignment) ..... | 13 | +| Annex B (normative): Tables for AMR Core Frame bit ordering..... | 17 | +| Annex C (informative): Change history..... | 20 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes a generic frame format for the Adaptive Multi-Rate (AMR) speech codec and the Enhanced Full Rate (GSM-EFR) speech codec. This format shall be used as a common reference point when interfacing speech frames between different elements of the 3G system and between different systems. Appropriate mappings to and from this generic frame format will be used within and between each system element. + +Annex A describes a second frame format which shall be used when octet alignment of AMR frames is required. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] TS 26.090: "AMR Speech Codec; Speech Transcoding Functions". +- [2] TS 26.093: "AMR Speech Codec; Source Controlled Rate Operation". +- [3] TS 26.092: "AMR Speech Codec; Comfort Noise Aspects". +- [4] TS 46.060: "EFR Speech Codec; Speech Transcoding Functions". +- [5] TS 46.062: "EFR Speech Codec; Comfort Noise Aspects". + +# --- 3 Definitions and Abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply: + +**AMR mode:** one of the eight AMR codec bit-rates denoted also with indices 0 to 7 where 0 maps to the 4.75 kbit/s mode and 7 maps to the 12.2 kbit/s mode. + +**AMR codec mode:** same as AMR mode. + +**RX\_TYPE:** classification of the received frame as defined in [2]. + +**TX\_TYPE:** classification of the transmitted frame as defined in [2]. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|-----|----------------------------------------| +| CRC | Cyclic Redundancy Check | +| FQI | Frame Quality Indicator | +| GSM | Global System for Mobile communication | +| LSB | Least Significant Bit | + +| | | +|------|------------------------------------------------| +| MSB | Most Significant Bit | +| RX | Receive | +| PDC | Personal Digital Communication (ARIB standard) | +| SCR | Source Controlled Rate operation | +| SID | Silence Descriptor (Comfort Noise Frame) | +| TDMA | Time Division Multiple Access (IS-641) | +| TX | Transmit | + +# 4 AMR codec frame format (AMR IF1) + +This clause describes the generic frame format for both the speech and comfort noise frames of the AMR speech codec. This format is referred to as AMR Interface Format 1 (AMR IF1). Annex A describes AMR Interface Format 2 (AMR IF2). + +Each AMR codec mode follows the generic frame structure depicted in figure 1. The frame is divided into three parts: AMR Header, AMR Auxiliary Information, and AMR Core Frame. The AMR Header part includes the Frame Type and the Frame Quality Indicator fields. The AMR auxiliary information part includes the Mode Indication, Mode Request, and Codec CRC fields. The AMR Core Frame part consists of the speech parameter bits or, in case of a comfort noise frame, the comfort noise parameter bits. In case of a comfort noise frame, the comfort noise parameters replace Class A bits of AMR Core Frame while Class B and C bits are omitted. + +![Figure 1: Generic AMR frame structure diagram showing the hierarchy of fields: AMR Header (Frame Type, Frame Quality Indicator), AMR Auxiliary Information (Mode Indication, Mode Request, Codec CRC), and AMR Core Frame (Class A, B, and C bits).](1d27fed9c01eb99f6535283f35fe3bbf_img.jpg) + +| | | | | | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---------------------------------|--------------------------|-----------------------|--------------------|--------------|--------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------| +|
Frame Type (4 bits)
Frame Quality Indicator (1 bit)
Mode Indication (3 bits)
Mode Request (3 bits)
Codec CRC (8 bits)
Class A bits
Class B bits
Class C bits
| Frame Type (4 bits) | Frame Quality Indicator (1 bit) | Mode Indication (3 bits) | Mode Request (3 bits) | Codec CRC (8 bits) | Class A bits | Class B bits | Class C bits | AMR Header

AMR Auxiliary Information
(for Mode Adaptation, and Error Detection)

AMR Core Frame (speech or comfort noise data) | +| Frame Type (4 bits) | | | | | | | | | | +| Frame Quality Indicator (1 bit) | | | | | | | | | | +| Mode Indication (3 bits) | | | | | | | | | | +| Mode Request (3 bits) | | | | | | | | | | +| Codec CRC (8 bits) | | | | | | | | | | +| Class A bits | | | | | | | | | | +| Class B bits | | | | | | | | | | +| Class C bits | | | | | | | | | | + +Figure 1: Generic AMR frame structure diagram showing the hierarchy of fields: AMR Header (Frame Type, Frame Quality Indicator), AMR Auxiliary Information (Mode Indication, Mode Request, Codec CRC), and AMR Core Frame (Class A, B, and C bits). + +Figure 1: Generic AMR frame structure + +## 4.1 AMR Header and AMR Auxiliary Information + +This subclause describes the AMR Header of figure 1. + +### 4.1.1 Frame Type, Mode Indication, and Mode Request + +Table 1a defines the 4-bit Frame Type field. Frame Type can indicate the use of one of the eight AMR codec modes, one of four different comfort noise frames, or an empty frame. In addition, three Frame Type Indices are reserved for future use. The same table is reused for the Mode Indication and Mode Request fields which are 3-bit fields each and are defined only in the range 0...7 to specify one of the eight AMR codec modes. + +**Table 1a: Interpretation of Frame Type, Mode Indication and Mode Request fields** + +| Frame Type | Mode Indication | Mode Request | Frame content (AMR mode, comfort noise, or other) | +|------------|-----------------|--------------|---------------------------------------------------| +| 0 | 0 | 0 | AMR 4,75 kbit/s | +| 1 | 1 | 1 | AMR 5,15 kbit/s | +| 2 | 2 | 2 | AMR 5,90 kbit/s | +| 3 | 3 | 3 | AMR 6,70 kbit/s (PDC-EFR) | +| 4 | 4 | 4 | AMR 7,40 kbit/s (TDMA-EFR) | +| 5 | 5 | 5 | AMR 7,95 kbit/s | +| 6 | 6 | 6 | AMR 10,2 kbit/s | +| 7 | 7 | 7 | AMR 12,2 kbit/s (GSM-EFR) | +| 8 | - | - | AMR SID | +| 9 | - | - | GSM-EFR SID | +| 10 | - | - | TDMA-EFR SID | +| 11 | - | - | PDC-EFR SID | +| 12-14 | - | - | For future use | +| 15 | - | - | No Data (No transmission/No reception) | + +### 4.1.2 Frame Quality Indicator + +The content of the Frame Quality Indicator field is defined in Table 1b. The field length is one bit. The Frame Quality Indicator indicates whether the data in the frame contains errors. + +**Table 1b: Definition of Frame Quality Indicator** + +| Frame Quality Indicator (FQI) | Quality of data | +|-------------------------------|--------------------------------------------------------------------------------| +| 0 | Bad frame or Corrupted frame
(bits may be used to assist error concealment) | +| 1 | Good frame | + +### 4.1.3 Mapping to TX\_TYPE and RX\_TYPE + +Table 1c shows how the AMR Header data (FQI and Frame Type) maps to the TX\_TYPE and RX\_TYPE frames defined in [2]. + +**Table 1c: Mapping of Frame Quality Indicator and Frame Type to TX\_TYPE and RX\_TYPE [2], respectively** + +| Frame Quality Indicator | Frame Type Index | TX_TYPE or RX_TYPE | Comment | +|-------------------------|------------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| 1 | 0-7 | SPEECH_GOOD | The specific Frame Type Index depends on the bit-rate being used. | +| 0 | 0-7 | SPEECH_BAD | The specific Frame Type Index depends on the bit-rate being used. The corrupted data may be used to assist error concealment. | +| 1 | 8 | SID_FIRST or SID_UPDATE | For AMR: SID_FIRST and SID_UPDATE are differentiated using one Class A bit: STI. | +| 0 | 8 | SID_BAD | For AMR | +| 1 | 9 | GSM-EFR SID | For GSM-EFR | +| 0 | 9 | GSM-EFR SID_BAD | For GSM-EFR | +| 1 | 10-11 | SID_UPDATE | For TDMA-EFR and PDC-EFR | +| 0 | 10-11 | SID_BAD | For TDMA-EFR and PDC-EFR | +| 1 | 15 | NO_DATA | Typically a non-transmitted frame or an erased or stolen frame with no data usable to assist error concealment. | + +### 4.1.4 Codec CRC + +Generic AMR codec frames with Frame Type 0.11 are associated with an 8-bit CRC for error-detection purposes. The Codec CRC field of AMR Auxiliary Information in figure 1 contains the value of this CRC. These eight parity bits are generated by the cyclic generator polynomial: + +$$- G(x)=D^8+D^6+D^5+D^4+1$$ + +which is computed over all Class A bits of AMR Core Frame. Class A bits for Frame Types 0.7 are defined in subclause 4.2.2 (for speech bits) and for Frame Types 8.11 in subclause 4.2.3 (for comfort noise bits). + +When Frame Type Index of table 1a is 15 the CRC field is not included in the Generic AMR frame. + +## 4.2 AMR Core Frame + +This subclause contains the description of AMR Core Frame of figure 1. The descriptions for AMR Core Frame with speech bits and with comfort noise bit are given separately. + +### 4.2.1 AMR Core Frame with speech bits: Bit ordering + +This subclause describes how AMR Core Frame carries the coded speech data. The bits produced by the speech encoder are denoted as $\{s(1),s(2),\dots,s(K)\}$ , where $K$ refers to the number of bits produced by the speech encoder as shown in table 2. The notation $s(i)$ follows that of [1]. The speech encoder output bits are ordered according to their subjective importance. This bit ordering can be utilized for error protection purposes when the speech data is, for example, carried over a radio interface. Tables B.1 to B.8 in Annex B define the AMR IF1 bit ordering for all the eight AMR codec modes. In these tables the speech bits are numbered in the order they are produced by the corresponding speech encoder as described in the relevant tables of TS 26.090 [1]. The reordered bits are denoted below, in the order of decreasing importance, as $\{d(0),d(1),\dots,d(K-1)\}$ . + +The ordering algorithm is described in pseudo code as: + +- for $j = 0$ to $K-1$ +- $d(j) := s(table_m(j)+1)$ ; + +where $table_m(j)$ refers to the relevant table in Annex B depending on the AMR mode $m=0..7$ . The Annex B tables should be read line by line from left to right. The first element of the table has the index 0. + +### 4.2.2 AMR Core Frame with speech bits: Class division + +The reordered bits are further divided into three indicative classes according to their subjective importance. This class division is only informative and provides supporting information for mapping this generic format into specific formats. The three different importance classes can then be subject to different error protection in the network. + +The importance classes are Class A, Class B, and Class C. Class A contains the bits most sensitive to errors and any error in these bits typically results in a corrupted speech frame which should not be decoded without applying appropriate error concealment. This class is protected by the Codec CRC in AMR Auxiliary Information. Classes B and C contain bits where increasing error rates gradually reduce the speech quality, but decoding of an erroneous speech frame is usually possible without annoying artefacts. Class B bits are more sensitive to errors than Class C bits. The importance ordering applies also within the three different classes and there are no significant step-wise changes in subjective importance between neighbouring bits at the class borders. + +The number of speech bits in each class (Class A, Class B, and Class C) for each AMR mode is shown in table 2. The classification in table 2 and the importance ordering $d(j)$ , together, are sufficient to assign all speech bits to their correct classes. For example, when the AMR codec mode is 4,75, then the Class A bits are $d(0)..d(41)$ , Class B bits are $d(42)..d(94)$ , and there are no Class C bits. + +**Table 2: Number of bits in Classes A, B, and C for each AMR codec mode** + +| Frame Type | AMR codec mode | Total number of bits | Class A | Class B | Class C | +|------------|----------------|----------------------|---------|---------|---------| +| 0 | 4,75 | 95 | 42 | 53 | 0 | +| 1 | 5,15 | 103 | 49 | 54 | 0 | +| 2 | 5,90 | 118 | 55 | 63 | 0 | +| 3 | 6,70 | 134 | 58 | 76 | 0 | +| 4 | 7,40 | 148 | 61 | 87 | 0 | +| 5 | 7,95 | 159 | 75 | 84 | 0 | +| 6 | 10,2 | 204 | 65 | 99 | 40 | +| 7 | 12,2 | 244 | 81 | 103 | 60 | + +### 4.2.3 AMR Core Frame with comfort noise bits + +The AMR Core Frame content for the additional frame type with Frame Type Index 8 in table 1a is described in this subclause. This consists of the frame related to Source Controlled Rate Operation specified in [2]. + +The data content (comfort noise bits) of the additional frame types is carried in AMR Core Frame. The comfort noise bits are all mapped to Class A of AMR Core Frame and Classes B and C are not used. This is a notation convention only and the class division has no meaning for comfort noise bits. + +The number of bits in each class (Class A, Class B, and Class C) for the AMR comfort noise bits (Frame Type Index 8) is shown in table 3. The contents of SID\_UPDATE and SID\_FIRST are divided into three parts (SID Type Indicator (STI), Mode Indication ( $mi(i)$ ), and Comfort Noise Parameters ( $s(i)$ ) as defined in [2]. In case of SID\_FIRST the Comfort Noise Parameters bits ( $s(i)$ ) shall be set to "0". + +The comfort noise parameter bits produced by the AMR speech encoder are denoted as $s(i) = \{s(1), s(2), \dots, s(35)\}$ . The notation $s(i)$ follows that of [3]. These bits are numbered in the order they are produced by the AMR encoder without any reordering. These bits are followed by the SID Type Indicator **STI** and the Mode Indication $mi(i) = \{mi(0), mi(1), mi(2)\} = \{LSB .. MSB\}$ . Thus, the AMR SID or comfort noise bits $\{d(0), d(1), \dots, d(38)\}$ are formed as defined by the pseudo code below. + +- for $j = 0$ to 34; +- $d(j) := s(j+1)$ ; +- $d(35) := STI$ ; +- for $j = 36$ to 38; +- $d(j) := mi(j-36)$ . Note: This mapping is different to the usual mapping: LSB first. + +Note: The alternative would be: $d(j) := m_i(38-j)$ : MSB first. + +**Table 3. Bit classification for Frame Type 8 (AMR SID)** + +| Frame Type Index | FQI | AMR TX_TYPE or RX_TYPE | Total number of bits | Class A | | | Class B | Class C | +|------------------|-----|------------------------|----------------------|--------------------------|--------------------------|--------------------------------|---------|---------| +| | | | | SID Type Indicator (STI) | Mode Indication $m_i(i)$ | Comfort Noise Parameter $s(i)$ | | | +| 8 | 1 | SID_UPDATE | 39 | 1 (= "1") | 3 | 35 | 0 | 0 | +| 8 | 1 | SID_FIRST | 39 | 1 (= "0") | 3 | 35 (= "0") | 0 | 0 | +| 8 | 0 | SID_BAD | 39 | 1 | 3 | 35 | 0 | 0 | + +The number of bits in each class (Class A, Class B, and Class C) for the comfort noise bits of Frame Types 9-11 is shown in Table 7. + +**Table 4: void** + +## 4.3 AMR frame composition + +The generic AMR frame is formed as a concatenation of AMR Header, AMR Auxiliary Information and the AMR Core Frame, in this order. The MSB of the Frame Type is placed in bit 8 of the first octet (see example in table 5 below), the LSB of the Frame Type is placed in bit 5. Then the next parameter follows, which is the Frame Quality Indicator, and so on. Between Mode Request and Codec CRC five spare bits are inserted to align the Codec CRC and the AMR Core frame to the octet boundary. The first bit of the AMR Core frame $d(0)$ is placed in bit 8 of octet 4. The last bit of the generic AMR frame is the last bit of AMR Core Frame, which is the last bit of speech bits or the last bit of comfort noise bits, as defined in subclauses 4.2.1 and 4.2.3. Table 5 shows the composition for the example of the Codec Mode 6.7kbit/s and table 6 shows the composition for the AMR SID frame. + +**Table 5: Mapping of an AMR speech coding mode into the generic AMR frame, AMR IF1, example: AMR 6.7 kbit/s, "good frame", Mode Request = 1.** + +| Octet | MSB | Mapping of bits AMR 6.7 | | | | | | LSB | +|-------|---------------------------|-------------------------|----------|----------|----------|----------------------|-----------|--------| +| | bit 8 | bit 7 | bit 6 | bit 5 | bit 4 | bit 3 | bit 2 | bit 1 | +| 1 | Frame Type (=3) | | | | FQI | Mode Indication (=3) | | | +| | 0 | 0 | 1 | 1 | 1 | 0 | 1 | 1 | +| 2 | Mode Request (=1) | | | | spare | | | | +| | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | +| 3 | Codec CRC | | | | | | | | +| | CRC(7) | CRC(6) | CRC(5) | CRC(4) | CRC(3) | CRC(2) | CRC(1) | CRC(0) | +| 4 | AMR Core Frame (octet 1) | | | | | | | | +| | $d(0)$ | $d(1)$ | $d(2)$ | $d(3)$ | $d(4)$ | $d(5)$ | $d(6)$ | $d(7)$ | +| 5..19 | | | | | | | | | +| 20 | AMR Core Frame (octet 17) | | | | | | undefined | | +| | $d(128)$ | $d(129)$ | $d(130)$ | $d(131)$ | $d(132)$ | $d(133)$ | | | + +**Table 6: Mapping of an AMR SID frame into the generic AMR frame, AMR IF1, example: AMR SID\_Update, "good frame", Mode Indication = 3, Mode Request = 2.** + +| Octet | MSB | Mapping of bits
AMR SID | | | | | | LSB | +|-------|--------------------------|----------------------------|------------------|--------|----------------------|-----------------|--------|--------| +| | bit 8 | bit 7 | bit 6 | bit 5 | bit 4 | bit 3 | bit 2 | bit 1 | +| 1 | Frame Type (=8) | | | | FQI | Mode Indication | | | +| | 1 | 0 | 0 | 0 | 1 | undefined | | | +| 2 | Mode Request (=2) | | | spare | | | | | +| | MSB | ... | LSB | 0 | 0 | 0 | 0 | 0 | +| 3 | Codec CRC | | | | | | | | +| | CRC(7) | CRC(6) | CRC(5) | CRC(4) | CRC(3) | CRC(2) | CRC(1) | CRC(0) | +| 4 | AMR Core Frame (octet 1) | | | | | | | | +| | d(0)=s(1) | d(1)=s(2) | d(2) | d(3) | d(4) | d(5) | d(6) | d(7) | +| 5..7 | | | | | | | | | +| 8 | | | | STI | Mode Indication (=3) | | | undef. | +| | d(32) | d(33) | d(34) =
s(35) | 1 | 1 | 1 | 0 | | + +Table 7 summarizes all possible AMR frame format combinations in terms of number of bits in each field. + +**Table 7. Number of bits for different fields in different AMR frame compositions** + +| Frame Type Index | Frame Type | Frame Quality Indicator | Mode Indication | Mode Request | Codec CRC | Class A | Class B | Class C | Total | +|------------------|-----------------------|-------------------------|-----------------|--------------|-----------|---------|---------|---------|-------| +| | AMR Core Frame | | | | | | | | | +| 0 | 4 | 1 | 3 | 3 | 8 | 42 | 53 | 0 | 114 | +| 1 | 4 | 1 | 3 | 3 | 8 | 49 | 54 | 0 | 122 | +| 2 | 4 | 1 | 3 | 3 | 8 | 55 | 63 | 0 | 137 | +| 3 | 4 | 1 | 3 | 3 | 8 | 58 | 76 | 0 | 153 | +| 4 | 4 | 1 | 3 | 3 | 8 | 61 | 87 | 0 | 167 | +| 5 | 4 | 1 | 3 | 3 | 8 | 75 | 84 | 0 | 178 | +| 6 | 4 | 1 | 3 | 3 | 8 | 65 | 99 | 40 | 223 | +| 7 | 4 | 1 | 3 | 3 | 8 | 81 | 103 | 60 | 263 | +| 8 | 4 | 1 | 3 | 3 | 8 | 39 | 0 | 0 | 58 | +| 9 | 4 | 1 | 3 | 3 | 8 | 43 | 0 | 0 | 62 | +| 10 | 4 | 1 | 3 | 3 | 8 | 38 | 0 | 0 | 57 | +| 11 | 4 | 1 | 3 | 3 | 8 | 37 | 0 | 0 | 56 | +| 12 | Not used | | | | | | | | | +| 13 | Not used | | | | | | | | | +| 14 | Not used | | | | | | | | | +| 15 | 4 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 4 | + +## 4.4 GSM-EFR Frame Composition + +This subclause contains the description of the generic GSM-EFR Frame of Figure 1. The descriptions for the generic GSM-EFR Frame with speech bits and with comfort noise bit are given separately. + +### 4.4.1 GSM-EFR Frame with speech bits + +The generic GSM-EFR frame for speech data bits is formed like for the AMR mode 12.2 kbit/s. + +The same Frame Type (Frame Type 7) is used also for GSM-EFR. The Mode Indication and Mode Request fields are set to "7". The GSM-EFR Core Frame for speech data bits is identical to the AMR Core Frame for speech data bits in the AMR mode with 12.2 kbit/s. + +### 4.4.2 GSM-EFR Frame with comfort noise bits + +The GSM-EFR Frame content for the additional frame type with Frame Type Index 9 in Table 1a are described in this subclause. This consists of the frame related to GSM-EFR Comfort Noise Aspects as specified in [4] and [5]. + +The comfort noise bits are all mapped to Class A. Classes B and C are not used (see Table 7). + +The contents of GSM-EFR SID is the Comfort Noise Parameters ( $s(i)$ ) as defined in [4]. The Comfort noise parameters are computed as described in [5] by the GSM-EFR speech encoder and are denoted as $s(i) = \{s(1), s(2), \dots, s(38), s(87), s(88), \dots, s(91)\}$ . The notation $s(i)$ follows that of [4] (Table 6). The notation $d(j) = \{d(0) \dots d(42)\}$ is local to the present document and is formed as defined by the pseudo code below. + +``` +for j = 0 to 37 + $d(j) := s(j+1)$ ; /* LSP parameters in s(1) to s(38) */; + +for j = 38 to 42 + $d(j) := s(j+49)$ ; /* fixed codebook gain parameter in s(87)-s(91) */ +``` + +Table 8 shows the composition for the generic GSM-EFR SID frame. + +**Table 8: Mapping of the GSM-EFR SID frame into the generic AMR frame format, AMR IF1, Example of a good GSM-EFR SID frame (FQI=1).** + +| Octet | MSB | Mapping of bits for GSM-EFR SID | | | | | | LSB | +|-------|----------------------|---------------------------------|---------------|---------|----------------------|---------------|---------------|---------------| +| | bit 8 | bit 7 | bit 6 | bit 5 | bit 4 | bit 3 | bit 2 | bit 1 | +| 1 | Frame Type (=9) | | | FQI | Mode Indication (=7) | | | | +| | 1 | 0 | 0 | 1 | 1 | 1 | 1 | 1 | +| 2 | Mode Request (=7) | | | spare | | | | | +| | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | +| 3 | Codec CRC | | | | | | | | +| | CRC(7) | CRC(6) | CRC(5) | CRC(4) | CRC(3) | CRC(2) | CRC(1) | CRC(0) | +| 4 | Core Frame (octet 1) | | | | | | | | +| | $d(0)=s(1)$ | $d(1)=s(2)$ | $d(2)$ | $d(3)$ | $d(4)$ | $d(5)$ | $d(6)$ | $d(7)$ | +| 5..7 | | | | | | | | | +| 8 | | | | | | | | | +| | $d(32)$ | $d(33)$ | $d(34)$ | $d(35)$ | $d(36)=s(37)$ | $d(37)=s(38)$ | $d(38)=s(87)$ | $d(39)=s(88)$ | +| 9 | | | | | | | | | +| | $d(40)=s(89)$ | $d(41)=s(90)$ | $d(42)=s(91)$ | 0 | 0 | 0 | 0 | 0 | + +# Annex A (informative): AMR Interface Format 2 (with octet alignment) + +This annex defines an octet-aligned frame format for the AMR codec. This format is useful, for example, when the AMR codec is used in connection with applicable ITU-T H-series of recommendations. The format is referred to as AMR Interface Format 2 (AMR IF2). + +The AMR IF2 frame is formed by concatenation of the 4-bit Frame Type field (as defined for AMR IF1 in subclause 4.1.1) and the AMR Core Frame (as defined for AMR IF1 in subclause 4.2) as shown in figure A.1. The length of the AMR Core Frame field depends on the particular Frame Type. The total number of bits in the AMR IF2 speech frames in the different modes is typically not a multiple of eight and bit stuffing is needed to achieve an octet structure. + +![Figure A.1: Frame structure for AMR IF2. The diagram shows a vertical stack of five rectangular boxes representing the frame fields. From top to bottom, they are: 'Frame Type (4 bits)', 'Class A bits', 'Class B bits', 'Class C bits', and 'Bit Stuffing'. A line connects the 'Class B bits' box to a larger box on the right labeled 'AMR Core Frame (speech or comfort noise data)'.](ddc7460821484f1ae2835c67955c554c_img.jpg) + +Figure A.1: Frame structure for AMR IF2. The diagram shows a vertical stack of five rectangular boxes representing the frame fields. From top to bottom, they are: 'Frame Type (4 bits)', 'Class A bits', 'Class B bits', 'Class C bits', and 'Bit Stuffing'. A line connects the 'Class B bits' box to a larger box on the right labeled 'AMR Core Frame (speech or comfort noise data)'. + +Figure A.1: Frame structure for AMR IF2 + +Table A.1a shows an example how the AMR 6.7 kbit/s mode is mapped into AMR IF2. The four LSBs of the first octet (octet 1) consist of the Frame Type(=3) for the AMR 6.7 kbit/s mode (see table 1a in AMR IF1 specification). This data field is followed by the 134 AMR Core Frame speech bits ( $d(0)\dots d(133)$ ) which consist of 58 Class A bits and 76 Class B bits as described in table 2 for AMR IF1. This results in a total of 138 bits and 6 bits are needed for Bit Stuffing to arrive to the closest multiple of 8 which is 144 bits. + +Table A.1a: Example mapping of the AMR speech coding mode 6.7kbit/s into AMR IF2. +The bits used for Bit Stuffing are denoted as UB (for "unused bit"). + +| | MSB | Mapping of bits
AMR 6.7 | | | | | | LSB | +|-------|------------------|----------------------------|-------|-------|-------|-------|--------|--------| +| Octet | bit 8 | bit 7 | bit 6 | bit 5 | bit 4 | bit 3 | bit 2 | bit 1 | +| 1 | Frame Type (= 3) | | | | | | | | +| | | | | | MSB | ..... | | LSB | +| 2 | d(3) | d(2) | d(1) | d(0) | 0 | 0 | 1 | 1 | +| 3 | d(11) | d(10) | d(9) | d(8) | d(7) | d(6) | d(5) | d(4) | +| 18 | ... | ... | ... | ... | ... | ... | d(133) | d(132) | +| | Stuffing bits | | | | | | | | +| | UB | UB | UB | UB | UB | UB | d(133) | d(132) | + +Table A.1b shows the composition of AMR IF2 frames for all Frame Types in terms of how many bits are used for each field of figure A.1. + +Tables A.2 to A.5 specify how the AMR Core Frame comfort noise bits of Frame Types 8-11 are mapped to AMR IF2. Table A.6 specifies the mapping for an empty frame ("no transmission"). + +**Table A.1b: Composition of AMR IF2 Frames for all Frame Types.** + +| Frame Type Index | Frame content | Number of bits in Frame Type | Number of Bits in AMR Core Frame | Number of Bits in Bit Stuffing | Number of octets (N) | +|------------------|----------------|------------------------------|----------------------------------|--------------------------------|----------------------| +| 0 | AMR 4,75 | 4 | 95 | 5 | 13 | +| 1 | AMR 5,15 | 4 | 103 | 5 | 14 | +| 2 | AMR 5,90 | 4 | 118 | 6 | 16 | +| 3 | AMR 6,70 | 4 | 134 | 6 | 18 | +| 4 | AMR 7,40 | 4 | 148 | 0 | 19 | +| 5 | AMR 7,95 | 4 | 159 | 5 | 21 | +| 6 | AMR 10,2 | 4 | 204 | 0 | 26 | +| 7 | AMR 12,2 | 4 | 244 | 0 | 31 | +| 8 | AMR SID | 4 | 39 | 5 | 6 | +| 9 | GSM-EFR SID | 4 | 43 | 1 | 6 | +| 10 | TDMA-EFR SID | 4 | 38 | 6 | 6 | +| 11 | PDC-EFR SID | 4 | 37 | 7 | 6 | +| 12-14 | For future use | - | - | - | - | +| 15 | No Data | 4 | 0 | 4 | 1 | + +**Table A.2: Mapping of bits for Frame Type 8 (AMR SID) +(Bits s1 to s35 refer to TS 26.092)** + +| Octet | MSB | Mapping of bits
AMR SID | | | | | | LSB | +|-------|----------------------------------------|----------------------------------------|-------|-------|------------------|--------------------------|-------|----------------------------------------| +| | bit 8 | bit 7 | bit 6 | bit 5 | bit 4 | bit 3 | bit 2 | bit 1 | +| 1 | Index of 1 st LSF subvector | index of LSF reference vector | | | Frame Type (= 8) | | | | +| | s4 | s3 | s2 | s1 | MSB
1 | 0 | 0 | LSB
0 | +| 2 | Index of 2 nd LSF subvector | index of 1 st LSF subvector | | | | | | | +| | s12 | s11 | s10 | s9 | s8 | s7 | s6 | s5 | +| 3 | | index of 2 nd LSF subvector | | | | | | | +| | s20 | s19 | s18 | s17 | s16 | s15 | s14 | s13 | +| 4 | | index of 3 rd LSF subvector | | | | | | | +| | s28 | s27 | s26 | s25 | s24 | s23 | s22 | s21 | +| 5 | SID Type Indicator | frame energy | | | | | | index of 3 rd LSF subvector | +| | t1 | s35 | s34 | s33 | s32 | s31 | s30 | s29 | +| 6 | | Stuffing bits | | | | Mode Indication
mi(i) | | | +| | UB | UB | UB | UB | UB | MSB
mi(2) | mi(1) | LSB
mi(0) | + +Definitions of additional descriptor bits needed for the silence descriptor in the table are as follows: SID-type Indicator STI is {0=SID\_FIRST, 1=SID\_UPDATE }, Mode Indication (mi(0)- mi(2)) is the AMR codec mode according to the first eight entries in table 1a. + +**Table A.3: Mapping of bits for Frame Type 9 (GSM-EFR SID)** + (Bits s1 to s91 refer to GSM 46.060) + +| | MSB | Mapping of bits
GSM-EFR SID | | | | | | LSB | +|-------|----------------------------------------|--------------------------------|-------|-------|----------------------------------------|----------------------------------------|----------------------------------------|-------| +| Octet | bit 8 | bit 7 | bit 6 | bit 5 | bit 4 | bit 3 | bit 2 | bit 1 | +| 1 | Index of 1 st LSF subMatrix | | | | Frame Type (= 9) | | | | +| | s4 | s3 | s2 | s1 | 1 | 0 | 0 | 1 | +| 2 | Index of 2 nd LSF submatrix | | | | index of 1 st LSF subMatrix | | | | +| | s12 | s11 | s10 | s9 | s8 | s7 | s6 | s5 | +| 3 | Index of 3 rd LSF submatrix | | | | Index of 2 nd LSF submatrix | | | | +| | s20 | s19 | s18 | s17 | s16 | s15 | s14 | s13 | +| 4 | index of 4 th LSF submatrix | | | | sign of 3 rd LSF submatrix | index of 3 rd LSF submatrix | | | +| | s28 | s27 | s26 | s25 | s24 | s23 | s22 | s21 | +| 5 | index of 5 th LSF submatrix | | | | index of 4 th LSF submatrix | | | | +| | s36 | s35 | s34 | s33 | s32 | s31 | s30 | s29 | +| 6 | Stuffing bit | fixed codebook gain | | | | | index of 5 th LSF submatrix | | +| | UB | s91 | s90 | s89 | s88 | s87 | s38 | s37 | + +**Table A.4: Mapping of bits for Frame Type 10 (TDMA-EFR SID)** + (Bits cn0 to cn37 refer to IS-641-A) + +| | MSB | Mapping of bits
TDMA-EFR SID | | | | | | LSB | +|-------|-----------------------------------------|---------------------------------|----------------------------------------|----------------------------------------|----------------------------------------|-------|-----------------------------------------|-------| +| Octet | bit 8 | bit 7 | bit 6 | bit 5 | bit 4 | bit 3 | bit 2 | bit 1 | +| 1 | Index of 1 st LSF subvector | | | | Frame Type (= 10) | | | | +| | cn3 | cn2 | cn1 | cn0 | 1 | 0 | 1 | 0 | +| 2 | Index of 2 nd LSF subvector | | | | index of 1 st LSF subvector | | | | +| | cn11 | Cn10 | cn9 | cn8 | cn7 | cn6 | cn5 | cn4 | +| 3 | Index of 3 rd LSF subvector | | | Index of 2 nd LSF subvector | | | | | +| | cn19 | cn18 | cn17 | cn16 | cn15 | cn14 | cn13 | cn12 | +| 4 | Random Excitation Gain | | index of 3 rd LSF subvector | | | | | | +| | cn27 | cn26 | cn25 | cn24 | cn23 | cn22 | cn21 | cn20 | +| 5 | Index of 1 st RESC parameter | | Random Excitation Gain | | | | | | +| | cn35 | cn34 | cn33 | cn32 | cn31 | cn30 | cn29 | cn28 | +| 6 | Stuffing bits | | | | | | Index of 2 nd RESC parameter | | +| | UB | UB | UB | UB | UB | UB | cn37 | cn36 | + +**Table A.5: Mapping of bits for Frame Type 11 (PDC-EFR SID)** + (Bits s1 to s35 refer to ARIB xx) + +| | MSB | Mapping of bits
PDC-EFR SID | | | | | | LSB | +|-------|----------------------------------------|----------------------------------------|-------|-------|-------------------|-------|-------|----------------------------------------| +| Octet | bit 8 | bit 7 | bit 6 | bit 5 | bit 4 | bit 3 | bit 2 | bit 1 | +| 1 | index of 1 st LSF subvector | index of LSF reference vector | | | Frame Type (= 11) | | | | +| | s4 | s3 | s2 | s1 | 1 | 0 | 1 | 1 | +| 2 | index of 2 nd LSF subvector | index of 1 st LSF subvector | | | | | | | +| | s12 | s11 | s10 | s9 | s8 | s7 | s6 | s5 | +| 3 | index of 2 nd LSF subvector | | | | | | | | +| | s20 | s19 | s18 | s17 | s16 | s15 | s14 | s13 | +| 4 | index of 3 rd LSF subvector | | | | | | | | +| | s28 | s27 | s26 | s25 | s24 | s23 | s22 | s21 | +| 5 | SID type | frame energy | | | | | | Index of 3 rd LSF subvector | +| | t1 | s35 | s34 | s33 | s32 | s31 | s30 | s29 | +| 6 | Stuffing bits | | | | | | | SID type | +| | UB | UB | UB | UB | UB | UB | UB | t2 | + +Definition of additional descriptor bits needed for the table is as follows: SID-type is {0=POST0, 1=POST1(SID\_UPDATE), 2=PRE, 3=POST1\_BAD }, where LSB of SID\_type is t1 and MSB of SID-type is t2. + +**Table A.6: Mapping of bit for Frame Type 15 (No Data)** + +| | MSB | Mapping of Bits
No Data | | | | | | LSB | +|-------|---------------|----------------------------|-------|-------|-------------------|-------|-------|-------| +| Octet | bit 8 | bit 7 | bit 6 | bit 5 | bit 4 | bit 3 | bit 2 | bit 1 | +| 1 | Stuffing bits | | | | Frame Type (= 15) | | | | +| | UB | UB | UB | UB | 1 | 1 | 1 | 1 | + +# Annex B (normative): Tables for AMR Core Frame bit ordering + +This annex contains the tables required for ordering the AMR Core Frame speech bits corresponding to the different AMR modes. These tables represent $table_m(j)$ in subclause 4.2.1 where $m=0..7$ is the AMR mode. The tables are read from left to right so that the first element (top left corner) of the table has index 0 and the last element (the rightmost element of the last row) has the index $K-1$ where $K$ is the total number of speech bits in the specific mode. For example, $table_0(20)=27$ , as defined in table B.1. + +**Table B.1: Ordering of the speech encoder bits for the 4.75 kbit/s mode: $table_0(j)$** + +| j=0 | j=1 | j=2 | ... | ... | ... | ... | ... | ... | ... | +|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | +| 10 | 11 | 12 | 13 | 14 | 15 | 23 | 24 | 25 | 26 | +| 27 | 28 | 48 | 49 | 61 | 62 | 82 | 83 | 47 | 46 | +| 45 | 44 | 81 | 80 | 79 | 78 | 17 | 18 | 20 | 22 | +| 77 | 76 | 75 | 74 | 29 | 30 | 43 | 42 | 41 | 40 | +| 38 | 39 | 16 | 19 | 21 | 50 | 51 | 59 | 60 | 63 | +| 64 | 72 | 73 | 84 | 85 | 93 | 94 | 32 | 33 | 35 | +| 36 | 53 | 54 | 56 | 57 | 66 | 67 | 69 | 70 | 87 | +| 88 | 90 | 91 | 34 | 55 | 68 | 89 | 37 | 58 | 71 | +| 92 | 31 | 52 | 65 | 86 | | | | | | + +**Table B.2: Ordering of the speech encoder bits for the 5.15 kbit/s mode: $table_1(j)$** + +| | | | | | | | | | | +|----|----|----|-----|-----|-----|----|----|----|----| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 15 | 14 | +| 13 | 12 | 11 | 10 | 9 | 8 | 23 | 24 | 25 | 26 | +| 27 | 46 | 65 | 84 | 45 | 44 | 43 | 64 | 63 | 62 | +| 83 | 82 | 81 | 102 | 101 | 100 | 42 | 61 | 80 | 99 | +| 28 | 47 | 66 | 85 | 18 | 41 | 60 | 79 | 98 | 29 | +| 48 | 67 | 17 | 20 | 22 | 40 | 59 | 78 | 97 | 21 | +| 30 | 49 | 68 | 86 | 19 | 16 | 87 | 39 | 38 | 58 | +| 57 | 77 | 35 | 54 | 73 | 92 | 76 | 96 | 95 | 36 | +| 55 | 74 | 93 | 32 | 51 | 33 | 52 | 70 | 71 | 89 | +| 90 | 31 | 50 | 69 | 88 | 37 | 56 | 75 | 94 | 34 | +| 53 | 72 | 91 | | | | | | | | + +**Table B.3: Ordering of the speech encoder bits for the 5.9 kbit/s mode: $table_2(j)$** + +| | | | | | | | | | | +|-----|-----|-----|-----|-----|-----|----|-----|-----|-----| +| 0 | 1 | 4 | 5 | 3 | 6 | 7 | 2 | 13 | 15 | +| 8 | 9 | 11 | 12 | 14 | 10 | 16 | 28 | 74 | 29 | +| 75 | 27 | 73 | 26 | 72 | 30 | 76 | 51 | 97 | 50 | +| 71 | 96 | 117 | 31 | 77 | 52 | 98 | 49 | 70 | 95 | +| 116 | 53 | 99 | 32 | 78 | 33 | 79 | 48 | 69 | 94 | +| 115 | 47 | 68 | 93 | 114 | 46 | 67 | 92 | 113 | 19 | +| 21 | 23 | 22 | 18 | 17 | 20 | 24 | 111 | 43 | 89 | +| 110 | 64 | 65 | 44 | 90 | 25 | 45 | 66 | 91 | 112 | +| 54 | 100 | 40 | 61 | 86 | 107 | 39 | 60 | 85 | 106 | +| 36 | 57 | 82 | 103 | 35 | 56 | 81 | 102 | 34 | 55 | +| 80 | 101 | 42 | 63 | 88 | 109 | 41 | 62 | 87 | 108 | +| 38 | 59 | 84 | 105 | 37 | 58 | 83 | 104 | | | + +**Table B.4: Ordering of the speech encoder bits for the 6.7 kbit/s mode: $table_3(j)$** + +| | | | | | | | | | | +|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----| +| 0 | 1 | 4 | 3 | 5 | 6 | 13 | 7 | 2 | 8 | +| 9 | 11 | 15 | 12 | 14 | 10 | 28 | 82 | 29 | 83 | +| 27 | 81 | 26 | 80 | 30 | 84 | 16 | 55 | 109 | 56 | +| 110 | 31 | 85 | 57 | 111 | 48 | 73 | 102 | 127 | 32 | +| 86 | 51 | 76 | 105 | 130 | 52 | 77 | 106 | 131 | 58 | +| 112 | 33 | 87 | 19 | 23 | 53 | 78 | 107 | 132 | 21 | +| 22 | 18 | 17 | 20 | 24 | 25 | 50 | 75 | 104 | 129 | +| 47 | 72 | 101 | 126 | 54 | 79 | 108 | 133 | 46 | 71 | +| 100 | 125 | 128 | 103 | 74 | 49 | 45 | 70 | 99 | 124 | +| 42 | 67 | 96 | 121 | 39 | 64 | 93 | 118 | 38 | 63 | +| 92 | 117 | 35 | 60 | 89 | 114 | 34 | 59 | 88 | 113 | +| 44 | 69 | 98 | 123 | 43 | 68 | 97 | 122 | 41 | 66 | +| 95 | 120 | 40 | 65 | 94 | 119 | 37 | 62 | 91 | 116 | +| 36 | 61 | 90 | 115 | | | | | | | + +**Table B.5: Ordering of the speech encoder bits for the 7.4 kbit/s mode: $table_4(j)$** + +| | | | | | | | | | | +|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | +| 10 | 11 | 12 | 13 | 14 | 15 | 16 | 26 | 87 | 27 | +| 88 | 28 | 89 | 29 | 90 | 30 | 91 | 51 | 80 | 112 | +| 141 | 52 | 81 | 113 | 142 | 54 | 83 | 115 | 144 | 55 | +| 84 | 116 | 145 | 58 | 119 | 59 | 120 | 21 | 22 | 23 | +| 17 | 18 | 19 | 31 | 60 | 92 | 121 | 56 | 85 | 117 | +| 146 | 20 | 24 | 25 | 50 | 79 | 111 | 140 | 57 | 86 | +| 118 | 147 | 49 | 78 | 110 | 139 | 48 | 77 | 53 | 82 | +| 114 | 143 | 109 | 138 | 47 | 76 | 108 | 137 | 32 | 33 | +| 61 | 62 | 93 | 94 | 122 | 123 | 41 | 42 | 43 | 44 | +| 45 | 46 | 70 | 71 | 72 | 73 | 74 | 75 | 102 | 103 | +| 104 | 105 | 106 | 107 | 131 | 132 | 133 | 134 | 135 | 136 | +| 34 | 63 | 95 | 124 | 35 | 64 | 96 | 125 | 36 | 65 | +| 97 | 126 | 37 | 66 | 98 | 127 | 38 | 67 | 99 | 128 | +| 39 | 68 | 100 | 129 | 40 | 69 | 101 | 130 | | | + +**Table B.6: Ordering of the speech encoder bits for the 7.95 kbit/s mode: $table_5(j)$** + +| | | | | | | | | | | +|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 14 | 16 | 9 | +| 10 | 12 | 13 | 15 | 11 | 17 | 20 | 22 | 24 | 23 | +| 19 | 18 | 21 | 56 | 88 | 122 | 154 | 57 | 89 | 123 | +| 155 | 58 | 90 | 124 | 156 | 52 | 84 | 118 | 150 | 53 | +| 85 | 119 | 151 | 27 | 93 | 28 | 94 | 29 | 95 | 30 | +| 96 | 31 | 97 | 61 | 127 | 62 | 128 | 63 | 129 | 59 | +| 91 | 125 | 157 | 32 | 98 | 64 | 130 | 1 | 0 | 25 | +| 26 | 33 | 99 | 34 | 100 | 65 | 131 | 66 | 132 | 54 | +| 86 | 120 | 152 | 60 | 92 | 126 | 158 | 55 | 87 | 121 | +| 153 | 117 | 116 | 115 | 46 | 78 | 112 | 144 | 43 | 75 | +| 109 | 141 | 40 | 72 | 106 | 138 | 36 | 68 | 102 | 134 | +| 114 | 149 | 148 | 147 | 146 | 83 | 82 | 81 | 80 | 51 | +| 50 | 49 | 48 | 47 | 45 | 44 | 42 | 39 | 35 | 79 | +| 77 | 76 | 74 | 71 | 67 | 113 | 111 | 110 | 108 | 105 | +| 101 | 145 | 143 | 142 | 140 | 137 | 133 | 41 | 73 | 107 | +| 139 | 37 | 69 | 103 | 135 | 38 | 70 | 104 | 136 | | + +Table B.7: Ordering of the speech encoder bits for the 10.2 kbit/s mode: $table_6(j)$ + +| | | | | | | | | | | +|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----| +| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 16 | 15 | +| 14 | 13 | 12 | 11 | 10 | 9 | 8 | 26 | 27 | 28 | +| 29 | 30 | 31 | 115 | 116 | 117 | 118 | 119 | 120 | 72 | +| 73 | 161 | 162 | 65 | 68 | 69 | 108 | 111 | 112 | 154 | +| 157 | 158 | 197 | 200 | 201 | 32 | 33 | 121 | 122 | 74 | +| 75 | 163 | 164 | 66 | 109 | 155 | 198 | 19 | 23 | 21 | +| 22 | 18 | 17 | 20 | 24 | 25 | 37 | 36 | 35 | 34 | +| 80 | 79 | 78 | 77 | 126 | 125 | 124 | 123 | 169 | 168 | +| 167 | 166 | 70 | 67 | 71 | 113 | 110 | 114 | 159 | 156 | +| 160 | 202 | 199 | 203 | 76 | 165 | 81 | 82 | 92 | 91 | +| 93 | 83 | 95 | 85 | 84 | 94 | 101 | 102 | 96 | 104 | +| 86 | 103 | 87 | 97 | 127 | 128 | 138 | 137 | 139 | 129 | +| 141 | 131 | 130 | 140 | 147 | 148 | 142 | 150 | 132 | 149 | +| 133 | 143 | 170 | 171 | 181 | 180 | 182 | 172 | 184 | 174 | +| 173 | 183 | 190 | 191 | 185 | 193 | 175 | 192 | 176 | 186 | +| 38 | 39 | 49 | 48 | 50 | 40 | 52 | 42 | 41 | 51 | +| 58 | 59 | 53 | 61 | 43 | 60 | 44 | 54 | 194 | 179 | +| 189 | 196 | 177 | 195 | 178 | 187 | 188 | 151 | 136 | 146 | +| 153 | 134 | 152 | 135 | 144 | 145 | 105 | 90 | 100 | 107 | +| 88 | 106 | 89 | 98 | 99 | 62 | 47 | 57 | 64 | 45 | +| 63 | 46 | 55 | 56 | | | | | | | + +Table B.8: Ordering of the speech encoder bits for the 12.2 kbit/s mode: $table_7(j)$ + +| | | | | | | | | | | +|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----| +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | +| 10 | 11 | 12 | 13 | 14 | 23 | 15 | 16 | 17 | 18 | +| 19 | 20 | 21 | 22 | 24 | 25 | 26 | 27 | 28 | 38 | +| 141 | 39 | 142 | 40 | 143 | 41 | 144 | 42 | 145 | 43 | +| 146 | 44 | 147 | 45 | 148 | 46 | 149 | 47 | 97 | 150 | +| 200 | 48 | 98 | 151 | 201 | 49 | 99 | 152 | 202 | 86 | +| 136 | 189 | 239 | 87 | 137 | 190 | 240 | 88 | 138 | 191 | +| 241 | 91 | 194 | 92 | 195 | 93 | 196 | 94 | 197 | 95 | +| 198 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 50 | 100 | +| 153 | 203 | 89 | 139 | 192 | 242 | 51 | 101 | 154 | 204 | +| 55 | 105 | 158 | 208 | 90 | 140 | 193 | 243 | 59 | 109 | +| 162 | 212 | 63 | 113 | 166 | 216 | 67 | 117 | 170 | 220 | +| 36 | 37 | 54 | 53 | 52 | 58 | 57 | 56 | 62 | 61 | +| 60 | 66 | 65 | 64 | 70 | 69 | 68 | 104 | 103 | 102 | +| 108 | 107 | 106 | 112 | 111 | 110 | 116 | 115 | 114 | 120 | +| 119 | 118 | 157 | 156 | 155 | 161 | 160 | 159 | 165 | 164 | +| 163 | 169 | 168 | 167 | 173 | 172 | 171 | 207 | 206 | 205 | +| 211 | 210 | 209 | 215 | 214 | 213 | 219 | 218 | 217 | 223 | +| 222 | 221 | 73 | 72 | 71 | 76 | 75 | 74 | 79 | 78 | +| 77 | 82 | 81 | 80 | 85 | 84 | 83 | 123 | 122 | 121 | +| 126 | 125 | 124 | 129 | 128 | 127 | 132 | 131 | 130 | 135 | +| 134 | 133 | 176 | 175 | 174 | 179 | 178 | 177 | 182 | 181 | +| 180 | 185 | 184 | 183 | 188 | 187 | 186 | 226 | 225 | 224 | +| 229 | 228 | 227 | 232 | 231 | 230 | 235 | 234 | 233 | 238 | +| 237 | 236 | 96 | 199 | | | | | | | \ No newline at end of file diff --git a/marked/Rel-18/26_series/26130/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/26_series/26130/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9cbd0cbdd85640e80e2f10c956b59645b32a2490 --- /dev/null +++ b/marked/Rel-18/26_series/26130/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:65d2666e9dda6fe5e279cab802484499fbb4d258584f92264579655845b9118d +size 9292 diff --git a/marked/Rel-18/26_series/26130/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/26_series/26130/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..421bddc426b3713e3e66fa03725724de0fe0727a --- /dev/null +++ b/marked/Rel-18/26_series/26130/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2c2d41e84edad2cfeb9f0d30b531e270388447941fc13c04ae58b8e9f651eba4 +size 5795 diff --git a/marked/Rel-18/26_series/26130/raw.md b/marked/Rel-18/26_series/26130/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8c6a41d4df36cc00c53279d77838497a58956332 --- /dev/null +++ b/marked/Rel-18/26_series/26130/raw.md @@ -0,0 +1,943 @@ + + +# 3GPP TS 26.130 V18.1.0 (2024-06) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Speech/Audio Codec RTP Payload Format Conformance for UE Testing (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations ..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Interfaces..... | 8 | +| 4.1 General ..... | 8 | +| 4.2 Acoustic interfaces ..... | 8 | +| 4.3 Electrical interfaces ..... | 9 | +| 5 Test setup ..... | 9 | +| 5.1 General ..... | 9 | +| 5.2 Setup for terminals ..... | 9 | +| 5.3 Setup of the electrical interfaces of test equipment..... | 9 | +| 5.4 Accuracy of test equipment..... | 9 | +| 5.5 Test signals..... | 9 | +| 5.6 Environmental conditions ..... | 9 | +| 5.7 System simulator conditions ..... | 10 | +| 6 RTP Payload Format Conformance for AMR ..... | 10 | +| 6.1 Applicability..... | 10 | +| 6.2 SDP tests ..... | 10 | +| 6.2.1 MO call..... | 10 | +| 6.2.2 MT calls..... | 10 | +| 6.3 RTP tests ..... | 11 | +| 6.3.1 Test cases in sending ..... | 11 | +| 6.3.1.1 FT verification ..... | 11 | +| 6.3.1.2 Q-bit verification..... | 12 | +| 6.3.1.3 SID update periodicity ..... | 12 | +| 6.3.2 Test cases in receiving..... | 12 | +| 6.3.2.1 Q-bit verification..... | 12 | +| 6.3.3 Test cases with CMR..... | 12 | +| 6.3.3.1 Response time definition ..... | 12 | +| 6.3.3.2 Open offer ..... | 13 | +| 6.3.3.3 Restricted offer ..... | 13 | +| 6.4 RTCP tests..... | 13 | +| 6.4.1 General ..... | 13 | +| 6.4.2 Verification of SR and RR reports ..... | 13 | +| 6.4.3 RTCP bandwidth verification..... | 13 | +| 7 RTP Payload Format Conformance for AMR-WB..... | 14 | +| 7.1 Applicability..... | 14 | +| 7.2 SDP tests ..... | 14 | +| 7.2.1 MO call..... | 14 | +| 7.2.2 MT calls..... | 14 | +| 7.3 RTP tests ..... | 15 | +| 7.3.1 Test cases in sending ..... | 15 | +| 7.3.1.1 FT verification ..... | 15 | +| 7.3.1.2 Q-bit verification..... | 16 | +| 7.3.1.3 SID update periodicity ..... | 16 | +| 7.3.2 Test cases in receiving..... | 16 | +| 7.3.2.1 Q-bit verification..... | 16 | + +| | | | +|-------------------------------|----------------------------------------------|-----------| +| 7.3.3 | Test cases with CMR..... | 16 | +| 7.3.3.1 | Response time definition ..... | 16 | +| 7.3.3.2 | Open offer ..... | 16 | +| 7.3.3.2 | Restricted offer ..... | 17 | +| 7.4 | RTCP tests..... | 17 | +| 7.4.1 | General ..... | 17 | +| 7.4.2 | Verification of SR and RR reports ..... | 17 | +| 7.4.3 | RTCP bandwidth verification..... | 17 | +| 8 | RTP Payload Format Conformance for EVS ..... | 18 | +| 8.1 | Applicability..... | 18 | +| 8.2 | SDP tests ..... | 18 | +| 8.2.1 | MO call..... | 18 | +| 8.2.2 | MT calls..... | 18 | +| 8.3 | RTP tests ..... | 20 | +| 8.3.1 | Test cases in sending ..... | 20 | +| 8.3.1.1 | ToC byte verification..... | 20 | +| 8.3.1.2 | Q-bit verification..... | 20 | +| 8.3.1.3 | SID update periodicity ..... | 21 | +| 8.3.2 | Test cases in receiving..... | 21 | +| 8.3.2.1 | Q-bit verification..... | 21 | +| 8.3.2.2 | Quality verification in receiving ..... | 21 | +| 8.3.3 | Test cases with CMR..... | 22 | +| 8.3.3.1 | Response time definition ..... | 22 | +| 8.3.3.2 | Open offer ..... | 22 | +| 8.3.3.3 | Restricted offer ..... | 22 | +| 8.4 | RTCP tests..... | 23 | +| 8.4.1 | General ..... | 23 | +| 8.4.2 | Verification of SR and RR reports ..... | 23 | +| 8.4.3 | RTCP bandwidth verification..... | 23 | +| Annex A (normative): | Packet impairment profile..... | 24 | +| Annex B (informative): | Change history..... | 25 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +The present document specifies requirements and test methods to verify correct implementations of the RTP payload format for 3GPP codecs in UE. The focus is on conversational services in LTE, NR and WLAN terminals when used to provide narrowband, wideband, super-wideband or fullband telephony. + +# --- 1 Scope + +The present document is applicable to any terminal capable of supporting narrowband, wideband, super-wideband or fullband telephony, either as a stand-alone service or as the telephony component of a multimedia service. The present document specifies requirements and test methods to verify correct implementations of the RTP payload format for 3GPP codecs in UE. The focus is on conversational services in LTE, NR and WLAN terminals when used to provide narrowband, wideband, super-wideband or fullband telephony. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 26.132: "Speech and video telephony terminal acoustic test specification". +- [3] 3GPP TS 26.139: "Real-time Transport Protocol (RTP) / RTP Control Protocol (RTCP) verification procedures". +- [4] 3GPP TS 34.229-1: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); User Equipment (UE) conformance specification; Part 1: Protocol conformance specification". +- [5] 3GPP TS 34.229-2: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); User Equipment (UE) conformance specification; Part 2: Implementation Conformance Statement (ICS) specification". +- [6] 3GPP TS 34.229-3: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); User Equipment (UE) conformance specification; Part 3: Abstract test suite (ATS)". +- [7] 3GPP TS 34.229-5: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); User Equipment (UE) conformance specification; Part 5: Protocol conformance specification using 5G System (5GS)". +- [8] IETF RFC 4867: "RTP Payload Format and File Storage Format for the Adaptive Multi-Rate (AMR) and Adaptive Multi-Rate Wideband (AMR-WB) Audio Codecs". +- [9] 3GPP TS 26.445: "Codec for Enhanced Voice Services (EVS); Detailed algorithmic description". +- [10] ITU-T Recommendation P.501 (06/2015): "Test signals for use in telephonometry". +- [11] 3GPP TS 26.101: "Mandatory speech codec speech processing functions; Adaptive Multi-Rate (AMR) speech codec frame structure". +- [12] 3GPP TS 26.190: "Speech codec speech processing functions; Adaptive Multi-Rate - Wideband (AMR-WB) speech codec; Transcoding functions". +- [13] 3GPP TS 26.114: IP Multimedia Subsystem (IMS); Multimedia telephony; Media handling and interaction. +- [14] IETF RFC 3550: RTP: A Transport Protocol for Real-Time Applications. + +- [15] ITU-T Recommendation P.863 (09/2014): "Perceptual objective listening quality assessment". +- [16] ITU-T Recommendation P.863.1 (09/2014): "Application guide for Recommendation ITU-T P.863". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**Incoming CMR:** CMR in RTP packet received by the DUT + +**Receiving:** Link from test simulator to DUT + +**Sending:** Link from DUT to test simulator + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|------|-----------------------------------------| +| DUT | Device Under Test | +| MO | Mobile Originated | +| MT | Mobile Terminated | +| SS | System Simulator | +| TX | Transmission | +| VoNR | 5G capable DUT supporting voice over NR | + +# --- 4 Interfaces + +## 4.1 General + +By default, electrical interfaces should be used for testing. Acoustic interfaces may be used as an alternative. The actual interfaces used in sending and receiving shall be documented. + +Test cases may be implemented either by injecting specific packet information (including CMR requests) in a live call or assuming a PCAP player scenario. To define the test setup, one approach is to reuse the test setup defined in TS 26.132 [2] (defining acoustical and electrical interfaces) where only LTE, WLAN and NR apply. + +If no acoustic measurement is required, the test setup in TS 26.139 [3] can be reused for RTP /RTCP "data injection" with either active or passive test instrument. + +## 4.2 Acoustic interfaces + +See clause 5.1 in TS 26.132 [2]. + +## 4.3 Electrical interfaces + +See clause 5.2 in TS 26.132 [2]. + +# --- 5 Test setup + +## 5.1 General + +Similar to clause 5.1 in TS 26.139 [3]: + +- The "system under test" is the device (DUT), or software to be tested +- The "test instrument" is the equipment used to place an IMS call including configurable SIP and SDP parameters and to collect test data (SDP/RTP/RTCP output from the system under test). It can extract, calculate, and store information to check requirements for all the test described in the present document. +- The "data injection" is the device or equipment used to generate RTP/RTCP data sent to the system under test. + +NOTE 1: 'data injection' may be collocated or integrated with the test instrument. + +NOTE 2: Data collection ('SDP/RTP / RTCP receiver') may be performed either by "test instrument" or collocated with "data injection" equipment. + +## 5.2 Setup for terminals + +See clause 5.2 in TS 26.132 [2] for the setup definition (Handset UE, Headset UE, Desktop-mounted hands-free UE, Hand-held hands-free UE, Softphone UE). + +## 5.3 Setup of the electrical interfaces of test equipment + +See clause 5.2 in TS 26.132 [2]. + +For receive tests, where a user operated volume control is provided, the measurements [should/shall] be carried out at the nominal setting of the volume control. + +## 5.4 Accuracy of test equipment + +See clause 5.3 in TS 26.132 [2]. + +## 5.5 Test signals + +See clause 5.4 in TS 26.132 [2]. + +## 5.6 Environmental conditions + +See clause 6 in TS 26.132 [2]. + +For LTE, WLAN, and NR connections, an RF shielded room should be one way to achieve these requirements on block error rate and jitter. Otherwise, care should be taken with potential sources of radio interference and their impact. + +## 5.7 System simulator conditions + +Test applicability and test result may depend on the SIM card or eSIM configuration. Depending on MNC and MCC, the DUT could be set in test mode or load specific parameters. Unless otherwise stated, a new call shall be established for each test case. + +# --- 6 RTP Payload Format Conformance for AMR + +## 6.1 Applicability + +The requirements and test methods in this clause shall apply when UE is used to provide narrowband telephony, either as a stand-alone service, or as part of a multimedia service. + +## 6.2 SDP tests + +### 6.2.1 MO call + +Requirement: + +Requirements on the SDP offer from the DUT are for further study. + +NOTE: SDP testing is already considered in [4,5,6,7]. + +Test method: + +A call is established by the DUT. The SDP offer from the DUT shall be documented. + +### 6.2.2 MT calls + +Requirement: + +Requirements on the SDP answer from the DUT are for further study. + +NOTE: Verification of b=AS is for further study. Purpose is to check compliance to [13] Annex K: b=AS is expected to be set according to the highest allowed codec mode and other parameters (IP version, ptime, bandwidth efficient or octet-align mode) in the SDP answer. + +Test method: + +Every call is established by the system simulator using one AMR payload type in the SDP offer. The system simulator shall configure the SDP offer according to Table 6.2.2-1 for the bandwidth-efficient mode of AMR and Table 6.2.2-2 for the octet-aligned mode of AMR. + +For each SDP offer, the SDP answer from the DUT shall be documented and the corresponding RTP and RTCP streams shall be recorded. + +The test signal to be used for the measurements shall be the same in both directions as specified below depending on test cases: + +- speech1: the British-English single talk sequence described in ITU-T Recommendation P.501 [10]. +- silence1: test signal forced to silence (same length as speech1) +- speech2: first sentence of the British-English single talk sequence described in ITU-T Recommendation P.501 [10] shortened to 2.4sec by selecting samples in interval [0.5sec, 2.9sec], repeated 16 times +- silence2: test signal forced to silence (same length as speech2) + +- speech3: 3 repeats of the Composite Source Signal (CSS) according to ITU-T Recommendation P.501 [10] followed by a speech signal of 160s as in clause 7.10.4.2 of TS 26.132 [2] +- silence3: test signal forced to silence (same length as speech3) + +In sending, for acoustic interfaces, the test signal level should be -4,7 dBPa measured at the MRP; for electrical interfaces, the active speech level of the signal should be calibrated to -60 dBV for analogue and to -16 dBm0 for digital connections. + +In receiving, the test signal level should be -16 dBm0 measured at the digital reference point or the equivalent analogue point. + +**Table 6.2.2-1: List of test cases for MT calls for given SDP offer (bandwidth-efficient)** + +| Test case | Parameter the SDP offer | Mode-set in SDP answer | Input to DUT | Input to system simulator | +|-----------|-----------------------------------|------------------------|-----------------------|---------------------------| +| amr-0 | mode-set=0 | 0 | speech1 | silence1 | +| amr-1 | mode-set=1 | 1 | speech1 | silence1 | +| amr-2 | mode-set=2 | 2 | speech1 | silence1 | +| amr-3 | mode-set=3 | 3 | speech1 | silence1 | +| amr-4 | mode-set=4 | 4 | speech1 | silence1 | +| amr-5 | mode-set=5 | 5 | speech1 | silence1 | +| amr-6 | mode-set=6 | 6 | speech1 | silence1 | +| amr-7 | mode-set=7 | 7 | speech1 | silence1 | +| amr-oo | mode-set not present (open offer) | See NOTE 1 | speech1 | silence1 | +| amr-cmr1 | mode-set not present (open-offer) | See NOTE 1 | speech2 (see NOTE 2) | speech2 | +| amr-cmr2 | mode-set=0,2,4,7 | 0,2,4,7 | speech2 (see NOTE 2) | speech2 | +| amr-qbit | mode-set=7 | 7 | silence1 | speech1 (see NOTE 3) | +| amr-imp | mode-set=7 | 7 | silence3 (see NOTE 4) | speech3 | + +NOTE 1: The DUT may restrict the mode-set in its answer to a restricted set of AMR modes, e.g., to 0,2,4,7 or a further subset due to configuration. +NOTE 2: The system simulator inserts CMRs in the RTP stream in this test case. +NOTE 3: The system simulator forces Q bit to 0 in all packets of the RTP stream in test case 'amr-qbit'. +NOTE 4: The system simulator inserts packet impairments (using profile in Annex A) in the RTP stream in this test case. + +**Table 6.2.2-2: List of test cases for MT calls for given SDP offer (octet-aligned)** + +| Test case | Parameter the SDP offer | Mode-set in SDP answer | Input to DUT | Input to system simulator | +|-------------|---------------------------|------------------------|--------------|---------------------------| +| amr-octet-7 | mode-set=7; octet-align=1 | 7 | speech1 | silence1 | + +## 6.3 RTP tests + +### 6.3.1 Test cases in sending + +#### 6.3.1.1 FT verification + +Requirement: + +The FT entry in the ToC shall be match the active speech bit rate index according to RFC 4867 [9]. + +The FT entry in the ToC shall be match the SID bit rate index according to RFC 4867 [9]. + +Test method: + +- For each test case amr-0 to amr-7 (see clause 6.2.2), the ToC field is extracted for recorded RTP stream from the DUT and compared with the respective AMR mode (0 to 7) for active speech packets or SID bitrate for SID packets. + +NOTE: The value of FT is defined in Table 1a in 3GPP TS 26.101 [11] for AMR. + +#### 6.3.1.2 Q-bit verification + +Requirement: + +The Q-bit shall always be set to 1 in the RTP payload. + +NOTE: The Q-bit is the frame quality indicator [8]. If set to 0, it indicates that the corresponding frame is severely damaged, and the receiver should set the RX\_TYPE to either SPEECH\_BAD or SID\_BAD depending on the Frame Type (FT).] + +Test method: For each test case amr-0 to amr-7 (see clause 6.2.2), the Q-bit field is extracted from recorded RTP stream from the DUT and the value is compared to 1. + +#### 6.3.1.3 SID update periodicity + +Requirement: + +The DUT shall respect the SID update rules specified in [8]. SID frames shall be sent with the following pattern: + +- First SID frame 20 ms after the last speech frame (SID\_FIRST) +- Second SID frame (first SID UPDATE): 60 ms after the first SID frame +- Following SID UPDATE: every 160 ms + +NOTE: Network equipment may monitor RTP traffic and release the call (false communications cutting detection) if SID update is incorrect. + +Test method: + +For the test case amr-7 (see clause 6.2.2), analyse and report the RTP sending frames intervals for SID frames according to requirement. + +### 6.3.2 Test cases in receiving + +#### 6.3.2.1 Q-bit verification + +Requirement: + +Quality requirement are ffs. + +Test method: + +The system simulator shall send an AMR coded RTP stream where the Q bit is set to 0 and record the audio output from the DUT. + +### 6.3.3 Test cases with CMR + +#### 6.3.3.1 Response time definition + +The UE response time in the send direction (uplink) to an incoming CMR is defined as the delay between the send time of a packet containing the CMR at the network interface of the SS and the arrival time of an active speech packet from the UE in response to this CMR at the network interface of the SS. + +#### 6.3.3.2 Open offer + +Requirement: + +The AMR bit rate (FT field) in sending shall be according to the i-th incoming CMR inserted by the SS with a response time $\leq 80$ ms and shall be valid until the next CMR over a time interval ranging from $i \cdot T_{\text{CMR}} + 80$ ms to $(i+1) \cdot T_{\text{CMR}}$ . + +NOTE: The expected response time is 60 ms, a margin of 20 ms is added to account for SS delay (assuming SS delay is less than 20 ms). + +Test method: + +**Table 6.3.3.2: List of CMRs to insert** + +| | | | | | | | | | +|-----------|------|------|------|------|------|------|------|------| +| i | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | +| CMR value | 0000 | 0001 | 0010 | 0011 | 0100 | 0101 | 0110 | 0111 | + +For the test case amr-cmr1 (see clause 6.2.2), the SS inserts the i-th CMR ( $i=0$ to $7$ ) at send time $i \cdot T_{\text{CMR}}$ according to Table 6.3.3.2, where $T_{\text{CMR}}$ is 2.4sec; the FT field is extracted from recorded RTP stream from the DUT and the value for active speech frame is reported with the corresponding packet arrival time. + +#### 6.3.3.3 Restricted offer + +Requirement: + +The AMR bit rate (FT field) in sending shall be according to the i-th incoming CMR ( $i=0$ to $7$ ) inserted by the SS with a response time $\leq 80$ ms and shall be valid until the next CMR over a time interval ranging from $i \cdot T_{\text{CMR}} + 80$ ms to $(i+1) \cdot T_{\text{CMR}}$ , if the mode in the CMR is defined in the mode-set, otherwise the AMR bit rate shall not change. + +NOTE: The expected response time is 60 ms, a margin of 20 ms is added to account for SS delay (assuming SS delay is less than 20 ms). Test method: + +For the test case amr-cmr2 (see clause 6.2.2), the SS inserts the i-th CMR ( $i=0$ to $7$ ) at send time $i \cdot T_{\text{CMR}}$ according to Table 6.3.3.2, where $T_{\text{CMR}}$ is 2.4sec; the FT field is extracted from recorded RTP stream from the DUT and the value for active speech frame is reported with the corresponding packet arrival time. + +## 6.4 RTCP tests + +### 6.4.1 General + +If the DUT is compliant with TS 26.139 [3], the RTCP tests defined in this clause may be skipped, otherwise the clause applies. + +### 6.4.2 Verification of SR and RR reports + +Characterisation is performed for test case amr-imp. The following information shall be reported: packet loss in terms of 'fraction lost' and 'cumulative number of packets lost' according to the timing interval of impairments, number of inverted and duplicated packets, interarrival jitter (using a computation similar to [3] clause 6.2.3.2). + +NOTE1: Packets that arrive late are not counted as lost (see RFC 3550 [14]). + +NOTE2: If the loss is negative due to duplicates, the fraction lost is set to zero (see RFC 3550 [14]). + +### 6.4.3 RTCP bandwidth verification + +Characterisation is performed for test case amr-imp. RTCP bandwidth is checked using the computation in [3] clause 6.2.3.2, applied to the whole test duration. + +# 7 RTP Payload Format Conformance for AMR-WB + +## 7.1 Applicability + +The requirements and test methods in this clause shall apply when UE is used to provide wideband telephony, either as a stand-alone service, or as part of a multimedia service. + +## 7.2 SDP tests + +### 7.2.1 MO call + +Requirement: + +Requirements on the SDP offer from the DUT are for further study. + +NOTE: SDP testing is already considered in [4,5,6,7]. + +Test method: + +A call is established by the DUT. The SDP offer from the DUT shall be documented. + +### 7.2.2 MT calls + +Requirement: + +Requirements on the SDP answer from the DUT are for further study. + +NOTE: Verification of b=AS is for further study. Purpose is to check compliance to [13] Annex K: b=AS is expected to be set according to the highest allowed codec mode and other parameters (IP version,ptime, bandwidth efficient or octet-align mode) in the SDP answer. + +Test method: + +Every call is established by the system simulator using one AMR-WB payload type in the SDP offer. The system simulator shall configure the SDP offer according to Table 7.2.2-1 for the bandwidth-efficient mode of AMR-WB and Table 7.2.2-2 for the octet-aligned mode of AMR-WB. + +For each SDP offer, the SDP answer from the DUT shall be documented and the corresponding RTP and RTCP streams shall be recorded. + +The test signal to be used for the measurements shall be the same in both directions as specified below depending on test cases: + +- speech1: the British-English single talk sequence described in ITU-T Recommendation P.501 [10]. +- silence1: test signal forced to silence (same length as speech1). +- speech2: first sentence of the British-English single talk sequence described in ITU-T Recommendation P.501 [10] shortened to 2.4sec by selecting samples in interval [0.5sec, 2.9sec], repeated 16 times. +- silence2: test signal forced to silence (same length as speech2). +- speech3: 3 repeats of the Composite Source Signal (CSS) according to ITU-T Recommendation P.501 [10] followed by a speech signal of 160 s as in clause 7.10.4.2 of TS 26.132 [2]. +- silence3: test signal forced to silence (same length as speech3). + +In sending, for acoustic interfaces, the test signal level should be -4,7 dBPa measured at the MRP; for electrical interfaces, the active speech level of the signal should be calibrated to -60 dBV for analogue and to -16 dBm0 for digital connections. + +In receiving, the test signal level should be -16 dBm0 measured at the digital reference point or the equivalent analogue point. + +**Table 7.2.2-1: List of test cases for MT calls for given SDP offer (bandwidth-efficient)** + +| Test case | Parameter the SDP offer | Mode-set in SDP answer | Input to DUT | Input to system simulator | +|------------|-----------------------------------|------------------------|-----------------------|---------------------------| +| amrwb-0 | mode-set=0 | 0 | speech1 | silence1 | +| amrwb-1 | mode-set=1 | 1 | speech1 | silence1 | +| amrwb-2 | mode-set=2 | 2 | speech1 | silence1 | +| amrwb-3 | mode-set=3 | 3 | speech1 | silence1 | +| amrwb-4 | mode-set=4 | 4 | speech1 | silence1 | +| amrwb-5 | mode-set=5 | 5 | speech1 | silence1 | +| amrwb-6 | mode-set=6 | 6 | speech1 | silence1 | +| amrwb-7 | mode-set=7 | 7 | speech1 | silence1 | +| amrwb-8 | mode-set=8 | 8 | speech1 | silence1 | +| amrwb-oo | mode-set not present (open offer) | See NOTE 1 | speech1 | silence1 | +| amrwb-cmr1 | mode-set not present (open-offer) | See NOTE 1 | speech2 (see NOTE 2) | speech2 | +| amrwb-cmr2 | mode-set=0,1,2 | 0,1,2 | speech2 (see NOTE 2) | speech2 | +| amrwb-qbit | mode-set=2 | 2 | silence1 | speech1 (see NOTE 3) | +| amrwb-imp | mode-set=2 | 2 | silence3 (see NOTE 4) | speech3 | + +NOTE 1: The DUT may restrict the mode-set in its answer to a restricted set of AMR-WB modes, e.g., to 0,2,4,7 or a further subset due to configuration. +NOTE 2: The system simulator inserts CMRs in the RTP stream in this test case. +NOTE 3: The system simulator forces Q bit to 0 in all packets of the RTP stream in test case 'amr-qbit'. +NOTE 4: The system simulator inserts packet impairments (using profile in Annex A) in the RTP stream in this test case. + +**Table 7.2.2-2: List of test cases for MT calls for given SDP offer (octet-aligned)** + +| Test case | Parameter the SDP offer | Mode-set in SDP answer | Input to DUT | Input to system simulator | +|---------------|---------------------------|------------------------|--------------|---------------------------| +| amrwb-octet-2 | mode-set=2; octet-align=1 | 7 | speech1 | silence1 | + +## 7.3 RTP tests + +### 7.3.1 Test cases in sending + +#### 7.3.1.1 FT verification + +Requirement: + +The FT entry in the ToC shall be match the active speech bit rate index according to RFC 4867 [9]. + +The FT entry in the ToC shall be match the SID bit rate index according to RFC 4867 [9]. + +Test method: + +For each test case amrwb-0 to amrwb-8 (see clause 6.2.2), the ToC field is extracted for recorded RTP stream from the DUT and compared with the respective AMR-WB mode (0 to 8) for active speech packets or SID bitrate for SID packets. + +NOTE: The value of FT is defined in Table 1a in TS 26.190 [12] for AMR-WB. + +#### 7.3.1.2 Q-bit verification + +Requirement: + +The Q-bit shall always be set to 1 in the RTP payload. + +NOTE: The Q-bit is the frame quality indicator [8]. If set to 0, it indicates that the corresponding frame is severely damaged, and the receiver should set the RX\_TYPE to either SPEECH\_BAD or SID\_BAD depending on the frame type (FT). + +Test method: + +For each test case amrwb-0 to amrwb-8 (see clause 7.2.2), the Q-bit field is extracted from recorded RTP stream from the DUT and the value is compared to 1. + +#### 7.3.1.3 SID update periodicity + +Requirement: + +The DUT shall respect the SID update rules specified in [8]. SID frames shall be sent with the following pattern: + +- First SID frame 20ms after the last speech frame (SID\_FIRST) +- Second SID frame (first SID UPDATE): 60 ms after the first SID frame +- Following SID UPDATE: every 160 ms + +NOTE: Network equipment may monitor RTP traffic and release the call (false communications cutting detection) if SID update is incorrect. + +Test method: + +For the test case amrwb-7 (see clause 7.2.2), analyse and report the RTP sending frames intervals for SID frames according to requirement. + +### 7.3.2 Test cases in receiving + +#### 7.3.2.1 Q-bit verification + +Requirement: + +Quality requirement are ffs. + +Test method: + +The system simulator shall send an AMR-WB coded RTP stream where the Q bit is set to 0 and record the audio output from the DUT. + +### 7.3.3 Test cases with CMR + +#### 7.3.3.1 Response time definition + +The UE response time in the send direction (uplink) to an incoming CMR is defined as the delay between the send time of a packet containing the CMR at the network interface of the SS and the arrival time of an active speech packet from the UE in response to this CMR at the network interface of the SS. + +#### 7.3.3.2 Open offer + +Requirement: + +The AMR-WB bit rate (FT field) in sending shall be according to the i-th incoming CMR inserted by the SS with a response time $\leq 80$ ms and shall be valid until the next CMR over a time interval ranging from $i \cdot T_{\text{CMR}} + 80$ ms to $(i+1) \cdot T_{\text{CMR}}$ . + +NOTE: The expected response time is 60 ms, a margin of 20 ms is added to account for SS delay (assuming SS delay is less than 20 ms). + +Test method: + +**Table 7.3.3.2: List of CMRs to insert** + +| | | | | | | | | | | +|-----|------|------|------|------|------|------|------|------|------| +| i | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | +| CMR | 0000 | 0001 | 0010 | 0011 | 0100 | 0101 | 0110 | 0111 | 1000 | + +For the test case amrwb-cmr1 (see clause 7.2.2), the SS inserts the i-th CMR ( $i=0$ to 8) at send time $i \cdot T_{\text{CMR}}$ according to Table 7.3.3.2, where $T_{\text{CMR}}$ is 2.4sec; the FT field is extracted from recorded RTP stream from the DUT and the value for active speech frame is reported with the corresponding packet arrival time. + +#### 7.3.3.2 Restricted offer + +Requirement: + +The AMR-WB bit rate (FT field) in sending shall be according to the i-th incoming CMR ( $i=0$ to 7) inserted by the SS with a response time $\leq 80$ ms and shall be valid until the next CMR over a time interval ranging from $i \cdot T_{\text{CMR}} + 80$ ms to $(i+1) \cdot T_{\text{CMR}}$ , if the mode in the CMR is defined in the mode-set, otherwise the AMR bit rate shall not change. + +NOTE: The expected response time is 60 ms, a margin of 20 ms is added to account for SS delay (assuming SS delay is less than 20 ms). + +Test method: + +For the test case amrwb-cmr2 (see clause 7.2.2), the SS inserts the i-th CMR ( $i=0$ to 7) at send time $i \cdot T_{\text{CMR}}$ according to Table 7.3.3.2, where $T_{\text{CMR}}$ is 2.4sec; the FT field is extracted from recorded RTP stream from the DUT and the value for active speech frame is reported with the corresponding packet arrival time. + +## 7.4 RTCP tests + +### 7.4.1 General + +If the DUT is compliant with TS 26.139 [3], the RTCP tests defined in this clause may be skipped, otherwise the clause applies. + +### 7.4.2 Verification of SR and RR reports + +Characterisation is performed for test case amr-wb-imp. The following information shall be reported: packet loss in terms of 'fraction lost' and 'cumulative number of packets lost' according to the timing interval of impairments, number of inverted and duplicated packets, interarrival jitter (using a computation similar to [3] clause 6.2.3.2). + +NOTE1: Packets that arrive late are not counted as lost (see RFC 3550 [14]). + +NOTE2: If the loss is negative due to duplicates, the fraction lost is set to zero (see RFC 3550 [14]). + +### 7.4.3 RTCP bandwidth verification + +Characterisation is performed for test case amr-wb-imp. RTCP bandwidth is checked using the computation in [3] clause 6.2.3.2, applied to the whole test duration. + +# 8 RTP Payload Format Conformance for EVS + +## 8.1 Applicability + +The requirements and test methods in this clause shall apply when UE is used to provide narrowband, wideband, super-wideband or fullband telephony, either as a stand-alone service, or as part of a multimedia service. + +## 8.2 SDP tests + +### 8.2.1 MO call + +Requirement: + +Requirements on the SDP offer from the DUT are for further study. + +NOTE: SDP testing is already considered in [4,5,6,7]. + +Test method: + +A call is established by the DUT. The SDP offer from the DUT shall be documented. + +### 8.2.2 MT calls + +Requirement: + +Requirements on the SDP answer from the DUT are for further study. + +NOTE: Verification of b=AS is for further study. Purpose is to check compliance to [13] Annex Q: b=AS is expected to be set according to the operation mode (Primary or AMR-WB IO) with highest bitrate and other parameters (IP version, ptime, default or header-full mode) in the SDP answer. + +Test method: + +Every call is established by the system simulator using one EVS payload type in the SDP offer. The system simulator shall configure the SDP offer according to Table 8.2.2-1 for the default packetization mode of EVS (i.e., hf-only present) and Table 8.2.2-2 for the header-full packetization mode of EVS (i.e., hf-only=1). + +For each SDP offer, the SDP answer from the DUT shall be documented and the corresponding RTP and RTCP streams shall be recorded. + +The test signal to be used for the measurements shall be the same in both directions as specified below depending on test cases: + +- speech1: the British-English single talk sequence described in ITU-T Recommendation P.501 [10]. +- silence1: test signal forced to silence (same length as speech1). +- speech2: first sentence of the British-English single talk sequence described in ITU-T Recommendation P.501 [10] shortened to 2.4sec by selecting samples in interval [0.5sec, 2.9sec], repeated 16 times. +- silence2: test signal forced to silence (same length as speech2). +- speech3: 3 repeats of the Composite Source Signal (CSS) according to ITU-T Recommendation P.501 [x13] followed by a speech signal of 160 s as in clause 7.10.4.2 of TS 26.132 [2]. +- silence3: test signal forced to silence (same length as speech3). + +In sending, for acoustic interfaces, the test signal level should be -4,7 dBPa measured at the MRP; for electrical interfaces, the active speech level of the signal should be calibrated to -60 dBV for analogue and to -16 dBm0 for digital connections. + +In receiving, the test signal level should be -16 dBm0 measured at the digital reference point or the equivalent analogue point. + +**Table 8.2.2-1: List of test cases for MT calls for given SDP offer (default packetization mode)** + +| Test case | Parameter the SDP offer | Parameter the SDP answer | Input to DUT | Input to system simulator | +|----------------|-------------------------|--------------------------|-----------------------|---------------------------| +| evs-primary-0 | br=5.9; bw=nb | Same as in SDP offer | speech1 | silence1 | +| evs-primary-1 | br=7.2; bw=wb | | speech1 | silence1 | +| evs-primary-2 | br=8; bw=wb | | speech1 | silence1 | +| evs-primary-3 | br=9.6; bw=wb | | speech1 | silence1 | +| evs-primary-4 | br=13.2; bw=swb | | speech1 | silence1 | +| evs-primary-5 | br=16.4; bw=swb | | speech1 | silence1 | +| evs-primary-6 | br=24.4; bw=swb | | speech1 | silence1 | +| evs-primary-7 | br=32; bw=fb | | speech1 | silence1 | +| evs-primary-8 | br=48; bw=fb | | speech1 | silence1 | +| evs-primary-9 | br=64; bw=fb | | speech1 | silence1 | +| evs-primary-10 | br=96; bw=fb | | speech1 | silence1 | +| evs-primary-11 | br=128; bw=fb | | speech1 | silence1 | +| evs-io-0-recv | br=5.9-24.4;bw=nb-swb | Same as in SDP offer | silence1 | speech3 (see NOTE1) | +| evs-io-1-recv | | | silence1 | speech3 (see NOTE1) | +| evs-io-2-recv | | | silence1 | speech3 (see NOTE1) | +| evs-io-3-recv | | | silence1 | speech3 (see NOTE1) | +| evs-io-4-recv | | | silence1 | speech3 (see NOTE1) | +| evs-io-5-recv | | | silence1 | speech3 (see NOTE1) | +| evs-io-6-recv | | | silence1 | speech3 (see NOTE1) | +| evs-io-7-recv | | | silence1 | speech3 (see NOTE1) | +| evs-io-8-recv | | | silence1 | speech3 (see NOTE1) | +| evs-oo | None (open offer) | See NOTE 2 | speech1 | silence1 | +| evs-imp-recv | br=24.4;bw=swb | br=24.4; bw=swb | silence3 (see NOTE 3) | speech3 | + +NOTE 1: The system simulator encodes the input signal with EVS AMR-WB IO at the corresponding mode M for evs-io-M-recv (M=0 to 8). + +NOTE 2: The DUT may restrict the br parameter or mode-set in its answer to a restricted set of bitrate or AMR-WB-IO modes due to configuration. + +NOTE 3: The system simulator inserts packet impairments (using profile in Annex A) in the RTP stream in this test case. + +**Table 3b: List of test cases for MT calls for given SDP offer (header-full packetization mode).** + +| Test case | Parameter the SDP offer | Parameter the SDP answer | Input to DUT | Input to system simulator | +|--------------------------|------------------------------------------|--------------------------|----------------------|---------------------------| +| evs-cmr1-1 to evs-cmr1-7 | None (open-offer) | See NOTE 1 | speech2 (see NOTE 2) | speech2 | +| evs-cmr2-1 to evs-cmr2-7 | br=5.9-24.4; bw=swb | See NOTE 1 | speech2 (see NOTE 2) | speech2 | +| evs-io-cmr | evs-mode-switch=1 hf-only=1 | See NOTE 1 | speech2 (see NOTE 3) | speech2 | +| evs-io-0 | mode-set=0; evs-mode-switch=1; hf-only=1 | Same as in SDP offer | speech1 | silence1 | +| evs-io-1 | mode-set=1; evs-mode-switch=1; hf-only=1 | | speech1 | silence1 | +| evs-io-2 | mode-set=1; evs-mode-switch=1 | | speech1 | silence1 | +| evs-io-3 | mode-set=1; evs-mode-switch=1; hf-only=1 | | speech1 | silence1 | +| evs-io-4 | mode-set=1; evs-mode-switch=1; hf-only=1 | | speech1 | silence1 | +| evs-io-5 | mode-set=1; evs-mode-switch=1; hf-only=1 | | speech1 | silence1 | +| evs-io-6 | mode-set=1; evs-mode-switch=1; hf-only=1 | | speech1 | silence1 | +| evs-io-7 | mode-set=1; evs-mode-switch=1; hf-only=1 | | speech1 | silence1 | +| evs-io-8 | mode-set=1; evs-mode-switch=1; hf-only=1 | | speech1 | silence1 | +| evs-io-qbit | mode-set=1; evs-mode-switch=1; hf-only=1 | | silence1 | speech1 (see NOTE 4) | + +NOTE 1: The DUT may restrict the br parameter or mode-set in its answer to a restricted set of bitrate or AMR-WB-IO modes due to configuration. +NOTE 2: The system simulator inserts CMRs in the RTP stream in this test case. +NOTE 3: CMR to EVS AMR-BIO modes 14.25 and 19.85 are not supported in Compact mode, see Table A.2 in [x9], therefore this test case is defined in header-full mode. +NOTE 4: The system simulator forces Q bit to 0 in all packets of the RTP stream in test case 'evs-io-cmr'. + +## 8.3 RTP tests + +### 8.3.1 Test cases in sending + +#### 8.3.1.1 ToC byte verification + +Requirement: + +The ToC byte in each RTP active speech packet shall match the active bit rate, bandwidth, and operation mode according to Annex A of TS 26.445 [9]. + +The ToC byte in each SID packet shall match the SID indication according to Annex A of TS 26.445 [9]. + +Test method: + +For each test case evs-io-0 to evs-io-8 (see clause 8.2.2), the ToC field is extracted for recorded RTP stream from the DUT and compared with the respective operation mode for active speech and SID packets. + +#### 8.3.1.2 Q-bit verification + +Requirement: + +The Q-bit shall always be set to 1 in the RTP payload when EVS AMR-WB-IO and header-full modes are negotiated. + +NOTE: The Q-bit is the frame quality indicator [8]. If set to 0, it indicates that the corresponding frame is severely damaged, and the receiver should set the RX\_TYPE to either SPEECH\_BAD or SID\_BAD depending on the frame type (FT). + +Test method: + +For each test case evs-io-0 to evs-io-8 (see clause 8.2.2), the Q-bit field is extracted from recorded RTP stream from the DUT and the value is compared to 1. + +#### 8.3.1.3 SID update periodicity + +Requirement: + +The DUT shall respect the SID update rules described in clause 5.6.1.1 of TS 26.445 [9]. + +SID frames shall be sent: + +- Either at a fixed rate: in such case interval shall be 20 ms multiple in range [60 ms; 2 s] +- or at adaptative rate: in such case interval shall be 20 ms multiple in range [160 ms; 1 s] + +Test method: + +For the test case evs-primary-0 to evs-primary-11 and evs-io-0 to evs-io-7 (see clause 8.2.2), analyse and report the RTP sending frames intervals for SID frames according to requirement. + +### 8.3.2 Test cases in receiving + +#### 8.3.2.1 Q-bit verification + +Requirement: + +Quality requirement are ffs. + +Test method: + +The system simulator shall send an EVS AMR-WB-IO coded RTP stream where the Q bit is set to 0 (test case 'evs-io-qbit') and record the audio output from the DUT. + +#### 8.3.2.2 Quality verification in receiving + +Requirement: + +The score $MOS-LQO_{TEST}$ shall be $\geq 3.0$ in all receiving tests evs-io-0-recv to evs-io-8-recv. + +Test method: + +The speech quality of the signal is estimated using the measurement algorithm described in ITU-T Recommendation P.863 [15] in super-wideband mode. Level pre-alignment to -26 dBov of recordings shall be used – see P.863.1 clause 10.2 [16]. + +A score shall be computed for each 8s speech sentence pair and averaged to produce a mean MOS-LQO value for the test conditions. + +$$MOS-LQO_{TEST} = (\sum_{i=1}^{20} MOS - LQO_{testcondition}(i))/20$$ + +The synchronization between stimuli and degraded condition shall be done by the test system before applying the P.863 algorithm on each sentence pair according to TS 26.132 [2]. + +### 8.3.3 Test cases with CMR + +#### 6.3.3.1 Response time definition + +The UE response time in the send direction (uplink) to an incoming CMR is defined as the delay between the send time of a packet containing the CMR at the network interface of the SS and the arrival time of an active speech packet from the UE in response to this CMR at the network interface of the SS. + +#### 8.3.3.2 Open offer + +Requirement: + +The EVS operation mode (Primary or AMR-WB IO), bandwidth, bit rate, and CAM operation in sending shall be according to the i-th CMR byte inserted by the SS with a response time $\leq 80\text{ms}$ and shall be valid until the next CMR over a time interval ranging from $i \cdot T_{\text{CMR}} + 80\text{ ms}$ to $(i+1) \cdot T_{\text{CMR}}$ , if a CMR is sent at time $T_{\text{CMR}}$ . + +NOTE: The expected response time is 60 ms, a margin of 20 ms is added to account for SS delay (assuming SS delay is less than 20 ms). + +If the CMR value is 'Not used', the DUT is expected to ignore the value, i.e., it shall not change its encoding mode. + +Test method: + +**Table 8.3.3.2-1: List of CMRs (T value) to insert** + +| | | | | | | | | +|------------------------|-----|-----|-----|-----|-----|-----|-----| +| j | 1 | 2 | 3 | 4 | 5 | 6 | 7 | +| Value of T in CMR byte | 000 | 001 | 010 | 011 | 100 | 101 | 110 | + +**Table 8.3.3.2-2: List of CMRs (D value) to insert** + +| | | | | | | | | | +|------------------------|------|------|------|------|------|------|------|------| +| i | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | +| Value of D in CMR byte | 0000 | 0001 | 0010 | 0011 | 0100 | 0101 | 0110 | 0111 | +| i | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | +| Value of D in CMR byte | 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 | 1111 | + +For the test case evs-cmr1-j where j=1 to 7 (see clause 8.2.2), the SS inserts the i-th CMR byte (i=0 to 7) at send time $i \cdot T_{\text{CMR}}$ , where $T_{\text{CMR}}$ is 2.4sec; the CMR byte is defined according to TS 26.445 Table A.3 [9] with the T value according to Table 8.3.3.2-1 and the D value according to Table 8.3.3.2-2. If the requested operation in the CMR byte is 'Not used', CMR byte shall be sent. The ToC byte is extracted from recorded RTP stream from the DUT and the operation mode, bandwidth, bit rate, and CAM operation for active speech frame is reported. + +#### 8.3.3.3 Restricted offer + +Requirement: + +The EVS operation mode (Primary or AMR-WB IO), bandwidth, bit rate, and CAM operation in sending shall be according to the i-th CMR byte inserted by the SS with a response time $\leq 80\text{ ms}$ and shall be valid until the next CMR over a time interval ranging from $i \cdot T_{\text{CMR}} + 80\text{ ms}$ to $(i+1) \cdot T_{\text{CMR}}$ , if a CMR byte is sent at time $T_{\text{CMR}}$ and the requested operation in the CMR is allowed by the accepted SDP answer, otherwise it shall not change. + +NOTE: The expected response time is 60 ms, a margin of 20 ms is added to account for SS delay (assuming SS delay is less than 20 ms). + +Test method: + +For the test case evs-cmr2-j where j=1 to 7 (see clause 8.2.2), , the SS inserts the i-th CMR byte (i=0 to 7) at send time $i.T_{CMR}$ , where $T_{CMR}$ is 2.4sec; the CMR byte is defined according to TS 26.445 Table A.3 [9] with the T value according to Table 8.3.3.2-1 and the D value according to Table 8.3.3.2-2. The ToC byte is extracted from recorded RTP stream from the DUT and the operation mode, bandwidth, bit rate, and CAM operation for active speech frame is reported. + +## 8.4 RTCP tests + +### 8.4.1 General + +If the DUT is compliant with TS 26.139 [3], the RTCP tests defined in this clause may be skipped, otherwise the clause applies. + +### 8.4.2 Verification of SR and RR reports + +Characterisation is performed for test case evs-imp-recv. The following information shall be reported: packet loss in terms of 'fraction lost' and 'cumulative number of packets lost' according to the timing interval of impairments, number of inverted and duplicated packets, interarrival jitter (using a computation similar to [3] clause 6.2.3.2). + +NOTE1: Packets that arrive late are not counted as lost (see RFC 3550 [14]). + +NOTE2: If the loss is negative due to duplicates, the fraction lost is set to zero (see RFC 3550 [14]). + +### 8.4.3 RTCP bandwidth verification + +Characterisation is performed for test case evs-imp. RTCP bandwidth is checked using the computation in [3] clause 6.2.3.2, applied to the whole test duration. + +# --- Annex A (normative): Packet impairment profile + +The impairment profile used in RTCP tests is defined in [2] Annex F. + diff --git a/marked/Rel-18/26_series/26139/54fabc351eda5228d2fa28cd9ba07971_img.jpg b/marked/Rel-18/26_series/26139/54fabc351eda5228d2fa28cd9ba07971_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cf4ad08c8ab08feeb96943c146ecc92d4e3ec971 --- /dev/null +++ b/marked/Rel-18/26_series/26139/54fabc351eda5228d2fa28cd9ba07971_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e2191e2825f0dbe31f30f26704b2ac3afc9accdc91c7e3ed1c6f06fea99475fd +size 7744 diff --git a/marked/Rel-18/26_series/26139/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-18/26_series/26139/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d3070e4844557ed5197de498464fe997f19c3515 --- /dev/null +++ b/marked/Rel-18/26_series/26139/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85455701e80a5e0060fc6f47ceb4f3b9d5b8b97f42030d02cb88565a8b0a2038 +size 14490 diff --git a/marked/Rel-18/26_series/26139/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/26_series/26139/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f301dae4f84f42e691e7cc7083cfd6b22e8b8294 --- /dev/null +++ b/marked/Rel-18/26_series/26139/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c42ff3a321c0352af3694d41926201475415330d1c65bac19c96d779233ebac +size 9514 diff --git a/marked/Rel-18/26_series/26139/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/26_series/26139/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1f312829e4540655e979c7a5c37d2077984392cd --- /dev/null +++ b/marked/Rel-18/26_series/26139/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c363fd0f6eb65ac558508adcf599adb3717d29375fd3685298afb8a63adf3437 +size 5656 diff --git a/marked/Rel-18/26_series/26139/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg b/marked/Rel-18/26_series/26139/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..38f8a722a258c7591b4c2d5f08e611ae5e09e034 --- /dev/null +++ b/marked/Rel-18/26_series/26139/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:07722aabc8d41050d7521a6732523fd24fe9956c8b82b56f661484ad5a2c7a3e +size 19791 diff --git a/marked/Rel-18/26_series/26139/7e670a2b556b53ea9002dfff3a420e08_img.jpg b/marked/Rel-18/26_series/26139/7e670a2b556b53ea9002dfff3a420e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6b17ec98d448a30cff524f95d0a56bda9caa15d4 --- /dev/null +++ b/marked/Rel-18/26_series/26139/7e670a2b556b53ea9002dfff3a420e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4093be31e4443733bbdc9ac163f1d2b0bc1249b2f12c70f3d2f2f0d9b97d0833 +size 15430 diff --git a/marked/Rel-18/26_series/26139/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg b/marked/Rel-18/26_series/26139/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3f7e45678dcbd262abe8514882940da9867e8e3b --- /dev/null +++ b/marked/Rel-18/26_series/26139/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:50f91c3712c78858922537329b1eeab58b37daeb04b88c96a089baff8a043ec6 +size 14164 diff --git a/marked/Rel-18/26_series/26139/raw.md b/marked/Rel-18/26_series/26139/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a8d0dfec2d9970c25b842bf41a197f4b585163c0 --- /dev/null +++ b/marked/Rel-18/26_series/26139/raw.md @@ -0,0 +1,1793 @@ + + +# **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; RTP/RTCP Verification Procedures (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green wave-like signal icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font. Below the 'P' is a small red signal icon, and below the entire logo is the text 'A GLOBAL INITIATIVE'. + +3GPP logo + +# **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Background ..... | 9 | +| 5 Test Architectures ..... | 9 | +| 5.1 General ..... | 9 | +| 5.2 Active Test Instrument..... | 10 | +| 5.3 Passive Test Instrument..... | 10 | +| 5.4 Interconnected Systems Under Test..... | 10 | +| 6 Verification Tests..... | 11 | +| 6.1 General ..... | 11 | +| 6.2 RTCP Tests ..... | 12 | +| 6.2.1 General ..... | 12 | +| 6.2.2 Basic RTCP Tests..... | 12 | +| 6.2.2.1 Initial Sending No Data RTCP Test ..... | 12 | +| 6.2.2.2 Initial Receiving No Data RTCP Test ..... | 13 | +| 6.2.2.3 Sending Data RTCP Test..... | 13 | +| 6.2.2.4 Mid-Session Sending No Data RTCP Test..... | 13 | +| 6.2.2.5 Mid-Session Receiving No Data RTCP Test..... | 14 | +| 6.2.2.6 Compound RTCP Packet Format Test..... | 14 | +| 6.2.2.7 RTCP Report Count Test..... | 15 | +| 6.2.3 RTCP Bandwidth and Transmission Timing Tests ..... | 15 | +| 6.2.3.1 RTCP Disable Test ..... | 15 | +| 6.2.3.2 RTCP Basic Interval Test ..... | 16 | +| 6.2.3.3 RTCP Explicit Bandwidth Test ..... | 16 | +| 6.2.3.4 RTCP Timeout Test ..... | 17 | +| 6.2.3.5 RTCP Step Join Backoff Receiver Test..... | 18 | +| 6.2.3.6 RTCP Step Join Backoff Sender Test..... | 18 | +| 6.2.4 Sender Report Sender Info Tests ..... | 18 | +| 6.2.4.1 Sender SSRC Test..... | 18 | +| 6.2.4.2 NTP Test..... | 18 | +| 6.2.4.3 Wrapped NTP Test ..... | 19 | +| 6.2.4.4 Time Stamp Test..... | 20 | +| 6.2.4.5 Wrapped Time Stamp Test ..... | 20 | +| 6.2.4.6 Packet Count Test ..... | 21 | +| 6.2.4.7 Wrapped Packet Count Test ..... | 21 | +| 6.2.4.8 Octet Count Test ..... | 22 | +| 6.2.4.9 Wrapped Octet Count Test ..... | 22 | +| 6.2.5 Source Description (SDES) Tests ..... | 24 | +| 6.2.5.1 Basic SDES Test..... | 24 | +| 6.2.5.2 Canonical End-point Identifier (CNAME) Test ..... | 24 | +| 6.2.6 Receiver Report Block Tests..... | 25 | +| 6.2.6.1 SSRC Consistency Test ..... | 25 | +| 6.2.6.2 SSRC Completeness Test ..... | 25 | +| 6.2.6.3 SSRC Change Test..... | 26 | +| 6.2.6.4 Initial Zero Loss Test..... | 26 | +| 6.2.6.5 Zero Loss Test ..... | 27 | +| 6.2.6.6 Loss Test..... | 27 | +| 6.2.6.7 Wrapped Loss Test ..... | 28 | + +| | | | +|-------------------------------|---------------------------------------------------------------------|-----------| +| 6.2.6.8 | Duplicate Loss Test ..... | 29 | +| 6.2.6.9 | Out-of-sequence Loss Test ..... | 30 | +| 6.2.6.10 | All Loss Test..... | 31 | +| 6.2.6.11 | Extended Highest Sequence Number Received Test..... | 32 | +| 6.2.6.12 | Wrapped Extended Highest Sequence Number Received Test..... | 32 | +| 6.2.6.13 | Out-of-sequence Extended Highest Sequence Number Received Test..... | 33 | +| 6.2.6.14 | Interarrival Jitter Test..... | 33 | +| 6.2.6.15 | Last Sender Report Timestamp Test..... | 34 | +| 6.2.6.16 | Delay Since Last SR Test ..... | 35 | +| 6.2.7 | Feedback Report Block Tests..... | 36 | +| 6.2.7.1 | Ignoring Unknown Feedback Report Test..... | 36 | +| 6.2.8 | Extended Report Block Tests ..... | 36 | +| 6.2.8.1 | Ignoring Unknown XR Test ..... | 36 | +| 6.2.9 | APP Tests ..... | 37 | +| 6.2.9.1 | Ignoring Unknown APP Test..... | 37 | +| 6.2.10 | Reduced-Size Packet Tests..... | 37 | +| 6.2.10.1 | Ignoring Unsupported Reduced-Size Test..... | 37 | +| 6.3 | RTP Tests ..... | 38 | +| 6.3.1 | General ..... | 38 | +| 6.3.2 | Basic RTP Tests ..... | 38 | +| 6.3.2.1 | Receive RTP Padding Test ..... | 38 | +| 6.3.2.2 | Initial SSRC Value Test..... | 38 | +| 6.3.2.3 | Initial Sequence Number Test..... | 39 | +| 6.3.2.4 | Initial Time Stamp Test ..... | 39 | +| 6.3.3 | RTP Header Extension Tests..... | 40 | +| 6.3.3.1 | Ignore Unknown Header Extension Test..... | 40 | +| 6.3.4 | RTP Contributing Source Tests..... | 40 | +| 6.3.4.1 | Ignore Contributing Source Test..... | 40 | +| 6.4 | SRTCP Tests ..... | 41 | +| 6.4.1 | General ..... | 41 | +| 6.5 | SRTP Tests..... | 41 | +| 6.5.1 | General ..... | 41 | +| 7 | Conformance Indication..... | 41 | +| 7.1 | General ..... | 41 | +| 7.2 | The a=3gpp-rtp SDP attribute ..... | 41 | +| 7.2.1 | General ..... | 41 | +| 7.2.2 | ABNF syntax and semantics ..... | 41 | +| 7.2.3 | SDP offer/answer considerations ..... | 42 | +| 7.2.4 | IANA registration information ..... | 42 | +| Annex A (informative): | Change history..... | 43 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes: + +- Test cases needed to ensure an adequate level of RTP operation and RTP stream monitoring. +- Test methods capable to verify that information contained in the RTP header and in RTCP is correct and consistent with the observed characteristics of the related RTP streams: + - Between RTP/RTCP within the scope of a single RTP stream (e.g. between an RTP stream and the corresponding RTCP reporting from the remote party, or between an RTP stream and the corresponding RTCP metadata, e.g. for sampling clock accuracy compensation between RTP sender and RTP receiver). + - Between RTP/RTCP across RTP streams in the same RTP session (e.g. between sent and received RTP streams, or between audio RTP streams and video RTP streams). +- Requirements on what constitutes acceptable RTP/RTCP protocol field values, including RTP payload header and RTP payload length, based on the observed characteristics of the related RTP streams. +- A method for an RTP/RTCP implementation to announce on the network that it has passed the necessary tests and conforms to the new specification. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] IETF RFC 3550 (2003): "RTP: A Transport Protocol for Real-Time Applications". +- [3] IETF RFC 3158 (2001): "RTP Testing Strategies". +- [4] IETF RFC 3551 (2003): "RTP Profile for Audio and Video Conferences with Minimal Control". +- [5] IETF RFC 3711 (2004): "The Secure Real-time Transport Protocol (SRTP)". +- [6] IETF RFC 3556 (2003): "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [7] IETF RFC 4585 (2006): "Extended RTP Profile for Real-time Transport Control Protocol (RTCP) – Based Feedback (RTP/AVPF)". +- [8] IETF RFC 5506 (2009): "Support for Reduced-Size Real-Time Transport Control Protocol (RTCP): Opportunities and Consequences". +- [9] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [10] 3GPP TS 26.131: "Terminal acoustic characteristics for telephony; Requirements". + +- [11] 3GPP TS 26.132: "Speech and video telephony terminal acoustic test specification". +- [12] 3GPP TS 34.229-1: "Internet Protocol (IP) multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); User Equipment (UE) conformance specification; Part 1: Protocol conformance specification". +- [13] IETF RFC 3611 (2003): "RTP Control Protocol Extended Reports (RTCP XR)". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|-----------------------|-------------------------------------------------------------------------------------------------------------------| +| = | Equal to. | +| ≠ | Not equal to. | +| < | Less than. | +| ≤ | Less than or equal to. | +| > | Greater than. | +| ≥ | Greater than or equal to. | +| + | Addition. | +| − | Subtraction. | +| ⋅ | Multiplication (when unambiguous, also by juxtaposition of expressions, e.g. $a \cdot b = ab$ ). | +| / | Division. | +| % | Modulo, e.g. $a \% b$ , where the result is the remainder from $a$ divided by $b$ . | +| $\sum$ | Sum, e.g. $\sum_{i=1}^n \text{expression}$ is the sum of expression over index $i$ ranging from 1 to $n$ . | +| & | Bitwise AND. | +| | Bitwise OR. | +| ≪ | Logical shift left, e.g. $a \ll b$ , where $a$ is shifted left $b$ bits, shifting in 0 in least significant bit. | +| ≫ | Logical shift right, e.g. $a \gg b$ where $a$ is shifted right $b$ bits, shifting in 0 in most significant bit. | +| ∈ | Belongs to. | +| ∀ | For all. | +| ∃ | Exists. | +| ∄ | Does not exist. | +| [ $a..b$ ] | Range of values, from $a$ to $b$ , inclusive. | +| { expression } | Set of unordered, unique values created from expression . | +| expression | Absolute value of expression . | +| [ expression ] | Integer value of expression , the floor value, rounded towards zero. | + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-----|-------------------| +| SUT | System Under Test | +|-----|-------------------| + +# 4 Background + +Today's 3GPP conversational and real-time services (e.g. MTSI [9] and mission critical services) all use the RTP protocol [2] or the Secure RTP protocol [5] on top of UDP/IP as media transport. (S)RTP has a companion control protocol, (S)RTCP (also in [2] and [5]), which is optional but is typically also used. In the rest of the present document, only the terms RTP/RTCP are used for brevity but should be understood to be equally applicable to SRTP/SRTCP if nothing else is said. + +RTCP provides means to feedback statistical characteristics of a received RTP stream from RTP receiver to RTP sender, and to carry RTP stream metadata from RTP sender to RTP receiver, both during an active RTP session and in hold conditions where no RTP is sent. While RTP/RTCP information is designed to be useful to an ongoing real-time media session, the increased focus on automation and the consequential need for service observability and automatic performance measurements also makes it convenient and common to use RTP header and RTCP as one of the information sources to monitor the RTP streams for automation purposes. This is a very straightforward approach since it was one of the very design targets for RTP/RTCP, and both RTCP and RTP are extensible and can optionally carry various types of information. Service observability is paramount to enable any tuning or optimization to achieve a well-functioning system. + +However, RTCP information has little or no end-user impact on basic, single-media communication services such as a voice-only call. The reasons for this are mainly twofold: + +- 1) One of the intended usages of RTCP feedback reporting functionality is to allow the RTP sender to adapt its sending rate to available transport capacity since a non-acknowledged transport such as UDP/IP has no built-in congestion control, but most voice-only calls today are both low-rate and fixed-rate that has no use for adaptation; and +- 2) One of the other intended usages of RTCP is to provide enough metadata information to allow close time synchronization of different RTP streams, such as e.g. voice and video for a video call, but a voice-only call is single-media and has no use for such time synchronization. + +Therefore, there is often no direct impact on the voice service performance if a UE or network-node implementation of the RTP stack includes incorrect (e.g. all-zero or random) data in RTCP for a voice-only call. RTCP information content only matters on service level when really making use of RTCP functionality such as for quality monitoring, somehow acting on varying transport characteristics (loss, delay, jitter), or when performing inter-media synchronization. + +Also, while the call setup and modification protocol, SIP/SDP, is conformance tested in 3GPP scope (by TSG RAN WG5), no media-level tests are defined or performed there when the present document is written. RTP and RTCP are considered as media-level protocols in that conformance testing. The current overall level of RTCP implementation conformance and accuracy in 3GPP devices and in RTP/RTCP-terminating network nodes is therefore mostly unknown. + +Since the information content in RTP/RTCP is often neither fundamental for the user-level experience nor explicitly tested today, there is a risk that automation, performance tuning efforts, and the application using the RTP/RTCP stack will work with incorrect data, potentially making wrong decisions that could result in worse rather than better performance. + +# 5 Test Architectures + +## 5.1 General + +This clause describes a set of terms and possible ways to arrange the equipment used in the tests in subsequent clauses. + +The "system under test" is the device or software to be tested. + +The "test instrument" is the equipment used to observe RTP/RTCP output from the system under test, and in applicable cases also RTP/RTCP output from data injection, similar to e.g. a "System Simulator" (SS) in TS 34.229-1 [12]. Depending on the test architecture used, it may also act as RTP/RTCP receiver for data sent from the system under test. The test instrument also includes possibility to extract, calculate, and store information as described by the test procedures in clause 6 of the present document. + +The "data injection" is the device or equipment used to generate RTP/RTCP data sent to the system under test. It may be collocated or integrated with the test instrument. For some tests and test architectures, e.g. when two systems under test are interconnected, it may be part of the system under test. Data injection may also act as RTP/RTCP receiver for data sent from the system under test, e.g. when the test instrument does not include this functionality. + +In all tests, it is assumed that both systems under test, the test instrument, and the data injection are active and connected to the network before starting the test procedure. + +Other test architectures than the ones suggested here may be used. + +## 5.2 Active Test Instrument + +In this test architecture, depicted in Figure 5.2-1, the test instrument is capable of both observing RTP/RTCP traffic and acting as fully functional counterpart to the system under test, including both RTP/RTCP sender and receiver. + +![Diagram of Active Test Instrument architecture](54fabc351eda5228d2fa28cd9ba07971_img.jpg) + +``` +graph LR; A[System Under Test] <--> B[Test Instrument] +``` + +The diagram shows two rectangular boxes, 'System Under Test' on the left and 'Test Instrument' on the right, connected by a horizontal double-headed arrow, indicating bidirectional communication. + +Diagram of Active Test Instrument architecture + +Figure 5.2-1: Active Test Instrument + +## 5.3 Passive Test Instrument + +In this test architecture, depicted in Figure 5.3-1, the test instrument is only passively observing RTP/RTCP traffic, and data injection including both RTP/RTCP sender and receiver is acting as a counterpart to the system under test. + +![Diagram of Passive Test Instrument architecture](fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg) + +``` +graph LR; A[System Under Test] <--> B[Data Injection]; A --> C[Test Instrument]; B --> C +``` + +The diagram shows three rectangular boxes. 'System Under Test' is on the left and 'Data Injection' is on the right, connected by a horizontal double-headed arrow. Below them, a 'Test Instrument' box is centered. A vertical line descends from the horizontal connection between 'System Under Test' and 'Data Injection' to the 'Test Instrument' box, with an arrowhead pointing down to it, indicating that the test instrument is passively observing the traffic. + +Diagram of Passive Test Instrument architecture + +Figure 5.3-1: Passive Test Instrument + +## 5.4 Interconnected Systems Under Test + +In this test architecture, the test instrument is either only passively observing RTP/RTCP traffic, depicted in Figure 5.4-1, or actively forwarding RTP/RTCP traffic, depicted in Figure 5.4-2, while two interconnected systems under test act as each other's RTP/RTCP sender and receiver counterparts. + +![Diagram of interconnected systems under test with a passive test instrument.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` +graph TD; A[First System Under Test] <--> B[Second System Under Test]; A --> C[Test Instrument]; B --> C +``` + +The diagram shows two boxes, 'First System Under Test' and 'Second System Under Test', connected by a horizontal double-headed arrow. Below this connection, a vertical arrow points down to a third box labeled 'Test Instrument'. + +Diagram of interconnected systems under test with a passive test instrument. + +Figure 5.4-1: Interconnected Systems Under Test with Passive Test Instrument + +![Diagram of interconnected systems under test with an active test instrument.](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +``` +graph TD; A[First System Under Test] --> C[Test Instrument]; B[Second System Under Test] --> C +``` + +The diagram shows two boxes, 'First System Under Test' and 'Second System Under Test', at the bottom. Arrows point from each of these boxes up to a central box labeled 'Test Instrument' positioned above them. + +Diagram of interconnected systems under test with an active test instrument. + +Figure 5.4-2: Interconnected Systems Under Test with Active Test Instrument + +## 5.5 Interconnected Systems Under Test with Data Injection + +In this test architecture, depicted in Figure 5.5-1, the test instrument is only passively observing RTP/RTCP traffic, while two interconnected systems under test act as each other's RTP/RTCP sender and receiver counterparts. Under the assumption that the systems under test lack necessary data injection capabilities, a separate data injection is included in the RTP/RTCP path with capability to make RTP/RTCP modifications on-path. Examples of such RTP/RTCP modifications could be setting certain sequence number or timestamp start values, dropping packets, duplicating packets, re-ordering packets, or adjusting the timing of sent packets. Individual test case procedures provide what RTP/RTCP modifications are applicable. + +![Diagram of interconnected systems under test with data injection.](7c6d9bfe9c31ce872722d60b73d20df1_img.jpg) + +``` +graph TD; A[First System Under Test] --> C[Data Injection]; B[Second System Under Test] --> C; C --> D[Test Instrument] +``` + +The diagram shows two boxes, 'First System Under Test' and 'Second System Under Test', at the bottom. Arrows point from each of these boxes up to a central box labeled 'Data Injection' positioned above them. From the 'Data Injection' box, an arrow points down to a third box labeled 'Test Instrument' positioned below it. + +Diagram of interconnected systems under test with data injection. + +Figure 5.5-1: Interconnected Systems Under Test with Data Injection + +# --- 6 Verification Tests + +## 6.1 General + +All test descriptions in this clause use the following layout: + +Purpose: *Describes what is tested.* + +Status: *Mandatory / Conditionally Mandatory* + +Preconditions: *Describes any preconditions to be fulfilled to run the test.* + +Test procedure: *Describes the steps taken to run the test.* + +Stop condition: *Describes the conditions when the test is concluded, in time order if more than a single condition.* + +Pass criteria: *Describes the criteria to be met to pass the test.* + +Comments: *Any additional comments applicable to the test.* + +Mandatory tests are required to pass for a system under test. + +Conditionally Mandatory tests are mandatory to pass if the functionality is supported/implemented by the system under test, can be set or negotiated, and is correctly negotiated to be used during the test, the method of negotiation being described as part of the Preconditions section (see above). + +## 6.2 RTCP Tests + +### 6.2.1 General + +This clause describes tests that are applicable to all types of RTCP and SRTCP packets. If not explicitly stated otherwise, any reference to RTCP is equally applicable to SRTCP. Tests that are only applicable to SRTCP and not to RTCP are specified in clause 6.4. + +If not explicitly stated otherwise, all tests in this clause assume that the system under test (SUT) and the test setup are set to use: + +- 1) AVP profile [4] for RTCP tests. +- 2) SAVP profile [5] for SRTCP tests. +- 3) A known, non-zero RTP session bandwidth. +- 4) Non-zero RTCP bandwidth. +- 5) Lossless RTP and RTCP packet transmission. +- 6) An RTCP report interval that is on average large enough to not exceed the set RTCP bandwidth, and where each RTCP report interval is kept within the minimum and maximum limits set by that (deterministic) average and the interval randomization described by section 6.3.1 of RFC 3550 [2]. + +NOTE 1: The minimum, maximum, and average RTCP report intervals are not static parameters for an RTP/RTCP implementation but, as described in RFC 3550 [2], depend on conditions that vary with e.g. RTP session bandwidth, RTCP bandwidth, average size of RTCP packets, number of RTP session participants, and use of optional RTP/RTCP features such as RTCP feedback [7] and/or non-compound RTCP packets [8]. + +NOTE 2: The method to set RTCP report interval in the system under test can vary. The RTCP report interval can in some cases be set directly, if the system under test has appropriate means to do so. The RTCP report interval can alternatively be set indirectly by e.g. setting an appropriate RTCP bandwidth in combination with pre-knowledge about the expected average RTCP packet size. If it is not possible to set RTCP bandwidth directly, it could be possible to set an appropriate RTP session bandwidth and rely on RTCP bandwidth becoming the default 5 % of that RTP session bandwidth. + +### 6.2.2 Basic RTCP Tests + +#### 6.2.2.1 Initial Sending No Data RTCP Test + +Purpose: Test if RTCP packets are generated by the SUT even if no RTP packets are sent or received by the SUT at the start of the session. + +Status: Mandatory + +- Preconditions: The SUT is set to not send any RTP packets from the start of the test session, e.g. pre-configured or set as receive-only through test instrument signalling. +- Test procedure: Observe the SUT output. +- Stop condition: RTCP packets are sent from the SUT, or time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1). +- Pass criteria: +1) No RTP packets are sent from the SUT. +2) RTCP packets are sent from the SUT containing at least a Receiver Report. +- Comments: The test result is agnostic to RTP packets being received by the SUT or not. If the SUT is not receiving any RTP packets, the Receiver Report will be empty (no report blocks, see also test 6.2.2.2). + +#### 6.2.2.2 Initial Receiving No Data RTCP Test + +- Purpose: Test if RTCP Sender Reports or Receiver Reports without any Receiver Report blocks are generated by the SUT even if no RTP packets are received at the start of the session. +- Status: Mandatory +- Preconditions: The SUT is set to not receive any RTP packets from the start of the test session, e.g. pre-configured, set as send-only through test instrument signalling, or data injection configuration. +- Test procedure: Observe the SUT output. +- Stop condition: RTCP packets are sent from the SUT, or time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1). +- Pass criteria: +1) No RTP packets are received by the SUT. +2) RTCP packets are sent by the SUT containing at least a Sender Report or Receiver Report, with an empty Receiver Report block, indicated by RC=0. +- Comments: The test result is agnostic to RTP packets being sent by the SUT or not. + +#### 6.2.2.3 Sending Data RTCP Test + +- Purpose: Test if RTCP Sender Reports with nonzero content are sent by the SUT when RTP packets are sent by the SUT. +- Status: Mandatory +- Preconditions: The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. +- Test procedure: Observe the SUT output. +- Stop condition: +1) One or more RTP packets are sent by the SUT. +2) One or more RTCP packets are sent by the SUT, or time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1). +- Pass criteria: +1) RTP packets are sent by the SUT. +2) At least one RTCP packet is sent by the SUT containing at least a Sender Report. +3) The Sender Report contains nonzero Sender Info fields (NTP timestamp, RTP timestamp, sender's packet count, and sender's octet count). +- Comments: The test result is agnostic to RTP packets being received by the SUT or not. + +#### 6.2.2.4 Mid-Session Sending No Data RTCP Test + +- Purpose: Test if the content of Sender Reports sent by the SUT after the SUT has stopped sending RTP packets correctly reflect that RTP is no longer sent, and that RTCP transmission is changed to instead issue Receiver Reports at an appropriate time after RTP packet transmission was stopped. + +- Status: Mandatory +- Preconditions: 1) The SUT has passed tests 6.2.2.1 and 6.2.2.3. +2) The SUT is possible to control dynamically (e.g. directly through proprietary interfaces or via test instrument signalling) during an ongoing RTP session to turn sending of RTP packets on and off, while keeping the RTP session. +- Test procedure: 1) Set the SUT to send RTP packets. +2) Observe the SUT output until at least one RTCP Sender Report is sent by the SUT, or time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1). +3) If no RTCP Sender Report was sent by the SUT in step 2, stop the test and set it as failed. +4) Set the SUT to not send RTP packets. +5) Observe the SUT output. +- Stop condition: At least three RTCP packets are sent by the SUT during step 5 in the test procedure, or time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1) during step 5 in the test procedure. +- Pass criteria: The following conditions are fulfilled after step 5 in the test procedure: +1) No RTP packets are sent by the SUT. +2) The first two RTCP packets sent from the SUT contain Sender Reports with identical sender information in sender's packet count and sender's octet count. +3) The third RTCP packet sent from the SUT contains a Receiver Report. +- Comments: The test result is agnostic to RTP packets being received by the SUT or not. +IETF RFC 3550 [2] section 6.4 specifies to send a Sender Report if RTP was sent during this RTCP reporting interval or the previous one, otherwise a Receiver Report is sent. The two first Sender Reports in this test contain identical sender information in sender's packet count and sender's octet count since no packets were sent during the latter reporting period. + +#### 6.2.2.5 Mid-Session Receiving No Data RTCP Test + +- Purpose: Test if RTCP content from the SUT correctly indicates that no RTP packets were received by the SUT during the reporting period, even if RTP packets were received by the SUT previously in the RTP session. +- Status: Mandatory +- Preconditions: 1) The SUT has passed tests 6.2.2.2 and 6.2.2.3. +2) The data injection to the SUT is possible to control dynamically (e.g. directly through proprietary interfaces or via test instrument signalling) during an ongoing RTP session to turn sending of RTP packets on and off, while keeping the RTP session. +- Test procedure: 1) Set the data injection to send RTP packets to the SUT. +2) Observe the SUT output until at least one RTCP packet is sent from the SUT, or time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1). +3) If no RTCP packet was sent by the SUT in step 2, stop the test and set it as failed. +4) Set the data injection to not send RTP packets to the SUT. +5) Observe the SUT output. +- Stop condition: At least two RTCP packets are sent by the SUT during step 5 in the test procedure, or time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1) during step 5 in the test procedure. +- Pass criteria: The second RTCP packet sent from the SUT during step 5 of the test procedure contains a Sender Report or Receiver Report with an empty Receiver Report block, indicated by RC=0. +- Comments: The test result is agnostic to RTP packets being sent by the SUT or not. +If the data injection does not perform step 4 fast enough after step 2, the SUT may receive some RTP packets after step 2. Those RTP packets will then be reported on in the next RTCP packet sent from the SUT, which is the reason to use the second RTCP packet sent after step 4 as input to the pass criteria. + +#### 6.2.2.6 Compound RTCP Packet Format Test + +- Purpose: Test if the content and formatting of a compound RTCP packet sent by the SUT fulfils basic criteria. +- Status: Mandatory +- Preconditions: 1) The SUT has passed tests 6.2.2.1 – 6.2.2.5. +2) Reduced-size RTCP [8] is *not* negotiated to be used in the session (see clause 6.2.10 for reduced-size tests), e.g. indicated by "a=rtcp-rsize" *not* being present in the SDP answer for the tested RTP media. +- Test procedure: Observe the SUT output from tests 6.2.2.1 – 6.2.2.5. +- Stop condition: Not applicable (implicit through tests in 6.2.2.1 – 6.2.2.5). +- Pass criteria: All RTCP packets sent from the SUT fulfils: +1) A Sender Report or Receiver Report (equally acceptable for the outcome of this test) is included as the *first part* of the compound RTCP packet. +2) An SDES packet with a CNAME SDES item (see also test 6.2.5.2) is included in the compound RTCP packet (except when a compound RTCP packet is split for partial encryption, if used; see SRTCP tests in clause 6.4). +3) Each RTCP packet in the compound RTCP packet starts on a 32-bit boundary. +4) Each RTCP packet in the compound RTCP packet has a length field with a value that is the number of 32-bit words minus one occupied by that RTCP packet, including the RTCP packet header and any padding. +5) The UDP packet that contains the compound RTCP packet in criteria 4 as payload has a Length field with a value that is 4 times the sum of the length fields in all the RTCP packets in the compound RTCP packet (the total RTCP size in bytes), plus 8 (the UDP header size in bytes). + +#### 6.2.2.7 RTCP Report Count Test + +- Purpose: Test if RTCP packets sent by the SUT contain a correct and consistent report count and length fields. +- Status: Mandatory +- Preconditions: The SUT has passed tests 6.2.2.1 – 6.2.2.5. +- Test procedure: Observe the SUT output from tests 6.2.2.1 – 6.2.2.5. +- Stop condition: Not applicable (implicit through tests in 6.2.2.1 – 6.2.2.5). +- Pass criteria: All RTCP packets sent from the SUT fulfils: +1) Regardless if the RTCP packet is a Sender Report or Receiver Report, the report count (RC) field is consistent with the number of report blocks observed to be included in the packet. +2) The RTCP packet length field has a value that is the number of 32-bit words minus one occupied by that RTCP packet, including the RTCP packet header and any padding. +- Comments: This test does not cover a higher report count than 1, which can be required when more than a single RTP stream is sent in an RTP session, e.g. in multi-stream scenarios as described by TS 26.114 [9] Annex S. Tests covering a higher report count than 1 may be added in future revisions of the present document. + +### 6.2.3 RTCP Bandwidth and Transmission Timing Tests + +#### 6.2.3.1 RTCP Disable Test + +- Purpose: Test if setting RTCP bandwidth to zero in SDP disables RTCP transmission from the SUT. +- Status: Conditionally Mandatory (Precondition 1) + +Preconditions: 1) RTCP transmission by the SUT is disabled for the RTP session, e.g. pre-configured or negotiated in SDP by both b=RS:0 and b=RR:0 being present in the SDP answer (zero RTCP bandwidth) through test instrument signalling. + +Test procedure: Observe the SUT output. + +Stop condition: Time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1). + +Pass criteria: No RTCP packets are sent from the SUT. + +Comments: The test result is agnostic to RTP packets being sent or received by the SUT. + +#### 6.2.3.2 RTCP Basic Interval Test + +Purpose: Test if the time interval with which RTCP packets are sent from the SUT keeps within the maximum RTCP bandwidth and complies with IETF RFC 3550 [2], including prescribed randomization of the time interval (if used). + +Status: Mandatory + +Preconditions: 1) The SUT is set to not use any explicit RTCP bandwidth such that default RTCP bandwidth is used (based on 5 % of the RTP session bandwidth), e.g. pre-configured or through neither "b=RS" nor "b=RR" (see also test 6.2.3.3) being included in the SDP answer through test instrument signalling. +2) The SUT is set to send and receive RTP packets during the test session, e.g. pre-configured or set as send-receive in SDP answer through test instrument signalling. +3) The test RTP session contains no more than two participants (a point-to-point session). + +Test procedure: 1) Observe the SUT output. +2) Note the reception time ( $t_i$ ) and size ( $S_i$ ) in bits including UDP and IP headers of each RTCP packet sent from the SUT. +3) Count the number of RTCP packets, $n$ , sent from the SUT. +4) For each pair of subsequent RTCP packets, calculate the difference in send time (called the interval), $I_i = t_i - t_{i-1}$ , $i \in [2..n]$ . +5) Calculate the average RTCP interval $I = \frac{1}{n-1} \sum_{i=2}^n I_i$ . +6) Calculate the maximum RTCP interval $I_{max} = \max_i I_i$ . +7) Calculate the minimum RTCP interval $I_{min} = \min_i I_i$ . +8) Calculate the average RTCP bandwidth $B = (\sum_{i=1}^{n-1} S_i) / (\sum_{i=2}^n I_i)$ . +9) Calculate the average RTCP packet size $S = \frac{1}{n-1} \sum_{i=1}^{n-1} S_i$ . +10) Calculate the maximum RTCP bandwidth $B_M = 0.05 B_{RTP}$ , where $B_{RTP}$ = RTP session maximum bandwidth in bit/s, e.g. calculated from b=AS (converting from kbit/s to bit/s) in SDP answer. + +Stop condition: At least 10 minutes, or 100 RTCP packets are sent from the SUT, whichever time is less. + +Pass criteria: 1) $B \leq B_M$ . +2) $I_{min} \geq \frac{S}{(e-1.5)B_M}$ . +3) $I_{max} \leq \max\left(\frac{3S}{(e-1.5)B_M} \mid \frac{15}{2(e-1.5)}\right)$ . + +Comments: This test allows an exception to IETF RFC 3550 [2] and the RTP testing strategies in [3] stating that an implementation fails the test if the RTCP packets are sent with a constant interval (not randomized). + +The calculations of bandwidth limits are seemingly not in accordance with the definition of IETF RFC 4566 section 5.8 that says b=AS is the RTP session bandwidth (all RTP streams that are sent and received in the RTP session), but 3GPP specifications commonly interpret SDP b= lines as receive bandwidth seen from the part sending the SDP, which is thus only half of the actual RTP session bandwidth in a bandwidth-symmetric point-to-point session. + +The maximum and minimum interval limits are chosen based on the $[0.5T..1.5T]$ uniform distribution randomization of the RTCP interval, divided by the $e-1.5$ ( $=1.21828\dots$ ) reconsideration factor, both taken from section 6.2.1 of IETF RFC 3550. The maximum allowed interval (the lowest RTCP bandwidth) in this test is a uniformly distributed and randomized interval based on the longest of the + +interval calculated from actual RTCP packet sizes and maximum RTCP bandwidth, and the default 5 second interval. + +#### 6.2.3.3 RTCP Explicit Bandwidth Test + +- Purpose:** Test if the SUT keeps RTCP bandwidth within set maximum limit, e.g. by "b=RS" and "b=RR" in SDP, and the information in those is correctly interpreted with respect to SUT being sender in a point-to-point RTP session. +- Status:** Conditionally Mandatory (Precondition 1) +- Preconditions:** +- 1) The SUT can set explicit RTCP bandwidth. + - 2) The SUT has passed test 6.2.3.2. + - 3) The SUT is set to send and receive RTP packets during the test session, e.g. pre-configured or set as send-receive in SDP answer through test instrument signalling. +- Test procedure:** +- 1) Negotiate an explicit RTCP bandwidth in SDP, setting "b=RS:625" and "b=RR:1875" in SDP answer. + - 2) Observe the SUT output. + - 3) Note the reception time ( $t_i$ ) and size ( $S_i$ ) in bits of each RTCP packet sent from the SUT, including UDP and IP headers. + - 4) Count the number of RTCP packets, $n$ , sent from the SUT. + - 5) For each pair of subsequent RTCP packets, calculate the difference in send time, $I_i = t_i - t_{i-1}$ , $i \in [2..n]$ . + - 6) Calculate the average RTCP bandwidth $B = (\sum_{i=1}^{n-1} S_i) / (\sum_{i=2}^n I_i)$ . + - 7) Note the test result from step 6. + - 8) Negotiate an explicit RTCP bandwidth in SDP, setting "b=RS:0" and "b=RR:2500" in SDP answer. + - 9) Re-run steps 2-6 and note the test result from step 6. +- Stop condition:** At least 10 minutes, or 100 RTCP packets are sent from the SUT, whichever time is less, in each of steps 7 and 9. +- Pass criteria:** +- 1) $B \leq 2500 \text{ bit/s}$ , from step 7 of this test. + - 2) $B \leq 2500 \text{ bit/s}$ , from step 9 of this test. +- Comments:** Pass criteria 1 and 2 are identical because the proportion of senders in this point-to-point RTP session (100 %) is larger than RS/(RS+RR) and all RTP senders get their proportion of the (RS+RR) sum (see section 2 of IETF RFC 3556 [6]). +The calculations of bandwidth limits are seemingly not in accordance with the definition of IETF RFC 3556 section 2 that says "RS" indicates the RTCP bandwidth allocated to active data senders and "RR" indicates the RTCP bandwidth allocated to other participants in the RTP session (all RTP streams that are sent and received in the RTP session), but 3GPP specifications commonly interpret SDP b= lines as receive bandwidth seen from the part sending the SDP, which is thus only half of the actual RTP session bandwidth in a bandwidth-symmetric point-to-point session. + +#### 6.2.3.4 RTCP Timeout Test + +- Purpose:** Test if an RTP stream received by the SUT that is stopped at the sender without any explicit RTCP BYE times out correctly in the SUT and is reflected as such in the subsequent receiver reporting from the SUT. +- Status:** Conditionally Mandatory (Precondition 1) +- Preconditions:** +- 1) The SUT is capable of using multiple simultaneous RTP streams in a single RTP session. + - 2) The SUT has passed tests 6.2.2.1, 6.2.2.3 and 6.2.2.5. + - 3) The data injection to the SUT is possible to control dynamically during an ongoing RTP session to turn sending of RTP packets on and off, without any indication in session signalling and while keeping the RTP session. +- Test procedure:** +- 1) Set the data injection to send RTP packets to the SUT. + - 2) Observe the SUT output until at least one RTCP packet is sent from the SUT. + - 3) Set the data injection to not send RTP packets to the SUT, not sending any RTCP BYE for the + +stopped RTP stream SSRC. +4) Observe the SUT output. + +Stop condition: Six (6) RTCP packets are sent from the SUT after step 3 in the test procedure. + +Pass criteria: The 6th RTCP packet sent from the SUT contains a Sender Report or Receiver Report that does *not* contain any report block for the stopped SSRC from data injection. + +Comments: An SSRC for which no packets have been received during (per default) 5 or more RTCP intervals will be timed out, as described by section 6.3.5 of IETF RFC 3550 [2]. The stopped SSRC may be omitted in RTCP reporting from the SUT (but not timed out) already for the first RTCP reporting interval where no RTP packets for that SSRC reaches the SUT, as described by section 6.4 of IETF RFC 3550. The current test procedure and pass criteria do not test if RTCP bandwidth allocated to the SSRC that was timed out is correctly re-allocated to the remaining SSRCs, which may be added in a subsequent version of the present document. + +#### 6.2.3.5 RTCP Step Join Backoff Receiver Test + +Purpose: Test if the time between first and second RTCP packet sent from the SUT is appropriate (using sufficiently low but not too low RTCP bandwidth) when the SUT is joining as RTP receiver (non-sender) in an RTP session that the SUT can discover to already contain many participants, as described by section 6.2 of IETF RFC 3550 [2] and section 2.4.2 of IETF RFC 3158 [3]. + +For Further Study. + +#### 6.2.3.6 RTCP Step Join Backoff Sender Test + +Purpose: Test if the time between first and second RTCP packet sent from the SUT is appropriate (using sufficiently low but not too low RTCP bandwidth) when the SUT is joining as RTP sender in an RTP session that the SUT can discover to already contain many participants, as described by section 6.2 of IETF RFC 3550 [2] and section 2.4.2 of IETF RFC 3158 [3]. + +For Further Study. + +### 6.2.4 Sender Report Sender Info Tests + +#### 6.2.4.1 Sender SSRC Test + +Purpose: Test if all SSRC values included in RTCP sender information sent from the SUT corresponds to the SSRC of an RTP stream sent from the SUT, and that there are corresponding RTCP sender information for all RTP streams (one or more) sent from the SUT. + +Status: Mandatory + +Preconditions: 1) The SUT has passed test 6.2.2.3. +2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. +3) The number of simultaneously used SSRC identifiers to be sent by the SUT in the RTP session is known a-priori (only one in the single-stream case). + +Test procedure: Observe the SUT output. + +Stop condition: 1) RTP packets are sent by the SUT. +2) At least three RTCP packets are sent per used SSRC identifier from the SUT (at least the first RTCP packet may be sent before first RTP packet for each SSRC). + +Pass criteria: 1) The "SSRC of sender" header field in all RTCP packets sent by the SUT contains a value that is identical to the "synchronization source (SSRC) identifier" header field in at least one of the RTP packets sent by the SUT. +2) The "synchronization source (SSRC) identifier" header field in all RTP packets sent by the SUT + +contains a value that is identical to the "SSRC of sender" header field in at least one of the RTCP packets sent by the SUT. + +Comments: The test result is agnostic to RTP packets being received by the SUT or not. + +#### 6.2.4.2 NTP Test + +Purpose: Test if the NTP timestamp field in successive RTCP packets sent from the SUT progresses with a consistent clock rate, and that the used NTP time format is correct (seconds in the high 32 bits). + +Status: Mandatory + +Preconditions: 1) The SUT has passed test 6.2.2.3. +2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. +3) The "NTP timestamp" field in the RTCP packet Sender Information from the SUT is monotonously increasing (value is not wrapping around, see also test 6.2.4.3). +4) The test network and test equipment contributes with an amount of time jitter that is insignificant to the test result. + +Test procedure: 1) Observe the SUT output. +2) Note the reception time ( $t_i$ ) and NTP timestamp field value ( $w_i$ ) of each RTCP packet sent from the SUT. +3) Count the number of RTCP packets, $n$ , sent from the SUT. +4) Using the first and last RTCP packets sent from the SUT, calculate the difference in reception time, $I = t_n - t_1$ , and difference in NTP time, $N = w_n - w_1$ . +5) Calculate the NTP timestamp clock rate estimate $C = N/I$ . + +Stop condition: 1) RTP packets are sent from the SUT. +2) At least 30 seconds have passed from the first RTCP packet was sent from the SUT. + +Pass criteria: $0.999 \leq C/2^{32} \leq 1.001$ . + +Comments: The test result is agnostic to RTP packets being received by the SUT or not. +NTP time calculations require 64-bit integer arithmetic capability. +The pass criterion corresponds to a minimum timestamp clock accuracy of 0.1 % but a much higher accuracy should in general be expected. The test setup can introduce packet delay jitter impacting measurement accuracy, which is mitigated by using a rather long test procedure and the above values are chosen as a trade-off. + +#### 6.2.4.3 Wrapped NTP Test + +Purpose: Test if the NTP timestamp field in successive RTCP packets sent from the SUT progresses with a consistent clock rate, even when the NTP timestamp field wraps around. + +Status: Conditionally Mandatory (Precondition 3) + +Preconditions: 1) The SUT has passed test 6.2.4.2. +2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. +3) The "NTP timestamp" field in the first RTCP packet Sender Information sent from the SUT is set to a value close to $2^{64}-1$ (when interpreted as an unsigned 64-bit integer), such that the value will wrap during the test. +4) The test network and test equipment contributes with an amount of time jitter that is insignificant to the test result. + +Test procedure: 1) Observe the SUT output. +2) Note the reception time ( $t_i$ ) and NTP timestamp field value ( $w_i$ ) of each RTCP packet sent from the SUT. +3) Count the number of RTCP packets, $n$ , sent from the SUT. +4) Using the first and last RTCP packets sent from the SUT, calculate the difference in reception time, $I = t_n - t_1$ . + +- 5) Using the first and last RTCP packets with $w_n < w_1$ when interpreting $w_n$ and $w_1$ as unsigned 64-bit values, calculate the difference in NTP time $N = 2^{64} - w_1 + w_n = (2^{64} + w_n - w_1) \bmod 2^{64}$ . +- 6) Calculate the NTP timestamp clock rate estimate $C = N/I$ . + +Stop condition: 1) RTP packets are sent from the SUT. + 2) At least 30 seconds have passed from the first RTCP packet was sent from the SUT. + 3) The "NTP timestamp" field in the last RTCP packet Sender Information sent from the SUT is less than the "NTP timestamp" field in the first RTCP packet Sender Information sent from the SUT, when interpreting those fields as unsigned 64-bit integers. + +Pass criteria: $0.999 \leq C/2^{32} \leq 1.001$ . + +Comments: The test result is agnostic to RTP packets being received by the SUT or not. + NTP time calculations require 64-bit integer arithmetic capability. + The pass criterion corresponds to a minimum timestamp clock accuracy of 0.1 % but a much higher accuracy should in general be expected. The test setup can introduce packet delay jitter impacting measurement accuracy, which is mitigated by using a rather long test procedure and the above values are chosen as a trade-off. + +#### 6.2.4.4 Time Stamp Test + +Purpose: Test if the RTP timestamp field in successive RTCP packets sent from the SUT progresses with a clock rate that, in relation to the NTP timestamp field, is reasonably close to the set rate for the RTP payload type related to this SSRC, e.g. from "a=rtpmap" line in SDP. + +Status: Mandatory + +Preconditions: 1) The SUT has passed tests 6.2.2.3, 6.2.4.1 and 6.2.4.2. + 2) The SUT is set to send RTP packets for a single RTP stream (one SSRC) during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. + 3) The "RTP timestamp" field in the RTCP packet Sender Information sent from the SUT is monotonously increasing (value is not wrapping around, see also test 6.2.4.5). + +Test procedure: 1) Observe the SUT output. + 2) Note the NTP timestamp field value ( $w_i$ ) and RTP timestamp field value ( $r_i$ ) of each RTCP packet sent from the SUT. + 3) Count the number of RTCP packets, $n$ , sent from the SUT. + 4) Using the first and last RTCP packet sent from the SUT, calculate the difference in NTP time, $N = w_n - w_1$ and difference in RTP timestamp, $T = r_n - r_1$ . + 5) Calculate the NTP timestamp difference in seconds $D = N/2^{32}$ . + 6) Calculate the RTP timestamp rate estimate $R = T/D$ . + 7) Retrieve RTP Time Stamp rate information, $S$ , e.g. from "" on the SDP "a=rtpmap: /" line, applicable for the RTP stream (SSRC) sent from the SUT that the RTCP packets sent from the SUT are associated with. + +Stop condition: 1) RTP packets are sent from the SUT. + 2) At least 30 seconds have passed from the first RTCP packet was sent from the SUT. + +Pass criteria: $0.999 \leq R/S \leq 1.001$ . + +Comments: The test result is agnostic to RTP packets being received by the SUT or not. + NTP time calculations require 64-bit integer arithmetic capability. + The pass criteria correspond to a minimum timestamp clock accuracy of 0.1 % in relation to NTP time but a much higher accuracy should in general be expected. + +#### 6.2.4.5 Wrapped Time Stamp Test + +Purpose: Test if the RTP timestamp field in successive RTCP packets sent from the SUT progresses with a clock rate that, in relation to the NTP timestamp field, is reasonably close to the set rate, e.g. from "a=rtpmap" line in SDP, even when the RTP timestamp field wraps around. + +- Status: Conditionally Mandatory (Precondition 3) +- Preconditions: + - 1) The SUT has passed test 6.2.4.4. + - 2) The SUT is set to send RTP packets for a single RTP stream (one SSRC) during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. + - 3) The "RTP timestamp" field in the first RTCP packet Sender Information sent from the SUT is set to a value close to $2^{32}-1$ (when interpreted as an unsigned 32-bit integer), such that the value will wrap during the test. +- Test procedure: + - 1) Observe the SUT output. + - 2) Note the NTP timestamp field value ( $w_i$ ) and RTP timestamp field value ( $r_i$ ) of each RTCP packet sent from the SUT. + - 3) Count the number of RTCP packets, $n$ , sent from the SUT. + - 4) Using the first and last RTCP packets sent from the SUT, calculate the difference in NTP time, $N = w_n - w_1$ . + - 5) Calculate the NTP timestamp difference in seconds $D = N/2^{32}$ . + - 6) Using the first and last RTCP packets with $r_n < r_1$ when interpreting $r_n$ and $r_1$ as unsigned 32-bit values, calculate $T = 2^{32} - r_1 + r_n = (2^{32} + r_n - r_1) \bmod 2^{32}$ . + - 7) Calculate the RTP timestamp rate estimate $R = T/D$ . + - 8) Retrieve the intended RTP Time Stamp rate information, $S$ , e.g. from "" on the SDP "a=rtpmap: /" line, applicable for the RTP stream (SSRC) sent from the SUT that the RTCP packets sent from the SUT are associated with. +- Stop condition: + - 1) RTP packets are sent from the SUT. + - 2) At least 30 seconds have passed from the first RTCP packet was sent from the SUT. + - 3) The "RTP timestamp" field in the last RTCP packet Sender Information sent from the SUT is less than the "RTP timestamp" field in the first RTCP packet Sender Information sent from the SUT, when interpreting those fields as unsigned 32-bit integers. +- Pass criteria: $0.999 \leq R/S \leq 1.001$ . +- Comments: The test result is agnostic to RTP packets being received by the SUT or not. +NTP time calculations require 64-bit integer arithmetic capability. +The pass criteria correspond to a minimum timestamp clock accuracy of 0.1 % in relation to NTP time but a much higher accuracy should in general be expected. + +#### 6.2.4.6 Packet Count Test + +- Purpose: Test if the reported packet count in RTCP sent from the SUT corresponds with RTP packets sent from the SUT. +- Status: Mandatory +- Preconditions: + - 1) The SUT has passed test 6.2.2.3. + - 2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. +- Test procedure: + - 1) Observe the SUT output. + - 2) Note the "sender's packet count" field ( $p_i$ ) of each RTCP packet sent from the SUT. + - 3) Count the number of RTCP packets ( $n$ ) sent from the SUT. + - 4) Count and note the number of RTP packets ( $P_i$ ) sent from the SUT between each pair $\{i - 1, i\}$ of subsequent RTCP packets sent from the SUT. + - 5) For each pair of subsequent RTCP packets, calculate the difference in packet count, $d_i = p_i - p_{i-1}, i \in [2..n]$ . +- Stop condition: + - 1) RTP packets are sent from the SUT. + - 2) At least three RTCP packets are sent from the SUT after the first RTP packet sent from the SUT (one or more RTCP packets may be sent before first RTP packet). +- Pass criteria: $d_i = P_i$ , for all $i \in [2..n]$ . +- Comments: The test result is agnostic to RTP packets being received by the SUT or not. + +#### 6.2.4.7 Wrapped Packet Count Test + +Purpose: Test if the reported packet count in RTCP sent from the SUT corresponds with RTP packets sent from the SUT, even when the "sender's packet count" field wraps around. + +Status: Conditionally Mandatory (Precondition 3) + +Preconditions: + + +- 1) The SUT has passed test 6.2.4.6. +- 2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. +- 3) The "sender's packet count" field in the first RTCP packet Sender Information sent from the SUT is set to a value close to $2^{32}-1$ (when interpreted as an unsigned 32-bit integer), such that the value will wrap during the test. + +Test procedure: + + +- 1) Observe the SUT output. +- 2) Note the "sender's packet count" field ( $p_i$ ) of each RTCP packet sent from the SUT. +- 3) Count the number of RTCP packets ( $n$ ) sent from the SUT. +- 4) Count and note the number of RTP packets ( $P_i$ ) sent from the SUT between each pair $\{i-1, i\}$ of subsequent RTCP packets sent from the SUT. +- 5) For each pair of subsequent RTCP packets where $p_i \geq p_{i-1}$ when interpreting $p_i$ and $p_{i-1}$ as unsigned 32-bit values, calculate the difference in packet count, $d_i = p_i - p_{i-1}$ , $i \in [2..n]$ . +- 6) For each pair of subsequent RTCP packets where $p_i < p_{i-1}$ when interpreting $p_i$ and $p_{i-1}$ as unsigned 32-bit values, calculate $d_i = 2^{32} - p_{i-1} + p_i = (2^{32} + p_i - p_{i-1}) \bmod 2^{32}$ , $i \in [2..n]$ . + +Stop condition: + + +- 1) RTP packets are sent from the SUT. +- 2) At least three RTCP packets are sent from the SUT after the first RTP packet (one or more RTCP packets may be sent before first RTP packet). +- 3) The "sender's packet count" field in the last RTCP packet Sender Information sent from the SUT is less than the "sender's packet count" field in the first RTCP packet Sender Information, when interpreting those fields as unsigned 32-bit integers. + +Pass criteria: $d_i = P_i$ , for all $i \in [2..n]$ . + +Comments: The test result is agnostic to RTP packets being received by the SUT or not. + +#### 6.2.4.8 Octet Count Test + +Purpose: Test if the reported octet count in RTCP sent from the SUT corresponds with RTP packets sent from the SUT. + +Status: Mandatory + +Preconditions: + + +- 1) The SUT has passed test 6.2.2.3. +- 2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. + +Test procedure: + + +- 1) Observe the SUT output. +- 2) Note the "sender's octet count" field ( $c_i$ ) of each RTCP packet sent from the SUT. +- 3) Count the number of RTCP packets ( $n$ ) sent from the SUT. +- 4) Count and note the number of RTP packets ( $P_i$ ) sent from the SUT between each pair $\{i-1, i\}$ of subsequent RTCP packets sent from the SUT. +- 5) Note the RTP payload size ( $s_{N_i}$ ), with $N_i \in [1..P_i]$ , excluding RTP, lower layer headers, and any RTP padding of each RTP packet sent from the SUT between each pair of subsequent RTCP packets sent from the SUT. +- 6) For each pair of subsequent RTCP packets, calculate the difference in octet count, $b_i = c_i - c_{i-1}$ , and sum of RTP payload sizes $S_i = \sum_{N_i=1}^{P_i} s_{N_i}$ with $i \in [2..n]$ . + +Stop condition: + + +- 1) RTP packets are sent from the SUT. +- 2) At least three RTCP packets are sent from the SUT after the first RTP packet sent from the SUT (one or more RTCP packets may be sent before first RTP packet). + +Pass criteria: $b_i = S_i$ , for all $i \in [2..n]$ . + +Comments: The test result is agnostic to RTP packets being received by the SUT or not. + +#### 6.2.4.9 Wrapped Octet Count Test + +Purpose: Test if the reported octet count in RTCP sent from the SUT corresponds with RTP packets sent from the SUT, even when the "sender's octet count" field wraps around. + +Status: Conditionally Mandatory (Precondition 3) + +Preconditions: 1) The SUT has passed test 6.2.4.8. +2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. +3) The "sender's octet count" field in the first RTCP packet Sender Information sent from the SUT is set to a value close to $2^{32}-1$ (when interpreted as an unsigned 32-bit integer), such that the value will wrap during the test. + +Test procedure: 1) Observe the SUT output. +2) Note the "sender's octet count" field ( $c_i$ ) of each RTCP packet sent from the SUT. +3) Count the number of RTCP packets ( $n$ ) sent from the SUT. +4) Count and note the number of RTP packets ( $P_i$ ) sent from the SUT between each pair $\{i-1, i\}$ of subsequent RTCP packets sent from the SUT, +5) Note the RTP payload size ( $s_{N_i}$ ), with $N_i \in [1..P_i]$ , excluding RTP, lower layer headers, and any RTP padding of each RTP packet sent from the SUT between each pair of subsequent RTCP packets sent from the SUT. +6) For each pair of subsequent RTCP packets, calculate the sum of RTP payload sizes $S_i = \sum_{N_i=1}^{P_i} s_{N_i}$ with $i \in [2..n]$ . +7) For each pair of subsequent RTCP packets where $c_i \geq c_{i-1}$ when interpreting $c_i$ and $c_{i-1}$ as unsigned 32-bit values, calculate the difference in octet count, $b_i = c_i - c_{i-1}$ , $i \in [2..n]$ . +8) For each pair of subsequent RTCP packets where $c_i < c_{i-1}$ when interpreting $c_i$ and $c_{i-1}$ as unsigned 32-bit values, calculate $b_i = 2^{32} - c_{i-1} + c_i = (2^{32} + c_i - c_{i-1}) \bmod 2^{32}$ , $i \in [2..n]$ . + +Stop condition: 1) RTP packets are sent from the SUT. +2) At least three RTCP packets are sent from the SUT after the first RTP packet sent from the SUT (one or more RTCP packets may be sent before first RTP packet). +3) The "sender's octet count" field in the last RTCP packet Sender Information sent from the SUT is less than the "sender's octet count" field in the first RTCP packet Sender Information, when interpreting those fields as unsigned 32-bit integers + +Pass criteria: $b_i = S_i$ , for all $i \in [2..n]$ . + +Comments: The test result is agnostic to RTP packets being received by the SUT or not. + +#### 6.2.4.10 Synchronization Information Test + +Purpose: Test if the RTCP sender information sent from the SUT and corresponding RTP for two or more streams that are sent simultaneously from the SUT and that are intended to be synchronized, are consistent enough to allow RTP receiver-side synchronization. + +Status: Mandatory + +Preconditions: 1) The SUT has passed tests 6.2.4.2, 6.2.4.4, and 6.2.5.2. +2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. + +Test procedure: 1) Observe SUT output. +2) Note the "SSRC of sender" field ( $s_i$ ), NTP timestamp field ( $w_i$ ), RTP timestamp field ( $r_i$ ), and CNAME SDES item field ( $c_i$ ) values of each RTCP packet sent from the SUT. +3) Count the number of RTCP packets ( $n$ ) sent from the SUT. +4) Note the reception time ( $t_j$ ), "SSRC identifier" field ( $S_j$ ), and RTP timestamp field ( $T_j$ ) values of each RTP packet sent from the SUT. +5) Count the number of RTP packets ( $N$ ) sent from the SUT. +6) For each SSRC value to be tested (indexed with $k$ ), retrieve RTP Time Stamp rate information + +( $R_k$ ), e.g. from "" on the SDP "a=rtpmap: /" line, applicable for the SSRC sent from the SUT that the RTCP packets sent from the SUT are associated with ( $s_i = S_j$ ). + +7) For at least one RTCP and RTP packet pair for each SSRC value to be tested (indexed with $k$ ), calculate the nominal playout time $C_k = w_k/2^{32} + (T_k - r_k)/R_k$ , where $w_k, r_k, s_k$ , and $c_k$ belong to a single RTCP packet, and $T_k$ is taken from a corresponding RTP packet with $S_k = s_k$ . + +Stop condition: 1) At least one RTP packet from all RTP streams (different SSRC identifiers, $S_j$ ) to be synchronized are sent from the SUT. + +2) At least one RTCP packet are sent from the SUT per used SSRC identifier, i.e. there exist both $s_i$ and $S_j$ with all SSRC values that are to be included in the test (the first RTCP packet may be sent before first RTP packet for each SSRC). + +Pass criteria: The following is fulfilled for each SSRC value ( $s_k$ ) to be tested, used by RTCP and RTP packets sent from the SUT: + +1) The CNAME SDES item field values ( $c_k$ ) are identical (if not, they are not intended to be synchronized). + +2) The nominal playout times ( $C_k$ ) of an RTP packet using the tested SSRC value ( $s_k$ ) and an RTP packet using a different tested SSRC value ( $s_{k+1}$ ) that are received no more than 500 ms apart ( $|(t_{k+1} - t_k)| \leq 0.5$ ), are no more than 300 ms apart when adjusted for the difference in reception time; $|(C_{k+1} - C_k) - (t_{k+1} - t_k)| \leq 0.3$ . + +Comments: This test only verifies that RTP streams sent from the SUT that are meant to be synchronized, are reasonably possible to synchronize based on RTP and RTCP information and RTP packet jitter for those RTP streams. It cannot and does not test how closely they will be synchronized on playout in the receiver since the details of RTP stream synchronization depends on the receiver implementation. The test result is agnostic to RTP packets being received by the SUT or not. + +### 6.2.5 Source Description (SDES) Tests + +#### 6.2.5.1 Basic SDES Test + +Purpose: Test if RTCP SDES packets sent from the SUT fulfils a few basic criteria for content and length consistency. + +Status: Mandatory + +Preconditions: 1) The SUT has passed test 6.2.2.6. +2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. + +Test procedure: Observe the SUT output. + +Stop condition: 1) RTP packets are sent from the SUT. +2) At least three RTCP packets are sent from the SUT per used SSRC identifier (at least the first RTCP packet may be sent before first RTP packet for each SSRC). + +Pass criteria: The following is fulfilled for all RTCP SDES packets sent from the SUT: +1) The source count (SC) header field matches the number of SDES item chunks included in the respective RTCP SDES packet. +2) Each SDES item chunk ends with at least one octet containing a zero value. +3) Each SDES item in a chunk has a length field that corresponds to the text content length in octets of that SDES item, corresponding to the distance in octets starting from the octet after that length field until the start of the next SDES item or until the terminating zero value octet (see above). +4) Each SDES item in a chunk with non-zero content length has a text content where the last octet value is not zero (is not a zero-terminated string). + +Comments: The test result is agnostic to RTP packets being received by the SUT or not. + +#### 6.2.5.2 Canonical End-point Identifier (CNAME) Test + +| | | +|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Purpose: | Test if CNAME content is identical for every RTCP packet sent from the SUT belonging to the same RTP stream. | +| Status: | Mandatory | +| Preconditions: |
  1. 1) The SUT has passed test 6.2.5.1.
  2. 2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling.
| +| Test procedure: |
  1. 1) Observe the SUT output.
  2. 2) Note the "SSRC of sender" field (s_i) and CNAME SDES item field (c_i) values of each RTCP packet sent from the SUT.
  3. 3) Count the number of RTCP packets (n) sent from the SUT.
| +| Stop condition: |
  1. 1) RTP packets are sent from the SUT.
  2. 2) At least three RTCP packets are sent from the SUT per used SSRC identifier after sending the first RTP packet from the SUT for that SSRC identifier (one or more RTCP packets may be sent before first RTP packet for each SSRC).
| +| Pass criteria: | $c_i = c_j$ , for all $i \in [1..n]$ and $j \in [1..n]$ where $s_i = s_j$ . | +| Comments: | The test result is agnostic to RTP packets being received by the SUT or not. | + +### 6.2.6 Receiver Report Block Tests + +#### 6.2.6.1 SSRC Consistency Test + +| | | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Purpose: | Test if the SSRC value included in a RTCP report block sent from the SUT corresponds to the SSRC of an RTP stream received by the SUT. | +| Status: | Mandatory | +| Preconditions: |
  1. 1) The SUT has passed tests 6.2.2.6, and 6.2.2.7.
  2. 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling.
  3. 3) Data injection is set to send RTP.
| +| Test procedure: | Observe the SUT and data injection output. | +| Stop condition: | An RTCP packet is sent from the SUT, containing at least a receiver report block. | +| Pass criteria: | The SSRC value in the RTCP report block sent from the SUT can be found as RTP header SSRC field value in at least one of the RTP packets sent from data injection. | +| Comments: |

The test result is agnostic to RTP packets being sent by the SUT or not.

A report block sent by the SUT containing an SSRC value identical to the SSRC value in the RTP header of RTP packets received by the SUT is henceforth denoted as the SUT "reporting on" the RTP stream those RTP packets belong to.

| + +#### 6.2.6.2 SSRC Completeness Test + +| | | +|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Purpose: | Test if all RTP streams (all SSRC) sent by data injection and received by the SUT in the RTP session are reported on by the SUT, while allowing that not all RTP streams are reported in every RTCP packet (e.g. due to RTCP packet MTU restrictions). | +| Status: | Conditionally Mandatory (Precondition 1) | +| Preconditions: |
  1. 1) The SUT is capable of using multiple simultaneous RTP streams in a single RTP session.
  2. 2) The SUT has passed test 6.2.6.1.
  3. 3) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling.
| + +- 4) Data injection is set to send RTP. +- 5) The number of simultaneously used, unique, SSRC values sent by the data injection in the RTP session ( $m$ ) is known a-priori (only one in the single-stream case). + +Test procedure: + +- 1) Observe SUT and data injection output. +- 2) Note which SSRC values ( $S_i$ ) that are included in RTCP report blocks sent from the SUT. +- 3) Count the number of RTCP packets ( $n$ ) sent from the SUT. +- 4) Note which SSRC values ( $R_j$ ) that are included in RTP headers of RTP packets sent from data injection. +- 5) Calculate the number of unique SSRC values ( $k$ ) in report blocks sent from the SUT. + +Stop condition: + +- 1) At least one RTP packet with SSRC value $R_j$ is sent from data injection for all $j \in [1..m]$ . +- 2) $k = m$ . + +Pass criteria: $\{S_i\} = \{R_j\}$ for all $i \in [1..n]$ and $j \in [1..m]$ . + +Comments: The test result is agnostic to RTP packets being sent by the SUT or not. + +#### 6.2.6.3 SSRC Change Test + +Purpose: Test if an RTP stream received by the SUT that changes SSRC is correctly reported on by the SUT, keeping reporting separate per used SSRC value. + +Status: Mandatory + +Preconditions: + +- 1) The SUT has passed tests 6.2.6.4 and 6.2.6.6. +- 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. +- 3) Data injection is set to send a single RTP stream (one SSRC, $S_i$ ) with monotonically increasing RTP sequence number (SN), and with the first RTP packet sent containing a non-zero RTP sequence number (SN), with a packet loss status that can be changed during the test session according to the test procedure without change in session signalling towards the SUT. + +Test procedure: + +- 1) Observe SUT and data injection output. +- 2) Send RTP packets for SSRC $S_i$ from data injection to the SUT with a low but nonzero amount of RTP packet loss. The exact amount of RTP packet loss and loss pattern is not important and may be chosen freely by the test equipment. +- 3) Continue sending RTP packets for SSRC $S_i$ from data injection to the SUT, without any RTP packet loss. +- 4) Note the fraction lost ( $f_i$ ) and cumulative number of packets lost ( $c_i$ ) for an RTCP report block sent from the SUT, reporting on the RTP stream with SSRC $S_i$ sent from data injection. There may be multiple such RTCP reports sent from the SUT and the test may choose any of those. +- 5) Change the used SSRC to $S_{i+1} \neq S_i$ for RTP packets sent from data injection to the SUT (and stop sending any RTP packets with SSRC $S_i$ ), with other RTP header fields across the transition kept as if SSRC was not changed (keeping payload type, sequence number incremented by one, timestamp incremented similar to before, etc), still without any RTP packet loss. +- 6) Note the fraction lost ( $f_{i+1}$ ) and cumulative number of packets lost ( $c_{i+1}$ ) for an RTCP report block sent from the SUT, reporting on the RTP stream with SSRC $S_{i+1}$ sent from data injection. There may be multiple such RTCP reports sent from the SUT and the test shall choose the first one sent after the RTP SSRC change. + +Stop condition: An RTCP packet is sent from the SUT, containing at least a receiver report block reporting on the RTP stream with SSRC $S_{i+1}$ from data injection. + +Pass criteria: + +- 1) $c_i \neq 0$ and $f_i \neq 0$ . +- 2) $c_{i+1} = 0$ and $f_{i+1} = 0$ . + +Comments: The interarrival jitter field of the RTCP receiver report is, like cumulative number of packets lost and fraction lost fields in this test, also not kept across SSRC changes but restart from zero jitter. It is however deliberately not included as part of this test because it is hard to require the test equipment to achieve entirely predictable jitter or not introduce any jitter at all, to be able to construct a repeatable + +jitter pass criteria. + +The test result is agnostic to RTP packets being sent by the SUT or not. + +#### 6.2.6.4 Initial Zero Loss Test + +Purpose: Test if loss-free reception of RTP packets by the SUT at RTP session start is correctly reported by the SUT as no loss in RTCP, even if the initial RTP sequence number is non-zero. + +Status: Mandatory + +Preconditions: 1) The SUT has passed test 6.2.6.1. +2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. +3) Data injection is set to send a single RTP stream (one SSRC) without loss, with monotonically increasing RTP sequence number (SN), and with the first RTP packet sent containing a non-zero RTP sequence number (SN). + +Test procedure: Observe the SUT and data injection output. + +Stop condition: 1) RTP packets are sent from data injection. +2) An RTCP packet is sent from the SUT, containing at least a receiver report block reporting on the RTP stream from data injection. + +Pass criteria: The report block in the RTCP packet sent from the SUT reporting on the RTP stream from data injection fulfils: +1) The fraction lost report block field is zero. +2) The cumulative number of packets lost report block field is zero. + +Comments: The test result is agnostic to RTP packets being sent by the SUT or not. + +#### 6.2.6.5 Zero Loss Test + +Purpose: Test if loss-free reception of RTP packets by the SUT during a reporting period is correctly reflected in the RTCP report sent by the SUT. + +Status: Mandatory + +Preconditions: 1) The SUT has passed test 6.2.6.4. +2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. +3) Data injection is set to send a single RTP stream (one SSRC) without loss and with monotonically increasing RTP sequence number (SN). + +Test procedure: Observe the SUT and data injection output. + +Stop condition: 1) RTP packets are sent from data injection. +2) Two RTCP packets are sent from the SUT, each containing at least a receiver report block reporting on the RTP stream from data injection. + +Pass criteria: The report block in the RTCP packets sent from the SUT, reporting on the RTP stream from data injection fulfils: +1) The fraction lost report block field is zero in the second RTCP packet sent from the SUT during the test. +2) The cumulative number of packets lost report block field value is identical in the first and second RTCP packet sent from the SUT during the test. + +Comments: The test result is agnostic to RTP packets being sent by the SUT or not. + +#### 6.2.6.6 Loss Test + +Purpose: Test if the "fraction lost" and "cumulative number of packets lost" fields in the receiver report sent from the SUT are consistent with one another and with the "extended last sequence number received" field in the same receiver report. + +- Status: Mandatory +- Preconditions: + - 1) The SUT has passed tests 6.2.6.5 and 6.2.6.11. + - 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. + - 3) Data injection is set to send a single RTP stream (one SSRC) with loss according to test procedure (below) and with monotonically increasing RTP sequence number (SN). +- Test procedure: + - 1) Observe the SUT and data injection output. + - 2) Note the extended last sequence number received ( $s_i$ ), fraction lost ( $f_i$ ) and cumulative number of packets lost ( $c_i$ ) for each RTCP report block sent from the SUT reporting on the RTP stream sent from data injection. + - 3) The below steps of this test procedure are designed to be run multiple times, using a few different loss patterns described in steps 5a)-5e). Each repetition of the below steps may be run in immediate succession (successive RTCP reporting periods) or may be separated by loss-free RTCP periods. In either case, it is the responsibility of the test setup to ensure that the RTP packets dropped by data injection are reported on in the next RTCP report sent from the SUT, e.g. by letting data injection drop RTP packets just after an RTCP packet is sent from the SUT. + - 4) An RTCP packet, $i - 1$ , is sent from the SUT, reporting on the RTP stream from data injection. The value of $i$ and its relation to how many RTCP packets that are actually sent by the SUT is only significant in context of describing the test procedure and $i$ will be different across the repetitions related to steps 5a)-5e). + - 5) Drop RTP packets from data injection to the SUT according to the below sub-bullets, one sub-bullet per repetition, $k$ , of steps 4-10, where $n_k$ is the number of dropped RTP packets in the RTCP reporting period for that repetition: + - a) A single RTP packet; $k = 1, n_1 = 1$ . + - b) Two RTP packets in succession; $k = 2, n_2 = 2$ . + - c) Two RTP packets with three RTP packets in between; $k = 3, n_3 = 2$ . + - d) Every 20th RTP packet; $k = 4, n_4 = N_k/20$ . + - e) Every 10th RTP packet; $k = 5, n_5 = N_k/10$ . + - 6) An RTCP packet, $i$ , is sent from the SUT, reporting on the RTP stream from data injection. + - 7) Calculate number of packets sent (disregarding packet drops) $N_k = s_i - s_{i-1}$ . + - 8) Calculate fraction lost $F_k = \left\lceil 256 \frac{n_k}{N_k} \right\rceil$ , with $n_k$ set according to 5a) – 5e) above. + - 9) Calculate packets lost $L_k = c_i - c_{i-1}$ . + - 10) Repeat from step 4. +- Stop condition: Step 9 is fulfilled for $k = 5$ , repetition 5e). +- Pass criteria: + - 1) $f_i = F_k$ , for all $k \in [1..5]$ . + - 2) $L_k = [n_k]$ , for all $k \in [1..5]$ . +- Comments: The test result is agnostic to RTP packets being sent by the SUT or not. It is assumed that the information in extended last sequence number received is correct (see test 6.2.6.11) and enough to correlate with actual, observed RTP packet loss. + +#### 6.2.6.7 Wrapped Loss Test + +- Purpose: Test if the "fraction lost" and "cumulative number of packets lost" fields in the receiver report sent from the SUT are consistent with one another and with the "extended last sequence number received" field in the same receiver report, even when the RTP "sequence number" field in RTP packets sent from data injection wraps around. +- Status: Conditionally Mandatory (Precondition 4) +- Preconditions: + - 1) The SUT has passed tests 6.2.6.6 and 6.2.6.12. + - 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. + - 3) Data injection is set to send a single RTP stream (one SSRC) with loss according to test procedure (below). + - 4) The "sequence number" (SN) field in the first RTP packet sent from data injection is set to a value + +close to $2^{16}-1$ (when interpreted as an unsigned 16-bit integer) in step 5 of the test procedure, such that the value will wrap during each repetition of the test. + +- Test procedure: +- 1) Observe the SUT and data injection output. + - 2) Note the extended last sequence number received ( $s_i$ ), fraction lost ( $f_i$ ) and cumulative number of packets lost ( $c_i$ ) for each RTCP report block sent from the SUT reporting on the RTP stream sent from data injection. + - 3) The below steps of this test procedure are designed to be run multiple times, using a few different loss patterns described in steps 5a)-5e). Each repetition of the below steps may be run in immediate succession (successive RTCP reporting periods) or may be separated by loss-free RTCP periods. In either case, it is the responsibility of the test setup to ensure that the RTP packets dropped by data injection are reported on in the next RTCP report sent from the SUT, e.g. by letting data injection drop RTP packets just after an RTCP packet is sent from the SUT. + - 4) An RTCP packet, $i - 1$ , is sent from the SUT, reporting on the RTP stream from data injection. The value of $i$ and its relation to how many RTCP packets that are actually sent by the SUT is only significant in context of describing the test procedure and $i$ will be different across the repetitions related to steps 5a)-5e). + - 5) Drop RTP packets from data injection to the SUT according to the below sub-bullets, one sub-bullet per repetition, $k$ , of steps 4-10, where $n_k$ is the number of dropped RTP packets in the RTCP reporting period for that repetition: + - a) A single RTP packet; $k = 1, n_1 = 1$ . + - b) Two RTP packets in succession; $k = 2, n_2 = 2$ . + - c) Two RTP packets with three RTP packets in between; $k = 3, n_3 = 2$ . + - d) Every 20th RTP packet; $k = 4, n_4 = \frac{N_k}{20}$ . + - e) Every 10th RTP packet; $k = 5, n_5 = \frac{N_k}{10}$ . + - 6) An RTCP packet, $i$ , is sent from the SUT, reporting on the RTP stream from data injection. + - 7) Calculate number of packets sent (disregarding packet drops) $N_k = s_i - s_{i-1}$ . + - 8) Calculate fraction lost $F_k = \left\lceil 256 \frac{n_k}{N_k} \right\rceil$ , with $n_k$ set according to 5a) – 5e) above. + - 9) Calculate packets lost $L_k = c_i - c_{i-1}$ . + - 10) Repeat from step 4. + +Stop condition: Step 9 is fulfilled for $k = 5$ , repetition 5e). + +- Pass criteria: +- 1) $f_i = F_k$ , for all $k \in [1..5]$ . + - 2) $L_k = [n_k]$ , for all $k \in [1..5]$ . + +Comments: The test result is agnostic to RTP packets being sent by the SUT or not. It is assumed that the information in extended last sequence number received is correct (see test 6.2.6.12) and enough to correlate with actual, observed RTP packet loss. + +#### 6.2.6.8 Duplicate Loss Test + +Purpose: Test if the "fraction lost" and "cumulative number of packets lost" fields in the receiver report sent from the SUT are consistent with one another and with the "extended last sequence number received" field in the same receiver report, even when receiving duplicate RTP packets (with duplicate values in "sequence number" field) sent from data injection. + +Status: Conditionally Mandatory (Precondition 4) + +- Preconditions: +- 1) The SUT has passed test 6.2.6.6. + - 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. + - 3) Data injection is set to send a single RTP stream (one SSRC) with loss according to test procedure (below). + - 4) Data injection is set to send some RTP packets multiple times according to test procedure (below). + +- Test procedure: +- 1) Observe the SUT and data injection output. + - 2) Note the extended last sequence number received ( $s_i$ ), fraction lost ( $f_i$ ) and cumulative number of packets lost ( $c_i$ ) for each RTCP report block sent from the SUT reporting on the RTP stream sent from data injection. + +- 3) The below steps of this test procedure are designed to be run multiple times, using a few different loss and duplication patterns described in steps 5a)-5e). Each repetition of the below steps may be run in immediate succession (successive RTCP reporting periods) or may be separated by loss-free RTCP periods. In either case, it is the responsibility of the test setup to ensure that the RTP packets dropped or duplicated by data injection are reported on in the next RTCP report sent from the SUT, e.g. by letting data injection drop and duplicate RTP packets just after an RTCP packet is sent from the SUT. +- 4) An RTCP packet, $i - 1$ , is sent from the SUT, reporting on the RTP stream from data injection. The value of $i$ and its relation to how many RTCP packets that are actually sent by the SUT is only significant in context of describing the test procedure and $i$ will be different across the repetitions related to steps 5a)-5e). +- 5) Drop and duplicate RTP packets from data injection to the SUT according to the below sub-bullets, one sub-bullet per repetition, $k$ , of step 4-10, where $n_k$ is the number of dropped RTP packets and $r_k$ is the number of duplicated RTP packets in the RTCP reporting period for that repetition: +- Drop a single RTP packet, duplicate a single non-dropped RTP packet; + $k = 1, n_1 = 1, r_1 = 1$ . + - Drop two RTP packets in succession, duplicate a single non-dropped RTP packet; + $k = 2, n_2 = 2, r_2 = 1$ . + - Drop two RTP packets with three RTP packets in between, duplicate three non-dropped RTP packets; + $k = 3, n_3 = 2, r_3 = 3$ . + - Drop every 20th RTP packet, duplicate every 20th non-dropped RTP packet; + $k = 4, n_4 = N_k/20, r_4 = 19N_k/400$ . + - Drop every 10th RTP packet, duplicate every 20th non-dropped RTP packet; + $k = 5, n_5 = N_k/10, r_5 = 9N_k/200$ . +- 6) An RTCP packet, $i$ , is sent from the SUT, reporting on the RTP stream from data injection. +- 7) Calculate number of packets sent (disregarding packet drops and duplications) $N_k = s_i - s_{i-1}$ . +- 8) Calculate fraction lost $F_k = \left\lceil 256 \frac{(n_k - r_k)}{N_k} \right\rceil$ , with $n_k$ and $r_k$ set according to 5a) – 5e) above. +- 9) Calculate packets lost $L_k = c_i - c_{i-1}$ . +- 10) Repeat from step 4. + +Stop condition: Step 9 is fulfilled for $k = 5$ , repetition 5e). + +Pass criteria: 1) $f_i = F_k$ , for all $k \in [1..5]$ . +2) $L_k = [n_k - r_k]$ , for all $k \in [1..5]$ . + +Comments: The test result is agnostic to RTP packets being sent by the SUT or not. +It is assumed that the information in extended last sequence number received is correct (see test 6.2.6.11) and enough to correlate with actual, observed RTP packet loss. + +#### 6.2.6.9 Out-of-sequence Loss Test + +Purpose: Test if the "fraction lost" and "cumulative number of packets lost" fields in the receiver report sent from the SUT are consistent with one another and with the "extended last sequence number received" field in the same receiver report, even when the SUT is receiving RTP packets with the "sequence number" field not monotonically incrementing. + +Status: Conditionally Mandatory (Precondition 3) + +Preconditions: 1) The SUT has passed test 6.2.6.6. +2) The SUT set to receive RTP packets during the test session, e.g. is pre-configured or set as send-receive or receive-only through test instrument signalling. +3) Data injection is set to send a single RTP stream (one SSRC) with loss according to test procedure (below) and where the "sequence number" field in the RTP packet header is not generated with a constant increment of 1 ( $n, n+1, n+2, \dots$ ) but with alternating increments of -1 and 3 ( $n+1, n, n+3, n+2, \dots$ ). + +Test procedure: 1) Observe the SUT and data injection output. +2) Note the extended last sequence number received ( $s_i$ ), fraction lost ( $f_i$ ) and cumulative number of packets lost ( $c_i$ ) for each RTCP report block sent from the SUT reporting on the RTP stream sent from + +data injection. + +3) The below steps of this test procedure are designed to be run multiple times, using a few different loss patterns described in steps 5a)-5e). Each repetition of the below steps may be run in immediate succession (successive RTCP reporting periods) or may be separated by loss-free RTCP periods. In either case, it is the responsibility of the test setup to ensure that the RTP packets dropped by data injection are reported on in the next RTCP report sent from the SUT, e.g. by letting data injection drop RTP packets just after an RTCP packet is sent from the SUT. + +4) An RTCP packet, $i - 1$ , is sent from the SUT, reporting on the RTP stream from data injection. The value of $i$ and its relation to how many RTCP packets that are actually sent by the SUT is only significant in context of describing the test procedure and $i$ will be different across the repetitions related to steps 5a)-5e). + +5) Drop RTP packets from data injection to the SUT according to the below sub-bullets, one sub-bullet per repetition, $k$ , of steps 4-10, where $n_k$ is the number of dropped RTP packets in the RTCP reporting period for that repetition: + +a) A single RTP packet; + +$$k = 1, n_1 = 1.$$ + +b) Drop two RTP packets in succession; + +$$k = 2, n_2 = 2.$$ + +c) Drop two RTP packets with three RTP packets in between; + +$$k = 3, n_3 = 2.$$ + +d) Drop every 20th RTP packet; + +$$k = 4, n_4 = \frac{N_k}{20}.$$ + +e) Drop every 10th RTP packet; + +$$k = 5, n_5 = \frac{N_k}{10}.$$ + +6) An RTCP packet, $i$ , is sent from the SUT, reporting on the RTP stream from data injection. + +7) Calculate number of packets sent (disregarding packet drops) $N_k = s_i - s_{i-1}$ . + +8) Calculate fraction lost $F_k = \left\lceil 256 \frac{n_k}{N_k} \right\rceil$ , with $n_k$ set according to 5a) – 5e) above. + +9) Calculate packets lost $L_k = c_i - c_{i-1}$ . + +10) Repeat from step 4. + +Stop condition: Step 9 is fulfilled for $k = 5$ , repetition 5e). + +Pass criteria: 1) $f_i = F_k$ , for all $k \in [1..5]$ . +2) $L_k = \lfloor n_k \rfloor$ , for all $k \in [1..5]$ . + +Comments: The test result is agnostic to RTP packets being sent by the SUT or not. It is assumed that the information in extended last sequence number received is correct (see test 6.2.6.11) and enough to correlate with actual, observed RTP packet loss. + +#### 6.2.6.10 All Loss Test + +Purpose: Test if no RTP packets being received by the SUT during one or more reporting periods is correctly reflected in the RTCP reports sent by the SUT when receiving RTP packets again. + +Status: Mandatory + +Preconditions: 1) The SUT has passed tests 6.2.6.4 and 6.2.6.5. +2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. +3) Data injection is set to send a single RTP stream (one SSRC) with loss according to the test procedure below. + +Test procedure: 1) Observe SUT and data injection output. +2) Note the cumulative number of packets lost ( $c_i$ ) for each RTCP report block sent from the SUT reporting on the RTP stream sent from data injection. +3) RTP packets are sent from data injection. +4) An RTCP packet, $i = 1$ , is sent from the SUT, reporting on the RTP stream from data injection. This RTCP packet is not necessarily the very first RTCP packet sent by the SUT in the RTP session but just the first in the scope of this test. The value of $i$ and its relation to how many RTCP packets that are actually sent by the SUT is only significant in context of describing the test procedure. + +- 5) All RTP packets are prevented from reaching the SUT and dropped (not buffered), without modifying the session as seen from the SUT, e.g. through proprietary data injection interaction or through transport network actions. +- 6) Note the sequence number $s_1$ of the last RTP packet reaching the SUT before the RTP loss period. +- 6) At least two RTCP packets, $i \in [2..n]$ , are sent from the SUT, reporting on the RTP stream from data injection (the first one likely covering the beginning of the all-loss period). +- 7) RTP packets are no longer prevented from reaching the SUT, without modifying the session as seen from the SUT, e.g. through proprietary data injection interaction or through transport network actions. +- 8) Note the sequence number $s_2$ of the first RTP packet reaching the SUT after the RTP loss period. + +**Stop condition:** An RTCP packet, $i = n + 1$ , is sent from the SUT after step 8 in the test procedure. + +**Pass criteria:** The report block in RTCP packets sent from the SUT, reporting on the RTP stream from data injection fulfils: + +- 1) RTCP packets with $i \in [3..n]$ do not contain any report block for the SSRC used by data injection and that was subjected to loss in step 5 of the test procedure. +- 2) $c_{n+1} = c_1 + (s_2 - s_1)$ . + +**Comments:** The test result is agnostic to RTP packets being sent by the SUT or not. $s_2$ must be strictly larger than $s_1$ (i.e., not wrapped around) for the pass criteria to work as currently formulated. + +#### 6.2.6.11 Extended Highest Sequence Number Received Test + +**Purpose:** Test if the "extended last sequence number received" field in the receiver report sent from the SUT is consistent with RTP "sequence number" field sent by data injection. + +**Status:** Mandatory + +**Preconditions:** + +- 1) The SUT has passed test 6.2.6.1. +- 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. +- 3) Data injection is set to send a single RTP stream (one SSRC). +- 4) The "sequence number" (SN) field in the first RTP packet sent from data injection is monotonously increasing (see 6.2.6.12 for test of wrapped value). + +**Test procedure:** + +- 1) Observe the SUT and data injection output. +- 2) Note the "extended last sequence number received" field ( $e_i$ ) of each RTCP packet sent from the SUT. +- 3) Count the number of RTCP packets ( $n$ ) sent from the SUT. +- 4) Count the number of sent RTP packets ( $P_i$ ) sent from data injection between each pair $\{i - 1, i\}$ of subsequent RTCP packets sent from the SUT. The value of $i$ and its relation to how many RTCP packets that are actually sent by the SUT is only significant in context of describing the test procedure. +- 5) Note the "sequence number" field ( $s_{i,j}$ ) of each RTP packet sent by data injection, with $j \in [1..P_i]$ . +- 6) Note the RTP packet number, $l_i = j$ , where $s_{i,j} = (e_i \% 2^{16})$ , or if no RTP packet with such $s_{i,j}$ exists, set $l_i = 0$ . + +**Stop condition:** + +- 1) RTP packets are sent from data injection. +- 2) At least three RTCP packets are sent from the SUT after the first RTP packet from data injection (one or more RTCP packets may be sent before first RTP packet). + +**Pass criteria:** $l_i \in [1..P_i]$ , for all $i \in [2..n]$ . + +**Comments:** The test result is agnostic to RTP packets being sent by the SUT or not. + +#### 6.2.6.12 Wrapped Extended Highest Sequence Number Received Test + +**Purpose:** Test if the "extended last sequence number received" field in the receiver report sent from the SUT is consistent with RTP "sequence number" field sent by data injection, even when the "sequence number" field wraps around, and the extended part above 16 bits sent from the SUT is properly incremented after wrap. + +**Status:** Conditionally Mandatory (Precondition 4) + +- Preconditions: +- 1) The SUT has passed test 6.2.6.11. + - 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. + - 3) Data injection is set to send a single RTP stream (one SSRC). + - 4) The "sequence number" (SN) field in the first RTP packet sent from data injection is set to a value close to $2^{16}-1$ (when interpreted as an unsigned 16-bit integer), such that the value will wrap during the test. +- Test procedure: +- 1) Observe the SUT and data injection output. + - 2) Note the "extended last sequence number received" field ( $e_i$ ) of each RTCP packet sent from the SUT. + - 3) Count the number of RTCP packets ( $n$ ) sent from the SUT. + - 4) Count the number of sent RTP packets ( $P_i$ ) sent from data injection between each pair $\{i-1, i\}$ of subsequent RTCP packets sent from the SUT. The value of $i$ and its relation to how many RTCP packets that are actually sent by the SUT is only significant in context of describing the test procedure. + - 5) Note the "sequence number" field ( $s_{i,j}$ ) of each RTP packet sent by data injection, with $j \in [1..P_i]$ . + - 6) Note the RTP packet number, $l_i = j$ , where $s_{i,j} = (e_i \% 2^{16})$ , or if no RTP packet with such $s_{i,j}$ is received, set $l_i = 0$ . +- Stop condition: +- 1) RTP packets are sent from data injection. + - 2) At least three RTCP packets are sent from the SUT after the first RTP packet from data injection (one or more RTCP packets may be sent before first RTP packet). + - 3) $s_{1,1} > s_{n-1,P_{n-1}}$ when interpreted as unsigned 16-bit integers. +- Pass criteria: +- 1) $l_i \in [1..P_i]$ , for all $i \in [2..n]$ . + - 2) $(e_n \gg 16) - (e_1 \gg 16) = 1$ . +- Comments: The test result is agnostic to RTP packets being sent by the SUT or not. + +#### 6.2.6.13 Out-of-sequence Extended Highest Sequence Number Received Test + +- Purpose: Test if the "extended last sequence number received" field in the receiver report sent from the SUT is consistent with RTP "sequence number" field sent by data injection, even when the "sequence number" field in RTP packets sent by data injection is not monotonically incrementing. +- Status: Conditionally Mandatory (Precondition 3) +- Preconditions: +- 1) The SUT has passed test 6.2.6.11. + - 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. + - 3) Data injection is set to send a single RTP stream (one SSRC) where the "sequence number" field in the RTP packet header is not generated with a constant increment of 1 ( $n, n+1, n+2, \dots$ ) but with alternating increments of -1 and 3 ( $n+1, n, n+3, n+2, \dots$ ). +- Test procedure: +- 1) Observe the SUT and data injection output. + - 2) Note the "extended last sequence number received" field ( $e_i$ ) of each RTCP packet sent from the SUT. + - 3) Count the number of RTCP packets ( $n$ ) sent from the SUT. + - 4) Count the number of sent RTP packets ( $P_i$ ) sent from data injection between each pair $\{i-1, i\}$ of subsequent RTCP packets sent from the SUT. The value of $i$ and its relation to how many RTCP packets that are actually sent by the SUT is only significant in context of describing the test procedure. + - 5) Note the "sequence number" field ( $s_{i,j}$ ) of each RTP packet sent by data injection, with $j \in [1..P_i]$ . + - 6) Note the RTP packet number, $l_i = j$ , where $s_{i,j} = (e_i \% 2^{16})$ , or if no RTP packet with such $s_{i,j}$ exists, set $l_i = 0$ . +- Stop condition: +- 1) RTP packets are sent from data injection. + - 2) At least three RTCP packets are sent from the SUT after the first RTP packet from data injection (one or more RTCP packets may be sent before first RTP packet). +- Pass criteria: +- 1) $l_i \in [1..P_i]$ , for all $i \in [2..n]$ . + - 2) $(e_i \% 2^{16}) = \max_j s_{i,j}$ , for all $i \in [2..n]$ and $j \in [1..l_i]$ . + +Comments: The test result is agnostic to RTP packets being sent by the SUT or not. + +#### 6.2.6.14 Interarrival Jitter Test + +Purpose: Test if the "interarrival jitter" field in the receiver report sent from the SUT, as described by RTP [2] section 6.4.1, is consistent with RTP packets sent by data injection. + +Status: Conditionally Mandatory (Precondition 3) + +Preconditions: + + +- 1) The SUT has passed tests 6.2.4.2, 6.2.4.4, and 6.2.6.1. +- 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. +- 3) Data injection is set to send a single RTP stream (one SSRC) that is subjected to delay variations according to delay and loss profiles from TS 26.132 [11] Annex E.3. + +Test procedure: + + +- 1) Observe the SUT and data injection output. +- 2) Retrieve RTP Time Stamp rate information ( $S$ ), e.g. from "" on the SDP "a=rtpmap: /" line used to set up the SUT session, applicable for the RTP stream that the RTCP packets sent from the SUT are associated with. +- 3) For each delay and loss profile $k$ from dly\_profile\_20msDRX\_10pctBLER\_e2e and dly\_profile\_20msDRX\_10pctBLER\_ue1\_to\_eNB2 in TS 26.131 [11] Annex E.3 (see also Table 6.2.6.14-1 below), repeat the following steps: +- 4) Start data injection sending RTP packets subjected to delay variations according to the delay and loss profile. +- 5) Note the reception time ( $t_{k,i}$ ) and "interarrival jitter" ( $j_{k,i}$ ) field in the report block of each RTCP packet sent from the SUT. +- 6) Count the number of RTCP packets ( $n_k$ ) sent from the SUT. +- 7) Count the number of sent RTP packets ( $P_{k,i}$ ) sent from data injection between each pair $\{i - 1, i\}$ of subsequent RTCP packets sent from the SUT. The value of $i$ and its relation to how many RTCP packets that are actually sent by the SUT is only significant in context of describing the test procedure. +- 8) Note the reception time ( $r_{k,i,j}$ ) and "timestamp" field ( $T_{k,i,j}$ ) of each RTP packet sent from data injection, with $j \in [1..P_{k,i}]$ . + +9) Calculate the arrival time $a_{k,i,j} = T_{k,1,1} + (r_{k,i,j} - r_{k,1,1})/S$ in timestamp units of each RTP packet sent from data injection, with $j \in [1..P_{k,i}]$ , and where $r_{k,1,1}$ is the reception time of the first received RTP packet with timestamp $T_{k,1,1}$ sent from data injection. + +10) Calculate the difference in RTP packet spacing $D_{k,i,j} = (a_{k,i,j} - T_{k,i,j}) - (a_{k,i,j-1} - T_{k,i,j-1})$ , with $j \in [2..P_{k,i}]$ . + +11) Calculate (not using integer arithmetic) the filtered RTP packet jitter $J_{k,i} = \sum_{j=2}^{P_{k,i}} s_j$ , where $s_j = (|D_{k,i,j}| - s_{j-1})/16$ , with $s_1 = J_{k,i-1}$ , where $J_{k,i-1}$ corresponds to the filtered RTP packet jitter reported in previous RTCP packet sent from the SUT, and $J_{k,1} = 0$ . + +12) When there are no more delay and loss profile data to apply to RTP packets, stop sending RTP packets to avoid further impact to $J_{k,i}$ . + +Stop condition: + + +- 1) RTP packets are sent from data injection. +- 2) At least one RTCP packet is sent from the SUT after the last RTP packet from data injection, for each delay and loss profile. + +Pass criteria: $j_{k,n_k} = \lfloor J_{k,n_k} \rfloor$ , for all $k$ , where expected, nominal values based only on delay and loss profile content, excluding any data injection or test instrument implementation impact, are (for information): + +**Table 6.2.6.14-1 Examples of delay and loss profile jitter** + +| Delay and loss profile | $k$ | $n_k$ | $\lfloor J_{k,n_k} \rfloor$ | $\lfloor J_{k,n_k} \rfloor$ | +|-------------------------------------------|-----|-------|-----------------------------|-----------------------------| +| | | | $S = 8000$ | $S = 16000$ | +| dly_profile_20msDRX_10pctBLER_e2e | 1 | 8000 | 93 | 186 | +| dly_profile_20msDRX_10pctBLER_ue1_to_eNB2 | 2 | 8000 | 27 | 55 | + +Comments: The test result is agnostic to RTP packets being sent by the SUT or not. + +#### 6.2.6.15 Last Sender Report Timestamp Test + +Purpose: Test if the LSR field in the receiver report from the SUT corresponds to middle 32 bits of "NTP timestamp" 64-bit field for some previous RTCP sender report sender info sent from data injection. + +Status: Mandatory + +Preconditions: + + +- 1) The SUT has passed test 6.2.2.6. +- 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. +- 3) Data injection is set to send a single RTP stream (one SSRC). + +Test procedure: + + +- 1) Observe the SUT and data injection output. +- 2) Note the LSR field ( $L_i$ ) in the report block of each RTCP packet sent from the SUT. +- 3) Count the number of RTCP packets ( $n$ ) sent from the SUT. +- 4) Note the "NTP timestamp, most significant word" ( $m_j$ ) and "NTP timestamp, least significant word" ( $l_j$ ) fields in the sender information of each RTCP packet sent from data injection. +- 5) Count the number of RTCP packets ( $p$ ) sent from data injection. +- 6) Calculate the reduced-precision last SR NTP time $N_j = \left( (m_j \& (2^{16} - 1)) \ll 2^{16} \right) + (l_j \gg 2^{16})$ for each RTCP packet sent from data injection, with $j \in [1..p]$ . +- 7) Note the RTCP packet number sent from data injection, $q_i = j$ , where $L_i = N_j$ , or if no RTCP packet with such $N_j$ exists, set $q_i = 0$ . + +Stop condition: + + +- 1) RTP packets are sent from data injection. +- 2) RTCP packets are sent from data injection. +- 3) At least three RTCP packets with $L_i \neq 0$ are sent from the SUT after the first RTCP packet is sent from data injection. + +Pass criteria: $q_i > 0$ , for at least one $i \in [1..n]$ . + +Comments: The test result is agnostic to RTP packets being sent by the SUT or not. + +#### 6.2.6.16 Delay Since Last SR Test + +Purpose: Test if the reception time and delay since last SR field in the receiver report from the SUT is consistent with observed reception time and NTP timestamp field of the corresponding RTCP sender report sender info from data injection. + +Status: Mandatory + +Preconditions: + + +- 1) The SUT has passed test 6.2.6.15. +- 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. +- 3) Data injection is set to send a single RTP stream (one SSRC). + +Test procedure: + + +- 1) Observe the SUT and data injection output. +- 2) Note the LSR ( $L_i$ ) and "delay since last LSR" (DLSR) ( $D_i$ ) fields in the report block and reception time ( $t_i$ ) of each RTCP packet sent from the SUT. +- 3) Count the number of RTCP packets ( $n$ ) sent from the SUT. +- 4) Note the "NTP timestamp, most significant word" ( $m_j$ ) and "NTP timestamp, least significant word" ( $l_j$ ) fields in the sender information, and reception time ( $r_j$ ) of each RTCP packet sent from data injection. +- 5) Count the number of RTCP packets ( $p$ ) sent from data injection. +- 6) Calculate the reduced-precision last SR NTP time $N_j = \left( (m_j \& (2^{16} - 1)) \ll 2^{16} \right) + (l_j \gg 2^{16})$ for each RTCP packet sent from data injection, with $j \in [1..p]$ . +- 7) Calculate the data injection reporting interval $s_j = r_j - r_{j-1}$ , for $j \in [2..p]$ . +- 8) Note the RTCP packet number sent from data injection, $q_i = j$ , where $L_i = N_j$ , or if no RTCP packet with such $N_j$ exists, set $q_i = 0$ . + +9) Calculate the observed round-trip reporting time, $d_i = r_{q_i} - t_i$ for all $i$ with $q_i \neq 0$ , where $r_{q_i}$ is the $r_j$ with $q_i = j$ . + +10) Calculate the round-trip time, $R_i = r_{q_i} - t_i - D_i/65536$ for all $i$ with $q_i \neq 0$ . + +Stop condition: 1) RTP packets are sent from data injection. +2) RTCP packets are sent from data injection. +3) At least three RTCP packets with $L_i \neq 0$ and $D_i \neq 0$ are sent from the SUT after the first RTCP packet from data injection. + +Pass criteria: 1) $d_i \geq D_i/65536$ for all $i$ with $q_i \neq 0$ , i.e. the DLSR value cannot represent a longer time than the entire, observed round-trip time. +2) $D_i/65536 \leq \max_j s_j$ for all $i$ with $q_i \neq 0$ and $j \in [2..p]$ , i.e. the DLSR value cannot represent a time that exceeds an RTCP reporting interval. + +Comments: This test only performs a sanity check of the DLSR field sent from the SUT since the DLSR field value in general cannot be verified without close knowledge of SUT detailed conditions and implementation. +The test result is agnostic to RTP packets being sent by the SUT or not. + +### 6.2.7 Feedback Report Block Tests + +#### 6.2.7.1 Ignoring Unknown Feedback Report Test + +Purpose: Test if receiving an RTCP feedback report [7] of unknown (non-negotiated) type is correctly ignored by the SUT without negative impact on other RTP/RTCP operation. + +Status: Mandatory + +Preconditions: 1) The SUT is set to not use RTCP Feedback messages during the test session, e.g. pre-configured or through no "a=rtcp-fb" lines being included in SDP signalling from the test instrument. +2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. + +Test procedure: 1) Observe SUT output. +2) RTP and RTCP packets are sent from the SUT. +3) Data injection sends an RTCP Feedback message to the SUT, as part of a compound RTCP message starting with a RTCP SR or RR. The RTCP Feedback message is characterized by the Payload Type (PT) field in the RTCP header set to either 205 (RTPFB) or 206 (PSFB), and the Feedback Message Type (FMT) may be chosen freely by data injection and set to any value. + +Stop condition: One or more RTP packets and one or more RTCP packets are sent by the SUT, or time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1). + +Pass criteria: RTP and RTCP packets are sent by the SUT after step 3 in the test procedure. + +Comments: The test only tries to detect if the RTP/RTCP stack in the SUT is operational after receiving an unexpected RTCP FB message in the sense that RTP and RTCP packets are still sent from the SUT. The test does not check for more detailed signs of SUT RTP/RTCP stack malfunction after receiving the unexpected RTCP message. +The test result is agnostic to RTP packets being received by the SUT or not. + +### 6.2.8 Extended Report Block Tests + +#### 6.2.8.1 Ignoring Unknown XR Test + +Purpose: Test if receiving an RTCP XR [13] packet of unknown (non-negotiated) type is correctly ignored by the SUT without negative impact on other RTP/RTCP operation. + +Status: Mandatory + +- Preconditions: 1) The SUT is set to not use RTCP XR messages during the test session, e.g. pre-configured or through no "a=rtcp-xr" lines being included in SDP signalling from the test instrument. +2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. +- Test procedure: 1) Observe SUT output. +2) RTP and RTCP packets are sent from the SUT. +3) Data injection sends an RTCP Feedback message to the SUT, as part of a compound RTCP message starting with a RTCP SR or RR. The RTCP Feedback message is characterized by the Payload Type (PT) field in the RTCP header set to 207, and the reserved bits are all set to zero. +- Stop condition: One or more RTP packets and one or more RTCP packets are sent by the SUT, or time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1). +- Pass criteria: RTP and RTCP packets are sent by the SUT after step 3 in the test procedure. +- Comments: The test only tries to detect if the RTP/RTCP stack in the SUT is operational after receiving an unexpected RTCP XR message in the sense that RTP and RTCP packets are still sent from the SUT. The test does not check for more detailed signs of SUT RTP/RTCP stack malfunction after receiving the unexpected RTCP message. +The test result is agnostic to RTP packets being received by the SUT or not. + +### 6.2.9 APP Tests + +#### 6.2.9.1 Ignoring Unknown APP Test + +- Purpose: Test if receiving an RTCP APP packet (see section 6.7 of IETF RFC 3550 [2]) with unknown name is correctly ignored by the SUT without negative impact on other RTP/RTCP operation. +- Status: Mandatory +- Preconditions: 1) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. +- Test procedure: 1) Observe SUT output. +2) RTP and RTCP packets are sent from the SUT. +3) Data injection sends an RTCP APP message to the SUT, as part of a compound RTCP message starting with a RTCP SR or RR. The RTCP APP message is characterized by the Payload Type (PT) field in the RTCP header set to 204, the subtype field may be chosen freely by data injection and set to any value, and the name field may be chosen freely by data injection from any sequence of four ASCII characters, with the exception that if the SUT is known to explicitly recognize APP messages with certain name field values, the name field is not set to any of those values. +- Stop condition: One or more RTP packets and one or more RTCP packets are sent by the SUT, or time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1). +- Pass criteria: RTP and RTCP packets are sent by the SUT after step 3 in the test procedure. +- Comments: The test only tries to detect if the RTP/RTCP stack in the SUT is operational after receiving an unexpected RTCP APP message in the sense that RTP and RTCP packets are still sent from the SUT. The test does not check for more detailed signs of SUT RTP/RTCP stack malfunction after receiving the unexpected RTCP message. +The test result is agnostic to RTP packets being received by the SUT or not. + +### 6.2.10 Reduced-Size Packet Tests + +#### 6.2.10.1 Ignoring Unsupported Reduced-Size Test + +- Purpose: Test if receiving a reduced-size RTCP packet [8] when its use is not negotiated is correctly ignored by the SUT without negative impact on other RTP/RTCP operation. +- Status: Mandatory + +- Preconditions: 1) The SUT is set to not use reduced-size RTCP messages during the test session, e.g. pre-configured or through no "a=rtcp-rsize" lines being included in SDP signalling from the test instrument. +2) The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. +- Test procedure: 1) Observe SUT output. +2) RTP and RTCP packets are sent from the SUT. +3) Data injection sends one or more compound RTCP messages to the SUT. +4) Data injection sends a reduced-size RTCP message to the SUT, not a compound RTCP starting with a RTCP SR or RR. What reduced-size RTCP message to use may be chosen freely by data injection as long as it is a correct and well-formed RTCP message, but can e.g. be a single RTCP Generic NACK (see section 6.2.1 of IETF RFC 4585 [7]). +- Stop condition: One or more RTP packets and one or more RTCP packets are sent by the SUT, or time has passed corresponding to at least three maximum RTCP intervals (see clause 6.2.1). +- Pass criteria: RTP and RTCP packets are sent by the SUT after step 4 in the test procedure. +- Comments: The test only tries to detect if the RTP/RTCP stack in the SUT is operational after receiving an unexpected reduced-size RTCP message in the sense that RTP and RTCP packets are still sent from the SUT. The test does not check for more detailed signs of SUT RTP/RTCP stack malfunction after receiving the unexpected RTCP message. +The test result is agnostic to RTP packets being received by the SUT or not. + +## 6.3 RTP Tests + +### 6.3.1 General + +This clause describes tests that are applicable to all RTP and SRTP packets. If not explicitly stated otherwise, any reference to RTP is equally applicable to SRTP. Tests that are only applicable to SRTP and not to RTP are specified in clause 6.5. + +### 6.3.2 Basic RTP Tests + +#### 6.3.2.1 Receive RTP Padding Test + +- Purpose: Test if RTP packets with padding are correctly received by the SUT. +- Status: Mandatory +- Preconditions: 1) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. +2) Data injection is set to use RTP padding as described by sections 4 and 5.1 of RFC 3550 in some or all RTP packets during the test session (RTP header P bit set). Any number of padding octets (larger than zero) suitable to the test instrument may be chosen. +- Test procedure: 1) Observe the SUT application-level output based on RTP packet payload, e.g. audio from a speaker and/or video on a screen. +2) RTP packets with RTP payload and RTP padding are sent from data injection. +- Stop condition: Ten or more seconds have passed after first RTP packet was sent from data injection. +- Pass criteria: Application-level output from the SUT exist as expected (e.g. audio and/or video) and is undistorted compared to a corresponding test setup where RTP padding is not used. +- Comments: The test result is agnostic to RTP packets being sent by the SUT or not. + +#### 6.3.2.2 Initial SSRC Value Test + +- Purpose: Test if the SSRC value is chosen randomly by the SUT for every new RTP stream sent by the SUT. + +Status: Mandatory + +Preconditions: The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. + +Test procedure: + +- 1) Observe the SUT output. +- 2) Note synchronization source (SSRC) field values ( $s_i$ ) in RTP packet headers from different RTP streams ( $i$ ) sent from the SUT. +- 3) Start sending three or more new RTP streams from the SUT, one after the other (one at a time) or sent simultaneously. Any method suitable to the SUT and the test instrument may be chosen to achieve this, e.g. making three or more calls with the SUT, adding and removing an RTP stream three or more times during a single session (call), or adding three or more simultaneous RTP streams for a single session (call). +- 4) Count the number of different RTP streams (different SSRC values), $n$ , sent during the test from the SUT. + +Stop condition: RTP packets for three or more, separate RTP streams are sent from the SUT. + +Pass criteria: + +- 1) $s_i \neq s_{i-1}$ for all $i \in [2..n]$ . +- 2) $s_i \neq s_{i-1} + 1$ for all $i \in [2..n]$ . +- 3) $s_i \neq s_{i-1} - 1$ for all $i \in [2..n]$ . + +Comments: The test pass criteria are a rough approximation of testing that the SSRC is a random value, i.e. simply testing that SSRC values are not all the same and not an increasing or decreasing sequence. Testing that the SSRC value is truly a random number would require a much more elaborate formula. The test result is agnostic to RTP packets being received by the SUT or not. + +#### 6.3.2.3 Initial Sequence Number Test + +Purpose: Test if the Sequence Number start value is chosen randomly by the SUT for every new RTP stream sent by the SUT. + +Status: Mandatory + +Preconditions: The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. + +Test procedure: + +- 1) Observe the SUT output. +- 2) Note the sequence number (SN) field value ( $S_i$ ) of the first RTP packet header of each RTP stream ( $i$ ) sent from the SUT. +- 3) Start sending three or more new RTP streams from the SUT, one after the other (one at a time) or sent simultaneously. Any method suitable to the SUT and the test instrument may be chosen to achieve this, e.g. making three or more calls with the SUT, adding and removing an RTP stream three or more times during a single session (call), or adding three or more simultaneous RTP streams for a single session (call). +- 4) Count the number of different RTP streams (different SSRC values), $n$ , sent during the test from the SUT. + +Stop condition: RTP packets for three or more, separate RTP streams are sent from the SUT. + +Pass criteria: + +- 1) $S_i \neq S_{i-1}$ for all $i \in [2..n]$ . +- 2) $S_i \neq S_{i-1} + 1$ for all $i \in [2..n]$ . +- 3) $S_i \neq S_{i-1} - 1$ for all $i \in [2..n]$ . + +Comments: The test pass criteria are a rough approximation of testing that the first SN is a random value, i.e. simply testing that the first SN values are not all the same and not an increasing or decreasing sequence. Testing that the first SN value is truly a random number would require a much more elaborate formula. The test result is agnostic to RTP packets being received by the SUT or not. + +#### 6.3.2.4 Initial Time Stamp Test + +Purpose: Test if the timestamp start value is chosen randomly by the SUT for every new RTP stream sent by the SUT. + +**Status:** Mandatory + +**Preconditions:** The SUT is set to send RTP packets during the test session, e.g. pre-configured or set as send-receive or send-only through test instrument signalling. + +**Test procedure:** + +- 1) Observe the SUT output. +- 2) Note the timestamp field value ( $T_i$ ) of the first RTP packet header of each RTP stream ( $i$ ) sent from the SUT. +- 3) Start sending three or more new RTP streams from the SUT, one after the other (one at a time) or sent simultaneously. Any method suitable to the SUT and the test instrument may be chosen to achieve this, e.g. making three or more calls with the SUT, adding and removing a single RTP stream three or more times during a single session (call), or adding three or more simultaneous RTP streams for a single session (call). +- 4) Count the number of different RTP streams (different SSRC values), $n$ , sent during the test from the SUT. + +**Stop condition:** RTP packets for three or more, separate RTP streams have been sent from the SUT. + +**Pass criteria:** + +- 1) $T_i \neq T_{i-1}$ for all $i \in [2..n]$ . +- 2) $T_i \neq T_{i-1} + 1$ for all $i \in [2..n]$ . +- 3) $T_i \neq T_{i-1} - 1$ for all $i \in [2..n]$ . + +**Comments:** The test pass criteria are a rough approximation of testing that the first TS is a random value, i.e. simply testing that the first TS values are not all the same and not an increasing or decreasing sequence. Testing that the first TS value is truly a random number would require a much more elaborate formula. The test result is agnostic to RTP packets being received by the SUT or not. + +### 6.3.3 RTP Header Extension Tests + +#### 6.3.3.1 Ignore Unknown Header Extension Test + +**Purpose:** Test if the SUT correctly ignores the RTP header extension when receiving RTP packets with an unknown header extension but that the SUT still accepts the RTP payload of those RTP packets. + +**Status:** Mandatory + +**Preconditions:** + +- 1) The SUT is set to not use RTP header extensions during the test session, e.g. pre-configured or through no "a=extmap" lines being included in SDP signalling from the test instrument. +- 2) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. +- 3) Data injection is set to use RTP header extension (RTP header X field set to 1) in some or all RTP packets during the test session, even though not announced through test instrument signalling. Any RTP header extension content according to section 5.3.1 of RFC 3550 that is suitable to the test instrument may be chosen, but the RTP header extension length field must be set larger than zero and the amount of RTP header extension data included in the RTP packet before the RTP payload must correspond to that length in each RTP packet. + +**Test procedure:** + +- 1) Observe the SUT application-level output based on RTP packet payload, e.g. audio from a speaker and/or video on a screen. +- 2) RTP packets with RTP header extension and RTP payload are sent from data injection. + +**Stop condition:** Ten or more seconds have passed after first RTP packet was sent from data injection. + +**Pass criteria:** Application-level output from the SUT exist as expected (e.g. audio and/or video) and is undistorted compared to a corresponding test setup where RTP header extension is not used. + +**Comments:** The test result is agnostic to RTP packets being sent by the SUT or not. + +### 6.3.4 RTP Contributing Source Tests + +#### 6.3.4.1 Ignore Contributing Source Test + +**Purpose:** Test if the SUT correctly ignores the CSRC list when receiving RTP packets with a non-zero CC field and CSRC list but that the SUT still accepts the RTP payload of those RTP packets. + +**Status:** Mandatory + +**Preconditions:** + +- 1) The SUT is set to receive RTP packets during the test session, e.g. pre-configured or set as send-receive or receive-only through test instrument signalling. +- 2) Data injection is set to use a CSRC list in some or all RTP packets during the test session (RTP header CC > 0). Any CSRC content suitable to the test instrument may be chosen, but the number of 32-bit CSRC values included in the CSRC list must correspond to the CC field in each RTP packet. + +**Test procedure:** + +- 1) Observe the SUT application-level output based on RTP packet payload, e.g. audio from a speaker and/or video on a screen. +- 2) RTP packets with CSRC list and RTP payload are sent from data injection. + +**Stop condition:** Ten or more seconds have passed after first RTP packet was sent from data injection. + +**Pass criteria:** Application-level output from the SUT exist as expected (e.g. audio and/or video) and is undistorted compared to a corresponding test setup where CSRC list is not used. + +**Comments:** The test result is agnostic to RTP packets being sent by the SUT or not. + +## 6.4 SRTCP Tests + +### 6.4.1 General + +This clause describes tests that are only applicable to SRTCP but not to RTCP. Tests that are applicable to both SRTCP and RTCP are described in clause 6.2. + +## 6.5 SRTP Tests + +### 6.5.1 General + +This clause describes tests that are only applicable to SRTP but not to RTP. Tests that are applicable to both SRTP and RTP are described in clause 6.3. + +# --- 7 Conformance Indication + +## 7.1 General + +An RTP/RTCP implementation conforming to this specification should announce its compliance during call setup. Announcing compliance to this specification must use an SDP attribute "a=3gpp-rtp" (see clause 7.2). + +## 7.2 The a=3gpp-rtp SDP attribute + +### 7.2.1 General + +The a=3gpp-rtp attribute may be provided on SDP session level, SDP media level or both. It is not defined for use on source or dcsa level. If used on SDP session level, it must be taken as applicable to all m= lines in the SDP using any RTP profile, e.g. RTP/AVP, RTP/AVPF, RTP/SAVP, or RTP/SAVPF. If used on SDP media level using any RTP + +profile, it must be taken as applicable only to that media description. It is not defined for use on non-RTP SDP media level. + +### 7.2.2 ABNF syntax and semantics + +The 3gpp-rtp ABNF syntax is: + +3gpp-rtp-value = [3gpp-rtp-extension] + +3gpp-rtp-extension = byte-string + +; SP and byte-string as defined by IETF RFC 4566 + +Example: + +a=3gpp-rtp + +The optional attribute value is defined to allow for future extensibility and has currently no defined use. + +### 7.2.3 SDP offer/answer considerations + +This attribute is a unilateral announcement from the party creating the SDP offer or answer, and there are thus no SDP offer/answer considerations. When announcing compliance to this specification, the a=3gpp-rtp attribute shall be included in the SDP offer, and shall be included in the SDP answer regardless if it was also present in the corresponding SDP offer. + +The optional attribute value should not be included in an SDP offer or answer sent by implementers of this specification and shall be ignored if received in an SDP offer or answer. + +### 7.2.4 IANA registration information + +Contact name, email address, and telephone number: + +3GPP Specifications Manager + +[3gppContact@etsi.org](mailto:3gppContact@etsi.org) + ++33 (0)492944200 + +Attribute Name (as it will appear in SDP): + +3gpp-rtp + +Long-form Attribute Name in English: + +3GPP-conformant RTP/RTCP implementation + +Type of Attribute: + +Session level and media level + +Is Attribute Value subject to the Charset Attribute? + +This attribute is not dependent on charset. + +Purpose of the attribute: + +This attribute is used to indicate the RTP/RTCP stack conformance to 3GPP TS 26.139. + +Appropriate Attribute Values for this Attribute: + +See 3GPP TS 26.139 clause 7.2.2 for ABNF and detailed usage. + +MUX Category for this Attribute: + +IDENTICAL \ No newline at end of file diff --git a/marked/Rel-18/26_series/26190/1ce027dfd26183da52137cf990213724_img.jpg b/marked/Rel-18/26_series/26190/1ce027dfd26183da52137cf990213724_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..afeb898a847a0a667ac30192fccaa74a916f1f9e --- /dev/null +++ b/marked/Rel-18/26_series/26190/1ce027dfd26183da52137cf990213724_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe51c3184d5609859a6b597fc1301931743acd3727376a99c5ec06166d6f4b98 +size 29535 diff --git a/marked/Rel-18/26_series/26190/33a8f3f01dfa8bce75d23017855a13c5_img.jpg b/marked/Rel-18/26_series/26190/33a8f3f01dfa8bce75d23017855a13c5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6cf039c3a8da6829f2f5d78e57162baf6f034b3c --- /dev/null +++ b/marked/Rel-18/26_series/26190/33a8f3f01dfa8bce75d23017855a13c5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a0c235efefc48b9b86490f992573813e853568c1fa49209aa25adc86ca2498f7 +size 14970 diff --git a/marked/Rel-18/26_series/26190/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg b/marked/Rel-18/26_series/26190/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..75632a4fed1cc9681e544783ec4417ab7a988a61 --- /dev/null +++ b/marked/Rel-18/26_series/26190/3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e4303fff04f16037e4f912aaa18b03b96d882fc207064722e5d819b36139ae44 +size 60917 diff --git a/marked/Rel-18/26_series/26190/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/26_series/26190/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..949724ffb684ba3af86acf2f05b3df771988eec7 --- /dev/null +++ b/marked/Rel-18/26_series/26190/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:63d5b5f678cb91d543843265d78eb2c56d10d8af6a7f2a3d0deda71d550884a2 +size 7682 diff --git a/marked/Rel-18/26_series/26190/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/26_series/26190/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7eb5a917aabf0e55ee2296ec95abe08f4bf5aa54 --- /dev/null +++ b/marked/Rel-18/26_series/26190/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:147e9356421d34474ee2b41d4b55712f309cb4e249f1be41c08fee0523cd8da8 +size 5652 diff --git a/marked/Rel-18/26_series/26190/a3b3abbf6d0b18f3dd4a83680b5e3e42_img.jpg b/marked/Rel-18/26_series/26190/a3b3abbf6d0b18f3dd4a83680b5e3e42_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c5ad8a23821db707e0bca780bd90d22d2c28b86 --- /dev/null +++ b/marked/Rel-18/26_series/26190/a3b3abbf6d0b18f3dd4a83680b5e3e42_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2981c53a510c801574f3b0d7c06ad6b250e2874c58315ff656e543c060cfa185 +size 104640 diff --git a/marked/Rel-18/26_series/26190/raw.md b/marked/Rel-18/26_series/26190/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..32610d32aa94357ee23e7f724c541a33afefd961 --- /dev/null +++ b/marked/Rel-18/26_series/26190/raw.md @@ -0,0 +1,1830 @@ + + +# 3GPP TS 26.190 V18.0.0 (2024-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Speech codec speech processing functions; Adaptive Multi-Rate - Wideband (AMR-WB) speech codec; Transcoding functions (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal wave icon at its base. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +# **3GPP** + +--- + +Postal address + +--- + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 Normative references ..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 12 | +| 4 Outline description..... | 12 | +| 4.1 Functional description of audio parts ..... | 12 | +| 4.2 Preparation of speech samples ..... | 13 | +| 4.3 Principles of the adaptive multi-rate wideband speech encoder ..... | 13 | +| 4.4 Principles of the adaptive multi-rate speech decoder..... | 16 | +| 4.5 Sequence and subjective importance of encoded parameters ..... | 16 | +| 5 Functional description of the encoder..... | 16 | +| 5.1 Pre-processing ..... | 16 | +| 5.2 Linear prediction analysis and quantization..... | 17 | +| 5.2.1 Windowing and auto-correlation computation ..... | 17 | +| 5.2.2 Levinson-Durbin algorithm ..... | 17 | +| 5.2.3 LP to ISP conversion ..... | 18 | +| 5.2.4 ISP to LP conversion ..... | 19 | +| 5.2.5 Quantization of the ISP coefficients ..... | 20 | +| 5.2.6 Interpolation of the ISPs..... | 21 | +| 5.3 Perceptual weighting..... | 21 | +| 5.4 Open-loop pitch analysis..... | 22 | +| 5.4.1 6.60 kbit/s mode ..... | 22 | +| 5.4.2 8.85, 12.65, 14.25, 15.85, 18.25, 19.85, 23.05 and 23.85 kbit/s modes ..... | 23 | +| 5.5 Impulse response computation..... | 24 | +| 5.6 Target signal computation..... | 24 | +| 5.7 Adaptive codebook..... | 24 | +| 5.8 Algebraic codebook..... | 26 | +| 5.8.1 Codebook structure..... | 26 | +| 5.8.1.1 23.85 and 23.05 kbit/s mode..... | 26 | +| 5.8.1.2 19.85 kbit/s mode..... | 26 | +| 5.8.1.3 18.25 kbit/s mode..... | 27 | +| 5.8.1.4 15.85 kbit/s mode..... | 27 | +| 5.8.1.5 14.25 kbit/s mode..... | 27 | +| 5.8.1.6 12.65 kbit/s mode..... | 28 | +| 5.8.1.7 8.85 kbit/s mode..... | 28 | +| 5.8.1.8 6.60 kbit/s mode..... | 28 | +| 5.8.2 Pulse indexing ..... | 29 | +| 5.8.3 Codebook search ..... | 32 | +| 5.9 Quantization of the adaptive and fixed codebook gains ..... | 35 | +| 5.10 Memory update ..... | 36 | +| 5.11 High-band gain generation..... | 36 | +| 6 Functional description of the decoder..... | 36 | +| 6.1 Decoding and speech synthesis ..... | 37 | +| 6.2 High-pass filtering, up-scaling and interpolation..... | 39 | +| 6.3 High frequency band..... | 40 | +| 6.3.1 Generation of high-band excitation ..... | 40 | +| 6.3.2 LP filter for the high frequency band ..... | 40 | +| 6.3.2.1 6.60 kbit/s mode..... | 40 | +| 6.3.2.2 8.85, 12.65, 14.25, 15.85, 18.25, 19.85, 23.05 or 23.85 kbit/s modes..... | 41 | +| 6.3.3 High band synthesis..... | 41 | + +| | | | +|-------------------------------|------------------------------------------------------------------------|-----------| +| 7 | Detailed bit allocation of the adaptive multi-rate wideband codec..... | 41 | +| 8 | Homing sequences ..... | 47 | +| 8.1 | Functional description ..... | 47 | +| 8.2 | Definitions ..... | 48 | +| 8.3 | Encoder homing ..... | 48 | +| 8.4 | Decoder homing ..... | 48 | +| 9 | Bibliography..... | 50 | +| Annex A (informative): | Change history..... | 51 | + +# --- Foreword + +The present document describes the detailed mapping of the wideband telephony speech service employing the Adaptive Multi-Rate (AMR-WB) speech coder within the 3GPP system. + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of this TS, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 Indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the specification; + +# 1 Scope + +This Telecommunication Standard (TS) describes the detailed mapping from input blocks of 320 speech samples in 16-bit uniform PCM format to encoded blocks of 132, 177, 253, 285, 317, 365, 397, 461 and 477 bits and from encoded blocks of 132, 177, 253, 285, 317, 365, 397, 461 and 477 bits to output blocks of 320 reconstructed speech samples. The sampling rate is 16 000 samples/s leading to a bit rate for the encoded bit stream of 6.60, 8.85, 12.65, 14.25, 15.85, 18.25, 19.85, 23.05 or 23.85 kbit/s. The coding scheme for the multi-rate coding modes is the so-called Algebraic Code Excited Linear Prediction Coder, hereafter referred to as ACELP. The multi-rate wideband ACELP coder is referred to as MRWB-ACELP. + +# 2 Normative references + +This TS incorporates by dated and undated reference, provisions from other publications. These normative references are cited in the appropriate places in the text and the publications are listed hereafter. For dated references, subsequent amendments to or revisions of any of these publications apply to this TS only when incorporated in it by amendment or revision. For undated references, the latest edition of the publication referred to applies. + +- [1] GSM 03.50: " Digital cellular telecommunications system (Phase 2); Transmission planning aspects of the speech service in the GSM Public Land Mobile Network (PLMN) system" +- [2] 3GPP TS 26.201 : "AMR wideband speech codec; Frame structure". +- [3] 3GPP TS 26.194: "AMR wideband speech codec; Voice Activity Detection (VAD)". +- [4] 3GPP TS 26.173: "AMR wideband speech codec; ANSI-C code". +- [5] 3GPP TS 26.174: "AMR wideband speech codec; Test sequences". +- [6] ITU-T Recommendation G.711 (1988): "Coding of analogue signals by pulse code modulation Pulse code modulation (PCM) of voice frequencies". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of this TS, the following definitions apply: + +**adaptive codebook:** The adaptive codebook contains excitation vectors that are adapted for every subframe. The adaptive codebook is derived from the long-term filter state. The lag value can be viewed as an index into the adaptive codebook. + +**algebraic codebook:** A fixed codebook where algebraic code is used to populate the excitation vectors (innovation vectors). The excitation contains a small number of nonzero pulses with predefined interlaced sets of potential positions. The amplitudes and positions of the pulses of the $k^{\text{th}}$ excitation codevector can be derived from its index $k$ through a rule requiring no or minimal physical storage, in contrast with stochastic codebooks whereby the path from the index to the associated codevector involves look-up tables. + +**anti-sparseness processing:** An adaptive post-processing procedure applied to the fixed codebook vector in order to reduce perceptual artifacts from a sparse fixed codebook vector. + +**closed-loop pitch analysis:** This is the adaptive codebook search, i.e., a process of estimating the pitch (lag) value from the weighted input speech and the long term filter state. In the closed-loop search, the lag is searched using error minimization loop (analysis-by-synthesis). In the adaptive multi-rate wideband codec, closed-loop pitch search is performed for every subframe. + +**direct form coefficients:** One of the formats for storing the short term filter parameters. In the adaptive multi-rate wideband codec, all filters which are used to modify speech samples use direct form coefficients. + +**fixed codebook:** The fixed codebook contains excitation vectors for speech synthesis filters. The contents of the codebook are non-adaptive (i.e., fixed). In the adaptive multi-rate wideband codec, the fixed codebook is implemented using an algebraic codebook. + +**fractional lags:** A set of lag values having sub-sample resolution. In the adaptive multi-rate wideband codec a sub-sample resolution of 1/4th or 1/2nd of a sample is used. + +**frame:** A time interval equal to 20 ms (320 samples at an 16 kHz sampling rate). + +**Immittance Spectral Frequencies:** (see Immittance Spectral Pair) + +**Immittance Spectral Pair:** Transformation of LPC parameters. Immittance Spectral Pairs are obtained by decomposing the inverse filter transfer function $A(z)$ to a set of two transfer functions, one having even symmetry and the other having odd symmetry. The Immittance Spectral Pairs (also called as Immittance Spectral Frequencies) are the roots of these polynomials on the z-unit circle. + +**integer lags:** A set of lag values having whole sample resolution. + +**interpolating filter:** An FIR filter used to produce an estimate of sub-sample resolution samples, given an input sampled with integer sample resolution. In this implementation, the interpolating filter has low pass filter characteristics. Thus the adaptive codebook consists of the low-pass filtered interpolated past excitation. + +**inverse filter:** This filter removes the short term correlation from the speech signal. The filter models an inverse frequency response of the vocal tract. + +**lag:** The long term filter delay. This is typically the true pitch period, or its multiple or sub-multiple. + +**LP analysis window:** For each frame, the short term filter coefficients are computed using the high pass filtered speech samples within the analysis window. In the adaptive multi-rate wideband codec, the length of the analysis window is always 384 samples. For all the modes, a single asymmetric window is used to generate a single set of LP coefficients. The 5 ms look-ahead is used in the analysis. + +**LP coefficients:** Linear Prediction (LP) coefficients (also referred as Linear Predictive Coding (LPC) coefficients) is a generic descriptive term for the short term filter coefficients. + +**mode:** When used alone, refers to the source codec mode, i.e., to one of the source codecs employed in the AMR-WB codec. + +**open-loop pitch search:** A process of estimating the near optimal lag directly from the weighted speech input. This is done to simplify the pitch analysis and confine the closed-loop pitch search to a small number of lags around the open-loop estimated lags. In the adaptive multi-rate wideband codec, an open-loop pitch search is performed in every other subframe. + +**residual:** The output signal resulting from an inverse filtering operation. + +**short term synthesis filter:** This filter introduces, into the excitation signal, short term correlation which models the impulse response of the vocal tract. + +**perceptual weighting filter:** This filter is employed in the analysis-by-synthesis search of the codebooks. The filter exploits the noise masking properties of the formants (vocal tract resonances) by weighting the error less in regions near the formant frequencies and more in regions away from them. + +**subframe:** A time interval equal to 5 ms (80 samples at 16 kHz sampling rate). + +**vector quantization:** A method of grouping several parameters into a vector and quantizing them simultaneously. + +**zero input response:** The output of a filter due to past inputs, i.e. due to the present state of the filter, given that an input of zeros is applied. + +**zero state response:** The output of a filter due to the present input, given that no past inputs have been applied, i.e., given that the state information in the filter is all zeroes. + +## 3.2 Symbols + +For the purposes of this TS, the following symbols apply: + +| | | +|-------------------------------|---------------------------------------------------------------------------------------| +| $A(z)$ | The inverse filter with unquantized coefficients | +| $\hat{A}(z)$ | The inverse filter with quantized coefficients | +| $H(z) = \frac{1}{\hat{A}(z)}$ | The speech synthesis filter with quantized coefficients | +| $a_i$ | The unquantized linear prediction parameters (direct form coefficients) | +| $\hat{a}_i$ | The quantified linear prediction parameters | +| $m$ | The order of the LP model | +| $W(z)$ | The perceptual weighting filter (unquantized coefficients) | +| $\gamma_1$ | The perceptual weighting factor | +| $T$ | The integer pitch lag nearest to the closed-loop fractional pitch lag of the subframe | +| $\beta$ | The adaptive pre-filter coefficient (the quantified pitch gain) | +| $H_{hl}(z)$ | Pre-processing high-pass filter | +| $w(n)$ | LP analysis window | +| $L_1$ | Length of the first part of the LP analysis window $w(n)$ | +| $L_2$ | Length of the second part of the LP analysis window $w(n)$ | +| $r(k)$ | The auto-correlations of the windowed speech $s'(n)$ | +| $w_{lag}(i)$ | Lag window for the auto-correlations (60 Hz bandwidth expansion) | +| $f_0$ | The bandwidth expansion in Hz | +| $f_s$ | The sampling frequency in Hz | +| $r'(k)$ | The modified (bandwidth expanded) auto-correlations | +| $E(i)$ | The prediction error in the $i$ th iteration of the Levinson algorithm | +| $k_i$ | The $i$ th reflection coefficient | +| $a_j^{(i)}$ | The $j$ th direct form coefficient in the $i$ th iteration of the Levinson algorithm | +| $F_1'(z)$ | Symmetric ISF polynomial | +| $F_2'(z)$ | Antisymmetric ISF polynomial | +| $F_1(z)$ | Polynomial $F_1'(z)$ | +| $F_2(z)$ | Polynomial $F_2'(z)$ with roots $z = 1$ and $z = -1$ eliminated | + +| | | +|-----------------------------------------|---------------------------------------------------------------------------------------| +| $q_i$ | The immittance spectral pairs (ISPs) in the cosine domain | +| $\mathbf{q}$ | An ISP vector in the cosine domain | +| $\hat{\mathbf{q}}_i^{(n)}$ | The quantified ISP vector at the $i$ th subframe of the frame $n$ | +| $\omega_i$ | The immittance spectral frequencies (ISFs) | +| $T_m(x)$ | A $m$ th order Chebyshev polynomial | +| $f_1(i), f_2(i)$ | The coefficients of the polynomials $F_1(z)$ and $F_2(z)$ | +| $f_1'(i), f_2'(i)$ | The coefficients of the polynomials $F_1'(z)$ and $F_2'(z)$ | +| $f(i)$ | The coefficients of either $F_1(z)$ or $F_2(z)$ | +| $C(x)$ | Sum polynomial of the Chebyshev polynomials | +| $x$ | Cosine of angular frequency $\omega$ | +| $\lambda_k$ | Recursion coefficients for the Chebyshev polynomial evaluation | +| $f_i$ | The immittance spectral frequencies (ISFs) in Hz | +| $\mathbf{f}^t = [f_1 f_2 \dots f_{16}]$ | The vector representation of the ISFs in Hz | +| $\mathbf{z}(n)$ | The mean-removed ISF vector at frame $n$ | +| $\mathbf{r}(n)$ | The ISF prediction residual vector at frame $n$ | +| $\mathbf{p}(n)$ | The predicted ISF vector at frame $n$ | +| $\hat{\mathbf{r}}(n-1)$ | The quantified residual vector at the past frame | +| $\hat{\mathbf{r}}_i^k$ | The quantified ISF subvector $i$ at quantization index $k$ | +| $d_i$ | The distance between the immittance spectral frequencies $f_{i+1}$ and $f_{i-1}$ | +| $h(n)$ | The impulse response of the weighted synthesis filter | +| $H(z)W(z)$ | The weighted synthesis filter | +| $T_l$ | The integer nearest to the fractional pitch lag of the previous (1st or 3rd) subframe | +| $s'(n)$ | The windowed speech signal | +| $s_w(n)$ | The weighted speech signal | +| $\hat{s}(n)$ | Reconstructed speech signal | +| $x(n)$ | The target signal for adaptive codebook search | +| $x_2(n), \mathbf{x}_2^t$ | The target signal for algebraic codebook search | + +| | | +|------------------------------------------|---------------------------------------------------------------------------------------------------------------------| +| $res_{LP}(n)$ | The LP residual signal | +| $c(n)$ | The fixed codebook vector | +| $v(n)$ | The adaptive codebook vector | +| $y(n) = v(n)*h(n)$ | The filtered adaptive codebook vector | +| $y_k(n)$ | The past filtered excitation | +| $u(n)$ | The excitation signal | +| $\hat{u}'(n)$ | The gain-scaled emphasized excitation signal | +| $T_{op}$ | The best open-loop lag | +| $t_{min}$ | Minimum lag search value | +| $t_{max}$ | Maximum lag search value | +| $R(k)$ | Correlation term to be maximized in the adaptive codebook search | +| $R(k)_t$ | The interpolated value of $R(k)$ for the integer delay $k$ and fraction $t$ | +| $A_k$ | Correlation term to be maximized in the algebraic codebook search at index $k$ | +| $C_k$ | The correlation in the numerator of $A_k$ at index $k$ | +| $E_{Dk}$ | The energy in the denominator of $A_k$ at index $k$ | +| $\mathbf{d} = \mathbf{H}^t \mathbf{x}_2$ | The correlation between the target signal $x_2(n)$ and the impulse response $h(n)$ , i.e., backward filtered target | +| $\mathbf{H}$ | The lower triangular Toeplitz convolution matrix with diagonal $h(0)$ and lower diagonals $h(1), \dots, h(63)$ | +| $\Phi = \mathbf{H}^t \mathbf{H}$ | The matrix of correlations of $h(n)$ | +| $d(n)$ | The elements of the vector $\mathbf{d}$ | +| $\phi(i, j)$ | The elements of the symmetric matrix $\Phi$ | +| $\mathbf{c}_k$ | The innovation vector | +| $C$ | The correlation in the numerator of $A_k$ | +| $m_i$ | The position of the $i$ th pulse | +| $\mathcal{G}_i$ | The amplitude of the $i$ th pulse | +| $N_p$ | The number of pulses in the fixed codebook excitation | + +| | | +|----------------------------|-------------------------------------------------------------------------| +| $E_D$ | The energy in the denominator of $A_k$ | +| $res_{LTP}(n)$ | The normalized long-term prediction residual | +| $b(n)$ | The signal used for presetting the signs in algebraic codebook search | +| $s_b(n)$ | The sign signal for the algebraic codebook search | +| $d'(n)$ | Sign extended backward filtered target | +| $\phi'(i,j)$ | The modified elements of the matrix $\Phi$ , including sign information | +| $z^t, z(n)$ | The fixed codebook vector convolved with $h(n)$ | +| $E(n)$ | The mean-removed innovation energy (in dB) | +| $\bar{E}$ | The mean of the innovation energy | +| $\tilde{E}(n)$ | The predicted energy | +| $[b_1 b_2 b_3 b_4]$ | The MA prediction coefficients | +| $\hat{R}(k)$ | The quantified prediction error at subframe $k$ | +| $E_I$ | The mean innovation energy | +| $R(n)$ | The prediction error of the fixed-codebook gain quantization | +| $E_Q$ | The quantization error of the fixed-codebook gain quantization | +| $e(n)$ | The states of the synthesis filter $1/\hat{A}(z)$ | +| $e_w(n)$ | The perceptually weighted error of the analysis-by-synthesis search | +| $\eta$ | The gain scaling factor for the emphasized excitation | +| $g_c$ | The fixed-codebook gain | +| $g'_c$ | The predicted fixed-codebook gain | +| $\hat{g}_c$ | The quantified fixed codebook gain | +| $g_p$ | The adaptive codebook gain | +| $\hat{g}_p$ | The quantified adaptive codebook gain | +| $\gamma_{gc} = g_c / g'_c$ | A correction factor between the gain $g_c$ and the estimated one $g'_c$ | +| $\hat{\gamma}_{gc}$ | The optimum value for $\gamma_{gc}$ | +| $\gamma_{sc}$ | Gain scaling factor | + +## 3.3 Abbreviations + +For the purposes of this TS, the following abbreviations apply. + +| | | +|------------|-----------------------------------------------| +| ACELP | Algebraic Code Excited Linear Prediction | +| AGC | Adaptive Gain Control | +| AMR | Adaptive Multi-Rate | +| AMR-WB | Adaptive Multi-Rate Wideband | +| CELP | Code Excited Linear Prediction | +| FIR | Finite Impulse Response | +| ISF | Immittance Spectral Frequency | +| ISP | Immittance Spectral Pair | +| ISPP | Interleaved Single-Pulse Permutation | +| LP | Linear Prediction | +| LPC | Linear Predictive Coding | +| LTP | Long Term Predictor (or Long Term Prediction) | +| MA | Moving Average | +| MRWB-ACELP | Wideband Multi-Rate ACELP | +| S-MSVQ | Split-MultiStage Vector Quantization | +| WB | Wideband | + +# --- 4 Outline description + +This TS is structured as follows: + +Section 4.1 contains a functional description of the audio parts including the A/D and D/A functions. Section 4.2 describes input format for the AMR-WB encoder and the output format for the AMR-WB decoder. Sections 4.3 and 4.4 present a simplified description of the principles of the AMR-WB codec encoding and decoding process respectively. In subclause 4.5, the sequence and subjective importance of encoded parameters are given. + +Section 5 presents the functional description of the AMR-WB codec encoding, whereas clause 6 describes the decoding procedures. In section 7, the detailed bit allocation of the AMR-WB codec is tabulated. Section 8 describes the homing operation. + +## 4.1 Functional description of audio parts + +The analogue-to-digital and digital-to-analogue conversion will in principle comprise the following elements: + +### 1) Analogue to uniform digital PCM + +- microphone; +- input level adjustment device; +- input anti-aliasing filter; +- sample-hold device sampling at 16 kHz; +- analogue-to-uniform digital conversion to 14-bit representation. + +The uniform format shall be represented in two's complement. + +### 2) Uniform digital PCM to analogue + +- conversion from 14-bit/16 kHz uniform PCM to analogue; +- a hold device; +- reconstruction filter including $x/\sin(x)$ correction; +- output level adjustment device; + +- earphone or loudspeaker. + +In the terminal equipment, the A/D function may be achieved + +- by direct conversion to 14-bit uniform PCM format; + +For the D/A operation, the inverse operations take place. + +## 4.2 Preparation of speech samples + +The encoder is fed with data comprising of samples with a resolution of 14 bits left justified in a 16-bit word. The decoder outputs data in the same format. Outside the speech codec further processing must be applied if the traffic data occurs in a different representation. + +## 4.3 Principles of the adaptive multi-rate wideband speech encoder + +The AMR-WB codec consists of nine source codecs with bit-rates of 23.85, 23.05, 19.85, 18.25, 15.85, 14.25, 12.65, 8.85 and 6.60 kbit/s. + +The codec is based on the code-excited linear predictive (CELP) coding model. The input signal is pre-emphasized using the filter $H_{pre-emph}(z) = 1 - \mu z^{-1}$ . The CELP model is then applied to the pre-emphasized signal. A 16th order linear prediction (LP), or short-term, synthesis filter is used which is given by: + +$$H(z) = \frac{1}{\hat{A}(z)} = \frac{1}{1 + \sum_{i=1}^m \hat{a}_i z^{-i}}, \quad (1)$$ + +where $\hat{a}_i, i=1, \dots, m$ are the (quantized) linear prediction (LP) parameters, and $m = 16$ is the predictor order. The long-term, or pitch, synthesis filter is usually given by: + +$$\frac{1}{B(z)} = \frac{1}{1 - g_p z^{-T}}, \quad (2)$$ + +where $T$ is the pitch delay and $g_p$ is the pitch gain. The pitch synthesis filter is implemented using the so-called adaptive codebook approach. + +The CELP speech synthesis model is shown in Figure 1. In this model, the excitation signal at the input of the short-term LP synthesis filter is constructed by adding two excitation vectors from adaptive and fixed (innovative) codebooks. The speech is synthesized by feeding the two properly chosen vectors from these codebooks through the short-term synthesis filter. The optimum excitation sequence in a codebook is chosen using an analysis-by-synthesis search procedure in which the error between the original and synthesized speech is minimized according to a perceptually weighted distortion measure. + +The perceptual weighting filter used in the analysis-by-synthesis search technique is given by: + +$$W(z) = A(z/\gamma_1)H_{de-emph}(z), \quad (3)$$ + +where $A(z)$ is the unquantized LP filter, $H_{de-emph} = \frac{1}{1 - 0.68z^{-1}}$ , and $\gamma_1 = 0.92$ is the perceptual weighting factor. The weighting filter uses the unquantized LP parameters. + +The encoder performs the analysis of the LPC, LTP and fixed codebook parameters at 12.8 kHz sampling rate. The coder operates on speech frames of 20 ms. At each frame, the speech signal is analysed to extract the parameters of the CELP model (LP filter coefficients, adaptive and fixed codebooks' indices and gains). In addition to these parameters, high-band gain indices are computed in 23.85 kbit/s mode. These parameters are encoded and transmitted. At the decoder, these parameters are decoded and speech is synthesized by filtering the reconstructed excitation signal through the LP synthesis filter. + +The signal flow at the encoder is shown in Figure 2. After decimation, high-pass and pre-emphasis filtering is performed. LP analysis is performed once per frame. The set of LP parameters is converted to immittance spectrum pairs (ISP) and vector quantized using split-multistage vector quantization (S-MSVQ). The speech frame is divided into 4 subframes of 5 ms each (64 samples at 12.8 kHz sampling rate). The adaptive and fixed codebook parameters are transmitted every subframe. The quantized and unquantized LP parameters or their interpolated versions are used depending on the subframe. An open-loop pitch lag is estimated in every other subframe or once per frame based on the perceptually weighted speech signal. + +Then the following operations are repeated for each subframe: + +- The target signal $x(n)$ is computed by filtering the LP residual through the weighted synthesis filter $W(z)H(z)$ with the initial states of the filters having been updated by filtering the error between LP residual and excitation (this is equivalent to the common approach of subtracting the zero input response of the weighted synthesis filter from the weighted speech signal). +- The impulse response, $h(n)$ of the weighted synthesis filter is computed. +- Closed-loop pitch analysis is then performed (to find the pitch lag and gain), using the target $x(n)$ and impulse response $h(n)$ , by searching around the open-loop pitch lag. Fractional pitch with 1/4th or 1/2nd of a sample resolution (depending on the mode and the pitch lag value) is used. The interpolating filter in fractional pitch search has low pass frequency response. Further, there are two potential low-pass characteristics in the the adaptive codebook and this information is encoded with 1 bit. +- The target signal $x(n)$ is updated by removing the adaptive codebook contribution (filtered adaptive codevector), and this new target, $x_2(n)$ , is used in the fixed algebraic codebook search (to find the optimum innovation). +- The gains of the adaptive and fixed codebook are vector quantified with 6 or 7 bits (with moving average (MA) prediction applied to the fixed codebook gain). +- Finally, the filter memories are updated (using the determined excitation signal) for finding the target signal in the next subframe. + +The bit allocation of the AMR-WB codec modes is shown in Table 1. In each 20 ms speech frame, 132, 177, 253, 285, 317, 365, 397, 461 and 477 bits are produced, corresponding to a bit-rate of 6.60, 8.85 ,12.65, 14.25, 15.85, 18.25, 19.85, 23.05 or 23.85 kbit/s. More detailed bit allocation among the codec parameters is given in tables 12a-12i. Note that the most significant bits (MSB) are always sent first. + +Table 1: Bit allocation of the AMR-WB coding algorithm for 20 ms frame + +| Mode | Parameter | 1st subframe | 2nd subframe | 3rd subframe | 4th subframe | total per frame | +|--------------|----------------|--------------|--------------|--------------|--------------|-----------------| +| 23.85 kbit/s | VAD-flag | | | | | 1 | +| | ISP | | | | | 46 | +| | LTP-filtering | 1 | 1 | 1 | 1 | 4 | +| | Pitch delay | 9 | 6 | 9 | 6 | 30 | +| | Algebraic code | 88 | 88 | 88 | 88 | 352 | +| | Codebook gain | 7 | 7 | 7 | 7 | 28 | +| | HB-energy | 4 | 4 | 4 | 4 | 16 | +| | Total | | | | | 477 | +| 23.05 kbit/s | VAD-flag | | | | | 1 | +| | ISP | | | | | 46 | +| | LTP-filtering | 1 | 1 | 1 | 1 | 4 | +| | Pitch delay | 9 | 6 | 9 | 6 | 30 | +| | Algebraic code | 88 | 88 | 88 | 88 | 352 | +| | Gains | 7 | 7 | 7 | 7 | 28 | +| | Total | | | | | 461 | +| 19.85 kbit/s | VAD-flag | | | | | 1 | +| | ISP | | | | | 46 | +| | LTP-filtering | 1 | 1 | 1 | 1 | 4 | +| | Pitch delay | 9 | 6 | 9 | 6 | 30 | +| | Algebraic code | 72 | 72 | 72 | 72 | 288 | +| | Codebook gain | 7 | 7 | 7 | 7 | 28 | +| | Total | | | | | 397 | +| 18.25 kbit/s | VAD-flag | | | | | 1 | +| | ISP | | | | | 46 | +| | LTP-filtering | 1 | 1 | 1 | 1 | 4 | +| | Pitch delay | 9 | 6 | 9 | 6 | 30 | +| | Algebraic code | 64 | 64 | 64 | 64 | 256 | +| | Gains | 7 | 7 | 7 | 7 | 28 | +| | Total | | | | | 365 | +| 15.85 kbit/s | VAD-flag | | | | | 1 | +| | ISP | | | | | 46 | +| | LTP-filtering | 1 | 1 | 1 | 1 | 4 | +| | Pitch delay | 9 | 6 | 9 | 6 | 30 | +| | Algebraic code | 52 | 52 | 52 | 52 | 208 | +| | Gains | 7 | 7 | 7 | 7 | 28 | +| | Total | | | | | 317 | +| 14.25 kbit/s | VAD-flag | | | | | 1 | +| | ISP | | | | | 46 | +| | LTP-filtering | 1 | 1 | 1 | 1 | 4 | +| | Pitch delay | 9 | 6 | 9 | 6 | 30 | +| | Algebraic code | 44 | 44 | 44 | 44 | 176 | +| | Gains | 7 | 7 | 7 | 7 | 28 | +| | Total | | | | | 285 | +| 12.65 kbit/s | VAD-flag | | | | | 1 | +| | ISP | | | | | 46 | +| | LTP-filtering | 1 | 1 | 1 | 1 | 4 | +| | Pitch delay | 9 | 6 | 9 | 6 | 30 | +| | Algebraic code | 36 | 36 | 36 | 36 | 144 | +| | Gains | 7 | 7 | 7 | 7 | 28 | +| | Total | | | | | 253 | +| 8.85 kbit/s | VAD-flag | | | | | 1 | +| | ISP | | | | | 46 | +| | Pitch delay | 8 | 5 | 8 | 5 | 26 | +| | Algebraic code | 20 | 20 | 20 | 20 | 80 | +| | Gains | 6 | 6 | 6 | 6 | 24 | +| | Total | | | | | 177 | +| 6.60 kbit/s | VAD-flag | | | | | 1 | +| | ISP | | | | | 36 | +| | Pitch delay | 8 | 5 | 5 | 5 | 23 | +| | Algebraic code | 12 | 12 | 12 | 12 | 48 | +| | Gains | 6 | 6 | 6 | 6 | 24 | +| | Total | | | | | 132 | + +## 4.4 Principles of the adaptive multi-rate speech decoder + +The signal flow at the decoder is shown in Figure 3. At the decoder, the transmitted indices are extracted from the received bitstream. The indices are decoded to obtain the coder parameters at each transmission frame. These parameters are the ISP vector, the 4 fractional pitch lags, the 4 LTP filtering parameters, the 4 innovative codevectors, and the 4 sets of vector quantized pitch and innovative gains. In 23.85 kbit/s mode, also high-band gain index is decoded. The ISP vector is converted to the LP filter coefficients and interpolated to obtain LP filters at each subframe. Then, at each 64-sample subframe: + +- The excitation is constructed by adding the adaptive and innovative codevectors scaled by their respective gains. +- The 12.8 kHz speech is reconstructed by filtering the excitation through the LP synthesis filter. +- The reconstructed speech is de-emphasized. + +Finally, the reconstructed speech is upsampled to 16 kHz and high-band speech signal is added to the frequency band from 6 kHz to 7 kHz. + +## 4.5 Sequence and subjective importance of encoded parameters + +The encoder will produce the output information in a unique sequence and format, and the decoder must receive the same information in the same way. In table 12a-12i, the sequence of output bits and the bit allocation for each parameter is shown. + +The different parameters of the encoded speech and their individual bits have unequal importance with respect to subjective quality. The output and input frame formats for the AMR wideband speech codec are given in [2], where a reordering of bits take place. + +# --- 5 Functional description of the encoder + +In this clause, the different functions of the encoder represented in Figure 2 are described. + +## 5.1 Pre-processing + +The encoder performs the analysis of the LPC, LTP and fixed codebook parameters at 12.8 kHz sampling rate. Therefore, the input signal has to be decimated from 16 kHz to 12.8 kHz. The decimation is performed by first upsampling by 4, then filtering the output through lowpass FIR filter $H_{decim}(z)$ that has the cut off frequency at 6.4 kHz. Then, the signal is downsampled by 5. The filtering delay is compensated by adding zeroes into the end of the input vector. + +After the decimation, two pre-processing functions are applied to the signal prior to the encoding process: high-pass filtering and pre-emphasizing (and signal down-scaling). + +(Down-scaling consists of dividing the input by a factor of 2 to reduce the possibility of overflows in the fixed-point implementation.) + +The high-pass filter serves as a precaution against undesired low frequency components. A filter at a cut off frequency of 50 Hz is used, and it is given by + +$$H_{hp}(z) = \frac{0.989502 - 1.979004 z^{-1} + 0.989502 z^{-2}}{1 - 1.978882 z^{-1} + 0.979126 z^{-2}}. \quad (4)$$ + +(Both down-scaling and high-pass filtering are combined by dividing the coefficients at the numerator of $H_{hp}(z)$ by 2.) + +In the pre-emphasis, a first order high-pass filter is used to emphasize higher frequencies, and it is given by + +$$H_{pre-emph}(z) = 1 - 0.68z^{-1} \quad (5)$$ + +## 5.2 Linear prediction analysis and quantization + +Short-term prediction, or LP, analysis is performed once per speech frame using the autocorrelation approach with 30 ms asymmetric windows. An overhead of 5 ms is used in the autocorrelation computation. The frame structure is depicted below. + +![Diagram of frame structure showing overlapping windows. A horizontal bar represents a frame, divided into 4 subframes of 5 ms each (labeled 'frame n (4 x 5 ms)'). A dashed box labeled 'windowing frame n-1' starts at the beginning of the frame. A solid box labeled 'windowing frame n' starts at the beginning of the third subframe and ends at the end of the frame. The third subframe is shaded gray.](33a8f3f01dfa8bce75d23017855a13c5_img.jpg) + +Diagram of frame structure showing overlapping windows. A horizontal bar represents a frame, divided into 4 subframes of 5 ms each (labeled 'frame n (4 x 5 ms)'). A dashed box labeled 'windowing frame n-1' starts at the beginning of the frame. A solid box labeled 'windowing frame n' starts at the beginning of the third subframe and ends at the end of the frame. The third subframe is shaded gray. + +The autocorrelations of windowed speech are converted to the LP coefficients using the Levinson-Durbin algorithm. Then the LP coefficients are transformed to the ISP domain for quantization and interpolation purposes. The interpolated quantized and unquantized filters are converted back to the LP filter coefficients (to construct the synthesis and weighting filters at each subframe). + +### 5.2.1 Windowing and auto-correlation computation + +LP analysis is performed once per frame using an asymmetric window. The window has its weight concentrated at the fourth subframe and it consists of two parts: the first part is a half of a Hamming window and the second part is a quarter of a Hamming-cosine function cycle. The window is given by: + +$$\begin{aligned} w(n) &= 0.54 - 0.46 \cos\left(\frac{2\pi n}{2L_1 - 1}\right), & n &= 0, \dots, L_1 - 1, \\ &= \cos\left(\frac{2\pi(n - L_1)}{4L_2 - 1}\right), & n &= L_1, \dots, L_1 + L_2 - 1 \end{aligned} \quad (6)$$ + +where the values $L_1=256$ and $L_2=128$ are used. + +The autocorrelations of the windowed speech $s'(n), n=0, \dots, 383$ are computed by + +$$r(k) = \sum_{n=k}^{383} s'(n)s'(n-k), \quad k = 0, \dots, 16, \quad (7)$$ + +and a 60 Hz bandwidth expansion is used by lag windowing the autocorrelations using the window [2] + +$$w_{lag}(i) = \exp\left[-\frac{1}{2}\left(\frac{2\pi f_0 i}{f_s}\right)^2\right], \quad i = 1, \dots, 16, \quad (8)$$ + +where $f_0=60$ Hz is the bandwidth expansion and $f_s=12800$ Hz is the sampling frequency. Further, $r(0)$ is multiplied by the white noise correction factor 1.0001 which is equivalent to adding a noise floor at -40 dB. + +### 5.2.2 Levinson-Durbin algorithm + +The modified autocorrelations $r'(0) = 1.0001r(0)$ and $r'(k) = r(k)w_{lag}(k), k = 1, \dots, 16$ , are used to obtain the LP filter coefficients $a_k, k=1, \dots, 16$ by solving the set of equations. + +$$\sum_{k=1}^{16} a_k r'(|i-k|) = -r'(i), \quad i = 1, \dots, 16. \quad (9)$$ + +The set of equations in (9) is solved using the Levinson-Durbin algorithm [2]. This algorithm uses the following recursion: + +$$\begin{aligned} +E(0) &= r'(0) \\ +\text{For } i &= 1 \text{ to } 16 \text{ do} \\ +k_i &= -\left[ r'(i) + \sum_{j=1}^{i-1} a_j^{(i-1)} r'(i-j) \right] / E(i-1) \\ +a_i^{(i)} &= k_i \\ +\text{For } j &= 1 \text{ to } i-1 \text{ do} \\ +a_j^{(i)} &= a_j^{(i-1)} + k_i a_{i-j}^{(i-1)} \\ +E(i) &= (1 - k_i^2) E(i-1) +\end{aligned}$$ + +The final solution is given as $a_j = a_j^{(16)}$ , $j=1, \dots, 16$ . + +The LP filter coefficients are converted to the ISP representation [4] for quantization and interpolation purposes. The conversions to the ISP domain and back to the LP filter domain are described in the next two sections. + +### 5.2.3 LP to ISP conversion + +The LP filter coefficients $a_k$ , $k=1, \dots, 16$ , are converted to the ISP representation for quantization and interpolation purposes. For a 16th order LP filter, the ISPs are defined as the roots of the sum and difference polynomials + +$$f_1'(z) = A(z) + z^{-16} A(z^{-1}) \quad (10)$$ + +and + +$$f_2'(z) = A(z) - z^{-16} A(z^{-1}) \quad (11)$$ + +respectively. (The polynomials $f_1'(z)$ and $f_2'(z)$ are symmetric and antisymmetric, respectively). It can be proven that all roots of these polynomials are on the unit circle and they alternate each other [5]. $f_2'(z)$ has two roots at $z = 1$ ( $\omega=0$ ) and $z = -1$ ( $\omega = \pi$ ). To eliminate these two roots, we define the new polynomials + +$$f_1(z) = f_1'(z) \quad (12)$$ + +and + +$$f_2(z) = f_2'(z)/(1-z^{-2}). \quad (13)$$ + +Polynomials $f_1(z)$ and $f_2(z)$ have 8 and 7 conjugate roots on the unit circle $(e^{\pm j\omega_i})$ respectively. Therefore, the polynomials can be written as + +$$F_1(z) = (1 + a[16]) \prod_{i=0,2,\dots,14} (1 - 2q_i z^{-1} + z^{-2}) \quad (14)$$ + +and + +$$F_2(z) = (1 - a[16]) \prod_{i=1,3,\dots,13} (1 - 2q_i z^{-1} + z^{-2}) \quad (15)$$ + +where $q_i = \cos(\omega_i)$ with $\omega_i$ being the immittance spectral frequencies (ISF) and $a[16]$ is the last predictor coefficient. ISFs satisfy the ordering property $0 < \omega_1 < \omega_2 < \dots < \omega_{16} < \pi$ . We refer to $q_i$ as the ISPs in the cosine domain. + +Since both polynomials $f_1(z)$ and $f_2(z)$ are symmetric only the first 8 and 7 coefficients of each polynomial, respectively, and the last predictor coefficient need to be computed. + +The coefficients of these polynomials are found by the recursive relations + +for $i=0$ to 7 + +$$\begin{aligned} f_1(i) &= a_i + a_{m-i}, \\ f_2(i) &= a_i - a_{m-i} + f_2(i-2). \\ f_1(8) &= 2a_8 \end{aligned} \quad (16)$$ + +where $m=16$ is the predictor order, and $f_2(-2) = f_2(-1) = 0$ . + +The ISPs are found by evaluating the polynomials $F_1(z)$ and $F_2(z)$ at 100 points equally spaced between 0 and $\pi$ and checking for sign changes. A sign change signifies the existence of a root and the sign change interval is then divided 4 times to better track the root. The Chebyshev polynomials are used to evaluate $F_1(z)$ and $F_2(z)$ [6]. In this method the roots are found directly in the cosine domain $\{q_i\}$ . The polynomials $F_1(z)$ and $F_2(z)$ evaluated at $z = e^{j\omega}$ can be written as + +$$F_1(\omega) = 2e^{-j8\omega}C_1(x) \text{ and } F_2(\omega) = 2e^{-j7\omega}C_2(x) \quad (17)$$ + +with + +$$C_1(x) = \sum_{i=0}^7 f_1(i)T_{8-i}(x) + f_1(8)/2, \text{ and } C_2(x) = \sum_{i=0}^6 f_2(i)T_{8-i}(x) + f_2(7)/2, \quad (18)$$ + +where $T_m = \cos(m\omega)$ is the $m$ th order Chebyshev polynomial, $f(i)$ are the coefficients of either $F_1(z)$ or $F_2(z)$ , computed using the equations in (16). The polynomial $C(x)$ is evaluated at a certain value of $x = \cos(\omega)$ using the recursive relation: + +$$\begin{aligned} &\text{for } k = n_f - 1 \text{ down to } 1 \\ &\quad b_k = 2xb_{k+1} - b_{k+2} + f(n_f - k) \\ &\text{end} \\ &C(x) = xb_1 - b_2 + f(n_f)/2, \end{aligned}$$ + +where $n_f=8$ in case of $C_1(x)$ and $n_f=7$ in case of $C_2(x)$ , with initial values $b_{n_f}=f(0)$ and $b_{n_f+1}=0$ . The details of the Chebyshev polynomial evaluation method are found in [6]. + +### 5.2.4 ISP to LP conversion + +Once the ISPs are quantized and interpolated, they are converted back to the LP coefficient domain $\{a_k\}$ . The conversion to the LP domain is done as follows. The coefficients of $F_1(z)$ and $F_2(z)$ are found by expanding Equations (14) and (15) knowing the quantized and interpolated ISPs $q_i, i=0, \dots, m-1$ , where $m=16$ . The following recursive relation is used to compute $f_1(z)$ + +$$\begin{aligned} &\text{for } i = 2 \text{ to } m/2 \\ &\quad f_1(i) = -2q_{2i-2}f_1(i-1) + 2f_1(i-2) \\ &\quad \text{for } j = i-1 \text{ down to } 2 \\ &\quad \quad f_1(j) = f_1(j) - 2q_{2i-2}f_1(j-1) + f_1(j-2) \\ &\quad \text{end} \\ &\quad f_1(1) = f_1(1) - 2q_{2i-2} \\ &\text{end} \end{aligned}$$ + +with initial values $f_1(0)=1$ and $f_1(1)=-2q_0$ . The coefficients $f_2(i)$ are computed similarly by replacing $q_{2i-2}$ by $q_{2i-1}$ and $m/2$ by $m/2-1$ , and with initial conditions $f_2(0)=1$ and $f_2(1)=-2q_1$ . + +Once the coefficients $f_1(z)$ and $f_2(z)$ are found, $F_2(z)$ is multiplied by $1-z^{-2}$ , to obtain $F'_2(z)$ ; that is + +$$\begin{aligned} f'_2(i) &= f_2(i) - f_2(i-2), & i &= 2, \dots, m/2 - 1, \\ f'_1(i) &= f_1(i) & i &= 0, \dots, m/2 \end{aligned} \quad (19)$$ + +Then $F'_1(z)$ and $F'_2(z)$ are multiplied by $1+q_{m-1}$ and $1-q_{m-1}$ , respectively. That is + +$$\begin{aligned} f'_2(i) &= (1 - q_{m-1}) f'_2(i), & i &= 0, \dots, m/2 - 1, \\ f'_1(i) &= (1 + q_{m-1}) f'_1(i) & i &= 0, \dots, m/2 \end{aligned}$$ + +Finally the LP coefficients are found by + +$$\begin{aligned} a_i &= 0.5 f'_1(i) + 0.5 f'_2(i), & i &= 1, \dots, m/2 - 1, \\ &0.5 f'_1(i) - 0.5 f'_2(i), & i &= m/2 + 1, \dots, m - 1, \\ &0.5 f'_1(m/2), & i &= m/2, \\ &q_{m-1}, & i &= m. \end{aligned} \quad (20)$$ + +This is directly derived from the relation $A(z) = (F'_1(z) + F'_2(z))/2$ , and considering the fact that $F'_1(z)$ and $F'_2(z)$ are symmetric and antisymmetric polynomials, respectively. + +### 5.2.5 Quantization of the ISP coefficients + +The LP filter coefficients are quantized using the ISP representation in the frequency domain; that is + +$$\begin{aligned} f_i &= \frac{f_s}{2\pi} \arccos(q_i), & i &= 0, \dots, 14, \\ &= \frac{f_s}{4\pi} \arccos(q_i), & i &= 15, \end{aligned} \quad (21)$$ + +where $f_i$ are the ISFs in Hz [0,6400] and $f_s=12800$ is the sampling frequency. The ISF vector is given by $\mathbf{f}^t = [f_0, f_1, \dots, f_{15}]$ , with $t$ denoting transpose. + +A 1st order MA prediction is applied, and the residual ISF vector is quantified using a combination of split vector quantization (SVQ) and multi-stage vector quantization (MSVQ). The prediction and quantization are performed as follows. Let $\mathbf{z}(n)$ denote the mean-removed ISF vector at frame $n$ . The prediction residual vector $\mathbf{r}(n)$ is given by: + +$$\mathbf{r}(n) = \mathbf{z}(n) - \mathbf{p}(n) \quad (22)$$ + +where $\mathbf{p}(n)$ is the predicted LSF vector at frame $n$ . First order moving-average (MA) prediction is used where: + +$$\mathbf{p}(n) = \frac{1}{3} \hat{\mathbf{r}}(n-1), \quad (23)$$ + +where $\hat{\mathbf{r}}(n-1)$ is the quantized residual vector at the past frame. + +The ISF residual vector $\mathbf{r}$ is quantized using split-multistage vector quantization S-MSVQ. The vector is split into 2 subvectors $\mathbf{r}_1(n)$ and $\mathbf{r}_2(n)$ of dimensions 9 and 7, respectively. The 2 subvectors are quantized in two stages. In the first stage $\mathbf{r}_1(n)$ is quantized with 8 bits and $\mathbf{r}_2(n)$ with 8 bits. + +For 8.85, 12.65, 14.25, 15.85, 18.25, 19.85, 23.05 or 23.85 kbit/s modes, the quantization error vectors + +$\mathbf{r}_i^{(2)} = \mathbf{r}_i - \hat{\mathbf{r}}_i, i = 1, 2$ are split in the next stage into 3 and 2 subvectors, respectively. The subvectors are quantized using the bit-rates described in Table 2. + +**Table 2. Quantization of ISP vector for the 8.85 ,12.65, 14.25, 15.85, 18.25, 19.85, 23.05 or 23.85 kbit/s modes** + +| 1. UNQUANTIZED 16-ELEMENT-LONG ISP VECTOR | | | | | +|-------------------------------------------|------------------------------|------------------------------|------------------------------|------------------------------| +| 2. STAGE 1 ( $r_1$ ) 8 bits | | | 2. STAGE 1 ( $r_2$ ) 8 bits | | +| 3. STAGE 2 | 3. STAGE 2 | 3. STAGE 2 | 3. STAGE 2 | 3. STAGE 2 | +| $(\mathbf{r}^{(2)}_{1,0-2})$ | $(\mathbf{r}^{(2)}_{1,3-5})$ | $(\mathbf{r}^{(2)}_{1,6-8})$ | $(\mathbf{r}^{(2)}_{2,0-2})$ | $(\mathbf{r}^{(2)}_{2,3-6})$ | +| 6 bits | 7 bits | 7 bits | 5 bits | 5 bits | + +For 6.60 kbit/s mode, the quantization error vectors $\mathbf{r}_i^{(2)} = \mathbf{r}_i - \hat{\mathbf{r}}_i, i = 1, 2$ are split in the next stage into 2 and 1 subvectors, respectively. The subvectors are quantized using the bit-rates described in Table 3. + +**Table 3. Quantization of ISP vector for the 6.60 kbit/s mode** + +| 1. UNQUANTIZED 16-ELEMENT-LONG ISP VECTOR | | | +|-------------------------------------------|------------------------------|------------------------------| +| 2. STAGE 1 ( $r_1$ ) 8 bits | | 2. STAGE 1 ( $r_2$ ) 8 bits | +| 3. STAGE 2 | 3. STAGE 2 | 3. STAGE 2 | +| $(\mathbf{r}^{(2)}_{1,0-4})$ | $(\mathbf{r}^{(2)}_{1,5-8})$ | $(\mathbf{r}^{(2)}_{2,0-6})$ | +| 7 bits | 7 bits | 6 bits | + +A squared error ISP distortion measure is used in the quantization process. In general, for an input ISP or error residual subvector $\mathbf{r}_i, i=1,2$ and a quantized vector at index $k$ , $\hat{\mathbf{r}}_i^k$ , the quantization is performed by finding the index $k$ which minimizes + +$$E = \sum_{i=m}^n [r_i - \hat{r}_i^k]^2, \quad (24)$$ + +where $m$ and $n$ are the first and last elements of the subvector. + +### 5.2.6 Interpolation of the ISPs + +The set of quantized (and unquantized) LP parameters is used for the fourth subframe whereas the first, second, and third subframes use a linear interpolation of the parameters in the adjacent frames. The interpolation is performed on the ISPs in the $\mathbf{q}$ domain. Let $\hat{\mathbf{q}}_4^{(n)}$ be the ISP vector at the 4th subframe of the frame, and $\hat{\mathbf{q}}_4^{(n-1)}$ the ISP vector at the 4th subframe of the past frame $n-1$ . The interpolated ISP vectors at the 1st, 2nd, and 3rd subframes are given by + +$$\begin{aligned} \hat{\mathbf{q}}_1^{(n)} &= 0.55\hat{\mathbf{q}}_4^{(n-1)} + 0.45\hat{\mathbf{q}}_4^{(n)}, \\ \hat{\mathbf{q}}_2^{(n)} &= 0.2\hat{\mathbf{q}}_4^{(n-1)} + 0.8\hat{\mathbf{q}}_4^{(n)}, \\ \hat{\mathbf{q}}_3^{(n)} &= 0.04\hat{\mathbf{q}}_4^{(n-1)} + 0.96\hat{\mathbf{q}}_4^{(n)}. \end{aligned}$$ + +The same formula is used for interpolation of the unquantized ISPs. The interpolated ISP vectors are used to compute a different LP filter at each subframe (both quantized and unquantized) using the ISP to LP conversion method described in Section 5.2.4. + +## 5.3 Perceptual weighting + +The traditional perceptual weighting filter $W(z) = A(z/\gamma_1)/A(z/\gamma_2)$ has inherent limitations in modelling the formant structure and the required spectral tilt concurrently. The spectral tilt is more pronounced in wideband signals due to the wide dynamic range between low and high frequencies. A solution to this problem is to introduce the preemphasis filter at the input, compute the LP filter $A(z)$ based on the preemphasized speech $s(n)$ , and use a modified filter $W(z)$ by fixing its denominator. This structure substantially decouples the formant weighting from the tilt. + +A weighting filter of the form $W(z) = A(z/\gamma_1)H_{de-emph}(z)$ is used, where $H_{de-emph} = \frac{1}{1 - \beta_1 z^{-1}}$ and $\beta_1=0.68$ . + +Because $A(z)$ is computed based on the preemphasized speech signal $s(n)$ , the tilt of the filter $1/A(z/\gamma_1)$ is less pronounced compared to the case when $A(z)$ is computed based on the original speech. Since deemphasis is performed at the decoder end, it can be shown that the quantization error spectrum is shaped by a filter having a transfer function $W^{-1}(z)H_{de-emph}(z)=1/A(z/\gamma_1)$ . Thus, the spectrum of the quantization error is shaped by a filter whose transfer function is $1/A(z/\gamma_1)$ , with $A(z)$ computed based on the preemphasized speech signal. + +## 5.4 Open-loop pitch analysis + +Depending on the mode, open-loop pitch analysis is performed once per frame (each 10 ms) or twice per frame (each 10 ms) to find two estimates of the pitch lag in each frame. This is done in order to simplify the pitch analysis and confine the closed loop pitch search to a small number of lags around the open-loop estimated lags. + +Open-loop pitch estimation is based on the weighted speech signal $s_w(n)$ which is obtained by filtering the input speech signal through the weighting filter $W(z) = A(z/\gamma_1)H_{de-emph}(z)$ , where $H_{de-emph} = \frac{1}{1 - \beta_1 z^{-1}}$ and $\beta_1=0.68$ . That is, in a subframe of size $L$ , the weighted speech is given by + +$$s_w(n) = s(n) + \sum_{i=1}^{16} a_i \gamma_1^i s(n-i) + \beta_1 s_w(n-1), n = 0, \dots, L-1. \quad (25)$$ + +The open-loop pitch analysis is performed to a signal decimated by two. The decimated signal is obtained by filtering $s_w(n)$ through a fourth order FIR filter $H_{decim2}(z)$ and then downsampling the output by two to obtain the signal $s_{wd}(n)$ . + +### 5.4.1 6.60 kbit/s mode + +Open-loop pitch analysis is performed once per frame (every 20 ms) to find an estimate of the pitch lag in each frame. + +The open-loop pitch analysis is performed as follows. First, the correlation of decimated weighted speech is determined for each pitch lag value $d$ by: + +$$C(d) = \sum_{n=0}^{128} s_{wd}(n) s_{wd}(n-d) w(d), d = 17, \dots, 115, \quad (26)$$ + +where $w(d)$ is a weighting function. The estimated pitch-lag is the delay that maximises the weighted correlation function $C(d)$ . The weighting emphasises lower pitch lag values reducing the likelihood of selecting a multiple of the correct delay. The weighting function consists of two parts: a low pitch lag emphasis function, $w_l(d)$ , and a previous frame lag neighbouring emphasis function, $w_n(d)$ : + +$$w(d) = w_l(d) w_n(d). \quad (27)$$ + +The low pitch lag emphasis function is a given by: + +$$w_l(d) = cw(d) \quad (28)$$ + +where $cw(d)$ is defined by a table in the fixed point computational description. The previous frame lag neighbouring emphasis function depends on the pitch lag of previous speech frames: + +$$w_n(d) = \begin{cases} cw(|T_{old} - d| + 98), & v > 0.8, \\ 1.0, & \text{otherwise,} \end{cases} \quad (29)$$ + +where $T_{old}$ is the median filtered pitch lag of 5 previous voiced speech half-frames and $v$ is an adaptive parameter. If the frame is classified as voiced by having the open-loop gain $g > 0.6$ , then the $v$ -value is set to 1.0 for the next frame. Otherwise, the $v$ -value is updated by $v = 0.9v$ . The open loop gain is given by: + +$$g = \frac{\sum_{n=0}^{127} s_{wd}(n)s_{wd}(n - d_{max})}{\sqrt{\sum_{n=0}^{127} s_{wd}^2(n) \sum_{n=0}^{127} s_{wd}^2(n - d_{max})}} \quad (30)$$ + +where $d_{max}$ is the pitch delay that maximizes $C(d)$ . The median filter is updated only during voiced speech frames. The weighting depends on the reliability of the old pitch lags. If previous frames have contained unvoiced speech or silence, the weighting is attenuated through the parameter $v$ . + +### 5.4.2 8.85, 12.65, 14.25, 15.85, 18.25, 19.85, 23.05 and 23.85 kbit/s modes + +Open-loop pitch analysis is performed twice per frame (every 10 ms) to find two estimates of the pitch lag in each frame. + +The open-loop pitch analysis is performed as follows. First, the correlation of decimated weighted speech is determined for each pitch lag value $d$ by: + +$$C(d) = \sum_{n=0}^{63} s_{wd}(n)s_{wd}(n - d)w(d), d = 17, \dots, 115, \quad (31)$$ + +where $w(d)$ is a weighting function. The estimated pitch-lag is the delay that maximises the weighted correlation function $C(d)$ . The weighting emphasises lower pitch lag values reducing the likelihood of selecting a multiple of the correct delay. The weighting function consists of two parts: a low pitch lag emphasis function, $w_l(d)$ , and a previous frame lag neighbouring emphasis function, $w_n(d)$ : + +$$w(d) = w_l(d)w_n(d). \quad (32)$$ + +The low pitch lag emphasis function is given by: + +$$w_l(d) = cw(d) \quad (33)$$ + +where $cw(d)$ is defined by a table in the fixed point computational description. The previous frame lag neighbouring emphasis function depends on the pitch lag of previous speech frames: + +$$w_n(d) = \begin{cases} cw(|T_{old} - d| + 98), & v > 0.8, \\ 1.0, & \text{otherwise,} \end{cases} \quad (34)$$ + +where $T_{old}$ is the median filtered pitch lag of 5 previous voiced speech half-frames and $v$ is an adaptive parameter. If the frame is classified as voiced by having the open-loop gain $g > 0.6$ , then the $v$ -value is set to 1.0 for the next frame. Otherwise, the $v$ -value is updated by $v = 0.9v$ . The open loop gain is given by: + +$$g = \frac{\sum_{n=0}^{63} s_{wd}(n)s_{wd}(n - d_{max})}{\sqrt{\sum_{n=0}^{63} s_{wd}^2(n) \sum_{n=0}^{63} s_{wd}^2(n - d_{max})}} \quad (35)$$ + +where $d_{max}$ is the pitch delay that maximizes $C(d)$ . The median filter is updated only during voiced speech frames. The weighting depends on the reliability of the old pitch lags. If previous frames have contained unvoiced speech or silence, the weighting is attenuated through the parameter $v$ . + +## 5.5 Impulse response computation + +The impulse response, $h(n)$ , of the weighted synthesis filter $H(z)W(z) = A(z/\gamma_1)H_{de-emph}(z)/\hat{A}(z)$ is computed each subframe. This impulse response is needed for the search of adaptive and fixed codebooks. The impulse response $h(n)$ is computed by filtering the vector of coefficients of the filter $A(z/\gamma_1)$ extended by zeros through the two filters $1/\hat{A}(z)$ and $H_{de-emph}(z)$ . + +## 5.6 Target signal computation + +The target signal for adaptive codebook search is usually computed by subtracting the zero-input response of the weighted synthesis filter $H(z)W(z) = A(z/\gamma_1)H_{de-emph}(z)/\hat{A}(z)$ from the weighted speech signal $s_w(n)$ . This is performed on a subframe basis. + +An equivalent procedure for computing the target signal, which is used in this codec, is the filtering of the LP residual signal $r(n)$ through the combination of synthesis filter $1/\hat{A}(z)$ and the weighting filter $A(z/\gamma_1)H_{de-emph}(z)$ . After determining the excitation for the subframe, the initial states of these filters are updated by filtering the difference between the LP residual and excitation. The memory update of these filters is explained in Section 5.10. + +The residual signal $r(n)$ which is needed for finding the target vector is also used in the adaptive codebook search to extend the past excitation buffer. This simplifies the adaptive codebook search procedure for delays less than the subframe size of 64 as will be explained in the next section. The LP residual is given by + +$$r(n) = s(n) + \sum_{i=1}^{16} \hat{a}_i s(n-i), n = 0, \dots, 63. \quad (36)$$ + +## 5.7 Adaptive codebook + +Adaptive codebook search is performed on a subframe basis. It consists of performing closed loop pitch search, and then computing the adaptive codevector by interpolating the past excitation at the selected fractional pitch lag. + +The adaptive codebook parameters (or pitch parameters) are the delay and gain of the pitch filter. In the search stage, the excitation is extended by the LP residual to simplify the closed-loop search. + +In 12.65, 14.25, 15.85, 18.25, 19.85, 23.05 or 23.85 kbit/s modes, in the first and third subframes, a fractional pitch delay is used with resolutions $1/4$ in the range $[34, 127 \frac{3}{4}]$ , resolutions $1/2$ in the range $[128, 159 \frac{1}{2}]$ , and integers only in the range $[160, 231]$ . For the second and fourth subframes, a pitch resolution of $1/4$ is always used in the range $[T_1-8, T_1+7 \frac{3}{4}]$ , where $T_1$ is nearest integer to the fractional pitch lag of the previous (1st or 3rd) subframe. + +In 8.85 kbit/s mode, in the first and third subframes, a fractional pitch delay is used with resolutions $1/2$ in the range $[34, 91 \frac{1}{2}]$ , and integers only in the range $[92, 231]$ . For the second and fourth subframes, a pitch resolution of $1/2$ is always used in the range $[T_1-8, T_1+7 \frac{1}{2}]$ , where $T_1$ is nearest integer to the fractional pitch lag of the previous (1st or 3rd) subframe. + +In 6.60 kbit/s mode, in the first subframe, a fractional pitch delay is used with resolutions $1/2$ in the range $[34, 91 \frac{1}{2}]$ , and integers only in the range $[92, 231]$ . For the second, third and fourth subframes, a pitch resolution of $1/2$ is always used in the range $[T_1-8, T_1+7 \frac{1}{2}]$ , where $T_1$ is nearest integer to the fractional pitch lag of the first subframe. + +Closed-loop pitch analysis is performed around the open-loop pitch estimates on a subframe basis. In 8.85, 12.65, 14.25, 15.85, 18.25, 19.85, 23.05 or 23.85 kbit/s modes, in the first (and third) subframe the range $T_{op} \pm 7$ , bounded by + +34...231, is searched. In 6.60 kbit/s mode, in the first subframe the range $T_{op} \pm 7$ , bounded by 34...231, is searched. For all the modes, for the other subframes, closed-loop pitch analysis is performed around the integer pitch selected in the previous subframe, as described above. In 12.65, 14.25, 15.85, 18.25, 19.85, 23.05 or 23.85 kbit/s modes, the pitch delay is encoded with 9 bits in the first and third subframes and the relative delay of the other subframes is encoded with 6 bits. In 8.85 kbit/s mode, the pitch delay is encoded with 8 bits in the first and third subframes and the relative delay of the other subframes is encoded with 5 bits. In 6.60 kbit/s mode, the pitch delay is encoded with 8 bits in the first subframe and the relative delay of the other subframes is encoded with 5 bits. + +The closed loop pitch search is performed by minimizing the mean-square weighted error between the original and synthesized speech. This is achieved by maximizing the term + +$$T_k = \frac{\sum_{n=0}^{63} x(n)y_k(n)}{\sqrt{\sum_{n=0}^{63} y_k(n)y_k(n)}}, \quad (37)$$ + +where $x(n)$ is the target signal and $y_k(n)$ is the past filtered excitation at delay $k$ (past excitation convolved with $h(n)$ ). Note that the search range is limited around the open-loop pitch as explained earlier. + +The convolution $y_k(n)$ is computed for the first delay in the searched range, and for the other delays, it is updated using the recursive relation + +$$y_k(n) = y_{k-1}(n-1) + u(-k)h(n) \quad (38)$$ + +where $u(n), n = -(231+17), \dots, 63$ , is the excitation buffer. Note that in search stage, the samples $u(n), n = 0, \dots, 63$ , are not known, and they are needed for pitch delays less than 64. To simplify the search, the LP residual is copied to $u(n)$ in order to make the relation in Equation (38) valid for all delays. + +Once the optimum integer pitch delay is determined, the fractions from $-\frac{3}{4}$ to $\frac{3}{4}$ with a step of $\frac{1}{4}$ around that integer are tested. The fractional pitch search is performed by interpolating the normalized correlation in Equation (37) and searching for its maximum. Once the fractional pitch lag is determined, $v'(n)$ is computed by interpolating the past excitation signal $u(n)$ at the given phase (fraction). (The interpolation is performed using two FIR filters (Hamming windowed sinc functions); one for interpolating the term in Equation (34) with the sinc truncated at $\pm 17$ and the other for interpolating the past excitation with the sinc truncated at $\pm 63$ ). The filters have their cut-off frequency (-3 dB) at 6000 Hz in the oversampled domain, which means that the interpolation filters exhibit low-pass frequency response. Thus, even when the pitch delay is an integer value, the adaptive codebook excitation consists of a low-pass filtered version of the past excitation at the given delay and not a direct copy thereof. Further, for delays smaller than the subframe size, the adaptive codebook excitation is completed based on the low-pass filtered interpolated past excitation and not by repeating the past excitation. + +In order to enhance the pitch prediction performance in wideband signals, a frequency-dependant pitch predictor is used. This is important in wideband signals since the periodicity doesn't necessarily extend over the whole spectrum. In this algorithm, there are two signal paths associated to respective sets of pitch codebook parameters, wherein each signal path comprises a pitch prediction error calculating device for calculating a pitch prediction error of a pitch codevector from a pitch codebook search device. One of these two paths comprises a low-pass filter for filtering the pitch codevector and the pitch prediction error is calculated for these two signal paths. The signal path having the lowest calculated pitch prediction error is selected, along with the associated pitch gain. + +The low pass filter used in the second path is in the form $B_{LP}(z) = 0.18z + 0.64 + 0.18z^{-1}$ . Note that 1 bit is used to encode the chosen path. + +Thus, for 12.65, 14.25, 15.85, 18.25, 19.85, 23.05 or 23.85 kbit/s modes, there are two possibilities to generate the adaptive codebook $v(n)$ , $v(n) = v'(n)$ in the first path, or $v(n) = \sum_{i=-1}^1 b_{LP}(i+1)v'(n+i)$ in the second path, where + +$\mathbf{b}_{LP} = [0.18, 0.64, 0.18]$ . The path which results in minimum energy of the target signal $x_2(n)$ defined in Equation (40) is selected for the filtered adaptive codebook vector. For 6.60 and 8.85 kbit/s modes, $v(n)$ is always + +$$v(n) = \sum_{i=-1}^1 b_{LP}(i+1)v'(n+i).$$ + +The adaptive codebook gain is then found by + +$$g_p = \frac{\sum_{n=0}^{63} x(n)y(n)}{\sum_{n=0}^{63} y(n)y(n)}, \quad \text{bounded by } 0 \leq g_p \leq 1.2, \quad (39)$$ + +where $y(n) = v(n) * h(n)$ is the filtered adaptive codebook vector (zero-state response of $H(z)W(z)$ to $v_i(n)$ ). To insure stability, the adaptive codebook gain $g_p$ is bounded by 0.95, if the adaptive codebook gains of the previous subframes have been small and the LP filters of the previous subframes have been close to being unstable. + +## 5.8 Algebraic codebook + +### 5.8.1 Codebook structure + +The codebook structure is based on interleaved single-pulse permutation (ISPP) design. The 64 positions in the codevector are divided into 4 tracks of interleaved positions, with 16 positions in each track. The different codebooks at the different rates are constructed by placing a certain number of signed pulses in the tracks (from 1 to 6 pulses per track). The codebook index, or codeword, represents the pulse positions and signs in each track. Thus, no codebook storage is needed, since the excitation vector at the decoder can be constructed through the information contained in the index itself (no lookup tables). + +An important feature of the used codebook is that it is a dynamic codebook consisting of an algebraic codebook followed by an adaptive prefilter $F(z)$ which enhances special spectral components in order to improve the synthesis speech quality. A prefilter relevant to wideband signals is used whereby $F(z)$ consists of two parts: a periodicity enhancement part $1/(1-0.85z^{-T})$ and a tilt part $(1 - \beta_l z^{-1})$ , where $T$ is the integer part of the pitch lag and $\beta_l$ is related to the voicing of the previous subframe and is bounded by [0.0,0.5]. The codebook search is performed in the algebraic domain by combining the filter $F(z)$ with the weighed synthesis filter prior to the codebook search. Thus, the impulse response $h(n)$ must be modified to include the prefilter $F(z)$ . That is, $h(n) \leftarrow h(n) * f(n)$ . + +The codebook structures of different bit rates are given below. + +#### 5.8.1.1 23.85 and 23.05 kbit/s mode + +In this codebook, the innovation vector contains 24 non-zero pulses. All pulses can have the amplitudes +1 or -1. The 64 positions in a subframe are divided into 4 tracks, where each track contains six pulses, as shown in Table 4. + +**Table 4. Potential positions of individual pulses in the algebraic codebook, 23.85 and 23.05 kbit/s** + +| Track | Pulse | Positions | +|-------|--------------------------------------------|--------------------------------------------------------------| +| 1 | $i_0, i_4, i_8, i_{12}, i_{16}, i_{20}$ | 0, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60 | +| 2 | $i_1, i_5, i_9, i_{13}, i_{17}, i_{21}$ | 1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61 | +| 3 | $i_2, i_6, i_{10}, i_{14}, i_{18}, i_{22}$ | 2, 6, 10, 14, 18, 22, 26, 30, 34, 38, 42, 46, 50, 54, 58, 62 | +| 4 | $i_3, i_7, i_{11}, i_{15}, i_{19}, i_{23}$ | 3, 7, 11, 15, 19, 23, 27, 31, 35, 39, 43, 47, 51, 55, 59, 63 | + +The six pulses in one track are encoded with 22 bits. + +This gives a total of 88 bits (22+22+22+22) for the algebraic code. + +#### 5.8.1.2 19.85 kbit/s mode + +In this codebook, the innovation vector contains 18 non-zero pulses. All pulses can have the amplitudes +1 or -1. The 64 positions in a subframe are divided into 4 tracks, where each of the first two tracks contains five pulses and each of the other tracks contains four pulses, as shown in Table 5. + +**Table 5. Potential positions of individual pulses in the algebraic codebook, 19.85 kbit/s** + +| Track | Pulse | Positions | +|-------|---------------------------------|--------------------------------------------------------------| +| 1 | $i_0, i_4, i_8, i_{12}, i_{16}$ | 0, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60 | +| 2 | $i_1, i_5, i_9, i_{13}, i_{17}$ | 1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61 | +| 3 | $i_2, i_6, i_{10}, i_{14}$ | 2, 6, 10, 14, 18, 22, 26, 30, 34, 38, 42, 46, 50, 54, 58, 62 | +| 4 | $i_3, i_7, i_{11}, i_{15}$ | 3, 7, 11, 15, 19, 23, 27, 31, 35, 39, 43, 47, 51, 55, 59, 63 | + +The five pulses in one track are encoded with 20 bits. The four pulses in one track is encoded with 16 bits. + +This gives a total of 72 bits (20+20+16+16) for the algebraic code. + +#### 5.8.1.3 18.25 kbit/s mode + +In this codebook, the innovation vector contains 16 non-zero pulses. All pulses can have the amplitudes +1 or -1. The 64 positions in a subframe are divided into 4 tracks, where each track contains four pulses, as shown in Table 6. + +**Table 6. Potential positions of individual pulses in the algebraic codebook, 18.25 kbit/s** + +| Track | Pulse | Positions | +|-------|----------------------------|--------------------------------------------------------------| +| 1 | $i_0, i_4, i_8, i_{12}$ | 0, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60 | +| 2 | $i_1, i_5, i_9, i_{13}$ | 1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61 | +| 3 | $i_2, i_6, i_{10}, i_{14}$ | 2, 6, 10, 14, 18, 22, 26, 30, 34, 38, 42, 46, 50, 54, 58, 62 | +| 4 | $i_3, i_7, i_{11}, i_{15}$ | 3, 7, 11, 15, 19, 23, 27, 31, 35, 39, 43, 47, 51, 55, 59, 63 | + +The four pulses in one track are encoded with 16 bits. + +This gives a total of 64 bits (16+16+16+16) for the algebraic code. + +#### 5.8.1.4 15.85 kbit/s mode + +In this codebook, the innovation vector contains 12 non-zero pulses. All pulses can have the amplitudes +1 or -1. The 64 positions in a subframe are divided into 4 tracks, where each track contains three pulses, as shown in Table 7. + +**Table 7. Potential positions of individual pulses in the algebraic codebook, 15.85 kbit/s** + +| Track | Pulse | Positions | +|-------|--------------------|--------------------------------------------------------------| +| 1 | $i_0, i_4, i_8$ | 0, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60 | +| 2 | $i_1, i_5, i_9$ | 1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61 | +| 3 | $i_2, i_6, i_{10}$ | 2, 6, 10, 14, 18, 22, 26, 30, 34, 38, 42, 46, 50, 54, 58, 62 | +| 4 | $i_3, i_7, i_{11}$ | 3, 7, 11, 15, 19, 23, 27, 31, 35, 39, 43, 47, 51, 55, 59, 63 | + +The three pulses in one track are encoded with 13 bits. + +This gives a total of 52 bits (13+13+13+13) for the algebraic code. + +#### 5.8.1.5 14.25 kbit/s mode + +In this codebook, the innovation vector contains 10 non-zero pulses. All pulses can have the amplitudes +1 or -1. The 64 positions in a subframe are divided into 4 tracks, where each track contains two or three pulses, as shown in Table 8. + +**Table 8. Potential positions of individual pulses in the algebraic codebook, 14.25 kbit/s** + +| Track | Pulse | Positions | +|-------|-----------------|--------------------------------------------------------------| +| 1 | $i_0, i_4, i_8$ | 0, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60 | +| 2 | $i_1, i_5, i_9$ | 1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61 | +| 3 | $i_2, i_6$ | 2, 6, 10, 14, 18, 22, 26, 30, 34, 38, 42, 46, 50, 54, 58, 62 | +| 4 | $i_3, i_7$ | 3, 7, 11, 15, 19, 23, 27, 31, 35, 39, 43, 47, 51, 55, 59, 63 | + +Each two pulse positions in one track are encoded with 8 bits (4 bits for the position of every pulse), and the sign of the first pulse in the track is encoded with 1 bit. + +The three pulse in one track are encoded with 13 bits. + +This gives a total of 44 bits (13+13+9+9) for the algebraic code. + +#### 5.8.1.6 12.65 kbit/s mode + +In this codebook, the innovation vector contains 8 non-zero pulses. All pulses can have the amplitudes +1 or -1. The 64 positions in a subframe are divided into 4 tracks, where each track contains two pulses, as shown in Table 9. + +**Table 9. Potential positions of individual pulses in the algebraic codebook, 12.65 kbit/s** + +| Track | Pulse | Positions | +|-------|---------------------------------|--------------------------------------------------------------| +| 1 | i 0 , i 4 | 0, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60 | +| 2 | i 1 , i 5 | 1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61 | +| 3 | i 2 , i 6 | 2, 6, 10, 14, 18, 22, 26, 30, 34, 38, 42, 46, 50, 54, 58, 62 | +| 4 | i 3 , i 7 | 3, 7, 11, 15, 19, 23, 27, 31, 35, 39, 43, 47, 51, 55, 59, 63 | + +Each two pulse positions in one track are encoded with 8 bits (total of 32 bits, 4 bits for the position of every pulse), and the sign of the first pulse in the track is encoded with 1 bit (total of 4 bits). This gives a total of 36 bits for the algebraic code. + +#### 5.8.1.7 8.85 kbit/s mode + +In this codebook, the innovation vector contains 4 non-zero pulses. All pulses can have the amplitudes +1 or -1. The 64 positions in a subframe are divided into 4 tracks, where each track contains one pulse, as shown in Table 10. + +**Table 10. Potential positions of individual pulses in the algebraic codebook, 8.85 kbit/s** + +| Track | Pulse | Positions | +|-------|----------------|--------------------------------------------------------------| +| 1 | i 0 | 0, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60 | +| 2 | i 1 | 1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61 | +| 3 | i 2 | 2, 6, 10, 14, 18, 22, 26, 30, 34, 38, 42, 46, 50, 54, 58, 62 | +| 4 | i 3 | 3, 7, 11, 15, 19, 23, 27, 31, 35, 39, 43, 47, 51, 55, 59, 63 | + +Each pulse position in one track are encoded with 4 bits and the sign of the pulse in the track is encoded with 1 bit. This gives a total of 20 bits for the algebraic code. + +#### 5.8.1.8 6.60 kbit/s mode + +In this codebook, the innovation vector contains 2 non-zero pulses. All pulses can have the amplitudes +1 or -1. The 64 positions in a subframe are divided into 2 tracks, where each track contains one pulse, as shown in Table 11. + +**Table 11. Potential positions of individual pulses in the algebraic codebook, 6.60 kbit/s** + +| Track | Pulse | Positions | +|-------|----------------|---------------------------------------------------------------------------------------------------------------------------| +| 1 | i 0 | 0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30, 32, 34, 36, 38, 40, 42, 44, 46, 48, 50, 52, 54, 56, 58, 60, 62 | +| 2 | i 1 | 1, 3, 5, 7, 9, 11, 13, 15, 17, 19, 21, 23, 25, 27, 29, 31, 33, 35, 37, 39, 41, 43, 45, 47, 49, 51, 53, 55, 57, 59, 61, 63 | + +Each pulse position in one track are encoded with 5 bits and the sign of the pulse in the track is encoded with 1 bit. This gives a total of 12 bits for the algebraic code. + +### 5.8.2 Pulse indexing + +In the above section, the number of bits needed to encode a number of pulses in a track was given. In this section, the procedures used for encoding from 1 to 6 pulses per track will be described. The description will be given for the case of 4 tracks per subframe, with 16 positions per track and pulse spacing of 4 (which is the case for all modes except the 6.6 kbit/s mode). + +#### Encoding 1 signed pulse per track + +The pulse position index is encoded with 4 bits and the sign index with 1 bit. The position index is given by the pulse position in the subframe divided by the pulse spacing (integer division). The division remainder gives the track index. For example, a pulse at position 31 has a position index of $31/4 = 7$ and it belongs to the track with index 3 (4th track). + +The sign index here is set to 0 for positive signs and 1 for negative signs. + +The index of the signed pulse is given by + +$$I_{1p} = p + s \times 2^M$$ + +where $p$ is the position index, $s$ is the sign index, and $M=4$ is the number of bits per track. + +#### Encoding 2 signed pulses per track + +In case of two pulses per track of $K=2^M$ potential positions (here $M=4$ ), each pulse needs 1 bit for the sign and $M$ bits for the position, which gives a total of $2M+2$ bits. However, some redundancy exists due to the unimportance of the pulse ordering. For example, placing the first pulse at position $p$ and the second pulse at position $q$ is equivalent to placing the first pulse at position $q$ and the second pulse at position $p$ . One bit can be saved by encoding only one sign and deducing the second sign from the ordering of the positions in the index. Here the index is given by + +$$I_{2p} = p_1 + p_0 \times 2^M + s \times 2^{2M}$$ + +where $s$ is the sign index of the pulse at position index $p_0$ . If the two signs are equal then the smaller position is set to $p_0$ and the larger position is set to $p_1$ . On the other hand, if the two signs are not equal then the larger position is set to $p_0$ and the smaller position is set to $p_1$ . At the decoder, the sign of the pulse at position $p_0$ is readily available. The second sign is deduced from the pulse ordering. If $p_0$ is larger than $p_1$ then the sign of the pulse at position $p_1$ is opposite to that at position $p_0$ . If this is not the case then the two signs are set equal + +#### Encoding 3 signed pulses per track + +In case of three pulses per track, similar logic can be used as in the case of two pulses. For a track with $2^M$ positions, $3M+1$ bits are needed instead of $3M+3$ bits. A simple way of indexing the pulses is to divide the track positions in two sections (or halves) and identify a section that contains at least two pulses. The number of positions in the section is $K/2 = 2^M/2 = 2^{M-1}$ , which can be represented with $M-1$ bits. The two pulses in the section containing at least two pulses are encoded with the procedure for encoding 2 signed pulses which requires $2(M-1)+1$ bits and the remaining pulse which can be anywhere in the track (in either section) is encoded with the $M+1$ bits. Finally, the index of the section that contains the two pulses is encoded with 1 bit. Thus the total number of required bits is $2(M-1)+1 + M+1 + 1 = 3M+1$ . + +A simple way of checking if two pulses are positioned in the same section is done by checking whether the most significant bits (MSB) of their position indices are equal or not. Note that a MSB of 0 means that the position belongs to the lower half of the track (0-7) and MSB of 1 means it belongs to the upper half (8-15). If the two pulses belong to the upper half, they need to be shifted to the range (0-7) before encoding them using $2 \times 3 + 1$ bits. This can be done by masking the $M-1$ least significant bits (LSB) with a mask consisting of $M-1$ ones (which corresponds to the number 7 in this case). + +The index of the 3 signed pulses is given by + +$$I_{3p} = I_{2p} + k \times 2^{2M-1} + I_{1p} \times 2^{2M}$$ + +where $I_{2p}$ is the index of the two pulses in the same section, $k$ is the section index (0 or 1), and $I_{1p}$ is the index of the third pulse in the track. + +#### Encoding 4 signed pulses per track + +The 4 signed pulses in a track of length $K=2^M$ can be encoded using $4M$ bits. Similar to the case of 3 pulses, the $K$ positions in the track are divided into 2 sections (two halves) where each section contains $K/2=8$ positions. Here we + +denote the sections as Section A with positions 0 to $K/2-1$ and Section B with positions $K/2$ to $K-1$ . Each section can contain from 0 to 4 pulses. The table below shows the 5 cases representing the possible number of pulses in each section: + +| case | Pulses in Section A | Pulses in Section B | Bits needed | +|-------------|----------------------------|----------------------------|--------------------| +| 0 | 0 | 4 | $4M-3$ | +| 1 | 1 | 3 | $4M-2$ | +| 2 | 2 | 2 | $4M-2$ | +| 3 | 3 | 1 | $4M-2$ | +| 4 | 4 | 0 | $4M-3$ | + +In cases 0 or 4, the 4 pulses in a section of length $K/2=2^{M-1}$ can be encoded using $4(M-1)+1=4M-3$ bits (this will be explained later on). + +In cases 1 or 3, the 1 pulse in a section of length $K/2=2^{M-1}$ can be encoded with $M-1+1 = M$ bits and the 3 pulses in the other section can be encoded with $3(M-1)+1 = 3M-2$ bits. This gives a total of $M+3M-2 = 4M-2$ bits. + +In case 2, the pulses in a section of length $K/2=2^{M-1}$ can be encoded with $2(M-1)+1 = 2M-1$ bits. Thus for both sections, $2(2M-1) = 4M-2$ bits are required. + +Now the case index can be encoded with 2 bits (4 possible cases) assuming cases 0 and 4 are combined. Then for cases 1, 2, or 3, the number of needed bits is $4M-2$ . This gives a total of $4M-2 + 2 = 4M$ bits. For cases 0 or 4, one bit is needed for identifying either case, and $4M-3$ bits are needed for encoding the 4 pulses in the section. Adding the 2 bits needed for the general case, this gives a total of $1+4M-3+2= 4M$ bits. + +The index of the 4 signed pulses is given by + +$$I_{4p} = I_{AB} + k \times 2^{4M-2}$$ + +where $k$ is the case index (2 bits), and $I_{AB}$ is the index of the pulses in both sections for each individual case. + +For cases 0 and 1, $I_{AB}$ is given by + +$$I_{AB\_0,4} = I_{4p\_section} + j \times 2^{4M-3}$$ + +where $j$ is a 1-bit index identifying the section with 4 pulses and $I_{4p\_section}$ is the index of the 4 pulses in that section (which requires $4M-3$ bits). + +For case 1, $I_{AB}$ is given by + +$$I_{AB\_1} = I_{3p\_B} + I_{1p\_A} \times 2^{3(M-1)+1}$$ + +where $I_{3p\_B}$ is the index of the 3 pulses in Section B ( $3(M-1)+1$ bits) and $I_{1p\_A}$ is the index of the pulse in Section A ( $(M-1)+1$ bits). + +For case 2, $I_{AB}$ is given by + +$$I_{AB\_2} = I_{2p\_B} + I_{2p\_A} \times 2^{2(M-1)+1}$$ + +where $I_{2p\_B}$ is the index of the 2 pulses in Section B ( $2(M-1)+1$ bits) and $I_{2p\_A}$ is the index of the two pulses in Section A ( $2(M-1)+1$ bits). + +Finally, for case 3, $I_{AB}$ is given by + +$$I_{AB\_3} = I_{1p\_B} + I_{3p\_A} \times 2^M$$ + +where $I_{1p\_B}$ is the index of the pulse in Section B ( $(M-1)+1$ bits) and $I_{3p\_A}$ is the index of the 3 pulses in Section A ( $3(M-1)+1$ bits). + +For cases 0 and 4, it was mentioned that the 4 pulses in one section are encoded using $4(M-1)+1$ bits. This is done by further dividing the section into 2 subsections of length $K/4=2^{M-2}$ ( $=4$ in this case); identifying a subsection that contains at least 2 pulses; coding the 2 pulses in that subsection using $2(M-2)+1=2M-3$ bits; coding the index of the subsection + +that contains at least 2 pulses using 1 bit; and coding the remaining 2 pulses, assuming that they can be anywhere in the section, using $2(M-1)+1=2M-1$ bits. This gives a total of $(2M-3)+(1)+(2M-1) = 4M-3$ bits + +#### Encoding 5 signed pulses per track + +The 5 signed pulses in a track of length $K=2^M$ can be encoded using $5M$ bits. Similar to the case of 4 pulses, the $K$ positions in the track are divided into 2 sections A and B. Each section can contain from 0 to 5 pulses. A simple approach to encode the 5 pulses is to identify a section that contains at least 3 pulses and to encode the 3 pulses in that section using $3(M-1)+1= 3M-2$ bits, and to encode the remaining 2 pulses in the whole track using $2M+1$ bits. This gives $5M-1$ bits. An extra bit is needed to identify the section that contains at least 3 pulses. Thus a total of $5M$ bits are needed to encode the 5 signed pulses. + +The index of the 5 signed pulses is given by + +$$I_{5p} = I_{2p} + I_{3p} \times 2^{2M} + k \times 2^{5M-1}$$ + +Where $k$ is the index of the section that contains at least 3 pulses, $I_{3p}$ is the index of the 3 pulses in that section ( $3(M-1)+1$ bits), and $I_{2p}$ is the index of the remaining 2 pulses in the track ( $2M+1$ bits). + +#### Encoding 6 signed pulses per track + +The 6 signed pulses in a track of length $K=2^M$ are encoded using $6M-2$ bits. Similar to the case of 5 pulses, the $K$ positions in the track are divided into 2 sections A and B. Each section can contain from 0 to 6 pulses. The table below shows the 7 cases representing the possible number of pulses in each sections: + +| case | Pulses in Section A | Pulses in Section B | Bits needed | +|-------------|----------------------------|----------------------------|--------------------| +| 0 | 0 | 6 | $6M-5$ | +| 1 | 1 | 5 | $6M-5$ | +| 2 | 2 | 4 | $6M-5$ | +| 3 | 3 | 3 | $6M-4$ | +| 4 | 4 | 2 | $6M-5$ | +| 5 | 5 | 1 | $6M-5$ | +| 6 | 6 | 0 | $6M-5$ | + +Note that cases 0 and 6 are similar except that the 6 pulses are in different section. Similarly, cases 1 and 5 as well as cases 2 and 4 differ only in the section that contains more pulses. Therefore these cases can be coupled and an extra bit can be assigned to identify the section that contains more pulses. Since these cases initially need $6M-5$ bits, the coupled cases need $6M-4$ bits taking into account the Section bit. Thus, we have now 4 states of coupled cases, that is (0,6), (1,5), (2,4), and (3), with 2 extra bits needed for the state. This gives a total of $6M-4+2=6M-2$ bits for the 6 signed pulses. + +In cases 0 and 6, 1 bit is needed to identify the section which contains 6 pulses. 5 pulses in that section are encoded using $5(M-1)$ bits (since the pulses are confined to that section), and the remaining pulse is encoded using $(M-1)+1$ bits. Thus a total of $1+5(M-1)+M=6M-4$ bits are needed for this coupled case. Extra 2 bits are needed to encode the state of the coupled case, giving a total of $6M-2$ bits. For this coupled case, the index of the 6 pulses is given by + +$$I_{6p} = I_{1p} + I_{5p} \times 2^{M+} j \times 2^{6M-5} + k \times 2^{6M-4}$$ + +where $k$ is the index of the coupled case (2 bits), $j$ is the index of the section containing 6 pulses (1 bit), $I_{5p}$ is the index of 5 pulses in that section ( $5(M-1)$ bits), and $I_{1p}$ is the index of the remaining pulse in that section ( $(M-1)+1$ bits). + +In cases 1 and 5, 1 bit is needed to identify the section which contains 5 pulses. The 5 pulses in that section are encoded using $5(M-1)$ bits and the pulse in the other section is encoded using $(M-1)+1$ bits. For this coupled case, the index of the 6 pulses is given by + +$$I_{6p} = I_{1p} + I_{5p} \times 2^{M+} j \times 2^{6M-5} + k \times 2^{6M-4}$$ + +where $k$ is the index of the coupled case (2 bits), $j$ is the index of the section containing 5 pulses (1 bit), $I_{5p}$ is the index of the 5 pulses in that section ( $5(M-1)$ bits), and $I_{1p}$ is the index of the pulse in the other section ( $(M-1)+1$ bits). + +In cases 2 or 4, 1 bit is needed to identify the section which contains 4 pulses. The 4 pulses in that section are encoded using $4(M-1)$ bits and the 2 pulses in the other section are encoded using $2(M-1)+1$ bits. For this coupled case, the index of the 6 pulses is given by + +$$I_{6p} = I_{2p} + I_{4p} \times 2^{2(M-1)+1} + j \times 2^{6M-5} + k \times 2^{6M-4}$$ + +where $k$ is the index of the coupled case (2 bits), $j$ is the index of the section containing 4 pulses (1 bit), $I_{4p}$ is the index of 4 pulses in that section ( $4(M-1)$ bits), and $I_{2p}$ is the index of the 2 pulses in the other section ( $2(M-1)+1$ bits). + +In case 3, the 3 pulses in each section are encoded using $3(M-1)+1$ bits in each Section. For this case, the index of the 6 pulses is given by + +$$I_{6p} = I_{3pB} + I_{3pA} \times 2^{3(M-1)+1} + k \times 2^{6M-4}$$ + +where $k$ is the index of the coupled case (2 bits), $I_{3pB}$ is the index of 3 pulses Section B ( $3(M-1)+1$ bits), and $I_{3pA}$ is the index of the 3 pulses in Section A ( $3(M-1)+1$ bits). + +### 5.8.3 Codebook search + +The algebraic codebook is searched by minimizing the mean square error between the weighted input speech and the weighted synthesis speech. The target signal used in the closed-loop pitch search is updated by subtracting the adaptive codebook contribution. That is + +$$x_2(n) = x(n) - g_p y(n), \quad n = 0, \dots, 63, \quad (40)$$ + +where $y(n) = v(n) * h(n)$ is the filtered adaptive codebook vector and $g_p$ is the unquantized adaptive codebook gain. + +The matrix **H** is defined as the lower triangular Toeplitz convolution matrix with diagonal $h(0)$ and lower diagonals $h(1), \dots, h(63)$ , and $\mathbf{d} = \mathbf{H}^t \mathbf{x}_2$ is the correlation between the target signal $x_2(n)$ and the impulse response $h(n)$ (also known as the backward filtered target vector), and $\Phi = \mathbf{H}^t \mathbf{H}$ is the matrix of correlations of $h(n)$ . + +The elements of the vector **d** are computed by + +$$d(n) = \sum_{i=n}^{63} x_2(i)h(i-n), \quad n = 0, \dots, 63, \quad (41)$$ + +and the elements of the symmetric matrix $\Phi$ are computed by + +$$\phi(i, j) = \sum_{n=j}^{63} h(n-i)h(n-j), \quad i = 0, \dots, 63, \quad j = i, \dots, 63. \quad (42)$$ + +If $\mathbf{c}_k$ is the algebraic codevector at index $k$ , then the algebraic codebook is searched by maximizing the search criterion + +$$Q_k = \frac{(\mathbf{x}_2^t \mathbf{H} \mathbf{c}_k)^2}{\mathbf{c}_k^t \mathbf{H}^t \mathbf{H} \mathbf{c}_k} = \frac{(\mathbf{d}^t \mathbf{c}_k)^2}{\mathbf{c}_k^t \Phi \mathbf{c}_k} = \frac{(R_k)^2}{E_k}. \quad (43)$$ + +The vector **d** and the matrix $\Phi$ are usually computed prior to the codebook search. + +The algebraic structure of the codebooks allows for very fast search procedures since the innovation vector $\mathbf{c}_k$ contains only a few nonzero pulses. The correlation in the numerator of Equation (43) is given by + +$$C = \sum_{i=0}^{N_p-1} a_i d(m_i) \quad (44)$$ + +where $m_i$ is the position of the $i$ th pulse, $a_i$ is its amplitude, and $N_p$ is the number of pulses. The energy in the denominator of Equation (43) is given by + +$$E = \sum_{i=0}^{N_p-1} \phi(m_i, m_i) + 2 \sum_{i=0}^{N_p-2} \sum_{j=i+1}^{N_p-1} a_i a_j \phi(m_i, m_j) \quad (45)$$ + +To simplify the search procedure, the pulse amplitudes are predetermined based on a certain reference signal $b(n)$ . In this so-called signal-selected pulse amplitude approach, the sign of a pulse at position $i$ is set equal to the sign of the reference signal at that position. Here, the reference signal $b(n)$ is given by + +$$b(n) = \sqrt{\frac{E_d}{E_r}} r_{LTP}(n) + \alpha d(n) \quad (46)$$ + +where $E_d = \mathbf{d}'\mathbf{d}$ is the energy of the signal $d(n)$ and $E_r = \mathbf{r}_{LTP}'\mathbf{r}_{LTP}$ is the energy of the signal $r_{LTP}(n)$ which is the residual signal after long term prediction. The scaling factor $\alpha$ controls the amount of dependence of the reference signal on $d(n)$ , and it is lowered as the bit rate is increased. Here $\alpha=2$ for 6.6 and 8.85 modes; $\alpha=1$ for 12.65, 14.25, and 15.85 modes; $\alpha=0.8$ for 18.25 mode; $\alpha=0.75$ for 19.85 mode; and $\alpha=0.5$ for 23.05 and 23.85 modes. + +To simplify the search the signal $d(n)$ and matrix $\Phi$ are modified to incorporate the pre-selected signs. Let $s_b(n)$ denote the vector containing the signs of $b(n)$ . The modified signal $d'(n)$ is given by + +$$d'(n) = s_b(n)d(n) \quad n=0, \dots, N-1$$ + +and the modified autocorrelation matrix $\Phi'$ is given by + +$$\phi'(i, j) = s_b(i)s_b(j)\phi(i, j), \quad i=0, \dots, N-1; \quad j=i, \dots, N-1.$$ + +The correlation at the numerator of the search criterion $Q_k$ is now given by + +$$R = \sum_{i=0}^{N_p-1} d'(m_i)$$ + +and the energy at the denominator of the search criterion $Q_k$ is given by + +$$E = \sum_{i=0}^{N_p-1} \phi'(m_i, m_i) + 2 \sum_{i=0}^{N_p-2} \sum_{j=i+1}^{N_p-1} \phi'(m_i, m_j)$$ + +The goal of the search now is to determine the codevector with the best set of $N_p$ pulse positions assuming amplitudes of the pulses have been selected as described above. The basic selection criterion is the maximization of the above mentioned ratio $Q_k$ . + +In order to reduce the search complexity, a fast search procedure known as depth-first tree search procedure is used, whereby the pulse positions are determined $N_m$ pulses at a time. More precisely, the $N_p$ available pulses are partitioned into $M$ non-empty subsets of $N_m$ pulses respectively such that $N_1+N_2+\dots+N_{M-1}+N_M = N_p$ . A particular choice of positions for the first $J = N_1+N_2+\dots+N_{m-1}$ pulses considered is called a level- $m$ path or a path of length $J$ . The basic criterion for a path of $J$ pulse positions is the ratio $Q_k(J)$ when only the $J$ relevant pulses are considered. + +The search begins with subset #1 and proceeds with subsequent subsets according to a tree structure whereby subset $m$ is searched at the $m^{\text{th}}$ level of the tree. The purpose of the search at level 1 is to consider the $N_1$ pulses of subset #1 and their valid positions in order to determine one, or a number of, candidate path(s) of length $N_1$ which are the tree nodes at level 1. The path at each terminating node of level $m-1$ is extended to length $N_1+N_2+\dots+N_m$ at level $m$ by considering $N_m$ new pulses and their valid positions. One, or a number of, candidate extended path(s) are determined to constitute level- $m$ nodes. The best codevector corresponds to that path of length $N_p$ which maximizes the criterion $Q_k(N_p)$ with respect to all level- $M$ nodes. + +A special form of the depth-first tree search procedure is used here, in which two pulses are searched at a time, that is, $N_m=2$ , and these 2 pulses belong to two consecutive tracks. Further, instead of assuming that the matrix $\Phi$ is precomputed and stored, which requires a memory of $N \times N$ words ( $64 \times 64 = 4k$ words), a memory-efficient approach is used which reduces the memory requirement. In this approach, the search procedure is performed in such a way that only a part of the needed elements of the correlation matrix are precomputed and stored. This part corresponds to the + +correlations of the impulse response corresponding to potential pulse positions in consecutive tracks, as well as the correlations corresponding to $\phi(j,j), j=0, \dots, N-1$ (that is the elements of the main diagonal of matrix $\Phi$ ). + +In order to reduce complexity, while testing possible combinations of two pulses, a limited number of potential positions of the first pulse are tested. Further, in case of large number of pulses, some pulses in the higher levels of the search tree are fixed. In order to guess intelligently which potential pulse positions are considered for the first pulse or in order to fix some pulse positions, a "pulse-position likelihood-estimate vector" $\mathbf{b}$ is used, which is based on speech-related signals. The $p^{\text{th}}$ component $b(p)$ of this estimate vector $\mathbf{b}$ characterizes the probability of a pulse occupying position $p$ ( $p = 0, 1, \dots, N-1$ ) in the best codevector we are searching for. Here the estimate vector $\mathbf{b}$ is the same vector used for preselecting the amplitudes and given in Equation (46). + +The search procedures for all bit rate modes are similar. Two pulses are searched at a time, and these two pulses always correspond to consecutive tracks. That is the two searched pulses are in tracks $T_0-T_1$ , $T_1-T_2$ , $T_2-T_3$ , or $T_3-T_0$ . + +Before searching the positions, the sign of at pulse a potential position $n$ is set the sign of $b(n)$ at that position. Then the modified signal $d'(n)$ is computed as described above by including the predetermined signs. + +For the first 2 pulses (1st tree level), the correlation at the numerator of the search criterion is given by + +$$R = d'(m_0) + d'(m_1)$$ + +and the energy at the denominator of the search criterion $Q_k$ is given by + +$$E = \phi'(m_0, m_0) + \phi'(m_1, m_1) + 2\phi'(m_0, m_1)$$ + +where the correlations $\phi'(m_i, m_j)$ has been modified to include the preselected signs at positions $m_i$ and $m_j$ . + +For subsequent levels, the numerator and denominator are updated by adding the contribution of two new pulses. Assuming that two new pulses at a certain tree level with positions $m_k$ and $m_{k+1}$ from two consecutive tracks are searched, then the updated value of $R$ is given by + +$$R = R + d'(m_k) + d'(m_{k+1}) \quad (47)$$ + +and the updated energy is given by + +$$E = E + \phi'(m_k, m_k) + \phi'(m_{k+1}, m_{k+1}) + 2\phi'(m_k, m_{k+1}) + 2R_{hv}(m_k) + 2R_{hv}(m_{k+1}) \quad (48)$$ + +where $R_{hv}(m)$ is the correlation between the impulse response $h(n)$ and a vector $v_h(n)$ containing the addition of delayed versions of impulse response at the previously determined positions. That is, + +$$v_h(n) = \sum_{i=0}^{k-1} h(n - m_i)$$ + +and + +$$R_{hv}(m) = \sum_{n=m}^{N-1} h(n)v_h(n - m)$$ + +At each tree level, the values of $R_{hv}(m)$ are computed online for all possible positions in each of the two tracks being tested. It can be seen from Equation (48) that only the correlations $\phi'(m_k, m_{k+1})$ corresponding to pulse positions in two consecutive tracks need to be stored ( $4 \times 16 \times 16$ words), along with the correlations $\phi'(m_k, m_k)$ corresponding to the diagonal of the matrix $\Phi$ (64 words). Thus the memory requirement in the present algebraic structure is 1088 words instead of $64 \times 64 = 4096$ words. + +The search procedures at the different bit rates modes are similar. The difference is in the number of pulses, and accordingly, the number of levels in the tree search. In order to keep a comparable search complexity across the different codebooks, the number of tested positions is kept similar. + +The search in the 12.65 kbit/s mode will be described as an example. In this mode, 2 pulses are placed in each track giving a total of 8 pulses per subframe of length 64. Two pulses are searched at a time, and these two pulses always + +correspond to consecutive tracks. That is the two searched pulses are in tracks $T_0-T_1$ , $T_1-T_2$ , $T_2-T_3$ , or $T_3-T_0$ . The tree has 4 levels in this case. At the first level, pulse $P_0$ is assigned to track $T_0$ and pulse $P_1$ to track $T_1$ . In this level, no search is performed and the two pulse positions are set to the maximum of $b(n)$ in each track. In the second level, pulse $P_2$ is assigned to track $T_2$ and pulse $P_3$ to track $T_3$ . 4 positions for pulse $P_2$ are tested against all 16 positions of pulse $P_3$ . The 4 tested positions of $P_2$ are determined based on the maxima of $b(n)$ in the track. In the third level, pulse $P_4$ is assigned to track $T_1$ and pulse $P_5$ to track $T_2$ . 8 positions for pulse $P_4$ are tested against all 16 positions of pulse $P_5$ . Similar to the previous search level, the 8 tested positions of $P_4$ are determined based on the maxima of $b(n)$ in the track. In the fourth level, pulse $P_6$ is assigned to track $T_3$ and pulse $P_7$ to track $T_0$ . 8 positions for pulse $P_6$ are tested against all 16 positions of pulse $P_7$ . Thus the total number of tested combination is $4 \times 16 + 8 \times 16 + 8 \times 16 = 320$ . The whole process is repeated 4 times (4 iterations) by assigning the pulses to different tracks. For example, in the 2nd iteration, pulses $P_0$ to $P_7$ are assigned to tracks $T_1$ , $T_2$ , $T_3$ , $T_0$ , $T_2$ , $T_3$ , $T_0$ , and $T_1$ , respectively. Thus the total number of tested position combinations is $4 \times 320 = 1280$ . + +As another search example, in the 15.85 kbit/s mode, 3 pulses are placed in each track giving a total of 12 pulses. There are 6 levels in the tree search whereby two pulses are searched in each level. In the first two levels, 4 pulses are set to the maxima of $b(n)$ . In the subsequent 4 levels, the number of tested combinations are $4 \times 16$ , $6 \times 16$ , $8 \times 16$ , and $8 \times 16$ , respectively. 4 iterations are used giving a total of $4 \times 26 \times 16 = 1664$ combinations. + +## 5.9 Quantization of the adaptive and fixed codebook gains + +The adaptive codebook gain (pitch gain) and the fixed (algebraic) codebook gain are vector quantized using a 6-bit codebook for modes 8.85 and 6.60 kbit/s and using a 7-bit codebook for all the other modes. + +The fixed codebook gain quantization is performed using MA prediction with fixed coefficients. The 4th order MA prediction is performed on the innovation energy as follows. Let $E(n)$ be the mean-removed innovation energy (in dB) at subframe $n$ , and given by + +$$E(n) = 10 \log \left( \frac{1}{N} g_c^2 \sum_{i=0}^{N-1} c^2(i) \right) - \bar{E} \quad (49)$$ + +where $N=64$ is the subframe size, $c(i)$ is the fixed codebook excitation, and $\bar{E} = 30$ dB is the mean of the innovation energy. The predicted energy is given by + +$$\tilde{E}(n) = \sum_{i=1}^4 b_i \hat{R}(n-i) \quad (50)$$ + +where $[b_1 \ b_2 \ b_3 \ b_4] = [0.5, 0.4, 0.3, 0.2]$ are the MA prediction coefficients, and $\hat{R}(k)$ is the quantized energy prediction error at subframe $k$ . The predicted energy is used to compute a predicted fixed-codebook gain $g'_c$ as in Equation (49) (by substituting $E(n)$ by $\tilde{E}(n)$ and $g_c$ by $g'_c$ ). This is done as follows. First, the mean innovation energy is found by + +$$E_i = 10 \log \left( \frac{1}{N} \sum_{i=0}^{N-1} c^2(i) \right) \quad (51)$$ + +and then the predicted gain $g'_c$ is found by + +$$g'_c = 10^{0.05(\tilde{E}(n) + \bar{E} - E_i)} \quad (52)$$ + +A correction factor between the gain $g_c$ and the estimated one $g'_c$ is given by + +$$\gamma = g_c / g'_c \quad (53)$$ + +Note that the prediction error is given by + +$$R(n) = E(n) - \tilde{E}(n) = 20 \log(\gamma) \quad (54)$$ + +The pitch gain, $g_p$ , and correction factor $\gamma$ are jointly vector quantized using a 6-bit codebook for modes 8.85 and 6.60 kbit/s, and 7-bit codebook for other modes. The gain codebook search is performed by minimizing the mean-square of the weighted error between original and reconstructed speech which is given + +$$E = x^t x + g_p^2 y^t y + g_c^2 z^t z - 2g_p x^t y - 2g_c x^t z + 2g_p g_c y^t z, \quad (55)$$ + +where the $x$ is the target vector, $y$ is the filtered adaptive codebook vector, and $z$ is the filtered fixed codebook vector. (Each gain vector in the codebook also has an element representing the quantized energy prediction error.) The quantized energy prediction error associated with the chosen gains is used to update $\hat{R}(n)$ . In the search, only the 64 codevectors that are closest to the unquantized pitch gain, $g_p$ , are taken into account. + +## 5.10 Memory update + +An update of the states of the synthesis and weighting filters is needed in order to compute the target signal in the next subframe. + +After the two gains have been quantized, the excitation signal, $u(n)$ , in the present subframe is found by + +$$u(n) = \hat{g}_p v(n) + \hat{g}_c c(n), \quad n = 0, \dots, 63, \quad (56)$$ + +where $\hat{g}_p$ and $\hat{g}_c$ are the quantized adaptive and fixed codebook gains, respectively, $v_i(n)$ the adaptive codebook vector (interpolated past excitation), and $c(n)$ is the fixed codebook vector (algebraic code including pitch sharpening). The states of the filters can be updated by filtering the signal $r(n) - u(n)$ (difference between residual and excitation) through the filters $1/\hat{A}(z)$ and $A(z/\gamma_1)H_{de-emph}(z)$ for the 64 sample subframe and saving the states of the filters. This would require 3 filterings. A simpler approach which requires only one filtering is as follows. The local synthesis speech, $\hat{s}(n)$ , is computed by filtering the excitation signal through $1/\hat{A}(z)$ . The output of the filter due to the input $r(n) - u(n)$ is equivalent to $e(n) = s(n) - \hat{s}(n)$ . So the states of the synthesis filter $1/\hat{A}(z)$ are given by $e(n), n=48, \dots, 63$ . Updating the states of the filter $A(z/\gamma_1)H_{de-emph}(z)$ can be done by filtering the error signal $e(n)$ through this filter to find the perceptually weighted error $e_w(n)$ . However, the signal $e_w(n)$ can be equivalently found by + +$$e_w(n) = x(n) - \hat{g}_p y(n) - \hat{g}_c z(n). \quad (57)$$ + +Since the signals $x(n)$ , $y(n)$ , and $z(n)$ are available, the states of the weighting filter are updated by computing $e_w(n)$ as in Equation (54) for $n = 48, \dots, 63$ . This saves two filterings. + +## 5.11 High-band gain generation + +In order to compute the high band gain for 23.85 kbit/s mode, 16 kHz input speech is filtered through a band-pass FIR filter $H_{HB}(z)$ which has the passband from 6.4 to 7 kHz. The high band gain $g_{HB}$ is obtained by + +$$g_{HB} = \frac{\sum_{i=0}^{63} (s_{HB}(i))^2}{\sum_{i=0}^{63} (s_{HB2}(i))^2}, \quad (58)$$ + +where $s_{HB}(i)$ is band-pass filtered input speech and $s_{HB2}(i)$ is high-band speech synthesis obtained from high-band excitation $u_{HB2}(i)$ filtered through high-band synthesis filter $A_{HB}(z)$ described in Section 6.3.2.2. + +# 6 Functional description of the decoder + +The function of the decoder consists of decoding the transmitted parameters (LP parameters, adaptive codebook vector, adaptive codebook gain, fixed codebook vector, fixed codebook gain and high-band gain) and performing synthesis to obtain the reconstructed speech. The reconstructed speech is then postprocessed and upsampled (and upscaled). + +Finally high-band signal is generated to the frequency band from 6 to 7 kHz. The signal flow at the decoder is shown in Figure 3. + +## 6.1 Decoding and speech synthesis + +The decoding process is performed in the following order: + +**Decoding of LP filter parameters:** The received indices of ISP quantization are used to reconstruct the quantized ISP vector. The interpolation described in Section 5.2.6 is performed to obtain 4 interpolated ISP vectors (corresponding to 4 subframes). For each subframe, the interpolated ISP vector is converted to LP filter coefficient domain $a_k$ , which is used for synthesizing the reconstructed speech in the subframe. + +The following steps are repeated for each subframe: + +1. **Decoding of the adaptive codebook vector:** The received pitch index (adaptive codebook index) is used to find the integer and fractional parts of the pitch lag. The adaptive codebook vector $v(n)$ is found by interpolating the past excitation $u(n)$ (at the pitch delay) using the FIR filter described in Section 5.7. The received adaptive filter index is used to find out whether the filtered adaptive codebook is $v_1(n) = v(n)$ or $v_2(n) = 0.18v(n) + 0.64v(n-1) + 0.18v(n-2)$ . +2. **Decoding of the innovative vector:** The received algebraic codebook index is used to extract the positions and amplitudes (signs) of the excitation pulses and to find the algebraic codevector $c(n)$ . If the integer part of the pitch lag is less than the subframe size 64, the pitch sharpening procedure is applied which translates into modifying $c(n)$ by filtering it through the adaptive prefilter $F(z)$ which consists of two parts: a periodicity enhancement part $1/(1-0.85z^{-T})$ and a tilt part $(1 - \beta_1 z^{-1})$ , where $T$ is the integer part of the pitch lag and $\beta_1(n)$ is related to the voicing of the previous subframe and is bounded by $[0.0, 0.5]$ . +3. **Decoding of the adaptive and innovative codebook gains:** The received index gives the fixed codebook gain correction factor $\hat{\gamma}$ . The estimated fixed codebook gain $g'_c$ is found as described in Section 5.8. First, the predicted energy for every subframe $n$ is found by + +$$\tilde{E}(n) = \sum_{i=1}^4 b_i \hat{R}(n-i) \quad (59)$$ + +and then the mean innovation energy is found by + +$$E_i = 10 \log \left( \frac{1}{N} \sum_{i=0}^{N-1} c^2(i) \right) \quad (60)$$ + +The predicted gain $g'_c$ is found by + +$$g'_c = 10^{0.05(\tilde{E}(n) + \bar{E} - E_i)} \quad (61)$$ + +The quantized fixed codebook gain is given by + +$$\hat{g}_c = \hat{\gamma} g'_c. \quad (62)$$ + +4. **Computing the reconstructed speech:** The following steps are for $n = 0, \dots, 63$ . The total excitation is constructed by: + +$$u(n) = \hat{g}_p v(n) + \hat{g}_c c(n), \quad (63)$$ + +Before the speech synthesis, a post-processing of excitation elements is performed. + +5. **Anti-sparseness processing (6.60 and 8.85 kbit/s modes):** An adaptive anti-sparseness post-processing procedure is applied to the fixed codebook vector $c(n)$ in order to reduce perceptual artifacts arising from the sparseness of the algebraic fixed codebook vectors with only a few non-zero samples per subframe. The anti-sparseness processing consists of circular convolution of the + +fixed codebook vector with an impulse response. Three pre-stored impulse responses are used and a number $impNr=0,1,2$ is set to select one of them. A value of 2 corresponds to no modification, a value of 1 corresponds to medium modification, while a value of 0 corresponds to strong modification. The selection of the impulse response is performed adaptively from the adaptive and fixed codebook gains. The following procedure is employed: + +``` + +if $\hat{g}_p < 0.6$ then + $impNr = 0;$ +else if $\hat{g}_p < 0.9$ then + $impNr = 1;$ +else + $impNr = 2;$ + +``` + +Detect onset by comparing the fixed codebook gain to the previous fixed codebook gain. If the current value is more than three times the previous value an onset is detected. + +If not onset and $impNr=0$ , the median filtered value of the current and the previous 4 adaptive codebook gains are computed. If this value is less than 0.6, $impNr=0$ . + +If not onset, the $impNr$ -value is restricted to increase by one step from the previous subframe. + +If an onset is declared, the $impNr$ -value is increased by one if it is less than 2. + +In case of 8.85 kbit/s mode, the $impNr$ -value is increased by one. + +6. **Noise enhancer:** A nonlinear gain smoothing technique is applied to the fixed codebook gain $\hat{g}_c$ in order to enhance excitation in noise. Based on the stability and voicing of the speech segment, the gain of the fixed codebook is smoothed in order to reduce fluctuation in the energy of the excitation in case of stationary signals. This improves the performance in case of stationary background noise. + +The voicing factor is given by $\lambda=0.5(1-r_v)$ with $r_v=(E_v-E_c)/(E_v+E_c)$ , where $E_v$ and $E_c$ are the energies of the scaled pitch codevector and scaled innovation codevector, respectively. Note that since the value of $r_v$ is between $-1$ and $1$ , the value of $\lambda$ is between $0$ and $1$ . Note that the factor $\lambda$ is related to the amount of unvoicing with a value of $0$ for purely voiced segments and a value of $1$ for purely unvoiced segments. + +A stability factor $\theta$ is computed based on a distance measure between the adjacent LP filters. Here, the factor $\theta$ is related to the ISP distance measure and it is bounded by $0 \leq \theta \leq 1$ , with larger values of $\theta$ corresponding to more stable signals. + +Finally, a gain smoothing factor $S_m$ is given by + +$$S_m = \lambda\theta. \quad (64)$$ + +The value of $S_m$ approaches $1$ for unvoiced and stable signals, which is the case of stationary background noise signals. For purely voiced signals or for unstable signals, the value of $S_m$ approaches $0$ . + +An initial modified gain $g_0$ is computed by comparing the fixed codebook gain $\hat{g}_c$ to a threshold given by the initial modified gain from the previous subframe, $g_{-1}$ . If $\hat{g}_c$ is larger or equal to $g_{-1}$ , then $g_0$ is computed by decrementing $\hat{g}_c$ by $1.5$ dB bounded by $g_0 \geq g_{-1}$ . If $\hat{g}_c$ is smaller than $g_{-1}$ , then $g_0$ is computed by incrementing $\hat{g}_c$ by $1.5$ dB bounded by $g_0 \leq g_{-1}$ . + +Finally, the gain is update with the value of the smoothed gain as follows + +$$\hat{g}_c = S_m g_0 + (1 - S_m) \hat{g}_c, \quad (65)$$ + +7. **Pitch enhancer:** A pitch enhancer procedure modifies the total excitation $u(n)$ by filtering the fixed codebook excitation through an innovation filter whose frequency response emphasizes the + +higher frequencies more than lower frequencies, and whose coefficients are related to the periodicity in the signal. A filter of the form + +$$F_{inno}(z) = -c_{pe}z + 1 - c_{pe}z^{-1}, \quad (66)$$ + +where $c_{pe}=0.125(1+r_v)$ , with $r_v=(E_v-E_c)/(E_v+E_c)$ as described above. The filtered fixed codevector is given by + +$$c'(n) = c(n) - c_{pe}(c(n+1) + c(n-1)). \quad (67)$$ + +and the updated excitation is given by + +$$u(n) = \hat{g}_p v(n) + \hat{g}_c c'(n). \quad (68)$$ + +The above procedure can be done in one step by updating the excitation as follows + +$$u(n) = u(n) - \hat{g}_c c_{pe}(c(n+1) + c(n-1)). \quad (69)$$ + +8. **Post-processing of excitation elements (6.60 and 8.85 kbit/s modes):** A post-processing of excitation elements procedure is applied to the total excitation $u(n)$ by emphasizing the contribution of the adaptive codebook vector: + +$$\hat{u}(n) = \begin{cases} u(n) + 0.25 \beta \hat{g}_p v(n), & \hat{g}_p > 0.5 \\ u(n), & \hat{g}_p \leq 0.5 \end{cases} \quad (70)$$ + +Adaptive gain control (AGC) is used to compensate for the gain difference between the non-emphasized excitation $u(n)$ and emphasized excitation $\hat{u}(n)$ . The gain scaling factor $\eta$ for the emphasized excitation is computed by: + +$$\eta = \begin{cases} \sqrt{\frac{\sum_{n=0}^{63} u^2(n)}{\sum_{n=0}^{63} \hat{u}^2(n)}}, & \hat{g}_p > 0.5, \\ 1.0, & \hat{g}_p \leq 0.5. \end{cases} \quad (71)$$ + +The gain-scaled emphasized excitation signal $\hat{u}'(n)$ is given by: + +$$\hat{u}'(n) = \hat{u}(n)\eta. \quad (72)$$ + +The reconstructed speech for the subframe of size 64 is given by + +$$\hat{s}(n) = \hat{u}(n) - \sum_{i=1}^{16} \hat{a}_i \hat{s}(n-i), \quad n = 0, \dots, 63. \quad (73)$$ + +where $\hat{a}_i$ are the interpolated LP filter coefficients. + +The synthesis speech $\hat{s}(n)$ is then passed through an adaptive postprocessing which is described in the following section. + +## 6.2 High-pass filtering, up-scaling and interpolation + +The high-pass filter serves as a precaution against undesired low frequency components. The signal is filtered through the high-pass filter $H_{h1}(z)$ and de-emphasis filter $H_{de\_emph}(z)$ . + +Finally, the signal is upsampled to 16 kHz to obtain the lower band synthesis signal $\hat{s}_{16k}(n)$ . $\hat{s}_{16k}(n)$ is produced by first upsampling the lower band synthesis $\hat{s}_{12.8k}(n)$ at 12.8 kHz by 5, then filtering the output through $H_{decim}(z)$ , and finally downsampling it by 4. + +(Up-scaling consists of multiplying the output from the high-pass filtering by a factor of 2 in order to compensate the down-scaling at the pre-processing stage.) + +## 6.3 High frequency band + +For the higher frequency band (6.4 – 7.0 kHz), excitation is generated to model the highest frequencies. The high frequency content is generated by filling the upper part of the spectrum with a white noise properly scaled in the excitation domain, then converted to the speech domain by shaping it with a filter derived from the same LP synthesis filter used for synthesizing the down-sampled signal. + +### 6.3.1 Generation of high-band excitation + +The high-band excitation is obtained by first generating white noise $u_{HB1}(n)$ . The power of the high-band excitation is set equal to the power of the lower band excitation $u_2(n)$ which means that + +$$u_{HB2}(n) = u_{HB1}(n) \sqrt{\sum_{k=0}^{63} u_2^2(k) / \sum_{k=0}^{63} u_{HB1}^2(k)}. \quad (74)$$ + +Finally the high-band excitation is found by + +$$u_{HB}(n) = \hat{g}_{HB} u_{HB2}(n), \quad (75)$$ + +where $\hat{g}_{HB}$ is a gain factor. + +In the 23.85 kbit/s mode, $\hat{g}_{HB}$ is decoded from the received gain index. + +In 6.60, 8.85, 12.65, 14.25, 15.85, 18.25, 19.85 and 23.05 kbit/s modes, $g_{HB}$ is estimated using voicing information bounded by [0.1, 1.0]. First, tilt of synthesis $e_{tilt}$ is found + +$$e_{tilt} = \sum_{n=1}^{63} \hat{s}_{hp}(n) \hat{s}_{hp}(n-1) / \sum_{n=0}^{63} \hat{s}_{hp}^2(n) \quad (76)$$ + +where $\hat{s}_{hp}(n)$ is high-pass filtered lower band speech synthesis $\hat{s}_{12.8k}(n)$ with cut-off frequency of 400 Hz. The $\hat{g}_{HB}$ is then found by + +$$g_{HB} = w_{SP} g_{SP} + (1 - w_{SP}) g_{BG}, \quad (77)$$ + +where $g_{SP} = 1 - e_{tilt}$ is gain for speech signal, $g_{BG} = 1.25 g_{SP}$ is gain for background noise signal, and $w_{SP}$ is a weighting function set to 1, when VAD is ON, and 0 when VAD is OFF. $g_{HB}$ is bounded between [0.1, 1.0]. In case of voiced segments where less energy is present at high frequencies, $e_{tilt}$ approaches 1 resulting in a lower gain $g_{HB}$ . This reduces the energy of the generated noise in case of voiced segments. + +### 6.3.2 LP filter for the high frequency band + +#### 6.3.2.1 6.60 kbit/s mode + +The high-band LP synthesis filter $A_{HB}(z)$ is found by extrapolating the quantized ISF vector $\mathbf{f}$ into 20th order ISF vector $\mathbf{f}_e$ . First, maximum of the autocorrelation $C_{max}(i)$ of ISF vector difference vector $f_{\Delta}(i) = f(i+1) - f(i), i = 1, \dots, 14$ is obtained. Then new 16kHz ISF vector $f'_e(i)$ is computed by + +$$f'_e(i) = \begin{cases} f(i-1), & i = 1, \dots, 15 \\ f'_e(i-1) + f'_e(i - C_{max}(i) - 1) - f'_e(i - C_{max}(i) - 2), & i = 16, \dots, 19 \end{cases} \quad (78)$$ + +An approximation of the last element of new ISF vector $f'_{e19}$ is updated based on lower frequency coefficients. New extrapolated ISF vector difference vector $f'_{e\Delta}(i)$ is + +$$f'_{e\Delta}(i) = c_{scale}(f'_e(i) - f'_e(i-1)), i = 16, \dots, 19, \quad (79)$$ + +where $c_{scale}$ scales $f'_{e\Delta}(i)$ so that $f'_e(19)$ will be equal to $f_{e19}$ . In order to insure stability, $f'_{e\Delta}(i)$ is bounded by + +$$f'_{e\Delta}(i) + f'_{e\Delta}(i-1) > 500, i = 17, \dots, 19. \quad (80)$$ + +Finally, the extrapolated ISF vector $\mathbf{f}_e$ is obtained by + +$$f_e(i) = \begin{cases} f(i), & i = 1, \dots, 15 \\ f'_{e\Delta}(i) + f_e(i-1), & i = 16, \dots, 19 \\ f(16), & i = 20 \end{cases} \quad (81)$$ + +$\mathbf{f}_e$ is converted to cosine domain to obtain $\mathbf{q}_e$ with 16000 Hz sampling rate. The high-band LP synthesis filter $A_{HB}(z)$ is obtained by converting $\mathbf{q}_e$ to LP filter as described in 5.2.4 with $m=20$ . + +#### 6.3.2.2 8.85, 12.65, 14.25, 15.85, 18.25, 19.85, 23.05 or 23.85 kbit/s modes + +The high-band LP synthesis filter $A_{HB}(z)$ is weighted low-band LP synthesis filter + +$$A_{HB}(z) = \hat{A}(z/0.8), \quad (82)$$ + +where $\hat{A}(z)$ is the interpolated LP synthesis filter. $\hat{A}(z)$ has been computed analysing signal with the sampling rate of 12.8 kHz but it is now used for a 16 kHz signal. Effectively, this means that the frequency response $FR_{16}(f)$ of $A_{HB}(z)$ is obtained by + +$$FR_{16}(f) = FR_{12.8}(\frac{12.8}{16} f), \quad (83)$$ + +where $FR_{12.8}(f)$ is the frequency response of $A(z)$ . This means that the band 5.1 – 5.6 kHz in 12.8 kHz domain will be mapped to 6.4 – 7.0 kHz in 16 kHz domain. + +### 6.3.3 High band synthesis + +$u_{HB}(n)$ is filtered through $A_{HB}(z)$ . The output of this high-band synthesis $s_{HB}(n)$ is filtered through a band-pass FIR filter $H_{HB}(z)$ which has the passband from 6 to 7 kHz. Finally, $s_{HB}$ is added to synthesized speech $\hat{s}_{16k}(n)$ to produce the synthesized output speech signal $\hat{s}_{output}(n)$ . + +# 7 Detailed bit allocation of the adaptive multi-rate wideband codec + +The detailed allocation of the bits in the adaptive multi-rate wideband speech encoder is shown for each mode in table 12a-12i. These tables show the order of the bits produced by the speech encoder. Note that the most significant bit (MSB) of each codec parameter is always sent first. + +**Table 12a: Source encoder output parameters in order of occurrence and bit allocation within the speech frame of 477 bits/20 ms, 23.85 kbit/s mode** + +| Bits (MSB-LSB) | Description | +|----------------|------------------------------------| +| s1 | VAD-flag | +| s2 – s9 | index of 1st ISP subvector | +| s10 – s17 | index of 2nd ISP subvector | +| s18 – s23 | index of 3rd ISP subvector | +| s24 – s30 | index of 4th ISP subvector | +| s31 – s37 | index of 5th ISP subvector | +| s38 – s42 | index of 6th ISP subvector | +| s43 – s47 | index of 7th ISP subvector | +| subframe 1 | | +| s48 – s56 | adaptive codebook index | +| s57 | LTP-filtering-flag | +| s58 – s68 | Codebook Index1 for track 1 | +| s69 – s79 | Codebook Index1 for track 2 | +| s80 – s90 | Codebook Index1 for track 3 | +| s91–s101 | Codebook Index1 for track 4 | +| s102–s112 | Codebook Index2 for track 1 | +| s113–s123 | Codebook Index2 for track 2 | +| s124 – s134 | Codebook Index2 for track 3 | +| s135 – s145 | Codebook Index2 for track 4 | +| s146 – s152 | codebook gains | +| s153 – s156 | High-band energy | +| subframe 2 | | +| s157 – s162 | adaptive codebook index (relative) | +| s163 – s262 | same description as s57 – s156 | +| subframe 3 | | +| s263 – s371 | same description as s48 – s156 | +| subframe 4 | | +| s372 – s477 | same description as s157 – s262 | + +**Table 12b: Source encoder output parameters in order of occurrence and bit allocation within the speech frame of 461 bits/20 ms, 23.05 kbit/s mode** + +| Bits (MSB-LSB) | Description | +|----------------|------------------------------------| +| s1 | VAD-flag | +| s2 – s9 | index of 1st ISP subvector | +| s10 – s17 | index of 2nd ISP subvector | +| s18 – s23 | index of 3rd ISP subvector | +| s24 – s30 | index of 4th ISP subvector | +| s31 – s37 | index of 5th ISP subvector | +| s38 – s42 | index of 6th ISP subvector | +| s43 – s47 | index of 7th ISP subvector | +| subframe 1 | | +| s48 – s56 | adaptive codebook index | +| s57 | LTP-filtering-flag | +| s58 – s68 | Codebook Index1 for track 1 | +| s69 – s79 | Codebook Index1 for track 2 | +| s80 – s90 | Codebook Index1 for track 3 | +| s91 – s101 | Codebook Index1 for track 4 | +| s102 – s112 | Codebook Index2 for track 1 | +| s113 – s123 | Codebook Index2 for track 2 | +| s124 – s134 | Codebook Index2 for track 3 | +| s135 – s145 | Codebook Index2 for track 4 | +| s146 – s152 | codebook gains | +| subframe 2 | | +| s153 – s158 | adaptive codebook index (relative) | +| s159 – s254 | same description as s57 – s152 | +| subframe 3 | | +| s255 – s359 | same description as s48 – s152 | +| subframe 4 | | +| s360 – s461 | same description as s153 – s254 | + +**Table 12c: Source encoder output parameters in order of occurrence and bit allocation within the speech frame of 397 bits/20 ms, 19.85 kbit/s mode** + +| Bits (MSB-LSB) | Description | +|----------------|------------------------------------| +| s1 | VAD-flag | +| s2 – s9 | index of 1st ISP subvector | +| s10 – s17 | index of 2nd ISP subvector | +| s18 – s23 | index of 3rd ISP subvector | +| s24 – s30 | index of 4th ISP subvector | +| s31 – s37 | index of 5th ISP subvector | +| s38 – s42 | index of 6th ISP subvector | +| s43 – s47 | index of 7th ISP subvector | +| subframe 1 | | +| s48 – s56 | adaptive codebook index | +| s57 | LTP-filtering-flag | +| s58 – s67 | Codebook Index1 for track 1 | +| s68 – s77 | Codebook Index1 for track 2 | +| s78 – s79 | Pulse Selector for track 3 | +| s80 – s81 | Pulse Selector for track 4 | +| s82 – s91 | Codebook index2 for track 1 | +| s92 – s101 | Codebook index2 for track 2 | +| s102 – s115 | Codebook index for track 3 | +| s116 – s129 | Codebook index for track 4 | +| s130 – s136 | VQ gain | +| subframe 2 | | +| s137 – s142 | adaptive codebook index (relative) | +| s143 – s222 | same description as s57 – s136 | +| subframe 3 | | +| s223 – s311 | same description as s48 – s136 | +| subframe 4 | | +| s312 – s397 | same description as s137 – s222 | + +**Table 12d: Source encoder output parameters in order of occurrence and bit allocation within the speech frame of 365 bits/20 ms, 18.25 kbit/s mode** + +| Bits (MSB-LSB) | Description | +|----------------|------------------------------------| +| s1 | VAD-flag | +| s2 – s9 | index of 1st ISP subvector | +| s10 – s17 | index of 2nd ISP subvector | +| s18 - s23 | index of 3rd ISP subvector | +| s24 – s30 | index of 4th ISP subvector | +| s31 – s37 | index of 5th ISP subvector | +| s38 – s42 | index of 6th ISP subvector | +| s43 – s47 | index of 7th ISP subvector | +| subframe 1 | | +| s48 – s56 | adaptive codebook index | +| s57 | LTP-filtering-flag | +| s58 – s59 | Pulse Selector for track 1 | +| s60 – s61 | Pulse Selector for track 2 | +| s62 – s63 | Pulse Selector for track 3 | +| s64 – s65 | Pulse Selector for track 4 | +| s66 – s79 | Codebook index for track 1 | +| s80 – s93 | Codebook index for track 2 | +| s94 – s107 | Codebook index for track 3 | +| s108 – s121 | Codebook index for track 4 | +| s122 – s128 | VQ gain | +| subframe 2 | | +| s129 – s134 | adaptive codebook index (relative) | +| s135 – s206 | same description as s57 – s128 | +| subframe 3 | | +| s207 – s287 | same description as s48 – s128 | +| subframe 4 | | +| s288 – s365 | same description as s129 – s206 | + +**Table 12e: Source encoder output parameters in order of occurrence and bit allocation within the speech frame of 317 bits/20 ms, 15.85 kbit/s mode** + +| Bits (MSB-LSB) | Description | +|----------------|------------------------------------| +| s1 | VAD-flag | +| s2 – s9 | index of 1st ISP subvector | +| s10 – s17 | index of 2nd ISP subvector | +| s18 - s23 | index of 3rd ISP subvector | +| s24 – s30 | index of 4th ISP subvector | +| s31 – s37 | index of 5th ISP subvector | +| s38 – s42 | index of 6th ISP subvector | +| s43 – s47 | index of 7th ISP subvector | +| subframe 1 | | +| s48 – s56 | adaptive codebook index | +| s57 | LTP-filtering-flag | +| s58 – s70 | Codebook index for track 1 | +| s71 – s83 | Codebook index for track 2 | +| s84 – s96 | Codebook index for track 3 | +| s97 – s109 | Codebook index for track 4 | +| s110 – s116 | VQ gain | +| subframe 2 | | +| s117 – s122 | adaptive codebook index (relative) | +| s123 – s182 | same description as s57 – s116 | +| subframe 3 | | +| s183 – s251 | same description as s48 – s116 | +| subframe 4 | | +| s252 – s317 | same description as s117 – s182 | + +**Table 12f: Source encoder output parameters in order of occurrence and bit allocation within the speech frame of 285 bits/20 ms, 14.25 kbit/s mode** + +| Bits (MSB-LSB) | Description | +|----------------|------------------------------------| +| s1 | VAD-flag | +| s2 – s9 | index of 1st ISP subvector | +| s10 – s17 | index of 2nd ISP subvector | +| s18 - s23 | index of 3rd ISP subvector | +| s24 – s30 | index of 4th ISP subvector | +| s31 – s37 | index of 5th ISP subvector | +| s38 – s42 | index of 6th ISP subvector | +| s43 – s47 | index of 7th ISP subvector | +| subframe 1 | | +| s48 – s56 | adaptive codebook index | +| s57 | LTP-filtering-flag | +| s58 – s70 | Codebook index for track 1 | +| s71 – s83 | Codebook index for track 2 | +| s84 – s92 | Codebook index for track 3 | +| s93 – s101 | Codebook index for track 4 | +| s102 – s108 | VQ gain | +| subframe 2 | | +| s109 – s114 | adaptive codebook index (relative) | +| s115 – s166 | same description as s57 – s108 | +| subframe 3 | | +| s167 – s227 | same description as s48 – s108 | +| subframe 4 | | +| s228 – s285 | same description as s109 – s166 | + +**Table 12g: Source encoder output parameters in order of occurrence and bit allocation within the speech frame of 253 bits/20 ms, 12.65 kbit/s mode** + +| Bits (MSB-LSB) | Description | +|----------------|------------------------------------| +| s1 | VAD-flag | +| s2 – s9 | index of 1st ISP subvector | +| s10 – s17 | index of 2nd ISP subvector | +| s18 - s23 | index of 3rd ISP subvector | +| s24 – s30 | index of 4th ISP subvector | +| s31 – s37 | index of 5th ISP subvector | +| s38 – s42 | index of 6th ISP subvector | +| s43 – s47 | index of 7th ISP subvector | +| subframe 1 | | +| s48 – s56 | adaptive codebook index | +| s57 | LTP-filtering-flag | +| s58 – s66 | Codebook index for track 1 | +| s67 – s75 | Codebook index for track 2 | +| s76 – s84 | Codebook index for track 3 | +| s85 – s93 | Codebook index for track 4 | +| s94 – s100 | VQ gain | +| subframe 2 | | +| s101 – s106 | adaptive codebook index (relative) | +| s107 – s150 | same description as s57 – s100 | +| subframe 3 | | +| s151 – s203 | same description as s48 – s100 | +| subframe 4 | | +| s204 – s253 | same description as s101 – s150 | + +**Table 12h: Source encoder output parameters in order of occurrence and bit allocation within the speech frame of 177 bits/20 ms, 8.85 kbit/s mode** + +| Bits (MSB-LSB) | Description | +|----------------|------------------------------------| +| s1 | VAD-flag | +| s2 – s9 | index of 1st ISP subvector | +| s10 – s17 | index of 2nd ISP subvector | +| s18 – s23 | index of 3rd ISP subvector | +| s24 – s30 | index of 4th ISP subvector | +| s31 – s37 | index of 5th ISP subvector | +| s38 – s42 | index of 6th ISP subvector | +| s43 – s47 | index of 7th ISP subvector | +| subframe 1 | | +| s48 – s55 | adaptive codebook index | +| s56 – s60 | Codebook index for track 1 | +| s61 – s65 | Codebook index for track 2 | +| s66 – s70 | Codebook index for track 3 | +| s71 – s75 | Codebook index for track 4 | +| s76 – s81 | VQ gain | +| subframe 2 | | +| s82 – s86 | adaptive codebook index (relative) | +| s87 – s112 | same description as s56 – s81 | +| subframe 3 | | +| s113 – s146 | same description as s48 – s81 | +| subframe 4 | | +| s147 – s177 | same description as s82 – s112 | + +**Table 12i: Source encoder output parameters in order of occurrence and bit allocation within the speech frame of 132 bits/20 ms, 6.60 kbit/s mode** + +| Bits (MSB-LSB) | Description | +|----------------|------------------------------------| +| s1 | VAD-flag | +| s2 – s9 | index of 1st ISP subvector | +| s10 – s17 | index of 2nd ISP subvector | +| s18 – s24 | index of 3rd ISP subvector | +| s25 – s31 | index of 4th ISP subvector | +| s32 – s37 | index of 5th ISP subvector | +| subframe 1 | | +| s38 – s45 | adaptive codebook index | +| s46 – 57 | Codebook Index | +| s58 – s63 | VQ gain | +| subframe 2 | | +| s64 – s68 | adaptive codebook index (relative) | +| s69 – s86 | same description as s46 – s63 | +| subframe 3 | | +| s87 – s109 | same description as s64 – s86 | +| subframe 4 | | +| s110 – s132 | same description as s64 – s86 | + +# 8 Homing sequences + +## 8.1 Functional description + +The adaptive multi-rate wideband speech codec is described in a bit-exact arithmetic to allow easy type approval as well as general testing of correct operation of the adaptive multi-rate wideband speech codec. + +The response of the codec to a predefined input sequence can only be foreseen if the internal state variables of the codec are in a predefined state at the beginning of the experiment. Therefore, the codec has to be put in a so called home state + +before a bit-exact test can be performed. This is usually done by a reset (a procedure in which the internal state variables of the codec are set to their defined initial values). The codec mode of the speech encoder and speech decoder shall be set to the tested codec mode by external means at reset. + +To allow a reset of the codec in remote locations, special homing frames have been defined for the encoder and the decoder, thus enabling a codec homing by inband signalling. + +The codec homing procedure is defined in such a way, that in either direction (encoder or decoder) the homing functions are called after the processing of the homing frame. The output corresponding to the first homing frame is therefore dependent on the used codec mode and the codec state when receiving that frame and hence usually not known. The response of the encoder to any further homing frame is by definition the corresponding decoder homing frame for the used codec mode. The response of the decoder to any further homing frame is by definition the encoder homing frame. This procedure allows homing of both the encoder and decoder from either side, if a loop back configuration is implemented, taking proper framing into account. + +## 8.2 Definitions + +**Encoder homing frame:** The encoder homing frame consists of 320 identical samples, each 13 bits long, with the least significant bit set to "one" and all other bits set to "zero". When written to 16-bit words with left justification, the samples have a value of 0008 hex. The speech decoder has to produce this frame as a response to the second and any further decoder homing frame if at least two decoder homing frames were input to the decoder consecutively. The encoder homing frame is identical for all codec modes. + +**Decoder homing frame:** There exist nine different decoder homing frames, which correspond to the nine AMR-WB codec modes. Using one of these codec modes, the corresponding decoder homing frame is the natural response of the speech encoder to the second and any further encoder homing frame if at least two encoder homing frames were input to the encoder consecutively. In [4], for each decoder homing frame the parameter values are given. + +## 8.3 Encoder homing + +Whenever the adaptive multi-rate wideband speech encoder receives at its input an encoder homing frame exactly aligned with its internal speech frame segmentation, the following events take place: + +- Step 1: The speech encoder performs its normal operation including VAD and SCR and produces in accordance with the used codec mode a speech parameter frame at its output which is in general unknown. But if the speech encoder was in its home state at the beginning of that frame, then the resulting speech parameter frame is identical to that decoder homing frame, which corresponds to the used codec mode (this is the way how the decoder homing frames were constructed). +- Step 2: After successful termination of that operation the speech encoder provokes the homing functions for all sub-modules including VAD and SCR and sets all state variables into their home state. On the reception of the next input frame, the speech encoder will start from its home state. + +NOTE: Applying a sequence of N encoder homing frames will cause at least N-1 decoder homing frames at the output of the speech encoder. + +## 8.4 Decoder homing + +Whenever the speech decoder receives at its input a decoder homing frame, which corresponds to the used codec mode, then the following events take place: + +- Step 1: The speech decoder performs its normal operation and produces a speech frame at its output which is in general unknown. But if the speech decoder was in its home state at the beginning of that frame, then the resulting speech frame is replaced by the encoder homing frame. This would not naturally be the case but is forced by this definition here. +- Step 2: After successful termination of that operation the speech decoder provokes the homing functions for all sub-modules including the comfort noise generator and sets all state variables into their home state. On the reception of the next input frame, the speech decoder will start from its home state. + +NOTE 1: Applying a sequence of N decoder homing frames will cause at least N-1 encoder homing frames at the output of the speech decoder. + +NOTE 2: By definition (!) the first frame of each decoder test sequence must differ from the decoder homing frame at least in one bit position within the parameters for LPC and first subframe. Therefore, if the decoder is in its home state, it is sufficient to check only these parameters to detect a subsequent decoder homing frame. This definition is made to support a delay-optimized implementation in the TRAU uplink direction. + +![Simplified block diagram of the CELP synthesis model. The diagram shows two input paths: an 'adaptive codebook' and a 'fixed codebook'. The adaptive codebook output is multiplied by a gain factor g_p to produce v(n). The fixed codebook output is multiplied by a gain factor g_c to produce c(n). These two signals are summed (+) to produce u(n). u(n) is then processed by an LP synthesis filter, represented by the transfer function \frac{1}{A(z)}, to produce the synthesized speech \hat{s}(n). Finally, \hat{s}(n) is processed by a 'post-processing' block. A feedback loop exists from the output of the summation back to the adaptive codebook.](1ce027dfd26183da52137cf990213724_img.jpg) + +Simplified block diagram of the CELP synthesis model. The diagram shows two input paths: an 'adaptive codebook' and a 'fixed codebook'. The adaptive codebook output is multiplied by a gain factor $g_p$ to produce $v(n)$ . The fixed codebook output is multiplied by a gain factor $g_c$ to produce $c(n)$ . These two signals are summed ( $+$ ) to produce $u(n)$ . $u(n)$ is then processed by an LP synthesis filter, represented by the transfer function $\frac{1}{A(z)}$ , to produce the synthesized speech $\hat{s}(n)$ . Finally, $\hat{s}(n)$ is processed by a 'post-processing' block. A feedback loop exists from the output of the summation back to the adaptive codebook. + +Figure 1 Simplified block diagram of the CELP synthesis model + +![Detailed block diagram of the ACELP encoder. The input 'speech input' is processed through a 'down-sample & HP filter' and 'pre-emphasis' to produce s(n). The signal s(n) is split into two main processing paths. The 'Lower band' path involves 'windowing & autocorrelation', 'Levinson-Durbin' (producing A(z) and ISP), conversion between ISP and ISF, 'ISF quantization' (outputting an 'ISF index'), and 'interpolation for 4 subframes'. The 'Higher band' path involves 'compute HB gain (23.85 kbit/s mode)' (outputting an 'HB gain index'). Both paths feed into a central processing block. This block includes 'compute target for adaptive codebook', 'find best delay and gain' (outputting a 'pitch index' and T0), 'compute adaptive codebook contribution', 'select adaptive codebook filter' (outputting a 'filt index'), 'compute impulse response', 'compute target for innovation' (outputting a 'code index'), 'find best innovation', 'compute excitation', 'gain vector quantization' (outputting a 'gain VQ index'), and 'update filter memories for next subframe'. The central block also receives feedback from the 'compute impulse response' and 'compute target for innovation' blocks. Signals x(n), x_2(n), and h(n) are labeled within the flow.](a3b3abbf6d0b18f3dd4a83680b5e3e42_img.jpg) + +Detailed block diagram of the ACELP encoder. The input 'speech input' is processed through a 'down-sample & HP filter' and 'pre-emphasis' to produce $s(n)$ . The signal $s(n)$ is split into two main processing paths. The 'Lower band' path involves 'windowing & autocorrelation', 'Levinson-Durbin' (producing $A(z)$ and $ISP$ ), conversion between $ISP$ and $ISF$ , 'ISF quantization' (outputting an 'ISF index'), and 'interpolation for 4 subframes'. The 'Higher band' path involves 'compute HB gain (23.85 kbit/s mode)' (outputting an 'HB gain index'). Both paths feed into a central processing block. This block includes 'compute target for adaptive codebook', 'find best delay and gain' (outputting a 'pitch index' and $T0$ ), 'compute adaptive codebook contribution', 'select adaptive codebook filter' (outputting a 'filt index'), 'compute impulse response', 'compute target for innovation' (outputting a 'code index'), 'find best innovation', 'compute excitation', 'gain vector quantization' (outputting a 'gain VQ index'), and 'update filter memories for next subframe'. The central block also receives feedback from the 'compute impulse response' and 'compute target for innovation' blocks. Signals $x(n)$ , $x_2(n)$ , and $h(n)$ are labeled within the flow. + +Figure 2 Detailed block diagram of the ACELP encoder + +![Detailed block diagram of the ACELP decoder. The diagram is split into two horizontal sections by a dashed line: 'Lower band' (top) and 'Higher band' (bottom). In the lower band, inputs include 'ISF index', 'pitch index', 'gain VQ index', and 'code index'. These pass through 'decode ISP', 'decode adaptive codebook', 'decode gains', and 'decode innovative codebook' respectively. The outputs of 'decode adaptive codebook', 'decode gains', and 'decode innovative codebook' are summed in 'construct excitation'. A 'filtering index' also feeds into an 'LTP filter' which provides an additional input to 'construct excitation'. The output of 'construct excitation' goes through 'post-processing' to 'synthesis filter', producing \hat{s}(n). This signal then passes through 'de-emphasis', 'up-sample', and is summed with the higher band output to produce the final 'speech output'. An 'ISP' block with \hat{A}(z) also feeds into the 'synthesis filter'. A label '(6.60 kbit/s mode)' is present near the synthesis filter. In the higher band, a '16 kHz random excitation' block feeds into 'gain scaling'. 'VAD flag' and 'HB gain index' also feed into 'gain scaling'. The output of 'gain scaling' goes through 'HB-synthesis filter' and then 'BP filter' before being summed with the lower band output.](3442f31a562d1ef45bfa18b18a6a1ddc_img.jpg) + +Detailed block diagram of the ACELP decoder. The diagram is split into two horizontal sections by a dashed line: 'Lower band' (top) and 'Higher band' (bottom). In the lower band, inputs include 'ISF index', 'pitch index', 'gain VQ index', and 'code index'. These pass through 'decode ISP', 'decode adaptive codebook', 'decode gains', and 'decode innovative codebook' respectively. The outputs of 'decode adaptive codebook', 'decode gains', and 'decode innovative codebook' are summed in 'construct excitation'. A 'filtering index' also feeds into an 'LTP filter' which provides an additional input to 'construct excitation'. The output of 'construct excitation' goes through 'post-processing' to 'synthesis filter', producing $\hat{s}(n)$ . This signal then passes through 'de-emphasis', 'up-sample', and is summed with the higher band output to produce the final 'speech output'. An 'ISP' block with $\hat{A}(z)$ also feeds into the 'synthesis filter'. A label '(6.60 kbit/s mode)' is present near the synthesis filter. In the higher band, a '16 kHz random excitation' block feeds into 'gain scaling'. 'VAD flag' and 'HB gain index' also feed into 'gain scaling'. The output of 'gain scaling' goes through 'HB-synthesis filter' and then 'BP filter' before being summed with the lower band output. + +Figure 3 Detailed block diagram of the ACELP decoder + +# 9 Bibliography + +- 1) M.R. Schroeder and B.S. Atal, "Code-Excited Linear Prediction (CELP): High quality speech at very low bit rates," in *Proc. ICASSP'85*, pp. 937-940, 1985. +- 2) L.R. Rabiner and R.W. Schaefer. *Digital processing of speech signals*. Prentice-Hall Int., 1978. +- 3) F. Itakura, "Line spectral representation of linear predictive coefficients of speech signals," *J. Acoust. Soc. Amer.*, vol. 57, Supplement no. 1, S35, 1975. +- 4) Y. Bistriz and S. Pellerm, "Immittance Spectral Pairs (ISP) for speech encoding," in *Proc. ICASSP'93*, pp. II-9 - II-12. +- 5) K.K Paliwal and B.S. Atal, "Efficient vector quantization of LPC parameters at 24 bits/frame", *IEEE Trans. Speech and Audio Processing*, vol. 1, no 1, pp. 3-14, 1993. +- 6) P. Kabal and R.P. Ramachandran, "The computation of line spectral frequencies using Chebyshev polynomials", *IEEE Trans. on ASSP*, vol. 34, no. 6, pp. 1419-1426, Dec. 1986. +- 7) K. Järvinen, J. Vainio, P. Kapanen, T. Honkanen, P. Haavisto, R. Salami, C. Laflamme, and J.-P. Adoul, "GSM enhanced full rate speech codec", in *Proc. ICASSP'97*, pp. 771-774. +- 8) T. Honkanen, J. Vainio, K. Järvinen, P. Haavisto, R. Salami, C. Laflamme, and J.-P. Adoul, "Enhanced full rate speech codec for IS-136 digital cellular system", in *Proc. ICASSP'97*, pp. 731-734. +- 9) R. Hagen, E. Ekudden, B. Johansson, and W.B. Kleijn, "Removal of sparse-excitation artifacts in CELP", in *Proc. ICASSP'98*, pp. I-145-I-148. \ No newline at end of file diff --git a/marked/Rel-18/26_series/26501/030c758fd425016b03290c8f11bef69d_img.jpg b/marked/Rel-18/26_series/26501/030c758fd425016b03290c8f11bef69d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..28711914b1ba0a420defec71903371a8f0ac5f62 --- /dev/null +++ b/marked/Rel-18/26_series/26501/030c758fd425016b03290c8f11bef69d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bf9f953c783ed1a53e60b09af91c3db47fb393113a56a853161039e835a81724 +size 96760 diff --git a/marked/Rel-18/26_series/26501/037f0f683efaa7f7d98458c351d3ce6b_img.jpg b/marked/Rel-18/26_series/26501/037f0f683efaa7f7d98458c351d3ce6b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..443aab039f7e09c9b08a2fb033e0f959516c5293 --- /dev/null +++ b/marked/Rel-18/26_series/26501/037f0f683efaa7f7d98458c351d3ce6b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6aee9a537555932b939813d81884eaa3e827a758e0cb5efc53445665ebcef7f3 +size 126385 diff --git a/marked/Rel-18/26_series/26501/0721cf4aa4a4582a03f2d132f3fdb523_img.jpg b/marked/Rel-18/26_series/26501/0721cf4aa4a4582a03f2d132f3fdb523_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..56401e9217dcb6988d136c8290d382824813ba4e --- /dev/null +++ b/marked/Rel-18/26_series/26501/0721cf4aa4a4582a03f2d132f3fdb523_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:55418d5b572c9176b805713e559c86f4d0d7ba02cd569d4945cfa659fba6e00d +size 189460 diff --git a/marked/Rel-18/26_series/26501/0ad1b90f313a822e42d66a872e981b42_img.jpg b/marked/Rel-18/26_series/26501/0ad1b90f313a822e42d66a872e981b42_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9f34af20ad0275d532a2263c374888d434033f85 --- /dev/null +++ b/marked/Rel-18/26_series/26501/0ad1b90f313a822e42d66a872e981b42_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a1e738e9d64796e7368b1d63ce446158347060ba0f4e7ce6b612affdb8dac5d1 +size 42917 diff --git a/marked/Rel-18/26_series/26501/0ee9d674085524d589646a6c3fb21ec3_img.jpg b/marked/Rel-18/26_series/26501/0ee9d674085524d589646a6c3fb21ec3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1341ad79767f9788910b9b832ef6e7f0ed00b0d5 --- /dev/null +++ b/marked/Rel-18/26_series/26501/0ee9d674085524d589646a6c3fb21ec3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:62f2c1475fc8be1060cbc3d8fb0625e02cc2c001d030cd0b115f530270065638 +size 70645 diff --git a/marked/Rel-18/26_series/26501/0f666d2ebbad7fab84c7c4fb531ea932_img.jpg b/marked/Rel-18/26_series/26501/0f666d2ebbad7fab84c7c4fb531ea932_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..536ae76c9963ca3194a389ac5dde7525c4c1cfd1 --- /dev/null +++ b/marked/Rel-18/26_series/26501/0f666d2ebbad7fab84c7c4fb531ea932_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:16d96ba8da7f74fe1ce7af4fe8c76accd9c0ff1138f4b9f0215e646d2ef9ef0f +size 80826 diff --git a/marked/Rel-18/26_series/26501/140bd031d724324269168296afd1e04d_img.jpg b/marked/Rel-18/26_series/26501/140bd031d724324269168296afd1e04d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f5f39295be3cf3c4543a37d6a762b5060564756f --- /dev/null +++ b/marked/Rel-18/26_series/26501/140bd031d724324269168296afd1e04d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe89699f425d682e6f7011fe31789dd9078724f4939b555165cde16c341d5c35 +size 138241 diff --git a/marked/Rel-18/26_series/26501/1841f348dfa81a3438d4e1f8465d9ac7_img.jpg b/marked/Rel-18/26_series/26501/1841f348dfa81a3438d4e1f8465d9ac7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..336613e9afd36cc8f0bdffedeaf22167e765393a --- /dev/null +++ b/marked/Rel-18/26_series/26501/1841f348dfa81a3438d4e1f8465d9ac7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:98c2e0d65cf0d1b175d6a80b1ec7dd6a38abb0d464c97635474f828e5caed78d +size 56272 diff --git a/marked/Rel-18/26_series/26501/2233ee3811b41289f9d88618078aa4d2_img.jpg b/marked/Rel-18/26_series/26501/2233ee3811b41289f9d88618078aa4d2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fda6e38ed4c2c7611e72185d5d05c7811ac2b225 --- /dev/null +++ b/marked/Rel-18/26_series/26501/2233ee3811b41289f9d88618078aa4d2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2ba3cbf6c60d22604223c61430620973e53b1300f96684962ad53b4489dc4a20 +size 196482 diff --git a/marked/Rel-18/26_series/26501/235e996e83e7d5198cf9d909f5713cdd_img.jpg b/marked/Rel-18/26_series/26501/235e996e83e7d5198cf9d909f5713cdd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..021fe6d8698c635d59e1a8a0b8215dec2a8e3e2b --- /dev/null +++ b/marked/Rel-18/26_series/26501/235e996e83e7d5198cf9d909f5713cdd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d8414dd463b28ff004c62d66a20ea8949a01c0b0e2b854f205ef06bb09e561c +size 50152 diff --git a/marked/Rel-18/26_series/26501/27fc71a666ffdf8fdc4ce84d9d585008_img.jpg b/marked/Rel-18/26_series/26501/27fc71a666ffdf8fdc4ce84d9d585008_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..050256d47eebf7663156f4d8417726e6eebe7233 --- /dev/null +++ b/marked/Rel-18/26_series/26501/27fc71a666ffdf8fdc4ce84d9d585008_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8af19965d89f62543ce196cdcc730af958b6c935a8d098e991f8377c10515c5f +size 43291 diff --git a/marked/Rel-18/26_series/26501/29178b001cb4c04e0c5ab60662ce5d80_img.jpg b/marked/Rel-18/26_series/26501/29178b001cb4c04e0c5ab60662ce5d80_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..845762eb357a05ddf711760f0ddc618c4699801b --- /dev/null +++ b/marked/Rel-18/26_series/26501/29178b001cb4c04e0c5ab60662ce5d80_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:236b5b6427ac16e74e6ac6c34804a280406f9766e1cee35717ede00328edab48 +size 108096 diff --git a/marked/Rel-18/26_series/26501/3198cdf0dbe501c46fe0e4073c7d8451_img.jpg b/marked/Rel-18/26_series/26501/3198cdf0dbe501c46fe0e4073c7d8451_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eb089ba6a45ade02ba14a8812e5a988136de4190 --- /dev/null +++ b/marked/Rel-18/26_series/26501/3198cdf0dbe501c46fe0e4073c7d8451_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:934737c50dc1389cd90091f2028f6ca0cf4a28c86f72296c9f69a18dd3d98447 +size 62208 diff --git a/marked/Rel-18/26_series/26501/33a8f3f01dfa8bce75d23017855a13c5_img.jpg b/marked/Rel-18/26_series/26501/33a8f3f01dfa8bce75d23017855a13c5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3198bf11c2a51a5750b5b48bb230d8d9715ef30b --- /dev/null +++ b/marked/Rel-18/26_series/26501/33a8f3f01dfa8bce75d23017855a13c5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:46d2d5f8789fe30fc5f4244f044356df4e42bc6d76607596347a92ad1cb04a98 +size 40530 diff --git a/marked/Rel-18/26_series/26501/4bb669bb31262e53e4f3c8ec0fd7624a_img.jpg b/marked/Rel-18/26_series/26501/4bb669bb31262e53e4f3c8ec0fd7624a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..087ac30a2153fc18078c89020ccd9554ee865548 --- /dev/null +++ b/marked/Rel-18/26_series/26501/4bb669bb31262e53e4f3c8ec0fd7624a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ca8ba7b47e6042f2ab72c0bc9823ed273d2273e123bd3844bd12e6d99ad0be6 +size 103193 diff --git a/marked/Rel-18/26_series/26501/521e2e9d53a2d9c4b3e22d151d46ee23_img.jpg b/marked/Rel-18/26_series/26501/521e2e9d53a2d9c4b3e22d151d46ee23_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6f63ea197291a423bc3b16d6d21750e51e5fd472 --- /dev/null +++ b/marked/Rel-18/26_series/26501/521e2e9d53a2d9c4b3e22d151d46ee23_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d8829faa9f66227d44afa0efa842d935b391ff2be76db8fc2d4255838eca1436 +size 141507 diff --git a/marked/Rel-18/26_series/26501/54d030ecf3f147af8773b8a23549856e_img.jpg b/marked/Rel-18/26_series/26501/54d030ecf3f147af8773b8a23549856e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4f251c7601358693c9529b6188847f7c8b60b0da --- /dev/null +++ b/marked/Rel-18/26_series/26501/54d030ecf3f147af8773b8a23549856e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4120a1fbb88b4aa02593e7eade6b59fa29dbebd6da0c14e37ebe8bd2b0ab9587 +size 111389 diff --git a/marked/Rel-18/26_series/26501/56a5265d174ce056c1dbe5e7a60839fc_img.jpg b/marked/Rel-18/26_series/26501/56a5265d174ce056c1dbe5e7a60839fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3fe5feb6cd5fcb199bd09bf9abcb89274907b67c --- /dev/null +++ b/marked/Rel-18/26_series/26501/56a5265d174ce056c1dbe5e7a60839fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:62558fb20ec3625caabd8f65c76490000af7c07b192993bef75e76b49189e55f +size 79983 diff --git a/marked/Rel-18/26_series/26501/60f844d947ea0bccdd9f64d81d5f8d26_img.jpg b/marked/Rel-18/26_series/26501/60f844d947ea0bccdd9f64d81d5f8d26_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cba94e8629e69960d6aef161d5f9336e64ba3e98 --- /dev/null +++ b/marked/Rel-18/26_series/26501/60f844d947ea0bccdd9f64d81d5f8d26_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6b1c90aa210e6599b4e213ba1b0c2e27b8832de7da9e327646a926e097f49e91 +size 114183 diff --git a/marked/Rel-18/26_series/26501/65b5e4a95d403df0ea5e8ff94f162a6a_img.jpg b/marked/Rel-18/26_series/26501/65b5e4a95d403df0ea5e8ff94f162a6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..717fbfed9e54883ea12ddace8d850f3916b02836 --- /dev/null +++ b/marked/Rel-18/26_series/26501/65b5e4a95d403df0ea5e8ff94f162a6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cc4d4e153f703cb82fd3fe4e62c150a754aacf538de96d147a903de58c135da7 +size 205811 diff --git a/marked/Rel-18/26_series/26501/6cdb31bed6791fa0bd3fbc1e583b07ed_img.jpg b/marked/Rel-18/26_series/26501/6cdb31bed6791fa0bd3fbc1e583b07ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2c3684144991512b4c23f5bc7b3a203bec4ddaa3 --- /dev/null +++ b/marked/Rel-18/26_series/26501/6cdb31bed6791fa0bd3fbc1e583b07ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7f8b263b26dbffda17cdd7139b0db96b65d59fc2a1a9561e66530314d0f6ecfe +size 111954 diff --git a/marked/Rel-18/26_series/26501/74fd2e41231630ea45706acca03e46f7_img.jpg b/marked/Rel-18/26_series/26501/74fd2e41231630ea45706acca03e46f7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ae3ede5c2dd759b091ea8460ad67822eea28b5ba --- /dev/null +++ b/marked/Rel-18/26_series/26501/74fd2e41231630ea45706acca03e46f7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da9b5fec3ca7d73b9237c29aa63b6117856ae24351c7114a2309570d472de65e +size 164684 diff --git a/marked/Rel-18/26_series/26501/750b1652a4f4791b84c02aa755a1dedd_img.jpg b/marked/Rel-18/26_series/26501/750b1652a4f4791b84c02aa755a1dedd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c975deb7a8e000878c658f7e8323e029159d698 --- /dev/null +++ b/marked/Rel-18/26_series/26501/750b1652a4f4791b84c02aa755a1dedd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7798f5cc3609200d3b8385499e400429b8959f2b026fff99b04e58fcee7bcc0f +size 163532 diff --git a/marked/Rel-18/26_series/26501/80a44321a02e8a7d638ac9d53e88772c_img.jpg b/marked/Rel-18/26_series/26501/80a44321a02e8a7d638ac9d53e88772c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..498e88401fc1e108e5e98370cf458d6ff29c2510 --- /dev/null +++ b/marked/Rel-18/26_series/26501/80a44321a02e8a7d638ac9d53e88772c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:369e588ab0c66817e12fce2f3fd527517118faa641048284c54be65f526fab74 +size 64800 diff --git a/marked/Rel-18/26_series/26501/8650b869a9e7291ac2caad3d008e1770_img.jpg b/marked/Rel-18/26_series/26501/8650b869a9e7291ac2caad3d008e1770_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9146e4f56a01014a327f875c2874468b1f2a8a7b --- /dev/null +++ b/marked/Rel-18/26_series/26501/8650b869a9e7291ac2caad3d008e1770_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f05f41ae41df6707af0cbd7c4d4ec713dd74b4140b249486348a3ce823f23ca7 +size 81570 diff --git a/marked/Rel-18/26_series/26501/8e2b6b0d92809964fe902cdb1272fb39_img.jpg b/marked/Rel-18/26_series/26501/8e2b6b0d92809964fe902cdb1272fb39_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..615f4f08d8def2e3342d1417b479bf5bbf35d7b5 --- /dev/null +++ b/marked/Rel-18/26_series/26501/8e2b6b0d92809964fe902cdb1272fb39_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d4c14dfa1090e5a1e7c254831ce9453ed719bad06a4111304f33e32529972994 +size 120932 diff --git a/marked/Rel-18/26_series/26501/980bb58dd1ca6ebc05e4cd2685997250_img.jpg b/marked/Rel-18/26_series/26501/980bb58dd1ca6ebc05e4cd2685997250_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3448a56814b36272e9b2ba7d98aaab77acc8b3cd --- /dev/null +++ b/marked/Rel-18/26_series/26501/980bb58dd1ca6ebc05e4cd2685997250_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4086deb2c88a534104ba135fdd744b09d7000b5f252ed5c3e163e5610dbe39b8 +size 54273 diff --git a/marked/Rel-18/26_series/26501/9af97997b7d3fbca90b8ddba0ea39c6c_img.jpg b/marked/Rel-18/26_series/26501/9af97997b7d3fbca90b8ddba0ea39c6c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..56155e67cfb67a152e9ac7540c5b1b131c17674a --- /dev/null +++ b/marked/Rel-18/26_series/26501/9af97997b7d3fbca90b8ddba0ea39c6c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1065e17bd69f9a780d3f6b2d7892925aa997e7f5d07d92cf9824622cf5d70f54 +size 41178 diff --git a/marked/Rel-18/26_series/26501/9b62a616c7a1097c5da57f001ab6dd64_img.jpg b/marked/Rel-18/26_series/26501/9b62a616c7a1097c5da57f001ab6dd64_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..93d9a04f12021bf337e0ea117e824b1a3e44e5de --- /dev/null +++ b/marked/Rel-18/26_series/26501/9b62a616c7a1097c5da57f001ab6dd64_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8e5d4083affd4eb7de83736be0fee7295e67e16262f1ba3849466b24f8ec95da +size 39634 diff --git a/marked/Rel-18/26_series/26501/9b6977f95ef47e2c87cd4979c09a7edb_img.jpg b/marked/Rel-18/26_series/26501/9b6977f95ef47e2c87cd4979c09a7edb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df9d6fbfe3dbbf6fa2e514f1be1df58da1ef8cb9 --- /dev/null +++ b/marked/Rel-18/26_series/26501/9b6977f95ef47e2c87cd4979c09a7edb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ba22c169e5237daa3e4d6452d363b1063f82354c841b37061a8f1c86c4479604 +size 161673 diff --git a/marked/Rel-18/26_series/26501/9d82cdfb435ec7bce0aee96333f34ea6_img.jpg b/marked/Rel-18/26_series/26501/9d82cdfb435ec7bce0aee96333f34ea6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a9043ccbcf6829c83b25c1bfc475620841902336 --- /dev/null +++ b/marked/Rel-18/26_series/26501/9d82cdfb435ec7bce0aee96333f34ea6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:16728ab8745d1bcba7d27b993319d53ffde7c683c24800eda0e0ea4f082e681a +size 45333 diff --git a/marked/Rel-18/26_series/26501/a4c80b98452e7949d9f8d969dc9cebf7_img.jpg b/marked/Rel-18/26_series/26501/a4c80b98452e7949d9f8d969dc9cebf7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..056ca7ed29853fd7a9faeb451d5dcc65c6165dc8 --- /dev/null +++ b/marked/Rel-18/26_series/26501/a4c80b98452e7949d9f8d969dc9cebf7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:085b34b69cd9a17bd80b8ab525f2c9e4552aa57a4e1ea62044724854bc5ab1f5 +size 94706 diff --git a/marked/Rel-18/26_series/26501/a76fd8608a1490167e6c1a4ed32b38e6_img.jpg b/marked/Rel-18/26_series/26501/a76fd8608a1490167e6c1a4ed32b38e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..505f62d0f72fbc9ac7bd574a77ad7b372f24312b --- /dev/null +++ b/marked/Rel-18/26_series/26501/a76fd8608a1490167e6c1a4ed32b38e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1242ceb154685a421b36c3329203b484caab684839a6224a0a163c49d5fd6b6e +size 54533 diff --git a/marked/Rel-18/26_series/26501/a9da82b13d607bfad1f953459bffac76_img.jpg b/marked/Rel-18/26_series/26501/a9da82b13d607bfad1f953459bffac76_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..39997e5cd94755213dc12fd3dd42f1fe8e65c865 --- /dev/null +++ b/marked/Rel-18/26_series/26501/a9da82b13d607bfad1f953459bffac76_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0ae0a9caa997997bd73986f26f28f227cf09d244bede5c1898cd53d52c3f7841 +size 43023 diff --git a/marked/Rel-18/26_series/26501/b55656f01d98097862b9e6d8461ec59b_img.jpg b/marked/Rel-18/26_series/26501/b55656f01d98097862b9e6d8461ec59b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9a0a15c6a088b09d770359b287e9d0c388bd2843 --- /dev/null +++ b/marked/Rel-18/26_series/26501/b55656f01d98097862b9e6d8461ec59b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d5ea8f0847485fe64cd10d11f0b15a8460fba8d456f6e9b391e14f10d87521c2 +size 41081 diff --git a/marked/Rel-18/26_series/26501/bb3354f497635d15bef873577125c48d_img.jpg b/marked/Rel-18/26_series/26501/bb3354f497635d15bef873577125c48d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7400fb13addae2eaca452a64a2b5a96a4656a7b1 --- /dev/null +++ b/marked/Rel-18/26_series/26501/bb3354f497635d15bef873577125c48d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:28cdcf97a9f10f061f960fbb7305185ee302540e7c591149528d10ee6cf595c9 +size 55855 diff --git a/marked/Rel-18/26_series/26501/c07e21a8d65991db04263322f859c94f_img.jpg b/marked/Rel-18/26_series/26501/c07e21a8d65991db04263322f859c94f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..604bdec823e2d0890a7f1f2c5e770e00fba06f6f --- /dev/null +++ b/marked/Rel-18/26_series/26501/c07e21a8d65991db04263322f859c94f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d43d4bb060b505c8b4e6be5201215a5b9c9e9502b2a71457320ee2054a11539b +size 192148 diff --git a/marked/Rel-18/26_series/26501/c1278da91cbcabe32628e589ebc47418_img.jpg b/marked/Rel-18/26_series/26501/c1278da91cbcabe32628e589ebc47418_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ea9fb0f399d05f84242670dce54aef079be81428 --- /dev/null +++ b/marked/Rel-18/26_series/26501/c1278da91cbcabe32628e589ebc47418_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:28c666125abd8ed2a85c157671e46260ee2b4c44e80a73859f3d0908ae9cf703 +size 99291 diff --git a/marked/Rel-18/26_series/26501/c15cb6383bc35906e6b3c7c3aac621ed_img.jpg b/marked/Rel-18/26_series/26501/c15cb6383bc35906e6b3c7c3aac621ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f13961166c71f550119afd5ffafa3867cbb0d271 --- /dev/null +++ b/marked/Rel-18/26_series/26501/c15cb6383bc35906e6b3c7c3aac621ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0d9f809663b528e7d90a01f040ced58db82b5103bf3d661b806789b146787727 +size 66388 diff --git a/marked/Rel-18/26_series/26501/c40637b9f0bcae2d6e1268f104168127_img.jpg b/marked/Rel-18/26_series/26501/c40637b9f0bcae2d6e1268f104168127_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7173b014f77fa26df5e878bd78814b284559abd9 --- /dev/null +++ b/marked/Rel-18/26_series/26501/c40637b9f0bcae2d6e1268f104168127_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e2e2764e6d43c263728f26d4e548c7a253ede6fa8ea42600222350568eb6e3b +size 181117 diff --git a/marked/Rel-18/26_series/26501/ce58a77ff34d610cd0634eacffbd3eaf_img.jpg b/marked/Rel-18/26_series/26501/ce58a77ff34d610cd0634eacffbd3eaf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f6a7fbc3bbf8cd005b5fd1125edc49307a05c790 --- /dev/null +++ b/marked/Rel-18/26_series/26501/ce58a77ff34d610cd0634eacffbd3eaf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:78e1eec1631b6e153f3effc6f3c6c378818658ac4e89f1bd04da985d4c6aa710 +size 191720 diff --git a/marked/Rel-18/26_series/26501/cf00e75c6befaeeb8f139f87d86252eb_img.jpg b/marked/Rel-18/26_series/26501/cf00e75c6befaeeb8f139f87d86252eb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..481ac147018cad04121e7fc47274c7d37c877d95 --- /dev/null +++ b/marked/Rel-18/26_series/26501/cf00e75c6befaeeb8f139f87d86252eb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:95116bd603c8b294f120962f069d9efad41290c27d9e304dc3f8d89028ec3443 +size 44733 diff --git a/marked/Rel-18/26_series/26501/cf8650780cc9719622f013f33967b37c_img.jpg b/marked/Rel-18/26_series/26501/cf8650780cc9719622f013f33967b37c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c46126293adb0241d54b43001d559ee9affeaaf7 --- /dev/null +++ b/marked/Rel-18/26_series/26501/cf8650780cc9719622f013f33967b37c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:817572e1c5913b11c94a13501fc380bdd30d1783bb5d3ebf8b54d1f7b5705667 +size 141240 diff --git a/marked/Rel-18/26_series/26501/d2417b04116c354deccb25d98a84a0fb_img.jpg b/marked/Rel-18/26_series/26501/d2417b04116c354deccb25d98a84a0fb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8e1be7b8402b33f8e9df99148dd72ecbf4e89c42 --- /dev/null +++ b/marked/Rel-18/26_series/26501/d2417b04116c354deccb25d98a84a0fb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b3a5475f10e47d3d3243f124f40c439271105830bd82dbf2ee1e98320705675 +size 180205 diff --git a/marked/Rel-18/26_series/26501/d6c377ae3e619ff992bd3647dbf43593_img.jpg b/marked/Rel-18/26_series/26501/d6c377ae3e619ff992bd3647dbf43593_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..db594c6e8b0ac4b3ee38b3eeb66a4c1798e56acd --- /dev/null +++ b/marked/Rel-18/26_series/26501/d6c377ae3e619ff992bd3647dbf43593_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:35ce7c337e56007fce2a0fcc51951a275b6412f4b97dd1fb677e5a45f2a6cbde +size 141292 diff --git a/marked/Rel-18/26_series/26501/dd5771673aececa53d42ece89218299d_img.jpg b/marked/Rel-18/26_series/26501/dd5771673aececa53d42ece89218299d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c787dcd81a10764893d21b8daff57bbc7c2d259e --- /dev/null +++ b/marked/Rel-18/26_series/26501/dd5771673aececa53d42ece89218299d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b9af40203b6ada81222eb3357d970f9d63acbb1be65689dd0f84742c4ff18aa7 +size 91608 diff --git a/marked/Rel-18/26_series/26501/e67f460676b783e7bf400213fe55066e_img.jpg b/marked/Rel-18/26_series/26501/e67f460676b783e7bf400213fe55066e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2c60e8267d8185b530e4af9eaa53863bb127845e --- /dev/null +++ b/marked/Rel-18/26_series/26501/e67f460676b783e7bf400213fe55066e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c4dcfab615d4dd728637bb4319344502c1e833c6f8c9eb5f2f597133aca4837f +size 43509 diff --git a/marked/Rel-18/26_series/26501/e90987faabad6a6665cd8ed1151dc474_img.jpg b/marked/Rel-18/26_series/26501/e90987faabad6a6665cd8ed1151dc474_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9534586605f1f0fc039cb9769bfd534258ba6869 --- /dev/null +++ b/marked/Rel-18/26_series/26501/e90987faabad6a6665cd8ed1151dc474_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a98e880e78a88f007a83f40ebbe7e1aca11629bf9fa80cbe9869881485474aa8 +size 69618 diff --git a/marked/Rel-18/26_series/26501/ecae674475cecdd0962200a5d1e2591e_img.jpg b/marked/Rel-18/26_series/26501/ecae674475cecdd0962200a5d1e2591e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cfbb3da998701027d31067a09144875509a65bed --- /dev/null +++ b/marked/Rel-18/26_series/26501/ecae674475cecdd0962200a5d1e2591e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ddbe31a2c830471233dd2053876b21d1f2954129a4cd8c283ee19d513982e63 +size 84417 diff --git a/marked/Rel-18/26_series/26501/ed9611ee491e3022629ab4f745c89f60_img.jpg b/marked/Rel-18/26_series/26501/ed9611ee491e3022629ab4f745c89f60_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..22b0b86e597079e353a45cedc1438b3b11d3b0fc --- /dev/null +++ b/marked/Rel-18/26_series/26501/ed9611ee491e3022629ab4f745c89f60_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4152e14ea9c33e155d4d76b0afa2fe8a0a2b88ae1df808cd8aa11894523cd392 +size 99548 diff --git a/marked/Rel-18/26_series/26501/efb282bed9f06eef1987a14fb27bc599_img.jpg b/marked/Rel-18/26_series/26501/efb282bed9f06eef1987a14fb27bc599_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9ecea518a25cd4f13085fe90d390c65edaebe12c --- /dev/null +++ b/marked/Rel-18/26_series/26501/efb282bed9f06eef1987a14fb27bc599_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:76d71cc97e2df0ad49b622decdd252c7e83b235377ecca5eba7a1649b77797ac +size 188594 diff --git a/marked/Rel-18/26_series/26501/f0246e61caa2250c480349cf17ee8ee6_img.jpg b/marked/Rel-18/26_series/26501/f0246e61caa2250c480349cf17ee8ee6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c77baf0377526212eb9fde3a42f00487b4df7290 --- /dev/null +++ b/marked/Rel-18/26_series/26501/f0246e61caa2250c480349cf17ee8ee6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8f2f2c90fe086df2393229229e665a223748d5453ad0cc8dd3374f1fb5327d85 +size 71440 diff --git a/marked/Rel-18/26_series/26501/f21295f56ab9da5a7ea269beb8cf4afe_img.jpg b/marked/Rel-18/26_series/26501/f21295f56ab9da5a7ea269beb8cf4afe_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8fe5133acabbe2117b1fb2047c7985fd08a13e78 --- /dev/null +++ b/marked/Rel-18/26_series/26501/f21295f56ab9da5a7ea269beb8cf4afe_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d51333b6efe3286f1b36766b17a66bd1c41b62001d93b4c6569c8658c46b103 +size 40593 diff --git a/marked/Rel-18/26_series/26501/f512ae9c630f2fb53197fa77a1bda0e8_img.jpg b/marked/Rel-18/26_series/26501/f512ae9c630f2fb53197fa77a1bda0e8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0684e08b622aef687041639e4a6a950612cdc5f7 --- /dev/null +++ b/marked/Rel-18/26_series/26501/f512ae9c630f2fb53197fa77a1bda0e8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:be9fb343a94193be3bb623b12fc932fccfeba6d1ad176271a25cf0e6eddc7c5d +size 128449 diff --git a/marked/Rel-18/26_series/26501/fd3cbb53e991f8209ba17b398f426e13_img.jpg b/marked/Rel-18/26_series/26501/fd3cbb53e991f8209ba17b398f426e13_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6aa8b3a2a65277d2775a0512fd75f51f8b2f2a64 --- /dev/null +++ b/marked/Rel-18/26_series/26501/fd3cbb53e991f8209ba17b398f426e13_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:721f7c4ca9243323f0aef4bc134a1466e8ee3a83f5732a700af4efd64ec7eb08 +size 119851 diff --git a/marked/Rel-18/26_series/26531/446100c084b94817a19c319fa776b412_img.jpg b/marked/Rel-18/26_series/26531/446100c084b94817a19c319fa776b412_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..28fb49fe7c13facfb84f6cb19efcb3059377cb13 --- /dev/null +++ b/marked/Rel-18/26_series/26531/446100c084b94817a19c319fa776b412_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ad7f0e03758a502f7a73b46ecc9a17ce9acf3ea9d5be26683946802906e59d54 +size 85936 diff --git a/marked/Rel-18/26_series/26531/4b87467ad9642943235f48f7d4b59449_img.jpg b/marked/Rel-18/26_series/26531/4b87467ad9642943235f48f7d4b59449_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..112b5c86f13dc3019ce4618c23a9e67900b91e8e --- /dev/null +++ b/marked/Rel-18/26_series/26531/4b87467ad9642943235f48f7d4b59449_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:10be6fcdd1e8b21447877f328388bc1d564bef788c933134ba338acc441b9930 +size 80554 diff --git a/marked/Rel-18/26_series/26531/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg b/marked/Rel-18/26_series/26531/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a12d499a09af6c3a991fffd5e293e25b05c9c0a3 --- /dev/null +++ b/marked/Rel-18/26_series/26531/4cde160bcc69b7b6c81b648dd0e4252e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a2118e9fa13869232d2e0fcd4c2ea037994c49656df79e123f7d26b46339e831 +size 119538 diff --git a/marked/Rel-18/26_series/26531/5478f70a6cef3e5672b2b22d28830cfb_img.jpg b/marked/Rel-18/26_series/26531/5478f70a6cef3e5672b2b22d28830cfb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..422cb80b2e2b707d3a17255f2b4f0cd2f3540084 --- /dev/null +++ b/marked/Rel-18/26_series/26531/5478f70a6cef3e5672b2b22d28830cfb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fc156d929d15d722523db7a126ff6c579c0e499f6b921b8f029f125db0e7645c +size 83929 diff --git a/marked/Rel-18/26_series/26531/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/26_series/26531/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..da01d3cc11dc439055dd49767f0294635379eaab --- /dev/null +++ b/marked/Rel-18/26_series/26531/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3870c4dd989823dd4b5a7d92e20a348ca1cde0c882ec96d6a1dcaf77db1815aa +size 9465 diff --git a/marked/Rel-18/26_series/26531/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/26_series/26531/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d1365931b0ee8f619e7b7baaba7055ce9a262c09 --- /dev/null +++ b/marked/Rel-18/26_series/26531/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f29cb754f22325f7f49b95bd8e0c908fdd3f8ad145cd4647fd7c64ad5d1ada32 +size 5649 diff --git a/marked/Rel-18/26_series/26531/6ca05954842b17f14dfd52f26b9d43d2_img.jpg b/marked/Rel-18/26_series/26531/6ca05954842b17f14dfd52f26b9d43d2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1147f6284f28f8115af7b06160178e594f77d6f7 --- /dev/null +++ b/marked/Rel-18/26_series/26531/6ca05954842b17f14dfd52f26b9d43d2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9ae6c7ae6c4f0ef781bf597a59910ffe963268b7683b737ed6a3b6984e452d1d +size 141809 diff --git a/marked/Rel-18/26_series/26531/86b4670fc1a5a694821ee92b99c1209a_img.jpg b/marked/Rel-18/26_series/26531/86b4670fc1a5a694821ee92b99c1209a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..42a026d3415488fae508332802dee166b362144f --- /dev/null +++ b/marked/Rel-18/26_series/26531/86b4670fc1a5a694821ee92b99c1209a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:624053bdfe1c197f2f9e15197665d4a403a56d25b7ee10f885fd17961bebd39e +size 196023 diff --git a/marked/Rel-18/26_series/26531/96b0240f56d14453b5da05ec30fd5c6e_img.jpg b/marked/Rel-18/26_series/26531/96b0240f56d14453b5da05ec30fd5c6e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..60da47700b32f5c1c624f47773958db373c15c0e --- /dev/null +++ b/marked/Rel-18/26_series/26531/96b0240f56d14453b5da05ec30fd5c6e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:93bbbd1dc9fd9276a2d5d5f218e275ce43ccbbd0563aadad26e6ac72d1c64e5d +size 37190 diff --git a/marked/Rel-18/26_series/26531/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg b/marked/Rel-18/26_series/26531/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dc6cbfa5f6766aadf422a7f538d7e7a9a5716877 --- /dev/null +++ b/marked/Rel-18/26_series/26531/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99311b7c94a06b8f24153945a511cae83563f869aa621295b41563ec9522881d +size 64121 diff --git a/marked/Rel-18/26_series/26531/9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg b/marked/Rel-18/26_series/26531/9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..75facea159c3ce0b89c1dfd3fefdbca6e7502f0d --- /dev/null +++ b/marked/Rel-18/26_series/26531/9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8c41f0e93eb080104a5f19add3bdbbd7530ec374ceb775c968d6cd37a722c902 +size 45599 diff --git a/marked/Rel-18/26_series/26531/a05e675f8651ae7ccea1d0d68691d1a9_img.jpg b/marked/Rel-18/26_series/26531/a05e675f8651ae7ccea1d0d68691d1a9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c2d33d34a434df95e3d671f1c9f3919e48cb8c70 --- /dev/null +++ b/marked/Rel-18/26_series/26531/a05e675f8651ae7ccea1d0d68691d1a9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e085877d0e68176f4295f1f76bb06712f9e6e9635d54859464030affcdb61a00 +size 77760 diff --git a/marked/Rel-18/26_series/26531/a0739aaf13fa5a632d4faa830f6b2708_img.jpg b/marked/Rel-18/26_series/26531/a0739aaf13fa5a632d4faa830f6b2708_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..45051194f4a53188c0203349d8d68b9c9142a891 --- /dev/null +++ b/marked/Rel-18/26_series/26531/a0739aaf13fa5a632d4faa830f6b2708_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b2e6e1c82d7dcae7cd26d1880ea4112698a44e051337ce859294b79ed56a02c8 +size 78406 diff --git a/marked/Rel-18/26_series/26531/a26e142d3df5bef41a84a9dd099d7825_img.jpg b/marked/Rel-18/26_series/26531/a26e142d3df5bef41a84a9dd099d7825_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0687a238fbea911d5da002173be16c20b4307ffe --- /dev/null +++ b/marked/Rel-18/26_series/26531/a26e142d3df5bef41a84a9dd099d7825_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7bbcf706060aab0d3d49841043eda6c6a4b20c3691b7f71c9aa865db61202413 +size 77322 diff --git a/marked/Rel-18/26_series/26531/a4b963a07cc368283154762c4b156fe7_img.jpg b/marked/Rel-18/26_series/26531/a4b963a07cc368283154762c4b156fe7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..141a782a863b145729dd29be8e799a9745f5c689 --- /dev/null +++ b/marked/Rel-18/26_series/26531/a4b963a07cc368283154762c4b156fe7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04fa76a3d045684aeba913da7698d4566bac67857e9cf4f160ceffb33e7a2ffa +size 84586 diff --git a/marked/Rel-18/26_series/26531/a734898ce18e972938949637c32a34f4_img.jpg b/marked/Rel-18/26_series/26531/a734898ce18e972938949637c32a34f4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bd76fc72a29efe22d83271998dd1a2ea1a092c9d --- /dev/null +++ b/marked/Rel-18/26_series/26531/a734898ce18e972938949637c32a34f4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:536f38fba9d6789e79fb5958336b3fc72441c5cd5fb61723722bdca4ee7d84cd +size 118650 diff --git a/marked/Rel-18/26_series/26531/ac31fdfebb9751f7f10416dfe33bc872_img.jpg b/marked/Rel-18/26_series/26531/ac31fdfebb9751f7f10416dfe33bc872_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7c8b06be9931e41598e2fcd4ad3f21e2088d610a --- /dev/null +++ b/marked/Rel-18/26_series/26531/ac31fdfebb9751f7f10416dfe33bc872_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5b410874d17681da0a4999d5b7753a1bb96d7384364b437c6e51356787e6b9b8 +size 29165 diff --git a/marked/Rel-18/26_series/26531/dbe553cf16dd14073b89a8263a428664_img.jpg b/marked/Rel-18/26_series/26531/dbe553cf16dd14073b89a8263a428664_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aec8e81673c6525c9e424cb6781736810928d4ae --- /dev/null +++ b/marked/Rel-18/26_series/26531/dbe553cf16dd14073b89a8263a428664_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d583c63e5af6023a674241eec415962811d21eb095877f0ce6fb55035d80293f +size 65760 diff --git a/marked/Rel-18/26_series/26531/e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg b/marked/Rel-18/26_series/26531/e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..43807156694c2f533eb17aff14ee90e3b106cb1e --- /dev/null +++ b/marked/Rel-18/26_series/26531/e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ce3ad8b7932e0296d3693592c04c1ac6cb68004685d2ccba5ea81158b8c2e3da +size 94818 diff --git a/marked/Rel-18/26_series/26531/raw.md b/marked/Rel-18/26_series/26531/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3cfd607401769276f9e74991788b5c59c3960121 --- /dev/null +++ b/marked/Rel-18/26_series/26531/raw.md @@ -0,0 +1,1184 @@ + + +# 3GPP TS 26.531 V18.1.0 (2023-12) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Data Collection and Reporting; General Description and Architecture (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The logo for 3GPP, featuring the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' below the logo. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Reference architecture for data collection and reporting ..... | 8 | +| 4.1 General ..... | 8 | +| 4.2 Functional entities for data collection and reporting..... | 9 | +| 4.3 Reference points for data collection and reporting ..... | 12 | +| 4.4 Service-based architecture for data collection and reporting ..... | 14 | +| 4.5 Information security model ..... | 16 | +| 4.5.1 Transport security ..... | 16 | +| 4.5.2 Data exposure restriction model..... | 16 | +| 4.5.3 Authentication of data collection clients by the Data Collection AF ..... | 17 | +| 4.5.4 Precedence rules ..... | 17 | +| 4.5.4.1 General ..... | 17 | +| 4.5.4.2 UE data domains owned by the 5G System (MNO)..... | 18 | +| 4.5.4.3 UE data domains owned by the ASP ..... | 18 | +| 4.6 Domain model..... | 19 | +| 4.6.1 General ..... | 19 | +| 4.6.2 Provisioning information for data collection and reporting ..... | 20 | +| 4.6.3 Configuration information for data collection clients ..... | 21 | +| 4.6.4 Information included in data reports to the Data Collection AF ..... | 21 | +| 4.7 Service exposure ..... | 22 | +| 4.7.1 Service exposure via Network Exposure Function (NEF) ..... | 22 | +| 4.7.2 Service exposure via Common API Framework (CAPIF) for Northbound APIs ..... | 22 | +| 4.7.3 Service exposure via Service Enabler Architecture Layer (SEAL) for Verticals ..... | 22 | +| 5 Procedures for data collection and reporting ..... | 23 | +| 5.1 General ..... | 23 | +| 5.2 Procedures for data collection and reporting provisioning ..... | 24 | +| 5.3 Procedures for Data Collection AF subscription..... | 25 | +| 5.4 Procedures for configuring data collection client ..... | 26 | +| 5.5 Procedures for reporting to the Data Collection AF ..... | 27 | +| 5.6 Procedures for Data Collection AF data exposure..... | 28 | +| 5.7 Procedures for Data Collection AF unsubscription..... | 28 | +| 5.8 Procedures for event consumer authorization ..... | 29 | + +| | | | +|-------------------------------|-----------------------------------------------------------------------|-----------| +| Annex A (informative): | Collaboration scenarios for data collection and reporting..... | 31 | +| A.1 | General..... | 31 | +| A.2 | Collaboration A..... | 32 | +| A.3 | Collaboration B..... | 33 | +| A.4 | Collaboration C..... | 34 | +| A.5 | Collaboration D..... | 35 | +| A.6 | Collaboration E..... | 36 | +| Annex B (normative): | UE data domain ownership ..... | 37 | +| B.1 | General..... | 37 | +| B.2 | Baseline UE data domains ..... | 37 | +| Annex C (informative): | Change history..... | 38 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document defines a generic architecture for collecting and reporting data in the 5G System as defined in TS 23.501 [2], TS 23.502 [3], TS 23.288 [4] and TS 29.517 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System architecture for the 5G System (5GS)". +- [3] 3GPP TS 23.502: "Procedures for the 5G System (5GS)". +- [4] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [5] 3GPP TS 29.517: "5G System; Application Function Event Exposure Service; Stage 3". +- [6] 3GPP TS 29.510: "Network function repository services; Stage 3". +- [7] 3GPP TS 29.532: "Data Collection and Reporting; Protocols and Formats". +- [8] 3GPP TS 23.222: "Common API Framework for 3GPP Northbound APIs". +- [9] 3GPP TS 33.501: "Security architecture and procedures for 5G System". +- [10] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [11] 3GPP TS 29.591: "5G System; Network Exposure Function Southbound Services; Stage 3". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1], TS 23.501 [2], TS 23.502 [3], TS 23.288 [4], TS 29.517 [5] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**data collection client:** functional entity that collects data and reports it to the Data Collection AF, *viz.* Direct Data Collection Client, Indirect Data Collection Client or AS + +**direct reporting:** method of sending a data report from the Direct Data Collection Client to the Data Collection AF + +**event consumer:** a subscriber to event data at the Data Collection AF, used synonymously with the terms NF consumer in TS 23.502 [3] and NF service consumer in TS 29.517 [5] + +**event data:** data exposed by the Data Collection AF to event consumers, used synonymously with the term event reporting information in TS 23.502 [3] and TS 29.517 [5] + +**indirect reporting:** method of sending a data report from a UE Application to the Data Collection AF via an Indirect Data Collection Client function of an Application Service Provider + +**MNO-managed event consumer:** An event consumer instance that is managed by the MNO + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], TS 23.501 [2], TS 23.502 [3], TS 23.288 [4], TS 29.517 [5] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|--------------------------------------------------| +| AF | Application Function | +| AS | Application Server | +| CAPIF | Common API Framework for 3GPP Northbound APIs | +| DN | Data Network | +| NEF | Network Exposure Function | +| NF | Network Function | +| NWDAF | Network Data Analytics Function | +| SEAL | Service Enabler Architecture Layer for Verticals | +| UE | User Equipment | + +# --- 4 Reference architecture for data collection and reporting + +## 4.1 General + +Clause 6.2.8 of TS 23.288 [4] envisages a set of high-level procedures by which data is collected by a Network Data Analytics Function (NWDAF) from UE Application(s) via an intermediary Application Function. This clause defines a generic reference architecture for data collection, reporting and subsequent exposure that satisfies those procedures, including the logical functions involved and the logical reference points between them. The intermediary Application Function envisaged in [4] is here named the *Data Collection AF*. + +NOTE 1: It is presumed that the user has granted consent for its UE data to be collected, reported and subsequently exposed by means outside the scope of the present document (e.g. through interactions with the MNO or the Application Service Provider, and via any applicable SLA between the MNO and Application Service Provider). See also the *setUserConsent* client API method specified in table 8.3.1-1 of TS 26.532 [7]. + +NOTE 2: The collection, reporting and exposure of location-based UE data is expected to comply with regional regulatory requirements and may be further limited by MNO policy. + +It is intended that this reference architecture be instantiated in domain-specific ways to suit the needs of different features of the 5G System. The reference architecture may be instantiated separately in different slices of a network. + +Each type of UE data subject to collection, reporting and subsequent event exposure in the 5G System is associated with a logical *UE data domain*. Each such UE data domain is associated with a *domain owner* – either the 5G System itself (embodied in a particular deployment by an MNO) or the Application Service Provider (ASP). Ownership of particular UE data domains is specified in annex B. + +Precedence rules on the exposure (and consequent collection and reporting) of UE data vis-à-vis conflicts between ASP provisioning information and system preconfiguration by the MNO or subscription by MNO-managed event consumers are defined in clause 4.5.4. + +The services defined in the present document may be exposed to parties outside the trusted domain via the NEF, as defined in clause 4.7.1. + +The Data Collection AF may support CAPIF [8] to provide APIs to other applications (i.e. API invokers), as defined in clause 4.7.2. + +## 4.2 Functional entities for data collection and reporting + +![Reference architecture for data collection and reporting in reference point notation. The diagram shows a central Data Collection AF connected to various entities via reference points. On the left, a UE contains a UE Application and a Direct Data Collection Client. The UE Application connects to an Application Service Provider via R8. The Direct Data Collection Client connects to the Data Collection AF via R2 and to the UE Application via R7. The Data Collection AF connects to an NRF via R1, to a Provisioning AF via R1, to an Indirect Data Collection Client via R3, to an Event Consumer AF via R6, to an NEF via N33 (dashed line), to an AS via R4, and to an NWDAF via R5. The Application Service Provider contains the Provisioning AF, Indirect Data Collection Client, and Event Consumer AF.](dbe553cf16dd14073b89a8263a428664_img.jpg) + +``` + +graph TD + subgraph UE + UEApp[UE Application] + DCC[Direct Data Collection Client] + UEApp --- R7 --- DCC + end + NRF[NRF] + DCAF[Data Collection AF] + ASP[Application Service Provider] + NEF[NEF] + AS[AS] + NWDAF[NWDAF] + + UEApp --- R8 --- ASP + DCC --- R2 --- DCAF + DCAF --- R1 --- NRF + DCAF --- R1 --- PA[Provisioning AF] + DCAF --- R3 --- IDC[Indirect Data Collection Client] + DCAF --- R6 --- ECA[Event Consumer AF] + DCAF -.- N33 -.- NEF + DCAF --- R4 --- AS + DCAF --- R5 --- NWDAF + + subgraph ASP + PA[Provisioning AF] + IDC[Indirect Data Collection Client] + ECA[Event Consumer AF] + end + +``` + +Reference architecture for data collection and reporting in reference point notation. The diagram shows a central Data Collection AF connected to various entities via reference points. On the left, a UE contains a UE Application and a Direct Data Collection Client. The UE Application connects to an Application Service Provider via R8. The Direct Data Collection Client connects to the Data Collection AF via R2 and to the UE Application via R7. The Data Collection AF connects to an NRF via R1, to a Provisioning AF via R1, to an Indirect Data Collection Client via R3, to an Event Consumer AF via R6, to an NEF via N33 (dashed line), to an AS via R4, and to an NWDAF via R5. The Application Service Provider contains the Provisioning AF, Indirect Data Collection Client, and Event Consumer AF. + +NOTE: The Data Collection AF may be deployed outside the trusted domain, in which case the services it exposes to API invokers are mediated by the NEF. The logical relationships denoted by the reference points are unaffected by such deployment choices. + +**Figure 4.2-1: Reference architecture for data collection and reporting in reference point notation** + +The functional entities illustrated in the figure are described as follows: + +1. Data collection and reporting functionality is provisioned at reference point R1 by a *Provisioning AF* of the *Application Service Provider* that may be deployed either inside or outside the trusted domain. The *Ndcaf\_DataReportingProvisioning* service is provided by the Data Collection AF for this purpose. + +NOTE 1: When provisioning is initiated from outside the trusted domain via the NEF, the Provisioning AF instead invokes the *Nnef\_DataReportingProvisioning* service. + +2. The *Data Collection AF* may be deployed inside or outside the trusted domain. It is responsible for managing the provisioning state for data collection and reporting. When its provisioning state changes, the Data Collection AF updates the set of available NF profile(s) in the NRF by invoking the *Nnrf\_NFManagement* service defined in + +clause 5.2.7.2 of TS 23.502 [3] according to the usage defined in clause 6.2.8.2.2 of TS 23.288 [4] and specified in clause 6.1 of TS 29.510 [6]. + +NOTE 2: If the Data Collection AF is deployed outside the trusted domain, this registration occurs via the NEF, as described in clause 6.2.2.3 of TS 23.288 [4]. + +Depending on the provisioning information provided by the Application Service Provider (see clause 4.6.2), the Data Collection AF provides a data collection and reporting configuration to the *Direct Data Collection Client* at reference point R2, to the *Indirect Data Collection Client* at reference point R3 or to the Application Server (AS) instances at reference point R4, and receives data reports from them respectively at those same reference points. + +The Data Collection AF processes received data reports according to processing instructions in its provisioning state. The processing activities include, but are not limited to, reporting format conversion, data normalisation, reporting domain-specific anonymisation of data and (dis)aggregation of data into reports to be exposed as events. + +Finally, the Data Collection AF is responsible for exposing processed UE data to event notification subscribers both inside the trusted domain (such as the NWDAF) and outside it (such as the *Event Consumer AF* in the Application Service Provider). In this role, the Data Collection AF realises the Event Exposure Service as defined in clause 6.2.2.1 of TS 23.288 [4] and as specified in TS 29.517 [5]. Subscribers fulfil the role of NF consumers of this service in the service-based architecture [2, 3]. + +The set of UE data to be collected and exposed by the Data Collection AF is determined by the intersection1 between its provisioning state provided at R1 and the current set of subscriptions. This is reflected in the data collection and reporting configuration exposed at reference points R2, R3 and R4, and the subscription-driven event notifications sent to consumer entities such as the NWDAF or Event Consumer AF of an Application Service Provider over reference points R5 and R6. The Data Collection AF is responsible for ensuring that access to UE data is controlled according to the rules indicated in its provisioning state, as specified in clause 4.5.2. Where these data exposure restrictions conflict with system preconfiguration by the MNO or event subscriptions by MNO-managed event consumers, the precedence rules defined in clause 4.5.4 shall apply. + +NOTE 3: When the Data Collection AF is deployed outside the trusted domain, the NWDAF uses the procedure defined in clause 5.2.6.2 of TS 23.502 [3] and further elaborated by clause 6.2.2.3 of TS 23.288 [4] to collect data from the externally deployed Data Collection AF via the NEF. + +NOTE 4: The Data Collection AF is intended to be instantiated inside another Application Function in order to satisfy the domain-specific data collection and reporting requirements corresponding to particular features in the 5G System. As such, there may be several reporting domain-specific Data Collection AF instances operating simultaneously in a particular 5G System, each one performing a different role. The definitions of these instantiations are beyond the scope of the present document. + +3. The *Direct Data Collection Client* is responsible for collecting relevant data in the UE and for sending data reports to the Data Collection AF via reference point R2 using the *Ndcaf\_DataReporting* service according to a data collection and reporting configuration that it has previously obtained from the Data Collection AF by invoking the same service at reference point R2. + +NOTE 5: This method of reporting corresponds to the direct data collection procedure defined in clause 6.2.8 of TS 23.288 [4]. + +NOTE 6: In the case where the Data Collection AF is deployed in a different trust domain than the UE, the Direct Data Collection Client instead invokes the equivalent *Nnef\_DataReporting* API via the NEF. + +--- + +1 In the event that provisioning data and subscription data contain similar rules, the permissible information to be exposed by the Data Collection Function shall be governed by the rule with more restrictive semantics. + +NOTE 7: The Direct Data Collection Client function is intended to be instantiated inside other UE functions in order to satisfy the domain-specific data collection and reporting requirements corresponding to particular features of the 5G System. As such, there may be several reporting domain-specific data collection client instances operating simultaneously on a given UE, each one performing a different role. One valid deployment option is to combine these instances in a common middleware component. Another option is to provide the Direct Data Collection Client as an integral part of each relevant UE Application. The definitions of these instantiations are beyond the scope of the present document. The realisation of these logical functions is implementation-dependent. + +4. The *UE Application* is responsible for sharing relevant data with the Direct Data Collection Client via reference point R7. This may be achieved as a combination of application design, application configuration via R8 and/or application configuration via R7. +5. An Application Service Provider may also collect data from UE Applications via reference point R8 and employ an *Indirect Data Collection Client* subfunction to then send data reports to the Data Collection AF via reference point R3 by invoking the *Ndcaf\_DataReporting* service according to a data collection and reporting configuration that it has previously obtained from the Data Collection AF by invoking the same service at reference point R3. + +NOTE 8: This method of reporting corresponds to the indirect data collection procedure defined in clause 6.2.8 of TS 23.288 [4]. + +NOTE 9: In the case where the Application Service Provider server is deployed in a different trust domain than the Data Collection AF, the Indirect Data Collection Client instead invokes the equivalent *Nnef\_DataReporting* API via the NEF at reference point R3. + +NOTE 10: Collection of UE data via reference point R8 and processing by the Application Server Provider are outside 3GPP scope. The Indirect Data Collection Client may modify the collected UE data to satisfy the requirements of its data collection and reporting configuration. + +6. Application Server instances (labelled *AS*) inside or outside the trusted domain may also collect data and report it to the Data Collection AF via reference point R4 by invoking the *Ndcaf\_DataReporting* service, according to a data collection and reporting configuration previously obtained from the Data Collection AF by invoking the same service at reference point R4. + +NOTE 11: In the case where the Application Server is deployed in a different trust domain than the Data Collection AF, the AS instead invokes the equivalent *Nnef\_DataReporting* service via the NEF. + +NOTE 12: The data collection and reporting requirements for such Application Servers are reporting domain-specific and therefore beyond the scope of the present document. + +7. The NWDAF is the primary consumer of processed UE data. This is exposed to the NWDAF by the Data Collection AF in the form of data reporting event notifications via reference point R5 using the *Naf\_EventExposure* service (as specified in TS 29.517 [5]) after any processing by the Data Collection AF has been performed according to its provisioned processing instructions. + +NOTE 13: If the Data Collection AF is deployed outside the trusted domain, this interaction occurs instead by invoking the *Nnef\_EventExposure* service via the NEF, as defined in clause 5.2.6.2 of TS 23.502 [3] and as further elaborated by clause 6.2.2.3 of TS 23.288 [4]. + +NOTE 14: The UE data of interest to the NWDAF at reference point R5, for example Observed Service Experience and Collective Behaviour, is governed by clause 6 of TS 23.288 [4]. + +8. By means of appropriate data collection and reporting provisioning, certain UE data may also be exposed in the form of data reporting events by the Data Collection AF to an *Event Consumer AF* residing in the Application Service Provider via reference point R6 using the *Naf\_EventExposure* service defined in clause 5.2.19 of TS 23.502 [4] and specified in TS 29.517 [5]. + +NOTE 15: In the case where the Application Service Provider server is deployed outside the trusted domain, the *Nnef\_EventExposure* service, as defined in clause 5.2.6.2 of TS 23.502 [3], is invoked instead. + +## 4.3 Reference points for data collection and reporting + +The purposes of the reference points in the functional architecture defined in clause 4.2 above are as follows: + +- **R1** supports the following interactions between a Provisioning AF in the Application Service Provider and the Data Collection AF: + - Used by the Application Service Provider to provision data collection and reporting in a Data Collection AF instance by means of the *Ndcaf\_DataReportingProvisioning* service defined in clause 4.4 of the present document (or else the equivalent service exposed by the NEF if the two functions are deployed in different trust domains). The provisioning information specifies what data is to be collected, and additionally may specify how that data is to be sampled by data collection clients (e.g., sampling frequency, location filter) and/or how the collected data is to be reported by them (e.g., reporting probability, reporting frequency, reporting format, data packaging strategy), how it is to be processed by the Data Collection AF and how it is to be exposed to event notification subscribers. A generic provisioning envelope for data collection and reporting is defined in clause 4.6 of the present document, but this is expected to be extended by individual reporting domains. + +NOTE 0: Provisioning of sampling frequency and/or location filters may be limited by MNO policy, for example to limit resource impacts on the 5G System, and the Data Collection AF is expected to reject provisioning information containing out-of-policy values. + +- **R2** supports the following interactions between the Direct Data Collection Client in the UE and the Data Collection AF: + - Used by a Direct Data Collection Client instance to obtain its data collection and reporting configuration from the corresponding Data Collection AF instance by means of the *Ndcaf\_DataReporting* service defined in clause 4.4 of the present document. The client configuration specifies what data is to be collected, and additionally specifies how that data is to be sampled (e.g., sampling frequency, location filter) and/or how the collected data is to be reported (e.g., reporting probability, reporting frequency, reporting format, data packaging strategy). A generic data collection and reporting configuration envelope is defined in clause 4.6.3 of the present document, but details of the configuration are specific to individual reporting domains and are specified elsewhere. + - Subsequently used by the Direct Data Collection Client to send reports to its Data Collection AF instance by means of the *Ndcaf\_DataReporting* service defined in clause 4.4 of the present document. A generic data reporting envelope is defined in clause 4.6.4 of the present document, but details of the reporting format are specific to individual reporting domains and are specified elsewhere. + +NOTE 1: This method of reporting corresponds to the direct data collection procedure defined in clause 6.2.8 of TS 23.288 [4]. + +- **R3** supports the following interactions between the Indirect Data Collection Client in the Application Service Provider Server and the Data Collection AF: + - Used by an Indirect Data Collection Client instance to obtain its data collection and reporting configuration from the corresponding Data Collection AF instance by means of the *Ndcaf\_DataReporting* service defined in clause 4.4 of the present document (or else the equivalent service exposed by the NEF if the two functions are deployed in different trust domains). A generic data collection and reporting configuration envelope is defined in clause 4.6.3 of the present document, but details of the configuration are specific to individual reporting domains and are specified elsewhere. + - Subsequently used by the Indirect Data Collection Client in the Application Service Provider server to send data reports to its Data Collection AF instance by means of the *Ndcaf\_DataReporting* service defined in clause 4.4 of the present document (or else the equivalent service exposed by the NEF if the two functions are deployed in different trust domains). A generic data reporting envelope is defined in clause 4.6.4 of the present document, but details of the reporting format are specific to individual reporting domains and are specified elsewhere. + +NOTE 2: This method of reporting corresponds to the indirect data collection procedure defined in clause 6.2.8 of TS 23.288 [4]. + +- **R4** supports the following interactions between the Application Server (AS) and the Data Collection AF: + - Used by an AS instance to obtain its data collection and reporting configuration from the corresponding Data Collection AF instance by means of the *Ndcaf\_DataReporting* service defined in clause 4.4 of the present document (or else the equivalent service exposed by the NEF if the two functions are deployed in different trust domains). A generic data collection and reporting configuration envelope is defined in clause 4.6.3 of the present document, but details of the configuration are specific to individual reporting domains and are specified elsewhere. + - Subsequently used by the AS instance to send data reports to its Data Collection AF instance by means of the *Ndcaf\_DataReporting* service defined in clause 4.4 of the present document (or else the equivalent service exposed by the NEF if the two functions are deployed in different trust domains). A generic data reporting envelope is defined in clause 4.6.4 of the present document, but details of the reporting format are specific to individual reporting domains and are specified elsewhere. + +NOTE 3: The AS plays the role of a Network Function when it invokes the *Ndcaf\_DataReporting* service at reference point R4. + +- **R5** supports the following interactions between the NWDAF and the Data Collection AF: + - Used by an NWDAF instance to subscribe to data reporting events exposed by a Data Collection AF instance, according to the *Naf\_EventExposure\_Subscribe* procedure defined in clause 5.2.19.2.2 of TS 23.502 [3], as further elaborated in step 3a of clause 6.2.8.2.3 in TS 23.288 [4], and as specified in TS 29.517 [5] (or else the equivalent *Nnef\_EventExposure\_Subscribe* service exposed by the NEF if the two functions are deployed in different trust domains). + - Subsequently used by the Data Collection AF to expose data reporting events to the NWDAF, according to the *Naf\_EventExposure\_Notify* procedure defined in clause 5.2.19.2.4 of TS 23.502 [3], as further elaborated in step 5a of clause 6.2.8.2.3 in TS 23.288 [4], and as specified in TS 29.517 [5] (or else the equivalent *Nnef\_EventExposure\_Notify* service exposed by the NEF if the two functions are deployed in different trust domains). +- **R6** supports the following interactions between the Event Consumer AF in the Application Service Provider and the Data Collection AF: + - Used by an Event Consumer AF instance to subscribe to data reporting events exposed by the Data Collection AF, according to the *Naf\_EventExposure\_Subscribe* procedure defined in clause 5.2.19.2.2 of TS 23.502 [3] and specified in TS 29.517 [5] (or else the equivalent *Nnef\_EventExposure\_Subscribe* service exposed by the NEF if the two functions are deployed in different trust domains). + - Subsequently used by the Data Collection AF to expose data reporting events to the Event Consumer AF according to the *Naf\_EventExposure\_Notify* procedure defined in clause 5.2.19.2.4 of TS 23.502 [3] and specified in TS 29.517 [5] (or else the equivalent *Nnef\_EventExposure\_Notify* service exposed by the NEF if the two functions are deployed in different trust domains). +- **R7** is a client API offered by the Direct Data Collection Client to the UE Application. + +NOTE 4: When the Direct Data Collection Client is embedded in the UE Application, reference point R7 is not used. + +- **R8** supports data collection and reporting interactions between the UE Application and the Application Service Provider server. + +NOTE 5: Interactions at reference point R8 are beyond the scope of 3GPP standardisation. + +## 4.4 Service-based architecture for data collection and reporting + +Figure 4.4-1 below shows the reference architecture for data collection and reporting in service-based architecture notation. It depicts the case where the Data Collection AF is deployed inside the trusted domain, while the Application Service Provider and the AS may be deployed independently either inside or outside the trusted domain. + +![Figure 4.4-1: Reference architecture for data collection and reporting in service-based architecture notation when the Data Collection AF is deployed in the trusted domain. The diagram shows a central Service Based Interface (SBI) bus. On the left, a UE contains a Direct Data Collection Client connected to a Data Collection AF via an R2 reference point. The Data Collection AF is connected to the SBI via Ndcaf and Naf interfaces. Above the SBI, a (Trusted) AS is connected via Nnrf to an NRF. To the right, an Application Service Provider (External DN) contains (External) Provisioning AF, (External) Event Consumer AF (connected via Naf), and an Indirect Data Collection Client, all connected to the SBI via Nnef interfaces. An (External) AS is also connected to the SBI via Nnef. Below the SBI, a NWDAF is connected via Naf. On the far left, a separate Application Service Provider (Trusted) contains (Trusted) Provisioning AF, (Trusted) Event Consumer AF (connected via Naf), and an Indirect Data Collection Client, all connected to the SBI via Nnef interfaces.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +Figure 4.4-1: Reference architecture for data collection and reporting in service-based architecture notation when the Data Collection AF is deployed in the trusted domain. The diagram shows a central Service Based Interface (SBI) bus. On the left, a UE contains a Direct Data Collection Client connected to a Data Collection AF via an R2 reference point. The Data Collection AF is connected to the SBI via Ndcaf and Naf interfaces. Above the SBI, a (Trusted) AS is connected via Nnrf to an NRF. To the right, an Application Service Provider (External DN) contains (External) Provisioning AF, (External) Event Consumer AF (connected via Naf), and an Indirect Data Collection Client, all connected to the SBI via Nnef interfaces. An (External) AS is also connected to the SBI via Nnef. Below the SBI, a NWDAF is connected via Naf. On the far left, a separate Application Service Provider (Trusted) contains (Trusted) Provisioning AF, (Trusted) Event Consumer AF (connected via Naf), and an Indirect Data Collection Client, all connected to the SBI via Nnef interfaces. + +NOTE 1: In its role as an event exposure service provider Application Function, the Data Collection AF provides the (un)subscription operations of the *Naf\_EventExposure* (or *Nnef\_EventExposure*) service for use by Network Function service consumers. As Network Function service consumers, the NWDAF and the Event Consumer AF provide the event notification operation of the *Naf\_EventExposure* (or *Nnef\_EventExposure*) service for use by the Data Collection AF. + +NOTE 2: The UE-based Direct Data Collection Client interacts with the Data Collection AF in the user plane, and so the interaction at reference point R2 does not traverse the service bus. + +**Figure 4.4-1: Reference architecture for data collection and reporting in service-based architecture notation when the Data Collection AF is deployed in the trusted domain** + +The following service-based APIs are used in connection with data collection and reporting: + +1. The *Ndcaf\_DataReportingProvisioning* service is provided by the Data Collection AF. It is defined by the present document and is specified in TS 26.532 [7]. This service is used by Provisioning AF instances to provision data collection and reporting in the Data Collection AF. +2. The *Nnrf\_NFManagement* service is provided by the NRF. It is defined in clause 5.2.7.2 of TS 23.502 [3] and specified in clause 6.1 of TS 29.510 [6]. This service is used by the Data Collection AF to register an available NF profile with the NRF for each set of data collection and reporting provisioning information held by the former. + +NOTE 1: As described in clause 6.2.8.2.2 of TS 23.288 [4] the NF profile in this case includes the External Application Identifier (used by clients when reporting data to the Data Collection AF), the Internal Application Identifier (used for event exposure to the NWDAF) and the Event ID. These NF profile parameters are in addition to those specified in clause 5.2.7.2 of TS 23.502 [3]. + +3. The *Ndcaf\_DataReporting* service is provided by the Data Collection AF. It is defined by the present document and is specified in TS 26.532 [7]. + - a. This service is used by the Direct Data Collection Client, by the Indirect Data Collection Client in the Application Service Provider server and by AS instances to obtain their data collection and reporting configuration from the Data Collection AF. + - b. Subsequently, this service is used by the Direct Data Collection Client, by the Indirect Data Collection Client and by AS instances to send data reports to the Data Collection AF. +- NOTE 2: Trusted AS instances play the role of a Network Function when invoking the *Ndcaf\_DataReporting* service (or equivalent) and are therefore depicted in figure 4.4-1 as being directly attached to the service bus. +4. The *Naf\_EventExposure* service is provided by the Data Collection AF. It is defined in clause 5.2.19.2 of TS 23.502 [3] and TS 23.288 [4], and is specified in TS 29.517 [5]. + - a. Used by the NWDAF to subscribe to data reporting events exposed by the Data Collection AF and subsequently used by the Data Collection AF to notify these events to the NWDAF, as described in clause 6.2.2.2 or 6.2.2.3 (as appropriate) of TS 23.288 [4]. + - b. Used by an Event Consumer AF in the Application Service Provider server to subscribe to data reporting events exposed by the Data Collection AF and subsequently used by the Data Collection AF to notify these events to the Application Service Provider server, as described in clause 6.2.2.2 or clause 6.2.2.3 (as appropriate) of TS 23.288 [4]. + +Figure 4.4-2 depicts the case where the Data Collection AF is instead deployed outside the trusted domain, along with the Application Service Provider and the (external) AS. In this case, the subfunctions of the Application Service Provider and the (external) AS do not interact with the Data Collection AF via the 5G System service bus. The *Ndcaf* service is therefore not required in such deployments. The interactions at the relevant reference points are outside the scope of 3GPP and are depicted as R1', R3', R4' and R6' to reflect this. + +![Figure 4.4-2: Reference architecture for data collection and reporting in service-based architecture notation when the Data Collection AF is deployed outside the trusted domain. The diagram shows a UE with a Direct Data Collection Client connected to a Data Collection AF via reference point R2. The Data Collection AF is part of an External DN and is connected to an Application Service Provider (ASP) via reference points R1', R3', and R6'. The ASP contains (External) Provisioning AF, (External) Event Consumer AF, and an Indirect Data Collection Client. The Data Collection AF is also connected to an (External) AS via reference point R4'. Below the Data Collection AF, the Naf service is exposed to the NEF (via Nnef reference points), which in turn connects to the NRF (via Nnrf) and the NWDAF (via Naf).](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +Figure 4.4-2: Reference architecture for data collection and reporting in service-based architecture notation when the Data Collection AF is deployed outside the trusted domain. The diagram shows a UE with a Direct Data Collection Client connected to a Data Collection AF via reference point R2. The Data Collection AF is part of an External DN and is connected to an Application Service Provider (ASP) via reference points R1', R3', and R6'. The ASP contains (External) Provisioning AF, (External) Event Consumer AF, and an Indirect Data Collection Client. The Data Collection AF is also connected to an (External) AS via reference point R4'. Below the Data Collection AF, the Naf service is exposed to the NEF (via Nnef reference points), which in turn connects to the NRF (via Nnrf) and the NWDAF (via Naf). + +**Figure 4.4-2: Reference architecture for data collection and reporting in service-based architecture notation when the Data Collection AF is deployed outside the trusted domain** + +## 4.5 Information security model + +### 4.5.1 Transport security + +An encrypted data transfer protocol shall be employed at reference point R2 to protect the secrecy and integrity of collected UE data in transit between the Direct Data Collection Client and the Data Collection AF. + +### 4.5.2 Data exposure restriction model + +The Provisioning AF restricts the exposure of UE data over reference points R5 and R6 by configuring a set of Data Access Profiles for each Event ID to be exposed. A Data Access Profile specifies a set of data processing operations that need to be performed by the Data Collection AF on the collected UE data in order to synthesize the event data that will be exposed to the NWDAF and/or Event Consumer AF. + +When subscribing to event exposure notifications for a particular Event ID, an NWDAF or Event Consumer AF goes through an authorisation procedure (see clause 5.8) with an Authorisation AS that determines the level of access the event subscriber is allowed to have by selecting one of the provisioned Data Access Profiles for the Event ID in question. If successful, the Authorisation AS supplies an access token to the subscriber which is presented to and validated by the Data Collection AF as part of the event subscription procedure. + +NOTE: The procedure for selecting an appropriate Data Access Profile is not specified in the present document. + +Figure 4.5.2-1 depicts the static data model for the data collection provisioning with Data Access Profiles to restrict data exposure access. + +![UML Class Diagram: Data exposure restriction domain model](96b0240f56d14453b5da05ec30fd5c6e_img.jpg) + +``` +classDiagram + class Provisioning_information [Provisioning information] { + Event ID + ... + } + class Data_Collection_Client_configuration [Data Collection Client configuration] { + Authorization URL + ... + } + class Data_Access_Profile [Data Access Profile] { + Data Access Profile identifier + Time-based data processing instructions + User-based data processing instructions + Location-based data processing instructions + } + Provisioning_information "1" -- "1..*" Data_Collection_Client_configuration + Data_Collection_Client_configuration "1" *-- "1..*" Data_Access_Profile +``` + +The diagram illustrates the static data model for the data exposure restriction domain. It consists of three classes represented by rectangular boxes with a light pink background. The top class is 'Provisioning information', which contains attributes 'Event ID' and '...'. The middle class is 'Data Collection Client configuration', which contains attributes 'Authorization URL' and '...'. The bottom class is 'Data Access Profile', which contains attributes 'Data Access Profile identifier', 'Time-based data processing instructions', 'User-based data processing instructions', and 'Location-based data processing instructions'. There is a directed association between 'Provisioning information' and 'Data Collection Client configuration', with a '1' at the top and '1..\*' at the bottom. There is also a directed association between 'Data Collection Client configuration' and 'Data Access Profile', with a '1' at the top and '1..\*' at the bottom. The association between 'Data Collection Client configuration' and 'Data Access Profile' is represented by a solid line with a filled diamond at the 'Data Collection Client configuration' end. + +UML Class Diagram: Data exposure restriction domain model + +Figure 4.5.2-1: Data exposure restriction domain model + +The Data Access Profile defines restrictions along the time, user, and location dimensions: + +- Restrictions along the time dimension determine the granularity of access to UE data along the time axis. The finest granularity allows access to events as they take place in time. The coarsest level of access aggregates all event data along the time axis to produce a single aggregated value. +- Restrictions along the user dimension allow the Provisioning AF to restrict access to UE data related events based on groups. The finest granularity allows the event consumer to access events related to single users. Coarse granularity access exposes aggregated collected event data based on user groups. The coarsest granularity access exposes the data being aggregated for all users. +- Restrictions along the location dimension allow the Provisioning AF to restrict access to UE data related events based on the geographical location of the data collection client during the event. The finest granularity allows the event consumer to access events individually, irrespective of the location. Coarse granularity access exposes aggregated collected event data based on a geographical area. The coarsest level of access aggregates all event data along the location axis to produce a single aggregated value for all locations. + +The baseline set of aggregation functions is listed in table 4.5.2-1: + +**Table 4.5.2-1: Baseline aggregation functions** + +| Aggregation function | Description | +|----------------------|--------------------------------------------------------------------------------------------| +| None | No aggregation is applied, and all reported data records are exposed as individual events. | +| Count | The number of reported data records is exposed to event consumers. | +| Mean | The mean average of the values in reported data records is exposed to event consumers. | +| Maximum | The maximal observed value in reported data records is exposed to event consumers. | +| Minimum | The minimal observed value in reported data records is exposed to event consumers. | +| Sum | The sum of the values in reported data records is exposed to event consumers. | + +The authorization URL, if present in the data exposure restrictions, is used to redirect subscription requests without a valid access token to an authorization server, which will perform the authorization for the requested Data Access Profile. + +Upon successful authorization, the consumer entity obtains an access token, which contains an identifier of the Data Access Profile that is allowed for the event consumer. Upon successful subscription, the Data Collection AF shall apply the indicated aggregation functions of the corresponding Data Access Profile along the time and user dimensions on the collected data prior to exposing it to the event consumer. + +### 4.5.3 Authentication of data collection clients by the Data Collection AF + +To satisfy the requirements in clause 6.2.8.1 of TS 23.288 [4], a data collection client shall supply authentication information to the Data Collection AF: + +1. When the data collection client requests its data collection and reporting configuration from the Data Collection AF; and +2. When the data collection client reports UE data to the Data Collection AF. + +For reasons of efficiency, the authentication information may be provided once at the start of a long-lived UE data reporting session. + +**NOTE:** In the case of direct reporting, the requirement to supply authentication information may require the UE Application to first obtain this from the Application Service Provider via reference point R8 and then pass it to the Direct Data Collection Client via R7 (or, in the case of Collaboration E depicted in clause A.6, via an internal interface) before it can be presented to the Data Collection AF at reference point R2. + +### 4.5.4 Precedence rules + +#### 4.5.4.1 General + +Where there is a conflict between data exposure restrictions provisioned by the ASP at reference point R1 and preconfiguration of the Data Collection AF and/or data collection clients by the MNO, or event subscriptions by MNO- + +managed event consumers (as defined in clause 3.1) such as the NWDAF, precedence is based on ownership of the UE data domain of concern, with specific rules as described in clauses 4.5.4.2 and 4.5.4.3. + +In this context, ownership of specific UE data domains is as specified in annex B. + +#### 4.5.4.2 UE data domains owned by the 5G System (MNO) + +The following rules shall apply to UE data domains that are owned by the 5G System (MNO): + +1. For determining data collection and reporting behaviour, any preconfiguration of the Data Collection AF and/or data collection clients by the 5G System operator shall take precedence over similar ASP-defined provisioning information. + - a) Any attempt by the ASP to provision data collection and reporting rules that are either more lax or more restrictive than allowed by the preconfiguration may be rejected by the Data Collection AF, subject to MNO policy. +2. For determining permissible access to event data exposed by the Data Collection AF to MNO-managed event consumers such as the NWDAF, MNO policies on event exposure (for example, regarding anonymization and aggregation) shall take precedence over any data exposure restrictions provisioned by the ASP as part of a Data Access Profile. + - a) Any attempt by the ASP to provision data exposure rules affecting an MNO-managed event consumer that are either more lax or more restrictive than allowed by MNO policy shall be rejected by the Data Collection AF. + - b) Any event subscription request by the ASP's Event Consumer AF to the Data Collection AF that would relax the data exposure restrictions provisioned on the Data Collection AF by the 5G System operator for that event consumer shall be rejected by the Data Collection AF. + +#### 4.5.4.3 UE data domains owned by the ASP + +The following rules shall apply to UE data domains that are owned by the ASP: + +1. For determining data collection and reporting behaviour, ASP-defined provisioning information shall take precedence over any similar preconfiguration of the Data Collection AF and/or data collection clients by the 5G System operator. + - a) Any preconfiguration by the 5G System operator of UE data collection and reporting behaviour that is either more lax or more restrictive than similar ASP-defined provisioning information should be ignored by the Data Collection AF and/or data collection clients. +2. For determining permissible access to event data exposed by the Data Collection AF to MNO-managed event consumers such as the NWDAF, data exposure restrictions provisioned by the ASP as part of a Data Access Profile shall take precedence over MNO policies on event exposure (for example, regarding anonymization and aggregation). + - a) Any event subscription request by an MNO-managed event consumer to the Data Collection AF that would relax the data exposure restrictions provisioned on the Data Collection AF by the ASP for that event consumer shall be rejected by the Data Collection AF. + +## 4.6 Domain model + +### 4.6.1 General + +Figure 4.6.1-1 depicts the static data model for the data collection and reporting domain. It is further described below. + +![Figure 4.6.1-1: Static domain model. This UML class diagram illustrates the relationships between several entities in a data collection and reporting domain. The entities are represented as boxes with compartments for their attributes. Associations are shown as lines with arrows indicating the direction of the relationship and multiplicity at each end. Actors are represented by stick figures.](a734898ce18e972938949637c32a34f4_img.jpg) + +``` + +classDiagram + class Provisioning_information [Provisioning information] { + External Application Identifier + Internal Application Identifier + Event ID + Valid targets[] + Parameters to be collected[] + Data sampling rules[] + Data reporting rules[] + Data processing instructions[] + Data exposure restrictions[] + } + class Data_Collection_Client_configuration [Data Collection Client configuration] { + External Application Identifier + Parameters to be collected[] + Data sampling rules[] + Data reporting rules[] + } + class Data_report [Data report] { + External Application Identifier + Data Reporting records[] + } + class Data_reporting_record [Data reporting record] { + Collected parameters[] + } + class Event_exposure_notification [Event exposure notification] { + Subscription correlation identifier + Exposed events[] + } + class Event [Event] { + Timestamp + Event ID + Processed parameters[] + } + + Provisioning_AF((Provisioning AF)) --> Provisioning_information : provisions + Provisioning_information "1" -- "1..*" Data_Collection_Client_configuration + Data_Collection_Client_configuration "1" -- "0..*" Data_report + Data_report "1" -- "1..*" Data_reporting_record + Data_reporting_record "1..*" -- "0..*" Event + NWDAF((NWDAF)) --> Event_exposure_notification : exposed to + Event_Consumer_AF((Event Consumer AF)) --> Event_exposure_notification : exposed to + Event_exposure_notification "1" -- "1..*" Event + +``` + +The diagram shows the following entities and relationships: + +- Provisioning information** (Class): + - Attributes: External Application Identifier, Internal Application Identifier, Event ID, Valid targets[], Parameters to be collected[], Data sampling rules[], Data reporting rules[], Data processing instructions[], Data exposure restrictions[] +- Provisioning AF** (Actor): + - Relationship: **provisions** to **Provisioning information** (1..\* multiplicity) +- Data Collection Client configuration** (Class): + - Attributes: External Application Identifier, Parameters to be collected[], Data sampling rules[], Data reporting rules[] +- Data report** (Class): + - Attributes: External Application Identifier, Data Reporting records[] +- Data reporting record** (Class): + - Attributes: Collected parameters[] +- Event exposure notification** (Class): + - Attributes: Subscription correlation identifier, Exposed events[] +- Event** (Class): + - Attributes: Timestamp, Event ID, Processed parameters[] +- NWDAF** (Actor): + - Relationship: **exposed to** **Event exposure notification** +- Event Consumer AF** (Actor): + - Relationship: **exposed to** **Event exposure notification** + +Associations and multiplicities: + +- Provisioning information** "1" -- "1..\*" **Data Collection Client configuration** +- Data Collection Client configuration** "1" -- "0..\*" **Data report** +- Data report** "1" -- "1..\*" **Data reporting record** +- Data reporting record** "1..\*" -- "0..\*" **Event** +- Event exposure notification** "1" -- "1..\*" **Event** + +Figure 4.6.1-1: Static domain model. This UML class diagram illustrates the relationships between several entities in a data collection and reporting domain. The entities are represented as boxes with compartments for their attributes. Associations are shown as lines with arrows indicating the direction of the relationship and multiplicity at each end. Actors are represented by stick figures. + +Figure 4.6.1-1: Static domain model + +The *Provisioning AF* provisions zero or more sets of *provisioning information* in the Data Collection AF at reference point R1. The baseline set of information provisioned is described in clause 4.6.2. Each set of provisioning information pertains to one application, identified by its *external application identifier*, and one type of exposed *event*, uniquely identified in the 5G System by its *Event ID*, as defined in clause 4.15.1 of TS 23.502 [3]. There may be more than one set of provisioning information for a particular external application identifier, but the combination of the external application identifier and Event ID shall be unique for a given Data Collection AF instance. + +The types of data collection client that are permitted to collect UE data are indicated in *Valid targets*. *Parameters to be collected* specifies which subset of parameters associated with the UE data domain for the provisioned Event ID are to be collected by these types of data collection clients. + +*Data sampling rules* specify how the domain-specific parameters associated with the Event ID are to be collected by the data collection client (e.g., sampling frequency, location filter). *Data reporting rules* specify how the data collection client is to report its collected data parameters to the Data Collection AF (e.g., reporting probability, reporting frequency, reporting format, data packaging strategy). + +The *data processing instructions* and *data exposure restrictions* are expressed as a set of Data Access Profiles (see clause 4.5.2). The data exposure restrictions limit the types of event consumer that are authorised to subscribe to the Event ID provisioned for the application and the data processing instructions specify aggregation functions that are applied to UE data prior to exposure to those event consumers. + +Each set of provisioning information is manifested as a *data collection client configuration* that the Data Collection AF makes available to Direct Data Collection Client instances at reference point R2, to Indirect Data Collection Client instances at R3 and to AS instances at R4. + +Once configured, these data collection clients then send *data reports* to the Data Collection AF associated with the data collection client configuration. Each data report provides the external application identifier associated with the UE Application and also includes a non-empty list of *data reporting records* containing the parameters collected by the data collection client. These parameters typically include a sampling timestamp. + +NOTE 1: It is the responsibility of the data collection client to discover its external application identifier by means outside the scope of the present document. + +An event consumer (the NWDAF and/or Event Consumer AF) subscribes to a type of event exposed by the Data Collection AF using the procedures defined in clause 6.2.8.2.3 of TS 23.288 [4]. The event consumer may additionally specify user-, location- and/or application-based filters in its subscription request in order to further limit the events exposed to a subset of those permitted by the relevant provisioned data exposure restriction(s). Attempts by an event consumer to subscribe to event types that are not provisioned at the Data Collection AF instance are permitted, but will yield no event notifications until such event types have been successfully provisioned. + +NOTE 2: It is the responsibility of the event consumer to discover the relevant application identifier of interest by means outside the scope of the present document. + +Depending on the *data processing instructions* provisioned in the Data Collection AF, a data reporting record contributes to zero or more events exposed to subscribers at reference points R5 and/or R6. Conversely, an exposed event arises from one or more data reporting records. In the case of events synthesised by the Data Collection AF from multiple data reporting records, the timestamp of the event shall indicate when it was synthesised. Otherwise, the timestamp of the event shall be identical to the timestamp of the data reporting record from which it arose. + +The Data Collection AF exposes a batch of recent events to consumers (the NWDAF and/or Event Consumer AF) as an *event exposure notification*. + +### 4.6.2 Provisioning information for data collection and reporting + +A separate set of provisioning information shall be provided to the Data Collection AF at reference point R1 for each Event ID it is to expose. This provisioning information embodies the Service Level Agreement between the network operator and the Application Service Provider envisaged in clause 6.2.8.1 of TS 23.288 [4]. The provisioning information shall include at least the parameters defined in table 4.6.2-1 below: + +**Table 4.6.2-1: Baseline provisioning information for data collection and reporting** + +| Parameter | Cardinality | Description | +|---------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| External Application Identifier | 1..1 | The identifier to be used in reports sent to the Data Collection AF by data collection clients. (This needs to be mapped to the Internal Application Identifier when exposing events to the NWDAF.) | +| Internal Application Identifier | 1..1 | The identifier to be used by event consumers (including the NWDAF and the Event Consumer AF) when subscribing to events in the Data Collection AF. | +| Event ID | 1..1 | The identifier of an AF event that will be exposed to event consumers as a result of the provisioning. | +| Data collection client type | 1..1 | The type of data collection client that will submit data reports to the Data Collection AF. | +| Valid targets | 1..1 | A parameter to control whether event consumers are permitted to filter events by External UE identifier or External Group Identifier when subscribing, instead of receiving events relating to all UEs. | +| Parameters to be reported | 1..* | The subset of domain-specific parameters associated with the specified Event ID to be reported to the Data Collection AF (subject to user consent). | + +| | | | +|------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Data sampling rules | 0..* | Information to be forwarded by the Data Collection AF to the data collection client, representing instructions on how the subset of domain-specific parameters associated with the Event ID are to be sampled by the data collection client (e.g., sampling frequency, location filter).

Default values (which may be agreed between the ASP and the MNO) shall be assumed by the Data Collection AF for any rules that are omitted. | +| Data reporting rules | 0..* | Information to be forwarded by the Data Collection AF to the data collection client, representing instructions on how the data collection client is to report data to the Data Collection AF (e.g., reporting probability, reporting frequency, reporting format, data packaging strategy).

Default values (which may be agreed between the ASP and the MNO) shall be assumed by the Data Collection AF for any rules that are omitted. | +| Data processing instructions | 1..* | A set of operations to be performed by the Data Collection AF on the parameters reported according to clause 4.6.4 prior to exposure as an event at a particular access level.

The set of supported operations shall include at least those listed in table 4.5.2-1. | +| Data exposure restrictions | 1..* | A set of restrictions on the exposure of the collected data after any data processing, each corresponding to a different access level. | + +### 4.6.3 Configuration information for data collection clients + +All clients of the Data Collection AF wishing to report data shall first obtain a data collection and reporting configuration from the Data Collection AF at reference point R2, R3 or R4 (as appropriate). For each Event ID, the data collection and reporting configuration shall include at least the parameters defined in table 4.6.3-1 below: + +**Table 4.6.3-1: Baseline information for data collection and reporting configuration** + +| Parameter | Cardinality | Description | +|---------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| External Application Identifier | 1..1 | Identifies the UE Application to which this data collection and reporting configuration pertains.

Quoted in reports sent to the Data Collection AF. | +| Parameters to be collected | 1..* | The subset of domain-specific parameters associated with the specified Event ID to be collected by the Data Collection AF (subject to user consent). | +| Data sampling rules | 1..* | Instructions on how the subset of domain-specific parameters associated with the Event ID are to be sampled by the data collection client (e.g., sampling frequency, location filter). | +| Data reporting rules | 1..* | Instructions on how the data collection client is to report data to the Data Collection AF (e.g., reporting probability, reporting frequency, reporting format, data packaging strategy). | + +### 4.6.4 Information included in data reports to the Data Collection AF + +For each Event ID, the data report shall include at least the parameters as defined in table 4.6.4-1 below: + +**Table 4.6.4-1: Baseline information for data reporting** + +| Parameter | Cardinality | Description | +|---------------------------------|-------------|------------------------------------------------------------------------------| +| External Application Identifier | 1..1 | Identifies the UE Application to which this data report pertains. | +| Collected parameters | 1..* | The set of parameters collected by the data collection and reporting client. | + +## 4.7 Service exposure + +### 4.7.1 Service exposure via Network Exposure Function (NEF) + +The following services provided by a Data Collection AF deployed inside the trusted domain shall be exposed northbound by the NEF to an Application Service Provider outside the trusted domain, as depicted in clauses A.3 and A.4: + +- The *Ndcaf\_DataReportingProvisioning* service shall be exposed to Provisioning AF instances deployed outside the trusted domain as *Nnef\_DataReportingProvisioning*. See clause 6 of TS 26.532 [7] and clause 5.24 of TS 29.522 [10]. +- The *Ndcaf\_DataReporting* service shall be exposed to Indirect Data Collection Clients and Application Servers deployed outside the trusted domain as *Nnef\_DataReporting*. See clause 7 of TS 26.532 [7] and clause 5.23 of TS 29.522 [10]. +- The *Naf\_EventExposure* service shall be exposed to Event Consumer AF instances deployed outside the trusted domain as *Nnef\_EventExposure*. See TS 29.517 [5] and TS 29.522 [10]. + +The following services provided by an externally deployed Data Collection AF shall be exposed southbound by the NEF to Network Functions deployed inside the trusted domain, as depicted in clauses A.5: + +- The *Naf\_EventExposure* service shall be exposed to Event Consumer AF instances deployed inside the trusted domain as *Nnef\_EventExposure*. See TS 29.517 [5] and TS 29.591 [11]. + +### 4.7.2 Service exposure via Common API Framework (CAPIF) for Northbound APIs + +When CAPIF is supported, then: + +- the Data Collection AF shall support the CAPIF API provider domain functions as part of a distributed CAPIF deployment, i.e. *Ndcaf* and *Naf* via CAPIF-2/2e; and CAPIF-3, CAPIF-4 and CAPIF-5, as specified in clause 7.3 of TS 23.222 [8]; +- the Data Collection AF shall support the CAPIF Core Function and API provider domain functions as part of a centralised CAPIF deployment, i.e. *Ndcaf* and *Naf* via CAPIF-2/2e, as specified in clause 7.2 of TS 23.222 [8]. + +The CAPIF and associated API provider domain functions are specified in TS 23.222 [8]. + +### 4.7.3 Service exposure via Service Enabler Architecture Layer (SEAL) for Verticals + +The use of the SEAL framework for exposure of the *Ndcaf\_DataReportingProvisioning*, *Ndcaf\_DataReporting* and *Naf\_EventExposure* services is for future study. + +# 5 Procedures for data collection and reporting + +## 5.1 General + +This clause defines the high-level procedures for data collection and reporting. + +Figure 5.1-1 below depicts the case where all functional entities lie inside the trusted domain. The detailed steps for each phase are further elaborated in the following clauses. + +![Sequence diagram illustrating high-level procedures for data collection and reporting. Lifelines include NRF, Data Collection AF, NWDAF, Application Service Provider (Provisioning AF, Indirect Data Collection Client, Event Consumer AF), UE (UE Application, Direct Data Collection Client), and AS. The diagram is divided into phases: AF registration, Data collection and reporting provisioning, Event exposure subscription, Data collection and reporting client configuration, Data collection, reporting and exposure, and Unsubscribe.](86b4670fc1a5a694821ee92b99c1209a_img.jpg) + +``` + +sequenceDiagram + participant NRF + participant DCAF as Data Collection AF + participant NWDAF + subgraph ASP [Application Service Provider] + direction TB + P[Provisioning AF] + IDC[Indirect Data Collection Client] + ECA[Event Consumer AF] + end + subgraph UE [UE] + direction TB + UA[UE Application] + DCC[Direct Data Collection Client] + end + participant AS + + Note left of NRF: AF registration (see TS 23.501) + NRF->>DCAF: 1: Register Nnrf_NFManagement_NFRegister + DCAF-->>NRF: 2: Register Nnrf_NFManagement_NFRegister{EventIDs} + + Note left of NRF: Data collection and reporting provisioning + NRF->>P: 3: Discover Data Collection AF Nnrf_NFDiscovery + P->>DCAF: 4: Provision R1 Ndcaf_DataReportingProvisioning{EventID} + + Note left of NRF: Event exposure subscription + NRF->>DCAF: 5: Discover Data Collection AF Nnrf_NFDiscovery + DCAF-->>NRF: 6: Subscribe R5 Naf_EventExposure_Subscribe{Event ID} + NRF->>DCAF: 7: Discover Data Collection AF Nnrf_NFDiscovery + DCAF-->>NRF: 8: Subscribe R6 Naf_EventExposure_Subscribe{Event ID} + + Note left of UE: Data collection and reporting client configuration + DCC->>DCAF: 9: Create context R7 + DCAF-->>DCC: 10: Acquire data collection and reporting configuration R2 Ndcaf_DataReporting + Note right of DCC: Data collection and reporting configuration + DCAF->>IDC: 11: Acquire data collection and reporting configuration R3 Ndcaf_DataReporting + DCAF->>ECA: 12: Acquire data collection and reporting configuration R4 Ndcaf_DataReporting + + Note left of UE: Data collection, reporting and exposure + Note left of UE: Data reporting + Note left of UE: Direct reporting + UA->>DCAF: 13: Report data R7 + DCAF->>DCAF: 14: Submit data report R2 Ndcaf_DataReporting + Note left of UE: Indirect reporting + UA->>NWDAF: 15: Application-specific data reporting R8 (out-of scope) + Note right of NWDAF: {Out-of scope} + DCAF->>IDC: 16: Submit data report R3 Ndcaf_DataReporting + Note left of UE: AS reporting + DCAF->>ECA: 17: Submit data report R4 Ndcaf_DataReporting + DCAF->>DCAF: 18: Data report processing + Note right of DCAF: NWDAF + DCAF-->>NWDAF: 19: Event exposure R5 Naf_EventExposure_Notify{Event ID} + DCAF-->>ECA: 20: Event exposure R6 Naf_EventExposure_Notify{Event ID} + + Note right of DCAF: NWDAF + DCAF-->>NWDAF: 21: Unsubscribe R5 Naf_EventExposure_Unsubscribe{Event ID} + DCAF-->>ECA: 22: Unsubscribe R6 Naf_EventExposure_Unsubscribe{Event ID} + +``` + +Sequence diagram illustrating high-level procedures for data collection and reporting. Lifelines include NRF, Data Collection AF, NWDAF, Application Service Provider (Provisioning AF, Indirect Data Collection Client, Event Consumer AF), UE (UE Application, Direct Data Collection Client), and AS. The diagram is divided into phases: AF registration, Data collection and reporting provisioning, Event exposure subscription, Data collection and reporting client configuration, Data collection, reporting and exposure, and Unsubscribe. + +http://mmsc-generator.sourceforge.net/v7.2 + +Figure 5.1-1: High-level procedures for data collection and reporting + +## 5.2 Procedures for data collection and reporting provisioning + +![Sequence diagram showing AF registration and provisioning phases between NRF, Data Collection AF, NWDAF, and Application Service Provider (Provisioning AF).](4b87467ad9642943235f48f7d4b59449_img.jpg) + +``` + +sequenceDiagram + participant NRF + participant DCAF as Data Collection AF + participant NWDAF + participant ASPP as Application Service Provider + Note right of ASPP: Provisioning AF + + Note left of DCAF: AF registration (see TS 23.501) + Note right of DCAF: Data collection and reporting provisioning + + Note left of DCAF: par + Note right of DCAF: 1: Register + Note left of DCAF: Nnrf_NFManagement_NFRegister + Note right of DCAF: 2: Register + Note left of DCAF: Nnrf_NFManagement_NFRegister{EventIDs} + Note right of DCAF: end + + Note left of DCAF: 3: Discover Data Collection AF + Note right of DCAF: Nnrf_NFDiscovery + Note left of DCAF: 4: Provision R1 + Note right of DCAF: Ndcaf_DataReportingProvisioning{EventID} + +``` + +The diagram illustrates the interaction between four network functions: NRF, Data Collection AF, NWDAF, and Application Service Provider (containing Provisioning AF). It is divided into two main phases: AF registration and Data collection and reporting provisioning. In the registration phase, the NWDAF registers with the NRF (1: Register, Nnrf\_NFManagement\_NFRegister), and the Data Collection AF registers with the NRF (2: Register, Nnrf\_NFManagement\_NFRegister{EventIDs}). In the provisioning phase, the Provisioning AF discovers the Data Collection AF (3: Discover Data Collection AF, Nnrf\_NFDiscovery) and provisions data collection and reporting (4: Provision R1, Ndcaf\_DataReportingProvisioning{EventID}). + +Sequence diagram showing AF registration and provisioning phases between NRF, Data Collection AF, NWDAF, and Application Service Provider (Provisioning AF). + + + +**Figure 5.2-1: High-level procedures for AF registration and provisioning phases** + +Initially, the different types of AF register themselves with the NRF using the *Nnrf\_NFManagement\_NFRegister* service operation defined in clause 5.2.7.2.2 of TS 23.502 [3]: + +1. The NWDAF registers itself with the NRF. +2. The Data Collection AF registers itself with the NRF. This registration includes a list of Event IDs that it is capable of exposing to event consumers. + +At some later point, Data Collection and Reporting features are provisioned by the Application Service Provider's Provisioning AF: + +3. The Provisioning AF discovers the Data Collection AF by following the *Nnrf\_NFDiscovery* procedure defined in clause 5.2.7.3 of TS 23.502 [3]. +4. The Provisioning AF provisions data collection and reporting in the Data Collection AF for a specific Event ID, using the *Ndcaf\_DataReportingProvisioning* procedures defined in the present document. The provisioning information may vary depending on the data reporting method, i.e. direct reporting or indirect reporting. + +## 5.3 Procedures for Data Collection AF subscription + +Subsequently, one or more of the two types of event consumer discover the Data Collection AF and subscribe to events from it. + +![Sequence diagram illustrating the high-level procedures for subscription phase. The diagram shows two optional (opt) sequences for event exposure subscription. In the first sequence, the NWDAF discovers the Data Collection AF via Nnrf_NFDiscovery and then subscribes to an event using Naf_EventExposure_Subscribe{Event ID}. In the second sequence, the Event Consumer AF (part of the Application Service Provider) discovers the Data Collection AF via Nnrf_NFDiscovery and then subscribes to an event using Naf_EventExposure_Subscribe{Event ID}. Lifelines involved are NRF, Data Collection AF, NWDAF, and Event Consumer AF (within Application Service Provider).](a0739aaf13fa5a632d4faa830f6b2708_img.jpg) + +``` + +sequenceDiagram + participant NRF + participant DCAF as Data Collection AF + participant NWDAF + participant ESP as Application Service Provider + participant ECAF as Event Consumer AF + + Note right of ESP: Event Consumer AF + + opt Event exposure subscription: R5 + Note left of DCAF: opt + NWDAF->>NRF: 5: Discover Data Collection AF + NRF-->>NWDAF: Nnrf_NFDiscovery + NWDAF->>DCAF: 6: Subscribe R5 + DCAF-->>NWDAF: Naf_EventExposure_Subscribe{Event ID} + end + + opt Event exposure subscription: R6 + Note left of DCAF: opt + ECAF->>NRF: 7: Discover Data Collection AF + NRF-->>ECAF: Nnrf_NFDiscovery + ECAF->>DCAF: 8: Subscribe R6 + DCAF-->>ECAF: Naf_EventExposure_Subscribe{Event ID} + end + +``` + + v6.4.7 + +Sequence diagram illustrating the high-level procedures for subscription phase. The diagram shows two optional (opt) sequences for event exposure subscription. In the first sequence, the NWDAF discovers the Data Collection AF via Nnrf\_NFDiscovery and then subscribes to an event using Naf\_EventExposure\_Subscribe{Event ID}. In the second sequence, the Event Consumer AF (part of the Application Service Provider) discovers the Data Collection AF via Nnrf\_NFDiscovery and then subscribes to an event using Naf\_EventExposure\_Subscribe{Event ID}. Lifelines involved are NRF, Data Collection AF, NWDAF, and Event Consumer AF (within Application Service Provider). + +**Figure 5.3-1: High-level procedures for subscription phase** + +The steps are as follows: + +5. The NWDAF discovers the Data Collection AF by following the *Nnrf\_NFDiscovery* procedure defined in clause 5.2.7.3 of TS 23.502 [3]... +6. ...and then subscribes to event(s) of interest by invoking the *Naf\_EventExposure\_Subscribe* service operation defined in clause 5.2.19.2.2 of TS 23.502 [3] on the discovered Data Collection AF. As described in clause 4.6.1, user-, location- and/or application-based filters may be specified as additional input parameters to the operation. +7. The Event Consumer AF discovers the Data Collection AF by following the *Nnrf\_NFDiscovery* procedure defined in clause 5.2.7.3 of TS 23.502 [3]... +8. ...and then subscribes to event(s) of interest by invoking the *Naf\_EventExposure\_Subscribe* service operation defined in clause 5.2.19.2.2 of TS 23.502 [3] on the discovered Data Collection AF. + +## 5.4 Procedures for configuring data collection client + +At some later point, one or more of the three types of data collection client obtain their configuration from the Data Collection AF by invoking the *Ndcaf\_DataReporting* service defined in the present document and specified in TS 26.532 [7]. The intersection between the above provisioning information and current event consumer subscriptions determines the contents of this configuration. + +![Sequence diagram illustrating the high-level procedures for data collection client configuration phase. The diagram shows interactions between UE (UE Application, Direct Data Collection Client), Data Collection AF, and Application Service Provider (Indirect Data Collection Client, AS).](e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg) + +The diagram illustrates the sequence of messages for configuring data collection clients. It is divided into three main lifelines: UE (containing UE Application and Direct Data Collection Client), Data Collection AF, and Application Service Provider (containing Indirect Data Collection Client and AS). A shaded region labeled 'Data collection and reporting client configuration' encompasses the relevant steps. The sequence is as follows: + + +- An 'opt' block labeled '9: Create context R7' shows the UE Application sending a message to the Direct Data Collection Client, which then sends a message to the Data Collection AF. The AF responds with '10: Acquire client configuration R2' using the *Ndcaf\_DataReporting* service. The Direct Data Collection Client then provides the 'Data collection and reporting configuration' back to the UE Application. +- An 'opt' block labeled '11: Acquire client configuration R3' shows the Data Collection AF sending a message to the Indirect Data Collection Client using the *Ndcaf\_DataReporting* service. +- An 'opt' block labeled '12: Acquire client configuration R6' shows the Data Collection AF sending a message to the AS using the *Ndcaf\_DataReporting* service. + + A small note at the bottom right of the diagram indicates the source: [http://msc-generator.sourceforge.net v7.2](http://msc-generator.sourceforge.net). + +Sequence diagram illustrating the high-level procedures for data collection client configuration phase. The diagram shows interactions between UE (UE Application, Direct Data Collection Client), Data Collection AF, and Application Service Provider (Indirect Data Collection Client, AS). + +**Figure 5.4-1: High-level procedures for data collection client configuration phase** + +The steps are as follows: + +- If present in the instantiation, the UE Application creates a data collection and reporting context with the Direct Data Collection Client. As part of this context, the UE Application may indicate consent for a UE identifier to be included in data reports submitted on its behalf by the Direct Data Collection Client. + +- As a consequence of step 9 or (if the UE Application is not present) during its own initialisation, the Direct Data Collection Client acquires its data collection and reporting configuration from the Data Collection AF, if relevant. + +If the UE Application is instantiated, the Direct Data Collection Client provides it with a data collection and reporting configuration derived from that just obtained from the Data Collection AF. + +- The Indirect Data Collection Client acquires its data collection and reporting configuration from the Data Collection AF, if relevant. + +- The AS acquires its data collection and reporting configuration from the Data Collection AF, if relevant. + +Whenever the provisioning information changes, or the set of event exposure subscriptions changes, a new set of data collection and reporting configuration shall be made available to data collection clients by the Data Collection AF. + +## 5.5 Procedures for reporting to the Data Collection AF + +As specified in clause 6.2.8.2.1 of TS 23.288 [4], both the direct reporting procedure and indirect reporting procedure are required to be supported. The indirect reporting procedure may be used when a Direct Data Collection Client is not available in the UE or when the Indirect Data Collection Client needs to modify the collected UE data to satisfy the requirements of its data collection and reporting configuration. + +![Sequence diagram illustrating high-level procedures for data reporting and exposure phase. The diagram shows interactions between UE (UE Application, Direct Data Collection Client), Data Collection AF, and Application Service Provider (Provisioning AF, Indirect Data Collection Client, Event Consumer AF, AS).](4cde160bcc69b7b6c81b648dd0e4252e_img.jpg) + +The sequence diagram illustrates the 'Data collection, reporting and exposure' phase. It is structured as follows: + +- UE (User Equipment):** Contains 'UE Application' and 'Direct Data Collection Client'. +- Data Collection AF:** The central entity for data collection. +- Application Service Provider:** Contains 'Provisioning AF', 'Indirect Data Collection Client', 'Event Consumer AF', and 'AS' (Application Server). +- Sequence of Messages:** + - Data reporting:** + - Direct reporting:** UE Application sends '13: Report data R7' to Direct Data Collection Client. Direct Data Collection Client sends '14: Submit data report R2' to Data Collection AF via *Ndcaf\_DataReporting*. + - Indirect reporting:** UE Application sends '15: Application-specific data reporting R8' to Indirect Data Collection Client (out of scope). Indirect Data Collection Client sends '16: Submit data report R3' to Data Collection AF via *Ndcaf\_DataReporting*. + - AS reporting:** AS sends '17: Submit data report R4' to Data Collection AF via *Ndcaf\_DataReporting*. + - Data report processing:** Data Collection AF performs '18: Data report processing'. + - Event exposure:** Data Collection AF sends '19: Event exposure R5' to NWDAF via *Naf\_EventExposure\_Notify{Event ID}*. NWDAF then sends '20: Event exposure R6' to Event Consumer AF via *Naf\_EventExposure\_Notify{Event ID}*. + +Sequence diagram illustrating high-level procedures for data reporting and exposure phase. The diagram shows interactions between UE (UE Application, Direct Data Collection Client), Data Collection AF, and Application Service Provider (Provisioning AF, Indirect Data Collection Client, Event Consumer AF, AS). + + + +**Figure 5.5-1: High-level procedures for data reporting and exposure phase** + +The different data collection clients proceed as follows: + +13. If present in the instantiation, the UE Application reports data to the Direct Data Collection Client according to the configuration provided in step 10 for inclusion in a data report. The UE application may instruct the Direct Data Collection Client to prioritise immediate delivery of a UE data report to the Data Collection AF. +14. The Direct Data Collection Client may submit a data report to the Data Collection AF via reference point R2 by invoking the *Ndcaf\_DataReporting* service defined in the present document and specified in TS 26.532 [7]. The Direct Data Collection Client may indicate that the data report includes UE data requiring expedited processing by the Data Collection AF. +15. The UE Application may send application-specific data reporting to the Application Service Provider... +16. ...and the Indirect Data Collection Client may, as a result, submit a data report to the Data Collection AF by invoking the *Ndcaf\_DataReporting* service defined in the present document and specified in TS 26.532 [7]. +17. The AS may submit a data report to the Data Collection AF by invoking the *Ndcaf\_DataReporting* service defined in the present document and specified in TS 26.532 [7]. + +## 5.6 Procedures for Data Collection AF data exposure + +In response to receiving a data report: + +18. The Data Reporting AF processes the data report. + +Reception of a data report by the Data Collection AF may result in an event being exposed to subscribed event consumers: + +19. The Data Collection AF may expose an event to the NWDAF by invoking the *Naf\_EventExposure\_Notify* service operation on the latter, as defined in clause 5.2.19.2.4 of TS 23.502 [3]. +20. The Data Collection AF may expose an event to the Event Consumer AF by invoking the *Naf\_EventExposure\_Notify* service operation on the latter, as defined in clause 5.2.19.2.4 of TS 23.502 [3]. + +## 5.7 Procedures for Data Collection AF unsubscription + +![Sequence diagram showing high-level procedures for unsubscription phase. Lifelines: Data Collection AF, NWDAF, and Application Service Provider (containing Event Consumer AF).](9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg) + +The diagram illustrates the unsubscription phase with two optional (opt) message exchanges. In the first, the NWDAF sends a '21: Unsubscribe R5' message to the Data Collection AF, which includes the *Naf\_EventExposure\_Unsubscribe{Event ID}* service operation. In the second, the Event Consumer AF (inside the Application Service Provider) sends a '22: Unsubscribe R6' message to the Data Collection AF, also including the *Naf\_EventExposure\_Unsubscribe{Event ID}* service operation. A small note at the bottom right indicates the source as 'http://msc-generator.sourceforge.net v7.2'. + +Sequence diagram showing high-level procedures for unsubscription phase. Lifelines: Data Collection AF, NWDAF, and Application Service Provider (containing Event Consumer AF). + +Figure 5.7-1: High-level procedures for unsubscription phase + +Finally: + +21. The NWDAF unsubscribes to events from the Data Collection AF by invoking the *Naf\_EventExposure\_Unsubscribe* service operation, as defined in clause 5.2.19.2.3 of TS 23.502 [3]. +22. The Event Consumer AF unsubscribes to events from the Data Collection AF by invoking the *Naf\_EventExposure\_Unsubscribe* service operation, as defined in clause 5.2.19.2.3 of TS 23.502 [3]. + +## 5.8 Procedures for event consumer authorization + +The procedure for authorising access to the events exposed by the Data Collection AF is depicted by the following call flow: + +![Sequence diagram showing high-level procedures for event consumer authorization. Lifelines: Data Collection AF, Authorization AS, Provisioning AF, Event Consumer. The process involves provisioning, optional AS provisioning, a loop for NF service access authorization (subscribe, redirect, authorize, authorized), another optional AS validation, subscription confirmation, a loop for event notifications, and finally unsubscribing.](6ca05954842b17f14dfd52f26b9d43d2_img.jpg) + +``` + +sequenceDiagram + participant DC AF as Data Collection AF + participant AS as Authorization AS + participant PA AF as Provisioning AF + participant EC as Event Consumer (e.g. NWDAF or Event Consumer AF) + + Note left of DC AF: opt 1a: Authorization AS provisioning + DC AF->>PA AF: 1: Data collection and reporting provisioning + Note right of PA AF: Access Profile configuration + Note left of DC AF: opt + DC AF->>AS: 1a: Authorization AS provisioning + Note right of AS: Access Profile configuration + Note left of DC AF: opt NF service access authorization + Note right of EC: NF service access authorization + EC->>DC AF: 2: Subscribe to Event + Note right of DC AF: Event ID, (Filters) + DC AF->>EC: 3: Redirect to Authorization AS + Note right of DC AF: Authorization URL, Event ID + EC->>AS: 4: Authorize access + Note right of EC: Data Collection AF referer URL, Event ID, credentials + AS->>EC: 5: Authorized + Note right of AS: (Data Collection AF URL), (Data Access Profile ID), Access token + EC->>DC AF: 6: Subscribe to Event + Note right of DC AF: Event ID, (Filters), (Data Access Profile ID), access token + Note left of DC AF: opt 7: Validate access token + DC AF->>AS: 7: Validate access token + DC AF->>EC: 8: Confirm subscription based on Data Access Profile + Note left of DC AF: loop + DC AF->>EC: 9: Event notification + EC->>DC AF: 10: Unsubscribe from Event + Note right of DC AF: Event ID + +``` + + + +Sequence diagram showing high-level procedures for event consumer authorization. Lifelines: Data Collection AF, Authorization AS, Provisioning AF, Event Consumer. The process involves provisioning, optional AS provisioning, a loop for NF service access authorization (subscribe, redirect, authorize, authorized), another optional AS validation, subscription confirmation, a loop for event notifications, and finally unsubscribing. + +**Figure 5.8-1: High-level procedures for event consumer authorization** + +The steps are: + +1. The Provisioning AF provisions the data collection and the report exposure functionality at reference point R1, per the procedures in clause 5.2, including a set of Data Access Profiles. +- 1a. The Data Collection AF may provision the Authorization AS with a Data Access Profile configuration corresponding to step 1, including the Data Access Profile ID. The procedures used in this step are outside the scope of standardisation. +2. An event consumer sends a subscription request to the Data Collection AF to receive events via reference point R5 or R6, per the procedures in clause 5.3, indicating the Event ID of interest and any desired user-, location- and/or application-based filters (see clause 4.6.1). +3. In return, the Data Collection AF redirects the event consumer to the Authorization AS in order to obtain access. +4. The event consumer contacts the Authorization AS (according to the procedures for authorization of NF service access defined in clause 13.4 of TS 33.501 [9]) with a set of valid credentials. +5. If access is granted, the Authorization AS responds with an access token that is valid for a specific period of time. The access token may encode a Data Access Profile ID if the authorization applies narrowly. The response may redirect the event consumer to the Data Collection AF using the initial subscription request URL, enhanced with the access token and optionally with the Data Access Profile ID passed in the clear. + +6. The event consumer resends the subscription request (including the Event ID and desired filters, if any) to the Data Collection AF, this time with the access token and, optionally, with the Data Access Profile ID. +7. The Data Collection AF may verify the access token with the Authorization AS, or it may verify it locally. +8. If verification is successful, the Data Collection AF approves the subscription request for the requested Access Profile +9. The Data Collection AF sends event notifications to the event consumer, per the procedures in clause 5.6. +10. The event consumer cancels its event subscription using the procedures in clause 5.7. + +# --- Annex A (informative): Collaboration scenarios for data collection and reporting + +## A.1 General + +This annex documents a set of collaboration scenarios that illustrate potential deployments of the data collection and reporting architecture as defined in the present document. + +In deployment, it is possible that some UE data is provided to the Data Collection AF using the direct data reporting method at reference point R2, while other (application-private) UE data is collected via reference R8 and provided to the Data Collection AF via the indirect data reporting method at reference point R3 (R3' in Collaboration D). In certain domains, UE data is collected in the first instance by an AS and therefore needs to be provided to the Data Collection AF at reference point R4 (R4' in Collaboration D). Hence, all three data reporting reference points are potentially in scope for all of the documented collaboration scenarios. + +NOTE 1: In all of the documented collaboration scenarios, reference point R2 traverses the data plane between the Direct Data Collection Client and the Data Collection AF regardless of whether the latter is deployed inside or outside the trusted domain. + +NOTE 2: In all of the documented collaboration scenarios, reference point R8 traverses the data plane between the UE Application the Application Service Provider. The traffic carried at this reference point is tunnelled transparently through the trusted domain without interacting with any control plane entities. + +## A.2 Collaboration A + +In this collaboration scenario all of the functions are deployed inside the trusted domain. This corresponds to the case where the functional entities of the Application Service Provider as well as the Application Server (AS) are internal to the 5G System. + +NOTE: Although deployed within the trusted domain, and granted privileged access to certain Network Functions in the 5G System, the Application Service Provider and/or the AS may or may not be under direct control of the MNO in this collaboration scenario. For example, management of one or more of the functional entities may be delegated to a trusted third-party service provider. + +![Diagram of Collaboration A showing functional entities and their interfaces within a trusted domain.](a05e675f8651ae7ccea1d0d68691d1a9_img.jpg) + +The diagram illustrates the functional architecture for Collaboration A. On the left, a grey box labeled 'UE' contains a blue 'UE Application' and a red 'Direct Data Collection Client'. A vertical line labeled 'R7' connects them. In the center, a dashed box labeled 'Trusted domain' contains several components: a grey 'NRF' at the top, a red 'Data Collection AF' in the middle, and a grey 'NWDAF' at the bottom. A vertical line labeled 'R5' connects the 'Data Collection AF' and the 'NWDAF'. On the right, a blue 'Application Service Provider' box contains three components: a grey 'Provisioning AF', a red 'Indirect Data Collection Client', and a grey 'Event Consumer AF'. A vertical line labeled 'R8' connects the 'UE Application' to the 'Application Service Provider'. Horizontal lines connect the 'Direct Data Collection Client' to the 'Data Collection AF' (labeled 'R2'), the 'Data Collection AF' to the 'Provisioning AF' (labeled 'R1'), the 'Data Collection AF' to the 'Indirect Data Collection Client' (labeled 'R3'), the 'Data Collection AF' to the 'Event Consumer AF' (labeled 'R6'), and the 'Data Collection AF' to a grey 'AS' box (labeled 'R4'). + +Diagram of Collaboration A showing functional entities and their interfaces within a trusted domain. + +Figure A.2-1: Collaboration A with all functions deployed inside the trusted domain + +## A.3 Collaboration B + +In this collaboration scenario the functional entities of the Application Service Provider are deployed outside the trusted domain. Interactions between these functions and the Data Collection AF must therefore be mediated by the NEF. + +![Diagram of Collaboration B showing functional entities and their interactions within a 'Trusted domain'.](5478f70a6cef3e5672b2b22d28830cfb_img.jpg) + +The diagram illustrates the architecture for Collaboration B. A central 'Trusted domain' (dashed box) contains the NRF, Data Collection AF, NEF, AS, and NWDAF. The Data Collection AF is the central component, connected to the NRF above it and the NWDAF below it via R5. To the right, the NEF mediates interactions between the Data Collection AF and the Application Service Provider (ASP) via R1, R3, and R6. The Data Collection AF also connects to the AS via R4. On the left, the UE contains a UE Application and a Direct Data Collection Client. The UE Application connects to the ASP via R8 and to the Direct Data Collection Client via R7. The Direct Data Collection Client connects to the Data Collection AF via R2. The ASP contains three functional entities: Provisioning AF, Indirect Data Collection Client, and Event Consumer AF. + +Diagram of Collaboration B showing functional entities and their interactions within a 'Trusted domain'. + +Figure A.3-1: Collaboration B with all functions of Application Service Provider deployed outside the trusted domain + +## A.4 Collaboration C + +This collaboration scenario illustrates the case where the Application Server (AS) is also deployed outside the trusted domain (in addition to the functional entities of the Application Service Provider per Collaboration B). In this case, the AS must therefore additionally interact with the Data Collection AF via the NEF. + +![Diagram of Collaboration C showing network architecture with UE, Data Collection AF, NEF, NRF, NWDAF, and Application Service Provider components.](a4b963a07cc368283154762c4b156fe7_img.jpg) + +The diagram illustrates the network architecture for Collaboration C. A central 'Trusted domain' is enclosed in a dashed box and contains the following components: NRF (top), Data Collection AF (center), NEF (right of Data Collection AF), and NWDAF (bottom). Outside the trusted domain, the following components are present: UE (left), UE Application (top left of UE), Direct Data Collection Client (middle left of UE), Application Service Provider (right), Provisioning AF (top right of AS), Indirect Data Collection Client (middle right of AS), Event Consumer AF (bottom right of AS), and AS (bottom right of Event Consumer AF). The interfaces are labeled as follows: R7 between UE Application and Direct Data Collection Client; R8 between UE Application and Data Collection AF; R2 between Direct Data Collection Client and Data Collection AF; R1 between Data Collection AF and Provisioning AF; R3 between Data Collection AF and Indirect Data Collection Client; R6 between Data Collection AF and Event Consumer AF; R4 between Data Collection AF and AS; R5 between Data Collection AF and NWDAF. + +Diagram of Collaboration C showing network architecture with UE, Data Collection AF, NEF, NRF, NWDAF, and Application Service Provider components. + +Figure A.4-1: Collaboration C with all functions of Application Service Provider and Application Server deployed outside the trusted domain + +## A.5 Collaboration D + +In this collaboration scenario, the Data Collection AF itself is deployed outside the trusted domain and interactions with functions inside the trusted domain occur via the NEF. This scenario corresponds to the "Procedure for Data Collection from AF via NEF" defined in clause 6.2.2.3 of TS 23.288 [4]. Specifically: + +- The externally deployed Data Collection AF registers with the NRF inside the trusted domain using the *Nnef\_NFManagement* service via the NEF. + +NOTE: In practice, the Data Collection AF is instantiated as a subfunction of a domain-specific Application Function. The enclosing Application Function should include data collection and reporting capabilities in its own registration with the NRF on behalf of the enclosed Data Collection AF rather than making a separate registration for the subfunction. + +- The NWDAF inside the trusted domain uses the *Nnef\_EventExposure* service (as specified in clause 5.2.6.2 of TS 23.502 [3]) to subscribe to and receive events exposed by the externally deployed Data Collection AF. + +![Figure A.5-1: Collaboration D with Data Collection AF deployed outside the trusted domain. The diagram shows a UE (User Equipment) on the left containing a UE Application and a Direct Data Collection Client. The UE Application connects to an Application Service Provider (ASP) via the R8 interface. The Direct Data Collection Client connects to a Data Collection AF via the R2 interface. The ASP contains a Provisioning AF, an Indirect Data Collection Client, and an Event Consumer AF. The Data Collection AF connects to the ASP via interfaces R1', R3', R6', and R4'. The Data Collection AF also connects to an AS (Application Server) via the R4' interface. The Data Collection AF registers with the NRF via the NEF (R8 interface). The NEF connects to the NWDAF via the R5 interface. The NWDAF connects to the Data Collection AF via the R2 interface. The NEF also connects to the Data Collection AF via the R2 interface. The Data Collection AF is outside the Trusted domain, while the NRF, NEF, and NWDAF are inside it.](446100c084b94817a19c319fa776b412_img.jpg) + +Figure A.5-1: Collaboration D with Data Collection AF deployed outside the trusted domain. The diagram shows a UE (User Equipment) on the left containing a UE Application and a Direct Data Collection Client. The UE Application connects to an Application Service Provider (ASP) via the R8 interface. The Direct Data Collection Client connects to a Data Collection AF via the R2 interface. The ASP contains a Provisioning AF, an Indirect Data Collection Client, and an Event Consumer AF. The Data Collection AF connects to the ASP via interfaces R1', R3', R6', and R4'. The Data Collection AF also connects to an AS (Application Server) via the R4' interface. The Data Collection AF registers with the NRF via the NEF (R8 interface). The NEF connects to the NWDAF via the R5 interface. The NWDAF connects to the Data Collection AF via the R2 interface. The NEF also connects to the Data Collection AF via the R2 interface. The Data Collection AF is outside the Trusted domain, while the NRF, NEF, and NWDAF are inside it. + +**Figure A.5-1: Collaboration D with Data Collection AF deployed outside the trusted domain** + +The functional entities of the Application Service Provider, as well as the Application Server (AS), interact with the externally deployed Data Collection AF using interfaces that are outside the scope of 3GPP specification. However, the interactions at reference points R1', R3', R4' and R6' are expected to be functionally equivalent to those at R1, R3, R4 and R6 respectively. + +## A.6 Collaboration E + +In this collaboration scenario, the Data Collection Client is deployed as a subfunction of the UE Application. As a consequence of this arrangement, reference point R7 is subsumed into the UE Application. + +This collaboration may be combined with any of the preceding collaboration scenarios. Hence, only reference points R2 and R8 are depicted in the figure in the interests of brevity. + +![Diagram of Collaboration E showing the UE Application, Direct Data Collection Client, Data Collection AF, and Application Service Provider.](ac31fdfebb9751f7f10416dfe33bc872_img.jpg) + +The diagram illustrates the architecture for Collaboration E. A large grey rectangle labeled 'UE' contains a light blue rectangle labeled 'UE Application'. Inside the 'UE Application' is a smaller red rectangle labeled 'Direct Data Collection Client'. A line labeled 'R2' connects the 'Direct Data Collection Client' to a red rectangle labeled 'Data Collection AF' located outside the 'UE' box. Another line labeled 'R8' connects the 'UE Application' to a large light blue rectangle labeled 'Application Service Provider' located to the right of the 'UE' box. + +Diagram of Collaboration E showing the UE Application, Direct Data Collection Client, Data Collection AF, and Application Service Provider. + +**Figure A.6-1: Collaboration E with Data Collection Client deployed as part of the UE Application** + +The Direct Data Collection Client could, for example, be realised as a software library that implements the appropriate protocol at reference point R2. In such a realisation, the procedures defined in the present document at reference point R7 would likely form the API of the Data Collection Client library. + +# --- Annex B (normative): UE data domain ownership + +## B.1 General + +Ownership of any UE data domain not listed in this annex shall be specified in the document defining that domain. + +## --- B.2 Baseline UE data domains + +Table B.1-1 specifies ownership of the baseline UE data domains defined in TS 23.288 [4]. + +**Table B.2-1: Ownership of baseline UE data domains** + +| UE data domain | Owner | +|---------------------------|-----------------| +| Service Experience | 5G System (MNO) | +| UE Location | 5G System (MNO) | +| Communication | 5G System (MNO) | +| Performance | 5G System (MNO) | +| Planned Trips | 5G System (MNO) | + +Application-specific UE data domains shall be owned by the ASP. + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|-----------------------|----------------------------------------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-06 | Post-SA4#115-e ad hoc | | | | | Initial skeleton document. | 0.0.1 | +| 2021-08 | SA4#115-e | S4-211037
S4-211218
S4-211232 | | | | Addition of reference architecture and collaboration scenarios.
References to CAPIF as an implementation option. | 0.1.0 | +| 2021-10 | Post-SA4#115-e ad hoc | S4a1211226
S4a1211227
S4a1211233 | | | | Additional collaboration scenario.
Additional service-based reference architecture figure.
Informative note declaring R7 for future study. | 0.1.1 | +| | | S4a1211236
S4a1211242
S4a1211244 | | | | Domain model.
High-level procedures.
Corrections and updates to editor's notes. | 0.1.2 | +| 2021-11 | SA4#116-e | S4-211590
S4-211591 | | | | Clarification of direct and indirect reporting.
Miscellaneous clarifications and corrections. | 0.2.0 | +| 2021-12 | SA#94-e | SP-211342 | | | | Presentation to SA plenary for information | 1.0.0 | +| 2021-12 | Post-SA4#116-e ad hoc | S4-a1211254 | | | | Domain model revisited. | 1.0.1 | +| 2022-02 | SA4#117-e | S4-200243 | | | | S4-220240: Data exposure restriction model. | 1.1.0 | +| 2022-03 | Post-SA4#117-e ad hoc | S4a1221307 | | | | S4-220240: Added missing subheadings in clause 4.5. | 1.1.1 | +| | | S4a1221317 | | | | Replacement figure 4.5.2-1 showing Data Access Profile identifier. | 1.1.2 | +| 2022-04 | SA4#118-e | S4-220349 | | | | Resolution of Editor's Notes. | 1.2.0 | +| 2022-05 | SA4#119-e | S4-220637 | | | | Draft presentation to TSG. | 2.0.0 | +| | | S4-220807 | | | | Revised presentation to TSG | 2.1.0 | +| 2022-06 | SA#96 | SP-220603 | | | | Under Change Control | 17.0.0 | +| 2022-09 | SA#97-e | SP-220757 | 0001 | 1 | F | [EVEX] Miscellaneous corrections and clarifications | 17.1.0 | +| 2023-06 | SA#100 | SP-230550 | 0005 | 1 | F | [EVEX] Provisioning of Data Collection and Reporting Configuration | 17.2.0 | +| 2023-06 | SA#100 | SP-230550 | 0006 | 1 | F | [EVEX] Precedence Rules on Data Collection, Reporting and Event Exposure | 17.2.0 | +| 2023-09 | SA#101 | SP-23092- | 0007 | 1 | B | [TEI18, ADAE, EVEX] UE Application instructing DDCC for immediate data report delivery | 18.0.0 | +| 2023-12 | SA#102 | SP-231510 | 0008 | 2 | F | Clarification on data reporting methods | 18.1.0 | \ No newline at end of file diff --git a/marked/Rel-18/26_series/26565/1b5a812c8aa20fd5cba28e97001d32de_img.jpg b/marked/Rel-18/26_series/26565/1b5a812c8aa20fd5cba28e97001d32de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d7888fe5e1f2f6e29cb3c5b959eff9afd0120e04 --- /dev/null +++ b/marked/Rel-18/26_series/26565/1b5a812c8aa20fd5cba28e97001d32de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7a90f4f2320eae6cce406d64bd762417aaf7a71566b6f580e7426f4b58f68a74 +size 126865 diff --git a/marked/Rel-18/26_series/26565/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/marked/Rel-18/26_series/26565/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..88f851dfbc1229ef419c944d39d56f56245b7c62 --- /dev/null +++ b/marked/Rel-18/26_series/26565/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:532ed570c445b3d246065caacfd9e7de977873f398d95ff48819ab64dc13617a +size 55561 diff --git a/marked/Rel-18/26_series/26565/5a4e62bead259c258d069fd3663ea670_img.jpg b/marked/Rel-18/26_series/26565/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..88076f08d361e91b3eb9a285fc5645f14044aff8 --- /dev/null +++ b/marked/Rel-18/26_series/26565/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:abaf17a9186deb577c399145f57aa3b1fbb846d15c4c08a8149e2350d6075c89 +size 56599 diff --git a/marked/Rel-18/26_series/26565/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/26_series/26565/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9649640e915abd93ec8bd126b92decf22762f91d --- /dev/null +++ b/marked/Rel-18/26_series/26565/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a3b80767c654a857c2dfed523b71f1e3357297a118ea12b061f77017e17cc97e +size 9997 diff --git a/marked/Rel-18/26_series/26565/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/26_series/26565/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..822ad6c64de47d52d8d3cf8e5a0c1622c28dc1f9 --- /dev/null +++ b/marked/Rel-18/26_series/26565/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7ee25acb0b5b75a4abfe99bff5e6e18525819da2b2f8c1588fbc88804b69eaa3 +size 5707 diff --git a/marked/Rel-18/26_series/26565/73b28b0f5e3be628bb5a3d6bd1d79d21_img.jpg b/marked/Rel-18/26_series/26565/73b28b0f5e3be628bb5a3d6bd1d79d21_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9ac7a2bf4e8320846b2d44f8ba65e25df9b0a7ce --- /dev/null +++ b/marked/Rel-18/26_series/26565/73b28b0f5e3be628bb5a3d6bd1d79d21_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e8e0c93a1cc640663c979c778163bfa1f0245c80e5d17369a5831b7fe7676291 +size 161585 diff --git a/marked/Rel-18/26_series/26565/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg b/marked/Rel-18/26_series/26565/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7432893a9de6816f189826fa85c728d90b469395 --- /dev/null +++ b/marked/Rel-18/26_series/26565/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:374dadf10488bb3ff90a95153c4ab2450c1141629f148e2ae787ce1d483c3e01 +size 78411 diff --git a/marked/Rel-18/26_series/26565/af6be343f0c0a8f155f965dcf337b8af_img.jpg b/marked/Rel-18/26_series/26565/af6be343f0c0a8f155f965dcf337b8af_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..224aa454c27bb769203fb669383503a8d168ddd8 --- /dev/null +++ b/marked/Rel-18/26_series/26565/af6be343f0c0a8f155f965dcf337b8af_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0044d858ceed4fe705fd21fee3e5dff92f8976a607b2fafb3fab49eb8deffb1e +size 36119 diff --git a/marked/Rel-18/26_series/26565/e6df2733626a85205c1db682e6259c46_img.jpg b/marked/Rel-18/26_series/26565/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..684dcfbba615cb5b24a88680cf146b73ad95ff2e --- /dev/null +++ b/marked/Rel-18/26_series/26565/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:49ea34714dbb4a217b706e3be6be984e132c3dada09262657e77d7ce71d7c73c +size 79406 diff --git a/marked/Rel-18/26_series/26565/e9d825d87c5f85c8dba0664eace96ef4_img.jpg b/marked/Rel-18/26_series/26565/e9d825d87c5f85c8dba0664eace96ef4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1bc230e9f21dee9f5d25c9658ba9fb7bbe6fd8bd --- /dev/null +++ b/marked/Rel-18/26_series/26565/e9d825d87c5f85c8dba0664eace96ef4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4d4eb8e13da530a178a6ed76e4496135f7d9103f7eb627081e52b4de85ebd5a7 +size 83022 diff --git a/marked/Rel-18/26_series/26565/raw.md b/marked/Rel-18/26_series/26565/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e6c74a8cb27f6ec61dd6f2c0a07afb5e4a84b620 --- /dev/null +++ b/marked/Rel-18/26_series/26565/raw.md @@ -0,0 +1,1955 @@ + + +# 3GPP TS 26.565 V18.3.0 (2025-06) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Split Rendering Media Service Enabler; (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green wave-like graphic above the 'G', and the word 'ADVANCED' in smaller black letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| Introduction ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations ..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 General ..... | 8 | +| 4.1 Overview ..... | 8 | +| 4.2 Typical Use Cases ..... | 9 | +| 5 Reference Architecture and Procedures..... | 9 | +| 5.1 Reference Architecture..... | 9 | +| 5.1.1 Introduction ..... | 9 | +| 5.1.2 Client Architecture ..... | 9 | +| 5.1.3 End-to-End Architecture ..... | 10 | +| 5.1.4 User Plane Architecture..... | 11 | +| 5.2 Procedures and Call Flows..... | 12 | +| 5.2.1 Call flow for Split Rendering instance discovery..... | 12 | +| 5.2.2 Call flow for Split Rendering session setup ..... | 14 | +| 6 Prerequisites ..... | 15 | +| 6.1 General ..... | 15 | +| 6.2 Pre-requisites on 5G System ..... | 15 | +| 6.3 Pre-requisites on Device APIs and Functionality ..... | 15 | +| 7 Network Support..... | 16 | +| 7.1 Overview ..... | 16 | +| 7.2 Provisioning ..... | 16 | +| 7.3 Dynamic Policy and Network Assistance..... | 16 | +| 7.4 Edge Resources ..... | 16 | +| 7.5 Metrics and Consumption Reporting ..... | 17 | +| 8 Split Rendering User Plane ..... | 17 | +| 8.1 General ..... | 17 | +| 8.2 Split Rendering Signalling Protocols ..... | 17 | +| 8.3 Split Rendering Formats for Media and Metadata ..... | 19 | +| 8.3.1 General ..... | 19 | +| 8.3.2 Metadata Formats ..... | 19 | +| 8.3.3 Metadata Data Channel Message Format..... | 19 | +| 8.4 Split Rendering Formats for Session Setup and Negotiation..... | 20 | +| 8.4.1 General ..... | 20 | +| 8.4.2 Split Rendering Configuration Format ..... | 20 | +| 8.4.3 Output Format Description ..... | 23 | +| 8.5 Split Rendering Transport Protocols ..... | 23 | +| 9 Split Rendering Client..... | 23 | +| 9.1 Functionality..... | 23 | +| 9.2 Client API..... | 23 | +| 9.3 Split Rendering Metrics ..... | 25 | +| 9.3.1 General ..... | 25 | +| 9.3.2 QoE Metrics Formats ..... | 25 | +| 9.3.3 QoE Metrics reporting protocol..... | 28 | +| 9.3.4 QoE metrics definition ..... | 28 | +| 9.3.5 Quality metrics reporting..... | 35 | + +| | | | +|---------|------------------------------------------------------------------------|----| +| 10 | Security and Privacy Aspects..... | 37 | +| 10.1 | Security..... | 37 | +| 10.2 | Privacy..... | 37 | +| A.1 | Guidelines for Application Developers..... | 38 | +| A.2 | Guidelines for Split Rendering MSE Implementers ..... | 38 | +| A.2.1 | Guidelines for implementers of the Split Rendering Server ..... | 38 | +| A.3 | Conformance Testing..... | 38 | +| C.1 | Pixel Streaming Profile ..... | 40 | +| C.1.1 | Introduction ..... | 40 | +| C.1.2 | 2D Pixel Streaming Profile ..... | 40 | +| C.1.2.1 | Introduction ..... | 40 | +| C.1.2.2 | SRC Capabilities ..... | 40 | +| C.1.2.3 | SRS Capabilities..... | 41 | +| C.1.2.4 | Profile identifier..... | 41 | +| C.1.3 | 3D Pixel Streaming Profile ..... | 41 | +| C.1.3.1 | Introduction ..... | 41 | +| C.1.3.2 | SRC Capabilities ..... | 41 | +| C.1.3.3 | SRS Capabilities..... | 42 | +| C.1.3.4 | Profile identifier..... | 43 | +| C.1.4 | Description of the Rendering Format for Pixel Streaming Profiles ..... | 43 | +| C.1.4.1 | General ..... | 43 | +| C.1.4.2 | 3D Pixel Streaming Profile-specific glTF Extension ..... | 43 | +| C.1.5 | Profile Restrictions and Requirements..... | 47 | +| C.2 | Adaptive Split Rendering Profile ..... | 47 | +| C.2.1 | Introduction ..... | 47 | +| C.2.2 | Procedures and Call Flows..... | 47 | +| C.2.3 | Metadata Formats..... | 49 | +| C.2.3.1 | Split Rendering Configuration Format..... | 49 | +| C.2.3.2 | Split Adaptation Message Format ..... | 50 | +| C.2.3.3 | State Synchronization Message Format ..... | 50 | +| C.2.4 | SRC Capabilities ..... | 51 | +| C.2.4.1 | Media Capabilities..... | 51 | +| C.2.4.2 | Metadata Formats ..... | 52 | +| C.2.4.3 | Rendering format description..... | 52 | +| C.2.4.4 | Scene Processing and Rendering Capabilities..... | 52 | +| C.2.5 | SRS Capabilities..... | 52 | +| C.2.5.1 | Media Capabilities..... | 52 | +| C.2.5.2 | Metadata Capabilities ..... | 53 | +| C.2.5.3 | Scene Processing and Rendering Capabilities..... | 53 | +| C.2.6 | Profile identifiers..... | 53 | +| C.2.7 | Extension to Client API Functions..... | 53 | +| C.2.8 | Implementation Guidelines for Adaptive Split Rendering..... | 54 | +| C.2.8.1 | General ..... | 54 | +| C.2.8.2 | Guidelines for Rendering Split and Composition ..... | 54 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +This specification defines a media service enabler for split rendering in the 5G system. + +# --- 1 Scope + +The present document defines a Media Service Enabler for Split Rendering according to the guidelines of TR26.857 [1]. The Split Rendering MSE covers functionality on the UE and on the Media AS. It also defines an API that is exposed to application developers on the UE to start and manage split rendering sessions. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 26.857: "5G Media Service Enablers". +- [2] ISO/IEC 12113:2022, Information technology, Runtime 3D asset delivery format, Khronos glTF 2.0 +- [3] ISO/IEC 23090-14: Information technology — Coded representation of immersive media — Part 14: Scene Description for MPEG Media. +- [4] 3GPP TS 26.119, Media Capabilities for Augmented Reality +- [5] 3GPP TS 26.506, 5G Real-time Media Communication Architecture (Stage 2) +- [6] 3GPP TS 26.113, Real-Time Media Communication; Protocols and APIs +- [7] 3GPP TS 26.512, 5G Media Streaming (5GMS); Protocols +- [8] 3GPP TS 26.522, 5G Real-time Media Transport Protocol Configurations +- [9] 3GPP TS 26.510, Media Delivery: interactions and APIs for provisioning and media session handling +- [10] Khronos, The OpenXR API, +- [11] W3C, WebXR Device API, WebXR Device API ([immersive-web.github.io](https://immersive-web.github.io)) +- [12] Khronos, WebGL Specification 1.0, WebGL Specification ([khronos.org](https://khronos.org)) +- [13] W3C, Web Audio API, Web Audio API ([w3.org](https://w3.org)) +- [14] 3GPP TS23.501, System architecture for the 5G System (5GS). +- [15] 3GPP TS23.503, 5G; Policy and charging control framework for the 5G System (5GS). +- [16] 3GPP TS26.857, 5G Media Service Enablers. +- [17] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Services (PSS); Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [18] 3GPP TS 26.501, 5G Media Streaming (5GMS); General description and architecture. + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**example:** text used to clarify abstract rules by applying them literally. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----------|---------------| +| | | +|----------|---------------| + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|--------|------------------------------------| +| AF | Application Function | +| AS | Application Server | +| MAF | Media Access Function | +| MAP | Media Application Provider | +| MSH | Media Session Handler | +| MSE | Media Service Enabler | +| 5G-RTC | 5G Real-Time Communication | +| RTC | Real-Time Communication | +| SR | Split Rendering | +| SRC | Split Rendering Client | +| SRS | Split Rendering Server | +| SWAP | Simple WebRTC Application Protocol | +| UE | User Equipment | +| XR | eXtended Reality | + +# --- 4 General + +## 4.1 Overview + +The Split Rendering Media Service Enabler collects a set of 5G media functions to build a media service enabler that targets application developers, network operators, and Media Application Providers, to enable the realization of split rendered applications. + +The interfaces, formats, protocols, and APIs are either referenced or defined in this specification. This will allow for interoperability between multiple vendor implementations. + +This specification targets primarily XR applications. However, it is not limited to XR applications and may be used for rendering for 2D displays. + +## 4.2 Typical Use Cases + +A typical use case for the split rendering MSE is immersive gaming. In this use case, the UE benefits from invoking split rendering by avoiding the download of the game to the phone and getting high quality graphics from edge rendering. + +Another use case that can benefit from split rendering is immersive communication, where users gather in a shared space and interact with each other and with the environment. Users may be represented by sophisticated Avatars and as the number of users increases the rendering will become more complex. + +# --- 5 Reference Architecture and Procedures + +## 5.1 Reference Architecture + +### 5.1.1 Introduction + +In this clause, different variants of the reference architecture for the split rendering Media Service Enabler (MSE) are defined, each representing a different perspective and level of details. + +The following functions are introduced: + +- Split-Rendering Client (SRC): This function is responsible for discovering the UE media capabilities and negotiating with the Split-Rendering Server (SRS) to agree on the split-rendering process. +- Split-Rendering Server (SRS): This function is responsible for negotiation of SR session with SRC, monitoring the server's edge resource usage, and managing/running the split rendering process. +- Media Application Function (AF): responsible for provisioning, QoS allocation, and edge resource discovery. +- Media Application Provider: The Media Application Provider that offers the service. +- Application: The application running on UE. +- Media Session Handler (MSH): is the entity on UE that is responsible for the control plane communication with the AF. +- XR Runtime: Set of functions provided by XR Device to the XR Application to create XR experiences. + +### 5.1.2 Client Architecture + +The client architectural breakdown is based on the client architecture in TS 26.119 [4] clause 5.1. The figure depicting the client architecture is replicated here as Figure 5.1.2-1 for convenience. + +![Figure 5.1.2-1 - XR Baseline terminal architecture diagram. The diagram shows the internal components of an XR Baseline Client and its interfaces to external systems. The client contains an Application, XR Runtime, XR Source Management, Presentation engine, Scene Manager, and Media Access Function. External systems include Sensors, Cameras, Actuators, Displays, Speakers, Microphones, and a 5G System (Uu). Interfaces are labeled IF-1a, IF-1b, IF-1c, IF-2, IF-3, IF-4, IF-5, IF-6, IF-7, IF-8, IF-9, and IF-10. APIs are labeled API-1, API-2, API-6, and API-7.](e6df2733626a85205c1db682e6259c46_img.jpg) + +The diagram illustrates the XR Baseline terminal architecture. At the top, 'User input' is shown entering the 'Application' block. The 'Application' block is connected to several internal components via interfaces: IF-10 to the 'XR Runtime', IF-2 to 'XR Source Management', IF-7 to the 'Scene Manager', IF-6 to the 'Media Session handler', and IF-8 to the '5G System (Uu)'. The 'XR Runtime' block contains 'Runtime functions (tracking, SLAM...)', 'Composition', and 'Audio Subsystem'. It has interfaces IF-1a, IF-1b, and IF-1c. IF-1a connects to 'Sensors' and 'Cameras'. IF-1b connects to 'Actuators', 'Displays', and 'Speakers'. IF-1c connects to 'Microphones'. The 'XR Source Management' block has an API-2 interface. The 'Presentation engine' block contains 'Visual renderer' and 'Audio renderer' and is connected to the 'Scene Manager' via IF-3. The 'Scene Manager' is connected to the 'Media Access Function' via IF-9. The 'Media Access Function' block contains 'Content delivery protocols', 'Metadata formats', 'Video codecs', and 'Audio codecs'. It has an API-7 interface and is connected to the 'Media Session handler' via IF-6 and IF-7. The 'Media Session handler' block has an API-6 interface and is connected to the '5G System (Uu)' via IF-5. The '5G System (Uu)' is a large vertical block on the right side of the diagram. + +Figure 5.1.2-1 - XR Baseline terminal architecture diagram. The diagram shows the internal components of an XR Baseline Client and its interfaces to external systems. The client contains an Application, XR Runtime, XR Source Management, Presentation engine, Scene Manager, and Media Access Function. External systems include Sensors, Cameras, Actuators, Displays, Speakers, Microphones, and a 5G System (Uu). Interfaces are labeled IF-1a, IF-1b, IF-1c, IF-2, IF-3, IF-4, IF-5, IF-6, IF-7, IF-8, IF-9, and IF-10. APIs are labeled API-1, API-2, API-6, and API-7. + +Figure 5.1.2-1 - XR Baseline terminal architecture + +The split rendering client consists of the following components: + +- The Media Access Functions: allows for fetching and processing of the pre-rendered media in preparation of final display. The MAF is also responsible for the carriage of any metadata or local media to the split rendering server. +- The Scene Manager and “thin” Presentation Engine: is responsible for the negotiation of the split rendering session and the parsing of the description of the rendered media as provided by the SRS. It is also responsible for setting up and managing the XR session with the XR runtime. +- The XR Source Management is responsible for gathering timed metadata such as pose and action information and sending it to the SRS. +- XR Runtime: Set of functions provided by XR Device to the XR Application to create XR experiences. + +### 5.1.3 End-to-End Architecture + +![Figure 5.1.3-1 – Split management architecture diagram. The diagram shows the interaction between a User Equipment (UE) and a Data Network (DN). In the UE, there is an Application, XR Runtime, Media Session Handler (MSH), and Split Rendering Client (SRC). In the DN, there is a Media AF, Split Rendering Server (SRS), and an Application Provider. Interfaces are labeled M1 through M8. M1 is between Media AF and Application Provider. M2 is between SRS and Application Provider. M3 is between Media AF and SRS. M4 is between SRC and SRS. M5 is between MSH and Media AF. M7 is between XR Runtime and SRC. M8 is between Application and Application Provider. M11 is between SRC and MSH. A legend indicates that green boxes represent 'Split Rendering' components, blue boxes represent 'External' components, solid lines represent interfaces 'In SR MSE scope', and dashed lines represent interfaces 'Out of SR MSE scope'. Red circles on the SRC and SRS indicate 'Exposed API'.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +Figure 5.1.3-1 – Split management architecture diagram. The diagram shows the interaction between a User Equipment (UE) and a Data Network (DN). In the UE, there is an Application, XR Runtime, Media Session Handler (MSH), and Split Rendering Client (SRC). In the DN, there is a Media AF, Split Rendering Server (SRS), and an Application Provider. Interfaces are labeled M1 through M8. M1 is between Media AF and Application Provider. M2 is between SRS and Application Provider. M3 is between Media AF and SRS. M4 is between SRC and SRS. M5 is between MSH and Media AF. M7 is between XR Runtime and SRC. M8 is between Application and Application Provider. M11 is between SRC and MSH. A legend indicates that green boxes represent 'Split Rendering' components, blue boxes represent 'External' components, solid lines represent interfaces 'In SR MSE scope', and dashed lines represent interfaces 'Out of SR MSE scope'. Red circles on the SRC and SRS indicate 'Exposed API'. + +**Figure 5.1.3-1 – Split management architecture** + +As shown in Figure 5.1.3-1: + +1. The Media Application Provider (MAP) provisions the split-rendering through M1. +2. In the use cases in which the MAP is involved in the media delivery, the M2 interface is used for this purpose. +3. The communication between Media AF and SRS is through M3. This interface is out of the scope of this document. This interface may for instance include the EDGE-3 interface. +4. The signalling as well as the media delivery between SRC and SRS is though M4. +5. The Media AF may provide SR-related information to the Media Session Handler (MSH) through the M5 interface, as defined in TS26.510 [9]. +6. The SRC in the UE discovers the application through M11 and handles the XR runtime. +7. The SRC discovers the client media capabilities through the M7 interface. This interface is out of the scope of this document. +8. The 5G Application and MAP interact through M8. This interface is out of the scope of this document. + +### 5.1.4 User Plane Architecture + +Figure 5.1.4-1 depicts the user plane architecture for split rendering. + +![Figure 5.1.4-1: User Plane Architecture for Split management architecture. The diagram shows a UE on the left connected to a Media AS on the right. The Media AS contains three internal components: Split Rendering Server (SRS), SWAP Server, and Other Functions. The UE is connected to the SRS via an M4 (RTC-4m) interface. The UE is also connected to the SWAP Server via an M4 (RTC-4s) interface. The UE is also connected to the Other Functions via an M4 (RTC-4s) interface. The SRS is connected to the SWAP Server via a vertical double-headed arrow. The SRS is also connected to an Application Provider on the right via an M2 interface.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +Figure 5.1.4-1: User Plane Architecture for Split management architecture. The diagram shows a UE on the left connected to a Media AS on the right. The Media AS contains three internal components: Split Rendering Server (SRS), SWAP Server, and Other Functions. The UE is connected to the SRS via an M4 (RTC-4m) interface. The UE is also connected to the SWAP Server via an M4 (RTC-4s) interface. The UE is also connected to the Other Functions via an M4 (RTC-4s) interface. The SRS is connected to the SWAP Server via a vertical double-headed arrow. The SRS is also connected to an Application Provider on the right via an M2 interface. + +Figure 5.1.4-1 – User Plane Architecture for Split management architecture + +In the context of split rendering, the M4 interface is further classified as RTC-4s and RTC-4m sub-interfaces. The RTC-4s interface covers all user-plane signalling, including WebRTC and ICE signalling. The RTC-4m serves for media and metadata exchange between the split rendering client and the split rendering server. + +## 5.2 Procedures and Call Flows + +### 5.2.1 Call flow for Split Rendering instance discovery + +#### 5.2.1.1 Call flow for edge server and split rendering session setup + +Figure 5.2.1.1-1 demonstrates a general call flow for split-rendering. + +![Figure 5.2.1.1-1: High-level call flow for split-rendering. The diagram is a sequence diagram showing interactions between UE, Media AS, Media AF, and Application Provider. Step 1: Optional message '1: M1/3/5: Edge resource provisioning & configuration' from Application Provider to Media AS, Media AF, and UE. Step 2: Message '2: M1/5: Split-rendering provisioning' from Application Provider to Media AS and Media AF. Step 3: Message '3: M4: Split-Rendering Session Setup' from UE to Media AS. A small URL 'https://gitlab.com/msc-generator v8.3' is visible at the bottom right.](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +Figure 5.2.1.1-1: High-level call flow for split-rendering. The diagram is a sequence diagram showing interactions between UE, Media AS, Media AF, and Application Provider. Step 1: Optional message '1: M1/3/5: Edge resource provisioning & configuration' from Application Provider to Media AS, Media AF, and UE. Step 2: Message '2: M1/5: Split-rendering provisioning' from Application Provider to Media AS and Media AF. Step 3: Message '3: M4: Split-Rendering Session Setup' from UE to Media AS. A small URL 'https://gitlab.com/msc-generator v8.3' is visible at the bottom right. + +Figure 5.2.1.1-1: High-level call flow for split-rendering + +Steps: + +1. In this optional step, the Media Application Provider requests and sets up the edge server(s) used for the split-rendering as described in TS 26.506 [5] clauses 6.1 or 6.2. The Media Application Provider may use any other method to allocate edge servers, or leave it to the MNO to set up appropriate edge servers to run the split-rendering process. +2. The Media Application Provider provisions the split-rendering session using M1 and M3, as defined in call flow of clauses 5.2.1.1. If the edge servers were provisioned in step 1, the edge servers ids are provided in this session to employ them for split-rendering. + +NOTE: In the case of the client-driven edge management (TS 26.501 [18], clause 8.1), only the client-driven split-rendering (5.2.1.1) is applicable. + +3. The split-rendering session is set up according to clause 5.2.2. + +#### 5.2.1.2 Client-driven procedures and call flows + +Figure 5.2.1.2-1 demonstrates a call flow for setting up the split rendering by the client. + +![Sequence diagram showing the high-level call flow for initiating a split. Lifelines: Application, Media Session Handler/Device Functions, Split-Rendering Client (SRC), Split-Rendering Server (SRS), Media AF, and Application Provider. The process includes provisioning, information acquisition, request for split rendering, discovery of SRS, negotiation, and the start of the rendering process, followed by a render loop.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +``` + +sequenceDiagram + participant Application + participant MSH as Media Session Handler/Device Functions + participant SRC as Split-Rendering Client (SRC) + participant SRS as Split-Rendering Server (SRS) + participant MediaAF as Media AF + participant AP as Application Provider + + Note left of Application: SR session establishment + Note left of Application: Render loop + + Application->>MediaAF: 1: M1: Provisioning + MediaAF-->>AP: + Note right of AP: 2: M8: Application information acquisition (not in scope) + Application->>SRC: 3: M7: Request for split rendering + SRC->>MSH: 4: M11: Discover SRS + Note right of SRC: Negotiation + SRC->>SRS: 5: M4 (RTC-4s): Negotiate split rendering session + SRS-->>SRC: + Note right of SRS: 6: Start split-rendering process + SRS->>MSH: 7: Apply dynamic policy and network assistance + MSH->>SRC: 8: M4 (RTC-4s): Establish WebRTC session for split rendering + SRC->>MSH: 9: M7: inform application about state change + Note right of SRC: 10: M4 (RTC-4m): send uplink metadata + Note right of SRC: 11: M4 (RTC-4m): send rendered media + SRC->>SRS: + +``` + +Sequence diagram showing the high-level call flow for initiating a split. Lifelines: Application, Media Session Handler/Device Functions, Split-Rendering Client (SRC), Split-Rendering Server (SRS), Media AF, and Application Provider. The process includes provisioning, information acquisition, request for split rendering, discovery of SRS, negotiation, and the start of the rendering process, followed by a render loop. + +Figure 5.2.1.2-1: High-level call flow for initiating a split + +Steps: + +1. The Media Application Provider requests from the Media AF, the creation of a Provisioning session for split rendering. +2. The SR configuration is announced to the MSH as part of the Service Access Information. +3. The Application requests the deployment of split rendering from the SRC. +4. The SRC requests the discovery of a suitable SRS from the MSH. It may provide the client's media capabilities as input parameters. +5. The SRC and SRS negotiate the configuration of the split rendering session. +6. The SRS starts the split rendering process. + +7. The SRC provides the session information via the M11 interface and requests the application of dynamic policy and subscription to network assistance from the Media AF, via the MSH. +8. The SRC establishes the WebRTC session. +9. The SRC informs the application that the split-rendering on edge is running via M7. +10. The SRC sends uplink metadata, such as pose and action information. +11. The SRS sends the rendered media to the SRC. + +### 5.2.2 Call flow for Split Rendering session setup + +The split rendering operation can be described by the call flow in Figure 5.2.2-1. + +![Sequence diagram showing the high-level call flow for split rendering session setup and operation. The diagram involves four main lifelines: XR Runtime, Split Rendering Client (containing Scene Manager, XR Source Management, and Media Access Function), and Split Rendering Server. The process is divided into two phases: Session Setup and negotiation, and Rendering Loop. The sequence of messages is: 1. create a split rendering session, 2. send description of split rendering output, 3. establish transport connections (e.g. WebRTC session), 4. receive pose information and user actions, 5. transmit pose information and user actions, 6. perform rendering for requested pose(s), 7. send next buffer frame, 8. decode and process buffer frame, 9. pass raw buffer frames for display, 10. compose and render frame.](1b5a812c8aa20fd5cba28e97001d32de_img.jpg) + +``` + +sequenceDiagram + participant XR_Runtime as XR Runtime + subgraph Split_Rendering_Client [Split Rendering Client] + direction TB + SM[Scene Manager (thin Presentation Engine)] + XSM[XR Source Management] + MAF[Media Access Function] + end + participant Split_Rendering_Server as Split Rendering Server + + Note left of XR_Runtime: Session Setup and negotiation + SM->>Split_Rendering_Server: 1: create a split rendering session + Split_Rendering_Server-->>SM: 2: send description of split rendering output + SM->>Split_Rendering_Server: 3: establish transport connections +e.g. WebRTC session + + Note left of XR_Runtime: Rendering Loop + XR_Runtime->>XSM: 4: receive pose information and user actions + XSM->>Split_Rendering_Server: 5: transmit pose information and user actions + Note right of Split_Rendering_Server: 6: perform rendering for requested pose(s) + Split_Rendering_Server-->>MAF: 7: send next buffer frame + Note right of MAF: 8: decode and process buffer frame + MAF->>SM: 9: pass raw buffer frames for display + Note left of XR_Runtime: 10: compose and render frame + +``` + + v7.2 + +Sequence diagram showing the high-level call flow for split rendering session setup and operation. The diagram involves four main lifelines: XR Runtime, Split Rendering Client (containing Scene Manager, XR Source Management, and Media Access Function), and Split Rendering Server. The process is divided into two phases: Session Setup and negotiation, and Rendering Loop. The sequence of messages is: 1. create a split rendering session, 2. send description of split rendering output, 3. establish transport connections (e.g. WebRTC session), 4. receive pose information and user actions, 5. transmit pose information and user actions, 6. perform rendering for requested pose(s), 7. send next buffer frame, 8. decode and process buffer frame, 9. pass raw buffer frames for display, 10. compose and render frame. + +**Figure 5.2.2- 1 High-level call flow for split rendering session setup and operation** + +The steps are: + +1. The Presentation Engine discovers the split rendering server and sets up a connection to it. It provides information about its rendering capabilities and the XR runtime configuration, e.g the OpenXR configuration may be used for this purpose. +2. In response, the split rendering server creates a description of the split rendering output and the input it expects to receive from the UE. +3. The Presentation Engine requests the buffer streams from the MAF, which in turn establishes a connection to the split rendering server to stream pose and retrieve split rendering buffers. + +4. The Source Manager retrieves pose and user input from the XR runtime. +5. The Source Manager shares the pose predictions and user input actions with the split rendering server. +6. The split rendering server uses that information to render the frame. +7. The rendered frame is encoded and streamed down to the MAF. +8. The MAF decodes and processes the received frame. +9. The MAF passes the decoded frame to the Scene Manager which passes it to the XR Runtime. +10. The XR runtime composes and renders the frame onto the display. + +# --- 6 Prerequisites + +## 6.1 General + +The below section provides guidance on the pre-requisites on the 5G system and device APIs in order to host and run a split rendering session. + +Pre-requisites document what is expected to be available either from the 5G System (i.e. certain functionalities of the 5G System) or from implementation (for example functions available on the device). These pre-requisites may be considered to be part of the specification (as reference to an external specification), but it is important to identify them separately in order to clearly demarcate the boundaries of the split rendering MSE with respect to other functions. + +## 6.2 Pre-requisites on 5G System + +Pre-requisites on the 5G System include, but are not limited to: + +- The split rendering session is expected to operate in the 5G system as specified in [14] that supports functionalities and procedures to configure the quality of service (QoS) and charging information and functionality, which may be used by split rendering sessions. +- The split rendering session is expected to operate within the 5G system as specified in [14], which supports functionalities and procedures to configure policy and charging control (PCC) information as specified in [15]. Split rendering sessions may benefit from these procedures. +- The split rendering server functionality may operate within the 5G system as specified in [14], which supports the discovery of and access to edge resources. The edge functionality may be used to deploy split rendering server functionality. + +## 6.3 Pre-requisites on Device APIs and Functionality + +The following assumptions for the split rendering client are made: + +- The SRC may have access to an XR runtime through a well-defined API such as the OpenXR [10] or WebXR [11] APIs. +- The SRC has access to 3D graphics library, such as. WebGL [12], and to an audio rendering engine, such as WebAudio [13]. + +# 7 Network Support + +## 7.1 Overview + +The Split Rendering MSE stands to benefit from the several procedures that the network offers. These include but are not limited to: + +- Dynamic QoS and charging, +- Edge resources, +- Consumption and metrics reporting, +- Configuration Information. + +In this clause, the control plane procedures that are relevant for split rendering and their usage are described. + +## 7.2 Provisioning + +A Media Application Provider that wishes to offer applications using split rendering shall use the procedures and data models defined in TS 26.510 [9] clauses 6 and 8 to create a Provisioning Session with the Media AF. + +The `ProvisioningSessionType` shall be set to “`BIDIRECTIONAL`”. + +The `aspId` shall be configured and shall be a unique identifier for the Media Application Provider that offers split rendering. + +The `externalApplicationId` shall be a URN that uniquely identifies the application and shall be terminated by the sub-string “`+3gpp-sr`”. An example is as follows: “`urn:com:example:game+3gpp-sr`”. + +## 7.3 Dynamic Policy and Network Assistance + +Dynamic policy and network assistance may be provisioned by the Media Application Provider with the Media AF. The allowed dynamic policies for the split rendering sessions of the Media Application Provider are communicated to the MSH in the UE using the Configuration procedure. + +Upon the creation of a new split rendering session and upon eligibility, the MSH shall use the Dynamic Policy API to request the allocation of network resources and charging policy to the session based on the information in the corresponding Provisioning session. + +A policy template that is provisioned for split rendering should be associated with the split rendering configuration. + +The MSH and the WebRTC Signaling Server shall support the dynamic policy API as defined in clause 10.4 of TS 26.113 [6]. + +The Media Application Provider may provision support for PDU Set marking. The SRS shall support the PDU Set marking and should support the End of Burst marking for the RTP streams that are generated by the Split Rendering Server. + +## 7.4 Edge Resources + +A Media Application Provider may use the procedures defined in TS 26.510 [9] clause 8.6 to define an edge resource configuration to be used for split-rendering sessions. + +In this case: + +- The `eligibilityCriteria` shall be present and shall have `appRequest` set to true. +- The `easRequirements` shall indicate “`SR`” as the `easType` and shall include “`3gpp-sr`” among the `easFeatures`. The `serviceKpi` shall be present and indicate the SRS processing and networking capabilities and requirements. + +## 7.5 Metrics and Consumption Reporting + +The Media Application Provider may use the Provisioning procedure to configure the collection of split rendering metrics and logging of consumption statistics. When present, this information shall be passed to the MSH using the Service Access Information procedure. + +The SRC shall collect and report the data for a split rendering session that matches the criteria for metrics and/or consumption reporting as indicated by the configuration procedure. + +# 8 Split Rendering User Plane + +## 8.1 General + +The user plane for split rendering covers all traffic between the SRC and SRS, or the SRC and any other Media AS. The common formats for split rendering are defined in this clause. Split rendering profiles may define additional user plane formats. + +This clause illustrates the protocol stack for the User plane transport related to the signalling as well as the media delivery between SRC and SRS through M4. + +| Signaling Path | | Media Path | | +|-------------------------------|--------------------|---------------------------|---------------------------------| +| Session Negotiation and Setup | | Data | Metadata | +| Configuration Format | Description Format | Media Formats | Metadata Formats | +| SR Signaling Protocol | | Media Data Stream Format | Metadata Channel Message Format | +| SWAP (TS26.113) | | Media Transport (RFC8834) | Data Channel (RFC8831) | +| RTC-4s | | RTC-4m | | + +Figure 8.1-1 Split rendering protocol Stack + +## 8.2 Split Rendering Signalling Protocols + +Both SRC and SRS shall support the SWAP protocol as defined in TS 26.113 [6] clause 13.2. + +The SWAP protocol allows for the definition of application-specific messages. + +The following application-specific messages shall be supported for split rendering: + +- The configuration message carries the split rendering configuration information from the SRC to the SRS. It shall be identified by the type “**urn:3gpp:split-rendering:sr-configuration**” and the object shall be formatted according to clause 8.4.2.2. +- The rendering description message carries the description of the split rendered media from the SRS to SRC. The format of the message is SR-profile-specific and shall be defined by each profile. It shall be identified by the type “**urn:3gpp:split-rendering:sr-description**”. The rendering description message provides the semantics of the media that is delivered over WebRTC from the SRS to SRC. + +The SWAP message exchange for the establishment of a split rendering session is depicted by the following call flow diagram: + +![Sequence diagram showing the SWAP message exchange for the establishment of a split rendering session between SRC, SWAP Server, and SRS.](8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg) + +``` + +sequenceDiagram + participant SRC + participant SWAP Server + participant SRS + + Note right of SWAP Server: 2: match end point + Note right of SRS: 5: Process SR configuration + Note left of SRC: 9: Process rendering description + + SRC->>SWAP Server: 1: App-specific message on SR configuration + SWAP Server-->>SRS: 3: Forward app-specific SR configuration message + SRS-->>SWAP Server: 6: App-specific message on rendering description + SWAP Server-->>SRC: 7: Forward app-specific message on rendering description + SRC->>SWAP Server: 10: Connect message with SDP offer + SWAP Server-->>SRS: 12: Accept message with SDP answer + SRS-->>SWAP Server: 13: Acknowledge message forwarded + SWAP Server-->>SRC: 11: Acknowledge message forwarded + +``` + +The diagram illustrates the call flow for SWAP message exchange between a Source (SRC), a SWAP Server, and a Sink (SRS). The sequence of messages is as follows: + + +- The SRC sends an "App-specific message on SR configuration" to the SWAP Server. +- The SWAP Server identifies the matching end point (SRS). +- The SWAP Server forwards the "App-specific SR configuration message" to the SRS. +- The SRS processes the SR configuration. +- The SRS sends an "App-specific message on rendering description" to the SWAP Server. +- The SWAP Server forwards this message to the SRC. +- The SRC processes the rendering description. +- The SRC sends a "Connect message with SDP offer" to the SWAP Server. +- The SWAP Server forwards the "Accept message with SDP answer" to the SRS. +- The SRS sends an "Acknowledge message forwarded" to the SWAP Server. +- The SWAP Server sends an "Acknowledge message forwarded" to the SRC. + +Sequence diagram showing the SWAP message exchange for the establishment of a split rendering session between SRC, SWAP Server, and SRS. + + + +**Figure 8.2-1 Call flows for SWAP message exchange** + +Pre-requisites: + +- The SRC has discovered the identifier of the SRS that it will use for its split rendering session. +- The SRC has retrieved the address of the SWAP server as part of the configuration. + +The steps are as follows: + +1. The SRC sends the configuration message as an application-specific SWAP message to the SWAP server. It provides the identifier of the target SRS as a matching criteria. +2. The SWAP server uses the provided matching criteria to locate the SRS. +3. The SWAP server forwards the configuration message to the target SRS. +4. The SWAP server confirms the successful forwarding of the message to the SRC. +5. The SRS processes the SR configuration message. It may for instance verify application and resource availability, launch the application, configure its rendering, and create a rendering description. +6. The SRS sends the rendering description message as an application-specific SWAP message to the SWAP server. +7. The SWAP server forwards the message to the SRC. + +8. The SWAP server acknowledges the successful forwarding of the message to the SRS. +9. The SRC processes the rendering description and identifies the required data channel and media sessions. +10. SRC sends a connect message with the SDP offer to the SRS. The offer reflects the negotiated media and data channel streams. +11. The SWAP server acknowledges the forwarding of the message to the SRS. +12. The SRS replies with an accept message that includes the SDP answer. The SDP answer reflects the information that was provided in the split rendering description. +13. The SWAP server acknowledges the forwarding of the message to the SRC. + +## 8.3 Split Rendering Formats for Media and Metadata + +### 8.3.1 General + +This clause defines media and metadata formats that are common to one or more split rendering profiles. + +### 8.3.2 Metadata Formats + +#### 8.3.2.1 General + +Both SRC and SRS shall support the usage of the WebRTC data channel for the exchange of split rendering metadata. The WebRTC data channel shall declare “3gpp-sr” as the data channel sub-protocol. The message content format depends on the type of the message. The data channel sub-protocol is defined in clause 8.3.3. + +Message types shall be unique identifiers in the URN format. This clause defines a set of message types and their formats. The messages are derived from the OpenXR API to ensure smooth operation with AR devices that support OpenXR. In case other XR APIs are used, mapping the message payload to the appropriate XR API structures shall be performed by the split rendering client. + +#### 8.3.2.2 Pose Format + +The pose format that is used by all split rendering profiles defined by this specification shall comply with the format defined in TS 26.119 [4] clause 12.2. The pose information shall be carried as part of the data channel messaging mechanism defined in clause 8.3.3 and shall be provided in JSON format. The message type shall be “urn:3gpp:split-rendering:v1:pose”. + +#### 8.3.2.3 Action Format + +The action information format that is used by all split rendering profiles defined by this specification shall comply with the format defined in TS 26.119 [4] clause 12.3. The action information shall be carried as part of the data channel messaging mechanism defined in clause 8.3.3 and shall be provided in JSON format. The message type shall be “urn:3gpp:split-rendering:v1:action”. + +### 8.3.3 Metadata Data Channel Message Format + +For the carriage of metadata defined in clause 8.3, such as pose and action information, the SRS and SRC shall use the WebRTC data channel. The data channel sub-protocol shall be identified as “3gpp-sr-metadata”, which shall be included in the demap attribute of the SDP. + +The transmission order for the data channel shall be set to in-order and the transmission reliability shall be set to reliable. + +The split rendering metadata message format shall be set to text-based and the messages shall be UTF-8 encoded JSON messages. + +A data channel message may carry one or more split rendering messages as defined in Table 8.3.3-1. + +**Table 8.3.3-1 Split Rendering Metadata Messages Format** + +| Name | Type | Cardinality | Description | +|----------|----------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| messages | Array(Message) | 1..n | A list of split rendering metadata messages. Each message shall be formatted according to the Message data type as defined in Table 8.3.3-2. | + +Each split rendering message shall follow the format specified in Table 8.3.3-2. + +**Table 8.3.3-2 Split Rendering Metadata Message Data Type** + +| Name | Type | Cardinality | Description | +|--------------------------|--------|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| id | string | 1..1 | An unique identifier of the message in the scope of the data channel session. | +| Type | string | 1..1 | A urn that identifies the message type. | +| Message | object | 1..1 | The message content depends on the message type. | +| sendingAtTime (ref. T1') | number | 0..1 | The time when the split rendering metadata message is transmitted from the split rendering client to the split rendering server. | + +## 8.4 Split Rendering Formats for Session Setup and Negotiation + +### 8.4.1 General + +In Figure 5.2.1.2-1, in step 5, the negotiation between the SRC and SRS for the split-rendering configuration takes place. The detailed call flow for such a negotiation between the SRC and the SRS may vary. Depending upon the split rendering profile, the negotiation between the SRC and the SRS may be straight forward or go back and forth. + +In the simplest case, the SRC provides SRS the capabilities of the device and if SRS can accommodate the split-rendering processing that addresses the device's needs and capabilities, it confirms by providing a description of the output format. In such scheme, the SRS is responsible to make the decision and no back-and-forth negotiation occurs. + +### 8.4.2 Split Rendering Configuration Format + +#### 8.4.2.1 Introduction + +The Split Rendering client establishes an XR session locally based on the device configuration and user selection. The SR client defines the view configuration (e.g. mono or stereo views), the projection format (such as projection, equirectangular, quad, or cubemap), the swap chain image configuration, etc. + +In addition, XR space and action configurations are negotiated between the SR client and server. This includes defining common XR spaces and defining and selecting actions and action sets. + +The format is extensible to support the exchange of additional/future configuration information. + +#### 8.4.2.2 Split Rendering Configuration Format + +The session configuration information shall be in JSON format. It shall have the following format: + +Table 8.4.2.2-1 Split Rendering Configuration Format + +| Name | Type | Cardinality | Description | +|-----------------------|------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| renderingFlags | Array(SR_CONFIG_FLAGS) | 0..1 | Provides a set of flags to activate/deactivate selected rendering functions. The defined SR_CONFIG_FLAGS are:
  • - FLAG_ALPHA_BLENDING
  • - FLAG_DEPTH_COMPOSITION
  • - FLAG_EYE_GAZE_TRACKING
| +| splitRenderingProfile | array(URI) | 0..1 | A list of supported split-rendering profile identifiers on the UE. The profile identifiers are listed in Annex C for each profile. | +| deviceCapabilities | Object | 0..1 | Device capabilities as defined in TS 26.119 [4], clause 6.1. | +| spaceConfiguration | Object | 0..1 | The space configuration is typically sent by the split rendering server to the split rendering client. Upon reception of this information, the SR client uses this information to create the reference and action spaces as well as to agree on common identifiers for the XR spaces. | +| referenceSpaces | Array | 0..1 | An array of reference spaces and their identifiers. | +| id | number | 1..1 | A unique identifier of the XR space in the context of the split rendering session. | +| refSpace | enum | 1..1 | One of the defined reference spaces in OpenXR. These may be:
XR_REFERENCE_SPACE_TYPE_VIEW,
XR_REFERENCE_SPACE_TYPE_LOCAL, or
XR_REFERENCE_SPACE_TYPE_STAGE. | +| actionSpaces | Array | 0..1 | An array of action spaces that need to be defined by the split rendering client in the XR session. | +| id | number | 1..1 | A unique identifier of the XR space in the context of the split rendering session. | +| actionId | number | 1..1 | Provides the unique identifier of the action. | +| subactionPath | string | 1..1 | The subaction path identifies the action, which can then be mapped by the XR runtime to user input modalities. | +| initialPose | Pose | 0..1 | Provides the initial pose of the new XR space's origin. | + +| | | | | +|----------------------|--------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| viewConfiguration | Object | 0..1 | Conveys the view configuration that is configured for the XR session. | +| type | Enum | 1..1 | The type indicates the view configuration. Defined values are MONO and STEREO. Other values may be added. | +| width | number | 1..1 | The recommended width of the swapchain image. | +| height | number | 1..1 | The recommended height of the swapchain image. | +| compositionLayer | string | 1..1 | An identifier of the selected composition layer. | +| minPoseInterval | number | 0..1 | The minimum time interval between two consecutive pose information instances sent to the network, in milliseconds. | +| fovs | Array | 0..1 | An array that provides a list of the field of views (FoV) associated with each view. | +| fov | Object | 1..n | Indicates the four sides of the field of view used for the projection of the corresponding XR view. The number of views n is determined by the type enum of the viewConfiguration . Both the viewPoses in the Pose Format and the fovs arrays shall be ordered in a consistent way (i.e., a same index can be used to retrieve the view pose and the related FoV information). | +| angleLeft | number | 1..1 | The angle of the left side of the field of view. For a symmetric field of view this value is negative. | +| angleRight | number | 1..1 | The angle of the right side of the field of view. | +| angleUp | number | 1..1 | The angle of the top part of the field of view. | +| angleDown | number | 1..1 | The angle of the bottom part of the field of view. For a symmetric field of view this value is negative. | +| environmentBlendMode | enum | 1..1 | The type indicates the environment blend mode configuration. Defined values are OPAQUE, ADDITIVE and ALPHA_BLEND. Other values may be added. | +| actionConfiguration | Array | 0..1 | This contains a list of the actions that are to be defined by the SR client. | +| action | Object | 1..n | A definition of a single action object. | +| id | number | 1..1 | A unique identifier of the action. | +| actionType | enum | 1..1 | The type of the action state. This can be a Boolean, float, vector2, pose, vibration output, etc. | + +| | | | | +|---------------------|--------|------|---------------------------------------------------------------------------------------------------------------------------------------------| +| subactionPaths | string | 1..n | An array of subaction paths associated with this action. The split rendering client will provide the state of all defined sub-action paths. | +| extraConfigurations | Object | 0..1 | A placeholder for addition configuration information. | + +### 8.4.3 Output Format Description + +The output format description depends on the split rendering profile and is defined by the split rendering profile in Annex C. + +## 8.5 Split Rendering Transport Protocols + +Split Rendering shall use WebRTC for the real-time transport of the rendered media. The RTP restrictions for WebRTC as specified in RFC8834 shall apply. The usage of the WebRTC data channel shall be in accordance with RFC8831. + +The RTP Header Extension for PDU Set Marking specified in clause 4.2 of TS 26.522 [8] shall be used for PDU set marking. For XR pose information transmission in RTP headers, RTP Header Extension for XR Pose specified in clause 4.3 of TS 26.522 [8] shall be used. + +# --- 9 Split Rendering Client + +## 9.1 Functionality + +The Split Rendering Client (SRC) is a function that runs on the UE to provide split rendering functionality to applications. The SRC is designed to be offered as an SDK to application developers. The SRC abstracts the details of the split rendering operation and provides a simple to use API to the application to facilitate the usage of split rendering. + +The SRC performs the following functions: + +- Creates and manages the XR session, +- Discovers and selects a split rendering server (SRS) in the network, +- Establishes a split rendering session with the SRS, +- Communicates the necessary information about the session to the MSH/AF to benefit from dynamic policy, network assistance, consumption reporting, etc. +- Operates the rendering loop on the UE. + +## 9.2 Client API + +As described in clause 5.1.3, the SRC exposes an API over M7 interface to the application. The SRC defines the following interface: + +Table 9.2-1 Split Rendering Client API + +| Method | Parameters | | State after Success | Description | +|--------------------|--------------------------------------------------------------------|------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| | in | out | | | +| SplitRenderer() | - appId
- appId?
-
- externalServiceId?
- preferences? | -
srSessionId | STATE_PROCESSING | Creates a SplitRenderer instance, representing the SRC, which can subsequently be used to connect to an SRS and perform split rendering. | +| getState() | - srSessionId | - state | N/A | Returns the current state of the SRC. Possible states are: STATE_IDLE, STATE_PROCESSING, STATE_READY, STATE_RUNNING, STATE_STOPPED. | +| getConfiguration() | - srSessionId | - configuration | N/A | Allows the application to query the current configuration of the split rendering session. | +| start() | - srSessionId | - boolean | STATE_RUNNING | Instructs the SRC to discover and connect to an SRS.

If current state is not STATE_READY, the connection will fail. | +| stop() | - srSessionId
- reason | | STATE_STOPPED | Terminates the connection to the SRS. | +| release() | - srSessionId | | STATE_IDLE | Releases all resources associated with the Split Rendering session. | +| getMetrics() | - srSessionId
- metrics | - metrics report | N/A | Retrieves a set of metric reports for the split rendering session that describe the quality of experience of the session. | + +NOTE: A “?” symbol appended to a parameter indicates the parameter is optional. + +The application is able to subscribe to events related to the split rendering session by setting the corresponding event handler. + +The supported events are: + +- State change: the state of the SR session has changed +- Error: an error has occurred during the split rendering session. The error is not severe enough to cause a state change to the STATE\_ERROR state. +- Quality change: the SRC has observed a change in the quality of the split rendering session. This may involve one or more SR metrics. + +The Preferences object shall contain the following information: + +- Information about the desired rendering, e.g. choose to render on 2D device or on one of the available connected XR devices. + +The criteria object may contain the following information: + +- Requirements for latency and bitrate that are different from the ones in the provisioning, +- KPIs for the SRS instance, such as its graphics capabilities or current load. + +The parameters are defined as follows: + +- aspid: a string that holds an identifier of the application service provider. The value is provisioned by the application service provider as defined in TS 26.510 [9]. +- appId: a string that holds an identifier of the application. This value is provisioned by the application service provider as defined in TS 26.510 [9]. +- externalServiceId: An identifier assigned by the Service Application Provider and shared with the SRC over M8 as defined in TS 26.510 [9]. +- preferences: the preferences object carries parameters about the user's current preferences. These include the preferred display configuration, e.g. 2D display, HMD, etc. It may also include information about quality versus latency preferences. +- configuration: the configuration object stores information about the currently active configuration for the session. It carries the same information as described in clause 8.4.2.2. +- srSessionId: the srSessionId is a unique identifier of the split rendering session at the SRC. +- reason: the reason for termination of the current session between SRS and SRC. +- metrics: the metrics and metrics report objects provide the current status of a selected set of metrics that pertain to the current split rendering session. The format should follow clause 7.5. + +## 9.3 Split Rendering Metrics + +### 9.3.1 General + +This clause defines a set of metrics that are relevant to the operation of a split rendering session. + +### 9.3.2 QoE Metrics Formats + +#### 9.3.2.1 Timing Information Format + +The timing information associated with the rendered frame is transmitted in the RTCP report block formats. This timing information is listed in the Table 9.3.22-1. + +The SRS may use the “QoE timing information” RTCP Extended Reports messages to transmit the timing information required for measuring the QoE metrics to an SRC. The RTCP report block format for transmitting the QoE timing information is specified in TS 26.522 [8]. SDP signalling required for negotiating the transmission of QoE metrics between the UE and the SRS is documented in TS 26.522 [8]. + +The latency metrics that use the timing information defined in Table 9.3.2-1 are detailed in the clause 9.3.2.2. + +**Table 9.3.2.1-1: Timing information in the RTCP block formats.** + +| Name | Description | +|------|-------------| +|------|-------------| + +| | | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| estimatedAtTime (ref. T1) | This wall clock time is defined in TS 26.119 [4] - Pose Format.

This time is sent from the split rendering client.

This time is then received by the split rendering server and sent back to the split rendering client with the associated media frame. | +| sendingAtTime (ref. T1') | This time is defined in Table 8.32.3-2 - Split Rendering Metadata Message Data Type

This time is sent from the split rendering client.

This time is then received by the split rendering server and sent back to the split rendering client with the associated media frame. | +| startToRenderAtTime (ref. T3) | The time when the renderer in the Split Rendering Server starts to render the associated media frame. | +| sceneUpdateTime (ref. T6) | The time when the Scene Manager starts to update the 3D scene graph according to the viewer pose and the user actions. | +| serverTransmitTime (ref. T5) | The time when the encoded rendered frame is transmitted from the split rendering server to the split rendering client. | + +#### 9.3.2.2 Latency metrics + +To enable good XR experiences, it is relevant to monitor latencies such as the motion-to-photon and the pose-to-render-to-photon. + +Beyond the sense of presence and immersiveness, the age of the content and user interaction delay are of the uttermost importance for immersive and non-immersive interactive experiences, i.e., experiences for which the user interaction with the scene impacts the content of scene (such as online gaming). + +Table 9.3.2.2-1 provides timing information collected to compute the latency metrics at the split rendering client or split rendering server endpoint. + +**Table 9.3.2.2-1: Timing information for latency metrics** + +| Source endpoint | Timing information | Definition | +|------------------------|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Split Rendering Client | estimatedAtTime (ref. T1) | This time is expressed in wall clock time (refer to Table 9.3.2-1). | +| Split Rendering Client | lastChangeTime | The time the user action is made. It corresponds to the lastChangeTime field defined in the action format in Table 9.3.2-1.
This time is expressed in XR system time clock. | +| Split Rendering Server | sceneUpdateTime (ref. T6) | This time is a NTP timestamp format (refer to Table 9.3.2-1). | +| Split Rendering Server | startToRenderAtTime (ref. T3) | This time is expressed in wall clock time (refer to Table 9.3.2-1). | +| Split Rendering Client | actualDisplayTime (ref. T2.actual) | The actual display time of the rendered frame in the swapchain. The estimation of the actual display time is available through the XR runtime. | + +| | | | +|------------------------|---------------------------------|---------------------------------------------------------------------| +| Split Rendering Client | sendingAtTime
(ref. T1') | This time is expressed in wall clock time (refer to Table 9.3.2-1). | +| Split Rendering Server | serverTransmitTime
(ref. T5) | This time is expressed in wall clock time (refer to Table 9.3.2-1). | +| Split Rendering Client | receptionTime | The time when the data is received by the split rendering client. | + +The latency metrics are specified in Table 9.3.2.2-2. Latency calculation formulas are defined using the timing information defined in Table 9.3.2.2-1. + +**Table 9.3.2.2-2: Latency metrics** + +| Latency metric | Description | +|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| poseToRenderToPhoton |

The time duration, in units of milliseconds, between the time to provide the pose information from the XR runtime to the renderer (the renderer uses this pose to generate the rendered frame) and the display time of the rendered frame.

It can be computed as follows:
\text{actualDisplayTime} - \text{estimatedAtTime}

| +| renderToPhoton |

The time duration, in units of milliseconds, between the start of the rendering by the Presentation Engine and the display time of the rendered frame.

It can be computed as follows:
\text{actualDisplayTime} - \text{startToRenderAtTime}

(NOTE 1)

| +| roundtripInteractionDelay |

The time duration, in units of milliseconds, between the time a user action is initiated and the time the action is presented to the user.

It can be computed as follows:
\text{actualDisplayTime} - \text{lastChangeTime}

| +| userInteractionDelay |

The time duration, in units of milliseconds, between the time a user action is initiated and the time the action is taken into account by the content creation engine in the scene manager.

It can be computed as follows:
\text{sceneUpdateTime} - \text{lastChangeTime}

(NOTE 1)

| +| ageOfContent |

The time duration, in units of milliseconds, between the time the content is created in the scene by the Scene Manager and the time it is presented to the user.

It can be computed as follows:
\text{actualDisplayTime} - \text{sceneUpdateTime}

(NOTE 1)

| +| sceneUpdateDelay |

The time duration, in units of milliseconds, spent by the Scene Manager to update the scene graph.

| + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | It can be computed as follows:
$startToRenderAtTime - sceneUpdateTime$ | +| metadataDelay | The time duration, in units of milliseconds, between the time the split rendering metadata message is sent from the split rendering client and the time the split rendering server start to render using that metadata.
It can be computed as follows:
$startToRenderAtTime - sendingAtTime$ | +| dataFrameDelay | The time duration, in units of milliseconds, spent to transmit the media rendered frame from the split rendering server to the split rendering client.
It can be computed as follows:
$receptionTime - serverTransmitTime$ | +| NOTE 1: for the latency metrics computation, the timing information mentioned above need to be converted to a single time format (e.g., Wall clock time). | | + +### 9.3.3 QoE Metrics reporting protocol + +The Metrics Reporting API allows the Media Session Handler to send QoE metrics reports to the metrics collection server. + +An SR UE supporting Quality of Experience shall report QoE metrics according to the QoE configuration. QoE reporting is optional, but if an MSH reports QoE metrics, it shall report all requested metrics. + +### 9.3.4 QoE metrics definition + +#### 9.3.4.1 Introduction + +This clause extends clause 15.2 of TS 26.113 that provides the general QoE metric definitions and measurement framework. An SR UE supporting the QoE metrics feature shall support the reporting of the metrics in this clause. + +The metrics are calculated for each measurement resolution interval "measureinterval" as described in clause 15.2.1 of TS 26.113. They are reported to the server according to the reporting interval "reportinginterval" and after the end of the session as described in clause 15.2.1 of TS 26.113. + +#### 9.3.4.2 Pose to render to photon metric + +The *PoseToRenderToPhoton* duration is the time duration between the time at which the pose information is available from the XR runtime to the renderer and the display time of the rendered frame. The unit of this metric is expressed in milli seconds. + +The average pose to render to photon is equal to the sum of *PoseToRenderToPhoton* duration of each frame during the measurement resolution period divided by the time duration, in seconds, of the measurement resolution period. The unit of this metric is expressed in milli seconds and can be a fractional value. + +The minimum pose to render to photon duration is equal to the lowest value of *PoseToRenderToPhoton* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The maximum pose to render to photon duration is equal to the highest value of *PoseToRenderToPhoton* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The syntax for the metric "*PoseToRenderToPhoton*" metric is as defined in Table 9.3.4.2-1. + +**Table 9.3.4.2-1: Pose to render to photon metric information for Quality Reporting** + +| Key | Type | Description | +|-----------------------------|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PoseToRenderToPhoton | Object | | +| @avgPoseToRenderToPhoton | doubleVectorType | An unordered list of all average pose to render to photon delay measured within each measurement resolution period. | +| @minPoseToRenderToPhoton | unsignedIntVectorType | The minimum pose to render to photon duration is equal to the lowest value of PoseToRenderToPhoton duration measured during each measurement resolution period.
Provides an unordered list of minimum pose to render to photon delay measured during a metric reporting period. | +| @maxPoseToRenderToPhoton | unsignedIntVectorType | The maximum pose to render to photon duration is equal to the highest value of PoseToRenderToPhoton duration measured during each measurement resolution period.
Provides an unordered list of maximum pose to render to photon delay measured during a metric reporting period. | + +#### 9.3.4.3 Render to photon metric + +The *renderToPhoton* duration is the time duration between the time at which the presentation engine started rendering to the display time of the rendered frame. The unit of this metric is expressed in milli seconds. + +The average render to photon metric is equal to the sum of *renderToPhoton* duration of each frame during the measurement resolution period divided by the time duration, in seconds, of the measurement resolution period. The unit of this metric is expressed in milli seconds and can be a fractional value. + +The minimum render to photon duration is equal to the lowest value of *renderToPhoton* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The maximum render to photon duration is equal to the highest value of *renderToPhoton* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The syntax for the metric "*renderToPhoton*" metric is as defined in Table 9.3.4.3-1. + +**Table 9.3.4.3-1: Render to Photon metric information for Quality Reporting** + +| Key | Type | Description | +|-----------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| renderToPhoton | Object | | +| @avgRenderToPhoton | doubleVectorType | An unordered list of all average render to photon delay measured within each measurement resolution period. | +| @minRenderToPhoton | unsignedIntVectorType | The minimum render to photon duration is equal to the lowest value of renderToPhoton duration measured during each measurement resolution period.
Provides an unordered list of minimum render to photon delay measured during a metric reporting period. | +| @maxRenderToPhoton | unsignedIntVectorType | The maximum render to photon duration is equal to the highest value of renderToPhoton duration measured during each measurement resolution period.
Provides an unordered list of maximum render to photon delay measured during a metric reporting period. | + +#### 9.3.4.4 Round-trip interaction delay metric + +The *roundtripInteractionDelay* duration is the time duration between the time a user action is initiated to the time the action is presented to the user. The unit of this metric is expressed in milli seconds. + +The average round trip interaction delay metric is equal to the sum of *roundtripInteractionDelay* duration of each action during the measurement resolution period divided by the number of actions in the measurement resolution period. The unit of this metric is expressed in milli seconds and can be a fractional value. Within each resolution period the number of user actions are summed up and stored in the vector *@numberOfInteractionEvents*. + +The minimum round trip interaction delay duration is equal to the lowest value of *roundtripInteractionDelay* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The maximum round trip interaction delay duration is equal to the highest value of *roundtripInteractionDelay* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The identifier of a user action with minimum, and maximum, round trip interaction delays within each measurement resolution period are provided in the *@minActionIDs*, *@maxActionIDs* respectively, as an unordered list of user action identifiers. + +The syntax for the metric "*roundtripInteractionDelay*" metric is as defined in Table 9.3.4.4-1 + +**Table 9.3.4.4-1: Round-trip interaction delay metric information for Quality Reporting** + +| Key | Type | Description | +|--------------------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| roundtripInteractionDelay | Object | | +| @avgRoundTripInteractionDelay | doubleVectorType | An unordered list of all average round trip interaction delays measured within each measurement resolution period. | +| @numberOfUserActions | unsignedIntVectorType | The number of user actions within each measurement resolution period are summed up and stored in the vector. Provides an unordered list of user actions (occurred within each measurement period) measured during a metric reporting period. | +| @minRoundTripInteractionDelay | unsignedIntVectorType | The minimum round trip interaction delay duration is equal to the lowest value of roundtripInteractionDelay duration measured during each measurement resolution period. Provides an unordered list of minimum round trip interaction delay measured during a metric reporting period. | +| @minActionIDs | unsignedIntVectorType | The identifier of a user action with minimum round trip interaction delay within each measurement resolution period. Provides an unordered list of user action identifiers (occurred within each measurement period) with minimum round trip interaction delay measured during a metric reporting period. | +| @maxRoundTripInteractionDelay | unsignedIntVectorType | The maximum round trip interaction delay duration is equal to the highest value of roundtripInteractionDelay duration measured during each measurement resolution period. Provides an unordered list of maximum round trip interaction delay measured during a metric reporting period. | +| @maxActionIDs | unsignedIntVectorType | The identifier of a user action with maximum round trip interaction delay within each measurement resolution period. Provides an unordered list of user action identifiers (occurred within each measurement period) with maximum round trip interaction delay measured during a metric reporting period. | + +#### 9.3.4.5 User interaction delay metric + +The *userInteractionDelay* duration is the time duration between the time a user action is initiated to the time the action is taken account by the content creation engine in the scene manager. The unit of this metric is expressed in milli seconds. + +The average user interaction delay metric is equal to the sum of *userInteractionDelay* duration of each action during the measurement resolution period divided by the number of actions in the measurement resolution period. The unit of this metric is expressed in milli seconds and can be a fractional value. + +The minimum user interaction delay duration is equal to the lowest value of *userInteractionDelay* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The maximum user interaction delay duration is equal to the highest value of *userInteractionDelay* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The identifier of a user action with minimum and maximum user interaction delays within each measurement resolution period are provided in the *@minActionIDs*, and *@maxActionIDs* respectively as an unordered list of user action identifiers. + +The syntax for the metric "*userInteractionDelay*" metric is as defined in Table 9.3.4.5-1. + +**Table 9.3.4.5-1: User interaction delay metric information for Quality Reporting** + +| Key | Type | Description | +|---------------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| userInteractionDelay | Object | | +| @avgUserInteractionDelay | doubleVectorType | An unordered list of all average user interaction delays measured within each measurement resolution period. | +| @numberOfUserActions | unsignedIntVectorType | The number of user actions within each measurement resolution period are summed up and stored in the vector. Provides an unordered list of user actions (occurred within each measurement period) measured during a metric reporting period. | +| @minUserInteractionDelay | unsignedIntVectorType | The user interaction delay duration is equal to the lowest value of userInteractionDelay duration measured during each measurement resolution period. Provides an unordered list of user interaction delay measured during a metric reporting period. | +| @minActionIDs | unsignedIntVectorType | The identifier of a user action with minimum round trip interaction delay within each measurement resolution period. Provides an unordered list of user action identifiers (occurred within each measurement period) with minimum round trip interaction delay measured during a metric reporting period. | +| @maxUserInteractionDelay | unsignedIntVectorType | The maximum user interaction delay duration is equal to the highest value of userInteractionDelay duration measured during each measurement resolution period. Provides an unordered list of maximum user interaction delay measured during a metric reporting period. | +| @maxActionIDs | unsignedIntVectorType | The identifier of a user action with maximum round trip interaction delay within each measurement resolution period. Provides an unordered list of user action identifiers (occurred within each measurement period) with maximum round trip interaction delay measured during a metric reporting period. | + +#### 9.3.4.6 Age of contents metric + +The *ageOfContent* is the time duration between the time the content is created in the scene by the scene manager and the time it is presented to the user. The unit of this metric is expressed in milli seconds. Within each measurement resolution period the number of scene creations and updates are counted and stored in the vector *@numberOfSceneEvents*. + +The average age of content metric is equal to the sum of *ageOfContent* durations of all scene creation and update events during the measurement resolution period divided by the total number of scene creation and updates in the measurement resolution period. The unit of this metric is expressed in milli seconds and can be a fractional value. + +The minimum age of content duration is equal to the lowest value of *ageOfContent* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The maximum age of content duration is equal to the highest value of *ageOfContent* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The syntax for the metric "*ageOfContent*" metric is as defined in Table 9.3.2.6-1. + +**Table 9.3.2.6-1: Age of Content metric information for Quality Reporting** + +| Key | Type | Description | +|----------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ageOfContent | Object | | +| @avgAgeOfContent | doubleVectorType | An unordered list of average age of content durations measured within each measurement resolution period. | +| @numberOfSceneEvents | unsignedIntVectorType | The number of scene creation and/or scene updates within each measurement resolution period are stored in the vector. Provides an unordered list of scene creation and/or scene updates (occurred within each measurement period) measured during a metric reporting period. | +| @minAgeOfContent | unsignedIntVectorType | The minimum age of content duration is equal to the lowest value of ageOfContent measured during each measurement resolution period. Provides an unordered list of minimum age of content measured during a metric reporting period. | +| @maxAgeOfContent | unsignedIntVectorType | The maximum age of content is equal to the highest value of ageOfContent measured during each measurement resolution period. Provides an unordered list of maximum age of content measured during a metric reporting period. | + +#### 9.3.2.7 Scene update delay metric + +The *sceneUpdateDelay* duration is the time duration spent by the scene manager to update the scene graph. The unit of this metric is expressed in milliseconds. Within each measurement resolution period the number of scene updates are counted and stored in the vector *@numberOfSceneUpdates*. + +The average scene update delay duration metric is equal to the sum of *sceneUpdateDelay* durations of all scene updates during the measurement resolution period divided by the total number of scene updates in the measurement resolution period. The unit of this metric is expressed in milli seconds and can be a fractional value. + +The minimum scene update delay is equal to the lowest value of *sceneUpdateDelay* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The maximum age of content duration is equal to the highest value of *sceneUpdateDelay* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The syntax for the metric "*sceneUpdateDelay*" metric is as defined in Table 9.3.2.7-1. + +**Table 9.3.2.7-1: Scene update delay metric information for Quality Reporting** + +| Key | Type | Description | +|-------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sceneUpdateDelay | Object | | +| @avgSceneUpdateDelay | doubleVectorType | An unordered list of average scene update delays measured within each measurement resolution period. | +| @numberOfSceneUpdates | unsignedIntVectorType | The number of scene updates within each measurement resolution period are stored in the vector. Provides an unordered list of scene updates (occurred within each measurement period) measured during a metric reporting period. | +| @minSceneUpdateDelay | unsignedIntVectorType | The minimum scene update delay is equal to the lowest value of sceneUpdateDelay measured during each measurement resolution period. Provides an unordered list of minimum scene update delay duration measured during a metric reporting period. | +| @maxSceneUpdateDelay | unsignedIntVectorType | The maximum age of content is equal to the highest value of sceneUpdateDelay measured during each measurement resolution period. Provides an unordered list of maximum scene update delay duration measured during a metric reporting period. | + +#### 9.3.2.8 Metadata delay metric + +The *metadataDelay* duration is the time duration between the time the split rendering metadata is sent from the SRC and the time the split rendering server start to render using that metadata. The unit of this metric is expressed in milliseconds. + +The average metadata delay metric is equal to the sum of *metadataDelay* duration of each metadata message during the measurement resolution period divided by the number of metadata messages in the measurement resolution period. The unit of this metric is expressed in milli seconds and can be a fractional value. Within each measurement resolution period the number of metadata messages are summed up and stored in the vector *@numberOfMetadataMessages*. + +The minimum metadata delay is equal to the lowest value of *metadataDelay* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The maximum metadata delay is equal to the highest value of *metadataDelay* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The syntax for the metric "*metadataDelay*" metric is as defined in Table 9.3.2.8-1. + +**Table 9.3.2.8-1: Metadata delay metric information for Quality Reporting** + +| Key | Type | Description | +|---------------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| metadataDelay | Object | | +| @avgMetadataDelay | doubleVectorType | An unordered list of average metadata delays measured within each measurement resolution period. | +| @numberOfMetadataMessages | unsignedIntVectorType | The number of metadata messages within each measurement resolution period are stored in the vector. Provides an unordered list of total number of metadata messages (occurred within each measurement period) measured during a metric reporting period. | +| @minMetadataDelay | unsignedIntVectorType | The minimum metadata delay is equal to the lowest value of metadataDelay measured during each measurement resolution period.
Provides an unordered list of minimum metadata delay duration measured during a metric reporting period. | +| @maxMetadataDelay | unsignedIntVectorType | The maximum metadata message delay is equal to the highest value of metadataDelay measured during each measurement resolution period.
Provides an unordered list of maximum metadata delay duration measured during a metric reporting period. | + +#### 9.3.2.9 Data frames delay metric + +The *dataFrameDelay* duration is the time duration between the time the media rendered frame is transmitted from the split rendering server to the time the split rendering client received the data frame. The unit of this metric is expressed in milliseconds. + +The average data frame delay metric is equal to the sum of *dataFrameDelay* duration of each transmitted frame during the measurement resolution period divided by the number of frames transmitted in the measurement resolution period. The unit of this metric is expressed in milli seconds and can be a fractional value. Within each measurement resolution period the number of data frames transmitted are summed up and stored in the vector *@numberOfDataFrames*. + +The minimum data frame delay is equal to the lowest value of *dataFrameDelay* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The maximum data frame delay is equal to the highest value of *dataFrameDelay* duration measured during the measurement resolution period. The unit of this metric is expressed in milli seconds and is an integer value. + +The syntax for the metric "*dataFrameDelay*" metric is as defined in Table 9.3.2.9-1. + +**Table 9.3.2.9-1: Data frame delay metric information for Quality Reporting** + +| Key | Type | Description | +|---------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dataFrameDelay | Object | | +| @avgDataFrameDelay | doubleVectorType | An unordered list of average data frame transmission delays measured within each measurement resolution period. | +| @numberOfDataFrames | unsignedIntVectorType | The number of data frames transmitted within each measurement resolution period are stored in the vector. Provides an unordered list of total number of data frames transmitted (within each measurement period) during a metric reporting period. | +| @minDataFrameDelay | unsignedIntVectorType | The minimum data frame delay is equal to the lowest value of dataFrameDelay measured during each measurement resolution period. Provides an unordered list of minimum data frame delay duration measured during a metric reporting period. | +| @maxDataFrameDelay | unsignedIntVectorType | The maximum data frame delay is equal to the highest value of dataFrameDelay measured during each measurement resolution period. Provides an unordered list of maximum data frame delay duration measured during a metric reporting period. | + +### 9.3.5 Quality metrics reporting + +#### 9.3.5.1 General + +The quality metrics report follows the XML-based report format defined in clause 9.3.5.2. + +The MIME type of an XML-formatted QoE report shall be "application/3gprtc-qoe-report+xml". + +The metrics reporting protocol is as defined in clause 9.5.3 of TS 26.510 [9]. Split rendering UEs shall use the above MIME content type. The metrics report format is defined in the following sub clause. + +#### 9.3.5.2 Report format + +The QoE report is formatted as an XML document that complies with the XML schema in listing 10.6.2-1 of TS 26.247 [17]. + +The schema in listing 9.3.5.2-1 is an extension to allow additional QoE metrics for SR UE to be reported using the QoE report specified in clause 10.6.2 of TS 26.247 [17]. The filename of this schema is "TS26565\_SR\_MSEQoEMetrics.xsd". + +**Listing 9.3.5.2-1: SR\_MSE QoE Metrics XML schema** + +``` + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +``` + + + + + + + + + + + + + + + + + +``` + +#### 9.3.5.3 Quality Reporting Scheme and Metrics reporting configuration for SRC + +An SR UE shall use the metrics reporting scheme defined in clause 6.7 of TS 26.113 [6]. The Metrics Reporting Provisioning API allows an RTC Application Provider to configure the Metrics Collection and Reporting procedure for a particular split rendering session at reference point RTC-1. The Service Access Information API allows an RTC Application Function to configure the metrics collection and reporting process for a particular split rendering session at reference point M5. + +An SR UE shall use the data model for metrics reporting provisioning API defined in clause 8.10.3.1 of TS 26.510 [9] and the Service Access Information API defined in clause 9.2.3 of TS 26.510 [9]. The *metrics* element present in the *MetricsReportingConfiguration* resource and the *ServiceAccessInformation* resource shall include zero or more metrics defined in clause 9.3.4 of this document in addition to the quality metrics defined in clause 15.2 of TS 26.113 [6]. + +# --- 10 Security and Privacy Aspects + +## 10.1 Security + +Signaling for session establishment and exchange of application-specific messages shall use a secure transport channel based on WebSockets as defined in TS 26.113 [6]. + +Media transport shall be secured by the usage of WebRTC. + +## 10.2 Privacy + +Users of the split rendering MSE shall be aware that the application data and traffic are fully accessible to the SRS. The SRC shall ensure that the SRS used is trusted by the Media Application Provider, for example through the validation of the SRS's X.509 certificates. + +# --- Annex A (informative): Implementation Guidelines + +## A.1 Guidelines for Application Developers + +Application developers may use the SR\_MSE enabler as an SDK for developing applications that benefit from Split Rendering. + +The SDK may be accessible through an API that conforms to the API definition in clause 9.2. + +Application developers should implement monitoring of the split rendering session quality in their applications and always be aware that not all functionality described in this specification is always available for all split rendering sessions. It is then up to the application to decide whether the usage of split rendering is acceptable or not. + +## --- A.2 Guidelines for Split Rendering MSE Implementers + +### A.2.1 Guidelines for implementers of the Split Rendering Server + +If the use of eye gaze tracking is activated, the SRS may use this confidence information to perform gaze-based optimizations like foveated rendering and foveated video encoding. In foveated rendering, the rendering engine renders areas of a picture with higher quality than others to match the user's current gaze, while in foveated video encoding areas of the picture are encoded with a higher SNR quality than other areas, to match the user's current gaze. With gaze predictions, the SRS should create an importance map for the picture based on the confidence values associated with the gaze predictions. Additionally, the SRS may also use other information to produce the importance map, such as content Regions of Interest, type of the experience being rendered for example, game genre, and device type of the SRC + +A low confidence score may indicate that the estimation on the device is not adequate. In this case the server can try to re-estimate the pose and gaze prediction prior to rendering and encoding. + +For foveated encoding this importance map is passed to the encoder to properly allocate bits for the encoding of the picture. + +For foveated rendering, the SRS or the rendering engine in the SRS may similarly create an importance map to use to differentially allocate rendering resources for a frame. + +When both foveated rendering and foveated encoding is used, the importance map used for rendering should take into account the importance map used for encoding and vice-versa. + +## --- A.3 Conformance Testing + +No conformance testing procedures are defined in this version of the specification. + +# --- Annex B (normative): IDL Definition of Client API + +The Split Rendering Client API is defined using the IDL syntax (according to ISO/IEC 19516) as follows: + +``` +interface SplitRenderer { + readonly attribute SRState state; + + attribute EventHandler onstatechange; + attribute EventHandler onerror; + attribute EventHandler onqualitychange; + + void SplitRenderer(in string application_id, in string aspId, in map settings); + + void connect(in map settings, in List criteria); + void disconnect(string reason); + Metrics getMetrics(sequence metrics); +}; +``` + +# Annex C (normative): Split Rendering Profiles + +## C.1 Pixel Streaming Profile + +### C.1.1 Introduction + +This Annex defines split rendering profiles to define requirements for SRC and SRS for different scenarios. At this stage the following two profiles are defined: + +- 2D Pixel Streaming Profile in clause C.2 to support split rendering to 2D screens, devices of type 3 in TS 26.119 [4]. +- 3D Pixel Streaming Profile in clause C.3 to support split rendering to devices of type 1, 2, and 4 in TS 26.119 [4]. + +### C.1.2 2D Pixel Streaming Profile + +#### C.1.2.1 Introduction + +This profile defines required capabilities for UE-based SRC functionalities as network-side SRS capabilities to support split rendering to 2D screens. + +#### C.1.2.2 SRC Capabilities + +##### C.1.2.2.1 Overview + +Requirements for UE-based SRC functionalities for following functions are defined in this clause: + +- Media Decoding +- Media Encoding +- Metadata Formats + +The capabilities of the receiving UE are shared with the split rendering server prior to the start of the split rendering session. + +##### C.1.2.2.2 Media Capabilities + +The SRC shall support the media capabilities of a device type 3 as defined in TS 26.119 [4], clause 10.4. + +##### C.1.2.2.3 Metadata Formats + +**XR-Pose-Cap 1:** the SRC shall be able to retrieve one or more pose predictions for each view and for every frame to be rendered. The pose prediction shall be formatted according to clause 8.2.2.2. + +**XR-Pose-Cap 2:** the SRC shall be able to retrieve and collect the user actions that occurred during an identified time interval. The action information shall be formatted according to clause 8.2.2.3. + +#### C.1.2.3 SRS Capabilities + +##### C.1.2.3.1 Overview + +Requirements for network-based SRS functionalities for following functions are defined in this clause: + +- Media Encoding +- Media Decoding +- Metadata Formats + +The capabilities of the SRC are shared with the SRS prior to the start of the split rendering session. + +##### C.1.2.3.2 Video encoding + +The SRS shall at least be able to support the encoding of video that complies to the capabilities in clause 10.4.3 of TS 26.119 [4]. + +##### C.1.2.3.3 Audio and Speech encoding + +The SRS shall at least be able to support the encoding of audio that complies to the capabilities in clause 10.4.4 of TS 26.119 [4]. + +##### C.1.2.3.4 Video decoding + +The SRS has no requirements for the decoding of video streams. + +##### C.1.2.3.5 Audio and Speech decoding + +The SRS has no requirements for the decoding of audio or speech streams. + +##### C.1.2.3.6 Metadata Formats + +The SRS shall support the exchange of Pose and action information as defined in clause 8.3.2. + +#### C.1.2.4 Profile identifier + +The type **urn:3gpp:split-rendering:src:profile:2dpixelstreaming** shall be included in splitRenderingProfile parameter when the SRC signals SRS the Split Rendering Configuration [8.4.2.2]. + +### C.1.3 3D Pixel Streaming Profile + +#### C.1.3.1 Introduction + +This profile defines required capabilities for UE-based SRC functionalities as network-side SRS capabilities to support MeCAR devices. + +#### C.1.3.2 SRC Capabilities + +##### C.1.3.2.1 Overview + +Requirements for UE-based SRC functionalities for following functions are defined in this clause: + +- Media Decoding +- Media Encoding + +- Metadata Formats + +The capabilities of the receiving UE are shared with the split rendering server prior to the start of the split rendering session. + +##### C.1.3.2.2 Media Capabilities + +The SRC shall support the media capabilities of a device type 1 as defined in TS 26.119 [4], clause 10.2. + +If the device is a device type 2 as defined in TS 26.119 [4], clause 10.4, it shall also support the media capabilities of a device type 2 as defined in TS 26.119 [4], clause 10.3. + +If the device is a device type 4 as defined in TS 26.119 [4], clause 10.5, it shall also support the media capabilities of a device type 2 as defined in TS 26.119 [4], clause 10.5. + +##### C.1.3.2.3 Metadata Formats + +**XR-Pose-Cap 1:** the SRC shall be able to retrieve one or more pose predictions for each view and for every frame to be rendered. The pose prediction shall be formatted according to clause 8.2.2.2. + +**XR-Pose-Cap 2:** the SRC shall be able to retrieve and collect the user actions that occurred during an identified time interval. The action information shall be formatted according to clause 8.2.2.3. + +#### C.1.3.3 SRS Capabilities + +##### C.1.3.3.1 Overview + +Requirements for network-based SRS functionalities for following functions are defined in this clause: + +- Media Encoding +- Media Decoding +- Metadata Formats + +The capabilities of the SRC are shared with the SRS prior to the start of the split rendering session. + +##### C.1.3.3.2 Video encoding + +The SRS shall at least be able to support the encoding of video that complies to the capabilities in clause 10.4.3 of TS26.119. + +##### C.1.3.3.3 Audio and Speech encoding + +The SRS shall at least be able to support the encoding of audio that complies to the capabilities in clause 10.4.4 of TS26.119. + +##### C.1.3.3.4 Video decoding + +The SRS has no requirements for the decoding of video streams. + +##### C.1.3.3.5 Audio and Speech decoding + +The SRS has no requirements for the decoding of audio or speech streams. + +##### C.1.3.3.6 Metadata Formats + +The SRS shall support the exchange of Pose and action information as defined in clause 8.3.2. + +#### C.1.3.4 Profile identifier + +The type **urn:3gpp:split-rendering:src:profile:3dpixelstreaming** shall be included in *splitRenderingProfile* parameter when the SRC signals SRS the Split Rendering Configuration [8.4.2.2]. + +### C.1.4 Description of the Rendering Format for Pixel Streaming Profiles + +#### C.1.4.1 General + +In response to the Split Rendering Configuration message, the SRS shall reply with a description of the rendering format. + +The rendering format description shall be a compliant glTF 2.0 [2] file. The file may include references to the buffer streams that contain the components of the rendered media. + +Both SRS and SRC shall comply with the SD-Rendering-Ext1 capability as defined in TS 26.119 [4]. + +In addition, both SRS and SRC shall support for referencing WebRTC RTP streams and data channels as described in [3]. + +An SRC that complies with the 3D Pixel Streaming profile shall support the 3GPP\_node\_prerendered extension as defined in C.1.4.2. + +#### C.1.4.2 3D Pixel Streaming Profile-specific glTF Extension + +The 3GPP\_node\_prerendered extension is an extension at the node level to describe that the corresponding node is accessible as a prerendered content. The 3GPP\_node\_prerendered extension should be associated with the root node of the scene. It constitutes an alternative representation of the node and all its children. As such, if present, if the client decides to use the pre-rendered representation, it shall completely ignore the mesh description of the node and its children nodes. + +The 3GPP\_node\_prerendered supports multiple 2D video textures and audio sources that correspond to the rendered views and audio content. + +The semantics of the 3GPP\_node\_prerendered are provided by the following table: + +| Name | Type | Usage | Default | Description | +|--------|--------|-------|---------|-------------------------------------------------------------------------| +| visual | Object | O | N/A | An object that describes the rendered visual components of the content. | +| audio | Object | O | N/A | An object that describes the rendered audio components of the content. | + +The description of the visual object is provided in the following table: + +| Name | Type | Usage | Default | Description | +|----------------------|---------------|-------|-------------|------------------------------------------------------------------------------------------------------------------------------------| +| visual_configuration | enum | O | VIEW_STEREO | An indication of the view configuration for the pre-rendered media. It can either be VIEW_MONO or VIEW_STEREO. | +| Views | array(Object) | M | | An array that describes the views of the prerendered content. | +| eye_visibility | enum | M | | The visibility of the current view. This can take one of the following values: "EYE_LEFT", "EYE_RIGHT", "EYE_BOTH", or "EYE_NONE". | + +| Name | Type | Usage | Default | Description | +|------------------------|---------------|-------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | EYE_NONE is used for depth and transparency components. | +| composition_layers | array(number) | M | | An array of accessors identifiers that each corresponds to a composition layer of the parent view. | +| composition_layer_type | array(enum) | M | | For each of the composition layers of the parent view, this indicates the type of that composition layer. The values should be provided in the same order as the composition_layers. The allowed values are: "COMPOSITION_LAYER_PROJECTION", "COMPOSITION_LAYER_QUAD", "COMPOSITION_LAYER_EQUIRECTANGULAR", "COMPOSITION_LAYER_CUBEMAP", "COMPOSITION_LAYER_DEPTH", and "COMPOSITION_LAYER_OCCUPANCY". | + +The description of the audio object in the prerendered media extension is provided in the following table: + +| Name | Type | Usage | Default | Description | +|------------|---------------|-------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| type | enum | O | AUDIO_STEREO | describes the format of the prerendered audio content. The type can take one of the following values: "AUDIO_MONO", "AUDIO_STEREO", and "AUDIO_HOA". | +| Components | array(number) | M | | provides a list of the accessors that point to the media streams associated with rendered audio content. | + +The JSON scheme for the 3GPP\_node\_prerendered is as follows: + +``` +{ + "$schema" : "http://json-schema.org/draft-07/schema", + "title" : "3GPP_node_rendered", + "type" : "object", + "description": "glTF extension to described pre-rendered content", + "allOf": [ { "$ref": "glTFProperty.schema.json" } ], + "properties" : { + "visual": { + "$ref": "3GPP_node_rendered.visual.schema.json", + "description": "visual streamed buffers" + }, + "audio": { + "$ref": "3GPP_node_rendered.audio.schema.json", + "description": "audio streamed buffers" + }, + "extensions": {}, + "extras": {} + }, +} +``` + +``` + "required": ["visual"] + } + { + "$schema" : "http://json-schema.org/draft-07/schema", + "title" : "3GPP_node_rendered.visual", + "type" : "object", + "description": "Object representing the visual rendered media", + "allOf": [ { "$ref": "glTFProperty.schema.json" } ], + "properties" : { + "view_configuration": { + "type": "string", + "description": "the view configuration used for the session", + "gltf_detailedDescription": "the view configuration used for the +session", + "enum": ["VIEW_MONO", "VIEW_STEREO"] + }, + "views": { + "type": "array", + "description": "array of layer view objects", + "gltf_detailedDescription": "", + "items": { + "$ref": "3GPP_node_rendered.visual.view.schema.json" + }, + "minItems": 1 + }, + "extensions": {}, + "extras": {} + }, + "required": ["views"] + } + { + "$schema" : "http://json-schema.org/draft-07/schema", + "title" : "3GPP_node_rendered.visual.view", + "type" : "object", + "description": "A representation of a rendered view", + "allOf": [ { "$ref": "glTFProperty.schema.json" } ], + "properties" : { + "eye_visibility": { + "type": "string", + "description": "the visibility of the current view", + "enum": ["EYE_LEFT", "EYE_RIGHT", "EYE_BOTH", "EYE_NONE"] + }, + "composition_layers": { + "type": "array", + "description": "array of timed accessors that carry the streamed +buffers for each composition layer of the view", + "items": { + "type": "integer" + }, + }, + } + } +} +``` + +``` + "minItems": 1 + }, + "composition_layer_type": { + "type": "array", + "items": { + "type": "string", + "description": "the type of composition layer in the array of +composition layers with the same array index", + "gltf_detailedDescription": "the type of composition layer in the +array of composition layers with the same array index", + "enum": ["COMPOSITION_LAYER_PROJECTION", +"COMPOSITION_LAYER_QUAD", "COMPOSITION_LAYER_EQUIRECTANGULAR", +"COMPOSITION_LAYER_CUBEMAP", "COMPOSITION_LAYER_DEPTH", +"COMPOSITION_LAYER_OCCUPANCY"] + }, + "minItems": 1 + }, + "extensions": {}, + "extras": {} +}, +"required": ["views"] +} + +{ + "$schema" : "http://json-schema.org/draft-07/schema", + "title" : "3GPP_node_rendered.audio", + "type" : "object", + "description": "Object representing the audio rendered media", + "allOf": [ { "$ref": "gltfProperty.schema.json" } ], + "properties" : { + "type": { + "type": "string", + "description": "the type of the rendered audio", + "gltf_detailedDescription": "the type of the rendered audio", + "enum": ["AUDIO_MONO", "AUDIO_STEREO", "AUDIO_HOA"], + "default": "AUDIO_STEREO" + }, + "components": { + "type": "array", + "description": "array of timed accessors to audio component +buffers", + "items": { + "type": "integer" + }, + "minItems": 1 + }, + "extensions": {}, + "extras": {} + }, + "required": ["components"] +} +``` + +} + +### C.1.5 Profile Restrictions and Requirements + +All Pixel Streaming profile are expected to be relocation intolerant and if using the 5G edge procedure shall set the *easRelocationRequirements* to "RELOCATION\_INTOLERANT" in the tolerance field. + +When the 2D Pixel Streaming profile is used, a policy template and a dynamic policy request may include the following QoS specifications, one for each of the components of the downlink streams: + +- 1 QoS specification corresponding to the mono view. +- 1 QoS specification corresponding to one depth buffer stream associated with the mono view. +- 1 QoS specification corresponding to an occupancy/transparency buffer stream associated with the mono view. +- 1 QoS specification corresponding to an audio stream. + +When the 3D Pixel Streaming profile is used, a policy template and a dynamic policy request may include the following QoS specifications, one for each of the components of the downlink streams: + +- 2 QoS specifications corresponding to for left and right eye buffer streams. +- 2 QoS specifications corresponding to one depth buffer stream associated with the left and/or the right views. +- 2 QoS specification corresponding to an occupancy/transparency buffer stream associated with the left and/or the right views. +- 1 QoS specification corresponding to an audio stream. + +## --- C.2 Adaptive Split Rendering Profile + +### C.2.1 Introduction + +This profile defines procedures and requirements for SRS and SRC to support split rendering features beyond a remote rendering paradigm. + +Adaptive split rendering profile allows the SRC to render some objects of a scene locally and the rendering split can be adapted between the SRS and SRC during a session. The adaptation of the rendering split may be triggered either by the SRS or the SRC to maintain a consistent QoE of the SR session or to accommodate changes in operating conditions. The triggers may be, for example, channel conditions, SRC or SRS conditions or defined by the application provider. + +To successfully render two parts of a scene separately in a split fashion, additional aspects of the rendering process need to be considered. Two basic requirements are maintaining a coherent state of the scene between the SRS and SRC and awareness of rendering split. Another requirement is seamless composition and display of the media rendered by the SRS and SRC into a frame to be displayed. + +### C.2.2 Procedures and Call Flows + +For adaptive split rendering, the general procedures and call flows in clause 5.2 are followed with the following additions and modifications. + +- The SRS and SRC should share a scene description. The implementation details may vary. The application provider may decide whether to provide identical scene descriptions to the SRS and the SRC or whether to provide a truncated version of the scene description to the SRC. + +Note: The Application Service Provider may provide the scene description resource to the SRS and SRC, for example, via M8 to SRC and via M2 to SRS. + +- The SRS and SRC agree on an initial rendering split during session negotiation and the states to be synchronized, for example, in Step 5 of the procedure in clause 5.2.1.2. +- The initial rendering split and states to be synchronized are indicated in the SR configuration. +- In the rendering loop, exchange of split adaptation messages and state synchronization messages between the SRS and SRC is supported. + +Figure C.2.2-1 illustrates a high level call flow set up and operation for a split rendering session which supports the adaptive split rendering profile. + +![Sequence diagram showing the high level call flows for Adaptive Split Rendering Profile. The diagram involves XR Runtime, Split Rendering Client (Scene Manager, XR Source Management, Media Access Function), and Split Rendering Server. It is divided into Session Setup and negotiation, and Rendering Loop phases.](73b28b0f5e3be628bb5a3d6bd1d79d21_img.jpg) + +``` + +sequenceDiagram + participant XR_Runtime as XR Runtime + subgraph Split_Rendering_Client [Split Rendering Client] + Scene_Manager[Scene Manager (thin Presentation Engine)] + XR_Source_Management[XR Source Management] + Media_Access_Function[Media Access Function] + end + participant Split_Rendering_Server as Split Rendering Server + + Note right of XR_Runtime: 0: Scene Description Acquisition + Note left of Split_Rendering_Server: Session Setup and negotiation + + Scene_Manager->>Split_Rendering_Server: 1: create a split rendering session + Split_Rendering_Server-->>Scene_Manager: 2: send description of split rendering output + Scene_Manager->>Split_Rendering_Server: 3: establish transport connections +e.g. WebRTC session + + Note left of XR_Runtime: Rendering Loop + + XR_Runtime->>XR_Source_Management: 4: receive pose information, user actions and state changes + XR_Source_Management->>Split_Rendering_Server: 5: transmit metadata + + Note right of Split_Rendering_Server: 6.a: perform rendering, for requested pose (s) +process state changes +process split adaptation + Split_Rendering_Server->>Media_Access_Function: 7.a: send next buffer frame + Note left of XR_Runtime: 6.b: perform rendering, for requested pose (s) +process state changes +process split adaptation + Media_Access_Function->>XR_Source_Management: 7.b: transmit split adaptation and state change messages + Note right of Media_Access_Function: 8: decode and process buffer frame + XR_Source_Management->>Scene_Manager: 9: pass raw buffer frames for display + Note left of Scene_Manager: 10: prepare composition layers and their corresponding swapchain images + Scene_Manager->>XR_Runtime: 11: forward swapchain images for composition and rendering + Note left of XR_Runtime: 12: compose and render frame + +``` + +Sequence diagram showing the high level call flows for Adaptive Split Rendering Profile. The diagram involves XR Runtime, Split Rendering Client (Scene Manager, XR Source Management, Media Access Function), and Split Rendering Server. It is divided into Session Setup and negotiation, and Rendering Loop phases. + + + +**Figure C.2.2.-1: High level call flows for Adaptive Split Rendering Profile** + +The steps are: + +0. In this optional step the SRC and the SRS acquire scene description of the scene to be rendered during the split rendering session. The actual implementation of delivery of the scene description by to the SRC and SRS is up to the application provider. +1. The Presentation Engine discovers the split rendering server and sets up a connection to it. It provides information about its rendering capabilities and the XR runtime configuration, e.g the OpenXR configuration + +may be used for this purpose. States to be synchronized and the initial rendering split is negotiated during this step. + +2. In response, the split rendering server creates a description of the split rendering output and the input it expects to receive from the UE. +3. The Presentation Engine requests the buffer streams from the MAF, which in turn establishes a connection to the split rendering server to stream pose and retrieve split rendering buffers. +4. The Source Manager retrieves pose and user input from the XR runtime and state changes in negotiated states and possible requests from the Scene Manager. +5. The Source Manager shares the pose predictions and user input actions , state changes and possible split adaptation messages with the split rendering server. +6. + - a. The split rendering server uses that information to, update states, render the frame and possibly update the split. + - b. The Scene Manager update states, renders a frame and possibly updates the split. +7. + - a. The rendered frame is encoded and streamed to the MAF. + - b. Possible split adaptation and state change messages are shared with the presentation engine, +8. The received media frames decoded and processed, +9. The raw buffer frames are passed to the Scene Manager, this includes the frames received from the SRS and the frames rendered locally by the PE, +10. The scene manager prepares composition layers and their corresponding swapchain images. +11. The swapchain images are forwarded to the XR runtime for composition and rendering, 12. The frames are composed and displayed. + +The final composition of a frame from media received from the SRS and locally rendered objects depends on the application logic. Implementation guidelines in C.2.7 provide a simple example. + +### C.2.3 Metadata Formats + +#### C.2.3.1 Split Rendering Configuration Format + +The configuration format defined in clause 8.4.2.2 with the additional fields defined below shall be used for split rendering configuration exchange in adaptive split rendering profile. + +| | | | | +|------------------------|---------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| renderingSplit | Object | 1..1 | A object identifying objects to be rendered and where they are to be rendered (SRS or SRC), for example, as a dictionary with keys “SRS” and “SRC” and lists of object indices from a scene description or a scene graph | +| synchronizedStatesInit | Object | 1..1 | A object identifying states to be synchronized between the SRS and SRC and their initial state | +| states | Object | 1..1 | A list of state identifiers, their current values | +| state | String/number | 1..n | Identifier of a state | +| initVal | String | 1..n | Initial value of the state | +| stateVals | Array | 1..1 | An array of values possible for the state | + +These renderingSplit object shall be present as part of the extraConfigurations Object as defined in clause 8.4.2.2 for extensibility of split rendering configuration format. + +#### C.2.3.2 Split Adaptation Message Format + +During a split rendering session, the operating environment of the split rendering server, the split rendering client or the network conditions may change. Consequently, the rendering split may need to be adapted to deliver a consistent QoE. When adaptive split rendering is enabled, the SRS or SRC shall request a new rendering split by sending a message of the type “urn:3gpp:split-rendering:v1:asrp:sr-split”. The message shall be conformant to the metadata message format specified in clause 8.5.1. The same message type shall be used to acknowledge, accept or reject the request by the receiver, with the message subtype identifying whether it is a request, acceptance, acknowledgement or rejection. The message shall follow the format in Table C.2.3.1-1. + +**Table C.2.3.2-1 Message format for split adaptation messages** + +| Name | Type | Cardinality | Description | +|------------------|--------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| id | string | 1..1 | A unique identifier of the message in the scope of the data channel session. | +| type | string | 1..1 | urn:3gpp:split-rendering:v1:asrp:sr-split | +| message | Object | 1..1 | Message content | +| subtype | string | 1..1 | An identifier of the subtype of the message, it may be a request (REQ) for new split or acknowledgement (ACK), acceptance (OK) or rejection of a request (NOK). | +| renderingSplitId | string | 1..1 | An identifier of the rendering split unique within the scope of the SR session | +| renderingSplit | Object | 0..1 | A object identifying objects to be rendered and where they are to be rendered (SRS or SRC). The message shall be a dictionary object . with keys “SRS” and “SRC”, and values corresponding to a key shall be a list of named nodes from the scene description being rendered in the SR session. The keys shall indicate where the objects named in the corresponding value list are rendered. | + +Split adaptation messages indicating acceptance, acknowledgment or rejection of a split adaptation request may not include the renderingSplit Object. + +#### C.2.3.3 State Synchronization Message Format + +During a split rendering session, various states associated with the scene being rendered may transition. Depending on the nature of the application being executed, a transition may occur at the SRS, at the SRC or at both the SRS and SRC. For the application execution to be consistent, some state transitions need to be synchronized between the SRS and SRC. The SRC and SRS may agree on which states to synchronize during session setup. To synchronize state transitions during a split rendering session the SRS and SRC shall exchange messages of the type “urn:3gpp:split-rendering:v1:asrp:sr-state” . The same message type shall be used to send a state synchronization update, acknowledge a state synchronization update or simultaneously send and acknowledge a state synchronization update. The state synchronization update messages shall be conformant with the meta-data message format defined in clause 8.5.1 and the message content shall be formatted as shown in Table C.2.3.2-1. + +**Table C.2.3.2-1 Message format for state synchronization messages** + +| Name | Type | Cardinality | Description | +|--------------------|----------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| id | string | 1..1 | A unique identifier of the message in the scope of the data channel session. | +| type | string | 1..1 | urn:3gpp:split-rendering:v1:sr-state | +| message | Object | 1..1 | Message content | +| subtype | string | 1..n | An identifier of the subtype of the message, it may be a state synchronization update (SYNC), acknowledgment (ACK) or both (SYNC_ACK) | +| syncUpdateId | string | 1..1 | An identifier of the synchronization update unique within the scope of the SR session | +| synchronizedStates | Object | 1..1 | An object identifying states that are synchronized between the SRS and SRC and their current state. Only states that have transitioned may be exchanged | +| states | Object | 1..1 | A list of state identifiers, their current values and last change time | +| identifier | String/number | 1..n | Identifier of a state | +| val | Object/String/number | 1..n | Value of the state | +| lastChangeTime | number | 1..1 | The timestamp of the last change in state | + +Split adaptation messages indicating an acknowledgment of a state update may not include the synchronizedStates Object. + +### C.2.4 SRC Capabilities + +The adaptive split rendering profile may be used in monoscopic mode or stereoscopic mode. In monoscopic mode, the SRC receives video corresponding to a single view. This mode supports split rendering to 2D screens, devices of type 3 in TS 26.119 [4]. + +In stereoscopic mode, the SRC receives video corresponding to two views, one for each eye. This mode supports split rendering to stereoscopic screens, devices of type 1,2,4 in TS 26.119 [4]. + +#### C.2.4.1 Media Capabilities + +If adaptive split rendering profile is used in monoscopic mode, the SRC shall support the media capabilities of a device type 3 as defined in TS 26.119 [4], clause 10.4, and referenced in Annex C.1.2.2.2. + +If adaptive split rendering profile is used in stereoscopic mode, the SRC shall support the media capabilities for device type 1 as defined in TS 26.119 [4], clauses 10.2, and referenced in Annex C.1.3.2.2 + +If the device is a device type 2 as defined in TS 26.119 [4], clause 10.4, it shall also support the media capabilities of a device type 2 as defined in TS 26.119 [4], clause 10.3, and referenced in Annex C.1.3.2.2 + +If the device is a device type 4 as defined in TS 26.119 [4], clause 10.5, it shall also support the media capabilities of a device type 4 as defined in TS 26.119 [4], clause 10.5, and as referenced in Annex C.1.3.2.2 + +#### C.2.4.2 Metadata Formats + +**XR-Pose-Cap 1:** the SRC shall be able to retrieve one or more pose predictions for each view and for every frame to be rendered. The pose prediction shall be formatted according to clause 8.3.2.2. + +**XR-Pose-Cap 2:** the SRC shall be able to retrieve and collect the user actions that occurred during an identified time interval. The action information shall be formatted according to clause 8.3.2.3. + +**XR-ObjId-Cap 1:** the SRC shall be able to receive, retrieve and collect identifiers of objects in a scene being rendered by the SRC in a split rendering session during an identified time interval. The state information shall be formatted according to clause C.2.3.2 + +**XR-ObjState-Cap 1:** the SRC shall be able to receive, retrieve and collect state changes in identified objects in a scene being rendered in a split rendering session during an identified time interval. The state information shall be formatted according to clause C.2.3.3 + +#### C.2.4.3 Rendering format description + +The SRC and SRS shall comply with rendering format description in annex C.4.1 + +If adaptive split rendering profile is used for stereoscopic use cases, the SRC shall support the 3GPP\_node\_prerendered extension defined in C.4.2, However, the extension may be used on non-root nodes. + +#### C.2.4.4 Scene Processing and Rendering Capabilities + +The SRC shall have the following minimum scene processing capabilities: + +- the **SD-Rendering-gltf-core** scene processing capabilities defined in clause 9.2 of TS 26.119 [4]. + +**SD-Rendering-gltf-core** enables basic compatibility of an SRC with the adaptive split rendering profile for simple use cases, where the SRC does minimal local rendering and adaptability of rendering split is minimal. An example of such a limited scenario may be a cloud gaming use case where the application provider isolates a small subgraph of the complex game scene to be rendered by the SRC and shares the subgraph with the SRC. The subgraph may contain only the assets (mesh and textures) related to a user's character and controller to allow the SRC to render these objects locally to mask motion to photon to render latency. More advanced use cases of adaptive split rendering place higher scene processing capabilities on the SRC. + +The SRC should have the following scene processing capabilities: + +- the **SD-Rendering-gltf-Ext1** scene processing capabilities defined in clause 9.2 of TS 26.119 [4]. + +In addition to the above specified scene processing capabilities, depending on the device type, the SRC shall have scene capabilities defined for each device type in clause 10 of TS 26.119 [4]. + +### C.2.5 SRS Capabilities + +The SRS capabilities to support adaptive split rendering profile are described in the sub-clauses below. + +#### C.2.5.1 Media Capabilities + +The media capabilities of the SRS are defined in relation to the media capabilities of the SRCs it is expected to serve. Therefore, the encoding capabilities of an SRS should match the decoding capabilities of the SRC. + +If adaptive split rendering profile is used in monoscopic code, the SRS shall have capabilities defined in clause C.1.2.3 + +If adaptive split rendering profile is used in stereoscopic mode, the SRS shall have capabilities defined in clause C.1.3.3. + +#### C.2.5.2 Metadata Capabilities + +The SRS shall support the metadata formats for pose and action defined in Clause 8.3.2. In addition, the SRS shall support the metadata formats defined in Annex C.2.3, and complement the metadata capabilities defined in Annex C.2.4.2. This shall include the ability to receive and process messages corresponding to metadata capabilities defined in Annex C.2.4.2 and formatted according to clause 8.3.2 and C.2.3. + +#### C.2.5.3 Scene Processing and Rendering Capabilities + +SRS shall have the **SD-Rendering-gltf-Ext1** scene processing capabilities. + +Additionally, depending on the device type of the SRC participating in a split rendering session, the SRS should support the required and recommended scene processing capabilities defined in TS 26.119 in clause 10.3.5 for device type 2, clause 10.4.5 for device type 3, and 10.5.5 for device type 4. + +### C.2.6 Profile identifiers + +If the adaptive split rendering profile is used in monoscopic mode the type **urn:3gpp:split-rendering:src:profile:asr2dpixelstreaming** shall be included in *splitRenderingProfile* parameter when the SRC signals SRS the Split Rendering Configuration [8.4.2.2]. + +If the adaptive split rendering profile is used in in stereoscopic mode the type **urn:3gpp:split-rendering:src:profile:asr3dpixelstreaming** shall be included in *splitRenderingProfile* parameter when the SRC signals SRS the Split Rendering Configuration [8.4.2.2]. + +### C.2.7 Extension to Client API Functions + +The SRC should perform adaptive split management which may be based on metrics reports of an ongoing split rendering session, scene being rendered and UE operating conditions. For adaptive split rendering, the SRC exposes functions to load and update scene description resources. The SRC may also expose functions to an application to allow application developers to deploy custom logic for split management. + +| Method | Parameters | | State after Success | Description | +|---------------|----------------------------------------------|---------|---------------------|-----------------------------------------------------------------------------------------------------------------------| +| | in | out | | | +| setScene() | - srSessionId
-scene description resource | -status | N/A | The application request the SRC to load a scene description resource for rendering in the split rendering session. | +| updateScene() | - srSessionId
-scene description resource | -status | N/A | The application request the SRC to update a scene description resource being rendered in the split rendering session. | + +SRC may optionally expose the function below to the application to allow application developers to deploy custom split management logic. + +| | | | | | +|---------------|-----------------------------------|-----------------------------|-----|-------------------------------------------------------------------------------------------------------------| +| updateSplit() | - srSessionId
-rendering split | -status
-rendering split | N/A | The application requests or queries the SRC for a new rendering split or the current rendering split in use | +|---------------|-----------------------------------|-----------------------------|-----|-------------------------------------------------------------------------------------------------------------| + +The parameters used are defined below: + +- srSessionId: as defined in Clause 9.2 + +- scene description resource: A scene description resource compliant with capabilities specified in clause C.2.4.4. The scene description resource may be a subset of the scene description resource being rendered by the SRS. It is assumed that the application provider makes the scene description resource available to the application, for example, via M8. +- status: indicates whether the call was successful (OK) or not successful (FAIL) +- rendering split: A pointer to a renderingSplit object defined in C.2.3. + +### C.2.8 Implementation Guidelines for Adaptive Split Rendering + +#### C.2.8.1 General + +ASR profile may be used with any of the pixel streaming profiles defined in Annex C. As such implementation guidelines for pixel streaming profiles may be applicable. Additional guidelines are provided below, and where applicable, differences from pixel stream profile guidelines are highlighted. + +The ASR profile allows SRS and SRC both to render objects for a given display frame. This functionality may be leveraged by application developers to develop SR applications which are more responsive to user interaction by leveraging local rendering for interactive objects. However, caution has to be exercised in choosing which objects to render locally and which objects to render remotely in a given 3D scene. The division should be such that composition of the locally rendered and remotely rendered frames into a display frame is visually as seamless as possible for the user. + +The logic on how to choose objects for local or remote rendering and how to compose the frame from locally and remotely rendered frames is left to the Application provider and application developers. Below we provide guidelines based on a simple use case to illustrate how to split objects for rendering and how to compose the final frame. + +#### C.2.8.2 Guidelines for Rendering Split and Composition + +Adaptive split rendering can be used based on the type of AR object. In this case it is most suited to AR objects that have low prediction accuracy, i.e., pose prediction and reprojection techniques are not enough to make up for the motion-to-render latency when using remote rendering. For example, + +- Interactive objects that react to user actions, pose, eye gaze, stimuli in the environment, etc. +- Objects with high reflectivity, especially in the presence of motion in the environment, such as, moving objects, changing light conditions, etc. +- Transparent objects + +In most cases, interactive objects can benefit from being rendered locally if the device has the capability to do so. However, to limit the number of objects rendered by the device, an application may choose to render only those interactive objects on the device that are near the user, e.g., they are located within a radius surrounding the device. Since the user is unlikely to interact with objects that are farther, i.e., outside this radius, these can still be rendered remotely. The application may also choose to render only interactive objects that have high level of interactivity on the client and render objects with predictable motion and slow responses on the server. + +Since, the level of interaction and distance from the user can change during the lifetime of the session, the rendering is appropriately adapted. + +In most cases, reflective objects may need to be rendered remotely as they require higher processing. If reflective objects are rendered at the client, then for convincing reflection effects, it is important for the server to provide an environment map to the client so the client can use it for shading its local objects. In practice, the client needs a (low-resolution) 360-degree cube map of the viewer's entire surroundings, with local objects omitted. The client may still need to locally augment this environment map with local objects in case they are prominently featured in reflections, for instance if they are very large or have bright light sources. \ No newline at end of file diff --git a/marked/Rel-18/34_series/34124/24c9e038a791677ed33100667b64f7e6_img.jpg b/marked/Rel-18/34_series/34124/24c9e038a791677ed33100667b64f7e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6cdcfa70cc96ae128be6c2322ac3b3e8cc066f43 --- /dev/null +++ b/marked/Rel-18/34_series/34124/24c9e038a791677ed33100667b64f7e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:265c96c89f589e1da44658c89b570b9fd5e97bc8b8c2f8c211d22c2410f13aba +size 48746 diff --git a/marked/Rel-18/34_series/34124/4af57aad638888edf2062306f8a54a6c_img.jpg b/marked/Rel-18/34_series/34124/4af57aad638888edf2062306f8a54a6c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..43882869a3582160b31890bd5f6e7fd0fa38a7bb --- /dev/null +++ b/marked/Rel-18/34_series/34124/4af57aad638888edf2062306f8a54a6c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5db9509414ca787797a10c8f98fc0c1757f0cfc3ceda1e58466d61f48de0d3ac +size 57485 diff --git a/marked/Rel-18/34_series/34124/7a0db9703b68b3d06cdaeefc084c0006_img.jpg b/marked/Rel-18/34_series/34124/7a0db9703b68b3d06cdaeefc084c0006_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c961dec974315d4edca34516b23cf02984cd7dd4 --- /dev/null +++ b/marked/Rel-18/34_series/34124/7a0db9703b68b3d06cdaeefc084c0006_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eb7ee116b45ffdc405aa24338d256648b2c9ea33cef6c40267ea64e09e221438 +size 20639 diff --git a/marked/Rel-18/34_series/34124/803776dff64331076ffc951fc95358ee_img.jpg b/marked/Rel-18/34_series/34124/803776dff64331076ffc951fc95358ee_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..56c9ec88a5ccd70e8ca916fa5f525ad48d00751c --- /dev/null +++ b/marked/Rel-18/34_series/34124/803776dff64331076ffc951fc95358ee_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:df0d91f3240209f95467a2b574d451d01848eefe925738b0abdab947cd95963b +size 35686 diff --git a/marked/Rel-18/34_series/34124/dd5771673aececa53d42ece89218299d_img.jpg b/marked/Rel-18/34_series/34124/dd5771673aececa53d42ece89218299d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9cff19f8065bf18458eb85d51bed19fe3001984c --- /dev/null +++ b/marked/Rel-18/34_series/34124/dd5771673aececa53d42ece89218299d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b34b3fd218e0433ceeae3e91a2423d60b38f7c229b4a1c906eec4c4912ffc1cc +size 60231 diff --git a/marked/Rel-18/34_series/34124/raw.md b/marked/Rel-18/34_series/34124/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e1e7ecce5444769c8c55fef3bee8b8b3cd7d26d1 --- /dev/null +++ b/marked/Rel-18/34_series/34124/raw.md @@ -0,0 +1,1075 @@ + + +# 3GPP TS 34.124 V18.0.0 (2024-03) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Radio Access Network; ElectroMagnetic Compatibility (EMC) requirements for mobile terminals and ancillary equipment (Release 18)** --- + +# **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + Valbonne - FRANCE + Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. + The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword .......................................................................................................................................................................... | 5 | +| 1 Scope....................................................................................................................................................................... | 6 | +| 2 References............................................................................................................................................................... | 6 | +| 3 Definitions and abbreviations ................................................................................................................................. | 8 | +| 3.1 Definitions ........................................................................................................................................................ | 8 | +| 3.2 Abbreviations ................................................................................................................................................... | 9 | +| 4 Test conditions ...................................................................................................................................................... | 10 | +| 4.1 General ........................................................................................................................................................... | 10 | +| 4.2 Arrangements for establishing a communication link.................................................................................... | 10 | +| 4.3 Narrow band responses on receivers............................................................................................................... | 11 | +| 4.3.1 FDD and 3.84Mcps TDD option ............................................................................................................. | 11 | +| 4.3.2 1,28Mcps TDD option............................................................................................................................. | 11 | +| 4.3.3 7,68Mcps TDD option............................................................................................................................. | 11 | +| 4.4 Receiver exclusion band.................................................................................................................................. | 12 | +| 4.4 Receiver exclusion band.................................................................................................................................. | 12 | +| 5 Performance assessment ....................................................................................................................................... | 12 | +| 5.1 General ........................................................................................................................................................... | 12 | +| 5.2 Equipment which can provide a continuous communication link ................................................................. | 12 | +| 5.3 Equipment which can only provide a discontinuous communication link (packet data/transmission) ........... | 13 | +| 5.4 Equipment which does not provide a communication link ............................................................................ | 13 | +| 5.5 Conformance of ancillary equipment.............................................................................................................. | 13 | +| 5.6 Equipment classification ................................................................................................................................ | 13 | +| 6 Performance criteria.............................................................................................................................................. | 13 | +| 6.1 Performance criteria for continuous phenomena ............................................................................................ | 14 | +| 6.2 Performance criteria for Transient phenomena............................................................................................... | 14 | +| 7 Applicability overview tables ............................................................................................................................... | 15 | +| 7.1 Emission......................................................................................................................................................... | 15 | +| 7.2 Immunity ........................................................................................................................................................ | 16 | +| 8 Methods of measurement and limits for EMC emissions ..................................................................................... | 16 | +| 8.1 Test configurations.......................................................................................................................................... | 16 | +| 8.2 Radiated Emission........................................................................................................................................... | 17 | +| 8.2.1 Definition................................................................................................................................................. | 17 | +| 8.2.2 Test method ............................................................................................................................................. | 17 | +| 8.2.3 Limits....................................................................................................................................................... | 17 | +| 8.2.3.1 FDD and 3.84 Mcps TDD option ..................................................................................................... | 17 | +| 8.2.3.2 1,28 Mcps TDD option ..................................................................................................................... | 18 | +| 8.2.3.3 7,68 Mcps TDD option ..................................................................................................................... | 18 | +| 8.2.4 Interpretation of the measurement results ............................................................................................... | 19 | +| 8.3 Conducted emission DC power input/output port........................................................................................... | 19 | +| 8.3.1 Definition................................................................................................................................................. | 19 | +| 8.3.2 Test method ............................................................................................................................................. | 19 | +| 8.3.3 Limits....................................................................................................................................................... | 20 | +| 8.4 Conducted emissions, AC mains power input/output port.............................................................................. | 20 | +| 8.4.1 Definition................................................................................................................................................. | 20 | +| 8.4.2 Test method ............................................................................................................................................. | 20 | +| 8.4.3 Limits....................................................................................................................................................... | 20 | +| 8.5 Harmonic current emissions (AC mains input port) ....................................................................................... | 21 | +| 8.6 Voltage fluctuations and flicker (AC mains input port).................................................................................. | 21 | +| 9 Test methods and levels for immunity tests ......................................................................................................... | 21 | +| 9.1 Test configurations.......................................................................................................................................... | 21 | +| 9.2 RF electromagnetic field (80 MHz - 1000 MHz and 1400 MHz to 2700 MHz)............................................ | 22 | + +| | | | +|----------------------------------------------------------------------------------------------|---------------------------------------------------|-----------| +| 9.2.1 | Definition..... | 22 | +| 9.2.2 | Test method and level..... | 22 | +| 9.2.3 | Performance criteria ..... | 22 | +| 9.3 | Electrostatic discharge..... | 22 | +| 9.3.1 | Definition..... | 22 | +| 9.3.2 | Test method and level..... | 22 | +| 9.3.3 | Performance criteria ..... | 23 | +| 9.4 | Fast transients common mode..... | 23 | +| 9.4.1 | Definition..... | 23 | +| 9.4.2 | Test method and level..... | 23 | +| 9.4.3 | Performance criteria ..... | 23 | +| 9.5 | RF common mode (0.15 MHz to 80 MHz)..... | 23 | +| 9.5.1 | Definition..... | 23 | +| 9.5.2 | Test method and level..... | 24 | +| 9.5.3 | Performance criteria ..... | 24 | +| 9.6 | Transients and surges, vehicular environment..... | 24 | +| 9.6.1 | Definition..... | 24 | +| 9.6.2 | Test method and level..... | 24 | +| 9.6.2.1 | 12 V DC powered equipment ..... | 24 | +| 9.6.2.2 | 24 V DC powered equipment ..... | 25 | +| 9.6.3 | Performance criteria ..... | 25 | +| 9.7 | Voltage dips and interruptions ..... | 25 | +| 9.7.1 | Definition..... | 25 | +| 9.7.2 | Test method and level..... | 25 | +| 9.7.3 | Performance criteria ..... | 26 | +| 9.8 | Surges, common and differential mode..... | 26 | +| 9.8.1 | Definition..... | 26 | +| 9.8.2 | Test method and level..... | 26 | +| 9.8.3 | Performance criteria ..... | 26 | +| Annex A (normative): Performance assessment voice call. Audio break through..... | | 27 | +| A.1 | Calibration of audio levels ..... | 27 | +| A.2 | Measurement of audio levels ..... | 28 | +| Annex B (normative): Performance assessment of data transfer call. Error Ratios ..... | | 29 | +| B.1 | Calibration of data transfer ..... | 29 | +| B.2 | Derivation of Error Ratios..... | 29 | +| B.3 | EUT without data application ancillary ..... | 29 | +| B.4 | EUT with data application ancillary ..... | 30 | +| Annex C (informative): Change History ..... | | 31 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document establishes the essential EMC requirements for UTRA terminal equipment and ancillary accessories in combination with a 3GPP user equipment (UE). + +The equipment conforming to the requirements laid out in the present document and used in its intended electromagnetic environment in accordance with the manufacturers instructions + +- shall not generate electromagnetic disturbances at a level which may interfere with the intended operation of other equipment; +- has an adequate level of intrinsic immunity to electromagnetic disturbances to operate as intended; + +The present document specifies the applicable EMC tests, the methods of measurement, the frequency range, the limits and the minimum performance criteria for all types of UTRA UE's operating in FDD or TDD modes and their accessories. The TDD has two options. The two options are the 3,84Mcps and 1,28Mcps options respectively. The requirements are listed in different subsections only if the parameters deviate. Base station equipment operating within network infrastructure is outside the scope of the present document. However, the present document does cover mobile and portable equipment that is intended to be operated in a fixed location while connected to the AC mains. Base stations in the radio access network are covered by the technical specification TS25.113 [1]. + +Requirements for the radiated emission from the enclosure port of integral antenna equipment and ancillaries have been included. Technical specifications for conducted emissions from the antenna connector are found in the 3GPP specifications for the radio interface, e.g. TS34.121 [2] and TS34.122 [3], for the effective use of the radio spectrum. + +The immunity requirements have been selected to ensure an adequate level of compatibility for apparatus in residential, commercial, light industrial and vehicular environments. The levels however, do not cover extreme cases, which may occur in any location but with low probability of occurrence. + +The environment classification used in the present document refers to the environment classification used in the Generic Standards IEC 61000-6-1 [4], IEC 61000-6-3 [5], except the vehicular environment class which refers to ISO 7637 Part 1 [6] and Part 2 [7]. + +Compliance of radio equipment to the requirements of the present document does not signify compliance to any requirement related to the use of the equipment (i.e. licensing requirements). + +Compliance to the requirements of the present document does not signify compliance to any safety requirement. However, any temporary or permanent unsafe condition caused by EMC is considered as non-compliance. + +# 2 References + +The following documents contain provisions, which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific; +- for a specific reference, subsequent revisions do not apply; +- for a non-specific reference, subsequent revisions do apply. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TS 25.113: "Base station and repeater electromagnetic compatibility (EMC)". +- [2] 3GPP TS 34.121: "Terminal conformance specification, Radio transmission and reception (FDD)". +- [3] 3GPP TS 34.122: "Terminal conformance specification, Radio transmission and reception (TDD)". +- [4] IEC 61000-6-1 (1997): "Electromagnetic compatibility (EMC) - Part 6: Generic standards - Section 1: Immunity standard for residential, commercial and light-industrial environments". + +- [5] IEC 61000-6-3 (1996): "Electromagnetic compatibility (EMC) - Part 6: Generic standards - Section 3: Emission standard for residential, commercial and light-industrial environments. +- [6] ISO 7637-1 (1990): "Road vehicles - Electrical disturbance by conduction and coupling - Part 1: Passenger cars and light commercial vehicles with nominal 12 V supply voltage - Electrical transient conduction along supply lines only". +- [7] ISO 7637-2 (1990): "Road vehicles - Electrical disturbance by conduction and coupling - Part 2: Commercial vehicles with nominal 24 V supply voltage - Electrical transient conduction along supply lines only". +- [8] 3GPP TR 25.990: "Vocabulary for UTRAN". +3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [9] IEC 60050(161): "International Electrotechnical Vocabulary - Chapter 161: Electromagnetic compatibility". +- [10] 3GPP TS 34.108: "Common test environments for User Equipment (UE); Conformance testing". +- [11] ITU-R Recommendation SM.329: "Unwanted emissions in the spurious domain ". +- [12] 3GPP TS 25.101: "User Equipment (UE) radio transmission and reception (FDD)". +- [13] 3GPP TS 25.102: "User Equipment (UE) radio transmission and reception (TDD)". +- [14] Void +- [15] 3GPP TS 34.109: "Terminal logical test interface; Special conformance testing functions". +- [16] IEC CISPR publication 16-1: "Specification for radio disturbance and immunity measuring apparatus and methods". +- [17] IEC 61000-3-2; (2000): "Electromagnetic compatibility; Part 3 - Limits; section 2 - Limits for harmonic current emissions (equipment input current $\leq 16$ A per phase)"; Am.1 (1997-09)". +- [18] IEC 61000-3-3; (19952): "Electromagnetic compatibility; Part 3 - Limits; section 2 - Limitation of voltage fluctuations and flicker in low-voltage supply systems for equipment with rated current $\leq 16$ A" +- [19] IEC 61000-4-2: "Electromagnetic compatibility (EMC) - Part 4: Testing and measurement techniques - section 2: Electrostatic discharge immunity test - Basic EMC publication". +- [20] IEC 61000-4-3: "Electromagnetic compatibility (EMC) - Part 4: Testing and measurement techniques - section 3: Radiated, radio-frequency electromagnetic field immunity test". +- [21] IEC 61000-4-4: "Electromagnetic compatibility (EMC) - Part 4: Testing and measurement techniques - section 4: Electrical fast transient/burst immunity test - Basic EMC publication". +- [22] IEC 61000-4-5: "Electromagnetic compatibility (EMC) - Part 4: Testing and measurement techniques - section 5: Surge immunity test". +- [23] IEC 61000-4-6: "Electromagnetic compatibility (EMC) - Part 4: Testing and measurement techniques - section 6: immunity to conducted disturbances induced by radio frequency fields". +- [24] IEC 61000-4-11: "Electromagnetic compatibility (EMC) - Part 4: Testing and measurement techniques - section 11: Voltage dips, short interruptions, and voltage variations immunity test". +- [25] ETSI ETR 027 (1991): "Radio Equipment and Systems (RES); Methods of measurement for private mobile radio equipment". +- [26] ITU-T Recommendation P.64: "Telephone transmission quality, Telephone installations, Local line networks, Objective electro-acoustical measurements. Determination of sensitivity/frequency characteristics of local telephone systems". +- [27] ITU-T Recommendation P.76: "Telephone transmission quality, Measurements related to speech loudness, Determination of loudness ratings; Fundamental principles, Annex A". + +- [28] ITU-R Recommendation SM.1539 (2001): "Variation of the boundary between the out-of-band and spurious domains required for the application of Recommendations ITU-R SM.1541 and ITU-R SM.329". +- [29] IEC CISPR 32: "Electromagnetic compatibility of multimedia equipment - Emission requirements". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**Ancillary equipment:** Equipment (apparatus), used in connection with a user equipment (UE) is considered as an ancillary equipment (apparatus) if: + +- the equipment is intended for use in conjunction with a UE to provide additional operational and/or control features to the UE, (e.g. to extend control to another position or location); and +- the equipment cannot be used on a stand alone basis to provide user functions independently of a UE; and +- the UE to which it is connected, is capable of providing some intended operation such as transmitting and/or receiving without the ancillary equipment (i.e. it is not a sub-unit of the main equipment essential to the main equipment basic functions). + +**BLER (BLock Error Ratio):** BLER is block error ratio. The BLER calculation shall be based on evaluating the CRC on each transport block . + +**Camped on a cell:** The UE is in idle mode and has completed the cell selection/reselection process and has chosen a cell. The UE monitors system information and (in most cases) paging information. Note that the services may be limited, and that the PLMN may not be aware of the existence of the UE within the chosen cell. + +**Continuous phenomena (continuous disturbance):** Electromagnetic disturbance, the effects of which on a particular device or equipment cannot be resolved into a succession of distinct effects (IEC 60050-161 [9]). + +**Data application ancillary:** ancillary which provides send and/or receive data access to UMTS services via UE + +**Enclosure port:** physical boundary of the apparatus through which electromagnetic fields may radiate or impinge. In the case of integral antenna equipment, this port is inseparable from the antenna port. + +**End- User data:** Manufacturer defined data patterns for data transfer testing. Represents EUT's typical user application (eg. photo, video, textfile, message) in its characteristics. + +**Idle mode:** Idle mode is the state of User Equipment (UE) when switched on but with no Radio Resource Control (RRC) connection. + +**Integral antenna:** antenna designed to be connected directly to the equipment with or without the use of an external connector and considered to be part of the equipment. An integral antenna may be fitted internally or externally to the equipment. + +**Average power:** The average transmitter output power obtained over any specified time interval, including periods with no transmission, when the transmit time slots are at the maximum power setting. + +**Necessary bandwidth:** For a given class of emission, the width of the frequency band which is just sufficient to ensure the transmission of information at the rate and with the quality required under specified conditions. + +**Out of band emissions:** Emission on a frequency or frequencies immediately outside the necessary bandwidth, which results from, the modulation process, but excluding spurious emissions. + +NOTE: Any unwanted emission which falls at frequencies separated from the centre frequency of the emission by less than 250% of the necessary bandwidth of the emission will generally be considered out-of-band emission. + +**Port:** particular interface, of the specified equipment (apparatus), with the electromagnetic environment. For example, any connection point on an equipment intended for connection of cables to or from that equipment is considered as a port (see figure 1). + +![Diagram of an APPARATUS showing various port types: Mains power port (DC power port, Earth port), Enclosure port, and Signal/control port (Antenna Port, Telecom Port, Earth port).](7a0db9703b68b3d06cdaeefc084c0006_img.jpg) + +| | | | | +|------------------|----------------|---------------------|--------------| +| Mains power port | Enclosure port | Signal/control port | | +| DC power port | | APPARATUS | Antenna Port | +| Earth port | | | Telecom Port | +| | | Earth port | | + +Diagram of an APPARATUS showing various port types: Mains power port (DC power port, Earth port), Enclosure port, and Signal/control port (Antenna Port, Telecom Port, Earth port). + +Figure 1: Examples of ports + +**Spurious emission from ITU-R SM 329 [11]:** Emission on a frequency, or frequencies, which are outside the necessary bandwidth and the level of which may be reduced without affecting the corresponding transmission of information. Spurious emissions include harmonic emissions, parasitic emissions, intermodulation products and frequency conversion products but exclude out-of-band emissions. + +**Telecommunication port:** ports which are intended to be connected to telecommunication networks (e.g. public switched telecommunication networks, integrated services digital networks), local area networks (e.g. Ethernet, Token Ring) and similar networks (see CISPR 32 [29]). + +**Transient phenomena:** Pertaining to or designating a phenomena or a quantity which varies between two consecutive steady states during a time interval short compared with the time-scale of interest (IEC 60050-161 [9]). + +**Traffic mode:** is the state of User Equipment (UE) when switched on and with Radio Resource Control (RRC) connection established. + +**Universal mobile telecommunications system (UMTS):** The telecommunications system, incorporating mobile cellular and other functionality, that is the subject of specifications produced by 3GPP + +**User equipment (UE):** is a "Mobile Station" (MS) which is an entity capable of accessing a set of UMTS services via one or more radio interfaces. This entity may be stationary or in motion within the UMTS service area while accessing the UMTS services, and may simultaneously serve one or more users. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|--------------------------------------------------| +| AC | Alternating Current | +| BCCH | Broadcast Control Channel *) | +| BS | Base Station | +| BSS | Base Station System | +| BTS | Base Transceiver Station | +| CCCH | Common Control Channel *) | +| CW | Continuous Wave (unmodulated carrier wave) | +| DC | Direct Current | +| DL | Down Link (From BTS to UE) | +| DTX | Discontinuous Transmission *) | +| EMC | Electromagnetic Compatibility | +| ESD | ElectroStatic Discharge | +| EUT | Equipment Under Test (UE or UE with ancillaries) | +| FDD | Frequency Division Duplex | +| LISN | Line Impedance Stabilizing Network | +| MRP | Mouth Reference Point (artificial head) | +| PCCPCH | Primary Common Control Physical Channel | +| RF | Radio Frequency | +| rms | root mean square | +| RRC | Radio Resource Control | +| SPL | Sound Pressure Level | +| TCH | Traffic channel | +| TDD | Time Division Duplex | + +| | | +|--------|-------------------------------------------------| +| UARFCN | UTRA Absolute Radio Frequency Channel Number *) | +| UE | User Equipment | +| UL | Up Link (From UE to BTS) | +| UMTS | Universal Mobile Telecommunication System | +| UTRA | Universal Terrestrial Radio Access network | + +\*) refer to Terminology specifications TS 21.905 and TS 25.990 [8] for further details. + +# 4 Test conditions + +## 4.1 General + +The equipment shall be tested under normal test conditions according to the relevant product and basic standards (See Annex D of TS 25.101 and Annex C of TS 25.102 for environmental conditions). If these conditions are not specified then the manufacturers declared range of humidity, temperature and supply voltage shall be used. The test conditions shall be recorded in the test report. + +Whenever the Equipment under test (EUT) is provided with a detachable antenna, the EUT shall be tested with the antenna fitted in a manner typical of normal intended use, unless specified otherwise. + +Where the equipment incorporates an external 50 $\Omega$ RF antenna connector that is normally connected via a coaxial cable, then the wanted signal to establish a communication link also uses a coaxial cable; + +Where the equipment has an external 50 $\Omega$ RF antenna connector that is not normally connected via a coaxial cable or where the equipment has no external 50 $\Omega$ RF connector (i.e., integral antenna equipment), then the wanted signal, to establish a communication link, shall be delivered from the equipment to an antenna located within the test environment; + +## 4.2 Arrangements for establishing a communication link + +The wanted RF input signal nominal frequency shall be selected by setting the UTRA Absolute Radio Frequency Channel Number (UARFCN) to an appropriate number. + +A communication link shall be set up with a suitable base station simulator (hereafter called "the test system"). The test system shall be located outside of the test environment + +When the EUT is required to be in the traffic mode, a call is set up according to the Generic call set-up procedure and the following conditions shall be met: + +See TS 34.108 [10] and TS 34.109 [15] Logical Test Interface for details regarding generic call set-up procedure and BER, BLER test loop scenarios. + +- set and send continuously Up power control commands to the UE; +- the DTX shall be disabled; +- For FDD and 3.84 Mcps TDD option Inner Loop Power Control shall be enabled, and for 1,28 Mcps TDD option closed loop power control shall be enabled; +- transmitting and/or receiving (UL/DL) bit rate for reference test channel shall be 12.2 kbps; +- adequate measures shall be taken to avoid the effect of the unwanted signal on the measuring equipment; +- For immunity testing , the wanted input signal level shall be set to 40 dB above the reference sensitivity level to provide a stable communication link. The reference sensitivity level is defined in TS 25.101 [12] and in TS 25.102 respectively. +- For emission testing, the wanted input signal level shall be no more than 15 dB above the reference sensitivity level, such that the performance of the measuring receiver is not limited by strong signal effects. + +When the EUT is required to be in the idle mode, the following conditions shall be met: + +- UE shall be camped on a cell +- UE shall perform Location Registration (LR) before the test, but not during the test; +- UE's neighbour cell list shall be empty; +- Paging repetition period and DRX cycle shall be set to minimum (shortest possible time interval); + +For immunity tests subclause 4.3, shall apply and the conditions shall be as follows: + +## 4.3 Narrow band responses on receivers + +### 4.3.1 FDD and 3.84Mcps TDD option + +Responses on receivers or duplex transceivers occurring during the test at discrete frequencies, which are narrow band responses (spurious responses), are identified by the following method: + +- If during an immunity test the quantity being monitored goes outside the specified tolerances, it is necessary to establish whether the deviation is due to an unwanted effect on the receiver of the UE or on the test system (narrow band response) or to a wide band (EMC) phenomenon. Therefore, the test shall be repeated with the UARFCN increased or decreased by 25 (DL / UL). +- if the deviation does not disappear, the procedure is repeated with the UARFCN increased or decreased by 50 from the original value (DL / UL); +- if the deviation does not disappear with the increased and/or decreased UARFCN, the phenomenon is considered wide band and therefore an EMC problem and the equipment fails the test. + +Narrow band responses are disregarded. + +The procedure above does not apply to conducted immunity tests in the frequency range 150 kHz to 80 MHz. + +### 4.3.2 1,28Mcps TDD option + +Responses on receivers or duplex transceivers occurring during the test at discrete frequencies, which are narrow band responses (spurious responses), are identified by the following method: + +- If during an immunity test the quantity being monitored goes outside the specified tolerances, it is necessary to establish whether the deviation is due to an unwanted effect on the receiver of the UE or on the test system (narrow band response) or to a wide band (EMC) phenomenon. Therefore, the test shall be repeated with the UARFCN increased or decreased by 8 (DL / UL). +- if the deviation does not disappear, the procedure is repeated with the UARFCN increased or decreased by 16 from the original value (DL / UL); +- if the deviation does not disappear with the increased and/or decreased UARFCN, the phenomenon is considered wide band and therefore an EMC problem and the equipment fails the test. + +Narrow band responses are disregarded. + +The procedure above does not apply to conducted immunity tests in the frequency range 150 kHz to 80 MHz. + +### 4.3.3 7,68Mcps TDD option + +Responses on receivers or duplex transceivers occurring during the test at discrete frequencies, which are narrow band responses (spurious responses), are identified by the following method: + +- If during an immunity test the quantity being monitored goes outside the specified tolerances, it is necessary to establish whether the deviation is due to an unwanted effect on the receiver of the UE or on the test system (narrow band response) or to a wide band (EMC) phenomenon. Therefore, the test shall be repeated with the UARFCN increased or decreased by 50 (DL / UL). + +- if the deviation does not disappear, the procedure is repeated with the UARFCN increased or decreased by 100 from the original value (DL / UL); +- if the deviation does not disappear with the increased and/or decreased UARFCN, the phenomenon is considered wide band and therefore an EMC problem and the equipment fails the test. + +Narrow band responses are disregarded. + +The procedure above does not apply to conducted immunity tests in the frequency range 150 kHz to 80 MHz. + +## 4.4 Receiver exclusion band + +## 4.4 Receiver exclusion band + +The receiver exclusion band for terminals extends from the lower frequency of the allocated receiver band minus 85 MHz to the upper frequency of the allocated receiver band plus 85 MHz. The *receiver exclusion band* for UE is the frequency range over which no tests of radiated immunity of a receiver are made. The exclusions bands are as set out below: +$$F_{DL,low} - 85 < f < F_{DL,high} + 85 \text{ (MHz)}$$ + +Where values of $F_{DL,low}$ and $F_{DL,high}$ are defined for downlink of each UTRA FDD operating band in TS 25.101 [12] clause 5.2, and for each UTRA TDD operating band in TS 25.102 [13] clause 5.2. + +# --- 5 Performance assessment + +## 5.1 General + +The manufacturer shall at the time of submission of the equipment for test, supply the following information to be recorded in the test report: + +- the primary functions of the radio equipment to be tested during and after the EMC testing; +- if applicable, the method to be used to verify that a communications link is established and maintained; +- the intended functions of the radio equipment which shall be in accordance with the documentation accompanying the equipment; +- the user-control functions and stored data that are required for normal operation and the method to be used to assess whether these have been lost after EMC stress; +- the ancillary equipment to be combined with the radio equipment for testing (where applicable); +- information about ancillary equipment intended to be used with the radio equipment; +- an exhaustive list of ports, classified as either power or signal/control. Power ports shall further be classified as AC or DC power; +- the humidity range, temperature, and supply voltage for all equipment submitted for testing. + +## 5.2 Equipment which can provide a continuous communication link + +The test arrangement and signals, given in clause 4, apply to radio equipment or a combination of radio equipment and ancillary equipment that permits the establishment of a communication link. The assessment of equipment performance shall be based on speech call and data transfer according to the criteria in clause 6. + +## 5.3 Equipment which can only provide a discontinuous communication link (packet data/transmission) + +If the equipment does not permit or allow for a communications link to be established and maintained during the EMC tests (as in subclause 5.2), the manufacturer shall define the performance assessment. The manufacturer shall provide the method of observing the degradation of performance of the equipment. + +## 5.4 Equipment which does not provide a communication link + +If the equipment is of a specialised nature which does not permit a communication link to be established, the manufacturer shall define the method of test to determine the acceptable level of performance or degradation of performance during and/or after the test. The manufacturer shall provide the method of observing the degradation of performance of the equipment. + +The performance assessment carried out shall be simple, but at the same time give adequate proof that the primary functions of the equipment are operational. + +## 5.5 Conformance of ancillary equipment + +Ancillary equipment shall be tested with it connected to a UE in which case compliance shall be demonstrated to the appropriate clauses of the present document. + +## 5.6 Equipment classification + +Equipment is classified according to the source of power. + +- if power is derived from a fixed AC or DC supply network installation the equipment is classified "for fixed use"; +- if power is derived from a vehicular power supply (car battery + alternator) the equipment is classified "for vehicular use"; +- if power is derived from an integral battery the equipment is classified "for portable use"; + +# --- 6 Performance criteria + +The maintenance of a communications link shall be assessed by using an indicator, which may be part of the test system or the equipment under test. + +Specifically the equipment shall meet the minimum performance criteria as specified in the following subclauses as appropriate. + +Portable equipment intended for use whilst powered by the main battery of a vehicle shall additionally fulfil the applicable requirements set out by the present document for mobile equipment for vehicular use. + +Portable equipment intended for use whilst powered by AC mains shall additionally fulfil the applicable requirements set out by the present document for equipment for fixed use. + +If an equipment is of such nature, that the performance criteria described in the following subclauses are not appropriate, then the manufacturer shall declare, for inclusion in the test report, his own specification for an acceptable level of performance or degradation of performance during and/or after testing, as required by the present document. + +The performance criteria specified by the manufacturer shall give the same degree of immunity protection as called for in the following subclauses. + +In addition, the test shall also be performed in idle mode to ensure the transmitter does not unintentionally operate. + +The requirements apply to all types of UTRA (FDD or TDD) for the UE. + +## 6.1 Performance criteria for continuous phenomena + +A communication link shall be established at the start of the test, and maintained during the test, subclauses 4.1 and 4.2. + +In the data transfer mode, the performance criteria can be one of the following error ratios: + +- if the BER (as referred in TS34.109) is used, it shall not exceed 0.001 during the test sequence; +- if the BLER (as referred in TS34.109) is used, it shall not exceed 0.01 during the test sequence; + +In the speech mode, the performance criteria shall be that the up link and downlink speech output levels shall be at least 35 dB less than the recorded reference levels, when measured through an audio band pass filter of width 200 Hz, centred on 1 kHz (Annex A). + +NOTE: When there is a high level noise background noise present the filter bandwidth can be reduced down to a minimum of 40 Hz. + +At the conclusion of the test, the EUT shall operate as intended with no loss of user control functions or stored data, and the communication link shall have been maintained. + +In addition to confirming the above performance in traffic mode, the test shall be performed in idle mode, and the transmitter shall not unintentionally operate. + +## 6.2 Performance criteria for Transient phenomena + +A communications link shall be established at the start of the test, subclauses 4.1 and 4.2. + +At the conclusion of each exposure the EUT shall operate with no user noticeable loss of the communication link. + +At the conclusion of the total test comprising the series of individual exposures, the EUT shall operate as intended with no loss of user control functions or stored data, as declared by the manufacturer, and the communication link shall have been maintained. + +In addition to confirming the above performance in traffic mode, the test shall also be performed in idle mode, and the transmitter shall not unintentionally operate. + +# 7 Applicability overview tables + +## 7.1 Emission + +Table 1: Emission applicability + +| Phenomenon | Application | Equipment test requirement | | | Reference subclause in the present document | Reference Standard | +|----------------------------------|----------------------------|-----------------------------------------------------------|----------------------------------------------|---------------------------------------|---------------------------------------------|------------------------------------| +| | | Equipment connected to fixed AC or DC power installations | Equipment connected to vehicular DC supplies | Equipment powered by integral battery | | | +| Radiated emission | Enclosure | applicable | applicable | applicable | 8.2 | ITU-R SM.329 [11]
TS25.101 [12] | +| Conducted emission | DC power input/output port | applicable | applicable | not applicable | 8.3 | CISPR 32 [29],
CISPR 16-1 [16] | +| Conducted emission | AC mains input/output port | applicable | not applicable | not applicable | 8.4 | CISPR 32 [29] | +| Harmonic current emissions | AC mains input port | applicable | not applicable | not applicable | 8.5 | IEC 61000-3-2 [17] | +| Voltage fluctuations and flicker | AC mains input port | applicable | not applicable | not applicable | 8.6 | IEC 61000-3-3 [18] | + +## 7.2 Immunity + +Table 2: Immunity applicability + +| Phenomenon | Application | Equipment test requirement | | | Reference subclause in the present document | Reference standard | +|-----------------------------------------------|-------------------------------------------------------|-----------------------------------------------------------|----------------------------------------------|---------------------------------------|---------------------------------------------|---------------------------------------------------| +| | | Equipment connected to fixed AC or DC power installations | Equipment connected to vehicular DC supplies | Equipment powered by integral battery | | | +| RF electromagnetic field (80 MHz to 2700 MHz) | Enclosure | applicable | applicable | applicable | 9.2 | IEC 61000-4-3 [20] | +| Electrostatic discharge | Enclosure | applicable | applicable | applicable | 9.3 | IEC 61000-4-2 [19] | +| Fast transients common mode | Signal and control ports, DC and AC power input ports | applicable | not applicable | not applicable | 9.4 | IEC 61000-4-4 [21] | +| RF common mode 0,15 MHz to 80 MHz | Signal and control ports, DC and AC power input ports | applicable | applicable | applicable | 9.5 | IEC 61000-4-6 [23] | +| Transients and surges, vehicular environment | DC power input ports | not applicable | applicable | not applicable | 9.6 | ISO 7637 Part 1 [6]
And
ISO 7637 Part 2 [7] | +| Voltage dips and interruptions | AC mains power input ports | applicable | not applicable | not applicable | 9.7 | IEC 61000-4-11 [24] | +| Surges, common and differential mode | DC and AC power input ports | applicable | not applicable | not applicable | 9.8 | IEC 61000-4-5 [22] | + +# 8 Methods of measurement and limits for EMC emissions + +## 8.1 Test configurations + +This subclause defines the configurations for emission tests as follows: + +- the equipment shall be tested under normal test conditions; +- the test configuration shall be as close to normal intended use as possible; +- if the equipment is part of a system, or can be connected to ancillary equipment, then it shall be acceptable to test the equipment while connected to the minimum configuration of ancillary equipment necessary to exercise the ports; +- if the equipment has a large number of ports, then a sufficient number shall be selected to simulate actual operation conditions and to ensure that all the different types of termination are tested; +- the test conditions, test configuration and mode of operation shall be recorded in the test report; + +- ports which in normal operation are connected shall be connected to an ancillary equipment or to a representative piece of cable correctly terminated to simulate the input/output characteristics of the ancillary equipment, Radio Frequency (RF) input/output ports shall be correctly terminated; +- ports that are not connected to cables during normal operation, e.g. service connectors, programming connectors; temporary connectors etc. shall not be connected to any cables for the purpose of EMC testing. Where cables have to be connected to these ports, or interconnecting cables have to be extended in length in order to exercise the EUT, precautions shall be taken to ensure that the evaluation of the EUT is not affected by the addition or extension of these cables; +- emission tests shall be performed in two modes of operation: + - with a communication link established (traffic mode); and + - in the idle mode. + +## 8.2 Radiated Emission + +This test is applicable to radio communications equipment and ancillary equipment. + +This test shall be performed on the radio equipment and/or a representative configuration of the ancillary equipment. + +### 8.2.1 Definition + +This test assesses the ability of radio equipment and ancillary equipment to limit unwanted emissions from the enclosure port. + +### 8.2.2 Test method + +Whenever possible the site shall be a fully anechoic chamber (FAC) simulating the free-space conditions. EUT shall be placed on a non-conducting support. Mean power of any spurious components shall be detected by the test antenna and measuring receiver (e.g. a spectrum analyser). + +At each frequency at which a component is detected, the EUT shall be rotated to obtain maximum response, and the effective radiated power (e.r.p.) of that component determined by a substitution measurement, which shall be the reference method. The measurement shall be repeated with the test antenna in the orthogonal polarization plane. + +NOTE: Effective radiated power e.r.p. refers to the radiation of a half wave tuned dipole instead of an isotropic antenna. There is a constant difference of 2.15 dB between e.i.r.p. and e.r.p. + +$$\text{e.r.p. (dBm)} = \text{e.i.r.p. (dBm)} - 2.15 \quad \text{Ref. ITU-R SM. 329 ANNEX 1 [11]}$$ + +Measurements are made with a tuned dipole antenna or a reference antenna with a known gain referenced to an isotropic antenna. Unless otherwise stated, all measurements are done as mean power (RMS). + +If a different test site or method is used, this shall be stated in the test report. The results shall be converted to the reference method values and the validity of the conversion shall be demonstrated. + +### 8.2.3 Limits + +The references for these requirements are ITU-R SM 329 [11], SM.1539 [28] and TS 25.101 subclauses 6.6.3.1. and 7.9.1 [12] and TS 25.102 subclauses 6.6.3 and 7.9 [13] respectively. + +#### 8.2.3.1 FDD and 3.84 Mcps TDD option + +The frequency boundary and reference bandwidths for the detailed transitions of the limits between the requirements for out of band emissions and spurious emissions are based on ITU-R SM 329 [11]. + +These requirements are only applicable for frequencies in the spurious domain. + +**Table 3: Radiated spurious emissions requirements** + +| Frequency | Minimum requirement (e.r.p.) /
Reference Bandwidth
Idle mode | Minimum requirement (e.r.p.) /
Reference Bandwidth
Traffic mode | +|-------------------------------------------------------|--------------------------------------------------------------------|-----------------------------------------------------------------------| +| $30 \text{ MHz} \leq f < 1000 \text{ MHz}$ | -57dBm / 100 kHz | -36 dBm / 100 kHz | +| $1 \text{ GHz} \leq f < 12.75 \text{ GHz}$ | -47dBm / 1MHz | -30 dBm / 1 MHz | +| $f_c - 12.5 \text{ MHz} < f < f_c + 12.5 \text{ MHz}$ | Not defined | Not defined | + +NOTE: $f_c$ is the centre frequency of the TCH. The frequency range $f_c \pm 12.5 \text{ MHz}$ are covered by the "Out of Band" emission requirements of TS 34.121[2] and TS 34.122 [3]. + +#### 8.2.3.2 1,28 Mcps TDD option + +The frequency boundary and reference bandwidths for the detailed transitions of the limits between the requirements for out of band emissions and spurious emissions are based on ITU-R SM 329 [11]. + +These requirements are only applicable for frequencies, which are greater than 4 MHz away from the UE centre carrier frequency + +**Table 3.1: Radiated spurious emissions requirements** + +| Frequency | Minimum requirement (e.r.p.) /
Reference Bandwidth
Idle mode | Minimum requirement (e.r.p.) /
Reference Bandwidth
Traffic mode | +|-------------------------------------------------|--------------------------------------------------------------------|-----------------------------------------------------------------------| +| $30 \text{ MHz} \leq f < 1000 \text{ MHz}$ | -57dBm / 100 kHz | -36 dBm / 100 kHz | +| $1 \text{ GHz} \leq f < 12.75 \text{ GHz}$ | -47dBm / 1MHz | -30 dBm / 1 MHz | +| $f_c - 4 \text{ MHz} < f < f_c + 4 \text{ MHz}$ | Not defined | Not defined | + +NOTE: $f_c$ is the centre frequency of the TCH. The frequency range $f_c \pm 4 \text{ MHz}$ are covered by the "Out of Band" emission requirements of TS 34.122 [3]. + +#### 8.2.3.3 7,68 Mcps TDD option + +The frequency boundary and reference bandwidths for the detailed transitions of the limits between the requirements for out of band emissions and spurious emissions are based on ITU-R SM 329 [11]. + +These requirements are only applicable for frequencies in the spurious domain. + +**Table 3.2: Radiated spurious emissions requirements** + +| Frequency | Minimum requirement (e.r.p.) /
Reference Bandwidth
Idle mode | Minimum requirement (e.r.p.) /
Reference Bandwidth
Traffic mode | +|---------------------------------------------------|--------------------------------------------------------------------|-----------------------------------------------------------------------| +| $30 \text{ MHz} \leq f < 1000 \text{ MHz}$ | -57dBm / 100 kHz | -36 dBm / 100 kHz | +| $1 \text{ GHz} \leq f < 12.75 \text{ GHz}$ | -47dBm / 1MHz | -30 dBm / 1 MHz | +| $f_c - 25 \text{ MHz} < f < f_c + 25 \text{ MHz}$ | Not defined | Not defined | + +NOTE: $f_c$ is the centre frequency of the TCH. The frequency range $f_c \pm 25 \text{ MHz}$ are covered by the "Out of Band" emission requirements of TS 34.121[2] and TS 34.122 [3]. + +### 8.2.4 Interpretation of the measurement results + +The interpretation of the results recorded in a test report for the radiated emission measurements described in the present document shall be as follows: + +- the measured value related to the corresponding limit will be used to decide whether an equipment meets the requirements of the present document; +- the value of the measurement uncertainty for the measurement of each parameter shall be included in the test report; +- the recorded value of the measurement uncertainty shall be, for each measurement, equal to or lower than the figure in table 3B. + +Table 3B specifies the Maximum measurement uncertainty of the Test System. The Test System shall enable the equipment under test to be measured with an uncertainty not exceeding the specified values. All tolerances and uncertainties are absolute values, and are valid for a confidence level of 95 %, unless otherwise stated. + +A confidence level of 95% is the measurement uncertainty tolerance interval for a specific measurement that contains 95% of the performance of a population of test equipment. + +**Table 3B: Maximum measurement uncertainty** + +| Parameter | Uncertainty | +|-----------------------------------------------------------|-------------| +| Effective radiated RF power between 30 MHz and 180 MHz | ±6 dB | +| Effective radiated RF power between 180 MHz and 12,75 GHz | ±3 dB | + +NOTE: If the Test System for a test is known to have a measurement uncertainty greater than that specified in table 3B, this equipment can still be used, provided that an adjustment is made follows: + +Any additional uncertainty in the Test System over and above that specified in table 3B is used to tighten the Test Requirements - making the test harder to pass. This procedure will ensure that a Test System not compliant with table 3B does not increase the probability of passing an EUT that would otherwise have failed a test if a Test System compliant with table 3B had been used. + +## 8.3 Conducted emission DC power input/output port + +This test is applicable to all equipment, which may have DC cables longer than 3 m. + +If the DC power cable of the UE and/or the ancillary equipment is intended to be less than 3 m in length, and intended only for direct connection to a dedicated AC to DC power supply, then the measurement shall be performed only on the AC power input of that power supply as specified in subclause 8.4. + +This test shall be performed on a representative configuration of the radio equipment or a representative configuration of the combination of radio and ancillary equipment. + +### 8.3.1 Definition + +This test assesses the ability of radio equipment and ancillary equipment to limit internal noise from the DC power input/output ports. + +### 8.3.2 Test method + +The test method shall be in accordance with CISPR 32 [29], and the Line Impedance Stabilising Networks (LISN) shall be connected to a DC power source. + +In the case of DC output ports, the ports shall be connected via a LISN to a load drawing the rated current of the source. + +A measuring receiver shall be connected to each LISN measurement port in turn and the conducted emission recorded. The LISN measurement ports not being used for measurement shall be terminated with a 50 Ω load. + +The equipment shall be installed with a ground plane as defined in CISPR 32 [29]. The reference earth point of the LISNs shall be connected to the reference ground plane with a conductor as short as possible. + +The measurement receiver shall be in accordance with the requirements of section one of CISPR 16-1 [16]. + +### 8.3.3 Limits + +The equipment shall meet the limits defined in table 4 (including the average limit and the quasi-peak limit) when using, respectively, an average detector receiver and a quasi-peak detector receiver and measured in accordance with the method described in subclause 8.2.2 above. If the average limit is met when using a quasi-peak detector, the equipment shall be deemed to meet both limits and measurement with the average detector receiver is not necessary. + +**Table 4: Limits** + +| Frequency range | Quasi-peak | Average | +|-----------------------------------------------------------------------------------------------------------|--------------------|--------------------| +| > 0,15-0,5 MHz | 66 - 56 dB $\mu$ V | 56 - 46 dB $\mu$ V | +| > 0,5- 5 MHz | 56 dB $\mu$ V | 46 dB $\mu$ V | +| > 5-30 MHz | 60 dB $\mu$ V | 50 dB $\mu$ V | +| NOTE: The limit decreases linearly with the logarithm of the frequency in the range 0,15 MHz to 0,50 MHz. | | | + +## 8.4 Conducted emissions, AC mains power input/output port + +This test is applicable to equipment powered by the AC mains. + +This test is not applicable to AC output ports, which are connected directly (or via a switch or circuit breaker) to the AC input port. + +This test shall be performed on a representative configuration of the radio equipment or a representative configuration of the combination of radio and ancillary equipment. + +### 8.4.1 Definition + +This test assesses the ability of radio equipment and ancillary equipment to limit internal noise from the AC mains power input/output ports. + +### 8.4.2 Test method + +The test method shall be in accordance with CISPR 32 [29], + +Mains connected ancillary equipment which is not part of the EUT shall be connected to the mains via a separate LISN. According to subclause 11.9 of CISPR 16-1 [16], the Protective Earth (PE) wire shall also be terminated by a 50 $\Omega$ //50 $\mu$ H common mode RF impedance. + +### 8.4.3 Limits + +The equipment shall meet the limits defined in table 5 (including the average limit and the quasi-peak limit) when using, respectively, an average detector receiver and a quasi-peak detector receiver and measured in accordance with the method described in subclause 8.3.2 above. If the average limit is met when using a quasi-peak detector, the equipment shall be deemed to meet both limits and measurement with the average detector receiver is not necessary. + +**Table 5: Limits for conducted emissions** + +| Frequency range | Quasi-peak | Average | +|-----------------------------------------------------------------------------------------------------------|--------------------|--------------------| +| > 0,15-0,5 MHz | 66 - 56 dB $\mu$ V | 56 - 46 dB $\mu$ V | +| > 0,5- 5 MHz | 56 dB $\mu$ V | 46 dB $\mu$ V | +| > 5-30 MHz | 60 dB $\mu$ V | 50 dB $\mu$ V | +| NOTE: The limit decreases linearly with the logarithm of the frequency in the range 0,15 MHz to 0,50 MHz. | | | + +## 8.5 Harmonic current emissions (AC mains input port) + +The requirements of IEC 61000-3-2 [17] for harmonic current emission apply for equipment covered by the scope of the present document. + +## 8.6 Voltage fluctuations and flicker (AC mains input port) + +The requirements of IEC 61000-3-3 [18] for voltage fluctuations and flicker apply for equipment covered by the scope of the present document. + +# --- 9 Test methods and levels for immunity tests + +## 9.1 Test configurations + +This subclause defines the configurations for immunity tests as follows: + +- the equipment shall be tested under normal test conditions as specified in the core specification ,e.g., TS 34.109 [15]; +- the test configuration shall be as close to normal intended use as possible; +- if the equipment is part of a system, or can be connected to ancillary equipment, then it shall be acceptable to test the equipment while connected to the minimum configuration of ancillary equipment necessary to exercise the ports; +- if the equipment has a large number of ports, then a sufficient number shall be selected to simulate actual operation conditions and to ensure that all the different types of termination are tested; +- the test conditions, test configuration and mode of operation shall be recorded in the test report; +- ports which in normal operation are connected shall be connected to an ancillary equipment or to a representative piece of cable correctly terminated to simulate the input/output characteristics of the ancillary equipment, Radio Frequency (RF) input/output ports shall be correctly terminated; +- ports, which are not, connected to cables during normal operation, e.g. service connectors, programming connectors, temporary connectors etc. shall not be connected to any cables for the purpose of EMC testing. Where cables have to be connected to these ports, or interconnecting cables have to be extended in length in order to exercise the EUT, precautions shall be taken to ensure that the evaluation of the EUT is not affected by the addition or extension of these cables; +- the test arrangements for transmitter and receiver sections of the transceiver are described separately for the sake of clarity. However, where possible the test of the transmitter section and receiver section of the EUT may be carried out simultaneously to reduce test time; +- immunity tests shall be performed in two modes of operation: + - with a communication link established (traffic mode); and + - in the idle mode. + +See subclauses 6.1 and 6.2. + +## 9.2 RF electromagnetic field (80 MHz - 1000 MHz and 1400 MHz to 2700 MHz) + +The test shall be performed on a representative configuration of the equipment or a representative configuration of the combination of UE and ancillary equipment. + +### 9.2.1 Definition + +This test assesses the ability of UE and ancillary equipment to operate as intended in the presence of a radio frequency electromagnetic field disturbance at the enclosure. + +### 9.2.2 Test method and level + +The test method shall be in accordance with IEC 61000-4-3 [20] + +- for UE and ancillary equipment the following requirements shall apply; +- the test level shall be 3 V/m amplitude modulated to a depth of 80 % by a sinusoidal audio signal of 1 kHz; +- the stepped frequency increments shall be 1 % of the momentary frequency; +- when using the max hold detector method (see ANNEX A) at each test frequency step initially an unmodulated test signal shall be applied. Then the test modulation shall be applied; +- the test shall be performed over the frequency range 80 MHz to 1 000 MHz and 1400 MHz to 2700 MHz; +- responses in stand alone receivers or receivers which are part of transceivers occurring at discrete frequencies which are narrow band responses, shall be disregarded, see subclause 4.3; +- the frequencies selected during the test shall be recorded in the test report. + +### 9.2.3 Performance criteria + +The performance criteria of subclause 6.1 shall apply. + +## 9.3 Electrostatic discharge + +The test shall be performed on a representative configuration of the equipment or a representative configuration of the combination of UE and ancillary equipment. + +### 9.3.1 Definition + +This test assesses the ability of UE and ancillary equipment to operate as intended in the event of an electrostatic discharge. + +### 9.3.2 Test method and level + +The test method shall be in accordance with IEC 61000-4-2 [19]: + +- for contact discharge, the equipment shall pass at $\pm 2$ kV and $\pm 4$ kV; +- for air discharge the equipment shall pass at $\pm 2$ kV, $\pm 4$ kV and $\pm 8$ kV (only for non-conducting surfaces, see IEC 61000-4-2 [19]). + +NOTE: The EUT shall be fully discharged between each ESD exposure by connecting its ground point (where applicable) to the HCP by a resistive wire with a 470 k $\Omega$ resistor in either end. + +### 9.3.3 Performance criteria + +The performance criteria of subclause 6.2 shall apply. + +## 9.4 Fast transients common mode + +The test shall be performed on AC mains power input ports. + +This test shall be performed on signal ports, control ports and DC power input/output ports if the cables may be longer than 3 m. + +Where this test is not carried out on a port or any other ports because the manufacturer declares that it is not intended to be used with cables longer than 3 m, a list of ports which were not tested for this reason shall be included in the test report. + +This test shall be performed on a representative configuration of the equipment or a representative configuration of the combination of UE and ancillary equipment. + +### 9.4.1 Definition + +This test assesses the ability of UE and ancillary equipment to operate as intended in the event of fast transients present on one of the input/output ports. + +### 9.4.2 Test method and level + +The test method shall be in accordance with IEC 61000-4-4 [21] + +- the test level for signal and control ports shall be 0,5 kV open circuit voltage as given in IEC 61000-4-4 [21]; +- the test level for DC power input/output ports shall be 0,5 kV open circuit voltage as given in IEC 61000-4-4 [21]; +- the test level for AC mains power input ports shall be 1 kV open circuit voltage as given in IEC 61000-4-4 [21]. + +### 9.4.3 Performance criteria + +The performance criteria of subclause 6.2 shall apply. + +## 9.5 RF common mode (0.15 MHz to 80 MHz) + +This test is applicable for UE for fixed, mobile, and portable use and for ancillary equipment. + +This test shall be performed on signal, control and DC power input/output ports, which may have cables longer than 3 m. + +This test shall be performed on AC mains power input/output ports of UE for fixed use and for fixed ancillary equipment. Where this test is not carried out on a port or any other ports because the manufacturer declares that it is not intended to be used with cables longer than stated above, a list of ports which were not tested shall be included in the test report. + +This test shall be performed on a representative configuration of the UE or a representative configuration of the combination of UE and ancillary equipment. + +### 9.5.1 Definition + +This test assesses the ability of equipment and ancillary equipment to operate as intended in the presence of a radio frequency electromagnetic disturbance. + +### 9.5.2 Test method and level + +The test method shall be in accordance with IEC 61000-4-6 [23]. + +- the test signal shall be amplitude modulated to a depth of 80 % by a sinusoidal audio signal of 1 kHz; +- the stepped frequency increments shall be either 50 kHz or 1 % frequency increment of the momentary frequency in the frequency range 150 kHz - 5 MHz and 1 % frequency increment of the momentary frequency in the frequency range 5 MHz - 80 MHz; +- when using the max hold detector method (see ANNEX A) at each test frequency step initially an unmodulated test signal shall be applied. Then the test modulation shall be applied; +- the test level shall be severity level 2 as given in IEC 61000-4-6 [23] corresponding to 3 V rms, at a transfer impedance of 150 $\Omega$ ; +- the test shall be performed over the frequency range 150 kHz - 80 MHz; +- responses of stand alone receivers or receivers which are part of transceivers occurring at discrete frequencies which are narrow band responses, shall be disregarded, see subclause 4.3; +- the frequencies selected during the test and the test method used shall be recorded in the test report. + +### 9.5.3 Performance criteria + +The performance criteria of subclause 6.1 shall apply. + +## 9.6 Transients and surges, vehicular environment + +The tests are applicable to UE intended for use in a vehicular environment. + +These tests shall be performed on 12 V and 24 V DC power input. + +These tests shall be performed on a representative configuration of the equipment or a representative configuration of the combination of UE and ancillary equipment. + +### 9.6.1 Definition + +These tests assess the ability of UE and ancillary equipment to operate as intended in the event of transients and surges present on the DC power input ports in a vehicular environment. + +### 9.6.2 Test method and level + +The test method shall be in accordance with ISO 7637-1 [6] for nominal 12 V DC powered equipment and ISO 7637-2 [7] for nominal 24 V DC powered equipment. The requirements are detailed as follows: + +#### 9.6.2.1 12 V DC powered equipment + +Where the manufacturer in his installation documentation requires the EUT to have a direct connection to the 12 V main vehicle battery the following requirements in accordance with ISO 7637-1 [6] shall apply: + +- pulse 3a and 3b, level II ( $\pm 50$ V), with the test time reduced to 5 minutes for each; +Supply voltage $V_A = 13,5 \pm 0,5$ V DC +- pulse 4, level II, 5 pulses, with the characteristics as follows: + $V_s = -5$ V, $V_a = -2,5$ V, $t_6 = 25$ ms, $t_g = 5$ s, $t_f = 5$ ms. +Supply voltage $V_B = 12,0 \pm 0,2$ V DC + +Where the manufacturer does not require the EUT to have a direct connection to the 12 V main vehicle battery, the following pulses apply in addition: + +- pulse 1, level II (-50 V), $t_1 = 2,5$ s, 10 pulses; Supply voltage $V_A = 13,5 \pm 0,5$ V DC; +- pulse 2, level II (+50 V), $t_1 = 2,5$ s, 10 pulses. Supply voltage $V_A = 13,5 \pm 0,5$ V DC. + +Where the manufacturer declares that the EUT requires a direct connection to the vehicle battery, and the corresponding tests are not carried out, this shall be stated in the test report. + +#### 9.6.2.2 24 V DC powered equipment + +Where the manufacturer in his installation documentation requires the EUT to have a direct connection to the 24 V main vehicle battery the following requirements in accordance with ISO 7637-2 [7] shall apply: + +- pulse 3a and 3b, level II ( $\pm 70$ V), with the test time reduced to 5 minutes for each; +Supply voltage $V_A = 27 \pm 1$ V DC +- pulse 4, level II, 5 pulses, with the characteristics as follows: + $V_s = -10$ V, $V_a = -5$ V, $t_6 = 25$ ms, $t_8 = 5$ s, $t_f = 5$ ms. +Supply voltage $V_B = 24 \pm 0,4$ V DC + +Where the manufacturer does not require the EUT to have a direct connection to the 24 V main vehicle battery, the following pulses apply in addition: + +- pulse 1, level II (-100 V), $t_1 = 2,5$ s, 10 pulses; Supply voltage $V_A = 27 \pm 1$ V DC; +- pulse 1b, level II (-550 V), $t_1 = 2,5$ s, 10 pulses $R_i = 100 \Omega$ ; +Supply voltage $V_A = 27 \pm 1$ V DC; +- pulse 2, level II (+50 V), $t_1 = 2,5$ s, 10 pulses. Supply voltage $V_A = 27 \pm 1$ V DC. + +Where the manufacturer declares that the EUT requires a direct connection to the vehicle battery, and the corresponding tests are not carried out, this shall be stated in the test report. + +For UE and ancillary equipment designed to operate at both DC voltages and where no manual adjustments are required, the requirement 9.6.2.2 and pulse 4 from 9.6.2.1 shall apply. + +For UE designed to operate at 12 V DC power supply, but operating from a 24 V DC power adapter ancillary, then the UE shall comply with the requirements in 9.6.2.1 and the configuration of the UE and the power adapter shall comply with the requirements of 9.6.2.2. + +### 9.6.3 Performance criteria + +The performance criteria of subclause 6.2 shall apply. However, where the equipment is powered without the use of a parallel battery back-up, for pulses 1, 1a, 1b, 2 and 4 the communications link need not be maintained and may have to be re-established and volatile user data may have been lost. + +## 9.7 Voltage dips and interruptions + +The tests shall be performed on AC mains power input ports. + +These tests shall be performed on a representative configuration of the UE or a representative configuration of the combination of UE and ancillary equipment. + +### 9.7.1 Definition + +These tests assess the ability of UE and ancillary equipment to operate as intended in the event of voltage dips and interruptions present on the AC mains power input ports. + +### 9.7.2 Test method and level + +The following requirements shall apply. + +The test method shall be in accordance with IEC 61000-4-11 [24]. + +The test levels shall be: + +- a voltage dip corresponding to a reduction of the supply voltage of 60 % for 5 periods; +- a voltage interruption corresponding to a reduction of the supply voltage of > 95 % for 250 periods. + +### 9.7.3 Performance criteria + +The performance criteria of subclause 6.2 shall apply. However, in the case where the equipment is powered solely from the AC mains supply (without the use of a parallel battery back-up the communications link need not be maintained and may have to be re-established and volatile user data may have been lost. In the event of loss of the communications link or in the event of loss of user data, this fact shall be recorded in the test report, the product description and the user documentation. + +## 9.8 Surges, common and differential mode + +The tests shall be performed on AC mains power input ports. + +These tests shall be performed on a representative configuration of the UE or a representative configuration of the combination of UE and ancillary equipment. + +### 9.8.1 Definition + +These tests assess the ability of UE and ancillary equipment to operate as intended in the event of surges being present at the AC mains power input ports. + +### 9.8.2 Test method and level + +The test method shall be in accordance with IEC 61000-4-5 [22]. + +The following requirements and evaluation of test results shall apply: + +- the test level for ac mains power input ports shall be 1 kV line to ground and 0,5 kV line to line with the output impedance of the surge generator as given in the IEC 61000-4-5 [22]; +- the test generator shall provide the 1,2/50 $\mu$ sec pulse as defined in IEC 61000-4-5 [22]. + +### 9.8.3 Performance criteria + +The performance criteria of sub-clause 6.2 shall apply. + +# Annex A (normative): Performance assessment voice call. Audio break through + +## A.1 Calibration of audio levels + +For the portable the audio calibration is performed as follows: + +Set the EUT volume to provide the nominal audio level if specified by the manufacturer. If no such level is specified, the centre volume step shall be used. + +Prior to the test sequence, the reference level of the speech output signal on both the downlink and uplink shall be recorded on the test instrumentation, as shown in figure A.1. The reference level shall be equivalent to the SPL of 0 dBPa at 1 kHz at the input of the acoustical coupler described in ETR 027 [25], for the downlink, and -5dBPa at 1 kHz at the mouth reference point (MRP) defined in ITU\_T recommendation P.64 [26] for the uplink. + +NOTE 1: The MRP is defined with respect to an artificial head defined in ITU-T P 76 [27] The handset shall be mounted on the artificial head such that the ear piece is centred at the artificial ear. + +NOTE 2: If the equipment does not include acoustical transducers (e.g. a microphone or loudspeaker) the manufacturer shall specify the equivalent electrical reference levels. + +The voice processor may often apply noise and echo cancellation algorithms, which attempt to eliminate or reduce steady state audio signals as e.g., the 1 kHz calibration signals. These algorithms may be disabled during the calibration procedure. Specialised test software may be required. If the algorithms can not be disabled then the reference level shall be measured using a max-hold detection on the audio level meter in order to determine the level before the noise and echo cancellation algorithms become effective. + +In handsfree applications an external loudspeaker is used. The SPL from the external loudspeaker is normally much higher than from the earpiece of the portable in order overcome a high ambient noise level. The downlink reference level shall be increased in order to compensate for the difference. Alternatively, the distance between the loudspeaker and the measuring microphone shall be adjusted during the measurement procedure in accordance with the manufacturers specification. It is important that the dynamic range of the test instrumentation is not exceeded. + +Normally no corrections are made to the uplink reference level. In case it is not possible to perform the above calibration (e.g., a PC card with headset) the manufacturer shall specify the distance between the MRP and the microphone. + +![Figure A.1: Audio breakthrough measurement, calibration set-up for portable equipment. The diagram shows a 'Test system' connected to a 'Radio link' antenna. The 'Radio link' is connected to an 'EUT' (Device Under Test). The 'EUT' has a '1 kHz test source' connected to its 'MRP' (Mouth Reference Point) at -5 dBPa. The 'EUT' also has a 'tube' connected to its 'Transducer' at 0 dBPa. The 'Transducer' is connected to a 'BPF' (Band Pass Filter) with 'CF = 1 kHz' and 'BW = 200 Hz'. The 'BPF' is connected to an 'Audio level meter'. The 'Test system' is also connected to a 'BPF' with 'CF = 1 kHz' and 'BW = 200 Hz', which is connected to an 'Audio level meter'.](803776dff64331076ffc951fc95358ee_img.jpg) + +Figure A.1: Audio breakthrough measurement, calibration set-up for portable equipment. The diagram shows a 'Test system' connected to a 'Radio link' antenna. The 'Radio link' is connected to an 'EUT' (Device Under Test). The 'EUT' has a '1 kHz test source' connected to its 'MRP' (Mouth Reference Point) at -5 dBPa. The 'EUT' also has a 'tube' connected to its 'Transducer' at 0 dBPa. The 'Transducer' is connected to a 'BPF' (Band Pass Filter) with 'CF = 1 kHz' and 'BW = 200 Hz'. The 'BPF' is connected to an 'Audio level meter'. The 'Test system' is also connected to a 'BPF' with 'CF = 1 kHz' and 'BW = 200 Hz', which is connected to an 'Audio level meter'. + +MRP = Mouth Reference Point + +**Figure A.1: Audio breakthrough measurement, calibration set-up for portable equipment** + +NOTE: The EUT is in position during calibration of the uplink, but not during calibration of the downlink where the EUT is replaced by the 1 kHz test audio source. During calibration of the uplink the mouthpiece shall be placed with respect to the MRP in a way representing intended use. + +## A.2 Measurement of audio levels + +When the audio levels are measured during testing the EUT software shall be configured for voice applications. If the algorithms for noise and echo cancellation are not disabled, then the level shall be measured using a max-hold detection on the audio level meter in order to determine the level before the noise and echo cancellation algorithms become effective. + +The level of the output signal from the downlink speech channel of the EUT at the mobile or portable's ear piece shall be assessed by measuring the Sound Pressure Level (SPL) as shown in figure A.2. When an external loudspeaker is used the acoustical coupler shall be fixed to the loudspeaker in the position used during the calibration. The level of the decoded output signal from the uplink speech channel of the EUT at the analogue output of the test system shall be measured. Pick up of extraneous background noise by the microphone of the EUT shall be minimised. + +NOTE: If the equipment is designed for use with external transducers, they shall be included in the test configuration. If the equipment does not include acoustical transducers the line voltage developed across specified termination impedance may be measured + +![Diagram of audio breakthrough measurement test set-up for portable equipment. The setup includes an EUT inside an absorber-lined test chamber, connected to a test system and an audio level meter via a radio link and a transducer. The test system output is filtered by a BPF (CF = 1 kHz, BW = 200 Hz) before being measured by an audio level meter. The EUT is connected to a tube with an MRP seal. The transducer output is also filtered by a BPF (CF = 1 kHz, BW = 200 Hz) before being measured by an audio level meter. An EMC test signal is also shown.](4af57aad638888edf2062306f8a54a6c_img.jpg) + +The diagram illustrates the test set-up for audio breakthrough measurement. It features an EUT (Equipment Under Test) inside an absorber-lined test chamber. A radio link connects the EUT to a test system. The test system's audio output is processed through a Band Pass Filter (BPF) with a center frequency (CF) of 1 kHz and a bandwidth (BW) of 200 Hz, then measured by an audio level meter. The EUT is connected to a tube with an MRP (Mouth Reference Point) seal. A transducer is connected to the tube, and its output is also processed through a BPF (CF = 1 kHz, BW = 200 Hz) and measured by an audio level meter. An EMC test signal is also shown. + +MRP = Mouth Reference Point + +Diagram of audio breakthrough measurement test set-up for portable equipment. The setup includes an EUT inside an absorber-lined test chamber, connected to a test system and an audio level meter via a radio link and a transducer. The test system output is filtered by a BPF (CF = 1 kHz, BW = 200 Hz) before being measured by an audio level meter. The EUT is connected to a tube with an MRP seal. The transducer output is also filtered by a BPF (CF = 1 kHz, BW = 200 Hz) before being measured by an audio level meter. An EMC test signal is also shown. + +Figure A.2: Audio breakthrough measurement, test set-up for portable equipment + +# --- Annex B (normative): Performance assessment of data transfer call. Error Ratios + +## B.1 Calibration of data transfer + +For the EUT, calibration of the data transfer may be performed by assessing the Bit Error Ratio (BER), Block Error Ratio (BLER) or End- User data error ratio before applying the RF immunity test signal (defined in clauses 9.2 and 9.5). + +## --- B.2 Derivation of Error Ratios + +The manufacturer shall provide the method for calculating the Error Ratio. Known data patterns shall be transferred bi-directionally from end-to-end (the whole of the UL and DL will be exercised). Performance assessment shall be made at each frequency step. Comparison between transmitted known data and received data shall result in the Error Ratio. + +The data patterns used should be of sufficient length to give valid results and should be equivalent to the used channel bit rate. + +Possible data patterns for assessing the Error Ratio are BER, BLER and User Data. Detailed description of BER and BLER can be found from TS 34.109 [15] + +End- User Data may be used where BER and BLER measurements are not appropriate, and is a manufacturers decision (see below): + +Note: For example, in the cases when the EUT consists of UE with data application ancillary and the data application ancillary itself does not support a loopback function that can be applied for the assessment of BER or BLER, as specified in TS 34.109 [15]. This would lead into a situation where the data application ancillary is not exercised, i.e. the data transfer loop is not end-to-end. + +The characteristics of the End- User Data used for testing (format, size, typical data throughput rate, additional error corrections etc.) and the necessary test equipment shall be delivered to enable the assessment of the EUT. + +Following formula may apply to End- User Data: + +$$\text{BitErrorRatio} = \left( \frac{\text{erroneous(bits, bytes, symbols, etc.)}}{\text{correct(bits, bytes, symbols, etc.)}} * 100 \right) = n\%$$ + +(In case that high Error Ratios exist, ensure that errors are a consequence of EMC stress). + +## --- B.3 EUT without data application ancillary + +Data monitoring Devices are here considered as part of the Test System. Arrangements should be made by the manufacturer, if needed, to couple the Data monitoring Device by a method which does not affect the radiated electromagnetic field (e.g. ultra sonic or optical). + +![Figure B.1: Error Ratio assessment, test set-up for EUT without data application ancillary.](dd5771673aececa53d42ece89218299d_img.jpg) + +The diagram illustrates the test set-up for Error Ratio assessment for an EUT without data application ancillary. It features an 'Absorber lined test chamber' containing an 'EUT' (dashed box) and an 'optic coupler'. A 'Radio link' is established between a 'Test System for Data sending and receiving + BER, BLER calculation' (located outside the chamber) and the 'EUT'. An 'EMC test signal' is input to the 'EUT'. A 'Data monitoring Device (e.g. PC) \*' is connected to the 'optic coupler' via a 'Transducer'. Another 'Data monitoring Device (e.g. PC) \*' is connected to the 'Test System'. + +Figure B.1: Error Ratio assessment, test set-up for EUT without data application ancillary. + +Figure B.1: Error Ratio assessment, test set-up for EUT without data application ancillary. + +## B.4 EUT with data application ancillary + +The Data monitoring Device is here considered as a part of the Test System. The Data application ancillary should be part of the data transfer (UL and DL) loop and is included in the EUT configuration. + +![Figure B.2: Error ratio assessment, test set-up for EUT with data application ancillary.](24c9e038a791677ed33100667b64f7e6_img.jpg) + +The diagram illustrates the test set-up for Error Ratio assessment for an EUT with data application ancillary. It features an 'Absorber lined test chamber' containing an 'EUT' (dashed box) which includes a 'Data application ancillary' (dashed box). A 'Radio link' is established between a 'Test System for Data sending and receiving + BER, BLER calculation' (located outside the chamber) and the 'EUT'. An 'EMC test signal' is input to the 'EUT'. A 'Data monitoring Device (e.g. PC) \*' is connected to the 'Test System'. + +Figure B.2: Error ratio assessment, test set-up for EUT with data application ancillary. + +Figure B.2: Error ratio assessment, test set-up for EUT with data application ancillary. + +# Annex C (informative): Change History + +| TSG | Doc | CR | R | Title | Cat | New | Work Item | +|-------|-----------|------|---|----------------------------------------------------------------------------------------------------------------|-----|--------|--------------------------| +| RP-37 | | | | Rel-8 version created based on v7.5.0 | | 8.0.0 | | +| RP-37 | RP-070658 | 0027 | | Introduction of UMTS1500 requirements (Rel-8) | B | 8.0.0 | RInImp8-UMTS1500 | +| RP-39 | RP-080124 | 0030 | 1 | Introduction of UMTS700 EMC requirements | B | 8.1.0 | RInImp8-UMTS700 | +| RP-40 | RP-080384 | 0031 | 1 | Introduction of UMTS700 EMC requirements | B | 8.2.0 | RInImp8-UMTS2300TDD | +| RP-43 | RP-080197 | 0032 | | Introduction of band 1880MHz for 34.124 | F | 8.3.0 | RInImp9-UMTS1880TDD | +| RP-44 | RP-090559 | 0033 | | Introduction of Extended UMTS800 requirements | B | 9.0.0 | RInImp9-UMTSLTE800 | +| RP-46 | RP-091286 | 034 | | Introduction of Extended UMTS1500 requirements for TS34.124 (Technically endorsed at RAN 4 52bis in R4-093629) | B | 9.1.0 | UMTSLTE1500 | +| RP-47 | RP-100263 | 36 | | Introduction of Band XX in 34.124 | B | 9.2.0 | RInImp9-UMTSLTE800EU | +| SP-51 | | | | Upgraded unchanged from Rel-9 | | 10.0.0 | | +| RP-52 | RP-110804 | 039 | | Add Expanded 1900 MHz Band for UTRA and LTE to TS34.124 (Rel-10) | B | 10.1.0 | E1900_UB-Core | +| RP-53 | RP-111255 | 042 | | Add Band 22/XXII for LTE/UMTS 3500 (FDD) to TS 34.124 | B | 10.2.0 | RInImp8-UMTSLTE3500 | +| RP-55 | RP-120305 | 043 | | Add Extending 850 MHz Upper Band (814 - 849 MHz) to TS34.124 | B | 11.0.0 | e850_UB-Core | +| RP-64 | RP-140926 | 046 | | Introduction of operating band XXXII in TS34.124 | B | 12.0.0 | LTE_UTRA_SDL_Band L-Core | +| SP-70 | - | - | - | Update to Rel-13 version (MCC) | - | 13.0.0 | | +| RP-75 | - | - | - | Update to Rel-14 version (MCC) | - | 14.0.0 | | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-06 | SA#80 | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2020-06 | SA#88 | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-03 | SA#95 | | | | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2022-06 | RAN#96 | RP-221654 | 0047 | | F | CR to TS 34.124: corrections of the UTRA UE EMC specification, Rel-17 | 17.1.0 | +| 2024-03 | RAN#103 | | | | | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/34_series/34131/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/marked/Rel-18/34_series/34131/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ddf9dccd0f896500a36309c9e4021a02d2f32162 --- /dev/null +++ b/marked/Rel-18/34_series/34131/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:acfe83ada4606bb66f7cd31e3c64980cd56bd168989be91d390dd286c4cc3fd8 +size 7653 diff --git a/marked/Rel-18/34_series/34131/64662465bba247703fdec49c8f3309f9_img.jpg b/marked/Rel-18/34_series/34131/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9dbf951e7be7ac43d98bf254124e839265b7480b --- /dev/null +++ b/marked/Rel-18/34_series/34131/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bd0d5a925271b8c7ed24378cd0fdb17eb2e1417edcaf810ff7bb946ca4568a05 +size 5673 diff --git a/marked/Rel-18/34_series/34131/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/marked/Rel-18/34_series/34131/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..de8d923853eadc3e79f1079bef4d14b4cf805e04 --- /dev/null +++ b/marked/Rel-18/34_series/34131/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1dedd562d76b57baffd1edfae7c0ee0f643793dfebe2b17007a54faa3d0b7796 +size 64746 diff --git a/marked/Rel-18/34_series/34131/raw.md b/marked/Rel-18/34_series/34131/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..366a89c89948075707543bd2b1913320ccb26646 --- /dev/null +++ b/marked/Rel-18/34_series/34131/raw.md @@ -0,0 +1,5649 @@ + + +# 3GPP TS 34.131 V18.0.0 (2024-04) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Test Specification for C-language binding to (Universal) Subscriber Interface Module ((U)SIM) Application Programming Interface (API) (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal wave icon at its base. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +--- + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|-------------------------------------------|----| +| Foreword ..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions and Acronyms ..... | 12 | +| 3.1 Definitions..... | 12 | +| 3.2 Acronyms ..... | 12 | +| 4 Test Environment..... | 13 | +| 4.1 Applicability..... | 13 | +| 4.2 Test Environment Description ..... | 13 | +| 4.3 Test Format ..... | 14 | +| 4.3.1 Test Area Reference ..... | 14 | +| 4.3.1.1 Conformance Requirements ..... | 14 | +| 4.3.1.2 Test Area Files ..... | 15 | +| 4.3.1.3 Test Procedure ..... | 15 | +| 4.3.1.4 Test Coverage ..... | 15 | +| 4.4 Initial Conditions..... | 15 | +| 4.5 Test Equipment ..... | 15 | +| 4.5.1 APDU Tool..... | 15 | +| 4.6 Testing Methodology ..... | 16 | +| 4.6.1 Test Interfaces and Facilities..... | 16 | +| 5 Test Plan..... | 16 | +| 6 API Test Plan ..... | 16 | +| 6.1 UICC File Store Access ..... | 16 | +| 6.1.1 CatSelect..... | 16 | +| 6.1.1.1 Conformance Requirements ..... | 16 | +| 6.1.1.2 Test Procedure ..... | 17 | +| 6.1.1.3 Test Coverage ..... | 18 | +| 6.1.2 CatStatus..... | 18 | +| 6.1.2.1 Conformance Requirements ..... | 18 | +| 6.1.2.2 Test Procedure ..... | 18 | +| 6.1.2.3 Test Coverage ..... | 19 | +| 6.1.3 CatGetCHVStatus..... | 19 | +| 6.1.3.1 Conformance Requirements ..... | 19 | +| 6.1.3.2 Test Procedure ..... | 19 | +| 6.1.3.3 Test Coverage ..... | 19 | +| 6.1.4 CatReadBinary ..... | 19 | +| 6.1.4.1 Conformance Requirements ..... | 20 | +| 6.1.4.2 Test Procedure ..... | 20 | +| 6.1.4.3 Test Coverage ..... | 21 | +| 6.1.5 CatUpdateBinary ..... | 21 | +| 6.1.5.1 Conformance Requirements ..... | 21 | +| 6.1.5.2 Test Procedure ..... | 22 | +| 6.1.5.3 Test Coverage ..... | 22 | +| 6.1.6 CatReadRecord..... | 23 | +| 6.1.6.1 Conformance Requirements ..... | 23 | +| 6.1.6.2 Test Procedure ..... | 24 | +| 6.1.6.3 Test Coverage ..... | 26 | +| 6.1.7 CatUpdateRecord ..... | 26 | +| 6.1.7.1 Conformance Requirements ..... | 26 | +| 6.1.7.2 Test Procedure ..... | 27 | +| 6.1.7.3 Test Coverage ..... | 29 | +| 6.1.8 CatSearch..... | 29 | +| 6.1.8.1 Conformance Requirements ..... | 29 | + +| | | | +|----------|---------------------------------|----| +| 6.1.8.2 | Test Procedure ..... | 30 | +| 6.1.8.3 | Test Coverage ..... | 31 | +| 6.1.9 | CatIncrease ..... | 31 | +| 6.1.9.1 | Conformance Requirements ..... | 31 | +| 6.1.9.2 | Test Procedure ..... | 32 | +| 6.1.9.3 | Test Coverage ..... | 33 | +| 6.1.10 | CatInvalidate..... | 33 | +| 6.1.10.1 | Conformance Requirements ..... | 33 | +| 6.1.10.2 | Test Procedure ..... | 33 | +| 6.1.10.3 | Test Coverage ..... | 34 | +| 6.1.11 | CatRehabilitate ..... | 34 | +| 6.1.11.1 | Conformance Requirements ..... | 34 | +| 6.1.11.2 | Test Procedure ..... | 35 | +| 6.1.11.3 | Test Coverage ..... | 35 | +| 6.2 | Registry ..... | 35 | +| 6.2.1 | CatSetMenuString ..... | 35 | +| 6.2.1.1 | Conformance Requirements ..... | 35 | +| 6.2.1.2 | Test Procedure ..... | 35 | +| 6.2.1.3 | Test Coverage ..... | 36 | +| 6.2.2 | CatNotifyOnFrameworkEvent ..... | 36 | +| 6.2.2.1 | Conformance Requirements ..... | 36 | +| 6.2.2.2 | Test Suite Files..... | 36 | +| 6.2.2.3 | Test Procedure ..... | 36 | +| 6.2.2.4 | Test Coverage ..... | 37 | +| 6.2.3 | CatNotifyOnEnvelope ..... | 37 | +| 6.2.3.1 | Conformance Requirements ..... | 37 | +| 6.2.3.2 | Test Procedure ..... | 37 | +| 6.2.3.3 | Test Coverage ..... | 37 | +| 6.2.4 | CatNotifyOnEvent ..... | 37 | +| 6.2.4.1 | Conformance Requirements ..... | 37 | +| 6.2.4.2 | Test Procedure ..... | 38 | +| 6.2.4.3 | Test Coverage ..... | 38 | +| 6.3 | Man-Machine Interface..... | 38 | +| 6.3.1 | CatAddItem ..... | 38 | +| 6.3.1.1 | Conformance Requirements ..... | 38 | +| 6.3.1.2 | Test Procedure ..... | 38 | +| 6.3.1.3 | Test Coverage ..... | 39 | +| 6.3.2 | CatSelectItem ..... | 39 | +| 6.3.2.1 | Conformance Requirements ..... | 39 | +| 6.3.2.2 | Test Procedure ..... | 39 | +| 6.3.2.3 | Test Coverage ..... | 39 | +| 6.3.3 | CatEndSelectItem ..... | 39 | +| 6.3.3.1 | Conformance Requirements ..... | 39 | +| 6.3.3.2 | Test Procedure ..... | 40 | +| 6.3.3.3 | Test Coverage ..... | 40 | +| 6.3.4 | CatDisplayText..... | 40 | +| 6.3.4.1 | Conformance Requirements ..... | 40 | +| 6.3.4.2 | Test Procedure ..... | 41 | +| 6.3.4.3 | Test Coverage ..... | 41 | +| 6.3.5 | CatGetInKey ..... | 41 | +| 6.3.5.1 | Conformance Requirements ..... | 41 | +| 6.3.5.2 | Test Procedure ..... | 42 | +| 6.3.5.3 | Test Coverage ..... | 42 | +| 6.3.6 | CatGetInput ..... | 42 | +| 6.3.6.1 | Conformance Requirements ..... | 42 | +| 6.3.6.2 | Test Procedure ..... | 43 | +| 6.3.6.3 | Test Coverage ..... | 43 | +| 6.3.7 | CatSetupIdleModeText..... | 43 | +| 6.3.7.1 | Conformance Requirements ..... | 43 | +| 6.3.7.2 | Test Procedure ..... | 44 | +| 6.3.7.3 | Test Coverage ..... | 44 | +| 6.3.8 | CatPlayTone ..... | 44 | + +| | | | +|---------|-------------------------------------------|----| +| 6.3.8.1 | Conformance Requirements ..... | 44 | +| 6.3.8.2 | Test Procedure ..... | 44 | +| 6.3.8.3 | Test Coverage ..... | 45 | +| 6.4 | Timers..... | 45 | +| 6.4.1 | CatGetTimer ..... | 45 | +| 6.4.1.1 | Conformance Requirements ..... | 45 | +| 6.4.1.2 | Test Procedure ..... | 45 | +| 6.4.1.3 | Test Coverage ..... | 45 | +| 6.4.2 | CatFreeTimer..... | 45 | +| 6.4.2.1 | Conformance Requirements ..... | 45 | +| 6.4.2.2 | Test Procedure ..... | 46 | +| 6.4.2.3 | Test Coverage ..... | 46 | +| 6.4.3 | CatStartTimer ..... | 46 | +| 6.4.3.1 | Conformance Requirements ..... | 46 | +| 6.4.3.2 | Test Procedure ..... | 46 | +| 6.4.3.3 | Test Coverage ..... | 47 | +| 6.4.4 | CatGetTimerValue ..... | 47 | +| 6.4.4.1 | Conformance Requirements ..... | 47 | +| 6.4.4.2 | Test Procedure ..... | 47 | +| 6.4.4.3 | Test Coverage ..... | 47 | +| 6.5 | Supplementary Card Reader Management..... | 47 | +| 6.5.1 | CatPowerOnCard..... | 47 | +| 6.5.1.1 | Conformance Requirements ..... | 48 | +| 6.5.1.2 | Test Procedure ..... | 48 | +| 6.5.1.3 | Test Coverage ..... | 48 | +| 6.5.2 | CatPowerOffCard..... | 48 | +| 6.5.2.1 | Conformance Requirements ..... | 48 | +| 6.5.2.2 | Test Procedure ..... | 49 | +| 6.5.2.3 | Test Coverage ..... | 49 | +| 6.5.3 | CatPerformCardAPDU ..... | 49 | +| 6.5.3.1 | Conformance Requirements ..... | 49 | +| 6.5.3.2 | Test Procedure ..... | 49 | +| 6.5.3.3 | Test Coverage ..... | 50 | +| 6.5.4 | CatGetReaderStatus..... | 50 | +| 6.5.4.1 | Conformance Requirements ..... | 50 | +| 6.5.4.2 | Test Procedure ..... | 50 | +| 6.5.4.3 | Test Coverage ..... | 50 | +| 6.6 | Network Services ..... | 50 | +| 6.6.1 | CatGetLocationInformation ..... | 50 | +| 6.6.1.1 | Conformance Requirements ..... | 51 | +| 6.6.1.2 | Test Procedure ..... | 51 | +| 6.6.1.3 | Test Coverage ..... | 51 | +| 6.6.2 | CatGetTimingAdvance..... | 51 | +| 6.6.2.1 | Conformance Requirements ..... | 51 | +| 6.6.2.2 | Test Procedure ..... | 52 | +| 6.6.2.3 | Test Coverage ..... | 52 | +| 6.6.3 | CatGetIMEI ..... | 52 | +| 6.6.3.1 | Conformance Requirements ..... | 52 | +| 6.6.3.2 | Test Procedure ..... | 52 | +| 6.6.3.3 | Test Coverage ..... | 53 | +| 6.6.4 | CatGetNetworkMeasurementResults ..... | 53 | +| 6.6.4.1 | Conformance Requirements ..... | 53 | +| 6.6.4.2 | Test Procedure ..... | 53 | +| 6.6.4.3 | Test Coverage ..... | 53 | +| 6.6.5 | CatGetDateTimeAndTimeZone ..... | 53 | +| 6.6.5.1 | Conformance Requirements ..... | 53 | +| 6.6.5.2 | Test Procedure ..... | 54 | +| 6.6.5.3 | Test Coverage ..... | 54 | +| 6.6.6 | CatGetLanguage ..... | 54 | +| 6.6.6.1 | Conformance Requirements ..... | 54 | +| 6.6.6.2 | Test Procedure ..... | 55 | +| 6.6.6.3 | Test Coverage ..... | 55 | + +| | | | +|----------|--------------------------------|----| +| 6.6.7 | CatSetupCall..... | 55 | +| 6.6.7.1 | Conformance Requirements ..... | 55 | +| 6.6.7.2 | Test Procedure ..... | 55 | +| 6.6.7.3 | Test Coverage ..... | 56 | +| 6.6.8 | CatSendShortMessage..... | 56 | +| 6.6.8.1 | Conformance Requirements ..... | 56 | +| 6.6.8.2 | Test Procedure ..... | 56 | +| 6.6.8.3 | Test Coverage ..... | 56 | +| 6.6.9 | CatSendSS ..... | 57 | +| 6.6.9.1 | Conformance Requirements ..... | 57 | +| 6.6.9.2 | Test Procedure ..... | 57 | +| 6.6.9.3 | Test Coverage ..... | 57 | +| 6.6.10 | CatSendUSSD ..... | 57 | +| 6.6.10.1 | Conformance Requirements ..... | 57 | +| 6.6.10.2 | Test Procedure ..... | 58 | +| 6.6.10.3 | Test Coverage ..... | 58 | +| 6.6.11 | CatOpenCSChannel..... | 58 | +| 6.6.11.1 | Conformance Requirements ..... | 58 | +| 6.6.11.2 | Test Procedure ..... | 59 | +| 6.6.11.3 | Test Coverage ..... | 59 | +| 6.6.12 | CatOpenGPRSChannel..... | 59 | +| 6.6.12.1 | Conformance Requirements ..... | 59 | +| 6.6.12.2 | Test Procedure ..... | 59 | +| 6.6.12.3 | Test Coverage ..... | 60 | +| 6.6.13 | CatCloseChannel..... | 60 | +| 6.6.13.1 | Conformance Requirements ..... | 60 | +| 6.6.13.2 | Test Procedure ..... | 60 | +| 6.6.13.3 | Test Coverage ..... | 60 | +| 6.6.14 | CatReceiveData ..... | 60 | +| 6.6.14.1 | Conformance Requirements ..... | 60 | +| 6.6.14.2 | Test Procedure ..... | 61 | +| 6.6.14.3 | Test Coverage ..... | 61 | +| 6.6.15 | CatSendData ..... | 61 | +| 6.6.15.1 | Conformance Requirements ..... | 61 | +| 6.6.15.2 | Test Procedure ..... | 62 | +| 6.6.15.3 | Test Coverage ..... | 62 | +| 6.6.16 | CatGetChannelStatus..... | 62 | +| 6.6.16.1 | Conformance Requirements ..... | 62 | +| 6.6.16.2 | Test Procedure ..... | 62 | +| 6.6.16.3 | Test Coverage ..... | 63 | +| 6.6.17 | CatServiceSearch..... | 63 | +| 6.6.17.1 | Conformance Requirements ..... | 63 | +| 6.6.17.2 | Test Procedure ..... | 63 | +| 6.6.17.3 | Test Coverage ..... | 64 | +| 6.6.18 | CatGetServiceInformation..... | 64 | +| 6.6.18.1 | Conformance Requirements ..... | 64 | +| 6.6.18.2 | Test Procedure ..... | 64 | +| 6.6.18.3 | Test Coverage ..... | 65 | +| 6.6.19 | CatDeclareService..... | 65 | +| 6.6.19.1 | Conformance Requirements ..... | 65 | +| 6.6.19.2 | Test Procedure ..... | 66 | +| 6.6.19.3 | Test Coverage ..... | 66 | +| 6.6.20 | CatRunATCommand..... | 66 | +| 6.6.20.1 | Conformance Requirements ..... | 66 | +| 6.6.20.2 | Test Procedure ..... | 67 | +| 6.6.20.3 | Test Coverage ..... | 67 | +| 6.6.21 | CatSendDTMFCommand..... | 67 | +| 6.6.21.1 | Conformance Requirements ..... | 67 | +| 6.6.21.2 | Test Procedure ..... | 68 | +| 6.6.21.3 | Test Coverage ..... | 68 | +| 6.7 | Toolkit Application ..... | 68 | +| 6.7.1 | main ..... | 68 | + +| | | | +|---------|------------------------------------|----| +| 6.7.1.1 | Conformance Requirements ..... | 68 | +| 6.7.1.2 | Test Procedure ..... | 69 | +| 6.7.1.3 | Test Coverage ..... | 69 | +| 6.7.2 | CatGetFrameworkEvent ..... | 69 | +| 6.7.2.1 | Conformance Requirements ..... | 69 | +| 6.7.2.2 | Test Procedure ..... | 69 | +| 6.7.2.3 | Test Coverage ..... | 69 | +| 6.7.3 | CatExit ..... | 70 | +| 6.7.3.1 | Conformance Requirements ..... | 70 | +| 6.7.3.2 | Test Procedure ..... | 70 | +| 6.7.3.3 | Test Coverage ..... | 70 | +| 6.8 | Miscellaneous ..... | 70 | +| 6.8.1 | CatGetTerminalProfile ..... | 70 | +| 6.8.1.1 | Conformance Requirements ..... | 70 | +| 6.8.1.2 | Test Procedure ..... | 71 | +| 6.8.1.3 | Test Coverage ..... | 71 | +| 6.8.2 | CatMoreTime ..... | 71 | +| 6.8.2.1 | Conformance Requirements ..... | 71 | +| 6.8.2.2 | Test Procedure ..... | 71 | +| 6.8.2.3 | Test Coverage ..... | 72 | +| 6.8.3 | CatPollingOff ..... | 72 | +| 6.8.3.1 | Conformance Requirements ..... | 72 | +| 6.8.3.2 | Test Procedure ..... | 72 | +| 6.8.3.3 | Test Coverage ..... | 72 | +| 6.8.4 | CatPollInterval ..... | 72 | +| 6.8.4.1 | Conformance Requirements ..... | 72 | +| 6.8.4.2 | Test Procedure ..... | 73 | +| 6.8.4.3 | Test Coverage ..... | 73 | +| 6.8.5 | CatRefresh ..... | 73 | +| 6.8.5.1 | Conformance Requirements ..... | 73 | +| 6.8.5.2 | Test Procedure ..... | 74 | +| 6.8.5.3 | Test Coverage ..... | 74 | +| 6.8.6 | CatLanguageNotification ..... | 74 | +| 6.8.6.1 | Conformance Requirements ..... | 74 | +| 6.8.6.2 | Test Procedure ..... | 74 | +| 6.8.6.3 | Test Coverage ..... | 75 | +| 6.8.7 | CatLaunchBrowser ..... | 75 | +| 6.8.7.1 | Conformance Requirements ..... | 75 | +| 6.8.7.2 | Test Procedure ..... | 75 | +| 6.8.7.3 | Test Coverage ..... | 76 | +| 6.9 | Low-Level Interface ..... | 76 | +| 6.9.1 | CatResetBuffer ..... | 76 | +| 6.9.1.1 | Conformance Requirements ..... | 76 | +| 6.9.1.2 | Test Procedure ..... | 76 | +| 6.9.1.3 | Test Coverage ..... | 76 | +| 6.9.2 | CatStartProactiveCommand ..... | 76 | +| 6.9.2.1 | Conformance Requirements ..... | 76 | +| 6.9.2.2 | Test Procedure ..... | 77 | +| 6.9.2.3 | Test Coverage ..... | 77 | +| 6.9.3 | CatSendProactiveCommand ..... | 77 | +| 6.9.3.1 | Conformance Requirements ..... | 77 | +| 6.9.3.2 | Test Procedure ..... | 78 | +| 6.9.3.3 | Test Coverage ..... | 78 | +| 6.9.4 | CatOpenEnvelope ..... | 78 | +| 6.9.4.1 | Conformance Requirements ..... | 78 | +| 6.9.4.2 | Test Procedure ..... | 78 | +| 6.9.4.3 | Test Coverage ..... | 79 | +| 6.9.5 | CatSendEnvelopeResponse ..... | 79 | +| 6.9.5.1 | Conformance Requirements ..... | 79 | +| 6.9.5.2 | Test Procedure ..... | 79 | +| 6.9.5.3 | Test Coverage ..... | 80 | +| 6.9.6 | CatSendEnvelopeErrorResponse ..... | 80 | + +| | | | +|-----------------------------|--------------------------------------------------------------|-----------| +| 6.9.6.1 | Conformance Requirements ..... | 80 | +| 6.9.6.2 | Test Procedure ..... | 80 | +| 6.9.6.3 | Test Coverage ..... | 80 | +| 6.9.7 | CatPutData..... | 80 | +| 6.9.7.1 | Conformance Requirements ..... | 81 | +| 6.9.7.2 | Test Procedure ..... | 81 | +| 6.9.7.3 | Test Coverage ..... | 81 | +| 6.9.8 | CatPutByte..... | 81 | +| 6.9.8.1 | Conformance Requirements ..... | 82 | +| 6.9.8.2 | Test Procedure ..... | 82 | +| 6.9.8.3 | Test Coverage ..... | 82 | +| 6.9.9 | CatPutTLV ..... | 82 | +| 6.9.9.1 | Conformance Requirements ..... | 82 | +| 6.9.9.2 | Test Procedure ..... | 83 | +| 6.9.9.3 | Test Coverage ..... | 83 | +| 6.9.10 | CatPutBytePrefixedTLV ..... | 83 | +| 6.9.10.1 | Conformance Requirements ..... | 83 | +| 6.9.10.2 | Test Procedure ..... | 83 | +| 6.9.10.3 | Test Coverage ..... | 84 | +| 6.9.11 | CatPutOneByteTLV ..... | 84 | +| 6.9.11.1 | Conformance Requirements ..... | 84 | +| 6.9.11.2 | Test Procedure ..... | 84 | +| 6.9.11.3 | Test Coverage ..... | 85 | +| 6.9.12 | CatPutTwoByteTLV..... | 85 | +| 6.9.12.1 | Conformance Requirements ..... | 85 | +| 6.9.12.2 | Test Procedure ..... | 85 | +| 6.9.12.3 | Test Coverage ..... | 85 | +| 6.9.13 | CatGetByte ..... | 85 | +| 6.9.13.1 | Conformance Requirements ..... | 85 | +| 6.9.13.2 | Test Procedure ..... | 86 | +| 6.9.13.3 | Test Coverage ..... | 86 | +| 6.9.14 | CatGetData ..... | 86 | +| 6.9.14.1 | Conformance Requirements ..... | 86 | +| 6.9.14.2 | Test Procedure ..... | 86 | +| 6.9.14.3 | Test Coverage ..... | 87 | +| 6.9.15 | CatFindNthTLV ..... | 87 | +| 6.9.15.1 | Conformance Requirements ..... | 87 | +| 6.9.15.2 | Test Procedure ..... | 87 | +| 6.9.15.3 | Test Coverage ..... | 88 | +| 6.9.16 | CatFindNthTLVInUserBuffer ..... | 88 | +| 6.9.16.1 | Conformance Requirements ..... | 88 | +| 6.9.16.2 | Test Procedure ..... | 89 | +| 6.9.16.3 | Test Coverage ..... | 89 | +| Annex A (normative): | Script file syntax and format description..... | 90 | +| A.1 | Syntax description..... | 90 | +| A.2 | Semantics ..... | 91 | +| A.3 | Example ..... | 91 | +| A.4 | Style and formatting ..... | 92 | +| Annex B (normative): | Default Prepersionalisation ..... | 93 | +| B.1 | General Default Prepersionalisation ..... | 93 | +| B.2 | File System Access Default Prepersionalisation..... | 94 | +| B.2.1 | DF SIMTEST (SIM Test) ..... | 94 | +| B.2.2 | EF TNR (Transparent Never Read) ..... | 94 | +| B.2.3 | EF TNU (Transparent Never Update)..... | 94 | +| B.2.4 | EF TARU (Transparent Always Read and Update)..... | 94 | +| B.2.5 | EF CNR (Cyclic Never Read)..... | 95 | +| B.2.6 | EF CNU (Cyclic Never Update) ..... | 95 | + +| | | | +|-------------------------------|------------------------------------------------------------------------|------------| +| B.2.7 | EF CNIC (Cyclic Never Increase)..... | 95 | +| B.2.8 | EF CNIV (Cyclic Never Invalidate)..... | 96 | +| B.2.9 | EF CNRH (Cyclic Never Rehabilitate)..... | 96 | +| B.2.10 | EF CARU (Cyclic Always Read and Update)..... | 96 | +| B.2.11 | EF LNR (Linear Fixed Never Read)..... | 97 | +| B.2.12 | EF LNU (Linear Fixed Never Update) ..... | 97 | +| B.2.13 | EF LARU (Linear Fixed Always Read and Update) ..... | 97 | +| B.2.14 | EF CINA (Cyclic Increase Not Allowed)..... | 98 | +| B.2.15 | EF TRAC (Transparent Read Access Condition CHV2) ..... | 98 | +| B.2.16 | EF TIAC (Transparent Invalidate Access Condition CHV1)..... | 98 | +| B.2.17 | EF CIAC (Cyclic Increase Access Condition CHV2)..... | 99 | +| B.2.18 | EF CIAA (Cyclic Increase Access Condition ADM)..... | 99 | +| B.2.19 | EF CNRI (Cyclic Never Rehabilitate Invalidated)..... | 99 | +| Annex C (informative): | Change history..... | 100 | + +--- + +## Foreword + +This Technical Specification has been produced by the 3GPP. + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of this TS, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater Indicates TSG approved document under change control. +- Y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +--- + +# 1 Scope + +The present document describes the technical characteristics and methods of test for testing the SIM API for the C programming language 3GPP TS 31.131 [11] implemented in the subscriber identity modules for GSM and 3G networks. It specifies the following parts: + +- test applicability +- test environment description +- tests format +- test area reference +- conformance requirements +- test suite files +- test procedure +- test coverage and, +- a description of the associated testing tools that may be used. + +--- + +# 2 References + +The following documents contain provisions, which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 31.111: "3rd Generation Partnership Project; Technical Specification Group; USIM Application Toolkit (USAT)". +- [3] 3GPP TS 23.048: "3rd Generation Partnership Project; Technical Specification Group Terminals; Security Mechanisms for the SIM application toolkit". +- [4] 3GPP TS 42.019: "3rd Generation Partnership Project; Technical Specification Group Terminals; Subscriber Identity Module Application Programming Interface (SIM API); Stage 1". +- [5] ISO 639 (1988): "Code for the representation of names of languages". +- [6] 3GPP TS 23.038: "Alphabets and language-specific information". +- [7] ISO/IEC 9899 Second Edition 1999-12-01: "Programming Languages – C". +- [8] 3GPP TS 11.14: "Specification of the SIM Application Toolkit for the Subscriber Identity Module – Mobile Equipment (SIM – ME) interface" version 4.0.0 Release 4. +- [9] Tool Interface Standard (TIS) Executable and Linking Format Specification Version 1.2 +- [10] SYSTEM V Application Binary Interface, Edition 4.1 +- [11] 3GPP TS 31.131 V1.1.2: "'C'-language binding to (U)SIM API". + +- [12] GSM 11.10-1: "Digital cellular telecommunication system (Phase 2+); Mobile Station (MS) conformance specification; Part 1: Conformance specification". +- [13] 3GPP TS 51.011: "Specification of the Subscriber Identity Module – Mobile Equipment (SIM-ME) interface". +- [14] ETSI TS 102.221: "UICC-Terminal interface; Physical and logical characteristics". +- [15] ETSI TS 102.226: "Remote APDU Structure for UICC based Applications." + +--- + +## 3 Definitions and Acronyms + +### 3.1 Definitions + +The definitions specified in GSM 11.10-1 [12] shall apply, unless otherwise specified in the present clause. + +**Application:** A computer program that defines and implements a useful domain-specific functionality. The term may apply to the functionality itself, to the representation of the functionality in a programming language, or to the realization of the functionality as executable code. + +**Application Executable:** The representation of an application as collection of executable codes. + +**Application Program:** The representation of an application in a programming language such as assembly language, C, Java, WML or XHTML. + +**Application Programming Interface:** A collection of entry points and data structures that an application program can access when translated into an application executable. + +**Byte Code:** A processor-independent representation of a basic computer operation such as "increment by one" that is executed by computer program called a byte code interpreter. + +**Data Structure:** A memory address that can be accessed by an application executable in order to read or write data. + +**Entry Point:** A memory address that can be branched to by an application executable in order to access functionality defined by an application-programming interface. Depending on the software technology, an entry point is also called a subroutine, a function or a method. + +**Executable Code:** The generic term for either byte code or native code. + +**Framework :** A framework defines a set of Application Programming Interface (API) functions for developing applications and for providing system services to those applications. + +**Native Code:** A processor-dependent representation of a basic computer operation such as "increment by one" that is executed by the hardware circuitry of a computer's central processing unit. + +**Null Operation:** A computer operation that accomplishes nothing. Abbreviated as NOP and pronounced "No Op". + +**Toolkit Application:** An application that uses the commands described in [2]. + +### 3.2 Acronyms + +For the purpose of the present document, the following abbreviations apply: + +| | | +|------|-----------------------------------| +| AC | Application Code | +| AID | Application Identifier | +| APDU | Application Protocol Data Unit | +| API | Application Programming Interface | +| CAD | Card Acceptance Device | +| CPDU | Command Protocol Data Unit | +| CAT | Card Application Toolkit | +| DF | Dedicated File | + +| | | +|------|-----------------------------------------| +| DTMF | Dual Tone Multiple Frequency | +| EF | Elementary File | +| FID | File Identifier | +| GSM | Global System for Mobile communications | +| IFD | Interface Device | +| NOP | Null Operation | +| ME | Mobile Equipment | +| NVM | Non-Volatile Memory | +| ROM | Read-Only Memory | +| SE | Sending Entity | +| SIM | Subscriber Identity Module | +| SMS | Short Message Service | +| STK | SIM ToolKit | +| TLV | Tag, Length, Value | +| TPDU | Transport Protocol Data Unit | +| UICC | (not an acronym) | +| URL | Uniform Resource Locator | +| USIM | Universal Subscriber Interface Module | + +--- + +## 4 Test Environment + +This clause specifies requirements that shall be met and the testing rules that shall be followed during the test procedure. + +### 4.1 Applicability + +The tests defined in this specification shall be performed taking into account the services supported by the card as specified in the EFSST file. + +The tests can be performed with either C source code files (.c) or with ELF loadfiles (.elf). + +### 4.2 Test Environment Description + +The C SIM API test specification covers applications that are linked into the smart card mask and stored in read-only memory as well as applications that are loaded into read/write memory after it has been manufactured. The C SIM API test specification also covers applications whose executable form is either as byte codes or as native codes. + +The general architecture for the test environment is given in the following diagram: + +![Diagram illustrating the test execution flow. At the top, 'Application as C Source Code' is processed through 'Compile' and 'Load and Link' steps, or directly through 'Compile, Link and Load'. The resulting application is loaded into a 'Test Harness'. The 'Test Harness' interacts with the 'Application', which in turn interacts with the 'C (U)SIM API'. The 'C (U)SIM API' interacts with 'Input/Output including Proactive Command Services' and the 'File System'. The 'Test Harness' receives 'Test' input and produces 'Test Result' output.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +graph TD + A[Application as C Source Code] --> B[Compile] + A --> C[Compile, Link and Load] + B --> D[Load and Link] + D --> E[Application] + C --> E + E --> F[C (U)SIM API] + F --> G[Input/Output including Proactive Command Services] + F --> H[File System] + I[Test] --> J[Test Harness] + J --> K[Test Result] + J --> E + E --> F + F --> G + F --> H + +``` + +Diagram illustrating the test execution flow. At the top, 'Application as C Source Code' is processed through 'Compile' and 'Load and Link' steps, or directly through 'Compile, Link and Load'. The resulting application is loaded into a 'Test Harness'. The 'Test Harness' interacts with the 'Application', which in turn interacts with the 'C (U)SIM API'. The 'C (U)SIM API' interacts with 'Input/Output including Proactive Command Services' and the 'File System'. The 'Test Harness' receives 'Test' input and produces 'Test Result' output. + +## 4.3 Test Format + +### 4.3.1 Test Area Reference + +Each test area is referenced as follows: + +API: API Testing: 'API\_[entry point name]' where + +entry point name: + +API entry point defined in 3GPP TS 31.131 [11] + +#### 4.3.1.1 Conformance Requirements + +The conformance requirements are expressed in the following way: + +- Entry point prototype as listed in 3GPP TS 31.131 [11] specification. +- Normal execution: + - Contains normal execution and correct parameters limit values, each referenced as a Conformance Requirement Reference Normal (CRRN) +- Parameters error: + - Contains parameter errors and incorrect parameter limit values, each referenced as a Conformance Requirement Reference Parameter Error (CRRP) +- Context error: + +- Contains errors due to the context the entry point is used in, each referenced as a Conformance Requirement Reference Context Error (CRRCE) + +#### 4.3.1.2 Test Area Files + +The test area contains the source code of a program that translates the test procedure found in each section below into C test application program (.c) and an APDU Tool test script (.s). A test is conducted by compiling the C program, installing it on the UICC, and running the associated test script. + +The test area also contains the C header files that are referenced by the output of the translator. The test scripts must be processed through a C pre-processor [7] before they are provided to the APDU Tool. + +#### 4.3.1.3 Test Procedure + +Each test procedure contains pseudo-code that describes the test together with the expected responses from the API and the expected command and response APDU traffic. The test procedure may be translated into a C test application program and APDU Tool test script using the program in the Test Area + +#### 4.3.1.4 Test Coverage + +The table at the end of each test procedure indicates the correspondence between the Conformance Requirements Reference (CRR) and the different test cases. + +### 4.4 Initial Conditions + +The Initial Conditions are a set of general prerequisites for the (U)SIM prior to the execution of testing. For each test procedure described in this document, the following rules apply to the Initial Conditions: + +- unless otherwise stated, the file system and the files' content shall fulfil the requirements described in the "Default Preparation" paragraph at the time of running the test with test number 1; +- unless otherwise stated, tests with test number 1 through i have been successfully executed before the test with test number i+1 is executed. + +When both statements apply, a test procedure is said to be in the "Default Initial Conditions" state. + +### 4.5 Test Equipment + +These subclauses recommend a minimum specification for each of the items of test equipment referenced in the tests. + +#### 4.5.1 APDU Tool + +This test tool shall meet the following requirements: + +- be able to send commands to the card TPDU; +- be able to check none, only a part, or all of the data returned; +- be able to check none, only part, or all of the status returned; +- be able to accept all valid status codes returned; +- be able to support CAD commands; +- be able to generate a log file for each test execution. +- if more data is returned than defined in the test specification the event shall be noted in the log and the tool shall continue; +- if less data is returned than defined in the test specification the event shall be noted in the log and the tool shall continue; + +- if there is an error in data or status returned the event shall be noted in the log and the tool shall continue. + +The log file produced by the test tool shall include the following information: + +- all commands issued; +- all data returned; +- all status returned; +- all errors codes; +- expected data and status in case of error; +- comments from the scripts; + +a log message to report success or failure of the test; + +transmission error events including anomalies in returned data; + +## 4.6 Testing Methodology + +### 4.6.1 Test Interfaces and Facilities + +The SIM-ME interface provides the main transport interface for the purpose of performing conformance tests. + +The SIM API interface provides the main test interface for the purpose of performing conformance tests. + +--- + +## 5 Test Plan + +The test plan is divided according to the entry point sections of 3GPP TS 31.131 [11] although the sections of the test plan do not appear in the same order as the corresponding sections in TS 31.131 [11]. + +--- + +## 6 API Test Plan + +### 6.1 UICC File Store Access + +#### 6.1.1 CatSelect + +Test Area Reference: API\_CatSelect + +##### 6.1.1.1 Conformance Requirements + +The entry point with the following signature shall be compliant to its definition in the API. + +``` +WORD CatSelect(CatFID FileIdentifier, CatFileStatus *Status) +``` + +###### 6.1.1.1.1 Normal execution + +CRRN1: If the desired file is selected, the proper status information has been returned in \*Status. + +CRRN2: After selecting a DF/MF no EF is selected. + +CRRN3: After selecting a linear fixed EF no record is selected. + +CRRN4: After selecting a cyclic EF the first record which is the last updated record is selected. + +CRRN5: The file with a file identifier that matches fid shall be found according to the following selection rules: + +- 1) An immediate child EF or DF of the current MF/DF can be selected, +- 2) A sibling DF of the current DF can be selected, +- 3) The current MF/DF it self can be selected, +- 4) The parent MF/DF of the current DF can be selected, + +The MF can always be selected. + +CRRN6: If status is NULL the invocation is a NOP. + +#### 6.1.1.1.2 Parameter errors + +#### 6.1.1.1.3 Context errors + +CRRC1: If the file with a file identifier which matches FileIdentifier could not be found according to the selection rules listed in CRRN5 then the FILE\_NOT\_FOUND status word shall be returned. + +CRRC2: If the entry point call causes a memory problem (e.g. memory access error), the MEMORY\_PROBLEM status word shall be returned. + +CRRC3: If the entry point call causes an error to occur that is not expected and thus not handled, the INTERNAL\_ERROR status word shall be returned. + +#### 6.1.1.2 Test Procedure + +SET Test TO CatSelect. + +``` +/* Test Case 1: Select MF in MF (Transparent EF) */ +IF {CatSelect(FID_MF, &FCP) == SW_OK} +THEN {FCP.fileType == FT_MF}. + +/* Test Case 2: Select EF-ICCID in MF (Transparent EF) */ +IF {CatSelect(FID_EF_ICCID, &FCP) == SW_OK} +THEN {FCP.fileType == FT_EF}. + +/* Test Case 3: Select DF-GSM in MF*/ +IF {CatSelect(FID_DF_GSM, &FCP) == SW_OK} +THEN {FCP.fileType == FT_DF}. + +/* Test Case 4: Select EF-ACM in DF-GSM (Cyclic EF) */ +IF {CatSelect(FID_EF_ACM, &FCP) == SW_OK} +THEN {FCP.fileType == FT_EF}. + +/* Test Case 5: Select MF*/ +IF {CatSelect(FID_MF, &FCP) == SW_OK} +THEN {FCP.fileType == FT_MF}. + +/* Test Case 6: Select DF-TELECOM in MF */ +IF {CatSelect(FID_DF_TELECOM, &FCP) == SW_OK} +THEN {FCP.fileType == FT_DF}. + +/* Test Case 7: Select EF-FDN in DF-TELECOM (Linear Fixed EF) */ +IF {CatSelect(FID_EF_FDN, &FCP) == SW_OK} +THEN {FCP.fileType == FT_EF}. + +/* Test Case 8: Status is null*/ +IF {CatSelect(FID_EF_FDN, NULL) == SW_OK} +THEN {FCP.fileType == FT_EF}. + +/* Test Case 9: EF not selected after MF/DF selection */ +IF {CatSelect(FID_MF, &FCP) == SW_OK} +AND {CatSelect(FID_EF_ICCID, &FCP) == SW_OK} +AND {CatSelect(FID_MF, &FCP) == SW_OK} +THEN {CatReadBinary(0, &bytes, buffer) == SW_NO_CURRENT_FILE} +AND {FCP.fileType == FT_UNKNOWN}. +``` + +``` + +/* Test Case 10: Selected file not available */ +IF {CatSelect(FID_MF, &FCP) == SW_OK} +THEN {CatSelect(FID_EF_ACM, &FCP) == SW_FILE_NOT_FOUND} +AND {FCP.fileType == FT_UNKNOWN}. + +/* Test Case 11: No record is selected after selecting linear fixed EF */ +IF {CatSelect(FID_MF, &FCP) == SW_OK} +AND {CatSelect(FID_DF_SIMTEST, &FCP) == SW_OK} +AND {CatSelect(FID_EF_LARU, &FCP) == SW_OK} +THEN {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_RECORD_NOT_FOUND} +AND {FCP.fileType == FT_EF}. + +``` + +### 6.1.1.3 Test Coverage + +| CRR Number | Test Case Number | +|------------|------------------| +| N1 | 1, 2, 3 | +| N2 | 4 | +| N3 | 5 | +| N4 | 6 | +| N5 | 7 | +| N6 | 8 | +| C1 | 9, 10, 11 | +| C2, C3 | Not Tested | + +## 6.1.2 CatStatus + +Test Area Reference: API\_CatStatus + +### 6.1.2.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +WORD CatStatus(CatFileStatus *Status) +``` + +#### 6.1.2.1.1 Normal execution + +CRRN1: The status information of the current EF is returned. + +CRRN2: If Status is NULL the invocation is a NOP. + +#### 6.1.2.1.2 Parameter errors + +#### 6.1.2.1.3 Context errors + +### 6.1.2.2 Test Procedure + +``` +SET Test TO CatStatus. +``` + +``` + +/* Test Case 1: Status of MF */ +IF {CatSelect(FID_MF, &FCP) == SW_OK} +AND {CatStatus(&Status) == SW_OK} +THEN {memcmp(&FCP, &Status, sizeof(CatDFStatus)) == 0} +AND {Status.fileType == FT_MF}. + +/* Test Case 2: Status of EF-ICCID */ +IF {CatSelect(FID_EF_ICCID, &FCP) == SW_OK} +AND {CatStatus(&Status) == SW_OK} +THEN {memcmp(&FCP, &Status, sizeof(CatEFStatus)) == 0}. + +/* Test Case 3: Status of DF-TELECOM / + +``` + +``` + +IF {CatSelect(FID_DF_TELECOM, &FCP) == SW_OK} +AND {CatStatus(&Status) == SW_OK} +THEN {memcmp(&FCP, &Status, sizeof(CatDFStatus)) == 0}. + +/* Test Case 4: Status with NULL argument */ +IF {CatStatus(NULL) == SW_OK} +THEN {NOP}. + +``` + +### 6.1.2.3 Test Coverage + +| CRR Number | Test Case Number | +|------------|------------------| +| N1 | 1, 2, 3 | +| N2 | 4 | + +## 6.1.3 CatGetCHVStatus + +Test Area Reference: API\_CatGetCHVStatus + +### 6.1.3.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +WORD CatGetCHVStatus(BYTE *CHV) +``` + +#### 6.1.3.1.1 Normal execution + +CRRN1: The current CHV status information is returned. + +#### 6.1.3.1.2 Parameter errors + +#### 6.1.3.1.3 Context errors + +### 6.1.3.2 Test Procedure + +``` +SET Test TO CatGetCHVStatus. +``` + +``` + +/* Test Case 1: Get the ATR CHV Status */ +IF {(CatGetCHVStatus(CHVStatus), SW_OK) == SW_OK} +THEN {CHVStatus[0] == 0} +AND {CHVStatus[1] == 0} +AND {CHVStatus[2] == 0} +AND {CHVStatus[3] == 0}. + +``` + +### 6.1.3.3 Test Coverage + +| CRR Number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.1.4 CatReadBinary + +Test Area Reference: API\_CatReadBinary + +### 6.1.4.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +WORD CatReadBinary(DWORD Offset, DWORD *Bytes, void *Buffer); +``` + +#### 6.1.4.1.1 Normal execution + +CRRN1: If data can be accessed at the specified offset in the currently selected transparent file, an attempt is made to read the number of bytes in Bytes. The bytes read are returned in Buffer and the actual number of bytes read returned in Bytes. + +CRRN2: If Bytes is non-null and Buffer is null, then the number of bytes that could be read is returned in Bytes. + +CRRN3: If Bytes is null or \*Bytes is zero the invocation is a NOP + +#### 6.1.4.1.2 Parameter errors + +CRRP1: If Offset exceeds the length of the file, the status word OUT\_OF\_FILE\_BOUNDARIES shall be returned. + +#### 6.1.4.1.3 Context errors + +CRRC1: If there is no currently selected EF, the status word NO\_EF\_SELECTED shall be returned. + +CRRC2: If the currently selected EF is not transparent, the status word FILE\_INCONSISTENT shall be returned. + +CRRC3: If the calling application does not fulfil the access condition, READ, to perform this function, the status word SECURITY\_CONDITION\_NOT\_SATISFIED shall be returned. + +CRRC4: If the currently selected EF is invalidated and the file status of the EF does not allow for the reading of an invalidated file, the status word INVALIDATION\_STATUS\_CONTRADICTION shall be returned. + +CRRC5: If the entry point call causes a memory problem (e.g. memory access error), an instance the status word MEMORY\_PROBLEM shall be returned. + +CRRC6: If the entry point call causes an error to occur that is not expected and thus not handled, an instance of the status word INTERNAL\_ERROR shall be returned. + +#### 6.1.4.2 Test Procedure + +``` +SET Test TO CatReadBinary +AND Data TO {0x0F, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}. + +/* Test Case 1: Read from EF-ICCID in MF */ +IF {CatSelect(FID_EF_ICCID, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 5} +THEN {CatReadBinary(0, &bytes, buffer) == SW_OK} +AND {bytes == 5} +AND {memcmp(buffer, Data, bytes) == 0}. + +/* Test Case 2: Offset < EOF < Offset+Bytes */ +IF {CatSelect(FID_EF_ICCID, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 5} +THEN {CatReadBinary(6, &bytes, buffer) == SW_OK} +AND {bytes == 4} +AND {memcmp(buffer, &Data[1], bytes) == 0}. + +/* Test Case 3: EOF < Offset */ +IF {CatSelect(FID_EF_ICCID, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 5} +THEN {CatReadBinary(100, &bytes, buffer) == SW_OK} +AND {bytes == 0}. + +/* Test Case 4: Buffer is null */ +IF {CatSelect(FID_EF_ICCID, NULL) == SW_OK} +AND {bytes = 5} +THEN {CatReadBinary(6, &bytes, NULL) == SW_OK} +AND {bytes == 4}. + +/* Test Case 5: EF is not Transparent */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatReadBinary(0, &bytes, NULL) == SW_INCOMPATIBLE_FILE_STRUCTURE}. +``` + +``` + +/* Test Case 6: Access condition not fulfilled */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TNR, NULL) == SW_OK} +THEN {CatReadBinary(0, &bytes, NULL) == SW_SECURITY_STATUS_NOT_SATISFIED}. + +/* Test Case 7: EF is invalidated */ +IF {CatSelect(FID_EF_TNU, NULL) == SW_OK} +AND {(CatInvalidate(), SW_OK) == SW_OK} +THEN {CatReadBinary(0, &bytes, NULL) == SW_REFERENCED_DATA_INVALIDATED}. + +/* Test Case 8: No EF selected */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +THEN {CatReadBinary(0, &bytes, NULL) == SW_NO_CURRENT_FILE}. + +/* Test Case 9: NULL arguments */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TARU, NULL) == SW_OK} +THEN {CatReadBinary(0, NULL, NULL) == SW_OK}. + +``` + +### 6.1.4.3 Test Coverage + +| CRR Number | Test Case Number | +|------------|------------------| +| N1 | 1,2 | +| N2 | 4 | +| N3 | 9 | +| P1 | 3 | +| C1 | 8 | +| C2 | 5 | +| C3 | 6 | +| C4 | 7 | +| C5, C6 | Not tested | + +## 6.1.5 CatUpdateBinary + +Test Area Reference: API\_CatUpdateBinary + +### 6.1.5.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +UINT16 CatUpdateBinary(DWORD Offset, DWORD Bytes, void *Buffer); +``` + +#### 6.1.5.1.1 Normal execution + +CRRN1: The currently selected transparent file is updated starting at Offset with the sequence of Bytes bytes in Buffer. + +#### 6.1.5.1.2 Parameter errors + +CRRP1: If Bytes is positive and Buffer is null, then INCORRECT\_PARAMETERS shall be returned. + +#### 6.1.5.1.3 Context errors + +CRRC1: If there is no currently selected EF, the status word NO\_EF\_SELECTED shall be returned. + +CRRC2: If the currently selected EF is not transparent, the status word FILE\_INCONSISTENT shall be returned. + +CRRC3: If the calling application does not fulfil the access condition, READ, to perform this function, the status word SECURITY\_CONDITION\_NOT\_SATISFIED shall be returned. + +CRRC4: If the currently selected EF is invalidated and the file status of the EF does not allow for the reading of an invalidated file, the status word INVALIDATION\_STATUS\_CONTRADICTION shall be returned. + +CRRC5: If the entry point call causes a memory problem (e.g. memory access error), an instance the status word MEMORY\_PROBLEM shall be returned. + +CRRC6: If the entry point call causes an error to occur that is not expected and thus not handled, an instance of the status word INTERNAL\_ERROR shall be returned. + +### 6.1.5.2 Test Procedure + +``` +SET Test TO CatUpdateBinary +AND Data TO {1,2,3,4,5}. + +/* Test Case 1: Update Transparent EF */ +IF {CatSelect(FID_EF_ICCID, NULL) == SW_OK} +AND {bytes = 5} +THEN {CatUpdateBinary(0, bytes, Data) == SW_OK} +AND {CatReadBinary(0, &bytes, buffer) == SW_OK} +AND {bytes == 5} +AND {memcmp(Data, buffer, bytes) == 0}. + +/* Test Case 2: Offset < EOF and Offset + Bytes > EOF*/ +IF {CatSelect(FID_EF_ICCID, NULL) == SW_OK} +AND {bytes = 5} +THEN {CatUpdateBinary(7, bytes, Data) == SW_OK} +AND {CatReadBinary(7, &bytes, buffer) == SW_OK} +AND {bytes == 5} +AND {memcmp(Data, buffer, bytes) == 0}. + +/* Test Case 3: Offset > EOF */ +IF {CatSelect(FID_EF_ICCID, NULL) == SW_OK} +THEN {CatUpdateBinary(11, 5, Data) == SW_OK} +AND {CatReadBinary(11, &bytes, buffer) == SW_OK} +AND {bytes == 5} +AND {memcmp(Data, buffer, bytes) == 0}. + +/* Test Case 4: Buffer is NULL */ +IF {CatSelect(FID_EF_ICCID, NULL) == SW_OK} +THEN {CatUpdateBinary(0, 5, NULL) == SW_OK}. + +/* Test Case 5: No EF selected */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +THEN {CatUpdateBinary(0, 5, Data) == SW_NO_CURRENT_FILE}. + +/* Test Case 6: EF is not transparent */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatUpdateBinary(0, 5, Data) == SW_INCOMPATIBLE_FILE_STRUCTURE}. + +/* Test Case 7: Access condition not fulfilled */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TNU, NULL) == SW_OK} +THEN {CatUpdateBinary(0, 5, Data) == SW_SECURITY_STATUS_NOT_SATISFIED}. + +/* Test Case 8: EF is invalidated*/ +IF {CatSelect(FID_EF_TNU, NULL) == SW_OK} +AND {(CatInvalidate(), SW_OK) == SW_OK} +THEN {CatUpdateBinary(0, 5, Data) == SW_REFERENCED_DATA_INVALIDATED}. +``` + +### 6.1.5.3 Test Coverage + +| CRR Number | Test Case Number | +|------------|------------------| +| N1 | 1,2,3 | +| P1 | 4 | +| C1 | 5 | +| C2 | 6 | +| C3 | 7 | +| C4 | 8 | +| C5, C6 | Not Tested | + +### 6.1.6 CatReadRecord + +Test Area Reference: API\_CatReadRecord + +### 6.1.6.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +UINT16 CatReadRecord(DWORD RecordNumber, CatRecordAccessModes Mode, + DWORD Offset, DWORD *NumBytes, void *Buffer); +``` + +#### 6.1.6.1.1 Normal execution + +CRRN1: NumBytes bytes starting at Offset from the record specified by Mode and RecordNumber of the currently selected linear fixed or cyclic EF are read into Buffer. + +CRRN2: If the access mode is ABSOLUTE or CURRENT: + +- if RecordNumber is not 0, the record addressed by RecordNumber will be read; +- if RecordNumber is 0 the current selected record will be read; and +- the current record pointer shall not change. + +CRRN3: If the access mode is NEXT: + +- the next record relative to the current selected record will be selected and read; +- if no current record is selected, the first record will be selected and read; +- if the current record pointer is set to the last record for a cyclic EF the record pointer is set to the first record and the record is read; +- the current record pointer of any other Application shall not be changed. + +CRRN4: If the access mode is PREVIOUS: + +- the previous record relative to the current selected record will be selected and read; +- if no current record is selected, the last record will be selected and read; +- if the current record pointer is set to the first record, for a linear fixed EF the entry point responses with an error exception and for a cyclic EF the record pointer is set to the last record and the record is read; +- the current record pointer of any other Application shall not be changed. + +#### 6.1.6.1.2 Parameter errors + +CRRP1: If the currently selected EF is linear fixed and the access mode is ABSOLUTE and RecordNumber is greater than records available, the status word RECORD\_NUMBER\_NOT\_AVAILABLE shall be returned + +CRRP2: If the currently selected EF is linear fixed and the access mode is CURRENT, RecordNumber is 0 and there is no current record selected, the status word RECORD\_NUMBER\_NOT\_AVAILABLE shall be returned. + +CRRP3: If the currently selected EF is linear fixed and the access mode is NEXT and the current record pointer is set to the last record, the status word RECORD\_NUMBER\_NOT\_AVAILABLE shall be returned. + +CRRP4: If the currently selected EF is linear fixed and the access mode is PREVIOUS and the current record pointer is set to the first record, the status word RECORD\_NUMBER\_NOT\_AVAILABLE shall be returned. + +#### 6.1.6.1.3 Context errors + +CRRC1: If the calling Application has currently no EF selected, the status word NO\_EF\_SELECTED shall be returned. + +CRRC2: If the currently selected EF is neither linear fixed nor cyclic, the status word FILE\_INCONSISTENT shall be returned. + +CRRC3: If the calling Application does not fulfil the access condition, READ, to perform this function, the status word AC\_NOT\_FULFILLED shall be returned. + +CRRC4: If the currently selected EF is invalidated and the file status of the EF does not allow for reading an invalidated file, the status word INVALIDATION\_STATUS\_CONTRADICTION shall be returned. + +CRRC5: If the entry point call causes a memory problem (e.g. memory access error), the status word MEMORY\_PROBLEM shall be returned. + +CRRC6: If the entry point call causes an error to occur that is not expected and thus not handled, the status word INTERNAL\_ERROR shall be returned. + +## 6.1.6.2 Test Procedure + +``` +SET Test TO CatReadRecord +AND Data55 TO {0x55,0x55,0x55,0x55} +AND DataAA TO {0xAA,0xAA,0xAA,0xAA}. + +/* Test Case 1: Read Absolute Linear Fixed EF */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatReadRecord(1, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +AND {bytes == 4} +AND {memcmp(buffer, Data55, bytes) == 0}. + +/* Test Case 2: Read Current Fixed EF */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +AND {bytes == 4} +AND {memcmp(buffer, Data55, bytes) == 0}. + +/* Test Case 3: Read Next from Linear Fixed EF */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatReadRecord(0, REC_ACC_MODE_NEXT, 0, &bytes, buffer) == SW_OK} +AND {bytes == 4} +AND {memcmp(buffer, DataAA, bytes) == 0}. + +/* Test Case 4: Read Next from Linear Fixed EF */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 0} +THEN {CatReadRecord(0, REC_ACC_MODE_NEXT, 0, &bytes, buffer) == SW_RECORD_NOT_FOUND}. + +/* Test Case 5: Read Previous from Linear Fixed EF */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatReadRecord(0, REC_ACC_MODE_PREVIOUS, 0, &bytes, buffer) == SW_OK} +AND {bytes == 4} +AND {memcmp(buffer, Data55, bytes) == 0}. + +/* Test Case 6: Read Previous from Linear Fixed EF */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 0} +THEN {CatReadRecord(0, REC_ACC_MODE_PREVIOUS, 0, &bytes, buffer) == SW_RECORD_NOT_FOUND}. + +/* Test Case 7: Read Absolute and Current from Cyclic EF */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +AND {bytes == 4} +AND {memcmp(buffer, Data55, bytes) == 0}. + +/* Test Case 8: Read Next from Cyclic EF */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatReadRecord(0, REC_ACC_MODE_NEXT, 0, &bytes, buffer) == SW_OK} +AND {bytes == 4} +AND {memcmp(buffer, DataAA, bytes) == 0}. +``` + +``` + +/* Test Case 9: Read Next from Cyclic EF */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +THEN {CatReadRecord(0, REC_ACC_MODE_NEXT, 0, &bytes, buffer) == SW_OK} +AND {bytes == 4} +AND {memcmp(buffer, Data55, bytes) == 0}. + +/* Test Case 10: Read Previous from Cyclic EF */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatReadRecord(0, REC_ACC_MODE_PREVIOUS, 0, &bytes, buffer) == SW_OK} +AND {bytes == 4} +AND {memcmp(buffer, DataAA, bytes) == 0}. + +/* Test Case 11: Read Previous from Cyclic EF */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatReadRecord(0, REC_ACC_MODE_PREVIOUS, 0, &bytes, buffer) == SW_OK} +AND {bytes == 4} +AND {memcmp(buffer, Data55, bytes) == 0}. + +/* Test Case 12: NumBytes > Record Length */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {bytes = 5} +THEN {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_INCORRECT_P1_P2}. + +/* Test Case 13: No current record in linear fixed EF */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {bytes = 4} +THEN {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_RECORD_NOT_FOUND}. + +/* Test Case 14: No EF selected */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TNR, NULL) == SW_OK} +THEN {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == +SW_INCOMPATIBLE_FILE_STRUCTURE}. + +/* Test Case 15: EF is neither Cyclic nor Linear Fixed */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +THEN {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_NO_CURRENT_FILE}. + +/* Test Case 16: Access condition not fulfilled */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LNR, NULL) == SW_OK} +THEN {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == +SW_SECURITY_STATUS_NOT_SATISFIED}. + +/* Test Case 17: EF is invalidated */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {(CatInvalidate(), SW_OK) == SW_OK} +THEN {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == +SW_REFERENCED_DATA_INVALIDATED}. + +``` + +### 6.1.6.3 Test Coverage + +| CRR Number | Test Case Number | +|------------|---------------------| +| N1 | 1,2,3,5,7,8,9,10,11 | +| N2 | 1,7 | +| N3 | 3,4,8,9 | +| N4 | 5,6,10,11 | +| P1 | Not Tested | +| P2 | Not Tested | +| P3 | 4 | +| P4 | 6 | +| C1 | 14 | +| C2 | 15 | +| C3 | 16 | +| C4 | 17 | +| C5, C6 | Not Tested | + +## 6.1.7 CatUpdateRecord + +Test Area Reference: API\_CatUpdateRecord + +### 6.1.7.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +UINT16 CatUpdateRecord(DWORD RecordNumber, CatRecordAccessModes Mode, + DWORD Offset, DWORD NumBytes, void *Buffer); +``` + +#### 6.1.7.1.1 Normal execution + +CRRN1: NumBytes of data starting at Offset in the record specified by Mode and RecordNumber of the current selected linear fixed or cyclic EF are overwritten by the data in Buffer. + +CRRN2: If the access mode is ABSOLUTE or CURRENT and the file is a linear fixed EF: + +- the record addressed by RecordNumber will be updated; +- if RecordNumber is 0 the current selected record will be updated; and +- the current record pointer shall not change. + +CRRN3: If the access mode is NEXT and the file is a linear fixed EF: + +- the next record relative to the current selected record will be selected and updated; +- if no current record is selected, the first record will be selected and updated; +- the current record pointer of any other application shall not be changed. + +CRRN4: If the access mode is PREVIOUS: + +- the previous record relative to the current selected record will be selected and updated; +- if no current record is selected, the last record will be selected and updated; +- if a cyclic EF is updated, the oldest record will be updated independent of the current record pointer and this record becomes record number 1 and the current record; +- the current record pointer of any other application shall not be changed in case of a linear fixed EF. + +#### 6.1.7.1.2 Parameter errors + +CRRP1: If the currently selected EF is linear fixed and the access mode is ABSOLUTE and RecordNumber is greater than records available, the status word RECORD\_NUMBER\_NOT\_AVAILABLE shall be returned + +CRRP2: If the currently selected EF is linear fixed and the access mode is CURRENT, RecordNumber is 0 and there is no current record selected, the status word RECORD\_NUMBER\_NOT\_AVAILABLE shall be returned. + +CRRP3: If the currently selected EF is linear fixed and the access mode is NEXT and the current record pointer is set to the last record, the status word RECORD\_NUMBER\_NOT\_AVAILABLE shall be returned. + +CRRP4: If the currently selected EF is linear fixed and the access mode is PREVIOUS and the current record pointer is set to the first record, the status word RECORD\_NUMBER\_NOT\_AVAILABLE shall be returned. + +CRRP5: If the currently selected EF is linear fixed and Offset plus NumBytes is greater than the record length, then the status word OUT\_OF\_FILE\_BOUNDARIES shall be returned. + +#### 6.1.7.1.3 Context errors + +CRRC1: If the calling Application has currently no EF selected, the status word NO\_EF\_SELECTED shall be returned. + +CRRC2: If the currently selected EF is neither linear fixed nor cyclic, the status word FILE\_INCONSISTENT shall be returned. + +CRRC3: If the calling Application does not fulfil the access condition, UPDATE, to perform this function, the status word AC\_NOT\_FULFILLED shall be returned. + +CRRC4: If the currently selected EF is invalidated and the file status of the EF does not allow for reading an invalidated file, the status word INVALIDATION\_STATUS\_CONTRADICTION shall be returned. + +CRRC5: If the entry point call causes a memory problem (e.g. memory access error), the status word MEMORY\_PROBLEM shall be returned. + +CRRC6: If the entry point call causes an error to occur that is not expected and thus not handled, the status word INTERNAL\_ERROR shall be returned. + +## 6.1.7.2 Test Procedure + +``` +SET Test TO CatUpdateRecord +AND Data TO {1,2,3,4}. + +/* Test Case 1: Update Absolute Record in Linear Fixed EF */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatUpdateRecord(1, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, bytes, Data) == SW_OK} +AND {bytes == 4} +AND {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +AND {memcmp(buffer, Data, bytes) == 0}. + +/* Test Case 2: Update Current Record in Linear Fixed EF */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatUpdateRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, bytes, Data) == SW_OK} +AND {bytes == 4} +AND {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +AND {memcmp(buffer, Data, bytes) == 0}. + +/* Test Case 3: Update Next from Linear Fixed EF, no record pointer set */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatUpdateRecord(0, REC_ACC_MODE_NEXT, 0, bytes, Data) == SW_OK} +AND {bytes == 4} +AND {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +AND {memcmp(buffer, Data, bytes) == 0}. + +/* Test Case 4: Update Next from Linear Fixed EF, record pointer set */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +AND {CatReadRecord(1, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +THEN {CatUpdateRecord(0, REC_ACC_MODE_NEXT, 0, bytes, Data) == SW_OK} +AND {bytes == 4} +AND {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +AND {memcmp(buffer, Data, bytes) == 0}. + +/* Test Case 5: Update Next from Linear Fixed EF, no more records */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {bytes = 4} +THEN {CatUpdateRecord(0, REC_ACC_MODE_NEXT, 0, bytes, Data) == SW_RECORD_NOT_FOUND}. + +/* Test Case 6: Update Previous from Linear Fixed EF, no record pointer set */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatUpdateRecord(0, REC_ACC_MODE_PREVIOUS, 0, bytes, Data) == SW_OK} +AND {bytes == 4} +AND {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +``` + +``` +AND {memcmp(buffer, Data, bytes) == 0}. + +/* Test Case 7: Update Previous from Linear Fixed EF, record pointer set */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +AND {CatReadRecord(2, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +THEN {CatUpdateRecord(0, REC_ACC_MODE_PREVIOUS, 0, bytes, Data) == SW_OK} +AND {bytes == 4} +AND {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +AND {memcmp(buffer, Data, bytes) == 0}. + +/* Test Case 8: Update Previous from Linear Fixed EF, no more records */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +AND {CatReadRecord(1, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +THEN {CatUpdateRecord(0, REC_ACC_MODE_PREVIOUS, 0, bytes, Data) == SW_RECORD_NOT_FOUND}. + +/* Test Case 9: Update Previous from Cyclic EF */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_CARU, NULL) == SW_OK} +AND {memset(buffer, 0, sizeof(buffer))} +AND {bytes = 4} +THEN {CatUpdateRecord(0, REC_ACC_MODE_PREVIOUS, 0, bytes, Data) == SW_OK} +AND {bytes == 4} +AND {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +AND {memcmp(buffer, Data, bytes) == 0}. + +/* Test Case 10: No EF selected */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +THEN {CatUpdateRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, bytes, buffer) == SW_NO_CURRENT_FILE}. + +/* Test Case 11: Update Absolute from Linear Fixed EF beyond Records */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {bytes = 5} +THEN {CatUpdateRecord(3, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, bytes, buffer) == SW_INCORRECT_P1_P2}. + +/* Test Case 12: No current record in linear fixed EF, update current */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {bytes = 4} +THEN {CatUpdateRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, bytes, buffer) == SW_RECORD_NOT_FOUND}. + +/* Test Case 13: Record Length < Offset + NumBytes */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {bytes = 5} +THEN {CatUpdateRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, bytes, buffer) == SW_INCORRECT_P1_P2}. + +/* Test Case 14: EF is neither Cyclic nor Linear Fixed */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TNR, NULL) == SW_OK} +THEN {CatUpdateRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, bytes, buffer) == SW_INCOMPATIBLE_FILE_STRUCTURE}. + +/* Test Case 15: Access condition not fulfilled */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LNU, NULL) == SW_OK} +THEN {CatUpdateRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, bytes, buffer) == SW_SECURITY_STATUS_NOT_SATISFIED}. + +/* Test Case 16: EF is invalidated */ +IF {CatSelect(FID_EF_LARU, NULL) == SW_OK} +AND {(CatInvalidate(), SW_OK) == SW_OK} +THEN {CatUpdateRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, bytes, buffer) == SW_REFERENCED_DATA_INVALIDATED}. +``` + +### 6.1.7.3 Test Coverage + +| CRR Number | Test Case Number | +|------------|------------------| +| N1 | 1,2,3,4,6,7,9 | +| N2 | 2 | +| N3 | 3,4 | +| N4 | 6,7,9 | +| P1 | 11 | +| P2 | 12 | +| P3 | 5 | +| P4 | 8 | +| P5 | 13 | +| C1 | 10 | +| C2 | 14 | +| C3 | 15 | +| C4 | 16 | +| C5, C6 | Not Tested | + +## 6.1.8 CatSearch + +Test Area Reference: API\_CatSearch + +### 6.1.8.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +UINT16 CatSearch(CatSeekModes Mode, DWORD Offset, DWORD PatternLength, const void *Pattern); +``` + +#### 6.1.8.1.1 Normal execution + +CRRN1: If the pattern in Pattern with the length PatternLength is found in the record being specified by mode starting at Offset, the current record pointer is set to that record and the record number is returned. + +CRRN2: If mode is BEGINNING\_FORWARD, the search starts with the first record forward towards the end of the file. + +CRRN3: If mode is END\_BACKWARD, the search starts with the last record backward towards the beginning of the file. + +CRRN4: If mode is NEXT\_FORWARD, the search starts from the next record after the current record pointer forward towards the end of file. If no current record pointer is selected, the search starts with the first record. + +CRRN5: If mode is PREVIOUS\_BACKWARD, the search starts from the previous record before the current record pointer backward towards the beginning of the file. If no current record pointer is selected the search starts with the last record. + +CRRN6: If pattern in patt is not found, the status word PATTERN\_NOT\_FOUND shall be returned. + +CRRN7: If mode is NEXT\_FORWARD and the record pointer is at the last record, the status word PATTERN\_NOT\_FOUND shall be returned. + +CRRN8: If mode is PREVIOUS\_BACKWARD and the record pointer is at the first record, the status word PATTERN\_NOT\_FOUND shall be returned. + +#### 6.1.8.1.2 Parameter errors + +CRRP1: If PatternLength is greater than the size of the record of the currently selected EF, the status word OUT\_OF\_RECORD\_BOUNDARIES shall be returned. + +CRRP2: If Offset plus PatternLength is greater than the length of the pattern array patt.length, the status word OUT\_OF\_RECORD\_BOUNDARIES shall be returned. + +#### 6.1.8.1.3 Context errors + +CRRC1: If the calling Application has currently no EF selected, the status word NO\_EF\_SELECTED shall be returned. + +CRRC2: If the currently selected EF is neither linear fixed nor cyclic, the status word FILE\_INCONSISTENT shall be returned. + +CRRC3: If the calling Application does not fulfil the access condition, READ, to perform this function, the status word AC\_NOT\_FULFILLED shall be returned. + +CRRC4: If the currently selected EF is invalidated and the file status of the EF does not allow for reading an invalidated file, the status word INVALIDATION\_STATUS\_CONTRADICTION shall be returned. + +CRRC5: If the entry point call causes a memory problem (e.g. memory access error), the status word MEMORY\_PROBLEM shall be returned. + +CRRC6: If the entry point call causes an error to occur that is not expected and thus not handled, the status word INTERNAL\_ERROR shall be returned. + +#### 6.1.8.2 Test Procedure + +``` +SET Test TO CatSearch +AND PatDA TO {0xDA, 0xDA, 0xDA} +AND Pat55 TO {0x55, 0x55, 0x55} +AND PatAA TO {0xAA, 0xAA, 0xAA} +AND Pat12 TO {1,2,3,4,5,6,7,8,9,0}. + +/* Test Case 1: Pattern not found */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatSearch(BEGINNING_FORWARD, 0, sizeof(PatDA), PatDA)== SW_REFERENCED_DATA_NOT_FOUND}. + +/* Test Case 2: Search from beginning forward */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatSearch(BEGINNING_FORWARD, 0, sizeof(Pat55), Pat55)== SW_OK}. + +/* Test Case 3: Search from end backward */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatSearch(END_BACKWARD, 0, sizeof(Pat55), Pat55)== SW_OK}. + +/* Test Case 4: Search from next forward */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatSearch(NEXT_FORWARD, 0, sizeof(PatAA), PatAA)== SW_OK}. + +/* Test Case 5: Last record, search next forward */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatSearch(NEXT_FORWARD, 0, sizeof(Pat55), Pat55)== SW_REFERENCED_DATA_NOT_FOUND}. + +/* Test Case 6: Search from next forward */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatSearch(PREVIOUS_BACKWARD, 0, sizeof(Pat55), Pat55)== SW_OK}. + +/* Test Case 7: First record, search previous backward */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatSearch(NEXT_FORWARD, 0, sizeof(Pat55), Pat55)== SW_REFERENCED_DATA_NOT_FOUND}. + +/* Test Case 8: Pattern not found, start beyond end of record */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatSearch(BEGINNING_FORWARD, 10, sizeof(Pat55), Pat55)== SW_REFERENCED_DATA_NOT_FOUND}. + +/* Test Case 9: Pattern not found, pattern longer than record */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatSearch(BEGINNING_FORWARD, 0, sizeof(Pat12), Pat12)== SW_REFERENCED_DATA_NOT_FOUND}. + +/* Test Case 10: Pattern not found, offset < record length < offset+pattern length*/ +``` + +``` + +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_LARU, NULL) == SW_OK} +THEN {CatSearch(BEGINNING_FORWARD, 2, sizeof(Pat55), Pat55) == SW_REFERENCED_DATA_NOT_FOUND}. + +/* Test Case 11: Pattern not found, EF not linear */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TARU, NULL) == SW_OK} +THEN {CatSearch(BEGINNING_FORWARD, 0, sizeof(Pat55), Pat55) == SW_INCOMPATIBLE_FILE_STRUCTURE}. + +/* Test Case 12: No EF selected */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +THEN {CatSearch(BEGINNING_FORWARD, 0, sizeof(Pat55), Pat55) == SW_NO_CURRENT_FILE}. + +/* Test Case 13: Security condition not satisfied */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TNR, NULL) == SW_OK} +THEN {CatSearch(BEGINNING_FORWARD, 0, sizeof(Pat55), Pat55) == SW_SECURITY_STATUS_NOT_SATISFIED}. + +/* Test Case 14: EF is invalidated */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TNU, NULL) == SW_OK} +AND {(CatInvalidate(), SW_OK) == SW_OK} +THEN {CatSearch(BEGINNING_FORWARD, 0, sizeof(Pat55), Pat55) == SW_REFERENCED_DATA_INVALIDATED}. + +``` + +### 6.1.8.3 Test Coverage + +| CRR Number | Test Case Number | +|------------|------------------| +| N1 | 2 | +| N2 | 3 | +| N3 | 4 | +| N4 | 6 | +| N5 | 8 | +| N6 | 1 | +| N7 | 5 | +| N8 | 7 | +| P1 | 9 | +| P2 | 10 | +| C1 | 12 | +| C2 | 11 | +| C3 | 13 | +| C4 | 14 | +| C5, C6 | Not tested | + +### 6.1.9 CatIncrease + +Test Area Reference: API\_CatIncrease + +#### 6.1.9.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +UINT16 CatIncrease(DWORD Increment, DWORD *Value); +``` + +##### 6.1.9.1.1 Normal execution + +CRRN1: The value Increment is added to the value of the last increased / updated record in the currently selected cyclic EF. The result is stored in the oldest record and returned in Value if Value is non-null. The updated record becomes record number 1 and is selected as current record. + +##### 6.1.9.1.2 Parameter errors + +CRP1: If the result of the addition is greater than the maximum value a DWORD, the status word MAX\_VALUE\_REACHED shall be returned. + +#### 6.1.9.1.3 Context errors + +- CRRC1: If the calling Application has currently no EF selected, the status word NO\_EF\_SELECTED shall be returned. +- CRRC2: If the currently selected EF is neither linear fixed nor cyclic, the status word FILE\_INCONSISTENT shall be returned. +- CRRC3: If the calling Application does not fulfil the access condition, READ, to perform this function, the status word AC\_NOT\_FULFILLED shall be returned. +- CRRC4: If the currently selected EF is invalidated and the file status of the EF does not allow for reading an invalidated file, the status word INVALIDATION\_STATUS\_CONTRADICTION shall be returned. +- CRRC5: If the entry point call causes a memory problem (e.g. memory access error), the status word MEMORY\_PROBLEM shall be returned. +- CRRC6: If the entry point call causes an error to occur that is not expected and thus not handled, the status word INTERNAL\_ERROR shall be returned. +- CRRC 7: If Increase not allowed due to an entry in the FCP then the status word FILE\_INCONSISTENT shall be returned. + +#### 6.1.9.2 Test Procedure + +``` +SET Test TO CatIncrease. + +/* Test Case 1: Increase, verify response */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_CARU, NULL) == SW_OK} +THEN {CatIncrease((DWORD)0x00000100, &bytes) == SW_OK} +AND {bytes == (DWORD)0x00000100}. + +/* Test Case 2: Increase, verify file */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_CARU, NULL) == SW_OK} +THEN {CatIncrease((DWORD)0x00000100, &bytes) == SW_OK} +AND {CatReadRecord(0, REC_ACC_MODE_ABSOLUTE_CURRENT, 0, &bytes, buffer) == SW_OK} +AND {*(DWORD *)buffer == (DWORD)0x00000100}. + +/* Test Case 3: Increase, exceed maximum */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_CARU, NULL) == SW_OK} +THEN {CatIncrease((DWORD)0xFFFFFFFF, &bytes) == SW_INCREASE_AT_MAX_VALUE}. + +/* Test Case 4: No EF selected */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +THEN {CatIncrease((DWORD)0x00000100, &bytes) == SW_NO_CURRENT_FILE}. + +/* Test Case 5: EF not cyclic */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TARU, NULL) == SW_OK} +THEN {CatIncrease((DWORD)0x00000100, &bytes) == SW_INCOMPATIBLE_FILE_STRUCTURE}. + +/* Test Case 6: Security condition not satisfied */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_CNU, NULL) == SW_OK} +THEN {CatIncrease((DWORD)0x00000100, &bytes) == SW_SECURITY_STATUS_NOT_SATISFIED}. + +/* Test Case 7: EF is invalidated */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_CARU, NULL) == SW_OK} +AND {(CatInvalidate(), SW_OK) == SW_OK} +THEN {CatIncrease((DWORD)0x00000100, &bytes) == SW_REFERENCED_DATA_INVALIDATED}. +``` + +### 6.1.9.3 Test Coverage + +| CRR Number | Test Case Number | +|------------|------------------| +| N1 | 1,2 | +| P1 | 3 | +| C1 | 4 | +| C2 | 5 | +| C3 | 6 | +| C4 | 7 | +| C5 | Not tested | +| C6, C7 | Not tested | + +### 6.1.10 CatInvalidate + +Test Area Reference: API\_CatInvalidate + +#### 6.1.10.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +UINT16 CatInvalidate(void) +``` + +##### 6.1.10.1.1 Normal execution + +CRRN1: The currently selected EF of the calling application shall be invalidated, i.e. the flag in the EF file status shall be changed accordingly. + +##### 6.1.10.1.2 Parameter errors + +##### 6.1.10.1.3 Context errors + +CRRC1: If the calling application has currently no EF selected, the status word NO\_EF\_SELECTED shall be returned. + +CRRC2: If the calling application does not 33ulfil the access condition, INVALIDATE, the status word AC\_NOT\_FULFILLED shall be returned. + +CRRC3: If the currently selected EF is already invalidated, the status word INVALIDATION\_STATUS\_CONTRADICTION shall be returned. + +CRRC4: If the entry point call causes a memory problem (e.g. memory access error), an instance of the status word MEMORY\_PROBLEM shall be returned. + +CRRC5: If the entry point call causes an error to occur that is not expected and thus not handled, the status word INTERNAL\_ERROR shall be returned. + +#### 6.1.10.2 Test Procedure + +``` +SET Test TO CatInvalidate. +``` + +``` +/* Test Case 1: Invalidate */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TNR, NULL) == SW_OK} +THEN {CatInvalidate() == SW_OK}. + +/* Test Case 2: No EF selected */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +THEN {CatInvalidate() == SW_NO_CURRENT_FILE}. + +/* Test Case 3: Security condition not satisfied */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_CNIV, NULL) == SW_OK} +``` + +``` + +THEN {CatInvalidate() == SW_SECURITY_STATUS_NOT_SATISFIED}. + +/* Test Case 4: EF is already invalidated */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_CARU, NULL) == SW_OK} +AND {(CatInvalidate(), SW_OK) == SW_OK} +THEN {CatInvalidate() == SW_REFERENCED_DATA_INVALIDATED}. + +``` + +### 6.1.10.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| C1 | 2 | +| C2 | 3 | +| C3 | 4 | +| C4, C5 | Not Tested | + +### 6.1.11 CatRehabilitate + +Test Area Reference: API\_CatRehabilitate + +#### 6.1.11.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +UINT16 CatRehabilitate(void) +``` + +##### 6.1.11.1.1 Normal execution + +CRRN1: The currently selected EF of the calling application shall be rehabilitated, i.e. the flag in the EF file status shall be changed accordingly. + +##### 6.1.11.1.2 Parameter errors + +##### 6.1.11.1.3 Context errors + +CRRC1: If the calling application has currently no EF selected, the status word NO\_EF\_SELECTED shall be returned. + +CRRC2: If the calling application does not fulfil the access condition, INVALIDATE, the status word AC\_NOT\_FULFILLED shall be returned. + +CRRC3: If the currently selected EF is already invalidated, the status word INVALIDATION\_STATUS\_CONTRADICTION shall be returned. + +CRRC4: If the entry point call causes a memory problem (e.g. memory access error), an instance of the status word MEMORY\_PROBLEM shall be returned. + +CRRC5: If the entry point call causes an error to occur that is not expected and thus not handled, the status word INTERNAL\_ERROR shall be returned. + +#### 6.1.11.2 Test Procedure + +``` +SET Test TO CatRehabilitate. +``` + +``` + +/* Test Case 1: Rehabilitate */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TNR, NULL) == SW_OK} +AND {(CatInvalidate(), SW_OK) == SW_OK} +THEN {CatRehabilitate() == SW_OK}. + +``` + +``` +/* Test Case 2: No EF selected */ +``` + +``` + +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +THEN {CatRehabilitate() == SW_NO_CURRENT_FILE}. + +/* Test Case 3: Security condition not satisfied */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_TNR, NULL) == SW_OK} +THEN {CatRehabilitate() == SW_SECURITY_STATUS_NOT_SATISFIED}. + +/* Test Case 4: EF is may not be rehabilitated */ +IF {CatSelect(FID_DF_SIMTEST, NULL) == SW_OK} +AND {CatSelect(FID_EF_CNRI, NULL) == SW_OK} +THEN {CatRehabilitate() == SW_REFERENCED_DATA_INVALIDATED}. + +``` + +### 6.1.11.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| C1 | 2 | +| C2 | 3 | +| C3 | 4 | +| C4, C5 | Not Tested | + +## 6.2 Registry + +### 6.2.1 CatSetMenuString + +Test Area Reference: API\_CatSetMenuString + +#### 6.2.1.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` + +Void CatSetMenuString (BYTE MenuID, BYTE MenuStringLength, const void *MenuString, + const CatIconIdentifier *IconIdentifier, + BYTE HelpAvailable, BYTE NextAction); + +``` + +##### 6.2.1.1.1 Normal execution + +CRRN1: Menu string with optional modifiers is added to the main menu. + +CRNN2: If MenuString is null, the invocation is a NOP. + +##### 6.2.1.1.2 Parameter errors + +##### 6.2.1.1.3 Context errors + +#### 6.2.1.2 Test Procedure + +``` +SET Test TO CatSetMenuString. +``` + +``` + +/* Test Case 1: Set non-null menu string */ +IF {(CatSetMenuString(1, 12, "Hello, world", NULL, 0, 0), SW_OK) == SW_OK} +THEN {NOP}. + +/* Test Case 2: Set null menu string */ +IF {(CatSetMenuString(1, 0, NULL, NULL, 0, 0), SW_OK) == SW_OK} +THEN {NOP}. + +``` + +### 6.2.1.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.2.2 CatNotifyOnFrameworkEvent + +Test Area Reference: API\_CatNotifyOnFrameworkEvent + +### 6.2.2.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatNotifyOnFrameworkEvent(CatFrameworkEventType Event, BYTE Enabled); +``` + +#### 6.2.2.1.1 Normal execution + +CRRN1: Enable or disable monitoring of the framework event indicated by Event depending on the setting of Enabled. + +#### 6.2.2.1.2 Parameter errors + +#### 6.2.2.1.3 Context errors + +### 6.2.2.2 Test Suite Files + +Additional requirements for the UICC personalisation: None + +Test Script: API\_CatNotifyOnFrameworkEvent.tst + +Test Application: API\_CatNotifyOnFrameworkEvent.c + +### 6.2.2.3 Test Procedure + +| Id | Description | API Expectation | APDU Expectation | +|----|------------------------------------------------------------------------------------------------------------|--------------------|------------------| +| 0 | UICC Initialisation | Responses ignored. | | +| 1 | Enable Monitoring of an Event
1 -
CatNotifyOnFrameworkEvent(EVENT_UNRECOGNIZED_ENVELOPE, 1); | 1 - No return | | +| 2 | Disable Monitoring of an Event
1 -
CatNotifyOnFrameworkEvent(EVENT_UNRECOGNIZED_ENVELOPE, 0); | 1 - No return | | + +### 6.2.2.4 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1,2 | + +## 6.2.3 CatNotifyOnEnvelope + +Test Area Reference: API\_CatNotifyOnEnvelope + +### 6.2.3.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatNotifyOnEnvelope(CatEnvelopeTagType Tag, BYTE Enabled); +``` + +#### 6.2.3.1.1 Normal execution + +CRRN1: Enable or disable monitoring of the envelope event indicated by Tag depending on the setting of Enabled. + +#### 6.2.3.1.2 Parameter errors + +#### 6.2.3.1.3 Context errors + +### 6.2.3.2 Test Procedure + +``` +SET Test TO CatNotifyOnFrameworkEvent. + +/* Test Case 1: Enable monitoring of event */ +IF {(CatNotifyOnFrameworkEvent(SMS_PP_DOWNLOAD_TAG, 1), SW_OK) == SW_OK} +THEN {NOP}. + +/* Test Case 2: Disable monitoring of event */ +IF {(CatNotifyOnFrameworkEvent(SMS_PP_DOWNLOAD_TAG, 0), SW_OK) == SW_OK} +THEN {NOP}. +``` + +### 6.2.3.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1, 2 | + +## 6.2.4 CatNotifyOnEvent + +Test Area Reference: API\_CatNotifyOnEvent + +### 6.2.4.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatNotifyOnEvent(CatEventType EventType, BYTE Enabled); +``` + +#### 6.2.4.1.1 Normal execution + +CRRN1: Enable or disable monitoring of the terminal event indicated by Event depending on the setting of Enabled. + +#### 6.2.4.1.2 Parameter errors + +#### 6.2.4.1.3 Context errors + +### 6.2.4.2 Test Procedure + +``` +SET Test TO CatNotifyOnEvent. + +/* Test Case 1: Enable monitoring of event */ +IF {(CatNotifyOnEvent(MT_CALL_EVENT, 1), SW_OK) == SW_OK} +THEN {NOP}. +``` + +``` + +THEN {NOP}. + +/* Test Case 2: Disable monitoring of event */ +IF {(CatNotifyOnEvent(MT_CALL_EVENT, 0), SW_OK) == SW_OK} +THEN {NOP}. + +``` + +#### 6.2.4.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1, 2 | + +### 6.3 Man-Machine Interface + +#### 6.3.1 CatAddItem + +Test Area Reference: API\_CatAddItem + +##### 6.3.1.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatAddItem(BYTE ItemTextLength, const void *ItemText, BYTE ItemIdentifier); +``` + +###### 6.3.1.1.1 Normal execution + +CRRN1: Add the provided item with the provided item identifier to the list of items in the current select list. + +CRRN2: If ItemTextLength is zero or ItemText is null, the invocation is a NOP. + +###### 6.3.1.1.2 Parameter errors + +###### 6.3.1.1.3 Context errors + +##### 6.3.1.2 Test Procedure + +``` + +SET Test TO CatAddItem. + +/* Test Case 1: Add non-null item */ +IF {(CatAddItem(12, "Hello, world", 0), SW_OK) == SW_OK} +THEN {NOP}. + +/* Test Case 2: Add null item */ +IF {(CatAddItem(0, NULL, 0), SW_OK) == SW_OK} +THEN {NOP}. + +``` + +##### 6.3.1.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +#### 6.3.2 CatSelectItem + +Test Area Reference: API\_CatSelectItem + +### 6.3.2.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatSelectItem(BYTE TitleLength, const void *Title, CatSelectItemOptions Options); +``` + +#### 6.3.2.1.1 Normal execution + +CRRN1: Create a new select list with the provided title and options. + +CRRN2: If TitleLength is zero or Title is null, the select list has no title. + +#### 6.3.2.1.2 Parameter errors + +#### 6.3.2.1.3 Context errors + +### 6.3.2.2 Test Procedure + +``` +SET Test TO CatSelectItem. +``` + +``` +/* Test Case 1: Initialize with title */ +IF ((CatSelectItem(5, "Title", 0), SW_OK) == SW_OK) +THEN {NOP}. +``` + +``` +/* Test Case 2: Initialize without title */ +IF ((CatSelectItem(0, NULL, 0), SW_OK) == SW_OK) +THEN {NOP}. +``` + +### 6.3.2.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +### 6.3.3 CatEndSelectItem + +Test Area Reference: API\_CatEndSelectItem + +#### 6.3.3.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatEndSelectItem(BYTE *SelectedItem, const CatIconIdentifier *IconIdentifier); +``` + +##### 6.3.3.1.1 Normal execution + +CRRN1: Send a SELECT ITEM proactive command to the terminal using the current select list and the indicated icon; return the item picked in SelectedItem. + +CRNN2: If SelectedItem is null, the invocation is for the return value only. + +CRNN3: If there is no current select list or if no items have been added to the current select list, the invocation does not send a proactive command to the terminal but rather returns CAT\_SUCCESS and sets \*SelectedItem to zero if SelectedItem is non-null. + +##### 6.3.3.1.2 Parameter errors + +### 6.3.3.1.3 Context errors + +## 6.3.3.2 Test Procedure + +``` + +SET Test TO CatEndSelectItem. + +/* Test Case 1: Non-null select list and non-null select item */ +IF ((CatSelectItem(4, "Pick", 0), SW_OK) == SW_OK) +AND ((CatAddItem(1, "1", 0), SW_OK) == SW_OK) +AND ((CatAddItem(1, "2", 0), SW_OK) == SW_OK) +THEN {CatEndSelectItem(buffer, NULL) == CAT_COMMAND_SUCCESSFUL} +AND {memcmp(proactiveCommandBuffer, endSelectItem, sizeof(endSelectItem)) == 0}. + +/* Test Case 2: Null select item */ +IF ((CatSelectItem(4, "Pick", 0), SW_OK) == SW_OK) +AND ((CatAddItem(1, "1", 0), SW_OK) == SW_OK) +AND ((CatAddItem(1, "2", 0), SW_OK) == SW_OK) +THEN {CatEndSelectItem(buffer, NULL) == CAT_COMMAND_SUCCESSFUL} +AND {memcmp(proactiveCommandBuffer, endSelectItem, sizeof(endSelectItem)) == 0}. + +/* Test Case 3: Null select list */ +IF {CatEndSelectItem(NULL, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. + +``` + +### 6.3.3.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | +| N3 | 3 | + +## 6.3.4 CatDisplayText + +Test Area Reference: API\_CatDisplayText + +### 6.3.4.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` + +CatGeneralResult CatDisplayText(CatDCSValue TextDCS, BYTE TextLength, const void *Text, + CatDisplayTextOptions Options, const CatIconIdentifier *IconIdentifier, + BYTE ImmediateResponse); + +``` + +#### 6.3.4.1.1 Normal execution + +CRRN1: Send a DISPLAY TEXT proactive command to the terminal with the provided text with the provided options and icon. + +CRRN2: If TextLength is zero or Text is null, the invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.3.4.1.2 Parameter errors + +#### 6.3.4.1.3 Context errors + +### 6.3.4.2 Test Procedure + +``` + +SET Test TO CatDisplayText. + +``` + +``` + +/* Test Case 1: Non-null text and non-null text length */ +IF {CatDisplayText(DCS_UCS2, 12, "Hello, world", + NORMAL_PRIORITY_AUTO_CLEAR, NULL, 0) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, displayText, sizeof(displayText)) == 0}. + +/* Test Case 2: Zero length text */ +IF {CatDisplayText(DCS_UCS2, 0, "Hello, world", + NORMAL_PRIORITY_AUTO_CLEAR, NULL, 0) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. + +/* Test Case 3: Null text */ +IF {CatDisplayText(DCS_UCS2, 0, NULL, + NORMAL_PRIORITY_AUTO_CLEAR, NULL, 0) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. + +``` + +### 6.3.4.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2, 3 | + +## 6.3.5 CatGetInKey + +Test Area Reference: API\_CatGetInKey + +### 6.3.5.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` + +CatGeneralResult CatGetInKey(CatDCSValue TitleDCS, BYTE TitleLength, const void *Title, + CatGetInKeyOptions Options, const CatIconIdentifier *IconIdentifier, + CatDCSValue *DCSOut, void *KeyOut); + +``` + +#### 6.3.5.1.1 Normal execution + +- CRRN1: Send a GET IN KEY proactive command to the terminal with the text in Title and according to the provided Options; return a key value in \*KeyOut and the alphabet indicator of the key value in \*DCSOut. +- CRRN2: If TitleLength is zero or Title is null, then no title is included in the proactive command. +- CRRN3: If KeyOut is null, then no key value is returned. +- CRRN4: If DCSOut is null, then no key value alphabet indicator is returned. + +#### 6.3.5.1.2 Parameter errors + +#### 6.3.5.1.3 Context errors + +### 6.3.5.2 Test Procedure + +SET Test TO CatGetInKey. + +``` + +/* Test Case 1: All arguments non-null */ +IF {CatGetInKey(DCS_UCS2, 9, "Hit a Key", 0, NULL, &bytes, buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getInKey1, sizeof(getInKey1)) == 0}. + +/* Test Case 2: Text null */ +IF {CatGetInKey(DCS_UCS2, 0, NULL, 0, NULL, &bytes, buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getInKey2, sizeof(getInKey2)) == 0}. + +/* Test Case 3: Key out null */ +IF {CatGetInKey(DCS_UCS2, 9, "Hit a Key", 0, NULL, &bytes, NULL) == CAT_COMMAND_SUCCESSFUL} + +``` + +``` + +THEN {memcmp(proactiveCommandBuffer, getInKey1, sizeof(getInKey1)) == 0}. + +/* Test Case 4: DCS out null */ +IF {CatGetInKey(DCS_UCS2, 9, "Hit a Key", 0, NULL, NULL, buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getInKey1, sizeof(getInKey1)) == 0}. + +``` + +### 6.3.5.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | +| N3 | 3 | +| N4 | 4 | + +## 6.3.6 CatGetInput + +Test Area Reference: API\_CatGetInput + +### 6.3.6.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` + +CatGeneralResult CatGetInput(CatDCSValue TitleDCS, BYTE TitleLength, const void *Title, + CatGetInputOptions Options, CatDCSValue DefaultReplyDCS, + BYTE DefaultReplyLength, const void *DefaultReply, + BYTE MinimumResponseLength, BYTE MaximumResponseLength, + const CatIconIdentifier *IconIdentifier, + CatDCSValue *MsgOutDCS, BYTE *MsgOutLength, void *MsgOut); + +``` + +#### 6.3.6.1.1 Normal execution + +- CRRN1: Send a GET INPUT proactive command to the terminal with the provided Title and acquire a sequence of key hits according to Options, MinimumResponseLength and MaximumResponseLength; return the MsgOutLength length sequence in MsgOut and the alphabet indicator of the returned values in MsgOutDCS. +- CRRN2: If TitleLength is zero or Title is null then no title is displayed. +- CRRN3: If MsgOut is null, then the sequence is not returned. +- CRRN4: If MsgOutDCS is null, then no alphabet indicator is returned. +- CRRN5: If MinimumResponseLength is greater than MaximumResponseLength then it is taken to be equal to MaximumResponseLength. + +#### 6.3.6.1.2 Parameter errors + +#### 6.3.6.1.3 Context errors + +### 6.3.6.2 Test Procedure + +SET Test TO CatGetInput. + +``` + +/* Test Case 1: All arguments non-null */ +IF {CatGetInput(DCS_UCS2, 4, "Pick", 0, DCS_UCS2, 5, buffer, + 1, 10, NULL, &dcs, &bytes, buffer)== CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getInput1, sizeof(getInput1)) == 0}. + +/* Test Case 2: Text null */ +IF {CatGetInput(DCS_UCS2, 0, NULL, 0, DCS_UCS2, 5, buffer, + 1, 10, NULL, &dcs, &bytes, buffer)== CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getInput2, sizeof(getInput2)) == 0}. + +``` + +``` + +/* Test Case 3: Message out null */ +IF {CatGetInput(DCS_UCS2, 4, "Pick", 0, DCS_UCS2, 5, buffer, + 1, 10, NULL, &dcs, &bytes, NULL)== CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getInput1, sizeof(getInput1)) == 0}. + +/* Test Case 4: DCS out null */ +IF {CatGetInput(DCS_UCS2, 4, "Pick", 0, DCS_UCS2, 5, buffer, + 1, 10, NULL, NULL, &bytes, buffer)== CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getInput1, sizeof(getInput1)) == 0}. + +/* Test Case 5: Maximum response length < Minimum response length */ +IF {CatGetInput(DCS_UCS2, 4, "Pick", 0, DCS_UCS2, 5, buffer, + 10, 1, NULL, &dcs, &bytes, buffer)== CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getInput3, sizeof(getInput3)) == 0}. + +``` + +### 6.3.6.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | +| N3 | 3 | +| N4 | 4 | +| N5 | 5 | + +## 6.3.7 CatSetupIdleModeText + +Test Area Reference: API\_CatSetupIdleModeText + +### 6.3.7.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` + +CatGeneralResult CatSetupIdleModeText(CatDCSValue TextDCS, BYTE TextLength, const void *Text, +const CatIconIdentifier *IconIdentifier); + +``` + +#### 6.3.7.1.1 Normal execution + +CRRN1: Send a SETUP IDLE MODE TEXT proactive command to the terminal with Text in the indicated alphabet and with an optional icon. + +CRRN2: If TextLength is zero or Text is null, then the invocation is a NOP. + +#### 6.3.7.1.2 Parameter errors + +#### 6.3.7.1.3 Context errors + +### 6.3.7.2 Test Procedure + +SET Test TO CatSetupIdleModeText. + +``` + +/* Test Case 1: All arguments non-null */ +IF {CatSetupIdleModeText(DCS_UCS2, 3, "MMS", NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, setupIdleModeText1, sizeof(setupIdleModeText1)) == 0}. + +/* Test Case 2: Text null */ +IF {CatSetupIdleModeText(DCS_UCS2, 3, NULL, NULL)== CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, setupIdleModeText2, sizeof(setupIdleModeText2)) == 0}. + +/* Test Case 3: Length null */ +IF {CatSetupIdleModeText(DCS_UCS2, 0, "MMS", NULL)== CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, setupIdleModeText3, sizeof(setupIdleModeText3)) == 0}. + +``` + +### 6.3.7.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2, 3 | + +## 6.3.8 CatPlayTone + +Test Area Reference: API\_CatPlayTone + +### 6.3.8.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatPlayTone(BYTE TextLength, const void *Text, + CatTone Tone, CatTimeUnit Units, BYTE Duration, + const CatIconIdentifier *IconIdentifier); +``` + +#### 6.3.8.1.1 Normal execution + +CRRN1: Send a PLAY TONE proactive command to the terminal with the provided data. + +CRRN2: If Duration is zero, the invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.3.8.1.2 Parameter errors + +#### 6.3.8.1.3 Context errors + +### 6.3.8.2 Test Procedure + +``` +SET Test TO CatPlayTone. +``` + +``` +/* Test Case 1: Duration positive, text non-null */ +IF {CatPlayTone(4, "Beep", GENERAL_BEEP, GSM_SECONDS, 5, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, playTone1, sizeof(playTone1)) == 0}. +``` + +``` +/* Test Case 2: Duration positive, text null */ +IF {CatPlayTone(0, NULL, GENERAL_BEEP, GSM_SECONDS, 5, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, playTone2, sizeof(playTone2)) == 0}. +``` + +``` +/* Test Case 3: Duration zero */ +IF {CatPlayTone(4, "Beep", GENERAL_BEEP, GSM_SECONDS, 0, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, playTone3, sizeof(playTone3)) == 0}. +``` + +### 6.3.8.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1, 2 | +| N2 | 3 | + +## 6.4 Timers + +### 6.4.1 CatGetTimer + +Test Area Reference: API\_CatGetTimer + +#### 6.4.1.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +BYTE CatGetTimer(void); +``` + +##### 6.4.1.1.1 Normal execution + +CRRN1: Send a GET TIMER proactive command to the terminal; return a timer index. + +##### 6.4.1.1.2 Parameter errors + +##### 6.4.1.1.3 Context errors + +#### 6.4.1.2 Test Procedure + +``` +SET Test TO CatGetTimer. +``` + +``` +/* Test Case 1: Acquire a timer */ +IF ((CatGetTimer(), CAT_COMMAND_SUCCESSFUL) == CAT_COMMAND_SUCCESSFUL) +THEN {memcmp(proactiveCommandBuffer, getTimer, sizeof(getTimer)) == 0}. +``` + +#### 6.4.1.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +### 6.4.2 CatFreeTimer + +Test Area Reference: API\_CatFreeTimer + +#### 6.4.2.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatFreeTimer(BYTE TimerID); +``` + +##### 6.4.2.1.1 Normal execution + +CRRN1: Send a FREE TIMER proactive command to the terminal with the provided timer index. + +##### 6.4.2.1.2 Parameter errors + +##### 6.4.2.1.3 Context errors + +### 6.4.2.2 Test Procedure + +SET Test TO CatFreeTimer. + +``` +/* Test Case 1: Free a timer */ +IF {(bytes = CatGetTimer(), CAT_COMMAND_SUCCESSFUL) == CAT_COMMAND_SUCCESSFUL} +AND {(CatFreeTimer((BYTE)bytes), CAT_COMMAND_SUCCESSFUL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, freeTimer, sizeof(freeTimer)) == 0}. +``` + +### 6.4.2.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.4.3 CatStartTimer + +Test Area Reference: API\_CatStartTimer + +### 6.4.3.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatStartTimer(BYTE TimerID, CatTimerValue *TimerValue); +``` + +#### 6.4.3.1.1 Normal execution + +CRRN1: Send a START TIMER proactive command to the terminal with the provided data. + +CRRN2: If TimerValue is null, the invocation is a NOP. + +#### 6.4.3.1.2 Parameter errors + +#### 6.4.3.1.3 Context errors + +### 6.4.3.2 Test Procedure + +SET Test TO CatStartTimer. + +``` +/* Test Case 1: Start a timer */ +IF {(bytes = CatGetTimer(), CAT_COMMAND_SUCCESSFUL) == CAT_COMMAND_SUCCESSFUL} +AND {(CatStartTimer((BYTE)bytes, &duration), CAT_COMMAND_SUCCESSFUL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, startTimer, sizeof(startTimer)) == 0}. +``` + +``` +/* Test Case 2: Null duration */ +IF {(bytes = CatGetTimer(), CAT_COMMAND_SUCCESSFUL) == CAT_COMMAND_SUCCESSFUL} +AND {(CatStartTimer((BYTE)bytes, NULL), CAT_COMMAND_SUCCESSFUL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. +``` + +### 6.4.3.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.4.4 CatGetTimerValue + +Test Area Reference: API\_CatGetTimerValue + +#### 6.4.4.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatGetTimerValue(BYTE TimerID, CatTimerValue *TimerValue); +``` + +##### 6.4.4.1.1 Normal execution + +CRRN1: Send a GET TIMER VALUE to the terminal; return a timer value in \*TimerValue if TimerValue is non-null. + +CRRN2: If TimerValue is null, the invocation is a NOP. + +##### 6.4.4.1.2 Parameter errors + +##### 6.4.4.1.3 Context errors + +#### 6.4.4.2 Test Procedure + +``` +SET Test TO CatGetTimerValue. +``` + +``` +/* Test Case 1: Get a timer value */ +IF {(bytes = CatGetTimer(), CAT_COMMAND_SUCCESSFUL) == CAT_COMMAND_SUCCESSFUL} +AND {(CatGetTimerValue((BYTE)bytes, &duration), CAT_COMMAND_SUCCESSFUL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getTimerValue, sizeof(getTimerValue)) == 0}. + +/* Test Case 2: Null duration */ +IF {(bytes = CatGetTimer(), CAT_COMMAND_SUCCESSFUL) == CAT_COMMAND_SUCCESSFUL} +AND {(CatGetTimerValue((BYTE)bytes, NULL), CAT_COMMAND_SUCCESSFUL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. +``` + +#### 6.4.4.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +### 6.5 Supplementary Card Reader Management + +#### 6.5.1 CatPowerOnCard + +Test Area Reference: API\_CatPowerOnCard + +##### 6.5.1.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatPowerOnCard(CatDevice DeviceID, BYTE *ATRLength, void *ATR); +``` + +##### 6.5.1.1.1 Normal execution + +CRRN1: Send a POWER ON CARD proactive command to the terminal with the provided data; return the ATR of the card in the indicated card reader in ATR. + +CRRN2: If either ATRLength or ATR is null, then the proactive command is issued but the ATR is not returned. + +#### 6.5.1.1.2 Parameter errors + +#### 6.5.1.1.3 Context errors + +### 6.5.1.2 Test Procedure + +SET Test TO CatPowerOnCard. + +``` +/* Test Case 1: Power on a card */ +IF {CatPowerOnCard(DEVICE_CARD_READER_7, (BYTE *)&bytes, buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, powerOnCard, sizeof(powerOnCard)) == 0}. + +/* Test Case 2: ATR null */ +IF {CatPowerOnCard(DEVICE_CARD_READER_7, (BYTE *)&bytes, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, powerOnCard, sizeof(powerOnCard)) == 0}. + +/* Test Case 3: ATR length null */ +IF {CatPowerOnCard(DEVICE_CARD_READER_7, NULL, buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, powerOnCard, sizeof(powerOnCard)) == 0}. +``` + +#### 6.5.1.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2, 3 | + +## 6.5.2 CatPowerOffCard + +Test Area Reference: API\_CatPowerOffCard + +### 6.5.2.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatPowerOffCard(CatDevice DeviceID); +``` + +#### 6.5.2.1.1 Normal execution + +CRRN1: Send a POWER OFF CARD proactive command to the terminal. + +#### 6.5.2.1.2 Parameter errors + +#### 6.5.2.1.3 Context errors + +### 6.5.2.2 Test Procedure + +SET Test TO CatPowerOffCard. + +``` +/* Test Case 1: Power off a card */ +IF {CatPowerOffCard(DEVICE_CARD_READER_7) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, powerOffCard, sizeof(powerOffCard)) == 0}. +``` + +### 6.5.2.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.5.3 CatPerformCardAPDU + +Test Area Reference: API\_CatPerformCardAPDU + +### 6.5.3.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatPerformCardAPDU(CatDevice DeviceID, + BYTE CAPDULength, const void *CAPDU, + BYTE *RAPDULength, void *RAPDU); +``` + +#### 6.5.3.1.1 Normal execution + +CRRN1: Send a PERFORM CARD APDU command to the terminal with the provided data; return the response of the card at RAPDU. + +CRRN2: If RAPDULength or RAPDU is null, the response of the card in the indicated card reader is not returned. + +#### 6.5.3.1.2 Parameter errors + +#### 6.5.3.1.3 Context errors + +### 6.5.3.2 Test Procedure + +``` +SET Test TO CatPerformCardAPDU +AND CAPDU TO {0x00, 0xA4, 0x00, 0x00, 0x02, 0x3F, 0x00}. + +/* Test Case 1: Perform card APDU */ +IF {CatPerformCardAPDU(DEVICE_CARD_READER_7, + sizeof(CAPDU), CAPDU, (BYTE *)(&bytes), buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, performCardAPDU, sizeof(performCardAPDU)) == 0}. + +/* Test Case 2: Null RAPDU length */ +IF {CatPerformCardAPDU(DEVICE_CARD_READER_7, + sizeof(CAPDU), CAPDU, NULL, buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, performCardAPDU, sizeof(performCardAPDU)) == 0}. + +/* Test Case 3: NULL RAPDU */ +IF {CatPerformCardAPDU(DEVICE_CARD_READER_7, + sizeof(CAPDU), CAPDU, (BYTE *)(&bytes), NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, performCardAPDU, sizeof(performCardAPDU)) == 0}. +``` + +### 6.5.3.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2, 3 | + +## 6.5.4 CatGetReaderStatus + +Test Area Reference: API\_CatGetReaderStatus + +### 6.5.4.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatGetReaderStatus(CatDevice DeviceID, CatReaderStatusOptions Options, + BYTE *Status); +``` + +#### 6.5.4.1.1 Normal execution + +CRRN1: Send a GET READER STATUS proactive command with the provided data to the terminal; return the status of the indicated device at Status. + +CRRN2: If Status is null then the invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.5.4.1.2 Parameter errors + +#### 6.5.4.1.3 Context errors + +### 6.5.4.2 Test Procedure + +``` +SET Test TO CatGetReaderStatus. +``` + +``` +/* Test Case 1: Perform card APDU */ +IF {CatGetReaderStatus(DEVICE_CARD_READER_7, 0, buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getReaderStatus, sizeof(getReaderStatus)) == 0}. + +/* Test Case 2: Null status */ +IF {CatGetReaderStatus(DEVICE_CARD_READER_7, 0, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getReaderStatus, sizeof(getReaderStatus)) == 0}. +``` + +### 6.5.4.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.6 Network Services + +### 6.6.1 CatGetLocationInformation + +Test Area Reference: API\_CatGetLocationInformation + +#### 6.6.1.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatGetLocationInformation(CatLocationInformation *LocationInformation); +``` + +#### 6.6.1.1.1 Normal execution + +CRRN1: Send a PROVIDE LOCAL INFORMATION proactive command to the terminal; return the retrieved local information in LocationInformation. + +CRRN2: If LocationInformation is null, the invocation is a NOP that returns CAT\_SUCCESS. + +## 6.6.1.1.2 Parameter errors + +## 6.6.1.1.3 Context errors + +## 6.6.1.2 Test Procedure + +``` + +SET Test TO CatGetLocationInformation. + +/* Test Case 1: Get location information */ +IF {CatGetLocationInformation( &locationInformation) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getLocationInformation, sizeof(getLocationInformation)) == 0}. + +/* Test Case 2: Null location information */ +IF {CatGetLocationInformation(NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. + +``` + +## 6.6.1.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.6.2 CatGetTimingAdvance + +Test Area Reference: API\_CatGetTimingAdvance + +## 6.6.2.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatGetTimingAdvance(CatTimingAdvance *TimingAdvance); +``` + +## 6.6.2.1.1 Normal execution + +CRRN1: Send a PROVIDE LOCAL INFORMATION proactive command to the terminal to retrieve the timing advance information; return the retrieved timing advance information at TimingAdvance. + +CRRN2: If TimingAdvance is null, the invocation is a NOP that returns CAT\_SUCCESS. + +## 6.6.2.1.2 Parameter errors + +## 6.6.2.1.3 Context errors + +## 6.6.2.2 Test Procedure + +``` + +SET Test TO CatGetTimingAdvance. + +/* Test Case 1: Get timing advance */ +IF {CatGetTimingAdvance(&timingAdvance) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getTimingAdvance, sizeof(getTimingAdvance)) == 0}. + +/* Test Case 2: Null timing advance */ +IF {CatGetTimingAdvance(NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. + +``` + +### 6.6.2.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.6.3 CatGetIMEI + +Test Area Reference: API\_CatGetIMEI + +### 6.6.3.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatGetIMEI (BYTE IMEI[8]); +``` + +#### 6.6.3.1.1 Normal execution + +CRRN1: Send a PROVIDE LOCAL INFORMATION proactive command to the terminal to retrieve the IMEI; return the retrieved IMEI in IMEI. + +CRRN2: If IMEI is null, the invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.6.3.1.2 Parameter errors + +#### 6.6.3.1.3 Context errors + +### 6.6.3.2 Test Procedure + +``` +SET Test TO CatGetIMEI. + +/* Test Case 1: Get IMEI */ +IF {CatGetIMEI(buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getIMEI, sizeof(getIMEI)) == 0}. + +/* Test Case 2: Null IMEI */ +IF {CatGetIMEI(NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. +``` + +### 6.6.3.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.6.4 CatGetNetworkMeasurementResults + +Test Area Reference: API\_CatGetNetworkMeasurementResults + +### 6.6.4.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatGetNetworkMeasurementResults (BYTE MeasurementResults[10]); +``` + +#### 6.6.4.1.1 Normal execution + +CRRN1: Send a PROVIDE LOCAL INFORMATION proactive command to the terminal to retrieve the measurement results; return the retrieved measurement results in MeasurementResults. + +CRRN2: If MeasurementResults is null, the invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.6.4.1.2 Parameter errors + +#### 6.6.4.1.3 Context errors + +### 6.6.4.2 Test Procedure + +``` +SET Test TO CatGetNetworkMeasurementResults. + +/* Test Case 1: Get network measurement results */ +IF {CatGetNetworkMeasurementResults(buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getNetworkMeasurementResults, +sizeof(getNetworkMeasurementResults)) == 0}. + +/* Test Case 2: Null network measurement results */ +IF {CatGetNetworkMeasurementResults(NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. +``` + +#### 6.6.4.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +### 6.6.5 CatGetDateTimeAndTimeZone + +Test Area Reference: API\_CatGetDateTimeAndTimeZone + +#### 6.6.5.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatGetDateTimeAndTimeZone (BYTE DateTimeAndTimeZone[7]); +``` + +##### 6.6.5.1.1 Normal execution + +CRRN1: Send a PROVIDE LOCAL INFORMATION proactive command to the terminal to retrieve the date, time and time zone; return the retrieved date, time and time zone in DateTimeAndTimeZone. + +CRRN2: If DateTimeAndTimeZone is null, the invocation is a NOP that returns CAT\_SUCCESS. + +##### 6.6.5.1.2 Parameter errors + +##### 6.6.5.1.3 Context errors + +#### 6.6.5.2 Test Procedure + +``` +SET Test TO CatGetDateTimeAndTimeZone. +``` + +``` + +/* Test Case 1: Get date, time and time zone */ +IF {CatGetDateTimeAndTimeZone(buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getDateTimeAndTimeZone, sizeof(getDateTimeAndTimeZone)) == 0}. + +/* Test Case 2: Null date, time and time zone */ +IF {CatGetDateTimeAndTimeZone(NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. + +``` + +### 6.6.5.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.6.6 CatGetLanguage + +Test Area Reference: API\_CatGetLanguage + +### 6.6.6.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatGetLanguage(BYTE Language[2]); +``` + +#### 6.6.6.1.1 Normal execution + +CRRN1: Send a PROVIDE LOCAL INFORMATION proactive command to the terminal to retrieve the current language selection; return the retrieved language selection in Language. + +CRRN2: If Language is null, the invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.6.6.1.2 Parameter errors + +#### 6.6.6.1.3 Context errors + +### 6.6.6.2 Test Procedure + +SET Test TO CatGetLanguage. + +``` + +/* Test Case 1: Get language */ +IF {CatGetLanguage(buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getLanguage, sizeof(getLanguage)) == 0}. + +/* Test Case 2: Null language */ +IF {CatGetLanguage(NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP} + +``` + +### 6.6.6.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.6.7 CatSetupCall + +Test Area Reference: API\_CatSetupCall + +### 6.6.7.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatSetupCall(BYTE UserConfirmationMessageLength, + const void *UserConfirmationMessage, + CatTypeOfNumberAndNumberingPlanIdentifier TONandNPI, + BYTE DiallingNumberLength, const void *DiallingNumber, + CatSetupCallOptions Options, + const CatIconIdentifier *UserConfirmationIconIdentifier, + BYTE CallSetupMessageLength, const void *CallSetupMessage, + const CatIconIdentifier *CallSetupIconIdentifier); +``` + +#### 6.6.7.1.1 Normal execution + +CRRN1: Send a SETUP CALL proactive command to the terminal with the provided data. + +#### 6.6.7.1.2 Parameter errors + +- CRRP1: If DiallingNumberLength is zero or Dialling Number is null, the status word CAT\_REQUIRED\_VALUES\_MISSING is returned. + +#### 6.6.7.1.3 Context errors + +### 6.6.7.2 Test Procedure + +SET Test TO CatSetUpCall. + +``` +/* Test Case 1: Set up call */ +IF {CatSetupCall(3, "AOK", TON_UNKNOWN_AND_NPI_UNKNOWN, 12, "+155512345678", + 0, NULL, 10, "Calling...", NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, setUpCall, sizeof(setUpCall)) == 0}. + +/* Test Case 2: Null dialing number */ +IF {CatSetupCall(3, "AOK", TON_UNKNOWN_AND_NPI_UNKNOWN, 0, NULL, + 0, NULL, 10, "Calling...", NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. +``` + +### 6.6.7.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| P1 | 2 | + +### 6.6.8 CatSendShortMessage + +Test Area Reference: API\_CatSendShortMessage + +#### 6.6.8.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatSendShortMessage(BYTE TitleLength, const void *Title, + CatTypeOfNumberAndNumberingPlanIdentifier TONandNPI, + BYTE AddressLength, const void *Address, + BYTE SmstPDULength, const void *SmstPDU, + CatSendShortMessageOptions Options, + const CatIconIdentifier *IconIdentifier); +``` + +#### 6.6.8.1.1 Normal execution + +CRRN1: Send a SEND SHORT MESSAGE proactive command to the terminal with the provided data. + +#### 6.6.8.1.2 Parameter errors + +- CRRP1: If AddressLength is zero or Address is null, the value CAT\_REQUIRED\_VALUES\_MISSING is returned. +- CRRP2: If SmstpduLength is zero or Smstpdu is null, the value CAT\_REQUIRED\_VALUES\_MISSING is returned. + +#### 6.6.8.1.3 Context errors + +### 6.6.8.2 Test Procedure + +``` +SET Test TO CatSendShortMessage +AND Smstpdu TO {0x00, 0x01, 0x02, 0x03}. + +/* Test Case 1: Send short message */ +IF {CatSendShortMessage(3, "SMS", TON_UNKNOWN_AND_NPI_UNKNOWN, 12, "+155512345678", + (BYTE)sizeof(Smstpdu), Smstpdu, 0, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, sendShortMessage, sizeof(sendShortMessage)) == 0}. + +/* Test Case 2: Null dialing number */ +IF {CatSendShortMessage(3, "SMS", TON_UNKNOWN_AND_NPI_UNKNOWN, 0, NULL, + (BYTE)sizeof(Smstpdu), Smstpdu, 0, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. + +/* Test Case 3: Null SMS */ +IF {CatSendShortMessage(3, "SMS", TON_UNKNOWN_AND_NPI_UNKNOWN, 12, "+155512345678", + 0, NULL, 0, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, sendShortMessage, sizeof(sendShortMessage)) == 0}. +``` + +#### 6.6.8.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| P1 | 2 | +| P2 | 3 | + +### 6.6.9 CatSendSS + +Test Area Reference: API\_CatSendSS + +#### 6.6.9.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatSendSS(BYTE TitleLength, const void *Title, + CatTypeOfNumberAndNumberingPlanIdentifier TONandNPI, + BYTE SSStringLength, const void *SSString, + const CatIconIdentifier *IconIdentifier); +``` + +##### 6.6.9.1.1 Normal execution + +- CRRN1: Send a SEND SS proactive command to the terminal with the provided data. +- CRRN2: If SSStringLength is zero or SSString is null, the invocation is a NOP that returns CAT\_SUCCESS. + +##### 6.6.9.1.2 Parameter errors + +### 6.6.9.1.3 Context errors + +### 6.6.9.2 Test Procedure + +``` +SET Test TO CatSendSS +AND SSString TO {0x00, 0x01, 0x02, 0x03}. + +/* Test Case 1: Send SS */ +IF {CatSendSS(2, "SS", TON_UNKNOWN_AND_NPI_UNKNOWN, + (BYTE)sizeof(SSString), SSString, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, sendSS, sizeof(sendSS)) == 0}. + +/* Test Case 2: Null SS */ +IF {CatSendSS(2, "SS", TON_UNKNOWN_AND_NPI_UNKNOWN, + 0, NULL, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. +``` + +### 6.6.9.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.6.10 CatSendUSSD + +Test Area Reference: API\_CatSendUSSD + +### 6.6.10.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatSendUSSD(BYTE TitleLength, const void *Title, + CatDCSValue MessageDCS, BYTE MessageLength, const void *Message, + CatDCSValue *MsgOutDCS, BYTE *MsgOutLength, void *MsgOut, + const CatIconIdentifier *IconIdentifier); +``` + +#### 6.6.10.1.1 Normal execution + +CRRN1: Send a SEND USSD proactive command to the terminal with the provided data. + +CRRN2: If MessageLength is zero or Message is null, the invocation is a NOP that returns CAT\_SUCCESS. + +CRRN3: If MsgOutDCS, MsgOutLength or MsgOut is null, only the CatGeneralResult return value of execution the function is returned. + +#### 6.6.10.1.2 Parameter errors + +#### 6.6.10.1.3 Context errors + +### 6.6.10.2 Test Procedure + +``` +SET Test TO CatSendUSSD +AND SSString TO {0x00, 0x01, 0x02, 0x03}. + +/* Test Case 1: Send SS */ +IF {CatSendUSSD(4, "USSD", DCS_UCS2, 4, "Time", &dcS, (BYTE*)&bytes, buffer, NULL) == + CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, sendUSSD1, sizeof(sendUSSD1)) == 0}. +``` + +``` + +/* Test Case 2: Null USSD */ +IF {CatSendUSSD(0, NULL, DCS_UCS2, 4, "Time", &dc, (BYTE*)&bytes, buffer, NULL) == +CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. + +/* Test Case 3: Null response */ +IF {CatSendUSSD(4, "USSD", DCS_UCS2, 4, "Time", NULL, NULL, NULL, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, sendUSSD2, sizeof(sendUSSD2)) == 0}. + +``` + +### 6.6.10.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | +| N3 | 3 | + +## 6.6.11 CatOpenCSChannel + +Test Area Reference: API\_CatOpenCSChannel + +### 6.6.11.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` + +CatGeneralResult CatOpenCSChannel(CatOpenChannelOptions Options, + BYTE UserConfirmationLength, const void *UserConfirmation, + const CatIconIdentifier *UserConfirmationIconIdentifier, + CatTypeOfNumberAndNumberingPlanIdentifier TONandNPI, + BYTE DiallingNumberLength, const void *DiallingNumber, + BYTE BearerDescription[3], WORD *BufferSize, CatDevice *ChannelIdentifier); + +``` + +#### 6.6.11.1.1 Normal execution + +CRRN1: Send an OPEN CHANNEL proactive command to the terminal that opens a circuit switched channel. + +#### 6.6.11.1.2 Parameter errors + +- CRRP1: If DiallingNumberLength is zero or Dialling Number is null, the status word CAT\_REQUIRED\_VALUES\_MISSING is returned. + +#### 6.6.11.1.3 Context errors + +### 6.6.11.2 Test Procedure + +``` + +SET Test TO CatOpenCSChannel +AND bearer TO {0x00, 0x01, 0x02}. + +``` + +``` + +/* Test Case 1: Open circuit channel */ +IF {CatOpenCSChannel(OPEN_CHANNEL_ON_DEMAND, 2, "OK", NULL, TON_UNKNOWN_AND_NPI_UNKNOWN, + 12, "+155512345678", bearer, (WORD *)&bytes, &device) == +CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, openCSChannel, sizeof(openCSChannel)) == 0}. + +/* Test Case 2: Null dialing number */ +IF {CatOpenCSChannel(OPEN_CHANNEL_ON_DEMAND, 2, "OK", NULL, TON_UNKNOWN_AND_NPI_UNKNOWN, + 12, "+155512345678", bearer, (WORD *)&bytes, &device) == +CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. + +``` + +### 6.6.11.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| P1 | 2 | + +## 6.6.12 CatOpenGPRSChannel + +Test Area Reference: API\_CatOpenGPRSChannel + +### 6.6.12.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatOpenGPRSChannel(CatOpenChannelOptions Options, + BYTE UserConfirmationLength, const void *UserConfirmation, + const CatIconIdentifier *UserConfirmationIconIdentifier, + BYTE BearerDescription[8], WORD *BufferSize, CatDevice *ChannelIdentifier); +``` + +#### 6.6.12.1.1 Normal execution + +CRRN1: Send an OPEN CHANNEL proactive command with the provided data to the terminal that opens a GPRS channel. + +#### 6.6.12.1.2 Parameter errors + +#### 6.6.12.1.3 Context errors + +### 6.6.12.2 Test Procedure + +``` +SET Test TO CatOpenGPRSChannel +AND bearer TO {0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07}. + +/* Test Case 1: Open GPRS channel */ +IF {CatOpenGPRSChannel(OPEN_CHANNEL_ON_DEMAND, 2, "OK", NULL, + bearer, (WORD *)&bytes, &device) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, openGPRSChannel, sizeof(openGPRSChannel)) == 0}. +``` + +### 6.6.12.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.6.13 CatCloseChannel + +Test Area Reference: API\_CatCloseChannel + +### 6.6.13.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatCloseChannel(CatDevice ChannelIdentifier, + BYTE TitleLength, const void *Title, + const CatIconIdentifier *IconIdentifier); +``` + +#### 6.6.13.1.1 Normal execution + +CRRN1: Send a CLOSE CHANNEL proactive command with the provided data to the terminal. + +#### 6.6.13.1.2 Parameter errors + +#### 6.6.13.1.3 Context errors + +### 6.6.13.2 Test Procedure + +SET Test TO CatCloseChannel. + +``` +/* Test Case 1: Close channel */ +IF {CatCloseChannel(DEVICE_CHANNEL_1, 3, "Bye", NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, closeChannel, sizeof(closeChannel)) == 0}. +``` + +#### 6.6.13.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +### 6.6.14 CatReceiveData + +Test Area Reference: API\_CatReceiveData + +#### 6.6.14.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatReceiveData(CatDevice ChannelIdentifier, + BYTE TitleLength, const void *Title, BYTE RequestedChannelDataLength, + const CatIconIdentifier *IconIdentifier, + BYTE *ChannelData, BYTE *NumChannelBytesRead, BYTE *NumChannelBytesLeft); +``` + +#### 6.6.14.1.1 Normal execution + +CRRN1: Send a RECEIVE DATA proactive command to the terminal with the provided data. + +CRRN2: If ChannelData or NumChannelBytesRead is null, the number of bytes available for reception on the channel is returned at NumChannelBytesLeft. + +CRRN3: If NumChannelBytesLeft is null, the invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.6.14.1.2 Parameter errors + +#### 6.6.14.1.3 Context errors + +### 6.6.14.2 Test Procedure + +SET Test TO CatReceiveData. + +``` +/* Test Case 1: Receive data */ +IF {CatReceiveData(DEVICE_CHANNEL_1, 8, "Incoming", 10, NULL, + buffer, (BYTE *)(&bytes), (BYTE *)(&bytes)) == CAT_COMMAND_SUCCESSFUL} +``` + +``` + +THEN {memcmp(proactiveCommandBuffer, receiveData1, sizeof(receiveData1)) == 0}. + +/* Test Case 2: Null data buffer */ +IF {CatReceiveData(DEVICE_CHANNEL_1, 8, "Incoming", 10, NULL, + NULL, (BYTE *)(&bytes), (BYTE *)(&bytes)) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, receiveData2, sizeof(receiveData2)) == 0}. + +/* Test Case 3: Null bytes left */ +IF {CatReceiveData(DEVICE_CHANNEL_1, 8, "Incoming", 10, NULL, + buffer, (BYTE *)(&bytes), NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, receiveData3, sizeof(receiveData3)) == 0}. + +``` + +### 6.6.14.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | +| N3 | 3 | + +## 6.6.15 CatSendData + +Test Area Reference: API\_CatSendData + +### 6.6.15.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` + +CatGeneralResult CatSendData(CatDevice ChannelIdentifier, + CatSendDataOptions Options, BYTE TitleLength, const void *Title, + BYTE ChannelDataLength, const void *ChannelData, + const CatIconIdentifier *IconIdentifier, BYTE *ActualBytesSent); + +``` + +#### 6.6.15.1.1 Normal execution + +CRRN1: Send a SEND DATA proactive command to the terminal with the provided data; if ActualBytesSent is non-null, the number of bytes actually sent is returned in ActualBytesSent. + +CRRN2: If ChannelDataLength is zero or ChannelData is null, the invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.6.15.1.2 Parameter errors + +#### 6.6.15.1.3 Context errors + +### 6.6.15.2 Test Procedure + +SET Test TO CatSendData. + +``` + +/* Test Case 1: Receive data */ +IF {CatSendData(DEVICE_CHANNEL_1, 0, 8, "Outgoing", + 10, buffer, NULL, (BYTE *)&bytes) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, sendData1, sizeof(sendData1)) == 0}. + +/* Test Case 2: Null data buffer */ +IF {CatSendData(DEVICE_CHANNEL_1, 0, 8, "Outgoing", + 10, NULL, NULL, (BYTE *)&bytes) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. + +/* Test Case 3: Null bytes sent */ +IF {CatSendData(DEVICE_CHANNEL_1, 0, 8, "Outgoing", + 10, buffer, NULL, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, sendData2, sizeof(sendData2)) == 0}. + +``` + +### 6.6.15.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1,2 | +| N2 | 3 | + +## 6.6.16 CatGetChannelStatus + +Test Area Reference: API\_CatGetChannelStatus + +### 6.6.16.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatGetChannelStatus(CatDevice ChannelIdentifier, void *ChannelStatus); +``` + +#### 6.6.16.1.1 Normal execution + +CRRN1: Send a GET CHANNEL STATUS proactive command to the terminal; if ChannelStatus is non-null return the channel status at ChannelStatus. + +CRRN2: If ChannelStatus is null, invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.6.16.1.2 Parameter errors + +#### 6.6.16.1.3 Context errors + +### 6.6.16.2 Test Procedure + +SET Test TO CatGetChannelStatus. + +``` +/* Test Case 1: Get channel status */ +``` + +``` +IF {CatGetChannelStatus(DEVICE_CHANNEL_1, buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, sendData1, sizeof(sendData1)) == 0}. +``` + +``` +/* Test Case 2: Null status buffer */ +``` + +``` +IF {CatGetChannelStatus(DEVICE_CHANNEL_1, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {NOP}. +``` + +### 6.6.16.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.6.17 CatServiceSearch + +Test Area Reference: API\_CatServiceSearch + +### 6.6.17.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatServiceSearch(CatBearer BearerId, + BYTE AttributeLength, void *Attributes, void *ServiceAvailability); +``` + +#### 6.6.17.1.1 Normal execution + +CRRN1: Send a SERVICE SEARCH proactive command to the terminal with the provided data. + +CRRN2: If AttributeLength is zero, Attributes is null or ServiceAvailability is null, invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.6.17.1.2 Parameter errors + +#### 6.6.17.1.3 Context errors + +### 6.6.17.2 Test Procedure + +SET Test TO CatServiceSearch. + +/\* Test Case 1: Service search \*/ + +``` +IF {CatServiceSearch(BEARER_GPRS, 20, buffer, &bytes) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, serviceSearch, sizeof(serviceSearch)) == 0}. +``` + +/\* Test Case 2: Attributes null \*/ + +``` +IF {CatServiceSearch(BEARER_GPRS, 20, buffer, &bytes) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, serviceSearch, sizeof(serviceSearch)) == 0}. +``` + +/\* Test Case 3: Availability null \*/ + +``` +IF {CatServiceSearch(BEARER_GPRS, 20, buffer, &bytes) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, serviceSearch, sizeof(serviceSearch)) == 0}. +``` + +### 6.6.17.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2, 3 | + +## 6.6.18 CatGetServiceInformation + +Test Area Reference: API\_CatGetServiceInformation + +### 6.6.18.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatGetServiceInformation(BYTE TitleLength, const BYTE *Title, + const CatIconIdentifier *IconIdentifier, + BYTE BearerId, BYTE *AttributeLength, void *Attributes, + void *ServiceInformation); +``` + +#### 6.6.18.1.1 Normal execution + +CRRN1: Send a GET SERVICE INFORMATION proactive command to the terminal with the provided data. + +CRNN2: If AttributesLength, Attributes or ServiceInformation is null, the invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.6.18.1.2 Parameter errors + +#### 6.6.18.1.3 Context errors + +### 6.6.18.2 Test Procedure + +SET Test TO CatGetServiceInformation. + +/\* Test Case 1: Get service information \*/ + +``` +IF {CatGetServiceInformation(7, "Whither", NULL, BEARER_GPRS, + (BYTE *)&bytes, buffer, buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getServiceInformation, sizeof(getServiceInformation)) == 0}. +``` + +/\* Test Case 2: Attributes null \*/ + +``` +IF {CatGetServiceInformation(7, "Whither", NULL, BEARER_GPRS, + (BYTE *)&bytes, NULL, buffer) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getServiceInformation, sizeof(getServiceInformation)) == 0}. +``` + +/\* Test Case 3: Service information null \*/ + +``` +IF {CatGetServiceInformation(7, "Whither", NULL, BEARER_GPRS, + (BYTE *)&bytes, buffer, NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, getServiceInformation, sizeof(getServiceInformation)) == 0}. +``` + +| Id | Description | API Expectation | APDU Expectation | +|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|-------------------------------------------------| +| 0 | UICC Initialisation | Responses ignored. | | +| 1 | All arguments non-null
CatGeneralResult rv;
Char *title="Title";
BYTE attr[] = {1,2,3,4}, service[16];
1 - rv =
CatGetServiceInformation(strlen(title),
title,NULL, BEARER_SMS, sizeof(attr),
attr, service); | 1 - rv = CAT_SUCCESS | 1 - SERVICE
INFORMATION proactive
command | +| 2 | ServiceInformation nul
CatGeneralResult rv;
Char *title="Title";
BYTE attr[] = {1,2,3,4}, service[16];
1 - rv =
CatGetServiceInformation(strlen(title),
title,NULL, BEARER_SMS, sizeof(attr),
attr, NULL); | 1 - rv = CAT_SUCCESS | | + +### 6.6.18.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.6.19 CatDeclareService + +Test Area Reference: API\_CatDeclareService + +### 6.6.19.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatDeclareService(BYTE BearerId, BYTE ServiceId, + CatTransportProtocol TransportProtocol, + WORD *PortNumber, BYTE ServiceRecordLength, void *ServiceRecord); +``` + +#### 6.6.19.1.1 Normal execution + +CRRN1: Send a DECLARE SERVICE proactive command to the terminal with the provided data. + +CRRN2: If ServiceRecordLength is zero or PortNumber or ServiceRecord is null, the invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.6.19.1.2 Parameter errors + +#### 6.6.19.1.3 Context errors + +### 6.6.19.2 Test Procedure + +SET Test TO CatDeclareService. + +``` +/* Test Case 1: Declare service */ +``` + +``` +IF {CatDeclareService(BEARER_GPRS, 1, TRANSPORT_PROTOCOL_TCP, + (WORD *)(&bytes), 10, buffer) == CAT_COMMAND_SUCCESSFUL} +``` + +THEN {memcmp(proactiveCommandBuffer, declareService, sizeof(declareService)) == 0}. + +/\* Test Case 2: Service record null \*/ + +IF {CatDeclareService(BEARER\_GPRS, 1, TRANSPORT\_PROTOCOL\_TCP, + (WORD \*)(&bytes), 10, buffer) == CAT\_COMMAND\_SUCCESSFUL} + THEN {NOP}. + +### 6.6.19.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.6.20 CatRunATCommand + +Test Area Reference: API\_CatRunATCommand + +### 6.6.20.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatRunATCommand(BYTE TitleLength, const void *Title, + BYTE CommandLength, const void *Command, + const CatIconIdentifier *IconIdentifier, + void *Response, BYTE *ResponseLength); +``` + +#### 6.6.20.1.1 Normal execution + +- CRRN1: Send a RUN AT COMMAND proactive command to the terminal with the provided data; + \*ResponseLength bytes of the result of the command are returned in Response if both are non-null. +- CRNN2: If ResponseLength or Response is null, no results are returned. +- CRNN3: If CommandLength is zero or Command is null, invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.6.20.1.2 Parameter errors + +#### 6.6.20.1.3 Context errors + +### 6.6.20.2 Test Procedure + +SET Test TO CatRunATCommand. + +/\* Test Case 1: Run AT command \*/ + +IF {CatRunATCommand(2, "AT", 10, buffer, NULL, buffer, (BYTE \*)(&bytes)) == + CAT\_COMMAND\_SUCCESSFUL} + +THEN {memcmp(proactiveCommandBuffer, runATCommand, sizeof(runATCommand)) == 0}. + +/\* Test Case 2: Command null \*/ + +``` +IF {CatRunATCommand(2, "AT", 0, NULL, NULL, buffer, (BYTE *)(&bytes)) == +CAT_COMMAND_SUCCESSFUL} + +THEN {NOP}. +``` + +/\* Test Case 3: Response null \*/ + +``` +IF {CatRunATCommand(2, "AT", 10, buffer, NULL, NULL, NULL) == CAT_COMMAND_SUCCESSFUL} + +THEN {memcmp(proactiveCommandBuffer, runATCommand, sizeof(runATCommand)) == 0}. +``` + +### 6.6.20.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | +| N3 | 3 | + +## 6.6.21 CatSendDTMFCommand + +Test Area Reference: API\_CatSendDTMFCommand + +### 6.6.21.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatSendDTMFCommand(BYTE TitleLength, const void *Title, + BYTE DTMFCodeLength, const void *DTMFCode, + const CatIconIdentifier *IconIdentifier); +``` + +#### 6.6.21.1.1 Normal execution + +CRRN1: Send a SEND DTMF COMMAND proactive command to the terminal with the provided data. + +CRRN2: If DTMFCodeLength is zero or DTMFCode is null, the invocation is a NOP that returns CAT\_SUCCESS. + +#### 6.6.21.1.2 Parameter errors + +#### 6.6.21.1.3 Context errors + +### 6.6.21.2 Test Procedure + +SET Test TO CatSendDTMFCommand. + +/\* Test Case 1: Send DTMF command \*/ + +``` +IF {CatSendDTMFCommand(4, "DTMF", 10, buffer, NULL) == CAT_COMMAND_SUCCESSFUL} + +THEN {memcmp(proactiveCommandBuffer, sendDTMFCommand, sizeof(sendDTMFCommand)) == 0}. +``` + +/\* Test Case 2: Command null \*/ + +IF {CatSendDTMFCommand(4, "DTMF", 0, NULL, NULL) == CAT\_COMMAND\_SUCCESSFUL} +THEN {NOP}. + +### 6.6.21.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.7 Toolkit Application + +### 6.7.1 main + +Test Area Reference: API\_main + +#### 6.7.1.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +Void main(void) + +##### 6.7.1.1.1 Normal execution + +CRRN1: Load and execute the null application: main(){}. + +##### 6.7.1.1.2 Parameter errors + +##### 6.7.1.1.3 Context errors + +#### 6.7.1.2 Test Procedure + +SET Test TO main. + +/\* Test Case 1: main \*/ + +IF {(CatExit(), SW\_OK) == SW\_OK} +THEN {NOP}. + +### 6.7.1.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.7.2 CatGetFrameworkEvent + +Test Area Reference: API\_CatGetFrameworkEvent + +### 6.7.2.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatFrameworkEventType CatGetFrameworkEvent(void); +``` + +#### 6.7.2.1.1 Normal execution + +CRRN1: Return the current framework event. + +#### 6.7.2.1.2 Parameter errors + +#### 6.7.2.1.3 Context errors + +### 6.7.2.2 Test Procedure + +SET Test TO CatGetFrameworkEvent. + +``` +/* Test Case 1: Get framework event */ +``` + +``` +IF {CatGetFrameworkEvent()} +``` + +``` +THEN {NOP}. +``` + +### 6.7.2.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.7.3 CatExit + +Test Area Reference: API\_CatExit + +### 6.7.3.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatExit(void); +``` + +#### 6.7.3.1.1 Normal execution + +CRRN1: Load and execute the exit application: main(){catExit();} + +#### 6.7.3.1.2 Parameter errors + +#### 6.7.3.1.3 Context errors + +### 6.7.3.2 Test Procedure + +SET Test TO CatExit. + +``` +/* Test Case 1: CatExit */ +IF {(CatExit(), SW_OK) == SW_OK} +THEN {NOP}. +``` + +### 6.7.3.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.8 Miscellaneous + +### 6.8.1 CatGetTerminalProfile + +Test Area Reference: API\_CatGetTerminalProfile + +#### 6.8.1.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatGetTerminalProfile(BYTE *ProfileOutLength, BYTE *Profile); +``` + +##### 6.8.1.1.1 Normal execution + +CRRN1: Retrieve the current terminal profile. + +CRRN2: If ProfileOutLength or Profile is null, the invocation is a NOP. + +##### 6.8.1.1.2 Parameter errors + +##### 6.8.1.1.3 Context errors + +#### 6.8.1.2 Test Procedure + +SET Test TO CatGetTerminalProfile. + +``` +/* Test Case 1: Get terminal profile */ +IF {(CatGetTerminalProfile((BYTE *) (&bytes), buffer), SW_OK) == SW_OK} +THEN {NOP}. + +/* Test Case 2: Null return */ +IF {(CatGetTerminalProfile(NULL, NULL), SW_OK) == SW_OK} +THEN {NOP}. +``` + +### 6.8.1.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.8.2 CatMoreTime + +Test Area Reference: API\_CatMoreTime + +### 6.8.2.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatMoreTime(void); +``` + +#### 6.8.2.1.1 Normal execution + +CRRN1: Issue a MORE TIME request to the terminal. + +#### 6.8.2.1.2 Parameter errors + +#### 6.8.2.1.3 Context errors + +Test Application: API\_CatMoreTime.c + +### 6.8.2.2 Test Procedure + +SET Test TO CatMoreTime. + +``` +/* Test Case 1: Get more time */ +``` + +``` +IF {CatMoreTime() == CAT_COMMAND_SUCCESSFUL} +``` + +``` +THEN {memcmp(proactiveCommandBuffer, moreTime, sizeof(moreTime)) == 0}. +``` + +### 6.8.2.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.8.3 CatPollingOff + +Test Area Reference: API\_CatPollingOff + +### 6.8.3.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatPollingOff(void); +``` + +## 6.8.3.1.1 Normal execution + +CRRN1: Send the POLLING OFF proactive command to the terminal. + +## 6.8.3.1.2 Parameter errors + +## 6.8.3.1.3 Context errors + +## 6.8.3.2 Test Procedure + +SET Test TO CatPollingOff. + +/\* Test Case 1: Turn polling off \*/ + +IF {CatPollingOff() == CAT\_COMMAND\_SUCCESSFUL} + +THEN {memcmp(proactiveCommandBuffer, pollingOff, sizeof(pollingOff)) == 0}. + +## 6.8.3.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.8.4 CatPollInterval + +Test Area Reference: API\_CatPollInterval + +## 6.8.4.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatPollInterval(CatTimeUnit Unit, BYTE Interval, + CatTimeInterval *ActualIntervalOut); +``` + +## 6.8.4.1.1 Normal execution + +CRRN1: Send the POLL INTERVAL proactive command to the terminal. + +CRRN2: If ActualIntervalOut is null, the actual interval set by the terminal is not returned. + +## 6.8.4.1.2 Parameter errors + +## 6.8.4.1.3 Context errors + +## 6.8.4.2 Test Procedure + +SET Test TO CatPollInterval. + +/\* Test Case 1: Set polling interval \*/ + +IF {CatPollInterval(GSM\_SECONDS, 5, &timeInterval) == CAT\_COMMAND\_SUCCESSFUL} + +THEN {memcmp(proactiveCommandBuffer, pollInterval, sizeof(pollInterval)) == 0}. + +/\* Test Case 2: Null time interval return \*/ + +IF {CatPollInterval(GSM\_SECONDS, 5, &timeInterval) == CAT\_COMMAND\_SUCCESSFUL} + +THEN {memcmp(proactiveCommandBuffer, pollInterval, sizeof(pollInterval)) == 0}. + +#### 6.8.4.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +### 6.8.5 CatRefresh + +Test Area Reference: API\_CatRefreshWithFileList + +#### 6.8.5.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatRefreshWithFileList(CatRefreshOptions Options, + BYTE FileListLength, const void *FileList); +``` + +##### 6.8.5.1.1 Normal execution + +CRRN1: Send a REFRESH proactive command to the terminal with the provided data. + +CRRN2: If FileListLength is zero or FileList is null, send a REFRESH proactive command that refreshes all files. + +##### 6.8.5.1.2 Parameter errors + +##### 6.8.5.1.3 Context errors + +#### 6.8.5.2 Test Procedure + +AND fileList TO {0x10, 0x00, 0x20, 0x00}. + +/\* Test Case 1: Refresh file list \*/ + +IF {CatRefreshWithFileList(REFRESH\_SIM\_RESET, 2, fileList) == CAT\_COMMAND\_SUCCESSFUL} + +THEN {memcmp(proactiveCommandBuffer, refreshWithFileList1, sizeof(refreshWithFileList1)) == 0}. + +/\* Test Case 2: Refresh all files \*/ + +IF {CatRefreshWithFileList(REFRESH\_SIM\_RESET, 0, NULL) == CAT\_COMMAND\_SUCCESSFUL} + +THEN {memcmp(proactiveCommandBuffer, refreshWithFileList2, sizeof(refreshWithFileList2)) == 0}. + +### 6.8.5.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.8.6 CatLanguageNotification + +Test Area Reference: API\_CatLanguageNotification + +### 6.8.6.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatLanguageNotification(CatLanguageNotificationOptions Options, +const void *Language); +``` + +#### 6.8.6.1.1 Normal execution + +CRRN1: Send a LANGUAGE NOTIFICATION proactive command to the terminal with the provided data. + +CRRN2: If Language is null, the invocation is a NOP. + +#### 6.8.6.1.2 Parameter errors + +#### 6.8.6.1.3 Context errors + +### 6.8.6.2 Test Procedure + +SET Test TO CatLanguageNotification. + +``` +/* Test Case 1: Refresh file list */ +``` + +``` +IF {(CatLanguageNotification(LANGUAGE_SPECIFIC_NOTIFICATION, buffer), SW_OK) == SW_OK} +THEN {memcmp(proactiveCommandBuffer, languageNotification, sizeof(languageNotification)) == 0}. +``` + +``` +/* Test Case 2: Null buffer */ +``` + +``` +IF {(CatLanguageNotification(LANGUAGE_SPECIFIC_NOTIFICATION, NULL), SW_OK) == SW_OK} +THEN {NOP}. +``` + +### 6.8.6.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.8.7 CatLaunchBrowser + +Test Area Reference: API\_CatLaunchBrowser + +### 6.8.7.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatLaunchBrowser(CatLaunchBrowserOptions Options, + BYTE TitleLength, const void *Title, + BYTE URLLength, const void *URL, + const CatIconIdentifier *IconIdentifier); +``` + +#### 6.8.7.1.1 Normal execution + +CRRN1: Send a LAUNCH BROWSER proactive command to the terminal with the provided data. + +#### 6.8.7.1.2 Parameter errors + +#### 6.8.7.1.3 Context errors + +### 6.8.7.2 Test Procedure + +SET Test TO CatLanguageNotification. + +/\* Test Case 1: Launch browser \*/ + +``` +IF {CatLaunchBrowser(LAUNCH_USE_EXISTING_BROWSER, 6, "Google", + 21, "http://www.google.com", NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, launchBrowser, sizeof(launchBrowser)) == 0}. +``` + +### 6.8.7.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.9 Low-Level Interface + +### 6.9.1 CatResetBuffer + +Test Area Reference: API\_CatResetBuffer + +#### 6.9.1.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatResetBuffer(void); +``` + +#### 6.9.1.1.1 Normal execution + +CRRN1: Clear the buffer that is used to construct proactive commands. + +6.9.1.1.2 Parameter errors + +6.9.1.1.3 Context errors + +## 6.9.1.2 Test Procedure + +SET Test TO CatResetBuffer. + +``` +/* Test Case 1: Reset proactive command buffer */ +IF {(CatResetBuffer(), SW_OK) == SW_OK} +THEN {NOP}. +``` + +## 6.9.1.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.9.2 CatStartProactiveCommand + +Test Area Reference: API\_CatStartProactiveCommand + +### 6.9.2.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatStartProactiveCommand(BYTE Command, BYTE Options, CatDevice To); +``` + +6.9.2.1.1 Normal execution + +CRRN1: Initialize the constructed proactive command buffer to contain the proactive command header that includes the provided data. + +6.9.2.1.2 Parameter errors + +6.9.2.1.3 Context errors + +## 6.9.2.2 Test Procedure + +``` +/* +``` + +``` +** Test Procedure for CatStartProactiveCommand +``` + +``` +*/ +``` + +SET Test TO CatStartProactiveCommand. + +``` +/* Test Case 1: Start construction of a proactive command */ +``` + +``` +IF {(CatStartProactiveCommand(SEND_SS_COMMAND, 0, DEVICE_NETWORK), SW_OK) == SW_OK} +``` + +THEN {NOP}. + +### 6.9.2.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.9.3 CatSendProactiveCommand + +Test Area Reference: API\_CatSendProactiveCommand + +### 6.9.3.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatGeneralResult CatSendProactiveCommand(BYTE *Length); +``` + +#### 6.9.3.1.1 Normal execution + +CRRN1: Send the proactive command in the constructed proactive command to the terminal and return the result of the terminal's execution of the command. + +CRRN2: If Length is null then the invocation is for the general result only. + +#### 6.9.3.1.2 Parameter errors + +#### 6.9.3.1.3 Context errors + +### 6.9.3.2 Test Procedure + +SET Test TO CatSendProactiveCommand. + +``` +/* Test Case 1: Send a proactive command */ +``` + +``` +IF {(CatStartProactiveCommand(SEND_SS_COMMAND, 0, DEVICE_NETWORK), SW_OK) == SW_OK} +AND {CatSendProactiveCommand((BYTE *)&bytes) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, sendProactiveCommand, sizeof(sendProactiveCommand)) == 0}. +``` + +``` +/* Test Case 2: Null argument */ +``` + +``` +IF {(CatStartProactiveCommand(SEND_SS_COMMAND, 0, DEVICE_NETWORK), SW_OK) == SW_OK} +AND {CatSendProactiveCommand(NULL) == CAT_COMMAND_SUCCESSFUL} +THEN {memcmp(proactiveCommandBuffer, sendProactiveCommand, sizeof(sendProactiveCommand)) == 0}. +``` + +### 6.9.3.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.9.4 CatOpenEnvelope + +Test Area Reference: API\_CatOpenEnvelope + +### 6.9.4.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +CatEnvelopeTagType CatOpenEnvelope (BYTE *Length); +``` + +#### 6.9.4.1.1 Normal execution + +CRRN1: Return the tag and the length of the envelope command that arrived for the application. + +CRRN2: If Length is null, only the tag is returned. + +#### 6.9.4.1.2 Parameter errors + +#### 6.9.4.1.3 Context errors + +### 6.9.4.2 Test Procedure + +SET Test TO CatOpenEnvelope. + +``` +/* Test Case 1: Open an incoming envelope */ +``` + +``` +IF {CatOpenEnvelope((BYTE *)&bytes) == EVENT_DOWNLOAD_TAG} +THEN {NOP}. +``` + +``` +/* Test Case 2: Null argument */ +``` + +``` +IF {CatOpenEnvelope(NULL) == EVENT_DOWNLOAD_TAG} +THEN {NOP}. +``` + +### 6.9.4.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.9.5 CatSendEnvelopeResponse + +Test Area Reference: API\_CatSendEnvelopeResponse + +### 6.9.5.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatSendEnvelopeResponse(void); +``` + +#### 6.9.5.1.1 Normal execution + +CRRN1: Send the contents of the constructed proactive command buffer to the terminal as a successful response to a envelope command. + +#### 6.9.5.1.2 Parameter errors + +#### 6.9.5.1.3 Context errors + +### 6.9.5.2 Test Procedure + +SET Test TO CatSendEnvelopeResponse. + +``` +/* Test Case 1: Send a response to an envelope APDU */ +``` + +``` +IF {(CatResetBuffer(), SW_OK) == SW_OK} +``` + +``` +AND {(CatPutByte(0x77), SW_OK) == SW_OK} +``` + +``` +AND {(CatSendEnvelopeResponse(), SW_OK) == SW_OK} +``` + +``` +THEN {memcmp(proactiveCommandBuffer, sendEnvelopeResponse, sizeof(sendEnvelopeResponse)) == 0}. +``` + +### 6.9.5.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +### 6.9.6 CatSendEnvelopeErrorResponse + +Test Area Reference: API\_CatSendEnvelopeErrorResponse + +#### 6.9.6.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatSendEnvelopeErrorResponse(void); +``` + +#### 6.9.6.1.1 Normal execution + +CRRN1: Send the contents of the constructed proactive command buffer to the terminal as an unsuccessful response to a envelope command. + +#### 6.9.6.1.2 Parameter errors + +#### 6.9.6.1.3 Context errors + +### 6.9.6.2 Test Procedure + +SET Test TO CatSendEnvelopeErrorResponse + +AND error TO {0x6D, 0x00}. + +/\* Test Case 1: Send an error response to an envelope APDU \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + +AND {(CatPutData(sizeof(error), error), SW\_OK) == SW\_OK} + +AND {(CatSendEnvelopeErrorResponse(), SW\_OK) == SW\_OK} + +THEN {memcmp(proactiveCommandBuffer, sendEnvelopeErrorResponse, sizeof(sendEnvelopeErrorResponse)) == 0}. + +### 6.9.6.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.9.7 CatPutData + +Test Area Reference: API\_CatPutData + +### 6.9.7.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatPutData(BYTE Length, const void *Data); +``` + +#### 6.9.7.1.1 Normal execution + +CRRN1: Append the provided data to the data in the constructed proactive command buffer. + +CRRN2: If Length is zero or Data is null, the invocation is a NOP. + +#### 6.9.7.1.2 Parameter errors + +#### 6.9.7.1.3 Context errors + +### 6.9.7.2 Test Procedure + +SET Test TO CatPutData + +AND data TO {0x01, 0x02, 0x03, 0x04}. + +/\* Test Case 1: Put some data into the proactive command buffer \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + +AND {(CatPutData(sizeof(data), data), SW\_OK) == SW\_OK} + +THEN {memcmp(proactiveCommandBuffer, putData, sizeof(putData)) == 0}. + +/\* Test Case 2: Null arguments \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + AND {(CatPutData(0, NULL), SW\_OK) == SW\_OK} + THEN {NOP}. + +### 6.9.7.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.9.8 CatPutByte + +Test Area Reference: API\_CatPutByte + +### 6.9.8.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatPutByte(BYTE Data) +``` + +#### 6.9.8.1.1 Normal execution + +CRRN1: Append the provided byte to the data in the constructed proactive command buffer. + +#### 6.9.8.1.2 Parameter errors + +#### 6.9.8.1.3 Context errors + +### 6.9.8.2 Test Procedure + +SET Test TO CatPutByte. + +/\* Test Case 1: Put a byte into the proactive command buffer \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + AND {(CatPutByte(0x77), SW\_OK) == SW\_OK} + THEN {memcmp(proactiveCommandBuffer, putByte, sizeof(putByte)) == 0}. + +### 6.9.8.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.9.9 CatPutTLV + +Test Area Reference: API\_CatPutTLV + +### 6.9.9.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatPutTLV(BYTE Tag, BYTE Length, const void *Value); +``` + +#### 6.9.9.1.1 Normal execution + +CRRN1: Append the provided TLV to the data in the constructed proactive command buffer. + +CRRN2: If Value is null, the invocation is a NOP. + +#### 6.9.9.1.2 Parameter errors + +#### 6.9.9.1.3 Context errors + +### 6.9.9.2 Test Procedure + +SET Test TO CatPutTLV + +AND value TO {0x01, 0x02, 0x03, 0x04}. + +``` +/* Test Case 1: Put a TLV into the proactive command buffer */ +``` + +``` +IF {(CatResetBuffer(), SW_OK) == SW_OK} +``` + +``` +AND {(CatPutTLV(R_APDU_TAG, sizeof(value), value), SW_OK) == SW_OK} +``` + +``` +THEN {memcmp(proactiveCommandBuffer, putTLV, sizeof(putTLV)) == 0}. +``` + +``` +/* Test Case 21: Null argument */ +``` + +``` +IF {(CatResetBuffer(), SW_OK) == SW_OK} +``` + +``` +AND {(CatPutTLV(0, 0, NULL), SW_OK) == SW_OK} +``` + +``` +THEN {NOP}. +``` + +### 6.9.9.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.9.10 CatPutBytePrefixedTLV + +Test Area Reference: API\_CatPutBytePrefixedTLV + +### 6.9.10.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatPutBytePrefixedTLV(BYTE Tag, BYTE Prefix, BYTE Length, const void *Value); +``` + +#### 6.9.10.1.1 Normal execution + +CRRN1: Append the provided data to the data in the constructed proactive command buffer. + +CRRN2: If Value is null the invocation is a NOP. + +#### 6.9.10.1.2 Parameter errors + +#### 6.9.10.1.3 Context errors + +### 6.9.10.2 Test Procedure + +SET Test TO CatPutBytePrefixedTLV + +AND value TO {0x01, 0x02, 0x03, 0x04}. + +/\* Test Case 1: Put a TLV into the proactive command buffer \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + +AND {(CatPutBytePrefixedTLV(R\_APDU\_TAG, 0x77, sizeof(value), value), SW\_OK) == SW\_OK} + +THEN {memcmp(proactiveCommandBuffer, putBytePrefixedTLV, sizeof(putBytePrefixedTLV)) == 0}. + +/\* Test Case 21: Null argument \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + +AND {(CatPutBytePrefixedTLV(0, 0, 0, NULL), SW\_OK) == SW\_OK} + +THEN {NOP}. + +### 6.9.10.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | + +## 6.9.11 CatPutOneByteTLV + +Test Area Reference: API\_CatPutOneByteTLV + +### 6.9.11.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatPutOneByteTLV(BYTE Tag, BYTE Value); +``` + +#### 6.9.11.1.1 Normal execution + +CRRN1: Append the provided data to the data in the constructed proactive command buffer. + +#### 6.9.11.1.2 Parameter errors + +#### 6.9.11.1.3 Context errors + +### 6.9.11.2 Test Procedure + +SET Test TO CatPutOneByteTLV. + +``` +/* Test Case 1: Put a TLV into the proactive command buffer */ +``` + +``` +IF {(CatResetBuffer(), SW_OK) == SW_OK} +``` + +``` +AND {(CatPutOneByteTLV(R_APDU_TAG, 0x77), SW_OK) == SW_OK} +``` + +``` +THEN {memcmp(proactiveCommandBuffer, putOneByteTLV, sizeof(putOneByteTLV)) == 0}. +``` + +### 6.9.11.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +### 6.9.12 CatPutTwoByteTLV + +Test Area Reference: API\_CatPutTwoByteTLV + +#### 6.9.12.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Void CatPutTwoByteTLV(BYTE Tag, BYTE Value1, BYTE Value2); +``` + +#### 6.9.12.1.1 Normal execution + +CRRN1: Append the provided data to the data in the constructed proactive command buffer. + +#### 6.9.12.1.2 Parameter errors + +#### 6.9.12.1.3 Context errors + +### 6.9.12.2 Test Procedure + +SET Test TO CatPutTwoByteTLV. + +/\* Test Case 1: Put a TLV into the proactive command buffer \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + AND {(CatPutTwoByteTLV(R\_APDU\_TAG, 0x77, 0x88), SW\_OK) == SW\_OK} + THEN {memcmp(proactiveCommandBuffer, putTwoByteTLV, sizeof(putTwoByteTLV)) == 0}. + +### 6.9.12.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.9.13 CatGetByte + +Test Area Reference: API\_CatGetByte + +### 6.9.13.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +BYTE CatGetByte(void); +``` + +#### 6.9.13.1.1 Normal execution + +CRRN1: Return the byte at the current buffer pointer and advance the pointer by one byte. + +#### 6.9.13.1.2 Parameter errors + +#### 6.9.13.1.3 Context errors + +### 6.9.13.2 Test Procedure + +SET Test TO CatGetByte. + +/\* Test Case 1: Get a byte from the proactive command buffer \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + AND {(CatPutTwoByteTLV(R\_APDU\_TAG, 0x77, 0x88), SW\_OK) == SW\_OK} + AND {(CatResetBuffer(), SW\_OK) == SW\_OK} + THEN {CatGetByte() == R\_APDU\_TAG}. + +### 6.9.13.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.9.14 CatGetData + +Test Area Reference: API\_CatGetData + +### 6.9.14.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Const void *CatGetData(BYTE Length); +``` + +#### 6.9.14.1.1 Normal execution + +CRRN1: Return the current data pointer and then increment the pointer by Length. + +#### 6.9.14.1.2 Parameter errors + +#### 6.9.14.1.3 Context errors + +### 6.9.14.2 Test Procedure + +SET Test TO CatGetData + +AND data TO {R\_APDU\_TAG, 0x02, 0x77, 0x88}. + +/\* Test Case 1: Get some data from the proactive command buffer \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + +AND {(CatPutTwoByteTLV(R\_APDU\_TAG, 0x77, 0x88), SW\_OK) == SW\_OK} + +AND {(CatResetBuffer(), SW\_OK) == SW\_OK} + +THEN {memcmp((BYTE \*)CatGetByte(), data, sizeof(data)) == 0}. + +### 6.9.14.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | + +## 6.9.15 CatFindNthTLV + +Test Area Reference: API\_CatFindNthTLV + +### 6.9.15.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Const void *CatFindNthTLV(BYTE Tag, BYTE Occurrence, BYTE *Length); +``` + +#### 6.9.15.1.1 Normal execution + +CRRN1: Return a pointer to the Occurance appearance of a TLV with the provided Tag in the data buffer and the length of this TLV at Length. + +CRRN2: If there are less than Occurance appearances of TLVs with the provided Tag, return null. + +CRRN3: If Length is null, do not return the Length of the TLV if one is found. + +6.9.15.1.2                Parameter errors + +6.9.15.1.3                Context errors + +## 6.9.15.2      Test Procedure + +SET Test TO CatFindNthTLV + +AND tlvs TO {0x80, 0x01, 0x00, 0x81, 0x01, 0x01, 0x81, 0x02, 0x01, 0x02}. + +/\* Test Case 1: Find a TLV \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + +AND {(CatPutData(sizeof(tlvs), tlvs), SW\_OK) == SW\_OK} + +AND {(CatResetBuffer(), SW\_OK) == SW\_OK} + +THEN {memcmp((BYTE \*)CatFindNthTLV(0x81, 2, buffer), tlvs+6, buffer[0]) == 0}. + +/\* Test Case 2: Too few appearances \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + +AND {(CatPutData(sizeof(tlvs), tlvs), SW\_OK) == SW\_OK} + +AND {(CatResetBuffer(), SW\_OK) == SW\_OK} + +THEN {(BYTE \*)CatFindNthTLV(0x81, 3, buffer) == NULL}. + +/\* Test Case 3: Null argument \*/ + +IF {(CatResetBuffer(), SW\_OK) == SW\_OK} + +AND {(CatPutData(sizeof(tlvs), tlvs), SW\_OK) == SW\_OK} + +AND {(CatResetBuffer(), SW\_OK) == SW\_OK} + +THEN {memcmp((BYTE \*)CatFindNthTLV(0x81, 2, NULL), tlvs+6, 4) == 0}. + +## 6.9.15.3      Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | +| N3 | 3 | + +## 6.9.16    CatFindNthTLVInUserBuffer + +Test Area Reference: API\_CatFindNthTLVInUserBuffer + +### 6.9.16.1 Conformance Requirements + +The entry point with the following header shall be compliant to its definition in the API. + +``` +Const void *CatFindNthTLVInUserBuffer (BYTE BufferLen, + const void *Buffer, BYTE Tag, + BYTE Occurrence, BYTE *Length); +``` + +#### 6.9.16.1.1 Normal execution + +CRRN1: Return a pointer to the Occurance appearance of a TLV with the provided Tag in the provided buffer and the length of this TLV at Length. + +CRRN2: If there are less than Occurance appearances of TLVs with the provided Tag, return null. + +CRRN3: If Length is null, do not return the Length of the TLV if one is found. + +CRNN4: If BufferLen is zero or Buffer is null, the invocation is a NOP that returns null. + +#### 6.9.16.1.2 Parameter errors + +#### 6.9.16.1.3 Context errors + +### 6.9.16.2 Test Procedure + +SET Test TO CatFindNthTLVInUserBuffer + +AND tlvs TO {0x80, 0x01, 0x00, 0x81, 0x01, 0x01, 0x81, 0x02, 0x01, 0x02}. + +/\* Test Case 1: Find a TLV \*/ + +IF {OK} + +THEN {memcmp((BYTE \*)CatFindNthTLVInUserBuffer(sizeof(tlvs), tlvs, 0x81, 2, buffer), tlvs+6, buffer[0]) == 0}. + +/\* Test Case 2: Too few appearances \*/ + +IF {OK} + +THEN {(BYTE \*)CatFindNthTLVInUserBuffer(sizeof(tlvs), tlvs, 0x81, 3, buffer) == NULL}. + +/\* Test Case 3: Length null \*/ + +IF {OK} + +THEN {CatFindNthTLVInUserBuffer(sizeof(tlvs), tlvs, 0x81, 2, NULL) == tlvs+6}. + +/\* Test Case 4: Buffer null \*/ + +IF {OK} + +THEN {CatFindNthTLVInUserBuffer(0, NULL, 0x81, 2, buffer) == 0}. + +## 6.9.16.3 Test Coverage + +| CRR number | Test Case Number | +|------------|------------------| +| N1 | 1 | +| N2 | 2 | +| N3 | 3 | +| N4 | 4 | + +--- + +## Annex A (normative): Script file syntax and format description + +### A.1 Syntax description + +Following is a syntax description in BNF. + +``` + + ::= [ \n ] + + + ::= | | + + ::= | | | + + ::= RST + + ::= INI + + ::= CMD [ ] ( ) + + ::= [ ] + + ::= ( ) + + ::= REM + + ::= SWI { [] + } + + ::=