123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537 |
- /*
- * cubeWorker.java
- *
- * Copyright 2011 Thomas Buck <xythobuz@me.com>
- * Copyright 2011 Max Nuding <max.nuding@gmail.com>
- * Copyright 2011 Felix Bäder <baeder.felix@gmail.com>
- *
- * This file is part of LED-Cube.
- *
- * LED-Cube 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.
- *
- * LED-Cube 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 LED-Cube. If not, see <http://www.gnu.org/licenses/>.
- */
-
- /*
- * This class handles one animation file. This file can contain
- * many animations, but has to be only 1Mbit in size (128*1024 Byte).
- */
- import java.util.ArrayList;
- import java.util.List;
- import java.util.StringTokenizer;
- import java.util.Collections;
-
- /**
- * This class holds all Data of the Application. Additionally it performs the
- * transmission of animation data to/from the cube and saves/loads animations
- * in/from a file.
- *
- * @author Thomas Buck
- * @author Felix Bäder
- * @author Max Nuding
- * @version 1.0
- */
-
- public class cubeWorker {
-
- // --------------------
- // Definitions
- // --------------------
-
- final int UP = 0;
- final int DOWN = 1;
-
- // --------------------
- // Fields
- // --------------------
-
- private List<Animation> animations = new ArrayList<Animation>();
- private final int framesRemaining = 2016; // (128 * 1024) / 65 = 2016,...
- private boolean changedState = false;
- private Frame parentFrame;
-
- // --------------------
-
- /**
- * Creates a worker with one animation, containing an empty frame.
- */
- public cubeWorker(Frame parent) {
- animations.add(new Animation());
- animations.get(0).setName("Animation 1");
- animations.get(0).add(0);
- animations.get(0).get(0).setName("Frame 1");
- parentFrame = parent;
- }
-
- /**
- * Creates a worker from the given animation list
- *
- * @param anims List of animations
- */
- public cubeWorker(List<Animation> anims, Frame parent) {
- animations = anims;
- parentFrame = parent;
- }
-
- /**
- * Returns number of frames in this cubeWorker.
- *
- * @return number of frames.
- */
- public int completeNumOfFrames() {
- int count = 0;
- for (int i = 0; i < numOfAnimations(); i++) {
- count += numOfFrames(i);
- }
- return count;
- }
-
- // --------------------
- // Misc. Methods
- // --------------------
-
- // Returns a number that is below the size of the animations list and not used as order
- // If a order is higher or equal to the size of the list, it tries to assign a hole found to this
- // Returns -1 if there is no hole
- private int holeInAnimationList() {
- int s = animations.size();
- byte[] result = new byte[s];
- int hole = -1;
- int fix = -1;
- for (int i = 0; i < s; i++) {
- result[i] = 0;
- }
- for (int i = 0; i < s; i++) {
- int order = animations.get(i).getOrder();
- if (order >= s) {
- // Houston, we have a problem...
- fix = i;
- }
- result[order] = 1;
- }
- for (int i = 0; i < s; i++) {
- if (result[i] == 0) {
- hole = i;
- break;
- }
- }
- if ((hole != -1) && (fix != 1)) {
- animations.get(fix).setOrder(hole);
- return holeInAnimationList();
- }
- return hole;
- }
-
- // return true if damaged and to be sorted
- private boolean checkAnimationList() {
- for (int i = 0; i < animations.size(); i++) {
- if (animations.get(i).getOrder() != i) {
- int h = holeInAnimationList();
- if (h != -1) {
- animations.get(i).setOrder(h);
- }
- return true;
- }
- }
- return false;
- }
-
- /**
- * Get the number of animations in this worker.
- * Also fixes the order of the animation list, if needed.
- *
- * @return number of animations
- */
- public int numOfAnimations() {
- while(checkAnimationList()) {
- Collections.sort(animations);
- }
- return animations.size();
- }
-
- /**
- * Get the number of frames in an animation.
- *
- * @param selectedAnimation the animation you want to check
- * @return number of frames in this animation
- */
- public int numOfFrames(int selectedAnimation) {
- return animations.get(selectedAnimation).size();
- }
-
- /**
- * Get the number of frames you can add until the Cubes memory is full.
- *
- * @return number of frames remaining
- */
- public int framesRemaining() {
- return framesRemaining - completeNumOfFrames();
- }
-
- // --------------------
- // Animation Specific
- // --------------------
-
- /**
- * Add an animation. It has an initial empty frame
- *
- * @return Index of new animation, or -1 if not enough space remaining.
- */
- public int addAnimation() {
- changedState = true;
- if (framesRemaining() <= 0) {
- return -1;
- } else {
- int s = animations.size();
- animations.add(s, new Animation());
- animations.get(s).setName("Animation " + animations.size());
- animations.get(s).add(0, new AFrame());
- animations.get(s).get(0).setName("Frame 1");
- return s;
- }
- }
-
- /**
- * Remove an animation.
- *
- * @param selectedAnimation the animation you want to delete
- */
- public void removeAnimation(int selectedAnimation) {
- changedState = true;
- animations.remove(selectedAnimation);
- }
-
- /**
- * Get the name of an animation
- *
- * @return The name
- * @param selectedAnimation The animation you want to get the name from
- */
- public String getAnimationName(int selectedAnimation) {
- return animations.get(selectedAnimation).getName();
- }
-
- /**
- * Set the name of an animation @param s New name
- *
- * @param selectedAnimation Index of the animation you want to change
- */
- public void setAnimationName(String s, int selectedAnimation) {
- changedState = true;
- animations.get(selectedAnimation).setName(s);
- }
-
- /**
- * Move an animation UP or DOWN.
- *
- * @param dir Direction. Use UP and DOWN defined in cubeWorker
- * @param selectedAnimation Animation you want to move
- */
- public void moveAnimation(int dir, int selectedAnimation) {
- changedState = true;
- if (dir == UP) {
- // animation moved up
- if (selectedAnimation > 0) {
- Animation tmp = animations.get(selectedAnimation);
- animations.set(selectedAnimation,
- animations.get(selectedAnimation - 1));
- animations.set(selectedAnimation - 1, tmp);
- }
- } else if (dir == DOWN) {
- // animation moved down
- if (selectedAnimation < (animations.size() - 1)) {
- Animation tmp = animations.get(selectedAnimation);
- animations.set(selectedAnimation,
- animations.get(selectedAnimation + 1));
- animations.set(selectedAnimation + 1, tmp);
- }
- }
- }
-
- // --------------------
- // Frame Specific
- // --------------------
-
- /**
- * Get the name of a frame.
- *
- * @param anim Animation the frame is in
- * @param frame Index of the frame
- */
- public String getFrameName(int anim, int frame) {
- return animations.get(anim).get(frame).getName();
- }
-
- /**
- * Set the name of a frame.
- *
- * @param s New name
- * @param anim Animation Index
- * @param frame Frame Index
- */
- public void setFrameName(String s, int anim, int frame) {
- changedState = true;
- animations.get(anim).get(frame).setName(s);
- }
-
- /**
- * Add a Frame to an animation.
- *
- * @return Index of new Frame or -1 if not enough space
- * @param anim Animation Index
- */
- public int addFrame(int anim) {
- changedState = true;
- if (framesRemaining() <= 0) {
- return -1;
- }
- int s = animations.get(anim).size();
- animations.get(anim).add(s);
- animations.get(anim).get(s)
- .setName("Frame " + animations.get(anim).size());
- return s;
- }
-
- /**
- * Remove a frame.
- *
- * @param anim Animation Index
- * @param frame Frame you want to remove
- */
- public void removeFrame(int anim, int frame) {
- changedState = true;
- animations.get(anim).remove(frame);
- }
-
- /**
- * Get the data of a frame.
- *
- * @param anim Animation Index @param frame Frame Index
- * @return 64 byte array with data (8 bits per byte => 512 bits)
- */
- public short[] getFrame(int anim, int frame) {
- return animations.get(anim).get(frame).getData();
- }
-
- /**
- * Set the data of a frame
- *
- * @param data 64 byte array with data
- * @param anim Animation Index
- * @param frame Frame Index
- * @see cubeWorker#getFrame(int, int) getFrame()
- */
- public void setFrame(short[] data, int anim, int frame) {
- changedState = true;
- animations.get(anim).get(frame).setData(data);
- }
-
- /**
- * Get frame duration.
- *
- * @param anim Animation Index
- * @param frame Frame Index
- * @return Duration. 0 means 1/24th of a second.
- */
- public short getFrameTime(int anim, int frame) {
- return animations.get(anim).get(frame).getTime();
- }
-
- /**
- * Set the frames duration.
- *
- * @param time New duration
- * @param anim Animation Index
- * @param frame Frame Index
- * @see cubeWorker#getFrameTime(int, int) getFrameTime()
- */
- public void setFrameTime(short time, int anim, int frame) {
- changedState = true;
- animations.get(anim).get(frame).setTime(time);
- }
-
- /**
- * Move a frame.
- *
- * @param dir Direction to move. Use UP and DOWN from cubeWorker
- * @param anim Animation Index
- * @param frame Frame Index
- * @see cubeWorker#moveAnimation(int, int) moveAnimation()
- */
- public void moveFrame(int dir, int anim, int frame) {
- changedState = true;
- if (dir == UP) {
- // frame moved up
- if (frame > 0) {
- AFrame tmp = animations.get(anim).frames.get(frame);
- animations.get(anim).frames.set(frame,
- animations.get(anim).frames.get(frame - 1));
- animations.get(anim).frames.set(frame - 1, tmp);
- }
- } else if (dir == DOWN) {
- // frame moved down
- if (frame < (animations.get(anim).size() - 1)) {
- AFrame tmp = animations.get(anim).frames.get(frame);
- animations.get(anim).frames.set(frame,
- animations.get(anim).frames.get(frame + 1));
- animations.get(anim).frames.set(frame + 1, tmp);
- }
- }
- }
-
- // --------------------
- // File Specific
- // --------------------
-
- /**
- * Loads an animation file into this worker.
- *
- * @param path Path of file to load
- * @return 0 on success, -1 on error.
- */
- public int loadState(String path) {
- changedState = false;
- try {
- animations = AnimationUtility.readFile(path);
- } catch (Exception e) {
- System.out.println("Did not load!");
- e.printStackTrace(System.out);
- return -1;
- }
- int size = 0;
- for (int i = 0; i < animations.size(); i++) {
- size += animations.get(i).size();
- }
- if (size > framesRemaining) {
- return -1;
- }
- return 0;
- }
-
- /**
- * Save the state of this object into a file.
- *
- * @param path Path to save file in
- * @return 0 on success, -1 on error
- */
- public int saveState(String path) {
- changedState = false;
- AnimationUtility.writeFile(path, animations);
- if (AnimationUtility.getLastError() != null) {
- System.out.println(AnimationUtility.getLastError());
- return -1;
- }
- return 0;
- }
-
- /**
- * Check if something changed after loading/saving.
- *
- * @return TRUE if something changed, FALSE otherwise
- */
- public boolean changedStateSinceSave() {
- return changedState;
- }
-
- // --------------------
- // Serial Port Specific
- // --------------------
-
- /**
- * Send all animations to the cube.
- *
- * @param port Name of serial port to use
- * @return 0 on success, -1 on error
- */
- public int uploadState(String port) {
- try {
- SerialHelper sh = new SerialHelper(port, parentFrame);
- int ret = sh.sendAnimationsToCube(this);
- sh.closeSerialPort();
- return ret;
- } catch (Exception e) {
- return -1;
- }
- }
-
- /**
- * Get all animations from the cube, place it in this object
- *
- * @param port Name of serial port to use
- * @return 0 on success, -1 on error
- */
- public int downloadState(String port) {
- try {
- SerialHelper sh = new SerialHelper(port, parentFrame);
- cubeWorker ret = sh.getAnimationsFromCube();
- sh.closeSerialPort();
- if (ret == null) {
- return -1;
- } else {
- changedState = true;
- animations = ret.getAnimationList();
- return 0;
- }
- } catch (Exception e) {
- return -1;
- }
- }
-
- /**
- * Get the list used internally to store all the animations.
- * @return The list.
- */
- public List<Animation> getAnimationList() {
- return animations;
- }
-
- /**
- * Try to speak with the cube.
- *
- * @return TRUE if cube responds
- * @param port Name of serial port
- */
- public boolean probeCubeConnected(String port) {
- try {
- SerialHelper sh = new SerialHelper(port, parentFrame);
- boolean response = sh.probeForCube();
- sh.closeSerialPort();
- return response;
- } catch (Exception e) {
- return false;
- }
- }
-
- /**
- * Get the names of all available serial ports.
- *
- * @return Array of port names. First entry is "Select serial port..." if no
- * others
- */
- public String[] getSerialPorts() {
- String[] ports = { "Select serial port..." };
- String portLines = HelperUtility.getPorts();
- if (portLines == null) {
- return ports;
- }
- StringTokenizer sT = new StringTokenizer(portLines, "\n");
- int size = sT.countTokens();
- ports = new String[size];
- for (int i = 0; i < size; i++) {
- ports[i] = sT.nextToken();
- }
- return ports;
- }
-
- // --------------------
-
- }
|