IError.h

/*******************************************************************************
 * Copyright (c) 2024, 2026, Olivier Ayache.  All rights reserved.
 *
 * This file is part of AVPKit.
 *
 * AVPKit is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * AVPKit is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with AVPKit.  If not, see <http://www.gnu.org/licenses/>.
 *******************************************************************************/
 
/*
 * IError.h
 *
 *  A way of translating between FFMPEG error codes and some core defined
 *  values.
 *  
 *  Created on: Mar 20, 2009
 *      Author: aclarke
 */
 
#ifndef IERROR_H_
#define IERROR_H_
 
#include <com/avpkit/ferry/RefCounted.h>
#include <com/avpkit/core/AVPKit.h>
 
namespace com { namespace avpkit { namespace core
{
 
class VS_API_AVPKIT IError : public com::avpkit::ferry::RefCounted
{
public:
  typedef enum Type {
    /* Unknown error */
    ERROR_UNKNOWN,
    /* IO error */
    ERROR_IO,
    /* Number expected */
    ERROR_NUMEXPECTED,
    /* Invalid data */
    ERROR_INVALIDDATA,
    /* Out of memory */
    ERROR_NOMEM,
    /* Format not supported */
    ERROR_NOFMT,
    /* Operation not supported */
    ERROR_NOTSUPPORTED,
    /* File not found */
    ERROR_NOENT,
    /* End of file or pipe */
    ERROR_EOF,
    /* Value out of range */
    ERROR_RANGE,
    /* Try again; Not enough data available on this non-blocking call */
    ERROR_AGAIN,
    /* Not supported, and the FFMPEG team wouldn't mind a patch */
    ERROR_PATCHWELCOME,
    /* Thread was interrupted while trying an IO operation */
    ERROR_INTERRUPTED,
  } Type;
  
 
  virtual Type getType()=0;
 
  virtual const char* getDescription()=0;
  
  virtual int32_t getErrorNumber()=0;
  
  static IError* make(int32_t errorNumber);
  
  static IError* make(Type type);
 
  static Type errorNumberToType(int32_t errorNo);
 
  static int32_t typeToErrorNumber(Type type);
 
protected:
  IError();
  virtual ~IError();
};
 
}}}
#endif /* IERROR_H_ */