Skip to content

Commit 8d917b0

Browse files
authored
community (#5)
* ### Refatoração e remoção de funcionalidades obsoletas no processamento SIP/RTP --- ### Alterações técnicas: 1. **Remoção de propriedades e funções não utilizadas no `mediaChannel.php`:** - **Elementos removidos:** - Propriedades relacionadas ao rastreamento de *timeouts*, perda de pacotes (`timeoutHistory`, `packetLossWindow`), entre outros. - Funções auxiliares como `calculateAdaptiveTimeout` e `updateConnectionHealth` foram eliminadas, dado que não apresentavam uso no fluxo atual do código. - **Motivação:** Simplificar o código ao remover lógica redundante e propriedades não utilizadas. 2. **Ajustes na manipulação de pacotes RTP:** - Foi alterado o tempo de espera no recebimento de pacotes (`recvfrom`) de 0.2 para 0.5 segundos. - Modificação no tipo de dado enviado ao construir pacotes de silêncio para codificação PCM, passando a utilizar bytes únicos, em vez de duplicados. 3. **Correção no mecanismo de resampling para codec G729:** - Ajuste na manipulação de frequências no resampler, garantindo que o codec G729 funcione apenas com frequência de 8000 Hz. 4. **Adições relacionadas ao codec OPUS:** - Criação de instância padrão de `opusChannel` ao detectar membros não resolvidos. - Configuração inicial com taxa de bits (24000) e complexidade (6) para melhorar desempenho e eficiência em sistemas de baixa latência. 5. **Atualização de referências e inclusão de dependências no `runner-worker.php`:** - Ajustes em `trunkController` para utilizar a namespace `\libspech\Sip`. - Adição de arquivo de áudio (`audioFilePath`) com caminho fixo para teste e exemplo. --- ### Motivação: - Reduzir complexidade no código do plugin eliminando trechos que não são mais relevantes ao fluxo principal. - Otimizar a manipulação de pacotes RTP em cenários de baixa confiabilidade na rede, aumentando a resiliência do sistema. - Melhorar compatibilidade e qualidade de áudio para codecs como G729 e OPUS, com configurações mais adequadas às frequências e ao uso em tempo real. - Consolidar as dependências no `runner-worker.php`, garantindo maior consistência no processamento de chamadas e no uso correto das bibliotecas. --- ### Impacto: - **Simplificação de manutenção:** Código mais limpo e coeso, eliminando recursos que poderiam gerar confusão ou introduzir erros desnecessários. - **Melhoria de estabilidade nas conexões RTP/SIP:** Taxas ajustadas de recebimento e envio aumentam tolerância em cenários de rede instável. - **Melhor suporte a codecs:** Instâncias padrão e configurações otimizadas garantem que G729 e OPUS operem com maior eficiência. - **Preparação para novos recursos:** Ajustes no `trunkController` fornecem uma base mais sólida para futuras implementações. --- ### Arquivos-chave alterados: - **`plugins/Utils/sip/mediaChannel.php`** - **`runner-worker.php`** * Switch project licensing to proprietary; update headers, README, and LICENSE accordingly. Refactor `.env` usage for SIP configuration. * Switch project licensing to proprietary; update headers, README, and LICENSE accordingly. Refactor `.env` usage for SIP configuration. * Switch project licensing to Apache 2.0; replace proprietary license files and update headers accordingly.
1 parent 0ac8afc commit 8d917b0

7 files changed

Lines changed: 386 additions & 67 deletions

File tree

.gitignore

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
11
/.idea/*
2-
.idea
2+
.idea
3+
4+
# Sensitive files
5+
.env
6+
.env.*
7+
!.env.example
8+
config/credentials.*
9+
credentials.*
10+
*_credentials.*
11+
secrets.*
12+
*.key
13+
*.pem
14+
*.p12
15+
*.pfx
16+
auth.json
17+
auth.php
18+
19+
# Audio files
20+
*.wav
21+
*.mp3
22+
*.ogg
23+
audio.wav
24+
25+
# Logs
26+
*.log
27+
logs/

COPYRIGHT_HEADER.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/**
2+
* libspech - Real-time SIP/RTP VoIP Library for PHP
3+
*
4+
* Copyright (c) 2025 Lotus / berzersks
5+
* Website: https://spechshop.com
6+
* All Rights Reserved.
7+
*
8+
* PROPRIETARY SOFTWARE - Unauthorized use is prohibited.
9+
* Please respect the creator. See LICENSE for terms.
10+
*/

LICENSE

Lines changed: 0 additions & 58 deletions
This file was deleted.

LICENSE.txt

Lines changed: 275 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,275 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2025 Lotus / berzersks
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
202+
203+
================================================================================
204+
CREATOR AND PROJECT INFORMATION
205+
================================================================================
206+
207+
Original Creator: Lotus (berzersks)
208+
Website: https://spechshop.com
209+
Official Repository: https://github.com/spechshop/libspech
210+
211+
IMPORTANT NOTICE TO THE COMMUNITY:
212+
213+
This project was created by Lotus (berzersks) and is open source under the
214+
Apache License 2.0. While you are free to use, modify, and distribute this
215+
software, we encourage the community to:
216+
217+
1. PRESERVE ATTRIBUTION: Always maintain the original creator's name and
218+
copyright notices. Do not remove or alter attribution to Lotus (berzersks).
219+
220+
2. UNITE THE COMMUNITY: We encourage contributors to submit improvements,
221+
bug fixes, and new features to the official repository rather than
222+
creating fragmented forks. A unified community is stronger and advances
223+
faster together.
224+
225+
3. OFFICIAL REPOSITORY: Please consider making pull requests to:
226+
https://github.com/spechshop/libspech
227+
228+
This helps keep the community in one place and ensures that all users
229+
benefit from improvements.
230+
231+
4. RESPECT THE CREATOR: While the Apache License grants you many freedoms,
232+
we ask that you respect the original creator by not misrepresenting
233+
authorship or claiming the original work as your own.
234+
235+
Thank you for helping build a strong, united, and respectful open source
236+
community around this project!
237+
238+
================================================================================
239+
THIRD-PARTY DEPENDENCIES
240+
================================================================================
241+
242+
This project uses or is compatible with the following third-party libraries:
243+
244+
1. Swoole (Apache License 2.0)
245+
- https://github.com/swoole/swoole-src
246+
- Used for asynchronous coroutines and networking
247+
248+
2. bcg729 (GNU General Public License v3.0)
249+
- Original: https://github.com/BelledonneCommunications/bcg729
250+
- PHP Extension: https://github.com/berzersks/bcg729
251+
- Optional: G.729 audio codec support
252+
253+
3. Opus Codec (BSD License)
254+
- Xiph.Org Foundation
255+
- https://opus-codec.org/
256+
- PHP Extension: https://github.com/berzersks/opus
257+
- Optional: Opus audio codec support
258+
259+
4. psampler
260+
- https://github.com/berzersks/psampler
261+
- Optional: Audio resampling utilities
262+
263+
Users must ensure compliance with the licenses of the original libraries when
264+
using this software. The PHP extensions (bcg729, opus, psampler) maintain their
265+
own licenses - consult individual repositories for details.
266+
267+
================================================================================
268+
PROTOCOLS AND STANDARDS
269+
================================================================================
270+
271+
This implementation is based on the following open standards:
272+
- SIP: RFC 3261 (IETF)
273+
- RTP/RTCP: RFC 3550 (IETF)
274+
- SDP: RFC 4566 (IETF)
275+
- DTMF: RFC 2833 (IETF)

0 commit comments

Comments
 (0)