Migrate to 7TV v3 api

[ScrubN]

Fixes #410

[sunkhaskasis]

I just tried it on my end and it didn't work, throws the ERROR: Error reading JArray from JsonReader. Current JsonReader item is not an array: StartObject. Path '', line 1, position 1. error, though I'm not sure if that's what causes it.

[ScrubN]

The one time I don't test...

Working on it. Thank you for testing it

[ScrubN]

Found the problem! The old api was structured:

[
    {
    },
    {
    },
]

where each {} is an emote. The new api is structured:

{
    ...data...
    "emotes": [
    {
    },
    {
    }
    ]
    ...data...
}

where each {} is an emote.

The key difference is that the new API isn't wrapped in [] making it not an array, and thus not a valid input to the JArray Parser. Thanks 7tv!

[ScrubN]

The old and new APIs looked close enough to me when I initially checked their outputs, but I should've looked further. If the JArray exception hadn't happened then it would've failed in other ways. They completely restructured the API, it wasn't just a renaming like last time.

[goldbattle]

It should still be valid (its an array of json objects). Should be able to first create a JSON object and get its value for the "emotes" which is then the json array you expect.

…

On Sun, Nov 6, 2022 at 10:58 PM Scrub ***@***.***> wrote: The old and new APIs looked close enough to me when I initially checked their outputs, but I should've looked further. If this hadn't happened then it would've failed in other ways. They completely restructured the API, it wasn't just a renaming like last time. — Reply to this email directly, view it on GitHub <#412 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAQ6TYUWX3PJBUSCCZ525BLWHBV55ANCNFSM6AAAAAARYRDEKM> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[ScrubN]

It should still be valid (its an array of json objects). Should be able to first create a JSON object and get its value for the "emotes" which is then the json array you expect.

Yes, that was more or less the plan. But many properties were renamed or moved, for example the mime field is gone and has been replaced by "animated" : <bool> and an array of valid formats in a variety of sizes.

[goldbattle]

To get the file you need to get it from the "host"

• host > url: cdn.7tv.app/emote/603caa69faf3a00014dff0b1
• host > files > name: [scale].webp
• Gives https://cdn.7tv.app/emote/603caa69faf3a00014dff0b1/1x.webp

You might be able to just assume there is always there is a webp there (I would put a check that goes through "files" and ensures there is a webp). For example chatterino only uses webp versions currently.

{
  "id": "6185d97a8d50b5f26ee802fb",
  "name": "PartyParrot",
  "flags": 0,
  "timestamp": 1657657262073,
  "actor_id": null,
  "data": {
    "id": "6185d97a8d50b5f26ee802fb",
    "name": "PartyParrot",
    "flags": 0,
    "lifecycle": 3,
    "listed": true,
    "animated": true,
    "host": {
      "url": "//cdn.7tv.app/emote/6185d97a8d50b5f26ee802fb",
      "files": [
        {
          "name": "1x.webp",
          "static_name": "1x",
          "width": 32,
          "height": 32,
          "size": 7540,
          "format": "WEBP"
        },
        ....
      ]
    }
  }
}

[goldbattle]

Here are the definitions:
https://github.com/SevenTV/API/blob/dev/data/model/emote.model.go#L60-L71
https://github.com/Chatterino/chatterino2/blob/dd6cb80ab945a4f0a40da9da8de83eea2de1ce08/src/providers/seventv/SeventvEmotes.hpp#L27-L47

There are actually a few extra checks that need to be made that is not currently checked.

1. Emote is not an unlisted one (these shouldn't be seen by users), can be enforced by checking "listed": true, in json
2. Emote has not been disallowed on twitch, this would need to be checked in the flags 1 << 24

If you want good examples see sodapoppin's channel:

• https://7tv.io/v3/users/twitch/26301881
• WICKEDglasses has flags 256 (zero width is 2^8 (eighth bit is 1))
• ShowerTime has flags 256 (zero width is 2^8 (eighth bit is 1))

[ScrubN]

My adaptation is complete. If you test it for yourself, odds are you'll end up with a slightly smaller output json because the streamer has unlisted emotes. I used Mizkif and he has an unlisted emote that the v2 parser did not ignore.

Please let me know if you have any critiques of my code, this is my first time properly working with Newtonsoft.Json

[sunkhaskasis]

Does SkiaSharp not support AVIF? IMO, it'd be better if it was preferred instead of WEBP, as it features better compression and weighs less.

[ScrubN]

Does SkiaSharp not support AVIF? IMO, it'd be better if it was preferred instead of WEBP, as it features better compression and weighs less.

Looks like SkiaSharp does support AVIF as of 2.88.1. I just figured may as well prefer webp since Chatterino does

[ScrubN]

Also currently master is on SkiaSharp 2.80.2. In #407 I updated the SkiaSharp packages to 2.88.3, so that would need to be merged first before prioritizing AVIF.