openshot/libopenshot
0
0
Fork 0
mirror of https://github.com/OpenShot/libopenshot.git synced 2026-03-02 08:53:52 -08:00
Code Issues Packages Projects Releases Wiki Activity
Files
develop
libopenshot/bindings/ruby/openshot.i

226 lines
5.5 KiB
OpenEdge ABL
Raw Permalink Normal View History

Adopt license management via Reuse project/tool (#711) * reuse-managed license/copyright headers reuse is a tool for compliance with the REUSE recommendations. See <https://reuse.software/> for more information, and <https://reuse.readthedocs.io/> for the online documentation. * Set jsoncpp license * Add MIT license for Decklink sources * Explicitly license examples/ - Add headers to source files - Change blanket licensing in .reuse/dep5 to only cover binary media - Import CC-BY-3.0 license and assign to sintel_trailer
2021-10-16 01:26:26 -04:00
/**
* @file
* @brief SWIG configuration for libopenshot (to generate Python SWIG bindings)
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @section LICENSE
*/
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
Wrap vector<float> in Swig mappings, and enable thread-safe access to swig wrappers - so our long running waveformer does not block the Python GIL
2022-10-31 14:20:18 -05:00
%module("threads"=1) openshot
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
SWIG: Warnings cleanup * Remove a SWIG pragma from Frame.h (gcc warns on it) * Place the equivalent %warnfilter in the openshot.i files * Set openshot.i PROPERTY GENERATED_COMPILE_OPTIONS with flags to disable warning spew in generated SWIG code, if -Wall is used (Also, remove 'using namespace std' from Frame.h, and add std:: prefixes to necessary variables.)
2019-07-12 13:28:47 -04:00
/* Suppress warnings about ignored operator= */
%warnfilter(362);
SWIG: Use compactdefaultargs in bindings
2019-09-28 21:43:59 -04:00
/* Don't generate multiple wrappers for functions with default args */
%feature("compactdefaultargs", "1");
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
/* Enable inline documentation */
%feature("autodoc", "1");
/* Include various SWIG helpers */
%include "typemaps.i"
%include "std_string.i"
%include "std_list.i"
%include "std_vector.i"
Adding metadata from format, audio stream, and video streams to ReaderBase.info, which in some cases includes the 'rotate' metadata added by certain cameras, and audio metadata like title, album, artist, copyright, dates, etc... Auto-Rotates any Clip with Reader metadata 'rotate' attribute.
2018-02-03 01:57:18 -06:00
%include "std_map.i"
Fix Ruby example script bug Ruby: Relax SWIG version for compatibility check - Turns out the Ruby-2.7.0-compatibility commit made it into SWIG 4.0.2 Ruby bindings: Fix all kinds of brokenness - Turns out int64_t function args require stdint.i for auto-conversion. - The imported module name is (still) 'Openshot' — lowercase 's'. - #TIL that accidentally dropping the OUTPUT_NAME config leads to a non-loadable shared library, due to the filename being wrong.
2020-10-18 05:17:27 -04:00
%include <stdint.i>
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
/* Unhandled STL Exception Handling */
%include <std_except.i>
Bindings: Use SWIG shared_ptr for Ruby, also
2020-10-18 05:11:43 -04:00
/* Include shared pointer code */
%include <std_shared_ptr.i>
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
/* Mark these classes as shared_ptr classes */
Fixing SWIG bindings when ImageMagick is not found
2016-02-23 01:24:13 -06:00
#ifdef USE_IMAGEMAGICK
Bindings: Use SWIG shared_ptr for Ruby, also
2020-10-18 05:11:43 -04:00
%shared_ptr(Magick::Image)
Fixing SWIG bindings when ImageMagick is not found
2016-02-23 01:24:13 -06:00
#endif
Rename AudioSampleBuffer to AudioBuffer<float> For a long time now, juce::AudioSampleBuffer has been nothing but an alias for its true (templated) type, AudioBuffer<float>.
2021-08-24 04:21:55 -04:00
%shared_ptr(juce::AudioBuffer<float>)
Bindings: Use SWIG shared_ptr for Ruby, also
2020-10-18 05:11:43 -04:00
%shared_ptr(openshot::Frame)
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
Rename AudioSampleBuffer to AudioBuffer<float> For a long time now, juce::AudioSampleBuffer has been nothing but an alias for its true (templated) type, AudioBuffer<float>.
2021-08-24 04:21:55 -04:00
/* Instantiate the required template specializations */
Bindings: Add template specializations
2020-12-04 11:26:20 -05:00
%template() std::map<std::string, int>;
%template() std::pair<int, int>;
%template() std::vector<int>;
Wrap vector<float> in Swig mappings, and enable thread-safe access to swig wrappers - so our long running waveformer does not block the Python GIL
2022-10-31 14:20:18 -05:00
%template() std::vector<float>;
Bindings: Add template specializations
2020-12-04 11:26:20 -05:00
%template() std::pair<double, double>;
%template() std::pair<float, float>;
Rename AudioSampleBuffer to AudioBuffer<float> For a long time now, juce::AudioSampleBuffer has been nothing but an alias for its true (templated) type, AudioBuffer<float>.
2021-08-24 04:21:55 -04:00
%template() std::pair<std::string, std::string>;
%template() std::vector<std::pair<std::string, std::string>>;
Improvements to AudioWaveformer to use RMS (Root Mean Square), and return both average RMS and max RMS for graphing, including some new unit tests.
2022-11-01 15:17:03 -05:00
%template() std::vector<std::vector<float>>;
Bindings: Add template specializations
2020-12-04 11:26:20 -05:00
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
%{
Ruby: Rename RSHIFT to RB_RSHIFT, temporarily When Ruby attempts to load the FFmpeg header files, it'll complain that RSHIFT is redefined if the Ruby definition is still in place. So, we define RB_RSHIFT to contain the Ruby definition, undef RSHIFT, load the FFmpeg headers, move its RSHIFT into FF_RSHIFT if necessary, and then restore Ruby's RSHIFT from RB_RSHIFT.
2019-01-26 11:53:08 -05:00
/* Ruby and FFmpeg define competing RSHIFT macros,
* so we move Ruby's out of the way for now. We'll
* restore it after dealing with FFmpeg's
*/
#ifdef RSHIFT
#define RB_RSHIFT(a, b) RSHIFT(a, b)
#undef RSHIFT
#endif
Merging work from @ferdnyc, to move version info to CMake, and other misc Cmake improvements. This was the easiest way to resolve the merge conflict for me (to apply it locally and commit it).
2019-07-01 12:24:50 -05:00
#include "OpenShotVersion.h"
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
#include "ReaderBase.h"
#include "WriterBase.h"
Rename AudioSampleBuffer to AudioBuffer<float> For a long time now, juce::AudioSampleBuffer has been nothing but an alias for its true (templated) type, AudioBuffer<float>.
2021-08-24 04:21:55 -04:00
#include "AudioDevices.h"
Initial commit of AudioWaveformer class, which is designed to iterate any ReaderBase, and return a reduced "average" sample set - more useful for generating waveforms - for example, reduce a 44100 samples per second down to 20 samples per second.
2022-10-30 22:04:19 -05:00
#include "AudioWaveformer.h"
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
#include "CacheBase.h"
#include "CacheDisk.h"
#include "CacheMemory.h"
#include "ChannelLayouts.h"
#include "ChunkReader.h"
#include "ChunkWriter.h"
#include "ClipBase.h"
#include "Clip.h"
#include "Coordinate.h"
#include "Color.h"
#include "DummyReader.h"
#include "EffectBase.h"
#include "Effects.h"
#include "EffectInfo.h"
#include "Enums.h"
#include "Exceptions.h"
#include "FFmpegReader.h"
#include "FFmpegWriter.h"
#include "Fraction.h"
#include "Frame.h"
#include "FrameMapper.h"
#include "PlayerBase.h"
#include "Point.h"
#include "Profiles.h"
#include "QtHtmlReader.h"
#include "QtImageReader.h"
#include "QtPlayer.h"
#include "QtTextReader.h"
#include "KeyFrame.h"
#include "RendererBase.h"
#include "Settings.h"
Large refactor of Timeline, TimelineBase, ClipBase, and Clip, to allow a Clip access to the parent timeline instance (if available), and thus, certain properties (preview size, timeline FPS, etc...). This allows for a simpler rendering of Clip keyframes (during the Clip::GetFrame method), and a simpler Timeline class, that can change the preview window size dynamically and no longer requires a Singleton Settings class. - Also removed "crop" from Clip class, as it was never implmeneted correctly, and we have a fully functional "crop" effect when needed - Added caching to Clip class, to optimize previewing of cached frames (much faster than previous)
2020-10-04 16:59:21 -05:00
#include "TimelineBase.h"
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
#include "Timeline.h"
Exposing VideoCacheThread to SWIG bindings for Python, Ruby, and Java. This will be called from openshot-qt in Python, to speed up exports.
2025-06-06 15:33:43 -05:00
#include "Qt/VideoCacheThread.h"
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
#include "ZmqLogger.h"
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
Ruby: Rename RSHIFT to RB_RSHIFT, temporarily When Ruby attempts to load the FFmpeg header files, it'll complain that RSHIFT is redefined if the Ruby definition is still in place. So, we define RB_RSHIFT to contain the Ruby definition, undef RSHIFT, load the FFmpeg headers, move its RSHIFT into FF_RSHIFT if necessary, and then restore Ruby's RSHIFT from RB_RSHIFT.
2019-01-26 11:53:08 -05:00
/* Move FFmpeg's RSHIFT to FF_RSHIFT, if present */
#ifdef RSHIFT
#define FF_RSHIFT(a, b) RSHIFT(a, b)
#undef RSHIFT
#endif
/* And restore Ruby's RSHIFT, if we captured it */
#ifdef RB_RSHIFT
#define RSHIFT(a, b) RB_RSHIFT(a, b)
#endif
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
%}
Exposing VideoCacheThread to SWIG bindings for Python, Ruby, and Java. This will be called from openshot-qt in Python, to speed up exports.
2025-06-06 15:33:43 -05:00
// Prevent SWIG from ever generating a wrapper for juce::Thread’s constructor (or run())
%ignore juce::Thread::Thread;
Making ImageMagick completely optional. This will simplify packaging on Windows and Mac. Also, reprogrammed Display, DisplayWaveform, Save, and Thumbnail methods, which are much faster now (using Qt).
2016-02-23 00:27:03 -06:00
#ifdef USE_IMAGEMAGICK
%{
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
#include "ImageReader.h"
#include "ImageWriter.h"
#include "TextReader.h"
Making ImageMagick completely optional. This will simplify packaging on Windows and Mac. Also, reprogrammed Display, DisplayWaveform, Save, and Thumbnail methods, which are much faster now (using Qt).
2016-02-23 00:27:03 -06:00
%}
#endif
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
Rename AudioSampleBuffer to AudioBuffer<float> For a long time now, juce::AudioSampleBuffer has been nothing but an alias for its true (templated) type, AudioBuffer<float>.
2021-08-24 04:21:55 -04:00
/* Wrap std templates (list, vector, etc...) */
%template(ClipList) std::list<openshot::Clip *>;
%template(EffectBaseList) std::list<openshot::EffectBase *>;
%template(CoordinateVector) std::vector<openshot::Coordinate>;
%template(PointsVector) std::vector<openshot::Point>;
%template(FieldVector) std::vector<openshot::Field>;
%template(MappedFrameVector) std::vector<openshot::MappedFrame>;
%template(MetadataMap) std::map<std::string, std::string>;
/* Deprecated */
%template(AudioDeviceInfoVector) std::vector<openshot::AudioDeviceInfo>;
Merging work from @ferdnyc, to move version info to CMake, and other misc Cmake improvements. This was the easiest way to resolve the merge conflict for me (to apply it locally and commit it).
2019-07-01 12:24:50 -05:00
%include "OpenShotVersion.h"
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
%include "ReaderBase.h"
%include "WriterBase.h"
Rename AudioSampleBuffer to AudioBuffer<float> For a long time now, juce::AudioSampleBuffer has been nothing but an alias for its true (templated) type, AudioBuffer<float>.
2021-08-24 04:21:55 -04:00
%include "AudioDevices.h"
Initial commit of AudioWaveformer class, which is designed to iterate any ReaderBase, and return a reduced "average" sample set - more useful for generating waveforms - for example, reduce a 44100 samples per second down to 20 samples per second.
2022-10-30 22:04:19 -05:00
%include "AudioWaveformer.h"
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
%include "CacheBase.h"
%include "CacheDisk.h"
%include "CacheMemory.h"
%include "ChannelLayouts.h"
%include "ChunkReader.h"
%include "ChunkWriter.h"
%include "ClipBase.h"
%include "Clip.h"
%include "Coordinate.h"
%include "Color.h"
%include "DummyReader.h"
%include "EffectBase.h"
%include "Effects.h"
%include "EffectInfo.h"
%include "Enums.h"
%include "Exceptions.h"
Ruby: Rename RSHIFT to RB_RSHIFT, temporarily When Ruby attempts to load the FFmpeg header files, it'll complain that RSHIFT is redefined if the Ruby definition is still in place. So, we define RB_RSHIFT to contain the Ruby definition, undef RSHIFT, load the FFmpeg headers, move its RSHIFT into FF_RSHIFT if necessary, and then restore Ruby's RSHIFT from RB_RSHIFT.
2019-01-26 11:53:08 -05:00
/* Ruby and FFmpeg define competing RSHIFT macros,
* so we move Ruby's out of the way for now. We'll
* restore it after dealing with FFmpeg's
*/
#ifdef RSHIFT
#define RB_RSHIFT(a, b) RSHIFT(a, b)
#undef RSHIFT
#endif
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
%include "FFmpegReader.h"
%include "FFmpegWriter.h"
Ruby: Rename RSHIFT to RB_RSHIFT, temporarily When Ruby attempts to load the FFmpeg header files, it'll complain that RSHIFT is redefined if the Ruby definition is still in place. So, we define RB_RSHIFT to contain the Ruby definition, undef RSHIFT, load the FFmpeg headers, move its RSHIFT into FF_RSHIFT if necessary, and then restore Ruby's RSHIFT from RB_RSHIFT.
2019-01-26 11:53:08 -05:00
/* Move FFmpeg's RSHIFT to FF_RSHIFT, if present */
#ifdef RSHIFT
#define FF_RSHIFT(a, b) RSHIFT(a, b)
#undef RSHIFT
#endif
/* And restore Ruby's RSHIFT, if we captured it */
#ifdef RB_RSHIFT
#define RSHIFT(a, b) RB_RSHIFT(a, b)
#endif
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
%include "Fraction.h"
%include "Frame.h"
%include "FrameMapper.h"
%include "PlayerBase.h"
%include "Point.h"
%include "Profiles.h"
%include "QtHtmlReader.h"
%include "QtImageReader.h"
%include "QtPlayer.h"
%include "QtTextReader.h"
%include "KeyFrame.h"
%include "RendererBase.h"
%include "Settings.h"
Large refactor of Timeline, TimelineBase, ClipBase, and Clip, to allow a Clip access to the parent timeline instance (if available), and thus, certain properties (preview size, timeline FPS, etc...). This allows for a simpler rendering of Clip keyframes (during the Clip::GetFrame method), and a simpler Timeline class, that can change the preview window size dynamically and no longer requires a Singleton Settings class. - Also removed "crop" from Clip class, as it was never implmeneted correctly, and we have a fully functional "crop" effect when needed - Added caching to Clip class, to optimize previewing of cached frames (much faster than previous)
2020-10-04 16:59:21 -05:00
%include "TimelineBase.h"
Exposing VideoCacheThread to SWIG bindings for Python, Ruby, and Java. This will be called from openshot-qt in Python, to speed up exports.
2025-06-06 15:33:43 -05:00
%include "Qt/VideoCacheThread.h"
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
%include "Timeline.h"
%include "ZmqLogger.h"
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
Making ImageMagick completely optional. This will simplify packaging on Windows and Mac. Also, reprogrammed Display, DisplayWaveform, Save, and Thumbnail methods, which are much faster now (using Qt).
2016-02-23 00:27:03 -06:00
#ifdef USE_IMAGEMAGICK
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
%include "ImageReader.h"
%include "ImageWriter.h"
%include "TextReader.h"
Making ImageMagick completely optional. This will simplify packaging on Windows and Mac. Also, reprogrammed Display, DisplayWaveform, Save, and Thumbnail methods, which are much faster now (using Qt).
2016-02-23 00:27:03 -06:00
#endif
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
/* Effects */
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
%include "effects/Bars.h"
%include "effects/Blur.h"
%include "effects/Brightness.h"
Fixing an issue caused by timeline::GetClip returning a ClipBase instead of a Clip (broke waveform generation). Also adding a swig definition for the Caption effect.
2020-12-03 10:52:27 -06:00
%include "effects/Caption.h"
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
%include "effects/ChromaKey.h"
%include "effects/ColorShift.h"
%include "effects/Crop.h"
%include "effects/Deinterlace.h"
%include "effects/Hue.h"
Adding unit tests for Lens Flare effect, and adding effect to Python SWIG bindings
2025-05-28 17:40:47 -05:00
%include "effects/LensFlare.h"
bindings: Remove relative header paths (#469) * bindings: Remove relative header paths Use the include paths set on the command line the way they're supposed to be used. * Also remove some redundant include paths * Fix SWIG include dirs
2020-03-23 08:13:46 -04:00
%include "effects/Mask.h"
%include "effects/Negate.h"
%include "effects/Pixelate.h"
%include "effects/Saturation.h"
%include "effects/Shift.h"
%include "effects/Wave.h"
Refactored and fixed many include paths (not sure how they worked before). Also, refactored SWIG bindings into separate folders, and added Ruby as the 2nd officially supported language for libopenshot.
2014-04-10 22:38:01 -05:00
Reference in New Issue Copy Permalink