style: unify identifier naming per updated conventions
Automated with clang-tidy readability-identifier-naming (config added to .clang-tidy) plus scripted passes, per the updated rules now documented in CONTRIBUTING.md: - types (class/struct/enum/alias/template params): PascalCase - functions, variables, members: snake_case (incl. rational -> Rational) - private/protected members: trailing underscore; static member variables likewise (instance_, available_themes_) - constants and enum values: snake_case (kLinear -> k_linear, F32P -> f32p); ALL_CAPS reserved for macros - macros: OAK_ prefix (OLIVE_ADD_TEST/OLIVE_ASSERT/OLIVE_CONFIG -> OAK_ADD_TEST/OAK_ASSERT/OAK_CONFIG, GL_PREAMBLE -> OAK_GL_PREAMBLE, include guards -> OAK_*) - file names: all lowercase (Current/Plugin/OliveHost/OliveClip/ OlivePluginInstance -> current/plugin/olivehost/oliveclip/ oliveplugininstance) - getters share the member name sans underscore, setters set_foo() - Qt and third-party (OpenFX) virtual overrides and framework callbacks keep their original names (exempt in .clang-tidy) Manual follow-ups required where automation could not reach: - string-based QMetaObject/SIGNAL/SLOT references updated to renamed methods (AddTask, CreatedFile, DeleteSpecificFile, moveSelectionUp, ...) - macro bodies referencing renamed methods (OLIVE_CONFIG, NODE_DEFAULT_DESTRUCTOR, MANAGEDDISPLAYWIDGET_*) - self-shadowing locals renamed where signals/methods became same-named (size_changed, worker_count, selected_items, import param, filters) - third_party OFX member/namespace usages restored (OFX::Host::*, _created, _clipPrefsDirty, createInstance, clearPersistentMessage) - STL protocol aliases restored (const_iterator) with .clang-tidy ignore rules; qHash overloads restored Full build and test suite pass: ctest 4/4, ~1960 gtest cases green.
This commit is contained in:
@@ -0,0 +1,106 @@
|
||||
/*
|
||||
* Oak Video Editor - Non-Linear Video Editor
|
||||
* Copyright (C) 2025 Olive CE Team
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
//
|
||||
// Created by mikesolar on 25-10-1.
|
||||
//
|
||||
|
||||
#ifndef OAK_OLIVECLIP_H
|
||||
#define OAK_OLIVECLIP_H
|
||||
#include "image.h"
|
||||
#include "ofxCore.h"
|
||||
#include "ofxhClip.h"
|
||||
#include "render/texture.h"
|
||||
#include "render/videoparams.h"
|
||||
|
||||
#include <QMap>
|
||||
#include <memory>
|
||||
namespace olive
|
||||
{
|
||||
namespace plugin
|
||||
{
|
||||
class OliveClipInstance : public OFX::Host::ImageEffect::ClipInstance {
|
||||
public:
|
||||
OliveClipInstance(OFX::Host::ImageEffect::Instance *effect_instance,
|
||||
OFX::Host::ImageEffect::ClipDescriptor &desc,
|
||||
VideoParams ¶ms)
|
||||
: ClipInstance(effect_instance, desc)
|
||||
, params_(params)
|
||||
, defaultRegionOfDefinitions_{ 0, 0, 0, 0 }
|
||||
, name_(desc.getName())
|
||||
{
|
||||
}
|
||||
OFX::Host::ImageEffect::Image *getOutputImage(OfxTime time);
|
||||
|
||||
const std::string &getUnmappedBitDepth() const override;
|
||||
const std::string &getUnmappedComponents() const override;
|
||||
const std::string &getPremult() const override;
|
||||
double getAspectRatio() const override;
|
||||
double getFrameRate() const override;
|
||||
void getFrameRange(double &start_frame, double &end_frame) const override;
|
||||
const std::string &getFieldOrder() const override;
|
||||
bool getConnected() const override;
|
||||
double getUnmappedFrameRate() const override;
|
||||
void getUnmappedFrameRange(double &start_frame,
|
||||
double &end_frame) const override;
|
||||
bool getContinuousSamples() const override;
|
||||
OFX::Host::ImageEffect::Image *
|
||||
getImage(OfxTime time, const OfxRectD *optional_bounds) override;
|
||||
OfxRectD getRegionOfDefinition(OfxTime time) const override;
|
||||
|
||||
void setRegionOfDefinition(OfxRectD region_of_definition, OfxTime time);
|
||||
void setDefaultRegionOfDefinition(OfxRectD region_of_definition);
|
||||
void setParams(const VideoParams ¶ms);
|
||||
#ifdef OFX_SUPPORTS_OPENGLRENDER
|
||||
OFX::Host::ImageEffect::Texture *
|
||||
loadTexture(OfxTime time, const char *format,
|
||||
const OfxRectD *optional_bounds) override;
|
||||
#endif
|
||||
|
||||
void setInputTexture(TexturePtr texture, OfxTime time,
|
||||
bool readback_cpu = true);
|
||||
void setOutputTexture(TexturePtr texture, OfxTime time);
|
||||
|
||||
// Get the plugin-preferred VideoParams based on base class _pixelDepth/_components
|
||||
VideoParams getPluginPreferredParams() const;
|
||||
|
||||
// Prune old entries from the images_ cache to prevent unbounded growth.
|
||||
// Output clip images are not pruned (they are typically single-frame).
|
||||
void prune_images_cache();
|
||||
|
||||
static constexpr int k_max_input_image_cache = 8;
|
||||
|
||||
private:
|
||||
VideoParams params_;
|
||||
|
||||
QMap<OfxTime, OfxRectD> regionOfDefinitions_;
|
||||
|
||||
OfxRectD defaultRegionOfDefinitions_;
|
||||
|
||||
std::string name_;
|
||||
QMap<OfxTime, Image *> images_;
|
||||
#ifdef OFX_SUPPORTS_OPENGLRENDER
|
||||
QMap<OfxTime, TexturePtr> input_textures_;
|
||||
QMap<OfxTime, TexturePtr> output_textures_;
|
||||
#endif
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
#endif //OAK_OLIVECLIP_H
|
||||
Reference in New Issue
Block a user