diff --git a/code/online_plugins/Generic/run_writedataset.m b/code/online_plugins/Generic/run_writedataset.m old mode 100644 new mode 100755 index 5bcf1dde..59d8bcaa --- a/code/online_plugins/Generic/run_writedataset.m +++ b/code/online_plugins/Generic/run_writedataset.m @@ -41,7 +41,7 @@ function run_writedataset(varargin) stream.xmax = stream.xmin + (stream.pnts-1)/stream.srate; [fp fn fe] = fileparts(out_filename); % remove superfluous fields -eeg = rmfield(stream,{'buffer','smax','buffer_len','timestamps','timestamps_len','timestamps_ptr','streamid'}); +eeg = rmfield(stream,{'buffer','smax','buffer_len','timestamps','timestamps_len','tmax','streamid'}); stream.timestamp_at_beginning = toc(uint64(0)); eeg = pop_saveset(eeg,'filename',[fn fe],'filepath',fastif(isempty(fp),env_translatepath('bcilab:/userdata'),fp),'savemode','twofiles'); % re-create the fdt file... @@ -49,16 +49,26 @@ function run_writedataset(varargin) fid = fopen(fullfile(eeg.filepath, eeg.datfile),'wb','ieee-le'); if fid == -1 error('Cannot write output file, check permission and space.'); end; + +% create a temporary text file to store stream event markers +event_filename = env_translatepath(['bcilab:/userdata/', fn, '_events.txt']); +marker_fid = fopen(event_filename, 'w+'); +if marker_fid == -1 + error('Cannot write marker output file, check permission and space.'); +end +% write a basic header to the event marker file +fprintf(marker_fid, '%s\t%s\n', 'type', 'latency'); + % create timer (which periodically writes to the stream) t = timer('ExecutionMode','fixedRate', 'Name',[in_stream '_write_timer'], 'Period',1/update_freq, ... - 'StartDelay',start_delay, 'TimerFcn',@(obj,varargin) append_data(in_stream,fid,stream.streamid,obj,eeg)); + 'StartDelay',start_delay, 'TimerFcn',@(obj,varargin) append_data(in_stream,fid,marker_fid,stream.streamid,obj,eeg)); % start timer start(t); % timer callback: visualization -function append_data(stream,fid,streamid,timerhandle,eeg) +function append_data(stream,fid,marker_fid,streamid,timerhandle,eeg) try % check if the stream and the predictor are still there s = evalin('base',stream); @@ -68,20 +78,42 @@ function append_data(stream,fid,streamid,timerhandle,eeg) % get an updated chunk of data samples_to_get = min(s.buffer_len, s.smax-ftell(fid)/(4*s.nbchan)); chunk = s.buffer(:, 1+mod(s.smax-samples_to_get:s.smax-1,s.buffer_len)); - + % and write it into the file - fwrite(fid,chunk,'float'); + fwrite(fid,chunk,'float'); + + % check if this data chunk contains any event markers + marker_chunk = s.marker_pos(:, 1+mod(s.smax-samples_to_get:s.smax-1,s.buffer_len)); + + % if so, write them into the marker file + if nnz(marker_chunk) > 0 + % find the sample(s) in this chunk with events + [marker_pos_in_sample, marker_pos_in_chunk] = find(marker_chunk); + + % EEG samples which correspond to positions in the chunk + chunk_samples = s.smax - (samples_to_get - 1) : s.smax; + + for m = 1:length(marker_pos_in_chunk) + marker_idx = marker_chunk(marker_pos_in_sample(m), marker_pos_in_chunk(m)); + marker_type = s.marker_buffer(marker_idx).type; + marker_sample_whole = chunk_samples(marker_pos_in_chunk(m)); + marker_sample_fractional = s.marker_buffer(marker_idx).latency; + marker_sample = marker_sample_whole + marker_sample_fractional; + fprintf(marker_fid, '%s\t%i\n', marker_type, marker_sample); + end + end + catch e if ~strcmp(e.identifier,'MATLAB:UndefinedFunction') env_handleerror(e); end - finalize_dataset(fid,eeg); + finalize_dataset(fid,marker_fid,eeg); % interrupted: make sure that the file gets closed stop(timerhandle); delete(timerhandle); end -function finalize_dataset(fid,EEG) +function finalize_dataset(fid,marker_fid,EEG) samples = ftell(fid)/(4*EEG.nbchan); fclose(fid); EEG.pnts = samples; @@ -89,4 +121,18 @@ function finalize_dataset(fid,EEG) EEG.xmax = EEG.xmin + (EEG.pnts-1)/EEG.srate; EEG.timestamp_at_end = toc(uint64(0)); +% load the event marker file from disk and include the markers in the EEG .set +marker_file = [EEG.filepath, filesep, regexprep(EEG.filename, '.set', '_events.txt')]; +frewind(marker_fid); +marker_data = textscan(marker_fid, '%s%d', 'Delimiter', '\t', 'HeaderLines', 1); +if ~isempty(marker_data{1}) + EEG.event = struct('type', marker_data{1}', 'latency', num2cell(marker_data{2}'), ... + 'urevent', num2cell((1:length(marker_data{1})))); +end +fclose(marker_fid); +delete(marker_file); + save(fullfile(EEG.filepath, EEG.filename), '-v6', '-mat', 'EEG'); + + + diff --git a/code/online_plugins/Neuroscan/BCILAB.readme b/code/online_plugins/Neuroscan/BCILAB.readme new file mode 100755 index 00000000..17517ffd --- /dev/null +++ b/code/online_plugins/Neuroscan/BCILAB.readme @@ -0,0 +1,18 @@ +README for Neuroscan Scan Plugin for BCILAB +Author: Visual Attention Lab, Dan Roberts, and Nick Peñaranda, George Mason University, Spring 2014 + Released under the GPLv3, see COPYING.txt + Based on the BrainVision BCILAB plug-in by Hal Greenwald + + +Plugin to stream EEG data and event markers from Neuroscan Scan software to BCILAB. Has been tested with Scan 4.3 and a NuAmps 40-channel amplifier + +Associated Files: + +BCILAB/code/online_plugins/Neuroscan: +ns_close.m +ns_open.m +ns_parseheader.m +ns_parseinfo.m +ns_read.m +ns_sendpacket.m +run_readneuroscan.m \ No newline at end of file diff --git a/code/online_plugins/Neuroscan/COPYING.txt b/code/online_plugins/Neuroscan/COPYING.txt new file mode 100755 index 00000000..94a9ed02 --- /dev/null +++ b/code/online_plugins/Neuroscan/COPYING.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. 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 +them 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 prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. 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. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + 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 +state 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 3 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, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program 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, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU 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 Lesser General +Public License instead of this License. But first, please read +. diff --git a/code/online_plugins/Neuroscan/ns_close.m b/code/online_plugins/Neuroscan/ns_close.m new file mode 100755 index 00000000..ee3a100a --- /dev/null +++ b/code/online_plugins/Neuroscan/ns_close.m @@ -0,0 +1,26 @@ +function ns_close(h) +% Close a TCP connection to Neuroscan Scan +% ns_close(h) +% +% +% In: +% h : handle to an existing Neuroscan connection +% +% Author: Visual Attention and Cognition Lab, Dan Roberts, and Nick Peñaranda, George Mason University, Spring 2014 +% Released under the GPLv3, see COPYING.txt +% Based on the BrainVision BCILAB plug-in by Hal Greenwald + + +% send message to Scan to stop sending data +ns_sendpacket(TCP_Connection,'CTRL',3,4,0); +% and indicate that connection is closing +ns_sendpacket(TCP_Connection,'CTRL',1,2,0); + +if ~h.initialized + return; +end +disp('Cleaning up connection to Neuroscan Scan'); +pnet(h.handle, 'close'); +if evalin('base', ['exist(' 'sprintf(''%s'', h.name)' ')']) + evalin('base',['clear ' sprintf('%s',h.name) ';']); +end \ No newline at end of file diff --git a/code/online_plugins/Neuroscan/ns_open.m b/code/online_plugins/Neuroscan/ns_open.m new file mode 100755 index 00000000..796650f0 --- /dev/null +++ b/code/online_plugins/Neuroscan/ns_open.m @@ -0,0 +1,87 @@ +function h = ns_open(hostname, port) +% Open a TCP connection to Neuroscan Recorder +% h = ns_open(Hostname, Port) +% +% +% In: +% Hostname: Source TCP hostname. Can be a computer name, URL, or IP +% address +% +% Port : the port on which to connect to the TCP host +% +% Out: +% h : handle to a newly opened Neuroscan connection +% +% Author: Visual Attention and Cognition Lab, Dan Roberts, and Nick Peñaranda, George Mason University, Spring 2014 +% Released under the GPLv3, see COPYING.txt +% Based on the BrainVision BCILAB plug-in by Hal Greenwald + + +% open the connection +h.handle = pnet('tcpconnect', hostname, port); +ConnectionStatus = pnet(h.handle,'status'); + +if ConnectionStatus > 0 + disp('Neuroscan Scan connection established'); +else + error('Neuroscan Scan connection failed - check the IP and port'); +end + +% flush the buffer +bufferData = pnet(h.handle,'read', 'noblock'); +while ~isempty(bufferData); + bufferData = pnet(h.handle,'read', 'noblock'); +end + +% request basic header +ns_sendpacket(h.handle,'CTRL',3,5,0); + +% try + % read reader and basic info + packetBytes = pnet(h.handle,'read', 40, 'uint8'); + + % parse header data + header = ns_parseheader(packetBytes(1:12)); + basicinfo = ns_parseinfo(packetBytes(13:end)); + + % attach Neuroscan parameters to connection handle + infoFields = fields(basicinfo); + for f = 1:length(infoFields) + h.(infoFields{f}) = basicinfo.(infoFields{f}); + end + + h.totalChan = h.numChan + h.numEventChan; + + h.markerChanIdx = 41; + + % number of bytes for neuroscan header + h.headerSize = 12; + + % save the block size, equal to the number of channels (including + % marker channel) x the number of samples per block x the number of + % bytes per sample + h.dataBlockSize = (basicinfo.numChan + basicinfo.numEventChan) ... + * basicinfo.samplesPerBlock * basicinfo.bytesPerSample; + + % save the data type (16 or 32 bit integer) for later casting + if h.bytesPerSample == 2 + h.datatype = 'int16'; + elseif h.bytesPerSample == 4 + h.datatype = 'int32'; + else + error('expecting either 2 or 4 bytes per sample'); + end + + h.cleanup = onCleanup(@()pnet(h.handle, 'close')); + + % instruct Scan to begin sending data + ns_sendpacket(h.handle,'CTRL',3,3,0); + h.initialized = true; + +% catch er +% disp(er.message); +% return; +% end + +end + diff --git a/code/online_plugins/Neuroscan/ns_parseheader.m b/code/online_plugins/Neuroscan/ns_parseheader.m new file mode 100755 index 00000000..944f1356 --- /dev/null +++ b/code/online_plugins/Neuroscan/ns_parseheader.m @@ -0,0 +1,36 @@ +function hdr = ns_parseheader(header) +% Parse the header info packet returned by Neuroscan Scan server +% hdr = ns_parseinfo(dataBytes) +% +% +% In: +% dataBytes : 12 byte array returned by Neuroscan server as header +% +% Out: +% hdr: Structure containing each element of packet header as a field. +% Header information includes: +% +% id: ID string, 'CTRL', 'FILE', or 'DATA' +% +% code: Control code, 1 (General), 2 (Server), or 3 (Client) +% +% req: Request value, see the Neuroscan Acquire manual +% +% bodysize: Size (in bytes) of message attached to header, +% or 0 if packet does not contain a data body (for example start +% or stop acquisition messages) +% +% +% Author: Visual Attention and Cognition Lab, Dan Roberts, and Nick Peñaranda, George Mason University, Spring 2014 +% Released under the GPLv3, see COPYING.txt +% Based on the BrainVision BCILAB plug-in by Hal Greenwald + + +hdr = struct('id',[],'code',[],'req',[],'bodysize',[]); + +hdr.id = char(header(1:4)); +hdr.code = double(typecast(fliplr(uint8(header(5:6))), 'uint16')); +hdr.req = double(typecast(fliplr(uint8(header(7:8))), 'uint16')); +hdr.bodysize = double(typecast(fliplr(uint8(header(9:12))), 'uint32')); + + \ No newline at end of file diff --git a/code/online_plugins/Neuroscan/ns_parseinfo.m b/code/online_plugins/Neuroscan/ns_parseinfo.m new file mode 100755 index 00000000..17b132fc --- /dev/null +++ b/code/online_plugins/Neuroscan/ns_parseinfo.m @@ -0,0 +1,47 @@ +function basicinfo = ns_parseinfo(dataBytes) +% Parse the basic info packet returned by Neuroscan Scan +% basicinfo = ns_parseinfo(dataBytes) +% +% +% In: +% dataBytes : 28 byte array returned by Neuroscan server after requesting +% basic info +% +% Out: +% basicinfo: Structure containing each element of basic EEG info as a +% field. EEG info includes: +% +% size: size of info array (in bytes) +% +% numChan: number of EEG data channels +% +% numEventChan: number of event marker channels +% +% samplesPerBlock: the number of data samples transmitted each block +% +% srate: data sampling rate in Hz +% +% bytesPerSamples: number of bytes per sample, either 2 (16 bits +% per sample) or 4 (32 bits per sample) +% +% resolution: the value in microvolts represented by the least +% significant bit +% +% +% Author: Visual Attention and Cognition Lab, Dan Roberts, and Nick Peñaranda, George Mason University, Spring 2014 +% Released under the GPLv3, see COPYING.txt +% Based on the BrainVision BCILAB plug-in by Hal Greenwald + +% basic EEG info +basicinfo = struct('size',[],'numChan',[],'numEventChan',[],'samplesPerBlock',[],... + 'srate', [], 'bytesPerSample', [], 'resolution', []); + +basicinfo.size = double(typecast((uint8(dataBytes(1:4))), 'int32')); +basicinfo.numChan = double(typecast((uint8(dataBytes(5:8))), 'int32')); +basicinfo.numEventChan = double(typecast((uint8(dataBytes(9:12))), 'int32')); +basicinfo.samplesPerBlock = double(typecast((uint8(dataBytes(13:16))), 'int32')); +basicinfo.srate = double(typecast((uint8(dataBytes(17:20))), 'int32')); +basicinfo.bytesPerSample = double(typecast((uint8(dataBytes(21:24))), 'int32')); +basicinfo.resolution = double(typecast((uint8(dataBytes(25:28))), 'single')); + +end diff --git a/code/online_plugins/Neuroscan/ns_read.m b/code/online_plugins/Neuroscan/ns_read.m new file mode 100755 index 00000000..2c0b7907 --- /dev/null +++ b/code/online_plugins/Neuroscan/ns_read.m @@ -0,0 +1,84 @@ +function block = ns_read(h) +% Block reader for Neuroscan Scan Recorder +% ns_read(h) +% +% +% In: +% h : handle to an existing Neuroscan connection +% +% Out: +% block: cell array data block containing EEG and event values +% +% Author: Visual Attention and Cognition Lab, Dan Roberts, and Nick Peñaranda, George Mason University, Spring 2014 +% Released under the GPLv3, see COPYING.txt +% Based on the BrainVision BCILAB plug-in by Hal Greenwald + +data = []; +if (~h.initialized) + return; +end + +try + % check for existing data in socket buffer + headerBytes = pnet(h.handle, 'read', h.headerSize, 'uint8', 'noblock'); + + events = []; + + if ~isempty(headerBytes) + + headerData = ns_parseheader(headerBytes); + + if strcmp(headerData.id, 'DATA') + + % wait until the data packet body is available + dataPreview = []; + while length(dataPreview) < headerData.bodysize + % wait until the rest of the packet is available + dataPreview = pnet(h.handle, 'read', headerData.bodysize,... + 'uint8', 'view', 'noblock'); + end + + % read the data packet body + dataBytes = pnet(h.handle, 'read', headerData.bodysize, 'uint8', 'noblock'); + + dataBytes = reshape(uint8(dataBytes), [h.bytesPerSample, h.totalChan, h.samplesPerBlock]); + + markerValues = squeeze((dataBytes(1,h.markerChanIdx, :))); + markerPoints = find(markerValues); + + if ~isempty(markerPoints) + markers = markerValues(markerPoints); + latencies = markerPoints; + for m = 1:length(markers) + events(m).type = num2str(markers(m)); %#ok + events(m).latency = latencies(m); %#ok + end + else + events = []; + end + + dataBytes(:,h.markerChanIdx, :) = []; + + dataCell = squeeze(num2cell(dataBytes, 1)); + dataBlock = cellfun(@(x) typecast(x, h.datatype), dataCell); + data = horzcat(data, dataBlock); + + else + disp('unknown message'); + end + + end + + +catch er + disp(er.message); + rethrow(er); +end + +if ~isempty(data) + % scale data to uV units + data = bsxfun(@times,data,h.resolution); +end + +block = {data,events}; + diff --git a/code/online_plugins/Neuroscan/ns_sendpacket.m b/code/online_plugins/Neuroscan/ns_sendpacket.m new file mode 100755 index 00000000..d8a19a2e --- /dev/null +++ b/code/online_plugins/Neuroscan/ns_sendpacket.m @@ -0,0 +1,35 @@ +function ns_sendpacket(h,id,code,request,bodysize) +% Prepare and send a data packet to Neuroscan Scan server +% ns_sendpacket(h,id,code,request,bodysize) +% +% +% In: +% h: PNET connection handle +% +% id: Neuroscan message ID string +% +% code: Neuroscan message code value +% +% request: Neuroscan message request value +% +% bodysize: Size of message body +% +% Note: See the Neuroscan Scan documentation for description of message ID, +% code, and request values +% +% Author: Visual Attention and Cognition Lab, Dan Roberts, and Nick Peñaranda, George Mason University, Spring 2014 +% Released under the GPLv3, see COPYING.txt +% Based on the BrainVision BCILAB plug-in by Hal Greenwald + + +% assemble the packet +packet = zeros(12,1,'uint8'); +packet(1:4) = id; +packet(5:6) = fliplr(typecast(int16(code),'int8')); +packet(7:8) = fliplr(typecast(int16(request),'int8')); +packet(9:12) = fliplr(typecast(int32(bodysize),'int8')); +% write the packet +pnet(h,'write', packet) + +end + \ No newline at end of file diff --git a/code/online_plugins/Neuroscan/run_readneuroscan.m b/code/online_plugins/Neuroscan/run_readneuroscan.m new file mode 100755 index 00000000..9dd7cbe9 --- /dev/null +++ b/code/online_plugins/Neuroscan/run_readneuroscan.m @@ -0,0 +1,73 @@ +function run_readneuroscan(varargin) +% Receive real-time data from Neuroscan Scan Recorder +% run_readneuroscan(MatlabStream,InputHost,Port) +% +% +% In: +% MatlabStream : name of the stream to create in the MATLAB environment (default: 'laststream') +% +% InputHost: Source TCP hostname. Can be a computer name, URL, or IP +% address (default: '127.0.0.1') +% +% Port : the port on which to connect to the TCP host (default: 4000) +% +% UpdateFrequency : update frequency, in Hz (default: 25) +% +% Examples: +% % open an input stream that named 'newstream' on port 5000, using all +% % other defaults +% run_readneuroscan('MatlabStream', 'newstream', 'Port', 5000); +% +% Author: Visual Attention and Cognition Lab, Dan Roberts, and Nick Peñaranda, George Mason University, Spring 2014 +% Released under the GPLv3, see COPYING.txt +% Based on the BrainVision BCILAB plug-in by Hal Greenwald + +% declare the name of this component (shown in the menu) +declare_properties('name','Neuroscan Recorder'); + +% read options +opts = arg_define(varargin, ... + arg({'new_stream','MatlabStream'}, 'laststream',[],'New Stream to create. This is the name of the stream within the MATLAB environment.'), ... + arg({'src_hostname','InputHost'}, '127.0.0.1',[],'Source TCP hostname. Can be a computer name, URL, or IP address.'), ... + arg({'src_port','Port'}, 4000,[],'TCP Host Port.'), ... + arg({'update_freq','UpdateFrequency'}, 25,[],'Update frequency (Hz). New data is polled at this rate, in Hz.'),... + arg({'chan_labels', 'ChannelLabels'}, 'standard', [], 'Enter custom channel labels if applicable')... + ); + +% open a connection +h = ns_open(opts.src_hostname, opts.src_port); + +if strcmpi(opts.chan_labels, 'standard') + if h.numChan == 40 % assume standard NuAmps 40-channel montage + h.channelNames = {'HEOL', 'HEOR', 'FP1', 'FP2', 'VEOU', 'VEOL', 'F7', 'F3', 'FZ',... + 'F4', 'F8', 'FT7', 'FC3', 'FCZ', 'FC4', 'FT8', 'T3', 'C3', 'CZ', 'C4', 'T4', ... + 'TP7', 'CP3', 'CPZ', 'CP4', 'TP8', 'A1', 'T5', 'P3', 'PZ', 'P4', 'T6', ... + 'A2', 'O1', 'OZ', 'O2', 'FT9', 'FT10', 'PO1', 'PO2'}; + elseif h.numChan == 68 % assume standard SynAmps2 montage, + % which includes 64 EEG channels + VEOG, HEOG, EKG, EMG + h.channelNames = {'FP1','FPZ','FP2','AF3','AF4','F7','F5','F3',... + 'F1','FZ','F2','F4','F6','F8','FT7','FC5','FC3','FC1','FCZ',... + 'FC2','FC4','FC6','FT8','T7','C5','C3','C1','CZ','C2','C4',... + 'C6','T8','M1','TP7','CP5','CP3','CP1','CPZ','CP2','CP4',... + 'CP6','TP8','M2','P7','P5','P3','P1','PZ','P2','P4','P6',... + 'P8','PO7','PO5','PO3','POZ','PO4','PO6','PO8','CB1','O1',... + 'OZ','O2','CB2','VEO','HEO','EKG','EMG'}; + else + error('unknown default channel labels for this montage'); + end +else % custom channel labels + opts.chan_labels = evalin('base', opts.chan_labels); + if length(opts.chan_labels) ~= h.numChan + errorMsg = sprintf('the number of custom channel labels provided (%i) does not match the number of channels in the data stream (%i)', length(opts.chan_labels), h.numChan); + ns_close(h); + error(errorMsg); %#ok + end +end + +h.name = opts.new_stream; + +%Create and initialize online stream +onl_newstream(opts.new_stream, 'srate', h.srate, 'chanlocs', h.channelNames, 'data', zeros(length(h.channelNames),0,0),'xmin',toc(uint64(0))); + +% start background acquisition +onl_read_background(opts.new_stream,@()ns_read(h), opts.update_freq); \ No newline at end of file diff --git a/dependencies/tcp_udp_ip/pnet.c b/dependencies/tcp_udp_ip/pnet.c old mode 100644 new mode 100755 index 21b10c9c..d7987e25 --- a/dependencies/tcp_udp_ip/pnet.c +++ b/dependencies/tcp_udp_ip/pnet.c @@ -2,10 +2,10 @@ MEX file for the tcpip toolbox. */ -#define VERSION "Version 2.0.5 2003-09-16" +#define VERSION "Version 2.0.5 + PTBMods by Mario Kleiner - 2012-09-10" /* -% This file(s) is part of the tcp_udp_ip toolbox (C) Peter Rydes�ter et al. +% This file(s) is part of the tcp_udp_ip toolbox (C) Peter Rydesater et al. % et al. 1998-2003 for running in MATLAB(R) as scripts and/or plug-ins. % % This program is free software; you can redistribute it and/or modify @@ -22,7 +22,7 @@ % along with this program; if not, write to the Free Software % Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA % -% In addition, as a SPECIAL EXCEPTION, Peter Rydes�ter, SWEDEN, +% In addition, as a SPECIAL EXCEPTION, Peter Rydesater, SWEDEN, % gives permission to link the code of this program with any library, % and distribute linked combinations of it. You must obey the GNU % General Public License in all respects for all of the code in the @@ -37,21 +37,25 @@ Notes for Unix implementation Compile this with: - mex -O pnet.c + mex -g -v -largeArrayDims pnet.c + On Linux + gcc 4.6+ + Matlab use: + + mex -O -g -v CFLAGS='$CFLAGS -fPIC -fexceptions' -largeArrayDims pnet.c + Notes for Windows implementation When using LCC, compile this with: mex -O pnet.c {MATLAB_INSTALL_DIR}\sys\lcc\lib\wsock32.lib -DWIN32 When using Visual C++, compile this with: - mex -O pnet.c ws2_32.lib -DWIN32 + mex -O pnet.c ws2_32.lib winmm.lib -DWIN32 -largeArrayDims == Main Authour == == Windows support == == Earlie/Basic UDP support == - Peter Rydes�ter Mario Bergeron Mike Medeiros at 23-Jan-2001. + Peter Rydesater Mario Bergeron Mike Medeiros at 23-Jan-2001. LYRtech - �stersund, Sweden Qu�bec, Canada + Ostersund, Sweden Quebec, Canada +46 70 560 68 16 Peter.Rydesater@mh.se Mario.Bergeron@lyrtech.com @@ -68,8 +72,7 @@ #include /******* WINDOWS ONLY DEFINES *********/ -#ifdef _WIN32 -#pragma comment(lib, "wsock32.lib") +#ifdef WIN32 #define IFWINDOWS(dothis) dothis #define IFUNIX(dothis) //#include @@ -80,15 +83,15 @@ #define EWOULDBLOCK WSAEWOULDBLOCK #define usleep(a) Sleep((a)/1000) #define MSG_NOSIGNAL 0 +#define DEFAULT_USLEEP 1000 /* MK: Changed from 10 msecs to 1 msec == 1000 microsecs. for lower latency. Can't go lower than 1 msec on Windoze. :-( */ /******* NON WINDOWS DEFINES *********/ #else - #define IFWINDOWS(dothis) #define IFUNIX(dothis) dothis #include -#define s_errno errno +#define s_errno errno // ?? Is this OK ?? #include #include #include @@ -96,14 +99,18 @@ #include #include #include +#include +#include + #define nonblockingsocket(s) fcntl(s,F_SETFL,O_NONBLOCK) +#define DEFAULT_USLEEP 500 /* MK: Changed from 10 msecs to 0.5 msec == 500 microsecs. for lower latency. Should not be a problem on good OS/X and Linux :-) */ #endif #ifndef INADDR_NONE #define INADDR_NONE (-1) #endif -/* Do this hack cause SIGPIPE that kills matlab on any platform??? */ +// Do this hack cause SIGPIPE that kills matlab on any platform??? #ifndef MSG_NOSIGNAL #define MSG_NOSIGNAL 0 #endif @@ -113,7 +120,7 @@ /********** DEFINES related to pnet own functionality *****************/ /* Set debuging on/off */ -#define debug_view_con_status(X) /* __debug_view_con_status(X) */ +#define debug_view_con_status(X) // __debug_view_con_status(X) #define MAX_CON 100 /* Maximum number of simultanius tcpip connections.*/ #define NAMEBUFF_LEN 100 @@ -128,16 +135,15 @@ #define DEFAULT_WRITETIMEOUT double_inf #define DEFAULT_READTIMEOUT double_inf #define DEFAULT_INPUT_SIZE 50000 -#define DEFAULT_USLEEP 10000 /* Different status of a con_info struct handles a file descriptor */ #define STATUS_FREE -1 -#define STATUS_NOCONNECT 0 /* Disconnected pipe that is note closed */ +#define STATUS_NOCONNECT 0 // Disconnected pipe that is note closed #define STATUS_TCP_SOCKET 1 -#define STATUS_IO_OK 5 /* Used for IS_... test */ +#define STATUS_IO_OK 5 // Used for IS_... test #define STATUS_UDP_CLIENT 6 #define STATUS_UDP_SERVER 8 -#define STATUS_CONNECT 10 /* Used for IS_... test */ +#define STATUS_CONNECT 10 // Used for IS_... test #define STATUS_TCP_CLIENT 11 #define STATUS_TCP_SERVER 12 #define STATUS_UDP_CLIENT_CONNECT 18 @@ -169,7 +175,7 @@ typedef struct } con_info; -/**********************************************************************/ +///////////////////////////////////////////////////////////////////////////////////////////////// /* Some global variables */ int gret_args=0; /* Global variable that holds number of matlab return argumens returned */ int gnlhs; /* number of expected outputs */ @@ -188,7 +194,7 @@ void Print_Start_Message(){ "Loaded pnet MEX-file for the tcp/udp/ip-toolbox Compiled @ " __DATE__ " " __TIME__ "\n" VERSION "\n" - "Copyright (C) Peter Rydes�ter, Sweden, et al. , 1998 - 2003\n" + "Copyright (C) Peter Rydesater, Sweden, et al. , 1998 - 2003\n" "GNU General Public License, se license.txt for full license notis.\n" "You are allowed to (dynamicaly) link this file with non-free code. \n\n" " http://www.rydesater.com \n\n" @@ -224,7 +230,7 @@ void *myrealloc(char *ptr,int newsize) /* A "wrapper" function for memory allocation. Most for debuging /tracing purpose */ void newbuffsize(io_buff *buff,int newsize) { - /* fprintf(stderr,"NEWSIZE:%d\n",newsize); */ + // fprintf(stderr,"NEWSIZE:%d\n",newsize); if(newsize==-1){ free(buff->ptr); buff->ptr=NULL; @@ -234,12 +240,12 @@ void newbuffsize(io_buff *buff,int newsize) newsize=buff->pos; if(newsize<256) newsize=256; - if(newsize>buff->len){ /* Grow.... */ - /* fprintf(stderr,"NEWSIZE UP %d -> %d\n",buff->len,newsize*2); */ + if(newsize>buff->len){ // Grow.... + // fprintf(stderr,"NEWSIZE UP %d -> %d\n",buff->len,newsize*2); buff->ptr=myrealloc(buff->ptr,newsize*2); buff->len=newsize*2; - }else if(newsize*4 < buff->len){ /* Decrease... */ - /* fprintf(stderr,"NEWSIZE DOWN %d -> %d\n",buff->len,newsize*2); */ + }else if(newsize*4 < buff->len){ // Decrease... + // fprintf(stderr,"NEWSIZE DOWN %d -> %d\n",buff->len,newsize*2); buff->ptr=myrealloc(buff->ptr,newsize*2); buff->len=newsize*2; } @@ -257,7 +263,7 @@ mxClassID str2classid(const char *str) if(myoptstrcmp("UINT16",str)==0) return mxUINT16_CLASS; if(myoptstrcmp("INT32",str)==0) return mxINT32_CLASS; if(myoptstrcmp("UINT32",str)==0) return mxUINT32_CLASS; - return mxCHAR_CLASS; /* Default to char; */ + return mxCHAR_CLASS; // Default to char; } /********************************************************************/ @@ -279,6 +285,7 @@ mxClassID classid2size(const mxClassID id) /* Windows implementation of perror() function */ #ifdef WIN32 /********************************************************************/ +/* void perror(const char *context ) { int wsa_err; @@ -316,26 +323,27 @@ void perror(const char *context ) } return; } + **/ #endif /********************************************************************/ /*Makes byte swapping, or not depending on the mode argument */ void byteswapdata(char *ptr,const int elements,const int elementsize,int mode) { - /* MODE=0 Do nothing, MODE=1 Swap, MODE=2 network byte order, MODE=3 Intel byte order. */ + // MODE=0 Do nothing, MODE=1 Swap, MODE=2 network byte order, MODE=3 Intel byte order. #ifndef SWAPDATA #define SWAPDATA(a,b) { a^=b; b^=a; a^=b; } #endif - /* A little smart ckeck of byte the machine byte order. */ + // A little smart ckeck of byte the machine byte order. const int ordertest=1; const char *is_intel_order=(const char *)(&ordertest); - /* fprintf(stderr,"SWAP FUNCTION...E:%d SI:%d\n",elements,elementsize); */ + // fprintf(stderr,"SWAP FUNCTION...E:%d SI:%d\n",elements,elementsize); if(elementsize<2) return; if(is_intel_order[0]==1 && mode==2) mode=1; if(is_intel_order[0]==0 && mode==3) mode=1; if(mode==1){ int e; - /* fprintf(stderr,"SWAP DATA\n"); */ + // fprintf(stderr,"SWAP DATA\n"); switch(elementsize){ case 2: for(e=0;eargno) return 1; return 0; @@ -473,7 +498,7 @@ int my_mexIsInputArgOK(const int argno) /* Returns specified input argument as scalar. Global and error tolerant replacement for mxGetScalar */ const mxArray *my_mexInputArg(const int argno) { - /* fprintf(stderr,"GET_INPUT_ARG NO:%d\n",argno); */ + // fprintf(stderr,"GET_INPUT_ARG NO:%d\n",argno); // DEBUG if(!my_mexIsInputArgOK(argno)) mexErrMsgTxt("Missing input argument."); return gprhs[argno]; @@ -583,12 +608,12 @@ int my_mexInputArray2Buff(const int argno,io_buff *buff) newbuffsize(buff,buff->pos+len*si); if(id==mxCHAR_CLASS){ - mxChar *ptr = (mxChar *)mxGetPr(gprhs[argno]); + mxChar *ptr = (mxChar *)mxGetData(gprhs[argno]); int a; for(a=0;aptr[buff->pos++]=(char)(unsigned char)ptr[a]; }else{ - char *ptr = (char *)mxGetPr(gprhs[argno]); + char *ptr = (char *)mxGetData(gprhs[argno]); byteswapcopy(&buff->ptr[buff->pos],ptr,len,si,swap); buff->pos+=(len*si); } @@ -609,7 +634,7 @@ void my_mexReturnValue(double val) *mxGetPr(gplhs[gret_args])=val; gret_args++; } -/* mexPrintf("DEBUG MEX RETURN VALUE:%g\n",val); */ +// mexPrintf("DEBUG MEX RETURN VALUE:%g\n",val); // DEBUG } /*******************************************************************************/ @@ -645,7 +670,7 @@ void my_mexReturnArrayFromBuff(const int argno,io_buff *buff,const int line) { const int maxelements=my_mexInputSize(argno); const mxClassID id=str2classid(my_mexInputOptionString(argno+1)); - int dims[20]={0,0,0,0,0, 0,0,0,0,0, 0,0,0,0,0, 0,0,0,0,0 }; + mwSize dims[20]={0,0,0,0,0, 0,0,0,0,0, 0,0,0,0,0, 0,0,0,0,0 }; const int si=classid2size(id); int returnelements= ( (buff->pos/si)< maxelements )?(buff->pos/si):maxelements; int deleteelements=returnelements; @@ -666,25 +691,25 @@ void my_mexReturnArrayFromBuff(const int argno,io_buff *buff,const int line) for(n=0;nptr[n]=='\n') break; - if(n==maxelements) /* If no new-line found inside limit... */ - deleteelements=returnelements=maxelements; /* ...return first part of splited line. */ - else if(n==returnelements) /* If new-line not recived inside limit... */ - deleteelements=returnelements=0; /* ...return empty string, and delete nothing. */ - else if(n>0 && buff->ptr[n-1]=='\r') /* If(*3) new-line, return line of char but not nl chars. */ + if(n==maxelements) // If no new-line found inside limit... + deleteelements=returnelements=maxelements; // ...return first part of splited line. + else if(n==returnelements) // If new-line not recived inside limit... + deleteelements=returnelements=0; // ...return empty string, and delete nothing. + else if(n>0 && buff->ptr[n-1]=='\r') // If(*3) new-line, return line of char but not nl chars. deleteelements=2+(returnelements=n-1); else deleteelements=1+(returnelements=n); return_no_dims=1; } - if(return_no_dims>1){ /* If shape of return argument is specified..... */ - if(returnelements==maxelements){ /* ...then only accept correct shape. */ + if(return_no_dims>1){ // If shape of return argument is specified..... + if(returnelements==maxelements){ // ...then only accept correct shape. int n; for(n=0;n0){ /* else... Just return row of available elements */ - dims[0]=1; - dims[1]=returnelements; + }else if(returnelements>0){ // else... Just return row of available elements + dims[0] = 1; + dims[1] = (mwSize) returnelements; return_no_dims=2; } if(! (gret_args>gnlhs && gret_args>1) ){ @@ -698,27 +723,27 @@ void my_mexReturnArrayFromBuff(const int argno,io_buff *buff,const int line) if(dims[0]!=0){ if(id==mxCHAR_CLASS){ int i; - mxChar *p=(mxChar *)mxGetPr(gplhs[gret_args]); + mxChar *p=(mxChar *)mxGetData(gplhs[gret_args]); for(i=0;iptr[i]; }else{ - char *p=(char *)mxGetPr(gplhs[gret_args]); + char *p=(char *)mxGetData(gplhs[gret_args]); byteswapcopy(p,buff->ptr,returnelements,si,swap); } } gret_args++; } - /* debug_view_con_status("GET_ARRAY N�STAN KLAR"); */ - /* Delete from read buffer if not "VIEW" option and dims filled */ + // debug_view_con_status("GET_ARRAY NSTAN KLAR"); + // Delete from read buffer if not "VIEW" option and dims filled if(my_mexFindInputOption(argno+1,"VIEW")==0 && deleteelements>0 ){ buff->pos-=deleteelements*si; memmove(buff->ptr,&buff->ptr[deleteelements*si],buff->pos); newbuffsize(buff,buff->pos); } - /* mexPrintf("DEBUG MEX RETURN ARRAY OF:%d\n",returnelements); */ + // mexPrintf("DEBUG MEX RETURN ARRAY OF:%d\n",returnelements); // DEBUG - /* fprintf(stderr,"DIMS:[%d %d] DEL:%d RET:%d SI:%d POS:%d LEN:%d PTR:%08X\n", */ - /* dims[0],dims[1],deleteelements,returnelements,si,buff->pos,buff->len,buff->ptr); */ + // fprintf(stderr,"DIMS:[%d %d] DEL:%d RET:%d SI:%d POS:%d LEN:%d PTR:%08X\n", + // dims[0],dims[1],deleteelements,returnelements,si,buff->pos,buff->len,buff->ptr); } @@ -732,7 +757,7 @@ int ipv4_lookup(const char *hostname,int port) /*Can't resolve host string as dot notation IP number... try lookup IP from hostname */ struct hostent *he; - /* fprintf(stderr,"Trying nameserverlookup:%s\n",hostname); */ + // fprintf(stderr,"Trying nameserverlookup:%s\n",hostname); he=gethostbyname(hostname); if(he==NULL){ mexPrintf("\nUNKNOWN HOST:%s\n",hostname); @@ -761,8 +786,8 @@ int writedata() int lastsize=1000000; if(con[con_index].status65534 ) */ - /* len=65534; */ + // if( !IS_STATUS_TCP_CONNECTED(con[con_index].status) && len>65534 ) // TODO: Ta bort! + // len=65534; while(sentlen0?retval:0; sentlen+=lastsize; - if(retval<0 && s_errno!=EWOULDBLOCK) { + /* if( retval==0){ + mexPrintf("\nREMOTE HOST DISCONNECTED\n"); + con[con_index].status=STATUS_NOCONNECT; + break; + }*/ + if(retval<0 && s_errno!=EWOULDBLOCK + // IFWINDOWS( && s_errno!=WSAECONNRESET ) // DEBUG: REMOVE THIS LINE? + ){ con[con_index].status=STATUS_NOCONNECT; perror( "sendto() / send()" ); mexPrintf("\nREMOTE HOST DISCONNECTED\n"); @@ -856,9 +888,9 @@ int read2buff(const int len,int newline,int noblock) if(con[con_index].read.len0){ if(IS_STATUS_CONNECTED(con[con_index].status)) retval=recv(con[con_index].fid,&con[con_index].read.ptr[con[con_index].read.pos],readlen ,MSG_NOSIGNAL); @@ -866,7 +898,7 @@ int read2buff(const int len,int newline,int noblock) struct sockaddr_in my_addr; int fromlen=sizeof(my_addr); - /* Copy 0.0.0.0 adress and 0 port to remote_addr as init-value. */ + // Copy 0.0.0.0 adress and 0 port to remote_addr as init-value. memset(&my_addr,0,sizeof(my_addr)); con[con_index].remote_addr.sin_addr = my_addr.sin_addr; con[con_index].remote_addr.sin_port = my_addr.sin_port; @@ -883,20 +915,21 @@ int read2buff(const int len,int newline,int noblock) break; } if(retval<0 && s_errno!=EWOULDBLOCK + // IFWINDOWS( && s_errno!=WSAECONNRESET )// DEBUG: REMOVE THIS LINE? ) { con[con_index].status=STATUS_NOCONNECT; perror( "recvfrom() or recv()" ); break; } } - /* fprintf(stderr,"RET:%d/%d ",retval,s_errno); */ + // fprintf(stderr,"RET:%d/%d ",retval,s_errno); readlen=retval>0?retval:0; con[con_index].read.pos+=readlen; if( !IS_STATUS_TCP_CONNECTED(con[con_index].status) && con[con_index].read.pos>0 ) break; if( con[con_index].read.pos>=len ) break; - if(timeoutat<=my_now() || noblock) + if(noblock || timeoutat<=my_now()) break; if(newline){ int n; @@ -910,7 +943,7 @@ int read2buff(const int len,int newline,int noblock) return con[con_index].read.pos; } -/***************************************************************************/ +/***************************************************************************/ // BORT??? /* Read specified length & type from UDP or TCP network to input buffer */ int readtype2buff(int len,mxClassID datatype,int newline,int noblock) { @@ -949,6 +982,14 @@ int tcp_udp_socket(int port,int dgram_f) int sockfd; struct sockaddr_in my_addr; /* my address information */ const int on=1; + + #ifndef WIN32 + #ifndef IPTOS_LOWDELAY + #define IPTOS_LOWDELAY 0x10 + #endif + int tos = IPTOS_LOWDELAY; + #endif + if(dgram_f) sockfd = socket(AF_INET, SOCK_DGRAM, 0); else @@ -967,6 +1008,14 @@ int tcp_udp_socket(int port,int dgram_f) } listen(sockfd,BACKLOG); nonblockingsocket(sockfd); + + /* Try to enable low-latency send/receive operations on socket: */ + #ifndef WIN32 + if (-1 == setsockopt(sockfd, IPPROTO_IP, IP_TOS, &tos, sizeof(tos))) { + mexPrintf("pnet: Warning: Could not enable low-latency mode on socket! [%s]\n", strerror(errno)); + } + #endif + return sockfd; } @@ -983,7 +1032,7 @@ int tcpiplisten(int noblock) while(1){ if ((new_fd = accept(sock_fd, (struct sockaddr *)&con[con_index].remote_addr,&sin_size)) > -1) break; - if(timeoutat<=my_now()|| noblock) + if(noblock || timeoutat<=my_now()) return -1; usleep(DEFAULT_USLEEP); } @@ -1058,7 +1107,7 @@ void mexFunction( if(mxIsChar(my_mexInputArg(0))){ /* GET FIRST ARGUMENT -- The "function" name */ strncpy(fun,my_mexInputOptionString(0),80); -/* mexPrintf("DEBUG MEX(1):[%d] %s\n",con_index,fun); // DEBUG */ +// mexPrintf("DEBUG MEX(1):[%d] %s\n",con_index,fun); // DEBUG /* Find of the function name corresponds to a non connection associated function */ if(myoptstrcmp(fun,"CLOSEALL")==0){ @@ -1098,11 +1147,11 @@ void mexFunction( } /* Get connection handler and suppose that it is a connection assosiated function */ /* Find given handel */ - /* if(strncasecmp(fun,"DEF",3)!=0) */ + // if(strncasecmp(fun,"DEF",3)!=0) if(move_con((int)my_mexInputScalar(0))==0) mexErrMsgTxt("Unknown connection handler"); strncpy(fun,my_mexInputOptionString(1),80); - /* mexPrintf("DEBUG MEX(2):[%d] %s\n",con_index,fun); // DEBUG */ + // mexPrintf("DEBUG MEX(2):[%d] %s\n",con_index,fun); // DEBUG debug_view_con_status("CON_MOVED!!"); if(myoptstrcmp(fun,"CLOSE")==0){ @@ -1132,7 +1181,7 @@ void mexFunction( mxArray *plhs[1]={NULL}; if(gnrhs<3) return; mexCallMATLAB(1,plhs, gnrhs-2, (mxArray **)&(gprhs[2]),"sprintf"); - gprhs=(const mxArray **)plhs; gnrhs=1; /* HACK: Move return arg from sprintf to input arg of this mex. */ + gprhs=(const mxArray **)plhs; gnrhs=1; // HACK: Move return arg from sprintf to input arg of this mex. my_mexInputArray2Buff(0,&con[con_index].write); if(IS_STATUS_TCP_CONNECTED(con[con_index].status)) writedata(); @@ -1145,11 +1194,11 @@ void mexFunction( return; } if(myoptstrcmp(fun,"READLINE")==0){ - /* mexPrintf("DEBUG: READLINE....\n"); */ + // mexPrintf("DEBUG: READLINE....\n"); if(IS_STATUS_TCP_CONNECTED(con[con_index].status)) read2buff(my_mexInputSize(2),1,my_mexFindInputOption(2,"noblock")); my_mexReturnArrayFromBuff(2,&con[con_index].read,1); - /* mexPrintf("DEBUG: READLINE END\n"); */ + // mexPrintf("DEBUG: READLINE END\n"); return; } if(myoptstrcmp(fun,"READTOFILE")==0){ @@ -1165,7 +1214,7 @@ void mexFunction( writelen=fwrite(con[con_index].read.ptr,1,readlen,f); fclose(f); } - /* Delete from read buffer if not "VIEW" option and dims filled */ + // Delete from read buffer if not "VIEW" option and dims filled if(my_mexFindInputOption(2+1,"VIEW")==0 ){ con[con_index].read.pos-=writelen; memmove(con[con_index].read.ptr,&con[con_index].read.ptr[writelen],con[con_index].read.pos); @@ -1247,11 +1296,11 @@ void mexFunction( mexPrintf(" FID:%d\n",con[con_index].fid); mexPrintf(" STATUS:%d\n",con[con_index].status); mexPrintf("WRITE TO:%g\n",con[con_index].writetimeout); - mexPrintf("WRITE PTR:%x\n",(int)con[con_index].write.ptr); + mexPrintf("WRITE PTR:%p\n",con[con_index].write.ptr); mexPrintf("WRITE POS:%d\n",con[con_index].write.pos); mexPrintf("WRITE LEN:%d\n",con[con_index].write.len); mexPrintf("READ TO:%g\n",con[con_index].readtimeout); - mexPrintf("READ PTR:%x\n",(int)con[con_index].read.ptr); + mexPrintf("READ PTR:%p\n",con[con_index].read.ptr); mexPrintf("READ POS:%d\n",con[con_index].read.pos); mexPrintf("READ LEN:%d\n",con[con_index].read.len); return;