| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 |
- About
- ========
- What does it do
- ---------------
- larigira integrates with MPD (Music Player Daemon) and prevents your playlist
- from running empty. It also has powerful support for "events": audio that must be played at some time.
- Features
- ---------
- * Simple to install
- * WebUI
- * modular event system
- Architecture
- -------------
- larigira delegates all the music playing business to MPD.
- It relies on ``tinydb`` as a db: it's actually just a json file, to achieve
- simplicity and flexibility.
- Code structure and core concepts
- -----------------------------------
- The code is heavily based on gevent: almost everything is a greenlet.
- alarm
- An alarm is a specification of timings. It is "something that can generate
- times". For example ``{ 'kind': 'single', 'timestamp': 1234567890 }``
- generates a single time (February 14, 2009 00:31:00), while
- ``{ 'kind': 'frequency', 'interval': 10, 'start': 1234567890 }`` generates
- infinite times, one every 10 seconds, starting from February 14, 2009
- 00:31:00.
- action
- An action is a specification of audio. It is "something that can generate a
- list of audio files".
- For example, ``{ 'kind': 'randomdir', 'paths': ['/my/dir', '/other/path'] }``
- will pick a random file from one of the two paths.
- event
- An event is an alarm plus a list of actions. At given times, do those things
- The main object is :class:`larigira.mpc.Player`; as the name says, it is the only object that sends messages
- to MPD. How does it know what to do? there are two main flows: the continous playlist filling and the alarm
- system.
- Continous playlist
- ~~~~~~~~~~~~~~~~~~
- :class:`larigira.mpc.Player` has a "child" called :class:`larigira.mpc.MpcWatcher`. It watches for events on
- the playlist; when the playlist is changed it notifies Player, which in turn will check if the playlist has
- enough songs. If that's the case, it will spawn an audiogenerator in a new greenlet; when the audio will be
- ready, it will be added at the bottom of the playlist.
- Alarm system
- ~~~~~~~~~~~~
- There is a DB. The lowest level is handled by TinyDB. :class:`larigira.event.EventModel` is a thin layer on
- it, providing more abstract functions. The real deal is :class:`larigira.event.EventSource`, which is a
- greenlet that sends notifications about alarms in the DB. Those notifications are received by
- :class:`larigira.event.Monitor`, which "runs" them; it executes the time specification, make an appropriate
- "sleep" and after that runs the audiogenerator.
|
