Document de Spécifications Externes: Compresseur de Huffman

Transcription

1 Document de Spécifications Externes: Compresseur de Huffman 24 avril 2017 Version 1.0 Groupe 4 BAERT Gaétan CASTEL Théo LIVNEY Michel MARTIN Pauline VANDECASTEELE Mathieu

2 Table des Matières 1 Introduction Introduction du dossier Documents de référence Répartition des tâches Contexte Objectifs Hypothèses Description générale Intégration dans le système Fonctions principales du produit Caractéristiques des utilisateurs Contraintes principales du projet Contraintes de développement Contraintes d exploitation Coformité aux standards Documentation Besoins détaillés Spécifications fonctionnelles La compression La décompression Spécifications d interfaces Spécifications opérationnelles Performance Fiabilité Scénarios d utilisations Compression Décompression Description des fournitures Livrable Contenu de l archive

3 Les rédacteurs du document de spécifications externes sont : Gaétan BAERT Groupe SCOLAM Théo CASTEL Groupe 1.1 Michel LIVNEY Groupe 1.3 Pauline MARTIN Groupe 1.2 Mathieu VANDECASTEELE Groupe 1.5 Les membres du Groupe 2.2 d algorithmique sont : Maxime Carpentier Guillaume Cavelier Denis Coquenet Constantin Dedeyan Anaëlle Morin Résumé Ce document est le cahier des charges pour la réalisation du projet de création d un programme qui compresse des fichiers utilisant la méthode de Huffman. Il fixe les exigeances et contraintes demandées par le client. Abstract This document is the specifications introducing the intructions for the realisation of the project that consists of the creation of a program that compress files using the Huffman method. It set the requirements and the constraints requested by the client.

4 1 Introduction 1.1 Introduction du dossier Ce document est le Document de Spécifications Externes (DSE) du projet de compression de fichier par la méthode de Huffman en langage C. Il a été réalisé dans le cadre du cours d algorithmie de M. Nicolas Delestre auprès de la classe d Architecture des Systèmes d Information (ASI) de troisième année. Il pose d abord le contexte en expliquant l objectif du projet. Dans un second temps il décrit le programme: les fonctionnalités demandées et contraintes imposées. Les besoins seront détaillés alors par les spécifications du programme avec également les scénarios d utilisation et pour finir la description de ce qui est attendue par le client sera expliquée. 1.2 Documents de référence Ce document est basé sur le rendu des réalisateurs du projet indiqués précédemment. Le dossier rendu contient le programme demandé et le rapport du projet fait par l équipe réalisatrice. Il est disponible sur Moodle, dans la section "Qualité et Notions Juridiques", dans le dossier: "Support Partie Qualité/4-RédactionDocumentsTechniques/Evaluations/G4". 1.3 Répartition des tâches Gaétan BAERT Rédaction Contexte et Description Générale. Théo CASTEL Rédaction Description des fournitures. Michel LIVNEY Rédaction Besoins détaillés. Pauline MARTIN Rédaction du résumé, de l abstract et de l Introduction. Mathieu VANDECASTEELE Fichier Latex, Rédaction Scénarios d utilisations. Figure 1 : Tableau de répartition des tâches 1

5 2 Contexte 2.1 Objectifs Il est commun de rencontrer des difficultés lors du partage de documents surtout quand il s agit de fichiers lourds. En effet, le temps de chargement vers les sites internet de stockage ou de partage de fichiers augmente avec la taille de l élément, de plus ce genre de site impose parfois des restrictions. Pour palier à ce problème la solution se caractérise par un compresseur des fichiers. Ce projet consiste donc en la création d un programme permettant la compression et la décompression de n importe quel type de fichier sans perte d informations. C est-à-dire que le fichier avant compression doit être identique au fichier après décompression. La méthode de Huffman devra être utilisée, celle-ci utilisant beaucoup de notions vues en cours d algorithmie. Ce projet a aussi comme objectif la découverte de nouveaux outils tel qu un outil gestionnaire de version décentralisée (GIT). D autres outils sont disponible sur la plateforme MonProjet comme le diagramme de Gantt aidant l organisation du projet. 2.2 Hypothèses Les hypothèses pour la réalisation du projets sont les suivantes: le programme doit être réalisé en C. le rapport doit être rédigé en Latex. le programme doit être documenté. le programme, la documentation et le rapport doivent pouvoir être compilés grâce à un makefile. le groupe de travail doit être de 5 ou 6 personnes. le travail doit être organisé selon un cycle en V. utilisation de la plateforme MonProjet. les membres du groupe doivent connaître la méthode de Huffman pour la compression de fichier. 2

6 3 Description générale Dans cette partie seront décrites diverses caractéristiques liées au projet de Compresseur de Huffman. Dans un premier temps, pour quels types de système ce projet est destiné, ses fonctions principales, ses utilisateurs et enfin ses contraintes principales. 3.1 Intégration dans le système Le programme devra pouvoir compiler et être lancé sur une machine Linux équipée de GNU Compiler Collection(GCC). 3.2 Fonctions principales du produit Le programme devra proposer un compresseur/décompresseur Huffman et fonctionner de la manière suivante : Le programme sera lancé via une ligne de commande d un terminal Linux depuis le répertoire du projet de la manière suivante : "./bin/huffman optiondecompression nomdufichier". optiondecompression : Dans ce champ, on écrira un c si l on souhaite compresser le fichier dont le nom sera écrit dans le champ nomdufichier, un d si l on souhaite le décompresser. Remarque : lorsque l on souhaitera décompresser un fichier, ce dernier devra absolument se terminer par l extension.huff, qui sera l extension de sortie du fichier lors de la compression. Par exemple, si le fichier pas encore compressé se nomme fichier.txt, le fichier compressé se nommera fichier.txt.huff et le fichier décompressé fichier.txt. 3.3 Caractéristiques des utilisateurs Pour utiliser ce programme, les utilisateurs devront être capables d écrire la commande Linux correspondante dans un terminal, et de comprendre grâce à une aide textuelle quelles options choisir pour exécuter le programme tel que souhaité. 3.4 Contraintes principales du projet Cette partie décrit les différentes contraintes qui s appliqueront au projet, d abord sur celles de développement, puis celles d exploitation, celles sur 3

7 les standards imposés et enfin sur la documentation Contraintes de développement Lors de la phase de développement, les développeurs devront se plier aux contraintes suivantes : Le programme devra être écrit en langage C. La documentation devra etre produite à l aide de l outil Doxygen. Les étapes de conception devront rigoureusement suivre le Cycle en V. Tous les tests unitaires des différentes fonctions et procédures devront être faits et vérifiés avec le système CUnit développé par Sourceforge. Ces tests devront être écrits avant lesdites fonctions et procédures Contraintes d exploitation Le programme devra être capable de compresser et décompresser des fichiers, c est-à-dire transformer un fichier en un autre fichier plus léger; et recréer le fichier d origine à partir du petit fichier Coformité aux standards Le code respectera le standard ISO/CEI 9899 : 1999, ce qui impose que le code compile sans Warnings avec l option -C Documentation Le rapport reprenant toutes les étapes de conception (analyse descendante, conception détaillée, conception préliminaire, types abstraits de données, code C, tests unitaires). La répartition du travail devra être fourni en LaTeX. Le code source aura une documentation aux formats HTML et Latex grâce à l outil Doxygen. Le code devra donc être entièrement commenté en suivant la syntaxe Doxygen. Tous ces doucuments pourront être générés via un makefile. Un fichier ReadMe devra également être présent pour expliquer comment utiliser le makefile. 4

8 4 Besoins détaillés Dans cette partie nous décrirons les besoins spécifiques liés au projet. Nous verrons tout d abord les spécifications fonctionnelles attendues puis nous aborderons les spécifications liées à l interface et enfin, nous évoquerons les spécifications opérationnelles. 4.1 Spécifications fonctionnelles Détaillons les spécifications fonctionnelles liées au projet La compression Le compresseur devra être capable de compresser un fichier texte selon la méthode de compression de Huffman. Le fichier ainsi compressé doit comprendre les informations suivantes : le corps du fichier texte compressé, l extension du fichier avant compression et l arbre de Huffman utilisé pour la compression La décompression Le projet nécessite aussi la création d un décompresseur. Ce décompresseur devra restituer le fichier originelle dans son intégralité et lui donner la bonne extension. Pour ce faire, il utilisera l arbre de Huffman présent dans le fichier compressé et devra décoder le corps du fichier. 4.2 Spécifications d interfaces Aucunes spécifications d interfaces n est attendu pour ce projet. La compression et la décompression seront lancés à travers l invité de commandes, à partir du code source compilé grâce au makefile. 4.3 Spécifications opérationnelles Performance Le compresseur et le décompresseur devrons être optimisés afin de compresser/décompresser un fichier de quelques ko de manière rapide. 5

9 4.3.2 Fiabilité Le projet se doit d être fiable et de restituer à la perfection le fichier d origine après compression puis décompression. 6

10 5 Scénarios d utilisations Cette section a pour but de décrire l utilisation du programme. L utilisation du programme se fait de 2 manières différentes. Le programme étant un compresseur, il peut compresser et décompresser. Les différentes fonctionnalités du programme s exécutent par ligne de commande. Nous avons deux paramètres présents dans les lignes de commandes. Le premier paramètre pour indiquer au programme s il doit compresser ou décompresser et le deuxième paramètre pour indiquer sur quel fichier il doit effectuer son action. 5.1 Compression Pour compresser un fichier, le fichier à compresser doit être dans le même dossier que l executable huffman et lancer la commande:./huffman c NomDuFichier créera un fichier compressé nommé NomDuFichier.huff. L une des seules erreurs possibles lors de la compression est de donner un nom de fichier inexistant. 5.2 Décompression De même que pour la compression,nous devons mettre le fichier à décompresser dans le même dossier que l executable huffman et lancer la commande./huffman d NomDuFichier.huff. Par ailleurs, le compresseur d Huffman peut uniquement décompresser des fichiers avec l extension.huff. Si ce n est pas le cas, un message d erreur s affichera et la décompression n aura pas lieu. 7

11 6 Description des fournitures Dans cette partie la forme et le contenue du produit livré sont décrites. 6.1 Livrable Le livrable se fera sous la forme d une archive zip dont le nom sera G Contenu de l archive La décompression de l archive générera un répertoire dont le nom sera composé des noms de famille des membres du projet, séparés par des tirets hauts en notation Camelcase suivant l ordre Lexico-graphique. ce répertoire contiendras l arborescence suivante: rapport: Packages contenant les package Latex nécessaire à la génération du rapport. Ressources contenant les fichiers image du rapport. Partie contenant les différentes partie du rapport Latex à savoir : 1. Introduction 2. Présentation des Types Abstraits de Données (TAD) 3. Analyses Descendantes 4. Conception Préliminaire 5. Conception Détaillée 6. Code C et Tests Unitaires 7. Conclusion (avec la grille de répartition des tâches) le rapport LaTeX. Un README indiquant comment générer le rapport. Un makefile permettant de générer le PDF du rapport. 8

12 sources: bin qui contient après compilation l exécutable «compresseurhuffman». lib qui contient les bibliothèque créés lors de la compilation du projet. doc qui contient les différents dossiers et fichiers de documentation du projet générés à l aide de doxygen. include qui contient les fichiers header (.h). src qui contient l ensemble des fichiers du code source du projet (.c) tests qui contient après compilation un exécutable permettant d effectuer la suite de test. un fichier README expliquant le fonctionnement du makefile et de l exécutable. fichier makefile qui permet de compiler les fichiers sources, les tests et de générer la documentation. 9