Scripting Example: Llbacks.Html

Total Page:16

File Type:pdf, Size:1020Kb

Scripting Example: Llbacks.Html The FMOD & Unity Essentials Course Module 6 - Lesson 3 FMOD Callback Events Resources: Examples: Witcher 3: Blood and Wine Implementation Talk: https://www.youtube.com/watch?v=aLq0NKs3H-k Event Callbacks FMOD Scripting Example: https://www.fmod.com/resources/documentation-unity?version=2.1&page=examples-timeline-ca llbacks.html System.Runtime.InteropServices: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices?view=net-5.0 GCHandle: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.gchandle?view=net- 5.0 StructLayout(LayoutKind.Sequential): https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.structlayoutattribute ?view=net-5.0 Marshal: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.marshal?view=net-5 .0 Concepts: Managed vs Unmanaged Memory: - https://docs.microsoft.com/en-us/dotnet/standard/automatic-memory-management - https://engineering.hexacta.com/memory-a-forgotten-topic-355088e2f2c1 - https://www.red-gate.com/products/dotnet-development/ants-memory-profiler/solving-me mory-problems/understanding-and-troubleshooting-unmanaged-memory Garbage Collection and Automatic Garbage Collection: https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/fundamentals What is a Runtime Framework (.NET): https://dotnet.microsoft.com/learn/dotnet/what-is-dotnet-framework FMOD threads and asynchronicity: https://fmod.com/resources/documentation-api?version=2.1&page=white-papers-threads.html https://fmod.com/resources/documentation-api?version=2.1&page=white-papers-studio-threads. html Singleton Pattern: http://wiki.unity3d.com/index.php/Singleton Unity Physics: https://docs.unity3d.com/Manual/PhysicsSection.html Triggers and Colliders: https://learn.unity.com/tutorial/physics-interactions-colliders-and-triggers-2019-3# Layers: https://docs.unity3d.com/Manual/Layers.html LayerMasks: https://docs.unity3d.com/ScriptReference/LayerMask.html C# Comparison Operations: Logical Operators: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/operators/boolean-logical-o perators Bitwise Operators: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/operators/bitwise-and-shift- operators Terms: "this" keyword: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/this Event delegates: https://learn.unity.com/tutorial/events-uh#5c894782edbc2a1410355442 Blittable types: https://docs.microsoft.com/en-us/dotnet/framework/interop/blittable-and-non-blittable-types Pointers (in C): https://www.educative.io/edpresso/what-are-pointers-in-c IntPtr: https://docs.microsoft.com/en-us/dotnet/api/system.intptr?view=net-5.0 OnGUI: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnGUI.html System.String.Format(): https://docs.microsoft.com/en-us/dotnet/api/system.string.format?view=net-5.0 Unity Rendering: https://unity3d.com/real-time-rendering-3d Post Processing: https://docs.unity3d.com/Manual/PostProcessingOverview.html Cinemachine: https://docs.unity3d.com/Packages/[email protected]/manual/index.html ____________________________________________________________________________ Intro - 0:00 Henry: Okay now that we’ve looked at both Delegates and Return Functions, it’s time to look at using those for something more FMOD specific. We’re going to start by looking at FMOD Callbacks, however I’m not going to be the one teaching you this lesson. A good friend of mine, Colin, is going to be the instructor for you and as you’re about to see, he really knows his stuff as you’re about to see! He really understands the sort of “backend” and these “deeper systems” that FMOD uses for both Callbacks and for Programmer Instruments which is the topic of the lesson after this. I’ve just watched his lesson that he has created for Callbacks, it’s very impressive. The one thing I wanted to say is that I don’t want you guys to worry too much about learning every single specific system, tool and thing that Colin points out in this lesson. The main thing is we just want you to get confident with using these tools, so Colin is going to run you through them all, and show you how you can create a really cool system where your game responds to your music, and we can change the color of our camera, just by reading our FMOD event. So I’m going to leave you in the capable hands of Colin. As always, if you have any issues our Discord is always available to you, or you can email me of course. And I hope you enjoy! Colin: Hi, I’m Colin Vandervort, also known as ColinVAudio, and I’ll be helping Henry out for these next two lessons. If you’re interested, I have a youtube channel, twitter and instagram page, where I post about technical game audio implementation concepts and strategies. -- In this lesson, we’ll be unpacking FMOD Event Callbacks. I’ll warn you ahead of time, the implementation for this topic gets pretty complicated and ‘heady,’ but the example I’ll be providing, as well as the one provided in the FMOD documentation is pretty easy to copy and paste, and get working at a basic level. I highly recommend doing the previous lessons before this one if you haven’t, as we’ll be building on a lot of the previously covered material. -- In most game design scenarios, audio is expected to respond and react to the events that are happening in the game. If you click a button, a UI sound is played. If a creature takes a step, a footstep sound is played. If you enter combat in an action game, battle music starts playing. These are very common situations, and are pretty easy implementation problems to reason about. However, sometimes, we might want parts of the game to respond to something that’s happening in our audio instead. It’s the reverse of what we’re used to. Examples of this can be found in any rhythm game, where certain events are synchronized with the tempo or instrumentation in the music, but you’ll also find cases such as in The Witcher 3: Blood and Wine, where enemy combat animations are being predictively assigned to line up with with events in the music. -- Event Callbacks are the means FMOD uses to allow us to build these types of audio-reactive systems. More specifically, Event Callbacks give us access to any tempo, bar and beat information on a track, in real time, as well as our current position along that track, and any custom markers or time signature markers we have assigned to the track. Each time a change in any of these is detected, FMOD will call a function to send that new information to us in the game engine. We can then distribute this information to any systems that will be relying upon it. -- Today, I’ll be walking through the method that’s used in Unity, for setting up Event Callbacks on a music track, and then a common method for distributing that information to other systems. We’ll be using one of these systems in our 3D Adventure Game to trigger some screen shake on each beat of the music in our final Level 2 boss fight, and to set some post-processing color changes on our camera to match the current mood of our music. -- For reference, I’ll be using FMOD Version 2.01 and Unity Version 2020.3. -- To start out, let’s hop over into our FMOD project, and create or select a music track. FMOD Music Setup - 3:54 This will be easier to visualize if you’re using a music track with a pronounced beat, and for that reason, I’m using the battle music from the end of our second level in the 3D game kit. Make sure to add a Timeline tab to our event if you don’t have one already, and place your music on it. Now, right click the Logic Tracks section in our timeline and add a tempo marker for each tempo or time signature section in your track. In our case, this is 112 BPM at 4/4 time. We’ll be using this tempo and time signature data to control our beat event callbacks, and trigger our screen shake event. Additionally, make sure the track loops. From here, create a few destination makers, and scatter them around your track. We won’t be using these for any logical purpose within FMOD, but we will be using their “string” names to apply specific behaviors when they’re reached. Place them in any section of your track where you’d like to highlight a tonal shift, and then give them a name. In my case, I’ll be naming them directly after the post processing colors I’ll be applying to our camera when they’re reached, but they can be realistically named anything. Chorus, Verse and Bridge are some example names that could work. Intro, low-intensity, and high-intensity might also be good names. The only caveat is there cannot be two markers that share the same name, back to back, or the second one won’t be detected as a new marker by our system. -- Now, because I’m mimicking the functionality that the Unity Battle music already had, I’ll be adding a global parameter entitled “MusicSection.” This parameter will be used to fade our battle music in and out when we enter and exit our boss battle arena. The parameter will be continuous, and mapped from 0 to 1. We’ll assign our volume curve such that 0 is silent and 1 is full volume. If you already have general level music set up in your scene, you’ll want to create the opposing automation curve on that music so that it fades out as the battle music fades in.
Recommended publications
  • Audio Middleware the Essential Link from Studio to Game Design
    AUDIONEXT B Y A LEX A N D E R B R A NDON Audio Middleware The Essential Link From Studio to Game Design hen I first played games such as Pac Man and GameCODA. The same is true of Renderware native audio Asteroids in the early ’80s, I was fascinated. tools. One caveat: Criterion is now owned by Electronic W While others saw a cute, beeping box, I saw Arts. The Renderware site was last updated in 2005, and something to be torn open and explored. How could many developers are scrambling to Unreal 3 due to un- these games create sounds I’d never heard before? Back certainty of Renderware’s future. Pity, it’s a pretty good then, it was transistors, followed by simple, solid-state engine. sound generators programmed with individual memory Streaming is supported, though it is not revealed how registers, machine code and dumb terminals. Now, things it is supported on next-gen consoles. What is nice is you are more complex. We’re no longer at the mercy of 8-bit, can specify whether you want a sound streamed or not or handing a sound to a programmer, and saying, “Put within CAGE Producer. GameCODA also provides the it in.” Today, game audio engineers have just as much ability to create ducking/mixing groups within CAGE. In power to create an exciting soundscape as anyone at code, this can also be taken advantage of using virtual Skywalker Ranch. (Well, okay, maybe not Randy Thom, voice channels. but close, right?) Other than SoundMAX (an older audio engine by But just as a single-channel strip on a Neve or SSL once Analog Devices and Staccato), GameCODA was the first baffled me, sound-bank manipulation can baffle your audio engine I’ve seen that uses matrix technology to average recording engineer.
    [Show full text]
  • Foundations for Music-Based Games
    Die approbierte Originalversion dieser Diplom-/Masterarbeit ist an der Hauptbibliothek der Technischen Universität Wien aufgestellt (http://www.ub.tuwien.ac.at). The approved original version of this diploma or master thesis is available at the main library of the Vienna University of Technology (http://www.ub.tuwien.ac.at/englweb/). MASTERARBEIT Foundations for Music-Based Games Ausgeführt am Institut für Gestaltungs- und Wirkungsforschung der Technischen Universität Wien unter der Anleitung von Ao.Univ.Prof. Dipl.-Ing. Dr.techn. Peter Purgathofer und Univ.Ass. Dipl.-Ing. Dr.techn. Martin Pichlmair durch Marc-Oliver Marschner Arndtstrasse 60/5a, A-1120 WIEN 01.02.2008 Abstract The goal of this document is to establish a foundation for the creation of music-based computer and video games. The first part is intended to give an overview of sound in video and computer games. It starts with a summary of the history of game sound, beginning with the arguably first documented game, Tennis for Two, and leading up to current developments in the field. Next I present a short introduction to audio, including descriptions of the basic properties of sound waves, as well as of the special characteristics of digital audio. I continue with a presentation of the possibilities of storing digital audio and a summary of the methods used to play back sound with an emphasis on the recreation of realistic environments and the positioning of sound sources in three dimensional space. The chapter is concluded with an overview of possible categorizations of game audio including a method to differentiate between music-based games.
    [Show full text]
  • The Impact of Multichannel Game Audio on the Quality of Player Experience and In-Game Performance
    The Impact of Multichannel Game Audio on the Quality of Player Experience and In-game Performance Joseph David Rees-Jones PhD UNIVERSITY OF YORK Electronic Engineering July 2018 2 Abstract Multichannel audio is a term used in reference to a collection of techniques designed to present sound to a listener from all directions. This can be done either over a collection of loudspeakers surrounding the listener, or over a pair of headphones by virtualising sound sources at specific positions. The most popular commercial example is surround-sound, a technique whereby sounds that make up an auditory scene are divided among a defined group of audio channels and played back over an array of loudspeakers. Interactive video games are well suited to this kind of audio presentation, due to the way in which in-game sounds react dynamically to player actions. Employing multichannel game audio gives the potential of immersive and enveloping soundscapes whilst also adding possible tactical advantages. However, it is unclear as to whether these factors actually impact a player’s overall experience. There is a general consensus in the wider gaming community that surround-sound audio is beneficial for gameplay but there is very little academic work to back this up. It is therefore important to investigate empirically how players react to multichannel game audio, and hence the main motivation for this thesis. The aim was to find if a surround-sound system can outperform other systems with fewer audio channels (like mono and stereo). This was done by performing listening tests that assessed the perceived spatial sound quality and preferences towards some commonly used multichannel systems for game audio playback over both loudspeakers and headphones.
    [Show full text]
  • CRYENGINE Audio Tutorial
    Course Setup • Navigate the CRYENGINE interface, Editor, and tool set • Add ambient sounds • Link ambient sounds to changing time of day • Installing CRYENGINE Add audio triggers • Link sounds to character actions (footsteps, shooting, etc.) This course requires CRYENGINE 5.5.2 or higher. Here are the steps to install it: • Link sounds to particle effects 1. Download and install the free CRYENGINE Launcher from here by clicking This tutorial covers the use of FMOD Studio. Please refer to the online tutorial for on the Download button. Please note that you will need to create a free information on using SDL Mixer and FMOD. CRYENGINE account if you don’t already have one. If you need additional help creating your account, refer to our Installation Quick Start guide. 1. Start the Launcher and sign in to your CRYENGINE account. Course Workbook Conventions 2. Install the latest version of the engine using the Library > My Engines tab in To help you understand the text in this workbook, we have used the following for- the Launcher. matting conventions: • Important concepts are highlighted in bold, or refer to something you can do or click on: a button, entity, menu item, etc. • Nested items in menus or tool panels are separated with the right caret char- acter, e.g.: Tools > Level Editor > Create Object. • Concepts and goals are explained first, followed by the exactstep-by-step in- structions to achieve them. Tips about best practices look like this grey box. Pro Tip: This is a “pro tip” suggesting best practices or informing you about something of particular importance.
    [Show full text]
  • Scream -- Supercollider Resource for Electro-Acoustic Music
    SCREAM – SuperCollider Resource for Electro-Acoustic Music Michael Leahy* *EGR & Recombinant Media Labs [email protected] Abstract efficient client/server based networking system for OSC communication, and hardware accelerated 2D/3D graphics SuperCollider3 is a major achievement for programmatic library support. real time audio synthesis. However, the adoption of SuperCollider3 has been limited to a small community due to it being a domain specific language/environment and the 2.1 High Level Language Support difficulty of using the tools provided in the default Scream is constructed in the Java programming distribution. The SuperCollider3 language is a powerful language. There are many benefits to using a high level tool to interact with the SuperCollider3 server, but requires language to connect to the SC3 Server. The first and the user to engage SuperCollider3 through a programming foremost benefit is that Java is an easy to understand and language. Scream is a high level component oriented mature object oriented language that supports rapid framework built in Java to interact directly with the component oriented development. Java also provides several SuperCollider3 server. Scream enables complete auxiliary APIs for networking, MIDI, graphics (Java2D, applications to be built with sophisticated GUIs that are JOGL, LWJGL), and cross platform support. accessible to users of all skill level while maintaining an An immediate concern of using Java is the ability to API for developers to create new software. create a real time system appropriate for music performance and creating multimedia interfaces. JFC/Swing is the 1 Introduction standard GUI toolkit available, but is not necessarily a real time capable system.
    [Show full text]
  • Overview Memory
    Overview There are several ways to profile sound and music and investigate different technical aspects. Here is an overview. Memory MemStats MemInfo CPU Time Load Stalls Profiler VU Meter Sound Management Optimizing Audio Using the FMOD built-in profiler Memory Sound memory is managed as a cache within static or rather dynamic sizes. If a static memory block is allocated then it is spent no matter how much audio data is stored. Sometimes old and unused data needs to be unloaded (trashed), before new data can be stored. Therefore, the goal is to find a good balance between cache size and trashing. Depending on the platform, memory can be divided into different types and uses: Memory Type Description System Memory With the transition to memory pools the system memory that is located in main memory is used to store data that the SoundSystem needs to function correctly. Primary Sound Sound, music, DSP, and voice data is stored in this area of main memory. It is planned to fully flush this memory during level load. Memory Secondary Sound On PlayStation 3 this memory is located through the graphics processor. It's slower to access but can be combined with the Memory precious main memory. On Xbox 360 physical memory has to be used for direct XMA decoding instead of the main memory, which can be "virtual". On the PC there is no need to use this memory type. MemStats MemStats n queries all modules in CRYENGINE to report back their used memory every second. It is not recommended to use values lower than 1000 as it would output too much data to make the readout manageable.
    [Show full text]
  • Joël A. Lamotte Born: 1983 – French Tel: 0(+33)6.52.26.61.58 Email: [email protected]
    Joël A. Lamotte Born: 1983 – French Tel: 0(+33)6.52.26.61.58 email: [email protected] PROFESSIONAL EXPERIENCE Independent - Lille (France) (Since July 2012) Projects: Working on NetRush (RTS game) and Art Of Sequence (OSS digital story-telling tools) Developed a client-server multi-process concurrent-tasks game-specific engine for the needs of NetRush (RTS game). Learned a lot about concurrency (using C++) while doing so, using the practical case of this game. Designed NetRush and several other smaller game prototypes. Developed and published an interpreter for AOSL in JavaScript as a partial Proof of Concept of Art of Sequence projects. Development on Art Of Sequence tools are still going on. Kayac - Kamakura (Japan) Creator (2012, 4 months) Projects: Make Games (Farmer Carrots Zombies , unreleased rogue-like prototype) Provided international game development expertise and point of view to the company that wished to sell games worldwide. Challenged to develop an iOS game in no time. It took us 2 weeks to produce FCZ, I made all the code and sound design and half of the game design. However, pressed by the time we were not able to do better. Releasing it publicly what not my decision but I did my best to make it enjoyable. Learned iOS (ObjectiveC/C++) development, Japanese keyboard, MacOSX use and Cocos2D-X (which I patched and provided back to the devs) in a very short time. Proposed 7 game concepts to work on next (after FCZ) which have all been approved, the game development team being confident in my skills, they suggested that I should chose the project myself.
    [Show full text]
  • How to Optimize the Implementation Process and Data Management in Game Audio Production
    How to optimize the implementation process and data management in game audio production Master’s thesis - Aalto University Mikko Kolehmainen Abstract While video games are getting more complex, the amount of required audio content keeps increasing. Copious amounts of audio files are usually implemented manually and require consistent data management. This master’s thesis is a study on the challenges typically encountered in large-scale game audio productions, where the often preferred linear workflows lead into new challenges, and whether these challenges could be solved with new tools such as custom extensions for middleware. Through detailed description of development and functionality of an example solution, the possible ways of using automation to optimize the audio implementation process and data management are shown. Finally, future development is discussed based on findings. Tiivistelmä Kun videopelit kehittyvät laajemmiksi ja monimutkaisemmiksi, tarvittavan äänisisällön tarve kasvaa. Valtavat määrät äänitiedostoja täytyy manuaalisesti integroida peliin, sekä datan hallinta vaatii tehokkaat työkalut. Työ on katsaus tyypillisiin videopeli-äänituotannon haasteisiin isoissa produktioissa, usein suosittujen lineaaristen työtapojen aiheuttamiin ongelmiin sekä niiden mahdollisiin ratkaisuihin mukautettujen sovellusten avulla. Työ esittelee esimerkin hyödyntää automaatiota datan hallinnan ja integroinnin optimoimiseksi käyden läpi esimerkkisovelluksen kehityksen ja toiminnallisuuden. Lopuksi ajatuksia jatkokehityksestä ja peliäänen tulevaisuudesta
    [Show full text]
  • Intelligent Implementation Keeping the Program Lead Off Your Back
    Intelligent implementation Keeping the Program Lead off your back Alistair Hirst General Manager Introduction ● Started in games 1990 ● Sega Genesis: ●6 voices of FM ●5 voices and one voice 8 bit 11kHz sample Introduction ● In 20 years ● VR Worlds, jacked in ● still fighting with simulation and graphics for resources. The Problem ● Resources are limited The Problem ● Resources are limited ● Trade offs need to be made ● Biggest bang for the buck The Problem ● Resources are limited ● Trade offs need to be made ● Biggest bang for the buck ● Trade offs are different depending on the platform and game. Find the bottleneck and balance. Trade offs Number Voices Fidelity Streams Effect Sample Quality Rate RAM Latency Game Event Data Buffer Driven Changes Compression size 122 FMOD DESIGNER Effects Reference Guide This section describes all the properties of effects used in FMOD Designer 2010. There are two types of effects: Property Automation Effects. This type of effect provides the sound designer the ability to manipulate or sequence properties such as volume or pitch. These effects use no additional CPU. FMOD DSP Effect. This type of effect uses DSP (digital signal processing) plug-ins to manipulate the audio stream in real-time, allowing the sound designer to radically alter a sound's timbre by adding distortion, filtering and echo. The properties of these effects can be set or sequenced using effect envelopes. In general, DSP plug-in effects require more CPU. Note: Versions of Designer 1.07.09 and above, support multiple pitch effects on each layer. For each effect, a relative CPU and memory usage rating is given.
    [Show full text]
  • Oldunreal Patch Version 227
    Oldunreal Patch Version 227 If you like those updates you can visit www.oldunreal.com and help me to keep it alive with a donation, its not easy for me nowadays, and with a little bit help you can help me improve these drivers, to buy new hardware for testing purposes, and it allows me to spend more time for it and the page itself. This package was created with knowledge and permission of Epic MegaGames, Inc. This package is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. These updates are made by Oldunreal, and are completely free. The package may be redistributed without the author's prior permission, and must remain unmodified, but if you offer them for download somewhere please refer to my page. This package can be offered for download everywhere as long it is of no charge. This means especially those filesharing pages in which you have to register (and maybe pay) to get it. If you can't offer it for free don't put it on your page. The license for OpenAL (www.openal.org, made by Creative Labs, Inc, www.creativelabs.com) and the license for Fmod (FMOD Sound System, copyright © Firelight Technologies Pty, Ltd., 1994-2005, www.fmod.org) which are used and shipped with these patches forbid a commercial use in any way too. Initial 227 features list (more features and Details in the changelogs below): A native Linux port is now availible, which runs with OpenGL and SDLSoftDriver for grafix and FMOD for sound.
    [Show full text]
  • Panda3d Tutorial
    Content INTRODUCTION..............................................................................................................................5 Conventions................................................................................................................................6 Reader Feedback, Errata and Questions.....................................................................................6 CHAPTER 1: IMAGINE...................................................................................................................7 Finding ideas...............................................................................................................................8 The basic idea..............................................................................................................................9 Fine-tuning the idea..................................................................................................................10 Splitting up the idea...................................................................................................................11 Prototyping...........................................................................................................................13 Project planning........................................................................................................................14 Design document..................................................................................................................14 Time and human resource planning.....................................................................................14
    [Show full text]
  • Cross Compiling the FMOD Library Joshua Gastaldello, Kevin Chen, Tyler Rubenuik, Patrick Wan
    Cross compiling the FMOD Library Joshua Gastaldello, Kevin Chen, Tyler Rubenuik, Patrick Wan Simon Fraser University CMPT 433 Brian Fraser Fall 2015 Table of Contents Intro to the FMOD Library ............................................................................................................................. 2 What is FMOD? ......................................................................................................................................... 2 Why did we choose FMOD? ...................................................................................................................... 2 How did we use FMOD? ............................................................................................................................ 2 Download and Extract the FMOD Library ..................................................................................................... 2 Install the g++ compiler on the target .......................................................................................................... 2 Get the libstdc++.so.6 file ............................................................................................................................. 3 Copy the library files to the BBB ................................................................................................................... 3 Compiling the Examples ................................................................................................................................ 3 Notes ............................................................................................................................................................
    [Show full text]