[RytoEX]

Description

Update libnsgif to from some ancient version to 1.0.0.

Motivation and Context

Wanted to attempt to update this while tackling #10993.

How Has This Been Tested?

Tested on Windows 11 with an animated GIF.

Types of changes

• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My code has been run through clang-format.
• I have read the contributing document.
• My code is not on the master branch.
• The code has been tested.
• All commit messages are properly formatted and commits squashed where appropriate.
• I have included updates to all appropriate documentation.

[RytoEX]

This could use further review, particularly on the struct changes, but generally on everything because I've never had to touch these files before.

This could also use further testing.

[RytoEX]

Fixing clang-format complaint, hopefully.

[Lain-B]

Would be nice to get this moved over to the deps dir but I don't think that it's a big deal for now, especially if we want to fix up issues for the next update.

[norihiro]

I'd like to note that this breaks the ABI for 3rd party plugins using struct gs_image_file.

• https://github.com/rogueyoshi/input-overlay/blob/f30f6450067227ca438fe7322e1991aed9d95b73/projects/plugin/src/util/element/element.hpp#L26
  https://github.com/rogueyoshi/input-overlay/blob/f30f6450067227ca438fe7322e1991aed9d95b73/projects/plugin/src/util/overlay.cpp#L136
• https://github.com/norihiro/obs-color-monitor/blob/a2f8bb7cbccd0994efe10d8d8361c3b2a0d0f29c/src/vectorscope.c#L45
  ... I checked this plugin looks working with the old binary compiled with the header file from the master on Fedora 39.
• https://github.com/norihiro/obs-color-monitor/blob/a2f8bb7cbccd0994efe10d8d8361c3b2a0d0f29c/src/vectorscope.c#L45
• https://github.com/reboot/obs-image-compare/blob/e73e9c4366467d490e7ffdc5484410c05ed22c2e/image-compare.c#L58
• https://github.com/jb55/obs-x11-blocker/blob/b41806365884181c65a1982112ddd436115c2173/x11-blocker.c#L35

Probably, it's still safe for most cases because these conditions are satisfied.

• The size of gs_image_file does not grow.
• The 3rd party plugin does not access the member variables gif or later.
  Majority of 3rd party plugins just access texture, cx, cy, and loaded.

[norihiro]

I want to suggest to hide nsgif.h from the exported header file so that the it does not require to disable some warnings and also we can update libnsgif in the future.
I made a commit on my branch. https://github.com/norihiro/obs-studio/tree/really-update-libnsgif-internal

[RytoEX]

cc @Lain-B and @derrod on the breaking changes concern raised by @norihiro

My initial and primary concern was working out an update to an outdated vendored dependency. If there are additional concerns, such as moving the dependency to deps/ or mitigating breaking changes, those merit attention. Unfortunately, I do not have time to address either of them. If someone is able to build upon the work here and address either of those concerns, feel free.

[RytoEX]

Rebased and made the warning suppression more targeted.

Will probably need @Lain-B to comment on the ABI breakage concern.

[Lain-B]

If we need to break the ABI then we might as well go through with it once and for all. The proposed change seems to self-contain all future ABI breaks anyway. This should have been a pointer to an opaque type from the beginning. (Blame me for this one)

[Warchamp7]

Updated this branch with norihiro and Lain's work, as well as fixed up formatting in each commit due to the clang changes between each of those commits.

[RytoEX]

Looks fine to me now. Might rebase and use a merge commit for this.

[RytoEX]

Future todo: move libnsgif into deps/ (preferably in a subfolder that's clear it is thirdparty) or into obs-deps.