summaryrefslogtreecommitdiff
path: root/indra/media_plugins/base/media_plugin_base.h
diff options
context:
space:
mode:
authorMaki <maki@hotmilk.space>2024-05-15 20:58:28 -0400
committerMaki <maki@hotmilk.space>2024-05-15 20:58:28 -0400
commitec23d45e2e9a87147641fed6f8c3ef6083c2f878 (patch)
tree169edbab006d8bbd86b2980ab98fb62e097067ff /indra/media_plugins/base/media_plugin_base.h
parent8d824e8923b26c7a1d858e6cb587be1cf7d4dfeb (diff)
parent2f25f87ee719a79efc8316079f3c881eddb4d266 (diff)
Merge branch 'release/maint-b' into pipewire-linux-volume-catcher
Diffstat (limited to 'indra/media_plugins/base/media_plugin_base.h')
-rw-r--r--indra/media_plugins/base/media_plugin_base.h118
1 files changed, 59 insertions, 59 deletions
diff --git a/indra/media_plugins/base/media_plugin_base.h b/indra/media_plugins/base/media_plugin_base.h
index c6407c4e3f..1f8fcf98ee 100644
--- a/indra/media_plugins/base/media_plugin_base.h
+++ b/indra/media_plugins/base/media_plugin_base.h
@@ -1,4 +1,4 @@
-/**
+/**
* @file media_plugin_base.h
* @brief Media plugin base class for LLMedia API plugin system
*
@@ -6,21 +6,21 @@
* $LicenseInfo:firstyear=2008&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2010, Linden Research, Inc.
- *
+ *
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License only.
- *
+ *
* This library 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
* Lesser General Public License for more details.
- *
+ *
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
- *
+ *
* Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
* $/LicenseInfo$
* @endcond
@@ -71,94 +71,94 @@ extern SymbolGrabber gSymbolGrabber;
class MediaPluginBase
{
public:
- MediaPluginBase(LLPluginInstance::sendMessageFunction host_send_func, void *host_user_data);
+ MediaPluginBase(LLPluginInstance::sendMessageFunction host_send_func, void *host_user_data);
/** Media plugin destructor. */
- virtual ~MediaPluginBase() {}
+ virtual ~MediaPluginBase() {}
/** Handle received message from plugin loader shell. */
- virtual void receiveMessage(const char *message_string) = 0;
-
- static void staticReceiveMessage(const char *message_string, void **user_data);
+ virtual void receiveMessage(const char *message_string) = 0;
+
+ static void staticReceiveMessage(const char *message_string, void **user_data);
protected:
/** Plugin status. */
- typedef enum
- {
- STATUS_NONE,
- STATUS_LOADING,
- STATUS_LOADED,
- STATUS_ERROR,
- STATUS_PLAYING,
- STATUS_PAUSED,
- STATUS_DONE
- } EStatus;
+ typedef enum
+ {
+ STATUS_NONE,
+ STATUS_LOADING,
+ STATUS_LOADED,
+ STATUS_ERROR,
+ STATUS_PLAYING,
+ STATUS_PAUSED,
+ STATUS_DONE
+ } EStatus;
/** Plugin shared memory. */
- class SharedSegmentInfo
- {
- public:
+ class SharedSegmentInfo
+ {
+ public:
/** Shared memory address. */
- void *mAddress;
+ void *mAddress;
/** Shared memory size. */
- size_t mSize;
- };
+ size_t mSize;
+ };
+
+ void sendMessage(const LLPluginMessage &message);
+ void sendStatus();
+ std::string statusString();
+ void setStatus(EStatus status);
- void sendMessage(const LLPluginMessage &message);
- void sendStatus();
- std::string statusString();
- void setStatus(EStatus status);
-
- /// Note: The quicktime plugin overrides this to add current time and duration to the message.
- virtual void setDirty(int left, int top, int right, int bottom);
+ /// Note: The quicktime plugin overrides this to add current time and duration to the message.
+ virtual void setDirty(int left, int top, int right, int bottom);
/** Map of shared memory names to shared memory. */
- typedef std::map<std::string, SharedSegmentInfo> SharedSegmentMap;
+ typedef std::map<std::string, SharedSegmentInfo> SharedSegmentMap;
+
-
/** Function to send message from plugin to plugin loader shell. */
- LLPluginInstance::sendMessageFunction mHostSendFunction;
+ LLPluginInstance::sendMessageFunction mHostSendFunction;
/** Message data being sent to plugin loader shell by mHostSendFunction. */
- void *mHostUserData;
+ void *mHostUserData;
/** Flag to delete plugin instance (self). */
- bool mDeleteMe;
+ bool mDeleteMe;
/** Pixel array to display. TODO:DOC are pixels always 24-bit RGB format, aligned on 32-bit boundary? Also: calling this a pixel array may be misleading since 1 pixel > 1 char. */
- unsigned char* mPixels;
+ unsigned char* mPixels;
/** TODO:DOC what's this for -- does a texture have its own piece of shared memory? updated on size_change_request, cleared on shm_remove */
- std::string mTextureSegmentName;
+ std::string mTextureSegmentName;
/** Width of plugin display in pixels. */
- int mWidth;
+ int mWidth;
/** Height of plugin display in pixels. */
- int mHeight;
+ int mHeight;
/** Width of plugin texture. */
- int mTextureWidth;
+ int mTextureWidth;
/** Height of plugin texture. */
- int mTextureHeight;
+ int mTextureHeight;
/** Pixel depth (pixel size in bytes). */
- int mDepth;
+ int mDepth;
/** Current status of plugin. */
- EStatus mStatus;
+ EStatus mStatus;
/** Map of shared memory segments. */
- SharedSegmentMap mSharedSegments;
+ SharedSegmentMap mSharedSegments;
};
/** The plugin <b>must</b> define this function to create its instance.
- * It should look something like this:
+ * It should look something like this:
* @code
- * {
- * MediaPluginFoo *self = new MediaPluginFoo(host_send_func, host_user_data);
- * *plugin_send_func = MediaPluginFoo::staticReceiveMessage;
- * *plugin_user_data = (void*)self;
- *
- * return 0;
- * }
+ * {
+ * MediaPluginFoo *self = new MediaPluginFoo(host_send_func, host_user_data);
+ * *plugin_send_func = MediaPluginFoo::staticReceiveMessage;
+ * *plugin_user_data = (void*)self;
+ *
+ * return 0;
+ * }
* @endcode
*/
int init_media_plugin(
- LLPluginInstance::sendMessageFunction host_send_func,
- void *host_user_data,
- LLPluginInstance::sendMessageFunction *plugin_send_func,
- void **plugin_user_data);
+ LLPluginInstance::sendMessageFunction host_send_func,
+ void *host_user_data,
+ LLPluginInstance::sendMessageFunction *plugin_send_func,
+ void **plugin_user_data);
#if LL_LINUX
pid_t getParentPid(pid_t aPid);