API VLCj: Criando Players de �udio/V�deo em Java

O VLC � um famoso player de v�deo open-source, que roda em v�rias plataformas e toca v�rios tipos de formato de �udio/v�deo.

Para esse artigo, utilizaremos a vers�o 1.1.11, que pode ser baixada aqui:

Nota: O sistema operacional ser� o Windows XP � 32 bits.

Nesse site , encontra-se a API VLCj, que permite interagir com o player VLC, acessando quase todas as suas funcionalidades. A vers�o utilizada ser� a 1.1.5.1, que pode ser baixada aqui.

Nota: Os c�digos fontes desse artigo tamb�m funcionam no Windows 64-bits. Por�m, � necess�rio baixar o JDK 32 bits da Oracle (mesmo que seu sistema seja 64 bits), e instalar a vers�o Win32 do VLC (link acima). Com isso os exemplos funcionar�o corretamente.

Figura 2. Executando v�deo no VLC

Configurando depend�ncias

Al�m da API VLCj, � necess�rio a biblioteca JNA (Java Native Access), pois o VLCj � dependente dela (faz uso de JNA para acessar as funç�es nativas do VLC).

Temos, portanto, que configurar esses 3 jars na nossa aplicaç�o:

Figura 3. Depend�ncias

Nota: JNA � uma API que permite acessar c�digo nativo a partir do Java. Para maiores informaç�es, clique aqui.

Testando a LibVlc

 
package br.com.devmedia.player;

import uk.co.caprica.vlcj.binding.LibVlc;

public class InformationLib {

    public static void main(String[] args) throws Exception {
        System.out.println("  version: {}" 
        + LibVlc.INSTANCE.libvlc_get_version());
        System.out.println(" compiler: {}" 
        + LibVlc.INSTANCE.libvlc_get_compiler());
        System.out.println("changeset: {}" 
        + LibVlc.INSTANCE.libvlc_get_changeset());
    }
}

Listagem 1. Obtendo informaç�es da LibVlc


   version: {}1.1.11 The Luggage
   compiler: {}gcc version 4.4.4 (GCC) 
   changeset: {}1.1.11-0-ge4974ac

Listagem 2. Sa�da

A LibVlc � uma interface que representa algumas das funç�es nativas do VLC (expostas atrav�s da libvlc.dll no Windows e libvlc.so no Linux). Essa interface possui um atributo INSTANCE, que � uma implementaç�o concreta da interface LibVlc, permitindo assim acessar todos os m�todos definidos nela. O javadoc com a listagem de todos os m�todos dispon�veis dessa interface, e tamb�m do restante da API, pode ser baixado nesse link.

Criando o player de �udio/v�deo


package br.com.devmedia.player;

import com.sun.jna.NativeLibrary;
import java.awt.BorderLayout;
import java.awt.Canvas;
import java.awt.Frame;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;

import java.util.ArrayList;
import java.util.List;
import uk.co.caprica.vlcj.player.MediaPlayerFactory;
import uk.co.caprica.vlcj.player.embedded.EmbeddedMediaPlayer;
import uk.co.caprica.vlcj.runtime.RuntimeUtil;
import uk.co.caprica.vlcj.runtime.windows.WindowsRuntimeUtil;

public class MinimalTestPlayer {

    public MinimalTestPlayer() {
        registerLibrary();
    }

    /**
     *  Executa arquivo de audio/video
     */
    public void play(final String filename) {
        final Canvas videoSurface = new Canvas();
        final Frame frame = buildFrame(videoSurface);
        final List<String> vlcArgs = 
        new ArrayList<String>();

        configureParameters(vlcArgs);

        final EmbeddedMediaPlayer mediaPlayer = 
        createPlayer(vlcArgs, videoSurface);
        mediaPlayer.playMedia(filename);
    }

    /**
     *  Importante: Informa onde est� a libvlc, 
     que contem as funç�es nativas de manipulacao do player
     * 
     *  Windows: libvlc.dll
     *  Linux: libvlc.so
     */
    private void registerLibrary() {
        NativeLibrary.addSearchPath("libvlc", 
        "C:\\Arquivos de programas\\VideoLAN\\VLC\\");

        // Windows 64 bits:
        // NativeLibrary.addSearchPath("libvlc", 
        "c:\\Program Files (x86)\\VideoLAN\\VLC\\");
    }

    /**
     * Cria frame onde ser� exibido o filme
     */
    private Frame buildFrame(final Canvas videoSurface) {
        final Frame f = new Frame("Test Player");
        f.setSize(800, 600);
        f.addWindowListener(new WindowAdapter() {

            @Override
            public void windowClosing(WindowEvent e) {
                System.exit(0);
            }
        });
        f.setLayout(new BorderLayout());
        f.add(videoSurface, BorderLayout.CENTER);
        f.setVisible(true);
        return f;
    }

    /**
     * Configura parametros do VLC
     */
    private void configureParameters(final 
    List<String> vlcArgs) {
        vlcArgs.add("--no-plugins-cache");
        vlcArgs.add("--no-video-title-show");
        vlcArgs.add("--no-snapshot-preview");

        // Importante, se esse parametro nao 
        for configurado no Windows, a aplicacao nao funcionara
        if (RuntimeUtil.isWindows()) {
            vlcArgs.add("--plugin-path=" 
            + WindowsRuntimeUtil.getVlcInstallDir() + "\\plugins");
        }
    }

    /**
     * Constroi o player
     */
    private EmbeddedMediaPlayer createPlayer(final 
    List<String> vlcArgs, final Canvas videoSurface) {
        final MediaPlayerFactory factory = 
        new MediaPlayerFactory(vlcArgs.toArray(new String[vlcArgs.size()]));
        EmbeddedMediaPlayer mediaPlayer = factory.newMediaPlayer(null);
        mediaPlayer.setVideoSurface(videoSurface);
        return mediaPlayer;
    }

    public static void main(String[] args) throws InterruptedException {
        MinimalTestPlayer player = new MinimalTestPlayer();
        // Pode ser MP4, AVI, MOV, MKV, WMA, MPG, MP3, WAV, etc.
        player.play("C:\\videos\\qualquer_video.mp4");

        // Aguarda janela do player ser fechada
        Thread.currentThread().join();
    }
}

Listagem 3. Player de �udio/v�deo

Figura 4. Execuç�o do Test Player

Vamos a explicaç�o dos trechos mais importantes do c�digo:


private void registerLibrary() {
    NativeLibrary.addSearchPath("libvlc", "C:\\Arquivos de programas\\VideoLAN\\VLC\\");

    // Windows 64 bits:
    // NativeLibrary.addSearchPath("libvlc", "c:\\Program Files (x86)\\VideoLAN\\VLC\\");
}

Listagem 4. Registrando DLL (ou Shared Library no Linux)

Atrav�s do m�todo addSearchPath da classe NativeLibray (do JNA), indicamos onde se encontra a biblioteca din�mica nativa que possuem a API de manipulaç�o do VLC.


/**
 * Configura parametros do VLC
 */
private void configureParameters(final List<String> vlcArgs) {
    vlcArgs.add("--no-plugins-cache");
    vlcArgs.add("--no-video-title-show");
    vlcArgs.add("--no-snapshot-preview");

    // Importante, se esse parametro nao for configurado no Windows, a aplicacao nao funcionara
    if (RuntimeUtil.isWindows()) {
        vlcArgs.add("--plugin-path=" + WindowsRuntimeUtil.getVlcInstallDir() + "\\plugins");
    }
}

Listagem 5. Configura os par�metros do VLC antes da execuç�o

Podemos passar uma s�rie de par�metros para o VLC, como por exemplo:

Tela cheia: --fullscreen
Configurar volume: -- volume
Desabilitando �udio: --noaudio
Definindo o tamanho da tela: --width, --height

Para ver a lista completa de par�metros, acesse esse site.

Essas configuraç�es tamb�m podem ser feitas programaticamente.

Nota: o par�metro -plugin-path � necess�rio no Windows, para que o VLC possa ser executado corretamente.


/**
 * Constroi o player
 */
private EmbeddedMediaPlayer createPlayer(final List<String> vlcArgs, final Canvas videoSurface) {
    final MediaPlayerFactory factory = new MediaPlayerFactory(vlcArgs.toArray(new String[vlcArgs.size()]));
    EmbeddedMediaPlayer mediaPlayer = factory.newMediaPlayer(null);
    mediaPlayer.setVideoSurface(videoSurface);
    return mediaPlayer;
}

Listagem 6. Criando o objeto mediaPlayer

A classe MediaPlayer � a classe principal com a qual os desenvolvedores devem lidar para interagir com o VLC. � atrav�s dela que acessamos todas as funcionalidades do player VLC, a saber:

funç�es de playlist
controles: play, pause, stop, etc
captura de frame
controles de ajuste de v�deo
controles de ajuste de �udio

Apesar de ser a super-classe de tudo que se relaciona a Players na API, para trabalharmos com o Canvas, devemos usar a classe EmbeddedMediaPlayer, que � a super-classe (abstrata) para as implementaç�es concretas do player.

Como o VLCj trabalha com m�ltiplas plataformas, ela faz uso de padr�o Factory (MediaPlayerFactory), para devolver a inst�ncia de media player adequada para a plataforma sobre a qual ela roda (LinuxEmbeddedMediaPlayer, MacEmbeddedMediaPlayer ou WindowsEmbeddedMediaPlayer).

Para ver de fato qual inst�ncia o MediaPlayerFactory devolve, acrescente a linha abaixo no m�todo createPlayer (antes do return, claro):


System.out.println (mediaPlayer.getClass().getName());

Listagem 7. Vendo o tipo de EmbeddedMediaPlayer


uk.co.caprica.vlcj.player.embedded.windows.WindowsEmbeddedMediaPlayer

Listagem 8. Sa�da (executando no Windows)

Nesse link, podem ser encontrados v�rios exemplos de c�digo fonte, demonstrando v�rias outras funcionalidades, como:

Tratamento de eventos do player (MediaPlayerEventAdapter)
Configuraç�o de teclas de atalho (AWTEventListener)
Interface de controle atrav�s de Swing / AWT (bot�es play / stop / next, etc)
Manipulaç�o de playlist�s
etc.

Conclus�o

Apesar dos exemplos terem sido executados no Windows, o mesmo � v�lido para o Linux (roda muito bem tamb�m). Agora, voc� pode criar seu pr�prio player de �udio/v�deo, customiz�-lo e at� mesmo control�-lo via internet, celular, etc.

Espero que esse artigo auxilie os desenvolvedores a explorar essa interessante API.

Refer�ncias:

API VLCj: Criando Players de �udio/V�deo em Java

Veja neste artigo como trabalhar com a API VLCj, para criar seus próprios players de áudio/vídeo para Windows/Linux em Java baseados no VLC.

Configurando depend�ncias

Testando a LibVlc

Criando o player de �udio/v�deo

Conclus�o

Artigos relacionados