codecs: Add basic documentation stubs

This commit is contained in:
Thibault Saunier 2020-04-08 08:47:37 -04:00
parent f5da12bcf5
commit b9e0ccd8b7
7 changed files with 46 additions and 0 deletions

View file

@ -0,0 +1,3 @@
# GstCodecs
> NOTE: This library API is considered *unstable*

View file

@ -0,0 +1 @@
gi-index

View file

@ -104,6 +104,7 @@ if build_gir
{'name': 'webrtc', 'gir': webrtc_gir, 'lib': gstwebrtc_dep, 'suffix': 'lib'},
{'name': 'audio', 'gir': audio_gir, 'lib': gstbadaudio_dep, 'prefix': 'bad-'},
{'name': 'transcoder', 'gir': transcoder_gir, 'lib': gst_transcoder_dep},
{'name': 'codecs', 'gir': codecs_gir, 'lib': gstcodecs_dep},
]
endif

View file

@ -46,6 +46,13 @@
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* SECTION:gsth264decoder
* @title: GstH264Decoder
* @short_description: Base class to implement stateless H.264 decoders
* @sources:
* - gsth264picture.h
*/
#ifdef HAVE_CONFIG_H
#include <config.h>

View file

@ -18,6 +18,13 @@
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gsth265decoder
* @title: GstH265Decoder
* @short_description: Base class to implement stateless H.265 decoders
* @sources:
* - gsth265picture.h
*/
#ifdef HAVE_CONFIG_H
#include <config.h>

View file

@ -46,6 +46,13 @@
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* SECTION:gstvp9decoder
* @title: Gstvp9Decoder
* @short_description: Base class to implement stateless VP9 decoders
* @sources:
* - gstvp9picture.h
*/
#ifdef HAVE_CONFIG_H
#include <config.h>

View file

@ -32,6 +32,26 @@ gstcodecs = library('gstcodecs-' + api_version,
dependencies : [gstvideo_dep, gstcodecparsers_dep],
)
gen_sources = []
if build_gir
codecs_gir = gnome.generate_gir(gstcodecs,
sources : codecs_sources + codecs_headers,
namespace : 'GstCodecs',
nsversion : api_version,
identifier_prefix : 'Gst',
symbol_prefix : 'gst',
export_packages : 'gstreamer-codecs-1.0',
includes : ['Gst-1.0', 'GstVideo-1.0'],
install : true,
extra_args : gir_init_section + ['-DGST_USE_UNSTABLE_API'] +
['--c-include=gst/codecs/gsth264decoder.h',
'--c-include=gst/codecs/gsth265decoder.h',
'--c-include=gst/codecs/gstvp9decoder.h', ],
dependencies : [gstvideo_dep, gstcodecparsers_dep]
)
endif
gstcodecs_dep = declare_dependency(link_with : gstcodecs,
include_directories : [libsinc],
sources: gen_sources,
dependencies : [gstvideo_dep, gstcodecparsers_dep])