• J
    Revamp API and start using doxygen · 8e81d8be
    jp9000 提交于
    The API used to be designed in such a way to where it would expect
    exports for each individual source/output/encoder/etc.  You would export
    functions for each and it would automatically load those functions based
    on a specific naming scheme from the module.
    
    The idea behind this was that I wanted to limit the usage of structures
    in the API so only functions could be used.  It was an interesting idea
    in theory, but this idea turned out to be flawed in a number of ways:
    
     1.) Requiring exports to create sources/outputs/encoders/etc meant that
         you could not create them by any other means, which meant that
         things like faruton's .net plugin would become difficult.
    
     2.) Export function declarations could not be checked, therefore if you
         created a function with the wrong parameters and parameter types,
         the compiler wouldn't know how to check for that.
    
     3.) Required overly complex load functions in libobs just to handle it.
         It makes much more sense to just have a load function that you call
         manually.  Complexity is the bane of all good programs.
    
     4.) It required that you have functions of specific names, which looked
         and felt somewhat unsightly.
    
    So, to fix these issues, I replaced it with a more commonly used API
    scheme, seen commonly in places like kernels and typical C libraries
    with abstraction.  You simply create a structure that contains the
    callback definitions, and you pass it to a function to register that
    definition (such as obs_register_source), which you call in the
    obs_module_load of the module.
    
    It will also automatically check the structure size and ensure that it
    only loads the required values if the structure happened to add new
    values in an API change.
    
    The "main" source file for each module must include obs-module.h, and
    must use OBS_DECLARE_MODULE() within that source file.
    
    Also, started writing some doxygen documentation in to the main library
    headers.  Will add more detailed documentation as I go.
    8e81d8be
obs.h 19.5 KB