Game Boy Interface/Speedrunning Edition

2019-03-27T19:32:58Z

BambooShadow:

{{:Game Boy Interface}}
Formerly the (ultra-)low latency version, '''Game Boy Interface Speedrunning Edition''' ('''GBISR''') features a simplified video renderer, and aims to meet the needs of most [[wikipedia:Speedrun|speedrunning]] communities.

<div class="toclimit-4">
__TOC__
</div>

== Controls ==

=== Type A (two-handed) ===

{| class="wikitable" style="display: inline-table;"
|-
! Nintendo GameCube
! Nintendo GameCube Controller
! Logitech Speed Force
! Action
|-
|
| A/B Buttons
| A/B Buttons or Accelerator/Brake Pedals
| A/B Buttons
|-
|
| Y/Z Buttons
| Y/Z Buttons
| Select
|-
|
| X Button or Start/Pause
| X Button or Start/Pause
| Start
|-
|
| +Control Pad or Control Stick
| +Control Pad or Steering Wheel
| +Control Pad
|-
|
| L/R Buttons
| L/R Buttons
| L/R Buttons
|-
| Reset Button
| B, X and Start/Pause Buttons
| B, X and Start/Pause Buttons
| Power Switch
|-
| Reset Button
| X, Y and Start/Pause Buttons (Hold for 1.5 seconds)
|
| Recalibrate
|-
|
| X, Y and Start/Pause Buttons (Hold for 3 seconds)
|
| Swap controls (Only with SNES Controller)
|-
|
| C Stick Down
|
| Toggle input viewer
|}

{| class="wikitable" style="display: inline-table;"
|-
! DK Bongos Controller
! Active Life Mat Controller
! Action
|-
| Bottom Right/Left
| Orange Up/Right
| A/B Buttons
|-
| Hand Clap
| - Button
| Select
|-
| Start/Pause
| + Button
| Start
|-
| Top Right
| Blue or Orange Square
| +Control Pad Right
|-
| Top Left
| Blue Left
| +Control Pad Left
|-
|
| Blue Up
| +Control Pad Up
|-
|
| Blue or Orange Down
| +Control Pad Down
|}

=== Type B (one-handed) ===

{| class="wikitable" style="display: inline-table;"
|-
! Nintendo GameCube
! Nintendo GameCube Controller
! Logitech Speed Force
! Action
|-
|
| A/B Buttons
| A/B Buttons or Accelerator/Brake Pedals
| A/B Buttons
|-
|
| L/Z Buttons
| Y/Z Buttons
| Select
|-
|
| R Button or Start/Pause
| X Button or Start/Pause
| Start
|-
|
| +Control Pad, Control Stick or C Stick
| +Control Pad or Steering Wheel
| +Control Pad
|-
|
| Y/X Buttons
| L/R Buttons
| L/R Buttons
|-
| Reset Button
| B, X and Start/Pause Buttons
| B, X and Start/Pause Buttons
| Power Switch
|-
| Reset Button
| X, Y and Start/Pause Buttons (Hold for 1.5 seconds)
|
| Recalibrate
|-
|
| X, Y and Start/Pause Buttons (Hold for 3 seconds)
|
| Swap controls (Only with SNES Controller)
|}

{| class="wikitable" style="display: inline-table;"
|-
! DK Bongos Controller
! Active Life Mat Controller
! Action
|-
| Bottom Right/Left
| Orange Up/Right
| A/B Buttons
|-
| Hand Clap
| - Button
| Select
|-
| Start/Pause
| + Button
| Start
|-
|
| Blue or Orange Square
| +Control Pad Right
|-
|
| Blue Left
| +Control Pad Left
|-
|
| Blue Up
| +Control Pad Up
|-
|
| Blue or Orange Down
| +Control Pad Down
|-
| Top Left/Right
|
| L/R Buttons
|}

=== Type C (''Super Mario World: Super Mario Advance 2'') ===

{| class="wikitable" style="display: inline-table;"
|-
! Nintendo GameCube
! Nintendo GameCube Controller
! Logitech Speed Force
! Action
|-
|
| B/Y or X Buttons
| A/B Buttons or Accelerator/Brake Pedals
| A/B Buttons
|-
|
| Z Button
| Y/Z Buttons
| Select
|-
|
| Start/Pause
| X Button or Start/Pause
| Start
|-
|
| +Control Pad or Control Stick
| +Control Pad or Steering Wheel
| +Control Pad
|-
|
| L/R or A Buttons
| L/R Buttons
| L/R Buttons
|-
| Reset Button
| B, X and Start/Pause Buttons
| B, X and Start/Pause Buttons
| Power Switch
|-
| Reset Button
| X, Y and Start/Pause Buttons (Hold for 1.5 seconds)
|
| Recalibrate
|-
|
| X, Y and Start/Pause Buttons (Hold for 3 seconds)
|
| Swap controls (Only with SNES Controller)
|-
|
| C Stick Down
|
| Toggle input viewer
|}

=== Type D (''The Legend of Zelda: A Link to the Past'') ===

{| class="wikitable" style="display: inline-table;"
|-
! Nintendo GameCube
! Nintendo GameCube Controller
! Logitech Speed Force
! Action
|-
|
| Y/B Buttons
| A/B Buttons or Accelerator/Brake Pedals
| A/B Buttons
|-
|
| R Button or Start/Pause
| Y/Z Buttons
| Select
|-
|
| L/Z Buttons
| X Button or Start/Pause
| Start
|-
|
| +Control Pad, Control Stick or C Stick
| +Control Pad or Steering Wheel
| +Control Pad
|-
|
| X/A Buttons
| L/R Buttons
| L/R Buttons
|-
| Reset Button
| B, X and Start/Pause Buttons
| B, X and Start/Pause Buttons
| Power Switch
|-
| Reset Button
| X, Y and Start/Pause Buttons (Hold for 1.5 seconds)
|
| Recalibrate
|-
|
| X, Y and Start/Pause Buttons (Hold for 3 seconds)
|
| Swap controls (Only with SNES Controller)
|}

== Options ==

; <code>--offset=<x:y></code>
: Set offset (default: 0).
; <code>--zoom=<x:y></code>
: Set zoom (default: 2.0).
; <code>--rotate=<0-359></code>
: Set rotation (default: 0).
; <code>--poll=<0-11></code>
: Set controller polling rate.
: {| class="wikitable"
| '''0:'''
| VSync (most compatible)
|-
| '''1:'''
| 1000Hz (default)
|-
| '''2:'''
| 500Hz
|-
| '''3:'''
| 350Hz
|-
| '''4:'''
| 300Hz
|-
| '''5:'''
| 250Hz
|-
| '''6:'''
| 200Hz
|-
| '''7:'''
| 150Hz
|-
| '''8:'''
| 150Hz
|-
| '''9:'''
| 125Hz
|-
| '''10:'''
| 125Hz
|-
| '''11:'''
| 100Hz
|}
; <code>--control=<P1[:P2[:P3[:P4]]]></code>
: Set control scheme. The default is the Game Boy Player Start-up Disc's Controller setting (0 or 1).
: {| class="wikitable"
| '''0:'''
| [[#Type A (two-handed)|Type A (two-handed)]]
|-
| '''1:'''
| [[#Type B (one-handed)|Type B (one-handed)]]
|-
| '''2:'''
| [[#Type C (Super Mario World: Super Mario Advance 2)|Type C (''Super Mario World: Super Mario Advance 2'')]]
|-
| '''3:'''
| [[#Type D (The Legend of Zelda: A Link to the Past)|Type D (''The Legend of Zelda: A Link to the Past'')]]
|}
: Note: A Game Boy Advance used as a controller is a Nintendo GameCube Controller.
; <code>--delay-reset=<N></code>
: Set reset delay (default: 75).
; <code>--delay-video=<N></code>
: Set video buffering (default: 1).
; <code>--movie=<path></code>, <code>--no-movie</code>
: Play input log (default: no).
; <code>--movie-record</code>, <code>--no-movie-record</code>
: Record input log (default: no).
; <code>--overlay=<path></code>, <code>--no-overlay</code>
: Load texture palette (default: frame-srgb.tpl.gz).
; <code>--overlay-id=<ID></code>
: Set texture palette index. The default is the Game Boy Player Start-up Disc's Frame setting (0 to 19).
; <code>--overlay-scale=<x:y></code>
: Set texture scale (default: auto).
; <code>--palette=<xxxx-xxxx-xxxx></code>, <code>--no-palette</code>
: Apply [https://gamefaqs.gamespot.com/snes/588731-super-game-boy/faqs/58647 Super Game Boy] color palette (default: no).
: Note: Press Left + B while the Game Boy logo is visible for proper application on original Game Boy Game Paks.
; <code>--lut3d=<path></code>, <code>--no-lut3d</code>
: Load 32x32x32 lookup table (default: no).
; <code>--lut3d-order=<rgb|gbr|bgr></code>
: Specify lookup table order (default: rgb).
; <code>--scaler=<nearest|bilinear|oversample|box></code>
: Set image scaling filter (default: nearest).
; <code>--matrix=<identity|gba|gbc|gbi|nds|palm|psp|vba></code>
: Set color matrix (default: identity).
: {| class="wikitable"
| '''identity:'''
| [[wikipedia:Identity matrix|Identity matrix]]
|-
| '''gba:'''
| [[#Game Boy Advance|Game Boy Advance]] (by [https://forums.libretro.com/t/real-gba-and-ds-phat-colors/1540 Pokefan531])
|-
| '''gbc:'''
| Game Boy Color (by [https://forums.libretro.com/t/real-gba-and-ds-phat-colors/1540 Pokefan531])
|-
| '''gbi:'''
| Game Boy Interface
|-
| '''nds:'''
| [[#Nintendo DS|Nintendo DS]] (by [https://forums.libretro.com/t/real-gba-and-ds-phat-colors/1540 Pokefan531])
|-
| '''palm:'''
| [[#Palm Treo 700p|Palm Treo 700p]] (by [https://forums.libretro.com/t/real-gba-and-ds-phat-colors/1540 Pokefan531])
|-
| '''psp:'''
| [[#PlayStation Portable|PlayStation Portable]] (by [https://forums.libretro.com/t/real-gba-and-ds-phat-colors/1540 Pokefan531])
|-
| '''vba:'''
| VisualBoyAdvance-M (by [https://forums.libretro.com/t/real-gba-and-ds-phat-colors/1540 Pokefan531])
|}
; <code>--input-gamma=<red[:green[:blue]]></code>
: Set gamma (default: 2.2).
; <code>--output-gamma=<value></code>
: Specify screen gamma (default: 2.2).
; <code>--gamma=<even[:odd]></code>
: Set gamma correction (default: 1.0).
; <code>--contrast=<red[:green[:blue]]></code>
: Set gain (default: 1.0).
; <code>--brightness=<red[:green[:blue]]></code>
: Set lift (default: 0.0).
; <code>--blend=<value></code>
: Set alpha blending (default: 1.0).
; <code>--background=<#rrggbb></code>
: Set background color (default: #000000).
; <code>--vfilter=<middle[:lower[:upper]]></code>
: Set vertical filter coefficients (default: 1.0).
; <code>--volume=<left[:right]></code>
: Set audio gain (default: 0.75).
; <code>--sound=<[mono|stereo][,digital|analog]></code>
: Set sound mode. The default is the Sound Mode system setting (mono or stereo).
:; <code>digital</code>
:: Use PWM decoder (default).
:; <code>analog[=<a0:a1:a2:b1:b2>]</code>
:: Use 2MHz biquad filter. Defaults to a second-order low-pass filter with a cut-off of 10kHz and a quality factor of √2 if not specified.
; <code>--format=<[ntsc|pal|pal-m|ntsc-50|pal-60|custom|custom-m][,offset=<x:y>][,scaled-size=<w:h>][,size=<w:h>]></code>
: Set video format. The default is the Video Mode or Progressive Scan Mode system setting (ntsc, pal-60, pal-m, or custom).
:; <code>offset=<x:y></code>
:: Set screen position. The default is the Screen Position system setting (-32 to +32).
:; <code>scaled-size=<w:h></code>
:: Set screen size (default: auto).
:: Default scaled size is 704x480 for 60Hz and 704x576 for 50Hz.
:; <code>size=<w:h></code>
:: Set internal resolution (default: 640:480).
; <code>--scan-mode=<[interlace|quasi-interlace|non-interlace|progressive][,clock2x|no-clock2x][,size2x|no-size2x]></code>
: Set scan mode. The default is the Progressive Scan Mode system setting (non-interlace or progressive).
: {| class="wikitable"
| '''interlace:'''
| 15kHz interlace
|-
| '''quasi-interlace:'''
| 15kHz segmented frame
|-
| '''non-interlace:'''
| 15kHz progressive
|-
| '''progressive:'''
| 31kHz progressive
|}
:; <code>clock2x</code>, <code>no-clock2x</code>
:: Enable 27MHz pixel clock (default: auto). Enabling doubles the refresh rate for <code>interlace</code> modes. Disabling halves the refresh rate for <code>progressive</code> modes.
:: This only works with the Component Video Cable.
:; <code>size2x</code>, <code>no-size2x</code>
:: Enable 2x video oversampling (default: no). Enabling halves the refresh rate.
:: This only works with the Component Video Cable.
; <code>--osd-input[=<x:y>]</code>, <code>--no-osd-input</code>
: Show input viewer (default: no). Defaults to 0:-64 if not specified.
; <code>--usb</code>, <code>--no-usb</code>
: Enable [[USBGecko|USB Gecko]] features (default: yes).
; <code>--enhance</code>, <code>--no-enhance</code>
: Enable Game Boy Player enhancements (default: no). Enabling this option is not recommended.
: {| class="wikitable sortable"
! Title
! Feature(s)
|-
| ''[[wikipedia:Drill Dozer|Drill Dozer]]''
| Rumble
|-
| ''[[wikipedia:Game Boy Advance Video|Game Boy Advance Video]] Series''
| [[#Can I play Game Boy Advance Video?|Not compatible]]
|-
| ''[[wikipedia:Mario & Luigi: Superstar Saga|Mario & Luigi: Superstar Saga]]''
| Rumble, [[#Mario & Luigi: Superstar Saga|reduced contrast]]
|-
| ''[[wikipedia:Pokémon Pinball: Ruby & Sapphire|Pokémon Pinball: Ruby & Sapphire]]''
| Rumble
|-
| ''Shikakui Atama o Maru Kusuru Advance: Kanji Keisanhen''
| Rumble, restored contrast
|-
| ''Shikakui Atama o Maru Kusuru Advance: Kokugo Sansuu Shakai Rikahen''
| Rumble, restored contrast
|-
| ''[[wikipedia:Super Mario Advance 4: Super Mario Bros. 3|Super Mario Advance 4: Super Mario Bros. 3]]''
| Rumble, [[#Super Mario Bros. 3: Super Mario Advance 4|restored gamma]]
|}
: Note: Remove any accessory from the External Extension Connector, or the Rumble Feature will not work.
: Note: If you are using an EverDrive, make sure to turn off "Quick Boot" in the options, or the enhancements may not work.
; <code><path></code>
: Load Game Boy Advance multiboot ROM. Using this option is not recommended.
: Note: Remove any accessory from the External Extension Connector. Hold Start + Select while the Game Boy logo is visible.

Any file path can be relative or absolute. If relative, it is relative to <code>/GBI</code>. They can also explicitly specify the SD card to read from by prefixing an absolute path with <code>carda:</code> or <code>cardb:</code>

== Comparisons ==

=== Video quality ===

==== Blackmagic Intensity Shuttle ====

Using [http://www.analog.com/media/en/technical-documentation/data-sheets/ADV7180.pdf ADV7180] and [http://www.analog.com/media/en/technical-documentation/data-sheets/ADV7604.pdf ADV7604].

<gallery widths="240px" heights="160px">
File:GBI ADV7180 Composite NTSC.png|Nintendo Stereo AV Cable (NTSC-J)
File:GBI ADV7180 Composite PAL-M.png|Nintendo Stereo AV Cable (PAL-M)
File:GBI ADV7180 S-Video NTSC.png|Generic S-Video Cable (NTSC-J)
File:GBI ADV7180 S-Video PAL-M.png|Generic S-Video Cable (PAL-M)
File:GBI ADV7604 HDRV.png|HD Retrovision Component Video Cable
File:GBI ADV7604 Component.png|Nintendo Component Video Cable
File:GBI ADV7604 GCHD.png|GCVideo-DVI v2.4a and earlier
File:GBI ADV7604 GCHD RevB.png|GCVideo-DVI v2.4b
</gallery>

==== Datapath VisionRGB ====

Using [http://www.analog.com/media/en/technical-documentation/data-sheets/AD9887A.pdf AD9887A].

<gallery widths="240px" heights="160px">
File:GBI AD9887A HDRV.png|HD Retrovision Component Video Cable
File:GBI AD9887A Component.png|Nintendo Component Video Cable
File:GBI AD9887A GCHD.png|GCVideo-DVI v2.4a and earlier
File:GBI AD9887A GCHD RevB.png|GCVideo-DVI v2.4b
</gallery>

==== Hauppauge WinTV-HVR-1850 ====

Using [https://web.archive.org/web/20120509222042/http://conexant.com/servlets/DownloadServlet/PBR-200974-004.pdf?docid=975&revid=4 CX23888].

<gallery widths="240px" heights="160px">
File:GBI CX23888 NTSC.png|Nintendo RF Modulator (NTSC-J)
File:GBI CX23888 PAL-M.png|Nintendo RF Modulator (PAL-M)
File:GBI CX23888 Composite NTSC.png|Nintendo Stereo AV Cable (NTSC-J)
File:GBI CX23888 Composite PAL-M.png|Nintendo Stereo AV Cable (PAL-M)
File:GBI CX23888 S-Video NTSC.png|Generic S-Video Cable (NTSC-J)
File:GBI CX23888 S-Video PAL-M.png|Generic S-Video Cable (PAL-M)
</gallery>

=== Sound emulation ===

==== ''Mega Man Zero 2'' ====

* [https://files.extremscorner.org/gamecube/audio/gbi-a62e-none.flac Digital]
* [https://files.extremscorner.org/gamecube/audio/gbi-a62e-gba.flac Game Boy Advance]
* [https://files.extremscorner.org/gamecube/audio/gbi-a62e-gbp.flac Game Boy Player Start-up Disc]

==== ''Pokémon Sapphire'' ====

* [https://files.extremscorner.org/gamecube/audio/gbi-axpe-none.flac Digital]
* [https://files.extremscorner.org/gamecube/audio/gbi-axpe-gba.flac Game Boy Advance]
* [https://files.extremscorner.org/gamecube/audio/gbi-axpe-gbp.flac Game Boy Player Start-up Disc]

=== 3D lookup table ===

==== ''Pokémon Sapphire'' ====

<gallery widths="240px" heights="160px">
File:GBI AXPE Identity LUT.png|Identity LUT <code>lutrgb.png</code>
File:GBI AXPE GBA Light LUT.png|Game Boy Advance <code>lutrgb-gba-light.png</code>
File:GBI AXPE GBA LUT.png|Game Boy Advance <code>lutrgb-gba.png</code>
File:GBI AXPE GBC LUT.png|Gambatte/higan <code>lutrgb-gbc.png</code>
File:GBI AXPE GBP LUT.png|Game Boy Player Start-up Disc <code>lutrgb-gbp.png</code>
File:GBI AXPE NDS LUT.png|Nintendo DS <code>lutrgb-nds.png</code>
File:GBI AXPE VBA LUT.png|VisualBoyAdvance-M <code>lutrgb-vba.png</code>
File:GBI AXPE WiiU LUT.png|Wii U Virtual Console <code>lutrgb-wiiu.png</code>
</gallery>

=== Color matrix ===

==== ''Golden Sun'' ====

<gallery widths="240px" heights="160px">
File:GBI AGSE Identity.png|Identity matrix
File:GBI AGSE GBA.png|Game Boy Advance
File:GBI AGSE GBC.png|Game Boy Color
File:GBI AGSE GBI.png|Game Boy Interface
File:GBI AGSE NDS.png|Nintendo DS
File:GBI AGSE Palm.png|Palm Treo 700p
File:GBI AGSE PSP.png|PlayStation Portable
File:GBI AGSE VBA.png|VisualBoyAdvance-M
</gallery>

==== ''Mario Kart: Super Circuit'' ====

<gallery widths="240px" heights="160px">
File:GBI AMKE Identity.png|Identity matrix
File:GBI AMKE GBA.png|Game Boy Advance
File:GBI AMKE GBC.png|Game Boy Color
File:GBI AMKE GBI.png|Game Boy Interface
File:GBI AMKE NDS.png|Nintendo DS
File:GBI AMKE Palm.png|Palm Treo 700p
File:GBI AMKE PSP.png|PlayStation Portable
File:GBI AMKE VBA.png|VisualBoyAdvance-M
</gallery>

==== ''Pokémon Sapphire'' ====

<gallery widths="240px" heights="160px">
File:GBI AXPE Identity.png|Identity matrix
File:GBI AXPE GBA.png|Game Boy Advance
File:GBI AXPE GBC.png|Game Boy Color
File:GBI AXPE GBI.png|Game Boy Interface
File:GBI AXPE NDS.png|Nintendo DS
File:GBI AXPE Palm.png|Palm Treo 700p
File:GBI AXPE PSP.png|PlayStation Portable
File:GBI AXPE VBA.png|VisualBoyAdvance-M
</gallery>

==== ''The Legend of Zelda: The Minish Cap'' ====

<gallery widths="240px" heights="160px">
File:GBI BZME Identity.png|Identity matrix
File:GBI BZME GBA.png|Game Boy Advance
File:GBI BZME GBC.png|Game Boy Color
File:GBI BZME GBI.png|Game Boy Interface
File:GBI BZME NDS.png|Nintendo DS
File:GBI BZME Palm.png|Palm Treo 700p
File:GBI BZME PSP.png|PlayStation Portable
File:GBI BZME VBA.png|VisualBoyAdvance-M
</gallery>

==== ''Wario Land 4'' ====

<gallery widths="240px" heights="160px">
File:GBI AWAE Identity.png|Identity matrix
File:GBI AWAE GBA.png|Game Boy Advance
File:GBI AWAE GBC.png|Game Boy Color
File:GBI AWAE GBI.png|Game Boy Interface
File:GBI AWAE NDS.png|Nintendo DS
File:GBI AWAE Palm.png|Palm Treo 700p
File:GBI AWAE PSP.png|PlayStation Portable
File:GBI AWAE VBA.png|VisualBoyAdvance-M
</gallery>

== Examples ==

=== Color emulation ===

==== Game Boy Advance ====

[[File:GBI_Game_Boy_Advance.png|border|right]]
Using a contrast ratio of 250:1.

<pre>
--matrix=gba
--input-gamma=4.
--contrast=.74851331406341291833644689906823
--brightness=.25148668593658708166355310093177
</pre>

==== Nintendo DS ====

[[File:GBI_Nintendo_DS.png|border|right]]
Using a contrast ratio of 600:1.

<pre>
--matrix=nds
--input-gamma=2.2
--contrast=.94539857500845076575010909270066
--brightness=.05460142499154923424989090729934
</pre>

==== Palm Treo 700p ====

[[File:GBI_Palm_Treo_700p.png|border|right]]
Using a contrast ratio of 75:1.

<pre>
--matrix=palm
--input-gamma=2.2
--contrast=.85949252616415732890698972119636
--brightness=.14050747383584267109301027880364
</pre>

==== PlayStation Portable ====

[[File:GBI_PlayStation_Portable.png|border|right]]
Using a contrast ratio of 750:1.

<pre>
--matrix=psp
--input-gamma=2.2
--contrast=.95066513192721403818280764386444
--brightness=.04933486807278596181719235613556
</pre>

=== Color restoration ===

==== ''Mario & Luigi: Superstar Saga'' ====

This game reduces contrast when played ''with'' Game Boy Player enhancements.

<pre>
--contrast=1.1
</pre>

==== ''Super Mario Bros. 3: Super Mario Advance 4'' ====

This game reduces gamma when played ''without'' Game Boy Player enhancements.

<pre>
--input-gamma=2.8
</pre>

==== ''The Legend of Zelda: Oracle of Ages/Seasons'' ====

This game reduces gamma when played on a Game Boy Advance.
Due to Game Boy Color limitations, only shadows can be restored perfectly.

<pre>
--input-gamma=4.
</pre>

=== Mimicking ===

==== Game Boy Interface (ultra-low latency) ====

<pre>
--delay-reset=0
--delay-video=0
--no-overlay
--format=custom,scaled-size=528:320,size=480:320
</pre>

==== Game Boy Player Start-up Disc (60Hz) ====

Included as <code>gbisr.cli.example</code>.

<pre>
--delay-video=2
--contrast=.78125
--vfilter=.5:.25:.25
--sound=analog=.000148021979839541018009185791015625:.00029604395967908203601837158203125:.000148021979839541018009185791015625:-1.965293407440185546875:.965885460376739501953125
--format=ntsc,scaled-size=666:448,size=608:448
--scan-mode=interlace
--enhance
</pre>

==== Game Boy Player Start-up Disc (50Hz) ====

<pre>
--delay-reset=65
--delay-video=2
--contrast=.78125
--vfilter=.5:.25:.25
--sound=analog=.000148021979839541018009185791015625:.00029604395967908203601837158203125:.000148021979839541018009185791015625:-1.965293407440185546875:.965885460376739501953125
--format=pal,scaled-size=670:530,size=608:448
--scan-mode=interlace
--enhance
</pre>

==== Nintendo 3DS Virtual Console ====

===== ''F-Zero Maximum Velocity'', ''Fire Emblem: The Sacred Stones'', ''Mario vs. Donkey Kong'' and ''The Legend of Zelda: The Minish Cap'' =====

<pre>
--contrast=.7
--blend=.75
</pre>

===== ''Kirby & The Amazing Mirror'' =====

<pre>
--contrast=.6
--blend=.5625
</pre>

===== ''Mario Kart: Super Circuit'' =====

<pre>
--contrast=.65
--blend=.75
</pre>

===== ''Metroid Fusion'' =====

<pre>
--contrast=.7
--blend=.5625
</pre>

===== ''Wario Land 4'' and ''WarioWare, Inc.: Mega Microgame$'' =====

<pre>
--contrast=.65
--blend=.5625
</pre>

===== ''Yoshi's Island: Super Mario Advance 3'' =====

<pre>
--contrast=.6
--blend=.5
</pre>

=== Video optimization ===

==== Datapath VisionRGB (Component Video Cable) ====

<pre>
--vfilter=.5:.5:.0:.5:.0:.5
--format=custom,offset=0,scaled-size=0
--scan-mode=non-interlace,clock2x
</pre>

* Resolution and Refresh
** Width: 320
** Height: 240
** Vertical Refresh: 119.45
* Video Adjustments
** Horizontal Position: 85
** Horizontal Size: 433
** Phase: 27
** Vertical Position: 18
** Black Level: 8
* Cropping
** Top: 40
** Left: 40
** Width: 240
** Height: 160
* Color Adjustments
** Brightness: 32
** Contrast: 128
** Colour Domain: YUV (601)
** Colour Balance
*** All Colors
**** Brightness: 32
**** Contrast: 128
*** Red
**** Brightness: 158
**** Contrast: 158
*** Green
**** Brightness: 170
**** Contrast: 170
*** Blue
**** Brightness: 152
**** Contrast: 152

==== Open Source Scan Converter ====

Included as <code>gbisr-ossc.cli</code>, <code>gbisr-ossc.dol+cli</code> and <code>gbisr-ossc.gci</code>.
Refer to [http://www.firebrandx.com/gbiosscoptimal.html FirebrandX] for configuration.

<pre>
--vfilter=.5:.5:.0:.5:.0:.5
--format=custom,offset=0,scaled-size=0
--scan-mode=non-interlace
</pre>

==== XRGB-mini Framemeister ====

Included as <code>gbisr-xrgb.cli</code>, <code>gbisr-xrgb.dol+cli</code> and <code>gbisr-xrgb.gci</code>.
Refer to [http://www.firebrandx.com/framemeisterprofiles.html FirebrandX] for configuration.

<pre>
--vfilter=.5:.5:.0:.5:.0:.5
--format=custom-m,offset=0,scaled-size=0
--scan-mode=non-interlace
</pre>

=== Video output ===

==== 120Hz black frame insertion ====

<pre>
--vfilter=.5:.5:.0:.0
--scan-mode=non-interlace,clock2x
</pre>

==== 480p hybrid scanlines ====

<pre>
--overlay=frame.tpl.gz
--gamma=2.2:1.
--scan-mode=progressive
</pre>

==== 480p simple scanlines ====

<pre>
--vfilter=.5:.5:.0:.0
--scan-mode=progressive
</pre>

=== Video scaling ===

==== 4:3 fullscreen (Game Boy Advance) ====

<pre>
--zoom=2.375
--scaler=oversample
--vfilter=.625:.1875:.1875
--scan-mode=interlace
</pre>

==== 4:3 fullscreen (Game Boy Color) ====

<pre>
--zoom=3
--vfilter=.5:.25:.25
--scan-mode=interlace
</pre>

<pre>
--zoom=3
--vfilter=.5:.5:.0:.5:.0:.5
--scan-mode=non-interlace
</pre>

==== 16:9 fullscreen ====

<pre>
--zoom=2:3
--format=size=568
--scan-mode=progressive
</pre>

== FAQs ==

=== How do I change Game Paks? ===

# Hold the Reset Button.
# Slide the Game Pak Ejector.
# Insert a Game Pak into the Game Pak Slot.
# Release the Reset Button.

=== Can I play [[wikipedia:Game Boy Advance Video|Game Boy Advance Video]]? ===

Yes. You can do so by disabling Game Boy Player enhancements (<code>--no-enhance</code>), or holding a direction while the Game Boy Player logo is visible.

=== Is this an emulator? Can I play ROMs? ===

No, but there's [[Enhanced mGBA]] if you're looking for one.

== Changelog ==

=== March, 2019 ===

* Fixed Super Game Boy password order.

=== August, 2018 ===

* Updated color matrices by Pokefan531.

=== July, 2018 ===

* Updated GBA-as-GC controller.
* Disabled component video DAC oversampling.

=== June, 2018 ===

* Added analog sound emulation.
* Added Custom-M video format.
* Added Custom interlaced video modes.
* Merged vertical filter controls.
* Changed brightness/contrast controls to match BT.1886.
* Fixed some audio bugs.
* Enabled progressive scan in more cases to prevent display issues.

=== May, 2018 ===

* Added Super Game Boy color palette setting.
* Changed scan mode semantics.
* Fixed Game Boy Player advertisement.
* Fixed rumble protocol handshake.

=== April, 2018 ===

* Added movie recording/playback.
* Updated GBA-as-GC controller.

=== March, 2018 ===

* Added control swapping for SNES Controllers.
* Added framebuffer size/offset setting.
* Replaced sample aspect ratio with scaled size.
* Improved per-field filtering in single-buffered mode.
* Improved multiboot implementation.
* Improved Game Boy sound quality.
* Improved audio rendering.
* Reduced audio latency.
* Fixed SD card compatibility.
* Fixed multiboot to rumble protocol transition.
* Disabled default multiboot.

=== February, 2018 ===

* Added background color setting.
* Added video buffering setting.
* Added input viewer.
* Added color matrix from Gambatte.
* Added mono sound mode.
* Added 3D LUT auto-generation.
* Added GBR/BGR LUT order support.
* Added per-field gamma correction control.
* Changed some argument semantics.
* Fixed per-field settings with default video mode.
* Fixed wiiload autoboot with tiny GBA multiboot ROMs.
* Disabled machine checks.

=== January, 2018 ===

* Updated LUTs by Pokefan531.
* Improved Game Boy Player driver.
* Changed default component video modes.
* Tweaked control type C.

=== September, 2017 ===

* Added overlay scale setting.
* Added Logitech Speed Force support.
* Added Active Life Mat support.
* Improved Game Boy Player driver.
* Changed zoom scale.
* Changed wiiload server to accept oversized DOLs.
* Fixed one random kernel crash.
* Fixed scaling without a 3D LUT.

=== August, 2017 ===

* Added DK Bongos support.
* Adapted control type C for Super Mario World: Super Mario Advance 2.
* Added control type D for The Legend of Zelda: A Link to the Past.
* Added per-field vertical filter control.
* Added PNG 3D LUT support.
* Added LUTs by Pokefan531.
* Added LUTs from the 3DS Virtual Console.
* Improved Game Boy Player driver.

=== July, 2017 ===

* Added CLI append support.
* Updated GBA-as-GC controller.
* Changed reset combo behavior.

=== June, 2017 ===

* Added zoom & rotate.
* Added reset delay.
* Added reset combo.

=== April, 2017 ===

* Added component video DAC oversampling.
* Added reset fade effect.
* Added TPL overlay support.

=== March, 2017 ===

* Added rumble, disabled by default.
* Added USB Gecko wiiload server.
* Added Xboo Communicator.

=== February, 2017 ===

* Added volume control.
* Added per-channel settings where possible.
* Changed volume to 75% to mitigate clipping.

=== November, 2016 ===

* Updated GBA-as-GC controller.

=== September, 2016 ===

* Added video options.
* Added control schemes.
* Added polling rate setting.

=== May, 2016 ===

* Updated GBA-as-GC controller.
* Improved Game Boy Player driver.
* Fixed WaveBird Controllers.

=== April, 2016 ===

* Replaced GBA-as-controller with GBA-as-GC controller.

=== March, 2016 ===

* Added U+D/L+R cancelling.
* Added GBA-as-controller support.
* Recognized a half press of the analog triggers.

=== August, 2015 ===

* Added executable compression.
* Added memory card distribution files.
* Reduced coil whine.

=== July, 2015 ===

* Fixed Game Boy Player detection.

[[Category:Homebrew_Software]]

GC-Forever Wiki - User contributions [en]

Game Boy Interface/Speedrunning Edition