Editing GimConv

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 4: Line 4:


*GimConv.exe versions:
*GimConv.exe versions:
**'''1.20c''' (it can be seen in the [[Graphic_Image_Map_(GIM)#0xFF_.28Fileinfo.29 |fileinfo block]] of GIM images with timestamp from november 2005, since firmware 0.82.006)
**'''1.20c''' (GIM files made around 2005 included in pre-retail PS3 firmwares such 0.82.006)
**'''1.20d''' (it can be seen in the [[Graphic_Image_Map_(GIM)#0xFF_.28Fileinfo.29 |fileinfo block]] of GIM images with timestamp from march 2006, since firmware 0.85.007)
**'''1.20e''' (GIM files made around 2006 and still present in PS3 4.82 firmware)
**'''1.20e''' (it can be seen in the [[Graphic_Image_Map_(GIM)#0xFF_.28Fileinfo.29 |fileinfo block]] of GIM images with timestamp from april 2006, since firmware 0.85.007 and still present in PS3 4.82 firmware)
**'''1.20h''' released with '''p3tcompiler v2.00''' as part of the [http://uk.playstation.com/ps3/support/settings/detail/linked235336/item85346/Download-PlayStation-3-Custom-Theme-Guidelines/ PS3 Custom Theme Toolbox] (this is the version included in rcomage using a modifyed GimConv.cfg)
**'''1.20h''' released with '''p3tcompiler v2.00''' as part of the [http://uk.playstation.com/ps3/support/settings/detail/linked235336/item85346/Download-PlayStation-3-Custom-Theme-Guidelines/ PS3 Custom Theme Toolbox] (this is the version included in rcomage using a modifyed GimConv.cfg)


Line 12: Line 11:
**GIM images can be previewed in PC by using '''Gim Viewer''' (unnofficial app made by hsreina, it has limited support for the "rgba based" GIM formats). See [[Multimedia_Formats_and_Tools#GIM | Multimedia Formats and Tools]]
**GIM images can be previewed in PC by using '''Gim Viewer''' (unnofficial app made by hsreina, it has limited support for the "rgba based" GIM formats). See [[Multimedia_Formats_and_Tools#GIM | Multimedia Formats and Tools]]
**The option '''-viewer''' (start gimview.exe when process ends) in the official config file (that was removed for rcomage) is intended to launch an official '''gimview.exe''' that doesnt exists in the public release
**The option '''-viewer''' (start gimview.exe when process ends) in the official config file (that was removed for rcomage) is intended to launch an official '''gimview.exe''' that doesnt exists in the public release
**[http://us.playstation.com/support/manuals/psp/pspguides/ PSP Custom Theme Toolbox] admits GIM files as inputs, but doesnt includes an standalone GIM converter
**[http://us.playstation.com/support/manuals/psp/pspguides/ PSP Custom Theme Toolbox] admits GIM files as inputs, but doesnt includes a GIM converter
**Some of the settings (such '''merge_mode''') seems to be related with animated images but the support of animated GIM images on PlayStation consoles is unknown, see: [http://endlessparadigm.com/forum/showthread.php?tid=5054 talk]
**Some of the settings (such '''merge_mode''') are related with animated images but the support of animated GIM images on PlayStation consoles is unknown, see: http://endlessparadigm.com/forum/showthread.php?tid=5054
**Supports AVI video as input, converts the video frames to static images and build a multiframe GIM with them
**It supports AVI video as input, probably to convert the video frames to static images and build a GIM animation with them, unknown usage
**Supports an internal script format to automatize image conversions, there is one script definition located at bottom of Gimconv.cfg named "Filter". The usage of this scripting features is unknown
**Gimconv.exe supports an internal script format to automatize image conversions, it can be seen how appears as an option available at bottom of Gimconv.cfg and allows to create GIM-to-GIS conversions. The usage of this scripting features is mostly unknown
**It uses an intermediate format named '''GIS''' that seems to be related with the scripting features
**There is a [http://tizzyt-archive.blogspot.com.es/2013/10/gis2png.html GIS2PNG converter] made by TizzyT
**There is a [http://tizzyt-archive.blogspot.com.es/2013/10/gis2png.html GIS2PNG converter] made by TizzyT


=GimConv.cfg Overview=
=GimConv.exe usage=
Before explaining how GimConv.exe works is needed an introduction about GimConv.cfg (the config file). All features of GimConv.exe are driven by the settings that appears on GimConv.cfg
Before explaining how works GimConv.exe is needed an introductory explain about how works GimConv.cfg (the settings file). GimConv.cfg is divided in sections and is loaded "from top to bottom", at top are the "default settings" where are given a default value, if a setting is repeated below the new value overrides the default. After the "default settings" appears the "options" that defines a group of settings, and this settings inside options overrides the defaults settings at top
 
==GimConv.exe help screen==
The command line help screen of GimConv.exe displays a very limited list of predefined options with an small explain for them, the example below belongs to the official GimConv.cfg and shows the options sony considered was useful for them
 
{{Keyboard|content='''C:\PS3_Custom_Theme_v200\GimConv>GimConv.exe'''
gimconv ver 1.20h --- generic picture converter
Copyright (C) 2006 Sony Computer Entertainment Inc.
  All Rights Reserved.
 
usage:
        gimconv <input files> [options]
 
options:
        -interact      input additional options
        -pictures      merge files as pictures
        -frames        merge files as frames
        -levels        merge files as levels
        -prompt        prompt always
        -warning        prompt on warning
        -error          prompt on error
        -viewer        start gimview.exe when process ends
        -o <filename>  specify output file name
        -s <w,h>        resize image data
        -S              output text format
        -P              resize image data to a power of two
        -N              output in normal pixel storage format
        -F              output in faster pixel storage format
        -R              re-convert ( don't swap RGBA <-> ABGR )
}}
 
==GimConv.exe usage with options==
For GIM-to-PNG conversions is not needed to use special options:
{{Keyboard|content='''gimconv.exe in.gim -o out.png'''}}
 
If you create a PNG-to-GIM (or any of the supported input image formats to GIM) without specifying special options it will generate a GIM with the "default settings" of GimConv.cfg "from top to bottom", you can achieve it by doing:
{{Keyboard|content='''gimconv.exe in.png -o out.gim'''}}
 
Additionally to the options that appears on the help screen there are a lot more special options inside GimConv.cfg, all them can be used in the same way, actually the help screen is just informative and the options that appears in it are not much useful for us
 
To specify an option is needed to use the name of the '''-option''' at the end of the line. At the time GimConv.exe processes this command it loads the settings of GimConv.cfg file "from top to bottom" (so it starts loading the default settings) and then it loads the option we have choosen (and the option contains settings that overrides the defaults)
{{Keyboard|content='''gimconv.exe in.png -o out.gim -DXT'''}}
*Note the option -DXT at bottom of GimConv.cfg is composed by 3 settings (this is an example of the official GimConv.cfg, the one used inside rcomage is different):
{{Boxcode|content=<syntaxhighlight lang="c">
option -DXT {
pixel_order = default
pixel_channel = default
image_format = default
}
</syntaxhighlight>}}
 
Another example where can be seen better how the options contains settings that overrides the default settings:
{{Keyboard|content='''gimconv.exe in.gim -o out.gis -S'''}}
*The option '''-S''' contains this settings that are going to override the defaults:
{{Boxcode|content=<syntaxhighlight lang="c">
option -S {
output_object = off
output_script = on
}
</syntaxhighlight>}}
If you look at GimConv.cfg "from top to bottom" you are going to find at top the default settings '''output_object''' with value '''on''' and '''output_script''' with value '''off''' (so by default it outputs a GIM and doesnt outputs a GIS). The option '''-S''' is "switching" them (doesnt outputs a GIM but it outpputs a GIS)


The contents of GimConv.cfg are loaded "from top to bottom" first are loaded the default settings, and then the settings inside the option (incase you enable some option/s, otherway the options are ignored). When enabled, the settings inside the options (at bottom ofGimConv.cfg) are going to "override" the default settings (at top of GimConv.cfg), this overriding also happens with any setting or option you use in command line, as example, if you change the same setting 3 times in a single command line the only setting that counts is the last one
==GimConv.exe usage with explicit settings==
usage {
This is the most accurate way to have full controll of the settings, if you are picky enought you can write a long line of settings to be sure you are overriding all the defaults (just incase the GimConv.cfg has been modifyed by someone, by doing this you are overriding his/her changes made to default settings). If you are writing an script or any tool that sends actions to gimconv.exe you should use this method
        This is the help screen (only informative)
{{Keyboard|content='''gimconv.exe in.png -o out.gim --pixel_order normal --format_style psp --format_endian big'''}}
}
*Note the 3 options used in the example are overriding the default settings at top of GimConv.cfg (this is an example of the official GimConv.cfg, the one used inside rcomage is different):
default {
{{Boxcode|content=<syntaxhighlight lang="c">
        Default predefined settings (loaded "from top to bottom", if a setting is repeated two or more times the most at bottom overrides the other/s at top)
//----------------------------------------------------------------
  }
// default settings
input * {
//----------------------------------------------------------------
        Settings for input file formats
pixel_order = default // default normal faster
}
format_style = psp // std psp ps3
option * {
format_endian = little // little big
        Groups of settings (overrides the defaults settings, are only used when you specify the option name at the command line)
</syntaxhighlight>}}
}
script * {
        Unknown
}


Below is shown GimConv.cfg released by sony as part of the [http://uk.playstation.com/ps3/support/settings/detail/linked235336/item85346/Download-PlayStation-3-Custom-Theme-Guidelines/ PS3 Custom Theme Toolbox] (official version)
==GimConv.exe usage driven by rcomage==
{{Boxwarning1|content='''Dont use this method for PS3'''. GIM files inside RCO files from PS3 firmware uses variated formats, this method applyes the same settings for all them and breaks some}}
This works by sending GIM settings from rcomage.exe to gimconv.exe and is made at the time rcomage.exe is compiling the RCO (see the "compile" help in [[rcomage]] page)


{{Boxcode|height=520px|title=GimConv.cfg (original)|code=<syntaxhighlight lang="c">
There are 2 options in rcomage specific for this task, named: '''--gimconv-cmd''' and '''--gimconv-flags'''
{{Keyboard|content='''rcomage.exe compile in.xml out.rco --gimconv-cmd ".\gimconv\gimconv.exe" --gimconv-flags "--pixel_order normal --format_style psp --format_endian big"'''}}
 
=GimConv.cfg Overview (official version)=
This is the configuration file released by sony as part of the [http://uk.playstation.com/ps3/support/settings/detail/linked235336/item85346/Download-PlayStation-3-Custom-Theme-Guidelines/ PS3 Custom Theme Toolbox]. At top is the help screen, then the default settings and a "patch" that belongs to the default settings and is named "PS3 OSD default settings" (this is actually overriding some default settings above), after that comes some input file formats definitions, after this point all the others are options (optionals literally, if you create a GIM without specifying special options none of this ones are used) up to the end of the file where appears a section related with scripting features
<div style="height:520px; overflow:auto">
{{Boxcode|content=<syntaxhighlight lang="c">
//================================================================
//================================================================
//  gimconv configuration
//  gimconv configuration
Line 288: Line 350:
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
</div>


The config file released with [[Rcomage]] have some default settings modifyed that are problematic for PS3 compatibility. For more info about the modifications made in the config file released with [[rcomage]] see the differences in the {{talk}} page
Note there are some modifications made officially by sony at a later version because GimComv was initially made for PSP (those initial GimComv versions compatibles with "PSP only" probably didnt had this PS3 specific settings), but this public release of GimConv was released as part of a toolkit to build PS3 themes so it has some settings specific for PS3


=GimConv.exe usage=
This group at top on the config file are default settings (for PS3) that overrides other default settings of an older version of GimComv (for PSP). They are overwriting default values because the same option is specifyed before in the file, so the last one overrrides the previous one with the same name (and also was added a new option named '''extend_edge''' that should be PS3 specific)
{{Boxcode|content=<syntaxhighlight lang="c">
//----------------------------------------------------------------
//  default settings
//----------------------------------------------------------------
 
//  PS3 OSD default settings


==Help screen==
format_endian = big // -B
The help screen of GimConv.exe displays a few options with an small explain about them, the example below belongs to the official GimConv.cfg with the options sony considered useful, this options are mostly useless for us, in short: interact doesnt allows to do special things, the merge modes are hardcore because are intended to create GIM files by some kind of artisan method where you create the GIM by using "pieces" from other files, the promt modes doesnt helps much, gimview.exe doesnt exists, the image resize methods should not be used (instead you should prepare your images with the correct size before converting them with GimConv.exe), the pixel formats normal/faster should not be used that way individually, and the options to swap rgba color channels are not needed for PS3
pixel_order = normal // -N
pixel_channel = default // -R
image_format = rgba8888 // --image_format rgba8888


{{Keyboard|content=<syntaxhighlight lang="bash">
extend_edge = off
C:\PS3_Custom_Theme_v200\GimConv>GimConv.exe
</syntaxhighlight>}}
gimconv ver 1.20h --- generic picture converter
Copyright (C) 2006 Sony Computer Entertainment Inc.
  All Rights Reserved.


usage:
This other group seems to be options for GIM formats used in PS3
        gimconv <input files> [options]
{{Boxcode|content=<syntaxhighlight lang="c">
//--------------------------------------------------------
//  PS3 OSD specific options
//--------------------------------------------------------


options:
option -B {
        -interact      input additional options
format_endian = big
        -pictures      merge files as pictures
}
        -frames        merge files as frames
        -levels        merge files as levels
        -prompt        prompt always
        -warning        prompt on warning
        -error          prompt on error
        -viewer        start gimview.exe when process ends
        -o <filename>  specify output file name
        -s <w,h>        resize image data
        -S              output text format
        -P              resize image data to a power of two
        -N              output in normal pixel storage format
        -F              output in faster pixel storage format
        -R              re-convert ( don't swap RGBA <-> ABGR )
</syntaxhighlight>}}


==Options==
option -X {
{{Boxtip1|content=To specify an option is needed to use '''a single dash''' with the name of the option.}}
pixel_channel = abgr
GimConv.exe allows to make a GIM-to-PNG conversion by specifying the file extension with the option '''-o''':
}
{{Keyboard|content=<syntaxhighlight lang="bash">gimconv.exe in.gim -o out.png</syntaxhighlight>}}


If you make a PNG-to-GIM conversion (or any of the supported input formats to GIM) without specifying any other option then are going to be loaded all the default settings of GimConv.cfg (from top to bottom) and this is not good because you dont have much control of the resulting GIM, most probably is going to generate a GIM file not compatible with PS3, at this point maybe you thought in creating a modifyed GimConv.cfg with all the default settings required by PS3 but this is not good enought either because there are (at least) 2 different GIM formats used in PS3 and you are going to break the compatbility with PSP, anyway here is the command as an usage example
option -R {
{{Keyboard|content=<syntaxhighlight lang="bash">gimconv.exe in.png -o out.gim</syntaxhighlight>}}
pixel_channel = default
}


The interesting options are located at middle of GimConv.exe and contains several settings, this is an example of an option that is overriding the most critical settings (is a bit pointless thought, because the settings are given the value "default")
{{Keyboard|content=<syntaxhighlight lang="bash">gimconv.exe in.png -o out.gim -DXT</syntaxhighlight>}}
The option '''-DXT''' used in this example contains 3 settings that are going to be loaded after the default settings (this is an example of the official GimConv.cfg, the one used inside rcomage is different):
{{Boxcode|code=<syntaxhighlight lang="c">
option -DXT {
option -DXT {
pixel_order = default
pixel_order = default
Line 340: Line 393:
image_format = default
image_format = default
}
}
</syntaxhighlight>}}


Another example where can be seen better how the options contains settings that overrides the default settings:
option -E {
{{Keyboard|content=<syntaxhighlight lang="bash">gimconv.exe in.gim -o out.gis -S</syntaxhighlight>}}
extend_edge = on
*The option '''-S''' contains this settings:
{{Boxcode|code=<syntaxhighlight lang="c">
option -S {
output_object = off
output_script = on
}
}
</syntaxhighlight>}}
</syntaxhighlight>}}
At top of GimConv.cfg (as part of the default settings) appears the settings: '''output_object''' with value '''on''' and '''output_script''' with value '''off''' (so by default gimconv.exe outputs a GIM and doesnt outputs a GIS). The option '''-S''' of this example is switching them (doesnt outputs a GIM but it outputs a GIS)


==Settings==
=How to identify GIM settings=
{{Boxtip1|content=To specify a setting is needed to use '''a double dash''' with the name of the setting.}}
 
This is the most accurate way to have full controll of the GIM settings, if you are picky you can write a long line of settings to override all the critical default settings (just incase the GimConv.cfg was modifyed by someone, by doing this you are overriding his/her changes made to the default settings). If you are writing an script or any tool that sends actions to gimconv.exe you should use this method
*GIM--->GIM method (prefered)
{{Keyboard|content=<syntaxhighlight lang="bash">gimconv.exe in.png -o out.gim --pixel_order normal --format_style psp --format_endian big</syntaxhighlight>}}
**Use gimconv with .gim files as input and output (this preserves dxt pixel info, because dxt images doesnt suffers a conversion)
The 3 settings in the example are overriding the default settings at top of GimConv.cfg (this is an example of the official GimConv.cfg, the one used inside rcomage is different):
{{Keyboard|content='''gimconv.exe test.gim -o test.gim --format_style psp --format_endian big --image_format dxt5 --pixel_channel default --pixel_alpha default'''}}
{{Boxcode|code=<syntaxhighlight lang="c">
 
//----------------------------------------------------------------
*GIM--->PNG--->GIM method (fails when there is involved a DXT conversion because DXT conversions are lossy, works fine for rgba**** image formats):
// default settings
**Use rcomagegui to make an extraction of the contents '''without''' conversion of images (this way the GIM are extracted as GIM)
//----------------------------------------------------------------
**Use rcomagegui to make another extraction of the contents '''with''' conversion of images (this way the GIM are extracted as PNG)
pixel_order = default // default normal faster
**Use gimconv to convert a PNG ---to---> GIM by the old method of test-error by trying some of the options availables that appears in gimonv.cfg
format_style = psp // std psp ps3
**Use a hexeditor to compare the original GIM extracted in step 1 with the rebuilt GIM from your test, there is no need to make accurate comparisons, just an overview of the first 0x80 bytes of the header, and how the pixel data is ordered starting at offset 0x80
format_endian = little // little big
**When the header and pixel data seems similar make a hash comparison, original GIM and rebuild GIM should be exactly the same hash (is posible to create a GIM exactly like the original)
</syntaxhighlight>}}
 
=GIM formats used in PS3=
PS3 uses at least 2 types of GIM images, both included inside rco's, and in some cases both types in the same rco
 
When an .RCO contains 2 or more images that was created with different .GIM settings... it means is not posible to compile the .RCO with rcomage by using .PNG images as source (because rcomage.exe sends the GIM settings to gimconv.exe to make the PNG--->GIM image conversion and this settings are applyed to all PNG images)
 
In other words, the only way to compile this RCO's is in 2 steps. In the first step is needed to make the different .GIM conversions with gimconv.exe (and all the other conversions in case exists .VAG audio a WAV2VAG conversion or a JS2VSMX for the .VSMX script). In the second step is needed to compile the .RCO with rcomage.exe by using the .GIM's .VAG's and .VSMX's as sources without any kind of file conversions
 
Also means we have a big problem to document in wiki wich settings are used for each image (there are thousands of images so initially seems not posible), but probably they follows a rule, so the solution is to deduce or imagine the real reason of why the ps3 is using different gim formats inside the .rco's
 
{| class="wikitable"
|-
! image group or rco !! gim settings !! notes
|-
| '''ps3bpp32''' || --format_style psp --format_endian big --image_format rgba8888 --pixel_order normal || Most used GIM format inside .rco's
|-
| '''ps3dxt5''' || --format_style psp --format_endian big --image_format dxt5 || Second most used GIM format inside rco's
|}
 
'''Notes about [[explore_plugin]]_full.rco from firmware 4.70''':
*There are 245 images
**201 was created by using options: ''--format_style psp --format_endian big --image_format rgba8888 --pixel_order normal'' (exact match of gims after rebuilding gim--->png--->gim)
**030 was created by using options: ''--format_style psp --format_endian big --image_format rgba8888 --pixel_order normal --update_fileinfo on'' (exact match of gims after removing footer from originals and rebuilding gim--->png--->gim)
**014 was created by using options: ''--format_style psp --format_endian big --image_format dxt5'' (exact match of gims after rebuilding gim--->gim)
***item_tex_trophy.gim, trophy_tex_grade_bronze.gim, trophy_tex_grade_gold.gim, trophy_tex_grade_hidden.gim, trophy_tex_grade_platinum.gim, trophy_tex_grade_silver.gim, item_tex_CardBallon.gim, item_tex_Profile_Game.gim, item_tex_Profile_Highlight.gim, item_tex_Profile_Onlines.gim, tex_indi_Me.gim, tex_sb_base.gim, tex_sb_base_s.gim, tex_sb_slider.gim
 
This is the footer of item_tex_cam_icon.gim (was added to the gim by enabling '''update_fileinfo''' option, variable size)
'''Offset(h) 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F'''
00006AD0  00 FF 00 00 00 00 00 4C 00 00 00 4C 00 00 00 10  .ÿ.....L...L....
00006AE0  53 70 61 6E 61 2E 74 67 61 00 73 30 30 30 39 33  Spana.tga.s00093
00006AF0  37 00 53 75 6E 20 41 70 72 20 32 33 20 31 38 3A  7.Sun Apr 23 18:
00006B00  33 39 3A 34 38 20 32 30 30 36 00 47 69 6D 43 6F  39:48 2006.GimCo
00006B10  6E 76 20 31 2E 32 30 65 00 00 00 00              nv 1.20e....
 
And this is the footer of a rebuild gim where the footer was added in the rebuild process
'''Offset(h) 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F'''
  00002300  00 FF 00 00 00 00 00 54 00 00 00 54 00 00 00 10  .ÿ.....T...T....
00002310  74 65 78 5F 70 73 6E 2E 70 6E 67 00 41 64 6D 69  tex_psn.png.Admi
00002320  6E 69 73 74 72 61 64 6F 72 00 53 61 74 20 4D 61  nistrador.Sat Ma
00002330  72 20 30 37 20 30 31 3A 33 32 3A 30 31 20 32 30  r 07 01:32:01 20
00002340  31 35 00 47 69 6D 43 6F 6E 76 20 31 2E 32 30 68  15.GimConv 1.20h
00002350  00 00 00 00                                      ....


==Cumulative options and settings==
It seems the reason why this images are slighty different is because are ancient (has not been updated lot of firmwares ago, and uses the format from the first firmwares)
{{Boxtip1|content=Reminder: options are passed with '''a single dash''' and settings with a '''double dash'''}}
This is the official way, the predefined options of the official GimConv.cfg are intended to be used together with other options, this way you can have an option containing a group of settings (that are common for a console) and several other options for the different GIM formats supported in that console, using GimConv.exe this way is a bit more confusing though and makes harder to pass commands to it, but is very handy to make tests
{{Keyboard|content=<syntaxhighlight lang="bash">gimconv.exe in.png -o out.gim -DXT --pixel_channel brag</syntaxhighlight>}}
The command in the example is loading the option '''-DXT''' like in the example above, but additionally is overriding one of the settings inside '''-DXT''' with the '''--pixel_channel brag''' to reorder the color channels (from left to right, BLUE, RED, ALPHA, GREEN), the resulting GIM is going to be like the one made in the example above, the only difference is the location of the pixel colors


It allows to cummulate many options and settings <abbr title="the rule to remember is... the last setting overrides the previous ones with the same name">in any order</abbr> (be careful this could create some problems) to do something like this:
As interesting details, in the footer of original files it can be seen the name and format of the original image (.tga), the windows user name, timestamp (from 2006), an the version of GimConv (an old 1.20e)
{{Keyboard|content=<syntaxhighlight lang="bash">gimconv.exe in.png -o out.gis -DXT --pixel_channel brag -S</syntaxhighlight>}}


==From rcomage==
The '''00 00 00 4C''' (repeated 2 times) at top of the footer in the original gim example is the size of the whole footer (usefull to make the calculation to remove the footer and update the filesize at gim header)
{{Boxwarning1|content='''Dont use this method for PS3'''. GIM files from PS3 firmware uses (at least) 2 different GIM formats, rcomage applyes the same settings for all the GIM files so some are broken}}
This ones are rcomage commands that includes gimconv commands in between quotes, are optional and are intended to change the default GIM settings used by rcomage when doing the PNG-to-GIM conversions. Rcomage.exe sends the GIM settings to gimconv.exe when is compiling the RCO (see the "compile" help in [[rcomage]] page). There are 2 options in rcomage specific for this task, named: '''--gimconv-cmd''' and '''--gimconv-flags'''
{{Keyboard|content=<syntaxhighlight lang="bash">rcomage.exe compile in.xml out.rco --gimconv-cmd ".\gimconv\gimconv.exe" --gimconv-flags "--pixel_order normal --format_style psp --format_endian big"</syntaxhighlight>}}


As mentioned [http://endlessparadigm.com/forum/showthread.php?tid=19501&pid=350611#pid350611 here] inside RCO files from PS3 official firmwares there are (at least) 2 types of GIM formats, and usually both are used inside the same RCO, as example... an RCO with a total of 14 GIM files where 12 of them was made using some GIM settings, and the other 2 with different GIM settings, for this reason is needed to identify the GIM settings and rebuild every GIM file individually
==Custom Options==
The configuration file allows to modify the ''help'' screen of the command line by adding custom labels, or by removing useless options to make room for more custom labels, this labels can be composed of groups of options, there is no need at all to do this because doesnt really enables any new funcionallity as you can specify all the options you need one by one from command line included the hability to override default values, but is good to keep a record of the most common used formats for a console by using custom labels with intuitive names that defines the GIM format


Is not posible to compile a PS3 RCO with rcomage by using PNG images as source (either way, using the commands in the example above or not using them, the problem is the same) because the GIM settings sent by rcomage are applyed to all the PNG images, so all the GIM files in the RCO will have the same GIM settings, '''this doesnt works for PS3 GIM files !'''
The config file supplyed by [[Rcomage]] contains some custom options for the formats that are used in PSP, some changes in the default settings that was common for PSP (included a size limit that breaks compatibility with PS3), and a group of options was added for PS3 (labeled '''-ps3''') but this group seems to use wrong options. For more info about the modifications made in the config file supplyed with [[rcomage]] see the differences in the {{talk}} page
{{How to rebuild a PS3 RCO with custom GIM images using Rcomage and GimConv}}


=GimConv.cfg options for PS3=
This wiki section proposes new groups of options with new label names (to be able to use a new modifyed config file without breaking the compatibility of other tools that uses rcomage as a dependency)
You can modify the GimConv.cfg file by adding some options (with custom names) containing any settings, by doing this you can keep a record of the correct settings for some GIM formats and group lot of settings under a single option, additionally when using GimConv.exe from command line the commands will be much shorter. This wiki section proposes a couple of options (but probably PS3 supports a lot more) that have been tested and are the first and second most commonlly used in PS3 official firmwares


*'''1st most common''' GIM format used in official PS3 firmwares
*Inside [[explore_plugin]]_full.rco from firmware 4.70 there are 245 images, 201 of them (included the new icon tex_psn.gim) has been made by using this options:
{{Boxcode|code=<syntaxhighlight lang="c">
{{Boxcode|content=<syntaxhighlight lang="c">
option -ps3rgba8888 {
option -ps3bpp32 {
format_style = psp
format_endian = big
format_endian = big
format_style = psp
pixel_order = normal
pixel_alpha = default
pixel_channel = default
image_format = rgba8888
image_format = rgba8888
pixel_order = normal
pixel_channel = rgba
limit_image_width = 4096
limit_image_width = 4096
limit_image_height = 4096
limit_image_height = 4096
Line 402: Line 483:
</syntaxhighlight>}}
</syntaxhighlight>}}


*'''2nd most common''' GIM format used in official PS3 firmwares
*Inside [[explore_plugin]]_full.rco from firmware 4.70 there are 245 images, 14 of them has been made by using this options:
{{Boxcode|code=<syntaxhighlight lang="c">
{{Boxcode|content=<syntaxhighlight lang="c">
option -ps3dxt5 {
option -ps3dxt5 {
format_style = psp
format_endian = big
format_endian = big
format_style = psp
image_format = dxt5
pixel_order = normal
pixel_order = normal
pixel_alpha = default
pixel_channel = default
pixel_channel = default
image_format = dxt5
limit_image_width = 4096
limit_image_width = 4096
limit_image_height = 4096
limit_image_height = 4096
Line 415: Line 497:
</syntaxhighlight>}}
</syntaxhighlight>}}


=How to identify GIM settings=
==Variants==
The goal is to identify the GimConv settings that was used when the original GIM file was created, there are basically two ways to identify GIM settings, by reading the GIM structure, or by bruteforce
This is just a variant shown here for curiosity sake, because this is what sony did exactly for some (old) GIM files that are still present in modern PS3 firmwares, it seems never was updated, the only difference with what is written above is i added the option '''update_fileinfo''' that adds a footer at the botom of the GIM files. In this footer you can see the name of the user account of the microsoft windows OS where the GIM was created (funny stuff), a timestamp (usually around 2006), the original file name and format (usually a TGA with weird names), etc... To make a custom RCO you dont need to add this footer (so dont create GIM files with this option), if you do open the GIM file in a hexeditor and look at the footer how it was added info from your PC


Both identification methods can be made manually or by using external code, and are not exclusive. For code performance reading the GIM structure is faster, but for accuracy the bruteforce method is 100% accurate, so a code could start reading "what we know" from the GIM structure and then start with the bruteforce to get the confirmation
*Inside [[explore_plugin]]_full.rco from firmware 4.70 there are 245 images, 30 of them has been made by using this options:
 
{{Boxcode|content=<syntaxhighlight lang="c">
==Identifying GIM settings by reading GIM structure==
option -ps3old {
GIM format is not completly documented, allows for lot of features that generates different GIM structures, at this point is not posible to identify all this GIM formats, for more info see: [[Graphic Image Map (GIM)]]
format_style = psp
*The most important settings needed to collect from the original GIM file are:
format_endian = big
**'''format_endian''' (offset 0 in the GIM)
pixel_order = normal
**'''format_style'''  (offset 8 in the GIM)
pixel_alpha = default
**'''image_format''' (offset 4 at block 4 in the GIM)
pixel_channel = default
**'''pixel_order''' (offset 6 at block 4 in the GIM)
image_format = rgba8888
 
limit_image_width = 4096
*Some notes:
limit_image_height = 4096
**GIM files using image formats with indexed colors have an additional block 5, and block 4 is displaced
update_fileinfo = on
**The list of settings mentioned above will work '''only''' if the GIM contains a single image/level/frame, otherway the GIM structure becomes more complex
}
**There are 4 unknown fields in GIM structure, and it seems GIM was used in other unknown sony devices or tools, so dont take this as something general, is just an approach focused in PS3 and PSP
</syntaxhighlight>}}


For this reasons, identifying GIM settings by reading GIM structure is not 100% accurate (there are too much unknown features and room for errors), the way to identify GIM settings more accuratelly is the next method explained... by bruteforce
==Speculation==
Initially... it seems the gim format depends of who is the responsible of displaying them (as an example, in the link above it seems the images reported as "rare" belongs to "tex_indi_***" (are textures for the "indicator", is the information bar at top-right of xmb, are the tiny icons that appears eventually when you receive a message, etc..)


==Identifying GIM settings by bruteforce==
<strike>Note is posible to group them based in how his names starts, all "tex_indi" belongs to indicator so should share the same gim format, even if there are more "tex_indi" inside other rco's, doesnt matters in wich .rco are located what matters is his purpose is the same (to be displayed inside the indicator)</strike> This assumption seems wrong
{{Boxinfo1|content='''GIM-to-GIM''' is the only conversion method that is '''[https://en.wikipedia.org/wiki/Lossless_compression lossless]''' for all image formats supported by GimConv.exe}}
The word [https://en.wikipedia.org/wiki/Brute-force_search bruteforce] sounds a bit ridiculous when used to identify image settings but defines pretty well how this identification method works. Consist in rebuilding the original GIM file several times by using different GimConv settings until we generate a GIM file identical to the original. In other words... if you find how to create a GIM file exactly like the original you can be 100% sure the GIM settings you are using are exactly the same used by sony to create that GIM
 
The only way to create a GIM file exactly like the original (that works with all image formats) is by making a GIM-to-GIM conversion, GimConv rebuilds the file when doing a GIM-to-GIM conversion and in the conversion is preserved the pixel data of dxt based image formats, otherway if the GIM image is dxt based and you try to convert it to other format (such PNG) and back to dxt it will never be like the original because dxt conversions are [https://en.wikipedia.org/wiki/Lossy_data_conversion lossy]
 
For bruteforce is used a "dictionary" that contains the posible "candidates" to solve the "problem", our dictionary (with the GIM formats found in PS3) only contains 3 candidates, this means in the worst scenario is need to rebuild the GIM file a max of 3 times. If none of the 3 GIM files matches with the original we have a problem (please report back and we will add the rare format to this wiki page)
 
'''1st most common'''
{{Keyboard|content=<syntaxhighlight lang="bash">gimconv.exe original.gim -o try1.gim -ps3rgba8888</syntaxhighlight>}}
'''2nd most common''' (this is a variant of the previous with <abbr title="the block contains info related with the GIM creation and a version usually 'GimConv 1.20e' in retail PS3 firmwares, when you run this command the original block data is preserved but the version is updated">a block added at the end of the file</abbr>)
{{Keyboard|content=<syntaxhighlight lang="bash">gimconv.exe original.gim -o try2.gim -ps3rgba8888 --update_fileinfo on</syntaxhighlight>}}
'''3rd most common'''
{{Keyboard|content=<syntaxhighlight lang="bash">gimconv.exe original.gim -o try3.gim -dxt5</syntaxhighlight>}}
 
After every GIM-to-GIM conversion is needed to compare the hashes, first "original.gim VS try1.gim", then "original.gim VS try2.gim", then "original.gim VS try3.gim"
 
===GimConv.exe version patch===
The reason to use this patch is because by enabling the setting '''--update_fileinfo on''' is added a block of data (named "fileinfo" with block id 0x00FF) at bottom of the GIM file, in a GIM-to-GIM conversion this block of data (from the original.gim) is preserved (added in the rebuild GIM file) but the GimConv version included at the end of this block is updated. The GimConv versions in the original PS3 retail GIM files are '''GimConv 1.20e''' and when you do the GIM-to-GIM conversion it changes to '''GimConv 1.20h''', the difference is a single byte but doesnt allows to create a GIM file identical to the original (the hash check fails, and this sucks). If you are using some external code you can modify this byte by other means (so you dont need to use this patch for GimConv.exe) but for normal usage of GimConv.exe in command line this patch is handy because it allows to create identical GIM files
 
GimConv.exe v1.20h original (MD5:425B2E4D9684BCE1FC79A37247618AC8)
At offset 0x91E4 replace 0x68 by 0x65 (character 'h' by character 'e')
At offset 0x91F8 replace 0x68 by 0x65 (character 'h' by character 'e')
GimConv.exe v1.20h patched to v1.20e (MD5:6C9B0E47273EFA6D34121A46E65EEDC6)
 
As far i know all the GIM files from PS3 retail firmwares that was created using '''--update_fileinfo on''' was build with GimConv.exe v1.20'''e''', and the patch changes the GimConv.exe version from v1.20'''h''' (the public GimConv.exe) by v1.20'''e''' (the internal GimConv.exe not available for us), so it should work for most GIM files... if at some point someone finds other GIM files that was made with other GimConv.exe versions (c, d, f, g) and you want to use this bruteforce identification process you can make others GimConv.exe patched with different versions and rename them to GimConvC.exe, GimConvD.exe, GimConvE.exe, GimConvF.exe, GimConvG.exe etc... and keep all them in the same folder next to the original v1.20h
 
==Examples==
*In [[explore_plugin]]_full.rco from firmware 4.70 there are 245 images:
**201 was created by using settings: ''--format_style psp --format_endian big --image_format rgba8888 --pixel_order normal'' (exact match of gims after rebuilding gim--->png--->gim), such tex_psn.gim
**030 was created by using settings: ''--format_style psp --format_endian big --image_format rgba8888 --pixel_order normal --update_fileinfo on'' (exact match of gims after removing footer from originals and rebuilding gim--->png--->gim), see: [[Graphic_Image_Map_(GIM)#0xFF_.28Fileinfo.29|fileinfo]]:
**014 was created by using settings: ''--format_style psp --format_endian big --image_format dxt5'' (exact match of gims after rebuilding gim--->gim)
***item_tex_trophy.gim, trophy_tex_grade_bronze.gim, trophy_tex_grade_gold.gim, trophy_tex_grade_hidden.gim, trophy_tex_grade_platinum.gim, trophy_tex_grade_silver.gim, item_tex_CardBallon.gim, item_tex_Profile_Game.gim, item_tex_Profile_Highlight.gim, item_tex_Profile_Onlines.gim, tex_indi_Me.gim, tex_sb_base.gim, tex_sb_base_s.gim, tex_sb_slider.gim
 
<!--
{| class="wikitable"
|-
! image group or rco !! gim settings !! notes
|-
| '''ps3rgba8888''' || --format_style psp --format_endian big --image_format rgba8888 --pixel_order normal || Most used GIM format inside .rco's
|-
| '''ps3dxt5''' || --format_style psp --format_endian big --image_format dxt5 || Second most used GIM format inside rco's
|}
-->


<!--
*This ones are perfect candidates to use for examples of how to find the correct GIM settings, all them located inside '''[[explore_plugin]]_full.rco'''
**'''item_tex_NewUser.gim''' (rgba8888 without fileinfo)
**'''item_tex_NewFriend.gim''' (rgba8888 with fileinfo)
**'''item_tex_trophy.gim''' (dxt5 without fileinfo)
-->
{{File Formats}}
{{File Formats}}
<noinclude>[[Category:Main]]</noinclude>
<noinclude>[[Category:Main]]</noinclude>
Please note that all contributions to PS3 Developer wiki are considered to be released under the GNU Free Documentation License 1.2 (see PS3 Developer wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following hCaptcha:

Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "http://www.psdevwiki.com/ps3/GimConv"