Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 05cdc7ba authored by Andrew Lewis's avatar Andrew Lewis
Browse files

Add media item info to editing metrics 

Each `MediaItemInfo` instance stores information about media formats
contained in it. The same type is used for input and output media.

Also store the operation types on the editing ended event to determine
what operations were applied as part of editing (eg., transcoding). This
will be added to the logging proto in a follow-up change.

Test: atest MediaMetricsAtomTests#testEditingEndedEvent_transcodeAndClip
Bug: 297487694
Change-Id: I9b9fec335c2f0216e89e08f2e9e4df5ef54d2799
parent ee704763

core/api/current.txt

+73 −0
Original line number Diff line number Diff line
@@ -25869,6 +25869,9 @@ package android.media.metrics { 
    method public int describeContents();

    method public int getErrorCode();

    method public int getFinalState();

    method @NonNull public java.util.List<android.media.metrics.MediaItemInfo> getInputMediaItemInfos();

    method public long getOperationTypes();

    method @Nullable public android.media.metrics.MediaItemInfo getOutputMediaItemInfo();

    method public void writeToParcel(@NonNull android.os.Parcel, int);

    field @NonNull public static final android.os.Parcelable.Creator<android.media.metrics.EditingEndedEvent> CREATOR;

    field public static final int ERROR_CODE_AUDIO_PROCESSING_FAILED = 18; // 0x12
@@ -25893,14 +25896,25 @@ package android.media.metrics { 
    field public static final int FINAL_STATE_CANCELED = 2; // 0x2

    field public static final int FINAL_STATE_ERROR = 3; // 0x3

    field public static final int FINAL_STATE_SUCCEEDED = 1; // 0x1

    field public static final long OPERATION_TYPE_AUDIO_EDIT = 8L; // 0x8L

    field public static final long OPERATION_TYPE_AUDIO_TRANSCODE = 2L; // 0x2L

    field public static final long OPERATION_TYPE_AUDIO_TRANSMUX = 32L; // 0x20L

    field public static final long OPERATION_TYPE_PAUSED = 64L; // 0x40L

    field public static final long OPERATION_TYPE_RESUMED = 128L; // 0x80L

    field public static final long OPERATION_TYPE_VIDEO_EDIT = 4L; // 0x4L

    field public static final long OPERATION_TYPE_VIDEO_TRANSCODE = 1L; // 0x1L

    field public static final long OPERATION_TYPE_VIDEO_TRANSMUX = 16L; // 0x10L

    field public static final int TIME_SINCE_CREATED_UNKNOWN = -1; // 0xffffffff

  }















  @FlaggedApi("com.android.media.editing.flags.add_media_metrics_editing") public static final class EditingEndedEvent.Builder {















    ctor public EditingEndedEvent.Builder(int);













    method @NonNull public android.media.metrics.EditingEndedEvent.Builder addInputMediaItemInfo(@NonNull android.media.metrics.MediaItemInfo);













    method @NonNull public android.media.metrics.EditingEndedEvent.Builder addOperationType(long);















    method @NonNull public android.media.metrics.EditingEndedEvent build();















    method @NonNull public android.media.metrics.EditingEndedEvent.Builder setErrorCode(int);















    method @NonNull public android.media.metrics.EditingEndedEvent.Builder setMetricsBundle(@NonNull android.os.Bundle);













    method @NonNull public android.media.metrics.EditingEndedEvent.Builder setOutputMediaItemInfo(@NonNull android.media.metrics.MediaItemInfo);















    method @NonNull public android.media.metrics.EditingEndedEvent.Builder setTimeSinceCreatedMillis(@IntRange(from=android.media.metrics.EditingEndedEvent.TIME_SINCE_CREATED_UNKNOWN) long);















  }























@@ -25920,6 +25934,65 @@ package android.media.metrics {













    field @NonNull public static final android.media.metrics.LogSessionId LOG_SESSION_ID_NONE;















  }



























  @FlaggedApi("com.android.media.editing.flags.add_media_metrics_editing") public final class MediaItemInfo implements android.os.Parcelable {













    method public int describeContents();













    method public int getAudioChannelCount();













    method public long getAudioSampleCount();













    method public int getAudioSampleRateHz();













    method public long getClipDurationMillis();













    method @NonNull public java.util.List<java.lang.String> getCodecNames();













    method @Nullable public String getContainerMimeType();













    method public long getDataTypes();













    method public long getDurationMillis();













    method @NonNull public java.util.List<java.lang.String> getSampleMimeTypes();













    method public int getSourceType();













    method public int getVideoDataSpace();













    method public float getVideoFrameRate();













    method public long getVideoSampleCount();













    method @NonNull public android.util.Size getVideoSize();













    method public void writeToParcel(@NonNull android.os.Parcel, int);













    field @NonNull public static final android.os.Parcelable.Creator<android.media.metrics.MediaItemInfo> CREATOR;













    field public static final long DATA_TYPE_AUDIO = 4L; // 0x4L













    field public static final long DATA_TYPE_CUE_POINTS = 128L; // 0x80L













    field public static final long DATA_TYPE_DEPTH = 16L; // 0x10L













    field public static final long DATA_TYPE_GAIN_MAP = 32L; // 0x20L













    field public static final long DATA_TYPE_GAPLESS = 256L; // 0x100L













    field public static final long DATA_TYPE_HIGH_DYNAMIC_RANGE_VIDEO = 1024L; // 0x400L













    field public static final long DATA_TYPE_HIGH_FRAME_RATE = 64L; // 0x40L













    field public static final long DATA_TYPE_IMAGE = 1L; // 0x1L













    field public static final long DATA_TYPE_METADATA = 8L; // 0x8L













    field public static final long DATA_TYPE_SPATIAL_AUDIO = 512L; // 0x200L













    field public static final long DATA_TYPE_VIDEO = 2L; // 0x2L













    field public static final int SOURCE_TYPE_CAMERA = 2; // 0x2













    field public static final int SOURCE_TYPE_EDITING_SESSION = 3; // 0x3













    field public static final int SOURCE_TYPE_GALLERY = 1; // 0x1













    field public static final int SOURCE_TYPE_GENERATED = 7; // 0x7













    field public static final int SOURCE_TYPE_LOCAL_FILE = 4; // 0x4













    field public static final int SOURCE_TYPE_REMOTE_FILE = 5; // 0x5













    field public static final int SOURCE_TYPE_REMOTE_LIVE_STREAM = 6; // 0x6













    field public static final int SOURCE_TYPE_UNSPECIFIED = 0; // 0x0













    field public static final int VALUE_UNSPECIFIED = -1; // 0xffffffff













  }

























  @FlaggedApi("com.android.media.editing.flags.add_media_metrics_editing") public static final class MediaItemInfo.Builder {













    ctor public MediaItemInfo.Builder();













    method @NonNull public android.media.metrics.MediaItemInfo.Builder addCodecName(@NonNull String);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder addDataType(long);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder addSampleMimeType(@NonNull String);













    method @NonNull public android.media.metrics.MediaItemInfo build();













    method @NonNull public android.media.metrics.MediaItemInfo.Builder setAudioChannelCount(@IntRange(from=0) int);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder setAudioSampleCount(@IntRange(from=0) long);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder setAudioSampleRateHz(@IntRange(from=0) int);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder setClipDurationMillis(long);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder setContainerMimeType(@NonNull String);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder setDurationMillis(long);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder setSourceType(int);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder setVideoDataSpace(int);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder setVideoFrameRate(@FloatRange(from=0) float);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder setVideoSampleCount(@IntRange(from=0) long);













    method @NonNull public android.media.metrics.MediaItemInfo.Builder setVideoSize(@NonNull android.util.Size);













  }



























  public final class MediaMetricsManager {















    method @NonNull public android.media.metrics.BundleSession createBundleSession();















    method @NonNull public android.media.metrics.EditingSession createEditingSession();

























media/java/android/media/metrics/EditingEndedEvent.java



+138
−13




























Original line number
Diff line number
Diff line








@@ -20,6 +20,7 @@ import static com.android.media.editing.flags.Flags.FLAG_ADD_MEDIA_METRICS_EDITI













import android.annotation.FlaggedApi;















import android.annotation.IntDef;















import android.annotation.IntRange;













import android.annotation.LongDef;















import android.annotation.NonNull;















import android.annotation.Nullable;















import android.os.Bundle;









@@ -27,6 +28,8 @@ import android.os.Parcel;













import android.os.Parcelable;































import java.lang.annotation.Retention;













import java.util.ArrayList;













import java.util.List;















import java.util.Objects;































/** Event for an editing operation having ended. */










@@ -156,14 +159,66 @@ public final class EditingEndedEvent extends Event implements Parcelable {













    @SuppressWarnings("HidingField") // Hiding field from superclass as for playback events.















    private final long mTimeSinceCreatedMillis;





























    private final ArrayList<MediaItemInfo> mInputMediaItemInfos;













    @Nullable private final MediaItemInfo mOutputMediaItemInfo;



























    /** @hide */













    @LongDef(













            prefix = {"OPERATION_TYPE_"},













            flag = true,













            value = {













                OPERATION_TYPE_VIDEO_TRANSCODE,













                OPERATION_TYPE_AUDIO_TRANSCODE,













                OPERATION_TYPE_VIDEO_EDIT,













                OPERATION_TYPE_AUDIO_EDIT,













                OPERATION_TYPE_VIDEO_TRANSMUX,













                OPERATION_TYPE_AUDIO_TRANSMUX,













                OPERATION_TYPE_PAUSED,













                OPERATION_TYPE_RESUMED,













            })













    @Retention(java.lang.annotation.RetentionPolicy.SOURCE)













    public @interface OperationType {}



























    /** Input video was decoded and re-encoded. */













    public static final long OPERATION_TYPE_VIDEO_TRANSCODE = 1;



























    /** Input audio was decoded and re-encoded. */













    public static final long OPERATION_TYPE_AUDIO_TRANSCODE = 1L << 1;



























    /** Input video was edited. */













    public static final long OPERATION_TYPE_VIDEO_EDIT = 1L << 2;



























    /** Input audio was edited. */













    public static final long OPERATION_TYPE_AUDIO_EDIT = 1L << 3;



























    /** Input video samples were writted (muxed) directly to the output file without transcoding. */













    public static final long OPERATION_TYPE_VIDEO_TRANSMUX = 1L << 4;



























    /** Input audio samples were written (muxed) directly to the output file without transcoding. */













    public static final long OPERATION_TYPE_AUDIO_TRANSMUX = 1L << 5;



























    /** The editing operation was paused before it completed. */













    public static final long OPERATION_TYPE_PAUSED = 1L << 6;



























    /** The editing operation resumed a previous (paused) operation. */













    public static final long OPERATION_TYPE_RESUMED = 1L << 7;



























    private final @OperationType long mOperationTypes;





























    private EditingEndedEvent(















            @FinalState int finalState,















            @ErrorCode int errorCode,















            long timeSinceCreatedMillis,













            ArrayList<MediaItemInfo> inputMediaItemInfos,













            @Nullable MediaItemInfo outputMediaItemInfo,













            @OperationType long operationTypes,















            @NonNull Bundle extras) {















        mFinalState = finalState;















        mErrorCode = errorCode;















        mTimeSinceCreatedMillis = timeSinceCreatedMillis;













        mInputMediaItemInfos = inputMediaItemInfos;













        mOutputMediaItemInfo = outputMediaItemInfo;













        mOperationTypes = operationTypes;















        mMetricsBundle = extras.deepCopy();















    }


























@@ -194,6 +249,23 @@ public final class EditingEndedEvent extends Event implements Parcelable {













        return mTimeSinceCreatedMillis;















    }





























    /** Gets information about the input media items, or an empty list if unspecified. */













    @NonNull













    public List<MediaItemInfo> getInputMediaItemInfos() {













        return new ArrayList<>(mInputMediaItemInfos);













    }



























    /** Gets information about the output media item, or {@code null} if unspecified. */













    @Nullable













    public MediaItemInfo getOutputMediaItemInfo() {













        return mOutputMediaItemInfo;













    }



























    /** Gets a set of flags describing the types of operations performed. */













    public @OperationType long getOperationTypes() {













        return mOperationTypes;













    }





























    /**















     * Gets metrics-related information that is not supported by dedicated methods.















     *









@@ -208,7 +280,7 @@ public final class EditingEndedEvent extends Event implements Parcelable {













    @Override















    @NonNull















    public String toString() {













        return "PlaybackErrorEvent { "













        return "EditingEndedEvent { "















                + "finalState = "















                + mFinalState















                + ", "









@@ -217,6 +289,15 @@ public final class EditingEndedEvent extends Event implements Parcelable {













                + ", "















                + "timeSinceCreatedMillis = "















                + mTimeSinceCreatedMillis













                + ", "













                + "inputMediaItemInfos = "













                + mInputMediaItemInfos













                + ", "













                + "outputMediaItemInfo = "













                + mOutputMediaItemInfo













                + ", "













                + "operationTypes = "













                + mOperationTypes















                + " }";















    }

























@@ -227,12 +308,21 @@ public final class EditingEndedEvent extends Event implements Parcelable {













        EditingEndedEvent that = (EditingEndedEvent) o;















        return mFinalState == that.mFinalState















                && mErrorCode == that.mErrorCode













                && Objects.equals(mInputMediaItemInfos, that.mInputMediaItemInfos)













                && Objects.equals(mOutputMediaItemInfo, that.mOutputMediaItemInfo)













                && mOperationTypes == that.mOperationTypes















                && mTimeSinceCreatedMillis == that.mTimeSinceCreatedMillis;















    }































    @Override















    public int hashCode() {













        return Objects.hash(mFinalState, mErrorCode, mTimeSinceCreatedMillis);













        return Objects.hash(













                mFinalState,













                mErrorCode,













                mInputMediaItemInfos,













                mOutputMediaItemInfo,













                mOperationTypes,













                mTimeSinceCreatedMillis);















    }































    @Override









@@ -240,6 +330,9 @@ public final class EditingEndedEvent extends Event implements Parcelable {













        dest.writeInt(mFinalState);















        dest.writeInt(mErrorCode);















        dest.writeLong(mTimeSinceCreatedMillis);













        dest.writeTypedList(mInputMediaItemInfos);













        dest.writeTypedObject(mOutputMediaItemInfo, /* parcelableFlags= */ 0);













        dest.writeLong(mOperationTypes);















        dest.writeBundle(mMetricsBundle);















    }

























@@ -249,15 +342,14 @@ public final class EditingEndedEvent extends Event implements Parcelable {













    }































    private EditingEndedEvent(@NonNull Parcel in) {













        int finalState = in.readInt();













        int errorCode = in.readInt();













        long timeSinceCreatedMillis = in.readLong();













        Bundle metricsBundle = in.readBundle();



























        mFinalState = finalState;













        mErrorCode = errorCode;













        mTimeSinceCreatedMillis = timeSinceCreatedMillis;













        mMetricsBundle = metricsBundle;













        mFinalState = in.readInt();













        mErrorCode = in.readInt();













        mTimeSinceCreatedMillis = in.readLong();













        mInputMediaItemInfos = new ArrayList<>();













        in.readTypedList(mInputMediaItemInfos, MediaItemInfo.CREATOR);













        mOutputMediaItemInfo = in.readTypedObject(MediaItemInfo.CREATOR);













        mOperationTypes = in.readLong();













        mMetricsBundle = in.readBundle();















    }































    public static final @NonNull Creator<EditingEndedEvent> CREATOR =









@@ -277,8 +369,11 @@ public final class EditingEndedEvent extends Event implements Parcelable {













    @FlaggedApi(FLAG_ADD_MEDIA_METRICS_EDITING)















    public static final class Builder {















        private final @FinalState int mFinalState;













        private final ArrayList<MediaItemInfo> mInputMediaItemInfos;















        private @ErrorCode int mErrorCode;















        private long mTimeSinceCreatedMillis;













        @Nullable private MediaItemInfo mOutputMediaItemInfo;













        private @OperationType long mOperationTypes;















        private Bundle mMetricsBundle;































        /**









@@ -290,6 +385,7 @@ public final class EditingEndedEvent extends Event implements Parcelable {













            mFinalState = finalState;















            mErrorCode = ERROR_CODE_NONE;















            mTimeSinceCreatedMillis = TIME_SINCE_CREATED_UNKNOWN;













            mInputMediaItemInfos = new ArrayList<>();















            mMetricsBundle = new Bundle();















        }

























@@ -312,20 +408,49 @@ public final class EditingEndedEvent extends Event implements Parcelable {













            return this;















        }





























        /** Adds information about a media item that was input to the editing operation. */













        public @NonNull Builder addInputMediaItemInfo(@NonNull MediaItemInfo mediaItemInfo) {













            mInputMediaItemInfos.add(Objects.requireNonNull(mediaItemInfo));













            return this;













        }



























        /** Sets information about the output media item. */













        public @NonNull Builder setOutputMediaItemInfo(@NonNull MediaItemInfo mediaItemInfo) {













            mOutputMediaItemInfo = Objects.requireNonNull(mediaItemInfo);













            return this;













        }



























        /**













         * Adds an operation type to the set of operations performed.













         *













         * @param operationType A type of operation performed as part of this editing operation.













         */













        public @NonNull Builder addOperationType(@OperationType long operationType) {













            mOperationTypes |= operationType;













            return this;













        }





























        /**















         * Sets metrics-related information that is not supported by dedicated methods.















         *















         * <p>Used for backwards compatibility by the metrics infrastructure.















         */















        public @NonNull Builder setMetricsBundle(@NonNull Bundle metricsBundle) {













            mMetricsBundle = metricsBundle;













            mMetricsBundle = Objects.requireNonNull(metricsBundle);















            return this;















        }































        /** Builds an instance. */















        public @NonNull EditingEndedEvent build() {















            return new EditingEndedEvent(













                    mFinalState, mErrorCode, mTimeSinceCreatedMillis, mMetricsBundle);













                    mFinalState,













                    mErrorCode,













                    mTimeSinceCreatedMillis,













                    mInputMediaItemInfos,













                    mOutputMediaItemInfo,













                    mOperationTypes,













                    mMetricsBundle);















        }















    }





























}
























media/java/android/media/metrics/MediaItemInfo.java
0 → 100644



+565
−0


























File added.
Preview size limit exceeded, changes collapsed.
























services/core/java/com/android/server/media/metrics/MediaMetricsManagerService.java



+328
−0


























File changed.
Preview size limit exceeded, changes collapsed.