2023-01-05 12:25:55 +00:00
|
|
|
/**************************************************************************/
|
|
|
|
/* audio_driver_dummy.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* */
|
|
|
|
/* 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. */
|
|
|
|
/**************************************************************************/
|
2018-01-04 23:50:27 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
#ifndef AUDIO_DRIVER_DUMMY_H
|
|
|
|
#define AUDIO_DRIVER_DUMMY_H
|
|
|
|
|
2017-01-15 19:06:14 +00:00
|
|
|
#include "servers/audio_server.h"
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
#include "core/os/mutex.h"
|
|
|
|
#include "core/os/thread.h"
|
2022-08-19 08:38:13 +00:00
|
|
|
#include "core/templates/safe_refcount.h"
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2017-01-15 19:06:14 +00:00
|
|
|
class AudioDriverDummy : public AudioDriver {
|
2021-01-19 12:29:41 +00:00
|
|
|
Thread thread;
|
2020-02-26 10:28:13 +00:00
|
|
|
Mutex mutex;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-04-04 13:06:57 +00:00
|
|
|
int32_t *samples_in = nullptr;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
static void thread_func(void *p_udata);
|
|
|
|
|
Implement Running Godot as Movie Writer
* Allows running the game in "movie writer" mode.
* It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time).
* If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult.
* Implements a simple, default MJPEG writer.
This new features has two main use cases, which have high demand:
* Saving game videos in high quality and ensuring the frame rate is *completely* stable, always.
* Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this).
**Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly).
Usage:
$ godot --write-movie movie.avi [scene_file.tscn]
Missing:
* Options for configuring video writing via GLOBAL_DEF
* UI Menu for launching with this mode from the editor.
* Add to list of command line options.
* Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
|
|
|
uint32_t buffer_frames = 4096;
|
|
|
|
int32_t mix_rate = -1;
|
|
|
|
SpeakerMode speaker_mode = SPEAKER_MODE_STEREO;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
int channels;
|
|
|
|
|
2022-08-19 08:38:13 +00:00
|
|
|
SafeFlag active;
|
|
|
|
SafeFlag exit_thread;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
Implement Running Godot as Movie Writer
* Allows running the game in "movie writer" mode.
* It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time).
* If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult.
* Implements a simple, default MJPEG writer.
This new features has two main use cases, which have high demand:
* Saving game videos in high quality and ensuring the frame rate is *completely* stable, always.
* Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this).
**Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly).
Usage:
$ godot --write-movie movie.avi [scene_file.tscn]
Missing:
* Options for configuring video writing via GLOBAL_DEF
* UI Menu for launching with this mode from the editor.
* Add to list of command line options.
* Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
|
|
|
bool use_threads = true;
|
|
|
|
|
|
|
|
static AudioDriverDummy *singleton;
|
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
public:
|
2023-02-08 15:40:15 +00:00
|
|
|
virtual const char *get_name() const override {
|
2014-02-10 01:10:30 +00:00
|
|
|
return "Dummy";
|
|
|
|
};
|
|
|
|
|
2023-02-08 15:40:15 +00:00
|
|
|
virtual Error init() override;
|
|
|
|
virtual void start() override;
|
|
|
|
virtual int get_mix_rate() const override;
|
|
|
|
virtual SpeakerMode get_speaker_mode() const override;
|
|
|
|
|
|
|
|
virtual void lock() override;
|
|
|
|
virtual void unlock() override;
|
|
|
|
virtual void finish() override;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
Implement Running Godot as Movie Writer
* Allows running the game in "movie writer" mode.
* It ensures entirely stable framerate, so your run can be saved stable and with proper sound (which is impossible if your CPU/GPU can't sustain doing this in real-time).
* If disabling vsync, it can save movies faster than the game is run, but if you want to control the interaction it can get difficult.
* Implements a simple, default MJPEG writer.
This new features has two main use cases, which have high demand:
* Saving game videos in high quality and ensuring the frame rate is *completely* stable, always.
* Using Godot as a tool to make movies and animations (which is ideal if you want interaction, or creating them procedurally. No other software is as good for this).
**Note**: This feature **IS NOT** for capturing real-time footage. Use something like OBS, SimpleScreenRecorder or FRAPS to achieve that, as they do a much better job at intercepting the compositor than Godot can probably do using Vulkan or OpenGL natively. If your game runs near real-time when capturing, you can still use this feature but it will play no sound (sound will be saved directly).
Usage:
$ godot --write-movie movie.avi [scene_file.tscn]
Missing:
* Options for configuring video writing via GLOBAL_DEF
* UI Menu for launching with this mode from the editor.
* Add to list of command line options.
* Add a feature tag to override configurations when movie writing (fantastic for saving videos with highest quality settings).
2022-06-16 22:55:19 +00:00
|
|
|
void set_use_threads(bool p_use_threads);
|
|
|
|
void set_speaker_mode(SpeakerMode p_mode);
|
|
|
|
void set_mix_rate(int p_rate);
|
|
|
|
|
|
|
|
uint32_t get_channels() const;
|
|
|
|
|
|
|
|
void mix_audio(int p_frames, int32_t *p_buffer);
|
|
|
|
|
|
|
|
static AudioDriverDummy *get_dummy_singleton() { return singleton; }
|
|
|
|
|
|
|
|
AudioDriverDummy();
|
2020-05-19 09:24:58 +00:00
|
|
|
~AudioDriverDummy() {}
|
2014-02-10 01:10:30 +00:00
|
|
|
};
|
|
|
|
|
2022-07-23 21:41:51 +00:00
|
|
|
#endif // AUDIO_DRIVER_DUMMY_H
|