001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.video.xuggle;
031
032import java.io.File;
033import java.io.IOException;
034import java.net.URL;
035import java.util.HashMap;
036import java.util.Map;
037
038import org.apache.commons.io.FileUtils;
039
040import com.xuggle.xuggler.io.FileProtocolHandler;
041import com.xuggle.xuggler.io.IURLProtocolHandler;
042
043/**
044 * An {@link IURLProtocolHandler} for jar resources. This implementation copies
045 * the resource to a temporary file before opening it - it could potentially
046 * consume a stream directly, but this would restrict the video codecs to ones
047 * that directly support streaming.
048 *
049 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
050 */
051public class JarURLProtocolHandler extends FileProtocolHandler {
052        private static final Map<URL, String> extractedVideos = new HashMap<URL, String>();
053
054        /**
055         * Construct with no video
056         */
057        public JarURLProtocolHandler() {
058
059        }
060
061        /**
062         * Construct with the given url. The video will be extracted immediately.
063         *
064         * @param url
065         *            the url to the video
066         * @throws IOException
067         *             if an error occurs
068         */
069        public JarURLProtocolHandler(String url) throws IOException {
070                super(extract(url));
071        }
072
073        @Override
074        public int open(String url, int flags) {
075                if (flags != URL_RDONLY_MODE) {
076                        // log.debug("Cannot write to a video in a jar file");
077                        return -1;
078                }
079
080                try {
081                        return super.open(extract(url), flags);
082                } catch (final IOException e) {
083                        // log.error("Unexpected IOException: " + e);
084                        e.printStackTrace();
085                        return -1;
086                }
087        }
088
089        private static String extract(String urlString) throws IOException {
090                final URL url = new URL(urlString);
091
092                if (extractedVideos.containsKey(url))
093                        return extractedVideos.get(url);
094
095                final File tmp = File.createTempFile("movie", ".tmp");
096                final String filename = tmp.toURI().toString();
097                // log.debug("Mapping url " + urlString + " to  file " + tmp);
098                tmp.deleteOnExit();
099                FileUtils.copyURLToFile(url, tmp);
100                extractedVideos.put(url, filename);
101
102                return filename;
103        }
104
105        @Override
106        public int write(byte[] paramArrayOfByte, int paramInt) {
107                // writing not supported
108                return -1;
109        }
110}