mirror of https://github.com/godotengine/godot.git
Updates VideoDecoder plugin API to GDExtension.
Adds VideoStream and relevant resource loaders to migrate external GDNative plugins to GDExtension. Adds a VideoStreamLoader as a specialization of ResourceFormatLoader as ClassDB::is_parent_class is inaccessible from GDExtension currently. Using Object* instead of Ref<T> in order to avoid the refcount bug (godotengine/godot-cpp#652) Also another bug is in ResourceLoader in use on the extension side that requires fixing.pull/62737/head
anish bhobe
Lyuma
parent
e9de988020
commit
42a9c33fad
@ -0,0 +1,104 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VideoStreamPlayback" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<brief_description>
|
||||
Internal class used by [VideoStream] to manage playback state when played from a [VideoStreamPlayer].
|
||||
</brief_description>
|
||||
<description>
|
||||
This class is intended to be overridden by video decoder extensions with custom implementations of [VideoStream].
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="_get_channels" qualifiers="virtual const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the number of audio channels.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_length" qualifiers="virtual const">
|
||||
<return type="float" />
|
||||
<description>
|
||||
Returns the video duration in seconds, if known, or 0 if unknown.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_mix_rate" qualifiers="virtual const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the audio sample rate used for mixing.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_playback_position" qualifiers="virtual const">
|
||||
<return type="float" />
|
||||
<description>
|
||||
Return the current playback timestamp. Called in response to the [member VideoStreamPlayer.stream_position] getter.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_texture" qualifiers="virtual const">
|
||||
<return type="Texture2D" />
|
||||
<description>
|
||||
Allocates a [Texture2D] in which decoded video frames will be drawn.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_is_paused" qualifiers="virtual const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns the paused status, as set by [method _set_paused].
|
||||
</description>
|
||||
</method>
|
||||
<method name="_is_playing" qualifiers="virtual const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns the playback state, as determined by calls to [method _play] and [method _stop].
|
||||
</description>
|
||||
</method>
|
||||
<method name="_play" qualifiers="virtual">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Called in response to [member VideoStreamPlayer.autoplay] or [method VideoStreamPlayer.play]. Note that manual playback may also invoke [method _stop] multiple times before this method is called. [method _is_playing] should return true once playing.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_seek" qualifiers="virtual">
|
||||
<return type="void" />
|
||||
<param index="0" name="time" type="float" />
|
||||
<description>
|
||||
Seeks to [code]time[/code] seconds. Called in response to the [member VideoStreamPlayer.stream_position] setter.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_set_audio_track" qualifiers="virtual">
|
||||
<return type="void" />
|
||||
<param index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Select the audio track [code]idx[/code]. Called when playback starts, and in response to the [member VideoStreamPlayer.audio_track] setter.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_set_paused" qualifiers="virtual">
|
||||
<return type="void" />
|
||||
<param index="0" name="paused" type="bool" />
|
||||
<description>
|
||||
Set the paused status of video playback. [method _is_paused] must return [code]paused[/code]. Called in response to the [member VideoStreamPlayer.paused] setter.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_stop" qualifiers="virtual">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Stops playback. May be called multiple times before [method _play], or in response to [method VideoStreamPlayer.stop]. [method _is_playing] should return false once stopped.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_update" qualifiers="virtual">
|
||||
<return type="void" />
|
||||
<param index="0" name="delta" type="float" />
|
||||
<description>
|
||||
Ticks video playback for [code]delta[/code] seconds. Called every frame as long as [method _is_paused] and [method _is_playing] return true.
|
||||
</description>
|
||||
</method>
|
||||
<method name="mix_audio">
|
||||
<return type="int" />
|
||||
<param index="0" name="num_frames" type="int" />
|
||||
<param index="1" name="buffer" type="PackedFloat32Array" default="PackedFloat32Array()" />
|
||||
<param index="2" name="offset" type="int" default="0" />
|
||||
<description>
|
||||
Render [code]num_frames[/code] audio frames (of [method _get_channels] floats each) from [code]buffer[/code], starting from index [code]offset[/code] in the array. Returns the number of audio frames rendered, or -1 on error.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
</class>
|
||||
@ -0,0 +1,198 @@
|
||||
/**************************************************************************/
|
||||
/* video_stream.cpp */
|
||||
/**************************************************************************/
|
||||
/* 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. */
|
||||
/**************************************************************************/
|
||||
|
||||
#include "video_stream.h"
|
||||
|
||||
#include "core/config/project_settings.h"
|
||||
#include "servers/audio_server.h"
|
||||
|
||||
// VideoStreamPlayback starts here.
|
||||
|
||||
void VideoStreamPlayback::_bind_methods() {
|
||||
ClassDB::bind_method(D_METHOD("mix_audio", "num_frames", "buffer", "offset"), &VideoStreamPlayback::mix_audio, DEFVAL(PackedFloat32Array()), DEFVAL(0));
|
||||
GDVIRTUAL_BIND(_stop);
|
||||
GDVIRTUAL_BIND(_play);
|
||||
GDVIRTUAL_BIND(_is_playing);
|
||||
GDVIRTUAL_BIND(_set_paused, "paused");
|
||||
GDVIRTUAL_BIND(_is_paused);
|
||||
GDVIRTUAL_BIND(_get_length);
|
||||
GDVIRTUAL_BIND(_get_playback_position);
|
||||
GDVIRTUAL_BIND(_seek, "time");
|
||||
GDVIRTUAL_BIND(_set_audio_track, "idx");
|
||||
GDVIRTUAL_BIND(_get_texture);
|
||||
GDVIRTUAL_BIND(_update, "delta");
|
||||
GDVIRTUAL_BIND(_get_channels);
|
||||
GDVIRTUAL_BIND(_get_mix_rate);
|
||||
}
|
||||
|
||||
VideoStreamPlayback::VideoStreamPlayback() {
|
||||
}
|
||||
|
||||
VideoStreamPlayback::~VideoStreamPlayback() {
|
||||
}
|
||||
|
||||
void VideoStreamPlayback::stop() {
|
||||
GDVIRTUAL_CALL(_stop);
|
||||
}
|
||||
|
||||
void VideoStreamPlayback::play() {
|
||||
GDVIRTUAL_CALL(_play);
|
||||
}
|
||||
|
||||
bool VideoStreamPlayback::is_playing() const {
|
||||
bool ret;
|
||||
if (GDVIRTUAL_CALL(_is_playing, ret)) {
|
||||
return ret;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
void VideoStreamPlayback::set_paused(bool p_paused) {
|
||||
GDVIRTUAL_CALL(_is_playing, p_paused);
|
||||
}
|
||||
|
||||
bool VideoStreamPlayback::is_paused() const {
|
||||
bool ret;
|
||||
if (GDVIRTUAL_CALL(_is_paused, ret)) {
|
||||
return ret;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
double VideoStreamPlayback::get_length() const {
|
||||
double ret;
|
||||
if (GDVIRTUAL_CALL(_get_length, ret)) {
|
||||
return ret;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
double VideoStreamPlayback::get_playback_position() const {
|
||||
double ret;
|
||||
if (GDVIRTUAL_CALL(_get_playback_position, ret)) {
|
||||
return ret;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
void VideoStreamPlayback::seek(double p_time) {
|
||||
GDVIRTUAL_CALL(_seek, p_time);
|
||||
}
|
||||
|
||||
void VideoStreamPlayback::set_audio_track(int p_idx) {
|
||||
GDVIRTUAL_CALL(_set_audio_track, p_idx);
|
||||
}
|
||||
|
||||
Ref<Texture2D> VideoStreamPlayback::get_texture() const {
|
||||
Ref<Texture2D> ret;
|
||||
if (GDVIRTUAL_CALL(_get_texture, ret)) {
|
||||
return ret;
|
||||
}
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
void VideoStreamPlayback::update(double p_delta) {
|
||||
if (!GDVIRTUAL_CALL(_update, p_delta)) {
|
||||
ERR_FAIL_MSG("VideoStreamPlayback::update unimplemented");
|
||||
}
|
||||
}
|
||||
|
||||
void VideoStreamPlayback::set_mix_callback(AudioMixCallback p_callback, void *p_userdata) {
|
||||
mix_callback = p_callback;
|
||||
mix_udata = p_userdata;
|
||||
}
|
||||
|
||||
int VideoStreamPlayback::get_channels() const {
|
||||
int ret;
|
||||
if (GDVIRTUAL_CALL(_get_channels, ret)) {
|
||||
_channel_count = ret;
|
||||
return ret;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
int VideoStreamPlayback::get_mix_rate() const {
|
||||
int ret;
|
||||
if (GDVIRTUAL_CALL(_get_mix_rate, ret)) {
|
||||
return ret;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
int VideoStreamPlayback::mix_audio(int num_frames, PackedFloat32Array buffer, int offset) {
|
||||
if (num_frames <= 0) {
|
||||
return 0;
|
||||
}
|
||||
if (!mix_callback) {
|
||||
return -1;
|
||||
}
|
||||
ERR_FAIL_INDEX_V(offset, buffer.size(), -1);
|
||||
ERR_FAIL_INDEX_V((_channel_count < 1 ? 1 : _channel_count) * num_frames - 1, buffer.size() - offset, -1);
|
||||
return mix_callback(mix_udata, buffer.ptr() + offset, num_frames);
|
||||
}
|
||||
|
||||
/* --- NOTE VideoStream starts here. ----- */
|
||||
|
||||
Ref<VideoStreamPlayback> VideoStream::instantiate_playback() {
|
||||
Ref<VideoStreamPlayback> ret;
|
||||
if (GDVIRTUAL_CALL(_instantiate_playback, ret)) {
|
||||
ERR_FAIL_COND_V_MSG(ret.is_null(), nullptr, "Plugin returned null playback");
|
||||
ret->set_audio_track(audio_track);
|
||||
return ret;
|
||||
}
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
void VideoStream::set_file(const String &p_file) {
|
||||
file = p_file;
|
||||
}
|
||||
|
||||
String VideoStream::get_file() {
|
||||
return file;
|
||||
}
|
||||
|
||||
void VideoStream::_bind_methods() {
|
||||
ClassDB::bind_method(D_METHOD("set_file", "file"), &VideoStream::set_file);
|
||||
ClassDB::bind_method(D_METHOD("get_file"), &VideoStream::get_file);
|
||||
|
||||
ADD_PROPERTY(PropertyInfo(Variant::STRING, "file"), "set_file", "get_file");
|
||||
|
||||
GDVIRTUAL_BIND(_instantiate_playback);
|
||||
}
|
||||
|
||||
VideoStream::VideoStream() {
|
||||
}
|
||||
|
||||
VideoStream::~VideoStream() {
|
||||
}
|
||||
|
||||
void VideoStream::set_audio_track(int p_track) {
|
||||
audio_track = p_track;
|
||||
}
|
||||
Loading…
Reference in New Issue