sxplayer

Warning: this repository has moved to https://github.com/gopro/sxplayer

---

Introduction

sxplayer stands for Stupeflix Player, a video frames fetching library.

It can handle only one stream at a time, generally video. If audio is requested, the frame returned will be an instant video frame containing both amplitudes and frequencies information.

License

LGPL v2.1, see LICENSE.

Compilation, installation

meson setup builddir
meson compile -C builddir
meson install -C builddir

meson configure can be used to list the available options. See the Meson documentation for more information.

API Usage

For API usage, refers to sxplayer.h.

Development

Running tests

Assuming sxplayer is built within a builddir directory (meson builddir && meson compile -C builddir), the test can be run with meson using a command such as meson test -C builddir -v.

The testing program itself (test-prog) can be found in the build directory, along a sample player tool named sxplayer (if its dependencies were met at build time), which can be used for other manual testing purposes.

Infrastructure overview

              .                             .
              .             API             .
              .                             .
              . . . . . . . . . . . . . . . .
              .                             .   .------------.               .-----------------------------------------------------.
              .                             .   | api.c      |               | control                                             |
              .                             .   +------------+               +-----------------------------------------------------+
           ===.===  sxplayer_create() ======.==>|            |===  init  ===>|                                                     |
              .                             .   |            |---  start  -->|                    MANAGE THREADS                   |
           ===.===  sxplayer_get_*frame() ==.==>|            |---  seek  --->|              _________/  |  \_______                |
  USER        .                             .   |            |---  stop  --->|             /            |          \               |
           ---.---  sxplayer_start() -------.-->|            |===  free  ===>|            /             |           \              |
           ---.---  sxplayer_seek()  -------.-->|            |               |           v              v            v             |
           ---.---  sxplayer_seek()  -------.-->|            |               |      .----------.  .----------.  .----------.       |
              .                             .   |            |               |      | demuxer  |  | decoder  |  | filterer |       |
           ===.===  sxplayer_free()  =======.==>|            |               |      +----------+  +----------+  +----------+       |
              .                             .   |            |               |      | init     |  | init     |  | init     |       |
              .                             .   `------------'               |      +----------+  +----------+  +----------+       |
              .                             .                                |      |          |  |          |  |          |       |
              .                             .                                |      |  RUN     |  |  RUN     |  |  RUN     |       |
              .                             .                                |      |          |  |          |  |          |       |
                                                                             |      |          |  |          |  |          |       |
                                                                             |   O==|==O    O==|==|==O    O==|==|==O    O==|==O    |
                                                                             |      |          |  |          |  |          |       |
                                                                             |      +----------+  +----------+  +----------+       |
                                                                             |      | free     |  | free     |  | free     |       |
                                                                             |      `----------'  `----------'  `----------'       |
                                                                             |                                                     |
                                                                             |                                                     |
                                                                             |   O=====O in control queue                          |
                                                                             |                                                     |
                                                                             |   O=====O out control queue                         |
                                                                             |                                                     |
                                                                             `-----------------------------------------------------'

O====O       message queue
-- xxx -->   async operation
== xxx ==>   sync operation