This class is used to filter wanted data according to the filter's configuration. - * TODO: remove - */ - public class Filter { - FilterCallback mCallback; - private Filter() {} - } - /** * Opens a filter object based on the given types and buffer size. * @@ -570,8 +537,6 @@ public final class Tuner implements AutoCloseable { * executor is used if it's {@code null}. * @param cb the callback to receive notifications from filter. * @return the opened filter. {@code null} if the operation failed. - * - * @hide */ @RequiresPermission(android.Manifest.permission.ACCESS_TV_TUNER) @Nullable @@ -582,7 +547,7 @@ public final class Tuner implements AutoCloseable { Filter filter = nativeOpenFilter( mainType, TunerUtils.getFilterSubtype(mainType, subType), bufferSize); if (filter != null) { - filter.mCallback = cb; + filter.setCallback(cb); if (mHandler == null) { mHandler = createEventHandler(); } diff --git a/media/java/android/media/tv/tuner/TunerConstants.java b/media/java/android/media/tv/tuner/TunerConstants.java index 20b77e6635866..b76a14d66313b 100644 --- a/media/java/android/media/tv/tuner/TunerConstants.java +++ b/media/java/android/media/tv/tuner/TunerConstants.java @@ -47,37 +47,6 @@ public final class TunerConstants { */ public static final int INVALID_STREAM_ID = Constants.Constant.INVALID_STREAM_ID; - /** @hide */ - @IntDef(flag = true, prefix = "FILTER_STATUS_", value = {FILTER_STATUS_DATA_READY, - FILTER_STATUS_LOW_WATER, FILTER_STATUS_HIGH_WATER, FILTER_STATUS_OVERFLOW}) - @Retention(RetentionPolicy.SOURCE) - public @interface FilterStatus {} - - /** - * The status of a filter that the data in the filter buffer is ready to be read. - */ - public static final int FILTER_STATUS_DATA_READY = Constants.DemuxFilterStatus.DATA_READY; - /** - * The status of a filter that the amount of available data in the filter buffer is at low - * level. - * - * The value is set to 25 percent of the buffer size by default. It can be changed when - * configuring the filter. - */ - public static final int FILTER_STATUS_LOW_WATER = Constants.DemuxFilterStatus.LOW_WATER; - /** - * The status of a filter that the amount of available data in the filter buffer is at high - * level. - * The value is set to 75 percent of the buffer size by default. It can be changed when - * configuring the filter. - */ - public static final int FILTER_STATUS_HIGH_WATER = Constants.DemuxFilterStatus.HIGH_WATER; - /** - * The status of a filter that the filter buffer is full and newly filtered data is being - * discarded. - */ - public static final int FILTER_STATUS_OVERFLOW = Constants.DemuxFilterStatus.OVERFLOW; - /** @hide */ @Retention(RetentionPolicy.SOURCE) diff --git a/media/java/android/media/tv/tuner/dvr/Dvr.java b/media/java/android/media/tv/tuner/dvr/Dvr.java index a17773c08a63d..320013056b2f6 100644 --- a/media/java/android/media/tv/tuner/dvr/Dvr.java +++ b/media/java/android/media/tv/tuner/dvr/Dvr.java @@ -20,8 +20,8 @@ import android.annotation.BytesLong; import android.annotation.IntDef; import android.annotation.NonNull; import android.hardware.tv.tuner.V1_0.Constants; -import android.media.tv.tuner.Tuner.Filter; import android.media.tv.tuner.TunerConstants.Result; +import android.media.tv.tuner.filter.Filter; import android.os.ParcelFileDescriptor; import java.lang.annotation.Retention; diff --git a/media/java/android/media/tv/tuner/dvr/DvrCallback.java b/media/java/android/media/tv/tuner/dvr/DvrCallback.java index ee0cfa7ddc2eb..0a4029f51fa23 100644 --- a/media/java/android/media/tv/tuner/dvr/DvrCallback.java +++ b/media/java/android/media/tv/tuner/dvr/DvrCallback.java @@ -16,8 +16,8 @@ package android.media.tv.tuner.dvr; -import android.media.tv.tuner.TunerConstants.FilterStatus; import android.media.tv.tuner.dvr.Dvr.PlaybackStatus; +import android.media.tv.tuner.filter.Filter; /** * Callback interface for receiving information from DVR interfaces. @@ -28,7 +28,7 @@ public interface DvrCallback { /** * Invoked when record status changed. */ - void onRecordStatusChanged(@FilterStatus int status); + void onRecordStatusChanged(@Filter.Status int status); /** * Invoked when playback status changed. */ diff --git a/media/java/android/media/tv/tuner/dvr/DvrSettings.java b/media/java/android/media/tv/tuner/dvr/DvrSettings.java index 49e875afc5ac6..7dec578b4b92d 100644 --- a/media/java/android/media/tv/tuner/dvr/DvrSettings.java +++ b/media/java/android/media/tv/tuner/dvr/DvrSettings.java @@ -22,8 +22,8 @@ import android.annotation.NonNull; import android.annotation.RequiresPermission; import android.content.Context; import android.hardware.tv.tuner.V1_0.Constants; -import android.media.tv.tuner.TunerConstants.FilterStatus; import android.media.tv.tuner.TunerUtils; +import android.media.tv.tuner.filter.Filter; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @@ -124,7 +124,7 @@ public class DvrSettings { * Sets status mask. */ @NonNull - public Builder setStatusMask(@FilterStatus int statusMask) { + public Builder setStatusMask(@Filter.Status int statusMask) { this.mStatusMask = statusMask; return this; } diff --git a/media/java/android/media/tv/tuner/filter/AlpFilterConfiguration.java b/media/java/android/media/tv/tuner/filter/AlpFilterConfiguration.java index fcca6a1615c34..197dd22d3b45d 100644 --- a/media/java/android/media/tv/tuner/filter/AlpFilterConfiguration.java +++ b/media/java/android/media/tv/tuner/filter/AlpFilterConfiguration.java @@ -65,7 +65,7 @@ public class AlpFilterConfiguration extends FilterConfiguration { @Override public int getType() { - return FilterConfiguration.FILTER_TYPE_ALP; + return Filter.TYPE_ALP; } /** diff --git a/media/java/android/media/tv/tuner/filter/DownloadEvent.java b/media/java/android/media/tv/tuner/filter/DownloadEvent.java index 591e4e54aaaeb..44c8447514d5e 100644 --- a/media/java/android/media/tv/tuner/filter/DownloadEvent.java +++ b/media/java/android/media/tv/tuner/filter/DownloadEvent.java @@ -16,8 +16,6 @@ package android.media.tv.tuner.filter; -import android.media.tv.tuner.Tuner.Filter; - /** * Filter event sent from {@link Filter} objects with download type. * diff --git a/media/java/android/media/tv/tuner/filter/Filter.java b/media/java/android/media/tv/tuner/filter/Filter.java index 3f6154be6af6a..06de6e8a83c78 100644 --- a/media/java/android/media/tv/tuner/filter/Filter.java +++ b/media/java/android/media/tv/tuner/filter/Filter.java @@ -20,8 +20,8 @@ import android.annotation.BytesLong; import android.annotation.IntDef; import android.annotation.NonNull; import android.annotation.Nullable; +import android.annotation.SystemApi; import android.hardware.tv.tuner.V1_0.Constants; -import android.media.tv.tuner.Tuner.FilterCallback; import android.media.tv.tuner.TunerConstants.Result; import java.lang.annotation.Retention; @@ -34,6 +34,7 @@ import java.lang.annotation.RetentionPolicy; * * @hide */ +@SystemApi public class Filter implements AutoCloseable { /** @hide */ @IntDef(prefix = "TYPE_", @@ -72,91 +73,107 @@ public class Filter implements AutoCloseable { public @interface Subtype {} /** * Filter subtype undefined. - * @hide */ public static final int SUBTYPE_UNDEFINED = 0; /** * Section filter subtype. - * @hide */ public static final int SUBTYPE_SECTION = 1; /** * PES filter subtype. - * @hide */ public static final int SUBTYPE_PES = 2; /** * Audio filter subtype. - * @hide */ public static final int SUBTYPE_AUDIO = 3; /** * Video filter subtype. - * @hide */ public static final int SUBTYPE_VIDEO = 4; /** * Download filter subtype. - * @hide */ public static final int SUBTYPE_DOWNLOAD = 5; /** * Record filter subtype. - * @hide */ public static final int SUBTYPE_RECORD = 6; /** * TS filter subtype. - * @hide */ public static final int SUBTYPE_TS = 7; /** * PCR filter subtype. - * @hide */ public static final int SUBTYPE_PCR = 8; /** * TEMI filter subtype. - * @hide */ public static final int SUBTYPE_TEMI = 9; /** * MMTP filter subtype. - * @hide */ public static final int SUBTYPE_MMTP = 10; /** * NTP filter subtype. - * @hide */ public static final int SUBTYPE_NTP = 11; /** * Payload filter subtype. - * @hide */ public static final int SUBTYPE_IP_PAYLOAD = 12; /** * IP filter subtype. - * @hide */ public static final int SUBTYPE_IP = 13; /** * Payload through filter subtype. - * @hide */ public static final int SUBTYPE_PAYLOAD_THROUGH = 14; /** * TLV filter subtype. - * @hide */ public static final int SUBTYPE_TLV = 15; /** * PTP filter subtype. - * @hide */ public static final int SUBTYPE_PTP = 16; + + /** @hide */ + @IntDef(flag = true, prefix = "STATUS_", value = {STATUS_DATA_READY, STATUS_LOW_WATER, + STATUS_HIGH_WATER, STATUS_OVERFLOW}) + @Retention(RetentionPolicy.SOURCE) + public @interface Status {} + + /** + * The status of a filter that the data in the filter buffer is ready to be read. + */ + public static final int STATUS_DATA_READY = Constants.DemuxFilterStatus.DATA_READY; + /** + * The status of a filter that the amount of available data in the filter buffer is at low + * level. + * + * The value is set to 25 percent of the buffer size by default. It can be changed when + * configuring the filter. + */ + public static final int STATUS_LOW_WATER = Constants.DemuxFilterStatus.LOW_WATER; + /** + * The status of a filter that the amount of available data in the filter buffer is at high + * level. + * The value is set to 75 percent of the buffer size by default. It can be changed when + * configuring the filter. + */ + public static final int STATUS_HIGH_WATER = Constants.DemuxFilterStatus.HIGH_WATER; + /** + * The status of a filter that the filter buffer is full and newly filtered data is being + * discarded. + */ + public static final int STATUS_OVERFLOW = Constants.DemuxFilterStatus.OVERFLOW; + + private long mNativeContext; private FilterCallback mCallback; private final int mId; @@ -171,6 +188,7 @@ public class Filter implements AutoCloseable { private native int nativeRead(byte[] buffer, long offset, long size); private native int nativeClose(); + // Called by JNI private Filter(int id) { mId = id; } @@ -178,6 +196,15 @@ public class Filter implements AutoCloseable { private void onFilterStatus(int status) { } + /** @hide */ + public void setCallback(FilterCallback cb) { + mCallback = cb; + } + /** @hide */ + public FilterCallback getCallback() { + return mCallback; + } + /** * Configures the filter. * @@ -241,7 +268,10 @@ public class Filter implements AutoCloseable { } /** - * Flushes the filter. Data in filter buffer is cleared. + * Flushes the filter. + * + *
The data which is already produced by filter but not consumed yet will + * be cleared. * * @return result status of the operation. */ @@ -251,7 +281,7 @@ public class Filter implements AutoCloseable { } /** - * Copies filtered data from filter buffer to the given byte array. + * Copies filtered data from filter output to the given byte array. * * @param buffer the buffer to store the filtered data. * @param offset the index of the first byte in {@code buffer} to write. diff --git a/media/java/android/media/tv/tuner/filter/FilterCallback.java b/media/java/android/media/tv/tuner/filter/FilterCallback.java index 888adc5f51bb1..2ad6bd1dfb813 100644 --- a/media/java/android/media/tv/tuner/filter/FilterCallback.java +++ b/media/java/android/media/tv/tuner/filter/FilterCallback.java @@ -17,13 +17,14 @@ package android.media.tv.tuner.filter; import android.annotation.NonNull; -import android.media.tv.tuner.TunerConstants.FilterStatus; +import android.annotation.SystemApi; /** * Callback interface for receiving information from the corresponding filters. * * @hide */ +@SystemApi public interface FilterCallback { /** * Invoked when there are filter events. @@ -38,5 +39,5 @@ public interface FilterCallback { * @param filter the corresponding filter whose status is changed. * @param status the new status of the filter. */ - void onFilterStatusChanged(@NonNull Filter filter, @FilterStatus int status); + void onFilterStatusChanged(@NonNull Filter filter, @Filter.Status int status); } diff --git a/media/java/android/media/tv/tuner/filter/FilterConfiguration.java b/media/java/android/media/tv/tuner/filter/FilterConfiguration.java index c901e2b591850..33c9b41842832 100644 --- a/media/java/android/media/tv/tuner/filter/FilterConfiguration.java +++ b/media/java/android/media/tv/tuner/filter/FilterConfiguration.java @@ -19,7 +19,6 @@ package android.media.tv.tuner.filter; import android.annotation.IntDef; import android.annotation.Nullable; import android.annotation.SystemApi; -import android.hardware.tv.tuner.V1_0.Constants; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @@ -32,37 +31,6 @@ import java.lang.annotation.RetentionPolicy; @SystemApi public abstract class FilterConfiguration { - /** - * TODO: moved to Filter. Remove it here. - * @hide - */ - @IntDef(prefix = "FILTER_TYPE_", value = - {FILTER_TYPE_TS, FILTER_TYPE_MMTP, FILTER_TYPE_IP, FILTER_TYPE_TLV, FILTER_TYPE_ALP}) - @Retention(RetentionPolicy.SOURCE) - public @interface FilterType {} - - /** - * TS filter type. - */ - public static final int FILTER_TYPE_TS = Constants.DemuxFilterMainType.TS; - /** - * MMTP filter type. - */ - public static final int FILTER_TYPE_MMTP = Constants.DemuxFilterMainType.MMTP; - /** - * IP filter type. - */ - public static final int FILTER_TYPE_IP = Constants.DemuxFilterMainType.IP; - /** - * TLV filter type. - */ - public static final int FILTER_TYPE_TLV = Constants.DemuxFilterMainType.TLV; - /** - * ALP filter type. - */ - public static final int FILTER_TYPE_ALP = Constants.DemuxFilterMainType.ALP; - - /** @hide */ @IntDef(prefix = "PACKET_TYPE_", value = {PACKET_TYPE_IPV4, PACKET_TYPE_COMPRESSED, PACKET_TYPE_SIGNALING}) @@ -97,7 +65,7 @@ public abstract class FilterConfiguration { * Gets filter configuration type. * @hide */ - @FilterType + @Filter.Type public abstract int getType(); /** @hide */ diff --git a/media/java/android/media/tv/tuner/filter/IpFilterConfiguration.java b/media/java/android/media/tv/tuner/filter/IpFilterConfiguration.java index 98edf1035df39..e16bac8f3dc8d 100644 --- a/media/java/android/media/tv/tuner/filter/IpFilterConfiguration.java +++ b/media/java/android/media/tv/tuner/filter/IpFilterConfiguration.java @@ -45,7 +45,7 @@ public class IpFilterConfiguration extends FilterConfiguration { @Override public int getType() { - return FilterConfiguration.FILTER_TYPE_IP; + return Filter.TYPE_IP; } /** diff --git a/media/java/android/media/tv/tuner/filter/IpPayloadEvent.java b/media/java/android/media/tv/tuner/filter/IpPayloadEvent.java index 09489ed86fef8..7d8f0ce4d2bbd 100644 --- a/media/java/android/media/tv/tuner/filter/IpPayloadEvent.java +++ b/media/java/android/media/tv/tuner/filter/IpPayloadEvent.java @@ -16,8 +16,6 @@ package android.media.tv.tuner.filter; -import android.media.tv.tuner.Tuner.Filter; - /** * Filter event sent from {@link Filter} objects with IP payload type. * diff --git a/media/java/android/media/tv/tuner/filter/MediaEvent.java b/media/java/android/media/tv/tuner/filter/MediaEvent.java index 0b5c56ba4429d..6b69aca0e4142 100644 --- a/media/java/android/media/tv/tuner/filter/MediaEvent.java +++ b/media/java/android/media/tv/tuner/filter/MediaEvent.java @@ -18,7 +18,6 @@ package android.media.tv.tuner.filter; import android.annotation.BytesLong; import android.annotation.Nullable; -import android.media.tv.tuner.Tuner.Filter; /** * Filter event sent from {@link Filter} objects with media type. diff --git a/media/java/android/media/tv/tuner/filter/MmtpFilterConfiguration.java b/media/java/android/media/tv/tuner/filter/MmtpFilterConfiguration.java index 248f23a1797b8..dfca949b1905c 100644 --- a/media/java/android/media/tv/tuner/filter/MmtpFilterConfiguration.java +++ b/media/java/android/media/tv/tuner/filter/MmtpFilterConfiguration.java @@ -35,7 +35,7 @@ public class MmtpFilterConfiguration extends FilterConfiguration { @Override public int getType() { - return FilterConfiguration.FILTER_TYPE_MMTP; + return Filter.TYPE_MMTP; } /** diff --git a/media/java/android/media/tv/tuner/filter/MmtpRecordEvent.java b/media/java/android/media/tv/tuner/filter/MmtpRecordEvent.java index 7f379944b2071..f4cf83336137c 100644 --- a/media/java/android/media/tv/tuner/filter/MmtpRecordEvent.java +++ b/media/java/android/media/tv/tuner/filter/MmtpRecordEvent.java @@ -16,8 +16,6 @@ package android.media.tv.tuner.filter; -import android.media.tv.tuner.Tuner.Filter; - /** * Filter event sent from {@link Filter} objects with MMTP type. * diff --git a/media/java/android/media/tv/tuner/filter/PesEvent.java b/media/java/android/media/tv/tuner/filter/PesEvent.java index 60251bf919add..081b7661c4338 100644 --- a/media/java/android/media/tv/tuner/filter/PesEvent.java +++ b/media/java/android/media/tv/tuner/filter/PesEvent.java @@ -16,8 +16,6 @@ package android.media.tv.tuner.filter; -import android.media.tv.tuner.Tuner.Filter; - /** * Filter event sent from {@link Filter} objects with PES type. * diff --git a/media/java/android/media/tv/tuner/filter/SectionEvent.java b/media/java/android/media/tv/tuner/filter/SectionEvent.java index e211ddab05303..ff1249296efd4 100644 --- a/media/java/android/media/tv/tuner/filter/SectionEvent.java +++ b/media/java/android/media/tv/tuner/filter/SectionEvent.java @@ -17,7 +17,6 @@ package android.media.tv.tuner.filter; import android.annotation.SystemApi; -import android.media.tv.tuner.Tuner.Filter; /** * Filter event sent from {@link Filter} objects with section type. diff --git a/media/java/android/media/tv/tuner/filter/TemiEvent.java b/media/java/android/media/tv/tuner/filter/TemiEvent.java index 031fa5c4cb0ea..b5bd49920715e 100644 --- a/media/java/android/media/tv/tuner/filter/TemiEvent.java +++ b/media/java/android/media/tv/tuner/filter/TemiEvent.java @@ -17,7 +17,6 @@ package android.media.tv.tuner.filter; import android.annotation.NonNull; -import android.media.tv.tuner.Tuner.Filter; /** * Filter event sent from {@link Filter} objects for Timed External Media Information (TEMI) data. diff --git a/media/java/android/media/tv/tuner/filter/TlvFilterConfiguration.java b/media/java/android/media/tv/tuner/filter/TlvFilterConfiguration.java index eb97fc04362ce..0a0e1a8540ec4 100644 --- a/media/java/android/media/tv/tuner/filter/TlvFilterConfiguration.java +++ b/media/java/android/media/tv/tuner/filter/TlvFilterConfiguration.java @@ -40,7 +40,7 @@ public class TlvFilterConfiguration extends FilterConfiguration { @Override public int getType() { - return FilterConfiguration.FILTER_TYPE_TLV; + return Filter.TYPE_TLV; } /** diff --git a/media/java/android/media/tv/tuner/filter/TsFilterConfiguration.java b/media/java/android/media/tv/tuner/filter/TsFilterConfiguration.java index 5c38cfa70eb38..f186de60b74ae 100644 --- a/media/java/android/media/tv/tuner/filter/TsFilterConfiguration.java +++ b/media/java/android/media/tv/tuner/filter/TsFilterConfiguration.java @@ -39,7 +39,7 @@ public class TsFilterConfiguration extends FilterConfiguration { @Override public int getType() { - return FilterConfiguration.FILTER_TYPE_TS; + return Filter.TYPE_TS; } /** diff --git a/media/java/android/media/tv/tuner/filter/TsRecordEvent.java b/media/java/android/media/tv/tuner/filter/TsRecordEvent.java index 1b8485e22dcfb..4dd843274227c 100644 --- a/media/java/android/media/tv/tuner/filter/TsRecordEvent.java +++ b/media/java/android/media/tv/tuner/filter/TsRecordEvent.java @@ -16,8 +16,6 @@ package android.media.tv.tuner.filter; -import android.media.tv.tuner.Tuner.Filter; - /** * Filter event sent from {@link Filter} objects for TS record data.