diff --git a/README.md b/README.md index 8ab5af7..eb1c4aa 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,10 @@ Linphone-SDK binaries are fetched from our [Cocoapods repository](https://gitlab Desktop tutorials are in C#, leveraging on our Nuget packaging. +## Java + +Java tutorials targeting the Desktop. If targeting Android, take a look at the Android tutorials instead. + ## Additional resources All tutorials require a SIP account to function, and if you don't have one you can create as many as you want and for free using our [free SIP service](https://subscribe.linphone.org/). diff --git a/java/.gitignore b/java/.gitignore new file mode 100644 index 0000000..0d52b88 --- /dev/null +++ b/java/.gitignore @@ -0,0 +1,6 @@ +.gradle +build +linphone-sdk*.jar +linphone-sdk*.zip +.*.db +.*.sqlite3 \ No newline at end of file diff --git a/java/0-HelloWorld/README.md b/java/0-HelloWorld/README.md new file mode 100644 index 0000000..edb5552 --- /dev/null +++ b/java/0-HelloWorld/README.md @@ -0,0 +1,8 @@ +Hello World tutorial +==================== + +The purpose of this tutorial is to explain how to add our SDK as a dependency of an Java project and how to create the `Core` object that all our APIs depends on. + +Start by taking a look at the `build.gradle` file to see how we reference the Linphone SDK and add it as a dependency of our project. + +The user interface will only display the `Core`'s version, but in the next tutorial you will learn how to use it to login your SIP account. \ No newline at end of file diff --git a/java/0-HelloWorld/build.gradle b/java/0-HelloWorld/build.gradle new file mode 100644 index 0000000..15524da --- /dev/null +++ b/java/0-HelloWorld/build.gradle @@ -0,0 +1,18 @@ +plugins { + id 'application' + id 'org.openjfx.javafxplugin' version '0.1.0' +} + +repositories { + mavenCentral() +} + +dependencies { + implementation files('linphone-sdk.jar') +} + +javafx { + modules = [ 'javafx.controls', 'javafx.fxml' ] +} + +mainClassName = 'LinphoneJavaFX' diff --git a/java/0-HelloWorld/gradle/wrapper/gradle-wrapper.jar b/java/0-HelloWorld/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d64cd49 Binary files /dev/null and b/java/0-HelloWorld/gradle/wrapper/gradle-wrapper.jar differ diff --git a/java/0-HelloWorld/gradle/wrapper/gradle-wrapper.properties b/java/0-HelloWorld/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..1af9e09 --- /dev/null +++ b/java/0-HelloWorld/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/java/0-HelloWorld/gradlew b/java/0-HelloWorld/gradlew new file mode 100755 index 0000000..1aa94a4 --- /dev/null +++ b/java/0-HelloWorld/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/java/0-HelloWorld/gradlew.bat b/java/0-HelloWorld/gradlew.bat new file mode 100644 index 0000000..6689b85 --- /dev/null +++ b/java/0-HelloWorld/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/java/0-HelloWorld/src/main/java/LinphoneJavaFX.java b/java/0-HelloWorld/src/main/java/LinphoneJavaFX.java new file mode 100644 index 0000000..5719359 --- /dev/null +++ b/java/0-HelloWorld/src/main/java/LinphoneJavaFX.java @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2010-2024 Belledonne Communications SARL. + * + * This file is part of Linphone Java Tutorial. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +import javafx.application.Application; +import javafx.scene.Scene; +import javafx.scene.control.Label; +import javafx.scene.layout.StackPane; +import javafx.stage.Stage; + +import org.linphone.core.Core; +import org.linphone.core.Factory; +import org.linphone.core.LogLevel; +import org.linphone.core.LoggingService; + +public class LinphoneJavaFX extends Application { + + @Override + public void start(Stage stage) throws Exception { + // Core is the main object of the SDK. You can't do much without it + + // To create a Core, we need the instance of the Factory. + Factory factory = Factory.instance(); + factory.setDataDir("."); + + // Some configuration can be done before the Core is created, for example enable logs. + LoggingService loggingService = factory.getLoggingService(); + loggingService.setLogLevel(LogLevel.Message); + + // Your Core can use up to 2 configuration files, but that isn't mandatory. + // The third parameter is the application context, which is *not* mandatory when working with Java. + // You can now create your Core object. + Core core = factory.createCore("", "", null); + + // Once you have your core you can start to do a lot of things, get its version for example. + String version = core.getVersion(); + + Label l = new Label("Hello world, Linphone core version is " + version); + Scene scene = new Scene(new StackPane(l), 640, 480); + stage.setScene(scene); + stage.show(); + } + + public static void main(String[] args) { + launch(); + } + +} \ No newline at end of file diff --git a/java/1-AccountLogin/README.md b/java/1-AccountLogin/README.md new file mode 100644 index 0000000..821a3e8 --- /dev/null +++ b/java/1-AccountLogin/README.md @@ -0,0 +1,10 @@ +Account login tutorial +==================== + +Now that you have set up Linphone-SDK in a Java project, let's start using it. + +We will see how to login on a SIP server using the `Core` object instanciated in the previous tutorial. + +If you don't have a SIP server yet, you can create an account for free using our [free SIP service](https://subscribe.linphone.org/). + +Once you'll be logged-in, you'll be able to continue to the next tutorials to make calls. \ No newline at end of file diff --git a/java/1-AccountLogin/build.gradle b/java/1-AccountLogin/build.gradle new file mode 100644 index 0000000..15524da --- /dev/null +++ b/java/1-AccountLogin/build.gradle @@ -0,0 +1,18 @@ +plugins { + id 'application' + id 'org.openjfx.javafxplugin' version '0.1.0' +} + +repositories { + mavenCentral() +} + +dependencies { + implementation files('linphone-sdk.jar') +} + +javafx { + modules = [ 'javafx.controls', 'javafx.fxml' ] +} + +mainClassName = 'LinphoneJavaFX' diff --git a/java/1-AccountLogin/gradle/wrapper/gradle-wrapper.jar b/java/1-AccountLogin/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d64cd49 Binary files /dev/null and b/java/1-AccountLogin/gradle/wrapper/gradle-wrapper.jar differ diff --git a/java/1-AccountLogin/gradle/wrapper/gradle-wrapper.properties b/java/1-AccountLogin/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..1af9e09 --- /dev/null +++ b/java/1-AccountLogin/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/java/1-AccountLogin/gradlew b/java/1-AccountLogin/gradlew new file mode 100755 index 0000000..1aa94a4 --- /dev/null +++ b/java/1-AccountLogin/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/java/1-AccountLogin/gradlew.bat b/java/1-AccountLogin/gradlew.bat new file mode 100644 index 0000000..6689b85 --- /dev/null +++ b/java/1-AccountLogin/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/java/1-AccountLogin/src/main/java/LinphoneJavaFX.java b/java/1-AccountLogin/src/main/java/LinphoneJavaFX.java new file mode 100644 index 0000000..04b1b7e --- /dev/null +++ b/java/1-AccountLogin/src/main/java/LinphoneJavaFX.java @@ -0,0 +1,47 @@ +/* + * Copyright (c) 2010-2024 Belledonne Communications SARL. + * + * This file is part of Linphone Java Tutorial. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +import javafx.application.Application; +import javafx.scene.Parent; +import javafx.scene.Scene; +import javafx.stage.Stage; +import service.CoreService; +import javafx.fxml.FXMLLoader; + +public class LinphoneJavaFX extends Application { + + @Override + public void start(Stage stage) throws Exception { + Parent root = FXMLLoader.load(getClass().getResource("/view/LoginPage.fxml")); + stage.setTitle("Linphone SDK example"); + stage.setScene(new Scene(root)); + stage.show(); + } + + @Override + public void stop() { + CoreService.instance().stop(); + System.exit(0); + } + + public static void main(String[] args) { + launch(); + } + +} \ No newline at end of file diff --git a/java/1-AccountLogin/src/main/java/controller/LoginController.java b/java/1-AccountLogin/src/main/java/controller/LoginController.java new file mode 100644 index 0000000..d2621e6 --- /dev/null +++ b/java/1-AccountLogin/src/main/java/controller/LoginController.java @@ -0,0 +1,154 @@ +/* + * Copyright (c) 2010-2024 Belledonne Communications SARL. + * + * This file is part of Linphone Java Tutorial. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package controller; + +import java.net.URL; +import java.util.ResourceBundle; + +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.Button; +import javafx.scene.control.Label; +import javafx.scene.control.PasswordField; +import javafx.scene.control.RadioButton; +import javafx.scene.control.TextField; +import service.CoreService; + +import org.linphone.core.Account; +import org.linphone.core.Core; +import org.linphone.core.CoreListenerStub; +import org.linphone.core.RegistrationState; +import org.linphone.core.TransportType; + +public class LoginController extends CoreListenerStub implements Initializable { + @FXML + private Button loginButton; + @FXML + private Button logoutButton; + @FXML + private TextField identityField; + @FXML + private PasswordField passwordField; + @FXML + private RadioButton tlsRadio; + @FXML + private RadioButton tcpRadio; + @FXML + private RadioButton udpRadio; + @FXML + private Label loginLabel; + @FXML + private Label registrationLabel; + + private CoreService coreService = CoreService.instance(); + + @FXML + public void initialize(URL location, ResourceBundle resourceBundle) { + // The Core is the main object of the SDK. You can't do much without it. + // If you're not familiar with Linphone Core creation, see the 0-HelloWorld project. + Core core = CoreService.instance().core; + + // In this tutorial we are going to log in and our registration state will change. + // To get callbacks from the Core and be notified of the registration state change, + // we need to register ourself as a listener of the core. + core.addListener(this); + + // Start the core after setup, and before everything else. + coreService.start(); + + // Setup GUI. + logoutGuiChanges(); + + // Now use the GUI to log in, and see LogInClick to see how to handle login. + } + + // Called when you click on the "Login" button. + @FXML + private void onLoginClicked() { + if (loginButton.isDisabled()) + return; + loginButton.setDisable(true); + TransportType transport = TransportType.Udp; + if (tlsRadio.isSelected()) { + transport = TransportType.Tls; + } else if (tcpRadio.isSelected()) { + transport = TransportType.Tcp; + } + coreService.login(identityField.getText(), passwordField.getText(), transport); + } + + // Called when you click on the "Logout" button. + @FXML + private void onLogoutClicked() { + if (logoutButton.isDisabled()) + return; + logoutButton.setDisable(true); + coreService.logout(); + } + + private void logoutGuiChanges() { + loginButton.setDisable(false); + logoutButton.setDisable(true); + loginLabel.setText("You are logged out"); + } + + private void loginGuiChanges() { + loginButton.setDisable(true); + logoutButton.setDisable(false); + loginLabel.setText("You are logged in, with identity " + CoreService.instance().core.getIdentity() + "."); + } + + private void loginInProgressGuiChanges() { + loginButton.setDisable(true); + logoutButton.setDisable(true); + loginLabel.setText("Login in progress, with identity " + CoreService.instance().core.getIdentity() + "."); + } + + private void loginFailedGuiChanges() { + loginButton.setDisable(false); + logoutButton.setDisable(true); + loginLabel.setText("Login failed, try again."); + } + + // This method is called every time the RegistrationState is updated by background core's actions. + // In this example we use this to update the GUI. + @Override + public void onAccountRegistrationStateChanged(Core core, Account account, RegistrationState state, String message) { + registrationLabel.setText("Your registration state is: " + state.toString()); + switch (state) { + case Cleared: + case None: + coreService.clearCoreAfterLogout(); + logoutGuiChanges(); + break; + case Ok: + loginGuiChanges(); + break; + case Progress: + loginInProgressGuiChanges(); + break; + case Failed: + loginFailedGuiChanges(); + break; + default: + break; + } + } +} diff --git a/java/1-AccountLogin/src/main/java/service/CoreService.java b/java/1-AccountLogin/src/main/java/service/CoreService.java new file mode 100644 index 0000000..790860a --- /dev/null +++ b/java/1-AccountLogin/src/main/java/service/CoreService.java @@ -0,0 +1,159 @@ +/* + * Copyright (c) 2010-2024 Belledonne Communications SARL. + * + * This file is part of Linphone Java Tutorial. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package service; + +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.Timer; +import java.util.TimerTask; + +import org.linphone.core.Account; +import org.linphone.core.AccountParams; +import org.linphone.core.Address; +import org.linphone.core.AuthInfo; +import org.linphone.core.Call; +import org.linphone.core.CallParams; +import org.linphone.core.Core; +import org.linphone.core.CoreListenerStub; +import org.linphone.core.Factory; +import org.linphone.core.GlobalState; +import org.linphone.core.LogLevel; +import org.linphone.core.LoggingService; +import org.linphone.core.TransportType; +import org.linphone.core.VideoActivationPolicy; + +import javafx.application.Platform; + +public class CoreService extends CoreListenerStub { + private static CoreService instance; + + public Core core; + public IterateRunnable iterateRunnable; + private Timer iterateTimer; + + private CoreService() { + Factory factory = Factory.instance(); + factory.setDataDir("."); + + LoggingService loggingService = factory.getLoggingService(); + loggingService.setLogLevel(LogLevel.Message); + + core = factory.createCore("", "", null); + core.setAudioPort(7666); + core.setUserCertificatesPath(Paths.get("").toString()); + } + + public static CoreService instance() { + if (instance == null) { + instance = new CoreService(); + } + return instance; + } + + public void start() { + this.core.start(); + + // The iterate method of the Core is to be called regularly, typically at 20 ms interval. + // So we create an IterateRunnable and a Timer to execute this call every 20 ms. + iterateRunnable = new IterateRunnable(); + iterateTimer = new Timer(); + iterateTimer.schedule(new IterateTimerTask(), 20, 20); + } + + public void stop() { + core.stop(); + } + + public void login(String identity, String password, TransportType transport) { + // To configure a SIP account, we need an Account object and an AuthInfo object. + // The first one is how to connect to the proxy server, the second one stores the credentials. + + // Here we are creating an AuthInfo object from the identity Address and password provided by the user. + Address address = Factory.instance().createAddress(identity); + // The AuthInfo can be created from the Factory as it's only a data class. + // userID is set to "" as it's the same as the username in our case. + // ha1 is set to "" as we are using the clear text password. Upon first register, the hash will be computed automatically. + // The realm will be determined automatically from the first register, as well as the algorithm. + AuthInfo authInfo = Factory.instance().createAuthInfo(address.getUsername(), "", password, "", "", + address.getDomain()); + // And we add it to the Core. + core.addAuthInfo(authInfo); + + // Then we create an AccountParams object. + // It contains the account informations needed by the core. + AccountParams accountParams = core.createAccountParams(); + // A SIP account is identified by an identity address that we can construct from the username and domain. + accountParams.setIdentityAddress(address); + // We also need to configure where the proxy server is located. + Address serverAddress = Factory.instance().createAddress("sip:" + address.getDomain()); + // We use the Address object to easily set the transport protocol. + serverAddress.setTransport(transport); + accountParams.setServerAddress(serverAddress); + // If setRegisterEnabled(true), when this account will be added to the core it will automatically try to connect. + accountParams.setRegisterEnabled(true); + + // We can now create an Account object from the AccountParams... + Account account = core.createAccount(accountParams); + // ... and add it to the core, launching the connection process. + core.addAccount(account); + // Also set the newly added account as default. + core.setDefaultAccount(account); + } + + public void logout() { + // setRegisterEnabled(false) on a connected Account object will launch the logout action. + Account account = core.getDefaultAccount(); + if (account != null) { + // BUT BE CAREFUL : the Params attribute of an account is read-only, you MUST Clone it. + AccountParams accountParams = account.getParams().clone(); + // Then you can modify the clone. + accountParams.setRegisterEnabled(false); + // And finally setting the new Params value triggers the changes, here the logout. + account.setParams(accountParams); + } + } + + public void clearCoreAfterLogout() { + core.clearAllAuthInfo(); + core.clearAccounts(); + } + + @Override + public void onGlobalStateChanged(Core core, GlobalState state, String message) { + if (state == GlobalState.Off) { + iterateTimer.cancel(); + } + } +} + +class IterateTimerTask extends TimerTask { + @Override + public void run() { + Platform.runLater(CoreService.instance().iterateRunnable); + } +} + +class IterateRunnable implements Runnable { + @Override + public void run() { + CoreService.instance().core.iterate(); + } + +} \ No newline at end of file diff --git a/java/1-AccountLogin/src/main/resources/view/LoginPage.fxml b/java/1-AccountLogin/src/main/resources/view/LoginPage.fxml new file mode 100644 index 0000000..417e0dc --- /dev/null +++ b/java/1-AccountLogin/src/main/resources/view/LoginPage.fxml @@ -0,0 +1,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +