PDStreamFilter.h

Go to the documentation of this file.

//
// PDStreamFilter.h
//
// Copyright (c) 2012 - 2015 Karl-Johan Alm (http://github.com/kallewoof)
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#ifndef INCLUDED_PDStreamFilter_h
#define INCLUDED_PDStreamFilter_h

#include "PDDefines.h"

typedef PDInteger (*PDStreamFilterFunc)(PDStreamFilterRef filter);

typedef PDStreamFilterRef (*PDStreamFilterPrcs)(PDStreamFilterRef filter);

typedef PDStreamFilterRef (*PDStreamDualFilterConstr)(PDBool inputEnd, PDDictionaryRef options);

struct PDStreamFilter {
    PDBool initialized;                 
    PDBool compatible;                  
    PDBool needsInput;                  
    PDBool hasInput;                    
    PDBool finished;                    
    PDBool failing;                     
    PDDictionaryRef options;            
    void *data;                         
    unsigned char *bufIn;               
    unsigned char *bufOut;              
    PDInteger bufInAvailable;           
    PDInteger bufOutCapacity;           
    PDStreamFilterFunc init;            
    PDStreamFilterFunc done;            
    PDStreamFilterFunc begin;           
    PDStreamFilterFunc proceed;         
    PDStreamFilterPrcs createInversion; 
    PDStreamFilterRef nextFilter;       
    float growthHint;                   
    unsigned char *bufOutOwned;         
    PDInteger bufOutOwnedCapacity;      
};

extern PDStreamFilterRef PDStreamFilterCreate(PDStreamFilterFunc init, PDStreamFilterFunc done, PDStreamFilterFunc begin, PDStreamFilterFunc proceed, PDStreamFilterPrcs createInversion, PDDictionaryRef options);

extern void PDStreamFilterRegisterDualFilter(const char *name, PDStreamDualFilterConstr constr);

extern PDStreamFilterRef PDStreamFilterObtain(const char *name, PDBool inputEnd, PDDictionaryRef options);

extern void PDStreamFilterAppendFilter(PDStreamFilterRef filter, PDStreamFilterRef next);

extern PDBool PDStreamFilterInit(PDStreamFilterRef filter);

extern PDBool PDStreamFilterDone(PDStreamFilterRef filter);

extern PDInteger PDStreamFilterBegin(PDStreamFilterRef filter);

extern PDInteger PDStreamFilterProceed(PDStreamFilterRef filter);

extern PDBool PDStreamFilterApply(PDStreamFilterRef filter, unsigned char *src, unsigned char **dstPtr, PDInteger len, PDInteger *newlenPtr, PDInteger *allocatedlenPtr);

extern PDStreamFilterRef PDStreamFilterCreateInversionForFilter(PDStreamFilterRef filter);

// Convert a PDScanner dictionary stack into a stream filter options stack.
// 
// @note The original stack remains untouched.
// 
// @param dictStack The dictionary stack to convert
// @return New allocated stack suited for stream filter options.
// */
//extern pd_stack PDStreamFilterGenerateOptionsFromDictionaryStack(pd_stack dictStack);

extern PDStreamFilterRef PDStreamFilterAlloc(void);

#define PDStreamFilterPrepare(f, buf_in, len_in, buf_out, len_out) do { \
    f->bufIn = (unsigned char *)buf_in; \
    f->bufOut = (unsigned char *)buf_out; \
    f->bufInAvailable = len_in; \
    f->bufOutCapacity = len_out; \
} while (0)

#endif