Skip to content

Commit

Permalink
Add 0-wrapping_unsafe_apis audio example
Browse files Browse the repository at this point in the history
Add an example of wrapping an unsafe OS or host application API with a
type-safe quanitites API.  The `audio::get_musical_context` API used in
this example will also be used in other audio examples.
  • Loading branch information
rothmichaels committed Dec 19, 2024
1 parent 39acaff commit f4fe2bd
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
52 changes: 52 additions & 0 deletions example/audio/0-wrapping_unsafe_apis.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
// The MIT License (MIT)
//
// Copyright (c) 2024 Roth Michaels
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#include <mp-units/ext/format.h>
#ifdef MP_UNITS_IMPORT_STD
import std;
#else
#include <iostream>
#endif
#ifdef MP_UNITS_MODULES
import mp_units;
#else
#include <mp-units/format.h>
#endif

#include "third_party_audio_api.h"
#include "wrapped_third_party_audio_api.h"

int main()
{
// Operating system or host applications will provide APIs with various musical context information such as tempo and
// sample rate, but these APIs are not type safe using float or double values; e.g.:
const auto unsafe_context = audio_third_party::get_musical_context();

std::cout << MP_UNITS_STD_FMT::format("Musical context:\n\tTempo: {}\n\tSample Rate: {}\n\n", unsafe_context.tempo,
unsafe_context.sample_rate);

// These unsafe APIs can be wrapped a new API returning type-safe quantities for tempo and sample rate; e.g.:
const auto safe_context = audio::get_musical_context();

std::cout << MP_UNITS_STD_FMT::format("Musical context:\n\tTempo: {}\n\tSample Rate: {}\n", safe_context.tempo,
safe_context.sample_rate);
}
1 change: 1 addition & 0 deletions example/audio/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

add_example(0-wrapping_unsafe_apis)
add_example(1-lfo)

0 comments on commit f4fe2bd

Please sign in to comment.