Multimedia online - manual

phpRS Plug-in modul: Multimedia online v0.9.3beta

O pluginu
Instalace
Upgrade
Jak na to
Licence a podpora, FAQ

O pluginu

Hledal jsem možnost, jak přehrávat hudbu a videa online na webech, které spravuji. Našel jsem si mně docela vyhovující flashové přehrávače a pro zjednodušení jsem si napsal tento plugin, který jsem se rozhodl zveřejnit, neb si myslím, že jistě najde využití i na dalších webech. Plugin můžete používat pro přehrávání hudby ve formátu mp3 a videí ve formátu flv. Písničky můžete přidávat jako samostatné nebo předem uspořádané do playlistů. Současný stav pluginu je prozatím konečný, žádný další zásadní vývoj v nejbližší době neplánuji. Možné jsou pouze drobné úpravy a vylepšení.

Instalace

Vytvoření databáze

Tabulky v databázi vytvoříte pomocí souboru multimedia sql, který najdete ve složce sql. Naimportujte ho buď v adminu phpRS v části Záloha DB příkazem Import SQL nebo přímo v phpMyAdminu. Pokud provedete vše správně, měli byste mít v databázi dvě nové tabulky:

rs_multimediaconf (konfigurační tabulka pluginu)

rs_multimedia (tabulka pro ukládání multimediálních souborů)

Nahrání souborů na web

Soubory rozbalte do rootu webu tak, jak jsou nastíněny v balíčku ve složce web. Ukázka struktury (kurzívou adresáře):

- root

- multimedia.php

- plugin

- multimedia

-admin_multimedia.php
- plugin.php
- rozcestnik.php
- multiblok.php

- lang

- cz

- admin_sl_multimedia_cz.php

- sk

- admin_sl_multimedia_sk.php (u v.0.9beta není součástí).

- multimedia

- fmp3.swf
- fvp.swf
- xspf_ev.swf
- img

- noplay.gif (pro nepřehratelné soubory)
- play.gif (pro přehrávání samostatných mp3)
- playlist.gif (pro přehrávání playlistů)
- video.gif (pro přehrávání videí)
- film.jpg (předdefinovaný úvodní obrázek pro video - zobrazení v bloku)

Přidání do phpRS

Plugin do phpRS přidáte v adminu v konfiguraci v části správa pluginů. Do políčka Cesta k novému pluginu uveďte cestu k instalačnímu souboru plugin.php tj. plugin/multimedia/plugin.php ,
Po úspěšné instalaci se v adminu objeví nové tlačítko Multimedia online. Na webu se plugin volá souborem multimedia.php, proto si ho přidejte do vašeho webového menu. V části přidání nového bloku přibyde nová položka na seznamu šablon bloku - Multimedia online - blok.

CSS a obrázky

Obsah souboru multimedia.css překopírujte na konec souboru css ve vašem layoutu, např. freestyle.css, a dle potřeby upravte, aby vše odpovídalo vašemu designu. Nebudou-li vám vyhovovat obrázky přibalené k pluginu pro odkaz na přehrání, můžete je bez problému nahradit vlastními, jen je nutné zachovat správné názvy (viz. výše struktura pluginu).

Upgrade

Jakou máte verzi zjistíte otevřením manuálu nebo např. souboru multimedia.php, kde je uvedeno číslo verze.

Historie verzí a postup upgrade

0.9
    - vydána 10. 8. 2007

0.9.1
    - vydána 30. 10. 2007
    - oprava drobných chyb
    - upgrade nahrazením php souborů

0.9.2
    - nevydána, přímý upgrade až na verzi 0.9.3
    - přidání sledování počtu přehrání
    - přidána možnost výběru mezi absolutní a relativní adresací
    - změna v databázi

0.9.3
    - vydána 18. 8. 2008
    - oprava chyby při zobrazování dle levelu
    - opravy drobných chyb (změna názvů přehrávačů na malá písmena atd.)
    - úpravy kódu
    - postup upgrade: 0.9 nebo 0.9.1 => 0.9.3:

Kompletně nahraďte všechny soubory novými, včetně přehrávačů
Aplikujte na databázi script ze souboru update091-092.sql buď pomocí adminu phpRS, v modulu Záloha DB, Import SQL skriptu, nebo pomocí phpMyAdmin na vašem hostingu.

Jak na to

Příprava webu

Na webu si můžete pro práci s pluginem připravit zvláštní strukturu adresářů, do kterých budete jednotlivé soubory nahrávat např.:

- storage

-mp3

pisnicka1.mp3

pisnicka2.mp3

-cd

- album A

pisena.mp3

pisenb.mp3

pisenc.mp3

playlist.xml

- album B

- video

film1.flv

film1.jpg

Soubory bude pravděpodobně nutno nahrávat na web přes ftp s ohledem na možná omezení velikosti uploadovaných souborů přes webové rozhraní. Z tohoto důvodu není součástí pluginu možnost uploadu souborů přes web.

Příprava MP3

Mp3 soubory není nutno nijak zvlášť upravovat, jen je třeba mít na zřeteli jejich velikost, kterou můžete upravit vhodně zvolenou kompresí při převodu.

Příprava playlistů

Playlisty jsou soubory xml s popisky a cestami k souborům mp3. V balíku je přibalen ukázkový soubor playlist_example.xml. Ten můžete požít jako vzor a po jeho úpravě ho přidat k mp3. Doporučuji soubory mp3 a jim určený playlist ukládat do stejné složky viz. výše návrh struktury. Soubory xml můžete editovat ve svém oblíbeném editoru např. pspad či notepad;) Při úpravě dodržujte strukturu dokumentu, jinak může dojít k chybě při přehrávání.

Obsah souboru playlist.xml + popis:

<?xml version="1.0" encoding="UTF-8"?>
<playlist version="1" xmlns="http://xspf.org/ns/0/">
    <title>Nazev playlistu</title> //jedná se jen o vnitřní název, nikde se nezobrazuje
    <annotation>Popis playlistu</annotation> //nikde se nezobrazuje
    <info>http://www.autor.com</info> //tento odkaz můžete nechat zobrazit při přehrávání, otevírá se do nového okna, nastavuje se při přídávání playlistu v adminu, zde není nutno vyplňovat, odkaz se načítá z nastavení u jednotlivcýh tracků
    <trackList> //otevírá seznam tracků

        <track> //začátek popisu jednoho tracku, tuto část si můžete včetně otevíracího a zavírací tagu nakopírovat v playlistu v libovolném množství
            <title>Autor/Song</title> //titul tracku, doporučuji zapisovat včetně autora, jinak se autor nezobrazí, formát je libovolný např. autor/song, autor - song atd.
            <annotation>Popis</annotation> //popis je pouze pro vlastní potřebu, nezobrazuje se, není nutno vyplňovat
            <location>http://www.domena.com/mp3/cd/song.mp3</location> //cesta k souboru, můžete adresovat relativně i absolutně
            <image>http://www.domena.com/mp3/cd/album.jpg</image> //obrázek zobrazený v přehrávači při přehrávání písničky, formát jpg, rozměry 80x80px, adresova tlze relativně i absolutně
            <info>http://www.autor.com</info> //tento odkaz můžete nechat zobrazit při přehrávání, otevírá se do nového okna, nastavuje se při přídávání playlistu v adminu, chcete-li odkaz zobrazit, u jednotlivých racků ho vždy mějte vyplnění, defaultní odkaz nahoře neumí přehrávač předávat
        </track> //koncový tag pro track

    </trackList>

</playlist>

Příprava videí

Videa je třeba převést do formátu .flv (flash video). Rozměry videa musí být 320x240 px. Pro konverzi videa můžete použít např. program SUPER 2007. Dobré zkušenosti mám s jednoduchým programem Free Riva FLV Encoder, kde si můžete nastavit rozměry, bitrate videa i zvuku, ořez apod. Občas ale mívá problémy se vstupními formáty. Program zvládá i export obrázků z videa, kde si můžete vyexportovat první obrázek z videa a ten pak použít v přehrávači. Další info viz. níže. Postupem převodu se tu zabývat nebudu, to budete muset zvládnout sami. Riva Encoder se dá ovládat takřka intuitivně;)

Konfigurace

Barva přehrávače, pozadí, textu - u barev se používá nastavení barvy ve formátu #000000. Doporučuji používat některou z 256 bezpečných barev pro web. Do formulářů vyplňujte barvy bez znaku # (plugin si ho na potřebná místa doplní sám) a v šestičíselném tvaru. Barvu pozadí můžete nastavit stejnou jako u přehrávače, v zobrazení není příliš viditelná, s vyjímkou přehrávače playlistů, kde od sebe opticky odděluje přehrávač, seznam písní a obrázek.. Barvu textu volte kontrastní proti barvě přehrávače.

Zobrazit jako - pop-up okno - v tomto nastavení se přehrávač otevře v novém předdefinovaném okně a hudba tak může hrát na pozadí, zatímco návštěvník "browsí" po webu.

- novou stránku - přehrávač se otevře v rámci webu jako nová stránka

Obrázek pro video - úvodní obrázek, který se zobrazí při nastavení videa automatické přehrání ne. Tento obrázek můžete nahradit vlastním o velikosti 320x240 px a ve formátu jpg. Nastavte relativní cestu k obrázku.

Počet položek v bloku - počet zobrazených nejnověji přidaných médií. Blok zobrazuje media bez rozdílu typu.

Počet položek ve výpisu na webu - nastavení po kolika položkách se má na webu stránkovat

Level:
Zobrazit nepřístupná media - jednotlivým médiím můžete přiřadit level, pro který jsou určena. V tomto nastavení můžete určit, zda se media mají zobrazit i čtenářům s nižším levelem. Pokud ano, media sice nemohou přehrát, ale zobrazí se jim infotext.

Základní level pro nová media - zde nastavíte level, který bude defaultně vybrán v přidávacím formuláři. Tento můžete u jednotlivých medií změnit.

Infotext- viz. zobrazit nepřístupná media. Infotext se zobrazí též v případě, že by někdo čirou náhodou (třeba přes nějaký uložený odkaz) přistupoval k médiím, jež nemají povolené zveřejnění.

Přidání

Společná nastavení:

Typ - vyberte typ přidaného media

Název - název, který se zobrazí ve výpisu

Popis - stručný popis media zobrazený ve výpisu, lze používat html tagy

Umístění a název souboru- napište relativní cestu (např. storage/mp3/pisnicka.mp3) nebo absolutní cestu (např. http://www.domena.cz/storage/mp3/pisnicka.mp3) k mediu. Soubor se tak může nacházet i na jiném serveru, než je váš web. V případě relativní cesty si plugin sám upraví adresu souboru.

Automaticky začít přehrávání - ano - medium se po otevření přehrávače začne přehrávat samo atd.

Barva přehrávače, pozadí - tyto hodnoty se načítají z konfigurace, můžete je změnit dle libosti.

Level - level se přednastaví podle konfigurace, lze změnit.

Zveřejnit - zveřejnit medium na webu nebo ne

Nastavení pro mp3 a playlist:

Název zobrazený v playeru - název pište bez diakritiky!, vyplňujte jen u samostatných mp3.

Opakované přehrávání - dostatečně vysvětleno přímo v popisu formuláře. Pro mp3 používejte jen ano/ne, pro playlist doporučuji nastavení přehraj playlist.

Barva textu - načítá z konfigurace, lze změnit.

Zobrazit infoodkaz z playlistu - viz. příprava playlistu.

Nastavení pro video:

Obrázek pro video - načítá se z konfigurace, lze nastavit pro každé video jiný (viz. příprava videa).

Buffer - počet sekund z délky videa, po jejichž načtení se video začne přehrávat. Vhodným nastavením můžete předejít zasekávání videa při jeho načítání do mezipaměti.

Výpis a zobrazení podrobností

Myslím, že nepotřebuje bližšího popisu, co vidíte, vidíte a na co se dá kliknout je napsaný;) Snad jen, že ve výpisu se zobrazuje jen začátek popisu pro lepší přehlednost.

Přidání bloku

Blok se přidává standartním způsobem. Jako šablonu bloku zvolte Multimedia online - blok. Blok zobrazí poslední přidaná média v počtu dle nastavení v konfiguraci. Názvy medií fungují jako odkaz do výpisu, vedle názvu je ikonka pro přímé přehrávání dle nastavení v konfiguraci do okna či na novou stránku. Zobrazení dle nastaveného levelu jsou identická jako u výpisu, tedy dle konfigurace.

Licence a podpora

Podpora

Jsem si vědom, že php kod mohl být napsán lépe, ale nejsem profík, tudíž je pro mě důležité, že plugin je funkční;)
Plugin instalujete na vlastní odpovědnost. Za chyby vzniklé při instalaci nepřebírám žádnou odpovědnost. Proto důrazně doporučuji před instalací provést zálohu databáze! Nepřebírám odpovědnost za chyby vzniklé používáním tohoto pluginu, před jeho ostrým použitím ho můžete předem vyzkoušet na identické kopii vašeho webu na localhostu..
Nemohu zaručit stoprocentní podporu a rady při používání tohoto pluginu. Stejně tak nemusím reagovat na žádosti o individuální úpravu pluginu, protože jsem si vědom, že způsob provedení pluginu nemusí vyhovovat všem. Přesto to ale můžete zkusit, bude-li to možné, pokusím se vám vyhovět. Dotazy a žádosti směřujte do fora phprs - pluginy a rozšíření, kde vám budou moci případně poradit i další uživatelé, nikoliv na můj email, díky za pochopení.
O úpravu kodu se můžete pokusit sami, zdrojové soubory jsem se snažil "srozumitelně" okomentovat.
Naleznete-li v pluginu nějakou funčkní chybu, využijte výše uvedeného odkazu do fora phprs. Opravu chyby zveřejním tam, kvůli informaci pro další uživatele.
Pro použití tohoto pluginu je třeba počítat s nevýhodami formátu flash, který může být návštěvníky vaši stránek v prohlížeči blokován nebo nemají nainstalovaný adobe flash player. Odkaz na instalaci adobe flash playeru můžete přidat na své stránky.

Verze 0.9.3beta prošla jen mým osobním testováním, může obsahovat chyby, ale v zásadě je funkční.

1. Provedl jsem instalaci, ale místo přehrávače se mi zobrazuje jen černý obdélník.

a) chyba při instalaci, plugin nenašel přehrávače, překontrolujte jejich správné umístění ve struktuře webu, viz. Instalace

b) plugin potřebuje pro správné zobrazení přehrávače absolutní adresaci. Proto používá proměnou $GLOBALS["baseadr"], která se doplňuje v souboru config.php v těchto místech:

 //--[http server]-----------------------------------------------------
 // jmeno WWW serveru
 $wwwname="Název webu";
 // zakladni URL adresa WWW serveru - napr.: [http://www.supersvet.cz/] - adresu nutno ukoncit lomitkem
 $baseadr="http://192.168.1.11/phprs/";
 // e-mailove adresy
 $redakceadr="redak ;ce@vase-domena.cz ";
 $infoadr="info@va 5;e-domena.cz";

Z toho důvodu je třeba tuto proměnou správně vyplnit. Pak by to již mělo fungovat.

2. Přehrávač se otevírá v novém okně, které je v kódování windows-1250! Nevíte odkud se to tam bere? Mám vše v UTF-8 a mám tam rozsypanou češtinu.

Okno přehrávače tahá kódování z proměnné $layoutkodovani v souboru lengine. Zkontrolujte, jestli tam tuhle proměnnou máte a co je u ní doplněno. Buď to opravte na to utf nebo si tam tu proměnnou doplňte s tím utf.
Pozn. Tato rada platí jen pro verze 0.9 a 0.9.1. U novějších verzí je příslušná proměnná pro kódování brána přímo ze souboru config.php.

3. Jeden poznatek ohledně instalace mám a to ten, že jsem si nevšiml, že při kopírování na server pomocí Totalcmd jsem měl zaškrtnuté - převést vše na malá písmena a tak jsem strávil dost času, než jsem přišel na to,že to nejede z důvodu právě těch písmen.

Týká se jen verzí 0.9 a 0.9.1, kde je třeba zkontrolovat názvy souborů uvedených ve složce Multimedia, a případně je přepsat na velká písmena. U verze 0.9.3 a výš jsou všechny soubory již uvedeny malými písmeny.

Licence

PHP kód můžete upravovat, měnit, mazat, přidávat atd. dle libosti. Případné chyby, které vzniknou vaším zásahem, jsou vaším problémem.. Provedete-li nějakou úpravu a plugin se stane nefunkčním, vraťte se k původní verzi!

Flashové přehrávače FMP3, FVP a XSPF_EV není možné jakkoliv měnit a upravovat, je možné je kopírovat a šířit dále. Tyto přehrávače jsou vydány pod creative commons licence a jsou určeny pouze pro nekomerční použití. Z toho vyplývá,že:

TENTO PLUGIN JE URČEN POUZE PRO NEKOMERČNÍ POUŹITÍ!!!

V případě, že byste chtěli plugin použít pro komerční použití, kontaktujte autora přehrávačů kvůli komerční licenci na tyto přehrávače. Podrobnosti najdete na níže uvedené webové stránce. (Stránka je v italštině!!!)

Autor pluginu nezodpovídá za způsob použití uživateli tohoto pluginu, stejně tak jako za porušení autorských práv vzniklé použitím tohoto pluginu pro nelegální přehrávání audio a video souborů.

php zdroj Copyright (c) 2007 Zdenek Hulbach - zdenekh (zdenekh.h@seznam.cz)
This program is free software. - Toto je bezplatný a svobodný software.

Flashové přehrávače FMP3.swf, FVP.swf a XSPF_EV.swf
Copyright (c) 2006 Enricolai.com
web: http://www.enricolai.com/