Experiments with Shared Holographic Experiences and Photon Unity Networking

NB: The usual blog disclaimer for this site applies to posts around HoloLens. I am not on the HoloLens team. I have no details on HoloLens other than what is on the public web and so what I post here is just from my own experience experimenting with pieces that are publicly available and you should always check out the official developer site for the product documentation.

Backdrop – Shared Holographic Experiences (or “Previously….”)

Recently, I seem to have adopted this topic of shared holographic experiences and I’ve written quite a few posts that relate to it and I keep returning to it as I find it really interesting although most of what I’ve posted has definitely been experimental rather than any kind of finished/polished solution.

One set of posts began quite a while ago with this post;

Windows 10, UWP, HoloLens & A Simple Two-Way Socket Library

where I experimented with writing my own comms library between two HoloLens devices on a local network with the initial network discovery being handled by Bluetooth and with no server or cloud involved.

That had limits though and I moved on to using the sharing service from the HoloToolkit-Unity culminating (so far) in this post;

Hitchhiking the HoloToolkit-Unity, Leg 13–Continuing with Shared Experiences

although I did recently go off on another journey to see if I could build a shared holographic experience on top of the AllJoyn protocol in this post;

Experiments with Shared Holographic Experiences and AllJoyn (Spoiler Alert- this one does not end well)

I should really have got this out of my system by now but I’m returning to it again in this post for another basic experiment.

That recent AllJoyn experiment had a couple of advantages including;

  • Performing automatic device discovery (i.e. letting AllJoyn handle the discovery)
  • Not requiring a cloud connection
  • Easy programming model (using the UWP tooling)

but the disadvantages came in that I ended up having to introduce some kind of ‘server’ app when I didn’t really intend to plus there was pretty bad performance when it came to passing around what are often large world anchor buffers.

That left me wanting to try out a few other options and I spent a bit of time looking at Unity networking (or UNET) but didn’t progress it too far because I couldn’t get the discovery mechanisms (based on UDP multicasting) to work nicely for me across a single HoloLens device and the HoloLens emulator and so I let that drop although, again, it looks to offer a server-less solution with a single device being able to operate as both ‘client’ and ‘host’ and the programming model seemed pretty easy.

Photon Unity Networking

Putting that to one side for the moment, I turned my attention to “Photon Unity Networking” (or PUN) to see if I could make use of that to build out the basics of a shared holographic experience and this post is a write up of my first experiment there.

PUN seems to involve a server which can either be run locally or in the cloud and Photon provide a hosted version of it and I figured that had to be the easiest starting point and so I went with that although, as you’ll see later, it brought with it a limitation that I could have avoided if I’d decided to host the server myself.

Getting started with cloud-hosted PUN is easy. I went for the free version of this cloud hosted model which seems to offer me up to 20 concurrent users and it was very easy to;

  1. Sign up for the service
  2. Use the portal to create an application as my first app and get an ID that can be fed into the SDK
  3. Download the SDK pieces from the Unity asset store and bring them into a Unity project

and so from there I thought it would be fun to see if I could get some basic experiment with shared holograms up and running on PUN and that’s what the rest of this post is about.

The Code

The code that I’m referring to here is all hosted on Github and it’s very basic in that all that it does (or tries to do) is to let the user use 3 voice commands;

  • “create”
  • “open debug log”
  • “close debug log”

and the keyword “create” creates a cube which should be visible across all the devices that are running the app and in the same place in the same physical location.

That’s it Smile I haven’t yet added the ability to move, manipulate holograms or show the user’s head positions as I’ve done in earlier posts. Perhaps I’ll return to that later.

But the code is hosted here;

Code on Github

and I’m going to refer to classes from it through the rest of the post.

It’s important to realise that the code is supplied without the Photon Application ID (you’d need to get your own) and without the storage access keys for my Azure storage account (you’d need to get your own).

The Blank Project

I think it’s fair to say that Photon has quite a lot of functionality that I’m not even going to attempt to make use of around lobbies and matchmaking – I really just wanted the simplest solution that I could make use of and so I started a new Unity project and added 4 sets of code to it straight off the bat as shown below;

image

Those pieces are;

  1. The HoloToolkit-Unity
  2. The Mixed Reality Design Labs
  3. The Photon Unity Networking Scripts
  4. A StorageServices library

I’ll return to the 4th one later in the post but I’m hoping that the other 3 are well understood and, if not, you can find reference to them on this blog site in many places;

Posts about Mixed Reality

I made sure that my Unity project was set up for Holographic development using the HoloToolkit menu options to set up the basic scene settings, project settings;

image

and specifically that my app had the capability to access both the microphone (for voice commands) and spatial perception (for world anchoring).

From there, I created a scene with very little in it other than a single empty Root object along with the HoloLens prefab from the Mixed Reality Design Labs (highlighted orange below) which provides the basics of getting that library into my project;

image

and I’m now “ready to go” in the sense of trying to make use of PUN to get a hologram shared across devices. Here’s the steps I undertook.

Configuring PUN

PUN makes it pretty easy to specify the details of your networking setup including your app key in that they have an option to use a configuration file which can be edited in the Unity editor and so I went via that route.

I didn’t change too much of the setup here other than to add my application id, specify TCP (more on that later) and a region of EU and then specify that I didn’t want to auto-join a lobby or enable stats as I’m hoping to avoid lobbies.

image

Making a Server Connection

I needed to make a connection to the server and PUN makes that pretty simple.

There’s a model in PUN of deriving your class from a PunBehaviour which then has a set of overrides that you can use to run code as/when certain networking events happen like a server connection or a player joining the game. I wrapped up the tiny bit of code needed to make a server connection based on a configuration file into a simple component that I called PhotonConnector which essentially takes the override-model of PUN and turns it into an event based model that suited me better. Here’s that class;

The PhotonConnector Class

and so the idea here is that I just use the OnConnectedToMaster override to wait for a connection and then I fire an event (FirstConnection) that some other piece of my code can pick up.

I dropped an instance of this component onto my Root object;

image

So, that’s hopefully my code connected to the PUN cloud server.

Making/Joining a Room

Like many multiplayer game libraries, PUN deals with the notion of a bounded set of users inside of a “room” (joined from a “lobby”) and I wanted to keep this as simple as possible for my experiment here and so I tried to bypass lobbies in as much as possible and tried to avoid building UI for the user to select a room.

Instead, I just wanted to hard-wire my app such that it would attempt to join (or create if necessary) a room given a room name and so I wrote a simple component which would attempt to either create or join a room given the room name;

The PhotoRoomJoiner Class

and so this component is prepared to look for the PhotonConnector, wait for it to connect to the network before then attempting to join/create a room on the server. Once done, like the PhotonConnector it fires an event to signify that it has completed.

I dropped an instance of this component onto my Root object leaving the room name setting as “Default Room”;

image

and by this point I was starting to realise that I was lacking any way of visualising Debug.Log calls on my device and that was starting to be a limiting factor…

Visualising Debug Output

I’ve written a few ugly solutions to displaying debug output on the HoloLens and I wanted to avoid writing yet another one and so I finally woke up and realised that I could make use of the DebugLog prefab from the Mixed Reality Design Labs;

image

and I left its configuration entirely alone but now I can see all my Debug.Log output by simply saying “open debug log” inside of my application which is a “very useful thing indeed” given how little I paid for it! Smile

image

One World Anchor Per App or Per Hologram?

In order to have holograms appear in a consistent position across devices, those devices are going to have to agree on a common coordinate system and that’s done by;

  • Creating an object at some position on one device
  • Applying a world anchor to that object to lock it in position in the real world
  • Obtaining (‘exporting’) the blob representing that world anchor
  • Sending the blob over the network to other devices
  • On those additional devices
    • Receiving the blob over the network
    • Creating the same type of object
    • Importing the world anchor blob onto the device
    • Applying (‘locking’) the newly created object with the imported world anchor blob so as to position it in the same position in the physical world as the original

It’s a multi-step process and, naturally, there’s many things that can go wrong along the way.

One of the first decisions to make is whether to apply a world anchor to every hologram shared or to perhaps apply one world anchor across the whole scene and parent all holograms from it. The former is likely to have great accuracy but the latter is a lot less expensive in terms of how many bytes need to be shipped around the network.

For this experiment, I decided to go with a halfway house. The guidance suggests that;

“A good rule of thumb is to ensure that anything you render based on a distant spatial anchor’s coordinate system is within about 3 meters of its origin”

and so I decided to go with that and to essentially create and share a new world anchor any time a hologram is created more than 3m from an existing world anchor.

In order to do that, I need to track where world anchors have been placed and I do that locally on the device.

Rather than use a hologram itself as a world anchor, I create an empty object as the world anchor and then any hologram within 3m of that anchor would be parented from that anchor.

Tracking World Anchor Positions

In order to keep track of the world anchors that a device has created or which it has received from other devices I have each device maintain a simple list of world anchors with a GUID-based naming scheme to ensure that I can refer to these world-anchors across devices. It’s a fairly simple thing and it’s listed here;

The AnchorPositionList Class

Importing/Exporting World Anchors

The business of importing or exporting world anchors takes quite a few steps and I’ve previously written code which wraps this up into a (relatively) simple single method call where I can hand a GameObject over to a method which will;

  • For export
    • Add a WorldAnchor component to the GameObject
    • Wait for that WorldAnchor component to flag that it isLocated in the world
    • Export the data for that WorldAnchor using the WorldAnchorTransferBatch
    • Return the byte[] array exported
  • For import
    • Take a byte[] array and import it using the WorldAnchorTransferBatch
    • Apply the LockObject call to the GameObject

That code is all wrapped up in a class I called SpatialAnchorHelpers

The SpatialAnchorHelpers class

One thing I’d add about this class is that it is very much “UWP” specific in that I made no attempt to make this code particularly usable from the Unity Editor and to avoid getting tied up in lots of asynchronous callbacks I just wrote code with async/await which Unity can’t make sense of but, for me, makes for much more readable code.

This code also needs to “wait” for the isLocated flag on a WorldAnchor component to signal ‘true’ and so I needed to make an awaitable version of this and I used this pretty ugly class that I’ve used before;

The PredicateLoopWatcher class

I’m not too proud of that and it perhaps needs a rethink but it’s “kind of working” for me for now although if you look at it you’ll realise that there’s a strong chance that it might loop forever and so some kind of timeout might be a good idea!

Using async/await without a suitable SynchronizationContext can mean that code can easily end up on the wrong thread for interacting with Unity’s UI objects and so I added a Dispatcher component which I try to use to help with marshalling code back onto Unity’s UI thread;

The Dispatcher Class

and so that’s part of the scripts I wrote here too and I just added an instance of it to my root script so that I’d be able to get hold of it;

image

Passing World Anchor Blobs Around the Network

For even the simplest, most basic solution like this one there comes a time when one device needs to ‘notify’ another device that either;

  • a new world anchor has been created
  • a new hologram has been created relative to an existing world anchor

and so there’s a need for some kind of ‘network notification’ which carries some data with it. The major decision though is how much data and initially what I was hoping to achieve here was for the notification to carry all of the data.

To put that into plainer English, I was hoping to use PUN’s RPC feature to enable me to send out an RPC from one device to another saying

“Hey, there’s a new world anchor called {GUID} and here’s the 1-10MB of data representing it”

Now, I must admit that I suspected that this would cause me problems (like it did when I tried it with AllJoyn) and it did Smile

Firstly, the default protocol for PUN is UDP and, naturally, it’s not a great idea to try and send MB over UDP this way and so I switched the protocol for my app to be TCP via the configuration screen that I screenshotted earlier.

Making an RPC method in PUN is simple, I just need to make sure that there’s a PhotonView component on my GameObject and then I can just add an [PunRPC] attribute and make sure that the parameters can be serialized by PUN or by my custom code if necessary.

Invoking the RPC method is also simple – you grab hold of the PhotonView component and use the RPC() method on it and there’s a target parameter on there which was really interesting to me.

In my scenario, I only really need two RPCs, something like;

  • NewWorldAnchorAdded( anchor identifier, anchor byte array )
  • NewHologramAdded( anchor identifier, hologram position relative to anchor )

Given that I was hoping to pass the entire world anchor blob over the RPC call, I didn’t want that mirrored back to the originating client by the server because that client already had that blob and so it would be wasteful.

Consequently, I used the Targets.OthersBuffered option to try and send the RPC to all the other devices in the room.

The other nice aspect around this option is the Buffered part in the sense that the server will keep the RPC details around and deliver it (and others) to new clients as they join the room.

Perfect.

It didn’t work for me though because, although PUN doesn’t place size limits on parameters to an RPC call, the cloud-hosted version of PUN does and the server bounced my RPCs straight back at me and after a little online discussion I was pointed to this article which flags that the server limit is 0.5MB for a parameter.

So, using RPCs for these large blobs wasn’t going to work much like it didn’t really work very nicely for me when I looked at doing something similar over AllJoyn.

What next? Use a blob store…

Putting Blobs in…a Blob Store!

I decided that I’d stick with the RPC mechanism for signalling the details of new world anchors and new holograms but I wouldn’t try and pass all of the bytes of the blob representing the world anchor across that boundary.

Instead, given that I’d already assumed a cloud connection to the PUN server I’d use the Azure cloud to store the blobs for my world anchors.

The next question is then how to best make use of Azure blob storage from Unity without having to hand-crank a bunch of code and set up HTTP headers etc. myself.

Fortunately, my colleague Dave has done some work around calling into Azure app services and blob storage from Unity and he has a blog post around it here;

Unity 3D and Azure Blog Storage

which points to a github repo over here;

Unity3DAzure on Github

and so I lifted this code into my project and wrote my own little BlobStorageHelper class around it so as to make it relatively easy to use in my scenario;

The AzureBlobStorageHelper class

There’s not a lot to it on top of what Dave already wrote – I just wrap it up for my use and add a little bit of code to download a blob directly from blob storage.

Naturally, to set this up I needed an Azure storage account (I already had one) and I just made a container within it (named ‘sharedholograms’) and made sure that it allowed public reads and authenticated writes and I copied out the access key such that the code would be able to make use of it.

I can then set up an instance of this component on my root game object;

image

so it’s available any time I want it from that script.

Back to RPCs

With my issue around what to do with large byte array parameters out of the way, I could return to my RPCs being as simple as their final signatures ended up being;

  [PunRPC]
  void WorldAnchorCreatedRemotely(string sessionId, string anchorId)
  {
  }
  
  [PunRPC]
  void CubeCreatedRemotely(string sessionId, string anchorId, Vector3 relativePosition)
  {

  }

because the name of the blob on the blob store can be derived from the anchorId and so it’s enough just to distribute that id.

However, what’s this sessionId parameter? This goes back to the earlier idea that I would dispatch my RPC calls using the Targets.OtherBuffered flag to notify all devices apart from the current one that something had changed.

However, what I seemed to find was that if DeviceA created one world anchor and three holograms and then quit/rejoined the server it didn’t seem to receive those 4 buffered RPCs from the server which would tell it to recreate those objects.

I’m unsure how PUN makes the distinction of “Other” but I decided that perhaps the best idea was to switch OtherBuffered to AllBuffered and then just my own mechanism to ignore RPCs which originated on the current device. Because I’m no longer sending large byte arrays over the network this didn’t feel like a particularly wasteful thing to do and so I stuck with it but it could do with a little more investigation on my part.

The other thing that I played with here was the way in which the room is originally created by my PhotoRoomJoiner component in that, initially, I wasn’t setting the RoomOptions.CleanUpCacheOnLeave which I think means that the buffered RPCs left by a player would disappear when they left the room.

However, I still seemed to find that even when I asked the room to keep around RPCs for a player that left the room the OtherBuffered option didn’t seem to deliver those RPCs back to that player when they connected again and hence me sticking with the AllBuffered option for the moment. Again, it needs more investigation.

Those big blob buffers though still cause me another problem…

Ordering of RPCs

I saw this one coming Smile Now that the upload/download of the blob representing a world anchor is done asynchronously through the cloud in a manner that’s outside the bounds of the RPCs being delivered by Photon it’s fairly easy to see a sequence of events where an RPC is delivered to create a hologram relative to a world anchor that has not yet been downloaded to the device – it’s a race and it’s pretty much certain to happen and especially if a device connected to a room with buffered RPCs containing a sequence of anchors and holograms.

Consequently, I simply keep a little lookaside list of holograms that a client has been asked to create when the world anchor that they are parented off has not yet been created. The assumption is that the world anchor will show up at some point in the future and this list can be consulted to check for all the pending holograms that then need to be created.

The AnchorCubeList Class

Bringing it All Together

All of these components are ultimately brought together by a simple “co-ordinating” script on my (almost) empty GameObject named Root that has been in the scene all along;

image

The only component that I haven’t mentioned there is the use of a KeywordManager from the HoloToolkit-Unity which sends the voice keyword “create” through to a function on my Root script which kicks off the whole process of creating a world anchor if necessary before creating a hologram (cube) 3m along the user’s gaze vector.

That Root script is longer than I’d like it to be at the moment so I could tidy that up a little but here it is in its completeness;

The Root Class

Testing and Carrying On…

I’ve left it to the end of the blog post to admit that I haven’t tested this much at the time of writing – it’s a bit of an experiment and so don’t expect too much from it Smile

One of the reasons for that is that I’m currently working with one HoloLens and the emulator and so importing/exporting of world anchors can be a bit of a challenge as it’s hard to know in the emulator whether things are working correctly or not and it’s much easier to test with multiple devices for that reason.

I’ll try that out in the coming days/weeks and will update the post or add to another post. I’d also like to add a little more into the code to make it possible to manipulate the holograms, show the user’s position as an avatar and so on as I’ve done in other posts around this topic so I’ll create a branch and keep working on that.

Beyond that, it might be “nice” to take away the dependency on PUN here and just build out a solution using nothing but standard pieces from Azure like service bus + blob storage as I don’t think that’d be a long way from what I’ve got here – that might be another avenue for a future post…

Exploring the Mixed Reality Design Labs–Experiment #2

NB: The usual blog disclaimer for this site applies to posts around HoloLens. I am not on the HoloLens team. I have no details on HoloLens other than what is on the public web and so what I post here is just from my own experience experimenting with pieces that are publicly available and you should always check out the official developer site for the product documentation.

Following up from this previous post;

Exploring the Mixed Reality Design Labs–Introduction and Experiment #1

I wanted to continue to explore some of the things present in the Mixed Reality Design Labs work and, since my last post, I’d revisited the github and had found this doc page which I hadn’t read last time I’d visited the site and it’s a great read as without it I’d felt a little like I was wandering without a map. I’m not quite sure how I missed it the first time around;

MRDL – Examples Write Up Including Interactable Objects, Object Collection, Progress, App Bar and Bounding Box

That’s definitely a good read and I’d also missed this document about including the MRDL as a submodule;

https://github.com/Microsoft/MRDesignLabs_Unity_Tools

and yet another thing that I’d missed was that the MRDL inserts a custom menu into Unity;

image

which can be used to insert the HoloLens prefab I mentiond in the previous post (from the Interace> menu) and to create the other areas of functionality listed there on the menu including quite a few buttons, receivers and cursors.

Exploring

The rest of this post is just what I’ve written down as rough notes while exploring one area of the MRDL and I chose to experiment with buttons as UIs often seem to end up with one type of button or another and I figured that I would poke around in the code and then start with the Button type;

Button on github

and that told me that there’s an abstract base class here which has (at least);

  • ButtonState (pressed, targeted, disabled, etc)
  • Whether the button requires the gaze to be on it or not
  • Events for when the state changes, when it is pressed, held, released, cancelled

along with a few private/implementation pieces. It all feels fairly ‘expected’ but there’s a relationship here with an InteractionManager;

InteractionManager on github

which looks to be a singleton handling things like tapping, manipulation, navigation events and somehow routing them (via Unity’s SendMessage) on via an AFocuser object.

AFocuser on github

This looks to be a perhaps more developed form of what’s present in the HoloToolkit-Unity done by types there like the GazeManager and so on and so it’s “interesting” that this framework looks to be reworking these particular wheels rather than picking up those bits from the HoloToolkit.

There would be quite a lot to explore here and I didn’t dig into all of it, that’ll have to be for another day. For today, I went back to exploring buttons and the types derived look to be;

  • KeyButton
  • AnimButton
  • SpriteButton
  • MeshButton
  • CompoundButton
  • AnimControllerButton
  • BoundingBoxHandle
  • ObjectButton

and I went back to reading the document on these and also had a good poke around the Interactable Object sample;

image

and I think I started to get a little bit of a grip of what was going on but I daresay I’ve got a bit more to learn here!

I tentatively added an empty parent object and a cube to my scene;

image

and then added the Compound Button script to my GameObject and it moaned at me (in a good way);

image

So I took away the box collider that comes by default with my cube and it said;

image

and so I added a box collider to the empty parent game object and the button became ‘happy’ Smile

image

I then got a bit adventurous, having noticed the notion of ‘receivers’ which look to be a form of event relay and I added a sphere to my scene and set up a “Color Receiver” on my empty game object;

image

and, sure enough, when I click on my cube my sphere toggles red/white;

image

but, equally, I think I could just handle this event by either writing code – e.g.

  private void Start()
  {
    var button = this.GetComponent<CompoundButton>();
    button.OnButtonPressed += this.OnPressed;
  }

and that seems to work just fine. I did then wonder whether I could create some hierarchy like this in my scene;

image

and then could I handle the button press by adding a script to the GrandParent object? I tried adding something like this;

using HUX.Interaction;

public class Startup : InteractibleObject
{
  private void Start()
  {
  }
  protected void FocusEnter()
  {
  }
  protected void FocusExit()
  {
  }
  protected void OnTapped(InteractionManager.InteractionEventArgs eventArgs)
  {
  }
}

but the debugger didn’t suggest that my OnTapped method was called. However, the FocusEnter and FocusExit calls do happen at this ‘grand parent’ level and this seems to be in line with the comments inside of the source code;

InteractibleObject on github

which says;

/// FocusEnter() & FocusExit() will bubble up through the hierarchy, starting from the Prime Focus collider.

///

/// All other messages will only be sent to the Prime Focus collider

and this notion of the ‘Prime Focus collider’ led me to go and take a look at the source for;

AFocuser on github

where the UpdateFocus method actually walks the hierarchy to build up the list of parent objects that will need to be notified of focus loss/gain while it updates its notion of the PrimeFocus and so (from a quick look) that all seems to tie up.

I think I could achieve what I wanted though by making by grand parent script an InteractionReceiver (as the sample does) and then I can pick up the button press that way – i.e.

public class Startup : InteractionReceiver
{
  private void Start()
  {
  }
  protected override void OnTapped(GameObject obj, InteractionManager.InteractionEventArgs eventArgs)
  {
    base.OnTapped(obj, eventArgs);
  }
}

and if I marry this up with the right settings in the UI to tell that script which interactible objects I want it to receive from;

image

then that seems to work out fine.

Quite commonly in a Mixed Reality app, I’d like to use speech in addition to moving my gaze and air-tapping and so it looks like the MRDL makes that easy in that I can add;

image

although I found that when I did this, I hit a snag in that the ColorReceiver that I’d previously added seemed to work fine when invoked by an air-tap but didn’t work when invoked by the speech command ‘click’ and that seemed to come down to this runtime error;

Failed to call function OnTapped of class ColorReceiver
Calling function OnTapped with no parameters but the function requires 2.

so maybe that’s a bug or maybe I’m misunderstanding how it’s meant to work but if I take the ColorReceiver away and handle the button OnButtonPressed event myself then I still see something similar – i.e. my code runs when I tap on the button but when I say “click” it doesn’t run but, instead, I see the debug output saying;

Keyword handler called in GameObject for keyword click with confidence level High

and I saw the same thing if I went back to having my code be an InteractionReceiver in that the air-tap seems to result in one call whereas the voice command “click” seems to result in another as below;

public class Startup : InteractionReceiver
{
  protected override void OnTapped(GameObject obj, InteractionManager.InteractionEventArgs eventArgs)
  {
    // This is called when I air-tap
    base.OnTapped(obj, eventArgs);
  }
  void OnTapped()
  {
    // This is called when I say 'click'
  }
}

and, again, I’m unsure whether that’s my understanding or whether it’s not quite working right but I figured I’d move on as I’d noticed that the “Compound Button Speech” script took two keyword sources – one was the local override I’ve used above where I can simply set the text but the other looks for a Compound Button Text;

image

and so I added one of those in, chose the provided profile and fed it a 3DTextMesh and then I selected that I wanted to override the Offset property and just dragged my text mesh around a little in Unity to try and position it ‘sensibly’;

image

and that all seemed to work fine. It’d be great to have my button give audible cues when the user interacted with it and so I also added in a Compound Button Sounds script which then wants a ButtonSoundProfile and I played with creating my own versus using the one that ships in the library;

image

and that worked fine once I’d managed to figure out how to get the sounds to come out properly over the holographic remoting app from Unity.

At this point, I’d added quite a lot of scripts to my original cube and so I reset things and went and grabbed a 3D object from Remix3D, this firefighter;

image

and dropped it into my scene as a child of my GameObject;

image

and then added back the Compound Button script and a Box Collider and then went and added the Compound Button Mesh script and tried to set up some scale and colour changes based on the states within;

image

and that seemed to work out fine – i.e. when I pressed on the button, the fireman got scaled up and the mesh got rendered in red;

image

so, that’s all really useful.

I then threw away my scene again, went back to just having a cube and set up a couple of animations – one which rotated the cube by 45 degrees and another which put it back to 0 and I built an animator around those with the transitions triggered by a change in the Targeted boolean parameter;

image

and then dragged an Animator and a Compound Button Anim component onto my GameObject;

image

and that seemed to give me the basics of having my cube animate into rotation when I focus on it and animate back from rotation when I take the focus away from it – seemed like a very useful tool to have in the toolbox Smile I noticed that Object Button seems to do something similar except it looks to model the various states via a set of different prefabs – i.e.

image

The last one of these Compound Button X types that I wanted to get my head around for this post was the Compound Button Icon type. This feels a little bit like the Text variant in that I can create an empty GameObject and then make it into a Compound Button (+Icon) as below;

image

and this seems to be driven off a ButtonIconProfile which can either be font based or texture based so I set up one that was font based;

image

and then there’s a need here for something to render the icon and I found it “interesting” to add a Cube as a child of my button object and then toggle the dropdown here to select my Cube as the rendering object. The component made a few changes on my behalf!

Here’s the before picture of my cube;

image

and this is what happens to it when I choose it as the renderer for my icon;

image

so – the mesh filter has gone and the material/shader has been changed for me and I can then go back to the Compound Button Icon component and choose the icon;

image

Very cool.

Wrapping Up

Having done a bit of exploring, I can now start to get some idea of what the tooling is doing if I use an option like;

image

and create myself a “Rectangle Button” which gives me all the glory of;

image

and so I’ve got compound, mesh, sounds, icon, text and speech all in one go and ready to be used and it takes me only a second or two in order to get buttons created;

image

and there’s a lot of flexibility in there.

As I said at the start of the post, I’m just experimenting here and I may well be getting things wrong so feel free to let me know and I’ll carry on my exploring in later posts…

Experiments with Shared Holographic Experiences and AllJoyn (Spoiler Alert: this one does not end well!)

NB: The usual blog disclaimer for this site applies to posts around HoloLens. I am not on the HoloLens team. I have no details on HoloLens other than what is on the public web and so what I post here is just from my own experience experimenting with pieces that are publicly available and you should always check out the official developer site for the product documentation.

This post is an interesting one in that it represents two sides of a day or so of technical failure! I tried to get something up and running and it didn’t quite work out but I thought it was worth sharing regardless but apply a large pinch of salt as the result isn’t anything that works too well Smile

Background – Catching up with AllJoyn

It’s been a little while since I looked at AllJoyn and the AllSeen Alliance.

In fact, long enough that the landscape has changed with the merger between the OCF (IoTivity) and the AllSeen Alliance (AllJoyn) with the result that (from the website);

Both projects will collaborate to support future versions of the OCF specification in a single IoTivity implementation that combines the best of both technologies into a unified solution. Current devices running on either AllJoyn or IoTivity solutions will be interoperable and backward-compatible. Companies already developing IoT solutions based on either technology can proceed with the confidence that their products will be compatible with the unified IoT standard that the industry has been asking for.

and so I guess that any use of AllJoyn at this point has to be seen against that backdrop.

Scenario – Using AllJoyn to Share Holograms Across Devices

With that said, I still have AllJoyn APIs in Windows 10 and I wanted to see whether I could use those as a basis for the sharing of Holograms across devices.

The idea would be that a HoloLens app becomes both an AllJoyn consumer and producer and so each device on a network could find all the other devices and then share data such that a common co-ordinate system could be established via world anchors and hologram creation/removal and positioning could also be shared.

If you’re not so familiar with this idea of shared holographic experiences then the official documentation lives here;

https://developer.microsoft.com/en-us/windows/mixed-reality/development 

and I’ve written a number of posts around this area of which this one would be the most recent;

Hitchhiking the HoloToolkit-Unity, Leg 13–Continuing with Shared Experiences

My idea for AllJoyn was to avoid any central server and let it do the work of having devices discover each other and connect so that they could form a network where they consume each others’ services as below;

image

Now, I don’t think that I’d tried this previously but there was something nagging at the back of my mind about the AllJoyn APIs not being something that I could use in the way that I wanted to on HoloLens and I should really have taken heed.

Instead, I ploughed ahead…

Making a “Hello World” AllJoyn Interface

I figured that the “Hello World” here might involve a HoloLens app offering an interface whereby a remote caller could create some object (e.g. a cube) at a particular location in world space.

That seemed like a simple enough thing to figure out and so I sketched out a quick interface for AllJoyn to do something like that;

<interface name=”com.taulty.RemoteHolograms”>
   <method name=”CreateCube”>
     <arg name=”x” type=”d” direction=”in” />
     <arg name=”y” type=”d” direction=”in” />
     <arg name=”z” type=”d” direction=”in” />
   </method>
</interface>

I then struggled a little with respect to knowing where to go next in that the tool alljoyncodegen.exe which I used to use to generate UWP code from an AllJoyn interface seemed to have disappeared from the SDKs.

I found this doc page which suggested that the tool was deprecated and for a while I landed on this page which sounded similar but turned out have only been tested on Linux and not to generate UWP code so was actually very different Smile

I gave up on the command line tool and went off to try and find AllJoyn Studio which does seem to still exist but only for Visual Studio 2015 which was ‘kind of ok’ because I still have VS2015 on my system alongside VS2017.

Whether all these changes are because of the AllJoyn/IoTivity merging, I’ve no idea but it certainly foxed me for a little while.

Regardless, I fed AllJoyn Studio in Visual Studio 2015 my little XML interface definition;

image

and it spat out some C++/CX code providing me a bunch of boiler plate AllJoyn implementation code which I retargeted to platform version 14393 as the tool seemed to favour 10586;

image

Writing Some Code for Unity to Consume

At this point, I was a little over-zealous in that I thought that the next step would be to try and write a library which would make it easy for Unity to make use of the code that I’d just had generated.

So, I went off and made a C# library project that referenced the newly generated code and I wrote this code to sit on top of it although I never really got around to figuring out whether this code worked or not as we’ll see in a moment;

namespace AllJoynHoloServer
{
  using com.taulty.RemoteHolograms;
  using System;
  using System.Threading.Tasks;
  using Windows.Devices.AllJoyn;
  using Windows.Foundation;

  public class AllJoynCreateCubeEventArgs : EventArgs
  {
    internal AllJoynCreateCubeEventArgs()
    {
        
    }
    public double X { get; internal set; }
    public double Y { get; internal set; }
    public double Z { get; internal set; }
  }

  public class ServiceDispatcher : IRemoteHologramsService
  {
    public ServiceDispatcher(Action<double, double, double> handler)
    {
      this.handler = handler;
    }
    public IAsyncOperation<RemoteHologramsCreateCubeResult> CreateCubeAsync(
      AllJoynMessageInfo info,
      double x,
      double y,
      double z)
    {
      return (this.CreateCubeAsyncInternal(x, y, z).AsAsyncOperation());
    }
    async Task<RemoteHologramsCreateCubeResult> CreateCubeAsyncInternal(
      double x, double y, double z)
    {
      // Likelihood that the thread we're calling from here is going to
      // break Unity's threading model.
      this.handler?.Invoke(x, y, z);

      return (RemoteHologramsCreateCubeResult.CreateSuccessResult());
    }
    Action<double, double, double> handler;
  }
  public static class AllJoynEventAdvertiser
  {
    public static event EventHandler<AllJoynCreateCubeEventArgs> CubeCreated;

    public static void Start()
    {
      if (busAttachment == null)
      {
        busAttachment = new AllJoynBusAttachment();
        busAttachment.AboutData.DateOfManufacture = DateTime.Now;
        busAttachment.AboutData.DefaultAppName = "Remote Holograms";
        busAttachment.AboutData.DefaultDescription = "Creation and Manipulation of Holograms";
        busAttachment.AboutData.DefaultManufacturer = "Mike Taulty";
        busAttachment.AboutData.ModelNumber = "Number One";
        busAttachment.AboutData.SoftwareVersion = "1.0";
        busAttachment.AboutData.SupportUrl = new Uri("http://www.mtaulty.com");

        producer = new RemoteHologramsProducer(busAttachment);
        producer.Service = new ServiceDispatcher(OnCreateCube);
        producer.Start();
      }
    }
    public static void Stop()
    {
      producer?.Stop();
      producer?.Dispose();
      busAttachment?.Disconnect();
      producer = null;
      busAttachment = null;
    }
    static void OnCreateCube(double x, double y, double z)
    {
      CubeCreated?.Invoke(
        EventArgs.Empty,
        new AllJoynCreateCubeEventArgs()
        {
          X = x,
          Y = y,
          Z = z
        });
    }
    static AllJoynBusAttachment busAttachment;
    static RemoteHologramsProducer producer;
  }
}

There’s nothing particularly exciting or new here, it’s just a static class which hides the underlying AllJoyn code from anything above it and it offers the IRemoteHologramsService over the network and fires a static event whenever some caller remotely invokes the one method on that interface.

I thought that this would be pretty easy for Unity to consume and so I dragged the DLLs into Unity (as per this post) and then added the script below to a blank GameObject to run when the app started up;

#if UNITY_UWP && !UNITY_EDITOR
using AllJoynHoloServer;
#endif
using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class Startup : MonoBehaviour
{
  // Use this for initialization
  void Start()
  {
#if UNITY_UWP && !UNITY_EDITOR
    AllJoynEventAdvertiser.CubeCreated += this.OnCubeCreated;
    AllJoynEventAdvertiser.Start();
#endif
  }
  #if UNITY_UWP && !UNITY_EDITOR
  void OnCubeCreated(object sender, AllJoynCreateCubeEventArgs args)
  {

  }
  
#endif

}

Clearly, this isn’t fully formed or entirely thought through but I wanted to just see if I could get something up and running and so I tried to debug this code having, first, made sure that my Unity app was asking for the AllJoyn security capability.

Debugging the AllJoyn Experience

I used the IoT AllJoyn Explorer to try and see if my Unity app from the HoloLens was advertising itself correctly on the local network.

That app still comes from the Windows Store and I’ve used it before and it’s always been pretty good for me.

It took me a little while to remember that I need to think about loopback exemption when it comes to this app so that’s worth flagging here.

I found that when I ran my Unity code on the HoloLens, I didn’t seem to see the service being advertised on the AllJoyn network as displayed by the IoT Explorer. I only ended up seeing a blank screen;

image

in order to sanity check this, I ended up lifting the code that I had built into Unity out of that environment and into a 2D XAML experience to run on my local PC where things lit up as I’d expect – i.e. IoT Explorer then shows;

image

and so the code seemed to be ok and, at this point, I realised that I could have tested out the whole concept in 2D XAML and never dropped into Unity at all – there’s a lesson in there somewhere! Smile

Having proved the point on my PC, I also ran the same code on my phone and saw a similar result – the service showed up on the network.

However, no matter how I went about it I couldn’t get HoloLens to advertise this AllJoyn service and so I have to think that perhaps that part of AllJoyn isn’t present on HoloLens today.

That doesn’t surprise me too much and I’ve tried to confirm it and will update this post if I get a confirmation either way.

If this is the case though, what might be done to achieve my original aim which was to use AllJoyn as the basis of a shared holographic experience across devices.

I decided that there was more than one way to achieve this…

HoloLens as AllJoyn Consumer, not Producer

It wasn’t what I’d originally had in mind but I figured I could change my scenario such that the HoloLens did not offer an AllJoyn service to be consumed but, instead, consumed an AllJoyn service offered by a device (like a PC or Phone) which could offer a service onto the network. The diagram then becomes…

image

and so there’s a need for an extra player here (the PC) and also a need for using events or signals in AllJoyn to inform devices when something has happened on ‘the server’ that they need to know about such as a world anchor being created and uploaded or a new hologram being created.

A New Interface with Signals

I figured that I was onto a winner and so set about implementing this. Firstly, I conjured up a basic interface to try and model the code scenarios of;

  1. Devices join/leave the network and other devices might want to know how many devices they are in a shared experience with.
  2. World anchors get uploaded to the network and other devices might want to import them in order to add a common co-ordinate system.
  3. Holograms get added by a user (I’m assuming that they would be added as a child of a world anchor and so there would be an association there).
  4. Holograms get removed by a user.

In addition, I’d also want to add the ability for the transforms (scale, rotate, translate) of a hologram to be changed but I left that to one side while trying to see if I could get these bits to work.

With this in mind, I created a new AllJoyn interface as below;

AllJoyn Interface on Github

and once again I should perhaps have realised that things weren’t going too well here.
Everything about that interface is probably self-explanatory except a couple of small things;
  1. I used GUIDs to identify world anchors and holograms.
  2. I’m assuming that types of holograms can be represented by simple strings – e.g. device 1 may create a hologram of an Xmas tree and I’m assuming that device 2 will get a string “Xmas tree” and know what to do with it.
  3. I wanted to have a single method which returns the [Id/Name/Type/Position] of a hologram but I found that this broke the code generation tool hence my methods GetHologramIdsAndNames and GetHologramTransforms – these should really be one method.

and a larger thing;

  • My original method for AddWorldAnchor simply took a byte array but I later discovered that AllJoyn seems to have a maximum message size of 128K whereas world anchors can be megabytes and so I added a capability here to “chunk” the world anchor into pieces and that affected this method and also the GetWorldAnchor method.

I should have stopped at this point as this limitation of 128K was flashing a warning light but I ignored it and pressed ahead.

A ‘Server’ App to Implement the Interface

Having generated the code from that new interface (highlighted blue below) I went ahead and generated a UWP app which could act as the ‘server’ (or producer) on the PC (highlighted orange below);

image

That involved implementing the generated IAJHoloServerService interface which I did as below;

AJHoloService implementation on Github

and then I can build this up (with the UI XAML which isn’t really worth listing) and have it run on my desktop;

image

waiting for connections to come in.

A Client Library to make it ‘Easier’ from Unity

I also wanted to have a small client library my life easier in the Unity environment in terms of consuming this service and so I added a 3rd UWP project to my solution;

image

and added a static class which gathered up the various bits of code needed to get the AllJoyn pieces working;

AJHoloServerConnection Implementation on Github

and that relied on this simple callback interface in order to call back into any user of the class which would be my Unity code;

Callback interface on Github

Consuming from Unity

At this point, I should have really tested what it was like to consume this code from a 2D app as I’d have learned a lot while expending little effort but I didn’t do that. Instead, I went and built a largely empty scene in Unity;

image

Where the Parent object is an empty GameObject and the UITextPrefab is straight from the HoloToolkit-Unity with a couple of voice keywords attached to it via the toolkit’s Keyword Manager;

image

I made sure my 2 DLLs (the AllJoyn generated DLL plus my client library) were present in a Plugins folder;

image

with appropriate settings on them;

image

and made sure that my project was requesting the AllJoyn capability. At this point, I realised that I needed to have some capability where I could relatively easily import/export world anchors in Unity without getting into a lot of code with Update() loops and state machines.

Towards that end, I wrote a couple of simple classes which I think function ok outside of the Unity editor in the UWP world but which wouldn’t work in the editor. I wrote a class to help with exporting world anchors;

WorldAnchorExporter implementation on Github

and a class to help with importing world anchors;

WorldAnchorImporter implementation on Github

and they rely on this a class which tries to do a simplistic bridge between the Update() oriented loop world of Unity and the async world of UWP as I wanted to be able to write async/await code which ‘waited’ for the isLocated flag on a WorldAnchor to be set true;

GameObjectUpdateWatcher implementation on Github

With that all done, I could attach a script to my empty GameObject to form the basis of my logic stringing together the handling of the voice keywords with the import/export of the world anchors, creation of a single, simple type of hologram (a cube) and calls to the AllJoyn service on the PC;

Startup script on Github

That took quite a bit of effort, but was it worth it? Possibly not…

Testing – AllJoyn and Large Buffers

In testing, things initially looked good. I’d run the consumer app on the PC, the client app on the HoloLens and I’d see it connect;

image

and disconnect when I shut it down and my voice command of “lock” seemed to go through the motions of creating a world anchor and it was quickly exported from the device and then it started to transfer over the network.

And it transferred…

And it transferred…

And it took a long time…minutes…

I spent quite some time debugging this. My first investigation was to look at the network performance graph from the HoloLens and it looked like this while transferring a 2-3MB world anchor across the network in chunks (64KB) using the AllJoyn interface that I’d written;

image

It’s the classic sawtooth and I moved my same client code onto both a Phone and a PC to see if it showed the same behaviour there and, to some extent, it did although it wasn’t as pronounced.

I played quite a bit with the size of the chunks that were being sent over the network and I could see that the gaps between the bursts of traffic seemed to be directly related to the size of the buffer and some native debugging combined with a quick experiment with the Visual Studio profiler pointed to this function in the generated code as being the cause of all my troubles;

image

and in so far as I can tell this runs some relatively expensive conversion function on every element in the array which burns up a bunch of CPU cycles on the HoloLens prior to the transmission of the data over the network. This seemed to slow down the world anchor transfers dramatically – I would find that it might take minutes for a world anchor to transfer which, clearly, isn’t very practical.

Putting the terrible performance that I’ve created to one side, I hit another problem…

Testing – Unexpected Method Signatures

Once I’d managed to be patient enough to upload a world anchor to my server, I found a particular problem testing out the method which downloads it back to another device. It’s AllJoyn signature in the interface looks like this;

<method name=”GetWorldAnchor”>

    <arg name=”anchorId” type=”s” direction=”in”/>

    <arg name=”byteIndex” type=”u” direction=”in”/>

    <arg name=”byteLength” type=”u” directon=”in”/>

    <arg name=”anchorData” type=”ay” direction=”out”/>

  </method>

and I found that when I called this at runtime from the client then my method’s implementation code on the server side wasn’t getting hit. All I was seeing was a client-side AllJoyn error;

ER_BUS_UNEXPECTED_SIGNATURE = 0x9015

now my method has 3 incoming parameters and a return value but it was curious to me that if I used the IoT Explorer on that interface it was showing up differently;

image

and so IoT Explorer was showing my method as having 2 inward parameters and 2 outgoing parameters or return values which isn’t what the interface specification actually says Confused smile

I wondered whether this was a bug in IoT Explorer or a bug in the runtime pieces and, through debugging the native code, I could use the debugger to cause the code to send 2 parameters rather than 3 and I could see that if I did this then the method call would cross the network and fail on the server side so it seemed that the IoT Explorer was right and my function expected 2 inward parameters and 2 outward parameters.

What wasn’t clear was…why and how to fix?

I spent about an hour before I realised that this problem came down to a type in the XML where the word “direction” had been turned into “directon” and that proved to be causing my problem – there’s a lesson in there somewhere too as the code generation tool didn’t seem to tell me anything about it and just defaulted the parameter to be outgoing.

With that simple typo fixed, I could get my code up and running properly for the first time.

Wrapping Up

Once I’d got past these stumbling blocks, the code as I have it actually seems to work in that I can run through the steps of;

  1. Run the server.
  2. Run the app on my HoloLens.
  3. See the server display that the app has connected.
  4. Use the voice command “lock” to create a world anchor, export it and upload it to the server taking a very long time.
  5. Use the voice command “cube” in a few places to create cubes.
  6. Shutdown the app and repeat 2, 3 above to see the device connect, download the anchor (taking a very long time), import it and recreate the cubes from step 5 where they were previously.

and I’ve placed the source for what I built up here;

https://github.com/mtaulty/AllJoynHoloSharing

but, because of the bad performance on copying the world anchor buffers around, I don’t think this would be a great starting point for implementing a shared holographic server and I’d go back to using the regular pieces from the HoloToolkit rather than trying to take this forward.

That said, I learned some things in playing with it and there’s probably some code in here that I’ll re-use in the future so it was worth while.