ll-scope-0.2.1/0000755000076500007650000000000010247036503011042 5ustar llllll-scope-0.2.1/ll-scope.h0000644000076500007650000000447210247036375012747 0ustar llll/**************************************************************************** ll-scope.h - The plugin part of the DSSI Oscilloscope plugin Copyright (C) 2005 Lars Luthman This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA ****************************************************************************/ #ifndef LL_SCOPE_H #define LL_SCOPE_H #include #include "ringbuffer.h" /** @file This file contains datatypes that are used by the scope plugin. */ #if defined(__cplusplus) extern "C" { #endif /** The BUFFER_SIZE is the number of sample frames that the ringbuffers can hold. */ #define BUFFER_SIZE 128000 /** This type contains the data that is stored in the memory segment that is shared between the plugin and the UI. It has two ringbuffers, one for each channel of audio data. */ typedef struct { unsigned long sample_rate; union { ringbuf_t rb; char data[sizeof(ringbuf_t) - 1 + BUFFER_SIZE * sizeof(LADSPA_Data)]; } channel1; union { ringbuf_t rb; char data[sizeof(ringbuf_t) - 1 + BUFFER_SIZE * sizeof(LADSPA_Data)]; } channel2; } shared_data_t; #if defined(__cplusplus) } #endif #endif /* For the Doxygen main page */ /** @mainpage Oscilloscope plugin source code documentation This source code documentation is generated in order to help people (including me) understand how the Oscilloscope plugin works, or is supposed to work. But it's not meant to be a complete reference, so many functions and types will be undocumented. Send questions and comments to larsl@users.sourceforge.net. */ ll-scope-0.2.1/dssiuiclient.hpp0000644000076500007650000002000310247036375014254 0ustar llll/**************************************************************************** dssiuiclient.hpp - a class that makes writing DSSI GUIs easier Copyright (C) 2005 Lars Luthman This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA ****************************************************************************/ #ifndef DSSIUICLIENT_HPP #define DSSIUICLIENT_HPP #include #include #include #include #include #include using namespace Glib; using namespace sigc; using namespace std; /** This class can be used by a DSSI plugin UI to communicate with the plugin host. It has public functions for all the messages that the UI can send to the host, and public signals for all the messages that the host can send to the UI, which will be emitted when a message is received. It also handles all the required communication with the host, such as sending the first /update request and sending an /exiting message when the DSSIUIClient object is destroyed. It also has a function that will handle all the nastyness involved in setting up a shared memory segment that the plugin and the UI can use to communicate messages that are not specified by DSSI. */ class DSSIUIClient { public: /** This constructor starts an OSC receiver thread and sends an update request to the plugin host. The parameters should be the @c argc and @c argv from the main() function. */ DSSIUIClient(int argc, char** argv); /** This destructor will mark any allocated shared memory for destruction, send an /exiting message to the plugin host, and stop and deallocate the OSC receiver thread. */ ~DSSIUIClient(); /** Returns @c true if the initialisation went OK and we haven't received a /quit message yet. */ bool is_valid() const; /** Returns the identifier string given by the plugin host. */ const string& get_identifier() const; // C++ wrappers for OSC methods specified in the DSSI RFC: // UI to host /** Sends the control value @c value to input port number @c port in the plugin. */ void send_control(int port, float value); /** Change the plugin's program. */ void send_program(int bank, int program); /** Tell the host that we want an update of all the controls, program and configuration values for the plugin. This is called automatically when this DSSIUIClient object is created. */ void send_update_request(); /** Send a configuration value to the plugin. */ void send_configure(const string& key, const string& value); /** Send a MIDI event to the plugin. The effect will be exactly the same as if it had been sent by the plugin host. */ void send_midi(const char event[4]); /** Tell the plugin host that the GUI is about to quit (you shouldn't have to call this explicitly, it is called when this DSSIUIClient object is destroyed. */ void send_exiting(); // Host to UI /** This signal is emitted when the host sends a new control value. The parameters are the control port number and the new control value. */ signal control_received; /** Emitted when the host sends a program change. The parameters are the bank and program numbers. */ signal program_received; /** Emitted when the host sends a configuration value. The parameters are the configuration key and the configuration value. */ signal configure_received; /** Emitted when the host wants the UI to be visible. A DSSI GUI should not show any windows until this signal is emitted. */ Dispatcher show_received; /** Emitted when the host wants to hide the UI. */ Dispatcher hide_received; /** Emitted when the host wants the UI to exit. This DSSIUIClient object will not send or receive any OSC messages after it has received this message, but you still have to quit the program yourself. */ Dispatcher quit_received; /** This function allocates a segment of shared memory and tells the plugin about it using a configure() call. The plugin should use dssi_shm_attach() to attach to the shared memory segment - this function handles all the nasty problems that can arise if the host decides to save the configure() message and send it again later, or send it to another instance of the plugin. This function can only be used once during the lifetime of this DSSIUIClient object, if you try to use it a second time it will simply return NULL. If you need to allocate more memory segments after the first one you can use the normal shm functions (see the man page for shm_get(2)) and send the segment IDs directly to the plugin using a ringbuffer in the initial shared segment (for example). The memory segment allocated using this function will be marked for deallocation when this DSSIUIClient object is destroyed. The segment won't actually be deallocated until the plugin detaches from it. */ void* allocate_shared_memory(int bytes); /** Emitted when the plugin has attached to the shared memory segment. */ signal plugin_attached; /** Returns true if the plugin has attached to the shared memory segment. */ bool plugin_has_attached(); private: // Static callbacks for OSC method calls (liblo is not C++) static int control_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data); static int program_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data); static int configure_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data); static int show_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data); static int hide_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data); static int quit_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data); // Dispatchers that get the signals from the OSC thread to the GUI thread // (the queues and receiver functions are needed for passing data since // Dispatchers don't take parameters) Dispatcher m_control_dispatcher; queue > m_control_queue; void control_receiver() { int port = m_control_queue.front().first; float value = m_control_queue.front().second; m_control_queue.pop(); control_received(port, value); } Dispatcher m_program_dispatcher; queue > m_program_queue; void program_receiver() { int bank = m_program_queue.front().first; int program = m_program_queue.front().second; m_program_queue.pop(); program_received(bank, program); } Dispatcher m_configure_dispatcher; queue > m_configure_queue; void configure_receiver() { string key = m_configure_queue.front().first; string value = m_configure_queue.front().second; m_configure_queue.pop(); configure_received(key, value); } bool check_shared_memory(); lo_address m_plugin_address; string m_plugin_path; lo_server_thread m_server_thread; string m_shm_key; char* m_plugin_flag; bool m_valid; string m_identifier; }; #endif ll-scope-0.2.1/scopewidget.hpp0000644000076500007650000000532110247036375014100 0ustar llll/**************************************************************************** scopewidget.hpp - an Oscilloscope widget for gtkmm Copyright (C) 2005 Lars Luthman This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA ****************************************************************************/ #ifndef SCOPEWIDGET_HPP #define SCOPEWIDGET_HPP #include #include #include "ll-scope.h" using namespace std; using namespace Gtk; using namespace Gdk; using namespace Glib; using namespace sigc; class ScopeWidget : public DrawingArea { public: ScopeWidget(shared_data_t* shared_data); ~ScopeWidget(); void set_trigger_level(LADSPA_Data trigger_level); void set_trigger_direction(bool up); void set_y1_scale(double scale); void set_y2_scale(double scale); void set_y1_offset(double offset); void set_y2_offset(double offset); void set_x_offset(double offset); void set_frozen(bool frozen); void set_additive(bool additive); void set_time_scale(double ms); void on_realize(); bool on_expose_event(GdkEventExpose* event); bool on_button_press_event(GdkEventButton* event); void clear(); // signals signal middle_button_pressed; private: bool read_data(); void draw_data(); RefPtr m_colormap; Color m_bg_color, m_fg_color, m_fg_color2, m_trig_color, m_grid_color1, m_grid_color2; RefPtr m_win; RefPtr m_gc; RefPtr m_background; shared_data_t* m_shared_data; ringbuf_t* m_buffer1; ringbuf_t* m_buffer2; LADSPA_Data* m_channel1; LADSPA_Data* m_channel2; unsigned int m_frames_read; int m_timeout; LADSPA_Data m_trigger_level; bool m_trigger_up; double m_y1_scale; double m_y2_scale; double m_y1_offset; double m_y2_offset; double m_x_offset; bool m_frozen; bool m_additive; LADSPA_Data m_trigger_phase; unsigned int m_window_size; unsigned long m_sample_rate; enum { WaitingForTrigger, ReadingData } m_scope_state; int m_samples_read; }; #endif ll-scope-0.2.1/COPYING0000644000076500007650000004311010247036375012103 0ustar llll GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. ll-scope-0.2.1/dssiuiclient.cpp0000644000076500007650000001556410247036375014267 0ustar llll/**************************************************************************** dssiuiclient.hpp - a class that makes writing DSSI GUIs easier Copyright (C) 2005 Lars Luthman This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA ****************************************************************************/ #include #include #include #include #include #include #include "dssi_shm.h" #include "dssiuiclient.hpp" using namespace Glib; using namespace sigc; DSSIUIClient::DSSIUIClient(int argc, char** argv) : m_plugin_flag(NULL), m_valid(false) { if (argc < 5) { cerr<<"Not enough arguments passed to the DSSIUIClient constructor! "< 0) { dssi_shm_free(m_shm_key.c_str()); if (m_valid) send_configure("shm_detach", m_shm_key.c_str()); m_shm_key = ""; } if (m_valid) { send_exiting(); lo_server_thread_stop(m_server_thread); lo_server_thread_free(m_server_thread); } } const string& DSSIUIClient::get_identifier() const { return m_identifier; } void DSSIUIClient::send_control(int port, float value) { if (!m_valid) { lo_send(m_plugin_address, string(m_plugin_path + "/control").c_str(), "if", port, value); } } void DSSIUIClient::send_program(int bank, int program) { if (m_valid) { lo_send(m_plugin_address, string(m_plugin_path + "/program").c_str(), "ii", bank, program); } } void DSSIUIClient::send_update_request() { if (m_valid) { char* my_url = lo_server_thread_get_url(m_server_thread); string url(my_url); free(my_url); lo_send(m_plugin_address, (m_plugin_path + "/update").c_str(), "s", (url + "scope").c_str()); } } void DSSIUIClient::send_configure(const string& key, const string& value) { if (m_valid) { lo_send(m_plugin_address, (m_plugin_path + "/configure").c_str(), "ss", key.c_str(), value.c_str()); } } void DSSIUIClient::send_midi(const char event[4]) { if (m_valid) { lo_send(m_plugin_address, (m_plugin_path + "/midi").c_str(), "s", event); } } void DSSIUIClient::send_exiting() { if (m_valid) { lo_send(m_plugin_address, (m_plugin_path + "/exiting").c_str(), NULL); } } void* DSSIUIClient::allocate_shared_memory(int bytes) { if (m_valid && m_shm_key.size() == 0) { char* key_str; m_plugin_flag = NULL; void* ptr = dssi_shm_allocate(bytes, &key_str, &m_plugin_flag); m_shm_key = key_str; free(key_str); signal_timeout().connect(mem_fun(*this, &DSSIUIClient::check_shared_memory), 10); send_configure("shm_attach", m_shm_key); return ptr; } return NULL; } bool DSSIUIClient::plugin_has_attached() { return (m_plugin_flag != NULL && *m_plugin_flag != 0); } int DSSIUIClient::control_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { DSSIUIClient* me = static_cast(user_data); me->m_control_queue.push(make_pair(argv[0]->i, argv[1]->f)); me->m_control_dispatcher(); return 0; } int DSSIUIClient::program_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { DSSIUIClient* me = static_cast(user_data); me->m_program_queue.push(make_pair(argv[0]->i, argv[1]->i)); me->m_program_dispatcher(); return 0; } int DSSIUIClient::configure_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { DSSIUIClient* me = static_cast(user_data); string key(&argv[0]->s); string value(&argv[1]->s); me->m_configure_queue.push(make_pair(key, value)); me->m_configure_dispatcher(); return 0; } int DSSIUIClient::show_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { DSSIUIClient* me = static_cast(user_data); me->show_received(); return 0; } int DSSIUIClient::hide_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { DSSIUIClient* me = static_cast(user_data); me->hide_received(); return 0; } int DSSIUIClient::quit_handler(const char *path, const char *types, lo_arg **argv, int argc, void *data, void *user_data) { DSSIUIClient* me = static_cast(user_data); me->m_valid = false; me->quit_received(); lo_server_thread_stop(me->m_server_thread); return 0; } bool DSSIUIClient::check_shared_memory() { if (m_plugin_flag != NULL && *m_plugin_flag != 0) { plugin_attached(); return false; } return true; } bool DSSIUIClient::is_valid() const { return m_valid; } ll-scope-0.2.1/main.cpp0000644000076500007650000001514210247036375012504 0ustar llll/**************************************************************************** main.cpp - the main file for the Oscilloscope GUI Copyright (C) 2005 Lars Luthman This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA ****************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "dssiuiclient.hpp" #include "ringbuffer.h" #include "scopewidget.hpp" #include "ll-scope.h" using namespace std; using namespace Gdk; using namespace Gtk; using namespace Gnome::Glade; using namespace Glib; Gtk::Window* main_win; Gtk::Window* init_gui(ScopeWidget& scope_canvas); void toggle_controls(Widget* notoggle); int main(int argc, char** argv) { // create the DSSI UI client DSSIUIClient dssi(argc, argv); if (!dssi.is_valid()) { cerr<<"Could not start OSC listener. You are not running the "<(dssi.allocate_shared_memory(shm_size)); Main kit(0, NULL); for (int i = 0; i < 1000; ++i) { if (dssi.plugin_has_attached()) break; if (i == 999) { cerr<<"Waited 10 seconds for the plugin to attach to the shared memory, " <<"nothing "<set_title(dssi.get_identifier()); // run dssi.show_received.connect(mem_fun(*main_win, &Gtk::Window::show)); dssi.hide_received.connect(mem_fun(*main_win, &Gtk::Window::hide)); dssi.quit_received.connect(&Main::quit); main_win->signal_delete_event().connect(bind_return(hide(&Main::quit), true)); Main::run(); return 0; } Gtk::Window* init_gui(ScopeWidget& scope_canvas) { // get everything from the Glade file RefPtr xml = Xml::create(INSTALL_DIR "/ll-scope/ll-scope.glade"); Gtk::Window* main_win = dynamic_cast(xml->get_widget("main_win")); Box* canvas_box = dynamic_cast(xml->get_widget("canvas_box")); SpinButton* trigger_spin = dynamic_cast(xml->get_widget("trigger_spin")); SpinButton* y1_scale_spin = dynamic_cast(xml->get_widget("y1_scale_spin")); SpinButton* y2_scale_spin = dynamic_cast(xml->get_widget("y2_scale_spin")); SpinButton* time_scale_spin = dynamic_cast(xml->get_widget("time_scale_spin")); Range* y1_offset_range = dynamic_cast(xml->get_widget("y1_offset_range")); Range* y2_offset_range = dynamic_cast(xml->get_widget("y2_offset_range")); Range* x_offset_range = dynamic_cast(xml->get_widget("x_offset_range")); CheckButton* trigger_up = dynamic_cast(xml->get_widget("trigger_up")); if (!(main_win && canvas_box && trigger_spin && y1_scale_spin && y2_scale_spin && time_scale_spin && y1_offset_range && y2_offset_range && x_offset_range && trigger_up)) return NULL; // insert the scope widget canvas_box->pack_start(scope_canvas); scope_canvas.set_size_request(300, 200); canvas_box->show_all(); // connect widgets to the scope trigger_spin->signal_value_changed(). connect(compose(mem_fun(scope_canvas, &ScopeWidget::set_trigger_level), mem_fun(*trigger_spin, &SpinButton::get_value))); y1_scale_spin->signal_value_changed(). connect(compose(mem_fun(scope_canvas, &ScopeWidget::set_y1_scale), mem_fun(*y1_scale_spin, &SpinButton::get_value))); y2_scale_spin->signal_value_changed(). connect(compose(mem_fun(scope_canvas, &ScopeWidget::set_y2_scale), mem_fun(*y2_scale_spin, &SpinButton::get_value))); time_scale_spin->signal_value_changed(). connect(compose(mem_fun(scope_canvas, &ScopeWidget::set_time_scale), mem_fun(*time_scale_spin, &SpinButton::get_value))); y1_offset_range->signal_value_changed(). connect(compose(mem_fun(scope_canvas, &ScopeWidget::set_y1_offset), mem_fun(*y1_offset_range, &Range::get_value))); y2_offset_range->signal_value_changed(). connect(compose(mem_fun(scope_canvas, &ScopeWidget::set_y2_offset), mem_fun(*y2_offset_range, &Range::get_value))); x_offset_range->signal_value_changed(). connect(compose(mem_fun(scope_canvas, &ScopeWidget::set_x_offset), mem_fun(*x_offset_range, &Range::get_value))); trigger_up->signal_toggled(). connect(compose(mem_fun(scope_canvas, &ScopeWidget::set_trigger_direction), mem_fun(*trigger_up, &CheckButton::get_active))); // and set the initial values (from the Glade file) scope_canvas.set_trigger_level(trigger_spin->get_value()); scope_canvas.set_y1_scale(y1_scale_spin->get_value()); scope_canvas.set_y2_scale(y2_scale_spin->get_value()); scope_canvas.set_time_scale(time_scale_spin->get_value()); scope_canvas.set_y1_offset(y1_offset_range->get_value()); scope_canvas.set_y2_offset(y2_offset_range->get_value()); scope_canvas.set_x_offset(x_offset_range->get_value()); scope_canvas.set_trigger_direction(trigger_up->get_active()); return main_win; } void toggle_controls(Widget* notoggle) { static bool hidden = false; if (hidden) main_win->show_all(); else { main_win->get_child()->hide_all(); Widget* w = notoggle; while (w) { w->show(); w = w->get_parent(); } } hidden = !hidden; } ll-scope-0.2.1/scopewidget.cpp0000644000076500007650000002040510247036375014073 0ustar llll/**************************************************************************** scopewidget.hpp - an Oscilloscope widget for gtkmm Copyright (C) 2005 Lars Luthman This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA ****************************************************************************/ #include #include #include #include "scopewidget.hpp" ScopeWidget::ScopeWidget(shared_data_t* shared_data) : DrawingArea(), m_shared_data(shared_data), m_buffer1(NULL), m_buffer2(NULL), m_frames_read(0), m_trigger_level(0), m_trigger_up(true), m_y1_scale(1), m_y2_scale(1), m_y1_offset(0), m_y2_offset(0), m_x_offset(0), m_frozen(false), m_additive(false), m_scope_state(WaitingForTrigger), m_samples_read(0), m_timeout(30), m_window_size(30), m_sample_rate(0), m_channel1(NULL), m_channel2(NULL) { m_sample_rate = m_shared_data->sample_rate; m_channel1 = new LADSPA_Data[m_sample_rate]; m_channel2 = new LADSPA_Data[m_sample_rate]; memset(m_channel1, 0, m_sample_rate * sizeof(LADSPA_Data)); memset(m_channel2, 0, m_sample_rate * sizeof(LADSPA_Data)); m_buffer1 = &(m_shared_data->channel1.rb); m_buffer2 = &(m_shared_data->channel2.rb); m_colormap = Colormap::get_system(); m_bg_color.set_rgb(10000, 10000, 10000); m_fg_color.set_rgb(0, 60000, 0); m_fg_color2.set_rgb(60000, 0, 0); m_trig_color.set_rgb(60000, 60000, 0); m_grid_color1.set_rgb(0, 30000, 30000); m_grid_color2.set_rgb(0, 15000, 15000); m_colormap->alloc_color(m_bg_color); m_colormap->alloc_color(m_fg_color); m_colormap->alloc_color(m_fg_color2); m_colormap->alloc_color(m_trig_color); m_colormap->alloc_color(m_grid_color1); m_colormap->alloc_color(m_grid_color2); add_events(BUTTON_PRESS_MASK); signal_timeout().connect(mem_fun(*this, &ScopeWidget::read_data), m_timeout); } ScopeWidget::~ScopeWidget() { delete [] m_channel1; delete [] m_channel2; } void ScopeWidget::set_trigger_level(LADSPA_Data trigger_level) { m_trigger_level = trigger_level; queue_draw(); } void ScopeWidget::set_trigger_direction(bool up) { m_trigger_up = up; } void ScopeWidget::set_y1_scale(double scale) { m_y1_scale = scale; queue_draw(); } void ScopeWidget::set_y2_scale(double scale) { m_y2_scale = scale; queue_draw(); } void ScopeWidget::set_x_offset(double offset) { m_x_offset = offset; queue_draw(); } void ScopeWidget::set_y1_offset(double offset) { m_y1_offset = offset; queue_draw(); } void ScopeWidget::set_y2_offset(double offset) { m_y2_offset = offset; queue_draw(); } void ScopeWidget::set_frozen(bool frozen) { m_frozen = frozen; } void ScopeWidget::set_additive(bool additive) { m_additive = additive; } void ScopeWidget::set_time_scale(double ms) { m_window_size = int(6 * ms * m_sample_rate / 1000); queue_draw(); } void ScopeWidget::on_realize() { // create drawing tools for the widget DrawingArea::on_realize(); m_win = get_window(); m_gc = GC::create(m_win); clear(); } bool ScopeWidget::on_expose_event(GdkEventExpose* event) { clear(); draw_data(); return true; } bool ScopeWidget::on_button_press_event(GdkEventButton* event) { if (event->button == 1) set_frozen(!m_frozen); else if (event->button == 2) middle_button_pressed(); else if (event->button == 3) set_additive(!m_additive); return true; } void ScopeWidget::clear() { m_gc->set_foreground(m_bg_color); m_win->draw_rectangle(m_gc, true, 0, 0, 3, 200); for (int x = 0; x < 300; x += 50) { for (int y = 0; y < 200; y += 50) { int xx = x + 3, yy = y, w = 49, h = 49; if (x != 0) ++xx; if (x == 0 || x == 250) ++w; if (y != 0) ++yy; if (y == 0 || y == 150) ++h; m_win->draw_rectangle(m_gc, true, xx, yy, w, h); } } m_gc->set_foreground(m_grid_color2); for (int x = 0; x < 300; x += 50) { if (x != 150) m_win->draw_line(m_gc, x + 3, 0, x + 3, 200); } for (int y = 50; y < 200; y += 50) { if (y != 100) m_win->draw_line(m_gc, 3, y, 300 + 3, y); } m_gc->set_foreground(m_grid_color1); m_win->draw_line(m_gc, 150 + 3, 0, 150 + 3, 200); m_win->draw_line(m_gc, 3, 100, 300 + 3, 100); m_gc->set_foreground(m_trig_color); int y = int(200 / 2 - m_y1_scale * m_trigger_level * 200 / 4 + m_y1_offset); m_win->draw_line(m_gc, 0, y, 2, y); } bool ScopeWidget::read_data() { bool got_data = false; LADSPA_Data* data1; LADSPA_Data* data2; // search the buffer for a trigger if (m_scope_state == WaitingForTrigger) { // catch up int a = ringbuf_available(m_buffer1); int b = ringbuf_available(m_buffer2); a = (a <= b ? a : b); if (a > 1000) { ringbuf_read(m_buffer1, NULL, a - 1000); ringbuf_read(m_buffer2, NULL, a - 1000); } data1 = (LADSPA_Data*)ringbuf_get_read_ptr(m_buffer1); data2 = (LADSPA_Data*)ringbuf_get_read_ptr(m_buffer2); int n = ringbuf_available_contiguous(m_buffer1); int m = ringbuf_available_contiguous(m_buffer2); n = (n <= m ? n : m); int i; for (i = 0; i < n; ++i) { if ((i > 0) && !m_frozen && ((m_trigger_up && (data1[i-1] < m_trigger_level) && (data1[i] >= m_trigger_level)) || (!m_trigger_up && (data1[i-1] >= m_trigger_level) && (data1[i] < m_trigger_level)))) { m_trigger_phase = abs((m_trigger_level - data1[i-1]) / (data1[i] - data1[i-1])); m_scope_state = ReadingData; m_channel1[0] = data1[i-1]; m_channel2[0] = data2[i-1]; m_frames_read = 1; break; } } ringbuf_read(m_buffer1, NULL, i); ringbuf_read(m_buffer2, NULL, i); } // got a trigger, copy data to the image buffer if (m_scope_state == ReadingData) { int n = ringbuf_available(m_buffer1); int m = ringbuf_available(m_buffer2); n = (n <= m ? n : m); n = (n <= m_window_size -m_frames_read ? n : m_window_size - m_frames_read); ringbuf_read(m_buffer1, m_channel1 + m_frames_read, n); ringbuf_read(m_buffer2, m_channel2 + m_frames_read, n); m_frames_read += n; if (m_frames_read >= m_window_size) { got_data = true; m_scope_state = WaitingForTrigger; } } // draw any new data if (got_data && !m_frozen) { if (!m_additive) clear(); draw_data(); } return true; } void ScopeWidget::draw_data() { int h = 200; m_gc->set_foreground(m_fg_color2); double scale = m_window_size / 300.0; for (int i = 1; i < 300; ++i) { if ((i + m_trigger_phase) * scale + 1 >= m_frames_read) break; double t1 = (i - 1 + m_trigger_phase) * scale; double t2 = (i + m_trigger_phase) * scale; double y1 = (m_channel2[int(t1)] * (1 - (t1 - int(t1))) + m_channel2[int(t1) + 1] * (t1 - int(t1))); double y2 = (m_channel2[int(t2)] * (1 - (t2 - int(t2))) + m_channel2[int(t2) + 1] * (t2 - int(t2))); m_win->draw_line(m_gc, i - 1 + int(m_x_offset) + 3, int(h / 2 - m_y2_scale * y1 * h / 4 + m_y2_offset), i + int(m_x_offset) + 3, int(h / 2 - m_y2_scale * y2 * h / 4 + m_y2_offset)); } m_gc->set_foreground(m_fg_color); for (int i = 1; i < 300; ++i) { if (int(i * scale) >= m_frames_read) break; double t1 = (i - 1 + m_trigger_phase) * scale; double t2 = (i + m_trigger_phase) * scale; double y1 = (m_channel1[int(t1)] * (1 - (t1 - int(t1))) + m_channel1[int(t1) + 1] * (t1 - int(t1))); double y2 = (m_channel1[int(t2)] * (1 - (t2 - int(t2))) + m_channel1[int(t2) + 1] * (t2 - int(t2))); m_win->draw_line(m_gc, i - 1 + int(m_x_offset) + 3, int(h / 2 - m_y1_scale * y1 * h / 4 + m_y1_offset), i + int(m_x_offset) + 3, int(h / 2 - m_y1_scale * y2 * h / 4 + m_y1_offset)); } } ll-scope-0.2.1/ll-scope.gladep0000644000076500007650000000074310247036375013751 0ustar llll Oscilloscope ll-scope FALSE FALSE FALSE FALSE FALSE ll-scope-0.2.1/Makefile0000644000076500007650000000201110247036375012503 0ustar llllINSTALL_DIR=/usr/local/lib/dssi all: ll-scope.so ll-scope_gtk %.so: %.c dssi_shm.o ringbuffer.o $(CC) -D_SVID_SOURCE -D_XOPEN_SOURCE $(CFLAGS) `pkg-config dssi --cflags` -g -o $*.o -c $*.c $(LD) `pkg-config dssi --libs` -o $*.so $*.o dssi_shm.o ringbuffer.o -shared ll-scope_gtk: main.cpp scopewidget.hpp scopewidget.cpp dssiuiclient.hpp dssiuiclient.cpp dssi_shm.o ringbuffer.o ll-scope.h Makefile $(CXX) $(CXXFLAGS) $(CFLAGS) -D_SVID_SOURCE -D_XOPEN_SOURCE -DINSTALL_DIR=\"$(INSTALL_DIR)\" `pkg-config libglademm-2.4 gthread-2.0 liblo dssi --cflags --libs` main.cpp scopewidget.cpp dssiuiclient.cpp dssi_shm.o ringbuffer.o -o ll-scope_gtk -g %.o: %.h %.c $(CC) $(CFLAGS) -D_SVID_SOURCE -D_XOPEN_SOURCE -DINSTALL_DIR=\"$(INSTALL_DIR)\" `pkg-config dssi --cflags` -c $*.c -g clean: rm -f ll-scope.so ll-scope_gtk *.o install: ll-scope.so ll-scope_gtk mkdir -p $(INSTALL_DIR) cp -f ll-scope.so $(INSTALL_DIR) mkdir -p $(INSTALL_DIR)/ll-scope cp -f ll-scope_gtk ll-scope.glade pixmaps/icon.png $(INSTALL_DIR)/ll-scope/ ll-scope-0.2.1/ringbuffer.h0000644000076500007650000000337410247036375013362 0ustar llll/**************************************************************************** ringbuffer.h - a ringbuffer designed to be used in shared memory Copyright (C) 2005 Lars Luthman This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA ****************************************************************************/ #ifndef RINGBUFFER_H #define RINGBUFFER_H #if defined(__cplusplus) extern "C" { #endif typedef struct ringbuf_t { int read_pos, write_pos, max_pos, atom_size; char data[1]; } ringbuf_t; void ringbuf_init(ringbuf_t* rb, int atom_size, int size); int ringbuf_read(ringbuf_t* rb, void* dest, int size); int ringbuf_write(ringbuf_t* rb, void* src, int size); int ringbuf_write_zeros(ringbuf_t* rb, int size); int ringbuf_available(ringbuf_t* rb); int ringbuf_available_contiguous(ringbuf_t* rb); int ringbuf_get_size(int atom_size, int size); int ringbuf_get_read_pos(ringbuf_t* rb); int ringbuf_get_write_pos(ringbuf_t* rb); char* ringbuf_get_read_ptr(ringbuf_t* rb); #if defined(__cplusplus) } #endif #endif ll-scope-0.2.1/dssi_shm.c0000644000076500007650000001030210247036375013022 0ustar llll/**************************************************************************** dssi_shm.h - functions that can handle shared memory segments for DSSI plugins and UIs Copyright (C) 2005 Lars Luthman This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA ****************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include "dssi_shm.h" void* dssi_shm_allocate(size_t bytes, char** keystring, char** used_flag) { int fd, shm_id, i; key_t key; void* shared_buffer; /* get a random key for the memory segment */ if ((fd = open("/dev/urandom", O_RDONLY)) == -1) { perror("Could not open /dev/urandom"); return NULL; } read(fd, &key, sizeof(key_t)); close(fd); /* create and attach the memory segment */ shm_id = shmget(key, bytes + 9, IPC_CREAT | IPC_EXCL | S_IRWXU | S_IRWXG); if (shm_id == -1) { perror("Could not create shared memory segment"); return NULL; } shared_buffer = shmat(shm_id, NULL, 0); if (!shared_buffer) { perror("Could not attach to shared memory segment"); shmctl(shm_id, IPC_RMID, NULL); return NULL; } /* add the unique string */ *keystring = calloc(100, sizeof(char)); srand(time(NULL) + getpid() * 1000000); for (i = 0; i < 8; ++i) sprintf((char*)shared_buffer + bytes + i, "%X", rand() % 16); /* give the caller a key to send to the plugin */ sprintf(*keystring, "%X:%s:%X", shm_id, (char*)shared_buffer + bytes, bytes); /* set the USED flag to 0 (it should be 0 already, but there's no harm in setting it explicitly) */ ((char*)shared_buffer)[bytes + 8] = 0; *used_flag = ((char*)shared_buffer) + bytes + 8; return shared_buffer; } void* dssi_shm_attach(const char* key, void* old_ptr) { int shm_id, keystart, bytes; void* ptr; if (sscanf(key, "%X:%n%*X:%X", &shm_id, &keystart, &bytes) < 1) { fprintf(stderr, "Invalid keystring, can not attach " "shared memory segment\n"); return NULL; } /* first, check if this is the same segment as the one we have already */ if (old_ptr) { if (!strncmp(key + keystart, (char*)old_ptr + bytes, 8)) { fprintf(stderr, "Trying to attach a memory segment that we already " "have attached\n"); return old_ptr; } /* set the USED flag to 0 and detach the segment (will attach it again immediately) */ ((char*)old_ptr)[bytes + 8] = 0; shmdt(old_ptr); } ptr = shmat(shm_id, NULL, 0); /* check the keystring */ if (strncmp(key + keystart, (char*)ptr + bytes, 8)) { shmdt(ptr); fprintf(stderr, "The keystrings do not match, detaching the " "shared memory segment\n"); return NULL; } /* check that this segment isn't already in use this is potentially dangerous since someone could come along and set the use flag to 1 in another thread right after our check */ if (((char*)ptr)[bytes + 8] == 0) ((char*)ptr)[bytes + 8] = 1; else { shmdt(ptr); fprintf(stderr, "The shared memory segment is already in use!\n"); return NULL; } return ptr; } int dssi_shm_free(const char* key) { int shm_id; unsigned int ptr_int; if (sscanf(key, "%X:%*X:%X", &shm_id, &ptr_int) < 1) shm_id = -1; shmdt((void*)ptr_int); return shmctl(shm_id, IPC_RMID, NULL); } int dssi_shm_detach(void* ptr) { return shmdt(ptr); } ll-scope-0.2.1/dssi_shm.h0000644000076500007650000000631110247036375013034 0ustar llll/**************************************************************************** dssi_shm.h - functions that can handle shared memory segments for DSSI plugins and UIs Copyright (C) 2005 Lars Luthman This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA ****************************************************************************/ #ifndef DSSI_SHM_H #define DSSI_SHM_H /** @file This file contains functions for handling shared memory in DSSI UIs and plugins. It is used by the DSSIUIClient class on the UI side, but can also be used on its own. */ #if defined(__cplusplus) extern "C" { #endif /** This function should be used in the UI to allocate a segment of shared memory and generate a key for this segment that can be sent to the plugin. @c bytes is the requested segment size in bytes. @c key and @c used_flag are output parameters, @c key will hold a key string for the new segment that you can send to the plugin with a /configure call, and @c used_flag will contain a pointer to a char in the shared memory segment that the plugin will set to 1 when it has attached succesfully to the segment. You will have to deallocate @c *key yourself. @returns A pointer to the new segment or NULL */ void* dssi_shm_allocate(size_t bytes, char** key, char** used_flag); /** This function should be used by the plugin to attach to a shared memory segment that has been allocated by the UI using dssi_shm_allocate(). @c key is the key string received from the UI and @c old_ptr is a pointer to the old shared memory segment if this is not the first time the plugin tries to attach to a segment. It can be NULL if no segment has been attached earlier. @returns A pointer to the new attached segment or NULL */ void* dssi_shm_attach(const char* key, void* old_ptr); /** This should always be called by the UI when it wants to deallocate a shared memory segment allocated using dssi_shm_allocate(). @c key is the key string generated by the call to dssi_shm_allocate(). @returns The result of a @c shmctl() call */ int dssi_shm_free(const char* key); /** This should always be called by the plugin when it wants to detach from a memory segment that has been attached using dssi_shm_attach(). @c ptr should be a pointer to the memory segment. @returns The result of s @c shmdt() call */ int dssi_shm_detach(void* ptr); #if defined(__cplusplus) } #endif #endif ll-scope-0.2.1/ringbuffer.c0000644000076500007650000001151310247036375013347 0ustar llll/**************************************************************************** ringbuffer.c - a ringbuffer designed to be used in shared memory Copyright (C) 2005 Lars Luthman This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA ****************************************************************************/ /* #include */ #include "ringbuffer.h" void ringbuf_init(ringbuf_t* rb, int atom_size, int size) { rb->read_pos = 0; rb->write_pos = 0; rb->atom_size = atom_size; rb->max_pos = size; } int ringbuf_read(ringbuf_t* rb, void* dest, int size) { int n = 0; static int col = 0; if (size == 0) return 0; /*fprintf(stderr, "Request to read %d atoms\n", size);*/ if (rb->read_pos > rb->write_pos) { n = rb->max_pos - rb->read_pos; n = (n > size ? size : n); if (dest) memcpy(dest, rb->data + rb->read_pos * rb->atom_size, n * rb->atom_size); rb->read_pos = (rb->read_pos + n) % rb->max_pos; } if (rb->read_pos < rb->write_pos && n < size) { int m = rb->write_pos - rb->read_pos; m = (m > size - n ? size - n : m); if (dest) memcpy((char*)dest + n * rb->atom_size, rb->data + rb->read_pos * rb->atom_size, m * rb->atom_size); rb->read_pos = (rb->read_pos + m) % rb->max_pos; n += m; } /* fprintf(stderr, "RB %d atoms read from the ringbuffer\n" "\tread_pos = %d write_pos = %d max_pos = %d\n", n, rb->read_pos, rb->write_pos, rb->max_pos); */ /*if (n < size) fprintf(stderr, "RB: read collision %d\n", col++);*/ return n; } int ringbuf_write(ringbuf_t* rb, void* src, int size) { int n = 0; static int col = 0; if (size == 0) return 0; if (rb->write_pos >= rb->read_pos) { n = rb->max_pos - rb->write_pos; if (rb->read_pos == 0) --n; n = (n > size ? size : n); memcpy(rb->data + rb->write_pos * rb->atom_size, src, n * rb->atom_size); rb->write_pos = (rb->write_pos + n) % rb->max_pos; } if (rb->write_pos + 1 < rb->read_pos && n < size) { int m = rb->read_pos - rb->write_pos - 1; m = (m > size - n ? size - n : m); memcpy(rb->data + rb->write_pos * rb->atom_size, (char*)src + n * rb->atom_size, m * rb->atom_size); rb->write_pos = (rb->write_pos + m) % rb->max_pos; n += m; } /*fprintf(stderr, "RB %d atoms written to the ringbuffer\n" "\tread_pos = %d write_pos = %d max_pos = %d\n", n, rb->read_pos, rb->write_pos, rb->max_pos);*/ /* if (n < size) fprintf(stderr, "RB: write collision %d\n", col++); */ return n; } int ringbuf_write_zeros(ringbuf_t* rb, int size) { int n = 0; static int col = 0; if (size == 0) return 0; if (rb->write_pos >= rb->read_pos) { n = rb->max_pos - rb->write_pos; if (rb->read_pos == 0) --n; n = (n > size ? size : n); memset(rb->data + rb->write_pos * rb->atom_size, 0, n * rb->atom_size); rb->write_pos = (rb->write_pos + n) % rb->max_pos; } if (rb->write_pos + 1 < rb->read_pos && n < size) { int m = rb->read_pos - rb->write_pos - 1; m = (m > size - n ? size - n : m); memset(rb->data + rb->write_pos * rb->atom_size, 0, m * rb->atom_size); rb->write_pos = (rb->write_pos + m) % rb->max_pos; n += m; } /*fprintf(stderr, "RB %d atoms written to the ringbuffer\n" "\tread_pos = %d write_pos = %d max_pos = %d\n", n, rb->read_pos, rb->write_pos, rb->max_pos);*/ /* if (n < size) fprintf(stderr, "RB: write collision %d\n", col++); */ return n; } int ringbuf_available(ringbuf_t* rb) { if (rb->read_pos <= rb->write_pos) return rb->write_pos - rb->read_pos; else return rb->max_pos - rb->read_pos + rb->write_pos; } int ringbuf_available_contiguous(ringbuf_t* rb) { if (rb->read_pos <= rb->write_pos) return rb->write_pos - rb->read_pos; else return rb->max_pos - rb->read_pos; } int ringbuf_get_size(int atom_size, int size) { return sizeof(ringbuf_t) - 1 + size * atom_size; } int ringbuf_get_read_pos(ringbuf_t* rb) { return rb->read_pos; } int ringbuf_get_write_pos(ringbuf_t* rb) { return rb->write_pos; } char* ringbuf_get_read_ptr(ringbuf_t* rb) { return rb->data + rb->read_pos * rb->atom_size; } ll-scope-0.2.1/ll-scope.c0000644000076500007650000001623110247036375012736 0ustar llll/**************************************************************************** ll-scope.c - The plugin part of the DSSI Oscilloscope plugin Copyright (C) 2005 Lars Luthman This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA ****************************************************************************/ #include #include #include #include #include #include #include #include #include #include "dssi_shm.h" #include "ringbuffer.h" #include "ll-scope.h" /* the plugin instance struct */ typedef struct { LADSPA_Data* input_buffer1; LADSPA_Data* input_buffer2; shared_data_t* shared_data; unsigned long sample_rate; int shm_id; } DSSI_Scope; /* data pointers */ LADSPA_Descriptor* ladspa_desc; LADSPA_PortDescriptor* port_desc; char** port_name; LADSPA_PortRangeHint* port_hint; DSSI_Descriptor* dssi_desc; /** In this function we allocate a DSSI_Scope object and allocate shared memory to copy incoming data into. It should be called by the host. */ LADSPA_Handle instantiate(const LADSPA_Descriptor* descriptor, unsigned long sample_rate) { DSSI_Scope* scope; /* fprintf(stderr, "Creating new DSSI Scope instance\n"); */ scope = calloc(1, sizeof(DSSI_Scope)); scope->sample_rate = sample_rate; return scope; } /** This function should be called by the host when something is connected to the input port. Nothing fancy here, just copy the pointer to the input buffer to our DSSI_Scope instance. */ void connect_port(LADSPA_Handle instance, unsigned long port, LADSPA_Data* data_location) { DSSI_Scope* scope; /* fprintf(stderr, "Connecting input buffer to input port %u of DSSI Scope\n", port); */ scope = instance; if (port == 0) scope->input_buffer1 = data_location; else if (port == 1) scope->input_buffer2 = data_location; } /** This function is run by the host when it wants to set a new configuration value (for example when the UI tells it to attach the shared memory segment). */ char* configure(LADSPA_Handle instance, const char *key, const char *value) { /* fprintf(stderr, "configure %s = %s\n", key, value); */ DSSI_Scope* scope = instance; if (!strcmp(key, "shm_attach")) { shared_data_t* new_data = (shared_data_t*)dssi_shm_attach(value, scope->shared_data); if (new_data) { scope->shared_data = new_data; scope->shared_data->sample_rate = scope->sample_rate; ringbuf_init(&(scope->shared_data->channel1.rb), sizeof(LADSPA_Data), BUFFER_SIZE); ringbuf_init(&(scope->shared_data->channel2.rb), sizeof(LADSPA_Data), BUFFER_SIZE); } } else if (!strcmp(key, "shm_detach")) { dssi_shm_detach(scope->shared_data); scope->shared_data = NULL; } return NULL; } /** This function is run by the host when it wants the plugin to process a chunk of audio data. We just copy it into our shared memory buffer. */ void run(LADSPA_Handle instance, unsigned long sample_count) { DSSI_Scope* scope = instance; if (scope->shared_data) { if (scope->input_buffer1) ringbuf_write(&(scope->shared_data->channel1.rb), scope->input_buffer1, sample_count); else ringbuf_write_zeros(&(scope->shared_data->channel1.rb), sample_count); if (scope->input_buffer2) ringbuf_write(&(scope->shared_data->channel2.rb), scope->input_buffer2, sample_count); else ringbuf_write_zeros(&(scope->shared_data->channel2.rb), sample_count); } } /** Just a wrapper function to make it work in jack-dssi-host 0.9 */ void run_synth(LADSPA_Handle instance, unsigned long sample_count, snd_seq_event_t* Events, unsigned long EventCount) { run(instance, sample_count); } /** This is called by the host when it wants to dispose of the plugin instance. Here we free the shared memory buffer and the DSSI_Scope instance. */ void cleanup(LADSPA_Handle instance) { DSSI_Scope* scope; /* fprintf(stderr, "Cleaning up after a DSSI Scope instance\n"); */ scope = instance; free(instance); } /** This is called automagically by the dynamic linker when the library is loaded. Initialise global stuff here. */ void _init() { /* allocate memory for LADSPA data */ ladspa_desc = malloc(sizeof(LADSPA_Descriptor)); memset(ladspa_desc, 0, sizeof(LADSPA_Descriptor)); port_desc = calloc(2, sizeof(LADSPA_PortDescriptor)); port_name = calloc(2, sizeof(char *)); port_hint = calloc(2, sizeof(LADSPA_PortRangeHint)); /* set LADSPA plugin info */ ladspa_desc->UniqueID = 2745; ladspa_desc->Label = strdup("ll-scope"); ladspa_desc->Properties = LADSPA_PROPERTY_HARD_RT_CAPABLE; ladspa_desc->Name = strdup("Oscilloscope"); ladspa_desc->Maker = strdup("Lars Luthman"); ladspa_desc->Copyright = strdup("GPL"); ladspa_desc->PortCount = 2; /* set LADSPA port info */ ladspa_desc->PortDescriptors = port_desc; port_desc[0] = LADSPA_PORT_INPUT | LADSPA_PORT_AUDIO; port_desc[1] = LADSPA_PORT_INPUT | LADSPA_PORT_AUDIO; ladspa_desc->PortNames = (const char**)port_name; port_name[0] = strdup("Channel 1"); port_name[1] = strdup("Channel 2"); ladspa_desc->PortRangeHints = port_hint; port_hint[0].HintDescriptor = 0; port_hint[1].HintDescriptor = 0; /* set LADSPA callbacks */ ladspa_desc->instantiate = instantiate; ladspa_desc->connect_port = connect_port; ladspa_desc->activate = NULL; ladspa_desc->run = run; ladspa_desc->run_adding = NULL; ladspa_desc->set_run_adding_gain = NULL; ladspa_desc->deactivate = NULL; ladspa_desc->cleanup = cleanup; /* set DSSI info */ dssi_desc = malloc(sizeof(DSSI_Descriptor)); dssi_desc->DSSI_API_Version = 1; dssi_desc->LADSPA_Plugin = ladspa_desc; dssi_desc->configure = configure; dssi_desc->get_program = NULL; dssi_desc->get_midi_controller_for_port = NULL; dssi_desc->select_program = NULL; dssi_desc->run_synth = run_synth; dssi_desc->run_synth_adding = NULL; dssi_desc->run_multiple_synths = NULL; dssi_desc->run_multiple_synths_adding = NULL; } /** This is called automagically by the dynamic linker when the library is unloaded. Free global stuff here. */ void _fini() { int i; free(dssi_desc); free(ladspa_desc); free(port_desc); for (i = 0; i < 2; ++i) free(port_name[i]); free(port_name); free(port_hint); } /** The host expects this function to return a DSSI_Descriptor describing the plugin. */ const DSSI_Descriptor* dssi_descriptor(unsigned long index) { if (index == 0) return dssi_desc; return NULL; } ll-scope-0.2.1/README0000644000076500007650000001125110247036375011731 0ustar llllOscilloscope plugin ================================================== The Oscilloscope is a DSSI plugin with a GUI that displays the audio input in an oscilloscope view. I wrote it because I wanted something too use in modular synths to view the waveforms with at different places in the synth graph. I am licensing it under the GNU General Public License, so if you are writing GPL software too, feel free to use any pieces of this plugin in your own code. The plugin DOES NOT WORK with jack-dssi-host 0.9, because that does not support audio input ports. You will either need a later release (which unfortunately does not exist yet) or get the latest development version from the DSSI CVS repository on SourceForge (http://sf.net/projects/dssi). You can of course also use another DSSI host, like Om (0.1.0 and 0.1.1 will not work though). This document describes how to install and use the DSSI Scope plugin. If you have any questions or comments about the plugin, send them to larsl@users.sourceforge.net. 1. Installation ================================================== To build the plugin you will need the following libraries (and all libraries they depend on): * libglademm, version 2.6.0 or later (it might work with earlier versions but that has not been tested) * liblo, version 0.18 or later (same comment as above) * the DSSI header, dssi.h This plugin does not use the GNU autotools since I thought it would be overkill for a small project that also is not meant to be cross-platform, so you will have to edit the Makefile to change the installation settings. The only thing you should have to change is the INSTALL_DIR variable. The default setting is to install the plugin in /usr/local/lib/dssi. To build the plugin, just type make in the plugin source directory. To install the plugin, type make install as root (unless you have set the INSTALL_DIR to something you can write to without being root). 2. Use ================================================== When you bring up the GUI for the DSSI Scope you will see a rectangular display and some sliders, spinbuttons, and other control widgets. The display will show the audio data from both input channels - channel 1 is green and channel 2 is red. If the input to channel 1 is constant 0 nothing might be shown at all, because you need a zero crossing to trigger the drawing. To test the plugin you can load it on Om and connect it to an oscillator, or run it in jack-dssi-host (which comes with the DSSI SDK) and connect it to a sound player such as XMMS. 2.1 The trigger ================================================== The oscilloscope will not show anything in the display until it detects a "trigger". This trigger consists of the audio signal in channel 1 moving over the trigger level, either from below to above (ascending) or from above to below (descending). When a trigger is detected a block of audio data corresponding to the display width will be copied from the input of both channels and shown in the display. You can control the trigger level by changing the value of the spinbutton labeled "Trg level". The current trigger level is shown as a small yellow line at the left edge of the display. You can also change whether the trigger will fire on ascending or descending signal by checking or unchecking the checkbox labeled "Trigger on ascending". 2.2 Offsets and scaling ================================================== The display is divided into 6 x 4 squares called "divisions". You can determine the amount of time (in the X direction) and signal amplitude (in the Y direction) that each division corresponds to by changing the value in the spinbuttons "ms/DIV", "V1/DIV", and "V2/DIV". ms/DIV will set the number of milliseconds per division, and V1/DIV will set the number of signal strength units per division for channel 1 while V2/DIV will do the same for channel 2. You can also use the vertical sliders to the left of the display to change the 0 levels for the two channels (i.e. moving the channels vertically). The leftmost slider controls the 0 level for channel 1 and the other controls the level for channel 2. The horizontal slider below the display can be used to move the signals from both channels horizontally. 2.3 Different modes ================================================== You can "freeze" the signal currently shown by left-clicking in the display. This will tell the oscilloscope to ignore any new triggers. Left-clicking again will unfreeze the signal. Right-clicking the display toggles "cumulative mode". In cumulative mode the display does not get cleared before a new audio block is drawn. Finally, middle-clicking the display hides or shows all the control widgets. ll-scope-0.2.1/ll-scope.glade0000644000076500007650000003307110247036375013571 0ustar llll Oscilloscope GTK_WINDOW_TOPLEVEL GTK_WIN_POS_NONE False False False icon.png True False False GDK_WINDOW_TYPE_HINT_NORMAL GDK_GRAVITY_NORTH_WEST 3 True 3 3 False 0 0 True True False GTK_POS_TOP 1 GTK_UPDATE_CONTINUOUS False 0 0 300 1 100 0 2 3 1 2 fill fill 2 True 2 6 False 2 3 True Set whether the trigger should fire on ascending or descending signal True Trigger on ascending True GTK_RELIEF_NORMAL True True False True 0 4 1 2 fill True ms/DIV: False False GTK_JUSTIFY_LEFT False False 1 0.5 0 0 0 1 0 1 fill True V1/DIV: False False GTK_JUSTIFY_LEFT False False 1 0.5 0 0 2 3 0 1 fill True Set the number of milliseconds per division True 1 0 False GTK_UPDATE_ALWAYS False False 6 1 165 1 10 10 1 2 0 1 fill True Set the number of signal amplitude units per division for channel 1 True 1 3 True GTK_UPDATE_ALWAYS False False 1 -10 10 0.00999999977648 1 1 3 4 0 1 fill True Set the number of signal amplitude units per division for channel 2 True 1 3 True GTK_UPDATE_ALWAYS False False 1 -10 10 0.00999999977648 1 1 5 6 0 1 fill True Trg level: False False GTK_JUSTIFY_LEFT False False 1 0.5 0 0 4 5 1 2 fill True Set the trigger level True 0.00999999977648 3 True GTK_UPDATE_ALWAYS False False 0.0010000000475 -10 10 0.00999999977648 0.25 0.25 5 6 1 2 fill True V2/DIV: False False GTK_JUSTIFY_LEFT False False 1 0.5 0 0 4 5 0 1 fill 0 3 2 3 fill 303 200 True False 0 2 3 0 1 fill fill True True False GTK_POS_TOP 1 GTK_UPDATE_CONTINUOUS False 0 -100 100 0 0 0 1 2 0 1 fill True True False GTK_POS_TOP 1 GTK_UPDATE_CONTINUOUS False 0 -100 100 0 0 0 0 1 0 1 fill ll-scope-0.2.1/Doxyfile0000644000076500007650000013501710247036473012565 0ustar llll# Doxyfile 1.3.9.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # # All text after a hash (#) is considered a comment and will be ignored # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = Oscilloscope # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = 0.2.1 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = dox # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output # format and will distribute the generated files over these directories. # Enabling this option can be useful when feeding doxygen a huge amount of source # files, where putting all generated files in the same directory would otherwise # cause performance problems for the file system. CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, # Swedish, and Ukrainian. OUTPUT_LANGUAGE = English # This tag can be used to specify the encoding used in the generated output. # The encoding is not always determined by the language that is chosen, # but also whether or not the output is meant for Windows or non-Windows users. # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES # forces the Windows encoding (this is the default for the Windows binary), # whereas setting the tag to NO uses a Unix-style encoding (the default for # all platforms other than Windows). USE_WINDOWS_ENCODING = NO # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string # in this list, if found as the leading text of the brief description, will be # stripped from the text and the result after processing the whole list, is used # as the annotated text. Otherwise, the brief description is used as-is. If left # blank, the following values are used ("$name" is automatically replaced with the # name of the entity): "The $name class" "The $name widget" "The $name file" # "is" "provides" "specifies" "contains" "represents" "a" "an" "the" ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited # members of a class in the documentation of that class as if those members were # ordinary class members. Constructors, destructors and assignment operators of # the base classes will not be shown. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = YES # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the # path to strip. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells # the reader which header file to include in order to use a class. # If left blank only the name of the header file containing the class # definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like the Qt-style comments (thus requiring an # explicit @brief command for a brief description. JAVADOC_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. # The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO # If the DETAILS_AT_TOP tag is set to YES then Doxygen # will output the detailed description near the top, like JavaDoc. # If set to NO, the detailed description appears after the member # documentation. DETAILS_AT_TOP = NO # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 8 # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". # For example adding "sideeffect=\par Side Effects:\n" will allow you to # put the command \sideeffect (or @sideeffect) in the documentation, which # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. ALIASES = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources # only. Doxygen will then generate output that is more tailored for Java. # For instance, namespaces will be presented as packages, qualified scopes # will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to # NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in # the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # will sort the (detailed) documentation of file and class members # alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically # by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, # not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES # If the sources in your project are distributed over multiple directories # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. SHOW_DIRECTORIES = YES #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text # tags, which will be replaced by the file and line number from which the # warning originated and the warning text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be used to specify the files and/or directories that contain # documented source files. You may enter file names like "myfile.cpp" or # directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm FILE_PATTERNS = # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories # that are symbolic links (a Unix filesystem feature) are excluded from the input. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. EXCLUDE_PATTERNS = # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command , where # is the value of the INPUT_FILTER tag, and is the name of an # input file. Doxygen will then use the output that the filter program writes # to standard output. If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES (the default) # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES # If the REFERENCES_RELATION tag is set to YES (the default) # then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = YES # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = NO # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all # classes will be put under the same header in the alphabetical index. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a # standard header. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to # fine-tune the look of the HTML output. If the tag is left blank doxygen # will generate a default style sheet. Note that doxygen will try to copy # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. HTML_ALIGN_MEMBERS = YES # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be # written to the html output directory. CHM_FILE = # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # be used to specify the location (absolute path including file name) of # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. HHC_LOCATION = # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO # This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be # generated containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are # probably better off using the HTML help feature. GENERATE_TREEVIEW = NO # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO # The PAPER_TYPE tag can be used to set the paper type that is used # by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until # the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! LATEX_HEADER = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # is prepared for conversion to pdf (using ps2pdf). The pdf file will # contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = NO # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = NO # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # command to the generated LaTeX files. This will instruct LaTeX to keep # running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO # If LATEX_HIDE_INDICES is set to YES then doxygen will not # include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output # The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf # If the COMPACT_RTF tag is set to YES Doxygen generates more compact # RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # will contain hyperlink fields. The RTF file will # contain links (just like the HTML output) instead of page references. # This makes the output suitable for online browsing using WORD or other # programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's # config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO # The MAN_OUTPUT tag is used to specify where the man pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, # then it will generate one additional man file for each entity # documented in the real man page(s). These additional files # only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- # If the GENERATE_XML tag is set to YES Doxygen will # generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml # The XML_SCHEMA tag can be used to specify an XML schema, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_SCHEMA = # The XML_DTD tag can be used to specify an XML DTD, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_DTD = # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will # generate an AutoGen Definitions (see autogen.sf.net) file # that captures the structure of the code including all # documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- # If the GENERATE_PERLMOD tag is set to YES Doxygen will # generate a Perl module file that captures the structure of # the code including all documentation. Note that this # feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO # If the PERLMOD_LATEX tag is set to YES Doxygen will generate # the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # nicely formatted so it can be parsed by a human reader. This is useful # if you want to understand what is going on. On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES # The names of the make variables in the generated doxyrules.make file # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = NO # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_PREDEFINED tags. EXPAND_ONLY_PREDEF = NO # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by # the preprocessor. INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. INCLUDE_FILE_PATTERNS = # The PREDEFINED tag can be used to specify one or more macro names that # are defined before the preprocessor is started (similar to the -D option of # gcc). The argument of the tag is a list of macros of the form: name # or name=definition (no spaces). If the definition and the = are # omitted =1 is assumed. To prevent a macro definition from being # undefined via #undef or recursively expanded use the := operator # instead of the = operator. PREDEFINED = # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all function-like macros that are alone # on a line, have an all uppercase name, and do not end with a semicolon. Such # function macros are typically used for boiler-plate code, and will confuse the # parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: # TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed # in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or # super classes. Setting the tag to NO turns the diagrams off. Note that this # option is superseded by the HAVE_DOT option below. This is only a fallback. It is # recommended to install and use dot, since it yields more powerful graphs. CLASS_DIAGRAMS = YES # If set to YES, the inheritance and collaboration graphs will hide # inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = NO # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented # file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # HAVE_DOT tags are set to YES then doxygen will generate a graph for each # documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will # generate a call dependency graph for every global function or class method. # Note that enabling this option will significantly increase the time of a run. # So in most cases it will be better to enable call graphs for selected # functions only using the \callgraph command. CALL_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found on the path. DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the # \dotfile command). DOTFILE_DIRS = # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width # (in pixels) of the graphs generated by dot. If a graph becomes larger than # this value, doxygen will try to truncate the graph, so that it fits within # the specified constraint. Beware that most browsers cannot cope with very # large images. MAX_DOT_GRAPH_WIDTH = 1024 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height # (in pixels) of the graphs generated by dot. If a graph becomes larger than # this value, doxygen will try to truncate the graph, so that it fits within # the specified constraint. Beware that most browsers cannot cope with very # large images. MAX_DOT_GRAPH_HEIGHT = 1024 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable # from the root by following a path via at most 3 edges will be shown. Nodes that # lay further from the root node will be omitted. Note that setting this option to # 1 or 2 may greatly reduce the computation time needed for large code bases. Also # note that a graph may be further truncated if the graph's image dimensions are # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). # If 0 is used for the depth value (the default), the graph is not depth-constrained. MAX_DOT_GRAPH_DEPTH = 0 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES #--------------------------------------------------------------------------- # Configuration::additions related to the search engine #--------------------------------------------------------------------------- # The SEARCHENGINE tag specifies whether or not a search engine should be # used. If set to NO the values of all tags below this one will be ignored. SEARCHENGINE = NO ll-scope-0.2.1/AUTHORS0000644000076500007650000000005310247036375012117 0ustar llllLars Luthman ll-scope-0.2.1/pixmaps/0000755000076500007650000000000010247036375012532 5ustar llllll-scope-0.2.1/pixmaps/icon.png0000644000076500007650000000575510247036375014204 0ustar llllPNG  IHDR[[6sBIT|dtEXtSoftwarewww.inkscape.org< IDATx[pgwe[n[|i8qH!Cgŭ@!C0n(/tp)80<4t/8CgϔN ƥp ) 6eYY-Y,iOCKٳ+_dw=RCn$\uъMR>wFG---*켉RZMMN !@R;;;kH)Y&F!@[[],v]2 (CCCC..QSS2tߒ}x? 8|cBk tÇ?c ! e-[QJݻW.t]ȑ# Dr[툢E{ې@<#Bې!IXnC s 2B0"xō$I0 0!}%>4~ I$0<bgN͆JBEMҗagddҲ%#ttԩShllDEEfk"v0ĉ't:hnE055cǎ ;wdRݦj@W!N. vB]]TCCCZe===R؁@H(F n[ެ/Gerrpt5xrr=8 ⳦=b'zt"X4bB9^J8Bz\bçbd#<:dŵB^B4]ԏ W k#ھ cN_yM̊?UI5 av[/y2"'>i6$V_hv{I>ֆkM<>EuykPvW-vdS;u}քU*}L]G*&oĭ#jX5 }w9Ϩ6»[ʬ-f+"g ^0 ;6n[hU|~ˡHiܳd&m*A'ÿ'ҠDoQY1ȟݍ=8x,O/ˀ9}v|[ 40w3L`11p=uTwR0[I[V1vL)v@h0v/c"8 Ix͉N?sy5uXQ٘|7ZJ I>n QĖRfB8z(27Axc~窧YxJ^S:T<ئ%tD61?5 c>ѝQ_vf̾vu!~R:t2G2ų)(3z3|f ~/8jv&nvc٫iV%ybIKڋ#({!uNze x:jBq.M*%_j2 vћ:S)̈xj HT/c 땧$#3;N3%HUrNl61\Nl)K)v^T/`q` ([x ]+LYj֖~IRm+j:+K/}u^{߷4juX Ml尾cS~-~9|]At4SYӥZ>_םυ%V9g~;&A jxJlI * Sw?-@kd.OA13SΘ F$7ڌ qJ}EW!lE`3p?Տ@iBq=([AsQFMs?nasXEksq,p:`3k7= gǣ[!(S`?e>&տiBy̳hE-F$d*;99'ꜳT>tR?3A~>DC0g7./e =cDߗLq0ooig@^٘H͔82[kR0j֞VmҒytP,Ѹ$!B"~<:p-IK#F$S@-RWM$IK#(Z~rLgۡz`k?gv7q$}8fU*%͖B*LP+?0ɀ-6_ s`pm_=466frҤϘP y%o.Lz6Qs hllmjESS?͙S-#Upfk+L!MMMZD:::T);Vsw;V~PVVu{γbɄUŘfwVݍ\٩Ġ(;_JLhA`6a6/[u(mZR-Hr$ @rt @)so%hO삾s{оe1_vB^mkk[S8w~`=cuY"~1]]]b(0R^OR>wFG---*A 4rIENDB`ll-scope-0.2.1/pixmaps/icon.svg0000644000076500007650000000711010247036375014202 0ustar llll image/svg+xml