| 1 | | == Contents == |
| 2 | | |
| 3 | | * Introduction |
| 4 | | * Asset, media file and metadata |
| 5 | | * What has to be uploaded? |
| 6 | | * The metadata file |
| 7 | | o Simple Dublin Core[[BR]] |
| 8 | | o Qualified Dublin Core |
| 9 | | * The video upload file |
| 10 | | o Structure and elements[[BR]] |
| 11 | | o Actions and related elements |
| 12 | | |
| 13 | | == Introduction == |
| 14 | | |
| 15 | | MediaMosa is a solid, flexible and scalable media distribution platform. It is the foundation of several succesful video services developed by SURFnet and Stichting Kennisnet, to the benefit of (the field of) education in the Netherlands. MediaMosa was published under an open source licence in the middle of 2009 by both organizations, and by software developer Madcap. |
| 16 | | |
| 17 | | MediaMosa is able to store and playback video on demand. Video files are stored in a repository and played back by streaming servers. The functionality in MediaMosa to upload media files is split into two components. The Batch Upload component allows registered MediaMosa users to upload multiple files to MediaMosa simultaneously using FTP. EGA's (End User Applications) and EGA end users can use the File Upload component. This document aims at the end user who wants to upload media files via FTP, and focuses on the requirements at which the metadata has to meet. |
| 18 | | |
| 19 | | == Asset, media file and metadata == |
| 20 | | A central object in the organization of content within MediaMosa is the so called asset, which can be considered a unit of content. An asset mainly consists of one or more media files (video, video stills) and metadata that describes the asset. In MediaMosa a media file is always part of one single asset, but an asset can contain multiple media files. If it does, these files are versions of the same media clip in different file formats, bit rates or resolutions. |
| 21 | | |
| 22 | | The metadata records information about the properties of an asset, concerning the content of the media file (title, language, publisher, etc.), or the technical properties (file format, resolution, bitrate, etc.). Technical metadata is automatically determined by MediaMosa while analyzing the uploaded media file. |
| 23 | | |
| 24 | | == What has to be uploaded? == |
| 25 | | |
| 26 | | To upload an asset, three files are mandatory: |
| 27 | | |
| 28 | | 1. the media file(s) (e.g. video.wmv), |
| 29 | | 2. a metadata file that describes the media file in XML, using the Dublin Core Metadata Element Set, |
| 30 | | 3. a video upload file (.vuf), laying down the upload procedure in a XML format. |
| 31 | | |
| 32 | | The video upload file contains references to the media and metadata files. Therefore these media and metadata files should have been uploaded before MediaMosa can upload the video upload file. |
| 33 | | |
| 34 | | == The metadata file == |
| 35 | | |
| 36 | | MediaMosa uses the Dublin Core Metadata Element Set (DCMES) to describe the media file in XML. The Dublin Core standard includes two levels: Simple and Qualified. Simple Dublin Core contains fifteen elements; Qualified Dublin Core includes three additional elements, as well as a group of element refinements. A refined element (or qualifier) shares the meaning of the unqualified element, but with a more specific scope. |
| 37 | | Simple Dublin Core |
| 38 | | |
| 39 | | The Simple or unqualified Dublin Core Metadata Element Set consists of 15 metadata elements: |
| 40 | | |
| 41 | | * dc:title |
| 42 | | * dc:creator |
| 43 | | * dc:subject |
| 44 | | * dc:description |
| 45 | | * dc:publisher |
| 46 | | * dc:contributor |
| 47 | | * dc:date |
| 48 | | * dc:type |
| 49 | | * dc:format |
| 50 | | * dc:identifier |
| 51 | | * dc:source |
| 52 | | * dc:language |
| 53 | | * dc:relation |
| 54 | | * dc:coverage |
| 55 | | * dc:rights |
| 56 | | |
| 57 | | A comprehensive explanation of these 15 elements can be found at: http://dublincore.org/documents/dces/ |
| 58 | | |
| 59 | | The Dublin Core XML schema can be found at: http://www.openarchives.org/OAI/2.0/oai_dc.xsd |
| 60 | | == Qualified Dublin Core == |
| 61 | | |
| 62 | | MediaMosa doesn't support the complete Qualified Dublin Core, but only a selection which contains the next qualifiers: |
| 63 | | |
| 64 | | * dcterms:alternative |
| 65 | | * dcterms:abstract |
| 66 | | * dcterms:created |
| 67 | | * dcterms:issued |
| 68 | | * dcterms:spatial |
| 69 | | * dcterms:temporal |
| 70 | | * dcterms:hasFormat |
| 71 | | * dcterms:isFormatOf |
| 72 | | * dcterms:medium |
| 73 | | * dcterms:extent |
| 74 | | * dcterms:license |
| 75 | | * dcterms:rightsHolder |
| 76 | | * dcterms:isReferencedBy |
| 77 | | * dcterms:isPartOf |
| 78 | | |
| 79 | | The meaning and use of these qualifiers is extensively explained at: http://dublincore.org/documents/usageguide/qualifiers.shtml |
| 80 | | |
| 81 | | The Qualified Dublin Core XML schema can be found at: http://dublincore.org/schemas/xmls/qdc/dcterms.xsd |
| 82 | | == The video upload file == |
| 83 | | |
| 84 | | The upload procedure is laid down in the Video Upload File (e.g. myvideos.vuf). With the information in this file the media file(s) and metadata will be related to each other and included in MediaMosa. It enables the supplier of media files to save, update or delete media files and metadata in the database. The FTP account defines the account under which the videos will be placed in the database, so this can not be established in the video upload file. |
| 85 | | == Structure and elements == |
| 86 | | |
| 87 | | The video upload file is a XML file with a specific structure and elements: |
| 88 | | {{{ |
| 89 | | <FTPupload> the root element |
| 90 | | <email>[EMAIL ADDRESS]</email> the email adress where upload status messages will be sent to |
| 91 | | <videos> the list of assets that are to be uploaded |
| 92 | | <video> an asset |
| 93 | | <action>[save|update|delete]</action> the action that has to be executed on the media file(s) and/or metadata file |
| 94 | | <referenceId>[STRING]</referenceId> an unique identifier of the asset, created by the uploader |
| 95 | | <metadataFile>[FILENAME]</metadataFile> a reference to the metadata file |
| 96 | | <formats> the list of media files that are to be uploaded |
| 97 | | <format> a media file |
| 98 | | <action>[save|update|delete]</action> the action that has to be executed on the media file |
| 99 | | <external>[URL]</external> a reference to the media file if it is stored outside MediaMosa |
| 100 | | <mediaFile>[FILENAME]</mediaFile> a reference to the media file (if is has to be uploaded to MediaMosa) |
| 101 | | <available>[yes|no]</available> indicates whether the media file has to be visible in the interface or not |
| 102 | | <downloadable>[yes|no]</downloadable> indicates whether the the media file has to downloadable or not |
| 103 | | <createstill>[yes|no]</createstill> indicates whether a video still has to be created or not |
| 104 | | <frametime>[INTEGER]</frametime> the number of seconds after the beginning of the video, indicating the frame of which the still is created |
| 105 | | </format> |
| 106 | | </formats> |
| 107 | | </video> |
| 108 | | </videos> |
| 109 | | <collections> a list of collections in which all of the uploaded media files have to be included |
| 110 | | <collectionId>[STRING]</collectionId> an unique identifier of a collection |
| 111 | | </collections> |
| 112 | | <categories> a list of categories to which all of the uploaded media files have to be related |
| 113 | | <categoryId>[STRING]</categoryId> an unique identifier of a category |
| 114 | | </categories> |
| 115 | | <accessRules> a list of rules that set down which end users are allowed to playback the media files in this upload |
| 116 | | <accessRule> |
| 117 | | <ruleType>[DOMAIN|REALM|GROUP|APP]</ruleType> one of the four types of user sets |
| 118 | | <ruleValue>[STRING]</ruleValue> the value of the domain (e.g. surfnet.nl), realm (e.g. peter@surfnet.nl), group (e.g. academia.group) |
| 119 | | </accessRule> |
| 120 | | </accessRules> |
| 121 | | <transcodings> a list of transcodings which have to be executed on all of the uploaded media files |
| 122 | | <transcodingName>[TRANSCODING PROFILE]</transcodingName> the name of a transcoding profile laid down before |
| 123 | | </transcodings> |
| 124 | | <recentList>[yes|no]</recentList> indicates whether or not all of the uploaded media files have to be included in a variety of lists on the website |
| 125 | | </FTPupload> |
| 126 | | }}} |
| 127 | | |
| 128 | | == Actions and related elements == |
| 129 | | |
| 130 | | Depending on which 'action' has to be executed, some elements are mandatory: |
| 131 | | |
| 132 | | * If 'video:action' is 'save' (resulting in a new asset with media file and metadata), then the following elements are mandatory: |
| 133 | | o email [[BR]] |
| 134 | | o video:referenceId [[BR]] |
| 135 | | o video:type [[BR]] |
| 136 | | o video:metadataFile [[BR]] |
| 137 | | o video:format [[BR]] |
| 138 | | o video:format:action (=save) [[BR]] |
| 139 | | o video:format:mediaFile [[BR]] |
| 140 | | |
| 141 | | * If 'video:action' is 'delete' (resulting in the complete removal of the media and metadata files), then the next two elements are mandatory: |
| 142 | | o email [[BR]] |
| 143 | | o video:referenceId [[BR]] |
| 144 | | |
| 145 | | * If 'video:action' is 'update', with the intention to update the metadata file (resulting in the old metadata overwritten by the new, without changing the id), then the next elements are necessary: |
| 146 | | o email [[BR]] |
| 147 | | o video:referenceId [[BR]] |
| 148 | | o video:metadataFile [[BR]] |
| 149 | | |
| 150 | | * If 'video:action' is 'update', with the intention to delete, update or add a media file, then there are three options: |
| 151 | | 1. 'format:action' is 'delete' (resulting in the removal of the media file and its filename), |
| 152 | | 2. 'format:action' is 'update' (resulting in the replacement of the existing media file by a new one, without changing de id), |
| 153 | | 3. 'format:action' is 'save' (resulting in the addition of a new media file to the asset). |
| 154 | | o 'video:format:mediaFile' is the mandatory element in all three cases |
| 155 | | |
| 156 | | * The other metadata will only be handled under the following conditions: |
| 157 | | o 'collections', 'categories', 'accessRules' and 'recentList' will only be handled if 'video:action' is 'save' or 'update' [[BR]] |
| 158 | | o 'transcodings' will only be executed if 'video:format:action' is 'save' or 'update' [[BR]] |
