1/**************************************************************************/
2/* movie_writer.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef MOVIE_WRITER_H
32#define MOVIE_WRITER_H
33
34#include "core/templates/local_vector.h"
35#include "servers/audio/audio_driver_dummy.h"
36#include "servers/audio_server.h"
37
38class MovieWriter : public Object {
39 GDCLASS(MovieWriter, Object);
40
41 uint64_t fps = 0;
42 uint64_t mix_rate = 0;
43 uint32_t audio_channels = 0;
44
45 float cpu_time = 0.0f;
46 float gpu_time = 0.0f;
47
48 String project_name;
49
50 LocalVector<int32_t> audio_mix_buffer;
51
52 enum {
53 MAX_WRITERS = 8
54 };
55 static MovieWriter *writers[];
56 static uint32_t writer_count;
57
58protected:
59 virtual uint32_t get_audio_mix_rate() const;
60 virtual AudioServer::SpeakerMode get_audio_speaker_mode() const;
61
62 virtual Error write_begin(const Size2i &p_movie_size, uint32_t p_fps, const String &p_base_path);
63 virtual Error write_frame(const Ref<Image> &p_image, const int32_t *p_audio_data);
64 virtual void write_end();
65
66 GDVIRTUAL0RC(uint32_t, _get_audio_mix_rate)
67 GDVIRTUAL0RC(AudioServer::SpeakerMode, _get_audio_speaker_mode)
68
69 GDVIRTUAL1RC(bool, _handles_file, const String &)
70 GDVIRTUAL0RC(Vector<String>, _get_supported_extensions)
71
72 GDVIRTUAL3R(Error, _write_begin, const Size2i &, uint32_t, const String &)
73 GDVIRTUAL2R(Error, _write_frame, const Ref<Image> &, GDExtensionConstPtr<int32_t>)
74 GDVIRTUAL0(_write_end)
75
76 static void _bind_methods();
77
78public:
79 virtual bool handles_file(const String &p_path) const;
80 virtual void get_supported_extensions(List<String> *r_extensions) const;
81
82 static void add_writer(MovieWriter *p_writer);
83 static MovieWriter *find_writer_for_file(const String &p_file);
84
85 void begin(const Size2i &p_movie_size, uint32_t p_fps, const String &p_base_path);
86 void add_frame();
87
88 static void set_extensions_hint();
89
90 void end();
91};
92
93#endif // MOVIE_WRITER_H
94