virtualx-engine/scene/gui/video_stream_player.h
Rémi Verschelde d95794ec8a
One Copyright Update to rule them all
As many open source projects have started doing it, we're removing the
current year from the copyright notice, so that we don't need to bump
it every year.

It seems like only the first year of publication is technically
relevant for copyright notices, and even that seems to be something
that many companies stopped listing altogether (in a version controlled
codebase, the commits are a much better source of date of publication
than a hardcoded copyright statement).

We also now list Godot Engine contributors first as we're collectively
the current maintainers of the project, and we clarify that the
"exclusive" copyright of the co-founders covers the timespan before
opensourcing (their further contributions are included as part of Godot
Engine contributors).

Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 13:25:55 +01:00

127 lines
4.4 KiB
C++

/**************************************************************************/
/* video_stream_player.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. */
/**************************************************************************/
#ifndef VIDEO_STREAM_PLAYER_H
#define VIDEO_STREAM_PLAYER_H
#include "scene/gui/control.h"
#include "scene/resources/video_stream.h"
#include "servers/audio/audio_rb_resampler.h"
#include "servers/audio_server.h"
class VideoStreamPlayer : public Control {
GDCLASS(VideoStreamPlayer, Control);
struct Output {
AudioFrame vol;
int bus_index = 0;
Viewport *viewport = nullptr; //pointer only used for reference to previous mix
};
Ref<VideoStreamPlayback> playback;
Ref<VideoStream> stream;
int sp_get_channel_count() const;
bool mix(AudioFrame *p_buffer, int p_frames);
RID stream_rid;
Ref<ImageTexture> texture;
AudioRBResampler resampler;
Vector<AudioFrame> mix_buffer;
int wait_resampler = 0;
int wait_resampler_limit = 2;
bool paused = false;
bool paused_from_tree = false;
bool autoplay = false;
float volume = 1.0;
double last_audio_time = 0.0;
bool expand = false;
bool loops = false;
int buffering_ms = 500;
int audio_track = 0;
int bus_index = 0;
StringName bus;
void _mix_audio();
static int _audio_mix_callback(void *p_udata, const float *p_data, int p_frames);
static void _mix_audios(void *p_self);
protected:
static void _bind_methods();
void _notification(int p_notification);
void _validate_property(PropertyInfo &p_property) const;
public:
Size2 get_minimum_size() const override;
void set_expand(bool p_expand);
bool has_expand() const;
Ref<Texture2D> get_video_texture() const;
void set_stream(const Ref<VideoStream> &p_stream);
Ref<VideoStream> get_stream() const;
void play();
void stop();
bool is_playing() const;
void set_paused(bool p_paused);
bool is_paused() const;
void set_volume(float p_vol);
float get_volume() const;
void set_volume_db(float p_db);
float get_volume_db() const;
String get_stream_name() const;
double get_stream_position() const;
void set_stream_position(double p_position);
void set_autoplay(bool p_enable);
bool has_autoplay() const;
void set_audio_track(int p_track);
int get_audio_track() const;
void set_buffering_msec(int p_msec);
int get_buffering_msec() const;
void set_bus(const StringName &p_bus);
StringName get_bus() const;
VideoStreamPlayer();
~VideoStreamPlayer();
};
#endif // VIDEO_STREAM_PLAYER_H