Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Roadmap to v1.0/stable release #1

Open
31 of 60 tasks
animafps opened this issue Jan 23, 2023 · 0 comments
Open
31 of 60 tasks

Roadmap to v1.0/stable release #1

animafps opened this issue Jan 23, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@animafps
Copy link
Owner

animafps commented Jan 23, 2023

Before releasing v1.0 would like to have near 100% coverage of the vapoursynth API or at least all developer facing functions/structs

Structs

  • API
  • Core(Ref)
  • Map (Ownedmap, MapRef, MapRefMut)
  • Map Iters (Keys, Values, Iter, IntoIter)
  • Node
  • Function
  • PluginFunction
  • Filter
  • Script environment
  • ScriptAPI
  • PluginAPI
  • VideoInfo
  • AudioInfo
  • Format
  • LogHandler
  • ...

May need to rework how the API cache works before checking it off

Functionality

  • Get API
  • Create Core (partial done need to document flags)
  • Create Map
  • Read keys from map
  • Data subtypes
  • Node subtypes
  • Read values from map
  • Read array values from map
  • Set array values to map
  • Index map
  • Basic map handling
  • Set values in map (partial need to improve data, node and frame for subtypes)
  • Create keys in map
  • Mutability of map through indexing
  • Get loaded plugins
  • Get plugin functions
  • invoke plugin functions
  • Create Nodes
  • Parse nodes
  • create Functions and by proxy pluginfunctions
  • Create script environment
  • eval script
  • get output from script environment
  • Log handling
  • create log event
  • Node infos
  • Load plugin
  • ...

Unit Testing

  • Map
  • API
  • Node
  • VSScript
  • Frame
  • Filter
  • Plugin
  • Function
  • PluginAPI

Documentation

  • Create overview API doc notes
  • function specific overview notes
  • Warnings/Errors
  • Panics
  • Safety limitations
  • App example (vspipe)
  • Plugin example
@animafps animafps added enhancement New feature or request help wanted Extra attention is needed labels Jan 23, 2023
@animafps animafps self-assigned this Jan 23, 2023
@animafps animafps pinned this issue Jan 23, 2023
@animafps animafps changed the title Things todo before v1.0 Roadmap to v1.0 Jan 23, 2023
@animafps animafps changed the title Roadmap to v1.0 Roadmap to v1.0/stable release Feb 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant