/*
 * Copyright (c) 2023 New Vector Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.element.android.libraries.mediaupload.api

import android.net.Uri

interface MediaPreProcessor {
    /**
     * Given a [uri] and [mimeType], pre-processes the media before it's uploaded, resizing, transcoding, and removing sensitive info from its metadata.
     * If [deleteOriginal] is `true`, the file reference by the [uri] will be automatically deleted too when this process finishes.
     * @return a [Result] with the [MediaUploadInfo] containing all the info needed to begin the upload.
     */
    suspend fun process(
        uri: Uri,
        mimeType: String,
        deleteOriginal: Boolean = false,
        compressIfPossible: Boolean
    ): Result<MediaUploadInfo>

    data class Failure(override val cause: Throwable?) : Exception(cause)
}
