initial

.gitattributes

@@ -0,0 +1,2 @@
+# Declare files that will always have LF line endings on checkout.
+*.strings text eol=lf

.gitignore

@@ -0,0 +1,141 @@
+# Mac OS X
+*.DS_Store
+
+
+# Xcode
+*.pbxuser
+*.mode2v3
+*.mode1v3
+*.perspective
+*.perspectivev3
+*.xcuserstate
+xcuserdata/
+
+## Generic Files To Ignore
+*~
+*.swp
+*.out
+
+# Carthage
+Carthage/Checkouts
+# Carthage/Build
+
+AppStoreBuild
+
+# Ignore MS Office scratch files
+*/~$*
+
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# =========================
+# Operating System Files
+# =========================
+
+# =========================
+# User-specific files
+# =========================
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+
+# =========================
+# Build results
+# =========================
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+build/
+bld/
+/*/[Bb]in/
+[Oo]bj/
+
+.vs
+.vscode
+*_i.c
+*_p.c
+*_i.h
+*.ilk
+*.meta
+*.obj
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+*.pfx
+
+packages/*
+publish/
+AppPackages
+
+.DS_Store
+
+node_modules/
+.vscode/
+
+bower_components/
+
+# This is for fixing the 'Include of non-modular header inside framework module'
+# error that appears when building with the Realm library.
+apps/ios/Pods/Headers/Public/Realm
+
+# CLion build subdirectories
+cmake-build-debug/
+
+apps/ios/GuideDogs\.xcworkspace/xcshareddata/IDEWorkspaceChecks\.plist
+
+svcs/data/env/
+
+# =========================
+# Python excludes
+# =========================
+venv/
+.venv/
+__pycache__/
+
+# =========================
+# Security excludes
+# =========================
+private_keys/

CODE_OF_CONDUCT.md

@@ -0,0 +1,9 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
+- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+- Contact [[email protected]](mailto:[email protected]) with questions or concerns

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+This project welcomes contributions and suggestions. Most contributions require you to
+agree to a Contributor License Agreement (CLA) declaring that you have the right to,
+and actually do, grant us the rights to use your contribution. For details, visit
+https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need
+to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
+instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

LICENSE.txt

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

README.md

@@ -1,3 +1,33 @@
-# Repository setup required :wave:
-      
-Please visit the website URL :point_right: for this repository to complete the setup of this repository and configure access controls.
+# Open Source Soundscape
+
+This open source project is a subset of 'Microsoft Soundscape' product
+as released on the Apple App Store.  To make this contribution to open
+source, it was necessary to remove 3rd party sources and some other
+proprietary code.  Further Microsoft branding, reference to specific
+Microsoft services, and deployment mechanisms have been removed.
+
+# What is Microsoft Soundscape
+
+"Microsoft Soundscape is a product from Microsoft Research that explores the use of innovative audio-based technology to enable people to build a richer awareness of their surroundings, thus becoming more confident and empowered to get around. Unlike step-by-step navigation apps, Soundscape uses 3D audio cues to enrich ambient awareness and provide a new way to relate to the environment. It allows you to build a mental map and make personal route choices while being more comfortable within unfamiliar spaces. Soundscape is designed to be used by everyone and live in the background; therefore, feel free to use it in conjunction with other apps such as podcasts, audio books, email and even GPS navigation!"
+
+Additional app features include:
+
+* **Guided Routes** - Using the web authoring tool, users can create and share guided routes for Soundscape.
+* **Street Preview** - An audio virtual reality experience which places the user on a location with the ability to explore the road graph.
+* **Head tracking** (with supported headsets) - Allows the points of interest to stay in place as the user moves the head.
+* **Background Use** - The ability to run in the background while you use other apps.
+* **Current Location** - Quickly hear your current location and direction of travel.
+
+# Contents
+
+The open source project contains three components:
+
+| Component | Sources | Documentation |
+| --------- | ------- | ------------- |
+| Soundscape iOS Client app| [dir](./apps/ios) | [docs](docs/Client.md) |
+| Service backend | [dir](./svcs/data) | [docs](docs/Services.md) |
+| Authoring web app | [dir](./svcs/soundscape-authoring) | [docs](docs/Authoring.md) |
+
+# Trademark Notice
+
+Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.

SECURITY.md

@@ -0,0 +1,41 @@
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.8 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report).
+
+If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). 
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd).
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->

apps/ios/.gitignore

@@ -0,0 +1,29 @@
+# Mac OS X
+*.DS_Store
+
+
+# Xcode
+*.pbxuser
+*.mode2v3
+*.mode1v3
+*.perspective
+*.perspectivev3
+*.xcuserstate
+xcuserdata/
+
+## Generic Files To Ignore
+*~
+*.swp
+*.out
+
+# Carthage
+Carthage/Checkouts
+# Carthage/Build
+
+AppStoreBuild
+
+# Ignore MS Office scratch files
+*/~$*
+
+# Ignore CocoaPods
+Pods/

apps/ios/.swiftlint.yml

@@ -0,0 +1,66 @@
+disabled_rules:
+  - force_cast
+  - line_length
+  - function_body_length
+  - type_body_length
+  - file_length
+  - cyclomatic_complexity
+  - implicit_getter
+  - valid_ibinspectable
+  - todo
+excluded:
+  - Pods/*
+  - Carthage/*
+  - RLMSupport.swift
+
+large_tuple:
+  warning: 3
+  error: 4
+trailing_whitespace:
+  ignores_empty_lines: true
+identifier_name:
+  excluded: # excluded via string array
+    - id
+    - db
+    - to
+    - on
+    - On
+    - of
+    - ui
+    - i
+    - j
+    - k
+    - x
+    - y
+    - z
+    - w
+    - a
+    - b
+    - aX
+    - aY
+    - bX
+    - bY
+    - cX
+    - cY
+    - vc
+    - pt
+    - ln
+    - at
+    - en
+    - ih
+
+custom_rules:
+  nslocalizedstring_usage:
+    included: ".*\\.swift"
+    name: "NSLocalizedString Usage"
+    regex: "(NSLocalizedString)"
+    match_kinds:
+      - identifier
+    message: "Consider using GDLocalizedString."
+    severity: error
+  gdlocalizedstring_empty_usage:
+    included: ".*\\.swift"
+    name: "GDLocalizedString Empty Usage"
+    regex: "(GDLocalizedString\\(\"\"\\))"
+    message: "Consider using GDLocalizationUnnecessary(\"\")."
+    severity: error

apps/ios/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'cocoapods', '1.11.3'
+gem 'cocoapods-patch', '1.0.2'