Difference between revisions of "Linden Lab Official:Media Plugin System Messages"

From Second Life Wiki
Jump to navigation Jump to search
 
(73 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Media Plugin Nav}}
{| align="right"
|--
|
{{:API Portal/navigation|media}}
|--
| 
|--
|
{{Media Messages AlphaList}}
|}
 
 
__TOC__
__TOC__
{{Note|This document reflects ongoing internal work on the Media Plugin System.  The details may not match the current publicly-available code; however the overall approach and high-level features reflect the project direction.}}


== Overview ==
== Overview ==


This article specifies the messages used by the Second Life Viewer media plugin system.
This article specifies the messages used in the Second Life Viewer media rendering plugin system. These messages are used to communicate between each plugin loader shell (PLS) and its media rendering plugin, and between each PLS and the Viewer.


Arrows indicate which direction each message is sent: 
=== Message categories ===


'''Messages the plugin receives''':
Messages fall into these general categories:
> for messages the [[Media_Plugin_System#Plugin_Loader_Shell|plugin loader shell]] sends to the plugin process.
For internal messages, these are from Viewer to plugin loader shell.


'''Messages the plugin sends''':
* '''[[#Base_messages|Base messages]]''' for initialization, connection management, and shared memory setup.  All plugins must implement these basic messages.
< for messages the plugin sends to the plugin loader shell.  
* '''[[#Media messages|Media messages]]''' for negotiating the pixel buffer and handling updates of subsections of it, specifying a media source URL, and passing mouse and keyboard events.  All media rendering plugins must implement these messages.
For internal messages, these are from plugin loader shell to Viewer.
* '''[[#Media_browser_messages|Time-based media messages]]''' for functions such as play, pause, stop, seek, and so on.  All time-based media (video-like) rendering plugins must implement these messages.
* '''[[#Media_time_messages|Browser-like media messages]]''' for functions such as forward, back, reload, and so on.  All browser-like media rendering plugins must implement these messages.
* '''[[#Internal system messages|Internal system messages]]''' for communication between the viewer and the plugin loader shell. These messages are not delivered to a plugin.  Plugin developers need not be concerned with them; their documentation is provided for Viewer developers.


Keys for each command are set off as bullet items, like this:
== Base messages ==
* foo: a sample argument
All plugins need to handle these messages.


=== Buffer size negotiation ===
=== Messages from the PLS to the plugin ===


The size and format of the pixel buffer which media plugins draw into is negotiated between the plugin and the host via the texture_params, size_change_request, and size_change messages.
==== init ====


The pixel size and format used for the buffer are determined entirely by the plugin, according to what it sends in the texture_params message.  Indexed pixel modes and pixels which use less than 8 bits per channel are not currently supported.  Recommended modes are 24 bit RGB or 32 bit ARGB, or variants thereof (BGRA, etc).
Initialization message the PLS sends.  Plugin responds with [[#init_response|init_response]].


Size negotiation is a bit more complicated:
'''No parameters'''.


* the host initially sets up the dimensions of the pixel buffer
==== idle ====
** if the plugin doesn't have any special sizing requirements, it can just draw to the buffer and never send a size_change_request message
* if the plugin sends a size_change_request message, the host takes that as the "native size" of the media
** media is allowed to change sizes multiple times during playback, such as with streaming QuickTime movies
* If the media is playing as parcel media and the "auto scale" option is set, the draw dimensions may be increased to the next power-of-two
* if the plugin sets the allow_downsample field in the texture_params message and the media's priority has been lowered, the host may reduce the requested draw dimensions
** the plugin should only set allow_downsample if it can draw the media at different scales without changing the overall look of the media, such as scaling down a video stream
** media which looks different when drawn at different pixel scales (such as a web browser where font sizes depend on pixel scale) should NOT set allow_downsample
** if it's more expensive to draw media downsampled than at native resolution, the plugin should NOT set allow_downsample -- it's supposed to be a way to reduce load on the system, and if it doesn't accomplish that it shouldn't be used
* if the plugin sets the 'padding' field in the texture_params message, the buffer's byte width will be padded to the requested alignment
** note that it's possible to request pixel size/alignment combinations that don't come out even when using 3-byte RGB pixels.  If the host detects this, it will disable padding.
* the host sends the requested drawing dimenions, the actual size of the buffer, and the name of the shared memory segment to the plugin in a size_change_response message
** the plugin must draw within the specified dimensions, and should NOT send a size_change_request in response to the size_change_response


When changing buffer sizes, the new size may require a larger or smaller memory buffer than the old size.  In this case, the shared memory segment name received with the size_change_response may be different than the one the plugin was previously drawing to.  If the plugin receives a size_change_response with a shared memory segment name it hasn't seen yet, it MUST not draw to the old shared memory segment using the new parameters, or it may overrun the end of the buffer and crash.
Call-in for plugin to do processing.  No response required.


In this case, the plugin should expect to receive a shm_added message for the new shared memory segment either before or after the size_change_response, and must wait until it has received both before drawing to the new buffer.
'''Parameters'''


Likewise, when a plugin receives a shm_remove message and it's drawing to the shared memory buffer with that name, it needs to stop doing so, since the memory buffer will be deallocated once the message handler returns.
{| class="lltable" border="1"
|--
!Key
!Type
!Description
 
|--
| time
| Real
| Interval (in seconds) at which idle messages are sent.
|}


== Internal messages ==
==== cleanup ====


The Viewer and plugin loader shell exchange ''internal messages''.  Plugins do not need to handle these messages.
The plugin is about to be unloaded, and should perform any cleanup it needs to do beforehand.


=== Messages plugin loader shell sends ===
'''No parameters'''.


==== hello====
==== shm_added ====
Shared memory segment has been set up.
 
'''Parameters'''
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description
 
|--
| name
| String
| Supplied to the plugin by the Viewer.  Human-readable; plugin should not try to change.
 
|--
| size
| Integer
| Size of segment in bytes.
 
|--
| address
| String
| Since this is going from the PLS to the plugin (not crossing a process boundary),
the pointer will actually be valid.  LLSD doesn't have an encoding for a pointer (or even an unsigned 32 bit value),
so this will be the full pointer (either 32 or 64 bits, depending on the pointer size of the platform) as a hexadecimal string.
 
|}
 
==== shm_remove ====
 
PLS will remove the shared memory segment. The segment will be effectively removed when plugin responds with [[#shm_remove_response|shm_remove_response]].
 
'''Parameters'''
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description
 
|--
| name
| String
| Name of memory segment to remove.
|}


This is the first message the plugin loader shell sends to the Viewer when it initializes.
=== Messages from the plugin to the PLS ===


==== load_plugin_response====
==== init_response ====


This message indicates the plugin is loaded and initialized.
This message is the plugin's response to the [[#init|init]] message sent by the PLS.


'''Parameters'''  
'''Parameters'''  
Line 84: Line 138:
|}
|}


====heartbeat====
==== shm_remove_response ====
 
Plugin is done with the shared memory segment, safe to delete.  Plugin responds with this message when it receives a [[#shm_remove|shm_remove]] message.


Plugin loader shell sends these once per second to indicate that the plugin isn't locked up.
'''Parameters'''


==== shm_add_response ====
{| class="lltable" border="1"
This message indicates shared memory has been mapped into the child.
|--
!Key
!Type
!Description
 
|--
| name
| String
| Name of shared memory segment to delete.
|}
 
== Media messages ==
 
=== Messages from the PLS to the plugin ===
 
==== load_uri ====
 
Tells the plugin to load the specified URI.


'''Parameters'''  
'''Parameters'''  
Line 100: Line 173:


|--
|--
| name
| uri
| String
| String
| ?
| URI to load.
|}
|}


==== shm_remove_response====
==== key_event ====


Plugin is done with the shared memory segment, safe to delete.
Simulates the user pressing a key on the keyboard.


'''Parameters'''  
'''Parameters'''  
Line 118: Line 191:


|--
|--
| name
| event
| String
| One of:
* down
* repeat
* up
 
|--
| key
| String
| Platform-specific keycode
 
|--
| modifiers
| String
| String
| ?
| Contains zero or more of the following, concatenated together with <nowiki>'|'</nowiki> characters in between.  There may be a spurious trailing <nowiki>'|'</nowiki>.
* control
* alt -- the 'option' key on the mac
* shift
* meta -- the 'command' key on the mac
 
|}
|}


=== Messages plugin loader shell receives ===  
==== text_event ====
 
Text input event not associated with a single keystroke.
 
'''Parameters'''
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description
 
|--
|text
| String
| Encoded in utf8
 
|--
| modifiers
| String
| Contains zero or more of the following, concatenated together with <nowiki>'|'</nowiki> characters in between.  There may be a spurious trailing <nowiki>'|'</nowiki>.
* control
* alt -- the 'option' key on the mac
* shift
* meta -- the 'command' key on the mac
 
|}


==== load_plugin====
==== mouse_event ====
Tells the loader to load a plugin and send the base init message.


'''Parameters'''  
'''Parameters'''  
Line 137: Line 253:


|--
|--
| file
| event
| String
| String
| Full path to the plugin DLL/dylib/so file.
| One of:
* down
* move
* up
* double_click
 
|--
|x
|Integer
| x-coordinate in texture space
 
|--
| y
| Integer
| Y-coordinate in texture space (taking into account whether vertical flip was requested or not).
 
|--
| button
| Integer
| Mouse button number associated with this event.  If this parameter is not present, assume the left button.
* 0 -- left button
* 1 -- right button
* 2 -- middle button
* higher numbers are not specifically assigned
 
|--
| modifiers
| String
| Contains zero or more of the following, concatenated together with <nowiki>'|'</nowiki> characters in between.  There may be a spurious trailing <nowiki>'|'</nowiki>.
* control
* alt -- the 'option' key on the mac
* shift
* meta -- the 'command' key on the mac
 
|}
|}


==== shm_add ====
==== scroll_event ====
shared memory segment has been set up in the parent


'''Parameters'''  
'''Parameters'''  
Line 154: Line 302:


|--
|--
| name
|x
| string
|Integer
|?
| x-horizontal scroll steps
 
|--
| y
| Integer
| Y-vertical scroll steps


|--
|--
| size
| modifiers
| S32
| String
| ?
| Contains zero or more of the following, concatenated together with <nowiki>'|'</nowiki> characters in between.  There may be a spurious trailing <nowiki>'|'</nowiki>.
* control
* alt -- the 'option' key on the mac
* shift
* meta -- the 'command' key on the mac
 
|}
|}


==== shm_remove====
==== size_change ====
Shared memory segment will be removed once you respond
Either host-initiated or after a request from the plugin.


'''Parameters'''  
'''Parameters'''  
Line 176: Line 334:


|--
|--
| name  
| width
| Integer
| Width in pixels; size at which the plugin is expected to render
 
|--
| height
| Integer
| Height in pixels
 
|--
| texture_width
| Integer
| Width of texture in pixels; Number of pixesl in the buffer its being asked to draw into.  May be larger than width parameter value.
 
|--
| texture_height
| Integer
| Height of texture in pixels; Number of pixesl in the buffer its being asked to draw into.  May be larger than height parameter value.
 
|--
| name
| String
| String
| Name of shared memory segment to remove.
| Name of the shared memory segment the texture will draw into. Matches with the name in an shm_added.
 
|}
|}


==== sleep_time====
==== set_priority ====
Set the interval between idle messages to the plugin.
 
Tells the plugin its relative priority.


'''Parameters'''  
'''Parameters'''  
Line 193: Line 373:


|--
|--
| time
| priority
| Float
| String
| Time in seconds (default is 1/100)
| One of:
* stopped: media is not playing, shouldn't need to update at all
* hidden: media is not being displayed or is out of view, don't need to do graphic updates, but may still update audio, playhead, etc.
* slideshow: media is being displayed, but is being severely throttled to reduce resource usage
* low: media is in the far distance, may be rendered at reduced size
* normal: default priority
* high: media has user focus and/or is taking up most of the screen
 
|}
|}


==== edit_cut ====
Perform an edit-menu "cut" operation to the system clipboard.
'''No parameters'''
==== edit_copy ====
Perform an edit-menu "copy" operation to the system clipboard.
'''No parameters'''
==== edit_paste ====
Perform an edit-menu "paste" operation from the system clipboard.
'''No parameters'''
=== Messages from the plugin to the PLS ===
==== texture_params ====
'''Parameters'''
{| class="lltable" border="1"
|--
!Key
!Type
!Description
|--
| default_width
| Integer
| Optional. Default width for the texture.
|--
| default_height
| Integer
| Optional. Default height for the texture.
|--
| depth
| Integer
| Pixel size in bytes.  Although the the format and type parameters completely determine the pixel size, deriving it is complex.  Thus, the plugin must provide the value to the host.
|--
| internalformat
| String
| Texture internal format for glTexImage2D.  The value is a string containing hexadecimal digits, (for example, "0xDEADBEEF") representing a GLint.  See [[#GL_params|Note on OpenGL parameters]].
|--
| format
| String
| Texture format for glTexImage2D. The value is a string containing hexadecimal digits, (for example, "0xDEADBEEF") representing a GLenum.  See [[#GL_params|Note on OpenGL parameters]].
|--
| type
| String
| Texture type for glTexImage2D. The value is a string containing hexadecimal digits, (for example, "0xDEADBEEF") representing a GLenum.  See [[#GL_params|Note on OpenGL parameters]].
|--
| swap_bytes
| Boolean
| Optional.  True if the host should use <code>glPixelStorei(GL_UNPACK_SWAP_BYTES, 1)</code> when loading the data.  If not specified, defaults to false.


|--
| coords_opengl
| Boolean
| True if the plugin wants to work in OpenGL coordinates (where (0,0) is the lower left corner of the texture); false to work in a coordinate system where (0,0) is the upper left.


== Base messages ==
|--
All plugins need to handle these messages.
| allow_downsample
| Boolean
| Optional.  If true, the host may negotiate a smaller texture when the plugin's priority is reduced. The plugin should not set this if downscaling the media is more expensive than drawing it at native size.
If the plugin sets the allow_downsample field in the [[#texture_params|texture_params]] message and the media's priority has been lowered, the host may reduce the requested draw dimensions.
* The plugin should only set allow_downsample if it can draw the media at different scales without changing the overall look of the media, such as scaling down a video stream
* Media that looks different when drawn at different pixel scales (such as a web browser where font sizes depend on pixel scale) should NOT set allow_downsample
* If it's more expensive to draw media downsampled than at native resolution, the plugin should NOT set allow_downsample: it's supposed to be a way to reduce load on the system, and if it doesn't accomplish that it shouldn't be used.


=== Messages the plugin receives ===
|--
| padding
| Integer
| Optional.  Specifies how the rows of the texture should be padded. Useful values:
* 0 (the default) -- no padding is added
* -1 -- pad width to the next power of two
* 16 -- start each row on a 16 byte boundary -- NOTE: may not work correctly with odd-sized pixels like GL_RGB
* 32 -- start each row on a 32 byte boundary -- NOTE: may not work correctly with odd-sized pixels like GL_RGB
'''NOTE:''' It is possible to request pixel size/alignment combinations that don't come out even when using 3-byte RGB pixels.  If the host detects this, it will disable padding.


==== init ====
|}


Initialization message.
<span id="GL_params"></span>'''Note on OpenGL parameters''': The hexadecimal GLint and GLenum values used for internalformat, format and type are set by the OpenGL, so passing them across process boundaries is generally safe.


==== idle ====
==== updated====


Call-in for plugin to do processing, no response.
Specifies the update rectangle; the coordinates are specified within the buffer in which the media is being drawn.  The coords_opengl flag in [[#texture_params|texture_params]] message specifies how coordinatess are interpreted.


'''Parameters'''  
'''Parameters'''  
Line 222: Line 490:


|--
|--
| time
| left
| float
| Integer
| interval (in seconds) at which idle messages are being sent.
| Left x-coordinate of the update rectangle.
|--
| top
| Integer
| Top y-coordinate of the update rectangle.
|--
| right
| Integer
| Right x-coordinate of the update rectangle.
|--
| bottom
| Integer
| Bottom y-coordinate of the update rectangle.
|--
| current_time
| Real
| Optional.  Current playhead time in seconds.
 
|--
| duration
| Real
| Optional.  Total duration of the media in seconds
 
|--
| current_rate
| Real
| Optional.  Rate at which the media is currently playing.
 
|--
| loaded_duration
| Real
| Optional.  For media that is partially loaded, the duration through which the media could currently play or seek.  For media which can't be loaded incrementally, either omit this parameter or set it to the same value as 'duration'.
|}
|}


==== cleanup ====
==== media_status====
 
Plugin describing the state to the PLS.
 
'''Parameters'''
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description
 
|--
| status
| String
| One of:
* <empty string> -- not initialized or no media loaded
* loading -- loading or navigating
* loaded -- preroll/navigation complete
* error -- navigation/preroll failed
* playing -- playing (only for time-based media)
* paused -- paused (only for time-based media)
 
|}


the plugin is about to be unloaded, and should perform any cleanup it needs to do beforehand
==== name_text====


==== shm_added ====
Specifies a name for the media being displayed.
Shared memory segment has been set up.


'''Parameters'''  
'''Parameters'''  
Line 244: Line 565:
|--
|--
| name  
| name  
| string
| String
|
| The name of the media. Typically the <code><title></code> tag in a Web page or the name in time based media.
 
|}
 
==== size_change_request ====
 
Indicates the stream wants to change its native size.
 
'''Parameters'''
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description
 
|--
| width
| Integer
| Desired width in pixels.
 
|--
| height
| Integer
| Desired height in pixels.
 
|--
| name
| String
| Name of the shared memory segment the texture will draw into.  This may induce the host to send a [[#size_change|size_change]] message.  The plugin may stop drawing to the texture until an appropriate size_change message has been received.
|}
 
==== size_change_response ====
 
Sent by the plugin in response to [[#size_change|size_change]] when the size change is complete.
 
See [[Media_Rendering_Plugin_Operation_and_Data_Flow#Shared_memory_size_negotiation|Shared memory size negotiation]].
 
'''Parameters'''
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description
 
|--
| width
| Integer
| Width in pixels.
 
|--
| height
| Integer
| Height in pixels.
 
|--
| texture_width
| Integer
| Width of texture in pixels; Number of pixels in the buffer its being asked to draw into. May be larger than width parameter value.


|--
|--
| size
| texture_height
| S32
| Integer
| ?
| Height of texture in pixels; Number of pixels in the buffer its being asked to draw into. May be larger than height parameter value.


|--
|--
| address
| name
| string
| String
| Since this is going from the loader shell to the plugin (i.e. not crossing a process boundary),
| Name of the shared memory segment the texture will draw into
the pointer will actually be valid.  LLSD doesn't have an encoding for a pointer (or even an unsigned 32 bit value),
so this will be the pointer's value as a hexadecimal string.
|}
|}


==== shm_remove ====
==== cursor_changed ====
Shared memory segment will be removed once you respond.


'''Parameters'''  
'''Parameters'''  
Line 274: Line 651:
| name
| name
| String
| String
| Name of memory segment to remove.
| One of:
* <empty string>
*  arrow
*  ibeam
*  splith
*  splitv
*  hand
|}
 
==== edit_state ====
 
Update the state of the edit menu items in the host. Note:
*  Items that are not present in the update message should have their state unchanged. 
*  All states start out false in the host. 
*  False means the operation is not possible and the menu should be disabled.
 
 
'''Parameters'''
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description
 
|--
| cut
| Boolean
| Optional.
 
|--
| copy
| Boolean
| Optional.
 
|--
| paste
| Boolean
| Optional.
|}
 
== Media_browser messages ==
 
=== Messages from the PLS to the plugin ===
 
==== focus ====
 
Give the plugin focus.
 
'''Parameters'''
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description
 
|---
| focused
| Boolean
| True to give the plugin instance focus.
|}
|}


=== Messages the plugin sends ===
==== clear_cache ====
 
Clear any cache that the plugin maintains.
 
'''No Parameters'''.
 
==== clear_cookies ====
 
Clear any cookies that the plugin maintains.
 
'''No Parameters'''.
 
==== enable_cookies ====


==== init_response ====
Enable or disable use of cookies.


'''Parameters'''  
'''Parameters'''  
Line 290: Line 739:


|--
|--
| versions
|enable
| Map
|Boolean
| Lists version corresponding to each plugin class.
|Whether to enable cookies.
* Key: message class name
|}
* Value: version string.  All versions start at "1.0".
 
==== proxy_setup ====
 
Use a proxy and specify proxy settings.
 
'''Parameters'''


{| class="lltable" border="1"
|--
|--
| plugin_version
!Key
!Type
!Description
 
|---
| enable
|Boolean
| Set to tru to enable using the spedcified proxy server.
 
|---
| host
| String
| String
| Free-form version string for the plugin. This is expected to contain the versions of libraries the plugin uses (for example, quicktime, webkit, and so on) and may end up in the Viewer's about box.
| Hostname of the proxy.
 
|---
| port
| Integer
| TCP port to use.
|}
 
==== browse_stop ====
 
'''No Parameters'''.
 
==== browse_reload ====
 
Reload the media stream.
 
'''Parameters'''  
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description


|---
| ignore_cache
| Boolean
| If true, bypass cache for this reload.
|}
|}


==== shm_remove_response ====
==== browse_forward ====
 
'''No Parameters'''.
 
==== browse_back ====
 
'''No Parameters'''.
 
==== set_status_redirect  ====
 
'''Parameters'''
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description


Pugin is done with the shared memory segment, safe to delete.
|---
| code
| Integer
| The HTTP status code on which to redirect (currently, only 404).


|---
| url
| String
| URL to which to redirect.
|}
==== init_history ====
'''Parameters'''  
'''Parameters'''  


Line 315: Line 832:
!Description
!Description


|---
| history
| Array of strings
| Array of string URIs to add to the browser history.
|}
=== Messages from the plugin to the PLS ===
==== navigate_begin ====
'''Parameters'''
{| class="lltable" border="1"
|--
|--
| name
!Key
!Type
!Description
 
|---
| uri
| String
| String
| Name of shared memory segment to delete.
| URI to which the browser is navigating.
 
|}
|}


== Media messages ==
==== navigate_complete ====


=== Messages the plugin receives ===
'''Parameters'''


==== load_uri ====
{| class="lltable" border="1"
* uri (string)
|--
!Key
!Type
!Description
|---
| uri  
| String
| URI to which the browser was navigating.
 
|---
| result_code
| Integer
| For example, 200, 404.


==== key_event ====
|---
* event (string) one of:
| result_string
** down
| String
** repeat
| "OK", "Not Found", etc.
** up
* key(S32) -- platform-specific keycode
* modifiers -- string containing zero or more of the following, concatenated together with '|' characters in between.  There may be a spurious trailing '|'.
** control
** alt -- means the 'option' key on the mac
** shift
** meta -- means the 'command' key on the mac


==== text_event ====
|---
| history_back_available
| Boolean
| True if the "back" button should be enabled


Text input event not associated with a single keystroke
|---
* text(string) -- encoded in utf8
| history_forward_available
| Boolean
| True if the "forward" button should be enabled


==== mouse_event ====
|}
* event (string) : one of:
** down
** move
** up
** double_click
* x -- x coordinate in texture space
* y -- y coordinate in texture space (taking into account whether vertical flip was requested or not)
* modifiers -- string containing zero or more of the following, concatenated together with '|' characters in between.  There may be a spurious trailing '|'.
** control
** alt -- means the 'option' key on the mac
** shift
** meta -- means the 'command' key on the mac


==== scroll_event ====
==== progress ====
'''Parameters'''


Scrollwheel
{| class="lltable" border="1"
* x (integer) : horizontal scroll amount (positive or negative)
|--
* y (integer) : vertical scroll amount (positive or negative)
!Key
* modifiers -- string containing zero or more of the following, concatenated together with '|' characters in between.  There may be a spurious trailing '|'.
!Type
** control
!Description
** alt -- means the 'option' key on the mac
|---
** shift
| percent
** meta -- means the 'command' key on the mac
| Integer
| Percent of page load that has completed; between zero (0) and 100, inclusive.


==== size_change ====
|}
Either host-initiated or after a request from the plugin
* width(S32)
* height(S32)
* texture_width(S32)
* texture_height(S32)
* name(string) -- the name of the shared memory segment the texture will draw into


==== set_priority ====
==== status_text ====


Tells the plugin its relative priority
'''Parameters'''
* priority(string): one of:
** stopped: media is not playing, shouldn't need to update at all
** hidden: media is not being displayed or is out of view, don't need to do graphic updates, but may still update audio, playhead, etc.
** low: media is in the far distance, may be rendered at reduced size
** normal: default priority
** high: media has user focus and/or is taking up most of the screen


==== edit_cut ====
{| class="lltable" border="1"
|--
!Key
!Type
!Description
|---
| status
| String
| New browser status string.


Do an edit-menu "cut" operation to the system clipboard
|}


==== edit_copy ====
==== location_changed ====


Do an edit-menu "copy" operation to the system clipboard
'''Parameters'''


==== edit_paste ====
{| class="lltable" border="1"
Do an edit-menu "paste" operation from the system clipboard
|--
!Key
!Type
!Description


=== Messages the plugin sends ===
|---
| uri
| String
| New browser URI for the navigation bar.


==== texture_params ====
|}
* default_width (S32) OPTIONAL -- default width for the texture
* default_height (S32) OPTIONAL -- default height for the texture
* depth (S32) -- pixel size in bytes
* internalformat (U32) -- texture internalformat for glTexImage2D
* format (U32) -- texture format for glTexImage2D
* type (U32) -- texture type for glTexImage2D
* swap_bytes(bool) OPTIONAL -- true if the host should use glPixelStorei(GL_UNPACK_SWAP_BYTES, 1) when loading the data
** if not specified, defaults to false.
* coords_opengl(bool) -- true if the plugin wants to work in OpenGL coordinates (where (0,0) is the lower left corner of the texture), false to work in a coordinate system where (0,0) is the upper left
** Note that the hexadecimal GLenum values for these are fixed by the OpenGL ARB, so passing them across process boundaries should be safe
** Although the pixel size in bytes is completely determined by the format and type, deriving it from only those values is complex.  To simplify things, the plugin must provide the pixel size to the host.
* allow_downsample(bool) OPTIONAL -- If true, the host may negotiate a smaller texture when the plugin's priority is reduced.
** The plugin should not set this if downscaling the media is more expensive than drawing it at native size
* padding(S32) OPTIONAL -- Specifies how the rows of the texture should be padded. Useful values:
** 0 (the default) -- no padding is added
** -1 -- pad width to the next power of two
** 16 -- start each row on a 16 byte boundary -- NOTE: may not work correctly with odd-sized pixels like GL_RGB
** 32 -- start each row on a 32 byte boundary -- NOTE: may not work correctly with odd-sized pixels like GL_RGB


==== updated====
==== click_href ====
* left(S32)
* top(S32)
* right(S32)
* bottom(S32)
* current_time(float) OPTIONAL -- the current playhead time in seconds
* duration(float) OPTIONAL -- the total duration of the media in seconds
* current_rate(float) OPTIONAL -- the rate at which the media is currently playing


==== media_status====
Occurs when the user clicks on a link. 
* status (string), one of:
**<empty string> -- not initialized or no media loaded
**loading -- loading or navigating
**loaded -- preroll/navigation complete
**error -- navigation/preroll failed
**playing -- playing (only for time-based media)
**paused -- paused (only for time-based media)


==== size_change_request ====
'''Parameters'''


When the stream wants to change its native size
{| class="lltable" border="1"
* width(S32)
|--
* height(S32)
!Key
* name(string) -- the name of the shared memory segment the texture will draw into
!Type
** this may or may not induce the host to send a size_change message.  The plugin may stop drawing to the texture until an appropriate size_change message has been received.
!Description
|---
| uri
| String
| URI of the link.


==== size_change_response ====
|---
| target
| String
| Target property of the link.


Sent by the plugin when the size change is complete
|}
* width(S32)
* height(S32)
* texture_width(S32)
* texture_height(S32)
* name(string) -- the name of the shared memory segment the texture will draw into


==== cursor_changed ====
==== click_nofollow ====


* name (string), one of:
'''Parameters'''
**<empty string>
** arrow
** ibeam
** splith
** splitv
** hand


==== edit_state ====
{| class="lltable" border="1"
|--
!Key
!Type
!Description


Update the state of the edit menu items in the host
|---
* cut(bool) OPTIONAL
| uri
* copy(bool) OPTIONAL
| String
* paste(bool) OPTIONAL
| URI of the link.
** items that are not present in the update message should have their state unchanged. 
** All states start out false in the host. 
** False means the operation is not possible and the menu should be disabled.


== Media_browser messages ==
|}
; > focus
* focused (bool): true if the browser instance has focus
; > clear_cache
; > clear_cookies
; > enable_cookies
* enable (bool)
; > proxy_setup
* enable (bool)
* host (string)
* port (S32)
; > browse_stop
; > browse_reload
* ignore_cache(bool): if true, bypass cache for this reload
; > browse_forward
; > browse_back
; > set_status_redirect (we use a 404 redirect in Web based search)
* code(S32): the code to redirect on (should only be 404 for now)
* url(string): the URL to redirect to
; < navigate_begin
* uri (string): uri the browser is navigating to
; < navigate_complete
* uri (string): uri the browser was navigating to
* result_code (S32): 200, 404, etc.
* result_string (string): "OK", "Not Found", etc.
* history_back_available (bool): true if the "back" button should be enabled
* history_forward_available (bool): true if the "forward" button should be enabled
; < progress
* percent (S32): percent of page load that has completed
; < status_text
* status (string): new browser status string
; < location_changed
* uri (string): new browser uri for the navigation bar
; < click_href
* uri (string): uri of the link
* target (string): target property of the link
; < click_nofollow
* uri (string): uri of the link
; > init_history
* history (LLSD, array of strings): array of string URIs to add to the browser history


== Media_time messages ==
== Media_time messages ==
; > stop
 
; > start
=== Messages from the PLS to the plugin ===
* rate (float) OPTIONAL: rate to play at -- 0.0 is the movie's default rate, 1.0 is normal forward (on most movies), -1.0 is reverse, greater than 1.0 is fast foward, etc.
 
; > pause
==== stop ====
; > seek
 
* time (float)
'''No parameters'''.
; > set_loop
 
* loop (boolean): true to make the media loop, false to make it play once
==== start ====
; > set_volume
 
* volume (float)
{| class="lltable" border="1"
|--
!Key
!Type
!Description
|---
| rate
| Real
| Optional. Rate to play at:
* 0.0 is the movie's default rate.
* 1.0 is normal forward (on most movies).
* -1.0 is reverse.
* Greater than 1.0 is fast foward.  
* Less than 1.0 is slow motion.
 
|}
 
==== pause ====
 
'''No parameters'''.
 
==== seek ====
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description
 
|---
| time  
| Real
| The point in the stream to Time in seconds.  Host will know the duration of the media from the [#updated|updated] message.
 
|}
 
==== set_loop ====
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description
|---
| loop  
| Boolean
| True to make the media loop, false to make it play once.
 
|}
 
==== set_volume ====
 
{| class="lltable" border="1"
|--
!Key
!Type
!Description
 
|---
| volume  
| Real
| Muted is zero (0) and full volume is 1.0.
 
|}

Latest revision as of 14:34, 4 May 2011

 


Overview

This article specifies the messages used in the Second Life Viewer media rendering plugin system. These messages are used to communicate between each plugin loader shell (PLS) and its media rendering plugin, and between each PLS and the Viewer.

Message categories

Messages fall into these general categories:

  • Base messages for initialization, connection management, and shared memory setup. All plugins must implement these basic messages.
  • Media messages for negotiating the pixel buffer and handling updates of subsections of it, specifying a media source URL, and passing mouse and keyboard events. All media rendering plugins must implement these messages.
  • Time-based media messages for functions such as play, pause, stop, seek, and so on. All time-based media (video-like) rendering plugins must implement these messages.
  • Browser-like media messages for functions such as forward, back, reload, and so on. All browser-like media rendering plugins must implement these messages.
  • Internal system messages for communication between the viewer and the plugin loader shell. These messages are not delivered to a plugin. Plugin developers need not be concerned with them; their documentation is provided for Viewer developers.

Base messages

All plugins need to handle these messages.

Messages from the PLS to the plugin

init

Initialization message the PLS sends. Plugin responds with init_response.

No parameters.

idle

Call-in for plugin to do processing. No response required.

Parameters

Key Type Description
time Real Interval (in seconds) at which idle messages are sent.

cleanup

The plugin is about to be unloaded, and should perform any cleanup it needs to do beforehand.

No parameters.

shm_added

Shared memory segment has been set up.

Parameters

Key Type Description
name String Supplied to the plugin by the Viewer. Human-readable; plugin should not try to change.
size Integer Size of segment in bytes.
address String Since this is going from the PLS to the plugin (not crossing a process boundary),

the pointer will actually be valid. LLSD doesn't have an encoding for a pointer (or even an unsigned 32 bit value), so this will be the full pointer (either 32 or 64 bits, depending on the pointer size of the platform) as a hexadecimal string.

shm_remove

PLS will remove the shared memory segment. The segment will be effectively removed when plugin responds with shm_remove_response.

Parameters

Key Type Description
name String Name of memory segment to remove.

Messages from the plugin to the PLS

init_response

This message is the plugin's response to the init message sent by the PLS.

Parameters

Key Type Description
versions Map Lists version corresponding to each plugin class.
  • Key: message class name
  • Value: version string. All versions start at "1.0".
plugin_version String Free-form version string for the plugin. This is expected to contain the versions of libraries the plugin uses (for example, quicktime, webkit, and so on) and may end up in the Viewer's about box.

shm_remove_response

Plugin is done with the shared memory segment, safe to delete. Plugin responds with this message when it receives a shm_remove message.

Parameters

Key Type Description
name String Name of shared memory segment to delete.

Media messages

Messages from the PLS to the plugin

load_uri

Tells the plugin to load the specified URI.

Parameters

Key Type Description
uri String URI to load.

key_event

Simulates the user pressing a key on the keyboard.

Parameters

Key Type Description
event String One of:
  • down
  • repeat
  • up
key String Platform-specific keycode
modifiers String Contains zero or more of the following, concatenated together with '|' characters in between. There may be a spurious trailing '|'.
  • control
  • alt -- the 'option' key on the mac
  • shift
  • meta -- the 'command' key on the mac

text_event

Text input event not associated with a single keystroke.

Parameters

Key Type Description
text String Encoded in utf8
modifiers String Contains zero or more of the following, concatenated together with '|' characters in between. There may be a spurious trailing '|'.
  • control
  • alt -- the 'option' key on the mac
  • shift
  • meta -- the 'command' key on the mac

mouse_event

Parameters

Key Type Description
event String One of:
  • down
  • move
  • up
  • double_click
x Integer x-coordinate in texture space
y Integer Y-coordinate in texture space (taking into account whether vertical flip was requested or not).
button Integer Mouse button number associated with this event. If this parameter is not present, assume the left button.
  • 0 -- left button
  • 1 -- right button
  • 2 -- middle button
  • higher numbers are not specifically assigned
modifiers String Contains zero or more of the following, concatenated together with '|' characters in between. There may be a spurious trailing '|'.
  • control
  • alt -- the 'option' key on the mac
  • shift
  • meta -- the 'command' key on the mac

scroll_event

Parameters

Key Type Description
x Integer x-horizontal scroll steps
y Integer Y-vertical scroll steps
modifiers String Contains zero or more of the following, concatenated together with '|' characters in between. There may be a spurious trailing '|'.
  • control
  • alt -- the 'option' key on the mac
  • shift
  • meta -- the 'command' key on the mac

size_change

Either host-initiated or after a request from the plugin.

Parameters

Key Type Description
width Integer Width in pixels; size at which the plugin is expected to render
height Integer Height in pixels
texture_width Integer Width of texture in pixels; Number of pixesl in the buffer its being asked to draw into. May be larger than width parameter value.
texture_height Integer Height of texture in pixels; Number of pixesl in the buffer its being asked to draw into. May be larger than height parameter value.
name String Name of the shared memory segment the texture will draw into. Matches with the name in an shm_added.

set_priority

Tells the plugin its relative priority.

Parameters

Key Type Description
priority String One of:
  • stopped: media is not playing, shouldn't need to update at all
  • hidden: media is not being displayed or is out of view, don't need to do graphic updates, but may still update audio, playhead, etc.
  • slideshow: media is being displayed, but is being severely throttled to reduce resource usage
  • low: media is in the far distance, may be rendered at reduced size
  • normal: default priority
  • high: media has user focus and/or is taking up most of the screen

edit_cut

Perform an edit-menu "cut" operation to the system clipboard.

No parameters

edit_copy

Perform an edit-menu "copy" operation to the system clipboard.

No parameters

edit_paste

Perform an edit-menu "paste" operation from the system clipboard.

No parameters

Messages from the plugin to the PLS

texture_params

Parameters

Key Type Description
default_width Integer Optional. Default width for the texture.
default_height Integer Optional. Default height for the texture.
depth Integer Pixel size in bytes. Although the the format and type parameters completely determine the pixel size, deriving it is complex. Thus, the plugin must provide the value to the host.
internalformat String Texture internal format for glTexImage2D. The value is a string containing hexadecimal digits, (for example, "0xDEADBEEF") representing a GLint. See Note on OpenGL parameters.
format String Texture format for glTexImage2D. The value is a string containing hexadecimal digits, (for example, "0xDEADBEEF") representing a GLenum. See Note on OpenGL parameters.
type String Texture type for glTexImage2D. The value is a string containing hexadecimal digits, (for example, "0xDEADBEEF") representing a GLenum. See Note on OpenGL parameters.
swap_bytes Boolean Optional. True if the host should use glPixelStorei(GL_UNPACK_SWAP_BYTES, 1) when loading the data. If not specified, defaults to false.
coords_opengl Boolean True if the plugin wants to work in OpenGL coordinates (where (0,0) is the lower left corner of the texture); false to work in a coordinate system where (0,0) is the upper left.
allow_downsample Boolean Optional. If true, the host may negotiate a smaller texture when the plugin's priority is reduced. The plugin should not set this if downscaling the media is more expensive than drawing it at native size.

If the plugin sets the allow_downsample field in the texture_params message and the media's priority has been lowered, the host may reduce the requested draw dimensions.

  • The plugin should only set allow_downsample if it can draw the media at different scales without changing the overall look of the media, such as scaling down a video stream
  • Media that looks different when drawn at different pixel scales (such as a web browser where font sizes depend on pixel scale) should NOT set allow_downsample
  • If it's more expensive to draw media downsampled than at native resolution, the plugin should NOT set allow_downsample: it's supposed to be a way to reduce load on the system, and if it doesn't accomplish that it shouldn't be used.
padding Integer Optional. Specifies how the rows of the texture should be padded. Useful values:
  • 0 (the default) -- no padding is added
  • -1 -- pad width to the next power of two
  • 16 -- start each row on a 16 byte boundary -- NOTE: may not work correctly with odd-sized pixels like GL_RGB
  • 32 -- start each row on a 32 byte boundary -- NOTE: may not work correctly with odd-sized pixels like GL_RGB

NOTE: It is possible to request pixel size/alignment combinations that don't come out even when using 3-byte RGB pixels. If the host detects this, it will disable padding.

Note on OpenGL parameters: The hexadecimal GLint and GLenum values used for internalformat, format and type are set by the OpenGL, so passing them across process boundaries is generally safe.

updated

Specifies the update rectangle; the coordinates are specified within the buffer in which the media is being drawn. The coords_opengl flag in texture_params message specifies how coordinatess are interpreted.

Parameters

Key Type Description
left Integer Left x-coordinate of the update rectangle.
top Integer Top y-coordinate of the update rectangle.
right Integer Right x-coordinate of the update rectangle.
bottom Integer Bottom y-coordinate of the update rectangle.
current_time Real Optional. Current playhead time in seconds.
duration Real Optional. Total duration of the media in seconds
current_rate Real Optional. Rate at which the media is currently playing.
loaded_duration Real Optional. For media that is partially loaded, the duration through which the media could currently play or seek. For media which can't be loaded incrementally, either omit this parameter or set it to the same value as 'duration'.

media_status

Plugin describing the state to the PLS.

Parameters

Key Type Description
status String One of:
  • <empty string> -- not initialized or no media loaded
  • loading -- loading or navigating
  • loaded -- preroll/navigation complete
  • error -- navigation/preroll failed
  • playing -- playing (only for time-based media)
  • paused -- paused (only for time-based media)

name_text

Specifies a name for the media being displayed.

Parameters

Key Type Description
name String The name of the media. Typically the <title> tag in a Web page or the name in time based media.

size_change_request

Indicates the stream wants to change its native size.

Parameters

Key Type Description
width Integer Desired width in pixels.
height Integer Desired height in pixels.
name String Name of the shared memory segment the texture will draw into. This may induce the host to send a size_change message. The plugin may stop drawing to the texture until an appropriate size_change message has been received.

size_change_response

Sent by the plugin in response to size_change when the size change is complete.

See Shared memory size negotiation.

Parameters

Key Type Description
width Integer Width in pixels.
height Integer Height in pixels.
texture_width Integer Width of texture in pixels; Number of pixels in the buffer its being asked to draw into. May be larger than width parameter value.
texture_height Integer Height of texture in pixels; Number of pixels in the buffer its being asked to draw into. May be larger than height parameter value.
name String Name of the shared memory segment the texture will draw into

cursor_changed

Parameters

Key Type Description
name String One of:
  • <empty string>
  • arrow
  • ibeam
  • splith
  • splitv
  • hand

edit_state

Update the state of the edit menu items in the host. Note:

  • Items that are not present in the update message should have their state unchanged.
  • All states start out false in the host.
  • False means the operation is not possible and the menu should be disabled.


Parameters

Key Type Description
cut Boolean Optional.
copy Boolean Optional.
paste Boolean Optional.

Media_browser messages

Messages from the PLS to the plugin

focus

Give the plugin focus.

Parameters

Key Type Description
focused Boolean True to give the plugin instance focus.

clear_cache

Clear any cache that the plugin maintains.

No Parameters.

clear_cookies

Clear any cookies that the plugin maintains.

No Parameters.

enable_cookies

Enable or disable use of cookies.

Parameters

Key Type Description
enable Boolean Whether to enable cookies.

proxy_setup

Use a proxy and specify proxy settings.

Parameters

Key Type Description
enable Boolean Set to tru to enable using the spedcified proxy server.
host String Hostname of the proxy.
port Integer TCP port to use.

browse_stop

No Parameters.

browse_reload

Reload the media stream.

Parameters

Key Type Description
ignore_cache Boolean If true, bypass cache for this reload.

browse_forward

No Parameters.

browse_back

No Parameters.

set_status_redirect

Parameters

Key Type Description
code Integer The HTTP status code on which to redirect (currently, only 404).
url String URL to which to redirect.

init_history

Parameters

Key Type Description
history Array of strings Array of string URIs to add to the browser history.

Messages from the plugin to the PLS

navigate_begin

Parameters

Key Type Description
uri String URI to which the browser is navigating.

navigate_complete

Parameters

Key Type Description
uri String URI to which the browser was navigating.
result_code Integer For example, 200, 404.
result_string String "OK", "Not Found", etc.
history_back_available Boolean True if the "back" button should be enabled
history_forward_available Boolean True if the "forward" button should be enabled

progress

Parameters

Key Type Description
percent Integer Percent of page load that has completed; between zero (0) and 100, inclusive.

status_text

Parameters

Key Type Description
status String New browser status string.

location_changed

Parameters

Key Type Description
uri String New browser URI for the navigation bar.

click_href

Occurs when the user clicks on a link.

Parameters

Key Type Description
uri String URI of the link.
target String Target property of the link.

click_nofollow

Parameters

Key Type Description
uri String URI of the link.

Media_time messages

Messages from the PLS to the plugin

stop

No parameters.

start

Key Type Description
rate Real Optional. Rate to play at:
  • 0.0 is the movie's default rate.
  • 1.0 is normal forward (on most movies).
  • -1.0 is reverse.
  • Greater than 1.0 is fast foward.
  • Less than 1.0 is slow motion.

pause

No parameters.

seek

Key Type Description
time Real updated] message.

set_loop

Key Type Description
loop Boolean True to make the media loop, false to make it play once.

set_volume

Key Type Description
volume Real Muted is zero (0) and full volume is 1.0.
Retrieved from "https://wiki.secondlife.com/w/index.php?title=Linden_Lab_Official:Media_Plugin_System_Messages&oldid=1142379"