frigg
1.1.2indexedShared Compose-based UI and structured per-target source sets for reusable app code, plus a native app entry point and simple build/run instructions.
0
Stars
—
Used by
dependents
—
Health
/ 100
Frigg 🧝🏻♀️
Uma biblioteca multiplataforma Kotlin para manipulação de áudio e vídeo, disponível para Android e iOS.
📖 Sobre Frigg
Frigg é uma figura da mitologia nórdica, sendo a principal deusa, esposa de Odin e deusa do amor, casamento, maternidade e lar. Assim como Frigg cuida e protege o lar, esta biblioteca foi criada para fornecer ferramentas confiáveis e cuidadosas para a manipulação de mídia em suas aplicações multiplataforma.
🎯 Descrição
Frigg é uma biblioteca Kotlin Multiplatform que oferece utilitários para manipulação de áudio e vídeo. Desenvolvida com foco em performance, confiabilidade e facilidade de uso, Frigg permite que você trabalhe com mídia de forma consistente em diferentes plataformas.
Plataformas Suportadas
- ✅ Android (minSdk 24)
- ✅ iOS (arm64, x64, simulator)
Tecnologias
- Kotlin Multiplatform: Código compartilhado entre plataformas
- LAME: Biblioteca nativa para codificação MP3
- Expect/Actual: Implementações específicas por plataforma
- Result API: Uso do padrão
Result<String>do Kotlin para tratamento de erros
✨ Funcionalidades
Atualmente Disponível
- 🎵 Conversão WAV para MP3
- Suporte a bitrate configurável (padrão: 128 kbps)
- Validação robusta de arquivos de entrada
- Sistema de exceções tipadas para tratamento de erros
- Validação de formato PCM 16-bit
- Verificação de permissões e espaço em disco
- API moderna usando
Result<String>do Kotlin
Em Desenvolvimento
- 🎬 Funcionalidades de manipulação de vídeo
- 🎚️ Mais formatos de áudio
- 🔧 Ferramentas adicionais de processamento
📦 Instalação
Gradle (Kotlin DSL)
Adicione o repositório Maven Central no seu build.gradle.kts:
repositories {
mavenCentral()
}
Adicione a dependência:
dependencies {
implementation("io.github.cardosofgui:frigg:1.1.0")
}
Gradle (Groovy)
repositories {
mavenCentral()
}
dependencies {
implementation 'io.github.cardosofgui:frigg:1.1.0'
}
🚀 Uso Básico
Android
No Android, você precisa inicializar a biblioteca no Application ou Activity:
import android.app.Application
import com.br.frigg.FriggConverter
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
FriggConverter.initialize(this)
}
}
Conversão de WAV para MP3
import com.br.frigg.FriggConverter
suspend fun convertAudio() {
val converter = FriggConverter()
val wavPath = "/path/to/audio.wav"
val result = converter.convertWavToMp3(wavPath, bitrate = 128)
result.onSuccess { mp3Path ->
println("Conversão bem-sucedida! MP3 salvo em: $mp3Path")
}.onFailure { exception ->
println("Erro na conversão: ")
exception.printStackTrace()
}
}
Exemplo Completo com Coroutines
Usando getOrElse
import com.br.frigg.FriggConverter
suspend fun convertWithFallback(wavPath: String): String {
val converter = FriggConverter()
return converter.convertWavToMp3(wavPath)
.getOrElse { exception ->
// Tratamento de erro personalizado
throw exception
}
}
Usando fold
import com.br.frigg.FriggConverter
suspend fun convertWithFold(wavPath: String): String {
val converter = FriggConverter()
return converter.convertWavToMp3(wavPath).fold(
onSuccess = { mp3Path -> mp3Path },
onFailure = { exception ->
throw exception
}
)
}
🛡️ Tratamento de Erros
Frigg utiliza um sistema completo de exceções tipadas que permite tratamento específico de diferentes tipos de erros:
Hierarquia de Exceções
FriggException (classe base)
├── StorageException
├── WritePermissionException
├── InvalidFileException
├── FileNotFoundException
├── ReadPermissionException
├── DirectoryCreationException
├── NativeLibraryException
├── ConversionException
├── EmptyFileException
└── UnknownFriggException
Exemplos de Tratamento
📚 API Reference
FriggConverter
Classe principal para conversão de áudio.
Métodos
convertWavToMp3(wavPath: String, bitrate: Int = 128): Result<String>
Converte um arquivo WAV para MP3.
Parâmetros:
wavPath: Caminho completo para o arquivo WAV de entradabitrate: Taxa de bits do MP3 de saída (padrão: 128 kbps)
Retorno:
Result.success(mp3Path: String): Conversão bem-sucedida, retorna o caminho do arquivo MP3 criadoResult.failure(exception: FriggException): Erro na conversão, contém uma exceção tipada
Requisitos do arquivo WAV:
- Formato: PCM 16-bit
- Extensão:
.wav - Arquivo válido e legível
Android:
- Método estático
initialize(context: Context)deve ser chamado antes do uso
Sistema de Exceções
FriggException
Classe base para todas as exceções do módulo Frigg.
open class FriggException(
message: String,
cause: Throwable? = null
) : Exception(message, cause)
StorageException
Lançada quando não há espaço suficiente em disco.
open class StorageException(
message: String,
val availableSpace: Long,
val requiredSpace: Long,
cause: Throwable? = null
) : FriggException(message, cause)
WritePermissionException
Lançada quando não há permissão para escrever no diretório de destino.
open class WritePermissionException(
message: String,
val path: String,
cause: Throwable? = null
) : FriggException(message, cause)
InvalidFileException
Lançada quando o arquivo WAV é inválido, corrompido ou em formato não suportado.
open class InvalidFileException(
message: String,
val filePath: String,
val reason: String,
cause: Throwable? = null
) : FriggException(message, cause)
FileNotFoundException
Lançada quando o arquivo WAV não foi encontrado.
open class FileNotFoundException(
message: String,
val filePath: String,
cause: Throwable? = null
) : FriggException(message, cause)
ReadPermissionException
Lançada quando não há permissão para ler o arquivo WAV.
open class ReadPermissionException(
message: String,
val filePath: String,
cause: Throwable? = null
) : FriggException(message, cause)
DirectoryCreationException
Lançada quando não é possível criar o diretório de saída.
open class DirectoryCreationException(
message: String,
val directoryPath: String,
cause: Throwable? = null
) : FriggException(message, cause)
NativeLibraryException
Lançada quando há erro ao carregar a biblioteca nativa.
open class NativeLibraryException(
message: String,
val libraryName: String? = null,
cause: Throwable? = null
) : FriggException(message, cause)
ConversionException
Lançada quando a conversão nativa falha.
open class ConversionException(
message: String,
val wavPath: String,
val mp3Path: String,
cause: Throwable? = null
) : FriggException(message, cause)
EmptyFileException
Lançada quando o arquivo MP3 foi criado mas está vazio ou não foi criado.
open class EmptyFileException(
message: String,
val filePath: String,
cause: Throwable? = null
) : FriggException(message, cause)
UnknownFriggException
Lançada para erros não mapeados.
open class UnknownFriggException(
message: String,
override val cause: Throwable
) : FriggException(message, cause)
⚙️ Requisitos
Android
- minSdk: 24 (Android 7.0)
- compileSdk: 36
- Kotlin: 2.2.20+
iOS
- iOS 13.0+
- Suporta dispositivos físicos (arm64) e simuladores (x64, arm64)
Kotlin
- Versão mínima: 2.2.20
🏗️ Estrutura do Projeto
Frigg utiliza a arquitetura expect/actual do Kotlin Multiplatform:
frigg/
├── src/
│ ├── commonMain/ # Código compartilhado
│ │ └── kotlin/
│ │ └── com/br/frigg/
│ │ ├── FriggConverter.kt # expect class
│ │ └── FriggException.kt # Sistema de exceções
│ ├── androidMain/ # Implementação Android
│ │ └── kotlin/
│ │ └── com/br/frigg/
│ │ └── FriggConverter.android.kt # actual class
│ └── iosMain/ # Implementação iOS
│ └── kotlin/
│ └── com/br/frigg/
│ └── FriggConverter.ios.kt # actual class
📝 Licença
Este projeto está licenciado sob a Licença GPL-2.0 - veja o arquivo LICENSE para detalhes.
🤝 Contribuindo
Contribuições são bem-vindas! Sinta-se à vontade para:
👤 Autor
Guilherme Cardoso
- GitHub: @CardosofGui
- Projeto: https://github.com/CardosofGui/frigg
🔗 Links Úteis
Feito com ❤️ usando Kotlin Multiplatform