sip-lab 1.12.34 → 1.12.35

package/DEV.md

@@ -0,0 +1,89 @@
+### For devs
+
+We build and statically link to libs pjproject, spandsp, bgc729 and rapidjson.
+
+Basic tasks for development:
+
+#### To build
+```
+npm install
+```
+
+#### To clean up (for a clean rebuild)
+```
+npx node-gyp clean
+```
+
+#### To update pjproject, spandsp, bcg729 or rapidjson
+Just delete the corresponding library subfolder in subfolder 3drParty.
+
+
+Then temporarily change install.sh to not checkout a specific version (or checkout a desired commit)
+
+Then run
+```
+npm install
+```
+
+Then perform code changes and tests. When you are satisfied with them, update install.sh with the new commit id.
+
+#### prebuild binaries
+```
+nvm use v16.13.1 # if we try with v17 it will fail to build for -t 1.5.0.0
+npx prebuildify --strip -t 15.0.0 -t 16.0.0 -t 17.0.0 -t 18.0.0
+```
+
+#### Running tests
+```
+npm test
+```
+
+#### publishing to npm registry
+
+Do it from within the project folder. First do a dry-run to check which files will be included:
+```
+takeshi:sip-lab$ npm publish --dry-run
+npm notice 
+npm notice 📦  sip-lab@1.12.26
+npm notice === Tarball Contents === 
+npm notice 1.8kB   README.md                               
+npm notice 1.5kB   build_deps.sh                           
+npm notice 2.8kB   index.js                                
+npm notice 757B    package.json                            
+npm notice 1.8MB   prebuilds/linux-x64/node.abi88.node     
+npm notice 1.8MB   prebuilds/linux-x64/node.abi93.node     
+npm notice 1.9MB   prebuilds/linux-x64/node.abi102.node    
+npm notice 1.9MB   prebuilds/linux-x64/node.abi108.node    
+npm notice 173.2kB samples/artifacts/marielle_presente.tiff
+npm notice 18.4kB  samples/artifacts/sample.tiff           
+npm notice 74.0kB  samples/artifacts/this-is-never-ok.tiff 
+npm notice 19.8kB  samples/artifacts/yosemitesam.wav       
+npm notice 6.8kB   samples/delayed_media.js                
+npm notice 4.6kB   samples/g729.js                         
+npm notice 4.2kB   samples/register_subscribe.js           
+npm notice 6.8kB   samples/reinvite_and_dtmf.js            
+npm notice 3.5kB   samples/send_and_receive_fax.js         
+npm notice 5.0kB   samples/simple.js                       
+npm notice 2.9kB   samples/sip_cancel.js                   
+npm notice 7.9kB   samples/tcp_and_extra_headers.js        
+npm notice === Tarball Details === 
+npm notice name:          sip-lab                                 
+npm notice version:       1.12.26                                 
+npm notice filename:      sip-lab-1.12.26.tgz                     
+npm notice package size:  3.2 MB                                  
+npm notice unpacked size: 7.7 MB                                  
+npm notice shasum:        aa225a9a6c704eddbfb945fe1570184d881c12d2
+npm notice integrity:     sha512-WtPrIFrFXlSAC[...]tLGc4T5h8y2qw==
+npm notice total files:   20                                      
+npm notice 
+npm notice Publishing to https://registry.npmjs.org/ (dry-run)
++ sip-lab@1.12.26
+takeshi:sip-lab$
+```
+
+Then do the actual publish:
+```
+npm publish 
+```
+
+

package/README.md

@@ -19,31 +19,16 @@ TODO:
 ### Installation
 
 This is an node.js addon and it is known to work on Ubuntu 18.04, Ubuntu 20.04, Ubuntu 22.04, Debian 10 and Debian 11 (it is known to not work on Debian 8 unless the app is built locally).
-It is distributed with prebuild binaries for node.js 15.0.0 and above.
+It is distributed with prebuild binaries for node.js 15.0.0 and above (but built for Debian 11).
 
-To install it, just do:
-```
-npm install sip-lab
-```
-
-If a prebuilt binary is not available, npm will try to build the addon.
-
-This might fail if you don't have the required tools and libraries.
-
-If this happens try installing them by doing:
+To install it, first install some dependencies:
 ```
 apt install build-essential automake autoconf libtool libspeex-dev libopus-dev libsdl2-dev libavdevice-dev libswscale-dev libv4l-dev libopencore-amrnb-dev libopencore-amrwb-dev libvo-amrwbenc-dev libvo-amrwbenc-dev libboost-dev libtiff-dev libpcap-dev libssl-dev uuid-dev cmake
 ```
 
-Then build the dependencies:
-```
-./build_deps.sh
+Then install sip-lab:
 ```
-
-and build the node addon by doing:
-```
-npx node-gyp configure
-npx node-gyp build
+npm install sip-lab
 ```
 
 Then run some sample script from subfolder samples:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sip-lab",
-  "version": "1.12.34",
+  "version": "1.12.35",
   "description": "",
   "main": "index.js",
   "engines": {
@@ -30,9 +30,11 @@
   },
   "files": [
     "index.js",
-    "install.sh",
     "binding.gyp",
     "build_deps.sh",
+    "src",
+    "README.md",
+    "DEV.md",
     "samples",
     "prebuilds"
   ]

package/src/Makefile

@@ -0,0 +1,39 @@
+#Modify this to point to the PJSIP location.
+PJBASE=/usr/local/src/svn/pjproject
+
+include $(PJBASE)/build.mak
+
+CC      = $(APP_CC)
+LDFLAGS = $(APP_LDFLAGS)
+LDLIBS  = -lstdc++ $(APP_LDLIBS)
+CFLAGS  = $(APP_CFLAGS)
+
+# CFLAGS is APP_CFLAGS that comes from /user/local/src/svn/pjproject. In it, we have -02. So since we want to disable optimization by setting -O0
+# we set -O0 before and after it to ensure -O0 has the final say.
+CPPFLAGS= -g -O0 ${CFLAGS} $(LDFLAGS) -O0 -I /usr/local/src/boost_1_51_0 -I pjmedia/include/chainlink
+
+VPATH = pjmedia
+
+.PHONY : clean install
+
+all: sip.so
+
+chainlink:
+	make -C pjmedia
+
+idmanager.o: idmanager.cpp idmanager.hpp
+	$(CC) -fPIC -c -o idmanager.o idmanager.cpp $(CPPFLAGS)
+
+event_templates.o: event_templates.cpp event_templates.hpp
+	$(CC) -fPIC -c -o event_templates.o event_templates.cpp $(CPPFLAGS)
+
+sip.o: sip.cpp sip.hpp
+	$(CC) -fPIC -c -o sip.o sip.cpp $(CPPFLAGS)
+
+sip.so: sip.o idmanager.o event_templates.o chainlink
+	$(CC) -fPIC -shared -o sip.so sip.o idmanager.o event_templates.o pjmedia/libchainlink.a 3rdParty/spandsp/src/.libs/libspandsp.a -Wl,-E -lm -ldl -ltiff $(CPPFLAGS) $(LDFLAGS) $(LDLIBS)
+
+clean:
+	rm -f *.o *.so
+	make -C pjmedia clean
+