Difference between revisions of "Display services"

From Nintendo Switch Brew
Jump to navigation Jump to search
Line 14: Line 14:
 
| 3 || [5.0.0+] AttachSharedBuffer || Takes a total of 8-bytes of input, no output.
 
| 3 || [5.0.0+] AttachSharedBuffer || Takes a total of 8-bytes of input, no output.
 
|-
 
|-
−
| 5 || [5.0.0-8.1.0] CaptureRawImageToAttachedSharedBuffer || Takes a total of 0x10-bytes of input, no output.
+
| 5 || [5.0.0+] CaptureRawImageToAttachedSharedBuffer || Takes a total of 0x10-bytes of input, no output.
 
|-
 
|-
 
| 210 || [6.0.0+] ? || Takes a total of 0x50-bytes of input, a type-0x15 input buffer, and a type-0x45 input buffer, returns a total of 0x20-bytes of output.
 
| 210 || [6.0.0+] ? || Takes a total of 0x50-bytes of input, a type-0x15 input buffer, and a type-0x45 input buffer, returns a total of 0x20-bytes of output.
Line 26: Line 26:
 
| 1004 || [5.0.0+] RequestTakingScreenShotEx1 || Takes a total of 0x60-bytes of input, no output. [6.0.0+]: In addition, this also takes a type-0x15 input buffer.
 
| 1004 || [5.0.0+] RequestTakingScreenShotEx1 || Takes a total of 0x60-bytes of input, no output. [6.0.0+]: In addition, this also takes a type-0x15 input buffer.
 
|-
 
|-
−
| 1009 || [5.0.0-8.1.0] CancelTakingScreenShot || Takes a total of 0x10-bytes of input, no output.
+
| 1009 || [5.0.0+] CancelTakingScreenShot || Takes a total of 0x10-bytes of input, no output.
 
|-
 
|-
−
| 1010 || [5.0.0-8.1.0] SetTakingScreenShotCancelState || Takes a total of 0x10-bytes of input, no output.
+
| 1010 || [5.0.0+] SetTakingScreenShotCancelState || Takes a total of 0x10-bytes of input, no output.
 
|-
 
|-
−
| 1011 || [2.0.0-8.1.0] NotifyTakingScreenShotRefused || Takes a total of 8-bytes of input, no output.
+
| 1011 || NotifyTakingScreenShotRefused || Takes a total of 8-bytes of input, no output.
 
|-
 
|-
−
| 1012 || [2.0.0-8.1.0] NotifyTakingScreenShotFailed || Takes a total of 8-bytes of input, no output.
+
| 1012 || NotifyTakingScreenShotFailed || Takes a total of 8-bytes of input, no output.
 
|-
 
|-
 
| 1101 || [4.0.0+] [[#SetupOverlayMovieThumbnail]] ||  
 
| 1101 || [4.0.0+] [[#SetupOverlayMovieThumbnail]] ||  

Revision as of 03:23, 10 September 2019

The only image data contained in this sysmodule is basically a saved display framebuffer, no image data for actively-used layers/framebuffers.

caps:sc

This is "nn::capsrv::sf::IScreenShotControlService". This is available with [2.0.0+].

Cmd Name Notes
1 #CaptureRawImage
2 #CaptureRawImageWithTimeout
3 [5.0.0+] AttachSharedBuffer Takes a total of 8-bytes of input, no output.
5 [5.0.0+] CaptureRawImageToAttachedSharedBuffer Takes a total of 0x10-bytes of input, no output.
210 [6.0.0+] ? Takes a total of 0x50-bytes of input, a type-0x15 input buffer, and a type-0x45 input buffer, returns a total of 0x20-bytes of output.
[2.0.0-4.1.0] 1001 RequestTakingScreenShot Takes a total of 0x10-bytes of input, no output.
[2.0.0-4.1.0] 1002 RequestTakingScreenShotWithTimeout Takes a total of 0x18-bytes of input, no output.
[3.0.0-4.1.0] 1003 RequestTakingScreenShotEx Takes a total of 0x58-bytes of input, no output.
1004 [5.0.0+] RequestTakingScreenShotEx1 Takes a total of 0x60-bytes of input, no output. [6.0.0+]: In addition, this also takes a type-0x15 input buffer.
1009 [5.0.0+] CancelTakingScreenShot Takes a total of 0x10-bytes of input, no output.
1010 [5.0.0+] SetTakingScreenShotCancelState Takes a total of 0x10-bytes of input, no output.
1011 NotifyTakingScreenShotRefused Takes a total of 8-bytes of input, no output.
1012 NotifyTakingScreenShotFailed Takes a total of 8-bytes of input, no output.
1101 [4.0.0+] #SetupOverlayMovieThumbnail
1106 [4.0.0+] ?
1107 [4.0.0+] ?
1201 [3.0.0+] OpenRawScreenShotReadStream Takes a total of 0x10-bytes of input, returns a total of 0x18-bytes of output.
1202 [3.0.0+] CloseRawScreenShotReadStream No input/output.
1203 [3.0.0+] ReadRawScreenShotReadStream Takes a total of 8-bytes of input and a type-0x6 output buffer, returns a total of 8-bytes of output.
1204 [9.0.0+] Takes a total of 0x10-bytes of input and a type-0x46 output buffer, returns a total of 8-bytes of output.
  • cmd210: User-processes use hard-coded size 0x88 for the type-0x15 buffer.
  • cmd1106/1107: User-processes use hard-coded sizes 0x400 and 0x404 for the first/second type-0x15 buffers.
  • cmd1201/1202/1203: These are only usable when the previously loaded value from set:sys GetDebugModeFlag is set.

The only caps:sc commands used by GRC are: 1101, 1106, and 1107.

[8.0.0+] Cmd210 and cmd1004 now takes an additional type-0x15 input buffer.

CaptureRawImage

Takes a type-0x46 output buffer, an input u32 layer_stack, two input u64s width/height, an input s64 buffer_count, and an input s64 buffer_index.

width/height must match 1280/720. buffer_index must be < buffer_count. buffer_index and buffer_count must not be negative.

buffer_index and buffer_count correspond to buffers with size 0x384000(1280*720*4).

Value 0 is usable for the input u32.

This takes a screenshot, the output buffer contains the RGBA8 image.

Stubbed with [5.0.0+], where it now returns error 0x7FECE.

CaptureRawImageWithTimeout

Calls the same internal func as #CaptureRawImage, where the last param is an additional cmd input u64 instead of hard-coded value 0x5f5e100.

Stubbed with [5.0.0+], where it now returns error 0x7FECE.

SetupOverlayMovieThumbnail

Takes two input u64s width/height, a 0x18-byte input struct, and two type-0x46 output buffers.

For the input struct, GRC uses the output from caps:c cmd2101.

width/height must be 1280x720. The first buffer address must be 0x400-byte aligned. The size of the first buffer must be at least width*height, and must be aligned to 0x20000-bytes.

The requirements for the second buffer address/size are the same as the first buffer, except the minimum size is (width*height)/2.

Cmd1106

Takes a 0x40-byte input struct, two input u64s width/height, a 0x18-byte input struct, two type-0x15 input buffers, a type-0x6 output buffer, and two type-0x46 output buffers, returns 3 output u64s.

width/height have same requirements as #SetupOverlayMovieThumbnail. The size of the type-0x6 buffer must be at least 0x7D000. The requirements for the type-0x46 buffers are the same as #SetupOverlayMovieThumbnail.

[5.0.0+] Now takes a total of 0x68-bytes of input instead of 0x30.

Cmd1107

Takes a 0x40-byte input struct, two input u64s width/height, a 0x18-byte input struct, two type-0x15 input buffers, a type-0x6 output buffer, and a type-0x45 input buffer, returns 3 output u64s.

width/height have same requirements as #SetupOverlayMovieThumbnail. The size of the type-0x6 buffer must be at least 0x7D000. The size of the type-0x45 buffer must be at least 0x384000.

[5.0.0+] Now takes a total of 0x68-bytes of input instead of 0x30.

caps:ss

This is "nn::capsrv::sf::IScreenShotService". This is available with [2.0.0+].

Cmd Name
201 SaveScreenShot
202 SaveEditedScreenShot
203 [3.0.0+] SaveScreenShotEx0
204 [3.0.0+] SaveEditedScreenShotEx0
206 [?-8.1.0]
208 [5.0.0-8.1.0] SaveScreenShotOfMovieEx1

caps:su

This is "nn::capsrv::sf::IScreenShotApplicationService".

This was added with [3.0.0+]. This was moved to AM with [6.0.0+].

Cmd Name
201 SaveScreenShot
203 SaveScreenShotEx0

cec-mgr

This is "nn::cec::ICecManager".

Cmd Name
0 RegisterCallback
1 UnregisterCallback
2 TriggerSystemEvent
3 PerformAction
4 QueryState
5 OnSystemEvent
6 [2.0.0+] CancelCurrentCall
100 [4.0.0+] GetHdcpServiceObject

GetHdcpServiceObject: No input, returns a #IHdcpController.

IHdcpController

This is "nn::hdcp::IHdcpController".

Added with [4.0.0+].

Cmd Name
0 GetHdcpStateTransitionEvent
1 GetHdcpAuthenticationState
2 SetCurrentHdcpMode
3 GetCurrentHdcpMode

mm:u

This is "nn::mmnv::IRequest".

NVIDIA multimedia (NvMM) platform service.

Cmd Name
0 InitializeOld
1 FinalizeOld
2 SetAndWaitOld
3 GetOld
4 Initialize
5 Finalize
6 SetAndWait
7 Get

vi:u

This is "nn::visrv::sf::IApplicationRootService".

Cmd Name
0 GetDisplayService
1 [9.0.0+]

GetDisplayService

Returns an #IApplicationDisplayService. Takes an input u32, user-processes use 0 or 1, with 0 for regular-applications normally. 0 = user-service(vi:u), 1 = system/manager service (vi:s/vi:m). Returns an error when using value 1 with vi:u(same error listed below for IApplicationDisplayService for unavailable commands), however passing 1 to vi:s/vi:m results in the IApplicationDisplayService having greater privileges.

vi:s

This is "nn::visrv::sf::ISystemRootService".

Cmd Name
1 GetDisplayService
3 GetDisplayServiceWithProxyNameExchange

GetDisplayService

Returns an #IApplicationDisplayService. Same input as vi:u.

GetDisplayServiceWithProxyNameExchange

Returns an #IApplicationDisplayService.

vi:m

This is "nn::visrv::sf::IManagerRootService".

Cmd Name
2 GetDisplayService
3 GetDisplayServiceWithProxyNameExchange

GetDisplayService

Returns an #IApplicationDisplayService. Same input as vi:u.

GetDisplayServiceWithProxyNameExchange

Takes an input u64 and u32. Returns an #IApplicationDisplayService.

IApplicationDisplayService

This is "nn::visrv::sf::IApplicationDisplayService".

Cmd Name
100 #GetRelayService
101 #GetSystemDisplayService
102 #GetManagerDisplayService
103 [2.0.0+] #GetIndirectDisplayTransactionService
1000 #ListDisplays
1010 #OpenDisplay
1011 #OpenDefaultDisplay
1020 #CloseDisplay
1101 #SetDisplayEnabled
1102 #GetDisplayResolution
2020 #OpenLayer
2021 #CloseLayer
2030 #CreateStrayLayer
2031 #DestroyStrayLayer
2101 #SetLayerScalingMode
2102 [5.0.0+] ConvertScalingMode
2450 #GetIndirectLayerImageMap
2451 #GetIndirectLayerImageCropMap
2460 #GetIndirectLayerImageRequiredMemoryInfo
5202 #GetDisplayVsyncEvent
5203 #GetDisplayVsyncEventForDebug

Available sessions for each service:

  • "vi:u": Only GetRelayService.
  • "vi:s": Everything except GetManagerDisplayService.
  • "vi:m": All.

When attempting to use a get-session cmd with a service it's not available with, error 0xA72 is returned.

These commands using PIDs have AppletResourceUserId as the last input u64, hence AppletResourceUserId must match the user-process PID(no special handling for value 0).

GetRelayService

Returns an IHOSBinderDriver interface which abstracts "nn::visrv::service::RelayServiceImpl".

GetIndirectDisplayTransactionService

Returns an IHOSBinderDriver interface which abstracts "nn::visrv::service::IndirectDisplayTransactionServiceImpl".

GetSystemDisplayService

Returns an #ISystemDisplayService.

GetManagerDisplayService

Returns an #IManagerDisplayService.

ListDisplays

Takes a type-0x6 output buffer containing the array of #DisplayInfo output entries. Returns an output u64: total number of output entries.

Normally(?) this only returns the "Default" display.

OpenDisplay

Takes a #DisplayName as input. Returns an output u64, the DisplayId.

To open the default display, input string "Default" can be used.

OpenDefaultDisplay

Returns an output u64.

Probably not (?) used by newer official user-processes, since those use OpenDisplay with the default string instead.

CloseDisplay

Takes an input u64, DisplayId.

SetDisplayEnabled

Takes an input u32 boolean, and an u64 DisplayId.

GetDisplayResolution

Takes an input u64 DisplayId and returns two output u64s: width and height.

OpenLayer

Takes a PID-descriptor, a type-0x6 buffer for the output #NativeWindow, a #DisplayName(which was previously used with #OpenDisplay), an u64 LayerId, and an u64 AppletResourceUserId. Returns an output u64 NativeWindow_Size.

Official user-processes use a LayerId stored in a global state field("...ExternalLayerId") if non-zero, otherwise:

This OpenLayer command returns error 0x272 when the AppletResourceUserId is invalid.

CloseLayer

Takes an input u64: LayerId which was used with #OpenLayer.

CreateStrayLayer

Takes a type-0x6 buffer for the output #NativeWindow, an u32(LayerFlags bitmask), and an u64 DisplayId. Returns two output u64s: LayerId and NativeWindow_Size.

DestroyStrayLayer

Takes an input u64: LayerId from #CreateStrayLayer.

SetLayerScalingMode

Takes an input u64("ScalingMode") and u64 ("LayerId").

GetIndirectLayerImageMap

Takes a PID-descriptor, an type-0x46 buffer, and four u64s: width(s32), height(s32), <output from AM GetIndirectLayerConsumerHandle>, and AppletResourceUserId. Returns two output u64s.

Calls the same func as #GetIndirectLayerImageCropMap internally, with the input floats set to 0.0f, then 1.0f for the rest.

GetIndirectLayerImageCropMap

Takes a PID-descriptor, an type-0x46 buffer, four floats, four u64s(last u64 is AppletResourceUserId). Returns two output u64s. The floats are stored immediately after each other(32bits).

GetIndirectLayerImageRequiredMemoryInfo

Takes two input u64s: width and height. Returns two output u64s. First u64 is the buffer size to use with the ImageMap cmds, second u64 is the buffer address alignment for those cmds.

GetDisplayVsyncEvent

Takes an input u64 DisplayId and returns a handle.

GetDisplayVsyncEventForDebug

Takes an input u64 DisplayId and returns a handle.

ISystemDisplayService

This is "nn::visrv::sf::ISystemDisplayService".

Cmd Name
1200 GetZOrderCountMin
1202 GetZOrderCountMax
1203 GetDisplayLogicalResolution
1204 [3.0.0+] SetDisplayMagnification
2201 SetLayerPosition
2203 SetLayerSize
2204 GetLayerZ
2205 SetLayerZ
2207 SetLayerVisibility
2209 SetLayerAlpha
2312 [1.0.0-6.2.0] CreateStrayLayer
2400 OpenIndirectLayer
2401 CloseIndirectLayer
2402 FlipIndirectLayer
3000 ListDisplayModes
3001 ListDisplayRgbRanges
3002 ListDisplayContentTypes
3200 GetDisplayMode
3201 SetDisplayMode
3202 GetDisplayUnderscan
3203 SetDisplayUnderscan
3204 GetDisplayContentType
3205 SetDisplayContentType
3206 GetDisplayRgbRange
3207 SetDisplayRgbRange
3208 GetDisplayCmuMode
3209 SetDisplayCmuMode
3210 GetDisplayContrastRatio
3211 SetDisplayContrastRatio
3214 GetDisplayGamma
3215 SetDisplayGamma
3216 GetDisplayCmuLuma
3217 SetDisplayCmuLuma
8225 [4.0.0+] GetSharedBufferMemoryHandleId
8250 [4.0.0+] OpenSharedLayer
8251 [4.0.0+] CloseSharedLayer
8252 [4.0.0+] ConnectSharedLayer
8253 [4.0.0+] DisconnectSharedLayer
8254 [4.0.0+] AcquireSharedFrameBuffer
8255 [4.0.0+] PresentSharedFrameBuffer
8256 [4.0.0+] GetSharedFrameBufferAcquirableEvent
8257 [4.0.0+] FillSharedFrameBufferColor
8258 [5.0.0+] CancelSharedFrameBuffer

IManagerDisplayService

This is "nn::visrv::sf::IManagerDisplayService".

Cmd Name
200 [4.0.0+] AllocateProcessHeapBlock
201 [4.0.0+] FreeProcessHeapBlock
1102 [3.0.0+] GetDisplayResolution
2010 CreateManagedLayer
2011 DestroyManagedLayer
2012 [7.0.0+] CreateStrayLayer
2050 CreateIndirectLayer
2051 DestroyIndirectLayer
2052 CreateIndirectProducerEndPoint
2053 DestroyIndirectProducerEndPoint
2054 CreateIndirectConsumerEndPoint
2055 DestroyIndirectConsumerEndPoint
2300 AcquireLayerTexturePresentingEvent
2301 ReleaseLayerTexturePresentingEvent
2302 GetDisplayHotplugEvent
2303 [5.1.0+] GetDisplayModeChangedEvent
2402 GetDisplayHotplugState
2501 [4.0.0+] GetCompositorErrorInfo
2601 [4.0.0+] GetDisplayErrorEvent
4201 SetDisplayAlpha
4203 SetDisplayLayerStack
4205 SetDisplayPowerState
4206 [4.0.0+] SetDefaultDisplay
6000 AddToLayerStack
6001 RemoveFromLayerStack
6002 SetLayerVisibility
6003 [5.0.0+] SetLayerConfig
6004 [5.0.0+] AttachLayerPresentationTracer
6005 [5.0.0+] DetachLayerPresentationTracer
6006 [5.0.0+] StartLayerPresentationRecording
6007 [5.0.0+] StopLayerPresentationRecording
6008 [5.0.0+] StartLayerPresentationFenceWait
6009 [5.0.0+] StopLayerPresentationFenceWait
6010 [5.0.0+] GetLayerPresentationAllFencesExpiredEvent
6011 [7.0.0+] EnableLayerAutoClearTransitionBuffer
6012 [7.0.0+] DisableLayerAutoClearTransitionBuffer
7000 SetContentVisibility
8000 SetConductorLayer
8001 [8.0.0+] SetTimestampTracking
8100 SetIndirectProducerFlipOffset
8200 [4.0.0+] CreateSharedBufferStaticStorage
8201 [4.0.0+] CreateSharedBufferTransferMemory
8202 [4.0.0+] DestroySharedBuffer
8203 [4.0.0+] BindSharedLowLevelLayerToManagedLayer
8204 [4.0.0+] BindSharedLowLevelLayerToIndirectLayer
8207 [4.0.0+] UnbindSharedLowLevelLayer
8208 [4.0.0+] ConnectSharedLowLevelLayerToSharedBuffer
8209 [4.0.0+] DisconnectSharedLowLevelLayerFromSharedBuffer
8210 [4.0.0+] CreateSharedLayer
8211 [4.0.0+] DestroySharedLayer
8216 [4.0.0+] AttachSharedLayerToLowLevelLayer
8217 [4.0.0+] ForceDetachSharedLayerFromLowLevelLayer
8218 [4.0.0+] StartDetachSharedLayerFromLowLevelLayer
8219 [4.0.0+] FinishDetachSharedLayerFromLowLevelLayer
8220 [4.0.0+] GetSharedLayerDetachReadyEvent
8221 [4.0.0+] GetSharedLowLevelLayerSynchronizedEvent
8222 [4.0.0+] CheckSharedLowLevelLayerSynchronized
8223 [4.0.0+] RegisterSharedBufferImporterAruid
8224 [4.0.0+] UnregisterSharedBufferImporterAruid
8227 [4.0.0+] CreateSharedBufferProcessHeap
8228 [4.0.0+] GetSharedLayerLayerStacks
8229 [4.0.0+] SetSharedLayerLayerStacks
8291 [4.0.0+] PresentDetachedSharedFrameBufferToLowLevelLayer
8292 [4.0.0+] FillDetachedSharedFrameBufferColor
8293 [4.0.0+] GetDetachedSharedFrameBufferImage
8294 [4.0.0+] SetDetachedSharedFrameBufferImage
8295 [4.0.0+] CopyDetachedSharedFrameBufferImage
8296 [4.0.0+] SetDetachedSharedFrameBufferSubImage
8297 [4.0.0+] GetSharedFrameBufferContentParameter
8298 [5.0.0+] ExpandStartupLogoOnSharedFrameBuffer

[5.0.0+] SetDetachedSharedFrameBufferImage now takes an additional 0x10-bytes of input. CopyDetachedSharedFrameBufferImage now takes an additional 0x18-bytes of input. SetDetachedSharedFrameBufferSubImage now takes an additional 0x10-bytes of input, and the buffer type was changed from 0x5 to 0x45.

DisplayInfo

Offset Size Description
0x0 0x40 #DisplayName
0x40 0x1 Whether or not the display has a constrained number of layers.
0x41 0x7 Padding/Reserved
0x48 0x8 If this display has a constrained number of layers (0x40 is set), indicates the maximum number of layers.
0x50 0x8 Width in pixels
0x58 0x8 Height in pixels

This is a 0x60-byte structure.

The width/height for the "Default" Display is the resolution for 1080p even when in handheld-mode.

DisplayName

This is a 0x40-byte block: a NUL-terminated string.

Can be "Default", "External", "Edid", "Internal" or "Null".

Parcel

Offset Size Description
0x0 0x4 ParcelDataSize
0x4 0x4 ParcelDataOffset
0x8 0x4 ParcelObjectsSize
0xC 0x4 ParcelObjectsOffset
0x10 ? FlattenedBinder

NativeWindow

Max size of this buffer is 0x100-bytes(outbuf size used by official user-processes). Parsed("...DeserializeNativeWindow()") by a function called by the code described under #OpenLayer, which executes code with Android symbols.

This is a #Parcel.

ParcelData

This normally contains the following:

Offset Size Description
0x0 0x4 0x2
0x4 0x4 Probably the user-process PID?
0x8 0x4 ID
0xC 0xC All-zero normally?
0x18 0x8 NUL-terminated "dispdrv" string.
0x20 0x8 All-zero normally?

The above ID is used for the ID param for the binder commands with IHOSBinderDriver.

ParcelObjects

This normally contains an u32 with value 0?

Resolution handling

There doesn't seem to be a way to get the actual TV resolution while using the "Default" Display. Official apps just hard-code what resolution to use depending on the current OperationMode.

Retrieved from "https://switchbrew.org/w/index.php?title=Display_services&oldid=7720"