plank_AudioFileMetaData.h

/*
 -------------------------------------------------------------------------------
 This file is part of the Plink, Plonk, Plank libraries
  by Martin Robinson
 
 http://code.google.com/p/pl-nk/
 
 Copyright University of the West of England, Bristol 2011-14
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 * Neither the name of University of the West of England, Bristol nor 
   the names of its contributors may be used to endorse or promote products
   derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 DISCLAIMED. IN NO EVENT SHALL UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL BE 
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 
 This software makes use of third party libraries. For more information see:
 doc/license.txt included in the distribution.
 -------------------------------------------------------------------------------
 */

#ifndef PLANK_AUDIOFILEMETADATA_H
#define PLANK_AUDIOFILEMETADATA_H

#include "plank_AudioFileCommon.h"
#include "../../containers/plank_SharedPtr.h"
#include "../../containers/plank_DynamicArray.h"
#include "../../containers/plank_SimpleLinkedList.h"

#define PLANKSHAREDPTR_TYPE_AUDIOFILEMETADATA pl_FourCharCode("amtd")

PLANK_BEGIN_C_LINKAGE

PlankResult pl_AudioFileMetaData_CreateSharedPtr (PlankAudioFileMetaDataRef* pp);
PlankAudioFileMetaDataRef pl_AudioFileMetaData_IncrementRefCountAndGet (PlankAudioFileMetaDataRef p);
PlankResult pl_AudioFileMetaData_DecrementRefCount (PlankAudioFileMetaDataRef p);
PlankWeakPtrRef pl_AudioFileMetaData_GetWeakPtr (PlankAudioFileMetaDataRef p);
PlankAudioFileMetaDataRef pl_AudioFileMetaDataGetFromWeakPtr (PlankWeakPtrRef w);

PlankResult pl_AudioFileMetaData_SetEditCount (PlankAudioFileMetaDataRef p, const PlankUI count);
PlankUI pl_AudioFileMetaData_GetEditCount (PlankAudioFileMetaDataRef p);

PlankResult pl_AudioFileMetaData_SetInstrumentData (PlankAudioFileMetaDataRef p,
                                                    PlankI baseNote,
                                                    PlankI detune,
                                                    PlankI gain,
                                                    PlankI lowNote,
                                                    PlankI highNote,
                                                    PlankI lowVelocity,
                                                    PlankI highVelocity);

PlankResult pl_AudioFileMetaData_GetInstrumentData (PlankAudioFileMetaDataRef p,
                                                    PlankI* baseNote,
                                                    PlankI* detune,
                                                    PlankI* gain,
                                                    PlankI* lowNote,
                                                    PlankI* highNote,
                                                    PlankI* lowVelocity,
                                                    PlankI* highVelocity);

PlankResult pl_AudioFileMetaData_SetSamplerData (PlankAudioFileMetaDataRef p,
                                                 PlankUI manufacturer,
                                                 PlankUI product,
                                                 PlankUI samplePeriod,
                                                 PlankUI smpteFormat,
                                                 PlankUI smpteOffset);

PlankResult pl_AudioFileMetaData_GetSamplerData (PlankAudioFileMetaDataRef p,
                                                 PlankUI* manufacturer,
                                                 PlankUI* product,
                                                 PlankUI* samplePeriod,
                                                 PlankUI* smpteFormat,
                                                 PlankUI* smpteOffset);

PlankDynamicArrayRef pl_AudioFileMetaData_GetExtraSamplerData (PlankAudioFileMetaDataRef p);

PlankResult pl_AudioFileMetaData_SetDescriptionComment (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_SetOriginatorArtist (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_SetOriginatorRef (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_SetOriginationDate (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_SetOriginationTime (PlankAudioFileMetaDataRef p, const char* text);

const char* pl_AudioFileMetaData_GetDescriptionComment (PlankAudioFileMetaDataRef p);
const char* pl_AudioFileMetaData_GetOriginatorArtist (PlankAudioFileMetaDataRef p);
const char* pl_AudioFileMetaData_GetOriginatorRef (PlankAudioFileMetaDataRef p);
const char* pl_AudioFileMetaData_GetOriginationDate (PlankAudioFileMetaDataRef p);
const char* pl_AudioFileMetaData_GetOriginationTime (PlankAudioFileMetaDataRef p);

PlankResult pl_AudioFileMetaData_SetPerformer (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_SetTitle (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_SetAlbum (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_SetGenre (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_SetLyrics (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_SetVendor (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_SetISRC (PlankAudioFileMetaDataRef p, const char* text);

const char* pl_AudioFileMetaData_GetPerformer (PlankAudioFileMetaDataRef p);
const char* pl_AudioFileMetaData_GetTitle (PlankAudioFileMetaDataRef p);
const char* pl_AudioFileMetaData_GetAlbum (PlankAudioFileMetaDataRef p);
const char* pl_AudioFileMetaData_GetGenre (PlankAudioFileMetaDataRef p);
const char* pl_AudioFileMetaData_GetLyrics (PlankAudioFileMetaDataRef p);
const char* pl_AudioFileMetaData_GetVendor (PlankAudioFileMetaDataRef p);
const char* pl_AudioFileMetaData_GetISRC (PlankAudioFileMetaDataRef p);

PlankResult pl_AudioFileMetaData_AddPerformer (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_AddDescriptionComment (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_AddOriginatorArtist (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_AddOriginatorRef (PlankAudioFileMetaDataRef p, const char* text);
PlankResult pl_AudioFileMetaData_AddGenre (PlankAudioFileMetaDataRef p, const char* text);

PlankResult pl_AudioFileMetaData_SetArt (PlankAudioFileMetaDataRef p, PlankConstantP data, const PlankL size);
PlankResult pl_AudioFileMetaData_GetArt (PlankAudioFileMetaDataRef p, PlankConstantP* data, PlankL* size);

PlankResult pl_AudioFileMetaData_SetYear (PlankAudioFileMetaDataRef p, const PlankI year);
PlankI pl_AudioFileMetaData_GetYear (PlankAudioFileMetaDataRef p);

PlankResult pl_AudioFileMetaData_SetTrackInfo (PlankAudioFileMetaDataRef p, const PlankI trackNum, const PlankI trackTotal);
PlankResult pl_AudioFileMetaData_GetTrackInfo (PlankAudioFileMetaDataRef p, PlankI* trackNum, PlankI* trackTotal);

PlankResult pl_AudioFileMetaData_SetTimeRef (PlankAudioFileMetaDataRef p, const PlankLL timeRef);
PlankLL pl_AudioFileMetaData_GetTimeRef (PlankAudioFileMetaDataRef p);

PlankResult pl_AudioFileMetaData_SetSource (PlankAudioFileMetaDataRef p, const PlankUI source);
PlankUI pl_AudioFileMetaData_GetSource (PlankAudioFileMetaDataRef p);

PlankResult pl_AudioFileMetaData_SetUMID (PlankAudioFileMetaDataRef p, const PlankUC* umid);
const PlankUC* pl_AudioFileMetaData_GetUMID (PlankAudioFileMetaDataRef p);


PlankResult pl_AudioFileMetaData_AddCuePoint (PlankAudioFileMetaDataRef p, PlankAudioFileCuePointRef cuePoint);

PlankResult pl_AudioFileMetaData_FindCuePointWithID (PlankAudioFileMetaDataRef p, const PlankUI cueID, PlankAudioFileCuePointRef* cuePoint, PlankL* index);

PlankResult pl_AudioFileMetaData_RemoveCuePointWithID (PlankAudioFileMetaDataRef p, const PlankUI cueID, PlankAudioFileCuePointRef* cuePoint, PlankB* success);

PlankResult pl_AudioFileMetaData_GetNextCueID (PlankAudioFileMetaDataRef p, PlankUI* cueID);


PlankSharedPtrArrayRef pl_AudioFileMetaData_GetCuePoints (PlankAudioFileMetaDataRef p);
PlankSharedPtrArrayRef pl_AudioFileMetaData_GetRegions (PlankAudioFileMetaDataRef p);
PlankSharedPtrArrayRef pl_AudioFileMetaData_GetLoopPoints (PlankAudioFileMetaDataRef p);


PlankResult pl_AudioFileMetaData_AddRegion (PlankAudioFileMetaDataRef p, PlankAudioFileRegionRef region);

PlankResult pl_AudioFileMetaData_ConvertCuePointsToRegions (PlankAudioFileMetaDataRef p, const double totalDuration, const PlankB removeCuePoints);

PlankResult pl_AudioFileMetaData_SortCuePointsByPosition (PlankAudioFileMetaDataRef p);
PlankResult pl_AudioFileMetaData_SortCuePointsByID (PlankAudioFileMetaDataRef p);


PlankResult pl_AudioFileMetaData_AddLoopPoint (PlankAudioFileMetaDataRef p, PlankAudioFileRegionRef region);

PlankResult pl_AudioFileMetaData_AddCodingHistory (PlankAudioFileMetaDataRef p, const char* text);
const char* pl_AudioFileMetaData_GetCodingHistory (PlankAudioFileMetaDataRef p);


PlankResult pl_AudioFileMetaData_AddFormatSpecificBlock (PlankAudioFileMetaDataRef p, PlankDynamicArrayRef block);


PlankResult pl_AudioFileMetaData_InsertTime (PlankAudioFileMetaDataRef p, const double start, const double length);
PlankResult pl_AudioFileMetaData_RemoveTime (PlankAudioFileMetaDataRef p, const double start, const double length);



PLANK_END_C_LINKAGE


#if !DOXYGEN
typedef struct PlankAudioFileMetaData
{
    PlankSharedPtr sharedHeader;
    
    PlankUI editCount;
    
    // smpl / inst
    PlankI baseNote;
    PlankI detune;
    PlankI gain;
    PlankI lowNote;
    PlankI highNote;
    PlankI lowVelocity;
    PlankI highVelocity;
    
    PlankUI manufacturer;
    PlankUI product;
    PlankUI samplePeriod;
    PlankUI smpteFormat;
    PlankUI smpteOffset;
    
    PlankUI textEncoding;

    PlankDynamicArray descriptionComment;
    PlankDynamicArray originatorArtist;
    PlankDynamicArray originatorRef;
    PlankDynamicArray originationDate;
    PlankDynamicArray originationTime;
    
    PlankDynamicArray performer;
    PlankDynamicArray title;
    PlankDynamicArray album;
    PlankDynamicArray genre;
    PlankDynamicArray lyrics;
    
    PlankDynamicArray vendor;
    PlankDynamicArray isrc;
    PlankDynamicArray copyright;

    PlankDynamicArray art;
    PlankDynamicArray samplerData;
    
    PlankI year;
    PlankI trackNum;
    PlankI trackTotal;
    
    PlankLL timeRef;
    PlankUI sourceType; // AIFF, WAV, BWAV
    PlankUI version;
    PlankUC umid[64];
    PlankDynamicArray codingHistory;

//      PlankDynamicArray cuePoints;
//    PlankDynamicArray loopPoints;
//    PlankDynamicArray regions;

    PlankSharedPtrArrayRef cuePoints;
    PlankSharedPtrArrayRef loopPoints;
    PlankSharedPtrArrayRef regions;

    // just a list of unparsed data - if we write the same format
    // wih no change this can be simply piped out
    PlankSimpleLinkedList formatSpecific;
        
} PlankAudioFileMetaData;
#endif 

#endif // PLANK_AUDIOFILEMETADATA_H