├── .github
└── workflows
│ ├── build.yml
│ └── deploy.yml
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── docs
├── Makefile
├── conf.py
├── index.rst
├── requirements.txt
└── synthesizer.rst
├── example
├── play_440hz.py
├── play_chord.py
├── play_pychord.py
└── write_wave.py
├── requirements.txt
├── setup.cfg
├── setup.py
├── synthesizer
├── __init__.py
├── frequency.py
├── player.py
├── synthesizer.py
└── writer.py
└── test
├── __init__.py
├── test_frequency.py
├── test_player.py
├── test_synthesizer.py
└── test_writer.py
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
1 | name: Build
2 |
3 | on: [push]
4 |
5 | jobs:
6 | build:
7 | runs-on: ubuntu-20.04
8 | strategy:
9 | matrix:
10 | python-version: ["3.6", "3.7", "3.8", "3.9"]
11 |
12 | steps:
13 | - uses: actions/checkout@v2
14 | - name: Set up Python ${{ matrix.python-version }}
15 | uses: actions/setup-python@v2
16 | with:
17 | python-version: ${{ matrix.python-version }}
18 | - name: Install dependencies
19 | run: |
20 | sudo apt-get -qq update
21 | sudo apt-get install -y portaudio19-dev
22 | - name: Install python dependencies
23 | run: |
24 | python -m pip install --upgrade pip
25 | pip install nose parameterized
26 | pip install -r requirements.txt
27 | - name: Run test
28 | run: |
29 | python setup.py test
30 |
--------------------------------------------------------------------------------
/.github/workflows/deploy.yml:
--------------------------------------------------------------------------------
1 | name: Upload Python Package
2 |
3 | on:
4 | create:
5 | tags:
6 | - v*
7 |
8 | jobs:
9 | deploy:
10 | runs-on: ubuntu-latest
11 | steps:
12 | - uses: actions/checkout@v2
13 | - name: Set up Python
14 | uses: actions/setup-python@v2
15 | with:
16 | python-version: '3.x'
17 | - name: Install dependencies
18 | run: |
19 | python -m pip install --upgrade pip
20 | pip install setuptools wheel twine
21 | - name: Build and publish
22 | env:
23 | TWINE_USERNAME: __token__
24 | TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
25 | run: |
26 | python setup.py sdist bdist_wheel
27 | twine upload dist/*
28 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | env/
12 | build/
13 | develop-eggs/
14 | dist/
15 | downloads/
16 | eggs/
17 | .eggs/
18 | lib/
19 | lib64/
20 | parts/
21 | sdist/
22 | var/
23 | wheels/
24 | *.egg-info/
25 | .installed.cfg
26 | *.egg
27 |
28 | # PyInstaller
29 | # Usually these files are written by a python script from a template
30 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
31 | *.manifest
32 | *.spec
33 |
34 | # Installer logs
35 | pip-log.txt
36 | pip-delete-this-directory.txt
37 |
38 | # Unit test / coverage reports
39 | htmlcov/
40 | .tox/
41 | .coverage
42 | .coverage.*
43 | .cache
44 | nosetests.xml
45 | coverage.xml
46 | *.cover
47 | .hypothesis/
48 |
49 | # Translations
50 | *.mo
51 | *.pot
52 |
53 | # Django stuff:
54 | *.log
55 | local_settings.py
56 |
57 | # Flask stuff:
58 | instance/
59 | .webassets-cache
60 |
61 | # Scrapy stuff:
62 | .scrapy
63 |
64 | # Sphinx documentation
65 | docs/_build/
66 |
67 | # PyBuilder
68 | target/
69 |
70 | # Jupyter Notebook
71 | .ipynb_checkpoints
72 |
73 | # pyenv
74 | .python-version
75 |
76 | # celery beat schedule file
77 | celerybeat-schedule
78 |
79 | # SageMath parsed files
80 | *.sage.py
81 |
82 | # dotenv
83 | .env
84 |
85 | # virtualenv
86 | .venv
87 | venv/
88 | ENV/
89 |
90 | # Spyder project settings
91 | .spyderproject
92 | .spyproject
93 |
94 | # Rope project settings
95 | .ropeproject
96 |
97 | # mkdocs documentation
98 | /site
99 |
100 | # mypy
101 | .mypy_cache/
102 |
103 | # Jetbrains IDE
104 | .idea/
105 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 |
3 | ## Forthcoming
4 |
5 | - Add example to integrate with [PyChord](https://github.com/yuma-m/pychord).
6 |
7 | ## 0.2.0
8 |
9 | - Support scale expression to generate chord.
10 |
11 | ## 0.1.5
12 |
13 | - Support triangle wave.
14 | - Contributor: @AntiMatterAMA
15 |
16 | ## 0.1.4
17 |
18 | - Fix channels of Player class from 2 to 1 to play proper sound.
19 |
20 | ## 0.1.3
21 |
22 | - Specify audio output device.
23 | - Add Writer class.
24 |
25 | ## 0.1.2
26 |
27 | - Add generate_chord method.
28 |
29 | ## 0.1.1
30 |
31 | - Add Synthesizer and Player classes.
32 | - Generate and play constant frequency wave.
33 |
34 | ## 0.1.0
35 |
36 | - Initial version.
37 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Python synthesizer  [](http://synthesizer.readthedocs.io/en/latest/?badge=latest)
2 |
3 | - Virtual analog synthesizer.
4 |
5 | ## Installation
6 |
7 | ```bash
8 | $ pip install synthesizer
9 | ```
10 |
11 | ### Install dependencies
12 |
13 | #### Ubuntu
14 |
15 | ```bash
16 | $ apt install portaudio19-dev
17 | $ pip install pyaudio
18 | ```
19 |
20 | ### macOS
21 |
22 | ```bash
23 | $ brew install portaudio
24 | $ pip install pyaudio
25 | ```
26 |
27 | ## Basic usage
28 |
29 | ### Play 440Hz sine wave
30 |
31 | ```python
32 | >>> from synthesizer import Player, Synthesizer, Waveform
33 |
34 |
35 | >>> player = Player()
36 | >>> player.open_stream()
37 | >>> synthesizer = Synthesizer(osc1_waveform=Waveform.sine, osc1_volume=1.0, use_osc2=False)
38 | # Play A4
39 | >>> player.play_wave(synthesizer.generate_constant_wave(440.0, 3.0))
40 | ```
41 |
42 | ### Play chord
43 |
44 | ```python
45 | # Play C major
46 | >>> chord = ["C3", "E3", "G3"]
47 | >>> player.play_wave(synthesizer.generate_chord(chord, 3.0))
48 |
49 | # You can also specify frequencies to play just intonation
50 | >>> chord = [440.0, 550.0, 660.0]
51 | >>> player.play_wave(synthesizer.generate_chord(chord, 3.0))
52 | ```
53 |
54 | You can use [PyChord](https://github.com/yuma-m/pychord) to handle chords easily.
55 |
56 | ```python
57 | >>> from pychord import Chord
58 | >>> chord = Chord("Dm7/G")
59 | >>> player.play_wave(synthesizer.generate_chord(chord.components_with_pitch(root_pitch=3), 3.0))
60 | ```
61 |
62 | ### Specify audio device
63 |
64 | ```python
65 | >>> player.enumerate_device()
66 | # index: 00, name: "Built-in Microphone", rate: 44100
67 | # index: 01, name: "Built-in Output", rate: 44100
68 | # index: 02, name: "UA-25EX 44.1kHz", rate: 44100
69 | >>> player.open_stream(device_name="UA-25EX")
70 | ```
71 |
72 | ### Write wav file
73 |
74 | ```python
75 | >>> from synthesizer import Writer
76 | >>> writer = Writer()
77 |
78 | >>> chord = ["C4", "E4", "G4"]
79 | >>> wave = synthesizer.generate_chord(chord, 3.0)
80 | >>> writer.write_wave("path/to/your.wav", wave)
81 | ```
82 |
83 | ## Examples
84 |
85 | ### play_pychord.py
86 |
87 | Play chords using [PyChord](https://github.com/yuma-m/pychord).
88 |
89 | ```bash
90 | pip install pychord>=0.5.0
91 | python example/play_pychord.py A C#m7 DM7 Bm7/E A
92 | ```
93 |
94 | ## Supported OS
95 |
96 | - macOS 10.12 and above
97 | - Ubuntu 16.04
98 |
99 | ## Supported versions
100 |
101 | - Python 2.7
102 | - Python 3.5 and above
103 |
104 | ## Author
105 |
106 | - [Yuma Mihira](http://yurax2.com/)
107 |
108 | ## License
109 |
110 | - GPL v3 License
111 |
112 | ## Links
113 |
114 | - PyPI: https://pypi.python.org/pypi/synthesizer
115 | - GitHub: https://github.com/yuma-m/synthesizer
116 | - Document: https://synthesizer.readthedocs.io
117 |
--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
1 | # Makefile for Sphinx documentation
2 | #
3 |
4 | # You can set these variables from the command line.
5 | SPHINXOPTS =
6 | SPHINXBUILD = sphinx-build
7 | PAPER =
8 | BUILDDIR = _build
9 |
10 | # Internal variables.
11 | PAPEROPT_a4 = -D latex_elements.papersize=a4
12 | PAPEROPT_letter = -D latex_elements.papersize=letter
13 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14 | # the i18n builder cannot share the environment and doctrees with the others
15 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
16 |
17 | .PHONY: help
18 | help:
19 | @echo "Please use \`make ' where is one of"
20 | @echo " html to make standalone HTML files"
21 | @echo " dirhtml to make HTML files named index.html in directories"
22 | @echo " singlehtml to make a single large HTML file"
23 | @echo " pickle to make pickle files"
24 | @echo " json to make JSON files"
25 | @echo " htmlhelp to make HTML files and an HTML help project"
26 | @echo " qthelp to make HTML files and a qthelp project"
27 | @echo " applehelp to make an Apple Help Book"
28 | @echo " devhelp to make HTML files and a Devhelp project"
29 | @echo " epub to make an epub"
30 | @echo " epub3 to make an epub3"
31 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
32 | @echo " latexpdf to make LaTeX files and run them through pdflatex"
33 | @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
34 | @echo " lualatexpdf to make LaTeX files and run them through lualatex"
35 | @echo " xelatexpdf to make LaTeX files and run them through xelatex"
36 | @echo " text to make text files"
37 | @echo " man to make manual pages"
38 | @echo " texinfo to make Texinfo files"
39 | @echo " info to make Texinfo files and run them through makeinfo"
40 | @echo " gettext to make PO message catalogs"
41 | @echo " changes to make an overview of all changed/added/deprecated items"
42 | @echo " xml to make Docutils-native XML files"
43 | @echo " pseudoxml to make pseudoxml-XML files for display purposes"
44 | @echo " linkcheck to check all external links for integrity"
45 | @echo " doctest to run all doctests embedded in the documentation (if enabled)"
46 | @echo " coverage to run coverage check of the documentation (if enabled)"
47 | @echo " dummy to check syntax errors of document sources"
48 |
49 | .PHONY: clean
50 | clean:
51 | rm -rf $(BUILDDIR)/*
52 |
53 | .PHONY: html
54 | html:
55 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
56 | @echo
57 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58 |
59 | .PHONY: dirhtml
60 | dirhtml:
61 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
62 | @echo
63 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
64 |
65 | .PHONY: singlehtml
66 | singlehtml:
67 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
68 | @echo
69 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
70 |
71 | .PHONY: pickle
72 | pickle:
73 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
74 | @echo
75 | @echo "Build finished; now you can process the pickle files."
76 |
77 | .PHONY: json
78 | json:
79 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
80 | @echo
81 | @echo "Build finished; now you can process the JSON files."
82 |
83 | .PHONY: htmlhelp
84 | htmlhelp:
85 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
86 | @echo
87 | @echo "Build finished; now you can run HTML Help Workshop with the" \
88 | ".hhp project file in $(BUILDDIR)/htmlhelp."
89 |
90 | .PHONY: qthelp
91 | qthelp:
92 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
93 | @echo
94 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \
95 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
96 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/synthesizer.qhcp"
97 | @echo "To view the help file:"
98 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/synthesizer.qhc"
99 |
100 | .PHONY: applehelp
101 | applehelp:
102 | $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
103 | @echo
104 | @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
105 | @echo "N.B. You won't be able to view it unless you put it in" \
106 | "~/Library/Documentation/Help or install it in your application" \
107 | "bundle."
108 |
109 | .PHONY: devhelp
110 | devhelp:
111 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
112 | @echo
113 | @echo "Build finished."
114 | @echo "To view the help file:"
115 | @echo "# mkdir -p $$HOME/.local/share/devhelp/synthesizer"
116 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/synthesizer"
117 | @echo "# devhelp"
118 |
119 | .PHONY: epub
120 | epub:
121 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
122 | @echo
123 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
124 |
125 | .PHONY: epub3
126 | epub3:
127 | $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
128 | @echo
129 | @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
130 |
131 | .PHONY: latex
132 | latex:
133 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
134 | @echo
135 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
136 | @echo "Run \`make' in that directory to run these through (pdf)latex" \
137 | "(use \`make latexpdf' here to do that automatically)."
138 |
139 | .PHONY: latexpdf
140 | latexpdf:
141 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
142 | @echo "Running LaTeX files through pdflatex..."
143 | $(MAKE) -C $(BUILDDIR)/latex all-pdf
144 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
145 |
146 | .PHONY: latexpdfja
147 | latexpdfja:
148 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
149 | @echo "Running LaTeX files through platex and dvipdfmx..."
150 | $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
151 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
152 |
153 | .PHONY: lualatexpdf
154 | lualatexpdf:
155 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
156 | @echo "Running LaTeX files through lualatex..."
157 | $(MAKE) PDFLATEX=lualatex -C $(BUILDDIR)/latex all-pdf
158 | @echo "lualatex finished; the PDF files are in $(BUILDDIR)/latex."
159 |
160 | .PHONY: xelatexpdf
161 | xelatexpdf:
162 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
163 | @echo "Running LaTeX files through xelatex..."
164 | $(MAKE) PDFLATEX=xelatex -C $(BUILDDIR)/latex all-pdf
165 | @echo "xelatex finished; the PDF files are in $(BUILDDIR)/latex."
166 |
167 | .PHONY: text
168 | text:
169 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
170 | @echo
171 | @echo "Build finished. The text files are in $(BUILDDIR)/text."
172 |
173 | .PHONY: man
174 | man:
175 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
176 | @echo
177 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
178 |
179 | .PHONY: texinfo
180 | texinfo:
181 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
182 | @echo
183 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
184 | @echo "Run \`make' in that directory to run these through makeinfo" \
185 | "(use \`make info' here to do that automatically)."
186 |
187 | .PHONY: info
188 | info:
189 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
190 | @echo "Running Texinfo files through makeinfo..."
191 | make -C $(BUILDDIR)/texinfo info
192 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
193 |
194 | .PHONY: gettext
195 | gettext:
196 | $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
197 | @echo
198 | @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
199 |
200 | .PHONY: changes
201 | changes:
202 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
203 | @echo
204 | @echo "The overview file is in $(BUILDDIR)/changes."
205 |
206 | .PHONY: linkcheck
207 | linkcheck:
208 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
209 | @echo
210 | @echo "Link check complete; look for any errors in the above output " \
211 | "or in $(BUILDDIR)/linkcheck/output.txt."
212 |
213 | .PHONY: doctest
214 | doctest:
215 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
216 | @echo "Testing of doctests in the sources finished, look at the " \
217 | "results in $(BUILDDIR)/doctest/output.txt."
218 |
219 | .PHONY: coverage
220 | coverage:
221 | $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
222 | @echo "Testing of coverage in the sources finished, look at the " \
223 | "results in $(BUILDDIR)/coverage/python.txt."
224 |
225 | .PHONY: xml
226 | xml:
227 | $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
228 | @echo
229 | @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
230 |
231 | .PHONY: pseudoxml
232 | pseudoxml:
233 | $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
234 | @echo
235 | @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
236 |
237 | .PHONY: dummy
238 | dummy:
239 | $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
240 | @echo
241 | @echo "Build finished. Dummy builder generates no files."
242 |
--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | #
3 | # synthesizer documentation build configuration file, created by
4 | # sphinx-quickstart on Sat Dec 31 14:51:42 2016.
5 | #
6 | # This file is execfile()d with the current directory set to its
7 | # containing dir.
8 | #
9 | # Note that not all possible configuration values are present in this
10 | # autogenerated file.
11 | #
12 | # All configuration values have a default; values that are commented out
13 | # serve to show the default.
14 |
15 | # If extensions (or modules to document with autodoc) are in another directory,
16 | # add these directories to sys.path here. If the directory is relative to the
17 | # documentation root, use os.path.abspath to make it absolute, like shown here.
18 | #
19 | # import os
20 | # import sys
21 | # sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath(__file__)), '../synthesizer'))
22 |
23 |
24 | # -- General configuration ------------------------------------------------
25 |
26 | # If your documentation needs a minimal Sphinx version, state it here.
27 | #
28 | # needs_sphinx = '1.0'
29 |
30 | # Add any Sphinx extension module names here, as strings. They can be
31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32 | # ones.
33 | extensions = ['sphinx.ext.autodoc',
34 | 'sphinx.ext.todo',
35 | 'sphinx.ext.viewcode']
36 |
37 | # Add any paths that contain templates here, relative to this directory.
38 | templates_path = ['_templates']
39 |
40 | # The suffix(es) of source filenames.
41 | # You can specify multiple suffix as a list of string:
42 | #
43 | # source_suffix = ['.rst', '.md']
44 | source_suffix = '.rst'
45 |
46 | # The master toctree document.
47 | master_doc = 'index'
48 |
49 | # General information about the project.
50 | project = u'synthesizer'
51 | copyright = u'2017, Yuma Mihira'
52 | author = u'Yuma Mihira'
53 |
54 | # The version info for the project you're documenting, acts as replacement for
55 | # |version| and |release|, also used in various other places throughout the
56 | # built documents.
57 | #
58 | # The short X.Y version.
59 | version = u''
60 | # The full version, including alpha/beta/rc tags.
61 | release = u''
62 |
63 | # The language for content autogenerated by Sphinx. Refer to documentation
64 | # for a list of supported languages.
65 | #
66 | # This is also used if you do content translation via gettext catalogs.
67 | # Usually you set "language" from the command line for these cases.
68 | language = 'en'
69 |
70 | # List of patterns, relative to source directory, that match files and
71 | # directories to ignore when looking for source files.
72 | # This patterns also effect to html_static_path and html_extra_path
73 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
74 |
75 | # The name of the Pygments (syntax highlighting) style to use.
76 | pygments_style = 'sphinx'
77 |
78 | # If true, `todo` and `todoList` produce output, else they produce nothing.
79 | todo_include_todos = True
80 |
81 |
82 | # -- Options for HTML output ----------------------------------------------
83 |
84 | # The theme to use for HTML and HTML Help pages. See the documentation for
85 | # a list of builtin themes.
86 | #
87 | html_theme = 'sphinx_rtd_theme'
88 |
89 | # Theme options are theme-specific and customize the look and feel of a theme
90 | # further. For a list of options available for each theme, see the
91 | # documentation.
92 | #
93 | # html_theme_options = {}
94 |
95 | # Add any paths that contain custom static files (such as style sheets) here,
96 | # relative to this directory. They are copied after the builtin static files,
97 | # so a file named "default.css" will overwrite the builtin "default.css".
98 | html_static_path = ['_static']
99 |
100 |
101 | # -- Options for HTMLHelp output ------------------------------------------
102 |
103 | # Output file base name for HTML help builder.
104 | htmlhelp_basename = 'synthesizerdoc'
105 |
106 |
107 | # -- Options for LaTeX output ---------------------------------------------
108 |
109 | latex_elements = {
110 | # The paper size ('letterpaper' or 'a4paper').
111 | #
112 | # 'papersize': 'letterpaper',
113 |
114 | # The font size ('10pt', '11pt' or '12pt').
115 | #
116 | # 'pointsize': '10pt',
117 |
118 | # Additional stuff for the LaTeX preamble.
119 | #
120 | # 'preamble': '',
121 |
122 | # Latex figure (float) alignment
123 | #
124 | # 'figure_align': 'htbp',
125 | }
126 |
127 | # Grouping the document tree into LaTeX files. List of tuples
128 | # (source start file, target name, title,
129 | # author, documentclass [howto, manual, or own class]).
130 | latex_documents = [
131 | (master_doc, 'synthesizer.tex', u'Synthesizer Documentation',
132 | u'Author', 'manual'),
133 | ]
134 |
135 |
136 | # -- Options for manual page output ---------------------------------------
137 |
138 | # One entry per manual page. List of tuples
139 | # (source start file, name, description, authors, manual section).
140 | man_pages = [
141 | (master_doc, 'synthesizer', u'Synthesizer Documentation',
142 | [author], 1)
143 | ]
144 |
145 |
146 | # -- Options for Texinfo output -------------------------------------------
147 |
148 | # Grouping the document tree into Texinfo files. List of tuples
149 | # (source start file, target name, title, author,
150 | # dir menu entry, description, category)
151 | texinfo_documents = [
152 | (master_doc, 'synthesizer', u'Synthesizer Documentation',
153 | author, 'synthesizer', 'One line description of project.',
154 | 'Miscellaneous'),
155 | ]
156 |
157 |
158 |
159 | # -- Options for Epub output ----------------------------------------------
160 |
161 | # Bibliographic Dublin Core info.
162 | epub_title = project
163 | epub_author = author
164 | epub_publisher = author
165 | epub_copyright = copyright
166 |
167 | # The unique identifier of the text. This can be a ISBN number
168 | # or the project homepage.
169 | #
170 | # epub_identifier = ''
171 |
172 | # A unique identification for the text.
173 | #
174 | # epub_uid = ''
175 |
176 | # A list of files that should not be packed into the epub file.
177 | epub_exclude_files = ['search.html']
178 |
--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
1 | .. synthesizer documentation master file, created by
2 | sphinx-quickstart on Sat Dec 31 14:51:42 2016.
3 | You can adapt this file completely to your liking, but it should at least
4 | contain the root `toctree` directive.
5 |
6 | Welcome to synthesizer's documentation!
7 | =======================================
8 |
9 | .. toctree::
10 | :maxdepth: 4
11 | :caption: Contents:
12 |
13 | synthesizer
14 |
15 |
16 | Indices and tables
17 | ==================
18 |
19 | * :ref:`genindex`
20 | * :ref:`modindex`
21 | * :ref:`search`
22 |
--------------------------------------------------------------------------------
/docs/requirements.txt:
--------------------------------------------------------------------------------
1 | enum34>=1.1.6
2 | numpy>=1.13.3
3 | scipy>=0.19.1
4 |
--------------------------------------------------------------------------------
/docs/synthesizer.rst:
--------------------------------------------------------------------------------
1 | synthesizer package
2 | ===================
3 |
4 | Submodules
5 | ----------
6 |
7 | synthesizer.player module
8 | -------------------------
9 |
10 | .. automodule:: synthesizer.player
11 | :members:
12 | :undoc-members:
13 | :show-inheritance:
14 |
15 | synthesizer.synthesizer module
16 | ------------------------------
17 |
18 | .. automodule:: synthesizer.synthesizer
19 | :members:
20 | :undoc-members:
21 | :show-inheritance:
22 |
23 | synthesizer.writer module
24 | -------------------------
25 |
26 | .. automodule:: synthesizer.writer
27 | :members:
28 | :undoc-members:
29 | :show-inheritance:
30 |
31 | Module contents
32 | ---------------
33 |
34 | .. automodule:: synthesizer
35 | :members:
36 | :undoc-members:
37 | :show-inheritance:
38 |
--------------------------------------------------------------------------------
/example/play_440hz.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | # -*- coding: utf-8 -*-
3 |
4 | import time
5 |
6 | from synthesizer import Player, Synthesizer, Waveform
7 |
8 |
9 | def main():
10 | player = Player()
11 | player.open_stream()
12 |
13 | print("play sine wave")
14 | synthesizer = Synthesizer(osc1_waveform=Waveform.sine, osc1_volume=1.0, use_osc2=False)
15 | player.play_wave(synthesizer.generate_constant_wave(440.0, 3.0))
16 | time.sleep(0.5)
17 |
18 | print("play square wave")
19 | synthesizer = Synthesizer(osc1_waveform=Waveform.square, osc1_volume=0.8, use_osc2=False)
20 | player.play_wave(synthesizer.generate_constant_wave(440.0, 3.0))
21 | time.sleep(0.5)
22 |
23 | print("play triangle wave")
24 | synthesizer = Synthesizer(osc1_waveform=Waveform.triangle, osc1_volume=0.8, use_osc2=False)
25 | player.play_wave(synthesizer.generate_constant_wave(440.0, 3.0))
26 | time.sleep(0.5)
27 |
28 | print("play synthesized wave 1")
29 | synthesizer = Synthesizer(
30 | osc1_waveform=Waveform.sawtooth, osc1_volume=1.0,
31 | use_osc2=True, osc2_waveform=Waveform.sawtooth,
32 | osc2_volume=0.3, osc2_freq_transpose=6.0,
33 | )
34 | player.play_wave(synthesizer.generate_constant_wave(440.0, 3.0))
35 | time.sleep(0.5)
36 |
37 | print("play synthesized wave 2")
38 | synthesizer = Synthesizer(
39 | osc1_waveform=Waveform.square, osc1_volume=1.0,
40 | use_osc2=True, osc2_waveform=Waveform.sine,
41 | osc2_volume=0.3, osc2_freq_transpose=3.0,
42 | )
43 | player.play_wave(synthesizer.generate_constant_wave(440.0, 3.0))
44 |
45 |
46 | if __name__ == '__main__':
47 | main()
48 |
--------------------------------------------------------------------------------
/example/play_chord.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | # -*- coding: utf-8 -*-
3 |
4 | import time
5 |
6 | from synthesizer import Player, Synthesizer, Waveform
7 |
8 |
9 | def main():
10 | player = Player()
11 | player.open_stream()
12 |
13 | print("play major chord")
14 | synthesizer = Synthesizer(osc1_waveform=Waveform.sine, osc1_volume=1.0, use_osc2=False)
15 | chord = ["C4", "E4", "G4"]
16 | player.play_wave(synthesizer.generate_chord(chord, 3.0))
17 | time.sleep(0.5)
18 |
19 | print("play minor chord")
20 | chord = ["C4", "Eb4", "G4"]
21 | player.play_wave(synthesizer.generate_chord(chord, 3.0))
22 | time.sleep(0.5)
23 |
24 | print("play sus4 chord")
25 | chord = ["C4", "F4", "G4"]
26 | player.play_wave(synthesizer.generate_chord(chord, 3.0))
27 | time.sleep(0.5)
28 |
29 | print("play 7th chord")
30 | chord = ["C4", "E4", "G4", "Bb4"]
31 | player.play_wave(synthesizer.generate_chord(chord, 3.0))
32 | time.sleep(0.5)
33 |
34 | print("play add9 chord")
35 | chord = ["C4", "E4", "G4", "D5"]
36 | player.play_wave(synthesizer.generate_chord(chord, 3.0))
37 | time.sleep(0.5)
38 |
39 | print("play chord sequence")
40 | chord = ["D4", "F4", "A4", "C5"]
41 | player.play_wave(synthesizer.generate_chord(chord, 1.0))
42 | chord = ["D4", "G4", "B4"]
43 | player.play_wave(synthesizer.generate_chord(chord, 1.0))
44 | chord = ["E4", "G4", "C5"]
45 | player.play_wave(synthesizer.generate_chord(chord, 1.0))
46 |
47 |
48 | if __name__ == '__main__':
49 | main()
50 |
--------------------------------------------------------------------------------
/example/play_pychord.py:
--------------------------------------------------------------------------------
1 | # In this demo, the chords passed as arguments will be played.
2 |
3 | import argparse
4 |
5 | from pychord import ChordProgression
6 |
7 | from synthesizer import Player, Synthesizer, Waveform
8 |
9 |
10 | def parse_args():
11 | parser = argparse.ArgumentParser()
12 | parser.add_argument("chord", nargs="+", help="The chord to be played")
13 | return parser.parse_args()
14 |
15 |
16 | def main():
17 | args = parse_args()
18 | chords = ChordProgression(args.chord)
19 |
20 | player = Player()
21 | player.open_stream()
22 | synthesizer = Synthesizer(osc1_waveform=Waveform.triangle, osc1_volume=1.0, use_osc2=False)
23 |
24 | for chord in chords:
25 | notes = chord.components_with_pitch(root_pitch=3)
26 | print("Play {}".format(chord))
27 | player.play_wave(synthesizer.generate_chord(notes, 1.0))
28 |
29 |
30 | if __name__ == '__main__':
31 | main()
32 |
--------------------------------------------------------------------------------
/example/write_wave.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | # -*- coding: utf-8 -*-
3 |
4 | import os
5 |
6 | from synthesizer import Synthesizer, Waveform, Writer
7 |
8 |
9 | BASE = 261.626 # C4
10 | DIR = os.path.dirname(os.path.abspath(__file__))
11 |
12 |
13 | def main():
14 | writer = Writer()
15 |
16 | print("write chord sequence")
17 | synthesizer = Synthesizer(osc1_waveform=Waveform.sine, osc1_volume=1.0, use_osc2=False)
18 | chord = [BASE * 2.0 ** (2 / 12.0), BASE * 2.0 ** (5 / 12.0), BASE * 2.0 ** (9 / 12.0), BASE * 2.0 ** (12 / 12.0)]
19 | wave1 = synthesizer.generate_chord(chord, 1.0)
20 | chord = [BASE * 2.0 ** (2 / 12.0), BASE * 2.0 ** (7 / 12.0), BASE * 2.0 ** (11 / 12.0)]
21 | wave2 = synthesizer.generate_chord(chord, 1.0)
22 | chord = [BASE, BASE * 2.0 ** (4 / 12.0), BASE * 2.0 ** (7 / 12.0), BASE * 2.0 ** (12 / 12.0)]
23 | wave3 = synthesizer.generate_chord(chord, 1.0)
24 |
25 | writer.write_waves(os.path.join(DIR, "test.wav"), wave1, wave2, wave3)
26 |
27 |
28 | if __name__ == '__main__':
29 | main()
30 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | enum34>=1.1.6
2 | numpy>=1.13.3
3 | PyAudio>=0.2.11
4 | scipy>=0.19.1
5 |
--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [bdist_wheel]
2 | universal=1
3 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | from setuptools import setup, find_packages
2 | version = '0.2.0'
3 |
4 | setup(
5 | name='synthesizer',
6 | version=version,
7 | description="A simple virtual analog synthesizer.",
8 | classifiers=[
9 | "Development Status :: 4 - Beta",
10 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
11 | "Operating System :: MacOS :: MacOS X",
12 | "Operating System :: POSIX :: Linux",
13 | "Topic :: Multimedia :: Sound/Audio :: Sound Synthesis",
14 | ],
15 | keywords='analog synthesizer',
16 | author='Yuma Mihira',
17 | author_email='info@yurax2.com',
18 | url='https://github.com/yuma-m/synthesizer',
19 | license='GPLv3',
20 | packages=find_packages(exclude=['test']),
21 | include_package_data=True,
22 | zip_safe=True,
23 | long_description=open('README.md').read(),
24 | long_description_content_type='text/markdown',
25 | test_suite='nose.collector',
26 | install_requires=[
27 | 'enum34>=1.1.6',
28 | "numpy>=1.13.3",
29 | # TODO: commented out to build document on ReadTheDocs
30 | # 'PyAudio>=0.2.11',
31 | 'scipy>=0.19.1',
32 | ],
33 | )
34 |
--------------------------------------------------------------------------------
/synthesizer/__init__.py:
--------------------------------------------------------------------------------
1 | from .player import Player
2 | from .synthesizer import Oscillator, Synthesizer, Waveform
3 | from .writer import Writer
4 |
--------------------------------------------------------------------------------
/synthesizer/frequency.py:
--------------------------------------------------------------------------------
1 | A1_FREQ = 55.0
2 |
3 | BASE_FREQUENCY = {
4 | "C": A1_FREQ * 2 ** (-9 / 12.0),
5 | "C#": A1_FREQ * 2 ** (-8 / 12.0),
6 | "Db": A1_FREQ * 2 ** (-8 / 12.0),
7 | "D": A1_FREQ * 2 ** (-7 / 12.0),
8 | "D#": A1_FREQ * 2 ** (-6 / 12.0),
9 | "Eb": A1_FREQ * 2 ** (-6 / 12.0),
10 | "E": A1_FREQ * 2 ** (-5 / 12.0),
11 | "F": A1_FREQ * 2 ** (-4 / 12.0),
12 | "F#": A1_FREQ * 2 ** (-3 / 12.0),
13 | "Gb": A1_FREQ * 2 ** (-3 / 12.0),
14 | "G": A1_FREQ * 2 ** (-2 / 12.0),
15 | "G#": A1_FREQ * 2 ** (-1 / 12.0),
16 | "Ab": A1_FREQ * 2 ** (-1 / 12.0),
17 | "A": A1_FREQ,
18 | "A#": A1_FREQ * 2 ** (1 / 12.0),
19 | "Bb": A1_FREQ * 2 ** (1 / 12.0),
20 | "B": A1_FREQ * 2 ** (2 / 12.0),
21 | }
22 |
23 |
24 | def frequency_from_scale(scale):
25 | """ Calculate frequency from pitch
26 |
27 | :param str scale: e.g. C4, Ab3, D#5
28 | :rtype: float
29 | :return: Frequency of pitch
30 | """
31 | base, octave = scale[:-1], scale[-1]
32 | octave = int(octave)
33 | if base not in BASE_FREQUENCY:
34 | return ValueError("Unknown note: {}".format(base))
35 | return BASE_FREQUENCY[base] * 2 ** (octave - 1)
36 |
--------------------------------------------------------------------------------
/synthesizer/player.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | import numpy as np
4 |
5 |
6 | class Player(object):
7 |
8 | def __init__(self, rate=44100):
9 | try:
10 | import pyaudio
11 | self._pyaudio = pyaudio.PyAudio()
12 | self._format = pyaudio.paInt16
13 | except ImportError:
14 | self._pyaudio = None
15 | self._stream = None
16 | # TODO: support stereo channels
17 | self._channels = 1
18 | self._rate = rate
19 |
20 | def enumerate_device(self):
21 | if not self._pyaudio:
22 | raise ImportError("Failed to import pyaudio, please install pyaudio")
23 | for n in range(self._pyaudio.get_device_count()):
24 | device = self._pyaudio.get_device_info_by_index(n)
25 | print('index: {index:02d}, name: "{name}", rate: {rate:5d}'.format(
26 | index=n, name=device["name"], rate=int(device["defaultSampleRate"])))
27 |
28 | def open_stream(self, device_name=None, device_index=-1):
29 | u""" open audio output stream
30 |
31 | if neither device_name nor device_index is specified,
32 | default output device will be opened.
33 |
34 | :param str device_name: part of device name (ex: hw:0,0)
35 | :param int device_index: index of device
36 | """
37 | if not self._pyaudio:
38 | raise ImportError("Failed to import pyaudio, please install pyaudio")
39 | if device_name:
40 | for n in range(self._pyaudio.get_device_count()):
41 | dev = self._pyaudio.get_device_info_by_index(n)
42 | if dev["name"].find(device_name) >= 0:
43 | device = dev
44 | break
45 | else:
46 | raise RuntimeError("audio device {} not found".format(device_name))
47 | elif device_index >= 0:
48 | device = self._pyaudio.get_device_info_by_index(device_index)
49 | else:
50 | device = self._pyaudio.get_default_output_device_info()
51 |
52 | self._stream = self._pyaudio.open(
53 | channels=self._channels,
54 | format=self._format,
55 | rate=self._rate,
56 | output_device_index=device["index"],
57 | output=True,
58 | )
59 |
60 | def play_wave(self, wave):
61 | u""" play normalized wave
62 |
63 | :param numpy.array wave: normalized wave
64 | """
65 | if not self._stream:
66 | raise RuntimeError("audio stream is not opened, please call open_stream() first.")
67 | wave = (wave * float(2 ** 15 - 1)).astype(np.int16).tobytes()
68 | self._stream.write(wave)
69 |
--------------------------------------------------------------------------------
/synthesizer/synthesizer.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | import numpy as np
4 | import scipy.signal
5 | from enum import Enum
6 |
7 | from .frequency import frequency_from_scale
8 |
9 |
10 | class Waveform(Enum):
11 | sine = "sine"
12 | sawtooth = "sawtooth"
13 | square = "square"
14 | triangle = "triangle"
15 |
16 |
17 | class Oscillator(object):
18 | u""" Virtual oscillator object
19 |
20 | :param Waveform _waveform: waveform of oscillator
21 | :param float _volume: amplitude of generated wave (0.1 - 1.0)
22 | :param float _freq_transpose: transpose of frequency (for sub oscillator)
23 | """
24 |
25 | def __init__(self, waveform, volume, freq_transpose=1.0):
26 | self._waveform = waveform
27 | self._volume = max(0.0, min(1.0, volume))
28 | self._freq_transpose = freq_transpose
29 |
30 | @property
31 | def volume(self):
32 | return self._volume
33 |
34 | @property
35 | def _wave_func(self):
36 | if self._waveform is Waveform.sine:
37 | return np.sin
38 | elif self._waveform is Waveform.sawtooth:
39 | return scipy.signal.sawtooth
40 | elif self._waveform is Waveform.square:
41 | return scipy.signal.square
42 | elif self._waveform is Waveform.triangle:
43 | return self.gen_triang
44 | raise TypeError("unknown waveform: {}".format(self._waveform))
45 |
46 | def generate_wave(self, phases):
47 | phases = np.copy(phases) * self._freq_transpose
48 | return self._volume * self._wave_func(phases)
49 |
50 | @staticmethod
51 | def gen_triang(t, width=0.5):
52 | return scipy.signal.sawtooth(t, width)
53 |
54 |
55 | class Synthesizer(object):
56 | u""" Virtual analog synthesizer object
57 |
58 | :param Oscillator _osc1: main virtual oscillator
59 | :param (Oscillator|None) _osc2: sub virtual oscillator
60 | """
61 |
62 | def __init__(self, osc1_waveform=Waveform.sine, osc1_volume=1.0,
63 | use_osc2=False, osc2_waveform=Waveform.sine,
64 | osc2_volume=0.3, osc2_freq_transpose=2.0,
65 | rate=44100):
66 | u""" Constructor of Synthesizer
67 |
68 | :param Waveform osc1_waveform: waveform for oscillator 1
69 | :param float osc1_volume: relative volume of oscillator 1
70 | :param bool use_osc2: if True wave from osc2 is added to wave from osc1
71 | :param Waveform osc2_waveform: waveform for oscillator 2
72 | :param float osc2_volume: relative volume of oscillator 2
73 | :param float osc2_freq_transpose: frequency transpose for oscillator 2
74 | :param int rate: sampling ratio
75 | """
76 | self._osc1 = Oscillator(waveform=osc1_waveform, volume=osc1_volume)
77 | self._use_osc2 = use_osc2
78 | if self._use_osc2:
79 | self._osc2 = Oscillator(waveform=osc2_waveform, volume=osc2_volume, freq_transpose=osc2_freq_transpose)
80 | else:
81 | self._osc2 = None
82 | self._rate = rate
83 |
84 | def _generate_wave(self, phases):
85 | wave = self._osc1.generate_wave(phases)
86 | if self._use_osc2:
87 | wave += self._osc2.generate_wave(phases)
88 | wave *= (1.0 / (self._osc1.volume + self._osc2.volume))
89 | return wave
90 |
91 | def generate_constant_wave(self, frequency, length):
92 | u""" generate wave with constant frequency
93 |
94 | :param (float|str) frequency: frequency or scale of wave
95 | :param float length: length of wave (seconds)
96 | :rtype: numpy.array
97 | :return: normalized wave
98 | """
99 | if isinstance(frequency, str):
100 | frequency = frequency_from_scale(frequency)
101 | phases = np.cumsum(2.0 * np.pi * frequency / self._rate * np.ones(int(self._rate * float(length))))
102 | return self._generate_wave(phases)
103 |
104 | def generate_chord(self, freqs, length):
105 | u""" generate wave consists of multiple frequencies
106 |
107 | :param list[float] freqs: list of frequencies or scales
108 | :param length: legnth of wave (seconds)
109 | :rtype: numpy.array
110 | :return: normalized wave
111 | """
112 | if not freqs or not isinstance(freqs, list):
113 | raise ValueError("freqs must be a list of float")
114 | wave = self.generate_constant_wave(freqs[0], length)
115 | for freq in freqs[1:]:
116 | wave += self.generate_constant_wave(freq, length)
117 | wave /= float(len(freqs))
118 | return wave
119 |
--------------------------------------------------------------------------------
/synthesizer/writer.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | import numpy as np
4 | from scipy.io import wavfile
5 |
6 |
7 | class Writer(object):
8 |
9 | def __init__(self, rate=44100):
10 | self._rate = rate
11 |
12 | def write_wave(self, file_path, wave):
13 | u""" write wave to a wav file
14 |
15 | :param str file_path: relative / absolute path of wave file
16 | :param numpy.array wave: normalized wave
17 | """
18 | wave = (wave * float(2 ** 15 - 1)).astype(np.int16)
19 | wavfile.write(file_path, self._rate, wave)
20 |
21 | def write_waves(self, file_path, *waves):
22 | u""" write waves to a wav file
23 |
24 | :param str file_path: relative / absolute path of wave file
25 | :param list[numpy.array] waves: list of normalized waves
26 | """
27 | self.write_wave(file_path, np.concatenate(waves))
28 |
--------------------------------------------------------------------------------
/test/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/yuma-m/synthesizer/4357b5664173cedbd0f13188a16bee588771e5fa/test/__init__.py
--------------------------------------------------------------------------------
/test/test_frequency.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | from nose.tools import assert_almost_equal
4 | from parameterized import parameterized
5 |
6 | from synthesizer.frequency import frequency_from_scale
7 |
8 |
9 | @parameterized([
10 | ("A0", 27.5),
11 | ("A#0", 29.135),
12 | ("Bb0", 29.135),
13 | ("B0", 30.868),
14 | ("C1", 32.703),
15 | ("C#1", 34.648),
16 | ("Db1", 34.648),
17 | ("D1", 36.708),
18 | ("D#1", 38.891),
19 | ("Eb1", 38.891),
20 | ("E1", 41.203),
21 | ("F1", 43.654),
22 | ("F#1", 46.249),
23 | ("Gb1", 46.249),
24 | ("G1", 48.999),
25 | ("G#1", 51.913),
26 | ("Ab1", 51.913),
27 | ("A1", 55),
28 | ("C3", 130.813),
29 | ("A4", 440),
30 | ("E5", 659.255),
31 | ])
32 | def test_frequency_from_scale(scale, frequency):
33 | assert_almost_equal(frequency_from_scale(scale), frequency, places=3)
34 |
--------------------------------------------------------------------------------
/test/test_player.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | from nose.tools import ok_, nottest
4 |
5 | from synthesizer import Player
6 |
7 |
8 | def test_enumerate_device():
9 | player = Player()
10 | player.enumerate_device()
11 | ok_("enumerate_device() succeeded.")
12 |
13 |
14 | @nottest
15 | def test_open_default_stream():
16 | player = Player()
17 | player.open_stream()
18 | ok_("open_stream() succeeded.")
19 |
--------------------------------------------------------------------------------
/test/test_synthesizer.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | from synthesizer import Synthesizer, Waveform
4 | from nose.tools import eq_, assert_almost_equal
5 |
6 | RATE = 16000
7 |
8 |
9 | def test_sine_wave():
10 | synthesizer = Synthesizer(osc1_waveform=Waveform.sine, osc1_volume=1.0, use_osc2=False, rate=RATE)
11 | wave = synthesizer.generate_constant_wave(440.0, 1.0)
12 | eq_(wave.size, RATE)
13 | assert_almost_equal(wave.max(), 1.0, places=3)
14 | assert_almost_equal(wave.min(), -1.0, places=3)
15 | assert_almost_equal(wave.mean(), 0.0, places=3)
16 |
17 |
18 | def test_sawtooth_wave():
19 | synthesizer = Synthesizer(osc1_waveform=Waveform.sawtooth, osc1_volume=1.0, use_osc2=False, rate=RATE)
20 | wave = synthesizer.generate_constant_wave(440.0, 1.0)
21 | eq_(wave.size, RATE)
22 | assert_almost_equal(wave.max(), 1.0, places=3)
23 | assert_almost_equal(wave.min(), -1.0, places=3)
24 | assert_almost_equal(wave.mean(), 0.0, places=3)
25 |
26 |
27 | def test_square_wave():
28 | synthesizer = Synthesizer(osc1_waveform=Waveform.square, osc1_volume=1.0, use_osc2=False, rate=RATE)
29 | wave = synthesizer.generate_constant_wave(440.0, 1.0)
30 | eq_(wave.size, RATE)
31 | assert_almost_equal(wave.max(), 1.0, places=3)
32 | assert_almost_equal(wave.min(), -1.0, places=3)
33 | assert_almost_equal(wave.mean(), 0.0, places=3)
34 |
35 |
36 | def test_triangle_wave():
37 | synthesizer = Synthesizer(osc1_waveform=Waveform.triangle, osc1_volume=1.0, use_osc2=False, rate=RATE)
38 | wave = synthesizer.generate_constant_wave(440.0, 1.0)
39 | eq_(wave.size, RATE)
40 | assert_almost_equal(wave.max(), 1.0, places=3)
41 | assert_almost_equal(wave.min(), -1.0, places=3)
42 | assert_almost_equal(wave.mean(), 0.0, places=3)
43 |
--------------------------------------------------------------------------------
/test/test_writer.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | import os
4 |
5 | from nose.tools import ok_
6 |
7 | from synthesizer import Synthesizer, Waveform, Writer
8 |
9 |
10 | def teardown_write_wave():
11 | os.remove("./test_wave.wav")
12 |
13 |
14 | def test_write_wave():
15 | writer = Writer()
16 |
17 | synthesizer = Synthesizer(osc1_waveform=Waveform.sine, osc1_volume=1.0, use_osc2=False)
18 | wave = synthesizer.generate_constant_wave(440.0, 3.0)
19 |
20 | writer.write_wave("./test_wave.wav", wave)
21 | ok_("write_wave() succeeded.")
22 |
23 |
24 | test_write_wave.teardown = teardown_write_wave
25 |
26 |
27 | def teardown_write_waves():
28 | os.remove("./test_waves.wav")
29 |
30 |
31 | def test_write_waves():
32 | writer = Writer()
33 |
34 | synthesizer = Synthesizer(osc1_waveform=Waveform.sine, osc1_volume=1.0, use_osc2=False)
35 | wave1 = synthesizer.generate_constant_wave(220.0, 3.0)
36 | wave2 = synthesizer.generate_constant_wave(440.0, 3.0)
37 |
38 | writer.write_waves("./test_waves.wav", wave1, wave2)
39 | ok_("write_waves() succeeded.")
40 |
41 |
42 | test_write_waves.teardown = teardown_write_waves
43 |
--------------------------------------------------------------------------------