Octopus Player G6S4. David-Alexandre Cohen Hector Jusforgues Bastien Thouverez Projet tuteuré Développement d'un lecteur audio sur Android

Transcription

1 David-Alexandre Cohen Hector Jusforgues Bastien Thouverez Projet tuteuré Développement d'un lecteur audio sur Android G6S4 Professeur tuteur : Alain Pillot 1 /

2 Sommaire Remerciements... 3 Introduction... 4 Android, qu'est ce que c'est?... Le choix du sujet... Outils utilisés Cahier des charges... 6 Analyse... 8 Développement Mise en place de l'environnement... Scan des fichiers... Organisation du projet... L'interface graphique Problèmes rencontrés Devenir Conclusion Sources Annexes /

3 Remerciements Merci à : Monsieur Alain Pillot, professeur à l'iut, qui a été notre tuteur et qui nous a suivi au long du projet. Mademoiselle Pauline Gallot, étudiante en graphisme, pour le logo Octopus, ses conseils avisés, et son aide précieuse pour l'interface de l'application. Vous, qui lisez ce rapport, en espérant que vous l'apprécierez 3 /

4 Introduction Android, qu'est-ce que c'est? Android est un système d'exploitation open source pour smartphones. Il a été développé par la startup Android rapidement rachetée par Google. La première version fut officiellement annoncée le 5 Novembre Android est un projet sous licence GNU GPL, il est donc libre et accessible à tous. Pour avoir une idée de l'ampleur d'android, depuis Octobre 2010, il détient une plus grosse part de marché que son principal concurrent Apple sur la vente de smarthphones aux États Unis. Caractéristiques d'android Famille Développeur Linux Open Handset Alliance Licence Licence Apache 2.0 GNU GPL 2 États des sources Open Source Dernière version stable SDK 4.0 (Octobre 2011) Site web 4 /

5 Le choix du sujet Nous avons eu la chance de pouvoir choisir notre sujet pour ce projet tuteuré. Nous avons choisi de développer une application sur Android, car premièrement, nous sommes tous les trois détenteurs de téléphones portables dotés de ce système d'exploitation, et le développement Android se fait en Java, langage que nous avons bien étudié à l'iut. Aussi, nous savons qu'avoir les bases du développement Android sera un point fort, vu l'ampleur toujours grandissante de ce phénomène. Notre choix s'est rapidement porté sur un lecteur audio car la musique est quelque chose qui nous rapproche, et un lecteur audio est un sujet concret, que nous pourrons toujours continuer de développer et d'améliorer dans le futur. Outils utilisés L'analyse du projet s'est faite grâce à ArgoUML, qui est un logiciel libre et gratuit de modélisation UML. Nous avons aussi utilisé, lors de l'analyse, Balsamiq Mockup, qui nous a permis de dessiner les différentes interfaces de l'application (Cf Annexes). Pour le développement, nous avons choisi d'utiliser l'environnement de développement intégré Eclipse Helios, car Google propose d'y installer le module ADT et le SDK Android nécessaires au développement Android. Nous avons enfin mis en place un gestionnaire de version pour notre projet grâce à l hébergeur de projet Google Doc, et le plugin SVN installable sous Eclipse. 5 /

6 Cahier des charges Le cahier des charges a été établi au tout début du projet, début Juin, en voici la copie. I. Présentation Le projet consiste à la réalisation d'une application mobile pour la plateforme Android. Cette application devra être capable de lire et d'administrer une bibliothèque de musiques stockées sur le téléphone. II. Fonctionnalités Voici la liste des fonctionnalités qui seront présentes : II.a Bibliothèque Il doit être possible de naviguer dans la bibliothèque, de supprimer un morceau de celle ci, de modifier les informations contenus dans les fichiers (cf métadonnées). Cela implique un scanne des fichiers présents sur le téléphone au lancement de l'application. Il sera prévu l'affichage par artiste, par album ou par popularité (nombre de lecture). Cette fonctionnalité impliquera l'utilisation d'une base de donnée et l'affichage des pochettes d'album. II.b Playlist Dans le prolongement de la fonctionnalité précédente, il doit être possible de créer des playlists, de les supprimer, d'y ajouter des morceaux et d'en enlever. II.c Player Il faut bien sûr que l'application soit capable de lire les fichiers qu'elle archive (format mp3, ogg, wav etc...). Cela implique la lecture en boucle, la lecture aléatoire et la lecture de playlist. L'interface devra être particulièrement intuitive et ergonomique. II.d Métadonnées Les métadonnées sont de petites informations incluses dans les fichiers audio, elles peuvent contenir le nom du morceau, de l'artiste, de l'album ou le genre du titre concerné. Elles sont aujourd'hui utilisé dans de nombreux formats. Il devra être possible d'éditer ces informations indépendamment du type de fichier. De plus, l'application devra intégrer un module capable de remplir ces informations automatiquement à partir du nom du fichier et d'un service similaire à Musicbrainz. Les informations devront être présentes à la fois dans le fichier et dans la base de données. 6 /

7 II.e Pochettes De la même manière que pour les métadonnées, il devra être possible d'importer automatiquement des pochettes d'album depuis internet. La présence de cette fonctionnalité dépendra de l'existence de service gratuit de recherche et d'acquisition de ces images. III. Outils III.a Les Ateliers de génie logiciel Pour la programmation : Eclipse + SDK Android google Pour l'analyse : L'AGL reste à déterminer, l'analyse se fera en UML. III.b Les technologies Java + classes Android (comprenant bibliothèque graphique et gestion du matériel) SqlLite pour la bibliothèque Http pour les demandes/récupération en ligne de tag ou de pochette III.c Les services MusicBrainz : Pour la récupération des métadonnées (cf plus haut). SourceForge : Il est prévu de tenir une forge et de faire du versionning pour facilité le travail en équipe. III.d Architecture Plus généralement l'application doit intégrer un service tournant en tache de fond, permettant de continuer la lecture d'une musique lors du lancement d'une autre application. La recherche de pochettes ou d'informations sur internet se fera par le biais de ce service ou d'une Thread séparée. Il sera également conseillé d'utiliser un Modèle-Vue-Contrôleur. IV. Conclusion Le projet reprend de nombreuses notions vues en cours, notamment concernant l'analyse UML, la programmation java, les bases de données sql, les requêtes http... Il est prévu de phaser le projet en étapes et d'identifier les zones de risques dans le cadre d'une organisation en mode projet. Enfin nous tenons à vous faire part de la motivation de l'équipe pour ce projet. Nous y avons travaillé la spécification pour correspondre au mieux à vos exigences. 7 /

8 Analyse L'analyse s'est faite sur une période de trois mois de Juin à Août. Cette phase a été constituée d'une grande partie de brainstorming, et sur l'établissement de diagrammes de use case pour chaque activité : Ce diagramme est celui au lancement de l'application. L'utilisateur pourra naviguer dans les 4 onglets de l'application. Une nouvelle activité est appelée pour chaque onglet. L'onglet player permettra d'afficher la playlist courante, de changer de chanson en prenant la suivante ou la précédente dans la playlist, et de mettre pause à la chanson en cours, toutes ces options étant disponibles via des boutons. L'affichage de la playlist actuelle permettra aussi de changer le morceau en cours de lecture. 8 /

9 L'onglet playlist, permettra d'ajouter des listes de lectures dans la base de donnée et d'explorer les playlist déjà enregistrées. L'appel à la fonction pour créer une nouvelle playlist ouvrira une boite de dialogue afin de saisir le nom de la liste de lecture. 9 /

10 L'onglet library contiendra tous les morceaux enregistrés dans la base de donnée. Il permettra l'accès à trois rubriques : Artistes, Albums et Morceaux. A chaque rubrique correspondra aussi une nouvelle activité. L'activité Artiste ouvrira la liste triée des artistes, et un clic sur un artiste lancera aussi une nouvelle activité qui affichera les albums de l'artiste. De la même manière, chaque album ouvrira la liste des chansons de l'album. Dés la fin des vacances, après avoir réuni les idées du brainstorming et après s'être documenté et avoir commencé à apprendre comment le développement Android fonctionnait, nous avons pu passer à la phase de développement. 10 /

11 Développement Mise en place de l'environnement Le développement a débuté en Septembre et n'est à l'heure qu'il est, pas encore terminé. Il nous a d'abords fallu installer tous les outils nécessaires. La première chose que nous avons fait a été de créer le projet sur l'hébergeur de projet Google Code. Nous avons fait le choix d'utiliser la licence GNU LGPL, pour Gnu is Not Unix Lesser General Public License, qui est une version limitée de la célèbre licence GNU GPL des logiciels libres. Cette licence fait que le code de l'application est ouvert, qu'il peut être copié et partagé. Nous avons choisi LGPL car il est aisé de passer à la licence GNU GPL si nous voulons continuer de développer Octopus au delà du projet tuteuré et de l'envoyer sur l'android Market. Ensuite nous avons chacun installé l'ide Eclipse. Nous avons choisi cet environnement car il est multiplateforme, certains membres du groupe travaillent sous windows, d'autres sous Linux, de plus il est doté du module ADT proposé par Google qui facilite amplement le développement Android. Enfin, nous l'avons choisi car nous ne le connaissions pas, nous avons travaillé sous NetBeans à l'iut, mais pas avec Eclipse, et ce projet nous a permis de bien le prendre en main. Avec le module ADT et le SDK Android installés dans Eclipse, il est alors très simple de développer directement sur le téléphone. Une otpion Déboguage USB est à cocher dans les otpions des applications sur le téléphone, et une fois branché par USB sur l'ordinateur, une compilation et execution du projer sous Eclipse génère automatiquement le fichier.apk (équivalent au.exe de windows), le transfère sur le téléphone, et y lance l'application. Le module ADT propose aussi un emulateur de téléphone, pour les développeurs qui n'ont pas de téléphone Android, mais il n'est pas très performant et il est plus aisé de tester l'application directement sur le téléphone. Scan des fichiers Nous avons passé un long moment sur le scan des fichiers. Le but ici était de lire la carte SD, et d'enregistrer dans la base de donnée tous les morceaux présents dans le dossier appelé Music de la carte. Pour gérer cela, une classe java MusicFilesScanne.java a été implémentée. Elle contient: Un constructeur Des methodes publiques Des methodes privées appelées par les methodes publiques MusicFilesScanne(Context cont, String dir, ProgressDialog dialog) public Vector<String> getvector() public int getnbfiles() public boolean scannefiles() private void recurscann(file tmpunknow) private void analysefiles() 11 /

12 Ces méthodes font appel aux repository du package com.octopus.database qui exécutent les requêtes et recherchent les fichiers. La fonction publique scannefiles() fait tout d'abords appel à la fonction privée recurscann. Cette dernière fonction sert à parcourir récursivement les dossiers et sous dossiers du dossier «Music», et de sauvegarder tous les chemins des chansons trouvées dans une liste. Ensuite la fonction scannefiles() fait appel à la fonction privée analysefiles() qui va comparer la liste des chemins recherchés juste avant avec la base de donnée. Elle ajoutera dans la base les chansons qui n'y sont pas encore. Cette étape était nécessaire pour pouvoir continuer le projet dans de bonnes conditions et elle nous a demandé beaucoup de temps car il nous a fallu étudier la base de donnée SQLite alors que nous n'avons étudié que Oracle à l'iut. Organisation du projet 12 /

13 Nous avons organisé le projet en packages. L'image précédente présente une partie de la hiérarchie des packages et fichiers. Nous avons un package com.octopus qui contient les fichiers sources appelés au lancement de l'application, et les packages com.octopus.database, com.octopus.model, et com.octopus.view qui découlent du premier package com.octopus. Le package com.octopus.database contient tout ce qui est en lien avec la base de données: toutes les fonctions qui intéragissent avec la base de donnée, requêtes, insertion d'éléments etc... se trouvent dans ce package et uniquement dans celui-ci. Ensuite, à chaque onglet de l'application correspond une ou plusieurs activités. Ces activités sont implémentées dans les fichiers sources contenus dans le package com.octopus.views. S'en suit des dizaines de packages entagged.audioformats qui contiennent des fonctions pour la gestion des différents formats audio. Ainsi nous avons donc un package entagged.audioformats.mp3, un autre entagged.audioformats.ogg et entagged.audioformats.flac à titre d'exemple. Tous ces packages contiennent des fichiers sources.java. L'interface graphique L'interface graphique se fait en xml. A chaque fichier.xml correspond une vue, qui pourra être appelée dans les sources java grace à la fonction setcontentview(view v); L'image suivante présente la hierarchie des layout (vues) : Nous avons donc un fichier xml par écran. Prenons pour exemple l'interface du player : 13 /

14 Cette interface est composée d'une vue présentant les onglets, et dans chaque onglet, une nouvelle vue est appelée. Une vue est découpée en layouts. L'onglet player est composé des éléments suivants : 14 /

15 Nous pouvons comparer l'interface au squelette suivant : La partie jaune correspond au linearlayout2 qui contient une imageview pour la pochette de l'album. La partie verte correspond au linearlayout3 qui contient les textviews du nom d'artiste, du nom de la chanson et du nom de l'album. La partie bleue est le linearlayout4 composé de la seekbar et enfin la partie orange est le lineralayout5 contenant les boutons retour, play et suivant. Le code xml correspondant à l'image est le suivant : <ImageView android:src="@drawable/iconoctopus" android:layout_height="200dp" android:layout_width="200dp" android:layout_marginleft="65dp" android:id="@+id/pochette"></imageview> Une image est crée dans la balise <ImageView> </ImageView> et contient plusieurs attributs : android:src="@drawable/iconoctopus" Pour récupérer l'image à afficher qui se trouve dans le répertoire res/drawable android:layout_height="200dp" Pour configurer la hauteur de l'image android:layout_width="200dp" android:layout_marginleft="65dp" Pour configurer la largeur de l'image Pour configurer la marge à gauche de l'image android:id="@+id/pochette" Pour configurer l'identifiant de l'image 15 /

16 Nous avons utilisé l'unité de mesure «dp», qui est une unité comparable aux pourcentages. Une valeur de 20dp sur un téléphone pourra varier sur un autre téléphone, et utiliser les dp fait que cette conversion se fait automatiquement. Un des problèmes majeurs d'android que doivent gérer ses développeurs, qui n'est pas a gérer pour les développeurs sur iphone par exemple, est la diversité des appareils, offrant des tailles différentes d'écran. Un développeur sous iphone n'aura pas a gérer les différentes résolutions puisque tous les iphones ont la même. Il pourra donc utiliser une unité de mesure fixe comme le pixel par exemple. Ceci n'est pas possible sous Android car faire une interface de taille fixe peut avoir un bon rendu sur un téléphone de résolution x, mais peut être totalement différent sur un téléphone de résolution y. Prenons maintenant comme autre exemple, le code du bouton play de l'interface : <Button android:id="@+id/buttonplay" android:background="@drawable/playnb" android:layout_marginright="20dp" android:gravity="center" android:layout_width="wrap_content" android:layout_height="wrap_content"></button> De même, un bouton est crée entre les balises <Button> et </Button>, voici les explications de ses attributs : android:id="@+id/buttonplay" Pour configurer l'identifiant du bouton android:background="@drawable/playnb" Pour configurer l'image du bouton android:layout_marginright="20dp" Pour configurer la marge à droite du bouton android:gravity="center" Pour placer le bouton au centre du layout android:layout_width="wrap_content" android:layout_height="wrap_content" Pour configurer la hauteur et la largeur du bouton: wrap_content sert à dire que l'objet prendra la place de son contenu. Ici le bouton prendra la place de l'image de fond. Le code complet du fichier tabplayer.xml ainsi que des screenshots des autres onglets d'octopus sont disponibles en annexes. 16 /

17 Problèmes rencontrés Le principal problème que nous avons rencontré à été celui du temps. Nous l'avons mal géré pour les phases de développement et d'analyse. Nous aurions du commencer le développement plus tôt car il demande beaucoup de temps, et nous avions beaucoup d'autres projets à terminer pour l'iut. Aussi, la répartition du travail que nous avons fait, chacun sur une tache différente pour développer plus rapidement, a fait que nous nous sommes chacun concentré sur un aspect précis de la programmation sans voir le temps de pouvoir comprendre et étudier ce que les autres ont fait. De plus, nous ne connaissions pas du tout la programmation Android, et nous avons été très gourmand sur notre cahier des charges. Nous pensions avoir le temps de développer plusieurs modules de communication avec certains réseaux sociaux (Facebook, Youtube...), des widgets, qui sont des «plugins» de l'application visibles et utilisables directement sur le bureau du téléphone Android, mais au fur et a mesure de l'avancement du projet, notre but s'est restreint à développer un lecteur simpliste mais stable, permettant de lire les musiques et de créer des playlist. Devenir Nous avons choisi de développer un lecteur audio car c'est une application qui peut toucher un nombre très important de personnes, à travers le monde : il est fort peu probable qu'aujourd'hui une personne ayant un téléphone portable n'écoute pas de musique, nous ne voulions pas nous enfermer dans un domaine restreint. Je pense notamment à l'application Andromach développée l'an dernier dans le même cadre d'un projet tuteuré, qui permet la consultation des emplois du temps de l'iut. Cette application est destinée uniquement aux personnes de l'iut, et elle n'apporte plus beaucoup d intérêts à ses développeurs. Nous voulions une application qui puisse être durable. De plus, Octopus n'est pas un simple test, nous comptons continuer de le développer au delà du projet tuteuré, l'envoyer sur l'android Market, et pourquoi pas en tirer quelques bénéfices. Ce qu'il nous sera possible de faire grâce à la licence que nous avons choisi. Le fichier d'installation de a dernière version stable de l'application est disponible au téléchargement sur notre hébergeur de projet google code à l'adresse suivante : 17 /

18 Conclusion Quelques chiffres sur le projet (au 03 Novembre 2011) : Nombre de fichiers (.java,.xml, images...) 637 Nombre de commit 106 Ce projet à finalement été très riche pour nous puisqu'il nous a apporté beaucoup de nouvelles connaissances. Nous connaissons dorénavant les bases du développement Android, nous savons utiliser l'ide Eclipse, nous savons mettre en place et utiliser un gestionnaire de version. Octopus nous a permis d'avoir une idée précise sur ce que représente un projet, avec toutes ses phases, d'analyse et de développement. Octopus nous a confronté à de nombreux problèmes que nous seront alors en mesure de résoudre rapidement lors de nouveaux projets, notamment par rapport à la gestion du temps et l'importance d'établir un calendrier précis au début du projet et de le respecter à la lettre. Sources Internet Wikipedia : fr.wikipedia.org Android Developers : developer.android.com Google Docs : docs.google.com Google Code : code.google.com Balsamiq Mockup : balsamiq.com/products/mockups Livres Programmation Android De la conception au déploiement avc le SDK Google Android 2 Damien Guignard, Julien Chable, Emmanuel Robles Ed. Eyrolles 2011 Le Programmeur L'art du développement Android Mark L. Murphy Ed. Pearson /

19 Annexes Mockup de l'onglet du player de l'application Mockup de l'onglet playlist de l'application 19 /

20 Mockup de gestion de playlist 20 /

21 Diagramme UML du lancement de l'application 21 /

22 Code du fichier tabplayer.xml <?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android=" android:layout_height="fill_parent" android:layout_width="match_parent" android:layout_margintop="15dp" android:orientation="vertical"> <TableLayout android:layout_height="wrap_content" android:layout_width="match_parent"> <LinearLayout android:orientation="horizontal" android:layout_width="fill_parent" android:layout_height="wrap_content"> <ImageView android:layout_height="200dp" android:layout_width="200dp" android:layout_marginleft="65dp" </LinearLayout> <LinearLayout android:layout_height="wrap_content" android:layout_width="fill_parent" android:orientation="horizontal" android:layout_margintop="10dp"> <TextView android:textcolor="#7bc147" android:text="artist name" android:layout_marginleft="25dp" android:layout_width="80dp" android:layout_height="45dp"></textview> <TextView android:textcolor="#ffffff" android:text="music name" android:layout_marginleft="15dp" android:layout_width="80dp" android:layout_height="45dp"></textview> <TextView android:textcolor="#7bc147" android:text="album name" android:layout_marginleft="15dp" android:layout_height="45dp" android:layout_width="100dp"></textview> </LinearLayout> 22 /

23 <LinearLayout android:layout_height="40dp" android:orientation="horizontal" android:layout_width="fill_parent" android:layout_marginleft="15dp" android:layout_marginright="15dp" android:layout_margintop="10dp"> <SeekBar android:layout_width="match_parent" android:layout_height="16dp"></seekbar> </LinearLayout> </TableLayout> <LinearLayout android:orientation="horizontal" android:layout_margin="0dip" android:layout_gravity="center" android:layout_width="wrap_content" android:layout_height="match_parent"> <Button android:layout_marginright="20dp" android:layout_width="wrap_content" android:layout_height="wrap_content" android:layout_marginleft="45dp" android:gravity="center" android:layout_gravity="center"></button> <Button android:layout_marginright="20dp" android:onclick="2" android:gravity="center" android:layout_gravity="center" android:layout_width="wrap_content" android:layout_height="wrap_content"></button> <Button android:layout_width="wrap_content" android:layout_height="wrap_content" android:layout_marginright="45dp" android:gravity="center" android:layout_gravity="center"></button> </LinearLayout> </LinearLayout> 23 /

24 Screenshot de l'interface de l'onglet Library Cet onglet contient tous les morceaux présents dans la base de donnée du téléphone, rangés par artiste, album, ou tous les morceaux Screenshot de l'interface de l'onglet Modules Cet onglet contient tous les options de l'application, à savoir la lecture aléatoire et la répétition de lecture 24 /