Merge pull request #73 from SunshineStream/nightly

v0.13.0

Author: ReenigneArcher

.clang-format

@@ -23,6 +23,7 @@ BraceWrapping:
   AfterEnum: false
   AfterFunction: false
   AfterNamespace: false
+  AfterObjCDeclaration: false
   AfterUnion: false
   BeforeCatch: true
   BeforeElse: true

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    target-branch: "nightly"
+    open-pull-requests-limit: 20

.github/workflows/CI.yml

@@ -51,30 +51,6 @@ jobs:
         echo Within 'CMakeLists.txt' change "project(Sunshine VERSION $cmakelists_version)" to "project(Sunshine VERSION ${{ needs.check_changelog.outputs.next_version_bare }})"
         exit 1
 
-    - name: Check gen-deb.in Version
-      run: |
-        version=$(grep -o -E '^Version: [0-9]+\.[0-9]+\.[0-9]+' gen-deb.in | grep -o -E '[0-9]+\.[0-9]+\.[0-9]+')
-        echo "gendeb_version=${version}" >> $GITHUB_ENV
-    - name: Compare gen-deb.in Version
-      if: ${{ env.gendeb_version != needs.check_changelog.outputs.next_version_bare }}
-      run: |
-        echo gen-deb.in version: "$gendeb_version"
-        echo Changelog version: "${{ needs.check_changelog.outputs.next_version_bare }}"
-        echo Within 'gen-deb.in' change "Version: $gendeb_version" to "Version: ${{ needs.check_changelog.outputs.next_version_bare }}"
-        exit 1
-
-    - name: Check sunshine.desktop Versions
-      run: |
-        version=$(grep -o -E '^X-AppImage-Version=[0-9]+\.[0-9]+\.[0-9]+' sunshine.desktop | grep -o -E '[0-9]+\.[0-9]+\.[0-9]+')
-        echo "appimage_version=${version}" >> $GITHUB_ENV
-    - name: Compare sunshine.desktop Versions
-      if: ${{ env.appimage_version != needs.check_changelog.outputs.next_version_bare }}
-      run: |
-        echo sunshine.desktop Version: "$appimage_version"
-        echo Changelog version: "${{ needs.check_changelog.outputs.next_version_bare }}"
-        echo Within 'sunshine.desktop' change "X-AppImage-Version=$appimage_version" to "X-AppImage-Version=${{ needs.check_changelog.outputs.next_version_bare }}"
-        exit 1
-
   build_appimage:
     name: AppImage
     runs-on: ubuntu-20.04
@@ -135,7 +111,7 @@ jobs:
 
         wget https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage && chmod +x linuxdeploy-x86_64.AppImage
 
-        ./linuxdeploy-x86_64.AppImage --appdir ../AppDir -e ../appimage-build/sunshine -i "../$ICON_FILE" -d "../$DESKTOP_FILE" --output appimage
+        ./linuxdeploy-x86_64.AppImage --appdir ../AppDir -e ../appimage-build/sunshine -i "../$ICON_FILE" -d "../appimage-build/$DESKTOP_FILE" --output appimage
 
         mv sunshine*.AppImage sunshine.AppImage
         mkdir sunshine && mv sunshine.AppImage sunshine/
@@ -160,7 +136,7 @@ jobs:
         path: artifacts/
     - name: Create Release
       if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
-      uses: SunshineStream/actions/create_release@v0
+      uses: SunshineStream/actions/create_release@master
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
         next_version: ${{ needs.check_changelog.outputs.next_version }}
@@ -211,7 +187,7 @@ jobs:
           path: artifacts/
       - name: Create Release
         if: ${{ matrix.package == '-p' && github.event_name == 'push' && github.ref == 'refs/heads/master' }}
-        uses: SunshineStream/actions/create_release@v0
+        uses: SunshineStream/actions/create_release@master
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           next_version: ${{ needs.check_changelog.outputs.next_version }}
@@ -275,7 +251,7 @@ jobs:
           path: artifacts/
       - name: Create Release
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
-        uses: SunshineStream/actions/create_release@v0
+        uses: SunshineStream/actions/create_release@master
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           next_version: ${{ needs.check_changelog.outputs.next_version }}

.github/workflows/clang.yml

@@ -0,0 +1,35 @@
+name: clang-format-lint
+
+on:
+  pull_request:
+    branches: [master, nightly]
+    types: [opened, synchronize, edited, reopened]
+
+jobs:
+  lint:
+    name: Clang Format Lint
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false  # false to test all, true to fail entire job if any fail
+      matrix:
+        inplace: [ true, false ]  # removed ubuntu_18_04 for now
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Clang format lint
+      uses: DoozyX/[email protected]
+      with:
+        source: './sunshine'
+        extensions: 'cpp,h,m,mm'
+        clangFormatVersion: 13
+        style: file
+        inplace: ${{ matrix.inplace }}
+
+    - name: Upload Artifacts
+      if: ${{ matrix.inplace == true }}
+      uses: actions/upload-artifact@v2
+      with:
+        name: sunshine
+        path: sunshine/

.gitmodules

@@ -13,3 +13,6 @@
 [submodule "third-party/nv-codec-headers"]
 	path = third-party/nv-codec-headers
 	url = https://github.com/FFmpeg/nv-codec-headers
+[submodule "sunshine/platform/macos/TPCircularBuffer"]
+	path = sunshine/platform/macos/TPCircularBuffer
+	url = https://github.com/michaeltyson/TPCircularBuffer

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [0.13.0] - 2022-02-27
+### Added
+- (MacOS) Initial support for MacOS (#40)
+
 ## [0.12.0] - 2022-02-13
 ### Added
 - New command line argument `--version`

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.0)
 
-project(Sunshine VERSION 0.12.0)
+project(Sunshine VERSION 0.13.0)
 
 set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
 
@@ -11,6 +11,22 @@ if(WIN32)
 		PQOS_FLOWID=UINT32*
 		QOS_NON_ADAPTIVE_FLOW=2)
 endif()
+if(APPLE)
+	macro(ADD_FRAMEWORK fwname appname)
+    find_library(FRAMEWORK_${fwname}
+    NAMES ${fwname}
+    PATHS ${CMAKE_OSX_SYSROOT}/System/Library
+    PATH_SUFFIXES Frameworks
+    NO_DEFAULT_PATH)
+    if( ${FRAMEWORK_${fwname}} STREQUAL FRAMEWORK_${fwname}-NOTFOUND)
+        MESSAGE(ERROR ": Framework ${fwname} not found")
+    else()
+        TARGET_LINK_LIBRARIES(${appname} "${FRAMEWORK_${fwname}}/${fwname}")
+        MESSAGE(STATUS "Framework ${fwname} found at ${FRAMEWORK_${fwname}}")
+    endif()
+	endmacro(ADD_FRAMEWORK)
+endif()
+
 add_subdirectory(third-party/moonlight-common-c/enet)
 add_subdirectory(third-party/Simple-Web-Server)
 
@@ -23,7 +39,9 @@ include_directories(third-party/miniupnp)
 
 find_package(Threads REQUIRED)
 find_package(OpenSSL REQUIRED)
-set(Boost_USE_STATIC_LIBS ON)
+if(NOT APPLE)
+	set(Boost_USE_STATIC_LIBS ON)
+endif()
 find_package(Boost COMPONENTS log filesystem REQUIRED)
 
 list(APPEND SUNSHINE_COMPILE_OPTIONS -Wall -Wno-missing-braces -Wno-maybe-uninitialized -Wno-sign-compare)
@@ -106,6 +124,46 @@ if(WIN32)
 
 	set_source_files_properties(third-party/ViGEmClient/src/ViGEmClient.cpp PROPERTIES COMPILE_DEFINITIONS "UNICODE=1;ERROR_INVALID_DEVICE_OBJECT_PARAMETER=650")
 	set_source_files_properties(third-party/ViGEmClient/src/ViGEmClient.cpp PROPERTIES COMPILE_FLAGS "-Wno-unknown-pragmas -Wno-misleading-indentation -Wno-class-memaccess")
+elseif(APPLE)
+	add_compile_definitions(SUNSHINE_PLATFORM="macos")
+	list(APPEND SUNSHINE_DEFINITIONS APPS_JSON="apps_mac.json")
+	link_directories(/opt/local/lib)
+	link_directories(/usr/local/lib)
+	ADD_DEFINITIONS(-DBOOST_LOG_DYN_LINK)
+
+	find_package(FFmpeg REQUIRED)
+	FIND_LIBRARY(APP_SERVICES_LIBRARY ApplicationServices )
+	FIND_LIBRARY(AV_FOUNDATION_LIBRARY AVFoundation )
+	FIND_LIBRARY(CORE_MEDIA_LIBRARY CoreMedia )
+	FIND_LIBRARY(CORE_VIDEO_LIBRARY CoreVideo )
+	FIND_LIBRARY(FOUNDATION_LIBRARY Foundation )
+	list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
+		${APP_SERVICES_LIBRARY}
+		${AV_FOUNDATION_LIBRARY}
+		${CORE_MEDIA_LIBRARY}
+		${CORE_VIDEO_LIBRARY}
+		${FOUNDATION_LIBRARY})
+
+	set(PLATFORM_INCLUDE_DIRS
+		${Boost_INCLUDE_DIR})
+
+	set(PLATFORM_TARGET_FILES
+		sunshine/platform/macos/av_audio.h
+		sunshine/platform/macos/av_audio.m
+		sunshine/platform/macos/av_img_t.h
+		sunshine/platform/macos/av_video.h
+		sunshine/platform/macos/av_video.m
+		sunshine/platform/macos/display.mm
+		sunshine/platform/macos/input.cpp
+		sunshine/platform/macos/microphone.mm
+		sunshine/platform/macos/misc.cpp
+		sunshine/platform/macos/misc.h
+		sunshine/platform/macos/nv12_zero_device.cpp
+		sunshine/platform/macos/nv12_zero_device.h
+		sunshine/platform/macos/publish.cpp
+		sunshine/platform/macos/TPCircularBuffer/TPCircularBuffer.c
+		sunshine/platform/macos/TPCircularBuffer/TPCircularBuffer.h
+		${CMAKE_CURRENT_SOURCE_DIR}/assets/Info.plist)
 else()
 	add_compile_definitions(SUNSHINE_PLATFORM="linux")
 	list(APPEND SUNSHINE_DEFINITIONS APPS_JSON="apps_linux.json")
@@ -255,6 +313,7 @@ else()
 		set(SUNSHINE_EXECUTABLE_PATH "sunshine")
 	endif()
 	configure_file(gen-deb.in gen-deb @ONLY)
+	configure_file(sunshine.desktop.in sunshine.desktop @ONLY)
 	configure_file(sunshine.service.in sunshine.service @ONLY)
 endif()
 
@@ -352,7 +411,6 @@ list(APPEND SUNSHINE_EXTERNAL_LIBRARIES
 		libminiupnpc-static
 		${CBS_EXTERNAL_LIBRARIES}
 		${CMAKE_THREAD_LIBS_INIT}
-		stdc++fs
 		enet
 		opus
 		${FFMPEG_LIBRARIES}
@@ -368,7 +426,7 @@ list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_ASSETS_DIR="${SUNSHINE_ASSETS_DIR}")
 list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_CONFIG_DIR="${SUNSHINE_CONFIG_DIR}")
 list(APPEND SUNSHINE_DEFINITIONS SUNSHINE_DEFAULT_DIR="${SUNSHINE_DEFAULT_DIR}")
 add_executable(sunshine ${SUNSHINE_TARGET_FILES})
-target_link_libraries(sunshine ${SUNSHINE_EXTERNAL_LIBRARIES})
+target_link_libraries(sunshine ${SUNSHINE_EXTERNAL_LIBRARIES} ${EXTRA_LIBS})
 target_compile_definitions(sunshine PUBLIC ${SUNSHINE_DEFINITIONS})
 set_target_properties(sunshine PROPERTIES CXX_STANDARD 17
                             VERSION ${PROJECT_VERSION}
@@ -380,6 +438,10 @@ if(NOT DEFINED CMAKE_CUDA_STANDARD)
     set(CMAKE_CUDA_STANDARD_REQUIRED ON)
 endif()
 
+if(APPLE)
+	target_link_options(sunshine PRIVATE LINKER:-sectcreate,__TEXT,__info_plist,${CMAKE_CURRENT_SOURCE_DIR}/assets/Info.plist)
+endif()
+
 foreach(flag IN LISTS SUNSHINE_COMPILE_OPTIONS)
 	list(APPEND SUNSHINE_COMPILE_OPTIONS_CUDA "$<$<COMPILE_LANGUAGE:CUDA>:--compiler-options=${flag}>")
 endforeach()

Portfile

@@ -0,0 +1,48 @@
+# -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:fenc=utf-8:ft=tcl:et:sw=4:ts=4:sts=4
+
+PortSystem          1.0
+PortGroup           cmake 1.1
+PortGroup           github 1.0
+PortGroup           boost 1.0
+
+github.setup        abusse sunshine macos-dev
+version             20220224
+
+categories          multimedia
+platforms           darwin
+license             GPL-2
+maintainers         {outlook.com:anselm.busse}
+
+fetch.type          git
+post-fetch {
+    system -W ${worksrcpath} "${git.cmd} submodule update --init --recursive"
+}
+
+description         Sunshine is a Gamestream host for Moonlight
+long_description    Sunshine is a Gamestream host for Moonlight
+
+homepage            https://github.com/SunshineStream/Sunshine
+
+depends_lib         port:avahi port:ffmpeg port:libopus
+
+
+boost.version       1.76
+
+configure.args      -DBOOST_ROOT=[boost::install_area] \
+                    -DSUNSHINE_ASSETS_DIR=${prefix}/etc/sunshine
+
+cmake.out_of_source yes
+
+destroot {
+    xinstall -d -m 755 ${destroot}${prefix}/etc/${name}
+    xinstall ${worksrcpath}/assets/apps_mac.json ${destroot}${prefix}/etc/${name}
+    xinstall ${worksrcpath}/assets/box.png ${destroot}${prefix}/etc/${name}
+    xinstall ${worksrcpath}/assets/sunshine.conf ${destroot}${prefix}/etc/${name}
+
+    xinstall -d -m 755 ${destroot}${prefix}/etc/${name}/web
+    xinstall {*}[glob ${worksrcpath}/assets/web/*.html] ${destroot}${prefix}/etc/${name}/web
+    xinstall -d -m 755 ${destroot}${prefix}/etc/${name}/web/third_party
+    xinstall {*}[glob ${worksrcpath}/assets/web/third_party/*] ${destroot}${prefix}/etc/${name}/web/third_party
+
+    xinstall ${workpath}/build/${name} ${destroot}${prefix}/bin
+}

README.md

@@ -10,6 +10,7 @@ Sunshine is a Gamestream host for Moonlight
 
 # Building
 - [Linux](README.md#linux)
+- [MacOS](README.md#macos)
 - [Windows](README.md#windows-10)
 
 ## Linux
@@ -108,6 +109,53 @@ It's necessary to allow Sunshine to use KMS
 - If you use hardware acceleration on Linux using an Intel or an AMD GPU (with VAAPI), you will get tons of [graphical issues](https://github.com/loki-47-6F-64/sunshine/issues/228) if your ffmpeg version is < 4.3. If it is not available in your distribution's repositories, consider using a newer version of your distribution.
 	- Ubuntu started to ship ffmpeg 4.3 starting with groovy (20.10). If you're using an older version, you could use [this PPA](https://launchpad.net/%7Esavoury1/+archive/ubuntu/ffmpeg4) instead of upgrading. **Using PPAs is dangerous and may break your system. Use it at your own risk.**
 
+## macOS
+
+### Quickstart
+
+- Install [MacPorts](https://www.macports.org)
+- Download the `Portfile` from this repository to `/tmp`
+- In a Terminal run `cd /tmp && sudo port install`
+- Sunshine configuration is in `/opt/local/etc`
+- Run `sunshine` to start the Sunshine server
+- You will be asked to grant access to screen recording and your microphone to be able to stream it
+
+### Manuel Build
+
+#### Requirements:
+macOS Big Sur and Xcode 12.5+:
+
+Either, using [MacPorts](https://www.macports.org), install the following
+```
+sudo port install cmake boost libopus ffmpeg
+```
+
+Or, using [Homebrew](https://brew.sh), install the follwoing:
+```
+brew install boost cmake ffmpeg libopusenc
+# if there are issues with an SSL header that is not found:
+cd /usr/local/include
+ln -s ../opt/openssl/include/openssl .
+```
+
+#### Compilation:
+- `git clone https://github.com/SunshineStream/Sunshine.git --recurse-submodules`
+- `cd sunshine && mkdir build && cd build`
+- `cmake ..`
+- `make -j ${nproc}`
+
+If cmake fails complaining to find Boost, try to set the path explicitly: `cmake -DBOOST_ROOT=[boost path] ..`, e.g., `cmake -DBOOST_ROOT=/opt/local/libexec/boost/1.76 ..`
+
+### Setup:
+- Sunshine can only access microphones on macOS due to system limitations. To stream system audio use [Soundflower](https://github.com/mattingalls/Soundflower) or [BlackHole](https://github.com/ExistentialAudio/BlackHole) and select their sink as audio device in `sunshine.conf`
+- `assets/sunshine.conf` is an example configuration file. Modify it as you see fit, then use it by running: 
+	`sunshine path/to/sunshine.conf`
+- `assets/apps.json` is an [example](README.md#application-list) of a list of applications that are started just before running a stream
+
+### Usage & Limitations:
+- Command Keys are not forwarded by Moonlight. Right Option-Key is mapped to CMD-Key.
+- Gamepads are not supported
+
 ## Windows 10
 
 ### Requirements:

assets/apps_mac.json

@@ -0,0 +1,6 @@
+{
+	"env":{
+		"PATH":"$(PATH):$(HOME)/.local/bin"
+	},
+	"apps":[ ]
+}

assets/info.plist

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>CFBundleIdentifier</key>
+  <string>com.github.sunshinestream.sunshine</string>
+  <key>CFBundleName</key>
+  <string>Sunshine</string>
+  <key>NSMicrophoneUsageDescription</key>
+  <string>This app requires access to your microphone to stream audio.</string>
+</dict>
+</plist>