package github.madmarty.madsonic.util.SubtitleConverter;
import java.io.IOException;
import java.io.InputStream;
/**
* This class specifies the interface for any format supported by the converter, these formats must
* create a {@link TimedTextObject} from an {@link InputStream} (so it can process files form standard In or uploads)
* and return a String array for text formats, or byte array for binary formats.
* <br><br>
* Copyright (c) 2012 J. David Requejo <br>
* j[dot]david[dot]requejo[at] Gmail
* <br><br>
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software
* and associated documentation files (the "Software"), to deal in the Software without restriction,
* including without limitation the rights to use, copy, modify, merge, publish, distribute,
* sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
* is furnished to do so, subject to the following conditions:
* <br><br>
* The above copyright notice and this permission notice shall be included in all copies
* or substantial portions of the Software.
* <br><br>
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
* PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
* FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* @author J. David Requejo
*
*/
public interface TimedTextFileFormat {
/**
* This methods receives the path to a file, parses it, and returns a TimedTextObject
*
* @param path String that contains the path to the file
* @return TimedTextObject representing the parsed file
* @throws IOException when having trouble reading the file from the given path
*/
TimedTextObject parseFile(String fileName, InputStream is) throws IOException, FatalParsingException;
}