// License: GPL. For details, see LICENSE file. package org.openstreetmap.josm.gui.layer.gpx; import static org.openstreetmap.josm.gui.help.HelpUtil.ht; import static org.openstreetmap.josm.tools.I18n.tr; import java.awt.event.ActionEvent; import java.io.File; import java.net.URL; import java.util.ArrayList; import java.util.Arrays; import java.util.Comparator; import java.util.List; import java.util.stream.Collectors; import javax.swing.AbstractAction; import javax.swing.JFileChooser; import javax.swing.JOptionPane; import javax.swing.filechooser.FileFilter; import org.openstreetmap.josm.actions.DiskAccessAction; import org.openstreetmap.josm.data.gpx.GpxConstants; import org.openstreetmap.josm.data.gpx.GpxData; import org.openstreetmap.josm.data.gpx.IGpxTrack; import org.openstreetmap.josm.data.gpx.IGpxTrackSegment; import org.openstreetmap.josm.data.gpx.WayPoint; import org.openstreetmap.josm.data.projection.ProjectionRegistry; import org.openstreetmap.josm.gui.HelpAwareOptionPane; import org.openstreetmap.josm.gui.MainApplication; import org.openstreetmap.josm.gui.layer.GpxLayer; import org.openstreetmap.josm.gui.layer.markerlayer.AudioMarker; import org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer; import org.openstreetmap.josm.gui.widgets.AbstractFileChooser; import org.openstreetmap.josm.io.audio.AudioUtil; import org.openstreetmap.josm.spi.preferences.Config; import org.openstreetmap.josm.tools.ImageProvider; import org.openstreetmap.josm.tools.Utils; /** * Import audio files into a GPX layer to enable audio playback functions. * @since 5715 */ public class ImportAudioAction extends AbstractAction { private final transient GpxLayer layer; /** * Audio file filter. * @since 12328 */ public static final class AudioFileFilter extends FileFilter { @Override public boolean accept(File f) { return f.isDirectory() || Utils.hasExtension(f, "wav", "mp3", "aac", "aif", "aiff"); } @Override public String getDescription() { return tr("Audio files (*.wav, *.mp3, *.aac, *.aif, *.aiff)"); } } private static final class Markers { public boolean timedMarkersOmitted; public boolean untimedMarkersOmitted; } /** * Constructs a new {@code ImportAudioAction}. * @param layer The associated GPX layer */ public ImportAudioAction(final GpxLayer layer) { super(tr("Import Audio")); new ImageProvider("importaudio").getResource().attachImageIcon(this, true); this.layer = layer; putValue("help", ht("/Action/ImportAudio")); } private static void warnCantImportIntoServerLayer(GpxLayer layer) { String msg = tr("The data in the GPX layer ''{0}'' has been downloaded from the server.
" + "Because its way points do not include a timestamp we cannot correlate them with audio data.", Utils.escapeReservedCharactersHTML(layer.getName())); HelpAwareOptionPane.showOptionDialog(MainApplication.getMainFrame(), msg, tr("Import not possible"), JOptionPane.WARNING_MESSAGE, ht("/Action/ImportAudio#CantImportIntoGpxLayerFromServer")); } @Override public void actionPerformed(ActionEvent e) { if (layer.data.fromServer) { warnCantImportIntoServerLayer(layer); return; } AbstractFileChooser fc = DiskAccessAction.createAndOpenFileChooser(true, true, null, new AudioFileFilter(), JFileChooser.FILES_ONLY, "markers.lastaudiodirectory"); if (fc != null) { File[] sel = fc.getSelectedFiles(); String names = Arrays.stream(sel) // sort files in increasing order of timestamp (this is the end time, but so long as they don't overlap, that's fine) .sorted(Comparator.comparingLong(File::lastModified)) .map(File::getName) .collect(Collectors.joining(", ", " (", ")")); MarkerLayer ml = new MarkerLayer(new GpxData(), tr("Audio markers from {0}", layer.getName()) + names, layer.getAssociatedFile(), layer); double firstStartTime = sel[0].lastModified() / 1000.0 - AudioUtil.getCalibratedDuration(sel[0]); Markers m = new Markers(); for (File file : sel) { importAudio(file, ml, firstStartTime, m); } MainApplication.getLayerManager().addLayer(ml); MainApplication.getMap().repaint(); } } /** * Makes a new marker layer derived from this GpxLayer containing at least one audio marker * which the given audio file is associated with. Markers are derived from the following (a) * explicit waypoints in the GPX layer, or (b) named trackpoints in the GPX layer, or (d) * timestamp on the audio file (e) (in future) voice recognised markers in the sound recording (f) * a single marker at the beginning of the track * @param audioFile the file to be associated with the markers in the new marker layer * @param ml marker layer * @param firstStartTime first start time in milliseconds, used for (d) * @param markers keeps track of warning messages to avoid repeated warnings */ private void importAudio(File audioFile, MarkerLayer ml, double firstStartTime, Markers markers) { URL url = Utils.fileToURL(audioFile); boolean hasTracks = !Utils.isEmpty(layer.data.tracks); boolean hasWaypoints = !Utils.isEmpty(layer.data.waypoints); List waypoints = new ArrayList<>(); boolean timedMarkersOmitted = false; boolean untimedMarkersOmitted = false; double snapDistance = Config.getPref().getDouble("marker.audiofromuntimedwaypoints.distance", 1.0e-3); // about 25 m WayPoint wayPointFromTimeStamp = null; // determine time of first point in track double firstTime = -1.0; if (hasTracks) { for (IGpxTrack track : layer.data.tracks) { for (IGpxTrackSegment seg : track.getSegments()) { for (WayPoint w : seg.getWayPoints()) { firstTime = w.getTime(); break; } if (firstTime >= 0.0) { break; } } if (firstTime >= 0.0) { break; } } } if (firstTime < 0.0) { JOptionPane.showMessageDialog( MainApplication.getMainFrame(), tr("No GPX track available in layer to associate audio with."), tr("Error"), JOptionPane.ERROR_MESSAGE ); return; } // (a) try explicit timestamped waypoints - unless suppressed if (hasWaypoints && Config.getPref().getBoolean("marker.audiofromexplicitwaypoints", true)) { for (WayPoint w : layer.data.waypoints) { if (w.getTime() > firstTime) { waypoints.add(w); } else if (w.getTime() > 0.0) { timedMarkersOmitted = true; } } } // (b) try explicit waypoints without timestamps - unless suppressed if (hasWaypoints && Config.getPref().getBoolean("marker.audiofromuntimedwaypoints", true)) { for (WayPoint w : layer.data.waypoints) { if (waypoints.contains(w)) { continue; } WayPoint wNear = layer.data.nearestPointOnTrack(w.getEastNorth(ProjectionRegistry.getProjection()), snapDistance); if (wNear != null) { WayPoint wc = new WayPoint(w.getCoor()); wc.setTimeInMillis(wNear.getTimeInMillis()); if (w.attr.containsKey(GpxConstants.GPX_NAME)) { wc.put(GpxConstants.GPX_NAME, w.getString(GpxConstants.GPX_NAME)); } waypoints.add(wc); } else { untimedMarkersOmitted = true; } } } // (c) use explicitly named track points, again unless suppressed if (layer.data.tracks != null && Config.getPref().getBoolean("marker.audiofromnamedtrackpoints", false) && !layer.data.tracks.isEmpty()) { for (IGpxTrack track : layer.data.tracks) { for (IGpxTrackSegment seg : track.getSegments()) { for (WayPoint w : seg.getWayPoints()) { if (w.attr.containsKey(GpxConstants.GPX_NAME) || w.attr.containsKey(GpxConstants.GPX_DESC)) { waypoints.add(w); } } } } } // (d) use timestamp of file as location on track if (hasTracks && Config.getPref().getBoolean("marker.audiofromwavtimestamps", false)) { double lastModified = audioFile.lastModified() / 1000.0; // lastModified is in milliseconds double duration = AudioUtil.getCalibratedDuration(audioFile); double startTime = lastModified - duration; startTime = firstStartTime + (startTime - firstStartTime) / Config.getPref().getDouble("audio.calibration", 1.0 /* default, ratio */); WayPoint w1 = null; WayPoint w2 = null; for (IGpxTrack track : layer.data.tracks) { for (IGpxTrackSegment seg : track.getSegments()) { for (WayPoint w : seg.getWayPoints()) { if (startTime < w.getTime()) { w2 = w; break; } w1 = w; } if (w2 != null) { break; } } } if (w1 == null || w2 == null) { timedMarkersOmitted = true; } else { wayPointFromTimeStamp = new WayPoint(w1.getCoor().interpolate(w2.getCoor(), (startTime - w1.getTime()) / (w2.getTime() - w1.getTime()))); wayPointFromTimeStamp.setTimeInMillis((long) (startTime * 1000)); String name = audioFile.getName(); int dot = name.lastIndexOf('.'); if (dot > 0) { name = name.substring(0, dot); } wayPointFromTimeStamp.put(GpxConstants.GPX_NAME, name); waypoints.add(wayPointFromTimeStamp); } } // (e) analyse audio for spoken markers here, in due course // (f) simply add a single marker at the start of the track if ((Config.getPref().getBoolean("marker.audiofromstart") || waypoints.isEmpty()) && hasTracks) { boolean gotOne = false; for (IGpxTrack track : layer.data.tracks) { for (IGpxTrackSegment seg : track.getSegments()) { for (WayPoint w : seg.getWayPoints()) { WayPoint wStart = new WayPoint(w.getCoor()); wStart.put(GpxConstants.GPX_NAME, "start"); wStart.setTimeInMillis(w.getTimeInMillis()); waypoints.add(wStart); gotOne = true; break; } if (gotOne) { break; } } if (gotOne) { break; } } } // we must have got at least one waypoint now waypoints.sort(Comparator.naturalOrder()); firstTime = -1.0; // this time of the first waypoint, not first trackpoint for (WayPoint w : waypoints) { if (firstTime < 0.0) { firstTime = w.getTime(); } double offset = w.getTime() - firstTime; AudioMarker am = new AudioMarker(w.getCoor(), w, url, ml, w.getTime(), offset); // timeFromAudio intended for future use to shift markers of this type on synchronization if (w == wayPointFromTimeStamp) { am.timeFromAudio = true; } ml.data.add(am); } if (timedMarkersOmitted && !markers.timedMarkersOmitted) { JOptionPane.showMessageDialog(MainApplication.getMainFrame(), tr("Some waypoints with timestamps from before the start of the track or after the end were omitted or moved to the start.")); markers.timedMarkersOmitted = timedMarkersOmitted; } if (untimedMarkersOmitted && !markers.untimedMarkersOmitted) { JOptionPane.showMessageDialog(MainApplication.getMainFrame(), tr("Some waypoints which were too far from the track to sensibly estimate their time were omitted.")); markers.untimedMarkersOmitted = untimedMarkersOmitted; } } }