Browse Source

Replace performance sampler with moving average

master
C. J. Howard 1 year ago
parent
commit
272378911d
7 changed files with 149 additions and 144 deletions
  1. +1
    -0
      CMakeLists.txt
  2. +0
    -66
      src/debug/performance-sampler.cpp
  3. +0
    -69
      src/debug/performance-sampler.hpp
  4. +6
    -4
      src/game/context.hpp
  5. +1
    -1
      src/game/settings.hpp
  6. +3
    -4
      src/game/state/boot.cpp
  7. +138
    -0
      src/math/moving-average.hpp

+ 1
- 0
CMakeLists.txt View File

@ -1,5 +1,6 @@
cmake_minimum_required(VERSION 3.25) cmake_minimum_required(VERSION 3.25)
option(APPLICATION_NAME "Application name" "Antkeeper") option(APPLICATION_NAME "Application name" "Antkeeper")
option(APPLICATION_VERSION "Application version string" "0.0.0") option(APPLICATION_VERSION "Application version string" "0.0.0")
option(APPLICATION_AUTHOR "Application author" "C. J. Howard") option(APPLICATION_AUTHOR "Application author" "C. J. Howard")

+ 0
- 66
src/debug/performance-sampler.cpp View File

@ -1,66 +0,0 @@
/*
* Copyright (C) 2023 Christopher J. Howard
*
* This file is part of Antkeeper source code.
*
* Antkeeper source code is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Antkeeper source code 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. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Antkeeper source code. If not, see <http://www.gnu.org/licenses/>.
*/
#include "performance-sampler.hpp"
#include <algorithm>
#include <numeric>
namespace debug {
performance_sampler::performance_sampler():
sample_size(1),
sample_index(0)
{}
void performance_sampler::sample(double duration)
{
if (samples.size() < sample_size)
{
samples.push_back(duration);
}
else
{
samples[sample_index] = duration;
sample_index = (sample_index + 1) % samples.size();
}
}
void performance_sampler::reset()
{
samples.clear();
sample_index = 0;
}
void performance_sampler::set_sample_size(std::size_t size)
{
sample_size = size;
if (samples.size() > size)
{
samples.resize(size);
sample_index = 0;
}
}
double performance_sampler::mean_frame_duration() const
{
return std::accumulate(samples.begin(), samples.end(), 0.0) / static_cast<double>(samples.size());
}
} // namespace debug

+ 0
- 69
src/debug/performance-sampler.hpp View File

@ -1,69 +0,0 @@
/*
* Copyright (C) 2023 Christopher J. Howard
*
* This file is part of Antkeeper source code.
*
* Antkeeper source code is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Antkeeper source code 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. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Antkeeper source code. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef ANTKEEPER_DEBUG_PERFORMANCE_SAMPLER_HPP
#define ANTKEEPER_DEBUG_PERFORMANCE_SAMPLER_HPP
#include <cstddef>
#include <vector>
namespace debug {
/**
* Measures a rolling mean frame duration.
*/
class performance_sampler
{
public:
/// Creates a performance sampler.
performance_sampler();
/**
* Adds a frame duration to the sample.
*
* @param duration Duration of the frame.
*/
void sample(double duration);
/**
* Resets the sampling process.
*/
void reset();
/**
* Sets the number of frames in a sample.
*
* @param size Number of frames in a sample.
*/
void set_sample_size(std::size_t size);
/**
* Returns the mean frame duration.
*/
[[nodiscard]] double mean_frame_duration() const;
private:
std::vector<double> samples;
std::size_t sample_size;
std::size_t sample_index;
};
} // namespace debug
#endif // ANTKEEPER_DEBUG_PERFORMANCE_SAMPLER_HPP

+ 6
- 4
src/game/context.hpp View File

@ -23,7 +23,6 @@
#include "animation/tween.hpp" #include "animation/tween.hpp"
#include "app/input-manager.hpp" #include "app/input-manager.hpp"
#include "app/window-manager.hpp" #include "app/window-manager.hpp"
#include "debug/performance-sampler.hpp"
#include "entity/id.hpp" #include "entity/id.hpp"
#include "entity/registry.hpp" #include "entity/registry.hpp"
#include "event/subscription.hpp" #include "event/subscription.hpp"
@ -51,6 +50,7 @@
#include "utility/dict.hpp" #include "utility/dict.hpp"
#include "utility/fundamental-types.hpp" #include "utility/fundamental-types.hpp"
#include "utility/state-machine.hpp" #include "utility/state-machine.hpp"
#include "math/moving-average.hpp"
#include <AL/al.h> #include <AL/al.h>
#include <AL/alc.h> #include <AL/alc.h>
#include <entt/entt.hpp> #include <entt/entt.hpp>
@ -186,13 +186,15 @@ struct context
input::control menu_modifier_control; input::control menu_modifier_control;
std::forward_list<std::shared_ptr<::event::subscription>> menu_control_subscriptions; std::forward_list<std::shared_ptr<::event::subscription>> menu_control_subscriptions;
// Debugging
math::moving_average<float, 15> average_frame_time;
debug::cli* cli;
// Hierarchichal state machine // Hierarchichal state machine
hsm::state_machine<game::state::base> state_machine; hsm::state_machine<game::state::base> state_machine;
std::function<void()> resume_callback; std::function<void()> resume_callback;
// Debugging
debug::performance_sampler performance_sampler;
debug::cli* cli;
// Queue for scheduling "next frame" function calls // Queue for scheduling "next frame" function calls
std::queue<std::function<void()>> function_queue; std::queue<std::function<void()>> function_queue;

+ 1
- 1
src/game/settings.hpp View File

@ -45,7 +45,7 @@ bool read_or_write_setting(game::context& ctx, std::uint32_t key, T& value)
{ {
value = std::any_cast<T>(i->second); value = std::any_cast<T>(i->second);
} }
catch (const std::bad_any_cast& e)
catch (const std::bad_any_cast&)
{ {
debug::log::error("Setting type mismatch ({:x}={})", key, value); debug::log::error("Setting type mismatch ({:x}={})", key, value);
i->second = value; i->second = value;

+ 3
- 4
src/game/state/boot.cpp View File

@ -1216,9 +1216,6 @@ void boot::setup_ui()
void boot::setup_debugging() void boot::setup_debugging()
{ {
// Setup performance sampling
ctx.performance_sampler.set_sample_size(15);
ctx.cli = new debug::cli(); ctx.cli = new debug::cli();
//debug::log::info(ctx.cli->interpret("echo hi 123")); //debug::log::info(ctx.cli->interpret("echo hi 123"));
} }
@ -1313,12 +1310,14 @@ void boot::loop()
ctx.loop.tick(); ctx.loop.tick();
// Sample frame duration // Sample frame duration
ctx.performance_sampler.sample(ctx.loop.get_frame_duration());
ctx.average_frame_time(static_cast<float>(ctx.loop.get_frame_duration()));
} }
// Exit all active game states // Exit all active game states
while (!ctx.state_machine.empty()) while (!ctx.state_machine.empty())
{
ctx.state_machine.pop(); ctx.state_machine.pop();
}
} }
void boot::shutdown_audio() void boot::shutdown_audio()

+ 138
- 0
src/math/moving-average.hpp View File

@ -0,0 +1,138 @@
/*
* Copyright (C) 2023 Christopher J. Howard
*
* This file is part of Antkeeper source code.
*
* Antkeeper source code is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Antkeeper source code 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. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Antkeeper source code. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef ANTKEEPER_MATH_MOVING_AVERAGE_HPP
#define ANTKEEPER_MATH_MOVING_AVERAGE_HPP
#include <algorithm>
#include <cstdint>
#include <vector>
namespace math {
/**
* Calculates a moving average.
*
* @tparam T Value type.
* @tparam N Sample capacity.
*/
template <class T, std::size_t N>
class moving_average
{
public:
/// Type of value to average.
typedef T value_type;
/// Constructs a moving average
moving_average():
m_sample_index{0},
m_sum{0},
m_average{0}
{}
/**
* Adds a sample to the moving average. If the moving average has reached its sample capacity, the oldest sample will be discarded.
*
* @param value Sample value.
*
* @return Current average value.
*/
value_type operator()(value_type value) noexcept
{
m_sum += value;
if (m_sample_index < N)
{
m_samples[m_sample_index] = value;
++m_sample_index;
m_average = m_sum / static_cast<value_type>(m_sample_index);
}
else
{
value_type& sample = m_samples[m_sample_index % N];
m_sum -= sample;
sample = value;
++m_sample_index;
m_average = m_sum / static_cast<value_type>(N);
}
return m_average;
}
/**
* Resets the moving average.
*/
void reset() noexcept
{
m_sample_index = 0;
m_sum = value_type{0};
m_average = value_type{0};
}
/// Returns a pointer to the sample data.
[[nodiscard]] inline constexpr value_type* data() const noexcept
{
return m_samples.data();
}
/// Returns the current moving average value.
[[nodiscard]] inline value_type average() const noexcept
{
return m_average;
}
///Returns the sum of all current samples.
[[nodiscard]] inline value_type sum() const noexcept
{
return m_sum;
}
/// Returns the current number of samples.
[[nodiscard]] inline std::size_t size() const noexcept
{
return std::min<std::size_t>(m_sample_index, N);
}
/// Returns the maximum number of samples.
[[nodiscard]] inline constexpr std::size_t capacity() const noexcept
{
return N;
}
/// Return `true` if there are currently no samples in the average, `false` otherwise.
[[nodiscard]] inline constexpr bool empty() const noexcept
{
return !m_sample_index;
}
/// Return `true` if the number of samples in the average has reached its capacity, `false` otherwise.
[[nodiscard]] inline constexpr bool full() const noexcept
{
return m_sample_index >= N;
}
private:
std::size_t m_sample_index;
value_type m_samples[N];
value_type m_sum;
value_type m_average;
};
} // namespace math
#endif // ANTKEEPER_MATH_MOVING_AVERAGE_HPP

Loading…
Cancel
Save