File spiel-1.0.0.obscpio of Package spiel

Overview Repositories Revisions Requests Users Attributes Meta

File spiel-1.0.0.obscpio of Package spiel (Revision 739cdc85383c21e9306f8ca4fc822766)

Currently displaying revision 739cdc85383c21e9306f8ca4fc822766 , Show latest

07070100000000000081A400000000000000000000000165D79E0600000106000000000000000000000000000000000000001A00000000spiel-1.0.0/.clang-format# See https://wiki.apertis.org/Guidelines/Coding_conventions#Code_formatting
BasedOnStyle: GNU
AlwaysBreakAfterDefinitionReturnType: All
BreakBeforeBinaryOperators: None
BinPackParameters: false
SpaceAfterCStyleCast: true
PointerAlignment: Right
ColumnLimit: 80
07070100000001000041ED00000000000000000000000265D79E0600000000000000000000000000000000000000000000001A00000000spiel-1.0.0/.devcontainer07070100000002000081A400000000000000000000000165D79E0600000238000000000000000000000000000000000000002500000000spiel-1.0.0/.devcontainer/DockerfileFROM ubuntu:lunar

ARG DEBIAN_FRONTEND=noninteractive
ARG USERNAME=ubuntu

RUN apt-get update \
    && apt-get install -y \
    git \
    sudo \
    meson \
    gi-docgen \
    libgirepository1.0-dev \
    dbus \
    libdbus-glib-1-dev \
    python3-dasbus \
    python3-tap \
    python3-gi \
    libgstreamer1.0-dev \
    libgstreamer-plugins-base1.0-dev \
    gstreamer1.0-plugins-good \
    && apt-get clean -y \
    && apt-get autoremove -y \
    && echo $USERNAME ALL=$root$ NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
    && chmod 0440 /etc/sudoers.d/$USERNAME
07070100000003000081A400000000000000000000000165D79E0600000059000000000000000000000000000000000000002C00000000spiel-1.0.0/.devcontainer/devcontainer.json{
	"name": "Ubuntu",
	"build": { "dockerfile": "Dockerfile" },
	"remoteUser": "ubuntu"
}
07070100000004000041ED00000000000000000000000265D79E0600000000000000000000000000000000000000000000001400000000spiel-1.0.0/.github07070100000005000041ED00000000000000000000000265D79E0600000000000000000000000000000000000000000000001E00000000spiel-1.0.0/.github/workflows07070100000006000081A400000000000000000000000165D79E0600000477000000000000000000000000000000000000002500000000spiel-1.0.0/.github/workflows/ci.ymlname: Build & Test

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

jobs:
  deploy:
    runs-on: ubuntu-latest
    container: ubuntu:lunar
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Setup Pages
        uses: actions/configure-pages@v3
      - name: Update repos
        run: apt update
      - name: Install dependencies
        run: apt install -y git meson libgirepository1.0-dev dbus libdbus-glib-1-dev python3-dasbus python3-tap python3-gi libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-good
      - name: Set up permissions
        run: chown ubuntu:ubuntu .
      - name: Setup Spiel
        run: su ubuntu -c "meson setup build -Ddocs=false"
      - name: Compile Spiel
        run: su ubuntu -c "meson compile -C build"
      - name: Test Spiel
        run: su ubuntu -c "meson test -C build"
      - uses: actions/upload-artifact@v1
        if: failure()
        with:
          name: Meson_Testlog
          path: build/meson-logs/testlog.txt
07070100000007000081A400000000000000000000000165D79E06000005B8000000000000000000000000000000000000002A00000000spiel-1.0.0/.github/workflows/website.ymlname: Docs & Website

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    container: ubuntu:lunar
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Setup Pages
        uses: actions/configure-pages@v3
      - name: Update repos
        run: apt update
      - name: Install dependencies
        run: apt install -y git meson gi-docgen libgirepository1.0-dev libdbus-glib-1-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
      - name: Set up permissions
        run: chown ubuntu:ubuntu .
      - name: Setup Spiel
        run: su ubuntu -c "meson setup build -Dtests=false"
      - name: Compile Spiel
        run: su ubuntu -c "meson compile -C build"
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: './build/doc/libspiel'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1
07070100000008000081A400000000000000000000000165D79E060000001A000000000000000000000000000000000000001700000000spiel-1.0.0/.gitignore.vscode
build
__pycache__
07070100000009000081A400000000000000000000000165D79E0600000026000000000000000000000000000000000000001400000000spiel-1.0.0/AUTHORSEitan Isaacson <eitan@monotonous.org>
0707010000000A000081A400000000000000000000000165D79E06000067A2000000000000000000000000000000000000001400000000spiel-1.0.0/COPYING                  GNU LESSER GENERAL PUBLIC LICENSE
                       Version 2.1, February 1999

Copyright (C) 1991, 1999 Free Software Foundation, Inc.
 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

[This is the first released version of the Lesser GPL.  It also counts
 as the successor of the GNU Library Public License, version 2, hence
 the version number 2.1.]

Preamble

The licenses for most software are designed to take away your
freedom to share and change it.  By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.

This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it.  You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.

When we speak of free software, we are referring to freedom of use,
not price.  Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.

To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights.  These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.

For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you.  You must make sure that they, too, receive or can get the source
code.  If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it.  And you must show them these terms so they know their rights.

We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.

To protect each distributor, we want to make it very clear that
there is no warranty for the free library.  Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.

Finally, software patents pose a constant threat to the existence of
any free program.  We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder.  Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.

Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License.  This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License.  We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.

When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library.  The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom.  The Lesser General
Public License permits more lax criteria for linking other code with
the library.

We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License.  It also provides other free software developers Less
of an advantage over competing non-free programs.  These disadvantages
are the reason we use the ordinary General Public License for many
libraries.  However, the Lesser license provides advantages in certain
special circumstances.

For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard.  To achieve this, non-free programs must be
allowed to use the library.  A more frequent case is that a free
library does the same job as widely used non-free libraries.  In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.

In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software.  For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.

Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.

The precise terms and conditions for copying, distribution and
modification follow.  Pay close attention to the difference between a
"work based on the library" and a "work that uses the library".  The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.

GNU LESSER GENERAL PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".

A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.

The "Library", below, refers to any such software library or work
which has been distributed under these terms.  A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language.  (Hereinafter, translation is
included without limitation in the term "modification".)

"Source code" for a work means the preferred form of the work for
making modifications to it.  For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.

Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope.  The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it).  Whether that is true depends on what the Library does
and what the program that uses the Library does.

1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.

You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.

2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:

a) The modified work must itself be a software library.

b) You must cause the files modified to carry prominent notices
    stating that you changed the files and the date of any change.

c) You must cause the whole of the work to be licensed at no
    charge to all third parties under the terms of this License.

d) If a facility in the modified Library refers to a function or a
    table of data to be supplied by an application program that uses
    the facility, other than as an argument passed when the facility
    is invoked, then you must make a good faith effort to ensure that,
    in the event an application does not supply such function or
    table, the facility still operates, and performs whatever part of
    its purpose remains meaningful.

(For example, a function in a library to compute square roots has
    a purpose that is entirely well-defined independent of the
    application.  Therefore, Subsection 2d requires that any
    application-supplied function or table used by this function must
    be optional: if the application does not supply it, the square
    root function must still compute square roots.)

These requirements apply to the modified work as a whole.  If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works.  But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.

Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.

In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.

3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library.  To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License.  (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.)  Do not make any other change in
these notices.

Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.

This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.

4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.

If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.

5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library".  Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.

However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library".  The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.

When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library.  The
threshold for this to be true is not precisely defined by law.

If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work.  (Executables containing this object code plus portions of the
Library will still fall under Section 6.)

Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.

6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.

You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License.  You must supply a copy of this License.  If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License.  Also, you must do one
of these things:

a) Accompany the work with the complete corresponding
    machine-readable source code for the Library including whatever
    changes were used in the work (which must be distributed under
    Sections 1 and 2 above); and, if the work is an executable linked
    with the Library, with the complete machine-readable "work that
    uses the Library", as object code and/or source code, so that the
    user can modify the Library and then relink to produce a modified
    executable containing the modified Library.  (It is understood
    that the user who changes the contents of definitions files in the
    Library will not necessarily be able to recompile the application
    to use the modified definitions.)

b) Use a suitable shared library mechanism for linking with the
    Library.  A suitable mechanism is one that (1) uses at run time a
    copy of the library already present on the user's computer system,
    rather than copying library functions into the executable, and (2)
    will operate properly with a modified version of the library, if
    the user installs one, as long as the modified version is
    interface-compatible with the version that the work was made with.

c) Accompany the work with a written offer, valid for at
    least three years, to give the same user the materials
    specified in Subsection 6a, above, for a charge no more
    than the cost of performing this distribution.

d) If distribution of the work is made by offering access to copy
    from a designated place, offer equivalent access to copy the above
    specified materials from the same place.

e) Verify that the user has already received a copy of these
    materials or that you have already sent this user a copy.

For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it.  However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.

It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system.  Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.

7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:

a) Accompany the combined library with a copy of the same work
    based on the Library, uncombined with any other library
    facilities.  This must be distributed under the terms of the
    Sections above.

b) Give prominent notice with the combined library of the fact
    that part of it is a work based on the Library, and explaining
    where to find the accompanying uncombined form of the same work.

8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License.  Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License.  However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.

9. You are not required to accept this License, since you have not
signed it.  However, nothing else grants you permission to modify or
distribute the Library or its derivative works.  These actions are
prohibited by law if you do not accept this License.  Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.

10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions.  You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.

11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all.  For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.

If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices.  Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.

This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.

12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded.  In such case, this License incorporates the limitation as if
written in the body of this License.

13. The Free Software Foundation may publish revised and/or new
versions of the Lesser General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number.  If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation.  If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.

14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission.  For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this.  Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.

NO WARRANTY

15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Libraries

If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change.  You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).

To apply these terms, attach the following notices to the library.  It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.

<one line to give the library's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>

This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

Also add information on how to contact you by electronic and paper mail.

You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary.  Here is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the
  library `Frob' (a library for tweaking knobs) written by James Random Hacker.

<signature of Ty Coon>, 1 April 1990
  Ty Coon, President of Vice

That's all there is to it!
0707010000000B000081A400000000000000000000000165D79E0600000C15000000000000000000000000000000000000001600000000spiel-1.0.0/README.md<img alt="libspiel logo" align="right" src="https://raw.githubusercontent.com/eeejay/spiel/main/spiel-logo.svg">

# Spiel

[![ Build & Test ](https://github.com/eeejay/spiel/actions/workflows/ci.yml/badge.svg)](https://github.com/eeejay/spiel/actions/workflows/ci.yml) [![ Docs & Website ](https://github.com/eeejay/spiel/actions/workflows/website.yml/badge.svg)](https://github.com/eeejay/spiel/actions/workflows/website.yml)

## Overview

This project provides a speech synthesis API for desktop Linux and beyond. It consists of two parts, a speech provider interface specification and a client library.

### org.freedesktop.Speech.Provider
This is a [loose specification](https://eeejay.github.io/spiel/generated-org.freedesktop.Speech.Provider.html) of what methods and signals a D-Bus speech provider should implement in order to be discoverable and usable by client applications. It consists of simple speech methods such as `Speak()`, `Pause()` and `Cancel()`, and speech events to notify of state changes of spoken text. There is also a `GetVoices()` method that should return a list of available voices and their associated properties (like supported language).

The interface for a typical speech provider implementation could be written in a couple hundred lines of code. The specification is designed to be simple and straightforward. The really neat thing about this kind of speech provider is that it can be distributed as a Flatpak or Snap without any system prerequisites and be completely self contained.

### Client Library (libspiel)
The [libspiel client library](https://eeejay.github.io/spiel/) is designed to provide an ergonomic interface to the myriad of potential speech providers that are installed in a given session. The API is inspired by the W3C Web Speech API. It serves several purposes:
* Provide an updated list of installed across all speech providers voices.
* Offer a “speaker” abstraction where utterances can be queued to speak.
* If no voice was explicitly chosen for an utterance, negotiate global user settings and language preferences to choose the most appropriate voice.

Language bindings are available through GObject Introspection. So this should work for any application, be it in C/C++, Python, Rust, ECMAscript, or Lua.

A minimal python example would look like this:
```python
import gi
gi.require_version("Spiel", "1.0")
from gi.repository import GLib, Spiel

loop = GLib.MainLoop()

def _notify_speaking_cb(synth, val):
    if not synth.props.speaking:
        loop.quit()

speaker = Spiel.Speaker.new_sync(None)
speaker.connect("notify::speaking", _notify_speaking_cb)

utterance = Spiel.Utterance(text="Hello world.")
speaker.speak(utterance)

loop.run()

```

## Building

We use the Meson build system for building Spiel.

```sh
# Some common options
meson setup build
meson compile -C build
```

## Documentation

There is [auto-generated API reference](https://eeejay.github.io/spiel/) along with a [documented D-Bus interface](https://eeejay.github.io/spiel/generated-org.freedesktop.Speech.Provider.html) for speech providers.0707010000000C000041ED00000000000000000000000265D79E0600000000000000000000000000000000000000000000001000000000spiel-1.0.0/doc0707010000000D000081A400000000000000000000000165D79E06000004CC000000000000000000000000000000000000001E00000000spiel-1.0.0/doc/Spiel.toml.in[library]
version = "@version@"
browse_url = "https://github.com/eeejay/libspiel"
repository_url = "https://github.com/eeejay/libspiel.git"
website_url = "https://github.com/eeejay/libspiel"
docs_url = "https://eeejay.github.io/libspiel/"
authors = "Eitan Isaacson"
logo_url = "spiel-logo.svg"
license = "LGPL-2.1"
description = "A library that interfaces with D-Bus speech synthesis providers."
dependencies = [ "GObject-2.0", "GLib-2.0", "Gio-2.0"]
devhelp = true
search_index = true

[dependencies."GObject-2.0"]
  name = "GObject"
  description = "The base type system library"
  docs_url = "https://docs.gtk.org/gobject/"

[dependencies."GLib-2.0"]
  name = "GLib"
  description = "The base type system library"
  docs_url = "https://docs.gtk.org/glib/"

[dependencies."Gio-2.0"]
  name = "GIO"
  description = "GObject Interfaces and Objects, Networking, IPC, and I/O"
  docs_url = "https://docs.gtk.org/gio/"

[theme]
name = "basic"
show_index_summary = true
show_class_hierarchy = true

[source-location]
base_url = "https://github.com/eeejay/libspiel/blob/main/"

[extra]
urlmap_file = "urlmap.js"
content_files = ["overview.md", "generated-org.freedesktop.Speech.Provider.md"]
content_images = ["spiel-logo.svg"]0707010000000E000081A400000000000000000000000165D79E0600000136000000000000000000000000000000000000002500000000spiel-1.0.0/doc/generate_overview.pyfrom sys import argv
import re

f = open(argv[-1], "r").read()

regex = r"(## Overview.*\n)## Building.*"

m = re.search(regex, f, re.MULTILINE | re.DOTALL)

subsection = m.groups()[0]

# Make headings one level higher
subsection = subsection.replace("## ", "# ")

print("Title: Overview\n")
print(subsection)
0707010000000F000081A400000000000000000000000165D79E0600000791000000000000000000000000000000000000001C00000000spiel-1.0.0/doc/meson.buildtoml_conf = configuration_data()
toml_conf.set('version', meson.project_version())

source_toml = configure_file(
  input: 'Spiel.toml.in',
  output: 'Spiel.toml',
  configuration: toml_conf,
  # install: true,
  # install_dir: docs_dir / 'libspiel',
)

interface_src_dir = join_paths(meson.project_source_root(), 'interface')
logo = join_paths(meson.project_source_root(), 'spiel-logo.svg')

gdbus_codegen_cmd = find_program('gdbus-codegen')
spiel_iface_docs = custom_target('dbus-docs',
  output : 'generated-org.freedesktop.Speech.Provider.md',
  input : join_paths(interface_src_dir, 'org.freedesktop.Speech.Provider.xml'),
  command : [gdbus_codegen_cmd, '--generate-md', 'generated',
             '--output-directory', meson.current_build_dir(),
             join_paths(interface_src_dir, 'org.freedesktop.Speech.Provider.xml')])

fs = import('fs')
urlmap_doc = fs.copyfile('urlmap.js')
logo_file = fs.copyfile(logo)

gidocgen = find_program('gi-docgen', required: true)

gidocgen_common_args = [
  '--quiet',
  '--no-namespace-dir',
]

if get_option('werror')
  gidocgen_common_args += ['--fatal-warnings']
endif

python_module = import('python')
python = python_module.find_installation(
  'python3', required : true)
overview_doc = custom_target(
    input: join_paths(meson.project_source_root(), 'README.md'),
    output: 'overview.md',
    command: [python, files('generate_overview.py'), '@INPUT@'],
    capture: true
)

if get_option('libspiel')
  custom_target('libspiel-doc',
    input: [ source_toml, spiel_gir[0] ],
    output: 'libspiel',
    command: [
      gidocgen,
      'generate',
      gidocgen_common_args,
      '--config=@INPUT0@',
      '--output-dir=@OUTPUT@',
      '--content-dir=@0@'.format(meson.current_build_dir()),
      '@INPUT1@',
    ],
    build_by_default: true,
    depends: [ spiel_iface_docs, overview_doc, urlmap_doc, logo_file ]
    # install: true,
    # install_dir: docs_dir,
  )
endif07070100000010000081A400000000000000000000000165D79E06000000E6000000000000000000000000000000000000001A00000000spiel-1.0.0/doc/urlmap.js// A map between namespaces and base URLs for their online documentation
baseURLs = [
    [ 'GLib', 'https://docs.gtk.org/glib/' ],
    [ 'GObject', 'https://docs.gtk.org/gobject/' ],
    [ 'Gio', 'https://docs.gtk.org/gio/' ],
]
07070100000011000041ED00000000000000000000000265D79E0600000000000000000000000000000000000000000000001500000000spiel-1.0.0/examples07070100000012000081ED00000000000000000000000165D79E0600000588000000000000000000000000000000000000001F00000000spiel-1.0.0/examples/spiel-cli#!/bin/env python3

from gi.repository import GLib
import gi
import sys

gi.require_version("Spiel", "1.0")
from gi.repository import Spiel

def speak_and_wait(speaker, voice, text):
    def _notify_speaking_cb(synth, val):
        print("notify speaking")
        if not synth.props.speaking:
            speaker.disconnect_by_func(_notify_speaking_cb)
            speaker.disconnect_by_func(_started_cb)
            speaker.disconnect_by_func(_range_started_cb)
            speaker.disconnect_by_func(_finished_cb)
            loop.quit()

def _started_cb(synth, utt):
        print("utterance-started")

def _range_started_cb(synth, utt, start, end):
        print("range", start, end)

def _finished_cb(synth, utt):
        print("utterance-finished")

speaker.connect("notify::speaking", _notify_speaking_cb)
    speaker.connect("utterance-started", _started_cb)
    speaker.connect("range-started", _range_started_cb)
    speaker.connect("utterance-finished", _finished_cb)
    utterance = Spiel.Utterance(text=text, voice=voice)
    speaker.speak(utterance)

loop = GLib.MainLoop()
    loop.run()

if __name__ == "__main__":
    actual_events = []

speaker = Spiel.Speaker.new_sync(None)
    for voice in speaker.props.voices:
        print(f"{voice.props.name}\t{voice.props.identifier}\t{voice.props.languages}")
        speak_and_wait(speaker, voice, sys.argv[-1])
        break;

07070100000013000041ED00000000000000000000000265D79E0600000000000000000000000000000000000000000000001600000000spiel-1.0.0/interface07070100000014000081A400000000000000000000000165D79E06000017FD000000000000000000000000000000000000002800000000spiel-1.0.0/interface/generate_enums.pyimport xml.parsers.expat
import sys
import pathlib

class DBusXMLEnumParser:
    def __init__(self, xml_data, prefix, infile, outfile):
        self.prefix = prefix
        self._parser = xml.parsers.expat.ParserCreate()
        self._parser.StartElementHandler = self.handle_start_element
        self._parser.EndElementHandler = self.handle_end_element
        self._parser.CharacterDataHandler = self.handle_char_data

self._enum_data = None
        self._in_docstring = False
        self._in_enum_value = False

self._poutfile = pathlib.Path(outfile)
        self._header = self._poutfile.suffix == ".h"
        self._writer = self._poutfile.open("w")
        self._writer.write(f"/* Autogenerated from {pathlib.Path(infile).name} */\n\n")

if self._header:
            self._writer.write("#pragma once\n\n")
            self._writer.write("#include <glib-object.h>\n\n")
            self._writer.write("G_BEGIN_DECLS\n\n")
        else:
            self._writer.write(f'#include "{self._poutfile.stem}.h"\n\n')
        self._parser.Parse(xml_data)

if self._header:
            self._writer.write("\nG_END_DECLS\n\n")
        self._writer.close()

def print_enum_impl(self):
        full_name = f"{self.prefix}_{self._enum_data['name']}"
        camel_case_name = "".join([a.capitalize() for a in full_name.split("_")])
        self._writer.write(f"GType\n{full_name.lower()}_get_type (void)\n{{\n")
        self._writer.write("  static gsize g_define_type_id__volatile = 0;\n\n")
        self._writer.write(
            "  if (g_once_init_enter (&g_define_type_id__volatile))\n    {\n"
        )
        if self._enum_data["is_flags"]:
            self._writer.write("      static const GFlagsValue values[] = {\n")
        else:
            self._writer.write("      static const GEnumValue values[] = {\n")
        values = []
        for val in self._enum_data["values"]:
            dashified = "-".join(
                val["name"][len(self._enum_data["name"]) + 1 :].lower().split("_")
            )
            triad = [
                f"{self.prefix.upper()}_{val['name']}",
                f"\"{self.prefix.upper()}_{val['name']}\"",
                f'"{dashified}"',
            ]
            values.append(triad)
        values.append(["0", "NULL", "NULL"])
        a = [f"        {{ {', '.join(triad)} }}" for triad in values]
        self._writer.write(",\n".join(a))
        self._writer.write("\n      };\n")
        self._writer.write("      GType g_define_type_id =\n")
        if self._enum_data["is_flags"]:
            self._writer.write(
                f'        g_flags_register_static (g_intern_static_string ("{camel_case_name}"), values);\n'
            )
        else:
            self._writer.write(
                f'        g_enum_register_static (g_intern_static_string ("{camel_case_name}"), values);\n'
            )
        self._writer.write(
            "      g_once_init_leave (&g_define_type_id__volatile, g_define_type_id);\n"
        )
        self._writer.write("    }\n\n")
        self._writer.write("  return g_define_type_id__volatile;\n")
        self._writer.write("}\n\n")

def print_enum_header(self):
        full_name = f"{self.prefix}_{self._enum_data['name']}"
        camel_case_name = "".join([a.capitalize() for a in full_name.split("_")])
        self._writer.write("\n/**\n")
        self._writer.write(f" * {camel_case_name}:\n")
        for val in self._enum_data["values"]:
            self._writer.write(
                f" * @{self.prefix.upper()}_{val['name']}: {' '.join(val['docstring'])}\n"
            )
        self._writer.write(" *\n")
        self._writer.write(f" * {' '.join(self._enum_data['docstring'])}\n")
        self._writer.write(" */\n")

self._writer.write(f"typedef enum /*<underscore_name={full_name.lower()}>*/\n")
        self._writer.write("{\n")
        for val in self._enum_data["values"]:
            self._writer.write(
                f"  {self.prefix.upper()}_{val['name']} = {val['value']},\n"
            )
        self._writer.write("} %s;\n\n" % camel_case_name)
        self._writer.write(
            f"\nGType {full_name.lower()}_get_type (void) G_GNUC_CONST;\n"
        )
        self._writer.write(
            f"#define {self.prefix.upper()}_TYPE_{self._enum_data['name']} ({full_name.lower()}_get_type ())\n"
        )

def handle_start_element(self, name, attrs):
        if name == "tp:enum" or name == "tp:flags":
            self._enum_data = {
                "name": attrs["name"],
                "values": [],
                "docstring": [],
                "is_flags": name == "tp:flags",
            }
        elif name == "tp:enumvalue" or name == "tp:flag":
            if (name == "tp:flag") != (self._enum_data["is_flags"]):
                raise Exception("Flags embedded in enum or vice-versa")
            self._enum_data["values"].append(
                {
                    "name": f"{self._enum_data['name']}_{attrs['suffix']}",
                    "value": attrs["value"],
                    "docstring": [],
                }
            )
            self._in_enum_value = True
        elif name == "tp:docstring":
            self._in_docstring = True

def handle_char_data(self, data):
        text = data.strip()
        if not text:
            return
        if self._in_docstring and self._in_enum_value:
            self._enum_data["values"][-1]["docstring"].append(text)
        else:
            self._enum_data["docstring"].append(text)

def handle_end_element(self, name):
        if name == "tp:enum" or name == "tp:flags":
            if self._header:
                self.print_enum_header()
            else:
                self.print_enum_impl()
            self._enum_data = None
        elif name == "tp:enumvalue" or name == "tp:flag":
            self._in_enum_value = False
        elif name == "tp:docstring":
            self._in_docstring = False

if __name__ == "__main__":
    prefix, infile, outfile = sys.argv[-3:]
    data = open(infile)
    parser = DBusXMLEnumParser(data.read(), prefix, infile, outfile)
07070100000015000081A400000000000000000000000165D79E060000150E000000000000000000000000000000000000003A00000000spiel-1.0.0/interface/org.freedesktop.Speech.Provider.xml<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
  <!--
    org.freedesktop.Speech.Provider:
    @short_description: A common interface for text-to-speech providers.

D-Bus services that implement this interface can provide speech synth
    to applications that use a client library, like `libspiel`.

For discoverability, the service's known name **must**
    end with `Speech.Provider`. For example, `org.espeak.Speech.Provider`.
  -->
  <interface name="org.freedesktop.Speech.Provider"
             xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <!--
    Synthesize:
    @pipe_fd: File descriptor of pipe to write to.
    @text: The text to be spoken.
    @voice_id: The voice identifier for the voice that should be spoken.
    @pitch: The voice pitch in which the text should be spoken.
    @rate: The rate in which the text should be spoken.
    @is_ssml: True if the text should be interpretted as an SSML snippet.
    @language: The language the utterance should be spoken in. Some voices support more than one language.

This is the basic synthesis method.
    When called, the speech provider will send the synthesized output to the given file descriptor.
    Depending on the voice's advertised format it will be raw audio or composite audio and events.

Providers should be capable of synthesizing more than one request concurrently.
  -->
    <method name="Synthesize">
      <arg direction="in"  type="h" name="pipe_fd" />
      <arg direction="in"  type="s" name="text" />
      <arg direction="in"  type="s" name="voice_id" />
      <arg direction="in"  type="d" name="pitch" />
      <arg direction="in"  type="d" name="rate" />
      <arg direction="in"  type="b" name="is_ssml" />
      <arg direction="in"  type="s" name="language" />
    </method>

<!--
    Voices:

A list of voices the provider can use.

Each voice in the array is structure with the following members:
    <ul>
      <li>A human readable name</li>
      <li>A unique identifier</li>
      <li>Synthesis output format</li>
      <li>A voice features bit field</li>
      <li>A list of languages the voice support represented as BCP 47 tags</li>
    </ul>
  -->
    <property name="Voices" type="a(ssstas)" access="read"/>

<!--
    Name:

A localizable, human readable, name for this provider.
  -->
  <property name="Name" type="s" access="read"/>

<tp:flags name="VOICE_FEATURE" type="t">
      <tp:docstring>
        A bitfield of potential voice features that can be advertised to consumers.
      </tp:docstring>
      <tp:flag suffix="NONE" value="0x0">
        <tp:docstring>
          No features
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="EVENTS_WORD" value="0x1">
        <tp:docstring>
          Provider dispatches event when about to speak word.
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="EVENTS_SENTENCE" value="0x2">
        <tp:docstring>
          Provider dispatches event when about to speak sentence.
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="EVENTS_RANGE" value="0x4">
        <tp:docstring>
          Provider dispatches event when about to speak unspecified range.
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="EVENTS_SSML_MARK" value="0x8">
        <tp:docstring>
          Provider dispatches event when SSML mark is reached.
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_SAY_AS_DATE" value="0x10">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_SAY_AS_TIME" value="0x20">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_SAY_AS_TELEPHONE" value="0x40">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_SAY_AS_CHARACTERS" value="0x80">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_SAY_AS_CHARACTERS_GLYPHS" value="0x100">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_SAY_AS_CARDINAL" value="0x200">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_SAY_AS_ORDINAL" value="0x400">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_SAY_AS_CURRENCY" value="0x800">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_BREAK" value="0x1000">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_SUB" value="0x2000">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_PHONEME" value="0x4000">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_EMPHASIS" value="0x8000">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_PROSODY" value="0x10000">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_SENTENCE_PARAGRAPH" value="0x20000">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="SSML_TOKEN" value="0x40000">
        <tp:docstring>
        </tp:docstring>
      </tp:flag>
    </tp:flags>
  </interface>
</node>
07070100000016000041ED00000000000000000000000265D79E0600000000000000000000000000000000000000000000001E00000000spiel-1.0.0/libspeechprovider07070100000017000081A400000000000000000000000165D79E0600002C5E000000000000000000000000000000000000002600000000spiel-1.0.0/libspeechprovider/COPYING
                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

"Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

(a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
07070100000018000081A400000000000000000000000165D79E0600000CE9000000000000000000000000000000000000002A00000000spiel-1.0.0/libspeechprovider/meson.buildpython_module = import('python')
python = python_module.find_installation(
  'python3', required : true)
gen_enums = files(join_paths(meson.project_source_root(), 'interface', 'generate_enums.py'))
speech_provider_dbus_enums_h = custom_target(
    input: join_paths(meson.project_source_root(), 'interface', 'org.freedesktop.Speech.Provider.xml'),
    output: 'speech-provider-dbus-enums.h',
    command: [python, gen_enums, 'speech_provider', '@INPUT@', '@OUTPUT@'],
    install: true,
    install_dir: join_paths(get_option('includedir'), 'speech-provider')
)
speech_provider_dbus_enums_c = custom_target(
    input: join_paths(meson.project_source_root(), 'interface', 'org.freedesktop.Speech.Provider.xml'),
    output: 'speech-provider-dbus-enums.c',
    command: [python, gen_enums, 'speech_provider', '@INPUT@', '@OUTPUT@'],
    install: true,
    install_dir: join_paths(get_option('includedir'), 'speech-provider')
)

speech_provider_sources = [
  'speech-provider-stream-reader.c',
  'speech-provider-stream-writer.c',
  speech_provider_dbus_enums_c,
]

speech_provider_headers = [
  'speech-provider.h',
  'speech-provider-common.h',
  'speech-provider-stream-reader.h',
  'speech-provider-stream-writer.h',
]

version_split = meson.project_version().split('.')
version_conf = configuration_data()
version_conf.set('VERSION', meson.project_version())
version_conf.set('MAJOR_VERSION', version_split[0])
version_conf.set('MINOR_VERSION', version_split[1])
version_conf.set('MICRO_VERSION', version_split[2])

speech_provider_version_h = configure_file(
          input: 'speech-provider-version.h.in',
         output: 'speech-provider-version.h',
  configuration: version_conf,
        install: true,
    install_dir: join_paths(get_option('includedir'), 'speech-provider')
)

speech_provider_lib_generated = [
  speech_provider_version_h,
  speech_provider_dbus_enums_h,
  speech_provider_dbus_enums_c,
]

speech_provider_deps = [
  dependency('gobject-2.0'),
]

speech_provider_lib = shared_library('speech-provider-' + api_version,
  [speech_provider_sources, speech_provider_lib_generated],
  dependencies: speech_provider_deps,
  install: true,
)

speech_provider_lib_dep = declare_dependency(
  sources: speech_provider_lib_generated,
  dependencies: speech_provider_deps,
  link_with: speech_provider_lib,
  include_directories: include_directories('.'),
)

install_headers(speech_provider_headers, subdir: 'speech-provider')

pkg = import('pkgconfig')
pkg.generate(
  description: 'A shared library for speech synthesis clients',
    libraries: speech_provider_lib,
         name: 'speech-provider',
     filebase: 'speech-provider-' + api_version,
      version: meson.project_version(),
      subdirs: 'speech-provider',
     requires: 'gobject-2.0'
)

gnome = import('gnome')
speech_provider_gir = gnome.generate_gir(speech_provider_lib,
            sources: speech_provider_headers + speech_provider_sources + speech_provider_dbus_enums_h,
            nsversion: api_version,
            namespace: 'SpeechProvider',
            header: 'speech-provider/speech-provider.h',
        symbol_prefix: 'speech_provider',
    identifier_prefix: 'SpeechProvider',
             includes: [ 'GObject-2.0' ],
              install: true,
              export_packages: 'speech-provider',
)
07070100000019000081A400000000000000000000000165D79E06000005CE000000000000000000000000000000000000003700000000spiel-1.0.0/libspeechprovider/speech-provider-common.h/* speech-provider-common.h
 *
 * Copyright (C) 2024 Eitan Isaacson <eitan@monotonous.org>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#pragma once

G_BEGIN_DECLS

#define SPEECH_PROVIDER_STREAM_PROTOCOL_VERSION "0.01"

typedef struct __attribute__ ((__packed__))
{
  char version[4];
} SpeechProviderStreamHeader;

typedef enum __attribute__ ((__packed__))
{
  SPEECH_PROVIDER_CHUNK_TYPE_NONE,
  SPEECH_PROVIDER_CHUNK_TYPE_AUDIO,
  SPEECH_PROVIDER_CHUNK_TYPE_EVENT,
} SpeechProviderChunkType;

typedef enum __attribute__ ((__packed__))
{
  SPEECH_PROVIDER_EVENT_TYPE_NONE,
  SPEECH_PROVIDER_EVENT_TYPE_WORD,
  SPEECH_PROVIDER_EVENT_TYPE_SENTENCE,
  SPEECH_PROVIDER_EVENT_TYPE_RANGE,
  SPEECH_PROVIDER_EVENT_TYPE_MARK,
} SpeechProviderEventType;

typedef struct __attribute__ ((__packed__))
{
  guint8 event_type;
  guint32 range_start;
  guint32 range_end;
  guint32 mark_name_length;
} SpeechProviderEventData;

G_END_DECLS
0707010000001A000081A400000000000000000000000165D79E0600001EA0000000000000000000000000000000000000003E00000000spiel-1.0.0/libspeechprovider/speech-provider-stream-reader.c/* speech-provider-stream-reader.c
 *
 * Copyright (C) 2024 Eitan Isaacson <eitan@monotonous.org>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#include "speech-provider.h"

#include "speech-provider-stream-reader.h"

#include <fcntl.h>
#include <unistd.h>

struct _SpeechProviderStreamReader
{
  GObject parent_instance;
};

typedef struct
{
  gint fd;
  gboolean stream_header_recieved;
  SpeechProviderChunkType next_chunk_type;
} SpeechProviderStreamReaderPrivate;

G_DEFINE_FINAL_TYPE_WITH_PRIVATE (SpeechProviderStreamReader,
                                  speech_provider_stream_reader,
                                  G_TYPE_OBJECT)

enum
{
  PROP_0,
  PROP_FD,
  N_PROPS
};

static GParamSpec *properties[N_PROPS];

/**
 * speech_provider_stream_reader_new: (constructor)
 * @fd: The file descriptor for a pipe
 *
 * Creates a new #SpeechProviderStreamReader.
 *
 * Returns: The new #SpeechProviderStreamReader.
 */
SpeechProviderStreamReader *
speech_provider_stream_reader_new (gint fd)
{
  if (fcntl (fd, F_GETFD) == -1)
    {
      g_warning ("Bad file descriptor");
      return NULL;
    }

return g_object_new (SPEECH_PROVIDER_TYPE_STREAM_READER, "fd", fd, NULL);
}

/**
 * speech_provider_stream_reader_close:
 *
 * Close the pipe.
 *
 */
void
speech_provider_stream_reader_close (SpeechProviderStreamReader *self)
{
  SpeechProviderStreamReaderPrivate *priv =
      speech_provider_stream_reader_get_instance_private (self);
  close (priv->fd);
  priv->fd = -1;
}

/**
 * speech_provider_stream_reader_get_stream_header:
 *
 * Retrieves stream header.
 *
 * Returns: %TRUE if header successfully recieved.
 */
gboolean
speech_provider_stream_reader_get_stream_header (
    SpeechProviderStreamReader *self)
{
  SpeechProviderStreamReaderPrivate *priv =
      speech_provider_stream_reader_get_instance_private (self);
  SpeechProviderStreamHeader header;
  g_assert (!priv->stream_header_recieved);
  read (priv->fd, &header, sizeof (SpeechProviderStreamHeader));
  priv->stream_header_recieved = TRUE;
  return strncmp (header.version, SPEECH_PROVIDER_STREAM_PROTOCOL_VERSION, 4) ==
         0;
}

static SpeechProviderChunkType
_get_next_chunk_type (SpeechProviderStreamReader *self)
{
  SpeechProviderStreamReaderPrivate *priv =
      speech_provider_stream_reader_get_instance_private (self);
  if (priv->next_chunk_type == SPEECH_PROVIDER_CHUNK_TYPE_NONE)
    {
      read (priv->fd, &priv->next_chunk_type, sizeof (SpeechProviderChunkType));
    }
  return priv->next_chunk_type;
}

/**
 * speech_provider_stream_reader_get_audio:
 * @chunk: (out) (array length=chunk_size) (transfer full): Location to
 *        store audio data
 * @chunk_size: (out): Location to store size of chunk
 *
 * Retrieves audio data
 *
 * Returns: (skip): %TRUE if the call succeeds.
 */
gboolean
speech_provider_stream_reader_get_audio (SpeechProviderStreamReader *self,
                                         guint8 **chunk,
                                         guint32 *chunk_size)
{
  SpeechProviderStreamReaderPrivate *priv =
      speech_provider_stream_reader_get_instance_private (self);
  SpeechProviderChunkType chunk_type = _get_next_chunk_type (self);
  g_assert (priv->stream_header_recieved);
  if (chunk_type != SPEECH_PROVIDER_CHUNK_TYPE_AUDIO)
    {
      *chunk_size = 0;
      return FALSE;
    }

read (priv->fd, chunk_size, sizeof (guint32));
  *chunk = g_malloc (*chunk_size * sizeof (guint8));
  read (priv->fd, *chunk, *chunk_size * sizeof (guint8));
  priv->next_chunk_type = SPEECH_PROVIDER_CHUNK_TYPE_NONE;
  return TRUE;
}

/**
 * speech_provider_stream_reader_get_event:
 * @event_type: (out): type of event
 * @range_start: (out): text range start
 * @range_end: (out): text range end
 * @mark_name: (out): mark name
 *
 * Retrieves event data
 *
 * Returns: (skip): %TRUE if the call succeeds.
 */
gboolean
speech_provider_stream_reader_get_event (SpeechProviderStreamReader *self,
                                         SpeechProviderEventType *event_type,
                                         guint32 *range_start,
                                         guint32 *range_end,
                                         char **mark_name)
{
  SpeechProviderStreamReaderPrivate *priv =
      speech_provider_stream_reader_get_instance_private (self);
  SpeechProviderChunkType chunk_type = _get_next_chunk_type (self);
  SpeechProviderEventData event_data;
  g_assert (priv->stream_header_recieved);
  if (chunk_type != SPEECH_PROVIDER_CHUNK_TYPE_EVENT)
    {
      *event_type = SPEECH_PROVIDER_EVENT_TYPE_NONE;
      return FALSE;
    }
  read (priv->fd, &event_data, sizeof (SpeechProviderEventData));
  *event_type = event_data.event_type;
  *range_start = event_data.range_start;
  *range_end = event_data.range_end;
  *mark_name = NULL;
  if (event_data.mark_name_length)
    {
      char *name = g_malloc0 (event_data.mark_name_length * sizeof (char) + 1);
      read (priv->fd, name, event_data.mark_name_length * sizeof (char));
      *mark_name = name;
    }
  priv->next_chunk_type = SPEECH_PROVIDER_CHUNK_TYPE_NONE;
  return TRUE;
}

static void
speech_provider_stream_reader_get_property (GObject *object,
                                            guint prop_id,
                                            GValue *value,
                                            GParamSpec *pspec)
{
  SpeechProviderStreamReader *self = SPEECH_PROVIDER_STREAM_READER (object);
  SpeechProviderStreamReaderPrivate *priv =
      speech_provider_stream_reader_get_instance_private (self);

switch (prop_id)
    {
    case PROP_FD:
      g_value_set_int (value, priv->fd);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
speech_provider_stream_reader_set_property (GObject *object,
                                            guint prop_id,
                                            const GValue *value,
                                            GParamSpec *pspec)
{
  SpeechProviderStreamReader *self = SPEECH_PROVIDER_STREAM_READER (object);
  SpeechProviderStreamReaderPrivate *priv =
      speech_provider_stream_reader_get_instance_private (self);

switch (prop_id)
    {
    case PROP_FD:
      priv->fd = g_value_get_int (value);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
speech_provider_stream_reader_class_init (
    SpeechProviderStreamReaderClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

object_class->get_property = speech_provider_stream_reader_get_property;
  object_class->set_property = speech_provider_stream_reader_set_property;

/**
   * SpeechProviderStreamReader:fd:
   *
   * File descriptor for pipe
   *
   */
  properties[PROP_FD] =
      g_param_spec_int ("fd", NULL, NULL, -1, G_MAXINT32, 0,
                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY);

g_object_class_install_properties (object_class, N_PROPS, properties);
}

static void
speech_provider_stream_reader_init (SpeechProviderStreamReader *self)
{
  SpeechProviderStreamReaderPrivate *priv =
      speech_provider_stream_reader_get_instance_private (self);
  priv->stream_header_recieved = FALSE;
  priv->next_chunk_type = SPEECH_PROVIDER_CHUNK_TYPE_NONE;
}
0707010000001B000081A400000000000000000000000165D79E060000072A000000000000000000000000000000000000003E00000000spiel-1.0.0/libspeechprovider/speech-provider-stream-reader.h/* speech-provider-stream-reader.h
 *
 * Copyright (C) 2024 Eitan Isaacson <eitan@monotonous.org>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#pragma once

#include <glib-object.h>

G_BEGIN_DECLS

#define SPEECH_PROVIDER_TYPE_STREAM_READER                                     \
  (speech_provider_stream_reader_get_type ())

G_DECLARE_FINAL_TYPE (SpeechProviderStreamReader,
                      speech_provider_stream_reader,
                      SPEECH_PROVIDER,
                      STREAM_READER,
                      GObject)

SpeechProviderStreamReader *speech_provider_stream_reader_new (gint fd);

void speech_provider_stream_reader_close (SpeechProviderStreamReader *self);

gboolean speech_provider_stream_reader_get_stream_header (
    SpeechProviderStreamReader *self);

gboolean speech_provider_stream_reader_get_audio (
    SpeechProviderStreamReader *self, guint8 **chunk, guint32 *chunk_size);

gboolean
speech_provider_stream_reader_get_event (SpeechProviderStreamReader *self,
                                         SpeechProviderEventType *event_type,
                                         guint32 *range_start,
                                         guint32 *range_end,
                                         char **mark_name);

G_END_DECLS
0707010000001C000081A400000000000000000000000165D79E0600001BAE000000000000000000000000000000000000003E00000000spiel-1.0.0/libspeechprovider/speech-provider-stream-writer.c/* speech-provider-stream-writer.c
 *
 * Copyright (C) 2024 Eitan Isaacson <eitan@monotonous.org>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#include "speech-provider.h"

#include "speech-provider-stream-writer.h"

#include <fcntl.h>
#include <unistd.h>

struct _SpeechProviderStreamWriter
{
  GObject parent_instance;
};

typedef struct
{
  gint fd;
  gboolean stream_header_sent;
} SpeechProviderStreamWriterPrivate;

G_DEFINE_FINAL_TYPE_WITH_PRIVATE (SpeechProviderStreamWriter,
                                  speech_provider_stream_writer,
                                  G_TYPE_OBJECT)

enum
{
  PROP_0,
  PROP_FD,
  N_PROPS
};

static GParamSpec *properties[N_PROPS];

/**
 * speech_provider_stream_writer_new: (constructor)
 * @fd: The file descriptor for a pipe
 *
 * Creates a new #SpeechProviderStreamWriter.
 *
 * Returns: The new #SpeechProviderStreamWriter.
 */
SpeechProviderStreamWriter *
speech_provider_stream_writer_new (gint fd)
{
  if (fcntl (fd, F_GETFD) == -1)
    {
      g_warning ("Bad file descriptor");
      return NULL;
    }

return g_object_new (SPEECH_PROVIDER_TYPE_STREAM_WRITER, "fd", fd, NULL);
}

/**
 * speech_provider_stream_writer_close:
 *
 * Close the pipe.
 *
 */
void
speech_provider_stream_writer_close (SpeechProviderStreamWriter *self)
{
  SpeechProviderStreamWriterPrivate *priv =
      speech_provider_stream_writer_get_instance_private (self);
  close (priv->fd);
  priv->fd = -1;
}

/**
 * speech_provider_stream_writer_send_stream_header:
 *
 * Sends initial stream header
 *
 */
void
speech_provider_stream_writer_send_stream_header (
    SpeechProviderStreamWriter *self)
{
  SpeechProviderStreamWriterPrivate *priv =
      speech_provider_stream_writer_get_instance_private (self);
  SpeechProviderStreamHeader header = {
    .version = SPEECH_PROVIDER_STREAM_PROTOCOL_VERSION
  };
  g_assert (!priv->stream_header_sent);
  write (priv->fd, &header, sizeof (SpeechProviderStreamHeader));
  priv->stream_header_sent = TRUE;
}

/**
 * speech_provider_stream_writer_send_audio:
 * @chunk: (array length=chunk_size): audio data
 * @chunk_size: audio chunk size
 *
 * Sends audio chunk
 *
 */
void
speech_provider_stream_writer_send_audio (SpeechProviderStreamWriter *self,
                                          guint8 *chunk,
                                          guint32 chunk_size)
{
  SpeechProviderStreamWriterPrivate *priv =
      speech_provider_stream_writer_get_instance_private (self);
  SpeechProviderChunkType chunk_type = SPEECH_PROVIDER_CHUNK_TYPE_AUDIO;

g_assert (priv->stream_header_sent);

write (priv->fd, &chunk_type, sizeof (SpeechProviderChunkType));
  write (priv->fd, &chunk_size, sizeof (guint32));
  write (priv->fd, chunk, chunk_size);
}

/**
 * speech_provider_stream_writer_send_event:
 *
 * Sends event
 *
 */
void
speech_provider_stream_writer_send_event (SpeechProviderStreamWriter *self,
                                          SpeechProviderEventType event_type,
                                          guint32 range_start,
                                          guint32 range_end,
                                          const char *mark_name)
{
  SpeechProviderStreamWriterPrivate *priv =
      speech_provider_stream_writer_get_instance_private (self);
  SpeechProviderChunkType chunk_type = SPEECH_PROVIDER_CHUNK_TYPE_EVENT;
  SpeechProviderEventData event_data = { .event_type = event_type,
                                         .range_start = range_start,
                                         .range_end = range_end,
                                         .mark_name_length =
                                             g_utf8_strlen (mark_name, -1) };
  g_assert (priv->stream_header_sent);

write (priv->fd, &chunk_type, sizeof (SpeechProviderChunkType));
  write (priv->fd, &event_data, sizeof (SpeechProviderEventData));
  if (event_data.mark_name_length)
    {
      write (priv->fd, mark_name, event_data.mark_name_length);
    }
}

static void
speech_provider_stream_writer_finalize (GObject *object)
{
  SpeechProviderStreamWriter *self = (SpeechProviderStreamWriter *) object;
  SpeechProviderStreamWriterPrivate *priv =
      speech_provider_stream_writer_get_instance_private (self);

close (priv->fd);
  G_OBJECT_CLASS (speech_provider_stream_writer_parent_class)
      ->finalize (object);
}

static void
speech_provider_stream_writer_get_property (GObject *object,
                                            guint prop_id,
                                            GValue *value,
                                            GParamSpec *pspec)
{
  SpeechProviderStreamWriter *self = SPEECH_PROVIDER_STREAM_WRITER (object);
  SpeechProviderStreamWriterPrivate *priv =
      speech_provider_stream_writer_get_instance_private (self);

switch (prop_id)
    {
    case PROP_FD:
      g_value_set_int (value, priv->fd);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
speech_provider_stream_writer_set_property (GObject *object,
                                            guint prop_id,
                                            const GValue *value,
                                            GParamSpec *pspec)
{
  SpeechProviderStreamWriter *self = SPEECH_PROVIDER_STREAM_WRITER (object);
  SpeechProviderStreamWriterPrivate *priv =
      speech_provider_stream_writer_get_instance_private (self);

switch (prop_id)
    {
    case PROP_FD:
      priv->fd = g_value_get_int (value);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
speech_provider_stream_writer_class_init (
    SpeechProviderStreamWriterClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

object_class->finalize = speech_provider_stream_writer_finalize;
  object_class->get_property = speech_provider_stream_writer_get_property;
  object_class->set_property = speech_provider_stream_writer_set_property;

/**
   * SpeechProviderStreamWriter:fd:
   *
   * File descriptor for pipe
   *
   */
  properties[PROP_FD] =
      g_param_spec_int ("fd", NULL, NULL, -1, G_MAXINT32, 0,
                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY);

g_object_class_install_properties (object_class, N_PROPS, properties);
}

static void
speech_provider_stream_writer_init (SpeechProviderStreamWriter *self)
{
  SpeechProviderStreamWriterPrivate *priv =
      speech_provider_stream_writer_get_instance_private (self);
  priv->stream_header_sent = FALSE;
}
0707010000001D000081A400000000000000000000000165D79E060000077E000000000000000000000000000000000000003E00000000spiel-1.0.0/libspeechprovider/speech-provider-stream-writer.h/* speech-provider-stream-writer.h
 *
 * Copyright (C) 2024 Eitan Isaacson <eitan@monotonous.org>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#pragma once

#include <glib-object.h>

G_BEGIN_DECLS

#define SPEECH_PROVIDER_TYPE_STREAM_WRITER                                     \
  (speech_provider_stream_writer_get_type ())

G_DECLARE_FINAL_TYPE (SpeechProviderStreamWriter,
                      speech_provider_stream_writer,
                      SPEECH_PROVIDER,
                      STREAM_WRITER,
                      GObject)

SpeechProviderStreamWriter *speech_provider_stream_writer_new (gint fd);

void speech_provider_stream_writer_close (SpeechProviderStreamWriter *self);

void speech_provider_stream_writer_send_stream_header (
    SpeechProviderStreamWriter *self);

void speech_provider_stream_writer_send_audio (SpeechProviderStreamWriter *self,
                                               guint8 *chunk,
                                               guint32 chunk_size);

void
speech_provider_stream_writer_send_event (SpeechProviderStreamWriter *self,
                                          SpeechProviderEventType event_type,
                                          guint32 range_start,
                                          guint32 range_end,
                                          const char *mark_name);

G_END_DECLS
0707010000001E000081A400000000000000000000000165D79E06000009A1000000000000000000000000000000000000003B00000000spiel-1.0.0/libspeechprovider/speech-provider-version.h.in
#pragma once

#if !defined(LIBSPEECHPROVIDER_INSIDE) && !defined(SPEECH_PROVIDER_COMPILATION)
#error "Only <speech-provider.h> can be included directly."
#endif

/**
 * SECTION:speech-providerversion
 * @short_description: speech-provider version checking
 *
 * speech-provider provides macros to check the version of the library
 * at compile-time
 */

/**
 * SPEECH_PROVIDER_MAJOR_VERSION:
 *
 * speech-provider major version component (e.g. 1 if %SPEECH_PROVIDER_VERSION is 1.2.3)
 */
#define SPEECH_PROVIDER_MAJOR_VERSION (@MAJOR_VERSION @)

/**
 * SPEECH_PROVIDER_MINOR_VERSION:
 *
 * speech-provider minor version component (e.g. 2 if %SPEECH_PROVIDER_VERSION is 1.2.3)
 */
#define SPEECH_PROVIDER_MINOR_VERSION (@MINOR_VERSION @)

/**
 * SPEECH_PROVIDER_MICRO_VERSION:
 *
 * speech-provider micro version component (e.g. 3 if %SPEECH_PROVIDER_VERSION is 1.2.3)
 */
#define SPEECH_PROVIDER_MICRO_VERSION (@MICRO_VERSION @)

/**
 * SPEECH_PROVIDER_VERSION
 *
 * speech-provider version.
 */
#define SPEECH_PROVIDER_VERSION (@VERSION @)

/**
 * SPEECH_PROVIDER_VERSION_S:
 *
 * speech-provider version, encoded as a string, useful for printing and
 * concatenation.
 */
#define SPEECH_PROVIDER_VERSION_S "@VERSION@"

#define SPEECH_PROVIDER_ENCODE_VERSION(major, minor, micro)                              \
  ((major) << 24 | (minor) << 16 | (micro) << 8)

/**
 * SPEECH_PROVIDER_VERSION_HEX:
 *
 * speech-provider version, encoded as an hexadecimal number, useful for
 * integer comparisons.
 */
#define SPEECH_PROVIDER_VERSION_HEX                                                      \
  (SPEECH_PROVIDER_ENCODE_VERSION (SPEECH_PROVIDER_MAJOR_VERSION, SPEECH_PROVIDER_MINOR_VERSION,             \
                         SPEECH_PROVIDER_MICRO_VERSION))

/**
 * SPEECH_PROVIDER_CHECK_VERSION:
 * @major: required major version
 * @minor: required minor version
 * @micro: required micro version
 *
 * Compile-time version checking. Evaluates to %TRUE if the version
 * of speech-provider is greater than the required one.
 */
#define SPEECH_PROVIDER_CHECK_VERSION(major, minor, micro)                               \
  (SPEECH_PROVIDER_MAJOR_VERSION > (major) ||                                            \
   (SPEECH_PROVIDER_MAJOR_VERSION == (major) && SPEECH_PROVIDER_MINOR_VERSION > (minor)) ||        \
   (SPEECH_PROVIDER_MAJOR_VERSION == (major) && SPEECH_PROVIDER_MINOR_VERSION == (minor) &&        \
    SPEECH_PROVIDER_MICRO_VERSION >= (micro)))
0707010000001F000081A400000000000000000000000165D79E06000003A8000000000000000000000000000000000000003000000000spiel-1.0.0/libspeechprovider/speech-provider.h/* speech-provider.h
 *
 * Copyright (C) 2024 Eitan Isaacson <eitan@monotonous.org>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#pragma once

#include <glib.h>

G_BEGIN_DECLS

#define LIBSPEECHPROVIDER_INSIDE
#include "speech-provider-common.h"
#include "speech-provider-stream-reader.h"
#include "speech-provider-stream-writer.h"
#undef LIBSPEECHPROVIDER_INSIDE

G_END_DECLS
07070100000020000041ED00000000000000000000000265D79E0600000000000000000000000000000000000000000000001500000000spiel-1.0.0/libspiel07070100000021000081A400000000000000000000000165D79E0600001126000000000000000000000000000000000000002100000000spiel-1.0.0/libspiel/meson.buildgnome = import('gnome')

spiel_iface_sources = gnome.gdbus_codegen(
    'spiel-provider-proxy',
    join_paths(meson.project_source_root(), 'interface', 'org.freedesktop.Speech.Provider.xml'),
    interface_prefix: 'org.freedesktop.Speech.',
    namespace: 'Spiel',
    annotations : [
      ['org.freedesktop.Speech.Provider', 'org.gtk.GDBus.C.Name', 'ProviderProxy']
    ],
    extra_args: '--glib-min-required=2.64')

python_module = import('python')
python = python_module.find_installation(
  'python3', required : true)
gen_enums = files(join_paths(meson.project_source_root(), 'interface', 'generate_enums.py'))
spiel_dbus_enums_h = custom_target(
    input: join_paths(meson.project_source_root(), 'interface', 'org.freedesktop.Speech.Provider.xml'),
    output: 'spiel-dbus-enums.h',
    command: [python, gen_enums, 'spiel', '@INPUT@', '@OUTPUT@'],
    install: true,
    install_dir: join_paths(get_option('includedir'), 'spiel')
)
spiel_dbus_enums_c = custom_target(
    input: join_paths(meson.project_source_root(), 'interface', 'org.freedesktop.Speech.Provider.xml'),
    output: 'spiel-dbus-enums.c',
    command: [python, gen_enums, 'spiel', '@INPUT@', '@OUTPUT@'],
    install: true,
    install_dir: join_paths(get_option('includedir'), 'spiel')
)

spiel_public_sources = [
  'spiel-utterance.c',
  'spiel-voice.c',
  'spiel-speaker.c',
  'spiel-provider.c',
  'spiel-voices-list-model.c',
]

spiel_sources = [
  spiel_public_sources,
  'spiel-registry.c',
  'spiel-collect-providers.c',
  'spiel-provider-src.c',
  spiel_iface_sources,
  spiel_dbus_enums_c,
]

spiel_public_headers = [
  'spiel.h',
  'spiel-utterance.h',
  'spiel-voice.h',
  'spiel-speaker.h',
  'spiel-provider.h',
  'spiel-voices-list-model.h',
]

spiel_headers = [
  spiel_public_headers,
  'spiel-registry.h',
  'spiel-collect-providers.h',
  'spiel-provider-src.h',
  'spiel-provider-private.h',
]

spiel_version_h = configure_file(
          input: 'spiel-version.h.in',
         output: 'spiel-version.h',
  configuration: version_conf,
        install: true,
    install_dir: join_paths(get_option('includedir'), 'spiel')
)

spiel_lib_generated = [
  spiel_version_h,
  spiel_dbus_enums_h,
  spiel_dbus_enums_c,
]

spiel_deps = [
  dependency('gio-2.0'),
  dependency('gio-unix-2.0'),
  dependency('gstreamer-1.0'),
  dependency('gstreamer-audio-1.0'),
  speech_provider_lib_dep
]

spiel_lib = shared_library('spiel-' + api_version,
  spiel_sources,
  dependencies: spiel_deps,
  include_directories: include_directories('../interface'),
  install: true,
)

spiel_lib_dep = declare_dependency(
  sources: spiel_lib_generated,
  dependencies: spiel_deps,
  link_with: spiel_lib,
  include_directories: include_directories('.'),
)

install_headers(spiel_public_headers, subdir: 'spiel')

pkg = import('pkgconfig')
pkg.generate(
  description: 'A shared library for speech synthesis clients',
    libraries: spiel_lib,
         name: 'spiel',
     filebase: 'spiel-' + api_version,
      version: meson.project_version(),
      subdirs: 'spiel',
     requires: 'gio-2.0'
)

spiel_gir = gnome.generate_gir(spiel_lib,
            sources: spiel_public_headers + spiel_public_sources + spiel_dbus_enums_h,
            nsversion: api_version,
            namespace: 'Spiel',
            header: 'spiel/spiel.h',
        symbol_prefix: 'spiel',
    identifier_prefix: 'Spiel',
             includes: [ 'Gio-2.0' ],
              install: true,
              export_packages: 'spiel',
)

schemas_dir = join_paths(get_option('datadir'), 'glib-2.0/schemas')
install_data('org.monotonous.libspiel.gschema.xml',
  install_dir: schemas_dir
)

gnome.compile_schemas(build_by_default: true, depend_files: 'org.monotonous.libspiel.gschema.xml')

gnome.post_install(glib_compile_schemas: true)

compile_schemas = find_program('glib-compile-schemas', required: false)
if compile_schemas.found()
  # meson.add_install_script('glib-compile-schemas', join_paths(get_option('prefix'), schemas_dir))
  test('Validate schema file', compile_schemas,
    args: ['--strict', '--dry-run', meson.current_source_dir()]
  )
endif07070100000022000081A400000000000000000000000165D79E0600000298000000000000000000000000000000000000003900000000spiel-1.0.0/libspiel/org.monotonous.libspiel.gschema.xml<?xml version="1.0" encoding="UTF-8"?>
<schemalist gettext-domain="libspiel">
    <schema id='org.monotonous.libspiel' path='/org/monotonous/libspiel/'>
        <key name="default-voice" type="m(ss)">
            <default>nothing</default>
            <summary>Default voice</summary>
            <description>The default voice to be used</description>
        </key>
        <key name="language-voice-mapping" type="a{s(ss)}">
            <default>{}</default>
            <summary>Language/voice mapping</summary>
            <description>Maping of BCP-47 language tags and the voices that should be used.</description>
        </key>
    </schema>
</schemalist>07070100000023000081A400000000000000000000000165D79E0600003420000000000000000000000000000000000000002F00000000spiel-1.0.0/libspiel/spiel-collect-providers.c/* spiel-collect-providers.c
 *
 * Copyright (C) 2024 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "spiel-collect-providers.h"

#include "spiel-provider-private.h"
#include "spiel-provider-proxy.h"

typedef struct
{
  GCancellable *cancellable;
  GHashTable *providers;
  GList *providers_to_process;
  char *provider_name;
} _CollectProvidersClosure;

static void
_collect_providers_closure_destroy (gpointer data)
{
  _CollectProvidersClosure *closure = data;
  g_clear_object (&closure->cancellable);
  g_hash_table_unref (closure->providers);
  if (closure->providers_to_process)
    {
      g_list_free (closure->providers_to_process);
    }

if (closure->provider_name)
    {
      g_free (closure->provider_name);
    }

g_slice_free (_CollectProvidersClosure, closure);
}

static void _on_list_activatable_names (GObject *source,
                                        GAsyncResult *result,
                                        gpointer user_data);

static gboolean _collect_provider_names (GObject *source,
                                         GAsyncResult *result,
                                         GTask *task,
                                         gboolean activatable);

static void _on_provider_created (GObject *source,
                                  GAsyncResult *result,
                                  gpointer user_data);

static void _create_next_provider (_CollectProvidersClosure *closure,
                                   GTask *task);

static void _create_provider (_CollectProvidersClosure *closure, GTask *task);

static void
_on_list_names (GObject *source, GAsyncResult *result, gpointer user_data);

static void _spiel_collect_providers (GDBusConnection *connection,
                                      GCancellable *cancellable,
                                      const char *provider_name,
                                      GAsyncReadyCallback callback,
                                      gpointer user_data);

void
spiel_collect_providers (GDBusConnection *connection,
                         GCancellable *cancellable,
                         GAsyncReadyCallback callback,
                         gpointer user_data)
{
  _spiel_collect_providers (connection, cancellable, NULL, callback, user_data);
}

void
spiel_collect_provider (GDBusConnection *connection,
                        GCancellable *cancellable,
                        const char *provider_name,
                        GAsyncReadyCallback callback,
                        gpointer user_data)
{
  _spiel_collect_providers (connection, cancellable, provider_name, callback,
                            user_data);
}

static void
_spiel_collect_providers (GDBusConnection *connection,
                          GCancellable *cancellable,
                          const char *provider_name,
                          GAsyncReadyCallback callback,
                          gpointer user_data)
{
  GTask *task = g_task_new (connection, cancellable, callback, user_data);
  _CollectProvidersClosure *closure = g_slice_new0 (_CollectProvidersClosure);

closure->providers = g_hash_table_new_full (g_str_hash, g_str_equal, g_free,
                                              (GDestroyNotify) g_object_unref);
  closure->cancellable = cancellable ? g_object_ref (cancellable) : NULL;

if (provider_name)
    {
      closure->provider_name = g_strdup (provider_name);
    }

g_task_set_task_data (task, closure,
                        (GDestroyNotify) _collect_providers_closure_destroy);
  g_dbus_connection_call (connection, "org.freedesktop.DBus",
                          "/org/freedesktop/DBus", "org.freedesktop.DBus",
                          "ListActivatableNames", NULL, NULL,
                          G_DBUS_CALL_FLAGS_NONE, -1, closure->cancellable,
                          _on_list_activatable_names, task);
}

static void
_on_list_activatable_names (GObject *source,
                            GAsyncResult *result,
                            gpointer user_data)
{
  GTask *task = user_data;
  _CollectProvidersClosure *closure = g_task_get_task_data (task);
  GDBusConnection *connection = g_task_get_source_object (task);

if (!_collect_provider_names (source, result, user_data, TRUE))
    {
      return;
    }

g_dbus_connection_call (connection, "org.freedesktop.DBus",
                          "/org/freedesktop/DBus", "org.freedesktop.DBus",
                          "ListNames", NULL, NULL, G_DBUS_CALL_FLAGS_NONE, -1,
                          closure->cancellable, _on_list_names, task);
}

static void
_on_list_names (GObject *source, GAsyncResult *result, gpointer user_data)
{
  GTask *task = user_data;
  _CollectProvidersClosure *closure = g_task_get_task_data (task);

if (!_collect_provider_names (source, result, user_data, FALSE))
    {
      return;
    }

closure->providers_to_process = g_hash_table_get_keys (closure->providers);

if (!closure->providers_to_process)
    {
      g_task_return_pointer (task, NULL, NULL);
      g_object_unref (task);
    }
  else
    {
      _create_provider (closure, task);
    }
}

static void
_create_next_provider (_CollectProvidersClosure *closure, GTask *task)
{
  GList *next_provider = closure->providers_to_process;
  closure->providers_to_process =
      g_list_remove_link (closure->providers_to_process, next_provider);
  g_list_free (next_provider);

if (closure->providers_to_process)
    {
      _create_provider (closure, task);
      return;
    }

// All done, lets return from the task
  if (closure->provider_name)
    {
      // If a provider name is specified we return a single result.
      SpielProvider *provider =
          g_hash_table_lookup (closure->providers, closure->provider_name);
      g_hash_table_steal (closure->providers, closure->provider_name);
      g_assert_cmpint (g_hash_table_size (closure->providers), ==, 0);
      g_task_return_pointer (task, provider, (GDestroyNotify) g_object_unref);
      g_object_unref (task);
    }
  else
    {
      // If no provider name was specified we return a hash table of
      // results.
      g_task_return_pointer (task, g_hash_table_ref (closure->providers),
                             (GDestroyNotify) g_hash_table_unref);
      g_object_unref (task);
    }
}

static char *
_object_path_from_service_name (const char *service_name)
{
  char **split_name = g_strsplit (service_name, ".", 0);
  g_autofree char *partial_path = g_strjoinv ("/", split_name);
  char *obj_path = g_strdup_printf ("/%s", partial_path);
  g_strfreev (split_name);
  return obj_path;
}

static void
_create_provider (_CollectProvidersClosure *closure, GTask *task)
{
  GList *next_provider = closure->providers_to_process;
  const char *service_name = next_provider->data;
  g_autofree char *obj_path = _object_path_from_service_name (service_name);

spiel_provider_proxy_proxy_new_for_bus (G_BUS_TYPE_SESSION, 0, service_name,
                                          obj_path, closure->cancellable,
                                          _on_provider_created, task);
}

static void
_on_provider_created (GObject *source, GAsyncResult *result, gpointer user_data)
{
  GTask *task = user_data;
  _CollectProvidersClosure *closure = g_task_get_task_data (task);
  const char *service_name = closure->providers_to_process->data;
  g_autoptr (GError) error = NULL;
  g_autoptr (SpielProviderProxy) provider_proxy =
      spiel_provider_proxy_proxy_new_for_bus_finish (result, &error);

if (error != NULL)
    {
      if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
        {
          // If we are cancelled, return from this task.
          g_task_return_error (task, error);
          return;
        }
      else
        {
          // Otherwise, just warn and move on to the next provider.
          g_warning ("Error creating proxy for '%s': %s\n", service_name,
                     error->message);
        }
    }
  else
    {
      SpielProvider *provider =
          g_hash_table_lookup (closure->providers, service_name);

g_assert (provider);
      g_assert (g_str_equal (
          g_dbus_proxy_get_name (G_DBUS_PROXY (provider_proxy)), service_name));

if (provider)
        {
          spiel_provider_set_proxy (provider, provider_proxy);
        }
    }

_create_next_provider (closure, task);
}

static gboolean
_collect_provider_names (GObject *source,
                         GAsyncResult *result,
                         GTask *task,
                         gboolean activatable)
{
  _CollectProvidersClosure *closure = g_task_get_task_data (task);
  GError *error = NULL;
  GDBusConnection *bus = G_DBUS_CONNECTION (source);
  g_autoptr (GVariant) real_ret = NULL;
  GVariantIter iter;
  GVariant *service = NULL;
  g_autoptr (GVariant) ret =
      g_dbus_connection_call_finish (bus, result, &error);
  if (error != NULL)
    {
      g_task_return_error (task, error);
      g_object_unref (task);
      return FALSE;
    }

real_ret = g_variant_get_child_value (ret, 0);

g_variant_iter_init (&iter, real_ret);
  while ((service = g_variant_iter_next_value (&iter)))
    {
      const char *service_name = g_variant_get_string (service, NULL);
      if (g_str_has_suffix (service_name, PROVIDER_SUFFIX) &&
          (!closure->provider_name ||
           g_str_equal (closure->provider_name, service_name)))
        {
          SpielProvider *provider =
              g_hash_table_lookup (closure->providers, service_name);
          if (!provider)
            {
              provider = spiel_provider_new ();
              g_hash_table_insert (closure->providers, g_strdup (service_name),
                                   provider);
            }
          if (activatable)
            {
              spiel_provider_set_is_activatable (provider, TRUE);
            }
        }
      g_variant_unref (service);
    }

return TRUE;
}

GHashTable *
spiel_collect_providers_finish (GAsyncResult *res, GError **error)
{
  return g_task_propagate_pointer (G_TASK (res), error);
}

SpielProvider *
spiel_collect_provider_finish (GAsyncResult *res, GError **error)
{
  return g_task_propagate_pointer (G_TASK (res), error);
}

GHashTable *
spiel_collect_providers_sync (GDBusConnection *connection,
                              GCancellable *cancellable,
                              GError **error)
{
  g_autoptr (GHashTable) providers = g_hash_table_new_full (
      g_str_hash, g_str_equal, g_free, (GDestroyNotify) g_object_unref);
  const char *list_name_methods[] = { "ListActivatableNames", "ListNames",
                                      NULL };
  for (const char **method = list_name_methods; *method; method++)
    {
      g_autoptr (GVariant) real_ret = NULL;
      GVariantIter iter;
      GVariant *service = NULL;
      g_autoptr (GVariant) ret = g_dbus_connection_call_sync (
          connection, "org.freedesktop.DBus", "/org/freedesktop/DBus",
          "org.freedesktop.DBus", *method, NULL, NULL, G_DBUS_CALL_FLAGS_NONE,
          -1, NULL, error);
      if (error && *error)
        {
          g_warning ("Error calling list (%s): %s\n", *method,
                     (*error)->message);
          return NULL;
        }

real_ret = g_variant_get_child_value (ret, 0);

g_variant_iter_init (&iter, real_ret);
      while ((service = g_variant_iter_next_value (&iter)) &&
             !g_cancellable_is_cancelled (cancellable))
        {
          const char *service_name = g_variant_get_string (service, NULL);
          g_autofree char *obj_path = NULL;
          SpielProvider *provider = NULL;
          SpielProviderProxy *provider_proxy = NULL;
          g_autoptr (GError) err = NULL;

if (!g_str_has_suffix (service_name, PROVIDER_SUFFIX) ||
              g_hash_table_contains (providers, service_name))
            {
              continue;
            }
          obj_path = _object_path_from_service_name (service_name);
          provider_proxy = spiel_provider_proxy_proxy_new_sync (
              connection, 0, service_name, obj_path, cancellable, &err);

if (err)
            {
              g_warning ("Error creating proxy for '%s': %s\n", service_name,
                         err->message);
              continue;
            }

provider = spiel_provider_new ();
          spiel_provider_set_proxy (provider, provider_proxy);
          spiel_provider_set_is_activatable (
              provider, g_str_equal (*method, "ListActivatableNames"));
          g_hash_table_insert (providers, g_strdup (service_name), provider);
          g_variant_unref (service);
        }
    }

return g_steal_pointer (&providers);
}07070100000024000081A400000000000000000000000165D79E060000073E000000000000000000000000000000000000002F00000000spiel-1.0.0/libspiel/spiel-collect-providers.h/* spiel-collect-providers.h
 *
 * Copyright (C) 2024 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <gio/gio.h>

typedef struct _SpielProviderProxy SpielProviderProxy;
typedef struct _SpielProvider SpielProvider;

#define PROVIDER_SUFFIX ".Speech.Provider"

void spiel_collect_providers (GDBusConnection *connection,
                              GCancellable *cancellable,
                              GAsyncReadyCallback callback,
                              gpointer user_data);

GHashTable *spiel_collect_providers_finish (GAsyncResult *res, GError **error);

GHashTable *spiel_collect_providers_sync (GDBusConnection *connection,
                                          GCancellable *cancellable,
                                          GError **error);

void spiel_collect_provider (GDBusConnection *connection,
                             GCancellable *cancellable,
                             const char *provider_name,
                             GAsyncReadyCallback callback,
                             gpointer user_data);

SpielProvider *spiel_collect_provider_finish (GAsyncResult *res,
                                              GError **error);
07070100000025000081A400000000000000000000000165D79E0600000644000000000000000000000000000000000000002E00000000spiel-1.0.0/libspiel/spiel-provider-private.h/* spiel-provider-private.h
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include "spiel-provider.h"

typedef struct _SpielProviderProxy SpielProviderProxy;
typedef struct _SpielVoice SpielVoice;

SpielProvider *spiel_provider_new (void);

void spiel_provider_set_proxy (SpielProvider *self,
                               SpielProviderProxy *provider_proxy);

SpielProviderProxy *spiel_provider_get_proxy (SpielProvider *self);

SpielVoice *spiel_provider_get_voice_by_id (SpielProvider *self,
                                            const char *voice_id);

void spiel_provider_set_is_activatable (SpielProvider *self,
                                        gboolean is_activatable);

gboolean spiel_provider_get_is_activatable (SpielProvider *self);

gint spiel_provider_compare (SpielProvider *self,
                             SpielProvider *other,
                             gpointer user_data);07070100000026000081A400000000000000000000000165D79E0600001E8F000000000000000000000000000000000000002A00000000spiel-1.0.0/libspiel/spiel-provider-src.c/* spiel-provider-src.c
 *
 * Copyright (C) 2024 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <fcntl.h>
#include <unistd.h>

#include "spiel-provider-src.h"

static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE (
    "src", GST_PAD_SRC, GST_PAD_ALWAYS, GST_STATIC_CAPS_ANY);

#define DEFAULT_FD 0

enum
{
  PROP_0,

PROP_FD,

PROP_LAST
};

#define spiel_provider_src_parent_class parent_class
G_DEFINE_TYPE (SpielProviderSrc, spiel_provider_src, GST_TYPE_PUSH_SRC);

SpielProviderSrc *
spiel_provider_src_new (gint fd)
{
  return g_object_new (SPIEL_TYPE_PROVIDER_SRC, "fd", fd, NULL);
}

static void spiel_provider_src_set_property (GObject *object,
                                             guint prop_id,
                                             const GValue *value,
                                             GParamSpec *pspec);
static void spiel_provider_src_get_property (GObject *object,
                                             guint prop_id,
                                             GValue *value,
                                             GParamSpec *pspec);
static void spiel_provider_src_dispose (GObject *obj);

static gboolean spiel_provider_src_start (GstBaseSrc *bsrc);
static gboolean spiel_provider_src_stop (GstBaseSrc *bsrc);
static gboolean spiel_provider_src_unlock (GstBaseSrc *bsrc);
static gboolean spiel_provider_src_unlock_stop (GstBaseSrc *bsrc);
static gboolean spiel_provider_src_get_size (GstBaseSrc *src, guint64 *size);

static GstFlowReturn spiel_provider_src_create (GstPushSrc *psrc,
                                                GstBuffer **outbuf);

static void
spiel_provider_src_class_init (SpielProviderSrcClass *klass)
{
  GObjectClass *gobject_class;
  GstElementClass *gstelement_class;
  GstBaseSrcClass *gstbasesrc_class;
  GstPushSrcClass *gstpush_src_class;

gobject_class = G_OBJECT_CLASS (klass);
  gstelement_class = GST_ELEMENT_CLASS (klass);
  gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
  gstpush_src_class = GST_PUSH_SRC_CLASS (klass);

gobject_class->set_property = spiel_provider_src_set_property;
  gobject_class->get_property = spiel_provider_src_get_property;
  gobject_class->dispose = spiel_provider_src_dispose;

g_object_class_install_property (
      gobject_class, PROP_FD,
      g_param_spec_int ("fd", "fd", "An open file descriptor to read from", 0,
                        G_MAXINT, DEFAULT_FD,
                        G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
                            G_PARAM_CONSTRUCT_ONLY));

gst_element_class_set_static_metadata (
      gstelement_class, "Spiel Provider Source", "Source",
      "Read specialized audio/event chunks from pipe",
      "Eitan Isaacson <eitan@monotonous.org>");
  gst_element_class_add_static_pad_template (gstelement_class, &srctemplate);

gstbasesrc_class->start = GST_DEBUG_FUNCPTR (spiel_provider_src_start);
  gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (spiel_provider_src_stop);
  gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (spiel_provider_src_unlock);
  gstbasesrc_class->unlock_stop =
      GST_DEBUG_FUNCPTR (spiel_provider_src_unlock_stop);
  gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (spiel_provider_src_get_size);

gstpush_src_class->create = GST_DEBUG_FUNCPTR (spiel_provider_src_create);
}

static void
spiel_provider_src_init (SpielProviderSrc *spsrc)
{
  spsrc->curoffset = 0;
  spsrc->reader = NULL;
}

static void
spiel_provider_src_dispose (GObject *obj)
{
  SpielProviderSrc *src = SPIEL_PROVIDER_SRC (obj);
  g_object_unref (src->reader);

G_OBJECT_CLASS (parent_class)->dispose (obj);
}

static gboolean
spiel_provider_src_start (GstBaseSrc *bsrc)
{
  SpielProviderSrc *src = SPIEL_PROVIDER_SRC (bsrc);
  gboolean got_header =
      speech_provider_stream_reader_get_stream_header (src->reader);
  return got_header;
}

static gboolean
spiel_provider_src_stop (GstBaseSrc *bsrc)
{
  // XXX: Do we need this?
  return TRUE;
}

static gboolean
spiel_provider_src_unlock (GstBaseSrc *bsrc)
{
  // XXX: Do we need this?
  return TRUE;
}

static gboolean
spiel_provider_src_unlock_stop (GstBaseSrc *bsrc)
{
  // XXX: Do we need this?
  return TRUE;
}

static void
spiel_provider_src_set_property (GObject *object,
                                 guint prop_id,
                                 const GValue *value,
                                 GParamSpec *pspec)
{
  SpielProviderSrc *src = SPIEL_PROVIDER_SRC (object);

switch (prop_id)
    {
    case PROP_FD:

GST_OBJECT_LOCK (object);
      g_assert (src->reader == NULL);
      src->fd = g_value_get_int (value);
      src->reader = speech_provider_stream_reader_new (src->fd);
      GST_OBJECT_UNLOCK (object);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
spiel_provider_src_get_property (GObject *object,
                                 guint prop_id,
                                 GValue *value,
                                 GParamSpec *pspec)
{
  SpielProviderSrc *src = SPIEL_PROVIDER_SRC (object);

switch (prop_id)
    {
    case PROP_FD:
      g_value_set_int (value, src->fd);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static GstFlowReturn
spiel_provider_src_create (GstPushSrc *psrc, GstBuffer **outbuf)
{
  SpielProviderSrc *src;

src = SPIEL_PROVIDER_SRC (psrc);

while (TRUE)
    {
      guint8 *chunk;
      guint32 chunk_size;
      SpeechProviderEventType event_type;
      guint32 range_start;
      guint32 range_end;
      g_autofree char *mark_name = NULL;
      gboolean got_event, got_audio;
      got_event = speech_provider_stream_reader_get_event (
          src->reader, &event_type, &range_start, &range_end, &mark_name);
      if (got_event)
        {
          gst_element_post_message (
              GST_ELEMENT_CAST (src),
              gst_message_new_element (
                  GST_OBJECT_CAST (src),
                  gst_structure_new ("SpielGoingToSpeak", "event_type",
                                     G_TYPE_UINT, event_type, "range_start",
                                     G_TYPE_UINT, range_start, "range_end",
                                     G_TYPE_UINT, range_end, "mark_name",
                                     G_TYPE_STRING, mark_name, NULL)));
        }

got_audio = speech_provider_stream_reader_get_audio (src->reader, &chunk,
                                                           &chunk_size);
      if (got_audio && chunk_size > 0)
        {
          GstBuffer *buf = gst_buffer_new_wrapped (chunk, chunk_size);

GST_BUFFER_OFFSET (buf) = src->curoffset;
          GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
          src->curoffset += chunk_size;

*outbuf = buf;

return GST_FLOW_OK;
        }

if (!got_audio && !got_event)
        {
          GST_DEBUG_OBJECT (psrc, "Read 0 bytes. EOS.");
          return GST_FLOW_EOS;
        }
    }

return GST_FLOW_OK;
}

static gboolean
spiel_provider_src_get_size (GstBaseSrc *bsrc, guint64 *size)
{
  // XXX: Get rid of this?
  return FALSE;
}
07070100000027000081A400000000000000000000000165D79E0600000916000000000000000000000000000000000000002A00000000spiel-1.0.0/libspiel/spiel-provider-src.h/* spiel-provider-src.c
 *
 * Copyright (C) 2024 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __SPIEL_PROVIDER_SRC_H__
#define __SPIEL_PROVIDER_SRC_H__

#include <gst/base/gstpushsrc.h>
#include <gst/gst.h>
#include <speech-provider.h>

G_BEGIN_DECLS

#define SPIEL_TYPE_PROVIDER_SRC (spiel_provider_src_get_type ())
#define SPIEL_PROVIDER_SRC(obj)                                                \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), SPIEL_TYPE_PROVIDER_SRC,                 \
                               SpielProviderSrc))
#define SPIEL_PROVIDER_SRC_CLASS(klass)                                        \
  (G_TYPE_CHECK_CLASS_CAST ((klass), SPIEL_TYPE_PROVIDER_SRC,                  \
                            SpielProviderSrcClass))
#define GST_IS_FD_SRC(obj)                                                     \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SPIEL_TYPE_PROVIDER_SRC))
#define GST_IS_FD_SRC_CLASS(klass)                                             \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), SPIEL_TYPE_PROVIDER_SRC))

typedef struct _SpielProviderSrc SpielProviderSrc;
typedef struct _SpielProviderSrcClass SpielProviderSrcClass;

/**
 * SpielProviderSrc:
 *
 * Opaque #SpielProviderSrc data structure.
 */
struct _SpielProviderSrc
{
  GstPushSrc element;

/* fd and flag indicating whether fd is seekable */
  gint fd;

gulong curoffset; /* current offset in file */

SpeechProviderStreamReader *reader;
};

struct _SpielProviderSrcClass
{
  GstPushSrcClass parent_class;
};

G_GNUC_INTERNAL GType spiel_provider_src_get_type (void);

SpielProviderSrc *spiel_provider_src_new (gint fd);

G_END_DECLS

#endif /* __SPIEL_PROVIDER_SRC_H__ */
07070100000028000081A400000000000000000000000165D79E0600002DAA000000000000000000000000000000000000002600000000spiel-1.0.0/libspiel/spiel-provider.c/* spiel-provider.c
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "spiel.h"

#include "spiel-collect-providers.h"
#include "spiel-provider-private.h"
#include "spiel-provider-proxy.h"
#include "spiel-provider.h"

/**
 * SpielProvider:
 *
 * Represents a provider speech backend.
 *
 */

struct _SpielProvider
{
  GObject parent_instance;
};

typedef struct
{
  SpielProviderProxy *provider_proxy;
  gboolean is_activatable;
  GListStore *voices;
  GHashTable *voices_hashset;
  gulong voices_changed_handler_id;
} SpielProviderPrivate;

G_DEFINE_FINAL_TYPE_WITH_PRIVATE (SpielProvider, spiel_provider, G_TYPE_OBJECT)

enum
{
  PROP_0,
  PROP_WELL_KNOWN_NAME,
  PROP_NAME,
  PROP_VOICES,
  N_PROPS
};

static GParamSpec *properties[N_PROPS];

static gboolean handle_voices_changed (SpielProviderProxy *provider_proxy,
                                       GParamSpec *spec,
                                       gpointer user_data);

static void _spiel_provider_update_voices (SpielProvider *self);

SpielProvider *
spiel_provider_new (void)
{
  return g_object_new (SPIEL_TYPE_PROVIDER, NULL);
}

void
spiel_provider_set_proxy (SpielProvider *self,
                          SpielProviderProxy *provider_proxy)
{
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);
  g_assert (!priv->provider_proxy);

priv->provider_proxy = g_object_ref (provider_proxy);

_spiel_provider_update_voices (self);

priv->voices_changed_handler_id =
      g_signal_connect (priv->provider_proxy, "notify::voices",
                        G_CALLBACK (handle_voices_changed), self);
}

SpielProviderProxy *
spiel_provider_get_proxy (SpielProvider *self)
{
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);
  return priv->provider_proxy;
}

SpielVoice *
spiel_provider_get_voice_by_id (SpielProvider *self, const char *voice_id)
{
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);
  guint voices_count = g_list_model_get_n_items (G_LIST_MODEL (priv->voices));

for (guint i = 0; i < voices_count; i++)
    {
      g_autoptr (SpielVoice) voice = SPIEL_VOICE (
          g_list_model_get_object (G_LIST_MODEL (priv->voices), i));
      if (g_str_equal (spiel_voice_get_identifier (voice), voice_id))
        {
          return g_steal_pointer (&voice);
        }
    }
  return NULL;
}

/**
 * spiel_provider_proxy_get_name: (get-property name)
 * @self: a #SpielProvider
 *
 * Fetches a human readable name of this provider
 *
 * Returns: (transfer none): the human readable name.
 */
const char *
spiel_provider_get_name (SpielProvider *self)
{
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);
  g_return_val_if_fail (priv->provider_proxy, NULL);

return spiel_provider_proxy_get_name (priv->provider_proxy);
}

/**
 * spiel_provider_get_well_known_name: (get-property well-known-name)
 * @self: a #SpielProvider
 *
 * Fetches the provider's D-Bus well known name.
 *
 * Returns: (transfer none): the well known name.
 */
const char *
spiel_provider_get_well_known_name (SpielProvider *self)
{
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);
  g_return_val_if_fail (priv->provider_proxy, NULL);

return g_dbus_proxy_get_name (G_DBUS_PROXY (priv->provider_proxy));
}

/**
 * spiel_provider_get_voices: (get-property voices)
 * @self: a #SpielProvider
 * *
 * Fetches the provider's voices.
 *
 * Returns: (transfer none): A list of #SpielVoice voices provided
 */
GListModel *
spiel_provider_get_voices (SpielProvider *self)
{
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);

return G_LIST_MODEL (priv->voices);
}

void
spiel_provider_set_is_activatable (SpielProvider *self, gboolean is_activatable)
{
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);
  priv->is_activatable = is_activatable;
}

gboolean
spiel_provider_get_is_activatable (SpielProvider *self)
{
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);
  return priv->is_activatable;
}

static GSList *
_create_provider_voices (SpielProvider *self)
{
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);
  GSList *voices_slist = NULL;
  GVariant *voices = spiel_provider_proxy_get_voices (priv->provider_proxy);
  gsize voices_count = voices ? g_variant_n_children (voices) : 0;

for (gsize i = 0; i < voices_count; i++)
    {
      const char *name = NULL;
      const char *identifier = NULL;
      const char *output_format = NULL;
      g_autofree char **languages = NULL;
      guint64 features;
      SpielVoice *voice;

g_variant_get_child (voices, i, "(&s&s&st^a&s)", &name, &identifier,
                           &output_format, &features, &languages);
      if (features >> 32)
        {
          g_warning ("Voice features past 32 bits are ignored in %s (%s)",
                     identifier, spiel_provider_get_well_known_name (self));
        }
      voice = g_object_new (SPIEL_TYPE_VOICE, "name", name, "identifier",
                            identifier, "languages", languages, "provider",
                            self, "features", features, NULL);
      spiel_voice_set_output_format (voice, output_format);

voices_slist = g_slist_prepend (voices_slist, voice);
    }

return voices_slist;
}

static void
_spiel_provider_update_voices (SpielProvider *self)
{
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);
  GSList *new_voices = NULL;
  g_autoptr (GHashTable) new_voices_hashset = NULL;

g_return_if_fail (priv->provider_proxy);

new_voices = _create_provider_voices (self);
  if (g_hash_table_size (priv->voices_hashset) > 0)
    {
      // We are adding voices to an already populated provider_proxy, store
      // new voices in a hashset for easy purge of ones that were removed.
      new_voices_hashset = g_hash_table_new ((GHashFunc) spiel_voice_hash,
                                             (GCompareFunc) spiel_voice_equal);
    }

if (new_voices)
    {
      for (GSList *item = new_voices; item; item = item->next)
        {
          SpielVoice *voice = item->data;
          if (!g_hash_table_contains (priv->voices_hashset, voice))
            {
              g_hash_table_insert (priv->voices_hashset, g_object_ref (voice),
                                   NULL);
              g_list_store_insert_sorted (
                  priv->voices, g_object_ref (voice),
                  (GCompareDataFunc) spiel_voice_compare, NULL);
            }
          if (new_voices_hashset)
            {
              g_hash_table_insert (new_voices_hashset, voice, NULL);
            }
        }
    }

if (new_voices_hashset)
    {
      GHashTableIter voices_iter;
      SpielVoice *old_voice;
      g_hash_table_iter_init (&voices_iter, priv->voices_hashset);
      while (
          g_hash_table_iter_next (&voices_iter, (gpointer *) &old_voice, NULL))
        {
          if (!g_hash_table_contains (new_voices_hashset, old_voice))
            {
              guint position = 0;
              if (g_list_store_find (priv->voices, old_voice, &position))
                {
                  g_list_store_remove (priv->voices, position);
                }
              g_hash_table_iter_remove (&voices_iter);
            }
        }
    }

g_slist_free_full (new_voices, (GDestroyNotify) g_object_unref);
}

static gboolean
handle_voices_changed (SpielProviderProxy *provider_proxy,
                       GParamSpec *spec,
                       gpointer user_data)
{
  SpielProvider *self = user_data;
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);
  g_autofree char *name_owner =
      g_dbus_proxy_get_name_owner (G_DBUS_PROXY (priv->provider_proxy));

if (name_owner == NULL && priv->is_activatable)
    {
      // Got a change notification because an activatable service left the bus.
      // Its voices are still valid, though.
      return TRUE;
    }

_spiel_provider_update_voices (self);

return TRUE;
}

gint
spiel_provider_compare (SpielProvider *self,
                        SpielProvider *other,
                        gpointer user_data)
{
  return g_strcmp0 (spiel_provider_get_well_known_name (self),
                    spiel_provider_get_well_known_name (other));
}

static void
spiel_provider_finalize (GObject *object)
{
  SpielProvider *self = (SpielProvider *) object;
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);

g_signal_handler_disconnect (priv->provider_proxy,
                               priv->voices_changed_handler_id);

g_clear_object (&(priv->provider_proxy));
  g_clear_object (&(priv->voices));

G_OBJECT_CLASS (spiel_provider_parent_class)->finalize (object);
}

static void
spiel_provider_get_property (GObject *object,
                             guint prop_id,
                             GValue *value,
                             GParamSpec *pspec)
{
  SpielProvider *self = SPIEL_PROVIDER (object);

switch (prop_id)
    {
    case PROP_NAME:
      g_value_set_string (value, spiel_provider_get_name (self));
      break;
    case PROP_WELL_KNOWN_NAME:
      g_value_set_string (value, spiel_provider_get_well_known_name (self));
      break;
    case PROP_VOICES:
      g_value_set_object (value, spiel_provider_get_voices (self));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
spiel_provider_class_init (SpielProviderClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

object_class->finalize = spiel_provider_finalize;
  object_class->get_property = spiel_provider_get_property;

/**
   * SpielProvider:name: (getter get_name)
   *
   * The provider's human readable name
   *
   */
  properties[PROP_NAME] =
      g_param_spec_string ("name", NULL, NULL, NULL /* default value */,
                           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);

/**
   * SpielProvider:well-known-name: (getter get_well_known_name)
   *
   * The provider's D-Bus well known name.
   *
   */
  properties[PROP_WELL_KNOWN_NAME] = g_param_spec_string (
      "well-known-name", NULL, NULL, NULL /* default value */,
      G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);

/**
   * SpielProvider:voices:
   *
   * The list of available [class@Voice]s that are provided.
   *
   */
  properties[PROP_VOICES] =
      g_param_spec_object ("voices", NULL, NULL, G_TYPE_LIST_MODEL,
                           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);

g_object_class_install_properties (object_class, N_PROPS, properties);
}

static void
spiel_provider_init (SpielProvider *self)
{
  SpielProviderPrivate *priv = spiel_provider_get_instance_private (self);
  priv->provider_proxy = NULL;
  priv->is_activatable = FALSE;
  priv->voices = g_list_store_new (SPIEL_TYPE_VOICE);
  priv->voices_hashset = g_hash_table_new ((GHashFunc) spiel_voice_hash,
                                           (GCompareFunc) spiel_voice_equal);
}
07070100000029000081A400000000000000000000000165D79E060000048E000000000000000000000000000000000000002600000000spiel-1.0.0/libspiel/spiel-provider.h/* spiel-provider.h
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <gio/gio.h>
#include <glib-object.h>

G_BEGIN_DECLS

#define SPIEL_TYPE_PROVIDER (spiel_provider_get_type ())

G_DECLARE_FINAL_TYPE (SpielProvider, spiel_provider, SPIEL, PROVIDER, GObject)

const char *spiel_provider_get_name (SpielProvider *self);

const char *spiel_provider_get_well_known_name (SpielProvider *self);

GListModel *spiel_provider_get_voices (SpielProvider *self);

G_END_DECLS
0707010000002A000081A400000000000000000000000165D79E06000049EF000000000000000000000000000000000000002600000000spiel-1.0.0/libspiel/spiel-registry.c/* spiel-registry.c
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "spiel.h"

#include "spiel-collect-providers.h"
#include "spiel-provider-private.h"
#include "spiel-registry.h"
#include "spiel-voices-list-model.h"

#include <gio/gio.h>
#include <gst/gst.h>

#define GSETTINGS_SCHEMA "org.monotonous.libspiel"

struct _SpielRegistry
{
  GObject parent_instance;
};

typedef struct
{
  GDBusConnection *connection;
  guint subscription_ids[2];
  GListStore *providers;
  SpielVoicesListModel *voices;
  GSettings *settings;
} SpielRegistryPrivate;

static void initable_iface_init (GInitableIface *initable_iface);
static void
async_initable_iface_init (GAsyncInitableIface *async_initable_iface);

G_DEFINE_FINAL_TYPE_WITH_CODE (
    SpielRegistry,
    spiel_registry,
    G_TYPE_OBJECT,
    G_ADD_PRIVATE (SpielRegistry)
        G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
            G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE,
                                   async_initable_iface_init))

static SpielRegistry *sRegistry = NULL;
static GSList *sPendingTasks = NULL;

enum
{
  PROVIDER_DIED,
  LAST_SIGNAL
};

static guint registry_signals[LAST_SIGNAL] = { 0 };

static SpielProvider *
_get_provider_by_name (GListStore *providers,
                       const char *provider_name,
                       guint *position)
{
  guint providers_count = g_list_model_get_n_items (G_LIST_MODEL (providers));

for (guint i = 0; i < providers_count; i++)
    {
      g_autoptr (SpielProvider) provider = SPIEL_PROVIDER (
          g_list_model_get_object (G_LIST_MODEL (providers), i));
      if (g_str_equal (provider_name,
                       spiel_provider_get_well_known_name (provider)))
        {
          if (position)
            {
              *position = i;
            }
          return provider;
        }
    }

return NULL;
}

static void
_insert_providers (const char *provider_name,
                   SpielProvider *new_provider,
                   SpielRegistry *self)
{
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);
  SpielProvider *provider =
      _get_provider_by_name (priv->providers, provider_name, NULL);

if (!provider)
    {
      g_list_store_insert_sorted (priv->providers, new_provider,
                                  (GCompareDataFunc) spiel_provider_compare,
                                  NULL);
    }
  else
    {
      spiel_provider_set_is_activatable (
          provider, spiel_provider_get_is_activatable (new_provider));
    }
}

static void
_on_providers_updated (GObject *source, GAsyncResult *res, SpielRegistry *self)
{
  g_autoptr (GError) err = NULL;
  g_autoptr (GHashTable) new_providers =
      spiel_collect_providers_finish (res, &err);
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);
  guint providers_count = 0;

if (err != NULL)
    {
      g_warning ("Error updating providers: %s\n", err->message);
      return;
    }

g_hash_table_foreach (new_providers, (GHFunc) _insert_providers, self);

providers_count = g_list_model_get_n_items (G_LIST_MODEL (priv->providers));

for (gint i = providers_count - 1; i >= 0; i--)
    {
      g_autoptr (SpielProvider) provider = SPIEL_PROVIDER (
          g_list_model_get_object (G_LIST_MODEL (priv->providers), i));
      if (!g_hash_table_contains (
              new_providers, spiel_provider_get_well_known_name (provider)))
        {
          g_list_store_remove (priv->providers, i);
        }
    }
}

static void
_on_new_provider_collected (GObject *source,
                            GAsyncResult *res,
                            SpielRegistry *self)
{
  g_autoptr (GError) err = NULL;
  g_autoptr (SpielProvider) provider =
      spiel_collect_provider_finish (res, &err);
  const char *provider_name;

if (err != NULL)
    {
      g_warning ("Error collecting provider: %s\n", err->message);
      return;
    }

provider_name = spiel_provider_get_well_known_name (provider);
  _insert_providers (provider_name, provider, self);
}

static void
_maybe_activatable_providers_changed (GDBusConnection *connection,
                                      const gchar *sender_name,
                                      const gchar *object_path,
                                      const gchar *interface_name,
                                      const gchar *signal_name,
                                      GVariant *parameters,
                                      gpointer user_data)
{
  SpielRegistry *self = user_data;

// No arguments given, so update the whole providers cache.
  spiel_collect_providers (connection, NULL,
                           (GAsyncReadyCallback) _on_providers_updated, self);
}

static void
_maybe_running_providers_changed (GDBusConnection *connection,
                                  const gchar *sender_name,
                                  const gchar *object_path,
                                  const gchar *interface_name,
                                  const gchar *signal_name,
                                  GVariant *parameters,
                                  gpointer user_data)
{
  SpielRegistry *self = user_data;
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);
  const char *service_name;
  const char *old_owner;
  const char *new_owner;
  g_variant_get (parameters, "(&s&s&s)", &service_name, &old_owner, &new_owner);
  if (g_str_has_suffix (service_name, PROVIDER_SUFFIX))
    {
      gboolean provider_removed = strlen (new_owner) == 0;
      guint position = 0;
      SpielProvider *provider =
          _get_provider_by_name (priv->providers, service_name, &position);
      if (provider_removed)
        {
          if (provider && !spiel_provider_get_is_activatable (provider))
            {
              g_list_store_remove (priv->providers, position);
            }

g_signal_emit (self, registry_signals[PROVIDER_DIED], 0,
                         service_name);
        }
      else if (!provider)
        {
          spiel_collect_provider (
              connection, NULL, service_name,
              (GAsyncReadyCallback) _on_new_provider_collected, self);
        }
    }
}

static void
_subscribe_to_activatable_services_changed (SpielRegistry *self)
{
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);
  priv->subscription_ids[0] = g_dbus_connection_signal_subscribe (
      priv->connection, "org.freedesktop.DBus", "org.freedesktop.DBus",
      "ActivatableServicesChanged", "/org/freedesktop/DBus", NULL,
      G_DBUS_SIGNAL_FLAGS_NONE, _maybe_activatable_providers_changed, self,
      NULL);

priv->subscription_ids[1] = g_dbus_connection_signal_subscribe (
      priv->connection, "org.freedesktop.DBus", "org.freedesktop.DBus",
      "NameOwnerChanged", "/org/freedesktop/DBus", NULL,
      G_DBUS_SIGNAL_FLAGS_NONE, _maybe_running_providers_changed,
      g_object_ref (self), g_object_unref);
}

static void
_on_providers_collected (GObject *source, GAsyncResult *res, gpointer user_data)
{
  GTask *top_task = user_data;
  g_autoptr (GError) err = NULL;
  SpielRegistry *self = g_task_get_source_object (top_task);
  g_autoptr (GHashTable) providers = spiel_collect_providers_finish (res, &err);
  g_assert (sPendingTasks->data == top_task);

if (err != NULL)
    {
      g_warning ("Error retrieving providers: %s\n", err->message);
      while (sPendingTasks)
        {
          GTask *task = sPendingTasks->data;
          g_task_return_error (task, g_error_copy (err));
          g_object_unref (task);
          sPendingTasks = g_slist_delete_link (sPendingTasks, sPendingTasks);
        }
      return;
    }

g_hash_table_foreach (providers, (GHFunc) _insert_providers, self);

_subscribe_to_activatable_services_changed (self);

while (sPendingTasks)
    {
      GTask *task = sPendingTasks->data;
      g_task_return_boolean (task, TRUE);
      g_object_unref (task);
      sPendingTasks = g_slist_delete_link (sPendingTasks, sPendingTasks);
    }
}

static void
_on_bus_get (GObject *source, GAsyncResult *result, gpointer user_data)
{
  GTask *task = user_data;
  GCancellable *cancellable = g_task_get_task_data (task);
  SpielRegistry *self = g_task_get_source_object (task);
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);

GError *error = NULL;
  GDBusConnection *bus = g_bus_get_finish (result, &error);
  if (error != NULL)
    {
      g_task_return_error (task, error);
      g_object_unref (task);
      return;
    }

priv->connection = g_object_ref (bus);

spiel_collect_providers (bus, cancellable, _on_providers_collected, task);
}

void
spiel_registry_get (GCancellable *cancellable,
                    GAsyncReadyCallback callback,
                    gpointer user_data)
{
  if (sRegistry != NULL)
    {
      GTask *task = g_task_new (g_object_ref (sRegistry), cancellable, callback,
                                user_data);
      g_task_return_boolean (task, TRUE);
      g_object_unref (task);
    }
  else if (sPendingTasks)
    {
      GObject *source_object = g_task_get_source_object (sPendingTasks->data);
      GTask *task = g_task_new (g_object_ref (source_object), cancellable,
                                callback, user_data);
      sPendingTasks = g_slist_append (sPendingTasks, task);
    }
  else
    {
      g_async_initable_new_async (SPIEL_TYPE_REGISTRY, G_PRIORITY_DEFAULT,
                                  cancellable, callback, user_data, NULL);
    }
}

SpielRegistry *
spiel_registry_get_finish (GAsyncResult *result, GError **error)
{
  GObject *object;
  g_autoptr (GObject) source_object = g_async_result_get_source_object (result);
  g_assert (source_object != NULL);

object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
                                        result, error);
  if (object != NULL)
    {
      if (sRegistry == NULL)
        {
          gst_init_check (NULL, NULL, error);
          sRegistry = SPIEL_REGISTRY (object);
        }
      g_assert (sRegistry == SPIEL_REGISTRY (object));
      return SPIEL_REGISTRY (object);
    }
  else
    {
      return NULL;
    }
}

SpielRegistry *
spiel_registry_get_sync (GCancellable *cancellable, GError **error)
{
  if (sRegistry == NULL)
    {
      gst_init_check (NULL, NULL, error);
      sRegistry =
          g_initable_new (SPIEL_TYPE_REGISTRY, cancellable, error, NULL);
    }
  else
    {
      g_object_ref (sRegistry);
    }

return sRegistry;
}

static GSettings *
_settings_new (void)
{
  GSettingsSchema *schema = NULL;
  GSettingsSchemaSource *source = g_settings_schema_source_get_default ();
  GSettings *settings = NULL;

schema = g_settings_schema_source_lookup (source, GSETTINGS_SCHEMA, TRUE);
  if (!schema)
    {
      g_debug ("libspiel settings schema is not installed");
      return NULL;
    }

settings = g_settings_new (GSETTINGS_SCHEMA);
  g_settings_schema_unref (schema);

return settings;
}

static void
async_initable_init_async (GAsyncInitable *initable,
                           gint io_priority,
                           GCancellable *cancellable,
                           GAsyncReadyCallback callback,
                           gpointer user_data)
{
  GTask *task = g_task_new (initable, cancellable, callback, user_data);
  SpielRegistry *self = SPIEL_REGISTRY (initable);
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);

g_assert (!sPendingTasks);
  sPendingTasks = g_slist_append (sPendingTasks, task);

priv->providers = g_list_store_new (SPIEL_TYPE_PROVIDER);
  priv->voices = spiel_voices_list_model_new (G_LIST_MODEL (priv->providers));
  priv->settings = _settings_new ();

if (cancellable != NULL)
    {
      g_task_set_task_data (task, g_object_ref (cancellable), g_object_unref);
    }
  g_bus_get (G_BUS_TYPE_SESSION, cancellable, _on_bus_get, task);
}

static gboolean
async_initable_init_finish (GAsyncInitable *initable,
                            GAsyncResult *res,
                            GError **error)
{
  g_return_val_if_fail (g_task_is_valid (res, initable), FALSE);

return g_task_propagate_boolean (G_TASK (res), error);
}

static void
spiel_registry_finalize (GObject *object)
{
  SpielRegistry *self = (SpielRegistry *) object;
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);

g_clear_object (&priv->providers);
  g_clear_object (&priv->voices);
  g_clear_object (&priv->settings);
  if (priv->connection)
    {
      g_dbus_connection_signal_unsubscribe (priv->connection,
                                            priv->subscription_ids[0]);
      g_dbus_connection_signal_unsubscribe (priv->connection,
                                            priv->subscription_ids[1]);
      g_clear_object (&priv->connection);
    }

G_OBJECT_CLASS (spiel_registry_parent_class)->finalize (object);
  g_assert (object == G_OBJECT (sRegistry));
  sRegistry = NULL;
}

static gboolean
initable_init (GInitable *initable, GCancellable *cancellable, GError **error)
{
  SpielRegistry *self = SPIEL_REGISTRY (initable);
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);
  g_autoptr (GHashTable) providers = NULL;
  GDBusConnection *bus = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, error);

if (error && *error != NULL)
    {
      g_warning ("Error retrieving session bus: %s\n", (*error)->message);
      return FALSE;
    }

providers = spiel_collect_providers_sync (bus, cancellable, error);

if (error && *error != NULL)
    {
      g_warning ("Error retrieving providers: %s\n", (*error)->message);
      return FALSE;
    }

if (providers)
    {
      g_hash_table_foreach (providers, (GHFunc) _insert_providers, self);
    }

priv->connection = g_object_ref (bus);

_subscribe_to_activatable_services_changed (self);

return TRUE;
}

static void
spiel_registry_init (SpielRegistry *self)
{
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);
  priv->providers = g_list_store_new (SPIEL_TYPE_PROVIDER);
  priv->voices = spiel_voices_list_model_new (G_LIST_MODEL (priv->providers));
  priv->settings = _settings_new ();
}

static void
spiel_registry_class_init (SpielRegistryClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

object_class->finalize = spiel_registry_finalize;

registry_signals[PROVIDER_DIED] = g_signal_new (
      "provider-died", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST, 0, NULL,
      NULL, NULL, G_TYPE_NONE, 1, G_TYPE_STRING);
}

static void
async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
{
  async_initable_iface->init_async = async_initable_init_async;
  async_initable_iface->init_finish = async_initable_init_finish;
}

static void
initable_iface_init (GInitableIface *initable_iface)
{
  initable_iface->init = initable_init;
}

/* Public API */

SpielProviderProxy *
spiel_registry_get_provider_for_voice (SpielRegistry *self, SpielVoice *voice)
{
  SpielProvider *provider = spiel_voice_get_provider (voice);

g_return_val_if_fail (provider, NULL);

return spiel_provider_get_proxy (provider);
}

static SpielVoice *
_get_voice_from_provider_and_name (SpielRegistry *self,
                                   const char *provider_name,
                                   const char *voice_id)
{
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);
  SpielProvider *provider =
      _get_provider_by_name (priv->providers, provider_name, NULL);
  g_return_val_if_fail (provider, NULL);

return spiel_provider_get_voice_by_id (provider, voice_id);
}

static SpielVoice *
_get_fallback_voice (SpielRegistry *self, const char *language)
{
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);

if (language)
    {
      guint voices_count =
          g_list_model_get_n_items (G_LIST_MODEL (priv->voices));

for (guint i = 0; i < voices_count; i++)
        {
          SpielVoice *voice = SPIEL_VOICE (
              g_list_model_get_object (G_LIST_MODEL (priv->voices), i));
          if (g_strv_contains (spiel_voice_get_languages (voice), language))
            {
              return voice;
            }
          g_object_unref (voice); // Just want to borrow a ref.
        }
    }

return g_list_model_get_item ((GListModel *) priv->voices, 0);
  ;
}

SpielVoice *
spiel_registry_get_voice_for_utterance (SpielRegistry *self,
                                        SpielUtterance *utterance)
{
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);
  g_autofree char *provider_name = NULL;
  g_autofree char *voice_id = NULL;
  const char *language = spiel_utterance_get_language (utterance);

SpielVoice *voice = spiel_utterance_get_voice (utterance);
  if (voice)
    {
      return voice;
    }

if (language && priv->settings)
    {
      g_autoptr (GVariant) mapping =
          g_settings_get_value (priv->settings, "language-voice-mapping");
      g_autofree char *_lang = g_strdup (language);
      char *found = _lang + g_utf8_strlen (_lang, -1);
      gssize boundary = -1;

do
        {
          *found = 0;
          g_variant_lookup (mapping, _lang, "(ss)", &provider_name, &voice_id);
          if (provider_name)
            {
              break;
            }
          found = g_utf8_strrchr (_lang, boundary, '-');
          boundary = found - _lang - 1;
        }
      while (found);
    }

if (!provider_name && priv->settings)
    {
      g_settings_get (priv->settings, "default-voice", "m(ss)", NULL,
                      &provider_name, &voice_id);
    }

if (provider_name)
    {
      g_assert (voice_id != NULL);
      voice = _get_voice_from_provider_and_name (self, provider_name, voice_id);
    }

if (voice)
    {
      return voice;
    }

return _get_fallback_voice (self, language);
}

GListModel *
spiel_registry_get_voices (SpielRegistry *self)
{
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);
  return G_LIST_MODEL (priv->voices);
}

GListModel *
spiel_registry_get_providers (SpielRegistry *self)
{
  SpielRegistryPrivate *priv = spiel_registry_get_instance_private (self);
  return G_LIST_MODEL (priv->providers);
}
0707010000002B000081A400000000000000000000000165D79E0600000752000000000000000000000000000000000000002600000000spiel-1.0.0/libspiel/spiel-registry.h/* spiel-registry.h
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <glib-object.h>

#include "spiel-provider-proxy.h"
#include "spiel-voice.h"

typedef struct _SpielVoicesListModel SpielVoicesListModel;

G_BEGIN_DECLS

#define SPIEL_TYPE_REGISTRY (spiel_registry_get_type ())

G_DECLARE_FINAL_TYPE (SpielRegistry, spiel_registry, SPIEL, REGISTRY, GObject)

void spiel_registry_get (GCancellable *cancellable,
                         GAsyncReadyCallback callback,
                         gpointer user_data);

SpielRegistry *spiel_registry_get_finish (GAsyncResult *result, GError **error);

SpielRegistry *spiel_registry_get_sync (GCancellable *cancellable,
                                        GError **error);

SpielProviderProxy *spiel_registry_get_provider_for_voice (SpielRegistry *self,
                                                           SpielVoice *voice);

SpielVoice *spiel_registry_get_voice_for_utterance (SpielRegistry *self,
                                                    SpielUtterance *utterance);

GListModel *spiel_registry_get_voices (SpielRegistry *self);

GListModel *spiel_registry_get_providers (SpielRegistry *self);

G_END_DECLS
0707010000002C000081A400000000000000000000000165D79E0600007FD5000000000000000000000000000000000000002500000000spiel-1.0.0/libspiel/spiel-speaker.c/* spiel-speaker.c
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "spiel.h"

#include "spiel-speaker.h"

#include "spiel-provider-proxy.h"
#include "spiel-provider-src.h"
#include "spiel-registry.h"
#include "spiel-voice.h"
#include <fcntl.h>
#include <gio/gio.h>
#include <glib-unix.h>
#include <gst/audio/audio.h>
#include <gst/gst.h>

/**
 * SpielSpeaker:
 *
 * A virtual speaker for speech synthesis
 *
 * The #SpielSpeaker class represents a single "individual" speaker. Its primary
 * method is [method@Speaker.speak] which queues utterances to be spoken.
 *
 * This class also provides a list of available voices provided by DBus speech
 * providers that are activatable on the session bus.
 *
 * #SpielSpeaker's initialization may perform blocking IO if it the first
 * instance in the process. The default constructor is asynchronous
 * ([func@Speaker.new]), although there is a synchronous blocking alternative
 * ([ctor@Speaker.new_sync]).
 *
 */

struct _SpielSpeaker
{
  GObject parent_instance;
};

typedef struct
{
  gboolean paused;
  SpielRegistry *registry;
  GSList *queue;
  GstElement *pipeline;
  GstElement *convert;
  GstElement *sink;
} SpielSpeakerPrivate;

static void initable_iface_init (GInitableIface *initable_iface);
static void
async_initable_iface_init (GAsyncInitableIface *async_initable_iface);

G_DEFINE_FINAL_TYPE_WITH_CODE (
    SpielSpeaker,
    spiel_speaker,
    G_TYPE_OBJECT,
    G_ADD_PRIVATE (SpielSpeaker)
        G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
            G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE,
                                   async_initable_iface_init))

enum
{
  UTTURANCE_STARTED,
  UTTERANCE_FINISHED,
  UTTERANCE_CANCELED,
  UTTERANCE_ERROR,
  RANGE_STARTED,
  WORD_STARTED,
  SENTENCE_STARTED,
  MARK_REACHED,
  LAST_SIGNAL
};

static guint speaker_signals[LAST_SIGNAL] = { 0 };

enum
{
  PROP_0,
  PROP_SPEAKING,
  PROP_PAUSED,
  PROP_VOICES,
  PROP_PROVIDERS,
  PROP_SINK,
  N_PROPS
};

static GParamSpec *properties[N_PROPS];

typedef struct
{
  SpielUtterance *utterance;
  GstElement *src;
  GstElement *parse;
  GstElement *volume;
  GError *error;
  gboolean started;
  GSList *deferred_messages;
} _QueueEntry;

static void
_queue_entry_destroy (gpointer data)
{
  _QueueEntry *entry = data;
  if (entry)
    {
      g_clear_object (&entry->utterance);
      if (entry->error)
        {
          g_error_free (entry->error);
        }

if (entry->src)
        {
          gint fd = -1;
          g_object_get (entry->src, "fd", &fd, NULL);
          if (fd > 0)
            {
              close (fd);
            }
          g_clear_object (&entry->src);
        }

if (entry->parse)
        {
          g_clear_object (&entry->parse);
        }

if (entry->volume)
        {
          g_clear_object (&entry->volume);
        }

if (entry->deferred_messages)
        {
          g_slist_free_full (g_steal_pointer (&entry->deferred_messages),
                             (GDestroyNotify) gst_message_unref);
        }
    }

g_slice_free (_QueueEntry, entry);
}

/**
 * spiel_speaker_new:
 * @cancellable: (nullable): A #GCancellable or %NULL.
 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
 * @user_data: User data to pass to @callback.
 *
 * Asynchronously creates a SpielSpeaker.
 *
 * When the operation is finished, @callback will be invoked in the
 * thread-default main loop of the thread you are calling this method from (see
 * g_main_context_push_thread_default()). You can then call
 * spiel_speaker_new_finish() to get the result of the operation.
 *
 * See spiel_speaker_new_sync() for the synchronous, blocking version of this
 * constructor.
 */
void
spiel_speaker_new (GCancellable *cancellable,
                   GAsyncReadyCallback callback,
                   gpointer user_data)
{
  g_async_initable_new_async (SPIEL_TYPE_SPEAKER, G_PRIORITY_DEFAULT,
                              cancellable, callback, user_data, NULL);
}

/**
 * spiel_speaker_new_finish:
 * @result: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
 * spiel_speaker_new().
 * @error: Return location for error or %NULL
 *
 * Finishes an operation started with spiel_speaker_new().
 *
 * Returns: (transfer full) (type SpielSpeaker): The constructed speaker object
 * or %NULL if @error is set.
 */
SpielSpeaker *
spiel_speaker_new_finish (GAsyncResult *result, GError **error)
{
  GObject *object;
  g_autoptr (GObject) source_object = g_async_result_get_source_object (result);

g_return_val_if_fail (source_object != NULL, NULL);

object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
                                        result, error);
  if (object != NULL)
    return SPIEL_SPEAKER (object);
  else
    return NULL;
}

/**
 * spiel_speaker_new_sync:
 * @cancellable: (nullable): A #GCancellable or %NULL.
 * @error: Return location for error or %NULL
 *
 * Synchronously creates a SpielSpeaker.
 *
 * The calling thread is blocked until a reply is received.
 *
 * See spiel_speaker_new() for the asynchronous version of this constructor.
 *
 * Returns: (transfer full) (type SpielSpeaker): The constructed speaker object
 * or %NULL if @error is set.
 */
SpielSpeaker *
spiel_speaker_new_sync (GCancellable *cancellable, GError **error)
{
  return g_initable_new (SPIEL_TYPE_SPEAKER, cancellable, error, NULL);
}

static void
spiel_speaker_finalize (GObject *object)
{
  SpielSpeaker *self = SPIEL_SPEAKER (object);
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);

g_clear_object (&priv->registry);
  if (priv->pipeline)
    {
      gst_element_set_state (priv->pipeline, GST_STATE_NULL);
    }
  g_clear_object (&priv->pipeline);
  g_clear_object (&priv->convert);
  g_clear_object (&priv->sink);
  g_slist_free_full (g_steal_pointer (&priv->queue),
                     (GDestroyNotify) _queue_entry_destroy);

G_OBJECT_CLASS (spiel_speaker_parent_class)->finalize (object);
}

static void
spiel_speaker_get_property (GObject *object,
                            guint prop_id,
                            GValue *value,
                            GParamSpec *pspec)
{
  SpielSpeaker *self = SPIEL_SPEAKER (object);
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);

switch (prop_id)
    {
    case PROP_SPEAKING:
      g_value_set_boolean (value, priv->queue != NULL);
      break;
    case PROP_PAUSED:
      g_value_set_boolean (value, priv->paused);
      break;
    case PROP_VOICES:
      g_value_set_object (value, spiel_speaker_get_voices (self));
      break;
    case PROP_PROVIDERS:
      g_value_set_object (value, spiel_speaker_get_providers (self));
      break;
    case PROP_SINK:
      g_value_set_object (value, priv->sink);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
spiel_speaker_set_property (GObject *object,
                            guint prop_id,
                            const GValue *value,
                            GParamSpec *pspec)
{
  SpielSpeaker *self = SPIEL_SPEAKER (object);
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);

switch (prop_id)
    {
    case PROP_SINK:
      {
        GstElement *new_sink = g_value_get_object (value);

gst_element_unlink (priv->convert, priv->sink);
        gst_bin_remove (GST_BIN (priv->pipeline), priv->sink);
        g_object_unref (priv->sink);

gst_bin_add (GST_BIN (priv->pipeline), new_sink);
        gst_element_link (priv->convert, new_sink);
        priv->sink = g_object_ref (new_sink);
      }
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
spiel_speaker_class_init (SpielSpeakerClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

object_class->finalize = spiel_speaker_finalize;
  object_class->get_property = spiel_speaker_get_property;
  object_class->set_property = spiel_speaker_set_property;

/**
   * SpielSpeaker:speaking:
   *
   * The speaker has an utterance queued or speaking.
   *
   */
  properties[PROP_SPEAKING] =
      g_param_spec_boolean ("speaking", NULL, NULL, FALSE /* default value */,
                            G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);

/**
   * SpielSpeaker:paused:
   *
   * The speaker is in a paused state.
   *
   */
  properties[PROP_PAUSED] =
      g_param_spec_boolean ("paused", NULL, NULL, FALSE /* default value */,
                            G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);

/**
   * SpielSpeaker:voices:
   *
   * The list of available [class@Voice]s that can be used in an utterance.
   *
   */
  properties[PROP_VOICES] =
      g_param_spec_object ("voices", NULL, NULL, G_TYPE_LIST_MODEL,
                           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);

/**
   * SpielSpeaker:providers:
   *
   * The list of available [class@Provider]s that offer voices.
   *
   */
  properties[PROP_PROVIDERS] =
      g_param_spec_object ("providers", NULL, NULL, G_TYPE_LIST_MODEL,
                           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);

/**
   * SpielSpeaker:sink:
   *
   * The gstreamer sink this speaker is connected to.
   *
   */
  properties[PROP_SINK] = g_param_spec_object (
      "sink", NULL, NULL, GST_TYPE_ELEMENT, G_PARAM_READWRITE);

g_object_class_install_properties (object_class, N_PROPS, properties);

/**
   * SpielSpeaker::utterance-started:
   * @speaker: A #SpielSpeaker
   * @utterance: A #SpielUtterance
   *
   * Emitted when the given utterance is actively being spoken.
   *
   */
  speaker_signals[UTTURANCE_STARTED] = g_signal_new (
      "utterance-started", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST, 0,
      NULL, NULL, NULL, G_TYPE_NONE, 1, SPIEL_TYPE_UTTERANCE);

/**
   * SpielSpeaker::utterance-finished:
   * @speaker: A #SpielSpeaker
   * @utterance: A #SpielUtterance
   *
   * Emitted when a given utterance has completed speaking
   *
   */
  speaker_signals[UTTERANCE_FINISHED] = g_signal_new (
      "utterance-finished", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST, 0,
      NULL, NULL, NULL, G_TYPE_NONE, 1, SPIEL_TYPE_UTTERANCE);

/**
   * SpielSpeaker::utterance-canceled:
   * @speaker: A #SpielSpeaker
   * @utterance: A #SpielUtterance
   *
   * Emitted when a given utterance has been canceled after it has started
   * speaking
   *
   */
  speaker_signals[UTTERANCE_CANCELED] = g_signal_new (
      "utterance-canceled", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST, 0,
      NULL, NULL, NULL, G_TYPE_NONE, 1, SPIEL_TYPE_UTTERANCE);

/**
   * SpielSpeaker::utterance-error:
   * @speaker: A #SpielSpeaker
   * @utterance: A #SpielUtterance
   * @error: A #GError
   *
   * Emitted when a given utterance has failed to start or complete.
   *
   */
  speaker_signals[UTTERANCE_ERROR] = g_signal_new (
      "utterance-error", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST, 0, NULL,
      NULL, NULL, G_TYPE_NONE, 2, SPIEL_TYPE_UTTERANCE, G_TYPE_ERROR);

/**
   * SpielSpeaker::word-started:
   * @speaker: A #SpielSpeaker
   * @utterance: A #SpielUtterance
   * @start: Character start offset of speech word
   * @end: Character end offset of speech word
   *
   * Emitted when a word will be spoken in a given utterance. Not all
   * voices are capable of notifying when a word will be spoken.
   *
   */
  speaker_signals[WORD_STARTED] =
      g_signal_new ("word-started", G_TYPE_FROM_CLASS (klass),
                    G_SIGNAL_RUN_FIRST, 0, NULL, NULL, NULL, G_TYPE_NONE, 3,
                    SPIEL_TYPE_UTTERANCE, G_TYPE_UINT64, G_TYPE_UINT64);

/**
   * SpielSpeaker::sentence-started:
   * @speaker: A #SpielSpeaker
   * @utterance: A #SpielUtterance
   * @start: Character start offset of speech sentence
   * @end: Character end offset of speech sentence
   *
   * Emitted when a sentence will be spoken in a given utterance. Not all
   * voices are capable of notifying when a sentence will be spoken.
   *
   */
  speaker_signals[SENTENCE_STARTED] =
      g_signal_new ("sentence-started", G_TYPE_FROM_CLASS (klass),
                    G_SIGNAL_RUN_FIRST, 0, NULL, NULL, NULL, G_TYPE_NONE, 3,
                    SPIEL_TYPE_UTTERANCE, G_TYPE_UINT64, G_TYPE_UINT64);

/**
   * SpielSpeaker::range-started:
   * @speaker: A #SpielSpeaker
   * @utterance: A #SpielUtterance
   * @start: Character start offset of speech range
   * @end: Character end offset of speech range
   *
   * Emitted when a range will be spoken in a given utterance. Not all
   * voices are capable of notifying when a range will be spoken.
   *
   */
  speaker_signals[RANGE_STARTED] =
      g_signal_new ("range-started", G_TYPE_FROM_CLASS (klass),
                    G_SIGNAL_RUN_FIRST, 0, NULL, NULL, NULL, G_TYPE_NONE, 3,
                    SPIEL_TYPE_UTTERANCE, G_TYPE_UINT64, G_TYPE_UINT64);

/**
   * SpielSpeaker::mark-reached:
   * @speaker: A #SpielSpeaker
   * @utterance: A #SpielUtterance
   * @name: Name of mark reached
   *
   * Emitted when an SSML mark element is reached
   *
   */
  speaker_signals[MARK_REACHED] = g_signal_new (
      "mark-reached", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST, 0, NULL,
      NULL, NULL, G_TYPE_NONE, 2, SPIEL_TYPE_UTTERANCE, G_TYPE_STRING);
}

static gboolean
_handle_gst_eos (GstBus *bus, GstMessage *msg, SpielSpeaker *self);

static gboolean
_handle_gst_state_change (GstBus *bus, GstMessage *msg, SpielSpeaker *self);

static gboolean
_handle_gst_element_message (GstBus *bus, GstMessage *msg, SpielSpeaker *self);

static void _process_going_to_speak_message (GstMessage *msg,
                                             SpielSpeaker *self);

static void
_setup_pipeline (SpielSpeaker *self, GError **error)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  GstBus *bus;
  GstElement *convert = gst_element_factory_make ("audioconvert", "convert");
  GstElement *sink = gst_element_factory_make (
      g_getenv ("SPIEL_TEST") ? "fakesink" : "autoaudiosink", "sink");
  priv->pipeline = gst_pipeline_new ("pipeline");

gst_bin_add_many (GST_BIN (priv->pipeline), convert, sink, NULL);
  gst_element_link (convert, sink);

bus = gst_element_get_bus (priv->pipeline);

gst_bus_add_signal_watch (bus);
  g_object_connect (bus, "signal::message::eos", _handle_gst_eos, self,
                    "signal::message::state-changed", _handle_gst_state_change,
                    self, "signal::message::element",
                    _handle_gst_element_message, self, NULL);

priv->convert = g_object_ref (convert);
  priv->sink = g_object_ref (sink);
}

static void
_on_registry_get (GObject *source, GAsyncResult *result, gpointer user_data)
{
  GTask *task = user_data;
  SpielSpeaker *self = g_task_get_task_data (task);
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  GError *error = NULL;

priv->registry = spiel_registry_get_finish (result, &error);
  if (error == NULL)
    {
      _setup_pipeline (self, &error);
    }
  if (error != NULL)
    {
      g_task_return_error (task, error);
    }
  else
    {
      g_task_return_boolean (task, TRUE);
    }

g_object_unref (task);
}

static void
async_initable_init_async (GAsyncInitable *initable,
                           gint io_priority,
                           GCancellable *cancellable,
                           GAsyncReadyCallback callback,
                           gpointer user_data)
{
  GTask *task = g_task_new (initable, cancellable, callback, user_data);
  SpielSpeaker *self = SPIEL_SPEAKER (initable);
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);

priv->paused = FALSE;
  priv->queue = NULL;

g_task_set_task_data (task, g_object_ref (self), g_object_unref);
  spiel_registry_get (cancellable, _on_registry_get, task);
}

return g_task_propagate_boolean (G_TASK (res), error);
}

static gboolean
initable_init (GInitable *initable, GCancellable *cancellable, GError **error)
{
  SpielSpeaker *self = SPIEL_SPEAKER (initable);
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  GError *err = NULL;

priv->registry = spiel_registry_get_sync (cancellable, &err);
  if (err == NULL)
    {
      _setup_pipeline (self, &err);
    }

if (err != NULL)
    {
      g_warning ("Error initializing speaker: %s\n", (*error)->message);
      g_propagate_error (error, err);
      return FALSE;
    }

return TRUE;
}

static void
initable_iface_init (GInitableIface *initable_iface)
{
  initable_iface->init = initable_init;
}

static void
spiel_speaker_init (SpielSpeaker *self)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  priv->paused = FALSE;
  priv->queue = NULL;
}

GQuark
spiel_error_quark (void)
{
  return g_quark_from_static_string ("spiel-error-quark");
}

/**
 * Playback
 */

static void _provider_call_synthesize_done (GObject *source_object,
                                            GAsyncResult *res,
                                            gpointer user_data);

static void _speak_current_entry (SpielSpeaker *self);

static void _advance_to_next_entry_or_finish (SpielSpeaker *self,
                                              gboolean canceled);

typedef struct
{
  SpielSpeaker *self;
  // We use an utterance instead of a queue entry because we can hold a strong
  // reference.
  SpielUtterance *utterance;
} _CallSynthData;

/**
 * spiel_speaker_speak:
 * @self: a #SpielSpeaker
 * @utterance: an #SpielUtterance to speak
 *
 * Speak the given utterance. If an utterance is already being spoken
 * the provided utterances will be added to a queue and will be spoken
 * in the order recieved.
 */
void
spiel_speaker_speak (SpielSpeaker *self, SpielUtterance *utterance)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  _QueueEntry *entry = g_slice_new0 (_QueueEntry);
  _CallSynthData *call_synth_data = g_slice_new0 (_CallSynthData);
  SpielProviderProxy *provider = NULL;
  GUnixFDList *fd_list = g_unix_fd_list_new ();
  int mypipe[2];
  int fd;
  const char *text = spiel_utterance_get_text (utterance);
  const char *output_format = NULL;
  const char *stream_type = NULL;
  gboolean is_ssml = FALSE;
  gdouble pitch, rate, volume;
  g_autoptr (SpielVoice) voice = NULL;
  GstStructure *gst_struct;

g_object_get (utterance, "pitch", &pitch, "rate", &rate, "volume", &volume,
                "voice", &voice, "is-ssml", &is_ssml, NULL);

if (voice == NULL)
    {
      voice =
          spiel_registry_get_voice_for_utterance (priv->registry, utterance);
      if (!voice)
        {
          g_warning ("No voice available!");
          return;
        }
      spiel_utterance_set_voice (utterance, voice);
      g_object_ref (voice);
    }

provider = spiel_registry_get_provider_for_voice (priv->registry, voice);

// XXX: Emit error on failure
  g_unix_open_pipe (mypipe, 0, NULL);
  fd = g_unix_fd_list_append (fd_list, mypipe[1], NULL);

// XXX: Emit error on failure
  close (mypipe[1]);

call_synth_data->self = self;
  call_synth_data->utterance = g_object_ref (utterance);

// XXX: Send utterance language
  spiel_provider_proxy_call_synthesize (
      provider, g_variant_new_handle (fd), text,
      voice ? spiel_voice_get_identifier (voice) : "", pitch, rate, is_ssml, "",
      G_DBUS_CALL_FLAGS_NONE, -1, fd_list, NULL, _provider_call_synthesize_done,
      call_synth_data);

g_object_unref (fd_list);

entry->utterance = g_object_ref (utterance);

output_format = spiel_voice_get_output_format (voice);

gst_struct = gst_structure_from_string (output_format, NULL);

stream_type = gst_struct ? gst_structure_get_name (gst_struct) : NULL;

if (g_str_equal (stream_type, "audio/x-raw"))
    {
      entry->src =
          gst_element_factory_make_full ("fdsrc", "fd", mypipe[0], NULL);
    }
  else if (g_str_equal (stream_type, "audio/x-spiel"))
    {
      entry->src = GST_ELEMENT (spiel_provider_src_new (mypipe[0]));
    }

if (!entry->src)
    {
      g_assert (!entry->error);
      g_set_error (&entry->error, SPIEL_ERROR, SPIEL_ERROR_MISCONFIGURED_VOICE,
                   "Voice output format not set correctly: '%s'",
                   output_format);
    }
  else
    {
      gint sample_rate, channels;
      const char *pcm_format;

entry->volume =
          gst_element_factory_make_full ("volume", "volume", volume, NULL);

entry->parse = gst_element_factory_make ("rawaudioparse", "parse");
      if (gst_structure_get_int (gst_struct, "rate", &sample_rate))
        {
          g_object_set (entry->parse, "sample-rate", sample_rate, NULL);
        }

if (gst_structure_get_int (gst_struct, "channels", &channels))
        {
          g_object_set (entry->parse, "num-channels", channels, NULL);
        }

pcm_format = gst_structure_get_string (gst_struct, "format");
      if (pcm_format)
        {
          g_object_set (entry->parse, "pcm-format",
                        gst_audio_format_from_string (pcm_format), NULL);
        }
    }

gst_structure_free (gst_struct);

priv->queue = g_slist_append (priv->queue, entry);

if (!priv->queue->next)
    {
      g_object_notify (G_OBJECT (self), "speaking");
      _speak_current_entry (self);
    }
}

/**
 * spiel_speaker_get_voices: (get-property voices)
 * @self: a #SpielSpeaker
 *
 * Fetches the voices available to this speaker
 *
 * Returns: (transfer none): A live #ListModel of voices
 */
GListModel *
spiel_speaker_get_voices (SpielSpeaker *self)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);

return spiel_registry_get_voices (priv->registry);
}

/**
 * spiel_speaker_get_providers: (get-property providers)
 * @self: a #SpielSpeaker
 *
 * Fetches the speech providers that offer voices to this speaker
 *
 * Returns: (transfer none): A live #ListModel of providers
 */
GListModel *
spiel_speaker_get_providers (SpielSpeaker *self)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);

return spiel_registry_get_providers (priv->registry);
}

/**
 * spiel_speaker_pause:
 * @self: a #SpielSpeaker
 *
 * Pause the given speaker. If an utterance is being spoken, it will pause
 * until [method@Speaker.resume] is called.
 * If the speaker isn't speaking, calling [method@Speaker.speak] will store
 * new utterances in a queue until [method@Speaker.resume] is called.
 */
void
spiel_speaker_pause (SpielSpeaker *self)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  _QueueEntry *entry = priv->queue ? priv->queue->data : NULL;
  if (priv->paused)
    {
      return;
    }

if (!entry)
    {
      priv->paused = TRUE;
      g_object_notify (G_OBJECT (self), "paused");
      return;
    }

gst_element_set_state (priv->pipeline, GST_STATE_PAUSED);
}

/**
 * spiel_speaker_resume:
 * @self: a #SpielSpeaker
 *
 * Resumes the given paused speaker. If the speaker isn't pause this will do
 * nothing.
 */
void
spiel_speaker_resume (SpielSpeaker *self)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  _QueueEntry *entry = priv->queue ? priv->queue->data : NULL;
  if (!priv->paused)
    {
      return;
    }

if (!entry)
    {
      priv->paused = FALSE;
      g_object_notify (G_OBJECT (self), "paused");
      return;
    }

gst_element_set_state (priv->pipeline, GST_STATE_PLAYING);
}

/**
 * spiel_speaker_cancel:
 * @self: a #SpielSpeaker
 *
 * Stops the current utterance from being spoken and dumps the utterance queue.
 */
void
spiel_speaker_cancel (SpielSpeaker *self)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  if (!priv->queue)
    {
      return;
    }

// Dump the rest of the queue after the current entry.
  g_slist_free_full (g_steal_pointer (&priv->queue->next),
                     (GDestroyNotify) _queue_entry_destroy);

_advance_to_next_entry_or_finish (self, TRUE);
}

static gboolean
_handle_gst_state_change (GstBus *bus, GstMessage *msg, SpielSpeaker *self)
{
  GstState old_state, new_state, pending_state;
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  _QueueEntry *entry = priv->queue ? priv->queue->data : NULL;
  GstObject *element = GST_MESSAGE_SRC (msg);

gst_message_parse_state_changed (msg, &old_state, &new_state, &pending_state);

if (new_state == GST_STATE_PLAYING &&
      pending_state == GST_STATE_VOID_PENDING &&
      element == GST_OBJECT (priv->pipeline))
    {
      if (priv->paused)
        {
          priv->paused = FALSE;
          g_object_notify (G_OBJECT (self), "paused");
        }

if (!entry->started)
        {
          entry->started = TRUE;
          g_signal_emit (self, speaker_signals[UTTURANCE_STARTED], 0,
                         entry->utterance);
          if (entry->deferred_messages)
            {
              g_slist_foreach (entry->deferred_messages,
                               (GFunc) _process_going_to_speak_message, self);
              g_slist_free_full (g_steal_pointer (&entry->deferred_messages),
                                 (GDestroyNotify) gst_message_unref);
            }
        }
    }
  if (new_state == GST_STATE_PAUSED &&
      pending_state == GST_STATE_VOID_PENDING &&
      element == GST_OBJECT (priv->pipeline))
    {
      priv->paused = TRUE;
      g_object_notify (G_OBJECT (self), "paused");
    }

if (new_state == GST_STATE_NULL && pending_state == GST_STATE_VOID_PENDING &&
      element == GST_OBJECT (entry->src))
    {
      _advance_to_next_entry_or_finish (self, FALSE);
    }

return TRUE;
}

static gboolean
_handle_gst_eos (GstBus *bus, GstMessage *msg, SpielSpeaker *self)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  _QueueEntry *entry = priv->queue ? priv->queue->data : NULL;
  GstElement *fdsrc = entry->src;
  gst_element_set_state (fdsrc, GST_STATE_NULL);

return TRUE;
}

static void
_process_going_to_speak_message (GstMessage *msg, SpielSpeaker *self)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  _QueueEntry *entry = priv->queue ? priv->queue->data : NULL;
  const GstStructure *strct = gst_message_get_structure (msg);
  guint event_type = SPEECH_PROVIDER_EVENT_TYPE_NONE;
  guint32 range_start = 0;
  guint32 range_end = 0;
  const char *mark_name = gst_structure_get_string (strct, "name");

if (!gst_structure_get_uint (strct, "event_type", &event_type))
    {
      g_warning ("No 'event_type' in message structure");
    }

if (!gst_structure_get_uint (strct, "range_start", &range_start))
    {
      g_warning ("No 'range_start' in message structure");
    }

if (!gst_structure_get_uint (strct, "range_end", &range_end))
    {
      g_warning ("No 'range_end' in message structure");
    }

switch (event_type)
    {
    case SPEECH_PROVIDER_EVENT_TYPE_WORD:
      g_signal_emit (self, speaker_signals[WORD_STARTED], 0, entry->utterance,
                     range_start, range_end);
      break;
    case SPEECH_PROVIDER_EVENT_TYPE_SENTENCE:
      g_signal_emit (self, speaker_signals[SENTENCE_STARTED], 0,
                     entry->utterance, range_start, range_end);
      break;
    case SPEECH_PROVIDER_EVENT_TYPE_RANGE:
      g_signal_emit (self, speaker_signals[RANGE_STARTED], 0, entry->utterance,
                     range_start, range_end);
      break;
    case SPEECH_PROVIDER_EVENT_TYPE_MARK:
      g_warn_if_fail (mark_name);
      g_signal_emit (self, speaker_signals[MARK_REACHED], 0, entry->utterance,
                     mark_name);
      break;
    default:
      g_warning ("Event type not recognized (%d)", event_type);
      break;
    }
}

static gboolean
_handle_gst_element_message (GstBus *bus, GstMessage *msg, SpielSpeaker *self)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  _QueueEntry *entry = priv->queue ? priv->queue->data : NULL;
  const GstStructure *strct = gst_message_get_structure (msg);

if (!strct ||
      !g_str_equal (gst_structure_get_name (strct), "SpielGoingToSpeak"))
    {
      return TRUE;
    }

if (entry->started)
    {
      _process_going_to_speak_message (msg, self);
    }
  else
    {
      entry->deferred_messages =
          g_slist_append (entry->deferred_messages, gst_message_ref (msg));
    }

return TRUE;
}

static void
_provider_call_synthesize_done (GObject *source_object,
                                GAsyncResult *res,
                                gpointer user_data)
{
  _CallSynthData *call_synth_data = user_data;
  SpielProviderProxy *provider = SPIEL_PROVIDER_PROXY (source_object);
  GError *err = NULL;
  spiel_provider_proxy_call_synthesize_finish (provider, NULL, res, &err);
  if (err != NULL)
    {
      SpielSpeakerPrivate *priv =
          spiel_speaker_get_instance_private (call_synth_data->self);
      GSList *item = priv->queue;
      while (item)
        {
          _QueueEntry *entry = item->data;
          if (entry->utterance == call_synth_data->utterance)
            {
              g_assert (!entry->error);
              entry->error = err;
              if (item == priv->queue)
                {
                  // Top of queue failed, advance to next.
                  _advance_to_next_entry_or_finish (call_synth_data->self,
                                                    FALSE);
                }
              break;
            }
          item = item->next;
        }

if (!item)
        {
          g_error_free (err);
        }
    }

g_object_unref (call_synth_data->utterance);
  g_slice_free (_CallSynthData, call_synth_data);
}

static void
_speak_current_entry (SpielSpeaker *self)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  _QueueEntry *entry = priv->queue ? priv->queue->data : NULL;

g_assert (entry);

if (entry->error)
    {
      g_assert (!entry->src);
      g_assert (!entry->parse);
      g_assert (!entry->volume);
      _advance_to_next_entry_or_finish (self, FALSE);
      return;
    }

gst_bin_add_many (GST_BIN (priv->pipeline), g_object_ref (entry->src),
                    g_object_ref (entry->parse), g_object_ref (entry->volume),
                    NULL);

gst_element_link_many (entry->src, entry->parse, entry->volume, priv->convert,
                         NULL);

if (!priv->paused)
    {
      gst_element_set_state (priv->pipeline, GST_STATE_PLAYING);
    }
}

static void
_advance_to_next_entry_or_finish (SpielSpeaker *self, gboolean canceled)
{
  SpielSpeakerPrivate *priv = spiel_speaker_get_instance_private (self);
  _QueueEntry *entry = priv->queue ? priv->queue->data : NULL;

g_assert (entry);

gst_element_set_state (priv->pipeline, GST_STATE_NULL);

if (entry->error)
    {
      g_signal_emit (self, speaker_signals[UTTERANCE_ERROR], 0,
                     entry->utterance, entry->error);
    }
  else
    {
      g_signal_emit (self,
                     canceled ? speaker_signals[UTTERANCE_CANCELED]
                              : speaker_signals[UTTERANCE_FINISHED],
                     0, entry->utterance);
    }

if (entry->src)
    {
      g_assert (entry->parse);
      g_assert (entry->volume);
      gst_bin_remove_many (GST_BIN (priv->pipeline), entry->src, entry->parse,
                           entry->volume, NULL);
    }

_queue_entry_destroy (entry);
  priv->queue = g_slist_delete_link (priv->queue, priv->queue);
  if (priv->queue)
    {
      _speak_current_entry (self);
    }
  else
    {
      g_object_notify (G_OBJECT (self), "speaking");
    }
}
0707010000002D000081A400000000000000000000000165D79E06000009A0000000000000000000000000000000000000002500000000spiel-1.0.0/libspiel/spiel-speaker.h/* spiel-speaker.h
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <gio/gio.h>
#include <glib-object.h>

#include "spiel-utterance.h"

G_BEGIN_DECLS

#define SPIEL_TYPE_SPEAKER (spiel_speaker_get_type ())

G_DECLARE_FINAL_TYPE (SpielSpeaker, spiel_speaker, SPIEL, SPEAKER, GObject)

void spiel_speaker_new (GCancellable *cancellable,
                        GAsyncReadyCallback callback,
                        gpointer user_data);

SpielSpeaker *spiel_speaker_new_finish (GAsyncResult *result, GError **error);

SpielSpeaker *spiel_speaker_new_sync (GCancellable *cancellable,
                                      GError **error);

void spiel_speaker_speak (SpielSpeaker *self, SpielUtterance *utterance);

void spiel_speaker_pause (SpielSpeaker *self);

void spiel_speaker_resume (SpielSpeaker *self);

void spiel_speaker_cancel (SpielSpeaker *self);

GListModel *spiel_speaker_get_voices (SpielSpeaker *self);

GListModel *spiel_speaker_get_providers (SpielSpeaker *self);

GQuark spiel_error_quark (void);

/**
 * SPIEL_ERROR:
 *
 * Domain for `SpielSpeaker` errors.
 */
#define SPIEL_ERROR spiel_error_quark ()

/**
 * SpielError:
 * @SPIEL_ERROR_NO_PROVIDERS: No speech providers are available
 * @SPIEL_ERROR_MISCONFIGURED_VOICE: Voice is not configured correctly
 * @SPIEL_ERROR_PROVIDER_UNEXPECTEDLY_DIED: Speech provider unexpectedly
 * died
 * @SPIEL_ERROR_INTERNAL_PROVIDER_FAILURE: Internal error in speech
 * provider
 *
 * Error codes in the `SPIEL_ERROR` domain that can be emitted in the
 * `utterance-error` signal.
 */
typedef enum /*<underscore_name=spiel_error>*/
{
  SPIEL_ERROR_NO_PROVIDERS,
  SPIEL_ERROR_MISCONFIGURED_VOICE,
  SPIEL_ERROR_PROVIDER_UNEXPECTEDLY_DIED,
  SPIEL_ERROR_INTERNAL_PROVIDER_FAILURE,
} SpielError;

G_END_DECLS
0707010000002E000081A400000000000000000000000165D79E0600003131000000000000000000000000000000000000002700000000spiel-1.0.0/libspiel/spiel-utterance.c/* spiel-utterance.c
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "spiel.h"

#include "spiel-utterance.h"

/**
 * SpielUtterance:
 *
 * Represents an utterance to be spoken by a #SpielSpeaker.
 *
 * An utterance consists of the text to be spoken and other properties that
 * affect the speech, like rate, pitch or voice used.
 *
 */

struct _SpielUtterance
{
  GObject parent_instance;
};

typedef struct
{
  char *text;
  double pitch;
  double rate;
  double volume;
  SpielVoice *voice;
  char *language;
  gboolean is_ssml;
} SpielUtterancePrivate;

G_DEFINE_FINAL_TYPE_WITH_PRIVATE (SpielUtterance,
                                  spiel_utterance,
                                  G_TYPE_OBJECT)

enum
{
  PROP_0,
  PROP_TEXT,
  PROP_PITCH,
  PROP_RATE,
  PROP_VOLUME,
  PROP_VOICE,
  PROP_LANGUAGE,
  PROP_IS_SSML,
  N_PROPS
};

static GParamSpec *properties[N_PROPS];

/**
 * spiel_utterance_new: (constructor)
 * @text: (not nullable): The utterance text to be spoken.
 *
 * Creates a new #SpielUtterance.
 *
 * Returns: The new #NotifyNotification.
 */
SpielUtterance *
spiel_utterance_new (const char *text)
{
  return g_object_new (SPIEL_TYPE_UTTERANCE, "text", text, NULL);
}

/**
 * spiel_utterance_get_text: (get-property text)
 * @self: a #SpielUtterance
 *
 * Fetches the text spoken in this utterance
 *
 * Returns: (transfer none): the text.
 */
const char *
spiel_utterance_get_text (SpielUtterance *self)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);

return priv->text;
}

/**
 * spiel_utterance_set_text: (set-property text)
 * @self: a #SpielUtterance
 * @text: the text to assign to this utterance
 *
 * Sets the text to be spoken by this utterance
 *
 */
void
spiel_utterance_set_text (SpielUtterance *self, const char *text)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);
  g_free (priv->text);
  priv->text = g_strdup (text);
  g_object_notify (G_OBJECT (self), "text");
}

/**
 * spiel_utterance_get_pitch: (get-property pitch)
 * @self: a #SpielUtterance
 *
 * Fetches the pitch used in this utterance
 *
 * Returns: the pitch value.
 */
double
spiel_utterance_get_pitch (SpielUtterance *self)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);

return priv->pitch;
}

/**
 * spiel_utterance_set_pitch: (set-property pitch)
 * @self: a #SpielUtterance
 * @pitch: a rate to assign to this utterance
 *
 * Sets a pitch on this utterance
 *
 */
void
spiel_utterance_set_pitch (SpielUtterance *self, double pitch)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);
  priv->pitch = pitch;
  g_object_notify (G_OBJECT (self), "pitch");
}

/**
 * spiel_utterance_get_rate: (get-property rate)
 * @self: a #SpielUtterance
 *
 * Fetches the rate used in this utterance
 *
 * Returns: the rate value.
 */
double
spiel_utterance_get_rate (SpielUtterance *self)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);

return priv->rate;
}

/**
 * spiel_utterance_set_rate: (set-property rate)
 * @self: a #SpielUtterance
 * @rate: a rate to assign to this utterance
 *
 * Sets a rate on this utterance
 *
 */
void
spiel_utterance_set_rate (SpielUtterance *self, double rate)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);
  priv->rate = rate;
  g_object_notify (G_OBJECT (self), "rate");
}

/**
 * spiel_utterance_get_volume: (get-property volume)
 * @self: a #SpielUtterance
 *
 * Fetches the volume used in this utterance
 *
 * Returns: the volume value.
 */
double
spiel_utterance_get_volume (SpielUtterance *self)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);

return priv->volume;
}

/**
 * spiel_utterance_set_volume: (set-property volume)
 * @self: a #SpielUtterance
 * @volume: a volume to assign to this utterance
 *
 * Sets a volume on this utterance
 *
 */
void
spiel_utterance_set_volume (SpielUtterance *self, double volume)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);
  priv->volume = volume;
  g_object_notify (G_OBJECT (self), "volume");
}

/**
 * spiel_utterance_get_voice: (get-property voice)
 * @self: a #SpielUtterance
 *
 * Fetches the voice used in this utterance
 *
 * Returns: (transfer none): the voice object.
 */
SpielVoice *
spiel_utterance_get_voice (SpielUtterance *self)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);

return priv->voice;
}

/**
 * spiel_utterance_set_voice: (set-property voice)
 * @self: a #SpielUtterance
 * @voice: a #SpielVoice to assign to this utterance
 *
 * Sets a voice on this utterance
 *
 */
void
spiel_utterance_set_voice (SpielUtterance *self, SpielVoice *voice)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);
  g_clear_object (&(priv->voice));

priv->voice = voice ? g_object_ref (voice) : NULL;
  g_object_notify (G_OBJECT (self), "voice");
}

/**
 * spiel_utterance_get_language: (get-property language)
 * @self: a #SpielUtterance
 *
 * Fetches the language used in this utterance.
 *
 * Returns: (transfer none): the language.
 */
const char *
spiel_utterance_get_language (SpielUtterance *self)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);

return priv->language;
}

/**
 * spiel_utterance_set_language: (set-property language)
 * @self: a #SpielUtterance
 * @language: the language to assign to this utterance
 *
 * Sets the language of this utterance
 *
 */
void
spiel_utterance_set_language (SpielUtterance *self, const char *language)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);
  g_free (priv->language);
  priv->language = g_strdup (language);
  g_object_notify (G_OBJECT (self), "language");
}

/**
 * spiel_utterance_get_is_ssml: (get-property is-ssml)
 * @self: a #SpielUtterance
 *
 * Is the current utterance an SSML snippet
 *
 * Returns: the utterance text is SSML
 */
gboolean
spiel_utterance_get_is_ssml (SpielUtterance *self)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);
  return priv->is_ssml;
}

/**
 * spiel_utterance_set_is_ssml: (set-property is-ssml)
 * @self: a #SpielUtterance
 * @is_ssml: whether the utterance text is an SSML snippet
 *
 * Indicates whether this utterance should be interpreted as SSML
 *
 */
void
spiel_utterance_set_is_ssml (SpielUtterance *self, gboolean is_ssml)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);
  priv->is_ssml = is_ssml;
}

static void
spiel_utterance_finalize (GObject *object)
{
  SpielUtterance *self = (SpielUtterance *) object;
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);

g_free (priv->text);
  g_free (priv->language);
  g_clear_object (&(priv->voice));

G_OBJECT_CLASS (spiel_utterance_parent_class)->finalize (object);
}

static void
spiel_utterance_get_property (GObject *object,
                              guint prop_id,
                              GValue *value,
                              GParamSpec *pspec)
{
  SpielUtterance *self = SPIEL_UTTERANCE (object);

switch (prop_id)
    {
    case PROP_TEXT:
      g_value_set_string (value, spiel_utterance_get_text (self));
      break;
    case PROP_PITCH:
      g_value_set_double (value, spiel_utterance_get_pitch (self));
      break;
    case PROP_RATE:
      g_value_set_double (value, spiel_utterance_get_rate (self));
      break;
    case PROP_VOLUME:
      g_value_set_double (value, spiel_utterance_get_volume (self));
      break;
    case PROP_VOICE:
      g_value_set_object (value, spiel_utterance_get_voice (self));
      break;
    case PROP_LANGUAGE:
      g_value_set_string (value, spiel_utterance_get_language (self));
      break;
    case PROP_IS_SSML:
      g_value_set_boolean (value, spiel_utterance_get_is_ssml (self));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
spiel_utterance_set_property (GObject *object,
                              guint prop_id,
                              const GValue *value,
                              GParamSpec *pspec)
{
  SpielUtterance *self = SPIEL_UTTERANCE (object);

switch (prop_id)
    {
    case PROP_TEXT:
      spiel_utterance_set_text (self, g_value_get_string (value));
      break;
    case PROP_PITCH:
      spiel_utterance_set_pitch (self, g_value_get_double (value));
      break;
    case PROP_RATE:
      spiel_utterance_set_rate (self, g_value_get_double (value));
      break;
    case PROP_VOLUME:
      spiel_utterance_set_volume (self, g_value_get_double (value));
      break;
    case PROP_VOICE:
      spiel_utterance_set_voice (self, g_value_dup_object (value));
      break;
    case PROP_LANGUAGE:
      spiel_utterance_set_language (self, g_value_get_string (value));
      break;
    case PROP_IS_SSML:
      spiel_utterance_set_is_ssml (self, g_value_get_boolean (value));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
spiel_utterance_class_init (SpielUtteranceClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

object_class->finalize = spiel_utterance_finalize;
  object_class->get_property = spiel_utterance_get_property;
  object_class->set_property = spiel_utterance_set_property;

/**
   * SpielUtterance:text: (getter get_text) (setter set_text)
   *
   * The utterance text that will be spoken.
   *
   */
  properties[PROP_TEXT] =
      g_param_spec_string ("text", NULL, NULL, NULL /* default value */,
                           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

/**
   * SpielUtterance:pitch: (getter get_pitch) (setter set_pitch)
   *
   * The pitch at which the utterance will be spoken.
   *
   */
  properties[PROP_PITCH] = g_param_spec_double (
      "pitch", NULL, NULL, 0, 2, 1, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

/**
   * SpielUtterance:rate: (getter get_rate) (setter set_rate)
   *
   * The speed at which the utterance will be spoken.
   *
   */
  properties[PROP_RATE] =
      g_param_spec_double ("rate", NULL, NULL, 0.1, 10, 1,
                           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

/**
   * SpielUtterance:volume: (getter get_volume) (setter set_volume)
   *
   * The volume at which the utterance will be spoken.
   *
   */
  properties[PROP_VOLUME] =
      g_param_spec_double ("volume", NULL, NULL, 0, 1, 1,
                           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

/**
   * SpielUtterance:voice: (getter get_voice) (setter set_voice)
   *
   * The voice with which the utterance will be spoken.
   *
   */
  properties[PROP_VOICE] =
      g_param_spec_object ("voice", NULL, NULL, SPIEL_TYPE_VOICE,
                           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

/**
   * SpielUtterance:language: (getter get_language) (setter set_language)
   *
   * The utterance language. If no voice is set this language will be used to
   * select the best matching voice.
   *
   */
  properties[PROP_LANGUAGE] =
      g_param_spec_string ("language", NULL, NULL, NULL /* default value */,
                           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

/**
   * SpielUtterance:is-ssml: (getter get_is_ssml) (setter set_is_ssml)
   *
   * Whether the utterance's text should be interpreted as an SSML snippet.
   *
   */
  properties[PROP_IS_SSML] = g_param_spec_boolean (
      "is-ssml", NULL, NULL, FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

g_object_class_install_properties (object_class, N_PROPS, properties);
}

static void
spiel_utterance_init (SpielUtterance *self)
{
  SpielUtterancePrivate *priv = spiel_utterance_get_instance_private (self);
  priv->text = NULL;
  priv->rate = 1;
  priv->volume = 1;
  priv->pitch = 1;
  priv->voice = NULL;
  priv->language = NULL;
  priv->is_ssml = FALSE;
}
0707010000002F000081A400000000000000000000000165D79E06000007C3000000000000000000000000000000000000002700000000spiel-1.0.0/libspiel/spiel-utterance.h/* spiel-utterance.h
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include "spiel-voice.h"
#include <glib-object.h>

G_BEGIN_DECLS

#define SPIEL_TYPE_UTTERANCE (spiel_utterance_get_type ())

G_DECLARE_FINAL_TYPE (
    SpielUtterance, spiel_utterance, SPIEL, UTTERANCE, GObject)

SpielUtterance *spiel_utterance_new (const char *text);

const char *spiel_utterance_get_text (SpielUtterance *self);

void spiel_utterance_set_text (SpielUtterance *self, const char *text);

double spiel_utterance_get_pitch (SpielUtterance *self);

void spiel_utterance_set_pitch (SpielUtterance *self, double pitch);

double spiel_utterance_get_rate (SpielUtterance *self);

void spiel_utterance_set_rate (SpielUtterance *self, double rate);

double spiel_utterance_get_volume (SpielUtterance *self);

void spiel_utterance_set_volume (SpielUtterance *self, double volume);

SpielVoice *spiel_utterance_get_voice (SpielUtterance *self);

void spiel_utterance_set_voice (SpielUtterance *self, SpielVoice *voice);

const char *spiel_utterance_get_language (SpielUtterance *self);

void spiel_utterance_set_language (SpielUtterance *self, const char *language);

void spiel_utterance_set_is_ssml (SpielUtterance *self, gboolean is_ssml);

gboolean spiel_utterance_get_is_ssml (SpielUtterance *self);

G_END_DECLS
07070100000030000081A400000000000000000000000165D79E0600000808000000000000000000000000000000000000002800000000spiel-1.0.0/libspiel/spiel-version.h.in
#pragma once

#if !defined(LIBSPIEL_INSIDE) && !defined(SPIEL_COMPILATION)
#error "Only <spiel.h> can be included directly."
#endif

/**
 * SECTION:spielversion
 * @short_description: spiel version checking
 *
 * spiel provides macros to check the version of the library
 * at compile-time
 */

/**
 * SPIEL_MAJOR_VERSION:
 *
 * spiel major version component (e.g. 1 if %SPIEL_VERSION is 1.2.3)
 */
#define SPIEL_MAJOR_VERSION (@MAJOR_VERSION @)

/**
 * SPIEL_MINOR_VERSION:
 *
 * spiel minor version component (e.g. 2 if %SPIEL_VERSION is 1.2.3)
 */
#define SPIEL_MINOR_VERSION (@MINOR_VERSION @)

/**
 * SPIEL_MICRO_VERSION:
 *
 * spiel micro version component (e.g. 3 if %SPIEL_VERSION is 1.2.3)
 */
#define SPIEL_MICRO_VERSION (@MICRO_VERSION @)

/**
 * SPIEL_VERSION
 *
 * spiel version.
 */
#define SPIEL_VERSION (@VERSION @)

/**
 * SPIEL_VERSION_S:
 *
 * spiel version, encoded as a string, useful for printing and
 * concatenation.
 */
#define SPIEL_VERSION_S "@VERSION@"

#define SPIEL_ENCODE_VERSION(major, minor, micro)                              \
  ((major) << 24 | (minor) << 16 | (micro) << 8)

/**
 * SPIEL_VERSION_HEX:
 *
 * spiel version, encoded as an hexadecimal number, useful for
 * integer comparisons.
 */
#define SPIEL_VERSION_HEX                                                      \
  (SPIEL_ENCODE_VERSION (SPIEL_MAJOR_VERSION, SPIEL_MINOR_VERSION,             \
                         SPIEL_MICRO_VERSION))

/**
 * SPIEL_CHECK_VERSION:
 * @major: required major version
 * @minor: required minor version
 * @micro: required micro version
 *
 * Compile-time version checking. Evaluates to %TRUE if the version
 * of spiel is greater than the required one.
 */
#define SPIEL_CHECK_VERSION(major, minor, micro)                               \
  (SPIEL_MAJOR_VERSION > (major) ||                                            \
   (SPIEL_MAJOR_VERSION == (major) && SPIEL_MINOR_VERSION > (minor)) ||        \
   (SPIEL_MAJOR_VERSION == (major) && SPIEL_MINOR_VERSION == (minor) &&        \
    SPIEL_MICRO_VERSION >= (micro)))
07070100000031000081A400000000000000000000000165D79E060000282B000000000000000000000000000000000000002300000000spiel-1.0.0/libspiel/spiel-voice.c/* spiel-voice.c
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "spiel.h"

#include "spiel-provider.h"
#include "spiel-voice.h"

/**
 * SpielVoice:
 *
 * Represents a voice implemented by a speech provider.
 *
 * A DBus speech provider advertises a list of voices that it implements.
 * Each voice will have human-readable name, a unique identifier, and a list
 * of languages supported by the voice.
 *
 */

struct _SpielVoice
{
  GObject parent_instance;
};

typedef struct
{
  char *name;
  char *identifier;
  char **languages;
  char *output_format;
  SpielVoiceFeature features;
  GWeakRef provider;
} SpielVoicePrivate;

G_DEFINE_FINAL_TYPE_WITH_PRIVATE (SpielVoice, spiel_voice, G_TYPE_OBJECT)

enum
{
  PROP_0,
  PROP_NAME,
  PROP_IDENTIFIER,
  PROP_LANGUAGES,
  PROP_PROVIDER,
  PROP_FEATURES,
  N_PROPS
};

static GParamSpec *properties[N_PROPS];

/**
 * spiel_voice_get_name: (get-property name)
 * @self: a #SpielVoice
 *
 * Fetches the name.
 *
 * Returns: (transfer none): the name text. This string is
 *   owned by the voice and must not be modified or freed.
 */
const char *
spiel_voice_get_name (SpielVoice *self)
{
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);
  return priv->name;
}

/**
 * spiel_voice_get_identifier: (get-property identifier)
 * @self: a #SpielVoice
 *
 * Fetches the identifier.
 *
 * Returns: the identifier text. This string is
 *   owned by the voice and must not be modified or freed.
 */
const char *
spiel_voice_get_identifier (SpielVoice *self)
{
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);
  return priv->identifier;
}

/**
 * spiel_voice_get_provider: (get-property provider)
 * @self: a #SpielVoice
 *
 * Fetches the provider associated with this voice
 *
 * Returns: (transfer none): a #SpielProvider
 */
SpielProvider *
spiel_voice_get_provider (SpielVoice *self)
{
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);
  return g_weak_ref_get (&priv->provider);
}

/**
 * spiel_voice_get_languages: (get-property languages)
 * @self: a #SpielVoice
 *
 * Fetches the list of supported languages
 *
 * Returns: the list of supported languages. This list is
 *   owned by the voice and must not be modified or freed.
 */
const char *const *
spiel_voice_get_languages (SpielVoice *self)
{
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);
  return (const char *const *) priv->languages;
}

SpielVoiceFeature
spiel_voice_get_features (SpielVoice *self)
{
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);
  return priv->features;
}

const char *
spiel_voice_get_output_format (SpielVoice *self)
{
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);
  return priv->output_format;
}

void
spiel_voice_set_output_format (SpielVoice *self, const char *output_format)
{
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);
  g_clear_pointer (&priv->output_format, g_free);
  priv->output_format = g_strdup (output_format);
}

guint
spiel_voice_hash (SpielVoice *self)
{
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);
  SpielProvider *provider = spiel_voice_get_provider (self);
  guint hash = 0;

hash = g_str_hash (priv->name);
  hash = (hash << 5) - hash + g_str_hash (priv->identifier);
  if (provider)
    {
      hash = (hash << 5) - hash +
             g_str_hash (spiel_provider_get_well_known_name (provider));
    }

for (char **language = priv->languages; *language; language++)
    {
      hash = (hash << 5) - hash + g_str_hash (*language);
    }

return hash;
}

gboolean
spiel_voice_equal (SpielVoice *self, SpielVoice *other)
{
  SpielVoicePrivate *self_priv = spiel_voice_get_instance_private (self);
  SpielVoicePrivate *other_priv = spiel_voice_get_instance_private (other);

if (g_weak_ref_get (&self_priv->provider) !=
      g_weak_ref_get (&other_priv->provider))
    {
      return FALSE;
    }

if (!g_str_equal (self_priv->name, other_priv->name))
    {
      return FALSE;
    }

if (!g_str_equal (self_priv->identifier, other_priv->identifier))
    {
      return FALSE;
    }

if (!g_strv_equal ((const gchar *const *) self_priv->languages,
                     (const gchar *const *) other_priv->languages))
    {
      return FALSE;
    }

return TRUE;
}

gint
spiel_voice_compare (SpielVoice *self, SpielVoice *other, gpointer user_data)
{
  SpielVoicePrivate *self_priv = spiel_voice_get_instance_private (self);
  SpielVoicePrivate *other_priv = spiel_voice_get_instance_private (other);
  SpielProvider *self_provider = g_weak_ref_get (&self_priv->provider);
  SpielProvider *other_provider = g_weak_ref_get (&other_priv->provider);
  gint cmp = 0;

if ((cmp = g_strcmp0 (
           self_provider ? spiel_provider_get_well_known_name (self_provider)
                         : "",
           other_provider ? spiel_provider_get_well_known_name (other_provider)
                          : "")))
    {
      return cmp;
    }

if ((cmp = g_strcmp0 (self_priv->name, other_priv->name)))
    {
      return cmp;
    }

if ((cmp = g_strcmp0 (self_priv->identifier, other_priv->identifier)))
    {
      return cmp;
    }

return cmp;
}

static void
spiel_voice_finalize (GObject *object)
{
  SpielVoice *self = (SpielVoice *) object;
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);

g_free (priv->name);
  g_free (priv->identifier);
  g_strfreev (priv->languages);

G_OBJECT_CLASS (spiel_voice_parent_class)->finalize (object);
}

static void
spiel_voice_get_property (GObject *object,
                          guint prop_id,
                          GValue *value,
                          GParamSpec *pspec)
{
  SpielVoice *self = SPIEL_VOICE (object);
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);

switch (prop_id)
    {
    case PROP_NAME:
      g_value_set_string (value, priv->name);
      break;
    case PROP_IDENTIFIER:
      g_value_set_string (value, priv->identifier);
      break;
    case PROP_LANGUAGES:
      g_value_set_boxed (value, priv->languages);
      break;
    case PROP_PROVIDER:
      g_value_set_object (value, spiel_voice_get_provider (self));
      break;
    case PROP_FEATURES:
      g_value_set_flags (value, priv->features);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
spiel_voice_set_property (GObject *object,
                          guint prop_id,
                          const GValue *value,
                          GParamSpec *pspec)
{
  SpielVoice *self = SPIEL_VOICE (object);
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);

switch (prop_id)
    {
    case PROP_NAME:
      g_clear_pointer (&priv->name, g_free);
      priv->name = g_value_dup_string (value);
      break;
    case PROP_IDENTIFIER:
      g_clear_pointer (&priv->identifier, g_free);
      priv->identifier = g_value_dup_string (value);
      break;
    case PROP_LANGUAGES:
      g_strfreev (priv->languages);
      priv->languages = g_value_dup_boxed (value);
      break;
    case PROP_PROVIDER:
      g_weak_ref_set (&priv->provider, g_value_get_object (value));
      break;
    case PROP_FEATURES:
      priv->features = g_value_get_flags (value);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
spiel_voice_class_init (SpielVoiceClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

object_class->finalize = spiel_voice_finalize;
  object_class->get_property = spiel_voice_get_property;
  object_class->set_property = spiel_voice_set_property;

/**
   * SpielVoice:name: (getter get_name)
   *
   * A human readable name for the voice. Not guaranteed to be unique.
   * May, or may not, be localized by the speech provider.
   *
   */
  properties[PROP_NAME] = g_param_spec_string (
      "name", NULL, NULL, NULL /* default value */,
      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

/**
   * SpielVoice:identifier: (getter get_identifier)
   *
   * A unique identifier of the voice. The uniqueness should be considered
   * in the scope of the provider (ie. two providers can use the same
   * identifier).
   *
   */
  properties[PROP_IDENTIFIER] = g_param_spec_string (
      "identifier", NULL, NULL, NULL /* default value */,
      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

/**
   * SpielVoice:languages: (getter get_languages)
   *
   * A list of supported languages encoded as BCP 47 tags.
   *
   */
  properties[PROP_LANGUAGES] = g_param_spec_boxed (
      "languages", NULL, NULL, G_TYPE_STRV,
      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

/**
   * SpielVoice:provider: (getter get_provider)
   *
   * The speech provider that implements this voice.
   *
   */
  properties[PROP_PROVIDER] = g_param_spec_object (
      "provider", NULL, NULL, SPIEL_TYPE_PROVIDER,
      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

properties[PROP_FEATURES] = g_param_spec_flags (
      "features", NULL, NULL, SPIEL_TYPE_VOICE_FEATURE,
      SPIEL_VOICE_FEATURE_NONE,
      G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

g_object_class_install_properties (object_class, N_PROPS, properties);
}

static void
spiel_voice_init (SpielVoice *self)
{
  SpielVoicePrivate *priv = spiel_voice_get_instance_private (self);

priv->name = NULL;
  priv->identifier = NULL;
  priv->languages = NULL;
  priv->output_format = NULL;
  priv->features = 0;
}
07070100000032000081A400000000000000000000000165D79E060000069D000000000000000000000000000000000000002300000000spiel-1.0.0/libspiel/spiel-voice.h/* spiel-voice.h
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include "spiel-dbus-enums.h"
#include <glib-object.h>

typedef struct _SpielProvider SpielProvider;

G_BEGIN_DECLS

#define SPIEL_TYPE_VOICE (spiel_voice_get_type ())

G_DECLARE_FINAL_TYPE (SpielVoice, spiel_voice, SPIEL, VOICE, GObject)

const char *spiel_voice_get_name (SpielVoice *self);

const char *spiel_voice_get_identifier (SpielVoice *self);

SpielProvider *spiel_voice_get_provider (SpielVoice *self);

const char *const *spiel_voice_get_languages (SpielVoice *self);

SpielVoiceFeature spiel_voice_get_features (SpielVoice *self);

const char *spiel_voice_get_output_format (SpielVoice *self);

void spiel_voice_set_output_format (SpielVoice *self,
                                    const char *output_format);

guint spiel_voice_hash (SpielVoice *self);

gboolean spiel_voice_equal (SpielVoice *self, SpielVoice *other);

gint
spiel_voice_compare (SpielVoice *self, SpielVoice *other, gpointer user_data);

G_END_DECLS
07070100000033000081A400000000000000000000000165D79E0600001D2F000000000000000000000000000000000000002F00000000spiel-1.0.0/libspiel/spiel-voices-list-model.c/* spiel-utterance.c
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "spiel-voices-list-model.h"

#include "spiel-provider-private.h"
#include "spiel-voice.h"

/**
 * SpielVoicesListModel:
 *
 * Represents an aggregate of all the voices available to Spiel.
 *
 *
 */

struct _SpielVoicesListModel
{
  GObject parent_instance;

GListModel *providers;
  GListStore *mirrored_providers; // XXX: Used to track removed providers
};

static void spiel_voices_list_model_iface_init (GListModelInterface *iface);

G_DEFINE_TYPE_WITH_CODE (
    SpielVoicesListModel,
    spiel_voices_list_model,
    G_TYPE_OBJECT,
    G_IMPLEMENT_INTERFACE (G_TYPE_LIST_MODEL,
                           spiel_voices_list_model_iface_init));

static void handle_providers_changed (GListModel *providers,
                                      guint position,
                                      guint removed,
                                      guint added,
                                      SpielVoicesListModel *self);

SpielVoicesListModel *
spiel_voices_list_model_new (GListModel *providers)
{
  SpielVoicesListModel *self =
      g_object_new (SPIEL_TYPE_VOICES_LIST_MODEL, NULL);

g_assert_cmpint (g_list_model_get_n_items (providers), ==, 0);
  self->providers = g_object_ref (providers);
  g_signal_connect (self->providers, "items-changed",
                    G_CALLBACK (handle_providers_changed), self);
  return self;
}

static void
spiel_voices_list_model_finalize (GObject *object)
{
  SpielVoicesListModel *self = (SpielVoicesListModel *) object;

g_signal_handlers_disconnect_by_func (
      self->providers, G_CALLBACK (handle_providers_changed), self);

g_clear_object (&(self->providers));

g_clear_object (&(self->mirrored_providers));

G_OBJECT_CLASS (spiel_voices_list_model_parent_class)->finalize (object);
}

static void
spiel_voices_list_model_class_init (SpielVoicesListModelClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

object_class->finalize = spiel_voices_list_model_finalize;
}

static void
spiel_voices_list_model_init (SpielVoicesListModel *self)
{
  self->providers = NULL;
  self->mirrored_providers = g_list_store_new (SPIEL_TYPE_PROVIDER);
}

static GType
spiel_voices_list_model_get_item_type (GListModel *list)
{
  return SPIEL_TYPE_VOICE;
}

static guint
spiel_voices_list_model_get_n_items (GListModel *list)
{
  SpielVoicesListModel *self = SPIEL_VOICES_LIST_MODEL (list);
  guint total = 0;
  guint providers_count = g_list_model_get_n_items (self->providers);

for (guint i = 0; i < providers_count; i++)
    {
      g_autoptr (SpielProvider) provider =
          SPIEL_PROVIDER (g_list_model_get_object (self->providers, i));
      GListModel *voices = G_LIST_MODEL (spiel_provider_get_voices (provider));
      total += g_list_model_get_n_items (voices);
    }

return total;
}

static gpointer
spiel_voices_list_model_get_item (GListModel *list, guint position)
{
  SpielVoicesListModel *self = SPIEL_VOICES_LIST_MODEL (list);
  guint total = 0;
  guint providers_count = g_list_model_get_n_items (self->providers);

for (guint i = 0; i < providers_count; i++)
    {
      g_autoptr (SpielProvider) provider =
          SPIEL_PROVIDER (g_list_model_get_object (self->providers, i));
      GListModel *voices = spiel_provider_get_voices (provider);
      guint voice_count = g_list_model_get_n_items (voices);

if (position >= total && position < (total + voice_count))
        {
          return g_list_model_get_item (voices, position - total);
        }
      total += voice_count;
    }

return NULL;
}

static void
spiel_voices_list_model_iface_init (GListModelInterface *iface)
{
  iface->get_item_type = spiel_voices_list_model_get_item_type;
  iface->get_n_items = spiel_voices_list_model_get_n_items;
  iface->get_item = spiel_voices_list_model_get_item;
}

/* Notifications and such */

static void
handle_voices_changed (GListModel *voices,
                       guint position,
                       guint removed,
                       guint added,
                       SpielVoicesListModel *self)
{
  guint offset = 0;
  guint providers_count = g_list_model_get_n_items (self->providers);

for (guint i = 0; i < providers_count; i++)
    {
      g_autoptr (SpielProvider) provider =
          SPIEL_PROVIDER (g_list_model_get_object (self->providers, i));
      if (voices == spiel_provider_get_voices (provider))
        {
          g_list_model_items_changed (G_LIST_MODEL (self), position + offset,
                                      removed, added);
          break;
        }
      offset += g_list_model_get_n_items (voices);
    }
}

static void
_connect_signals (SpielVoicesListModel *self, SpielProvider *provider)
{
  GListModel *voices = spiel_provider_get_voices (provider);
  g_signal_connect (voices, "items-changed", G_CALLBACK (handle_voices_changed),
                    self);
}

static void
_disconnect_signals (SpielVoicesListModel *self, SpielProvider *provider)
{
  GListModel *voices = spiel_provider_get_voices (provider);
  g_signal_handlers_disconnect_by_func (
      voices, G_CALLBACK (handle_voices_changed), self);
}

static void
handle_providers_changed (GListModel *providers,
                          guint position,
                          guint removed,
                          guint added,
                          SpielVoicesListModel *self)
{
  guint removed_voices_count = 0;
  guint added_voices_count = 0;
  guint offset = 0;

for (guint i = position; i < position + removed; i++)
    {
      g_autoptr (SpielProvider) provider = SPIEL_PROVIDER (
          g_list_model_get_object (G_LIST_MODEL (self->mirrored_providers), i));
      GListModel *voices = spiel_provider_get_voices (provider);
      removed_voices_count += g_list_model_get_n_items (voices);
      _disconnect_signals (self, provider);
    }

g_list_store_splice (self->mirrored_providers, position, removed, NULL, 0);

for (guint i = position; i < position + added; i++)
    {
      g_autoptr (SpielProvider) provider =
          SPIEL_PROVIDER (g_list_model_get_object (self->providers, i));
      GListModel *voices = spiel_provider_get_voices (provider);
      added_voices_count += g_list_model_get_n_items (voices);
      _connect_signals (self, provider);
      g_list_store_insert (self->mirrored_providers, i, provider);
    }

for (guint i = 0; i < position; i++)
    {
      g_autoptr (SpielProvider) provider =
          SPIEL_PROVIDER (g_list_model_get_object (self->providers, i));
      GListModel *voices = spiel_provider_get_voices (provider);
      offset += g_list_model_get_n_items (voices);
    }

g_list_model_items_changed (G_LIST_MODEL (self), offset, removed_voices_count,
                              added_voices_count);
}
07070100000034000081A400000000000000000000000165D79E06000004A5000000000000000000000000000000000000002F00000000spiel-1.0.0/libspiel/spiel-voices-list-model.h/* spiel-voices-list-model.h
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <gio/gio.h>
#include <glib-object.h>

G_BEGIN_DECLS

#define SPIEL_TYPE_VOICES_LIST_MODEL (spiel_voices_list_model_get_type ())

G_DECLARE_FINAL_TYPE (SpielVoicesListModel,
                      spiel_voices_list_model,
                      SPIEL,
                      VOICES_LIST_MODEL,
                      GObject)

SpielVoicesListModel *spiel_voices_list_model_new (GListModel *providers);

G_END_DECLS
07070100000035000081A400000000000000000000000165D79E06000003F4000000000000000000000000000000000000001D00000000spiel-1.0.0/libspiel/spiel.h/* spiel.h
 *
 * Copyright (C) 2023 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <glib.h>

G_BEGIN_DECLS

#define LIBSPIEL_INSIDE
#include "spiel-dbus-enums.h"
#include "spiel-provider.h"
#include "spiel-speaker.h"
#include "spiel-utterance.h"
#include "spiel-version.h"
#include "spiel-voice.h"
#undef LIBSPIEL_INSIDE

G_END_DECLS
07070100000036000081A400000000000000000000000165D79E060000093D000000000000000000000000000000000000001800000000spiel-1.0.0/meson.buildproject('spiel', 'c',
          version: '1.0.0',
    meson_version: '>= 0.64.0',
  default_options: [ 'warning_level=2', 'werror=false', 'c_std=gnu11', ],
)

api_version = '1.0'

cc = meson.get_compiler('c')

config_h = configuration_data()
config_h.set_quoted('PACKAGE_VERSION', meson.project_version())
configure_file(output: 'config.h', configuration: config_h)
add_project_arguments(['-I' + meson.project_build_root()], language: 'c')

project_c_args = []
test_c_args = [
  '-Wcast-align',
  '-Wdeclaration-after-statement',
  '-Werror=address',
  '-Werror=array-bounds',
  '-Werror=empty-body',
  '-Werror=implicit',
  '-Werror=implicit-function-declaration',
  '-Werror=incompatible-pointer-types',
  '-Werror=init-self',
  '-Werror=int-conversion',
  '-Werror=int-to-pointer-cast',
  '-Werror=main',
  '-Werror=misleading-indentation',
  '-Werror=missing-braces',
  '-Werror=missing-include-dirs',
  '-Werror=nonnull',
  '-Werror=overflow',
  '-Werror=parenthesis',
  '-Werror=pointer-arith',
  '-Werror=pointer-to-int-cast',
  '-Werror=redundant-decls',
  '-Werror=return-type',
  '-Werror=sequence-point',
  '-Werror=shadow',
  '-Werror=strict-prototypes',
  '-Werror=trigraphs',
  '-Werror=undef',
  '-Werror=write-strings',
  '-Wformat-nonliteral',
  '-Wignored-qualifiers',
  '-Wimplicit-function-declaration',
  '-Wlogical-op',
  '-Wmissing-declarations',
  '-Wmissing-format-attribute',
  '-Wmissing-include-dirs',
  '-Wmissing-noreturn',
  '-Wnested-externs',
  '-Wno-cast-function-type',
  '-Wno-dangling-pointer',
  '-Wno-missing-field-initializers',
  '-Wno-sign-compare',
  '-Wno-unused-parameter',
  '-Wold-style-definition',
  '-Wpointer-arith',
  '-Wredundant-decls',
  '-Wstrict-prototypes',
  '-Wswitch-default',
  '-Wswitch-enum',
  '-Wundef',
  '-Wuninitialized',
  '-Wunused',
  '-fno-strict-aliasing',
  ['-Werror=format-security', '-Werror=format=2'],
]
if get_option('buildtype') != 'plain'
  test_c_args += '-fstack-protector-strong'
endif
foreach arg: test_c_args
  if cc.has_multi_arguments(arg)
    project_c_args += arg
  endif
endforeach
add_project_arguments(project_c_args, language: 'c')

subdir('libspeechprovider')

if get_option('libspiel')
  subdir('libspiel')

if get_option('tests')
    subdir('tests')
  endif

if get_option('utils')
    subdir('utils')
  endif
endif

if get_option('docs')
  subdir('doc')
endif

07070100000037000081A400000000000000000000000165D79E0600000138000000000000000000000000000000000000001E00000000spiel-1.0.0/meson_options.txtoption('libspiel', type: 'boolean', value: true, description: 'Enable libspiel')
option('tests', type: 'boolean', value: true, description: 'Enable tests')
option('docs', type: 'boolean', value: true, description: 'Enable docs')
option('utils', type: 'boolean', value: true, description: 'Enable CLI utilities')
07070100000038000081A400000000000000000000000165D79E0600069A48000000000000000000000000000000000000001B00000000spiel-1.0.0/spiel-logo.svg<?xml version="1.0" encoding="UTF-8" standalone="no"?>

import gi

gi.require_version("Spiel", "1.0")
from gi.repository import Spiel

dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)

LOG_EVENTS = False

STANDARD_VOICES = [
    ["org.mock2.Speech.Provider", "English (Great Britain)", "gmw/en", ["en-gb", "en"]],
    [
        "org.mock2.Speech.Provider",
        "English (Scotland)",
        "gmw/en-GB-scotland#misconfigured",
        ["en-gb-scotland", "en"],
    ],
    [
        "org.mock2.Speech.Provider",
        "English (Lancaster)",
        "gmw/en-GB-x-gbclan",
        ["en-gb-x-gbclan", "en-gb", "en"],
    ],
    ["org.mock2.Speech.Provider", "English (America)", "gmw/en-US", ["en-us", "en"]],
    [
        "org.mock.Speech.Provider",
        "Armenian (East Armenia)",
        "ine/hy",
        ["hy", "hy-arevela"],
    ],
    [
        "org.mock2.Speech.Provider",
        "Armenian (West Armenia)",
        "ine/hyw",
        ["hyw", "hy-arevmda", "hy"],
    ],
    [
        "org.mock.Speech.Provider",
        "Chinese (Cantonese)",
        "sit/yue",
        ["yue", "zh-yue", "zh"],
    ],
    ["org.mock3.Speech.Provider", "Uzbek", "trk/uz", ["uz"]],
]

class BaseSpielTest(unittest.TestCase):
    def __init__(self, *args):
        super().__init__(*args)

def setUp(self):
        self.mock_service = self.mock_iface("org.mock.Speech.Provider")
        self.mock_service.SetInfinite(False)
        self.mock_service.FlushTasks()

def tearDown(self):
        settings = Gio.Settings.new("org.monotonous.libspiel")
        settings["default-voice"] = None
        settings["language-voice-mapping"] = {}
        discarded_dir = os.environ["TEST_DISCARDED_SERVICE_DIR"]
        service_dir = os.environ["TEST_SERVICE_DIR"]
        for fname in os.listdir(discarded_dir):
            os.rename(
                os.path.join(discarded_dir, fname), os.path.join(service_dir, fname)
            )

def mock_iface(self, provider_name):
        session_bus = dbus.SessionBus()
        proxy = session_bus.get_object(
            provider_name,
            f"/{'/'.join(provider_name.split('.'))}",
        )
        return dbus.Interface(
            proxy, dbus_interface="org.freedesktop.Speech.MockProvider"
        )

def kill_provider(self, provider_name):
        try:
            self.mock_iface(provider_name).KillMe()
        except:
            pass

def list_active_providers(self):
        session_bus = dbus.SessionBus()
        bus_obj = session_bus.get_object(
            "org.freedesktop.DBus", "/org/freedesktop/DBus"
        )
        iface = dbus.Interface(bus_obj, "org.freedesktop.DBus")
        speech_providers = filter(
            lambda s: s.endswith(".Speech.Provider"),
            iface.ListNames(),
        )
        return [str(s) for s in speech_providers]

def wait_for_async_speaker_init(self):
        def _init_cb(source, result, user_data):
            user_data.append(Spiel.Speaker.new_finish(result))
            loop.quit()

speakerContainer = []
        Spiel.Speaker.new(None, _init_cb, speakerContainer)
        loop = GLib.MainLoop()
        loop.run()
        return speakerContainer[0]

def wait_for_provider_to_go_away(self, name):
        def _cb(*args):
            self.assertNotIn(name, self.list_active_providers())
            session_bus.remove_signal_receiver(
                _cb,
                bus_name="org.freedesktop.DBus",
                dbus_interface="org.freedesktop.DBus",
                signal_name="NameOwnerChanged",
                path="/org/freedesktop/DBus",
                arg0=name,
            )
            GLib.idle_add(loop.quit)

speech_providers = self.list_active_providers()
        if name not in speech_providers:
            return

session_bus = dbus.SessionBus()
        sig_match = session_bus.add_signal_receiver(
            _cb,
            bus_name="org.freedesktop.DBus",
            dbus_interface="org.freedesktop.DBus",
            signal_name="NameOwnerChanged",
            path="/org/freedesktop/DBus",
            arg0=name,
        )
        loop = GLib.MainLoop()
        loop.run()

def wait_for_voices_changed(self, speaker, added=[], removed=[]):
        voices = speaker.props.voices

def _cb(*args):
            voice_ids = [v.props.identifier for v in voices]
            for a in added:
                if a not in voice_ids:
                    return
            for r in removed:
                if r in voice_ids:
                    return
            voices.disconnect_by_func(_cb)
            loop.quit()

voices.connect("items-changed", _cb)
        loop = GLib.MainLoop()
        loop.run()

def wait_for_speaking_done(self, speaker, action):
        def _cb(*args):
            if not speaker.props.speaking:
                speaker.disconnect_by_func(_cb)
                loop.quit()

speaker.connect("notify::speaking", _cb)
        action()
        loop = GLib.MainLoop()
        loop.run()

def uninstall_provider(self, name):
        src = os.path.join(
            os.environ["TEST_SERVICE_DIR"], f"{name}{os.path.extsep}service"
        )
        dest = os.path.join(
            os.environ["TEST_DISCARDED_SERVICE_DIR"], f"{name}{os.path.extsep}service"
        )
        os.rename(src, dest)

def install_provider(self, name):
        src = os.path.join(
            os.environ["TEST_DISCARDED_SERVICE_DIR"], f"{name}{os.path.extsep}service"
        )
        dest = os.path.join(
            os.environ["TEST_SERVICE_DIR"], f"{name}{os.path.extsep}service"
        )
        os.rename(src, dest)

def get_voice(self, synth, provider_well_known_name, voice_id):
        for v in synth.props.voices:
            if (
                v.props.provider.get_well_known_name() == provider_well_known_name
                and v.props.identifier == voice_id
            ):
                return v

def capture_speak_sequence(self, speaker, *utterances):
        event_sequence = []

def _append_to_sequence(signal_and_args):
            event_sequence.append(signal_and_args)
            if LOG_EVENTS:
                print(signal_and_args)

def _notify_speaking_cb(synth, val):
            _append_to_sequence(["notify:speaking", synth.props.speaking])
            if not synth.props.speaking:
                loop.quit()

def _notify_paused_cb(synth, val):
            _append_to_sequence(["notify:paused", synth.props.paused])

def _utterance_started_cb(synth, utt):
            _append_to_sequence(["utterance-started", utt])

def _utterance_word_started_cb(synth, utt, start, end):
            _append_to_sequence(["word-started", utt, start, end])

def _utterance_sentence_started_cb(synth, utt, start, end):
            _append_to_sequence(["sentence-started", utt, start, end])

def _utterance_canceled_cb(synth, utt):
            _append_to_sequence(["utterance-canceled", utt])

def _utterance_finished_cb(synth, utt):
            _append_to_sequence(["utterance-finished", utt])

def _utterance_error_cb(synth, utt, error):
            _append_to_sequence(
                ["utterance-error", utt, (error.domain, error.code, error.message)]
            )
            if not synth.props.speaking:
                loop.quit()

speaker.connect("notify::speaking", _notify_speaking_cb)
        speaker.connect("notify::paused", _notify_paused_cb)
        speaker.connect("utterance-started", _utterance_started_cb)
        speaker.connect("utterance-canceled", _utterance_canceled_cb)
        speaker.connect("utterance-finished", _utterance_finished_cb)
        speaker.connect("utterance-error", _utterance_error_cb)
        speaker.connect("word-started", _utterance_word_started_cb)
        speaker.connect("sentence-started", _utterance_sentence_started_cb)

def do_speak():
            for utterance in utterances:
                speaker.speak(utterance)

GLib.idle_add(do_speak)

loop = GLib.MainLoop()
        loop.run()

return event_sequence

def test_main():
    from tap.runner import TAPTestRunner

runner = TAPTestRunner()
    runner.set_stream(True)
    unittest.main(testRunner=runner)
0707010000003B000041ED00000000000000000000000265D79E0600000000000000000000000000000000000000000000002500000000spiel-1.0.0/tests/discarded_services0707010000003C000081A400000000000000000000000165D79E0600000000000000000000000000000000000000000000003100000000spiel-1.0.0/tests/discarded_services/meson.build0707010000003D000081A400000000000000000000000165D79E0600000AB7000000000000000000000000000000000000001E00000000spiel-1.0.0/tests/meson.buildservice_dir = join_paths(meson.current_build_dir(), 'services')

test_env = environment()
test_env.prepend('GI_TYPELIB_PATH',
  join_paths(meson.project_build_root(), 'libspiel'),
  join_paths(meson.project_build_root(), 'libspeechprovider'), separator: ':')
test_env.prepend('LD_LIBRARY_PATH',
  join_paths(meson.project_build_root(), 'libspiel'),
  join_paths(meson.project_build_root(), 'libspeechprovider'), separator: ':')
test_env.set('G_DEBUG', 'fatal-warnings')
test_env.set('TEST_SERVICE_DIR', service_dir)
test_env.set('TEST_DISCARDED_SERVICE_DIR', join_paths(meson.current_build_dir(), 'discarded_services'))
test_env.set('GSETTINGS_SCHEMA_DIR', join_paths(meson.project_build_root(), 'libspiel'))
test_env.set('GSETTINGS_BACKEND', 'memory')
test_env.set('SPIEL_TEST', '1')

python_module = import('python')
dbus_run_session = find_program('dbus-run-session', required : false)
python = python_module.find_installation(
  'python3', required : false, modules: ['tap', 'dasbus'])

tests = ['test_speak.py',
         'test_types.py',
         'test_voices.py',
         'test_settings.py',
         'test_voice_selection.py',
         'test_errors.py',
         'test_audio.py',
         'test_provider_lib.py']

newer_dbus = dependency('dbus-1', version : '>=1.14.4', required : false)
if newer_dbus.found()
  tests += ['test_provider.py']
endif

conf = configuration_data()
conf.set('service_dir', service_dir)
test_bus_conf_file = configure_file(
  input: 'test-bus.conf.in',
  output: 'test-bus.conf',
  configuration: conf)

test_deps = spiel_deps + [
  spiel_lib_dep,
]

test_simple_speak = executable('test-simple-speak', 'test-simple-speak.c',
  dependencies: test_deps
)

test_simultaneous_init = executable(
  'test-simultaneous-init',
  'test-simultaneous-init.c',
  dependencies: test_deps
)

if dbus_run_session.found() and python.found()
  foreach test_name : tests
    test(
      test_name, dbus_run_session,
      args : [
        '--config-file=@0@'.format(join_paths(meson.current_build_dir(), 'test-bus.conf')),
        '--',
        python.full_path(),
        files(test_name)
      ],
      env : test_env,
      protocol : 'tap',
      is_parallel : test_name != 'test_provider.py'
    )
  endforeach

test('test-simple-speak', dbus_run_session,
      args : [
        '--config-file=@0@'.format(join_paths(meson.current_build_dir(), 'test-bus.conf')),
        '--', test_simple_speak
        ],
      env : test_env
    )

test('test-simultaneous-init', dbus_run_session,
      args : [
        '--config-file=@0@'.format(join_paths(meson.current_build_dir(), 'test-bus.conf')),
        '--', test_simultaneous_init
        ],
      env : test_env
    )
endif

subdir('services')
subdir('discarded_services')0707010000003E000041ED00000000000000000000000265D79E0600000000000000000000000000000000000000000000001B00000000spiel-1.0.0/tests/services0707010000003F000081A400000000000000000000000165D79E06000002C3000000000000000000000000000000000000002700000000spiel-1.0.0/tests/services/meson.buildconfig = configuration_data()
config.set('provider_iface', join_paths(meson.project_source_root(), 'interface', 'org.freedesktop.Speech.Provider.xml'))
# config.set('python_path', py.full_path())

configure_file(
  input: 'mock_speech_provider.py.in',
  output: 'mock_speech_provider.py',
  configuration: config
)

service_names = ['mock', 'mock2', 'mock3']
foreach service_name : service_names
    c = configuration_data({
        'service_exec_dir': meson.current_build_dir(),
        'service_name': service_name
    })
    configure_file(
        input: 'org.mock.Speech.Provider.service.in',
        output: 'org.@0@.Speech.Provider.service'.format(service_name),
        configuration: c)
endforeach
07070100000040000081ED00000000000000000000000165D79E0600002578000000000000000000000000000000000000003600000000spiel-1.0.0/tests/services/mock_speech_provider.py.in#!/usr/bin/env python3

import gi

gi.require_version("Gst", "1.0")
gi.require_version("SpeechProvider", "1.0")
from gi.repository import GLib, Gst, SpeechProvider

from dasbus.connection import SessionMessageBus
from dasbus.unix import GLibServerUnix
from dasbus.server.property import PropertiesInterface
from xml.dom.minidom import parse, parseString
import re
import os
from os import getcwd
from sys import argv

Gst.init(None)

NAME = argv[-1] if len(argv) > 1 else "mock"

AUTOEXIT = NAME == "mock3"

VOICES = {
    "mock": [
        {
            "name": "Chinese (Cantonese)",
            "output_format": "audio/x-raw,format=S16LE,channels=1,rate=22050",
            "identifier": "sit/yue",
            "features": SpeechProvider.VoiceFeature.SSML_SAY_AS_CARDINAL
            | SpeechProvider.VoiceFeature.SSML_SAY_AS_ORDINAL,
            "languages": ["yue", "zh-yue", "zh"],
        },
        {
            "name": "Armenian (East Armenia)",
            "output_format": "audio/x-raw,format=S16LE,channels=1,rate=22050",
            "identifier": "ine/hy",
            "features": 0,
            "languages": ["hy", "hy-arevela"],
        },
    ],
    "mock2": [
        {
            "name": "Armenian (West Armenia)",
            "output_format": "audio/x-raw,format=S16LE,channels=1,rate=22050",
            "identifier": "ine/hyw",
            "features": 0,
            "languages": ["hyw", "hy-arevmda", "hy"],
        },
        {
            "name": "English (Scotland)",
            "output_format": "nuthin",
            "identifier": "gmw/en-GB-scotland#misconfigured",
            "features": 0,
            "languages": ["en-gb-scotland", "en"],
        },
        {
            "name": "English (Lancaster)",
            "output_format": "audio/x-raw,format=S16LE,channels=1,rate=22050",
            "identifier": "gmw/en-GB-x-gbclan",
            "features": 0,
            "languages": ["en-gb-x-gbclan", "en-gb", "en"],
        },
        {
            "name": "English (America)",
            "output_format": "audio/x-spiel,format=S16LE,channels=1,rate=22050",
            "identifier": "gmw/en-US",
            "features": 0,
            "languages": ["en-us", "en"],
        },
        {
            "name": "English (Great Britain)",
            "output_format": "audio/x-raw,format=S16LE,channels=1,rate=22050",
            "identifier": "gmw/en",
            "features": 0,
            "languages": ["en-gb", "en"],
        },
    ],
    "mock3": [
        {
            "name": "Uzbek",
            "output_format": "audio/x-raw,format=S16LE,channels=1,rate=22050",
            "identifier": "trk/uz",
            "features": 0,
            "languages": ["uz"],
        },
    ],
}

class RawSynthStream(object):
    def __init__(self, fd, text, indefinite, silent):
        elements = [
            "audiotestsrc num-buffers=%d wave=%s name=src"
            % (-1 if indefinite else 10, "silence" if silent else "sine"),
            "audioconvert",
            "audio/x-raw,format=S16LE,channels=1,rate=22050",
            "fdsink name=sink",
        ]
        self._pipeline = Gst.parse_launch(" ! ".join(elements))
        self._pipeline.get_by_name("sink").set_property("fd", fd)
        bus = self._pipeline.get_bus()
        bus.add_signal_watch()
        bus.connect("message::eos", self._on_eos)

def start(self):
        self._pipeline.set_state(Gst.State.PLAYING)

def end(self):
        src = self._pipeline.get_by_name("src")
        src.set_state(Gst.State.NULL)
        raw_fd = self._pipeline.get_by_name("sink").get_property("fd")
        os.close(raw_fd)

def _on_eos(self, *args):
        src = self._pipeline.get_by_name("src")
        raw_fd = self._pipeline.get_by_name("sink").get_property("fd")
        os.close(raw_fd)
        src.set_state(Gst.State.NULL)

class SpielSynthStream(object):
    def __init__(self, fd, text, indefinite, silent):
        self.ranges = ranges = [
            [m.start(), m.end()] for m in re.finditer(r".*?\b\W\s?", text, re.MULTILINE)
        ]
        num_buffers = -1
        if not indefinite:
            num_buffers = max(10, len(self.ranges) + 1)
        elements = [
            "audiotestsrc num-buffers=%d wave=%s name=src"
            % (-1 if indefinite else 10, "silence" if silent else "sine"),
            "audioconvert",
            "audio/x-raw,format=S16LE,channels=1,rate=22050",
            "appsink emit-signals=True name=sink",
        ]
        self._pipeline = Gst.parse_launch(" ! ".join(elements))
        sink = self._pipeline.get_by_name("sink")
        sink.connect("new-sample", self._on_new_sample)
        sink.connect("eos", self._on_eos)

self.stream_writer = SpeechProvider.StreamWriter.new(fd)

def _on_new_sample(self, sink):
        sample = sink.emit("pull-sample")
        buffer = sample.get_buffer()
        b = buffer.extract_dup(0, buffer.get_size())
        # Some chaos
        self.stream_writer.send_audio(b"")
        if self.ranges:
            start, end = self.ranges.pop(0)
            if len(self.ranges) % 2:
                self.stream_writer.send_event(
                    SpeechProvider.EventType.SENTENCE, start, end, ""
                )
            self.stream_writer.send_event(SpeechProvider.EventType.WORD, start, end, "")
        self.stream_writer.send_audio(b)

return Gst.FlowReturn.OK

def end(self):
        self._pipeline.set_state(Gst.State.NULL)
        self.stream_writer.close()

def start(self):
        self.stream_writer.send_stream_header()
        self._pipeline.set_state(Gst.State.PLAYING)

def _on_eos(self, *args):
        self.stream_writer.close()

class SomeObject(PropertiesInterface):
    __dbus_xml__ = """<node>
<interface name="org.freedesktop.Speech.MockProvider">
    <method name="GetLastSpeakArguments">
      <arg direction="out" type="t" />
      <arg direction="out" type="s" />
      <arg direction="out" type="s" />
      <arg direction="out" type="d" />
      <arg direction="out" type="d" />
      <arg direction="out" type="b" />
    </method>
    <method name="FlushTasks">
    </method>
    <method name="SetInfinite">
      <arg direction="in"  type="b" name="val" />
    </method>
    <method name="End">
    </method>
    <method name="AddVoice">
      <arg direction="in"  type="s" name="name" />
      <arg direction="in"  type="s" name="identifier" />
      <arg direction="in"  type="as" name="languages" />
    </method>
    <method name="RemoveVoice">
      <arg direction="in"  type="s" name="identifier" />
    </method>
  </interface>
</node>"""

def __init__(self):
        self._last_speak_args = [0, "", "", 0, 0, 0]
        self._infinite = False
        self._stream = None
        self._voices = VOICES[NAME][:]
        super().__init__()

def Synthesize(self, fd, utterance, voice_id, pitch, rate, is_ssml, language):
        if utterance == "die":
            # special utterance text that makes us die
            self.byebye()
        self._last_speak_args = (fd, utterance, voice_id, pitch, rate, is_ssml)
        voice = dict([[v["identifier"], v] for v in self._voices])[voice_id]
        output_format = voice["output_format"]
        synthstream_cls = RawSynthStream
        if output_format.startswith("audio/x-spiel"):
            synthstream_cls = SpielSynthStream

self.stream = synthstream_cls(
            fd, utterance, self._infinite, utterance == "silent"
        )
        self.stream.start()

@property
    def Voices(self):
        if AUTOEXIT:
            GLib.timeout_add(500, self.byebye)
        voices = [
            (
                v["name"],
                v["identifier"],
                v["output_format"],
                v["features"],
                v["languages"],
            )
            for v in self._voices
        ]
        return voices

@property
    def Name(self):
        return NAME

def GetLastSpeakArguments(self):
        return self._last_speak_args

def FlushTasks(self):
        self.stream = None
        self._last_speak_args = [0, "", "", 0, 0, 0]

def SetInfinite(self, val):
        self._infinite = val

def End(self):
        if self.stream:
            self.stream.end()

def AddVoice(self, name, identifier, languages):
        self._voices.append(
            {
                "name": name,
                "identifier": identifier,
                "output_format": "audio/x-raw,format=S16LE,channels=1,rate=22050",
                "features": 0,
                "languages": languages,
            }
        )
        GLib.idle_add(self.report_changed_voices)

def RemoveVoice(self, identifier):
        self._voices = [v for v in self._voices if v["identifier"] != identifier]
        GLib.idle_add(self.report_changed_voices)

def report_changed_voices(self):
        self.report_changed_property("Voices")
        self.flush_changes()

def byebye(self):
        exit()

# Add speech provider interface
dbus_xml = parseString(SomeObject.__dbus_xml__)
node = dbus_xml.getElementsByTagName("node")[0]
provider_iface_xml = parse("@provider_iface@").getElementsByTagName("interface")[0]
provider_iface_xml.parentNode.removeChild(provider_iface_xml)
node.appendChild(provider_iface_xml)
SomeObject.__dbus_xml__ = dbus_xml.toxml()

if __name__ == "__main__":
    bus = SessionMessageBus()
    bus.publish_object(
        f"/org/{NAME}/Speech/Provider", SomeObject(), server=GLibServerUnix
    )
    bus.register_service(f"org.{NAME}.Speech.Provider")

mainloop = GLib.MainLoop()
    mainloop.run()
07070100000041000081A400000000000000000000000165D79E060000009C000000000000000000000000000000000000003F00000000spiel-1.0.0/tests/services/org.mock.Speech.Provider.service.in[D-BUS Service]
Name=org.@service_name@.Speech.Provider
Exec=@service_exec_dir@/mock_speech_provider.py @service_name@
SystemdService=tracker-store.service
07070100000042000081A400000000000000000000000165D79E0600000329000000000000000000000000000000000000002300000000spiel-1.0.0/tests/test-bus.conf.in<!DOCTYPE busconfig PUBLIC "-//freedesktop//DTD D-BUS Bus Configuration 1.0//EN"
 "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd">
<busconfig>
  
  <type>session</type>

<listen>unix:tmpdir=./</listen>

<servicedir>@service_dir@</servicedir>

<limit name="service_start_timeout">1000000</limit>

<policy context="default">
    
    <allow send_destination="*"/>
    
    <allow eavesdrop="true"/>
    
    <allow own="*"/>
  </policy>
</busconfig>
07070100000043000081A400000000000000000000000165D79E06000005D2000000000000000000000000000000000000002600000000spiel-1.0.0/tests/test-simple-speak.c#include <spiel.h>

static GMainLoop *main_loop;
static SpielSpeaker *speaker = NULL;

static void
speaking_cb (SpielSpeaker *_speaker, GParamSpec *pspec, gpointer user_data)
{
  gboolean speaking = FALSE;
  g_object_get (speaker, "speaking", &speaking, NULL);

if (!speaking)
    {
      g_main_loop_quit (main_loop);
    }
}

static void
speaker_new_cb (GObject *source, GAsyncResult *result, gpointer user_data)
{
  GError *err = NULL;
  SpielUtterance *utterance = spiel_utterance_new ("hello world");
  gboolean speaking = FALSE;

speaker = spiel_speaker_new_finish (result, &err);
  g_assert_no_error (err);
  if (err)
    g_error_free (err);

g_assert (speaker != NULL);
  g_assert (utterance != NULL);

// prevents mock3 from being used
  spiel_utterance_set_language (utterance, "hy");

g_object_get (speaker, "speaking", &speaking, NULL);
  g_assert_false (speaking);

spiel_speaker_speak (speaker, utterance);
  g_object_unref (utterance);

g_object_get (speaker, "speaking", &speaking, NULL);
  g_assert_true (speaking);

g_signal_connect (speaker, "notify::speaking", G_CALLBACK (speaking_cb),
                    NULL);
}

static void
test_speak (void)
{
  main_loop = g_main_loop_new (NULL, FALSE);
  spiel_speaker_new (NULL, speaker_new_cb, NULL);
  g_main_loop_run (main_loop);
  g_object_unref (speaker);
}

gint
main (gint argc, gchar *argv[])
{
  g_test_init (&argc, &argv, NULL);
  g_test_add_func ("/spiel/speak", test_speak);
  return g_test_run ();
}07070100000044000081A400000000000000000000000165D79E060000028F000000000000000000000000000000000000002B00000000spiel-1.0.0/tests/test-simultaneous-init.c#include <gio/gio.h>
#include <spiel.h>

static guint speakers_to_init = 10;

static void
spiel_speaker_new_cb (GObject *object, GAsyncResult *result, gpointer user_data)
{
  GMainLoop *loop = user_data;
  g_autoptr (GError) error = NULL;
  g_autoptr (SpielSpeaker) speaker = spiel_speaker_new_finish (result, &error);
  if (--speakers_to_init == 0)
    {
      g_main_loop_quit (loop);
    }
}

int
main (int argc, char *argv[])
{
  g_autoptr (GMainLoop) loop = g_main_loop_new (NULL, FALSE);

for (guint i = 0; i < speakers_to_init; i++)
    {
      spiel_speaker_new (NULL, spiel_speaker_new_cb, loop);
    }

g_main_loop_run (loop);

return 0;
}07070100000045000081A400000000000000000000000165D79E0600000C7D000000000000000000000000000000000000002000000000spiel-1.0.0/tests/test_audio.pyfrom _common import *

import gi

gi.require_version("Gst", "1.0")
from gi.repository import Gst

Gst.init(None)

class TestSpeak(BaseSpielTest):
    def _setup_custom_sink(self):
        bin = Gst.Bin.new("bin")
        level = Gst.ElementFactory.make("level", "level")
        bin.add(level)
        sink = Gst.ElementFactory.make("fakesink", "sink")
        bin.add(sink)
        level.link(sink)

level.set_property("post-messages", True)
        # level.set_property("interval", 100)
        sink.set_property("sync", True)

pad = level.get_static_pad("sink")
        ghostpad = Gst.GhostPad.new("sink", pad)
        bin.add_pad(ghostpad)

speechSynthesis = Spiel.Speaker.new_sync(None)
        speechSynthesis.props.sink = bin

pipeline = bin.get_parent()
        bus = pipeline.get_bus()

return speechSynthesis, bus

def test_max_volume(self):
        loop = GLib.MainLoop()

def _on_message(bus, message):
            info = message.get_structure()
            if info.get_name() == "level":
                self.assertGreater(info.get_value("rms")[0], -5)
                loop.quit()

speechSynthesis, bus = self._setup_custom_sink()

bus.connect("message::element", _on_message)

utterance = Spiel.Utterance(text="hello world, how are you?")
        utterance.props.volume = 1
        utterance.props.voice = self.get_voice(
            speechSynthesis, "org.mock2.Speech.Provider", "gmw/en-US"
        )

speechSynthesis.speak(utterance)

loop.run()

def test_half_volume(self):
        loop = GLib.MainLoop()

def _on_message(bus, message):
            info = message.get_structure()
            if info.get_name() == "level":
                self.assertLess(info.get_value("rms")[0], -5)
                loop.quit()

speechSynthesis, bus = self._setup_custom_sink()

bus.connect("message::element", _on_message)

utterance = Spiel.Utterance(text="hello world, how are you?")
        utterance.props.volume = 0.5
        utterance.props.voice = self.get_voice(
            speechSynthesis, "org.mock2.Speech.Provider", "gmw/en-US"
        )
        speechSynthesis.speak(utterance)

loop.run()

def test_queue(self):
        # Tests the proper disposal/closing of 'audio/x-spiel' utterances in a queue
        speaker = Spiel.Speaker.new_sync(None)

sink = Gst.ElementFactory.make("autoaudiosink", "sink")
        # Override usual test fakesink
        speaker.props.sink = sink

voice = self.get_voice(speaker, "org.mock2.Speech.Provider", "gmw/en-US")
        [one, two] = [
            Spiel.Utterance(text=text, voice=voice) for text in ["silent", "silent"]
        ]

expected_events = [
            ["notify:speaking", True],
            ["utterance-started", one],
            ["utterance-finished", one],
            ["utterance-started", two],
            ["utterance-finished", two],
            ["notify:speaking", False],
        ]

actual_events = self.capture_speak_sequence(speaker, one, two)

self.assertEqual(actual_events, expected_events)

if __name__ == "__main__":
    test_main()
07070100000046000081A400000000000000000000000165D79E0600000921000000000000000000000000000000000000002100000000spiel-1.0.0/tests/test_errors.pyfrom _common import *

class TestSpeak(BaseSpielTest):
    def test_provider_dies(self):
        speaker = Spiel.Speaker.new_sync(None)

utterance = Spiel.Utterance(text="die")
        # XXX: fdsrc goes to playing state even when no
        # data is written to the pipe. So we use a spielsrc.
        utterance.props.voice = self.get_voice(
            speaker, "org.mock2.Speech.Provider", "gmw/en-US"
        )

expected_error = (
            "g-dbus-error-quark",
            int(Gio.DBusError.NO_REPLY),
            "GDBus.Error:org.freedesktop.DBus.Error.NoReply: "
            "Message recipient disconnected from message bus without replying",
        )
        expected_events = [
            ["notify:speaking", True],
            ["utterance-error", utterance, expected_error],
            ["notify:speaking", False],
        ]

actual_events = self.capture_speak_sequence(speaker, utterance)

self.assertEqual(actual_events, expected_events)

def test_bad_voice(self):
        self.mock_service.SetInfinite(True)
        speaker = Spiel.Speaker.new_sync(None)

voices = [
            self.get_voice(speaker, *provider_well_known_name_and_id)
            for provider_well_known_name_and_id in [
                ("org.mock2.Speech.Provider", "ine/hyw"),
                ("org.mock2.Speech.Provider", "gmw/en-GB-scotland#misconfigured"),
                ("org.mock2.Speech.Provider", "gmw/en-GB-x-gbclan"),
            ]
        ]

[one, two, three] = [
            Spiel.Utterance(text="hello world, how are you?", voice=voice)
            for voice in voices
        ]

expected_error = (
            "spiel-error-quark",
            int(Spiel.Error.MISCONFIGURED_VOICE),
            "Voice output format not set correctly: 'nuthin'",
        )
        expected_events = [
            ["notify:speaking", True],
            ["utterance-started", one],
            ["utterance-finished", one],
            ["utterance-error", two, expected_error],
            ["utterance-started", three],
            ["utterance-finished", three],
            ["notify:speaking", False],
        ]

actual_events = self.capture_speak_sequence(speaker, one, two, three)

self.assertEqual(actual_events, expected_events)

if __name__ == "__main__":
    test_main()
07070100000047000081A400000000000000000000000165D79E06000004F7000000000000000000000000000000000000002300000000spiel-1.0.0/tests/test_provider.pyfrom _common import *

class TestInstallProvider(BaseSpielTest):
    def test_providers_speaker_property(self):
        speaker = self.wait_for_async_speaker_init()
        self.assertEqual(
            [p.get_well_known_name() for p in speaker.props.providers],
            [
                "org.mock.Speech.Provider",
                "org.mock2.Speech.Provider",
                "org.mock3.Speech.Provider",
            ],
        )
        self.assertEqual(
            [len(p.get_voices()) for p in speaker.get_providers()],
            [2, 5, 1],
        )
        self.assertEqual(
            [p.props.name for p in speaker.get_providers()],
            ["mock", "mock2", "mock3"],
        )

def test_install_provider_service(self):
        speaker = Spiel.Speaker.new_sync(None)

self.wait_for_provider_to_go_away("org.mock3.Speech.Provider")
        self.uninstall_provider("org.mock3.Speech.Provider")
        self.wait_for_voices_changed(speaker, removed=["trk/uz"])
        self.assertEqual(len(speaker.props.voices), 7)
        self.install_provider("org.mock3.Speech.Provider")
        self.wait_for_voices_changed(speaker, added=["trk/uz"])
        self.assertEqual(len(speaker.props.voices), 8)

if __name__ == "__main__":
    test_main()
07070100000048000081A400000000000000000000000165D79E060000067C000000000000000000000000000000000000002700000000spiel-1.0.0/tests/test_provider_lib.pyimport unittest, os
import gi

gi.require_version("SpeechProvider", "1.0")
from gi.repository import SpeechProvider

from _common import test_main

class TestSpeak(unittest.TestCase):
    def test_bad_header(self):
        r, w = os.pipe2(os.O_NONBLOCK)

sr = SpeechProvider.StreamReader.new(r)

ww = os.fdopen(w, "w")
        ww.write("boop")

success = sr.get_stream_header()
        self.assertFalse(success)

def test_simple(self):
        r, w = os.pipe2(os.O_NONBLOCK)

sw = SpeechProvider.StreamWriter.new(w)
        sr = SpeechProvider.StreamReader.new(r)

sw.send_stream_header()
        sw.send_audio(b"foo")
        sw.send_event(2, 20, 24, "bar")

success = sr.get_stream_header()
        self.assertTrue(success)

# Event is not next chunk, so return empty event
        event_type, range_start, range_end, mark_name = sr.get_event()
        self.assertEqual(event_type, SpeechProvider.EventType.NONE)
        self.assertEqual(range_start, 0)
        self.assertEqual(range_end, 0)
        self.assertEqual(mark_name, None)

# Get audio chunk
        audio = sr.get_audio()
        self.assertEqual(audio, b"foo")

# Audio is not next chunk, return empty buffer
        audio = sr.get_audio()
        self.assertEqual(audio, b"")

# Get event chunk
        event_type, range_start, range_end, mark_name = sr.get_event()
        self.assertEqual(event_type, SpeechProvider.EventType.SENTENCE)
        self.assertEqual(range_start, 20)
        self.assertEqual(range_end, 24)
        self.assertEqual(mark_name, "bar")

if __name__ == "__main__":
    test_main()
07070100000049000081A400000000000000000000000165D79E060000030F000000000000000000000000000000000000002300000000spiel-1.0.0/tests/test_settings.pyfrom _common import *

class SettingsTest(unittest.TestCase):
    def test_default_voice(self):
        settings = Gio.Settings.new("org.monotonous.libspiel")

self.assertEqual(settings["default-voice"], None)
        settings["default-voice"] = ("org.mock2.Speech.Provider", "ine/hy")
        self.assertEqual(
            settings["default-voice"], ("org.mock2.Speech.Provider", "ine/hy")
        )

self.assertEqual(settings["language-voice-mapping"], {})
        settings["language-voice-mapping"] = {
            "hy": ("org.mock2.Speech.Provider", "ine/hyw")
        }
        self.assertEqual(
            settings["language-voice-mapping"],
            {"hy": ("org.mock2.Speech.Provider", "ine/hyw")},
        )

if __name__ == "__main__":
    test_main()
0707010000004A000081A400000000000000000000000165D79E06000016D2000000000000000000000000000000000000002000000000spiel-1.0.0/tests/test_speak.pyfrom _common import *

class TestSpeak(BaseSpielTest):
    def test_speak(self):
        speaker = Spiel.Speaker.new_sync(None)

utterance = Spiel.Utterance(text="hello world, how are you?")
        utterance.props.voice = self.get_voice(
            speaker, "org.mock2.Speech.Provider", "gmw/en-US"
        )

expected_events = [
            ["notify:speaking", True],
            ["utterance-started", utterance],
            ["word-started", utterance, 0, 6],
            ["sentence-started", utterance, 6, 13],
            ["word-started", utterance, 6, 13],
            ["word-started", utterance, 13, 17],
            ["sentence-started", utterance, 17, 21],
            ["word-started", utterance, 17, 21],
            ["word-started", utterance, 21, 25],
            ["utterance-finished", utterance],
            ["notify:speaking", False],
        ]

actual_events = self.capture_speak_sequence(speaker, utterance)

self.assertEqual(actual_events, expected_events)

def test_queue(self):
        speaker = Spiel.Speaker.new_sync(None)
        [one, two, three] = [
            Spiel.Utterance(text=text) for text in ["one", "two", "three"]
        ]

actual_events = self.capture_speak_sequence(speaker, one, two, three)

self.assertEqual(actual_events, expected_events)

def test_pause(self):
        def _started_cb(_speaker, utt):
            _speaker.pause()

def _notify_paused_cb(_speaker, val):
            if _speaker.props.paused:
                GLib.idle_add(lambda: _speaker.resume())
            else:
                self.mock_service.End()

self.mock_service.SetInfinite(True)
        speaker = Spiel.Speaker.new_sync(None)
        speaker.connect("utterance-started", _started_cb)
        speaker.connect("notify::paused", _notify_paused_cb)

utterance = Spiel.Utterance(text="hello world, how are you?")

expected_events = [
            ["notify:speaking", True],
            ["utterance-started", utterance],
            ["notify:paused", True],
            ["notify:paused", False],
            ["utterance-finished", utterance],
            ["notify:speaking", False],
        ]

actual_events = self.capture_speak_sequence(speaker, utterance)

self.assertEqual(actual_events, expected_events)

def test_cancel(self):
        def _started_cb(_speaker, utt):
            GLib.idle_add(lambda: _speaker.cancel())

self.mock_service.SetInfinite(True)

speaker = Spiel.Speaker.new_sync(None)
        speaker.connect("utterance-started", _started_cb)

[one, two, three] = [
            Spiel.Utterance(text=text) for text in ["one", "two", "three"]
        ]

expected_events = [
            ["notify:speaking", True],
            ["utterance-started", one],
            ["utterance-canceled", one],
            ["notify:speaking", False],
        ]
        actual_events = self.capture_speak_sequence(speaker, one, two, three)

self.assertEqual(actual_events, expected_events)

def test_pause_and_cancel(self):
        def _started_cb(_speaker, utt):
            GLib.idle_add(lambda: _speaker.pause())

def _notify_paused_cb(_speaker, val):
            GLib.idle_add(lambda: _speaker.cancel())

actual_events = []

utterance = Spiel.Utterance(text="hello world, how are you?")

expected_events = [
            ["notify:speaking", True],
            ["utterance-started", utterance],
            ["notify:paused", True],
            ["utterance-canceled", utterance],
            ["notify:speaking", False],
        ]

actual_events = self.capture_speak_sequence(speaker, utterance)

self.assertEqual(actual_events, expected_events)

def test_pause_then_speak(self):
        def _notify_paused_cb(_speaker, val):
            if _speaker.props.paused:
                GLib.idle_add(lambda: _speaker.resume())

speaker = Spiel.Speaker.new_sync(None)
        speaker.connect("notify::paused", _notify_paused_cb)
        GLib.idle_add(lambda: speaker.pause())

utterance = Spiel.Utterance(text="hello world, how are you?")

expected_events = [
            ["notify:paused", True],
            ["notify:speaking", True],
            ["notify:paused", False],
            ["utterance-started", utterance],
            ["utterance-finished", utterance],
            ["notify:speaking", False],
        ]

actual_events = self.capture_speak_sequence(speaker, utterance)

self.assertEqual(actual_events, expected_events)

def test_is_ssml(self):
        speaker = Spiel.Speaker.new_sync(None)

utterance = Spiel.Utterance(text="hello world, how are you?", language="hy")
        self.wait_for_speaking_done(speaker, lambda: speaker.speak(utterance))
        is_ssml = self.mock_service.GetLastSpeakArguments()[-1]
        self.assertFalse(is_ssml)

utterance = Spiel.Utterance(
            text="hello world, how are you?", language="hy", is_ssml=True
        )
        self.wait_for_speaking_done(speaker, lambda: speaker.speak(utterance))
        is_ssml = self.mock_service.GetLastSpeakArguments()[-1]
        self.assertTrue(is_ssml)

if __name__ == "__main__":
    test_main()
0707010000004B000081A400000000000000000000000165D79E0600000DEB000000000000000000000000000000000000002000000000spiel-1.0.0/tests/test_types.pyfrom _common import *

class TestTypes(BaseSpielTest):
    def test_speaker(self):
        def _cb(*args):
            pass

speechSynthesis = Spiel.Speaker()
        self.assertFalse(speechSynthesis.props.speaking)
        self.assertFalse(speechSynthesis.props.paused)
        speechSynthesis.connect("notify::speaking", _cb)
        speechSynthesis.connect("notify::paused", _cb)
        speechSynthesis.connect("utterance-started", _cb)
        speechSynthesis.connect("range-started", _cb)
        speechSynthesis.connect("utterance-finished", _cb)
        speechSynthesis.connect("utterance-canceled", _cb)

def test_voice(self):
        voice = Spiel.Voice(
            name="English",
            identifier="en",
            languages=["en", "es", "he"],
            features=Spiel.VoiceFeature.SSML_SAY_AS_CARDINAL,
        )
        self.assertEqual(voice.props.name, "English")
        self.assertEqual(voice.get_name(), "English")
        self.assertEqual(voice.props.identifier, "en")
        self.assertEqual(voice.get_identifier(), "en")
        self.assertEqual(voice.props.languages, ["en", "es", "he"])
        self.assertEqual(voice.get_languages(), ["en", "es", "he"])
        self.assertEqual(voice.get_features(), Spiel.VoiceFeature.SSML_SAY_AS_CARDINAL)

def test_utterance(self):
        utterance = Spiel.Utterance(text="bye")
        self.assertIsNotNone(utterance)
        self.assertEqual(utterance.props.text, "bye")
        self.assertEqual(utterance.get_text(), "bye")
        utterance.set_property("text", "hi")
        self.assertEqual(utterance.props.text, "hi")
        utterance.set_text("yo")
        self.assertEqual(utterance.get_text(), "yo")
        self.assertEqual(utterance.props.volume, 1)
        self.assertEqual(utterance.get_volume(), 1)
        self.assertEqual(utterance.props.rate, 1)
        self.assertEqual(utterance.get_rate(), 1)
        self.assertEqual(utterance.props.pitch, 1)
        self.assertEqual(utterance.get_pitch(), 1)
        utterance.props.volume = 0.5
        self.assertEqual(utterance.props.volume, 0.5)
        self.assertEqual(utterance.get_volume(), 0.5)
        utterance.set_volume(0.334)
        self.assertEqual(utterance.get_property("volume"), 0.334)
        utterance.set_property("pitch", 2)
        self.assertEqual(utterance.get_pitch(), 2)
        utterance.set_pitch(2.2)
        self.assertEqual(utterance.props.pitch, 2.2)
        utterance.set_property("rate", 0.25)
        self.assertEqual(utterance.get_rate(), 0.25)
        utterance.set_rate(0.1)
        self.assertEqual(utterance.props.rate, 0.1)
        self.assertEqual(utterance.props.voice, None)
        self.assertEqual(utterance.get_voice(), None)
        voice = Spiel.Voice(name="English", identifier="en")
        utterance.set_property("voice", voice)
        self.assertEqual(utterance.props.voice.props.name, "English")
        self.assertEqual(utterance.get_voice(), voice)
        self.assertEqual(utterance.props.language, None)
        self.assertEqual(utterance.get_language(), None)
        utterance.set_property("language", "en-gb")
        self.assertEqual(utterance.props.language, "en-gb")
        utterance.set_language("en-us")
        self.assertEqual(utterance.get_language(), "en-us")
        self.assertFalse(utterance.props.is_ssml)
        self.assertFalse(utterance.get_is_ssml())
        utterance.set_is_ssml(True)
        self.assertTrue(utterance.props.is_ssml)
        self.assertTrue(utterance.get_is_ssml())

if __name__ == "__main__":
    test_main()
0707010000004C000081A400000000000000000000000165D79E0600000B7C000000000000000000000000000000000000002A00000000spiel-1.0.0/tests/test_voice_selection.pyfrom _common import *

class TestSpeak(BaseSpielTest):
    def test_lang_settings(self):
        settings = Gio.Settings.new("org.monotonous.libspiel")
        settings["default-voice"] = ("org.mock.Speech.Provider", "ine/hy")
        settings["language-voice-mapping"] = {
            "en": ("org.mock2.Speech.Provider", "gmw/en-GB-x-gbclan")
        }

utterance = Spiel.Utterance(text="hello world, how are you?", language="en-us")

speechSynthesis = Spiel.Speaker.new_sync(None)
        self.wait_for_speaking_done(
            speechSynthesis, lambda: speechSynthesis.speak(utterance)
        )
        self.assertEqual(utterance.props.voice.props.name, "English (Lancaster)")

def test_lang_no_settings(self):
        utterance = Spiel.Utterance(text="hello world, how are you?", language="hy")

speechSynthesis = Spiel.Speaker.new_sync(None)
        self.wait_for_speaking_done(
            speechSynthesis, lambda: speechSynthesis.speak(utterance)
        )
        self.assertIn("hy", utterance.props.voice.props.languages)

def test_default_voice(self):
        speechSynthesis = Spiel.Speaker.new_sync(None)
        settings = Gio.Settings.new("org.monotonous.libspiel")
        settings["default-voice"] = ("org.mock.Speech.Provider", "ine/hy")

utterance = Spiel.Utterance(text="hello world, how are you?", language="hy")

def _test_speak_with_voice(self, speechSynthesis, voice):
        utterance = Spiel.Utterance(text="hello world, how are you?", voice=voice)
        speechSynthesis.speak(utterance)
        args = self.mock_iface(
            voice.props.provider.get_well_known_name()
        ).GetLastSpeakArguments()
        self.assertEqual(str(args[2]), voice.props.identifier)

def test_speak_with_voice_sync(self):
        speechSynthesis = Spiel.Speaker.new_sync(None)
        voice = self.get_voice(speechSynthesis, "org.mock.Speech.Provider", "sit/yue")
        self._test_speak_with_voice(speechSynthesis, voice)

def test_speak_with_voice_sync_autoexit(self):
        speechSynthesis = Spiel.Speaker.new_sync(None)
        voice = self.get_voice(speechSynthesis, "org.mock3.Speech.Provider", "trk/uz")
        self.wait_for_provider_to_go_away("org.mock3.Speech.Provider")
        self._test_speak_with_voice(speechSynthesis, voice)

def test_speak_with_voice_async(self):
        speechSynthesis = self.wait_for_async_speaker_init()
        voice = self.get_voice(speechSynthesis, "org.mock.Speech.Provider", "sit/yue")
        self._test_speak_with_voice(speechSynthesis, voice)

if __name__ == "__main__":
    test_main()
0707010000004D000081A400000000000000000000000165D79E0600000BEA000000000000000000000000000000000000002100000000spiel-1.0.0/tests/test_voices.pyfrom _common import *

class TestVoices(BaseSpielTest):
    def test_voice_features(self):
        speechSynthesis = Spiel.Speaker.new_sync(None)
        voice = self.get_voice(speechSynthesis, "org.mock.Speech.Provider", "sit/yue")
        self.assertTrue(voice.get_features() & Spiel.VoiceFeature.SSML_SAY_AS_CARDINAL)
        voice = self.get_voice(speechSynthesis, "org.mock.Speech.Provider", "ine/hy")
        self.assertEqual(voice.get_features(), 0)

def test_get_async_voices(self):
        speechSynthesis = self.wait_for_async_speaker_init()
        self._test_get_voices(speechSynthesis)

def test_get_sync_voices(self):
        speechSynthesis = Spiel.Speaker.new_sync(None)
        self._test_get_voices(speechSynthesis)

def _test_get_voices(self, speechSynthesis, expected_voices=STANDARD_VOICES):
        voices = speechSynthesis.props.voices
        voices_info = [
            [
                v.props.provider.props.well_known_name,
                v.props.name,
                v.props.identifier,
                v.props.languages,
            ]
            for v in voices
        ]
        _expected_voices = expected_voices[:]
        _expected_voices.sort(key=lambda v: "-".join(v[:3]))
        self.assertEqual(
            voices_info,
            _expected_voices,
        )

def test_add_voice(self):
        speechSynthesis = self.wait_for_async_speaker_init()
        self._test_get_voices(speechSynthesis)
        self.mock_service.AddVoice("Hebrew", "he", ["he", "he-il"])
        self.wait_for_voices_changed(speechSynthesis, added=["he"])
        self._test_get_voices(
            speechSynthesis,
            STANDARD_VOICES
            + [
                [
                    "org.mock.Speech.Provider",
                    "Hebrew",
                    "he",
                    ["he", "he-il"],
                ]
            ],
        )
        self.mock_service.RemoveVoice("he")
        self.wait_for_voices_changed(speechSynthesis, removed=["he"])
        self._test_get_voices(speechSynthesis)

def test_add_voice_from_inactive(self):
        speechSynthesis = self.wait_for_async_speaker_init()
        self.wait_for_provider_to_go_away("org.mock3.Speech.Provider")
        self.mock_iface("org.mock3.Speech.Provider").AddVoice(
            "Arabic", "ar", ["ar", "ar-ps", "ar-eg"]
        )
        self.wait_for_voices_changed(speechSynthesis, added=["ar"])
        self._test_get_voices(
            speechSynthesis,
            STANDARD_VOICES
            + [
                [
                    "org.mock3.Speech.Provider",
                    "Arabic",
                    "ar",
                    ["ar", "ar-ps", "ar-eg"],
                ]
            ],
        )
        self.wait_for_provider_to_go_away("org.mock3.Speech.Provider")
        self.mock_iface("org.mock3.Speech.Provider").RemoveVoice("ar")
        self.wait_for_voices_changed(speechSynthesis, removed=["ar"])
        self._test_get_voices(speechSynthesis)

if __name__ == "__main__":
    test_main()
0707010000004E000041ED00000000000000000000000265D79E0600000000000000000000000000000000000000000000001200000000spiel-1.0.0/utils0707010000004F000081A400000000000000000000000165D79E0600000089000000000000000000000000000000000000001E00000000spiel-1.0.0/utils/meson.buildutils_deps = spiel_deps + [
  spiel_lib_dep,
]

spiel_cli = executable('spiel', 'spiel.c',
  dependencies: utils_deps,
  install: true
)
07070100000050000081A400000000000000000000000165D79E0600001993000000000000000000000000000000000000001A00000000spiel-1.0.0/utils/spiel.c/* spiel.c
 *
 * Copyright (C) 2024 Eitan Isaacson <eitan@monotonous.org>
 *
 * This file is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <glib.h>
#include <spiel.h>

static gboolean list_voices = FALSE;
static gboolean list_providers = FALSE;
static const char *voice_id = NULL;
static const char *provider_id = NULL;
static const char *lang = NULL;
static double pitch = 1;
static double rate = 1;
static double volume = 1;
static gboolean is_ssml = FALSE;

static GOptionEntry entries[] = {
  { "list-voices", 'V', 0, G_OPTION_ARG_NONE, &list_voices,
    "List available voices", NULL },
  { "list-providers", 'P', 0, G_OPTION_ARG_NONE, &list_providers,
    "List available speech providers", NULL },
  { "voice", 'v', 0, G_OPTION_ARG_STRING, &voice_id,
    "Voice ID to use with utterance (should specify provider too)", NULL },
  { "provider", 'p', 0, G_OPTION_ARG_STRING, &provider_id,
    "Provider ID of voice to use with utterance", NULL },
  { "language", 'l', 0, G_OPTION_ARG_STRING, &lang,
    "Language to use with utterance (specifying a voice overrides this)",
    NULL },
  { "pitch", 0, 0, G_OPTION_ARG_DOUBLE, &pitch,
    "Pitch of utterance (default: 1.0 range: [0.0 - 2.0])", NULL },
  { "rate", 0, 0, G_OPTION_ARG_DOUBLE, &rate,
    "Rate of utterance (default: 1.0 range: [0.1 - 10.0])", NULL },
  { "volume", 0, 0, G_OPTION_ARG_DOUBLE, &volume,
    "Volume of utterance (default: 1.0 range: [0.1 - 1.0])", NULL },
  { "ssml", 0, 0, G_OPTION_ARG_NONE, &is_ssml, "Utterance is SSML markup",
    NULL },
  { NULL }
};

static void
do_list_voices (SpielSpeaker *speaker)
{
  GListModel *voices = spiel_speaker_get_voices (speaker);
  guint voices_count = g_list_model_get_n_items (voices);

g_print ("%-25s %-10s %-10s %s\n", "NAME", "LANGUAGES", "IDENTIFIER",
           "PROVIDER");
  for (guint i = 0; i < voices_count; i++)
    {
      g_autoptr (SpielVoice) voice =
          SPIEL_VOICE (g_list_model_get_object (voices, i));
      g_autofree char *languages =
          g_strjoinv (",", (char **) spiel_voice_get_languages (voice));
      g_print ("%-25s %-10s %-10s %s\n", spiel_voice_get_name (voice),
               languages, spiel_voice_get_identifier (voice),
               spiel_provider_get_well_known_name (
                   spiel_voice_get_provider (voice)));
    }
}

static void
do_list_providers (SpielSpeaker *speaker)
{
  GListModel *providers = spiel_speaker_get_providers (speaker);
  guint providers_count = g_list_model_get_n_items (providers);

g_print ("%-30s %s\n", "NAME", "IDENTIFIER");
  for (guint i = 0; i < providers_count; i++)
    {
      g_autoptr (SpielProvider) provider =
          SPIEL_PROVIDER (g_list_model_get_object (providers, i));
      g_print ("%-30s %s\n", spiel_provider_get_name (provider),
               spiel_provider_get_well_known_name (provider));
    }
}

static void
speaking_cb (SpielSpeaker *speaker, GParamSpec *pspec, gpointer user_data)
{
  GMainLoop *loop = user_data;
  gboolean speaking = FALSE;
  g_object_get (speaker, "speaking", &speaking, NULL);

if (!speaking)
    {
      g_main_loop_quit (loop);
    }
}

static SpielVoice *
find_voice (SpielSpeaker *speaker)
{
  if (!voice_id && provider_id)
    {
      // Get first voice of provider
      GListModel *providers = spiel_speaker_get_providers (speaker);
      g_autoptr (SpielProvider) provider =
          SPIEL_PROVIDER (g_list_model_get_object (providers, 0));
      if (provider)
        {
          GListModel *voices = spiel_provider_get_voices (provider);
          return SPIEL_VOICE (g_list_model_get_object (voices, 0));
        }

return NULL;
    }

if (voice_id)
    {
      GListModel *voices = spiel_speaker_get_voices (speaker);
      guint voices_count = g_list_model_get_n_items (voices);

for (guint i = 0; i < voices_count; i++)
        {
          g_autoptr (SpielVoice) voice =
              SPIEL_VOICE (g_list_model_get_object (voices, i));
          if (g_str_equal (voice_id, spiel_voice_get_identifier (voice)) &&
              (!provider_id ||
               g_str_equal (provider_id,
                            spiel_provider_get_well_known_name (
                                spiel_voice_get_provider (voice)))))
            {
              return g_steal_pointer (&voice);
            }
        }
    }

return NULL;
}

static void
do_speak (SpielSpeaker *speaker, const char *utterance_text)
{
  g_autoptr (GMainLoop) loop = g_main_loop_new (NULL, FALSE);
  g_autoptr (SpielUtterance) utterance = spiel_utterance_new (utterance_text);
  g_autoptr (SpielVoice) voice = find_voice (speaker);

if (voice)
    {
      spiel_utterance_set_voice (utterance, voice);
    }

if (lang)
    {
      spiel_utterance_set_language (utterance, lang);
    }

spiel_utterance_set_pitch (utterance, pitch);
  spiel_utterance_set_rate (utterance, rate);
  spiel_utterance_set_volume (utterance, volume);
  spiel_utterance_set_is_ssml (utterance, is_ssml);

g_signal_connect (speaker, "notify::speaking", G_CALLBACK (speaking_cb),
                    loop);

spiel_speaker_speak (speaker, utterance);

g_main_loop_run (loop);
}

int
main (int argc, char *argv[])
{
  g_autoptr (GError) error = NULL;
  g_autoptr (GOptionContext) context;
  g_autoptr (SpielSpeaker) speaker;

context = g_option_context_new ("- command line speech synthesis");
  g_option_context_add_main_entries (context, entries, NULL);

if (!g_option_context_parse (context, &argc, &argv, &error))
    {
      g_print ("option parsing failed: %s\n", error->message);
      return 1;
    }

speaker = spiel_speaker_new_sync (NULL, &error);
  if (!speaker)
    {
      g_print ("failed in instantiate speaker: %s\n", error->message);
      return 1;
    }

if (list_voices)
    {
      do_list_voices (speaker);
      return 0;
    }

if (list_providers)
    {
      do_list_providers (speaker);
      return 0;
    }

do_speak (speaker, argv[argc - 1]);
}07070100000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000B00000000TRAILER!!!1428 blocks

Places

File spiel-1.0.0.obscpio of Package spiel (Revision 739cdc85383c21e9306f8ca4fc822766)

Places