klang::Debug

The Klang debug interface. More...

#include <klang.h>

Inheritance diagram for klang::Debug:

Classes
struct	Buffer
	Audio buffer for debug output. More...

Public Member Functions
void	print (const char *format,...)
void	printOnce (const char *format,...)
bool	hasText () const
int	getText (char *buffer)
	operator const signal & () const
void	input () override
virtual const signal &	input () const
virtual void	input (const signal &source)
virtual void	operator<< (const signal &source)

Static Public Member Functions
template<typename Func , typename... Args>
static double	profile (Func func, Args... args)
template<typename Func , typename... Args>
static double	profile (int times, Func func, Args... args)

Public Attributes
Console	console
	Debug console output.
signal	in

Static Public Attributes
static THREAD_LOCAL Buffer	buffer

Detailed Description

Definition at line 2230 of file klang.h.

Member Function Documentation

getText()

int klang::Debug::getText ( char * buffer )

inline

Definition at line 2374 of file klang.h.

                              {
      return console.getText(buffer);
    }

References console, and klang::Console::getText().

hasText()

bool klang::Debug::hasText ( ) const

inline

Definition at line 2370 of file klang.h.

                         {
      return console.hasText();
    }

References console, and klang::Console::hasText().

input() [1/3]

void klang::Debug::input ( )

inlineoverridevirtual

Reimplemented from klang::Generic::Input< signal >.

Definition at line 2383 of file klang.h.

                          {
      buffer += in;
    }

References buffer, and klang::Debug::Buffer::operator+=().

input() [2/3]

virtual const signal & klang::Generic::Input< signal >::input ( ) const

inlinevirtualinherited

Reimplemented in klang::Generic::Graph< SIZE >::Series.

Definition at line 1343 of file klang.h.

{ return in; }

input() [3/3]

virtual void klang::Generic::Input< signal >::input ( const signal & source )

inlinevirtualinherited

Definition at line 1347 of file klang.h.

{ in = source; input(); }

operator const signal &()

klang::Debug::operator const signal & ( ) const

inline

Definition at line 2378 of file klang.h.

                                    {
      return buffer.operator const klang::signal & ();
    }

References buffer, and klang::Debug::Buffer::operator const signal &().

operator<<()

virtual void klang::Generic::Input< signal >::operator<< ( const signal & source )

inlinevirtualinherited

Definition at line 1346 of file klang.h.

{ in = source; input(); }

print()

void klang::Debug::print ( const char * format, ... )

inline

Definition at line 2344 of file klang.h.

                                        {
      if (console.length < 10000) {
        THREAD_LOCAL static char string[1024] = { 0 };
        string[0] = 0;
        va_list args;                     // Initialize the variadic argument list
        va_start(args, format);           // Start variadic argument processing
        vsnprintf(string, 1024, format, args);  // Safely format the string into the buffer
        va_end(args);                     // Clean up the variadic argument list
        console += string;
      }
    }

References console, klang::Console::length, and klang::Console::operator+=().

printOnce()

void klang::Debug::printOnce ( const char * format, ... )

inline

Definition at line 2356 of file klang.h.

                                            {
      if (console.length < 1024) {
        THREAD_LOCAL static char string[1024] = { 0 };
        string[0] = 0;
        va_list args;                     // Initialize the variadic argument list
        va_start(args, format);           // Start variadic argument processing
        vsnprintf(string, 1024, format, args);  // Safely format the string into the buffer
        va_end(args);                     // Clean up the variadic argument list
 
        if (console.last != string)
          console += string;
      }
    }

References console, klang::Console::last, klang::Console::length, klang::Text< SIZE >::operator!=(), and klang::Console::operator+=().

profile() [1/2]

template<typename Func , typename... Args>

static double klang::Debug::profile ( Func func, Args... args )

inlinestatic

Definition at line 2300 of file klang.h.

                                                          {
      using namespace std::chrono;
 
      auto start = high_resolution_clock::now();
      func(args...);
      auto end = high_resolution_clock::now();
 
      auto duration = duration_cast<nanoseconds>(end - start).count();
      return (double)duration;
    }

profile() [2/2]

template<typename Func , typename... Args>

static double klang::Debug::profile ( int times, Func func, Args... args )

inlinestatic

Definition at line 2312 of file klang.h.

                                                                     {
      double sum = 0;
      while (times--) {
        sum += profile(func, args...);
      }
      return sum / 1000000.0;
    }

Member Data Documentation

buffer

THREAD_LOCAL Debug::Buffer klang::Debug::buffer

inlinestatic

Definition at line 2294 of file klang.h.

Referenced by input(), operator const signal &(), klang::Effect::process(), klang::Note::process(), and klang::Stereo::Effect::process().

console

Console klang::Debug::console

Definition at line 2297 of file klang.h.

Referenced by getText(), hasText(), print(), and printOnce().

in

signal klang::Generic::Input< signal >::in

inherited

Definition at line 1340 of file klang.h.

{ 0.f };