Gif player #2833

MobinYengejehi · 2022-12-16T09:33:00Z

hi
i made a gif player which load and play gifs as fast as possible
you can create a gif like:

local gif = gifCreate(file_path or gif_buffer) -- "logo.gif" for example

local size = Vector2(dxGetMaterialSize(gif))

addEventHandler("onClientRender",getRootElement(),function()
    if isElement(gif) then
        dxDrawImage(0,0,size,gif)
    end
end)

cuz it is a texture element you can use it, inside shaders or inside all dx related functions

patrikjuvonen · 2022-12-16T10:12:12Z

Thanks for the pull request! Cool idea!

I'm wondering if there is an open source Gif loader library out there that we could use instead of implementing the intricacies ourselves, thinking from a future maintainability and security perspective.

tederis · 2022-12-16T10:14:01Z

Great. But I think you should use the new Lua parser.

MobinYengejehi · 2022-12-16T10:16:35Z

Thanks for the pull request! Cool idea!

I'm wondering if there is an open source Gif loader library out there that we could use instead of implementing the intricacies ourselves, thinking from a future maintainability and security perspective.

yeah we can
i just used https://github.com/hidefromkgb/gif_load and made it a little better because it needed some changes. you can go and see the real code. it is from @hidefromkgb
i thought that we must write code like this
this is my first time trying to contribute mta-blue

Client/mods/deathmatch/logic/CClientGifDisplay.cpp

Client/mods/deathmatch/logic/CClientRenderElementManager.h

Client/sdk/core/CRenderItemManagerInterface.h

Client/mods/deathmatch/logic/luadefs/CLuaGifDefs.cpp

Client/mods/deathmatch/logic/CClientGif.cpp

Client/mods/deathmatch/logic/CClientGif.h

Client/mods/deathmatch/logic/CClientGif.cpp

Client/mods/deathmatch/logic/CClientGif.h

lopezloo · 2023-07-09T15:14:33Z

Do we really need this?

CrosRoad95 · 2023-07-09T15:18:08Z

Do we really need this?

actualy, no. If you for example want to have gif in mta, i bet there is a program that can turn it into atlas texture with every frame.
If you want to have dynamic gifs, let's say gif avatars then use for example: https://www.npmjs.com/package/gif-to-png

dmi7ry · 2023-07-10T15:48:34Z

Do we really need this?

actualy, no. If you for example want to have gif in mta, i bet there is a program that can turn it into atlas texture with every frame. If you want to have dynamic gifs, let's say gif avatars then use for example: https://www.npmjs.com/package/gif-to-png

Keep in mind that GIF is not just a collection of pictures displayed one after the other. GIF allows you to set pauses between frames and other things. If such GIF is directly converted to a png set, then the size of the textures will be much MUCH larger.
And to avoid this, you still have to write a sequencer that will take into account all the pauses between frames, etc. I think that this will be somewhat difficult for many developers.

CrosRoad95 · 2023-07-10T16:01:38Z

take into account all the pauses between frames, etc.

Probably along with frames you can use some tool to extract metadata.

dmi7ry · 2023-07-10T18:42:55Z

take into account all the pauses between frames, etc.
Probably along with frames you can use some tool to extract metadata.

Me personally prefer to use Rive and Spine. But how about not very experienced deveopers? Of course this means that just no one will use animations, and therefore the interfaces will look less interesting than they could be.

MobinYengejehi · 2023-07-22T19:42:54Z

Do we really need this?

actualy, no. If you for example want to have gif in mta, i bet there is a program that can turn it into atlas texture with every frame. If you want to have dynamic gifs, let's say gif avatars then use for example: https://www.npmjs.com/package/gif-to-png

well then you won't be able to use shaders to control the texture pixels
this feature is not that important cuz developers can use browsers which is much better
but my experience says CEF sometimes doesn't work properly on weak cpus
actually it happened to me multiple times and it wasn't only me who experienced that
mta created browser and also onClientBrowserCreated event was triggered but my display was empty
it seemed like cef didn't change browser texture pixels and all of those was 0x00000000
so i decided to contribute mta and add this feature that is fast and allows developers save some frames inside a gif and use that frames the way they want
and also because this gif element is a dx texture developers can use shaders for it and also apply this shaders on models
for example animated labels on vehicles or something like that
and the way to use it is like this:

local gif = gifCreate("label.gif");

local shader = dxCreateShader("shader.fx");
assert(shader, "couldn't create the shader!");

dxSetShaderValue(shader, "gif", gif);

addCommandHandler("startanim", function()
    gifPlay(gif);
);

addCommandHandler("stopanim", function()
    gifStop(gif);
end);

addCommandHandler("setlabel", function()
    -- engineApplyShaderToWorldTexture ...
end);

texture gif;
sampler2D gifSampler{
    Texture = gif;
};

float4 pixels(float2 coords : TEXCOORD0) : COLOR0 {
    // and for example i want to remove green background here
    float4 color = tex2D(gifSampler, coords);
    
    if (color == float4(0, 1, 0, 1)) {
        return (float4)0;
    }
    
    return color;
}

technique Render{
    pass p0 {
        PixelShader = compile ps_2_a pixels();
    }
}

this feature has less fps drop than the render target or other possible methods
with this api also the clients who use weak systems can experience this animated labels on their vehicles

PlatinMTA · 2023-07-23T07:11:17Z

The shader idea is kinda cool, I can see myself using it. I would use it to display some forum avatars aswell.

this feature has less fps drop than the render target or other possible methods
Just out of curiosity, do you have some benchmarks about that? Just having the easy implementation is enough, but having it be faster is a no brainer if you need to use .gifs.

MobinYengejehi · 2023-07-25T10:04:43Z

The shader idea is kinda cool, I can see myself using it. I would use it to display some forum avatars aswell.

this feature has less fps drop than the render target or other possible methods Just out of curiosity, do you have some benchmarks about that? Just having the easy implementation is enough, but having it be faster is a no brainer if you need to use .gifs.

actually i was thinking about playing videos on mta client
i know we can play videos or other medias with CEF
but as i mentioned mta sometimes can't load browser textures
so i decided to somehow create my own library to load videos but i knew lua isn't that fast that i can load my webm buffer and display it on screen
i thought maybe if we had some features in mta that we could allocate memory to save frames and use them can help me.
at first i used textures for that
when i tested it, it took 30 seconds to load only 50 frames and after all frames loaded when i displayed them on screen it was using 8% of my cpu
and most important thing was that creating the texture occupied the memory of graphic card
so i thought if i create only one texture and allocate some bytes from computer memory to save my frames and send that bytes to graphic card memory this can fix my problem (and this is exactly what this gif player does)
then i came up with this gif player idea and decided to make it and ask mta team if they like my idea add it to the launcher
when i used gif player to load my webm frames, it took less than 100 ms to load more than 700 frames and on display, it was
only using something like 0.5% of my cpu
and you can control your player to display frames with gifSetProperty and gifGetProperty functions

new functions:
gifGetProperty(element [gif (dx material)], [int (frame index)] string [property]);
gifSetProperty(element [gif (dx material)], [int (frame index)] string [property], string or number [value]);
gif get properties:
Frame:

delay : gets the frame delay
default_delay : gets the frame default delay

Global:

showing_frame : gets the showing frame
frame_count : gets the loaded frames count
format : gets the gif format GIF89a or GIF87a
tick : gets last updated tick

gif set properties:
Frame:

delay : sets frame delay

Global:

showing_frame : sets showing frame

you know i don't want to open another application in my computers background and create other vm s to display a simple gif

tederis · 2025-05-31T08:36:09Z

@MobinYengejehi Please, resolve the conflicts.

MobinYengejehi · 2025-07-15T08:03:46Z

@tederis conflicts have been resolved

FileEX

The code generally looks very messy. There are missing line breaks, everything is stacked together, and inside functions there are definitions and structures inserted. It all looks very untidy and needs cleaning up for better readability.

It might be worth reviewing the guidelines:
https://github.com/multitheftauto/mtasa-docs/blob/main/mtasa-blue/CODING_GUIDELINES.md

FileEX · 2025-08-13T18:17:57Z

Client/mods/deathmatch/logic/CClientRenderElementManager.h

@@ -36,6 +37,7 @@ class CClientRenderElementManager
    CClientScreenSource*  CreateScreenSource(uint uiSizeX, uint uiSizeY);
    CClientWebBrowser*    CreateWebBrowser(uint uiSizeX, uint uiSizeY, bool bIsLocal, bool bTransparent);
    CClientVectorGraphic* CreateVectorGraphic(uint width, uint height);
+    CClientGif*           CreateGif(uint width, uint height);


uint -> std::uint32_t

FileEX · 2025-08-13T18:18:17Z

Client/mods/deathmatch/logic/CClientRenderElementManager.h

@@ -47,6 +49,7 @@ class CClientRenderElementManager
    uint GetScreenSourceCount() { return m_uiStatsScreenSourceCount; }
    uint GetWebBrowserCount() { return m_uiStatsWebBrowserCount; }
    uint GetVectorGraphicCount() { return m_uiStatsVectorGraphicCount; }
+    uint GetGifCount() { return m_uiStatsGifCount; }


uint -> std::uint32_t

FileEX · 2025-08-13T18:19:39Z

Client/mods/deathmatch/logic/CClientRenderElementManager.cpp

+CClientGif* CClientRenderElementManager::CreateGif(uint width, uint height)
+{
+    // Create the item
+    CGifItem* pGifItem = m_pRenderItemManager->CreateGif(width, height);


We no longer use Hungarian notation.

pGifItem -> gifItem

FileEX · 2025-08-13T18:19:51Z

Client/mods/deathmatch/logic/CClientRenderElementManager.cpp

+    {
+        return nullptr;
+    }


You can remove braces here

FileEX · 2025-08-13T18:20:03Z

Client/mods/deathmatch/logic/CClientGifDisplay.h

+    CClientGif* m_pGif;
+    bool        m_bIsCleared;


We no longer use Hungarian notation.

FileEX · 2025-08-13T18:23:46Z

Client/mods/deathmatch/logic/CClientGif.h

+    uint8_t* GetBuffer() { return m_pBuffer; }
+    long&    GetWidth() { return m_lgWidth; }
+    long&    GetHeight() { return m_lgHeight; }
+    long&    GetDelay() { return m_lgDelay; }
+    long&    GetFrameNumber() { return m_lgFrameNumber; }
+    long&    GetFrameCount() { return m_uiFrameCount; }
+    SString  GetFormat() { return m_strFormat; }


const + noexcept

FileEX · 2025-08-13T18:23:55Z

Client/mods/deathmatch/logic/CClientGif.h

+public:
+    CClientGifLoader() = default;
+    CClientGifLoader(SString& data);
+    CClientGifLoader(uint8_t* data, unsigned long dataSize);


std::uint8_t

FileEX · 2025-08-13T18:24:04Z

Client/mods/deathmatch/logic/CClientGif.h

+    uint left = 0;
+    uint top = 0;
+    uint width = 0;
+    uint height = 0;


std::uint32_t

FileEX · 2025-08-13T18:25:01Z

Client/core/Graphics/CRenderItemManager.h

@@ -34,6 +34,7 @@ class CRenderItemManager : public CRenderItemManagerInterface
                                                   bool bForce = false);
    virtual CScreenSourceItem*  CreateScreenSource(uint uiSizeX, uint uiSizeY);
    virtual CVectorGraphicItem* CreateVectorGraphic(uint width, uint height);
+    virtual CGifItem*           CreateGif(uint width,uint height);


std::uint32_t

FileEX · 2025-08-13T18:25:35Z

Client/core/Graphics/CRenderItem.Gif.cpp

+// Check underlying data is present
+//
+////////////////////////////////////////////////////////////////
+bool CGifItem::IsValid()


const + noexcept?

MobinYengejehi added 17 commits December 16, 2022 12:16

Add new display type DISPLAY_GIF

c259f7d

Add Gif entity class

e762bf2

Load Gif functions on startup

562b87f

Load Gif class on startup

45c77e0

Add Gif class type name

a363cae

Create CLuaGifDefs.h

66c7f7b

Create CLuaGifDefs.cpp

5af7c4c

Create CClientGif.h

3f33535

Create CClientGif.cpp

ce4fcd2

Create CClientGifDisplay.h

56399ae

Create CClientGifDisplay.cpp

304b7cd

Add CreateGif function

ea85709

Add CreateGif function

4f21b9a

Add Gif render item

494e4ba

Create CRenderItem.Gif.cpp

595f40e

Add Gif render item creator

6cedb9f

Add Gif render item creator

9915258

patrikjuvonen added the enhancement New feature or request label Dec 16, 2022

tederis reviewed Dec 16, 2022

View reviewed changes

MobinYengejehi added 6 commits December 16, 2022 14:28

check if rect locked to surface

564029b

Erase GetTickCount64 and add it inside constructor

6ed1853

Update tick inside constructor

0c6a575

Change CClientGif::Register definition

c11b623

Change CClientGif::Register definition

39ca727

Move frames and delays instead of copying them

1998dab

tederis reviewed Dec 16, 2022

View reviewed changes

Client/mods/deathmatch/logic/CClientGif.cpp Outdated Show resolved Hide resolved

Client/mods/deathmatch/logic/CClientGif.h Outdated Show resolved Hide resolved

Use move inside Gif_Register for frames and delays

c661315

MobinYengejehi added 6 commits May 2, 2023 15:41

Merge branch 'master' into gifPlayer

19fe68b

Merge branch 'master' into gifPlayer

0e2d293

Merge branch 'master' into gifPlayer

58f761d

Merge branch 'master' into gifPlayer

fd6aebc

Merge branch 'master' into gifPlayer

2880a32

Merge branch 'master' into gifPlayer

1079d1b

Merge branch 'master' into gifPlayer

80d0947

MobinYengejehi added 4 commits April 24, 2024 03:04

Merge branch 'master' into gifPlayer

62e8d31

Merge branch 'master' into gifPlayer

582a5d5

Merge branch 'master' into gifPlayer

03978e1

Merge branch 'master' into gifPlayer

7c3739e

Merge branch 'master' into gifPlayer

fac8abe

MobinYengejehi added 5 commits July 16, 2025 17:11

Merge branch 'master' into gifPlayer

29d8a94

Merge branch 'master' into gifPlayer

49329f9

Merge branch 'master' into gifPlayer

ff2cf29

Merge branch 'master' into gifPlayer

3caec27

Merge branch 'master' into gifPlayer

48c590c

FileEX requested changes Aug 13, 2025

View reviewed changes

Merge branch 'master' into gifPlayer

10c1983

MobinYengejehi requested a review from FileEX August 27, 2025 13:31

Uh oh!

Gif player #2833

Are you sure you want to change the base?

Gif player #2833

Uh oh!

Conversation

MobinYengejehi commented Dec 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

patrikjuvonen commented Dec 16, 2022

Uh oh!

tederis commented Dec 16, 2022

Uh oh!

MobinYengejehi commented Dec 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lopezloo commented Jul 9, 2023

Uh oh!

CrosRoad95 commented Jul 9, 2023

Uh oh!

dmi7ry commented Jul 10, 2023

Uh oh!

CrosRoad95 commented Jul 10, 2023

Uh oh!

dmi7ry commented Jul 10, 2023

Uh oh!

MobinYengejehi commented Jul 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PlatinMTA commented Jul 23, 2023

Uh oh!

MobinYengejehi commented Jul 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tederis commented May 31, 2025

Uh oh!

MobinYengejehi commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FileEX left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MobinYengejehi commented Dec 16, 2022 •

edited

Loading

MobinYengejehi commented Dec 16, 2022 •

edited

Loading

MobinYengejehi commented Jul 22, 2023 •

edited

Loading

MobinYengejehi commented Jul 25, 2023 •

edited

Loading

MobinYengejehi commented Jul 15, 2025 •

edited

Loading