pt-br:doc:tutorial

Iniciando no NCL Composer

2017-02-03T16:31:18-03:00

Esta página ainda está em desenvolvimento!

Iniciando no NCL Composer

Este documento apresenta uma introdução rápida que permitirá o desenvolvimento de aplicações interativas para TV digital usando o NCL Composer.

Aqui, nós assumimos que você já está com o NCL Composer instalado e funcionando em seu computador. Se você ainda não o instalou, vá para a página de download, baixe a última versão do NCL Composer e instale-a.

Primeiros passos

1. Criando um novo projeto

Quando você abre o NCL Composer, a tela da imagem abaixo aparece para você. Para criar seu próprio projeto, clique no botão Novo projeto ou vá para Arquivo→Novo projeto.

A fazer: captura de tela.

A fazer: O quê? Onde? Como? Quando?

2. O quê? Adicionando objetos de mídia

Depois de criar um novo projeto você será apresentado a várias visões do NCL Composer. Cada visão permite que você foque em uma tarefa específica enquanto cria a sua aplicação.

Por exemplo, vamos iniciar adicionando objetos de mídia. Para isso, vá para a Visão Estrutural e clique com o botão direito na área de canvas e então clique em Inserir→Mídia. Você pode também arrastar seus arquivos de mídia, diretamente do seu sistema de arquivos, e soltá-los no canvas da Visão Estrutural.

3. Onde? Criando regiões

Em breve.

4. Como? Trabalhando com propriedades ou descritores

Em breve.

5. Quando? Elos

Em breve.

Como compilar o NCL Composer a partir do código-fonte (< 0.1.x )

2017-02-03T16:31:18-03:00

Como compilar o NCL Composer a partir do código-fonte (< 0.1.x )

Para versões recentes (>= 0.2.x) vá para: Como compilar o NCL Composer a partir do código-fonte (>= 0.2.x).

Requisitos

Git (>= 1.7.x) http://git-scm.com/
Qt (>=4.7.x) http://qt.nokia.com/downloads/

Adquirindo o Código-fonte

Sobre o Git (retirado do sourceforge.net com tradução livre)

Git é uma ferramenta de Gestão de Código-fonte para desenvolvedores de software que suporta o desenvolvimento colaborativo dentro de uma equipe e o rastreamento de alterações do código-fonte ao longo do tempo.

Git é usado por desenvolvedores e usuários avançados que precisam das mudanças mais recentes do software (antes do lançamento da versão ocorrer). Usuários de software geralmente não precisam utilizar o Git; tipicamente, eles irão fazer o download da versão oficial lançada pelo projeto.

Desenvolvedores devem se familiarizar com Git lendo a Documentação do Git.

Acesso ao repositório Git do NCL Composer

A partir da linha de comando, você precisa somente executar os comandos abaixo para ter uma cópia do código-fonte do NCL Composer:

$ git clone http://git.telemidia.puc-rio.br/composer-core.git
$ git clone http://git.telemidia.puc-rio.br/composer-gui.git
$ git clone http://git.telemidia.puc-rio.br/composer-plugins.git

Compilando o Código-fonte

Para compilar o código do NCL Composer basta, a partir da linha de comando, executar os comandos abaixo para cada diretório criado no passo anterior:

$ qmake
$ make
$ make install

Se você está compilando no Windows, você provavelmente precisará trocar 'make' por:

$ mingw32-make

e 'make install' por:

$ mingw32-make install

Se você está compilando no Debian (ou Ubuntu), você provavelmente precisará trocar 'make install' por:

$ sudo make install

Se você está compilando no MAC, você provavelmente precisará trocar 'qmake' por:

$ qmake -spec macx-g++

e 'make install' por:

$ sudo make install

Compilando com característica de "Execução Remota"

Por padrão, você não irá compilar o NCL Composer com suporte à “execução remota”. Isso é feito de forma a não incluir dependências para a libssh2 dentro do código-fonte. Entretanto, se você quer usar esta característica, antes de compilar o subprojeto composer-gui, você deve seguir os seguintes passos:

1. Obtenha as bibliotecas relacionadas a LIBSSH2:

No Ubuntu/Debian você pode instalar estas dependências com o seguinte comando:

$ sudo apt-get install libssh2-1-dev libgcrypt11-dev

No Windows você pode fazer o download a partir de:

http://composer.telemidia.puc-rio.br/downloads/deps/nclcomposer-gui-0.1.1-deps.zip

e descomprimir os arquivos dentro do diretório composer-gui. Você terá, então, algo com essa estrutura (observe a pasta para libssh):

  + composer-core
      ...
  + composer-gui
    + data
    + deps
      + libssh2-1.3.0
    + images
    + include
    + translations
    ...
  + composer-plugins
      ...

No Mac OS X você precisará primeiro instalar um software chamado port (http://www.macports.org/), que é basicamente um pacote de gerenciamento de sistema que simplifica a instalação de softwares no Mac OS X. Assim, você poderá instalar as dependências com o seguinte comando:

$ sudo port install libssh2 libgcrypt

2. Descomente (remova o caracter #) as seguintes linhas dentro de composer-gui/Composer.pro:

#CONFIG += runssh_on

Testando

Para testar o NCL Composer, você precisará executar o seguinte comando:

Windows:

$ C:\composer.exe

Linux

$ /usr/local/bin/composer

MAC OS X

$ open /Applications/Composer.app

Problemas?

Se você tem problemas com algum dos passos anteriores veja nossa seção de Perguntas Frequentes e, se ainda assim você não tiver conseguido resolver seu problema, contate-nos.

Como compilar o NCL Composer a partir do código-fonte (>= 0.2.x)

2017-02-03T16:31:18-03:00

Como compilar o NCL Composer a partir do código-fonte (>= 0.2.x)

Para versões anteriores (< 0.1.x): Como compilar o NCL Composer a partir do código-fonte (< 0.1.x).

Requisitos

Git (>= 1.7.x) http://git-scm.com/
Qt (>=4.7.x) http://qt.nokia.com/downloads/

Adquirindo o Código-fonte

Sobre o Git (retirado do sourceforge.net com tradução livre)

Desenvolvedores devem se familiarizar com Git lendo a Documentação do Git.

Acesso ao repositório Git do NCL Composer

A partir da linha de comando, você precisa somente executar o comando abaixo para ter uma cópia do código-fonte do NCL Composer:

$ git clone http://git.telemidia.puc-rio.br/nclcomposer.git

Compilando o Código-fonte

Para compilar o código do NCL Composer basta, a partir da linha de comando, executar os comandos abaixo para cada diretório criado no passo anterior:

$ qmake
$ make install

Se você está compilando no Windows, você provavelmente precisará trocar 'make' por:

$ mingw32-make

e 'make install' por:

$ mingw32-make install

Se você está compilando no Debian (ou Ubuntu), você provavelmente precisará trocar 'make install' por:

$ sudo make install

Se você está compilando no MAC, você provavelmente precisará trocar 'qmake' por:

$ qmake -spec macx-g++

e 'make install' por:

$ sudo make install

Compilando com característica de "Execução Remota"

1. Obtenha as bibliotecas relacionadas a LIBSSH2:

No Ubuntu/Debian você pode instalar estas dependências com o seguinte comando:

$ sudo apt-get install libssh2-1-dev libgcrypt11-dev

No Windows você pode fazer o download a partir de:

http://composer.telemidia.puc-rio.br/downloads/deps/nclcomposer-gui-0.1.1-deps.zip

e descomprimir os arquivos dentro do diretório composer-gui. Você terá, então, algo com essa estrutura (observe a pasta para libssh):

  + composer-core
      ...
  + composer-gui
    + data
    + deps
      + libssh2-1.3.0
    + images
    + include
    + translations
    ...
  + composer-plugins
      ...

$ sudo port install libssh2 libgcrypt

2. Descomente (remova o caracter #) as seguintes linhas dentro de composer-gui/Composer.pro:

#CONFIG += runssh_on

Testando

Para testar o NCL Composer, você precisará executar o seguinte comando:

Windows:

$ C:\composer.exe

Linux

$ /usr/local/bin/composer

MAC OS X

$ open /Applications/Composer.app

Problemas?

Se você tem problemas com algum dos passos anteriores veja nossa seção de Perguntas Frequentes e, se ainda assim você não tiver conseguido resolver seu problema, contate-nos.

Como configurar o NCL Composer para executar sua aplicação

2017-02-03T16:31:18-03:00

Como configurar o NCL Composer para executar sua aplicação

Existem duas formas principais de executar sua aplicação NCL a partir da interface do NCL Composer:

No executável do Ginga-NCL instalado localmente; ou
em uma máquina remota (e.g. Ginga Virtual Set-top Box);

Executando no Ginga-NCL localmente

Para configurar o NCL Composer para executar em uma instalação local do Ginga selecione o Menu: Edit→Preferences→Run Configuration.

A tela a seguir será apresentada:

Nessa janela, marque a opção Local: Ginga Player e na caixa de texto Command coloque o caminho completo do executável Ginga-NCL.

A caixa de texto Arguments pode ser preenchida com os parâmetros que o executável do Ginga-NCL será chamado. Você deve colocar um parâmetro em cada uma das linhas.

Executando no Ginga Virtual Set-top Box

Para executar no Ginga Virtual Set-top Box escolha a opção: Remote: Ginga-NCL Virtual Set-top Box.

Usualmente o único parâmetro a ser modificado é o endereço IP da máquina virtual contendo o Ginga-NCL Virtual Set-top Box. Sugerimos que você modifique os outros parâmetros apenas se souber exatamente o que está fazendo.

How to: Create an NCL Composer Plugin

2017-02-03T16:31:18-03:00

How to: Create an NCL Composer Plugin

This page is a draft

This tutorial assumes you are familiar with C/C++ programming languages and have basic knowledge about Qt framework (mainly the qmake build system and signals & slots mechanism).

What is a Plugin?

A plugin is a piece of software distributed separated from other software (the main or host) aiming to extend its functionalities. In order to allow extensions and customizations NCL Composer architecture is based on plugins.

A common way to extend the NCL Composer functionalities is creating new Views to documents being developed. A View is a plugin that brings out a representation of this document (e.g. showing its entities in a tree, or showing how this document is represented in a timeline, etc.).

NCL Composer Plugins

An NCL Composer plugins is based on two main C++ interfaces that must to be implemented: IPluginFactory and IPlugin.

IPluginFactory

The IPluginFactory is responsible to create new instances of IPlugin's, and keep global informations about the plugin, like its vendor, version, etc. Every time a document is open, the NCL Composer will try to create a new instance of the plugin calling IPluginFactory's method. But if your plugin is a singleton, you can always returns the same instance.

IPlugin

The IPlugin is the NCL Composer plugin itself. When a document is open by NCL Composer, a new instance of the plugin will be required by NCL Composer. The IPlugin is linked with the Document instance and will be called every time this document is changed. Likewise, the IPlugin is also able to require changes in the Document.

An example: Debug Plugin

As a simple example, let's create a Debug Plugin. This plugin will print all the messages that it receives from NCL Composer core.

First of all, let's create our DebugConsolePlugin.h:

#ifndef DEBUGCONSOLEPLUGIN_H
#define DEBUGCONSOLEPLUGIN_H
 
#include <QObject>
#include <core/extensions/IPlugin.h>
 
using namespace composer::core::extension::plugin;
 
class DebugConsolePlugin : public IPlugin
{
        Q_OBJECT
    private:
        QWidget *window;
 
    public:
        explicit DebugConsolePlugin();
        ~DebugConsolePlugin();
 
        QWidget* getWidget();
	bool init();
 
    public slots:
        void onEntityAdded(QString ID, Entity *);
        void onEntityChanged(QString ID, Entity *);
        void onEntityRemoved(QString ID, QString entityID);
 
        void errorMessage(QString error);
};
 
#endif // DEBUGCONSOLEPLUGIN_H

And the DebugConsole.cpp:

#include "DebugConsolePlugin.h"
 
DebugConsolePlugin::DebugConsolePlugin()
{
  // Do nothing
}
 
DebugConsolePlugin::~DebugConsolePlugin()
{
  // Do nothing
}
 
void DebugConsolePlugin::init()
{
  // Do nothing
}
 
QWidget* DebugConsolePlugin::getWidget()
{
    return NULL; /*This tell to NCL Composer that our plugin doesn't have a GUI*/
}
 
void DebugConsolePlugin::onEntityAdded(QString ID, Entity *entity)
{
    QString line = "PLUGIN (" + ID + ") added the Entity (" +
                   entity->getType() + " - " + entity->getUniqueId() +")";
    qDebug() << line;
}
 
void DebugConsolePlugin::errorMessage(QString error)
{
    qDebug() << "ERROR:" << error;
}
 
void DebugConsolePlugin::onEntityChanged(QString ID, Entity * entity)
{
    QString line = "PLUGIN (" + ID + ") changed the Entity (" +
                    entity->getType() + " - " + entity->getUniqueId() +")";
    qDebug() << line;
}
 
void DebugConsolePlugin::onEntityRemoved(QString ID, QString entityID)
{
    QString line = "PLUGIN (" + ID + ") removed Entity (" +
                   entityID + ")";
    qDebug() << line;
}

In order to NCL Composer know how to create new instances of our DebugPlugin, we have to provide a Factory class:

#ifndef DEBUGCONSOLE_H
#define DEBUGCONSOLE_H
 
#include "DebugConsole_global.h"
#include "DebugConsolePlugin.h"
 
#include <core/extensions/IPluginFactory.h>
using namespace composer::extension;
 
class DebugConsoleFactory : public QObject,
                            public IPluginFactory
{
    Q_OBJECT
    Q_INTERFACES(IPluginFactory)
 
    public:
         DebugConsoleFactory();
         ~DebugConsoleFactory();
         IPlugin* createPluginInstance();
         void releasePluginInstance(IPlugin *);
 
         /* Global information about DebugPlugin. */
         QString id() const {return "br.puc-rio.telemidia.DebugPlugin";};
         QString name() const {return "Debug Plugin";};
 
         QString version() { return "0.1"; }
         QString compatVersion() {return "0.1";}
         QString vendor() {return "Telemidia Lab";}
         QString copyright() {return "Telemidia/PUC-Rio";}
         QString description() {return "Debug Console View prints all the messages send by NCL Composer to plugins.";}
         QString url() {return "http://composer.telemidia.puc-rio.br/debug";}
         QString category() {return "Debug";}
 
};

#include "DebugConsoleFactory.h"
 
namespace composer {
    namespace plugin {
        namespace debug {
 
DebugConsoleFactory::DebugConsoleFactory()
{
  //Do nothing
}
 
DebugConsoleFactory::~DebugConsoleFactory()
{
  //Do nothing
}
 
IPlugin* DebugConsoleFactory::createPluginInstance()
{
    return new DebugConsolePlugin();
}
 
void DebugConsoleFactory::releasePluginInstance(IPlugin *plugin)
{
    DebugConsolePlugin *debug = qobject_cast<DebugConsolePlugin*>(plugin);
 
    if (debug)
    {
        delete debug;
        debug = NULL;
    }
 
}
 
// This is very important, and will allow to Qt framework recognize your
// plugin
Q_EXPORT_PLUGIN2(DebugConsole,DebugConsoleFactory)
 
} } } //end namespace

NCL Composer Tutorials

2017-02-03T16:31:18-03:00

NCL Composer Tutorials

Esta página tem o objetivo de reunir posts e tutoriais relacionados ao NCL Composer. Se você encontrar qualquer problema, tiver alguma sugestão, ou quiser incluir um tutorial criado por você, por favor contate-nos.

pt-br:doc:tutorial

Iniciando no NCL Composer

Iniciando no NCL Composer

Primeiros passos

1. Criando um novo projeto

2. O quê? Adicionando objetos de mídia

3. Onde? Criando regiões

4. Como? Trabalhando com propriedades ou descritores

5. Quando? Elos

Como compilar o NCL Composer a partir do código-fonte (< 0.1.x )

Como compilar o NCL Composer a partir do código-fonte (< 0.1.x )

Requisitos

Adquirindo o Código-fonte

Sobre o Git (retirado do sourceforge.net com tradução livre)

Acesso ao repositório Git do NCL Composer

Compilando o Código-fonte

Compilando com característica de "Execução Remota"

Testando

Problemas?

Como compilar o NCL Composer a partir do código-fonte (>= 0.2.x)

Como compilar o NCL Composer a partir do código-fonte (>= 0.2.x)

Requisitos

Adquirindo o Código-fonte

Sobre o Git (retirado do sourceforge.net com tradução livre)

Acesso ao repositório Git do NCL Composer

Compilando o Código-fonte

Compilando com característica de "Execução Remota"

Testando

Problemas?

Como configurar o NCL Composer para executar sua aplicação

Como configurar o NCL Composer para executar sua aplicação

Executando no Ginga-NCL localmente

Executando no Ginga Virtual Set-top Box

How to: Create an NCL Composer Plugin

How to: Create an NCL Composer Plugin

What is a Plugin?

NCL Composer Plugins

IPluginFactory

IPlugin

An example: Debug Plugin

NCL Composer Tutorials

NCL Composer Tutorials

Para Usuários

For Desenvolvedores