2 * Sonitus - TimeCounterFilter.java - Copyright © 2013 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sonitus.data.filter;
20 import java.io.IOException;
21 import java.util.concurrent.atomic.AtomicLong;
22 import java.util.concurrent.atomic.AtomicReference;
24 import net.pterodactylus.sonitus.data.Filter;
25 import net.pterodactylus.sonitus.data.Metadata;
28 * {@link Filter} implementation that uses the number of bytes that have been
29 * {@link #process(byte[]) processed} together with the {@link Metadata} to
30 * calculate how long a source is already playing.
32 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
34 public class TimeCounterFilter extends DummyFilter {
36 /** The byte counter. */
37 private final AtomicLong counter = new AtomicLong();
39 /** The parent’s metdata. */
40 private final AtomicReference<Metadata> parentMetadata = new AtomicReference<Metadata>();
42 /** Whether to reset the counter on a metadata update. */
43 private final boolean resetOnMetadataUpdate;
45 /** The last displayed timestamp. */
46 private final AtomicLong lastTimestamp = new AtomicLong(-1);
49 * Creates a new time counter filter that automatically resets the counter when
50 * the metadata is {@link #metadataUpdated(Metadata) updated}.
53 * The name of the filter
55 public TimeCounterFilter(String name) {
60 * Creates a new time counter filter.
63 * The name of the filter
64 * @param resetOnMetadataUpdate
65 * {@code true} if the counter should automatically be reset if the metadata
66 * is updated, {@code false} otherwise
68 public TimeCounterFilter(String name, boolean resetOnMetadataUpdate) {
70 this.resetOnMetadataUpdate = resetOnMetadataUpdate;
78 * Returns the number of milliseconds worth of data that has been passed into
79 * {@link #process(byte[])}. If no metadata has yet been set, {@code 0} is
82 * @return The number of milliseconds the current source is already playing
84 public long getMillis() {
85 Metadata metadata = super.metadata();
86 if (metadata == null) {
89 return 1000 * counter.get() / (metadata.channels() * metadata.frequency() * 2);
92 /** Resets the counter to 0. */
98 // DUMMYFILTER METHODS
102 public void metadataUpdated(Metadata metadata) {
103 parentMetadata.set(metadata);
104 if (resetOnMetadataUpdate) {
107 updateTimestamp(true);
111 public void process(byte[] buffer) throws IOException {
112 super.process(buffer);
113 counter.getAndAdd(buffer.length);
114 updateTimestamp(false);
121 /** Updates the timestamp in the metadata. */
122 private void updateTimestamp(boolean now) {
123 long timestamp = getMillis() / 1000;
124 if (now || (lastTimestamp.get() != timestamp)) {
125 super.metadataUpdated(parentMetadata.get().comment(String.format("%02d:%02d", timestamp / 60, timestamp % 60)));
126 lastTimestamp.set(timestamp);