uk.co.caprica.vlcj.player.base.SnapshotApi Maven / Gradle / Ivy
Show all versions of vlcj Show documentation
/*
* This file is part of VLCJ.
*
* VLCJ 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.
*
* VLCJ 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 VLCJ. If not, see
* If this is not set then snapshots will be saved to the user home directory.
*/
private String snapshotDirectoryName;
SnapshotApi(MediaPlayer mediaPlayer) {
super(mediaPlayer);
}
/**
* Set the directory into which snapshots of the video are saved.
*
* If the specified directory path does not yet exist, it will be created.
*
* @param snapshotDirectoryName name of the directory to save snapshots to
*/
public void setSnapshotDirectory(String snapshotDirectoryName) {
this.snapshotDirectoryName = snapshotDirectoryName;
}
/**
* Save a snapshot of the currently playing video.
*
* The size of the image will be that produced by the libvlc native snapshot function, i.e. the
* size of the media itself.
*
* The snapshot will be created in the directory set via {@link #setSnapshotDirectory(String)},
* unless that directory has not been set in which case the snapshot will be created in the
* user's home directory, obtained via the "user.home" system property.
*
* The snapshot will be assigned a filename based on the current time.
*
* The size of the image will be that produced by the libvlc native snapshot function.
*
* Taking a snapshot is an asynchronous function, the snapshot is not available until
* after the {@link MediaPlayerEventListener#snapshotTaken(MediaPlayer, String)} event
* is received.
*
* @return true if the snapshot was saved, otherwise false
*/
public boolean save() {
return save(0, 0);
}
/**
* Save a snapshot of the currently playing video.
*
* The snapshot will be created in the directory set via {@link #setSnapshotDirectory(String)},
* unless that directory has not been set in which case the snapshot will be created in the
* user's home directory, obtained via the "user.home" system property.
*
* The snapshot will be assigned a filename based on the current time.
*
* If one of width or height is zero the original image aspect ratio will be preserved.
*
* If both width and height are zero, the original image size will be used, see
* {@link #save()}.
*
* Taking a snapshot is an asynchronous function, the snapshot is not available until
* after the {@link MediaPlayerEventListener#snapshotTaken(MediaPlayer, String)} event
* is received.
*
* @param width desired image width
* @param height desired image height
* @return true if the snapshot was saved, otherwise false
*/
public boolean save(int width, int height) {
File snapshotDirectory = new File(snapshotDirectoryName == null ? System.getProperty("user.home") : snapshotDirectoryName);
File snapshotFile = new File(snapshotDirectory, "vlcj-snapshot-" + System.currentTimeMillis() + ".png");
return save(snapshotFile, width, height);
}
/**
* Save a snapshot of the currently playing video.
*
* The size of the image will be that produced by the libvlc native snapshot function, i.e. the
* size of the media itself.
*
* Any missing directory path will be created if it does not exist.
*
* Taking a snapshot is an asynchronous function, the snapshot is not available until
* after the {@link MediaPlayerEventListener#snapshotTaken(MediaPlayer, String)} event
* is received.
*
* @param file file to contain the snapshot
* @return true if the snapshot was saved, otherwise false
*/
public boolean save(File file) {
return save(file, 0, 0);
}
/**
* Save a snapshot of the currently playing video.
*
* Any missing directory path will be created if it does not exist.
*
* If one of width or height is zero the original image aspect ratio will be preserved.
*
* If both width and height are zero, the original image size will be used, see
* {@link #save(File)}.
*
* Taking a snapshot is an asynchronous function, the snapshot is not available until
* after the {@link MediaPlayerEventListener#snapshotTaken(MediaPlayer, String)} event
* is received.
*
* @param file file to contain the snapshot
* @param width desired image width
* @param height desired image height
* @return true if the snapshot was saved, otherwise false
*/
public boolean save(File file, int width, int height) {
File snapshotDirectory = file.getParentFile();
if (snapshotDirectory == null) {
snapshotDirectory = new File(".");
}
if (!snapshotDirectory.exists()) {
snapshotDirectory.mkdirs();
}
if (snapshotDirectory.exists()) {
return libvlc.libvlc_video_take_snapshot(mediaPlayerInstance, 0, file.getAbsolutePath(), width, height) == 0;
} else {
throw new RuntimeException("Directory does not exist and could not be created for '" + file.getAbsolutePath() + "'");
}
}
/**
* Get a snapshot of the currently playing video.
*
* The size of the image will be that produced by the libvlc native snapshot function, i.e. the
* size of the media itself.
*
* This implementation uses the native libvlc method to save a snapshot of the currently playing
* video. This snapshot is saved to a temporary file and then the resultant image is loaded from
* the file.
*
* Taking a snapshot is an asynchronous function, the snapshot is not available until
* after the {@link MediaPlayerEventListener#snapshotTaken(MediaPlayer, String)} event
* is received.
*
* @return snapshot image, or null if a snapshot could not be taken
*/
public BufferedImage get() {
return get(0, 0);
}
/**
* Get a snapshot of the currently playing video.
*
* This implementation uses the native libvlc method to save a snapshot of the currently playing
* video. This snapshot is saved to a temporary file and then the resultant image is loaded from
* the file.
*
* If one of width or height is zero the original image aspect ratio will be preserved.
*
* If both width and height are zero, the original image size will be used, see
* {@link #get()}
*
* Taking a snapshot is an asynchronous function, the snapshot is not available until
* after the {@link MediaPlayerEventListener#snapshotTaken(MediaPlayer, String)} event
* is received.
*
* @param width desired image width
* @param height desired image height
* @return snapshot image, or null if a snapshot could not be taken
*/
public BufferedImage get(int width, int height) {
File file = null;
try {
file = File.createTempFile("vlcj-snapshot-", ".png");
return ImageIO.read(new File(new WaitForSnapshot(mediaPlayer, file, width, height).await()));
}
catch (IOException e) {
throw new RuntimeException("Failed to get snapshot image", e);
}
catch (InterruptedException e) {
throw new RuntimeException("Failed to get snapshot image", e);
}
catch (BeforeWaiterAbortedException e) {
return null;
}
finally {
if (file != null) {
file.delete();
}
}
}
}