├── .gitignore ├── LICENSE ├── README.md ├── examples ├── __init__.py ├── app.py ├── gunicorn-app.sh ├── loopback │ ├── __init__.py │ └── handlers.py ├── multires │ ├── __init__.py │ └── handlers.py ├── requirements.txt ├── rooms │ ├── __init__.py │ ├── handlers.py │ └── models.py ├── static │ ├── img │ │ └── rainbowpox.png │ └── js │ │ └── kurento-utils.js └── views │ ├── index.html │ ├── loopback.html │ ├── multires.html │ └── room.html ├── pykurento ├── __init__.py ├── client.py ├── media.py └── transport.py ├── setup.cfg └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | .pypirc 3 | dist/ 4 | pykurento.egg-info/ 5 | rooms.db 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | (This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.) 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | {description} 474 | Copyright (C) {year} {fullname} 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | {signature of Ty Coon}, 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | 506 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Pykurento 2 | 3 | ##We are no longer actively developing this project. Sorry to those who were interested. Feel free to fork. 4 | 5 | 6 | Pykurento is a [Kurento](http://www.kurento.org/docs/5.0.3/what_is_kurento.html) client written in python and uses the [websocket-client](https://github.com/liris/websocket-client) library for its transport layer. 7 | 8 | ## Installing 9 | 10 | ``` 11 | pip install git+https://github.com/minervaproject/pykurento.git#egg=pykurento 12 | ``` 13 | 14 | ## Usage 15 | 16 | Here's a simple example of a loopback pipeline created in a tornado request handler. 17 | 18 | ```python 19 | from pykurento import KurentoClient, media 20 | 21 | kurento = KurentoClient("ws://localhost:8888/kurento") 22 | 23 | class LoopbackHandler(tornado.web.RequestHandler): 24 | def get(self): 25 | with open("loopback.html","r") as f: 26 | self.finish(f.read()) 27 | 28 | def post(self): 29 | sdp_offer = self.request.body 30 | pipeline = kurento.create_pipeline() 31 | wrtc_pub = media.WebRtcEndpoint() 32 | sdp_answer = wrtc_pub.process_offer(sdp_offer) 33 | wrtc_pub.connect(wrtc_pub) 34 | self.finish(str(sdp_answer)) 35 | ``` 36 | 37 | [Source for loopback.html](https://github.com/minervaproject/pykurento/blob/master/examples/views/loopback.html) 38 | 39 | 40 | ## Developing 41 | 42 | ### Source and deps 43 | 44 | ``` 45 | git clone https://github.com/minervaproject/pykurento 46 | cd ./pykurento 47 | pip install -r examples/requirements.txt 48 | ``` 49 | 50 | ### Running the examples 51 | 52 | ``` 53 | ./examples/app.py 54 | ``` 55 | 56 | or 57 | 58 | ``` 59 | PORT=8080 ./examples/app.py 60 | ``` 61 | 62 | There is an assumption in the examples that your KMS address is localhost:8888. The easiest way during development to make this work is to setup an ssh tunnel to your media server. 63 | 64 | ``` 65 | ssh -nNT -i -L 8888:localhost:8888 @ 66 | ``` 67 | 68 | ## License 69 | As with Kurento, this client is released under the terms of [LGPL version 2.1](http://www.gnu.org/licenses/lgpl-2.1.html) license. 70 | 71 | -------------------------------------------------------------------------------- /examples/__init__.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | 4 | base_path = os.path.dirname(__file__) 5 | 6 | sys.path.append(os.path.abspath(os.path.join(base_path, '..'))) 7 | 8 | 9 | from pykurento import KurentoClient 10 | 11 | kurento = KurentoClient("ws://localhost:8888/kurento") 12 | 13 | def render_view(handler, name): 14 | with open("%s/views/%s.html" % (base_path, name), "r") as f: 15 | handler.finish(f.read()) 16 | -------------------------------------------------------------------------------- /examples/app.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import os 4 | import sys 5 | import logging 6 | import signal 7 | import tornado.ioloop 8 | import tornado.web 9 | 10 | 11 | sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) 12 | logging.getLogger().setLevel(logging.DEBUG) 13 | 14 | from examples import render_view 15 | import examples.loopback.handlers 16 | import examples.rooms.handlers 17 | import examples.multires.handlers 18 | 19 | 20 | class IndexHandler(tornado.web.RequestHandler): 21 | def get(self): 22 | render_view(self, "index") 23 | 24 | application = tornado.web.Application([ 25 | (r"/", IndexHandler), 26 | (r"/loopback", examples.loopback.handlers.LoopbackHandler), 27 | (r"/multires", examples.multires.handlers.MultiResHandler), 28 | (r"/room", examples.rooms.handlers.RoomIndexHandler), 29 | (r"/room/(?P\d*)", examples.rooms.handlers.RoomHandler), 30 | (r"/room/(?P[^/]*)/subscribe/(?P[^/]*)/(?P[^/]*)", examples.rooms.handlers.SubscribeToParticipantHandler), 31 | (r'/static/(.*)', tornado.web.StaticFileHandler, {'path': os.path.join(os.path.dirname(__file__), "static")}), 32 | ], debug=True) 33 | 34 | if __name__ == "__main__": 35 | port = int(os.environ.get("PORT", 8080)) 36 | application.listen(port) 37 | print "Webserver now listening on port %d" % port 38 | ioloop = tornado.ioloop.IOLoop.instance() 39 | signal.signal(signal.SIGINT, lambda sig, frame: ioloop.stop()) 40 | ioloop.start() 41 | -------------------------------------------------------------------------------- /examples/gunicorn-app.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | gunicorn --name pykurento --worker-class tornado --workers 10 --timeout=300 --bind=127.0.0.1:${PORT-8080} examples.app 4 | -------------------------------------------------------------------------------- /examples/loopback/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/minervaproject/pykurento/59c1c9cb3d89531c05fc6bbc4096b92db312186a/examples/loopback/__init__.py -------------------------------------------------------------------------------- /examples/loopback/handlers.py: -------------------------------------------------------------------------------- 1 | import tornado.web 2 | from pykurento import media 3 | from examples import kurento, render_view 4 | 5 | class LoopbackHandler(tornado.web.RequestHandler): 6 | def on_event(self, *args, **kwargs): 7 | print "received event!" 8 | print args 9 | print kwargs 10 | 11 | def get(self): 12 | render_view(self, "loopback") 13 | 14 | def post(self): 15 | sdp_offer = self.request.body 16 | pipeline = kurento.create_pipeline() 17 | wrtc = media.WebRtcEndpoint(pipeline) 18 | 19 | wrtc.on_media_session_started_event(self.on_event) 20 | wrtc.on_media_session_terminated_event(self.on_event) 21 | 22 | sdp_answer = wrtc.process_offer(sdp_offer) 23 | self.finish(str(sdp_answer)) 24 | 25 | # setup recording 26 | recorder = media.RecorderEndpoint(pipeline, uri="file:///tmp/test.webm") 27 | wrtc.connect(recorder) 28 | recorder.record() 29 | 30 | # plain old loopback 31 | # wrtc.connect(wrtc) 32 | 33 | # fun face overlay 34 | face = media.FaceOverlayFilter(pipeline) 35 | face.set_overlayed_image("https://raw.githubusercontent.com/minervaproject/pykurento/master/example/static/img/rainbowpox.png", 0, 0, 1, 1) 36 | wrtc.connect(face) 37 | face.connect(wrtc) 38 | 39 | -------------------------------------------------------------------------------- /examples/multires/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/minervaproject/pykurento/59c1c9cb3d89531c05fc6bbc4096b92db312186a/examples/multires/__init__.py -------------------------------------------------------------------------------- /examples/multires/handlers.py: -------------------------------------------------------------------------------- 1 | import tornado.web 2 | from pykurento import media 3 | from examples import kurento, render_view 4 | 5 | class MultiResHandler(tornado.web.RequestHandler): 6 | low_res = None 7 | med_res = None 8 | high_res = None 9 | incoming = None 10 | 11 | def get(self): 12 | res = self.get_argument("res", None) 13 | if res and MultiResHandler.incoming: 14 | if res == "high": 15 | MultiResHandler.high_res.connect(MultiResHandler.incoming) 16 | elif res == "med": 17 | MultiResHandler.med_res.connect(MultiResHandler.incoming) 18 | elif res == "low": 19 | MultiResHandler.low_res.connect(MultiResHandler.incoming) 20 | else: 21 | render_view(self, "multires") 22 | 23 | def post(self): 24 | sdp_offer = self.request.body 25 | pipeline = kurento.create_pipeline() 26 | MultiResHandler.incoming = media.WebRtcEndpoint(pipeline) 27 | MultiResHandler.high_res = MultiResHandler.incoming 28 | MultiResHandler.low_res = media.GStreamerFilter(pipeline, command="capsfilter caps=video/x-raw,width=160,height=120", filterType="VIDEO") 29 | MultiResHandler.med_res = media.GStreamerFilter(pipeline, command="capsfilter caps=video/x-raw,width=320,height=240", filterType="VIDEO") 30 | 31 | sdp_answer = MultiResHandler.incoming.process_offer(sdp_offer) 32 | self.finish(str(sdp_answer)) 33 | 34 | MultiResHandler.high_res.connect(MultiResHandler.incoming) 35 | MultiResHandler.incoming.connect(MultiResHandler.low_res) 36 | MultiResHandler.incoming.connect(MultiResHandler.med_res) 37 | -------------------------------------------------------------------------------- /examples/requirements.txt: -------------------------------------------------------------------------------- 1 | tornado==4.0.2 2 | websocket-client==0.21.0 3 | gunicorn==19.2.1 4 | pysqlite==2.6.3 5 | SQLAlchemy==0.9.8 6 | -------------------------------------------------------------------------------- /examples/rooms/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/minervaproject/pykurento/59c1c9cb3d89531c05fc6bbc4096b92db312186a/examples/rooms/__init__.py -------------------------------------------------------------------------------- /examples/rooms/handlers.py: -------------------------------------------------------------------------------- 1 | import tornado.web 2 | from examples import render_view 3 | from examples.rooms import models 4 | 5 | session = models.get_session() 6 | 7 | class RoomIndexHandler(tornado.web.RequestHandler): 8 | def get(self): 9 | render_view(self, "room") 10 | 11 | 12 | class RoomHandler(tornado.web.RequestHandler): 13 | def get(self, room_id=None): 14 | room = session.query(models.Room).get(room_id) 15 | if room: 16 | self.finish({"participants": [p.id for p in room.participants]}) 17 | else: 18 | self.finish({"error": "missing room"}) 19 | 20 | def post(self, room_id): 21 | room = session.query(models.Room).get(room_id) 22 | if not room: 23 | room = models.Room(id=room_id) 24 | session.add(room) 25 | session.commit() 26 | 27 | sdp_offer = self.request.body 28 | 29 | participant = models.Participant(room_id=room_id) 30 | session.add(participant) 31 | session.commit() 32 | 33 | sdp_answer = participant.get_answer(sdp_offer) 34 | 35 | self.finish({ 36 | "participant_id": participant.id, 37 | "answer": sdp_answer 38 | }) 39 | 40 | 41 | class SubscribeToParticipantHandler(tornado.web.RequestHandler): 42 | def post(self, room_id, from_participant_id, to_participant_id): 43 | sdp_offer = self.request.body 44 | from_participant = session.query(models.Participant).get(from_participant_id) 45 | to_participant = session.query(models.Participant).get(to_participant_id) 46 | 47 | if from_participant and to_participant: 48 | sdp_answer = from_participant.connect(sdp_offer) 49 | self.finish({ "answer": sdp_answer }) 50 | else: 51 | self.set_status(409) 52 | self.finish({ "error": "participants matching ids not found" }) 53 | -------------------------------------------------------------------------------- /examples/rooms/models.py: -------------------------------------------------------------------------------- 1 | from examples import kurento 2 | from sqlalchemy import create_engine, Column, Integer, String, ForeignKey 3 | from sqlalchemy.ext.declarative import declarative_base 4 | from sqlalchemy.orm import relationship, backref 5 | from sqlalchemy.orm import sessionmaker 6 | 7 | from pykurento import media 8 | 9 | engine = create_engine('sqlite:///rooms.db', echo=False) 10 | 11 | Base = declarative_base(bind=engine) 12 | Session = sessionmaker(bind=engine) 13 | session = Session() 14 | 15 | def get_session(): 16 | return session 17 | 18 | class Participant(Base): 19 | __tablename__ = "participants" 20 | 21 | id = Column(Integer, primary_key=True) 22 | incoming_endpoint_id = Column(String) 23 | room_id = Column(Integer, ForeignKey('rooms.id')) 24 | 25 | room = relationship("Room", backref=backref('participants', order_by=id)) 26 | 27 | def get_incoming(self): 28 | if self.incoming_endpoint_id: 29 | incoming = media.WebRtcEndpoint(self.room.get_pipeline(), id=self.incoming_endpoint_id) 30 | else: 31 | incoming = media.WebRtcEndpoint(self.room.get_pipeline()) 32 | self.incoming_endpoint_id = incoming.id 33 | session = get_session() 34 | session.add(self) 35 | session.commit() 36 | return incoming 37 | 38 | def get_answer(self, offer): 39 | return self.get_incoming().process_offer(offer) 40 | 41 | def connect(self, offer): 42 | incoming = self.get_incoming() 43 | outgoing = media.WebRtcEndpoint(self.room.get_pipeline()) 44 | incoming.connect(outgoing) 45 | return outgoing.process_offer(offer) 46 | 47 | 48 | class Room(Base): 49 | __tablename__ = "rooms" 50 | 51 | id = Column(Integer, primary_key=True) 52 | pipeline_id = Column(String) 53 | 54 | def get_pipeline(self): 55 | if self.pipeline_id: 56 | pipeline = kurento.get_pipeline(self.pipeline_id) 57 | else: 58 | pipeline = kurento.create_pipeline() 59 | self.pipeline_id = pipeline.id 60 | session = get_session() 61 | session.add(self) 62 | session.commit() 63 | 64 | return pipeline 65 | 66 | 67 | Base.metadata.create_all(engine) -------------------------------------------------------------------------------- /examples/static/img/rainbowpox.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/minervaproject/pykurento/59c1c9cb3d89531c05fc6bbc4096b92db312186a/examples/static/img/rainbowpox.png -------------------------------------------------------------------------------- /examples/static/js/kurento-utils.js: -------------------------------------------------------------------------------- 1 | !function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var f;"undefined"!=typeof window?f=window:"undefined"!=typeof global?f=global:"undefined"!=typeof self&&(f=self),f.kurentoUtils=e()}}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o 1) { 561 | url = parts[1]; 562 | parts = parts[0].split(':'); 563 | 564 | // add the output credential and username 565 | output.username = parts[0]; 566 | output.credential = (input || {}).credential || parts[1] || ''; 567 | } 568 | 569 | output.url = protocol + url; 570 | output.urls = [ output.url ]; 571 | 572 | return output; 573 | }; 574 | 575 | },{}],5:[function(require,module,exports){ 576 | module.exports=[ 577 | "stun.l.google.com:19302", 578 | "stun1.l.google.com:19302", 579 | "stun2.l.google.com:19302", 580 | "stun3.l.google.com:19302", 581 | "stun4.l.google.com:19302", 582 | "stun.ekiga.net", 583 | "stun.ideasip.com", 584 | "stun.rixtelecom.se", 585 | "stun.schlund.de", 586 | "stun.stunprotocol.org:3478", 587 | "stun.voiparound.com", 588 | "stun.voipbuster.com", 589 | "stun.voipstunt.com", 590 | "stun.voxgratia.org" 591 | ] 592 | 593 | },{}],6:[function(require,module,exports){ 594 | module.exports=[] 595 | 596 | },{}]},{},[2])(2) 597 | }); -------------------------------------------------------------------------------- /examples/views/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | Pykurento Examples 10 | 11 | 12 | 13 | 14 |

Pykurento Examples

15 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /examples/views/loopback.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | Pykurento Loopback 13 | 14 | 15 | 16 | 17 |
18 |
19 |

Local stream

20 | 21 |
22 |
23 |

Remote stream

24 | 25 |
26 |
27 | 28 | 29 | 30 | 85 | 86 | 87 | -------------------------------------------------------------------------------- /examples/views/multires.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | Pykurento Loopback 13 | 14 | 15 | 16 | 17 |
18 | low 19 | med 20 | high 21 |
22 |
23 |
24 |

Local stream

25 | 26 |
27 |
28 |

Remote stream

29 | 30 |
31 |
32 |
33 | 34 | 35 | 95 | 96 | 97 | -------------------------------------------------------------------------------- /examples/views/room.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | Pykurento Loopback 13 | 14 | 15 | 16 | 17 |
18 |
19 |
20 |
21 |
22 | 23 | 24 | 134 | 135 | 136 | -------------------------------------------------------------------------------- /pykurento/__init__.py: -------------------------------------------------------------------------------- 1 | from client import KurentoClient -------------------------------------------------------------------------------- /pykurento/client.py: -------------------------------------------------------------------------------- 1 | from pykurento import media 2 | from pykurento.transport import KurentoTransport 3 | 4 | class KurentoClient(object): 5 | def __init__(self, url, transport=None): 6 | self.url = url 7 | self.transport = transport or KurentoTransport(self.url) 8 | 9 | def get_transport(self): 10 | return self.transport 11 | 12 | def create_pipeline(self): 13 | return media.MediaPipeline(self) 14 | 15 | def get_pipeline(self, id): 16 | return media.MediaPipeline(self, id=id) 17 | -------------------------------------------------------------------------------- /pykurento/media.py: -------------------------------------------------------------------------------- 1 | import logging 2 | 3 | logger = logging.getLogger(__name__) 4 | 5 | # This is the object graph as described at http://www.kurento.org/docs/5.0.3/mastering/kurento_API.html 6 | # We dont mimic it precisely yet as its still being built out, not all abstractions are necessary 7 | # MediaObject 8 | # Hub MediaElement MediaPipeline 9 | # HubPort Endpoint Filter 10 | 11 | class MediaType(object): 12 | AUDIO = "AUDIO" 13 | VIDEO = "VIDEO" 14 | DATA = "DATA" 15 | 16 | class MediaObject(object): 17 | def __init__(self, parent, **args): 18 | self.parent = parent 19 | self.options = args 20 | if 'id' in args: 21 | logger.debug("Creating existing %s with id=%s", self.__class__.__name__, args['id']) 22 | self.id = args['id'] 23 | else: 24 | logger.debug("Creating new %s", self.__class__.__name__) 25 | self.id = self.get_transport().create(self.__class__.__name__, **args) 26 | 27 | def get_transport(self): 28 | return self.parent.get_transport() 29 | 30 | def get_pipeline(self): 31 | return self.parent.get_pipeline() 32 | 33 | # todo: remove arguments that have a value of None to let optional params work seamlessly 34 | def invoke(self, method, **args): 35 | return self.get_transport().invoke(self.id, method, **args) 36 | 37 | def subscribe(self, event, fn): 38 | def _callback(value): 39 | fn(value, self) 40 | return self.get_transport().subscribe(self.id, event, _callback) 41 | 42 | def release(self): 43 | return self.get_transport().release(self.id) 44 | 45 | 46 | class MediaPipeline(MediaObject): 47 | def get_pipeline(self): 48 | return self 49 | 50 | 51 | class MediaElement(MediaObject): 52 | def __init__(self, parent, **args): 53 | args["mediaPipeline"] = parent.get_pipeline().id 54 | super(MediaElement, self).__init__(parent, **args) 55 | 56 | def connect(self, sink): 57 | return self.invoke("connect", sink=sink.id) 58 | 59 | def disconnect(self, sink): 60 | return self.invoke("disconnect", sink=sink.id) 61 | 62 | def set_audio_format(self, caps): 63 | return self.invoke("setAudioFormat", caps=caps) 64 | 65 | def set_video_format(self, caps): 66 | return self.invoke("setVideoFormat", caps=caps) 67 | 68 | def get_source_connections(self, media_type): 69 | return self.invoke("getSourceConnections", mediaType=media_type) 70 | 71 | def get_sink_connections(self, media_type): 72 | return self.invoke("getSinkConnections", mediaType=media_type) 73 | 74 | # ENDPOINTS 75 | 76 | class UriEndpoint(MediaElement): 77 | def get_uri(self): 78 | return self.invoke("getUri") 79 | 80 | def pause(self): 81 | return self.invoke("pause") 82 | 83 | def stop(self): 84 | return self.invoke("stop") 85 | 86 | 87 | class PlayerEndpoint(UriEndpoint): 88 | def play(self): 89 | return self.invoke("play") 90 | 91 | def on_end_of_stream_event(self, fn): 92 | return self.subscribe("EndOfStream", fn) 93 | 94 | 95 | class RecorderEndpoint(UriEndpoint): 96 | def record(self): 97 | return self.invoke("record") 98 | 99 | 100 | class SessionEndpoint(MediaElement): 101 | def on_media_session_started_event(self, fn): 102 | return self.subscribe("MediaSessionStarted", fn) 103 | 104 | def on_media_session_terminated_event(self, fn): 105 | return self.subscribe("MediaSessionTerminated", fn) 106 | 107 | 108 | class HttpEndpoint(SessionEndpoint): 109 | def get_url(self): 110 | return self.invoke("getUrl") 111 | 112 | 113 | class HttpGetEndpoint(HttpEndpoint): 114 | pass 115 | 116 | 117 | class HttpPostEndpoint(HttpEndpoint): 118 | def on_end_of_stream_event(self, fn): 119 | return self.subscribe("EndOfStream", fn) 120 | 121 | 122 | class SdpEndpoint(SessionEndpoint): 123 | def generate_offer(self): 124 | return self.invoke("generateOffer") 125 | 126 | def process_offer(self, offer): 127 | return self.invoke("processOffer", offer=offer) 128 | 129 | def process_answer(self, answer): 130 | return self.invoke("processAnswer", answer=answer) 131 | 132 | def get_local_session_descriptor(self): 133 | return self.invoke("getLocalSessionDescriptor") 134 | 135 | def get_remote_session_descriptor(self): 136 | return self.invoke("getRemoteSessionDescriptor") 137 | 138 | 139 | class RtpEndpoint(SdpEndpoint): 140 | pass 141 | 142 | 143 | class WebRtcEndpoint(SdpEndpoint): 144 | pass 145 | 146 | 147 | # FILTERS 148 | 149 | class GStreamerFilter(MediaElement): 150 | pass 151 | 152 | 153 | class FaceOverlayFilter(MediaElement): 154 | def set_overlayed_image(self, uri, offset_x, offset_y, width, height): 155 | return self.invoke("setOverlayedImage", uri=uri, offsetXPercent=offset_x, offsetYPercent=offset_y, widthPercent=width, heightPercent=height) 156 | 157 | 158 | class ZBarFilter(MediaElement): 159 | def on_code_found_event(self, fn): 160 | return self.subscribe("CodeFound", fn) 161 | 162 | 163 | # HUBS 164 | 165 | class Composite(MediaElement): 166 | pass 167 | 168 | 169 | class Dispatcher(MediaElement): 170 | pass 171 | 172 | 173 | class DispatcherOneToMany(MediaElement): 174 | pass 175 | -------------------------------------------------------------------------------- /pykurento/transport.py: -------------------------------------------------------------------------------- 1 | import websocket 2 | import json 3 | import time 4 | import threading 5 | import logging 6 | 7 | logger = logging.getLogger(__name__) 8 | 9 | class TimeoutException(Exception): 10 | pass 11 | 12 | 13 | class Timeout(object): 14 | def __init__(self, seconds=1, error_message='Timeout'): 15 | self.seconds = seconds 16 | self.error_message = error_message 17 | self.timer = None 18 | 19 | def handle_timeout(self): 20 | raise TimeoutException(self.error_message) 21 | 22 | def __enter__(self): 23 | self.timer = threading.Timer(self.seconds, self.handle_timeout) 24 | 25 | def __exit__(self, type, value, traceback): 26 | if self.timer: 27 | self.timer.cancel() 28 | 29 | 30 | class KurentoTransportException(Exception): 31 | def __init__(self, message, response={}): 32 | super(KurentoTransportException, self).__init__(message) 33 | self.response = response 34 | 35 | def __str__(self): 36 | return "%s - %s" % (str(self.message), json.dumps(self.response)) 37 | 38 | 39 | class KurentoTransport(object): 40 | def __init__(self, url): 41 | logger.debug("Creating new KurentoTransport with url: %s" % url) 42 | self.url = url 43 | self.ws = websocket.WebSocket() 44 | self.current_id = 0 45 | self.session_id = None 46 | self.pending_operations = {} 47 | self.subscriptions = {} 48 | self.stopped = False 49 | 50 | self.thread = threading.Thread(target=self._run_thread) 51 | self.thread.daemon = True 52 | self.thread.start() 53 | 54 | def __del__(self): 55 | logger.debug("Destroying KurentoTransport with url: %s" % self.url) 56 | self.stopped = True 57 | self.ws.close() 58 | 59 | def _check_connection(self): 60 | if not self.ws.connected: 61 | logger.info("Kurent Client websocket is not connected, reconnecting") 62 | try: 63 | with Timeout(seconds=5): 64 | self.ws.connect(self.url) 65 | logger.info("Kurent Client websocket connected!") 66 | except TimeoutException: 67 | # modifying this exception so we can differentiate in the receiver thread 68 | raise KurentoTransportException("Timeout: Kurento Client websocket connection timed out") 69 | 70 | def _run_thread(self): 71 | while not self.stopped: 72 | try: 73 | self._check_connection() 74 | with Timeout(seconds=1): 75 | self._on_message(self.ws.recv()) 76 | except TimeoutException: 77 | logger.debug("WS Receiver Timeout") 78 | except Exception as ex: 79 | logger.error("WS Receiver Thread %s: %s" % (type(ex), str(ex))) 80 | 81 | def _next_id(self): 82 | self.current_id += 1 83 | return self.current_id 84 | 85 | def _on_message(self, message): 86 | resp = json.loads(message) 87 | logger.debug("received message: %s" % message) 88 | 89 | if 'method' in resp: 90 | if (resp['method'] == 'onEvent' 91 | and 'params' in resp 92 | and 'value' in resp['params'] 93 | and 'subscription' in resp['params'] 94 | and resp['params']['subscription'] in self.subscriptions): 95 | sub_id = resp['params']['subscription'] 96 | fn = self.subscriptions[sub_id] 97 | self.session_id = resp['params']['sessionId'] if 'sessionId' in resp['params'] else self.session_id 98 | fn(resp["params"]["value"]) 99 | 100 | else: 101 | if 'result' in resp and 'sessionId' in resp['result']: 102 | self.session_id = resp['result']['sessionId'] 103 | self.pending_operations["%d_response" % resp["id"]] = resp 104 | 105 | def _rpc(self, rpc_type, **args): 106 | if self.session_id: 107 | args["sessionId"] = self.session_id 108 | 109 | request = { 110 | "jsonrpc": "2.0", 111 | "id": self._next_id(), 112 | "method": rpc_type, 113 | "params": args 114 | } 115 | req_key = "%d_request" % request["id"] 116 | resp_key = "%d_response" % request["id"] 117 | 118 | self.pending_operations[req_key] = request 119 | 120 | self._check_connection() 121 | 122 | logger.debug("sending message: %s" % json.dumps(request)) 123 | self.ws.send(json.dumps(request)) 124 | 125 | while (resp_key not in self.pending_operations): 126 | time.sleep(1) 127 | 128 | resp = self.pending_operations[resp_key] 129 | 130 | del self.pending_operations[req_key] 131 | del self.pending_operations[resp_key] 132 | 133 | if 'error' in resp: 134 | raise KurentoTransportException(resp['error']['message'] if 'message' in resp['error'] else 'Unknown Error', resp) 135 | elif 'result' in resp and 'value' in resp['result']: 136 | return resp['result']['value'] 137 | else: 138 | return None # just to be explicit 139 | 140 | def create(self, obj_type, **args): 141 | return self._rpc("create", type=obj_type, constructorParams=args) 142 | 143 | def invoke(self, object_id, operation, **args): 144 | return self._rpc("invoke", object=object_id, operation=operation, operationParams=args) 145 | 146 | def subscribe(self, object_id, event_type, fn): 147 | subscription_id = self._rpc("subscribe", object=object_id, type=event_type) 148 | self.subscriptions[subscription_id] = fn 149 | return subscription_id 150 | 151 | def unsubscribe(self, subscription_id): 152 | del self.subscriptions[subscription_id] 153 | return self._rpc("unsubscribe", subscription=subscription_id) 154 | 155 | def release(self, object_id): 156 | return self._rpc("release", object=object_id) 157 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | setup(name='pykurento', 4 | version='0.0.1', 5 | description='A python kurento client based on websocket-client', 6 | url='https://github.com/minervaproject/pykurento', 7 | download_url='https://github.com/minervaproject/pykurento/tarball/0.0.1', 8 | author='Gene Hallman, MinervaProject', 9 | author_email='gene@minervaproject.com', 10 | license='LGPL', 11 | packages=['pykurento'], 12 | install_requires=[ 13 | 'websocket-client>=0.21.0' 14 | ], 15 | zip_safe=False) 16 | --------------------------------------------------------------------------------