gingaf

gingaf is an MIT-licensed, multi-platform implementation of the interactive TV middleware Ginga standardised by ITU-T and SBTVD.

Architecture

The gingaf repository is organized as a monorepo: the root directory contains the Flutter host application. See the main components below.

• packages/gingacc/: configuration, users, and CCWS
• packages/ncldoc/: NCL headless execution engine
• packages/nclui/: NCL and visual widgets
• node/: npm package which also contains web interactive playground

block-beta
columns 3
  playground["playground"]
  space
  space
  ginga_node["ginga-node"]
  ginga_code["ginga-code"]
  space
  web["gingaf (web)"]
  desktop["gingaf (desktop)"]
  mobile["gingaf (mobile)"]
  gingaf["gingaf"]:3
  nclui["nclui"]:3
  ncldoc["ncldoc"]:2
  gingacc["gingacc"]:1

Loading

Developing Ginga Applications using gingaf

You can use gingaf to develop Ginga applications at web by using the playground or acessing ginga.org.br/gingaf/playground or at desktop by the Visual Studio Code extension ginga-code.

Demonstration Videos

Windows

windows.mp4

Android

android.mp4

Chrome

chrome.mp4

NCL headless

cli.mp4

Playground Ginga-NCL (video.ncl)

playground-ncl.mp4

Playground Ginga-HTML5 (current_service.html)

playground-html.mp4

Playground Ginga-NCL with Lua (lua.ncl)

playground-lua.mp4

Launch Ginga Application from VSCode

vscode.mp4

gingaf (desktop) run applications from local examples/

All example NCL and HTML documents are stored in the examples/ folder. You can configure and run the application via APP environment variable (e.g. examples/image.ncl or examples/image.html).

flutter run -d windows --dart-define="APP=examples/video.ncl"
flutter run -d windows --dart-define="APP=examples/image.html"

For convenience, you can use make run-example for the current platform:

make run-example app=video.ncl
make run-example app=image.html

gingaf (web, mobile) run applications from URLs

flutter run -d chrome --dart-define="APP=https://raw.githubusercontent.com/ginga-org-br/gingaf/refs/heads/main/examples/video.ncl"