Skip to content

vanderbilt-virtual-reality/individual-project-VietThan

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Experience "Happenings Around the World"

platform language engine vr

TABLE OF CONTENTS

INSTALLATION / DOWNLOAD

Users have three options, either (1) download the entire folder from Google Drive which contains the whole project and the built executable, or (2) download the "Build" folder from Google Drive which contains only the built executable, or (3) clone this repository and then download the missing files from Google Drive.

Project's Google Drive link: https://drive.google.com/drive/folders/1IcyC5SGtITwNdlNzdM0d2vNWOhm3cU-d?usp=sharing

Whole Project from Google Drive

This option has the most extraneous bloat.

  1. Go to project Google Drive link
  2. Download the whole folder (Total size: near 16GB)

Built Executable from Google Drive

This option won't have the Unity project.

  1. Go to project Google Drive link
  2. Download the "Build" folder only (Total size: near 4GB)

Clone this repository and get the missing files

We have not tried this method, this is purely theoretically the most efficient if successful.

  1. Clone this repository (less than 1GB)
  2. Download the following with the Google Drive link:

Built only

Using the Google Drive link, download the following .resource files into the corresponding folder. (Nearly 4GB)

Build/ProtestExperience_Data/sharedassets1.resource
Build/ProtestExperience_Data/sharedassets2.resource
Build/ProtestExperience_Data/sharedassets3.resource
Build/ProtestExperience_Data/sharedassets4.resource
Build/ProtestExperience_Data/sharedassets5.resource

Unity project

Using the GoogleDrive link, download the following video files in .mp4 format BEFORE opening the project in Unity. (Nearly 4GB)

Assets/Interactive360/Videos/ABCHongKong2VidAud.mp4
Assets/Interactive360/Videos/ABCHongKongVidAud.mp4
Assets/Interactive360/Videos/CitizenSeoulVidAud.mp4
Assets/Interactive360/Videos/NYT_Falluja_VidAud.mp4
Assets/Interactive360/Videos/UnknownBeirutVidAud.mp4

RUN & PLAY

Once there is all the .resource files in "Build\ProtestExperience_Data", the user can choose to run the "ProtestExperience.exe" in the folder "Build".

If the user has downloaded the .mp4 files into "Assets\Interactive360\Videos", the user can choose to run in Unity editor.

Oculus Rift is required for playing.

INSTRUCTIONS

Use Right controller main trigger while raycast on menu button to change videos

Press B on Right controller to make Menu UI disappear

Press Y on Left controller to go back to main menu scene

Use Right controller main trigger while ray cast on play/pause button to play/pause video

THERE IS NO PLAYBACK OR MOVEFORWARD BUTTON, USER IS COMMITTED TO THE ENTIRE VIDEO ONCE LOADED

CONTENT

NYT Fallujah (11:09)

The Fight for Falluja is produced by the New York Times. Released 11 August 2016, the video aims to have viewers "experience firsthand the battles Iraqi forces endured to retake the important strategic city of Falluja from ISIS" - from video description.

ABC Hong Kong (6:27)

Among the Hong Kong protesters in Tsim Sha Tsui is produced by ABC News Australia. Released 6 August 2019, the video aims to have viewers experience a night where "Hong Kong protesters surrounded the police station in the Kowloon district of Tsim Sha Tsui, police moved in firing tear gas to push the crowds back" - from video description.

Citizen Beirut (1:05)

Downtown Beirut Freedom Demonstration October 2019 is uploaded by user Maher Iskandar who gives credit to Yves Ackaouy. Released 20 October 2019, the video captured the Beirut demonstration singing the Lebanese anthem. The protest "constitute a reaction against sectarian rule, endemic corruption in the public sector, legislation (such as banking secrecy) that is perceived to shield the ruling class from accountability and failures from the government to provide basic services such as electricity, water and sanitation. It is suspected that the direct trigger to the protests were due to the planned taxes on gasoline, tobacco and online phone calls such as through WhatsApp" - from Wikipedia.

Citizen Seoul (2:55)

9th Candle Protest for reformation of prosecution is uploaded by user "donggi cho". Released 16 Oct 2019, the video depicts a protest in Seoul, Korea. It is unknown if this is a pro-resignation demonstration or counter demonstration for the current Korean president Moon Jae-in amidst a corruption scandal of his justice minister Cho Kuk, though likely to be an pro-resignation protest. The scene is remarkable for showing how organized a protest can be. (maybe someone who know Korean can help?).

INTERESTING DEVELOPMENT CHALLENGES

Challenge: YouTube Format for 360 Videos, Unity Video Filetype, and Open Source Solution

Unique 360 Format

Since all our videos were sourced from YouTube, it was important that the format of video provided match with what Unity was capable of rendering. Unity can render "Equirectangular" (no depth, 2D), "Cube Map" (for static usage), or "Over / Under" on its skyboxes. However, from early 2018, YouTube videos if downloaded using the common video downloaders on the internet, will have YouTube's own 3D format. People speculated that this is YouTube's decision to make videos optimized for areas that viewers are likely to watch. But this does not help development for Unity and we struggled on this problem for quite a bit.

1) Unity approved: Equirectangular

2) Unity approved: Over / Under (each half is for a different eye)

3) Unity approved: Cube Map (static only)

4) YouTube's format (notice how the bottom half is rotated 90 degrees)

Deep in Discussion Thread

The solution came from an github issue discussion in January 2018 by collaborators of youtube-dl, an open source program to download YouTube videos from the command line. There were several workarounds mentioned in the thread that involved other programs and even browser extensions, we tried them but they don't work anymore. Deeper into the thread, in May 2018, the collaborators were able to find out a weird trick with youtube-dl where with the --user-agent "" flag (noting to YouTube servers that this is not a human trying to reach their servers), the video stream retrieved from YouTube would be the "Over / Under" format. Using youtube-dl, we were able to finally download a Unity-approved 360 video, though now it's of "Equirectangular" format.

Filetypes and Another Open-Source Solution

The problem with youtube-dl was that it only download specific streams from YouTube. As such, the video and audio stream would be split into two, usually video into .mp4 or .webm, audio into .m4a or .webm . (1) youtube-dl can merge separate streams into .mkv but that filetype is not supported by Unity. (2) Attempt at using Handbrake to encode videos into mp4 from mkv is succesful but loses the audio. (3) keep the video and audio separate and put them into the project leads to bugs. And finally, (4) download and merge only webm filetype (Unity approved) leads to video codecs not yet recognized by Unity (Unity still works on the older version of codec vp8 instead of YouTube's current vp9).

In the end, another open source program came to the rescue. ffmpeg was used to merge the .m4a audio stream (first converted to .mp3) with the .mp4 video stream into a nice and clean .mp4 video that is fully supported by Unity and the project configurations.

Useful youtube-dl & ffmpeg Commands:

With youtube-dl, find out streams of video, their aspect ratio and format:

.\youtube-dl.exe --user-agent "" URL https://www.youtube.com/watch?v=4l6XrqLWu3A -F

With youtube-dl, download the exact stream provided by YouTube:

.\youtube-dl.exe --user-agent "" URL https://www.youtube.com/watch?v=4l6XrqLWu3A -f 138

With ffmpeg, merge audio and video streams:

.\ffmpeg -i UnknownBeirut.mp4 -i UnknownBeirutAudio.mp3 -map 0:v -map 1:a -c:v copy -c:a copy UnknownBeirutVidAud.mp4 -y

Challenge: Controllers and Legacy System

Backward (In)compatibility

An emblematic problem for Unity has always been backward compatibility. Developers have long learnt that even minor updates for the Unity engine can lead to substantial changes in how things are done "under the hood", leading to working projects suddenly become bug-filled messes. Our project template, though very simple, was released alongside Unity 2017.3, which is very old by Unity development cycle standard and as such we encountered a bug right away: the VR controller doesn't move.

Non-moving Controllers

This is a substantial bug. Though we can use the other templates available, it would be a step back from the interactivity that an Oculus Rift would potentially provide, and a step back from the experience we wanted to achieve. The other template that we could have used do not use the controllers and all interactions are done through the user "looking"/"gazing" at buttons long enough. The perplexing thing with our situation is that the controller buttons are still interactive. It's the controllers (or the movements of the controllers) that are missing. In fact, because the controllers spawn conveniently in a location where the raycast is on a scene button, we're actually able to launch the game without moving controllers, but able to switch into a video, and nothing else.

A Clue in the Tutorial

Looking through the game objects, and with the help of a Unity console error message, we were able to pin down that there is a particular C# script missing from the "RH" and "LH" game object. However, what is the script? Unity only knows that something is missing. The answer didn't come easily, in fact, we had to look through the video tutorial and happen to catch a frame where the object with the missing script was clicked and on the inspector the name of the script was "Tracked Pose Driver".

Legacy systems

But our problem doesn't end there. "Tracked Posed Driver" is supposed to be the general script with which an Unity project can take in a varity of inputs from different hardware (one of Unity's strengths). It used to just be provided with the installation of Unity. However, it doesn't exist anymore with our current version 2019.2.6f1 . Thankfully, we were able to find an Unity forum thread that pointed us in the direction of installing the package "XR Legacy Input Helpers". That succesfully fixed our bug, we have moving controllers, and were able to work toward other functionalities (like menu toggle and scene reset).

OUTPUT CAPTURED

To see the screen capture playing the executable, please see InBuiltVideo.mp4

To see the screen capture playing in the editor, please see InEditorVideo.mp4

To hear the game played with sound (captured through a smartphone), please see Non-CapturedVideo.mp4

MOTIVATIONS

Please see MOTIVATIONS.md.

AUTHOR

Created by Viet Than as the individual project for class "CS3892: Virtual-Reality Projects for Interdisciplinary Apps" at Vanderbilt University, Fall 2019.

Contact at [email protected] or [email protected] .

ACKNOWLEDGEMENTS

Short tutorial: YouTube video.

Long tutorial series: YouTube playlist.

Template sample project: Unity store package.

Lecturers: Prof. Robert Bodenheimer, EECS Department. Prof. Ole Molvig, History Department. Vanderbilt University

About

individual-project-VietThan created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published