annotate libtwamr/sid_sync.h @ 585:3c6bf0d26ee7 default tip

TW-TS-005 reader: fix maximum line length bug TW-TS-005 section 4.1 states: The maximum allowed length of each line is 80 characters, not including the OS-specific newline encoding. The implementation of this line length limit in the TW-TS-005 hex file reader function in the present suite was wrong, such that lines of the full maximum length could not be read. Fix it. Note that this bug affects comment lines too, not just actual RTP payloads. Neither Annex A nor Annex B features an RTP payload format that goes to the maximum of 40 bytes, but if a comment line goes to the maximum allowed length of 80 characters not including the terminating newline, the bug will be triggered, necessitating the present fix.
author Mychaela Falconia <falcon@freecalypso.org>
date Tue, 25 Feb 2025 07:49:28 +0000
parents a8b73b1c5b19
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
402
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 /*
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 *****************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 *
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 * GSM AMR-NB speech codec R98 Version 7.6.0 December 12, 2001
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 * R99 Version 3.3.0
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 * REL-4 Version 4.1.0
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 *
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 *****************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 *
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 * File : sid_sync.h
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 * Purpose : To ensure that the mode only switches to a
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 * neighbouring mode
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 *
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 *****************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 #ifndef sid_sync_h
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 #define sid_sync_h "$Id $"
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 /*
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 *****************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 * INCLUDE FILES
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 *****************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 #include "tw_amr.h"
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 #include "typedef.h"
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 /*
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28 ******************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 * CONSTANTS
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30 ******************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31 */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 /*
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 ******************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 * DEFINITION OF DATA TYPES
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36 ******************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 typedef struct {
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 Word16 sid_update_rate; /* Send SID Update every sid_update_rate frame */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 Word16 sid_update_counter; /* Number of frames since last SID */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41 Word16 sid_handover_debt; /* Number of extra SID_UPD frames to schedule*/
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 enum TXFrameType prev_ft;
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
43 } sid_syncState;
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
45 /*
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
46 *****************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
47 * LOCAL VARIABLES AND TABLES
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
48 *****************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
49 */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
50
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
51 /*
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
52 *****************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
53 * DECLARATION OF PROTOTYPES
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
54 *****************************************************************************
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
55 */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
56
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
57 void sid_sync_reset (sid_syncState *st);
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
58 /* reset of sid_sync module (i.e. set state memory to zero)
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
59 returns 0 on success
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
60 */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
61
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
62 int sid_sync_set_handover_debt (sid_syncState *st, /* i/o: sid_sync state */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
63 Word16 debtFrames);
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
64 /* update handover debt
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
65 debtFrames extra SID_UPD are scheduled .
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
66 to update remote decoder CNI states, right after an handover.
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
67 (primarily for use on MS UL side )
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
68 */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
69
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
70 void sid_sync(sid_syncState *st , /* i/o: sid_sync state */
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
71 enum Mode mode,
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
72 enum TXFrameType *tx_frame_type);
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
73
a8b73b1c5b19 libtwamr: integrate sid_sync.c
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
74 #endif